ooxml-core 1.20.0 → 1.22.0

package/dist/docx/field-instruction.d.ts

@@ -0,0 +1,22 @@
+/** One word of a field instruction: text (an argument, unquoted) or a switch (`l` for `\l`). */
+export interface FieldToken {
+    kind: 'text' | 'switch';
+    value: string;
+}
+/**
+ * Splits an instruction into its field type, arguments and switches. A quoted argument keeps its
+ * spaces, and `\"` or `\\` inside quotes stand for the character itself. A switch is a backslash
+ * followed by `*`, `#`, `@`, `!` or one or two letters; its letters are lower-cased.
+ */
+export declare function fieldTokens(instr: string): FieldToken[];
+/** The text case a `\*` switch asks for. */
+export type FieldTextCase = 'upper' | 'lower' | 'firstcap' | 'caps';
+/** Whether a `\*` switch's argument (any case) is one of the text case formats. */
+export declare const isFieldTextCase: (format: string) => format is FieldTextCase;
+/**
+ * Applies a text case format to a field result: `Upper` and `Lower` change every letter,
+ * `FirstCap` capitalizes the first letter of the first word and `Caps` that of every word. The
+ * other letters are left as they are, as the standard words it.
+ */
+export declare function applyFieldTextCase(text: string, format: FieldTextCase): string;
+//# sourceMappingURL=field-instruction.d.ts.map

package/dist/docx/field-instruction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-instruction.d.ts","sourceRoot":"","sources":["../../docx/field-instruction.ts"],"names":[],"mappings":"AAIA,gGAAgG;AAChG,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,EAAE,CA+BvD;AAED,4CAA4C;AAC5C,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;AAIpE,mFAAmF;AACnF,eAAO,MAAM,eAAe,WAAY,MAAM,KAAG,MAAM,IAAI,aACtB,CAAC;AAEtC;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,MAAM,CAc9E"}

package/dist/docx/form-field-model.d.ts

@@ -0,0 +1,48 @@
+import type { StDocProtect, StFFTextType, StInfoTextType } from './generated/wml-simple-types.js';
+/** Help or status-bar text: the text itself, or the name of an AutoText entry holding it. */
+export interface FormFieldInfoText {
+    type: StInfoTextType;
+    value: string;
+}
+export interface FormField {
+    /** FORMTEXT, FORMCHECKBOX or FORMDROPDOWN. */
+    kind: 'text' | 'checkbox' | 'dropDown';
+    /** `w:name`, also the bookmark Word puts around the field. Word leaves it empty or repeats it at times. */
+    name?: string;
+    /** `w:enabled`; false when "Fill-in enabled" is off. Unset when the element is absent. */
+    enabled?: boolean;
+    /** `w:calcOnExit`: update the document's fields when the user leaves this one. */
+    calcOnExit?: boolean;
+    helpText?: FormFieldInfoText;
+    statusText?: FormFieldInfoText;
+    /** `w:textInput`: what a text field accepts and its default text. */
+    textInput?: {
+        type?: StFFTextType;
+        default?: string;
+        maxLength?: number;
+        format?: string;
+    };
+    /** `w:checkBox`: `checked` unset means the box shows its default state. Size is in half-points. */
+    checkBox?: {
+        default: boolean;
+        checked?: boolean;
+        sizeAuto?: boolean;
+        size?: number;
+    };
+    /** `w:ddList`: the entries, and the index of the selected (`result`) and default entries. */
+    dropDown?: {
+        entries: string[];
+        result?: number;
+        default?: number;
+    };
+    /** Verbatim `w:ffData`, used to keep what is not modeled when the field is written back. */
+    sourceXml?: string;
+}
+/** `w:documentProtection` in settings.xml: what the document lets a user change. */
+export interface DocumentProtection {
+    /** `w:edit`: `forms` allows filling form fields and content controls only. */
+    edit: StDocProtect;
+    /** `w:enforcement`: whether the protection applies; Word enforces it unless it is off. */
+    enforced: boolean;
+}
+//# sourceMappingURL=form-field-model.d.ts.map

