@superdoc-dev/sdk 1.13.0 → 1.14.0-next.2

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.
@@ -466,6 +466,156 @@ export interface DocDeleteParams {
466
466
  start?: number;
467
467
  end?: number;
468
468
  }
469
+ export interface DocFormatRangeParams {
470
+ doc?: string;
471
+ sessionId?: string;
472
+ out?: string;
473
+ force?: boolean;
474
+ expectedRevision?: number;
475
+ changeMode?: string;
476
+ dryRun?: boolean;
477
+ target?: {
478
+ kind: "selection";
479
+ start: ({
480
+ kind: "text";
481
+ blockId: string;
482
+ offset: number;
483
+ }) | ({
484
+ kind: "nodeEdge";
485
+ node: {
486
+ kind: "block";
487
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
488
+ nodeId: string;
489
+ };
490
+ edge: "before" | "after";
491
+ });
492
+ end: ({
493
+ kind: "text";
494
+ blockId: string;
495
+ offset: number;
496
+ }) | ({
497
+ kind: "nodeEdge";
498
+ node: {
499
+ kind: "block";
500
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
501
+ nodeId: string;
502
+ };
503
+ edge: "before" | "after";
504
+ });
505
+ };
506
+ in?: ({
507
+ kind: "story";
508
+ storyType: "body";
509
+ }) | ({
510
+ kind: "story";
511
+ storyType: "headerFooterSlot";
512
+ section: {
513
+ kind: "section";
514
+ sectionId: string;
515
+ };
516
+ headerFooterKind: "header" | "footer";
517
+ variant: "default" | "first" | "even";
518
+ resolution?: "effective" | "explicit";
519
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
520
+ }) | ({
521
+ kind: "story";
522
+ storyType: "headerFooterPart";
523
+ refId: string;
524
+ }) | ({
525
+ kind: "story";
526
+ storyType: "footnote";
527
+ noteId: string;
528
+ }) | ({
529
+ kind: "story";
530
+ storyType: "endnote";
531
+ noteId: string;
532
+ });
533
+ properties: {
534
+ bold?: boolean | unknown;
535
+ italic?: boolean | unknown;
536
+ strike?: boolean | unknown;
537
+ underline?: boolean | unknown | ({
538
+ style?: string | unknown;
539
+ color?: string | unknown;
540
+ themeColor?: string | unknown;
541
+ });
542
+ highlight?: string | unknown;
543
+ color?: string | unknown;
544
+ fontSize?: number | unknown;
545
+ fontFamily?: string | unknown;
546
+ letterSpacing?: number | unknown;
547
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
548
+ position?: number | unknown;
549
+ dstrike?: boolean | unknown;
550
+ smallCaps?: boolean | unknown;
551
+ caps?: boolean | unknown;
552
+ shading?: ({
553
+ fill?: string | unknown;
554
+ color?: string | unknown;
555
+ val?: string | unknown;
556
+ }) | unknown;
557
+ border?: ({
558
+ val?: string | unknown;
559
+ sz?: number | unknown;
560
+ color?: string | unknown;
561
+ space?: number | unknown;
562
+ }) | unknown;
563
+ outline?: boolean | unknown;
564
+ shadow?: boolean | unknown;
565
+ emboss?: boolean | unknown;
566
+ imprint?: boolean | unknown;
567
+ charScale?: number | unknown;
568
+ kerning?: number | unknown;
569
+ vanish?: boolean | unknown;
570
+ webHidden?: boolean | unknown;
571
+ specVanish?: boolean | unknown;
572
+ rtl?: boolean | unknown;
573
+ cs?: boolean | unknown;
574
+ bCs?: boolean | unknown;
575
+ iCs?: boolean | unknown;
576
+ eastAsianLayout?: ({
577
+ id?: string | unknown;
578
+ combine?: boolean | unknown;
579
+ combineBrackets?: string | unknown;
580
+ vert?: boolean | unknown;
581
+ vertCompress?: boolean | unknown;
582
+ }) | unknown;
583
+ em?: string | unknown;
584
+ fitText?: ({
585
+ val?: number | unknown;
586
+ id?: string | unknown;
587
+ }) | unknown;
588
+ snapToGrid?: boolean | unknown;
589
+ lang?: ({
590
+ val?: string | unknown;
591
+ eastAsia?: string | unknown;
592
+ bidi?: string | unknown;
593
+ }) | unknown;
594
+ oMath?: boolean | unknown;
595
+ rStyle?: string | unknown;
596
+ rFonts?: ({
597
+ ascii?: string | unknown;
598
+ hAnsi?: string | unknown;
599
+ eastAsia?: string | unknown;
600
+ cs?: string | unknown;
601
+ asciiTheme?: string | unknown;
602
+ hAnsiTheme?: string | unknown;
603
+ eastAsiaTheme?: string | unknown;
604
+ csTheme?: string | unknown;
605
+ hint?: string | unknown;
606
+ }) | unknown;
607
+ fontSizeCs?: number | unknown;
608
+ ligatures?: string | unknown;
609
+ numForm?: string | unknown;
610
+ numSpacing?: string | unknown;
611
+ stylisticSets?: (Array<{
612
+ id: number;
613
+ val?: boolean;
614
+ }>) | unknown;
615
+ contextualAlternates?: boolean | unknown;
616
+ };
617
+ ref?: string;
618
+ }
469
619
  export interface DocBlocksListParams {
470
620
  doc?: string;
471
621
  sessionId?: string;
@@ -4534,132 +4684,284 @@ export interface DocCommentsCreateParams {
4534
4684
  storyType: "endnote";
4535
4685
  noteId: string;
4536
4686
  });
