@uniformdev/canvas 18.38.2-alpha.6 → 19.1.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
@@ -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
  };
@@ -462,7 +462,7 @@ interface components$2 {
462
462
  * This file was auto-generated by openapi-typescript.
463
463
  * Do not make direct changes to the file.
464
464
  */
465
- interface paths$4 {
465
+ interface paths$6 {
466
466
  "/api/v1/canvas-definitions": {
467
467
  get: {
468
468
  parameters: {
@@ -485,15 +485,15 @@ interface paths$4 {
485
485
  content: {
486
486
  "application/json": {
487
487
  /** @description Component definitions that match the query */
488
- componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
488
+ componentDefinitions: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
489
489
  };
490
490
  };
491
491
  };
492
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
493
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
494
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
495
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
496
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
492
+ 400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
493
+ 401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
494
+ 403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
495
+ 429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
496
+ 500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
497
497
  };
498
498
  };
499
499
  /** Upserts a component definition */
@@ -501,11 +501,11 @@ interface paths$4 {
501
501
  responses: {
502
502
  /** OK */
503
503
  204: never;
504
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
505
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
506
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
507
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
508
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
504
+ 400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
505
+ 401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
506
+ 403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
507
+ 429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
508
+ 500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
509
509
  };
510
510
  requestBody: {
511
511
  content: {
@@ -515,7 +515,7 @@ interface paths$4 {
515
515
  * @description The project ID to upsert the component definition to
516
516
  */
517
517
  projectId: string;
518
- componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
518
+ componentDefinition: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
519
519
  };
520
520
  };
521
521
  };
@@ -525,11 +525,11 @@ interface paths$4 {
525
525
  responses: {
526
526
  /** OK */
527
527
  204: never;
528
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
529
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
530
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
531
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
532
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
528
+ 400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
529
+ 401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
530
+ 403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
531
+ 429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
532
+ 500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
533
533
  };
534
534
  requestBody: {
535
535
  content: {
@@ -554,7 +554,7 @@ interface paths$4 {
554
554
  };
555
555
  };
556
556
  }
557
- interface external$5 {
557
+ interface external$7 {
558
558
  "swagger.yml": {
559
559
  paths: {};
560
560
  components: {
@@ -568,25 +568,25 @@ interface external$5 {
568
568
  /** Request input validation failed */
569
569
  BadRequestError: {
570
570
  content: {
571
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
571
+ "application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
572
572
  };
573
573
  };
574
574
  /** API key or token was not valid */
575
575
  UnauthorizedError: {
576
576
  content: {
577
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
577
+ "application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
578
578
  };
579
579
  };
580
580
  /** Permission was denied */
581
581
  ForbiddenError: {
582
582
  content: {
583
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
583
+ "application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
584
584
  };
585
585
  };
586
586
  /** Resource not found */
587
587
  NotFoundError: {
588
588
  content: {
589
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
589
+ "application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
590
590
  };
591
591
  };
592
592
  /** Too many requests in allowed time period */
@@ -605,7 +605,7 @@ interface external$5 {
605
605
  PublicIdProperty: string;
606
606
  /** @description The definition of a component parameter */
607
607
  ComponentDefinitionParameter: {
608
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
608
+ id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
609
609
  /** @description Friendly name of the parameter */
610
610
  name: string;
611
611
  /** @description Appears next to the parameter in the Composition editor */
@@ -617,7 +617,7 @@ interface external$5 {
617
617
  };
618
618
  /** @description The definition of a named component slot that can contain other components */
619
619
  ComponentDefinitionSlot: {
620
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
620
+ id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
621
621
  /** @description Friendly name of the slot */
622
622
  name: string;
623
623
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -675,13 +675,13 @@ interface external$5 {
675
675
  };
676
676
  /** @description The definition of a component variant */
677
677
  ComponentDefinitionVariant: {
678
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
678
+ id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
679
679
  /** @description Friendly name of the variant */
680
680
  name: string;
681
681
  };
682
682
  /** @description Permission set for a component defintion */
683
683
  ComponentDefinitionPermission: {
684
- roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
684
+ roleId: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
685
685
  /**
686
686
  * @description Permission type for this permission ComponentDefinition:
687
687
  * read | write | create | delete
@@ -694,7 +694,7 @@ interface external$5 {
694
694
  };
695
695
  /** @description Defines a component type that can live on a Composition */
696
696
  ComponentDefinition: {
697
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
697
+ id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
698
698
  /** @description Friendly name of the component definition */
699
699
  name: string;
700
700
  /**
@@ -713,21 +713,21 @@ interface external$5 {
713
713
  */
714
714
  canBeComposition?: boolean;
715
715
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
716
- parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
716
+ parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
717
717
  /**
718
718
  * @description if this component uses team permissions or custom permissions
719
719
  * @default true
720
720
  */
721
721
  useTeamPermissions?: boolean;
722
722
  /** @description Custom role permissions for this component definition */
723
- permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
723
+ permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
724
724
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
725
- slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
726
- slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
725
+ slots?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
726
+ slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
727
727
  /** @description Default component instance value */
728
- defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
728
+ defaults?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
729
729
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
730
- variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
730
+ variants?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
731
731
  /** @description Created date string for this definition (ignored for writes) */
732
732
  created?: string;
733
733
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -739,11 +739,13 @@ interface external$5 {
739
739
  value: unknown;
740
740
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
741
741
  type: string;
742
- connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
742
+ connectedData?: external$7["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. */
@@ -760,13 +762,13 @@ interface external$5 {
760
762
  type: string;
761
763
  /** @description Component parameter values for the component instance */
762
764
  parameters?: {
763
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
765
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
764
766
  };
765
767
  /** @description Public ID of alternate visual appearance for this component, if any selected */
766
768
  variant?: string;
767
769
  /** @description Slots containing any child components */
768
770
  slots?: {
769
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
771
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
770
772
  };
771
773
  /**
772
774
  * @description Unique identifier of the component within the composition.
@@ -776,14 +778,13 @@ interface external$5 {
776
778
  _id?: string;
777
779
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
778
780
  _pattern?: string;
779
- _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
781
+ _dataResources?: external$7["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
  */
785
786
  _patternDataResources?: {
786
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
787
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
787
788
  };
788
789
  /**
789
790
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -795,22 +796,28 @@ 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
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
811
+ [key: string]: external$7["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
- _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
820
+ _overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
814
821
  };
815
822
  /** @description Defines the shape of the root component in a composition */
816
823
  RootComponentInstance: {
@@ -818,15 +825,15 @@ interface external$5 {
818
825
  type: string;
819
826
  /** @description Component parameter values for the component instance */
820
827
  parameters?: {
821
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
828
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
822
829
  };
823
830
  /** @description Public ID of alternate visual appearance for this component, if any selected */
824
831
  variant?: string;
825
832
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
826
- projectMapNodes?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
833
+ projectMapNodes?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
827
834
  /** @description Slots containing any child components */
828
835
  slots?: {
829
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
836
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
830
837
  };
831
838
  /** @description The public UUID of the composition. */
832
839
  _id: string;
@@ -834,62 +841,68 @@ interface external$5 {
834
841
  _slug?: string | null;
835
842
  /** @description Friendly name of this component. */
836
843
  _name: string;
837
- _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
844
+ _dataResources?: external$7["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
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
858
+ [key: string]: external$7["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
- _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
867
+ _overridability?: external$7["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?: {
867
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
877
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
868
878
  };
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. */
879
890
  parameters?: {
880
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
891
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
881
892
  };
882
893
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
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"
@@ -916,17 +929,14 @@ interface external$5 {
916
929
  }[];
917
930
  /** @description Variables needed to make calls to the data source */
918
931
  variables?: {
919
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
932
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
920
933
  };
921
934
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
922
935
  custom?: {
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;
@@ -976,17 +986,14 @@ interface external$5 {
976
986
  method: "GET" | "POST" | "HEAD";
977
987
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
978
988
  variables?: {
979
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
989
+ [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
980
990
  };
981
991
  /** @description Custom configuration specific to the data source being defined */
982
992
  custom?: {
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
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1017
+ [key: string]: external$7["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;
@@ -1025,12 +1028,9 @@ interface external$5 {
1025
1028
  * If isPatternParameter is false or undefined, this has no meaning.
1026
1029
  */
1027
1030
  ignorePatternParameterDefault?: boolean;
1028
- variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1031
+ variables?: external$7["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
  };
@@ -1056,7 +1056,7 @@ interface external$5 {
1056
1056
  }
1057
1057
 
1058
1058
  type SharedComponents$1 = components$2['schemas'];
1059
- type Api$1 = paths$4['/api/v1/canvas-definitions'];
1059
+ type Api$1 = paths$6['/api/v1/canvas-definitions'];
1060
1060
  /** Shape of the GET response from /api/v1/canvas-definitions */
1061
1061
  type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
1062
1062
  /** Shape of the PUT request body for /api/v1/canvas-definitions */
@@ -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,14 +1079,12 @@ 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.
1095
1085
  * Do not make direct changes to the file.
1096
1086
  */
1097
- interface paths$3 {
1087
+ interface paths$5 {
1098
1088
  "/api/v1/canvas": {
1099
1089
  get: {
1100
1090
  parameters: {
@@ -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
  */
@@ -1195,17 +1185,17 @@ interface paths$3 {
1195
1185
  "application/json": components$1["schemas"]["CompositionListResponse"] | components$1["schemas"]["CompositionApiResponse"];
1196
1186
  };
1197
1187
  };
1198
- 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
1199
- 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1200
- 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1188
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
1189
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1190
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1201
1191
  /** Composition not found */
1202
1192
  404: {
1203
1193
  content: {
1204
1194
  "text/plain": string;
1205
1195
  };
1206
1196
  };
1207
- 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
1208
- 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
1197
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
1198
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
1209
1199
  };
1210
1200
  };
1211
1201
  /** Upserts a composition */
@@ -1213,11 +1203,11 @@ interface paths$3 {
1213
1203
  responses: {
1214
1204
  /** OK */
1215
1205
  204: never;
1216
- 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
1217
- 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1218
- 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1219
- 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
1220
- 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
1206
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
1207
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1208
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1209
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
1210
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
1221
1211
  };
1222
1212
  requestBody: {
1223
1213
  content: {
@@ -1229,7 +1219,7 @@ interface paths$3 {
1229
1219
  projectId: string;
1230
1220
  /** @description The state of the composition to upsert into. 0 = draft, 64 = published */
1231
1221
  state: number;
1232
- composition: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1222
+ composition: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1233
1223
  /**
1234
1224
  * @description True if the composition is a pattern (which can be referenced on other compositions)
1235
1225
  * @default false
@@ -1248,11 +1238,11 @@ interface paths$3 {
1248
1238
  responses: {
1249
1239
  /** OK */
1250
1240
  204: never;
1251
- 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
1252
- 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1253
- 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1254
- 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
1255
- 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
1241
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
1242
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1243
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1244
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
1245
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
1256
1246
  };
1257
1247
  requestBody: {
1258
1248
  content: {
@@ -1310,7 +1300,7 @@ interface components$1 {
1310
1300
  modified: string;
1311
1301
  /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
1312
1302
  pattern: boolean;
1313
- composition: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1303
+ composition: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1314
1304
  };
1315
1305
  CompositionListResponse: {
1316
1306
  compositions: components$1["schemas"]["CompositionApiResponse"][];
@@ -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.
@@ -1412,7 +1401,7 @@ interface components$1 {
1412
1401
  withTotalCount: boolean;
1413
1402
  };
1414
1403
  }
1415
- interface external$4 {
1404
+ interface external$6 {
1416
1405
  "swagger.yml": {
1417
1406
  paths: {};
1418
1407
  components: {
@@ -1426,25 +1415,25 @@ interface external$4 {
1426
1415
  /** Request input validation failed */
1427
1416
  BadRequestError: {
1428
1417
  content: {
1429
- "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
1418
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
1430
1419
  };
1431
1420
  };
1432
1421
  /** API key or token was not valid */
1433
1422
  UnauthorizedError: {
1434
1423
  content: {
1435
- "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
1424
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
1436
1425
  };
1437
1426
  };
1438
1427
  /** Permission was denied */
1439
1428
  ForbiddenError: {
1440
1429
  content: {
1441
- "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
1430
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
1442
1431
  };
1443
1432
  };
1444
1433
  /** Resource not found */
1445
1434
  NotFoundError: {
1446
1435
  content: {
1447
- "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
1436
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
1448
1437
  };
1449
1438
  };
1450
1439
  /** Too many requests in allowed time period */
@@ -1463,7 +1452,7 @@ interface external$4 {
1463
1452
  PublicIdProperty: string;
1464
1453
  /** @description The definition of a component parameter */
1465
1454
  ComponentDefinitionParameter: {
1466
- id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1455
+ id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1467
1456
  /** @description Friendly name of the parameter */
1468
1457
  name: string;
1469
1458
  /** @description Appears next to the parameter in the Composition editor */
@@ -1475,7 +1464,7 @@ interface external$4 {
1475
1464
  };
1476
1465
  /** @description The definition of a named component slot that can contain other components */
1477
1466
  ComponentDefinitionSlot: {
1478
- id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1467
+ id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1479
1468
  /** @description Friendly name of the slot */
1480
1469
  name: string;
1481
1470
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -1533,13 +1522,13 @@ interface external$4 {
1533
1522
  };
1534
1523
  /** @description The definition of a component variant */
1535
1524
  ComponentDefinitionVariant: {
1536
- id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1525
+ id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1537
1526
  /** @description Friendly name of the variant */
1538
1527
  name: string;
1539
1528
  };
1540
1529
  /** @description Permission set for a component defintion */
1541
1530
  ComponentDefinitionPermission: {
1542
- roleId: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1531
+ roleId: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1543
1532
  /**
1544
1533
  * @description Permission type for this permission ComponentDefinition:
1545
1534
  * read | write | create | delete
@@ -1552,7 +1541,7 @@ interface external$4 {
1552
1541
  };
1553
1542
  /** @description Defines a component type that can live on a Composition */
1554
1543
  ComponentDefinition: {
1555
- id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1544
+ id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1556
1545
  /** @description Friendly name of the component definition */
1557
1546
  name: string;
1558
1547
  /**
@@ -1571,21 +1560,21 @@ interface external$4 {
1571
1560
  */
1572
1561
  canBeComposition?: boolean;
1573
1562
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
1574
- parameters?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1563
+ parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1575
1564
  /**
1576
1565
  * @description if this component uses team permissions or custom permissions
1577
1566
  * @default true
1578
1567
  */
1579
1568
  useTeamPermissions?: boolean;
1580
1569
  /** @description Custom role permissions for this component definition */
1581
- permissions?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1570
+ permissions?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1582
1571
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
1583
- slots?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1584
- slugSettings?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1572
+ slots?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1573
+ slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1585
1574
  /** @description Default component instance value */
1586
- defaults?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1575
+ defaults?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1587
1576
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
1588
- variants?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1577
+ variants?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1589
1578
  /** @description Created date string for this definition (ignored for writes) */
1590
1579
  created?: string;
1591
1580
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -1597,11 +1586,13 @@ interface external$4 {
1597
1586
  value: unknown;
1598
1587
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1599
1588
  type: string;
1600
- connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1589
+ connectedData?: external$6["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. */
@@ -1618,13 +1609,13 @@ interface external$4 {
1618
1609
  type: string;
1619
1610
  /** @description Component parameter values for the component instance */
1620
1611
  parameters?: {
1621
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1612
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1622
1613
  };
1623
1614
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1624
1615
  variant?: string;
1625
1616
  /** @description Slots containing any child components */
1626
1617
  slots?: {
1627
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1618
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1628
1619
  };
1629
1620
  /**
1630
1621
  * @description Unique identifier of the component within the composition.
@@ -1634,14 +1625,13 @@ interface external$4 {
1634
1625
  _id?: string;
1635
1626
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1636
1627
  _pattern?: string;
1637
- _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1628
+ _dataResources?: external$6["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
  */
1643
1633
  _patternDataResources?: {
1644
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1634
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1645
1635
  };
1646
1636
  /**
1647
1637
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -1653,22 +1643,28 @@ 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
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1658
+ [key: string]: external$6["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
- _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1667
+ _overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1672
1668
  };
1673
1669
  /** @description Defines the shape of the root component in a composition */
1674
1670
  RootComponentInstance: {
@@ -1676,15 +1672,15 @@ interface external$4 {
1676
1672
  type: string;
1677
1673
  /** @description Component parameter values for the component instance */
1678
1674
  parameters?: {
1679
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1675
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1680
1676
  };
1681
1677
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1682
1678
  variant?: string;
1683
1679
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
1684
- projectMapNodes?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
1680
+ projectMapNodes?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
1685
1681
  /** @description Slots containing any child components */
1686
1682
  slots?: {
1687
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1683
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1688
1684
  };
1689
1685
  /** @description The public UUID of the composition. */
1690
1686
  _id: string;
@@ -1692,62 +1688,68 @@ interface external$4 {
1692
1688
  _slug?: string | null;
1693
1689
  /** @description Friendly name of this component. */
1694
1690
  _name: string;
1695
- _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1691
+ _dataResources?: external$6["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
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1705
+ [key: string]: external$6["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
- _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1714
+ _overridability?: external$6["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?: {
1725
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1724
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1726
1725
  };
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. */
1737
1737
  parameters?: {
1738
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1738
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1739
1739
  };
1740
1740
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
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"
@@ -1774,17 +1776,14 @@ interface external$4 {
1774
1776
  }[];
1775
1777
  /** @description Variables needed to make calls to the data source */
1776
1778
  variables?: {
1777
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1779
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1778
1780
  };
1779
1781
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
1780
1782
  custom?: {
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;
@@ -1834,17 +1833,14 @@ interface external$4 {
1834
1833
  method: "GET" | "POST" | "HEAD";
1835
1834
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
1836
1835
  variables?: {
1837
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1836
+ [key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1838
1837
  };
1839
1838
  /** @description Custom configuration specific to the data source being defined */
1840
1839
  custom?: {
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
- [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1864
+ [key: string]: external$6["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;
@@ -1883,12 +1875,9 @@ interface external$4 {
1883
1875
  * If isPatternParameter is false or undefined, this has no meaning.
1884
1876
  */
1885
1877
  ignorePatternParameterDefault?: boolean;
1886
- variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1878
+ variables?: external$6["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
  };
@@ -1920,7 +1909,7 @@ interface components {
1920
1909
  status: number;
1921
1910
  statusText: string;
1922
1911
  };
1923
- UniformError: components["schemas"]["EdgehancersError"] | external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
1912
+ UniformError: components["schemas"]["EdgehancersError"] | external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
1924
1913
  InvalidationPayload: {
1925
1914
  /** @description List of variables with values to invalidate */
1926
1915
  variables?: {
@@ -2038,7 +2027,7 @@ interface components {
2038
2027
  diagnostics?: components["schemas"]["CompositionDiagnostics"];
2039
2028
  errors?: components["schemas"]["CompositionIssue"][];
2040
2029
  warnings?: components["schemas"]["CompositionIssue"][];
2041
- } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
2030
+ } & external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
2042
2031
  };
2043
2032
  };
2044
2033
  /** Invalidation request was processed; ok indicates if it succeeded */
@@ -2055,7 +2044,7 @@ interface components {
2055
2044
  };
2056
2045
  };
2057
2046
  }
2058
- interface external$3 {
2047
+ interface external$5 {
2059
2048
  "../../../lambda/functions/swagger.yml": {
2060
2049
  paths: {};
2061
2050
  components: {
@@ -2069,25 +2058,25 @@ interface external$3 {
2069
2058
  /** Request input validation failed */
2070
2059
  BadRequestError: {
2071
2060
  content: {
2072
- "application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2061
+ "application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2073
2062
  };
2074
2063
  };
2075
2064
  /** API key or token was not valid */
2076
2065
  UnauthorizedError: {
2077
2066
  content: {
2078
- "application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2067
+ "application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2079
2068
  };
2080
2069
  };
2081
2070
  /** Permission was denied */
2082
2071
  ForbiddenError: {
2083
2072
  content: {
2084
- "application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2073
+ "application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2085
2074
  };
2086
2075
  };
2087
2076
  /** Resource not found */
2088
2077
  NotFoundError: {
2089
2078
  content: {
2090
- "application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2079
+ "application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
2091
2080
  };
2092
2081
  };
2093
2082
  /** Too many requests in allowed time period */
@@ -2106,7 +2095,7 @@ interface external$3 {
2106
2095
  PublicIdProperty: string;
2107
2096
  /** @description The definition of a component parameter */
2108
2097
  ComponentDefinitionParameter: {
2109
- id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2098
+ id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2110
2099
  /** @description Friendly name of the parameter */
2111
2100
  name: string;
2112
2101
  /** @description Appears next to the parameter in the Composition editor */
@@ -2118,7 +2107,7 @@ interface external$3 {
2118
2107
  };
2119
2108
  /** @description The definition of a named component slot that can contain other components */
2120
2109
  ComponentDefinitionSlot: {
2121
- id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2110
+ id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2122
2111
  /** @description Friendly name of the slot */
2123
2112
  name: string;
2124
2113
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -2176,13 +2165,13 @@ interface external$3 {
2176
2165
  };
2177
2166
  /** @description The definition of a component variant */
2178
2167
  ComponentDefinitionVariant: {
2179
- id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2168
+ id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2180
2169
  /** @description Friendly name of the variant */
2181
2170
  name: string;
2182
2171
  };
2183
2172
  /** @description Permission set for a component defintion */
2184
2173
  ComponentDefinitionPermission: {
2185
- roleId: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2174
+ roleId: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2186
2175
  /**
2187
2176
  * @description Permission type for this permission ComponentDefinition:
2188
2177
  * read | write | create | delete
@@ -2195,7 +2184,7 @@ interface external$3 {
2195
2184
  };
2196
2185
  /** @description Defines a component type that can live on a Composition */
2197
2186
  ComponentDefinition: {
2198
- id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2187
+ id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2199
2188
  /** @description Friendly name of the component definition */
2200
2189
  name: string;
2201
2190
  /**
@@ -2214,21 +2203,21 @@ interface external$3 {
2214
2203
  */
2215
2204
  canBeComposition?: boolean;
2216
2205
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
2217
- parameters?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2206
+ parameters?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2218
2207
  /**
2219
2208
  * @description if this component uses team permissions or custom permissions
2220
2209
  * @default true
2221
2210
  */
2222
2211
  useTeamPermissions?: boolean;
2223
2212
  /** @description Custom role permissions for this component definition */
2224
- permissions?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2213
+ permissions?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2225
2214
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
2226
- slots?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2227
- slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2215
+ slots?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2216
+ slugSettings?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2228
2217
  /** @description Default component instance value */
2229
- defaults?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2218
+ defaults?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2230
2219
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
2231
- variants?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2220
+ variants?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2232
2221
  /** @description Created date string for this definition (ignored for writes) */
2233
2222
  created?: string;
2234
2223
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -2240,11 +2229,13 @@ interface external$3 {
2240
2229
  value: unknown;
2241
2230
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2242
2231
  type: string;
2243
- connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
2232
+ connectedData?: external$5["../../../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. */
@@ -2261,13 +2252,13 @@ interface external$3 {
2261
2252
  type: string;
2262
2253
  /** @description Component parameter values for the component instance */
2263
2254
  parameters?: {
2264
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2255
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2265
2256
  };
2266
2257
  /** @description Public ID of alternate visual appearance for this component, if any selected */
2267
2258
  variant?: string;
2268
2259
  /** @description Slots containing any child components */
2269
2260
  slots?: {
2270
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2261
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2271
2262
  };
2272
2263
  /**
2273
2264
  * @description Unique identifier of the component within the composition.
@@ -2277,14 +2268,13 @@ interface external$3 {
2277
2268
  _id?: string;
2278
2269
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
2279
2270
  _pattern?: string;
2280
- _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2271
+ _dataResources?: external$5["../../../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
  */
2286
2276
  _patternDataResources?: {
2287
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2277
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2288
2278
  };
2289
2279
  /**
2290
2280
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -2296,22 +2286,28 @@ 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
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2301
+ [key: string]: external$5["../../../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
- _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2310
+ _overridability?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2315
2311
  };
2316
2312
  /** @description Defines the shape of the root component in a composition */
2317
2313
  RootComponentInstance: {
@@ -2319,15 +2315,15 @@ interface external$3 {
2319
2315
  type: string;
2320
2316
  /** @description Component parameter values for the component instance */
2321
2317
  parameters?: {
2322
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2318
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2323
2319
  };
2324
2320
  /** @description Public ID of alternate visual appearance for this component, if any selected */
2325
2321
  variant?: string;
2326
2322
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
2327
- projectMapNodes?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
2323
+ projectMapNodes?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
2328
2324
  /** @description Slots containing any child components */
2329
2325
  slots?: {
2330
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2326
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2331
2327
  };
2332
2328
  /** @description The public UUID of the composition. */
2333
2329
  _id: string;
@@ -2335,62 +2331,68 @@ interface external$3 {
2335
2331
  _slug?: string | null;
2336
2332
  /** @description Friendly name of this component. */
2337
2333
  _name: string;
2338
- _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2334
+ _dataResources?: external$5["../../../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
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2348
+ [key: string]: external$5["../../../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
- _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2357
+ _overridability?: external$5["../../../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?: {
2368
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2367
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2369
2368
  };
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. */
2380
2380
  parameters?: {
2381
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2381
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2382
2382
  };
2383
2383
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
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"
@@ -2417,17 +2419,14 @@ interface external$3 {
2417
2419
  }[];
2418
2420
  /** @description Variables needed to make calls to the data source */
2419
2421
  variables?: {
2420
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2422
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2421
2423
  };
2422
2424
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
2423
2425
  custom?: {
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;
@@ -2477,17 +2476,14 @@ interface external$3 {
2477
2476
  method: "GET" | "POST" | "HEAD";
2478
2477
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
2479
2478
  variables?: {
2480
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2479
+ [key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2481
2480
  };
2482
2481
  /** @description Custom configuration specific to the data source being defined */
2483
2482
  custom?: {
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
- [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2507
+ [key: string]: external$5["../../../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;
@@ -2526,12 +2518,9 @@ interface external$3 {
2526
2518
  * If isPatternParameter is false or undefined, this has no meaning.
2527
2519
  */
2528
2520
  ignorePatternParameterDefault?: boolean;
2529
- variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2521
+ variables?: external$5["../../../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
  };
@@ -2561,112 +2550,112 @@ interface external$3 {
2561
2550
  parameters: {
2562
2551
  query: {
2563
2552
  /** Specify a single composition ID to fetch. Changes response from list to single. */
2564
- compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
2553
+ compositionId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
2565
2554
  /** Specify multiple composition IDs to fetch. Response type will be a list. */
2566
- compositionIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
2555
+ compositionIDs?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
2567
2556
  /** Filters composition lists by the user who created them. The user is specified by their identity subject. */
2568
- createdBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
2557
+ createdBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
2569
2558
  /**
2570
2559
  * Matches compositions where their name, slug, or definition name contains the specified keyword.
2571
2560
  * NOT a full text search; does not match composition contents.
2572
2561
  */
2573
- keyword?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
2562
+ keyword?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
2574
2563
  /** Max number of records to return */
2575
- limit?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
2564
+ limit?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
2576
2565
  /** Number of records to skip */
2577
- offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
2566
+ offset?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
2578
2567
  /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
2579
- orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
2568
+ orderBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
2580
2569
  /**
2581
2570
  * Matches compositions based on whether they are a pattern composition or a regular composition.
2582
2571
  * If true, only pattern compositions will be returned.
2583
2572
  * If false, only regular compositions will be returned.
2584
2573
  * If omitted, both pattern and regular compositions will be returned.
2585
2574
  */
2586
- pattern?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
2575
+ pattern?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
2587
2576
  /** The project the composition(s) are on. */
2588
- projectId: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
2577
+ projectId: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
2589
2578
  /** Required when using project map node id or path for fetch. */
2590
- projectMapId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
2579
+ projectMapId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
2591
2580
  /** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
2592
- projectMapNodeId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
2581
+ projectMapNodeId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
2593
2582
  /** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
2594
- projectMapNodePath?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
2583
+ projectMapNodePath?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
2595
2584
  /**
2596
2585
  * @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
2597
2586
  * This improves performance if you do not require enhanced component data.
2598
2587
  * If calling the Canvas API directly with no enhancer proxy, this has no effect.
2599
2588
  */
2600
- skipEnhance?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
2589
+ skipEnhance?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
2601
2590
  /**
2602
2591
  * If true, any pattern references in the composition will be left unresolved.
2603
2592
  * This is appropriate if you intend to serialize the composition without patterns
2604
2593
  * embedded into it, and serialize the pattern data separately.
2605
2594
  */
2606
- skipPatternResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
2595
+ skipPatternResolution?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
2607
2596
  /** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
2608
- skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
2597
+ skipParameterResolution?: external$5["../../../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
  */
2614
- skipOverridesResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
2603
+ skipOverridesResolution?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
2615
2604
  /** Specify a single composition to fetch by slug. Changes response from list to single. */
2616
- slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
2605
+ slug?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
2617
2606
  /** State of compositions to fetch. 0 = draft, 64 = published. */
2618
- state?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
2607
+ state?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
2619
2608
  /** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
2620
- type?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
2609
+ type?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
2621
2610
  /**
2622
2611
  * @deprecated Filters composition lists by the UI status of the composition.
2623
2612
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2624
2613
  */
2625
- uiStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
2614
+ uiStatus?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
2626
2615
  /**
2627
2616
  * Filters out compositions without attached node or filters out compositions with attached nodes
2628
2617
  * in case of FALSE. If not specified - no filtration applied.
2629
2618
  */
2630
- attachedToProjectMap?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
2619
+ attachedToProjectMap?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
2631
2620
  /** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
2632
- updatedBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
2621
+ updatedBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
2633
2622
  /**
2634
2623
  * If true the `_id` unique identifier of each non-root component will be part of the response data.
2635
2624
  * If false, the `_id` will not be present in the API response.
2636
2625
  */
2637
- withComponentIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
2626
+ withComponentIDs?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
2638
2627
  /**
2639
2628
  * Controls whether the total count of results will be returned along with the current results page in a list.
2640
2629
  * Has no effect when not fetching a list. This does impact performance when enabled.
2641
2630
  */
2642
- withTotalCount?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
2631
+ withTotalCount?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
2643
2632
  /**
2644
2633
  * @deprecated Returns the UI status string of the composition.
2645
2634
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2646
2635
  */
2647
- withUIStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
2636
+ withUIStatus?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
2648
2637
  /** Includes project map node information in the composition results */
2649
- withProjectMapNodes?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
2638
+ withProjectMapNodes?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
2650
2639
  };
2651
2640
  };
2652
2641
  responses: {
2653
2642
  /** OK */
2654
2643
  200: {
2655
2644
  content: {
2656
- "application/json": external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
2645
+ "application/json": external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
2657
2646
  };
2658
2647
  };
2659
- 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2660
- 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2661
- 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2648
+ 400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2649
+ 401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2650
+ 403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2662
2651
  /** Composition not found */
2663
2652
  404: {
2664
2653
  content: {
2665
2654
  "text/plain": string;
2666
2655
  };
2667
2656
  };
2668
- 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2669
- 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2657
+ 429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2658
+ 500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2670
2659
  };
2671
2660
  };
2672
2661
  /** Upserts a composition */
@@ -2674,11 +2663,11 @@ interface external$3 {
2674
2663
  responses: {
2675
2664
  /** OK */
2676
2665
  204: never;
2677
- 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2678
- 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2679
- 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2680
- 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2681
- 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2666
+ 400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2667
+ 401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2668
+ 403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2669
+ 429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2670
+ 500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2682
2671
  };
2683
2672
  requestBody: {
2684
2673
  content: {
@@ -2690,7 +2679,7 @@ interface external$3 {
2690
2679
  projectId: string;
2691
2680
  /** @description The state of the composition to upsert into. 0 = draft, 64 = published */
2692
2681
  state: number;
2693
- composition: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
2682
+ composition: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
2694
2683
  /**
2695
2684
  * @description True if the composition is a pattern (which can be referenced on other compositions)
2696
2685
  * @default false
@@ -2709,11 +2698,11 @@ interface external$3 {
2709
2698
  responses: {
2710
2699
  /** OK */
2711
2700
  204: never;
2712
- 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2713
- 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2714
- 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2715
- 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2716
- 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2701
+ 400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
2702
+ 401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2703
+ 403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
2704
+ 429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
2705
+ 500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
2717
2706
  };
2718
2707
  requestBody: {
2719
2708
  content: {
@@ -2771,10 +2760,10 @@ interface external$3 {
2771
2760
  modified: string;
2772
2761
  /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
2773
2762
  pattern: boolean;
2774
- composition: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
2763
+ composition: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
2775
2764
  };
2776
2765
  CompositionListResponse: {
2777
- compositions: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
2766
+ compositions: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
2778
2767
  /** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
2779
2768
  totalCount?: number;
2780
2769
  };
@@ -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.
@@ -2879,7 +2867,7 @@ interface external$3 {
2879
2867
 
2880
2868
  type Components = components$1['schemas'];
2881
2869
  type SharedComponents = components$2['schemas'];
2882
- type Api = paths$3['/api/v1/canvas'];
2870
+ type Api = paths$5['/api/v1/canvas'];
2883
2871
  /** Query parameter options for GET /api/v1/canvas */
2884
2872
  type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
2885
2873
  type?: string | string[];
@@ -2895,14 +2883,6 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
2895
2883
  type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
2896
2884
  /** Shape of the DELETE request body for /api/v1/canvas */
2897
2885
  type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
2898
- /** @deprecated use CompositionGetResponse */
2899
- type CompositionAPIResponse = CompositionGetResponse;
2900
- /** @deprecated use CompositionDeleteParameters */
2901
- type CompositionAPIDeleteRequest = CompositionDeleteParameters;
2902
- /** @deprecated use CompositionGetParameters */
2903
- type CompositionListAPIResponse = CompositionGetListResponse;
2904
- /** @deprecated use CompositionGetParameters */
2905
- type CompositionAPIOptions = CompositionGetParameters;
2906
2886
  /** Defines an editable parameter on a component. */
2907
2887
  type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
2908
2888
  /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
@@ -2928,22 +2908,18 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
2928
2908
  type RootComponentInstance = SharedComponents['RootComponentInstance'];
2929
2909
  /**
2930
2910
  * Defines the shape of a component override
2931
- * @deprecated
2932
2911
  */
2933
2912
  type OverrideOptions = SharedComponents['OverrideOptions'];
2934
2913
  /**
2935
2914
  * Defines the shape of a component override
2936
- * @deprecated
2937
2915
  */
2938
2916
  type ComponentOverride = SharedComponents['ComponentOverride'];
2939
2917
  /**
2940
2918
  * Defines a set of component overrides by component ID
2941
- * @deprecated
2942
2919
  */
2943
2920
  type ComponentOverrides = Record<string, ComponentOverride>;
2944
2921
  /**
2945
2922
  * Defines how a component on a pattern may have its values overridden
2946
- * @deprecated
2947
2923
  */
2948
2924
  type ComponentOverridability = SharedComponents['ComponentOverridability'];
2949
2925
  /** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
@@ -2965,20 +2941,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
2965
2941
  type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
2966
2942
  /** Switches for data resolution */
2967
2943
  type DataResolutionOption = {
2968
- unstable_resolveData?: boolean;
2944
+ skipDataResolution?: boolean;
2969
2945
  };
2970
2946
  type DataResolutionOptionNegative = {
2971
- unstable_resolveData?: false;
2947
+ skipDataResolution: true;
2972
2948
  };
2973
2949
  type DataResolutionOptionPositive = {
2974
- unstable_resolveData: true;
2950
+ skipDataResolution?: false;
2975
2951
  };
2976
2952
  type DataResolutionParameters = {
2977
2953
  /**
2978
2954
  * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
2979
2955
  * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
2980
2956
  */
2981
- unstable_diagnostics?: boolean;
2957
+ diagnostics?: boolean;
2982
2958
  /**
2983
2959
  * Pass dynamic variables to the composition that are required for resolving bindings and datas,
2984
2960
  * such as language, detail page ID, etc.
@@ -3184,14 +3160,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
3184
3160
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3185
3161
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
3186
3162
  getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
3187
- /** @deprecated use getCompositionByNodePath instead */
3188
- unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
3189
3163
  /** Fetches one composition by its project map node ID */
3190
3164
  getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3191
3165
  getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
3192
3166
  getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
3193
- /** @deprecated Use getCompositionByNodeId instead */
3194
- unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
3195
3167
  /** Fetches one composition by its slug */
3196
3168
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
3197
3169
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
@@ -3320,6 +3292,258 @@ declare class UncachedCanvasClient extends CanvasClient {
3320
3292
  constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
3321
3293
  }
3322
3294
 
3295
+ /**
3296
+ * This file was auto-generated by openapi-typescript.
3297
+ * Do not make direct changes to the file.
3298
+ */
3299
+ interface paths$4 {
3300
+ "/api/v1/composition-relationships": {
3301
+ /** Gets the relationships for a composition */
3302
+ get: {
3303
+ parameters: {
3304
+ query: {
3305
+ projectId: string;
3306
+ type: "definition";
3307
+ definitionIds?: string;
3308
+ withCompositions?: boolean | null;
3309
+ };
3310
+ };
3311
+ responses: {
3312
+ /** 200 response */
3313
+ 200: {
3314
+ content: {
3315
+ "application/json": {
3316
+ id: string;
3317
+ compositions?: {
3318
+ /** @enum {string} */
3319
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
3320
+ composition: {
3321
+ _id: string;
3322
+ _name: string;
3323
+ };
3324
+ pattern: boolean;
3325
+ }[];
3326
+ totalCount: number;
3327
+ }[];
3328
+ };
3329
+ };
3330
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
3331
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3332
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3333
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
3334
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
3335
+ };
3336
+ };
3337
+ /** Reindexes the composition relationships for a project */
3338
+ post: {
3339
+ responses: {
3340
+ /** 200 response */
3341
+ 200: {
3342
+ content: {
3343
+ "application/json": {
3344
+ success: boolean;
3345
+ };
3346
+ };
3347
+ };
3348
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
3349
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3350
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3351
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
3352
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
3353
+ };
3354
+ requestBody: {
3355
+ content: {
3356
+ "application/json": {
3357
+ /** Format: uuid */
3358
+ projectId: string;
3359
+ /** @enum {string} */
3360
+ type: "clear" | "index";
3361
+ definitionId?: string;
3362
+ compositionId?: string;
3363
+ state?: number;
3364
+ };
3365
+ };
3366
+ };
3367
+ };
3368
+ };
3369
+ }
3370
+ interface external$4 {
3371
+ "swagger.yml": {
3372
+ paths: {};
3373
+ components: {
3374
+ schemas: {
3375
+ Error: {
3376
+ /** @description Error message(s) that occurred while processing the request */
3377
+ errorMessage?: string[] | string;
3378
+ };
3379
+ };
3380
+ responses: {
3381
+ /** Request input validation failed */
3382
+ BadRequestError: {
3383
+ content: {
3384
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
3385
+ };
3386
+ };
3387
+ /** API key or token was not valid */
3388
+ UnauthorizedError: {
3389
+ content: {
3390
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
3391
+ };
3392
+ };
3393
+ /** Permission was denied */
3394
+ ForbiddenError: {
3395
+ content: {
3396
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
3397
+ };
3398
+ };
3399
+ /** Resource not found */
3400
+ NotFoundError: {
3401
+ content: {
3402
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
3403
+ };
3404
+ };
3405
+ /** Too many requests in allowed time period */
3406
+ RateLimitError: unknown;
3407
+ /** Execution error occurred */
3408
+ InternalServerError: unknown;
3409
+ };
3410
+ };
3411
+ operations: {};
3412
+ };
3413
+ }
3414
+
3415
+ /**
3416
+ * This file was auto-generated by openapi-typescript.
3417
+ * Do not make direct changes to the file.
3418
+ */
3419
+ interface paths$3 {
3420
+ "/api/v1/usage-tracking": {
3421
+ /** Gets current version of the usage tracking for a project */
3422
+ get: {
3423
+ parameters: {
3424
+ query: {
3425
+ projectId: string;
3426
+ };
3427
+ };
3428
+ responses: {
3429
+ /** 200 response */
3430
+ 200: {
3431
+ content: {
3432
+ "application/json": {
3433
+ version: number;
3434
+ };
3435
+ };
3436
+ };
3437
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
3438
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3439
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3440
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
3441
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
3442
+ };
3443
+ };
3444
+ /** Sets version of the usage tracking for a project */
3445
+ post: {
3446
+ responses: {
3447
+ /** 200 response */
3448
+ 200: {
3449
+ content: {
3450
+ "application/json": {
3451
+ version: number;
3452
+ };
3453
+ };
3454
+ };
3455
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
3456
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3457
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3458
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
3459
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
3460
+ };
3461
+ requestBody: {
3462
+ content: {
3463
+ "application/json": {
3464
+ /** Format: uuid */
3465
+ projectId: string;
3466
+ version: number;
3467
+ };
3468
+ };
3469
+ };
3470
+ };
3471
+ };
3472
+ }
3473
+ interface external$3 {
3474
+ "swagger.yml": {
3475
+ paths: {};
3476
+ components: {
3477
+ schemas: {
3478
+ Error: {
3479
+ /** @description Error message(s) that occurred while processing the request */
3480
+ errorMessage?: string[] | string;
3481
+ };
3482
+ };
3483
+ responses: {
3484
+ /** Request input validation failed */
3485
+ BadRequestError: {
3486
+ content: {
3487
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
3488
+ };
3489
+ };
3490
+ /** API key or token was not valid */
3491
+ UnauthorizedError: {
3492
+ content: {
3493
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
3494
+ };
3495
+ };
3496
+ /** Permission was denied */
3497
+ ForbiddenError: {
3498
+ content: {
3499
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
3500
+ };
3501
+ };
3502
+ /** Resource not found */
3503
+ NotFoundError: {
3504
+ content: {
3505
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
3506
+ };
3507
+ };
3508
+ /** Too many requests in allowed time period */
3509
+ RateLimitError: unknown;
3510
+ /** Execution error occurred */
3511
+ InternalServerError: unknown;
3512
+ };
3513
+ };
3514
+ operations: {};
3515
+ };
3516
+ }
3517
+
3518
+ type CompositionRelationshipsDefinitionApi = paths$4['/api/v1/composition-relationships'];
3519
+ type CompositionRelationshipsDefinitionGetParameters = CompositionRelationshipsDefinitionApi['get']['parameters']['query'];
3520
+ type CompositionRelationshipsDDefinitionGetResponse = CompositionRelationshipsDefinitionApi['get']['responses']['200']['content']['application/json'];
3521
+ type UsageTrackingApi = paths$3['/api/v1/usage-tracking'];
3522
+ type UsageTrackingGetParameters = UsageTrackingApi['get']['parameters']['query'];
3523
+ type UsageTrackingGetResponse = UsageTrackingApi['get']['responses']['200']['content']['application/json'];
3524
+ type UsageTrackingPostParameters = UsageTrackingApi['post']['requestBody']['content']['application/json'];
3525
+ type UsageTrackingPostResponse = UsageTrackingApi['post']['responses']['200']['content']['application/json'];
3526
+ type CompositionRelationshipsClientOptions = ClientOptions;
3527
+ declare class unstable_CompositionRelationshipClient extends ApiClient<CompositionRelationshipsClientOptions> {
3528
+ private readonly _options;
3529
+ constructor(options: CompositionRelationshipsClientOptions);
3530
+ getDefinitionsRelationships: ({ definitionIds, withCompositions, }: {
3531
+ definitionIds: string[];
3532
+ withCompositions?: boolean | undefined;
3533
+ }) => Promise<CompositionRelationshipsDDefinitionGetResponse>;
3534
+ clearAllRelationships: () => Promise<{
3535
+ success: boolean;
3536
+ }>;
3537
+ indexCompositionRelationships: ({ state, compositionId, }: {
3538
+ state: number;
3539
+ compositionId: string;
3540
+ }) => Promise<{
3541
+ success: boolean;
3542
+ }>;
3543
+ getVersion: () => Promise<UsageTrackingGetResponse['version']>;
3544
+ setVersion: (version: UsageTrackingPostParameters['version']) => Promise<UsageTrackingPostResponse>;
3545
+ }
3546
+
3323
3547
  type PreviewPanelSettings = {
3324
3548
  isInteractive: boolean;
3325
3549
  };
@@ -3372,7 +3596,7 @@ interface paths$2 {
3372
3596
  /**
3373
3597
  * Format: uuid
3374
3598
  * @deprecated
3375
- * @description Do not use. Will be removed in future.
3599
+ * @description Do not use. May be removed in future.
3376
3600
  */
3377
3601
  integrationId?: string;
3378
3602
  /** @description The integration type that the data source is attached to. Must be installed in the project. */
@@ -3591,8 +3815,10 @@ interface external$2 {
3591
3815
  connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
3592
3816
  };
3593
3817
  /**
3594
- * @deprecated
3595
- * @description Defines a connection to a data element on a data resource. Do not use.
3818
+ * @description Defines a connection to a data element on a data resource.
3819
+ *
3820
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3821
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
3596
3822
  */
3597
3823
  DataElementConnectionDefinition: {
3598
3824
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -3627,7 +3853,6 @@ interface external$2 {
3627
3853
  _pattern?: string;
3628
3854
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3629
3855
  /**
3630
- * @deprecated
3631
3856
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3632
3857
  * Means nothing for PUTs; it will be ignored.
3633
3858
  */
@@ -3644,20 +3869,26 @@ interface external$2 {
3644
3869
  */
3645
3870
  _patternError?: "NOTFOUND" | "CYCLIC";
3646
3871
  /**
3647
- * @deprecated
3648
- * @description Experimental functionality subject to change without notice.
3649
- * Contains overrides that are defined on a pattern instance reference nested in a composition.
3650
- * This is always undefined unless `skipOverridesResolution` is true.
3651
- * See `_overrides` on `RootComponentInstance`.
3872
+ * @description Defines patch overrides to component IDs that live in the composition.
3873
+ * This can be used to override parameters that are defined on patterns,
3874
+ * including nested patterns, with values that are specific to this composition.
3875
+ * The keys in this object are component IDs.
3876
+ * Overrides are applied from the top down, so for example if both the composition
3877
+ * and a pattern on the composition define an override on a nested pattern,
3878
+ * the composition's override replaces the pattern's.
3879
+ *
3880
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3881
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3652
3882
  */
3653
3883
  _overrides?: {
3654
3884
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3655
3885
  };
3656
3886
  /**
3657
- * @deprecated
3658
- * @description Experimental functionality subject to change without notice.
3659
- * When used on a pattern, defines how the pattern's parameters may be overridden
3887
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3660
3888
  * by consumers of the pattern.
3889
+ *
3890
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3891
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3661
3892
  */
3662
3893
  _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3663
3894
  };
@@ -3685,31 +3916,34 @@ interface external$2 {
3685
3916
  _name: string;
3686
3917
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3687
3918
  /**
3688
- * @deprecated
3689
- * @description Experimental functionality subject to change without notice.
3690
- * Defines patch overrides to component IDs that live in the composition.
3919
+ * @description Defines patch overrides to component IDs that live in the composition.
3691
3920
  * This can be used to override parameters that are defined on patterns,
3692
3921
  * including nested patterns, with values that are specific to this composition.
3693
3922
  * The keys in this object are component IDs.
3694
3923
  * Overrides are applied from the top down, so for example if both the composition
3695
3924
  * and a pattern on the composition define an override on a nested pattern,
3696
3925
  * the composition's override replaces the pattern's.
3926
+ *
3927
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3928
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3697
3929
  */
3698
3930
  _overrides?: {
3699
3931
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3700
3932
  };
3701
3933
  /**
3702
- * @deprecated
3703
- * @description Experimental functionality subject to change without notice.
3704
- * When used on a pattern, defines how the pattern's parameters may be overridden
3934
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3705
3935
  * by consumers of the pattern.
3936
+ *
3937
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3938
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3706
3939
  */
3707
3940
  _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3708
3941
  };
3709
3942
  /**
3710
- * @deprecated
3711
- * @description Experimental functionality subject to change without notice.
3712
- * Defines how to override a specific component.
3943
+ * @description Defines how to override a specific component.
3944
+ *
3945
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3946
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3713
3947
  */
3714
3948
  ComponentOverride: {
3715
3949
  parameters?: {
@@ -3718,10 +3952,11 @@ interface external$2 {
3718
3952
  variant?: string;
3719
3953
  };
3720
3954
  /**
3721
- * @deprecated
3722
- * @description Experimental functionality subject to change without notice.
3723
- * Defines how a component on a pattern may have its values overridden.
3724
- * NOTE: Data resources' overridability is defined in the data resource definition.
3955
+ * @description Defines how a component on a pattern may have its values overridden.
3956
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
3957
+ *
3958
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3959
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3725
3960
  */
3726
3961
  ComponentOverridability: {
3727
3962
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -3732,13 +3967,15 @@ interface external$2 {
3732
3967
  variants?: boolean;
3733
3968
  };
3734
3969
  /**
3735
- * @deprecated
3736
- * @description Experimental functionality subject to change without notice.
3970
+ * @description Whether a parameter is overridable
3971
+ *
3972
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3973
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3974
+ *
3737
3975
  * @enum {string}
3738
3976
  */
3739
3977
  OverrideOptions: "yes" | "no";
3740
3978
  /**
3741
- * @deprecated
3742
3979
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
3743
3980
  * These are created in the UI and shared across a whole project.
3744
3981
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -3772,10 +4009,7 @@ interface external$2 {
3772
4009
  [key: string]: unknown;
3773
4010
  };
3774
4011
  };
3775
- /**
3776
- * @deprecated
3777
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
3778
- */
4012
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
3779
4013
  DataType: {
3780
4014
  /** @description Public ID of the data type */
3781
4015
  id: string;
@@ -3832,10 +4066,7 @@ interface external$2 {
3832
4066
  [key: string]: unknown;
3833
4067
  };
3834
4068
  };
3835
- /**
3836
- * @deprecated
3837
- * @description Defines the shape of a data variable on a Data Source or Data Type
3838
- */
4069
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
3839
4070
  DataVariableDefinition: {
3840
4071
  /** @description Display name of the data variable */
3841
4072
  displayName?: string;
@@ -3852,17 +4083,13 @@ interface external$2 {
3852
4083
  order?: number;
3853
4084
  };
3854
4085
  /**
3855
- * @deprecated
3856
4086
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
3857
4087
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
3858
4088
  */
3859
4089
  DataResourceDefinitions: {
3860
4090
  [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
3861
4091
  };
3862
- /**
3863
- * @deprecated
3864
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
3865
- */
4092
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
3866
4093
  DataResourceDefinition: {
3867
4094
  /** @description Public ID of the data type that provides this data */
3868
4095
  type: string;
@@ -3876,10 +4103,7 @@ interface external$2 {
3876
4103
  ignorePatternParameterDefault?: boolean;
3877
4104
  variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3878
4105
  };
3879
- /**
3880
- * @deprecated
3881
- * @description Variable values for a data resource.
3882
- */
4106
+ /** @description Variable values for a data resource. */
3883
4107
  DataResourceVariables: {
3884
4108
  [key: string]: string;
3885
4109
  };
@@ -4127,8 +4351,10 @@ interface external$1 {
4127
4351
  connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4128
4352
  };
4129
4353
  /**
4130
- * @deprecated
4131
- * @description Defines a connection to a data element on a data resource. Do not use.
4354
+ * @description Defines a connection to a data element on a data resource.
4355
+ *
4356
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4357
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
4132
4358
  */
4133
4359
  DataElementConnectionDefinition: {
4134
4360
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4163,7 +4389,6 @@ interface external$1 {
4163
4389
  _pattern?: string;
4164
4390
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4165
4391
  /**
4166
- * @deprecated
4167
4392
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
4168
4393
  * Means nothing for PUTs; it will be ignored.
4169
4394
  */
@@ -4180,20 +4405,26 @@ interface external$1 {
4180
4405
  */
4181
4406
  _patternError?: "NOTFOUND" | "CYCLIC";
4182
4407
  /**
4183
- * @deprecated
4184
- * @description Experimental functionality subject to change without notice.
4185
- * Contains overrides that are defined on a pattern instance reference nested in a composition.
4186
- * This is always undefined unless `skipOverridesResolution` is true.
4187
- * See `_overrides` on `RootComponentInstance`.
4408
+ * @description Defines patch overrides to component IDs that live in the composition.
4409
+ * This can be used to override parameters that are defined on patterns,
4410
+ * including nested patterns, with values that are specific to this composition.
4411
+ * The keys in this object are component IDs.
4412
+ * Overrides are applied from the top down, so for example if both the composition
4413
+ * and a pattern on the composition define an override on a nested pattern,
4414
+ * the composition's override replaces the pattern's.
4415
+ *
4416
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4417
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4188
4418
  */
4189
4419
  _overrides?: {
4190
4420
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4191
4421
  };
4192
4422
  /**
4193
- * @deprecated
4194
- * @description Experimental functionality subject to change without notice.
4195
- * When used on a pattern, defines how the pattern's parameters may be overridden
4423
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4196
4424
  * by consumers of the pattern.
4425
+ *
4426
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4427
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4197
4428
  */
4198
4429
  _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4199
4430
  };
@@ -4221,31 +4452,34 @@ interface external$1 {
4221
4452
  _name: string;
4222
4453
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4223
4454
  /**
4224
- * @deprecated
4225
- * @description Experimental functionality subject to change without notice.
4226
- * Defines patch overrides to component IDs that live in the composition.
4455
+ * @description Defines patch overrides to component IDs that live in the composition.
4227
4456
  * This can be used to override parameters that are defined on patterns,
4228
4457
  * including nested patterns, with values that are specific to this composition.
4229
4458
  * The keys in this object are component IDs.
4230
4459
  * Overrides are applied from the top down, so for example if both the composition
4231
4460
  * and a pattern on the composition define an override on a nested pattern,
4232
4461
  * the composition's override replaces the pattern's.
4462
+ *
4463
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4464
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4233
4465
  */
4234
4466
  _overrides?: {
4235
4467
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4236
4468
  };
4237
4469
  /**
4238
- * @deprecated
4239
- * @description Experimental functionality subject to change without notice.
4240
- * When used on a pattern, defines how the pattern's parameters may be overridden
4470
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4241
4471
  * by consumers of the pattern.
4472
+ *
4473
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4474
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4242
4475
  */
4243
4476
  _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4244
4477
  };
4245
4478
  /**
4246
- * @deprecated
4247
- * @description Experimental functionality subject to change without notice.
4248
- * Defines how to override a specific component.
4479
+ * @description Defines how to override a specific component.
4480
+ *
4481
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4482
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4249
4483
  */
4250
4484
  ComponentOverride: {
4251
4485
  parameters?: {
@@ -4254,10 +4488,11 @@ interface external$1 {
4254
4488
  variant?: string;
4255
4489
  };
4256
4490
  /**
4257
- * @deprecated
4258
- * @description Experimental functionality subject to change without notice.
4259
- * Defines how a component on a pattern may have its values overridden.
4260
- * NOTE: Data resources' overridability is defined in the data resource definition.
4491
+ * @description Defines how a component on a pattern may have its values overridden.
4492
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
4493
+ *
4494
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4495
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4261
4496
  */
4262
4497
  ComponentOverridability: {
4263
4498
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4268,13 +4503,15 @@ interface external$1 {
4268
4503
  variants?: boolean;
4269
4504
  };
4270
4505
  /**
4271
- * @deprecated
4272
- * @description Experimental functionality subject to change without notice.
4506
+ * @description Whether a parameter is overridable
4507
+ *
4508
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4509
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4510
+ *
4273
4511
  * @enum {string}
4274
4512
  */
4275
4513
  OverrideOptions: "yes" | "no";
4276
4514
  /**
4277
- * @deprecated
4278
4515
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
4279
4516
  * These are created in the UI and shared across a whole project.
4280
4517
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4308,10 +4545,7 @@ interface external$1 {
4308
4545
  [key: string]: unknown;
4309
4546
  };
4310
4547
  };
4311
- /**
4312
- * @deprecated
4313
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
4314
- */
4548
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
4315
4549
  DataType: {
4316
4550
  /** @description Public ID of the data type */
4317
4551
  id: string;
@@ -4368,10 +4602,7 @@ interface external$1 {
4368
4602
  [key: string]: unknown;
4369
4603
  };
4370
4604
  };
4371
- /**
4372
- * @deprecated
4373
- * @description Defines the shape of a data variable on a Data Source or Data Type
4374
- */
4605
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
4375
4606
  DataVariableDefinition: {
4376
4607
  /** @description Display name of the data variable */
4377
4608
  displayName?: string;
@@ -4388,17 +4619,13 @@ interface external$1 {
4388
4619
  order?: number;
4389
4620
  };
4390
4621
  /**
4391
- * @deprecated
4392
4622
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
4393
4623
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
4394
4624
  */
4395
4625
  DataResourceDefinitions: {
4396
4626
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
4397
4627
  };
4398
- /**
4399
- * @deprecated
4400
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
4401
- */
4628
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
4402
4629
  DataResourceDefinition: {
4403
4630
  /** @description Public ID of the data type that provides this data */
4404
4631
  type: string;
@@ -4412,10 +4639,7 @@ interface external$1 {
4412
4639
  ignorePatternParameterDefault?: boolean;
4413
4640
  variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4414
4641
  };
4415
- /**
4416
- * @deprecated
4417
- * @description Variable values for a data resource.
4418
- */
4642
+ /** @description Variable values for a data resource. */
4419
4643
  DataResourceVariables: {
4420
4644
  [key: string]: string;
4421
4645
  };
@@ -4698,8 +4922,10 @@ interface external {
4698
4922
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
4699
4923
  };
4700
4924
  /**
4701
- * @deprecated
4702
- * @description Defines a connection to a data element on a data resource. Do not use.
4925
+ * @description Defines a connection to a data element on a data resource.
4926
+ *
4927
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4928
+ * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
4703
4929
  */
4704
4930
  DataElementConnectionDefinition: {
4705
4931
  /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4734,7 +4960,6 @@ interface external {
4734
4960
  _pattern?: string;
4735
4961
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4736
4962
  /**
4737
- * @deprecated
4738
4963
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
4739
4964
  * Means nothing for PUTs; it will be ignored.
4740
4965
  */
@@ -4751,20 +4976,26 @@ interface external {
4751
4976
  */
4752
4977
  _patternError?: "NOTFOUND" | "CYCLIC";
4753
4978
  /**
4754
- * @deprecated
4755
- * @description Experimental functionality subject to change without notice.
4756
- * Contains overrides that are defined on a pattern instance reference nested in a composition.
4757
- * This is always undefined unless `skipOverridesResolution` is true.
4758
- * See `_overrides` on `RootComponentInstance`.
4979
+ * @description Defines patch overrides to component IDs that live in the composition.
4980
+ * This can be used to override parameters that are defined on patterns,
4981
+ * including nested patterns, with values that are specific to this composition.
4982
+ * The keys in this object are component IDs.
4983
+ * Overrides are applied from the top down, so for example if both the composition
4984
+ * and a pattern on the composition define an override on a nested pattern,
4985
+ * the composition's override replaces the pattern's.
4986
+ *
4987
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4988
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4759
4989
  */
4760
4990
  _overrides?: {
4761
4991
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4762
4992
  };
4763
4993
  /**
4764
- * @deprecated
4765
- * @description Experimental functionality subject to change without notice.
4766
- * When used on a pattern, defines how the pattern's parameters may be overridden
4994
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4767
4995
  * by consumers of the pattern.
4996
+ *
4997
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4998
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4768
4999
  */
4769
5000
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4770
5001
  };
@@ -4792,31 +5023,34 @@ interface external {
4792
5023
  _name: string;
4793
5024
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
4794
5025
  /**
4795
- * @deprecated
4796
- * @description Experimental functionality subject to change without notice.
4797
- * Defines patch overrides to component IDs that live in the composition.
5026
+ * @description Defines patch overrides to component IDs that live in the composition.
4798
5027
  * This can be used to override parameters that are defined on patterns,
4799
5028
  * including nested patterns, with values that are specific to this composition.
4800
5029
  * The keys in this object are component IDs.
4801
5030
  * Overrides are applied from the top down, so for example if both the composition
4802
5031
  * and a pattern on the composition define an override on a nested pattern,
4803
5032
  * the composition's override replaces the pattern's.
5033
+ *
5034
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
5035
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4804
5036
  */
4805
5037
  _overrides?: {
4806
5038
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
4807
5039
  };
4808
5040
  /**
4809
- * @deprecated
4810
- * @description Experimental functionality subject to change without notice.
4811
- * When used on a pattern, defines how the pattern's parameters may be overridden
5041
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
4812
5042
  * by consumers of the pattern.
5043
+ *
5044
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
5045
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4813
5046
  */
4814
5047
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
4815
5048
  };
4816
5049
  /**
4817
- * @deprecated
4818
- * @description Experimental functionality subject to change without notice.
4819
- * Defines how to override a specific component.
5050
+ * @description Defines how to override a specific component.
5051
+ *
5052
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
5053
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4820
5054
  */
4821
5055
  ComponentOverride: {
4822
5056
  parameters?: {
@@ -4825,10 +5059,11 @@ interface external {
4825
5059
  variant?: string;
4826
5060
  };
4827
5061
  /**
4828
- * @deprecated
4829
- * @description Experimental functionality subject to change without notice.
4830
- * Defines how a component on a pattern may have its values overridden.
4831
- * NOTE: Data resources' overridability is defined in the data resource definition.
5062
+ * @description Defines how a component on a pattern may have its values overridden.
5063
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
5064
+ *
5065
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
5066
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4832
5067
  */
4833
5068
  ComponentOverridability: {
4834
5069
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4839,13 +5074,15 @@ interface external {
4839
5074
  variants?: boolean;
4840
5075
  };
4841
5076
  /**
4842
- * @deprecated
4843
- * @description Experimental functionality subject to change without notice.
5077
+ * @description Whether a parameter is overridable
5078
+ *
5079
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
5080
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
5081
+ *
4844
5082
  * @enum {string}
4845
5083
  */
4846
5084
  OverrideOptions: "yes" | "no";
4847
5085
  /**
4848
- * @deprecated
4849
5086
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
4850
5087
  * These are created in the UI and shared across a whole project.
4851
5088
  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4879,10 +5116,7 @@ interface external {
4879
5116
  [key: string]: unknown;
4880
5117
  };
4881
5118
  };
4882
- /**
4883
- * @deprecated
4884
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
4885
- */
5119
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
4886
5120
  DataType: {
4887
5121
  /** @description Public ID of the data type */
4888
5122
  id: string;
@@ -4939,10 +5173,7 @@ interface external {
4939
5173
  [key: string]: unknown;
4940
5174
  };
4941
5175
  };
4942
- /**
4943
- * @deprecated
4944
- * @description Defines the shape of a data variable on a Data Source or Data Type
4945
- */
5176
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
4946
5177
  DataVariableDefinition: {
4947
5178
  /** @description Display name of the data variable */
4948
5179
  displayName?: string;
@@ -4959,17 +5190,13 @@ interface external {
4959
5190
  order?: number;
4960
5191
  };
4961
5192
  /**
4962
- * @deprecated
4963
5193
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
4964
5194
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
4965
5195
  */
4966
5196
  DataResourceDefinitions: {
4967
5197
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
4968
5198
  };
4969
- /**
4970
- * @deprecated
4971
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
4972
- */
5199
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
4973
5200
  DataResourceDefinition: {
4974
5201
  /** @description Public ID of the data type that provides this data */
4975
5202
  type: string;
@@ -4983,10 +5210,7 @@ interface external {
4983
5210
  ignorePatternParameterDefault?: boolean;
4984
5211
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4985
5212
  };
4986
- /**
4987
- * @deprecated
4988
- * @description Variable values for a data resource.
4989
- */
5213
+ /** @description Variable values for a data resource. */
4990
5214
  DataResourceVariables: {
4991
5215
  [key: string]: string;
4992
5216
  };
@@ -5121,9 +5345,7 @@ type InvalidationPayload = schemas['InvalidationPayload'];
5121
5345
  type InvalidationResult = schemas['InvalidationResult'];
5122
5346
  type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
5123
5347
 
5124
- /**
5125
- * @deprecated
5126
- */
5348
+ /** API client to make comms with the Next Gen Mesh Data Source API simpler */
5127
5349
  declare class DataSourceClient extends ApiClient {
5128
5350
  constructor(options: ClientOptions);
5129
5351
  /** Fetches all DataSources for a project */
@@ -5190,9 +5412,7 @@ declare class DataSourceClient extends ApiClient {
5190
5412
  remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
5191
5413
  }
5192
5414
 
5193
- /**
5194
- * @deprecated
5195
- */
5415
+ /** API client to make comms with the Next Gen Mesh Data Type API simpler */
5196
5416
  declare class DataTypeClient extends ApiClient {
5197
5417
  #private;
5198
5418
  constructor(options: ClientOptions);
@@ -5724,4 +5944,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
5724
5944
 
5725
5945
  declare const CanvasClientError: typeof ApiClientError;
5726
5946
 
5727
- export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, 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, 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, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
5947
+ export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };