@uniformdev/canvas 18.35.1-alpha.18 → 18.35.1-alpha.22

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 CHANGED
@@ -148,8 +148,10 @@ interface components$2 {
148
148
  connectedData?: components$2["schemas"]["DataElementConnectionDefinition"];
149
149
  };
150
150
  /**
151
- * @deprecated
152
- * @description Defines a connection to a data element on a data resource. Do not use.
151
+ * @description Defines a connection to a data element on a data resource.
152
+ *
153
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
154
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
153
155
  */
154
156
  DataElementConnectionDefinition: {
155
157
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -184,7 +186,6 @@ interface components$2 {
184
186
  _pattern?: string;
185
187
  _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
186
188
  /**
187
- * @deprecated
188
189
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
189
190
  * Means nothing for PUTs; it will be ignored.
190
191
  */
@@ -201,20 +202,26 @@ interface components$2 {
201
202
  */
202
203
  _patternError?: "NOTFOUND" | "CYCLIC";
203
204
  /**
204
- * @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`.
205
+ * @description Defines patch overrides to component IDs that live in the composition.
206
+ * This can be used to override parameters that are defined on patterns,
207
+ * including nested patterns, with values that are specific to this composition.
208
+ * The keys in this object are component IDs.
209
+ * Overrides are applied from the top down, so for example if both the composition
210
+ * and a pattern on the composition define an override on a nested pattern,
211
+ * the composition's override replaces the pattern's.
212
+ *
213
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
214
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
209
215
  */
210
216
  _overrides?: {
211
217
  [key: string]: components$2["schemas"]["ComponentOverride"];
212
218
  };
213
219
  /**
214
- * @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
220
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
217
221
  * by consumers of the pattern.
222
+ *
223
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
224
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
218
225
  */
219
226
  _overridability?: components$2["schemas"]["ComponentOverridability"];
220
227
  };
@@ -242,31 +249,34 @@ interface components$2 {
242
249
  _name: string;
243
250
  _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
244
251
  /**
245
- * @deprecated
246
- * @description Experimental functionality subject to change without notice.
247
- * Defines patch overrides to component IDs that live in the composition.
252
+ * @description Defines patch overrides to component IDs that live in the composition.
248
253
  * This can be used to override parameters that are defined on patterns,
249
254
  * including nested patterns, with values that are specific to this composition.
250
255
  * The keys in this object are component IDs.
251
256
  * Overrides are applied from the top down, so for example if both the composition
252
257
  * and a pattern on the composition define an override on a nested pattern,
253
258
  * the composition's override replaces the pattern's.
259
+ *
260
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
261
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
254
262
  */
255
263
  _overrides?: {
256
264
  [key: string]: components$2["schemas"]["ComponentOverride"];
257
265
  };
258
266
  /**
259
- * @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
267
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
262
268
  * by consumers of the pattern.
269
+ *
270
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
271
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
263
272
  */
264
273
  _overridability?: components$2["schemas"]["ComponentOverridability"];
265
274
  };
266
275
  /**
267
- * @deprecated
268
- * @description Experimental functionality subject to change without notice.
269
- * Defines how to override a specific component.
276
+ * @description Defines how to override a specific component.
277
+ *
278
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
279
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
270
280
  */
271
281
  ComponentOverride: {
272
282
  parameters?: {
@@ -275,10 +285,11 @@ interface components$2 {
275
285
  variant?: string;
276
286
  };
277
287
  /**
278
- * @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.
288
+ * @description Defines how a component on a pattern may have its values overridden.
289
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
290
+ *
291
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
292
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
282
293
  */
283
294
  ComponentOverridability: {
284
295
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -289,13 +300,15 @@ interface components$2 {
289
300
  variants?: boolean;
290
301
  };
291
302
  /**
292
- * @deprecated
293
- * @description Experimental functionality subject to change without notice.
303
+ * @description Whether a parameter is overridable
304
+ *
305
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
306
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
307
+ *
294
308
  * @enum {string}
295
309
  */
296
310
  OverrideOptions: "yes" | "no";
297
311
  /**
298
- * @deprecated
299
312
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
300
313
  * These are created in the UI and shared across a whole project.
301
314
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -329,10 +342,7 @@ interface components$2 {
329
342
  [key: string]: unknown;
330
343
  };
331
344
  };
332
- /**
333
- * @deprecated
334
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
335
- */
345
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
336
346
  DataType: {
337
347
  /** @description Public ID of the data type */
338
348
  id: string;
@@ -389,10 +399,7 @@ interface components$2 {
389
399
  [key: string]: unknown;
390
400
  };
391
401
  };
392
- /**
393
- * @deprecated
394
- * @description Defines the shape of a data variable on a Data Source or Data Type
395
- */
402
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
396
403
  DataVariableDefinition: {
397
404
  /** @description Display name of the data variable */
398
405
  displayName?: string;
@@ -409,17 +416,13 @@ interface components$2 {
409
416
  order?: number;
410
417
  };
411
418
  /**
412
- * @deprecated
413
419
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
414
420
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
415
421
  */
416
422
  DataResourceDefinitions: {
417
423
  [key: string]: components$2["schemas"]["DataResourceDefinition"];
418
424
  };
419
- /**
420
- * @deprecated
421
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
422
- */
425
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
423
426
  DataResourceDefinition: {
424
427
  /** @description Public ID of the data type that provides this data */
425
428
  type: string;
@@ -433,10 +436,7 @@ interface components$2 {
433
436
  ignorePatternParameterDefault?: boolean;
434
437
  variables?: components$2["schemas"]["DataResourceVariables"];
435
438
  };
436
- /**
437
- * @deprecated
438
- * @description Variable values for a data resource.
439
- */
439
+ /** @description Variable values for a data resource. */
440
440
  DataResourceVariables: {
441
441
  [key: string]: string;
442
442
  };
@@ -742,8 +742,10 @@ interface external$5 {
742
742
  connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
743
743
  };
744
744
  /**
745
- * @deprecated
746
- * @description Defines a connection to a data element on a data resource. Do not use.
745
+ * @description Defines a connection to a data element on a data resource.
746
+ *
747
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
748
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
747
749
  */
748
750
  DataElementConnectionDefinition: {
749
751
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -778,7 +780,6 @@ interface external$5 {
778
780
  _pattern?: string;
779
781
  _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
780
782
  /**
781
- * @deprecated
782
783
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
783
784
  * Means nothing for PUTs; it will be ignored.
784
785
  */
@@ -795,20 +796,26 @@ interface external$5 {
795
796
  */
796
797
  _patternError?: "NOTFOUND" | "CYCLIC";
797
798
  /**
798
- * @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`.
799
+ * @description Defines patch overrides to component IDs that live in the composition.
800
+ * This can be used to override parameters that are defined on patterns,
801
+ * including nested patterns, with values that are specific to this composition.
802
+ * The keys in this object are component IDs.
803
+ * Overrides are applied from the top down, so for example if both the composition
804
+ * and a pattern on the composition define an override on a nested pattern,
805
+ * the composition's override replaces the pattern's.
806
+ *
807
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
808
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
803
809
  */
804
810
  _overrides?: {
805
811
  [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
806
812
  };
807
813
  /**
808
- * @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
814
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
811
815
  * by consumers of the pattern.
816
+ *
817
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
818
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
812
819
  */
813
820
  _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
814
821
  };
@@ -836,31 +843,34 @@ interface external$5 {
836
843
  _name: string;
837
844
  _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
838
845
  /**
839
- * @deprecated
840
- * @description Experimental functionality subject to change without notice.
841
- * Defines patch overrides to component IDs that live in the composition.
846
+ * @description Defines patch overrides to component IDs that live in the composition.
842
847
  * This can be used to override parameters that are defined on patterns,
843
848
  * including nested patterns, with values that are specific to this composition.
844
849
  * The keys in this object are component IDs.
845
850
  * Overrides are applied from the top down, so for example if both the composition
846
851
  * and a pattern on the composition define an override on a nested pattern,
847
852
  * the composition's override replaces the pattern's.
853
+ *
854
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
855
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
848
856
  */
849
857
  _overrides?: {
850
858
  [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
851
859
  };
852
860
  /**
853
- * @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
861
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
856
862
  * by consumers of the pattern.
863
+ *
864
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
865
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
857
866
  */
858
867
  _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
859
868
  };
860
869
  /**
861
- * @deprecated
862
- * @description Experimental functionality subject to change without notice.
863
- * Defines how to override a specific component.
870
+ * @description Defines how to override a specific component.
871
+ *
872
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
873
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
864
874
  */
865
875
  ComponentOverride: {
866
876
  parameters?: {
@@ -869,10 +879,11 @@ interface external$5 {
869
879
  variant?: string;
870
880
  };
871
881
  /**
872
- * @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.
882
+ * @description Defines how a component on a pattern may have its values overridden.
883
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
884
+ *
885
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
886
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
876
887
  */
877
888
  ComponentOverridability: {
878
889
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -883,13 +894,15 @@ interface external$5 {
883
894
  variants?: boolean;
884
895
  };
885
896
  /**
886
- * @deprecated
887
- * @description Experimental functionality subject to change without notice.
897
+ * @description Whether a parameter is overridable
898
+ *
899
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
900
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
901
+ *
888
902
  * @enum {string}
889
903
  */
890
904
  OverrideOptions: "yes" | "no";
891
905
  /**
892
- * @deprecated
893
906
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
894
907
  * These are created in the UI and shared across a whole project.
895
908
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -923,10 +936,7 @@ interface external$5 {
923
936
  [key: string]: unknown;
924
937
  };
925
938
  };
926
- /**
927
- * @deprecated
928
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
929
- */
939
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
930
940
  DataType: {
931
941
  /** @description Public ID of the data type */
932
942
  id: string;
@@ -983,10 +993,7 @@ interface external$5 {
983
993
  [key: string]: unknown;
984
994
  };
985
995
  };
986
- /**
987
- * @deprecated
988
- * @description Defines the shape of a data variable on a Data Source or Data Type
989
- */
996
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
990
997
  DataVariableDefinition: {
991
998
  /** @description Display name of the data variable */
992
999
  displayName?: string;
@@ -1003,17 +1010,13 @@ interface external$5 {
1003
1010
  order?: number;
1004
1011
  };
1005
1012
  /**
1006
- * @deprecated
1007
1013
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
1008
1014
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1009
1015
  */
1010
1016
  DataResourceDefinitions: {
1011
1017
  [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1012
1018
  };
1013
- /**
1014
- * @deprecated
1015
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
1016
- */
1019
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
1017
1020
  DataResourceDefinition: {
1018
1021
  /** @description Public ID of the data type that provides this data */
1019
1022
  type: string;
@@ -1027,10 +1030,7 @@ interface external$5 {
1027
1030
  ignorePatternParameterDefault?: boolean;
1028
1031
  variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1029
1032
  };
1030
- /**
1031
- * @deprecated
1032
- * @description Variable values for a data resource.
1033
- */
1033
+ /** @description Variable values for a data resource. */
1034
1034
  DataResourceVariables: {
1035
1035
  [key: string]: string;
1036
1036
  };
@@ -1065,14 +1065,6 @@ type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['
1065
1065
  type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
1066
1066
  /** Query parameter options for GET /api/v1/canvas-definitions */
1067
1067
  type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
1068
- /** @deprecated use ComponentDefinitionGetResponse instead */
1069
- type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
1070
- /** @deprecated use ComponentDefinitionPutParameters */
1071
- type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
1072
- /** @deprecated use ComponentDefinitionDeleteParameters */
1073
- type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
1074
- /** @deprecated use ComponentDefinitionGetParameters */
1075
- type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
1076
1068
  /** The definition of a component parameter */
1077
1069
  type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
1078
1070
  typeConfig?: TConfig;
@@ -1087,8 +1079,6 @@ type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
1087
1079
  type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
1088
1080
  /** Defines a component type that can live on a Composition */
1089
1081
  type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
1090
- /** @deprecated use ComponentDefinition instead */
1091
- type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
1092
1082
 
1093
1083
  /**
1094
1084
  * This file was auto-generated by openapi-typescript.
@@ -1146,7 +1136,7 @@ interface paths$3 {
1146
1136
  /** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
1147
1137
  skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
1148
1138
  /**
1149
- * @deprecated If true, any pattern override data is not resolved by the API.
1139
+ * If true, any pattern override data is not resolved by the API.
1150
1140
  * This is intended for internal use in the Canvas editor, and should not be used.
1151
1141
  * Passing this parameter automatically implies withComponentIDs to be true.
1152
1142
  */
@@ -1355,7 +1345,6 @@ interface components$1 {
1355
1345
  */
1356
1346
  skipPatternResolution: boolean;
1357
1347
  /**
1358
- * @deprecated
1359
1348
  * @description If true, any pattern override data is not resolved by the API.
1360
1349
  * This is intended for internal use in the Canvas editor, and should not be used.
1361
1350
  * Passing this parameter automatically implies withComponentIDs to be true.
@@ -1600,8 +1589,10 @@ interface external$4 {
1600
1589
  connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1601
1590
  };
1602
1591
  /**
1603
- * @deprecated
1604
- * @description Defines a connection to a data element on a data resource. Do not use.
1592
+ * @description Defines a connection to a data element on a data resource.
1593
+ *
1594
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1595
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
1605
1596
  */
1606
1597
  DataElementConnectionDefinition: {
1607
1598
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -1636,7 +1627,6 @@ interface external$4 {
1636
1627
  _pattern?: string;
1637
1628
  _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1638
1629
  /**
1639
- * @deprecated
1640
1630
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
1641
1631
  * Means nothing for PUTs; it will be ignored.
1642
1632
  */
@@ -1653,20 +1643,26 @@ interface external$4 {
1653
1643
  */
1654
1644
  _patternError?: "NOTFOUND" | "CYCLIC";
1655
1645
  /**
1656
- * @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`.
1646
+ * @description Defines patch overrides to component IDs that live in the composition.
1647
+ * This can be used to override parameters that are defined on patterns,
1648
+ * including nested patterns, with values that are specific to this composition.
1649
+ * The keys in this object are component IDs.
1650
+ * Overrides are applied from the top down, so for example if both the composition
1651
+ * and a pattern on the composition define an override on a nested pattern,
1652
+ * the composition's override replaces the pattern's.
1653
+ *
1654
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1655
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1661
1656
  */
1662
1657
  _overrides?: {
1663
1658
  [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1664
1659
  };
1665
1660
  /**
1666
- * @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
1661
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
1669
1662
  * by consumers of the pattern.
1663
+ *
1664
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1665
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1670
1666
  */
1671
1667
  _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1672
1668
  };
@@ -1694,31 +1690,34 @@ interface external$4 {
1694
1690
  _name: string;
1695
1691
  _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1696
1692
  /**
1697
- * @deprecated
1698
- * @description Experimental functionality subject to change without notice.
1699
- * Defines patch overrides to component IDs that live in the composition.
1693
+ * @description Defines patch overrides to component IDs that live in the composition.
1700
1694
  * This can be used to override parameters that are defined on patterns,
1701
1695
  * including nested patterns, with values that are specific to this composition.
1702
1696
  * The keys in this object are component IDs.
1703
1697
  * Overrides are applied from the top down, so for example if both the composition
1704
1698
  * and a pattern on the composition define an override on a nested pattern,
1705
1699
  * the composition's override replaces the pattern's.
1700
+ *
1701
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1702
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1706
1703
  */
1707
1704
  _overrides?: {
1708
1705
  [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1709
1706
  };
1710
1707
  /**
1711
- * @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
1708
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
1714
1709
  * by consumers of the pattern.
1710
+ *
1711
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1712
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1715
1713
  */
1716
1714
  _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1717
1715
  };
1718
1716
  /**
1719
- * @deprecated
1720
- * @description Experimental functionality subject to change without notice.
1721
- * Defines how to override a specific component.
1717
+ * @description Defines how to override a specific component.
1718
+ *
1719
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1720
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1722
1721
  */
1723
1722
  ComponentOverride: {
1724
1723
  parameters?: {
@@ -1727,10 +1726,11 @@ interface external$4 {
1727
1726
  variant?: string;
1728
1727
  };
1729
1728
  /**
1730
- * @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.
1729
+ * @description Defines how a component on a pattern may have its values overridden.
1730
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
1731
+ *
1732
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1733
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1734
1734
  */
1735
1735
  ComponentOverridability: {
1736
1736
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -1741,13 +1741,15 @@ interface external$4 {
1741
1741
  variants?: boolean;
1742
1742
  };
1743
1743
  /**
1744
- * @deprecated
1745
- * @description Experimental functionality subject to change without notice.
1744
+ * @description Whether a parameter is overridable
1745
+ *
1746
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1747
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1748
+ *
1746
1749
  * @enum {string}
1747
1750
  */
1748
1751
  OverrideOptions: "yes" | "no";
1749
1752
  /**
1750
- * @deprecated
1751
1753
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
1752
1754
  * These are created in the UI and shared across a whole project.
1753
1755
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -1781,10 +1783,7 @@ interface external$4 {
1781
1783
  [key: string]: unknown;
1782
1784
  };
1783
1785
  };
1784
- /**
1785
- * @deprecated
1786
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
1787
- */
1786
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
1788
1787
  DataType: {
1789
1788
  /** @description Public ID of the data type */
1790
1789
  id: string;
@@ -1841,10 +1840,7 @@ interface external$4 {
1841
1840
  [key: string]: unknown;
1842
1841
  };
1843
1842
  };
1844
- /**
1845
- * @deprecated
1846
- * @description Defines the shape of a data variable on a Data Source or Data Type
1847
- */
1843
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
1848
1844
  DataVariableDefinition: {
1849
1845
  /** @description Display name of the data variable */
1850
1846
  displayName?: string;
@@ -1861,17 +1857,13 @@ interface external$4 {
1861
1857
  order?: number;
1862
1858
  };
1863
1859
  /**
1864
- * @deprecated
1865
1860
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
1866
1861
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1867
1862
  */
1868
1863
  DataResourceDefinitions: {
1869
1864
  [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1870
1865
  };
1871
- /**
1872
- * @deprecated
1873
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
1874
- */
1866
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
1875
1867
  DataResourceDefinition: {
1876
1868
  /** @description Public ID of the data type that provides this data */
1877
1869
  type: string;
@@ -1885,10 +1877,7 @@ interface external$4 {
1885
1877
  ignorePatternParameterDefault?: boolean;
1886
1878
  variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1887
1879
  };
1888
- /**
1889
- * @deprecated
1890
- * @description Variable values for a data resource.
1891
- */
1880
+ /** @description Variable values for a data resource. */
1892
1881
  DataResourceVariables: {
1893
1882
  [key: string]: string;
1894
1883
  };
@@ -2243,8 +2232,10 @@ interface external$3 {
2243
2232
  connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
2244
2233
  };
2245
2234
  /**
2246
- * @deprecated
2247
- * @description Defines a connection to a data element on a data resource. Do not use.
2235
+ * @description Defines a connection to a data element on a data resource.
2236
+ *
2237
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2238
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
2248
2239
  */
2249
2240
  DataElementConnectionDefinition: {
2250
2241
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -2279,7 +2270,6 @@ interface external$3 {
2279
2270
  _pattern?: string;
2280
2271
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2281
2272
  /**
2282
- * @deprecated
2283
2273
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2284
2274
  * Means nothing for PUTs; it will be ignored.
2285
2275
  */
@@ -2296,20 +2286,26 @@ interface external$3 {
2296
2286
  */
2297
2287
  _patternError?: "NOTFOUND" | "CYCLIC";
2298
2288
  /**
2299
- * @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`.
2289
+ * @description Defines patch overrides to component IDs that live in the composition.
2290
+ * This can be used to override parameters that are defined on patterns,
2291
+ * including nested patterns, with values that are specific to this composition.
2292
+ * The keys in this object are component IDs.
2293
+ * Overrides are applied from the top down, so for example if both the composition
2294
+ * and a pattern on the composition define an override on a nested pattern,
2295
+ * the composition's override replaces the pattern's.
2296
+ *
2297
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2298
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2304
2299
  */
2305
2300
  _overrides?: {
2306
2301
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2307
2302
  };
2308
2303
  /**
2309
- * @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
2304
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
2312
2305
  * by consumers of the pattern.
2306
+ *
2307
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2308
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2313
2309
  */
2314
2310
  _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2315
2311
  };
@@ -2337,31 +2333,34 @@ interface external$3 {
2337
2333
  _name: string;
2338
2334
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2339
2335
  /**
2340
- * @deprecated
2341
- * @description Experimental functionality subject to change without notice.
2342
- * Defines patch overrides to component IDs that live in the composition.
2336
+ * @description Defines patch overrides to component IDs that live in the composition.
2343
2337
  * This can be used to override parameters that are defined on patterns,
2344
2338
  * including nested patterns, with values that are specific to this composition.
2345
2339
  * The keys in this object are component IDs.
2346
2340
  * Overrides are applied from the top down, so for example if both the composition
2347
2341
  * and a pattern on the composition define an override on a nested pattern,
2348
2342
  * the composition's override replaces the pattern's.
2343
+ *
2344
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2345
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2349
2346
  */
2350
2347
  _overrides?: {
2351
2348
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2352
2349
  };
2353
2350
  /**
2354
- * @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
2351
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
2357
2352
  * by consumers of the pattern.
2353
+ *
2354
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2355
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2358
2356
  */
2359
2357
  _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2360
2358
  };
2361
2359
  /**
2362
- * @deprecated
2363
- * @description Experimental functionality subject to change without notice.
2364
- * Defines how to override a specific component.
2360
+ * @description Defines how to override a specific component.
2361
+ *
2362
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2363
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2365
2364
  */
2366
2365
  ComponentOverride: {
2367
2366
  parameters?: {
@@ -2370,10 +2369,11 @@ interface external$3 {
2370
2369
  variant?: string;
2371
2370
  };
2372
2371
  /**
2373
- * @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.
2372
+ * @description Defines how a component on a pattern may have its values overridden.
2373
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
2374
+ *
2375
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2376
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2377
2377
  */
2378
2378
  ComponentOverridability: {
2379
2379
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -2384,13 +2384,15 @@ interface external$3 {
2384
2384
  variants?: boolean;
2385
2385
  };
2386
2386
  /**
2387
- * @deprecated
2388
- * @description Experimental functionality subject to change without notice.
2387
+ * @description Whether a parameter is overridable
2388
+ *
2389
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2390
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2391
+ *
2389
2392
  * @enum {string}
2390
2393
  */
2391
2394
  OverrideOptions: "yes" | "no";
2392
2395
  /**
2393
- * @deprecated
2394
2396
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
2395
2397
  * These are created in the UI and shared across a whole project.
2396
2398
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -2424,10 +2426,7 @@ interface external$3 {
2424
2426
  [key: string]: unknown;
2425
2427
  };
2426
2428
  };
2427
- /**
2428
- * @deprecated
2429
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
2430
- */
2429
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
2431
2430
  DataType: {
2432
2431
  /** @description Public ID of the data type */
2433
2432
  id: string;
@@ -2484,10 +2483,7 @@ interface external$3 {
2484
2483
  [key: string]: unknown;
2485
2484
  };
2486
2485
  };
2487
- /**
2488
- * @deprecated
2489
- * @description Defines the shape of a data variable on a Data Source or Data Type
2490
- */
2486
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
2491
2487
  DataVariableDefinition: {
2492
2488
  /** @description Display name of the data variable */
2493
2489
  displayName?: string;
@@ -2504,17 +2500,13 @@ interface external$3 {
2504
2500
  order?: number;
2505
2501
  };
2506
2502
  /**
2507
- * @deprecated
2508
2503
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
2509
2504
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
2510
2505
  */
2511
2506
  DataResourceDefinitions: {
2512
2507
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2513
2508
  };
2514
- /**
2515
- * @deprecated
2516
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
2517
- */
2509
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
2518
2510
  DataResourceDefinition: {
2519
2511
  /** @description Public ID of the data type that provides this data */
2520
2512
  type: string;
@@ -2528,10 +2520,7 @@ interface external$3 {
2528
2520
  ignorePatternParameterDefault?: boolean;
2529
2521
  variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2530
2522
  };
2531
- /**
2532
- * @deprecated
2533
- * @description Variable values for a data resource.
2534
- */
2523
+ /** @description Variable values for a data resource. */
2535
2524
  DataResourceVariables: {
2536
2525
  [key: string]: string;
2537
2526
  };
@@ -2607,7 +2596,7 @@ interface external$3 {
2607
2596
  /** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
2608
2597
  skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
2609
2598
  /**
2610
- * @deprecated If true, any pattern override data is not resolved by the API.
2599
+ * If true, any pattern override data is not resolved by the API.
2611
2600
  * This is intended for internal use in the Canvas editor, and should not be used.
2612
2601
  * Passing this parameter automatically implies withComponentIDs to be true.
2613
2602
  */
@@ -2816,7 +2805,6 @@ interface external$3 {
2816
2805
  */
2817
2806
  skipPatternResolution: boolean;
2818
2807
  /**
2819
- * @deprecated
2820
2808
  * @description If true, any pattern override data is not resolved by the API.
2821
2809
  * This is intended for internal use in the Canvas editor, and should not be used.
2822
2810
  * Passing this parameter automatically implies withComponentIDs to be true.
@@ -2895,14 +2883,6 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
2895
2883
  type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
2896
2884
  /** Shape of the DELETE request body for /api/v1/canvas */
2897
2885
  type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
2898
- /** @deprecated use CompositionGetResponse */
2899
- type CompositionAPIResponse = CompositionGetResponse;
2900
- /** @deprecated use CompositionDeleteParameters */
2901
- type CompositionAPIDeleteRequest = CompositionDeleteParameters;
2902
- /** @deprecated use CompositionGetParameters */
2903
- type CompositionListAPIResponse = CompositionGetListResponse;
2904
- /** @deprecated use CompositionGetParameters */
2905
- type CompositionAPIOptions = CompositionGetParameters;
2906
2886
  /** Defines an editable parameter on a component. */
2907
2887
  type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
2908
2888
  /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
@@ -2935,22 +2915,18 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
2935
2915
  type RootComponentInstance = SharedComponents['RootComponentInstance'];
2936
2916
  /**
2937
2917
  * Defines the shape of a component override
2938
- * @deprecated
2939
2918
  */
2940
2919
  type OverrideOptions = SharedComponents['OverrideOptions'];
2941
2920
  /**
2942
2921
  * Defines the shape of a component override
2943
- * @deprecated
2944
2922
  */
2945
2923
  type ComponentOverride = SharedComponents['ComponentOverride'];
2946
2924
  /**
2947
2925
  * Defines a set of component overrides by component ID
2948
- * @deprecated
2949
2926
  */
2950
2927
  type ComponentOverrides = Record<string, ComponentOverride>;
2951
2928
  /**
2952
2929
  * Defines how a component on a pattern may have its values overridden
2953
- * @deprecated
2954
2930
  */
2955
2931
  type ComponentOverridability = SharedComponents['ComponentOverridability'];
2956
2932
  /** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
@@ -2972,20 +2948,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
2972
2948
  type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
2973
2949
  /** Switches for data resolution */
2974
2950
  type DataResolutionOption = {
2975
- unstable_resolveData?: boolean;
2951
+ skipDataResolution?: boolean;
2976
2952
  };
2977
2953
  type DataResolutionOptionNegative = {
2978
- unstable_resolveData?: false;
2954
+ skipDataResolution: true;
2979
2955
  };
2980
2956
  type DataResolutionOptionPositive = {
2981
- unstable_resolveData: true;
2957
+ skipDataResolution?: false;
2982
2958
  };
2983
2959
  type DataResolutionParameters = {
2984
2960
  /**
2985
2961
  * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
2986
2962
  * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
2987
2963
  */
2988
- unstable_diagnostics?: boolean;
2964
+ diagnostics?: boolean;
2989
2965
  /**
2990
2966
  * Pass dynamic variables to the composition that are required for resolving bindings and datas,
2991
2967
  * such as language, detail page ID, etc.
@@ -3191,14 +3167,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
3191
3167
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3192
3168
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
3193
3169
  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>;
3196
3170
  /** Fetches one composition by its project map node ID */
3197
3171
  getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3198
3172
  getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
3199
3173
  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>;
3202
3174
  /** Fetches one composition by its slug */
3203
3175
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3204
3176
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
@@ -3379,7 +3351,7 @@ interface paths$2 {
3379
3351
  /**
3380
3352
  * Format: uuid
3381
3353
  * @deprecated
3382
- * @description Do not use. Will be removed in future.
3354
+ * @description Do not use. May be removed in future.
3383
3355
  */
3384
3356
  integrationId?: string;
3385
3357
  /** @description The integration type that the data source is attached to. Must be installed in the project. */
@@ -3598,8 +3570,10 @@ interface external$2 {
3598
3570
  connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
3599
3571
  };
3600
3572
  /**
3601
- * @deprecated
3602
- * @description Defines a connection to a data element on a data resource. Do not use.
3573
+ * @description Defines a connection to a data element on a data resource.
3574
+ *
3575
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3576
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
3603
3577
  */
3604
3578
  DataElementConnectionDefinition: {
3605
3579
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -3634,7 +3608,6 @@ interface external$2 {
3634
3608
  _pattern?: string;
3635
3609
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3636
3610
  /**
3637
- * @deprecated
3638
3611
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3639
3612
  * Means nothing for PUTs; it will be ignored.
3640
3613
  */
@@ -3651,20 +3624,26 @@ interface external$2 {
3651
3624
  */
3652
3625
  _patternError?: "NOTFOUND" | "CYCLIC";
3653
3626
  /**
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`.
3627
+ * @description Defines patch overrides to component IDs that live in the composition.
3628
+ * This can be used to override parameters that are defined on patterns,
3629
+ * including nested patterns, with values that are specific to this composition.
3630
+ * The keys in this object are component IDs.
3631
+ * Overrides are applied from the top down, so for example if both the composition
3632
+ * and a pattern on the composition define an override on a nested pattern,
3633
+ * the composition's override replaces the pattern's.
3634
+ *
3635
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3636
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3659
3637
  */
3660
3638
  _overrides?: {
3661
3639
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3662
3640
  };
3663
3641
  /**
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
3642
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3667
3643
  * by consumers of the pattern.
3644
+ *
3645
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3646
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3668
3647
  */
3669
3648
  _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3670
3649
  };
@@ -3692,31 +3671,34 @@ interface external$2 {
3692
3671
  _name: string;
3693
3672
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3694
3673
  /**
3695
- * @deprecated
3696
- * @description Experimental functionality subject to change without notice.
3697
- * Defines patch overrides to component IDs that live in the composition.
3674
+ * @description Defines patch overrides to component IDs that live in the composition.
3698
3675
  * This can be used to override parameters that are defined on patterns,
3699
3676
  * including nested patterns, with values that are specific to this composition.
3700
3677
  * The keys in this object are component IDs.
3701
3678
  * Overrides are applied from the top down, so for example if both the composition
3702
3679
  * and a pattern on the composition define an override on a nested pattern,
3703
3680
  * the composition's override replaces the pattern's.
3681
+ *
3682
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3683
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3704
3684
  */
3705
3685
  _overrides?: {
3706
3686
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3707
3687
  };
3708
3688
  /**
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
3689
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3712
3690
  * by consumers of the pattern.
3691
+ *
3692
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3693
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3713
3694
  */
3714
3695
  _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3715
3696
  };
3716
3697
  /**
3717
- * @deprecated
3718
- * @description Experimental functionality subject to change without notice.
3719
- * Defines how to override a specific component.
3698
+ * @description Defines how to override a specific component.
3699
+ *
3700
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3701
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3720
3702
  */
3721
3703
  ComponentOverride: {
3722
3704
  parameters?: {
@@ -3725,10 +3707,11 @@ interface external$2 {
3725
3707
  variant?: string;
3726
3708
  };
3727
3709
  /**
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.
3710
+ * @description Defines how a component on a pattern may have its values overridden.
3711
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
3712
+ *
3713
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3714
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3732
3715
  */
3733
3716
  ComponentOverridability: {
3734
3717
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -3739,13 +3722,15 @@ interface external$2 {
3739
3722
  variants?: boolean;
3740
3723
  };
3741
3724
  /**
3742
- * @deprecated
3743
- * @description Experimental functionality subject to change without notice.
3725
+ * @description Whether a parameter is overridable
3726
+ *
3727
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3728
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3729
+ *
3744
3730
  * @enum {string}
3745
3731
  */
3746
3732
  OverrideOptions: "yes" | "no";
3747
3733
  /**
3748
- * @deprecated
3749
3734
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
3750
3735
  * These are created in the UI and shared across a whole project.
3751
3736
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -3779,10 +3764,7 @@ interface external$2 {
3779
3764
  [key: string]: unknown;
3780
3765
  };
3781
3766
  };
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
- */
3767
+ /** @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. */
3786
3768
  DataType: {
3787
3769
  /** @description Public ID of the data type */
3788
3770
  id: string;
@@ -3839,10 +3821,7 @@ interface external$2 {
3839
3821
  [key: string]: unknown;
3840
3822
  };
3841
3823
  };
3842
- /**
3843
- * @deprecated
3844
- * @description Defines the shape of a data variable on a Data Source or Data Type
3845
- */
3824
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
3846
3825
  DataVariableDefinition: {
3847
3826
  /** @description Display name of the data variable */
3848
3827
  displayName?: string;
@@ -3859,17 +3838,13 @@ interface external$2 {
3859
3838
  order?: number;
3860
3839
  };
3861
3840
  /**
3862
- * @deprecated
3863
3841
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
3864
3842
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
3865
3843
  */
3866
3844
  DataResourceDefinitions: {
3867
3845
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
3868
3846
  };
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
- */
3847
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
3873
3848
  DataResourceDefinition: {
3874
3849
  /** @description Public ID of the data type that provides this data */
3875
3850
  type: string;
@@ -3883,10 +3858,7 @@ interface external$2 {
3883
3858
  ignorePatternParameterDefault?: boolean;
3884
3859
  variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3885
3860
  };
3886
- /**
3887
- * @deprecated
3888
- * @description Variable values for a data resource.
3889
- */
3861
+ /** @description Variable values for a data resource. */
3890
3862
  DataResourceVariables: {
3891
3863
  [key: string]: string;
3892
3864
  };
@@ -4134,8 +4106,10 @@ interface external$1 {
4134
4106
  connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4135
4107
  };
4136
4108
  /**
4137
- * @deprecated
4138
- * @description Defines a connection to a data element on a data resource. Do not use.
4109
+ * @description Defines a connection to a data element on a data resource.
4110
+ *
4111
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4112
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
4139
4113
  */
4140
4114
  DataElementConnectionDefinition: {
4141
4115
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4170,7 +4144,6 @@ interface external$1 {
4170
4144
  _pattern?: string;
4171
4145
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4172
4146
  /**
4173
- * @deprecated
4174
4147
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
4175
4148
  * Means nothing for PUTs; it will be ignored.
4176
4149
  */
@@ -4187,20 +4160,26 @@ interface external$1 {
4187
4160
  */
4188
4161
  _patternError?: "NOTFOUND" | "CYCLIC";
4189
4162
  /**
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`.
4163
+ * @description Defines patch overrides to component IDs that live in the composition.
4164
+ * This can be used to override parameters that are defined on patterns,
4165
+ * including nested patterns, with values that are specific to this composition.
4166
+ * The keys in this object are component IDs.
4167
+ * Overrides are applied from the top down, so for example if both the composition
4168
+ * and a pattern on the composition define an override on a nested pattern,
4169
+ * the composition's override replaces the pattern's.
4170
+ *
4171
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4172
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4195
4173
  */
4196
4174
  _overrides?: {
4197
4175
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4198
4176
  };
4199
4177
  /**
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
4178
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4203
4179
  * by consumers of the pattern.
4180
+ *
4181
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4182
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4204
4183
  */
4205
4184
  _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4206
4185
  };
@@ -4228,31 +4207,34 @@ interface external$1 {
4228
4207
  _name: string;
4229
4208
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4230
4209
  /**
4231
- * @deprecated
4232
- * @description Experimental functionality subject to change without notice.
4233
- * Defines patch overrides to component IDs that live in the composition.
4210
+ * @description Defines patch overrides to component IDs that live in the composition.
4234
4211
  * This can be used to override parameters that are defined on patterns,
4235
4212
  * including nested patterns, with values that are specific to this composition.
4236
4213
  * The keys in this object are component IDs.
4237
4214
  * Overrides are applied from the top down, so for example if both the composition
4238
4215
  * and a pattern on the composition define an override on a nested pattern,
4239
4216
  * the composition's override replaces the pattern's.
4217
+ *
4218
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4219
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4240
4220
  */
4241
4221
  _overrides?: {
4242
4222
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4243
4223
  };
4244
4224
  /**
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
4225
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4248
4226
  * by consumers of the pattern.
4227
+ *
4228
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4229
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4249
4230
  */
4250
4231
  _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4251
4232
  };
4252
4233
  /**
4253
- * @deprecated
4254
- * @description Experimental functionality subject to change without notice.
4255
- * Defines how to override a specific component.
4234
+ * @description Defines how to override a specific component.
4235
+ *
4236
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4237
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4256
4238
  */
4257
4239
  ComponentOverride: {
4258
4240
  parameters?: {
@@ -4261,10 +4243,11 @@ interface external$1 {
4261
4243
  variant?: string;
4262
4244
  };
4263
4245
  /**
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.
4246
+ * @description Defines how a component on a pattern may have its values overridden.
4247
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
4248
+ *
4249
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4250
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4268
4251
  */
4269
4252
  ComponentOverridability: {
4270
4253
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4275,13 +4258,15 @@ interface external$1 {
4275
4258
  variants?: boolean;
4276
4259
  };
4277
4260
  /**
4278
- * @deprecated
4279
- * @description Experimental functionality subject to change without notice.
4261
+ * @description Whether a parameter is overridable
4262
+ *
4263
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4264
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4265
+ *
4280
4266
  * @enum {string}
4281
4267
  */
4282
4268
  OverrideOptions: "yes" | "no";
4283
4269
  /**
4284
- * @deprecated
4285
4270
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
4286
4271
  * These are created in the UI and shared across a whole project.
4287
4272
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4315,10 +4300,7 @@ interface external$1 {
4315
4300
  [key: string]: unknown;
4316
4301
  };
4317
4302
  };
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
- */
4303
+ /** @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. */
4322
4304
  DataType: {
4323
4305
  /** @description Public ID of the data type */
4324
4306
  id: string;
@@ -4375,10 +4357,7 @@ interface external$1 {
4375
4357
  [key: string]: unknown;
4376
4358
  };
4377
4359
  };
4378
- /**
4379
- * @deprecated
4380
- * @description Defines the shape of a data variable on a Data Source or Data Type
4381
- */
4360
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
4382
4361
  DataVariableDefinition: {
4383
4362
  /** @description Display name of the data variable */
4384
4363
  displayName?: string;
@@ -4395,17 +4374,13 @@ interface external$1 {
4395
4374
  order?: number;
4396
4375
  };
4397
4376
  /**
4398
- * @deprecated
4399
4377
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
4400
4378
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
4401
4379
  */
4402
4380
  DataResourceDefinitions: {
4403
4381
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
4404
4382
  };
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
- */
4383
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
4409
4384
  DataResourceDefinition: {
4410
4385
  /** @description Public ID of the data type that provides this data */
4411
4386
  type: string;
@@ -4419,10 +4394,7 @@ interface external$1 {
4419
4394
  ignorePatternParameterDefault?: boolean;
4420
4395
  variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4421
4396
  };
4422
- /**
4423
- * @deprecated
4424
- * @description Variable values for a data resource.
4425
- */
4397
+ /** @description Variable values for a data resource. */
4426
4398
  DataResourceVariables: {
4427
4399
  [key: string]: string;
4428
4400
  };
@@ -4705,8 +4677,10 @@ interface external {
4705
4677
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4706
4678
  };
4707
4679
  /**
4708
- * @deprecated
4709
- * @description Defines a connection to a data element on a data resource. Do not use.
4680
+ * @description Defines a connection to a data element on a data resource.
4681
+ *
4682
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4683
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
4710
4684
  */
4711
4685
  DataElementConnectionDefinition: {
4712
4686
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4741,7 +4715,6 @@ interface external {
4741
4715
  _pattern?: string;
4742
4716
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4743
4717
  /**
4744
- * @deprecated
4745
4718
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
4746
4719
  * Means nothing for PUTs; it will be ignored.
4747
4720
  */
@@ -4758,20 +4731,26 @@ interface external {
4758
4731
  */
4759
4732
  _patternError?: "NOTFOUND" | "CYCLIC";
4760
4733
  /**
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`.
4734
+ * @description Defines patch overrides to component IDs that live in the composition.
4735
+ * This can be used to override parameters that are defined on patterns,
4736
+ * including nested patterns, with values that are specific to this composition.
4737
+ * The keys in this object are component IDs.
4738
+ * Overrides are applied from the top down, so for example if both the composition
4739
+ * and a pattern on the composition define an override on a nested pattern,
4740
+ * the composition's override replaces the pattern's.
4741
+ *
4742
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4743
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4766
4744
  */
4767
4745
  _overrides?: {
4768
4746
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4769
4747
  };
4770
4748
  /**
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
4749
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4774
4750
  * by consumers of the pattern.
4751
+ *
4752
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4753
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4775
4754
  */
4776
4755
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4777
4756
  };
@@ -4799,31 +4778,34 @@ interface external {
4799
4778
  _name: string;
4800
4779
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4801
4780
  /**
4802
- * @deprecated
4803
- * @description Experimental functionality subject to change without notice.
4804
- * Defines patch overrides to component IDs that live in the composition.
4781
+ * @description Defines patch overrides to component IDs that live in the composition.
4805
4782
  * This can be used to override parameters that are defined on patterns,
4806
4783
  * including nested patterns, with values that are specific to this composition.
4807
4784
  * The keys in this object are component IDs.
4808
4785
  * Overrides are applied from the top down, so for example if both the composition
4809
4786
  * and a pattern on the composition define an override on a nested pattern,
4810
4787
  * the composition's override replaces the pattern's.
4788
+ *
4789
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4790
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4811
4791
  */
4812
4792
  _overrides?: {
4813
4793
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4814
4794
  };
4815
4795
  /**
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
4796
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4819
4797
  * by consumers of the pattern.
4798
+ *
4799
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4800
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4820
4801
  */
4821
4802
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4822
4803
  };
4823
4804
  /**
4824
- * @deprecated
4825
- * @description Experimental functionality subject to change without notice.
4826
- * Defines how to override a specific component.
4805
+ * @description Defines how to override a specific component.
4806
+ *
4807
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4808
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4827
4809
  */
4828
4810
  ComponentOverride: {
4829
4811
  parameters?: {
@@ -4832,10 +4814,11 @@ interface external {
4832
4814
  variant?: string;
4833
4815
  };
4834
4816
  /**
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.
4817
+ * @description Defines how a component on a pattern may have its values overridden.
4818
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
4819
+ *
4820
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4821
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4839
4822
  */
4840
4823
  ComponentOverridability: {
4841
4824
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4846,13 +4829,15 @@ interface external {
4846
4829
  variants?: boolean;
4847
4830
  };
4848
4831
  /**
4849
- * @deprecated
4850
- * @description Experimental functionality subject to change without notice.
4832
+ * @description Whether a parameter is overridable
4833
+ *
4834
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4835
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4836
+ *
4851
4837
  * @enum {string}
4852
4838
  */
4853
4839
  OverrideOptions: "yes" | "no";
4854
4840
  /**
4855
- * @deprecated
4856
4841
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
4857
4842
  * These are created in the UI and shared across a whole project.
4858
4843
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4886,10 +4871,7 @@ interface external {
4886
4871
  [key: string]: unknown;
4887
4872
  };
4888
4873
  };
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
- */
4874
+ /** @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. */
4893
4875
  DataType: {
4894
4876
  /** @description Public ID of the data type */
4895
4877
  id: string;
@@ -4946,10 +4928,7 @@ interface external {
4946
4928
  [key: string]: unknown;
4947
4929
  };
4948
4930
  };
4949
- /**
4950
- * @deprecated
4951
- * @description Defines the shape of a data variable on a Data Source or Data Type
4952
- */
4931
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
4953
4932
  DataVariableDefinition: {
4954
4933
  /** @description Display name of the data variable */
4955
4934
  displayName?: string;
@@ -4966,17 +4945,13 @@ interface external {
4966
4945
  order?: number;
4967
4946
  };
4968
4947
  /**
4969
- * @deprecated
4970
4948
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
4971
4949
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
4972
4950
  */
4973
4951
  DataResourceDefinitions: {
4974
4952
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
4975
4953
  };
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
- */
4954
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
4980
4955
  DataResourceDefinition: {
4981
4956
  /** @description Public ID of the data type that provides this data */
4982
4957
  type: string;
@@ -4990,10 +4965,7 @@ interface external {
4990
4965
  ignorePatternParameterDefault?: boolean;
4991
4966
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4992
4967
  };
4993
- /**
4994
- * @deprecated
4995
- * @description Variable values for a data resource.
4996
- */
4968
+ /** @description Variable values for a data resource. */
4997
4969
  DataResourceVariables: {
4998
4970
  [key: string]: string;
4999
4971
  };
@@ -5128,9 +5100,7 @@ type InvalidationPayload = schemas['InvalidationPayload'];
5128
5100
  type InvalidationResult = schemas['InvalidationResult'];
5129
5101
  type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
5130
5102
 
5131
- /**
5132
- * @deprecated
5133
- */
5103
+ /** API client to make comms with the Next Gen Mesh Data Source API simpler */
5134
5104
  declare class DataSourceClient extends ApiClient {
5135
5105
  constructor(options: ClientOptions);
5136
5106
  /** Fetches all DataSources for a project */
@@ -5197,9 +5167,7 @@ declare class DataSourceClient extends ApiClient {
5197
5167
  remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
5198
5168
  }
5199
5169
 
5200
- /**
5201
- * @deprecated
5202
- */
5170
+ /** API client to make comms with the Next Gen Mesh Data Type API simpler */
5203
5171
  declare class DataTypeClient extends ApiClient {
5204
5172
  #private;
5205
5173
  constructor(options: ClientOptions);
@@ -5751,4 +5719,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
5751
5719
 
5752
5720
  declare const CanvasClientError: typeof ApiClientError;
5753
5721
 
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 };
5722
+ 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, ComponentParameterContextualEditing, 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, 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 };