@uniformdev/canvas 17.1.1-alpha.452 → 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-IQWDQAHE.mjs → chunk-IK3FODEI.mjs} +2 -2
- package/dist/{chunk-OT3KUGLJ.mjs → chunk-YBMT3VRI.mjs} +2 -2
- 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-1e372818.d.ts → createEventBus-a8e85b6e.d.ts} +411 -323
- package/dist/index.d.ts +196 -38
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/package.json +5 -5
- package/dist/createEventBus-ce0758ee.d.ts +0 -1552
@@ -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 project map node ID. Changes response from list to single. */
|
920
|
+
projectMapNodeId?: string;
|
921
|
+
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
922
|
+
projectMapNodePath?: string;
|
923
|
+
/** Required when using project map node id or path for fetch. */
|
924
|
+
projectMapId?: 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
|
/**
|
@@ -945,6 +975,11 @@ interface paths$3 {
|
|
945
975
|
createdBy?: string;
|
946
976
|
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
947
977
|
updatedBy?: string;
|
978
|
+
/**
|
979
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
980
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
981
|
+
*/
|
982
|
+
withTotalCount?: boolean;
|
948
983
|
};
|
949
984
|
};
|
950
985
|
responses: {
|
@@ -1073,6 +1108,8 @@ interface components {
|
|
1073
1108
|
};
|
1074
1109
|
CompositionListResponse: {
|
1075
1110
|
compositions: components["schemas"]["CompositionApiResponse"][];
|
1111
|
+
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
1112
|
+
totalCount?: number;
|
1076
1113
|
};
|
1077
1114
|
};
|
1078
1115
|
}
|
@@ -1249,24 +1286,24 @@ interface external$3 {
|
|
1249
1286
|
value: unknown;
|
1250
1287
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1251
1288
|
type: string;
|
1252
|
-
|
1289
|
+
connectedData?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1253
1290
|
};
|
1254
1291
|
/**
|
1255
1292
|
* @deprecated
|
1256
|
-
* @description Defines a
|
1293
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1257
1294
|
*/
|
1258
|
-
|
1259
|
-
/** @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. */
|
1260
1297
|
pointer: string;
|
1261
1298
|
/**
|
1262
|
-
* @description The syntax
|
1299
|
+
* @description The syntax used to select the data element to bind to
|
1263
1300
|
* @enum {string}
|
1264
1301
|
*/
|
1265
1302
|
syntax: "jptr";
|
1266
1303
|
/**
|
1267
|
-
* @description Whether
|
1268
|
-
*
|
1269
|
-
*
|
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.
|
1270
1307
|
*
|
1271
1308
|
* @default false
|
1272
1309
|
*/
|
@@ -1290,14 +1327,14 @@ interface external$3 {
|
|
1290
1327
|
_id?: string;
|
1291
1328
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1292
1329
|
_pattern?: string;
|
1293
|
-
|
1330
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1294
1331
|
/**
|
1295
1332
|
* @deprecated
|
1296
1333
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1297
1334
|
* Means nothing for PUTs; it will be ignored.
|
1298
1335
|
*/
|
1299
|
-
|
1300
|
-
[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"];
|
1301
1338
|
};
|
1302
1339
|
/**
|
1303
1340
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1329,63 +1366,67 @@ interface external$3 {
|
|
1329
1366
|
_slug?: string | null;
|
1330
1367
|
/** @description Friendly name of this component. */
|
1331
1368
|
_name: string;
|
1332
|
-
|
1369
|
+
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1333
1370
|
};
|
1334
1371
|
/**
|
1335
1372
|
* @deprecated
|
1336
|
-
* @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.
|
1337
1374
|
*/
|
1338
|
-
|
1339
|
-
/** @description Public ID of the data
|
1375
|
+
DataSourceInfo: {
|
1376
|
+
/** @description Public ID of the data source */
|
1340
1377
|
id: string;
|
1341
|
-
/** @description Display name of the data
|
1378
|
+
/** @description Display name of the data source */
|
1342
1379
|
displayName: string;
|
1343
1380
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1344
1381
|
connectorType: string;
|
1345
|
-
/** @description Base resource URL of the data
|
1382
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1346
1383
|
baseUrl: string;
|
1347
1384
|
};
|
1348
1385
|
/**
|
1349
1386
|
* @deprecated
|
1350
|
-
* @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.
|
1351
1388
|
*/
|
1352
|
-
|
1353
|
-
/** @description Public ID of the data
|
1389
|
+
DataSource: {
|
1390
|
+
/** @description Public ID of the data source */
|
1354
1391
|
id: string;
|
1355
|
-
/** @description Display name of the data
|
1392
|
+
/** @description Display name of the data source */
|
1356
1393
|
displayName: string;
|
1357
1394
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1358
1395
|
connectorType: string;
|
1359
|
-
/** @description Base resource URL of the data
|
1396
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1360
1397
|
baseUrl: string;
|
1361
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
1362
1398
|
headers?: {
|
1363
1399
|
[key: string]: string;
|
1364
|
-
}
|
1365
|
-
|
1400
|
+
} | {
|
1401
|
+
key: string;
|
1402
|
+
value: string;
|
1403
|
+
}[];
|
1366
1404
|
parameters?: {
|
1367
1405
|
[key: string]: string;
|
1368
|
-
}
|
1369
|
-
|
1406
|
+
} | {
|
1407
|
+
key: string;
|
1408
|
+
value: string;
|
1409
|
+
}[];
|
1410
|
+
/** @description Variables needed to make calls to the data source */
|
1370
1411
|
variables?: {
|
1371
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1412
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1372
1413
|
};
|
1373
|
-
/** @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) */
|
1374
1415
|
custom?: {
|
1375
1416
|
[key: string]: unknown;
|
1376
1417
|
};
|
1377
1418
|
};
|
1378
1419
|
/**
|
1379
1420
|
* @deprecated
|
1380
|
-
* @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.
|
1381
1422
|
*/
|
1382
1423
|
DataType: {
|
1383
1424
|
/** @description Public ID of the data type */
|
1384
1425
|
id: string;
|
1385
1426
|
/** @description Display name of the data type */
|
1386
1427
|
displayName: string;
|
1387
|
-
/** @description Public ID of the associated data
|
1388
|
-
|
1428
|
+
/** @description Public ID of the associated data source */
|
1429
|
+
dataSourceId: string;
|
1389
1430
|
/**
|
1390
1431
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1391
1432
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1393,16 +1434,24 @@ interface external$3 {
|
|
1393
1434
|
*/
|
1394
1435
|
archetype?: string;
|
1395
1436
|
allowedOnComponents?: string[];
|
1396
|
-
/** @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. */
|
1397
1438
|
path: string;
|
1398
|
-
/** @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;
|
1399
1443
|
headers?: {
|
1400
1444
|
[key: string]: string;
|
1401
|
-
}
|
1402
|
-
|
1445
|
+
} | {
|
1446
|
+
key: string;
|
1447
|
+
value: string;
|
1448
|
+
}[];
|
1403
1449
|
parameters?: {
|
1404
1450
|
[key: string]: string;
|
1405
|
-
}
|
1451
|
+
} | {
|
1452
|
+
key: string;
|
1453
|
+
value: string;
|
1454
|
+
}[];
|
1406
1455
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1407
1456
|
body?: string;
|
1408
1457
|
/**
|
@@ -1411,11 +1460,11 @@ interface external$3 {
|
|
1411
1460
|
* @enum {string}
|
1412
1461
|
*/
|
1413
1462
|
method: "GET" | "POST" | "HEAD";
|
1414
|
-
/** @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. */
|
1415
1464
|
variables?: {
|
1416
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1465
|
+
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1417
1466
|
};
|
1418
|
-
/** @description Custom configuration specific to the data
|
1467
|
+
/** @description Custom configuration specific to the data source being defined */
|
1419
1468
|
custom?: {
|
1420
1469
|
[key: string]: unknown;
|
1421
1470
|
};
|
@@ -1424,7 +1473,7 @@ interface external$3 {
|
|
1424
1473
|
* @deprecated
|
1425
1474
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1426
1475
|
*/
|
1427
|
-
|
1476
|
+
DataVariableDefinition: {
|
1428
1477
|
/** @description Display name of the data variable */
|
1429
1478
|
displayName?: string;
|
1430
1479
|
/**
|
@@ -1445,25 +1494,25 @@ interface external$3 {
|
|
1445
1494
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1446
1495
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1447
1496
|
*/
|
1448
|
-
|
1449
|
-
[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"];
|
1450
1499
|
};
|
1451
1500
|
/**
|
1452
1501
|
* @deprecated
|
1453
|
-
* @description
|
1502
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1454
1503
|
*/
|
1455
|
-
|
1504
|
+
DataResourceDefinition: {
|
1456
1505
|
/** @description Public ID of the data type that provides this data */
|
1457
1506
|
type: string;
|
1458
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. */
|
1459
1508
|
isPatternParameter?: boolean;
|
1460
|
-
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1509
|
+
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1461
1510
|
};
|
1462
1511
|
/**
|
1463
1512
|
* @deprecated
|
1464
|
-
* @description
|
1513
|
+
* @description Variable values for a data resource.
|
1465
1514
|
*/
|
1466
|
-
|
1515
|
+
DataResourceVariables: {
|
1467
1516
|
[key: string]: string;
|
1468
1517
|
};
|
1469
1518
|
};
|
@@ -1503,14 +1552,17 @@ declare type ComponentParameter<TValue = unknown> = Omit<SharedComponents['Compo
|
|
1503
1552
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1504
1553
|
value: TValue;
|
1505
1554
|
};
|
1506
|
-
/** Defines a
|
1507
|
-
declare type
|
1508
|
-
/**
|
1509
|
-
declare type
|
1510
|
-
/**
|
1511
|
-
|
1512
|
-
|
1513
|
-
|
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'];
|
1514
1566
|
/** Defines the shape of a component instance served by the composition API. */
|
1515
1567
|
declare type ComponentInstance = SharedComponents['ComponentInstance'] & {
|
1516
1568
|
/** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
|
@@ -1768,24 +1820,24 @@ interface external$2 {
|
|
1768
1820
|
value: unknown;
|
1769
1821
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1770
1822
|
type: string;
|
1771
|
-
|
1823
|
+
connectedData?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1772
1824
|
};
|
1773
1825
|
/**
|
1774
1826
|
* @deprecated
|
1775
|
-
* @description Defines a
|
1827
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1776
1828
|
*/
|
1777
|
-
|
1778
|
-
/** @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. */
|
1779
1831
|
pointer: string;
|
1780
1832
|
/**
|
1781
|
-
* @description The syntax
|
1833
|
+
* @description The syntax used to select the data element to bind to
|
1782
1834
|
* @enum {string}
|
1783
1835
|
*/
|
1784
1836
|
syntax: "jptr";
|
1785
1837
|
/**
|
1786
|
-
* @description Whether
|
1787
|
-
*
|
1788
|
-
*
|
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.
|
1789
1841
|
*
|
1790
1842
|
* @default false
|
1791
1843
|
*/
|
@@ -1809,14 +1861,14 @@ interface external$2 {
|
|
1809
1861
|
_id?: string;
|
1810
1862
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1811
1863
|
_pattern?: string;
|
1812
|
-
|
1864
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1813
1865
|
/**
|
1814
1866
|
* @deprecated
|
1815
1867
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1816
1868
|
* Means nothing for PUTs; it will be ignored.
|
1817
1869
|
*/
|
1818
|
-
|
1819
|
-
[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"];
|
1820
1872
|
};
|
1821
1873
|
/**
|
1822
1874
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1848,63 +1900,67 @@ interface external$2 {
|
|
1848
1900
|
_slug?: string | null;
|
1849
1901
|
/** @description Friendly name of this component. */
|
1850
1902
|
_name: string;
|
1851
|
-
|
1903
|
+
_dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1852
1904
|
};
|
1853
1905
|
/**
|
1854
1906
|
* @deprecated
|
1855
|
-
* @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.
|
1856
1908
|
*/
|
1857
|
-
|
1858
|
-
/** @description Public ID of the data
|
1909
|
+
DataSourceInfo: {
|
1910
|
+
/** @description Public ID of the data source */
|
1859
1911
|
id: string;
|
1860
|
-
/** @description Display name of the data
|
1912
|
+
/** @description Display name of the data source */
|
1861
1913
|
displayName: string;
|
1862
1914
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1863
1915
|
connectorType: string;
|
1864
|
-
/** @description Base resource URL of the data
|
1916
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1865
1917
|
baseUrl: string;
|
1866
1918
|
};
|
1867
1919
|
/**
|
1868
1920
|
* @deprecated
|
1869
|
-
* @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.
|
1870
1922
|
*/
|
1871
|
-
|
1872
|
-
/** @description Public ID of the data
|
1923
|
+
DataSource: {
|
1924
|
+
/** @description Public ID of the data source */
|
1873
1925
|
id: string;
|
1874
|
-
/** @description Display name of the data
|
1926
|
+
/** @description Display name of the data source */
|
1875
1927
|
displayName: string;
|
1876
1928
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1877
1929
|
connectorType: string;
|
1878
|
-
/** @description Base resource URL of the data
|
1930
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1879
1931
|
baseUrl: string;
|
1880
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
1881
1932
|
headers?: {
|
1882
1933
|
[key: string]: string;
|
1883
|
-
}
|
1884
|
-
|
1934
|
+
} | {
|
1935
|
+
key: string;
|
1936
|
+
value: string;
|
1937
|
+
}[];
|
1885
1938
|
parameters?: {
|
1886
1939
|
[key: string]: string;
|
1887
|
-
}
|
1888
|
-
|
1940
|
+
} | {
|
1941
|
+
key: string;
|
1942
|
+
value: string;
|
1943
|
+
}[];
|
1944
|
+
/** @description Variables needed to make calls to the data source */
|
1889
1945
|
variables?: {
|
1890
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1946
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1891
1947
|
};
|
1892
|
-
/** @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) */
|
1893
1949
|
custom?: {
|
1894
1950
|
[key: string]: unknown;
|
1895
1951
|
};
|
1896
1952
|
};
|
1897
1953
|
/**
|
1898
1954
|
* @deprecated
|
1899
|
-
* @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.
|
1900
1956
|
*/
|
1901
1957
|
DataType: {
|
1902
1958
|
/** @description Public ID of the data type */
|
1903
1959
|
id: string;
|
1904
1960
|
/** @description Display name of the data type */
|
1905
1961
|
displayName: string;
|
1906
|
-
/** @description Public ID of the associated data
|
1907
|
-
|
1962
|
+
/** @description Public ID of the associated data source */
|
1963
|
+
dataSourceId: string;
|
1908
1964
|
/**
|
1909
1965
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1910
1966
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -1912,16 +1968,24 @@ interface external$2 {
|
|
1912
1968
|
*/
|
1913
1969
|
archetype?: string;
|
1914
1970
|
allowedOnComponents?: string[];
|
1915
|
-
/** @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. */
|
1916
1972
|
path: string;
|
1917
|
-
/** @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;
|
1918
1977
|
headers?: {
|
1919
1978
|
[key: string]: string;
|
1920
|
-
}
|
1921
|
-
|
1979
|
+
} | {
|
1980
|
+
key: string;
|
1981
|
+
value: string;
|
1982
|
+
}[];
|
1922
1983
|
parameters?: {
|
1923
1984
|
[key: string]: string;
|
1924
|
-
}
|
1985
|
+
} | {
|
1986
|
+
key: string;
|
1987
|
+
value: string;
|
1988
|
+
}[];
|
1925
1989
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1926
1990
|
body?: string;
|
1927
1991
|
/**
|
@@ -1930,11 +1994,11 @@ interface external$2 {
|
|
1930
1994
|
* @enum {string}
|
1931
1995
|
*/
|
1932
1996
|
method: "GET" | "POST" | "HEAD";
|
1933
|
-
/** @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. */
|
1934
1998
|
variables?: {
|
1935
|
-
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
1999
|
+
[key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1936
2000
|
};
|
1937
|
-
/** @description Custom configuration specific to the data
|
2001
|
+
/** @description Custom configuration specific to the data source being defined */
|
1938
2002
|
custom?: {
|
1939
2003
|
[key: string]: unknown;
|
1940
2004
|
};
|
@@ -1943,7 +2007,7 @@ interface external$2 {
|
|
1943
2007
|
* @deprecated
|
1944
2008
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
1945
2009
|
*/
|
1946
|
-
|
2010
|
+
DataVariableDefinition: {
|
1947
2011
|
/** @description Display name of the data variable */
|
1948
2012
|
displayName?: string;
|
1949
2013
|
/**
|
@@ -1964,25 +2028,25 @@ interface external$2 {
|
|
1964
2028
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1965
2029
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1966
2030
|
*/
|
1967
|
-
|
1968
|
-
[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"];
|
1969
2033
|
};
|
1970
2034
|
/**
|
1971
2035
|
* @deprecated
|
1972
|
-
* @description
|
2036
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1973
2037
|
*/
|
1974
|
-
|
2038
|
+
DataResourceDefinition: {
|
1975
2039
|
/** @description Public ID of the data type that provides this data */
|
1976
2040
|
type: string;
|
1977
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. */
|
1978
2042
|
isPatternParameter?: boolean;
|
1979
|
-
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2043
|
+
variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1980
2044
|
};
|
1981
2045
|
/**
|
1982
2046
|
* @deprecated
|
1983
|
-
* @description
|
2047
|
+
* @description Variable values for a data resource.
|
1984
2048
|
*/
|
1985
|
-
|
2049
|
+
DataResourceVariables: {
|
1986
2050
|
[key: string]: string;
|
1987
2051
|
};
|
1988
2052
|
};
|
@@ -1996,11 +2060,11 @@ interface external$2 {
|
|
1996
2060
|
* Do not make direct changes to the file.
|
1997
2061
|
*/
|
1998
2062
|
interface paths$1 {
|
1999
|
-
"/api/v1/data-
|
2063
|
+
"/api/v1/data-source": {
|
2000
2064
|
get: {
|
2001
2065
|
parameters: {
|
2002
2066
|
query: {
|
2003
|
-
|
2067
|
+
dataSourceId: string;
|
2004
2068
|
projectId: string;
|
2005
2069
|
};
|
2006
2070
|
};
|
@@ -2009,7 +2073,7 @@ interface paths$1 {
|
|
2009
2073
|
200: {
|
2010
2074
|
content: {
|
2011
2075
|
"application/json": {
|
2012
|
-
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2076
|
+
result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2013
2077
|
};
|
2014
2078
|
};
|
2015
2079
|
};
|
@@ -2033,7 +2097,7 @@ interface paths$1 {
|
|
2033
2097
|
requestBody: {
|
2034
2098
|
content: {
|
2035
2099
|
"application/json": {
|
2036
|
-
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2100
|
+
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
2037
2101
|
/** Format: uuid */
|
2038
2102
|
projectId: string;
|
2039
2103
|
/** Format: uuid */
|
@@ -2055,7 +2119,7 @@ interface paths$1 {
|
|
2055
2119
|
requestBody: {
|
2056
2120
|
content: {
|
2057
2121
|
"application/json": {
|
2058
|
-
|
2122
|
+
dataSourceId: string;
|
2059
2123
|
/** Format: uuid */
|
2060
2124
|
projectId: string;
|
2061
2125
|
};
|
@@ -2237,24 +2301,24 @@ interface external$1 {
|
|
2237
2301
|
value: unknown;
|
2238
2302
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2239
2303
|
type: string;
|
2240
|
-
|
2304
|
+
connectedData?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2241
2305
|
};
|
2242
2306
|
/**
|
2243
2307
|
* @deprecated
|
2244
|
-
* @description Defines a
|
2308
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2245
2309
|
*/
|
2246
|
-
|
2247
|
-
/** @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. */
|
2248
2312
|
pointer: string;
|
2249
2313
|
/**
|
2250
|
-
* @description The syntax
|
2314
|
+
* @description The syntax used to select the data element to bind to
|
2251
2315
|
* @enum {string}
|
2252
2316
|
*/
|
2253
2317
|
syntax: "jptr";
|
2254
2318
|
/**
|
2255
|
-
* @description Whether
|
2256
|
-
*
|
2257
|
-
*
|
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.
|
2258
2322
|
*
|
2259
2323
|
* @default false
|
2260
2324
|
*/
|
@@ -2278,14 +2342,14 @@ interface external$1 {
|
|
2278
2342
|
_id?: string;
|
2279
2343
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2280
2344
|
_pattern?: string;
|
2281
|
-
|
2345
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2282
2346
|
/**
|
2283
2347
|
* @deprecated
|
2284
2348
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2285
2349
|
* Means nothing for PUTs; it will be ignored.
|
2286
2350
|
*/
|
2287
|
-
|
2288
|
-
[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"];
|
2289
2353
|
};
|
2290
2354
|
/**
|
2291
2355
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2317,63 +2381,67 @@ interface external$1 {
|
|
2317
2381
|
_slug?: string | null;
|
2318
2382
|
/** @description Friendly name of this component. */
|
2319
2383
|
_name: string;
|
2320
|
-
|
2384
|
+
_dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2321
2385
|
};
|
2322
2386
|
/**
|
2323
2387
|
* @deprecated
|
2324
|
-
* @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.
|
2325
2389
|
*/
|
2326
|
-
|
2327
|
-
/** @description Public ID of the data
|
2390
|
+
DataSourceInfo: {
|
2391
|
+
/** @description Public ID of the data source */
|
2328
2392
|
id: string;
|
2329
|
-
/** @description Display name of the data
|
2393
|
+
/** @description Display name of the data source */
|
2330
2394
|
displayName: string;
|
2331
2395
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2332
2396
|
connectorType: string;
|
2333
|
-
/** @description Base resource URL of the data
|
2397
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2334
2398
|
baseUrl: string;
|
2335
2399
|
};
|
2336
2400
|
/**
|
2337
2401
|
* @deprecated
|
2338
|
-
* @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.
|
2339
2403
|
*/
|
2340
|
-
|
2341
|
-
/** @description Public ID of the data
|
2404
|
+
DataSource: {
|
2405
|
+
/** @description Public ID of the data source */
|
2342
2406
|
id: string;
|
2343
|
-
/** @description Display name of the data
|
2407
|
+
/** @description Display name of the data source */
|
2344
2408
|
displayName: string;
|
2345
2409
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2346
2410
|
connectorType: string;
|
2347
|
-
/** @description Base resource URL of the data
|
2411
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2348
2412
|
baseUrl: string;
|
2349
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
2350
2413
|
headers?: {
|
2351
2414
|
[key: string]: string;
|
2352
|
-
}
|
2353
|
-
|
2415
|
+
} | {
|
2416
|
+
key: string;
|
2417
|
+
value: string;
|
2418
|
+
}[];
|
2354
2419
|
parameters?: {
|
2355
2420
|
[key: string]: string;
|
2356
|
-
}
|
2357
|
-
|
2421
|
+
} | {
|
2422
|
+
key: string;
|
2423
|
+
value: string;
|
2424
|
+
}[];
|
2425
|
+
/** @description Variables needed to make calls to the data source */
|
2358
2426
|
variables?: {
|
2359
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2427
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2360
2428
|
};
|
2361
|
-
/** @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) */
|
2362
2430
|
custom?: {
|
2363
2431
|
[key: string]: unknown;
|
2364
2432
|
};
|
2365
2433
|
};
|
2366
2434
|
/**
|
2367
2435
|
* @deprecated
|
2368
|
-
* @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.
|
2369
2437
|
*/
|
2370
2438
|
DataType: {
|
2371
2439
|
/** @description Public ID of the data type */
|
2372
2440
|
id: string;
|
2373
2441
|
/** @description Display name of the data type */
|
2374
2442
|
displayName: string;
|
2375
|
-
/** @description Public ID of the associated data
|
2376
|
-
|
2443
|
+
/** @description Public ID of the associated data source */
|
2444
|
+
dataSourceId: string;
|
2377
2445
|
/**
|
2378
2446
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2379
2447
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2381,16 +2449,24 @@ interface external$1 {
|
|
2381
2449
|
*/
|
2382
2450
|
archetype?: string;
|
2383
2451
|
allowedOnComponents?: string[];
|
2384
|
-
/** @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. */
|
2385
2453
|
path: string;
|
2386
|
-
/** @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;
|
2387
2458
|
headers?: {
|
2388
2459
|
[key: string]: string;
|
2389
|
-
}
|
2390
|
-
|
2460
|
+
} | {
|
2461
|
+
key: string;
|
2462
|
+
value: string;
|
2463
|
+
}[];
|
2391
2464
|
parameters?: {
|
2392
2465
|
[key: string]: string;
|
2393
|
-
}
|
2466
|
+
} | {
|
2467
|
+
key: string;
|
2468
|
+
value: string;
|
2469
|
+
}[];
|
2394
2470
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2395
2471
|
body?: string;
|
2396
2472
|
/**
|
@@ -2399,11 +2475,11 @@ interface external$1 {
|
|
2399
2475
|
* @enum {string}
|
2400
2476
|
*/
|
2401
2477
|
method: "GET" | "POST" | "HEAD";
|
2402
|
-
/** @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. */
|
2403
2479
|
variables?: {
|
2404
|
-
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2480
|
+
[key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2405
2481
|
};
|
2406
|
-
/** @description Custom configuration specific to the data
|
2482
|
+
/** @description Custom configuration specific to the data source being defined */
|
2407
2483
|
custom?: {
|
2408
2484
|
[key: string]: unknown;
|
2409
2485
|
};
|
@@ -2412,7 +2488,7 @@ interface external$1 {
|
|
2412
2488
|
* @deprecated
|
2413
2489
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2414
2490
|
*/
|
2415
|
-
|
2491
|
+
DataVariableDefinition: {
|
2416
2492
|
/** @description Display name of the data variable */
|
2417
2493
|
displayName?: string;
|
2418
2494
|
/**
|
@@ -2433,25 +2509,25 @@ interface external$1 {
|
|
2433
2509
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2434
2510
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2435
2511
|
*/
|
2436
|
-
|
2437
|
-
[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"];
|
2438
2514
|
};
|
2439
2515
|
/**
|
2440
2516
|
* @deprecated
|
2441
|
-
* @description
|
2517
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2442
2518
|
*/
|
2443
|
-
|
2519
|
+
DataResourceDefinition: {
|
2444
2520
|
/** @description Public ID of the data type that provides this data */
|
2445
2521
|
type: string;
|
2446
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. */
|
2447
2523
|
isPatternParameter?: boolean;
|
2448
|
-
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2524
|
+
variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2449
2525
|
};
|
2450
2526
|
/**
|
2451
2527
|
* @deprecated
|
2452
|
-
* @description
|
2528
|
+
* @description Variable values for a data resource.
|
2453
2529
|
*/
|
2454
|
-
|
2530
|
+
DataResourceVariables: {
|
2455
2531
|
[key: string]: string;
|
2456
2532
|
};
|
2457
2533
|
};
|
@@ -2465,7 +2541,7 @@ interface external$1 {
|
|
2465
2541
|
* Do not make direct changes to the file.
|
2466
2542
|
*/
|
2467
2543
|
interface paths {
|
2468
|
-
"/api/v1/data-
|
2544
|
+
"/api/v1/data-sources": {
|
2469
2545
|
get: {
|
2470
2546
|
parameters: {
|
2471
2547
|
query: {
|
@@ -2477,7 +2553,7 @@ interface paths {
|
|
2477
2553
|
200: {
|
2478
2554
|
content: {
|
2479
2555
|
"application/json": {
|
2480
|
-
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2556
|
+
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSourceInfo"][];
|
2481
2557
|
};
|
2482
2558
|
};
|
2483
2559
|
};
|
@@ -2663,24 +2739,24 @@ interface external {
|
|
2663
2739
|
value: unknown;
|
2664
2740
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2665
2741
|
type: string;
|
2666
|
-
|
2742
|
+
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2667
2743
|
};
|
2668
2744
|
/**
|
2669
2745
|
* @deprecated
|
2670
|
-
* @description Defines a
|
2746
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
2671
2747
|
*/
|
2672
|
-
|
2673
|
-
/** @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. */
|
2674
2750
|
pointer: string;
|
2675
2751
|
/**
|
2676
|
-
* @description The syntax
|
2752
|
+
* @description The syntax used to select the data element to bind to
|
2677
2753
|
* @enum {string}
|
2678
2754
|
*/
|
2679
2755
|
syntax: "jptr";
|
2680
2756
|
/**
|
2681
|
-
* @description Whether
|
2682
|
-
*
|
2683
|
-
*
|
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.
|
2684
2760
|
*
|
2685
2761
|
* @default false
|
2686
2762
|
*/
|
@@ -2704,14 +2780,14 @@ interface external {
|
|
2704
2780
|
_id?: string;
|
2705
2781
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2706
2782
|
_pattern?: string;
|
2707
|
-
|
2783
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2708
2784
|
/**
|
2709
2785
|
* @deprecated
|
2710
2786
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
2711
2787
|
* Means nothing for PUTs; it will be ignored.
|
2712
2788
|
*/
|
2713
|
-
|
2714
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2789
|
+
_patternDataResources?: {
|
2790
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2715
2791
|
};
|
2716
2792
|
/**
|
2717
2793
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2743,63 +2819,67 @@ interface external {
|
|
2743
2819
|
_slug?: string | null;
|
2744
2820
|
/** @description Friendly name of this component. */
|
2745
2821
|
_name: string;
|
2746
|
-
|
2822
|
+
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2747
2823
|
};
|
2748
2824
|
/**
|
2749
2825
|
* @deprecated
|
2750
|
-
* @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.
|
2751
2827
|
*/
|
2752
|
-
|
2753
|
-
/** @description Public ID of the data
|
2828
|
+
DataSourceInfo: {
|
2829
|
+
/** @description Public ID of the data source */
|
2754
2830
|
id: string;
|
2755
|
-
/** @description Display name of the data
|
2831
|
+
/** @description Display name of the data source */
|
2756
2832
|
displayName: string;
|
2757
2833
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2758
2834
|
connectorType: string;
|
2759
|
-
/** @description Base resource URL of the data
|
2835
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2760
2836
|
baseUrl: string;
|
2761
2837
|
};
|
2762
2838
|
/**
|
2763
2839
|
* @deprecated
|
2764
|
-
* @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.
|
2765
2841
|
*/
|
2766
|
-
|
2767
|
-
/** @description Public ID of the data
|
2842
|
+
DataSource: {
|
2843
|
+
/** @description Public ID of the data source */
|
2768
2844
|
id: string;
|
2769
|
-
/** @description Display name of the data
|
2845
|
+
/** @description Display name of the data source */
|
2770
2846
|
displayName: string;
|
2771
2847
|
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2772
2848
|
connectorType: string;
|
2773
|
-
/** @description Base resource URL of the data
|
2849
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2774
2850
|
baseUrl: string;
|
2775
|
-
/** @description HTTP headers to pass with requests to the data connection */
|
2776
2851
|
headers?: {
|
2777
2852
|
[key: string]: string;
|
2778
|
-
}
|
2779
|
-
|
2853
|
+
} | {
|
2854
|
+
key: string;
|
2855
|
+
value: string;
|
2856
|
+
}[];
|
2780
2857
|
parameters?: {
|
2781
2858
|
[key: string]: string;
|
2782
|
-
}
|
2783
|
-
|
2859
|
+
} | {
|
2860
|
+
key: string;
|
2861
|
+
value: string;
|
2862
|
+
}[];
|
2863
|
+
/** @description Variables needed to make calls to the data source */
|
2784
2864
|
variables?: {
|
2785
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2865
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2786
2866
|
};
|
2787
|
-
/** @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) */
|
2788
2868
|
custom?: {
|
2789
2869
|
[key: string]: unknown;
|
2790
2870
|
};
|
2791
2871
|
};
|
2792
2872
|
/**
|
2793
2873
|
* @deprecated
|
2794
|
-
* @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.
|
2795
2875
|
*/
|
2796
2876
|
DataType: {
|
2797
2877
|
/** @description Public ID of the data type */
|
2798
2878
|
id: string;
|
2799
2879
|
/** @description Display name of the data type */
|
2800
2880
|
displayName: string;
|
2801
|
-
/** @description Public ID of the associated data
|
2802
|
-
|
2881
|
+
/** @description Public ID of the associated data source */
|
2882
|
+
dataSourceId: string;
|
2803
2883
|
/**
|
2804
2884
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2805
2885
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
@@ -2807,16 +2887,24 @@ interface external {
|
|
2807
2887
|
*/
|
2808
2888
|
archetype?: string;
|
2809
2889
|
allowedOnComponents?: string[];
|
2810
|
-
/** @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. */
|
2811
2891
|
path: string;
|
2812
|
-
/** @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;
|
2813
2896
|
headers?: {
|
2814
2897
|
[key: string]: string;
|
2815
|
-
}
|
2816
|
-
|
2898
|
+
} | {
|
2899
|
+
key: string;
|
2900
|
+
value: string;
|
2901
|
+
}[];
|
2817
2902
|
parameters?: {
|
2818
2903
|
[key: string]: string;
|
2819
|
-
}
|
2904
|
+
} | {
|
2905
|
+
key: string;
|
2906
|
+
value: string;
|
2907
|
+
}[];
|
2820
2908
|
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2821
2909
|
body?: string;
|
2822
2910
|
/**
|
@@ -2825,11 +2913,11 @@ interface external {
|
|
2825
2913
|
* @enum {string}
|
2826
2914
|
*/
|
2827
2915
|
method: "GET" | "POST" | "HEAD";
|
2828
|
-
/** @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. */
|
2829
2917
|
variables?: {
|
2830
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2918
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2831
2919
|
};
|
2832
|
-
/** @description Custom configuration specific to the data
|
2920
|
+
/** @description Custom configuration specific to the data source being defined */
|
2833
2921
|
custom?: {
|
2834
2922
|
[key: string]: unknown;
|
2835
2923
|
};
|
@@ -2838,7 +2926,7 @@ interface external {
|
|
2838
2926
|
* @deprecated
|
2839
2927
|
* @description Defines the shape of a data variable on a Data Connector or Data Type
|
2840
2928
|
*/
|
2841
|
-
|
2929
|
+
DataVariableDefinition: {
|
2842
2930
|
/** @description Display name of the data variable */
|
2843
2931
|
displayName?: string;
|
2844
2932
|
/**
|
@@ -2859,25 +2947,25 @@ interface external {
|
|
2859
2947
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2860
2948
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2861
2949
|
*/
|
2862
|
-
|
2863
|
-
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2950
|
+
DataResourceDefinitions: {
|
2951
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2864
2952
|
};
|
2865
2953
|
/**
|
2866
2954
|
* @deprecated
|
2867
|
-
* @description
|
2955
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
2868
2956
|
*/
|
2869
|
-
|
2957
|
+
DataResourceDefinition: {
|
2870
2958
|
/** @description Public ID of the data type that provides this data */
|
2871
2959
|
type: string;
|
2872
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. */
|
2873
2961
|
isPatternParameter?: boolean;
|
2874
|
-
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
2962
|
+
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2875
2963
|
};
|
2876
2964
|
/**
|
2877
2965
|
* @deprecated
|
2878
|
-
* @description
|
2966
|
+
* @description Variable values for a data resource.
|
2879
2967
|
*/
|
2880
|
-
|
2968
|
+
DataResourceVariables: {
|
2881
2969
|
[key: string]: string;
|
2882
2970
|
};
|
2883
2971
|
};
|
@@ -2887,8 +2975,8 @@ interface external {
|
|
2887
2975
|
}
|
2888
2976
|
|
2889
2977
|
declare type DataTypeApi = paths$2['/api/v1/data-types'];
|
2890
|
-
declare type
|
2891
|
-
declare type
|
2978
|
+
declare type DataSourcesApi = paths['/api/v1/data-sources'];
|
2979
|
+
declare type DataSourceApi = paths$1['/api/v1/data-source'];
|
2892
2980
|
/** Query parameter options for GET /api/v1/data-types */
|
2893
2981
|
declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
2894
2982
|
/** The GET response from /api/v1/data-types */
|
@@ -2897,22 +2985,22 @@ declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['conte
|
|
2897
2985
|
declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
2898
2986
|
/** Shape of the DELETE request body for /api/v1/data-types */
|
2899
2987
|
declare type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
2900
|
-
/** Query parameter options for GET /api/v1/data-
|
2901
|
-
declare type
|
2902
|
-
/** Query parameter options for GET /api/v1/data-
|
2903
|
-
declare type
|
2904
|
-
/** The GET response from /api/v1/data-
|
2905
|
-
declare type
|
2906
|
-
/** The GET response from /api/v1/data-
|
2907
|
-
declare type
|
2908
|
-
/** The PUT request body for /api/v1/data-
|
2909
|
-
declare type
|
2910
|
-
/** Shape of the DELETE request body for /api/v1/data-
|
2911
|
-
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'];
|
2912
3000
|
declare type DataType = components$1['schemas']['DataType'];
|
2913
|
-
declare type
|
2914
|
-
declare type
|
2915
|
-
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'];
|
2916
3004
|
|
2917
3005
|
/**
|
2918
3006
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
@@ -2939,4 +3027,4 @@ declare global {
|
|
2939
3027
|
*/
|
2940
3028
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
2941
3029
|
|
2942
|
-
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 };
|