@uniformdev/canvas 17.3.1-alpha.194 → 17.4.1-alpha.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-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, D as DataSourceGetParameters, h as DataSourcesGetParameters, i as DataSourcePutParameters, j as DataSourceDeleteParameters, k as DataTypeGetParameters, l as DataTypeGetResponse, m as DataTypePutParameters, n as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus, o as CompositionGetResponse } from './createEventBus-33bac5ac.js';
-export { O as CanvasDefinitions, X as ChannelSubscription, z as ComponentDefinition, s as ComponentDefinitionAPIDeleteRequest, r as ComponentDefinitionAPIPutRequest, q as ComponentDefinitionAPIResponse, g as ComponentDefinitionDeleteParameters, e as ComponentDefinitionGetParameters, p as ComponentDefinitionGetResponse, t as ComponentDefinitionListAPIOptions, u as ComponentDefinitionParameter, y as ComponentDefinitionPermission, f as ComponentDefinitionPutParameters, x as ComponentDefinitionSlot, w as ComponentDefinitionSlugSettings, v as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, H as CompositionAPIDeleteRequest, J as CompositionAPIOptions, G as CompositionAPIResponse, d as CompositionDeleteParameters, F as CompositionGetListResponse, B as CompositionGetOrderBy, b as CompositionGetParameters, o as CompositionGetResponse, I as CompositionListAPIResponse, c as CompositionPutParameters, E as CompositionUIStatus, A as CreatingComponentDefinition, K as DataElementConnectionDefinition, N as DataResourceDefinition, M as DataResourceDefinitions, L as DataResourceVariables, U as DataSource, j as DataSourceDeleteParameters, D as DataSourceGetParameters, Q as DataSourceGetResponse, V as DataSourceInfo, i as DataSourcePutParameters, h as DataSourcesGetParameters, S as DataSourcesGetResponse, T as DataType, n as DataTypeDeleteParameters, k as DataTypeGetParameters, l as DataTypeGetResponse, m as DataTypePutParameters, W as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, Y as createEventBus } from './createEventBus-33bac5ac.js';
+import { C as ComponentInstance, a as ComponentParameter, b as CompositionGetParameters, c as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, d as CompositionGetResponse, e as DataResolutionOptionPositive, f as DataResolutionParameters, g as CompositionResolvedGetResponse, h as CompositionGetValidResponses, i as DataResolutionOption, j as CompositionGetByNodeIdParameters, k as CompositionGetBySlugParameters, l as CompositionGetByIdParameters, m as CompositionPutParameters, n as CompositionDeleteParameters, o as ComponentDefinitionGetParameters, p as ComponentDefinitionPutParameters, q as ComponentDefinitionDeleteParameters, r as DataSourceGetParameters, s as DataSourcesGetParameters, t as DataSourcePutParameters, u as DataSourceDeleteParameters, v as DataTypeGetParameters, w as DataTypeGetResponse, x as DataTypePutParameters, y as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus } from './createEventBus-f298dcef.js';
+export { _ as CanvasDefinitions, ab as ChannelSubscription, L as ComponentDefinition, E as ComponentDefinitionAPIDeleteRequest, B as ComponentDefinitionAPIPutRequest, A as ComponentDefinitionAPIResponse, q as ComponentDefinitionDeleteParameters, o as ComponentDefinitionGetParameters, z as ComponentDefinitionGetResponse, F as ComponentDefinitionListAPIOptions, G as ComponentDefinitionParameter, K as ComponentDefinitionPermission, p as ComponentDefinitionPutParameters, J as ComponentDefinitionSlot, I as ComponentDefinitionSlugSettings, H as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, T as CompositionAPIDeleteRequest, V as CompositionAPIOptions, S as CompositionAPIResponse, a4 as CompositionDataDiagnostic, n as CompositionDeleteParameters, l as CompositionGetByIdParameters, j as CompositionGetByNodeIdParameters, c as CompositionGetByNodePathParameters, k as CompositionGetBySlugParameters, Q as CompositionGetListResponse, N as CompositionGetOrderBy, b as CompositionGetParameters, d as CompositionGetResponse, h as CompositionGetValidResponses, $ as CompositionIssue, U as CompositionListAPIResponse, a0 as CompositionPatternIssue, m as CompositionPutParameters, g as CompositionResolvedGetResponse, O as CompositionUIStatus, M as CreatingComponentDefinition, a1 as DataElementBindingIssue, W as DataElementConnectionDefinition, i as DataResolutionOption, D as DataResolutionOptionNegative, e as DataResolutionOptionPositive, f as DataResolutionParameters, Z as DataResourceDefinition, Y as DataResourceDefinitions, a2 as DataResourceIssue, a3 as DataResourceVariableIssue, X as DataResourceVariables, a8 as DataSource, u as DataSourceDeleteParameters, r as DataSourceGetParameters, a5 as DataSourceGetResponse, a9 as DataSourceInfo, t as DataSourcePutParameters, s as DataSourcesGetParameters, a6 as DataSourcesGetResponse, a7 as DataType, y as DataTypeDeleteParameters, v as DataTypeGetParameters, w as DataTypeGetResponse, x as DataTypePutParameters, aa as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, ac as createEventBus } from './createEventBus-f298dcef.js';
 import { Options } from 'p-throttle';
 import { Options as Options$1 } from 'p-retry';
 import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
