Files
Stirling-PDF/frontend/portal/src/mocks/ops.ts
T
919f0ade99 Portal (#6391)
# Description of Changes

## What & why

This PR introduces the **Stirling developer portal** — a new
control-plane frontend that sits alongside the existing PDF editor —
plus the shared design system and workspace structure needed to host
both apps in one frontend.

The portal is the parent product surface: where users connect sources,
compose pipelines, wire agents, and manage usage / billing /
infrastructure, with the PDF editor as one capability inside it. This PR
lays the **foundation** — workspace reshape, design system, app shell,
navigation, and a mock-driven home — rather than wiring real backends
(those surfaces are placeholders for follow-up phases).

## What's in this PR

**1. Frontend repo reshape (`frontend/src/` → `frontend/editor/`)**
The existing editor app moved under `frontend/editor/`, so `editor`,
`portal`, and `shared` are siblings in one workspace. All references
were updated accordingly: `LICENSE`, `.dockerignore`, `.gitignore`,
build/sign shell scripts, the GH language-check script, the Taskfile,
and Docker config. **No editor source logic changed — path references
only.**

**2. New shared design system (`frontend/shared/`)**
- **Design tokens** in `tokens.css` as the single runtime source of
truth (light/dark, category accents, gradients). `tokens.ts` now holds
only the `Tier` type — the old JS palette mirror was removed (nothing
consumed it and it had drifted).
- ~30 framework-light **components** (Card, Button, Input, Select, Tabs,
Modal, Drawer, Toast, MetricCard, StatusBadge, Skeleton, EmptyState, …)
with Storybook stories.
- **Typed data catalogues**: `endpoints.ts` (10 verticals / 64
endpoints) and `ops.ts`.

**3. New developer portal app (`frontend/portal/`)**
- App shell: `Header`, `Sidebar`, `AssistantPanel`, search modal,
notifications, tier switcher, theme toggle, MSW toggle.
- **Tier-aware** home (free / pay-as-you-go / enterprise): KPI strip,
30-day usage chart, onboarding checklist, quick actions, recent
activity, region health, product grid, and a curated **"Popular use
cases"** teaser.
- **Documents** view hosting the full, tab-filterable endpoint
catalogue.
- Placeholder views for Sources / Pipelines / Agents / Editor /
Infrastructure / Usage & Billing / Developer Docs / Settings (follow-up
phases).
- **MSW-mocked** API layer: `api/*` issues real `fetch`, intercepted by
mocks in dev/Storybook; pointing at a real backend is just a matter of
not registering MSW. `react-router` URLs; Tier / View / UI contexts.

**4. Tooling & guardrails**
- ESLint extended to `portal` + `shared`, with **layering-boundary
rules**: `shared/` may depend only on third-party packages and itself
(no `@app` / `@portal` / `@core` / `@proprietary` / Tauri), so it stays
cleanly extractable into a standalone package later.
- `dpdm` circular-dependency check now walks editor + portal + shared
(the old glob matched only 2 files).
- New **devDependencies only** — Storybook (+ a11y/docs/themes addons),
MSW. No runtime dependencies added.
- New tasks: `frontend:dev:portal`, `frontend:build:portal`.

## Testing done locally

- `tsc` for both `portal` and `shared` projects — clean
- `eslint --max-warnings=0` across the whole frontend — clean
- `dpdm` circular-dependency check — no cycles
- Editor builds clean: `vite build editor --mode core` (✓ built, only
the pre-existing >500 kB chunk-size advisory)
- Editor runs in dev (core mode) with **zero console errors**; portal
runs in dev across all three tiers

## Notes for reviewers

- The change is overwhelmingly **additive**: `shared/` and `portal/` are
brand-new; the existing editor is path-reference changes only.
- The portal is intentionally **mock-driven** at this stage — real
backends and the remaining views land in follow-up phases.

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md)
(if applicable)
- [x] I have performed a self-review of my own code
- [x] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] I have read the section [Add New Translation
Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags)
(for new translation tags only)

### Translations (if applicable)

