@uniformdev/canvas 17.1.0 → 17.1.1-alpha.231

package/dist/index.d.ts

@@ -1,7 +1,9 @@
-import { C as ComponentInstance, a as ComponentParameter, b as CompositionGetParameters, c as CompositionPutParameters, d as CompositionDeleteParameters, e as ComponentDefinitionGetParameters, f as ComponentDefinitionPutParameters, g as ComponentDefinitionDeleteParameters, P as PreviewEventBus } from './createEventBus-c46c67da.js';
-export { F as CanvasDefinitions, G as ChannelSubscription, r as ComponentDefinition, k as ComponentDefinitionAPIDeleteRequest, j as ComponentDefinitionAPIPutRequest, i as ComponentDefinitionAPIResponse, g as ComponentDefinitionDeleteParameters, e as ComponentDefinitionGetParameters, h as ComponentDefinitionGetResponse, l as ComponentDefinitionListAPIOptions, m as ComponentDefinitionParameter, q as ComponentDefinitionPermission, f as ComponentDefinitionPutParameters, p as ComponentDefinitionSlot, o as ComponentDefinitionSlugSettings, n as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, z as ComponentParameterBinding, w as CompositionAPIDeleteRequest, y as CompositionAPIOptions, v as CompositionAPIResponse, d as CompositionDeleteParameters, u as CompositionGetListResponse, b as CompositionGetParameters, t as CompositionGetResponse, x as CompositionListAPIResponse, c as CompositionPutParameters, E as CompositionResourceDefinition, D as CompositionResourceDefinitions, B as CompositionVariable, A as CompositionVariableDefinitions, s as CreatingComponentDefinition, P as PreviewEventBus, R as RootComponentInstance, H as createEventBus } from './createEventBus-c46c67da.js';
+import { C as ComponentInstance, a as ComponentParameter, c as components, b as CompositionGetParameters, d as CompositionPutParameters, e as CompositionDeleteParameters, f as ComponentDefinitionGetParameters, g as ComponentDefinitionPutParameters, h as ComponentDefinitionDeleteParameters, R as RootComponentInstance, P as PreviewEventBus, i as CompositionGetResponse } from './createEventBus-e386fc9c.js';
+export { H as CanvasDefinitions, I as ChannelSubscription, t as ComponentDefinition, m as ComponentDefinitionAPIDeleteRequest, l as ComponentDefinitionAPIPutRequest, k as ComponentDefinitionAPIResponse, h as ComponentDefinitionDeleteParameters, f as ComponentDefinitionGetParameters, j as ComponentDefinitionGetResponse, n as ComponentDefinitionListAPIOptions, o as ComponentDefinitionParameter, s as ComponentDefinitionPermission, g as ComponentDefinitionPutParameters, r as ComponentDefinitionSlot, q as ComponentDefinitionSlugSettings, p as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, D as ComponentParameterBinding, z as CompositionAPIDeleteRequest, B as CompositionAPIOptions, y as CompositionAPIResponse, G as CompositionDataDefinition, F as CompositionDataDefinitions, E as CompositionDataVariables, e as CompositionDeleteParameters, x as CompositionGetListResponse, v as CompositionGetOrderBy, b as CompositionGetParameters, i as CompositionGetResponse, A as CompositionListAPIResponse, d as CompositionPutParameters, w as CompositionUIStatus, u as CreatingComponentDefinition, P as PreviewEventBus, R as RootComponentInstance, J as createEventBus } from './createEventBus-e386fc9c.js';
 import { Options } from 'p-throttle';
 import { Options as Options$1 } from 'p-retry';
+import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
+export { ApiClientError } from '@uniformdev/context/api';
 import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
 import 'pusher-js';
 
