@triiiceratops/plugin-image-export 1.0.0-rc.5 → 1.0.0

package/dist/catalog.d.ts

@@ -1,11 +1,10 @@
 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.
+ * locale**): ships with the plugin rather than living in core's catalogs, so
+ * core carries 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/exportImage.d.ts

@@ -1,12 +1,28 @@
 import type { ViewerState } from 'triiiceratops';
 import { type ExportSizeOption, type ResolvedCanvasImage } from 'triiiceratops/image-export';
+export { isCrossOriginImageFailure } 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;
+/**
+ * The default name for a downloaded image: the manifest's label and the canvas's
+ * label, in that order, sanitized for a filesystem.
+ *
+ * Both labels are localized IIIF language maps, so the caller resolves them in
+ * the viewer's **active locale** rather than passing raw JSON here — a reader
+ * browsing in French should get `Evangiles-Folio-2r.jpg`, not the English label.
+ * Either may resolve to nothing (a manifest with no label, an unlabeled canvas),
+ * and whichever survives is used alone.
+ */
+export declare function buildImageDownloadFilename(canvasLabel: string, mode: ImageDownloadMode, format: ImageDownloadFormat, manifestLabel?: string | null): string;
 type ExportOptions = {
     format?: ImageDownloadFormat;
     getSelectedChoice?: (canvasId: string) => string | undefined;
 };
+/**
+ * The image server a resolved image comes from, for an error message that names
+ * who declined. `null` when there is no absolute URL to read a host from.
+ */
+export declare function getImageHost(resolved: ResolvedCanvasImage): string | null;
 /**
  * Every painting image on `canvas` resolved for the "single image" picker
  * and to detect whether "composite canvas" mode has more than one image to
@@ -27,20 +43,26 @@ export declare function resolveCompositeCanvasSizeOptions(canvas: any, getSelect
 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.
+ * Every canvas currently laid out together in the viewer that this plugin can
+ * actually produce an image from (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.
+ *
+ * A canvas whose painting bodies are all non-image — the **unsupported
+ * presentation**, a video or a sound recording sharing the spread — is left out
+ * here rather than downstream. It is the difference between an export the
+ * reader is never offered and one offered, chosen, and then refused for want of
+ * a resolution to pick.
  */
 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
+ * same layout math the viewer 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/identity.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This plugin's identity, in one place.
+ *
+ * `definePlugin` and the `pluginerror` reporter both need it, and writing the
+ * version out at each site is how the two drifted from each other.
+ */
+export declare const PLUGIN_META: {
+    readonly name: "@triiiceratops/plugin-image-export";
+    readonly version: "1.0.0";
+};