@superdoc-dev/sdk 1.3.0-next.14 → 1.3.0-next.15

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.
@@ -487,6 +487,18 @@ function createDocApi(runtime) {
487
487
  compare: async (params, options) => unwrapEnvelope(await runtime.invoke(contract.CONTRACT.operations["doc.diff.compare"], params, options), "diff"),
488
488
  apply: async (params, options) => unwrapEnvelope(await runtime.invoke(contract.CONTRACT.operations["doc.diff.apply"], params, options), "result"),
489
489
  },
490
+ protection: {
491
+ get: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.get"], params, options),
492
+ setEditingRestriction: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.setEditingRestriction"], params, options),
493
+ clearEditingRestriction: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.clearEditingRestriction"], params, options),
494
+ },
495
+ permissionRanges: {
496
+ list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.list"], params, options),
497
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.get"], params, options),
498
+ create: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.create"], params, options),
499
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.remove"], params, options),
500
+ updatePrincipal: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.updatePrincipal"], params, options),
501
+ },
490
502
  open: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.open"], params, options),
491
503
  save: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.save"], params, options),
492
504
  close: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.close"], params, options),
@@ -968,6 +980,18 @@ function createBoundDocApi(runtime) {
968
980
  compare: async (params, options) => unwrapEnvelope(await runtime.invoke(contract.CONTRACT.operations["doc.diff.compare"], params, options), "diff"),
969
981
  apply: async (params, options) => unwrapEnvelope(await runtime.invoke(contract.CONTRACT.operations["doc.diff.apply"], params, options), "result"),
970
982
  },
983
+ protection: {
984
+ get: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.get"], params, options),
985
+ setEditingRestriction: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.setEditingRestriction"], params, options),
986
+ clearEditingRestriction: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.protection.clearEditingRestriction"], params, options),
987
+ },
988
+ permissionRanges: {
989
+ list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.list"], params, options),
990
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.get"], params, options),
991
+ create: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.create"], params, options),
992
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.remove"], params, options),
993
+ updatePrincipal: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.permissionRanges.updatePrincipal"], params, options),
994
+ },
971
995
  save: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.save"], params, options),
972
996
  close: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.close"], params, options),
973
997
  };
@@ -9126,6 +9126,108 @@ export interface DocDiffApplyParams {
9126
9126
  payload: Record<string, unknown>;
9127
9127
  };
9128
9128
  }