package/dist/docx/form-field-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-field-model.d.ts","sourceRoot":"","sources":["../../docx/form-field-model.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE/F,6FAA6F;AAC7F,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACzB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;IACvC,2GAA2G;IAC3G,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0FAA0F;IAC1F,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kFAAkF;IAClF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,qEAAqE;IACrE,SAAS,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,YAAY,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3F,mGAAmG;IACnG,QAAQ,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF,6FAA6F;IAC7F,QAAQ,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpE,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,oFAAoF;AACpF,MAAM,WAAW,kBAAkB;IAClC,8EAA8E;IAC9E,IAAI,EAAE,YAAY,CAAC;IACnB,0FAA0F;IAC1F,QAAQ,EAAE,OAAO,CAAC;CAClB"}

package/dist/docx/form-fields.d.ts

@@ -0,0 +1,31 @@
+import type { FormField } from './form-field-model.js';
+import type { TextRun } from './model.js';
+import { type XmlDocument, type XmlElement } from './xml.js';
+/** The form field `w:ffData` describes, or undefined when it holds no text, check box or list. */
+export declare function parseFormField(ffData: XmlElement): FormField | undefined;
+/** Whether a `w:fldChar` child is form field data this model reads and writes back. */
+export declare const isModeledFormFieldData: (element: XmlElement) => boolean;
+/**
+ * The `w:ffData` for `field`: `source` (the field's own element from the file, when it is at
+ * hand) or its verbatim XML, with what the model changed written over it.
+ */
+export declare function writeFormFieldData(doc: XmlDocument, field: FormField, source?: XmlElement): XmlElement;
+/** Whether a check box form field shows as checked: its own state, else its default. */
+export declare const formCheckboxChecked: (field: FormField) => boolean;
+/** The entry a drop-down form field shows: the selected one, else the default, else the first. */
+export declare function formDropDownIndex(field: FormField): number | undefined;
+/**
+ * What a check box or drop-down form field's begin marker shows, since neither has result text:
+ * a ballot box, or the shown entry. Undefined for other runs, including text fields.
+ */
+export declare function formFieldDisplayText(run: TextRun): string | undefined;
+/** The check box with `checked` as its state. */
+export declare function setFormCheckbox(field: FormField, checked: boolean): FormField;
+/** The drop-down with entry `index` selected, or undefined when there is no such entry. */
+export declare function selectFormDropDownEntry(field: FormField, index: number): FormField | undefined;
+/**
+ * The form field a run belongs to: the begin marker's own field, or the field whose begin marker
+ * opens the innermost complex field around run `index`.
+ */
+export declare function formFieldOfRun(runs: readonly TextRun[], index: number): FormField | undefined;
+//# sourceMappingURL=form-fields.d.ts.map

package/dist/docx/form-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fields.d.ts","sourceRoot":"","sources":["../../docx/form-fields.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAqB,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EASN,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,MAAM,OAAO,CAAC;AAgBf,kGAAkG;AAClG,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAkDxE;AAED,uFAAuF;AACvF,eAAO,MAAM,sBAAsB,YAAa,UAAU,KAAG,OACK,CAAC;AAwDnE;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,SAAS,EAChB,MAAM,CAAC,EAAE,UAAU,GACjB,UAAU,CA2BZ;AAED,wFAAwF;AACxF,eAAO,MAAM,mBAAmB,UAAW,SAAS,KAAG,OACK,CAAC;AAE7D,kGAAkG;AAClG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAKtE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAQrE;AAED,iDAAiD;AACjD,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,CAE7E;AAED,2FAA2F;AAC3F,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAK9F;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAU7F"}

package/dist/docx/form-fill-fields.d.ts

