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

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
@@ -1,6 +1,26 @@
1
1
  import * as vue_demi from 'vue-demi';
2
- import { ConcreteComponent, PropType, Ref } from 'vue-demi';
3
- import { ComponentInstance, ComponentParameter, SubscribeToCompositionOptions, UpdateCompositionMessage, RootComponentInstance } from '@uniformdev/canvas';
2
+ import { PropType, ConcreteComponent, Ref } from 'vue-demi';
3
+ import * as _uniformdev_canvas from '@uniformdev/canvas';
4
+ import { ComponentInstance, ComponentParameter, RootComponentInstance, UpdateCompositionMessage, SubscribeToCompositionOptions } from '@uniformdev/canvas';
5
+ export { createUniformApiEnhancer } from '@uniformdev/canvas';
6
+ import * as _uniformdev_canvas_dist_createEventBus_bd2e0a92 from '@uniformdev/canvas/dist/createEventBus-bd2e0a92';
7
+
8
+ type DefaultNotImplementedComponentProps = {
9
+ component: ComponentInstance;
10
+ };
11
+ declare const DefaultNotImplementedComponent: vue_demi.DefineComponent<{
12
+ component: {
13
+ type: PropType<ComponentInstance>;
14
+ required: true;
15
+ };
16
+ }, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
17
+ [key: string]: any;
18
+ }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
19
+ component: {
20
+ type: PropType<ComponentInstance>;
21
+ required: true;
22
+ };
23
+ }>>, {}>;
4
24
 
5
25
  interface TestComponent {
6
26
  slots?: {
@@ -29,9 +49,18 @@ type ComponentProps<TProps = unknown> = TProps & {
29
49
  };
30
50
  type ResolveRenderer = (componentInstance: ComponentInstance) => ConcreteComponent<any>;
31
51
 
32
- type CompositionProps = {
52
+ type UniformCurrentComponent = {
53
+ data?: UniformComponentProps['data'];
54
+ resolveRenderer?: UniformComponentProps['resolveRenderer'];
55
+ behaviorTracking?: UniformComponentProps['behaviorTracking'];
56
+ };
57
+ /**
58
+ * Gets the data of the closest `<UniformComponent />` ancestor.
59
+ */
60
+ declare const useUniformCurrentComponent: () => UniformCurrentComponent;
61
+ type UniformComponentProps = {
33
62
  /** A dynamic vue component that provides data to the Uniform Canvas SlotContent component via provide/inject */
34
- data: ComponentInstance;
63
+ data: ComponentInstance | RootComponentInstance;
35
64
  /** Resolves a Vue component to render a Canvas component, generally by inspecting type/variant */
36
65
  resolveRenderer?: ResolveRenderer;
37
66
  /**
@@ -39,21 +68,92 @@ type CompositionProps = {
39
68
  * onView: adds enrichment score when the visitor views the tagged component in the browser viewport.
40
69
  * onLoad: adds enrichment score as soon as the composition mounts, regardless of viewport.
41
70
  *
42
- * NOTE: onView renders a <div> tag around components that have enrichment tags, to support IntersectionObserver.
71
+ * NOTE: onView renders a `<div>` tag around components that have enrichment tags, to support IntersectionObserver.
43
72
  * onLoad does not need to do this, and renders no wrapping tag.
44
73
  *
45
74
  * Default: onView
46
75
  */
47
76
  behaviorTracking?: 'onLoad' | 'onView';
48
77
  };
49
- declare const Composition: vue_demi.DefineComponent<{
78
+ /**
79
+ * Allows the rendering of a Canvas component instance (root or not), and its children if it has any.
80
+ * Note that the actual rendering happens inside `<Slot />`, this component only provides the services needed to achieve that.
81
+ * This component is used internally by `<UniformComposition />`, which you should use in most cases.
82
+ */
83
+ declare const UniformComponent: vue_demi.DefineComponent<{
50
84
  data: {
51
- type: PropType<ComponentInstance>;
85
+ type: PropType<ComponentInstance | {
86
+ type: string;
87
+ parameters?: {
88
+ [key: string]: {
89
+ value: unknown;
90
+ type: string;
91
+ connectedData?: {
92
+ pointer: string;
93
+ syntax: "jptr";
94
+ required?: boolean | undefined;
95
+ } | undefined;
96
+ };
97
+ } | undefined;
98
+ variant?: string | undefined;
99
+ slots?: {
100
+ [key: string]: {
101
+ type: string;
102
+ parameters?: {
103
+ [key: string]: {
104
+ value: unknown;
105
+ type: string;
106
+ connectedData?: {
107
+ pointer: string;
108
+ syntax: "jptr";
109
+ required?: boolean | undefined;
110
+ } | undefined;
111
+ };
112
+ } | undefined;
113
+ variant?: string | undefined;
114
+ slots?: {
115
+ [key: string]: any[];
116
+ } | undefined;
117
+ _id?: string | undefined;
118
+ _pattern?: string | undefined;
119
+ _dataResources?: {
120
+ [key: string]: {
121
+ type: string;
122
+ isPatternParameter?: boolean | undefined;
123
+ variables?: {
124
+ [key: string]: string;
125
+ } | undefined;
126
+ };
127
+ } | undefined;
128
+ _patternDataResources?: {
129
+ [key: string]: {
130
+ type: string;
131
+ isPatternParameter?: boolean | undefined;
132
+ variables?: {
133
+ [key: string]: string;
134
+ } | undefined;
135
+ };
136
+ } | undefined;
137
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
138
+ }[];
139
+ } | undefined;
140
+ _id: string;
141
+ _slug?: string | null | undefined;
142
+ _name: string;
143
+ _dataResources?: {
144
+ [key: string]: {
145
+ type: string;
146
+ isPatternParameter?: boolean | undefined;
147
+ variables?: {
148
+ [key: string]: string;
149
+ } | undefined;
150
+ };
151
+ } | undefined;
152
+ }>;
52
153
  required: true;
53
154
  };
54
155
  resolveRenderer: {
55
156
  type: PropType<ResolveRenderer | undefined>;
56
- default: () => ({ type }: ComponentInstance) => string | ConcreteComponent<{}, any, any, vue_demi.ComputedOptions, vue_demi.MethodOptions>;
57
157
  };
58
158
  behaviorTracking: {
59
159
  type: PropType<"onLoad" | "onView" | undefined>;
@@ -63,79 +163,90 @@ declare const Composition: vue_demi.DefineComponent<{
63
163
  [key: string]: any;
64
164
  }>) | (() => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
65
165
  [key: string]: any;
66
- }>[] | undefined), unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
166
+ }>[] | undefined) | null, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
67
167
  data: {
68
- type: PropType<ComponentInstance>;
168
+ type: PropType<ComponentInstance | {
169
+ type: string;
170
+ parameters?: {
171
+ [key: string]: {
172
+ value: unknown;
173
+ type: string;
174
+ connectedData?: {
175
+ pointer: string;
176
+ syntax: "jptr";
177
+ required?: boolean | undefined;
178
+ } | undefined;
179
+ };
180
+ } | undefined;
181
+ variant?: string | undefined;
182
+ slots?: {
183
+ [key: string]: {
184
+ type: string;
185
+ parameters?: {
186
+ [key: string]: {
187
+ value: unknown;
188
+ type: string;
189
+ connectedData?: {
190
+ pointer: string;
191
+ syntax: "jptr";
192
+ required?: boolean | undefined;
193
+ } | undefined;
194
+ };
195
+ } | undefined;
196
+ variant?: string | undefined;
197
+ slots?: {
198
+ [key: string]: any[];
199
+ } | undefined;
200
+ _id?: string | undefined;
201
+ _pattern?: string | undefined;
202
+ _dataResources?: {
203
+ [key: string]: {
204
+ type: string;
205
+ isPatternParameter?: boolean | undefined;
206
+ variables?: {
207
+ [key: string]: string;
208
+ } | undefined;
209
+ };
210
+ } | undefined;
211
+ _patternDataResources?: {
212
+ [key: string]: {
213
+ type: string;
214
+ isPatternParameter?: boolean | undefined;
215
+ variables?: {
216
+ [key: string]: string;
217
+ } | undefined;
218
+ };
219
+ } | undefined;
220
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
221
+ }[];
222
+ } | undefined;
223
+ _id: string;
224
+ _slug?: string | null | undefined;
225
+ _name: string;
226
+ _dataResources?: {
227
+ [key: string]: {
228
+ type: string;
229
+ isPatternParameter?: boolean | undefined;
230
+ variables?: {
231
+ [key: string]: string;
232
+ } | undefined;
233
+ };
234
+ } | undefined;
235
+ }>;
69
236
  required: true;
70
237
  };
71
238
  resolveRenderer: {
72
239
  type: PropType<ResolveRenderer | undefined>;
73
- default: () => ({ type }: ComponentInstance) => string | ConcreteComponent<{}, any, any, vue_demi.ComputedOptions, vue_demi.MethodOptions>;
74
240
  };
75
241
  behaviorTracking: {
76
242
  type: PropType<"onLoad" | "onView" | undefined>;
77
243
  default: string;
78
244
  };
79
245
  }>>, {
80
- resolveRenderer: ResolveRenderer | undefined;
81
246
  behaviorTracking: "onLoad" | "onView" | undefined;
82
247
  }>;
83
248
 
84
- type DefaultNotImplementedComponentProps = {
85
- component: ComponentInstance;
86
- };
87
- declare const DefaultNotImplementedComponent: vue_demi.DefineComponent<{
88
- component: {
89
- type: PropType<ComponentInstance>;
90
- required: true;
91
- };
92
- }, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
93
- [key: string]: any;
94
- }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
95
- component: {
96
- type: PropType<ComponentInstance>;
97
- required: true;
98
- };
99
- }>>, {}>;
100
-
101
- type SlotComponentProps = {
102
- /** Name of the slot to render */
103
- name?: string;
104
- /**
105
- * Function to resolve the Vue component to render for a given Canvas component type.
106
- * If not specified, the resolveRenderer function on the nearest <Composition /> will be used, if any.
107
- */
108
- resolveRenderer?: ResolveRenderer;
109
- };
110
- /**
111
- * Renders the content of a Canvas composition's slot
112
- */
113
- declare const SlotContent: vue_demi.DefineComponent<{
114
- name: {
115
- type: PropType<string | undefined>;
116
- };
117
- resolveRenderer: {
118
- type: PropType<ResolveRenderer | undefined>;
119
- };
120
- }, () => (ConcreteComponent<any, any, any, vue_demi.ComputedOptions, vue_demi.MethodOptions> | vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
121
- [key: string]: any;
122
- }>[])[], unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
123
- name: {
124
- type: PropType<string | undefined>;
125
- };
126
- resolveRenderer: {
127
- type: PropType<ResolveRenderer | undefined>;
128
- };
129
- }>>, {}>;
130
-
131
- type UseCompositionEventEffectOptions = Omit<Partial<SubscribeToCompositionOptions>, 'callback' | 'compositionId'> & {
132
- compositionIdRef: Ref<SubscribeToCompositionOptions['compositionId']>;
133
- enabled: boolean;
134
- effect: () => void;
135
- };
136
- /** A composable to manage a subscription to a realtime event on a composition */
137
- declare function useCompositionEventEffect({ enabled, projectId, compositionIdRef, effect, }: UseCompositionEventEffectOptions): Promise<void>;
138
-
249
+ /** @deprecated use `createUniformApiEnhancer` instead */
139
250
  declare const createApiEnhancer: ({ apiUrl }: {
140
251
  apiUrl: string;
141
252
  }) => (message: UpdateCompositionMessage) => Promise<{
@@ -206,78 +317,21 @@ declare const createApiEnhancer: ({ apiUrl }: {
206
317
  };
207
318
  } | undefined;
208
319
  }>;
