@uniformdev/canvas 17.1.1-alpha.498 → 17.1.1-alpha.752
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/{chunk-OT3KUGLJ.mjs → chunk-IK3FODEI.mjs} +2 -2
- package/dist/chunk-YBMT3VRI.mjs +4 -0
- package/dist/cli/cli.d.ts +1 -1
- package/dist/cli/cli.js +61 -61
- package/dist/cli/cli.mjs +49 -49
- package/dist/{createEventBus-6f48d55f.d.ts → createEventBus-33bac5ac.d.ts} +404 -323
- package/dist/createEventBus-a8e85b6e.d.ts +3030 -0
- package/dist/index.d.ts +197 -39
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/package.json +5 -5
@@ -269,24 +269,24 @@ interface external$4 {
|
|
269
269
|
value: unknown;
|
270
270
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
271
271
|
type: string;
|
272
|
-
|
272
|
+
connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
273
273
|
};
|
274
274
|
/**
|
275
275
|
* @deprecated
|
276
|
-
* @description Defines a
|
276
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
277
277
|
*/
|
278
|
-
|
279
|
-
/** @description A JSON Pointer expression that defines the
|
278
|
+
DataElementConnectionDefinition: {
|
279
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
280
280
|
pointer: string;
|
281
281
|
/**
|
282
|
-
* @description The syntax
|
282
|
+
* @description The syntax used to select the data element to bind to
|
283
283
|
* @enum {string}
|
284
284
|
*/
|
285
285
|
syntax: "jptr";
|
286
286
|
/**
|
287
|
-
* @description Whether
|
288
|
-
*
|
289
|
-
*
|
287
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
288
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
289
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
290
290
|
*
|
291
291
|
* @default false
|
292
292
|
*/
|
@@ -310,14 +310,14 @@ interface external$4 {
|
|
310
310
|
_id?: string;
|
311
311
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
312
312
|
_pattern?: string;
|
313
|
-
|
313
|
+
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
314
314
|
/**
|
315
315
|
* @deprecated
|
316
316
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
317
317
|
* Means nothing for PUTs; it will be ignored.
|
318
318
|
*/
|
319
|
-
|
320
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
319
|
+
_patternDataResources?: {
|
320
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
321
321
|
};
|
322
322
|
/**
|
323
323
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -349,63 +349,67 @@ interface external$4 {
|
|
349
349
|
_slug?: string | null;
|
350
350
|
/** @description Friendly name of this component. */
|
351
351
|
_name: string;
|
352
|
-
|
352
|
+
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
353
353
|
};
|
354
354
|
/**
|
355
355
|
* @deprecated
|
356
|
-
* @description Basic information about
|
356
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
357
357
|
*/
|
358
|
-
|
359
|
-
/** @description Public ID of the data
|
358
|
+
DataSourceInfo: {
|
359
|
+
/** @description Public ID of the data source */
|
360
360
|
id: string;
|
361
|
-
/** @description Display name of the data
|
361
|
+
/** @description Display name of the data source */
|
362
362
|
displayName: string;
|
363
363
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
364
364
|
connectorType: string;
|
365
|
-
/** @description Base resource URL of the data
|
365
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
366
366
|
baseUrl: string;
|
367
367
|
};
|
368
368
|
/**
|
369
369
|
* @deprecated
|
370
|
-
* @description An instance of
|
370
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
371
371
|
*/
|
372
|
-
|
373
|
-
/** @description Public ID of the data
|
372
|
+
DataSource: {
|
373
|
+
/** @description Public ID of the data source */
|
374
374
|
id: string;
|
375
|
-
/** @description Display name of the data
|
375
|
+
/** @description Display name of the data source */
|
376
376
|
displayName: string;
|
377
377
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
378
378
|
connectorType: string;
|
379
|
-
/** @description Base resource URL of the data
|
379
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
380
380
|
baseUrl: string;
|
381
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
382
381
|
headers?: {
|
383
382
|
[key: string]: string;
|
384
|
-
}
|
385
|
-
|
383
|
+
} | {
|
384
|
+
key: string;
|
385
|
+
value: string;
|
386
|
+
}[];
|
386
387
|
parameters?: {
|
387
388
|
[key: string]: string;
|
388
|
-
}
|
389
|
-
|
389
|
+
} | {
|
390
|
+
key: string;
|
391
|
+
value: string;
|
392
|
+
}[];
|
393
|
+
/** @description Variables needed to make calls to the data source */
|
390
394
|
variables?: {
|
391
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
395
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
392
396
|
};
|
393
|
-
/** @description Custom configuration specific to the data
|
397
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
394
398
|
custom?: {
|
395
399
|
[key: string]: unknown;
|
396
400
|
};
|
397
401
|
};
|
398
402
|
/**
|
399
403
|
* @deprecated
|
400
|
-
* @description A specific type of data that a Data
|
404
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
401
405
|
*/
|
402
406
|
DataType: {
|
403
407
|
/** @description Public ID of the data type */
|
404
408
|
id: string;
|
405
409
|
/** @description Display name of the data type */
|
406
410
|
displayName: string;
|
407
|
-
/** @description Public ID of the associated data
|
408
|
-
|
411
|
+
/** @description Public ID of the associated data source */
|
412
|
+
dataSourceId: string;
|
409
413
|
/**
|
410
414
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
411
415
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -413,16 +417,24 @@ interface external$4 {
|
|
413
417
|
*/
|
414
418
|
archetype?: string;
|
415
419
|
allowedOnComponents?: string[];
|
416
|
-
/** @description Resource path, appended to the data
|
420
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
417
421
|
path: string;
|
418
|
-
/** @description
|
422
|
+
/** @description Time-to-live for the resource data cache. */
|
423
|
+
ttl?: number;
|
424
|
+
/** @description A key for the resource data cache purging. */
|
425
|
+
purgeKey?: string;
|
419
426
|
headers?: {
|
420
427
|
[key: string]: string;
|
421
|
-
}
|
422
|
-
|
428
|
+
} | {
|
429
|
+
key: string;
|
430
|
+
value: string;
|
431
|
+
}[];
|
423
432
|
parameters?: {
|
424
433
|
[key: string]: string;
|
425
|
-
}
|
434
|
+
} | {
|
435
|
+
key: string;
|
436
|
+
value: string;
|
437
|
+
}[];
|
426
438
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
427
439
|
body?: string;
|
428
440
|
/**
|
@@ -431,11 +443,11 @@ interface external$4 {
|
|
431
443
|
* @enum {string}
|
432
444
|
*/
|
433
445
|
method: "GET" | "POST" | "HEAD";
|
434
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
446
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
435
447
|
variables?: {
|
436
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
448
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
437
449
|
};
|
438
|
-
/** @description Custom configuration specific to the data
|
450
|
+
/** @description Custom configuration specific to the data source being defined */
|
439
451
|
custom?: {
|
440
452
|
[key: string]: unknown;
|
441
453
|
};
|
@@ -444,7 +456,7 @@ interface external$4 {
|
|
444
456
|
* @deprecated
|
445
457
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
446
458
|
*/
|
447
|
-
|
459
|
+
DataVariableDefinition: {
|
448
460
|
/** @description Display name of the data variable */
|
449
461
|
displayName?: string;
|
450
462
|
/**
|
@@ -465,25 +477,25 @@ interface external$4 {
|
|
465
477
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
466
478
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
467
479
|
*/
|
468
|
-
|
469
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
480
|
+
DataResourceDefinitions: {
|
481
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
470
482
|
};
|
471
483
|
/**
|
472
484
|
* @deprecated
|
473
|
-
* @description
|
485
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
474
486
|
*/
|
475
|
-
|
487
|
+
DataResourceDefinition: {
|
476
488
|
/** @description Public ID of the data type that provides this data */
|
477
489
|
type: string;
|
478
490
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
479
491
|
isPatternParameter?: boolean;
|
480
|
-
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
492
|
+
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
481
493
|
};
|
482
494
|
/**
|
483
495
|
* @deprecated
|
484
|
-
* @description
|
496
|
+
* @description Variable values for a data resource.
|
485
497
|
*/
|
486
|
-
|
498
|
+
DataResourceVariables: {
|
487
499
|
[key: string]: string;
|
488
500
|
};
|
489
501
|
};
|
@@ -620,24 +632,24 @@ interface components$1 {
|
|
620
632
|
value: unknown;
|
621
633
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
622
634
|
type: string;
|
623
|
-
|
635
|
+
connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
|
624
636
|
};
|
625
637
|
/**
|
626
638
|
* @deprecated
|
627
|
-
* @description Defines a
|
639
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
628
640
|
*/
|
629
|
-
|
630
|
-
/** @description A JSON Pointer expression that defines the
|
641
|
+
DataElementConnectionDefinition: {
|
642
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
631
643
|
pointer: string;
|
632
644
|
/**
|
633
|
-
* @description The syntax
|
645
|
+
* @description The syntax used to select the data element to bind to
|
634
646
|
* @enum {string}
|
635
647
|
*/
|
636
648
|
syntax: "jptr";
|
637
649
|
/**
|
638
|
-
* @description Whether
|
639
|
-
*
|
640
|
-
*
|
650
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
651
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
652
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
641
653
|
*
|
642
654
|
* @default false
|
643
655
|
*/
|
@@ -661,14 +673,14 @@ interface components$1 {
|
|
661
673
|
_id?: string;
|
662
674
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
663
675
|
_pattern?: string;
|
664
|
-
|
676
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
665
677
|
/**
|
666
678
|
* @deprecated
|
667
679
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
668
680
|
* Means nothing for PUTs; it will be ignored.
|
669
681
|
*/
|
670
|
-
|
671
|
-
[key: string]: components$1["schemas"]["
|
682
|
+
_patternDataResources?: {
|
683
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
672
684
|
};
|
673
685
|
/**
|
674
686
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -700,63 +712,67 @@ interface components$1 {
|
|
700
712
|
_slug?: string | null;
|
701
713
|
/** @description Friendly name of this component. */
|
702
714
|
_name: string;
|
703
|
-
|
715
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
704
716
|
};
|
705
717
|
/**
|
706
718
|
* @deprecated
|
707
|
-
* @description Basic information about
|
719
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
708
720
|
*/
|
709
|
-
|
710
|
-
/** @description Public ID of the data
|
721
|
+
DataSourceInfo: {
|
722
|
+
/** @description Public ID of the data source */
|
711
723
|
id: string;
|
712
|
-
/** @description Display name of the data
|
724
|
+
/** @description Display name of the data source */
|
713
725
|
displayName: string;
|
714
726
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
715
727
|
connectorType: string;
|
716
|
-
/** @description Base resource URL of the data
|
728
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
717
729
|
baseUrl: string;
|
718
730
|
};
|
719
731
|
/**
|
720
732
|
* @deprecated
|
721
|
-
* @description An instance of
|
733
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
722
734
|
*/
|
723
|
-
|
724
|
-
/** @description Public ID of the data
|
735
|
+
DataSource: {
|
736
|
+
/** @description Public ID of the data source */
|
725
737
|
id: string;
|
726
|
-
/** @description Display name of the data
|
738
|
+
/** @description Display name of the data source */
|
727
739
|
displayName: string;
|
728
740
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
729
741
|
connectorType: string;
|
730
|
-
/** @description Base resource URL of the data
|
742
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
731
743
|
baseUrl: string;
|
732
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
733
744
|
headers?: {
|
734
745
|
[key: string]: string;
|
735
|
-
}
|
736
|
-
|
746
|
+
} | {
|
747
|
+
key: string;
|
748
|
+
value: string;
|
749
|
+
}[];
|
737
750
|
parameters?: {
|
738
751
|
[key: string]: string;
|
739
|
-
}
|
740
|
-
|
752
|
+
} | {
|
753
|
+
key: string;
|
754
|
+
value: string;
|
755
|
+
}[];
|
756
|
+
/** @description Variables needed to make calls to the data source */
|
741
757
|
variables?: {
|
742
|
-
[key: string]: components$1["schemas"]["
|
758
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
743
759
|
};
|
744
|
-
/** @description Custom configuration specific to the data
|
760
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
745
761
|
custom?: {
|
746
762
|
[key: string]: unknown;
|
747
763
|
};
|
748
764
|
};
|
749
765
|
/**
|
750
766
|
* @deprecated
|
751
|
-
* @description A specific type of data that a Data
|
767
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
752
768
|
*/
|
753
769
|
DataType: {
|
754
770
|
/** @description Public ID of the data type */
|
755
771
|
id: string;
|
756
772
|
/** @description Display name of the data type */
|
757
773
|
displayName: string;
|
758
|
-
/** @description Public ID of the associated data
|
759
|
-
|
774
|
+
/** @description Public ID of the associated data source */
|
775
|
+
dataSourceId: string;
|
760
776
|
/**
|
761
777
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
762
778
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -764,16 +780,24 @@ interface components$1 {
|
|
764
780
|
*/
|
765
781
|
archetype?: string;
|
766
782
|
allowedOnComponents?: string[];
|
767
|
-
/** @description Resource path, appended to the data
|
783
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
768
784
|
path: string;
|
769
|
-
/** @description
|
785
|
+
/** @description Time-to-live for the resource data cache. */
|
786
|
+
ttl?: number;
|
787
|
+
/** @description A key for the resource data cache purging. */
|
788
|
+
purgeKey?: string;
|
770
789
|
headers?: {
|
771
790
|
[key: string]: string;
|
772
|
-
}
|
773
|
-
|
791
|
+
} | {
|
792
|
+
key: string;
|
793
|
+
value: string;
|
794
|
+
}[];
|
774
795
|
parameters?: {
|
775
796
|
[key: string]: string;
|
776
|
-
}
|
797
|
+
} | {
|
798
|
+
key: string;
|
799
|
+
value: string;
|
800
|
+
}[];
|
777
801
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
778
802
|
body?: string;
|
779
803
|
/**
|
@@ -782,11 +806,11 @@ interface components$1 {
|
|
782
806
|
* @enum {string}
|
783
807
|
*/
|
784
808
|
method: "GET" | "POST" | "HEAD";
|
785
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
809
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
786
810
|
variables?: {
|
787
|
-
[key: string]: components$1["schemas"]["
|
811
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
788
812
|
};
|
789
|
-
/** @description Custom configuration specific to the data
|
813
|
+
/** @description Custom configuration specific to the data source being defined */
|
790
814
|
custom?: {
|
791
815
|
[key: string]: unknown;
|
792
816
|
};
|
@@ -795,7 +819,7 @@ interface components$1 {
|
|
795
819
|
* @deprecated
|
796
820
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
797
821
|
*/
|
798
|
-
|
822
|
+
DataVariableDefinition: {
|
799
823
|
/** @description Display name of the data variable */
|
800
824
|
displayName?: string;
|
801
825
|
/**
|
@@ -816,25 +840,25 @@ interface components$1 {
|
|
816
840
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
817
841
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
818
842
|
*/
|
819
|
-
|
820
|
-
[key: string]: components$1["schemas"]["
|
843
|
+
DataResourceDefinitions: {
|
844
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
821
845
|
};
|
822
846
|
/**
|
823
847
|
* @deprecated
|
824
|
-
* @description
|
848
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
825
849
|
*/
|
826
|
-
|
850
|
+
DataResourceDefinition: {
|
827
851
|
/** @description Public ID of the data type that provides this data */
|
828
852
|
type: string;
|
829
853
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
830
854
|
isPatternParameter?: boolean;
|
831
|
-
variables?: components$1["schemas"]["
|
855
|
+
variables?: components$1["schemas"]["DataResourceVariables"];
|
832
856
|
};
|
833
857
|
/**
|
834
858
|
* @deprecated
|
835
|
-
* @description
|
859
|
+
* @description Variable values for a data resource.
|
836
860
|
*/
|
837
|
-
|
861
|
+
DataResourceVariables: {
|
838
862
|
[key: string]: string;
|
839
863
|
};
|
840
864
|
};
|
@@ -892,6 +916,12 @@ interface paths$3 {
|
|
892
916
|
compositionIDs?: string[];
|
893
917
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
894
918
|
slug?: string;
|
919
|
+
/** Specify a single composition to fetch by assodicated Sitemap Node ID. Changes response from list to single. */
|
920
|
+
sitemapNodeId?: string;
|
921
|
+
/** Specify a single composition to fetch by assodicated Sitemap Node path. Changes response from list to single. */
|
922
|
+
sitemapNodePath?: string;
|
923
|
+
/** Required when using sitemap node id or path for fetch. */
|
924
|
+
sitemapId?: string;
|
895
925
|
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
896
926
|
type?: string[];
|
897
927
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -908,8 +938,8 @@ interface paths$3 {
|
|
908
938
|
skipEnhance?: boolean;
|
909
939
|
/**
|
910
940
|
* If true, any pattern references in the composition will be left unresolved.
|
911
|
-
* This is appropriate if you intend to serialize the composition
|
912
|
-
*
|
941
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
942
|
+
* embedded into it, and serialize the pattern data separately.
|
913
943
|
*/
|
914
944
|
skipPatternResolution?: boolean;
|
915
945
|
/**
|
@@ -1256,24 +1286,24 @@ interface external$3 {
|
|
1256
1286
|
value: unknown;
|
1257
1287
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1258
1288
|
type: string;
|
1259
|
-
|
1289
|
+
connectedData?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1260
1290
|
};
|
1261
1291
|
/**
|
1262
1292
|
* @deprecated
|
1263
|
-
* @description Defines a
|
1293
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1264
1294
|
*/
|
1265
|
-
|
1266
|
-
/** @description A JSON Pointer expression that defines the
|
1295
|
+
DataElementConnectionDefinition: {
|
1296
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
1267
1297
|
pointer: string;
|
1268
1298
|
/**
|
1269
|
-
* @description The syntax
|
1299
|
+
* @description The syntax used to select the data element to bind to
|
1270
1300
|
* @enum {string}
|
1271
1301
|
*/
|
1272
1302
|
syntax: "jptr";
|
1273
1303
|
/**
|
1274
|
-
* @description Whether
|
1275
|
-
*
|
1276
|
-
*
|
1304
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
1305
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
1306
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
1277
1307
|
*
|
1278
1308
|
* @default false
|
1279
1309
|
*/
|
@@ -1297,14 +1327,14 @@ interface external$3 {
|
|
1297
1327
|
_id?: string;
|
1298
1328
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1299
1329
|
_pattern?: string;
|
1300
|
-
|
1330
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1301
1331
|
/**
|
1302
1332
|
* @deprecated
|
1303
1333
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1304
1334
|
* Means nothing for PUTs; it will be ignored.
|
1305
1335
|
*/
|
1306
|
-
|
1307
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1336
|
+
_patternDataResources?: {
|
1337
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1308
1338
|
};
|
1309
1339
|
/**
|
1310
1340
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1336,63 +1366,67 @@ interface external$3 {
|
|
1336
1366
|
_slug?: string | null;
|
1337
1367
|
/** @description Friendly name of this component. */
|
1338
1368
|
_name: string;
|
1339
|
-
|
1369
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1340
1370
|
};
|
1341
1371
|
/**
|
1342
1372
|
* @deprecated
|
1343
|
-
* @description Basic information about
|
1373
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
1344
1374
|
*/
|
1345
|
-
|
1346
|
-
/** @description Public ID of the data
|
1375
|
+
DataSourceInfo: {
|
1376
|
+
/** @description Public ID of the data source */
|
1347
1377
|
id: string;
|
1348
|
-
/** @description Display name of the data
|
1378
|
+
/** @description Display name of the data source */
|
1349
1379
|
displayName: string;
|
1350
1380
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1351
1381
|
connectorType: string;
|
1352
|
-
/** @description Base resource URL of the data
|
1382
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1353
1383
|
baseUrl: string;
|
1354
1384
|
};
|
1355
1385
|
/**
|
1356
1386
|
* @deprecated
|
1357
|
-
* @description An instance of
|
1387
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
1358
1388
|
*/
|
1359
|
-
|
1360
|
-
/** @description Public ID of the data
|
1389
|
+
DataSource: {
|
1390
|
+
/** @description Public ID of the data source */
|
1361
1391
|
id: string;
|
1362
|
-
/** @description Display name of the data
|
1392
|
+
/** @description Display name of the data source */
|
1363
1393
|
displayName: string;
|
1364
1394
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1365
1395
|
connectorType: string;
|
1366
|
-
/** @description Base resource URL of the data
|
1396
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1367
1397
|
baseUrl: string;
|
1368
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
1369
1398
|
headers?: {
|
1370
1399
|
[key: string]: string;
|
1371
|
-
}
|
1372
|
-
|
1400
|
+
} | {
|
1401
|
+
key: string;
|
1402
|
+
value: string;
|
1403
|
+
}[];
|
1373
1404
|
parameters?: {
|
1374
1405
|
[key: string]: string;
|
1375
|
-
}
|
1376
|
-
|
1406
|
+
} | {
|
1407
|
+
key: string;
|
1408
|
+
value: string;
|
1409
|
+
}[];
|
1410
|
+
/** @description Variables needed to make calls to the data source */
|
1377
1411
|
variables?: {
|
1378
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1412
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1379
1413
|
};
|
1380
|
-
/** @description Custom configuration specific to the data
|
1414
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1381
1415
|
custom?: {
|
1382
1416
|
[key: string]: unknown;
|
1383
1417
|
};
|
1384
1418
|
};
|
1385
1419
|
/**
|
1386
1420
|
* @deprecated
|
1387
|
-
* @description A specific type of data that a Data
|
1421
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
1388
1422
|
*/
|
1389
1423
|
DataType: {
|
1390
1424
|
/** @description Public ID of the data type */
|
1391
1425
|
id: string;
|
1392
1426
|
/** @description Display name of the data type */
|
1393
1427
|
displayName: string;
|
1394
|
-
/** @description Public ID of the associated data
|
1395
|
-
|
1428
|
+
/** @description Public ID of the associated data source */
|
1429
|
+
dataSourceId: string;
|
1396
1430
|
/**
|
1397
1431
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1398
1432
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1400,16 +1434,24 @@ interface external$3 {
|
|
1400
1434
|
*/
|
1401
1435
|
archetype?: string;
|
1402
1436
|
allowedOnComponents?: string[];
|
1403
|
-
/** @description Resource path, appended to the data
|
1437
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
1404
1438
|
path: string;
|
1405
|
-
/** @description
|
1439
|
+
/** @description Time-to-live for the resource data cache. */
|
1440
|
+
ttl?: number;
|
1441
|
+
/** @description A key for the resource data cache purging. */
|
1442
|
+
purgeKey?: string;
|
1406
1443
|
headers?: {
|
1407
1444
|
[key: string]: string;
|
1408
|
-
}
|
1409
|
-
|
1445
|
+
} | {
|
1446
|
+
key: string;
|
1447
|
+
value: string;
|
1448
|
+
}[];
|
1410
1449
|
parameters?: {
|
1411
1450
|
[key: string]: string;
|
1412
|
-
}
|
1451
|
+
} | {
|
1452
|
+
key: string;
|
1453
|
+
value: string;
|
1454
|
+
}[];
|
1413
1455
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1414
1456
|
body?: string;
|
1415
1457
|
/**
|
@@ -1418,11 +1460,11 @@ interface external$3 {
|
|
1418
1460
|
* @enum {string}
|
1419
1461
|
*/
|
1420
1462
|
method: "GET" | "POST" | "HEAD";
|
1421
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
1463
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1422
1464
|
variables?: {
|
1423
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1465
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1424
1466
|
};
|
1425
|
-
/** @description Custom configuration specific to the data
|
1467
|
+
/** @description Custom configuration specific to the data source being defined */
|
1426
1468
|
custom?: {
|
1427
1469
|
[key: string]: unknown;
|
1428
1470
|
};
|
@@ -1431,7 +1473,7 @@ interface external$3 {
|
|
1431
1473
|
* @deprecated
|
1432
1474
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1433
1475
|
*/
|
1434
|
-
|
1476
|
+
DataVariableDefinition: {
|
1435
1477
|
/** @description Display name of the data variable */
|
1436
1478
|
displayName?: string;
|
1437
1479
|
/**
|
@@ -1452,25 +1494,25 @@ interface external$3 {
|
|
1452
1494
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1453
1495
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1454
1496
|
*/
|
1455
|
-
|
1456
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1497
|
+
DataResourceDefinitions: {
|
1498
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1457
1499
|
};
|
1458
1500
|
/**
|
1459
1501
|
* @deprecated
|
1460
|
-
* @description
|
1502
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1461
1503
|
*/
|
1462
|
-
|
1504
|
+
DataResourceDefinition: {
|
1463
1505
|
/** @description Public ID of the data type that provides this data */
|
1464
1506
|
type: string;
|
1465
1507
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
1466
1508
|
isPatternParameter?: boolean;
|
1467
|
-
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1509
|
+
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1468
1510
|
};
|
1469
1511
|
/**
|
1470
1512
|
* @deprecated
|
1471
|
-
* @description
|
1513
|
+
* @description Variable values for a data resource.
|
1472
1514
|
*/
|
1473
|
-
|
1515
|
+
DataResourceVariables: {
|
1474
1516
|
[key: string]: string;
|
1475
1517
|
};
|
1476
1518
|
};
|
@@ -1510,14 +1552,17 @@ declare type ComponentParameter<TValue = unknown> = Omit<SharedComponents['Compo
|
|
1510
1552
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1511
1553
|
value: TValue;
|
1512
1554
|
};
|
1513
|
-
/** Defines a
|
1514
|
-
declare type
|
1515
|
-
/**
|
1516
|
-
declare type
|
1517
|
-
/**
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1555
|
+
/** Defines a connection to a data element on a data resource. */
|
1556
|
+
declare type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
1557
|
+
/** Variable values for a data resource. */
|
1558
|
+
declare type DataResourceVariables = SharedComponents['DataResourceVariables'];
|
1559
|
+
/**
|
1560
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
1561
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1562
|
+
*/
|
1563
|
+
declare type DataResourceDefinitions = SharedComponents['DataResourceDefinitions'];
|
1564
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1565
|
+
declare type DataResourceDefinition = SharedComponents['DataResourceDefinition'];
|
1521
1566
|
/** Defines the shape of a component instance served by the composition API. */
|
1522
1567
|
declare type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
1523
1568
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
@@ -1775,24 +1820,24 @@ interface external$2 {
|
|
1775
1820
|
value: unknown;
|
1776
1821
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1777
1822
|
type: string;
|
1778
|
-
|
1823
|
+
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1779
1824
|
};
|
1780
1825
|
/**
|
1781
1826
|
* @deprecated
|
1782
|
-
* @description Defines a
|
1827
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1783
1828
|
*/
|
1784
|
-
|
1785
|
-
/** @description A JSON Pointer expression that defines the
|
1829
|
+
DataElementConnectionDefinition: {
|
1830
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
1786
1831
|
pointer: string;
|
1787
1832
|
/**
|
1788
|
-
* @description The syntax
|
1833
|
+
* @description The syntax used to select the data element to bind to
|
1789
1834
|
* @enum {string}
|
1790
1835
|
*/
|
1791
1836
|
syntax: "jptr";
|
1792
1837
|
/**
|
1793
|
-
* @description Whether
|
1794
|
-
*
|
1795
|
-
*
|
1838
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
1839
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
1840
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
1796
1841
|
*
|
1797
1842
|
* @default false
|
1798
1843
|
*/
|
@@ -1816,14 +1861,14 @@ interface external$2 {
|
|
1816
1861
|
_id?: string;
|
1817
1862
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1818
1863
|
_pattern?: string;
|
1819
|
-
|
1864
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1820
1865
|
/**
|
1821
1866
|
* @deprecated
|
1822
1867
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1823
1868
|
* Means nothing for PUTs; it will be ignored.
|
1824
1869
|
*/
|
1825
|
-
|
1826
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1870
|
+
_patternDataResources?: {
|
1871
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1827
1872
|
};
|
1828
1873
|
/**
|
1829
1874
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1855,63 +1900,67 @@ interface external$2 {
|
|
1855
1900
|
_slug?: string | null;
|
1856
1901
|
/** @description Friendly name of this component. */
|
1857
1902
|
_name: string;
|
1858
|
-
|
1903
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1859
1904
|
};
|
1860
1905
|
/**
|
1861
1906
|
* @deprecated
|
1862
|
-
* @description Basic information about
|
1907
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
1863
1908
|
*/
|
1864
|
-
|
1865
|
-
/** @description Public ID of the data
|
1909
|
+
DataSourceInfo: {
|
1910
|
+
/** @description Public ID of the data source */
|
1866
1911
|
id: string;
|
1867
|
-
/** @description Display name of the data
|
1912
|
+
/** @description Display name of the data source */
|
1868
1913
|
displayName: string;
|
1869
1914
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1870
1915
|
connectorType: string;
|
1871
|
-
/** @description Base resource URL of the data
|
1916
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1872
1917
|
baseUrl: string;
|
1873
1918
|
};
|
1874
1919
|
/**
|
1875
1920
|
* @deprecated
|
1876
|
-
* @description An instance of
|
1921
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
1877
1922
|
*/
|
1878
|
-
|
1879
|
-
/** @description Public ID of the data
|
1923
|
+
DataSource: {
|
1924
|
+
/** @description Public ID of the data source */
|
1880
1925
|
id: string;
|
1881
|
-
/** @description Display name of the data
|
1926
|
+
/** @description Display name of the data source */
|
1882
1927
|
displayName: string;
|
1883
1928
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1884
1929
|
connectorType: string;
|
1885
|
-
/** @description Base resource URL of the data
|
1930
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1886
1931
|
baseUrl: string;
|
1887
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
1888
1932
|
headers?: {
|
1889
1933
|
[key: string]: string;
|
1890
|
-
}
|
1891
|
-
|
1934
|
+
} | {
|
1935
|
+
key: string;
|
1936
|
+
value: string;
|
1937
|
+
}[];
|
1892
1938
|
parameters?: {
|
1893
1939
|
[key: string]: string;
|
1894
|
-
}
|
1895
|
-
|
1940
|
+
} | {
|
1941
|
+
key: string;
|
1942
|
+
value: string;
|
1943
|
+
}[];
|
1944
|
+
/** @description Variables needed to make calls to the data source */
|
1896
1945
|
variables?: {
|
1897
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1946
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1898
1947
|
};
|
1899
|
-
/** @description Custom configuration specific to the data
|
1948
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1900
1949
|
custom?: {
|
1901
1950
|
[key: string]: unknown;
|
1902
1951
|
};
|
1903
1952
|
};
|
1904
1953
|
/**
|
1905
1954
|
* @deprecated
|
1906
|
-
* @description A specific type of data that a Data
|
1955
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
1907
1956
|
*/
|
1908
1957
|
DataType: {
|
1909
1958
|
/** @description Public ID of the data type */
|
1910
1959
|
id: string;
|
1911
1960
|
/** @description Display name of the data type */
|
1912
1961
|
displayName: string;
|
1913
|
-
/** @description Public ID of the associated data
|
1914
|
-
|
1962
|
+
/** @description Public ID of the associated data source */
|
1963
|
+
dataSourceId: string;
|
1915
1964
|
/**
|
1916
1965
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1917
1966
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1919,16 +1968,24 @@ interface external$2 {
|
|
1919
1968
|
*/
|
1920
1969
|
archetype?: string;
|
1921
1970
|
allowedOnComponents?: string[];
|
1922
|
-
/** @description Resource path, appended to the data
|
1971
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
1923
1972
|
path: string;
|
1924
|
-
/** @description
|
1973
|
+
/** @description Time-to-live for the resource data cache. */
|
1974
|
+
ttl?: number;
|
1975
|
+
/** @description A key for the resource data cache purging. */
|
1976
|
+
purgeKey?: string;
|
1925
1977
|
headers?: {
|
1926
1978
|
[key: string]: string;
|
1927
|
-
}
|
1928
|
-
|
1979
|
+
} | {
|
1980
|
+
key: string;
|
1981
|
+
value: string;
|
1982
|
+
}[];
|
1929
1983
|
parameters?: {
|
1930
1984
|
[key: string]: string;
|
1931
|
-
}
|
1985
|
+
} | {
|
1986
|
+
key: string;
|
1987
|
+
value: string;
|
1988
|
+
}[];
|
1932
1989
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1933
1990
|
body?: string;
|
1934
1991
|
/**
|
@@ -1937,11 +1994,11 @@ interface external$2 {
|
|
1937
1994
|
* @enum {string}
|
1938
1995
|
*/
|
1939
1996
|
method: "GET" | "POST" | "HEAD";
|
1940
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
1997
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1941
1998
|
variables?: {
|
1942
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1999
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1943
2000
|
};
|
1944
|
-
/** @description Custom configuration specific to the data
|
2001
|
+
/** @description Custom configuration specific to the data source being defined */
|
1945
2002
|
custom?: {
|
1946
2003
|
[key: string]: unknown;
|
1947
2004
|
};
|
@@ -1950,7 +2007,7 @@ interface external$2 {
|
|
1950
2007
|
* @deprecated
|
1951
2008
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1952
2009
|
*/
|
1953
|
-
|
2010
|
+
DataVariableDefinition: {
|
1954
2011
|
/** @description Display name of the data variable */
|
1955
2012
|
displayName?: string;
|
1956
2013
|
/**
|
@@ -1971,25 +2028,25 @@ interface external$2 {
|
|
1971
2028
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1972
2029
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1973
2030
|
*/
|
1974
|
-
|
1975
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2031
|
+
DataResourceDefinitions: {
|
2032
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1976
2033
|
};
|
1977
2034
|
/**
|
1978
2035
|
* @deprecated
|
1979
|
-
* @description
|
2036
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1980
2037
|
*/
|
1981
|
-
|
2038
|
+
DataResourceDefinition: {
|
1982
2039
|
/** @description Public ID of the data type that provides this data */
|
1983
2040
|
type: string;
|
1984
2041
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
1985
2042
|
isPatternParameter?: boolean;
|
1986
|
-
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2043
|
+
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1987
2044
|
};
|
1988
2045
|
/**
|
1989
2046
|
* @deprecated
|
1990
|
-
* @description
|
2047
|
+
* @description Variable values for a data resource.
|
1991
2048
|
*/
|
1992
|
-
|
2049
|
+
DataResourceVariables: {
|
1993
2050
|
[key: string]: string;
|
1994
2051
|
};
|
1995
2052
|
};
|
@@ -2003,11 +2060,11 @@ interface external$2 {
|
|
2003
2060
|
* Do not make direct changes to the file.
|
2004
2061
|
*/
|
2005
2062
|
interface paths$1 {
|
2006
|
-
"/api/v1/data-
|
2063
|
+
"/api/v1/data-source": {
|
2007
2064
|
get: {
|
2008
2065
|
parameters: {
|
2009
2066
|
query: {
|
2010
|
-
|
2067
|
+
dataSourceId: string;
|
2011
2068
|
projectId: string;
|
2012
2069
|
};
|
2013
2070
|
};
|
@@ -2016,7 +2073,7 @@ interface paths$1 {
|
|
2016
2073
|
200: {
|
2017
2074
|
content: {
|
2018
2075
|
"application/json": {
|
2019
|
-
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2076
|
+
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2020
2077
|
};
|
2021
2078
|
};
|
2022
2079
|
};
|
@@ -2040,7 +2097,7 @@ interface paths$1 {
|
|
2040
2097
|
requestBody: {
|
2041
2098
|
content: {
|
2042
2099
|
"application/json": {
|
2043
|
-
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2100
|
+
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2044
2101
|
/** Format: uuid */
|
2045
2102
|
projectId: string;
|
2046
2103
|
/** Format: uuid */
|
@@ -2062,7 +2119,7 @@ interface paths$1 {
|
|
2062
2119
|
requestBody: {
|
2063
2120
|
content: {
|
2064
2121
|
"application/json": {
|
2065
|
-
|
2122
|
+
dataSourceId: string;
|
2066
2123
|
/** Format: uuid */
|
2067
2124
|
projectId: string;
|
2068
2125
|
};
|
@@ -2244,24 +2301,24 @@ interface external$1 {
|
|
2244
2301
|
value: unknown;
|
2245
2302
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2246
2303
|
type: string;
|
2247
|
-
|
2304
|
+
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2248
2305
|
};
|
2249
2306
|
/**
|
2250
2307
|
* @deprecated
|
2251
|
-
* @description Defines a
|
2308
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2252
2309
|
*/
|
2253
|
-
|
2254
|
-
/** @description A JSON Pointer expression that defines the
|
2310
|
+
DataElementConnectionDefinition: {
|
2311
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
2255
2312
|
pointer: string;
|
2256
2313
|
/**
|
2257
|
-
* @description The syntax
|
2314
|
+
* @description The syntax used to select the data element to bind to
|
2258
2315
|
* @enum {string}
|
2259
2316
|
*/
|
2260
2317
|
syntax: "jptr";
|
2261
2318
|
/**
|
2262
|
-
* @description Whether
|
2263
|
-
*
|
2264
|
-
*
|
2319
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
2320
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
2321
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
2265
2322
|
*
|
2266
2323
|
* @default false
|
2267
2324
|
*/
|
@@ -2285,14 +2342,14 @@ interface external$1 {
|
|
2285
2342
|
_id?: string;
|
2286
2343
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2287
2344
|
_pattern?: string;
|
2288
|
-
|
2345
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2289
2346
|
/**
|
2290
2347
|
* @deprecated
|
2291
2348
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2292
2349
|
* Means nothing for PUTs; it will be ignored.
|
2293
2350
|
*/
|
2294
|
-
|
2295
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2351
|
+
_patternDataResources?: {
|
2352
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2296
2353
|
};
|
2297
2354
|
/**
|
2298
2355
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2324,63 +2381,67 @@ interface external$1 {
|
|
2324
2381
|
_slug?: string | null;
|
2325
2382
|
/** @description Friendly name of this component. */
|
2326
2383
|
_name: string;
|
2327
|
-
|
2384
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2328
2385
|
};
|
2329
2386
|
/**
|
2330
2387
|
* @deprecated
|
2331
|
-
* @description Basic information about
|
2388
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
2332
2389
|
*/
|
2333
|
-
|
2334
|
-
/** @description Public ID of the data
|
2390
|
+
DataSourceInfo: {
|
2391
|
+
/** @description Public ID of the data source */
|
2335
2392
|
id: string;
|
2336
|
-
/** @description Display name of the data
|
2393
|
+
/** @description Display name of the data source */
|
2337
2394
|
displayName: string;
|
2338
2395
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2339
2396
|
connectorType: string;
|
2340
|
-
/** @description Base resource URL of the data
|
2397
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2341
2398
|
baseUrl: string;
|
2342
2399
|
};
|
2343
2400
|
/**
|
2344
2401
|
* @deprecated
|
2345
|
-
* @description An instance of
|
2402
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
2346
2403
|
*/
|
2347
|
-
|
2348
|
-
/** @description Public ID of the data
|
2404
|
+
DataSource: {
|
2405
|
+
/** @description Public ID of the data source */
|
2349
2406
|
id: string;
|
2350
|
-
/** @description Display name of the data
|
2407
|
+
/** @description Display name of the data source */
|
2351
2408
|
displayName: string;
|
2352
2409
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2353
2410
|
connectorType: string;
|
2354
|
-
/** @description Base resource URL of the data
|
2411
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2355
2412
|
baseUrl: string;
|
2356
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
2357
2413
|
headers?: {
|
2358
2414
|
[key: string]: string;
|
2359
|
-
}
|
2360
|
-
|
2415
|
+
} | {
|
2416
|
+
key: string;
|
2417
|
+
value: string;
|
2418
|
+
}[];
|
2361
2419
|
parameters?: {
|
2362
2420
|
[key: string]: string;
|
2363
|
-
}
|
2364
|
-
|
2421
|
+
} | {
|
2422
|
+
key: string;
|
2423
|
+
value: string;
|
2424
|
+
}[];
|
2425
|
+
/** @description Variables needed to make calls to the data source */
|
2365
2426
|
variables?: {
|
2366
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2427
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2367
2428
|
};
|
2368
|
-
/** @description Custom configuration specific to the data
|
2429
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2369
2430
|
custom?: {
|
2370
2431
|
[key: string]: unknown;
|
2371
2432
|
};
|
2372
2433
|
};
|
2373
2434
|
/**
|
2374
2435
|
* @deprecated
|
2375
|
-
* @description A specific type of data that a Data
|
2436
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
2376
2437
|
*/
|
2377
2438
|
DataType: {
|
2378
2439
|
/** @description Public ID of the data type */
|
2379
2440
|
id: string;
|
2380
2441
|
/** @description Display name of the data type */
|
2381
2442
|
displayName: string;
|
2382
|
-
/** @description Public ID of the associated data
|
2383
|
-
|
2443
|
+
/** @description Public ID of the associated data source */
|
2444
|
+
dataSourceId: string;
|
2384
2445
|
/**
|
2385
2446
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2386
2447
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2388,16 +2449,24 @@ interface external$1 {
|
|
2388
2449
|
*/
|
2389
2450
|
archetype?: string;
|
2390
2451
|
allowedOnComponents?: string[];
|
2391
|
-
/** @description Resource path, appended to the data
|
2452
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
2392
2453
|
path: string;
|
2393
|
-
/** @description
|
2454
|
+
/** @description Time-to-live for the resource data cache. */
|
2455
|
+
ttl?: number;
|
2456
|
+
/** @description A key for the resource data cache purging. */
|
2457
|
+
purgeKey?: string;
|
2394
2458
|
headers?: {
|
2395
2459
|
[key: string]: string;
|
2396
|
-
}
|
2397
|
-
|
2460
|
+
} | {
|
2461
|
+
key: string;
|
2462
|
+
value: string;
|
2463
|
+
}[];
|
2398
2464
|
parameters?: {
|
2399
2465
|
[key: string]: string;
|
2400
|
-
}
|
2466
|
+
} | {
|
2467
|
+
key: string;
|
2468
|
+
value: string;
|
2469
|
+
}[];
|
2401
2470
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2402
2471
|
body?: string;
|
2403
2472
|
/**
|
@@ -2406,11 +2475,11 @@ interface external$1 {
|
|
2406
2475
|
* @enum {string}
|
2407
2476
|
*/
|
2408
2477
|
method: "GET" | "POST" | "HEAD";
|
2409
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
2478
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2410
2479
|
variables?: {
|
2411
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2480
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2412
2481
|
};
|
2413
|
-
/** @description Custom configuration specific to the data
|
2482
|
+
/** @description Custom configuration specific to the data source being defined */
|
2414
2483
|
custom?: {
|
2415
2484
|
[key: string]: unknown;
|
2416
2485
|
};
|
@@ -2419,7 +2488,7 @@ interface external$1 {
|
|
2419
2488
|
* @deprecated
|
2420
2489
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2421
2490
|
*/
|
2422
|
-
|
2491
|
+
DataVariableDefinition: {
|
2423
2492
|
/** @description Display name of the data variable */
|
2424
2493
|
displayName?: string;
|
2425
2494
|
/**
|
@@ -2440,25 +2509,25 @@ interface external$1 {
|
|
2440
2509
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2441
2510
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2442
2511
|
*/
|
2443
|
-
|
2444
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2512
|
+
DataResourceDefinitions: {
|
2513
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2445
2514
|
};
|
2446
2515
|
/**
|
2447
2516
|
* @deprecated
|
2448
|
-
* @description
|
2517
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2449
2518
|
*/
|
2450
|
-
|
2519
|
+
DataResourceDefinition: {
|
2451
2520
|
/** @description Public ID of the data type that provides this data */
|
2452
2521
|
type: string;
|
2453
2522
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
2454
2523
|
isPatternParameter?: boolean;
|
2455
|
-
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2524
|
+
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2456
2525
|
};
|
2457
2526
|
/**
|
2458
2527
|
* @deprecated
|
2459
|
-
* @description
|
2528
|
+
* @description Variable values for a data resource.
|
2460
2529
|
*/
|
2461
|
-
|
2530
|
+
DataResourceVariables: {
|
2462
2531
|
[key: string]: string;
|
2463
2532
|
};
|
2464
2533
|
};
|
@@ -2472,7 +2541,7 @@ interface external$1 {
|
|
2472
2541
|
* Do not make direct changes to the file.
|
2473
2542
|
*/
|
2474
2543
|
interface paths {
|
2475
|
-
"/api/v1/data-
|
2544
|
+
"/api/v1/data-sources": {
|
2476
2545
|
get: {
|
2477
2546
|
parameters: {
|
2478
2547
|
query: {
|
@@ -2484,7 +2553,7 @@ interface paths {
|
|
2484
2553
|
200: {
|
2485
2554
|
content: {
|
2486
2555
|
"application/json": {
|
2487
|
-
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2556
|
+
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSourceInfo"][];
|
2488
2557
|
};
|
2489
2558
|
};
|
2490
2559
|
};
|
@@ -2670,24 +2739,24 @@ interface external {
|
|
2670
2739
|
value: unknown;
|
2671
2740
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2672
2741
|
type: string;
|
2673
|
-
|
2742
|
+
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2674
2743
|
};
|
2675
2744
|
/**
|
2676
2745
|
* @deprecated
|
2677
|
-
* @description Defines a
|
2746
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2678
2747
|
*/
|
2679
|
-
|
2680
|
-
/** @description A JSON Pointer expression that defines the
|
2748
|
+
DataElementConnectionDefinition: {
|
2749
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
2681
2750
|
pointer: string;
|
2682
2751
|
/**
|
2683
|
-
* @description The syntax
|
2752
|
+
* @description The syntax used to select the data element to bind to
|
2684
2753
|
* @enum {string}
|
2685
2754
|
*/
|
2686
2755
|
syntax: "jptr";
|
2687
2756
|
/**
|
2688
|
-
* @description Whether
|
2689
|
-
*
|
2690
|
-
*
|
2757
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
2758
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
2759
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
2691
2760
|
*
|
2692
2761
|
* @default false
|
2693
2762
|
*/
|
@@ -2711,14 +2780,14 @@ interface external {
|
|
2711
2780
|
_id?: string;
|
2712
2781
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2713
2782
|
_pattern?: string;
|
2714
|
-
|
2783
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2715
2784
|
/**
|
2716
2785
|
* @deprecated
|
2717
2786
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2718
2787
|
* Means nothing for PUTs; it will be ignored.
|
2719
2788
|
*/
|
2720
|
-
|
2721
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2789
|
+
_patternDataResources?: {
|
2790
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2722
2791
|
};
|
2723
2792
|
/**
|
2724
2793
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2750,63 +2819,67 @@ interface external {
|
|
2750
2819
|
_slug?: string | null;
|
2751
2820
|
/** @description Friendly name of this component. */
|
2752
2821
|
_name: string;
|
2753
|
-
|
2822
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2754
2823
|
};
|
2755
2824
|
/**
|
2756
2825
|
* @deprecated
|
2757
|
-
* @description Basic information about
|
2826
|
+
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
2758
2827
|
*/
|
2759
|
-
|
2760
|
-
/** @description Public ID of the data
|
2828
|
+
DataSourceInfo: {
|
2829
|
+
/** @description Public ID of the data source */
|
2761
2830
|
id: string;
|
2762
|
-
/** @description Display name of the data
|
2831
|
+
/** @description Display name of the data source */
|
2763
2832
|
displayName: string;
|
2764
2833
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2765
2834
|
connectorType: string;
|
2766
|
-
/** @description Base resource URL of the data
|
2835
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2767
2836
|
baseUrl: string;
|
2768
2837
|
};
|
2769
2838
|
/**
|
2770
2839
|
* @deprecated
|
2771
|
-
* @description An instance of
|
2840
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
2772
2841
|
*/
|
2773
|
-
|
2774
|
-
/** @description Public ID of the data
|
2842
|
+
DataSource: {
|
2843
|
+
/** @description Public ID of the data source */
|
2775
2844
|
id: string;
|
2776
|
-
/** @description Display name of the data
|
2845
|
+
/** @description Display name of the data source */
|
2777
2846
|
displayName: string;
|
2778
2847
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2779
2848
|
connectorType: string;
|
2780
|
-
/** @description Base resource URL of the data
|
2849
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2781
2850
|
baseUrl: string;
|
2782
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
2783
2851
|
headers?: {
|
2784
2852
|
[key: string]: string;
|
2785
|
-
}
|
2786
|
-
|
2853
|
+
} | {
|
2854
|
+
key: string;
|
2855
|
+
value: string;
|
2856
|
+
}[];
|
2787
2857
|
parameters?: {
|
2788
2858
|
[key: string]: string;
|
2789
|
-
}
|
2790
|
-
|
2859
|
+
} | {
|
2860
|
+
key: string;
|
2861
|
+
value: string;
|
2862
|
+
}[];
|
2863
|
+
/** @description Variables needed to make calls to the data source */
|
2791
2864
|
variables?: {
|
2792
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2865
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2793
2866
|
};
|
2794
|
-
/** @description Custom configuration specific to the data
|
2867
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2795
2868
|
custom?: {
|
2796
2869
|
[key: string]: unknown;
|
2797
2870
|
};
|
2798
2871
|
};
|
2799
2872
|
/**
|
2800
2873
|
* @deprecated
|
2801
|
-
* @description A specific type of data that a Data
|
2874
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
2802
2875
|
*/
|
2803
2876
|
DataType: {
|
2804
2877
|
/** @description Public ID of the data type */
|
2805
2878
|
id: string;
|
2806
2879
|
/** @description Display name of the data type */
|
2807
2880
|
displayName: string;
|
2808
|
-
/** @description Public ID of the associated data
|
2809
|
-
|
2881
|
+
/** @description Public ID of the associated data source */
|
2882
|
+
dataSourceId: string;
|
2810
2883
|
/**
|
2811
2884
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2812
2885
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2814,16 +2887,24 @@ interface external {
|
|
2814
2887
|
*/
|
2815
2888
|
archetype?: string;
|
2816
2889
|
allowedOnComponents?: string[];
|
2817
|
-
/** @description Resource path, appended to the data
|
2890
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
2818
2891
|
path: string;
|
2819
|
-
/** @description
|
2892
|
+
/** @description Time-to-live for the resource data cache. */
|
2893
|
+
ttl?: number;
|
2894
|
+
/** @description A key for the resource data cache purging. */
|
2895
|
+
purgeKey?: string;
|
2820
2896
|
headers?: {
|
2821
2897
|
[key: string]: string;
|
2822
|
-
}
|
2823
|
-
|
2898
|
+
} | {
|
2899
|
+
key: string;
|
2900
|
+
value: string;
|
2901
|
+
}[];
|
2824
2902
|
parameters?: {
|
2825
2903
|
[key: string]: string;
|
2826
|
-
}
|
2904
|
+
} | {
|
2905
|
+
key: string;
|
2906
|
+
value: string;
|
2907
|
+
}[];
|
2827
2908
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2828
2909
|
body?: string;
|
2829
2910
|
/**
|
@@ -2832,11 +2913,11 @@ interface external {
|
|
2832
2913
|
* @enum {string}
|
2833
2914
|
*/
|
2834
2915
|
method: "GET" | "POST" | "HEAD";
|
2835
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
2916
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2836
2917
|
variables?: {
|
2837
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2918
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2838
2919
|
};
|
2839
|
-
/** @description Custom configuration specific to the data
|
2920
|
+
/** @description Custom configuration specific to the data source being defined */
|
2840
2921
|
custom?: {
|
2841
2922
|
[key: string]: unknown;
|
2842
2923
|
};
|
@@ -2845,7 +2926,7 @@ interface external {
|
|
2845
2926
|
* @deprecated
|
2846
2927
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2847
2928
|
*/
|
2848
|
-
|
2929
|
+
DataVariableDefinition: {
|
2849
2930
|
/** @description Display name of the data variable */
|
2850
2931
|
displayName?: string;
|
2851
2932
|
/**
|
@@ -2866,25 +2947,25 @@ interface external {
|
|
2866
2947
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2867
2948
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2868
2949
|
*/
|
2869
|
-
|
2870
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2950
|
+
DataResourceDefinitions: {
|
2951
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2871
2952
|
};
|
2872
2953
|
/**
|
2873
2954
|
* @deprecated
|
2874
|
-
* @description
|
2955
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2875
2956
|
*/
|
2876
|
-
|
2957
|
+
DataResourceDefinition: {
|
2877
2958
|
/** @description Public ID of the data type that provides this data */
|
2878
2959
|
type: string;
|
2879
2960
|
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
2880
2961
|
isPatternParameter?: boolean;
|
2881
|
-
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2962
|
+
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2882
2963
|
};
|
2883
2964
|
/**
|
2884
2965
|
* @deprecated
|
2885
|
-
* @description
|
2966
|
+
* @description Variable values for a data resource.
|
2886
2967
|
*/
|
2887
|
-
|
2968
|
+
DataResourceVariables: {
|
2888
2969
|
[key: string]: string;
|
2889
2970
|
};
|
2890
2971
|
};
|
@@ -2894,8 +2975,8 @@ interface external {
|
|
2894
2975
|
}
|
2895
2976
|
|
2896
2977
|
declare type DataTypeApi = paths$2['/api/v1/data-types'];
|
2897
|
-
declare type
|
2898
|
-
declare type
|
2978
|
+
declare type DataSourcesApi = paths['/api/v1/data-sources'];
|
2979
|
+
declare type DataSourceApi = paths$1['/api/v1/data-source'];
|
2899
2980
|
/** Query parameter options for GET /api/v1/data-types */
|
2900
2981
|
declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
2901
2982
|
/** The GET response from /api/v1/data-types */
|
@@ -2904,22 +2985,22 @@ declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['conte
|
|
2904
2985
|
declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
2905
2986
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
2906
2987
|
declare type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
2907
|
-
/** Query parameter options for GET /api/v1/data-
|
2908
|
-
declare type
|
2909
|
-
/** Query parameter options for GET /api/v1/data-
|
2910
|
-
declare type
|
2911
|
-
/** The GET response from /api/v1/data-
|
2912
|
-
declare type
|
2913
|
-
/** The GET response from /api/v1/data-
|
2914
|
-
declare type
|
2915
|
-
/** The PUT request body for /api/v1/data-
|
2916
|
-
declare type
|
2917
|
-
/** Shape of the DELETE request body for /api/v1/data-
|
2918
|
-
declare type
|
2988
|
+
/** Query parameter options for GET /api/v1/data-source */
|
2989
|
+
declare type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
2990
|
+
/** Query parameter options for GET /api/v1/data-sources */
|
2991
|
+
declare type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
2992
|
+
/** The GET response from /api/v1/data-sources */
|
2993
|
+
declare type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
2994
|
+
/** The GET response from /api/v1/data-sources */
|
2995
|
+
declare type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
2996
|
+
/** The PUT request body for /api/v1/data-source */
|
2997
|
+
declare type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
2998
|
+
/** Shape of the DELETE request body for /api/v1/data-source */
|
2999
|
+
declare type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
2919
3000
|
declare type DataType = components$1['schemas']['DataType'];
|
2920
|
-
declare type
|
2921
|
-
declare type
|
2922
|
-
declare type
|
3001
|
+
declare type DataSource = components$1['schemas']['DataSource'];
|
3002
|
+
declare type DataSourceInfo = components$1['schemas']['DataSourceInfo'];
|
3003
|
+
declare type DataVariableDefinition = components$1['schemas']['DataVariableDefinition'];
|
2923
3004
|
|
2924
3005
|
/**
|
2925
3006
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
@@ -2946,4 +3027,4 @@ declare global {
|
|
2946
3027
|
*/
|
2947
3028
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
2948
3029
|
|
2949
|
-
export { CreatingComponentDefinition as A, CompositionGetOrderBy as B, ComponentInstance as C,
|
3030
|
+
export { CreatingComponentDefinition as A, CompositionGetOrderBy as B, ComponentInstance as C, DataSourceGetParameters as D, CompositionUIStatus as E, CompositionGetListResponse as F, CompositionAPIResponse as G, CompositionAPIDeleteRequest as H, CompositionListAPIResponse as I, CompositionAPIOptions as J, DataElementConnectionDefinition as K, DataResourceVariables as L, DataResourceDefinitions as M, DataResourceDefinition as N, CanvasDefinitions as O, PreviewEventBus as P, DataSourceGetResponse as Q, RootComponentInstance as R, DataSourcesGetResponse as S, DataType as T, DataSource as U, DataSourceInfo as V, DataVariableDefinition as W, ChannelSubscription as X, createEventBus as Y, ComponentParameter as a, CompositionGetParameters as b, CompositionPutParameters as c, CompositionDeleteParameters as d, ComponentDefinitionGetParameters as e, ComponentDefinitionPutParameters as f, ComponentDefinitionDeleteParameters as g, DataSourcesGetParameters as h, DataSourcePutParameters as i, DataSourceDeleteParameters as j, DataTypeGetParameters as k, DataTypeGetResponse as l, DataTypePutParameters as m, DataTypeDeleteParameters as n, CompositionGetResponse as o, ComponentDefinitionGetResponse as p, ComponentDefinitionAPIResponse as q, ComponentDefinitionAPIPutRequest as r, ComponentDefinitionAPIDeleteRequest as s, ComponentDefinitionListAPIOptions as t, ComponentDefinitionParameter as u, ComponentDefinitionVariant as v, ComponentDefinitionSlugSettings as w, ComponentDefinitionSlot as x, ComponentDefinitionPermission as y, ComponentDefinition as z };
|