@superdoc/sdk 2.24.0 → 2.25.0-next.1

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.
@@ -13052,6 +13052,10 @@ export interface DocStylesApplyParams {
13052
13052
  }) | ({
13053
13053
  scope: "docDefaults";
13054
13054
  channel: "paragraph";
13055
+ }) | ({
13056
+ scope: "style";
13057
+ styleId: string;
13058
+ channel: "run";
13055
13059
  });
13056
13060
  patch?: ({
13057
13061
  bold?: boolean;
@@ -13298,6 +13302,100 @@ export interface DocStylesApplyParams {
13298
13302
  leader?: string;
13299
13303
  };
13300
13304
  }>;
13305
+ }) | ({
13306
+ bold?: boolean | unknown;
13307
+ boldCs?: boolean | unknown;
13308
+ italic?: boolean | unknown;
13309
+ iCs?: boolean | unknown;
13310
+ smallCaps?: boolean | unknown;
13311
+ strike?: boolean | unknown;
13312
+ dstrike?: boolean | unknown;
13313
+ emboss?: boolean | unknown;
13314
+ imprint?: boolean | unknown;
13315
+ outline?: boolean | unknown;
13316
+ shadow?: boolean | unknown;
13317
+ vanish?: boolean | unknown;
13318
+ webHidden?: boolean | unknown;
13319
+ specVanish?: boolean | unknown;
13320
+ snapToGrid?: boolean | unknown;
13321
+ noProof?: boolean | unknown;
13322
+ fontSize?: number | unknown;
13323
+ fontSizeCs?: number | unknown;
13324
+ letterSpacing?: number | unknown;
13325
+ kern?: number | unknown;
13326
+ position?: number | unknown;
13327
+ w?: number | unknown;
13328
+ textTransform?: "uppercase" | "none" | unknown;
13329
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
13330
+ em?: "none" | "dot" | "comma" | "circle" | "sesame" | unknown;
13331
+ effect?: string | unknown;
13332
+ fontFamily?: ({
13333
+ hint?: string;
13334
+ ascii?: string;
13335
+ hAnsi?: string;
13336
+ eastAsia?: string;
13337
+ cs?: string;
13338
+ val?: string;
13339
+ asciiTheme?: string;
13340
+ hAnsiTheme?: string;
13341
+ eastAsiaTheme?: string;
13342
+ cstheme?: string;
13343
+ }) | unknown;
13344
+ color?: ({
13345
+ val?: string;
13346
+ themeColor?: string;
13347
+ themeTint?: string;
13348
+ themeShade?: string;
13349
+ }) | unknown;
13350
+ underline?: ({
13351
+ val?: "single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none";
13352
+ color?: string;
13353
+ themeColor?: string;
13354
+ themeTint?: string;
13355
+ themeShade?: string;
13356
+ }) | unknown;
13357
+ borders?: ({
13358
+ val?: string;
13359
+ color?: string;
13360
+ themeColor?: string;
13361
+ themeTint?: string;
13362
+ themeShade?: string;
13363
+ size?: number;
13364
+ space?: number;
13365
+ shadow?: boolean;
13366
+ frame?: boolean;
13367
+ }) | unknown;
13368
+ shading?: ({
13369
+ color?: string;
13370
+ fill?: string;
13371
+ themeColor?: string;
13372
+ themeFill?: string;
13373
+ themeFillShade?: string;
13374
+ themeFillTint?: string;
13375
+ themeShade?: string;
13376
+ themeTint?: string;
13377
+ val?: string;
13378
+ }) | unknown;
13379
+ lang?: ({
13380
+ val?: string;
13381
+ eastAsia?: string;
13382
+ bidi?: string;
13383
+ }) | unknown;
13384
+ eastAsianLayout?: ({
13385
+ id?: number;
13386
+ combine?: boolean;
13387
+ combineBrackets?: string;
13388
+ vert?: boolean;
13389
+ vertCompress?: boolean;
13390
+ }) | unknown;
13391
+ fitText?: ({
13392
+ val?: number;
13393
+ id?: number;
13394
+ }) | unknown;
13395
+ cs?: boolean | unknown;
13396
+ oMath?: boolean | unknown;
13397
+ rtl?: boolean | unknown;
13398
+ highlight?: "black" | "blue" | "cyan" | "green" | "magenta" | "red" | "yellow" | "white" | "darkBlue" | "darkCyan" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "darkGray" | "lightGray" | "none" | unknown;
13301
13399
  });
