@uniformdev/canvas-vue 18.5.0 → 18.7.0

package/dist/index.d.ts

@@ -1,9 +1,8 @@
 import * as vue_demi from 'vue-demi';
 import { PropType, ConcreteComponent, Ref } from 'vue-demi';
-import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { ComponentInstance, ComponentParameter, RootComponentInstance, UpdateCompositionMessage, SubscribeToCompositionOptions } from '@uniformdev/canvas';
 export { createUniformApiEnhancer } from '@uniformdev/canvas';
-import * as _uniformdev_canvas_dist_createEventBus_db0afea5 from '@uniformdev/canvas/dist/createEventBus-db0afea5';
+import * as _uniformdev_canvas_dist_createEventBus_60ff8dc4 from '@uniformdev/canvas/dist/createEventBus-60ff8dc4';
 
 type DefaultNotImplementedComponentProps = {
     component: ComponentInstance;
@@ -60,7 +59,7 @@ type UniformCurrentComponent = {
 declare const useUniformCurrentComponent: () => UniformCurrentComponent;
 type UniformComponentProps = {
     /** A dynamic vue component that provides data to the Uniform Canvas SlotContent component via provide/inject */
-    data: ComponentInstance | RootComponentInstance;
+    data?: ComponentInstance | RootComponentInstance;
     /** Resolves a Vue component to render a Canvas component, generally by inspecting type/variant */
     resolveRenderer?: ResolveRenderer;
     /**
@@ -154,8 +153,7 @@ declare const UniformComponent: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        } | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -242,8 +240,7 @@ declare const UniformComponent: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        } | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -333,7 +330,7 @@ declare const createApiEnhancer: ({ apiUrl }: {
     } | undefined;
 }>;
 type UseUniformContextualEditingProps = {
-    initialCompositionValue: RootComponentInstance;
+    initialCompositionValue?: RootComponentInstance;
     /**
      * A function to enhance the composition after receiving it from Canvas editor.
      * WARNING: This enhancer will run on the client side. Make sure you're not exposing any secrets.
@@ -418,7 +415,7 @@ declare const useUniformContextualEditing: ({ initialCompositionValue, enhance,
                 } | undefined;
             };
         } | undefined;
-    }>;
+    } | undefined>;
 };
 
 /** @deprecated use useUniformContextualEditing instead */
@@ -495,18 +492,18 @@ declare const useContextualEditing: ({ initialCompositionValue, enhance, }: UseU
                 } | undefined;
             };
         } | undefined;
-    }>;
+    } | undefined>;
 };
 /** @deprecated use UseUniformContextualEditingProps instead */
 type UseContextualEditingProps = UseUniformContextualEditingProps;
 
 type UniformCompositionProps = UniformComponentProps & {
     /** The composition data */
-    data: RootComponentInstance;
+    data?: RootComponentInstance;
     contextualEditingEnhancer?: UseUniformContextualEditingProps['enhance'];
 };
 type UniformCurrentComposition = {
-    data?: UniformCompositionProps['data'];
+    data: UniformCompositionProps['data'] | undefined;
     resolveRenderer?: UniformCompositionProps['resolveRenderer'];
     behaviorTracking?: UniformCompositionProps['behaviorTracking'];
 };
@@ -521,7 +518,7 @@ declare const useUniformCurrentComposition: () => UniformCurrentComposition;
  */
 declare const UniformComposition: vue_demi.DefineComponent<{
     data: {
-        type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
+        type: PropType<((_uniformdev_canvas_dist_createEventBus_60ff8dc4.p | {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -665,8 +662,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        }) | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -676,7 +672,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
         default: string;
     };
     contextualEditingEnhancer: {
-        type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
+        type: PropType<((compositionUpdateMessage: _uniformdev_canvas_dist_createEventBus_60ff8dc4.U) => {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -826,7 +822,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
     [key: string]: any;
 }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
     data: {
-        type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
+        type: PropType<((_uniformdev_canvas_dist_createEventBus_60ff8dc4.p | {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -970,8 +966,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        }) | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -981,7 +976,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
         default: string;
     };
     contextualEditingEnhancer: {
-        type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
+        type: PropType<((compositionUpdateMessage: _uniformdev_canvas_dist_createEventBus_60ff8dc4.U) => {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -1133,7 +1128,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
 /** @deprecated use `UniformComposition` instead */
 declare const Composition: vue_demi.DefineComponent<{
     data: {
-        type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
+        type: PropType<((_uniformdev_canvas_dist_createEventBus_60ff8dc4.p | {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -1277,8 +1272,7 @@ declare const Composition: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        }) | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -1288,7 +1282,7 @@ declare const Composition: vue_demi.DefineComponent<{
         default: string;
     };
     contextualEditingEnhancer: {
-        type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
+        type: PropType<((compositionUpdateMessage: _uniformdev_canvas_dist_createEventBus_60ff8dc4.U) => {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -1438,7 +1432,7 @@ declare const Composition: vue_demi.DefineComponent<{
     [key: string]: any;
 }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
     data: {
-        type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
+        type: PropType<((_uniformdev_canvas_dist_createEventBus_60ff8dc4.p | {
             type: string;
             parameters?: {
                 [key: string]: {
@@ -1582,8 +1576,7 @@ declare const Composition: vue_demi.DefineComponent<{
                     } | undefined;
                 };
             } | undefined;
-        }>;
-        required: true;
+        }) | undefined>;
     };
     resolveRenderer: {
         type: PropType<ResolveRenderer | undefined>;
@@ -1593,7 +1586,7 @@ declare const Composition: vue_demi.DefineComponent<{
         default: string;
     };
     contextualEditingEnhancer: {
-        type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
+        type: PropType<((compositionUpdateMessage: _uniformdev_canvas_dist_createEventBus_60ff8dc4.U) => {
             type: string;
             parameters?: {
                 [key: string]: {

package/dist/index.esm.js

@@ -82,8 +82,7 @@ var UniformComponent = defineComponent2({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function
@@ -100,7 +99,7 @@ var UniformComponent = defineComponent2({
       var _a2;
       return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
     });
-    if (!data) {
+    if (!data.value) {
       if (process.env.NODE_ENV === "development") {
         console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
       }
@@ -190,7 +189,7 @@ var useUniformContextualEditing = ({
   watch(
     [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
     () => {
-      if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
+      if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
         return;
       }
       const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -200,10 +199,10 @@ var useUniformContextualEditing = ({
         const enhancedComposition = await enhance(message);
         contextualComposition.value = enhancedComposition;
       });
-      registeredCompositionIds.add(initialCompositionValue._id);
+      registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       return () => {
         unsubscribe();
-        registeredCompositionIds.delete(initialCompositionValue._id);
+        registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       };
     },
     { immediate: true }
@@ -216,6 +215,9 @@ var useUniformContextualEditing = ({
     if (existingScript) {
       return;
     }
+    window.__UNIFORM_CONTEXTUAL_EDITING__ = {
+      framework: "Vue"
+    };
     const script = document.createElement("script");
     script.id = IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
     script.src = getCanvasInContextEmbedScriptUrl();
@@ -257,8 +259,7 @@ var UniformComposition = defineComponent3({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function

package/dist/index.js

@@ -113,8 +113,7 @@ var UniformComponent = (0, import_vue_demi2.defineComponent)({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function
@@ -131,7 +130,7 @@ var UniformComponent = (0, import_vue_demi2.defineComponent)({
       var _a2;
       return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
     });
-    if (!data) {
+    if (!data.value) {
       if (process.env.NODE_ENV === "development") {
         console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
       }
@@ -209,7 +208,7 @@ var useUniformContextualEditing = ({
   (0, import_vue_demi3.watch)(
     [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
     () => {
-      if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
+      if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
         return;
       }
       const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -219,10 +218,10 @@ var useUniformContextualEditing = ({
         const enhancedComposition = await enhance(message);
         contextualComposition.value = enhancedComposition;
       });
-      registeredCompositionIds.add(initialCompositionValue._id);
+      registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       return () => {
         unsubscribe();
-        registeredCompositionIds.delete(initialCompositionValue._id);
+        registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       };
     },
     { immediate: true }
@@ -235,6 +234,9 @@ var useUniformContextualEditing = ({
     if (existingScript) {
       return;
     }
+    window.__UNIFORM_CONTEXTUAL_EDITING__ = {
+      framework: "Vue"
+    };
     const script = document.createElement("script");
     script.id = import_canvas3.IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
     script.src = getCanvasInContextEmbedScriptUrl();
@@ -276,8 +278,7 @@ var UniformComposition = (0, import_vue_demi4.defineComponent)({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function

package/dist/index.mjs

@@ -82,8 +82,7 @@ var UniformComponent = defineComponent2({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function
@@ -100,7 +99,7 @@ var UniformComponent = defineComponent2({
       var _a2;
       return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
     });
-    if (!data) {
+    if (!data.value) {
       if (process.env.NODE_ENV === "development") {
         console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
       }
@@ -190,7 +189,7 @@ var useUniformContextualEditing = ({
   watch(
     [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
     () => {
-      if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
+      if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
         return;
       }
       const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -200,10 +199,10 @@ var useUniformContextualEditing = ({
         const enhancedComposition = await enhance(message);
         contextualComposition.value = enhancedComposition;
       });
-      registeredCompositionIds.add(initialCompositionValue._id);
+      registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       return () => {
         unsubscribe();
-        registeredCompositionIds.delete(initialCompositionValue._id);
+        registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
       };
     },
     { immediate: true }
@@ -216,6 +215,9 @@ var useUniformContextualEditing = ({
     if (existingScript) {
       return;
     }
+    window.__UNIFORM_CONTEXTUAL_EDITING__ = {
+      framework: "Vue"
+    };
     const script = document.createElement("script");
     script.id = IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID;
     script.src = getCanvasInContextEmbedScriptUrl();
@@ -257,8 +259,7 @@ var UniformComposition = defineComponent3({
   inheritAttrs: false,
   props: {
     data: {
-      type: Object,
-      required: true
+      type: Object
     },
     resolveRenderer: {
       type: Function

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-vue",
-  "version": "18.5.0",
+  "version": "18.7.0",
   "description": "Vue SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -22,7 +22,7 @@
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\""
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.5.0",
+    "@uniformdev/canvas": "18.7.0",
     "@vue/test-utils": "2.2.8",
     "vue-demi": "^0.13.11"
   },
@@ -39,7 +39,7 @@
   "devDependencies": {
     "@testing-library/vue": "6.6.1",
     "@types/uuid": "9.0.0",
-    "@uniformdev/context-vue": "18.5.0",
+    "@uniformdev/context-vue": "18.7.0",
     "@vue/server-test-utils": "1.3.0",
     "vue": "3.2.45",
     "vue-server-renderer": "2.7.14",
@@ -62,5 +62,5 @@
     "last 2 versions",
     "not dead"
   ],
-  "gitHead": "757923e90bece28162621d867709e08674bdaa05"
+  "gitHead": "eaf3d0e5c1c124d6b449a2f2b16b327d6f3d3666"
 }