@@ -83,12 +85,1398 @@ declare type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unkn
     completeAll?: () => Promise<number>;
 };
 
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths$2 {
+    "/api/v1/data-types": {
+        get: {
+            parameters: {
+                query: {
+                    projectId: string;
+                };
+            };
+            responses: {
+                /** OK */
+                200: {
+                    content: {
+                        "application/json": {
+                            results: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
+                        };
+                    };
+                };
+                400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+        put: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
+                        /** Format: uuid */
+                        projectId: string;
+                    };
+                };
+            };
+        };
+        delete: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        typeId: string;
+                        /** Format: uuid */
+                        projectId: string;
+                    };
+                };
+            };
+        };
+    };
+}
+interface external$2 {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Too many requests in allowed time period */
+                RateLimitError: unknown;
+                /** Execution error occurred */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+    "uniform-canvas-types.swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                /** @description Public ID (used in code). Do not change after creation. */
+                PublicIdProperty: string;
+                /** @description The definition of a component parameter */
+                ComponentDefinitionParameter: {
+                    id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the parameter */
+                    name: string;
+                    /** @description Appears next to the parameter in the Composition editor */
+                    helpText?: string;
+                    /** @description Type name of the parameter (provided by a Uniform integration) */
+                    type: string;
+                    /** @description The configuration object for the type (type-specific) */
+                    typeConfig?: unknown;
+                };
+                /** @description The definition of a named component slot that can contain other components */
+                ComponentDefinitionSlot: {
+                    id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the slot */
+                    name: string;
+                    /** @description A list of component definition public IDs that are allowed in this named slot */
+                    allowedComponents: string[];
+                    /**
+                     * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
+                     * @default false
+                     */
+                    inheritAllowedComponents: boolean;
+                    /** @description Minimum valid number of components in this slot */
+                    minComponents?: number;
+                    /** @description Maximum valid number of components in this slot */
+                    maxComponents?: number;
+                };
+                /** @description The definition of a composition's slug settings */
+                ComponentDefinitionSlugSettings: {
+                    /**
+                     * @description Whether the slug is required
+                     * no: slug is optional
+                     * yes: slug is required
+                     * disabled: slug is disabled and will not be shown in the editor
+                     *
+                     * @default no
+                     * @enum {string}
+                     */
+                    required?: "no" | "yes" | "disabled";
+                    /**
+                     * @description Slug uniqueness configuration.
+                     * no = no unique constraint
+                     * local = must be unique within this component type
+                     * global = must be unique across all component types
+                     *
+                     * @enum {string}
+                     */
+                    unique?: "no" | "local" | "global";
+                    /** @description Regular expression slugs must match */
+                    regularExpression?: string;
+                    /**
+                     * @description Custom error message when regular expression validation fails.
+                     * Has no effect if `regularExpression` is not set.
+                     */
+                    regularExpressionMessage?: string;
+                };
+                /** @description The definition of a component variant */
+                ComponentDefinitionVariant: {
+                    id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the variant */
+                    name: string;
+                };
+                /** @description Permission set for a component defintion */
+                ComponentDefinitionPermission: {
+                    roleId: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /**
+                     * @description Permission type for this permission ComponentDefinition:
+                     * read | write | create | delete
+                     *
+                     * @enum {string}
+                     */
+                    permission: "read" | "write" | "create" | "delete";
+                    /** @description State of the component that this permission applies to */
+                    state: number;
+                };
+                /** @description Defines a component type that can live on a Composition */
+                ComponentDefinition: {
+                    id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the component definition */
+                    name: string;
+                    /**
+                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @default screen
+                     */
+                    icon?: string;
+                    /**
+                     * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
+                     * The parameter type must support being used as a title parameter for this to work.
+                     */
+                    titleParameter?: string | null;
+                    /**
+                     * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
+                     * @default false
+                     */
+                    canBeComposition?: boolean;
+                    /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
+                    parameters?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * @description if this component uses team permissions or custom permissions
+                     * @default true
+                     */
+                    useTeamPermissions?: boolean;
+                    /** @description Custom role permissions for this component definition */
+                    permissions?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
+                    /** @description The named slots for this component; placement areas where arrays of other components can be added. */
+                    slots?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
+                    slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
+                    /** @description Default component instance value */
+                    defaults?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
+                    /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
+                    variants?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
+                    /** @description Created date string for this definition (ignored for writes) */
+                    created?: string;
+                    /** @description Last modified date string for this definition (ignored for writes) */
+                    updated?: string;
+                };
+                /** @description Defines an editable parameter on a component. */
+                ComponentParameter: {
+                    /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
+                    value: unknown;
+                    /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
+                    type: string;
+                    binding?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
+                };
+                /**
+                 * @deprecated
+                 * @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 */
+                    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: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external$2["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$2["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$2["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}
+                     */
+                    _patternError?: "NOTFOUND" | "CYCLIC";
+                };
+                /** @description Defines the shape of the root component in a composition */
+                RootComponentInstance: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
+                    };
+                    /** @description The public UUID of the composition. */
+                    _id: string;
+                    /** @description Slug pattern of this component. */
+                    _slug?: string | null;
+                    /** @description Friendly name of this component. */
+                    _name: string;
+                    _data?: external$2["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 connection */
+                    id: string;
+                    /** @description Display name of the data connection */
+                    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 connection. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data connection */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connection */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Variables needed to make calls to the data connection */
+                    variables?: {
+                        [key: string]: external$2["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 type */
+                    id: string;
+                    /** @description Display name of the data type */
+                    displayName: string;
+                    /** @description Public ID of the associated data connection */
+                    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 type. Merged with headers from the data connection, overriding identical keys. */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Body to pass with requests to the data type (ignored unless method is POST) */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data type.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
+                    variables?: {
+                        [key: string]: external$2["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$2["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$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
+                };
+                /**
+                 * @deprecated
+                 * @description Static variable values for this composition.
+                 */
+                CompositionDataVariables: {
+                    [key: string]: string;
+                };
+            };
+        };
+        operations: {};
+    };
+}
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths$1 {
+    "/api/v1/data-connection": {
+        get: {
+            parameters: {
+                query: {
+                    dataConnectionId: string;
+                    projectId: string;
+                };
+            };
+            responses: {
+                /** OK */
+                200: {
+                    content: {
+                        "application/json": {
+                            result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
+                        };
+                    };
+                };
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+        put: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
+                        /** Format: uuid */
+                        projectId: string;
+                        /** Format: uuid */
+                        integrationId: string;
+                    };
+                };
+            };
+        };
+        delete: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        connectionId: string;
+                        /** Format: uuid */
+                        projectId: string;
+                    };
+                };
+            };
+        };
+    };
+}
+interface external$1 {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "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 */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+    "uniform-canvas-types.swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                /** @description Public ID (used in code). Do not change after creation. */
+                PublicIdProperty: string;
+                /** @description The definition of a component parameter */
+                ComponentDefinitionParameter: {
+                    id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the parameter */
+                    name: string;
+                    /** @description Appears next to the parameter in the Composition editor */
+                    helpText?: string;
+                    /** @description Type name of the parameter (provided by a Uniform integration) */
+                    type: string;
+                    /** @description The configuration object for the type (type-specific) */
+                    typeConfig?: unknown;
+                };
+                /** @description The definition of a named component slot that can contain other components */
+                ComponentDefinitionSlot: {
+                    id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the slot */
+                    name: string;
+                    /** @description A list of component definition public IDs that are allowed in this named slot */
+                    allowedComponents: string[];
+                    /**
+                     * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
+                     * @default false
+                     */
+                    inheritAllowedComponents: boolean;
+                    /** @description Minimum valid number of components in this slot */
+                    minComponents?: number;
+                    /** @description Maximum valid number of components in this slot */
+                    maxComponents?: number;
+                };
+                /** @description The definition of a composition's slug settings */
+                ComponentDefinitionSlugSettings: {
+                    /**
+                     * @description Whether the slug is required
+                     * no: slug is optional
+                     * yes: slug is required
+                     * disabled: slug is disabled and will not be shown in the editor
+                     *
+                     * @default no
+                     * @enum {string}
+                     */
+                    required?: "no" | "yes" | "disabled";
+                    /**
+                     * @description Slug uniqueness configuration.
+                     * no = no unique constraint
+                     * local = must be unique within this component type
+                     * global = must be unique across all component types
+                     *
+                     * @enum {string}
+                     */
+                    unique?: "no" | "local" | "global";
+                    /** @description Regular expression slugs must match */
+                    regularExpression?: string;
+                    /**
+                     * @description Custom error message when regular expression validation fails.
+                     * Has no effect if `regularExpression` is not set.
+                     */
+                    regularExpressionMessage?: string;
+                };
+                /** @description The definition of a component variant */
+                ComponentDefinitionVariant: {
+                    id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the variant */
+                    name: string;
+                };
+                /** @description Permission set for a component defintion */
+                ComponentDefinitionPermission: {
+                    roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /**
+                     * @description Permission type for this permission ComponentDefinition:
+                     * read | write | create | delete
+                     *
+                     * @enum {string}
+                     */
+                    permission: "read" | "write" | "create" | "delete";
+                    /** @description State of the component that this permission applies to */
+                    state: number;
+                };
+                /** @description Defines a component type that can live on a Composition */
+                ComponentDefinition: {
+                    id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the component definition */
+                    name: string;
+                    /**
+                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @default screen
+                     */
+                    icon?: string;
+                    /**
+                     * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
+                     * The parameter type must support being used as a title parameter for this to work.
+                     */
+                    titleParameter?: string | null;
+                    /**
+                     * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
+                     * @default false
+                     */
+                    canBeComposition?: boolean;
+                    /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
+                    parameters?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * @description if this component uses team permissions or custom permissions
+                     * @default true
+                     */
+                    useTeamPermissions?: boolean;
+                    /** @description Custom role permissions for this component definition */
+                    permissions?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
+                    /** @description The named slots for this component; placement areas where arrays of other components can be added. */
+                    slots?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
+                    slugSettings?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
+                    /** @description Default component instance value */
+                    defaults?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
+                    /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
+                    variants?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
+                    /** @description Created date string for this definition (ignored for writes) */
+                    created?: string;
+                    /** @description Last modified date string for this definition (ignored for writes) */
+                    updated?: string;
+                };
+                /** @description Defines an editable parameter on a component. */
+                ComponentParameter: {
+                    /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
+                    value: unknown;
+                    /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
+                    type: string;
+                    binding?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
+                };
+                /**
+                 * @deprecated
+                 * @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 */
+                    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: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    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}
+                     */
+                    _patternError?: "NOTFOUND" | "CYCLIC";
+                };
+                /** @description Defines the shape of the root component in a composition */
+                RootComponentInstance: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
+                    };
+                    /** @description The public UUID of the composition. */
+                    _id: string;
+                    /** @description Slug pattern of this component. */
+                    _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 connection */
+                    id: string;
+                    /** @description Display name of the data connection */
+                    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 connection. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data connection */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connection */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Variables needed to make calls to the data connection */
+                    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 type */
+                    id: string;
+                    /** @description Display name of the data type */
+                    displayName: string;
+                    /** @description Public ID of the associated data connection */
+                    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 type. Merged with headers from the data connection, overriding identical keys. */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Body to pass with requests to the data type (ignored unless method is POST) */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data type.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
+                    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;
+                };
+            };
+        };
+        operations: {};
+    };
+}
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/v1/data-connections": {
+        get: {
+            parameters: {
+                query: {
+                    projectId: string;
+                };
+            };
+            responses: {
+                /** OK */
+                200: {
+                    content: {
+                        "application/json": {
+                            results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnectionInfo"][];
+                        };
+                    };
+                };
+                400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+    };
+}
+interface external {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "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 */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+    "uniform-canvas-types.swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                /** @description Public ID (used in code). Do not change after creation. */
+                PublicIdProperty: string;
+                /** @description The definition of a component parameter */
+                ComponentDefinitionParameter: {
+                    id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the parameter */
+                    name: string;
+                    /** @description Appears next to the parameter in the Composition editor */
+                    helpText?: string;
+                    /** @description Type name of the parameter (provided by a Uniform integration) */
+                    type: string;
+                    /** @description The configuration object for the type (type-specific) */
+                    typeConfig?: unknown;
+                };
+                /** @description The definition of a named component slot that can contain other components */
+                ComponentDefinitionSlot: {
+                    id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the slot */
+                    name: string;
+                    /** @description A list of component definition public IDs that are allowed in this named slot */
+                    allowedComponents: string[];
+                    /**
+                     * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
+                     * @default false
+                     */
+                    inheritAllowedComponents: boolean;
+                    /** @description Minimum valid number of components in this slot */
+                    minComponents?: number;
+                    /** @description Maximum valid number of components in this slot */
+                    maxComponents?: number;
+                };
+                /** @description The definition of a composition's slug settings */
+                ComponentDefinitionSlugSettings: {
+                    /**
+                     * @description Whether the slug is required
+                     * no: slug is optional
+                     * yes: slug is required
+                     * disabled: slug is disabled and will not be shown in the editor
+                     *
+                     * @default no
+                     * @enum {string}
+                     */
+                    required?: "no" | "yes" | "disabled";
+                    /**
+                     * @description Slug uniqueness configuration.
+                     * no = no unique constraint
+                     * local = must be unique within this component type
+                     * global = must be unique across all component types
+                     *
+                     * @enum {string}
+                     */
+                    unique?: "no" | "local" | "global";
+                    /** @description Regular expression slugs must match */
+                    regularExpression?: string;
+                    /**
+                     * @description Custom error message when regular expression validation fails.
+                     * Has no effect if `regularExpression` is not set.
+                     */
+                    regularExpressionMessage?: string;
+                };
+                /** @description The definition of a component variant */
+                ComponentDefinitionVariant: {
+                    id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the variant */
+                    name: string;
+                };
+                /** @description Permission set for a component defintion */
+                ComponentDefinitionPermission: {
+                    roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /**
+                     * @description Permission type for this permission ComponentDefinition:
+                     * read | write | create | delete
+                     *
+                     * @enum {string}
+                     */
+                    permission: "read" | "write" | "create" | "delete";
+                    /** @description State of the component that this permission applies to */
+                    state: number;
+                };
+                /** @description Defines a component type that can live on a Composition */
+                ComponentDefinition: {
+                    id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the component definition */
+                    name: string;
+                    /**
+                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @default screen
+                     */
+                    icon?: string;
+                    /**
+                     * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
+                     * The parameter type must support being used as a title parameter for this to work.
+                     */
+                    titleParameter?: string | null;
+                    /**
+                     * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
+                     * @default false
+                     */
+                    canBeComposition?: boolean;
+                    /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
+                    parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * @description if this component uses team permissions or custom permissions
+                     * @default true
+                     */
+                    useTeamPermissions?: boolean;
+                    /** @description Custom role permissions for this component definition */
+                    permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
+                    /** @description The named slots for this component; placement areas where arrays of other components can be added. */
+                    slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
+                    slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
+                    /** @description Default component instance value */
+                    defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
+                    /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
+                    variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
+                    /** @description Created date string for this definition (ignored for writes) */
+                    created?: string;
+                    /** @description Last modified date string for this definition (ignored for writes) */
+                    updated?: string;
+                };
+                /** @description Defines an editable parameter on a component. */
+                ComponentParameter: {
+                    /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
+                    value: unknown;
+                    /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
+                    type: string;
+                    binding?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
+                };
+                /**
+                 * @deprecated
+                 * @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 */
+                    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: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    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}
+                     */
+                    _patternError?: "NOTFOUND" | "CYCLIC";
+                };
+                /** @description Defines the shape of the root component in a composition */
+                RootComponentInstance: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
+                    };
+                    /** @description The public UUID of the composition. */
+                    _id: string;
+                    /** @description Slug pattern of this component. */
+                    _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 connection */
+                    id: string;
+                    /** @description Display name of the data connection */
+                    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 connection. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data connection */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data connection */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Variables needed to make calls to the data connection */
+                    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 type */
+                    id: string;
+                    /** @description Display name of the data type */
+                    displayName: string;
+                    /** @description Public ID of the associated data connection */
+                    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 type. Merged with headers from the data connection, overriding identical keys. */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
+                    parameters?: {
+                        [key: string]: string;
+                    };
+                    /** @description Body to pass with requests to the data type (ignored unless method is POST) */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data type.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
+                    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;
+                };
+            };
+        };
+        operations: {};
+    };
+}
+
+declare type DataTypeApi = paths$2['/api/v1/data-types'];
+declare type DataConnectionsApi = paths['/api/v1/data-connections'];
+declare type DataConnectionApi = paths$1['/api/v1/data-connection'];
+/** Query parameter options for GET /api/v1/data-types */
+declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
+/** The GET response from /api/v1/data-types */
+declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
+/** The PUT request body for /api/v1/data-types */
+declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
+/** Shape of the DELETE request body for /api/v1/data-types */
+declare type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
+/** Query parameter options for GET /api/v1/data-connection */
+declare type DataConnectionGetParameters = DataConnectionApi['get']['parameters']['query'];
+/** Query parameter options for GET /api/v1/data-connections */
+declare type DataConnectionsGetParameters = DataConnectionsApi['get']['parameters']['query'];
+/** The GET response from /api/v1/data-connections */
+declare type DataConnectionGetResponse = DataConnectionApi['get']['responses']['200']['content']['application/json'];
+/** The GET response from /api/v1/data-connections */
+declare type DataConnectionsGetResponse = DataConnectionsApi['get']['responses']['200']['content']['application/json'];
+/** The PUT request body for /api/v1/data-connection */
+declare type DataConnectionPutParameters = DataConnectionApi['put']['requestBody']['content']['application/json'];
+/** Shape of the DELETE request body for /api/v1/data-connection */
+declare type DataConnectionDeleteParameters = DataConnectionApi['delete']['requestBody']['content']['application/json'];
+declare type DataType = components['schemas']['DataType'];
+declare type DataConnection = components['schemas']['DataConnection'];
+declare type DataConnectionInfo = components['schemas']['DataConnectionInfo'];
+declare type DataVariable = components['schemas']['DataVariable'];
+
 declare type ComponentLocationReference = {
     component: ComponentInstance;
     parentSlot?: string;
     parentSlotIndex?: number;
 };
