@uniformdev/canvas-vue 18.4.0 → 18.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -60,7 +60,7 @@ type UniformCurrentComponent = {
60
60
  declare const useUniformCurrentComponent: () => UniformCurrentComponent;
61
61
  type UniformComponentProps = {
62
62
  /** A dynamic vue component that provides data to the Uniform Canvas SlotContent component via provide/inject */
63
- data: ComponentInstance | RootComponentInstance;
63
+ data?: ComponentInstance | RootComponentInstance;
64
64
  /** Resolves a Vue component to render a Canvas component, generally by inspecting type/variant */
65
65
  resolveRenderer?: ResolveRenderer;
66
66
  /**
@@ -154,8 +154,7 @@ declare const UniformComponent: vue_demi.DefineComponent<{
154
154
  } | undefined;
155
155
  };
156
156
  } | undefined;
157
- }>;
158
- required: true;
157
+ } | undefined>;
159
158
  };
160
159
  resolveRenderer: {
161
160
  type: PropType<ResolveRenderer | undefined>;
@@ -242,8 +241,7 @@ declare const UniformComponent: vue_demi.DefineComponent<{
242
241
  } | undefined;
243
242
  };
244
243
  } | undefined;
245
- }>;
246
- required: true;
244
+ } | undefined>;
247
245
  };
248
246
  resolveRenderer: {
249
247
  type: PropType<ResolveRenderer | undefined>;
@@ -333,7 +331,7 @@ declare const createApiEnhancer: ({ apiUrl }: {
333
331
  } | undefined;
334
332
  }>;
335
333
  type UseUniformContextualEditingProps = {
336
- initialCompositionValue: RootComponentInstance;
334
+ initialCompositionValue?: RootComponentInstance;
337
335
  /**
338
336
  * A function to enhance the composition after receiving it from Canvas editor.
339
337
  * WARNING: This enhancer will run on the client side. Make sure you're not exposing any secrets.
@@ -418,7 +416,7 @@ declare const useUniformContextualEditing: ({ initialCompositionValue, enhance,
418
416
  } | undefined;
419
417
  };
420
418
  } | undefined;
421
- }>;
419
+ } | undefined>;
422
420
  };
423
421
 
424
422
  /** @deprecated use useUniformContextualEditing instead */
@@ -495,18 +493,18 @@ declare const useContextualEditing: ({ initialCompositionValue, enhance, }: UseU
495
493
  } | undefined;
496
494
  };
497
495
  } | undefined;
498
- }>;
496
+ } | undefined>;
499
497
  };
500
498
  /** @deprecated use UseUniformContextualEditingProps instead */
501
499
  type UseContextualEditingProps = UseUniformContextualEditingProps;
502
500
 
503
501
  type UniformCompositionProps = UniformComponentProps & {
504
502
  /** The composition data */
505
- data: RootComponentInstance;
503
+ data?: RootComponentInstance;
506
504
  contextualEditingEnhancer?: UseUniformContextualEditingProps['enhance'];
507
505
  };
508
506
  type UniformCurrentComposition = {
509
- data?: UniformCompositionProps['data'];
507
+ data: UniformCompositionProps['data'] | undefined;
510
508
  resolveRenderer?: UniformCompositionProps['resolveRenderer'];
511
509
  behaviorTracking?: UniformCompositionProps['behaviorTracking'];
512
510
  };
@@ -521,7 +519,7 @@ declare const useUniformCurrentComposition: () => UniformCurrentComposition;
521
519
  */
522
520
  declare const UniformComposition: vue_demi.DefineComponent<{
523
521
  data: {
524
- type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
522
+ type: PropType<((_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
525
523
  type: string;
526
524
  parameters?: {
527
525
  [key: string]: {
@@ -665,8 +663,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
665
663
  } | undefined;
666
664
  };
667
665
  } | undefined;
668
- }>;
669
- required: true;
666
+ }) | undefined>;
670
667
  };
671
668
  resolveRenderer: {
672
669
  type: PropType<ResolveRenderer | undefined>;
@@ -826,7 +823,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
826
823
  [key: string]: any;
827
824
  }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
828
825
  data: {
829
- type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
826
+ type: PropType<((_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
830
827
  type: string;
831
828
  parameters?: {
832
829
  [key: string]: {
@@ -970,8 +967,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
970
967
  } | undefined;
971
968
  };
972
969
  } | undefined;
973
- }>;
974
- required: true;
970
+ }) | undefined>;
975
971
  };
