@docmentis/udoc-viewer 0.5.1 → 0.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docmentis/udoc-viewer",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "type": "module",
   "license": "MIT",
   "description": "Free, open-source, universal document viewer for the web. Render PDF, PPTX, and images with high fidelity — no server required.",

package/dist/package.json

@@ -1,56 +0,0 @@
-{
-    "name": "@docmentis/udoc-viewer",
-    "version": "0.5.1",
-    "type": "module",
-    "license": "MIT",
-    "description": "Free, open-source, universal document viewer for the web. Render PDF, PPTX, and images with high fidelity — no server required.",
-    "homepage": "https://docmentis.com/viewer/guide",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/docmentis/docmentis-udoc-viewer.git",
-        "directory": "packages/udoc-viewer"
-    },
-    "bugs": {
-        "url": "https://github.com/docmentis/docmentis-udoc-viewer/issues"
-    },
-    "keywords": [
-        "pdf",
-        "pptx",
-        "powerpoint",
-        "viewer",
-        "document",
-        "document-viewer",
-        "pdf-viewer",
-        "wasm",
-        "webassembly",
-        "image-viewer",
-        "client-side"
-    ],
-    "main": "dist/src/index.js",
-    "types": "dist/src/index.d.ts",
-    "exports": {
-        ".": {
-            "types": "./dist/src/index.d.ts",
-            "import": "./dist/src/index.js"
-        },
-        "./worker": {
-            "types": "./dist/src/worker.d.ts",
-            "import": "./dist/src/worker.js"
-        }
-    },
-    "files": [
-        "dist"
-    ],
-    "sideEffects": false,
-    "engines": {
-        "node": ">=18"
-    },
-    "scripts": {
-        "build": "node scripts/build-styles.js && tsc && rm -rf dist/src/wasm && cp -r src/wasm dist/src/wasm",
-        "clean": "rm -rf dist",
-        "dev": "tsc --watch"
-    },
-    "devDependencies": {
-        "typescript": "^5.7.2"
-    }
-}

package/dist/src/UDocClient.d.ts

