@docmentis/udoc-viewer 0.5.2 → 0.5.3

package/dist/src/UDocViewer.d.ts

@@ -1,271 +0,0 @@
-/**
- * UDocViewer - Document viewer component.
- *
- * Binds to a loaded document and optionally provides UI.
- * Created via `client.createViewer()`.
- */
-import type { WorkerClient, PageInfo } from "./worker/index.js";
-import type { ViewerOptions } from "./UDocClient.js";
-import type { Destination, OutlineItem } from "./ui/viewer/navigation.js";
-import type { Annotation } from "./ui/viewer/annotation/index.js";
-export type { Annotation } from "./ui/viewer/annotation/index.js";
-import { type IPerformanceCounter } from "./performance/index.js";
-/**
- * Options for rendering a page.
- */
-export interface RenderOptions {
-    /**
-     * Scale factor for rendering.
-     * 1 = 72 DPI (1 point = 1 pixel)
-     * 2 = 144 DPI (retina)
-     * @default 1
-     */
-    scale?: number;
-    /**
-     * Output format.
-     * @default 'image-data'
-     */
-    format?: "image-data" | "image-bitmap" | "blob" | "data-url";
-    /**
-     * Image type when format is 'blob' or 'data-url'.
-     * @default 'image/png'
-     */
-    imageType?: "image/png" | "image/jpeg";
-    /**
-     * JPEG quality (0-1) when imageType is 'image/jpeg'.
-     * @default 0.92
-     */
-    quality?: number;
-    /**
-     * Include annotations in render.
-     * @default true
-     */
-    annotations?: boolean;
-    /**
-     * Skip all cache and queue, call worker directly.
-     * Useful for one-off renders that shouldn't affect the render queue.
-     * @default false
-     */
-    force?: boolean;
-    /**
-     * Boost render priority by calling boostRenderPage before rendering.
-     * This prioritizes this page and nearby pages in the render queue.
-     * @default false
-     */
-    boost?: boolean;
-}
-/**
- * Rendered page result.
- */
-export type RenderedPage = ImageData | ImageBitmap | Blob | string;
-/**
- * Document metadata.
- */
-export interface DocumentMetadata {
-    title?: string;
-    author?: string;
-    subject?: string;
-    keywords?: string;
-    creator?: string;
-    producer?: string;
-    creationDate?: Date;
-    modificationDate?: Date;
-}
-/**
- * Re-export navigation types for public API.
- */
-export type { Destination, DestinationDisplay, OutlineItem } from "./ui/viewer/navigation.js";
-/**
- * Download progress information.
- */
-export interface DownloadProgress {
-    /** Bytes loaded so far. */
-    loaded: number;
-    /** Total bytes (may be 0 if Content-Length not available). */
-    total: number;
-    /** Progress percentage 0-100 (null if total unknown). */
-    percent: number | null;
-}
-/**
- * Event map for viewer events.
- */
-export interface ViewerEventMap {
-    "document:load": {
-        pageCount: number;
-    };
-    "document:close": Record<string, never>;
-    "download:progress": DownloadProgress;
-    error: {
-        error: Error;
-        phase: "fetch" | "parse" | "render";
-    };
-}
-type EventHandler<K extends keyof ViewerEventMap> = (payload: ViewerEventMap[K]) => void;
-/**
- * Document viewer component.
- *
- * Supports both UI mode (with container) and headless mode (without container).
- * Use `client.createViewer()` to create instances.
- */
-export declare class UDocViewer {
-    private workerClient;
-    private container;
-    private uiShell;
-    private documentId;
-    private _pageCount;
-    private _pageInfo;
-    private destroyed;
-    private eventHandlers;
-    private _performanceCounter;
-    private googleFontsEnabled;
-    /**
-     * @internal
-     * Use `client.createViewer()` instead.
-     */
-    constructor(workerClient: WorkerClient, options?: ViewerOptions);
-    /**
-     * Performance counter for tracking operation timings.
-     * Only records data when `enablePerformanceCounter` is true.
-     */
-    get performanceCounter(): IPerformanceCounter;
-    private buildStateOverrides;
-    /**
-     * Load a document.
-     *
-     * @param source - URL string, File object, or raw bytes
-     */
-    load(source: string | File | Uint8Array): Promise<void>;
-    /**
-     * Close the current document.
-     * Viewer returns to empty state.
-     */
-    close(): void;
-    /**
-     * Whether a document is currently loaded.
-     */
-    get isLoaded(): boolean;
-    /**
-     * Check if the loaded document requires a password to open.
-     * @returns True if the document needs authentication before pages can be accessed.
-     */
-    needsPassword(): Promise<boolean>;
-    /**
-     * Authenticate with a password to unlock an encrypted document.
-     *
-     * After successful authentication, page info is reloaded and the document
-     * becomes fully accessible.
-     *
-     * @param password - The password to try
-     * @returns True if authentication succeeded, false if the password was incorrect.
-     */
-    authenticate(password: string): Promise<boolean>;
-    /**
-     * Handle password submission from the UI dialog.
-     * @internal
-     */
-    private handlePasswordSubmit;
-    /**
-     * Total number of pages.
-     * Returns 0 if no document is loaded.
-     */
-    get pageCount(): number;
-    /**
-     * Document metadata (title, author, etc.).
-     * Returns null if no document is loaded.
-     */
-    get metadata(): DocumentMetadata | null;
-    /**
-     * Get document outline (table of contents / bookmarks).
-     */
-    getOutline(): Promise<OutlineItem[]>;
-    /**
-     * Get page dimensions in points (1 point = 1/72 inch).
-     * @param page - Page index (0-based)
-     */
-    getPageInfo(page: number): Promise<PageInfo>;
-    /**
-     * Get annotations on a specific page.
-     * @param page - Page index (0-based)
-     */
-    getPageAnnotations(page: number): Promise<Annotation[]>;
-    /**
-     * Get the current page number (1-based).
-     */
-    get currentPage(): number;
-    /**
-     * Navigate to a specific page.
-     * @param page - Page number (1-based)
-     */
-    goToPage(page: number): void;
-    /**
-     * Navigate to a destination (page + position + zoom).
-     * @param destination - Full destination object with page index and display mode
-     */
-    goToDestination(destination: Destination): void;
-    /**
-     * Render a page to an image.
-     *
-     * @param page - Page index (0-based)
-     * @param options - Render options (scale, format, etc.)
-     */
-    renderPage(page: number, options?: RenderOptions): Promise<RenderedPage>;
-    /**
-     * Render a thumbnail of a page.
-     *
-     * Similar to renderPage but uses lower priority in the render queue,
-     * making it suitable for generating thumbnails without blocking main page renders.
-     *
-     * @param page - Page index (0-based)
-     * @param options - Render options (scale, format, etc.)
-     */
-    renderThumbnail(page: number, options?: RenderOptions): Promise<RenderedPage>;
-    /**
-     * Internal method to render a page with a specific render type.
-     */
-    private renderWithType;
-    /**
-     * Convert an ImageBitmap to the requested output format.
-     */
-    private convertBitmapToFormat;
-    /**
-     * Export document as bytes.
-     */
-    toBytes(): Promise<Uint8Array>;
-    /**
-     * Download document to user's device.
-     * @param filename - Filename for download
-     */
-    download(filename?: string): Promise<void>;
-    /**
-     * Subscribe to an event.
-     * @returns Unsubscribe function
-     */
-    on<K extends keyof ViewerEventMap>(event: K, handler: EventHandler<K>): () => void;
-    /**
-     * Unsubscribe from an event.
-     */
-    off<K extends keyof ViewerEventMap>(event: K, handler: EventHandler<K>): void;
-    /**
-     * Destroy the viewer and release resources.
-     */
-    destroy(): void;
-    /**
-     * Get the document ID (for internal use).
-     * @internal
-     */
-    getDocumentId(): string | null;
-    /**
-     * Initialize the viewer with an already-loaded document ID.
-     * Used by UDocClient.compose() to create viewers for composed documents.
-     * @internal
-     */
-    initializeFromDocId(docId: string): Promise<void>;
-    private resolveContainer;
-    private resolveSourceWithFilename;
-    private fetchWithProgress;
-    private emit;
-    private createEngineAdapter;
-    private ensureNotDestroyed;
-    private ensureLoaded;
-}
-//# sourceMappingURL=UDocViewer.d.ts.map

