superdoc 2.16.1-next.4 → 2.16.1-next.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,2036 +1,24 @@
1
+ import { DocumentApiSurface } from '../index.js';
2
+ import { OPERATION_DEFINITIONS } from './operation-definitions.js';
1
3
  import { OperationId } from './types.js';
2
- import { NodeAddress } from '../types/index.js';
3
- import { SDNodeResult, SDFindInput, SDFindResult, SDGetInput } from '../types/sd-envelope.js';
4
- import { TextMutationReceipt, Receipt } from '../types/receipt.js';
5
- import { SDHtmlToFragmentResult, SDMutationReceipt, SDMarkdownToFragmentResult } from '../types/sd-contract.js';
6
- import { DocumentInfo } from '../types/info.types.js';
7
- import { SDDocument } from '../types/fragment.js';
8
- import { CreateParagraphInput, CreateParagraphResult, CreateHeadingInput, CreateHeadingResult } from '../types/create.types.js';
9
- import { BlocksDeleteInput, BlocksDeleteResult, BlocksListInput, BlocksListResult, BlocksFindTextInput, BlocksFindTextResult, BlocksDeleteRangeInput, BlocksDeleteRangeResult, BlocksMergeInput, BlocksMergeResult, BlocksMoveInput, BlocksMoveResult, BlocksSplitInput, BlocksSplitResult } from '../types/blocks.types.js';
10
- import { GetNodeByIdInput } from '../get-node/get-node.js';
11
- import { GetTextInput } from '../get-text/get-text.js';
12
- import { GetMarkdownInput } from '../get-markdown/get-markdown.js';
13
- import { GetHtmlInput } from '../get-html/get-html.js';
14
- import { ProjectHtmlInput, ProjectMarkdownInput, SDContentProjectionResult } from '../types/content-projection.js';
15
- import { MarkdownToFragmentInput } from '../markdown-to-fragment/markdown-to-fragment.js';
16
- import { HtmlToFragmentInput } from '../html-to-fragment/html-to-fragment.js';
17
- import { InfoInput } from '../info/info.js';
18
- import { ExtractInput } from '../extract/extract.js';
19
- import { ExtractResult } from '../types/extract.types.js';
20
- import { ClearContentInput } from '../clear-content/clear-content.js';
21
- import { InsertInput } from '../insert/insert.js';
22
- import { ReplaceInput } from '../replace/replace.js';
23
- import { DeleteInput } from '../delete/delete.js';
24
- import { MutationOptions, RevisionGuardOptions, RichContentMutationOptions } from '../write/write.js';
25
- import { FormatInlineAliasInput, FormatRangeInput, StyleApplyInput } from '../format/format.js';
26
- import { InlineRunPatchKey } from '../format/inline-run-patch.js';
27
- import { StylesApplyInput, StylesApplyOptions, StylesApplyReceipt, StylesGetCatalogInput, StylesGetCatalogResult } from '../styles/index.js';
28
- import { TemplatesApplyInput, TemplatesApplyOptions, TemplatesApplyReceipt } from '../templates/index.js';
29
- import { CommentsCreateReceipt, CommentsCreateInput, CommentsPatchInput, CommentsDeleteInput, GetCommentInput } from '../comments/comments.js';
30
- import { CommentInfo, CommentsListQuery, CommentsListResult } from '../comments/comments.types.js';
31
- import { TrackChangesListInput, TrackChangesGetInput, ReviewDecideInput } from '../track-changes/track-changes.js';
32
- import { TrackChangeInfo, TrackChangesListResult } from '../types/track-changes.types.js';
33
- import { DocumentApiCapabilities } from '../capabilities/capabilities.js';
34
- import { SDHtmlMarkdownSupportCheckInput, SDHtmlMarkdownSupportCheckResult } from '../capabilities/html-markdown-support.js';
35
- import { HistoryState, HistoryActionResult } from '../history/history.types.js';
36
- import { DiffSnapshot, DiffPayload, DiffApplyResult, DiffCompareInput, DiffApplyInput, DiffApplyOptions } from '../diff/diff.types.js';
37
- import { ExportToDocxInput, ExportToDocxResult } from '../export/export.types.js';
38
- import { DocumentProtectionState, ProtectionGetInput, SetEditingRestrictionInput, ClearEditingRestrictionInput, ProtectionMutationResult } from '../protection/protection.types.js';
39
- import { PermissionRangesListInput, PermissionRangesListResult, PermissionRangesGetInput, PermissionRangeInfo, PermissionRangesCreateInput, PermissionRangesRemoveInput, PermissionRangesUpdatePrincipalInput, PermissionRangeMutationResult, PermissionRangeRemoveResult } from '../permission-ranges/permission-ranges.types.js';
40
- import { ListsListQuery, ListsListResult, ListsGetInput, ListItemInfo, ListInsertInput, ListsInsertResult, ListsMutateItemResult, ListTargetInput, ListsCreateInput, ListsCreateResult, ListsAttachInput, ListsDetachInput, ListsDetachResult, ListsDeleteInput, ListsDeleteResult, ListsJoinInput, ListsJoinResult, ListsCanJoinInput, ListsCanJoinResult, ListsSeparateInput, ListsSeparateResult, ListsMergeInput, ListsMergeResult, ListsSplitInput, ListsSplitResult, ListsSetLevelInput, ListsSetValueInput, ListsContinuePreviousInput, ListsCanContinuePreviousInput, ListsCanContinuePreviousResult, ListsSetLevelRestartInput, ListsConvertToTextInput, ListsConvertToTextResult, ListsApplyTemplateInput, ListsApplyPresetInput, ListsSetTypeInput, ListsCaptureTemplateInput, ListsCaptureTemplateResult, ListsSetLevelNumberingInput, ListsSetLevelBulletInput, ListsSetLevelPictureBulletInput, ListsSetLevelAlignmentInput, ListsSetLevelIndentsInput, ListsSetLevelTrailingCharacterInput, ListsSetLevelMarkerFontInput, ListsClearLevelOverridesInput, ListsGetStyleInput, ListsGetStyleResult, ListsApplyStyleInput, ListsRestartAtInput, ListsSetLevelNumberStyleInput, ListsSetLevelTextInput, ListsSetLevelStartInput, ListsSetLevelLayoutInput, ListsGetStateInput, ListsGetStateResult, ListsApplyInput, ListsContinueV2Input, ListsRestartV2Input, ListsRemoveV2Input } from '../lists/lists.types.js';
41
- import { ParagraphMutationResult, ParagraphsSetStyleInput, ParagraphsSetStyleRefInput, ParagraphsClearStyleInput, ParagraphsResetDirectFormattingInput, ParagraphsSetAlignmentInput, ParagraphsClearAlignmentInput, ParagraphsSetIndentationInput, ParagraphsClearIndentationInput, ParagraphsSetSpacingInput, ParagraphsClearSpacingInput, ParagraphsSetKeepOptionsInput, ParagraphsSetOutlineLevelInput, ParagraphsSetFlowOptionsInput, ParagraphsSetTabStopInput, ParagraphsClearTabStopInput, ParagraphsClearAllTabStopsInput, ParagraphsSetBorderInput, ParagraphsClearBorderInput, ParagraphsSetShadingInput, ParagraphsClearShadingInput, ParagraphsSetMarkRunPropsInput, ParagraphsSetDirectionInput, ParagraphsClearDirectionInput, ParagraphsSetNumberingInput } from '../paragraphs/paragraphs.js';
42
- import { CreateSectionBreakInput, CreateSectionBreakResult, DocumentMutationResult, SectionInfo, SectionMutationResult, SectionsClearHeaderFooterRefInput, SectionsClearPageBordersInput, SectionsGetInput, SectionsListQuery, SectionsListResult, SectionsSetBreakTypeInput, SectionsSetColumnsInput, SectionsSetHeaderFooterMarginsInput, SectionsSetHeaderFooterRefInput, SectionsSetLineNumberingInput, SectionsSetLinkToPreviousInput, SectionsSetOddEvenHeadersFootersInput, SectionsSetPageBordersInput, SectionsSetPageMarginsInput, SectionsSetPageNumberingInput, SectionsSetPageSetupInput, SectionsSetSectionDirectionInput, SectionsSetTitlePageInput, SectionsSetVerticalAlignInput } from '../sections/sections.types.js';
43
- import { QueryMatchInput, QueryMatchOutput } from '../types/query-match.types.js';
44
- import { ResolveRangeInput, ResolveRangeOutput } from '../ranges/ranges.types.js';
45
- import { SelectionCurrentInput, SelectionInfo } from '../selection/selection.js';
46
- import { CreateImageInput, CreateImageResult, ImagesListInput, ImagesListResult, ImagesGetInput, ImageSummary, ImagesDeleteInput, ImagesMutationResult, MoveImageInput, ConvertToInlineInput, ConvertToFloatingInput, SetSizeInput, SetWrapTypeInput, SetWrapSideInput, SetWrapDistancesInput, SetPositionInput, SetAnchorOptionsInput, SetZOrderInput, ScaleInput, SetLockAspectRatioInput, RotateInput, FlipInput, CropInput, ResetCropInput, ReplaceSourceInput, SetAltTextInput, SetDecorativeInput, SetNameInput, SetHyperlinkInput, InsertCaptionInput, UpdateCaptionInput, RemoveCaptionInput } from '../images/images.types.js';
47
- import { MutationsApplyInput, MutationsPreviewInput, MutationsPreviewOutput, PlanReceipt } from '../types/mutation-plan.types.js';
48
- import { PlanExecuteInput, PlanExecuteResult } from '../plan/plan.js';
49
- import { CreateTableOfContentsInput, CreateTableOfContentsResult, TocListQuery, TocListResult, TocGetInput, TocInfo, TocConfigureInput, TocUpdateInput, TocRemoveInput, TocMutationResult, TocMarkEntryInput, TocUnmarkEntryInput, TocListEntriesQuery, TocListEntriesResult, TocGetEntryInput, TocEntryInfo, TocEditEntryInput, TocEntryMutationResult } from '../toc/toc.types.js';
50
- import { BookmarkListInput, BookmarksListResult, BookmarkGetInput, BookmarkInfo, BookmarkInsertInput, BookmarkRenameInput, BookmarkRemoveInput, BookmarkMutationResult } from '../bookmarks/bookmarks.types.js';
51
- import { CustomXmlPartsListInput, CustomXmlPartsListResult, CustomXmlPartsGetInput, CustomXmlPartInfo, CustomXmlPartsCreateInput, CustomXmlPartsCreateResult, CustomXmlPartsPatchInput, CustomXmlPartsRemoveInput, CustomXmlPartsMutationResult } from '../customXml/customXml.types.js';
52
- import { AnchoredMetadataAttachInput, AnchoredMetadataAttachResult, AnchoredMetadataListInput, AnchoredMetadataListResult, AnchoredMetadataGetInput, AnchoredMetadataInfo, AnchoredMetadataUpdateInput, AnchoredMetadataRemoveInput, AnchoredMetadataResolveInput, AnchoredMetadataMutationResult, AnchoredMetadataResolveInfo } from '../metadata/anchored-metadata.types.js';
53
- import { FootnoteListInput, FootnotesListResult, FootnoteGetInput, FootnoteInfo, FootnoteInsertInput, FootnoteUpdateInput, FootnoteRemoveInput, FootnoteMutationResult, FootnoteConfigureInput, FootnoteConfigResult } from '../footnotes/footnotes.types.js';
54
- import { ClipboardInsertInput, ClipboardInsertResult, ClipboardParseOptions, ClipboardParseResult, ClipboardPayload, ClipboardSerializeInput, ClipboardSerializeResult } from '../types/clipboard.js';
55
- import { CrossRefListInput, CrossRefsListResult, CrossRefGetInput, CrossRefInfo, CrossRefInsertInput, CrossRefRebuildInput, CrossRefRemoveInput, CrossRefMutationResult } from '../cross-refs/cross-refs.types.js';
56
- import { IndexListInput, IndexListResult, IndexGetInput, IndexInfo, IndexInsertInput, IndexConfigureInput, IndexRebuildInput, IndexRemoveInput, IndexMutationResult, IndexEntryListInput, IndexEntryListResult, IndexEntryGetInput, IndexEntryInfo, IndexEntryInsertInput, IndexEntryUpdateInput, IndexEntryRemoveInput, IndexEntryMutationResult } from '../index/index.types.js';
57
- import { CaptionListInput, CaptionsListResult, CaptionGetInput, CaptionInfo, CaptionInsertInput, CaptionUpdateInput, CaptionRemoveInput, CaptionMutationResult, CaptionConfigureInput, CaptionConfigResult } from '../captions/captions.types.js';
58
- import { FieldListInput, FieldsListResult, FieldGetInput, FieldInfo, FieldInsertInput, FieldRebuildInput, FieldRemoveInput, FieldMutationResult } from '../fields/fields.types.js';
59
- import { CitationListInput, CitationsListResult, CitationGetInput, CitationInfo, CitationInsertInput, CitationUpdateInput, CitationRemoveInput, CitationMutationResult, CitationSourceListInput, CitationSourcesListResult, CitationSourceGetInput, CitationSourceInfo, CitationSourceInsertInput, CitationSourceUpdateInput, CitationSourceRemoveInput, CitationSourceMutationResult, BibliographyGetInput, BibliographyInfo, BibliographyInsertInput, BibliographyRebuildInput, BibliographyConfigureInput, BibliographyRemoveInput, BibliographyMutationResult } from '../citations/citations.types.js';
60
- import { AuthoritiesListInput, AuthoritiesListResult, AuthoritiesGetInput, AuthoritiesInfo, AuthoritiesInsertInput, AuthoritiesConfigureInput, AuthoritiesRebuildInput, AuthoritiesRemoveInput, AuthoritiesMutationResult, AuthorityEntryListInput, AuthorityEntryListResult, AuthorityEntryGetInput, AuthorityEntryInfo, AuthorityEntryInsertInput, AuthorityEntryUpdateInput, AuthorityEntryRemoveInput, AuthorityEntryMutationResult } from '../authorities/authorities.types.js';
61
- import { CreateTableInput, CreateTableResult, TablesConvertFromTextInput, TableLocator, TablesMoveInput, TablesSplitInput, TablesConvertToTextInput, TablesSetLayoutInput, TablesInsertRowInput, TablesDeleteRowInput, TablesMoveRowInput, TablesSetRowHeightInput, TablesDistributeRowsInput, TablesSetRowOptionsInput, TablesInsertColumnInput, TablesDeleteColumnInput, TablesMoveColumnInput, TablesSetColumnWidthInput, TablesDistributeColumnsInput, TablesInsertCellInput, TablesDeleteCellInput, TablesMergeCellsInput, TablesUnmergeCellsInput, TablesSplitCellInput, TablesSetCellPropertiesInput, TablesSetCellTextInput, TablesSortInput, TablesSetAltTextInput, TablesSetStyleInput, TablesClearStyleInput, TablesSetStyleOptionInput, TablesSetBorderInput, TablesClearBorderInput, TablesApplyBorderPresetInput, TablesSetShadingInput, TablesClearShadingInput, TablesSetTablePaddingInput, TablesSetCellPaddingInput, TablesSetCellSpacingInput, TablesClearCellSpacingInput, TablesApplyStyleInput, TablesSetBordersInput, TablesSetTableOptionsInput, TablesApplyPresetInput, TableMutationResult, TablesGetInput, TablesGetOutput, TablesGetCellsInput, TablesGetCellsOutput, TablesGetPropertiesInput, TablesGetPropertiesOutput, TablesGetStylesInput, TablesGetStylesOutput, TablesSetDefaultStyleInput, TablesClearDefaultStyleInput } from '../types/table-operations.types.js';
62
- import { HyperlinksListQuery, HyperlinksListResult, HyperlinksGetInput, HyperlinkInfo, HyperlinksWrapInput, HyperlinksInsertInput, HyperlinksPatchInput, HyperlinksRemoveInput, HyperlinkMutationResult } from '../hyperlinks/hyperlinks.types.js';
63
- import { HeaderFootersListQuery, HeaderFootersListResult, HeaderFootersGetInput, HeaderFooterSlotEntry, HeaderFootersResolveInput, HeaderFooterResolveResult, HeaderFootersRefsSetInput, HeaderFootersRefsClearInput, HeaderFootersRefsSetLinkedToPreviousInput, HeaderFootersPartsListQuery, HeaderFootersPartsListResult, HeaderFootersPartsCreateInput, HeaderFootersPartsDeleteInput, HeaderFooterPartsMutationResult } from '../header-footers/header-footers.types.js';
64
- import { WatermarksInsertInput, WatermarksListQuery, WatermarksListResult, WatermarksRemoveInput, WatermarksReplaceInput, WatermarkMutationResult, WatermarkRemoveResult } from '../watermarks/watermarks.types.js';
65
- import { ContentControlInfo, ContentControlMutationResult, ContentControlsListResult, ContentControlsListQuery, ContentControlsGetInput, ContentControlsListInRangeInput, ContentControlsSelectByTagInput, ContentControlsSelectByTitleInput, ContentControlsListChildrenInput, ContentControlsGetParentInput, ContentControlsWrapInput, ContentControlsUnwrapInput, ContentControlsDeleteInput, ContentControlsCopyInput, ContentControlsMoveInput, ContentControlsPatchInput, ContentControlsSetLockModeInput, ContentControlsSetTypeInput, ContentControlsGetContentInput, ContentControlsGetContentResult, ContentControlsReplaceContentInput, ContentControlsClearContentInput, ContentControlsAppendContentInput, ContentControlsPrependContentInput, ContentControlsInsertBeforeInput, ContentControlsInsertAfterInput, ContentControlsGetBindingInput, ContentControlBinding, ContentControlsSetBindingInput, ContentControlsClearBindingInput, ContentControlsGetRawPropertiesInput, ContentControlsGetRawPropertiesResult, ContentControlsPatchRawPropertiesInput, ContentControlsValidateWordCompatibilityInput, ContentControlsValidateWordCompatibilityResult, ContentControlsNormalizeWordCompatibilityInput, ContentControlsNormalizeTagPayloadInput, ContentControlsTextSetMultilineInput, ContentControlsTextSetValueInput, ContentControlsTextClearValueInput, ContentControlsDateSetValueInput, ContentControlsDateClearValueInput, ContentControlsDateSetDisplayFormatInput, ContentControlsDateSetDisplayLocaleInput, ContentControlsDateSetStorageFormatInput, ContentControlsDateSetCalendarInput, ContentControlsCheckboxGetStateInput, ContentControlsCheckboxGetStateResult, ContentControlsCheckboxSetStateInput, ContentControlsCheckboxToggleInput, ContentControlsCheckboxSetSymbolPairInput, ContentControlsChoiceListGetItemsInput, ContentControlsChoiceListGetItemsResult, ContentControlsChoiceListSetItemsInput, ContentControlsChoiceListSetSelectedInput, ContentControlsRepeatingSectionListItemsInput, ContentControlsRepeatingSectionListItemsResult, ContentControlsRepeatingSectionInsertItemBeforeInput, ContentControlsRepeatingSectionInsertItemAfterInput, ContentControlsRepeatingSectionCloneItemInput, ContentControlsRepeatingSectionDeleteItemInput, ContentControlsRepeatingSectionSetAllowInsertDeleteInput, ContentControlsGroupWrapInput, ContentControlsGroupUngroupInput, CreateContentControlInput } from '../content-controls/content-controls.types.js';
66
- type FormatInlineAliasOperationRegistry = {
67
- [K in InlineRunPatchKey as `format.${K}`]: {
68
- input: FormatInlineAliasInput<K>;
69
- options: MutationOptions;
70
- output: TextMutationReceipt;
71
- };
72
- };
73
- export interface OperationRegistry extends FormatInlineAliasOperationRegistry {
74
- get: {
75
- input: SDGetInput;
76
- options: never;
77
- output: SDDocument;
78
- };
79
- find: {
80
- input: SDFindInput;
81
- options: never;
82
- output: SDFindResult;
83
- };
84
- getNode: {
85
- input: NodeAddress;
86
- options: never;
87
- output: SDNodeResult;
88
- };
89
- getNodeById: {
90
- input: GetNodeByIdInput;
91
- options: never;
92
- output: SDNodeResult;
93
- };
94
- getText: {
95
- input: GetTextInput;
96
- options: never;
97
- output: string;
98
- };
99
- getMarkdown: {
100
- input: GetMarkdownInput;
101
- options: never;
102
- output: string;
103
- };
104
- getHtml: {
105
- input: GetHtmlInput;
106
- options: never;
107
- output: string;
108
- };
109
- projectMarkdown: {
110
- input: ProjectMarkdownInput;
111
- options: never;
112
- output: Promise<SDContentProjectionResult<'markdown'>>;
113
- };
114
- projectHtml: {
115
- input: ProjectHtmlInput;
116
- options: never;
117
- output: Promise<SDContentProjectionResult<'html'>>;
118
- };
119
- markdownToFragment: {
120
- input: MarkdownToFragmentInput;
121
- options: never;
122
- output: SDMarkdownToFragmentResult;
123
- };
124
- htmlToFragment: {
125
- input: HtmlToFragmentInput;
126
- options: never;
127
- output: SDHtmlToFragmentResult;
128
- };
129
- info: {
130
- input: InfoInput;
131
- options: never;
132
- output: DocumentInfo;
133
- };
134
- extract: {
135
- input: ExtractInput;
136
- options: never;
137
- output: ExtractResult;
138
- };
139
- clearContent: {
140
- input: ClearContentInput;
141
- options: MutationOptions;
142
- output: Receipt;
143
- };
144
- insert: {
145
- input: InsertInput;
146
- options: RichContentMutationOptions;
147
- output: SDMutationReceipt;
148
- };
149
- replace: {
150
- input: ReplaceInput;
151
- options: RichContentMutationOptions;
152
- output: SDMutationReceipt;
153
- };
154
- delete: {
155
- input: DeleteInput;
156
- options: MutationOptions;
157
- output: TextMutationReceipt;
158
- };
159
- formatRange: {
160
- input: FormatRangeInput;
161
- options: MutationOptions;
162
- output: TextMutationReceipt;
163
- };
164
- 'blocks.list': {
165
- input: BlocksListInput | undefined;
166
- options: never;
167
- output: BlocksListResult;
168
- };
169
- 'blocks.findText': {
170
- input: BlocksFindTextInput;
171
- options: never;
172
- output: BlocksFindTextResult;
173
- };
174
- 'blocks.delete': {
175
- input: BlocksDeleteInput;
176
- options: MutationOptions;
177
- output: BlocksDeleteResult;
178
- };
179
- 'blocks.deleteRange': {
180
- input: BlocksDeleteRangeInput;
181
- options: MutationOptions;
182
- output: BlocksDeleteRangeResult;
183
- };
184
- 'blocks.split': {
185
- input: BlocksSplitInput;
186
- options: MutationOptions;
187
- output: BlocksSplitResult;
188
- };
189
- 'blocks.merge': {
190
- input: BlocksMergeInput;
191
- options: MutationOptions;
192
- output: BlocksMergeResult;
193
- };
194
- 'blocks.move': {
195
- input: BlocksMoveInput;
196
- options: MutationOptions;
197
- output: BlocksMoveResult;
198
- };
199
- 'format.apply': {
200
- input: StyleApplyInput;
201
- options: MutationOptions;
202
- output: TextMutationReceipt;
203
- };
204
- 'styles.paragraph.setStyle': {
205
- input: ParagraphsSetStyleInput;
206
- options: MutationOptions;
207
- output: ParagraphMutationResult;
208
- };
209
- 'styles.paragraph.setStyleRef': {
210
- input: ParagraphsSetStyleRefInput;
211
- options: MutationOptions;
212
- output: ParagraphMutationResult;
213
- };
214
- 'styles.paragraph.clearStyle': {
215
- input: ParagraphsClearStyleInput;
216
- options: MutationOptions;
217
- output: ParagraphMutationResult;
218
- };
219
- 'format.paragraph.resetDirectFormatting': {
220
- input: ParagraphsResetDirectFormattingInput;
221
- options: MutationOptions;
222
- output: ParagraphMutationResult;
223
- };
224
- 'format.paragraph.setAlignment': {
225
- input: ParagraphsSetAlignmentInput;
226
- options: MutationOptions;
227
- output: ParagraphMutationResult;
228
- };
229
- 'format.paragraph.clearAlignment': {
230
- input: ParagraphsClearAlignmentInput;
231
- options: MutationOptions;
232
- output: ParagraphMutationResult;
233
- };
234
- 'format.paragraph.setIndentation': {
235
- input: ParagraphsSetIndentationInput;
236
- options: MutationOptions;
237
- output: ParagraphMutationResult;
238
- };
239
- 'format.paragraph.clearIndentation': {
240
- input: ParagraphsClearIndentationInput;
241
- options: MutationOptions;
242
- output: ParagraphMutationResult;
243
- };
244
- 'format.paragraph.setSpacing': {
245
- input: ParagraphsSetSpacingInput;
246
- options: MutationOptions;
247
- output: ParagraphMutationResult;
248
- };
249
- 'format.paragraph.clearSpacing': {
250
- input: ParagraphsClearSpacingInput;
251
- options: MutationOptions;
252
- output: ParagraphMutationResult;
253
- };
254
- 'format.paragraph.setKeepOptions': {
255
- input: ParagraphsSetKeepOptionsInput;
256
- options: MutationOptions;
257
- output: ParagraphMutationResult;
258
- };
259
- 'format.paragraph.setOutlineLevel': {
260
- input: ParagraphsSetOutlineLevelInput;
261
- options: MutationOptions;
262
- output: ParagraphMutationResult;
263
- };
264
- 'format.paragraph.setFlowOptions': {
265
- input: ParagraphsSetFlowOptionsInput;
266
- options: MutationOptions;
267
- output: ParagraphMutationResult;
268
- };
269
- 'format.paragraph.setTabStop': {
270
- input: ParagraphsSetTabStopInput;
271
- options: MutationOptions;
272
- output: ParagraphMutationResult;
273
- };
274
- 'format.paragraph.clearTabStop': {
275
- input: ParagraphsClearTabStopInput;
276
- options: MutationOptions;
277
- output: ParagraphMutationResult;
278
- };
279
- 'format.paragraph.clearAllTabStops': {
280
- input: ParagraphsClearAllTabStopsInput;
281
- options: MutationOptions;
282
- output: ParagraphMutationResult;
283
- };
284
- 'format.paragraph.setBorder': {
285
- input: ParagraphsSetBorderInput;
286
- options: MutationOptions;
287
- output: ParagraphMutationResult;
288
- };
289
- 'format.paragraph.clearBorder': {
290
- input: ParagraphsClearBorderInput;
291
- options: MutationOptions;
292
- output: ParagraphMutationResult;
293
- };
294
- 'format.paragraph.setShading': {
295
- input: ParagraphsSetShadingInput;
296
- options: MutationOptions;
297
- output: ParagraphMutationResult;
298
- };
299
- 'format.paragraph.clearShading': {
300
- input: ParagraphsClearShadingInput;
301
- options: MutationOptions;
302
- output: ParagraphMutationResult;
303
- };
304
- 'format.paragraph.setMarkRunProps': {
305
- input: ParagraphsSetMarkRunPropsInput;
306
- options: MutationOptions;
307
- output: ParagraphMutationResult;
308
- };
309
- 'format.paragraph.setDirection': {
310
- input: ParagraphsSetDirectionInput;
311
- options: MutationOptions;
312
- output: ParagraphMutationResult;
313
- };
314
- 'format.paragraph.clearDirection': {
315
- input: ParagraphsClearDirectionInput;
316
- options: MutationOptions;
317
- output: ParagraphMutationResult;
318
- };
319
- 'format.paragraph.setNumbering': {
320
- input: ParagraphsSetNumberingInput;
321
- options: MutationOptions;
322
- output: ParagraphMutationResult;
323
- };
324
- 'styles.apply': {
325
- input: StylesApplyInput;
326
- options: StylesApplyOptions;
327
- output: StylesApplyReceipt;
328
- };
329
- 'styles.getCatalog': {
330
- input: StylesGetCatalogInput | undefined;
331
- options: never;
332
- output: StylesGetCatalogResult;
333
- };
334
- 'templates.apply': {
335
- input: TemplatesApplyInput;
336
- options: TemplatesApplyOptions;
337
- output: Promise<TemplatesApplyReceipt>;
338
- };
339
- 'create.paragraph': {
340
- input: CreateParagraphInput;
341
- options: MutationOptions;
342
- output: CreateParagraphResult;
343
- };
344
- 'create.heading': {
345
- input: CreateHeadingInput;
346
- options: MutationOptions;
347
- output: CreateHeadingResult;
348
- };
349
- 'create.sectionBreak': {
350
- input: CreateSectionBreakInput;
351
- options: MutationOptions;
352
- output: CreateSectionBreakResult;
353
- };
354
- 'lists.list': {
355
- input: ListsListQuery | undefined;
356
- options: never;
357
- output: ListsListResult;
358
- };
359
- 'lists.get': {
360
- input: ListsGetInput;
361
- options: never;
362
- output: ListItemInfo;
363
- };
364
- 'lists.insert': {
365
- input: ListInsertInput;
366
- options: MutationOptions;
367
- output: ListsInsertResult;
368
- };
369
- 'lists.create': {
370
- input: ListsCreateInput;
371
- options: MutationOptions;
372
- output: ListsCreateResult;
373
- };
374
- 'lists.attach': {
375
- input: ListsAttachInput;
376
- options: MutationOptions;
377
- output: ListsMutateItemResult;
378
- };
379
- 'lists.detach': {
380
- input: ListsDetachInput;
381
- options: MutationOptions;
382
- output: ListsDetachResult;
383
- };
384
- 'lists.delete': {
385
- input: ListsDeleteInput;
386
- options: MutationOptions;
387
- output: ListsDeleteResult;
388
- };
389
- 'lists.indent': {
390
- input: ListTargetInput;
391
- options: MutationOptions;
392
- output: ListsMutateItemResult;
393
- };
394
- 'lists.outdent': {
395
- input: ListTargetInput;
396
- options: MutationOptions;
397
- output: ListsMutateItemResult;
398
- };
399
- 'lists.join': {
400
- input: ListsJoinInput;
401
- options: MutationOptions;
402
- output: ListsJoinResult;
403
- };
404
- 'lists.canJoin': {
405
- input: ListsCanJoinInput;
406
- options: never;
407
- output: ListsCanJoinResult;
408
- };
409
- 'lists.separate': {
410
- input: ListsSeparateInput;
411
- options: MutationOptions;
412
- output: ListsSeparateResult;
413
- };
414
- 'lists.merge': {
415
- input: ListsMergeInput;
416
- options: MutationOptions;
417
- output: ListsMergeResult;
418
- };
419
- 'lists.split': {
420
- input: ListsSplitInput;
421
- options: MutationOptions;
422
- output: ListsSplitResult;
423
- };
424
- 'lists.setLevel': {
425
- input: ListsSetLevelInput;
426
- options: MutationOptions;
427
- output: ListsMutateItemResult;
428
- };
429
- 'lists.setValue': {
430
- input: ListsSetValueInput;
431
- options: MutationOptions;
432
- output: ListsMutateItemResult;
433
- };
434
- 'lists.continuePrevious': {
435
- input: ListsContinuePreviousInput;
436
- options: MutationOptions;
437
- output: ListsMutateItemResult;
438
- };
439
- 'lists.canContinuePrevious': {
440
- input: ListsCanContinuePreviousInput;
441
- options: never;
442
- output: ListsCanContinuePreviousResult;
443
- };
444
- 'lists.setLevelRestart': {
445
- input: ListsSetLevelRestartInput;
446
- options: MutationOptions;
447
- output: ListsMutateItemResult;
448
- };
449
- 'lists.convertToText': {
450
- input: ListsConvertToTextInput;
451
- options: MutationOptions;
452
- output: ListsConvertToTextResult;
453
- };
454
- 'lists.applyTemplate': {
455
- input: ListsApplyTemplateInput;
456
- options: MutationOptions;
457
- output: ListsMutateItemResult;
458
- };
459
- 'lists.applyPreset': {
460
- input: ListsApplyPresetInput;
461
- options: MutationOptions;
462
- output: ListsMutateItemResult;
463
- };
464
- 'lists.setType': {
465
- input: ListsSetTypeInput;
466
- options: MutationOptions;
467
- output: ListsMutateItemResult;
468
- };
469
- 'lists.captureTemplate': {
470
- input: ListsCaptureTemplateInput;
471
- options: never;
472
- output: ListsCaptureTemplateResult;
473
- };
474
- 'lists.setLevelNumbering': {
475
- input: ListsSetLevelNumberingInput;
476
- options: MutationOptions;
477
- output: ListsMutateItemResult;
478
- };
479
- 'lists.setLevelBullet': {
480
- input: ListsSetLevelBulletInput;
481
- options: MutationOptions;
482
- output: ListsMutateItemResult;
483
- };
484
- 'lists.setLevelPictureBullet': {
485
- input: ListsSetLevelPictureBulletInput;
486
- options: MutationOptions;
487
- output: ListsMutateItemResult;
488
- };
489
- 'lists.setLevelAlignment': {
490
- input: ListsSetLevelAlignmentInput;
491
- options: MutationOptions;
492
- output: ListsMutateItemResult;
493
- };
494
- 'lists.setLevelIndents': {
495
- input: ListsSetLevelIndentsInput;
496
- options: MutationOptions;
497
- output: ListsMutateItemResult;
498
- };
499
- 'lists.setLevelTrailingCharacter': {
500
- input: ListsSetLevelTrailingCharacterInput;
501
- options: MutationOptions;
502
- output: ListsMutateItemResult;
503
- };
504
- 'lists.setLevelMarkerFont': {
505
- input: ListsSetLevelMarkerFontInput;
506
- options: MutationOptions;
507
- output: ListsMutateItemResult;
508
- };
509
- 'lists.clearLevelOverrides': {
510
- input: ListsClearLevelOverridesInput;
511
- options: MutationOptions;
512
- output: ListsMutateItemResult;
513
- };
514
- 'lists.getStyle': {
515
- input: ListsGetStyleInput;
516
- options: never;
517
- output: ListsGetStyleResult;
518
- };
519
- 'lists.applyStyle': {
520
- input: ListsApplyStyleInput;
521
- options: MutationOptions;
522
- output: ListsMutateItemResult;
523
- };
524
- 'lists.restartAt': {
525
- input: ListsRestartAtInput;
526
- options: MutationOptions;
527
- output: ListsMutateItemResult;
528
- };
529
- 'lists.setLevelNumberStyle': {
530
- input: ListsSetLevelNumberStyleInput;
531
- options: MutationOptions;
532
- output: ListsMutateItemResult;
533
- };
534
- 'lists.setLevelText': {
535
- input: ListsSetLevelTextInput;
536
- options: MutationOptions;
537
- output: ListsMutateItemResult;
538
- };
539
- 'lists.setLevelStart': {
540
- input: ListsSetLevelStartInput;
541
- options: MutationOptions;
542
- output: ListsMutateItemResult;
543
- };
544
- 'lists.setLevelLayout': {
545
- input: ListsSetLevelLayoutInput;
546
- options: MutationOptions;
547
- output: ListsMutateItemResult;
548
- };
549
- 'lists.getState': {
550
- input: ListsGetStateInput;
551
- options: never;
552
- output: ListsGetStateResult;
553
- };
554
- 'lists.apply': {
555
- input: ListsApplyInput;
556
- options: MutationOptions;
557
- output: ListsMutateItemResult;
558
- };
559
- 'lists.continue': {
560
- input: ListsContinueV2Input;
561
- options: MutationOptions;
562
- output: ListsMutateItemResult;
563
- };
564
- 'lists.restart': {
565
- input: ListsRestartV2Input;
566
- options: MutationOptions;
567
- output: ListsMutateItemResult;
568
- };
569
- 'lists.remove': {
570
- input: ListsRemoveV2Input;
571
- options: MutationOptions;
572
- output: ListsMutateItemResult;
573
- };
574
- 'sections.list': {
575
- input: SectionsListQuery | undefined;
576
- options: never;
577
- output: SectionsListResult;
578
- };
579
- 'sections.get': {
580
- input: SectionsGetInput;
581
- options: never;
582
- output: SectionInfo;
583
- };
584
- 'sections.setBreakType': {
585
- input: SectionsSetBreakTypeInput;
586
- options: MutationOptions;
587
- output: SectionMutationResult;
588
- };
589
- 'sections.setPageMargins': {
590
- input: SectionsSetPageMarginsInput;
591
- options: MutationOptions;
592
- output: SectionMutationResult;
593
- };
594
- 'sections.setHeaderFooterMargins': {
595
- input: SectionsSetHeaderFooterMarginsInput;
596
- options: MutationOptions;
597
- output: SectionMutationResult;
598
- };
599
- 'sections.setPageSetup': {
600
- input: SectionsSetPageSetupInput;
601
- options: MutationOptions;
602
- output: SectionMutationResult;
603
- };
604
- 'sections.setColumns': {
605
- input: SectionsSetColumnsInput;
606
- options: MutationOptions;
607
- output: SectionMutationResult;
608
- };
609
- 'sections.setLineNumbering': {
610
- input: SectionsSetLineNumberingInput;
611
- options: MutationOptions;
612
- output: SectionMutationResult;
613
- };
614
- 'sections.setPageNumbering': {
615
- input: SectionsSetPageNumberingInput;
616
- options: MutationOptions;
617
- output: SectionMutationResult;
618
- };
619
- 'sections.setTitlePage': {
620
- input: SectionsSetTitlePageInput;
621
- options: MutationOptions;
622
- output: SectionMutationResult;
623
- };
624
- 'sections.setOddEvenHeadersFooters': {
625
- input: SectionsSetOddEvenHeadersFootersInput;
626
- options: MutationOptions;
627
- output: DocumentMutationResult;
628
- };
629
- 'sections.setVerticalAlign': {
630
- input: SectionsSetVerticalAlignInput;
631
- options: MutationOptions;
632
- output: SectionMutationResult;
633
- };
634
- 'sections.setSectionDirection': {
635
- input: SectionsSetSectionDirectionInput;
636
- options: MutationOptions;
637
- output: SectionMutationResult;
638
- };
639
- 'sections.setHeaderFooterRef': {
640
- input: SectionsSetHeaderFooterRefInput;
641
- options: MutationOptions;
642
- output: SectionMutationResult;
643
- };
644
- 'sections.clearHeaderFooterRef': {
645
- input: SectionsClearHeaderFooterRefInput;
646
- options: MutationOptions;
647
- output: SectionMutationResult;
648
- };
649
- 'sections.setLinkToPrevious': {
650
- input: SectionsSetLinkToPreviousInput;
651
- options: MutationOptions;
652
- output: SectionMutationResult;
653
- };
654
- 'sections.setPageBorders': {
655
- input: SectionsSetPageBordersInput;
656
- options: MutationOptions;
657
- output: SectionMutationResult;
658
- };
659
- 'sections.clearPageBorders': {
660
- input: SectionsClearPageBordersInput;
661
- options: MutationOptions;
662
- output: SectionMutationResult;
663
- };
664
- 'comments.create': {
665
- input: CommentsCreateInput;
666
- options: RevisionGuardOptions;
667
- output: CommentsCreateReceipt;
668
- };
669
- 'comments.patch': {
670
- input: CommentsPatchInput;
671
- options: RevisionGuardOptions;
672
- output: Receipt;
673
- };
674
- 'comments.delete': {
675
- input: CommentsDeleteInput;
676
- options: RevisionGuardOptions;
677
- output: Receipt;
678
- };
679
- 'comments.get': {
680
- input: GetCommentInput;
681
- options: never;
682
- output: CommentInfo;
683
- };
684
- 'comments.list': {
685
- input: CommentsListQuery | undefined;
686
- options: never;
687
- output: CommentsListResult;
688
- };
689
- 'trackChanges.list': {
690
- input: TrackChangesListInput | undefined;
691
- options: never;
692
- output: TrackChangesListResult;
693
- };
694
- 'trackChanges.get': {
695
- input: TrackChangesGetInput;
696
- options: never;
697
- output: TrackChangeInfo;
698
- };
699
- 'trackChanges.decide': {
700
- input: ReviewDecideInput;
701
- options: RevisionGuardOptions;
702
- output: Receipt;
703
- };
704
- 'query.match': {
705
- input: QueryMatchInput;
706
- options: never;
707
- output: QueryMatchOutput;
708
- };
709
- 'ranges.resolve': {
710
- input: ResolveRangeInput;
711
- options: never;
712
- output: ResolveRangeOutput;
713
- };
714
- 'selection.current': {
715
- input: SelectionCurrentInput | undefined;
716
- options: never;
717
- output: SelectionInfo;
718
- };
719
- 'mutations.preview': {
720
- input: MutationsPreviewInput;
721
- options: never;
722
- output: MutationsPreviewOutput;
723
- };
724
- 'mutations.apply': {
725
- input: MutationsApplyInput;
726
- options: never;
727
- output: PlanReceipt;
728
- };
729
- 'plan.execute': {
730
- input: PlanExecuteInput;
731
- options: never;
732
- output: PlanExecuteResult;
733
- };
734
- 'capabilities.get': {
735
- input: undefined;
736
- options: never;
737
- output: DocumentApiCapabilities;
738
- };
739
- 'capabilities.check': {
740
- input: SDHtmlMarkdownSupportCheckInput;
741
- options: never;
742
- output: Promise<SDHtmlMarkdownSupportCheckResult>;
743
- };
744
- 'history.get': {
745
- input: undefined;
746
- options: never;
747
- output: HistoryState;
748
- };
749
- 'history.undo': {
750
- input: undefined;
751
- options: never;
752
- output: HistoryActionResult;
753
- };
754
- 'history.redo': {
755
- input: undefined;
756
- options: never;
757
- output: HistoryActionResult;
758
- };
759
- 'create.table': {
760
- input: CreateTableInput;
761
- options: MutationOptions;
762
- output: CreateTableResult;
763
- };
764
- 'tables.convertFromText': {
765
- input: TablesConvertFromTextInput;
766
- options: MutationOptions;
767
- output: TableMutationResult;
768
- };
769
- 'tables.delete': {
770
- input: TableLocator;
771
- options: MutationOptions;
772
- output: TableMutationResult;
773
- };
774
- 'tables.clearContents': {
775
- input: TableLocator;
776
- options: MutationOptions;
777
- output: TableMutationResult;
778
- };
779
- 'tables.move': {
780
- input: TablesMoveInput;
781
- options: MutationOptions;
782
- output: TableMutationResult;
783
- };
784
- 'tables.split': {
785
- input: TablesSplitInput;
786
- options: MutationOptions;
787
- output: TableMutationResult;
788
- };
789
- 'tables.convertToText': {
790
- input: TablesConvertToTextInput;
791
- options: MutationOptions;
792
- output: TableMutationResult;
793
- };
794
- 'tables.setLayout': {
795
- input: TablesSetLayoutInput;
796
- options: MutationOptions;
797
- output: TableMutationResult;
798
- };
799
- 'tables.insertRow': {
800
- input: TablesInsertRowInput;
801
- options: MutationOptions;
802
- output: TableMutationResult;
803
- };
804
- 'tables.deleteRow': {
805
- input: TablesDeleteRowInput;
806
- options: MutationOptions;
807
- output: TableMutationResult;
808
- };
809
- 'tables.moveRow': {
810
- input: TablesMoveRowInput;
811
- options: MutationOptions;
812
- output: TableMutationResult;
813
- };
814
- 'tables.setRowHeight': {
815
- input: TablesSetRowHeightInput;
816
- options: MutationOptions;
817
- output: TableMutationResult;
818
- };
819
- 'tables.distributeRows': {
820
- input: TablesDistributeRowsInput;
821
- options: MutationOptions;
822
- output: TableMutationResult;
823
- };
824
- 'tables.setRowOptions': {
825
- input: TablesSetRowOptionsInput;
826
- options: MutationOptions;
827
- output: TableMutationResult;
828
- };
829
- 'tables.insertColumn': {
830
- input: TablesInsertColumnInput;
831
- options: MutationOptions;
832
- output: TableMutationResult;
833
- };
834
- 'tables.deleteColumn': {
835
- input: TablesDeleteColumnInput;
836
- options: MutationOptions;
837
- output: TableMutationResult;
838
- };
839
- 'tables.moveColumn': {
840
- input: TablesMoveColumnInput;
841
- options: MutationOptions;
842
- output: TableMutationResult;
843
- };
844
- 'tables.setColumnWidth': {
845
- input: TablesSetColumnWidthInput;
846
- options: MutationOptions;
847
- output: TableMutationResult;
848
- };
849
- 'tables.distributeColumns': {
850
- input: TablesDistributeColumnsInput;
851
- options: MutationOptions;
852
- output: TableMutationResult;
853
- };
854
- 'tables.insertCell': {
855
- input: TablesInsertCellInput;
856
- options: MutationOptions;
857
- output: TableMutationResult;
858
- };
859
- 'tables.deleteCell': {
860
- input: TablesDeleteCellInput;
861
- options: MutationOptions;
862
- output: TableMutationResult;
863
- };
864
- 'tables.mergeCells': {
865
- input: TablesMergeCellsInput;
866
- options: MutationOptions;
867
- output: TableMutationResult;
868
- };
869
- 'tables.unmergeCells': {
870
- input: TablesUnmergeCellsInput;
871
- options: MutationOptions;
872
- output: TableMutationResult;
873
- };
874
- 'tables.splitCell': {
875
- input: TablesSplitCellInput;
876
- options: MutationOptions;
877
- output: TableMutationResult;
878
- };
879
- 'tables.setCellProperties': {
880
- input: TablesSetCellPropertiesInput;
881
- options: MutationOptions;
882
- output: TableMutationResult;
883
- };
884
- 'tables.setCellText': {
885
- input: TablesSetCellTextInput;
886
- options: MutationOptions;
887
- output: TableMutationResult;
888
- };
889
- 'tables.sort': {
890
- input: TablesSortInput;
891
- options: MutationOptions;
892
- output: TableMutationResult;
893
- };
894
- 'tables.setAltText': {
895
- input: TablesSetAltTextInput;
896
- options: MutationOptions;
897
- output: TableMutationResult;
898
- };
899
- 'tables.setStyle': {
900
- input: TablesSetStyleInput;
901
- options: MutationOptions;
902
- output: TableMutationResult;
903
- };
904
- 'tables.clearStyle': {
905
- input: TablesClearStyleInput;
906
- options: MutationOptions;
907
- output: TableMutationResult;
908
- };
909
- 'tables.setStyleOption': {
910
- input: TablesSetStyleOptionInput;
911
- options: MutationOptions;
912
- output: TableMutationResult;
913
- };
914
- 'tables.setBorder': {
915
- input: TablesSetBorderInput;
916
- options: MutationOptions;
917
- output: TableMutationResult;
918
- };
919
- 'tables.clearBorder': {
920
- input: TablesClearBorderInput;
921
- options: MutationOptions;
922
- output: TableMutationResult;
923
- };
924
- 'tables.applyBorderPreset': {
925
- input: TablesApplyBorderPresetInput;
926
- options: MutationOptions;
927
- output: TableMutationResult;
928
- };
929
- 'tables.setShading': {
930
- input: TablesSetShadingInput;
931
- options: MutationOptions;
932
- output: TableMutationResult;
933
- };
934
- 'tables.clearShading': {
935
- input: TablesClearShadingInput;
936
- options: MutationOptions;
937
- output: TableMutationResult;
938
- };
939
- 'tables.setTablePadding': {
940
- input: TablesSetTablePaddingInput;
941
- options: MutationOptions;
942
- output: TableMutationResult;
943
- };
944
- 'tables.setCellPadding': {
945
- input: TablesSetCellPaddingInput;
946
- options: MutationOptions;
947
- output: TableMutationResult;
948
- };
949
- 'tables.setCellSpacing': {
950
- input: TablesSetCellSpacingInput;
951
- options: MutationOptions;
952
- output: TableMutationResult;
953
- };
954
- 'tables.clearCellSpacing': {
955
- input: TablesClearCellSpacingInput;
956
- options: MutationOptions;
957
- output: TableMutationResult;
958
- };
959
- 'tables.applyStyle': {
960
- input: TablesApplyStyleInput;
961
- options: MutationOptions;
962
- output: TableMutationResult;
963
- };
964
- 'tables.setBorders': {
965
- input: TablesSetBordersInput;
966
- options: MutationOptions;
967
- output: TableMutationResult;
968
- };
969
- 'tables.setTableOptions': {
970
- input: TablesSetTableOptionsInput;
971
- options: MutationOptions;
972
- output: TableMutationResult;
973
- };
974
- 'tables.applyPreset': {
975
- input: TablesApplyPresetInput;
976
- options: MutationOptions;
977
- output: TableMutationResult;
978
- };
979
- 'tables.get': {
980
- input: TablesGetInput;
981
- options: never;
982
- output: TablesGetOutput;
983
- };
984
- 'tables.getCells': {
985
- input: TablesGetCellsInput;
986
- options: never;
987
- output: TablesGetCellsOutput;
988
- };
989
- 'tables.getProperties': {
990
- input: TablesGetPropertiesInput;
991
- options: never;
992
- output: TablesGetPropertiesOutput;
993
- };
994
- 'tables.getStyles': {
995
- input: TablesGetStylesInput | undefined;
996
- options: never;
997
- output: TablesGetStylesOutput;
998
- };
999
- 'tables.setDefaultStyle': {
1000
- input: TablesSetDefaultStyleInput;
1001
- options: MutationOptions;
1002
- output: DocumentMutationResult;
1003
- };
1004
- 'tables.clearDefaultStyle': {
1005
- input: TablesClearDefaultStyleInput | undefined;
1006
- options: MutationOptions;
1007
- output: DocumentMutationResult;
1008
- };
1009
- 'create.tableOfContents': {
1010
- input: CreateTableOfContentsInput;
1011
- options: MutationOptions;
1012
- output: CreateTableOfContentsResult;
1013
- };
1014
- 'toc.list': {
1015
- input: TocListQuery | undefined;
1016
- options: never;
1017
- output: TocListResult;
1018
- };
1019
- 'toc.get': {
1020
- input: TocGetInput;
1021
- options: never;
1022
- output: TocInfo;
1023
- };
1024
- 'toc.configure': {
1025
- input: TocConfigureInput;
1026
- options: MutationOptions;
1027
- output: TocMutationResult;
1028
- };
1029
- 'toc.update': {
1030
- input: TocUpdateInput;
1031
- options: MutationOptions;
1032
- output: TocMutationResult;
1033
- };
1034
- 'toc.remove': {
1035
- input: TocRemoveInput;
1036
- options: MutationOptions;
1037
- output: TocMutationResult;
1038
- };
1039
- 'toc.markEntry': {
1040
- input: TocMarkEntryInput;
1041
- options: MutationOptions;
1042
- output: TocEntryMutationResult;
1043
- };
1044
- 'toc.unmarkEntry': {
1045
- input: TocUnmarkEntryInput;
1046
- options: MutationOptions;
1047
- output: TocEntryMutationResult;
1048
- };
1049
- 'toc.listEntries': {
1050
- input: TocListEntriesQuery | undefined;
1051
- options: never;
1052
- output: TocListEntriesResult;
1053
- };
1054
- 'toc.getEntry': {
1055
- input: TocGetEntryInput;
1056
- options: never;
1057
- output: TocEntryInfo;
1058
- };
1059
- 'toc.editEntry': {
1060
- input: TocEditEntryInput;
1061
- options: MutationOptions;
1062
- output: TocEntryMutationResult;
1063
- };
1064
- 'create.image': {
1065
- input: CreateImageInput;
1066
- options: MutationOptions;
1067
- output: CreateImageResult;
1068
- };
1069
- 'images.list': {
1070
- input: ImagesListInput | undefined;
1071
- options: never;
1072
- output: ImagesListResult;
1073
- };
1074
- 'images.get': {
1075
- input: ImagesGetInput;
1076
- options: never;
1077
- output: ImageSummary;
1078
- };
1079
- 'images.delete': {
1080
- input: ImagesDeleteInput;
1081
- options: MutationOptions;
1082
- output: ImagesMutationResult;
1083
- };
1084
- 'images.move': {
1085
- input: MoveImageInput;
1086
- options: MutationOptions;
1087
- output: ImagesMutationResult;
1088
- };
1089
- 'images.convertToInline': {
1090
- input: ConvertToInlineInput;
1091
- options: MutationOptions;
1092
- output: ImagesMutationResult;
1093
- };
1094
- 'images.convertToFloating': {
1095
- input: ConvertToFloatingInput;
1096
- options: MutationOptions;
1097
- output: ImagesMutationResult;
1098
- };
1099
- 'images.setSize': {
1100
- input: SetSizeInput;
1101
- options: MutationOptions;
1102
- output: ImagesMutationResult;
1103
- };
1104
- 'images.setWrapType': {
1105
- input: SetWrapTypeInput;
1106
- options: MutationOptions;
1107
- output: ImagesMutationResult;
1108
- };
1109
- 'images.setWrapSide': {
1110
- input: SetWrapSideInput;
1111
- options: MutationOptions;
1112
- output: ImagesMutationResult;
1113
- };
1114
- 'images.setWrapDistances': {
1115
- input: SetWrapDistancesInput;
1116
- options: MutationOptions;
1117
- output: ImagesMutationResult;
1118
- };
1119
- 'images.setPosition': {
1120
- input: SetPositionInput;
1121
- options: MutationOptions;
1122
- output: ImagesMutationResult;
1123
- };
1124
- 'images.setAnchorOptions': {
1125
- input: SetAnchorOptionsInput;
1126
- options: MutationOptions;
1127
- output: ImagesMutationResult;
1128
- };
1129
- 'images.setZOrder': {
1130
- input: SetZOrderInput;
1131
- options: MutationOptions;
1132
- output: ImagesMutationResult;
1133
- };
1134
- 'images.scale': {
1135
- input: ScaleInput;
1136
- options: MutationOptions;
1137
- output: ImagesMutationResult;
1138
- };
1139
- 'images.setLockAspectRatio': {
1140
- input: SetLockAspectRatioInput;
1141
- options: MutationOptions;
1142
- output: ImagesMutationResult;
1143
- };
1144
- 'images.rotate': {
1145
- input: RotateInput;
1146
- options: MutationOptions;
1147
- output: ImagesMutationResult;
1148
- };
1149
- 'images.flip': {
1150
- input: FlipInput;
1151
- options: MutationOptions;
1152
- output: ImagesMutationResult;
1153
- };
1154
- 'images.crop': {
1155
- input: CropInput;
1156
- options: MutationOptions;
1157
- output: ImagesMutationResult;
1158
- };
1159
- 'images.resetCrop': {
1160
- input: ResetCropInput;
1161
- options: MutationOptions;
1162
- output: ImagesMutationResult;
1163
- };
1164
- 'images.replaceSource': {
1165
- input: ReplaceSourceInput;
1166
- options: MutationOptions;
1167
- output: ImagesMutationResult;
1168
- };
1169
- 'images.setAltText': {
1170
- input: SetAltTextInput;
1171
- options: MutationOptions;
1172
- output: ImagesMutationResult;
1173
- };
1174
- 'images.setDecorative': {
1175
- input: SetDecorativeInput;
1176
- options: MutationOptions;
1177
- output: ImagesMutationResult;
1178
- };
1179
- 'images.setName': {
1180
- input: SetNameInput;
1181
- options: MutationOptions;
1182
- output: ImagesMutationResult;
1183
- };
1184
- 'images.setHyperlink': {
1185
- input: SetHyperlinkInput;
1186
- options: MutationOptions;
1187
- output: ImagesMutationResult;
1188
- };
1189
- 'images.insertCaption': {
1190
- input: InsertCaptionInput;
1191
- options: MutationOptions;
1192
- output: ImagesMutationResult;
1193
- };
1194
- 'images.updateCaption': {
1195
- input: UpdateCaptionInput;
1196
- options: MutationOptions;
1197
- output: ImagesMutationResult;
1198
- };
1199
- 'images.removeCaption': {
1200
- input: RemoveCaptionInput;
1201
- options: MutationOptions;
1202
- output: ImagesMutationResult;
1203
- };
1204
- 'hyperlinks.list': {
1205
- input: HyperlinksListQuery | undefined;
1206
- options: never;
1207
- output: HyperlinksListResult;
1208
- };
1209
- 'hyperlinks.get': {
1210
- input: HyperlinksGetInput;
1211
- options: never;
1212
- output: HyperlinkInfo;
1213
- };
1214
- 'hyperlinks.wrap': {
1215
- input: HyperlinksWrapInput;
1216
- options: MutationOptions;
1217
- output: HyperlinkMutationResult;
1218
- };
1219
- 'hyperlinks.insert': {
1220
- input: HyperlinksInsertInput;
1221
- options: MutationOptions;
1222
- output: HyperlinkMutationResult;
1223
- };
1224
- 'hyperlinks.patch': {
1225
- input: HyperlinksPatchInput;
1226
- options: MutationOptions;
1227
- output: HyperlinkMutationResult;
1228
- };
1229
- 'hyperlinks.remove': {
1230
- input: HyperlinksRemoveInput;
1231
- options: MutationOptions;
1232
- output: HyperlinkMutationResult;
1233
- };
1234
- 'headerFooters.list': {
1235
- input: HeaderFootersListQuery | undefined;
1236
- options: never;
1237
- output: HeaderFootersListResult;
1238
- };
1239
- 'headerFooters.get': {
1240
- input: HeaderFootersGetInput;
1241
- options: never;
1242
- output: HeaderFooterSlotEntry;
1243
- };
1244
- 'headerFooters.resolve': {
1245
- input: HeaderFootersResolveInput;
1246
- options: never;
1247
- output: HeaderFooterResolveResult;
1248
- };
1249
- 'headerFooters.refs.set': {
1250
- input: HeaderFootersRefsSetInput;
1251
- options: MutationOptions;
1252
- output: SectionMutationResult;
1253
- };
1254
- 'headerFooters.refs.clear': {
1255
- input: HeaderFootersRefsClearInput;
1256
- options: MutationOptions;
1257
- output: SectionMutationResult;
1258
- };
1259
- 'headerFooters.refs.setLinkedToPrevious': {
1260
- input: HeaderFootersRefsSetLinkedToPreviousInput;
1261
- options: MutationOptions;
1262
- output: SectionMutationResult;
1263
- };
1264
- 'headerFooters.parts.list': {
1265
- input: HeaderFootersPartsListQuery | undefined;
1266
- options: never;
1267
- output: HeaderFootersPartsListResult;
1268
- };
1269
- 'headerFooters.parts.create': {
1270
- input: HeaderFootersPartsCreateInput;
1271
- options: MutationOptions;
1272
- output: HeaderFooterPartsMutationResult;
1273
- };
1274
- 'headerFooters.parts.delete': {
1275
- input: HeaderFootersPartsDeleteInput;
1276
- options: MutationOptions;
1277
- output: HeaderFooterPartsMutationResult;
1278
- };
1279
- 'watermarks.list': {
1280
- input: WatermarksListQuery | undefined;
1281
- options: never;
1282
- output: WatermarksListResult;
1283
- };
1284
- 'watermarks.insert': {
1285
- input: WatermarksInsertInput;
1286
- options: MutationOptions;
1287
- output: WatermarkMutationResult;
1288
- };
1289
- 'watermarks.replace': {
1290
- input: WatermarksReplaceInput;
1291
- options: MutationOptions;
1292
- output: WatermarkMutationResult;
1293
- };
1294
- 'watermarks.remove': {
1295
- input: WatermarksRemoveInput;
1296
- options: MutationOptions;
1297
- output: WatermarkRemoveResult;
1298
- };
1299
- 'create.contentControl': {
1300
- input: CreateContentControlInput;
1301
- options: MutationOptions;
1302
- output: ContentControlMutationResult;
1303
- };
1304
- 'contentControls.list': {
1305
- input: ContentControlsListQuery | undefined;
1306
- options: never;
1307
- output: ContentControlsListResult;
1308
- };
1309
- 'contentControls.get': {
1310
- input: ContentControlsGetInput;
1311
- options: never;
1312
- output: ContentControlInfo;
1313
- };
1314
- 'contentControls.listInRange': {
1315
- input: ContentControlsListInRangeInput;
1316
- options: never;
1317
- output: ContentControlsListResult;
1318
- };
1319
- 'contentControls.selectByTag': {
1320
- input: ContentControlsSelectByTagInput;
1321
- options: never;
1322
- output: ContentControlsListResult;
1323
- };
1324
- 'contentControls.selectByTitle': {
1325
- input: ContentControlsSelectByTitleInput;
1326
- options: never;
1327
- output: ContentControlsListResult;
1328
- };
1329
- 'contentControls.listChildren': {
1330
- input: ContentControlsListChildrenInput;
1331
- options: never;
1332
- output: ContentControlsListResult;
1333
- };
1334
- 'contentControls.getParent': {
1335
- input: ContentControlsGetParentInput;
1336
- options: never;
1337
- output: ContentControlInfo | null;
1338
- };
1339
- 'contentControls.wrap': {
1340
- input: ContentControlsWrapInput;
1341
- options: MutationOptions;
1342
- output: ContentControlMutationResult;
1343
- };
1344
- 'contentControls.unwrap': {
1345
- input: ContentControlsUnwrapInput;
1346
- options: MutationOptions;
1347
- output: ContentControlMutationResult;
1348
- };
1349
- 'contentControls.delete': {
1350
- input: ContentControlsDeleteInput;
1351
- options: MutationOptions;
1352
- output: ContentControlMutationResult;
1353
- };
1354
- 'contentControls.copy': {
1355
- input: ContentControlsCopyInput;
1356
- options: MutationOptions;
1357
- output: ContentControlMutationResult;
1358
- };
1359
- 'contentControls.move': {
1360
- input: ContentControlsMoveInput;
1361
- options: MutationOptions;
1362
- output: ContentControlMutationResult;
1363
- };
1364
- 'contentControls.patch': {
1365
- input: ContentControlsPatchInput;
1366
- options: MutationOptions;
1367
- output: ContentControlMutationResult;
1368
- };
1369
- 'contentControls.setLockMode': {
1370
- input: ContentControlsSetLockModeInput;
1371
- options: MutationOptions;
1372
- output: ContentControlMutationResult;
1373
- };
1374
- 'contentControls.setType': {
1375
- input: ContentControlsSetTypeInput;
1376
- options: MutationOptions;
1377
- output: ContentControlMutationResult;
1378
- };
1379
- 'contentControls.getContent': {
1380
- input: ContentControlsGetContentInput;
1381
- options: never;
1382
- output: ContentControlsGetContentResult;
1383
- };
1384
- 'contentControls.replaceContent': {
1385
- input: ContentControlsReplaceContentInput;
1386
- options: MutationOptions;
1387
- output: ContentControlMutationResult;
1388
- };
1389
- 'contentControls.clearContent': {
1390
- input: ContentControlsClearContentInput;
1391
- options: MutationOptions;
1392
- output: ContentControlMutationResult;
1393
- };
1394
- 'contentControls.appendContent': {
1395
- input: ContentControlsAppendContentInput;
1396
- options: MutationOptions;
1397
- output: ContentControlMutationResult;
1398
- };
1399
- 'contentControls.prependContent': {
1400
- input: ContentControlsPrependContentInput;
1401
- options: MutationOptions;
1402
- output: ContentControlMutationResult;
1403
- };
1404
- 'contentControls.insertBefore': {
1405
- input: ContentControlsInsertBeforeInput;
1406
- options: MutationOptions;
1407
- output: ContentControlMutationResult;
1408
- };
1409
- 'contentControls.insertAfter': {
1410
- input: ContentControlsInsertAfterInput;
1411
- options: MutationOptions;
1412
- output: ContentControlMutationResult;
1413
- };
1414
- 'contentControls.getBinding': {
1415
- input: ContentControlsGetBindingInput;
1416
- options: never;
1417
- output: ContentControlBinding | null;
1418
- };
1419
- 'contentControls.setBinding': {
1420
- input: ContentControlsSetBindingInput;
1421
- options: MutationOptions;
1422
- output: ContentControlMutationResult;
1423
- };
1424
- 'contentControls.clearBinding': {
1425
- input: ContentControlsClearBindingInput;
1426
- options: MutationOptions;
1427
- output: ContentControlMutationResult;
1428
- };
1429
- 'contentControls.getRawProperties': {
1430
- input: ContentControlsGetRawPropertiesInput;
1431
- options: never;
1432
- output: ContentControlsGetRawPropertiesResult;
1433
- };
1434
- 'contentControls.patchRawProperties': {
1435
- input: ContentControlsPatchRawPropertiesInput;
1436
- options: MutationOptions;
1437
- output: ContentControlMutationResult;
1438
- };
1439
- 'contentControls.validateWordCompatibility': {
1440
- input: ContentControlsValidateWordCompatibilityInput;
1441
- options: never;
1442
- output: ContentControlsValidateWordCompatibilityResult;
1443
- };
1444
- 'contentControls.normalizeWordCompatibility': {
1445
- input: ContentControlsNormalizeWordCompatibilityInput;
1446
- options: MutationOptions;
1447
- output: ContentControlMutationResult;
1448
- };
1449
- 'contentControls.normalizeTagPayload': {
1450
- input: ContentControlsNormalizeTagPayloadInput;
1451
- options: MutationOptions;
1452
- output: ContentControlMutationResult;
1453
- };
1454
- 'contentControls.text.setMultiline': {
1455
- input: ContentControlsTextSetMultilineInput;
1456
- options: MutationOptions;
1457
- output: ContentControlMutationResult;
1458
- };
1459
- 'contentControls.text.setValue': {
1460
- input: ContentControlsTextSetValueInput;
1461
- options: MutationOptions;
1462
- output: ContentControlMutationResult;
1463
- };
1464
- 'contentControls.text.clearValue': {
1465
- input: ContentControlsTextClearValueInput;
1466
- options: MutationOptions;
1467
- output: ContentControlMutationResult;
1468
- };
1469
- 'contentControls.date.setValue': {
1470
- input: ContentControlsDateSetValueInput;
1471
- options: MutationOptions;
1472
- output: ContentControlMutationResult;
1473
- };
1474
- 'contentControls.date.clearValue': {
1475
- input: ContentControlsDateClearValueInput;
1476
- options: MutationOptions;
1477
- output: ContentControlMutationResult;
1478
- };
1479
- 'contentControls.date.setDisplayFormat': {
1480
- input: ContentControlsDateSetDisplayFormatInput;
1481
- options: MutationOptions;
1482
- output: ContentControlMutationResult;
1483
- };
1484
- 'contentControls.date.setDisplayLocale': {
1485
- input: ContentControlsDateSetDisplayLocaleInput;
1486
- options: MutationOptions;
1487
- output: ContentControlMutationResult;
1488
- };
1489
- 'contentControls.date.setStorageFormat': {
1490
- input: ContentControlsDateSetStorageFormatInput;
1491
- options: MutationOptions;
1492
- output: ContentControlMutationResult;
1493
- };
1494
- 'contentControls.date.setCalendar': {
1495
- input: ContentControlsDateSetCalendarInput;
1496
- options: MutationOptions;
1497
- output: ContentControlMutationResult;
1498
- };
1499
- 'contentControls.checkbox.getState': {
1500
- input: ContentControlsCheckboxGetStateInput;
1501
- options: never;
1502
- output: ContentControlsCheckboxGetStateResult;
1503
- };
1504
- 'contentControls.checkbox.setState': {
1505
- input: ContentControlsCheckboxSetStateInput;
1506
- options: MutationOptions;
1507
- output: ContentControlMutationResult;
1508
- };
1509
- 'contentControls.checkbox.toggle': {
1510
- input: ContentControlsCheckboxToggleInput;
1511
- options: MutationOptions;
1512
- output: ContentControlMutationResult;
1513
- };
1514
- 'contentControls.checkbox.setSymbolPair': {
1515
- input: ContentControlsCheckboxSetSymbolPairInput;
1516
- options: MutationOptions;
1517
- output: ContentControlMutationResult;
1518
- };
1519
- 'contentControls.choiceList.getItems': {
1520
- input: ContentControlsChoiceListGetItemsInput;
1521
- options: never;
1522
- output: ContentControlsChoiceListGetItemsResult;
1523
- };
1524
- 'contentControls.choiceList.setItems': {
1525
- input: ContentControlsChoiceListSetItemsInput;
1526
- options: MutationOptions;
1527
- output: ContentControlMutationResult;
1528
- };
1529
- 'contentControls.choiceList.setSelected': {
1530
- input: ContentControlsChoiceListSetSelectedInput;
1531
- options: MutationOptions;
1532
- output: ContentControlMutationResult;
1533
- };
1534
- 'contentControls.repeatingSection.listItems': {
1535
- input: ContentControlsRepeatingSectionListItemsInput;
1536
- options: never;
1537
- output: ContentControlsRepeatingSectionListItemsResult;
1538
- };
1539
- 'contentControls.repeatingSection.insertItemBefore': {
1540
- input: ContentControlsRepeatingSectionInsertItemBeforeInput;
1541
- options: MutationOptions;
1542
- output: ContentControlMutationResult;
1543
- };
1544
- 'contentControls.repeatingSection.insertItemAfter': {
1545
- input: ContentControlsRepeatingSectionInsertItemAfterInput;
1546
- options: MutationOptions;
1547
- output: ContentControlMutationResult;
1548
- };
1549
- 'contentControls.repeatingSection.cloneItem': {
1550
- input: ContentControlsRepeatingSectionCloneItemInput;
1551
- options: MutationOptions;
1552
- output: ContentControlMutationResult;
1553
- };
1554
- 'contentControls.repeatingSection.deleteItem': {
1555
- input: ContentControlsRepeatingSectionDeleteItemInput;
1556
- options: MutationOptions;
1557
- output: ContentControlMutationResult;
1558
- };
1559
- 'contentControls.repeatingSection.setAllowInsertDelete': {
1560
- input: ContentControlsRepeatingSectionSetAllowInsertDeleteInput;
1561
- options: MutationOptions;
1562
- output: ContentControlMutationResult;
1563
- };
1564
- 'contentControls.group.wrap': {
1565
- input: ContentControlsGroupWrapInput;
1566
- options: MutationOptions;
1567
- output: ContentControlMutationResult;
1568
- };
1569
- 'contentControls.group.ungroup': {
1570
- input: ContentControlsGroupUngroupInput;
1571
- options: MutationOptions;
1572
- output: ContentControlMutationResult;
1573
- };
1574
- 'bookmarks.list': {
1575
- input: BookmarkListInput | undefined;
1576
- options: never;
1577
- output: BookmarksListResult;
1578
- };
1579
- 'bookmarks.get': {
1580
- input: BookmarkGetInput;
1581
- options: never;
1582
- output: BookmarkInfo;
1583
- };
1584
- 'bookmarks.insert': {
1585
- input: BookmarkInsertInput;
1586
- options: MutationOptions;
1587
- output: BookmarkMutationResult;
1588
- };
1589
- 'bookmarks.rename': {
1590
- input: BookmarkRenameInput;
1591
- options: MutationOptions;
1592
- output: BookmarkMutationResult;
1593
- };
1594
- 'bookmarks.remove': {
1595
- input: BookmarkRemoveInput;
1596
- options: MutationOptions;
1597
- output: BookmarkMutationResult;
1598
- };
1599
- 'footnotes.list': {
1600
- input: FootnoteListInput | undefined;
1601
- options: never;
1602
- output: FootnotesListResult;
1603
- };
1604
- 'footnotes.get': {
1605
- input: FootnoteGetInput;
1606
- options: never;
1607
- output: FootnoteInfo;
1608
- };
1609
- 'footnotes.insert': {
1610
- input: FootnoteInsertInput;
1611
- options: MutationOptions;
1612
- output: FootnoteMutationResult;
1613
- };
1614
- 'footnotes.update': {
1615
- input: FootnoteUpdateInput;
1616
- options: MutationOptions;
1617
- output: FootnoteMutationResult;
1618
- };
1619
- 'footnotes.remove': {
1620
- input: FootnoteRemoveInput;
1621
- options: MutationOptions;
1622
- output: FootnoteMutationResult;
1623
- };
1624
- 'footnotes.configure': {
1625
- input: FootnoteConfigureInput;
1626
- options: MutationOptions;
1627
- output: FootnoteConfigResult;
1628
- };
1629
- 'clipboard.parse': {
1630
- input: ClipboardPayload;
1631
- options: ClipboardParseOptions;
1632
- output: ClipboardParseResult;
1633
- };
1634
- 'clipboard.insert': {
1635
- input: ClipboardInsertInput;
1636
- options: MutationOptions;
1637
- output: ClipboardInsertResult;
1638
- };
1639
- 'clipboard.serializeSelection': {
1640
- input: ClipboardSerializeInput | undefined;
1641
- options: never;
1642
- output: ClipboardSerializeResult;
1643
- };
1644
- 'crossRefs.list': {
1645
- input: CrossRefListInput | undefined;
1646
- options: never;
1647
- output: CrossRefsListResult;
1648
- };
1649
- 'crossRefs.get': {
1650
- input: CrossRefGetInput;
1651
- options: never;
1652
- output: CrossRefInfo;
1653
- };
1654
- 'crossRefs.insert': {
1655
- input: CrossRefInsertInput;
1656
- options: MutationOptions;
1657
- output: CrossRefMutationResult;
1658
- };
1659
- 'crossRefs.rebuild': {
1660
- input: CrossRefRebuildInput;
1661
- options: MutationOptions;
1662
- output: CrossRefMutationResult;
1663
- };
1664
- 'crossRefs.remove': {
1665
- input: CrossRefRemoveInput;
1666
- options: MutationOptions;
1667
- output: CrossRefMutationResult;
1668
- };
1669
- 'index.list': {
1670
- input: IndexListInput | undefined;
1671
- options: never;
1672
- output: IndexListResult;
1673
- };
1674
- 'index.get': {
1675
- input: IndexGetInput;
1676
- options: never;
1677
- output: IndexInfo;
1678
- };
1679
- 'index.insert': {
1680
- input: IndexInsertInput;
1681
- options: MutationOptions;
1682
- output: IndexMutationResult;
1683
- };
1684
- 'index.configure': {
1685
- input: IndexConfigureInput;
1686
- options: MutationOptions;
1687
- output: IndexMutationResult;
1688
- };
1689
- 'index.rebuild': {
1690
- input: IndexRebuildInput;
1691
- options: MutationOptions;
1692
- output: IndexMutationResult;
1693
- };
1694
- 'index.remove': {
1695
- input: IndexRemoveInput;
1696
- options: MutationOptions;
1697
- output: IndexMutationResult;
1698
- };
1699
- 'index.entries.list': {
1700
- input: IndexEntryListInput | undefined;
1701
- options: never;
1702
- output: IndexEntryListResult;
1703
- };
1704
- 'index.entries.get': {
1705
- input: IndexEntryGetInput;
1706
- options: never;
1707
- output: IndexEntryInfo;
1708
- };
1709
- 'index.entries.insert': {
1710
- input: IndexEntryInsertInput;
1711
- options: MutationOptions;
1712
- output: IndexEntryMutationResult;
1713
- };
1714
- 'index.entries.update': {
1715
- input: IndexEntryUpdateInput;
1716
- options: MutationOptions;
1717
- output: IndexEntryMutationResult;
1718
- };
1719
- 'index.entries.remove': {
1720
- input: IndexEntryRemoveInput;
1721
- options: MutationOptions;
1722
- output: IndexEntryMutationResult;
1723
- };
1724
- 'captions.list': {
1725
- input: CaptionListInput | undefined;
1726
- options: never;
1727
- output: CaptionsListResult;
1728
- };
1729
- 'captions.get': {
1730
- input: CaptionGetInput;
1731
- options: never;
1732
- output: CaptionInfo;
1733
- };
1734
- 'captions.insert': {
1735
- input: CaptionInsertInput;
1736
- options: MutationOptions;
1737
- output: CaptionMutationResult;
1738
- };
1739
- 'captions.update': {
1740
- input: CaptionUpdateInput;
1741
- options: MutationOptions;
1742
- output: CaptionMutationResult;
1743
- };
1744
- 'captions.remove': {
1745
- input: CaptionRemoveInput;
1746
- options: MutationOptions;
1747
- output: CaptionMutationResult;
1748
- };
1749
- 'captions.configure': {
1750
- input: CaptionConfigureInput;
1751
- options: MutationOptions;
1752
- output: CaptionConfigResult;
1753
- };
1754
- 'fields.list': {
1755
- input: FieldListInput | undefined;
1756
- options: never;
1757
- output: FieldsListResult;
1758
- };
1759
- 'fields.get': {
1760
- input: FieldGetInput;
1761
- options: never;
1762
- output: FieldInfo;
1763
- };
1764
- 'fields.insert': {
1765
- input: FieldInsertInput;
1766
- options: MutationOptions;
1767
- output: FieldMutationResult;
1768
- };
1769
- 'fields.rebuild': {
1770
- input: FieldRebuildInput;
1771
- options: MutationOptions;
1772
- output: FieldMutationResult;
1773
- };
1774
- 'fields.remove': {
1775
- input: FieldRemoveInput;
1776
- options: MutationOptions;
1777
- output: FieldMutationResult;
1778
- };
1779
- 'citations.list': {
1780
- input: CitationListInput | undefined;
1781
- options: never;
1782
- output: CitationsListResult;
1783
- };
1784
- 'citations.get': {
1785
- input: CitationGetInput;
1786
- options: never;
1787
- output: CitationInfo;
1788
- };
1789
- 'citations.insert': {
1790
- input: CitationInsertInput;
1791
- options: MutationOptions;
1792
- output: CitationMutationResult;
1793
- };
1794
- 'citations.update': {
1795
- input: CitationUpdateInput;
1796
- options: MutationOptions;
1797
- output: CitationMutationResult;
1798
- };
1799
- 'citations.remove': {
1800
- input: CitationRemoveInput;
1801
- options: MutationOptions;
1802
- output: CitationMutationResult;
1803
- };
1804
- 'citations.sources.list': {
1805
- input: CitationSourceListInput | undefined;
1806
- options: never;
1807
- output: CitationSourcesListResult;
1808
- };
1809
- 'citations.sources.get': {
1810
- input: CitationSourceGetInput;
1811
- options: never;
1812
- output: CitationSourceInfo;
1813
- };
1814
- 'citations.sources.insert': {
1815
- input: CitationSourceInsertInput;
1816
- options: MutationOptions;
1817
- output: CitationSourceMutationResult;
1818
- };
1819
- 'citations.sources.update': {
1820
- input: CitationSourceUpdateInput;
1821
- options: MutationOptions;
1822
- output: CitationSourceMutationResult;
1823
- };
1824
- 'citations.sources.remove': {
1825
- input: CitationSourceRemoveInput;
1826
- options: MutationOptions;
1827
- output: CitationSourceMutationResult;
1828
- };
1829
- 'citations.bibliography.get': {
1830
- input: BibliographyGetInput;
1831
- options: never;
1832
- output: BibliographyInfo;
1833
- };
1834
- 'citations.bibliography.insert': {
1835
- input: BibliographyInsertInput;
1836
- options: MutationOptions;
1837
- output: BibliographyMutationResult;
1838
- };
1839
- 'citations.bibliography.rebuild': {
1840
- input: BibliographyRebuildInput;
1841
- options: MutationOptions;
1842
- output: BibliographyMutationResult;
1843
- };
1844
- 'citations.bibliography.configure': {
1845
- input: BibliographyConfigureInput;
1846
- options: MutationOptions;
1847
- output: BibliographyMutationResult;
1848
- };
1849
- 'citations.bibliography.remove': {
1850
- input: BibliographyRemoveInput;
1851
- options: MutationOptions;
1852
- output: BibliographyMutationResult;
1853
- };
1854
- 'authorities.list': {
1855
- input: AuthoritiesListInput | undefined;
1856
- options: never;
1857
- output: AuthoritiesListResult;
1858
- };
1859
- 'authorities.get': {
1860
- input: AuthoritiesGetInput;
1861
- options: never;
1862
- output: AuthoritiesInfo;
1863
- };
1864
- 'authorities.insert': {
1865
- input: AuthoritiesInsertInput;
1866
- options: MutationOptions;
1867
- output: AuthoritiesMutationResult;
1868
- };
1869
- 'authorities.configure': {
1870
- input: AuthoritiesConfigureInput;
1871
- options: MutationOptions;
1872
- output: AuthoritiesMutationResult;
1873
- };
1874
- 'authorities.rebuild': {
1875
- input: AuthoritiesRebuildInput;
1876
- options: MutationOptions;
1877
- output: AuthoritiesMutationResult;
1878
- };
1879
- 'authorities.remove': {
1880
- input: AuthoritiesRemoveInput;
1881
- options: MutationOptions;
1882
- output: AuthoritiesMutationResult;
1883
- };
1884
- 'authorities.entries.list': {
1885
- input: AuthorityEntryListInput | undefined;
1886
- options: never;
1887
- output: AuthorityEntryListResult;
1888
- };
1889
- 'authorities.entries.get': {
1890
- input: AuthorityEntryGetInput;
1891
- options: never;
1892
- output: AuthorityEntryInfo;
1893
- };
1894
- 'authorities.entries.insert': {
1895
- input: AuthorityEntryInsertInput;
1896
- options: MutationOptions;
1897
- output: AuthorityEntryMutationResult;
1898
- };
1899
- 'authorities.entries.update': {
1900
- input: AuthorityEntryUpdateInput;
1901
- options: MutationOptions;
1902
- output: AuthorityEntryMutationResult;
1903
- };
1904
- 'authorities.entries.remove': {
1905
- input: AuthorityEntryRemoveInput;
1906
- options: MutationOptions;
1907
- output: AuthorityEntryMutationResult;
1908
- };
1909
- 'diff.capture': {
1910
- input: undefined;
1911
- options: never;
1912
- output: DiffSnapshot;
1913
- };
1914
- 'diff.compare': {
1915
- input: DiffCompareInput;
1916
- options: never;
1917
- output: DiffPayload;
1918
- };
1919
- 'diff.apply': {
1920
- input: DiffApplyInput;
1921
- options: DiffApplyOptions;
1922
- output: DiffApplyResult;
1923
- };
1924
- 'export.toDocx': {
1925
- input: ExportToDocxInput;
1926
- options: never;
1927
- output: ExportToDocxResult;
1928
- };
1929
- 'protection.get': {
1930
- input: ProtectionGetInput;
1931
- options: never;
1932
- output: DocumentProtectionState;
1933
- };
1934
- 'protection.setEditingRestriction': {
1935
- input: SetEditingRestrictionInput;
1936
- options: MutationOptions;
1937
- output: ProtectionMutationResult;
1938
- };
1939
- 'protection.clearEditingRestriction': {
1940
- input: ClearEditingRestrictionInput;
1941
- options: MutationOptions;
1942
- output: ProtectionMutationResult;
1943
- };
1944
- 'permissionRanges.list': {
1945
- input: PermissionRangesListInput | undefined;
1946
- options: never;
1947
- output: PermissionRangesListResult;
1948
- };
1949
- 'permissionRanges.get': {
1950
- input: PermissionRangesGetInput;
1951
- options: never;
1952
- output: PermissionRangeInfo;
1953
- };
1954
- 'permissionRanges.create': {
1955
- input: PermissionRangesCreateInput;
1956
- options: MutationOptions;
1957
- output: PermissionRangeMutationResult;
1958
- };
1959
- 'permissionRanges.remove': {
1960
- input: PermissionRangesRemoveInput;
1961
- options: MutationOptions;
1962
- output: PermissionRangeRemoveResult;
1963
- };
1964
- 'permissionRanges.updatePrincipal': {
1965
- input: PermissionRangesUpdatePrincipalInput;
1966
- options: MutationOptions;
1967
- output: PermissionRangeMutationResult;
1968
- };
1969
- 'customXml.parts.list': {
1970
- input: CustomXmlPartsListInput | undefined;
1971
- options: never;
1972
- output: CustomXmlPartsListResult;
1973
- };
1974
- 'customXml.parts.get': {
1975
- input: CustomXmlPartsGetInput;
1976
- options: never;
1977
- output: CustomXmlPartInfo | null;
1978
- };
1979
- 'customXml.parts.create': {
1980
- input: CustomXmlPartsCreateInput;
1981
- options: MutationOptions;
1982
- output: CustomXmlPartsCreateResult;
1983
- };
1984
- 'customXml.parts.patch': {
1985
- input: CustomXmlPartsPatchInput;
1986
- options: MutationOptions;
1987
- output: CustomXmlPartsMutationResult;
1988
- };
1989
- 'customXml.parts.remove': {
1990
- input: CustomXmlPartsRemoveInput;
1991
- options: MutationOptions;
1992
- output: CustomXmlPartsMutationResult;
1993
- };
1994
- 'metadata.attach': {
1995
- input: AnchoredMetadataAttachInput;
1996
- options: MutationOptions;
1997
- output: AnchoredMetadataAttachResult;
1998
- };
1999
- 'metadata.list': {
2000
- input: AnchoredMetadataListInput | undefined;
2001
- options: never;
2002
- output: AnchoredMetadataListResult;
2003
- };
2004
- 'metadata.get': {
2005
- input: AnchoredMetadataGetInput;
2006
- options: never;
2007
- output: AnchoredMetadataInfo | null;
2008
- };
2009
- 'metadata.update': {
2010
- input: AnchoredMetadataUpdateInput;
2011
- options: MutationOptions;
2012
- output: AnchoredMetadataMutationResult;
2013
- };
2014
- 'metadata.remove': {
2015
- input: AnchoredMetadataRemoveInput;
2016
- options: MutationOptions;
2017
- output: AnchoredMetadataMutationResult;
2018
- };
2019
- 'metadata.resolve': {
2020
- input: AnchoredMetadataResolveInput;
2021
- options: never;
2022
- output: AnchoredMetadataResolveInfo | null;
2023
- };
2024
- }
4
+ type ResolveMemberPath<T, Path extends string> = Path extends `${infer Head}.${infer Tail}` ? Head extends keyof T ? ResolveMemberPath<T[Head], Tail> : never : Path extends keyof T ? T[Path] : never;
5
+ type MethodArguments<T> = T extends (...args: infer Arguments) => unknown ? Arguments : never;
6
+ type MethodInput<T> = MethodArguments<T> extends readonly [] ? undefined : MethodArguments<T>[0];
7
+ type MethodOptions<T> = 2 extends MethodArguments<T>['length'] ? Exclude<MethodArguments<T>[1], undefined> : never;
8
+ type MethodReturn<T> = T extends (...args: never[]) => infer Output ? Output : never;
2025
9
  /**
2026
- * Typed invoke request. TypeScript narrows input and options based on operationId.
2027
- *
2028
- * When an operation has no options (`options: never` in the registry), the
2029
- * request shape forbids `options` via `options?: never` rather than via an
2030
- * intersection with `Record<string, never>` (which would also forbid
2031
- * `operationId` and `input`, making the typed overload unmatchable and
2032
- * silently falling through to the dynamic `unknown` return).
10
+ * Canonical type-level mapping used by `invoke()` and its dispatch table.
11
+ * Promise-returning mutation-plan operations store their resolved payload so
12
+ * `InvokeResult` can retain the established async call shape.
2033
13
  */