@@ -0,0 +1,61 @@
+import { type FieldSite, type FormFieldStory } from './form-fill-sites.js';
+import type { DocumentModel } from './model.js';
+export type FormFieldType = 'text' | 'date' | 'number' | 'checkbox' | 'dropdown';
+export type { FormFieldStory } from './form-fill-sites.js';
+/** A drop-down or combo box entry: the text it shows and the value it stands for. */
+export interface FormFieldChoice {
+    display: string;
+    value: string;
+}
+export interface FormFieldInfo {
+    /**
+     * Stable for the same file: `field:<name>` for a legacy field whose name no other field has,
+     * `control:<id>` or `tag:<tag>` for a content control, else `field#<n>` or `control#<n>`,
+     * the field's place among the legacy fields or the controls in reading order.
+     */
+    id: string;
+    /** `legacy` for a Word 97 form field (`w:ffData`), `control` for a content control (`w:sdt`). */
+    source: 'legacy' | 'control';
+    type: FormFieldType;
+    /** The label read from the layout, numbered when several fields have it. */
+    label: string;
+    /** What `label` was built from, the most general first (a row's label, then the field's own). */
+    labelParts: string[];
+    /** The text it holds, or whether a check box is checked; empty while it shows a placeholder. */
+    value: string | boolean;
+    /** A legacy text field's default text, or a legacy check box's default state. */
+    defaultValue?: string | boolean;
+    /** What an empty control shows. */
+    placeholder?: string;
+    /** A drop-down's or combo box's entries. */
+    choices?: FormFieldChoice[];
+    /** A combo box also takes text that is none of its entries. */
+    allowsOtherText?: boolean;
+    maxLength?: number;
+    /** A date picture (`dd-MMM-yyyy`), a number picture (`#,##0.00`) or a text case (`UPPERCASE`). */
+    format?: string;
+    /** A date control's language (`en-US`). */
+    locale?: string;
+    /** Whether the text may hold line breaks. */
+    multiLine?: boolean;
+    /** A legacy field's `w:name`, as written (several fields can share one). */
+    name?: string;
+    /** A control's title (`w:alias`) and tag (`w:tag`). */
+    alias?: string;
+    tag?: string;
+    /** A legacy field's help text. */
+    help?: string;
+    story: FormFieldStory;
+    /** Whether `fillFormFields` sets it; when not, `reason` says why. */
+    fillable: boolean;
+    reason?: 'disabled' | 'calculated' | 'locked' | 'bound' | 'nested table';
+}
+/** The text a site's content shows: a legacy field's result, a control's runs or paragraphs. */
+export declare function siteText(site: FieldSite): string;
+/** The id of each site, from its name, control id or tag when no other field shares it. */
+export declare function siteIds(sites: readonly FieldSite[]): string[];
+/** Each site described, with its id and label. */
+export declare function describeSites(sites: readonly FieldSite[]): FormFieldInfo[];
+/** The fill-in fields of a document in reading order: the body, then headers and footers. */
+export declare const listFormFields: (model: DocumentModel) => FormFieldInfo[];
+//# sourceMappingURL=form-fill-fields.d.ts.map

package/dist/docx/form-fill-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fill-fields.d.ts","sourceRoot":"","sources":["../../docx/form-fill-fields.ts"],"names":[],"mappings":"AAQA,OAAO,EAIN,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,aAAa,EAAsB,MAAM,SAAS,CAAC;AAEjE,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AACjF,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,qFAAqF;AACrF,MAAM,WAAW,eAAe;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,iGAAiG;IACjG,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,iGAAiG;IACjG,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,gGAAgG;IAChG,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,+DAA+D;IAC/D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kGAAkG;IAClG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4EAA4E;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,cAAc,CAAC;IACtB,qEAAqE;IACrE,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,cAAc,CAAC;CACzE;AAgBD,gGAAgG;AAChG,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAchD;AA4GD,2FAA2F;AAC3F,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,MAAM,EAAE,CAyB7D;AAED,kDAAkD;AAClD,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,aAAa,EAAE,CAmB1E;AAED,6FAA6F;AAC7F,eAAO,MAAM,cAAc,UAAW,aAAa,KAAG,aAAa,EAC9B,CAAC"}

