@superdoc-dev/sdk 1.0.0-alpha.1 → 1.0.0-alpha.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.
@@ -6,29 +6,44 @@ import type { SuperDocRuntime, InvokeOptions } from '../runtime/process';
6
6
 
7
7
  export interface DocOpenParams {
8
8
  doc: string;
9
- replace?: boolean;
10
9
  sessionId?: string;
11
- collaboration?: Record<string, unknown> | unknown[];
10
+ collaboration?: {
11
+ providerType: string;
12
+ url: string;
13
+ documentId: string;
14
+ tokenEnv?: string;
15
+ syncTimeoutMs?: number;
16
+ };
12
17
  }
13
18
 
14
19
  export interface DocStatusParams {
15
20
  sessionId?: string;
16
21
  }
17
22
 
18
- export interface DocCloseParams {
23
+ export interface DocSaveParams {
19
24
  sessionId?: string;
20
- save?: boolean;
21
25
  inPlace?: boolean;
22
26
  out?: string;
23
- discard?: boolean;
24
27
  force?: boolean;
25
28
  }
26
29
 
30
+ export interface DocCloseParams {
31
+ sessionId?: string;
32
+ discard?: boolean;
33
+ }
34
+
27
35
  export interface DocInfoParams {
28
36
  doc?: string;
29
37
  sessionId?: string;
30
38
  }
31
39
 
40
+ export interface DocDescribeParams {
41
+ }
42
+
43
+ export interface DocDescribeCommandParams {
44
+ operationId: string;
45
+ }
46
+
32
47
  export interface DocFindParams {
33
48
  doc?: string;
34
49
  sessionId?: string;
@@ -42,14 +57,79 @@ export interface DocFindParams {
42
57
  offset?: number;
43
58
  include?: string[];
44
59
  includeUnknown?: boolean;
45
- query?: Record<string, unknown> | unknown[];
46
- within?: Record<string, unknown> | unknown[];
60
+ query?: {
61
+ select: {
62
+ type: string;
63
+ nodeType?: string;
64
+ kind?: "block" | "inline";
65
+ pattern?: string;
66
+ mode?: "contains" | "regex";
67
+ caseSensitive?: boolean;
68
+ };
69
+ within?: ({
70
+ kind: "block";
71
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
72
+ nodeId: string;
73
+ }) | ({
74
+ kind: "inline";
75
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
76
+ anchor: {
77
+ start: {
78
+ blockId: string;
79
+ offset: number;
80
+ };
81
+ end: {
82
+ blockId: string;
83
+ offset: number;
84
+ };
85
+ };
86
+ });
87
+ limit?: number;
88
+ offset?: number;
89
+ include?: Array<string>;
90
+ includeUnknown?: boolean;
91
+ };
92
+ within?: ({
93
+ kind: "block";
94
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
95
+ nodeId: string;
96
+ }) | ({
97
+ kind: "inline";
98
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
99
+ anchor: {
100
+ start: {
101
+ blockId: string;
102
+ offset: number;
103
+ };
104
+ end: {
105
+ blockId: string;
106
+ offset: number;
107
+ };
108
+ };
109
+ });
47
110
  }
48
111
 
49
112
  export interface DocGetNodeParams {
50
113
  doc?: string;
51
114
  sessionId?: string;
52
- address: Record<string, unknown> | unknown[];
115
+ address: ({
116
+ kind: "block";
117
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
118
+ nodeId: string;
119
+ }) | ({
120
+ kind: "inline";
121
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
122
+ anchor: {
123
+ start: {
124
+ blockId: string;
125
+ offset: number;
126
+ };
127
+ end: {
128
+ blockId: string;
129
+ offset: number;
130
+ };
131
+ };
132
+ });
53
133
  }
54
134
 
55
135
  export interface DocGetNodeByIdParams {
@@ -62,7 +142,14 @@ export interface DocGetNodeByIdParams {
62
142
  export interface DocCommentsAddParams {
63
143
  doc?: string;
64
144
  sessionId?: string;
65
- target: Record<string, unknown> | unknown[];
145
+ target: {
146
+ kind: "text";
147
+ blockId: string;
148
+ range: {
149
+ start: number;
150
+ end: number;
151
+ };
152
+ };
66
153
  text: string;
67
154
  out?: string;
68
155
  force?: boolean;
@@ -93,7 +180,14 @@ export interface DocCommentsMoveParams {
93
180
  doc?: string;
94
181
  sessionId?: string;
95
182
  id: string;
96
- target: Record<string, unknown> | unknown[];
183
+ target: {
184
+ kind: "text";
185
+ blockId: string;
186
+ range: {
187
+ start: number;
188
+ end: number;
189
+ };
190
+ };
97
191
  out?: string;
98
192
  force?: boolean;
99
193
  expectedRevision?: number;
@@ -152,10 +246,38 @@ export interface DocCommentsListParams {
152
246
  includeResolved?: boolean;
153
247
  }
154
248
 
249
+ export interface DocCreateParagraphParams {
250
+ doc?: string;
251
+ sessionId?: string;
252
+ input?: {
253
+ at?: {
254
+ kind: string;
255
+ target?: {
256
+ kind: string;
257
+ nodeType: string;
258
+ nodeId: string;
259
+ };
260
+ };
261
+ text?: string;
262
+ };
263
+ changeMode?: string;
264
+ out?: string;
265
+ dryRun?: boolean;
266
+ force?: boolean;
267
+ expectedRevision?: number;
268
+ }
269
+
155
270
  export interface DocInsertParams {
156
271
  doc?: string;
157
272
  sessionId?: string;
158
- target: Record<string, unknown> | unknown[];
273
+ target?: {
274
+ kind: "text";
275
+ blockId: string;
276
+ range: {
277
+ start: number;
278
+ end: number;
279
+ };
280
+ };
159
281
  text: string;
160
282
  changeMode?: string;
161
283
  out?: string;
@@ -167,7 +289,14 @@ export interface DocInsertParams {
167
289
  export interface DocReplaceParams {
168
290
  doc?: string;
169
291
  sessionId?: string;
170
- target: Record<string, unknown> | unknown[];
292
+ target: {
293
+ kind: "text";
294
+ blockId: string;
295
+ range: {
296
+ start: number;
297
+ end: number;
298
+ };
299
+ };
171
300
  text: string;
172
301
  changeMode?: string;
173
302
  out?: string;
@@ -179,7 +308,14 @@ export interface DocReplaceParams {
179
308
  export interface DocDeleteParams {
180
309
  doc?: string;
181
310
  sessionId?: string;
182
- target: Record<string, unknown> | unknown[];
311
+ target: {
312
+ kind: "text";
313
+ blockId: string;
314
+ range: {
315
+ start: number;
316
+ end: number;
317
+ };
318
+ };
183
319
  changeMode?: string;
184
320
  out?: string;
185
321
  dryRun?: boolean;
@@ -190,7 +326,14 @@ export interface DocDeleteParams {
190
326
  export interface DocFormatBoldParams {
191
327
  doc?: string;
192
328
  sessionId?: string;
193
- target: Record<string, unknown> | unknown[];
329
+ target: {
330
+ kind: "text";
331
+ blockId: string;
332
+ range: {
333
+ start: number;
334
+ end: number;
335
+ };
336
+ };
194
337
  changeMode?: string;
195
338
  out?: string;
196
339
  dryRun?: boolean;
@@ -249,15 +392,18 @@ export interface DocTrackChangesRejectAllParams {
249
392
  export interface DocSessionListParams {
250
393
  }
251
394
 
252
- export interface DocSessionCloseParams {
395
+ export interface DocSessionSaveParams {
253
396
  sessionId: string;
254
- save?: boolean;
255
397
  inPlace?: boolean;
256
398
  out?: string;
257
- discard?: boolean;
258
399
  force?: boolean;
259
400
  }
260
401
 
402
+ export interface DocSessionCloseParams {
403
+ sessionId: string;
404
+ discard?: boolean;
405
+ }
406
+
261
407
  export interface DocSessionSetDefaultParams {
262
408
  sessionId: string;
263
409
  }
@@ -265,7 +411,6 @@ export interface DocSessionSetDefaultParams {
265
411
  export type DocOpenResult = {
266
412
  active: boolean;
267
413
  contextId: string;
268
- replaced: boolean;
269
414
  document: {
270
415
  path?: string;
271
416
  source: string;
@@ -311,6 +456,26 @@ export type DocStatusResult = {
311
456
  lastSavedAt?: string;
312
457
  };
313
458
 
459
+ export type DocSaveResult = {
460
+ contextId: string;
461
+ saved: boolean;
462
+ inPlace: boolean;
463
+ document: {
464
+ path?: string;
465
+ source: string;
466
+ revision: number;
467
+ };
468
+ context: {
469
+ dirty: boolean;
470
+ revision: number;
471
+ lastSavedAt?: string;
472
+ };
473
+ output: {
474
+ path: string;
475
+ byteLength: number;
476
+ };
477
+ };
478
+
314
479
  export type DocCloseResult = {
315
480
  contextId: string;
316
481
  closed: boolean;
@@ -357,6 +522,91 @@ export type DocInfoResult = {
357
522
  };
358
523
  };
359
524
 
525
+ export type DocDescribeResult = {
526
+ contractVersion: string;
527
+ cli: {
528
+ package: string;
529
+ minVersion: string;
530
+ binaryName: string;
531
+ };
532
+ protocol: {
533
+ defaultOutput: string;
534
+ successEnvelope: Array<string>;
535
+ errorEnvelope: Array<string>;
536
+ host: {
537
+ protocolVersion: string;
538
+ features: Array<string>;
539
+ notifications: Array<string>;
540
+ };
541
+ };
542
+ invariants: Array<string>;
543
+ operationCount: number;
544
+ operations: Array<{
545
+ id: string;
546
+ command: Array<string>;
547
+ description: string;
548
+ category: string;
549
+ stability: string;
550
+ mutates: boolean;
551
+ requiresOpenContext: boolean;
552
+ capabilities?: Array<string>;
553
+ aliases?: Array<string>;
554
+ examples?: Array<string>;
555
+ errors?: Array<string>;
556
+ }>;
557
+ };
558
+
559
+ export type DocDescribeCommandResult = {
560
+ contractVersion: string;
561
+ query: string;
562
+ operation: {
563
+ id: string;
564
+ command: Array<string>;
565
+ description: string;
566
+ category: string;
567
+ stability: string;
568
+ mutates: boolean;
569
+ requiresOpenContext: boolean;
570
+ capabilities?: Array<string>;
571
+ aliases?: Array<string>;
572
+ examples?: Array<string>;
573
+ params: Array<{
574
+ name: string;
575
+ kind: string;
576
+ type: string;
577
+ flag?: string;
578
+ required?: boolean;
579
+ schema?: ({
580
+ type: string;
581
+ items?: unknown;
582
+ properties?: unknown;
583
+ required?: Array<string>;
584
+ }) | ({
585
+ oneOf: Array<unknown>;
586
+ });
587
+ }>;
588
+ constraints?: {
589
+ mutuallyExclusive?: Array<Array<string>>;
590
+ requiresOneOf?: Array<Array<string>>;
591
+ requiredWhen?: Array<{
592
+ param: string;
593
+ whenParam: string;
594
+ equals?: unknown;
595
+ present?: boolean;
596
+ }>;
597
+ };
598
+ response: ({
599
+ type: string;
600
+ items?: unknown;
601
+ properties?: unknown;
602
+ required?: Array<string>;
603
+ }) | ({
604
+ oneOf: Array<unknown>;
605
+ });
606
+ errors: Array<string>;
607
+ };
608
+ };
609
+
360
610
  export type DocFindResult = {
361
611
  document: {
362
612
  path?: string;
@@ -364,8 +614,507 @@ export type DocFindResult = {
364
614
  byteLength: number;
365
615
  revision: number;
366
616
  };
367
- query: unknown;
368
- result: unknown;
617
+ query: {
618
+ select: {
619
+ type: string;
620
+ nodeType?: string;
621
+ kind?: "block" | "inline";
622
+ pattern?: string;
623
+ mode?: "contains" | "regex";
624
+ caseSensitive?: boolean;
625
+ };
626
+ within?: ({
627
+ kind: "block";
628
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
629
+ nodeId: string;
630
+ }) | ({
631
+ kind: "inline";
632
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
633
+ anchor: {
634
+ start: {
635
+ blockId: string;
636
+ offset: number;
637
+ };
638
+ end: {
639
+ blockId: string;
640
+ offset: number;
641
+ };
642
+ };
643
+ });
644
+ limit?: number;
645
+ offset?: number;
646
+ include?: Array<string>;
647
+ includeUnknown?: boolean;
648
+ };
649
+ result: {
650
+ matches: Array<({
651
+ kind: "block";
652
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
653
+ nodeId: string;
654
+ }) | ({
655
+ kind: "inline";
656
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
657
+ anchor: {
658
+ start: {
659
+ blockId: string;
660
+ offset: number;
661
+ };
662
+ end: {
663
+ blockId: string;
664
+ offset: number;
665
+ };
666
+ };
667
+ })>;
668
+ total: number;
669
+ nodes?: Array<({
670
+ summary?: {
671
+ label?: string;
672
+ text?: string;
673
+ };
674
+ text?: string;
675
+ nodes?: Array<unknown>;
676
+ nodeType: "paragraph";
677
+ kind: "block";
678
+ properties: {
679
+ styleId?: string;
680
+ alignment?: string;
681
+ indentation?: {
682
+ left?: number;
683
+ right?: number;
684
+ firstLine?: number;
685
+ hanging?: number;
686
+ unit?: string;
687
+ };
688
+ spacing?: {
689
+ before?: number;
690
+ after?: number;
691
+ line?: number;
692
+ unit?: string;
693
+ };
694
+ keepWithNext?: boolean;
695
+ outlineLevel?: number;
696
+ paragraphNumbering?: {
697
+ numId?: number;
698
+ level?: number;
699
+ };
700
+ };
701
+ }) | ({
702
+ summary?: {
703
+ label?: string;
704
+ text?: string;
705
+ };
706
+ text?: string;
707
+ nodes?: Array<unknown>;
708
+ nodeType: "heading";
709
+ kind: "block";
710
+ properties: {
711
+ styleId?: string;
712
+ alignment?: string;
713
+ indentation?: {
714
+ left?: number;
715
+ right?: number;
716
+ firstLine?: number;
717
+ hanging?: number;
718
+ unit?: string;
719
+ };
720
+ spacing?: {
721
+ before?: number;
722
+ after?: number;
723
+ line?: number;
724
+ unit?: string;
725
+ };
726
+ keepWithNext?: boolean;
727
+ outlineLevel?: number;
728
+ paragraphNumbering?: {
729
+ numId?: number;
730
+ level?: number;
731
+ };
732
+ headingLevel: 1 | 2 | 3 | 4 | 5 | 6;
733
+ };
734
+ }) | ({
735
+ summary?: {
736
+ label?: string;
737
+ text?: string;
738
+ };
739
+ text?: string;
740
+ nodes?: Array<unknown>;
741
+ nodeType: "listItem";
742
+ kind: "block";
743
+ properties: {
744
+ styleId?: string;
745
+ alignment?: string;
746
+ indentation?: {
747
+ left?: number;
748
+ right?: number;
749
+ firstLine?: number;
750
+ hanging?: number;
751
+ unit?: string;
752
+ };
753
+ spacing?: {
754
+ before?: number;
755
+ after?: number;
756
+ line?: number;
757
+ unit?: string;
758
+ };
759
+ keepWithNext?: boolean;
760
+ outlineLevel?: number;
761
+ paragraphNumbering?: {
762
+ numId?: number;
763
+ level?: number;
764
+ };
765
+ numbering?: {
766
+ marker?: string;
767
+ path?: Array<number>;
768
+ ordinal?: number;
769
+ listIndex?: number;
770
+ };
771
+ };
772
+ }) | ({
773
+ summary?: {
774
+ label?: string;
775
+ text?: string;
776
+ };
777
+ text?: string;
778
+ nodes?: Array<unknown>;
779
+ nodeType: "table";
780
+ kind: "block";
781
+ properties: {
782
+ layout?: string;
783
+ width?: number;
784
+ alignment?: string;
785
+ borders?: {
786
+ top?: string;
787
+ right?: string;
788
+ bottom?: string;
789
+ left?: string;
790
+ insideH?: string;
791
+ insideV?: string;
792
+ };
793
+ };
794
+ }) | ({
795
+ summary?: {
796
+ label?: string;
797
+ text?: string;
798
+ };
799
+ text?: string;
800
+ nodes?: Array<unknown>;
801
+ nodeType: "tableRow";
802
+ kind: "block";
803
+ properties: {
804
+ rowIndex?: number;
805
+ };
806
+ }) | ({
807
+ summary?: {
808
+ label?: string;
809
+ text?: string;
810
+ };
811
+ text?: string;
812
+ nodes?: Array<unknown>;
813
+ nodeType: "tableCell";
814
+ kind: "block";
815
+ properties: {
816
+ rowIndex?: number;
817
+ colIndex?: number;
818
+ width?: number;
819
+ shading?: string;
820
+ vMerge?: boolean;
821
+ gridSpan?: number;
822
+ padding?: number;
823
+ borders?: {
824
+ top?: string;
825
+ right?: string;
826
+ bottom?: string;
827
+ left?: string;
828
+ insideH?: string;
829
+ insideV?: string;
830
+ };
831
+ };
832
+ }) | ({
833
+ summary?: {
834
+ label?: string;
835
+ text?: string;
836
+ };
837
+ text?: string;
838
+ nodes?: Array<unknown>;
839
+ nodeType: "blockquote";
840
+ kind: "block";
841
+ properties: {
842
+ };
843
+ }) | ({
844
+ summary?: {
845
+ label?: string;
846
+ text?: string;
847
+ };
848
+ text?: string;
849
+ nodes?: Array<unknown>;
850
+ nodeType: "codeBlock";
851
+ kind: "block";
852
+ properties: {
853
+ };
854
+ }) | ({
855
+ summary?: {
856
+ label?: string;
857
+ text?: string;
858
+ };
859
+ text?: string;
860
+ nodes?: Array<unknown>;
861
+ nodeType: "image";
862
+ kind: "block";
863
+ properties: {
864
+ src?: string;
865
+ alt?: string;
866
+ size?: {
867
+ width?: number;
868
+ height?: number;
869
+ unit?: string;
870
+ };
871
+ wrap?: string;
872
+ };
873
+ }) | ({
874
+ summary?: {
875
+ label?: string;
876
+ text?: string;
877
+ };
878
+ text?: string;
879
+ nodes?: Array<unknown>;
880
+ nodeType: "image";
881
+ kind: "inline";
882
+ properties: {
883
+ src?: string;
884
+ alt?: string;
885
+ size?: {
886
+ width?: number;
887
+ height?: number;
888
+ unit?: string;
889
+ };
890
+ wrap?: string;
891
+ };
892
+ }) | ({
893
+ summary?: {
894
+ label?: string;
895
+ text?: string;
896
+ };
897
+ text?: string;
898
+ nodes?: Array<unknown>;
899
+ nodeType: "sdt";
900
+ kind: "block";
901
+ properties: {
902
+ tag?: string;
903
+ alias?: string;
904
+ type?: string;
905
+ appearance?: string;
906
+ placeholder?: string;
907
+ };
908
+ }) | ({
909
+ summary?: {
910
+ label?: string;
911
+ text?: string;
912
+ };
913
+ text?: string;
914
+ nodes?: Array<unknown>;
915
+ nodeType: "sdt";
916
+ kind: "inline";
917
+ properties: {
918
+ tag?: string;
919
+ alias?: string;
920
+ type?: string;
921
+ appearance?: string;
922
+ placeholder?: string;
923
+ };
924
+ }) | ({
925
+ summary?: {
926
+ label?: string;
927
+ text?: string;
928
+ };
929
+ text?: string;
930
+ nodes?: Array<unknown>;
931
+ nodeType: "field";
932
+ kind: "block";
933
+ properties: {
934
+ tag?: string;
935
+ alias?: string;
936
+ type?: string;
937
+ appearance?: string;
938
+ placeholder?: string;
939
+ fieldType?: string;
940
+ instruction?: string;
941
+ resultText?: string;
942
+ };
943
+ }) | ({
944
+ summary?: {
945
+ label?: string;
946
+ text?: string;
947
+ };
948
+ text?: string;
949
+ nodes?: Array<unknown>;
950
+ nodeType: "field";
951
+ kind: "inline";
952
+ properties: {
953
+ tag?: string;
954
+ alias?: string;
955
+ type?: string;
956
+ appearance?: string;
957
+ placeholder?: string;
958
+ fieldType?: string;
959
+ instruction?: string;
960
+ resultText?: string;
961
+ };
962
+ }) | ({
963
+ summary?: {
964
+ label?: string;
965
+ text?: string;
966
+ };
967
+ text?: string;
968
+ nodes?: Array<unknown>;
969
+ nodeType: "run";
970
+ kind: "inline";
971
+ properties: {
972
+ bold?: boolean;
973
+ italic?: boolean;
974
+ underline?: boolean;
975
+ font?: string;
976
+ size?: number;
977
+ color?: string;
978
+ highlight?: string;
979
+ styleId?: string;
980
+ language?: string;
981
+ };
982
+ }) | ({
983
+ summary?: {
984
+ label?: string;
985
+ text?: string;
986
+ };
987
+ text?: string;
988
+ nodes?: Array<unknown>;
989
+ nodeType: "bookmark";
990
+ kind: "inline";
991
+ properties: {
992
+ name?: string;
993
+ bookmarkId?: string;
994
+ };
995
+ }) | ({
996
+ summary?: {
997
+ label?: string;
998
+ text?: string;
999
+ };
1000
+ text?: string;
1001
+ nodes?: Array<unknown>;
1002
+ nodeType: "comment";
1003
+ kind: "inline";
1004
+ properties: {
1005
+ commentId: string;
1006
+ author?: string;
1007
+ status?: string;
1008
+ createdAt?: string;
1009
+ commentText?: string;
1010
+ };
1011
+ bodyText?: string;
1012
+ bodyNodes?: Array<unknown>;
1013
+ }) | ({
1014
+ summary?: {
1015
+ label?: string;
1016
+ text?: string;
1017
+ };
1018
+ text?: string;
1019
+ nodes?: Array<unknown>;
1020
+ nodeType: "hyperlink";
1021
+ kind: "inline";
1022
+ properties: {
1023
+ href?: string;
1024
+ anchor?: string;
1025
+ tooltip?: string;
1026
+ };
1027
+ }) | ({
1028
+ summary?: {
1029
+ label?: string;
1030
+ text?: string;
1031
+ };
1032
+ text?: string;
1033
+ nodes?: Array<unknown>;
1034
+ nodeType: "footnoteRef";
1035
+ kind: "inline";
1036
+ properties: {
1037
+ noteId?: string;
1038
+ };
1039
+ }) | ({
1040
+ summary?: {
1041
+ label?: string;
1042
+ text?: string;
1043
+ };
1044
+ text?: string;
1045
+ nodes?: Array<unknown>;
1046
+ nodeType: "tab";
1047
+ kind: "inline";
1048
+ properties: {
1049
+ };
1050
+ }) | ({
1051
+ summary?: {
1052
+ label?: string;
1053
+ text?: string;
1054
+ };
1055
+ text?: string;
1056
+ nodes?: Array<unknown>;
1057
+ nodeType: "lineBreak";
1058
+ kind: "inline";
1059
+ properties: {
1060
+ };
1061
+ })>;
1062
+ context?: Array<{
1063
+ address: ({
1064
+ kind: "block";
1065
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
1066
+ nodeId: string;
1067
+ }) | ({
1068
+ kind: "inline";
1069
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
1070
+ anchor: {
1071
+ start: {
1072
+ blockId: string;
1073
+ offset: number;
1074
+ };
1075
+ end: {
1076
+ blockId: string;
1077
+ offset: number;
1078
+ };
1079
+ };
1080
+ });
1081
+ snippet: string;
1082
+ highlightRange: {
1083
+ start: number;
1084
+ end: number;
1085
+ };
1086
+ textRanges?: Array<{
1087
+ kind: "text";
1088
+ blockId: string;
1089
+ range: {
1090
+ start: number;
1091
+ end: number;
1092
+ };
1093
+ }>;
1094
+ }>;
1095
+ diagnostics?: Array<{
1096
+ message: string;
1097
+ address?: ({
1098
+ kind: "block";
1099
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
1100
+ nodeId: string;
1101
+ }) | ({
1102
+ kind: "inline";
1103
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
1104
+ anchor: {
1105
+ start: {
1106
+ blockId: string;
1107
+ offset: number;
1108
+ };
1109
+ end: {
1110
+ blockId: string;
1111
+ offset: number;
1112
+ };
1113
+ };
1114
+ });
1115
+ hint?: string;
1116
+ }>;
1117
+ };
369
1118
  };
370
1119
 
371
1120
  export type DocGetNodeResult = {
@@ -375,8 +1124,417 @@ export type DocGetNodeResult = {
375
1124
  byteLength: number;
376
1125
  revision: number;
377
1126
  };
378
- address: unknown;
379
- node: unknown;
1127
+ address: ({
1128
+ kind: "block";
1129
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
1130
+ nodeId: string;
1131
+ }) | ({
1132
+ kind: "inline";
1133
+ nodeType: "run" | "field" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
1134
+ anchor: {
1135
+ start: {
1136
+ blockId: string;
1137
+ offset: number;
1138
+ };
1139
+ end: {
1140
+ blockId: string;
1141
+ offset: number;
1142
+ };
1143
+ };
1144
+ });
1145
+ node: ({
1146
+ summary?: {
1147
+ label?: string;
1148
+ text?: string;
1149
+ };
1150
+ text?: string;
1151
+ nodes?: Array<unknown>;
1152
+ nodeType: "paragraph";
1153
+ kind: "block";
1154
+ properties: {
1155
+ styleId?: string;
1156
+ alignment?: string;
1157
+ indentation?: {
1158
+ left?: number;
1159
+ right?: number;
1160
+ firstLine?: number;
1161
+ hanging?: number;
1162
+ unit?: string;
1163
+ };
1164
+ spacing?: {
1165
+ before?: number;
1166
+ after?: number;
1167
+ line?: number;
1168
+ unit?: string;
1169
+ };
1170
+ keepWithNext?: boolean;
1171
+ outlineLevel?: number;
1172
+ paragraphNumbering?: {
1173
+ numId?: number;
1174
+ level?: number;
1175
+ };
1176
+ };
1177
+ }) | ({
1178
+ summary?: {
1179
+ label?: string;
1180
+ text?: string;
1181
+ };
1182
+ text?: string;
1183
+ nodes?: Array<unknown>;
1184
+ nodeType: "heading";
1185
+ kind: "block";
1186
+ properties: {
1187
+ styleId?: string;
1188
+ alignment?: string;
1189
+ indentation?: {
1190
+ left?: number;
1191
+ right?: number;
1192
+ firstLine?: number;
1193
+ hanging?: number;
1194
+ unit?: string;
1195
+ };
1196
+ spacing?: {
1197
+ before?: number;
1198
+ after?: number;
1199
+ line?: number;
1200
+ unit?: string;
1201
+ };
1202
+ keepWithNext?: boolean;
1203
+ outlineLevel?: number;
1204
+ paragraphNumbering?: {
1205
+ numId?: number;
1206
+ level?: number;
1207
+ };
1208
+ headingLevel: 1 | 2 | 3 | 4 | 5 | 6;
1209
+ };
1210
+ }) | ({
1211
+ summary?: {
1212
+ label?: string;
1213
+ text?: string;
1214
+ };
1215
+ text?: string;
1216
+ nodes?: Array<unknown>;
1217
+ nodeType: "listItem";
1218
+ kind: "block";
1219
+ properties: {
1220
+ styleId?: string;
1221
+ alignment?: string;
1222
+ indentation?: {
1223
+ left?: number;
1224
+ right?: number;
1225
+ firstLine?: number;
1226
+ hanging?: number;
1227
+ unit?: string;
1228
+ };
1229
+ spacing?: {
1230
+ before?: number;
1231
+ after?: number;
1232
+ line?: number;
1233
+ unit?: string;
1234
+ };
1235
+ keepWithNext?: boolean;
1236
+ outlineLevel?: number;
1237
+ paragraphNumbering?: {
1238
+ numId?: number;
1239
+ level?: number;
1240
+ };
1241
+ numbering?: {
1242
+ marker?: string;
1243
+ path?: Array<number>;
1244
+ ordinal?: number;
1245
+ listIndex?: number;
1246
+ };
1247
+ };
1248
+ }) | ({
1249
+ summary?: {
1250
+ label?: string;
1251
+ text?: string;
1252
+ };
1253
+ text?: string;
1254
+ nodes?: Array<unknown>;
1255
+ nodeType: "table";
1256
+ kind: "block";
1257
+ properties: {
1258
+ layout?: string;
1259
+ width?: number;
1260
+ alignment?: string;
1261
+ borders?: {
1262
+ top?: string;
1263
+ right?: string;
1264
+ bottom?: string;
1265
+ left?: string;
1266
+ insideH?: string;
1267
+ insideV?: string;
1268
+ };
1269
+ };
1270
+ }) | ({
1271
+ summary?: {
1272
+ label?: string;
1273
+ text?: string;
1274
+ };
1275
+ text?: string;
1276
+ nodes?: Array<unknown>;
1277
+ nodeType: "tableRow";
1278
+ kind: "block";
1279
+ properties: {
1280
+ rowIndex?: number;
1281
+ };
1282
+ }) | ({
1283
+ summary?: {
1284
+ label?: string;
1285
+ text?: string;
1286
+ };
1287
+ text?: string;
1288
+ nodes?: Array<unknown>;
1289
+ nodeType: "tableCell";
1290
+ kind: "block";
1291
+ properties: {
1292
+ rowIndex?: number;
1293
+ colIndex?: number;
1294
+ width?: number;
1295
+ shading?: string;
1296
+ vMerge?: boolean;
1297
+ gridSpan?: number;
1298
+ padding?: number;
1299
+ borders?: {
1300
+ top?: string;
1301
+ right?: string;
1302
+ bottom?: string;
1303
+ left?: string;
1304
+ insideH?: string;
1305
+ insideV?: string;
1306
+ };
1307
+ };
1308
+ }) | ({
1309
+ summary?: {
1310
+ label?: string;
1311
+ text?: string;
1312
+ };
1313
+ text?: string;
1314
+ nodes?: Array<unknown>;
1315
+ nodeType: "blockquote";
1316
+ kind: "block";
1317
+ properties: {
1318
+ };
1319
+ }) | ({
1320
+ summary?: {
1321
+ label?: string;
1322
+ text?: string;
1323
+ };
1324
+ text?: string;
1325
+ nodes?: Array<unknown>;
1326
+ nodeType: "codeBlock";
1327
+ kind: "block";
1328
+ properties: {
1329
+ };
1330
+ }) | ({
1331
+ summary?: {
1332
+ label?: string;
1333
+ text?: string;
1334
+ };
1335
+ text?: string;
1336
+ nodes?: Array<unknown>;
1337
+ nodeType: "image";
1338
+ kind: "block";
1339
+ properties: {
1340
+ src?: string;
1341
+ alt?: string;
1342
+ size?: {
1343
+ width?: number;
1344
+ height?: number;
1345
+ unit?: string;
1346
+ };
1347
+ wrap?: string;
1348
+ };
1349
+ }) | ({
1350
+ summary?: {
1351
+ label?: string;
1352
+ text?: string;
1353
+ };
1354
+ text?: string;
1355
+ nodes?: Array<unknown>;
1356
+ nodeType: "image";
1357
+ kind: "inline";
1358
+ properties: {
1359
+ src?: string;
1360
+ alt?: string;
1361
+ size?: {
1362
+ width?: number;
1363
+ height?: number;
1364
+ unit?: string;
1365
+ };
1366
+ wrap?: string;
1367
+ };
1368
+ }) | ({
1369
+ summary?: {
1370
+ label?: string;
1371
+ text?: string;
1372
+ };
1373
+ text?: string;
1374
+ nodes?: Array<unknown>;
1375
+ nodeType: "sdt";
1376
+ kind: "block";
1377
+ properties: {
1378
+ tag?: string;
1379
+ alias?: string;
1380
+ type?: string;
1381
+ appearance?: string;
1382
+ placeholder?: string;
1383
+ };
1384
+ }) | ({
1385
+ summary?: {
1386
+ label?: string;
1387
+ text?: string;
1388
+ };
1389
+ text?: string;
1390
+ nodes?: Array<unknown>;
1391
+ nodeType: "sdt";
1392
+ kind: "inline";
1393
+ properties: {
1394
+ tag?: string;
1395
+ alias?: string;
1396
+ type?: string;
1397
+ appearance?: string;
1398
+ placeholder?: string;
1399
+ };
1400
+ }) | ({
1401
+ summary?: {
1402
+ label?: string;
1403
+ text?: string;
1404
+ };
1405
+ text?: string;
1406
+ nodes?: Array<unknown>;
1407
+ nodeType: "field";
1408
+ kind: "block";
1409
+ properties: {
1410
+ tag?: string;
1411
+ alias?: string;
1412
+ type?: string;
1413
+ appearance?: string;
1414
+ placeholder?: string;
1415
+ fieldType?: string;
1416
+ instruction?: string;
1417
+ resultText?: string;
1418
+ };
1419
+ }) | ({
1420
+ summary?: {
1421
+ label?: string;
1422
+ text?: string;
1423
+ };
1424
+ text?: string;
1425
+ nodes?: Array<unknown>;
1426
+ nodeType: "field";
1427
+ kind: "inline";
1428
+ properties: {
1429
+ tag?: string;
1430
+ alias?: string;
1431
+ type?: string;
1432
+ appearance?: string;
1433
+ placeholder?: string;
1434
+ fieldType?: string;
1435
+ instruction?: string;
1436
+ resultText?: string;
1437
+ };
1438
+ }) | ({
1439
+ summary?: {
1440
+ label?: string;
1441
+ text?: string;
1442
+ };
1443
+ text?: string;
1444
+ nodes?: Array<unknown>;
1445
+ nodeType: "run";
1446
+ kind: "inline";
1447
+ properties: {
1448
+ bold?: boolean;
1449
+ italic?: boolean;
1450
+ underline?: boolean;
1451
+ font?: string;
1452
+ size?: number;
1453
+ color?: string;
1454
+ highlight?: string;
1455
+ styleId?: string;
1456
+ language?: string;
1457
+ };
1458
+ }) | ({
1459
+ summary?: {
1460
+ label?: string;
1461
+ text?: string;
1462
+ };
1463
+ text?: string;
1464
+ nodes?: Array<unknown>;
1465
+ nodeType: "bookmark";
1466
+ kind: "inline";
1467
+ properties: {
1468
+ name?: string;
1469
+ bookmarkId?: string;
1470
+ };
1471
+ }) | ({
1472
+ summary?: {
1473
+ label?: string;
1474
+ text?: string;
1475
+ };
1476
+ text?: string;
1477
+ nodes?: Array<unknown>;
1478
+ nodeType: "comment";
1479
+ kind: "inline";
1480
+ properties: {
1481
+ commentId: string;
1482
+ author?: string;
1483
+ status?: string;
1484
+ createdAt?: string;
1485
+ commentText?: string;
1486
+ };
1487
+ bodyText?: string;
1488
+ bodyNodes?: Array<unknown>;
1489
+ }) | ({
1490
+ summary?: {
1491
+ label?: string;
1492
+ text?: string;
1493
+ };
1494
+ text?: string;
1495
+ nodes?: Array<unknown>;
1496
+ nodeType: "hyperlink";
1497
+ kind: "inline";
1498
+ properties: {
1499
+ href?: string;
1500
+ anchor?: string;
1501
+ tooltip?: string;
1502
+ };
1503
+ }) | ({
1504
+ summary?: {
1505
+ label?: string;
1506
+ text?: string;
1507
+ };
1508
+ text?: string;
1509
+ nodes?: Array<unknown>;
1510
+ nodeType: "footnoteRef";
1511
+ kind: "inline";
1512
+ properties: {
1513
+ noteId?: string;
1514
+ };
1515
+ }) | ({
1516
+ summary?: {
1517
+ label?: string;
1518
+ text?: string;
1519
+ };
1520
+ text?: string;
1521
+ nodes?: Array<unknown>;
1522
+ nodeType: "tab";
1523
+ kind: "inline";
1524
+ properties: {
1525
+ };
1526
+ }) | ({
1527
+ summary?: {
1528
+ label?: string;
1529
+ text?: string;
1530
+ };
1531
+ text?: string;
1532
+ nodes?: Array<unknown>;
1533
+ nodeType: "lineBreak";
1534
+ kind: "inline";
1535
+ properties: {
1536
+ };
1537
+ });
380
1538
  };
381
1539
 
382
1540
  export type DocGetNodeByIdResult = {
@@ -388,7 +1546,399 @@ export type DocGetNodeByIdResult = {
388
1546
  };
389
1547
  nodeId: string;
390
1548
  nodeType?: string;
391
- node: unknown;
1549
+ node: ({
1550
+ summary?: {
1551
+ label?: string;
1552
+ text?: string;
1553
+ };
1554
+ text?: string;
1555
+ nodes?: Array<unknown>;
1556
+ nodeType: "paragraph";
1557
+ kind: "block";
1558
+ properties: {
1559
+ styleId?: string;
1560
+ alignment?: string;
1561
+ indentation?: {
1562
+ left?: number;
1563
+ right?: number;
1564
+ firstLine?: number;
1565
+ hanging?: number;
1566
+ unit?: string;
1567
+ };
1568
+ spacing?: {
1569
+ before?: number;
1570
+ after?: number;
1571
+ line?: number;
1572
+ unit?: string;
1573
+ };
1574
+ keepWithNext?: boolean;
1575
+ outlineLevel?: number;
1576
+ paragraphNumbering?: {
1577
+ numId?: number;
1578
+ level?: number;
1579
+ };
1580
+ };
1581
+ }) | ({
1582
+ summary?: {
1583
+ label?: string;
1584
+ text?: string;
1585
+ };
1586
+ text?: string;
1587
+ nodes?: Array<unknown>;
1588
+ nodeType: "heading";
1589
+ kind: "block";
1590
+ properties: {
1591
+ styleId?: string;
1592
+ alignment?: string;
1593
+ indentation?: {
1594
+ left?: number;
1595
+ right?: number;
1596
+ firstLine?: number;
1597
+ hanging?: number;
1598
+ unit?: string;
1599
+ };
1600
+ spacing?: {
1601
+ before?: number;
1602
+ after?: number;
1603
+ line?: number;
1604
+ unit?: string;
1605
+ };
1606
+ keepWithNext?: boolean;
1607
+ outlineLevel?: number;
1608
+ paragraphNumbering?: {
1609
+ numId?: number;
1610
+ level?: number;
1611
+ };
1612
+ headingLevel: 1 | 2 | 3 | 4 | 5 | 6;
1613
+ };
1614
+ }) | ({
1615
+ summary?: {
1616
+ label?: string;
1617
+ text?: string;
1618
+ };
1619
+ text?: string;
1620
+ nodes?: Array<unknown>;
1621
+ nodeType: "listItem";
1622
+ kind: "block";
1623
+ properties: {
1624
+ styleId?: string;
1625
+ alignment?: string;
1626
+ indentation?: {
1627
+ left?: number;
1628
+ right?: number;
1629
+ firstLine?: number;
1630
+ hanging?: number;
1631
+ unit?: string;
1632
+ };
1633
+ spacing?: {
1634
+ before?: number;
1635
+ after?: number;
1636
+ line?: number;
1637
+ unit?: string;
1638
+ };
1639
+ keepWithNext?: boolean;
1640
+ outlineLevel?: number;
1641
+ paragraphNumbering?: {
1642
+ numId?: number;
1643
+ level?: number;
1644
+ };
1645
+ numbering?: {
1646
+ marker?: string;
1647
+ path?: Array<number>;
1648
+ ordinal?: number;
1649
+ listIndex?: number;
1650
+ };
1651
+ };
1652
+ }) | ({
1653
+ summary?: {
1654
+ label?: string;
1655
+ text?: string;
1656
+ };
1657
+ text?: string;
1658
+ nodes?: Array<unknown>;
1659
+ nodeType: "table";
1660
+ kind: "block";
1661
+ properties: {
1662
+ layout?: string;
1663
+ width?: number;
1664
+ alignment?: string;
1665
+ borders?: {
1666
+ top?: string;
1667
+ right?: string;
1668
+ bottom?: string;
1669
+ left?: string;
1670
+ insideH?: string;
1671
+ insideV?: string;
1672
+ };
1673
+ };
1674
+ }) | ({
1675
+ summary?: {
1676
+ label?: string;
1677
+ text?: string;
1678
+ };
1679
+ text?: string;
1680
+ nodes?: Array<unknown>;
1681
+ nodeType: "tableRow";
1682
+ kind: "block";
1683
+ properties: {
1684
+ rowIndex?: number;
1685
+ };
1686
+ }) | ({
1687
+ summary?: {
1688
+ label?: string;
1689
+ text?: string;
1690
+ };
1691
+ text?: string;
1692
+ nodes?: Array<unknown>;
1693
+ nodeType: "tableCell";
1694
+ kind: "block";
1695
+ properties: {
1696
+ rowIndex?: number;
1697
+ colIndex?: number;
1698
+ width?: number;
1699
+ shading?: string;
1700
+ vMerge?: boolean;
1701
+ gridSpan?: number;
1702
+ padding?: number;
1703
+ borders?: {
1704
+ top?: string;
1705
+ right?: string;
1706
+ bottom?: string;
1707
+ left?: string;
1708
+ insideH?: string;
1709
+ insideV?: string;
1710
+ };
1711
+ };
1712
+ }) | ({
1713
+ summary?: {
1714
+ label?: string;
1715
+ text?: string;
1716
+ };
1717
+ text?: string;
1718
+ nodes?: Array<unknown>;
1719
+ nodeType: "blockquote";
1720
+ kind: "block";
1721
+ properties: {
1722
+ };
1723
+ }) | ({
1724
+ summary?: {
1725
+ label?: string;
1726
+ text?: string;
1727
+ };
1728
+ text?: string;
1729
+ nodes?: Array<unknown>;
1730
+ nodeType: "codeBlock";
1731
+ kind: "block";
1732
+ properties: {
1733
+ };
1734
+ }) | ({
1735
+ summary?: {
1736
+ label?: string;
1737
+ text?: string;
1738
+ };
1739
+ text?: string;
1740
+ nodes?: Array<unknown>;
1741
+ nodeType: "image";
1742
+ kind: "block";
1743
+ properties: {
1744
+ src?: string;
1745
+ alt?: string;
1746
+ size?: {
1747
+ width?: number;
1748
+ height?: number;
1749
+ unit?: string;
1750
+ };
1751
+ wrap?: string;
1752
+ };
1753
+ }) | ({
1754
+ summary?: {
1755
+ label?: string;
1756
+ text?: string;
1757
+ };
1758
+ text?: string;
1759
+ nodes?: Array<unknown>;
1760
+ nodeType: "image";
1761
+ kind: "inline";
1762
+ properties: {
1763
+ src?: string;
1764
+ alt?: string;
1765
+ size?: {
1766
+ width?: number;
1767
+ height?: number;
1768
+ unit?: string;
1769
+ };
1770
+ wrap?: string;
1771
+ };
1772
+ }) | ({
1773
+ summary?: {
1774
+ label?: string;
1775
+ text?: string;
1776
+ };
1777
+ text?: string;
1778
+ nodes?: Array<unknown>;
1779
+ nodeType: "sdt";
1780
+ kind: "block";
1781
+ properties: {
1782
+ tag?: string;
1783
+ alias?: string;
1784
+ type?: string;
1785
+ appearance?: string;
1786
+ placeholder?: string;
1787
+ };
1788
+ }) | ({
1789
+ summary?: {
1790
+ label?: string;
1791
+ text?: string;
1792
+ };
1793
+ text?: string;
1794
+ nodes?: Array<unknown>;
1795
+ nodeType: "sdt";
1796
+ kind: "inline";
1797
+ properties: {
1798
+ tag?: string;
1799
+ alias?: string;
1800
+ type?: string;
1801
+ appearance?: string;
1802
+ placeholder?: string;
1803
+ };
1804
+ }) | ({
1805
+ summary?: {
1806
+ label?: string;
1807
+ text?: string;
1808
+ };
1809
+ text?: string;
1810
+ nodes?: Array<unknown>;
1811
+ nodeType: "field";
1812
+ kind: "block";
1813
+ properties: {
1814
+ tag?: string;
1815
+ alias?: string;
1816
+ type?: string;
1817
+ appearance?: string;
1818
+ placeholder?: string;
1819
+ fieldType?: string;
1820
+ instruction?: string;
1821
+ resultText?: string;
1822
+ };
1823
+ }) | ({
1824
+ summary?: {
1825
+ label?: string;
1826
+ text?: string;
1827
+ };
1828
+ text?: string;
1829
+ nodes?: Array<unknown>;
1830
+ nodeType: "field";
1831
+ kind: "inline";
1832
+ properties: {
1833
+ tag?: string;
1834
+ alias?: string;
1835
+ type?: string;
1836
+ appearance?: string;
1837
+ placeholder?: string;
1838
+ fieldType?: string;
1839
+ instruction?: string;
1840
+ resultText?: string;
1841
+ };
1842
+ }) | ({
1843
+ summary?: {
1844
+ label?: string;
1845
+ text?: string;
1846
+ };
1847
+ text?: string;
1848
+ nodes?: Array<unknown>;
1849
+ nodeType: "run";
1850
+ kind: "inline";
1851
+ properties: {
1852
+ bold?: boolean;
1853
+ italic?: boolean;
1854
+ underline?: boolean;
1855
+ font?: string;
1856
+ size?: number;
1857
+ color?: string;
1858
+ highlight?: string;
1859
+ styleId?: string;
1860
+ language?: string;
1861
+ };
1862
+ }) | ({
1863
+ summary?: {
1864
+ label?: string;
1865
+ text?: string;
1866
+ };
1867
+ text?: string;
1868
+ nodes?: Array<unknown>;
1869
+ nodeType: "bookmark";
1870
+ kind: "inline";
1871
+ properties: {
1872
+ name?: string;
1873
+ bookmarkId?: string;
1874
+ };
1875
+ }) | ({
1876
+ summary?: {
1877
+ label?: string;
1878
+ text?: string;
1879
+ };
1880
+ text?: string;
1881
+ nodes?: Array<unknown>;
1882
+ nodeType: "comment";
1883
+ kind: "inline";
1884
+ properties: {
1885
+ commentId: string;
1886
+ author?: string;
1887
+ status?: string;
1888
+ createdAt?: string;
1889
+ commentText?: string;
1890
+ };
1891
+ bodyText?: string;
1892
+ bodyNodes?: Array<unknown>;
1893
+ }) | ({
1894
+ summary?: {
1895
+ label?: string;
1896
+ text?: string;
1897
+ };
1898
+ text?: string;
1899
+ nodes?: Array<unknown>;
1900
+ nodeType: "hyperlink";
1901
+ kind: "inline";
1902
+ properties: {
1903
+ href?: string;
1904
+ anchor?: string;
1905
+ tooltip?: string;
1906
+ };
1907
+ }) | ({
1908
+ summary?: {
1909
+ label?: string;
1910
+ text?: string;
1911
+ };
1912
+ text?: string;
1913
+ nodes?: Array<unknown>;
1914
+ nodeType: "footnoteRef";
1915
+ kind: "inline";
1916
+ properties: {
1917
+ noteId?: string;
1918
+ };
1919
+ }) | ({
1920
+ summary?: {
1921
+ label?: string;
1922
+ text?: string;
1923
+ };
1924
+ text?: string;
1925
+ nodes?: Array<unknown>;
1926
+ nodeType: "tab";
1927
+ kind: "inline";
1928
+ properties: {
1929
+ };
1930
+ }) | ({
1931
+ summary?: {
1932
+ label?: string;
1933
+ text?: string;
1934
+ };
1935
+ text?: string;
1936
+ nodes?: Array<unknown>;
1937
+ nodeType: "lineBreak";
1938
+ kind: "inline";
1939
+ properties: {
1940
+ };
1941
+ });
392
1942
  };
393
1943
 
394
1944
  export type DocCommentsAddResult = {
@@ -398,9 +1948,38 @@ export type DocCommentsAddResult = {
398
1948
  byteLength: number;
399
1949
  revision: number;
400
1950
  };
401
- target: unknown;
1951
+ target: {
1952
+ kind: "text";
1953
+ blockId: string;
1954
+ range: {
1955
+ start: number;
1956
+ end: number;
1957
+ };
1958
+ };
402
1959
  text: string;
403
- receipt: unknown;
1960
+ receipt: {
1961
+ success: boolean;
1962
+ inserted?: Array<{
1963
+ kind: string;
1964
+ entityType: string;
1965
+ entityId: string;
1966
+ }>;
1967
+ updated?: Array<{
1968
+ kind: string;
1969
+ entityType: string;
1970
+ entityId: string;
1971
+ }>;
1972
+ removed?: Array<{
1973
+ kind: string;
1974
+ entityType: string;
1975
+ entityId: string;
1976
+ }>;
1977
+ failure?: {
1978
+ code: string;
1979
+ message: string;
1980
+ details?: unknown;
1981
+ };
1982
+ };
404
1983
  context?: {
405
1984
  dirty: boolean;
406
1985
  revision: number;
@@ -420,7 +1999,29 @@ export type DocCommentsEditResult = {
420
1999
  };
421
2000
  id: string;
422
2001
  text: string;
423
- receipt: unknown;
2002
+ receipt: {
2003
+ success: boolean;
2004
+ inserted?: Array<{
2005
+ kind: string;
2006
+ entityType: string;
2007
+ entityId: string;
2008
+ }>;
2009
+ updated?: Array<{
2010
+ kind: string;
2011
+ entityType: string;
2012
+ entityId: string;
2013
+ }>;
2014
+ removed?: Array<{
2015
+ kind: string;
2016
+ entityType: string;
2017
+ entityId: string;
2018
+ }>;
2019
+ failure?: {
2020
+ code: string;
2021
+ message: string;
2022
+ details?: unknown;
2023
+ };
2024
+ };
424
2025
  context?: {
425
2026
  dirty: boolean;
426
2027
  revision: number;
@@ -440,7 +2041,29 @@ export type DocCommentsReplyResult = {
440
2041
  };
441
2042
  parentId: string;
442
2043
  text: string;
443
- receipt: unknown;
2044
+ receipt: {
2045
+ success: boolean;
2046
+ inserted?: Array<{
2047
+ kind: string;
2048
+ entityType: string;
2049
+ entityId: string;
2050
+ }>;
2051
+ updated?: Array<{
2052
+ kind: string;
2053
+ entityType: string;
2054
+ entityId: string;
2055
+ }>;
2056
+ removed?: Array<{
2057
+ kind: string;
2058
+ entityType: string;
2059
+ entityId: string;
2060
+ }>;
2061
+ failure?: {
2062
+ code: string;
2063
+ message: string;
2064
+ details?: unknown;
2065
+ };
2066
+ };
444
2067
  context?: {
445
2068
  dirty: boolean;
446
2069
  revision: number;
@@ -459,8 +2082,37 @@ export type DocCommentsMoveResult = {
459
2082
  revision: number;
460
2083
  };
461
2084
  id: string;
462
- target: unknown;
463
- receipt: unknown;
2085
+ target: {
2086
+ kind: "text";
2087
+ blockId: string;
2088
+ range: {
2089
+ start: number;
2090
+ end: number;
2091
+ };
2092
+ };
2093
+ receipt: {
2094
+ success: boolean;
2095
+ inserted?: Array<{
2096
+ kind: string;
2097
+ entityType: string;
2098
+ entityId: string;
2099
+ }>;
2100
+ updated?: Array<{
2101
+ kind: string;
2102
+ entityType: string;
2103
+ entityId: string;
2104
+ }>;
2105
+ removed?: Array<{
2106
+ kind: string;
2107
+ entityType: string;
2108
+ entityId: string;
2109
+ }>;
2110
+ failure?: {
2111
+ code: string;
2112
+ message: string;
2113
+ details?: unknown;
2114
+ };
2115
+ };
464
2116
  context?: {
465
2117
  dirty: boolean;
466
2118
  revision: number;
@@ -479,7 +2131,29 @@ export type DocCommentsResolveResult = {
479
2131
  revision: number;
480
2132
  };
481
2133
  id: string;
482
- receipt: unknown;
2134
+ receipt: {
2135
+ success: boolean;
2136
+ inserted?: Array<{
2137
+ kind: string;
2138
+ entityType: string;
2139
+ entityId: string;
2140
+ }>;
2141
+ updated?: Array<{
2142
+ kind: string;
2143
+ entityType: string;
2144
+ entityId: string;
2145
+ }>;
2146
+ removed?: Array<{
2147
+ kind: string;
2148
+ entityType: string;
2149
+ entityId: string;
2150
+ }>;
2151
+ failure?: {
2152
+ code: string;
2153
+ message: string;
2154
+ details?: unknown;
2155
+ };
2156
+ };
483
2157
  context?: {
484
2158
  dirty: boolean;
485
2159
  revision: number;
@@ -498,7 +2172,29 @@ export type DocCommentsRemoveResult = {
498
2172
  revision: number;
499
2173
  };
500
2174
  id: string;
501
- receipt: unknown;
2175
+ receipt: {
2176
+ success: boolean;
2177
+ inserted?: Array<{
2178
+ kind: string;
2179
+ entityType: string;
2180
+ entityId: string;
2181
+ }>;
2182
+ updated?: Array<{
2183
+ kind: string;
2184
+ entityType: string;
2185
+ entityId: string;
2186
+ }>;
2187
+ removed?: Array<{
2188
+ kind: string;
2189
+ entityType: string;
2190
+ entityId: string;
2191
+ }>;
2192
+ failure?: {
2193
+ code: string;
2194
+ message: string;
2195
+ details?: unknown;
2196
+ };
2197
+ };
502
2198
  context?: {
503
2199
  dirty: boolean;
504
2200
  revision: number;
@@ -518,7 +2214,29 @@ export type DocCommentsSetInternalResult = {
518
2214
  };
519
2215
  id: string;
520
2216
  isInternal: boolean;
521
- receipt: unknown;
2217
+ receipt: {
2218
+ success: boolean;
2219
+ inserted?: Array<{
2220
+ kind: string;
2221
+ entityType: string;
2222
+ entityId: string;
2223
+ }>;
2224
+ updated?: Array<{
2225
+ kind: string;
2226
+ entityType: string;
2227
+ entityId: string;
2228
+ }>;
2229
+ removed?: Array<{
2230
+ kind: string;
2231
+ entityType: string;
2232
+ entityId: string;
2233
+ }>;
2234
+ failure?: {
2235
+ code: string;
2236
+ message: string;
2237
+ details?: unknown;
2238
+ };
2239
+ };
522
2240
  context?: {
523
2241
  dirty: boolean;
524
2242
  revision: number;
@@ -536,8 +2254,30 @@ export type DocCommentsSetActiveResult = {
536
2254
  byteLength: number;
537
2255
  revision: number;
538
2256
  };
539
- id: string;
540
- receipt: unknown;
2257
+ id?: string;
2258
+ receipt: {
2259
+ success: boolean;
2260
+ inserted?: Array<{
2261
+ kind: string;
2262
+ entityType: string;
2263
+ entityId: string;
2264
+ }>;
2265
+ updated?: Array<{
2266
+ kind: string;
2267
+ entityType: string;
2268
+ entityId: string;
2269
+ }>;
2270
+ removed?: Array<{
2271
+ kind: string;
2272
+ entityType: string;
2273
+ entityId: string;
2274
+ }>;
2275
+ failure?: {
2276
+ code: string;
2277
+ message: string;
2278
+ details?: unknown;
2279
+ };
2280
+ };
541
2281
  };
542
2282
 
543
2283
  export type DocCommentsGoToResult = {
@@ -548,7 +2288,29 @@ export type DocCommentsGoToResult = {
548
2288
  revision: number;
549
2289
  };
550
2290
  id: string;
551
- receipt: unknown;
2291
+ receipt: {
2292
+ success: boolean;
2293
+ inserted?: Array<{
2294
+ kind: string;
2295
+ entityType: string;
2296
+ entityId: string;
2297
+ }>;
2298
+ updated?: Array<{
2299
+ kind: string;
2300
+ entityType: string;
2301
+ entityId: string;
2302
+ }>;
2303
+ removed?: Array<{
2304
+ kind: string;
2305
+ entityType: string;
2306
+ entityId: string;
2307
+ }>;
2308
+ failure?: {
2309
+ code: string;
2310
+ message: string;
2311
+ details?: unknown;
2312
+ };
2313
+ };
552
2314
  };
553
2315
 
554
2316
  export type DocCommentsGetResult = {
@@ -559,7 +2321,30 @@ export type DocCommentsGetResult = {
559
2321
  revision: number;
560
2322
  };
561
2323
  id: string;
562
- comment: unknown;
2324
+ comment: {
2325
+ address: {
2326
+ kind: string;
2327
+ entityType: string;
2328
+ entityId: string;
2329
+ };
2330
+ commentId: string;
2331
+ importedId?: string;
2332
+ parentCommentId?: string;
2333
+ text?: string;
2334
+ isInternal?: boolean;
2335
+ status: string;
2336
+ target?: {
2337
+ kind: "text";
2338
+ blockId: string;
2339
+ range: {
2340
+ start: number;
2341
+ end: number;
2342
+ };
2343
+ };
2344
+ createdTime?: number;
2345
+ creatorName?: string;
2346
+ creatorEmail?: string;
2347
+ };
563
2348
  };
564
2349
 
565
2350
  export type DocCommentsListResult = {
@@ -569,102 +2354,457 @@ export type DocCommentsListResult = {
569
2354
  byteLength: number;
570
2355
  revision: number;
571
2356
  };
572
- query: unknown;
573
- result: unknown;
2357
+ query: {
2358
+ includeResolved?: boolean;
2359
+ };
2360
+ result: {
2361
+ matches: Array<{
2362
+ address: {
2363
+ kind: string;
2364
+ entityType: string;
2365
+ entityId: string;
2366
+ };
2367
+ commentId: string;
2368
+ importedId?: string;
2369
+ parentCommentId?: string;
2370
+ text?: string;
2371
+ isInternal?: boolean;
2372
+ status: string;
2373
+ target?: {
2374
+ kind: "text";
2375
+ blockId: string;
2376
+ range: {
2377
+ start: number;
2378
+ end: number;
2379
+ };
2380
+ };
2381
+ createdTime?: number;
2382
+ creatorName?: string;
2383
+ creatorEmail?: string;
2384
+ }>;
2385
+ total: number;
2386
+ };
574
2387
  };
575
2388
 
576
- export type DocInsertResult = {
2389
+ export type DocCreateParagraphResult = ({
577
2390
  document: {
578
2391
  path?: string;
579
2392
  source: string;
580
2393
  byteLength: number;
581
2394
  revision: number;
582
2395
  };
583
- target: unknown;
584
- text?: string;
585
- changeMode?: string;
586
- dryRun?: boolean;
587
- proposed?: unknown;
588
- receipt?: unknown;
2396
+ input: {
2397
+ at?: {
2398
+ kind: string;
2399
+ target?: {
2400
+ kind: string;
2401
+ nodeType: string;
2402
+ nodeId: string;
2403
+ };
2404
+ };
2405
+ text?: string;
2406
+ };
2407
+ changeMode: "direct" | "tracked";
2408
+ dryRun: true;
2409
+ proposed: {
2410
+ kind: string;
2411
+ position: number;
2412
+ targetNodeId?: string;
2413
+ };
589
2414
  context?: {
590
2415
  dirty: boolean;
591
2416
  revision: number;
592
2417
  };
593
2418
  output?: {
594
2419
  path: string;
2420
+ skippedWrite: true;
2421
+ };
2422
+ }) | ({
2423
+ document: {
2424
+ path?: string;
2425
+ source: string;
595
2426
  byteLength: number;
2427
+ revision: number;
596
2428
  };
597
- };
2429
+ input: {
2430
+ at?: {
2431
+ kind: string;
2432
+ target?: {
2433
+ kind: string;
2434
+ nodeType: string;
2435
+ nodeId: string;
2436
+ };
2437
+ };
2438
+ text?: string;
2439
+ };
2440
+ changeMode: "direct" | "tracked";
2441
+ dryRun: false;
2442
+ result: {
2443
+ success: boolean;
2444
+ paragraph?: {
2445
+ kind: string;
2446
+ nodeType: string;
2447
+ nodeId: string;
2448
+ };
2449
+ insertionPoint?: {
2450
+ kind: "text";
2451
+ blockId: string;
2452
+ range: {
2453
+ start: number;
2454
+ end: number;
2455
+ };
2456
+ };
2457
+ trackedChangeRefs?: Array<{
2458
+ kind: string;
2459
+ entityType: string;
2460
+ entityId: string;
2461
+ }>;
2462
+ failure?: {
2463
+ code: string;
2464
+ message: string;
2465
+ details?: unknown;
2466
+ };
2467
+ };
2468
+ context?: {
2469
+ dirty: boolean;
2470
+ revision: number;
2471
+ };
2472
+ output?: {
2473
+ path: string;
2474
+ byteLength: number;
2475
+ };
2476
+ });
598
2477
 
599
- export type DocReplaceResult = {
2478
+ export type DocInsertResult = ({
600
2479
  document: {
601
2480
  path?: string;
602
2481
  source: string;
603
2482
  byteLength: number;
604
2483
  revision: number;
605
2484
  };
606
- target: unknown;
607
- changeMode?: string;
608
- dryRun?: boolean;
609
- proposed?: unknown;
610
- receipt?: unknown;
611
- from?: string;
612
- to?: string;
2485
+ target: {
2486
+ kind: "text";
2487
+ blockId: string;
2488
+ range: {
2489
+ start: number;
2490
+ end: number;
2491
+ };
2492
+ };
2493
+ text: string;
2494
+ changeMode: "direct" | "tracked";
2495
+ dryRun: true;
2496
+ proposed: {
2497
+ at: number;
2498
+ text: string;
2499
+ };
613
2500
  context?: {
614
2501
  dirty: boolean;
615
2502
  revision: number;
616
2503
  };
617
2504
  output?: {
618
2505
  path: string;
2506
+ skippedWrite: true;
2507
+ };
2508
+ }) | ({
2509
+ document: {
2510
+ path?: string;
2511
+ source: string;
619
2512
  byteLength: number;
2513
+ revision: number;
620
2514
  };
621
- };
2515
+ target: {
2516
+ kind: "text";
2517
+ blockId: string;
2518
+ range: {
2519
+ start: number;
2520
+ end: number;
2521
+ };
2522
+ };
2523
+ text: string;
2524
+ changeMode: "direct" | "tracked";
2525
+ dryRun: false;
2526
+ receipt: {
2527
+ success: boolean;
2528
+ inserted?: Array<{
2529
+ kind: string;
2530
+ entityType: string;
2531
+ entityId: string;
2532
+ }>;
2533
+ updated?: Array<{
2534
+ kind: string;
2535
+ entityType: string;
2536
+ entityId: string;
2537
+ }>;
2538
+ removed?: Array<{
2539
+ kind: string;
2540
+ entityType: string;
2541
+ entityId: string;
2542
+ }>;
2543
+ failure?: {
2544
+ code: string;
2545
+ message: string;
2546
+ details?: unknown;
2547
+ };
2548
+ };
2549
+ context?: {
2550
+ dirty: boolean;
2551
+ revision: number;
2552
+ };
2553
+ output?: {
2554
+ path: string;
2555
+ byteLength: number;
2556
+ };
2557
+ });
622
2558
 
623
- export type DocDeleteResult = {
2559
+ export type DocReplaceResult = ({
624
2560
  document: {
625
2561
  path?: string;
626
2562
  source: string;
627
2563
  byteLength: number;
628
2564
  revision: number;
629
2565
  };
630
- target: unknown;
631
- changeMode?: string;
632
- dryRun?: boolean;
633
- proposed?: unknown;
634
- receipt?: unknown;
635
- removedText?: string;
2566
+ target: {
2567
+ kind: "text";
2568
+ blockId: string;
2569
+ range: {
2570
+ start: number;
2571
+ end: number;
2572
+ };
2573
+ };
2574
+ changeMode: "direct" | "tracked";
2575
+ dryRun: true;
2576
+ proposed: {
2577
+ target: {
2578
+ kind: "text";
2579
+ blockId: string;
2580
+ range: {
2581
+ start: number;
2582
+ end: number;
2583
+ };
2584
+ };
2585
+ text: string;
2586
+ };
636
2587
  context?: {
637
2588
  dirty: boolean;
638
2589
  revision: number;
639
2590
  };
640
2591
  output?: {
641
2592
  path: string;
2593
+ skippedWrite: true;
2594
+ };
2595
+ }) | ({
2596
+ document: {
2597
+ path?: string;
2598
+ source: string;
642
2599
  byteLength: number;
2600
+ revision: number;
643
2601
  };
644
- };
2602
+ target: {
2603
+ kind: "text";
2604
+ blockId: string;
2605
+ range: {
2606
+ start: number;
2607
+ end: number;
2608
+ };
2609
+ };
2610
+ changeMode: "direct" | "tracked";
2611
+ dryRun: false;
2612
+ receipt: {
2613
+ success: boolean;
2614
+ inserted?: Array<{
2615
+ kind: string;
2616
+ entityType: string;
2617
+ entityId: string;
2618
+ }>;
2619
+ updated?: Array<{
2620
+ kind: string;
2621
+ entityType: string;
2622
+ entityId: string;
2623
+ }>;
2624
+ removed?: Array<{
2625
+ kind: string;
2626
+ entityType: string;
2627
+ entityId: string;
2628
+ }>;
2629
+ failure?: {
2630
+ code: string;
2631
+ message: string;
2632
+ details?: unknown;
2633
+ };
2634
+ };
2635
+ to: string;
2636
+ context?: {
2637
+ dirty: boolean;
2638
+ revision: number;
2639
+ };
2640
+ output?: {
2641
+ path: string;
2642
+ byteLength: number;
2643
+ };
2644
+ });
645
2645
 
646
- export type DocFormatBoldResult = {
2646
+ export type DocDeleteResult = ({
647
2647
  document: {
648
2648
  path?: string;
649
2649
  source: string;
650
2650
  byteLength: number;
651
2651
  revision: number;
652
2652
  };
653
- target: unknown;
654
- changeMode?: string;
655
- dryRun?: boolean;
656
- proposed?: unknown;
657
- receipt?: unknown;
658
- selectedText?: string;
2653
+ target: {
2654
+ kind: "text";
2655
+ blockId: string;
2656
+ range: {
2657
+ start: number;
2658
+ end: number;
2659
+ };
2660
+ };
2661
+ changeMode: "direct" | "tracked";
2662
+ dryRun: true;
2663
+ proposed: {
2664
+ from: number;
2665
+ to: number;
2666
+ removedText: string;
2667
+ };
659
2668
  context?: {
660
2669
  dirty: boolean;
661
2670
  revision: number;
662
2671
  };
663
2672
  output?: {
664
2673
  path: string;
2674
+ skippedWrite: true;
2675
+ };
2676
+ }) | ({
2677
+ document: {
2678
+ path?: string;
2679
+ source: string;
665
2680
  byteLength: number;
2681
+ revision: number;
666
2682
  };
667
- };
2683
+ target: {
2684
+ kind: "text";
2685
+ blockId: string;
2686
+ range: {
2687
+ start: number;
2688
+ end: number;
2689
+ };
2690
+ };
2691
+ changeMode: "direct" | "tracked";
2692
+ dryRun: false;
2693
+ receipt: {
2694
+ success: boolean;
2695
+ inserted?: Array<{
2696
+ kind: string;
2697
+ entityType: string;
2698
+ entityId: string;
2699
+ }>;
2700
+ updated?: Array<{
2701
+ kind: string;
2702
+ entityType: string;
2703
+ entityId: string;
2704
+ }>;
2705
+ removed?: Array<{
2706
+ kind: string;
2707
+ entityType: string;
2708
+ entityId: string;
2709
+ }>;
2710
+ failure?: {
2711
+ code: string;
2712
+ message: string;
2713
+ details?: unknown;
2714
+ };
2715
+ };
2716
+ removedText: string;
2717
+ context?: {
2718
+ dirty: boolean;
2719
+ revision: number;
2720
+ };
2721
+ output?: {
2722
+ path: string;
2723
+ byteLength: number;
2724
+ };
2725
+ });
2726
+
2727
+ export type DocFormatBoldResult = ({
2728
+ document: {
2729
+ path?: string;
2730
+ source: string;
2731
+ byteLength: number;
2732
+ revision: number;
2733
+ };
2734
+ target: {
2735
+ kind: "text";
2736
+ blockId: string;
2737
+ range: {
2738
+ start: number;
2739
+ end: number;
2740
+ };
2741
+ };
2742
+ changeMode: "direct" | "tracked";
2743
+ dryRun: true;
2744
+ proposed: {
2745
+ from: number;
2746
+ to: number;
2747
+ selectedText: string;
2748
+ mark: string;
2749
+ };
2750
+ context?: {
2751
+ dirty: boolean;
2752
+ revision: number;
2753
+ };
2754
+ output?: {
2755
+ path: string;
2756
+ skippedWrite: true;
2757
+ };
2758
+ }) | ({
2759
+ document: {
2760
+ path?: string;
2761
+ source: string;
2762
+ byteLength: number;
2763
+ revision: number;
2764
+ };
2765
+ target: {
2766
+ kind: "text";
2767
+ blockId: string;
2768
+ range: {
2769
+ start: number;
2770
+ end: number;
2771
+ };
2772
+ };
2773
+ changeMode: "direct" | "tracked";
2774
+ dryRun: false;
2775
+ receipt: {
2776
+ success: boolean;
2777
+ inserted?: Array<{
2778
+ kind: string;
2779
+ entityType: string;
2780
+ entityId: string;
2781
+ }>;
2782
+ updated?: Array<{
2783
+ kind: string;
2784
+ entityType: string;
2785
+ entityId: string;
2786
+ }>;
2787
+ removed?: Array<{
2788
+ kind: string;
2789
+ entityType: string;
2790
+ entityId: string;
2791
+ }>;
2792
+ failure?: {
2793
+ code: string;
2794
+ message: string;
2795
+ details?: unknown;
2796
+ };
2797
+ };
2798
+ selectedText: string;
2799
+ context?: {
2800
+ dirty: boolean;
2801
+ revision: number;
2802
+ };
2803
+ output?: {
2804
+ path: string;
2805
+ byteLength: number;
2806
+ };
2807
+ });
668
2808
 
669
2809
  export type DocTrackChangesListResult = {
670
2810
  document: {
@@ -673,8 +2813,33 @@ export type DocTrackChangesListResult = {
673
2813
  byteLength: number;
674
2814
  revision: number;
675
2815
  };
676
- query: unknown;
677
- result: unknown;
2816
+ query: {
2817
+ limit?: number;
2818
+ offset?: number;
2819
+ type?: "insert" | "delete" | "format";
2820
+ };
2821
+ result: {
2822
+ matches: Array<{
2823
+ kind: string;
2824
+ entityType: string;
2825
+ entityId: string;
2826
+ }>;
2827
+ total: number;
2828
+ changes?: Array<{
2829
+ address: {
2830
+ kind: string;
2831
+ entityType: string;
2832
+ entityId: string;
2833
+ };
2834
+ id: string;
2835
+ type: "insert" | "delete" | "format";
2836
+ author?: string;
2837
+ authorEmail?: string;
2838
+ authorImage?: string;
2839
+ date?: string;
2840
+ excerpt?: string;
2841
+ }>;
2842
+ };
678
2843
  };
679
2844
 
680
2845
  export type DocTrackChangesGetResult = {
@@ -685,7 +2850,20 @@ export type DocTrackChangesGetResult = {
685
2850
  revision: number;
686
2851
  };
687
2852
  id: string;
688
- change: unknown;
2853
+ change: {
2854
+ address: {
2855
+ kind: string;
2856
+ entityType: string;
2857
+ entityId: string;
2858
+ };
2859
+ id: string;
2860
+ type: "insert" | "delete" | "format";
2861
+ author?: string;
2862
+ authorEmail?: string;
2863
+ authorImage?: string;
2864
+ date?: string;
2865
+ excerpt?: string;
2866
+ };
689
2867
  };
690
2868
 
691
2869
  export type DocTrackChangesAcceptResult = {
@@ -696,7 +2874,29 @@ export type DocTrackChangesAcceptResult = {
696
2874
  revision: number;
697
2875
  };
698
2876
  id: string;
699
- receipt: unknown;
2877
+ receipt: {
2878
+ success: boolean;
2879
+ inserted?: Array<{
2880
+ kind: string;
2881
+ entityType: string;
2882
+ entityId: string;
2883
+ }>;
2884
+ updated?: Array<{
2885
+ kind: string;
2886
+ entityType: string;
2887
+ entityId: string;
2888
+ }>;
2889
+ removed?: Array<{
2890
+ kind: string;
2891
+ entityType: string;
2892
+ entityId: string;
2893
+ }>;
2894
+ failure?: {
2895
+ code: string;
2896
+ message: string;
2897
+ details?: unknown;
2898
+ };
2899
+ };
700
2900
  context?: {
701
2901
  dirty: boolean;
702
2902
  revision: number;
@@ -715,7 +2915,29 @@ export type DocTrackChangesRejectResult = {
715
2915
  revision: number;
716
2916
  };
717
2917
  id: string;
718
- receipt: unknown;
2918
+ receipt: {
2919
+ success: boolean;
2920
+ inserted?: Array<{
2921
+ kind: string;
2922
+ entityType: string;
2923
+ entityId: string;
2924
+ }>;
2925
+ updated?: Array<{
2926
+ kind: string;
2927
+ entityType: string;
2928
+ entityId: string;
2929
+ }>;
2930
+ removed?: Array<{
2931
+ kind: string;
2932
+ entityType: string;
2933
+ entityId: string;
2934
+ }>;
2935
+ failure?: {
2936
+ code: string;
2937
+ message: string;
2938
+ details?: unknown;
2939
+ };
2940
+ };
719
2941
  context?: {
720
2942
  dirty: boolean;
721
2943
  revision: number;
@@ -733,7 +2955,29 @@ export type DocTrackChangesAcceptAllResult = {
733
2955
  byteLength: number;
734
2956
  revision: number;
735
2957
  };
736
- receipt: unknown;
2958
+ receipt: {
2959
+ success: boolean;
2960
+ inserted?: Array<{
2961
+ kind: string;
2962
+ entityType: string;
2963
+ entityId: string;
2964
+ }>;
2965
+ updated?: Array<{
2966
+ kind: string;
2967
+ entityType: string;
2968
+ entityId: string;
2969
+ }>;
2970
+ removed?: Array<{
2971
+ kind: string;
2972
+ entityType: string;
2973
+ entityId: string;
2974
+ }>;
2975
+ failure?: {
2976
+ code: string;
2977
+ message: string;
2978
+ details?: unknown;
2979
+ };
2980
+ };
737
2981
  context?: {
738
2982
  dirty: boolean;
739
2983
  revision: number;
@@ -751,7 +2995,29 @@ export type DocTrackChangesRejectAllResult = {
751
2995
  byteLength: number;
752
2996
  revision: number;
753
2997
  };
754
- receipt: unknown;
2998
+ receipt: {
2999
+ success: boolean;
3000
+ inserted?: Array<{
3001
+ kind: string;
3002
+ entityType: string;
3003
+ entityId: string;
3004
+ }>;
3005
+ updated?: Array<{
3006
+ kind: string;
3007
+ entityType: string;
3008
+ entityId: string;
3009
+ }>;
3010
+ removed?: Array<{
3011
+ kind: string;
3012
+ entityType: string;
3013
+ entityId: string;
3014
+ }>;
3015
+ failure?: {
3016
+ code: string;
3017
+ message: string;
3018
+ details?: unknown;
3019
+ };
3020
+ };
755
3021
  context?: {
756
3022
  dirty: boolean;
757
3023
  revision: number;
@@ -785,6 +3051,27 @@ export type DocSessionListResult = {
785
3051
  total: number;
786
3052
  };
787
3053
 
3054
+ export type DocSessionSaveResult = {
3055
+ sessionId: string;
3056
+ contextId: string;
3057
+ saved: boolean;
3058
+ inPlace: boolean;
3059
+ document: {
3060
+ path?: string;
3061
+ source: string;
3062
+ revision: number;
3063
+ };
3064
+ context: {
3065
+ dirty: boolean;
3066
+ revision: number;
3067
+ lastSavedAt?: string;
3068
+ };
3069
+ output: {
3070
+ path: string;
3071
+ byteLength: number;
3072
+ };
3073
+ };
3074
+
788
3075
  export type DocSessionCloseResult = {
789
3076
  sessionId: string;
790
3077
  contextId: string;
@@ -814,8 +3101,11 @@ export function createDocApi(runtime: SuperDocRuntime) {
814
3101
  return {
815
3102
  open: (params: DocOpenParams, options?: InvokeOptions) => runtime.invoke<DocOpenResult>(OPERATION_MAP["doc.open"], params as unknown as Record<string, unknown>, options),
816
3103
  status: (params: DocStatusParams = {}, options?: InvokeOptions) => runtime.invoke<DocStatusResult>(OPERATION_MAP["doc.status"], params as unknown as Record<string, unknown>, options),
3104
+ save: (params: DocSaveParams = {}, options?: InvokeOptions) => runtime.invoke<DocSaveResult>(OPERATION_MAP["doc.save"], params as unknown as Record<string, unknown>, options),
817
3105
  close: (params: DocCloseParams = {}, options?: InvokeOptions) => runtime.invoke<DocCloseResult>(OPERATION_MAP["doc.close"], params as unknown as Record<string, unknown>, options),
818
3106
  info: (params: DocInfoParams = {}, options?: InvokeOptions) => runtime.invoke<DocInfoResult>(OPERATION_MAP["doc.info"], params as unknown as Record<string, unknown>, options),
3107
+ describe: (params: DocDescribeParams = {}, options?: InvokeOptions) => runtime.invoke<DocDescribeResult>(OPERATION_MAP["doc.describe"], params as unknown as Record<string, unknown>, options),
3108
+ describeCommand: (params: DocDescribeCommandParams, options?: InvokeOptions) => runtime.invoke<DocDescribeCommandResult>(OPERATION_MAP["doc.describeCommand"], params as unknown as Record<string, unknown>, options),
819
3109
  find: (params: DocFindParams = {}, options?: InvokeOptions) => runtime.invoke<DocFindResult>(OPERATION_MAP["doc.find"], params as unknown as Record<string, unknown>, options),
820
3110
  getNode: (params: DocGetNodeParams, options?: InvokeOptions) => runtime.invoke<DocGetNodeResult>(OPERATION_MAP["doc.getNode"], params as unknown as Record<string, unknown>, options),
821
3111
  getNodeById: (params: DocGetNodeByIdParams, options?: InvokeOptions) => runtime.invoke<DocGetNodeByIdResult>(OPERATION_MAP["doc.getNodeById"], params as unknown as Record<string, unknown>, options),
@@ -832,6 +3122,9 @@ export function createDocApi(runtime: SuperDocRuntime) {
832
3122
  get: (params: DocCommentsGetParams, options?: InvokeOptions) => runtime.invoke<DocCommentsGetResult>(OPERATION_MAP["doc.comments.get"], params as unknown as Record<string, unknown>, options),
833
3123
  list: (params: DocCommentsListParams = {}, options?: InvokeOptions) => runtime.invoke<DocCommentsListResult>(OPERATION_MAP["doc.comments.list"], params as unknown as Record<string, unknown>, options),
834
3124
  },
3125
+ create: {
3126
+ paragraph: (params: DocCreateParagraphParams = {}, options?: InvokeOptions) => runtime.invoke<DocCreateParagraphResult>(OPERATION_MAP["doc.create.paragraph"], params as unknown as Record<string, unknown>, options),
3127
+ },
835
3128
  insert: (params: DocInsertParams, options?: InvokeOptions) => runtime.invoke<DocInsertResult>(OPERATION_MAP["doc.insert"], params as unknown as Record<string, unknown>, options),
836
3129
  replace: (params: DocReplaceParams, options?: InvokeOptions) => runtime.invoke<DocReplaceResult>(OPERATION_MAP["doc.replace"], params as unknown as Record<string, unknown>, options),
837
3130
  delete: (params: DocDeleteParams, options?: InvokeOptions) => runtime.invoke<DocDeleteResult>(OPERATION_MAP["doc.delete"], params as unknown as Record<string, unknown>, options),
@@ -848,6 +3141,7 @@ export function createDocApi(runtime: SuperDocRuntime) {
848
3141
  },
849
3142
  session: {
850
3143
  list: (params: DocSessionListParams = {}, options?: InvokeOptions) => runtime.invoke<DocSessionListResult>(OPERATION_MAP["doc.session.list"], params as unknown as Record<string, unknown>, options),
3144
+ save: (params: DocSessionSaveParams, options?: InvokeOptions) => runtime.invoke<DocSessionSaveResult>(OPERATION_MAP["doc.session.save"], params as unknown as Record<string, unknown>, options),
851
3145
  close: (params: DocSessionCloseParams, options?: InvokeOptions) => runtime.invoke<DocSessionCloseResult>(OPERATION_MAP["doc.session.close"], params as unknown as Record<string, unknown>, options),
852
3146
  setDefault: (params: DocSessionSetDefaultParams, options?: InvokeOptions) => runtime.invoke<DocSessionSetDefaultResult>(OPERATION_MAP["doc.session.setDefault"], params as unknown as Record<string, unknown>, options),
853
3147
  },