209
- declare const useContextualEditing: ({ initialCompositionValue, enhance, }: {
210
- initialCompositionValue?: {
211
- type: string;
212
- parameters?: {
213
- [key: string]: {
214
- value: unknown;
215
- type: string;
216
- connectedData?: {
217
- pointer: string;
218
- syntax: "jptr";
219
- required?: boolean | undefined;
220
- } | undefined;
221
- };
222
- } | undefined;
223
- variant?: string | undefined;
224
- slots?: {
225
- [key: string]: {
226
- type: string;
227
- parameters?: {
228
- [key: string]: {
229
- value: unknown;
230
- type: string;
231
- connectedData?: {
232
- pointer: string;
233
- syntax: "jptr";
234
- required?: boolean | undefined;
235
- } | undefined;
236
- };
237
- } | undefined;
238
- variant?: string | undefined;
239
- slots?: {
240
- [key: string]: any[];
241
- } | undefined;
242
- _id?: string | undefined;
243
- _pattern?: string | undefined;
244
- _dataResources?: {
245
- [key: string]: {
246
- type: string;
247
- isPatternParameter?: boolean | undefined;
248
- variables?: {
249
- [key: string]: string;
250
- } | undefined;
251
- };
252
- } | undefined;
253
- _patternDataResources?: {
254
- [key: string]: {
255
- type: string;
256
- isPatternParameter?: boolean | undefined;
257
- variables?: {
258
- [key: string]: string;
259
- } | undefined;
260
- };
261
- } | undefined;
262
- _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
263
- }[];
264
- } | undefined;
265
- _id: string;
266
- _slug?: string | null | undefined;
267
- _name: string;
268
- _dataResources?: {
269
- [key: string]: {
270
- type: string;
271
- isPatternParameter?: boolean | undefined;
272
- variables?: {
273
- [key: string]: string;
274
- } | undefined;
275
- };
276
- } | undefined;
277
- } | undefined;
278
- enhance?: ((composition: UpdateCompositionMessage) => RootComponentInstance | Promise<RootComponentInstance>) | undefined;
279
- }) => {
280
- composition: vue_demi.Ref<{
320
+ type UseUniformContextualEditingProps = {
321
+ initialCompositionValue: RootComponentInstance;
322
+ /**
323
+ * A function to enhance the composition after receiving it from Canvas editor.
324
+ * WARNING: This enhancer will run on the client side. Make sure you're not exposing any secrets.
325
+ * You can use `createUniformApiEnhancer` to create an enhancer based on an API route.
326
+ */
327
+ enhance?: (compositionUpdateMessage: UpdateCompositionMessage) => RootComponentInstance | Promise<RootComponentInstance>;
328
+ };
329
+ /**
330
+ * Adds contextual editing capability to a Uniform app.
331
+ * This hook is already integrated in `<UniformComposition />`, you won't need to use it directly, unless you have a custom setup.
332
+ */
333
+ declare const useUniformContextualEditing: ({ initialCompositionValue, enhance, }: UseUniformContextualEditingProps) => {
334
+ composition: vue_demi.ComputedRef<{
281
335
  type: string;
282
336
  parameters?: {
283
337
  [key: string]: {
@@ -344,22 +398,1240 @@ declare const useContextualEditing: ({ initialCompositionValue, enhance, }: {
344
398
  } | undefined;
345
399
  };
346
400
  } | undefined;
347
- } | undefined>;
401
+ }>;
348
402
  };
349
403
 
404
+ type UniformCompositionProps = UniformComponentProps & {
405
+ /** The composition data */
406
+ data: RootComponentInstance;
407
+ contextualEditingEnhancer?: UseUniformContextualEditingProps['enhance'];
408
+ };
409
+ type UniformCurrentComposition = {
410
+ data?: UniformCompositionProps['data'];
411
+ resolveRenderer?: UniformCompositionProps['resolveRenderer'];
412
+ behaviorTracking?: UniformCompositionProps['behaviorTracking'];
413
+ };
350
414
  /**
351
- * Converts a raw Canvas component instance to Vue component props format.
352
- * This merges each parameter moved to the root object and removes the 'value' node,
353
- * hugely simplifying rendering code. For example if the raw object has parameters.foo.value,
354
- * then the final props have props.foo === raw.parameters.foo.value.
415
+ * Gets the data of the closest `<UniformComposition />` ancestor.
355
416
  */
356
- declare function convertComponentToProps<T = unknown>(component: ComponentInstance): ComponentProps<T>;
357
-
358
- /** Public ID of Canvas composition component type */
359
- declare const CANVAS_COMPOSITION_TYPE = "Composition";
360
- /** Public ID of Canvas slot component component type */
361
- declare const CANVAS_SLOT_CONTENT_TYPE = "SlotContent";
362
- declare const compositionInjectionKey = "uniformComposition";
363
- declare const resolveRendererInjectionKey = "uniformResolveRenderer";
417
+ declare const useUniformCurrentComposition: () => UniformCurrentComposition;
418
+ /**
419
+ * The main component to render a Canvas composition.
420
+ * It renders the full tree of components, and provides some services to the children, such as `useUniformCurrentComposition`.
421
+ * It also takes care of enabling [Contextual Editing](https://docs.uniform.app/capabilities/composition/contextual-editing).
422
+ */
423
+ declare const UniformComposition: vue_demi.DefineComponent<{
424
+ data: {
425
+ type: PropType<(_uniformdev_canvas_dist_createEventBus_bd2e0a92.p | {
426
+ type: string;
427
+ parameters?: {
428
+ [key: string]: {
429
+ value: unknown;
430
+ type: string;
431
+ connectedData?: {
432
+ pointer: string;
433
+ syntax: "jptr";
434
+ required?: boolean | undefined;
435
+ } | undefined;
436
+ };
437
+ } | undefined;
438
+ variant?: string | undefined;
439
+ slots?: {
440
+ [key: string]: {
441
+ type: string;
442
+ parameters?: {
443
+ [key: string]: {
444
+ value: unknown;
445
+ type: string;
446
+ connectedData?: {
447
+ pointer: string;
448
+ syntax: "jptr";
449
+ required?: boolean | undefined;
450
+ } | undefined;
451
+ };
452
+ } | undefined;
453
+ variant?: string | undefined;
454
+ slots?: {
455
+ [key: string]: any[];
456
+ } | undefined;
457
+ _id?: string | undefined;
458
+ _pattern?: string | undefined;
459
+ _dataResources?: {
460
+ [key: string]: {
461
+ type: string;
462
+ isPatternParameter?: boolean | undefined;
463
+ variables?: {
464
+ [key: string]: string;
465
+ } | undefined;
466
+ };
467
+ } | undefined;
468
+ _patternDataResources?: {
469
+ [key: string]: {
470
+ type: string;
471
+ isPatternParameter?: boolean | undefined;
472
+ variables?: {
473
+ [key: string]: string;
474
+ } | undefined;
475
+ };
476
+ } | undefined;
477
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
478
+ }[];
479
+ } | undefined;
480
+ _id: string;
481
+ _slug?: string | null | undefined;
482
+ _name: string;
483
+ _dataResources?: {
484
+ [key: string]: {
485
+ type: string;
486
+ isPatternParameter?: boolean | undefined;
487
+ variables?: {
488
+ [key: string]: string;
489
+ } | undefined;
490
+ };
491
+ } | undefined;
492
+ }) & {
493
+ type: string;
494
+ parameters?: {
495
+ [key: string]: {
496
+ value: unknown;
497
+ type: string;
498
+ connectedData?: {
499
+ pointer: string;
500
+ syntax: "jptr";
501
+ required?: boolean | undefined;
502
+ } | undefined;
503
+ };
504
+ } | undefined;
505
+ variant?: string | undefined;
506
+ slots?: {
507
+ [key: string]: {
508
+ type: string;
509
+ parameters?: {
510
+ [key: string]: {
511
+ value: unknown;
512
+ type: string;
513
+ connectedData?: {
514
+ pointer: string;
515
+ syntax: "jptr";
516
+ required?: boolean | undefined;
517
+ } | undefined;
518
+ };
519
+ } | undefined;
520
+ variant?: string | undefined;
521
+ slots?: {
522
+ [key: string]: any[];
523
+ } | undefined;
524
+ _id?: string | undefined;
525
+ _pattern?: string | undefined;
526
+ _dataResources?: {
527
+ [key: string]: {
528
+ type: string;
529
+ isPatternParameter?: boolean | undefined;
530
+ variables?: {
531
+ [key: string]: string;
532
+ } | undefined;
533
+ };
534
+ } | undefined;
535
+ _patternDataResources?: {
536
+ [key: string]: {
537
+ type: string;
538
+ isPatternParameter?: boolean | undefined;
539
+ variables?: {
540
+ [key: string]: string;
541
+ } | undefined;
542
+ };
543
+ } | undefined;
544
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
545
+ }[];
546
+ } | undefined;
547
+ _id: string;
548
+ _slug?: string | null | undefined;
549
+ _name: string;
550
+ _dataResources?: {
551
+ [key: string]: {
552
+ type: string;
553
+ isPatternParameter?: boolean | undefined;
554
+ variables?: {
555
+ [key: string]: string;
556
+ } | undefined;
557
+ };
558
+ } | undefined;
559
+ }>;
560
+ required: true;
561
+ };
562
+ resolveRenderer: {
563
+ type: PropType<ResolveRenderer | undefined>;
564
+ };
565
+ behaviorTracking: {
566
+ type: PropType<"onLoad" | "onView" | undefined>;
567
+ default: string;
568
+ };
569
+ contextualEditingEnhancer: {
570
+ type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
571
+ type: string;
572
+ parameters?: {
573
+ [key: string]: {
574
+ value: unknown;
575
+ type: string;
576
+ connectedData?: {
577
+ pointer: string;
578
+ syntax: "jptr";
579
+ required?: boolean | undefined;
580
+ } | undefined;
581
+ };
582
+ } | undefined;
583
+ variant?: string | undefined;
584
+ slots?: {
585
+ [key: string]: {
586
+ type: string;
587
+ parameters?: {
588
+ [key: string]: {
589
+ value: unknown;
590
+ type: string;
591
+ connectedData?: {
592
+ pointer: string;
593
+ syntax: "jptr";
594
+ required?: boolean | undefined;
595
+ } | undefined;
596
+ };
597
+ } | undefined;
598
+ variant?: string | undefined;
599
+ slots?: {
600
+ [key: string]: any[];
601
+ } | undefined;
602
+ _id?: string | undefined;
603
+ _pattern?: string | undefined;
604
+ _dataResources?: {
605
+ [key: string]: {
606
+ type: string;
607
+ isPatternParameter?: boolean | undefined;
608
+ variables?: {
609
+ [key: string]: string;
610
+ } | undefined;
611
+ };
612
+ } | undefined;
613
+ _patternDataResources?: {
614
+ [key: string]: {
615
+ type: string;
616
+ isPatternParameter?: boolean | undefined;
617
+ variables?: {
618
+ [key: string]: string;
619
+ } | undefined;
620
+ };
621
+ } | undefined;
622
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
623
+ }[];
624
+ } | undefined;
625
+ _id: string;
626
+ _slug?: string | null | undefined;
627
+ _name: string;
628
+ _dataResources?: {
629
+ [key: string]: {
630
+ type: string;
631
+ isPatternParameter?: boolean | undefined;
632
+ variables?: {
633
+ [key: string]: string;
634
+ } | undefined;
635
+ };
636
+ } | undefined;
637
+ } | Promise<{
638
+ type: string;
639
+ parameters?: {
640
+ [key: string]: {
641
+ value: unknown;
642
+ type: string;
643
+ connectedData?: {
644
+ pointer: string;
645
+ syntax: "jptr";
646
+ required?: boolean | undefined;
647
+ } | undefined;
648
+ };
649
+ } | undefined;
650
+ variant?: string | undefined;
651
+ slots?: {
652
+ [key: string]: {
653
+ type: string;
654
+ parameters?: {
655
+ [key: string]: {
656
+ value: unknown;
657
+ type: string;
658
+ connectedData?: {
659
+ pointer: string;
660
+ syntax: "jptr";
661
+ required?: boolean | undefined;
662
+ } | undefined;
663
+ };
664
+ } | undefined;
665
+ variant?: string | undefined;
666
+ slots?: {
667
+ [key: string]: any[];
668
+ } | undefined;
669
+ _id?: string | undefined;
670
+ _pattern?: string | undefined;
671
+ _dataResources?: {
672
+ [key: string]: {
673
+ type: string;
674
+ isPatternParameter?: boolean | undefined;
675
+ variables?: {
676
+ [key: string]: string;
677
+ } | undefined;
678
+ };
679
+ } | undefined;
680
+ _patternDataResources?: {
681
+ [key: string]: {
682
+ type: string;
683
+ isPatternParameter?: boolean | undefined;
684
+ variables?: {
685
+ [key: string]: string;
686
+ } | undefined;
687
+ };
688
+ } | undefined;
689
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
690
+ }[];
691
+ } | undefined;
692
+ _id: string;
693
+ _slug?: string | null | undefined;
694
+ _name: string;
695
+ _dataResources?: {
696
+ [key: string]: {
697
+ type: string;
698
+ isPatternParameter?: boolean | undefined;
699
+ variables?: {
700
+ [key: string]: string;
701
+ } | undefined;
702
+ };
703
+ } | undefined;
704
+ }>) | undefined>;
705
+ };
706
+ }, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
707
+ [key: string]: any;
708
+ }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
709
+ data: {
710
+ type: PropType<(_uniformdev_canvas_dist_createEventBus_bd2e0a92.p | {
711
+ type: string;
712
+ parameters?: {
713
+ [key: string]: {
714
+ value: unknown;
715
+ type: string;
716
+ connectedData?: {
717
+ pointer: string;
718
+ syntax: "jptr";
719
+ required?: boolean | undefined;
720
+ } | undefined;
721
+ };
722
+ } | undefined;
723
+ variant?: string | undefined;
724
+ slots?: {
725
+ [key: string]: {
726
+ type: string;
727
+ parameters?: {
728
+ [key: string]: {
729
+ value: unknown;
730
+ type: string;
731
+ connectedData?: {
732
+ pointer: string;
733
+ syntax: "jptr";
734
+ required?: boolean | undefined;
735
+ } | undefined;
736
+ };
737
+ } | undefined;
738
+ variant?: string | undefined;
739
+ slots?: {
740
+ [key: string]: any[];
741
+ } | undefined;
742
+ _id?: string | undefined;
743
+ _pattern?: string | undefined;
744
+ _dataResources?: {
745
+ [key: string]: {
746
+ type: string;
747
+ isPatternParameter?: boolean | undefined;
748
+ variables?: {
749
+ [key: string]: string;
750
+ } | undefined;
751
+ };
752
+ } | undefined;
753
+ _patternDataResources?: {
754
+ [key: string]: {
755
+ type: string;
756
+ isPatternParameter?: boolean | undefined;
757
+ variables?: {
758
+ [key: string]: string;
759
+ } | undefined;
760
+ };
761
+ } | undefined;
762
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
763
+ }[];
764
+ } | undefined;
765
+ _id: string;
766
+ _slug?: string | null | undefined;
767
+ _name: string;
768
+ _dataResources?: {
769
+ [key: string]: {
770
+ type: string;
771
+ isPatternParameter?: boolean | undefined;
772
+ variables?: {
773
+ [key: string]: string;
774
+ } | undefined;
775
+ };
776
+ } | undefined;
777
+ }) & {
778
+ type: string;
779
+ parameters?: {
780
+ [key: string]: {
781
+ value: unknown;
782
+ type: string;
783
+ connectedData?: {
784
+ pointer: string;
785
+ syntax: "jptr";
786
+ required?: boolean | undefined;
787
+ } | undefined;
788
+ };
789
+ } | undefined;
790
+ variant?: string | undefined;
791
+ slots?: {
792
+ [key: string]: {
793
+ type: string;
794
+ parameters?: {
795
+ [key: string]: {
796
+ value: unknown;
797
+ type: string;
798
+ connectedData?: {
799
+ pointer: string;
800
+ syntax: "jptr";
801
+ required?: boolean | undefined;
802
+ } | undefined;
803
+ };
804
+ } | undefined;
805
+ variant?: string | undefined;
806
+ slots?: {
807
+ [key: string]: any[];
808
+ } | undefined;
809
+ _id?: string | undefined;
810
+ _pattern?: string | undefined;
811
+ _dataResources?: {
812
+ [key: string]: {
813
+ type: string;
814
+ isPatternParameter?: boolean | undefined;
815
+ variables?: {
816
+ [key: string]: string;
817
+ } | undefined;
818
+ };
819
+ } | undefined;
820
+ _patternDataResources?: {
821
+ [key: string]: {
822
+ type: string;
823
+ isPatternParameter?: boolean | undefined;
824
+ variables?: {
825
+ [key: string]: string;
826
+ } | undefined;
827
+ };
828
+ } | undefined;
829
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
830
+ }[];
831
+ } | undefined;
832
+ _id: string;
833
+ _slug?: string | null | undefined;
834
+ _name: string;
835
+ _dataResources?: {
836
+ [key: string]: {
837
+ type: string;
838
+ isPatternParameter?: boolean | undefined;
839
+ variables?: {
840
+ [key: string]: string;
841
+ } | undefined;
842
+ };
843
+ } | undefined;
844
+ }>;
845
+ required: true;
846
+ };
847
+ resolveRenderer: {
848
+ type: PropType<ResolveRenderer | undefined>;
849
+ };
850
+ behaviorTracking: {
851
+ type: PropType<"onLoad" | "onView" | undefined>;
852
+ default: string;
853
+ };
854
+ contextualEditingEnhancer: {
855
+ type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
856
+ type: string;
857
+ parameters?: {
858
+ [key: string]: {
859
+ value: unknown;
860
+ type: string;
861
+ connectedData?: {
862
+ pointer: string;
863
+ syntax: "jptr";
864
+ required?: boolean | undefined;
865
+ } | undefined;
866
+ };
867
+ } | undefined;
868
+ variant?: string | undefined;
869
+ slots?: {
870
+ [key: string]: {
871
+ type: string;
872
+ parameters?: {
873
+ [key: string]: {
874
+ value: unknown;
875
+ type: string;
876
+ connectedData?: {
877
+ pointer: string;
878
+ syntax: "jptr";
879
+ required?: boolean | undefined;
880
+ } | undefined;
881
+ };
882
+ } | undefined;
883
+ variant?: string | undefined;
884
+ slots?: {
885
+ [key: string]: any[];
886
+ } | undefined;
887
+ _id?: string | undefined;
888
+ _pattern?: string | undefined;
889
+ _dataResources?: {
890
+ [key: string]: {
891
+ type: string;
892
+ isPatternParameter?: boolean | undefined;
893
+ variables?: {
894
+ [key: string]: string;
895
+ } | undefined;
896
+ };
897
+ } | undefined;
898
+ _patternDataResources?: {
899
+ [key: string]: {
900
+ type: string;
901
+ isPatternParameter?: boolean | undefined;
902
+ variables?: {
903
+ [key: string]: string;
904
+ } | undefined;
905
+ };
906
+ } | undefined;
907
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
908
+ }[];
909
+ } | undefined;
910
+ _id: string;
911
+ _slug?: string | null | undefined;
912
+ _name: string;
913
+ _dataResources?: {
914
+ [key: string]: {
915
+ type: string;
916
+ isPatternParameter?: boolean | undefined;
917
+ variables?: {
918
+ [key: string]: string;
919
+ } | undefined;
920
+ };
921
+ } | undefined;
922
+ } | Promise<{
923
+ type: string;
924
+ parameters?: {
925
+ [key: string]: {
926
+ value: unknown;
927
+ type: string;
928
+ connectedData?: {
929
+ pointer: string;
930
+ syntax: "jptr";
931
+ required?: boolean | undefined;
932
+ } | undefined;
933
+ };
934
+ } | undefined;
935
+ variant?: string | undefined;
936
+ slots?: {
937
+ [key: string]: {
938
+ type: string;
939
+ parameters?: {
940
+ [key: string]: {
941
+ value: unknown;
942
+ type: string;
943
+ connectedData?: {
944
+ pointer: string;
945
+ syntax: "jptr";
946
+ required?: boolean | undefined;
947
+ } | undefined;
948
+ };
949
+ } | undefined;
950
+ variant?: string | undefined;
951
+ slots?: {
952
+ [key: string]: any[];
953
+ } | undefined;
954
+ _id?: string | undefined;
955
+ _pattern?: string | undefined;
956
+ _dataResources?: {
957
+ [key: string]: {
958
+ type: string;
959
+ isPatternParameter?: boolean | undefined;
960
+ variables?: {
961
+ [key: string]: string;
962
+ } | undefined;
963
+ };
964
+ } | undefined;
965
+ _patternDataResources?: {
966
+ [key: string]: {
967
+ type: string;
968
+ isPatternParameter?: boolean | undefined;
969
+ variables?: {
970
+ [key: string]: string;
971
+ } | undefined;
972
+ };
973
+ } | undefined;
974
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
975
+ }[];
976
+ } | undefined;
977
+ _id: string;
978
+ _slug?: string | null | undefined;
979
+ _name: string;
980
+ _dataResources?: {
981
+ [key: string]: {
982
+ type: string;
983
+ isPatternParameter?: boolean | undefined;
984
+ variables?: {
985
+ [key: string]: string;
986
+ } | undefined;
987
+ };
988
+ } | undefined;
989
+ }>) | undefined>;
990
+ };
991
+ }>>, {
992
+ behaviorTracking: "onLoad" | "onView" | undefined;
993
+ }>;
994
+ /** @deprecated use `UniformComposition` instead */
995
+ declare const Composition: vue_demi.DefineComponent<{
996
+ data: {
997
+ type: PropType<(_uniformdev_canvas_dist_createEventBus_bd2e0a92.p | {
998
+ type: string;
999
+ parameters?: {
1000
+ [key: string]: {
1001
+ value: unknown;
1002
+ type: string;
1003
+ connectedData?: {
1004
+ pointer: string;
1005
+ syntax: "jptr";
1006
+ required?: boolean | undefined;
1007
+ } | undefined;
1008
+ };
1009
+ } | undefined;
1010
+ variant?: string | undefined;
1011
+ slots?: {
1012
+ [key: string]: {
1013
+ type: string;
1014
+ parameters?: {
1015
+ [key: string]: {
1016
+ value: unknown;
1017
+ type: string;
1018
+ connectedData?: {
1019
+ pointer: string;
1020
+ syntax: "jptr";
1021
+ required?: boolean | undefined;
1022
+ } | undefined;
1023
+ };
1024
+ } | undefined;
1025
+ variant?: string | undefined;
1026
+ slots?: {
1027
+ [key: string]: any[];
1028
+ } | undefined;
1029
+ _id?: string | undefined;
1030
+ _pattern?: string | undefined;
1031
+ _dataResources?: {
1032
+ [key: string]: {
1033
+ type: string;
1034
+ isPatternParameter?: boolean | undefined;
1035
+ variables?: {
1036
+ [key: string]: string;
1037
+ } | undefined;
1038
+ };
1039
+ } | undefined;
1040
+ _patternDataResources?: {
1041
+ [key: string]: {
1042
+ type: string;
1043
+ isPatternParameter?: boolean | undefined;
1044
+ variables?: {
1045
+ [key: string]: string;
1046
+ } | undefined;
1047
+ };
1048
+ } | undefined;
1049
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1050
+ }[];
1051
+ } | undefined;
1052
+ _id: string;
1053
+ _slug?: string | null | undefined;
1054
+ _name: string;
1055
+ _dataResources?: {
1056
+ [key: string]: {
1057
+ type: string;
1058
+ isPatternParameter?: boolean | undefined;
1059
+ variables?: {
1060
+ [key: string]: string;
1061
+ } | undefined;
1062
+ };
1063
+ } | undefined;
1064
+ }) & {
1065
+ type: string;
1066
+ parameters?: {
1067
+ [key: string]: {
1068
+ value: unknown;
1069
+ type: string;
1070
+ connectedData?: {
1071
+ pointer: string;
1072
+ syntax: "jptr";
1073
+ required?: boolean | undefined;
1074
+ } | undefined;
1075
+ };
1076
+ } | undefined;
1077
+ variant?: string | undefined;
1078
+ slots?: {
1079
+ [key: string]: {
1080
+ type: string;
1081
+ parameters?: {
1082
+ [key: string]: {
1083
+ value: unknown;
1084
+ type: string;
1085
+ connectedData?: {
1086
+ pointer: string;
1087
+ syntax: "jptr";
1088
+ required?: boolean | undefined;
1089
+ } | undefined;
1090
+ };
1091
+ } | undefined;
1092
+ variant?: string | undefined;
1093
+ slots?: {
1094
+ [key: string]: any[];
1095
+ } | undefined;
1096
+ _id?: string | undefined;
1097
+ _pattern?: string | undefined;
1098
+ _dataResources?: {
1099
+ [key: string]: {
1100
+ type: string;
1101
+ isPatternParameter?: boolean | undefined;
1102
+ variables?: {
1103
+ [key: string]: string;
1104
+ } | undefined;
1105
+ };
1106
+ } | undefined;
1107
+ _patternDataResources?: {
1108
+ [key: string]: {
1109
+ type: string;
1110
+ isPatternParameter?: boolean | undefined;
1111
+ variables?: {
1112
+ [key: string]: string;
1113
+ } | undefined;
1114
+ };
1115
+ } | undefined;
1116
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1117
+ }[];
1118
+ } | undefined;
1119
+ _id: string;
1120
+ _slug?: string | null | undefined;
1121
+ _name: string;
1122
+ _dataResources?: {
1123
+ [key: string]: {
1124
+ type: string;
1125
+ isPatternParameter?: boolean | undefined;
1126
+ variables?: {
1127
+ [key: string]: string;
1128
+ } | undefined;
1129
+ };
1130
+ } | undefined;
1131
+ }>;
1132
+ required: true;
1133
+ };
1134
+ resolveRenderer: {
1135
+ type: PropType<ResolveRenderer | undefined>;
1136
+ };
1137
+ behaviorTracking: {
1138
+ type: PropType<"onLoad" | "onView" | undefined>;
1139
+ default: string;
1140
+ };
1141
+ contextualEditingEnhancer: {
1142
+ type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
1143
+ type: string;
1144
+ parameters?: {
1145
+ [key: string]: {
1146
+ value: unknown;
1147
+ type: string;
1148
+ connectedData?: {
1149
+ pointer: string;
1150
+ syntax: "jptr";
1151
+ required?: boolean | undefined;
1152
+ } | undefined;
1153
+ };
1154
+ } | undefined;
1155
+ variant?: string | undefined;
1156
+ slots?: {
1157
+ [key: string]: {
1158
+ type: string;
1159
+ parameters?: {
1160
+ [key: string]: {
1161
+ value: unknown;
1162
+ type: string;
1163
+ connectedData?: {
1164
+ pointer: string;
1165
+ syntax: "jptr";
1166
+ required?: boolean | undefined;
1167
+ } | undefined;
1168
+ };
1169
+ } | undefined;
1170
+ variant?: string | undefined;
1171
+ slots?: {
1172
+ [key: string]: any[];
1173
+ } | undefined;
1174
+ _id?: string | undefined;
1175
+ _pattern?: string | undefined;
1176
+ _dataResources?: {
1177
+ [key: string]: {
1178
+ type: string;
1179
+ isPatternParameter?: boolean | undefined;
1180
+ variables?: {
1181
+ [key: string]: string;
1182
+ } | undefined;
1183
+ };
1184
+ } | undefined;
1185
+ _patternDataResources?: {
1186
+ [key: string]: {
1187
+ type: string;
1188
+ isPatternParameter?: boolean | undefined;
1189
+ variables?: {
1190
+ [key: string]: string;
1191
+ } | undefined;
1192
+ };
1193
+ } | undefined;
1194
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1195
+ }[];
1196
+ } | undefined;
1197
+ _id: string;
1198
+ _slug?: string | null | undefined;
1199
+ _name: string;
1200
+ _dataResources?: {
1201
+ [key: string]: {
1202
+ type: string;
1203
+ isPatternParameter?: boolean | undefined;
1204
+ variables?: {
1205
+ [key: string]: string;
1206
+ } | undefined;
1207
+ };
1208
+ } | undefined;
1209
+ } | Promise<{
1210
+ type: string;
1211
+ parameters?: {
1212
+ [key: string]: {
1213
+ value: unknown;
1214
+ type: string;
1215
+ connectedData?: {
1216
+ pointer: string;
1217
+ syntax: "jptr";
1218
+ required?: boolean | undefined;
1219
+ } | undefined;
1220
+ };
1221
+ } | undefined;
1222
+ variant?: string | undefined;
1223
+ slots?: {
1224
+ [key: string]: {
1225
+ type: string;
1226
+ parameters?: {
1227
+ [key: string]: {
1228
+ value: unknown;
1229
+ type: string;
1230
+ connectedData?: {
1231
+ pointer: string;
1232
+ syntax: "jptr";
1233
+ required?: boolean | undefined;
1234
+ } | undefined;
1235
+ };
1236
+ } | undefined;
1237
+ variant?: string | undefined;
1238
+ slots?: {
1239
+ [key: string]: any[];
1240
+ } | undefined;
1241
+ _id?: string | undefined;
1242
+ _pattern?: string | undefined;
1243
+ _dataResources?: {
1244
+ [key: string]: {
1245
+ type: string;
1246
+ isPatternParameter?: boolean | undefined;
1247
+ variables?: {
1248
+ [key: string]: string;
1249
+ } | undefined;
1250
+ };
1251
+ } | undefined;
1252
+ _patternDataResources?: {
1253
+ [key: string]: {
1254
+ type: string;
1255
+ isPatternParameter?: boolean | undefined;
1256
+ variables?: {
1257
+ [key: string]: string;
1258
+ } | undefined;
1259
+ };
1260
+ } | undefined;
1261
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1262
+ }[];
1263
+ } | undefined;
1264
+ _id: string;
1265
+ _slug?: string | null | undefined;
1266
+ _name: string;
1267
+ _dataResources?: {
1268
+ [key: string]: {
1269
+ type: string;
1270
+ isPatternParameter?: boolean | undefined;
1271
+ variables?: {
1272
+ [key: string]: string;
1273
+ } | undefined;
1274
+ };
1275
+ } | undefined;
1276
+ }>) | undefined>;
1277
+ };
1278
+ }, () => vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
1279
+ [key: string]: any;
1280
+ }>, unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
1281
+ data: {
1282
+ type: PropType<(_uniformdev_canvas_dist_createEventBus_bd2e0a92.p | {
1283
+ type: string;
1284
+ parameters?: {
1285
+ [key: string]: {
1286
+ value: unknown;
1287
+ type: string;
1288
+ connectedData?: {
1289
+ pointer: string;
1290
+ syntax: "jptr";
1291
+ required?: boolean | undefined;
1292
+ } | undefined;
1293
+ };
1294
+ } | undefined;
1295
+ variant?: string | undefined;
1296
+ slots?: {
1297
+ [key: string]: {
1298
+ type: string;
1299
+ parameters?: {
1300
+ [key: string]: {
1301
+ value: unknown;
1302
+ type: string;
1303
+ connectedData?: {
1304
+ pointer: string;
1305
+ syntax: "jptr";
1306
+ required?: boolean | undefined;
1307
+ } | undefined;
1308
+ };
1309
+ } | undefined;
1310
+ variant?: string | undefined;
1311
+ slots?: {
1312
+ [key: string]: any[];
1313
+ } | undefined;
1314
+ _id?: string | undefined;
1315
+ _pattern?: string | undefined;
1316
+ _dataResources?: {
1317
+ [key: string]: {
1318
+ type: string;
1319
+ isPatternParameter?: boolean | undefined;
1320
+ variables?: {
1321
+ [key: string]: string;
1322
+ } | undefined;
1323
+ };
1324
+ } | undefined;
1325
+ _patternDataResources?: {
1326
+ [key: string]: {
1327
+ type: string;
1328
+ isPatternParameter?: boolean | undefined;
1329
+ variables?: {
1330
+ [key: string]: string;
1331
+ } | undefined;
1332
+ };
1333
+ } | undefined;
1334
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1335
+ }[];
1336
+ } | undefined;
1337
+ _id: string;
1338
+ _slug?: string | null | undefined;
1339
+ _name: string;
1340
+ _dataResources?: {
1341
+ [key: string]: {
1342
+ type: string;
1343
+ isPatternParameter?: boolean | undefined;
1344
+ variables?: {
1345
+ [key: string]: string;
1346
+ } | undefined;
1347
+ };
1348
+ } | undefined;
1349
+ }) & {
1350
+ type: string;
1351
+ parameters?: {
1352
+ [key: string]: {
1353
+ value: unknown;
1354
+ type: string;
1355
+ connectedData?: {
1356
+ pointer: string;
1357
+ syntax: "jptr";
1358
+ required?: boolean | undefined;
1359
+ } | undefined;
1360
+ };
1361
+ } | undefined;
1362
+ variant?: string | undefined;
1363
+ slots?: {
1364
+ [key: string]: {
1365
+ type: string;
1366
+ parameters?: {
1367
+ [key: string]: {
1368
+ value: unknown;
1369
+ type: string;
1370
+ connectedData?: {
1371
+ pointer: string;
1372
+ syntax: "jptr";
1373
+ required?: boolean | undefined;
1374
+ } | undefined;
1375
+ };
1376
+ } | undefined;
1377
+ variant?: string | undefined;
1378
+ slots?: {
1379
+ [key: string]: any[];
1380
+ } | undefined;
1381
+ _id?: string | undefined;
1382
+ _pattern?: string | undefined;
1383
+ _dataResources?: {
1384
+ [key: string]: {
1385
+ type: string;
1386
+ isPatternParameter?: boolean | undefined;
1387
+ variables?: {
1388
+ [key: string]: string;
1389
+ } | undefined;
1390
+ };
1391
+ } | undefined;
1392
+ _patternDataResources?: {
1393
+ [key: string]: {
1394
+ type: string;
1395
+ isPatternParameter?: boolean | undefined;
1396
+ variables?: {
1397
+ [key: string]: string;
1398
+ } | undefined;
1399
+ };
1400
+ } | undefined;
1401
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1402
+ }[];
1403
+ } | undefined;
1404
+ _id: string;
1405
+ _slug?: string | null | undefined;
1406
+ _name: string;
1407
+ _dataResources?: {
1408
+ [key: string]: {
1409
+ type: string;
1410
+ isPatternParameter?: boolean | undefined;
1411
+ variables?: {
1412
+ [key: string]: string;
1413
+ } | undefined;
1414
+ };
1415
+ } | undefined;
1416
+ }>;
1417
+ required: true;
1418
+ };
1419
+ resolveRenderer: {
1420
+ type: PropType<ResolveRenderer | undefined>;
1421
+ };
1422
+ behaviorTracking: {
1423
+ type: PropType<"onLoad" | "onView" | undefined>;
1424
+ default: string;
1425
+ };
1426
+ contextualEditingEnhancer: {
1427
+ type: PropType<((compositionUpdateMessage: _uniformdev_canvas.UpdateCompositionMessage) => {
1428
+ type: string;
1429
+ parameters?: {
1430
+ [key: string]: {
1431
+ value: unknown;
1432
+ type: string;
1433
+ connectedData?: {
1434
+ pointer: string;
1435
+ syntax: "jptr";
1436
+ required?: boolean | undefined;
1437
+ } | undefined;
1438
+ };
1439
+ } | undefined;
1440
+ variant?: string | undefined;
1441
+ slots?: {
1442
+ [key: string]: {
1443
+ type: string;
1444
+ parameters?: {
1445
+ [key: string]: {
1446
+ value: unknown;
1447
+ type: string;
1448
+ connectedData?: {
1449
+ pointer: string;
1450
+ syntax: "jptr";
1451
+ required?: boolean | undefined;
1452
+ } | undefined;
1453
+ };
1454
+ } | undefined;
1455
+ variant?: string | undefined;
1456
+ slots?: {
1457
+ [key: string]: any[];
1458
+ } | undefined;
1459
+ _id?: string | undefined;
1460
+ _pattern?: string | undefined;
1461
+ _dataResources?: {
1462
+ [key: string]: {
1463
+ type: string;
1464
+ isPatternParameter?: boolean | undefined;
1465
+ variables?: {
1466
+ [key: string]: string;
1467
+ } | undefined;
1468
+ };
1469
+ } | undefined;
1470
+ _patternDataResources?: {
1471
+ [key: string]: {
1472
+ type: string;
1473
+ isPatternParameter?: boolean | undefined;
1474
+ variables?: {
1475
+ [key: string]: string;
1476
+ } | undefined;
1477
+ };
1478
+ } | undefined;
1479
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1480
+ }[];
1481
+ } | undefined;
1482
+ _id: string;
1483
+ _slug?: string | null | undefined;
1484
+ _name: string;
1485
+ _dataResources?: {
1486
+ [key: string]: {
1487
+ type: string;
1488
+ isPatternParameter?: boolean | undefined;
1489
+ variables?: {
1490
+ [key: string]: string;
1491
+ } | undefined;
1492
+ };
1493
+ } | undefined;
1494
+ } | Promise<{
1495
+ type: string;
1496
+ parameters?: {
1497
+ [key: string]: {
1498
+ value: unknown;
1499
+ type: string;
1500
+ connectedData?: {
1501
+ pointer: string;
1502
+ syntax: "jptr";
1503
+ required?: boolean | undefined;
1504
+ } | undefined;
1505
+ };
1506
+ } | undefined;
1507
+ variant?: string | undefined;
1508
+ slots?: {
1509
+ [key: string]: {
1510
+ type: string;
1511
+ parameters?: {
1512
+ [key: string]: {
1513
+ value: unknown;
1514
+ type: string;
1515
+ connectedData?: {
1516
+ pointer: string;
1517
+ syntax: "jptr";
1518
+ required?: boolean | undefined;
1519
+ } | undefined;
1520
+ };
1521
+ } | undefined;
1522
+ variant?: string | undefined;
1523
+ slots?: {
1524
+ [key: string]: any[];
1525
+ } | undefined;
1526
+ _id?: string | undefined;
1527
+ _pattern?: string | undefined;
1528
+ _dataResources?: {
1529
+ [key: string]: {
1530
+ type: string;
1531
+ isPatternParameter?: boolean | undefined;
1532
+ variables?: {
1533
+ [key: string]: string;
1534
+ } | undefined;
1535
+ };
1536
+ } | undefined;
1537
+ _patternDataResources?: {
1538
+ [key: string]: {
1539
+ type: string;
1540
+ isPatternParameter?: boolean | undefined;
1541
+ variables?: {
1542
+ [key: string]: string;
1543
+ } | undefined;
1544
+ };
1545
+ } | undefined;
1546
+ _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
1547
+ }[];
1548
+ } | undefined;
1549
+ _id: string;
1550
+ _slug?: string | null | undefined;
1551
+ _name: string;
1552
+ _dataResources?: {
1553
+ [key: string]: {
1554
+ type: string;
1555
+ isPatternParameter?: boolean | undefined;
1556
+ variables?: {
1557
+ [key: string]: string;
1558
+ } | undefined;
1559
+ };
1560
+ } | undefined;
1561
+ }>) | undefined>;
1562
+ };
1563
+ }>>, {
1564
+ behaviorTracking: "onLoad" | "onView" | undefined;
1565
+ }>;
1566
+ /** @deprecated use `UniformCompositionProps` instead */
1567
+ type CompositionProps = UniformCompositionProps;
1568
+
1569
+ type UniformSlotProps = {
1570
+ /** Name of the slot to render */
1571
+ name?: string;
1572
+ /**
1573
+ * Function to resolve the Vue component to render for a given Canvas component type.
1574
+ * If not specified, the resolveRenderer function on the nearest <Composition /> will be used, if any.
1575
+ */
1576
+ resolveRenderer?: ResolveRenderer;
1577
+ };
1578
+ /**
1579
+ * Renders the content of a Canvas composition's slot
1580
+ */
1581
+ declare const UniformSlot: vue_demi.DefineComponent<{
1582
+ name: {
1583
+ type: PropType<string | undefined>;
1584
+ };
1585
+ resolveRenderer: {
1586
+ type: PropType<ResolveRenderer | undefined>;
1587
+ };
1588
+ }, () => (ConcreteComponent<any, any, any, vue_demi.ComputedOptions, vue_demi.MethodOptions> | vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
1589
+ [key: string]: any;
1590
+ }>[])[], unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
1591
+ name: {
1592
+ type: PropType<string | undefined>;
1593
+ };
1594
+ resolveRenderer: {
1595
+ type: PropType<ResolveRenderer | undefined>;
1596
+ };
1597
+ }>>, {}>;
1598
+ /** @deprecated use `UniformSlotProps` instead */
1599
+ type SlotComponentProps = UniformSlotProps;
1600
+ /** @deprecated use `UniformSlot` instead */
1601
+ declare const SlotContent: vue_demi.DefineComponent<{
1602
+ name: {
1603
+ type: PropType<string | undefined>;
1604
+ };
1605
+ resolveRenderer: {
1606
+ type: PropType<ResolveRenderer | undefined>;
1607
+ };
1608
+ }, () => (ConcreteComponent<any, any, any, vue_demi.ComputedOptions, vue_demi.MethodOptions> | vue_demi.VNode<vue_demi.RendererNode, vue_demi.RendererElement, {
1609
+ [key: string]: any;
1610
+ }>[])[], unknown, {}, {}, vue_demi.ComponentOptionsMixin, vue_demi.ComponentOptionsMixin, {}, string, vue_demi.VNodeProps & vue_demi.AllowedComponentProps & vue_demi.ComponentCustomProps, Readonly<vue_demi.ExtractPropTypes<{
1611
+ name: {
1612
+ type: PropType<string | undefined>;
1613
+ };
1614
+ resolveRenderer: {
1615
+ type: PropType<ResolveRenderer | undefined>;
1616
+ };
1617
+ }>>, {}>;
1618
+
1619
+ type UseCompositionEventEffectOptions = Omit<Partial<SubscribeToCompositionOptions>, 'callback' | 'compositionId'> & {
1620
+ compositionIdRef: Ref<SubscribeToCompositionOptions['compositionId']>;
1621
+ enabled: boolean;
1622
+ effect: () => void;
1623
+ };
1624
+ /** A composable to manage a subscription to a realtime event on a composition */
1625
+ declare function useCompositionEventEffect({ enabled, projectId, compositionIdRef, effect, }: UseCompositionEventEffectOptions): Promise<void>;
1626
+
1627
+ declare const globalCompositionEnhancerInjectionKey = "uniformGlobalCompositionEnhancer";
1628
+
1629
+ /**
1630
+ * Converts a raw Canvas component instance to Vue component props format.
1631
+ * This merges each parameter moved to the root object and removes the 'value' node,
1632
+ * hugely simplifying rendering code. For example if the raw object has parameters.foo.value,
1633
+ * then the final props have props.foo === raw.parameters.foo.value.
1634
+ */
1635
+ declare function convertComponentToProps<T = unknown>(component: ComponentInstance): ComponentProps<T>;
364
1636
 
365
- export { CANVAS_COMPOSITION_TYPE, CANVAS_SLOT_CONTENT_TYPE, ComponentProps, Composition, CompositionProps, DefaultNotImplementedComponent, DefaultNotImplementedComponentProps, PersonalizeComponent, ResolveRenderer, SlotComponentProps, SlotContent, TestComponent, UseCompositionEventEffectOptions, compositionInjectionKey, convertComponentToProps, createApiEnhancer, resolveRendererInjectionKey, useCompositionEventEffect, useContextualEditing };
1637
+ export { ComponentProps, Composition, CompositionProps, DefaultNotImplementedComponent, DefaultNotImplementedComponentProps, PersonalizeComponent, ResolveRenderer, SlotComponentProps, SlotContent, TestComponent, UniformComponent, UniformComponentProps, UniformComposition, UniformCompositionProps, UniformSlot, UniformSlotProps, UseCompositionEventEffectOptions, UseUniformContextualEditingProps, convertComponentToProps, createApiEnhancer, globalCompositionEnhancerInjectionKey, useCompositionEventEffect, useUniformContextualEditing, useUniformCurrentComponent, useUniformCurrentComposition };