- [ ] I ran
[`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have run `task check` to verify linters, typechecks, and tests
pass
- [x] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing)
for more details.

---------

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-02 16:08:24 +00:00

167 lines
4.0 KiB
TypeScript

/**
* Mock op catalogue + canned operation results for the single-op runner.
* Only api/ops.ts imports from this file.
*/
export type OpResultMap = Record<string, unknown>;
export interface FeaturedOp {
id: string;
label: string;
endpoint: string;
accent: "blue" | "purple" | "green" | "amber" | "red";
/** Shown in the picker — short single line. */
blurb: string;
}
export const FEATURED_OPS: FeaturedOp[] = [
{
id: "extract",
label: "Extract",
endpoint: "/v1/extract",
accent: "blue",
blurb: "Pull structured fields into a typed schema",
},
{
id: "redact",
label: "Redact PII",
endpoint: "/v1/redact",
accent: "red",
blurb: "Mask SSN, DOB, addresses, accounts before storage",
},
{
id: "classify",
label: "Classify",
endpoint: "/v1/classify",
accent: "purple",
blurb: "Identify document type with a confidence score",
},
{
id: "ocr",
label: "OCR",
endpoint: "/v1/ocr",
accent: "green",
blurb: "Text-recognize scanned or image pages",
},
{
id: "validate",
label: "Schema validate",
endpoint: "/v1/validate",
accent: "blue",
blurb: "Check fields, rules, and coverage against the schema",
},
{
id: "sign-output",
label: "Sign output",
endpoint: "/v1/sign",
accent: "green",
blurb: "Tamper-evident signature over artifact + run metadata",
},
{
id: "authenticity",
label: "Authenticity",
endpoint: "/v1/authenticity",
accent: "blue",
blurb: "Verify issuer signature, watermark, and metadata",
},
{
id: "tamper-check",
label: "Tamper check",
endpoint: "/v1/tamper-check",
accent: "amber",
blurb: "Detect modifications since signing or last-known-good state",
},
{
id: "encrypt-rest",
label: "Encrypt at rest",
endpoint: "/v1/encrypt",
accent: "purple",
blurb: "AES-256 with Stirling-managed, BYOK, or HYOK keys",
},
{
id: "smart-redact",
label: "Smart redact",
endpoint: "/v1/smart-redact",
accent: "red",
blurb: "Schema-aware redaction with confidence gating",
},
];
/** Canned JSON for each featured op's runner "done" state. */
export const OP_RESULTS: Record<string, OpResultMap> = {
extract: {
schema: "coi.v2",
fields: {
carrier: "Travelers Casualty",
policy_number: "PHB-1108-2025",
gl_limit: 1_000_000,
umbrella_limit: 5_000_000,
effective: "2026-01-15",
expiry: "2027-01-15",
},
confidence_avg: 0.96,
},
redact: {
redacted_pages: 4,
pii_types: ["SSN", "DOB", "ADDRESS", "EMAIL"],
occurrences: 19,
redaction_style: "blackout",
audit_id: "rdct_01HVQ7K3ZA9YJ8C",
},
classify: {
schema: "invoice.v3",
confidence: 0.94,
alternatives: [
{ schema: "credit_memo.v1", confidence: 0.04 },
{ schema: "purchase_order.v2", confidence: 0.02 },
],
processing_ms: 287,
},
ocr: {
pages: 12,
characters_recognized: 28471,
confidence_avg: 0.987,
languages_detected: ["en"],
processing_ms: 1840,
},
validate: {
schema: "coi.v2",
passed: true,
checks_run: 14,
warnings: [
{ field: "additional_insured", message: "Optional field empty" },
],
},
"sign-output": {
algorithm: "Ed25519",
key_id: "kx-prod-2026",
manifest_hash:
"0xb3f0c1a9d54fa1c0b8fd4eebd7fa11b1b16c9a3e2d2cc6f1f5a2f0a87e1b7a04",
},
authenticity: {
verified: true,
issuer: "State of California DMV",
signed_at: "2025-11-04T17:22:00Z",
watermark_match: true,
},
"tamper-check": {
tampered: false,
hash_match: true,
modifications_detected: 0,
last_known_good: "2026-04-22T09:14:00Z",
},
"encrypt-rest": {
algorithm: "AES-256-GCM",
key_mode: "BYOK",
key_id: "arn:aws:kms:us-east-1:123:key/abc-…",
object_id: "obj_01HVQ7M9B2",
},
"smart-redact": {
schema: "coi.v2",
redacted_fields: ["named_insured", "dob"],
occurrences: 7,
confidence_gate: 0.85,
gated_by_confidence: 1,
},
};