@uniformdev/canvas 19.21.0 → 19.22.0

package/dist/index.d.ts

@@ -7384,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;
@@ -7840,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;
@@ -7856,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 = {
@@ -7871,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, }: {
@@ -8193,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, 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, 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, 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
   };
 };
@@ -1774,6 +1785,7 @@ export {
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,

package/dist/index.js

@@ -337,6 +337,7 @@ __export(src_exports, {
   isUpdateComponentParameterMessage: () => isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage: () => isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage: () => isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage: () => isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
   localize: () => localize,
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
@@ -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
   };
 };
@@ -1858,6 +1870,7 @@ var CanvasClientError = import_api6.ApiClientError;
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,

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
   };
 };
@@ -1774,6 +1785,7 @@ export {
   isUpdateComponentParameterMessage,
   isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
+  isUpdateContextualEditingStateInternalMessage,
   isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.21.0",
+  "version": "19.22.0",
   "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.21.0",
+    "@uniformdev/context": "19.22.0",
     "immer": "9.0.21"
   },
   "files": [
@@ -47,5 +47,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3db4c0f1c775a5cf9677c6df294322cfbf79611e"
+  "gitHead": "f3b826c15f64a8abc5bd7ca08c0539bd85684cf9"
 }