mirror of https://github.com/arsvendg/Stirling-PDF.git synced 2026-07-14 10:34:06 +02:00

Files

T

Reece BrowneandGitHub 9ee0bc4b32 Policies: enforce on upload or export (#6614 )

Follow-up to #6604 (merged). Builds the Security policy out so it
actually enforces, driven from the editor.

## What it does
- **Run on upload or export** — a single choice in the wizard: enforce
when a file is uploaded, or just before it's exported.
- **Output** — enforced result is a **new version** of the file
(default) or a **new file**, with optional filename
prefix/suffix/auto-number ("Output filename" subsection; auto-number
only for new files).
- **Export enforcement** — exporting an export-mode file runs the policy
first and downloads the enforced result; never hard-blocks (on failure
the original downloads). For new-version policies the in-editor file is
versioned too. Covers every export path incl. multi-file ZIP. A toast
(glowing in the policy's accent while it runs) reports progress and
fades after ~10s.
- **Affordances** — a freshly enforced file briefly glows its policy
accent and carries a shield badge.
- **Config tidy-up** — removed the unwired Security setting fields + the
wizard's review step; "Upgrade to enterprise" on locked categories;
category accent in the detail/wizard headers.

## Notes
- Builds on the manual-only (client-driven) policy model from #6587
(`trigger: null`, metadata in `output.options`), adding the `runOn`
field + export-time enforcement.
- The page-editor merge-export (no single source file) enforces +
downloads but doesn't version in place.

## Verification
typecheck (core + proprietary), eslint, prettier; proprietary suite
(105) green; flows checked in-app.

2026-06-11 18:12:01 +01:00

.claude/agents

playwright (#6025 )

2026-04-27 11:35:50 +01:00

.storybook

feat(policies): backend-driven policy enforcement (frontend) (#6598 )

2026-06-10 15:57:08 +01:00

editor

Policies: enforce on upload or export (#6614 )

2026-06-11 18:12:01 +01:00

portal

Move agent section to fab (#6597 )

2026-06-10 15:47:47 +01:00

scripts

Fix desktop updater latest.json generation for releases (#6540 )

2026-06-05 15:41:41 +01:00

shared

feat(policies): backend-driven policy enforcement (frontend) (#6598 )

2026-06-10 15:57:08 +01:00

.gitignore

UI changes to update and support auto updating (#6075 )

2026-06-02 23:11:37 +01:00

.prettierignore

UI changes to update and support auto updating (#6075 )

2026-06-02 23:11:37 +01:00

.prettierrc

Prettier 2: Electric Boogaloo (#6113 )

2026-04-17 09:50:16 +00:00

eslint.config.mjs

drop type-aware ESLint to stop the lint OOM (#6602 )

2026-06-10 15:44:52 +01:00

package-lock.json

perf(compression): add vite-plugin-compression for gzip and Brotli support (#6279 )

2026-06-05 18:49:09 +01:00

package.json

perf(compression): add vite-plugin-compression for gzip and Brotli support (#6279 )

2026-06-05 18:49:09 +01:00

README.md

Restructure/frontend editor (#6404 )

2026-05-22 13:40:34 +01:00

README.md

Frontend

All frontend commands are run from the repository root using Task:

task frontend:dev — start Vite dev server (localhost:5173)
task frontend:build — production build
task frontend:test — run tests
task frontend:test:watch — run tests in watch mode
task frontend:lint — run ESLint + cycle detection
task frontend:typecheck — run TypeScript type checking
task frontend:check — run typecheck + lint + test
task frontend:install — install npm dependencies

For desktop app development, see the Tauri section below.

Layout

frontend/ is a workspace containing one or more apps. Today it holds the PDF editor under frontend/editor/; new apps (the developer portal, etc.) will sit alongside it as siblings. Shared tooling — package.json, node_modules, .storybook/, ESLint, Prettier — lives at frontend/ so every app installs once and lints with the same config.

Environment Variables

The editor's environment variables live in committed .env files at frontend/editor/:

.env — used by all builds (core, proprietary, and as the base for desktop/SaaS)
.env.desktop — additional vars loaded in desktop (Tauri) mode
.env.saas — additional vars loaded in SaaS mode

These files contain non-secret defaults and are checked into Git, so most dev work needs no further setup.

To override values locally (API keys, machine-specific settings), create an uncommitted sibling editor/.env.local / editor/.env.desktop.local / editor/.env.saas.local. Vite automatically layers these on top of the committed files.

Docker Setup

For Docker deployments and configuration, see the Docker README.

Tauri

All desktop tasks are available via Task. From the root of the repo:

Dev

task desktop:dev

This ensures the JLink runtime and backend JAR exist (skipping if already built), then starts Tauri in dev mode.

Build

task desktop:build

This does a full clean rebuild of the backend JAR and JLink runtime, then builds the Tauri app for production.

Platform-specific dev builds are also available:

task desktop:build:dev           # No bundling
task desktop:build:dev:mac       # macOS .app bundle
task desktop:build:dev:windows   # Windows NSIS installer
task desktop:build:dev:linux     # Linux AppImage

JLink Tasks

You can also run JLink steps individually:

task desktop:jlink          # Build JAR + create JLink runtime
task desktop:jlink:jar      # Build backend JAR only
task desktop:jlink:runtime  # Create JLink custom JRE only
task desktop:jlink:clean    # Remove JLink artifacts

Clean

task desktop:clean

Removes all desktop build artifacts including JLink runtime, bundled JARs, Cargo build, and dist/build directories.