@superdoc/sdk 2.25.0-next.1 → 2.25.0-next.11

package/dist/generated/client.d.ts

@@ -441,6 +441,37 @@ export interface DocGetNodeByIdParams {
     sessionId?: string;
     id: string;
     nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+    story?: ({
+        kind: "story";
+        storyType: "body";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header" | "footer";
+        variant: "default" | "first" | "even";
+        resolution?: "effective" | "explicit";
+        onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterPart";
+        refId: string;
+    }) | ({
+        kind: "story";
+        storyType: "footnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "endnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "textbox";
+        textboxId: string;
+    });
 }
 export interface DocGetTextParams {
     doc?: string;
@@ -21417,6 +21448,7 @@ export interface DocMutationsPreviewParams {
             });
             replacementMode?: "literal" | "regex-template";
             caseHandling?: "exact" | "preserve-match";
+            replacementGranularity?: "word" | "phrase" | "range";
             style?: {
                 inline: {
                     mode: "preserve" | "set" | "clear" | "merge";
@@ -23332,6 +23364,7 @@ export interface DocMutationsApplyParams {
             });
             replacementMode?: "literal" | "regex-template";
             caseHandling?: "exact" | "preserve-match";
+            replacementGranularity?: "word" | "phrase" | "range";
             style?: {
                 inline: {
                     mode: "preserve" | "set" | "clear" | "merge";
@@ -28107,6 +28140,37 @@ export interface DocImagesRemoveCaptionParams {
 export interface DocHyperlinksListParams {
     doc?: string;
     sessionId?: string;
+    in?: ({
+        kind: "story";
+        storyType: "body";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header" | "footer";
+        variant: "default" | "first" | "even";
+        resolution?: "effective" | "explicit";
+        onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterPart";
+        refId: string;
+    }) | ({
+        kind: "story";
+        storyType: "footnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "endnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "textbox";
+        textboxId: string;
+    });
     within?: {
         kind: "block";
         nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
@@ -28165,6 +28229,37 @@ export interface DocHyperlinksGetParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
 }
 export interface DocHyperlinksWrapParams {
@@ -28308,6 +28403,37 @@ export interface DocHyperlinksPatchParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     patch: {
         href?: string | unknown;
@@ -28340,6 +28466,37 @@ export interface DocHyperlinksRemoveParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     mode?: "unwrap" | "deleteText";
 }
@@ -29048,6 +29205,18 @@ export interface DocCreateContentControlParams {
     content?: string;
     html?: string;
     json?: Record<string, unknown> | Array<Record<string, unknown>>;
+    inline?: {
+        bold?: boolean | unknown;
+        italic?: boolean | unknown;
+        strike?: boolean | unknown;
+        underline?: boolean | unknown | ({
+            style?: string | unknown;
+            color?: string | unknown;
+            themeColor?: string | unknown;
+        });
+        fontSize?: number | unknown;
+        fontFamily?: string | unknown;
+    };
 }
 export interface DocContentControlsListParams {
     doc?: string;
@@ -33540,6 +33709,11 @@ export interface DocExportToDocxParams {
     doc?: string;
     sessionId?: string;
     mode?: "review-preserving" | "final" | "original";
+    policies?: {
+        trackedChanges?: "review-preserving" | "final" | "original";
+        comments?: "preserve" | "resolve" | "remove";
+        contentControls?: "preserve" | "flatten";
+    };
 }
 export interface DocProtectionGetParams {
     doc?: string;
@@ -220754,6 +220928,37 @@ export type DocHyperlinksListResult = {
                     offset: number;
                 };
             };
+            story?: ({
+                kind: "story";
+                storyType: "body";
+            }) | ({
+                kind: "story";
+                storyType: "headerFooterSlot";
+                section: {
+                    kind: "section";
+                    sectionId: string;
+                };
+                headerFooterKind: "header" | "footer";
+                variant: "default" | "first" | "even";
+                resolution?: "effective" | "explicit";
+                onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+            }) | ({
+                kind: "story";
+                storyType: "headerFooterPart";
+                refId: string;
+            }) | ({
+                kind: "story";
+                storyType: "footnote";
+                noteId: string;
+            }) | ({
+                kind: "story";
+                storyType: "endnote";
+                noteId: string;
+            }) | ({
+                kind: "story";
+                storyType: "textbox";
+                textboxId: string;
+            });
         };
         properties: {
             href?: string;
@@ -220785,6 +220990,37 @@ export type DocHyperlinksGetResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     properties: {
         href?: string;
@@ -221989,6 +222225,37 @@ export type DocHyperlinksWrapResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     hyperlinkNodeId?: string | null;
     partsCreated?: Array<string>;
@@ -223188,6 +223455,37 @@ export type DocHyperlinksInsertResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     hyperlinkNodeId?: string | null;
     partsCreated?: Array<string>;
@@ -224387,6 +224685,37 @@ export type DocHyperlinksPatchResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     hyperlinkNodeId?: string | null;
     partsCreated?: Array<string>;
@@ -225586,6 +225915,37 @@ export type DocHyperlinksRemoveResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     hyperlinkNodeId?: string | null;
     partsCreated?: Array<string>;
@@ -282131,6 +282491,37 @@ export interface DocGetNodeBoundParams {
 export interface DocGetNodeByIdBoundParams {
     id: string;
     nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+    story?: ({
+        kind: "story";
+        storyType: "body";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header" | "footer";
+        variant: "default" | "first" | "even";
+        resolution?: "effective" | "explicit";
+        onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterPart";
+        refId: string;
+    }) | ({
+        kind: "story";
+        storyType: "footnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "endnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "textbox";
+        textboxId: string;
+    });
 }
 export interface DocGetTextBoundParams {
     in?: ({
@@ -302751,6 +303142,7 @@ export interface DocMutationsPreviewBoundParams {
             });
             replacementMode?: "literal" | "regex-template";
             caseHandling?: "exact" | "preserve-match";
+            replacementGranularity?: "word" | "phrase" | "range";
             style?: {
                 inline: {
                     mode: "preserve" | "set" | "clear" | "merge";
@@ -304664,6 +305056,7 @@ export interface DocMutationsApplyBoundParams {
             });
             replacementMode?: "literal" | "regex-template";
             caseHandling?: "exact" | "preserve-match";
+            replacementGranularity?: "word" | "phrase" | "range";
             style?: {
                 inline: {
                     mode: "preserve" | "set" | "clear" | "merge";
@@ -309246,6 +309639,37 @@ export interface DocImagesRemoveCaptionBoundParams {
     imageId: string;
 }
 export interface DocHyperlinksListBoundParams {
+    in?: ({
+        kind: "story";
+        storyType: "body";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header" | "footer";
+        variant: "default" | "first" | "even";
+        resolution?: "effective" | "explicit";
+        onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+    }) | ({
+        kind: "story";
+        storyType: "headerFooterPart";
+        refId: string;
+    }) | ({
+        kind: "story";
+        storyType: "footnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "endnote";
+        noteId: string;
+    }) | ({
+        kind: "story";
+        storyType: "textbox";
+        textboxId: string;
+    });
     within?: {
         kind: "block";
         nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
@@ -309302,6 +309726,37 @@ export interface DocHyperlinksGetBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
 }
 export interface DocHyperlinksWrapBoundParams {
@@ -309439,6 +309894,37 @@ export interface DocHyperlinksPatchBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     patch: {
         href?: string | unknown;
@@ -309469,6 +309955,37 @@ export interface DocHyperlinksRemoveBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
     };
     mode?: "unwrap" | "deleteText";
 }
@@ -310139,6 +310656,18 @@ export interface DocCreateContentControlBoundParams {
     content?: string;
     html?: string;
     json?: Record<string, unknown> | Array<Record<string, unknown>>;
+    inline?: {
+        bold?: boolean | unknown;
+        italic?: boolean | unknown;
+        strike?: boolean | unknown;
+        underline?: boolean | unknown | ({
+            style?: string | unknown;
+            color?: string | unknown;
+            themeColor?: string | unknown;
+        });
+        fontSize?: number | unknown;
+        fontFamily?: string | unknown;
+    };
 }
 export interface DocContentControlsListBoundParams {
     controlType?: string;
@@ -314381,6 +314910,11 @@ export interface DocDiffApplyBoundParams {
 }
 export interface DocExportToDocxBoundParams {
     mode?: "review-preserving" | "final" | "original";
+    policies?: {
+        trackedChanges?: "review-preserving" | "final" | "original";
+        comments?: "preserve" | "resolve" | "remove";
+        contentControls?: "preserve" | "flatten";
+    };
 }
 export interface DocProtectionGetBoundParams {
 }