@uniformdev/canvas 19.55.1-alpha.8 → 19.55.2-alpha.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +2260 -624
- package/dist/index.d.ts +2260 -624
- package/dist/index.esm.js +572 -167
- package/dist/index.js +587 -174
- package/dist/index.mjs +572 -167
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
@@ -171,26 +171,26 @@ interface components$5 {
|
|
171
171
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
172
172
|
fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
|
173
173
|
/**
|
174
|
-
*
|
175
|
-
* @description Reference to the category this component definition belongs to
|
176
|
-
* @default null
|
177
|
-
*/
|
178
|
-
categoryId?: string | null;
|
179
|
-
/**
|
180
|
-
* @description Description of the component definition
|
174
|
+
* @description Description of the content type
|
181
175
|
* @default null
|
182
176
|
*/
|
183
177
|
description?: string;
|
184
178
|
/**
|
185
|
-
* @description
|
186
|
-
* @default
|
179
|
+
* @description Icon name for the content type (e.g. 'screen')
|
180
|
+
* @default file-document
|
187
181
|
*/
|
188
|
-
|
182
|
+
icon?: string;
|
189
183
|
/** @description Created date string for this content type (ignored for writes) */
|
190
184
|
created?: string;
|
191
185
|
/** @description Last modified date string for this content type (ignored for writes) */
|
192
186
|
updated?: string;
|
193
187
|
slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
|
188
|
+
/**
|
189
|
+
* @description The definition type of this content type (block or content type)
|
190
|
+
* @default contentType
|
191
|
+
* @enum {string}
|
192
|
+
*/
|
193
|
+
type?: "contentType" | "block";
|
194
194
|
};
|
195
195
|
/** @description Defines an editable parameter on a component. */
|
196
196
|
ComponentParameter: {
|
@@ -409,15 +409,8 @@ interface components$5 {
|
|
409
409
|
allowedOnComponents?: string[];
|
410
410
|
/** @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. */
|
411
411
|
path: string;
|
412
|
-
/** @description Time-to-live (in seconds) for the
|
412
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
413
413
|
ttl?: number;
|
414
|
-
/** @description Long term data resource cache configuration. */
|
415
|
-
longTermCache?: {
|
416
|
-
/** @description A flag to turn the long term cache on. */
|
417
|
-
enabled: boolean;
|
418
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
419
|
-
ttlInHours?: number;
|
420
|
-
};
|
421
414
|
/** @description A key for the resource data cache purging. */
|
422
415
|
purgeKey?: string;
|
423
416
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -527,6 +520,26 @@ interface components$5 {
|
|
527
520
|
*/
|
528
521
|
projectMapId: string;
|
529
522
|
};
|
523
|
+
/** @description AI Prompt definition. */
|
524
|
+
Prompt: {
|
525
|
+
/**
|
526
|
+
* Format: uuid
|
527
|
+
* @description Unique identifier for the prompt
|
528
|
+
*/
|
529
|
+
id: string;
|
530
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
531
|
+
integrationType: string;
|
532
|
+
/** @description Name for the prompt */
|
533
|
+
promptName?: string | null;
|
534
|
+
/** @description Text for the prompt */
|
535
|
+
promptText?: string | null;
|
536
|
+
/** @description Data for the prompt */
|
537
|
+
promptData?: string | null;
|
538
|
+
/** @description Turn off/on prompt */
|
539
|
+
enabled?: boolean | null;
|
540
|
+
/** @description Integration default prompt */
|
541
|
+
builtIn?: boolean | null;
|
542
|
+
};
|
530
543
|
};
|
531
544
|
}
|
532
545
|
|
@@ -534,7 +547,7 @@ interface components$5 {
|
|
534
547
|
* This file was auto-generated by openapi-typescript.
|
535
548
|
* Do not make direct changes to the file.
|
536
549
|
*/
|
537
|
-
interface paths$
|
550
|
+
interface paths$d {
|
538
551
|
"/api/v1/canvas-definitions": {
|
539
552
|
get: {
|
540
553
|
parameters: {
|
@@ -559,15 +572,15 @@ interface paths$b {
|
|
559
572
|
content: {
|
560
573
|
"application/json": {
|
561
574
|
/** @description Component definitions that match the query */
|
562
|
-
componentDefinitions: external$
|
575
|
+
componentDefinitions: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
563
576
|
};
|
564
577
|
};
|
565
578
|
};
|
566
|
-
400: external$
|
567
|
-
401: external$
|
568
|
-
403: external$
|
569
|
-
429: external$
|
570
|
-
500: external$
|
579
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
580
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
581
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
582
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
583
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
571
584
|
};
|
572
585
|
};
|
573
586
|
/** Upserts a component definition */
|
@@ -575,11 +588,11 @@ interface paths$b {
|
|
575
588
|
responses: {
|
576
589
|
/** OK */
|
577
590
|
204: never;
|
578
|
-
400: external$
|
579
|
-
401: external$
|
580
|
-
403: external$
|
581
|
-
429: external$
|
582
|
-
500: external$
|
591
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
592
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
593
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
594
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
595
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
583
596
|
};
|
584
597
|
requestBody: {
|
585
598
|
content: {
|
@@ -589,7 +602,7 @@ interface paths$b {
|
|
589
602
|
* @description The project ID to upsert the component definition to
|
590
603
|
*/
|
591
604
|
projectId: string;
|
592
|
-
componentDefinition: external$
|
605
|
+
componentDefinition: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
593
606
|
};
|
594
607
|
};
|
595
608
|
};
|
@@ -599,11 +612,11 @@ interface paths$b {
|
|
599
612
|
responses: {
|
600
613
|
/** OK */
|
601
614
|
204: never;
|
602
|
-
400: external$
|
603
|
-
401: external$
|
604
|
-
403: external$
|
605
|
-
429: external$
|
606
|
-
500: external$
|
615
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
616
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
617
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
618
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
619
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
607
620
|
};
|
608
621
|
requestBody: {
|
609
622
|
content: {
|
@@ -628,7 +641,7 @@ interface paths$b {
|
|
628
641
|
};
|
629
642
|
};
|
630
643
|
}
|
631
|
-
interface external$
|
644
|
+
interface external$e {
|
632
645
|
"swagger.yml": {
|
633
646
|
paths: {};
|
634
647
|
components: {
|
@@ -642,25 +655,25 @@ interface external$c {
|
|
642
655
|
/** Request input validation failed */
|
643
656
|
BadRequestError: {
|
644
657
|
content: {
|
645
|
-
"application/json": external$
|
658
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
646
659
|
};
|
647
660
|
};
|
648
661
|
/** API key or token was not valid */
|
649
662
|
UnauthorizedError: {
|
650
663
|
content: {
|
651
|
-
"application/json": external$
|
664
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
652
665
|
};
|
653
666
|
};
|
654
667
|
/** Permission was denied */
|
655
668
|
ForbiddenError: {
|
656
669
|
content: {
|
657
|
-
"application/json": external$
|
670
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
658
671
|
};
|
659
672
|
};
|
660
673
|
/** Resource not found */
|
661
674
|
NotFoundError: {
|
662
675
|
content: {
|
663
|
-
"application/json": external$
|
676
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
664
677
|
};
|
665
678
|
};
|
666
679
|
/** Too many requests in allowed time period */
|
@@ -679,7 +692,7 @@ interface external$c {
|
|
679
692
|
PublicIdProperty: string;
|
680
693
|
/** @description The definition of a component parameter */
|
681
694
|
ComponentDefinitionParameter: {
|
682
|
-
id: external$
|
695
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
683
696
|
/** @description Friendly name of the parameter */
|
684
697
|
name: string;
|
685
698
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -691,7 +704,7 @@ interface external$c {
|
|
691
704
|
};
|
692
705
|
/** @description The definition of a named component slot that can contain other components */
|
693
706
|
ComponentDefinitionSlot: {
|
694
|
-
id: external$
|
707
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
695
708
|
/** @description Friendly name of the slot */
|
696
709
|
name: string;
|
697
710
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -749,13 +762,13 @@ interface external$c {
|
|
749
762
|
};
|
750
763
|
/** @description The definition of a component variant */
|
751
764
|
ComponentDefinitionVariant: {
|
752
|
-
id: external$
|
765
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
753
766
|
/** @description Friendly name of the variant */
|
754
767
|
name: string;
|
755
768
|
};
|
756
769
|
/** @description Permission set for a component defintion */
|
757
770
|
ComponentDefinitionPermission: {
|
758
|
-
roleId: external$
|
771
|
+
roleId: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
759
772
|
/**
|
760
773
|
* @description Permission type for this permission ComponentDefinition:
|
761
774
|
* read | write | create | delete
|
@@ -768,7 +781,7 @@ interface external$c {
|
|
768
781
|
};
|
769
782
|
/** @description Defines a component type that can live on a Composition */
|
770
783
|
ComponentDefinition: {
|
771
|
-
id: external$
|
784
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
772
785
|
/** @description Friendly name of the component definition */
|
773
786
|
name: string;
|
774
787
|
/**
|
@@ -789,7 +802,7 @@ interface external$c {
|
|
789
802
|
*/
|
790
803
|
canBeComposition?: boolean;
|
791
804
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
792
|
-
parameters?: external$
|
805
|
+
parameters?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
793
806
|
/**
|
794
807
|
* Format: uuid
|
795
808
|
* @description Reference to the category this component definition belongs to
|
@@ -812,14 +825,14 @@ interface external$c {
|
|
812
825
|
*/
|
813
826
|
useTeamPermissions?: boolean;
|
814
827
|
/** @description Custom role permissions for this component definition */
|
815
|
-
permissions?: external$
|
828
|
+
permissions?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
816
829
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
817
|
-
slots?: external$
|
818
|
-
slugSettings?: external$
|
830
|
+
slots?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
831
|
+
slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
819
832
|
/** @description Default component instance value */
|
820
|
-
defaults?: external$
|
833
|
+
defaults?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
821
834
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
822
|
-
variants?: external$
|
835
|
+
variants?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
823
836
|
/** @description Created date string for this definition (ignored for writes) */
|
824
837
|
created?: string;
|
825
838
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -827,7 +840,7 @@ interface external$c {
|
|
827
840
|
};
|
828
841
|
/** @description Defines a content type */
|
829
842
|
ContentType: {
|
830
|
-
id: external$
|
843
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
831
844
|
/** @description Friendly name of the content type */
|
832
845
|
name: string;
|
833
846
|
/**
|
@@ -836,28 +849,28 @@ interface external$c {
|
|
836
849
|
*/
|
837
850
|
entryName?: string | null;
|
838
851
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
839
|
-
fields?: external$
|
840
|
-
/**
|
841
|
-
* Format: uuid
|
842
|
-
* @description Reference to the category this component definition belongs to
|
843
|
-
* @default null
|
844
|
-
*/
|
845
|
-
categoryId?: string | null;
|
852
|
+
fields?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
846
853
|
/**
|
847
|
-
* @description Description of the
|
854
|
+
* @description Description of the content type
|
848
855
|
* @default null
|
849
856
|
*/
|
850
857
|
description?: string;
|
851
858
|
/**
|
852
|
-
* @description
|
853
|
-
* @default
|
859
|
+
* @description Icon name for the content type (e.g. 'screen')
|
860
|
+
* @default file-document
|
854
861
|
*/
|
855
|
-
|
862
|
+
icon?: string;
|
856
863
|
/** @description Created date string for this content type (ignored for writes) */
|
857
864
|
created?: string;
|
858
865
|
/** @description Last modified date string for this content type (ignored for writes) */
|
859
866
|
updated?: string;
|
860
|
-
slugSettings?: external$
|
867
|
+
slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
868
|
+
/**
|
869
|
+
* @description The definition type of this content type (block or content type)
|
870
|
+
* @default contentType
|
871
|
+
* @enum {string}
|
872
|
+
*/
|
873
|
+
type?: "contentType" | "block";
|
861
874
|
};
|
862
875
|
/** @description Defines an editable parameter on a component. */
|
863
876
|
ComponentParameter: {
|
@@ -866,7 +879,7 @@ interface external$c {
|
|
866
879
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
867
880
|
type: string;
|
868
881
|
/** @deprecated */
|
869
|
-
connectedData?: external$
|
882
|
+
connectedData?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
870
883
|
};
|
871
884
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
872
885
|
DataElementConnectionDefinition: {
|
@@ -884,13 +897,13 @@ interface external$c {
|
|
884
897
|
type: string;
|
885
898
|
/** @description Component parameter values for the component instance */
|
886
899
|
parameters?: {
|
887
|
-
[key: string]: external$
|
900
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
888
901
|
};
|
889
902
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
890
903
|
variant?: string;
|
891
904
|
/** @description Slots containing any child components */
|
892
905
|
slots?: {
|
893
|
-
[key: string]: external$
|
906
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
894
907
|
};
|
895
908
|
/**
|
896
909
|
* @description Unique identifier of the component within the composition.
|
@@ -901,13 +914,13 @@ interface external$c {
|
|
901
914
|
_id?: string;
|
902
915
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
903
916
|
_pattern?: string;
|
904
|
-
_dataResources?: external$
|
917
|
+
_dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
905
918
|
/**
|
906
919
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
907
920
|
* Means nothing for PUTs; it will be ignored.
|
908
921
|
*/
|
909
922
|
_patternDataResources?: {
|
910
|
-
[key: string]: external$
|
923
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
911
924
|
};
|
912
925
|
/**
|
913
926
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -931,7 +944,7 @@ interface external$c {
|
|
931
944
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
932
945
|
*/
|
933
946
|
_overrides?: {
|
934
|
-
[key: string]: external$
|
947
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
935
948
|
};
|
936
949
|
/**
|
937
950
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -940,7 +953,7 @@ interface external$c {
|
|
940
953
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
941
954
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
942
955
|
*/
|
943
|
-
_overridability?: external$
|
956
|
+
_overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
944
957
|
};
|
945
958
|
/** @description Defines the shape of the root component in a composition */
|
946
959
|
RootComponentInstance: {
|
@@ -948,15 +961,15 @@ interface external$c {
|
|
948
961
|
type: string;
|
949
962
|
/** @description Component parameter values for the component instance */
|
950
963
|
parameters?: {
|
951
|
-
[key: string]: external$
|
964
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
952
965
|
};
|
953
966
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
954
967
|
variant?: string;
|
955
968
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
956
|
-
projectMapNodes?: external$
|
969
|
+
projectMapNodes?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
957
970
|
/** @description Slots containing any child components */
|
958
971
|
slots?: {
|
959
|
-
[key: string]: external$
|
972
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
960
973
|
};
|
961
974
|
/** @description The public UUID of the composition. */
|
962
975
|
_id: string;
|
@@ -964,7 +977,7 @@ interface external$c {
|
|
964
977
|
_slug?: string | null;
|
965
978
|
/** @description Friendly name of this component. */
|
966
979
|
_name: string;
|
967
|
-
_dataResources?: external$
|
980
|
+
_dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
968
981
|
/**
|
969
982
|
* @description Defines patch overrides to component IDs that live in the composition.
|
970
983
|
* This can be used to override parameters that are defined on patterns,
|
@@ -978,7 +991,7 @@ interface external$c {
|
|
978
991
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
979
992
|
*/
|
980
993
|
_overrides?: {
|
981
|
-
[key: string]: external$
|
994
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
982
995
|
};
|
983
996
|
/**
|
984
997
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -987,7 +1000,7 @@ interface external$c {
|
|
987
1000
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
988
1001
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
989
1002
|
*/
|
990
|
-
_overridability?: external$
|
1003
|
+
_overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
991
1004
|
};
|
992
1005
|
/**
|
993
1006
|
* @description Defines how to override a specific component.
|
@@ -997,7 +1010,7 @@ interface external$c {
|
|
997
1010
|
*/
|
998
1011
|
ComponentOverride: {
|
999
1012
|
parameters?: {
|
1000
|
-
[key: string]: external$
|
1013
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1001
1014
|
};
|
1002
1015
|
variant?: string;
|
1003
1016
|
};
|
@@ -1011,7 +1024,7 @@ interface external$c {
|
|
1011
1024
|
ComponentOverridability: {
|
1012
1025
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1013
1026
|
parameters?: {
|
1014
|
-
[key: string]: external$
|
1027
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1015
1028
|
};
|
1016
1029
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1017
1030
|
variants?: boolean;
|
@@ -1052,7 +1065,7 @@ interface external$c {
|
|
1052
1065
|
}[];
|
1053
1066
|
/** @description Variables needed to make calls to the data source */
|
1054
1067
|
variables?: {
|
1055
|
-
[key: string]: external$
|
1068
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1056
1069
|
};
|
1057
1070
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1058
1071
|
custom?: {
|
@@ -1076,15 +1089,8 @@ interface external$c {
|
|
1076
1089
|
allowedOnComponents?: string[];
|
1077
1090
|
/** @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. */
|
1078
1091
|
path: string;
|
1079
|
-
/** @description Time-to-live (in seconds) for the
|
1092
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
1080
1093
|
ttl?: number;
|
1081
|
-
/** @description Long term data resource cache configuration. */
|
1082
|
-
longTermCache?: {
|
1083
|
-
/** @description A flag to turn the long term cache on. */
|
1084
|
-
enabled: boolean;
|
1085
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
1086
|
-
ttlInHours?: number;
|
1087
|
-
};
|
1088
1094
|
/** @description A key for the resource data cache purging. */
|
1089
1095
|
purgeKey?: string;
|
1090
1096
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -1111,7 +1117,7 @@ interface external$c {
|
|
1111
1117
|
method: "GET" | "POST" | "HEAD";
|
1112
1118
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1113
1119
|
variables?: {
|
1114
|
-
[key: string]: external$
|
1120
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1115
1121
|
};
|
1116
1122
|
/** @description Custom configuration specific to the data source being defined */
|
1117
1123
|
custom?: {
|
@@ -1144,7 +1150,7 @@ interface external$c {
|
|
1144
1150
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1145
1151
|
*/
|
1146
1152
|
DataResourceDefinitions: {
|
1147
|
-
[key: string]: external$
|
1153
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1148
1154
|
};
|
1149
1155
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1150
1156
|
DataResourceDefinition: {
|
@@ -1158,7 +1164,7 @@ interface external$c {
|
|
1158
1164
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1159
1165
|
*/
|
1160
1166
|
ignorePatternParameterDefault?: boolean;
|
1161
|
-
variables?: external$
|
1167
|
+
variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1162
1168
|
};
|
1163
1169
|
/** @description Variable values for a data resource. */
|
1164
1170
|
DataResourceVariables: {
|
@@ -1194,6 +1200,26 @@ interface external$c {
|
|
1194
1200
|
*/
|
1195
1201
|
projectMapId: string;
|
1196
1202
|
};
|
1203
|
+
/** @description AI Prompt definition. */
|
1204
|
+
Prompt: {
|
1205
|
+
/**
|
1206
|
+
* Format: uuid
|
1207
|
+
* @description Unique identifier for the prompt
|
1208
|
+
*/
|
1209
|
+
id: string;
|
1210
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
1211
|
+
integrationType: string;
|
1212
|
+
/** @description Name for the prompt */
|
1213
|
+
promptName?: string | null;
|
1214
|
+
/** @description Text for the prompt */
|
1215
|
+
promptText?: string | null;
|
1216
|
+
/** @description Data for the prompt */
|
1217
|
+
promptData?: string | null;
|
1218
|
+
/** @description Turn off/on prompt */
|
1219
|
+
enabled?: boolean | null;
|
1220
|
+
/** @description Integration default prompt */
|
1221
|
+
builtIn?: boolean | null;
|
1222
|
+
};
|
1197
1223
|
};
|
1198
1224
|
};
|
1199
1225
|
operations: {};
|
@@ -1201,7 +1227,7 @@ interface external$c {
|
|
1201
1227
|
}
|
1202
1228
|
|
1203
1229
|
type SharedComponents$2 = components$5['schemas'];
|
1204
|
-
type Api$2 = paths$
|
1230
|
+
type Api$2 = paths$d['/api/v1/canvas-definitions'];
|
1205
1231
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1206
1232
|
type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
1207
1233
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1225,11 +1251,80 @@ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPerm
|
|
1225
1251
|
/** Defines a component type that can live on a Composition */
|
1226
1252
|
type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
|
1227
1253
|
|
1254
|
+
/** Public ID of Canvas personalization component type */
|
1255
|
+
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
1256
|
+
/** Public ID of Canvas A/B test component type */
|
1257
|
+
declare const CANVAS_TEST_TYPE = "$test";
|
1258
|
+
/** Public ID of Canvas localization component type */
|
1259
|
+
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
1260
|
+
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
1261
|
+
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
1262
|
+
/** Public ID of the locale parameter on Canvas components */
|
1263
|
+
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
1264
|
+
/** Parameter type for a block parameter */
|
1265
|
+
declare const CANVAS_BLOCK_PARAM_TYPE = "$block";
|
1266
|
+
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
1267
|
+
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
1268
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1269
|
+
declare const CANVAS_TEST_SLOT = "test";
|
1270
|
+
/** Name of the slot on CANVAS_TEST_TYPE */
|
1271
|
+
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
1272
|
+
/** Constant for a draft composition state. Subject to change. */
|
1273
|
+
declare const CANVAS_DRAFT_STATE = 0;
|
1274
|
+
/** Constant for a published composition state. Subject to change. */
|
1275
|
+
declare const CANVAS_PUBLISHED_STATE = 64;
|
1276
|
+
/** Constant for editor composition state. */
|
1277
|
+
declare const CANVAS_EDITOR_STATE = 63;
|
1278
|
+
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
1279
|
+
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1280
|
+
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
1281
|
+
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1282
|
+
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
1283
|
+
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
1284
|
+
/**
|
1285
|
+
* The name of the query string used to set a secret to protect for the preview mode.
|
1286
|
+
* This is not configurable at the moment.
|
1287
|
+
*/
|
1288
|
+
declare const SECRET_QUERY_STRING_PARAM = "secret";
|
1289
|
+
/** The name of the query string used to detect if we are in contextual editing mode */
|
1290
|
+
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
1291
|
+
/** The name of the query string used to indicate that we want to use the playground for preview */
|
1292
|
+
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
1293
|
+
/** The name of the query string used to get the config from the preview url */
|
1294
|
+
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
1295
|
+
/** The value of "data-role" in the component start `<script>` tag */
|
1296
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
1297
|
+
/** The value of "data-role" in the component end `<script>` tag */
|
1298
|
+
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
1299
|
+
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
1300
|
+
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
1301
|
+
/**
|
1302
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
1303
|
+
* Use to allow interacting with them by default in the preview panel
|
1304
|
+
*/
|
1305
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
1306
|
+
/** The ID we give to placeholder components */
|
1307
|
+
declare const PLACEHOLDER_ID = "placeholder";
|
1308
|
+
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
1309
|
+
declare const EMPTY_COMPOSITION: {
|
1310
|
+
_id: string;
|
1311
|
+
_name: string;
|
1312
|
+
type: string;
|
1313
|
+
};
|
1314
|
+
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
1315
|
+
declare const EDGE_MIN_CACHE_TTL = 10;
|
1316
|
+
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
1317
|
+
declare const EDGE_MAX_CACHE_TTL: number;
|
1318
|
+
/** Default value for Edgehancers Cache TTL (in seconds) */
|
1319
|
+
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
1320
|
+
/** A value that indicates that Edgehancers caching is disabled */
|
1321
|
+
declare const EDGE_CACHE_DISABLED = -1;
|
1322
|
+
|
1228
1323
|
/**
|
1229
1324
|
* This file was auto-generated by openapi-typescript.
|
1230
1325
|
* Do not make direct changes to the file.
|
1231
1326
|
*/
|
1232
|
-
interface paths$
|
1327
|
+
interface paths$c {
|
1233
1328
|
"/api/v1/categories": {
|
1234
1329
|
get: {
|
1235
1330
|
parameters: {
|
@@ -1242,33 +1337,33 @@ interface paths$a {
|
|
1242
1337
|
200: {
|
1243
1338
|
content: {
|
1244
1339
|
"application/json": {
|
1245
|
-
categories: external$
|
1340
|
+
categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1246
1341
|
};
|
1247
1342
|
};
|
1248
1343
|
};
|
1249
|
-
400: external$
|
1250
|
-
401: external$
|
1251
|
-
403: external$
|
1252
|
-
429: external$
|
1253
|
-
500: external$
|
1344
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1345
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1346
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1347
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1348
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1254
1349
|
};
|
1255
1350
|
};
|
1256
1351
|
put: {
|
1257
1352
|
responses: {
|
1258
1353
|
/** OK */
|
1259
1354
|
204: never;
|
1260
|
-
400: external$
|
1261
|
-
401: external$
|
1262
|
-
403: external$
|
1263
|
-
429: external$
|
1264
|
-
500: external$
|
1355
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1356
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1357
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1358
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1359
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1265
1360
|
};
|
1266
1361
|
requestBody: {
|
1267
1362
|
content: {
|
1268
1363
|
"application/json": {
|
1269
1364
|
/** Format: uuid */
|
1270
1365
|
projectId: string;
|
1271
|
-
categories: external$
|
1366
|
+
categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1272
1367
|
};
|
1273
1368
|
};
|
1274
1369
|
};
|
@@ -1277,11 +1372,11 @@ interface paths$a {
|
|
1277
1372
|
responses: {
|
1278
1373
|
/** OK */
|
1279
1374
|
204: never;
|
1280
|
-
400: external$
|
1281
|
-
401: external$
|
1282
|
-
403: external$
|
1283
|
-
429: external$
|
1284
|
-
500: external$
|
1375
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1376
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1377
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1378
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1379
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1285
1380
|
};
|
1286
1381
|
requestBody: {
|
1287
1382
|
content: {
|
@@ -1296,7 +1391,7 @@ interface paths$a {
|
|
1296
1391
|
};
|
1297
1392
|
};
|
1298
1393
|
}
|
1299
|
-
interface external$
|
1394
|
+
interface external$d {
|
1300
1395
|
"swagger.yml": {
|
1301
1396
|
paths: {};
|
1302
1397
|
components: {
|
@@ -1310,25 +1405,25 @@ interface external$b {
|
|
1310
1405
|
/** Request input validation failed */
|
1311
1406
|
BadRequestError: {
|
1312
1407
|
content: {
|
1313
|
-
"application/json": external$
|
1408
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1314
1409
|
};
|
1315
1410
|
};
|
1316
1411
|
/** API key or token was not valid */
|
1317
1412
|
UnauthorizedError: {
|
1318
1413
|
content: {
|
1319
|
-
"application/json": external$
|
1414
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1320
1415
|
};
|
1321
1416
|
};
|
1322
1417
|
/** Permission was denied */
|
1323
1418
|
ForbiddenError: {
|
1324
1419
|
content: {
|
1325
|
-
"application/json": external$
|
1420
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1326
1421
|
};
|
1327
1422
|
};
|
1328
1423
|
/** Resource not found */
|
1329
1424
|
NotFoundError: {
|
1330
1425
|
content: {
|
1331
|
-
"application/json": external$
|
1426
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1332
1427
|
};
|
1333
1428
|
};
|
1334
1429
|
/** Too many requests in allowed time period */
|
@@ -1347,7 +1442,7 @@ interface external$b {
|
|
1347
1442
|
PublicIdProperty: string;
|
1348
1443
|
/** @description The definition of a component parameter */
|
1349
1444
|
ComponentDefinitionParameter: {
|
1350
|
-
id: external$
|
1445
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1351
1446
|
/** @description Friendly name of the parameter */
|
1352
1447
|
name: string;
|
1353
1448
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1359,7 +1454,7 @@ interface external$b {
|
|
1359
1454
|
};
|
1360
1455
|
/** @description The definition of a named component slot that can contain other components */
|
1361
1456
|
ComponentDefinitionSlot: {
|
1362
|
-
id: external$
|
1457
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1363
1458
|
/** @description Friendly name of the slot */
|
1364
1459
|
name: string;
|
1365
1460
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1417,13 +1512,13 @@ interface external$b {
|
|
1417
1512
|
};
|
1418
1513
|
/** @description The definition of a component variant */
|
1419
1514
|
ComponentDefinitionVariant: {
|
1420
|
-
id: external$
|
1515
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1421
1516
|
/** @description Friendly name of the variant */
|
1422
1517
|
name: string;
|
1423
1518
|
};
|
1424
1519
|
/** @description Permission set for a component defintion */
|
1425
1520
|
ComponentDefinitionPermission: {
|
1426
|
-
roleId: external$
|
1521
|
+
roleId: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1427
1522
|
/**
|
1428
1523
|
* @description Permission type for this permission ComponentDefinition:
|
1429
1524
|
* read | write | create | delete
|
@@ -1436,7 +1531,7 @@ interface external$b {
|
|
1436
1531
|
};
|
1437
1532
|
/** @description Defines a component type that can live on a Composition */
|
1438
1533
|
ComponentDefinition: {
|
1439
|
-
id: external$
|
1534
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1440
1535
|
/** @description Friendly name of the component definition */
|
1441
1536
|
name: string;
|
1442
1537
|
/**
|
@@ -1457,7 +1552,7 @@ interface external$b {
|
|
1457
1552
|
*/
|
1458
1553
|
canBeComposition?: boolean;
|
1459
1554
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1460
|
-
parameters?: external$
|
1555
|
+
parameters?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1461
1556
|
/**
|
1462
1557
|
* Format: uuid
|
1463
1558
|
* @description Reference to the category this component definition belongs to
|
@@ -1480,14 +1575,14 @@ interface external$b {
|
|
1480
1575
|
*/
|
1481
1576
|
useTeamPermissions?: boolean;
|
1482
1577
|
/** @description Custom role permissions for this component definition */
|
1483
|
-
permissions?: external$
|
1578
|
+
permissions?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1484
1579
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1485
|
-
slots?: external$
|
1486
|
-
slugSettings?: external$
|
1580
|
+
slots?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1581
|
+
slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1487
1582
|
/** @description Default component instance value */
|
1488
|
-
defaults?: external$
|
1583
|
+
defaults?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1489
1584
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1490
|
-
variants?: external$
|
1585
|
+
variants?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1491
1586
|
/** @description Created date string for this definition (ignored for writes) */
|
1492
1587
|
created?: string;
|
1493
1588
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1495,7 +1590,7 @@ interface external$b {
|
|
1495
1590
|
};
|
1496
1591
|
/** @description Defines a content type */
|
1497
1592
|
ContentType: {
|
1498
|
-
id: external$
|
1593
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1499
1594
|
/** @description Friendly name of the content type */
|
1500
1595
|
name: string;
|
1501
1596
|
/**
|
@@ -1504,28 +1599,28 @@ interface external$b {
|
|
1504
1599
|
*/
|
1505
1600
|
entryName?: string | null;
|
1506
1601
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1507
|
-
fields?: external$
|
1508
|
-
/**
|
1509
|
-
* Format: uuid
|
1510
|
-
* @description Reference to the category this component definition belongs to
|
1511
|
-
* @default null
|
1512
|
-
*/
|
1513
|
-
categoryId?: string | null;
|
1602
|
+
fields?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1514
1603
|
/**
|
1515
|
-
* @description Description of the
|
1604
|
+
* @description Description of the content type
|
1516
1605
|
* @default null
|
1517
1606
|
*/
|
1518
1607
|
description?: string;
|
1519
1608
|
/**
|
1520
|
-
* @description
|
1521
|
-
* @default
|
1609
|
+
* @description Icon name for the content type (e.g. 'screen')
|
1610
|
+
* @default file-document
|
1522
1611
|
*/
|
1523
|
-
|
1612
|
+
icon?: string;
|
1524
1613
|
/** @description Created date string for this content type (ignored for writes) */
|
1525
1614
|
created?: string;
|
1526
1615
|
/** @description Last modified date string for this content type (ignored for writes) */
|
1527
1616
|
updated?: string;
|
1528
|
-
slugSettings?: external$
|
1617
|
+
slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1618
|
+
/**
|
1619
|
+
* @description The definition type of this content type (block or content type)
|
1620
|
+
* @default contentType
|
1621
|
+
* @enum {string}
|
1622
|
+
*/
|
1623
|
+
type?: "contentType" | "block";
|
1529
1624
|
};
|
1530
1625
|
/** @description Defines an editable parameter on a component. */
|
1531
1626
|
ComponentParameter: {
|
@@ -1534,7 +1629,7 @@ interface external$b {
|
|
1534
1629
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1535
1630
|
type: string;
|
1536
1631
|
/** @deprecated */
|
1537
|
-
connectedData?: external$
|
1632
|
+
connectedData?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1538
1633
|
};
|
1539
1634
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
1540
1635
|
DataElementConnectionDefinition: {
|
@@ -1552,13 +1647,13 @@ interface external$b {
|
|
1552
1647
|
type: string;
|
1553
1648
|
/** @description Component parameter values for the component instance */
|
1554
1649
|
parameters?: {
|
1555
|
-
[key: string]: external$
|
1650
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1556
1651
|
};
|
1557
1652
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1558
1653
|
variant?: string;
|
1559
1654
|
/** @description Slots containing any child components */
|
1560
1655
|
slots?: {
|
1561
|
-
[key: string]: external$
|
1656
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1562
1657
|
};
|
1563
1658
|
/**
|
1564
1659
|
* @description Unique identifier of the component within the composition.
|
@@ -1569,13 +1664,13 @@ interface external$b {
|
|
1569
1664
|
_id?: string;
|
1570
1665
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1571
1666
|
_pattern?: string;
|
1572
|
-
_dataResources?: external$
|
1667
|
+
_dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1573
1668
|
/**
|
1574
1669
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1575
1670
|
* Means nothing for PUTs; it will be ignored.
|
1576
1671
|
*/
|
1577
1672
|
_patternDataResources?: {
|
1578
|
-
[key: string]: external$
|
1673
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1579
1674
|
};
|
1580
1675
|
/**
|
1581
1676
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1599,7 +1694,7 @@ interface external$b {
|
|
1599
1694
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1600
1695
|
*/
|
1601
1696
|
_overrides?: {
|
1602
|
-
[key: string]: external$
|
1697
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1603
1698
|
};
|
1604
1699
|
/**
|
1605
1700
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1608,7 +1703,7 @@ interface external$b {
|
|
1608
1703
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1609
1704
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1610
1705
|
*/
|
1611
|
-
_overridability?: external$
|
1706
|
+
_overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1612
1707
|
};
|
1613
1708
|
/** @description Defines the shape of the root component in a composition */
|
1614
1709
|
RootComponentInstance: {
|
@@ -1616,15 +1711,15 @@ interface external$b {
|
|
1616
1711
|
type: string;
|
1617
1712
|
/** @description Component parameter values for the component instance */
|
1618
1713
|
parameters?: {
|
1619
|
-
[key: string]: external$
|
1714
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1620
1715
|
};
|
1621
1716
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1622
1717
|
variant?: string;
|
1623
1718
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1624
|
-
projectMapNodes?: external$
|
1719
|
+
projectMapNodes?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1625
1720
|
/** @description Slots containing any child components */
|
1626
1721
|
slots?: {
|
1627
|
-
[key: string]: external$
|
1722
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1628
1723
|
};
|
1629
1724
|
/** @description The public UUID of the composition. */
|
1630
1725
|
_id: string;
|
@@ -1632,7 +1727,7 @@ interface external$b {
|
|
1632
1727
|
_slug?: string | null;
|
1633
1728
|
/** @description Friendly name of this component. */
|
1634
1729
|
_name: string;
|
1635
|
-
_dataResources?: external$
|
1730
|
+
_dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1636
1731
|
/**
|
1637
1732
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1638
1733
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1646,7 +1741,7 @@ interface external$b {
|
|
1646
1741
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1647
1742
|
*/
|
1648
1743
|
_overrides?: {
|
1649
|
-
[key: string]: external$
|
1744
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1650
1745
|
};
|
1651
1746
|
/**
|
1652
1747
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1655,7 +1750,7 @@ interface external$b {
|
|
1655
1750
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1656
1751
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1657
1752
|
*/
|
1658
|
-
_overridability?: external$
|
1753
|
+
_overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1659
1754
|
};
|
1660
1755
|
/**
|
1661
1756
|
* @description Defines how to override a specific component.
|
@@ -1665,7 +1760,7 @@ interface external$b {
|
|
1665
1760
|
*/
|
1666
1761
|
ComponentOverride: {
|
1667
1762
|
parameters?: {
|
1668
|
-
[key: string]: external$
|
1763
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1669
1764
|
};
|
1670
1765
|
variant?: string;
|
1671
1766
|
};
|
@@ -1679,7 +1774,7 @@ interface external$b {
|
|
1679
1774
|
ComponentOverridability: {
|
1680
1775
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1681
1776
|
parameters?: {
|
1682
|
-
[key: string]: external$
|
1777
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1683
1778
|
};
|
1684
1779
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1685
1780
|
variants?: boolean;
|
@@ -1720,7 +1815,7 @@ interface external$b {
|
|
1720
1815
|
}[];
|
1721
1816
|
/** @description Variables needed to make calls to the data source */
|
1722
1817
|
variables?: {
|
1723
|
-
[key: string]: external$
|
1818
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1724
1819
|
};
|
1725
1820
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1726
1821
|
custom?: {
|
@@ -1744,15 +1839,8 @@ interface external$b {
|
|
1744
1839
|
allowedOnComponents?: string[];
|
1745
1840
|
/** @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. */
|
1746
1841
|
path: string;
|
1747
|
-
/** @description Time-to-live (in seconds) for the
|
1842
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
1748
1843
|
ttl?: number;
|
1749
|
-
/** @description Long term data resource cache configuration. */
|
1750
|
-
longTermCache?: {
|
1751
|
-
/** @description A flag to turn the long term cache on. */
|
1752
|
-
enabled: boolean;
|
1753
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
1754
|
-
ttlInHours?: number;
|
1755
|
-
};
|
1756
1844
|
/** @description A key for the resource data cache purging. */
|
1757
1845
|
purgeKey?: string;
|
1758
1846
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -1779,7 +1867,7 @@ interface external$b {
|
|
1779
1867
|
method: "GET" | "POST" | "HEAD";
|
1780
1868
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1781
1869
|
variables?: {
|
1782
|
-
[key: string]: external$
|
1870
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1783
1871
|
};
|
1784
1872
|
/** @description Custom configuration specific to the data source being defined */
|
1785
1873
|
custom?: {
|
@@ -1812,7 +1900,7 @@ interface external$b {
|
|
1812
1900
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1813
1901
|
*/
|
1814
1902
|
DataResourceDefinitions: {
|
1815
|
-
[key: string]: external$
|
1903
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1816
1904
|
};
|
1817
1905
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1818
1906
|
DataResourceDefinition: {
|
@@ -1826,7 +1914,7 @@ interface external$b {
|
|
1826
1914
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1827
1915
|
*/
|
1828
1916
|
ignorePatternParameterDefault?: boolean;
|
1829
|
-
variables?: external$
|
1917
|
+
variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1830
1918
|
};
|
1831
1919
|
/** @description Variable values for a data resource. */
|
1832
1920
|
DataResourceVariables: {
|
@@ -1862,6 +1950,26 @@ interface external$b {
|
|
1862
1950
|
*/
|
1863
1951
|
projectMapId: string;
|
1864
1952
|
};
|
1953
|
+
/** @description AI Prompt definition. */
|
1954
|
+
Prompt: {
|
1955
|
+
/**
|
1956
|
+
* Format: uuid
|
1957
|
+
* @description Unique identifier for the prompt
|
1958
|
+
*/
|
1959
|
+
id: string;
|
1960
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
1961
|
+
integrationType: string;
|
1962
|
+
/** @description Name for the prompt */
|
1963
|
+
promptName?: string | null;
|
1964
|
+
/** @description Text for the prompt */
|
1965
|
+
promptText?: string | null;
|
1966
|
+
/** @description Data for the prompt */
|
1967
|
+
promptData?: string | null;
|
1968
|
+
/** @description Turn off/on prompt */
|
1969
|
+
enabled?: boolean | null;
|
1970
|
+
/** @description Integration default prompt */
|
1971
|
+
builtIn?: boolean | null;
|
1972
|
+
};
|
1865
1973
|
};
|
1866
1974
|
};
|
1867
1975
|
operations: {};
|
@@ -1869,7 +1977,7 @@ interface external$b {
|
|
1869
1977
|
}
|
1870
1978
|
|
1871
1979
|
type SharedComponents$1 = components$5['schemas'];
|
1872
|
-
type Api$1 = paths$
|
1980
|
+
type Api$1 = paths$c['/api/v1/categories'];
|
1873
1981
|
/** Shape of the GET response from /api/v1/category */
|
1874
1982
|
type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1875
1983
|
/** Shape of the PUT request body for /api/v1/category */
|
@@ -1885,7 +1993,7 @@ type Category = SharedComponents$1['Category'];
|
|
1885
1993
|
* This file was auto-generated by openapi-typescript.
|
1886
1994
|
* Do not make direct changes to the file.
|
1887
1995
|
*/
|
1888
|
-
interface paths$
|
1996
|
+
interface paths$b {
|
1889
1997
|
"/api/v1/content-types": {
|
1890
1998
|
get: {
|
1891
1999
|
parameters: {
|
@@ -1896,6 +2004,8 @@ interface paths$9 {
|
|
1896
2004
|
offset?: number;
|
1897
2005
|
/** Max number of records to return */
|
1898
2006
|
limit?: number;
|
2007
|
+
/** Limit the types of content type to return. If not specified, both block types and content types are returned. */
|
2008
|
+
type?: "block" | "contentType";
|
1899
2009
|
};
|
1900
2010
|
};
|
1901
2011
|
responses: {
|
@@ -1904,15 +2014,15 @@ interface paths$9 {
|
|
1904
2014
|
content: {
|
1905
2015
|
"application/json": {
|
1906
2016
|
/** @description Content types that match the query */
|
1907
|
-
contentTypes: external$
|
2017
|
+
contentTypes: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
|
1908
2018
|
};
|
1909
2019
|
};
|
1910
2020
|
};
|
1911
|
-
400: external$
|
1912
|
-
401: external$
|
1913
|
-
403: external$
|
1914
|
-
429: external$
|
1915
|
-
500: external$
|
2021
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2022
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2023
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2024
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2025
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1916
2026
|
};
|
1917
2027
|
};
|
1918
2028
|
/** Upserts a content type */
|
@@ -1920,11 +2030,11 @@ interface paths$9 {
|
|
1920
2030
|
responses: {
|
1921
2031
|
/** OK */
|
1922
2032
|
204: never;
|
1923
|
-
400: external$
|
1924
|
-
401: external$
|
1925
|
-
403: external$
|
1926
|
-
429: external$
|
1927
|
-
500: external$
|
2033
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2034
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2035
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2036
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2037
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1928
2038
|
};
|
1929
2039
|
requestBody: {
|
1930
2040
|
content: {
|
@@ -1934,7 +2044,7 @@ interface paths$9 {
|
|
1934
2044
|
* @description The project ID to upsert the content type to
|
1935
2045
|
*/
|
1936
2046
|
projectId: string;
|
1937
|
-
contentType: external$
|
2047
|
+
contentType: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"];
|
1938
2048
|
};
|
1939
2049
|
};
|
1940
2050
|
};
|
@@ -1944,11 +2054,11 @@ interface paths$9 {
|
|
1944
2054
|
responses: {
|
1945
2055
|
/** OK */
|
1946
2056
|
204: never;
|
1947
|
-
400: external$
|
1948
|
-
401: external$
|
1949
|
-
403: external$
|
1950
|
-
429: external$
|
1951
|
-
500: external$
|
2057
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2058
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2059
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2060
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2061
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1952
2062
|
};
|
1953
2063
|
requestBody: {
|
1954
2064
|
content: {
|
@@ -1973,7 +2083,7 @@ interface paths$9 {
|
|
1973
2083
|
};
|
1974
2084
|
};
|
1975
2085
|
}
|
1976
|
-
interface external$
|
2086
|
+
interface external$c {
|
1977
2087
|
"swagger.yml": {
|
1978
2088
|
paths: {};
|
1979
2089
|
components: {
|
@@ -1987,25 +2097,25 @@ interface external$a {
|
|
1987
2097
|
/** Request input validation failed */
|
1988
2098
|
BadRequestError: {
|
1989
2099
|
content: {
|
1990
|
-
"application/json": external$
|
2100
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
1991
2101
|
};
|
1992
2102
|
};
|
1993
2103
|
/** API key or token was not valid */
|
1994
2104
|
UnauthorizedError: {
|
1995
2105
|
content: {
|
1996
|
-
"application/json": external$
|
2106
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
1997
2107
|
};
|
1998
2108
|
};
|
1999
2109
|
/** Permission was denied */
|
2000
2110
|
ForbiddenError: {
|
2001
2111
|
content: {
|
2002
|
-
"application/json": external$
|
2112
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2003
2113
|
};
|
2004
2114
|
};
|
2005
2115
|
/** Resource not found */
|
2006
2116
|
NotFoundError: {
|
2007
2117
|
content: {
|
2008
|
-
"application/json": external$
|
2118
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2009
2119
|
};
|
2010
2120
|
};
|
2011
2121
|
/** Too many requests in allowed time period */
|
@@ -2024,7 +2134,7 @@ interface external$a {
|
|
2024
2134
|
PublicIdProperty: string;
|
2025
2135
|
/** @description The definition of a component parameter */
|
2026
2136
|
ComponentDefinitionParameter: {
|
2027
|
-
id: external$
|
2137
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2028
2138
|
/** @description Friendly name of the parameter */
|
2029
2139
|
name: string;
|
2030
2140
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2036,7 +2146,7 @@ interface external$a {
|
|
2036
2146
|
};
|
2037
2147
|
/** @description The definition of a named component slot that can contain other components */
|
2038
2148
|
ComponentDefinitionSlot: {
|
2039
|
-
id: external$
|
2149
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2040
2150
|
/** @description Friendly name of the slot */
|
2041
2151
|
name: string;
|
2042
2152
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2094,13 +2204,13 @@ interface external$a {
|
|
2094
2204
|
};
|
2095
2205
|
/** @description The definition of a component variant */
|
2096
2206
|
ComponentDefinitionVariant: {
|
2097
|
-
id: external$
|
2207
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2098
2208
|
/** @description Friendly name of the variant */
|
2099
2209
|
name: string;
|
2100
2210
|
};
|
2101
2211
|
/** @description Permission set for a component defintion */
|
2102
2212
|
ComponentDefinitionPermission: {
|
2103
|
-
roleId: external$
|
2213
|
+
roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2104
2214
|
/**
|
2105
2215
|
* @description Permission type for this permission ComponentDefinition:
|
2106
2216
|
* read | write | create | delete
|
@@ -2113,7 +2223,7 @@ interface external$a {
|
|
2113
2223
|
};
|
2114
2224
|
/** @description Defines a component type that can live on a Composition */
|
2115
2225
|
ComponentDefinition: {
|
2116
|
-
id: external$
|
2226
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2117
2227
|
/** @description Friendly name of the component definition */
|
2118
2228
|
name: string;
|
2119
2229
|
/**
|
@@ -2134,7 +2244,7 @@ interface external$a {
|
|
2134
2244
|
*/
|
2135
2245
|
canBeComposition?: boolean;
|
2136
2246
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2137
|
-
parameters?: external$
|
2247
|
+
parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2138
2248
|
/**
|
2139
2249
|
* Format: uuid
|
2140
2250
|
* @description Reference to the category this component definition belongs to
|
@@ -2157,14 +2267,14 @@ interface external$a {
|
|
2157
2267
|
*/
|
2158
2268
|
useTeamPermissions?: boolean;
|
2159
2269
|
/** @description Custom role permissions for this component definition */
|
2160
|
-
permissions?: external$
|
2270
|
+
permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2161
2271
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2162
|
-
slots?: external$
|
2163
|
-
slugSettings?: external$
|
2272
|
+
slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2273
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2164
2274
|
/** @description Default component instance value */
|
2165
|
-
defaults?: external$
|
2275
|
+
defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2166
2276
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2167
|
-
variants?: external$
|
2277
|
+
variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2168
2278
|
/** @description Created date string for this definition (ignored for writes) */
|
2169
2279
|
created?: string;
|
2170
2280
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2172,7 +2282,7 @@ interface external$a {
|
|
2172
2282
|
};
|
2173
2283
|
/** @description Defines a content type */
|
2174
2284
|
ContentType: {
|
2175
|
-
id: external$
|
2285
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2176
2286
|
/** @description Friendly name of the content type */
|
2177
2287
|
name: string;
|
2178
2288
|
/**
|
@@ -2181,28 +2291,28 @@ interface external$a {
|
|
2181
2291
|
*/
|
2182
2292
|
entryName?: string | null;
|
2183
2293
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2184
|
-
fields?: external$
|
2185
|
-
/**
|
2186
|
-
* Format: uuid
|
2187
|
-
* @description Reference to the category this component definition belongs to
|
2188
|
-
* @default null
|
2189
|
-
*/
|
2190
|
-
categoryId?: string | null;
|
2294
|
+
fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2191
2295
|
/**
|
2192
|
-
* @description Description of the
|
2296
|
+
* @description Description of the content type
|
2193
2297
|
* @default null
|
2194
2298
|
*/
|
2195
2299
|
description?: string;
|
2196
2300
|
/**
|
2197
|
-
* @description
|
2198
|
-
* @default
|
2301
|
+
* @description Icon name for the content type (e.g. 'screen')
|
2302
|
+
* @default file-document
|
2199
2303
|
*/
|
2200
|
-
|
2304
|
+
icon?: string;
|
2201
2305
|
/** @description Created date string for this content type (ignored for writes) */
|
2202
2306
|
created?: string;
|
2203
2307
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2204
2308
|
updated?: string;
|
2205
|
-
slugSettings?: external$
|
2309
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2310
|
+
/**
|
2311
|
+
* @description The definition type of this content type (block or content type)
|
2312
|
+
* @default contentType
|
2313
|
+
* @enum {string}
|
2314
|
+
*/
|
2315
|
+
type?: "contentType" | "block";
|
2206
2316
|
};
|
2207
2317
|
/** @description Defines an editable parameter on a component. */
|
2208
2318
|
ComponentParameter: {
|
@@ -2211,7 +2321,7 @@ interface external$a {
|
|
2211
2321
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2212
2322
|
type: string;
|
2213
2323
|
/** @deprecated */
|
2214
|
-
connectedData?: external$
|
2324
|
+
connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2215
2325
|
};
|
2216
2326
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
2217
2327
|
DataElementConnectionDefinition: {
|
@@ -2229,13 +2339,13 @@ interface external$a {
|
|
2229
2339
|
type: string;
|
2230
2340
|
/** @description Component parameter values for the component instance */
|
2231
2341
|
parameters?: {
|
2232
|
-
[key: string]: external$
|
2342
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2233
2343
|
};
|
2234
2344
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2235
2345
|
variant?: string;
|
2236
2346
|
/** @description Slots containing any child components */
|
2237
2347
|
slots?: {
|
2238
|
-
[key: string]: external$
|
2348
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2239
2349
|
};
|
2240
2350
|
/**
|
2241
2351
|
* @description Unique identifier of the component within the composition.
|
@@ -2246,13 +2356,13 @@ interface external$a {
|
|
2246
2356
|
_id?: string;
|
2247
2357
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2248
2358
|
_pattern?: string;
|
2249
|
-
_dataResources?: external$
|
2359
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2250
2360
|
/**
|
2251
2361
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2252
2362
|
* Means nothing for PUTs; it will be ignored.
|
2253
2363
|
*/
|
2254
2364
|
_patternDataResources?: {
|
2255
|
-
[key: string]: external$
|
2365
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2256
2366
|
};
|
2257
2367
|
/**
|
2258
2368
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2276,7 +2386,7 @@ interface external$a {
|
|
2276
2386
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2277
2387
|
*/
|
2278
2388
|
_overrides?: {
|
2279
|
-
[key: string]: external$
|
2389
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2280
2390
|
};
|
2281
2391
|
/**
|
2282
2392
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2285,7 +2395,7 @@ interface external$a {
|
|
2285
2395
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2286
2396
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2287
2397
|
*/
|
2288
|
-
_overridability?: external$
|
2398
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2289
2399
|
};
|
2290
2400
|
/** @description Defines the shape of the root component in a composition */
|
2291
2401
|
RootComponentInstance: {
|
@@ -2293,15 +2403,15 @@ interface external$a {
|
|
2293
2403
|
type: string;
|
2294
2404
|
/** @description Component parameter values for the component instance */
|
2295
2405
|
parameters?: {
|
2296
|
-
[key: string]: external$
|
2406
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2297
2407
|
};
|
2298
2408
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2299
2409
|
variant?: string;
|
2300
2410
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2301
|
-
projectMapNodes?: external$
|
2411
|
+
projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2302
2412
|
/** @description Slots containing any child components */
|
2303
2413
|
slots?: {
|
2304
|
-
[key: string]: external$
|
2414
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2305
2415
|
};
|
2306
2416
|
/** @description The public UUID of the composition. */
|
2307
2417
|
_id: string;
|
@@ -2309,7 +2419,7 @@ interface external$a {
|
|
2309
2419
|
_slug?: string | null;
|
2310
2420
|
/** @description Friendly name of this component. */
|
2311
2421
|
_name: string;
|
2312
|
-
_dataResources?: external$
|
2422
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2313
2423
|
/**
|
2314
2424
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2315
2425
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2323,7 +2433,7 @@ interface external$a {
|
|
2323
2433
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2324
2434
|
*/
|
2325
2435
|
_overrides?: {
|
2326
|
-
[key: string]: external$
|
2436
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2327
2437
|
};
|
2328
2438
|
/**
|
2329
2439
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2332,7 +2442,7 @@ interface external$a {
|
|
2332
2442
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2333
2443
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2334
2444
|
*/
|
2335
|
-
_overridability?: external$
|
2445
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2336
2446
|
};
|
2337
2447
|
/**
|
2338
2448
|
* @description Defines how to override a specific component.
|
@@ -2342,7 +2452,7 @@ interface external$a {
|
|
2342
2452
|
*/
|
2343
2453
|
ComponentOverride: {
|
2344
2454
|
parameters?: {
|
2345
|
-
[key: string]: external$
|
2455
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2346
2456
|
};
|
2347
2457
|
variant?: string;
|
2348
2458
|
};
|
@@ -2356,7 +2466,7 @@ interface external$a {
|
|
2356
2466
|
ComponentOverridability: {
|
2357
2467
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2358
2468
|
parameters?: {
|
2359
|
-
[key: string]: external$
|
2469
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2360
2470
|
};
|
2361
2471
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2362
2472
|
variants?: boolean;
|
@@ -2397,7 +2507,7 @@ interface external$a {
|
|
2397
2507
|
}[];
|
2398
2508
|
/** @description Variables needed to make calls to the data source */
|
2399
2509
|
variables?: {
|
2400
|
-
[key: string]: external$
|
2510
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2401
2511
|
};
|
2402
2512
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2403
2513
|
custom?: {
|
@@ -2421,15 +2531,8 @@ interface external$a {
|
|
2421
2531
|
allowedOnComponents?: string[];
|
2422
2532
|
/** @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. */
|
2423
2533
|
path: string;
|
2424
|
-
/** @description Time-to-live (in seconds) for the
|
2534
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
2425
2535
|
ttl?: number;
|
2426
|
-
/** @description Long term data resource cache configuration. */
|
2427
|
-
longTermCache?: {
|
2428
|
-
/** @description A flag to turn the long term cache on. */
|
2429
|
-
enabled: boolean;
|
2430
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
2431
|
-
ttlInHours?: number;
|
2432
|
-
};
|
2433
2536
|
/** @description A key for the resource data cache purging. */
|
2434
2537
|
purgeKey?: string;
|
2435
2538
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -2456,7 +2559,7 @@ interface external$a {
|
|
2456
2559
|
method: "GET" | "POST" | "HEAD";
|
2457
2560
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2458
2561
|
variables?: {
|
2459
|
-
[key: string]: external$
|
2562
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2460
2563
|
};
|
2461
2564
|
/** @description Custom configuration specific to the data source being defined */
|
2462
2565
|
custom?: {
|
@@ -2489,7 +2592,7 @@ interface external$a {
|
|
2489
2592
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2490
2593
|
*/
|
2491
2594
|
DataResourceDefinitions: {
|
2492
|
-
[key: string]: external$
|
2595
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2493
2596
|
};
|
2494
2597
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2495
2598
|
DataResourceDefinition: {
|
@@ -2503,7 +2606,7 @@ interface external$a {
|
|
2503
2606
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2504
2607
|
*/
|
2505
2608
|
ignorePatternParameterDefault?: boolean;
|
2506
|
-
variables?: external$
|
2609
|
+
variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2507
2610
|
};
|
2508
2611
|
/** @description Variable values for a data resource. */
|
2509
2612
|
DataResourceVariables: {
|
@@ -2539,6 +2642,26 @@ interface external$a {
|
|
2539
2642
|
*/
|
2540
2643
|
projectMapId: string;
|
2541
2644
|
};
|
2645
|
+
/** @description AI Prompt definition. */
|
2646
|
+
Prompt: {
|
2647
|
+
/**
|
2648
|
+
* Format: uuid
|
2649
|
+
* @description Unique identifier for the prompt
|
2650
|
+
*/
|
2651
|
+
id: string;
|
2652
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
2653
|
+
integrationType: string;
|
2654
|
+
/** @description Name for the prompt */
|
2655
|
+
promptName?: string | null;
|
2656
|
+
/** @description Text for the prompt */
|
2657
|
+
promptText?: string | null;
|
2658
|
+
/** @description Data for the prompt */
|
2659
|
+
promptData?: string | null;
|
2660
|
+
/** @description Turn off/on prompt */
|
2661
|
+
enabled?: boolean | null;
|
2662
|
+
/** @description Integration default prompt */
|
2663
|
+
builtIn?: boolean | null;
|
2664
|
+
};
|
2542
2665
|
};
|
2543
2666
|
};
|
2544
2667
|
operations: {};
|
@@ -2549,7 +2672,7 @@ interface external$a {
|
|
2549
2672
|
* This file was auto-generated by openapi-typescript.
|
2550
2673
|
* Do not make direct changes to the file.
|
2551
2674
|
*/
|
2552
|
-
interface paths$
|
2675
|
+
interface paths$a {
|
2553
2676
|
"/api/v1/entries": {
|
2554
2677
|
get: {
|
2555
2678
|
parameters: {
|
@@ -2589,6 +2712,13 @@ interface paths$8 {
|
|
2589
2712
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2590
2713
|
*/
|
2591
2714
|
withUIStatus?: components$4["parameters"]["withUIStatus"];
|
2715
|
+
/**
|
2716
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
2717
|
+
* If false, the `_id` will not be present in the API response.
|
2718
|
+
*/
|
2719
|
+
withComponentIDs?: components$4["parameters"]["withComponentIDs"];
|
2720
|
+
/** Performs keyword search on the entries. */
|
2721
|
+
keyword?: components$4["parameters"]["keyword"];
|
2592
2722
|
};
|
2593
2723
|
};
|
2594
2724
|
responses: {
|
@@ -2598,17 +2728,17 @@ interface paths$8 {
|
|
2598
2728
|
"application/json": components$4["schemas"]["EntryListResponse"];
|
2599
2729
|
};
|
2600
2730
|
};
|
2601
|
-
400: external$
|
2602
|
-
401: external$
|
2603
|
-
403: external$
|
2731
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2732
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2733
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2604
2734
|
/** Entry not found */
|
2605
2735
|
404: {
|
2606
2736
|
content: {
|
2607
2737
|
"text/plain": string;
|
2608
2738
|
};
|
2609
2739
|
};
|
2610
|
-
429: external$
|
2611
|
-
500: external$
|
2740
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2741
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2612
2742
|
};
|
2613
2743
|
};
|
2614
2744
|
/** Upserts an entry */
|
@@ -2616,11 +2746,11 @@ interface paths$8 {
|
|
2616
2746
|
responses: {
|
2617
2747
|
/** OK */
|
2618
2748
|
204: never;
|
2619
|
-
400: external$
|
2620
|
-
401: external$
|
2621
|
-
403: external$
|
2622
|
-
429: external$
|
2623
|
-
500: external$
|
2749
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2750
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2751
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2752
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2753
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2624
2754
|
};
|
2625
2755
|
requestBody: {
|
2626
2756
|
content: {
|
@@ -2646,11 +2776,11 @@ interface paths$8 {
|
|
2646
2776
|
responses: {
|
2647
2777
|
/** OK */
|
2648
2778
|
204: never;
|
2649
|
-
400: external$
|
2650
|
-
401: external$
|
2651
|
-
403: external$
|
2652
|
-
429: external$
|
2653
|
-
500: external$
|
2779
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2780
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2781
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2782
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2783
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2654
2784
|
};
|
2655
2785
|
requestBody: {
|
2656
2786
|
content: {
|
@@ -2693,15 +2823,15 @@ interface components$4 {
|
|
2693
2823
|
_id: string;
|
2694
2824
|
/** @description The name of the entry. */
|
2695
2825
|
_name?: string;
|
2696
|
-
/** @description The slug of the entry
|
2826
|
+
/** @description The slug of the entry. */
|
2697
2827
|
_slug?: string;
|
2698
2828
|
/** @description Name of the author of the most recent change. */
|
2699
2829
|
_author?: string;
|
2700
2830
|
/** @description Entry field values. */
|
2701
2831
|
fields?: {
|
2702
|
-
[key: string]: external$
|
2832
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2703
2833
|
};
|
2704
|
-
_dataResources?: external$
|
2834
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2705
2835
|
};
|
2706
2836
|
/** @description Defines the shape of the entry input */
|
2707
2837
|
EntryInput: {
|
@@ -2712,11 +2842,15 @@ interface components$4 {
|
|
2712
2842
|
* @description The public UUID of the entry.
|
2713
2843
|
*/
|
2714
2844
|
_id?: string;
|
2845
|
+
/** @description The name of the entry. */
|
2846
|
+
_name?: string;
|
2847
|
+
/** @description The slug of the entry. */
|
2848
|
+
_slug?: string;
|
2715
2849
|
/** @description Entry field values. */
|
2716
2850
|
fields?: {
|
2717
|
-
[key: string]: external$
|
2851
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2718
2852
|
};
|
2719
|
-
_dataResources?: external$
|
2853
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2720
2854
|
};
|
2721
2855
|
EntryApiResponse: {
|
2722
2856
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -2750,44 +2884,1348 @@ interface components$4 {
|
|
2750
2884
|
totalCount?: number;
|
2751
2885
|
};
|
2752
2886
|
};
|
2753
|
-
parameters: {
|
2754
|
-
/** @description The project the entry/entries are on. */
|
2755
|
-
projectId: string;
|
2756
|
-
/** @description Specify multiple entry IDs to fetch. */
|
2757
|
-
entryIDs: string[];
|
2758
|
-
/** @description Specify a single entry to fetch by slug. */
|
2759
|
-
slug: string;
|
2760
|
-
/** @description The content type ID to filter by. */
|
2761
|
-
type: string[];
|
2762
|
-
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2763
|
-
state: number;
|
2764
|
-
/** @description Number of records to skip */
|
2765
|
-
offset: number;
|
2766
|
-
/** @description Max number of records to return */
|
2767
|
-
limit: number;
|
2768
|
-
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2769
|
-
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
|
2770
|
-
/**
|
2771
|
-
* @deprecated
|
2772
|
-
* @description Returns the UI status string of the entry.
|
2773
|
-
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2774
|
-
*/
|
2775
|
-
withUIStatus: boolean;
|
2776
|
-
/**
|
2777
|
-
* @
|
2778
|
-
*
|
2779
|
-
|
2780
|
-
|
2781
|
-
|
2782
|
-
|
2783
|
-
|
2784
|
-
|
2785
|
-
|
2786
|
-
|
2787
|
-
|
2788
|
-
|
2789
|
-
|
2790
|
-
|
2887
|
+
parameters: {
|
2888
|
+
/** @description The project the entry/entries are on. */
|
2889
|
+
projectId: string;
|
2890
|
+
/** @description Specify multiple entry IDs to fetch. */
|
2891
|
+
entryIDs: string[];
|
2892
|
+
/** @description Specify a single entry to fetch by slug. */
|
2893
|
+
slug: string;
|
2894
|
+
/** @description The content type ID to filter by. */
|
2895
|
+
type: string[];
|
2896
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2897
|
+
state: number;
|
2898
|
+
/** @description Number of records to skip */
|
2899
|
+
offset: number;
|
2900
|
+
/** @description Max number of records to return */
|
2901
|
+
limit: number;
|
2902
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2903
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
|
2904
|
+
/**
|
2905
|
+
* @deprecated
|
2906
|
+
* @description Returns the UI status string of the entry.
|
2907
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2908
|
+
*/
|
2909
|
+
withUIStatus: boolean;
|
2910
|
+
/**
|
2911
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
2912
|
+
* If false, the `_id` will not be present in the API response.
|
2913
|
+
*/
|
2914
|
+
withComponentIDs: boolean;
|
2915
|
+
/**
|
2916
|
+
* @deprecated
|
2917
|
+
* @description Filters entries lists by the UI status of the entry.
|
2918
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2919
|
+
*/
|
2920
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
2921
|
+
/** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
2922
|
+
createdBy: string;
|
2923
|
+
/** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
|
2924
|
+
updatedBy: string;
|
2925
|
+
/**
|
2926
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
2927
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2928
|
+
*/
|
2929
|
+
withTotalCount: boolean;
|
2930
|
+
/** @description Performs keyword search on the entries. */
|
2931
|
+
keyword: string;
|
2932
|
+
};
|
2933
|
+
}
|
2934
|
+
interface external$b {
|
2935
|
+
"swagger.yml": {
|
2936
|
+
paths: {};
|
2937
|
+
components: {
|
2938
|
+
schemas: {
|
2939
|
+
Error: {
|
2940
|
+
/** @description Error message(s) that occurred while processing the request */
|
2941
|
+
errorMessage?: string[] | string;
|
2942
|
+
};
|
2943
|
+
};
|
2944
|
+
responses: {
|
2945
|
+
/** Request input validation failed */
|
2946
|
+
BadRequestError: {
|
2947
|
+
content: {
|
2948
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
2949
|
+
};
|
2950
|
+
};
|
2951
|
+
/** API key or token was not valid */
|
2952
|
+
UnauthorizedError: {
|
2953
|
+
content: {
|
2954
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
2955
|
+
};
|
2956
|
+
};
|
2957
|
+
/** Permission was denied */
|
2958
|
+
ForbiddenError: {
|
2959
|
+
content: {
|
2960
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
2961
|
+
};
|
2962
|
+
};
|
2963
|
+
/** Resource not found */
|
2964
|
+
NotFoundError: {
|
2965
|
+
content: {
|
2966
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
2967
|
+
};
|
2968
|
+
};
|
2969
|
+
/** Too many requests in allowed time period */
|
2970
|
+
RateLimitError: unknown;
|
2971
|
+
/** Execution error occurred */
|
2972
|
+
InternalServerError: unknown;
|
2973
|
+
};
|
2974
|
+
};
|
2975
|
+
operations: {};
|
2976
|
+
};
|
2977
|
+
"uniform-canvas-types.swagger.yml": {
|
2978
|
+
paths: {};
|
2979
|
+
components: {
|
2980
|
+
schemas: {
|
2981
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
2982
|
+
PublicIdProperty: string;
|
2983
|
+
/** @description The definition of a component parameter */
|
2984
|
+
ComponentDefinitionParameter: {
|
2985
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2986
|
+
/** @description Friendly name of the parameter */
|
2987
|
+
name: string;
|
2988
|
+
/** @description Appears next to the parameter in the Composition editor */
|
2989
|
+
helpText?: string;
|
2990
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
2991
|
+
type: string;
|
2992
|
+
/** @description The configuration object for the type (type-specific) */
|
2993
|
+
typeConfig?: unknown;
|
2994
|
+
};
|
2995
|
+
/** @description The definition of a named component slot that can contain other components */
|
2996
|
+
ComponentDefinitionSlot: {
|
2997
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2998
|
+
/** @description Friendly name of the slot */
|
2999
|
+
name: string;
|
3000
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
3001
|
+
allowedComponents: string[];
|
3002
|
+
/**
|
3003
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
3004
|
+
* If allowAllComponents is true, this value is ignored.
|
3005
|
+
*
|
3006
|
+
* @default false
|
3007
|
+
*/
|
3008
|
+
inheritAllowedComponents: boolean;
|
3009
|
+
/**
|
3010
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
3011
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
3012
|
+
*/
|
3013
|
+
allowAllComponents?: boolean;
|
3014
|
+
/**
|
3015
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
3016
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
3017
|
+
*/
|
3018
|
+
patternsInAllowedComponents?: boolean;
|
3019
|
+
/** @description Minimum valid number of components in this slot */
|
3020
|
+
minComponents?: number;
|
3021
|
+
/** @description Maximum valid number of components in this slot */
|
3022
|
+
maxComponents?: number;
|
3023
|
+
};
|
3024
|
+
/** @description The definition of a composition's slug settings */
|
3025
|
+
ComponentDefinitionSlugSettings: {
|
3026
|
+
/**
|
3027
|
+
* @description Whether the slug is required
|
3028
|
+
* no: slug is optional
|
3029
|
+
* yes: slug is required
|
3030
|
+
* disabled: slug is disabled and will not be shown in the editor
|
3031
|
+
*
|
3032
|
+
* @default no
|
3033
|
+
* @enum {string}
|
3034
|
+
*/
|
3035
|
+
required?: "no" | "yes" | "disabled";
|
3036
|
+
/**
|
3037
|
+
* @description Slug uniqueness configuration.
|
3038
|
+
* no = no unique constraint
|
3039
|
+
* local = must be unique within this component type
|
3040
|
+
* global = must be unique across all component types
|
3041
|
+
*
|
3042
|
+
* @enum {string}
|
3043
|
+
*/
|
3044
|
+
unique?: "no" | "local" | "global";
|
3045
|
+
/** @description Regular expression slugs must match */
|
3046
|
+
regularExpression?: string;
|
3047
|
+
/**
|
3048
|
+
* @description Custom error message when regular expression validation fails.
|
3049
|
+
* Has no effect if `regularExpression` is not set.
|
3050
|
+
*/
|
3051
|
+
regularExpressionMessage?: string;
|
3052
|
+
};
|
3053
|
+
/** @description The definition of a component variant */
|
3054
|
+
ComponentDefinitionVariant: {
|
3055
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3056
|
+
/** @description Friendly name of the variant */
|
3057
|
+
name: string;
|
3058
|
+
};
|
3059
|
+
/** @description Permission set for a component defintion */
|
3060
|
+
ComponentDefinitionPermission: {
|
3061
|
+
roleId: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3062
|
+
/**
|
3063
|
+
* @description Permission type for this permission ComponentDefinition:
|
3064
|
+
* read | write | create | delete
|
3065
|
+
*
|
3066
|
+
* @enum {string}
|
3067
|
+
*/
|
3068
|
+
permission: "read" | "write" | "create" | "delete";
|
3069
|
+
/** @description State of the component that this permission applies to */
|
3070
|
+
state: number;
|
3071
|
+
};
|
3072
|
+
/** @description Defines a component type that can live on a Composition */
|
3073
|
+
ComponentDefinition: {
|
3074
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3075
|
+
/** @description Friendly name of the component definition */
|
3076
|
+
name: string;
|
3077
|
+
/**
|
3078
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
3079
|
+
* @default screen
|
3080
|
+
*/
|
3081
|
+
icon?: string;
|
3082
|
+
/**
|
3083
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
3084
|
+
* The parameter type must support being used as a title parameter for this to work.
|
3085
|
+
*
|
3086
|
+
* @default null
|
3087
|
+
*/
|
3088
|
+
titleParameter?: string | null;
|
3089
|
+
/**
|
3090
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
3091
|
+
* @default false
|
3092
|
+
*/
|
3093
|
+
canBeComposition?: boolean;
|
3094
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
3095
|
+
parameters?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3096
|
+
/**
|
3097
|
+
* Format: uuid
|
3098
|
+
* @description Reference to the category this component definition belongs to
|
3099
|
+
* @default null
|
3100
|
+
*/
|
3101
|
+
categoryId?: string | null;
|
3102
|
+
/**
|
3103
|
+
* @description Description of the component definition
|
3104
|
+
* @default null
|
3105
|
+
*/
|
3106
|
+
description?: string;
|
3107
|
+
/**
|
3108
|
+
* @description Description of the component definition
|
3109
|
+
* @default null
|
3110
|
+
*/
|
3111
|
+
previewImageUrl?: string;
|
3112
|
+
/**
|
3113
|
+
* @description if this component uses team permissions or custom permissions
|
3114
|
+
* @default true
|
3115
|
+
*/
|
3116
|
+
useTeamPermissions?: boolean;
|
3117
|
+
/** @description Custom role permissions for this component definition */
|
3118
|
+
permissions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
3119
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
3120
|
+
slots?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3121
|
+
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3122
|
+
/** @description Default component instance value */
|
3123
|
+
defaults?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
3124
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
3125
|
+
variants?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
3126
|
+
/** @description Created date string for this definition (ignored for writes) */
|
3127
|
+
created?: string;
|
3128
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
3129
|
+
updated?: string;
|
3130
|
+
};
|
3131
|
+
/** @description Defines a content type */
|
3132
|
+
ContentType: {
|
3133
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3134
|
+
/** @description Friendly name of the content type */
|
3135
|
+
name: string;
|
3136
|
+
/**
|
3137
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
3138
|
+
* The field type must support being used as an entry name for this to work.
|
3139
|
+
*/
|
3140
|
+
entryName?: string | null;
|
3141
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3142
|
+
fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3143
|
+
/**
|
3144
|
+
* @description Description of the content type
|
3145
|
+
* @default null
|
3146
|
+
*/
|
3147
|
+
description?: string;
|
3148
|
+
/**
|
3149
|
+
* @description Icon name for the content type (e.g. 'screen')
|
3150
|
+
* @default file-document
|
3151
|
+
*/
|
3152
|
+
icon?: string;
|
3153
|
+
/** @description Created date string for this content type (ignored for writes) */
|
3154
|
+
created?: string;
|
3155
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
3156
|
+
updated?: string;
|
3157
|
+
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3158
|
+
/**
|
3159
|
+
* @description The definition type of this content type (block or content type)
|
3160
|
+
* @default contentType
|
3161
|
+
* @enum {string}
|
3162
|
+
*/
|
3163
|
+
type?: "contentType" | "block";
|
3164
|
+
};
|
3165
|
+
/** @description Defines an editable parameter on a component. */
|
3166
|
+
ComponentParameter: {
|
3167
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
3168
|
+
value: unknown;
|
3169
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
3170
|
+
type: string;
|
3171
|
+
/** @deprecated */
|
3172
|
+
connectedData?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3173
|
+
};
|
3174
|
+
/** @description Defines a connection to a dynamic token on a data resource. */
|
3175
|
+
DataElementConnectionDefinition: {
|
3176
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value. */
|
3177
|
+
pointer: string;
|
3178
|
+
/**
|
3179
|
+
* @description The syntax used to select the dynamic token to bind to
|
3180
|
+
* @enum {string}
|
3181
|
+
*/
|
3182
|
+
syntax: "jptr";
|
3183
|
+
};
|
3184
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
3185
|
+
ComponentInstance: {
|
3186
|
+
/** @description Type of the component instance (public_id of its definition) */
|
3187
|
+
type: string;
|
3188
|
+
/** @description Component parameter values for the component instance */
|
3189
|
+
parameters?: {
|
3190
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3191
|
+
};
|
3192
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3193
|
+
variant?: string;
|
3194
|
+
/** @description Slots containing any child components */
|
3195
|
+
slots?: {
|
3196
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3197
|
+
};
|
3198
|
+
/**
|
3199
|
+
* @description Unique identifier of the component within the composition.
|
3200
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
3201
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
3202
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
|
3203
|
+
*/
|
3204
|
+
_id?: string;
|
3205
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3206
|
+
_pattern?: string;
|
3207
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3208
|
+
/**
|
3209
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3210
|
+
* Means nothing for PUTs; it will be ignored.
|
3211
|
+
*/
|
3212
|
+
_patternDataResources?: {
|
3213
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3214
|
+
};
|
3215
|
+
/**
|
3216
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
3217
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
3218
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
3219
|
+
* Means nothing for PUTs; it will be ignored.
|
3220
|
+
*
|
3221
|
+
* @enum {string}
|
3222
|
+
*/
|
3223
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
3224
|
+
/**
|
3225
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3226
|
+
* This can be used to override parameters that are defined on patterns,
|
3227
|
+
* including nested patterns, with values that are specific to this composition.
|
3228
|
+
* The keys in this object are component IDs.
|
3229
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3230
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3231
|
+
* the composition's override replaces the pattern's.
|
3232
|
+
*
|
3233
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3234
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3235
|
+
*/
|
3236
|
+
_overrides?: {
|
3237
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3238
|
+
};
|
3239
|
+
/**
|
3240
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3241
|
+
* by consumers of the pattern.
|
3242
|
+
*
|
3243
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3244
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3245
|
+
*/
|
3246
|
+
_overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3247
|
+
};
|
3248
|
+
/** @description Defines the shape of the root component in a composition */
|
3249
|
+
RootComponentInstance: {
|
3250
|
+
/** @description Type of the component instance (public_id of its definition) */
|
3251
|
+
type: string;
|
3252
|
+
/** @description Component parameter values for the component instance */
|
3253
|
+
parameters?: {
|
3254
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3255
|
+
};
|
3256
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3257
|
+
variant?: string;
|
3258
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
3259
|
+
projectMapNodes?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
3260
|
+
/** @description Slots containing any child components */
|
3261
|
+
slots?: {
|
3262
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3263
|
+
};
|
3264
|
+
/** @description The public UUID of the composition. */
|
3265
|
+
_id: string;
|
3266
|
+
/** @description Slug pattern of this component. */
|
3267
|
+
_slug?: string | null;
|
3268
|
+
/** @description Friendly name of this component. */
|
3269
|
+
_name: string;
|
3270
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3271
|
+
/**
|
3272
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3273
|
+
* This can be used to override parameters that are defined on patterns,
|
3274
|
+
* including nested patterns, with values that are specific to this composition.
|
3275
|
+
* The keys in this object are component IDs.
|
3276
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3277
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3278
|
+
* the composition's override replaces the pattern's.
|
3279
|
+
*
|
3280
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3281
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3282
|
+
*/
|
3283
|
+
_overrides?: {
|
3284
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3285
|
+
};
|
3286
|
+
/**
|
3287
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3288
|
+
* by consumers of the pattern.
|
3289
|
+
*
|
3290
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3291
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3292
|
+
*/
|
3293
|
+
_overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3294
|
+
};
|
3295
|
+
/**
|
3296
|
+
* @description Defines how to override a specific component.
|
3297
|
+
*
|
3298
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3299
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3300
|
+
*/
|
3301
|
+
ComponentOverride: {
|
3302
|
+
parameters?: {
|
3303
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3304
|
+
};
|
3305
|
+
variant?: string;
|
3306
|
+
};
|
3307
|
+
/**
|
3308
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
3309
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
3310
|
+
*
|
3311
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3312
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3313
|
+
*/
|
3314
|
+
ComponentOverridability: {
|
3315
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3316
|
+
parameters?: {
|
3317
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3318
|
+
};
|
3319
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3320
|
+
variants?: boolean;
|
3321
|
+
};
|
3322
|
+
/**
|
3323
|
+
* @description Whether a parameter is overridable
|
3324
|
+
*
|
3325
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3326
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3327
|
+
*
|
3328
|
+
* @enum {string}
|
3329
|
+
*/
|
3330
|
+
OverrideOptions: "yes" | "no";
|
3331
|
+
/**
|
3332
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
3333
|
+
* These are created in the UI and shared across a whole project.
|
3334
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
3335
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
3336
|
+
*/
|
3337
|
+
DataSource: {
|
3338
|
+
/** @description Public ID of the data source */
|
3339
|
+
id: string;
|
3340
|
+
/** @description Display name of the data source */
|
3341
|
+
displayName: string;
|
3342
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
3343
|
+
connectorType: string;
|
3344
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
3345
|
+
baseUrl: string;
|
3346
|
+
/** @description HTTP headers to pass with requests to the data source */
|
3347
|
+
headers?: {
|
3348
|
+
key: string;
|
3349
|
+
value: string;
|
3350
|
+
}[];
|
3351
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3352
|
+
parameters?: {
|
3353
|
+
key: string;
|
3354
|
+
value: string;
|
3355
|
+
}[];
|
3356
|
+
/** @description Variables needed to make calls to the data source */
|
3357
|
+
variables?: {
|
3358
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3359
|
+
};
|
3360
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
3361
|
+
custom?: {
|
3362
|
+
[key: string]: unknown;
|
3363
|
+
};
|
3364
|
+
};
|
3365
|
+
/** @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. */
|
3366
|
+
DataType: {
|
3367
|
+
/** @description Public ID of the data type */
|
3368
|
+
id: string;
|
3369
|
+
/** @description Display name of the data type */
|
3370
|
+
displayName: string;
|
3371
|
+
/** @description Public ID of the associated data source */
|
3372
|
+
dataSourceId: string;
|
3373
|
+
/**
|
3374
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
3375
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
3376
|
+
* no special UI or processing is required.
|
3377
|
+
*/
|
3378
|
+
archetype?: string;
|
3379
|
+
allowedOnComponents?: string[];
|
3380
|
+
/** @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. */
|
3381
|
+
path: string;
|
3382
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
3383
|
+
ttl?: number;
|
3384
|
+
/** @description A key for the resource data cache purging. */
|
3385
|
+
purgeKey?: string;
|
3386
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
3387
|
+
badgeIconUrl?: string;
|
3388
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3389
|
+
headers?: {
|
3390
|
+
key: string;
|
3391
|
+
value: string;
|
3392
|
+
omitIfEmpty?: boolean;
|
3393
|
+
}[];
|
3394
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3395
|
+
parameters?: {
|
3396
|
+
key: string;
|
3397
|
+
value: string;
|
3398
|
+
omitIfEmpty?: boolean;
|
3399
|
+
}[];
|
3400
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
3401
|
+
body?: string;
|
3402
|
+
/**
|
3403
|
+
* @description HTTP method to use with requests to the data type.
|
3404
|
+
* @default GET
|
3405
|
+
* @enum {string}
|
3406
|
+
*/
|
3407
|
+
method: "GET" | "POST" | "HEAD";
|
3408
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
3409
|
+
variables?: {
|
3410
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3411
|
+
};
|
3412
|
+
/** @description Custom configuration specific to the data source being defined */
|
3413
|
+
custom?: {
|
3414
|
+
[key: string]: unknown;
|
3415
|
+
};
|
3416
|
+
};
|
3417
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
3418
|
+
DataVariableDefinition: {
|
3419
|
+
/** @description Display name of the data variable */
|
3420
|
+
displayName?: string;
|
3421
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
3422
|
+
helpText?: string;
|
3423
|
+
/**
|
3424
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
3425
|
+
* @default text
|
3426
|
+
*/
|
3427
|
+
type?: string;
|
3428
|
+
/** @description Default value of the data variable */
|
3429
|
+
default: string;
|
3430
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
3431
|
+
order?: number;
|
3432
|
+
/**
|
3433
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
3434
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
|
3435
|
+
*/
|
3436
|
+
source?: string;
|
3437
|
+
};
|
3438
|
+
/**
|
3439
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
3440
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3441
|
+
*/
|
3442
|
+
DataResourceDefinitions: {
|
3443
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3444
|
+
};
|
3445
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3446
|
+
DataResourceDefinition: {
|
3447
|
+
/** @description Public ID of the data type that provides this data */
|
3448
|
+
type: string;
|
3449
|
+
/** @description Whether this data is a pattern data resource that can 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. */
|
3450
|
+
isPatternParameter?: boolean;
|
3451
|
+
/**
|
3452
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
3453
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
3454
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
3455
|
+
*/
|
3456
|
+
ignorePatternParameterDefault?: boolean;
|
3457
|
+
variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3458
|
+
};
|
3459
|
+
/** @description Variable values for a data resource. */
|
3460
|
+
DataResourceVariables: {
|
3461
|
+
[key: string]: string;
|
3462
|
+
};
|
3463
|
+
/** @description Category for tagging canvas entities */
|
3464
|
+
Category: {
|
3465
|
+
/**
|
3466
|
+
* Format: uuid
|
3467
|
+
* @description Unique identifier for the category
|
3468
|
+
*/
|
3469
|
+
id: string;
|
3470
|
+
/** @description Display name of the category */
|
3471
|
+
name: string;
|
3472
|
+
/**
|
3473
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
|
3474
|
+
* @default 0
|
3475
|
+
*/
|
3476
|
+
order?: number;
|
3477
|
+
};
|
3478
|
+
/** @description Project map node information related to a component. */
|
3479
|
+
CompositionProjectMapNodeInfo: {
|
3480
|
+
/**
|
3481
|
+
* Format: uuid
|
3482
|
+
* @description Unique identifier for the project map node
|
3483
|
+
*/
|
3484
|
+
id: string;
|
3485
|
+
/** @description Path of the project map node */
|
3486
|
+
path: string;
|
3487
|
+
/**
|
3488
|
+
* Format: uuid
|
3489
|
+
* @description Unique identifier for the project map that this node belongs to.
|
3490
|
+
*/
|
3491
|
+
projectMapId: string;
|
3492
|
+
};
|
3493
|
+
/** @description AI Prompt definition. */
|
3494
|
+
Prompt: {
|
3495
|
+
/**
|
3496
|
+
* Format: uuid
|
3497
|
+
* @description Unique identifier for the prompt
|
3498
|
+
*/
|
3499
|
+
id: string;
|
3500
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
3501
|
+
integrationType: string;
|
3502
|
+
/** @description Name for the prompt */
|
3503
|
+
promptName?: string | null;
|
3504
|
+
/** @description Text for the prompt */
|
3505
|
+
promptText?: string | null;
|
3506
|
+
/** @description Data for the prompt */
|
3507
|
+
promptData?: string | null;
|
3508
|
+
/** @description Turn off/on prompt */
|
3509
|
+
enabled?: boolean | null;
|
3510
|
+
/** @description Integration default prompt */
|
3511
|
+
builtIn?: boolean | null;
|
3512
|
+
};
|
3513
|
+
};
|
3514
|
+
};
|
3515
|
+
operations: {};
|
3516
|
+
};
|
3517
|
+
}
|
3518
|
+
|
3519
|
+
type ContentType = components$5['schemas']['ContentType'];
|
3520
|
+
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
3521
|
+
type GetContentTypesOptions = paths$b['/api/v1/content-types']['get']['parameters']['query'];
|
3522
|
+
type DeleteContentTypeOptions = paths$b['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
3523
|
+
type PutContentTypeBody = paths$b['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3524
|
+
type GetContentTypesResponse = paths$b['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3525
|
+
type Entry = components$4['schemas']['EntryApiResponse'];
|
3526
|
+
type EntryData = Entry['entry'];
|
3527
|
+
type GetEntriesOptions = paths$a['/api/v1/entries']['get']['parameters']['query'];
|
3528
|
+
type GetEntriesResponse = paths$a['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3529
|
+
type DeleteEntryOptions = paths$a['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
3530
|
+
type PutEntryBody = paths$a['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
3531
|
+
|
3532
|
+
/**
|
3533
|
+
* This file was auto-generated by openapi-typescript.
|
3534
|
+
* Do not make direct changes to the file.
|
3535
|
+
*/
|
3536
|
+
interface paths$9 {
|
3537
|
+
"/api/v1/data-source": {
|
3538
|
+
get: {
|
3539
|
+
parameters: {
|
3540
|
+
query: {
|
3541
|
+
dataSourceId: string;
|
3542
|
+
projectId: string;
|
3543
|
+
};
|
3544
|
+
};
|
3545
|
+
responses: {
|
3546
|
+
/** OK */
|
3547
|
+
200: {
|
3548
|
+
content: {
|
3549
|
+
"application/json": {
|
3550
|
+
result: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
3551
|
+
};
|
3552
|
+
};
|
3553
|
+
};
|
3554
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3555
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3556
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3557
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3558
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3559
|
+
};
|
3560
|
+
};
|
3561
|
+
put: {
|
3562
|
+
responses: {
|
3563
|
+
/** OK */
|
3564
|
+
204: never;
|
3565
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3566
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3567
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3568
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3569
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3570
|
+
};
|
3571
|
+
requestBody: {
|
3572
|
+
content: {
|
3573
|
+
"application/json": {
|
3574
|
+
data: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
3575
|
+
/** Format: uuid */
|
3576
|
+
projectId: string;
|
3577
|
+
/**
|
3578
|
+
* Format: uuid
|
3579
|
+
* @deprecated
|
3580
|
+
* @description Do not use. May be removed in future.
|
3581
|
+
*/
|
3582
|
+
integrationId?: string;
|
3583
|
+
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
3584
|
+
integrationType?: string;
|
3585
|
+
};
|
3586
|
+
};
|
3587
|
+
};
|
3588
|
+
};
|
3589
|
+
delete: {
|
3590
|
+
responses: {
|
3591
|
+
/** OK */
|
3592
|
+
204: never;
|
3593
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3594
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3595
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3596
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3597
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3598
|
+
};
|
3599
|
+
requestBody: {
|
3600
|
+
content: {
|
3601
|
+
"application/json": {
|
3602
|
+
dataSourceId: string;
|
3603
|
+
/** Format: uuid */
|
3604
|
+
projectId: string;
|
3605
|
+
};
|
3606
|
+
};
|
3607
|
+
};
|
3608
|
+
};
|
3609
|
+
};
|
3610
|
+
}
|
3611
|
+
interface external$a {
|
3612
|
+
"swagger.yml": {
|
3613
|
+
paths: {};
|
3614
|
+
components: {
|
3615
|
+
schemas: {
|
3616
|
+
Error: {
|
3617
|
+
/** @description Error message(s) that occurred while processing the request */
|
3618
|
+
errorMessage?: string[] | string;
|
3619
|
+
};
|
3620
|
+
};
|
3621
|
+
responses: {
|
3622
|
+
/** Request input validation failed */
|
3623
|
+
BadRequestError: {
|
3624
|
+
content: {
|
3625
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
3626
|
+
};
|
3627
|
+
};
|
3628
|
+
/** API key or token was not valid */
|
3629
|
+
UnauthorizedError: {
|
3630
|
+
content: {
|
3631
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
3632
|
+
};
|
3633
|
+
};
|
3634
|
+
/** Permission was denied */
|
3635
|
+
ForbiddenError: {
|
3636
|
+
content: {
|
3637
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
3638
|
+
};
|
3639
|
+
};
|
3640
|
+
/** Resource not found */
|
3641
|
+
NotFoundError: {
|
3642
|
+
content: {
|
3643
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
3644
|
+
};
|
3645
|
+
};
|
3646
|
+
/** Too many requests in allowed time period */
|
3647
|
+
RateLimitError: unknown;
|
3648
|
+
/** Execution error occurred */
|
3649
|
+
InternalServerError: unknown;
|
3650
|
+
};
|
3651
|
+
};
|
3652
|
+
operations: {};
|
3653
|
+
};
|
3654
|
+
"uniform-canvas-types.swagger.yml": {
|
3655
|
+
paths: {};
|
3656
|
+
components: {
|
3657
|
+
schemas: {
|
3658
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
3659
|
+
PublicIdProperty: string;
|
3660
|
+
/** @description The definition of a component parameter */
|
3661
|
+
ComponentDefinitionParameter: {
|
3662
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3663
|
+
/** @description Friendly name of the parameter */
|
3664
|
+
name: string;
|
3665
|
+
/** @description Appears next to the parameter in the Composition editor */
|
3666
|
+
helpText?: string;
|
3667
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
3668
|
+
type: string;
|
3669
|
+
/** @description The configuration object for the type (type-specific) */
|
3670
|
+
typeConfig?: unknown;
|
3671
|
+
};
|
3672
|
+
/** @description The definition of a named component slot that can contain other components */
|
3673
|
+
ComponentDefinitionSlot: {
|
3674
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3675
|
+
/** @description Friendly name of the slot */
|
3676
|
+
name: string;
|
3677
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
3678
|
+
allowedComponents: string[];
|
3679
|
+
/**
|
3680
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
3681
|
+
* If allowAllComponents is true, this value is ignored.
|
3682
|
+
*
|
3683
|
+
* @default false
|
3684
|
+
*/
|
3685
|
+
inheritAllowedComponents: boolean;
|
3686
|
+
/**
|
3687
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
3688
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
3689
|
+
*/
|
3690
|
+
allowAllComponents?: boolean;
|
3691
|
+
/**
|
3692
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
3693
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
3694
|
+
*/
|
3695
|
+
patternsInAllowedComponents?: boolean;
|
3696
|
+
/** @description Minimum valid number of components in this slot */
|
3697
|
+
minComponents?: number;
|
3698
|
+
/** @description Maximum valid number of components in this slot */
|
3699
|
+
maxComponents?: number;
|
3700
|
+
};
|
3701
|
+
/** @description The definition of a composition's slug settings */
|
3702
|
+
ComponentDefinitionSlugSettings: {
|
3703
|
+
/**
|
3704
|
+
* @description Whether the slug is required
|
3705
|
+
* no: slug is optional
|
3706
|
+
* yes: slug is required
|
3707
|
+
* disabled: slug is disabled and will not be shown in the editor
|
3708
|
+
*
|
3709
|
+
* @default no
|
3710
|
+
* @enum {string}
|
3711
|
+
*/
|
3712
|
+
required?: "no" | "yes" | "disabled";
|
3713
|
+
/**
|
3714
|
+
* @description Slug uniqueness configuration.
|
3715
|
+
* no = no unique constraint
|
3716
|
+
* local = must be unique within this component type
|
3717
|
+
* global = must be unique across all component types
|
3718
|
+
*
|
3719
|
+
* @enum {string}
|
3720
|
+
*/
|
3721
|
+
unique?: "no" | "local" | "global";
|
3722
|
+
/** @description Regular expression slugs must match */
|
3723
|
+
regularExpression?: string;
|
3724
|
+
/**
|
3725
|
+
* @description Custom error message when regular expression validation fails.
|
3726
|
+
* Has no effect if `regularExpression` is not set.
|
3727
|
+
*/
|
3728
|
+
regularExpressionMessage?: string;
|
3729
|
+
};
|
3730
|
+
/** @description The definition of a component variant */
|
3731
|
+
ComponentDefinitionVariant: {
|
3732
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3733
|
+
/** @description Friendly name of the variant */
|
3734
|
+
name: string;
|
3735
|
+
};
|
3736
|
+
/** @description Permission set for a component defintion */
|
3737
|
+
ComponentDefinitionPermission: {
|
3738
|
+
roleId: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3739
|
+
/**
|
3740
|
+
* @description Permission type for this permission ComponentDefinition:
|
3741
|
+
* read | write | create | delete
|
3742
|
+
*
|
3743
|
+
* @enum {string}
|
3744
|
+
*/
|
3745
|
+
permission: "read" | "write" | "create" | "delete";
|
3746
|
+
/** @description State of the component that this permission applies to */
|
3747
|
+
state: number;
|
3748
|
+
};
|
3749
|
+
/** @description Defines a component type that can live on a Composition */
|
3750
|
+
ComponentDefinition: {
|
3751
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3752
|
+
/** @description Friendly name of the component definition */
|
3753
|
+
name: string;
|
3754
|
+
/**
|
3755
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
3756
|
+
* @default screen
|
3757
|
+
*/
|
3758
|
+
icon?: string;
|
3759
|
+
/**
|
3760
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
3761
|
+
* The parameter type must support being used as a title parameter for this to work.
|
3762
|
+
*
|
3763
|
+
* @default null
|
3764
|
+
*/
|
3765
|
+
titleParameter?: string | null;
|
3766
|
+
/**
|
3767
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
3768
|
+
* @default false
|
3769
|
+
*/
|
3770
|
+
canBeComposition?: boolean;
|
3771
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
3772
|
+
parameters?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3773
|
+
/**
|
3774
|
+
* Format: uuid
|
3775
|
+
* @description Reference to the category this component definition belongs to
|
3776
|
+
* @default null
|
3777
|
+
*/
|
3778
|
+
categoryId?: string | null;
|
3779
|
+
/**
|
3780
|
+
* @description Description of the component definition
|
3781
|
+
* @default null
|
3782
|
+
*/
|
3783
|
+
description?: string;
|
3784
|
+
/**
|
3785
|
+
* @description Description of the component definition
|
3786
|
+
* @default null
|
3787
|
+
*/
|
3788
|
+
previewImageUrl?: string;
|
3789
|
+
/**
|
3790
|
+
* @description if this component uses team permissions or custom permissions
|
3791
|
+
* @default true
|
3792
|
+
*/
|
3793
|
+
useTeamPermissions?: boolean;
|
3794
|
+
/** @description Custom role permissions for this component definition */
|
3795
|
+
permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
3796
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
3797
|
+
slots?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3798
|
+
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3799
|
+
/** @description Default component instance value */
|
3800
|
+
defaults?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
3801
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
3802
|
+
variants?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
3803
|
+
/** @description Created date string for this definition (ignored for writes) */
|
3804
|
+
created?: string;
|
3805
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
3806
|
+
updated?: string;
|
3807
|
+
};
|
3808
|
+
/** @description Defines a content type */
|
3809
|
+
ContentType: {
|
3810
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3811
|
+
/** @description Friendly name of the content type */
|
3812
|
+
name: string;
|
3813
|
+
/**
|
3814
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
3815
|
+
* The field type must support being used as an entry name for this to work.
|
3816
|
+
*/
|
3817
|
+
entryName?: string | null;
|
3818
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3819
|
+
fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3820
|
+
/**
|
3821
|
+
* @description Description of the content type
|
3822
|
+
* @default null
|
3823
|
+
*/
|
3824
|
+
description?: string;
|
3825
|
+
/**
|
3826
|
+
* @description Icon name for the content type (e.g. 'screen')
|
3827
|
+
* @default file-document
|
3828
|
+
*/
|
3829
|
+
icon?: string;
|
3830
|
+
/** @description Created date string for this content type (ignored for writes) */
|
3831
|
+
created?: string;
|
3832
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
3833
|
+
updated?: string;
|
3834
|
+
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3835
|
+
/**
|
3836
|
+
* @description The definition type of this content type (block or content type)
|
3837
|
+
* @default contentType
|
3838
|
+
* @enum {string}
|
3839
|
+
*/
|
3840
|
+
type?: "contentType" | "block";
|
3841
|
+
};
|
3842
|
+
/** @description Defines an editable parameter on a component. */
|
3843
|
+
ComponentParameter: {
|
3844
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
3845
|
+
value: unknown;
|
3846
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
3847
|
+
type: string;
|
3848
|
+
/** @deprecated */
|
3849
|
+
connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3850
|
+
};
|
3851
|
+
/** @description Defines a connection to a dynamic token on a data resource. */
|
3852
|
+
DataElementConnectionDefinition: {
|
3853
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value. */
|
3854
|
+
pointer: string;
|
3855
|
+
/**
|
3856
|
+
* @description The syntax used to select the dynamic token to bind to
|
3857
|
+
* @enum {string}
|
3858
|
+
*/
|
3859
|
+
syntax: "jptr";
|
3860
|
+
};
|
3861
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
3862
|
+
ComponentInstance: {
|
3863
|
+
/** @description Type of the component instance (public_id of its definition) */
|
3864
|
+
type: string;
|
3865
|
+
/** @description Component parameter values for the component instance */
|
3866
|
+
parameters?: {
|
3867
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3868
|
+
};
|
3869
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3870
|
+
variant?: string;
|
3871
|
+
/** @description Slots containing any child components */
|
3872
|
+
slots?: {
|
3873
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3874
|
+
};
|
3875
|
+
/**
|
3876
|
+
* @description Unique identifier of the component within the composition.
|
3877
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
3878
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
3879
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
|
3880
|
+
*/
|
3881
|
+
_id?: string;
|
3882
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3883
|
+
_pattern?: string;
|
3884
|
+
_dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3885
|
+
/**
|
3886
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3887
|
+
* Means nothing for PUTs; it will be ignored.
|
3888
|
+
*/
|
3889
|
+
_patternDataResources?: {
|
3890
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3891
|
+
};
|
3892
|
+
/**
|
3893
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
3894
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
3895
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
3896
|
+
* Means nothing for PUTs; it will be ignored.
|
3897
|
+
*
|
3898
|
+
* @enum {string}
|
3899
|
+
*/
|
3900
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
3901
|
+
/**
|
3902
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3903
|
+
* This can be used to override parameters that are defined on patterns,
|
3904
|
+
* including nested patterns, with values that are specific to this composition.
|
3905
|
+
* The keys in this object are component IDs.
|
3906
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3907
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3908
|
+
* the composition's override replaces the pattern's.
|
3909
|
+
*
|
3910
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3911
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3912
|
+
*/
|
3913
|
+
_overrides?: {
|
3914
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3915
|
+
};
|
3916
|
+
/**
|
3917
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3918
|
+
* by consumers of the pattern.
|
3919
|
+
*
|
3920
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3921
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3922
|
+
*/
|
3923
|
+
_overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3924
|
+
};
|
3925
|
+
/** @description Defines the shape of the root component in a composition */
|
3926
|
+
RootComponentInstance: {
|
3927
|
+
/** @description Type of the component instance (public_id of its definition) */
|
3928
|
+
type: string;
|
3929
|
+
/** @description Component parameter values for the component instance */
|
3930
|
+
parameters?: {
|
3931
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3932
|
+
};
|
3933
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3934
|
+
variant?: string;
|
3935
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
3936
|
+
projectMapNodes?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
3937
|
+
/** @description Slots containing any child components */
|
3938
|
+
slots?: {
|
3939
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3940
|
+
};
|
3941
|
+
/** @description The public UUID of the composition. */
|
3942
|
+
_id: string;
|
3943
|
+
/** @description Slug pattern of this component. */
|
3944
|
+
_slug?: string | null;
|
3945
|
+
/** @description Friendly name of this component. */
|
3946
|
+
_name: string;
|
3947
|
+
_dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3948
|
+
/**
|
3949
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
3950
|
+
* This can be used to override parameters that are defined on patterns,
|
3951
|
+
* including nested patterns, with values that are specific to this composition.
|
3952
|
+
* The keys in this object are component IDs.
|
3953
|
+
* Overrides are applied from the top down, so for example if both the composition
|
3954
|
+
* and a pattern on the composition define an override on a nested pattern,
|
3955
|
+
* the composition's override replaces the pattern's.
|
3956
|
+
*
|
3957
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3958
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3959
|
+
*/
|
3960
|
+
_overrides?: {
|
3961
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3962
|
+
};
|
3963
|
+
/**
|
3964
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3965
|
+
* by consumers of the pattern.
|
3966
|
+
*
|
3967
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3968
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3969
|
+
*/
|
3970
|
+
_overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3971
|
+
};
|
3972
|
+
/**
|
3973
|
+
* @description Defines how to override a specific component.
|
3974
|
+
*
|
3975
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3976
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3977
|
+
*/
|
3978
|
+
ComponentOverride: {
|
3979
|
+
parameters?: {
|
3980
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3981
|
+
};
|
3982
|
+
variant?: string;
|
3983
|
+
};
|
3984
|
+
/**
|
3985
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
3986
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
3987
|
+
*
|
3988
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3989
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3990
|
+
*/
|
3991
|
+
ComponentOverridability: {
|
3992
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3993
|
+
parameters?: {
|
3994
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3995
|
+
};
|
3996
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3997
|
+
variants?: boolean;
|
3998
|
+
};
|
3999
|
+
/**
|
4000
|
+
* @description Whether a parameter is overridable
|
4001
|
+
*
|
4002
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
4003
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
4004
|
+
*
|
4005
|
+
* @enum {string}
|
4006
|
+
*/
|
4007
|
+
OverrideOptions: "yes" | "no";
|
4008
|
+
/**
|
4009
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
4010
|
+
* These are created in the UI and shared across a whole project.
|
4011
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
4012
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
4013
|
+
*/
|
4014
|
+
DataSource: {
|
4015
|
+
/** @description Public ID of the data source */
|
4016
|
+
id: string;
|
4017
|
+
/** @description Display name of the data source */
|
4018
|
+
displayName: string;
|
4019
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
4020
|
+
connectorType: string;
|
4021
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
4022
|
+
baseUrl: string;
|
4023
|
+
/** @description HTTP headers to pass with requests to the data source */
|
4024
|
+
headers?: {
|
4025
|
+
key: string;
|
4026
|
+
value: string;
|
4027
|
+
}[];
|
4028
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
4029
|
+
parameters?: {
|
4030
|
+
key: string;
|
4031
|
+
value: string;
|
4032
|
+
}[];
|
4033
|
+
/** @description Variables needed to make calls to the data source */
|
4034
|
+
variables?: {
|
4035
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
4036
|
+
};
|
4037
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
4038
|
+
custom?: {
|
4039
|
+
[key: string]: unknown;
|
4040
|
+
};
|
4041
|
+
};
|
4042
|
+
/** @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. */
|
4043
|
+
DataType: {
|
4044
|
+
/** @description Public ID of the data type */
|
4045
|
+
id: string;
|
4046
|
+
/** @description Display name of the data type */
|
4047
|
+
displayName: string;
|
4048
|
+
/** @description Public ID of the associated data source */
|
4049
|
+
dataSourceId: string;
|
4050
|
+
/**
|
4051
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
4052
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
4053
|
+
* no special UI or processing is required.
|
4054
|
+
*/
|
4055
|
+
archetype?: string;
|
4056
|
+
allowedOnComponents?: string[];
|
4057
|
+
/** @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. */
|
4058
|
+
path: string;
|
4059
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
4060
|
+
ttl?: number;
|
4061
|
+
/** @description A key for the resource data cache purging. */
|
4062
|
+
purgeKey?: string;
|
4063
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
4064
|
+
badgeIconUrl?: string;
|
4065
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
4066
|
+
headers?: {
|
4067
|
+
key: string;
|
4068
|
+
value: string;
|
4069
|
+
omitIfEmpty?: boolean;
|
4070
|
+
}[];
|
4071
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
4072
|
+
parameters?: {
|
4073
|
+
key: string;
|
4074
|
+
value: string;
|
4075
|
+
omitIfEmpty?: boolean;
|
4076
|
+
}[];
|
4077
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
4078
|
+
body?: string;
|
4079
|
+
/**
|
4080
|
+
* @description HTTP method to use with requests to the data type.
|
4081
|
+
* @default GET
|
4082
|
+
* @enum {string}
|
4083
|
+
*/
|
4084
|
+
method: "GET" | "POST" | "HEAD";
|
4085
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
4086
|
+
variables?: {
|
4087
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
4088
|
+
};
|
4089
|
+
/** @description Custom configuration specific to the data source being defined */
|
4090
|
+
custom?: {
|
4091
|
+
[key: string]: unknown;
|
4092
|
+
};
|
4093
|
+
};
|
4094
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
4095
|
+
DataVariableDefinition: {
|
4096
|
+
/** @description Display name of the data variable */
|
4097
|
+
displayName?: string;
|
4098
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
4099
|
+
helpText?: string;
|
4100
|
+
/**
|
4101
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
4102
|
+
* @default text
|
4103
|
+
*/
|
4104
|
+
type?: string;
|
4105
|
+
/** @description Default value of the data variable */
|
4106
|
+
default: string;
|
4107
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
4108
|
+
order?: number;
|
4109
|
+
/**
|
4110
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
4111
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
|
4112
|
+
*/
|
4113
|
+
source?: string;
|
4114
|
+
};
|
4115
|
+
/**
|
4116
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
4117
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
4118
|
+
*/
|
4119
|
+
DataResourceDefinitions: {
|
4120
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
4121
|
+
};
|
4122
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
4123
|
+
DataResourceDefinition: {
|
4124
|
+
/** @description Public ID of the data type that provides this data */
|
4125
|
+
type: string;
|
4126
|
+
/** @description Whether this data is a pattern data resource that can 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. */
|
4127
|
+
isPatternParameter?: boolean;
|
4128
|
+
/**
|
4129
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
4130
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
4131
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
4132
|
+
*/
|
4133
|
+
ignorePatternParameterDefault?: boolean;
|
4134
|
+
variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
4135
|
+
};
|
4136
|
+
/** @description Variable values for a data resource. */
|
4137
|
+
DataResourceVariables: {
|
4138
|
+
[key: string]: string;
|
4139
|
+
};
|
4140
|
+
/** @description Category for tagging canvas entities */
|
4141
|
+
Category: {
|
4142
|
+
/**
|
4143
|
+
* Format: uuid
|
4144
|
+
* @description Unique identifier for the category
|
4145
|
+
*/
|
4146
|
+
id: string;
|
4147
|
+
/** @description Display name of the category */
|
4148
|
+
name: string;
|
4149
|
+
/**
|
4150
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
|
4151
|
+
* @default 0
|
4152
|
+
*/
|
4153
|
+
order?: number;
|
4154
|
+
};
|
4155
|
+
/** @description Project map node information related to a component. */
|
4156
|
+
CompositionProjectMapNodeInfo: {
|
4157
|
+
/**
|
4158
|
+
* Format: uuid
|
4159
|
+
* @description Unique identifier for the project map node
|
4160
|
+
*/
|
4161
|
+
id: string;
|
4162
|
+
/** @description Path of the project map node */
|
4163
|
+
path: string;
|
4164
|
+
/**
|
4165
|
+
* Format: uuid
|
4166
|
+
* @description Unique identifier for the project map that this node belongs to.
|
4167
|
+
*/
|
4168
|
+
projectMapId: string;
|
4169
|
+
};
|
4170
|
+
/** @description AI Prompt definition. */
|
4171
|
+
Prompt: {
|
4172
|
+
/**
|
4173
|
+
* Format: uuid
|
4174
|
+
* @description Unique identifier for the prompt
|
4175
|
+
*/
|
4176
|
+
id: string;
|
4177
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
4178
|
+
integrationType: string;
|
4179
|
+
/** @description Name for the prompt */
|
4180
|
+
promptName?: string | null;
|
4181
|
+
/** @description Text for the prompt */
|
4182
|
+
promptText?: string | null;
|
4183
|
+
/** @description Data for the prompt */
|
4184
|
+
promptData?: string | null;
|
4185
|
+
/** @description Turn off/on prompt */
|
4186
|
+
enabled?: boolean | null;
|
4187
|
+
/** @description Integration default prompt */
|
4188
|
+
builtIn?: boolean | null;
|
4189
|
+
};
|
4190
|
+
};
|
4191
|
+
};
|
4192
|
+
operations: {};
|
4193
|
+
};
|
4194
|
+
}
|
4195
|
+
|
4196
|
+
/**
|
4197
|
+
* This file was auto-generated by openapi-typescript.
|
4198
|
+
* Do not make direct changes to the file.
|
4199
|
+
*/
|
4200
|
+
interface paths$8 {
|
4201
|
+
"/api/v1/data-sources": {
|
4202
|
+
get: {
|
4203
|
+
parameters: {
|
4204
|
+
query: {
|
4205
|
+
projectId: string;
|
4206
|
+
};
|
4207
|
+
};
|
4208
|
+
responses: {
|
4209
|
+
/**
|
4210
|
+
* Gets a list of data sources.
|
4211
|
+
* Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
|
4212
|
+
* requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
|
4213
|
+
* user, and fetch using the `data-source` endpoint for each data source.
|
4214
|
+
*/
|
4215
|
+
200: {
|
4216
|
+
content: {
|
4217
|
+
"application/json": {
|
4218
|
+
results: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
|
4219
|
+
};
|
4220
|
+
};
|
4221
|
+
};
|
4222
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4223
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4224
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4225
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4226
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4227
|
+
};
|
4228
|
+
};
|
2791
4229
|
};
|
2792
4230
|
}
|
2793
4231
|
interface external$9 {
|
@@ -3000,26 +4438,26 @@ interface external$9 {
|
|
3000
4438
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3001
4439
|
fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3002
4440
|
/**
|
3003
|
-
*
|
3004
|
-
* @description Reference to the category this component definition belongs to
|
3005
|
-
* @default null
|
3006
|
-
*/
|
3007
|
-
categoryId?: string | null;
|
3008
|
-
/**
|
3009
|
-
* @description Description of the component definition
|
4441
|
+
* @description Description of the content type
|
3010
4442
|
* @default null
|
3011
4443
|
*/
|
3012
4444
|
description?: string;
|
3013
4445
|
/**
|
3014
|
-
* @description
|
3015
|
-
* @default
|
4446
|
+
* @description Icon name for the content type (e.g. 'screen')
|
4447
|
+
* @default file-document
|
3016
4448
|
*/
|
3017
|
-
|
4449
|
+
icon?: string;
|
3018
4450
|
/** @description Created date string for this content type (ignored for writes) */
|
3019
4451
|
created?: string;
|
3020
4452
|
/** @description Last modified date string for this content type (ignored for writes) */
|
3021
4453
|
updated?: string;
|
3022
4454
|
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
4455
|
+
/**
|
4456
|
+
* @description The definition type of this content type (block or content type)
|
4457
|
+
* @default contentType
|
4458
|
+
* @enum {string}
|
4459
|
+
*/
|
4460
|
+
type?: "contentType" | "block";
|
3023
4461
|
};
|
3024
4462
|
/** @description Defines an editable parameter on a component. */
|
3025
4463
|
ComponentParameter: {
|
@@ -3238,15 +4676,8 @@ interface external$9 {
|
|
3238
4676
|
allowedOnComponents?: string[];
|
3239
4677
|
/** @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. */
|
3240
4678
|
path: string;
|
3241
|
-
/** @description Time-to-live (in seconds) for the
|
4679
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
3242
4680
|
ttl?: number;
|
3243
|
-
/** @description Long term data resource cache configuration. */
|
3244
|
-
longTermCache?: {
|
3245
|
-
/** @description A flag to turn the long term cache on. */
|
3246
|
-
enabled: boolean;
|
3247
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
3248
|
-
ttlInHours?: number;
|
3249
|
-
};
|
3250
4681
|
/** @description A key for the resource data cache purging. */
|
3251
4682
|
purgeKey?: string;
|
3252
4683
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -3356,34 +4787,41 @@ interface external$9 {
|
|
3356
4787
|
*/
|
3357
4788
|
projectMapId: string;
|
3358
4789
|
};
|
4790
|
+
/** @description AI Prompt definition. */
|
4791
|
+
Prompt: {
|
4792
|
+
/**
|
4793
|
+
* Format: uuid
|
4794
|
+
* @description Unique identifier for the prompt
|
4795
|
+
*/
|
4796
|
+
id: string;
|
4797
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
4798
|
+
integrationType: string;
|
4799
|
+
/** @description Name for the prompt */
|
4800
|
+
promptName?: string | null;
|
4801
|
+
/** @description Text for the prompt */
|
4802
|
+
promptText?: string | null;
|
4803
|
+
/** @description Data for the prompt */
|
4804
|
+
promptData?: string | null;
|
4805
|
+
/** @description Turn off/on prompt */
|
4806
|
+
enabled?: boolean | null;
|
4807
|
+
/** @description Integration default prompt */
|
4808
|
+
builtIn?: boolean | null;
|
4809
|
+
};
|
3359
4810
|
};
|
3360
4811
|
};
|
3361
4812
|
operations: {};
|
3362
4813
|
};
|
3363
4814
|
}
|
3364
4815
|
|
3365
|
-
type ContentType = components$5['schemas']['ContentType'];
|
3366
|
-
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
3367
|
-
type GetContentTypesOptions = paths$9['/api/v1/content-types']['get']['parameters']['query'];
|
3368
|
-
type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
3369
|
-
type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3370
|
-
type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3371
|
-
type Entry = components$4['schemas']['EntryApiResponse'];
|
3372
|
-
type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
|
3373
|
-
type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3374
|
-
type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
3375
|
-
type PutEntryBody = paths$8['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
3376
|
-
|
3377
4816
|
/**
|
3378
4817
|
* This file was auto-generated by openapi-typescript.
|
3379
4818
|
* Do not make direct changes to the file.
|
3380
4819
|
*/
|
3381
4820
|
interface paths$7 {
|
3382
|
-
"/api/v1/data-
|
4821
|
+
"/api/v1/data-types": {
|
3383
4822
|
get: {
|
3384
4823
|
parameters: {
|
3385
4824
|
query: {
|
3386
|
-
dataSourceId: string;
|
3387
4825
|
projectId: string;
|
3388
4826
|
};
|
3389
4827
|
};
|
@@ -3392,7 +4830,7 @@ interface paths$7 {
|
|
3392
4830
|
200: {
|
3393
4831
|
content: {
|
3394
4832
|
"application/json": {
|
3395
|
-
|
4833
|
+
results: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
3396
4834
|
};
|
3397
4835
|
};
|
3398
4836
|
};
|
@@ -3416,17 +4854,9 @@ interface paths$7 {
|
|
3416
4854
|
requestBody: {
|
3417
4855
|
content: {
|
3418
4856
|
"application/json": {
|
3419
|
-
data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
4857
|
+
data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
3420
4858
|
/** Format: uuid */
|
3421
4859
|
projectId: string;
|
3422
|
-
/**
|
3423
|
-
* Format: uuid
|
3424
|
-
* @deprecated
|
3425
|
-
* @description Do not use. May be removed in future.
|
3426
|
-
*/
|
3427
|
-
integrationId?: string;
|
3428
|
-
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
3429
|
-
integrationType?: string;
|
3430
4860
|
};
|
3431
4861
|
};
|
3432
4862
|
};
|
@@ -3444,7 +4874,7 @@ interface paths$7 {
|
|
3444
4874
|
requestBody: {
|
3445
4875
|
content: {
|
3446
4876
|
"application/json": {
|
3447
|
-
|
4877
|
+
typeId: string;
|
3448
4878
|
/** Format: uuid */
|
3449
4879
|
projectId: string;
|
3450
4880
|
};
|
@@ -3663,26 +5093,26 @@ interface external$8 {
|
|
3663
5093
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3664
5094
|
fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3665
5095
|
/**
|
3666
|
-
*
|
3667
|
-
* @description Reference to the category this component definition belongs to
|
3668
|
-
* @default null
|
3669
|
-
*/
|
3670
|
-
categoryId?: string | null;
|
3671
|
-
/**
|
3672
|
-
* @description Description of the component definition
|
5096
|
+
* @description Description of the content type
|
3673
5097
|
* @default null
|
3674
5098
|
*/
|
3675
5099
|
description?: string;
|
3676
5100
|
/**
|
3677
|
-
* @description
|
3678
|
-
* @default
|
5101
|
+
* @description Icon name for the content type (e.g. 'screen')
|
5102
|
+
* @default file-document
|
3679
5103
|
*/
|
3680
|
-
|
5104
|
+
icon?: string;
|
3681
5105
|
/** @description Created date string for this content type (ignored for writes) */
|
3682
5106
|
created?: string;
|
3683
5107
|
/** @description Last modified date string for this content type (ignored for writes) */
|
3684
5108
|
updated?: string;
|
3685
5109
|
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
5110
|
+
/**
|
5111
|
+
* @description The definition type of this content type (block or content type)
|
5112
|
+
* @default contentType
|
5113
|
+
* @enum {string}
|
5114
|
+
*/
|
5115
|
+
type?: "contentType" | "block";
|
3686
5116
|
};
|
3687
5117
|
/** @description Defines an editable parameter on a component. */
|
3688
5118
|
ComponentParameter: {
|
@@ -3901,15 +5331,8 @@ interface external$8 {
|
|
3901
5331
|
allowedOnComponents?: string[];
|
3902
5332
|
/** @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. */
|
3903
5333
|
path: string;
|
3904
|
-
/** @description Time-to-live (in seconds) for the
|
5334
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
3905
5335
|
ttl?: number;
|
3906
|
-
/** @description Long term data resource cache configuration. */
|
3907
|
-
longTermCache?: {
|
3908
|
-
/** @description A flag to turn the long term cache on. */
|
3909
|
-
enabled: boolean;
|
3910
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
3911
|
-
ttlInHours?: number;
|
3912
|
-
};
|
3913
5336
|
/** @description A key for the resource data cache purging. */
|
3914
5337
|
purgeKey?: string;
|
3915
5338
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -4019,6 +5442,26 @@ interface external$8 {
|
|
4019
5442
|
*/
|
4020
5443
|
projectMapId: string;
|
4021
5444
|
};
|
5445
|
+
/** @description AI Prompt definition. */
|
5446
|
+
Prompt: {
|
5447
|
+
/**
|
5448
|
+
* Format: uuid
|
5449
|
+
* @description Unique identifier for the prompt
|
5450
|
+
*/
|
5451
|
+
id: string;
|
5452
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
5453
|
+
integrationType: string;
|
5454
|
+
/** @description Name for the prompt */
|
5455
|
+
promptName?: string | null;
|
5456
|
+
/** @description Text for the prompt */
|
5457
|
+
promptText?: string | null;
|
5458
|
+
/** @description Data for the prompt */
|
5459
|
+
promptData?: string | null;
|
5460
|
+
/** @description Turn off/on prompt */
|
5461
|
+
enabled?: boolean | null;
|
5462
|
+
/** @description Integration default prompt */
|
5463
|
+
builtIn?: boolean | null;
|
5464
|
+
};
|
4022
5465
|
};
|
4023
5466
|
};
|
4024
5467
|
operations: {};
|
@@ -4030,24 +5473,20 @@ interface external$8 {
|
|
4030
5473
|
* Do not make direct changes to the file.
|
4031
5474
|
*/
|
4032
5475
|
interface paths$6 {
|
4033
|
-
"/api/v1/
|
5476
|
+
"/api/v1/prompt": {
|
4034
5477
|
get: {
|
4035
5478
|
parameters: {
|
4036
5479
|
query: {
|
5480
|
+
promptId: string;
|
4037
5481
|
projectId: string;
|
4038
5482
|
};
|
4039
5483
|
};
|
4040
5484
|
responses: {
|
4041
|
-
/**
|
4042
|
-
* Gets a list of data sources.
|
4043
|
-
* Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
|
4044
|
-
* requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
|
4045
|
-
* user, and fetch using the `data-source` endpoint for each data source.
|
4046
|
-
*/
|
5485
|
+
/** OK */
|
4047
5486
|
200: {
|
4048
5487
|
content: {
|
4049
5488
|
"application/json": {
|
4050
|
-
|
5489
|
+
result: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
|
4051
5490
|
};
|
4052
5491
|
};
|
4053
5492
|
};
|
@@ -4058,6 +5497,47 @@ interface paths$6 {
|
|
4058
5497
|
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4059
5498
|
};
|
4060
5499
|
};
|
5500
|
+
put: {
|
5501
|
+
responses: {
|
5502
|
+
/** OK */
|
5503
|
+
204: never;
|
5504
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
5505
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
5506
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
5507
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
5508
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5509
|
+
};
|
5510
|
+
requestBody: {
|
5511
|
+
content: {
|
5512
|
+
"application/json": {
|
5513
|
+
data: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
|
5514
|
+
/** Format: uuid */
|
5515
|
+
projectId: string;
|
5516
|
+
};
|
5517
|
+
};
|
5518
|
+
};
|
5519
|
+
};
|
5520
|
+
delete: {
|
5521
|
+
responses: {
|
5522
|
+
/** OK */
|
5523
|
+
204: never;
|
5524
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
5525
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
5526
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
5527
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
5528
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5529
|
+
};
|
5530
|
+
requestBody: {
|
5531
|
+
content: {
|
5532
|
+
"application/json": {
|
5533
|
+
/** Format: uuid */
|
5534
|
+
projectId: string;
|
5535
|
+
/** Format: uuid */
|
5536
|
+
promptId: string;
|
5537
|
+
};
|
5538
|
+
};
|
5539
|
+
};
|
5540
|
+
};
|
4061
5541
|
};
|
4062
5542
|
}
|
4063
5543
|
interface external$7 {
|
@@ -4270,26 +5750,26 @@ interface external$7 {
|
|
4270
5750
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
4271
5751
|
fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
4272
5752
|
/**
|
4273
|
-
*
|
4274
|
-
* @description Reference to the category this component definition belongs to
|
4275
|
-
* @default null
|
4276
|
-
*/
|
4277
|
-
categoryId?: string | null;
|
4278
|
-
/**
|
4279
|
-
* @description Description of the component definition
|
5753
|
+
* @description Description of the content type
|
4280
5754
|
* @default null
|
4281
5755
|
*/
|
4282
5756
|
description?: string;
|
4283
5757
|
/**
|
4284
|
-
* @description
|
4285
|
-
* @default
|
5758
|
+
* @description Icon name for the content type (e.g. 'screen')
|
5759
|
+
* @default file-document
|
4286
5760
|
*/
|
4287
|
-
|
5761
|
+
icon?: string;
|
4288
5762
|
/** @description Created date string for this content type (ignored for writes) */
|
4289
5763
|
created?: string;
|
4290
5764
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4291
5765
|
updated?: string;
|
4292
5766
|
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
5767
|
+
/**
|
5768
|
+
* @description The definition type of this content type (block or content type)
|
5769
|
+
* @default contentType
|
5770
|
+
* @enum {string}
|
5771
|
+
*/
|
5772
|
+
type?: "contentType" | "block";
|
4293
5773
|
};
|
4294
5774
|
/** @description Defines an editable parameter on a component. */
|
4295
5775
|
ComponentParameter: {
|
@@ -4508,15 +5988,8 @@ interface external$7 {
|
|
4508
5988
|
allowedOnComponents?: string[];
|
4509
5989
|
/** @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. */
|
4510
5990
|
path: string;
|
4511
|
-
/** @description Time-to-live (in seconds) for the
|
5991
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
4512
5992
|
ttl?: number;
|
4513
|
-
/** @description Long term data resource cache configuration. */
|
4514
|
-
longTermCache?: {
|
4515
|
-
/** @description A flag to turn the long term cache on. */
|
4516
|
-
enabled: boolean;
|
4517
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
4518
|
-
ttlInHours?: number;
|
4519
|
-
};
|
4520
5993
|
/** @description A key for the resource data cache purging. */
|
4521
5994
|
purgeKey?: string;
|
4522
5995
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -4626,6 +6099,26 @@ interface external$7 {
|
|
4626
6099
|
*/
|
4627
6100
|
projectMapId: string;
|
4628
6101
|
};
|
6102
|
+
/** @description AI Prompt definition. */
|
6103
|
+
Prompt: {
|
6104
|
+
/**
|
6105
|
+
* Format: uuid
|
6106
|
+
* @description Unique identifier for the prompt
|
6107
|
+
*/
|
6108
|
+
id: string;
|
6109
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
6110
|
+
integrationType: string;
|
6111
|
+
/** @description Name for the prompt */
|
6112
|
+
promptName?: string | null;
|
6113
|
+
/** @description Text for the prompt */
|
6114
|
+
promptText?: string | null;
|
6115
|
+
/** @description Data for the prompt */
|
6116
|
+
promptData?: string | null;
|
6117
|
+
/** @description Turn off/on prompt */
|
6118
|
+
enabled?: boolean | null;
|
6119
|
+
/** @description Integration default prompt */
|
6120
|
+
builtIn?: boolean | null;
|
6121
|
+
};
|
4629
6122
|
};
|
4630
6123
|
};
|
4631
6124
|
operations: {};
|
@@ -4637,7 +6130,7 @@ interface external$7 {
|
|
4637
6130
|
* Do not make direct changes to the file.
|
4638
6131
|
*/
|
4639
6132
|
interface paths$5 {
|
4640
|
-
"/api/v1/
|
6133
|
+
"/api/v1/prompts": {
|
4641
6134
|
get: {
|
4642
6135
|
parameters: {
|
4643
6136
|
query: {
|
@@ -4645,11 +6138,11 @@ interface paths$5 {
|
|
4645
6138
|
};
|
4646
6139
|
};
|
4647
6140
|
responses: {
|
4648
|
-
/**
|
6141
|
+
/** Gets a list of prompts. */
|
4649
6142
|
200: {
|
4650
6143
|
content: {
|
4651
6144
|
"application/json": {
|
4652
|
-
results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
6145
|
+
results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"][];
|
4653
6146
|
};
|
4654
6147
|
};
|
4655
6148
|
};
|
@@ -4660,46 +6153,6 @@ interface paths$5 {
|
|
4660
6153
|
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4661
6154
|
};
|
4662
6155
|
};
|
4663
|
-
put: {
|
4664
|
-
responses: {
|
4665
|
-
/** OK */
|
4666
|
-
204: never;
|
4667
|
-
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4668
|
-
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4669
|
-
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4670
|
-
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4671
|
-
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4672
|
-
};
|
4673
|
-
requestBody: {
|
4674
|
-
content: {
|
4675
|
-
"application/json": {
|
4676
|
-
data: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
4677
|
-
/** Format: uuid */
|
4678
|
-
projectId: string;
|
4679
|
-
};
|
4680
|
-
};
|
4681
|
-
};
|
4682
|
-
};
|
4683
|
-
delete: {
|
4684
|
-
responses: {
|
4685
|
-
/** OK */
|
4686
|
-
204: never;
|
4687
|
-
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4688
|
-
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4689
|
-
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4690
|
-
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4691
|
-
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4692
|
-
};
|
4693
|
-
requestBody: {
|
4694
|
-
content: {
|
4695
|
-
"application/json": {
|
4696
|
-
typeId: string;
|
4697
|
-
/** Format: uuid */
|
4698
|
-
projectId: string;
|
4699
|
-
};
|
4700
|
-
};
|
4701
|
-
};
|
4702
|
-
};
|
4703
6156
|
};
|
4704
6157
|
}
|
4705
6158
|
interface external$6 {
|
@@ -4912,26 +6365,26 @@ interface external$6 {
|
|
4912
6365
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
4913
6366
|
fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
4914
6367
|
/**
|
4915
|
-
*
|
4916
|
-
* @description Reference to the category this component definition belongs to
|
4917
|
-
* @default null
|
4918
|
-
*/
|
4919
|
-
categoryId?: string | null;
|
4920
|
-
/**
|
4921
|
-
* @description Description of the component definition
|
6368
|
+
* @description Description of the content type
|
4922
6369
|
* @default null
|
4923
6370
|
*/
|
4924
6371
|
description?: string;
|
4925
6372
|
/**
|
4926
|
-
* @description
|
4927
|
-
* @default
|
6373
|
+
* @description Icon name for the content type (e.g. 'screen')
|
6374
|
+
* @default file-document
|
4928
6375
|
*/
|
4929
|
-
|
6376
|
+
icon?: string;
|
4930
6377
|
/** @description Created date string for this content type (ignored for writes) */
|
4931
6378
|
created?: string;
|
4932
6379
|
/** @description Last modified date string for this content type (ignored for writes) */
|
4933
6380
|
updated?: string;
|
4934
6381
|
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
6382
|
+
/**
|
6383
|
+
* @description The definition type of this content type (block or content type)
|
6384
|
+
* @default contentType
|
6385
|
+
* @enum {string}
|
6386
|
+
*/
|
6387
|
+
type?: "contentType" | "block";
|
4935
6388
|
};
|
4936
6389
|
/** @description Defines an editable parameter on a component. */
|
4937
6390
|
ComponentParameter: {
|
@@ -5150,15 +6603,8 @@ interface external$6 {
|
|
5150
6603
|
allowedOnComponents?: string[];
|
5151
6604
|
/** @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. */
|
5152
6605
|
path: string;
|
5153
|
-
/** @description Time-to-live (in seconds) for the
|
6606
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
5154
6607
|
ttl?: number;
|
5155
|
-
/** @description Long term data resource cache configuration. */
|
5156
|
-
longTermCache?: {
|
5157
|
-
/** @description A flag to turn the long term cache on. */
|
5158
|
-
enabled: boolean;
|
5159
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
5160
|
-
ttlInHours?: number;
|
5161
|
-
};
|
5162
6608
|
/** @description A key for the resource data cache purging. */
|
5163
6609
|
purgeKey?: string;
|
5164
6610
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -5268,15 +6714,37 @@ interface external$6 {
|
|
5268
6714
|
*/
|
5269
6715
|
projectMapId: string;
|
5270
6716
|
};
|
6717
|
+
/** @description AI Prompt definition. */
|
6718
|
+
Prompt: {
|
6719
|
+
/**
|
6720
|
+
* Format: uuid
|
6721
|
+
* @description Unique identifier for the prompt
|
6722
|
+
*/
|
6723
|
+
id: string;
|
6724
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
6725
|
+
integrationType: string;
|
6726
|
+
/** @description Name for the prompt */
|
6727
|
+
promptName?: string | null;
|
6728
|
+
/** @description Text for the prompt */
|
6729
|
+
promptText?: string | null;
|
6730
|
+
/** @description Data for the prompt */
|
6731
|
+
promptData?: string | null;
|
6732
|
+
/** @description Turn off/on prompt */
|
6733
|
+
enabled?: boolean | null;
|
6734
|
+
/** @description Integration default prompt */
|
6735
|
+
builtIn?: boolean | null;
|
6736
|
+
};
|
5271
6737
|
};
|
5272
6738
|
};
|
5273
6739
|
operations: {};
|
5274
6740
|
};
|
5275
6741
|
}
|
5276
6742
|
|
5277
|
-
type
|
5278
|
-
type
|
5279
|
-
type
|
6743
|
+
type PromptApi = paths$6['/api/v1/prompt'];
|
6744
|
+
type PromptsApi = paths$5['/api/v1/prompts'];
|
6745
|
+
type DataTypeApi = paths$7['/api/v1/data-types'];
|
6746
|
+
type DataSourcesApi = paths$8['/api/v1/data-sources'];
|
6747
|
+
type DataSourceApi = paths$9['/api/v1/data-source'];
|
5280
6748
|
/** Query parameter options for GET /api/v1/data-types */
|
5281
6749
|
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
5282
6750
|
/** The GET response from /api/v1/data-types */
|
@@ -5297,9 +6765,22 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
5297
6765
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
5298
6766
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
5299
6767
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
6768
|
+
/** Query parameter options for GET /api/v1/prompt */
|
6769
|
+
type PromptGetParameters = PromptApi['get']['parameters']['query'];
|
6770
|
+
/** The GET response from /api/v1/prompt */
|
6771
|
+
type PromptGetResponse = PromptApi['get']['responses']['200']['content']['application/json'];
|
6772
|
+
/** The PUT request body for /api/v1/prompt */
|
6773
|
+
type PromptPutParameters = PromptApi['put']['requestBody']['content']['application/json'];
|
6774
|
+
/** Shape of the DELETE request body for /api/v1/prompt */
|
6775
|
+
type PromptDeleteParameters = PromptApi['delete']['requestBody']['content']['application/json'];
|
6776
|
+
/** Query parameter options for GET /api/v1/prompts */
|
6777
|
+
type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
|
6778
|
+
/** The GET response from /api/v1/prompts */
|
6779
|
+
type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
|
5300
6780
|
type DataType = components$5['schemas']['DataType'];
|
5301
6781
|
type DataSource = components$5['schemas']['DataSource'];
|
5302
6782
|
type DataVariableDefinition = components$5['schemas']['DataVariableDefinition'];
|
6783
|
+
type Prompt = components$5['schemas']['Prompt'];
|
5303
6784
|
|
5304
6785
|
/**
|
5305
6786
|
* This file was auto-generated by openapi-typescript.
|
@@ -5577,7 +7058,7 @@ interface components$3 {
|
|
5577
7058
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
5578
7059
|
* @enum {string}
|
5579
7060
|
*/
|
5580
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
7061
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
|
5581
7062
|
/**
|
5582
7063
|
* Format: uuid
|
5583
7064
|
* @description The project ID that this layout data is part of
|
@@ -5983,26 +7464,26 @@ interface external$5 {
|
|
5983
7464
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
5984
7465
|
fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
5985
7466
|
/**
|
5986
|
-
*
|
5987
|
-
* @description Reference to the category this component definition belongs to
|
5988
|
-
* @default null
|
5989
|
-
*/
|
5990
|
-
categoryId?: string | null;
|
5991
|
-
/**
|
5992
|
-
* @description Description of the component definition
|
7467
|
+
* @description Description of the content type
|
5993
7468
|
* @default null
|
5994
7469
|
*/
|
5995
7470
|
description?: string;
|
5996
7471
|
/**
|
5997
|
-
* @description
|
5998
|
-
* @default
|
7472
|
+
* @description Icon name for the content type (e.g. 'screen')
|
7473
|
+
* @default file-document
|
5999
7474
|
*/
|
6000
|
-
|
7475
|
+
icon?: string;
|
6001
7476
|
/** @description Created date string for this content type (ignored for writes) */
|
6002
7477
|
created?: string;
|
6003
7478
|
/** @description Last modified date string for this content type (ignored for writes) */
|
6004
7479
|
updated?: string;
|
6005
7480
|
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
7481
|
+
/**
|
7482
|
+
* @description The definition type of this content type (block or content type)
|
7483
|
+
* @default contentType
|
7484
|
+
* @enum {string}
|
7485
|
+
*/
|
7486
|
+
type?: "contentType" | "block";
|
6006
7487
|
};
|
6007
7488
|
/** @description Defines an editable parameter on a component. */
|
6008
7489
|
ComponentParameter: {
|
@@ -6221,15 +7702,8 @@ interface external$5 {
|
|
6221
7702
|
allowedOnComponents?: string[];
|
6222
7703
|
/** @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. */
|
6223
7704
|
path: string;
|
6224
|
-
/** @description Time-to-live (in seconds) for the
|
7705
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
6225
7706
|
ttl?: number;
|
6226
|
-
/** @description Long term data resource cache configuration. */
|
6227
|
-
longTermCache?: {
|
6228
|
-
/** @description A flag to turn the long term cache on. */
|
6229
|
-
enabled: boolean;
|
6230
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
6231
|
-
ttlInHours?: number;
|
6232
|
-
};
|
6233
7707
|
/** @description A key for the resource data cache purging. */
|
6234
7708
|
purgeKey?: string;
|
6235
7709
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -6339,6 +7813,26 @@ interface external$5 {
|
|
6339
7813
|
*/
|
6340
7814
|
projectMapId: string;
|
6341
7815
|
};
|
7816
|
+
/** @description AI Prompt definition. */
|
7817
|
+
Prompt: {
|
7818
|
+
/**
|
7819
|
+
* Format: uuid
|
7820
|
+
* @description Unique identifier for the prompt
|
7821
|
+
*/
|
7822
|
+
id: string;
|
7823
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
7824
|
+
integrationType: string;
|
7825
|
+
/** @description Name for the prompt */
|
7826
|
+
promptName?: string | null;
|
7827
|
+
/** @description Text for the prompt */
|
7828
|
+
promptText?: string | null;
|
7829
|
+
/** @description Data for the prompt */
|
7830
|
+
promptData?: string | null;
|
7831
|
+
/** @description Turn off/on prompt */
|
7832
|
+
enabled?: boolean | null;
|
7833
|
+
/** @description Integration default prompt */
|
7834
|
+
builtIn?: boolean | null;
|
7835
|
+
};
|
6342
7836
|
};
|
6343
7837
|
};
|
6344
7838
|
operations: {};
|
@@ -6831,26 +8325,26 @@ interface external$3 {
|
|
6831
8325
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
6832
8326
|
fields?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
6833
8327
|
/**
|
6834
|
-
*
|
6835
|
-
* @description Reference to the category this component definition belongs to
|
6836
|
-
* @default null
|
6837
|
-
*/
|
6838
|
-
categoryId?: string | null;
|
6839
|
-
/**
|
6840
|
-
* @description Description of the component definition
|
8328
|
+
* @description Description of the content type
|
6841
8329
|
* @default null
|
6842
8330
|
*/
|
6843
8331
|
description?: string;
|
6844
8332
|
/**
|
6845
|
-
* @description
|
6846
|
-
* @default
|
8333
|
+
* @description Icon name for the content type (e.g. 'screen')
|
8334
|
+
* @default file-document
|
6847
8335
|
*/
|
6848
|
-
|
8336
|
+
icon?: string;
|
6849
8337
|
/** @description Created date string for this content type (ignored for writes) */
|
6850
8338
|
created?: string;
|
6851
8339
|
/** @description Last modified date string for this content type (ignored for writes) */
|
6852
8340
|
updated?: string;
|
6853
8341
|
slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
8342
|
+
/**
|
8343
|
+
* @description The definition type of this content type (block or content type)
|
8344
|
+
* @default contentType
|
8345
|
+
* @enum {string}
|
8346
|
+
*/
|
8347
|
+
type?: "contentType" | "block";
|
6854
8348
|
};
|
6855
8349
|
/** @description Defines an editable parameter on a component. */
|
6856
8350
|
ComponentParameter: {
|
@@ -7069,15 +8563,8 @@ interface external$3 {
|
|
7069
8563
|
allowedOnComponents?: string[];
|
7070
8564
|
/** @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. */
|
7071
8565
|
path: string;
|
7072
|
-
/** @description Time-to-live (in seconds) for the
|
8566
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
7073
8567
|
ttl?: number;
|
7074
|
-
/** @description Long term data resource cache configuration. */
|
7075
|
-
longTermCache?: {
|
7076
|
-
/** @description A flag to turn the long term cache on. */
|
7077
|
-
enabled: boolean;
|
7078
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
7079
|
-
ttlInHours?: number;
|
7080
|
-
};
|
7081
8568
|
/** @description A key for the resource data cache purging. */
|
7082
8569
|
purgeKey?: string;
|
7083
8570
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -7187,6 +8674,26 @@ interface external$3 {
|
|
7187
8674
|
*/
|
7188
8675
|
projectMapId: string;
|
7189
8676
|
};
|
8677
|
+
/** @description AI Prompt definition. */
|
8678
|
+
Prompt: {
|
8679
|
+
/**
|
8680
|
+
* Format: uuid
|
8681
|
+
* @description Unique identifier for the prompt
|
8682
|
+
*/
|
8683
|
+
id: string;
|
8684
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
8685
|
+
integrationType: string;
|
8686
|
+
/** @description Name for the prompt */
|
8687
|
+
promptName?: string | null;
|
8688
|
+
/** @description Text for the prompt */
|
8689
|
+
promptText?: string | null;
|
8690
|
+
/** @description Data for the prompt */
|
8691
|
+
promptData?: string | null;
|
8692
|
+
/** @description Turn off/on prompt */
|
8693
|
+
enabled?: boolean | null;
|
8694
|
+
/** @description Integration default prompt */
|
8695
|
+
builtIn?: boolean | null;
|
8696
|
+
};
|
7190
8697
|
};
|
7191
8698
|
};
|
7192
8699
|
operations: {};
|
@@ -7464,7 +8971,7 @@ interface external$3 {
|
|
7464
8971
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
7465
8972
|
* @enum {string}
|
7466
8973
|
*/
|
7467
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
8974
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
|
7468
8975
|
/**
|
7469
8976
|
* Format: uuid
|
7470
8977
|
* @description The project ID that this layout data is part of
|
@@ -7703,6 +9210,13 @@ interface external$3 {
|
|
7703
9210
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7704
9211
|
*/
|
7705
9212
|
withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
9213
|
+
/**
|
9214
|
+
* If true the `_id` unique identifier of blocks will be part of the response data.
|
9215
|
+
* If false, the `_id` will not be present in the API response.
|
9216
|
+
*/
|
9217
|
+
withComponentIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
9218
|
+
/** Performs keyword search on the entries. */
|
9219
|
+
keyword?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["keyword"];
|
7706
9220
|
};
|
7707
9221
|
};
|
7708
9222
|
responses: {
|
@@ -7807,7 +9321,7 @@ interface external$3 {
|
|
7807
9321
|
_id: string;
|
7808
9322
|
/** @description The name of the entry. */
|
7809
9323
|
_name?: string;
|
7810
|
-
/** @description The slug of the entry
|
9324
|
+
/** @description The slug of the entry. */
|
7811
9325
|
_slug?: string;
|
7812
9326
|
/** @description Name of the author of the most recent change. */
|
7813
9327
|
_author?: string;
|
@@ -7826,6 +9340,10 @@ interface external$3 {
|
|
7826
9340
|
* @description The public UUID of the entry.
|
7827
9341
|
*/
|
7828
9342
|
_id?: string;
|
9343
|
+
/** @description The name of the entry. */
|
9344
|
+
_name?: string;
|
9345
|
+
/** @description The slug of the entry. */
|
9346
|
+
_slug?: string;
|
7829
9347
|
/** @description Entry field values. */
|
7830
9348
|
fields?: {
|
7831
9349
|
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
@@ -7887,6 +9405,11 @@ interface external$3 {
|
|
7887
9405
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7888
9406
|
*/
|
7889
9407
|
withUIStatus: boolean;
|
9408
|
+
/**
|
9409
|
+
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
9410
|
+
* If false, the `_id` will not be present in the API response.
|
9411
|
+
*/
|
9412
|
+
withComponentIDs: boolean;
|
7890
9413
|
/**
|
7891
9414
|
* @deprecated
|
7892
9415
|
* @description Filters entries lists by the UI status of the entry.
|
@@ -7902,6 +9425,8 @@ interface external$3 {
|
|
7902
9425
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
7903
9426
|
*/
|
7904
9427
|
withTotalCount: boolean;
|
9428
|
+
/** @description Performs keyword search on the entries. */
|
9429
|
+
keyword: string;
|
7905
9430
|
};
|
7906
9431
|
};
|
7907
9432
|
operations: {};
|
@@ -8603,26 +10128,26 @@ interface external$2 {
|
|
8603
10128
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
8604
10129
|
fields?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
8605
10130
|
/**
|
8606
|
-
*
|
8607
|
-
* @description Reference to the category this component definition belongs to
|
8608
|
-
* @default null
|
8609
|
-
*/
|
8610
|
-
categoryId?: string | null;
|
8611
|
-
/**
|
8612
|
-
* @description Description of the component definition
|
10131
|
+
* @description Description of the content type
|
8613
10132
|
* @default null
|
8614
10133
|
*/
|
8615
10134
|
description?: string;
|
8616
10135
|
/**
|
8617
|
-
* @description
|
8618
|
-
* @default
|
10136
|
+
* @description Icon name for the content type (e.g. 'screen')
|
10137
|
+
* @default file-document
|
8619
10138
|
*/
|
8620
|
-
|
10139
|
+
icon?: string;
|
8621
10140
|
/** @description Created date string for this content type (ignored for writes) */
|
8622
10141
|
created?: string;
|
8623
10142
|
/** @description Last modified date string for this content type (ignored for writes) */
|
8624
10143
|
updated?: string;
|
8625
10144
|
slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
10145
|
+
/**
|
10146
|
+
* @description The definition type of this content type (block or content type)
|
10147
|
+
* @default contentType
|
10148
|
+
* @enum {string}
|
10149
|
+
*/
|
10150
|
+
type?: "contentType" | "block";
|
8626
10151
|
};
|
8627
10152
|
/** @description Defines an editable parameter on a component. */
|
8628
10153
|
ComponentParameter: {
|
@@ -8841,15 +10366,8 @@ interface external$2 {
|
|
8841
10366
|
allowedOnComponents?: string[];
|
8842
10367
|
/** @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. */
|
8843
10368
|
path: string;
|
8844
|
-
/** @description Time-to-live (in seconds) for the
|
10369
|
+
/** @description Time-to-live (in seconds) for the resource data cache. */
|
8845
10370
|
ttl?: number;
|
8846
|
-
/** @description Long term data resource cache configuration. */
|
8847
|
-
longTermCache?: {
|
8848
|
-
/** @description A flag to turn the long term cache on. */
|
8849
|
-
enabled: boolean;
|
8850
|
-
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
8851
|
-
ttlInHours?: number;
|
8852
|
-
};
|
8853
10371
|
/** @description A key for the resource data cache purging. */
|
8854
10372
|
purgeKey?: string;
|
8855
10373
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
@@ -8959,6 +10477,26 @@ interface external$2 {
|
|
8959
10477
|
*/
|
8960
10478
|
projectMapId: string;
|
8961
10479
|
};
|
10480
|
+
/** @description AI Prompt definition. */
|
10481
|
+
Prompt: {
|
10482
|
+
/**
|
10483
|
+
* Format: uuid
|
10484
|
+
* @description Unique identifier for the prompt
|
10485
|
+
*/
|
10486
|
+
id: string;
|
10487
|
+
/** @description Unique identifier for the integration that this prompt belongs to. */
|
10488
|
+
integrationType: string;
|
10489
|
+
/** @description Name for the prompt */
|
10490
|
+
promptName?: string | null;
|
10491
|
+
/** @description Text for the prompt */
|
10492
|
+
promptText?: string | null;
|
10493
|
+
/** @description Data for the prompt */
|
10494
|
+
promptData?: string | null;
|
10495
|
+
/** @description Turn off/on prompt */
|
10496
|
+
enabled?: boolean | null;
|
10497
|
+
/** @description Integration default prompt */
|
10498
|
+
builtIn?: boolean | null;
|
10499
|
+
};
|
8962
10500
|
};
|
8963
10501
|
};
|
8964
10502
|
operations: {};
|
@@ -9236,7 +10774,7 @@ interface external$2 {
|
|
9236
10774
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
9237
10775
|
* @enum {string}
|
9238
10776
|
*/
|
9239
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
10777
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
|
9240
10778
|
/**
|
9241
10779
|
* Format: uuid
|
9242
10780
|
* @description The project ID that this layout data is part of
|
@@ -9665,6 +11203,12 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
|
|
9665
11203
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
9666
11204
|
value: TValue;
|
9667
11205
|
};
|
11206
|
+
/** Parameter which stores blocks of entry types */
|
11207
|
+
type ComponentParameterBlock = Omit<ComponentParameter<BlockValue>, 'type'> & {
|
11208
|
+
type: typeof CANVAS_BLOCK_PARAM_TYPE;
|
11209
|
+
};
|
11210
|
+
/** Value type of a block parameter or block field */
|
11211
|
+
type BlockValue = EntryData[];
|
9668
11212
|
/** The type of the parameters in contextual editing mode. */
|
9669
11213
|
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
9670
11214
|
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
@@ -9721,6 +11265,7 @@ type CanvasDefinitions = {
|
|
9721
11265
|
categories?: Array<Category>;
|
9722
11266
|
contentTypes?: Array<ContentType>;
|
9723
11267
|
entries?: Array<Entry>;
|
11268
|
+
prompts?: Array<Prompt>;
|
9724
11269
|
};
|
9725
11270
|
/** Defines shared parameters for requests getting a single composition */
|
9726
11271
|
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
|
@@ -9808,7 +11353,7 @@ type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
|
|
9808
11353
|
type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
|
9809
11354
|
type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
|
9810
11355
|
/** The GET response from /api/v1/entries */
|
9811
|
-
type EntriesGetParameters = paths$
|
11356
|
+
type EntriesGetParameters = paths$a['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
9812
11357
|
type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
|
9813
11358
|
type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
|
9814
11359
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
@@ -9826,7 +11371,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
9826
11371
|
getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'>): Promise<{
|
9827
11372
|
compositions: {
|
9828
11373
|
state: number;
|
9829
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | undefined;
|
11374
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown" | undefined;
|
9830
11375
|
projectId: string;
|
9831
11376
|
created: string;
|
9832
11377
|
modified: string;
|
@@ -10153,7 +11698,7 @@ interface paths$1 {
|
|
10153
11698
|
id: string;
|
10154
11699
|
compositions?: {
|
10155
11700
|
/** @enum {string} */
|
10156
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
11701
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Unknown" | "Previous";
|
10157
11702
|
composition: {
|
10158
11703
|
_id: string;
|
10159
11704
|
_name: string;
|
@@ -10385,15 +11930,25 @@ type PreviewPanelSettings = {
|
|
10385
11930
|
isInteractive: boolean;
|
10386
11931
|
};
|
10387
11932
|
type ContextualEditingComponentReference = {
|
10388
|
-
elements: HTMLElement[];
|
10389
11933
|
id: string;
|
10390
|
-
|
10391
|
-
|
10392
|
-
|
10393
|
-
|
10394
|
-
|
11934
|
+
icon?: string;
|
11935
|
+
type?: string;
|
11936
|
+
title?: string;
|
11937
|
+
name?: string;
|
11938
|
+
parameters?: Record<string, {
|
11939
|
+
id: string;
|
11940
|
+
type: string;
|
11941
|
+
name?: string;
|
11942
|
+
isReadOnly?: boolean;
|
11943
|
+
}>;
|
10395
11944
|
parentId?: string;
|
10396
11945
|
parentType?: string;
|
11946
|
+
parentSlot?: {
|
11947
|
+
id?: string;
|
11948
|
+
componentIndex?: number;
|
11949
|
+
totalComponents?: number;
|
11950
|
+
};
|
11951
|
+
childIdsBySlot?: Record<string, string[]>;
|
10397
11952
|
isLocalized?: boolean;
|
10398
11953
|
isReadOnly?: boolean | undefined;
|
10399
11954
|
};
|
@@ -10753,6 +12308,105 @@ declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ c
|
|
10753
12308
|
onErrors?: (errors: EnhancerError[]) => void;
|
10754
12309
|
}): Promise<void>;
|
10755
12310
|
|
12311
|
+
/** @deprecated use walkNodeTree */
|
12312
|
+
type ComponentLocationReference = {
|
12313
|
+
component: ComponentInstance;
|
12314
|
+
parentSlot?: string;
|
12315
|
+
parentSlotIndex?: number;
|
12316
|
+
};
|
12317
|
+
/** @deprecated use walkNodeTree and check for type = slot */
|
12318
|
+
type WalkComponentTreeActions<TContext> = {
|
12319
|
+
/** Replaces the component being visited with a new object */
|
12320
|
+
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
12321
|
+
/** Removes the component being visited from the composition */
|
12322
|
+
removeComponent: () => void;
|
12323
|
+
/** Inserts a new component immediately after the current component in its parent slot */
|
12324
|
+
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
12325
|
+
/** Aborts visitation of components that are in child slots of the current component */
|
12326
|
+
stopProcessingDescendants: () => void;
|
12327
|
+
/**
|
12328
|
+
* Set a new traversal context for descendants of this node.
|
12329
|
+
* If this is not called, `context` will automatically pass through.
|
12330
|
+
*/
|
12331
|
+
setDescendantsContext: (context: TContext) => void;
|
12332
|
+
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
12333
|
+
};
|
12334
|
+
/**
|
12335
|
+
* Walks a composition's component tree, visiting each component instance depth-first, in order.
|
12336
|
+
* @deprecated use walkNodeTree
|
12337
|
+
*/
|
12338
|
+
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
12339
|
+
/** Traversal context for this node */
|
12340
|
+
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
12341
|
+
|
12342
|
+
/** Ancestor location that is in a slot on a component */
|
12343
|
+
type ComponentLocationReferenceV2 = {
|
12344
|
+
type: 'slot';
|
12345
|
+
node: ComponentInstance;
|
12346
|
+
parentSlot: string;
|
12347
|
+
parentSlotIndex: number;
|
12348
|
+
};
|
12349
|
+
/** Ancestor location that is in a block on a parameter or field */
|
12350
|
+
type BlockLocationReference = {
|
12351
|
+
type: 'block';
|
12352
|
+
node: EntryData;
|
12353
|
+
fieldName: string;
|
12354
|
+
blockIndex: number;
|
12355
|
+
};
|
12356
|
+
/** Ancestor location that is the root of a composition or entry */
|
12357
|
+
type RootLocationReference = {
|
12358
|
+
type: 'root';
|
12359
|
+
node: ComponentInstance;
|
12360
|
+
};
|
12361
|
+
type NodeLocationReference = ComponentLocationReferenceV2 | BlockLocationReference | RootLocationReference;
|
12362
|
+
type WalkNodeTreeActions<TContext, TNodeType> = {
|
12363
|
+
/** Replaces the node being visited with a new object */
|
12364
|
+
replace: (replacement: TNodeType) => void;
|
12365
|
+
/** Removes the node being visited from the composition */
|
12366
|
+
remove: () => void;
|
12367
|
+
/** Inserts a new node immediately after the current node in its parent slot */
|
12368
|
+
insertAfter: (components: TNodeType | TNodeType[]) => void;
|
12369
|
+
/** Aborts visitation of nodes that are descendants of the current node */
|
12370
|
+
stopProcessingDescendants: () => void;
|
12371
|
+
/**
|
12372
|
+
* Set a new traversal context for descendants of this node.
|
12373
|
+
* If this is not called, `context` will automatically pass through.
|
12374
|
+
*/
|
12375
|
+
setDescendantsContext: (context: TContext) => void;
|
12376
|
+
/** Sets a traversal context for a specific child (and any descendants) of this node. */
|
12377
|
+
setChildContext: (child: TNodeType, context: TContext) => void;
|
12378
|
+
};
|
12379
|
+
type NodeTypes = 'entry' | 'component';
|
12380
|
+
type TreeNodeInfo<TType extends NodeTypes, TContext, TNodeType> = {
|
12381
|
+
/** Type of node being visited */
|
12382
|
+
type: TType;
|
12383
|
+
/** The node being visited */
|
12384
|
+
node: TNodeType;
|
12385
|
+
/** The current node and its ancestors. The current node is [0], the parent [1], etc */
|
12386
|
+
ancestorsAndSelf: Array<NodeLocationReference>;
|
12387
|
+
/** Actions you can take on this node or the traversal of additional nodes */
|
12388
|
+
actions: WalkNodeTreeActions<TContext, TNodeType>;
|
12389
|
+
/** Traversal context for this node */
|
12390
|
+
context: TContext | undefined;
|
12391
|
+
};
|
12392
|
+
type TreeNodeInfoTypes<TContext> = TreeNodeInfo<'component', TContext, ComponentInstance> | TreeNodeInfo<'entry', TContext, EntryData>;
|
12393
|
+
type WalkNodeTreeOptions<TContext> = {
|
12394
|
+
/**
|
12395
|
+
* The initial value of the node-walk context, an arbitrary object that is passed to all visitor calls.
|
12396
|
+
* The visitor can use an action to change this value for descendants of the current node.
|
12397
|
+
*/
|
12398
|
+
initialContext?: TContext;
|
12399
|
+
};
|
12400
|
+
/** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
|
12401
|
+
declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
|
12402
|
+
/** Gets the typed value of a block parameter or block field */
|
12403
|
+
declare function getBlockValue(component: ComponentInstance | EntryData, parameterName: string): BlockValue;
|
12404
|
+
|
12405
|
+
/** Returns the JSON pointer of a component based on its location */
|
12406
|
+
declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference | ComponentLocationReference>): string;
|
12407
|
+
|
12408
|
+
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference | NodeLocationReference>): string;
|
12409
|
+
|
10756
12410
|
declare function extractLocales({ component }: {
|
10757
12411
|
component: ComponentInstance;
|
10758
12412
|
}): Record<string, ComponentInstance[]>;
|
@@ -10781,37 +12435,6 @@ declare class UniqueBatchEntries<TArgs, TResult> {
|
|
10781
12435
|
resolveRemaining(value: TResult): void;
|
10782
12436
|
}
|
10783
12437
|
|
10784
|
-
type ComponentLocationReference = {
|
10785
|
-
component: ComponentInstance;
|
10786
|
-
parentSlot?: string;
|
10787
|
-
parentSlotIndex?: number;
|
10788
|
-
};
|
10789
|
-
type WalkComponentTreeActions<TContext> = {
|
10790
|
-
/** Replaces the component being visited with a new object */
|
10791
|
-
replaceComponent: (replacementComponent: ComponentInstance) => void;
|
10792
|
-
/** Removes the component being visited from the composition */
|
10793
|
-
removeComponent: () => void;
|
10794
|
-
/** Inserts a new component immediately after the current component in its parent slot */
|
10795
|
-
insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
|
10796
|
-
/** Aborts visitation of components that are in child slots of the current component */
|
10797
|
-
stopProcessingDescendants: () => void;
|
10798
|
-
/**
|
10799
|
-
* Set a new traversal context for descendants of this node.
|
10800
|
-
* If this is not called, `context` will automatically pass through.
|
10801
|
-
*/
|
10802
|
-
setDescendantsContext: (context: TContext) => void;
|
10803
|
-
setChildContext: (child: ComponentInstance, context: TContext) => void;
|
10804
|
-
};
|
10805
|
-
/** Walks a composition's component tree, visiting each component instance depth-first, in order. */
|
10806
|
-
declare function walkComponentTree<TContext = unknown>(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions<TContext>,
|
10807
|
-
/** Traversal context for this node */
|
10808
|
-
currentContext: TContext | undefined) => void, initialContext?: TContext): void;
|
10809
|
-
declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
|
10810
|
-
/** Returns the JSON pointer of a component based on its location */
|
10811
|
-
declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocationReference>, { withSlots }?: {
|
10812
|
-
withSlots?: boolean | undefined;
|
10813
|
-
}): string;
|
10814
|
-
|
10815
12438
|
interface ContextualEditingWindowData {
|
10816
12439
|
framework?: ReadyMessage['framework'];
|
10817
12440
|
version?: ReadyMessage['version'];
|
@@ -10827,8 +12450,8 @@ type SelectComponentMessage = {
|
|
10827
12450
|
};
|
10828
12451
|
type SelectParameterMessage = {
|
10829
12452
|
type: 'select-parameter';
|
10830
|
-
parameterId
|
10831
|
-
componentId
|
12453
|
+
parameterId?: string;
|
12454
|
+
componentId?: string;
|
10832
12455
|
};
|
10833
12456
|
type ReadyMessage = {
|
10834
12457
|
type: 'ready';
|
@@ -10836,6 +12459,15 @@ type ReadyMessage = {
|
|
10836
12459
|
/** A non-semantic version of the contextual editing SDK. */
|
10837
12460
|
version?: number;
|
10838
12461
|
};
|
12462
|
+
type TriggerComponentActionMessage = {
|
12463
|
+
type: 'trigger-component-action';
|
12464
|
+
actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
|
12465
|
+
componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
|
12466
|
+
};
|
12467
|
+
type UpdateComponentReferencesMessage = {
|
12468
|
+
type: 'update-component-references';
|
12469
|
+
referencesById: Record<string, ContextualEditingComponentReference>;
|
12470
|
+
};
|
10839
12471
|
type UpdateCompositionMessage = {
|
10840
12472
|
type: 'update-composition';
|
10841
12473
|
composition: RootComponentInstance;
|
@@ -10859,6 +12491,11 @@ type MoveComponentMessage = {
|
|
10859
12491
|
index: number;
|
10860
12492
|
direction: 'up' | 'down';
|
10861
12493
|
};
|
12494
|
+
type OpenParameterEditorMessage = {
|
12495
|
+
type: 'open-parameter-editor';
|
12496
|
+
componentId: string;
|
12497
|
+
parameterId: string;
|
12498
|
+
};
|
10862
12499
|
type UpdateComponentParameterMessage = {
|
10863
12500
|
type: 'update-component-parameter';
|
10864
12501
|
componentId: string;
|
@@ -10878,10 +12515,25 @@ type UpdatePreviewSettingsMessage = {
|
|
10878
12515
|
type: 'update-preview-settings';
|
10879
12516
|
settings: PreviewPanelSettings;
|
10880
12517
|
};
|
12518
|
+
type UpdateFeatureFlagsMessage = {
|
12519
|
+
type: 'update-feature-flags';
|
12520
|
+
featureFlags: Record<string, boolean>;
|
12521
|
+
};
|
10881
12522
|
type UpdateContextualEditingStateInternalMessage = {
|
10882
12523
|
type: 'update-contextual-editing-state-internal';
|
10883
12524
|
state: {
|
10884
|
-
selectedComponentReference?:
|
12525
|
+
selectedComponentReference?: {
|
12526
|
+
id: string;
|
12527
|
+
slotName?: string;
|
12528
|
+
componentIndex?: number;
|
12529
|
+
totalComponents?: number;
|
12530
|
+
componentName?: string;
|
12531
|
+
componentTitle?: string;
|
12532
|
+
parentId?: string;
|
12533
|
+
parentType?: string;
|
12534
|
+
isLocalized?: boolean;
|
12535
|
+
isReadOnly?: boolean | undefined;
|
12536
|
+
};
|
10885
12537
|
};
|
10886
12538
|
};
|
10887
12539
|
type ReportRenderedCompositionsMessage = {
|
@@ -10892,9 +12544,10 @@ type ReportRenderedCompositionsMessage = {
|
|
10892
12544
|
type EditorStateUpdatedMessage = {
|
10893
12545
|
type: 'editor-state-updated';
|
10894
12546
|
};
|
10895
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
|
12547
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | UpdateFeatureFlagsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
|
10896
12548
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
10897
12549
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
12550
|
+
declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
|
10898
12551
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
10899
12552
|
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
10900
12553
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
@@ -10903,16 +12556,21 @@ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => me
|
|
10903
12556
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
10904
12557
|
declare const isTriggerCompositionActionMessage: (message: ChannelMessage) => message is TriggerCompositionActionMessage;
|
10905
12558
|
declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
|
12559
|
+
declare const isUpdateFeatureFlagsMessage: (message: ChannelMessage) => message is UpdateFeatureFlagsMessage;
|
10906
12560
|
declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
|
10907
12561
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
10908
12562
|
declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
|
12563
|
+
declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
|
12564
|
+
declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
|
10909
12565
|
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
10910
12566
|
type Channel = {
|
10911
12567
|
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
10912
12568
|
ready: () => void;
|
10913
12569
|
destroy: () => void;
|
12570
|
+
triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
|
10914
12571
|
selectComponent: (id: string) => void;
|
10915
12572
|
selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
|
12573
|
+
openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
|
10916
12574
|
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
10917
12575
|
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
10918
12576
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
@@ -10921,8 +12579,10 @@ type Channel = {
|
|
10921
12579
|
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
10922
12580
|
triggerCompositionAction: (options: Omit<TriggerCompositionActionMessage, 'type'>) => void;
|
10923
12581
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
12582
|
+
updateFeatureFlags: (options: Omit<UpdateFeatureFlagsMessage, 'type'>) => void;
|
10924
12583
|
updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
|
10925
12584
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
12585
|
+
updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
|
10926
12586
|
editorStateUpdated: () => void;
|
10927
12587
|
};
|
10928
12588
|
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
@@ -10971,6 +12631,39 @@ type UnsubscribeCallback = () => void;
|
|
10971
12631
|
/** Subscribes to a composition event */
|
10972
12632
|
declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { subscribe }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;
|
10973
12633
|
|
12634
|
+
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
12635
|
+
declare class PromptClient extends ApiClient {
|
12636
|
+
constructor(options: ClientOptions);
|
12637
|
+
/** Fetches all Prompts for a project */
|
12638
|
+
get(options?: ExceptProject<PromptGetParameters>): Promise<{
|
12639
|
+
result: {
|
12640
|
+
id: string;
|
12641
|
+
integrationType: string;
|
12642
|
+
promptName?: string | null | undefined;
|
12643
|
+
promptText?: string | null | undefined;
|
12644
|
+
promptData?: string | null | undefined;
|
12645
|
+
enabled?: boolean | null | undefined;
|
12646
|
+
builtIn?: boolean | null | undefined;
|
12647
|
+
};
|
12648
|
+
}>;
|
12649
|
+
/** Fetches all Prompts for a project */
|
12650
|
+
getList(options?: ExceptProject<PromptsGetParameters>): Promise<{
|
12651
|
+
results: {
|
12652
|
+
id: string;
|
12653
|
+
integrationType: string;
|
12654
|
+
promptName?: string | null | undefined;
|
12655
|
+
promptText?: string | null | undefined;
|
12656
|
+
promptData?: string | null | undefined;
|
12657
|
+
enabled?: boolean | null | undefined;
|
12658
|
+
builtIn?: boolean | null | undefined;
|
12659
|
+
}[];
|
12660
|
+
}>;
|
12661
|
+
/** Updates or creates (based on id) a Prompt */
|
12662
|
+
upsert(body: ExceptProject<PromptPutParameters>): Promise<void>;
|
12663
|
+
/** Deletes a Prompt */
|
12664
|
+
remove(body: ExceptProject<PromptDeleteParameters>): Promise<void>;
|
12665
|
+
}
|
12666
|
+
|
10974
12667
|
type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
|
10975
12668
|
edgeApiHost?: string;
|
10976
12669
|
};
|
@@ -10987,74 +12680,6 @@ declare class RouteClient extends ApiClient<RouteClientOptions> {
|
|
10987
12680
|
getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
|
10988
12681
|
}
|
10989
12682
|
|
10990
|
-
/** Public ID of Canvas personalization component type */
|
10991
|
-
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
10992
|
-
/** Public ID of Canvas A/B test component type */
|
10993
|
-
declare const CANVAS_TEST_TYPE = "$test";
|
10994
|
-
/** Public ID of Canvas localization component type */
|
10995
|
-
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
10996
|
-
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
10997
|
-
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
10998
|
-
/** Public ID of the locale parameter on Canvas components */
|
10999
|
-
declare const CANVAS_LOCALE_TAG_PARAM = "locale";
|
11000
|
-
/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
|
11001
|
-
declare const CANVAS_PERSONALIZE_SLOT = "pz";
|
11002
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
11003
|
-
declare const CANVAS_TEST_SLOT = "test";
|
11004
|
-
/** Name of the slot on CANVAS_TEST_TYPE */
|
11005
|
-
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
11006
|
-
/** Constant for a draft composition state. Subject to change. */
|
11007
|
-
declare const CANVAS_DRAFT_STATE = 0;
|
11008
|
-
/** Constant for a published composition state. Subject to change. */
|
11009
|
-
declare const CANVAS_PUBLISHED_STATE = 64;
|
11010
|
-
/** Constant for editor composition state. */
|
11011
|
-
declare const CANVAS_EDITOR_STATE = 63;
|
11012
|
-
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
11013
|
-
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
11014
|
-
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
11015
|
-
declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
11016
|
-
/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
|
11017
|
-
declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
11018
|
-
/** The name of the query string used to detect if we are in contextual editing mode */
|
11019
|
-
declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
|
11020
|
-
/** The name of the query string used to indicate that we want to use the playground for preview */
|
11021
|
-
declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
|
11022
|
-
/** The name of the query string used to get the config from the preview url */
|
11023
|
-
declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
|
11024
|
-
/** The value of "data-role" in the component start `<script>` tag */
|
11025
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
|
11026
|
-
/** The value of "data-role" in the component end `<script>` tag */
|
11027
|
-
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
11028
|
-
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
11029
|
-
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
11030
|
-
/**
|
11031
|
-
* The name of the attribute added to the elements rendered by Uniform.
|
11032
|
-
* Use to allow interacting with them by default in the preview panel
|
11033
|
-
*/
|
11034
|
-
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
11035
|
-
/** The ID we give to placeholder components */
|
11036
|
-
declare const PLACEHOLDER_ID = "placeholder";
|
11037
|
-
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
11038
|
-
declare const EMPTY_COMPOSITION: {
|
11039
|
-
_id: string;
|
11040
|
-
_name: string;
|
11041
|
-
type: string;
|
11042
|
-
};
|
11043
|
-
/** Minimal value for Edgehancers Cache TTL (in seconds) */
|
11044
|
-
declare const EDGE_MIN_CACHE_TTL = 15;
|
11045
|
-
/** Maximal value for Edgehancers Cache TTL (in seconds) */
|
11046
|
-
declare const EDGE_MAX_CACHE_TTL = 600;
|
11047
|
-
/** Default value for Edgehancers Cache TTL (in seconds) */
|
11048
|
-
declare const EDGE_DEFAULT_CACHE_TTL = 30;
|
11049
|
-
/** A value that indicates that Edgehancers caching is disabled */
|
11050
|
-
declare const EDGE_CACHE_DISABLED = -1;
|
11051
|
-
/** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
|
11052
|
-
declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
|
11053
|
-
/** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
|
11054
|
-
declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
|
11055
|
-
/** Default value for Edgehancers Long Term Cache TTL (in hours) */
|
11056
|
-
declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
11057
|
-
|
11058
12683
|
/**
|
11059
12684
|
* Creates an enhancer based on an API route.
|
11060
12685
|
* This is mainly used to create an enhancer for Contextual Editing, which can be passed to the `contextualEditingEnhancer` prop of `<UniformComposition />`.
|
@@ -11190,6 +12815,11 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
11190
12815
|
* Removes things like author, stats, etc.
|
11191
12816
|
*/
|
11192
12817
|
declare function convertEntryToPutEntry(entry: Entry): PutEntryBody;
|
12818
|
+
/**
|
12819
|
+
* Gets the object holding the properties (fields or parameters) of an entry or component instance
|
12820
|
+
* If no properties are defined, returns undefined.
|
12821
|
+
*/
|
12822
|
+
declare function getPropertiesValue(entity: Pick<ComponentInstance, 'parameters'> | Pick<EntryData, 'fields'>): ComponentInstance['parameters'];
|
11193
12823
|
|
11194
12824
|
declare const ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
|
11195
12825
|
declare const ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
|
@@ -11224,6 +12854,12 @@ declare const generateHash: ({ composition, secret, }: {
|
|
11224
12854
|
secret: string | undefined;
|
11225
12855
|
}) => number | undefined;
|
11226
12856
|
|
12857
|
+
/**
|
12858
|
+
* Checks if page is opened from inside Uniform Canvas Editor.
|
12859
|
+
* So if you open preview in incognito or via copy/paste link, it will return false.
|
12860
|
+
*/
|
12861
|
+
declare const isAllowedReferrer: (referrer: string | undefined) => boolean;
|
12862
|
+
|
11227
12863
|
/** Determines if a given Canvas component type is a system-defined type */
|
11228
12864
|
declare const isSystemComponentDefinition: (componentType: string) => boolean;
|
11229
12865
|
|
@@ -11240,7 +12876,7 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
|
|
11240
12876
|
declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
|
11241
12877
|
|
11242
12878
|
declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
|
11243
|
-
declare const generateComponentPlaceholderId: (randomId: string) => string;
|
12879
|
+
declare const generateComponentPlaceholderId: (randomId: string, sdkVersion: number | undefined) => string;
|
11244
12880
|
|
11245
12881
|
type BindVariablesResult<TValue> = {
|
11246
12882
|
/** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
|
@@ -11301,4 +12937,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
11301
12937
|
|
11302
12938
|
declare const CanvasClientError: typeof ApiClientError;
|
11303
12939
|
|
11304
|
-
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL,
|
12940
|
+
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, BlockLocationReference, BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentLocationReferenceV2, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterBlock, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EntryData, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NodeLocationReference, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, Prompt, PromptClient, PromptDeleteParameters, PromptGetParameters, PromptGetResponse, PromptPutParameters, PromptsGetParameters, PromptsGetResponse, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
|