@superdoc-dev/sdk 1.10.0-next.9 → 1.11.0-next.1

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.
@@ -517,6 +517,14 @@ function createDocApi(runtime) {
517
517
  remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.customXml.parts.remove"], params, options),
518
518
  },
519
519
  },
520
+ metadata: {
521
+ attach: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.attach"], params, options),
522
+ list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.list"], params, options),
523
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.get"], params, options),
524
+ update: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.update"], params, options),
525
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.remove"], params, options),
526
+ resolve: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.resolve"], params, options),
527
+ },
520
528
  open: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.open"], params, options),
521
529
  save: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.save"], params, options),
522
530
  close: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.close"], params, options),
@@ -1030,6 +1038,14 @@ function createBoundDocApi(runtime) {
1030
1038
  remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.customXml.parts.remove"], params, options),
1031
1039
  },
1032
1040
  },
1041
+ metadata: {
1042
+ attach: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.attach"], params, options),
1043
+ list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.list"], params, options),
1044
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.get"], params, options),
1045
+ update: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.update"], params, options),
1046
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.remove"], params, options),
1047
+ resolve: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.metadata.resolve"], params, options),
1048
+ },
1033
1049
  save: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.save"], params, options),
1034
1050
  close: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.close"], params, options),
1035
1051
  insertTab: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.insertTab"], params, options),
@@ -9942,6 +9942,114 @@ export interface DocCustomXmlPartsRemoveParams {
9942
9942
  partName: string;
9943
9943
  });
9944
9944
  }
9945
+ export interface DocMetadataAttachParams {
9946
+ doc?: string;
9947
+ sessionId?: string;
9948
+ out?: string;
9949
+ force?: boolean;
9950
+ expectedRevision?: number;
9951
+ changeMode?: string;
9952
+ dryRun?: boolean;
9953
+ target: {
9954
+ kind: "selection";
9955
+ start: ({
9956
+ kind: "text";
9957
+ blockId: string;
9958
+ offset: number;
9959
+ }) | ({
9960
+ kind: "nodeEdge";
9961
+ node: {
9962
+ kind: "block";
9963
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
9964
+ nodeId: string;
9965
+ };
9966
+ edge: "before" | "after";
9967
+ });
9968
+ end: ({
9969
+ kind: "text";
9970
+ blockId: string;
9971
+ offset: number;
9972
+ }) | ({
9973
+ kind: "nodeEdge";
9974
+ node: {
9975
+ kind: "block";
9976
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
9977
+ nodeId: string;
9978
+ };
9979
+ edge: "before" | "after";
9980
+ });
9981
+ };
9982
+ namespace: string;
9983
+ payload: unknown;
9984
+ id?: string;
9985
+ }
9986
+ export interface DocMetadataListParams {
9987
+ doc?: string;
9988
+ sessionId?: string;
9989
+ limit?: number;
9990
+ offset?: number;
9991
+ namespace?: string;
9992
+ within?: {
9993
+ kind: "selection";
9994
+ start: ({
9995
+ kind: "text";
9996
+ blockId: string;
9997
+ offset: number;
9998
+ }) | ({
9999
+ kind: "nodeEdge";
10000
+ node: {
10001
+ kind: "block";
10002
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10003
+ nodeId: string;
10004
+ };
10005
+ edge: "before" | "after";
10006
+ });
10007
+ end: ({
10008
+ kind: "text";
10009
+ blockId: string;
10010
+ offset: number;
10011
+ }) | ({
10012
+ kind: "nodeEdge";
10013
+ node: {
10014
+ kind: "block";
10015
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
10016
+ nodeId: string;
10017
+ };
10018
+ edge: "before" | "after";
10019
+ });
10020
+ };
10021
+ }
10022
+ export interface DocMetadataGetParams {
10023
+ doc?: string;
10024
+ sessionId?: string;
10025
+ id: string;
10026
+ }
10027
+ export interface DocMetadataUpdateParams {
10028
+ doc?: string;
10029
+ sessionId?: string;
10030
+ out?: string;
10031
+ force?: boolean;
10032
+ expectedRevision?: number;
10033
+ changeMode?: string;
10034
+ dryRun?: boolean;
10035
+ id: string;
10036
+ payload: unknown;
10037
+ }
10038
+ export interface DocMetadataRemoveParams {
10039
+ doc?: string;
10040
+ sessionId?: string;
10041
+ out?: string;
10042
+ force?: boolean;
10043
+ expectedRevision?: number;
10044
+ changeMode?: string;
10045
+ dryRun?: boolean;
10046
+ id: string;
10047
+ }
10048
+ export interface DocMetadataResolveParams {
10049
+ doc?: string;
10050
+ sessionId?: string;
10051
+ id: string;
10052
+ }
9945
10053
  export interface DocOpenParams {
9946
10054
  doc?: string;
9947
10055
  sessionId?: string;
@@ -22956,6 +23064,42 @@ export type DocCapabilitiesGetResult = {
22956
23064
  dryRun: boolean;
22957
23065
  reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
22958
23066
  };
23067
+ "metadata.attach": {
23068
+ available: boolean;
23069
+ tracked: boolean;
23070
+ dryRun: boolean;
23071
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23072
+ };
23073
+ "metadata.list": {
23074
+ available: boolean;
23075
+ tracked: boolean;
23076
+ dryRun: boolean;
23077
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23078
+ };
23079
+ "metadata.get": {
23080
+ available: boolean;
23081
+ tracked: boolean;
23082
+ dryRun: boolean;
23083
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23084
+ };
23085
+ "metadata.update": {
23086
+ available: boolean;
23087
+ tracked: boolean;
23088
+ dryRun: boolean;
23089
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23090
+ };
23091
+ "metadata.remove": {
23092
+ available: boolean;
23093
+ tracked: boolean;
23094
+ dryRun: boolean;
23095
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23096
+ };
23097
+ "metadata.resolve": {
23098
+ available: boolean;
23099
+ tracked: boolean;
23100
+ dryRun: boolean;
23101
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
23102
+ };
22959
23103
  };