@@ -1,383 +0,0 @@
-/**
- * UDocClient - SDK entry point for document viewing.
- *
- * Manages the WASM engine and provides document operations.
- */
-import { WorkerClient } from "./worker/index.js";
-import type { Composition, ComposePick, ExtractedFont, ExtractedImage, SplitByOutlineResult } from "./worker/index.js";
-import { UDocViewer } from "./UDocViewer.js";
-import type { ScrollMode, LayoutMode, ZoomMode, PanelTab } from "./ui/viewer/state.js";
-import type { PerformanceLogCallback } from "./performance/index.js";
-/**
- * License information for the client.
- */
-export interface LicenseInfo {
-    /**
-     * Whether the license is valid.
-     */
-    valid: boolean;
-    /**
-     * License tier: "free" (no license) or "licensed" (valid license).
-     */
-    tier: "free" | "licensed";
-    /**
-     * Enabled feature flags.
-     */
-    features: string[];
-    /**
-     * Numeric limits (e.g., max_file_size_mb).
-     */
-    limits: Record<string, number>;
-    /**
-     * Organization name from the license.
-     */
-    organization?: string;
-    /**
-     * When the license expires (if applicable).
-     */
-    expiresAt?: Date;
-    /**
-     * Error message if license validation failed.
-     */
-    error?: string;
-}
-/**
- * Options for creating a UDocClient.
- */
-export interface ClientOptions {
-    /**
-     * License key for commercial use.
-     * Client runs in trial mode if not provided.
-     */
-    license?: string;
-    /**
-     * Base URL for loading worker and WASM files.
-     *
-     * By default, files are loaded relative to the package location.
-     *
-     * Expected files at baseUrl:
-     * - `{baseUrl}/worker.js`
-     * - `{baseUrl}/udoc_bg.wasm`
-     */
-    baseUrl?: string;
-    /**
-     * Locale for UI strings and date formatting.
-     * @default 'en'
-     */
-    locale?: string;
-}
-/**
- * Options for creating a viewer.
- */
-export interface ViewerOptions {
-    /**
-     * Container element or CSS selector.
-     * If not provided, viewer runs in headless mode (no UI).
-     */
-    container?: string | HTMLElement;
-    /**
-     * Scroll mode for page navigation.
-     * @default ScrollMode.Continuous
-     */
-    scrollMode?: ScrollMode;
-    /**
-     * Page layout mode.
-     * @default LayoutMode.SinglePage
-     */
-    layoutMode?: LayoutMode;
-    /**
-     * Zoom mode for automatic scaling.
-     * @default ZoomMode.FitSpreadWidth
-     */
-    zoomMode?: ZoomMode;
-    /**
-     * Initial zoom level (when zoomMode is Custom).
-     * @default 1
-     */
-    zoom?: number;
-    /**
-     * Custom zoom steps for zoom in/out.
-     * @default DEFAULT_ZOOM_STEPS
-     */
-    zoomSteps?: readonly number[];
-    /**
-     * Spacing between pages in pixels.
-     * @default 10
-     */
-    pageSpacing?: number;
-    /**
-     * Spacing between spreads in pixels.
-     * @default 20
-     */
-    spreadSpacing?: number;
-    /**
-     * Initially active panel, or null for no panel.
-     * @default null
-     */
-    activePanel?: PanelTab | null;
-    /**
-     * Target display DPI for rendering.
-     * PDF points are 72 DPI; this setting determines the CSS pixel ratio.
-     * Most displays use 96 DPI (CSS standard).
-     * @default 96
-     */
-    dpi?: number;
-    /**
-     * Enable performance tracking for debugging and analytics.
-     * When enabled, records timing for all major operations.
-     * @default false
-     */
-    enablePerformanceCounter?: boolean;
-    /**
-     * Callback for performance log entries.
-     * Called for each operation start/end when enablePerformanceCounter is true.
-     */
-    onPerformanceLog?: PerformanceLogCallback;
-    /**
-     * Enable Google Fonts for automatic font fetching.
-     * When true, fonts not embedded in the document are fetched from Google Fonts
-     * on-demand during rendering.
-     * @default true
-     */
-    googleFonts?: boolean;
-}
-/**
- * A document source can be:
- * - URL string
- * - File object
- * - Raw bytes
- * - An existing viewer (uses its loaded document)
- */
-export type DocumentSource = string | File | Uint8Array | UDocViewer;
-/**
- * A pick specifies which pages to take from which document.
- */
-export interface Pick {
-    /**
-     * Document source (viewer, URL, File, or bytes).
-     */
-    doc: DocumentSource;
-    /**
-     * Page range to pick. Can be:
-     * - A string like "0-2,4" (0-based page indices)
-     * - A single page index
-     * - An array of page indices
-     */
-    pages: string | number | number[];
-    /**
-     * Optional rotation to apply to the picked pages.
-     * Value in degrees: 0, 90, 180, or 270.
-     */
-    rotation?: 0 | 90 | 180 | 270;
-}
-/**
- * Re-export low-level types for advanced usage.
- */
-export type { Composition, ComposePick, ExtractedFont, ExtractedImage, SplitByOutlineResult };
-/**
- * SDK entry point for document viewing.
- *
- * Manages the WASM engine, creates viewers, and provides document operations.
- */
-export declare class UDocClient {
-    /**
-     * SDK version string.
-     */
-    static readonly version: string;
-    private workerClient;
-    private options;
-    private viewers;
-    private destroyed;
-    private licenseInfo;
-    private constructor();
-    /**
-     * Create and initialize a client instance.
-     * Loads the WASM engine.
-     */
-    static create(options?: ClientOptions): Promise<UDocClient>;
-    /**
-     * Get current license information.
-     */
-    get license(): LicenseInfo;
-    /**
-     * Check if a feature is available with the current license.
-     * @param feature - Feature name (e.g., "merge")
-     */
-    hasFeature(feature: string): boolean;
-    /**
-     * Create a viewer instance.
-     *
-     * - With container: Full UI mode
-     * - Without container: Headless mode (same API, no UI)
-     */
-    createViewer(options?: ViewerOptions): Promise<UDocViewer>;
-    /**
-     * Compose new documents by cherry-picking pages from source documents.
-     *
-     * This is a powerful method that allows creating new documents by selecting
-     * specific pages from multiple source documents in any order. Pages can
-     * optionally be rotated during composition.
-     *
-     * @param compositions - Array of compositions. Each composition creates one output document.
-     *   Each composition is an array of picks specifying which pages from which documents.
-     * @returns Array of viewers containing the composed documents
-     *
-     * @example
-     * ```ts
-     * // Create a document with pages 1-3 from viewer A and page 5 from viewer B
-     * const [newDoc] = await client.compose([
-     *   [
-     *     { doc: viewerA, pages: "1-3" },
-     *     { doc: viewerB, pages: "5" }
-     *   ]
-     * ]);
-     *
-     * // Create multiple documents at once
-     * const [doc1, doc2] = await client.compose([
-     *   [{ doc: viewerA, pages: "1" }],           // doc1: page 1 from A
-     *   [{ doc: viewerA, pages: "2" }, { doc: viewerB, pages: "1" }]  // doc2: page 2 from A + page 1 from B
-     * ]);
-     *
-     * // Rotate pages during composition
-     * const [rotated] = await client.compose([
-     *   [
-     *     { doc: viewerA, pages: "1", rotation: 90 },   // rotate page 1 by 90 degrees
-     *     { doc: viewerA, pages: "2", rotation: 180 }   // rotate page 2 by 180 degrees
-     *   ]
-     * ]);
-     * ```
-     */
-    compose(compositions: Pick[][]): Promise<UDocViewer[]>;
-    /**
-     * Split a document by its outline (bookmarks) structure.
-     *
-     * Creates multiple documents, one for each outline section at the specified level.
-     * The original document remains unchanged.
-     *
-     * @param source - Document source (viewer, URL, File, or bytes)
-     * @param options - Split options
-     * @param options.maxLevel - Maximum outline level to consider (1 = top level only, default: 1)
-     * @param options.splitMidPage - When true, filters page content when sections share a page (default: false)
-     * @returns Object with viewers array and sections metadata
-     *
-     * @example
-     * ```ts
-     * // Split a document by top-level bookmarks
-     * const result = await client.splitByOutline(viewer);
-     * console.log(`Split into ${result.viewers.length} documents`);
-     * result.sections.forEach((section, i) => {
-     *   console.log(`Document ${i}: ${section.title}`);
-     * });
-     *
-     * // Split with mid-page content filtering
-     * const result = await client.splitByOutline(viewer, { maxLevel: 2, splitMidPage: true });
-     * ```
-     */
-    splitByOutline(source: DocumentSource, options?: {
-        maxLevel?: number;
-        splitMidPage?: boolean;
-    }): Promise<{
-        viewers: UDocViewer[];
-        sections: {
-            title: string;
-            index: number;
-        }[];
-    }>;
-    /**
-     * Extract all embedded images from a document.
-     *
-     * @param source - Document source (viewer, URL, File, or bytes)
-     * @param options - Extract options
-     * @param options.convertRawToPng - When true, converts raw pixel data to PNG format (default: false)
-     * @returns Array of extracted images with metadata and data
-     *
-     * @example
-     * ```ts
-     * const images = await client.extractImages(viewer);
-     * for (const image of images) {
-     *   console.log(`${image.name}: ${image.format} (${image.width}x${image.height})`);
-     *   // image.data contains the raw image bytes
-     * }
-     *
-     * // Convert raw images to PNG for easier viewing
-     * const pngImages = await client.extractImages(viewer, { convertRawToPng: true });
-     * ```
-     */
-    extractImages(source: DocumentSource, options?: {
-        convertRawToPng?: boolean;
-    }): Promise<ExtractedImage[]>;
-    /**
-     * Extract all embedded fonts from a document.
-     *
-     * @param source - Document source (viewer, URL, File, or bytes)
-     * @returns Array of extracted fonts with metadata and data
-     *
-     * @example
-     * ```ts
-     * const fonts = await client.extractFonts(viewer);
-     * for (const font of fonts) {
-     *   console.log(`${font.name}: ${font.fontType} (.${font.extension})`);
-     *   // font.data contains the raw font bytes
-     * }
-     * ```
-     */
-    extractFonts(source: DocumentSource): Promise<ExtractedFont[]>;
-    /**
-     * Compress a document.
-     *
-     * Saves the document with full compression options enabled:
-     * - Compress stream data using FlateDecode
-     * - Pack objects into compressed object streams (PDF 1.5+)
-     * - Use compressed xref streams (PDF 1.5+)
-     * - Remove unreferenced objects
-     *
-     * @param source - Document source (viewer, URL, File, or bytes)
-     * @returns Compressed PDF data as Uint8Array
-     *
-     * @example
-     * ```ts
-     * const compressedBytes = await client.compress(viewer);
-     * // Save to file or download
-     * const blob = new Blob([compressedBytes], { type: 'application/pdf' });
-     * ```
-     */
-    compress(source: DocumentSource): Promise<Uint8Array>;
-    /**
-     * Decompress a document.
-     *
-     * Removes all filter encodings from streams, resulting in raw,
-     * uncompressed stream data. Useful for debugging or inspection.
-     *
-     * @param source - Document source (viewer, URL, File, or bytes)
-     * @returns Decompressed PDF data as Uint8Array
-     *
-     * @example
-     * ```ts
-     * const decompressedBytes = await client.decompress(viewer);
-     * // Save to file for inspection
-     * const blob = new Blob([decompressedBytes], { type: 'application/pdf' });
-     * ```
-     */
-    decompress(source: DocumentSource): Promise<Uint8Array>;
-    /**
-     * Load a document source and return its ID.
-     * Note: This is only used for PDF operations (compose, split, etc.)
-     */
-    private loadSource;
-    /**
-     * Normalize page specification to a string format.
-     */
-    private normalizePages;
-    /**
-     * Destroy the client and release all resources.
-     * All viewers created by this client become invalid.
-     */
-    destroy(): void;
-    /**
-     * Get the underlying worker client (for internal use).
-     * @internal
-     */
-    getWorkerClient(): WorkerClient;
-    private ensureNotDestroyed;
-}
-//# sourceMappingURL=UDocClient.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"UDocClient.d.ts","sourceRoot":"","sources":["../../src/UDocClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAEV,WAAW,EACX,WAAW,EACX,aAAa,EACb,cAAc,EACd,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE9B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAE1C;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,IAAI,GAAG,UAAU,GAAG,UAAU,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,GAAG,EAAE,cAAc,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC;CAC/B;AAED;;GAEG;AACH,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC;AAE9F;;;;GAIG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAe;IAE9C,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAKjB;IAEF,OAAO;IAKP;;;OAGG;WACU,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IA+BrE;;OAEG;IACH,IAAI,OAAO,IAAI,WAAW,CAEzB;IAED;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIpC;;;;;OAKG;IACG,YAAY,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IASpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IA2D5D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAClB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1D,OAAO,CAAC;QAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QAAC,QAAQ,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IA+BnF;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CACjB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE;QAAE,eAAe,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,OAAO,CAAC,cAAc,EAAE,CAAC;IAgB5B;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAepE;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAe3D;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAe7D;;;OAGG;YACW,UAAU;IAyBxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAUtB;;;OAGG;IACH,OAAO,IAAI,IAAI;IAef;;;OAGG;IACH,eAAe,IAAI,YAAY;IAI/B,OAAO,CAAC,kBAAkB;CAK3B"}