@file-viewer/ppt 0.2.0 → 0.3.0

package/index.d.ts

@@ -1,32 +1,45 @@
+export interface PptFontPackManifest {
+  readonly kind: 'flyfish-cjk-font-pack-v1';
+  readonly file: 'ppt-font-cjk.otf';
+  readonly bytes: number;
+  readonly sha256: string;
+}
+
 export interface PptPackageManifest {
-  kind: 'flyfish-ppt-public-native-wasm-v1';
-  product: 'Flyfish PPT Viewer';
-  format: 'PowerPoint 97-2003 (.ppt)';
-  packageName: '@file-viewer/ppt';
-  packageVersion: string;
-  engine: 'flyfish-classic-ppt-native-engine';
-  engineBuild: string;
-  id: 'FV-PPT-PUBLIC-WATERMARKED-V2';
-  feature: 'ppt';
-  edition: 'public-watermarked';
-  holder: 'Individual Personal Non-Commercial Use';
-  distribution: 'proprietary-public-binary';
-  commercialUse: false;
-  publicAnyOrigin: true;
-  watermarkRequired: true;
-  watermarkText: 'Flyfish Viewer';
-  usePolicy: 'public-individual-noncommercial-watermarked';
-  licensePolicy: 'flyfish-public-watermarked-binary-license-v1';
-  sourceCodeRights: false;
-  sourceDeliveryRights: false;
-  apacheLicenseApplies: false;
-  redistributionAllowed: false;
-  runtimeLicenseRequired: false;
-  renderer: 'native-wasm-rgba-canvas';
-  integrity: 'native-wasm-sha256-v1';
-  wasmFile: 'ppt-native.wasm';
-  watermarkEnforcement: 'native-final-frame';
-  wasmSha256: string;
+  readonly kind: 'flyfish-ppt-public-native-wasm-v2';
+  readonly product: 'Flyfish PPT Viewer';
+  readonly format: 'PowerPoint 97-2003 (.ppt)';
+  readonly packageName: '@file-viewer/ppt';
+  readonly packageVersion: string;
+  readonly engine: 'flyfish-classic-ppt-native-engine';
+  readonly engineBuild: string;
+  readonly id: 'FV-PPT-PUBLIC-WATERMARKED-V2';
+  readonly feature: 'ppt';
+  readonly edition: 'public-watermarked';
+  readonly holder: 'Individual Personal Non-Commercial Use';
+  readonly distribution: 'proprietary-public-binary';
+  readonly commercialUse: false;
+  readonly publicAnyOrigin: true;
+  readonly watermarkRequired: true;
+  readonly watermarkText: 'Flyfish Viewer';
+  readonly usePolicy: 'public-individual-noncommercial-watermarked';
+  readonly licensePolicy: 'flyfish-public-watermarked-binary-license-v1';
+  readonly sourceCodeRights: false;
+  readonly sourceDeliveryRights: false;
+  readonly apacheLicenseApplies: false;
+  readonly redistributionAllowed: false;
+  readonly runtimeLicenseRequired: false;
+  readonly renderer: 'native-wasm-worker-offscreen-canvas';
+  readonly integrity: 'native-wasm-font-sha256-v2';
+  readonly wasmFile: 'ppt-native.wasm';
+  readonly wasmBytes: number;
+  readonly wasmSha256: string;
+  readonly workerFile: 'worker.mjs';
+  readonly fontPack: PptFontPackManifest;
+  readonly workerDefault: true;
+  readonly virtualScrollDefault: true;
+  readonly frameCache: 'indexeddb-final-watermarked-png-lru';
+  readonly watermarkEnforcement: 'native-final-frame';
 }
 
 export interface PptRuntimeLicenseSummary {
@@ -58,9 +71,48 @@ export interface PptMountOptions extends PptRenderOptions {
   replace?: boolean;
   /** Optional class name for the generated viewer root. */
   className?: string;
+  /** Render only the viewport and overscan window. Defaults to true. */
+  virtualize?: boolean;
+  /** IntersectionObserver root. Defaults to the browser viewport. */
+  scrollRoot?: Element | Document | null;
+  /** IntersectionObserver overscan. Defaults to `150% 0px`. */
+  rootMargin?: string;
+  /** Delay before a hidden Canvas is persisted and released. Defaults to 1200 ms. */
+  releaseDelayMs?: number;
+}
+
+export interface PptFrameCacheOptions {
+  enabled?: boolean;
+  dbName?: string;
+  /** Total IndexedDB frame budget. Defaults to 256 MiB. */
+  maxBytes?: number;
+  /** Maximum number of cached pages. Defaults to 200. */
+  maxEntries?: number;
+  /** Maximum encoded PNG size for one page. Defaults to 32 MiB. */
+  maxEntryBytes?: number;
+}
+
+export interface PptFrameCacheStats {
+  readonly enabled: boolean;
+  readonly available: boolean;
+  readonly disabledReason: string | null;
+  readonly entries: number;
+  readonly bytes: number;
+  readonly maxBytes: number;
+  readonly maxEntries: number;
+  readonly maxEntryBytes: number;
+  readonly hits: number;
+  readonly misses: number;
+  readonly writes: number;
+  readonly nativeRenders: number;
+  readonly cancellations: number;
+  readonly attachedCanvases: number;
+  readonly activeCanvases: number;
+  readonly wasmMemoryBytes: number;
 }
 
 export interface PptRenderResult {
+  readonly cancelled?: boolean;
   readonly slideIndex: number;
   readonly width: number;
   readonly height: number;
@@ -68,9 +120,12 @@ export interface PptRenderResult {
   readonly logicalHeight: number;
   readonly scale: number;
   readonly pixelRatio: number;
+  readonly source?: 'native' | 'indexeddb';
 }
 
 export interface PptDocument {
+  readonly mode: 'worker' | 'direct';
+  readonly documentId: string;
   readonly slideCount: number;
   readonly width: number;
   readonly height: number;
@@ -79,30 +134,48 @@ export interface PptDocument {
     slideIndex: number,
     canvas: HTMLCanvasElement | OffscreenCanvas,
     options?: PptRenderOptions
-  ): PptRenderResult;
-  close(): void;
+  ): Promise<PptRenderResult>;
+  releaseSlide(slideIndex: number): Promise<boolean>;
+  cacheStats(): Promise<PptFrameCacheStats>;
+  close(): Promise<void>;
 }
 
 export interface MountedPptViewer {
   readonly document: PptDocument;
   readonly root: HTMLElement;
   readonly canvases: readonly HTMLCanvasElement[];
-  close(): void;
+  readonly virtualized: boolean;
+  renderSlide(slideIndex: number): Promise<PptRenderResult | void>;
+  cacheStats(): Promise<PptFrameCacheStats>;
+  close(): Promise<void>;
 }
 
+export type PptAssetSource = string | URL | Response | ArrayBuffer | Uint8Array;
+
 export interface LoadPptViewerOptions {
-  wasmUrl?: string | URL | Response | ArrayBuffer | Uint8Array;
+  wasmUrl?: PptAssetSource;
+  fontUrl?: PptAssetSource;
+  workerUrl?: string | URL;
+  /** `auto` uses a module Worker when Worker and OffscreenCanvas are supported. */
+  worker?: 'auto' | boolean;
+  /** Transfer ownership of full-buffer inputs to the Worker to avoid a main-thread copy. The input becomes detached. */
+  transferInputOwnership?: boolean;
+  /** Stores only final, native-watermarked PNG frames in bounded IndexedDB. */
+  cache?: false | PptFrameCacheOptions;
 }
 
 export interface PptViewerRuntime {
+  readonly mode: 'worker' | 'direct';
   readonly license: Readonly<PptRuntimeLicenseSummary>;
   readonly watermark: Readonly<PptWatermarkSummary>;
-  open(input: ArrayBuffer | Uint8Array): PptDocument;
+  open(input: ArrayBuffer | Uint8Array): Promise<PptDocument>;
   mount(
     target: string | HTMLElement,
     input: ArrayBuffer | Uint8Array,
     options?: PptMountOptions
   ): Promise<MountedPptViewer>;
+  cacheStats(): Promise<PptFrameCacheStats>;
+  close(): Promise<void>;
 }
 
 export declare function getPptPackageManifest(): PptPackageManifest;