@uniformdev/canvas 18.38.2-alpha.6 → 19.0.0
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 -350
- 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. */
|
@@ -184,7 +186,6 @@ interface components$2 {
|
|
184
186
|
_pattern?: string;
|
185
187
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
186
188
|
/**
|
187
|
-
* @deprecated
|
188
189
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
189
190
|
* Means nothing for PUTs; it will be ignored.
|
190
191
|
*/
|
@@ -201,20 +202,26 @@ interface components$2 {
|
|
201
202
|
*/
|
202
203
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
203
204
|
/**
|
204
|
-
* @
|
205
|
-
*
|
206
|
-
*
|
207
|
-
*
|
208
|
-
*
|
205
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
206
|
+
* This can be used to override parameters that are defined on patterns,
|
207
|
+
* including nested patterns, with values that are specific to this composition.
|
208
|
+
* The keys in this object are component IDs.
|
209
|
+
* Overrides are applied from the top down, so for example if both the composition
|
210
|
+
* and a pattern on the composition define an override on a nested pattern,
|
211
|
+
* the composition's override replaces the pattern's.
|
212
|
+
*
|
213
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
214
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
209
215
|
*/
|
210
216
|
_overrides?: {
|
211
217
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
212
218
|
};
|
213
219
|
/**
|
214
|
-
* @
|
215
|
-
* @description Experimental functionality subject to change without notice.
|
216
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
220
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
217
221
|
* by consumers of the pattern.
|
222
|
+
*
|
223
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
224
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
218
225
|
*/
|
219
226
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
220
227
|
};
|
@@ -242,31 +249,34 @@ interface components$2 {
|
|
242
249
|
_name: string;
|
243
250
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
244
251
|
/**
|
245
|
-
* @
|
246
|
-
* @description Experimental functionality subject to change without notice.
|
247
|
-
* Defines patch overrides to component IDs that live in the composition.
|
252
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
248
253
|
* This can be used to override parameters that are defined on patterns,
|
249
254
|
* including nested patterns, with values that are specific to this composition.
|
250
255
|
* The keys in this object are component IDs.
|
251
256
|
* Overrides are applied from the top down, so for example if both the composition
|
252
257
|
* and a pattern on the composition define an override on a nested pattern,
|
253
258
|
* the composition's override replaces the pattern's.
|
259
|
+
*
|
260
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
261
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
254
262
|
*/
|
255
263
|
_overrides?: {
|
256
264
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
257
265
|
};
|
258
266
|
/**
|
259
|
-
* @
|
260
|
-
* @description Experimental functionality subject to change without notice.
|
261
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
267
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
262
268
|
* by consumers of the pattern.
|
269
|
+
*
|
270
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
271
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
263
272
|
*/
|
264
273
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
265
274
|
};
|
266
275
|
/**
|
267
|
-
* @
|
268
|
-
*
|
269
|
-
*
|
276
|
+
* @description Defines how to override a specific component.
|
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.
|
270
280
|
*/
|
271
281
|
ComponentOverride: {
|
272
282
|
parameters?: {
|
@@ -275,10 +285,11 @@ interface components$2 {
|
|
275
285
|
variant?: string;
|
276
286
|
};
|
277
287
|
/**
|
278
|
-
* @
|
279
|
-
*
|
280
|
-
*
|
281
|
-
* NOTE:
|
288
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
289
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
290
|
+
*
|
291
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
292
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
282
293
|
*/
|
283
294
|
ComponentOverridability: {
|
284
295
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -289,13 +300,15 @@ interface components$2 {
|
|
289
300
|
variants?: boolean;
|
290
301
|
};
|
291
302
|
/**
|
292
|
-
* @
|
293
|
-
*
|
303
|
+
* @description Whether a parameter is overridable
|
304
|
+
*
|
305
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
306
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
307
|
+
*
|
294
308
|
* @enum {string}
|
295
309
|
*/
|
296
310
|
OverrideOptions: "yes" | "no";
|
297
311
|
/**
|
298
|
-
* @deprecated
|
299
312
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
300
313
|
* These are created in the UI and shared across a whole project.
|
301
314
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -329,10 +342,7 @@ interface components$2 {
|
|
329
342
|
[key: string]: unknown;
|
330
343
|
};
|
331
344
|
};
|
332
|
-
/**
|
333
|
-
* @deprecated
|
334
|
-
* @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.
|
335
|
-
*/
|
345
|
+
/** @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. */
|
336
346
|
DataType: {
|
337
347
|
/** @description Public ID of the data type */
|
338
348
|
id: string;
|
@@ -389,10 +399,7 @@ interface components$2 {
|
|
389
399
|
[key: string]: unknown;
|
390
400
|
};
|
391
401
|
};
|
392
|
-
/**
|
393
|
-
* @deprecated
|
394
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
395
|
-
*/
|
402
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
396
403
|
DataVariableDefinition: {
|
397
404
|
/** @description Display name of the data variable */
|
398
405
|
displayName?: string;
|
@@ -409,17 +416,13 @@ interface components$2 {
|
|
409
416
|
order?: number;
|
410
417
|
};
|
411
418
|
/**
|
412
|
-
* @deprecated
|
413
419
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
414
420
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
415
421
|
*/
|
416
422
|
DataResourceDefinitions: {
|
417
423
|
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
418
424
|
};
|
419
|
-
/**
|
420
|
-
* @deprecated
|
421
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
422
|
-
*/
|
425
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
423
426
|
DataResourceDefinition: {
|
424
427
|
/** @description Public ID of the data type that provides this data */
|
425
428
|
type: string;
|
@@ -433,10 +436,7 @@ interface components$2 {
|
|
433
436
|
ignorePatternParameterDefault?: boolean;
|
434
437
|
variables?: components$2["schemas"]["DataResourceVariables"];
|
435
438
|
};
|
436
|
-
/**
|
437
|
-
* @deprecated
|
438
|
-
* @description Variable values for a data resource.
|
439
|
-
*/
|
439
|
+
/** @description Variable values for a data resource. */
|
440
440
|
DataResourceVariables: {
|
441
441
|
[key: string]: string;
|
442
442
|
};
|
@@ -742,8 +742,10 @@ interface external$5 {
|
|
742
742
|
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
743
743
|
};
|
744
744
|
/**
|
745
|
-
* @
|
746
|
-
*
|
745
|
+
* @description Defines a connection to a data element on a data resource.
|
746
|
+
*
|
747
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
748
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
747
749
|
*/
|
748
750
|
DataElementConnectionDefinition: {
|
749
751
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -778,7 +780,6 @@ interface external$5 {
|
|
778
780
|
_pattern?: string;
|
779
781
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
780
782
|
/**
|
781
|
-
* @deprecated
|
782
783
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
783
784
|
* Means nothing for PUTs; it will be ignored.
|
784
785
|
*/
|
@@ -795,20 +796,26 @@ interface external$5 {
|
|
795
796
|
*/
|
796
797
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
797
798
|
/**
|
798
|
-
* @
|
799
|
-
*
|
800
|
-
*
|
801
|
-
*
|
802
|
-
*
|
799
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
800
|
+
* This can be used to override parameters that are defined on patterns,
|
801
|
+
* including nested patterns, with values that are specific to this composition.
|
802
|
+
* The keys in this object are component IDs.
|
803
|
+
* Overrides are applied from the top down, so for example if both the composition
|
804
|
+
* and a pattern on the composition define an override on a nested pattern,
|
805
|
+
* the composition's override replaces the pattern's.
|
806
|
+
*
|
807
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
808
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
803
809
|
*/
|
804
810
|
_overrides?: {
|
805
811
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
806
812
|
};
|
807
813
|
/**
|
808
|
-
* @
|
809
|
-
* @description Experimental functionality subject to change without notice.
|
810
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
814
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
811
815
|
* by consumers of the pattern.
|
816
|
+
*
|
817
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
818
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
812
819
|
*/
|
813
820
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
814
821
|
};
|
@@ -836,31 +843,34 @@ interface external$5 {
|
|
836
843
|
_name: string;
|
837
844
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
838
845
|
/**
|
839
|
-
* @
|
840
|
-
* @description Experimental functionality subject to change without notice.
|
841
|
-
* Defines patch overrides to component IDs that live in the composition.
|
846
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
842
847
|
* This can be used to override parameters that are defined on patterns,
|
843
848
|
* including nested patterns, with values that are specific to this composition.
|
844
849
|
* The keys in this object are component IDs.
|
845
850
|
* Overrides are applied from the top down, so for example if both the composition
|
846
851
|
* and a pattern on the composition define an override on a nested pattern,
|
847
852
|
* the composition's override replaces the pattern's.
|
853
|
+
*
|
854
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
855
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
848
856
|
*/
|
849
857
|
_overrides?: {
|
850
858
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
851
859
|
};
|
852
860
|
/**
|
853
|
-
* @
|
854
|
-
* @description Experimental functionality subject to change without notice.
|
855
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
861
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
856
862
|
* by consumers of the pattern.
|
863
|
+
*
|
864
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
865
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
857
866
|
*/
|
858
867
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
859
868
|
};
|
860
869
|
/**
|
861
|
-
* @
|
862
|
-
*
|
863
|
-
*
|
870
|
+
* @description Defines how to override a specific component.
|
871
|
+
*
|
872
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
873
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
864
874
|
*/
|
865
875
|
ComponentOverride: {
|
866
876
|
parameters?: {
|
@@ -869,10 +879,11 @@ interface external$5 {
|
|
869
879
|
variant?: string;
|
870
880
|
};
|
871
881
|
/**
|
872
|
-
* @
|
873
|
-
*
|
874
|
-
*
|
875
|
-
* NOTE:
|
882
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
883
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
884
|
+
*
|
885
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
886
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
876
887
|
*/
|
877
888
|
ComponentOverridability: {
|
878
889
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -883,13 +894,15 @@ interface external$5 {
|
|
883
894
|
variants?: boolean;
|
884
895
|
};
|
885
896
|
/**
|
886
|
-
* @
|
887
|
-
*
|
897
|
+
* @description Whether a parameter is overridable
|
898
|
+
*
|
899
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
900
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
901
|
+
*
|
888
902
|
* @enum {string}
|
889
903
|
*/
|
890
904
|
OverrideOptions: "yes" | "no";
|
891
905
|
/**
|
892
|
-
* @deprecated
|
893
906
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
894
907
|
* These are created in the UI and shared across a whole project.
|
895
908
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -923,10 +936,7 @@ interface external$5 {
|
|
923
936
|
[key: string]: unknown;
|
924
937
|
};
|
925
938
|
};
|
926
|
-
/**
|
927
|
-
* @deprecated
|
928
|
-
* @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.
|
929
|
-
*/
|
939
|
+
/** @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. */
|
930
940
|
DataType: {
|
931
941
|
/** @description Public ID of the data type */
|
932
942
|
id: string;
|
@@ -983,10 +993,7 @@ interface external$5 {
|
|
983
993
|
[key: string]: unknown;
|
984
994
|
};
|
985
995
|
};
|
986
|
-
/**
|
987
|
-
* @deprecated
|
988
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
989
|
-
*/
|
996
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
990
997
|
DataVariableDefinition: {
|
991
998
|
/** @description Display name of the data variable */
|
992
999
|
displayName?: string;
|
@@ -1003,17 +1010,13 @@ interface external$5 {
|
|
1003
1010
|
order?: number;
|
1004
1011
|
};
|
1005
1012
|
/**
|
1006
|
-
* @deprecated
|
1007
1013
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1008
1014
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1009
1015
|
*/
|
1010
1016
|
DataResourceDefinitions: {
|
1011
1017
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1012
1018
|
};
|
1013
|
-
/**
|
1014
|
-
* @deprecated
|
1015
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1016
|
-
*/
|
1019
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1017
1020
|
DataResourceDefinition: {
|
1018
1021
|
/** @description Public ID of the data type that provides this data */
|
1019
1022
|
type: string;
|
@@ -1027,10 +1030,7 @@ interface external$5 {
|
|
1027
1030
|
ignorePatternParameterDefault?: boolean;
|
1028
1031
|
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1029
1032
|
};
|
1030
|
-
/**
|
1031
|
-
* @deprecated
|
1032
|
-
* @description Variable values for a data resource.
|
1033
|
-
*/
|
1033
|
+
/** @description Variable values for a data resource. */
|
1034
1034
|
DataResourceVariables: {
|
1035
1035
|
[key: string]: string;
|
1036
1036
|
};
|
@@ -1065,14 +1065,6 @@ type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['
|
|
1065
1065
|
type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
|
1066
1066
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1067
1067
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
1068
|
-
/** @deprecated use ComponentDefinitionGetResponse instead */
|
1069
|
-
type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
|
1070
|
-
/** @deprecated use ComponentDefinitionPutParameters */
|
1071
|
-
type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
|
1072
|
-
/** @deprecated use ComponentDefinitionDeleteParameters */
|
1073
|
-
type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
|
1074
|
-
/** @deprecated use ComponentDefinitionGetParameters */
|
1075
|
-
type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
|
1076
1068
|
/** The definition of a component parameter */
|
1077
1069
|
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1078
1070
|
typeConfig?: TConfig;
|
@@ -1087,8 +1079,6 @@ type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
|
|
1087
1079
|
type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
|
1088
1080
|
/** Defines a component type that can live on a Composition */
|
1089
1081
|
type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
1090
|
-
/** @deprecated use ComponentDefinition instead */
|
1091
|
-
type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
|
1092
1082
|
|
1093
1083
|
/**
|
1094
1084
|
* This file was auto-generated by openapi-typescript.
|
@@ -1146,7 +1136,7 @@ interface paths$3 {
|
|
1146
1136
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
1147
1137
|
skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
|
1148
1138
|
/**
|
1149
|
-
*
|
1139
|
+
* If true, any pattern override data is not resolved by the API.
|
1150
1140
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1151
1141
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
1152
1142
|
*/
|
@@ -1355,7 +1345,6 @@ interface components$1 {
|
|
1355
1345
|
*/
|
1356
1346
|
skipPatternResolution: boolean;
|
1357
1347
|
/**
|
1358
|
-
* @deprecated
|
1359
1348
|
* @description If true, any pattern override data is not resolved by the API.
|
1360
1349
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1361
1350
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -1600,8 +1589,10 @@ interface external$4 {
|
|
1600
1589
|
connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1601
1590
|
};
|
1602
1591
|
/**
|
1603
|
-
* @
|
1604
|
-
*
|
1592
|
+
* @description Defines a connection to a data element on a data resource.
|
1593
|
+
*
|
1594
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1595
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
1605
1596
|
*/
|
1606
1597
|
DataElementConnectionDefinition: {
|
1607
1598
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -1636,7 +1627,6 @@ interface external$4 {
|
|
1636
1627
|
_pattern?: string;
|
1637
1628
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1638
1629
|
/**
|
1639
|
-
* @deprecated
|
1640
1630
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1641
1631
|
* Means nothing for PUTs; it will be ignored.
|
1642
1632
|
*/
|
@@ -1653,20 +1643,26 @@ interface external$4 {
|
|
1653
1643
|
*/
|
1654
1644
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
1655
1645
|
/**
|
1656
|
-
* @
|
1657
|
-
*
|
1658
|
-
*
|
1659
|
-
*
|
1660
|
-
*
|
1646
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1647
|
+
* This can be used to override parameters that are defined on patterns,
|
1648
|
+
* including nested patterns, with values that are specific to this composition.
|
1649
|
+
* The keys in this object are component IDs.
|
1650
|
+
* Overrides are applied from the top down, so for example if both the composition
|
1651
|
+
* and a pattern on the composition define an override on a nested pattern,
|
1652
|
+
* the composition's override replaces the pattern's.
|
1653
|
+
*
|
1654
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1655
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1661
1656
|
*/
|
1662
1657
|
_overrides?: {
|
1663
1658
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1664
1659
|
};
|
1665
1660
|
/**
|
1666
|
-
* @
|
1667
|
-
* @description Experimental functionality subject to change without notice.
|
1668
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1661
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1669
1662
|
* by consumers of the pattern.
|
1663
|
+
*
|
1664
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1665
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1670
1666
|
*/
|
1671
1667
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1672
1668
|
};
|
@@ -1694,31 +1690,34 @@ interface external$4 {
|
|
1694
1690
|
_name: string;
|
1695
1691
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1696
1692
|
/**
|
1697
|
-
* @
|
1698
|
-
* @description Experimental functionality subject to change without notice.
|
1699
|
-
* Defines patch overrides to component IDs that live in the composition.
|
1693
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1700
1694
|
* This can be used to override parameters that are defined on patterns,
|
1701
1695
|
* including nested patterns, with values that are specific to this composition.
|
1702
1696
|
* The keys in this object are component IDs.
|
1703
1697
|
* Overrides are applied from the top down, so for example if both the composition
|
1704
1698
|
* and a pattern on the composition define an override on a nested pattern,
|
1705
1699
|
* the composition's override replaces the pattern's.
|
1700
|
+
*
|
1701
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1702
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1706
1703
|
*/
|
1707
1704
|
_overrides?: {
|
1708
1705
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1709
1706
|
};
|
1710
1707
|
/**
|
1711
|
-
* @
|
1712
|
-
* @description Experimental functionality subject to change without notice.
|
1713
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1708
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1714
1709
|
* by consumers of the pattern.
|
1710
|
+
*
|
1711
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1712
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1715
1713
|
*/
|
1716
1714
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1717
1715
|
};
|
1718
1716
|
/**
|
1719
|
-
* @
|
1720
|
-
*
|
1721
|
-
*
|
1717
|
+
* @description Defines how to override a specific component.
|
1718
|
+
*
|
1719
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1720
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1722
1721
|
*/
|
1723
1722
|
ComponentOverride: {
|
1724
1723
|
parameters?: {
|
@@ -1727,10 +1726,11 @@ interface external$4 {
|
|
1727
1726
|
variant?: string;
|
1728
1727
|
};
|
1729
1728
|
/**
|
1730
|
-
* @
|
1731
|
-
*
|
1732
|
-
*
|
1733
|
-
* NOTE:
|
1729
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
1730
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
1731
|
+
*
|
1732
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1733
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1734
1734
|
*/
|
1735
1735
|
ComponentOverridability: {
|
1736
1736
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -1741,13 +1741,15 @@ interface external$4 {
|
|
1741
1741
|
variants?: boolean;
|
1742
1742
|
};
|
1743
1743
|
/**
|
1744
|
-
* @
|
1745
|
-
*
|
1744
|
+
* @description Whether a parameter is overridable
|
1745
|
+
*
|
1746
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1747
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1748
|
+
*
|
1746
1749
|
* @enum {string}
|
1747
1750
|
*/
|
1748
1751
|
OverrideOptions: "yes" | "no";
|
1749
1752
|
/**
|
1750
|
-
* @deprecated
|
1751
1753
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
1752
1754
|
* These are created in the UI and shared across a whole project.
|
1753
1755
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -1781,10 +1783,7 @@ interface external$4 {
|
|
1781
1783
|
[key: string]: unknown;
|
1782
1784
|
};
|
1783
1785
|
};
|
1784
|
-
/**
|
1785
|
-
* @deprecated
|
1786
|
-
* @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.
|
1787
|
-
*/
|
1786
|
+
/** @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. */
|
1788
1787
|
DataType: {
|
1789
1788
|
/** @description Public ID of the data type */
|
1790
1789
|
id: string;
|
@@ -1841,10 +1840,7 @@ interface external$4 {
|
|
1841
1840
|
[key: string]: unknown;
|
1842
1841
|
};
|
1843
1842
|
};
|
1844
|
-
/**
|
1845
|
-
* @deprecated
|
1846
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1847
|
-
*/
|
1843
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
1848
1844
|
DataVariableDefinition: {
|
1849
1845
|
/** @description Display name of the data variable */
|
1850
1846
|
displayName?: string;
|
@@ -1861,17 +1857,13 @@ interface external$4 {
|
|
1861
1857
|
order?: number;
|
1862
1858
|
};
|
1863
1859
|
/**
|
1864
|
-
* @deprecated
|
1865
1860
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1866
1861
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1867
1862
|
*/
|
1868
1863
|
DataResourceDefinitions: {
|
1869
1864
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1870
1865
|
};
|
1871
|
-
/**
|
1872
|
-
* @deprecated
|
1873
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1874
|
-
*/
|
1866
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1875
1867
|
DataResourceDefinition: {
|
1876
1868
|
/** @description Public ID of the data type that provides this data */
|
1877
1869
|
type: string;
|
@@ -1885,10 +1877,7 @@ interface external$4 {
|
|
1885
1877
|
ignorePatternParameterDefault?: boolean;
|
1886
1878
|
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1887
1879
|
};
|
1888
|
-
/**
|
1889
|
-
* @deprecated
|
1890
|
-
* @description Variable values for a data resource.
|
1891
|
-
*/
|
1880
|
+
/** @description Variable values for a data resource. */
|
1892
1881
|
DataResourceVariables: {
|
1893
1882
|
[key: string]: string;
|
1894
1883
|
};
|
@@ -2243,8 +2232,10 @@ interface external$3 {
|
|
2243
2232
|
connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2244
2233
|
};
|
2245
2234
|
/**
|
2246
|
-
* @
|
2247
|
-
*
|
2235
|
+
* @description Defines a connection to a data element on a data resource.
|
2236
|
+
*
|
2237
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2238
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
2248
2239
|
*/
|
2249
2240
|
DataElementConnectionDefinition: {
|
2250
2241
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -2279,7 +2270,6 @@ interface external$3 {
|
|
2279
2270
|
_pattern?: string;
|
2280
2271
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2281
2272
|
/**
|
2282
|
-
* @deprecated
|
2283
2273
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2284
2274
|
* Means nothing for PUTs; it will be ignored.
|
2285
2275
|
*/
|
@@ -2296,20 +2286,26 @@ interface external$3 {
|
|
2296
2286
|
*/
|
2297
2287
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
2298
2288
|
/**
|
2299
|
-
* @
|
2300
|
-
*
|
2301
|
-
*
|
2302
|
-
*
|
2303
|
-
*
|
2289
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2290
|
+
* This can be used to override parameters that are defined on patterns,
|
2291
|
+
* including nested patterns, with values that are specific to this composition.
|
2292
|
+
* The keys in this object are component IDs.
|
2293
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2294
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2295
|
+
* the composition's override replaces the pattern's.
|
2296
|
+
*
|
2297
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2298
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2304
2299
|
*/
|
2305
2300
|
_overrides?: {
|
2306
2301
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2307
2302
|
};
|
2308
2303
|
/**
|
2309
|
-
* @
|
2310
|
-
* @description Experimental functionality subject to change without notice.
|
2311
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2304
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2312
2305
|
* by consumers of the pattern.
|
2306
|
+
*
|
2307
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2308
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2313
2309
|
*/
|
2314
2310
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2315
2311
|
};
|
@@ -2337,31 +2333,34 @@ interface external$3 {
|
|
2337
2333
|
_name: string;
|
2338
2334
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2339
2335
|
/**
|
2340
|
-
* @
|
2341
|
-
* @description Experimental functionality subject to change without notice.
|
2342
|
-
* Defines patch overrides to component IDs that live in the composition.
|
2336
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2343
2337
|
* This can be used to override parameters that are defined on patterns,
|
2344
2338
|
* including nested patterns, with values that are specific to this composition.
|
2345
2339
|
* The keys in this object are component IDs.
|
2346
2340
|
* Overrides are applied from the top down, so for example if both the composition
|
2347
2341
|
* and a pattern on the composition define an override on a nested pattern,
|
2348
2342
|
* the composition's override replaces the pattern's.
|
2343
|
+
*
|
2344
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2345
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2349
2346
|
*/
|
2350
2347
|
_overrides?: {
|
2351
2348
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2352
2349
|
};
|
2353
2350
|
/**
|
2354
|
-
* @
|
2355
|
-
* @description Experimental functionality subject to change without notice.
|
2356
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2351
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2357
2352
|
* by consumers of the pattern.
|
2353
|
+
*
|
2354
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2355
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2358
2356
|
*/
|
2359
2357
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2360
2358
|
};
|
2361
2359
|
/**
|
2362
|
-
* @
|
2363
|
-
*
|
2364
|
-
*
|
2360
|
+
* @description Defines how to override a specific component.
|
2361
|
+
*
|
2362
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2363
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2365
2364
|
*/
|
2366
2365
|
ComponentOverride: {
|
2367
2366
|
parameters?: {
|
@@ -2370,10 +2369,11 @@ interface external$3 {
|
|
2370
2369
|
variant?: string;
|
2371
2370
|
};
|
2372
2371
|
/**
|
2373
|
-
* @
|
2374
|
-
*
|
2375
|
-
*
|
2376
|
-
* NOTE:
|
2372
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
2373
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
2374
|
+
*
|
2375
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2376
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2377
2377
|
*/
|
2378
2378
|
ComponentOverridability: {
|
2379
2379
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -2384,13 +2384,15 @@ interface external$3 {
|
|
2384
2384
|
variants?: boolean;
|
2385
2385
|
};
|
2386
2386
|
/**
|
2387
|
-
* @
|
2388
|
-
*
|
2387
|
+
* @description Whether a parameter is overridable
|
2388
|
+
*
|
2389
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2390
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2391
|
+
*
|
2389
2392
|
* @enum {string}
|
2390
2393
|
*/
|
2391
2394
|
OverrideOptions: "yes" | "no";
|
2392
2395
|
/**
|
2393
|
-
* @deprecated
|
2394
2396
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
2395
2397
|
* These are created in the UI and shared across a whole project.
|
2396
2398
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -2424,10 +2426,7 @@ interface external$3 {
|
|
2424
2426
|
[key: string]: unknown;
|
2425
2427
|
};
|
2426
2428
|
};
|
2427
|
-
/**
|
2428
|
-
* @deprecated
|
2429
|
-
* @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.
|
2430
|
-
*/
|
2429
|
+
/** @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. */
|
2431
2430
|
DataType: {
|
2432
2431
|
/** @description Public ID of the data type */
|
2433
2432
|
id: string;
|
@@ -2484,10 +2483,7 @@ interface external$3 {
|
|
2484
2483
|
[key: string]: unknown;
|
2485
2484
|
};
|
2486
2485
|
};
|
2487
|
-
/**
|
2488
|
-
* @deprecated
|
2489
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2490
|
-
*/
|
2486
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
2491
2487
|
DataVariableDefinition: {
|
2492
2488
|
/** @description Display name of the data variable */
|
2493
2489
|
displayName?: string;
|
@@ -2504,17 +2500,13 @@ interface external$3 {
|
|
2504
2500
|
order?: number;
|
2505
2501
|
};
|
2506
2502
|
/**
|
2507
|
-
* @deprecated
|
2508
2503
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2509
2504
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2510
2505
|
*/
|
2511
2506
|
DataResourceDefinitions: {
|
2512
2507
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2513
2508
|
};
|
2514
|
-
/**
|
2515
|
-
* @deprecated
|
2516
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2517
|
-
*/
|
2509
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2518
2510
|
DataResourceDefinition: {
|
2519
2511
|
/** @description Public ID of the data type that provides this data */
|
2520
2512
|
type: string;
|
@@ -2528,10 +2520,7 @@ interface external$3 {
|
|
2528
2520
|
ignorePatternParameterDefault?: boolean;
|
2529
2521
|
variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2530
2522
|
};
|
2531
|
-
/**
|
2532
|
-
* @deprecated
|
2533
|
-
* @description Variable values for a data resource.
|
2534
|
-
*/
|
2523
|
+
/** @description Variable values for a data resource. */
|
2535
2524
|
DataResourceVariables: {
|
2536
2525
|
[key: string]: string;
|
2537
2526
|
};
|
@@ -2607,7 +2596,7 @@ interface external$3 {
|
|
2607
2596
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2608
2597
|
skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2609
2598
|
/**
|
2610
|
-
*
|
2599
|
+
* If true, any pattern override data is not resolved by the API.
|
2611
2600
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2612
2601
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2613
2602
|
*/
|
@@ -2816,7 +2805,6 @@ interface external$3 {
|
|
2816
2805
|
*/
|
2817
2806
|
skipPatternResolution: boolean;
|
2818
2807
|
/**
|
2819
|
-
* @deprecated
|
2820
2808
|
* @description If true, any pattern override data is not resolved by the API.
|
2821
2809
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2822
2810
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -2895,14 +2883,6 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
|
|
2895
2883
|
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2896
2884
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2897
2885
|
type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
|
2898
|
-
/** @deprecated use CompositionGetResponse */
|
2899
|
-
type CompositionAPIResponse = CompositionGetResponse;
|
2900
|
-
/** @deprecated use CompositionDeleteParameters */
|
2901
|
-
type CompositionAPIDeleteRequest = CompositionDeleteParameters;
|
2902
|
-
/** @deprecated use CompositionGetParameters */
|
2903
|
-
type CompositionListAPIResponse = CompositionGetListResponse;
|
2904
|
-
/** @deprecated use CompositionGetParameters */
|
2905
|
-
type CompositionAPIOptions = CompositionGetParameters;
|
2906
2886
|
/** Defines an editable parameter on a component. */
|
2907
2887
|
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2908
2888
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
@@ -2928,22 +2908,18 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
|
2928
2908
|
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2929
2909
|
/**
|
2930
2910
|
* Defines the shape of a component override
|
2931
|
-
* @deprecated
|
2932
2911
|
*/
|
2933
2912
|
type OverrideOptions = SharedComponents['OverrideOptions'];
|
2934
2913
|
/**
|
2935
2914
|
* Defines the shape of a component override
|
2936
|
-
* @deprecated
|
2937
2915
|
*/
|
2938
2916
|
type ComponentOverride = SharedComponents['ComponentOverride'];
|
2939
2917
|
/**
|
2940
2918
|
* Defines a set of component overrides by component ID
|
2941
|
-
* @deprecated
|
2942
2919
|
*/
|
2943
2920
|
type ComponentOverrides = Record<string, ComponentOverride>;
|
2944
2921
|
/**
|
2945
2922
|
* Defines how a component on a pattern may have its values overridden
|
2946
|
-
* @deprecated
|
2947
2923
|
*/
|
2948
2924
|
type ComponentOverridability = SharedComponents['ComponentOverridability'];
|
2949
2925
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
@@ -2965,20 +2941,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
|
2965
2941
|
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2966
2942
|
/** Switches for data resolution */
|
2967
2943
|
type DataResolutionOption = {
|
2968
|
-
|
2944
|
+
skipDataResolution?: boolean;
|
2969
2945
|
};
|
2970
2946
|
type DataResolutionOptionNegative = {
|
2971
|
-
|
2947
|
+
skipDataResolution: true;
|
2972
2948
|
};
|
2973
2949
|
type DataResolutionOptionPositive = {
|
2974
|
-
|
2950
|
+
skipDataResolution?: false;
|
2975
2951
|
};
|
2976
2952
|
type DataResolutionParameters = {
|
2977
2953
|
/**
|
2978
2954
|
* Adds additional diagnostics about edge request processing to the response (`diagnostics`).
|
2979
2955
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
2980
2956
|
*/
|
2981
|
-
|
2957
|
+
diagnostics?: boolean;
|
2982
2958
|
/**
|
2983
2959
|
* Pass dynamic variables to the composition that are required for resolving bindings and datas,
|
2984
2960
|
* such as language, detail page ID, etc.
|
@@ -3184,14 +3160,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3184
3160
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3185
3161
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3186
3162
|
getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3187
|
-
/** @deprecated use getCompositionByNodePath instead */
|
3188
|
-
unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3189
3163
|
/** Fetches one composition by its project map node ID */
|
3190
3164
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3191
3165
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3192
3166
|
getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3193
|
-
/** @deprecated Use getCompositionByNodeId instead */
|
3194
|
-
unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3195
3167
|
/** Fetches one composition by its slug */
|
3196
3168
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3197
3169
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
@@ -3372,7 +3344,7 @@ interface paths$2 {
|
|
3372
3344
|
/**
|
3373
3345
|
* Format: uuid
|
3374
3346
|
* @deprecated
|
3375
|
-
* @description Do not use.
|
3347
|
+
* @description Do not use. May be removed in future.
|
3376
3348
|
*/
|
3377
3349
|
integrationId?: string;
|
3378
3350
|
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
@@ -3591,8 +3563,10 @@ interface external$2 {
|
|
3591
3563
|
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3592
3564
|
};
|
3593
3565
|
/**
|
3594
|
-
* @
|
3595
|
-
*
|
3566
|
+
* @description Defines a connection to a data element on a data resource.
|
3567
|
+
*
|
3568
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3569
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
3596
3570
|
*/
|
3597
3571
|
DataElementConnectionDefinition: {
|
3598
3572
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -3627,7 +3601,6 @@ interface external$2 {
|
|
3627
3601
|
_pattern?: string;
|
3628
3602
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3629
3603
|
/**
|
3630
|
-
* @deprecated
|
3631
3604
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3632
3605
|
* Means nothing for PUTs; it will be ignored.
|
3633
3606
|
*/
|
@@ -3644,20 +3617,26 @@ interface external$2 {
|
|
3644
3617
|
*/
|
3645
3618
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
3646
3619
|
/**
|
3647
|
-
* @
|
3648
|
-
*
|
3649
|
-
*
|
3650
|
-
*
|
3651
|
-
*
|
3620
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3621
|
+
* This can be used to override parameters that are defined on patterns,
|
3622
|
+
* including nested patterns, with values that are specific to this composition.
|
3623
|
+
* The keys in this object are component IDs.
|
3624
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3625
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3626
|
+
* the composition's override replaces the pattern's.
|
3627
|
+
*
|
3628
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3629
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3652
3630
|
*/
|
3653
3631
|
_overrides?: {
|
3654
3632
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3655
3633
|
};
|
3656
3634
|
/**
|
3657
|
-
* @
|
3658
|
-
* @description Experimental functionality subject to change without notice.
|
3659
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3635
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3660
3636
|
* by consumers of the pattern.
|
3637
|
+
*
|
3638
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3639
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3661
3640
|
*/
|
3662
3641
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3663
3642
|
};
|
@@ -3685,31 +3664,34 @@ interface external$2 {
|
|
3685
3664
|
_name: string;
|
3686
3665
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3687
3666
|
/**
|
3688
|
-
* @
|
3689
|
-
* @description Experimental functionality subject to change without notice.
|
3690
|
-
* Defines patch overrides to component IDs that live in the composition.
|
3667
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3691
3668
|
* This can be used to override parameters that are defined on patterns,
|
3692
3669
|
* including nested patterns, with values that are specific to this composition.
|
3693
3670
|
* The keys in this object are component IDs.
|
3694
3671
|
* Overrides are applied from the top down, so for example if both the composition
|
3695
3672
|
* and a pattern on the composition define an override on a nested pattern,
|
3696
3673
|
* the composition's override replaces the pattern's.
|
3674
|
+
*
|
3675
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3676
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3697
3677
|
*/
|
3698
3678
|
_overrides?: {
|
3699
3679
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3700
3680
|
};
|
3701
3681
|
/**
|
3702
|
-
* @
|
3703
|
-
* @description Experimental functionality subject to change without notice.
|
3704
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3682
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3705
3683
|
* by consumers of the pattern.
|
3684
|
+
*
|
3685
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3686
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3706
3687
|
*/
|
3707
3688
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3708
3689
|
};
|
3709
3690
|
/**
|
3710
|
-
* @
|
3711
|
-
*
|
3712
|
-
*
|
3691
|
+
* @description Defines how to override a specific component.
|
3692
|
+
*
|
3693
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3694
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3713
3695
|
*/
|
3714
3696
|
ComponentOverride: {
|
3715
3697
|
parameters?: {
|
@@ -3718,10 +3700,11 @@ interface external$2 {
|
|
3718
3700
|
variant?: string;
|
3719
3701
|
};
|
3720
3702
|
/**
|
3721
|
-
* @
|
3722
|
-
*
|
3723
|
-
*
|
3724
|
-
* NOTE:
|
3703
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
3704
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
3705
|
+
*
|
3706
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3707
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3725
3708
|
*/
|
3726
3709
|
ComponentOverridability: {
|
3727
3710
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -3732,13 +3715,15 @@ interface external$2 {
|
|
3732
3715
|
variants?: boolean;
|
3733
3716
|
};
|
3734
3717
|
/**
|
3735
|
-
* @
|
3736
|
-
*
|
3718
|
+
* @description Whether a parameter is overridable
|
3719
|
+
*
|
3720
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3721
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3722
|
+
*
|
3737
3723
|
* @enum {string}
|
3738
3724
|
*/
|
3739
3725
|
OverrideOptions: "yes" | "no";
|
3740
3726
|
/**
|
3741
|
-
* @deprecated
|
3742
3727
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
3743
3728
|
* These are created in the UI and shared across a whole project.
|
3744
3729
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -3772,10 +3757,7 @@ interface external$2 {
|
|
3772
3757
|
[key: string]: unknown;
|
3773
3758
|
};
|
3774
3759
|
};
|
3775
|
-
/**
|
3776
|
-
* @deprecated
|
3777
|
-
* @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.
|
3778
|
-
*/
|
3760
|
+
/** @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. */
|
3779
3761
|
DataType: {
|
3780
3762
|
/** @description Public ID of the data type */
|
3781
3763
|
id: string;
|
@@ -3832,10 +3814,7 @@ interface external$2 {
|
|
3832
3814
|
[key: string]: unknown;
|
3833
3815
|
};
|
3834
3816
|
};
|
3835
|
-
/**
|
3836
|
-
* @deprecated
|
3837
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
3838
|
-
*/
|
3817
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
3839
3818
|
DataVariableDefinition: {
|
3840
3819
|
/** @description Display name of the data variable */
|
3841
3820
|
displayName?: string;
|
@@ -3852,17 +3831,13 @@ interface external$2 {
|
|
3852
3831
|
order?: number;
|
3853
3832
|
};
|
3854
3833
|
/**
|
3855
|
-
* @deprecated
|
3856
3834
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
3857
3835
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3858
3836
|
*/
|
3859
3837
|
DataResourceDefinitions: {
|
3860
3838
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3861
3839
|
};
|
3862
|
-
/**
|
3863
|
-
* @deprecated
|
3864
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
3865
|
-
*/
|
3840
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3866
3841
|
DataResourceDefinition: {
|
3867
3842
|
/** @description Public ID of the data type that provides this data */
|
3868
3843
|
type: string;
|
@@ -3876,10 +3851,7 @@ interface external$2 {
|
|
3876
3851
|
ignorePatternParameterDefault?: boolean;
|
3877
3852
|
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3878
3853
|
};
|
3879
|
-
/**
|
3880
|
-
* @deprecated
|
3881
|
-
* @description Variable values for a data resource.
|
3882
|
-
*/
|
3854
|
+
/** @description Variable values for a data resource. */
|
3883
3855
|
DataResourceVariables: {
|
3884
3856
|
[key: string]: string;
|
3885
3857
|
};
|
@@ -4127,8 +4099,10 @@ interface external$1 {
|
|
4127
4099
|
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4128
4100
|
};
|
4129
4101
|
/**
|
4130
|
-
* @
|
4131
|
-
*
|
4102
|
+
* @description Defines a connection to a data element on a data resource.
|
4103
|
+
*
|
4104
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4105
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
4132
4106
|
*/
|
4133
4107
|
DataElementConnectionDefinition: {
|
4134
4108
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4163,7 +4137,6 @@ interface external$1 {
|
|
4163
4137
|
_pattern?: string;
|
4164
4138
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4165
4139
|
/**
|
4166
|
-
* @deprecated
|
4167
4140
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4168
4141
|
* Means nothing for PUTs; it will be ignored.
|
4169
4142
|
*/
|
@@ -4180,20 +4153,26 @@ interface external$1 {
|
|
4180
4153
|
*/
|
4181
4154
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4182
4155
|
/**
|
4183
|
-
* @
|
4184
|
-
*
|
4185
|
-
*
|
4186
|
-
*
|
4187
|
-
*
|
4156
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4157
|
+
* This can be used to override parameters that are defined on patterns,
|
4158
|
+
* including nested patterns, with values that are specific to this composition.
|
4159
|
+
* The keys in this object are component IDs.
|
4160
|
+
* Overrides are applied from the top down, so for example if both the composition
|
4161
|
+
* and a pattern on the composition define an override on a nested pattern,
|
4162
|
+
* the composition's override replaces the pattern's.
|
4163
|
+
*
|
4164
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4165
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4188
4166
|
*/
|
4189
4167
|
_overrides?: {
|
4190
4168
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4191
4169
|
};
|
4192
4170
|
/**
|
4193
|
-
* @
|
4194
|
-
* @description Experimental functionality subject to change without notice.
|
4195
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4171
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4196
4172
|
* by consumers of the pattern.
|
4173
|
+
*
|
4174
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4175
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4197
4176
|
*/
|
4198
4177
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4199
4178
|
};
|
@@ -4221,31 +4200,34 @@ interface external$1 {
|
|
4221
4200
|
_name: string;
|
4222
4201
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4223
4202
|
/**
|
4224
|
-
* @
|
4225
|
-
* @description Experimental functionality subject to change without notice.
|
4226
|
-
* Defines patch overrides to component IDs that live in the composition.
|
4203
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4227
4204
|
* This can be used to override parameters that are defined on patterns,
|
4228
4205
|
* including nested patterns, with values that are specific to this composition.
|
4229
4206
|
* The keys in this object are component IDs.
|
4230
4207
|
* Overrides are applied from the top down, so for example if both the composition
|
4231
4208
|
* and a pattern on the composition define an override on a nested pattern,
|
4232
4209
|
* the composition's override replaces the pattern's.
|
4210
|
+
*
|
4211
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4212
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4233
4213
|
*/
|
4234
4214
|
_overrides?: {
|
4235
4215
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4236
4216
|
};
|
4237
4217
|
/**
|
4238
|
-
* @
|
4239
|
-
* @description Experimental functionality subject to change without notice.
|
4240
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4218
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4241
4219
|
* by consumers of the pattern.
|
4220
|
+
*
|
4221
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4222
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4242
4223
|
*/
|
4243
4224
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4244
4225
|
};
|
4245
4226
|
/**
|
4246
|
-
* @
|
4247
|
-
*
|
4248
|
-
*
|
4227
|
+
* @description Defines how to override a specific component.
|
4228
|
+
*
|
4229
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4230
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4249
4231
|
*/
|
4250
4232
|
ComponentOverride: {
|
4251
4233
|
parameters?: {
|
@@ -4254,10 +4236,11 @@ interface external$1 {
|
|
4254
4236
|
variant?: string;
|
4255
4237
|
};
|
4256
4238
|
/**
|
4257
|
-
* @
|
4258
|
-
*
|
4259
|
-
*
|
4260
|
-
* NOTE:
|
4239
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
4240
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
4241
|
+
*
|
4242
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4243
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4261
4244
|
*/
|
4262
4245
|
ComponentOverridability: {
|
4263
4246
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4268,13 +4251,15 @@ interface external$1 {
|
|
4268
4251
|
variants?: boolean;
|
4269
4252
|
};
|
4270
4253
|
/**
|
4271
|
-
* @
|
4272
|
-
*
|
4254
|
+
* @description Whether a parameter is overridable
|
4255
|
+
*
|
4256
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4257
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4258
|
+
*
|
4273
4259
|
* @enum {string}
|
4274
4260
|
*/
|
4275
4261
|
OverrideOptions: "yes" | "no";
|
4276
4262
|
/**
|
4277
|
-
* @deprecated
|
4278
4263
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4279
4264
|
* These are created in the UI and shared across a whole project.
|
4280
4265
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4308,10 +4293,7 @@ interface external$1 {
|
|
4308
4293
|
[key: string]: unknown;
|
4309
4294
|
};
|
4310
4295
|
};
|
4311
|
-
/**
|
4312
|
-
* @deprecated
|
4313
|
-
* @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.
|
4314
|
-
*/
|
4296
|
+
/** @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. */
|
4315
4297
|
DataType: {
|
4316
4298
|
/** @description Public ID of the data type */
|
4317
4299
|
id: string;
|
@@ -4368,10 +4350,7 @@ interface external$1 {
|
|
4368
4350
|
[key: string]: unknown;
|
4369
4351
|
};
|
4370
4352
|
};
|
4371
|
-
/**
|
4372
|
-
* @deprecated
|
4373
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
4374
|
-
*/
|
4353
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
4375
4354
|
DataVariableDefinition: {
|
4376
4355
|
/** @description Display name of the data variable */
|
4377
4356
|
displayName?: string;
|
@@ -4388,17 +4367,13 @@ interface external$1 {
|
|
4388
4367
|
order?: number;
|
4389
4368
|
};
|
4390
4369
|
/**
|
4391
|
-
* @deprecated
|
4392
4370
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4393
4371
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4394
4372
|
*/
|
4395
4373
|
DataResourceDefinitions: {
|
4396
4374
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4397
4375
|
};
|
4398
|
-
/**
|
4399
|
-
* @deprecated
|
4400
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
4401
|
-
*/
|
4376
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
4402
4377
|
DataResourceDefinition: {
|
4403
4378
|
/** @description Public ID of the data type that provides this data */
|
4404
4379
|
type: string;
|
@@ -4412,10 +4387,7 @@ interface external$1 {
|
|
4412
4387
|
ignorePatternParameterDefault?: boolean;
|
4413
4388
|
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4414
4389
|
};
|
4415
|
-
/**
|
4416
|
-
* @deprecated
|
4417
|
-
* @description Variable values for a data resource.
|
4418
|
-
*/
|
4390
|
+
/** @description Variable values for a data resource. */
|
4419
4391
|
DataResourceVariables: {
|
4420
4392
|
[key: string]: string;
|
4421
4393
|
};
|
@@ -4698,8 +4670,10 @@ interface external {
|
|
4698
4670
|
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4699
4671
|
};
|
4700
4672
|
/**
|
4701
|
-
* @
|
4702
|
-
*
|
4673
|
+
* @description Defines a connection to a data element on a data resource.
|
4674
|
+
*
|
4675
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4676
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
4703
4677
|
*/
|
4704
4678
|
DataElementConnectionDefinition: {
|
4705
4679
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4734,7 +4708,6 @@ interface external {
|
|
4734
4708
|
_pattern?: string;
|
4735
4709
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4736
4710
|
/**
|
4737
|
-
* @deprecated
|
4738
4711
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4739
4712
|
* Means nothing for PUTs; it will be ignored.
|
4740
4713
|
*/
|
@@ -4751,20 +4724,26 @@ interface external {
|
|
4751
4724
|
*/
|
4752
4725
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4753
4726
|
/**
|
4754
|
-
* @
|
4755
|
-
*
|
4756
|
-
*
|
4757
|
-
*
|
4758
|
-
*
|
4727
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4728
|
+
* This can be used to override parameters that are defined on patterns,
|
4729
|
+
* including nested patterns, with values that are specific to this composition.
|
4730
|
+
* The keys in this object are component IDs.
|
4731
|
+
* Overrides are applied from the top down, so for example if both the composition
|
4732
|
+
* and a pattern on the composition define an override on a nested pattern,
|
4733
|
+
* the composition's override replaces the pattern's.
|
4734
|
+
*
|
4735
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4736
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4759
4737
|
*/
|
4760
4738
|
_overrides?: {
|
4761
4739
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4762
4740
|
};
|
4763
4741
|
/**
|
4764
|
-
* @
|
4765
|
-
* @description Experimental functionality subject to change without notice.
|
4766
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4742
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4767
4743
|
* by consumers of the pattern.
|
4744
|
+
*
|
4745
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4746
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4768
4747
|
*/
|
4769
4748
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4770
4749
|
};
|
@@ -4792,31 +4771,34 @@ interface external {
|
|
4792
4771
|
_name: string;
|
4793
4772
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4794
4773
|
/**
|
4795
|
-
* @
|
4796
|
-
* @description Experimental functionality subject to change without notice.
|
4797
|
-
* Defines patch overrides to component IDs that live in the composition.
|
4774
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
4798
4775
|
* This can be used to override parameters that are defined on patterns,
|
4799
4776
|
* including nested patterns, with values that are specific to this composition.
|
4800
4777
|
* The keys in this object are component IDs.
|
4801
4778
|
* Overrides are applied from the top down, so for example if both the composition
|
4802
4779
|
* and a pattern on the composition define an override on a nested pattern,
|
4803
4780
|
* the composition's override replaces the pattern's.
|
4781
|
+
*
|
4782
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4783
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4804
4784
|
*/
|
4805
4785
|
_overrides?: {
|
4806
4786
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4807
4787
|
};
|
4808
4788
|
/**
|
4809
|
-
* @
|
4810
|
-
* @description Experimental functionality subject to change without notice.
|
4811
|
-
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4789
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
4812
4790
|
* by consumers of the pattern.
|
4791
|
+
*
|
4792
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4793
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4813
4794
|
*/
|
4814
4795
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4815
4796
|
};
|
4816
4797
|
/**
|
4817
|
-
* @
|
4818
|
-
*
|
4819
|
-
*
|
4798
|
+
* @description Defines how to override a specific component.
|
4799
|
+
*
|
4800
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4801
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4820
4802
|
*/
|
4821
4803
|
ComponentOverride: {
|
4822
4804
|
parameters?: {
|
@@ -4825,10 +4807,11 @@ interface external {
|
|
4825
4807
|
variant?: string;
|
4826
4808
|
};
|
4827
4809
|
/**
|
4828
|
-
* @
|
4829
|
-
*
|
4830
|
-
*
|
4831
|
-
* NOTE:
|
4810
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
4811
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
4812
|
+
*
|
4813
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4814
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4832
4815
|
*/
|
4833
4816
|
ComponentOverridability: {
|
4834
4817
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4839,13 +4822,15 @@ interface external {
|
|
4839
4822
|
variants?: boolean;
|
4840
4823
|
};
|
4841
4824
|
/**
|
4842
|
-
* @
|
4843
|
-
*
|
4825
|
+
* @description Whether a parameter is overridable
|
4826
|
+
*
|
4827
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4828
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4829
|
+
*
|
4844
4830
|
* @enum {string}
|
4845
4831
|
*/
|
4846
4832
|
OverrideOptions: "yes" | "no";
|
4847
4833
|
/**
|
4848
|
-
* @deprecated
|
4849
4834
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4850
4835
|
* These are created in the UI and shared across a whole project.
|
4851
4836
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4879,10 +4864,7 @@ interface external {
|
|
4879
4864
|
[key: string]: unknown;
|
4880
4865
|
};
|
4881
4866
|
};
|
4882
|
-
/**
|
4883
|
-
* @deprecated
|
4884
|
-
* @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.
|
4885
|
-
*/
|
4867
|
+
/** @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. */
|
4886
4868
|
DataType: {
|
4887
4869
|
/** @description Public ID of the data type */
|
4888
4870
|
id: string;
|
@@ -4939,10 +4921,7 @@ interface external {
|
|
4939
4921
|
[key: string]: unknown;
|
4940
4922
|
};
|
4941
4923
|
};
|
4942
|
-
/**
|
4943
|
-
* @deprecated
|
4944
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
4945
|
-
*/
|
4924
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
4946
4925
|
DataVariableDefinition: {
|
4947
4926
|
/** @description Display name of the data variable */
|
4948
4927
|
displayName?: string;
|
@@ -4959,17 +4938,13 @@ interface external {
|
|
4959
4938
|
order?: number;
|
4960
4939
|
};
|
4961
4940
|
/**
|
4962
|
-
* @deprecated
|
4963
4941
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4964
4942
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4965
4943
|
*/
|
4966
4944
|
DataResourceDefinitions: {
|
4967
4945
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4968
4946
|
};
|
4969
|
-
/**
|
4970
|
-
* @deprecated
|
4971
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
4972
|
-
*/
|
4947
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
4973
4948
|
DataResourceDefinition: {
|
4974
4949
|
/** @description Public ID of the data type that provides this data */
|
4975
4950
|
type: string;
|
@@ -4983,10 +4958,7 @@ interface external {
|
|
4983
4958
|
ignorePatternParameterDefault?: boolean;
|
4984
4959
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4985
4960
|
};
|
4986
|
-
/**
|
4987
|
-
* @deprecated
|
4988
|
-
* @description Variable values for a data resource.
|
4989
|
-
*/
|
4961
|
+
/** @description Variable values for a data resource. */
|
4990
4962
|
DataResourceVariables: {
|
4991
4963
|
[key: string]: string;
|
4992
4964
|
};
|
@@ -5121,9 +5093,7 @@ type InvalidationPayload = schemas['InvalidationPayload'];
|
|
5121
5093
|
type InvalidationResult = schemas['InvalidationResult'];
|
5122
5094
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
5123
5095
|
|
5124
|
-
/**
|
5125
|
-
* @deprecated
|
5126
|
-
*/
|
5096
|
+
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
5127
5097
|
declare class DataSourceClient extends ApiClient {
|
5128
5098
|
constructor(options: ClientOptions);
|
5129
5099
|
/** Fetches all DataSources for a project */
|
@@ -5190,9 +5160,7 @@ declare class DataSourceClient extends ApiClient {
|
|
5190
5160
|
remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
|
5191
5161
|
}
|
5192
5162
|
|
5193
|
-
/**
|
5194
|
-
* @deprecated
|
5195
|
-
*/
|
5163
|
+
/** API client to make comms with the Next Gen Mesh Data Type API simpler */
|
5196
5164
|
declare class DataTypeClient extends ApiClient {
|
5197
5165
|
#private;
|
5198
5166
|
constructor(options: ClientOptions);
|
@@ -5724,4 +5692,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
5724
5692
|
|
5725
5693
|
declare const CanvasClientError: typeof ApiClientError;
|
5726
5694
|
|
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,
|
5695
|
+
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, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, 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, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
|