@uniformdev/canvas 19.0.0 → 19.1.1-alpha.1

package/dist/index.esm.js

@@ -548,11 +548,74 @@ var UncachedCanvasClient = class extends CanvasClient {
   }
 };
 
-// src/DataSourceClient.ts
+// src/CompositionRelationshipClient.ts
 import { ApiClient as ApiClient2 } from "@uniformdev/context/api";
+var COMPOSITION_RELATIONSHIP_URL = "/api/v1/composition-relationships";
+var unstable_CompositionRelationshipClient = class extends ApiClient2 {
+  constructor(options) {
+    super(options);
+    this.getDefinitionsRelationships = async ({
+      definitionIds,
+      withCompositions
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL, {
+        type: "definition",
+        projectId: this._options.projectId,
+        definitionIds: definitionIds.join(","),
+        withCompositions
+      });
+      return this.apiClient(url);
+    };
+    this.clearAllRelationships = async () => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "clear",
+          projectId: this._options.projectId
+        })
+      });
+    };
+    this.indexCompositionRelationships = async ({
+      state,
+      compositionId
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "index",
+          projectId: this._options.projectId,
+          state,
+          compositionId
+        })
+      });
+    };
+    this.getVersion = async () => {
+      const url = this.createUrl("/api/v1/usage-tracking", {
+        projectId: this._options.projectId
+      });
+      return this.apiClient(url).then((response) => response.version);
+    };
+    this.setVersion = async (version) => {
+      const url = this.createUrl("/api/v1/usage-tracking");
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          projectId: this._options.projectId,
+          version
+        })
+      });
+    };
+    this._options = options;
+  }
+};
+
+// src/DataSourceClient.ts
+import { ApiClient as ApiClient3 } from "@uniformdev/context/api";
 var dataSourceUrl = "/api/v1/data-source";
 var dataSourcesUrl = "/api/v1/data-sources";
-var DataSourceClient = class extends ApiClient2 {
+var DataSourceClient = class extends ApiClient3 {
   constructor(options) {
     super(options);
   }
@@ -589,9 +652,9 @@ var DataSourceClient = class extends ApiClient2 {
 };
 
 // src/DataTypeClient.ts
-import { ApiClient as ApiClient3 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient4 } from "@uniformdev/context/api";
 var _url;
-var _DataTypeClient = class extends ApiClient3 {
+var _DataTypeClient = class extends ApiClient4 {
   constructor(options) {
     super(options);
   }
@@ -1121,6 +1184,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",
@@ -1230,12 +1294,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";
 };
@@ -1297,6 +1367,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,
@@ -1311,6 +1389,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1333,7 +1418,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;
@@ -1363,9 +1448,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1546,6 +1633,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,
@@ -1568,6 +1656,8 @@ export {
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1575,5 +1665,6 @@ export {
   mapSlotToTestVariations,
   nullLimitPolicy,
   subscribeToComposition,
+  unstable_CompositionRelationshipClient,
   walkComponentTree
 };

package/dist/index.js

@@ -274,7 +274,7 @@ var require_retry2 = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  ApiClientError: () => import_api4.ApiClientError,
+  ApiClientError: () => import_api5.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,
@@ -336,6 +339,7 @@ __export(src_exports, {
   mapSlotToTestVariations: () => mapSlotToTestVariations,
   nullLimitPolicy: () => nullLimitPolicy,
   subscribeToComposition: () => subscribeToComposition,
+  unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
   walkComponentTree: () => walkComponentTree
 });
 module.exports = __toCommonJS(src_exports);
@@ -623,11 +627,74 @@ var UncachedCanvasClient = class extends CanvasClient {
   }
 };
 
-// src/DataSourceClient.ts
+// src/CompositionRelationshipClient.ts
 var import_api2 = require("@uniformdev/context/api");
+var COMPOSITION_RELATIONSHIP_URL = "/api/v1/composition-relationships";
+var unstable_CompositionRelationshipClient = class extends import_api2.ApiClient {
+  constructor(options) {
+    super(options);
+    this.getDefinitionsRelationships = async ({
+      definitionIds,
+      withCompositions
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL, {
+        type: "definition",
+        projectId: this._options.projectId,
+        definitionIds: definitionIds.join(","),
+        withCompositions
+      });
+      return this.apiClient(url);
+    };
+    this.clearAllRelationships = async () => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "clear",
+          projectId: this._options.projectId
+        })
+      });
+    };
+    this.indexCompositionRelationships = async ({
+      state,
+      compositionId
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "index",
+          projectId: this._options.projectId,
+          state,
+          compositionId
+        })
+      });
+    };
+    this.getVersion = async () => {
+      const url = this.createUrl("/api/v1/usage-tracking", {
+        projectId: this._options.projectId
+      });
+      return this.apiClient(url).then((response) => response.version);
+    };
+    this.setVersion = async (version) => {
+      const url = this.createUrl("/api/v1/usage-tracking");
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          projectId: this._options.projectId,
+          version
+        })
+      });
+    };
+    this._options = options;
+  }
+};
+
+// src/DataSourceClient.ts
+var import_api3 = require("@uniformdev/context/api");
 var dataSourceUrl = "/api/v1/data-source";
 var dataSourcesUrl = "/api/v1/data-sources";