14
+ export type OperationRegistry = {
15
+ [Id in OperationId]: ResolveMemberPath<DocumentApiSurface, (typeof OPERATION_DEFINITIONS)[Id]['memberPath']> extends infer Method ? {
16
+ input: MethodInput<Method>;
17
+ options: MethodOptions<Method>;
18
+ output: Id extends 'mutations.preview' | 'mutations.apply' | 'plan.execute' ? Awaited<MethodReturn<Method>> : MethodReturn<Method>;
19
+ } : never;
20
+ };
21
+ /** Typed invoke request narrowed by `operationId`. */
2034
22
  export type InvokeRequest<T extends OperationId> = OperationRegistry[T]['options'] extends never ? {
2035
23
  operationId: T;
2036
24
  input: OperationRegistry[T]['input'];
@@ -2040,14 +28,9 @@ export type InvokeRequest<T extends OperationId> = OperationRegistry[T]['options
2040
28
  input: OperationRegistry[T]['input'];
2041
29
  options?: OperationRegistry[T]['options'];
2042
30
  };
2043
- /**
2044
- * Typed invoke result, narrowed by operationId.
2045
- */
31
+ /** Typed invoke result narrowed by `operationId`. */
2046
32
  export type InvokeResult<T extends OperationId> = T extends 'mutations.preview' | 'mutations.apply' ? Promise<OperationRegistry[T]['output']> : T extends 'plan.execute' ? OperationRegistry[T]['output'] | Promise<OperationRegistry[T]['output']> : OperationRegistry[T]['output'];
2047
- /**
2048
- * Loose invoke request for dynamic callers who don't know the operation at compile time.
2049
- * Invalid inputs will produce adapter-level errors, not input-validation errors.
2050
- */
33
+ /** Loose request for callers that resolve operation identity at runtime. */
2051
34
  export type DynamicInvokeRequest = {
2052
35
  operationId: OperationId;
2053
36
  input: unknown;