oasis-editor 0.0.82 → 0.0.83

package/dist/core/model/index.d.ts

@@ -8,9 +8,9 @@
  */
 export type { EditorUnderlineStyle, EditorLigatures, EditorNumberSpacing, EditorNumberForm, EditorTextLanguage, EditorBorderStyle, EditorTabStop, EditorParagraphListStyle, EditorImageCrop, EditorImageFillMode, EditorImageFloatingPosition, EditorImageFloatingLayout, EditorImageRunData, EditorWrapPolygonPoint, EditorFieldData, EditorFieldChar, EditorFootnoteReferenceData, EditorEndnoteReferenceData, EditorRevision, EditorAsset, EditorFootnoteNumberFormat, EditorFootnoteRestart, EditorDocxWidthValue, EditorTableLayout, EditorTableRowHeightRule, } from './types/primitives.js';
 export type { EditorTextStyle, EditorParagraphStyle, EditorTableStyle, EditorTableConditionalFormat, EditorConditionalRowStyle, EditorNamedStyle, } from './types/styles.js';
-export type { EditorTextRun, EditorTextBoxShape, EditorTextBoxBody, EditorTextBoxData, EditorDropCap, EditorParagraphNode, EditorTableCellStyle, EditorTableCellNode, EditorTableRowStyle, EditorTableRowNode, EditorTableNode, EditorBlockNode, } from './types/nodes.js';
-export type { RunKind, RunVisitor } from './runKind.js';
-export { getRunKind, isInlineObjectRun, visitRun } from './runKind.js';
+export type { EditorRunBase, EditorTextRun, EditorTextBoxShape, EditorTextBoxBody, EditorTextBoxData, EditorDropCap, EditorParagraphNode, EditorTableCellStyle, EditorTableCellNode, EditorTableRowStyle, EditorTableRowNode, EditorTableNode, EditorBlockNode, } from './types/nodes.js';
+export type { RunKind, RunOfKind, RunVisitor } from './runKind.js';
+export { getRunKind, isInlineObjectRun, visitRun, getRunImage, getRunTextBox, getRunField, getRunFieldChar, getRunFieldInstruction, getRunFootnoteReference, getRunEndnoteReference, getRunSym, } from './runKind.js';
 export type { EditorFootnote } from './types/documentFootnotes.js';
 export type { EditorEndnote } from './types/documentEndnotes.js';
 export type { EditorBookmark, EditorBookmarkAnchor, EditorBookmarks, } from './types/documentBookmarks.js';

package/dist/core/model/runKind.d.ts

@@ -1,40 +1,45 @@
-import { EditorTextRun } from './types/nodes.js';
+import { EditorTextBoxData, EditorTextRun } from './types/nodes.js';
+import { EditorFieldChar, EditorFieldData, EditorImageRunData, EditorFootnoteReferenceData, EditorEndnoteReferenceData } from './types/primitives.js';
 
 /**
- * Discriminated classification of an {@link EditorTextRun}.
- *
- * `EditorTextRun` is a flat bag of optional fields (`image`, `textBox`,
- * `field`, …) with no discriminant, so adding a new inline object means every
- * dispatch site has to remember to handle it (O1). `getRunKind` derives the
- * effective kind once, in the canonical precedence the DOCX serializer uses
- * (`export/docx/text/runXml.ts`), and `visitRun` turns that into an exhaustive
- * dispatch — a missing branch is a compile error.
- *
- * This is purely derived from the existing fields; it does not change the wire
- * shape. It is the safe first step before migrating `EditorTextRun` itself to a
- * discriminated union.
- */
-export type RunKind = "footnoteReference" | "endnoteReference" | "fieldChar" | "fieldInstruction" | "field" | "textBox" | "image" | "sym" | "text";
-/**
- * Classifies a run by its highest-precedence object field. The order mirrors
- * `serializeRun` so callers that switch on the kind agree with export.
+ * Discriminant of an {@link EditorTextRun}. `EditorTextRun` is a discriminated
+ * union keyed on `kind`; `getRunKind`/`visitRun` are thin helpers over it so
+ * dispatch stays in one place and adding a variant is a compile error (O1).
  */
+export type RunKind = EditorTextRun["kind"];
+/** The union member for a given run kind. */
+export type RunOfKind<K extends RunKind> = Extract<EditorTextRun, {
+    kind: K;
+}>;
+/** Returns a run's discriminant. */
 export declare function getRunKind(run: EditorTextRun): RunKind;
 /** True for runs that carry an inline object replacement (image or text box). */
 export declare function isInlineObjectRun(run: EditorTextRun): boolean;
+export declare function getRunImage(run: EditorTextRun): EditorImageRunData | undefined;
+export declare function getRunTextBox(run: EditorTextRun): EditorTextBoxData | undefined;
+export declare function getRunField(run: EditorTextRun): EditorFieldData | undefined;
+export declare function getRunFieldChar(run: EditorTextRun): EditorFieldChar | undefined;
+export declare function getRunFieldInstruction(run: EditorTextRun): string | undefined;
+export declare function getRunFootnoteReference(run: EditorTextRun): EditorFootnoteReferenceData | undefined;
+export declare function getRunEndnoteReference(run: EditorTextRun): EditorEndnoteReferenceData | undefined;
+export declare function getRunSym(run: EditorTextRun): {
+    font: string;
+    char: string;
+} | undefined;
 export interface RunVisitor<R> {
-    text(run: EditorTextRun): R;
-    image(run: EditorTextRun): R;
-    textBox(run: EditorTextRun): R;
-    field(run: EditorTextRun): R;
-    fieldChar(run: EditorTextRun): R;
-    fieldInstruction(run: EditorTextRun): R;
-    footnoteReference(run: EditorTextRun): R;
-    endnoteReference(run: EditorTextRun): R;
-    sym(run: EditorTextRun): R;
+    text(run: RunOfKind<"text">): R;
+    image(run: RunOfKind<"image">): R;
+    textBox(run: RunOfKind<"textBox">): R;
+    field(run: RunOfKind<"field">): R;
+    fieldChar(run: RunOfKind<"fieldChar">): R;
+    fieldInstruction(run: RunOfKind<"fieldInstruction">): R;
+    footnoteReference(run: RunOfKind<"footnoteReference">): R;
+    endnoteReference(run: RunOfKind<"endnoteReference">): R;
+    sym(run: RunOfKind<"sym">): R;
 }
 /**
- * Exhaustive dispatch over a run's kind. Adding a `RunKind` variant forces every
+ * Exhaustive dispatch over a run's kind, narrowing the run to the matching union
+ * member inside each visitor method. Adding a `RunKind` variant forces every
  * `RunVisitor` to grow the matching method (compile error otherwise).
  */
 export declare function visitRun<R>(run: EditorTextRun, visitor: RunVisitor<R>): R;

package/dist/core/model/types/nodes.d.ts

@@ -58,41 +58,76 @@ export interface EditorTextBoxData {
     shape?: EditorTextBoxShape;
     body?: EditorTextBoxBody;
 }
-export interface EditorTextRun {
+/**
+ * Fields shared by every run kind. `text` is always present (inline objects use
+ * the object-replacement character ``); `revision` can decorate a run of
+ * any kind (insert/delete tracking).
+ */
+export interface EditorRunBase {
     id: string;
     text: string;
     styles?: EditorTextStyle;
-    image?: EditorImageRunData;
-    textBox?: EditorTextBoxData;
-    field?: EditorFieldData;
-    /**
-     * Preserved complex-field control char (`w:fldChar`). Zero-length marker run;
-     * see {@link EditorFieldChar}.
-     */
-    fieldChar?: EditorFieldChar;
-    /** Preserved field instruction text (`w:instrText`). Zero-length marker run. */
-    fieldInstruction?: string;
     revision?: EditorRevision;
-    /**
-     * Inline marker of a footnote whose body lives in
-     * `EditorDocument.footnotes.items[footnoteReference.footnoteId]`.
-     */
-    footnoteReference?: EditorFootnoteReferenceData;
-    /**
-     * Inline marker of an endnote whose body lives in
-     * `EditorDocument.endnotes.items[endnoteReference.endnoteId]`.
-     */
-    endnoteReference?: EditorEndnoteReferenceData;
-    /**
-     * Round-trip metadata for `w:sym` — a glyph from a named font.
-     * `font` is the `w:font` attribute value; `char` is the 4-digit hex `w:char` value.
-     * The character is also stored in `text` so the canvas can render it.
-     */
-    sym?: {
+}
+/**
+ * A run of text, optionally carrying one inline object. Discriminated by `kind`
+ * so adding a new inline object forces every dispatch site to handle it (a
+ * missing branch is a compile error) and invalid combinations (e.g. `image` +
+ * `textBox`) are unrepresentable (O1). The `kind` values mirror {@link RunKind}.
+ */
+export type EditorTextRun = (EditorRunBase & {
+    kind: "text";
+}) | (EditorRunBase & {
+    kind: "image";
+    image: EditorImageRunData;
+}) | (EditorRunBase & {
+    kind: "textBox";
+    textBox: EditorTextBoxData;
+}) | (EditorRunBase & {
+    kind: "field";
+    field: EditorFieldData;
+})
+/**
+ * Preserved complex-field control char (`w:fldChar`). Zero-length marker run;
+ * see {@link EditorFieldChar}.
+ */
+ | (EditorRunBase & {
+    kind: "fieldChar";
+    fieldChar: EditorFieldChar;
+})
+/** Preserved field instruction text (`w:instrText`). Zero-length marker run. */
+ | (EditorRunBase & {
+    kind: "fieldInstruction";
+    fieldInstruction: string;
+})
+/**
+ * Inline marker of a footnote whose body lives in
+ * `EditorDocument.footnotes.items[footnoteReference.footnoteId]`.
+ */
+ | (EditorRunBase & {
+    kind: "footnoteReference";
+    footnoteReference: EditorFootnoteReferenceData;
+})
+/**
+ * Inline marker of an endnote whose body lives in
+ * `EditorDocument.endnotes.items[endnoteReference.endnoteId]`.
+ */
+ | (EditorRunBase & {
+    kind: "endnoteReference";
+    endnoteReference: EditorEndnoteReferenceData;
+})
+/**
+ * Round-trip metadata for `w:sym` — a glyph from a named font. `font` is the
+ * `w:font` attribute value; `char` is the 4-digit hex `w:char` value. The
+ * character is also stored in `text` so the canvas can render it.
+ */
+ | (EditorRunBase & {
+    kind: "sym";
+    sym: {
         font: string;
         char: string;
     };
-}
+});
 /**
  * A drop cap (Word's `w:framePr/@dropCap`): a large initial letter sunk into
  * the first lines of the paragraph, with body text wrapping around it. In OOXML