@qrcommunication/gigapdf-lib 0.1.0 → 0.7.0

package/dist/viewer.d.cts

@@ -0,0 +1,144 @@
+import { GigaPdfEngine, GigaPdfDoc, HtmlFont } from './index.cjs';
+
+/**
+ * `@qrcommunication/gigapdf-lib/viewer` — a zero-dependency document **viewer**
+ * built entirely on the WASM engine. It opens PDF, Office (docx/xlsx/pptx +
+ * legacy/ODF) and HTML — converting non-PDF inputs to PDF in-engine — renders
+ * pages with {@link GigaPdfDoc.renderPage}, detects each page's orientation and
+ * adapts, and offers navigation, zoom, a thumbnail rail and a **fullscreen
+ * presentation mode**. No third-party libraries (no pdf.js); browser-only (DOM).
+ *
+ * ```ts
+ * const giga = await GigaPdfEngine.load(wasmUrl);
+ * const viewer = new GigaPdfViewer(giga, document.getElementById("app")!);
+ * await viewer.open({ kind: "auto", bytes });   // pdf / office / html auto-detected
+ * viewer.present();                              // fullscreen slideshow
+ * ```
+ */
+
+/** A document to open. `auto` sniffs the format from magic bytes. */
+type ViewerSource = {
+    kind: "pdf";
+    bytes: Uint8Array;
+} | {
+    kind: "office";
+    bytes: Uint8Array;
+} | {
+    kind: "html";
+    html: string;
+    fonts?: HtmlFont[];
+} | {
+    kind: "auto";
+    bytes: Uint8Array;
+};
+interface ViewerOptions {
+    /** CSS zoom multiplier applied to the page boxes (default 1). */
+    scale?: number;
+    /** Raster scale for crisp rendering (default 2 ≈ retina). */
+    renderScale?: number;
+    /** Show the thumbnail rail (default true). */
+    thumbnails?: boolean;
+    /** Show the toolbar (default true). */
+    toolbar?: boolean;
+    /** Gutter background colour (default `#525659`). */
+    background?: string;
+}
+/** Page orientation derived from the rendered raster. */
+type Orientation = "portrait" | "landscape";
+declare class GigaPdfViewer {
+    protected engine: GigaPdfEngine;
+    private options;
+    protected doc: GigaPdfDoc | null;
+    protected count: number;
+    protected current: number;
+    protected cssScale: number;
+    protected renderScale: number;
+    /** Active auto-fit mode; re-applied on resize and page change. */
+    protected fitMode: "none" | "width" | "page";
+    private presenting;
+    private resizeObs;
+    protected urls: (string | null)[];
+    protected sizes: ({
+        w: number;
+        h: number;
+    } | null)[];
+    protected root: HTMLElement;
+    private bar;
+    private body;
+    private thumbs;
+    protected pages: HTMLElement;
+    private pageInput;
+    private zoomReadout;
+    private zoomSelect;
+    protected pageEls: (HTMLElement | null)[];
+    private onKey;
+    private onFsChange;
+    constructor(engine: GigaPdfEngine, container: HTMLElement, options?: ViewerOptions);
+    /** Number of pages currently open. */
+    get pageCount(): number;
+    /** The page currently in view (1-based). */
+    get currentPage(): number;
+    /** Orientation of `page` (after open). */
+    orientation(page: number): Orientation;
+    /** The current document as PDF bytes (including any applied edits). */
+    save(): Uint8Array;
+    /** Open a document; Office/HTML are converted to PDF in-engine. Returns the page count. */
+    open(src: ViewerSource): Promise<number>;
+    private toPdf;
+    private detectAndConvert;
+    protected renderPageRaster(page: number): {
+        url: string;
+        w: number;
+        h: number;
+    };
+    /** The page's width / height in PDF points (raster pixels ÷ render scale). */
+    protected pageWidthPt(page: number): number;
+    protected pageHeightPt(page: number): number;
+    /** Re-raster a page after its content changed (drops the cached image). */
+    protected reRenderPage(page: number): void;
+    /** Hook for subclasses (the editor) to attach per-page overlays. */
+    protected afterRender(): void;
+    private renderAllPages;
+    private buildThumbs;
+    private highlightThumb;
+    /** Scroll/jump to `page` (clamped to range). */
+    goTo(page: number): void;
+    next(): void;
+    prev(): void;
+    /** Current CSS zoom multiplier (1 = 100%). */
+    get zoom(): number;
+    /** Resize the page boxes to the current `cssScale` (no re-raster). */
+    private applyScale;
+    /** Set an explicit zoom multiplier (cancels any auto-fit mode). */
+    setZoom(scale: number): void;
+    /** Set zoom as a percentage (e.g. `125`). */
+    setZoomPercent(pct: number): void;
+    /** Reset to 100 % (actual size). */
+    actualSize(): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    /** Fit the current page's **width** to the viewport (sticks across resizes). */
+    fitWidth(): void;
+    /** Fit the **whole** current page (width *and* height) to the viewport. */
+    fitPage(): void;
+    /** Recompute the zoom for the active fit mode against the current page. */
+    protected applyFitMode(): void;
+    /** Hook for subclasses (the editor) to react to zoom changes. */
+    protected onZoomChange(): void;
+    private updateZoomReadout;
+    /** Enter fullscreen single-page presentation mode. */
+    present(): void;
+    /** Leave presentation mode. */
+    exitPresent(): void;
+    private syncPresentClass;
+    private handleKey;
+    private isActive;
+    private buildChrome;
+    private trackScroll;
+    /** Close the current document and free its rendered pages. */
+    close(): void;
+    /** Destroy the viewer: close the document and detach listeners. */
+    destroy(): void;
+}
+
+export { GigaPdfViewer, type Orientation, type ViewerOptions, type ViewerSource };