-var DataSourceClient = class extends import_api2.ApiClient {
+var DataSourceClient = class extends import_api3.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -664,9 +731,9 @@ var DataSourceClient = class extends import_api2.ApiClient {
 };
 
 // src/DataTypeClient.ts
-var import_api3 = require("@uniformdev/context/api");
+var import_api4 = require("@uniformdev/context/api");
 var _url;
-var _DataTypeClient = class extends import_api3.ApiClient {
+var _DataTypeClient = class extends import_api4.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -1196,6 +1263,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",
@@ -1305,12 +1373,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";
 };
@@ -1372,6 +1446,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,
@@ -1386,6 +1468,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1408,7 +1497,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;
@@ -1438,9 +1527,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1585,8 +1676,8 @@ function mapSlotToTestVariations(slot) {
 }
 
 // src/index.ts
-var import_api4 = require("@uniformdev/context/api");
-var CanvasClientError = import_api4.ApiClientError;
+var import_api5 = require("@uniformdev/context/api");
+var CanvasClientError = import_api5.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApiClientError,
@@ -1622,6 +1713,7 @@ var CanvasClientError = import_api4.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,
@@ -1644,6 +1736,8 @@ var CanvasClientError = import_api4.ApiClientError;
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1651,5 +1745,6 @@ var CanvasClientError = import_api4.ApiClientError;
   mapSlotToTestVariations,
   nullLimitPolicy,
   subscribeToComposition,
+  unstable_CompositionRelationshipClient,
   walkComponentTree
 });

package/dist/index.mjs

@@ -548,11 +548,74 @@ var UncachedCanvasClient = class extends CanvasClient {
   }
 };
 
-// src/DataSourceClient.ts
+// src/CompositionRelationshipClient.ts
 import { ApiClient as ApiClient2 } from "@uniformdev/context/api";
+var COMPOSITION_RELATIONSHIP_URL = "/api/v1/composition-relationships";
+var unstable_CompositionRelationshipClient = class extends ApiClient2 {
+  constructor(options) {
+    super(options);
+    this.getDefinitionsRelationships = async ({
+      definitionIds,
+      withCompositions
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL, {
+        type: "definition",
+        projectId: this._options.projectId,
+        definitionIds: definitionIds.join(","),
+        withCompositions
+      });
+      return this.apiClient(url);
+    };
+    this.clearAllRelationships = async () => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "clear",
+          projectId: this._options.projectId
+        })
+      });
+    };
+    this.indexCompositionRelationships = async ({
+      state,
+      compositionId
+    }) => {
+      const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL);
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          type: "index",
+          projectId: this._options.projectId,
+          state,
+          compositionId
+        })
+      });
+    };
+    this.getVersion = async () => {
+      const url = this.createUrl("/api/v1/usage-tracking", {
+        projectId: this._options.projectId
+      });
+      return this.apiClient(url).then((response) => response.version);
+    };
+    this.setVersion = async (version) => {
+      const url = this.createUrl("/api/v1/usage-tracking");
+      return this.apiClient(url, {
+        method: "POST",
+        body: JSON.stringify({
+          projectId: this._options.projectId,
+          version
+        })
+      });
+    };
+    this._options = options;
+  }
+};
+
+// src/DataSourceClient.ts
+import { ApiClient as ApiClient3 } from "@uniformdev/context/api";
 var dataSourceUrl = "/api/v1/data-source";
 var dataSourcesUrl = "/api/v1/data-sources";
-var DataSourceClient = class extends ApiClient2 {
+var DataSourceClient = class extends ApiClient3 {
   constructor(options) {
     super(options);
   }
@@ -589,9 +652,9 @@ var DataSourceClient = class extends ApiClient2 {
 };
 
 // src/DataTypeClient.ts
-import { ApiClient as ApiClient3 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient4 } from "@uniformdev/context/api";
 var _url;
-var _DataTypeClient = class extends ApiClient3 {
+var _DataTypeClient = class extends ApiClient4 {
   constructor(options) {
     super(options);
   }
@@ -1121,6 +1184,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",
@@ -1230,12 +1294,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";
 };
@@ -1297,6 +1367,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,
@@ -1311,6 +1389,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateComponentParameter = (options) => {
+    const message = {
+      ...options,
+      type: "update-component-parameter"
+    };
+    postMessage(message);
+  };
   const dismissPlaceholder = (options) => {
     const message = {
       ...options,
@@ -1333,7 +1418,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;
@@ -1363,9 +1448,11 @@ var createCanvasChannel = ({
     destroy,
     selectComponent,
     updateComposition,
+    updateCompositionInternal,
     on,
     addComponent,
     moveComponent,
+    updateComponentParameter,
     dismissPlaceholder,
     updatePreviewSettings,
     reportRenderedCompositions
@@ -1546,6 +1633,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,
@@ -1568,6 +1656,8 @@ export {
   isReportRenderedCompositionsMessage,
   isSelectComponentMessage,
   isSystemComponentDefinition,
+  isUpdateComponentParameterMessage,
+  isUpdateCompositionInternalMessage,
   isUpdateCompositionMessage,
   isUpdatePreviewSettingsMessage,
   localize,
@@ -1575,5 +1665,6 @@ export {
   mapSlotToTestVariations,
   nullLimitPolicy,
   subscribeToComposition,
+  unstable_CompositionRelationshipClient,
   walkComponentTree
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.0.0",
+  "version": "19.1.1-alpha.1+3ec68fe9d",
   "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.0.0"
+    "@uniformdev/context": "19.1.1-alpha.1+3ec68fe9d"
   },
   "files": [
     "/dist"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e104985924b24a8de1d8dcfcca6c9167611adf85"
+  "gitHead": "3ec68fe9d54c7128e57cc8a5c8116fe968f65865"
 }