package/dist/docx/form-fill-labels.d.ts

@@ -0,0 +1,8 @@
+import { type FieldSite } from './form-fill-sites.js';
+/** Text as a label: one line, single spaces, without a trailing colon. */
+export declare const labelText: (text: string) => string;
+/** The label parts of one field, most general first; empty when the layout gives none. */
+export declare function labelParts(site: FieldSite, siblings: readonly FieldSite[]): string[];
+/** The labels joined, with an ordinal added to every label that more than one field has. */
+export declare function numberedLabels(labels: readonly string[]): string[];
+//# sourceMappingURL=form-fill-labels.d.ts.map

package/dist/docx/form-fill-labels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fill-labels.d.ts","sourceRoot":"","sources":["../../docx/form-fill-labels.ts"],"names":[],"mappings":"AAKA,OAAO,EAIN,KAAK,SAAS,EAEd,MAAM,mBAAmB,CAAC;AAG3B,0EAA0E;AAC1E,eAAO,MAAM,SAAS,SAAU,MAAM,KAAG,MAGxC,CAAC;AAgGF,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,SAAS,EAAE,GAAG,MAAM,EAAE,CAgBpF;AAED,4FAA4F;AAC5F,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAUlE"}

package/dist/docx/form-fill-sites.d.ts

@@ -0,0 +1,59 @@
+import type { ContentControl } from './content-control-model.js';
+import type { FormField } from './form-field-model.js';
+import type { Block, DocumentModel, Paragraph, Table, TableCell, TextRun } from './model.js';
+/** The story a field is in. */
+export type FormFieldStory = 'body' | 'header' | 'footer';
+/**
+ * The text a run of a paragraph shows, as a person reads the form: none for hidden text, set on
+ * the run or through its paragraph or character style, or for text a revision deletes or moves.
+ */
+export type ShownText = (run: TextRun, paragraph: Paragraph) => string;
+/** A cell's place in its table: its row, its index in the row and the grid columns it covers. */
+export interface CellPlace {
+    table: Table;
+    row: number;
+    cell: number;
+    column: number;
+    span: number;
+    /** The cell's paragraph holding the field. */
+    paragraph: number;
+}
+/** A fill-in field found in the model, with references into it for reading and writing. */
+export interface FieldSite {
+    /** A legacy field, a control around runs, a control around a cell, or one around paragraphs. */
+    kind: 'legacy' | 'inline' | 'cell' | 'block';
+    story: FormFieldStory;
+    /** The story's blocks, and the index of the block holding the field (or its first block). */
+    blocks: Block[];
+    block: number;
+    /** The paragraph holding a legacy field or an inline control; a cell or block control's first. */
+    paragraph: Paragraph;
+    /** A legacy field's runs from its begin to its end marker; an inline control's runs. */
+    from: number;
+    to: number;
+    /** Set when the field is in a table cell, or is a control around one. */
+    place?: CellPlace;
+    /** A block control's paragraphs, as indexes into `blocks`. */
+    paragraphs?: number[];
+    formField?: FormField;
+    control?: ContentControl;
+    /** The field is in a table nested in a cell, which this library keeps but does not edit. */
+    nested?: boolean;
+    /** The text the runs of its document show, for its value and the labels around it. */
+    shown: ShownText;
+}
+export declare const isFilledControl: (control: ContentControl | undefined) => control is ContentControl;
+/** The index of the marker that ends the complex field begun at `begin`. */
+export declare function fieldEnd(runs: readonly TextRun[], begin: number): number | undefined;
+/** Whether a paragraph holds a fill-in field of its own. */
+export declare const holdsField: (paragraph: Paragraph) => boolean;
+/** Every fill-in field of the document: the body, then each header and footer part once. */
+export declare function formFieldSites(model: DocumentModel): FieldSite[];
+/** The runs between a legacy field's `separate` and `end` markers: its result. */
+export declare function legacyResult(site: FieldSite): {
+    from: number;
+    to: number;
+} | undefined;
+/** The cell a site is in. */
+export declare const siteCell: (site: FieldSite) => TableCell | undefined;
+//# sourceMappingURL=form-fill-sites.d.ts.map

