@triiiceratops/plugin-pdf-export 1.0.0-rc.1

package/dist/plugin.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The PDF-export plugin, authored entirely on `@triiiceratops/plugin-sdk`.
+ *
+ * `definePlugin` returns the framework-neutral factory core activates through the
+ * structural seam (it carries its own `activate(host)`); core never imports this
+ * package, its Svelte runtime, or its `pdf-lib` dependency. The UI is Svelte,
+ * mounted through the neutral `view.mount(container, context)` contract and torn
+ * down by the returned cleanup. Styles install through the SDK style service
+ * (root-aware), strings resolve through the per-viewer locale service over this
+ * package's catalog, and the toolbar glyph is a `svgIcon` descriptor.
+ *
+ * The factory-with-config authoring API is preserved: `createPdfExportPlugin(config)`
+ * stays the public entry (a consumer can supply a cover sheet, filename provider,
+ * OCR overlay provider, custom image loader, etc.), adapted to `definePlugin`
+ * internally. The consumer `config` is captured in the `view.mount` closure and
+ * handed to the panel through Svelte's context map, so each activation renders
+ * with its own configuration. A preconfigured default (`PdfExportPlugin`) is
+ * exported alongside it.
+ *
+ * The plugin reads the raw OSD viewer (`ViewerState.osdViewer`) to size export
+ * requests, so it declares `requiredCapabilities: ['osd@5']`.
+ */
+import { type SdkPlugin } from '@triiiceratops/plugin-sdk';
+import type { PdfExportConfig } from './types';
+/**
+ * Create a PDF-export plugin factory with consumer configuration. Activate the
+ * returned factory explicitly, per viewer.
+ */
+export declare function createPdfExportPlugin(config?: PdfExportConfig): SdkPlugin;
+/** A preconfigured PDF-export plugin (no consumer config). */
+export declare const PdfExportPlugin: SdkPlugin;

package/dist/reportError.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Route an actionable export failure to the host through the structured
+ * `pluginerror` channel (ticket 09 shape, {@link PluginError}) instead of the
+ * browser console; `node` is the panel's own root element, which lives inside the viewer
+ * root, so a bubbling + composed event reaches the host's `pluginerror` listener
+ * and escapes the shadow root for a Web Component host — the same delivery core
+ * uses for lifecycle failures. The event name is core's `PLUGIN_ERROR_EVENT`
+ * (`'pluginerror'`); it is used as a string literal so this framework-neutral
+ * bundle never pulls in core's runtime entry.
+ *
+ * `phase` is `'command'`: the failure occurred while carrying out a user-driven
+ * viewer operation (the export action), the closest lifecycle phase in
+ * {@link PluginError}. `retry` re-runs that operation.
+ */
+export declare function reportPdfExportError(node: EventTarget, error: unknown, retry: () => void): void;

