@uniformdev/canvas 17.0.0 → 17.1.1-alpha.152

package/dist/{createEventBus-aea3860f.d.ts → createEventBus-b9cdb6ff.d.ts}

@@ -125,6 +125,12 @@ interface external$1 {
                         "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
                     };
                 };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
                 /** Too many requests in allowed time period */
                 RateLimitError: unknown;
                 /** Execution error occurred */
@@ -270,25 +276,21 @@ interface external$1 {
                  * @description Defines a binding from a resource data value to a component parameter value. Do not use.
                  */
                 ComponentParameterBinding: {
-                    /**
-                     * @description A JSON Pointer expression that defines the binding directly to the parameter value, or
-                     * a map of JSON Pointers in the target parameter to JSON Pointers in the source resource data.
-                     * Used to bind to object-type values.
-                     * e.g. { "/prop1/thing": "/res1/things/value" } would set the target parameter's `value` to
-                     * {
-                     *   prop1: {
-                     *     thing: "value of /res1/things/value resource"
-                     *   }
-                     * }
-                     */
-                    pointer: string | {
-                        [key: string]: string;
-                    };
+                    /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
+                    pointer: string;
                     /**
                      * @description The syntax of the binding (currently always 'jptr')
                      * @enum {string}
                      */
                     syntax: "jptr";
+                    /**
+                     * @description Whether the binding should cause an error if it cannot be resolved.
+                     * If true, and the binding cannot be resolved, an error will be returned by the binding process.
+                     * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
+                     *
+                     * @default false
+                     */
+                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -304,12 +306,24 @@ interface external$1 {
                     slots?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
                     };
+                    /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
+                    _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
                     _pattern?: string;
+                    _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
+                    /**
+                     * @deprecated
+                     * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
+                     * Means nothing for PUTs; it will be ignored.
+                     */
+                    _patternData?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
+                    };
                     /**
                      * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
                      * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
                      * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
+                     * Means nothing for PUTs; it will be ignored.
                      *
                      * @enum {string}
                      */
@@ -335,6 +349,141 @@ interface external$1 {
                     _slug?: string | null;
                     /** @description Friendly name of this component. */
                     _name: string;
+                    _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
+                };
+                /**
+                 * @deprecated
+                 * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
+                 */
+                DataConnectionInfo: {
+                    /** @description Public ID of the data connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+                    connectorType: string;
+                    /** @description Base resource URL of the data connector. No trailing slash. */
+                    baseUrl?: string;
+                };
+                /**
+                 * @deprecated
+                 * @description An instance of an integration data connector (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.
+                 */
+                DataConnection: {
+                    /** @description Public ID of the data connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+                    connectorType: string;
+                    /** @description Base resource URL of the data connector. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data connector */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connector */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Variables needed to make calls to the data connector */
+                    variables?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
+                    };
+                    /** @description Custom configuration specific to the data connection being defined */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /**
+                 * @deprecated
+                 * @description A specific type of data that a Data Connection 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 connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description Public ID of the associated data connector */
+                    connectionId: string;
+                    /**
+                     * @description A connector-specific archetype for this data type; used to select UI as well as perform any
+                     * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
+                     * no special UI or processing is required.
+                     */
+                    archetype?: string;
+                    /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
+                    path: string;
+                    /** @description HTTP headers to pass with requests to the data connector */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connector */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Body to pass with requests to the data connector */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data connector.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data connector */
+                    variables?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
+                    };
+                    /** @description Custom configuration specific to the data connection being defined */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 */
+                DataVariable: {
+                    /** @description Display name of the data variable */
+                    displayName?: string;
+                    /**
+                     * @description Type of the data variable
+                     * @default text
+                     */
+                    type: string;
+                    /** @description Default value of the data variable */
+                    default: string;
+                    /**
+                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
+                     * @enum {string}
+                     */
+                    setBy: "static" | "dynamic";
+                };
+                /**
+                 * @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).
+                 */
+                CompositionDataDefinitions: {
+                    [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
+                };
+                /**
+                 * @deprecated
+                 * @description Data definition attached to this component
+                 */
+                CompositionDataDefinition: {
+                    /** @description Public ID of the data type that provides this data */
+                    type: string;
+                    /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
+                    isPatternParameter?: boolean;
+                    variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
+                };
+                /**
+                 * @deprecated
+                 * @description Static variable values for this composition.
+                 */
+                CompositionDataVariables: {
+                    [key: string]: string;
                 };
             };
         };
