@uniformdev/canvas 18.33.1-alpha.7 → 18.34.0

package/dist/index.d.ts

@@ -148,10 +148,8 @@ interface components$2 {
             connectedData?: components$2["schemas"]["DataElementConnectionDefinition"];
         };
         /**
-         * @description Defines a connection to a data element on a data resource.
-         *
-         * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-         * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+         * @deprecated
+         * @description Defines a connection to a data element on a data resource. Do not use.
          */
         DataElementConnectionDefinition: {
             /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -161,14 +159,6 @@ interface components$2 {
              * @enum {string}
              */
             syntax: "jptr";
-            /**
-             * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-             * In all cases the binding process will remove the parameter data for the unresolvable data element.
-             * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-             *
-             * @default false
-             */
-            required?: boolean;
         };
         /** @description Defines the shape of a component instance served by the composition API. */
         ComponentInstance: {
@@ -194,6 +184,7 @@ interface components$2 {
             _pattern?: string;
             _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
             /**
+             * @deprecated
              * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
              * Means nothing for PUTs; it will be ignored.
              */
@@ -210,26 +201,20 @@ interface components$2 {
              */
             _patternError?: "NOTFOUND" | "CYCLIC";
             /**
-             * @description Defines patch overrides to component IDs that live in the composition.
-             * This can be used to override parameters that are defined on patterns,
-             * including nested patterns, with values that are specific to this composition.
-             * The keys in this object are component IDs.
-             * Overrides are applied from the top down, so for example if both the composition
-             * and a pattern on the composition define an override on a nested pattern,
-             * the composition's override replaces the pattern's.
-             *
-             * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-             * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+             * @deprecated
+             * @description Experimental functionality subject to change without notice.
+             * Contains overrides that are defined on a pattern instance reference nested in a composition.
+             * This is always undefined unless `skipOverridesResolution` is true.
+             * See `_overrides` on `RootComponentInstance`.
              */
             _overrides?: {
                 [key: string]: components$2["schemas"]["ComponentOverride"];
             };
             /**
-             * @description When used on a pattern, defines how the pattern's parameters may be overridden
+             * @deprecated
+             * @description Experimental functionality subject to change without notice.
+             * When used on a pattern, defines how the pattern's parameters may be overridden
              * by consumers of the pattern.
-             *
-             * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-             * Future updates that do not break the overrides-applied state of a composition may be made without notice.
              */
             _overridability?: components$2["schemas"]["ComponentOverridability"];
         };
@@ -257,34 +242,31 @@ interface components$2 {
             _name: string;
             _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
             /**
-             * @description Defines patch overrides to component IDs that live in the composition.
+             * @deprecated
+             * @description Experimental functionality subject to change without notice.
+             * Defines patch overrides to component IDs that live in the composition.
              * This can be used to override parameters that are defined on patterns,
              * including nested patterns, with values that are specific to this composition.
              * The keys in this object are component IDs.
              * Overrides are applied from the top down, so for example if both the composition
              * and a pattern on the composition define an override on a nested pattern,
              * the composition's override replaces the pattern's.
-             *
-             * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-             * Future updates that do not break the overrides-applied state of a composition may be made without notice.
              */
             _overrides?: {
                 [key: string]: components$2["schemas"]["ComponentOverride"];
             };
             /**
-             * @description When used on a pattern, defines how the pattern's parameters may be overridden
+             * @deprecated
+             * @description Experimental functionality subject to change without notice.
+             * When used on a pattern, defines how the pattern's parameters may be overridden
              * by consumers of the pattern.
-             *
-             * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-             * Future updates that do not break the overrides-applied state of a composition may be made without notice.
              */
             _overridability?: components$2["schemas"]["ComponentOverridability"];
         };
         /**
-         * @description Defines how to override a specific component.
-         *
-         * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-         * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+         * @deprecated
+         * @description Experimental functionality subject to change without notice.
+         * Defines how to override a specific component.
          */
         ComponentOverride: {
             parameters?: {
@@ -293,11 +275,10 @@ interface components$2 {
             variant?: string;
         };
         /**
-         * @description Defines how a component on a pattern may have its values overridden.
-         * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-         *
-         * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-         * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+         * @deprecated
+         * @description Experimental functionality subject to change without notice.
+         * Defines how a component on a pattern may have its values overridden.
+         * NOTE: Data resources' overridability is defined in the data resource definition.
          */
         ComponentOverridability: {
             /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -308,15 +289,13 @@ interface components$2 {
             variants?: boolean;
         };
         /**
-         * @description Whether a parameter is overridable
-         *
-         * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-         * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-         *
+         * @deprecated
+         * @description Experimental functionality subject to change without notice.
          * @enum {string}
          */
         OverrideOptions: "yes" | "no";
         /**
+         * @deprecated
          * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
          * These are created in the UI and shared across a whole project.
          * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -350,7 +329,10 @@ interface components$2 {
                 [key: string]: unknown;
             };
         };
-        /** @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. */
+        /**
+         * @deprecated
+         * @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.
+         */
         DataType: {
             /** @description Public ID of the data type */
             id: string;
@@ -407,7 +389,10 @@ interface components$2 {
                 [key: string]: unknown;
             };
         };
-        /** @description Defines the shape of a data variable on a Data Source or Data Type */
+        /**
+         * @deprecated
+         * @description Defines the shape of a data variable on a Data Source or Data Type
+         */
         DataVariableDefinition: {
             /** @description Display name of the data variable */
             displayName?: string;
@@ -424,13 +409,17 @@ interface components$2 {
             order?: number;
         };
         /**
+         * @deprecated
          * @description Data definitions attached to this component. The property name is the key of the data in the data document.
          * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
          */
         DataResourceDefinitions: {
             [key: string]: components$2["schemas"]["DataResourceDefinition"];
         };
-        /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+        /**
+         * @deprecated
+         * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+         */
         DataResourceDefinition: {
             /** @description Public ID of the data type that provides this data */
             type: string;
@@ -444,7 +433,10 @@ interface components$2 {
             ignorePatternParameterDefault?: boolean;
             variables?: components$2["schemas"]["DataResourceVariables"];
         };
-        /** @description Variable values for a data resource. */
+        /**
+         * @deprecated
+         * @description Variable values for a data resource.
+         */
         DataResourceVariables: {
             [key: string]: string;
         };
@@ -750,10 +742,8 @@ interface external$5 {
                     connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -763,14 +753,6 @@ interface external$5 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -796,6 +778,7 @@ interface external$5 {
                     _pattern?: string;
                     _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -812,26 +795,20 @@ interface external$5 {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -859,34 +836,31 @@ interface external$5 {
                     _name: string;
                     _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -895,11 +869,10 @@ interface external$5 {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -910,15 +883,13 @@ interface external$5 {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -952,7 +923,10 @@ interface external$5 {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -1009,7 +983,10 @@ interface external$5 {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -1026,13 +1003,17 @@ interface external$5 {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -1046,7 +1027,10 @@ interface external$5 {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -1081,6 +1065,14 @@ type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['
 type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
 /** Query parameter options for GET /api/v1/canvas-definitions */
 type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
+/** @deprecated use ComponentDefinitionGetResponse instead */
+type ComponentDefinitionAPIResponse = ComponentDefinitionGetResponse;
+/** @deprecated use ComponentDefinitionPutParameters */
+type ComponentDefinitionAPIPutRequest = ComponentDefinitionPutParameters;
+/** @deprecated use ComponentDefinitionDeleteParameters */
+type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeleteParameters;
+/** @deprecated use ComponentDefinitionGetParameters */
+type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
 /** The definition of a component parameter */
 type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
     typeConfig?: TConfig;
@@ -1095,6 +1087,8 @@ type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
 type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
 /** Defines a component type that can live on a Composition */
 type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
+/** @deprecated use ComponentDefinition instead */
+type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'updated'>;
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -1152,7 +1146,7 @@ interface paths$3 {
                     /** If true, any dynamic parameters will be left with their raw data.  Project map link path is a dynamic parameter. */
                     skipParameterResolution?: components$1["parameters"]["skipParameterResolution"];
                     /**
-                     * If true, any pattern override data is not resolved by the API.
+                     * @deprecated If true, any pattern override data is not resolved by the API.
                      * This is intended for internal use in the Canvas editor, and should not be used.
                      * Passing this parameter automatically implies withComponentIDs to be true.
                      */
@@ -1361,6 +1355,7 @@ interface components$1 {
          */
         skipPatternResolution: boolean;
         /**
+         * @deprecated
          * @description If true, any pattern override data is not resolved by the API.
          * This is intended for internal use in the Canvas editor, and should not be used.
          * Passing this parameter automatically implies withComponentIDs to be true.
@@ -1605,10 +1600,8 @@ interface external$4 {
                     connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -1618,14 +1611,6 @@ interface external$4 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -1651,6 +1636,7 @@ interface external$4 {
                     _pattern?: string;
                     _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -1667,26 +1653,20 @@ interface external$4 {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -1714,34 +1694,31 @@ interface external$4 {
                     _name: string;
                     _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -1750,11 +1727,10 @@ interface external$4 {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -1765,15 +1741,13 @@ interface external$4 {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -1807,7 +1781,10 @@ interface external$4 {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -1864,7 +1841,10 @@ interface external$4 {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -1881,13 +1861,17 @@ interface external$4 {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -1901,7 +1885,10 @@ interface external$4 {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -2256,10 +2243,8 @@ interface external$3 {
                     connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -2269,14 +2254,6 @@ interface external$3 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -2302,6 +2279,7 @@ interface external$3 {
                     _pattern?: string;
                     _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -2318,26 +2296,20 @@ interface external$3 {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -2365,34 +2337,31 @@ interface external$3 {
                     _name: string;
                     _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -2401,11 +2370,10 @@ interface external$3 {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -2416,15 +2384,13 @@ interface external$3 {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -2458,7 +2424,10 @@ interface external$3 {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -2515,7 +2484,10 @@ interface external$3 {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -2532,13 +2504,17 @@ interface external$3 {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -2552,7 +2528,10 @@ interface external$3 {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -2628,7 +2607,7 @@ interface external$3 {
                             /** If true, any dynamic parameters will be left with their raw data.  Project map link path is a dynamic parameter. */
                             skipParameterResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
                             /**
-                             * If true, any pattern override data is not resolved by the API.
+                             * @deprecated If true, any pattern override data is not resolved by the API.
                              * This is intended for internal use in the Canvas editor, and should not be used.
                              * Passing this parameter automatically implies withComponentIDs to be true.
                              */
@@ -2837,6 +2816,7 @@ interface external$3 {
                  */
                 skipPatternResolution: boolean;
                 /**
+                 * @deprecated
                  * @description If true, any pattern override data is not resolved by the API.
                  * This is intended for internal use in the Canvas editor, and should not be used.
                  * Passing this parameter automatically implies withComponentIDs to be true.
@@ -2915,6 +2895,14 @@ type CompositionGetListResponse = Components['CompositionListResponse'];
 type CompositionPutParameters = Api['put']['requestBody']['content']['application/json'];
 /** Shape of the DELETE request body for /api/v1/canvas */
 type CompositionDeleteParameters = Api['delete']['requestBody']['content']['application/json'];
+/** @deprecated use CompositionGetResponse */
+type CompositionAPIResponse = CompositionGetResponse;
+/** @deprecated use CompositionDeleteParameters */
+type CompositionAPIDeleteRequest = CompositionDeleteParameters;
+/** @deprecated use CompositionGetParameters */
+type CompositionListAPIResponse = CompositionGetListResponse;
+/** @deprecated use CompositionGetParameters */
+type CompositionAPIOptions = CompositionGetParameters;
 /** Defines an editable parameter on a component. */
 type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentParameter'], 'value'> & {
     /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
@@ -2940,18 +2928,22 @@ type ComponentInstance = SharedComponents['ComponentInstance'] & {
 type RootComponentInstance = SharedComponents['RootComponentInstance'];
 /**
  * Defines the shape of a component override
+ * @deprecated
  */
 type OverrideOptions = SharedComponents['OverrideOptions'];
 /**
  * Defines the shape of a component override
+ * @deprecated
  */
 type ComponentOverride = SharedComponents['ComponentOverride'];
 /**
  * Defines a set of component overrides by component ID
+ * @deprecated
  */
 type ComponentOverrides = Record<string, ComponentOverride>;
 /**
  * Defines how a component on a pattern may have its values overridden
+ * @deprecated
  */
 type ComponentOverridability = SharedComponents['ComponentOverridability'];
 /** Defines single structure to keep all canvas models (used in CLI commands and Starter content generations) */
@@ -2973,20 +2965,20 @@ type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
 type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
 /** Switches for data resolution */
 type DataResolutionOption = {
-    skipDataResolution?: boolean;
+    unstable_resolveData?: boolean;
 };
 type DataResolutionOptionNegative = {
-    skipDataResolution: true;
+    unstable_resolveData?: false;
 };
 type DataResolutionOptionPositive = {
-    skipDataResolution?: false;
+    unstable_resolveData: true;
 };
 type DataResolutionParameters = {
     /**
      * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
      * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
      */
-    diagnostics?: boolean;
+    unstable_diagnostics?: boolean;
     /**
      * Pass dynamic variables to the composition that are required for resolving bindings and datas,
      * such as language, detail page ID, etc.
@@ -3078,7 +3070,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                         connectedData?: {
                             pointer: string;
                             syntax: "jptr";
-                            required?: boolean | undefined;
                         } | undefined;
                     };
                 } | undefined;
@@ -3098,7 +3089,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3138,7 +3128,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                         connectedData?: {
                                             pointer: string;
                                             syntax: "jptr";
-                                            required?: boolean | undefined;
                                         } | undefined;
                                     };
                                 } | undefined;
@@ -3175,7 +3164,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3196,10 +3184,14 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
     getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
     getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
     getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    /** @deprecated use getCompositionByNodePath instead */
+    unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
     /** Fetches one composition by its project map node ID */
     getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
     getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
     getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    /** @deprecated Use getCompositionByNodeId instead */
+    unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
     /** Fetches one composition by its slug */
     getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
     getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
@@ -3259,7 +3251,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                         connectedData?: {
                             pointer: string;
                             syntax: "jptr";
-                            required?: boolean | undefined;
                         } | undefined;
                     };
                 } | undefined;
@@ -3299,7 +3290,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3330,6 +3320,10 @@ declare class UncachedCanvasClient extends CanvasClient {
     constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
 }
 
+type PreviewPanelSettings = {
+    isInteractive: boolean;
+};
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -3375,8 +3369,14 @@ interface paths$2 {
                         data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
                         /** Format: uuid */
                         projectId: string;
+                        /**
+                         * Format: uuid
+                         * @deprecated
+                         * @description Do not use. Will be removed in future.
+                         */
+                        integrationId?: string;
                         /** @description The integration type that the data source is attached to. Must be installed in the project. */
-                        integrationType: string;
+                        integrationType?: string;
                     };
                 };
             };
@@ -3591,10 +3591,8 @@ interface external$2 {
                     connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -3604,14 +3602,6 @@ interface external$2 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -3637,6 +3627,7 @@ interface external$2 {
                     _pattern?: string;
                     _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -3653,26 +3644,20 @@ interface external$2 {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -3700,34 +3685,31 @@ interface external$2 {
                     _name: string;
                     _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -3736,11 +3718,10 @@ interface external$2 {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -3751,15 +3732,13 @@ interface external$2 {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -3793,7 +3772,10 @@ interface external$2 {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -3850,7 +3832,10 @@ interface external$2 {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -3867,13 +3852,17 @@ interface external$2 {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -3887,7 +3876,10 @@ interface external$2 {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -4135,10 +4127,8 @@ interface external$1 {
                     connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4148,14 +4138,6 @@ interface external$1 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -4181,6 +4163,7 @@ interface external$1 {
                     _pattern?: string;
                     _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -4197,26 +4180,20 @@ interface external$1 {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -4244,34 +4221,31 @@ interface external$1 {
                     _name: string;
                     _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -4280,11 +4254,10 @@ interface external$1 {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4295,15 +4268,13 @@ interface external$1 {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4337,7 +4308,10 @@ interface external$1 {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -4394,7 +4368,10 @@ interface external$1 {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -4411,13 +4388,17 @@ interface external$1 {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -4431,7 +4412,10 @@ interface external$1 {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -4714,10 +4698,8 @@ interface external {
                     connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
                 };
                 /**
-                 * @description Defines a connection to a data element on a data resource.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Defines a connection to a data element on a data resource. Do not use.
                  */
                 DataElementConnectionDefinition: {
                     /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
@@ -4727,14 +4709,6 @@ interface external {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -4760,6 +4734,7 @@ interface external {
                     _pattern?: string;
                     _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
+                     * @deprecated
                      * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
                      * Means nothing for PUTs; it will be ignored.
                      */
@@ -4776,26 +4751,20 @@ interface external {
                      */
                     _patternError?: "NOTFOUND" | "CYCLIC";
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
-                     * This can be used to override parameters that are defined on patterns,
-                     * including nested patterns, with values that are specific to this composition.
-                     * The keys in this object are component IDs.
-                     * Overrides are applied from the top down, so for example if both the composition
-                     * and a pattern on the composition define an override on a nested pattern,
-                     * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Contains overrides that are defined on a pattern instance reference nested in a composition.
+                     * This is always undefined unless `skipOverridesResolution` is true.
+                     * See `_overrides` on `RootComponentInstance`.
                      */
                     _overrides?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
@@ -4823,34 +4792,31 @@ interface external {
                     _name: string;
                     _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
                     /**
-                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * Defines patch overrides to component IDs that live in the composition.
                      * This can be used to override parameters that are defined on patterns,
                      * including nested patterns, with values that are specific to this composition.
                      * The keys in this object are component IDs.
                      * Overrides are applied from the top down, so for example if both the composition
                      * and a pattern on the composition define an override on a nested pattern,
                      * the composition's override replaces the pattern's.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overrides?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
                     };
                     /**
-                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * @deprecated
+                     * @description Experimental functionality subject to change without notice.
+                     * When used on a pattern, defines how the pattern's parameters may be overridden
                      * by consumers of the pattern.
-                     *
-                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
                      */
                     _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
                 };
                 /**
-                 * @description Defines how to override a specific component.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how to override a specific component.
                  */
                 ComponentOverride: {
                     parameters?: {
@@ -4859,11 +4825,10 @@ interface external {
                     variant?: string;
                 };
                 /**
-                 * @description Defines how a component on a pattern may have its values overridden.
-                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
+                 * Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition.
                  */
                 ComponentOverridability: {
                     /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
@@ -4874,15 +4839,13 @@ interface external {
                     variants?: boolean;
                 };
                 /**
-                 * @description Whether a parameter is overridable
-                 *
-                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
-                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
-                 *
+                 * @deprecated
+                 * @description Experimental functionality subject to change without notice.
                  * @enum {string}
                  */
                 OverrideOptions: "yes" | "no";
                 /**
+                 * @deprecated
                  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
                  * These are created in the UI and shared across a whole project.
                  * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
@@ -4916,7 +4879,10 @@ interface external {
                         [key: string]: unknown;
                     };
                 };
-                /** @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. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 DataType: {
                     /** @description Public ID of the data type */
                     id: string;
@@ -4973,7 +4939,10 @@ interface external {
                         [key: string]: unknown;
                     };
                 };
-                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Source or Data Type
+                 */
                 DataVariableDefinition: {
                     /** @description Display name of the data variable */
                     displayName?: string;
@@ -4990,13 +4959,17 @@ interface external {
                     order?: number;
                 };
                 /**
+                 * @deprecated
                  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
                  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
                  */
                 DataResourceDefinitions: {
                     [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
                 };
-                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                /**
+                 * @deprecated
+                 * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
+                 */
                 DataResourceDefinition: {
                     /** @description Public ID of the data type that provides this data */
                     type: string;
@@ -5010,7 +4983,10 @@ interface external {
                     ignorePatternParameterDefault?: boolean;
                     variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
                 };
-                /** @description Variable values for a data resource. */
+                /**
+                 * @deprecated
+                 * @description Variable values for a data resource.
+                 */
                 DataResourceVariables: {
                     [key: string]: string;
                 };
@@ -5145,7 +5121,9 @@ type InvalidationPayload = schemas['InvalidationPayload'];
 type InvalidationResult = schemas['InvalidationResult'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
-/** API client to make comms with the Next Gen Mesh Data Source API simpler */
+/**
+ * @deprecated
+ */
 declare class DataSourceClient extends ApiClient {
     constructor(options: ClientOptions);
     /** Fetches all DataSources for a project */
@@ -5212,7 +5190,9 @@ declare class DataSourceClient extends ApiClient {
     remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
 }
 
-/** API client to make comms with the Next Gen Mesh Data Type API simpler */
+/**
+ * @deprecated
+ */
 declare class DataTypeClient extends ApiClient {
     #private;
     constructor(options: ClientOptions);
@@ -5418,6 +5398,7 @@ declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocati
 
 interface ContextualEditingWindowData {
     framework?: ReadyMessage['framework'];
+    version?: ReadyMessage['version'];
 }
 declare global {
     interface Window {
@@ -5431,6 +5412,8 @@ type SelectComponentMessage = {
 type ReadyMessage = {
     type: 'ready';
     framework?: 'React' | 'Vue';
+    /** A non-semantic version of the contextual editing SDK. */
+    version?: number;
 };
 type UpdateCompositionMessage = {
     type: 'update-composition';
@@ -5455,23 +5438,36 @@ type DismissPlaceholderMessage = {
     parentId: string;
     slotName: string;
 };
-type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
+type UpdatePreviewSettingsMessage = {
+    type: 'update-preview-settings';
+    settings: PreviewPanelSettings;
+};
+type ReportRenderedCompositionsMessage = {
+    type: 'report-rendered-compositions';
+    compositionIds: string[];
+    url: string;
+};
+type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
 declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
 declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
 declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
 declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
 declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
 declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
+declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
+declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
 type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
 type Channel = {
+    on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
     ready: () => void;
     destroy: () => void;
     selectComponent: (id: string) => void;
     updateComposition: (component: RootComponentInstance, secret?: string) => void;
-    on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
     addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
     moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
     dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
+    updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
+    reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
 };
 declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
     listenTo: Window[];
@@ -5549,10 +5545,18 @@ declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 /** The value of "data-role" in the component start `<script>` tag */
 declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+/** The value of "data-role" in the component end `<script>` tag */
+declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 /** The ID of the Contextual Editing script that gets embedded in frontend apps */
 declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 /** The ID we give to placeholder components */
 declare const PLACEHOLDER_ID = "placeholder";
+/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
+declare const EMPTY_COMPOSITION: {
+    _id: string;
+    _name: string;
+    type: string;
+};
 /** Minimal value for Edgehancers Cache TTL (in seconds) */
 declare const EDGE_MIN_CACHE_TTL = 15;
 /** Maximal value for Edgehancers Cache TTL (in seconds) */
@@ -5590,7 +5594,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
             connectedData?: {
                 pointer: string;
                 syntax: "jptr";
-                required?: boolean | undefined;
             } | undefined;
         };
     } | undefined;
@@ -5610,7 +5613,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                     connectedData?: {
                         pointer: string;
                         syntax: "jptr";
-                        required?: boolean | undefined;
                     } | undefined;
                 };
             } | undefined;
@@ -5650,7 +5652,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                             connectedData?: {
                                 pointer: string;
                                 syntax: "jptr";
-                                required?: boolean | undefined;
                             } | undefined;
                         };
                     } | undefined;
@@ -5687,7 +5688,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                     connectedData?: {
                         pointer: string;
                         syntax: "jptr";
-                        required?: boolean | undefined;
                     } | undefined;
                 };
             } | undefined;
@@ -5724,4 +5724,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+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 };