@docx-editor.dev/core 2.14.1 → 2.15.0

package/dist/contracts/document.d.cts

@@ -1,273 +0,0 @@
-import { DocxDocument, ExecResult, ContentControlType, DocTarget, RunFormatting, Extent, InsertableContentControlType, ContainerRef, ContentControlFilter, DocRange, Revision, DocComment, StyleDefinitions } from './types.cjs';
-export { Block, ColorValue, ContentControl, DocAnchor, DocAnchorRange, DocLocation, DocumentBody, ExecErrorCode, HeaderFooterSet, IndentFormatting, Paragraph, ParagraphFlags, ParagraphTabStop, RevisionType, Section, SectionProperties, StyleDefinition, Table, Theme, ThemeColorScheme } from './types.cjs';
-
-/**
- * `@docx-editor.dev/core/contracts/document` — the document-level edit and query vocabulary.
- *
- * The subset that means something without a live editor: what an automation host or an LLM tool
- * can ask for and change.
- *
- * A CONTRACT module, not a barrel. `contracts/editor` builds the `Editor` command and query
- * surfaces on top of these, so they cannot live in the package root: the root re-exports
- * runtime from `../editor`, and a contract importing the root would invert the dependency —
- * safe today only because that import is type-only, and one accidental value import away from
- * pulling the painted engine into a server bundle.
- *
- * @packageDocumentation
- * @public
- */
-
-/**
- * The document-executable edit vocabulary.
- *
- * An interface rather than a closed union so extensions can widen it by
- * declaration merging. A sealed union cannot be extended by a plugin, and the
- * runtime dispatch is already registry-backed.
- */
-interface DocEdits {
-    insertText: {
-        target: DocTarget;
-        text: string;
-    };
-    replaceText: {
-        target: DocTarget;
-        text: string;
-    };
-    deleteText: {
-        target: DocTarget;
-    };
-    applyFormatting: {
-        target: DocTarget;
-        marks: RunFormatting;
-    };
-    setParagraphStyle: {
-        target: DocTarget;
-        styleId: string;
-    };
-    insertTable: {
-        target: DocTarget;
-        rows: number;
-        cols: number;
-    };
-    insertImage: {
-        target: DocTarget;
-        data: Uint8Array;
-        extent?: Extent;
-    };
-    insertHyperlink: {
-        target: DocTarget;
-        href: string;
-        text?: string;
-    };
-    removeHyperlink: {
-        target: DocTarget;
-    };
-    /**
-     * `'section'` is Word's Next Page break; `'sectionContinuous'` keeps the new section on
-     * the sheet the previous one ended, which is how a mid-page column or margin change is
-     * authored. `'column'` belongs to the multi-column lane and is refused for now.
-     */
-    insertBreak: {
-        target: DocTarget;
-        kind: 'page' | 'column' | 'line' | 'section' | 'sectionContinuous';
-    };
-    /**
-     * Word's Increase/Decrease Indent.
-     *
-     * A numbered or bulleted paragraph changes LEVEL, so its marker re-resolves from the
-     * numbering definition — a bullet becomes a hollow circle, a `1.` becomes an `a.`.
-     * Every other paragraph moves its left indent by one default tab stop.
-     */
-    adjustIndent: {
-        target: DocTarget;
-        direction: 'increase' | 'decrease';
-    };
-    /**
-     * Word's Bullets and Numbering.
-     *
-     * Turns the selection into a list, or takes it out of one when it already is. The
-     * definition is created on first use, `numbering.xml` included.
-     */
-    toggleList: {
-        target: DocTarget;
-        kind: 'bullet' | 'ordered';
-    };
-    splitParagraph: {
-        target: DocTarget;
-    };
-    mergeParagraphs: {
-        target: DocTarget;
-    };
-    setVariable: {
-        name: string;
-        value: string;
-    };
-    applyVariables: {
-        values: Record<string, string>;
-    };
-    /**
-     * Authored family. `author` is required: tracked-ness is verb identity, not a
-     * boolean flag, so there is no global trackChanges toggle to forget.
-     */
-    proposeReplacement: {
-        target: DocTarget;
-        replaceWith: string;
-        author: string;
-    };
-    proposeInsertion: {
-        target: DocTarget;
-        text: string;
-        author: string;
-    };
-    proposeDeletion: {
-        target: DocTarget;
-        author: string;
-    };
-    addComment: {
-        target: DocTarget;
-        text: string;
-        author: string;
-    };
-    replyComment: {
-        commentId: string;
-        text: string;
-        author: string;
-    };
-    resolveComment: {
-        commentId: string;
-    };
-    acceptRevision: {
-        id: number;
-        part?: 'body' | 'footnote' | 'endnote';
-        noteId?: number;
-    };
-    rejectRevision: {
-        id: number;
-        part?: 'body' | 'footnote' | 'endnote';
-        noteId?: number;
-    };
-    acceptAllRevisions: Record<never, never>;
-    rejectAllRevisions: Record<never, never>;
-    /**
-     * Author a NEW control over the addressed span.
-     *
-     * A RANGE becomes a wrapper around the characters that are already there. A COLLAPSED
-     * position inserts an empty control showing its type's prompt, which is Word's own gesture
-     * and the one a template host reaches for: the first character typed replaces the prompt
-     * whole, so nothing has to detect and undo text the caller never asked for.
-     *
-     * `title` is Word's `w:alias` — the label a user sees — and `tag` is `w:tag`, the
-     * machine-readable identity a host looks the control back up by. Named as the automation
-     * protocol names them, so a caller who reaches for both surfaces writes one vocabulary.
-     *
-     * One paragraph only. A control that starts in one paragraph and ends in another is a BLOCK
-     * wrapper over both, a different element than the inline one this authors — refused rather
-     * than guessed, so a caller learns which they asked for.
-     */
-    insertContentControl: {
-        target: DocTarget;
-        subtype: InsertableContentControlType;
-        tag?: string;
-        title?: string;
-    };
-    setContentControlValue: {
-        target: DocTarget;
-        value: string;
-    };
-    removeContentControl: {
-        target: DocTarget;
-    };
-    addRepeatingSectionItem: {
-        target: DocTarget;
-        index?: number;
-    };
-    removeRepeatingSectionItem: {
-        target: DocTarget;
-        index: number;
-    };
-}
-/**
- * One edit, as a discriminated union derived from {@link DocEdits}.
- *
- * Adding a key to `DocEdits` — including by declaration merging from a plugin — widens this
- * automatically, so the union never drifts from the vocabulary it is built out of.
- */
-type DocEdit = {
-    [K in keyof DocEdits]: {
-        type: K;
-    } & DocEdits[K];
-}[keyof DocEdits];
-/**
- * What applying a batch of edits produced: the new document, and a per-edit verdict.
- *
- * `results` is positionally aligned with the input, so an edit that failed is identified by its
- * index rather than by anything the caller has to correlate.
- */
-interface ApplyResult {
-    doc: DocxDocument;
-    /** One per edit, positionally aligned with the input. */
-    results: ExecResult[];
-}
-/**
- * The document-readable query vocabulary, keyed identically to {@link DocQueryResults}.
- *
- * An interface rather than a closed union for the same reason {@link DocEdits} is: an extension
- * widens it by declaration merging, and the runtime dispatch is registry-backed.
- */
-interface DocQueries {
-    paragraphs: {
-        container?: ContainerRef;
-    };
-    findText: {
-        text: string;
-        container?: ContainerRef;
-    };
-    contentControls: {
-        filter?: ContentControlFilter;
-    };
-    revisions: {
-        part?: 'body' | 'footnote' | 'endnote';
-    };
-    comments: {
-        resolved?: boolean;
-    };
-    styles: Record<never, never>;
-    variables: Record<never, never>;
-}
-/** One query, as a discriminated union derived from {@link DocQueries}. */
-type DocQuery = {
-    [K in keyof DocQueries]: {
-        type: K;
-    } & DocQueries[K];
-}[keyof DocQueries];
-/** What each query returns. Keyed identically to `DocQueries`. */
-interface DocQueryResults {
-    paragraphs: readonly ParagraphSummary[];
-    findText: readonly DocRange[];
-    contentControls: readonly ContentControlSummary[];
-    revisions: readonly Revision[];
-    comments: readonly DocComment[];
-    styles: StyleDefinitions;
-    variables: Readonly<Record<string, string>>;
-}
-/**
- * A paragraph reduced to what a listing needs: its stable handle, its text, and its style.
- *
- * `paraId` is what a follow-up edit addresses, so a summary without one names a paragraph the
- * file gave no `w14:paraId` and that a `DocAnchor` cannot reach.
- */
-interface ParagraphSummary {
-    readonly paraId?: string;
-    readonly text: string;
-    readonly styleId?: string;
-}
-/** A content control reduced to what a listing needs: its identity, kind, and lock state. */
-interface ContentControlSummary {
-    readonly id: string;
-    readonly tag?: string;
-    readonly alias?: string;
-    readonly controlType: ContentControlType;
-    readonly locked?: boolean;
-}
-
-export { type ApplyResult, ContainerRef, ContentControlFilter, type ContentControlSummary, ContentControlType, DocComment, type DocEdit, type DocEdits, type DocQueries, type DocQuery, type DocQueryResults, DocRange, DocTarget, DocxDocument, ExecResult, Extent, InsertableContentControlType, type ParagraphSummary, Revision, RunFormatting, StyleDefinitions };