4537
- });
4538
- parentId?: string;
4539
- blockId?: string;
4540
- start?: number;
4541
- end?: number;
4542
- }
4543
- export interface DocCommentsPatchParams {
4544
- doc?: string;
4545
- sessionId?: string;
4546
- out?: string;
4547
- force?: boolean;
4548
- expectedRevision?: number;
4549
- changeMode?: string;
4550
- id?: string;
4551
- text?: string;
4552
- target?: {
4553
- kind: "text";
4554
- blockId: string;
4555
- range: {
4556
- start: number;
4557
- end: number;
4558
- };
4559
- };
4560
- status?: string;
4561
- isInternal?: boolean;
4562
- blockId?: string;
4563
- start?: number;
4564
- end?: number;
4565
- }
4566
- export interface DocCommentsDeleteParams {
4567
- doc?: string;
4568
- sessionId?: string;
4569
- out?: string;
4570
- force?: boolean;
4571
- expectedRevision?: number;
4572
- changeMode?: string;
4573
- id: string;
4574
- }
4575
- export interface DocCommentsGetParams {
4576
- doc?: string;
4577
- sessionId?: string;
4578
- id: string;
4579
- }
4580
- export interface DocCommentsListParams {
4581
- doc?: string;
4582
- sessionId?: string;
4583
- includeResolved?: boolean;
4584
- limit?: number;
4585
- offset?: number;
4586
- }
4587
- export interface DocTrackChangesListParams {
4588
- doc?: string;
4589
- sessionId?: string;
4590
- limit?: number;
4591
- offset?: number;
4592
- type?: string;
4593
- in?: (({
4594
- kind: "story";
4595
- storyType: "body";
4596
- }) | ({
4597
- kind: "story";
4598
- storyType: "headerFooterSlot";
4599
- section: {
4600
- kind: "section";
4601
- sectionId: string;
4602
- };
4603
- headerFooterKind: "header" | "footer";
4604
- variant: "default" | "first" | "even";
4605
- resolution?: "effective" | "explicit";
4606
- onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4607
- }) | ({
4608
- kind: "story";
4609
- storyType: "headerFooterPart";
4610
- refId: string;
4611
- }) | ({
4612
- kind: "story";
4613
- storyType: "footnote";
4614
- noteId: string;
4615
- }) | ({
4616
- kind: "story";
4617
- storyType: "endnote";
4618
- noteId: string;
4619
- })) | "all";
4620
- }
4621
- export interface DocTrackChangesGetParams {
4622
- doc?: string;
4623
- sessionId?: string;
4624
- id: string;
4625
- story?: ({
4626
- kind: "story";
4627
- storyType: "body";
4628
- }) | ({
4629
- kind: "story";
4630
- storyType: "headerFooterSlot";
4631
- section: {
4632
- kind: "section";
4633
- sectionId: string;
4634
- };
4635
- headerFooterKind: "header" | "footer";
4636
- variant: "default" | "first" | "even";
4637
- resolution?: "effective" | "explicit";
4638
- onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4639
4687
  }) | ({
4640
- kind: "story";
4641
- storyType: "headerFooterPart";
4642
- refId: string;
4643
- }) | ({
4644
- kind: "story";
4645
- storyType: "footnote";
4646
- noteId: string;
4688
+ kind: "selection";
4689
+ start: ({
4690
+ kind: "text";
4691
+ blockId: string;
4692
+ offset: number;
4693
+ }) | ({
4694
+ kind: "nodeEdge";
4695
+ node: {
4696
+ kind: "block";
4697
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
4698
+ nodeId: string;
4699
+ };
4700
+ edge: "before" | "after";
4701
+ });
4702
+ end: ({
4703
+ kind: "text";
4704
+ blockId: string;
4705
+ offset: number;
4706
+ }) | ({
4707
+ kind: "nodeEdge";
4708
+ node: {
4709
+ kind: "block";
4710
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
4711
+ nodeId: string;
4712
+ };
4713
+ edge: "before" | "after";
4714
+ });
4647
4715
  }) | ({
4648
- kind: "story";
4649
- storyType: "endnote";
4650
- noteId: string;
4651
- });
4652
- }
4653
- export interface DocTrackChangesDecideParams {
4654
- doc?: string;
4655
- sessionId?: string;
4656
- out?: string;
4657
- force?: boolean;
4658
- expectedRevision?: number;
4659
- changeMode?: string;
4660
- decision: string;
4661
- target: ({
4662
- id: string;
4716
+ kind?: "trackedChange";
4717
+ trackedChangeId: string;
4718
+ story?: ({
4719
+ kind: "story";
4720
+ storyType: "body";
4721
+ }) | ({
4722
+ kind: "story";
4723
+ storyType: "headerFooterSlot";
4724
+ section: {
4725
+ kind: "section";
4726
+ sectionId: string;
4727
+ };
4728
+ headerFooterKind: "header" | "footer";
4729
+ variant: "default" | "first" | "even";
4730
+ resolution?: "effective" | "explicit";
4731
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4732
+ }) | ({
4733
+ kind: "story";
4734
+ storyType: "headerFooterPart";
4735
+ refId: string;
4736
+ }) | ({
4737
+ kind: "story";
4738
+ storyType: "footnote";
4739
+ noteId: string;
4740
+ }) | ({
4741
+ kind: "story";
4742
+ storyType: "endnote";
4743
+ noteId: string;
4744
+ });
4745
+ });
4746
+ parentId?: string;
4747
+ blockId?: string;
4748
+ start?: number;
4749
+ end?: number;
4750
+ }
4751
+ export interface DocCommentsPatchParams {
4752
+ doc?: string;
4753
+ sessionId?: string;
4754
+ out?: string;
4755
+ force?: boolean;
4756
+ expectedRevision?: number;
4757
+ changeMode?: string;
4758
+ id?: string;
4759
+ text?: string;
4760
+ target?: ({
4761
+ kind: "text";
4762
+ blockId: string;
4763
+ range: {
4764
+ start: number;
4765
+ end: number;
4766
+ };
4767
+ }) | ({
4768
+ kind: "text";
4769
+ segments: Array<{
4770
+ blockId: string;
4771
+ range: {
4772
+ start: number;
4773
+ end: number;
4774
+ };
4775
+ }>;
4776
+ story?: ({
4777
+ kind: "story";
4778
+ storyType: "body";
4779
+ }) | ({
4780
+ kind: "story";
4781
+ storyType: "headerFooterSlot";
4782
+ section: {
4783
+ kind: "section";
4784
+ sectionId: string;
4785
+ };
4786
+ headerFooterKind: "header" | "footer";
4787
+ variant: "default" | "first" | "even";
4788
+ resolution?: "effective" | "explicit";
4789
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4790
+ }) | ({
4791
+ kind: "story";
4792
+ storyType: "headerFooterPart";
4793
+ refId: string;
4794
+ }) | ({
4795
+ kind: "story";
4796
+ storyType: "footnote";
4797
+ noteId: string;
4798
+ }) | ({
4799
+ kind: "story";
4800
+ storyType: "endnote";
4801
+ noteId: string;
4802
+ });
4803
+ }) | ({
4804
+ kind: "selection";
4805
+ start: ({
4806
+ kind: "text";
4807
+ blockId: string;
4808
+ offset: number;
4809
+ }) | ({
4810
+ kind: "nodeEdge";
4811
+ node: {
4812
+ kind: "block";
4813
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
4814
+ nodeId: string;
4815
+ };
4816
+ edge: "before" | "after";
4817
+ });
4818
+ end: ({
4819
+ kind: "text";
4820
+ blockId: string;
4821
+ offset: number;
4822
+ }) | ({
4823
+ kind: "nodeEdge";
4824
+ node: {
4825
+ kind: "block";
4826
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
4827
+ nodeId: string;
4828
+ };
4829
+ edge: "before" | "after";
4830
+ });
4831
+ }) | ({
4832
+ kind?: "trackedChange";
4833
+ trackedChangeId: string;
4834
+ story?: ({
4835
+ kind: "story";
4836
+ storyType: "body";
4837
+ }) | ({
4838
+ kind: "story";
4839
+ storyType: "headerFooterSlot";
4840
+ section: {
4841
+ kind: "section";
4842
+ sectionId: string;
4843
+ };
4844
+ headerFooterKind: "header" | "footer";
4845
+ variant: "default" | "first" | "even";
4846
+ resolution?: "effective" | "explicit";
4847
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4848
+ }) | ({
4849
+ kind: "story";
4850
+ storyType: "headerFooterPart";
4851
+ refId: string;
4852
+ }) | ({
4853
+ kind: "story";
4854
+ storyType: "footnote";
4855
+ noteId: string;
4856
+ }) | ({
4857
+ kind: "story";
4858
+ storyType: "endnote";
4859
+ noteId: string;
4860
+ });
4861
+ });
4862
+ status?: string;
4863
+ isInternal?: boolean;
4864
+ blockId?: string;
4865
+ start?: number;
4866
+ end?: number;
4867
+ }
4868
+ export interface DocCommentsDeleteParams {
4869
+ doc?: string;
4870
+ sessionId?: string;
4871
+ out?: string;
4872
+ force?: boolean;
4873
+ expectedRevision?: number;
4874
+ changeMode?: string;
4875
+ id: string;
4876
+ }
4877
+ export interface DocCommentsGetParams {
4878
+ doc?: string;
4879
+ sessionId?: string;
4880
+ id: string;
4881
+ }
4882
+ export interface DocCommentsListParams {
4883
+ doc?: string;
4884
+ sessionId?: string;
4885
+ includeResolved?: boolean;
4886
+ limit?: number;
4887
+ offset?: number;
4888
+ }
4889
+ export interface DocTrackChangesListParams {
4890
+ doc?: string;
4891
+ sessionId?: string;
4892
+ limit?: number;
4893
+ offset?: number;
4894
+ type?: string;
4895
+ in?: (({
4896
+ kind: "story";
4897
+ storyType: "body";
4898
+ }) | ({
4899
+ kind: "story";
4900
+ storyType: "headerFooterSlot";
4901
+ section: {
4902
+ kind: "section";
4903
+ sectionId: string;
4904
+ };
4905
+ headerFooterKind: "header" | "footer";
4906
+ variant: "default" | "first" | "even";
4907
+ resolution?: "effective" | "explicit";
4908
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4909
+ }) | ({
4910
+ kind: "story";
4911
+ storyType: "headerFooterPart";
4912
+ refId: string;
4913
+ }) | ({
4914
+ kind: "story";
4915
+ storyType: "footnote";
4916
+ noteId: string;
4917
+ }) | ({
4918
+ kind: "story";
4919
+ storyType: "endnote";
4920
+ noteId: string;
4921
+ })) | "all";
4922
+ }
4923
+ export interface DocTrackChangesGetParams {
4924
+ doc?: string;
4925
+ sessionId?: string;
4926
+ id: string;
4927
+ story?: ({
4928
+ kind: "story";
4929
+ storyType: "body";
4930
+ }) | ({
4931
+ kind: "story";
4932
+ storyType: "headerFooterSlot";
4933
+ section: {
4934
+ kind: "section";
4935
+ sectionId: string;
4936
+ };
4937
+ headerFooterKind: "header" | "footer";
4938
+ variant: "default" | "first" | "even";
4939
+ resolution?: "effective" | "explicit";
4940
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
4941
+ }) | ({
4942
+ kind: "story";
4943
+ storyType: "headerFooterPart";
4944
+ refId: string;
4945
+ }) | ({
4946
+ kind: "story";
4947
+ storyType: "footnote";
4948
+ noteId: string;
4949
+ }) | ({
4950
+ kind: "story";
4951
+ storyType: "endnote";
4952
+ noteId: string;
4953
+ });
4954
+ }
4955
+ export interface DocTrackChangesDecideParams {
4956
+ doc?: string;
4957
+ sessionId?: string;
4958
+ out?: string;
4959
+ force?: boolean;
4960
+ expectedRevision?: number;
4961
+ changeMode?: string;
4962
+ decision: string;
4963
+ target: ({
4964
+ id: string;
4663
4965
  story?: ({
4664
4966
  kind: "story";
4665
4967
  storyType: "body";
@@ -4687,8 +4989,102 @@ export interface DocTrackChangesDecideParams {
4687
4989
  storyType: "endnote";
4688
4990
  noteId: string;
4689
4991
  });
4992
+ }) | ({
4993
+ kind: "range";
4994
+ range: {
4995
+ kind: "text";
4996
+ segments: Array<{
4997
+ blockId: string;
4998
+ range: {
4999
+ start: number;
5000
+ end: number;
5001
+ };
5002
+ }>;
5003
+ story?: ({
5004
+ kind: "story";
5005
+ storyType: "body";
5006
+ }) | ({
5007
+ kind: "story";
5008
+ storyType: "headerFooterSlot";
5009
+ section: {
5010
+ kind: "section";
5011
+ sectionId: string;
5012
+ };
5013
+ headerFooterKind: "header" | "footer";
5014
+ variant: "default" | "first" | "even";
5015
+ resolution?: "effective" | "explicit";
5016
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
5017
+ }) | ({
5018
+ kind: "story";
5019
+ storyType: "headerFooterPart";
5020
+ refId: string;
5021
+ }) | ({
5022
+ kind: "story";
5023
+ storyType: "footnote";
5024
+ noteId: string;
5025
+ }) | ({
5026
+ kind: "story";
5027
+ storyType: "endnote";
5028
+ noteId: string;
5029
+ });
5030
+ };
5031
+ story?: ({
5032
+ kind: "story";
5033
+ storyType: "body";
5034
+ }) | ({
5035
+ kind: "story";
5036
+ storyType: "headerFooterSlot";
5037
+ section: {
5038
+ kind: "section";
5039
+ sectionId: string;
5040
+ };
5041
+ headerFooterKind: "header" | "footer";
5042
+ variant: "default" | "first" | "even";
5043
+ resolution?: "effective" | "explicit";
5044
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
5045
+ }) | ({
5046
+ kind: "story";
5047
+ storyType: "headerFooterPart";
5048
+ refId: string;
5049
+ }) | ({
5050
+ kind: "story";
5051
+ storyType: "footnote";
5052
+ noteId: string;
5053
+ }) | ({
5054
+ kind: "story";
5055
+ storyType: "endnote";
5056
+ noteId: string;
5057
+ });
5058
+ part?: string;
4690
5059
  }) | ({
4691
5060
  scope: "all";
5061
+ story?: (({
5062
+ kind: "story";
5063
+ storyType: "body";
5064
+ }) | ({
5065
+ kind: "story";
5066
+ storyType: "headerFooterSlot";
5067
+ section: {
5068
+ kind: "section";
5069
+ sectionId: string;
5070
+ };
5071
+ headerFooterKind: "header" | "footer";
5072
+ variant: "default" | "first" | "even";
5073
+ resolution?: "effective" | "explicit";
5074
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
5075
+ }) | ({
5076
+ kind: "story";
5077
+ storyType: "headerFooterPart";
5078
+ refId: string;
5079
+ }) | ({
5080
+ kind: "story";
5081
+ storyType: "footnote";
5082
+ noteId: string;
5083
+ }) | ({
5084
+ kind: "story";
5085
+ storyType: "endnote";
5086
+ noteId: string;
5087
+ })) | "all";
4692
5088
  });
4693
5089
  }
4694
5090
  export interface DocQueryMatchParams {
@@ -10084,12 +10480,16 @@ export interface DocOpenParams {
10084
10480
  overrideType?: string;
10085
10481
  onMissing?: string;
10086
10482
  bootstrapSettlingMs?: number;
10483
+ trackChanges?: {
10484
+ replacements?: "paired" | "independent";
10485
+ };
10087
10486
  userName?: string;
10088
10487
  userEmail?: string;
10089
10488
  password?: string;
10090
10489
  }
10091
10490
  export interface DocSaveParams {
10092
10491
  sessionId?: string;
10492
+ mode?: string;
10093
10493
  out?: string;
10094
10494
  force?: boolean;
10095
10495
  inPlace?: boolean;
@@ -10309,7 +10709,7 @@ export type DocExtractResult = {
10309
10709
  }>;
10310
10710
  trackedChanges: Array<{
10311
10711
  entityId: string;
10312
- type: "insert" | "delete" | "format";
10712
+ type: "insert" | "delete" | "replacement" | "format";
10313
10713
  blockIds?: Array<string>;
10314
10714
  wordRevisionIds?: {
10315
10715
  insert?: string;
@@ -10482,66 +10882,229 @@ export type DocInsertResult = {
10482
10882
  });
10483
10883
  };
10484
10884
  };
10485
- evaluatedRevision?: {
10486
- before: string;
10487
- after: string;
10488
- };
10489
- };
10490
- export type DocReplaceResult = {
10491
- success: true;
10492
- resolution?: {
10493
- target: ({
10494
- kind: "text";
10495
- blockId: string;
10496
- range: {
10497
- start: number;
10498
- end: number;
10885
+ evaluatedRevision?: {
10886
+ before: string;
10887
+ after: string;
10888
+ };
10889
+ };
10890
+ export type DocReplaceResult = {
10891
+ success: true;
10892
+ resolution?: {
10893
+ target: ({
10894
+ kind: "text";
10895
+ blockId: string;
10896
+ range: {
10897
+ start: number;
10898
+ end: number;
10899
+ };
10900
+ }) | ({
10901
+ kind: "block";
10902
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
10903
+ nodeId: string;
10904
+ });
10905
+ range: {
10906
+ from: number;
10907
+ to: number;
10908
+ };
10909
+ selectionTarget?: {
10910
+ kind: "selection";
10911
+ start: ({
10912
+ kind: "text";
10913
+ blockId: string;
10914
+ offset: number;
10915
+ }) | ({
10916
+ kind: "nodeEdge";
10917
+ node: {
10918
+ kind: "block";
10919
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10920
+ nodeId: string;
10921
+ };
10922
+ edge: "before" | "after";
10923
+ });
10924
+ end: ({
10925
+ kind: "text";
10926
+ blockId: string;
10927
+ offset: number;
10928
+ }) | ({
10929
+ kind: "nodeEdge";
10930
+ node: {
10931
+ kind: "block";
10932
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10933
+ nodeId: string;
10934
+ };
10935
+ edge: "before" | "after";
10936
+ });
10937
+ };
10938
+ };
10939
+ evaluatedRevision?: {
10940
+ before: string;
10941
+ after: string;
10942
+ };
10943
+ };
10944
+ export type DocDeleteResult = {
10945
+ success: true;
10946
+ resolution: {
10947
+ requestedTarget?: {
10948
+ kind: "text";
10949
+ blockId: string;
10950
+ range: {
10951
+ start: number;
10952
+ end: number;
10953
+ };
10954
+ };
10955
+ target: {
10956
+ kind: "text";
10957
+ blockId: string;
10958
+ range: {
10959
+ start: number;
10960
+ end: number;
10961
+ };
10962
+ };
10963
+ range: {
10964
+ from: number;
10965
+ to: number;
10966
+ };
10967
+ text: string;
10968
+ selectionTarget?: {
10969
+ kind: "selection";
10970
+ start: ({
10971
+ kind: "text";
10972
+ blockId: string;
10973
+ offset: number;
10974
+ }) | ({
10975
+ kind: "nodeEdge";
10976
+ node: {
10977
+ kind: "block";
10978
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10979
+ nodeId: string;
10980
+ };
10981
+ edge: "before" | "after";
10982
+ });
10983
+ end: ({
10984
+ kind: "text";
10985
+ blockId: string;
10986
+ offset: number;
10987
+ }) | ({
10988
+ kind: "nodeEdge";
10989
+ node: {
10990
+ kind: "block";
10991
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10992
+ nodeId: string;
10993
+ };
10994
+ edge: "before" | "after";
10995
+ });
10996
+ };
10997
+ };
10998
+ inserted?: Array<({
10999
+ kind: "entity";
11000
+ entityType: "comment";
11001
+ entityId: string;
11002
+ }) | ({
11003
+ kind: "entity";
11004
+ entityType: "trackedChange";
11005
+ entityId: string;
11006
+ story?: ({
11007
+ kind: "story";
11008
+ storyType: "body";
11009
+ }) | ({
11010
+ kind: "story";
11011
+ storyType: "headerFooterSlot";
11012
+ section: {
11013
+ kind: "section";
11014
+ sectionId: string;
10499
11015
  };
11016
+ headerFooterKind: "header" | "footer";
11017
+ variant: "default" | "first" | "even";
11018
+ resolution?: "effective" | "explicit";
11019
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
10500
11020
  }) | ({
10501
- kind: "block";
10502
- nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
10503
- nodeId: string;
11021
+ kind: "story";
11022
+ storyType: "headerFooterPart";
11023
+ refId: string;
11024
+ }) | ({
11025
+ kind: "story";
11026
+ storyType: "footnote";
11027
+ noteId: string;
11028
+ }) | ({
11029
+ kind: "story";
11030
+ storyType: "endnote";
11031
+ noteId: string;
10504
11032
  });
10505
- range: {
10506
- from: number;
10507
- to: number;
10508
- };
10509
- selectionTarget?: {
10510
- kind: "selection";
10511
- start: ({
10512
- kind: "text";
10513
- blockId: string;
10514
- offset: number;
10515
- }) | ({
10516
- kind: "nodeEdge";
10517
- node: {
10518
- kind: "block";
10519
- nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10520
- nodeId: string;
10521
- };
10522
- edge: "before" | "after";
10523
- });
10524
- end: ({
10525
- kind: "text";
10526
- blockId: string;
10527
- offset: number;
10528
- }) | ({
10529
- kind: "nodeEdge";
10530
- node: {
10531
- kind: "block";
10532
- nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10533
- nodeId: string;
10534
- };
10535
- edge: "before" | "after";
10536
- });
10537
- };
10538
- };
10539
- evaluatedRevision?: {
10540
- before: string;
10541
- after: string;
10542
- };
11033
+ })>;
11034
+ updated?: Array<({
11035
+ kind: "entity";
11036
+ entityType: "comment";
11037
+ entityId: string;
11038
+ }) | ({
11039
+ kind: "entity";
11040
+ entityType: "trackedChange";
11041
+ entityId: string;
11042
+ story?: ({
11043
+ kind: "story";
11044
+ storyType: "body";
11045
+ }) | ({
11046
+ kind: "story";
11047
+ storyType: "headerFooterSlot";
11048
+ section: {
11049
+ kind: "section";
11050
+ sectionId: string;
11051
+ };
11052
+ headerFooterKind: "header" | "footer";
11053
+ variant: "default" | "first" | "even";
11054
+ resolution?: "effective" | "explicit";
11055
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
11056
+ }) | ({
11057
+ kind: "story";
11058
+ storyType: "headerFooterPart";
11059
+ refId: string;
11060
+ }) | ({
11061
+ kind: "story";
11062
+ storyType: "footnote";
11063
+ noteId: string;
11064
+ }) | ({
11065
+ kind: "story";
11066
+ storyType: "endnote";
11067
+ noteId: string;
11068
+ });
11069
+ })>;
11070
+ removed?: Array<({
11071
+ kind: "entity";
11072
+ entityType: "comment";
11073
+ entityId: string;
11074
+ }) | ({
11075
+ kind: "entity";
11076
+ entityType: "trackedChange";
11077
+ entityId: string;
11078
+ story?: ({
11079
+ kind: "story";
11080
+ storyType: "body";
11081
+ }) | ({
11082
+ kind: "story";
11083
+ storyType: "headerFooterSlot";
11084
+ section: {
11085
+ kind: "section";
11086
+ sectionId: string;
11087
+ };
11088
+ headerFooterKind: "header" | "footer";
11089
+ variant: "default" | "first" | "even";
11090
+ resolution?: "effective" | "explicit";
11091
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
11092
+ }) | ({
11093
+ kind: "story";
11094
+ storyType: "headerFooterPart";
11095
+ refId: string;
11096
+ }) | ({
11097
+ kind: "story";
11098
+ storyType: "footnote";
11099
+ noteId: string;
11100
+ }) | ({
11101
+ kind: "story";
11102
+ storyType: "endnote";
11103
+ noteId: string;
11104
+ });
11105
+ })>;
10543
11106
  };
10544
- export type DocDeleteResult = {
11107
+ export type DocFormatRangeResult = {
10545
11108
  success: true;
10546
11109
  resolution: {
10547
11110
  requestedTarget?: {
@@ -19449,6 +20012,7 @@ export type DocListsSetLevelLayoutResult = {
19449
20012
  };
19450
20013
  export type DocCommentsCreateResult = {
19451
20014
  success: true;
20015
+ id: string;
19452
20016
  inserted?: Array<({
19453
20017
  kind: "entity";
19454
20018
  entityType: "comment";
@@ -19669,88 +20233,138 @@ export type DocCommentsPatchResult = {
19669
20233
  });
19670
20234
  })>;
19671
20235
  };
19672
- export type DocCommentsDeleteResult = {
19673
- success: true;
19674
- inserted?: Array<({
19675
- kind: "entity";
19676
- entityType: "comment";
19677
- entityId: string;
19678
- }) | ({
19679
- kind: "entity";
19680
- entityType: "trackedChange";
19681
- entityId: string;
19682
- story?: ({
19683
- kind: "story";
19684
- storyType: "body";
19685
- }) | ({
19686
- kind: "story";
19687
- storyType: "headerFooterSlot";
19688
- section: {
19689
- kind: "section";
19690
- sectionId: string;
19691
- };
19692
- headerFooterKind: "header" | "footer";
19693
- variant: "default" | "first" | "even";
19694
- resolution?: "effective" | "explicit";
19695
- onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
19696
- }) | ({
19697
- kind: "story";
19698
- storyType: "headerFooterPart";
19699
- refId: string;
19700
- }) | ({
19701
- kind: "story";
19702
- storyType: "footnote";
19703
- noteId: string;
19704
- }) | ({
19705
- kind: "story";
19706
- storyType: "endnote";
19707
- noteId: string;
19708
- });
19709
- })>;
19710
- updated?: Array<({
20236
+ export type DocCommentsDeleteResult = {
20237
+ success: true;
20238
+ inserted?: Array<({
20239
+ kind: "entity";
20240
+ entityType: "comment";
20241
+ entityId: string;
20242
+ }) | ({
20243
+ kind: "entity";
20244
+ entityType: "trackedChange";
20245
+ entityId: string;
20246
+ story?: ({
20247
+ kind: "story";
20248
+ storyType: "body";
20249
+ }) | ({
20250
+ kind: "story";
20251
+ storyType: "headerFooterSlot";
20252
+ section: {
20253
+ kind: "section";
20254
+ sectionId: string;
20255
+ };
20256
+ headerFooterKind: "header" | "footer";
20257
+ variant: "default" | "first" | "even";
20258
+ resolution?: "effective" | "explicit";
20259
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20260
+ }) | ({
20261
+ kind: "story";
20262
+ storyType: "headerFooterPart";
20263
+ refId: string;
20264
+ }) | ({
20265
+ kind: "story";
20266
+ storyType: "footnote";
20267
+ noteId: string;
20268
+ }) | ({
20269
+ kind: "story";
20270
+ storyType: "endnote";
20271
+ noteId: string;
20272
+ });
20273
+ })>;
20274
+ updated?: Array<({
20275
+ kind: "entity";
20276
+ entityType: "comment";
20277
+ entityId: string;
20278
+ }) | ({
20279
+ kind: "entity";
20280
+ entityType: "trackedChange";
20281
+ entityId: string;
20282
+ story?: ({
20283
+ kind: "story";
20284
+ storyType: "body";
20285
+ }) | ({
20286
+ kind: "story";
20287
+ storyType: "headerFooterSlot";
20288
+ section: {
20289
+ kind: "section";
20290
+ sectionId: string;
20291
+ };
20292
+ headerFooterKind: "header" | "footer";
20293
+ variant: "default" | "first" | "even";
20294
+ resolution?: "effective" | "explicit";
20295
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20296
+ }) | ({
20297
+ kind: "story";
20298
+ storyType: "headerFooterPart";
20299
+ refId: string;
20300
+ }) | ({
20301
+ kind: "story";
20302
+ storyType: "footnote";
20303
+ noteId: string;
20304
+ }) | ({
20305
+ kind: "story";
20306
+ storyType: "endnote";
20307
+ noteId: string;
20308
+ });
20309
+ })>;
20310
+ removed?: Array<({
20311
+ kind: "entity";
20312
+ entityType: "comment";
20313
+ entityId: string;
20314
+ }) | ({
20315
+ kind: "entity";
20316
+ entityType: "trackedChange";
20317
+ entityId: string;
20318
+ story?: ({
20319
+ kind: "story";
20320
+ storyType: "body";
20321
+ }) | ({
20322
+ kind: "story";
20323
+ storyType: "headerFooterSlot";
20324
+ section: {
20325
+ kind: "section";
20326
+ sectionId: string;
20327
+ };
20328
+ headerFooterKind: "header" | "footer";
20329
+ variant: "default" | "first" | "even";
20330
+ resolution?: "effective" | "explicit";
20331
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20332
+ }) | ({
20333
+ kind: "story";
20334
+ storyType: "headerFooterPart";
20335
+ refId: string;
20336
+ }) | ({
20337
+ kind: "story";
20338
+ storyType: "footnote";
20339
+ noteId: string;
20340
+ }) | ({
20341
+ kind: "story";
20342
+ storyType: "endnote";
20343
+ noteId: string;
20344
+ });
20345
+ })>;
20346
+ };
20347
+ export type DocCommentsGetResult = {
20348
+ address: {
19711
20349
  kind: "entity";
19712
20350
  entityType: "comment";
19713
20351
  entityId: string;
19714
- }) | ({
19715
- kind: "entity";
19716
- entityType: "trackedChange";
19717
- entityId: string;
19718
- story?: ({
19719
- kind: "story";
19720
- storyType: "body";
19721
- }) | ({
19722
- kind: "story";
19723
- storyType: "headerFooterSlot";
19724
- section: {
19725
- kind: "section";
19726
- sectionId: string;
20352
+ };
20353
+ commentId: string;
20354
+ importedId?: string;
20355
+ parentCommentId?: string;
20356
+ text?: string;
20357
+ isInternal?: boolean;
20358
+ status: "open" | "resolved";
20359
+ target?: {
20360
+ kind: "text";
20361
+ segments: Array<{
20362
+ blockId: string;
20363
+ range: {
20364
+ start: number;
20365
+ end: number;
19727
20366
  };
19728
- headerFooterKind: "header" | "footer";
19729
- variant: "default" | "first" | "even";
19730
- resolution?: "effective" | "explicit";
19731
- onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
19732
- }) | ({
19733
- kind: "story";
19734
- storyType: "headerFooterPart";
19735
- refId: string;
19736
- }) | ({
19737
- kind: "story";
19738
- storyType: "footnote";
19739
- noteId: string;
19740
- }) | ({
19741
- kind: "story";
19742
- storyType: "endnote";
19743
- noteId: string;
19744
- });
19745
- })>;
19746
- removed?: Array<({
19747
- kind: "entity";
19748
- entityType: "comment";
19749
- entityId: string;
19750
- }) | ({
19751
- kind: "entity";
19752
- entityType: "trackedChange";
19753
- entityId: string;
20367
+ }>;
19754
20368
  story?: ({
19755
20369
  kind: "story";
19756
20370
  storyType: "body";
@@ -19778,30 +20392,49 @@ export type DocCommentsDeleteResult = {
19778
20392
  storyType: "endnote";
19779
20393
  noteId: string;
19780
20394
  });
19781
- })>;
19782
- };
19783
- export type DocCommentsGetResult = {
19784
- address: {
19785
- kind: "entity";
19786
- entityType: "comment";
19787
- entityId: string;
19788
20395
  };
19789
- commentId: string;
19790
- importedId?: string;
19791
- parentCommentId?: string;
19792
- text?: string;
19793
- isInternal?: boolean;
19794
- status: "open" | "resolved";
19795
- target?: {
19796
- kind: "text";
19797
- segments: Array<{
19798
- blockId: string;
19799
- range: {
19800
- start: number;
19801
- end: number;
19802
- };
19803
- }>;
19804
- story?: ({
20396
+ anchoredText?: string;
20397
+ createdTime?: number;
20398
+ creatorName?: string;
20399
+ creatorEmail?: string;
20400
+ trackedChange?: boolean;
20401
+ trackedChangeType?: "insert" | "delete" | "replacement" | "format";
20402
+ trackedChangeDisplayType?: unknown;
20403
+ trackedChangeStory?: (({
20404
+ kind: "story";
20405
+ storyType: "body";
20406
+ }) | ({
20407
+ kind: "story";
20408
+ storyType: "headerFooterSlot";
20409
+ section: {
20410
+ kind: "section";
20411
+ sectionId: string;
20412
+ };
20413
+ headerFooterKind: "header" | "footer";
20414
+ variant: "default" | "first" | "even";
20415
+ resolution?: "effective" | "explicit";
20416
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20417
+ }) | ({
20418
+ kind: "story";
20419
+ storyType: "headerFooterPart";
20420
+ refId: string;
20421
+ }) | ({
20422
+ kind: "story";
20423
+ storyType: "footnote";
20424
+ noteId: string;
20425
+ }) | ({
20426
+ kind: "story";
20427
+ storyType: "endnote";
20428
+ noteId: string;
20429
+ })) | null;
20430
+ trackedChangeAnchorKey?: unknown;
20431
+ trackedChangeText?: unknown;
20432
+ deletedText?: unknown;
20433
+ trackedChangeLink?: ({
20434
+ trackedChange?: true;
20435
+ trackedChangeType?: "insert" | "delete" | "replacement" | "format";
20436
+ trackedChangeDisplayType?: unknown;
20437
+ trackedChangeStory?: (({
19805
20438
  kind: "story";
19806
20439
  storyType: "body";
19807
20440
  }) | ({
@@ -19827,12 +20460,11 @@ export type DocCommentsGetResult = {
19827
20460
  kind: "story";
19828
20461
  storyType: "endnote";
19829
20462
  noteId: string;
19830
- });
19831
- };
19832
- anchoredText?: string;
19833
- createdTime?: number;
19834
- creatorName?: string;
19835
- creatorEmail?: string;
20463
+ })) | null;
20464
+ trackedChangeAnchorKey?: unknown;
20465
+ trackedChangeText?: unknown;
20466
+ deletedText?: unknown;
20467
+ }) | null;
19836
20468
  };
19837
20469
  export type DocCommentsListResult = {
19838
20470
  evaluatedRevision: string;
@@ -19895,6 +20527,74 @@ export type DocCommentsListResult = {
19895
20527
  createdTime?: number;
19896
20528
  creatorName?: string;
19897
20529
  creatorEmail?: string;
20530
+ trackedChange?: boolean;
20531
+ trackedChangeType?: "insert" | "delete" | "replacement" | "format";
20532
+ trackedChangeDisplayType?: unknown;
20533
+ trackedChangeStory?: (({
20534
+ kind: "story";
20535
+ storyType: "body";
20536
+ }) | ({
20537
+ kind: "story";
20538
+ storyType: "headerFooterSlot";
20539
+ section: {
20540
+ kind: "section";
20541
+ sectionId: string;
20542
+ };
20543
+ headerFooterKind: "header" | "footer";
20544
+ variant: "default" | "first" | "even";
20545
+ resolution?: "effective" | "explicit";
20546
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20547
+ }) | ({
20548
+ kind: "story";
20549
+ storyType: "headerFooterPart";
20550
+ refId: string;
20551
+ }) | ({
20552
+ kind: "story";
20553
+ storyType: "footnote";
20554
+ noteId: string;
20555
+ }) | ({
20556
+ kind: "story";
20557
+ storyType: "endnote";
20558
+ noteId: string;
20559
+ })) | null;
20560
+ trackedChangeAnchorKey?: unknown;
20561
+ trackedChangeText?: unknown;
20562
+ deletedText?: unknown;
20563
+ trackedChangeLink?: ({
20564
+ trackedChange?: true;
20565
+ trackedChangeType?: "insert" | "delete" | "replacement" | "format";
20566
+ trackedChangeDisplayType?: unknown;
20567
+ trackedChangeStory?: (({
20568
+ kind: "story";
20569
+ storyType: "body";
20570
+ }) | ({
20571
+ kind: "story";
20572
+ storyType: "headerFooterSlot";
20573
+ section: {
20574
+ kind: "section";
20575
+ sectionId: string;
20576
+ };
20577
+ headerFooterKind: "header" | "footer";
20578
+ variant: "default" | "first" | "even";
20579
+ resolution?: "effective" | "explicit";
20580
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
20581
+ }) | ({
20582
+ kind: "story";
20583
+ storyType: "headerFooterPart";
20584
+ refId: string;
20585
+ }) | ({
20586
+ kind: "story";
20587
+ storyType: "footnote";
20588
+ noteId: string;
20589
+ }) | ({
20590
+ kind: "story";
20591
+ storyType: "endnote";
20592
+ noteId: string;
20593
+ })) | null;
20594
+ trackedChangeAnchorKey?: unknown;
20595
+ trackedChangeText?: unknown;
20596
+ deletedText?: unknown;
20597
+ }) | null;
19898
20598
  }>;
19899
20599
  page: {
19900
20600
  limit: number;
@@ -19944,7 +20644,9 @@ export type DocTrackChangesListResult = {
19944
20644
  noteId: string;
19945
20645
  });
19946
20646
  };
19947
- type: "insert" | "delete" | "format";
20647
+ type: "insert" | "delete" | "replacement" | "format";
20648
+ grouping?: "standalone" | "replacement-pair" | "unknown";
20649
+ pairedWithChangeId?: unknown;
19948
20650
  wordRevisionIds?: {
19949
20651
  insert?: string;
19950
20652
  delete?: string;
@@ -19955,6 +20657,8 @@ export type DocTrackChangesListResult = {
19955
20657
  authorImage?: string;
19956
20658
  date?: string;
19957
20659
  excerpt?: string;
20660
+ insertedText?: string;
20661
+ deletedText?: string;
19958
20662
  }>;
19959
20663
  page: {
19960
20664
  limit: number;
@@ -19996,7 +20700,9 @@ export type DocTrackChangesGetResult = {
19996
20700
  });
19997
20701
  };
19998
20702
  id: string;
19999
- type: "insert" | "delete" | "format";
20703
+ type: "insert" | "delete" | "replacement" | "format";
20704
+ grouping?: "standalone" | "replacement-pair" | "unknown";
20705
+ pairedWithChangeId?: unknown;
20000
20706
  wordRevisionIds?: {
20001
20707
  insert?: string;
20002
20708
  delete?: string;
@@ -20007,6 +20713,8 @@ export type DocTrackChangesGetResult = {
20007
20713
  authorImage?: string;
20008
20714
  date?: string;
20009
20715
  excerpt?: string;
20716
+ insertedText?: string;
20717
+ deletedText?: string;
20010
20718
  };
20011
20719
  export type DocTrackChangesDecideResult = {
20012
20720
  success: true;
@@ -20766,6 +21474,12 @@ export type DocCapabilitiesGetResult = {
20766
21474
  dryRun: boolean;
20767
21475
  reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
20768
21476
  };
21477
+ formatRange: {
21478
+ available: boolean;
21479
+ tracked: boolean;
21480
+ dryRun: boolean;
21481
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
21482
+ };
20769
21483
  "blocks.list": {
20770
21484
  available: boolean;
20771
21485
  tracked: boolean;
@@ -26860,6 +27574,7 @@ export type DocSaveResult = {
26860
27574
  contextId: string;
26861
27575
  saved: boolean;
26862
27576
  inPlace?: boolean;
27577
+ mode?: "review-preserving" | "final";
26863
27578
  document?: {
26864
27579
  path?: string;
26865
27580
  source?: string;
@@ -27425,11 +28140,159 @@ export interface DocDeleteBoundParams {
27425
28140
  storyType: "endnote";
27426
28141
  noteId: string;
27427
28142
  });
27428
- behavior?: string;
28143
+ behavior?: string;
28144
+ ref?: string;
28145
+ blockId?: string;
28146
+ start?: number;
28147
+ end?: number;
28148
+ }
28149
+ export interface DocFormatRangeBoundParams {
28150
+ out?: string;
28151
+ force?: boolean;
28152
+ expectedRevision?: number;
28153
+ changeMode?: string;
28154
+ dryRun?: boolean;
28155
+ target?: {
28156
+ kind: "selection";
28157
+ start: ({
28158
+ kind: "text";
28159
+ blockId: string;
28160
+ offset: number;
28161
+ }) | ({
28162
+ kind: "nodeEdge";
28163
+ node: {
28164
+ kind: "block";
28165
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
28166
+ nodeId: string;
28167
+ };
28168
+ edge: "before" | "after";
28169
+ });
28170
+ end: ({
28171
+ kind: "text";
28172
+ blockId: string;
28173
+ offset: number;
28174
+ }) | ({
28175
+ kind: "nodeEdge";
28176
+ node: {
28177
+ kind: "block";
28178
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
28179
+ nodeId: string;
28180
+ };
28181
+ edge: "before" | "after";
28182
+ });
28183
+ };
28184
+ in?: ({
28185
+ kind: "story";
28186
+ storyType: "body";
28187
+ }) | ({
28188
+ kind: "story";
28189
+ storyType: "headerFooterSlot";
28190
+ section: {
28191
+ kind: "section";
28192
+ sectionId: string;
28193
+ };
28194
+ headerFooterKind: "header" | "footer";
28195
+ variant: "default" | "first" | "even";
28196
+ resolution?: "effective" | "explicit";
28197
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
28198
+ }) | ({
28199
+ kind: "story";
28200
+ storyType: "headerFooterPart";
28201
+ refId: string;
28202
+ }) | ({
28203
+ kind: "story";
28204
+ storyType: "footnote";
28205
+ noteId: string;
28206
+ }) | ({
28207
+ kind: "story";
28208
+ storyType: "endnote";
28209
+ noteId: string;
28210
+ });
28211
+ properties: {
28212
+ bold?: boolean | unknown;
28213
+ italic?: boolean | unknown;
28214
+ strike?: boolean | unknown;
28215
+ underline?: boolean | unknown | ({
28216
+ style?: string | unknown;
28217
+ color?: string | unknown;
28218
+ themeColor?: string | unknown;
28219
+ });
28220
+ highlight?: string | unknown;
28221
+ color?: string | unknown;
28222
+ fontSize?: number | unknown;
28223
+ fontFamily?: string | unknown;
28224
+ letterSpacing?: number | unknown;
28225
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
28226
+ position?: number | unknown;
28227
+ dstrike?: boolean | unknown;
28228
+ smallCaps?: boolean | unknown;
28229
+ caps?: boolean | unknown;
28230
+ shading?: ({
28231
+ fill?: string | unknown;
28232
+ color?: string | unknown;
28233
+ val?: string | unknown;
28234
+ }) | unknown;
28235
+ border?: ({
28236
+ val?: string | unknown;
28237
+ sz?: number | unknown;
28238
+ color?: string | unknown;
28239
+ space?: number | unknown;
28240
+ }) | unknown;
28241
+ outline?: boolean | unknown;
28242
+ shadow?: boolean | unknown;
28243
+ emboss?: boolean | unknown;
28244
+ imprint?: boolean | unknown;
28245
+ charScale?: number | unknown;
28246
+ kerning?: number | unknown;
28247
+ vanish?: boolean | unknown;
28248
+ webHidden?: boolean | unknown;
28249
+ specVanish?: boolean | unknown;
28250
+ rtl?: boolean | unknown;
28251
+ cs?: boolean | unknown;
28252
+ bCs?: boolean | unknown;
28253
+ iCs?: boolean | unknown;
28254
+ eastAsianLayout?: ({
28255
+ id?: string | unknown;
28256
+ combine?: boolean | unknown;
28257
+ combineBrackets?: string | unknown;
28258
+ vert?: boolean | unknown;
28259
+ vertCompress?: boolean | unknown;
28260
+ }) | unknown;
28261
+ em?: string | unknown;
28262
+ fitText?: ({
28263
+ val?: number | unknown;
28264
+ id?: string | unknown;
28265
+ }) | unknown;
28266
+ snapToGrid?: boolean | unknown;
28267
+ lang?: ({
28268
+ val?: string | unknown;
28269
+ eastAsia?: string | unknown;
28270
+ bidi?: string | unknown;
28271
+ }) | unknown;
28272
+ oMath?: boolean | unknown;
28273
+ rStyle?: string | unknown;
28274
+ rFonts?: ({
28275
+ ascii?: string | unknown;
28276
+ hAnsi?: string | unknown;
28277
+ eastAsia?: string | unknown;
28278
+ cs?: string | unknown;
28279
+ asciiTheme?: string | unknown;
28280
+ hAnsiTheme?: string | unknown;
28281
+ eastAsiaTheme?: string | unknown;
28282
+ csTheme?: string | unknown;
28283
+ hint?: string | unknown;
28284
+ }) | unknown;
28285
+ fontSizeCs?: number | unknown;
28286
+ ligatures?: string | unknown;
28287
+ numForm?: string | unknown;
28288
+ numSpacing?: string | unknown;
28289
+ stylisticSets?: (Array<{
28290
+ id: number;
28291
+ val?: boolean;
28292
+ }>) | unknown;
28293
+ contextualAlternates?: boolean | unknown;
28294
+ };
27429
28295
  ref?: string;
27430
- blockId?: string;
27431
- start?: number;
27432
- end?: number;
27433
28296
  }
27434
28297
  export interface DocBlocksListBoundParams {
27435
28298
  offset?: number;
@@ -31239,6 +32102,64 @@ export interface DocCommentsCreateBoundParams {
31239
32102
  storyType: "endnote";
31240
32103
  noteId: string;
31241
32104
  });
32105
+ }) | ({
32106
+ kind: "selection";
32107
+ start: ({
32108
+ kind: "text";
32109
+ blockId: string;
32110
+ offset: number;
32111
+ }) | ({
32112
+ kind: "nodeEdge";
32113
+ node: {
32114
+ kind: "block";
32115
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
32116
+ nodeId: string;
32117
+ };
32118
+ edge: "before" | "after";
32119
+ });
32120
+ end: ({
32121
+ kind: "text";
32122
+ blockId: string;
32123
+ offset: number;
32124
+ }) | ({
32125
+ kind: "nodeEdge";
32126
+ node: {
32127
+ kind: "block";
32128
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
32129
+ nodeId: string;
32130
+ };
32131
+ edge: "before" | "after";
32132
+ });
32133
+ }) | ({
32134
+ kind?: "trackedChange";
32135
+ trackedChangeId: string;
32136
+ story?: ({
32137
+ kind: "story";
32138
+ storyType: "body";
32139
+ }) | ({
32140
+ kind: "story";
32141
+ storyType: "headerFooterSlot";
32142
+ section: {
32143
+ kind: "section";
32144
+ sectionId: string;
32145
+ };
32146
+ headerFooterKind: "header" | "footer";
32147
+ variant: "default" | "first" | "even";
32148
+ resolution?: "effective" | "explicit";
32149
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32150
+ }) | ({
32151
+ kind: "story";
32152
+ storyType: "headerFooterPart";
32153
+ refId: string;
32154
+ }) | ({
32155
+ kind: "story";
32156
+ storyType: "footnote";
32157
+ noteId: string;
32158
+ }) | ({
32159
+ kind: "story";
32160
+ storyType: "endnote";
32161
+ noteId: string;
32162
+ });
31242
32163
  });
31243
32164
  parentId?: string;
31244
32165
  blockId?: string;
@@ -31252,14 +32173,108 @@ export interface DocCommentsPatchBoundParams {
31252
32173
  changeMode?: string;
31253
32174
  id?: string;
31254
32175
  text?: string;
31255
- target?: {
32176
+ target?: ({
31256
32177
  kind: "text";
31257
32178
  blockId: string;
31258
32179
  range: {
31259
32180
  start: number;
31260
32181
  end: number;
31261
32182
  };
31262
- };
32183
+ }) | ({
32184
+ kind: "text";
32185
+ segments: Array<{
32186
+ blockId: string;
32187
+ range: {
32188
+ start: number;
32189
+ end: number;
32190
+ };
32191
+ }>;
32192
+ story?: ({
32193
+ kind: "story";
32194
+ storyType: "body";
32195
+ }) | ({
32196
+ kind: "story";
32197
+ storyType: "headerFooterSlot";
32198
+ section: {
32199
+ kind: "section";
32200
+ sectionId: string;
32201
+ };
32202
+ headerFooterKind: "header" | "footer";
32203
+ variant: "default" | "first" | "even";
32204
+ resolution?: "effective" | "explicit";
32205
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32206
+ }) | ({
32207
+ kind: "story";
32208
+ storyType: "headerFooterPart";
32209
+ refId: string;
32210
+ }) | ({
32211
+ kind: "story";
32212
+ storyType: "footnote";
32213
+ noteId: string;
32214
+ }) | ({
32215
+ kind: "story";
32216
+ storyType: "endnote";
32217
+ noteId: string;
32218
+ });
32219
+ }) | ({
32220
+ kind: "selection";
32221
+ start: ({
32222
+ kind: "text";
32223
+ blockId: string;
32224
+ offset: number;
32225
+ }) | ({
32226
+ kind: "nodeEdge";
32227
+ node: {
32228
+ kind: "block";
32229
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
32230
+ nodeId: string;
32231
+ };
32232
+ edge: "before" | "after";
32233
+ });
32234
+ end: ({
32235
+ kind: "text";
32236
+ blockId: string;
32237
+ offset: number;
32238
+ }) | ({
32239
+ kind: "nodeEdge";
32240
+ node: {
32241
+ kind: "block";
32242
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
32243
+ nodeId: string;
32244
+ };
32245
+ edge: "before" | "after";
32246
+ });
32247
+ }) | ({
32248
+ kind?: "trackedChange";
32249
+ trackedChangeId: string;
32250
+ story?: ({
32251
+ kind: "story";
32252
+ storyType: "body";
32253
+ }) | ({
32254
+ kind: "story";
32255
+ storyType: "headerFooterSlot";
32256
+ section: {
32257
+ kind: "section";
32258
+ sectionId: string;
32259
+ };
32260
+ headerFooterKind: "header" | "footer";
32261
+ variant: "default" | "first" | "even";
32262
+ resolution?: "effective" | "explicit";
32263
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32264
+ }) | ({
32265
+ kind: "story";
32266
+ storyType: "headerFooterPart";
32267
+ refId: string;
32268
+ }) | ({
32269
+ kind: "story";
32270
+ storyType: "footnote";
32271
+ noteId: string;
32272
+ }) | ({
32273
+ kind: "story";
32274
+ storyType: "endnote";
32275
+ noteId: string;
32276
+ });
32277
+ });
31263
32278
  status?: string;
31264
32279
  isInternal?: boolean;
31265
32280
  blockId?: string;
@@ -31378,8 +32393,102 @@ export interface DocTrackChangesDecideBoundParams {
31378
32393
  storyType: "endnote";
31379
32394
  noteId: string;
31380
32395
  });
32396
+ }) | ({
32397
+ kind: "range";
32398
+ range: {
32399
+ kind: "text";
32400
+ segments: Array<{
32401
+ blockId: string;
32402
+ range: {
32403
+ start: number;
32404
+ end: number;
32405
+ };
32406
+ }>;
32407
+ story?: ({
32408
+ kind: "story";
32409
+ storyType: "body";
32410
+ }) | ({
32411
+ kind: "story";
32412
+ storyType: "headerFooterSlot";
32413
+ section: {
32414
+ kind: "section";
32415
+ sectionId: string;
32416
+ };
32417
+ headerFooterKind: "header" | "footer";
32418
+ variant: "default" | "first" | "even";
32419
+ resolution?: "effective" | "explicit";
32420
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32421
+ }) | ({
32422
+ kind: "story";
32423
+ storyType: "headerFooterPart";
32424
+ refId: string;
32425
+ }) | ({
32426
+ kind: "story";
32427
+ storyType: "footnote";
32428
+ noteId: string;
32429
+ }) | ({
32430
+ kind: "story";
32431
+ storyType: "endnote";
32432
+ noteId: string;
32433
+ });
32434
+ };
32435
+ story?: ({
32436
+ kind: "story";
32437
+ storyType: "body";
32438
+ }) | ({
32439
+ kind: "story";
32440
+ storyType: "headerFooterSlot";
32441
+ section: {
32442
+ kind: "section";
32443
+ sectionId: string;
32444
+ };
32445
+ headerFooterKind: "header" | "footer";
32446
+ variant: "default" | "first" | "even";
32447
+ resolution?: "effective" | "explicit";
32448
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32449
+ }) | ({
32450
+ kind: "story";
32451
+ storyType: "headerFooterPart";
32452
+ refId: string;
32453
+ }) | ({
32454
+ kind: "story";
32455
+ storyType: "footnote";
32456
+ noteId: string;
32457
+ }) | ({
32458
+ kind: "story";
32459
+ storyType: "endnote";
32460
+ noteId: string;
32461
+ });
32462
+ part?: string;
31381
32463
  }) | ({
31382
32464
  scope: "all";
32465
+ story?: (({
32466
+ kind: "story";
32467
+ storyType: "body";
32468
+ }) | ({
32469
+ kind: "story";
32470
+ storyType: "headerFooterSlot";
32471
+ section: {
32472
+ kind: "section";
32473
+ sectionId: string;
32474
+ };
32475
+ headerFooterKind: "header" | "footer";
32476
+ variant: "default" | "first" | "even";
32477
+ resolution?: "effective" | "explicit";
32478
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
32479
+ }) | ({
32480
+ kind: "story";
32481
+ storyType: "headerFooterPart";
32482
+ refId: string;
32483
+ }) | ({
32484
+ kind: "story";
32485
+ storyType: "footnote";
32486
+ noteId: string;
32487
+ }) | ({
32488
+ kind: "story";
32489
+ storyType: "endnote";
32490
+ noteId: string;
32491
+ })) | "all";
31383
32492
  });
31384
32493
  }
31385
32494
  export interface DocQueryMatchBoundParams {
@@ -36239,6 +37348,7 @@ export interface DocMetadataResolveBoundParams {
36239
37348
  id: string;
36240
37349
  }
36241
37350
  export interface DocSaveBoundParams {
37351
+ mode?: string;
36242
37352
  out?: string;
36243
37353
  force?: boolean;
36244
37354
  inPlace?: boolean;
@@ -36284,6 +37394,7 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
36284
37394
  insert: (params?: DocInsertParams, options?: InvokeOptions) => Promise<DocInsertResult>;
36285
37395
  replace: (params?: DocReplaceParams, options?: InvokeOptions) => Promise<DocReplaceResult>;
36286
37396
  delete: (params?: DocDeleteParams, options?: InvokeOptions) => Promise<DocDeleteResult>;
37397
+ formatRange: (params: DocFormatRangeParams, options?: InvokeOptions) => Promise<DocFormatRangeResult>;
36287
37398
  blocks: {
36288
37399
  list: (params?: DocBlocksListParams, options?: InvokeOptions) => Promise<DocBlocksListResult>;
36289
37400
  delete: (params?: DocBlocksDeleteParams, options?: InvokeOptions) => Promise<DocBlocksDeleteResult>;
@@ -36801,6 +37912,7 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
36801
37912
  insert: (params?: DocInsertBoundParams, options?: InvokeOptions) => Promise<DocInsertResult>;
36802
37913
  replace: (params?: DocReplaceBoundParams, options?: InvokeOptions) => Promise<DocReplaceResult>;
36803
37914
  delete: (params?: DocDeleteBoundParams, options?: InvokeOptions) => Promise<DocDeleteResult>;
37915
+ formatRange: (params: DocFormatRangeBoundParams, options?: InvokeOptions) => Promise<DocFormatRangeResult>;
36804
37916
  blocks: {
36805
37917
  list: (params?: DocBlocksListBoundParams, options?: InvokeOptions) => Promise<DocBlocksListResult>;
36806
37918
  delete: (params?: DocBlocksDeleteBoundParams, options?: InvokeOptions) => Promise<DocBlocksDeleteResult>;