@uniformdev/canvas 18.35.1-alpha.12 → 18.35.1-alpha.16
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 +379 -320
- package/dist/index.esm.js +39 -4
- package/dist/index.js +42 -4
- package/dist/index.mjs +39 -4
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -148,10 +148,8 @@ interface components$2 {
|
|
148
148
|
connectedData?: components$2["schemas"]["DataElementConnectionDefinition"];
|
149
149
|
};
|
150
150
|
/**
|
151
|
-
* @
|
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.
|
151
|
+
* @deprecated
|
152
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
155
153
|
*/
|
156
154
|
DataElementConnectionDefinition: {
|
157
155
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -186,6 +184,7 @@ interface components$2 {
|
|
186
184
|
_pattern?: string;
|
187
185
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
188
186
|
/**
|
187
|
+
* @deprecated
|
189
188
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
190
189
|
* Means nothing for PUTs; it will be ignored.
|
191
190
|
*/
|
@@ -202,26 +201,20 @@ interface components$2 {
|
|
202
201
|
*/
|
203
202
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
204
203
|
/**
|
205
|
-
* @
|
206
|
-
*
|
207
|
-
*
|
208
|
-
*
|
209
|
-
*
|
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.
|
204
|
+
* @deprecated
|
205
|
+
* @description Experimental functionality subject to change without notice.
|
206
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
207
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
208
|
+
* See `_overrides` on `RootComponentInstance`.
|
215
209
|
*/
|
216
210
|
_overrides?: {
|
217
211
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
218
212
|
};
|
219
213
|
/**
|
220
|
-
* @
|
214
|
+
* @deprecated
|
215
|
+
* @description Experimental functionality subject to change without notice.
|
216
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
221
217
|
* 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.
|
225
218
|
*/
|
226
219
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
227
220
|
};
|
@@ -249,34 +242,31 @@ interface components$2 {
|
|
249
242
|
_name: string;
|
250
243
|
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
251
244
|
/**
|
252
|
-
* @
|
245
|
+
* @deprecated
|
246
|
+
* @description Experimental functionality subject to change without notice.
|
247
|
+
* Defines patch overrides to component IDs that live in the composition.
|
253
248
|
* This can be used to override parameters that are defined on patterns,
|
254
249
|
* including nested patterns, with values that are specific to this composition.
|
255
250
|
* The keys in this object are component IDs.
|
256
251
|
* Overrides are applied from the top down, so for example if both the composition
|
257
252
|
* and a pattern on the composition define an override on a nested pattern,
|
258
253
|
* 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.
|
262
254
|
*/
|
263
255
|
_overrides?: {
|
264
256
|
[key: string]: components$2["schemas"]["ComponentOverride"];
|
265
257
|
};
|
266
258
|
/**
|
267
|
-
* @
|
259
|
+
* @deprecated
|
260
|
+
* @description Experimental functionality subject to change without notice.
|
261
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
268
262
|
* 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.
|
272
263
|
*/
|
273
264
|
_overridability?: components$2["schemas"]["ComponentOverridability"];
|
274
265
|
};
|
275
266
|
/**
|
276
|
-
* @
|
277
|
-
*
|
278
|
-
*
|
279
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
267
|
+
* @deprecated
|
268
|
+
* @description Experimental functionality subject to change without notice.
|
269
|
+
* Defines how to override a specific component.
|
280
270
|
*/
|
281
271
|
ComponentOverride: {
|
282
272
|
parameters?: {
|
@@ -285,11 +275,10 @@ interface components$2 {
|
|
285
275
|
variant?: string;
|
286
276
|
};
|
287
277
|
/**
|
288
|
-
* @
|
289
|
-
*
|
290
|
-
*
|
291
|
-
* NOTE:
|
292
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
278
|
+
* @deprecated
|
279
|
+
* @description Experimental functionality subject to change without notice.
|
280
|
+
* Defines how a component on a pattern may have its values overridden.
|
281
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
293
282
|
*/
|
294
283
|
ComponentOverridability: {
|
295
284
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -300,15 +289,13 @@ interface components$2 {
|
|
300
289
|
variants?: boolean;
|
301
290
|
};
|
302
291
|
/**
|
303
|
-
* @
|
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
|
-
*
|
292
|
+
* @deprecated
|
293
|
+
* @description Experimental functionality subject to change without notice.
|
308
294
|
* @enum {string}
|
309
295
|
*/
|
310
296
|
OverrideOptions: "yes" | "no";
|
311
297
|
/**
|
298
|
+
* @deprecated
|
312
299
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
313
300
|
* These are created in the UI and shared across a whole project.
|
314
301
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -342,7 +329,10 @@ interface components$2 {
|
|
342
329
|
[key: string]: unknown;
|
343
330
|
};
|
344
331
|
};
|
345
|
-
/**
|
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
|
+
*/
|
346
336
|
DataType: {
|
347
337
|
/** @description Public ID of the data type */
|
348
338
|
id: string;
|
@@ -399,7 +389,10 @@ interface components$2 {
|
|
399
389
|
[key: string]: unknown;
|
400
390
|
};
|
401
391
|
};
|
402
|
-
/**
|
392
|
+
/**
|
393
|
+
* @deprecated
|
394
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
395
|
+
*/
|
403
396
|
DataVariableDefinition: {
|
404
397
|
/** @description Display name of the data variable */
|
405
398
|
displayName?: string;
|
@@ -416,13 +409,17 @@ interface components$2 {
|
|
416
409
|
order?: number;
|
417
410
|
};
|
418
411
|
/**
|
412
|
+
* @deprecated
|
419
413
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
420
414
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
421
415
|
*/
|
422
416
|
DataResourceDefinitions: {
|
423
417
|
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
424
418
|
};
|
425
|
-
/**
|
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
|
+
*/
|
426
423
|
DataResourceDefinition: {
|
427
424
|
/** @description Public ID of the data type that provides this data */
|
428
425
|
type: string;
|
@@ -436,7 +433,10 @@ interface components$2 {
|
|
436
433
|
ignorePatternParameterDefault?: boolean;
|
437
434
|
variables?: components$2["schemas"]["DataResourceVariables"];
|
438
435
|
};
|
439
|
-
/**
|
436
|
+
/**
|
437
|
+
* @deprecated
|
438
|
+
* @description Variable values for a data resource.
|
439
|
+
*/
|
440
440
|
DataResourceVariables: {
|
441
441
|
[key: string]: string;
|
442
442
|
};
|
@@ -742,10 +742,8 @@ interface external$5 {
|
|
742
742
|
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
743
743
|
};
|
744
744
|
/**
|
745
|
-
* @
|
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.
|
745
|
+
* @deprecated
|
746
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
749
747
|
*/
|
750
748
|
DataElementConnectionDefinition: {
|
751
749
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -780,6 +778,7 @@ interface external$5 {
|
|
780
778
|
_pattern?: string;
|
781
779
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
782
780
|
/**
|
781
|
+
* @deprecated
|
783
782
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
784
783
|
* Means nothing for PUTs; it will be ignored.
|
785
784
|
*/
|
@@ -796,26 +795,20 @@ interface external$5 {
|
|
796
795
|
*/
|
797
796
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
798
797
|
/**
|
799
|
-
* @
|
800
|
-
*
|
801
|
-
*
|
802
|
-
*
|
803
|
-
*
|
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.
|
798
|
+
* @deprecated
|
799
|
+
* @description Experimental functionality subject to change without notice.
|
800
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
801
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
802
|
+
* See `_overrides` on `RootComponentInstance`.
|
809
803
|
*/
|
810
804
|
_overrides?: {
|
811
805
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
812
806
|
};
|
813
807
|
/**
|
814
|
-
* @
|
808
|
+
* @deprecated
|
809
|
+
* @description Experimental functionality subject to change without notice.
|
810
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
815
811
|
* 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.
|
819
812
|
*/
|
820
813
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
821
814
|
};
|
@@ -843,34 +836,31 @@ interface external$5 {
|
|
843
836
|
_name: string;
|
844
837
|
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
845
838
|
/**
|
846
|
-
* @
|
839
|
+
* @deprecated
|
840
|
+
* @description Experimental functionality subject to change without notice.
|
841
|
+
* Defines patch overrides to component IDs that live in the composition.
|
847
842
|
* This can be used to override parameters that are defined on patterns,
|
848
843
|
* including nested patterns, with values that are specific to this composition.
|
849
844
|
* The keys in this object are component IDs.
|
850
845
|
* Overrides are applied from the top down, so for example if both the composition
|
851
846
|
* and a pattern on the composition define an override on a nested pattern,
|
852
847
|
* 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.
|
856
848
|
*/
|
857
849
|
_overrides?: {
|
858
850
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
859
851
|
};
|
860
852
|
/**
|
861
|
-
* @
|
853
|
+
* @deprecated
|
854
|
+
* @description Experimental functionality subject to change without notice.
|
855
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
862
856
|
* 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.
|
866
857
|
*/
|
867
858
|
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
868
859
|
};
|
869
860
|
/**
|
870
|
-
* @
|
871
|
-
*
|
872
|
-
*
|
873
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
861
|
+
* @deprecated
|
862
|
+
* @description Experimental functionality subject to change without notice.
|
863
|
+
* Defines how to override a specific component.
|
874
864
|
*/
|
875
865
|
ComponentOverride: {
|
876
866
|
parameters?: {
|
@@ -879,11 +869,10 @@ interface external$5 {
|
|
879
869
|
variant?: string;
|
880
870
|
};
|
881
871
|
/**
|
882
|
-
* @
|
883
|
-
*
|
884
|
-
*
|
885
|
-
* NOTE:
|
886
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
872
|
+
* @deprecated
|
873
|
+
* @description Experimental functionality subject to change without notice.
|
874
|
+
* Defines how a component on a pattern may have its values overridden.
|
875
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
887
876
|
*/
|
888
877
|
ComponentOverridability: {
|
889
878
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -894,15 +883,13 @@ interface external$5 {
|
|
894
883
|
variants?: boolean;
|
895
884
|
};
|
896
885
|
/**
|
897
|
-
* @
|
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
|
-
*
|
886
|
+
* @deprecated
|
887
|
+
* @description Experimental functionality subject to change without notice.
|
902
888
|
* @enum {string}
|
903
889
|
*/
|
904
890
|
OverrideOptions: "yes" | "no";
|
905
891
|
/**
|
892
|
+
* @deprecated
|
906
893
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
907
894
|
* These are created in the UI and shared across a whole project.
|
908
895
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -936,7 +923,10 @@ interface external$5 {
|
|
936
923
|
[key: string]: unknown;
|
937
924
|
};
|
938
925
|
};
|
939
|
-
/**
|
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
|
+
*/
|
940
930
|
DataType: {
|
941
931
|
/** @description Public ID of the data type */
|
942
932
|
id: string;
|
@@ -993,7 +983,10 @@ interface external$5 {
|
|
993
983
|
[key: string]: unknown;
|
994
984
|
};
|
995
985
|
};
|
996
|
-
/**
|
986
|
+
/**
|
987
|
+
* @deprecated
|
988
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
989
|
+
*/
|
997
990
|
DataVariableDefinition: {
|
998
991
|
/** @description Display name of the data variable */
|
999
992
|
displayName?: string;
|
@@ -1010,13 +1003,17 @@ interface external$5 {
|
|
1010
1003
|
order?: number;
|
1011
1004
|
};
|
1012
1005
|
/**
|
1006
|
+
* @deprecated
|
1013
1007
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1014
1008
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1015
1009
|
*/
|
1016
1010
|
DataResourceDefinitions: {
|
1017
1011
|
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1018
1012
|
};
|
1019
|
-
/**
|
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
|
+
*/
|
1020
1017
|
DataResourceDefinition: {
|
1021
1018
|
/** @description Public ID of the data type that provides this data */
|
1022
1019
|
type: string;
|
@@ -1030,7 +1027,10 @@ interface external$5 {
|
|
1030
1027
|
ignorePatternParameterDefault?: boolean;
|
1031
1028
|
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1032
1029
|
};
|
1033
|
-
/**
|
1030
|
+
/**
|
1031
|
+
* @deprecated
|
1032
|
+
* @description Variable values for a data resource.
|
1033
|
+
*/
|
1034
1034
|
DataResourceVariables: {
|
1035
1035
|
[key: string]: string;
|
1036
1036
|
};
|
@@ -1065,6 +1065,14 @@ 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;
|
1068
1076
|
/** The definition of a component parameter */
|
1069
1077
|
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1070
1078
|
typeConfig?: TConfig;
|
@@ -1079,6 +1087,8 @@ type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
|
|
1079
1087
|
type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
|
1080
1088
|
/** Defines a component type that can live on a Composition */
|
1081
1089
|
type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
1090
|
+
/** @deprecated use ComponentDefinition instead */
|
1091
|
+
type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
|
1082
1092
|
|
1083
1093
|
/**
|
1084
1094
|
* This file was auto-generated by openapi-typescript.
|
@@ -1136,7 +1146,7 @@ interface paths$3 {
|
|
1136
1146
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
1137
1147
|
skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
|
1138
1148
|
/**
|
1139
|
-
* If true, any pattern override data is not resolved by the API.
|
1149
|
+
* @deprecated If true, any pattern override data is not resolved by the API.
|
1140
1150
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1141
1151
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
1142
1152
|
*/
|
@@ -1345,6 +1355,7 @@ interface components$1 {
|
|
1345
1355
|
*/
|
1346
1356
|
skipPatternResolution: boolean;
|
1347
1357
|
/**
|
1358
|
+
* @deprecated
|
1348
1359
|
* @description If true, any pattern override data is not resolved by the API.
|
1349
1360
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1350
1361
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -1589,10 +1600,8 @@ interface external$4 {
|
|
1589
1600
|
connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1590
1601
|
};
|
1591
1602
|
/**
|
1592
|
-
* @
|
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.
|
1603
|
+
* @deprecated
|
1604
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1596
1605
|
*/
|
1597
1606
|
DataElementConnectionDefinition: {
|
1598
1607
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -1627,6 +1636,7 @@ interface external$4 {
|
|
1627
1636
|
_pattern?: string;
|
1628
1637
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1629
1638
|
/**
|
1639
|
+
* @deprecated
|
1630
1640
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1631
1641
|
* Means nothing for PUTs; it will be ignored.
|
1632
1642
|
*/
|
@@ -1643,26 +1653,20 @@ interface external$4 {
|
|
1643
1653
|
*/
|
1644
1654
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
1645
1655
|
/**
|
1646
|
-
* @
|
1647
|
-
*
|
1648
|
-
*
|
1649
|
-
*
|
1650
|
-
*
|
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.
|
1656
|
+
* @deprecated
|
1657
|
+
* @description Experimental functionality subject to change without notice.
|
1658
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
1659
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
1660
|
+
* See `_overrides` on `RootComponentInstance`.
|
1656
1661
|
*/
|
1657
1662
|
_overrides?: {
|
1658
1663
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1659
1664
|
};
|
1660
1665
|
/**
|
1661
|
-
* @
|
1666
|
+
* @deprecated
|
1667
|
+
* @description Experimental functionality subject to change without notice.
|
1668
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1662
1669
|
* 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.
|
1666
1670
|
*/
|
1667
1671
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1668
1672
|
};
|
@@ -1690,34 +1694,31 @@ interface external$4 {
|
|
1690
1694
|
_name: string;
|
1691
1695
|
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1692
1696
|
/**
|
1693
|
-
* @
|
1697
|
+
* @deprecated
|
1698
|
+
* @description Experimental functionality subject to change without notice.
|
1699
|
+
* Defines patch overrides to component IDs that live in the composition.
|
1694
1700
|
* This can be used to override parameters that are defined on patterns,
|
1695
1701
|
* including nested patterns, with values that are specific to this composition.
|
1696
1702
|
* The keys in this object are component IDs.
|
1697
1703
|
* Overrides are applied from the top down, so for example if both the composition
|
1698
1704
|
* and a pattern on the composition define an override on a nested pattern,
|
1699
1705
|
* 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.
|
1703
1706
|
*/
|
1704
1707
|
_overrides?: {
|
1705
1708
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1706
1709
|
};
|
1707
1710
|
/**
|
1708
|
-
* @
|
1711
|
+
* @deprecated
|
1712
|
+
* @description Experimental functionality subject to change without notice.
|
1713
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
1709
1714
|
* 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.
|
1713
1715
|
*/
|
1714
1716
|
_overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1715
1717
|
};
|
1716
1718
|
/**
|
1717
|
-
* @
|
1718
|
-
*
|
1719
|
-
*
|
1720
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1719
|
+
* @deprecated
|
1720
|
+
* @description Experimental functionality subject to change without notice.
|
1721
|
+
* Defines how to override a specific component.
|
1721
1722
|
*/
|
1722
1723
|
ComponentOverride: {
|
1723
1724
|
parameters?: {
|
@@ -1726,11 +1727,10 @@ interface external$4 {
|
|
1726
1727
|
variant?: string;
|
1727
1728
|
};
|
1728
1729
|
/**
|
1729
|
-
* @
|
1730
|
-
*
|
1731
|
-
*
|
1732
|
-
* NOTE:
|
1733
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1730
|
+
* @deprecated
|
1731
|
+
* @description Experimental functionality subject to change without notice.
|
1732
|
+
* Defines how a component on a pattern may have its values overridden.
|
1733
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
1734
1734
|
*/
|
1735
1735
|
ComponentOverridability: {
|
1736
1736
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -1741,15 +1741,13 @@ interface external$4 {
|
|
1741
1741
|
variants?: boolean;
|
1742
1742
|
};
|
1743
1743
|
/**
|
1744
|
-
* @
|
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
|
-
*
|
1744
|
+
* @deprecated
|
1745
|
+
* @description Experimental functionality subject to change without notice.
|
1749
1746
|
* @enum {string}
|
1750
1747
|
*/
|
1751
1748
|
OverrideOptions: "yes" | "no";
|
1752
1749
|
/**
|
1750
|
+
* @deprecated
|
1753
1751
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
1754
1752
|
* These are created in the UI and shared across a whole project.
|
1755
1753
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -1783,7 +1781,10 @@ interface external$4 {
|
|
1783
1781
|
[key: string]: unknown;
|
1784
1782
|
};
|
1785
1783
|
};
|
1786
|
-
/**
|
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
|
+
*/
|
1787
1788
|
DataType: {
|
1788
1789
|
/** @description Public ID of the data type */
|
1789
1790
|
id: string;
|
@@ -1840,7 +1841,10 @@ interface external$4 {
|
|
1840
1841
|
[key: string]: unknown;
|
1841
1842
|
};
|
1842
1843
|
};
|
1843
|
-
/**
|
1844
|
+
/**
|
1845
|
+
* @deprecated
|
1846
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1847
|
+
*/
|
1844
1848
|
DataVariableDefinition: {
|
1845
1849
|
/** @description Display name of the data variable */
|
1846
1850
|
displayName?: string;
|
@@ -1857,13 +1861,17 @@ interface external$4 {
|
|
1857
1861
|
order?: number;
|
1858
1862
|
};
|
1859
1863
|
/**
|
1864
|
+
* @deprecated
|
1860
1865
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1861
1866
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1862
1867
|
*/
|
1863
1868
|
DataResourceDefinitions: {
|
1864
1869
|
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1865
1870
|
};
|
1866
|
-
/**
|
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
|
+
*/
|
1867
1875
|
DataResourceDefinition: {
|
1868
1876
|
/** @description Public ID of the data type that provides this data */
|
1869
1877
|
type: string;
|
@@ -1877,7 +1885,10 @@ interface external$4 {
|
|
1877
1885
|
ignorePatternParameterDefault?: boolean;
|
1878
1886
|
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1879
1887
|
};
|
1880
|
-
/**
|
1888
|
+
/**
|
1889
|
+
* @deprecated
|
1890
|
+
* @description Variable values for a data resource.
|
1891
|
+
*/
|
1881
1892
|
DataResourceVariables: {
|
1882
1893
|
[key: string]: string;
|
1883
1894
|
};
|
@@ -2232,10 +2243,8 @@ interface external$3 {
|
|
2232
2243
|
connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2233
2244
|
};
|
2234
2245
|
/**
|
2235
|
-
* @
|
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.
|
2246
|
+
* @deprecated
|
2247
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2239
2248
|
*/
|
2240
2249
|
DataElementConnectionDefinition: {
|
2241
2250
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -2270,6 +2279,7 @@ interface external$3 {
|
|
2270
2279
|
_pattern?: string;
|
2271
2280
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2272
2281
|
/**
|
2282
|
+
* @deprecated
|
2273
2283
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2274
2284
|
* Means nothing for PUTs; it will be ignored.
|
2275
2285
|
*/
|
@@ -2286,26 +2296,20 @@ interface external$3 {
|
|
2286
2296
|
*/
|
2287
2297
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
2288
2298
|
/**
|
2289
|
-
* @
|
2290
|
-
*
|
2291
|
-
*
|
2292
|
-
*
|
2293
|
-
*
|
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.
|
2299
|
+
* @deprecated
|
2300
|
+
* @description Experimental functionality subject to change without notice.
|
2301
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
2302
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
2303
|
+
* See `_overrides` on `RootComponentInstance`.
|
2299
2304
|
*/
|
2300
2305
|
_overrides?: {
|
2301
2306
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2302
2307
|
};
|
2303
2308
|
/**
|
2304
|
-
* @
|
2309
|
+
* @deprecated
|
2310
|
+
* @description Experimental functionality subject to change without notice.
|
2311
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2305
2312
|
* 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.
|
2309
2313
|
*/
|
2310
2314
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2311
2315
|
};
|
@@ -2333,34 +2337,31 @@ interface external$3 {
|
|
2333
2337
|
_name: string;
|
2334
2338
|
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2335
2339
|
/**
|
2336
|
-
* @
|
2340
|
+
* @deprecated
|
2341
|
+
* @description Experimental functionality subject to change without notice.
|
2342
|
+
* Defines patch overrides to component IDs that live in the composition.
|
2337
2343
|
* This can be used to override parameters that are defined on patterns,
|
2338
2344
|
* including nested patterns, with values that are specific to this composition.
|
2339
2345
|
* The keys in this object are component IDs.
|
2340
2346
|
* Overrides are applied from the top down, so for example if both the composition
|
2341
2347
|
* and a pattern on the composition define an override on a nested pattern,
|
2342
2348
|
* 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.
|
2346
2349
|
*/
|
2347
2350
|
_overrides?: {
|
2348
2351
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2349
2352
|
};
|
2350
2353
|
/**
|
2351
|
-
* @
|
2354
|
+
* @deprecated
|
2355
|
+
* @description Experimental functionality subject to change without notice.
|
2356
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
2352
2357
|
* 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.
|
2356
2358
|
*/
|
2357
2359
|
_overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2358
2360
|
};
|
2359
2361
|
/**
|
2360
|
-
* @
|
2361
|
-
*
|
2362
|
-
*
|
2363
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2362
|
+
* @deprecated
|
2363
|
+
* @description Experimental functionality subject to change without notice.
|
2364
|
+
* Defines how to override a specific component.
|
2364
2365
|
*/
|
2365
2366
|
ComponentOverride: {
|
2366
2367
|
parameters?: {
|
@@ -2369,11 +2370,10 @@ interface external$3 {
|
|
2369
2370
|
variant?: string;
|
2370
2371
|
};
|
2371
2372
|
/**
|
2372
|
-
* @
|
2373
|
-
*
|
2374
|
-
*
|
2375
|
-
* NOTE:
|
2376
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2373
|
+
* @deprecated
|
2374
|
+
* @description Experimental functionality subject to change without notice.
|
2375
|
+
* Defines how a component on a pattern may have its values overridden.
|
2376
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
2377
2377
|
*/
|
2378
2378
|
ComponentOverridability: {
|
2379
2379
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -2384,15 +2384,13 @@ interface external$3 {
|
|
2384
2384
|
variants?: boolean;
|
2385
2385
|
};
|
2386
2386
|
/**
|
2387
|
-
* @
|
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
|
-
*
|
2387
|
+
* @deprecated
|
2388
|
+
* @description Experimental functionality subject to change without notice.
|
2392
2389
|
* @enum {string}
|
2393
2390
|
*/
|
2394
2391
|
OverrideOptions: "yes" | "no";
|
2395
2392
|
/**
|
2393
|
+
* @deprecated
|
2396
2394
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
2397
2395
|
* These are created in the UI and shared across a whole project.
|
2398
2396
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -2426,7 +2424,10 @@ interface external$3 {
|
|
2426
2424
|
[key: string]: unknown;
|
2427
2425
|
};
|
2428
2426
|
};
|
2429
|
-
/**
|
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
|
+
*/
|
2430
2431
|
DataType: {
|
2431
2432
|
/** @description Public ID of the data type */
|
2432
2433
|
id: string;
|
@@ -2483,7 +2484,10 @@ interface external$3 {
|
|
2483
2484
|
[key: string]: unknown;
|
2484
2485
|
};
|
2485
2486
|
};
|
2486
|
-
/**
|
2487
|
+
/**
|
2488
|
+
* @deprecated
|
2489
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2490
|
+
*/
|
2487
2491
|
DataVariableDefinition: {
|
2488
2492
|
/** @description Display name of the data variable */
|
2489
2493
|
displayName?: string;
|
@@ -2500,13 +2504,17 @@ interface external$3 {
|
|
2500
2504
|
order?: number;
|
2501
2505
|
};
|
2502
2506
|
/**
|
2507
|
+
* @deprecated
|
2503
2508
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2504
2509
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2505
2510
|
*/
|
2506
2511
|
DataResourceDefinitions: {
|
2507
2512
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2508
2513
|
};
|
2509
|
-
/**
|
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
|
+
*/
|
2510
2518
|
DataResourceDefinition: {
|
2511
2519
|
/** @description Public ID of the data type that provides this data */
|
2512
2520
|
type: string;
|
@@ -2520,7 +2528,10 @@ interface external$3 {
|
|
2520
2528
|
ignorePatternParameterDefault?: boolean;
|
2521
2529
|
variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2522
2530
|
};
|
2523
|
-
/**
|
2531
|
+
/**
|
2532
|
+
* @deprecated
|
2533
|
+
* @description Variable values for a data resource.
|
2534
|
+
*/
|
2524
2535
|
DataResourceVariables: {
|
2525
2536
|
[key: string]: string;
|
2526
2537
|
};
|
@@ -2596,7 +2607,7 @@ interface external$3 {
|
|
2596
2607
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2597
2608
|
skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2598
2609
|
/**
|
2599
|
-
* If true, any pattern override data is not resolved by the API.
|
2610
|
+
* @deprecated If true, any pattern override data is not resolved by the API.
|
2600
2611
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2601
2612
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2602
2613
|
*/
|
@@ -2805,6 +2816,7 @@ interface external$3 {
|
|
2805
2816
|
*/
|
2806
2817
|
skipPatternResolution: boolean;
|
2807
2818
|
/**
|
2819
|
+
* @deprecated
|
2808
2820
|
* @description If true, any pattern override data is not resolved by the API.
|
2809
2821
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2810
2822
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
@@ -2883,11 +2895,26 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
|
|
2883
2895
|
type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
|
2884
2896
|
/** Shape of the DELETE request body for /api/v1/canvas */
|
2885
2897
|
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;
|
2886
2906
|
/** Defines an editable parameter on a component. */
|
2887
2907
|
type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
|
2888
2908
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2889
2909
|
value: TValue;
|
2890
2910
|
};
|
2911
|
+
/** The type of the parameters in contextual editing mode. */
|
2912
|
+
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
2913
|
+
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
2914
|
+
_contextualEditing?: {
|
2915
|
+
isEditable?: boolean;
|
2916
|
+
};
|
2917
|
+
};
|
2891
2918
|
/** Defines a connection to a data element on a data resource. */
|
2892
2919
|
type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
2893
2920
|
/** Variable values for a data resource. */
|
@@ -2908,18 +2935,22 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
|
2908
2935
|
type RootComponentInstance = SharedComponents['RootComponentInstance'];
|
2909
2936
|
/**
|
2910
2937
|
* Defines the shape of a component override
|
2938
|
+
* @deprecated
|
2911
2939
|
*/
|
2912
2940
|
type OverrideOptions = SharedComponents['OverrideOptions'];
|
2913
2941
|
/**
|
2914
2942
|
* Defines the shape of a component override
|
2943
|
+
* @deprecated
|
2915
2944
|
*/
|
2916
2945
|
type ComponentOverride = SharedComponents['ComponentOverride'];
|
2917
2946
|
/**
|
2918
2947
|
* Defines a set of component overrides by component ID
|
2948
|
+
* @deprecated
|
2919
2949
|
*/
|
2920
2950
|
type ComponentOverrides = Record<string, ComponentOverride>;
|
2921
2951
|
/**
|
2922
2952
|
* Defines how a component on a pattern may have its values overridden
|
2953
|
+
* @deprecated
|
2923
2954
|
*/
|
2924
2955
|
type ComponentOverridability = SharedComponents['ComponentOverridability'];
|
2925
2956
|
/** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
|
@@ -2941,20 +2972,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
|
2941
2972
|
type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2942
2973
|
/** Switches for data resolution */
|
2943
2974
|
type DataResolutionOption = {
|
2944
|
-
|
2975
|
+
unstable_resolveData?: boolean;
|
2945
2976
|
};
|
2946
2977
|
type DataResolutionOptionNegative = {
|
2947
|
-
|
2978
|
+
unstable_resolveData?: false;
|
2948
2979
|
};
|
2949
2980
|
type DataResolutionOptionPositive = {
|
2950
|
-
|
2981
|
+
unstable_resolveData: true;
|
2951
2982
|
};
|
2952
2983
|
type DataResolutionParameters = {
|
2953
2984
|
/**
|
2954
2985
|
* Adds additional diagnostics about edge request processing to the response (`diagnostics`).
|
2955
2986
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
2956
2987
|
*/
|
2957
|
-
|
2988
|
+
unstable_diagnostics?: boolean;
|
2958
2989
|
/**
|
2959
2990
|
* Pass dynamic variables to the composition that are required for resolving bindings and datas,
|
2960
2991
|
* such as language, detail page ID, etc.
|
@@ -3160,10 +3191,14 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
3160
3191
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3161
3192
|
getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3162
3193
|
getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3194
|
+
/** @deprecated use getCompositionByNodePath instead */
|
3195
|
+
unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3163
3196
|
/** Fetches one composition by its project map node ID */
|
3164
3197
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3165
3198
|
getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
3166
3199
|
getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
3200
|
+
/** @deprecated Use getCompositionByNodeId instead */
|
3201
|
+
unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
|
3167
3202
|
/** Fetches one composition by its slug */
|
3168
3203
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
3169
3204
|
getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
@@ -3344,7 +3379,7 @@ interface paths$2 {
|
|
3344
3379
|
/**
|
3345
3380
|
* Format: uuid
|
3346
3381
|
* @deprecated
|
3347
|
-
* @description Do not use.
|
3382
|
+
* @description Do not use. Will be removed in future.
|
3348
3383
|
*/
|
3349
3384
|
integrationId?: string;
|
3350
3385
|
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
@@ -3563,10 +3598,8 @@ interface external$2 {
|
|
3563
3598
|
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3564
3599
|
};
|
3565
3600
|
/**
|
3566
|
-
* @
|
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.
|
3601
|
+
* @deprecated
|
3602
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
3570
3603
|
*/
|
3571
3604
|
DataElementConnectionDefinition: {
|
3572
3605
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -3601,6 +3634,7 @@ interface external$2 {
|
|
3601
3634
|
_pattern?: string;
|
3602
3635
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3603
3636
|
/**
|
3637
|
+
* @deprecated
|
3604
3638
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3605
3639
|
* Means nothing for PUTs; it will be ignored.
|
3606
3640
|
*/
|
@@ -3617,26 +3651,20 @@ interface external$2 {
|
|
3617
3651
|
*/
|
3618
3652
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
3619
3653
|
/**
|
3620
|
-
* @
|
3621
|
-
*
|
3622
|
-
*
|
3623
|
-
*
|
3624
|
-
*
|
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.
|
3654
|
+
* @deprecated
|
3655
|
+
* @description Experimental functionality subject to change without notice.
|
3656
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
3657
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
3658
|
+
* See `_overrides` on `RootComponentInstance`.
|
3630
3659
|
*/
|
3631
3660
|
_overrides?: {
|
3632
3661
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3633
3662
|
};
|
3634
3663
|
/**
|
3635
|
-
* @
|
3664
|
+
* @deprecated
|
3665
|
+
* @description Experimental functionality subject to change without notice.
|
3666
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3636
3667
|
* 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.
|
3640
3668
|
*/
|
3641
3669
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3642
3670
|
};
|
@@ -3664,34 +3692,31 @@ interface external$2 {
|
|
3664
3692
|
_name: string;
|
3665
3693
|
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3666
3694
|
/**
|
3667
|
-
* @
|
3695
|
+
* @deprecated
|
3696
|
+
* @description Experimental functionality subject to change without notice.
|
3697
|
+
* Defines patch overrides to component IDs that live in the composition.
|
3668
3698
|
* This can be used to override parameters that are defined on patterns,
|
3669
3699
|
* including nested patterns, with values that are specific to this composition.
|
3670
3700
|
* The keys in this object are component IDs.
|
3671
3701
|
* Overrides are applied from the top down, so for example if both the composition
|
3672
3702
|
* and a pattern on the composition define an override on a nested pattern,
|
3673
3703
|
* 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.
|
3677
3704
|
*/
|
3678
3705
|
_overrides?: {
|
3679
3706
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3680
3707
|
};
|
3681
3708
|
/**
|
3682
|
-
* @
|
3709
|
+
* @deprecated
|
3710
|
+
* @description Experimental functionality subject to change without notice.
|
3711
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
3683
3712
|
* 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.
|
3687
3713
|
*/
|
3688
3714
|
_overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3689
3715
|
};
|
3690
3716
|
/**
|
3691
|
-
* @
|
3692
|
-
*
|
3693
|
-
*
|
3694
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3717
|
+
* @deprecated
|
3718
|
+
* @description Experimental functionality subject to change without notice.
|
3719
|
+
* Defines how to override a specific component.
|
3695
3720
|
*/
|
3696
3721
|
ComponentOverride: {
|
3697
3722
|
parameters?: {
|
@@ -3700,11 +3725,10 @@ interface external$2 {
|
|
3700
3725
|
variant?: string;
|
3701
3726
|
};
|
3702
3727
|
/**
|
3703
|
-
* @
|
3704
|
-
*
|
3705
|
-
*
|
3706
|
-
* NOTE:
|
3707
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3728
|
+
* @deprecated
|
3729
|
+
* @description Experimental functionality subject to change without notice.
|
3730
|
+
* Defines how a component on a pattern may have its values overridden.
|
3731
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
3708
3732
|
*/
|
3709
3733
|
ComponentOverridability: {
|
3710
3734
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -3715,15 +3739,13 @@ interface external$2 {
|
|
3715
3739
|
variants?: boolean;
|
3716
3740
|
};
|
3717
3741
|
/**
|
3718
|
-
* @
|
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
|
-
*
|
3742
|
+
* @deprecated
|
3743
|
+
* @description Experimental functionality subject to change without notice.
|
3723
3744
|
* @enum {string}
|
3724
3745
|
*/
|
3725
3746
|
OverrideOptions: "yes" | "no";
|
3726
3747
|
/**
|
3748
|
+
* @deprecated
|
3727
3749
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
3728
3750
|
* These are created in the UI and shared across a whole project.
|
3729
3751
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -3757,7 +3779,10 @@ interface external$2 {
|
|
3757
3779
|
[key: string]: unknown;
|
3758
3780
|
};
|
3759
3781
|
};
|
3760
|
-
/**
|
3782
|
+
/**
|
3783
|
+
* @deprecated
|
3784
|
+
* @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.
|
3785
|
+
*/
|
3761
3786
|
DataType: {
|
3762
3787
|
/** @description Public ID of the data type */
|
3763
3788
|
id: string;
|
@@ -3814,7 +3839,10 @@ interface external$2 {
|
|
3814
3839
|
[key: string]: unknown;
|
3815
3840
|
};
|
3816
3841
|
};
|
3817
|
-
/**
|
3842
|
+
/**
|
3843
|
+
* @deprecated
|
3844
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
3845
|
+
*/
|
3818
3846
|
DataVariableDefinition: {
|
3819
3847
|
/** @description Display name of the data variable */
|
3820
3848
|
displayName?: string;
|
@@ -3831,13 +3859,17 @@ interface external$2 {
|
|
3831
3859
|
order?: number;
|
3832
3860
|
};
|
3833
3861
|
/**
|
3862
|
+
* @deprecated
|
3834
3863
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
3835
3864
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3836
3865
|
*/
|
3837
3866
|
DataResourceDefinitions: {
|
3838
3867
|
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3839
3868
|
};
|
3840
|
-
/**
|
3869
|
+
/**
|
3870
|
+
* @deprecated
|
3871
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
3872
|
+
*/
|
3841
3873
|
DataResourceDefinition: {
|
3842
3874
|
/** @description Public ID of the data type that provides this data */
|
3843
3875
|
type: string;
|
@@ -3851,7 +3883,10 @@ interface external$2 {
|
|
3851
3883
|
ignorePatternParameterDefault?: boolean;
|
3852
3884
|
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3853
3885
|
};
|
3854
|
-
/**
|
3886
|
+
/**
|
3887
|
+
* @deprecated
|
3888
|
+
* @description Variable values for a data resource.
|
3889
|
+
*/
|
3855
3890
|
DataResourceVariables: {
|
3856
3891
|
[key: string]: string;
|
3857
3892
|
};
|
@@ -4099,10 +4134,8 @@ interface external$1 {
|
|
4099
4134
|
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4100
4135
|
};
|
4101
4136
|
/**
|
4102
|
-
* @
|
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.
|
4137
|
+
* @deprecated
|
4138
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
4106
4139
|
*/
|
4107
4140
|
DataElementConnectionDefinition: {
|
4108
4141
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4137,6 +4170,7 @@ interface external$1 {
|
|
4137
4170
|
_pattern?: string;
|
4138
4171
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4139
4172
|
/**
|
4173
|
+
* @deprecated
|
4140
4174
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4141
4175
|
* Means nothing for PUTs; it will be ignored.
|
4142
4176
|
*/
|
@@ -4153,26 +4187,20 @@ interface external$1 {
|
|
4153
4187
|
*/
|
4154
4188
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4155
4189
|
/**
|
4156
|
-
* @
|
4157
|
-
*
|
4158
|
-
*
|
4159
|
-
*
|
4160
|
-
*
|
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.
|
4190
|
+
* @deprecated
|
4191
|
+
* @description Experimental functionality subject to change without notice.
|
4192
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
4193
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
4194
|
+
* See `_overrides` on `RootComponentInstance`.
|
4166
4195
|
*/
|
4167
4196
|
_overrides?: {
|
4168
4197
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4169
4198
|
};
|
4170
4199
|
/**
|
4171
|
-
* @
|
4200
|
+
* @deprecated
|
4201
|
+
* @description Experimental functionality subject to change without notice.
|
4202
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4172
4203
|
* 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.
|
4176
4204
|
*/
|
4177
4205
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4178
4206
|
};
|
@@ -4200,34 +4228,31 @@ interface external$1 {
|
|
4200
4228
|
_name: string;
|
4201
4229
|
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4202
4230
|
/**
|
4203
|
-
* @
|
4231
|
+
* @deprecated
|
4232
|
+
* @description Experimental functionality subject to change without notice.
|
4233
|
+
* Defines patch overrides to component IDs that live in the composition.
|
4204
4234
|
* This can be used to override parameters that are defined on patterns,
|
4205
4235
|
* including nested patterns, with values that are specific to this composition.
|
4206
4236
|
* The keys in this object are component IDs.
|
4207
4237
|
* Overrides are applied from the top down, so for example if both the composition
|
4208
4238
|
* and a pattern on the composition define an override on a nested pattern,
|
4209
4239
|
* 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.
|
4213
4240
|
*/
|
4214
4241
|
_overrides?: {
|
4215
4242
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4216
4243
|
};
|
4217
4244
|
/**
|
4218
|
-
* @
|
4245
|
+
* @deprecated
|
4246
|
+
* @description Experimental functionality subject to change without notice.
|
4247
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4219
4248
|
* 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.
|
4223
4249
|
*/
|
4224
4250
|
_overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4225
4251
|
};
|
4226
4252
|
/**
|
4227
|
-
* @
|
4228
|
-
*
|
4229
|
-
*
|
4230
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4253
|
+
* @deprecated
|
4254
|
+
* @description Experimental functionality subject to change without notice.
|
4255
|
+
* Defines how to override a specific component.
|
4231
4256
|
*/
|
4232
4257
|
ComponentOverride: {
|
4233
4258
|
parameters?: {
|
@@ -4236,11 +4261,10 @@ interface external$1 {
|
|
4236
4261
|
variant?: string;
|
4237
4262
|
};
|
4238
4263
|
/**
|
4239
|
-
* @
|
4240
|
-
*
|
4241
|
-
*
|
4242
|
-
* NOTE:
|
4243
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4264
|
+
* @deprecated
|
4265
|
+
* @description Experimental functionality subject to change without notice.
|
4266
|
+
* Defines how a component on a pattern may have its values overridden.
|
4267
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
4244
4268
|
*/
|
4245
4269
|
ComponentOverridability: {
|
4246
4270
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4251,15 +4275,13 @@ interface external$1 {
|
|
4251
4275
|
variants?: boolean;
|
4252
4276
|
};
|
4253
4277
|
/**
|
4254
|
-
* @
|
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
|
-
*
|
4278
|
+
* @deprecated
|
4279
|
+
* @description Experimental functionality subject to change without notice.
|
4259
4280
|
* @enum {string}
|
4260
4281
|
*/
|
4261
4282
|
OverrideOptions: "yes" | "no";
|
4262
4283
|
/**
|
4284
|
+
* @deprecated
|
4263
4285
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4264
4286
|
* These are created in the UI and shared across a whole project.
|
4265
4287
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4293,7 +4315,10 @@ interface external$1 {
|
|
4293
4315
|
[key: string]: unknown;
|
4294
4316
|
};
|
4295
4317
|
};
|
4296
|
-
/**
|
4318
|
+
/**
|
4319
|
+
* @deprecated
|
4320
|
+
* @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.
|
4321
|
+
*/
|
4297
4322
|
DataType: {
|
4298
4323
|
/** @description Public ID of the data type */
|
4299
4324
|
id: string;
|
@@ -4350,7 +4375,10 @@ interface external$1 {
|
|
4350
4375
|
[key: string]: unknown;
|
4351
4376
|
};
|
4352
4377
|
};
|
4353
|
-
/**
|
4378
|
+
/**
|
4379
|
+
* @deprecated
|
4380
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
4381
|
+
*/
|
4354
4382
|
DataVariableDefinition: {
|
4355
4383
|
/** @description Display name of the data variable */
|
4356
4384
|
displayName?: string;
|
@@ -4367,13 +4395,17 @@ interface external$1 {
|
|
4367
4395
|
order?: number;
|
4368
4396
|
};
|
4369
4397
|
/**
|
4398
|
+
* @deprecated
|
4370
4399
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4371
4400
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4372
4401
|
*/
|
4373
4402
|
DataResourceDefinitions: {
|
4374
4403
|
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4375
4404
|
};
|
4376
|
-
/**
|
4405
|
+
/**
|
4406
|
+
* @deprecated
|
4407
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
4408
|
+
*/
|
4377
4409
|
DataResourceDefinition: {
|
4378
4410
|
/** @description Public ID of the data type that provides this data */
|
4379
4411
|
type: string;
|
@@ -4387,7 +4419,10 @@ interface external$1 {
|
|
4387
4419
|
ignorePatternParameterDefault?: boolean;
|
4388
4420
|
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4389
4421
|
};
|
4390
|
-
/**
|
4422
|
+
/**
|
4423
|
+
* @deprecated
|
4424
|
+
* @description Variable values for a data resource.
|
4425
|
+
*/
|
4391
4426
|
DataResourceVariables: {
|
4392
4427
|
[key: string]: string;
|
4393
4428
|
};
|
@@ -4670,10 +4705,8 @@ interface external {
|
|
4670
4705
|
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
4671
4706
|
};
|
4672
4707
|
/**
|
4673
|
-
* @
|
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.
|
4708
|
+
* @deprecated
|
4709
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
4677
4710
|
*/
|
4678
4711
|
DataElementConnectionDefinition: {
|
4679
4712
|
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
@@ -4708,6 +4741,7 @@ interface external {
|
|
4708
4741
|
_pattern?: string;
|
4709
4742
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4710
4743
|
/**
|
4744
|
+
* @deprecated
|
4711
4745
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
4712
4746
|
* Means nothing for PUTs; it will be ignored.
|
4713
4747
|
*/
|
@@ -4724,26 +4758,20 @@ interface external {
|
|
4724
4758
|
*/
|
4725
4759
|
_patternError?: "NOTFOUND" | "CYCLIC";
|
4726
4760
|
/**
|
4727
|
-
* @
|
4728
|
-
*
|
4729
|
-
*
|
4730
|
-
*
|
4731
|
-
*
|
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.
|
4761
|
+
* @deprecated
|
4762
|
+
* @description Experimental functionality subject to change without notice.
|
4763
|
+
* Contains overrides that are defined on a pattern instance reference nested in a composition.
|
4764
|
+
* This is always undefined unless `skipOverridesResolution` is true.
|
4765
|
+
* See `_overrides` on `RootComponentInstance`.
|
4737
4766
|
*/
|
4738
4767
|
_overrides?: {
|
4739
4768
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4740
4769
|
};
|
4741
4770
|
/**
|
4742
|
-
* @
|
4771
|
+
* @deprecated
|
4772
|
+
* @description Experimental functionality subject to change without notice.
|
4773
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4743
4774
|
* 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.
|
4747
4775
|
*/
|
4748
4776
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4749
4777
|
};
|
@@ -4771,34 +4799,31 @@ interface external {
|
|
4771
4799
|
_name: string;
|
4772
4800
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
4773
4801
|
/**
|
4774
|
-
* @
|
4802
|
+
* @deprecated
|
4803
|
+
* @description Experimental functionality subject to change without notice.
|
4804
|
+
* Defines patch overrides to component IDs that live in the composition.
|
4775
4805
|
* This can be used to override parameters that are defined on patterns,
|
4776
4806
|
* including nested patterns, with values that are specific to this composition.
|
4777
4807
|
* The keys in this object are component IDs.
|
4778
4808
|
* Overrides are applied from the top down, so for example if both the composition
|
4779
4809
|
* and a pattern on the composition define an override on a nested pattern,
|
4780
4810
|
* 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.
|
4784
4811
|
*/
|
4785
4812
|
_overrides?: {
|
4786
4813
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
4787
4814
|
};
|
4788
4815
|
/**
|
4789
|
-
* @
|
4816
|
+
* @deprecated
|
4817
|
+
* @description Experimental functionality subject to change without notice.
|
4818
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
4790
4819
|
* 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.
|
4794
4820
|
*/
|
4795
4821
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
4796
4822
|
};
|
4797
4823
|
/**
|
4798
|
-
* @
|
4799
|
-
*
|
4800
|
-
*
|
4801
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4824
|
+
* @deprecated
|
4825
|
+
* @description Experimental functionality subject to change without notice.
|
4826
|
+
* Defines how to override a specific component.
|
4802
4827
|
*/
|
4803
4828
|
ComponentOverride: {
|
4804
4829
|
parameters?: {
|
@@ -4807,11 +4832,10 @@ interface external {
|
|
4807
4832
|
variant?: string;
|
4808
4833
|
};
|
4809
4834
|
/**
|
4810
|
-
* @
|
4811
|
-
*
|
4812
|
-
*
|
4813
|
-
* NOTE:
|
4814
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4835
|
+
* @deprecated
|
4836
|
+
* @description Experimental functionality subject to change without notice.
|
4837
|
+
* Defines how a component on a pattern may have its values overridden.
|
4838
|
+
* NOTE: Data resources' overridability is defined in the data resource definition.
|
4815
4839
|
*/
|
4816
4840
|
ComponentOverridability: {
|
4817
4841
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
@@ -4822,15 +4846,13 @@ interface external {
|
|
4822
4846
|
variants?: boolean;
|
4823
4847
|
};
|
4824
4848
|
/**
|
4825
|
-
* @
|
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
|
-
*
|
4849
|
+
* @deprecated
|
4850
|
+
* @description Experimental functionality subject to change without notice.
|
4830
4851
|
* @enum {string}
|
4831
4852
|
*/
|
4832
4853
|
OverrideOptions: "yes" | "no";
|
4833
4854
|
/**
|
4855
|
+
* @deprecated
|
4834
4856
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4835
4857
|
* These are created in the UI and shared across a whole project.
|
4836
4858
|
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
@@ -4864,7 +4886,10 @@ interface external {
|
|
4864
4886
|
[key: string]: unknown;
|
4865
4887
|
};
|
4866
4888
|
};
|
4867
|
-
/**
|
4889
|
+
/**
|
4890
|
+
* @deprecated
|
4891
|
+
* @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.
|
4892
|
+
*/
|
4868
4893
|
DataType: {
|
4869
4894
|
/** @description Public ID of the data type */
|
4870
4895
|
id: string;
|
@@ -4921,7 +4946,10 @@ interface external {
|
|
4921
4946
|
[key: string]: unknown;
|
4922
4947
|
};
|
4923
4948
|
};
|
4924
|
-
/**
|
4949
|
+
/**
|
4950
|
+
* @deprecated
|
4951
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
4952
|
+
*/
|
4925
4953
|
DataVariableDefinition: {
|
4926
4954
|
/** @description Display name of the data variable */
|
4927
4955
|
displayName?: string;
|
@@ -4938,13 +4966,17 @@ interface external {
|
|
4938
4966
|
order?: number;
|
4939
4967
|
};
|
4940
4968
|
/**
|
4969
|
+
* @deprecated
|
4941
4970
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4942
4971
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4943
4972
|
*/
|
4944
4973
|
DataResourceDefinitions: {
|
4945
4974
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4946
4975
|
};
|
4947
|
-
/**
|
4976
|
+
/**
|
4977
|
+
* @deprecated
|
4978
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
4979
|
+
*/
|
4948
4980
|
DataResourceDefinition: {
|
4949
4981
|
/** @description Public ID of the data type that provides this data */
|
4950
4982
|
type: string;
|
@@ -4958,7 +4990,10 @@ interface external {
|
|
4958
4990
|
ignorePatternParameterDefault?: boolean;
|
4959
4991
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4960
4992
|
};
|
4961
|
-
/**
|
4993
|
+
/**
|
4994
|
+
* @deprecated
|
4995
|
+
* @description Variable values for a data resource.
|
4996
|
+
*/
|
4962
4997
|
DataResourceVariables: {
|
4963
4998
|
[key: string]: string;
|
4964
4999
|
};
|
@@ -5093,7 +5128,9 @@ type InvalidationPayload = schemas['InvalidationPayload'];
|
|
5093
5128
|
type InvalidationResult = schemas['InvalidationResult'];
|
5094
5129
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
5095
5130
|
|
5096
|
-
/**
|
5131
|
+
/**
|
5132
|
+
* @deprecated
|
5133
|
+
*/
|
5097
5134
|
declare class DataSourceClient extends ApiClient {
|
5098
5135
|
constructor(options: ClientOptions);
|
5099
5136
|
/** Fetches all DataSources for a project */
|
@@ -5160,7 +5197,9 @@ declare class DataSourceClient extends ApiClient {
|
|
5160
5197
|
remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
|
5161
5198
|
}
|
5162
5199
|
|
5163
|
-
/**
|
5200
|
+
/**
|
5201
|
+
* @deprecated
|
5202
|
+
*/
|
5164
5203
|
declare class DataTypeClient extends ApiClient {
|
5165
5204
|
#private;
|
5166
5205
|
constructor(options: ClientOptions);
|
@@ -5388,6 +5427,11 @@ type UpdateCompositionMessage = {
|
|
5388
5427
|
composition: RootComponentInstance;
|
5389
5428
|
hash: number | undefined;
|
5390
5429
|
};
|
5430
|
+
type UpdateCompositionInternalMessage = {
|
5431
|
+
type: 'update-composition-internal';
|
5432
|
+
composition: RootComponentInstance;
|
5433
|
+
hash: number | undefined;
|
5434
|
+
};
|
5391
5435
|
type AddComponentMessage = {
|
5392
5436
|
type: 'add-component';
|
5393
5437
|
parentId: string;
|
@@ -5401,6 +5445,12 @@ type MoveComponentMessage = {
|
|
5401
5445
|
index: number;
|
5402
5446
|
direction: 'up' | 'down';
|
5403
5447
|
};
|
5448
|
+
type UpdateComponentParameterMessage = {
|
5449
|
+
type: 'update-component-parameter';
|
5450
|
+
componentId: string;
|
5451
|
+
parameterId: string;
|
5452
|
+
value: string | number | undefined;
|
5453
|
+
};
|
5404
5454
|
type DismissPlaceholderMessage = {
|
5405
5455
|
type: 'dismiss-placeholder';
|
5406
5456
|
parentId: string;
|
@@ -5415,12 +5465,14 @@ type ReportRenderedCompositionsMessage = {
|
|
5415
5465
|
compositionIds: string[];
|
5416
5466
|
url: string;
|
5417
5467
|
};
|
5418
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
|
5468
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | DismissPlaceholderMessage;
|
5419
5469
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
5420
5470
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
5421
5471
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
5472
|
+
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
5422
5473
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
5423
5474
|
declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
|
5475
|
+
declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => message is UpdateComponentParameterMessage;
|
5424
5476
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
5425
5477
|
declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
|
5426
5478
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
@@ -5430,9 +5482,11 @@ type Channel = {
|
|
5430
5482
|
ready: () => void;
|
5431
5483
|
destroy: () => void;
|
5432
5484
|
selectComponent: (id: string) => void;
|
5433
|
-
updateComposition: (
|
5485
|
+
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
5486
|
+
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
5434
5487
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
5435
5488
|
moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
|
5489
|
+
updateComponentParameter: (options: Omit<UpdateComponentParameterMessage, 'type'>) => void;
|
5436
5490
|
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
5437
5491
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
5438
5492
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
@@ -5517,6 +5571,11 @@ declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start"
|
|
5517
5571
|
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
5518
5572
|
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
5519
5573
|
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
5574
|
+
/**
|
5575
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
5576
|
+
* Use to allow interacting with them by default in the preview panel
|
5577
|
+
*/
|
5578
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
5520
5579
|
/** The ID we give to placeholder components */
|
5521
5580
|
declare const PLACEHOLDER_ID = "placeholder";
|
5522
5581
|
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
@@ -5692,4 +5751,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
5692
5751
|
|
5693
5752
|
declare const CanvasClientError: typeof ApiClientError;
|
5694
5753
|
|
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 };
|
5754
|
+
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, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, 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, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
|