@superdoc-dev/sdk 1.0.0-alpha.2 → 1.0.0-alpha.3

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.
@@ -267,6 +267,175 @@ export interface DocCreateParagraphParams {
267
267
  expectedRevision?: number;
268
268
  }
269
269
 
270
+ export interface DocListsListParams {
271
+ doc?: string;
272
+ sessionId?: string;
273
+ query?: {
274
+ within?: {
275
+ kind: "block";
276
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
277
+ nodeId: string;
278
+ };
279
+ limit?: number;
280
+ offset?: number;
281
+ kind?: "ordered" | "bullet";
282
+ level?: number;
283
+ ordinal?: number;
284
+ };
285
+ within?: {
286
+ kind: "block";
287
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
288
+ nodeId: string;
289
+ };
290
+ kind?: string;
291
+ level?: number;
292
+ ordinal?: number;
293
+ limit?: number;
294
+ offset?: number;
295
+ }
296
+
297
+ export interface DocListsGetParams {
298
+ doc?: string;
299
+ sessionId?: string;
300
+ address: {
301
+ kind: "block";
302
+ nodeType: "listItem";
303
+ nodeId: string;
304
+ };
305
+ }
306
+
307
+ export interface DocListsInsertParams {
308
+ doc?: string;
309
+ sessionId?: string;
310
+ input?: {
311
+ target: {
312
+ kind: "block";
313
+ nodeType: "listItem";
314
+ nodeId: string;
315
+ };
316
+ position: "before" | "after";
317
+ text?: string;
318
+ };
319
+ target?: {
320
+ kind: "block";
321
+ nodeType: "listItem";
322
+ nodeId: string;
323
+ };
324
+ position?: string;
325
+ text?: string;
326
+ changeMode?: string;
327
+ out?: string;
328
+ force?: boolean;
329
+ expectedRevision?: number;
330
+ }
331
+
332
+ export interface DocListsSetTypeParams {
333
+ doc?: string;
334
+ sessionId?: string;
335
+ input?: {
336
+ target: {
337
+ kind: "block";
338
+ nodeType: "listItem";
339
+ nodeId: string;
340
+ };
341
+ kind: "ordered" | "bullet";
342
+ };
343
+ target?: {
344
+ kind: "block";
345
+ nodeType: "listItem";
346
+ nodeId: string;
347
+ };
348
+ kind?: string;
349
+ changeMode?: string;
350
+ out?: string;
351
+ force?: boolean;
352
+ expectedRevision?: number;
353
+ }
354
+
355
+ export interface DocListsIndentParams {
356
+ doc?: string;
357
+ sessionId?: string;
358
+ input?: {
359
+ target: {
360
+ kind: "block";
361
+ nodeType: "listItem";
362
+ nodeId: string;
363
+ };
364
+ };
365
+ target?: {
366
+ kind: "block";
367
+ nodeType: "listItem";
368
+ nodeId: string;
369
+ };
370
+ changeMode?: string;
371
+ out?: string;
372
+ force?: boolean;
373
+ expectedRevision?: number;
374
+ }
375
+
376
+ export interface DocListsOutdentParams {
377
+ doc?: string;
378
+ sessionId?: string;
379
+ input?: {
380
+ target: {
381
+ kind: "block";
382
+ nodeType: "listItem";
383
+ nodeId: string;
384
+ };
385
+ };
386
+ target?: {
387
+ kind: "block";
388
+ nodeType: "listItem";
389
+ nodeId: string;
390
+ };
391
+ changeMode?: string;
392
+ out?: string;
393
+ force?: boolean;
394
+ expectedRevision?: number;
395
+ }
396
+
397
+ export interface DocListsRestartParams {
398
+ doc?: string;
399
+ sessionId?: string;
400
+ input?: {
401
+ target: {
402
+ kind: "block";
403
+ nodeType: "listItem";
404
+ nodeId: string;
405
+ };
406
+ };
407
+ target?: {
408
+ kind: "block";
409
+ nodeType: "listItem";
410
+ nodeId: string;
411
+ };
412
+ changeMode?: string;
413
+ out?: string;
414
+ force?: boolean;
415
+ expectedRevision?: number;
416
+ }
417
+
418
+ export interface DocListsExitParams {
419
+ doc?: string;
420
+ sessionId?: string;
421
+ input?: {
422
+ target: {
423
+ kind: "block";
424
+ nodeType: "listItem";
425
+ nodeId: string;
426
+ };
427
+ };
428
+ target?: {
429
+ kind: "block";
430
+ nodeType: "listItem";
431
+ nodeId: string;
432
+ };
433
+ changeMode?: string;
434
+ out?: string;
435
+ force?: boolean;
436
+ expectedRevision?: number;
437
+ }
438
+
270
439
  export interface DocInsertParams {
271
440
  doc?: string;
272
441
  sessionId?: string;
@@ -2475,6 +2644,319 @@ export type DocCreateParagraphResult = ({
2475
2644
  };
2476
2645
  });