@@ -477,25 +626,21 @@ interface components$1 {
          * @description Defines a binding from a resource data value to a component parameter value. Do not use.
          */
         ComponentParameterBinding: {
-            /**
-             * @description A JSON Pointer expression that defines the binding directly to the parameter value, or
-             * a map of JSON Pointers in the target parameter to JSON Pointers in the source resource data.
-             * Used to bind to object-type values.
-             * e.g. { "/prop1/thing": "/res1/things/value" } would set the target parameter's `value` to
-             * {
-             *   prop1: {
-             *     thing: "value of /res1/things/value resource"
-             *   }
-             * }
-             */
-            pointer: string | {
-                [key: string]: string;
-            };
+            /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
+            pointer: string;
             /**
              * @description The syntax of the binding (currently always 'jptr')
              * @enum {string}
              */
             syntax: "jptr";
+            /**
+             * @description Whether the binding should cause an error if it cannot be resolved.
+             * If true, and the binding cannot be resolved, an error will be returned by the binding process.
+             * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
+             *
+             * @default false
+             */
+            required?: boolean;
         };
         /** @description Defines the shape of a component instance served by the composition API. */
         ComponentInstance: {
@@ -511,12 +656,24 @@ interface components$1 {
             slots?: {
                 [key: string]: components$1["schemas"]["ComponentInstance"][];
             };
+            /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
+            _id?: string;
             /** @description Indicates this component instance should be sourced from a pattern library pattern. */
             _pattern?: string;
+            _data?: components$1["schemas"]["CompositionDataDefinitions"];
+            /**
+             * @deprecated
+             * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
+             * Means nothing for PUTs; it will be ignored.
+             */
+            _patternData?: {
+                [key: string]: components$1["schemas"]["CompositionDataDefinition"];
+            };
             /**
              * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
              * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
              * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
+             * Means nothing for PUTs; it will be ignored.
              *
              * @enum {string}
              */
@@ -542,6 +699,141 @@ interface components$1 {
             _slug?: string | null;
             /** @description Friendly name of this component. */
             _name: string;
+            _data?: components$1["schemas"]["CompositionDataDefinitions"];
+        };
+        /**
+         * @deprecated
+         * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
+         */
+        DataConnectionInfo: {
+            /** @description Public ID of the data connector */
+            id: string;
+            /** @description Display name of the data connector */
+            displayName: string;
+            /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+            connectorType: string;
+            /** @description Base resource URL of the data connector. No trailing slash. */
+            baseUrl?: string;
+        };
+        /**
+         * @deprecated
+         * @description An instance of an integration data connector (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.
+         */
+        DataConnection: {
+            /** @description Public ID of the data connector */
+            id: string;
+            /** @description Display name of the data connector */
+            displayName: string;
+            /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+            connectorType: string;
+            /** @description Base resource URL of the data connector. No trailing slash. */
+            baseUrl: string;
+            /** @description HTTP headers to pass with requests to the data connector */
+            headers?: {
+                [key: string]: string;
+            };
+            /** @description Query String parameters to pass with requests to the data connector */
+            parameters?: {
+                [key: string]: string;
+            };
+            /** @description Variables needed to make calls to the data connector */
+            variables?: {
+                [key: string]: components$1["schemas"]["DataVariable"];
+            };
+            /** @description Custom configuration specific to the data connection being defined */
+            custom?: {
+                [key: string]: unknown;
+            };
+        };
+        /**
+         * @deprecated
+         * @description A specific type of data that a Data Connection 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 connector */
+            id: string;
+            /** @description Display name of the data connector */
+            displayName: string;
+            /** @description Public ID of the associated data connector */
+            connectionId: string;
+            /**
+             * @description A connector-specific archetype for this data type; used to select UI as well as perform any
+             * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
+             * no special UI or processing is required.
+             */
+            archetype?: string;
+            /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
+            path: string;
+            /** @description HTTP headers to pass with requests to the data connector */
+            headers?: {
+                [key: string]: string;
+            };
+            /** @description Query String parameters to pass with requests to the data connector */
+            parameters?: {
+                [key: string]: string;
+            };
+            /** @description Body to pass with requests to the data connector */
+            body?: string;
+            /**
+             * @description HTTP method to use with requests to the data connector.
+             * @default GET
+             * @enum {string}
+             */
+            method: "GET" | "POST" | "HEAD";
+            /** @description Variables needed to make calls to the data connector */
+            variables?: {
+                [key: string]: components$1["schemas"]["DataVariable"];
+            };
+            /** @description Custom configuration specific to the data connection being defined */
+            custom?: {
+                [key: string]: unknown;
+            };
+        };
+        /**
+         * @deprecated
+         * @description Defines the shape of a data variable on a Data Connector or Data Type
+         */
+        DataVariable: {
+            /** @description Display name of the data variable */
+            displayName?: string;
+            /**
+             * @description Type of the data variable
+             * @default text
+             */
+            type: string;
+            /** @description Default value of the data variable */
+            default: string;
+            /**
+             * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
+             * @enum {string}
+             */
+            setBy: "static" | "dynamic";
+        };
+        /**
+         * @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).
+         */
+        CompositionDataDefinitions: {
+            [key: string]: components$1["schemas"]["CompositionDataDefinition"];
+        };
+        /**
+         * @deprecated
+         * @description Data definition attached to this component
+         */
+        CompositionDataDefinition: {
+            /** @description Public ID of the data type that provides this data */
+            type: string;
+            /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
+            isPatternParameter?: boolean;
+            variables?: components$1["schemas"]["CompositionDataVariables"];
+        };
+        /**
+         * @deprecated
+         * @description Static variable values for this composition.
+         */
+        CompositionDataVariables: {
+            [key: string]: string;
         };
     };
 }