9129
+ export interface DocProtectionGetParams {
9130
+ doc?: string;
9131
+ sessionId?: string;
9132
+ }
9133
+ export interface DocProtectionSetEditingRestrictionParams {
9134
+ doc?: string;
9135
+ sessionId?: string;
9136
+ out?: string;
9137
+ force?: boolean;
9138
+ expectedRevision?: number;
9139
+ changeMode?: string;
9140
+ dryRun?: boolean;
9141
+ mode: string;
9142
+ formattingRestricted?: boolean;
9143
+ }
9144
+ export interface DocProtectionClearEditingRestrictionParams {
9145
+ doc?: string;
9146
+ sessionId?: string;
9147
+ out?: string;
9148
+ force?: boolean;
9149
+ expectedRevision?: number;
9150
+ changeMode?: string;
9151
+ dryRun?: boolean;
9152
+ }
9153
+ export interface DocPermissionRangesListParams {
9154
+ doc?: string;
9155
+ sessionId?: string;
9156
+ limit?: number;
9157
+ offset?: number;
9158
+ }
9159
+ export interface DocPermissionRangesGetParams {
9160
+ doc?: string;
9161
+ sessionId?: string;
9162
+ id: string;
9163
+ }
9164
+ export interface DocPermissionRangesCreateParams {
9165
+ doc?: string;
9166
+ sessionId?: string;
9167
+ out?: string;
9168
+ force?: boolean;
9169
+ expectedRevision?: number;
9170
+ changeMode?: string;
9171
+ dryRun?: boolean;
9172
+ target: {
9173
+ kind: "selection";
9174
+ start: ({
9175
+ kind: "text";
9176
+ blockId: string;
9177
+ offset: number;
9178
+ }) | ({
9179
+ kind: "nodeEdge";
9180
+ node: {
9181
+ kind: "block";
9182
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
9183
+ nodeId: string;
9184
+ };
9185
+ edge: "before" | "after";
9186
+ });
9187
+ end: ({
9188
+ kind: "text";
9189
+ blockId: string;
9190
+ offset: number;
9191
+ }) | ({
9192
+ kind: "nodeEdge";
9193
+ node: {
9194
+ kind: "block";
9195
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
9196
+ nodeId: string;
9197
+ };
9198
+ edge: "before" | "after";
9199
+ });
9200
+ };
9201
+ principal: {
9202
+ kind: "everyone" | "editor";
9203
+ id?: string;
9204
+ };
9205
+ id?: string;
9206
+ }
9207
+ export interface DocPermissionRangesRemoveParams {
9208
+ doc?: string;
9209
+ sessionId?: string;
9210
+ out?: string;
9211
+ force?: boolean;
9212
+ expectedRevision?: number;
9213
+ changeMode?: string;
9214
+ dryRun?: boolean;
9215
+ id: string;
9216
+ }
9217
+ export interface DocPermissionRangesUpdatePrincipalParams {
9218
+ doc?: string;
9219
+ sessionId?: string;
9220
+ out?: string;
9221
+ force?: boolean;
9222
+ expectedRevision?: number;
9223
+ changeMode?: string;
9224
+ dryRun?: boolean;
9225
+ id: string;
9226
+ principal: {
9227
+ kind: "everyone" | "editor";
9228
+ id?: string;
9229
+ };
9230
+ }
9129
9231
  export interface DocOpenParams {
9130
9232
  doc?: string;
9131
9233
  sessionId?: string;
@@ -12252,6 +12354,54 @@ export type DocCapabilitiesGetResult = {
12252
12354
  reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12253
12355
  tracked: boolean;
12254
12356
  };
12357
+ "permissionRanges.create": {
12358
+ available: boolean;
12359
+ dryRun: boolean;
12360
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12361
+ tracked: boolean;
12362
+ };
12363
+ "permissionRanges.get": {
12364
+ available: boolean;
12365
+ dryRun: boolean;
12366
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12367
+ tracked: boolean;
12368
+ };
12369
+ "permissionRanges.list": {
12370
+ available: boolean;
12371
+ dryRun: boolean;
12372
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12373
+ tracked: boolean;
12374
+ };
12375
+ "permissionRanges.remove": {
12376
+ available: boolean;
12377
+ dryRun: boolean;
12378
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12379
+ tracked: boolean;
12380
+ };
12381
+ "permissionRanges.updatePrincipal": {
12382
+ available: boolean;
12383
+ dryRun: boolean;
12384
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12385
+ tracked: boolean;
12386
+ };
12387
+ "protection.clearEditingRestriction": {
12388
+ available: boolean;
12389
+ dryRun: boolean;
12390
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12391
+ tracked: boolean;
12392
+ };
12393
+ "protection.get": {
12394
+ available: boolean;
12395
+ dryRun: boolean;
12396
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12397
+ tracked: boolean;
12398
+ };
12399
+ "protection.setEditingRestriction": {
12400
+ available: boolean;
12401
+ dryRun: boolean;
12402
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
12403
+ tracked: boolean;
12404
+ };
12255
12405
  "query.match": {
12256
12406
  available: boolean;
12257
12407
  dryRun: boolean;
@@ -14433,6 +14583,27 @@ export type DocDiffApplyResult = {
14433
14583
  };
14434
14584
  targetFingerprint: string;
14435
14585
  };
14586
+ export type DocProtectionGetResult = {
14587
+ editingRestriction: {
14588
+ enforced: boolean;
14589
+ formattingRestricted: boolean;
14590
+ mode: "none" | "readOnly" | "comments" | "trackedChanges" | "forms";
14591
+ passwordProtected: boolean;
14592
+ runtimeEnforced: boolean;
14593
+ };
14594
+ readOnlyRecommended: boolean;
14595
+ writeProtection: {
14596
+ enabled: boolean;
14597
+ passwordProtected: boolean;
14598
+ };
14599
+ };
14600
+ export type DocProtectionSetEditingRestrictionResult = Record<string, unknown>;
14601
+ export type DocProtectionClearEditingRestrictionResult = Record<string, unknown>;
14602
+ export type DocPermissionRangesListResult = Record<string, unknown>;
14603
+ export type DocPermissionRangesGetResult = Record<string, unknown>;
14604
+ export type DocPermissionRangesCreateResult = Record<string, unknown>;
14605
+ export type DocPermissionRangesRemoveResult = Record<string, unknown>;
14606
+ export type DocPermissionRangesUpdatePrincipalResult = Record<string, unknown>;
14436
14607
  export type DocOpenResult = {
14437
14608
  active: boolean;
14438
14609
  contextId: string;
@@ -22953,6 +23124,92 @@ export interface DocDiffApplyBoundParams {
22953
23124
  payload: Record<string, unknown>;
22954
23125
  };
22955
23126
  }
23127
+ export interface DocProtectionGetBoundParams {
23128
+ }
23129
+ export interface DocProtectionSetEditingRestrictionBoundParams {
23130
+ out?: string;
23131
+ force?: boolean;
23132
+ expectedRevision?: number;
23133
+ changeMode?: string;
23134
+ dryRun?: boolean;
23135
+ mode: string;
23136
+ formattingRestricted?: boolean;
23137
+ }
23138
+ export interface DocProtectionClearEditingRestrictionBoundParams {
23139
+ out?: string;
23140
+ force?: boolean;
23141
+ expectedRevision?: number;
23142
+ changeMode?: string;
23143
+ dryRun?: boolean;
23144
+ }
23145
+ export interface DocPermissionRangesListBoundParams {
23146
+ limit?: number;
23147
+ offset?: number;
23148
+ }
23149
+ export interface DocPermissionRangesGetBoundParams {
23150
+ id: string;
23151
+ }
23152
+ export interface DocPermissionRangesCreateBoundParams {
23153
+ out?: string;
23154
+ force?: boolean;
23155
+ expectedRevision?: number;
23156
+ changeMode?: string;
23157
+ dryRun?: boolean;
23158
+ target: {
23159
+ kind: "selection";
23160
+ start: ({
23161
+ kind: "text";
23162
+ blockId: string;
23163
+ offset: number;
23164
+ }) | ({
23165
+ kind: "nodeEdge";
23166
+ node: {
23167
+ kind: "block";
23168
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
23169
+ nodeId: string;
23170
+ };
23171
+ edge: "before" | "after";
23172
+ });
23173
+ end: ({
23174
+ kind: "text";
23175
+ blockId: string;
23176
+ offset: number;
23177
+ }) | ({
23178
+ kind: "nodeEdge";
23179
+ node: {
23180
+ kind: "block";
23181
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
23182
+ nodeId: string;
23183
+ };
23184
+ edge: "before" | "after";
23185
+ });
23186
+ };
23187
+ principal: {
23188
+ kind: "everyone" | "editor";
23189
+ id?: string;
23190
+ };
23191
+ id?: string;
23192
+ }
23193
+ export interface DocPermissionRangesRemoveBoundParams {
23194
+ out?: string;
23195
+ force?: boolean;
23196
+ expectedRevision?: number;
23197
+ changeMode?: string;
23198
+ dryRun?: boolean;
23199
+ id: string;
23200
+ }
23201
+ export interface DocPermissionRangesUpdatePrincipalBoundParams {
23202
+ out?: string;
23203
+ force?: boolean;
23204
+ expectedRevision?: number;
23205
+ changeMode?: string;
23206
+ dryRun?: boolean;
23207
+ id: string;
23208
+ principal: {
23209
+ kind: "everyone" | "editor";
23210
+ id?: string;
23211
+ };
23212
+ }
22956
23213
  export interface DocSaveBoundParams {
22957
23214
  out?: string;
22958
23215
  force?: boolean;
@@ -23424,6 +23681,18 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
23424
23681
  compare: (params: DocDiffCompareParams, options?: InvokeOptions) => Promise<DocDiffCompareResult>;
23425
23682
  apply: (params: DocDiffApplyParams, options?: InvokeOptions) => Promise<DocDiffApplyResult>;
23426
23683
  };
23684
+ protection: {
23685
+ get: (params?: DocProtectionGetParams, options?: InvokeOptions) => Promise<DocProtectionGetResult>;
23686
+ setEditingRestriction: (params: DocProtectionSetEditingRestrictionParams, options?: InvokeOptions) => Promise<DocProtectionSetEditingRestrictionResult>;
23687
+ clearEditingRestriction: (params?: DocProtectionClearEditingRestrictionParams, options?: InvokeOptions) => Promise<DocProtectionClearEditingRestrictionResult>;
23688
+ };
23689
+ permissionRanges: {
23690
+ list: (params?: DocPermissionRangesListParams, options?: InvokeOptions) => Promise<DocPermissionRangesListResult>;
23691
+ get: (params: DocPermissionRangesGetParams, options?: InvokeOptions) => Promise<DocPermissionRangesGetResult>;
23692
+ create: (params: DocPermissionRangesCreateParams, options?: InvokeOptions) => Promise<DocPermissionRangesCreateResult>;
23693
+ remove: (params: DocPermissionRangesRemoveParams, options?: InvokeOptions) => Promise<DocPermissionRangesRemoveResult>;
23694
+ updatePrincipal: (params: DocPermissionRangesUpdatePrincipalParams, options?: InvokeOptions) => Promise<DocPermissionRangesUpdatePrincipalResult>;
23695
+ };
23427
23696
  open: (params?: DocOpenParams, options?: InvokeOptions) => Promise<DocOpenResult>;
23428
23697
  save: (params?: DocSaveParams, options?: InvokeOptions) => Promise<DocSaveResult>;
23429
23698
  close: (params?: DocCloseParams, options?: InvokeOptions) => Promise<DocCloseResult>;
@@ -23901,6 +24170,18 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
23901
24170
  compare: (params: DocDiffCompareBoundParams, options?: InvokeOptions) => Promise<DocDiffCompareResult>;
23902
24171
  apply: (params: DocDiffApplyBoundParams, options?: InvokeOptions) => Promise<DocDiffApplyResult>;
23903
24172
  };