package/dist/styles.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The plugin's package-owned global CSS + its style-service install id, shaped
+ * by {@link definePluginStyles} into the `STYLES` / `STYLE_ID` exports the
+ * activation installs. Class names are namespaced `tri-pdf-*` since these rules
+ * are not Svelte-scoped.
+ *
+ * Chrome ownership (epic restore-plugin-toolbar-chrome, ticket 05): core owns
+ * the toolbar button and the docked panel chrome (surface, sticky header, radius,
+ * open/close). These rules therefore style ONLY the panel's content body — no
+ * self-positioned toggle, no `position: absolute`, no panel surface/border. The
+ * body layout mirrors core's former `PdfExportPanel` embedded look; the range
+ * `Select`s and export `Button` are themed by the shared `@triiiceratops/ui`
+ * primitives, so no bespoke control styling lives here. Tokens are the current
+ * `--tri-` theme variables.
+ */
+export declare const STYLES: string, STYLE_ID: string;

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+import type { PdfCanvasOcrOverlayProvider, PdfCoverSheetConfig, PdfExportFilenameProvider, PdfImageLoader, PdfImageRequestConfig, PdfOcrPlacementMode, PdfOcrSizingMode, PdfOcrVisibilityMode } from './exportPdf';
+/**
+ * Consumer-facing configuration for the PDF export plugin. This is the same
+ * public shape the plugin exposed before it moved to its own package (ticket 16
+ * moved it here unchanged), so `createPdfExportPlugin(config)` keeps its
+ * factory-with-config authoring contract.
+ */
+export type PdfExportConfig = {
+    coverSheet?: PdfCoverSheetConfig;
+    filename?: string;
+    getFilename?: PdfExportFilenameProvider;
+    ocrAnnotationSource?: string;
+    getCanvasOcrOverlays?: PdfCanvasOcrOverlayProvider;
+    imageRequest?: PdfImageRequestConfig;
+    loadImageBlob?: PdfImageLoader;
+    ocrPlacementMode?: PdfOcrPlacementMode;
+    ocrSizingMode?: PdfOcrSizingMode;
+    ocrVisibilityMode?: PdfOcrVisibilityMode;
+    onSelectionChange?: PdfExportSelectionChangeHandler;
+};
+/** The current start/end selection reported through `onSelectionChange`. */
+export type PdfExportSelection = {
+    startIndex: number | null;
+    endIndex: number | null;
+    startCanvas: any | null;
+    endCanvas: any | null;
+};
+export type PdfExportSelectionChangeHandler = (selection: PdfExportSelection) => void;

package/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "@triiiceratops/plugin-pdf-export",
+    "version": "1.0.0-rc.1",
+    "type": "module",
+    "description": "PDF export plugin for the triiiceratops IIIF viewer, authored on @triiiceratops/plugin-sdk. Owns its own pdf-lib dependency.",
+    "license": "MIT",
+    "author": "David Flood",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/d-flood/triiiceratops.git",
+        "directory": "packages/plugin-pdf-export"
+    },
+    "homepage": "https://d-flood.github.io/triiiceratops/",
+    "publishConfig": {
+        "access": "public",
+        "provenance": true
+    },
+    "private": false,
+    "engines": {
+        "node": ">=22"
+    },
+    "sideEffects": [
+        "./dist/iife.js"
+    ],
+    "files": [
+        "dist",
+        "LICENSE"
+    ],
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "./iife": "./dist/iife.js"
+    },
+    "scripts": {
+        "build": "pnpm build:esm && pnpm build:iife && pnpm build:types",
+        "build:esm": "BUILD_FORMAT=es vite build",
+        "build:iife": "BUILD_FORMAT=iife vite build",
+        "build:types": "tsc -p tsconfig.build.json",
+        "check": "svelte-check --tsconfig ./tsconfig.json --fail-on-warnings && tsc -p tsconfig.build.json --noEmit",
+        "test": "vitest run",
+        "clean": "rm -rf dist",
+        "test:coverage": "vitest run --coverage",
+        "lint": "eslint . --max-warnings 0",
+        "lint:fix": "eslint . --fix --max-warnings 0"
+    },
+    "peerDependencies": {
+        "triiiceratops": "workspace:^",
+        "@triiiceratops/plugin-sdk": "workspace:^"
+    },
+    "dependencies": {
+        "pdf-lib": "^1.17.1"
+    },
+    "devDependencies": {
+        "@sveltejs/vite-plugin-svelte": "^6.2.1",
+        "@triiiceratops/plugin-sdk": "workspace:*",
+        "@triiiceratops/ui": "workspace:*",
+        "@vitest/coverage-v8": "4.0.15",
+        "happy-dom": "^20.0.11",
+        "svelte": "5.45.5",
+        "svelte-check": "^4.3.4",
+        "triiiceratops": "workspace:*",
+        "typescript": "~5.9.3",
+        "vite": "^6.0.0",
+        "vitest": "^4.0.15"
+    }
+}