@p10node/office-engine 0.1.0 → 0.1.1

package/dist/office-engine.worker.js

@@ -344,7 +344,7 @@ async function ce(e, t, n = "application/zip") {
 		let n = await ae(oe(t)), { time: r, date: i } = se();
 		l(e, 8, n.crc, n.csize, n.size, r, i, n.chunks);
 	};
-	for (let t of e.list()) {
+	for (let t of e?.list() ?? []) {
 		let n = E(t.name), r = c.get(n);
 		if (r) {
 			c.delete(n), r.data !== null && await u(t.name, r.data);

package/dist/types/core/convert.d.ts

@@ -0,0 +1,29 @@
+import type { RunSet } from './docx/types';
+/** Separator of a delimited text file: tab, semicolon (European CSV) or comma. */
+export declare function detectSeparator(text: string): string;
+/** RFC 4180 parser (quoted fields, escaped quotes, CRLF / LF, newlines inside quotes). */
+export declare function parseCsv(text: string, sep?: string): string[][];
+/**
+ * Builds a one-sheet workbook from rows of text.
+ * `decimalComma`: "12,5" is a number (semicolon-separated files from comma-decimal locales).
+ */
+export declare function rowsToXlsx(rows: string[][], sheetName?: string, decimalComma?: boolean): Promise<Blob>;
+export interface ImportRun {
+    text: string;
+    set?: RunSet;
+    href?: string;
+}
+export interface ImportPara {
+    runs: ImportRun[];
+    /** heading level 1-6 */
+    heading?: number;
+    list?: 'bullet' | 'number';
+}
+/** One paragraph per line. */
+export declare function textToParas(text: string): ImportPara[];
+/** Small CommonMark subset → HTML: headings, paragraphs, lists, quotes, code blocks, rules, tables. */
+export declare function markdownToHtml(md: string): string;
+/** Builds a document (Letter, 1" margins, Calibri 11) from paragraphs of formatted runs. */
+export declare function parasToDocx(paras: ImportPara[]): Promise<Blob>;
+/** One empty title slide, 16:9, Office theme; layouts: title, title and content, blank. */
+export declare function blankPptx(): Promise<Blob>;

package/dist/types/core/zipwrite.d.ts

@@ -6,4 +6,6 @@ export type PartData = Uint8Array | string | (() => ReadableStream<Uint8Array>);
  * zero-copy when the source is a Blob); changed/added entries are deflated.
  * `changes`: path → new data, or null to delete.
  */
-export declare function rebuildZip(zip: ZipArchive, changes: Map<string, PartData | null>, type?: string): Promise<Blob>;
+export declare function rebuildZip(zip: ZipArchive | null, changes: Map<string, PartData | null>, type?: string): Promise<Blob>;
+/** Writes a new archive (all entries deflated). */
+export declare function writeZip(entries: Map<string, PartData>, type?: string): Promise<Blob>;

package/dist/types/embed.d.ts

@@ -10,7 +10,7 @@ export declare function mount(el: HTMLElement, options: MountOptions): MountedVi
 /**
  * `<office-viewer src="/file.xlsx" style="height:600px"></office-viewer>`
  * Rendered inside a shadow root so host page CSS cannot leak in.
- * Attributes: src, name, editable, toolbar ("false" to hide), thumbnails ("false" to hide);
+ * Attributes: src, name, editable, toolbar / thumbnails / save / download / file-menu / open ("false" to hide);
  * real-time collaboration: collab (hub WebSocket URL), room, user (display name).
  * Property: `file` (File/Blob/ArrayBuffer) for local data.
  */

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import './core/default-worker';
 export { DocViewer, type DocViewerProps } from './react/DocViewer';
+export type { FileMenuItem } from './react/file/FileMenu';
 export { DocxView, type DocxViewProps } from './react/docx/DocxView';
 export { XlsxView, type XlsxViewProps } from './react/xlsx/XlsxView';
 export { PptxView, type PptxViewProps } from './react/pptx/PptxView';

package/dist/types/react/DocViewer.d.ts

@@ -2,6 +2,7 @@ import { type CSSProperties, type ReactNode } from 'react';
 import type { DocSource } from '../core/source';
 import type { DocumentClient, OpenOptions } from '../core/worker/client';
 import type { Zoom } from './common/ZoomControl';
+import { type FileMenuItem } from './file/FileMenu';
 import type { CollabOptions } from '../collab';
 export interface DocViewerProps {
     /** File, Blob, ArrayBuffer, Uint8Array or URL (HTTP Range requests are used when the server supports them). */
@@ -30,6 +31,23 @@ export interface DocViewerProps {
     editable?: boolean;
     /** Show the Edit/View toggle. Default true. */
     allowEdit?: boolean;
+    /** Show the Save/Download button and enable Ctrl+S. Default true. */
+    allowSave?: boolean;
+    /**
+     * Allow downloading files to the user's device (the save fallback without `onSave`, "Download image").
+     * With `onSave`, saving still works when this is false. Default true.
+     */
+    allowDownload?: boolean;
+    /** Show the File menu (new, open, save, rename, download as PDF / HTML / text…, details, print) and its shortcuts. Default true. */
+    fileMenu?: boolean;
+    /** File → New / Open: replace the document with a blank one or a local file (Office, CSV, text, Markdown, HTML). Default true. */
+    allowOpen?: boolean;
+    /** Extra File menu entries (Share, Version history…), shown before Close. */
+    fileMenuItems?: FileMenuItem[];
+    /** File → Rename: called with the new name (extension included). Rename is shown when `fileMenu` is on. */
+    onRename?: (name: string) => void;
+    /** Adds File → Close. */
+    onClose?: () => void;
     /** Receives the saved file instead of downloading it. */
     onSave?: (file: Blob, name: string) => void | Promise<void>;
     /** Called when the document gets / loses unsaved changes. */

package/dist/types/react/common/Dialog.d.ts

@@ -20,6 +20,14 @@ export declare function PromptDialog({ spec, onClose }: {
     spec: PromptSpec;
     onClose: () => void;
 }): import("react").JSX.Element;
+/** Yes / no question (no window.confirm: works in sandboxed / embedded pages). */
+export declare function ConfirmDialog(props: {
+    title: string;
+    message: ReactNode;
+    ok: string;
+    onOk: () => void;
+    onClose: () => void;
+}): import("react").JSX.Element;
 /** Short-lived message at the bottom of the viewer. */
 export declare function Toast({ text, onDone }: {
     text: string;

package/dist/types/react/common/Slots.d.ts

@@ -1,5 +1,17 @@
 import { type ReactNode } from 'react';
 import type { DocumentClient } from '../../core/worker/client';
+import type { Printable } from '../file/print';
+/** What the active view offers to the File menu. */
+export interface FileOps {
+    /** all pages, for PDF / print and HTML */
+    printable(): Promise<Printable>;
+    /** text formats: 'txt' / 'md' (documents, presentations), 'csv' / 'tsv' (current sheet) */
+    text(format: string): Promise<string>;
+    /** File → Document details: [label, value] rows */
+    stats(): [string, string][];
+    /** File → Import (spreadsheets): rows into a new sheet */
+    importTable?(rows: string[][], name: string): Promise<void>;
+}
 export interface ViewerApi {
     /** editor bar mount point (null when the viewer toolbar is hidden) */
     bar: HTMLElement | null;
@@ -8,10 +20,18 @@ export interface ViewerApi {
     setDirty: (dirty: boolean) => void;
     /** build + hand off the edited file */
     save: () => Promise<void>;
+    /** whether files may be downloaded to the user's device */
+    canDownload: boolean;
     client: DocumentClient | null;
+    /** set by the mounted view (see useFileOps) */
+    fileOps: {
+        current: FileOps | null;
+    };
 }
 export declare const ViewerContext: import("react").Context<ViewerApi>;
 export declare const useViewer: () => ViewerApi;
+/** Publishes the view's file operations (latest closure each render) to the File menu. */
+export declare function useFileOps(ops: FileOps): void;
 /** Renders the editor bar into the viewer's toolbar row. */
 export declare function EditorBar({ children }: {
     children: ReactNode;

package/dist/types/react/docx/DocxToolbar.d.ts

@@ -4,7 +4,8 @@ export interface ImageActions {
     original: () => void;
     replace: () => void;
     alt: () => void;
-    download: () => void;
+    /** undefined when downloads are disabled */
+    download?: () => void;
 }
 export declare function DocxToolbar(props: {
     editor: DocxEditor;

package/dist/types/react/edit/Toolbar.d.ts

@@ -26,6 +26,8 @@ export interface DropOption<T> {
     disabled?: boolean;
     /** separator above this option */
     sep?: boolean;
+    /** group heading above this option */
+    head?: string;
 }
 /**
  * Styled dropdown (listbox). Never takes focus from the editor: mouse down is prevented and,
@@ -46,6 +48,8 @@ export declare function Dropdown<T extends string | number>(props: {
     disabled?: boolean;
     /** popup aligned to the trigger's right edge */
     alignRight?: boolean;
+    /** extra class of the trigger button */
+    className?: string;
 }): import("react").JSX.Element;
 /** Value picker (fonts, styles, formats…). */
 export declare function Select<T extends string | number>(props: {

package/dist/types/react/file/DetailsDialog.d.ts

@@ -0,0 +1,7 @@
+import type { DocumentClient } from '../../core/worker/client';
+export declare function DetailsDialog(props: {
+    client: DocumentClient;
+    file: [string, string][];
+    stats: [string, string][];
+    onClose: () => void;
+}): import("react").JSX.Element;

package/dist/types/react/file/FileMenu.d.ts

@@ -0,0 +1,48 @@
+import type { DocKind } from '../../core/opc';
+import type { FileOps } from '../common/Slots';
+import { type DropOption } from '../edit/Toolbar';
+export declare const KIND_LABEL: Record<DocKind, string>;
+/** Host-provided File menu entry (Share, Version history…). */
+export interface FileMenuItem {
+    label: string;
+    /** built-in icon name */
+    icon?: string;
+    /** shortcut / note on the right */
+    hint?: string;
+    disabled?: boolean;
+    onClick: () => void;
+}
+export interface FileActionsOptions {
+    kind: DocKind | undefined;
+    /** file name without extension */
+    base: string;
+    /** New / Open (replace the document) */
+    canOpen: boolean;
+    /** Import into the document (spreadsheets) */
+    canImport: boolean;
+    canSave: boolean;
+    canDownload: boolean;
+    ops: {
+        current: FileOps | null;
+    };
+    create: (kind: DocKind) => void;
+    open: (file: File) => void;
+    save: () => Promise<void>;
+    /** the document in its own format */
+    downloadOriginal: () => Promise<void>;
+    rename?: () => void;
+    details?: () => void;
+    close?: () => void;
+    extra: FileMenuItem[];
+    notify: (message: string) => void;
+}
+export interface FileActions {
+    options: DropOption<string>[];
+    busy: boolean;
+    run: (action: string) => void;
+}
+/** File menu entries and their actions (also used by the Ctrl+O / Ctrl+P shortcuts). */
+export declare function useFileActions(o: FileActionsOptions): FileActions;
+export declare function FileMenu({ actions }: {
+    actions: FileActions;
+}): import("react").JSX.Element | null;

package/dist/types/react/file/importFile.d.ts

@@ -0,0 +1,10 @@
+/** `accept` of the File → Open picker */
+export declare const OPEN_ACCEPT: string;
+export interface Imported {
+    src: Blob;
+    name: string;
+    /** built from another format: not saved as an Office file yet */
+    converted: boolean;
+}
+/** Office files open as they are; CSV / TSV become a workbook, text / Markdown / HTML a document. */
+export declare function importFile(file: File): Promise<Imported>;

package/dist/types/react/file/print.d.ts

@@ -0,0 +1,16 @@
+import type { ReactNode } from 'react';
+/** Content laid out for paper: PDF / print and standalone HTML. */
+export interface Printable {
+    /** the pages (`.de-print-page` elements) or flowing content */
+    node: ReactNode;
+    /** CSS `@page` size: '612pt 792pt', 'landscape', 'auto' */
+    size: string;
+    /** CSS `@page` margin */
+    margin: string;
+    /** shown to the user (e.g. output was truncated) */
+    notice?: string;
+}
+/** Opens the browser print dialog for the content (choose "Save as PDF" there). */
+export declare function printDocument(p: Printable, title: string): Promise<void>;
+/** Standalone web page of the content (pictures embedded). */
+export declare function exportHtml(p: Printable, title: string): Promise<Blob>;

package/dist/types/react/file/text.d.ts

@@ -0,0 +1,10 @@
+import type { Block } from '../../core/docx/types';
+import type { SlideModel } from '../../core/pptx/types';
+/** Plain text: one line per paragraph, list markers kept, table cells separated by tabs. */
+export declare function docxToText(blocks: Block[]): string;
+/** Markdown: headings (outline levels), lists, bold / italic / strike, links, tables. */
+export declare function docxToMarkdown(blocks: Block[]): string;
+/** Text of each slide (shapes, tables, speaker notes). */
+export declare function slidesToText(slides: SlideModel[]): string;
+/** RFC 4180 output (CRLF; fields with separators, quotes or line breaks are quoted). */
+export declare function toCsv(rows: string[][], sep?: string): string;

package/dist/types/react/xlsx/XlsxView.d.ts

@@ -1,4 +1,4 @@
-import type { Range } from '../../core/xlsx/types';
+import type { Merge, Range } from '../../core/xlsx/types';
 import type { DocumentClient } from '../../core/worker/client';
 export interface XlsxViewProps {
     client: DocumentClient;
@@ -14,3 +14,5 @@ interface Selection {
     fc: number;
 }
 export declare const rectOf: (s: Selection) => Range;
+/** grows a range until it holds every merged cell it touches (like Excel / Sheets selections) */
+export declare function withMerges(r: Range, merges: Merge[]): Range;

package/dist/types/react/xlsx/print.d.ts

@@ -0,0 +1,17 @@
+import type { DocumentClient } from '../../core/worker/client';
+import type { Merge, WorkbookMeta } from '../../core/xlsx/types';
+import type { Printable } from '../file/print';
+import type { Axis } from './axis';
+export interface SheetLayout {
+    rows: number;
+    cols: number;
+    rowAxis: Axis;
+    colAxis: Axis;
+    merges: Merge[];
+    gridLines: boolean;
+    done: boolean;
+}
+/** Shown values of the sheet as CSV / TSV (UTF-8 BOM for CSV so Excel reads accents). */
+export declare function sheetText(client: DocumentClient, sheet: number, l: SheetLayout, sep: string): Promise<string>;
+/** The sheet as a table (used range, hidden rows / columns left out), fitted to the paper width. */
+export declare function sheetPrintable(client: DocumentClient, sheet: number, l: SheetLayout, meta: WorkbookMeta): Promise<Printable>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@p10node/office-engine",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Browser engine to view DOCX, XLSX, PPTX progressively (worker-based, range-loading, virtualized React views)",
   "type": "module",
   "license": "MIT",
@@ -48,6 +48,7 @@
     "build:playground": "vite build --config vite.playground.config.ts",
     "typecheck": "tsc --noEmit",
     "test": "bun test",
+    "test:e2e": "bun test ./e2e --timeout 90000",
     "fixtures": "bun scripts/gen-fixtures.ts",
     "build:worker": "vite build --config vite.worker.config.ts",
     "collab": "bun scripts/collab-server.ts",