@@ -594,10 +886,12 @@ interface paths {
                     projectId: string;
                     /** Specify a single composition ID to fetch. Changes response from list to single. */
                     compositionId?: string;
+                    /** Specify multiple composition IDs to fetch. Response type will be a list. */
+                    compositionIDs?: string[];
                     /** Specify a single composition to fetch by slug. Changes response from list to single. */
                     slug?: string;
-                    /** The component type to filter by */
-                    type?: string;
+                    /** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
+                    type?: string[];
                     /** State of compositions to fetch. 0 = draft, 64 = published. */
                     state?: number;
                     /** Number of records to skip */
@@ -605,7 +899,7 @@ interface paths {
                     /** Max number of records to return */
                     limit?: number;
                     /**
-                     * Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
+                     * @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
                      * This improves performance if you do not require enhanced component data.
                      * If calling the Canvas API directly with no enhancer proxy, this has no effect.
                      */
@@ -616,6 +910,39 @@ interface paths {
                      * data embedded into it, and serialize the pattern data separately.
                      */
                     skipPatternResolution?: boolean;
+                    /**
+                     * If true the `_id` unique identifier of each non-root component will be part of the response data.
+                     * If false, the `_id` will not be present in the API response.
+                     */
+                    withComponentIDs?: boolean;
+                    /**
+                     * Matches compositions where their name, slug, or definition name contains the specified keyword.
+                     * NOT a full text search; does not match composition contents.
+                     */
+                    keyword?: string;
+                    /**
+                     * Matches compositions based on whether they are a pattern composition or a regular composition.
+                     * If true, only pattern compositions will be returned.
+                     * If false, only regular compositions will be returned.
+                     * If omitted, both pattern and regular compositions will be returned.
+                     */
+                    pattern?: boolean;
+                    /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
+                    orderBy?: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
+                    /**
+                     * @deprecated Returns the UI status string of the composition.
+                     * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
+                     */
+                    withUIStatus?: boolean;
+                    /**
+                     * @deprecated Filters composition lists by the UI status of the composition.
+                     * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
+                     */
+                    uiStatus?: ("Draft" | "Modified" | "Published" | "Orphan")[];
+                    /** Filters composition lists by the user who created them. The user is specified by their identity subject. */
+                    createdBy?: string;
+                    /** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
+                    updatedBy?: string;
                 };
             };
             responses: {
@@ -717,6 +1044,12 @@ interface components {
         CompositionApiResponse: {
             /** @description State of compositions to fetch. 0 = draft, 64 = published. */
             state: number;
+            /**
+             * @deprecated
+             * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
+             * @enum {string}
+             */
+            uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
             /**
              * Format: uuid
              * @description The project ID that this layout data is part of
@@ -770,6 +1103,12 @@ interface external {
                         "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
                     };
                 };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
                 /** Too many requests in allowed time period */
                 RateLimitError: unknown;
                 /** Execution error occurred */
@@ -915,25 +1254,21 @@ interface external {
                  * @description Defines a binding from a resource data value to a component parameter value. Do not use.
                  */
                 ComponentParameterBinding: {
-                    /**
-                     * @description A JSON Pointer expression that defines the binding directly to the parameter value, or
-                     * a map of JSON Pointers in the target parameter to JSON Pointers in the source resource data.
-                     * Used to bind to object-type values.
-                     * e.g. { "/prop1/thing": "/res1/things/value" } would set the target parameter's `value` to
-                     * {
-                     *   prop1: {
-                     *     thing: "value of /res1/things/value resource"
-                     *   }
-                     * }
-                     */
-                    pointer: string | {
-                        [key: string]: string;
-                    };
+                    /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
+                    pointer: string;
                     /**
                      * @description The syntax of the binding (currently always 'jptr')
                      * @enum {string}
                      */
                     syntax: "jptr";
+                    /**
+                     * @description Whether the binding should cause an error if it cannot be resolved.
+                     * If true, and the binding cannot be resolved, an error will be returned by the binding process.
+                     * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
+                     *
+                     * @default false
+                     */
+                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -949,12 +1284,24 @@ interface external {
                     slots?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
                     };
+                    /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
+                    _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
                     _pattern?: string;
+                    _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
+                    /**
+                     * @deprecated
+                     * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
+                     * Means nothing for PUTs; it will be ignored.
+                     */
+                    _patternData?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
+                    };
                     /**
                      * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
                      * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
                      * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
+                     * Means nothing for PUTs; it will be ignored.
                      *
                      * @enum {string}
                      */
@@ -980,6 +1327,141 @@ interface external {
                     _slug?: string | null;
                     /** @description Friendly name of this component. */
                     _name: string;
+                    _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
+                };
+                /**
+                 * @deprecated
+                 * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
+                 */
+                DataConnectionInfo: {
+                    /** @description Public ID of the data connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+                    connectorType: string;
+                    /** @description Base resource URL of the data connector. No trailing slash. */
+                    baseUrl?: string;
+                };
+                /**
+                 * @deprecated
+                 * @description An instance of an integration data connector (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.
+                 */
+                DataConnection: {
+                    /** @description Public ID of the data connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+                    connectorType: string;
+                    /** @description Base resource URL of the data connector. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data connector */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connector */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Variables needed to make calls to the data connector */
+                    variables?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
+                    };
+                    /** @description Custom configuration specific to the data connection being defined */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /**
+                 * @deprecated
+                 * @description A specific type of data that a Data Connection 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 connector */
+                    id: string;
+                    /** @description Display name of the data connector */
+                    displayName: string;
+                    /** @description Public ID of the associated data connector */
+                    connectionId: string;
+                    /**
+                     * @description A connector-specific archetype for this data type; used to select UI as well as perform any
+                     * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
+                     * no special UI or processing is required.
+                     */
+                    archetype?: string;
+                    /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
+                    path: string;
+                    /** @description HTTP headers to pass with requests to the data connector */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connector */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Body to pass with requests to the data connector */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data connector.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data connector */
+                    variables?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
+                    };
+                    /** @description Custom configuration specific to the data connection being defined */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /**
+                 * @deprecated
+                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 */
+                DataVariable: {
+                    /** @description Display name of the data variable */
+                    displayName?: string;
+                    /**
+                     * @description Type of the data variable
+                     * @default text
+                     */
+                    type: string;
+                    /** @description Default value of the data variable */
+                    default: string;
+                    /**
+                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
+                     * @enum {string}
+                     */
+                    setBy: "static" | "dynamic";
+                };
+                /**
+                 * @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).
+                 */
+                CompositionDataDefinitions: {
+                    [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
+                };
+                /**
+                 * @deprecated
+                 * @description Data definition attached to this component
+                 */
+                CompositionDataDefinition: {
+                    /** @description Public ID of the data type that provides this data */
+                    type: string;
+                    /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
+                    isPatternParameter?: boolean;
+                    variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
+                };
+                /**
+                 * @deprecated
+                 * @description Static variable values for this composition.
+                 */
+                CompositionDataVariables: {
+                    [key: string]: string;
                 };
             };
         };
@@ -991,9 +1473,14 @@ declare type Components = components['schemas'];
 declare type SharedComponents = components$1['schemas'];
 declare type Api = paths['/api/v1/canvas'];
 /** Query parameter options for GET /api/v1/canvas */
-declare type CompositionGetParameters = Api['get']['parameters']['query'];
+declare type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
+    type?: string | string[];
+};
+declare type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
 /** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
 declare type CompositionGetResponse = Components['CompositionApiResponse'];
+/** @deprecated - internal use, do not rely on this value */
+declare type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
 /** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
 declare type CompositionGetListResponse = Components['CompositionListResponse'];
 /** The PUT request body for /api/v1/canvas */
@@ -1015,6 +1502,12 @@ declare type ComponentParameter<TValue = unknown> = Omit<SharedComponents['Compo
 };
 /** Defines a binding from a resource data value to a component parameter value. */
 declare type ComponentParameterBinding = SharedComponents['ComponentParameterBinding'];
+/** Variables defined for this composition. */
+declare type CompositionDataVariables = SharedComponents['CompositionDataVariables'];
+/** Defines the shape of a resource bound to a composition */
+declare type CompositionDataDefinitions = SharedComponents['CompositionDataDefinitions'];
+/** Defines the shape of a resource bound to a composition */
+declare type CompositionDataDefinition = SharedComponents['CompositionDataDefinition'];
 /** Defines the shape of a component instance served by the composition API. */
 declare type ComponentInstance = SharedComponents['ComponentInstance'] & {
     /** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
@@ -1053,4 +1546,4 @@ declare global {
  */
 declare function createEventBus(): Promise<PreviewEventBus | undefined>;
 
-export { CanvasDefinitions as A, ChannelSubscription as B, ComponentInstance as C, createEventBus as D, PreviewEventBus as P, RootComponentInstance as R, ComponentParameter as a, CompositionGetParameters as b, CompositionPutParameters as c, CompositionDeleteParameters as d, ComponentDefinitionGetParameters as e, ComponentDefinitionPutParameters as f, ComponentDefinitionDeleteParameters as g, ComponentDefinitionGetResponse as h, ComponentDefinitionAPIResponse as i, ComponentDefinitionAPIPutRequest as j, ComponentDefinitionAPIDeleteRequest as k, ComponentDefinitionListAPIOptions as l, ComponentDefinitionParameter as m, ComponentDefinitionVariant as n, ComponentDefinitionSlugSettings as o, ComponentDefinitionSlot as p, ComponentDefinitionPermission as q, ComponentDefinition as r, CreatingComponentDefinition as s, CompositionGetResponse as t, CompositionGetListResponse as u, CompositionAPIResponse as v, CompositionAPIDeleteRequest as w, CompositionListAPIResponse as x, CompositionAPIOptions as y, ComponentParameterBinding as z };
+export { CompositionListAPIResponse as A, CompositionAPIOptions as B, ComponentInstance as C, ComponentParameterBinding as D, CompositionDataVariables as E, CompositionDataDefinitions as F, CompositionDataDefinition as G, CanvasDefinitions as H, ChannelSubscription as I, createEventBus as J, PreviewEventBus as P, RootComponentInstance as R, ComponentParameter as a, CompositionGetParameters as b, components$1 as c, CompositionPutParameters as d, CompositionDeleteParameters as e, ComponentDefinitionGetParameters as f, ComponentDefinitionPutParameters as g, ComponentDefinitionDeleteParameters as h, ComponentDefinitionGetResponse as i, ComponentDefinitionAPIResponse as j, ComponentDefinitionAPIPutRequest as k, ComponentDefinitionAPIDeleteRequest as l, ComponentDefinitionListAPIOptions as m, ComponentDefinitionParameter as n, ComponentDefinitionVariant as o, ComponentDefinitionSlugSettings as p, ComponentDefinitionSlot as q, ComponentDefinitionPermission as r, ComponentDefinition as s, CreatingComponentDefinition as t, CompositionGetOrderBy as u, CompositionGetResponse as v, CompositionUIStatus as w, CompositionGetListResponse as x, CompositionAPIResponse as y, CompositionAPIDeleteRequest as z };