@uniformdev/canvas 17.1.1-alpha.152 → 17.2.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-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, P as PreviewEventBus } from './createEventBus-b9cdb6ff.js';
-export { H as CanvasDefinitions, I as ChannelSubscription, s as ComponentDefinition, l as ComponentDefinitionAPIDeleteRequest, k as ComponentDefinitionAPIPutRequest, j as ComponentDefinitionAPIResponse, h as ComponentDefinitionDeleteParameters, f as ComponentDefinitionGetParameters, i as ComponentDefinitionGetResponse, m as ComponentDefinitionListAPIOptions, n as ComponentDefinitionParameter, r as ComponentDefinitionPermission, g as ComponentDefinitionPutParameters, q as ComponentDefinitionSlot, p as ComponentDefinitionSlugSettings, o 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, u as CompositionGetOrderBy, b as CompositionGetParameters, v as CompositionGetResponse, A as CompositionListAPIResponse, d as CompositionPutParameters, w as CompositionUIStatus, t as CreatingComponentDefinition, P as PreviewEventBus, R as RootComponentInstance, J as createEventBus } from './createEventBus-b9cdb6ff.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-3f3f7633.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-3f3f7633.js';
 import { Options } from 'p-throttle';
 import { Options as Options$1 } from 'p-retry';
-import { ClientOptions, ApiClient, ExceptProject, ApiClientError } from '@uniformdev/context/api';
+import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
 export { ApiClientError } from '@uniformdev/context/api';
 import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
 import 'pusher-js';
@@ -273,11 +273,11 @@ interface external$2 {
                     roleId: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
                     /**
                      * @description Permission type for this permission ComponentDefinition:
-                     * read | write | delete
+                     * read | write | create | delete
                      *
                      * @enum {string}
                      */
-                    permission: "read" | "write" | "delete";
+                    permission: "read" | "write" | "create" | "delete";
                     /** @description State of the component that this permission applies to */
                     state: number;
                 };