22960
23104
  planEngine: {
22961
23105
  supportedStepOps: Array<string>;
@@ -26671,6 +26815,23 @@ export type DocCustomXmlPartsRemoveResult = {
26671
26815
  });
26672
26816
  id?: string;
26673
26817
  };
26818
+ export type DocMetadataAttachResult = {
26819
+ success: true;
26820
+ id: string;
26821
+ namespace: string;
26822
+ partName: string;
26823
+ };
26824
+ export type DocMetadataListResult = Record<string, unknown>;
26825
+ export type DocMetadataGetResult = Record<string, unknown> | null;
26826
+ export type DocMetadataUpdateResult = {
26827
+ success: true;
26828
+ id: string;
26829
+ };
26830
+ export type DocMetadataRemoveResult = {
26831
+ success: true;
26832
+ id: string;
26833
+ };
26834
+ export type DocMetadataResolveResult = Record<string, unknown> | null;
26674
26835
  export type DocOpenResult = {
26675
26836
  active: boolean;
26676
26837
  contextId: string;
@@ -35981,6 +36142,102 @@ export interface DocCustomXmlPartsRemoveBoundParams {
35981
36142
  partName: string;
35982
36143
  });
35983
36144
  }
36145
+ export interface DocMetadataAttachBoundParams {
36146
+ out?: string;
36147
+ force?: boolean;
36148
+ expectedRevision?: number;
36149
+ changeMode?: string;
36150
+ dryRun?: boolean;
36151
+ target: {
36152
+ kind: "selection";
36153
+ start: ({
36154
+ kind: "text";
36155
+ blockId: string;
36156
+ offset: number;
36157
+ }) | ({
36158
+ kind: "nodeEdge";
36159
+ node: {
36160
+ kind: "block";
36161
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
36162
+ nodeId: string;
36163
+ };
36164
+ edge: "before" | "after";
36165
+ });
36166
+ end: ({
36167
+ kind: "text";
36168
+ blockId: string;
36169
+ offset: number;
36170
+ }) | ({
36171
+ kind: "nodeEdge";
36172
+ node: {
36173
+ kind: "block";
36174
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
36175
+ nodeId: string;
36176
+ };
36177
+ edge: "before" | "after";
36178
+ });
36179
+ };
36180
+ namespace: string;
36181
+ payload: unknown;
36182
+ id?: string;
36183
+ }
36184
+ export interface DocMetadataListBoundParams {
36185
+ limit?: number;
36186
+ offset?: number;
36187
+ namespace?: string;
36188
+ within?: {
36189
+ kind: "selection";
36190
+ start: ({
36191
+ kind: "text";
36192
+ blockId: string;
36193
+ offset: number;
36194
+ }) | ({
36195
+ kind: "nodeEdge";
36196
+ node: {
36197
+ kind: "block";
36198
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
36199
+ nodeId: string;
36200
+ };
36201
+ edge: "before" | "after";
36202
+ });
36203
+ end: ({
36204
+ kind: "text";
36205
+ blockId: string;
36206
+ offset: number;
36207
+ }) | ({
36208
+ kind: "nodeEdge";
36209
+ node: {
36210
+ kind: "block";
36211
+ nodeType: "paragraph" | "heading" | "table" | "tableOfContents" | "sdt" | "image";
36212
+ nodeId: string;
36213
+ };
36214
+ edge: "before" | "after";
36215
+ });
36216
+ };
36217
+ }
36218
+ export interface DocMetadataGetBoundParams {
36219
+ id: string;
36220
+ }
36221
+ export interface DocMetadataUpdateBoundParams {
36222
+ out?: string;
36223
+ force?: boolean;
36224
+ expectedRevision?: number;
36225
+ changeMode?: string;
36226
+ dryRun?: boolean;
36227
+ id: string;
36228
+ payload: unknown;
36229
+ }
36230
+ export interface DocMetadataRemoveBoundParams {
36231
+ out?: string;
36232
+ force?: boolean;
36233
+ expectedRevision?: number;
36234
+ changeMode?: string;
36235
+ dryRun?: boolean;
36236
+ id: string;
36237
+ }
36238
+ export interface DocMetadataResolveBoundParams {
36239
+ id: string;
36240
+ }
35984
36241
  export interface DocSaveBoundParams {
35985
36242
  out?: string;
35986
36243
  force?: boolean;
@@ -36504,6 +36761,14 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
36504
36761
  remove: (params: DocCustomXmlPartsRemoveParams, options?: InvokeOptions) => Promise<DocCustomXmlPartsRemoveResult>;
36505
36762
  };
