ooxml-core 1.20.0 → 1.22.0

package/dist/docx/ui/content-control-spans.d.ts

@@ -1,19 +1,42 @@
 import type { Mark, Node as ProseMirrorNode } from 'prosemirror-model';
 import type { EditorState } from 'prosemirror-state';
 import type { ContentControl } from '../content-control-model.js';
+import { type RowControlSpan } from './content-control-rows.js';
 /** A control and the document range it covers. */
 export interface ControlSpan {
     control: ContentControl;
-    level: 'inline' | 'block';
-    /** Inline: the first text position. Block: the position before the first paragraph. */
+    level: 'inline' | 'block' | 'cell';
+    /** Inline: the first text position. Block or cell: the position before its first node. */
     from: number;
-    /** Inline: after the last character. Block: after the last paragraph. */
+    /** Inline: after the last character. Block or cell: after its last node. */
     to: number;
 }
-export declare function controlOfMark(mark: Mark | undefined): ContentControl | undefined;
-/** Every inline and block control in document order. */
+/**
+ * The control `data` (a `data-sdt` attribute, or an inline control's mark) holds, at `level`. HTML
+ * pasted from another page and remote peers can put anything there: only an object with an id and
+ * a kind, nested no deeper than a control's fields, is a control.
+ */
+export declare function controlFromData(data: unknown, level: ContentControl['level']): ContentControl | undefined;
+/**
+ * The control `value` is at `level`: itself when it is an object with an id and a kind at that
+ * level, holding values of the kinds its fields hold; a copy at that level, or without the values
+ * of other kinds, otherwise; nothing when it is not a control or nests deeper than one does.
+ */
+export declare function controlFromValue(value: unknown, level: ContentControl['level']): ContentControl | undefined;
+export declare const controlOfMark: (mark: Mark | undefined) => ContentControl | undefined;
+/** Every inline, block and cell control in document order. */
 export declare function controlSpans(doc: ProseMirrorNode): ControlSpan[];
-/** The innermost control around `pos` (an inline control wins over the block one around it). */
+/** The tables held by a block control, in document order. */
+export declare function tableControlSpans(doc: ProseMirrorNode): ControlSpan[];
+/**
+ * Every control in `doc`: those `controlSpans` lists, and those around tables and rows, which no
+ * command operates but whose ids and locks count.
+ */
+export declare const everyControlSpan: (doc: ProseMirrorNode) => (ControlSpan | RowControlSpan)[];
+/**
+ * The innermost control around `pos`. An inline control wins over the block or cell around it,
+ * and with `edges` also when `pos` is at its start or end.
+ */
 export declare function controlAt(spans: readonly ControlSpan[], pos: number, edges?: boolean): ControlSpan | undefined;
 export declare const controlAtSelection: (state: EditorState, edges?: boolean) => ControlSpan | undefined;
 //# sourceMappingURL=content-control-spans.d.ts.map

