@triiiceratops/plugin-image-export 1.0.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 David Flood
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/catalog.d.ts

@@ -0,0 +1,11 @@
+import type { LocaleCatalog } from '@triiiceratops/plugin-sdk';
+/**
+ * The plugin's package-owned localization catalog (CONTEXT.md **Active
+ * locale**). These strings previously lived in core's `messages/en.json` /
+ * `messages/de.json`; migrating the plugin out of core moves them here so the
+ * catalog ships with (and evolves with) the plugin, and core's catalogs carry
+ * no plugin keys. `en` is the required fallback; a missing key resolves to `en`
+ * and then to the key itself. `image_download_result_downloaded` interpolates a
+ * `{filename}` param through the locale service.
+ */
+export declare const catalog: LocaleCatalog;

package/dist/contextKey.d.ts

@@ -0,0 +1,17 @@
+import type { PluginContext } from '@triiiceratops/plugin-sdk';
+/**
+ * Shared key for handing the SDK {@link PluginContext} to the panel through
+ * Svelte's component-context map. `getContext` returns a plain (non-reactive)
+ * value, which is exactly right here: the activation context is stable for the
+ * lifetime of a mount (a fresh mount gets a fresh context), so it must not be
+ * treated as reactive state. Cross-runtime viewer reactivity is bridged
+ * explicitly inside the panel through `context.viewerState.subscribe` /
+ * `context.selectors`, never through the plugin runtime's own reactivity reading
+ * core's `$state`.
+ */
+export declare const PLUGIN_CONTEXT_KEY: unique symbol;
+/** What `view.mount` passes to the panel through the context map. */
+export interface PanelContext {
+    /** The SDK activation context (viewer state, selectors, services). */
+    readonly context: PluginContext;
+}

package/dist/exportImage.d.ts

@@ -0,0 +1,46 @@
+import type { ViewerState } from 'triiiceratops';
+import { type ExportSizeOption, type ResolvedCanvasImage } from 'triiiceratops/image-export';
+export type ImageDownloadFormat = 'image/png' | 'image/jpeg';
+export type ImageDownloadMode = 'composite' | 'single' | 'world';
+export declare function buildImageDownloadFilename(canvasLabel: string, mode: ImageDownloadMode, format: ImageDownloadFormat): string;
+type ExportOptions = {
+    format?: ImageDownloadFormat;
+    getSelectedChoice?: (canvasId: string) => string | undefined;
+};
+/**
+ * Every painting image on `canvas` resolved for the "single image" picker
+ * and to detect whether "composite canvas" mode has more than one image to
+ * offer.
+ */
+export declare function getCanvasImageChoices(canvas: any, getSelectedChoice?: (canvasId: string) => string | undefined): ResolvedCanvasImage[];
+/**
+ * Resolution options for downloading a single image from a canvas.
+ */
+export declare function resolveSingleImageSizeOptions(resolvedImage: ResolvedCanvasImage): Promise<ExportSizeOption[]>;
+/**
+ * Resolution options for downloading an entire (possibly composite) canvas.
+ * There's no single canonical request URL once there's more than one image,
+ * so this always returns a relative Original/50%/25% ladder based on the
+ * canvas's own declared IIIF dimensions.
+ */
+export declare function resolveCompositeCanvasSizeOptions(canvas: any, getSelectedChoice?: (canvasId: string) => string | undefined): ExportSizeOption[];
+export declare function exportSingleImage(resolvedImage: ResolvedCanvasImage, sizeOption: ExportSizeOption): Promise<Blob>;
+export declare function exportCompositeCanvas(canvas: any, sizeOption: ExportSizeOption, options?: ExportOptions): Promise<Blob>;
+/**
+ * Every canvas currently laid out together in the viewer (e.g. both pages of
+ * a spread in `paged` mode). Used both to build the "current view" composite
+ * and to let "single image" mode target one of several visible canvases
+ * instead of only ever the active one.
+ */
+export declare function getVisibleCanvasesForDownload(viewerState: ViewerState): any[];
+/**
+ * Resolution options for downloading everything currently laid out together
+ * in the viewer (e.g. a two-page spread in `paged` viewing mode). Reuses the
+ * same layout math OSD itself uses (`getCanvasDisplayLayouts`), so the
+ * downloaded image matches what's on screen; there's no single native
+ * reference size across canvases, so this offers a relative ladder against
+ * the first image's own native width as the reference scale.
+ */
+export declare function resolveWorldSizeOptions(viewerState: ViewerState, getSelectedChoice?: (canvasId: string) => string | undefined): ExportSizeOption[];
+export declare function exportCurrentWorld(viewerState: ViewerState, sizeOption: ExportSizeOption, options?: ExportOptions): Promise<Blob>;
+export {};

package/dist/icons.d.ts

@@ -0,0 +1,3 @@
+import { type IconDescriptor } from '@triiiceratops/plugin-sdk';
+/** The toolbar icon descriptor (the download glyph), validated by `svgIcon`. */
+export declare const DOWNLOAD_ICON: IconDescriptor;

package/dist/iife.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Self-contained IIFE entry — loadable from a `<script>` tag with no bundler.
+ *
+ * Loading this bundle bootstraps the `window.Triiiceratops` namespace if absent
+ * and registers the plugin factory into `window.Triiiceratops.plugins` (SPEC.md
+ * "Browser IIFEs register package-qualified factories in one `window.Triiiceratops`
+ * namespace"). It does NOT activate anything — activation is explicit and per
+ * viewer:
+ *
+ * ```html
+ * <script src="triiiceratops-element.iife.js"></script>
+ * <script src="triiiceratops-plugin-image-export.iife.js"></script>
+ * <script>
+ *   const viewer = document.querySelector('triiiceratops-viewer');
+ *   viewer.plugins = [
+ *     window.Triiiceratops.plugins.get('@triiiceratops/plugin-image-export'),
+ *   ];
+ * </script>
+ * ```
+ *
+ * The plugin script may load before OR after core: the registry is bootstrapped
+ * order-independently, so both script orders work.
+ */
+export {};