@uniformdev/canvas 18.33.1-alpha.7 → 18.34.0

package/dist/index.esm.js

@@ -470,9 +470,17 @@ var CanvasClient = class extends ApiClient {
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated use getCompositionByNodePath instead */
+  unstable_getCompositionByNodePath(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated Use getCompositionByNodeId instead */
+  unstable_getCompositionByNodeId(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionBySlug(options) {
     return this.getOneComposition(options);
   }
@@ -480,13 +488,13 @@ var CanvasClient = class extends ApiClient {
     return this.getOneComposition(options);
   }
   getOneComposition({
-    skipDataResolution,
+    unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    diagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
-    if (skipDataResolution) {
+    if (!resolveData) {
       return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
     const edgeParams = {
@@ -1119,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;
@@ -1233,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
@@ -1251,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);
   };
@@ -1304,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;
@@ -1338,7 +1374,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1510,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,
@@ -1533,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,
@@ -541,9 +545,17 @@ var CanvasClient = class extends import_api.ApiClient {
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated use getCompositionByNodePath instead */
+  unstable_getCompositionByNodePath(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated Use getCompositionByNodeId instead */
+  unstable_getCompositionByNodeId(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionBySlug(options) {
     return this.getOneComposition(options);
   }
@@ -551,13 +563,13 @@ var CanvasClient = class extends import_api.ApiClient {
     return this.getOneComposition(options);
   }
   getOneComposition({
-    skipDataResolution,
+    unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    diagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
-    if (skipDataResolution) {
+    if (!resolveData) {
       return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
     const edgeParams = {
@@ -1190,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;
@@ -1304,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
@@ -1322,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);
   };
@@ -1375,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;
@@ -1409,7 +1449,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1582,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,
@@ -1605,9 +1649,11 @@ var CanvasClientError = import_api4.ApiClientError;
   isDismissPlaceholderMessage,
   isMovingComponentMessage,
   isReadyMessage,
+  isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
   isUpdateCompositionMessage,
+  isUpdatePreviewSettingsMessage,
   localize,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/dist/index.mjs

@@ -470,9 +470,17 @@ var CanvasClient = class extends ApiClient {
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated use getCompositionByNodePath instead */
+  unstable_getCompositionByNodePath(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated Use getCompositionByNodeId instead */
+  unstable_getCompositionByNodeId(options) {
+    return this.getOneComposition(options);
+  }
   getCompositionBySlug(options) {
     return this.getOneComposition(options);
   }
@@ -480,13 +488,13 @@ var CanvasClient = class extends ApiClient {
     return this.getOneComposition(options);
   }
   getOneComposition({
-    skipDataResolution,
+    unstable_resolveData: resolveData,
     unstable_dynamicVariables: dynamicVariables,
-    diagnostics,
+    unstable_diagnostics: diagnostics,
     ...params
   }) {
     const { projectId } = this.options;
-    if (skipDataResolution) {
+    if (!resolveData) {
       return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
     const edgeParams = {
@@ -1119,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;
@@ -1233,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
@@ -1251,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);
   };
@@ -1304,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;
@@ -1338,7 +1374,9 @@ var createCanvasChannel = ({
     on,
     addComponent,
     moveComponent,
-    dismissPlaceholder
+    dismissPlaceholder,
+    updatePreviewSettings,
+    reportRenderedCompositions
   };
 };
 
@@ -1510,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,
@@ -1533,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.1-alpha.7+7127237a1",
+  "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.1-alpha.7+7127237a1"
+    "@uniformdev/context": "18.34.0"
   },
   "files": [
     "/dist"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7127237a1e099d2a11fa8c06d49cb01cf16c0852"
+  "gitHead": "563ab31aa4308102c988bea321028e73efe836d0"
 }