36506
36763
  };
36764
+ metadata: {
36765
+ attach: (params: DocMetadataAttachParams, options?: InvokeOptions) => Promise<DocMetadataAttachResult>;
36766
+ list: (params?: DocMetadataListParams, options?: InvokeOptions) => Promise<DocMetadataListResult>;
36767
+ get: (params: DocMetadataGetParams, options?: InvokeOptions) => Promise<DocMetadataGetResult>;
36768
+ update: (params: DocMetadataUpdateParams, options?: InvokeOptions) => Promise<DocMetadataUpdateResult>;
36769
+ remove: (params: DocMetadataRemoveParams, options?: InvokeOptions) => Promise<DocMetadataRemoveResult>;
36770
+ resolve: (params: DocMetadataResolveParams, options?: InvokeOptions) => Promise<DocMetadataResolveResult>;
36771
+ };
36507
36772
  open: (params?: DocOpenParams, options?: InvokeOptions) => Promise<DocOpenResult>;
36508
36773
  save: (params?: DocSaveParams, options?: InvokeOptions) => Promise<DocSaveResult>;
36509
36774
  close: (params?: DocCloseParams, options?: InvokeOptions) => Promise<DocCloseResult>;
@@ -37013,6 +37278,14 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
37013
37278
  remove: (params: DocCustomXmlPartsRemoveBoundParams, options?: InvokeOptions) => Promise<DocCustomXmlPartsRemoveResult>;
37014
37279
  };
37015
37280
  };
37281
+ metadata: {
37282
+ attach: (params: DocMetadataAttachBoundParams, options?: InvokeOptions) => Promise<DocMetadataAttachResult>;
37283
+ list: (params?: DocMetadataListBoundParams, options?: InvokeOptions) => Promise<DocMetadataListResult>;
37284
+ get: (params: DocMetadataGetBoundParams, options?: InvokeOptions) => Promise<DocMetadataGetResult>;
37285
+ update: (params: DocMetadataUpdateBoundParams, options?: InvokeOptions) => Promise<DocMetadataUpdateResult>;
37286
+ remove: (params: DocMetadataRemoveBoundParams, options?: InvokeOptions) => Promise<DocMetadataRemoveResult>;
37287
+ resolve: (params: DocMetadataResolveBoundParams, options?: InvokeOptions) => Promise<DocMetadataResolveResult>;
37288
+ };
37016
37289
  save: (params?: DocSaveBoundParams, options?: InvokeOptions) => Promise<DocSaveResult>;
37017
37290
  close: (params?: DocCloseBoundParams, options?: InvokeOptions) => Promise<DocCloseResult>;
37018
37291
  insertTab: (params?: DocInsertTabBoundParams, options?: InvokeOptions) => Promise<DocInsertTabResult>;