13302
13400
  }
13303
13401
  export interface DocStylesCreateParams {
@@ -21018,6 +21116,9 @@ export interface DocMutationsPreviewParams {
21018
21116
  storyType: "textbox";
21019
21117
  textboxId: string;
21020
21118
  });
21119
+ author?: {
21120
+ name: string;
21121
+ };
21021
21122
  expectedRevision?: string;
21022
21123
  atomic: boolean;
21023
21124
  changeMode: "direct" | "tracked";
@@ -22932,6 +23033,9 @@ export interface DocMutationsApplyParams {
22932
23033
  storyType: "textbox";
22933
23034
  textboxId: string;
22934
23035
  });
23036
+ author?: {
23037
+ name: string;
23038
+ };
22935
23039
  atomic: boolean;
22936
23040
  steps: Array<({
22937
23041
  id: string;
@@ -114008,14 +114112,21 @@ export type DocStylesApplyResult = {
114008
114112
  success: true;
114009
114113
  appliedChangeMode?: "direct" | "tracked";
114010
114114
  changed: boolean;
114011
- resolution: {
114115
+ resolution: ({
114012
114116
  scope: "docDefaults";
114013
114117
  channel: "run" | "paragraph";
114014
114118
  xmlPart: string;
114015
114119
  xmlPath: "w:styles/w:docDefaults/w:rPrDefault/w:rPr" | "w:styles/w:docDefaults/w:pPrDefault/w:pPr";
114016
- };
114120
+ }) | ({
114121
+ scope: "style";
114122
+ styleId: string;
114123
+ channel: "run";
114124
+ xmlPart: string;
114125
+ xmlPath: "w:styles/w:style/w:rPr";
114126
+ linkedStyleId?: string;
114127
+ });
114017
114128
  dryRun: boolean;
114018
- before: {
114129
+ before: ({
114019
114130
  bold?: "on" | "off" | "inherit";
114020
114131
  boldCs?: "on" | "off" | "inherit";
114021
114132
  italic?: "on" | "off" | "inherit";
@@ -114077,8 +114188,47 @@ export type DocStylesApplyResult = {
114077
114188
  numberingProperties?: Record<string, unknown> | "inherit";
114078
114189
  framePr?: Record<string, unknown> | "inherit";
114079
114190
  tabStops?: Array<unknown> | "inherit";
114080
- };
114081
- after: {
114191
+ }) | ({
114192
+ bold?: "on" | "off" | "inherit";
114193
+ boldCs?: "on" | "off" | "inherit";
114194
+ italic?: "on" | "off" | "inherit";
114195
+ iCs?: "on" | "off" | "inherit";
114196
+ smallCaps?: "on" | "off" | "inherit";
114197
+ strike?: "on" | "off" | "inherit";
114198
+ dstrike?: "on" | "off" | "inherit";
114199
+ emboss?: "on" | "off" | "inherit";
114200
+ imprint?: "on" | "off" | "inherit";
114201
+ outline?: "on" | "off" | "inherit";
114202
+ shadow?: "on" | "off" | "inherit";
114203
+ vanish?: "on" | "off" | "inherit";
114204
+ webHidden?: "on" | "off" | "inherit";
114205
+ specVanish?: "on" | "off" | "inherit";
114206
+ snapToGrid?: "on" | "off" | "inherit";
114207
+ noProof?: "on" | "off" | "inherit";
114208
+ fontSize?: number | "inherit";
114209
+ fontSizeCs?: number | "inherit";
114210
+ letterSpacing?: number | "inherit";
114211
+ kern?: number | "inherit";
114212
+ position?: number | "inherit";
114213
+ w?: number | "inherit";
114214
+ textTransform?: string | "inherit";
114215
+ vertAlign?: string | "inherit";
114216
+ em?: string | "inherit";
114217
+ effect?: string | "inherit";
114218
+ fontFamily?: Record<string, unknown> | "inherit";
114219
+ color?: Record<string, unknown> | "inherit";
114220
+ underline?: Record<string, unknown> | "inherit";
114221
+ borders?: Record<string, unknown> | "inherit";
114222
+ shading?: Record<string, unknown> | "inherit";
114223
+ lang?: Record<string, unknown> | "inherit";
114224
+ eastAsianLayout?: Record<string, unknown> | "inherit";
114225
+ fitText?: Record<string, unknown> | "inherit";
114226
+ cs?: "on" | "off" | "inherit";
114227
+ oMath?: "on" | "off" | "inherit";
114228
+ rtl?: "on" | "off" | "inherit";
114229
+ highlight?: string | "inherit";
114230
+ });
114231
+ after: ({
114082
114232
  bold?: "on" | "off" | "inherit";
114083
114233
  boldCs?: "on" | "off" | "inherit";
114084
114234
  italic?: "on" | "off" | "inherit";
@@ -114140,7 +114290,46 @@ export type DocStylesApplyResult = {
114140
114290
  numberingProperties?: Record<string, unknown> | "inherit";
114141
114291
  framePr?: Record<string, unknown> | "inherit";
114142
114292
  tabStops?: Array<unknown> | "inherit";
114143
- };
114293
+ }) | ({
114294
+ bold?: "on" | "off" | "inherit";
114295
+ boldCs?: "on" | "off" | "inherit";
114296
+ italic?: "on" | "off" | "inherit";
114297
+ iCs?: "on" | "off" | "inherit";
114298
+ smallCaps?: "on" | "off" | "inherit";
114299
+ strike?: "on" | "off" | "inherit";
114300
+ dstrike?: "on" | "off" | "inherit";
114301
+ emboss?: "on" | "off" | "inherit";
114302
+ imprint?: "on" | "off" | "inherit";
114303
+ outline?: "on" | "off" | "inherit";
114304
+ shadow?: "on" | "off" | "inherit";
114305
+ vanish?: "on" | "off" | "inherit";
114306
+ webHidden?: "on" | "off" | "inherit";
114307
+ specVanish?: "on" | "off" | "inherit";
114308
+ snapToGrid?: "on" | "off" | "inherit";
114309
+ noProof?: "on" | "off" | "inherit";
114310
+ fontSize?: number | "inherit";
114311
+ fontSizeCs?: number | "inherit";
114312
+ letterSpacing?: number | "inherit";
114313
+ kern?: number | "inherit";
114314
+ position?: number | "inherit";
114315
+ w?: number | "inherit";
114316
+ textTransform?: string | "inherit";
114317
+ vertAlign?: string | "inherit";
114318
+ em?: string | "inherit";
114319
+ effect?: string | "inherit";
114320
+ fontFamily?: Record<string, unknown> | "inherit";
114321
+ color?: Record<string, unknown> | "inherit";
114322
+ underline?: Record<string, unknown> | "inherit";
114323
+ borders?: Record<string, unknown> | "inherit";
114324
+ shading?: Record<string, unknown> | "inherit";
114325
+ lang?: Record<string, unknown> | "inherit";
114326
+ eastAsianLayout?: Record<string, unknown> | "inherit";
114327
+ fitText?: Record<string, unknown> | "inherit";
114328
+ cs?: "on" | "off" | "inherit";
114329
+ oMath?: "on" | "off" | "inherit";
114330
+ rtl?: "on" | "off" | "inherit";
114331
+ highlight?: string | "inherit";
114332
+ });
114144
114333
  };
114145
114334
  export type DocStylesCreateResult = {
114146
114335
  success: true;
@@ -175162,6 +175351,48 @@ export type DocMutationsBeginTemporaryResult = {
175162
175351
  before: string;
175163
175352
  after: string;
175164
175353
  };
175354
+ operationEffects?: Record<string, {
175355
+ inserted: Array<({
175356
+ kind: "entity";
175357
+ entityType: "comment";
175358
+ entityId: string;
175359
+ }) | ({
175360
+ kind: "entity";
175361
+ entityType: "trackedChange";
175362
+ entityId: string;
175363
+ story?: ({
175364
+ kind: "story";
175365
+ storyType: "body";
175366
+ }) | ({
175367
+ kind: "story";
175368
+ storyType: "headerFooterSlot";
175369
+ section: {
175370
+ kind: "section";
175371
+ sectionId: string;
175372
+ };
175373
+ headerFooterKind: "header" | "footer";
175374
+ variant: "default" | "first" | "even";
175375
+ resolution?: "effective" | "explicit";
175376
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
175377
+ }) | ({
175378
+ kind: "story";
175379
+ storyType: "headerFooterPart";
175380
+ refId: string;
175381
+ }) | ({
175382
+ kind: "story";
175383
+ storyType: "footnote";
175384
+ noteId: string;
175385
+ }) | ({
175386
+ kind: "story";
175387
+ storyType: "endnote";
175388
+ noteId: string;
175389
+ }) | ({
175390
+ kind: "story";
175391
+ storyType: "textbox";
175392
+ textboxId: string;
175393
+ });
175394
+ })>;
175395
+ }>;
175165
175396
  };
175166
175397
  export type DocMutationsReplaceTemporaryResult = {
175167
175398
  changeTag?: string;
@@ -176347,6 +176578,48 @@ export type DocMutationsReplaceTemporaryResult = {
176347
176578
  before: string;
176348
176579
  after: string;
176349
176580
  };
176581
+ operationEffects?: Record<string, {
176582
+ inserted: Array<({
176583
+ kind: "entity";
176584
+ entityType: "comment";
176585
+ entityId: string;
176586
+ }) | ({
176587
+ kind: "entity";
176588
+ entityType: "trackedChange";
176589
+ entityId: string;
176590
+ story?: ({
176591
+ kind: "story";
176592
+ storyType: "body";
176593
+ }) | ({
176594
+ kind: "story";
176595
+ storyType: "headerFooterSlot";
176596
+ section: {
176597
+ kind: "section";
176598
+ sectionId: string;
176599
+ };
176600
+ headerFooterKind: "header" | "footer";
176601
+ variant: "default" | "first" | "even";
176602
+ resolution?: "effective" | "explicit";
176603
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
176604
+ }) | ({
176605
+ kind: "story";
176606
+ storyType: "headerFooterPart";
176607
+ refId: string;
176608
+ }) | ({
176609
+ kind: "story";
176610
+ storyType: "footnote";
176611
+ noteId: string;
176612
+ }) | ({
176613
+ kind: "story";
176614
+ storyType: "endnote";
176615
+ noteId: string;
176616
+ }) | ({
176617
+ kind: "story";
176618
+ storyType: "textbox";
176619
+ textboxId: string;
176620
+ });
176621
+ })>;
176622
+ }>;
176350
176623
  };
176351
176624
  export type DocMutationsRollbackTemporaryResult = {
176352
176625
  changeTag?: string;
@@ -177532,6 +177805,48 @@ export type DocMutationsRollbackTemporaryResult = {
177532
177805
  before: string;
177533
177806
  after: string;
177534
177807
  };
177808
+ operationEffects?: Record<string, {
177809
+ inserted: Array<({
177810
+ kind: "entity";
177811
+ entityType: "comment";
177812
+ entityId: string;
177813
+ }) | ({
177814
+ kind: "entity";
177815
+ entityType: "trackedChange";
177816
+ entityId: string;
177817
+ story?: ({
177818
+ kind: "story";
177819
+ storyType: "body";
177820
+ }) | ({
177821
+ kind: "story";
177822
+ storyType: "headerFooterSlot";
177823
+ section: {
177824
+ kind: "section";
177825
+ sectionId: string;
177826
+ };
177827
+ headerFooterKind: "header" | "footer";
177828
+ variant: "default" | "first" | "even";
177829
+ resolution?: "effective" | "explicit";
177830
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
177831
+ }) | ({
177832
+ kind: "story";
177833
+ storyType: "headerFooterPart";
177834
+ refId: string;
177835
+ }) | ({
177836
+ kind: "story";
177837
+ storyType: "footnote";
177838
+ noteId: string;
177839
+ }) | ({
177840
+ kind: "story";
177841
+ storyType: "endnote";
177842
+ noteId: string;
177843
+ }) | ({
177844
+ kind: "story";
177845
+ storyType: "textbox";
177846
+ textboxId: string;
177847
+ });
177848
+ })>;
177849
+ }>;
177535
177850
  };
177536
177851
  export type DocMutationsCommitTemporaryResult = {
177537
177852
  changeTag?: string;
@@ -178717,6 +179032,48 @@ export type DocMutationsCommitTemporaryResult = {
178717
179032
  before: string;
178718
179033
  after: string;
178719
179034
  };
179035
+ operationEffects?: Record<string, {
179036
+ inserted: Array<({
179037
+ kind: "entity";
179038
+ entityType: "comment";
179039
+ entityId: string;
179040
+ }) | ({
179041
+ kind: "entity";
179042
+ entityType: "trackedChange";
179043
+ entityId: string;
179044
+ story?: ({
179045
+ kind: "story";
179046
+ storyType: "body";
179047
+ }) | ({
179048
+ kind: "story";
179049
+ storyType: "headerFooterSlot";
179050
+ section: {
179051
+ kind: "section";
179052
+ sectionId: string;
179053
+ };
179054
+ headerFooterKind: "header" | "footer";
179055
+ variant: "default" | "first" | "even";
179056
+ resolution?: "effective" | "explicit";
179057
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
179058
+ }) | ({
179059
+ kind: "story";
179060
+ storyType: "headerFooterPart";
179061
+ refId: string;
179062
+ }) | ({
179063
+ kind: "story";
179064
+ storyType: "footnote";
179065
+ noteId: string;
179066
+ }) | ({
179067
+ kind: "story";
179068
+ storyType: "endnote";
179069
+ noteId: string;
179070
+ }) | ({
179071
+ kind: "story";
179072
+ storyType: "textbox";
179073
+ textboxId: string;
179074
+ });
179075
+ })>;
179076
+ }>;
178720
179077
  };
178721
179078
  export type DocMutationsPreviewResult = {
178722
179079
  evaluatedRevision: string;
@@ -294251,6 +294608,10 @@ export interface DocStylesApplyBoundParams {
294251
294608
  }) | ({
294252
294609
  scope: "docDefaults";
294253
294610
  channel: "paragraph";
294611
+ }) | ({
294612
+ scope: "style";
294613
+ styleId: string;
294614
+ channel: "run";
294254
294615
  });
294255
294616
  patch?: ({
294256
294617
  bold?: boolean;
@@ -294497,6 +294858,100 @@ export interface DocStylesApplyBoundParams {
294497
294858
  leader?: string;
294498
294859
  };
294499
294860
  }>;
294861
+ }) | ({
294862
+ bold?: boolean | unknown;
294863
+ boldCs?: boolean | unknown;
294864
+ italic?: boolean | unknown;
294865
+ iCs?: boolean | unknown;
294866
+ smallCaps?: boolean | unknown;
294867
+ strike?: boolean | unknown;
294868
+ dstrike?: boolean | unknown;
294869
+ emboss?: boolean | unknown;
294870
+ imprint?: boolean | unknown;
294871
+ outline?: boolean | unknown;
294872
+ shadow?: boolean | unknown;
294873
+ vanish?: boolean | unknown;
294874
+ webHidden?: boolean | unknown;
294875
+ specVanish?: boolean | unknown;
294876
+ snapToGrid?: boolean | unknown;
294877
+ noProof?: boolean | unknown;
294878
+ fontSize?: number | unknown;
294879
+ fontSizeCs?: number | unknown;
294880
+ letterSpacing?: number | unknown;
294881
+ kern?: number | unknown;
294882
+ position?: number | unknown;
294883
+ w?: number | unknown;
294884
+ textTransform?: "uppercase" | "none" | unknown;
294885
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
294886
+ em?: "none" | "dot" | "comma" | "circle" | "sesame" | unknown;
294887
+ effect?: string | unknown;
294888
+ fontFamily?: ({
294889
+ hint?: string;
294890
+ ascii?: string;
294891
+ hAnsi?: string;
294892
+ eastAsia?: string;
294893
+ cs?: string;
294894
+ val?: string;
294895
+ asciiTheme?: string;
294896
+ hAnsiTheme?: string;
294897
+ eastAsiaTheme?: string;
294898
+ cstheme?: string;
294899
+ }) | unknown;
294900
+ color?: ({
294901
+ val?: string;
294902
+ themeColor?: string;
294903
+ themeTint?: string;
294904
+ themeShade?: string;
294905
+ }) | unknown;
294906
+ underline?: ({
294907
+ val?: "single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none";
294908
+ color?: string;
294909
+ themeColor?: string;
294910
+ themeTint?: string;
294911
+ themeShade?: string;
294912
+ }) | unknown;
294913
+ borders?: ({
294914
+ val?: string;
294915
+ color?: string;
294916
+ themeColor?: string;
294917
+ themeTint?: string;
294918
+ themeShade?: string;
294919
+ size?: number;
294920
+ space?: number;
294921
+ shadow?: boolean;
294922
+ frame?: boolean;
294923
+ }) | unknown;
294924
+ shading?: ({
294925
+ color?: string;
294926
+ fill?: string;
294927
+ themeColor?: string;
294928
+ themeFill?: string;
294929
+ themeFillShade?: string;
294930
+ themeFillTint?: string;
294931
+ themeShade?: string;
294932
+ themeTint?: string;
294933
+ val?: string;
294934
+ }) | unknown;
294935
+ lang?: ({
294936
+ val?: string;
294937
+ eastAsia?: string;
294938
+ bidi?: string;
294939
+ }) | unknown;
294940
+ eastAsianLayout?: ({
294941
+ id?: number;
294942
+ combine?: boolean;
294943
+ combineBrackets?: string;
294944
+ vert?: boolean;
294945
+ vertCompress?: boolean;
294946
+ }) | unknown;
294947
+ fitText?: ({
294948
+ val?: number;
294949
+ id?: number;
294950
+ }) | unknown;
294951
+ cs?: boolean | unknown;
294952
+ oMath?: boolean | unknown;
294953
+ rtl?: boolean | unknown;
294954
+ highlight?: "black" | "blue" | "cyan" | "green" | "magenta" | "red" | "yellow" | "white" | "darkBlue" | "darkCyan" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "darkGray" | "lightGray" | "none" | unknown;
294500
294955
  });
294501
294956
  }
294502
294957
  export interface DocStylesCreateBoundParams {
@@ -301995,6 +302450,9 @@ export interface DocMutationsPreviewBoundParams {
301995
302450
  storyType: "textbox";
301996
302451
  textboxId: string;
301997
302452
  });
302453
+ author?: {
302454
+ name: string;
302455
+ };
301998
302456
  expectedRevision?: string;
301999
302457
  atomic: boolean;
302000
302458
  changeMode: "direct" | "tracked";
@@ -303907,6 +304365,9 @@ export interface DocMutationsApplyBoundParams {
303907
304365
  storyType: "textbox";
303908
304366
  textboxId: string;
303909
304367
  });
304368
+ author?: {
304369
+ name: string;
304370
+ };
303910
304371
  atomic: boolean;
303911
304372
  steps: Array<({
303912
304373
  id: string;