@uniformdev/canvas 19.19.0 → 19.20.1-alpha.32

package/dist/index.d.ts

@@ -112,6 +112,8 @@ interface components$4 {
             /**
              * @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.
+             *
+             * @default null
              */
             titleParameter?: string | null;
             /**
@@ -197,7 +199,8 @@ interface components$4 {
             /**
              * @description Unique identifier of the component within the composition.
              * No assumptions should be made about the format of this value other than "it will be unique."
-             * This is not set unless specifically requested via `withComponentIDs` API parameter.
+             * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+             * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
              */
             _id?: string;
             /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -723,6 +726,8 @@ interface external$9 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -808,7 +813,8 @@ interface external$9 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -1345,6 +1351,8 @@ interface external$8 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -1430,7 +1438,8 @@ interface external$8 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -1898,6 +1907,8 @@ interface external$7 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -1983,7 +1994,8 @@ interface external$7 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -2486,6 +2498,8 @@ interface external$6 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -2571,7 +2585,8 @@ interface external$6 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -3460,6 +3475,8 @@ interface external$5 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -3545,7 +3562,8 @@ interface external$5 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -4259,6 +4277,8 @@ interface external$3 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -4344,7 +4364,8 @@ interface external$3 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -5674,6 +5695,8 @@ interface external$2 {
                     /**
                      * @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.
+                     *
+                     * @default null
                      */
                     titleParameter?: string | null;
                     /**
@@ -5759,7 +5782,8 @@ interface external$2 {
                     /**
                      * @description Unique identifier of the component within the composition.
                      * No assumptions should be made about the format of this value other than "it will be unique."
-                     * This is not set unless specifically requested via `withComponentIDs` API parameter.
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
                      */
                     _id?: string;
                     /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -6772,7 +6796,7 @@ type DataResolutionParameters = {
     diagnostics?: boolean;
 };
 /** Types of issue that can occur when fetching composition data */
-type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceInputIssue | DataResolutionConfigIssue | OverrideIssue;
+type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
 type CompositionIssueCore = components$1['schemas']['CompositionIssue'];
 /** An error that occured resolving a pattern that is referenced on the composition */
 type CompositionPatternIssue = CompositionIssueCore & {
@@ -6795,20 +6819,14 @@ type DataResourceIssue = CompositionIssueCore & {
  * An issue that occurred while binding dynamic inputs to composition data resources,
  * specifically when an expected dynamic input did not have a value.
  */
-type DataResourceInputIssue = CompositionIssueCore & {
+type DynamicInputIssue = CompositionIssueCore & {
     type: 'input';
-    inputName: string;
 };
 /** Error in data resolution configuration (internal error) */
 type DataResolutionConfigIssue = {
     message: string;
     type: 'config';
 };
-/** Error in applying component overrides */
-type OverrideIssue = CompositionIssueCore & {
-    message: string;
-    type: 'override';
-};
 /** Diagnostics about edge request processing */
 type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
 /** Diagnostic data about the load performance of attached composition datas */
@@ -7366,6 +7384,18 @@ declare class unstable_CompositionRelationshipClient extends ApiClient<Compositi
 type PreviewPanelSettings = {
     isInteractive: boolean;
 };
+type ContextualEditingComponentReference = {
+    elements: HTMLElement[];
+    id: string;
+    slotName?: string;
+    componentIndex?: number;
+    totalComponents?: number;
+    componentName?: string;
+    componentTitle?: string;
+    parentId?: string;
+    parentType?: string;
+    isLocalized?: boolean;
+};
 
 type EnhancerContext = {
     preview?: boolean;
@@ -7822,12 +7852,18 @@ type UpdatePreviewSettingsMessage = {
     type: 'update-preview-settings';
     settings: PreviewPanelSettings;
 };
+type UpdateContextualEditingStateInternalMessage = {
+    type: 'update-contextual-editing-state-internal';
+    state: {
+        selectedComponentReference?: Omit<ContextualEditingComponentReference, 'elements'>;
+    };
+};
 type ReportRenderedCompositionsMessage = {
     type: 'report-rendered-compositions';
     compositionIds: string[];
     url: string;
 };
-type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | DismissPlaceholderMessage;
+type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | 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;
@@ -7838,6 +7874,7 @@ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => me
 declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
 declare const isTriggerCompositionActionMessage: (message: ChannelMessage) => message is TriggerCompositionActionMessage;
 declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
+declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
 declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
 type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
 type Channel = {
@@ -7853,6 +7890,7 @@ type Channel = {
     dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
     triggerCompositionAction: (options: Omit<TriggerCompositionActionMessage, 'type'>) => void;
     updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
+    updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
     reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
 };
 declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
@@ -7910,7 +7948,7 @@ type ResolvedRouteGetResponse = RouteGetResponseNotFound | RouteGetResponseRedir
  * Resolves a route using Uniform Project Map and Uniform Redirects,
  * returning a composition, redirection, or not found result.
  */
-declare class unstable_RouteClient extends ApiClient<RouteClientOptions> {
+declare class RouteClient extends ApiClient<RouteClientOptions> {
     private edgeApiHost;
     constructor(options: RouteClientOptions);
     /** Fetches lists of Canvas compositions, optionally by type */
@@ -7925,7 +7963,6 @@ type BindVariablesResult<TValue> = {
 type BindVariablesToObjectOptions<T> = {
     /** The object to bind variables to. Only strings or objects are bound. */
     value: T;
-    recursivePath?: string;
 } & Omit<BindVariablesOptions, 'value'>;
 /**
  * Binds composition variables to an object whose string keys may have variable expressions in them.
@@ -8176,4 +8213,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
+export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };

package/dist/index.esm.js

@@ -1321,6 +1321,9 @@ var isTriggerCompositionActionMessage = (message) => {
 var isUpdatePreviewSettingsMessage = (message) => {
   return message.type === "update-preview-settings";
 };
+var isUpdateContextualEditingStateInternalMessage = (message) => {
+  return message.type === "update-contextual-editing-state-internal";
+};
 var isReportRenderedCompositionsMessage = (message) => {
   return message.type === "report-rendered-compositions";
 };
@@ -1426,6 +1429,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateContextualEditingStateInternal = (options) => {
+    const message = {
+      ...options,
+      type: "update-contextual-editing-state-internal"
+    };
+    postMessage(message);
+  };
   const reportRenderedCompositions = (options) => {
     const message = {
       ...options,
@@ -1472,6 +1482,7 @@ var createCanvasChannel = ({
     dismissPlaceholder,
     triggerCompositionAction,
     updatePreviewSettings,
+    updateContextualEditingStateInternal,
     reportRenderedCompositions
   };
 };
@@ -1557,7 +1568,7 @@ function subscribeToComposition({
 // src/RouteClient.ts
 import { ApiClient as ApiClient5 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var unstable_RouteClient = class extends ApiClient5 {
+var RouteClient = class extends ApiClient5 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -1631,7 +1642,7 @@ function bindVariablesToObjectRecursive({
         }
         return;
       }
-      const childBind = bindVariablesToObject({
+      const childBind = bindVariablesToObjectRecursive({
         ...bindVariablesOptions,
         value: oldValue,
         recursivePath: currentObjectPath
@@ -1746,6 +1757,7 @@ export {
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
+  RouteClient,
   UncachedCanvasClient,
   UniqueBatchEntries,
   bindVariables,
@@ -1773,6 +1785,7 @@ export {
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
@@ -1780,6 +1793,5 @@ export {
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
-  unstable_RouteClient,
   walkComponentTree
 };

package/dist/index.js

@@ -309,6 +309,7 @@ __export(src_exports, {
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
+  RouteClient: () => RouteClient,
   UncachedCanvasClient: () => UncachedCanvasClient,
   UniqueBatchEntries: () => UniqueBatchEntries,
   bindVariables: () => bindVariables,
@@ -336,6 +337,7 @@ __export(src_exports, {
   isUpdateComponentParameterMessage: () => isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage: () => isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage: () => isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage: () => isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
   localize: () => localize,
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
@@ -343,7 +345,6 @@ __export(src_exports, {
   nullLimitPolicy: () => nullLimitPolicy,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
-  unstable_RouteClient: () => unstable_RouteClient,
   walkComponentTree: () => walkComponentTree
 });
 module.exports = __toCommonJS(src_exports);
@@ -1404,6 +1405,9 @@ var isTriggerCompositionActionMessage = (message) => {
 var isUpdatePreviewSettingsMessage = (message) => {
   return message.type === "update-preview-settings";
 };
+var isUpdateContextualEditingStateInternalMessage = (message) => {
+  return message.type === "update-contextual-editing-state-internal";
+};
 var isReportRenderedCompositionsMessage = (message) => {
   return message.type === "report-rendered-compositions";
 };
@@ -1509,6 +1513,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateContextualEditingStateInternal = (options) => {
+    const message = {
+      ...options,
+      type: "update-contextual-editing-state-internal"
+    };
+    postMessage(message);
+  };
   const reportRenderedCompositions = (options) => {
     const message = {
       ...options,
@@ -1555,6 +1566,7 @@ var createCanvasChannel = ({
     dismissPlaceholder,
     triggerCompositionAction,
     updatePreviewSettings,
+    updateContextualEditingStateInternal,
     reportRenderedCompositions
   };
 };
@@ -1640,7 +1652,7 @@ function subscribeToComposition({
 // src/RouteClient.ts
 var import_api5 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var unstable_RouteClient = class extends import_api5.ApiClient {
+var RouteClient = class extends import_api5.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -1714,7 +1726,7 @@ function bindVariablesToObjectRecursive({
         }
         return;
       }
-      const childBind = bindVariablesToObject({
+      const childBind = bindVariablesToObjectRecursive({
         ...bindVariablesOptions,
         value: oldValue,
         recursivePath: currentObjectPath
@@ -1830,6 +1842,7 @@ var CanvasClientError = import_api6.ApiClientError;
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
+  RouteClient,
   UncachedCanvasClient,
   UniqueBatchEntries,
   bindVariables,
@@ -1857,6 +1870,7 @@ var CanvasClientError = import_api6.ApiClientError;
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
@@ -1864,6 +1878,5 @@ var CanvasClientError = import_api6.ApiClientError;
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
-  unstable_RouteClient,
   walkComponentTree
 });

package/dist/index.mjs

@@ -1321,6 +1321,9 @@ var isTriggerCompositionActionMessage = (message) => {
 var isUpdatePreviewSettingsMessage = (message) => {
   return message.type === "update-preview-settings";
 };
+var isUpdateContextualEditingStateInternalMessage = (message) => {
+  return message.type === "update-contextual-editing-state-internal";
+};
 var isReportRenderedCompositionsMessage = (message) => {
   return message.type === "report-rendered-compositions";
 };
@@ -1426,6 +1429,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateContextualEditingStateInternal = (options) => {
+    const message = {
+      ...options,
+      type: "update-contextual-editing-state-internal"
+    };
+    postMessage(message);
+  };
   const reportRenderedCompositions = (options) => {
     const message = {
       ...options,
@@ -1472,6 +1482,7 @@ var createCanvasChannel = ({
     dismissPlaceholder,
     triggerCompositionAction,
     updatePreviewSettings,
+    updateContextualEditingStateInternal,
     reportRenderedCompositions
   };
 };
@@ -1557,7 +1568,7 @@ function subscribeToComposition({
 // src/RouteClient.ts
 import { ApiClient as ApiClient5 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var unstable_RouteClient = class extends ApiClient5 {
+var RouteClient = class extends ApiClient5 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -1631,7 +1642,7 @@ function bindVariablesToObjectRecursive({
         }
         return;
       }
-      const childBind = bindVariablesToObject({
+      const childBind = bindVariablesToObjectRecursive({
         ...bindVariablesOptions,
         value: oldValue,
         recursivePath: currentObjectPath
@@ -1746,6 +1757,7 @@ export {
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
+  RouteClient,
   UncachedCanvasClient,
   UniqueBatchEntries,
   bindVariables,
@@ -1773,6 +1785,7 @@ export {
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
@@ -1780,6 +1793,5 @@ export {
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
-  unstable_RouteClient,
   walkComponentTree
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.19.0",
+  "version": "19.20.1-alpha.32+9ad53dedb",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,7 +38,7 @@
     "pusher-js": "8.0.1"
   },
   "dependencies": {
-    "@uniformdev/context": "19.19.0",
+    "@uniformdev/context": "19.20.1-alpha.32+9ad53dedb",
     "immer": "9.0.21"
   },
   "files": [
@@ -47,5 +47,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "631d1e21b1303220d80bea12611ea6c98d5fe354"
+  "gitHead": "9ad53dedb0a0c580abc314fe1422f48a09efd0aa"
 }