@uniformdev/canvas-react 18.0.1-alpha.7 → 18.1.2-alpha.4

package/dist/index.mjs

@@ -1,7 +1,42 @@
-// src/components/Composition.tsx
-import { CANVAS_ENRICHMENT_TAG_PARAM } from "@uniformdev/canvas";
+// src/components/DefaultNotImplementedComponent.tsx
+import { CANVAS_LOCALIZATION_TYPE } from "@uniformdev/canvas";
+import React from "react";
+var wrapperStyles = {
+  borderLeft: "4px solid #e42535",
+  padding: "16px",
+  fontSize: "16px",
+  borderRadius: "0 8px 8px 0",
+  margin: "8px",
+  backgroundColor: "rgba(255, 255, 255, 0.45)",
+  color: "#1d3557"
+};
+function DefaultNotImplementedComponent(props) {
+  var _a;
+  const componentType = (_a = props.component) == null ? void 0 : _a.type;
+  if (!componentType) {
+    return null;
+  }
+  if (componentType === CANVAS_LOCALIZATION_TYPE) {
+    return /* @__PURE__ */ React.createElement("div", { style: wrapperStyles }, /* @__PURE__ */ React.createElement("p", null, "Seems like localization is not enabled in your application. Please read our documentation on how to", " ", /* @__PURE__ */ React.createElement(
+      "a",
+      {
+        href: "https://docs.uniform.app/guides/composition/localization#activate-front-end",
+        target: "_blank",
+        style: { fontWeight: "bolder", textDecoration: "underline" },
+        rel: "noreferrer"
+      },
+      "enable localization in your front-end application."
+    )));
+  }
+  return /* @__PURE__ */ React.createElement("div", { style: wrapperStyles }, /* @__PURE__ */ React.createElement("h2", null, "Component: ", /* @__PURE__ */ React.createElement("code", null, componentType)), /* @__PURE__ */ React.createElement("p", null, /* @__PURE__ */ React.createElement("code", null, /* @__PURE__ */ React.createElement("strong", null, componentType)), " ", "has no React implementation. It may need to be added to your ", /* @__PURE__ */ React.createElement("code", null, "resolveRenderer()"), " function."), /* @__PURE__ */ React.createElement("details", null, /* @__PURE__ */ React.createElement("summary", { style: { cursor: "pointer" } }, "Props"), /* @__PURE__ */ React.createElement("pre", null, JSON.stringify(props, null, 2))));
+}
+
+// src/components/UniformComponent.tsx
+import {
+  CANVAS_ENRICHMENT_TAG_PARAM
+} from "@uniformdev/canvas";
 import { Track, TrackFragment, useUniformContext } from "@uniformdev/context-react";
