web-doc 0.3.0

package/dist/adapters/office.d.ts

@@ -0,0 +1,211 @@
+import type { AdapterOpenContext, DocumentAdapter, DocumentFormat, DocumentInfo, HyperlinkTarget, RenderViewport, SpreadsheetSheetInfo, TextRun, ViewerWarning } from "../contracts.js";
+declare const LEGACY_FORMATS: readonly ["doc", "xls", "ppt"];
+type LegacyFormat = (typeof LEGACY_FORMATS)[number];
+interface EngineLoadOptions {
+    readonly useGoogleFonts: false;
+    readonly maxZipEntryBytes: number;
+    readonly mode: "main";
+}
+interface EngineHyperlink {
+    readonly kind: "external" | "internal";
+    readonly url?: string;
+    readonly ref?: string;
+    readonly slideIndex?: number;
+}
+interface DocxRun {
+    readonly text: string;
+    readonly x: number;
+    readonly y: number;
+    readonly w: number;
+    readonly h: number;
+    readonly fontSize: number;
+    readonly font: string;
+    readonly letterSpacingPx?: number;
+    readonly transform?: string;
+    readonly eastAsianVert?: boolean;
+    readonly hyperlink?: EngineHyperlink;
+}
+interface DocxBackend {
+    readonly pageCount: number;
+    pageSize(pageIndex: number): {
+        widthPt: number;
+        heightPt: number;
+    };
+    renderPage(target: HTMLCanvasElement | OffscreenCanvas, pageIndex: number, options: {
+        width: number;
+        dpr: number;
+    }): Promise<void>;
+    collectPageRuns(pageIndex: number, options?: {
+        width?: number;
+        dpr?: number;
+    }): Promise<readonly DocxRun[]>;
+    getBookmarkPage?(bookmark: string): number | undefined;
+    destroy(): void;
+}
+interface PptxRun {
+    readonly text: string;
+    readonly inShapeX: number;
+    readonly inShapeY: number;
+    readonly w: number;
+    readonly h: number;
+    readonly shapeX: number;
+    readonly shapeY: number;
+    readonly hyperlink?: EngineHyperlink;
+}
+interface PptxBackend {
+    readonly slideCount: number;
+    readonly slideWidth: number;
+    readonly slideHeight: number;
+    renderSlide(target: HTMLCanvasElement | OffscreenCanvas, slideIndex: number, options: {
+        width: number;
+        dpr: number;
+    }): Promise<void>;
+    collectSlideRuns(slideIndex: number, width?: number): Promise<readonly PptxRun[]>;
+    resolveInternalTarget?(ref: string, currentIndex?: number): number | undefined;
+    destroy(): void;
+}
+type CellValue = {
+    type: "empty";
+} | {
+    type: "text";
+    text: string;
+} | {
+    type: "number";
+    number: number;
+} | {
+    type: "bool";
+    bool: boolean;
+} | {
+    type: "error";
+    error: string;
+} | {
+    type: "shared";
+    si: number;
+};
+interface SpreadsheetCell {
+    readonly row: number;
+    readonly col: number;
+    value: CellValue;
+    formula?: string;
+}
+interface SpreadsheetWorksheet {
+    readonly name: string;
+    readonly rows: readonly {
+        readonly index: number;
+        readonly height?: number | null;
+        readonly hidden?: boolean;
+        readonly cells: readonly SpreadsheetCell[];
+    }[];
+    colWidths?: Record<number, number>;
+    readonly rowHeights?: Readonly<Record<number, number>>;
+    readonly colHidden?: Readonly<Record<number, boolean>>;
+    readonly defaultColWidth?: number;
+    readonly defaultRowHeight?: number;
+    readonly defaultFontFamily?: string;
+    readonly defaultFontSize?: number;
+    readonly mergeCells: readonly {
+        readonly top: number;
+        readonly left: number;
+        readonly bottom: number;
+        readonly right: number;
+    }[];
+    readonly freezeRows: number;
+    readonly freezeCols: number;
+    readonly rightToLeft?: boolean;
+    readonly images?: readonly SpreadsheetDrawingAnchor[];
+    readonly charts?: readonly SpreadsheetDrawingAnchor[];
+    readonly hyperlinks?: readonly {
+        readonly row: number;
+        readonly col: number;
+        readonly url: string | null;
+        readonly location?: string | null;
+    }[];
+    readonly parseError?: string;
+}
+interface SpreadsheetDrawingAnchor {
+    readonly fromCol: number;
+    readonly fromRow: number;
+    readonly toCol: number;
+    readonly toRow: number;
+}
+interface XlsxRun {
+    readonly text: string;
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+    readonly row: number;
+    readonly col: number;
+}
+interface XlsxBackend {
+    readonly sheetNames: readonly string[];
+    readonly sheetCount: number;
+    getWorksheet(sheetIndex: number): Promise<SpreadsheetWorksheet>;
+    cellText?(worksheet: SpreadsheetWorksheet, cell: SpreadsheetCell): string;
+    renderViewport(target: HTMLCanvasElement | OffscreenCanvas, sheetIndex: number, range: {
+        row: number;
+        col: number;
+        rows: number;
+        cols: number;
+    }, options: {
+        width: number;
+        height: number;
+        dpr: number;
+        cellScale: number;
+        freezeRows?: number;
+        freezeCols?: number;
+        scrollOffsetX?: number;
+        scrollOffsetY?: number;
+        onTextRun?: (run: XlsxRun) => void;
+    }): Promise<void>;
+    destroy(): void;
+}
+export interface OfficeEngineLoaders {
+    readonly docx?: (data: ArrayBuffer, options: EngineLoadOptions) => Promise<DocxBackend>;
+    readonly xlsx?: (data: ArrayBuffer, options: EngineLoadOptions) => Promise<XlsxBackend>;
+    readonly pptx?: (data: ArrayBuffer, options: EngineLoadOptions) => Promise<PptxBackend>;
+}
+export interface LegacyConversionOptions {
+    readonly workerUrl?: string | URL;
+    readonly moduleUrl?: string | URL;
+    readonly convert?: (data: Uint8Array, format: LegacyFormat, context: AdapterOpenContext) => Promise<Uint8Array>;
+}
+export interface OfficeAdapterOptions {
+    readonly engines?: OfficeEngineLoaders;
+    readonly legacy?: LegacyConversionOptions;
+}
+interface DocumentHandle {
+    readonly kind: "document";
+    readonly format: DocumentFormat;
+    readonly backend: DocxBackend;
+    readonly warnings: readonly ViewerWarning[];
+}
+interface PresentationHandle {
+    readonly kind: "presentation";
+    readonly format: DocumentFormat;
+    readonly backend: PptxBackend;
+    readonly warnings: readonly ViewerWarning[];
+}
+interface SpreadsheetHandle {
+    readonly kind: "spreadsheet";
+    readonly format: DocumentFormat;
+    readonly backend: XlsxBackend;
+    readonly warnings: readonly ViewerWarning[];
+    readonly worksheets: readonly SpreadsheetWorksheet[];
+    readonly sheets: readonly SpreadsheetSheetInfo[];
+}
+type OfficeHandle = DocumentHandle | PresentationHandle | SpreadsheetHandle;
+export declare class OfficeDocumentAdapter implements DocumentAdapter<OfficeHandle> {
+    #private;
+    readonly id = "office";
+    readonly formats: readonly ["docx", "docm", "xlsx", "xlsm", "pptx", "pptm", "ppsx", "doc", "xls", "ppt"];
+    constructor(options?: OfficeAdapterOptions);
+    open(input: Uint8Array, context: AdapterOpenContext): Promise<OfficeHandle>;
+    getInfo(handle: OfficeHandle): Promise<DocumentInfo>;
+    render(handle: OfficeHandle, target: HTMLCanvasElement | OffscreenCanvas, viewport: RenderViewport, signal?: AbortSignal): Promise<void>;
+    getTextMap(handle: OfficeHandle, pageIndex: number, signal?: AbortSignal): Promise<readonly TextRun[]>;
+    close(handle: OfficeHandle): void;
+}
+export declare function createOfficeAdapter(options?: OfficeAdapterOptions): OfficeDocumentAdapter;
+export declare function sanitizeOfficeHyperlink(target: EngineHyperlink | undefined): HyperlinkTarget | undefined;
+export {};