@file-viewer/core 2.1.26 → 2.1.27

package/dist/contracts/types.d.ts

@@ -186,6 +186,28 @@ export interface FileViewerPresentationOptions {
     workerType?: WorkerType;
 }
 export type FileRenderExportMode = 'export' | 'print';
+export type FileViewerRenderPurpose = 'preview' | 'thumbnail';
+export type FileViewerThumbnailFormat = 'webp' | 'jpeg' | 'png';
+export type FileViewerThumbnailFit = 'contain' | 'cover';
+export interface FileViewerThumbnailCaptureOptions {
+    width: number;
+    height: number;
+    format: FileViewerThumbnailFormat;
+    quality: number;
+    fit: FileViewerThumbnailFit;
+    background: string;
+    signal?: AbortSignal;
+}
+export interface FileRenderThumbnailAdapter {
+    /** Prepare lazy content immediately before capture. */
+    beforeCapture?: (options: FileViewerThumbnailCaptureOptions) => void | Promise<void>;
+    /** Identifies a capture result that comes from packaged metadata rather than rendered content. */
+    captureSource?: 'embedded' | 'rendered';
+    /** A renderer-native fast path. Returning null delegates to the DOM fallback. */
+    capture?: (options: FileViewerThumbnailCaptureOptions) => Blob | null | Promise<Blob | null>;
+    /** The first page/slide/sheet/cover element used by the DOM fallback. */
+    getTarget?: (options: FileViewerThumbnailCaptureOptions) => Element | null | Promise<Element | null>;
+}
 export interface FileRenderExportOptions {
     mode: FileRenderExportMode;
     title: string;
@@ -202,9 +224,12 @@ export interface FileRenderContext {
     filename?: string;
     url?: string;
     streamUrl?: string;
+    signal?: AbortSignal;
     options?: FileViewerOptions;
     surface?: RenderSurface;
     registerExportAdapter?: (adapter: FileRenderExportAdapter | null) => void;
+    registerThumbnailAdapter?: (adapter: FileRenderThumbnailAdapter | null) => void;
+    renderPurpose?: FileViewerRenderPurpose;
     onProgressiveRender?: () => void;
     renderNestedBuffer?: (buffer: ArrayBuffer, type: string, target: HTMLDivElement, context?: FileRenderContext) => Promise<FileViewerRenderedInstance | undefined>;
 }
@@ -846,6 +871,7 @@ export interface RendererLoadContext {
     options: FileViewerOptions;
     signal?: AbortSignal;
     registerExportAdapter?: (adapter: FileRenderExportAdapter | null) => void;
+    registerThumbnailAdapter?: (adapter: FileRenderThumbnailAdapter | null) => void;
     renderContext?: FileRenderContext;
 }
 export interface RendererSession {
@@ -897,9 +923,15 @@ export interface FileViewerRendererPreset<Handler = FileRenderHandler> {
 }
 export type FileViewerRendererPluginInput<Handler = FileRenderHandler> = FileViewerRendererPlugin<Handler> | FileViewerRendererPreset<Handler> | readonly FileViewerRendererPluginInput<Handler>[];
 export type FileViewerRendererPresetInput<Handler = FileRenderHandler> = FileViewerRendererPresetName | FileViewerRendererPluginInput<Handler> | readonly FileViewerRendererPresetInput<Handler>[];
+export interface FileViewerLoadOptions {
+    signal?: AbortSignal;
+}
 export interface FileViewerInstance {
     readonly container: HTMLElement;
-    load(source: FileViewerSource): Promise<RendererSession | null>;
+    /** Installs configured renderer plugins without loading a document. */
+    prepare?(): Promise<void>;
+    load(source: FileViewerSource, options?: FileViewerLoadOptions): Promise<RendererSession | null>;
+    unload?(reason?: FileViewerLifecycleContext['reason']): Promise<void>;
     destroy(reason?: FileViewerLifecycleContext['reason']): Promise<void>;
     updateOptions(options: Partial<FileViewerOptions>): void;
     getCapabilities(extension?: string): FileViewerOperationAvailability;
@@ -907,6 +939,8 @@ export interface FileViewerInstance {
     getSource(): NormalizedFileViewerSource | null;
     registerExportAdapter(adapter: FileRenderExportAdapter | null): void;
     getExportAdapter(): FileRenderExportAdapter | null;
+    registerThumbnailAdapter?(adapter: FileRenderThumbnailAdapter | null): void;
+    getThumbnailAdapter?(): FileRenderThumbnailAdapter | null;
     download(options?: FileViewerDownloadOptions): Promise<void>;
     exportHtml(options?: FileViewerExportHtmlOptions): Promise<string>;
     print(options?: FileViewerPrintOptions): Promise<void>;

package/dist/index.d.ts

@@ -88,4 +88,4 @@ export type { CreateFileViewerZoomControllerOptions, FileViewerZoomOperation, }
 export type { CreateViewerOptions } from './viewer/createViewer';
 export type { BuildExportHtmlDocumentOptions, BuildFileViewerRenderedHtmlDocumentOptions, } from './output/export';
 export type { CreateFileViewerWorkerControllerOptions, FileViewerWorkerContext, FileViewerWorkerController, FileViewerWorkerErrorHook, FileViewerWorkerEventHandler, FileViewerWorkerFactory, FileViewerWorkerMessageHook, WorkerProvider, WorkerRef, } from './platform/worker';
-export type { FileViewerAiOptions, FileViewerArchiveEntryActionContext, FileViewerArchiveEntryActionPolicy, FileViewerArchiveEntryActionsOptions, FileViewerArchivePasswordRequestContext, FileViewerArchivePasswordRequestReason, FileViewerArchiveOptions, FileViewerApplyViewStateOptions, FileViewerBeforeOperation, FileViewerCadDwfLineWeightMode, FileViewerCadOptions, FileViewerCadRenderer, FileViewerComponentEmits, FileViewerComponentEventMap, FileViewerComponentProps, FileViewerDocumentAnchor, FileViewerDocumentChunk, FileViewerDownloadOptions, FileViewerDocxOptions, FileViewerDrawingOptions, FileViewerEvent, FileViewerEventHandler, FileViewerEventType, FileViewerExportHtmlOptions, FileViewerFileRef, FileViewerFitMode, FileViewerFitOptions, FileViewerFitRequest, FileViewerFitResize, FileViewerFitResult, FileViewerGeoBasemapOptions, FileViewerGeoBasemapPreset, FileViewerGeoOptions, FileRenderContext, FileRenderExportAdapter, FileRenderExportMode, FileRenderExportOptions, FileRenderHandler, FileRenderHandlerComposite, FileViewerBuiltinRendererPreset, FileViewerInstance, FileViewerLifecycleContext, FileViewerLifecycleHooks, FileViewerLifecyclePhase, FileViewerI18nOptions, FileViewerLocale, FileViewerMessageKey, FileViewerMessageParams, FileViewerMessageResolver, FileViewerMessages, FileViewerNavigationState, FileViewerOperationAvailability, FileViewerOperationContext, FileViewerOperationType, FileViewerOptions, FileViewerPdfOptions, FileViewerPresentationOptions, FileViewerPrintOptions, FileViewerPublicApi, FileViewerRenderedInstance, FileViewerRendererMode, FileViewerRendererPluginAssetKind, FileViewerRendererPluginAssetManifest, FileViewerRendererPluginAssetEntry, FileViewerRenderStateKind, FileViewerRendererCategory, FileViewerRendererHandlerRegistration, FileViewerRendererInstallContext, FileViewerRendererPlugin, FileViewerRendererPluginInput, FileViewerRendererPresetInput, FileViewerRendererPresetName, FileViewerRendererPreset, FileViewerSearchMatch, FileViewerSearchOptions, FileViewerSearchProvider, FileViewerSearchState, FileViewerSource, FileViewerSourceKind, FileViewerSpreadsheetOptions, FileViewerStateDescriptor, FileViewerStateTheme, FileViewerStyleIsolation, FileViewerTextOptions, FileViewerResolvedThemeMode, FileViewerThemeMode, FileViewerToolbarActionMap, FileViewerToolbarItem, FileViewerToolbarOptions, FileViewerToolbarPosition, FileViewerResolvedToolbarItem, FileViewerUiDensity, FileViewerUiOptions, FileViewerTypstOptions, FileViewerViewScrollState, FileViewerViewState, FileViewerViewStateChange, FileViewerViewStateChangeAction, FileViewerViewStateChangeSource, FileViewerViewStateProvider, FileViewerWatermarkOptions, FileViewerZoomProvider, FileViewerZoomState, NormalizedFileViewerSource, RendererCapability, RendererDefinition, RendererPlugin, RendererLoadContext, RendererLoader, RendererRegistry, RendererSession, RenderSurface, ViewerCapabilityState, ViewerLifecycleContext, ViewerOperationContext, } from './contracts/types';
+export type { FileViewerAiOptions, FileViewerArchiveEntryActionContext, FileViewerArchiveEntryActionPolicy, FileViewerArchiveEntryActionsOptions, FileViewerArchivePasswordRequestContext, FileViewerArchivePasswordRequestReason, FileViewerArchiveOptions, FileViewerApplyViewStateOptions, FileViewerBeforeOperation, FileViewerCadDwfLineWeightMode, FileViewerCadOptions, FileViewerCadRenderer, FileViewerComponentEmits, FileViewerComponentEventMap, FileViewerComponentProps, FileViewerDocumentAnchor, FileViewerDocumentChunk, FileViewerDownloadOptions, FileViewerDocxOptions, FileViewerDrawingOptions, FileViewerEvent, FileViewerEventHandler, FileViewerEventType, FileViewerExportHtmlOptions, FileViewerFileRef, FileViewerFitMode, FileViewerFitOptions, FileViewerFitRequest, FileViewerFitResize, FileViewerFitResult, FileViewerGeoBasemapOptions, FileViewerGeoBasemapPreset, FileViewerGeoOptions, FileRenderContext, FileRenderExportAdapter, FileRenderThumbnailAdapter, FileRenderExportMode, FileRenderExportOptions, FileRenderHandler, FileRenderHandlerComposite, FileViewerBuiltinRendererPreset, FileViewerInstance, FileViewerLoadOptions, FileViewerLifecycleContext, FileViewerLifecycleHooks, FileViewerLifecyclePhase, FileViewerI18nOptions, FileViewerLocale, FileViewerMessageKey, FileViewerMessageParams, FileViewerMessageResolver, FileViewerMessages, FileViewerNavigationState, FileViewerOperationAvailability, FileViewerOperationContext, FileViewerOperationType, FileViewerOptions, FileViewerPdfOptions, FileViewerPresentationOptions, FileViewerPrintOptions, FileViewerPublicApi, FileViewerRenderedInstance, FileViewerRendererMode, FileViewerRendererPluginAssetKind, FileViewerRendererPluginAssetManifest, FileViewerRendererPluginAssetEntry, FileViewerRenderStateKind, FileViewerRenderPurpose, FileViewerRendererCategory, FileViewerRendererHandlerRegistration, FileViewerRendererInstallContext, FileViewerRendererPlugin, FileViewerRendererPluginInput, FileViewerRendererPresetInput, FileViewerRendererPresetName, FileViewerRendererPreset, FileViewerSearchMatch, FileViewerSearchOptions, FileViewerSearchProvider, FileViewerSearchState, FileViewerSource, FileViewerSourceKind, FileViewerThumbnailCaptureOptions, FileViewerThumbnailFit, FileViewerThumbnailFormat, FileViewerSpreadsheetOptions, FileViewerStateDescriptor, FileViewerStateTheme, FileViewerStyleIsolation, FileViewerTextOptions, FileViewerResolvedThemeMode, FileViewerThemeMode, FileViewerToolbarActionMap, FileViewerToolbarItem, FileViewerToolbarOptions, FileViewerToolbarPosition, FileViewerResolvedToolbarItem, FileViewerUiDensity, FileViewerUiOptions, FileViewerTypstOptions, FileViewerViewScrollState, FileViewerViewState, FileViewerViewStateChange, FileViewerViewStateChangeAction, FileViewerViewStateChangeSource, FileViewerViewStateProvider, FileViewerWatermarkOptions, FileViewerZoomProvider, FileViewerZoomState, NormalizedFileViewerSource, RendererCapability, RendererDefinition, RendererPlugin, RendererLoadContext, RendererLoader, RendererRegistry, RendererSession, RenderSurface, ViewerCapabilityState, ViewerLifecycleContext, ViewerOperationContext, } from './contracts/types';

package/dist/registry/formats.d.ts

@@ -315,4 +315,4 @@ export declare const DEFAULT_RENDERER_DEFINITIONS: readonly [{
         readonly search: true;
     };
 }];
-export declare const DEFAULT_SUPPORTED_EXTENSIONS: readonly ("markdown" | "xyz" | "wasm" | "pdf" | "typst" | "zip" | "zipx" | "7z" | "rar" | "tar" | "gz" | "gzip" | "tgz" | "bz2" | "bzip2" | "tbz" | "tbz2" | "xz" | "txz" | "lzma" | "zst" | "tzst" | "cab" | "ar" | "cpio" | "iso" | "xar" | "lha" | "lzh" | "jar" | "war" | "ear" | "apk" | "cbz" | "cbr" | "glb" | "gltf" | "obj" | "stl" | "ply" | "fbx" | "dae" | "3ds" | "3mf" | "amf" | "usd" | "usda" | "usdc" | "usdz" | "kmz" | "step" | "stp" | "iges" | "igs" | "ifc" | "3dm" | "brep" | "pcd" | "wrl" | "vrml" | "vtk" | "vtp" | "txt" | "json" | "js" | "mjs" | "cjs" | "css" | "java" | "py" | "html" | "htm" | "jsx" | "ts" | "tsx" | "xml" | "log" | "vue" | "yaml" | "yml" | "ini" | "sh" | "bash" | "sql" | "go" | "rs" | "php" | "c" | "cpp" | "cc" | "h" | "hpp" | "cs" | "diff" | "patch" | "bundle" | "bdl" | "jsonc" | "json5" | "ipynb" | "toml" | "proto" | "hcl" | "tex" | "gv" | "http" | "react" | "rb" | "swift" | "kt" | "gif" | "jpg" | "jpeg" | "bmp" | "tiff" | "tif" | "png" | "svg" | "webp" | "avif" | "ico" | "heic" | "heif" | "jxl" | "docx" | "docm" | "dotx" | "dotm" | "doc" | "dot" | "pptx" | "pptm" | "potx" | "potm" | "ppsx" | "ppsm" | "rtf" | "odt" | "odp" | "xlsx" | "xltx" | "xlsm" | "xlsb" | "xls" | "xlt" | "xltm" | "csv" | "ods" | "fods" | "numbers" | "ofd" | "typ" | "eml" | "msg" | "mbox" | "olb" | "dra" | "gds" | "oas" | "oasis" | "dxf" | "dwg" | "dwf" | "dwfx" | "xps" | "geojson" | "kml" | "gpx" | "shp" | "excalidraw" | "drawio" | "dio" | "mermaid" | "mmd" | "plantuml" | "puml" | "xmind" | "epub" | "umd" | "md" | "mp4" | "webm" | "m3u8" | "mp3" | "mpeg" | "wav" | "ogg" | "oga" | "opus" | "m4a" | "aac" | "flac" | "weba" | "midi" | "mid" | "ttf" | "otf" | "woff" | "woff2" | "psd" | "ai" | "eps" | "sqlite" | "parquet" | "avro" | "webarchive")[];
+export declare const DEFAULT_SUPPORTED_EXTENSIONS: readonly ("markdown" | "webp" | "jpeg" | "png" | "xyz" | "wasm" | "pdf" | "typst" | "zip" | "zipx" | "7z" | "rar" | "tar" | "gz" | "gzip" | "tgz" | "bz2" | "bzip2" | "tbz" | "tbz2" | "xz" | "txz" | "lzma" | "zst" | "tzst" | "cab" | "ar" | "cpio" | "iso" | "xar" | "lha" | "lzh" | "jar" | "war" | "ear" | "apk" | "cbz" | "cbr" | "glb" | "gltf" | "obj" | "stl" | "ply" | "fbx" | "dae" | "3ds" | "3mf" | "amf" | "usd" | "usda" | "usdc" | "usdz" | "kmz" | "step" | "stp" | "iges" | "igs" | "ifc" | "3dm" | "brep" | "pcd" | "wrl" | "vrml" | "vtk" | "vtp" | "txt" | "json" | "js" | "mjs" | "cjs" | "css" | "java" | "py" | "html" | "htm" | "jsx" | "ts" | "tsx" | "xml" | "log" | "vue" | "yaml" | "yml" | "ini" | "sh" | "bash" | "sql" | "go" | "rs" | "php" | "c" | "cpp" | "cc" | "h" | "hpp" | "cs" | "diff" | "patch" | "bundle" | "bdl" | "jsonc" | "json5" | "ipynb" | "toml" | "proto" | "hcl" | "tex" | "gv" | "http" | "react" | "rb" | "swift" | "kt" | "gif" | "jpg" | "bmp" | "tiff" | "tif" | "svg" | "avif" | "ico" | "heic" | "heif" | "jxl" | "docx" | "docm" | "dotx" | "dotm" | "doc" | "dot" | "pptx" | "pptm" | "potx" | "potm" | "ppsx" | "ppsm" | "rtf" | "odt" | "odp" | "xlsx" | "xltx" | "xlsm" | "xlsb" | "xls" | "xlt" | "xltm" | "csv" | "ods" | "fods" | "numbers" | "ofd" | "typ" | "eml" | "msg" | "mbox" | "olb" | "dra" | "gds" | "oas" | "oasis" | "dxf" | "dwg" | "dwf" | "dwfx" | "xps" | "geojson" | "kml" | "gpx" | "shp" | "excalidraw" | "drawio" | "dio" | "mermaid" | "mmd" | "plantuml" | "puml" | "xmind" | "epub" | "umd" | "md" | "mp4" | "webm" | "m3u8" | "mp3" | "mpeg" | "wav" | "ogg" | "oga" | "opus" | "m4a" | "aac" | "flac" | "weba" | "midi" | "mid" | "ttf" | "otf" | "woff" | "woff2" | "psd" | "ai" | "eps" | "sqlite" | "parquet" | "avro" | "webarchive")[];

package/dist/renderers/image.js

@@ -102,10 +102,13 @@ const createLightbox = (documentRef, src, t) => {
     };
 };
 export default async function renderImage(buffer, target, type, context) {
-    var _a;
+    var _a, _b;
     const t = createFileViewerTranslator(context === null || context === void 0 ? void 0 : context.options);
     const documentRef = target.ownerDocument || document;
     const src = await resolveImageUrl(buffer, type);
+    (_a = context === null || context === void 0 ? void 0 : context.registerThumbnailAdapter) === null || _a === void 0 ? void 0 : _a.call(context, {
+        capture: () => new Blob([buffer], { type: getImageBlobType(type) }),
+    });
     let userZoom = 1;
     let fitScale = 1;
     let currentScale = 1;
@@ -236,11 +239,13 @@ export default async function renderImage(buffer, target, type, context) {
         subscribe: zoomEmitter.subscribe,
     });
     target.replaceChildren(createStyle(documentRef), root);
-    (((_a = context === null || context === void 0 ? void 0 : context.surface) === null || _a === void 0 ? void 0 : _a.shadowRoot) || target).append(lightbox.element);
+    (((_b = context === null || context === void 0 ? void 0 : context.surface) === null || _b === void 0 ? void 0 : _b.shadowRoot) || target).append(lightbox.element);
     updateViewportSize();
     return {
         $el: target,
         unmount() {
+            var _a;
+            (_a = context === null || context === void 0 ? void 0 : context.registerThumbnailAdapter) === null || _a === void 0 ? void 0 : _a.call(context, null);
             unregisterFileViewerZoomProvider(root);
             resizeObserver.disconnect();
             image.removeEventListener('load', updateViewportSize);

package/dist/rendering/handler.d.ts

@@ -1,6 +1,6 @@
 import type { FileViewerRendererDispatcher } from './dispatcher';
 import { type FileViewerMutableAccessor, type MutableFileViewerRenderReadinessState } from '../source/loading';
-import type { FileRenderExportAdapter, FileRenderContext, FileRenderHandler, FileViewerLifecycleContext, FileViewerOptions, FileViewerStyleIsolation, RenderSurface, RendererDefinition, RendererLoadContext, RendererLoader, RendererRegistry, RendererSession } from '../contracts/types';
+import type { FileRenderExportAdapter, FileRenderThumbnailAdapter, FileRenderContext, FileRenderHandler, FileViewerLifecycleContext, FileViewerOptions, FileViewerStyleIsolation, RenderSurface, RendererDefinition, RendererLoadContext, RendererLoader, RendererRegistry, RendererSession } from '../contracts/types';
 export declare const FILE_VIEWER_RENDER_SESSION_DISPOSE_ERROR_MESSAGE = "\u9884\u89C8\u5185\u5BB9\u5378\u8F7D\u5931\u8D25";
 export interface ResolveFileViewerRenderSessionDisposeErrorMessageInput {
     message?: string;
@@ -34,6 +34,7 @@ export interface DisposeFileViewerRendererSessionOptions {
 export interface FileViewerRenderSurfaceState<Session extends RendererSession = RendererSession> {
     session: Session | null;
     exportAdapter: FileRenderExportAdapter | null;
+    thumbnailAdapter: FileRenderThumbnailAdapter | null;
 }
 export type MutableFileViewerRenderSurfaceState<Session extends RendererSession = RendererSession> = FileViewerRenderSurfaceState<Session>;
 export interface CreateFileViewerRenderReadinessTargetInput {
@@ -43,6 +44,7 @@ export interface CreateFileViewerRenderReadinessTargetInput {
 export interface CreateFileViewerRenderSurfaceStateTargetInput<Session extends RendererSession = RendererSession> {
     session: FileViewerMutableAccessor<Session | null>;
     exportAdapter: FileViewerMutableAccessor<FileRenderExportAdapter | null>;
+    thumbnailAdapter?: FileViewerMutableAccessor<FileRenderThumbnailAdapter | null>;
 }
 export interface CreateFileViewerRenderTargetOptions {
     className?: string;
@@ -171,7 +173,7 @@ export declare const appendFileViewerStyle: (target: HTMLElement | ShadowRoot, c
 export declare const removeFileViewerRenderTarget: (container: HTMLElement, target: HTMLElement) => boolean;
 export declare const createFileViewerRenderSurfaceState: <Session extends RendererSession = RendererSession>() => FileViewerRenderSurfaceState<Session>;
 export declare const createFileViewerRenderReadinessTarget: ({ renderedReady, progressiveReady, }: CreateFileViewerRenderReadinessTargetInput) => MutableFileViewerRenderReadinessState;
-export declare const createFileViewerRenderSurfaceStateTarget: <Session extends RendererSession = RendererSession>({ session, exportAdapter, }: CreateFileViewerRenderSurfaceStateTargetInput<Session>) => MutableFileViewerRenderSurfaceState<Session>;
+export declare const createFileViewerRenderSurfaceStateTarget: <Session extends RendererSession = RendererSession>({ session, exportAdapter, thumbnailAdapter, }: CreateFileViewerRenderSurfaceStateTargetInput<Session>) => MutableFileViewerRenderSurfaceState<Session>;
 export declare const applyFileViewerRenderSurfaceState: <Session extends RendererSession, Target extends MutableFileViewerRenderSurfaceState<Session>>(target: Target, state: Partial<FileViewerRenderSurfaceState<Session>>) => Target;
 export declare const createFileRenderHandlerRendererSession: <Rendered = unknown>(rendered: Rendered, destroy?: () => void | Promise<void>) => FileRenderHandlerRendererSession<Rendered>;
 export interface CreateFileRenderHandlerRegistryOptions<Rendered = unknown, Target extends HTMLElement = HTMLElement> extends Omit<CreateFileRenderHandlerLoaderOptions<Rendered, Target>, 'handler'> {
@@ -196,7 +198,7 @@ export declare const resetFileViewerRenderSurface: <Session extends RendererSess
 export declare const runFileViewerRenderSurfaceClear: <Session extends RendererSession, UnloadContext = FileViewerLifecycleContext | null>({ reason, surfaceState, readinessState, container, disposeOptions, onUnloadStart, onUnloadComplete, onClearActiveDocumentContext, onClearDocumentState, onStopZoomObserver, onClearZoomProvider, onStopFitObserver, onStopViewStateObserver, onClearViewStateProvider, }: RunFileViewerRenderSurfaceClearInput<Session, UnloadContext>) => FileViewerRenderSurfaceClearState<Session, UnloadContext>;
 export declare const runFileViewerRenderSurfaceMount: <Session extends RendererSession>({ buffer, file, version, sourceUrl, streamUrl, getContainer, surfaceState, readinessState, isCurrent, clearRenderedContent, render, waitForContainer, waitForPaint, disposeSession, onStartZoomObserver, onStartFitObserver, onStartViewStateObserver, onApplyInitialFit, onRefreshDocumentIndex, onRefreshZoomProvider, onRefreshViewStateProvider, }: RunFileViewerRenderSurfaceMountInput<Session>) => Promise<Session | undefined>;
 export declare const createFileViewerRenderSurfaceActionHandlers: <Session extends RendererSession, UnloadContext = FileViewerLifecycleContext | null>({ getContainer, surfaceState, readinessState, isCurrent, render, waitForContainer, waitForPaint, disposeOptions, onUnloadStart, onUnloadComplete, onClearActiveDocumentContext, onClearDocumentState, onStartZoomObserver, onStopZoomObserver, onClearZoomProvider, onStartFitObserver, onStopFitObserver, onStartViewStateObserver, onStopViewStateObserver, onClearViewStateProvider, onApplyInitialFit, onRefreshDocumentIndex, onRefreshZoomProvider, onRefreshViewStateProvider, }: CreateFileViewerRenderSurfaceActionHandlersInput<Session, UnloadContext>) => FileViewerRenderSurfaceActionHandlers<Session, UnloadContext>;
-export declare const buildFileRenderContextFromLoadContext: ({ source, surface, options, registerExportAdapter, renderContext, }: RendererLoadContext) => FileRenderContext;
+export declare const buildFileRenderContextFromLoadContext: ({ source, surface, options, signal, registerExportAdapter, registerThumbnailAdapter, renderContext, }: RendererLoadContext) => FileRenderContext;
 export declare const renderFileViewerHandler: <Rendered = unknown, Target extends HTMLElement = HTMLElement>({ dispatcher, buffer, target, type, context, throwOnMissingHandler, }: RenderFileViewerHandlerInput<Rendered, Target>) => Promise<Rendered | undefined>;
 export declare const createFileRenderHandlerLoader: <Rendered = unknown, Target extends HTMLElement = HTMLElement>({ handler, rendererId, getTarget, createContext, destroy, }: CreateFileRenderHandlerLoaderOptions<Rendered, Target>) => RendererLoader;
 export declare const createFileRenderHandlerRegistry: <Rendered = unknown, Target extends HTMLElement = HTMLElement>({ definitions, handlers, getTarget, createContext, destroy, }: CreateFileRenderHandlerRegistryOptions<Rendered, Target>) => FileRenderHandlerRegistryResult<Rendered, Target>;

package/dist/rendering/handler.js

@@ -157,6 +157,7 @@ export const removeFileViewerRenderTarget = (container, target) => {
 export const createFileViewerRenderSurfaceState = () => ({
     session: null,
     exportAdapter: null,
+    thumbnailAdapter: null,
 });
 export const createFileViewerRenderReadinessTarget = ({ renderedReady, progressiveReady, }) => {
     return {
@@ -174,7 +175,8 @@ export const createFileViewerRenderReadinessTarget = ({ renderedReady, progressi
         },
     };
 };
-export const createFileViewerRenderSurfaceStateTarget = ({ session, exportAdapter, }) => {
+export const createFileViewerRenderSurfaceStateTarget = ({ session, exportAdapter, thumbnailAdapter, }) => {
+    let localThumbnailAdapter = null;
     return {
         get session() {
             return session.get();
@@ -188,16 +190,27 @@ export const createFileViewerRenderSurfaceStateTarget = ({ session, exportAdapte
         set exportAdapter(value) {
             exportAdapter.set(value);
         },
+        get thumbnailAdapter() {
+            var _a;
+            return (_a = thumbnailAdapter === null || thumbnailAdapter === void 0 ? void 0 : thumbnailAdapter.get()) !== null && _a !== void 0 ? _a : localThumbnailAdapter;
+        },
+        set thumbnailAdapter(value) {
+            localThumbnailAdapter = value;
+            thumbnailAdapter === null || thumbnailAdapter === void 0 ? void 0 : thumbnailAdapter.set(value);
+        },
     };
 };
 export const applyFileViewerRenderSurfaceState = (target, state) => {
-    var _a, _b;
+    var _a, _b, _c;
     if ('session' in state) {
         target.session = (_a = state.session) !== null && _a !== void 0 ? _a : null;
     }
     if ('exportAdapter' in state) {
         target.exportAdapter = (_b = state.exportAdapter) !== null && _b !== void 0 ? _b : null;
     }
+    if ('thumbnailAdapter' in state) {
+        target.thumbnailAdapter = (_c = state.thumbnailAdapter) !== null && _c !== void 0 ? _c : null;
+    }
     return target;
 };
 export const createFileRenderHandlerRendererSession = (rendered, destroy) => ({
@@ -265,7 +278,7 @@ export const disposeActiveFileViewerRendererSession = (target, options = {}) =>
 };
 export const resetFileViewerRenderSurface = ({ surfaceState, readinessState, container, disposeOptions, }) => {
     const session = disposeActiveFileViewerRendererSession(surfaceState, disposeOptions);
-    applyFileViewerRenderSurfaceState(surfaceState, { exportAdapter: null });
+    applyFileViewerRenderSurfaceState(surfaceState, { exportAdapter: null, thumbnailAdapter: null });
     applyFileViewerRenderReadinessState(readinessState, {
         renderedReady: false,
         progressiveReady: false,
@@ -430,13 +443,15 @@ export const createFileViewerRenderSurfaceActionHandlers = ({ getContainer, surf
         mountRenderedContent,
     };
 };
-export const buildFileRenderContextFromLoadContext = ({ source, surface, options, registerExportAdapter, renderContext, }) => ({
+export const buildFileRenderContextFromLoadContext = ({ source, surface, options, signal, registerExportAdapter, registerThumbnailAdapter, renderContext, }) => ({
     filename: source.filename,
     url: source.url,
     streamUrl: source.url,
+    signal,
     options,
     surface,
     registerExportAdapter,
+    registerThumbnailAdapter,
     ...renderContext,
 });
 export const renderFileViewerHandler = async ({ dispatcher, buffer, target, type = '', context, throwOnMissingHandler = false, }) => {

package/dist/viewer/createViewer.d.ts

@@ -1,8 +1,9 @@
-import type { FileViewerEventHandler, FileViewerInstance, FileViewerOptions, RendererRegistry } from '../contracts/types';
+import type { FileViewerEventHandler, FileViewerInstance, FileViewerOptions, FileViewerRenderPurpose, RendererRegistry } from '../contracts/types';
 export interface CreateViewerOptions {
     registry?: RendererRegistry;
     options?: FileViewerOptions;
     signal?: AbortSignal;
     onEvent?: FileViewerEventHandler;
+    renderPurpose?: FileViewerRenderPurpose;
 }
 export declare const createViewer: (container: HTMLElement, createOptions?: CreateViewerOptions) => FileViewerInstance;

package/dist/viewer/createViewer.js

@@ -56,6 +56,27 @@ const resolveAutoRenderersEnabled = (options) => {
     }
     return (options.rendererMode || 'extend') !== 'replace';
 };
+const createFileViewerLoadSignal = (controller, signals) => {
+    if (!controller) {
+        return signals.find(signal => signal);
+    }
+    const removeListeners = [];
+    const cleanup = () => removeListeners.splice(0).forEach(remove => remove());
+    controller.signal.addEventListener('abort', cleanup, { once: true });
+    for (const signal of signals) {
+        if (!signal) {
+            continue;
+        }
+        if (signal.aborted) {
+            controller.abort(signal.reason);
+            break;
+        }
+        const onAbort = () => controller.abort(signal.reason);
+        signal.addEventListener('abort', onAbort, { once: true });
+        removeListeners.push(() => signal.removeEventListener('abort', onAbort));
+    }
+    return controller.signal;
+};
 const renderMissingRendererState = (container, type, options) => {
     const documentRef = container.ownerDocument;
     const state = createFileViewerUnsupportedState(type, undefined, options);
@@ -427,6 +448,7 @@ export const createViewer = (container, createOptions = {}) => {
         applyFileViewerRenderSurfaceState(renderSurfaceState, {
             session: null,
             exportAdapter: null,
+            thumbnailAdapter: null,
         });
         removeWatermarkOverlay();
         await documentActions.clearDocumentState();
@@ -440,8 +462,16 @@ export const createViewer = (container, createOptions = {}) => {
     };
     const instance = {
         container,
-        async load(source) {
+        async prepare() {
+            await ensureRendererPluginsInstalled();
+        },
+        async load(source, loadOptions = {}) {
             const version = requestScope.requestController.createVersion();
+            const requestAbortController = requestScope.requestController.createAbortController();
+            const loadSignal = createFileViewerLoadSignal(requestAbortController, [
+                createOptions.signal,
+                loadOptions.signal,
+            ]);
             await destroyCurrent('replace');
             await ensureRendererPluginsInstalled();
             if (!requestScope.isCurrentRequest(version)) {
@@ -470,12 +500,20 @@ export const createViewer = (container, createOptions = {}) => {
                     source: normalized,
                     surface,
                     options,
-                    signal: createOptions.signal,
+                    signal: loadSignal,
                     registerExportAdapter: adapter => {
                         if (requestScope.isCurrentRequest(version)) {
                             applyFileViewerRenderSurfaceState(renderSurfaceState, { exportAdapter: adapter });
                         }
                     },
+                    registerThumbnailAdapter: adapter => {
+                        if (requestScope.isCurrentRequest(version)) {
+                            applyFileViewerRenderSurfaceState(renderSurfaceState, { thumbnailAdapter: adapter });
+                        }
+                    },
+                    renderContext: {
+                        renderPurpose: createOptions.renderPurpose || 'preview',
+                    },
                 });
             }
             catch (error) {
@@ -504,6 +542,10 @@ export const createViewer = (container, createOptions = {}) => {
             await emitLifecycle(options, createOptions.onEvent, 'load-complete', normalized, version, startedAt);
             return session;
         },
+        async unload(reason = 'replace') {
+            requestScope.requestController.createVersion();
+            await destroyCurrent(reason);
+        },
         async destroy(reason = 'component-unmount') {
             requestScope.requestController.createVersion();
             await destroyCurrent(reason);
@@ -540,6 +582,12 @@ export const createViewer = (container, createOptions = {}) => {
         getExportAdapter() {
             return renderSurfaceState.exportAdapter;
         },
+        registerThumbnailAdapter(adapter) {
+            applyFileViewerRenderSurfaceState(renderSurfaceState, { thumbnailAdapter: adapter });
+        },
+        getThumbnailAdapter() {
+            return renderSurfaceState.thumbnailAdapter;
+        },
         async download(downloadOptions = {}) {
             const source = createFileViewerOriginalSourceStateFromNormalizedSource(currentSource);
             await executeFileViewerDownloadOperation({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@file-viewer/core",
-  "version": "2.1.26",
+  "version": "2.1.27",
   "private": false,
   "type": "module",
   "description": "Framework-neutral modular TypeScript core for Flyfish File Viewer renderer orchestration, lifecycle APIs, search, zoom, print, and export",