-declare type WalkComponentTreeActions = {
+declare type WalkComponentTreeActions<TContext> = {
     /** Replaces the component being visited with a new object */
     replaceComponent: (replacementComponent: ComponentInstance) => void;
     /** Removes the component being visited from the composition */
@@ -97,9 +1485,17 @@ declare type WalkComponentTreeActions = {
     insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
     /** Aborts visitation of components that are in child slots of the current component */
     stopProcessingDescendants: () => void;
+    /**
+     * Set a new traversal context for descendants of this node.
+     * If this is not called, `context` will automatically pass through.
+     */
+    setDescendantsContext: (context: TContext) => void;
+    setChildContext: (child: ComponentInstance, context: TContext) => void;
 };
 /** Walks a composition's component tree, visiting each component instance depth-first, in order. */
-declare function walkComponentTree(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions) => void): void;
+declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>, 
+/** Traversal context for this node */
+currentContext: TContext | undefined) => void, initialContext?: TContext): void;
 declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
 
 /** A single entry in a batch of queued enhancements. */
@@ -252,56 +1648,18 @@ declare function createLimitPolicy({ throttle, retry, }: {
 }): LimitPolicy;
 declare const nullLimitPolicy: LimitPolicy;
 
-declare type CanvasClientOptions = {
-    /** The Uniform API host to use. Internal use. */
-    apiHost?: string;
-    /** The Uniform API key to use when sending API requests. This or bearer token must be specified. */
-    apiKey?: string | null;
-    /** The Uniform bearer token to use. Internal use. */
-    bearerToken?: string | null;
-    /** The Uniform project ID to connect to */
-    projectId?: string | null;
-    /** Specify a fetch implementation to use when fetching data. Useful if you want to only polyfill selectively. */
-    fetch?: typeof fetch;
-    /**
-     * Specify how to retry and throttle requests.
-     * Default: retry 3x on failures with exponential backoff, up to 10 requests per second.
-     * Use createLimitPolicy() to help creating a policy. */
-    limitPolicy?: LimitPolicy;
-    /** Specify whether CDN caching is disabled. */
-    bypassCache?: boolean;
-    /** @deprecated do not use */
-    experiment14?: boolean;
-};
-declare class CanvasClientError extends Error {
-    errorMessage: string;
-    fetchMethod: string;
-    fetchUri: string;
-    statusCode?: number | undefined;
-    statusText?: string | undefined;
-    requestId?: string | undefined;
-    constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number | undefined, statusText?: string | undefined, requestId?: string | undefined);
-}
-declare class CanvasClient {
-    private options;
-    constructor(options: CanvasClientOptions);
-    private get canvasUrl();
+declare class CanvasClient extends ApiClient<ClientOptions> {
+    constructor(options: ClientOptions);
+    private canvasUrl;
     /** Fetches lists of Canvas compositions, optionally by type */
-    getCompositionList(options?: Omit<CompositionGetParameters, 'projectId'>): Promise<{
+    getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
         compositions: {
             state: number;
+            uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
             projectId: string;
             created: string;
             modified: string;
             pattern: boolean;
-            resources?: {
-                [key: string]: {
-                    type: string;
-                    data: {
-                        [key: string]: unknown;
-                    };
-                };
-            } | undefined;
             composition: {
                 type: string;
                 parameters?: {
@@ -309,9 +1667,7 @@ declare class CanvasClient {
                         value: unknown;
                         type: string;
                         binding?: {
-                            pointer: string | {
-                                [key: string]: string;
-                            };
+                            pointer: string;
                             syntax: "jptr";
                             required?: boolean | undefined;
                         } | undefined;
@@ -326,9 +1682,7 @@ declare class CanvasClient {
                                 value: unknown;
                                 type: string;
                                 binding?: {
-                                    pointer: string | {
-                                        [key: string]: string;
-                                    };
+                                    pointer: string;
                                     syntax: "jptr";
                                     required?: boolean | undefined;
                                 } | undefined;
@@ -340,36 +1694,50 @@ declare class CanvasClient {
                         } | undefined;
                         _id?: string | undefined;
                         _pattern?: string | undefined;
+                        _data?: {
+                            [key: string]: {
+                                type: string;
+                                isPatternParameter?: boolean | undefined;
+                                variables?: {
+                                    [key: string]: string;
+                                } | undefined;
+                            };
+                        } | undefined;
+                        _patternData?: {
+                            [key: string]: {
+                                type: string;
+                                isPatternParameter?: boolean | undefined;
+                                variables?: {
+                                    [key: string]: string;
+                                } | undefined;
+                            };
+                        } | undefined;
                         _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
                     }[];
                 } | undefined;
                 _id: string;
                 _slug?: string | null | undefined;
                 _name: string;
+                _data?: {
+                    [key: string]: {
+                        type: string;
+                        isPatternParameter?: boolean | undefined;
+                        variables?: {
+                            [key: string]: string;
+                        } | undefined;
+                    };
+                } | undefined;
             };
-            variables?: {
-                [key: string]: {
-                    required: boolean;
-                    default: string;
-                };
-            } | undefined;
         }[];
     }>;
     /** Fetches a Canvas composition by string name (slug) */
-    getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs'>): Promise<{
+    getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus'>): Promise<{
         state: number;
+        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
         projectId: string;
         created: string;
         modified: string;
         pattern: boolean;
-        resources?: {
-            [key: string]: {
-                type: string;
-                data: {
-                    [key: string]: unknown;
-                };
-            };
-        } | undefined;
         composition: {
             type: string;
             parameters?: {
@@ -377,9 +1745,7 @@ declare class CanvasClient {
                     value: unknown;
                     type: string;
                     binding?: {
-                        pointer: string | {
-                            [key: string]: string;
-                        };
+                        pointer: string;
                         syntax: "jptr";
                         required?: boolean | undefined;
                     } | undefined;
@@ -394,9 +1760,7 @@ declare class CanvasClient {
                             value: unknown;
                             type: string;
                             binding?: {
-                                pointer: string | {
-                                    [key: string]: string;
-                                };
+                                pointer: string;
                                 syntax: "jptr";
                                 required?: boolean | undefined;
                             } | undefined;
@@ -408,35 +1772,49 @@ declare class CanvasClient {
                     } | undefined;
                     _id?: string | undefined;
                     _pattern?: string | undefined;
+                    _data?: {
+                        [key: string]: {
+                            type: string;
+                            isPatternParameter?: boolean | undefined;
+                            variables?: {
+                                [key: string]: string;
+                            } | undefined;
+                        };
+                    } | undefined;
+                    _patternData?: {
+                        [key: string]: {
+                            type: string;
+                            isPatternParameter?: boolean | undefined;
+                            variables?: {
+                                [key: string]: string;
+                            } | undefined;
+                        };
+                    } | undefined;
                     _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
                 }[];
             } | undefined;
             _id: string;
             _slug?: string | null | undefined;
             _name: string;
+            _data?: {
+                [key: string]: {
+                    type: string;
+                    isPatternParameter?: boolean | undefined;
+                    variables?: {
+                        [key: string]: string;
+                    } | undefined;
+                };
+            } | undefined;
         };
-        variables?: {
-            [key: string]: {
-                required: boolean;
-                default: string;
-            };
-        } | undefined;
     }>;
     /** Fetches a Canvas composition by its public UUID */
-    getCompositionById(options: Pick<CompositionGetParameters, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs'>): Promise<{
+    getCompositionById(options: Pick<CompositionGetParameters, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus'>): Promise<{
         state: number;
+        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
         projectId: string;
         created: string;
         modified: string;
         pattern: boolean;
-        resources?: {
-            [key: string]: {
-                type: string;
-                data: {
-                    [key: string]: unknown;
-                };
-            };
-        } | undefined;
         composition: {
             type: string;
             parameters?: {
@@ -444,9 +1822,7 @@ declare class CanvasClient {
                     value: unknown;
                     type: string;
                     binding?: {
-                        pointer: string | {
-                            [key: string]: string;
-                        };
+                        pointer: string;
                         syntax: "jptr";
                         required?: boolean | undefined;
                     } | undefined;
@@ -461,9 +1837,7 @@ declare class CanvasClient {
                             value: unknown;
                             type: string;
                             binding?: {
-                                pointer: string | {
-                                    [key: string]: string;
-                                };
+                                pointer: string;
                                 syntax: "jptr";
                                 required?: boolean | undefined;
                             } | undefined;
@@ -475,19 +1849,40 @@ declare class CanvasClient {
                     } | undefined;
                     _id?: string | undefined;
                     _pattern?: string | undefined;
+                    _data?: {
+                        [key: string]: {
+                            type: string;
+                            isPatternParameter?: boolean | undefined;
+                            variables?: {
+                                [key: string]: string;
+                            } | undefined;
+                        };
+                    } | undefined;
+                    _patternData?: {
+                        [key: string]: {
+                            type: string;
+                            isPatternParameter?: boolean | undefined;
+                            variables?: {
+                                [key: string]: string;
+                            } | undefined;
+                        };
+                    } | undefined;
                     _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
                 }[];
             } | undefined;
             _id: string;
             _slug?: string | null | undefined;
             _name: string;
+            _data?: {
+                [key: string]: {
+                    type: string;
+                    isPatternParameter?: boolean | undefined;
+                    variables?: {
+                        [key: string]: string;
+                    } | undefined;
+                };
+            } | undefined;
         };
-        variables?: {
-            [key: string]: {
-                required: boolean;
-                default: string;
-            };
-        } | undefined;
     }>;
     /** Updates or creates a Canvas component definition */
     updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
@@ -511,7 +1906,7 @@ declare class CanvasClient {
             useTeamPermissions?: boolean | undefined;
             permissions?: {
                 roleId: string;
-                permission: "read" | "write" | "delete";
+                permission: "read" | "write" | "create" | "delete";
                 state: number;
             }[] | undefined;
             slots?: {
@@ -524,7 +1919,7 @@ declare class CanvasClient {
             }[] | undefined;
             slugSettings?: {
                 required?: "no" | "yes" | "disabled" | undefined;
-                unique?: "no" | "local" | "global" | undefined;
+                unique?: "global" | "no" | "local" | undefined;
                 regularExpression?: string | undefined;
                 regularExpressionMessage?: string | undefined;
             } | undefined;
@@ -535,9 +1930,7 @@ declare class CanvasClient {
                         value: unknown;
                         type: string;
                         binding?: {
-                            pointer: string | {
-                                [key: string]: string;
-                            };
+                            pointer: string;
                             syntax: "jptr";
                             required?: boolean | undefined;
                         } | undefined;
@@ -549,6 +1942,24 @@ declare class CanvasClient {
                 } | undefined;
                 _id?: string | undefined;
                 _pattern?: string | undefined;
+                _data?: {
+                    [key: string]: {
+                        type: string;
+                        isPatternParameter?: boolean | undefined;
+                        variables?: {
+                            [key: string]: string;
+                        } | undefined;
+                    };
+                } | undefined;
+                _patternData?: {
+                    [key: string]: {
+                        type: string;
+                        isPatternParameter?: boolean | undefined;
+                        variables?: {
+                            [key: string]: string;
+                        } | undefined;
+                    };
+                } | undefined;
                 _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
             } | null | undefined;
             variants?: {
@@ -563,12 +1974,69 @@ declare class CanvasClient {
     updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
     /** Deletes a Canvas component definition */
     removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
-    private apiClient;
-    private createUrl;
-    private static getRequestId;
 }
 declare class UncachedCanvasClient extends CanvasClient {
-    constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
+    constructor(options: Omit<ClientOptions, 'bypassCache'>);
+}
+
+/**
+ * @deprecated
+ */
+declare class CanvasDataConnectionClient extends ApiClient {
+    constructor(options: ClientOptions);
+    /** Fetches all DataConnections for a project */
+    get(options?: ExceptProject<DataConnectionGetParameters>): Promise<{
+        result: {
+            id: string;
+            displayName: string;
+            connectorType: string;
+            baseUrl: string;
+            headers?: {
+                [key: string]: string;
+            } | undefined;
+            parameters?: {
+                [key: string]: string;
+            } | undefined;
+            variables?: {
+                [key: string]: {
+                    displayName?: string | undefined;
+                    type: string;
+                    default: string;
+                    setBy: "static" | "dynamic";
+                };
+            } | undefined;
+            custom?: {
+                [key: string]: unknown;
+            } | undefined;
+        };
+    }>;
+    /** Fetches all DataConnections for a project */
+    getList(options?: ExceptProject<DataConnectionsGetParameters>): Promise<{
+        results: {
+            id: string;
+            displayName: string;
+            connectorType: string;
+            baseUrl?: string | undefined;
+        }[];
+    }>;
+    /** Updates or creates (based on id) a DataConnection */
+    upsert(body: ExceptProject<DataConnectionPutParameters>): Promise<void>;
+    /** Deletes a DataConnection */
+    remove(body: ExceptProject<DataConnectionDeleteParameters>): Promise<void>;
+}
+
+/**
+ * @deprecated
+ */
+declare class CanvasDataTypeClient extends ApiClient {
+    #private;
+    constructor(options: ClientOptions);
+    /** Fetches all DataTypes for a project */
+    get(options?: ExceptProject<DataTypeGetParameters>): Promise<DataTypeGetResponse>;
+    /** Updates or creates (based on id) a DataType */
+    upsert(body: ExceptProject<DataTypePutParameters>): Promise<void>;
+    /** Deletes a DataType */
+    remove(body: ExceptProject<DataTypeDeleteParameters>): Promise<void>;
 }
 
 /** Public ID of Canvas personalization component type */
@@ -597,6 +2065,8 @@ declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
 declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
 declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
+/** The name of the query string used to detect if we are in in-context editing mode */
+declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 
 /** Determines if a given Canvas component type is a system-defined type */
 declare const isSystemComponentDefinition: (componentType: string) => boolean;
@@ -613,6 +2083,11 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
  */
 declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
 
+declare const generateHash: ({ composition, secret, }: {
+    composition: RootComponentInstance;
+    secret: string | undefined;
+}) => number | undefined;
+
 declare function getChannelName(projectId: string, compositionId: string, state: number): string;
 
 declare type EventNames = 'updated';
@@ -640,4 +2115,126 @@ declare function localize({ composition, locale, }: {
     }) => string | undefined);
 }): void;
 
-export { BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasClientOptions, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, LimitPolicy, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, WalkComponentTreeActions, compose, createBatchEnhancer, createLimitPolicy, enhance, extractLocales, getChannelName, getComponentPath, isSystemComponentDefinition, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+declare type SelectComponentMessage = {
+    type: 'select-component';
+    id: string;
+};
+declare type ReadyMessage = {
+    type: 'ready';
+};
+declare type UpdateCompositionMessage = {
+    type: 'update-composition';
+    composition: RootComponentInstance;
+    hash: number | undefined;
+};
+declare type AddComponentMessage = {
+    type: 'add-component';
+    componentId: string;
+    slotName: string;
+    index: number;
+};
+declare type MoveComponentMessage = {
+    type: 'move-component';
+    componentId: string;
+    slotName: string;
+    index: number;
+};
+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 type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage;
+declare type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
+declare type Channel = {
+    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: {
+        componentId: string;
+        slotName: string;
+        index: number;
+    }) => void;
+    moveComponent: (options: {
+        componentId: string;
+        slotName: string;
+        index: number;
+    }) => void;
+};
+declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
+    listenTo: Window[];
+    broadcastTo: Window[];
+}) => Channel;
+
+declare type CompositionIssue = CompositionPatternIssue | CompositionDataIssue | CompositionBindingIssue;
+declare type CompositionIssueCore = {
+    componentPath: string;
+    componentType: string;
+    message: string;
+};
+declare type CompositionPatternIssue = CompositionIssueCore & {
+    type: 'pattern';
+    code: NonNullable<ComponentInstance['_patternError']>;
+};
+declare type CompositionBindingIssue = CompositionIssueCore & {
+    type: 'binding';
+    parameterName: string;
+};
+declare type CompositionDataIssue = CompositionIssueCore & {
+    type: 'data';
+    dataName: string;
+    dataType: string;
+};
+declare type CompositionDataDiagnostic = {
+    componentPath: string;
+    dataType: string;
+    dataName: string;
+    performance: number;
+    data: unknown;
+};
+declare type CommonCompositionGetParameters = Pick<CompositionGetParameters, 'state' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus'> & {
+    /**
+     * Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
+     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     */
+    dataDiagnostics?: boolean;
+    /**
+     * Pass dynamic variables to the composition that are required for resolving bindings and datas,
+     * such as language, detail page ID, etc.
+     */
+    dynamicVariables?: Record<string, string>;
+};
+/** @deprecated do not use */
+declare type EdgeCompositionGetResponse = CompositionGetResponse & {
+    /**
+     * Copies of resolved data and how long it took to resolve each data.
+     * Only set when dataDiagnostics=true is passed to the options.
+     */
+    dataDiagnostics?: Array<CompositionDataDiagnostic>;
+    /**
+     * Any failures to bind to data that occured on bindings marked 'must exist'.
+     * If no failures occurred, this will be undefined.
+     * NOTE: No exception will be thrown if this type of error occurs. You must inspect this property if you care to cause client errors.
+     */
+    errors?: Array<CompositionIssue>;
+    /**
+     * Any failures to bind to data that occurred on optional bindings. In most cases, these are only informational (i.e. data is bound to a property that does not always exist)
+     * If no failures occurred, this will be undefined.
+     */
+    warnings?: Array<CompositionIssue>;
+};
+/** @deprecated do not use */
+declare class EdgeCanvasClient extends ApiClient<ClientOptions> {
+    constructor(options: ClientOptions);
+    private canvasUrl;
+    /** Fetches a Canvas composition by string name (slug) */
+    getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug'> & CommonCompositionGetParameters): Promise<EdgeCompositionGetResponse>;
+    /** Fetches a Canvas composition by its public UUID */
+    getCompositionById(options: Pick<CompositionGetParameters, 'compositionId'> & CommonCompositionGetParameters): Promise<EdgeCompositionGetResponse>;
+}
+
+declare const CanvasClientError: typeof ApiClientError;
+
+export { AddComponentMessage, BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDataConnectionClient, CanvasDataTypeClient, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionBindingIssue, CompositionDataDiagnostic, CompositionDataIssue, CompositionIssue, CompositionPatternIssue, DataConnection, DataConnectionDeleteParameters, DataConnectionGetParameters, DataConnectionGetResponse, DataConnectionInfo, DataConnectionPutParameters, DataConnectionsGetParameters, DataConnectionsGetResponse, DataType, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariable, EdgeCanvasClient, EdgeCompositionGetResponse, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, LimitPolicy, MessageHandler, MoveComponentMessage, ReadyMessage, SelectComponentMessage, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createLimitPolicy, enhance, extractLocales, generateHash, getChannelName, getComponentPath, isAddComponentMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };