Files
Stirling-PDF/frontend/editor/src/proprietary/services/policyCatalog.ts
T
Reece BrowneandGitHub 8dde4262ec feat(policies): backend-driven policy enforcement (frontend) (#6598)
## Summary
Adds the **Policies** feature (proprietary, behind the
`POLICIES_ENABLED` flag): backend-driven enforcement that runs a fixed
tool pipeline on documents, docked in the right tool sidebar alongside
Tools.

## Highlights
- **Policy catalog** — 5 categories; **Security** is wired (redact PII +
sanitize), the others are marked "Coming soon".
- **Backend as source of truth** — policies persist via the Policies
engine (`/api/v1/policies`), one policy per category, with a local cache
+ offline fallback.
- **Auto-run** — enabled policies run on every uploaded file: dispatch →
poll → import outputs into the workspace.
- **Security redact config** — PII preset dropdown + custom word/regex
entry + advanced options; tool params map to the backend endpoint
fields.
- **Activity feed** with retry on failures; **file badges** showing
which policies ran on a file (sidebar + files page), tinted to the
policy colour.
- Reuses the **Watched Folders** engine for each policy's backing
folder; policy-owned folders are filtered out of the Watched Folders UI.

## Notes
- Gated by `POLICIES_ENABLED` (true in proprietary, false in core) —
unreachable in the open-source build.
- Frontend-only diff; depends on the backend Policies engine and the
merged Watched Folders feature.
2026-06-10 15:57:08 +01:00

44 lines
1.4 KiB
TypeScript

/**
* The catalog of available policy *definitions* — the policy types, their
* editable fields, the sources a policy can run over, and the document types
* scope can be narrowed to. This is the single seam through which definitions
* reach the UI: components never import the static definitions directly, they
* read the catalog (via {@link usePolicyCatalog}).
*
* Backed by the static `policyDefinitions` today; swap {@link loadPolicyCatalog}
* for a fetch to move definitions server-side without touching any component.
*/
import {
POLICY_CATEGORIES,
POLICY_CONFIG,
POLICY_SOURCES,
POLICY_DOC_TYPES,
} from "@app/data/policyDefinitions";
import type {
PolicyCategory,
PolicyConfigDef,
PolicySource,
} from "@app/types/policies";
export interface PolicyCatalog {
/** Available policy types, in display order. */
categories: PolicyCategory[];
/** Per-category narrative + editable field definitions, keyed by category id. */
configs: Record<string, PolicyConfigDef>;
/** Sources a policy can run over (wizard step 2). */
sources: PolicySource[];
/** Document types scope can be narrowed to (gated behind classification). */
docTypes: string[];
}
/** Load the policy catalog. Swap this for a backend fetch to go live. */
export function loadPolicyCatalog(): PolicyCatalog {
return {
categories: POLICY_CATEGORIES,
configs: POLICY_CONFIG,
sources: POLICY_SOURCES,
docTypes: POLICY_DOC_TYPES,
};
}