976
972
  resolveRenderer: {
977
973
  type: PropType<ResolveRenderer | undefined>;
@@ -1133,7 +1129,7 @@ declare const UniformComposition: vue_demi.DefineComponent<{
1133
1129
  /** @deprecated use `UniformComposition` instead */
1134
1130
  declare const Composition: vue_demi.DefineComponent<{
1135
1131
  data: {
1136
- type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
1132
+ type: PropType<((_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
1137
1133
  type: string;
1138
1134
  parameters?: {
1139
1135
  [key: string]: {
@@ -1277,8 +1273,7 @@ declare const Composition: vue_demi.DefineComponent<{
1277
1273
  } | undefined;
1278
1274
  };
1279
1275
  } | undefined;
1280
- }>;
1281
- required: true;
1276
+ }) | undefined>;
1282
1277
  };
1283
1278
  resolveRenderer: {
1284
1279
  type: PropType<ResolveRenderer | undefined>;
@@ -1438,7 +1433,7 @@ declare const Composition: vue_demi.DefineComponent<{
1438
1433
  [key: string]: any;
1439
1434
  }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
1440
1435
  data: {
1441
- type: PropType<(_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
1436
+ type: PropType<((_uniformdev_canvas_dist_createEventBus_db0afea5.p | {
1442
1437
  type: string;
1443
1438
  parameters?: {
1444
1439
  [key: string]: {
@@ -1582,8 +1577,7 @@ declare const Composition: vue_demi.DefineComponent<{
1582
1577
  } | undefined;
1583
1578
  };
1584
1579
  } | undefined;
1585
- }>;
1586
- required: true;
1580
+ }) | undefined>;
1587
1581
  };
1588
1582
  resolveRenderer: {
1589
1583
  type: PropType<ResolveRenderer | undefined>;
package/dist/index.esm.js CHANGED
@@ -82,8 +82,7 @@ var UniformComponent = defineComponent2({
82
82
  inheritAttrs: false,
83
83
  props: {
84
84
  data: {
85
- type: Object,
86
- required: true
85
+ type: Object
87
86
  },
88
87
  resolveRenderer: {
89
88
  type: Function
@@ -100,7 +99,7 @@ var UniformComponent = defineComponent2({
100
99
  var _a2;
101
100
  return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
102
101
  });
103
- if (!data) {
102
+ if (!data.value) {
104
103
  if (process.env.NODE_ENV === "development") {
105
104
  console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
106
105
  }
@@ -190,7 +189,7 @@ var useUniformContextualEditing = ({
190
189
  watch(
191
190
  [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
192
191
  () => {
193
- if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
192
+ if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
194
193
  return;
195
194
  }
196
195
  const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -200,10 +199,10 @@ var useUniformContextualEditing = ({
200
199
  const enhancedComposition = await enhance(message);
201
200
  contextualComposition.value = enhancedComposition;
202
201
  });
203
- registeredCompositionIds.add(initialCompositionValue._id);
202
+ registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
204
203
  return () => {
205
204
  unsubscribe();
206
- registeredCompositionIds.delete(initialCompositionValue._id);
205
+ registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
207
206
  };
208
207
  },
209
208
  { immediate: true }
@@ -257,8 +256,7 @@ var UniformComposition = defineComponent3({
257
256
  inheritAttrs: false,
258
257
  props: {
259
258
  data: {
260
- type: Object,
261
- required: true
259
+ type: Object
262
260
  },
263
261
  resolveRenderer: {
264
262
  type: Function
package/dist/index.js CHANGED
@@ -113,8 +113,7 @@ var UniformComponent = (0, import_vue_demi2.defineComponent)({
113
113
  inheritAttrs: false,
114
114
  props: {
115
115
  data: {
116
- type: Object,
117
- required: true
116
+ type: Object
118
117
  },
119
118
  resolveRenderer: {
120
119
  type: Function
@@ -131,7 +130,7 @@ var UniformComponent = (0, import_vue_demi2.defineComponent)({
131
130
  var _a2;
132
131
  return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
133
132
  });
134
- if (!data) {
133
+ if (!data.value) {
135
134
  if (process.env.NODE_ENV === "development") {
136
135
  console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
137
136
  }
@@ -209,7 +208,7 @@ var useUniformContextualEditing = ({
209
208
  (0, import_vue_demi3.watch)(
210
209
  [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
211
210
  () => {
212
- if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
211
+ if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
213
212
  return;
214
213
  }
215
214
  const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -219,10 +218,10 @@ var useUniformContextualEditing = ({
219
218
  const enhancedComposition = await enhance(message);
220
219
  contextualComposition.value = enhancedComposition;
221
220
  });
222
- registeredCompositionIds.add(initialCompositionValue._id);
221
+ registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
223
222
  return () => {
224
223
  unsubscribe();
225
- registeredCompositionIds.delete(initialCompositionValue._id);
224
+ registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
226
225
  };
227
226
  },
228
227
  { immediate: true }
@@ -276,8 +275,7 @@ var UniformComposition = (0, import_vue_demi4.defineComponent)({
276
275
  inheritAttrs: false,
277
276
  props: {
278
277
  data: {
279
- type: Object,
280
- required: true
278
+ type: Object
281
279
  },
282
280
  resolveRenderer: {
283
281
  type: Function
package/dist/index.mjs CHANGED
@@ -82,8 +82,7 @@ var UniformComponent = defineComponent2({
82
82
  inheritAttrs: false,
83
83
  props: {
84
84
  data: {
85
- type: Object,
86
- required: true
85
+ type: Object
87
86
  },
88
87
  resolveRenderer: {
89
88
  type: Function
@@ -100,7 +99,7 @@ var UniformComponent = defineComponent2({
100
99
  var _a2;
101
100
  return (_a2 = props.data) != null ? _a2 : parentComponent == null ? void 0 : parentComponent.data;
102
101
  });
103
- if (!data) {
102
+ if (!data.value) {
104
103
  if (process.env.NODE_ENV === "development") {
105
104
  console.warn(`[canvas-dev] UniformComponent was rendered with no data, nothing will be output.`);
106
105
  }
@@ -190,7 +189,7 @@ var useUniformContextualEditing = ({
190
189
  watch(
191
190
  [channel, () => enhance, () => initialCompositionValue == null ? void 0 : initialCompositionValue._id],
192
191
  () => {
193
- if (!channel.value || registeredCompositionIds.has(initialCompositionValue._id)) {
192
+ if (!channel.value || registeredCompositionIds.has(initialCompositionValue == null ? void 0 : initialCompositionValue._id)) {
194
193
  return;
195
194
  }
196
195
  const unsubscribe = channel.value.on("update-composition", async (message) => {
@@ -200,10 +199,10 @@ var useUniformContextualEditing = ({
200
199
  const enhancedComposition = await enhance(message);
201
200
  contextualComposition.value = enhancedComposition;
202
201
  });
203
- registeredCompositionIds.add(initialCompositionValue._id);
202
+ registeredCompositionIds.add(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
204
203
  return () => {
205
204
  unsubscribe();
206
- registeredCompositionIds.delete(initialCompositionValue._id);
205
+ registeredCompositionIds.delete(initialCompositionValue == null ? void 0 : initialCompositionValue._id);
207
206
  };
208
207
  },
209
208
  { immediate: true }
@@ -257,8 +256,7 @@ var UniformComposition = defineComponent3({
257
256
  inheritAttrs: false,
258
257
  props: {
259
258
  data: {
260
- type: Object,
261
- required: true
259
+ type: Object
262
260
  },
263
261
  resolveRenderer: {
264
262
  type: Function
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas-vue",
3
- "version": "18.4.0",
3
+ "version": "18.6.0",
4
4
  "description": "Vue SDK for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -22,8 +22,8 @@
22
22
  "format": "prettier --write \"src/**/*.{js,ts,tsx}\""
23
23
  },
24
24
  "dependencies": {
25
- "@uniformdev/canvas": "18.4.0",
26
- "@vue/test-utils": "2.2.7",
25
+ "@uniformdev/canvas": "18.6.0",
26
+ "@vue/test-utils": "2.2.8",
27
27
  "vue-demi": "^0.13.11"
28
28
  },
29
29
  "peerDependencies": {
@@ -39,7 +39,7 @@
39
39
  "devDependencies": {
40
40
  "@testing-library/vue": "6.6.1",
41
41
  "@types/uuid": "9.0.0",
42
- "@uniformdev/context-vue": "18.4.0",
42
+ "@uniformdev/context-vue": "18.6.0",
43
43
  "@vue/server-test-utils": "1.3.0",
44
44
  "vue": "3.2.45",
45
45
  "vue-server-renderer": "2.7.14",
@@ -62,5 +62,5 @@
62
62
  "last 2 versions",
63
63
  "not dead"
64
64
  ],
65
- "gitHead": "34456ffbb8609bfaa0c2e321e1ebea82f02e040a"
65
+ "gitHead": "2e2b4d179180900386f8b3ceb30d4a854a7e22fd"
66
66
  }