-import React3, { createContext, useContext } from "react";
+import React4, { createContext, useContext } from "react";
 
 // src/convertComponentToProps.ts
 function convertComponentToProps(component) {
@@ -61,7 +96,7 @@ var componentStoreResolver = createComponentStoreResolver({
   store: componentStore
 });
 
-// src/components/Slot.tsx
+// src/components/UniformSlot.tsx
 import {
   CANVAS_LOCALE_TAG_PARAM,
   CANVAS_PERSONALIZE_TYPE,
@@ -69,7 +104,7 @@ import {
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   PLACEHOLDER_ID
 } from "@uniformdev/canvas";
-import React2 from "react";
+import React3 from "react";
 
 // src/defaultSystemComponentResolver.tsx
 import {
@@ -77,7 +112,7 @@ import {
   mapSlotToTestVariations
 } from "@uniformdev/canvas";
 import { Personalize, Test } from "@uniformdev/context-react";
-import * as React from "react";
+import * as React2 from "react";
 var defaultSystemComponentResolver = {
   test: (component, key, renderChild) => {
     var _a, _b, _c, _d, _e;
@@ -85,7 +120,7 @@ var defaultSystemComponentResolver = {
     const variants = (_b = (_a = testComponent.slots) == null ? void 0 : _a.test) != null ? _b : [];
     const testName = (_e = (_d = (_c = testComponent.parameters) == null ? void 0 : _c.test) == null ? void 0 : _d.value) != null ? _e : "Untitled Test";
     const finalVariants = mapSlotToTestVariations(variants);
-    return /* @__PURE__ */ React.createElement(
+    return /* @__PURE__ */ React2.createElement(
       Test,
       {
         key,
@@ -99,7 +134,7 @@ var defaultSystemComponentResolver = {
     var _a, _b, _c, _d, _e, _f, _g;
     const pzComponent = component;
     const processedVariants = mapSlotToPersonalizedVariations((_a = pzComponent == null ? void 0 : pzComponent.slots) == null ? void 0 : _a.pz);
-    return /* @__PURE__ */ React.createElement(
+    return /* @__PURE__ */ React2.createElement(
       Personalize,
       {
         key,
@@ -112,28 +147,24 @@ var defaultSystemComponentResolver = {
   }
 };
 
-// src/components/Slot.tsx
-function Slot({
+// src/components/UniformSlot.tsx
+function UniformSlot({
   name,
   resolveRenderer,
   children,
   emptyPlaceholder
 }) {
   var _a;
-  const compositionContext = useComposition();
-  if (!(compositionContext == null ? void 0 : compositionContext.composition)) {
-    throw new Error("Slot must be rendered within a Composition");
-  }
-  const { composition: layout, resolveRenderer: parentResolveRenderer } = compositionContext;
-  if (!layout) {
-    throw new Error("Cannot use Slot without a Composition wrapper.");
+  const { data: parentData, resolveRenderer: parentResolveRenderer } = useUniformCurrentComponent();
+  if (!parentData) {
+    throw new Error("Cannot use Slot without a <UniformComponent /> wrapper.");
   }
-  const slot = (_a = layout.slots) == null ? void 0 : _a[name];
+  const slot = (_a = parentData.slots) == null ? void 0 : _a[name];
   if (!slot || !Array.isArray(slot)) {
     if (process.env.NODE_ENV === "development") {
       console.warn(
         `[canvas-dev] slot '${name}' was rendered, but it was not defined on its component. This is expected if the slot is optional, otherwise it may indicate a typo. Component:`,
-        layout
+        parentData
       );
     }
     return null;
@@ -148,14 +179,14 @@ function Slot({
       key: `inner-${index}`,
       indexInSlot: index,
       slotName: name,
-      parentComponent: layout,
+      parentComponent: parentData,
       slotChildrenCount: slot.length,
       emptyPlaceholder
     });
     const elements = children ? children({ child, component, key: `wrapped-inner-${index}` }) : child;
-    return React2.createElement(React2.Fragment, { key: index }, elements);
+    return React3.createElement(React3.Fragment, { key: index }, elements);
   });
-  return React2.createElement(React2.Fragment, void 0, finalChildren);
+  return React3.createElement(React3.Fragment, void 0, finalChildren);
 }
 function renderComponent({
   component,
@@ -186,7 +217,7 @@ function renderComponent({
     const props = convertComponentToProps(component);
     const shouldRenderContextualEditingTags = Boolean(component._id);
     const isPlaceholder = component._id === PLACEHOLDER_ID;
-    return /* @__PURE__ */ React2.createElement(Composition, { key, data: component, resolveRenderer }, !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React2.createElement(
+    return /* @__PURE__ */ React3.createElement(UniformComponent, { key, data: component, resolveRenderer }, !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React3.createElement(
       "script",
       {
         key,
@@ -202,7 +233,7 @@ function renderComponent({
         "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__ */ React2.createElement(RenderComponent, { ...props }), !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React2.createElement("script", { "data-role": "component-end" }));
+    ), isPlaceholder && emptyPlaceholder !== void 0 ? emptyPlaceholder : /* @__PURE__ */ React3.createElement(RenderComponent, { ...props }), !shouldRenderContextualEditingTags ? null : /* @__PURE__ */ React3.createElement("script", { "data-role": "component-end" }));
   } else if (process.env.NODE_ENV !== "production") {
     console.warn(
       `[canvas] found component of type '${component.type}' which the resolveRenderer prop returned no component for. Nothing will be rendered. The resolveRenderer function may need to be extended to handle the new type.`,
@@ -211,44 +242,45 @@ function renderComponent({
   }
   return null;
 }
+var Slot = UniformSlot;
 
-// src/components/Composition.tsx
-var CompositionContext = createContext(void 0);
-function useComposition() {
-  return useContext(CompositionContext);
+// src/components/UniformComponent.tsx
+var UniformComponentContext = createContext({});
+function useUniformCurrentComponent() {
+  return useContext(UniformComponentContext);
 }
 var componentStoreResolver2 = (component) => {
   const resolved = componentStore.get(component.type);
   return resolved || null;
 };
-function Composition({
+function UniformComponent({
   data,
   resolveRenderer,
   children,
   behaviorTracking
 }) {
   var _a, _b, _c;
-  const parentLayout = useComposition();
+  const parentData = useUniformCurrentComponent();
   const contextContextProviderPresent = useUniformContext({ throwOnMissingProvider: false }) !== void 0;
   if (!data) {
     if (process.env.NODE_ENV === "development") {
-      console.warn(`[canvas-dev] Composition was rendered with no data, nothing will be output.`);
+      console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
     }
     return null;
   }
-  const context = {
-    composition: data,
-    resolveRenderer: resolveRenderer || (parentLayout == null ? void 0 : parentLayout.resolveRenderer) || componentStoreResolver2,
-    behaviorTracking: (_a = behaviorTracking != null ? behaviorTracking : parentLayout == null ? void 0 : parentLayout.behaviorTracking) != null ? _a : "onView"
+  const contextValue = {
+    data,
+    resolveRenderer: resolveRenderer || (parentData == null ? void 0 : parentData.resolveRenderer) || componentStoreResolver2,
+    behaviorTracking: (_a = behaviorTracking != null ? behaviorTracking : parentData == null ? void 0 : parentData.behaviorTracking) != null ? _a : "onView"
   };
   const enrichmentTags = (_c = (_b = data.parameters) == null ? void 0 : _b[CANVAS_ENRICHMENT_TAG_PARAM]) == null ? void 0 : _c.value;
-  const TrackComponent = context.behaviorTracking === "onLoad" ? TrackFragment : Track;
+  const TrackComponent = contextValue.behaviorTracking === "onLoad" ? TrackFragment : Track;
   const resolvedChildren = resolveChildren({
     children,
     data,
-    hasParentLayout: Boolean(parentLayout)
+    hasParentLayout: Boolean(parentData)
   });
-  return /* @__PURE__ */ React3.createElement(CompositionContext.Provider, { value: context }, contextContextProviderPresent ? /* @__PURE__ */ React3.createElement(TrackComponent, { behavior: enrichmentTags }, resolvedChildren) : resolvedChildren);
+  return /* @__PURE__ */ React4.createElement(UniformComponentContext.Provider, { value: contextValue }, contextContextProviderPresent ? /* @__PURE__ */ React4.createElement(TrackComponent, { behavior: enrichmentTags }, resolvedChildren) : resolvedChildren);
 }
 function resolveChildren({
   children,
@@ -256,126 +288,38 @@ function resolveChildren({
   hasParentLayout
 }) {
   var _a;
-  let compositionChildren = children;
-  if (!compositionChildren && !hasParentLayout) {
+  if (!children && !hasParentLayout) {
     const rootComponent = componentStore.get(data.type);
     if (rootComponent) {
-      compositionChildren = React3.createElement(rootComponent, convertComponentToProps(data));
+      children = React4.createElement(rootComponent, 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 '<Slot name={slotName} />' to reliably render the slots.`
         );
       }
-      compositionChildren = Object.keys(data.slots || {}).map((slotName) => /* @__PURE__ */ React3.createElement(Slot, { key: slotName, name: slotName }));
+      children = Object.keys(data.slots || {}).map((slotName) => /* @__PURE__ */ React4.createElement(UniformSlot, { key: slotName, name: slotName }));
     }
   }
-  const renderChildren = typeof compositionChildren === "function" ? compositionChildren(convertComponentToProps(data)) : compositionChildren;
+  const renderChildren = typeof children === "function" ? children(convertComponentToProps(data)) : children;
   return renderChildren;
 }
 
-// src/components/DefaultNotImplementedComponent.tsx
-import { CANVAS_LOCALIZATION_TYPE } from "@uniformdev/canvas";
-import React4 from "react";
-var wrapperStyles = {
-  borderLeft: "4px solid #e42535",
-  padding: "16px",
-  fontSize: "16px",
-  borderRadius: "0 8px 8px 0",
-  margin: "8px",
-  backgroundColor: "rgba(255, 255, 255, 0.45)",
-  color: "#1d3557"
-};
-function DefaultNotImplementedComponent(props) {
-  var _a;
-  const componentType = (_a = props.component) == null ? void 0 : _a.type;
-  if (!componentType) {
-    return null;
-  }
-  if (componentType === CANVAS_LOCALIZATION_TYPE) {
-    return /* @__PURE__ */ React4.createElement("div", { style: wrapperStyles }, /* @__PURE__ */ React4.createElement("p", null, "Seems like localization is not enabled in your application. Please read our documentation on how to", " ", /* @__PURE__ */ React4.createElement(
-      "a",
-      {
-        href: "https://docs.uniform.app/guides/composition/localization#activate-front-end",
-        target: "_blank",
-        style: { fontWeight: "bolder", textDecoration: "underline" },
-        rel: "noreferrer"
-      },
-      "enable localization in your front-end application."
-    )));
-  }
-  return /* @__PURE__ */ React4.createElement("div", { style: wrapperStyles }, /* @__PURE__ */ React4.createElement("h2", null, "Component: ", /* @__PURE__ */ React4.createElement("code", null, componentType)), /* @__PURE__ */ React4.createElement("p", null, /* @__PURE__ */ React4.createElement("code", null, /* @__PURE__ */ React4.createElement("strong", null, componentType)), " ", "has no React implementation. It may need to be added to your ", /* @__PURE__ */ React4.createElement("code", null, "resolveRenderer()"), " function."), /* @__PURE__ */ React4.createElement("details", null, /* @__PURE__ */ React4.createElement("summary", { style: { cursor: "pointer" } }, "Props"), /* @__PURE__ */ React4.createElement("pre", null, JSON.stringify(props, null, 2))));
-}
+// src/components/UniformComposition.tsx
+import React5, { createContext as createContext2, useContext as useContext2 } from "react";
 
-// src/hooks/useCompositionEventEffect.ts
-import {
-  CANVAS_DRAFT_STATE,
-  createEventBus,
-  subscribeToComposition
-} from "@uniformdev/canvas";
-import { useEffect } from "react";
-function useCompositionEventEffect({
-  enabled,
-  projectId,
-  compositionId,
-  effect
-}) {
-  useEffect(() => {
-    if (!enabled || !compositionId || !projectId) {
-      return;
-    }
-    let goodbye = void 0;
-    const loadEffect = async () => {
-      const eventBus = await createEventBus();
-      if (eventBus) {
-        goodbye = subscribeToComposition({
-          eventBus,
-          compositionId,
-          compositionState: CANVAS_DRAFT_STATE,
-          projectId,
-          callback: effect,
-          event: "updated"
-        });
-      }
-    };
-    loadEffect();
-    return () => {
-      if (goodbye) {
-        goodbye();
-      }
-    };
-  }, [compositionId, enabled, projectId, effect]);
-}
-
-// src/hooks/useContextualEditing.ts
+// 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 as useEffect2, useMemo, useState } from "react";
-var previewScriptId = "uniform-canvas-preview-script";
-var createApiEnhancer = ({ apiUrl }) => {
-  return async (message) => {
-    const response = await fetch(apiUrl, {
-      method: "post",
-      body: JSON.stringify({
-        composition: message.composition,
-        hash: message.hash
-      }),
-      headers: {
-        "Content-Type": "application/json"
-      }
-    });
-    const json = await response.json();
-    if (!response.ok) {
-      throw new Error("Error reading enhanced composition");
-    }
-    const body = json;
-    return body.composition;
-  };
-};
-var useContextualEditing = ({
+import { useEffect, useMemo, useState } from "react";
+var createApiEnhancer = createUniformApiEnhancer;
+var registeredCompositionIds = /* @__PURE__ */ new Set();
+var useUniformContextualEditing = ({
   initialCompositionValue,
   enhance = (message) => message.composition
 }) => {
@@ -391,30 +335,33 @@ var useContextualEditing = ({
     });
     return channel2;
   }, []);
-  useEffect2(() => {
-    if (!channel) {
+  useEffect(() => {
+    if (!channel || registeredCompositionIds.has(initialCompositionValue._id)) {
       return;
     }
     const unsubscribe = channel.on("update-composition", async (message) => {
-      if (isUpdateCompositionMessage(message)) {
-        const composition = await enhance(message);
-        setContextualComposition(composition);
+      if (!isUpdateCompositionMessage(message)) {
+        return;
       }
+      const enhancedComposition = await enhance(message);
+      setContextualComposition(enhancedComposition);
     });
+    registeredCompositionIds.add(initialCompositionValue._id);
     return () => {
       unsubscribe();
+      registeredCompositionIds.delete(initialCompositionValue._id);
     };
-  }, [channel, enhance]);
-  useEffect2(() => {
+  }, [channel, enhance, initialCompositionValue._id]);
+  useEffect(() => {
     if (!isInContextEditingMode()) {
       return;
     }
-    const existingScript = document.getElementById(previewScriptId);
+    const existingScript = document.getElementById(IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID);
     if (existingScript) {
       return;
     }
     const script = document.createElement("script");
-    script.id = previewScriptId;
+    script.id = IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
     script.src = getCanvasInContextEmbedScriptUrl();
     script.async = true;
     document.head.appendChild(script);
@@ -439,17 +386,92 @@ function isInContextEditingMode() {
   );
   return isOpenedByInContextEditor && isAllowlistedReferrer;
 }
+
+// src/components/UniformComposition.tsx
+var UniformCompositionContext = createContext2({});
+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
+  ));
+}
+var useComposition = useUniformCurrentComposition;
+var Composition = UniformComposition;
+
+// src/hooks/useCompositionEventEffect.ts
+import {
+  CANVAS_DRAFT_STATE,
+  createEventBus,
+  subscribeToComposition
+} from "@uniformdev/canvas";
+import { useEffect as useEffect2 } from "react";
+function useCompositionEventEffect({
+  enabled,
+  projectId,
+  compositionId,
+  effect
+}) {
+  useEffect2(() => {
+    if (!enabled || !compositionId || !projectId) {
+      return;
+    }
+    let goodbye = void 0;
+    const loadEffect = async () => {
+      const eventBus = await createEventBus();
+      if (eventBus) {
+        goodbye = subscribeToComposition({
+          eventBus,
+          compositionId,
+          compositionState: CANVAS_DRAFT_STATE,
+          projectId,
+          callback: effect,
+          event: "updated"
+        });
+      }
+    };
+    loadEffect();
+    return () => {
+      if (goodbye) {
+        goodbye();
+      }
+    };
+  }, [compositionId, enabled, projectId, effect]);
+}
 export {
   Composition,
   DefaultNotImplementedComponent,
   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.0.1-alpha.7+919e1112a",
+  "version": "18.1.2-alpha.4+e9d268bce",
   "description": "React SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -23,16 +23,16 @@
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\""
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.0.1-alpha.7+919e1112a",
-    "@uniformdev/context": "18.0.1-alpha.7+919e1112a",
-    "@uniformdev/context-react": "18.0.1-alpha.7+919e1112a"
+    "@uniformdev/canvas": "18.1.2-alpha.4+e9d268bce",
+    "@uniformdev/context": "18.1.2-alpha.4+e9d268bce",
+    "@uniformdev/context-react": "18.1.2-alpha.4+e9d268bce"
   },
   "peerDependencies": {
-    "react": ">= 16",
+    "react": ">= 16 || 17 || 18",
     "react-dom": ">=16"
   },
   "devDependencies": {
-    "@types/react": "18.0.26",
+    "@types/react": "18.0.27",
     "react": "18.2.0",
     "react-dom": "18.2.0"
   },
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "919e1112a0e44600072a7309798a55bcf70fc0ed"
+  "gitHead": "e9d268bcef28fc22632f4968ca988e3b0b92d146"
 }