@uniformdev/canvas 18.33.0 → 18.34.0

package/dist/index.d.ts

@@ -159,14 +159,6 @@ interface components$2 {
              * @enum {string}
              */
             syntax: "jptr";
-            /**
-             * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-             * In all cases the binding process will remove the parameter data for the unresolvable data element.
-             * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-             *
-             * @default false
-             */
-            required?: boolean;
         };
         /** @description Defines the shape of a component instance served by the composition API. */
         ComponentInstance: {
@@ -761,14 +753,6 @@ interface external$5 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -1627,14 +1611,6 @@ interface external$4 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -2278,14 +2254,6 @@ interface external$3 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -3102,7 +3070,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                         connectedData?: {
                             pointer: string;
                             syntax: "jptr";
-                            required?: boolean | undefined;
                         } | undefined;
                     };
                 } | undefined;
@@ -3122,7 +3089,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3162,7 +3128,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                         connectedData?: {
                                             pointer: string;
                                             syntax: "jptr";
-                                            required?: boolean | undefined;
                                         } | undefined;
                                     };
                                 } | undefined;
@@ -3199,7 +3164,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3287,7 +3251,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                         connectedData?: {
                             pointer: string;
                             syntax: "jptr";
-                            required?: boolean | undefined;
                         } | undefined;
                     };
                 } | undefined;
@@ -3327,7 +3290,6 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                                 connectedData?: {
                                     pointer: string;
                                     syntax: "jptr";
-                                    required?: boolean | undefined;
                                 } | undefined;
                             };
                         } | undefined;
@@ -3358,6 +3320,10 @@ declare class UncachedCanvasClient extends CanvasClient {
     constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
 }
 
+type PreviewPanelSettings = {
+    isInteractive: boolean;
+};
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -3636,14 +3602,6 @@ interface external$2 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -4180,14 +4138,6 @@ interface external$1 {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -4759,14 +4709,6 @@ interface external {
                      * @enum {string}
                      */
                     syntax: "jptr";
-                    /**
-                     * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
-                     * In all cases the binding process will remove the parameter data for the unresolvable data element.
-                     * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
-                     *
-                     * @default false
-                     */
-                    required?: boolean;
                 };
                 /** @description Defines the shape of a component instance served by the composition API. */
                 ComponentInstance: {
@@ -5456,6 +5398,7 @@ declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocati
 
 interface ContextualEditingWindowData {
     framework?: ReadyMessage['framework'];
+    version?: ReadyMessage['version'];
 }
 declare global {
     interface Window {
@@ -5469,6 +5412,8 @@ type SelectComponentMessage = {
 type ReadyMessage = {
     type: 'ready';
     framework?: 'React' | 'Vue';
+    /** A non-semantic version of the contextual editing SDK. */
+    version?: number;
 };
 type UpdateCompositionMessage = {
     type: 'update-composition';
@@ -5493,23 +5438,36 @@ type DismissPlaceholderMessage = {
     parentId: string;
     slotName: string;
 };
-type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
+type UpdatePreviewSettingsMessage = {
+    type: 'update-preview-settings';
+    settings: PreviewPanelSettings;
+};
+type ReportRenderedCompositionsMessage = {
+    type: 'report-rendered-compositions';
+    compositionIds: string[];
+    url: string;
+};
+type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
 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 const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
+declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
+declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
 type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
 type Channel = {
+    on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
     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: Omit<AddComponentMessage, 'type'>) => void;
     moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
     dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
+    updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
+    reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
 };
 declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
     listenTo: Window[];
@@ -5587,10 +5545,18 @@ declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 /** The value of "data-role" in the component start `<script>` tag */
 declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+/** The value of "data-role" in the component end `<script>` tag */
+declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 /** The ID of the Contextual Editing script that gets embedded in frontend apps */
 declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 /** The ID we give to placeholder components */
 declare const PLACEHOLDER_ID = "placeholder";
+/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
+declare const EMPTY_COMPOSITION: {
+    _id: string;
+    _name: string;
+    type: string;
+};
 /** Minimal value for Edgehancers Cache TTL (in seconds) */
 declare const EDGE_MIN_CACHE_TTL = 15;
 /** Maximal value for Edgehancers Cache TTL (in seconds) */
@@ -5628,7 +5594,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
             connectedData?: {
                 pointer: string;
                 syntax: "jptr";
-                required?: boolean | undefined;
             } | undefined;
         };
     } | undefined;
@@ -5648,7 +5613,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                     connectedData?: {
                         pointer: string;
                         syntax: "jptr";
-                        required?: boolean | undefined;
                     } | undefined;
                 };
             } | undefined;
@@ -5688,7 +5652,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                             connectedData?: {
                                 pointer: string;
                                 syntax: "jptr";
-                                required?: boolean | undefined;
                             } | undefined;
                         };
                     } | undefined;
