@uniformdev/canvas 18.33.0 → 18.33.1-alpha.7
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.
- package/dist/index.d.ts +318 -356
- package/dist/index.esm.js +3 -11
- package/dist/index.js +3 -11
- package/dist/index.mjs +3 -11
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -148,8 +148,10 @@ interface components$2 {
|
|
148
148
|
connectedData?: components$2["schemas"]["DataElementConnectionDefinition"];
|
149
149
|
};
|
150
150
|
/**
|
151
|
-
* @
|
152
|
-
*
|
151
|
+
* @description Defines a connection to a data element on a data resource.
|
152
|
+
*
|
153
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
154
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
153
155
|
*/
|
154
156
|
DataElementConnectionDefinition: {
|
155
157
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -192,7 +194,6 @@ interface components$2 {
|
|
192
194
|
_pattern?: string;
|
193
195
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
194
196
|
/**
|
195
|
-
* @deprecated
|
196
197
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
197
198
|
* Means nothing for PUTs; it will be ignored.
|
198
199
|
*/
|
@@ -209,20 +210,26 @@ interface components$2 {
|
|
209
210
|
*/
|
210
211
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
211
212
|
/**
|
212
|
-
* @
|
213
|
-
*
|
214
|
-
*
|
215
|
-
*
|
216
|
-
*
|
213
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
214
|
+
* This can be used to override parameters that are defined on patterns,
|
215
|
+
* including nested patterns, with values that are specific to this composition.
|
216
|
+
* The keys in this object are component IDs.
|
217
|
+
* Overrides are applied from the top down, so for example if both the composition
|
218
|
+
* and a pattern on the composition define an override on a nested pattern,
|
219
|
+
* the composition's override replaces the pattern's.
|
220
|
+
*
|
221
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
222
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
217
223
|
*/
|
218
224
|
_overrides?: {
|
219
225
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
220
226
|
};
|
221
227
|
/**
|
222
|
-
* @
|
223
|
-
* @description Experimental functionality subject to change without notice.
|
224
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
228
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
225
229
|
* by consumers of the pattern.
|
230
|
+
*
|
231
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
232
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
226
233
|
*/
|
227
234
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
228
235
|
};
|
@@ -250,31 +257,34 @@ interface components$2 {
|
|
250
257
|
_name: string;
|
251
258
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
252
259
|
/**
|
253
|
-
* @
|
254
|
-
* @description Experimental functionality subject to change without notice.
|
255
|
-
* Defines patch overrides to component IDs that live in the composition.
|
260
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
256
261
|
* This can be used to override parameters that are defined on patterns,
|
257
262
|
* including nested patterns, with values that are specific to this composition.
|
258
263
|
* The keys in this object are component IDs.
|
259
264
|
* Overrides are applied from the top down, so for example if both the composition
|
260
265
|
* and a pattern on the composition define an override on a nested pattern,
|
261
266
|
* the composition's override replaces the pattern's.
|
267
|
+
*
|
268
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
269
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
262
270
|
*/
|
263
271
|
_overrides?: {
|
264
272
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
265
273
|
};
|
266
274
|
/**
|
267
|
-
* @
|
268
|
-
* @description Experimental functionality subject to change without notice.
|
269
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
275
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
270
276
|
* by consumers of the pattern.
|
277
|
+
*
|
278
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
279
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
271
280
|
*/
|
272
281
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
273
282
|
};
|
274
283
|
/**
|
275
|
-
* @
|
276
|
-
*
|
277
|
-
*
|
284
|
+
* @description Defines how to override a specific component.
|
285
|
+
*
|
286
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
287
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
278
288
|
*/
|
279
289
|
ComponentOverride: {
|
280
290
|
parameters?: {
|
@@ -283,10 +293,11 @@ interface components$2 {
|
|
283
293
|
variant?: string;
|
284
294
|
};
|
285
295
|
/**
|
286
|
-
* @
|
287
|
-
*
|
288
|
-
*
|
289
|
-
* NOTE:
|
296
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
297
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
298
|
+
*
|
299
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
300
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
290
301
|
*/
|
291
302
|
ComponentOverridability: {
|
292
303
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -297,13 +308,15 @@ interface components$2 {
|
|
297
308
|
variants?: boolean;
|
298
309
|
};
|
299
310
|
/**
|
300
|
-
* @
|
301
|
-
*
|
311
|
+
* @description Whether a parameter is overridable
|
312
|
+
*
|
313
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
314
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
315
|
+
*
|
302
316
|
* @enum {string}
|
303
317
|
*/
|
304
318
|
OverrideOptions: "yes" | "no";
|
305
319
|
/**
|
306
|
-
* @deprecated
|
307
320
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
308
321
|
* These are created in the UI and shared across a whole project.
|
309
322
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -337,10 +350,7 @@ interface components$2 {
|
|
337
350
|
[key: string]: unknown;
|
338
351
|
};
|
339
352
|
};
|
340
|
-
/**
|
341
|
-
* @deprecated
|
342
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
343
|
-
*/
|
353
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
344
354
|
DataType: {
|
345
355
|
/** @description Public ID of the data type */
|
346
356
|
id: string;
|
@@ -397,10 +407,7 @@ interface components$2 {
|
|
397
407
|
[key: string]: unknown;
|
398
408
|
};
|
399
409
|
};
|
400
|
-
/**
|
401
|
-
* @deprecated
|
402
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
403
|
-
*/
|
410
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
404
411
|
DataVariableDefinition: {
|
405
412
|
/** @description Display name of the data variable */
|
406
413
|
displayName?: string;
|
@@ -417,17 +424,13 @@ interface components$2 {
|
|
417
424
|
order?: number;
|
418
425
|
};
|
419
426
|
/**
|
420
|
-
* @deprecated
|
421
427
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
422
428
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
423
429
|
*/
|
424
430
|
DataResourceDefinitions: {
|
425
431
|
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
426
432
|
};
|
427
|
-
/**
|
428
|
-
* @deprecated
|
429
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
430
|
-
*/
|
433
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
431
434
|
DataResourceDefinition: {
|
432
435
|
/** @description Public ID of the data type that provides this data */
|
433
436
|
type: string;
|
@@ -441,10 +444,7 @@ interface components$2 {
|
|
441
444
|
ignorePatternParameterDefault?: boolean;
|
442
445
|
variables?: components$2["schemas"]["DataResourceVariables"];
|
443
446
|
};
|
444
|
-
/**
|
445
|
-
* @deprecated
|
446
|
-
* @description Variable values for a data resource.
|
447
|
-
*/
|
447
|
+
/** @description Variable values for a data resource. */
|
448
448
|
DataResourceVariables: {
|
449
449
|
[key: string]: string;
|
450
450
|
};
|
@@ -750,8 +750,10 @@ interface external$5 {
|
|
750
750
|
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
751
751
|
};
|
752
752
|
/**
|
753
|
-
* @
|
754
|
-
*
|
753
|
+
* @description Defines a connection to a data element on a data resource.
|
754
|
+
*
|
755
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
756
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
755
757
|
*/
|
756
758
|
DataElementConnectionDefinition: {
|
757
759
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -794,7 +796,6 @@ interface external$5 {
|
|
794
796
|
_pattern?: string;
|
795
797
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
796
798
|
/**
|
797
|
-
* @deprecated
|
798
799
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
799
800
|
* Means nothing for PUTs; it will be ignored.
|
800
801
|
*/
|
@@ -811,20 +812,26 @@ interface external$5 {
|
|
811
812
|
*/
|
812
813
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
813
814
|
/**
|
814
|
-
* @
|
815
|
-
*
|
816
|
-
*
|
817
|
-
*
|
818
|
-
*
|
815
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
816
|
+
* This can be used to override parameters that are defined on patterns,
|
817
|
+
* including nested patterns, with values that are specific to this composition.
|
818
|
+
* The keys in this object are component IDs.
|
819
|
+
* Overrides are applied from the top down, so for example if both the composition
|
820
|
+
* and a pattern on the composition define an override on a nested pattern,
|
821
|
+
* the composition's override replaces the pattern's.
|
822
|
+
*
|
823
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
824
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
819
825
|
*/
|
820
826
|
_overrides?: {
|
821
827
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
822
828
|
};
|
823
829
|
/**
|
824
|
-
* @
|
825
|
-
* @description Experimental functionality subject to change without notice.
|
826
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
830
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
827
831
|
* by consumers of the pattern.
|
832
|
+
*
|
833
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
834
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
828
835
|
*/
|
829
836
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
830
837
|
};
|
@@ -852,31 +859,34 @@ interface external$5 {
|
|
852
859
|
_name: string;
|
853
860
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
854
861
|
/**
|
855
|
-
* @
|
856
|
-
* @description Experimental functionality subject to change without notice.
|
857
|
-
* Defines patch overrides to component IDs that live in the composition.
|
862
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
858
863
|
* This can be used to override parameters that are defined on patterns,
|
859
864
|
* including nested patterns, with values that are specific to this composition.
|
860
865
|
* The keys in this object are component IDs.
|
861
866
|
* Overrides are applied from the top down, so for example if both the composition
|
862
867
|
* and a pattern on the composition define an override on a nested pattern,
|
863
868
|
* the composition's override replaces the pattern's.
|
869
|
+
*
|
870
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
871
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
864
872
|
*/
|
865
873
|
_overrides?: {
|
866
874
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
867
875
|
};
|
868
876
|
/**
|
869
|
-
* @
|
870
|
-
* @description Experimental functionality subject to change without notice.
|
871
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
877
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
872
878
|
* by consumers of the pattern.
|
879
|
+
*
|
880
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
881
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
873
882
|
*/
|
874
883
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
875
884
|
};
|
876
885
|
/**
|
877
|
-
* @
|
878
|
-
*
|
879
|
-
*
|
886
|
+
* @description Defines how to override a specific component.
|
887
|
+
*
|
888
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
889
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
880
890
|
*/
|
881
891
|
ComponentOverride: {
|
882
892
|
parameters?: {
|
@@ -885,10 +895,11 @@ interface external$5 {
|
|
885
895
|
variant?: string;
|
886
896
|
};
|
887
897
|
/**
|
888
|
-
* @
|
889
|
-
*
|
890
|
-
*
|
891
|
-
* NOTE:
|
898
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
899
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
900
|
+
*
|
901
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
902
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
892
903
|
*/
|
893
904
|
ComponentOverridability: {
|
894
905
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -899,13 +910,15 @@ interface external$5 {
|
|
899
910
|
variants?: boolean;
|
900
911
|
};
|
901
912
|
/**
|
902
|
-
* @
|
903
|
-
*
|
913
|
+
* @description Whether a parameter is overridable
|
914
|
+
*
|
915
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
916
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
917
|
+
*
|
904
918
|
* @enum {string}
|
905
919
|
*/
|
906
920
|
OverrideOptions: "yes" | "no";
|
907
921
|
/**
|
908
|
-
* @deprecated
|
909
922
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
910
923
|
* These are created in the UI and shared across a whole project.
|
911
924
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -939,10 +952,7 @@ interface external$5 {
|
|
939
952
|
[key: string]: unknown;
|
940
953
|
};
|
941
954
|
};
|
942
|
-
/**
|
943
|
-
* @deprecated
|
944
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
945
|
-
*/
|
955
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
946
956
|
DataType: {
|
947
957
|
/** @description Public ID of the data type */
|
948
958
|
id: string;
|
@@ -999,10 +1009,7 @@ interface external$5 {
|
|
999
1009
|
[key: string]: unknown;
|
1000
1010
|
};
|
1001
1011
|
};
|
1002
|
-
/**
|
1003
|
-
* @deprecated
|
1004
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1005
|
-
*/
|
1012
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
1006
1013
|
DataVariableDefinition: {
|
1007
1014
|
/** @description Display name of the data variable */
|
1008
1015
|
displayName?: string;
|
@@ -1019,17 +1026,13 @@ interface external$5 {
|
|
1019
1026
|
order?: number;
|
1020
1027
|
};
|
1021
1028
|
/**
|
1022
|
-
* @deprecated
|
1023
1029
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1024
1030
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1025
1031
|
*/
|
1026
1032
|
DataResourceDefinitions: {
|
1027
1033
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1028
1034
|
};
|
1029
|
-
/**
|
1030
|
-
* @deprecated
|
1031
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1032
|
-
*/
|
1035
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1033
1036
|
DataResourceDefinition: {
|
1034
1037
|
/** @description Public ID of the data type that provides this data */
|
1035
1038
|
type: string;
|
@@ -1043,10 +1046,7 @@ interface external$5 {
|
|
1043
1046
|
ignorePatternParameterDefault?: boolean;
|
1044
1047
|
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1045
1048
|
};
|
1046
|
-
/**
|
1047
|
-
* @deprecated
|
1048
|
-
* @description Variable values for a data resource.
|
1049
|
-
*/
|
1049
|
+
/** @description Variable values for a data resource. */
|
1050
1050
|
DataResourceVariables: {
|
1051
1051
|
[key: string]: string;
|
1052
1052
|
};
|
@@ -1081,14 +1081,6 @@ type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['
|
|
1081
1081
|
type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
|
1082
1082
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1083
1083
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
1084
|
-
/** @deprecated use ComponentDefinitionGetResponse instead */
|
1085
|
-
type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
|
1086
|
-
/** @deprecated use ComponentDefinitionPutParameters */
|
1087
|
-
type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
|
1088
|
-
/** @deprecated use ComponentDefinitionDeleteParameters */
|
1089
|
-
type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
|
1090
|
-
/** @deprecated use ComponentDefinitionGetParameters */
|
1091
|
-
type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
|
1092
1084
|
/** The definition of a component parameter */
|
1093
1085
|
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1094
1086
|
typeConfig?: TConfig;
|
@@ -1103,8 +1095,6 @@ type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
|
|
1103
1095
|
type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
|
1104
1096
|
/** Defines a component type that can live on a Composition */
|
1105
1097
|
type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
1106
|
-
/** @deprecated use ComponentDefinition instead */
|
1107
|
-
type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
|
1108
1098
|
|
1109
1099
|
/**
|
1110
1100
|
* This file was auto-generated by openapi-typescript.
|
@@ -1162,7 +1152,7 @@ interface paths$3 {
|
|
1162
1152
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
1163
1153
|
skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
|
1164
1154
|
/**
|
1165
|
-
*
|
1155
|
+
* If true, any pattern override data is not resolved by the API.
|
1166
1156
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1167
1157
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
1168
1158
|
*/
|
@@ -1371,7 +1361,6 @@ interface components$1 {
|
|
1371
1361
|
*/
|
1372
1362
|
skipPatternResolution: boolean;
|
1373
1363
|
/**
|
1374
|
-
* @deprecated
|
1375
1364
|
* @description If true, any pattern override data is not resolved by the API.
|
1376
1365
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1377
1366
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -1616,8 +1605,10 @@ interface external$4 {
|
|
1616
1605
|
connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1617
1606
|
};
|
1618
1607
|
/**
|
1619
|
-
* @
|
1620
|
-
*
|
1608
|
+
* @description Defines a connection to a data element on a data resource.
|
1609
|
+
*
|
1610
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1611
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
1621
1612
|
*/
|
1622
1613
|
DataElementConnectionDefinition: {
|
1623
1614
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -1660,7 +1651,6 @@ interface external$4 {
|
|
1660
1651
|
_pattern?: string;
|
1661
1652
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1662
1653
|
/**
|
1663
|
-
* @deprecated
|
1664
1654
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1665
1655
|
* Means nothing for PUTs; it will be ignored.
|
1666
1656
|
*/
|
@@ -1677,20 +1667,26 @@ interface external$4 {
|
|
1677
1667
|
*/
|
1678
1668
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
1679
1669
|
/**
|
1680
|
-
* @
|
1681
|
-
*
|
1682
|
-
*
|
1683
|
-
*
|
1684
|
-
*
|
1670
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1671
|
+
* This can be used to override parameters that are defined on patterns,
|
1672
|
+
* including nested patterns, with values that are specific to this composition.
|
1673
|
+
* The keys in this object are component IDs.
|
1674
|
+
* Overrides are applied from the top down, so for example if both the composition
|
1675
|
+
* and a pattern on the composition define an override on a nested pattern,
|
1676
|
+
* the composition's override replaces the pattern's.
|
1677
|
+
*
|
1678
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1679
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1685
1680
|
*/
|
1686
1681
|
_overrides?: {
|
1687
1682
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1688
1683
|
};
|
1689
1684
|
/**
|
1690
|
-
* @
|
1691
|
-
* @description Experimental functionality subject to change without notice.
|
1692
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1685
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1693
1686
|
* by consumers of the pattern.
|
1687
|
+
*
|
1688
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1689
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1694
1690
|
*/
|
1695
1691
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1696
1692
|
};
|
@@ -1718,31 +1714,34 @@ interface external$4 {
|
|
1718
1714
|
_name: string;
|
1719
1715
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1720
1716
|
/**
|
1721
|
-
* @
|
1722
|
-
* @description Experimental functionality subject to change without notice.
|
1723
|
-
* Defines patch overrides to component IDs that live in the composition.
|
1717
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1724
1718
|
* This can be used to override parameters that are defined on patterns,
|
1725
1719
|
* including nested patterns, with values that are specific to this composition.
|
1726
1720
|
* The keys in this object are component IDs.
|
1727
1721
|
* Overrides are applied from the top down, so for example if both the composition
|
1728
1722
|
* and a pattern on the composition define an override on a nested pattern,
|
1729
1723
|
* the composition's override replaces the pattern's.
|
1724
|
+
*
|
1725
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1726
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1730
1727
|
*/
|
1731
1728
|
_overrides?: {
|
1732
1729
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1733
1730
|
};
|
1734
1731
|
/**
|
1735
|
-
* @
|
1736
|
-
* @description Experimental functionality subject to change without notice.
|
1737
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1732
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1738
1733
|
* by consumers of the pattern.
|
1734
|
+
*
|
1735
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1736
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1739
1737
|
*/
|
1740
1738
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1741
1739
|
};
|
1742
1740
|
/**
|
1743
|
-
* @
|
1744
|
-
*
|
1745
|
-
*
|
1741
|
+
* @description Defines how to override a specific component.
|
1742
|
+
*
|
1743
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1744
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1746
1745
|
*/
|
1747
1746
|
ComponentOverride: {
|
1748
1747
|
parameters?: {
|
@@ -1751,10 +1750,11 @@ interface external$4 {
|
|
1751
1750
|
variant?: string;
|
1752
1751
|
};
|
1753
1752
|
/**
|
1754
|
-
* @
|
1755
|
-
*
|
1756
|
-
*
|
1757
|
-
* NOTE:
|
1753
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
1754
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
1755
|
+
*
|
1756
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1757
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1758
1758
|
*/
|
1759
1759
|
ComponentOverridability: {
|
1760
1760
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -1765,13 +1765,15 @@ interface external$4 {
|
|
1765
1765
|
variants?: boolean;
|
1766
1766
|
};
|
1767
1767
|
/**
|
1768
|
-
* @
|
1769
|
-
*
|
1768
|
+
* @description Whether a parameter is overridable
|
1769
|
+
*
|
1770
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1771
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1772
|
+
*
|
1770
1773
|
* @enum {string}
|
1771
1774
|
*/
|
1772
1775
|
OverrideOptions: "yes" | "no";
|
1773
1776
|
/**
|
1774
|
-
* @deprecated
|
1775
1777
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
1776
1778
|
* These are created in the UI and shared across a whole project.
|
1777
1779
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -1805,10 +1807,7 @@ interface external$4 {
|
|
1805
1807
|
[key: string]: unknown;
|
1806
1808
|
};
|
1807
1809
|
};
|
1808
|
-
/**
|
1809
|
-
* @deprecated
|
1810
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
1811
|
-
*/
|
1810
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
1812
1811
|
DataType: {
|
1813
1812
|
/** @description Public ID of the data type */
|
1814
1813
|
id: string;
|
@@ -1865,10 +1864,7 @@ interface external$4 {
|
|
1865
1864
|
[key: string]: unknown;
|
1866
1865
|
};
|
1867
1866
|
};
|
1868
|
-
/**
|
1869
|
-
* @deprecated
|
1870
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1871
|
-
*/
|
1867
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
1872
1868
|
DataVariableDefinition: {
|
1873
1869
|
/** @description Display name of the data variable */
|
1874
1870
|
displayName?: string;
|
@@ -1885,17 +1881,13 @@ interface external$4 {
|
|
1885
1881
|
order?: number;
|
1886
1882
|
};
|
1887
1883
|
/**
|
1888
|
-
* @deprecated
|
1889
1884
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1890
1885
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1891
1886
|
*/
|
1892
1887
|
DataResourceDefinitions: {
|
1893
1888
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1894
1889
|
};
|
1895
|
-
/**
|
1896
|
-
* @deprecated
|
1897
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1898
|
-
*/
|
1890
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1899
1891
|
DataResourceDefinition: {
|
1900
1892
|
/** @description Public ID of the data type that provides this data */
|
1901
1893
|
type: string;
|
@@ -1909,10 +1901,7 @@ interface external$4 {
|
|
1909
1901
|
ignorePatternParameterDefault?: boolean;
|
1910
1902
|
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1911
1903
|
};
|
1912
|
-
/**
|
1913
|
-
* @deprecated
|
1914
|
-
* @description Variable values for a data resource.
|
1915
|
-
*/
|
1904
|
+
/** @description Variable values for a data resource. */
|
1916
1905
|
DataResourceVariables: {
|
1917
1906
|
[key: string]: string;
|
1918
1907
|
};
|
@@ -2267,8 +2256,10 @@ interface external$3 {
|
|
2267
2256
|
connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2268
2257
|
};
|
2269
2258
|
/**
|
2270
|
-
* @
|
2271
|
-
*
|
2259
|
+
* @description Defines a connection to a data element on a data resource.
|
2260
|
+
*
|
2261
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2262
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
2272
2263
|
*/
|
2273
2264
|
DataElementConnectionDefinition: {
|
2274
2265
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -2311,7 +2302,6 @@ interface external$3 {
|
|
2311
2302
|
_pattern?: string;
|
2312
2303
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2313
2304
|
/**
|
2314
|
-
* @deprecated
|
2315
2305
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2316
2306
|
* Means nothing for PUTs; it will be ignored.
|
2317
2307
|
*/
|
@@ -2328,20 +2318,26 @@ interface external$3 {
|
|
2328
2318
|
*/
|
2329
2319
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
2330
2320
|
/**
|
2331
|
-
* @
|
2332
|
-
*
|
2333
|
-
*
|
2334
|
-
*
|
2335
|
-
*
|
2321
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2322
|
+
* This can be used to override parameters that are defined on patterns,
|
2323
|
+
* including nested patterns, with values that are specific to this composition.
|
2324
|
+
* The keys in this object are component IDs.
|
2325
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2326
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2327
|
+
* the composition's override replaces the pattern's.
|
2328
|
+
*
|
2329
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2330
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2336
2331
|
*/
|
2337
2332
|
_overrides?: {
|
2338
2333
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2339
2334
|
};
|
2340
2335
|
/**
|
2341
|
-
* @
|
2342
|
-
* @description Experimental functionality subject to change without notice.
|
2343
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2336
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2344
2337
|
* by consumers of the pattern.
|
2338
|
+
*
|
2339
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2340
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2345
2341
|
*/
|
2346
2342
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2347
2343
|
};
|
@@ -2369,31 +2365,34 @@ interface external$3 {
|
|
2369
2365
|
_name: string;
|
2370
2366
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2371
2367
|
/**
|
2372
|
-
* @
|
2373
|
-
* @description Experimental functionality subject to change without notice.
|
2374
|
-
* Defines patch overrides to component IDs that live in the composition.
|
2368
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2375
2369
|
* This can be used to override parameters that are defined on patterns,
|
2376
2370
|
* including nested patterns, with values that are specific to this composition.
|
2377
2371
|
* The keys in this object are component IDs.
|
2378
2372
|
* Overrides are applied from the top down, so for example if both the composition
|
2379
2373
|
* and a pattern on the composition define an override on a nested pattern,
|
2380
2374
|
* the composition's override replaces the pattern's.
|
2375
|
+
*
|
2376
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2377
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2381
2378
|
*/
|
2382
2379
|
_overrides?: {
|
2383
2380
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2384
2381
|
};
|
2385
2382
|
/**
|
2386
|
-
* @
|
2387
|
-
* @description Experimental functionality subject to change without notice.
|
2388
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2383
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2389
2384
|
* by consumers of the pattern.
|
2385
|
+
*
|
2386
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2387
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2390
2388
|
*/
|
2391
2389
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2392
2390
|
};
|
2393
2391
|
/**
|
2394
|
-
* @
|
2395
|
-
*
|
2396
|
-
*
|
2392
|
+
* @description Defines how to override a specific component.
|
2393
|
+
*
|
2394
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2395
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2397
2396
|
*/
|
2398
2397
|
ComponentOverride: {
|
2399
2398
|
parameters?: {
|
@@ -2402,10 +2401,11 @@ interface external$3 {
|
|
2402
2401
|
variant?: string;
|
2403
2402
|
};
|
2404
2403
|
/**
|
2405
|
-
* @
|
2406
|
-
*
|
2407
|
-
*
|
2408
|
-
* NOTE:
|
2404
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
2405
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
2406
|
+
*
|
2407
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2408
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2409
2409
|
*/
|
2410
2410
|
ComponentOverridability: {
|
2411
2411
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -2416,13 +2416,15 @@ interface external$3 {
|
|
2416
2416
|
variants?: boolean;
|
2417
2417
|
};
|
2418
2418
|
/**
|
2419
|
-
* @
|
2420
|
-
*
|
2419
|
+
* @description Whether a parameter is overridable
|
2420
|
+
*
|
2421
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2422
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2423
|
+
*
|
2421
2424
|
* @enum {string}
|
2422
2425
|
*/
|
2423
2426
|
OverrideOptions: "yes" | "no";
|
2424
2427
|
/**
|
2425
|
-
* @deprecated
|
2426
2428
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
2427
2429
|
* These are created in the UI and shared across a whole project.
|
2428
2430
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -2456,10 +2458,7 @@ interface external$3 {
|
|
2456
2458
|
[key: string]: unknown;
|
2457
2459
|
};
|
2458
2460
|
};
|
2459
|
-
/**
|
2460
|
-
* @deprecated
|
2461
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
2462
|
-
*/
|
2461
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
2463
2462
|
DataType: {
|
2464
2463
|
/** @description Public ID of the data type */
|
2465
2464
|
id: string;
|
@@ -2516,10 +2515,7 @@ interface external$3 {
|
|
2516
2515
|
[key: string]: unknown;
|
2517
2516
|
};
|
2518
2517
|
};
|
2519
|
-
/**
|
2520
|
-
* @deprecated
|
2521
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2522
|
-
*/
|
2518
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
2523
2519
|
DataVariableDefinition: {
|
2524
2520
|
/** @description Display name of the data variable */
|
2525
2521
|
displayName?: string;
|
@@ -2536,17 +2532,13 @@ interface external$3 {
|
|
2536
2532
|
order?: number;
|
2537
2533
|
};
|
2538
2534
|
/**
|
2539
|
-
* @deprecated
|
2540
2535
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2541
2536
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2542
2537
|
*/
|
2543
2538
|
DataResourceDefinitions: {
|
2544
2539
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2545
2540
|
};
|
2546
|
-
/**
|
2547
|
-
* @deprecated
|
2548
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2549
|
-
*/
|
2541
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2550
2542
|
DataResourceDefinition: {
|
2551
2543
|
/** @description Public ID of the data type that provides this data */
|
2552
2544
|
type: string;
|
@@ -2560,10 +2552,7 @@ interface external$3 {
|
|
2560
2552
|
ignorePatternParameterDefault?: boolean;
|
2561
2553
|
variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2562
2554
|
};
|
2563
|
-
/**
|
2564
|
-
* @deprecated
|
2565
|
-
* @description Variable values for a data resource.
|
2566
|
-
*/
|
2555
|
+
/** @description Variable values for a data resource. */
|
2567
2556
|
DataResourceVariables: {
|
2568
2557
|
[key: string]: string;
|
2569
2558
|
};
|
@@ -2639,7 +2628,7 @@ interface external$3 {
|
|
2639
2628
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2640
2629
|
skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2641
2630
|
/**
|
2642
|
-
*
|
2631
|
+
* If true, any pattern override data is not resolved by the API.
|
2643
2632
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2644
2633
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2645
2634
|
*/
|
@@ -2848,7 +2837,6 @@ interface external$3 {
|
|
2848
2837
|
*/
|
2849
2838
|
skipPatternResolution: boolean;
|
2850
2839
|
/**
|
2851
|
-
* @deprecated
|
2852
2840
|
* @description If true, any pattern override data is not resolved by the API.
|
2853
2841
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2854
2842
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -2927,14 +2915,6 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
|
|
2927
2915
|
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2928
2916
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2929
2917
|
type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
|
2930
|
-
/** @deprecated use CompositionGetResponse */
|
2931
|
-
type CompositionAPIResponse = CompositionGetResponse;
|
2932
|
-
/** @deprecated use CompositionDeleteParameters */
|
2933
|
-
type CompositionAPIDeleteRequest = CompositionDeleteParameters;
|
2934
|
-
/** @deprecated use CompositionGetParameters */
|
2935
|
-
type CompositionListAPIResponse = CompositionGetListResponse;
|
2936
|
-
/** @deprecated use CompositionGetParameters */
|
2937
|
-
type CompositionAPIOptions = CompositionGetParameters;
|
2938
2918
|
/** Defines an editable parameter on a component. */
|
2939
2919
|
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2940
2920
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
@@ -2960,22 +2940,18 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
|
2960
2940
|
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2961
2941
|
/**
|
2962
2942
|
* Defines the shape of a component override
|
2963
|
-
* @deprecated
|
2964
2943
|
*/
|
2965
2944
|
type OverrideOptions = SharedComponents['OverrideOptions'];
|
2966
2945
|
/**
|
2967
2946
|
* Defines the shape of a component override
|
2968
|
-
* @deprecated
|
2969
2947
|
*/
|
2970
2948
|
type ComponentOverride = SharedComponents['ComponentOverride'];
|
2971
2949
|
/**
|
2972
2950
|
* Defines a set of component overrides by component ID
|
2973
|
-
* @deprecated
|
2974
2951
|
*/
|
2975
2952
|
type ComponentOverrides = Record<string, ComponentOverride>;
|
2976
2953
|
/**
|
2977
2954
|
* Defines how a component on a pattern may have its values overridden
|
2978
|
-
* @deprecated
|
2979
2955
|
*/
|
2980
2956
|
type ComponentOverridability = SharedComponents['ComponentOverridability'];
|
2981
2957
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
@@ -2997,20 +2973,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
|
2997
2973
|
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2998
2974
|
/** Switches for data resolution */
|
2999
2975
|
type DataResolutionOption = {
|
3000
|
-
|
2976
|
+
skipDataResolution?: boolean;
|
3001
2977
|
};
|
3002
2978
|
type DataResolutionOptionNegative = {
|
3003
|
-
|
2979
|
+
skipDataResolution: true;
|
3004
2980
|
};
|
3005
2981
|
type DataResolutionOptionPositive = {
|
3006
|
-
|
2982
|
+
skipDataResolution?: false;
|
3007
2983
|
};
|
3008
2984
|
type DataResolutionParameters = {
|
3009
2985
|
/**
|
3010
2986
|
* Adds additional diagnostics about edge request processing to the response (`diagnostics`).
|
3011
2987
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
3012
2988
|
*/
|
3013
|
-
|
2989
|
+
diagnostics?: boolean;
|
3014
2990
|
/**
|
3015
2991
|
* Pass dynamic variables to the composition that are required for resolving bindings and datas,
|
3016
2992
|
* such as language, detail page ID, etc.
|
@@ -3220,14 +3196,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3220
3196
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3221
3197
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3222
3198
|
getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3223
|
-
/** @deprecated use getCompositionByNodePath instead */
|
3224
|
-
unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3225
3199
|
/** Fetches one composition by its project map node ID */
|
3226
3200
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3227
3201
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3228
3202
|
getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3229
|
-
/** @deprecated Use getCompositionByNodeId instead */
|
3230
|
-
unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3231
3203
|
/** Fetches one composition by its slug */
|
3232
3204
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3233
3205
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
@@ -3403,14 +3375,8 @@ interface paths$2 {
|
|
3403
3375
|
data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
3404
3376
|
/** Format: uuid */
|
3405
3377
|
projectId: string;
|
3406
|
-
/**
|
3407
|
-
* Format: uuid
|
3408
|
-
* @deprecated
|
3409
|
-
* @description Do not use. Will be removed in future.
|
3410
|
-
*/
|
3411
|
-
integrationId?: string;
|
3412
3378
|
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
3413
|
-
integrationType
|
3379
|
+
integrationType: string;
|
3414
3380
|
};
|
3415
3381
|
};
|
3416
3382
|
};
|
@@ -3625,8 +3591,10 @@ interface external$2 {
|
|
3625
3591
|
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3626
3592
|
};
|
3627
3593
|
/**
|
3628
|
-
* @
|
3629
|
-
*
|
3594
|
+
* @description Defines a connection to a data element on a data resource.
|
3595
|
+
*
|
3596
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3597
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
3630
3598
|
*/
|
3631
3599
|
DataElementConnectionDefinition: {
|
3632
3600
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -3669,7 +3637,6 @@ interface external$2 {
|
|
3669
3637
|
_pattern?: string;
|
3670
3638
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3671
3639
|
/**
|
3672
|
-
* @deprecated
|
3673
3640
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3674
3641
|
* Means nothing for PUTs; it will be ignored.
|
3675
3642
|
*/
|
@@ -3686,20 +3653,26 @@ interface external$2 {
|
|
3686
3653
|
*/
|
3687
3654
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
3688
3655
|
/**
|
3689
|
-
* @
|
3690
|
-
*
|
3691
|
-
*
|
3692
|
-
*
|
3693
|
-
*
|
3656
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3657
|
+
* This can be used to override parameters that are defined on patterns,
|
3658
|
+
* including nested patterns, with values that are specific to this composition.
|
3659
|
+
* The keys in this object are component IDs.
|
3660
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3661
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3662
|
+
* the composition's override replaces the pattern's.
|
3663
|
+
*
|
3664
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3665
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3694
3666
|
*/
|
3695
3667
|
_overrides?: {
|
3696
3668
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3697
3669
|
};
|
3698
3670
|
/**
|
3699
|
-
* @
|
3700
|
-
* @description Experimental functionality subject to change without notice.
|
3701
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3671
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3702
3672
|
* by consumers of the pattern.
|
3673
|
+
*
|
3674
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3675
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3703
3676
|
*/
|
3704
3677
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3705
3678
|
};
|
@@ -3727,31 +3700,34 @@ interface external$2 {
|
|
3727
3700
|
_name: string;
|
3728
3701
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3729
3702
|
/**
|
3730
|
-
* @
|
3731
|
-
* @description Experimental functionality subject to change without notice.
|
3732
|
-
* Defines patch overrides to component IDs that live in the composition.
|
3703
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3733
3704
|
* This can be used to override parameters that are defined on patterns,
|
3734
3705
|
* including nested patterns, with values that are specific to this composition.
|
3735
3706
|
* The keys in this object are component IDs.
|
3736
3707
|
* Overrides are applied from the top down, so for example if both the composition
|
3737
3708
|
* and a pattern on the composition define an override on a nested pattern,
|
3738
3709
|
* the composition's override replaces the pattern's.
|
3710
|
+
*
|
3711
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3712
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3739
3713
|
*/
|
3740
3714
|
_overrides?: {
|
3741
3715
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3742
3716
|
};
|
3743
3717
|
/**
|
3744
|
-
* @
|
3745
|
-
* @description Experimental functionality subject to change without notice.
|
3746
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3718
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3747
3719
|
* by consumers of the pattern.
|
3720
|
+
*
|
3721
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3722
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3748
3723
|
*/
|
3749
3724
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3750
3725
|
};
|
3751
3726
|
/**
|
3752
|
-
* @
|
3753
|
-
*
|
3754
|
-
*
|
3727
|
+
* @description Defines how to override a specific component.
|
3728
|
+
*
|
3729
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3730
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3755
3731
|
*/
|
3756
3732
|
ComponentOverride: {
|
3757
3733
|
parameters?: {
|
@@ -3760,10 +3736,11 @@ interface external$2 {
|
|
3760
3736
|
variant?: string;
|
3761
3737
|
};
|
3762
3738
|
/**
|
3763
|
-
* @
|
3764
|
-
*
|
3765
|
-
*
|
3766
|
-
* NOTE:
|
3739
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
3740
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
3741
|
+
*
|
3742
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3743
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3767
3744
|
*/
|
3768
3745
|
ComponentOverridability: {
|
3769
3746
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -3774,13 +3751,15 @@ interface external$2 {
|
|
3774
3751
|
variants?: boolean;
|
3775
3752
|
};
|
3776
3753
|
/**
|
3777
|
-
* @
|
3778
|
-
*
|
3754
|
+
* @description Whether a parameter is overridable
|
3755
|
+
*
|
3756
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3757
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3758
|
+
*
|
3779
3759
|
* @enum {string}
|
3780
3760
|
*/
|
3781
3761
|
OverrideOptions: "yes" | "no";
|
3782
3762
|
/**
|
3783
|
-
* @deprecated
|
3784
3763
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
3785
3764
|
* These are created in the UI and shared across a whole project.
|
3786
3765
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -3814,10 +3793,7 @@ interface external$2 {
|
|
3814
3793
|
[key: string]: unknown;
|
3815
3794
|
};
|
3816
3795
|
};
|
3817
|
-
/**
|
3818
|
-
* @deprecated
|
3819
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
3820
|
-
*/
|
3796
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
3821
3797
|
DataType: {
|
3822
3798
|
/** @description Public ID of the data type */
|
3823
3799
|
id: string;
|
@@ -3874,10 +3850,7 @@ interface external$2 {
|
|
3874
3850
|
[key: string]: unknown;
|
3875
3851
|
};
|
3876
3852
|
};
|
3877
|
-
/**
|
3878
|
-
* @deprecated
|
3879
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
3880
|
-
*/
|
3853
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
3881
3854
|
DataVariableDefinition: {
|
3882
3855
|
/** @description Display name of the data variable */
|
3883
3856
|
displayName?: string;
|
@@ -3894,17 +3867,13 @@ interface external$2 {
|
|
3894
3867
|
order?: number;
|
3895
3868
|
};
|
3896
3869
|
/**
|
3897
|
-
* @deprecated
|
3898
3870
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
3899
3871
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3900
3872
|
*/
|
3901
3873
|
DataResourceDefinitions: {
|
3902
3874
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3903
3875
|
};
|
3904
|
-
/**
|
3905
|
-
* @deprecated
|
3906
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
3907
|
-
*/
|
3876
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3908
3877
|
DataResourceDefinition: {
|
3909
3878
|
/** @description Public ID of the data type that provides this data */
|
3910
3879
|
type: string;
|
@@ -3918,10 +3887,7 @@ interface external$2 {
|
|
3918
3887
|
ignorePatternParameterDefault?: boolean;
|
3919
3888
|
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3920
3889
|
};
|
3921
|
-
/**
|
3922
|
-
* @deprecated
|
3923
|
-
* @description Variable values for a data resource.
|
3924
|
-
*/
|
3890
|
+
/** @description Variable values for a data resource. */
|
3925
3891
|
DataResourceVariables: {
|
3926
3892
|
[key: string]: string;
|
3927
3893
|
};
|
@@ -4169,8 +4135,10 @@ interface external$1 {
|
|
4169
4135
|
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4170
4136
|
};
|
4171
4137
|
/**
|
4172
|
-
* @
|
4173
|
-
*
|
4138
|
+
* @description Defines a connection to a data element on a data resource.
|
4139
|
+
*
|
4140
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4141
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
4174
4142
|
*/
|
4175
4143
|
DataElementConnectionDefinition: {
|
4176
4144
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4213,7 +4181,6 @@ interface external$1 {
|
|
4213
4181
|
_pattern?: string;
|
4214
4182
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4215
4183
|
/**
|
4216
|
-
* @deprecated
|
4217
4184
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4218
4185
|
* Means nothing for PUTs; it will be ignored.
|
4219
4186
|
*/
|
@@ -4230,20 +4197,26 @@ interface external$1 {
|
|
4230
4197
|
*/
|
4231
4198
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4232
4199
|
/**
|
4233
|
-
* @
|
4234
|
-
*
|
4235
|
-
*
|
4236
|
-
*
|
4237
|
-
*
|
4200
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4201
|
+
* This can be used to override parameters that are defined on patterns,
|
4202
|
+
* including nested patterns, with values that are specific to this composition.
|
4203
|
+
* The keys in this object are component IDs.
|
4204
|
+
* Overrides are applied from the top down, so for example if both the composition
|
4205
|
+
* and a pattern on the composition define an override on a nested pattern,
|
4206
|
+
* the composition's override replaces the pattern's.
|
4207
|
+
*
|
4208
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4209
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4238
4210
|
*/
|
4239
4211
|
_overrides?: {
|
4240
4212
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4241
4213
|
};
|
4242
4214
|
/**
|
4243
|
-
* @
|
4244
|
-
* @description Experimental functionality subject to change without notice.
|
4245
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4215
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4246
4216
|
* by consumers of the pattern.
|
4217
|
+
*
|
4218
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4219
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4247
4220
|
*/
|
4248
4221
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4249
4222
|
};
|
@@ -4271,31 +4244,34 @@ interface external$1 {
|
|
4271
4244
|
_name: string;
|
4272
4245
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4273
4246
|
/**
|
4274
|
-
* @
|
4275
|
-
* @description Experimental functionality subject to change without notice.
|
4276
|
-
* Defines patch overrides to component IDs that live in the composition.
|
4247
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4277
4248
|
* This can be used to override parameters that are defined on patterns,
|
4278
4249
|
* including nested patterns, with values that are specific to this composition.
|
4279
4250
|
* The keys in this object are component IDs.
|
4280
4251
|
* Overrides are applied from the top down, so for example if both the composition
|
4281
4252
|
* and a pattern on the composition define an override on a nested pattern,
|
4282
4253
|
* the composition's override replaces the pattern's.
|
4254
|
+
*
|
4255
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4256
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4283
4257
|
*/
|
4284
4258
|
_overrides?: {
|
4285
4259
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4286
4260
|
};
|
4287
4261
|
/**
|
4288
|
-
* @
|
4289
|
-
* @description Experimental functionality subject to change without notice.
|
4290
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4262
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4291
4263
|
* by consumers of the pattern.
|
4264
|
+
*
|
4265
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4266
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4292
4267
|
*/
|
4293
4268
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4294
4269
|
};
|
4295
4270
|
/**
|
4296
|
-
* @
|
4297
|
-
*
|
4298
|
-
*
|
4271
|
+
* @description Defines how to override a specific component.
|
4272
|
+
*
|
4273
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4274
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4299
4275
|
*/
|
4300
4276
|
ComponentOverride: {
|
4301
4277
|
parameters?: {
|
@@ -4304,10 +4280,11 @@ interface external$1 {
|
|
4304
4280
|
variant?: string;
|
4305
4281
|
};
|
4306
4282
|
/**
|
4307
|
-
* @
|
4308
|
-
*
|
4309
|
-
*
|
4310
|
-
* NOTE:
|
4283
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
4284
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
4285
|
+
*
|
4286
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4287
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4311
4288
|
*/
|
4312
4289
|
ComponentOverridability: {
|
4313
4290
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4318,13 +4295,15 @@ interface external$1 {
|
|
4318
4295
|
variants?: boolean;
|
4319
4296
|
};
|
4320
4297
|
/**
|
4321
|
-
* @
|
4322
|
-
*
|
4298
|
+
* @description Whether a parameter is overridable
|
4299
|
+
*
|
4300
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4301
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4302
|
+
*
|
4323
4303
|
* @enum {string}
|
4324
4304
|
*/
|
4325
4305
|
OverrideOptions: "yes" | "no";
|
4326
4306
|
/**
|
4327
|
-
* @deprecated
|
4328
4307
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4329
4308
|
* These are created in the UI and shared across a whole project.
|
4330
4309
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4358,10 +4337,7 @@ interface external$1 {
|
|
4358
4337
|
[key: string]: unknown;
|
4359
4338
|
};
|
4360
4339
|
};
|
4361
|
-
/**
|
4362
|
-
* @deprecated
|
4363
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
4364
|
-
*/
|
4340
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
4365
4341
|
DataType: {
|
4366
4342
|
/** @description Public ID of the data type */
|
4367
4343
|
id: string;
|
@@ -4418,10 +4394,7 @@ interface external$1 {
|
|
4418
4394
|
[key: string]: unknown;
|
4419
4395
|
};
|
4420
4396
|
};
|
4421
|
-
/**
|
4422
|
-
* @deprecated
|
4423
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
4424
|
-
*/
|
4397
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
4425
4398
|
DataVariableDefinition: {
|
4426
4399
|
/** @description Display name of the data variable */
|
4427
4400
|
displayName?: string;
|
@@ -4438,17 +4411,13 @@ interface external$1 {
|
|
4438
4411
|
order?: number;
|
4439
4412
|
};
|
4440
4413
|
/**
|
4441
|
-
* @deprecated
|
4442
4414
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4443
4415
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4444
4416
|
*/
|
4445
4417
|
DataResourceDefinitions: {
|
4446
4418
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4447
4419
|
};
|
4448
|
-
/**
|
4449
|
-
* @deprecated
|
4450
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
4451
|
-
*/
|
4420
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
4452
4421
|
DataResourceDefinition: {
|
4453
4422
|
/** @description Public ID of the data type that provides this data */
|
4454
4423
|
type: string;
|
@@ -4462,10 +4431,7 @@ interface external$1 {
|
|
4462
4431
|
ignorePatternParameterDefault?: boolean;
|
4463
4432
|
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4464
4433
|
};
|
4465
|
-
/**
|
4466
|
-
* @deprecated
|
4467
|
-
* @description Variable values for a data resource.
|
4468
|
-
*/
|
4434
|
+
/** @description Variable values for a data resource. */
|
4469
4435
|
DataResourceVariables: {
|
4470
4436
|
[key: string]: string;
|
4471
4437
|
};
|
@@ -4748,8 +4714,10 @@ interface external {
|
|
4748
4714
|
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4749
4715
|
};
|
4750
4716
|
/**
|
4751
|
-
* @
|
4752
|
-
*
|
4717
|
+
* @description Defines a connection to a data element on a data resource.
|
4718
|
+
*
|
4719
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4720
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
4753
4721
|
*/
|
4754
4722
|
DataElementConnectionDefinition: {
|
4755
4723
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4792,7 +4760,6 @@ interface external {
|
|
4792
4760
|
_pattern?: string;
|
4793
4761
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4794
4762
|
/**
|
4795
|
-
* @deprecated
|
4796
4763
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4797
4764
|
* Means nothing for PUTs; it will be ignored.
|
4798
4765
|
*/
|
@@ -4809,20 +4776,26 @@ interface external {
|
|
4809
4776
|
*/
|
4810
4777
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4811
4778
|
/**
|
4812
|
-
* @
|
4813
|
-
*
|
4814
|
-
*
|
4815
|
-
*
|
4816
|
-
*
|
4779
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4780
|
+
* This can be used to override parameters that are defined on patterns,
|
4781
|
+
* including nested patterns, with values that are specific to this composition.
|
4782
|
+
* The keys in this object are component IDs.
|
4783
|
+
* Overrides are applied from the top down, so for example if both the composition
|
4784
|
+
* and a pattern on the composition define an override on a nested pattern,
|
4785
|
+
* the composition's override replaces the pattern's.
|
4786
|
+
*
|
4787
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4788
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4817
4789
|
*/
|
4818
4790
|
_overrides?: {
|
4819
4791
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4820
4792
|
};
|
4821
4793
|
/**
|
4822
|
-
* @
|
4823
|
-
* @description Experimental functionality subject to change without notice.
|
4824
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4794
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4825
4795
|
* by consumers of the pattern.
|
4796
|
+
*
|
4797
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4798
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4826
4799
|
*/
|
4827
4800
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4828
4801
|
};
|
@@ -4850,31 +4823,34 @@ interface external {
|
|
4850
4823
|
_name: string;
|
4851
4824
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4852
4825
|
/**
|
4853
|
-
* @
|
4854
|
-
* @description Experimental functionality subject to change without notice.
|
4855
|
-
* Defines patch overrides to component IDs that live in the composition.
|
4826
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4856
4827
|
* This can be used to override parameters that are defined on patterns,
|
4857
4828
|
* including nested patterns, with values that are specific to this composition.
|
4858
4829
|
* The keys in this object are component IDs.
|
4859
4830
|
* Overrides are applied from the top down, so for example if both the composition
|
4860
4831
|
* and a pattern on the composition define an override on a nested pattern,
|
4861
4832
|
* the composition's override replaces the pattern's.
|
4833
|
+
*
|
4834
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4835
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4862
4836
|
*/
|
4863
4837
|
_overrides?: {
|
4864
4838
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4865
4839
|
};
|
4866
4840
|
/**
|
4867
|
-
* @
|
4868
|
-
* @description Experimental functionality subject to change without notice.
|
4869
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4841
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4870
4842
|
* by consumers of the pattern.
|
4843
|
+
*
|
4844
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4845
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4871
4846
|
*/
|
4872
4847
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4873
4848
|
};
|
4874
4849
|
/**
|
4875
|
-
* @
|
4876
|
-
*
|
4877
|
-
*
|
4850
|
+
* @description Defines how to override a specific component.
|
4851
|
+
*
|
4852
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4853
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4878
4854
|
*/
|
4879
4855
|
ComponentOverride: {
|
4880
4856
|
parameters?: {
|
@@ -4883,10 +4859,11 @@ interface external {
|
|
4883
4859
|
variant?: string;
|
4884
4860
|
};
|
4885
4861
|
/**
|
4886
|
-
* @
|
4887
|
-
*
|
4888
|
-
*
|
4889
|
-
* NOTE:
|
4862
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
4863
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
4864
|
+
*
|
4865
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4866
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4890
4867
|
*/
|
4891
4868
|
ComponentOverridability: {
|
4892
4869
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4897,13 +4874,15 @@ interface external {
|
|
4897
4874
|
variants?: boolean;
|
4898
4875
|
};
|
4899
4876
|
/**
|
4900
|
-
* @
|
4901
|
-
*
|
4877
|
+
* @description Whether a parameter is overridable
|
4878
|
+
*
|
4879
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4880
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4881
|
+
*
|
4902
4882
|
* @enum {string}
|
4903
4883
|
*/
|
4904
4884
|
OverrideOptions: "yes" | "no";
|
4905
4885
|
/**
|
4906
|
-
* @deprecated
|
4907
4886
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4908
4887
|
* These are created in the UI and shared across a whole project.
|
4909
4888
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4937,10 +4916,7 @@ interface external {
|
|
4937
4916
|
[key: string]: unknown;
|
4938
4917
|
};
|
4939
4918
|
};
|
4940
|
-
/**
|
4941
|
-
* @deprecated
|
4942
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
4943
|
-
*/
|
4919
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
|
4944
4920
|
DataType: {
|
4945
4921
|
/** @description Public ID of the data type */
|
4946
4922
|
id: string;
|
@@ -4997,10 +4973,7 @@ interface external {
|
|
4997
4973
|
[key: string]: unknown;
|
4998
4974
|
};
|
4999
4975
|
};
|
5000
|
-
/**
|
5001
|
-
* @deprecated
|
5002
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
5003
|
-
*/
|
4976
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
5004
4977
|
DataVariableDefinition: {
|
5005
4978
|
/** @description Display name of the data variable */
|
5006
4979
|
displayName?: string;
|
@@ -5017,17 +4990,13 @@ interface external {
|
|
5017
4990
|
order?: number;
|
5018
4991
|
};
|
5019
4992
|
/**
|
5020
|
-
* @deprecated
|
5021
4993
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
5022
4994
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
5023
4995
|
*/
|
5024
4996
|
DataResourceDefinitions: {
|
5025
4997
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
5026
4998
|
};
|
5027
|
-
/**
|
5028
|
-
* @deprecated
|
5029
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
5030
|
-
*/
|
4999
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
5031
5000
|
DataResourceDefinition: {
|
5032
5001
|
/** @description Public ID of the data type that provides this data */
|
5033
5002
|
type: string;
|
@@ -5041,10 +5010,7 @@ interface external {
|
|
5041
5010
|
ignorePatternParameterDefault?: boolean;
|
5042
5011
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
5043
5012
|
};
|
5044
|
-
/**
|
5045
|
-
* @deprecated
|
5046
|
-
* @description Variable values for a data resource.
|
5047
|
-
*/
|
5013
|
+
/** @description Variable values for a data resource. */
|
5048
5014
|
DataResourceVariables: {
|
5049
5015
|
[key: string]: string;
|
5050
5016
|
};
|
@@ -5179,9 +5145,7 @@ type InvalidationPayload = schemas['InvalidationPayload'];
|
|
5179
5145
|
type InvalidationResult = schemas['InvalidationResult'];
|
5180
5146
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
5181
5147
|
|
5182
|
-
/**
|
5183
|
-
* @deprecated
|
5184
|
-
*/
|
5148
|
+
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
5185
5149
|
declare class DataSourceClient extends ApiClient {
|
5186
5150
|
constructor(options: ClientOptions);
|
5187
5151
|
/** Fetches all DataSources for a project */
|
@@ -5248,9 +5212,7 @@ declare class DataSourceClient extends ApiClient {
|
|
5248
5212
|
remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
|
5249
5213
|
}
|
5250
5214
|
|
5251
|
-
/**
|
5252
|
-
* @deprecated
|
5253
|
-
*/
|
5215
|
+
/** API client to make comms with the Next Gen Mesh Data Type API simpler */
|
5254
5216
|
declare class DataTypeClient extends ApiClient {
|
5255
5217
|
#private;
|
5256
5218
|
constructor(options: ClientOptions);
|
@@ -5762,4 +5724,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
5762
5724
|
|
5763
5725
|
declare const CanvasClientError: typeof ApiClientError;
|
5764
5726
|
|
5765
|
-
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition,
|
5727
|
+
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
|