@uniformdev/canvas 18.18.1-alpha.12 → 18.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -170,14 +170,18 @@ interface components$2 {
170
170
  slots?: {
171
171
  [key: string]: components$2["schemas"]["ComponentInstance"][];
172
172
  };
173
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
173
+ /**
174
+ * @description Unique identifier of the component within the composition.
175
+ * No assumptions should be made about the format of this value other than "it will be unique."
176
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
177
+ */
174
178
  _id?: string;
175
179
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
176
180
  _pattern?: string;
177
181
  _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
178
182
  /**
179
183
  * @deprecated
180
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
184
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
181
185
  * Means nothing for PUTs; it will be ignored.
182
186
  */
183
187
  _patternDataResources?: {
@@ -192,6 +196,23 @@ interface components$2 {
192
196
  * @enum {string}
193
197
  */
194
198
  _patternError?: "NOTFOUND" | "CYCLIC";
199
+ /**
200
+ * @deprecated
201
+ * @description Experimental functionality subject to change without notice.
202
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
203
+ * This is always undefined unless `skipOverridesResolution` is true.
204
+ * See `_overrides` on `RootComponentInstance`.
205
+ */
206
+ _overrides?: {
207
+ [key: string]: components$2["schemas"]["ComponentOverride"];
208
+ };
209
+ /**
210
+ * @deprecated
211
+ * @description Experimental functionality subject to change without notice.
212
+ * When used on a pattern, defines how the pattern's parameters may be overridden
213
+ * by consumers of the pattern.
214
+ */
215
+ _overridability?: components$2["schemas"]["ComponentOverridability"];
195
216
  };
196
217
  /** @description Defines the shape of the root component in a composition */
197
218
  RootComponentInstance: {
@@ -216,7 +237,55 @@ interface components$2 {
216
237
  /** @description Friendly name of this component. */
217
238
  _name: string;
218
239
  _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
240
+ /**
241
+ * @deprecated
242
+ * @description Experimental functionality subject to change without notice.
243
+ * Defines patch overrides to component IDs that live in the composition.
244
+ * This can be used to override parameters that are defined on patterns,
245
+ * including nested patterns, with values that are specific to this composition.
246
+ * The keys in this object are component IDs.
247
+ * Overrides are applied from the top down, so for example if both the composition
248
+ * and a pattern on the composition define an override on a nested pattern,
249
+ * the composition's override replaces the pattern's.
250
+ */
251
+ _overrides?: {
252
+ [key: string]: components$2["schemas"]["ComponentOverride"];
253
+ };
254
+ /**
255
+ * @deprecated
256
+ * @description Experimental functionality subject to change without notice.
257
+ * When used on a pattern, defines how the pattern's parameters may be overridden
258
+ * by consumers of the pattern.
259
+ */
260
+ _overridability?: components$2["schemas"]["ComponentOverridability"];
261
+ };
262
+ /**
263
+ * @deprecated
264
+ * @description Experimental functionality subject to change without notice.
265
+ * Defines how to override a specific component.
266
+ */
267
+ ComponentOverride: {
268
+ parameters?: {
269
+ [key: string]: components$2["schemas"]["ComponentParameter"];
270
+ };
271
+ };
272
+ /**
273
+ * @deprecated
274
+ * @description Experimental functionality subject to change without notice.
275
+ * Defines how a component on a pattern may have its values overridden.
276
+ * NOTE: Data resources' overridability is defined in the data resource definition.
277
+ */
278
+ ComponentOverridability: {
279
+ parameters?: {
280
+ [key: string]: components$2["schemas"]["OverrideOptions"];
281
+ };
219
282
  };
283
+ /**
284
+ * @deprecated
285
+ * @description Experimental functionality subject to change without notice.
286
+ * @enum {string}
287
+ */
288
+ OverrideOptions: "yes" | "no";
220
289
  /**
221
290
  * @deprecated
222
291
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -681,14 +750,18 @@ interface external$5 {
681
750
  slots?: {
682
751
  [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
683
752
  };
684
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
753
+ /**
754
+ * @description Unique identifier of the component within the composition.
755
+ * No assumptions should be made about the format of this value other than "it will be unique."
756
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
757
+ */
685
758
  _id?: string;
686
759
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
687
760
  _pattern?: string;
688
761
  _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
689
762
  /**
690
763
  * @deprecated
691
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
764
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
692
765
  * Means nothing for PUTs; it will be ignored.
693
766
  */
694
767
  _patternDataResources?: {
@@ -703,6 +776,23 @@ interface external$5 {
703
776
  * @enum {string}
704
777
  */
705
778
  _patternError?: "NOTFOUND" | "CYCLIC";
779
+ /**
780
+ * @deprecated
781
+ * @description Experimental functionality subject to change without notice.
782
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
783
+ * This is always undefined unless `skipOverridesResolution` is true.
784
+ * See `_overrides` on `RootComponentInstance`.
785
+ */
786
+ _overrides?: {
787
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
788
+ };
789
+ /**
790
+ * @deprecated
791
+ * @description Experimental functionality subject to change without notice.
792
+ * When used on a pattern, defines how the pattern's parameters may be overridden
793
+ * by consumers of the pattern.
794
+ */
795
+ _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
706
796
  };
707
797
  /** @description Defines the shape of the root component in a composition */
708
798
  RootComponentInstance: {
@@ -727,7 +817,55 @@ interface external$5 {
727
817
  /** @description Friendly name of this component. */
728
818
  _name: string;
729
819
  _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
820
+ /**
821
+ * @deprecated
822
+ * @description Experimental functionality subject to change without notice.
823
+ * Defines patch overrides to component IDs that live in the composition.
824
+ * This can be used to override parameters that are defined on patterns,
825
+ * including nested patterns, with values that are specific to this composition.
826
+ * The keys in this object are component IDs.
827
+ * Overrides are applied from the top down, so for example if both the composition
828
+ * and a pattern on the composition define an override on a nested pattern,
829
+ * the composition's override replaces the pattern's.
830
+ */
831
+ _overrides?: {
832
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
833
+ };
834
+ /**
835
+ * @deprecated
836
+ * @description Experimental functionality subject to change without notice.
837
+ * When used on a pattern, defines how the pattern's parameters may be overridden
838
+ * by consumers of the pattern.
839
+ */
840
+ _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
841
+ };
842
+ /**
843
+ * @deprecated
844
+ * @description Experimental functionality subject to change without notice.
845
+ * Defines how to override a specific component.
846
+ */
847
+ ComponentOverride: {
848
+ parameters?: {
849
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
850
+ };
851
+ };
852
+ /**
853
+ * @deprecated
854
+ * @description Experimental functionality subject to change without notice.
855
+ * Defines how a component on a pattern may have its values overridden.
856
+ * NOTE: Data resources' overridability is defined in the data resource definition.
857
+ */
858
+ ComponentOverridability: {
859
+ parameters?: {
860
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
861
+ };
730
862
  };
863
+ /**
864
+ * @deprecated
865
+ * @description Experimental functionality subject to change without notice.
866
+ * @enum {string}
867
+ */
868
+ OverrideOptions: "yes" | "no";
731
869
  /**
732
870
  * @deprecated
733
871
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -979,6 +1117,12 @@ interface paths$3 {
979
1117
  skipPatternResolution?: components$1["parameters"]["skipPatternResolution"];
980
1118
  /** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
981
1119
  skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
1120
+ /**
1121
+ * @deprecated If true, any pattern override data is not resolved by the API.
1122
+ * This is intended for internal use in the Canvas editor, and should not be used.
1123
+ * Passing this parameter automatically implies withComponentIDs to be true.
1124
+ */
1125
+ skipOverridesResolution?: components$1["parameters"]["skipOverridesResolution"];
982
1126
  /** Specify a single composition to fetch by slug. Changes response from list to single. */
983
1127
  slug?: components$1["parameters"]["slug"];
984
1128
  /** State of compositions to fetch. 0 = draft, 64 = published. */
@@ -1177,6 +1321,13 @@ interface components$1 {
1177
1321
  * embedded into it, and serialize the pattern data separately.
1178
1322
  */
1179
1323
  skipPatternResolution: boolean;
1324
+ /**
1325
+ * @deprecated
1326
+ * @description If true, any pattern override data is not resolved by the API.
1327
+ * This is intended for internal use in the Canvas editor, and should not be used.
1328
+ * Passing this parameter automatically implies withComponentIDs to be true.
1329
+ */
1330
+ skipOverridesResolution: boolean;
1180
1331
  /** @description If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
1181
1332
  skipParameterResolution: boolean;
1182
1333
  /**
@@ -1433,14 +1584,18 @@ interface external$4 {
1433
1584
  slots?: {
1434
1585
  [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1435
1586
  };
1436
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
1587
+ /**
1588
+ * @description Unique identifier of the component within the composition.
1589
+ * No assumptions should be made about the format of this value other than "it will be unique."
1590
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
1591
+ */
1437
1592
  _id?: string;
1438
1593
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1439
1594
  _pattern?: string;
1440
1595
  _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1441
1596
  /**
1442
1597
  * @deprecated
1443
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
1598
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
1444
1599
  * Means nothing for PUTs; it will be ignored.
1445
1600
  */
1446
1601
  _patternDataResources?: {
@@ -1455,6 +1610,23 @@ interface external$4 {
1455
1610
  * @enum {string}
1456
1611
  */
1457
1612
  _patternError?: "NOTFOUND" | "CYCLIC";
1613
+ /**
1614
+ * @deprecated
1615
+ * @description Experimental functionality subject to change without notice.
1616
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
1617
+ * This is always undefined unless `skipOverridesResolution` is true.
1618
+ * See `_overrides` on `RootComponentInstance`.
1619
+ */
1620
+ _overrides?: {
1621
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1622
+ };
1623
+ /**
1624
+ * @deprecated
1625
+ * @description Experimental functionality subject to change without notice.
1626
+ * When used on a pattern, defines how the pattern's parameters may be overridden
1627
+ * by consumers of the pattern.
1628
+ */
1629
+ _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1458
1630
  };
1459
1631
  /** @description Defines the shape of the root component in a composition */
1460
1632
  RootComponentInstance: {
@@ -1479,7 +1651,55 @@ interface external$4 {
1479
1651
  /** @description Friendly name of this component. */
1480
1652
  _name: string;
1481
1653
  _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1654
+ /**
1655
+ * @deprecated
1656
+ * @description Experimental functionality subject to change without notice.
1657
+ * Defines patch overrides to component IDs that live in the composition.
1658
+ * This can be used to override parameters that are defined on patterns,
1659
+ * including nested patterns, with values that are specific to this composition.
1660
+ * The keys in this object are component IDs.
1661
+ * Overrides are applied from the top down, so for example if both the composition
1662
+ * and a pattern on the composition define an override on a nested pattern,
1663
+ * the composition's override replaces the pattern's.
1664
+ */
1665
+ _overrides?: {
1666
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1667
+ };
1668
+ /**
1669
+ * @deprecated
1670
+ * @description Experimental functionality subject to change without notice.
1671
+ * When used on a pattern, defines how the pattern's parameters may be overridden
1672
+ * by consumers of the pattern.
1673
+ */
1674
+ _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1675
+ };
1676
+ /**
1677
+ * @deprecated
1678
+ * @description Experimental functionality subject to change without notice.
1679
+ * Defines how to override a specific component.
1680
+ */
1681
+ ComponentOverride: {
1682
+ parameters?: {
1683
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1684
+ };
1685
+ };
1686
+ /**
1687
+ * @deprecated
1688
+ * @description Experimental functionality subject to change without notice.
1689
+ * Defines how a component on a pattern may have its values overridden.
1690
+ * NOTE: Data resources' overridability is defined in the data resource definition.
1691
+ */
1692
+ ComponentOverridability: {
1693
+ parameters?: {
1694
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1695
+ };
1482
1696
  };
1697
+ /**
1698
+ * @deprecated
1699
+ * @description Experimental functionality subject to change without notice.
1700
+ * @enum {string}
1701
+ */
1702
+ OverrideOptions: "yes" | "no";
1483
1703
  /**
1484
1704
  * @deprecated
1485
1705
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -1650,11 +1870,20 @@ interface components {
1650
1870
  };
1651
1871
  UniformError: components["schemas"]["EdgehancersError"] | external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
1652
1872
  InvalidationPayload: {
1873
+ /** @description List of variables with values to invalidate */
1653
1874
  variables?: {
1654
1875
  name: string;
1655
1876
  value: string;
1656
1877
  }[];
1878
+ /** @description List of surrogate keys to invalidate */
1879
+ surrogateKeys?: string[];
1657
1880
  };
1881
+ BatchInvalidationPayload: {
1882
+ dataTypeId: string;
1883
+ /** Format: uuid */
1884
+ purgeKey: string;
1885
+ conditions?: components["schemas"]["InvalidationPayload"];
1886
+ }[];
1658
1887
  DataDiagnostic: {
1659
1888
  componentPath: string;
1660
1889
  dataType: string;
@@ -1676,16 +1905,10 @@ interface components {
1676
1905
  };
1677
1906
  InvalidationResult: {
1678
1907
  ok: boolean;
1679
- input: {
1680
- /** Format: uuid */
1681
- projectId: string;
1682
- /** Format: uuid */
1683
- dataTypeId: string;
1684
- dataVariable?: {
1685
- name: string;
1686
- value: string;
1687
- };
1688
- };
1908
+ };
1909
+ BatchInvalidationResult: {
1910
+ ok: number;
1911
+ failed: number;
1689
1912
  };
1690
1913
  };
1691
1914
  responses: {
@@ -1749,6 +1972,12 @@ interface components {
1749
1972
  "application/json": components["schemas"]["InvalidationResult"];
1750
1973
  };
1751
1974
  };
1975
+ /** Batch invalidation request was processed; number of successful and failed jobs is included */
1976
+ BatchInvalidationResult: {
1977
+ content: {
1978
+ "application/json": components["schemas"]["BatchInvalidationResult"];
1979
+ };
1980
+ };
1752
1981
  };
1753
1982
  }
1754
1983
  interface external$3 {
@@ -1961,14 +2190,18 @@ interface external$3 {
1961
2190
  slots?: {
1962
2191
  [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1963
2192
  };
1964
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
2193
+ /**
2194
+ * @description Unique identifier of the component within the composition.
2195
+ * No assumptions should be made about the format of this value other than "it will be unique."
2196
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
2197
+ */
1965
2198
  _id?: string;
1966
2199
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1967
2200
  _pattern?: string;
1968
2201
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1969
2202
  /**
1970
2203
  * @deprecated
1971
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
2204
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
1972
2205
  * Means nothing for PUTs; it will be ignored.
1973
2206
  */
1974
2207
  _patternDataResources?: {
@@ -1983,6 +2216,23 @@ interface external$3 {
1983
2216
  * @enum {string}
1984
2217
  */
1985
2218
  _patternError?: "NOTFOUND" | "CYCLIC";
2219
+ /**
2220
+ * @deprecated
2221
+ * @description Experimental functionality subject to change without notice.
2222
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
2223
+ * This is always undefined unless `skipOverridesResolution` is true.
2224
+ * See `_overrides` on `RootComponentInstance`.
2225
+ */
2226
+ _overrides?: {
2227
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2228
+ };
2229
+ /**
2230
+ * @deprecated
2231
+ * @description Experimental functionality subject to change without notice.
2232
+ * When used on a pattern, defines how the pattern's parameters may be overridden
2233
+ * by consumers of the pattern.
2234
+ */
2235
+ _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1986
2236
  };
1987
2237
  /** @description Defines the shape of the root component in a composition */
1988
2238
  RootComponentInstance: {
@@ -2007,7 +2257,55 @@ interface external$3 {
2007
2257
  /** @description Friendly name of this component. */
2008
2258
  _name: string;
2009
2259
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2260
+ /**
2261
+ * @deprecated
2262
+ * @description Experimental functionality subject to change without notice.
2263
+ * Defines patch overrides to component IDs that live in the composition.
2264
+ * This can be used to override parameters that are defined on patterns,
2265
+ * including nested patterns, with values that are specific to this composition.
2266
+ * The keys in this object are component IDs.
2267
+ * Overrides are applied from the top down, so for example if both the composition
2268
+ * and a pattern on the composition define an override on a nested pattern,
2269
+ * the composition's override replaces the pattern's.
2270
+ */
2271
+ _overrides?: {
2272
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2273
+ };
2274
+ /**
2275
+ * @deprecated
2276
+ * @description Experimental functionality subject to change without notice.
2277
+ * When used on a pattern, defines how the pattern's parameters may be overridden
2278
+ * by consumers of the pattern.
2279
+ */
2280
+ _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2281
+ };
2282
+ /**
2283
+ * @deprecated
2284
+ * @description Experimental functionality subject to change without notice.
2285
+ * Defines how to override a specific component.
2286
+ */
2287
+ ComponentOverride: {
2288
+ parameters?: {
2289
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2290
+ };
2291
+ };
2292
+ /**
2293
+ * @deprecated
2294
+ * @description Experimental functionality subject to change without notice.
2295
+ * Defines how a component on a pattern may have its values overridden.
2296
+ * NOTE: Data resources' overridability is defined in the data resource definition.
2297
+ */
2298
+ ComponentOverridability: {
2299
+ parameters?: {
2300
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2301
+ };
2010
2302
  };
2303
+ /**
2304
+ * @deprecated
2305
+ * @description Experimental functionality subject to change without notice.
2306
+ * @enum {string}
2307
+ */
2308
+ OverrideOptions: "yes" | "no";
2011
2309
  /**
2012
2310
  * @deprecated
2013
2311
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -2219,6 +2517,12 @@ interface external$3 {
2219
2517
  skipPatternResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
2220
2518
  /** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
2221
2519
  skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
2520
+ /**
2521
+ * @deprecated If true, any pattern override data is not resolved by the API.
2522
+ * This is intended for internal use in the Canvas editor, and should not be used.
2523
+ * Passing this parameter automatically implies withComponentIDs to be true.
2524
+ */
2525
+ skipOverridesResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
2222
2526
  /** Specify a single composition to fetch by slug. Changes response from list to single. */
2223
2527
  slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
2224
2528
  /** State of compositions to fetch. 0 = draft, 64 = published. */
@@ -2417,6 +2721,13 @@ interface external$3 {
2417
2721
  * embedded into it, and serialize the pattern data separately.
2418
2722
  */
2419
2723
  skipPatternResolution: boolean;
2724
+ /**
2725
+ * @deprecated
2726
+ * @description If true, any pattern override data is not resolved by the API.
2727
+ * This is intended for internal use in the Canvas editor, and should not be used.
2728
+ * Passing this parameter automatically implies withComponentIDs to be true.
2729
+ */
2730
+ skipOverridesResolution: boolean;
2420
2731
  /** @description If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
2421
2732
  skipParameterResolution: boolean;
2422
2733
  /**
@@ -2516,6 +2827,26 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
2516
2827
  };
2517
2828
  /** Defines the shape of the root component in a composition */
2518
2829
  type RootComponentInstance = SharedComponents['RootComponentInstance'];
2830
+ /**
2831
+ * Defines the shape of a component override
2832
+ * @deprecated
2833
+ */
2834
+ type OverrideOptions = SharedComponents['OverrideOptions'];
2835
+ /**
2836
+ * Defines the shape of a component override
2837
+ * @deprecated
2838
+ */
2839
+ type ComponentOverride = SharedComponents['ComponentOverride'];
2840
+ /**
2841
+ * Defines a set of component overrides by component ID
2842
+ * @deprecated
2843
+ */
2844
+ type ComponentOverrides = Record<string, ComponentOverride>;
2845
+ /**
2846
+ * Defines how a component on a pattern may have its values overridden
2847
+ * @deprecated
2848
+ */
2849
+ type ComponentOverridability = SharedComponents['ComponentOverridability'];
2519
2850
  /** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
2520
2851
  type CanvasDefinitions = {
2521
2852
  components?: Array<ComponentDefinition>;
@@ -2523,7 +2854,7 @@ type CanvasDefinitions = {
2523
2854
  dataTypes?: Array<DataType>;
2524
2855
  };
2525
2856
  /** Defines shared parameters for requests getting a single composition */
2526
- type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
2857
+ type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution'>;
2527
2858
  type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
2528
2859
  type SpecificProjectMap = {
2529
2860
  projectMapId?: string;
@@ -2556,7 +2887,7 @@ type DataResolutionParameters = {
2556
2887
  unstable_dynamicVariables?: Record<string, string>;
2557
2888
  };
2558
2889
  /** Types of issue that can occur when fetching composition data */
2559
- type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
2890
+ type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue | OverrideIssue;
2560
2891
  type CompositionIssueCore = components['schemas']['CompositionIssue'];
2561
2892
  /** An error that occured resolving a pattern that is referenced on the composition */
2562
2893
  type CompositionPatternIssue = CompositionIssueCore & {
@@ -2579,10 +2910,16 @@ type DataResourceVariableIssue = CompositionIssueCore & {
2579
2910
  type: 'variable';
2580
2911
  variableName: string;
2581
2912
  };
2913
+ /** Error in data resolution configuration (internal error) */
2582
2914
  type DataResolutionConfigIssue = {
2583
2915
  message: string;
2584
2916
  type: 'config';
2585
2917
  };
2918
+ /** Error in applying component overrides */
2919
+ type OverrideIssue = CompositionIssueCore & {
2920
+ message: string;
2921
+ type: 'override';
2922
+ };
2586
2923
  /** Diagnostic data about the load performance of attached composition datas */
2587
2924
  type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
2588
2925
  /** Response as it comes from the data resolution endpoint */
@@ -2680,6 +3017,26 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
2680
3017
  };
2681
3018
  } | undefined;
2682
3019
  _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
3020
+ _overrides?: {
3021
+ [key: string]: {
3022
+ parameters?: {
3023
+ [key: string]: {
3024
+ value: unknown;
3025
+ type: string;
3026
+ connectedData?: {
3027
+ pointer: string;
3028
+ syntax: "jptr";
3029
+ required?: boolean | undefined;
3030
+ } | undefined;
3031
+ };
3032
+ } | undefined;
3033
+ };
3034
+ } | undefined;
3035
+ _overridability?: {
3036
+ parameters?: {
3037
+ [key: string]: "no" | "yes";
3038
+ } | undefined;
3039
+ } | undefined;
2683
3040
  }[];
2684
3041
  } | undefined;
2685
3042
  _id: string;
@@ -2694,6 +3051,26 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
2694
3051
  } | undefined;
2695
3052
  };
2696
3053
  } | undefined;
3054
+ _overrides?: {
3055
+ [key: string]: {
3056
+ parameters?: {
3057
+ [key: string]: {
3058
+ value: unknown;
3059
+ type: string;
3060
+ connectedData?: {
3061
+ pointer: string;
3062
+ syntax: "jptr";
3063
+ required?: boolean | undefined;
3064
+ } | undefined;
3065
+ };
3066
+ } | undefined;
3067
+ };
3068
+ } | undefined;
3069
+ _overridability?: {
3070
+ parameters?: {
3071
+ [key: string]: "no" | "yes";
3072
+ } | undefined;
3073
+ } | undefined;
2697
3074
  };
2698
3075
  }[];
2699
3076
  totalCount?: number | undefined;
@@ -2796,6 +3173,26 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
2796
3173
  };
2797
3174
  } | undefined;
2798
3175
  _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
3176
+ _overrides?: {
3177
+ [key: string]: {
3178
+ parameters?: {
3179
+ [key: string]: {
3180
+ value: unknown;
3181
+ type: string;
3182
+ connectedData?: {
3183
+ pointer: string;
3184
+ syntax: "jptr";
3185
+ required?: boolean | undefined;
3186
+ } | undefined;
3187
+ };
3188
+ } | undefined;
3189
+ };
3190
+ } | undefined;
3191
+ _overridability?: {
3192
+ parameters?: {
3193
+ [key: string]: "no" | "yes";
3194
+ } | undefined;
3195
+ } | undefined;
2799
3196
  } | null | undefined;
2800
3197
  variants?: {
2801
3198
  id: string;
@@ -3103,14 +3500,18 @@ interface external$2 {
3103
3500
  slots?: {
3104
3501
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3105
3502
  };
3106
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
3503
+ /**
3504
+ * @description Unique identifier of the component within the composition.
3505
+ * No assumptions should be made about the format of this value other than "it will be unique."
3506
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
3507
+ */
3107
3508
  _id?: string;
3108
3509
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
3109
3510
  _pattern?: string;
3110
3511
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3111
3512
  /**
3112
3513
  * @deprecated
3113
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
3514
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3114
3515
  * Means nothing for PUTs; it will be ignored.
3115
3516
  */
3116
3517
  _patternDataResources?: {
@@ -3125,6 +3526,23 @@ interface external$2 {
3125
3526
  * @enum {string}
3126
3527
  */
3127
3528
  _patternError?: "NOTFOUND" | "CYCLIC";
3529
+ /**
3530
+ * @deprecated
3531
+ * @description Experimental functionality subject to change without notice.
3532
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
3533
+ * This is always undefined unless `skipOverridesResolution` is true.
3534
+ * See `_overrides` on `RootComponentInstance`.
3535
+ */
3536
+ _overrides?: {
3537
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3538
+ };
3539
+ /**
3540
+ * @deprecated
3541
+ * @description Experimental functionality subject to change without notice.
3542
+ * When used on a pattern, defines how the pattern's parameters may be overridden
3543
+ * by consumers of the pattern.
3544
+ */
3545
+ _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3128
3546
  };
3129
3547
  /** @description Defines the shape of the root component in a composition */
3130
3548
  RootComponentInstance: {
@@ -3149,7 +3567,55 @@ interface external$2 {
3149
3567
  /** @description Friendly name of this component. */
3150
3568
  _name: string;
3151
3569
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3570
+ /**
3571
+ * @deprecated
3572
+ * @description Experimental functionality subject to change without notice.
3573
+ * Defines patch overrides to component IDs that live in the composition.
3574
+ * This can be used to override parameters that are defined on patterns,
3575
+ * including nested patterns, with values that are specific to this composition.
3576
+ * The keys in this object are component IDs.
3577
+ * Overrides are applied from the top down, so for example if both the composition
3578
+ * and a pattern on the composition define an override on a nested pattern,
3579
+ * the composition's override replaces the pattern's.
3580
+ */
3581
+ _overrides?: {
3582
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3583
+ };
3584
+ /**
3585
+ * @deprecated
3586
+ * @description Experimental functionality subject to change without notice.
3587
+ * When used on a pattern, defines how the pattern's parameters may be overridden
3588
+ * by consumers of the pattern.
3589
+ */
3590
+ _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3591
+ };
3592
+ /**
3593
+ * @deprecated
3594
+ * @description Experimental functionality subject to change without notice.
3595
+ * Defines how to override a specific component.
3596
+ */
3597
+ ComponentOverride: {
3598
+ parameters?: {
3599
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3600
+ };
3601
+ };
3602
+ /**
3603
+ * @deprecated
3604
+ * @description Experimental functionality subject to change without notice.
3605
+ * Defines how a component on a pattern may have its values overridden.
3606
+ * NOTE: Data resources' overridability is defined in the data resource definition.
3607
+ */
3608
+ ComponentOverridability: {
3609
+ parameters?: {
3610
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
3611
+ };
3152
3612
  };
3613
+ /**
3614
+ * @deprecated
3615
+ * @description Experimental functionality subject to change without notice.
3616
+ * @enum {string}
3617
+ */
3618
+ OverrideOptions: "yes" | "no";
3153
3619
  /**
3154
3620
  * @deprecated
3155
3621
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -3556,14 +4022,18 @@ interface external$1 {
3556
4022
  slots?: {
3557
4023
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3558
4024
  };
3559
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
4025
+ /**
4026
+ * @description Unique identifier of the component within the composition.
4027
+ * No assumptions should be made about the format of this value other than "it will be unique."
4028
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
4029
+ */
3560
4030
  _id?: string;
3561
4031
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
3562
4032
  _pattern?: string;
3563
4033
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3564
4034
  /**
3565
4035
  * @deprecated
3566
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
4036
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3567
4037
  * Means nothing for PUTs; it will be ignored.
3568
4038
  */
3569
4039
  _patternDataResources?: {
@@ -3578,6 +4048,23 @@ interface external$1 {
3578
4048
  * @enum {string}
3579
4049
  */
3580
4050
  _patternError?: "NOTFOUND" | "CYCLIC";
4051
+ /**
4052
+ * @deprecated
4053
+ * @description Experimental functionality subject to change without notice.
4054
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
4055
+ * This is always undefined unless `skipOverridesResolution` is true.
4056
+ * See `_overrides` on `RootComponentInstance`.
4057
+ */
4058
+ _overrides?: {
4059
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4060
+ };
4061
+ /**
4062
+ * @deprecated
4063
+ * @description Experimental functionality subject to change without notice.
4064
+ * When used on a pattern, defines how the pattern's parameters may be overridden
4065
+ * by consumers of the pattern.
4066
+ */
4067
+ _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3581
4068
  };
3582
4069
  /** @description Defines the shape of the root component in a composition */
3583
4070
  RootComponentInstance: {
@@ -3602,7 +4089,55 @@ interface external$1 {
3602
4089
  /** @description Friendly name of this component. */
3603
4090
  _name: string;
3604
4091
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4092
+ /**
4093
+ * @deprecated
4094
+ * @description Experimental functionality subject to change without notice.
4095
+ * Defines patch overrides to component IDs that live in the composition.
4096
+ * This can be used to override parameters that are defined on patterns,
4097
+ * including nested patterns, with values that are specific to this composition.
4098
+ * The keys in this object are component IDs.
4099
+ * Overrides are applied from the top down, so for example if both the composition
4100
+ * and a pattern on the composition define an override on a nested pattern,
4101
+ * the composition's override replaces the pattern's.
4102
+ */
4103
+ _overrides?: {
4104
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4105
+ };
4106
+ /**
4107
+ * @deprecated
4108
+ * @description Experimental functionality subject to change without notice.
4109
+ * When used on a pattern, defines how the pattern's parameters may be overridden
4110
+ * by consumers of the pattern.
4111
+ */
4112
+ _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4113
+ };
4114
+ /**
4115
+ * @deprecated
4116
+ * @description Experimental functionality subject to change without notice.
4117
+ * Defines how to override a specific component.
4118
+ */
4119
+ ComponentOverride: {
4120
+ parameters?: {
4121
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
4122
+ };
4123
+ };
4124
+ /**
4125
+ * @deprecated
4126
+ * @description Experimental functionality subject to change without notice.
4127
+ * Defines how a component on a pattern may have its values overridden.
4128
+ * NOTE: Data resources' overridability is defined in the data resource definition.
4129
+ */
4130
+ ComponentOverridability: {
4131
+ parameters?: {
4132
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
4133
+ };
3605
4134
  };
4135
+ /**
4136
+ * @deprecated
4137
+ * @description Experimental functionality subject to change without notice.
4138
+ * @enum {string}
4139
+ */
4140
+ OverrideOptions: "yes" | "no";
3606
4141
  /**
3607
4142
  * @deprecated
3608
4143
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -4044,14 +4579,18 @@ interface external {
4044
4579
  slots?: {
4045
4580
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
4046
4581
  };
4047
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
4582
+ /**
4583
+ * @description Unique identifier of the component within the composition.
4584
+ * No assumptions should be made about the format of this value other than "it will be unique."
4585
+ * This is not set unless specifically requested via `withComponentIDs` API parameter.
4586
+ */
4048
4587
  _id?: string;
4049
4588
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
4050
4589
  _pattern?: string;
4051
4590
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4052
4591
  /**
4053
4592
  * @deprecated
4054
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
4593
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
4055
4594
  * Means nothing for PUTs; it will be ignored.
4056
4595
  */
4057
4596
  _patternDataResources?: {
@@ -4066,6 +4605,23 @@ interface external {
4066
4605
  * @enum {string}
4067
4606
  */
4068
4607
  _patternError?: "NOTFOUND" | "CYCLIC";
4608
+ /**
4609
+ * @deprecated
4610
+ * @description Experimental functionality subject to change without notice.
4611
+ * Contains overrides that are defined on a pattern instance reference nested in a composition.
4612
+ * This is always undefined unless `skipOverridesResolution` is true.
4613
+ * See `_overrides` on `RootComponentInstance`.
4614
+ */
4615
+ _overrides?: {
4616
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4617
+ };
4618
+ /**
4619
+ * @deprecated
4620
+ * @description Experimental functionality subject to change without notice.
4621
+ * When used on a pattern, defines how the pattern's parameters may be overridden
4622
+ * by consumers of the pattern.
4623
+ */
4624
+ _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4069
4625
  };
4070
4626
  /** @description Defines the shape of the root component in a composition */
4071
4627
  RootComponentInstance: {
@@ -4090,7 +4646,55 @@ interface external {
4090
4646
  /** @description Friendly name of this component. */
4091
4647
  _name: string;
4092
4648
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4649
+ /**
4650
+ * @deprecated
4651
+ * @description Experimental functionality subject to change without notice.
4652
+ * Defines patch overrides to component IDs that live in the composition.
4653
+ * This can be used to override parameters that are defined on patterns,
4654
+ * including nested patterns, with values that are specific to this composition.
4655
+ * The keys in this object are component IDs.
4656
+ * Overrides are applied from the top down, so for example if both the composition
4657
+ * and a pattern on the composition define an override on a nested pattern,
4658
+ * the composition's override replaces the pattern's.
4659
+ */
4660
+ _overrides?: {
4661
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4662
+ };
4663
+ /**
4664
+ * @deprecated
4665
+ * @description Experimental functionality subject to change without notice.
4666
+ * When used on a pattern, defines how the pattern's parameters may be overridden
4667
+ * by consumers of the pattern.
4668
+ */
4669
+ _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4093
4670
  };
4671
+ /**
4672
+ * @deprecated
4673
+ * @description Experimental functionality subject to change without notice.
4674
+ * Defines how to override a specific component.
4675
+ */
4676
+ ComponentOverride: {
4677
+ parameters?: {
4678
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
4679
+ };
4680
+ };
4681
+ /**
4682
+ * @deprecated
4683
+ * @description Experimental functionality subject to change without notice.
4684
+ * Defines how a component on a pattern may have its values overridden.
4685
+ * NOTE: Data resources' overridability is defined in the data resource definition.
4686
+ */
4687
+ ComponentOverridability: {
4688
+ parameters?: {
4689
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
4690
+ };
4691
+ };
4692
+ /**
4693
+ * @deprecated
4694
+ * @description Experimental functionality subject to change without notice.
4695
+ * @enum {string}
4696
+ */
4697
+ OverrideOptions: "yes" | "no";
4094
4698
  /**
4095
4699
  * @deprecated
4096
4700
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
@@ -4360,7 +4964,7 @@ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TCo
4360
4964
  type schemas = components['schemas'];
4361
4965
  type InvalidationPayload = schemas['InvalidationPayload'];
4362
4966
  type InvalidationResult = schemas['InvalidationResult'];
4363
- type InvalidationInput = InvalidationResult['input'];
4967
+ type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
4364
4968
 
4365
4969
  /**
4366
4970
  * @deprecated
@@ -4860,6 +5464,26 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
4860
5464
  };
4861
5465
  } | undefined;
4862
5466
  _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
5467
+ _overrides?: {
5468
+ [key: string]: {
5469
+ parameters?: {
5470
+ [key: string]: {
5471
+ value: unknown;
5472
+ type: string;
5473
+ connectedData?: {
5474
+ pointer: string;
5475
+ syntax: "jptr";
5476
+ required?: boolean | undefined;
5477
+ } | undefined;
5478
+ };
5479
+ } | undefined;
5480
+ };
5481
+ } | undefined;
5482
+ _overridability?: {
5483
+ parameters?: {
5484
+ [key: string]: "no" | "yes";
5485
+ } | undefined;
5486
+ } | undefined;
4863
5487
  }[];
4864
5488
  } | undefined;
4865
5489
  _id: string;
@@ -4874,6 +5498,26 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
4874
5498
  } | undefined;
4875
5499
  };
4876
5500
  } | undefined;
5501
+ _overrides?: {
5502
+ [key: string]: {
5503
+ parameters?: {
5504
+ [key: string]: {
5505
+ value: unknown;
5506
+ type: string;
5507
+ connectedData?: {
5508
+ pointer: string;
5509
+ syntax: "jptr";
5510
+ required?: boolean | undefined;
5511
+ } | undefined;
5512
+ };
5513
+ } | undefined;
5514
+ };
5515
+ } | undefined;
5516
+ _overridability?: {
5517
+ parameters?: {
5518
+ [key: string]: "no" | "yes";
5519
+ } | undefined;
5520
+ } | undefined;
4877
5521
  }>;
4878
5522
 
4879
5523
  declare const generateHash: ({ composition, secret, }: {
@@ -4898,4 +5542,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
4898
5542
 
4899
5543
  declare const CanvasClientError: typeof ApiClientError;
4900
5544
 
4901
- export { AddComponentMessage, BatchEnhancer, BatchEntry, 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, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, 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, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationInput, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
5545
+ 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, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, 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, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };