@uniformdev/canvas 19.1.0 → 19.2.0

package/dist/index.esm.js

@@ -481,7 +481,6 @@ var CanvasClient = class extends ApiClient {
   }
   getOneComposition({
     skipDataResolution,
-    unstable_dynamicVariables: dynamicVariables,
     diagnostics,
     ...params
   }) {
@@ -492,7 +491,6 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
@@ -1184,6 +1182,7 @@ 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 IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
 var PLACEHOLDER_ID = "placeholder";
 var EMPTY_COMPOSITION = {
   _id: "_empty_composition_id",
@@ -1293,12 +1292,18 @@ var isReadyMessage = (message) => {
 var isUpdateCompositionMessage = (message) => {
   return message.type === "update-composition";
 };
+var isUpdateCompositionInternalMessage = (message) => {
+  return message.type === "update-composition-internal";
+};
 var isAddComponentMessage = (message) => {
   return message.type === "add-component";
 };
 var isMovingComponentMessage = (message) => {
   return message.type === "move-component";
 };
+var isUpdateComponentParameterMessage = (message) => {
+  return message.type === "update-component-parameter";
+};
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
@@ -1360,6 +1365,14 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateCompositionInternal = (composition, hash) => {
+    const message = {
+      type: "update-composition-internal",
+      composition,
+      hash
+    };
+    postMessage(message);
+  };
   const addComponent = (options) => {
     const message = {
       ...options,
@@ -1374,6 +1387,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1396,7 +1416,7 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const messageEventListener = (event) => {
-    if (typeof event.data !== "string" || event.source === window) {
+    if (typeof event.data !== "string") {
       return;
     }
     let message = null;
@@ -1426,9 +1446,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1513,6 +1535,26 @@ 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 {
+  constructor(options) {
+    var _a;
+    if (!options.limitPolicy) {
+      options.limitPolicy = createLimitPolicy({});
+    }
+    super(options);
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+  }
+  /** Fetches lists of Canvas compositions, optionally by type */
+  async getRoute(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
+    return await this.apiClient(fetchUri);
+  }
+};
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -1609,6 +1651,7 @@ export {
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
   UniqueBatchEntries,
@@ -1631,6 +1674,8 @@ export {
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1639,5 +1684,6 @@ export {
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
+  unstable_RouteClient,
   walkComponentTree
 };

package/dist/index.js

@@ -274,7 +274,7 @@ var require_retry2 = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  ApiClientError: () => import_api5.ApiClientError,
+  ApiClientError: () => import_api6.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
   CANVAS_ENRICHMENT_TAG_PARAM: () => CANVAS_ENRICHMENT_TAG_PARAM,
@@ -307,6 +307,7 @@ __export(src_exports, {
   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,
+  IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   UncachedCanvasClient: () => UncachedCanvasClient,
   UniqueBatchEntries: () => UniqueBatchEntries,
@@ -329,6 +330,8 @@ __export(src_exports, {
   isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
   isSelectComponentMessage: () => isSelectComponentMessage,
   isSystemComponentDefinition: () => isSystemComponentDefinition,
+  isUpdateComponentParameterMessage: () => isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage: () => isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage: () => isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
   localize: () => localize,
@@ -337,6 +340,7 @@ __export(src_exports, {
   nullLimitPolicy: () => nullLimitPolicy,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
+  unstable_RouteClient: () => unstable_RouteClient,
   walkComponentTree: () => walkComponentTree
 });
 module.exports = __toCommonJS(src_exports);
@@ -557,7 +561,6 @@ var CanvasClient = class extends import_api.ApiClient {
   }
   getOneComposition({
     skipDataResolution,
-    unstable_dynamicVariables: dynamicVariables,
     diagnostics,
     ...params
   }) {
@@ -568,7 +571,6 @@ var CanvasClient = class extends import_api.ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
@@ -1260,6 +1262,7 @@ 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 IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
 var PLACEHOLDER_ID = "placeholder";
 var EMPTY_COMPOSITION = {
   _id: "_empty_composition_id",
@@ -1369,12 +1372,18 @@ var isReadyMessage = (message) => {
 var isUpdateCompositionMessage = (message) => {
   return message.type === "update-composition";
 };
+var isUpdateCompositionInternalMessage = (message) => {
+  return message.type === "update-composition-internal";
+};
 var isAddComponentMessage = (message) => {
   return message.type === "add-component";
 };
 var isMovingComponentMessage = (message) => {
   return message.type === "move-component";
 };
+var isUpdateComponentParameterMessage = (message) => {
+  return message.type === "update-component-parameter";
+};
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
@@ -1436,6 +1445,14 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateCompositionInternal = (composition, hash) => {
+    const message = {
+      type: "update-composition-internal",
+      composition,
+      hash
+    };
+    postMessage(message);
+  };
   const addComponent = (options) => {
     const message = {
       ...options,
@@ -1450,6 +1467,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1472,7 +1496,7 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const messageEventListener = (event) => {
-    if (typeof event.data !== "string" || event.source === window) {
+    if (typeof event.data !== "string") {
       return;
     }
     let message = null;
@@ -1502,9 +1526,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1589,6 +1615,26 @@ 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 {
+  constructor(options) {
+    var _a;
+    if (!options.limitPolicy) {
+      options.limitPolicy = createLimitPolicy({});
+    }
+    super(options);
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+  }
+  /** Fetches lists of Canvas compositions, optionally by type */
+  async getRoute(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
+    return await this.apiClient(fetchUri);
+  }
+};
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -1649,8 +1695,8 @@ function mapSlotToTestVariations(slot) {
 }
 
 // src/index.ts
-var import_api5 = require("@uniformdev/context/api");
-var CanvasClientError = import_api5.ApiClientError;
+var import_api6 = require("@uniformdev/context/api");
+var CanvasClientError = import_api6.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApiClientError,
@@ -1686,6 +1732,7 @@ var CanvasClientError = import_api5.ApiClientError;
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
   UniqueBatchEntries,
@@ -1708,6 +1755,8 @@ var CanvasClientError = import_api5.ApiClientError;
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1716,5 +1765,6 @@ var CanvasClientError = import_api5.ApiClientError;
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
+  unstable_RouteClient,
   walkComponentTree
 });

package/dist/index.mjs

@@ -481,7 +481,6 @@ var CanvasClient = class extends ApiClient {
   }
   getOneComposition({
     skipDataResolution,
-    unstable_dynamicVariables: dynamicVariables,
     diagnostics,
     ...params
   }) {
@@ -492,7 +491,6 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
@@ -1184,6 +1182,7 @@ 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 IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
 var PLACEHOLDER_ID = "placeholder";
 var EMPTY_COMPOSITION = {
   _id: "_empty_composition_id",
@@ -1293,12 +1292,18 @@ var isReadyMessage = (message) => {
 var isUpdateCompositionMessage = (message) => {
   return message.type === "update-composition";
 };
+var isUpdateCompositionInternalMessage = (message) => {
+  return message.type === "update-composition-internal";
+};
 var isAddComponentMessage = (message) => {
   return message.type === "add-component";
 };
 var isMovingComponentMessage = (message) => {
   return message.type === "move-component";
 };
+var isUpdateComponentParameterMessage = (message) => {
+  return message.type === "update-component-parameter";
+};
 var isDismissPlaceholderMessage = (message) => {
   return message.type === "dismiss-placeholder";
 };
@@ -1360,6 +1365,14 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateCompositionInternal = (composition, hash) => {
+    const message = {
+      type: "update-composition-internal",
+      composition,
+      hash
+    };
+    postMessage(message);
+  };
   const addComponent = (options) => {
     const message = {
       ...options,
@@ -1374,6 +1387,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1396,7 +1416,7 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const messageEventListener = (event) => {
-    if (typeof event.data !== "string" || event.source === window) {
+    if (typeof event.data !== "string") {
       return;
     }
     let message = null;
@@ -1426,9 +1446,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1513,6 +1535,26 @@ 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 {
+  constructor(options) {
+    var _a;
+    if (!options.limitPolicy) {
+      options.limitPolicy = createLimitPolicy({});
+    }
+    super(options);
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+  }
+  /** Fetches lists of Canvas compositions, optionally by type */
+  async getRoute(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
+    return await this.apiClient(fetchUri);
+  }
+};
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -1609,6 +1651,7 @@ export {
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
   UniqueBatchEntries,
@@ -1631,6 +1674,8 @@ export {
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1639,5 +1684,6 @@ export {
   nullLimitPolicy,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
+  unstable_RouteClient,
   walkComponentTree
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.1.0",
+  "version": "19.2.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": "19.1.0"
+    "@uniformdev/context": "19.2.0"
   },
   "files": [
     "/dist"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0a06bc3cbf5a3ef7eb72b7ba237e76df645a4a88"
+  "gitHead": "9eb2423cd12a5db527f9f3a9d46b47ac2a0e7eb3"
 }