@printwithsynergy/lens-pdf 0.3.0-beta.81

package/dist/components/LensPDFDemo.d.ts

@@ -0,0 +1,160 @@
+import type { ReactNode } from "react";
+import { type MinimalCodexClient } from "../browser";
+import type { ThemeTokens, ViewerServices } from "../plugin/services";
+import type { OverlayItem } from "../plugin/types";
+import type { DielineResult } from "../types";
+import { type LensPDFPresetKind } from "./presets";
+import { type LensPDFShellPlugin } from "./shellPlugins";
+/**
+ * Tool ids the demo's sidebar can show. The `tools` prop accepts any
+ * subset; default is every tool. Passing `[]` hides the entire tool
+ * column, giving consumers a "viewer only" mount.
+ *
+ * @public
+ */
+export type LensPDFDemoTool = "color-picker" | "densitometer" | "measure" | "annotate" | "tac-heatmap" | "separations" | "layers";
+/**
+ * Props for {@link LensPDFDemo}.
+ *
+ * @public
+ */
+export interface LensPDFDemoProps {
+    /** Theme tokens. Defaults to {@link darkThemeTokens}. */
+    tokens?: Partial<ThemeTokens>;
+    /** Maximum upload size in bytes. Default: 50 MB. */
+    maxFileSize?: number;
+    /** Brand label in the top bar. Default: "LensPDF". */
+    brand?: string;
+    /** Brand logo URL for the top bar. */
+    brandLogoUrl?: string;
+    /** Optional className on the outermost div. */
+    className?: string;
+    /** Tools to show in the sidebar. Default: every tool. */
+    tools?: ReadonlyArray<LensPDFDemoTool>;
+    /** Initial zoom percentage. Default: 80. */
+    initialZoom?: number;
+    /** TAC limit for the heatmap + densitometer. Default: 300. */
+    tacLimit?: number;
+    /** Override pdf.js worker URL (unpkg by default). */
+    workerSrc?: string;
+    /**
+     * Pre-built services. When provided, Lens uses them where wired and
+     * automatically falls back to in-browser RGB/pdf.js services for any
+     * unwired capability. This keeps LintPDF/backends optional.
+     */
+    services?: ViewerServices;
+    /** Optional footer content below the viewer. */
+    footer?: ReactNode;
+    /** When true, renders full-viewport with fixed positioning. */
+    fullscreen?: boolean;
+    /** Pre-loaded PDF URL (e.g. from query params). Skips empty state. */
+    initialPdfUrl?: string;
+    /** Initial page number (1-indexed). Default: 1. */
+    initialPage?: number;
+    /**
+     * When true, hides the upload chrome (URL bar, file picker, drag &
+     * drop, empty state) and renders as an embedded production viewer.
+     * `initialPdfUrl` becomes effectively required. Used internally by
+     * `<LensPDF>` to expose a clean drop-in surface.
+     */
+    embedded?: boolean;
+    /**
+     * Findings to flag on the page raster. Hosts convert their domain
+     * records (engine findings, brand-spec violations, etc.) into
+     * `OverlayItem`s. PageCanvas draws the bbox tinted by `tier`,
+     * PageNavigator badges errors / warnings per page.
+     */
+    items?: readonly OverlayItem[];
+    /**
+     * Force the Inspection / Findings side-panel slot visible even when
+     * ``items`` is empty. Renders an empty "no findings yet" state so
+     * the slot stays in the layout. Defaults to ``false`` — hosts
+     * without preflight data don't see a placeholder panel.
+     *
+     * Useful for:
+     * - Demos that want the panel discoverable from the first frame.
+     * - Hosts with an in-flight preflight call (stable layout while it
+     *   loads).
+     * - Adapters where the user explicitly toggles preflight on/off in
+     *   the UI and you want to keep the slot mounted across that toggle.
+     */
+    forceInspectionPanel?: boolean;
+    /**
+     * Spot-color palette keyed by spot name (case insensitive). Wins
+     * over the Pantone Gold library + the PDF's ``altRgb`` fallback in
+     * the separations panel swatch render. Hosts that have richer
+     * sources of truth (codex's ``summary.spot_colors.colors[].swatch_hex``,
+     * a callas / PitStop / Acrobat preflight report, an internal
+     * swatch DB) pass values here.
+     *
+     * Example: ``{ "PANTONE 225 C": "#c6168d", "PANTONE 236 C": "#da1884" }``.
+     */
+    spotPalette?: Record<string, string>;
+    /** Currently-selected finding (controlled). Drives the canvas
+     *  highlight + tooltip. */
+    selectedItem?: OverlayItem | null;
+    /** Fires when the user clicks a finding's bbox or the page background
+     *  (in which case the argument is `null`). */
+    onItemSelect?: (item: OverlayItem | null) => void;
+    /**
+     * Dieline payload for the current page. When non-null, mounts
+     * `<DielineOverlay>` so each detected artwork region gets a
+     * size-popover info chip at its centroid (mm + inches).
+     */
+    dieline?: DielineResult | null;
+    /**
+     * When true, mounts `<BoxOverlay>` so trim / bleed / crop boxes
+     * defined in the PDF render with size popovers. Hosts that don't
+     * carry box geometry can leave this off (default).
+     */
+    showBoxOverlays?: boolean;
+    /**
+     * When true, the canvas is clipped to the page's TrimBox (falls
+     * back to BleedBox, then CropBox). Hides the white bleed strip
+     * outside the trim line. Default false.
+     */
+    cropToTrim?: boolean;
+    /** Fires after the active page changes (1-indexed). */
+    onPageChange?: (page: number) => void;
+    /** Fires after the zoom level changes (percentage). */
+    onZoomChange?: (zoom: number) => void;
+    /** Fires when the viewer raises a recoverable error. */
+    onError?: (message: string) => void;
+    /** First-party plugin preset used as the base composition. */
+    preset?: LensPDFPresetKind;
+    /**
+     * Additional shell plugins (or replacements) for panels and toolbar
+     * slots. Use `replaces` on your plugin to override a built-in one.
+     */
+    plugins?: ReadonlyArray<LensPDFShellPlugin>;
+    /**
+     * Optional codex client. When provided, `<LensPDFDemo>` fires
+     * `extractStream` in the background after each PDF loads. As codex
+     * events arrive the viewer silently upgrades:
+     *
+     * - `colorWorld` → separations panel shows pikepdf-accurate ink list
+     *   (including spots inside compressed streams that the browser's
+     *   regex parser misses).
+     * - `phase2_complete` → separations, TAC heatmap, and layers switch
+     *   to Ghostscript-rendered plates (higher fidelity than the
+     *   pdfjs RGB-approximated versions).
+     *
+     * Tools remain fully active on pdfjs throughout — there is no loading
+     * state or disabled period. Codex is a silent quality upgrade.
+     *
+     * Accepts any object satisfying {@link MinimalCodexClient} —
+     * including `HttpClient` from `@printwithsynergy/codex-client`.
+     */
+    codex?: MinimalCodexClient;
+}
+/**
+ * Complete interactive LensPDF demo — upload, URL paste, drag-drop,
+ * validation, sidebar controls, theming, and optional fullscreen mode.
+ * All viewer-only features (color picker, densitometer, measure,
+ * separations, TAC heatmap, layers, annotations) are wired out of the
+ * box.
+ *
+ * @public
+ */
+export declare function LensPDFDemo({ tokens: tokenOverrides, maxFileSize, brand, brandLogoUrl, className, tools, initialZoom, tacLimit, workerSrc, services: serviceOverrides, footer, fullscreen: initialFullscreen, initialPdfUrl, initialPage, embedded, items, forceInspectionPanel, spotPalette, selectedItem, onItemSelect, dieline, showBoxOverlays, cropToTrim, onPageChange: onPageChangeProp, onZoomChange: onZoomChangeProp, onError: onErrorProp, preset, plugins: customPlugins, codex, }: LensPDFDemoProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=LensPDFDemo.d.ts.map

package/dist/components/LensPDFDemo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensPDFDemo.d.ts","sourceRoot":"","sources":["../../components/LensPDFDemo.tsx"],"names":[],"mappings":"AA+DA,OAAO,KAAK,EAAiB,SAAS,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,EASL,KAAK,kBAAkB,EAExB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,UAAU,CAAC;AAsCxD,OAAO,EAAoB,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EAIL,KAAK,kBAAkB,EAGxB,MAAM,gBAAgB,CAAC;AAMxB;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GACvB,cAAc,GACd,cAAc,GACd,SAAS,GACT,UAAU,GACV,aAAa,GACb,aAAa,GACb,QAAQ,CAAC;AAYb;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9B,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IACvC,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,gDAAgD;IAChD,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC;+BAC2B;IAC3B,YAAY,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAClC;kDAC8C;IAC9C,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IAClD;;;;OAIG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC/B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,uDAAuD;IACvD,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,uDAAuD;IACvD,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,wDAAwD;IACxD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,8DAA8D;IAC9D,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAC5C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC;CAC5B;AAwBD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EAAE,cAAc,EACtB,WAA+B,EAC/B,KAAK,EACL,YAAY,EACZ,SAAS,EACT,KAAqB,EACrB,WAAgB,EAChB,QAAc,EACd,SAAS,EACT,QAAQ,EAAE,gBAAgB,EAC1B,MAAM,EACN,UAAU,EAAE,iBAAyB,EACrC,aAAa,EACb,WAAe,EACf,QAAgB,EAChB,KAAK,EACL,oBAAoB,EACpB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,eAAuB,EACvB,UAAkB,EAClB,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,OAAO,EAAE,WAAW,EACpB,MAAe,EACf,OAAO,EAAE,aAAkB,EAC3B,KAAK,GACN,EAAE,gBAAgB,2CA4gDlB"}