2477
2646
 
2647
+ export type DocListsListResult = {
2648
+ document: {
2649
+ path?: string;
2650
+ source: string;
2651
+ byteLength: number;
2652
+ revision: number;
2653
+ };
2654
+ query: {
2655
+ within?: {
2656
+ kind: "block";
2657
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "blockquote" | "codeBlock" | "image" | "sdt" | "field";
2658
+ nodeId: string;
2659
+ };
2660
+ limit?: number;
2661
+ offset?: number;
2662
+ kind?: "ordered" | "bullet";
2663
+ level?: number;
2664
+ ordinal?: number;
2665
+ };
2666
+ result: {
2667
+ matches: Array<{
2668
+ kind: "block";
2669
+ nodeType: "listItem";
2670
+ nodeId: string;
2671
+ }>;
2672
+ total: number;
2673
+ items: Array<{
2674
+ address: {
2675
+ kind: "block";
2676
+ nodeType: "listItem";
2677
+ nodeId: string;
2678
+ };
2679
+ marker?: string;
2680
+ ordinal?: number;
2681
+ path?: Array<number>;
2682
+ level?: number;
2683
+ kind?: "ordered" | "bullet";
2684
+ text?: string;
2685
+ }>;
2686
+ };
2687
+ };
2688
+
2689
+ export type DocListsGetResult = {
2690
+ document: {
2691
+ path?: string;
2692
+ source: string;
2693
+ byteLength: number;
2694
+ revision: number;
2695
+ };
2696
+ address: {
2697
+ kind: "block";
2698
+ nodeType: "listItem";
2699
+ nodeId: string;
2700
+ };
2701
+ item: {
2702
+ address: {
2703
+ kind: "block";
2704
+ nodeType: "listItem";
2705
+ nodeId: string;
2706
+ };
2707
+ marker?: string;
2708
+ ordinal?: number;
2709
+ path?: Array<number>;
2710
+ level?: number;
2711
+ kind?: "ordered" | "bullet";
2712
+ text?: string;
2713
+ };
2714
+ };
2715
+
2716
+ export type DocListsInsertResult = {
2717
+ document: {
2718
+ path?: string;
2719
+ source: string;
2720
+ byteLength: number;
2721
+ revision: number;
2722
+ };
2723
+ input: {
2724
+ target: {
2725
+ kind: "block";
2726
+ nodeType: "listItem";
2727
+ nodeId: string;
2728
+ };
2729
+ position: "before" | "after";
2730
+ text?: string;
2731
+ };
2732
+ changeMode: "direct" | "tracked";
2733
+ result: {
2734
+ success: boolean;
2735
+ item?: {
2736
+ kind: "block";
2737
+ nodeType: "listItem";
2738
+ nodeId: string;
2739
+ };
2740
+ insertionPoint?: {
2741
+ kind: "text";
2742
+ blockId: string;
2743
+ range: {
2744
+ start: number;
2745
+ end: number;
2746
+ };
2747
+ };
2748
+ trackedChangeRefs?: Array<{
2749
+ kind: string;
2750
+ entityType: string;
2751
+ entityId: string;
2752
+ }>;
2753
+ failure?: {
2754
+ code: string;
2755
+ message: string;
2756
+ details?: unknown;
2757
+ };
2758
+ };
2759
+ context?: {
2760
+ dirty: boolean;
2761
+ revision: number;
2762
+ };
2763
+ output?: {
2764
+ path: string;
2765
+ byteLength: number;
2766
+ };
2767
+ };
2768
+
2769
+ export type DocListsSetTypeResult = {
2770
+ document: {
2771
+ path?: string;
2772
+ source: string;
2773
+ byteLength: number;
2774
+ revision: number;
2775
+ };
2776
+ input: {
2777
+ target: {
2778
+ kind: "block";
2779
+ nodeType: "listItem";
2780
+ nodeId: string;
2781
+ };
2782
+ kind: "ordered" | "bullet";
2783
+ };
2784
+ changeMode: "direct" | "tracked";
2785
+ result: {
2786
+ success: boolean;
2787
+ item?: {
2788
+ kind: "block";
2789
+ nodeType: "listItem";
2790
+ nodeId: string;
2791
+ };
2792
+ failure?: {
2793
+ code: string;
2794
+ message: string;
2795
+ details?: unknown;
2796
+ };
2797
+ };
2798
+ context?: {
2799
+ dirty: boolean;
2800
+ revision: number;
2801
+ };
2802
+ output?: {
2803
+ path: string;
2804
+ byteLength: number;
2805
+ };
2806
+ };
2807
+
2808
+ export type DocListsIndentResult = {
2809
+ document: {
2810
+ path?: string;
2811
+ source: string;
2812
+ byteLength: number;
2813
+ revision: number;
2814
+ };
2815
+ input: {
2816
+ target: {
2817
+ kind: "block";
2818
+ nodeType: "listItem";
2819
+ nodeId: string;
2820
+ };
2821
+ };
2822
+ changeMode: "direct" | "tracked";
2823
+ result: {
2824
+ success: boolean;
2825
+ item?: {
2826
+ kind: "block";
2827
+ nodeType: "listItem";
2828
+ nodeId: string;
2829
+ };
2830
+ failure?: {
2831
+ code: string;
2832
+ message: string;
2833
+ details?: unknown;
2834
+ };
2835
+ };
2836
+ context?: {
2837
+ dirty: boolean;
2838
+ revision: number;
2839
+ };
2840
+ output?: {
2841
+ path: string;
2842
+ byteLength: number;
2843
+ };
2844
+ };
2845
+
2846
+ export type DocListsOutdentResult = {
2847
+ document: {
2848
+ path?: string;
2849
+ source: string;
2850
+ byteLength: number;
2851
+ revision: number;
2852
+ };
2853
+ input: {
2854
+ target: {
2855
+ kind: "block";
2856
+ nodeType: "listItem";
2857
+ nodeId: string;
2858
+ };
2859
+ };
2860
+ changeMode: "direct" | "tracked";
2861
+ result: {
2862
+ success: boolean;
2863
+ item?: {
2864
+ kind: "block";
2865
+ nodeType: "listItem";
2866
+ nodeId: string;
2867
+ };
2868
+ failure?: {
2869
+ code: string;
2870
+ message: string;
2871
+ details?: unknown;
2872
+ };
2873
+ };
2874
+ context?: {
2875
+ dirty: boolean;
2876
+ revision: number;
2877
+ };
2878
+ output?: {
2879
+ path: string;
2880
+ byteLength: number;
2881
+ };
2882
+ };
2883
+
2884
+ export type DocListsRestartResult = {
2885
+ document: {
2886
+ path?: string;
2887
+ source: string;
2888
+ byteLength: number;
2889
+ revision: number;
2890
+ };
2891
+ input: {
2892
+ target: {
2893
+ kind: "block";
2894
+ nodeType: "listItem";
2895
+ nodeId: string;
2896
+ };
2897
+ };
2898
+ changeMode: "direct" | "tracked";
2899
+ result: {
2900
+ success: boolean;
2901
+ item?: {
2902
+ kind: "block";
2903
+ nodeType: "listItem";
2904
+ nodeId: string;
2905
+ };
2906
+ failure?: {
2907
+ code: string;
2908
+ message: string;
2909
+ details?: unknown;
2910
+ };
2911
+ };
2912
+ context?: {
2913
+ dirty: boolean;
2914
+ revision: number;
2915
+ };
2916
+ output?: {
2917
+ path: string;
2918
+ byteLength: number;
2919
+ };
2920
+ };
2921
+
2922
+ export type DocListsExitResult = {
2923
+ document: {
2924
+ path?: string;
2925
+ source: string;
2926
+ byteLength: number;
2927
+ revision: number;
2928
+ };
2929
+ input: {
2930
+ target: {
2931
+ kind: "block";
2932
+ nodeType: "listItem";
2933
+ nodeId: string;
2934
+ };
2935
+ };
2936
+ changeMode: "direct" | "tracked";
2937
+ result: {
2938
+ success: boolean;
2939
+ paragraph?: {
2940
+ kind: "block";
2941
+ nodeType: "paragraph";
2942
+ nodeId: string;
2943
+ };
2944
+ failure?: {
2945
+ code: string;
2946
+ message: string;
2947
+ details?: unknown;
2948
+ };
2949
+ };
2950
+ context?: {
2951
+ dirty: boolean;
2952
+ revision: number;
2953
+ };
2954
+ output?: {
2955
+ path: string;
2956
+ byteLength: number;
2957
+ };
2958
+ };
2959
+
2478
2960
  export type DocInsertResult = ({
2479
2961
  document: {
2480
2962
  path?: string;
@@ -3125,6 +3607,16 @@ export function createDocApi(runtime: SuperDocRuntime) {
3125
3607
  create: {
3126
3608
  paragraph: (params: DocCreateParagraphParams = {}, options?: InvokeOptions) => runtime.invoke<DocCreateParagraphResult>(OPERATION_MAP["doc.create.paragraph"], params as unknown as Record<string, unknown>, options),
3127
3609
  },
3610
+ lists: {
3611
+ list: (params: DocListsListParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsListResult>(OPERATION_MAP["doc.lists.list"], params as unknown as Record<string, unknown>, options),
3612
+ get: (params: DocListsGetParams, options?: InvokeOptions) => runtime.invoke<DocListsGetResult>(OPERATION_MAP["doc.lists.get"], params as unknown as Record<string, unknown>, options),
3613
+ insert: (params: DocListsInsertParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsInsertResult>(OPERATION_MAP["doc.lists.insert"], params as unknown as Record<string, unknown>, options),
3614
+ setType: (params: DocListsSetTypeParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsSetTypeResult>(OPERATION_MAP["doc.lists.setType"], params as unknown as Record<string, unknown>, options),
3615
+ indent: (params: DocListsIndentParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsIndentResult>(OPERATION_MAP["doc.lists.indent"], params as unknown as Record<string, unknown>, options),
3616
+ outdent: (params: DocListsOutdentParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsOutdentResult>(OPERATION_MAP["doc.lists.outdent"], params as unknown as Record<string, unknown>, options),
3617
+ restart: (params: DocListsRestartParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsRestartResult>(OPERATION_MAP["doc.lists.restart"], params as unknown as Record<string, unknown>, options),
3618
+ exit: (params: DocListsExitParams = {}, options?: InvokeOptions) => runtime.invoke<DocListsExitResult>(OPERATION_MAP["doc.lists.exit"], params as unknown as Record<string, unknown>, options),
3619
+ },
3128
3620
  insert: (params: DocInsertParams, options?: InvokeOptions) => runtime.invoke<DocInsertResult>(OPERATION_MAP["doc.insert"], params as unknown as Record<string, unknown>, options),
3129
3621
  replace: (params: DocReplaceParams, options?: InvokeOptions) => runtime.invoke<DocReplaceResult>(OPERATION_MAP["doc.replace"], params as unknown as Record<string, unknown>, options),
3130
3622
  delete: (params: DocDeleteParams, options?: InvokeOptions) => runtime.invoke<DocDeleteResult>(OPERATION_MAP["doc.delete"], params as unknown as Record<string, unknown>, options),