package/dist/docx/ui/content-control-spans.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"content-control-spans.d.ts","sourceRoot":"","sources":["../../../docx/ui/content-control-spans.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC3B,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC1B,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,EAAE,EAAE,MAAM,CAAC;CACX;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAOhF;AAKD,wDAAwD;AACxD,wBAAgB,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,WAAW,EAAE,CAqBhE;AAED,gGAAgG;AAChG,wBAAgB,SAAS,CACxB,KAAK,EAAE,SAAS,WAAW,EAAE,EAC7B,GAAG,EAAE,MAAM,EACX,KAAK,UAAQ,GACX,WAAW,GAAG,SAAS,CAKzB;AAED,eAAO,MAAM,kBAAkB,UAAW,WAAW,sBAAiB,WAAW,GAAG,SACpB,CAAC"}
+{"version":3,"file":"content-control-spans.d.ts","sourceRoot":"","sources":["../../../docx/ui/content-control-spans.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACX,cAAc,EAGd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE9E,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC3B,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IACnC,0FAA0F;IAC1F,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC9B,IAAI,EAAE,OAAO,EACb,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,GAC5B,cAAc,GAAG,SAAS,CAS5B;AA2FD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC/B,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,GAC5B,cAAc,GAAG,SAAS,CAO5B;AAED,eAAO,MAAM,aAAa,SAAU,IAAI,GAAG,SAAS,KAAG,cAAc,GAAG,SAC5B,CAAC;AAK7C,8DAA8D;AAC9D,wBAAgB,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,WAAW,EAAE,CAgChE;AAED,6DAA6D;AAC7D,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,eAAe,GAAG,WAAW,EAAE,CAcrE;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,QAAS,eAAe,KAAG,CAAC,WAAW,GAAG,cAAc,CAAC,EAIrF,CAAC;AAEF;;;GAGG;AACH,wBAAgB,SAAS,CACxB,KAAK,EAAE,SAAS,WAAW,EAAE,EAC7B,GAAG,EAAE,MAAM,EACX,KAAK,UAAQ,GACX,WAAW,GAAG,SAAS,CAczB;AAED,eAAO,MAAM,kBAAkB,UAAW,WAAW,sBAAiB,WAAW,GAAG,SACpB,CAAC"}

package/dist/docx/ui/content-control-temporary.d.ts

@@ -0,0 +1,10 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+import { type RowControlSpan } from './content-control-rows.js';
+import { type ControlSpan } from './content-control-spans.js';
+type Span = ControlSpan | RowControlSpan;
+/** Takes the control of `span` off its text, paragraphs, table, cell or row; its content stays. */
+export declare function removeControl(tr: Transaction, span: Span): Transaction;
+/** The transaction removing every temporary control whose content `transactions` changed. */
+export declare function removeEditedTemporaryControls(transactions: readonly Transaction[], before: EditorState, after: EditorState): Transaction | null;
+export {};
+//# sourceMappingURL=content-control-temporary.d.ts.map

package/dist/docx/ui/content-control-temporary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-control-temporary.d.ts","sourceRoot":"","sources":["../../../docx/ui/content-control-temporary.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIlE,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAIN,KAAK,WAAW,EAChB,MAAM,yBAAyB,CAAC;AAGjC,KAAK,IAAI,GAAG,WAAW,GAAG,cAAc,CAAC;AAazC,mGAAmG;AACnG,wBAAgB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CA4BtE;AAuED,6FAA6F;AAC7F,wBAAgB,6BAA6B,CAC5C,YAAY,EAAE,SAAS,WAAW,EAAE,EACpC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,WAAW,GAChB,WAAW,GAAG,IAAI,CAmDpB"}

package/dist/docx/ui/form-field-commands.d.ts

@@ -0,0 +1,41 @@
+import type { Node } from 'prosemirror-model';
+import type { EditorState, Transaction } from 'prosemirror-state';
+import type { AttrStep } from 'prosemirror-transform';
+import type { FormField } from '../model.js';
+/** Marks a transaction made by operating a form field, which form protection lets through. */
+export declare const FORM_FIELD_EDIT_META = "dve-form-field-edit";
+/** The form field on a begin marker node, if it is one. */
+export declare function formFieldOfNode(node: Node | null | undefined): FormField | undefined;
+/**
+ * Whether `step` gives the begin marker of an enabled form field other field data and nothing
+ * else, as operating the field does (an undo or redo of that too): the field stays the same kind
+ * and name, and its formatting stays as it was.
+ */
+export declare function operatesFormField(step: AttrStep, doc: Node | undefined): boolean;
+/** What a begin marker node draws for its field: a ballot box, a drop-down's entry, or nothing. */
+export declare function formFieldNodeDisplay(node: Node): string | undefined;
+/** Whether a content control around the field at `pos` locks its content, so it cannot change. */
+export declare function formFieldLocked(state: EditorState, pos: number): boolean;
+/** Toggles the check box form field whose begin marker is at `pos`. */
+export declare function toggleFormCheckboxAt(state: EditorState, pos: number): Transaction | undefined;
+/** Selects entry `index` of the drop-down form field whose begin marker is at `pos`. */
+export declare function selectFormDropDownAt(state: EditorState, pos: number, index: number): Transaction | undefined;
+/**
+ * The begin marker of the check box or drop-down form field beside `pos`, for operating it from
+ * the keyboard: `pos` is in front of the field, among its hidden markers or just after it. A field
+ * that starts at `pos` wins over one that ends there.
+ */
+export declare function formFieldBeside(doc: Node, pos: number): number | undefined;
+/** A text form field's result in the editor document: where it is and the field it belongs to. */
+export interface FormTextResult {
+    field: FormField;
+    /** Document position of the field's begin marker. */
+    begin: number;
+    /** Document positions around the result text (equal when the result is empty). */
+    from: number;
+    to: number;
+    length: number;
+}
+/** Every text form field's result range, in document order. */
+export declare function formTextResults(doc: Node): FormTextResult[];
+//# sourceMappingURL=form-field-commands.d.ts.map

package/dist/docx/ui/form-field-commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-field-commands.d.ts","sourceRoot":"","sources":["../../../docx/ui/form-field-commands.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAW,MAAM,UAAU,CAAC;AAUnD,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,wBAAwB,CAAC;AAE1D,2DAA2D;AAC3D,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAGpF;AAaD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,GAAG,SAAS,GAAG,OAAO,CAShF;AAED,mGAAmG;AACnG,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAKnE;AAUD,kGAAkG;AAClG,wBAAgB,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAMxE;AAQD,uEAAuE;AACvE,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAI7F;AAED,wFAAwF;AACxF,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GACX,WAAW,GAAG,SAAS,CAOzB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAsB1E;AAED,kGAAkG;AAClG,MAAM,WAAW,cAAc;IAC9B,KAAK,EAAE,SAAS,CAAC;IACjB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;CACf;AAED,+DAA+D;AAC/D,wBAAgB,eAAe,CAAC,GAAG,EAAE,IAAI,GAAG,cAAc,EAAE,CAiC3D"}

package/dist/docx/ui/form-field-guard.d.ts

@@ -0,0 +1,24 @@
+import { Plugin, type Transaction } from 'prosemirror-state';
+import type { DocumentProtection } from '../model.js';
+/**
+ * Whether the document is protected for filling in forms: only its form fields, content controls
+ * and unprotected sections can change, and its headers, footers and notes not at all.
+ */
+export declare const isFormsProtected: (protection: DocumentProtection | undefined) => boolean;
+/**
+ * Whether the transaction makes a text field's result longer than its maximum length. Word's blank
+ * result (en spaces only) counts as empty, and so do the en spaces of a blank that text is typed
+ * into, which the guard then removes.
+ */
+export declare function exceedsFormTextLength(tr: Transaction): boolean;
+/**
+ * Whether every step of a transaction stays inside a form field, a content control or a section
+ * the protection leaves editable.
+ */
+export declare function staysInFormFields(tr: Transaction): boolean;
+/**
+ * Rejects local edits that a field's maximum length or the document's protection forbids, and
+ * removes the en spaces of a blank text field that text was typed into.
+ */
+export declare function formFieldGuardPlugin(protection: () => DocumentProtection | undefined): Plugin;
+//# sourceMappingURL=form-field-guard.d.ts.map

package/dist/docx/ui/form-field-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-field-guard.d.ts","sourceRoot":"","sources":["../../../docx/ui/form-field-guard.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAa,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAUxE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAenD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,eAAgB,kBAAkB,GAAG,SAAS,KAAG,OAChB,CAAC;AAE/D;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAkB9D;AAsFD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAuE1D;AAiCD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,kBAAkB,GAAG,SAAS,GAAG,MAAM,CAsC7F"}

package/dist/docx/ui/form-text-blank.d.ts

@@ -0,0 +1,18 @@
+import type { Node } from 'prosemirror-model';
+import type { Mappable } from 'prosemirror-transform';
+import type { FormTextResult } from './form-field-commands.js';
+type Range = {
+    from: number;
+    to: number;
+};
+/** Whether a text field's result is Word's blank: en spaces only. */
+export declare function isBlankFormText(doc: Node, result: FormTextResult): boolean;
+/**
+ * The en spaces of blank results that an edit typed other text into, where they are after the
+ * edit, one range per character: they go, and the text typed stays. `before` and `after` are the
+ * documents before and after the edit, each with its text field results, and `mapping` maps the
+ * one to the other.
+ */
+export declare function replacedBlanks(before: Node, beforeResults: readonly FormTextResult[], after: Node, afterResults: readonly FormTextResult[], mapping: Mappable): Range[];
+export {};
+//# sourceMappingURL=form-text-blank.d.ts.map

package/dist/docx/ui/form-text-blank.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-text-blank.d.ts","sourceRoot":"","sources":["../../../docx/ui/form-text-blank.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAI5D,KAAK,KAAK,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,qEAAqE;AACrE,wBAAgB,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAI1E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,IAAI,EACZ,aAAa,EAAE,SAAS,cAAc,EAAE,EACxC,KAAK,EAAE,IAAI,EACX,YAAY,EAAE,SAAS,cAAc,EAAE,EACvC,OAAO,EAAE,QAAQ,GACf,KAAK,EAAE,CAiBT"}