@uniformdev/canvas-react 18.33.1-alpha.7 → 18.34.0

package/dist/index.mjs

@@ -36,7 +36,7 @@ import {
   CANVAS_ENRICHMENT_TAG_PARAM
 } from "@uniformdev/canvas";
 import { Track, TrackFragment, useUniformContext } from "@uniformdev/context-react";
-import React4, { createContext, useContext } from "react";
+import React6, { createContext as createContext2, useContext as useContext2 } from "react";
 
 // src/convertComponentToProps.ts
 function convertComponentToProps(component) {
@@ -70,7 +70,8 @@ var createComponentStore = () => {
 };
 var createComponentStoreResolver = ({ store, defaultComponent = DefaultNotImplementedComponent }) => {
   return (component) => {
-    const resolved = store.get(getTypeWithVariant(component.type, component.variant));
+    var _a;
+    const resolved = (_a = store.get(getTypeWithVariant(component.type, component.variant))) != null ? _a : store.get(getTypeWithVariant(component.type));
     return resolved || defaultComponent;
   };
 };
@@ -94,15 +95,12 @@ var componentStoreResolver = createComponentStoreResolver({
 
 // src/components/UniformSlot.tsx
 import {
-  CANVAS_LOCALE_TAG_PARAM,
   CANVAS_PERSONALIZE_SLOT,
   CANVAS_PERSONALIZE_TYPE,
   CANVAS_TEST_SLOT,
-  CANVAS_TEST_TYPE,
-  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
-  PLACEHOLDER_ID
+  CANVAS_TEST_TYPE
 } from "@uniformdev/canvas";
-import React3 from "react";
+import React5 from "react";
 
 // src/defaultSystemComponentResolver.tsx
 import {
@@ -145,6 +143,178 @@ var defaultSystemComponentResolver = {
   }
 };
 
+// src/components/ContextualEditingComponentWrapper.tsx
+import {
+  CANVAS_LOCALE_TAG_PARAM,
+  IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
+  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  PLACEHOLDER_ID
+} from "@uniformdev/canvas";
+import React4 from "react";
+
+// src/components/UniformComposition.tsx
+import React3, { createContext, useContext } from "react";
+
+// src/hooks/useUniformContextualEditing.ts
+import {
+  createCanvasChannel,
+  createUniformApiEnhancer,
+  EMPTY_COMPOSITION,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
+  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
+  isUpdateCompositionMessage
+} from "@uniformdev/canvas";
+import { useEffect, useMemo, useState } from "react";
+var createApiEnhancer = createUniformApiEnhancer;
+var registeredCompositionIds = /* @__PURE__ */ new Set();
+var useUniformContextualEditing = ({
+  initialCompositionValue,
+  enhance = (message) => message.composition
+}) => {
+  const [contextualComposition, setContextualComposition] = useState();
+  const channel = useMemo(() => {
+    var _a;
+    if (!isInContextEditingMode()) {
+      return;
+    }
+    const channel2 = createCanvasChannel({
+      broadcastTo: [(_a = window.opener) != null ? _a : window.top],
+      listenTo: [window]
+    });
+    return channel2;
+  }, []);
+  useEffect(() => {
+    if ((contextualComposition == null ? void 0 : contextualComposition._id) && (initialCompositionValue == null ? void 0 : initialCompositionValue._id) !== EMPTY_COMPOSITION._id && (initialCompositionValue == null ? void 0 : initialCompositionValue._id) !== (contextualComposition == null ? void 0 : contextualComposition._id)) {
+      setContextualComposition(void 0);
+      return;
+    }
+    if (!channel || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
+      return;
+    }
+    const unsubscribeFromCompositionUpdates = channel.on("update-composition", async (message) => {
+      if (!isUpdateCompositionMessage(message)) {
+        return;
+      }
+      const enhancedComposition = await enhance(message);
+      setContextualComposition(enhancedComposition);
+    });
+    registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
+    return () => {
+      unsubscribeFromCompositionUpdates();
+      registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
+    };
+  }, [channel, enhance, initialCompositionValue == null ? void 0 : initialCompositionValue._id, contextualComposition == null ? void 0 : contextualComposition._id]);
+  useEffect(() => {
+    if (!isInContextEditingMode()) {
+      return;
+    }
+    const existingScript = document.getElementById(IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID);
+    if (existingScript) {
+      return;
+    }
+    window.__UNIFORM_CONTEXTUAL_EDITING__ = {
+      framework: "React",
+      // Make sure to also update the value in canvas-vue
+      version: 1
+    };
+    const script = document.createElement("script");
+    script.id = IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
+    script.src = getCanvasInContextEmbedScriptUrl();
+    script.async = true;
+    document.head.appendChild(script);
+  }, [initialCompositionValue == null ? void 0 : initialCompositionValue._id]);
+  return {
+    composition: contextualComposition != null ? contextualComposition : initialCompositionValue,
+    isContextualEditing: Boolean(contextualComposition)
+  };
+};
+function getCanvasInContextEmbedScriptUrl() {
+  const scriptUrl = `${window.document.referrer}files/canvas-in-context-embed/index.js`;
+  return scriptUrl;
+}
+function isInContextEditingMode() {
+  if (typeof window === "undefined") {
+    return false;
+  }
+  const isOpenedByInContextEditor = new URLSearchParams(window.location.search).has(
+    IN_CONTEXT_EDITOR_QUERY_STRING_PARAM
+  );
+  const isAllowlistedReferrer = Boolean(
+    window.document.referrer.match(/(^https:\/\/|\.)(uniform.app|uniform.wtf|localhost:\d{4})\//)
+  );
+  return isOpenedByInContextEditor && isAllowlistedReferrer;
+}
+var useContextualEditing = useUniformContextualEditing;
+
+// src/components/UniformComposition.tsx
+var UniformCompositionContext = createContext({
+  data: void 0,
+  isContextualEditing: false
+});
+function useUniformCurrentComposition() {
+  return useContext(UniformCompositionContext);
+}
+function UniformComposition({
+  data,
+  behaviorTracking = "onView",
+  children,
+  resolveRenderer,
+  contextualEditingEnhancer
+}) {
+  const { composition, isContextualEditing } = useUniformContextualEditing({
+    initialCompositionValue: data,
+    enhance: contextualEditingEnhancer
+  });
+  return /* @__PURE__ */ React3.createElement(
+    UniformCompositionContext.Provider,
+    {
+      value: { data: composition, behaviorTracking, resolveRenderer, isContextualEditing }
+    },
+    /* @__PURE__ */ React3.createElement(ContextualEditingComponentWrapper, { component: composition }, /* @__PURE__ */ React3.createElement(
+      UniformComponent,
+      {
+        data: composition,
+        behaviorTracking,
+        resolveRenderer
+      },
+      children
+    ))
+  );
+}
+var useComposition = useUniformCurrentComposition;
+var Composition = UniformComposition;
+
+// src/components/ContextualEditingComponentWrapper.tsx
+function ContextualEditingComponentWrapper({
+  component,
+  parentComponent,
+  slotName,
+  indexInSlot,
+  slotChildrenCount,
+  emptyPlaceholder,
+  children
+}) {
+  var _a, _b, _c, _d;
+  const isPlaceholder = (component == null ? void 0 : component._id) === PLACEHOLDER_ID;
+  const { isContextualEditing } = useUniformCurrentComposition();
+  return !isContextualEditing ? /* @__PURE__ */ React4.createElement(React4.Fragment, null, children) : /* @__PURE__ */ React4.createElement(React4.Fragment, null, /* @__PURE__ */ React4.createElement(
+    "script",
+    {
+      "data-role": IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+      "data-parent-id": parentComponent == null ? void 0 : parentComponent._id,
+      "data-parent-type": parentComponent == null ? void 0 : parentComponent.type,
+      "data-component-id": component == null ? void 0 : component._id,
+      "data-slot-name": slotName != null ? slotName : "",
+      "data-component-index": indexInSlot != null ? indexInSlot : "",
+      "data-total-components": slotChildrenCount != null ? slotChildrenCount : "",
+      "data-component-name": component == null ? void 0 : component.type,
+      "data-is-placeholder": isPlaceholder ? "true" : void 0,
+      "data-is-localized": ((_a = component == null ? void 0 : component.parameters) == null ? void 0 : _a[CANVAS_LOCALE_TAG_PARAM]) ? "true" : void 0,
+      "data-component-title": (_d = (_c = (_b = component == null ? void 0 : component.parameters) == null ? void 0 : _b.title) == null ? void 0 : _c.value) != null ? _d : ""
+    }
+  ), isPlaceholder && emptyPlaceholder !== void 0 ? emptyPlaceholder : children, /* @__PURE__ */ React4.createElement("script", { "data-role": IN_CONTEXT_EDITOR_COMPONENT_END_ROLE }));
+}
+
 // src/components/UniformSlot.tsx
 function UniformSlot({
   name,
@@ -182,9 +352,9 @@ function UniformSlot({
       emptyPlaceholder
     });
     const elements = children ? children({ child, component, key: `wrapped-inner-${index}` }) : child;
-    return React3.createElement(React3.Fragment, { key: index }, elements);
+    return React5.createElement(React5.Fragment, { key: index }, elements);
   });
-  return React3.createElement(React3.Fragment, void 0, finalChildren);
+  return React5.createElement(React5.Fragment, void 0, finalChildren);
 }
 function renderComponent({
   component,
@@ -197,14 +367,13 @@ function renderComponent({
   slotChildrenCount,
   emptyPlaceholder
 }) {
-  var _a, _b, _c, _d;
   const RenderComponent = resolveRenderer == null ? void 0 : resolveRenderer(component);
   if (component.type === CANVAS_TEST_TYPE) {
     return resolveSystem.test(
       component,
       key,
       (variantComponent, key2) => {
-        var _a2, _b2;
+        var _a, _b;
         return renderComponent({
           component: variantComponent,
           resolveRenderer,
@@ -212,8 +381,8 @@ function renderComponent({
           key: key2,
           parentComponent: component,
           slotName: CANVAS_TEST_SLOT,
-          slotChildrenCount: (_a2 = component == null ? void 0 : component.slots) == null ? void 0 : _a2[CANVAS_TEST_SLOT].length,
-          indexInSlot: (_b2 = component == null ? void 0 : component.slots) == null ? void 0 : _b2[CANVAS_TEST_SLOT].findIndex(
+          slotChildrenCount: (_a = component == null ? void 0 : component.slots) == null ? void 0 : _a[CANVAS_TEST_SLOT].length,
+          indexInSlot: (_b = component == null ? void 0 : component.slots) == null ? void 0 : _b[CANVAS_TEST_SLOT].findIndex(
             ({ _id }) => variantComponent._id === _id
           )
         });
@@ -224,7 +393,7 @@ function renderComponent({
       component,
       key,
       (variantComponent, key2) => {
-        var _a2, _b2;
+        var _a, _b;
         return renderComponent({
           component: variantComponent,
           resolveRenderer,
@@ -232,8 +401,8 @@ function renderComponent({
           key: key2,
           parentComponent: component,
           slotName: CANVAS_PERSONALIZE_SLOT,
-          slotChildrenCount: (_a2 = component == null ? void 0 : component.slots) == null ? void 0 : _a2[CANVAS_PERSONALIZE_SLOT].length,
-          indexInSlot: (_b2 = component == null ? void 0 : component.slots) == null ? void 0 : _b2[CANVAS_PERSONALIZE_SLOT].findIndex(
+          slotChildrenCount: (_a = component == null ? void 0 : component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT].length,
+          indexInSlot: (_b = component == null ? void 0 : component.slots) == null ? void 0 : _b[CANVAS_PERSONALIZE_SLOT].findIndex(
             ({ _id }) => variantComponent._id === _id
           )
         });
@@ -241,25 +410,18 @@ function renderComponent({
     );
   } else if (RenderComponent) {
     const props = convertComponentToProps(component);
-    const shouldRenderContextualEditingTags = Boolean(component._id);
-    const isPlaceholder = component._id === PLACEHOLDER_ID;
-    return /* @__PURE__ */ React3.createElement(UniformComponent, { key, data: component, resolveRenderer }, !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React3.createElement(
-      "script",
+    return /* @__PURE__ */ React5.createElement(UniformComponent, { key, data: component, resolveRenderer }, /* @__PURE__ */ React5.createElement(
+      ContextualEditingComponentWrapper,
       {
-        key,
-        "data-role": IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
-        "data-parent-id": parentComponent == null ? void 0 : parentComponent._id,
-        "data-parent-type": parentComponent == null ? void 0 : parentComponent.type,
-        "data-component-id": component._id,
-        "data-slot-name": slotName != null ? slotName : "",
-        "data-component-index": indexInSlot != null ? indexInSlot : "",
-        "data-total-components": slotChildrenCount != null ? slotChildrenCount : "",
-        "data-component-name": component.type,
-        "data-is-placeholder": isPlaceholder ? "true" : void 0,
-        "data-is-localized": ((_a = component.parameters) == null ? void 0 : _a[CANVAS_LOCALE_TAG_PARAM]) ? "true" : void 0,
-        "data-component-title": (_d = (_c = (_b = component.parameters) == null ? void 0 : _b.title) == null ? void 0 : _c.value) != null ? _d : ""
-      }
-    ), isPlaceholder && emptyPlaceholder !== void 0 ? emptyPlaceholder : /* @__PURE__ */ React3.createElement(RenderComponent, { ...props }), !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React3.createElement("script", { "data-role": "component-end" }));
+        component,
+        parentComponent,
+        slotName,
+        indexInSlot,
+        slotChildrenCount,
+        emptyPlaceholder
+      },
+      /* @__PURE__ */ React5.createElement(RenderComponent, { ...props })
+    ));
   } else if (process.env.NODE_ENV !== "production") {
     console.warn(
       `[canvas] found component of type '${component.type}'${component.variant ? ` with variant '${component.variant}'` : ""}. Nothing will be rendered. Check your resolveRenderer function or add registerUniformComponent to your component.
@@ -269,11 +431,12 @@ function renderComponent({
   }
   return null;
 }
+var Slot = UniformSlot;
 
 // src/components/UniformComponent.tsx
-var UniformComponentContext = createContext({});
+var UniformComponentContext = createContext2({});
 function useUniformCurrentComponent() {
-  return useContext(UniformComponentContext);
+  return useContext2(UniformComponentContext);
 }
 function UniformComponent({
   data,
@@ -303,9 +466,9 @@ function UniformComponent({
     hasParentLayout: Boolean(parentData.data),
     resolveRenderer: contextValue.resolveRenderer
   });
-  return /* @__PURE__ */ React4.createElement(UniformComponentContext.Provider, { value: contextValue }, contextContextProviderPresent ? (
+  return /* @__PURE__ */ React6.createElement(UniformComponentContext.Provider, { value: contextValue }, contextContextProviderPresent ? (
     /* auto-track behavior signals when in a Canvas context */
-    /* @__PURE__ */ React4.createElement(TrackComponent, { behavior: enrichmentTags }, resolvedChildren)
+    /* @__PURE__ */ React6.createElement(TrackComponent, { behavior: enrichmentTags }, resolvedChildren)
   ) : resolvedChildren);
 }
 function resolveChildren({
@@ -318,131 +481,20 @@ function resolveChildren({
   if (!children && !hasParentLayout) {
     const topLevelComponent = resolveRenderer({ type: data.type });
     if (topLevelComponent) {
-      children = React4.createElement(topLevelComponent, convertComponentToProps(data));
+      children = React6.createElement(topLevelComponent, convertComponentToProps(data));
     } else {
       if (Object.keys((_a = data.slots) != null ? _a : {}).length > 1 && process.env.NODE_ENV === "development") {
         console.warn(
-          `[canvas-dev] All the slots in component '${data.type}' are rendered in no particular order. Use '<UniformSlot name={slotName} />' to reliably render the slots.`
+          `[canvas-dev] All the slots in component '${data.type}' are rendered in no particular order. Use '<Slot name={slotName} />' to reliably render the slots.`
         );
       }
-      children = Object.keys(data.slots || {}).map((slotName) => /* @__PURE__ */ React4.createElement(UniformSlot, { key: slotName, name: slotName }));
+      children = Object.keys(data.slots || {}).map((slotName) => /* @__PURE__ */ React6.createElement(UniformSlot, { key: slotName, name: slotName }));
     }
   }
   const renderChildren = typeof children === "function" ? children(convertComponentToProps(data)) : children;
   return renderChildren;
 }
 
-// src/components/UniformComposition.tsx
-import React5, { createContext as createContext2, useContext as useContext2 } from "react";
-
-// src/hooks/useUniformContextualEditing.ts
-import {
-  createCanvasChannel,
-  createUniformApiEnhancer,
-  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
-  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
-  isUpdateCompositionMessage
-} from "@uniformdev/canvas";
-import { useEffect, useMemo, useState } from "react";
-var registeredCompositionIds = /* @__PURE__ */ new Set();
-var useUniformContextualEditing = ({
-  initialCompositionValue,
-  enhance = (message) => message.composition
-}) => {
-  const [contextualComposition, setContextualComposition] = useState();
-  const channel = useMemo(() => {
-    var _a;
-    if (!isInContextEditingMode()) {
-      return;
-    }
-    const channel2 = createCanvasChannel({
-      broadcastTo: [(_a = window.opener) != null ? _a : window.top],
-      listenTo: [window]
-    });
-    return channel2;
-  }, []);
-  useEffect(() => {
-    if (!channel || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
-      return;
-    }
-    const unsubscribe = channel.on("update-composition", async (message) => {
-      if (!isUpdateCompositionMessage(message)) {
-        return;
-      }
-      const enhancedComposition = await enhance(message);
-      setContextualComposition(enhancedComposition);
-    });
-    registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
-    return () => {
-      unsubscribe();
-      registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
-    };
-  }, [channel, enhance, initialCompositionValue == null ? void 0 : initialCompositionValue._id]);
-  useEffect(() => {
-    if (!isInContextEditingMode()) {
-      return;
-    }
-    const existingScript = document.getElementById(IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID);
-    if (existingScript) {
-      return;
-    }
-    window.__UNIFORM_CONTEXTUAL_EDITING__ = {
-      framework: "React"
-    };
-    const script = document.createElement("script");
-    script.id = IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
-    script.src = getCanvasInContextEmbedScriptUrl();
-    script.async = true;
-    document.head.appendChild(script);
-  }, []);
-  return {
-    composition: contextualComposition != null ? contextualComposition : initialCompositionValue
-  };
-};
-function getCanvasInContextEmbedScriptUrl() {
-  const scriptUrl = `${window.document.referrer}files/canvas-in-context-embed/index.js`;
-  return scriptUrl;
-}
-function isInContextEditingMode() {
-  if (typeof window === "undefined") {
-    return false;
-  }
-  const isOpenedByInContextEditor = new URLSearchParams(window.location.search).has(
-    IN_CONTEXT_EDITOR_QUERY_STRING_PARAM
-  );
-  const isAllowlistedReferrer = Boolean(
-    window.document.referrer.match(/(^https:\/\/|\.)(uniform.app|uniform.wtf|localhost:\d{4})\//)
-  );
-  return isOpenedByInContextEditor && isAllowlistedReferrer;
-}
-
-// src/components/UniformComposition.tsx
-var UniformCompositionContext = createContext2({ data: void 0 });
-function useUniformCurrentComposition() {
-  return useContext2(UniformCompositionContext);
-}
-function UniformComposition({
-  data,
-  behaviorTracking = "onView",
-  children,
-  resolveRenderer,
-  contextualEditingEnhancer
-}) {
-  const { composition } = useUniformContextualEditing({
-    initialCompositionValue: data,
-    enhance: contextualEditingEnhancer
-  });
-  return /* @__PURE__ */ React5.createElement(UniformCompositionContext.Provider, { value: { data: composition, behaviorTracking, resolveRenderer } }, /* @__PURE__ */ React5.createElement(
-    UniformComponent,
-    {
-      data: composition,
-      behaviorTracking,
-      resolveRenderer
-    },
-    children
-  ));
-}
-
 // src/hooks/useCompositionEventEffect.ts
 import {
   CANVAS_DRAFT_STATE,
@@ -483,18 +535,23 @@ function useCompositionEventEffect({
   }, [compositionId, enabled, projectId, effect]);
 }
 export {
+  Composition,
   DefaultNotImplementedComponent,
   NOT_IMPLEMENTED_COMPONENT,
+  Slot,
   UniformComponent,
   UniformComposition,
   UniformSlot,
   componentStore,
   componentStoreResolver,
+  createApiEnhancer,
   createComponentStore,
   createComponentStoreResolver,
   createUniformApiEnhancer,
   registerUniformComponent,
+  useComposition,
   useCompositionEventEffect,
+  useContextualEditing,
   useUniformContextualEditing,
   useUniformCurrentComponent,
   useUniformCurrentComposition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-react",
-  "version": "18.33.1-alpha.7+7127237a1",
+  "version": "18.34.0",
   "description": "React SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -24,9 +24,9 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.33.1-alpha.7+7127237a1",
-    "@uniformdev/context": "18.33.1-alpha.7+7127237a1",
-    "@uniformdev/context-react": "18.33.1-alpha.7+7127237a1"
+    "@uniformdev/canvas": "18.34.0",
+    "@uniformdev/context": "18.34.0",
+    "@uniformdev/context-react": "18.34.0"
   },
   "peerDependencies": {
     "react": ">= 16 || 17 || 18",
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7127237a1e099d2a11fa8c06d49cb01cf16c0852"
+  "gitHead": "563ab31aa4308102c988bea321028e73efe836d0"
 }