package/dist/contracts/editor.d.cts

@@ -1,10 +0,0 @@
-export { ContentControlSummary, DocEdits, DocQueries, DocQueryResults, ParagraphSummary } from './document.cjs';
-export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, a as ReviewItem, e as ReviewPosition, f as ReviewRange, b as ReviewRevisionItem, g as ReviewRevisionKind } from '../review-items-CaAkgi5s.cjs';
-export { A as AuthoredNoteNumbering, C as CanResult, u as DocumentChange, w as DocumentEditingMode, x as DocumentHandle, D as DocumentSource, n as Editor, b as EditorCommand, y as EditorCommandShape, z as EditorCommands, B as EditorError, G as EditorEvents, E as EditorFontError, H as EditorFontErrorCode, J as EditorFormatPainterCommands, K as EditorHeaderFooterCommands, L as EditorNoteCommands, M as EditorPosition, N as EditorQueries, O as EditorQuery, P as EditorQueryResults, Q as EditorScope, R as EditorSelection, a as EditorSnapshot, F as FontConfiguration, m as FontFaceRequest, k as FontSource, l as FontSourceSubstitution, U as FormatPainterLevel, W as FormatPainterMode, o as FormatPainterSurfaceState, X as FurnitureVariant, Y as HeaderFooterSlotArgs, _ as HeaderFooterState, $ as HyperlinkInfo, I as ImageContext, c as ImageCropPercent, a0 as InteractionAffinity, a1 as InteractionOutcome, a2 as InteractionOutcomeCode, a3 as NoteKind, a4 as NotePropertiesSide, a5 as NotePropertiesState, a6 as PageSetup, a7 as ResolvedNoteNumbering, a8 as ReviewActivationOptions, a9 as ReviewCommentPlacement, aa as ReviewCustomPlacement, ab as ReviewItemPlacement, ac as ReviewItemPlacementBase, ad as ReviewItemQuery, ae as ReviewRevisionPlacement, S as SelectedImageState, af as SemanticIdentity, ag as SemanticTarget, p as TableBorderEdgeTarget, q as TableBorderSpec, r as TableBorderStyle, ah as TableBorderTarget, ai as TableCellVerticalAlignment, aj as TableColumnDividerResizeTarget, ak as TableColumnOccurrenceTarget, t as TableContext, al as TableRightEdgeResizeTarget, am as TableRowOccurrenceTarget, an as TextMatch, T as TrackedChangeFilterMode, e as TrackedChangePredicate, V as ViewScope, ao as ZoomFitTarget, Z as ZoomMode } from '../editor-AJ06hyyg.cjs';
-export { S as SemanticPosition, a as SemanticSelection } from '../semantic-interaction-DUAnxbgf.cjs';
-export { z as DrawingHorizontalReferenceFrame, D as DrawingKind, w as DrawingLocks, v as DrawingPositionInput, A as DrawingVerticalReferenceFrame, x as ImageResourceState, u as ImageWrapTarget, P as PreservedImageMime, t as RenderableImageMime, R as RevisionAddress, y as SupportedImageMime, V as ValidatedImageBytesHandle, B as VectorImageMime } from '../tree-op-types-BUulYD5y.cjs';
-export { Block, ColorValue, ContainerRef, ContentControl, ContentControlFilter, ContentControlType, DocAnchor, DocAnchorRange, DocComment, DocLocation, DocRange, DocTarget, DocumentBody, DocxDocument, DocxDocumentJSON, ExecErrorCode, ExecResult, Extent, FontDefinition, HeaderFooterSet, IndentFormatting, InsertableContentControlType, NumberingRef, PageMargins, Paragraph, ParagraphDisagreements, ParagraphFlags, ParagraphFormatCommand, ParagraphTabStop, Point, Rect, Revision, RevisionType, Run, RunFormatting, Section, SectionProperties, SelectionPin, StyleDefinition, StyleDefinitions, Table, TableCell, TableRow, Theme, ThemeColorScheme, Unsubscribe, Watermark } from './types.cjs';
-import '../failure-BnGjoXf0.cjs';
-import '../semantic-records-BpozY7-j.cjs';
-import '../revision-projection-DXbrfNGD.cjs';
-import '../omml-equation-DB8d-jCq.cjs';