package/dist/viewer.d.ts

@@ -0,0 +1,144 @@
+import { GigaPdfEngine, GigaPdfDoc, HtmlFont } from './index.js';
+
+/**
+ * `@qrcommunication/gigapdf-lib/viewer` — a zero-dependency document **viewer**
+ * built entirely on the WASM engine. It opens PDF, Office (docx/xlsx/pptx +
+ * legacy/ODF) and HTML — converting non-PDF inputs to PDF in-engine — renders
+ * pages with {@link GigaPdfDoc.renderPage}, detects each page's orientation and
+ * adapts, and offers navigation, zoom, a thumbnail rail and a **fullscreen
+ * presentation mode**. No third-party libraries (no pdf.js); browser-only (DOM).
+ *
+ * ```ts
+ * const giga = await GigaPdfEngine.load(wasmUrl);
+ * const viewer = new GigaPdfViewer(giga, document.getElementById("app")!);
+ * await viewer.open({ kind: "auto", bytes });   // pdf / office / html auto-detected
+ * viewer.present();                              // fullscreen slideshow
+ * ```
+ */
+
+/** A document to open. `auto` sniffs the format from magic bytes. */
+type ViewerSource = {
+    kind: "pdf";
+    bytes: Uint8Array;
+} | {
+    kind: "office";
+    bytes: Uint8Array;
+} | {
+    kind: "html";
+    html: string;
+    fonts?: HtmlFont[];
+} | {
+    kind: "auto";
+    bytes: Uint8Array;
+};
+interface ViewerOptions {
+    /** CSS zoom multiplier applied to the page boxes (default 1). */
+    scale?: number;
+    /** Raster scale for crisp rendering (default 2 ≈ retina). */
+    renderScale?: number;
+    /** Show the thumbnail rail (default true). */
+    thumbnails?: boolean;
+    /** Show the toolbar (default true). */
+    toolbar?: boolean;
+    /** Gutter background colour (default `#525659`). */
+    background?: string;
+}
+/** Page orientation derived from the rendered raster. */
+type Orientation = "portrait" | "landscape";
+declare class GigaPdfViewer {
+    protected engine: GigaPdfEngine;
+    private options;
+    protected doc: GigaPdfDoc | null;
+    protected count: number;
+    protected current: number;
+    protected cssScale: number;
+    protected renderScale: number;
+    /** Active auto-fit mode; re-applied on resize and page change. */
+    protected fitMode: "none" | "width" | "page";
+    private presenting;
+    private resizeObs;
+    protected urls: (string | null)[];
+    protected sizes: ({
+        w: number;
+        h: number;
+    } | null)[];
+    protected root: HTMLElement;
+    private bar;
+    private body;
+    private thumbs;
+    protected pages: HTMLElement;
+    private pageInput;
+    private zoomReadout;
+    private zoomSelect;
+    protected pageEls: (HTMLElement | null)[];
+    private onKey;
+    private onFsChange;
+    constructor(engine: GigaPdfEngine, container: HTMLElement, options?: ViewerOptions);
+    /** Number of pages currently open. */
+    get pageCount(): number;
+    /** The page currently in view (1-based). */
+    get currentPage(): number;
+    /** Orientation of `page` (after open). */
+    orientation(page: number): Orientation;
+    /** The current document as PDF bytes (including any applied edits). */
+    save(): Uint8Array;
+    /** Open a document; Office/HTML are converted to PDF in-engine. Returns the page count. */
+    open(src: ViewerSource): Promise<number>;
+    private toPdf;
+    private detectAndConvert;
+    protected renderPageRaster(page: number): {
+        url: string;
+        w: number;
+        h: number;
+    };
+    /** The page's width / height in PDF points (raster pixels ÷ render scale). */
+    protected pageWidthPt(page: number): number;
+    protected pageHeightPt(page: number): number;
+    /** Re-raster a page after its content changed (drops the cached image). */
+    protected reRenderPage(page: number): void;
+    /** Hook for subclasses (the editor) to attach per-page overlays. */
+    protected afterRender(): void;
+    private renderAllPages;
+    private buildThumbs;
+    private highlightThumb;
+    /** Scroll/jump to `page` (clamped to range). */
+    goTo(page: number): void;
+    next(): void;
+    prev(): void;
+    /** Current CSS zoom multiplier (1 = 100%). */
+    get zoom(): number;
+    /** Resize the page boxes to the current `cssScale` (no re-raster). */
+    private applyScale;
+    /** Set an explicit zoom multiplier (cancels any auto-fit mode). */
+    setZoom(scale: number): void;
+    /** Set zoom as a percentage (e.g. `125`). */
+    setZoomPercent(pct: number): void;
+    /** Reset to 100 % (actual size). */
+    actualSize(): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    /** Fit the current page's **width** to the viewport (sticks across resizes). */
+    fitWidth(): void;
+    /** Fit the **whole** current page (width *and* height) to the viewport. */
+    fitPage(): void;
+    /** Recompute the zoom for the active fit mode against the current page. */
+    protected applyFitMode(): void;
+    /** Hook for subclasses (the editor) to react to zoom changes. */
+    protected onZoomChange(): void;
+    private updateZoomReadout;
+    /** Enter fullscreen single-page presentation mode. */
+    present(): void;
+    /** Leave presentation mode. */
+    exitPresent(): void;
+    private syncPresentClass;
+    private handleKey;
+    private isActive;
+    private buildChrome;
+    private trackScroll;
+    /** Close the current document and free its rendered pages. */
+    close(): void;
+    /** Destroy the viewer: close the document and detach listeners. */
+    destroy(): void;
+}
+
+export { GigaPdfViewer, type Orientation, type ViewerOptions, type ViewerSource };