package/dist/src/UDocViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"UDocViewer.d.ts","sourceRoot":"","sources":["../../src/UDocViewer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAc,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,cAAc,GAAG,MAAM,GAAG,UAAU,CAAC;IAE7D;;;OAGG;IACH,SAAS,CAAC,EAAE,WAAW,GAAG,YAAY,CAAC;IAEvC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,GAAG,MAAM,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,gBAAgB,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,WAAW,EACZ,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,eAAe,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxC,mBAAmB,EAAE,gBAAgB,CAAC;IACtC,KAAK,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;KAAE,CAAC;CAC9D;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,cAAc,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEzF;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,SAAS,CAA4B;IAC7C,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAA4E;IACjG,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,kBAAkB,CAAU;IAEpC;;;OAGG;gBACS,YAAY,EAAE,YAAY,EAAE,OAAO,GAAE,aAAkB;IA2BnE;;;OAGG;IACH,IAAI,kBAAkB,IAAI,mBAAmB,CAE5C;IAED,OAAO,CAAC,mBAAmB;IAoB3B;;;;OAIG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmF7D;;;OAGG;IACH,KAAK,IAAI,IAAI;IA0Bb;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAKvC;;;;;;;;OAQG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAsDtD;;;OAGG;YACW,oBAAoB;IAYlC;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,gBAAgB,GAAG,IAAI,CAItC;IAED;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAM1C;;;OAGG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAelD;;;OAGG;IACG,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAU7D;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAKxB;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQ5B;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAY/C;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAIlF;;;;;;;;OAQG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAIvF;;OAEG;YACW,cAAc;IA0C5B;;OAEG;YACW,qBAAqB;IA2CnC;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;IAKpC;;;OAGG;IACG,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBhD;;;OAGG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IASlF;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI;IAQ7E;;OAEG;IACH,OAAO,IAAI,IAAI;IAgBf;;;OAGG;IACH,aAAa,IAAI,MAAM,GAAG,IAAI;IAI9B;;;;OAIG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBvD,OAAO,CAAC,gBAAgB;YAWV,yBAAyB;YAiBzB,iBAAiB;IA+E/B,OAAO,CAAC,IAAI;IAaZ,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,YAAY;CAMrB"}