@uniformdev/canvas 17.3.0 → 17.3.1-alpha.117
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/cli/cli.d.ts +1 -1
- package/dist/cli/cli.js +59 -59
- package/dist/cli/cli.mjs +49 -49
- package/dist/{createEventBus-6f48d55f.d.ts → createEventBus-4b8ecb61.d.ts} +308 -299
- package/dist/index.d.ts +188 -36
- 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,63 @@ 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
|
381
|
+
/** @description HTTP headers to pass with requests to the data source */
|
382
382
|
headers?: {
|
383
383
|
[key: string]: string;
|
384
384
|
};
|
385
|
-
/** @description Query String parameters to pass with requests to the data
|
385
|
+
/** @description Query String parameters to pass with requests to the data source */
|
386
386
|
parameters?: {
|
387
387
|
[key: string]: string;
|
388
388
|
};
|
389
|
-
/** @description Variables needed to make calls to the data
|
389
|
+
/** @description Variables needed to make calls to the data source */
|
390
390
|
variables?: {
|
391
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
391
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
392
392
|
};
|
393
|
-
/** @description Custom configuration specific to the data
|
393
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
394
394
|
custom?: {
|
395
395
|
[key: string]: unknown;
|
396
396
|
};
|
397
397
|
};
|
398
398
|
/**
|
399
399
|
* @deprecated
|
400
|
-
* @description A specific type of data that a Data
|
400
|
+
* @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
401
|
*/
|
402
402
|
DataType: {
|
403
403
|
/** @description Public ID of the data type */
|
404
404
|
id: string;
|
405
405
|
/** @description Display name of the data type */
|
406
406
|
displayName: string;
|
407
|
-
/** @description Public ID of the associated data
|
408
|
-
|
407
|
+
/** @description Public ID of the associated data source */
|
408
|
+
dataSourceId: string;
|
409
409
|
/**
|
410
410
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
411
411
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -413,13 +413,13 @@ interface external$4 {
|
|
413
413
|
*/
|
414
414
|
archetype?: string;
|
415
415
|
allowedOnComponents?: string[];
|
416
|
-
/** @description Resource path, appended to the data
|
416
|
+
/** @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
417
|
path: string;
|
418
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
418
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
419
419
|
headers?: {
|
420
420
|
[key: string]: string;
|
421
421
|
};
|
422
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
422
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
423
423
|
parameters?: {
|
424
424
|
[key: string]: string;
|
425
425
|
};
|
@@ -431,11 +431,11 @@ interface external$4 {
|
|
431
431
|
* @enum {string}
|
432
432
|
*/
|
433
433
|
method: "GET" | "POST" | "HEAD";
|
434
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
434
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
435
435
|
variables?: {
|
436
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
436
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
437
437
|
};
|
438
|
-
/** @description Custom configuration specific to the data
|
438
|
+
/** @description Custom configuration specific to the data source being defined */
|
439
439
|
custom?: {
|
440
440
|
[key: string]: unknown;
|
441
441
|
};
|
@@ -444,7 +444,7 @@ interface external$4 {
|
|
444
444
|
* @deprecated
|
445
445
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
446
446
|
*/
|
447
|
-
|
447
|
+
DataVariableDefinition: {
|
448
448
|
/** @description Display name of the data variable */
|
449
449
|
displayName?: string;
|
450
450
|
/**
|
@@ -465,25 +465,25 @@ interface external$4 {
|
|
465
465
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
466
466
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
467
467
|
*/
|
468
|
-
|
469
|
-
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
468
|
+
DataResourceDefinitions: {
|
469
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
470
470
|
};
|
471
471
|
/**
|
472
472
|
* @deprecated
|
473
|
-
* @description
|
473
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
474
474
|
*/
|
475
|
-
|
475
|
+
DataResourceDefinition: {
|
476
476
|
/** @description Public ID of the data type that provides this data */
|
477
477
|
type: string;
|
478
478
|
/** @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
479
|
isPatternParameter?: boolean;
|
480
|
-
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
480
|
+
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
481
481
|
};
|
482
482
|
/**
|
483
483
|
* @deprecated
|
484
|
-
* @description
|
484
|
+
* @description Variable values for a data resource.
|
485
485
|
*/
|
486
|
-
|
486
|
+
DataResourceVariables: {
|
487
487
|
[key: string]: string;
|
488
488
|
};
|
489
489
|
};
|
@@ -620,24 +620,24 @@ interface components$1 {
|
|
620
620
|
value: unknown;
|
621
621
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
622
622
|
type: string;
|
623
|
-
|
623
|
+
connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
|
624
624
|
};
|
625
625
|
/**
|
626
626
|
* @deprecated
|
627
|
-
* @description Defines a
|
627
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
628
628
|
*/
|
629
|
-
|
630
|
-
/** @description A JSON Pointer expression that defines the
|
629
|
+
DataElementConnectionDefinition: {
|
630
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
631
631
|
pointer: string;
|
632
632
|
/**
|
633
|
-
* @description The syntax
|
633
|
+
* @description The syntax used to select the data element to bind to
|
634
634
|
* @enum {string}
|
635
635
|
*/
|
636
636
|
syntax: "jptr";
|
637
637
|
/**
|
638
|
-
* @description Whether
|
639
|
-
*
|
640
|
-
*
|
638
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
639
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
640
|
+
* 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
641
|
*
|
642
642
|
* @default false
|
643
643
|
*/
|
@@ -661,14 +661,14 @@ interface components$1 {
|
|
661
661
|
_id?: string;
|
662
662
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
663
663
|
_pattern?: string;
|
664
|
-
|
664
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
665
665
|
/**
|
666
666
|
* @deprecated
|
667
667
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
668
668
|
* Means nothing for PUTs; it will be ignored.
|
669
669
|
*/
|
670
|
-
|
671
|
-
[key: string]: components$1["schemas"]["
|
670
|
+
_patternDataResources?: {
|
671
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
672
672
|
};
|
673
673
|
/**
|
674
674
|
* @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 +700,63 @@ interface components$1 {
|
|
700
700
|
_slug?: string | null;
|
701
701
|
/** @description Friendly name of this component. */
|
702
702
|
_name: string;
|
703
|
-
|
703
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
704
704
|
};
|
705
705
|
/**
|
706
706
|
* @deprecated
|
707
|
-
* @description Basic information about
|
707
|
+
* @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
708
|
*/
|
709
|
-
|
710
|
-
/** @description Public ID of the data
|
709
|
+
DataSourceInfo: {
|
710
|
+
/** @description Public ID of the data source */
|
711
711
|
id: string;
|
712
|
-
/** @description Display name of the data
|
712
|
+
/** @description Display name of the data source */
|
713
713
|
displayName: string;
|
714
714
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
715
715
|
connectorType: string;
|
716
|
-
/** @description Base resource URL of the data
|
716
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
717
717
|
baseUrl: string;
|
718
718
|
};
|
719
719
|
/**
|
720
720
|
* @deprecated
|
721
|
-
* @description An instance of
|
721
|
+
* @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
722
|
*/
|
723
|
-
|
724
|
-
/** @description Public ID of the data
|
723
|
+
DataSource: {
|
724
|
+
/** @description Public ID of the data source */
|
725
725
|
id: string;
|
726
|
-
/** @description Display name of the data
|
726
|
+
/** @description Display name of the data source */
|
727
727
|
displayName: string;
|
728
728
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
729
729
|
connectorType: string;
|
730
|
-
/** @description Base resource URL of the data
|
730
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
731
731
|
baseUrl: string;
|
732
|
-
/** @description HTTP headers to pass with requests to the data
|
732
|
+
/** @description HTTP headers to pass with requests to the data source */
|
733
733
|
headers?: {
|
734
734
|
[key: string]: string;
|
735
735
|
};
|
736
|
-
/** @description Query String parameters to pass with requests to the data
|
736
|
+
/** @description Query String parameters to pass with requests to the data source */
|
737
737
|
parameters?: {
|
738
738
|
[key: string]: string;
|
739
739
|
};
|
740
|
-
/** @description Variables needed to make calls to the data
|
740
|
+
/** @description Variables needed to make calls to the data source */
|
741
741
|
variables?: {
|
742
|
-
[key: string]: components$1["schemas"]["
|
742
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
743
743
|
};
|
744
|
-
/** @description Custom configuration specific to the data
|
744
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
745
745
|
custom?: {
|
746
746
|
[key: string]: unknown;
|
747
747
|
};
|
748
748
|
};
|
749
749
|
/**
|
750
750
|
* @deprecated
|
751
|
-
* @description A specific type of data that a Data
|
751
|
+
* @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
752
|
*/
|
753
753
|
DataType: {
|
754
754
|
/** @description Public ID of the data type */
|
755
755
|
id: string;
|
756
756
|
/** @description Display name of the data type */
|
757
757
|
displayName: string;
|
758
|
-
/** @description Public ID of the associated data
|
759
|
-
|
758
|
+
/** @description Public ID of the associated data source */
|
759
|
+
dataSourceId: string;
|
760
760
|
/**
|
761
761
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
762
762
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -764,13 +764,13 @@ interface components$1 {
|
|
764
764
|
*/
|
765
765
|
archetype?: string;
|
766
766
|
allowedOnComponents?: string[];
|
767
|
-
/** @description Resource path, appended to the data
|
767
|
+
/** @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
768
|
path: string;
|
769
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
769
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
770
770
|
headers?: {
|
771
771
|
[key: string]: string;
|
772
772
|
};
|
773
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
773
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
774
774
|
parameters?: {
|
775
775
|
[key: string]: string;
|
776
776
|
};
|
@@ -782,11 +782,11 @@ interface components$1 {
|
|
782
782
|
* @enum {string}
|
783
783
|
*/
|
784
784
|
method: "GET" | "POST" | "HEAD";
|
785
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
785
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
786
786
|
variables?: {
|
787
|
-
[key: string]: components$1["schemas"]["
|
787
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
788
788
|
};
|
789
|
-
/** @description Custom configuration specific to the data
|
789
|
+
/** @description Custom configuration specific to the data source being defined */
|
790
790
|
custom?: {
|
791
791
|
[key: string]: unknown;
|
792
792
|
};
|
@@ -795,7 +795,7 @@ interface components$1 {
|
|
795
795
|
* @deprecated
|
796
796
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
797
797
|
*/
|
798
|
-
|
798
|
+
DataVariableDefinition: {
|
799
799
|
/** @description Display name of the data variable */
|
800
800
|
displayName?: string;
|
801
801
|
/**
|
@@ -816,25 +816,25 @@ interface components$1 {
|
|
816
816
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
817
817
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
818
818
|
*/
|
819
|
-
|
820
|
-
[key: string]: components$1["schemas"]["
|
819
|
+
DataResourceDefinitions: {
|
820
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
821
821
|
};
|
822
822
|
/**
|
823
823
|
* @deprecated
|
824
|
-
* @description
|
824
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
825
825
|
*/
|
826
|
-
|
826
|
+
DataResourceDefinition: {
|
827
827
|
/** @description Public ID of the data type that provides this data */
|
828
828
|
type: string;
|
829
829
|
/** @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
830
|
isPatternParameter?: boolean;
|
831
|
-
variables?: components$1["schemas"]["
|
831
|
+
variables?: components$1["schemas"]["DataResourceVariables"];
|
832
832
|
};
|
833
833
|
/**
|
834
834
|
* @deprecated
|
835
|
-
* @description
|
835
|
+
* @description Variable values for a data resource.
|
836
836
|
*/
|
837
|
-
|
837
|
+
DataResourceVariables: {
|
838
838
|
[key: string]: string;
|
839
839
|
};
|
840
840
|
};
|
@@ -892,6 +892,12 @@ interface paths$3 {
|
|
892
892
|
compositionIDs?: string[];
|
893
893
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
894
894
|
slug?: string;
|
895
|
+
/** Specify a single composition to fetch by assodicated Sitemap Node ID. Changes response from list to single. */
|
896
|
+
sitemapNodeId?: string;
|
897
|
+
/** Specify a single composition to fetch by assodicated Sitemap Node path. Changes response from list to single. */
|
898
|
+
sitemapNodePath?: string;
|
899
|
+
/** Required when using sitemap node id or path for fetch. */
|
900
|
+
sitemapId?: string;
|
895
901
|
/** 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
902
|
type?: string[];
|
897
903
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
@@ -908,8 +914,8 @@ interface paths$3 {
|
|
908
914
|
skipEnhance?: boolean;
|
909
915
|
/**
|
910
916
|
* If true, any pattern references in the composition will be left unresolved.
|
911
|
-
* This is appropriate if you intend to serialize the composition
|
912
|
-
*
|
917
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
918
|
+
* embedded into it, and serialize the pattern data separately.
|
913
919
|
*/
|
914
920
|
skipPatternResolution?: boolean;
|
915
921
|
/**
|
@@ -1256,24 +1262,24 @@ interface external$3 {
|
|
1256
1262
|
value: unknown;
|
1257
1263
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1258
1264
|
type: string;
|
1259
|
-
|
1265
|
+
connectedData?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1260
1266
|
};
|
1261
1267
|
/**
|
1262
1268
|
* @deprecated
|
1263
|
-
* @description Defines a
|
1269
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1264
1270
|
*/
|
1265
|
-
|
1266
|
-
/** @description A JSON Pointer expression that defines the
|
1271
|
+
DataElementConnectionDefinition: {
|
1272
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
1267
1273
|
pointer: string;
|
1268
1274
|
/**
|
1269
|
-
* @description The syntax
|
1275
|
+
* @description The syntax used to select the data element to bind to
|
1270
1276
|
* @enum {string}
|
1271
1277
|
*/
|
1272
1278
|
syntax: "jptr";
|
1273
1279
|
/**
|
1274
|
-
* @description Whether
|
1275
|
-
*
|
1276
|
-
*
|
1280
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
1281
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
1282
|
+
* 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
1283
|
*
|
1278
1284
|
* @default false
|
1279
1285
|
*/
|
@@ -1297,14 +1303,14 @@ interface external$3 {
|
|
1297
1303
|
_id?: string;
|
1298
1304
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1299
1305
|
_pattern?: string;
|
1300
|
-
|
1306
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1301
1307
|
/**
|
1302
1308
|
* @deprecated
|
1303
1309
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1304
1310
|
* Means nothing for PUTs; it will be ignored.
|
1305
1311
|
*/
|
1306
|
-
|
1307
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1312
|
+
_patternDataResources?: {
|
1313
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1308
1314
|
};
|
1309
1315
|
/**
|
1310
1316
|
* @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 +1342,63 @@ interface external$3 {
|
|
1336
1342
|
_slug?: string | null;
|
1337
1343
|
/** @description Friendly name of this component. */
|
1338
1344
|
_name: string;
|
1339
|
-
|
1345
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1340
1346
|
};
|
1341
1347
|
/**
|
1342
1348
|
* @deprecated
|
1343
|
-
* @description Basic information about
|
1349
|
+
* @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
1350
|
*/
|
1345
|
-
|
1346
|
-
/** @description Public ID of the data
|
1351
|
+
DataSourceInfo: {
|
1352
|
+
/** @description Public ID of the data source */
|
1347
1353
|
id: string;
|
1348
|
-
/** @description Display name of the data
|
1354
|
+
/** @description Display name of the data source */
|
1349
1355
|
displayName: string;
|
1350
1356
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1351
1357
|
connectorType: string;
|
1352
|
-
/** @description Base resource URL of the data
|
1358
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1353
1359
|
baseUrl: string;
|
1354
1360
|
};
|
1355
1361
|
/**
|
1356
1362
|
* @deprecated
|
1357
|
-
* @description An instance of
|
1363
|
+
* @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
1364
|
*/
|
1359
|
-
|
1360
|
-
/** @description Public ID of the data
|
1365
|
+
DataSource: {
|
1366
|
+
/** @description Public ID of the data source */
|
1361
1367
|
id: string;
|
1362
|
-
/** @description Display name of the data
|
1368
|
+
/** @description Display name of the data source */
|
1363
1369
|
displayName: string;
|
1364
1370
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1365
1371
|
connectorType: string;
|
1366
|
-
/** @description Base resource URL of the data
|
1372
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1367
1373
|
baseUrl: string;
|
1368
|
-
/** @description HTTP headers to pass with requests to the data
|
1374
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1369
1375
|
headers?: {
|
1370
1376
|
[key: string]: string;
|
1371
1377
|
};
|
1372
|
-
/** @description Query String parameters to pass with requests to the data
|
1378
|
+
/** @description Query String parameters to pass with requests to the data source */
|
1373
1379
|
parameters?: {
|
1374
1380
|
[key: string]: string;
|
1375
1381
|
};
|
1376
|
-
/** @description Variables needed to make calls to the data
|
1382
|
+
/** @description Variables needed to make calls to the data source */
|
1377
1383
|
variables?: {
|
1378
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1384
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1379
1385
|
};
|
1380
|
-
/** @description Custom configuration specific to the data
|
1386
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1381
1387
|
custom?: {
|
1382
1388
|
[key: string]: unknown;
|
1383
1389
|
};
|
1384
1390
|
};
|
1385
1391
|
/**
|
1386
1392
|
* @deprecated
|
1387
|
-
* @description A specific type of data that a Data
|
1393
|
+
* @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
1394
|
*/
|
1389
1395
|
DataType: {
|
1390
1396
|
/** @description Public ID of the data type */
|
1391
1397
|
id: string;
|
1392
1398
|
/** @description Display name of the data type */
|
1393
1399
|
displayName: string;
|
1394
|
-
/** @description Public ID of the associated data
|
1395
|
-
|
1400
|
+
/** @description Public ID of the associated data source */
|
1401
|
+
dataSourceId: string;
|
1396
1402
|
/**
|
1397
1403
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1398
1404
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1400,13 +1406,13 @@ interface external$3 {
|
|
1400
1406
|
*/
|
1401
1407
|
archetype?: string;
|
1402
1408
|
allowedOnComponents?: string[];
|
1403
|
-
/** @description Resource path, appended to the data
|
1409
|
+
/** @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
1410
|
path: string;
|
1405
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
1411
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1406
1412
|
headers?: {
|
1407
1413
|
[key: string]: string;
|
1408
1414
|
};
|
1409
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
1415
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1410
1416
|
parameters?: {
|
1411
1417
|
[key: string]: string;
|
1412
1418
|
};
|
@@ -1418,11 +1424,11 @@ interface external$3 {
|
|
1418
1424
|
* @enum {string}
|
1419
1425
|
*/
|
1420
1426
|
method: "GET" | "POST" | "HEAD";
|
1421
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
1427
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1422
1428
|
variables?: {
|
1423
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1429
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1424
1430
|
};
|
1425
|
-
/** @description Custom configuration specific to the data
|
1431
|
+
/** @description Custom configuration specific to the data source being defined */
|
1426
1432
|
custom?: {
|
1427
1433
|
[key: string]: unknown;
|
1428
1434
|
};
|
@@ -1431,7 +1437,7 @@ interface external$3 {
|
|
1431
1437
|
* @deprecated
|
1432
1438
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1433
1439
|
*/
|
1434
|
-
|
1440
|
+
DataVariableDefinition: {
|
1435
1441
|
/** @description Display name of the data variable */
|
1436
1442
|
displayName?: string;
|
1437
1443
|
/**
|
@@ -1452,25 +1458,25 @@ interface external$3 {
|
|
1452
1458
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1453
1459
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1454
1460
|
*/
|
1455
|
-
|
1456
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1461
|
+
DataResourceDefinitions: {
|
1462
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1457
1463
|
};
|
1458
1464
|
/**
|
1459
1465
|
* @deprecated
|
1460
|
-
* @description
|
1466
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1461
1467
|
*/
|
1462
|
-
|
1468
|
+
DataResourceDefinition: {
|
1463
1469
|
/** @description Public ID of the data type that provides this data */
|
1464
1470
|
type: string;
|
1465
1471
|
/** @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
1472
|
isPatternParameter?: boolean;
|
1467
|
-
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1473
|
+
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1468
1474
|
};
|
1469
1475
|
/**
|
1470
1476
|
* @deprecated
|
1471
|
-
* @description
|
1477
|
+
* @description Variable values for a data resource.
|
1472
1478
|
*/
|
1473
|
-
|
1479
|
+
DataResourceVariables: {
|
1474
1480
|
[key: string]: string;
|
1475
1481
|
};
|
1476
1482
|
};
|
@@ -1510,14 +1516,17 @@ declare type ComponentParameter<TValue = unknown> = Omit<SharedComponents['Compo
|
|
1510
1516
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1511
1517
|
value: TValue;
|
1512
1518
|
};
|
1513
|
-
/** Defines a
|
1514
|
-
declare type
|
1515
|
-
/**
|
1516
|
-
declare type
|
1517
|
-
/**
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1519
|
+
/** Defines a connection to a data element on a data resource. */
|
1520
|
+
declare type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
1521
|
+
/** Variable values for a data resource. */
|
1522
|
+
declare type DataResourceVariables = SharedComponents['DataResourceVariables'];
|
1523
|
+
/**
|
1524
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
1525
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1526
|
+
*/
|
1527
|
+
declare type DataResourceDefinitions = SharedComponents['DataResourceDefinitions'];
|
1528
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1529
|
+
declare type DataResourceDefinition = SharedComponents['DataResourceDefinition'];
|
1521
1530
|
/** Defines the shape of a component instance served by the composition API. */
|
1522
1531
|
declare type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
1523
1532
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
@@ -1775,24 +1784,24 @@ interface external$2 {
|
|
1775
1784
|
value: unknown;
|
1776
1785
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1777
1786
|
type: string;
|
1778
|
-
|
1787
|
+
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1779
1788
|
};
|
1780
1789
|
/**
|
1781
1790
|
* @deprecated
|
1782
|
-
* @description Defines a
|
1791
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1783
1792
|
*/
|
1784
|
-
|
1785
|
-
/** @description A JSON Pointer expression that defines the
|
1793
|
+
DataElementConnectionDefinition: {
|
1794
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
1786
1795
|
pointer: string;
|
1787
1796
|
/**
|
1788
|
-
* @description The syntax
|
1797
|
+
* @description The syntax used to select the data element to bind to
|
1789
1798
|
* @enum {string}
|
1790
1799
|
*/
|
1791
1800
|
syntax: "jptr";
|
1792
1801
|
/**
|
1793
|
-
* @description Whether
|
1794
|
-
*
|
1795
|
-
*
|
1802
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
1803
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
1804
|
+
* 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
1805
|
*
|
1797
1806
|
* @default false
|
1798
1807
|
*/
|
@@ -1816,14 +1825,14 @@ interface external$2 {
|
|
1816
1825
|
_id?: string;
|
1817
1826
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1818
1827
|
_pattern?: string;
|
1819
|
-
|
1828
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1820
1829
|
/**
|
1821
1830
|
* @deprecated
|
1822
1831
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1823
1832
|
* Means nothing for PUTs; it will be ignored.
|
1824
1833
|
*/
|
1825
|
-
|
1826
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1834
|
+
_patternDataResources?: {
|
1835
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1827
1836
|
};
|
1828
1837
|
/**
|
1829
1838
|
* @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 +1864,63 @@ interface external$2 {
|
|
1855
1864
|
_slug?: string | null;
|
1856
1865
|
/** @description Friendly name of this component. */
|
1857
1866
|
_name: string;
|
1858
|
-
|
1867
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1859
1868
|
};
|
1860
1869
|
/**
|
1861
1870
|
* @deprecated
|
1862
|
-
* @description Basic information about
|
1871
|
+
* @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
1872
|
*/
|
1864
|
-
|
1865
|
-
/** @description Public ID of the data
|
1873
|
+
DataSourceInfo: {
|
1874
|
+
/** @description Public ID of the data source */
|
1866
1875
|
id: string;
|
1867
|
-
/** @description Display name of the data
|
1876
|
+
/** @description Display name of the data source */
|
1868
1877
|
displayName: string;
|
1869
1878
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1870
1879
|
connectorType: string;
|
1871
|
-
/** @description Base resource URL of the data
|
1880
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1872
1881
|
baseUrl: string;
|
1873
1882
|
};
|
1874
1883
|
/**
|
1875
1884
|
* @deprecated
|
1876
|
-
* @description An instance of
|
1885
|
+
* @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
1886
|
*/
|
1878
|
-
|
1879
|
-
/** @description Public ID of the data
|
1887
|
+
DataSource: {
|
1888
|
+
/** @description Public ID of the data source */
|
1880
1889
|
id: string;
|
1881
|
-
/** @description Display name of the data
|
1890
|
+
/** @description Display name of the data source */
|
1882
1891
|
displayName: string;
|
1883
1892
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1884
1893
|
connectorType: string;
|
1885
|
-
/** @description Base resource URL of the data
|
1894
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1886
1895
|
baseUrl: string;
|
1887
|
-
/** @description HTTP headers to pass with requests to the data
|
1896
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1888
1897
|
headers?: {
|
1889
1898
|
[key: string]: string;
|
1890
1899
|
};
|
1891
|
-
/** @description Query String parameters to pass with requests to the data
|
1900
|
+
/** @description Query String parameters to pass with requests to the data source */
|
1892
1901
|
parameters?: {
|
1893
1902
|
[key: string]: string;
|
1894
1903
|
};
|
1895
|
-
/** @description Variables needed to make calls to the data
|
1904
|
+
/** @description Variables needed to make calls to the data source */
|
1896
1905
|
variables?: {
|
1897
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1906
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1898
1907
|
};
|
1899
|
-
/** @description Custom configuration specific to the data
|
1908
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1900
1909
|
custom?: {
|
1901
1910
|
[key: string]: unknown;
|
1902
1911
|
};
|
1903
1912
|
};
|
1904
1913
|
/**
|
1905
1914
|
* @deprecated
|
1906
|
-
* @description A specific type of data that a Data
|
1915
|
+
* @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
1916
|
*/
|
1908
1917
|
DataType: {
|
1909
1918
|
/** @description Public ID of the data type */
|
1910
1919
|
id: string;
|
1911
1920
|
/** @description Display name of the data type */
|
1912
1921
|
displayName: string;
|
1913
|
-
/** @description Public ID of the associated data
|
1914
|
-
|
1922
|
+
/** @description Public ID of the associated data source */
|
1923
|
+
dataSourceId: string;
|
1915
1924
|
/**
|
1916
1925
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1917
1926
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1919,13 +1928,13 @@ interface external$2 {
|
|
1919
1928
|
*/
|
1920
1929
|
archetype?: string;
|
1921
1930
|
allowedOnComponents?: string[];
|
1922
|
-
/** @description Resource path, appended to the data
|
1931
|
+
/** @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
1932
|
path: string;
|
1924
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
1933
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1925
1934
|
headers?: {
|
1926
1935
|
[key: string]: string;
|
1927
1936
|
};
|
1928
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
1937
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1929
1938
|
parameters?: {
|
1930
1939
|
[key: string]: string;
|
1931
1940
|
};
|
@@ -1937,11 +1946,11 @@ interface external$2 {
|
|
1937
1946
|
* @enum {string}
|
1938
1947
|
*/
|
1939
1948
|
method: "GET" | "POST" | "HEAD";
|
1940
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
1949
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1941
1950
|
variables?: {
|
1942
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1951
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1943
1952
|
};
|
1944
|
-
/** @description Custom configuration specific to the data
|
1953
|
+
/** @description Custom configuration specific to the data source being defined */
|
1945
1954
|
custom?: {
|
1946
1955
|
[key: string]: unknown;
|
1947
1956
|
};
|
@@ -1950,7 +1959,7 @@ interface external$2 {
|
|
1950
1959
|
* @deprecated
|
1951
1960
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1952
1961
|
*/
|
1953
|
-
|
1962
|
+
DataVariableDefinition: {
|
1954
1963
|
/** @description Display name of the data variable */
|
1955
1964
|
displayName?: string;
|
1956
1965
|
/**
|
@@ -1971,25 +1980,25 @@ interface external$2 {
|
|
1971
1980
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1972
1981
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1973
1982
|
*/
|
1974
|
-
|
1975
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1983
|
+
DataResourceDefinitions: {
|
1984
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1976
1985
|
};
|
1977
1986
|
/**
|
1978
1987
|
* @deprecated
|
1979
|
-
* @description
|
1988
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1980
1989
|
*/
|
1981
|
-
|
1990
|
+
DataResourceDefinition: {
|
1982
1991
|
/** @description Public ID of the data type that provides this data */
|
1983
1992
|
type: string;
|
1984
1993
|
/** @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
1994
|
isPatternParameter?: boolean;
|
1986
|
-
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1995
|
+
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1987
1996
|
};
|
1988
1997
|
/**
|
1989
1998
|
* @deprecated
|
1990
|
-
* @description
|
1999
|
+
* @description Variable values for a data resource.
|
1991
2000
|
*/
|
1992
|
-
|
2001
|
+
DataResourceVariables: {
|
1993
2002
|
[key: string]: string;
|
1994
2003
|
};
|
1995
2004
|
};
|
@@ -2003,11 +2012,11 @@ interface external$2 {
|
|
2003
2012
|
* Do not make direct changes to the file.
|
2004
2013
|
*/
|
2005
2014
|
interface paths$1 {
|
2006
|
-
"/api/v1/data-
|
2015
|
+
"/api/v1/data-source": {
|
2007
2016
|
get: {
|
2008
2017
|
parameters: {
|
2009
2018
|
query: {
|
2010
|
-
|
2019
|
+
dataSourceId: string;
|
2011
2020
|
projectId: string;
|
2012
2021
|
};
|
2013
2022
|
};
|
@@ -2016,7 +2025,7 @@ interface paths$1 {
|
|
2016
2025
|
200: {
|
2017
2026
|
content: {
|
2018
2027
|
"application/json": {
|
2019
|
-
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2028
|
+
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2020
2029
|
};
|
2021
2030
|
};
|
2022
2031
|
};
|
@@ -2040,7 +2049,7 @@ interface paths$1 {
|
|
2040
2049
|
requestBody: {
|
2041
2050
|
content: {
|
2042
2051
|
"application/json": {
|
2043
|
-
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2052
|
+
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2044
2053
|
/** Format: uuid */
|
2045
2054
|
projectId: string;
|
2046
2055
|
/** Format: uuid */
|
@@ -2062,7 +2071,7 @@ interface paths$1 {
|
|
2062
2071
|
requestBody: {
|
2063
2072
|
content: {
|
2064
2073
|
"application/json": {
|
2065
|
-
|
2074
|
+
dataSourceId: string;
|
2066
2075
|
/** Format: uuid */
|
2067
2076
|
projectId: string;
|
2068
2077
|
};
|
@@ -2244,24 +2253,24 @@ interface external$1 {
|
|
2244
2253
|
value: unknown;
|
2245
2254
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2246
2255
|
type: string;
|
2247
|
-
|
2256
|
+
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2248
2257
|
};
|
2249
2258
|
/**
|
2250
2259
|
* @deprecated
|
2251
|
-
* @description Defines a
|
2260
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2252
2261
|
*/
|
2253
|
-
|
2254
|
-
/** @description A JSON Pointer expression that defines the
|
2262
|
+
DataElementConnectionDefinition: {
|
2263
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
2255
2264
|
pointer: string;
|
2256
2265
|
/**
|
2257
|
-
* @description The syntax
|
2266
|
+
* @description The syntax used to select the data element to bind to
|
2258
2267
|
* @enum {string}
|
2259
2268
|
*/
|
2260
2269
|
syntax: "jptr";
|
2261
2270
|
/**
|
2262
|
-
* @description Whether
|
2263
|
-
*
|
2264
|
-
*
|
2271
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
2272
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
2273
|
+
* 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
2274
|
*
|
2266
2275
|
* @default false
|
2267
2276
|
*/
|
@@ -2285,14 +2294,14 @@ interface external$1 {
|
|
2285
2294
|
_id?: string;
|
2286
2295
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2287
2296
|
_pattern?: string;
|
2288
|
-
|
2297
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2289
2298
|
/**
|
2290
2299
|
* @deprecated
|
2291
2300
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2292
2301
|
* Means nothing for PUTs; it will be ignored.
|
2293
2302
|
*/
|
2294
|
-
|
2295
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2303
|
+
_patternDataResources?: {
|
2304
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2296
2305
|
};
|
2297
2306
|
/**
|
2298
2307
|
* @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 +2333,63 @@ interface external$1 {
|
|
2324
2333
|
_slug?: string | null;
|
2325
2334
|
/** @description Friendly name of this component. */
|
2326
2335
|
_name: string;
|
2327
|
-
|
2336
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2328
2337
|
};
|
2329
2338
|
/**
|
2330
2339
|
* @deprecated
|
2331
|
-
* @description Basic information about
|
2340
|
+
* @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
2341
|
*/
|
2333
|
-
|
2334
|
-
/** @description Public ID of the data
|
2342
|
+
DataSourceInfo: {
|
2343
|
+
/** @description Public ID of the data source */
|
2335
2344
|
id: string;
|
2336
|
-
/** @description Display name of the data
|
2345
|
+
/** @description Display name of the data source */
|
2337
2346
|
displayName: string;
|
2338
2347
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2339
2348
|
connectorType: string;
|
2340
|
-
/** @description Base resource URL of the data
|
2349
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2341
2350
|
baseUrl: string;
|
2342
2351
|
};
|
2343
2352
|
/**
|
2344
2353
|
* @deprecated
|
2345
|
-
* @description An instance of
|
2354
|
+
* @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
2355
|
*/
|
2347
|
-
|
2348
|
-
/** @description Public ID of the data
|
2356
|
+
DataSource: {
|
2357
|
+
/** @description Public ID of the data source */
|
2349
2358
|
id: string;
|
2350
|
-
/** @description Display name of the data
|
2359
|
+
/** @description Display name of the data source */
|
2351
2360
|
displayName: string;
|
2352
2361
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2353
2362
|
connectorType: string;
|
2354
|
-
/** @description Base resource URL of the data
|
2363
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2355
2364
|
baseUrl: string;
|
2356
|
-
/** @description HTTP headers to pass with requests to the data
|
2365
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2357
2366
|
headers?: {
|
2358
2367
|
[key: string]: string;
|
2359
2368
|
};
|
2360
|
-
/** @description Query String parameters to pass with requests to the data
|
2369
|
+
/** @description Query String parameters to pass with requests to the data source */
|
2361
2370
|
parameters?: {
|
2362
2371
|
[key: string]: string;
|
2363
2372
|
};
|
2364
|
-
/** @description Variables needed to make calls to the data
|
2373
|
+
/** @description Variables needed to make calls to the data source */
|
2365
2374
|
variables?: {
|
2366
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2375
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2367
2376
|
};
|
2368
|
-
/** @description Custom configuration specific to the data
|
2377
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2369
2378
|
custom?: {
|
2370
2379
|
[key: string]: unknown;
|
2371
2380
|
};
|
2372
2381
|
};
|
2373
2382
|
/**
|
2374
2383
|
* @deprecated
|
2375
|
-
* @description A specific type of data that a Data
|
2384
|
+
* @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
2385
|
*/
|
2377
2386
|
DataType: {
|
2378
2387
|
/** @description Public ID of the data type */
|
2379
2388
|
id: string;
|
2380
2389
|
/** @description Display name of the data type */
|
2381
2390
|
displayName: string;
|
2382
|
-
/** @description Public ID of the associated data
|
2383
|
-
|
2391
|
+
/** @description Public ID of the associated data source */
|
2392
|
+
dataSourceId: string;
|
2384
2393
|
/**
|
2385
2394
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2386
2395
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2388,13 +2397,13 @@ interface external$1 {
|
|
2388
2397
|
*/
|
2389
2398
|
archetype?: string;
|
2390
2399
|
allowedOnComponents?: string[];
|
2391
|
-
/** @description Resource path, appended to the data
|
2400
|
+
/** @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
2401
|
path: string;
|
2393
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
2402
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2394
2403
|
headers?: {
|
2395
2404
|
[key: string]: string;
|
2396
2405
|
};
|
2397
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
2406
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2398
2407
|
parameters?: {
|
2399
2408
|
[key: string]: string;
|
2400
2409
|
};
|
@@ -2406,11 +2415,11 @@ interface external$1 {
|
|
2406
2415
|
* @enum {string}
|
2407
2416
|
*/
|
2408
2417
|
method: "GET" | "POST" | "HEAD";
|
2409
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
2418
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2410
2419
|
variables?: {
|
2411
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2420
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2412
2421
|
};
|
2413
|
-
/** @description Custom configuration specific to the data
|
2422
|
+
/** @description Custom configuration specific to the data source being defined */
|
2414
2423
|
custom?: {
|
2415
2424
|
[key: string]: unknown;
|
2416
2425
|
};
|
@@ -2419,7 +2428,7 @@ interface external$1 {
|
|
2419
2428
|
* @deprecated
|
2420
2429
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2421
2430
|
*/
|
2422
|
-
|
2431
|
+
DataVariableDefinition: {
|
2423
2432
|
/** @description Display name of the data variable */
|
2424
2433
|
displayName?: string;
|
2425
2434
|
/**
|
@@ -2440,25 +2449,25 @@ interface external$1 {
|
|
2440
2449
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2441
2450
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2442
2451
|
*/
|
2443
|
-
|
2444
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2452
|
+
DataResourceDefinitions: {
|
2453
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2445
2454
|
};
|
2446
2455
|
/**
|
2447
2456
|
* @deprecated
|
2448
|
-
* @description
|
2457
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2449
2458
|
*/
|
2450
|
-
|
2459
|
+
DataResourceDefinition: {
|
2451
2460
|
/** @description Public ID of the data type that provides this data */
|
2452
2461
|
type: string;
|
2453
2462
|
/** @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
2463
|
isPatternParameter?: boolean;
|
2455
|
-
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2464
|
+
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2456
2465
|
};
|
2457
2466
|
/**
|
2458
2467
|
* @deprecated
|
2459
|
-
* @description
|
2468
|
+
* @description Variable values for a data resource.
|
2460
2469
|
*/
|
2461
|
-
|
2470
|
+
DataResourceVariables: {
|
2462
2471
|
[key: string]: string;
|
2463
2472
|
};
|
2464
2473
|
};
|
@@ -2472,7 +2481,7 @@ interface external$1 {
|
|
2472
2481
|
* Do not make direct changes to the file.
|
2473
2482
|
*/
|
2474
2483
|
interface paths {
|
2475
|
-
"/api/v1/data-
|
2484
|
+
"/api/v1/data-sources": {
|
2476
2485
|
get: {
|
2477
2486
|
parameters: {
|
2478
2487
|
query: {
|
@@ -2484,7 +2493,7 @@ interface paths {
|
|
2484
2493
|
200: {
|
2485
2494
|
content: {
|
2486
2495
|
"application/json": {
|
2487
|
-
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2496
|
+
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSourceInfo"][];
|
2488
2497
|
};
|
2489
2498
|
};
|
2490
2499
|
};
|
@@ -2670,24 +2679,24 @@ interface external {
|
|
2670
2679
|
value: unknown;
|
2671
2680
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2672
2681
|
type: string;
|
2673
|
-
|
2682
|
+
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2674
2683
|
};
|
2675
2684
|
/**
|
2676
2685
|
* @deprecated
|
2677
|
-
* @description Defines a
|
2686
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2678
2687
|
*/
|
2679
|
-
|
2680
|
-
/** @description A JSON Pointer expression that defines the
|
2688
|
+
DataElementConnectionDefinition: {
|
2689
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
2681
2690
|
pointer: string;
|
2682
2691
|
/**
|
2683
|
-
* @description The syntax
|
2692
|
+
* @description The syntax used to select the data element to bind to
|
2684
2693
|
* @enum {string}
|
2685
2694
|
*/
|
2686
2695
|
syntax: "jptr";
|
2687
2696
|
/**
|
2688
|
-
* @description Whether
|
2689
|
-
*
|
2690
|
-
*
|
2697
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
2698
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
2699
|
+
* 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
2700
|
*
|
2692
2701
|
* @default false
|
2693
2702
|
*/
|
@@ -2711,14 +2720,14 @@ interface external {
|
|
2711
2720
|
_id?: string;
|
2712
2721
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2713
2722
|
_pattern?: string;
|
2714
|
-
|
2723
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2715
2724
|
/**
|
2716
2725
|
* @deprecated
|
2717
2726
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2718
2727
|
* Means nothing for PUTs; it will be ignored.
|
2719
2728
|
*/
|
2720
|
-
|
2721
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2729
|
+
_patternDataResources?: {
|
2730
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2722
2731
|
};
|
2723
2732
|
/**
|
2724
2733
|
* @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 +2759,63 @@ interface external {
|
|
2750
2759
|
_slug?: string | null;
|
2751
2760
|
/** @description Friendly name of this component. */
|
2752
2761
|
_name: string;
|
2753
|
-
|
2762
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2754
2763
|
};
|
2755
2764
|
/**
|
2756
2765
|
* @deprecated
|
2757
|
-
* @description Basic information about
|
2766
|
+
* @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
2767
|
*/
|
2759
|
-
|
2760
|
-
/** @description Public ID of the data
|
2768
|
+
DataSourceInfo: {
|
2769
|
+
/** @description Public ID of the data source */
|
2761
2770
|
id: string;
|
2762
|
-
/** @description Display name of the data
|
2771
|
+
/** @description Display name of the data source */
|
2763
2772
|
displayName: string;
|
2764
2773
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2765
2774
|
connectorType: string;
|
2766
|
-
/** @description Base resource URL of the data
|
2775
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2767
2776
|
baseUrl: string;
|
2768
2777
|
};
|
2769
2778
|
/**
|
2770
2779
|
* @deprecated
|
2771
|
-
* @description An instance of
|
2780
|
+
* @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
2781
|
*/
|
2773
|
-
|
2774
|
-
/** @description Public ID of the data
|
2782
|
+
DataSource: {
|
2783
|
+
/** @description Public ID of the data source */
|
2775
2784
|
id: string;
|
2776
|
-
/** @description Display name of the data
|
2785
|
+
/** @description Display name of the data source */
|
2777
2786
|
displayName: string;
|
2778
2787
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2779
2788
|
connectorType: string;
|
2780
|
-
/** @description Base resource URL of the data
|
2789
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2781
2790
|
baseUrl: string;
|
2782
|
-
/** @description HTTP headers to pass with requests to the data
|
2791
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2783
2792
|
headers?: {
|
2784
2793
|
[key: string]: string;
|
2785
2794
|
};
|
2786
|
-
/** @description Query String parameters to pass with requests to the data
|
2795
|
+
/** @description Query String parameters to pass with requests to the data source */
|
2787
2796
|
parameters?: {
|
2788
2797
|
[key: string]: string;
|
2789
2798
|
};
|
2790
|
-
/** @description Variables needed to make calls to the data
|
2799
|
+
/** @description Variables needed to make calls to the data source */
|
2791
2800
|
variables?: {
|
2792
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2801
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2793
2802
|
};
|
2794
|
-
/** @description Custom configuration specific to the data
|
2803
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2795
2804
|
custom?: {
|
2796
2805
|
[key: string]: unknown;
|
2797
2806
|
};
|
2798
2807
|
};
|
2799
2808
|
/**
|
2800
2809
|
* @deprecated
|
2801
|
-
* @description A specific type of data that a Data
|
2810
|
+
* @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
2811
|
*/
|
2803
2812
|
DataType: {
|
2804
2813
|
/** @description Public ID of the data type */
|
2805
2814
|
id: string;
|
2806
2815
|
/** @description Display name of the data type */
|
2807
2816
|
displayName: string;
|
2808
|
-
/** @description Public ID of the associated data
|
2809
|
-
|
2817
|
+
/** @description Public ID of the associated data source */
|
2818
|
+
dataSourceId: string;
|
2810
2819
|
/**
|
2811
2820
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2812
2821
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2814,13 +2823,13 @@ interface external {
|
|
2814
2823
|
*/
|
2815
2824
|
archetype?: string;
|
2816
2825
|
allowedOnComponents?: string[];
|
2817
|
-
/** @description Resource path, appended to the data
|
2826
|
+
/** @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
2827
|
path: string;
|
2819
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data
|
2828
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2820
2829
|
headers?: {
|
2821
2830
|
[key: string]: string;
|
2822
2831
|
};
|
2823
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data
|
2832
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2824
2833
|
parameters?: {
|
2825
2834
|
[key: string]: string;
|
2826
2835
|
};
|
@@ -2832,11 +2841,11 @@ interface external {
|
|
2832
2841
|
* @enum {string}
|
2833
2842
|
*/
|
2834
2843
|
method: "GET" | "POST" | "HEAD";
|
2835
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data
|
2844
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2836
2845
|
variables?: {
|
2837
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2846
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2838
2847
|
};
|
2839
|
-
/** @description Custom configuration specific to the data
|
2848
|
+
/** @description Custom configuration specific to the data source being defined */
|
2840
2849
|
custom?: {
|
2841
2850
|
[key: string]: unknown;
|
2842
2851
|
};
|
@@ -2845,7 +2854,7 @@ interface external {
|
|
2845
2854
|
* @deprecated
|
2846
2855
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2847
2856
|
*/
|
2848
|
-
|
2857
|
+
DataVariableDefinition: {
|
2849
2858
|
/** @description Display name of the data variable */
|
2850
2859
|
displayName?: string;
|
2851
2860
|
/**
|
@@ -2866,25 +2875,25 @@ interface external {
|
|
2866
2875
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2867
2876
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2868
2877
|
*/
|
2869
|
-
|
2870
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2878
|
+
DataResourceDefinitions: {
|
2879
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2871
2880
|
};
|
2872
2881
|
/**
|
2873
2882
|
* @deprecated
|
2874
|
-
* @description
|
2883
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2875
2884
|
*/
|
2876
|
-
|
2885
|
+
DataResourceDefinition: {
|
2877
2886
|
/** @description Public ID of the data type that provides this data */
|
2878
2887
|
type: string;
|
2879
2888
|
/** @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
2889
|
isPatternParameter?: boolean;
|
2881
|
-
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2890
|
+
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2882
2891
|
};
|
2883
2892
|
/**
|
2884
2893
|
* @deprecated
|
2885
|
-
* @description
|
2894
|
+
* @description Variable values for a data resource.
|
2886
2895
|
*/
|
2887
|
-
|
2896
|
+
DataResourceVariables: {
|
2888
2897
|
[key: string]: string;
|
2889
2898
|
};
|
2890
2899
|
};
|
@@ -2894,8 +2903,8 @@ interface external {
|
|
2894
2903
|
}
|
2895
2904
|
|
2896
2905
|
declare type DataTypeApi = paths$2['/api/v1/data-types'];
|
2897
|
-
declare type
|
2898
|
-
declare type
|
2906
|
+
declare type DataSourcesApi = paths['/api/v1/data-sources'];
|
2907
|
+
declare type DataSourceApi = paths$1['/api/v1/data-source'];
|
2899
2908
|
/** Query parameter options for GET /api/v1/data-types */
|
2900
2909
|
declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
2901
2910
|
/** The GET response from /api/v1/data-types */
|
@@ -2904,22 +2913,22 @@ declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['conte
|
|
2904
2913
|
declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
2905
2914
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
2906
2915
|
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
|
2916
|
+
/** Query parameter options for GET /api/v1/data-source */
|
2917
|
+
declare type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
2918
|
+
/** Query parameter options for GET /api/v1/data-sources */
|
2919
|
+
declare type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
2920
|
+
/** The GET response from /api/v1/data-sources */
|
2921
|
+
declare type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
2922
|
+
/** The GET response from /api/v1/data-sources */
|
2923
|
+
declare type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
2924
|
+
/** The PUT request body for /api/v1/data-source */
|
2925
|
+
declare type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
2926
|
+
/** Shape of the DELETE request body for /api/v1/data-source */
|
2927
|
+
declare type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
2919
2928
|
declare type DataType = components$1['schemas']['DataType'];
|
2920
|
-
declare type
|
2921
|
-
declare type
|
2922
|
-
declare type
|
2929
|
+
declare type DataSource = components$1['schemas']['DataSource'];
|
2930
|
+
declare type DataSourceInfo = components$1['schemas']['DataSourceInfo'];
|
2931
|
+
declare type DataVariableDefinition = components$1['schemas']['DataVariableDefinition'];
|
2923
2932
|
|
2924
2933
|
/**
|
2925
2934
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
@@ -2946,4 +2955,4 @@ declare global {
|
|
2946
2955
|
*/
|
2947
2956
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
2948
2957
|
|
2949
|
-
export { CreatingComponentDefinition as A, CompositionGetOrderBy as B, ComponentInstance as C,
|
2958
|
+
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 };
|