mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-16 19:33:11 +02:00
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]>
This commit is contained in:
Reece Browne
co-authored by
Claude Opus 4.8
Claude Opus 4.8
parent
b355ccec9e
commit
919f0ade99
@@ -0,0 +1,116 @@
|
||||
import type { Meta, StoryObj } from "@storybook/react";
|
||||
import { VERTICALS, ALL_ENDPOINTS } from "@shared/data/endpoints";
|
||||
import { MethodBadge } from "@shared/components/MethodBadge";
|
||||
import { StatusBadge } from "@shared/components/StatusBadge";
|
||||
|
||||
const meta: Meta = {
|
||||
title: "Data/Endpoint catalogue",
|
||||
parameters: {
|
||||
layout: "padded",
|
||||
docs: {
|
||||
description: {
|
||||
component:
|
||||
"Live preview of the typed endpoint catalogue in src/data/endpoints.ts. Verticals come from VERTICALS, the flat list from ALL_ENDPOINTS.",
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
export default meta;
|
||||
type Story = StoryObj;
|
||||
|
||||
export const ByVertical: Story = {
|
||||
render: () => (
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 22 }}>
|
||||
<div style={{ fontSize: 12, color: "var(--color-text-4)" }}>
|
||||
{ALL_ENDPOINTS.length} endpoints across {VERTICALS.length} verticals
|
||||
</div>
|
||||
{VERTICALS.map((v) => (
|
||||
<div key={v.key}>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: 10,
|
||||
marginBottom: 8,
|
||||
}}
|
||||
>
|
||||
<span
|
||||
style={{
|
||||
width: 8,
|
||||
height: 8,
|
||||
borderRadius: 2,
|
||||
background: v.color,
|
||||
}}
|
||||
/>
|
||||
<h3
|
||||
style={{ margin: 0, fontSize: 14, color: "var(--color-text-1)" }}
|
||||
>
|
||||
{v.label}
|
||||
</h3>
|
||||
<span style={{ fontSize: 12, color: "var(--color-text-5)" }}>
|
||||
{v.endpoints.length} endpoints
|
||||
</span>
|
||||
</div>
|
||||
<div style={{ display: "grid", gap: 8 }}>
|
||||
{v.endpoints.map((e) => (
|
||||
<div
|
||||
key={e.endpoint}
|
||||
style={{
|
||||
display: "grid",
|
||||
gridTemplateColumns: "4.375rem 13.75rem 1fr auto",
|
||||
gap: 12,
|
||||
alignItems: "center",
|
||||
padding: "0.625rem 0.875rem",
|
||||
background: "var(--color-surface)",
|
||||
border: "1px solid var(--color-border)",
|
||||
borderRadius: "var(--radius-md)",
|
||||
}}
|
||||
>
|
||||
<MethodBadge method="POST" />
|
||||
<span
|
||||
style={{
|
||||
fontFamily: "var(--font-mono)",
|
||||
fontSize: 12,
|
||||
color: "var(--color-text-2)",
|
||||
}}
|
||||
>
|
||||
{e.endpoint}
|
||||
</span>
|
||||
<div style={{ minWidth: 0 }}>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 13,
|
||||
fontWeight: 500,
|
||||
color: "var(--color-text-1)",
|
||||
}}
|
||||
>
|
||||
{e.name}
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 12,
|
||||
color: "var(--color-text-4)",
|
||||
overflow: "hidden",
|
||||
textOverflow: "ellipsis",
|
||||
whiteSpace: "nowrap",
|
||||
}}
|
||||
>
|
||||
{e.desc}
|
||||
</div>
|
||||
</div>
|
||||
<StatusBadge
|
||||
tone={
|
||||
e.tier === 0 ? "success" : e.tier === 1 ? "info" : "purple"
|
||||
}
|
||||
size="sm"
|
||||
>
|
||||
{e.tier === 0 ? "free" : e.tier === 1 ? "paid" : "enterprise"}
|
||||
</StatusBadge>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
};
|
||||
@@ -0,0 +1,306 @@
|
||||
import type { Meta, StoryObj } from "@storybook/react";
|
||||
import {
|
||||
PIPELINE_OPS,
|
||||
LIBRARY_OPS,
|
||||
OP_CATEGORIES,
|
||||
PIPELINE_AGENTS,
|
||||
SOURCE_OPTIONS,
|
||||
DESTINATION_OPTIONS,
|
||||
type OpKind,
|
||||
} from "@shared/data/ops";
|
||||
|
||||
const meta: Meta = {
|
||||
title: "Data/Ops library",
|
||||
parameters: { layout: "padded" },
|
||||
};
|
||||
export default meta;
|
||||
type Story = StoryObj;
|
||||
|
||||
const STAGE_ORDER: OpKind[] = [
|
||||
"ingest",
|
||||
"validate",
|
||||
"modify",
|
||||
"secure",
|
||||
"store",
|
||||
"alert",
|
||||
];
|
||||
const STAGE_COLOUR: Record<OpKind, string> = {
|
||||
ingest: "var(--color-green)",
|
||||
validate: "var(--color-blue)",
|
||||
modify: "#F97316",
|
||||
secure: "var(--color-red)",
|
||||
store: "var(--color-purple)",
|
||||
alert: "var(--color-amber)",
|
||||
};
|
||||
|
||||
export const PipelineOps: Story = {
|
||||
render: () => (
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 22 }}>
|
||||
{STAGE_ORDER.map((stage) => (
|
||||
<div key={stage}>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: 10,
|
||||
marginBottom: 8,
|
||||
}}
|
||||
>
|
||||
<span
|
||||
style={{
|
||||
width: 8,
|
||||
height: 8,
|
||||
borderRadius: 2,
|
||||
background: STAGE_COLOUR[stage],
|
||||
}}
|
||||
/>
|
||||
<h3
|
||||
style={{
|
||||
margin: 0,
|
||||
fontSize: 13,
|
||||
textTransform: "uppercase",
|
||||
letterSpacing: 0.6,
|
||||
color: "var(--color-text-3)",
|
||||
}}
|
||||
>
|
||||
{stage}
|
||||
</h3>
|
||||
<span style={{ fontSize: 12, color: "var(--color-text-5)" }}>
|
||||
{PIPELINE_OPS[stage].length} ops
|
||||
</span>
|
||||
</div>
|
||||
<div style={{ display: "flex", flexWrap: "wrap", gap: 6 }}>
|
||||
{PIPELINE_OPS[stage].map((op) => (
|
||||
<span
|
||||
key={op.id}
|
||||
title={op.desc}
|
||||
style={{
|
||||
fontSize: 12,
|
||||
padding: "0.25rem 0.625rem",
|
||||
borderRadius: 999,
|
||||
border: `1px solid ${STAGE_COLOUR[stage]}33`,
|
||||
background: `${STAGE_COLOUR[stage]}12`,
|
||||
color: STAGE_COLOUR[stage],
|
||||
fontFamily: "var(--font-mono)",
|
||||
}}
|
||||
>
|
||||
{op.label}
|
||||
{op.defaultOn && (
|
||||
<span
|
||||
style={{
|
||||
marginLeft: 6,
|
||||
fontFamily: "var(--font-sans)",
|
||||
fontSize: 10,
|
||||
opacity: 0.7,
|
||||
}}
|
||||
>
|
||||
· default
|
||||
</span>
|
||||
)}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
export const LibraryByCategory: Story = {
|
||||
render: () => (
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 22 }}>
|
||||
<div style={{ fontSize: 12, color: "var(--color-text-4)" }}>
|
||||
{LIBRARY_OPS.length} library ops across {OP_CATEGORIES.length}{" "}
|
||||
categories
|
||||
</div>
|
||||
{OP_CATEGORIES.map((cat) => {
|
||||
const ops = LIBRARY_OPS.filter((op) => op.category === cat.name);
|
||||
return (
|
||||
<div key={cat.name}>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "baseline",
|
||||
gap: 10,
|
||||
marginBottom: 8,
|
||||
}}
|
||||
>
|
||||
<span
|
||||
style={{
|
||||
width: 8,
|
||||
height: 8,
|
||||
borderRadius: 2,
|
||||
background: cat.color,
|
||||
}}
|
||||
/>
|
||||
<h3
|
||||
style={{
|
||||
margin: 0,
|
||||
fontSize: 13,
|
||||
color: "var(--color-text-1)",
|
||||
}}
|
||||
>
|
||||
{cat.name}
|
||||
</h3>
|
||||
<span style={{ fontSize: 12, color: "var(--color-text-5)" }}>
|
||||
{cat.blurb}
|
||||
</span>
|
||||
<span
|
||||
style={{
|
||||
fontSize: 12,
|
||||
color: "var(--color-text-5)",
|
||||
marginLeft: "auto",
|
||||
}}
|
||||
>
|
||||
{ops.length}
|
||||
</span>
|
||||
</div>
|
||||
<div style={{ display: "flex", flexWrap: "wrap", gap: 6 }}>
|
||||
{ops.map((op) => (
|
||||
<span
|
||||
key={op.id}
|
||||
title={op.desc}
|
||||
style={{
|
||||
fontSize: 12,
|
||||
padding: "0.25rem 0.625rem",
|
||||
borderRadius: 999,
|
||||
border: `1px solid ${cat.color}33`,
|
||||
background: `${cat.color}12`,
|
||||
color: cat.color,
|
||||
fontFamily: "var(--font-mono)",
|
||||
}}
|
||||
>
|
||||
{op.label}
|
||||
{op.provider && (
|
||||
<span
|
||||
style={{
|
||||
marginLeft: 6,
|
||||
fontFamily: "var(--font-sans)",
|
||||
fontSize: 10,
|
||||
opacity: 0.8,
|
||||
}}
|
||||
>
|
||||
· {op.provider}
|
||||
</span>
|
||||
)}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
export const Agents: Story = {
|
||||
render: () => (
|
||||
<div
|
||||
style={{
|
||||
display: "grid",
|
||||
gridTemplateColumns: "repeat(2, 1fr)",
|
||||
gap: 12,
|
||||
}}
|
||||
>
|
||||
{PIPELINE_AGENTS.map((a) => (
|
||||
<div
|
||||
key={a.id}
|
||||
style={{
|
||||
padding: 14,
|
||||
background: "var(--color-surface)",
|
||||
border: "1px solid var(--color-border)",
|
||||
borderRadius: 8,
|
||||
}}
|
||||
>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: 8,
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
<strong style={{ fontSize: 13, color: "var(--color-text-1)" }}>
|
||||
{a.label}
|
||||
</strong>
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 12,
|
||||
color: "var(--color-text-4)",
|
||||
marginBottom: 8,
|
||||
}}
|
||||
>
|
||||
{a.desc}
|
||||
</div>
|
||||
<div style={{ display: "flex", gap: 4, flexWrap: "wrap" }}>
|
||||
{a.ops.map((op) => (
|
||||
<span
|
||||
key={op}
|
||||
style={{
|
||||
fontSize: 11,
|
||||
padding: "0.125rem 0.375rem",
|
||||
borderRadius: 4,
|
||||
background: "var(--color-bg-muted)",
|
||||
color: "var(--color-text-3)",
|
||||
fontFamily: "var(--font-mono)",
|
||||
}}
|
||||
>
|
||||
{op}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
export const SourcesAndDestinations: Story = {
|
||||
render: () => (
|
||||
<div style={{ display: "grid", gridTemplateColumns: "1fr 1fr", gap: 24 }}>
|
||||
<div>
|
||||
<h3 style={{ margin: "0 0 0.625rem", fontSize: 13 }}>Sources</h3>
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 6 }}>
|
||||
{SOURCE_OPTIONS.map((s) => (
|
||||
<div
|
||||
key={s.id}
|
||||
style={{
|
||||
padding: "0.625rem 0.75rem",
|
||||
border: "1px solid var(--color-border)",
|
||||
borderRadius: 6,
|
||||
background: "var(--color-surface)",
|
||||
}}
|
||||
>
|
||||
<div style={{ fontSize: 13, fontWeight: 500 }}>{s.label}</div>
|
||||
<div style={{ fontSize: 12, color: "var(--color-text-4)" }}>
|
||||
{s.desc}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h3 style={{ margin: "0 0 0.625rem", fontSize: 13 }}>Destinations</h3>
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 6 }}>
|
||||
{DESTINATION_OPTIONS.map((d) => (
|
||||
<div
|
||||
key={d.id}
|
||||
style={{
|
||||
padding: "0.625rem 0.75rem",
|
||||
border: "1px solid var(--color-border)",
|
||||
borderRadius: 6,
|
||||
background: "var(--color-surface)",
|
||||
}}
|
||||
>
|
||||
<div style={{ fontSize: 13, fontWeight: 500 }}>{d.label}</div>
|
||||
<div style={{ fontSize: 12, color: "var(--color-text-4)" }}>
|
||||
{d.desc}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
),
|
||||
};
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user