@@ -111,6 +111,10 @@ declare function walkComponentTree<TContext = unknown>(component: ComponentInsta
 /** Traversal context for this node */
 currentContext: TContext | undefined) => void, initialContext?: TContext): void;
 declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
+/** Returns the JSON pointer of a component based on its location */
+declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocationReference>, { withSlots }?: {
+    withSlots?: boolean | undefined;
+}): string;
 
 /** A single entry in a batch of queued enhancements. */
 declare class BatchEntry<TArgs, TResult> {
@@ -345,312 +349,23 @@ declare class CanvasClient extends ApiClient<ClientOptions> {
         }[];
         totalCount?: number | undefined;
     }>;
-    getCompositionBySitemapNodePath(options: Pick<CompositionGetParameters, 'sitemapNodePath' | 'sitemapId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
-        state: number;
-        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
-        projectId: string;
-        created: string;
-        modified: string;
-        pattern: boolean;
-        composition: {
-            type: string;
-            parameters?: {
-                [key: string]: {
-                    value: unknown;
-                    type: string;
-                    connectedData?: {
-                        pointer: string;
-                        syntax: "jptr";
-                        required?: boolean | undefined;
-                    } | undefined;
-                };
-            } | undefined;
-            variant?: string | undefined;
-            slots?: {
-                [key: string]: {
-                    type: string;
-                    parameters?: {
-                        [key: string]: {
-                            value: unknown;
-                            type: string;
-                            connectedData?: {
-                                pointer: string;
-                                syntax: "jptr";
-                                required?: boolean | undefined;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    variant?: string | undefined;
-                    slots?: {
-                        [key: string]: any[];
-                    } | undefined;
-                    _id?: string | undefined;
-                    _pattern?: string | undefined;
-                    _dataResources?: {
-                        [key: string]: {
-                            type: string;
-                            isPatternParameter?: boolean | undefined;
-                            variables?: {
-                                [key: string]: string;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    _patternDataResources?: {
-                        [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;
-            _dataResources?: {
-                [key: string]: {
-                    type: string;
-                    isPatternParameter?: boolean | undefined;
-                    variables?: {
-                        [key: string]: string;
-                    } | undefined;
-                };
-            } | undefined;
-        };
-    }>;
-    getCompositionBySitemapNodeId(options: Pick<CompositionGetParameters, 'sitemapNodeId' | 'sitemapId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
-        state: number;
-        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
-        projectId: string;
-        created: string;
-        modified: string;
-        pattern: boolean;
-        composition: {
-            type: string;
-            parameters?: {
-                [key: string]: {
-                    value: unknown;
-                    type: string;
-                    connectedData?: {
-                        pointer: string;
-                        syntax: "jptr";
-                        required?: boolean | undefined;
-                    } | undefined;
-                };
-            } | undefined;
-            variant?: string | undefined;
-            slots?: {
-                [key: string]: {
-                    type: string;
-                    parameters?: {
-                        [key: string]: {
-                            value: unknown;
-                            type: string;
-                            connectedData?: {
-                                pointer: string;
-                                syntax: "jptr";
-                                required?: boolean | undefined;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    variant?: string | undefined;
-                    slots?: {
-                        [key: string]: any[];
-                    } | undefined;
-                    _id?: string | undefined;
-                    _pattern?: string | undefined;
-                    _dataResources?: {
-                        [key: string]: {
-                            type: string;
-                            isPatternParameter?: boolean | undefined;
-                            variables?: {
-                                [key: string]: string;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    _patternDataResources?: {
-                        [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;
-            _dataResources?: {
-                [key: string]: {
-                    type: string;
-                    isPatternParameter?: boolean | undefined;
-                    variables?: {
-                        [key: string]: string;
-                    } | undefined;
-                };
-            } | undefined;
-        };
-    }>;
-    /** Fetches a Canvas composition by string name (slug) */
-    getCompositionBySlug(options: Pick<CompositionGetParameters, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
-        state: number;
-        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
-        projectId: string;
-        created: string;
-        modified: string;
-        pattern: boolean;
-        composition: {
-            type: string;
-            parameters?: {
-                [key: string]: {
-                    value: unknown;
-                    type: string;
-                    connectedData?: {
-                        pointer: string;
-                        syntax: "jptr";
-                        required?: boolean | undefined;
-                    } | undefined;
-                };
-            } | undefined;
-            variant?: string | undefined;
-            slots?: {
-                [key: string]: {
-                    type: string;
-                    parameters?: {
-                        [key: string]: {
-                            value: unknown;
-                            type: string;
-                            connectedData?: {
-                                pointer: string;
-                                syntax: "jptr";
-                                required?: boolean | undefined;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    variant?: string | undefined;
-                    slots?: {
-                        [key: string]: any[];
-                    } | undefined;
-                    _id?: string | undefined;
-                    _pattern?: string | undefined;
-                    _dataResources?: {
-                        [key: string]: {
-                            type: string;
-                            isPatternParameter?: boolean | undefined;
-                            variables?: {
-                                [key: string]: string;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    _patternDataResources?: {
-                        [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;
-            _dataResources?: {
-                [key: string]: {
-                    type: string;
-                    isPatternParameter?: boolean | undefined;
-                    variables?: {
-                        [key: string]: string;
-                    } | undefined;
-                };
-            } | undefined;
-        };
-    }>;
-    /** Fetches a Canvas composition by its public UUID */
-    getCompositionById(options: Pick<CompositionGetParameters, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>): Promise<{
-        state: number;
-        uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
-        projectId: string;
-        created: string;
-        modified: string;
-        pattern: boolean;
-        composition: {
-            type: string;
-            parameters?: {
-                [key: string]: {
-                    value: unknown;
-                    type: string;
-                    connectedData?: {
-                        pointer: string;
-                        syntax: "jptr";
-                        required?: boolean | undefined;
-                    } | undefined;
-                };
-            } | undefined;
-            variant?: string | undefined;
-            slots?: {
-                [key: string]: {
-                    type: string;
-                    parameters?: {
-                        [key: string]: {
-                            value: unknown;
-                            type: string;
-                            connectedData?: {
-                                pointer: string;
-                                syntax: "jptr";
-                                required?: boolean | undefined;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    variant?: string | undefined;
-                    slots?: {
-                        [key: string]: any[];
-                    } | undefined;
-                    _id?: string | undefined;
-                    _pattern?: string | undefined;
-                    _dataResources?: {
-                        [key: string]: {
-                            type: string;
-                            isPatternParameter?: boolean | undefined;
-                            variables?: {
-                                [key: string]: string;
-                            } | undefined;
-                        };
-                    } | undefined;
-                    _patternDataResources?: {
-                        [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;
-            _dataResources?: {
-                [key: string]: {
-                    type: string;
-                    isPatternParameter?: boolean | undefined;
-                    variables?: {
-                        [key: string]: string;
-                    } | undefined;
-                };
-            } | undefined;
-        };
-    }>;
+    /** Fetches one composition by its project map node path */
+    getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
+    getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
+    getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    /** Fetches one composition by its project map node ID */
+    getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
+    getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
+    getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    /** Fetches one composition by its slug */
+    getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
+    getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
+    getCompositionBySlug<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetBySlugParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    /** Fetches one composition by its ID */
+    getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
+    getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
+    getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
+    private getOneComposition;
     /** Updates or creates a Canvas component definition */
     updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
     /** Deletes a Canvas component definition */
@@ -664,6 +379,7 @@ declare class CanvasClient extends ApiClient<ClientOptions> {
             titleParameter?: string | null | undefined;
             canBeComposition?: boolean | undefined;
             parameters?: {
+                /** Updates or creates a Canvas component definition */
                 id: string;
                 name: string;
                 helpText?: string | undefined;
@@ -776,6 +492,7 @@ declare class DataSourceClient extends ApiClient {
                     type: string;
                     default: string;
                     setBy: "static" | "dynamic";
+                    order?: number | undefined;
                 };
             } | undefined;
             custom?: {
@@ -840,6 +557,8 @@ declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 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";
+/** The name of the query string used to detect if we are in in-context editing mode */
+declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
 
 /** Determines if a given Canvas component type is a system-defined type */
 declare const isSystemComponentDefinition: (componentType: string) => boolean;
@@ -902,7 +621,7 @@ declare type UpdateCompositionMessage = {
 };
 declare type AddComponentMessage = {
     type: 'add-component';
-    componentId: string;
+    parentId: string;
     slotName: string;
     index: number;
 };
@@ -912,12 +631,18 @@ declare type MoveComponentMessage = {
     slotName: string;
     index: number;
 };
+declare type DismissPlaceholderMessage = {
+    type: 'dismiss-placeholder';
+    parentId: string;
+    slotName: string;
+};
+declare type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
 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 const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
 declare type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
 declare type Channel = {
     ready: () => void;
@@ -925,99 +650,15 @@ declare type Channel = {
     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;
+    addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
+    moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
+    dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => 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 | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue;
-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 data element from a data resource to a component parameter (i.e. a missing property in the data resource) */
-declare type DataElementBindingIssue = CompositionIssueCore & {
-    type: 'binding';
-    parameterName: string;
-};
-/** An error that occurred fetching a data defined on the composition or a pattern within */
-declare type DataResourceIssue = CompositionIssueCore & {
-    type: 'data';
-    dataName: string;
-    dataType: string;
-};
-/** An issue that occurred while binding dynamic variables to composition data resources */
-declare type DataResourceVariableIssue = 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 { 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, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionIssue, CompositionPatternIssue, DataElementBindingIssue, DataResourceIssue, DataResourceVariableIssue, DataSourceClient, DataTypeClient, 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 };
+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, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, DataSourceClient, DataTypeClient, DismissPlaceholderMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, 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, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };

package/dist/index.esm.js

@@ -1 +1 @@
-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-IK3FODEI.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,d as ChildEnhancerBuilder,n as DataSourceClient,o as DataTypeClient,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};
+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,ea as V,fa as W,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-YWIQN37J.mjs";export{V as ApiClientError,g as BatchEntry,y as CANVAS_DRAFT_STATE,C as CANVAS_ENRICHMENT_TAG_PARAM,t as CANVAS_INTENT_TAG_PARAM,u as CANVAS_LOCALE_TAG_PARAM,x as CANVAS_LOCALIZATION_SLOT,s as CANVAS_LOCALIZATION_TYPE,A as CANVAS_PERSONALIZATION_PARAM,v as CANVAS_PERSONALIZE_SLOT,q as CANVAS_PERSONALIZE_TYPE,z as CANVAS_PUBLISHED_STATE,w as CANVAS_TEST_SLOT,r as CANVAS_TEST_TYPE,B as CANVAS_TEST_VARIANT_PARAM,m as CanvasClient,W as CanvasClientError,e as ChildEnhancerBuilder,o as DataSourceClient,p as DataTypeClient,f as EnhancerBuilder,E as IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,D as IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,n as UncachedCanvasClient,d as UniqueBatchEntries,l as compose,h as createBatchEnhancer,U as createCanvasChannel,J as createEventBus,i as createLimitPolicy,k as enhance,M as extractLocales,I as generateHash,K as getChannelName,c as getComponentJsonPointer,b as getComponentPath,R as isAddComponentMessage,T as isDismissPlaceholderMessage,S as isMovingComponentMessage,P as isReadyMessage,O as isSelectComponentMessage,F as isSystemComponentDefinition,Q as isUpdateCompositionMessage,N as localize,G as mapSlotToPersonalizedVariations,H as mapSlotToTestVariations,j as nullLimitPolicy,L as subscribeToComposition,a as walkComponentTree};