@@ -429,23 +429,23 @@ interface external$2 {
                  * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
                  */
                 DataConnection: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data connection */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @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 connector. No trailing slash. */
+                    /** @description Base resource URL of the data connection. No trailing slash. */
                     baseUrl: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @description Variables needed to make calls to the data connection */
                     variables?: {
                         [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -459,11 +459,11 @@ interface external$2 {
                  * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
                  */
                 DataType: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data type */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data type */
                     displayName: string;
-                    /** @description Public ID of the associated data connector */
+                    /** @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
@@ -471,25 +471,26 @@ interface external$2 {
                      * no special UI or processing is required.
                      */
                     archetype?: string;
+                    allowedOnComponents?: string[];
                     /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
                     path: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @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 connector.
+                     * @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 connector */
+                    /** @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"];
                     };
@@ -741,11 +742,11 @@ interface external$1 {
                     roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
                     /**
                      * @description Permission type for this permission ComponentDefinition:
-                     * read | write | delete
+                     * read | write | create | delete
                      *
                      * @enum {string}
                      */
-                    permission: "read" | "write" | "delete";
+                    permission: "read" | "write" | "create" | "delete";
                     /** @description State of the component that this permission applies to */
                     state: number;
                 };
@@ -897,23 +898,23 @@ interface external$1 {
                  * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
                  */
                 DataConnection: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data connection */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @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 connector. No trailing slash. */
+                    /** @description Base resource URL of the data connection. No trailing slash. */
                     baseUrl: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @description Variables needed to make calls to the data connection */
                     variables?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -927,11 +928,11 @@ interface external$1 {
                  * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
                  */
                 DataType: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data type */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data type */
                     displayName: string;
-                    /** @description Public ID of the associated data connector */
+                    /** @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
@@ -939,25 +940,26 @@ interface external$1 {
                      * no special UI or processing is required.
                      */
                     archetype?: string;
+                    allowedOnComponents?: string[];
                     /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
                     path: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @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 connector.
+                     * @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 connector */
+                    /** @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"];
                     };
@@ -1166,11 +1168,11 @@ interface external {
                     roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
                     /**
                      * @description Permission type for this permission ComponentDefinition:
-                     * read | write | delete
+                     * read | write | create | delete
                      *
                      * @enum {string}
                      */
-                    permission: "read" | "write" | "delete";
+                    permission: "read" | "write" | "create" | "delete";
                     /** @description State of the component that this permission applies to */
                     state: number;
                 };
@@ -1322,23 +1324,23 @@ interface external {
                  * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
                  */
                 DataConnection: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data connection */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @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 connector. No trailing slash. */
+                    /** @description Base resource URL of the data connection. No trailing slash. */
                     baseUrl: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @description Variables needed to make calls to the data connection */
                     variables?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -1352,11 +1354,11 @@ interface external {
                  * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
                  */
                 DataType: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data type */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data type */
                     displayName: string;
-                    /** @description Public ID of the associated data connector */
+                    /** @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
@@ -1364,25 +1366,26 @@ interface external {
                      * no special UI or processing is required.
                      */
                     archetype?: string;
+                    allowedOnComponents?: string[];
                     /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
                     path: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @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 connector */
+                    /** @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 connector */
+                    /** @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 connector.
+                     * @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 connector */
+                    /** @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"];
                     };
@@ -1476,7 +1479,7 @@ declare type ComponentLocationReference = {
     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 */
@@ -1485,9 +1488,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. */
@@ -1640,15 +1651,11 @@ declare function createLimitPolicy({ throttle, retry, }: {
 }): LimitPolicy;
 declare const nullLimitPolicy: LimitPolicy;
 
-declare type CanvasClientOptions = ClientOptions & {
-    /** @deprecated do not use */
-    experiment14?: boolean;
-};
-declare class CanvasClient extends ApiClient<CanvasClientOptions> {
-    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' | 'compositionId'>): Promise<{
+    getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
         compositions: {
             state: number;
             uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
@@ -1902,7 +1909,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
             useTeamPermissions?: boolean | undefined;
             permissions?: {
                 roleId: string;
-                permission: "read" | "write" | "delete";
+                permission: "read" | "write" | "create" | "delete";
                 state: number;
             }[] | undefined;
             slots?: {
@@ -1972,7 +1979,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
     removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
 }
 declare class UncachedCanvasClient extends CanvasClient {
-    constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
+    constructor(options: Omit<ClientOptions, 'bypassCache'>);
 }
 
 /**
@@ -2061,6 +2068,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;
@@ -2077,6 +2086,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';
@@ -2104,6 +2118,136 @@ declare function localize({ composition, locale, }: {
     }) => string | undefined);
 }): void;
 
-declare type CanvasClientError = ApiClientError;
+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;
+
+/** Types of issue that can occur when fetching composition data */
+declare type CompositionIssue = CompositionPatternIssue | CompositionDataIssue | CompositionBindingIssue | CompositionVariableIssue;
+declare type CompositionIssueCore = {
+    componentPath: string;
+    componentType: string;
+    message: string;
+};
+/** An error that occured resolving a pattern that is referenced on the composition */
+declare type CompositionPatternIssue = CompositionIssueCore & {
+    type: 'pattern';
+    code: NonNullable<ComponentInstance['_patternError']>;
+};
+/** An error while binding a piece of data to a component parameter */
+declare type CompositionBindingIssue = CompositionIssueCore & {
+    type: 'binding';
+    parameterName: string;
+};
+/** An error that occurred fetching a data defined on the composition or a pattern within */
+declare type CompositionDataIssue = CompositionIssueCore & {
+    type: 'data';
+    dataName: string;
+    dataType: string;
+};
+/** An issue that occurred while binding dynamic variables to composition data types */
+declare type CompositionVariableIssue = CompositionIssueCore & {
+    type: 'variable';
+    variableName: string;
+};
+/** Diagnostic data about the load performance of attached composition datas */
+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 { 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, CanvasDataConnectionClient, CanvasDataTypeClient, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, DataConnection, DataConnectionDeleteParameters, DataConnectionGetParameters, DataConnectionGetResponse, DataConnectionInfo, DataConnectionPutParameters, DataConnectionsGetParameters, DataConnectionsGetResponse, DataType, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariable, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, LimitPolicy, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, WalkComponentTreeActions, compose, createBatchEnhancer, createLimitPolicy, enhance, extractLocales, getChannelName, getComponentPath, isSystemComponentDefinition, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+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, CompositionVariableIssue, 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 };

package/dist/index.esm.js

@@ -1 +1 @@
-import{A as p,B as q,C as r,D as s,E as t,F as u,G as v,H as w,I as x,J as y,K as z,L as A,M as B,N as C,O as D,P as E,Q as F,R as G,S as H,T as I,U as J,l as a,m as b,n as c,o as d,p as e,q as f,r as g,s as h,t as i,u as j,v as k,w as l,x as m,y as n,z as o}from"./chunk-PFL3XEAQ.mjs";export{f as BatchEntry,x as CANVAS_DRAFT_STATE,B as CANVAS_ENRICHMENT_TAG_PARAM,s as CANVAS_INTENT_TAG_PARAM,t as CANVAS_LOCALE_TAG_PARAM,w as CANVAS_LOCALIZATION_SLOT,r as CANVAS_LOCALIZATION_TYPE,z as CANVAS_PERSONALIZATION_PARAM,u as CANVAS_PERSONALIZE_SLOT,p as CANVAS_PERSONALIZE_TYPE,y as CANVAS_PUBLISHED_STATE,v as CANVAS_TEST_SLOT,q as CANVAS_TEST_TYPE,A as CANVAS_TEST_VARIANT_PARAM,l as CanvasClient,n as CanvasDataConnectionClient,o as CanvasDataTypeClient,d as ChildEnhancerBuilder,e as EnhancerBuilder,m as UncachedCanvasClient,c as UniqueBatchEntries,k as compose,g as createBatchEnhancer,F as createEventBus,h as createLimitPolicy,j as enhance,I as extractLocales,G as getChannelName,b as getComponentPath,C as isSystemComponentDefinition,J as localize,D as mapSlotToPersonalizedVariations,E as mapSlotToTestVariations,i as nullLimitPolicy,H as subscribeToComposition,a as walkComponentTree};
+import{$ as Q,A as p,B as q,C as r,D as s,E as t,F as u,G as v,H as w,I as x,J as y,K as z,L as A,M as B,N as C,O as D,P as E,Q as F,R as G,S as H,T as I,U as J,V as K,W as L,X as M,Y as N,Z as O,_ as P,aa as R,ba as S,ca as T,da as U,l as a,m as b,n as c,o as d,p as e,q as f,r as g,s as h,t as i,u as j,v as k,w as l,x as m,y as n,z as o}from"./chunk-IQWDQAHE.mjs";export{T as ApiClientError,f as BatchEntry,x as CANVAS_DRAFT_STATE,B as CANVAS_ENRICHMENT_TAG_PARAM,s as CANVAS_INTENT_TAG_PARAM,t as CANVAS_LOCALE_TAG_PARAM,w as CANVAS_LOCALIZATION_SLOT,r as CANVAS_LOCALIZATION_TYPE,z as CANVAS_PERSONALIZATION_PARAM,u as CANVAS_PERSONALIZE_SLOT,p as CANVAS_PERSONALIZE_TYPE,y as CANVAS_PUBLISHED_STATE,v as CANVAS_TEST_SLOT,q as CANVAS_TEST_TYPE,A as CANVAS_TEST_VARIANT_PARAM,l as CanvasClient,U as CanvasClientError,n as CanvasDataConnectionClient,o as CanvasDataTypeClient,d as ChildEnhancerBuilder,S as EdgeCanvasClient,e as EnhancerBuilder,C as IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,m as UncachedCanvasClient,c as UniqueBatchEntries,k as compose,g as createBatchEnhancer,R as createCanvasChannel,H as createEventBus,h as createLimitPolicy,j as enhance,K as extractLocales,G as generateHash,I as getChannelName,b as getComponentPath,P as isAddComponentMessage,Q as isMovingComponentMessage,N as isReadyMessage,M as isSelectComponentMessage,D as isSystemComponentDefinition,O as isUpdateCompositionMessage,L as localize,E as mapSlotToPersonalizedVariations,F as mapSlotToTestVariations,i as nullLimitPolicy,J as subscribeToComposition,a as walkComponentTree};