24173
+ protection: {
24174
+ get: (params?: DocProtectionGetBoundParams, options?: InvokeOptions) => Promise<DocProtectionGetResult>;
24175
+ setEditingRestriction: (params: DocProtectionSetEditingRestrictionBoundParams, options?: InvokeOptions) => Promise<DocProtectionSetEditingRestrictionResult>;
24176
+ clearEditingRestriction: (params?: DocProtectionClearEditingRestrictionBoundParams, options?: InvokeOptions) => Promise<DocProtectionClearEditingRestrictionResult>;
24177
+ };
24178
+ permissionRanges: {
24179
+ list: (params?: DocPermissionRangesListBoundParams, options?: InvokeOptions) => Promise<DocPermissionRangesListResult>;
24180
+ get: (params: DocPermissionRangesGetBoundParams, options?: InvokeOptions) => Promise<DocPermissionRangesGetResult>;
24181
+ create: (params: DocPermissionRangesCreateBoundParams, options?: InvokeOptions) => Promise<DocPermissionRangesCreateResult>;
24182
+ remove: (params: DocPermissionRangesRemoveBoundParams, options?: InvokeOptions) => Promise<DocPermissionRangesRemoveResult>;
24183
+ updatePrincipal: (params: DocPermissionRangesUpdatePrincipalBoundParams, options?: InvokeOptions) => Promise<DocPermissionRangesUpdatePrincipalResult>;
24184
+ };
23904
24185
  save: (params?: DocSaveBoundParams, options?: InvokeOptions) => Promise<DocSaveResult>;
23905
24186
  close: (params?: DocCloseBoundParams, options?: InvokeOptions) => Promise<DocCloseResult>;
23906
24187
  };