mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-14 10:34:06 +02:00
# 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]>
86 lines
2.2 KiB
TypeScript
86 lines
2.2 KiB
TypeScript
import type { Meta, StoryObj } from "@storybook/react-vite";
|
|
import { CodeBlock } from "@shared/components/CodeBlock";
|
|
|
|
const CURL_EXAMPLE = `curl https://api.stirling.com/v1/coi \\
|
|
-H "Authorization: Bearer sk_live_a3f8..." \\
|
|
-F "[email protected]"`;
|
|
|
|
const JSON_RESULT = `{
|
|
"schema": "coi.v2",
|
|
"fields": {
|
|
"carrier": "Travelers Casualty",
|
|
"policy_number": "PHB-1108-2025",
|
|
"gl_limit": 1000000,
|
|
"umbrella_limit": 5000000,
|
|
"effective": "2026-01-15",
|
|
"expiry": "2027-01-15"
|
|
},
|
|
"confidence_avg": 0.96
|
|
}`;
|
|
|
|
const PYTHON_EXAMPLE = `import stirling
|
|
|
|
client = stirling.Client(api_key="sk_live_a3f8...")
|
|
result = client.extract(file="certificate.pdf", schema="coi.v2")
|
|
print(result.fields)`;
|
|
|
|
const meta: Meta<typeof CodeBlock> = {
|
|
title: "Primitives/CodeBlock",
|
|
component: CodeBlock,
|
|
tags: ["autodocs"],
|
|
parameters: { layout: "padded" },
|
|
args: { code: CURL_EXAMPLE, lang: "curl", copyable: true, maxHeight: 400 },
|
|
argTypes: {
|
|
lang: {
|
|
control: "inline-radio",
|
|
options: [
|
|
"json",
|
|
"javascript",
|
|
"typescript",
|
|
"python",
|
|
"bash",
|
|
"curl",
|
|
"http",
|
|
"plain",
|
|
],
|
|
},
|
|
copyable: { control: "boolean" },
|
|
maxHeight: { control: "number" },
|
|
code: { control: "text" },
|
|
},
|
|
};
|
|
export default meta;
|
|
type Story = StoryObj<typeof CodeBlock>;
|
|
|
|
/** Flip lang / copyable / maxHeight / code in controls. */
|
|
export const Playground: Story = {};
|
|
|
|
export const LongScrolling: Story = {
|
|
args: {
|
|
code: Array.from(
|
|
{ length: 40 },
|
|
(_, i) => `line ${i + 1}: const x = ${i};`,
|
|
).join("\n"),
|
|
lang: "javascript",
|
|
maxHeight: 240,
|
|
},
|
|
};
|
|
|
|
export const InContext_TwoUpComparison: Story = {
|
|
render: () => (
|
|
<div style={{ display: "grid", gridTemplateColumns: "1fr 1fr", gap: 16 }}>
|
|
<CodeBlock code={CURL_EXAMPLE} lang="curl" caption="Request" />
|
|
<CodeBlock code={JSON_RESULT} lang="json" caption="Response" />
|
|
</div>
|
|
),
|
|
};
|
|
|
|
export const InContext_Quickstart: Story = {
|
|
render: () => (
|
|
<div style={{ display: "flex", flexDirection: "column", gap: 16 }}>
|
|
<CodeBlock code={PYTHON_EXAMPLE} lang="python" caption="quickstart.py" />
|
|
<CodeBlock code={CURL_EXAMPLE} lang="curl" caption="curl" />
|
|
</div>
|
|
),
|
|
};
|