package/dist/docx/form-fill-sites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fill-sites.d.ts","sourceRoot":"","sources":["../../docx/form-fill-sites.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAsB,MAAM,yBAAyB,CAAC;AAClF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1F,+BAA+B;AAC/B,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,KAAK,MAAM,CAAC;AAcvE,iGAAiG;AACjG,MAAM,WAAW,SAAS;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,2FAA2F;AAC3F,MAAM,WAAW,SAAS;IACzB,gGAAgG;IAChG,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;IAC7C,KAAK,EAAE,cAAc,CAAC;IACtB,6FAA6F;IAC7F,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,kGAAkG;IAClG,SAAS,EAAE,SAAS,CAAC;IACrB,wFAAwF;IACxF,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,yEAAyE;IACzE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,4FAA4F;IAC5F,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sFAAsF;IACtF,KAAK,EAAE,SAAS,CAAC;CACjB;AAYD,eAAO,MAAM,eAAe,YAAa,cAAc,GAAG,SAAS,KAAG,OAAO,IAAI,cACpC,CAAC;AAE9C,4EAA4E;AAC5E,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOpF;AAoCD,4DAA4D;AAC5D,eAAO,MAAM,UAAU,cAAe,SAAS,KAAG,OAE8C,CAAC;AAgFjG,4FAA4F;AAC5F,wBAAgB,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAAE,CAehE;AAED,kFAAkF;AAClF,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAWtF;AAED,6BAA6B;AAC7B,eAAO,MAAM,QAAQ,SAAU,SAAS,KAAG,SAAS,GAAG,SACgB,CAAC"}

package/dist/docx/form-fill-values.d.ts

@@ -0,0 +1,28 @@
+import type { FormFieldChoice, FormFieldInfo } from './form-fill-fields.js';
+/** What a host can give a field: text, a check box state, or a number. */
+export type FormFieldValue = string | boolean | number;
+/** A value made ready for a field, or the reason it cannot go in. */
+export type PreparedValue = {
+    text: string;
+    date?: Date;
+} | {
+    checked: boolean;
+} | {
+    choice: number;
+} | {
+    clear: true;
+} | {
+    reason: string;
+};
+/** A calendar day given as `YYYY-MM-DD` (a time after it is ignored). */
+export declare function parseDay(value: string): Date | undefined;
+/**
+ * A number written with a Word number picture (`0`, `0.00`, `#,##0.00`, `0%`, with text around
+ * it, and a second `;` section for negative numbers). Undefined for a picture it cannot read.
+ */
+export declare function formatNumber(value: number, picture: string): string | undefined;
+/** The entry a value names: by its text or value, then the same ignoring case when only one does. */
+export declare function choiceIndex(choices: readonly FormFieldChoice[], value: string): number | undefined;
+/** Checks `value` for `field` and turns it into what the field will hold. */
+export declare const prepareValue: (field: FormFieldInfo, value: FormFieldValue) => PreparedValue;
+//# sourceMappingURL=form-fill-values.d.ts.map

