@superdoc-dev/sdk 1.0.0-alpha.30 → 1.0.0-alpha.32

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.
@@ -2679,9 +2679,378 @@ export interface DocMutationsPreviewParams {
2679
2679
  doc?: string;
2680
2680
  sessionId?: string;
2681
2681
  expectedRevision?: string;
2682
- atomic: true;
2682
+ atomic: boolean;
2683
2683
  changeMode: string;
2684
- steps: unknown;
2684
+ steps: Array<({
2685
+ id: string;
2686
+ op: "text.rewrite";
2687
+ where: ({
2688
+ by: "select";
2689
+ select: ({
2690
+ type: "text";
2691
+ pattern: string;
2692
+ mode?: "contains" | "regex";
2693
+ caseSensitive?: boolean;
2694
+ }) | ({
2695
+ type: "node";
2696
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
2697
+ kind?: "block" | "inline";
2698
+ });
2699
+ within?: ({
2700
+ kind: "block";
2701
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2702
+ nodeId: string;
2703
+ }) | ({
2704
+ kind: "inline";
2705
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2706
+ anchor: {
2707
+ start: {
2708
+ blockId: string;
2709
+ offset: number;
2710
+ };
2711
+ end: {
2712
+ blockId: string;
2713
+ offset: number;
2714
+ };
2715
+ };
2716
+ });
2717
+ require: "first" | "exactlyOne" | "all";
2718
+ }) | ({
2719
+ by: "ref";
2720
+ ref: string;
2721
+ within?: ({
2722
+ kind: "block";
2723
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2724
+ nodeId: string;
2725
+ }) | ({
2726
+ kind: "inline";
2727
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2728
+ anchor: {
2729
+ start: {
2730
+ blockId: string;
2731
+ offset: number;
2732
+ };
2733
+ end: {
2734
+ blockId: string;
2735
+ offset: number;
2736
+ };
2737
+ };
2738
+ });
2739
+ });
2740
+ args: {
2741
+ replacement: ({
2742
+ text: string;
2743
+ }) | ({
2744
+ blocks: Array<{
2745
+ text: string;
2746
+ }>;
2747
+ });
2748
+ style?: {
2749
+ inline: {
2750
+ mode: "preserve" | "set" | "clear" | "merge";
2751
+ requireUniform?: boolean;
2752
+ onNonUniform?: "error" | "useLeadingRun" | "majority" | "union";
2753
+ setMarks?: {
2754
+ bold?: "on" | "off" | "clear";
2755
+ italic?: "on" | "off" | "clear";
2756
+ underline?: "on" | "off" | "clear";
2757
+ strike?: "on" | "off" | "clear";
2758
+ };
2759
+ };
2760
+ paragraph?: {
2761
+ mode: "preserve" | "set" | "clear";
2762
+ };
2763
+ };
2764
+ };
2765
+ }) | ({
2766
+ id: string;
2767
+ op: "text.insert";
2768
+ where: {
2769
+ by: "select";
2770
+ select: ({
2771
+ type: "text";
2772
+ pattern: string;
2773
+ mode?: "contains" | "regex";
2774
+ caseSensitive?: boolean;
2775
+ }) | ({
2776
+ type: "node";
2777
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
2778
+ kind?: "block" | "inline";
2779
+ });
2780
+ within?: ({
2781
+ kind: "block";
2782
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2783
+ nodeId: string;
2784
+ }) | ({
2785
+ kind: "inline";
2786
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2787
+ anchor: {
2788
+ start: {
2789
+ blockId: string;
2790
+ offset: number;
2791
+ };
2792
+ end: {
2793
+ blockId: string;
2794
+ offset: number;
2795
+ };
2796
+ };
2797
+ });
2798
+ require: "first" | "exactlyOne";
2799
+ };
2800
+ args: {
2801
+ position: "before" | "after";
2802
+ content: {
2803
+ text: string;
2804
+ };
2805
+ style?: {
2806
+ inline: {
2807
+ mode: "inherit" | "set" | "clear";
2808
+ setMarks?: {
2809
+ bold?: "on" | "off" | "clear";
2810
+ italic?: "on" | "off" | "clear";
2811
+ underline?: "on" | "off" | "clear";
2812
+ strike?: "on" | "off" | "clear";
2813
+ };
2814
+ };
2815
+ };
2816
+ };
2817
+ }) | ({
2818
+ id: string;
2819
+ op: "text.delete";
2820
+ where: ({
2821
+ by: "select";
2822
+ select: ({
2823
+ type: "text";
2824
+ pattern: string;
2825
+ mode?: "contains" | "regex";
2826
+ caseSensitive?: boolean;
2827
+ }) | ({
2828
+ type: "node";
2829
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
2830
+ kind?: "block" | "inline";
2831
+ });
2832
+ within?: ({
2833
+ kind: "block";
2834
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2835
+ nodeId: string;
2836
+ }) | ({
2837
+ kind: "inline";
2838
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2839
+ anchor: {
2840
+ start: {
2841
+ blockId: string;
2842
+ offset: number;
2843
+ };
2844
+ end: {
2845
+ blockId: string;
2846
+ offset: number;
2847
+ };
2848
+ };
2849
+ });
2850
+ require: "first" | "exactlyOne" | "all";
2851
+ }) | ({
2852
+ by: "ref";
2853
+ ref: string;
2854
+ within?: ({
2855
+ kind: "block";
2856
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2857
+ nodeId: string;
2858
+ }) | ({
2859
+ kind: "inline";
2860
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2861
+ anchor: {
2862
+ start: {
2863
+ blockId: string;
2864
+ offset: number;
2865
+ };
2866
+ end: {
2867
+ blockId: string;
2868
+ offset: number;
2869
+ };
2870
+ };
2871
+ });
2872
+ });
2873
+ args: Record<string, unknown>;
2874
+ }) | ({
2875
+ id: string;
2876
+ op: "format.apply";
2877
+ where: ({
2878
+ by: "select";
2879
+ select: ({
2880
+ type: "text";
2881
+ pattern: string;
2882
+ mode?: "contains" | "regex";
2883
+ caseSensitive?: boolean;
2884
+ }) | ({
2885
+ type: "node";
2886
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
2887
+ kind?: "block" | "inline";
2888
+ });
2889
+ within?: ({
2890
+ kind: "block";
2891
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2892
+ nodeId: string;
2893
+ }) | ({
2894
+ kind: "inline";
2895
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2896
+ anchor: {
2897
+ start: {
2898
+ blockId: string;
2899
+ offset: number;
2900
+ };
2901
+ end: {
2902
+ blockId: string;
2903
+ offset: number;
2904
+ };
2905
+ };
2906
+ });
2907
+ require: "first" | "exactlyOne" | "all";
2908
+ }) | ({
2909
+ by: "ref";
2910
+ ref: string;
2911
+ within?: ({
2912
+ kind: "block";
2913
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
2914
+ nodeId: string;
2915
+ }) | ({
2916
+ kind: "inline";
2917
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
2918
+ anchor: {
2919
+ start: {
2920
+ blockId: string;
2921
+ offset: number;
2922
+ };
2923
+ end: {
2924
+ blockId: string;
2925
+ offset: number;
2926
+ };
2927
+ };
2928
+ });
2929
+ });
2930
+ args: {
2931
+ inline: {
2932
+ bold?: boolean | unknown;
2933
+ italic?: boolean | unknown;
2934
+ strike?: boolean | unknown;
2935
+ underline?: boolean | unknown | ({
2936
+ style?: string | unknown;
2937
+ color?: string | unknown;
2938
+ themeColor?: string | unknown;
2939
+ });
2940
+ highlight?: string | unknown;
2941
+ color?: string | unknown;
2942
+ fontSize?: number | unknown;
2943
+ fontFamily?: string | unknown;
2944
+ letterSpacing?: number | unknown;
2945
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
2946
+ position?: number | unknown;
2947
+ dstrike?: boolean | unknown;
2948
+ smallCaps?: boolean | unknown;
2949
+ caps?: boolean | unknown;
2950
+ shading?: ({
2951
+ fill?: string | unknown;
2952
+ color?: string | unknown;
2953
+ val?: string | unknown;
2954
+ }) | unknown;
2955
+ border?: ({
2956
+ val?: string | unknown;
2957
+ sz?: number | unknown;
2958
+ color?: string | unknown;
2959
+ space?: number | unknown;
2960
+ }) | unknown;
2961
+ outline?: boolean | unknown;
2962
+ shadow?: boolean | unknown;
2963
+ emboss?: boolean | unknown;
2964
+ imprint?: boolean | unknown;
2965
+ charScale?: number | unknown;
2966
+ kerning?: number | unknown;
2967
+ vanish?: boolean | unknown;
2968
+ webHidden?: boolean | unknown;
2969
+ specVanish?: boolean | unknown;
2970
+ rtl?: boolean | unknown;
2971
+ cs?: boolean | unknown;
2972
+ bCs?: boolean | unknown;
2973
+ iCs?: boolean | unknown;
2974
+ eastAsianLayout?: ({
2975
+ id?: string | unknown;
2976
+ combine?: boolean | unknown;
2977
+ combineBrackets?: string | unknown;
2978
+ vert?: boolean | unknown;
2979
+ vertCompress?: boolean | unknown;
2980
+ }) | unknown;
2981
+ em?: string | unknown;
2982
+ fitText?: ({
2983
+ val?: number | unknown;
2984
+ id?: string | unknown;
2985
+ }) | unknown;
2986
+ snapToGrid?: boolean | unknown;
2987
+ lang?: ({
2988
+ val?: string | unknown;
2989
+ eastAsia?: string | unknown;
2990
+ bidi?: string | unknown;
2991
+ }) | unknown;
2992
+ oMath?: boolean | unknown;
2993
+ rStyle?: string | unknown;
2994
+ rFonts?: ({
2995
+ ascii?: string | unknown;
2996
+ hAnsi?: string | unknown;
2997
+ eastAsia?: string | unknown;
2998
+ cs?: string | unknown;
2999
+ asciiTheme?: string | unknown;
3000
+ hAnsiTheme?: string | unknown;
3001
+ eastAsiaTheme?: string | unknown;
3002
+ csTheme?: string | unknown;
3003
+ hint?: string | unknown;
3004
+ }) | unknown;
3005
+ fontSizeCs?: number | unknown;
3006
+ ligatures?: string | unknown;
3007
+ numForm?: string | unknown;
3008
+ numSpacing?: string | unknown;
3009
+ stylisticSets?: (Array<{
3010
+ id: number;
3011
+ val?: boolean;
3012
+ }>) | unknown;
3013
+ contextualAlternates?: boolean | unknown;
3014
+ };
3015
+ };
3016
+ }) | ({
3017
+ id: string;
3018
+ op: "assert";
3019
+ where: {
3020
+ by: "select";
3021
+ select: ({
3022
+ type: "text";
3023
+ pattern: string;
3024
+ mode?: "contains" | "regex";
3025
+ caseSensitive?: boolean;
3026
+ }) | ({
3027
+ type: "node";
3028
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3029
+ kind?: "block" | "inline";
3030
+ });
3031
+ within?: ({
3032
+ kind: "block";
3033
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3034
+ nodeId: string;
3035
+ }) | ({
3036
+ kind: "inline";
3037
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3038
+ anchor: {
3039
+ start: {
3040
+ blockId: string;
3041
+ offset: number;
3042
+ };
3043
+ end: {
3044
+ blockId: string;
3045
+ offset: number;
3046
+ };
3047
+ };
3048
+ });
3049
+ };
3050
+ args: {
3051
+ expectCount: number;
3052
+ };
3053
+ })>;
2685
3054
  }
2686
3055
  export interface DocMutationsApplyParams {
2687
3056
  doc?: string;
@@ -2690,8 +3059,377 @@ export interface DocMutationsApplyParams {
2690
3059
  force?: boolean;
2691
3060
  expectedRevision?: number;
2692
3061
  changeMode?: string;
2693
- atomic: true;
2694
- steps: unknown;
3062
+ atomic: boolean;
3063
+ steps: Array<({
3064
+ id: string;
3065
+ op: "text.rewrite";
3066
+ where: ({
3067
+ by: "select";
3068
+ select: ({
3069
+ type: "text";
3070
+ pattern: string;
3071
+ mode?: "contains" | "regex";
3072
+ caseSensitive?: boolean;
3073
+ }) | ({
3074
+ type: "node";
3075
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3076
+ kind?: "block" | "inline";
3077
+ });
3078
+ within?: ({
3079
+ kind: "block";
3080
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3081
+ nodeId: string;
3082
+ }) | ({
3083
+ kind: "inline";
3084
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3085
+ anchor: {
3086
+ start: {
3087
+ blockId: string;
3088
+ offset: number;
3089
+ };
3090
+ end: {
3091
+ blockId: string;
3092
+ offset: number;
3093
+ };
3094
+ };
3095
+ });
3096
+ require: "first" | "exactlyOne" | "all";
3097
+ }) | ({
3098
+ by: "ref";
3099
+ ref: string;
3100
+ within?: ({
3101
+ kind: "block";
3102
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3103
+ nodeId: string;
3104
+ }) | ({
3105
+ kind: "inline";
3106
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3107
+ anchor: {
3108
+ start: {
3109
+ blockId: string;
3110
+ offset: number;
3111
+ };
3112
+ end: {
3113
+ blockId: string;
3114
+ offset: number;
3115
+ };
3116
+ };
3117
+ });
3118
+ });
3119
+ args: {
3120
+ replacement: ({
3121
+ text: string;
3122
+ }) | ({
3123
+ blocks: Array<{
3124
+ text: string;
3125
+ }>;
3126
+ });
3127
+ style?: {
3128
+ inline: {
3129
+ mode: "preserve" | "set" | "clear" | "merge";
3130
+ requireUniform?: boolean;
3131
+ onNonUniform?: "error" | "useLeadingRun" | "majority" | "union";
3132
+ setMarks?: {
3133
+ bold?: "on" | "off" | "clear";
3134
+ italic?: "on" | "off" | "clear";
3135
+ underline?: "on" | "off" | "clear";
3136
+ strike?: "on" | "off" | "clear";
3137
+ };
3138
+ };
3139
+ paragraph?: {
3140
+ mode: "preserve" | "set" | "clear";
3141
+ };
3142
+ };
3143
+ };
3144
+ }) | ({
3145
+ id: string;
3146
+ op: "text.insert";
3147
+ where: {
3148
+ by: "select";
3149
+ select: ({
3150
+ type: "text";
3151
+ pattern: string;
3152
+ mode?: "contains" | "regex";
3153
+ caseSensitive?: boolean;
3154
+ }) | ({
3155
+ type: "node";
3156
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3157
+ kind?: "block" | "inline";
3158
+ });
3159
+ within?: ({
3160
+ kind: "block";
3161
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3162
+ nodeId: string;
3163
+ }) | ({
3164
+ kind: "inline";
3165
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3166
+ anchor: {
3167
+ start: {
3168
+ blockId: string;
3169
+ offset: number;
3170
+ };
3171
+ end: {
3172
+ blockId: string;
3173
+ offset: number;
3174
+ };
3175
+ };
3176
+ });
3177
+ require: "first" | "exactlyOne";
3178
+ };
3179
+ args: {
3180
+ position: "before" | "after";
3181
+ content: {
3182
+ text: string;
3183
+ };
3184
+ style?: {
3185
+ inline: {
3186
+ mode: "inherit" | "set" | "clear";
3187
+ setMarks?: {
3188
+ bold?: "on" | "off" | "clear";
3189
+ italic?: "on" | "off" | "clear";
3190
+ underline?: "on" | "off" | "clear";
3191
+ strike?: "on" | "off" | "clear";
3192
+ };
3193
+ };
3194
+ };
3195
+ };
3196
+ }) | ({
3197
+ id: string;
3198
+ op: "text.delete";
3199
+ where: ({
3200
+ by: "select";
3201
+ select: ({
3202
+ type: "text";
3203
+ pattern: string;
3204
+ mode?: "contains" | "regex";
3205
+ caseSensitive?: boolean;
3206
+ }) | ({
3207
+ type: "node";
3208
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3209
+ kind?: "block" | "inline";
3210
+ });
3211
+ within?: ({
3212
+ kind: "block";
3213
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3214
+ nodeId: string;
3215
+ }) | ({
3216
+ kind: "inline";
3217
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3218
+ anchor: {
3219
+ start: {
3220
+ blockId: string;
3221
+ offset: number;
3222
+ };
3223
+ end: {
3224
+ blockId: string;
3225
+ offset: number;
3226
+ };
3227
+ };
3228
+ });
3229
+ require: "first" | "exactlyOne" | "all";
3230
+ }) | ({
3231
+ by: "ref";
3232
+ ref: string;
3233
+ within?: ({
3234
+ kind: "block";
3235
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3236
+ nodeId: string;
3237
+ }) | ({
3238
+ kind: "inline";
3239
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3240
+ anchor: {
3241
+ start: {
3242
+ blockId: string;
3243
+ offset: number;
3244
+ };
3245
+ end: {
3246
+ blockId: string;
3247
+ offset: number;
3248
+ };
3249
+ };
3250
+ });
3251
+ });
3252
+ args: Record<string, unknown>;
3253
+ }) | ({
3254
+ id: string;
3255
+ op: "format.apply";
3256
+ where: ({
3257
+ by: "select";
3258
+ select: ({
3259
+ type: "text";
3260
+ pattern: string;
3261
+ mode?: "contains" | "regex";
3262
+ caseSensitive?: boolean;
3263
+ }) | ({
3264
+ type: "node";
3265
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3266
+ kind?: "block" | "inline";
3267
+ });
3268
+ within?: ({
3269
+ kind: "block";
3270
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3271
+ nodeId: string;
3272
+ }) | ({
3273
+ kind: "inline";
3274
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3275
+ anchor: {
3276
+ start: {
3277
+ blockId: string;
3278
+ offset: number;
3279
+ };
3280
+ end: {
3281
+ blockId: string;
3282
+ offset: number;
3283
+ };
3284
+ };
3285
+ });
3286
+ require: "first" | "exactlyOne" | "all";
3287
+ }) | ({
3288
+ by: "ref";
3289
+ ref: string;
3290
+ within?: ({
3291
+ kind: "block";
3292
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3293
+ nodeId: string;
3294
+ }) | ({
3295
+ kind: "inline";
3296
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3297
+ anchor: {
3298
+ start: {
3299
+ blockId: string;
3300
+ offset: number;
3301
+ };
3302
+ end: {
3303
+ blockId: string;
3304
+ offset: number;
3305
+ };
3306
+ };
3307
+ });
3308
+ });
3309
+ args: {
3310
+ inline: {
3311
+ bold?: boolean | unknown;
3312
+ italic?: boolean | unknown;
3313
+ strike?: boolean | unknown;
3314
+ underline?: boolean | unknown | ({
3315
+ style?: string | unknown;
3316
+ color?: string | unknown;
3317
+ themeColor?: string | unknown;
3318
+ });
3319
+ highlight?: string | unknown;
3320
+ color?: string | unknown;
3321
+ fontSize?: number | unknown;
3322
+ fontFamily?: string | unknown;
3323
+ letterSpacing?: number | unknown;
3324
+ vertAlign?: "superscript" | "subscript" | "baseline" | unknown;
3325
+ position?: number | unknown;
3326
+ dstrike?: boolean | unknown;
3327
+ smallCaps?: boolean | unknown;
3328
+ caps?: boolean | unknown;
3329
+ shading?: ({
3330
+ fill?: string | unknown;
3331
+ color?: string | unknown;
3332
+ val?: string | unknown;
3333
+ }) | unknown;
3334
+ border?: ({
3335
+ val?: string | unknown;
3336
+ sz?: number | unknown;
3337
+ color?: string | unknown;
3338
+ space?: number | unknown;
3339
+ }) | unknown;
3340
+ outline?: boolean | unknown;
3341
+ shadow?: boolean | unknown;
3342
+ emboss?: boolean | unknown;
3343
+ imprint?: boolean | unknown;
3344
+ charScale?: number | unknown;
3345
+ kerning?: number | unknown;
3346
+ vanish?: boolean | unknown;
3347
+ webHidden?: boolean | unknown;
3348
+ specVanish?: boolean | unknown;
3349
+ rtl?: boolean | unknown;
3350
+ cs?: boolean | unknown;
3351
+ bCs?: boolean | unknown;
3352
+ iCs?: boolean | unknown;
3353
+ eastAsianLayout?: ({
3354
+ id?: string | unknown;
3355
+ combine?: boolean | unknown;
3356
+ combineBrackets?: string | unknown;
3357
+ vert?: boolean | unknown;
3358
+ vertCompress?: boolean | unknown;
3359
+ }) | unknown;
3360
+ em?: string | unknown;
3361
+ fitText?: ({
3362
+ val?: number | unknown;
3363
+ id?: string | unknown;
3364
+ }) | unknown;
3365
+ snapToGrid?: boolean | unknown;
3366
+ lang?: ({
3367
+ val?: string | unknown;
3368
+ eastAsia?: string | unknown;
3369
+ bidi?: string | unknown;
3370
+ }) | unknown;
3371
+ oMath?: boolean | unknown;
3372
+ rStyle?: string | unknown;
3373
+ rFonts?: ({
3374
+ ascii?: string | unknown;
3375
+ hAnsi?: string | unknown;
3376
+ eastAsia?: string | unknown;
3377
+ cs?: string | unknown;
3378
+ asciiTheme?: string | unknown;
3379
+ hAnsiTheme?: string | unknown;
3380
+ eastAsiaTheme?: string | unknown;
3381
+ csTheme?: string | unknown;
3382
+ hint?: string | unknown;
3383
+ }) | unknown;
3384
+ fontSizeCs?: number | unknown;
3385
+ ligatures?: string | unknown;
3386
+ numForm?: string | unknown;
3387
+ numSpacing?: string | unknown;
3388
+ stylisticSets?: (Array<{
3389
+ id: number;
3390
+ val?: boolean;
3391
+ }>) | unknown;
3392
+ contextualAlternates?: boolean | unknown;
3393
+ };
3394
+ };
3395
+ }) | ({
3396
+ id: string;
3397
+ op: "assert";
3398
+ where: {
3399
+ by: "select";
3400
+ select: ({
3401
+ type: "text";
3402
+ pattern: string;
3403
+ mode?: "contains" | "regex";
3404
+ caseSensitive?: boolean;
3405
+ }) | ({
3406
+ type: "node";
3407
+ nodeType?: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "tab" | "lineBreak";
3408
+ kind?: "block" | "inline";
3409
+ });
3410
+ within?: ({
3411
+ kind: "block";
3412
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
3413
+ nodeId: string;
3414
+ }) | ({
3415
+ kind: "inline";
3416
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
3417
+ anchor: {
3418
+ start: {
3419
+ blockId: string;
3420
+ offset: number;
3421
+ };
3422
+ end: {
3423
+ blockId: string;
3424
+ offset: number;
3425
+ };
3426
+ };
3427
+ });
3428
+ };
3429
+ args: {
3430
+ expectCount: number;
3431
+ };
3432
+ })>;
2695
3433
  }
2696
3434
  export interface DocCapabilitiesGetParams {
2697
3435
  sessionId?: string;
@@ -3899,6 +4637,161 @@ export interface DocImagesSetZOrderParams {
3899
4637
  relativeHeight: number;
3900
4638
  };
3901
4639
  }
4640
+ export interface DocHyperlinksListParams {
4641
+ doc?: string;
4642
+ sessionId?: string;
4643
+ within?: ({
4644
+ kind: "block";
4645
+ nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
4646
+ nodeId: string;
4647
+ }) | ({
4648
+ kind: "inline";
4649
+ nodeType: "run" | "bookmark" | "comment" | "hyperlink" | "sdt" | "image" | "footnoteRef" | "tab" | "lineBreak";
4650
+ anchor: {
4651
+ start: {
4652
+ blockId: string;
4653
+ offset: number;
4654
+ };
4655
+ end: {
4656
+ blockId: string;
4657
+ offset: number;
4658
+ };
4659
+ };
4660
+ });
4661
+ hrefPattern?: string;
4662
+ anchor?: string;
4663
+ textPattern?: string;
4664
+ limit?: number;
4665
+ offset?: number;
4666
+ }
4667
+ export interface DocHyperlinksGetParams {
4668
+ doc?: string;
4669
+ sessionId?: string;
4670
+ target: {
4671
+ kind: "inline";
4672
+ nodeType: "hyperlink";
4673
+ anchor: {
4674
+ start: {
4675
+ blockId: string;
4676
+ offset: number;
4677
+ };
4678
+ end: {
4679
+ blockId: string;
4680
+ offset: number;
4681
+ };
4682
+ };
4683
+ };
4684
+ }
4685
+ export interface DocHyperlinksWrapParams {
4686
+ doc?: string;
4687
+ sessionId?: string;
4688
+ out?: string;
4689
+ force?: boolean;
4690
+ expectedRevision?: number;
4691
+ changeMode?: string;
4692
+ dryRun?: boolean;
4693
+ target: {
4694
+ kind: "text";
4695
+ blockId: string;
4696
+ range: {
4697
+ start: number;
4698
+ end: number;
4699
+ };
4700
+ };
4701
+ link: {
4702
+ destination: {
4703
+ href?: string;
4704
+ anchor?: string;
4705
+ docLocation?: string;
4706
+ };
4707
+ tooltip?: string;
4708
+ target?: string;
4709
+ rel?: string;
4710
+ };
4711
+ }
4712
+ export interface DocHyperlinksInsertParams {
4713
+ doc?: string;
4714
+ sessionId?: string;
4715
+ out?: string;
4716
+ force?: boolean;
4717
+ expectedRevision?: number;
4718
+ changeMode?: string;
4719
+ dryRun?: boolean;
4720
+ target?: {
4721
+ kind: "text";
4722
+ blockId: string;
4723
+ range: {
4724
+ start: number;
4725
+ end: number;
4726
+ };
4727
+ };
4728
+ text: string;
4729
+ link: {
4730
+ destination: {
4731
+ href?: string;
4732
+ anchor?: string;
4733
+ docLocation?: string;
4734
+ };
4735
+ tooltip?: string;
4736
+ target?: string;
4737
+ rel?: string;
4738
+ };
4739
+ }
4740
+ export interface DocHyperlinksPatchParams {
4741
+ doc?: string;
4742
+ sessionId?: string;
4743
+ out?: string;
4744
+ force?: boolean;
4745
+ expectedRevision?: number;
4746
+ changeMode?: string;
4747
+ dryRun?: boolean;
4748
+ target: {
4749
+ kind: "inline";
4750
+ nodeType: "hyperlink";
4751
+ anchor: {
4752
+ start: {
4753
+ blockId: string;
4754
+ offset: number;
4755
+ };
4756
+ end: {
4757
+ blockId: string;
4758
+ offset: number;
4759
+ };
4760
+ };
4761
+ };
4762
+ patch: {
4763
+ href?: string | unknown;
4764
+ anchor?: string | unknown;
4765
+ docLocation?: string | unknown;
4766
+ tooltip?: string | unknown;
4767
+ target?: string | unknown;
4768
+ rel?: string | unknown;
4769
+ };
4770
+ }
4771
+ export interface DocHyperlinksRemoveParams {
4772
+ doc?: string;
4773
+ sessionId?: string;
4774
+ out?: string;
4775
+ force?: boolean;
4776
+ expectedRevision?: number;
4777
+ changeMode?: string;
4778
+ dryRun?: boolean;
4779
+ target: {
4780
+ kind: "inline";
4781
+ nodeType: "hyperlink";
4782
+ anchor: {
4783
+ start: {
4784
+ blockId: string;
4785
+ offset: number;
4786
+ };
4787
+ end: {
4788
+ blockId: string;
4789
+ offset: number;
4790
+ };
4791
+ };
4792
+ };
4793
+ mode?: string;
4794
+ }
3902
4795
  export interface DocOpenParams {
3903
4796
  doc?: string;
3904
4797
  sessionId?: string;
@@ -5604,6 +6497,42 @@ export type DocCapabilitiesGetResult = {
5604
6497
  reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
5605
6498
  tracked: boolean;
5606
6499
  };
6500
+ "hyperlinks.get": {
6501
+ available: boolean;
6502
+ dryRun: boolean;
6503
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6504
+ tracked: boolean;
6505
+ };
6506
+ "hyperlinks.insert": {
6507
+ available: boolean;
6508
+ dryRun: boolean;
6509
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6510
+ tracked: boolean;
6511
+ };
6512
+ "hyperlinks.list": {
6513
+ available: boolean;
6514
+ dryRun: boolean;
6515
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6516
+ tracked: boolean;
6517
+ };
6518
+ "hyperlinks.patch": {
6519
+ available: boolean;
6520
+ dryRun: boolean;
6521
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6522
+ tracked: boolean;
6523
+ };
6524
+ "hyperlinks.remove": {
6525
+ available: boolean;
6526
+ dryRun: boolean;
6527
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6528
+ tracked: boolean;
6529
+ };
6530
+ "hyperlinks.wrap": {
6531
+ available: boolean;
6532
+ dryRun: boolean;
6533
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
6534
+ tracked: boolean;
6535
+ };
5607
6536
  "images.convertToFloating": {
5608
6537
  available: boolean;
5609
6538
  dryRun: boolean;
@@ -6781,6 +7710,75 @@ export type DocImagesSetZOrderResult = {
6781
7710
  image: Record<string, unknown>;
6782
7711
  success: true;
6783
7712
  };
7713
+ export type DocHyperlinksListResult = {
7714
+ evaluatedRevision: string;
7715
+ items: Array<{
7716
+ address: {
7717
+ anchor: unknown;
7718
+ kind: "inline";
7719
+ nodeType: "hyperlink";
7720
+ };
7721
+ properties: {
7722
+ anchor?: string;
7723
+ docLocation?: string;
7724
+ href?: string;
7725
+ rel?: string;
7726
+ target?: string;
7727
+ tooltip?: string;
7728
+ };
7729
+ text?: string;
7730
+ }>;
7731
+ page: unknown;
7732
+ total: number;
7733
+ };
7734
+ export type DocHyperlinksGetResult = {
7735
+ address: {
7736
+ anchor: unknown;
7737
+ kind: "inline";
7738
+ nodeType: "hyperlink";
7739
+ };
7740
+ properties: {
7741
+ anchor?: string;
7742
+ docLocation?: string;
7743
+ href?: string;
7744
+ rel?: string;
7745
+ target?: string;
7746
+ tooltip?: string;
7747
+ };
7748
+ text?: string;
7749
+ };
7750
+ export type DocHyperlinksWrapResult = {
7751
+ hyperlink: {
7752
+ anchor: unknown;
7753
+ kind: "inline";
7754
+ nodeType: "hyperlink";
7755
+ };
7756
+ success: true;
7757
+ };
7758
+ export type DocHyperlinksInsertResult = {
7759
+ hyperlink: {
7760
+ anchor: unknown;
7761
+ kind: "inline";
7762
+ nodeType: "hyperlink";
7763
+ };
7764
+ success: true;
7765
+ };
7766
+ export type DocHyperlinksPatchResult = {
7767
+ hyperlink: {
7768
+ anchor: unknown;
7769
+ kind: "inline";
7770
+ nodeType: "hyperlink";
7771
+ };
7772
+ success: true;
7773
+ };
7774
+ export type DocHyperlinksRemoveResult = {
7775
+ hyperlink: {
7776
+ anchor: unknown;
7777
+ kind: "inline";
7778
+ nodeType: "hyperlink";
7779
+ };
7780
+ success: true;
7781
+ };
6784
7782
  export type DocOpenResult = {
6785
7783
  contextId: string;
6786
7784
  sessionType: string;
@@ -7144,6 +8142,14 @@ export declare function createDocApi(runtime: SuperDocRuntime): {
7144
8142
  setAnchorOptions: (params: DocImagesSetAnchorOptionsParams, options?: InvokeOptions) => Promise<DocImagesSetAnchorOptionsResult>;
7145
8143
  setZOrder: (params: DocImagesSetZOrderParams, options?: InvokeOptions) => Promise<DocImagesSetZOrderResult>;
7146
8144
  };
8145
+ hyperlinks: {
8146
+ list: (params?: DocHyperlinksListParams, options?: InvokeOptions) => Promise<DocHyperlinksListResult>;
8147
+ get: (params: DocHyperlinksGetParams, options?: InvokeOptions) => Promise<DocHyperlinksGetResult>;
8148
+ wrap: (params: DocHyperlinksWrapParams, options?: InvokeOptions) => Promise<DocHyperlinksWrapResult>;
8149
+ insert: (params: DocHyperlinksInsertParams, options?: InvokeOptions) => Promise<DocHyperlinksInsertResult>;
8150
+ patch: (params: DocHyperlinksPatchParams, options?: InvokeOptions) => Promise<DocHyperlinksPatchResult>;
8151
+ remove: (params: DocHyperlinksRemoveParams, options?: InvokeOptions) => Promise<DocHyperlinksRemoveResult>;
8152
+ };
7147
8153
  open: (params?: DocOpenParams, options?: InvokeOptions) => Promise<DocOpenResult>;
7148
8154
  save: (params?: DocSaveParams, options?: InvokeOptions) => Promise<DocSaveResult>;
7149
8155
  close: (params?: DocCloseParams, options?: InvokeOptions) => Promise<DocCloseResult>;