@@ -5725,7 +5688,6 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
                     connectedData?: {
                         pointer: string;
                         syntax: "jptr";
-                        required?: boolean | undefined;
                     } | undefined;
                 };
             } | undefined;
@@ -5762,4 +5724,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, 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, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, 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, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, 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, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, 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, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };

package/dist/index.esm.js

@@ -1127,8 +1127,14 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 var PLACEHOLDER_ID = "placeholder";
+var EMPTY_COMPOSITION = {
+  _id: "_empty_composition_id",
+  _name: "An empty composition used for contextual editing",
+  type: "_empty_composition_type"
+};
 var EDGE_MIN_CACHE_TTL = 15;
 var EDGE_MAX_CACHE_TTL = 600;
 var EDGE_DEFAULT_CACHE_TTL = 30;
@@ -1241,6 +1247,12 @@ var isMovingComponentMessage = (message) => {
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
+var isUpdatePreviewSettingsMessage = (message) => {
+  return message.type === "update-preview-settings";
+};
+var isReportRenderedCompositionsMessage = (message) => {
+  return message.type === "report-rendered-compositions";
+};
 var createCanvasChannel = ({
   listenTo,
   broadcastTo
@@ -1259,14 +1271,16 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const ready = () => {
-    var _a;
+    var _a, _b;
     if (typeof window === "undefined") {
       return;
     }
     const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
+    const version = (_b = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _b.version;
     const message = {
       type: "ready",
-      framework
+      framework,
+      version
     };
     postMessage(message);
   };
@@ -1312,6 +1326,20 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updatePreviewSettings = (options) => {
+    const message = {
+      ...options,
+      type: "update-preview-settings"
+    };
+    postMessage(message);
+  };
+  const reportRenderedCompositions = (options) => {
+    const message = {
+      ...options,
+      type: "report-rendered-compositions"
+    };
+    postMessage(message);
+  };
   const messageEventListener = (event) => {
     if (typeof event.data !== "string" || event.source === window) {
       return;
@@ -1346,7 +1374,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1518,7 +1548,9 @@ export {
   EDGE_MAX_L2_CACHE_TTL_IN_HOURS,
   EDGE_MIN_CACHE_TTL,
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
+  EMPTY_COMPOSITION,
   EnhancerBuilder,
+  IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1541,9 +1573,11 @@ export {
   isDismissPlaceholderMessage,
   isMovingComponentMessage,
   isReadyMessage,
+  isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
   isUpdateCompositionMessage,
+  isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/dist/index.js

@@ -301,7 +301,9 @@ __export(src_exports, {
   EDGE_MAX_L2_CACHE_TTL_IN_HOURS: () => EDGE_MAX_L2_CACHE_TTL_IN_HOURS,
   EDGE_MIN_CACHE_TTL: () => EDGE_MIN_CACHE_TTL,
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS: () => EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
+  EMPTY_COMPOSITION: () => EMPTY_COMPOSITION,
   EnhancerBuilder: () => EnhancerBuilder,
+  IN_CONTEXT_EDITOR_COMPONENT_END_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID: () => IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -324,9 +326,11 @@ __export(src_exports, {
   isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
   isMovingComponentMessage: () => isMovingComponentMessage,
   isReadyMessage: () => isReadyMessage,
+  isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
   isSelectComponentMessage: () => isSelectComponentMessage,
   isSystemComponentDefinition: () => isSystemComponentDefinition,
   isUpdateCompositionMessage: () => isUpdateCompositionMessage,
+  isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
   localize: () => localize,
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
   mapSlotToTestVariations: () => mapSlotToTestVariations,
@@ -1198,8 +1202,14 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 var PLACEHOLDER_ID = "placeholder";
+var EMPTY_COMPOSITION = {
+  _id: "_empty_composition_id",
+  _name: "An empty composition used for contextual editing",
+  type: "_empty_composition_type"
+};
 var EDGE_MIN_CACHE_TTL = 15;
 var EDGE_MAX_CACHE_TTL = 600;
 var EDGE_DEFAULT_CACHE_TTL = 30;
@@ -1312,6 +1322,12 @@ var isMovingComponentMessage = (message) => {
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
+var isUpdatePreviewSettingsMessage = (message) => {
+  return message.type === "update-preview-settings";
+};
+var isReportRenderedCompositionsMessage = (message) => {
+  return message.type === "report-rendered-compositions";
+};
 var createCanvasChannel = ({
   listenTo,
   broadcastTo
@@ -1330,14 +1346,16 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const ready = () => {
-    var _a;
+    var _a, _b;
     if (typeof window === "undefined") {
       return;
     }
     const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
+    const version = (_b = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _b.version;
     const message = {
       type: "ready",
-      framework
+      framework,
+      version
     };
     postMessage(message);
   };
@@ -1383,6 +1401,20 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updatePreviewSettings = (options) => {
+    const message = {
+      ...options,
+      type: "update-preview-settings"
+    };
+    postMessage(message);
+  };
+  const reportRenderedCompositions = (options) => {
+    const message = {
+      ...options,
+      type: "report-rendered-compositions"
+    };
+    postMessage(message);
+  };
   const messageEventListener = (event) => {
     if (typeof event.data !== "string" || event.source === window) {
       return;
@@ -1417,7 +1449,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1590,7 +1624,9 @@ var CanvasClientError = import_api4.ApiClientError;
   EDGE_MAX_L2_CACHE_TTL_IN_HOURS,
   EDGE_MIN_CACHE_TTL,
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
+  EMPTY_COMPOSITION,
   EnhancerBuilder,
+  IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1613,9 +1649,11 @@ var CanvasClientError = import_api4.ApiClientError;
   isDismissPlaceholderMessage,
   isMovingComponentMessage,
   isReadyMessage,
+  isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
   isUpdateCompositionMessage,
+  isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/dist/index.mjs

@@ -1127,8 +1127,14 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
 var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 var PLACEHOLDER_ID = "placeholder";
+var EMPTY_COMPOSITION = {
+  _id: "_empty_composition_id",
+  _name: "An empty composition used for contextual editing",
+  type: "_empty_composition_type"
+};
 var EDGE_MIN_CACHE_TTL = 15;
 var EDGE_MAX_CACHE_TTL = 600;
 var EDGE_DEFAULT_CACHE_TTL = 30;
@@ -1241,6 +1247,12 @@ var isMovingComponentMessage = (message) => {
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
+var isUpdatePreviewSettingsMessage = (message) => {
+  return message.type === "update-preview-settings";
+};
+var isReportRenderedCompositionsMessage = (message) => {
+  return message.type === "report-rendered-compositions";
+};
 var createCanvasChannel = ({
   listenTo,
   broadcastTo
@@ -1259,14 +1271,16 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const ready = () => {
-    var _a;
+    var _a, _b;
     if (typeof window === "undefined") {
       return;
     }
     const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
+    const version = (_b = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _b.version;
     const message = {
       type: "ready",
-      framework
+      framework,
+      version
     };
     postMessage(message);
   };
@@ -1312,6 +1326,20 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updatePreviewSettings = (options) => {
+    const message = {
+      ...options,
+      type: "update-preview-settings"
+    };
+    postMessage(message);
+  };
+  const reportRenderedCompositions = (options) => {
+    const message = {
+      ...options,
+      type: "report-rendered-compositions"
+    };
+    postMessage(message);
+  };
   const messageEventListener = (event) => {
     if (typeof event.data !== "string" || event.source === window) {
       return;
@@ -1346,7 +1374,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1518,7 +1548,9 @@ export {
   EDGE_MAX_L2_CACHE_TTL_IN_HOURS,
   EDGE_MIN_CACHE_TTL,
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
+  EMPTY_COMPOSITION,
   EnhancerBuilder,
+  IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1541,9 +1573,11 @@ export {
   isDismissPlaceholderMessage,
   isMovingComponentMessage,
   isReadyMessage,
+  isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
   isUpdateCompositionMessage,
+  isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "18.33.0",
+  "version": "18.34.0",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -47,7 +47,7 @@
     "pusher-js": "8.0.1"
   },
   "dependencies": {
-    "@uniformdev/context": "18.33.0"
+    "@uniformdev/context": "18.34.0"
   },
   "files": [
     "/dist"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2b6ca533e90fa133ead4ce435f4a3f19e30b21c1"
+  "gitHead": "563ab31aa4308102c988bea321028e73efe836d0"
 }