package/dist/contracts/interaction.d.cts

@@ -1,10 +0,0 @@
-export { Q as EditorScope, a0 as InteractionAffinity, a1 as InteractionOutcome, a2 as InteractionOutcomeCode, af as SemanticIdentity, ag as SemanticTarget, V as ViewScope } from '../editor-AJ06hyyg.cjs';
-import './document.cjs';
-import './types.cjs';
-import '../review-items-CaAkgi5s.cjs';
-import '../tree-op-types-BUulYD5y.cjs';
-import '../semantic-interaction-DUAnxbgf.cjs';
-import '../semantic-records-BpozY7-j.cjs';
-import '../revision-projection-DXbrfNGD.cjs';
-import '../omml-equation-DB8d-jCq.cjs';
-import '../failure-BnGjoXf0.cjs';

package/dist/contracts/modules.d.cts

@@ -1,130 +0,0 @@
-import { O as OoxmlPart } from '../tree-op-types-BUulYD5y.cjs';
-export { R as RevisionAddress } from '../tree-op-types-BUulYD5y.cjs';
-import { R as ReviewModelInput, a as ReviewItem, b as ReviewRevisionItem } from '../review-items-CaAkgi5s.cjs';
-export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, e as ReviewPosition, f as ReviewRange, g as ReviewRevisionKind } from '../review-items-CaAkgi5s.cjs';
-import { CollaborationModuleContribution } from '../collaboration.cjs';
-import { R as RevisionDisplayMode } from '../revision-projection-DXbrfNGD.cjs';
-import './types.cjs';
-import '../tree-package-fragment-Dhyw7oPm.cjs';
-import '../tree-store-DEEQ9wz_.cjs';
-import '../collaboration/replication.cjs';
-import '../failure-BnGjoXf0.cjs';
-
-/**
- * `@docx-editor.dev/core/contracts/modules` — the `EditorModule` seam.
- *
- * How a paid or optional capability contributes to the engine without the free tier importing
- * it: the review module and custom nodes both arrive through here, and their absence leaves the
- * corresponding chrome disabled with the engine's own reason.
- *
- * NOT a plugin system. The shape is closed: every contribution point is named
- * here, core iterates registered modules at its existing dispatch points, and
- * core never imports a capability package. A capability absent from this file
- * is not extendable from outside — deliberately, so the one-pipeline principle
- * survives the packaging boundary.
- * The free engine behaves identically with an empty registry: documents
- * round-trip losslessly, revisions render in their final-state projection, and
- * the review chrome slots stay disabled with the engine's own reason.
- *
- * @packageDocumentation
- * @public
- */
-
-/**
- * Derives the review queue — every pending revision decision and comment
- * thread — from one story part plus its comment parts. Implemented by the pro
- * review module; the free engine has no implementation and reports an empty
- * queue.
- *
- * @public
- */
-type CollectReviewItems = (input: ReviewModelInput) => readonly ReviewItem[];
-/**
- * What a review module contributes: the queue derivation, and the revision
- * display modes the editor may enter beyond the free tier's final-state
- * projection.
- *
- * @public
- */
-interface ReviewModuleContribution {
-    /**
-     * Display modes this module unlocks (the free engine renders `proposed` only).
-     *
-     * Currently DECLARATIVE: any registered review module restores the layout
-     * default (`all-markup`), and no runtime mode switch exists yet. The list is
-     * carried so the future `setRevisionDisplayMode` command can validate against
-     * it without a breaking module-shape change.
-     */
-    readonly displayModes: readonly RevisionDisplayMode[];
-    /** The review queue derivation. */
-    readonly collectReviewItems: CollectReviewItems;
-    /**
-     * Revisions wholly inside one paragraph — for the conservative local review
-     * patch after a text-local body edit.
-     */
-    readonly revisionItemsOfParagraph: (part: OoxmlPart, paragraphId: string) => readonly ReviewRevisionItem[];
-}
-
-/**
- * One registered capability module. Registration is construction-time
- * (`createDocxEditor({ modules })`) and immutable for the instance's lifetime.
- *
- * @public
- */
-interface EditorModule {
-    /** Diagnostic identity (`'review'`, `'custom-nodes'`); not a dispatch key. */
-    readonly id: string;
-    /** Review capability: queue derivation, commands gate, display modes. */
-    readonly review?: ReviewModuleContribution;
-    /**
-     * Collaboration replica. Absent, the editor stays single-user: local undo
-     * stays the authority, and `snapshot().collaborationStatus` is `'inactive'`.
-     */
-    readonly collaboration?: CollaborationModuleContribution;
-    /**
-     * Custom inline node definitions. Reserved: the definition shape lands with
-     * the custom-nodes lane; the registry carries them opaquely until then.
-     */
-    readonly customNodes?: readonly unknown[];
-    /**
-     * customXml payload namespaces this module OWNS, swept for orphans when a document opens.
-     *
-     * A payload lives in a customXml data part, and Word will not delete one when a user deletes
-     * the control bound to it — nothing in OOXML asks it to. So a document can arrive holding
-     * payloads for chips that no longer exist, and reconciling against what the story actually
-     * binds is the only thing that collects them.
-     *
-     * The claim is what keeps the sweep off other people's stores: Word's own Cover Page
-     * Properties store rides in most templates, and a sweep that walked every customXml part
-     * would be deleting from it on the strength of a name collision. A namespace no module names
-     * is never touched.
-     */
-    readonly customNodePayloadNamespaces?: readonly string[];
-    /**
-     * Told when the recognition pass finds something wrong with a node in THIS editor's document.
-     *
-     * Carried per module rather than kept by the capability package, so two editors on one page
-     * hear only their own documents and a detached editor's listener goes with it. The shape is
-     * opaque here for the same reason `customNodes` is: what a diagnostic means belongs to the
-     * package that raised it.
-     */
-    readonly onCustomNodeDiagnostic?: (diagnostic: unknown) => void;
-}
-/**
- * The resolved registry the editor instance holds: at most one review
- * contribution and at most one collaboration contribution (first registration
- * wins for each), all custom node definitions in registration order.
- */
-interface EditorModuleRegistry {
-    readonly review: ReviewModuleContribution | null;
-    readonly collaboration: CollaborationModuleContribution | null;
-    readonly customNodes: readonly unknown[];
-    /** Every claimed payload namespace, deduplicated, in registration order. */
-    readonly customNodePayloadNamespaces: readonly string[];
-    /** Every registered diagnostic listener, in registration order. */
-    readonly customNodeDiagnostics: readonly ((diagnostic: unknown) => void)[];
-}
-/** Resolve construction-time modules into the registry the instance dispatches over. */
-declare function resolveEditorModules(modules: readonly EditorModule[] | undefined): EditorModuleRegistry;
-
-export { CollaborationModuleContribution, type CollectReviewItems, type EditorModule, type EditorModuleRegistry, OoxmlPart, ReviewItem, ReviewModelInput, type ReviewModuleContribution, ReviewRevisionItem, RevisionDisplayMode, resolveEditorModules };