@pixerate/editor 0.24.0 → 0.26.0

package/dist/{documents-BQjzJNe2.d.ts → documents-CHT1U5Vs.d.ts}

@@ -29,6 +29,14 @@ interface CompareDocumentsOptions {
      * at `granularity: "char"`. Default 2000.
      */
     maxCharDiff?: number;
+    /**
+     * Record a top-level paragraph that was deleted in one place and inserted,
+     * identical, elsewhere as a tracked move (`type: "move"`) instead of a
+     * whole-block deletion and insertion. Only paragraphs whose content occurs
+     * once among the deleted and once among the inserted blocks are paired.
+     * Default `false`.
+     */
+    detectMoves?: boolean;
 }
 interface CompareSummary {
     /** Inserted text runs and inserted block runs. */
@@ -39,6 +47,8 @@ interface CompareSummary {
     formatChanges: number;
     /** Block type, attribute and wrapping changes. */
     blockChanges: number;
+    /** Moved paragraphs (with `detectMoves`). */
+    moves: number;
     /** Differences the result could not represent as tracked changes. */
     notHonoured: string[];
 }

package/dist/{documents-KRTPhvst.d.cts → documents-Gp7wb0Me.d.cts}

@@ -29,6 +29,14 @@ interface CompareDocumentsOptions {
      * at `granularity: "char"`. Default 2000.
      */
     maxCharDiff?: number;
+    /**
+     * Record a top-level paragraph that was deleted in one place and inserted,
+     * identical, elsewhere as a tracked move (`type: "move"`) instead of a
+     * whole-block deletion and insertion. Only paragraphs whose content occurs
+     * once among the deleted and once among the inserted blocks are paired.
+     * Default `false`.
+     */
+    detectMoves?: boolean;
 }
 interface CompareSummary {
     /** Inserted text runs and inserted block runs. */
@@ -39,6 +47,8 @@ interface CompareSummary {
     formatChanges: number;
     /** Block type, attribute and wrapping changes. */
     blockChanges: number;
+    /** Moved paragraphs (with `detectMoves`). */
+    moves: number;
     /** Differences the result could not represent as tracked changes. */
     notHonoured: string[];
 }

package/dist/export/index.cjs

@@ -0,0 +1,36 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+var _chunkTXXNBDQXcjs = require('../chunk-TXXNBDQX.cjs');
+require('../chunk-3CC7OPUQ.cjs');
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.DOCX_ANONYMOUS_AUTHOR = _chunkTXXNBDQXcjs.DOCX_ANONYMOUS_AUTHOR; exports.DOCX_EXPORT_MIME_TYPE = _chunkTXXNBDQXcjs.DOCX_EXPORT_MIME_TYPE; exports.DocxExportController = _chunkTXXNBDQXcjs.DocxExportController; exports.XmlWriter = _chunkTXXNBDQXcjs.XmlWriter; exports.createDocxExportController = _chunkTXXNBDQXcjs.createDocxExportController; exports.createDocxParts = _chunkTXXNBDQXcjs.createDocxParts; exports.deflateRaw = _chunkTXXNBDQXcjs.deflateRaw; exports.docxFileName = _chunkTXXNBDQXcjs.docxFileName; exports.downloadBlob = _chunkTXXNBDQXcjs.downloadBlob; exports.escapeXmlAttr = _chunkTXXNBDQXcjs.escapeXmlAttr; exports.escapeXmlText = _chunkTXXNBDQXcjs.escapeXmlText; exports.exportDocx = _chunkTXXNBDQXcjs.exportDocx; exports.exportDocxBlob = _chunkTXXNBDQXcjs.exportDocxBlob; exports.stripInvalidXmlChars = _chunkTXXNBDQXcjs.stripInvalidXmlChars; exports.writeZip = _chunkTXXNBDQXcjs.writeZip;
+//# sourceMappingURL=index.cjs.map

package/dist/export/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/editor/editor/packages/core/dist/export/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,g5BAAC","file":"/home/runner/work/editor/editor/packages/core/dist/export/index.cjs"}

package/dist/export/index.d.cts

@@ -0,0 +1,243 @@
+import { S as SerializedComments, f as CommentThread, R as ReviewAuthor } from '../comment-store-BEMgVlAA.cjs';
+import { e as StyleRegistry, f as StyleRegistryJSON, c as StyleDefinition } from '../registry-CED5C0lA.cjs';
+
+/**
+ * Dependency-free DOCX (WordprocessingML) export of TipTap documents.
+ *
+ * Takes an editor (anything with `getJSON()`) or its JSON and writes a
+ * minimal, valid package: `[Content_Types].xml`, `_rels/.rels`,
+ * `word/document.xml` (+ relationships), `styles.xml` (from the paragraph
+ * style registry, with `basedOn` / `next` / `link`), `numbering.xml` (one
+ * `w:num` per list), `settings.xml`, `comments.xml` +
+ * `commentsExtended.xml` (replies and resolved state) + `people.xml` (author
+ * ids), `docProps/core.xml` and `docProps/app.xml`, plus embedded images.
+ *
+ * Tracked insertions, deletions, moves (`w:moveFrom` / `w:moveTo` with
+ * named move ranges), formatting changes (`w:rPrChange`) and block changes
+ * (`w:pPrChange`, paragraph-mark `w:ins` / `w:del`) keep their authors and
+ * dates. Anything that cannot be written is listed in the returned report.
+ */
+declare const DOCX_EXPORT_MIME_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+/** A ProseMirror / TipTap JSON node (`editor.getJSON()`). */
+interface DocxJSONNode {
+    type?: string;
+    attrs?: Record<string, any>;
+    content?: DocxJSONNode[];
+    marks?: DocxJSONMark[];
+    text?: string;
+}
+interface DocxJSONMark {
+    type: string;
+    attrs?: Record<string, any>;
+}
+/** Anything with `getJSON()`, e.g. a TipTap `Editor`. Its comment store and style registry are used by default. */
+interface DocxExportEditorLike {
+    getJSON(): DocxJSONNode;
+    storage?: unknown;
+}
+/** A comment store (`CommentStore`), its `toJSON()` output, or a thread list. */
+type DocxCommentSource = {
+    toJSON(): SerializedComments;
+} | {
+    getSnapshot(): {
+        threads: readonly CommentThread[];
+    };
+} | SerializedComments | readonly CommentThread[];
+interface DocxExportOptions {
+    /**
+     * Paragraph and character styles written to `styles.xml`. Defaults to the
+     * editor's registry (`ParagraphStyles` extension), else the built-in styles.
+     */
+    styles?: StyleRegistry | StyleRegistryJSON | readonly StyleDefinition[];
+    /** Comment threads. Defaults to the editor's comment store (`Comments` extension). */
+    comments?: DocxCommentSource | null;
+    /**
+     * The document's author (`dc:creator`) and the author of tracked changes
+     * and comments that name none.
+     */
+    author?: string | ReviewAuthor;
+    /**
+     * `"strip-authors"` writes every comment, reply and tracked change as
+     * "Author" (initials "A"), leaves out `people.xml`, the creator and last
+     * modified by, and sets `w:removePersonalInformation` so Word keeps doing
+     * so. Default `"keep"`.
+     */
+    privacy?: "keep" | "strip-authors";
+    /** `dc:title` of the document. */
+    title?: string;
+    /**
+     * Images with `http(s)` URLs: `"skip"` (default, reported) or `"link"`
+     * (an external relationship Word may load when the file is opened).
+     */
+    remoteImages?: "skip" | "link";
+    /** Time written as created / modified (default: now). */
+    now?: () => Date;
+    /** ZIP compression (default `"auto"`: deflate when `CompressionStream` exists). */
+    compression?: "auto" | "store";
+}
+type DocxExportIssueKind = "node" | "mark" | "image" | "link" | "comment" | "style";
+/** Something the export left out or simplified, counted per kind, name and reason. */
+interface DocxExportIssue {
+    kind: DocxExportIssueKind;
+    /** Node / mark type, style id, image or link URL (truncated), or comment thread id. */
+    name: string;
+    reason: string;
+    count: number;
+}
+interface DocxExportReport {
+    /** Content that was dropped or simplified. Empty when everything was written. */
+    dropped: DocxExportIssue[];
+    /** Counts of what was written. */
+    written: {
+        paragraphs: number;
+        tables: number;
+        images: number;
+        comments: number;
+        replies: number;
+        trackedChanges: number;
+    };
+}
+interface DocxExportResult {
+    /** The `.docx` file. */
+    data: Uint8Array;
+    report: DocxExportReport;
+}
+interface DocxPackagePart {
+    name: string;
+    data: Uint8Array | string;
+}
+/** Name written for every author with `privacy: "strip-authors"` (as Word does). */
+declare const DOCX_ANONYMOUS_AUTHOR = "Author";
+/**
+ * Builds the package parts of a DOCX file without zipping them (synchronous;
+ * useful for inspection and tests). See {@link exportDocx}.
+ */
+declare function createDocxParts(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): {
+    parts: DocxPackagePart[];
+    report: DocxExportReport;
+};
+/**
+ * Exports an editor (or its JSON) as a Word document. Resolves with the file
+ * bytes and a report of what was dropped. Never fetches anything: remote
+ * images are skipped (or linked with `remoteImages: "link"`).
+ */
+declare function exportDocx(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): Promise<DocxExportResult>;
+/** Like {@link exportDocx}, but resolves with a `Blob` of type {@link DOCX_EXPORT_MIME_TYPE}. */
+declare function exportDocxBlob(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): Promise<{
+    blob: Blob;
+    report: DocxExportReport;
+}>;
+
+/**
+ * Saves a `Blob` as a file through a temporary `<a download>` link. Does
+ * nothing (returns `false`) without a DOM.
+ */
+declare function downloadBlob(blob: Blob, fileName: string): boolean;
+/** `name.docx`, with characters that are invalid in file names replaced. */
+declare function docxFileName(name: string | undefined): string;
+interface DocxExportState {
+    isExporting: boolean;
+    /** Last export error (cleared when a new export starts). */
+    error: Error | null;
+    /** Report of the most recent successful export. */
+    lastReport: DocxExportReport | null;
+}
+interface DocxExportControllerOptions extends DocxExportOptions {
+    /** Download file name (default: `title`, else `document`, plus `.docx`). */
+    fileName?: string;
+    /** Called after each successful export with its report. */
+    onExport?: (report: DocxExportReport, blob: Blob) => void;
+    /** Called when an export fails (the error is also kept in the state). */
+    onError?: (error: Error) => void;
+}
+/**
+ * Framework-agnostic state for an "Export to Word" button: tracks
+ * `isExporting` / `error` / `lastReport` and downloads the `.docx` of the
+ * editor returned by `getSource`. React's `useDocxExport` and Svelte's
+ * `createDocxExport` wrap it.
+ */
+declare class DocxExportController {
+    private readonly getSource;
+    private options;
+    private state;
+    private readonly listeners;
+    private pending;
+    constructor(getSource: () => DocxExportEditorLike | DocxJSONNode | null | undefined, options?: DocxExportControllerOptions);
+    setOptions(options: DocxExportControllerOptions): void;
+    getState: () => DocxExportState;
+    subscribe: (listener: (state: DocxExportState) => void) => (() => void);
+    private setState;
+    /** Builds the `.docx` without downloading it. Resolves with `null` when there is no editor or it fails. */
+    exportBlob(): Promise<{
+        blob: Blob;
+        report: DocxExportReport;
+    } | null>;
+    /** Exports and downloads the document. Resolves with the report, or `null`. */
+    download(fileName?: string): Promise<DocxExportReport | null>;
+}
+declare function createDocxExportController(getSource: () => DocxExportEditorLike | DocxJSONNode | null | undefined, options?: DocxExportControllerOptions): DocxExportController;
+
+/**
+ * Minimal, dependency-free ZIP writer (the counterpart of `readZip`), used by
+ * the DOCX export. Entries are deflated with the platform
+ * `CompressionStream("deflate-raw")` when it exists (modern browsers,
+ * Node ≥ 18) and stored otherwise, or when deflating does not make them
+ * smaller. Names are written as UTF-8 (flag bit 11). No ZIP64: archives are
+ * limited to 65 535 entries and 4 GiB.
+ */
+interface ZipWriteEntry {
+    /** Entry path with `/` separators; must be relative and free of `..`. */
+    name: string;
+    /** Strings are encoded as UTF-8. */
+    data: Uint8Array | string;
+}
+interface ZipWriteOptions {
+    /**
+     * `"auto"` (default) deflates when `CompressionStream` is available,
+     * `"store"` never compresses.
+     */
+    compression?: "auto" | "store";
+    /**
+     * Modification time written for every entry (default 1980-01-01, the DOS
+     * epoch, so the output is deterministic).
+     */
+    modified?: Date;
+}
+/** Raw deflate with `CompressionStream`, or `null` when it is unavailable. */
+declare function deflateRaw(data: Uint8Array): Promise<Uint8Array | null>;
+/** Writes a ZIP archive. Throws on unsafe or duplicate names and oversized archives. */
+declare function writeZip(entries: readonly ZipWriteEntry[], options?: ZipWriteOptions): Promise<Uint8Array>;
+
+/** Removes characters that are not allowed in XML 1.0 documents. */
+declare function stripInvalidXmlChars(value: string): string;
+/** Escapes text for XML element content (`&`, `<`, `>`), dropping invalid characters. */
+declare function escapeXmlText(value: string): string;
+/**
+ * Escapes a value for a double- or single-quoted XML attribute. White space
+ * other than spaces is written as character references, because attribute
+ * value normalisation would otherwise turn tabs and newlines into spaces.
+ */
+declare function escapeXmlAttr(value: string): string;
+type XmlAttrs = Record<string, string | number | undefined | null | false>;
+/**
+ * A small string-building XML writer; every attribute value and text node is
+ * escaped. Element names are trusted (always literals in this codebase).
+ */
+declare class XmlWriter {
+    private parts;
+    /** `declaration: false` writes a fragment (e.g. one paragraph). */
+    constructor(declaration?: boolean);
+    open(name: string, values?: XmlAttrs): this;
+    empty(name: string, values?: XmlAttrs): this;
+    close(name: string): this;
+    text(value: string): this;
+    /** `<name attrs>text</name>`. */
+    leaf(name: string, values: XmlAttrs | undefined, text: string): this;
+    /** `<name w:val="value"/>`. */
+    val(name: string, value: string | number): this;
+    /** Appends markup produced by another writer. */
+    raw(markup: string): this;
+    toString(): string;
+}
+
+export { DOCX_ANONYMOUS_AUTHOR, DOCX_EXPORT_MIME_TYPE, type DocxCommentSource, DocxExportController, type DocxExportControllerOptions, type DocxExportEditorLike, type DocxExportIssue, type DocxExportIssueKind, type DocxExportOptions, type DocxExportReport, type DocxExportResult, type DocxExportState, type DocxJSONMark, type DocxJSONNode, type DocxPackagePart, type XmlAttrs, XmlWriter, type ZipWriteEntry, type ZipWriteOptions, createDocxExportController, createDocxParts, deflateRaw, docxFileName, downloadBlob, escapeXmlAttr, escapeXmlText, exportDocx, exportDocxBlob, stripInvalidXmlChars, writeZip };

package/dist/export/index.d.ts

@@ -0,0 +1,243 @@
+import { S as SerializedComments, f as CommentThread, R as ReviewAuthor } from '../comment-store-BEMgVlAA.js';
+import { e as StyleRegistry, f as StyleRegistryJSON, c as StyleDefinition } from '../registry-CED5C0lA.js';
+
+/**
+ * Dependency-free DOCX (WordprocessingML) export of TipTap documents.
+ *
+ * Takes an editor (anything with `getJSON()`) or its JSON and writes a
+ * minimal, valid package: `[Content_Types].xml`, `_rels/.rels`,
+ * `word/document.xml` (+ relationships), `styles.xml` (from the paragraph
+ * style registry, with `basedOn` / `next` / `link`), `numbering.xml` (one
+ * `w:num` per list), `settings.xml`, `comments.xml` +
+ * `commentsExtended.xml` (replies and resolved state) + `people.xml` (author
+ * ids), `docProps/core.xml` and `docProps/app.xml`, plus embedded images.
+ *
+ * Tracked insertions, deletions, moves (`w:moveFrom` / `w:moveTo` with
+ * named move ranges), formatting changes (`w:rPrChange`) and block changes
+ * (`w:pPrChange`, paragraph-mark `w:ins` / `w:del`) keep their authors and
+ * dates. Anything that cannot be written is listed in the returned report.
+ */
+declare const DOCX_EXPORT_MIME_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+/** A ProseMirror / TipTap JSON node (`editor.getJSON()`). */
+interface DocxJSONNode {
+    type?: string;
+    attrs?: Record<string, any>;
+    content?: DocxJSONNode[];
+    marks?: DocxJSONMark[];
+    text?: string;
+}
+interface DocxJSONMark {
+    type: string;
+    attrs?: Record<string, any>;
+}
+/** Anything with `getJSON()`, e.g. a TipTap `Editor`. Its comment store and style registry are used by default. */
+interface DocxExportEditorLike {
+    getJSON(): DocxJSONNode;
+    storage?: unknown;
+}
+/** A comment store (`CommentStore`), its `toJSON()` output, or a thread list. */
+type DocxCommentSource = {
+    toJSON(): SerializedComments;
+} | {
+    getSnapshot(): {
+        threads: readonly CommentThread[];
+    };
+} | SerializedComments | readonly CommentThread[];
+interface DocxExportOptions {
+    /**
+     * Paragraph and character styles written to `styles.xml`. Defaults to the
+     * editor's registry (`ParagraphStyles` extension), else the built-in styles.
+     */
+    styles?: StyleRegistry | StyleRegistryJSON | readonly StyleDefinition[];
+    /** Comment threads. Defaults to the editor's comment store (`Comments` extension). */
+    comments?: DocxCommentSource | null;
+    /**
+     * The document's author (`dc:creator`) and the author of tracked changes
+     * and comments that name none.
+     */
+    author?: string | ReviewAuthor;
+    /**
+     * `"strip-authors"` writes every comment, reply and tracked change as
+     * "Author" (initials "A"), leaves out `people.xml`, the creator and last
+     * modified by, and sets `w:removePersonalInformation` so Word keeps doing
+     * so. Default `"keep"`.
+     */
+    privacy?: "keep" | "strip-authors";
+    /** `dc:title` of the document. */
+    title?: string;
+    /**
+     * Images with `http(s)` URLs: `"skip"` (default, reported) or `"link"`
+     * (an external relationship Word may load when the file is opened).
+     */
+    remoteImages?: "skip" | "link";
+    /** Time written as created / modified (default: now). */
+    now?: () => Date;
+    /** ZIP compression (default `"auto"`: deflate when `CompressionStream` exists). */
+    compression?: "auto" | "store";
+}
+type DocxExportIssueKind = "node" | "mark" | "image" | "link" | "comment" | "style";
+/** Something the export left out or simplified, counted per kind, name and reason. */
+interface DocxExportIssue {
+    kind: DocxExportIssueKind;
+    /** Node / mark type, style id, image or link URL (truncated), or comment thread id. */
+    name: string;
+    reason: string;
+    count: number;
+}
+interface DocxExportReport {
+    /** Content that was dropped or simplified. Empty when everything was written. */
+    dropped: DocxExportIssue[];
+    /** Counts of what was written. */
+    written: {
+        paragraphs: number;
+        tables: number;
+        images: number;
+        comments: number;
+        replies: number;
+        trackedChanges: number;
+    };
+}
+interface DocxExportResult {
+    /** The `.docx` file. */
+    data: Uint8Array;
+    report: DocxExportReport;
+}
+interface DocxPackagePart {
+    name: string;
+    data: Uint8Array | string;
+}
+/** Name written for every author with `privacy: "strip-authors"` (as Word does). */
+declare const DOCX_ANONYMOUS_AUTHOR = "Author";
+/**
+ * Builds the package parts of a DOCX file without zipping them (synchronous;
+ * useful for inspection and tests). See {@link exportDocx}.
+ */
+declare function createDocxParts(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): {
+    parts: DocxPackagePart[];
+    report: DocxExportReport;
+};
+/**
+ * Exports an editor (or its JSON) as a Word document. Resolves with the file
+ * bytes and a report of what was dropped. Never fetches anything: remote
+ * images are skipped (or linked with `remoteImages: "link"`).
+ */
+declare function exportDocx(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): Promise<DocxExportResult>;
+/** Like {@link exportDocx}, but resolves with a `Blob` of type {@link DOCX_EXPORT_MIME_TYPE}. */
+declare function exportDocxBlob(input: DocxExportEditorLike | DocxJSONNode, options?: DocxExportOptions): Promise<{
+    blob: Blob;
+    report: DocxExportReport;
+}>;
+
+/**
+ * Saves a `Blob` as a file through a temporary `<a download>` link. Does
+ * nothing (returns `false`) without a DOM.
+ */
+declare function downloadBlob(blob: Blob, fileName: string): boolean;
+/** `name.docx`, with characters that are invalid in file names replaced. */
+declare function docxFileName(name: string | undefined): string;
+interface DocxExportState {
+    isExporting: boolean;
+    /** Last export error (cleared when a new export starts). */
+    error: Error | null;
+    /** Report of the most recent successful export. */
+    lastReport: DocxExportReport | null;
+}
+interface DocxExportControllerOptions extends DocxExportOptions {
+    /** Download file name (default: `title`, else `document`, plus `.docx`). */
+    fileName?: string;
+    /** Called after each successful export with its report. */
+    onExport?: (report: DocxExportReport, blob: Blob) => void;
+    /** Called when an export fails (the error is also kept in the state). */
+    onError?: (error: Error) => void;
+}
+/**
+ * Framework-agnostic state for an "Export to Word" button: tracks
+ * `isExporting` / `error` / `lastReport` and downloads the `.docx` of the
+ * editor returned by `getSource`. React's `useDocxExport` and Svelte's
+ * `createDocxExport` wrap it.
+ */
+declare class DocxExportController {
+    private readonly getSource;
+    private options;
+    private state;
+    private readonly listeners;
+    private pending;
+    constructor(getSource: () => DocxExportEditorLike | DocxJSONNode | null | undefined, options?: DocxExportControllerOptions);
+    setOptions(options: DocxExportControllerOptions): void;
+    getState: () => DocxExportState;
+    subscribe: (listener: (state: DocxExportState) => void) => (() => void);
+    private setState;
+    /** Builds the `.docx` without downloading it. Resolves with `null` when there is no editor or it fails. */
+    exportBlob(): Promise<{
+        blob: Blob;
+        report: DocxExportReport;
+    } | null>;
+    /** Exports and downloads the document. Resolves with the report, or `null`. */
+    download(fileName?: string): Promise<DocxExportReport | null>;
+}
+declare function createDocxExportController(getSource: () => DocxExportEditorLike | DocxJSONNode | null | undefined, options?: DocxExportControllerOptions): DocxExportController;
+
+/**
+ * Minimal, dependency-free ZIP writer (the counterpart of `readZip`), used by
+ * the DOCX export. Entries are deflated with the platform
+ * `CompressionStream("deflate-raw")` when it exists (modern browsers,
+ * Node ≥ 18) and stored otherwise, or when deflating does not make them
+ * smaller. Names are written as UTF-8 (flag bit 11). No ZIP64: archives are
+ * limited to 65 535 entries and 4 GiB.
+ */
+interface ZipWriteEntry {
+    /** Entry path with `/` separators; must be relative and free of `..`. */
+    name: string;
+    /** Strings are encoded as UTF-8. */
+    data: Uint8Array | string;
+}
+interface ZipWriteOptions {
+    /**
+     * `"auto"` (default) deflates when `CompressionStream` is available,
+     * `"store"` never compresses.
+     */
+    compression?: "auto" | "store";
+    /**
+     * Modification time written for every entry (default 1980-01-01, the DOS
+     * epoch, so the output is deterministic).
+     */
+    modified?: Date;
+}
+/** Raw deflate with `CompressionStream`, or `null` when it is unavailable. */
+declare function deflateRaw(data: Uint8Array): Promise<Uint8Array | null>;
+/** Writes a ZIP archive. Throws on unsafe or duplicate names and oversized archives. */
+declare function writeZip(entries: readonly ZipWriteEntry[], options?: ZipWriteOptions): Promise<Uint8Array>;
+
+/** Removes characters that are not allowed in XML 1.0 documents. */
+declare function stripInvalidXmlChars(value: string): string;
+/** Escapes text for XML element content (`&`, `<`, `>`), dropping invalid characters. */
+declare function escapeXmlText(value: string): string;
+/**
+ * Escapes a value for a double- or single-quoted XML attribute. White space
+ * other than spaces is written as character references, because attribute
+ * value normalisation would otherwise turn tabs and newlines into spaces.
+ */
+declare function escapeXmlAttr(value: string): string;
+type XmlAttrs = Record<string, string | number | undefined | null | false>;
+/**
+ * A small string-building XML writer; every attribute value and text node is
+ * escaped. Element names are trusted (always literals in this codebase).
+ */
+declare class XmlWriter {
+    private parts;
+    /** `declaration: false` writes a fragment (e.g. one paragraph). */
+    constructor(declaration?: boolean);
+    open(name: string, values?: XmlAttrs): this;
+    empty(name: string, values?: XmlAttrs): this;
+    close(name: string): this;
+    text(value: string): this;
+    /** `<name attrs>text</name>`. */
+    leaf(name: string, values: XmlAttrs | undefined, text: string): this;
+    /** `<name w:val="value"/>`. */
+    val(name: string, value: string | number): this;
+    /** Appends markup produced by another writer. */
+    raw(markup: string): this;
+    toString(): string;
+}
+
+export { DOCX_ANONYMOUS_AUTHOR, DOCX_EXPORT_MIME_TYPE, type DocxCommentSource, DocxExportController, type DocxExportControllerOptions, type DocxExportEditorLike, type DocxExportIssue, type DocxExportIssueKind, type DocxExportOptions, type DocxExportReport, type DocxExportResult, type DocxExportState, type DocxJSONMark, type DocxJSONNode, type DocxPackagePart, type XmlAttrs, XmlWriter, type ZipWriteEntry, type ZipWriteOptions, createDocxExportController, createDocxParts, deflateRaw, docxFileName, downloadBlob, escapeXmlAttr, escapeXmlText, exportDocx, exportDocxBlob, stripInvalidXmlChars, writeZip };

package/dist/export/index.js

@@ -0,0 +1,36 @@
+import {
+  DOCX_ANONYMOUS_AUTHOR,
+  DOCX_EXPORT_MIME_TYPE,
+  DocxExportController,
+  XmlWriter,
+  createDocxExportController,
+  createDocxParts,
+  deflateRaw,
+  docxFileName,
+  downloadBlob,
+  escapeXmlAttr,
+  escapeXmlText,
+  exportDocx,
+  exportDocxBlob,
+  stripInvalidXmlChars,
+  writeZip
+} from "../chunk-KRGXUQ2Y.js";
+import "../chunk-MR2764X2.js";
+export {
+  DOCX_ANONYMOUS_AUTHOR,
+  DOCX_EXPORT_MIME_TYPE,
+  DocxExportController,
+  XmlWriter,
+  createDocxExportController,
+  createDocxParts,
+  deflateRaw,
+  docxFileName,
+  downloadBlob,
+  escapeXmlAttr,
+  escapeXmlText,
+  exportDocx,
+  exportDocxBlob,
+  stripInvalidXmlChars,
+  writeZip
+};
+//# sourceMappingURL=index.js.map

package/dist/export/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}