package/dist/docx/form-fill-values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fill-values.d.ts","sourceRoot":"","sources":["../../docx/form-fill-values.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEzE,0EAA0E;AAC1E,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEvD,qEAAqE;AACrE,MAAM,MAAM,aAAa,GACtB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GAC7B;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GACpB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GACf;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtB,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAQxD;AAID;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAe/E;AAUD,qGAAqG;AACrG,wBAAgB,WAAW,CAC1B,OAAO,EAAE,SAAS,eAAe,EAAE,EACnC,KAAK,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAWpB;AAYD,6EAA6E;AAC7E,eAAO,MAAM,YAAY,UAAW,aAAa,SAAS,cAAc,KAAG,aACxC,CAAC"}

package/dist/docx/form-fill-write.d.ts

@@ -0,0 +1,26 @@
+import { type FormFieldValue } from './form-fill-values.js';
+import type { DocumentModel } from './model.js';
+/** What happened to one value. */
+export interface FormFillResult {
+    id: string;
+    /** Whether the field holds the value now (also when it held it already). */
+    ok: boolean;
+    /** Why the value was not set. */
+    reason?: string;
+    /** What the field shows now: the text written (a formatted date or number) or the state. */
+    value?: string | boolean;
+}
+export interface FormFillOptions {
+    /** Bring body STYLEREF results up to date as Update Fields does (default true). */
+    updateStyleRefs?: boolean;
+}
+/**
+ * Sets fields by id (as `listFormFields` gives them) and returns the filled model, which
+ * `loadDocx(...).save(model)` writes back over the source package. `model` itself is not
+ * changed. A value that does not fit its field is not set, and its result says why.
+ */
+export declare function fillFormFields(model: DocumentModel, values: Readonly<Record<string, FormFieldValue>>, options?: FormFillOptions): {
+    model: DocumentModel;
+    results: FormFillResult[];
+};
+//# sourceMappingURL=form-fill-write.d.ts.map

package/dist/docx/form-fill-write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-fill-write.d.ts","sourceRoot":"","sources":["../../docx/form-fill-write.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAgB,KAAK,cAAc,EAAsB,MAAM,oBAAoB,CAAC;AAC3F,OAAO,KAAK,EAAE,aAAa,EAAsB,MAAM,SAAS,CAAC;AAGjE,kCAAkC;AAClC,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,4EAA4E;IAC5E,EAAE,EAAE,OAAO,CAAC;IACZ,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC/B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAoLD;;;;GAIG;AACH,wBAAgB,cAAc,CAC7B,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,EAChD,OAAO,GAAE,eAAoB,GAC3B;IAAE,KAAK,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAoDrD"}

package/dist/docx/glossary.d.ts

@@ -0,0 +1,15 @@
+import type JSZip from 'jszip';
+import type { ContentControl } from './content-control-model.js';
+import type { Block, DocumentModel } from './model.js';
+import { type Relationship } from './package-parts.js';
+/** Each glossary entry's text by entry name: the first paragraph of its body. */
+export declare function parseGlossaryTexts(xml: string): Map<string, string>;
+/** Every content control of `blocks`: around runs, paragraphs, tables, rows and cells. */
+export declare function forEachContentControl(blocks: readonly Block[], visit: (control: ContentControl) => void): void;
+/**
+ * Gives each control whose placeholder is a glossary entry that entry's text. The glossary is read
+ * only when a control names an entry, and a part that cannot be read leaves the built-in prompts
+ * (with a warning) rather than stopping the document from opening.
+ */
+export declare function readPlaceholderTexts(zip: JSZip, relationships: ReadonlyMap<string, Relationship>, model: DocumentModel): Promise<void>;
+//# sourceMappingURL=glossary.d.ts.map

package/dist/docx/glossary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../docx/glossary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAoB3E,iFAAiF;AACjF,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CASnE;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,CACpC,MAAM,EAAE,SAAS,KAAK,EAAE,EACxB,KAAK,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GACtC,IAAI,CAeN;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACzC,GAAG,EAAE,KAAK,EACV,aAAa,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,EAChD,KAAK,EAAE,aAAa,GAClB,OAAO,CAAC,IAAI,CAAC,CAkCf"}