@uniformdev/canvas 19.0.0 → 19.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +443 -191
- package/dist/index.esm.js +68 -4
- package/dist/index.js +72 -7
- package/dist/index.mjs +68 -4
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -462,7 +462,7 @@ interface components$2 {
|
|
462
462
|
* This file was auto-generated by openapi-typescript.
|
463
463
|
* Do not make direct changes to the file.
|
464
464
|
*/
|
465
|
-
interface paths$
|
465
|
+
interface paths$6 {
|
466
466
|
"/api/v1/canvas-definitions": {
|
467
467
|
get: {
|
468
468
|
parameters: {
|
@@ -485,15 +485,15 @@ interface paths$4 {
|
|
485
485
|
content: {
|
486
486
|
"application/json": {
|
487
487
|
/** @description Component definitions that match the query */
|
488
|
-
componentDefinitions: external$
|
488
|
+
componentDefinitions: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
489
489
|
};
|
490
490
|
};
|
491
491
|
};
|
492
|
-
400: external$
|
493
|
-
401: external$
|
494
|
-
403: external$
|
495
|
-
429: external$
|
496
|
-
500: external$
|
492
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
493
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
494
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
495
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
496
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
497
497
|
};
|
498
498
|
};
|
499
499
|
/** Upserts a component definition */
|
@@ -501,11 +501,11 @@ interface paths$4 {
|
|
501
501
|
responses: {
|
502
502
|
/** OK */
|
503
503
|
204: never;
|
504
|
-
400: external$
|
505
|
-
401: external$
|
506
|
-
403: external$
|
507
|
-
429: external$
|
508
|
-
500: external$
|
504
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
505
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
506
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
507
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
508
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
509
509
|
};
|
510
510
|
requestBody: {
|
511
511
|
content: {
|
@@ -515,7 +515,7 @@ interface paths$4 {
|
|
515
515
|
* @description The project ID to upsert the component definition to
|
516
516
|
*/
|
517
517
|
projectId: string;
|
518
|
-
componentDefinition: external$
|
518
|
+
componentDefinition: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
519
519
|
};
|
520
520
|
};
|
521
521
|
};
|
@@ -525,11 +525,11 @@ interface paths$4 {
|
|
525
525
|
responses: {
|
526
526
|
/** OK */
|
527
527
|
204: never;
|
528
|
-
400: external$
|
529
|
-
401: external$
|
530
|
-
403: external$
|
531
|
-
429: external$
|
532
|
-
500: external$
|
528
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
529
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
530
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
531
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
532
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
533
533
|
};
|
534
534
|
requestBody: {
|
535
535
|
content: {
|
@@ -554,7 +554,7 @@ interface paths$4 {
|
|
554
554
|
};
|
555
555
|
};
|
556
556
|
}
|
557
|
-
interface external$
|
557
|
+
interface external$7 {
|
558
558
|
"swagger.yml": {
|
559
559
|
paths: {};
|
560
560
|
components: {
|
@@ -568,25 +568,25 @@ interface external$5 {
|
|
568
568
|
/** Request input validation failed */
|
569
569
|
BadRequestError: {
|
570
570
|
content: {
|
571
|
-
"application/json": external$
|
571
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
572
572
|
};
|
573
573
|
};
|
574
574
|
/** API key or token was not valid */
|
575
575
|
UnauthorizedError: {
|
576
576
|
content: {
|
577
|
-
"application/json": external$
|
577
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
578
578
|
};
|
579
579
|
};
|
580
580
|
/** Permission was denied */
|
581
581
|
ForbiddenError: {
|
582
582
|
content: {
|
583
|
-
"application/json": external$
|
583
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
584
584
|
};
|
585
585
|
};
|
586
586
|
/** Resource not found */
|
587
587
|
NotFoundError: {
|
588
588
|
content: {
|
589
|
-
"application/json": external$
|
589
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
590
590
|
};
|
591
591
|
};
|
592
592
|
/** Too many requests in allowed time period */
|
@@ -605,7 +605,7 @@ interface external$5 {
|
|
605
605
|
PublicIdProperty: string;
|
606
606
|
/** @description The definition of a component parameter */
|
607
607
|
ComponentDefinitionParameter: {
|
608
|
-
id: external$
|
608
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
609
609
|
/** @description Friendly name of the parameter */
|
610
610
|
name: string;
|
611
611
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -617,7 +617,7 @@ interface external$5 {
|
|
617
617
|
};
|
618
618
|
/** @description The definition of a named component slot that can contain other components */
|
619
619
|
ComponentDefinitionSlot: {
|
620
|
-
id: external$
|
620
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
621
621
|
/** @description Friendly name of the slot */
|
622
622
|
name: string;
|
623
623
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -675,13 +675,13 @@ interface external$5 {
|
|
675
675
|
};
|
676
676
|
/** @description The definition of a component variant */
|
677
677
|
ComponentDefinitionVariant: {
|
678
|
-
id: external$
|
678
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
679
679
|
/** @description Friendly name of the variant */
|
680
680
|
name: string;
|
681
681
|
};
|
682
682
|
/** @description Permission set for a component defintion */
|
683
683
|
ComponentDefinitionPermission: {
|
684
|
-
roleId: external$
|
684
|
+
roleId: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
685
685
|
/**
|
686
686
|
* @description Permission type for this permission ComponentDefinition:
|
687
687
|
* read | write | create | delete
|
@@ -694,7 +694,7 @@ interface external$5 {
|
|
694
694
|
};
|
695
695
|
/** @description Defines a component type that can live on a Composition */
|
696
696
|
ComponentDefinition: {
|
697
|
-
id: external$
|
697
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
698
698
|
/** @description Friendly name of the component definition */
|
699
699
|
name: string;
|
700
700
|
/**
|
@@ -713,21 +713,21 @@ interface external$5 {
|
|
713
713
|
*/
|
714
714
|
canBeComposition?: boolean;
|
715
715
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
716
|
-
parameters?: external$
|
716
|
+
parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
717
717
|
/**
|
718
718
|
* @description if this component uses team permissions or custom permissions
|
719
719
|
* @default true
|
720
720
|
*/
|
721
721
|
useTeamPermissions?: boolean;
|
722
722
|
/** @description Custom role permissions for this component definition */
|
723
|
-
permissions?: external$
|
723
|
+
permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
724
724
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
725
|
-
slots?: external$
|
726
|
-
slugSettings?: external$
|
725
|
+
slots?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
726
|
+
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
727
727
|
/** @description Default component instance value */
|
728
|
-
defaults?: external$
|
728
|
+
defaults?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
729
729
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
730
|
-
variants?: external$
|
730
|
+
variants?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
731
731
|
/** @description Created date string for this definition (ignored for writes) */
|
732
732
|
created?: string;
|
733
733
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -739,7 +739,7 @@ interface external$5 {
|
|
739
739
|
value: unknown;
|
740
740
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
741
741
|
type: string;
|
742
|
-
connectedData?: external$
|
742
|
+
connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
743
743
|
};
|
744
744
|
/**
|
745
745
|
* @description Defines a connection to a data element on a data resource.
|
@@ -762,13 +762,13 @@ interface external$5 {
|
|
762
762
|
type: string;
|
763
763
|
/** @description Component parameter values for the component instance */
|
764
764
|
parameters?: {
|
765
|
-
[key: string]: external$
|
765
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
766
766
|
};
|
767
767
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
768
768
|
variant?: string;
|
769
769
|
/** @description Slots containing any child components */
|
770
770
|
slots?: {
|
771
|
-
[key: string]: external$
|
771
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
772
772
|
};
|
773
773
|
/**
|
774
774
|
* @description Unique identifier of the component within the composition.
|
@@ -778,13 +778,13 @@ interface external$5 {
|
|
778
778
|
_id?: string;
|
779
779
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
780
780
|
_pattern?: string;
|
781
|
-
_dataResources?: external$
|
781
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
782
782
|
/**
|
783
783
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
784
784
|
* Means nothing for PUTs; it will be ignored.
|
785
785
|
*/
|
786
786
|
_patternDataResources?: {
|
787
|
-
[key: string]: external$
|
787
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
788
788
|
};
|
789
789
|
/**
|
790
790
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -808,7 +808,7 @@ interface external$5 {
|
|
808
808
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
809
809
|
*/
|
810
810
|
_overrides?: {
|
811
|
-
[key: string]: external$
|
811
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
812
812
|
};
|
813
813
|
/**
|
814
814
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -817,7 +817,7 @@ interface external$5 {
|
|
817
817
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
818
818
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
819
819
|
*/
|
820
|
-
_overridability?: external$
|
820
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
821
821
|
};
|
822
822
|
/** @description Defines the shape of the root component in a composition */
|
823
823
|
RootComponentInstance: {
|
@@ -825,15 +825,15 @@ interface external$5 {
|
|
825
825
|
type: string;
|
826
826
|
/** @description Component parameter values for the component instance */
|
827
827
|
parameters?: {
|
828
|
-
[key: string]: external$
|
828
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
829
829
|
};
|
830
830
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
831
831
|
variant?: string;
|
832
832
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
833
|
-
projectMapNodes?: external$
|
833
|
+
projectMapNodes?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
834
834
|
/** @description Slots containing any child components */
|
835
835
|
slots?: {
|
836
|
-
[key: string]: external$
|
836
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
837
837
|
};
|
838
838
|
/** @description The public UUID of the composition. */
|
839
839
|
_id: string;
|
@@ -841,7 +841,7 @@ interface external$5 {
|
|
841
841
|
_slug?: string | null;
|
842
842
|
/** @description Friendly name of this component. */
|
843
843
|
_name: string;
|
844
|
-
_dataResources?: external$
|
844
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
845
845
|
/**
|
846
846
|
* @description Defines patch overrides to component IDs that live in the composition.
|
847
847
|
* This can be used to override parameters that are defined on patterns,
|
@@ -855,7 +855,7 @@ interface external$5 {
|
|
855
855
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
856
856
|
*/
|
857
857
|
_overrides?: {
|
858
|
-
[key: string]: external$
|
858
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
859
859
|
};
|
860
860
|
/**
|
861
861
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -864,7 +864,7 @@ interface external$5 {
|
|
864
864
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
865
865
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
866
866
|
*/
|
867
|
-
_overridability?: external$
|
867
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
868
868
|
};
|
869
869
|
/**
|
870
870
|
* @description Defines how to override a specific component.
|
@@ -874,7 +874,7 @@ interface external$5 {
|
|
874
874
|
*/
|
875
875
|
ComponentOverride: {
|
876
876
|
parameters?: {
|
877
|
-
[key: string]: external$
|
877
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
878
878
|
};
|
879
879
|
variant?: string;
|
880
880
|
};
|
@@ -888,7 +888,7 @@ interface external$5 {
|
|
888
888
|
ComponentOverridability: {
|
889
889
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
890
890
|
parameters?: {
|
891
|
-
[key: string]: external$
|
891
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
892
892
|
};
|
893
893
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
894
894
|
variants?: boolean;
|
@@ -929,7 +929,7 @@ interface external$5 {
|
|
929
929
|
}[];
|
930
930
|
/** @description Variables needed to make calls to the data source */
|
931
931
|
variables?: {
|
932
|
-
[key: string]: external$
|
932
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
933
933
|
};
|
934
934
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
935
935
|
custom?: {
|
@@ -986,7 +986,7 @@ interface external$5 {
|
|
986
986
|
method: "GET" | "POST" | "HEAD";
|
987
987
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
988
988
|
variables?: {
|
989
|
-
[key: string]: external$
|
989
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
990
990
|
};
|
991
991
|
/** @description Custom configuration specific to the data source being defined */
|
992
992
|
custom?: {
|
@@ -1014,7 +1014,7 @@ interface external$5 {
|
|
1014
1014
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1015
1015
|
*/
|
1016
1016
|
DataResourceDefinitions: {
|
1017
|
-
[key: string]: external$
|
1017
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1018
1018
|
};
|
1019
1019
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1020
1020
|
DataResourceDefinition: {
|
@@ -1028,7 +1028,7 @@ interface external$5 {
|
|
1028
1028
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1029
1029
|
*/
|
1030
1030
|
ignorePatternParameterDefault?: boolean;
|
1031
|
-
variables?: external$
|
1031
|
+
variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1032
1032
|
};
|
1033
1033
|
/** @description Variable values for a data resource. */
|
1034
1034
|
DataResourceVariables: {
|
@@ -1056,7 +1056,7 @@ interface external$5 {
|
|
1056
1056
|
}
|
1057
1057
|
|
1058
1058
|
type SharedComponents$1 = components$2['schemas'];
|
1059
|
-
type Api$1 = paths$
|
1059
|
+
type Api$1 = paths$6['/api/v1/canvas-definitions'];
|
1060
1060
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1061
1061
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1062
1062
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1084,7 +1084,7 @@ type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
|
1084
1084
|
* This file was auto-generated by openapi-typescript.
|
1085
1085
|
* Do not make direct changes to the file.
|
1086
1086
|
*/
|
1087
|
-
interface paths$
|
1087
|
+
interface paths$5 {
|
1088
1088
|
"/api/v1/canvas": {
|
1089
1089
|
get: {
|
1090
1090
|
parameters: {
|
@@ -1185,17 +1185,17 @@ interface paths$3 {
|
|
1185
1185
|
"application/json": components$1["schemas"]["CompositionListResponse"] | components$1["schemas"]["CompositionApiResponse"];
|
1186
1186
|
};
|
1187
1187
|
};
|
1188
|
-
400: external$
|
1189
|
-
401: external$
|
1190
|
-
403: external$
|
1188
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1189
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1190
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1191
1191
|
/** Composition not found */
|
1192
1192
|
404: {
|
1193
1193
|
content: {
|
1194
1194
|
"text/plain": string;
|
1195
1195
|
};
|
1196
1196
|
};
|
1197
|
-
429: external$
|
1198
|
-
500: external$
|
1197
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1198
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1199
1199
|
};
|
1200
1200
|
};
|
1201
1201
|
/** Upserts a composition */
|
@@ -1203,11 +1203,11 @@ interface paths$3 {
|
|
1203
1203
|
responses: {
|
1204
1204
|
/** OK */
|
1205
1205
|
204: never;
|
1206
|
-
400: external$
|
1207
|
-
401: external$
|
1208
|
-
403: external$
|
1209
|
-
429: external$
|
1210
|
-
500: external$
|
1206
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1207
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1208
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1209
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1210
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1211
1211
|
};
|
1212
1212
|
requestBody: {
|
1213
1213
|
content: {
|
@@ -1219,7 +1219,7 @@ interface paths$3 {
|
|
1219
1219
|
projectId: string;
|
1220
1220
|
/** @description The state of the composition to upsert into. 0 = draft, 64 = published */
|
1221
1221
|
state: number;
|
1222
|
-
composition: external$
|
1222
|
+
composition: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1223
1223
|
/**
|
1224
1224
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
1225
1225
|
* @default false
|
@@ -1238,11 +1238,11 @@ interface paths$3 {
|
|
1238
1238
|
responses: {
|
1239
1239
|
/** OK */
|
1240
1240
|
204: never;
|
1241
|
-
400: external$
|
1242
|
-
401: external$
|
1243
|
-
403: external$
|
1244
|
-
429: external$
|
1245
|
-
500: external$
|
1241
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1242
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1243
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1244
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1245
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1246
1246
|
};
|
1247
1247
|
requestBody: {
|
1248
1248
|
content: {
|
@@ -1300,7 +1300,7 @@ interface components$1 {
|
|
1300
1300
|
modified: string;
|
1301
1301
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
1302
1302
|
pattern: boolean;
|
1303
|
-
composition: external$
|
1303
|
+
composition: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1304
1304
|
};
|
1305
1305
|
CompositionListResponse: {
|
1306
1306
|
compositions: components$1["schemas"]["CompositionApiResponse"][];
|
@@ -1401,7 +1401,7 @@ interface components$1 {
|
|
1401
1401
|
withTotalCount: boolean;
|
1402
1402
|
};
|
1403
1403
|
}
|
1404
|
-
interface external$
|
1404
|
+
interface external$6 {
|
1405
1405
|
"swagger.yml": {
|
1406
1406
|
paths: {};
|
1407
1407
|
components: {
|
@@ -1415,25 +1415,25 @@ interface external$4 {
|
|
1415
1415
|
/** Request input validation failed */
|
1416
1416
|
BadRequestError: {
|
1417
1417
|
content: {
|
1418
|
-
"application/json": external$
|
1418
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
1419
1419
|
};
|
1420
1420
|
};
|
1421
1421
|
/** API key or token was not valid */
|
1422
1422
|
UnauthorizedError: {
|
1423
1423
|
content: {
|
1424
|
-
"application/json": external$
|
1424
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
1425
1425
|
};
|
1426
1426
|
};
|
1427
1427
|
/** Permission was denied */
|
1428
1428
|
ForbiddenError: {
|
1429
1429
|
content: {
|
1430
|
-
"application/json": external$
|
1430
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
1431
1431
|
};
|
1432
1432
|
};
|
1433
1433
|
/** Resource not found */
|
1434
1434
|
NotFoundError: {
|
1435
1435
|
content: {
|
1436
|
-
"application/json": external$
|
1436
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
1437
1437
|
};
|
1438
1438
|
};
|
1439
1439
|
/** Too many requests in allowed time period */
|
@@ -1452,7 +1452,7 @@ interface external$4 {
|
|
1452
1452
|
PublicIdProperty: string;
|
1453
1453
|
/** @description The definition of a component parameter */
|
1454
1454
|
ComponentDefinitionParameter: {
|
1455
|
-
id: external$
|
1455
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1456
1456
|
/** @description Friendly name of the parameter */
|
1457
1457
|
name: string;
|
1458
1458
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1464,7 +1464,7 @@ interface external$4 {
|
|
1464
1464
|
};
|
1465
1465
|
/** @description The definition of a named component slot that can contain other components */
|
1466
1466
|
ComponentDefinitionSlot: {
|
1467
|
-
id: external$
|
1467
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1468
1468
|
/** @description Friendly name of the slot */
|
1469
1469
|
name: string;
|
1470
1470
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1522,13 +1522,13 @@ interface external$4 {
|
|
1522
1522
|
};
|
1523
1523
|
/** @description The definition of a component variant */
|
1524
1524
|
ComponentDefinitionVariant: {
|
1525
|
-
id: external$
|
1525
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1526
1526
|
/** @description Friendly name of the variant */
|
1527
1527
|
name: string;
|
1528
1528
|
};
|
1529
1529
|
/** @description Permission set for a component defintion */
|
1530
1530
|
ComponentDefinitionPermission: {
|
1531
|
-
roleId: external$
|
1531
|
+
roleId: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1532
1532
|
/**
|
1533
1533
|
* @description Permission type for this permission ComponentDefinition:
|
1534
1534
|
* read | write | create | delete
|
@@ -1541,7 +1541,7 @@ interface external$4 {
|
|
1541
1541
|
};
|
1542
1542
|
/** @description Defines a component type that can live on a Composition */
|
1543
1543
|
ComponentDefinition: {
|
1544
|
-
id: external$
|
1544
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1545
1545
|
/** @description Friendly name of the component definition */
|
1546
1546
|
name: string;
|
1547
1547
|
/**
|
@@ -1560,21 +1560,21 @@ interface external$4 {
|
|
1560
1560
|
*/
|
1561
1561
|
canBeComposition?: boolean;
|
1562
1562
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1563
|
-
parameters?: external$
|
1563
|
+
parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1564
1564
|
/**
|
1565
1565
|
* @description if this component uses team permissions or custom permissions
|
1566
1566
|
* @default true
|
1567
1567
|
*/
|
1568
1568
|
useTeamPermissions?: boolean;
|
1569
1569
|
/** @description Custom role permissions for this component definition */
|
1570
|
-
permissions?: external$
|
1570
|
+
permissions?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1571
1571
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1572
|
-
slots?: external$
|
1573
|
-
slugSettings?: external$
|
1572
|
+
slots?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1573
|
+
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1574
1574
|
/** @description Default component instance value */
|
1575
|
-
defaults?: external$
|
1575
|
+
defaults?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1576
1576
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1577
|
-
variants?: external$
|
1577
|
+
variants?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1578
1578
|
/** @description Created date string for this definition (ignored for writes) */
|
1579
1579
|
created?: string;
|
1580
1580
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1586,7 +1586,7 @@ interface external$4 {
|
|
1586
1586
|
value: unknown;
|
1587
1587
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1588
1588
|
type: string;
|
1589
|
-
connectedData?: external$
|
1589
|
+
connectedData?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1590
1590
|
};
|
1591
1591
|
/**
|
1592
1592
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1609,13 +1609,13 @@ interface external$4 {
|
|
1609
1609
|
type: string;
|
1610
1610
|
/** @description Component parameter values for the component instance */
|
1611
1611
|
parameters?: {
|
1612
|
-
[key: string]: external$
|
1612
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1613
1613
|
};
|
1614
1614
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1615
1615
|
variant?: string;
|
1616
1616
|
/** @description Slots containing any child components */
|
1617
1617
|
slots?: {
|
1618
|
-
[key: string]: external$
|
1618
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1619
1619
|
};
|
1620
1620
|
/**
|
1621
1621
|
* @description Unique identifier of the component within the composition.
|
@@ -1625,13 +1625,13 @@ interface external$4 {
|
|
1625
1625
|
_id?: string;
|
1626
1626
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1627
1627
|
_pattern?: string;
|
1628
|
-
_dataResources?: external$
|
1628
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1629
1629
|
/**
|
1630
1630
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1631
1631
|
* Means nothing for PUTs; it will be ignored.
|
1632
1632
|
*/
|
1633
1633
|
_patternDataResources?: {
|
1634
|
-
[key: string]: external$
|
1634
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1635
1635
|
};
|
1636
1636
|
/**
|
1637
1637
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1655,7 +1655,7 @@ interface external$4 {
|
|
1655
1655
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1656
1656
|
*/
|
1657
1657
|
_overrides?: {
|
1658
|
-
[key: string]: external$
|
1658
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1659
1659
|
};
|
1660
1660
|
/**
|
1661
1661
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1664,7 +1664,7 @@ interface external$4 {
|
|
1664
1664
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1665
1665
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1666
1666
|
*/
|
1667
|
-
_overridability?: external$
|
1667
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1668
1668
|
};
|
1669
1669
|
/** @description Defines the shape of the root component in a composition */
|
1670
1670
|
RootComponentInstance: {
|
@@ -1672,15 +1672,15 @@ interface external$4 {
|
|
1672
1672
|
type: string;
|
1673
1673
|
/** @description Component parameter values for the component instance */
|
1674
1674
|
parameters?: {
|
1675
|
-
[key: string]: external$
|
1675
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1676
1676
|
};
|
1677
1677
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1678
1678
|
variant?: string;
|
1679
1679
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1680
|
-
projectMapNodes?: external$
|
1680
|
+
projectMapNodes?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1681
1681
|
/** @description Slots containing any child components */
|
1682
1682
|
slots?: {
|
1683
|
-
[key: string]: external$
|
1683
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1684
1684
|
};
|
1685
1685
|
/** @description The public UUID of the composition. */
|
1686
1686
|
_id: string;
|
@@ -1688,7 +1688,7 @@ interface external$4 {
|
|
1688
1688
|
_slug?: string | null;
|
1689
1689
|
/** @description Friendly name of this component. */
|
1690
1690
|
_name: string;
|
1691
|
-
_dataResources?: external$
|
1691
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1692
1692
|
/**
|
1693
1693
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1694
1694
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1702,7 +1702,7 @@ interface external$4 {
|
|
1702
1702
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1703
1703
|
*/
|
1704
1704
|
_overrides?: {
|
1705
|
-
[key: string]: external$
|
1705
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1706
1706
|
};
|
1707
1707
|
/**
|
1708
1708
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1711,7 +1711,7 @@ interface external$4 {
|
|
1711
1711
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1712
1712
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1713
1713
|
*/
|
1714
|
-
_overridability?: external$
|
1714
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1715
1715
|
};
|
1716
1716
|
/**
|
1717
1717
|
* @description Defines how to override a specific component.
|
@@ -1721,7 +1721,7 @@ interface external$4 {
|
|
1721
1721
|
*/
|
1722
1722
|
ComponentOverride: {
|
1723
1723
|
parameters?: {
|
1724
|
-
[key: string]: external$
|
1724
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1725
1725
|
};
|
1726
1726
|
variant?: string;
|
1727
1727
|
};
|
@@ -1735,7 +1735,7 @@ interface external$4 {
|
|
1735
1735
|
ComponentOverridability: {
|
1736
1736
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1737
1737
|
parameters?: {
|
1738
|
-
[key: string]: external$
|
1738
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1739
1739
|
};
|
1740
1740
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1741
1741
|
variants?: boolean;
|
@@ -1776,7 +1776,7 @@ interface external$4 {
|
|
1776
1776
|
}[];
|
1777
1777
|
/** @description Variables needed to make calls to the data source */
|
1778
1778
|
variables?: {
|
1779
|
-
[key: string]: external$
|
1779
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1780
1780
|
};
|
1781
1781
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1782
1782
|
custom?: {
|
@@ -1833,7 +1833,7 @@ interface external$4 {
|
|
1833
1833
|
method: "GET" | "POST" | "HEAD";
|
1834
1834
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1835
1835
|
variables?: {
|
1836
|
-
[key: string]: external$
|
1836
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1837
1837
|
};
|
1838
1838
|
/** @description Custom configuration specific to the data source being defined */
|
1839
1839
|
custom?: {
|
@@ -1861,7 +1861,7 @@ interface external$4 {
|
|
1861
1861
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1862
1862
|
*/
|
1863
1863
|
DataResourceDefinitions: {
|
1864
|
-
[key: string]: external$
|
1864
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1865
1865
|
};
|
1866
1866
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1867
1867
|
DataResourceDefinition: {
|
@@ -1875,7 +1875,7 @@ interface external$4 {
|
|
1875
1875
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1876
1876
|
*/
|
1877
1877
|
ignorePatternParameterDefault?: boolean;
|
1878
|
-
variables?: external$
|
1878
|
+
variables?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1879
1879
|
};
|
1880
1880
|
/** @description Variable values for a data resource. */
|
1881
1881
|
DataResourceVariables: {
|
@@ -1909,7 +1909,7 @@ interface components {
|
|
1909
1909
|
status: number;
|
1910
1910
|
statusText: string;
|
1911
1911
|
};
|
1912
|
-
UniformError: components["schemas"]["EdgehancersError"] | external$
|
1912
|
+
UniformError: components["schemas"]["EdgehancersError"] | external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1913
1913
|
InvalidationPayload: {
|
1914
1914
|
/** @description List of variables with values to invalidate */
|
1915
1915
|
variables?: {
|
@@ -2027,7 +2027,7 @@ interface components {
|
|
2027
2027
|
diagnostics?: components["schemas"]["CompositionDiagnostics"];
|
2028
2028
|
errors?: components["schemas"]["CompositionIssue"][];
|
2029
2029
|
warnings?: components["schemas"]["CompositionIssue"][];
|
2030
|
-
} & external$
|
2030
|
+
} & external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2031
2031
|
};
|
2032
2032
|
};
|
2033
2033
|
/** Invalidation request was processed; ok indicates if it succeeded */
|
@@ -2044,7 +2044,7 @@ interface components {
|
|
2044
2044
|
};
|
2045
2045
|
};
|
2046
2046
|
}
|
2047
|
-
interface external$
|
2047
|
+
interface external$5 {
|
2048
2048
|
"../../../lambda/functions/swagger.yml": {
|
2049
2049
|
paths: {};
|
2050
2050
|
components: {
|
@@ -2058,25 +2058,25 @@ interface external$3 {
|
|
2058
2058
|
/** Request input validation failed */
|
2059
2059
|
BadRequestError: {
|
2060
2060
|
content: {
|
2061
|
-
"application/json": external$
|
2061
|
+
"application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2062
2062
|
};
|
2063
2063
|
};
|
2064
2064
|
/** API key or token was not valid */
|
2065
2065
|
UnauthorizedError: {
|
2066
2066
|
content: {
|
2067
|
-
"application/json": external$
|
2067
|
+
"application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2068
2068
|
};
|
2069
2069
|
};
|
2070
2070
|
/** Permission was denied */
|
2071
2071
|
ForbiddenError: {
|
2072
2072
|
content: {
|
2073
|
-
"application/json": external$
|
2073
|
+
"application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2074
2074
|
};
|
2075
2075
|
};
|
2076
2076
|
/** Resource not found */
|
2077
2077
|
NotFoundError: {
|
2078
2078
|
content: {
|
2079
|
-
"application/json": external$
|
2079
|
+
"application/json": external$5["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2080
2080
|
};
|
2081
2081
|
};
|
2082
2082
|
/** Too many requests in allowed time period */
|
@@ -2095,7 +2095,7 @@ interface external$3 {
|
|
2095
2095
|
PublicIdProperty: string;
|
2096
2096
|
/** @description The definition of a component parameter */
|
2097
2097
|
ComponentDefinitionParameter: {
|
2098
|
-
id: external$
|
2098
|
+
id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2099
2099
|
/** @description Friendly name of the parameter */
|
2100
2100
|
name: string;
|
2101
2101
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2107,7 +2107,7 @@ interface external$3 {
|
|
2107
2107
|
};
|
2108
2108
|
/** @description The definition of a named component slot that can contain other components */
|
2109
2109
|
ComponentDefinitionSlot: {
|
2110
|
-
id: external$
|
2110
|
+
id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2111
2111
|
/** @description Friendly name of the slot */
|
2112
2112
|
name: string;
|
2113
2113
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2165,13 +2165,13 @@ interface external$3 {
|
|
2165
2165
|
};
|
2166
2166
|
/** @description The definition of a component variant */
|
2167
2167
|
ComponentDefinitionVariant: {
|
2168
|
-
id: external$
|
2168
|
+
id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2169
2169
|
/** @description Friendly name of the variant */
|
2170
2170
|
name: string;
|
2171
2171
|
};
|
2172
2172
|
/** @description Permission set for a component defintion */
|
2173
2173
|
ComponentDefinitionPermission: {
|
2174
|
-
roleId: external$
|
2174
|
+
roleId: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2175
2175
|
/**
|
2176
2176
|
* @description Permission type for this permission ComponentDefinition:
|
2177
2177
|
* read | write | create | delete
|
@@ -2184,7 +2184,7 @@ interface external$3 {
|
|
2184
2184
|
};
|
2185
2185
|
/** @description Defines a component type that can live on a Composition */
|
2186
2186
|
ComponentDefinition: {
|
2187
|
-
id: external$
|
2187
|
+
id: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2188
2188
|
/** @description Friendly name of the component definition */
|
2189
2189
|
name: string;
|
2190
2190
|
/**
|
@@ -2203,21 +2203,21 @@ interface external$3 {
|
|
2203
2203
|
*/
|
2204
2204
|
canBeComposition?: boolean;
|
2205
2205
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2206
|
-
parameters?: external$
|
2206
|
+
parameters?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2207
2207
|
/**
|
2208
2208
|
* @description if this component uses team permissions or custom permissions
|
2209
2209
|
* @default true
|
2210
2210
|
*/
|
2211
2211
|
useTeamPermissions?: boolean;
|
2212
2212
|
/** @description Custom role permissions for this component definition */
|
2213
|
-
permissions?: external$
|
2213
|
+
permissions?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2214
2214
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2215
|
-
slots?: external$
|
2216
|
-
slugSettings?: external$
|
2215
|
+
slots?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2216
|
+
slugSettings?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2217
2217
|
/** @description Default component instance value */
|
2218
|
-
defaults?: external$
|
2218
|
+
defaults?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2219
2219
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2220
|
-
variants?: external$
|
2220
|
+
variants?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2221
2221
|
/** @description Created date string for this definition (ignored for writes) */
|
2222
2222
|
created?: string;
|
2223
2223
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2229,7 +2229,7 @@ interface external$3 {
|
|
2229
2229
|
value: unknown;
|
2230
2230
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2231
2231
|
type: string;
|
2232
|
-
connectedData?: external$
|
2232
|
+
connectedData?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2233
2233
|
};
|
2234
2234
|
/**
|
2235
2235
|
* @description Defines a connection to a data element on a data resource.
|
@@ -2252,13 +2252,13 @@ interface external$3 {
|
|
2252
2252
|
type: string;
|
2253
2253
|
/** @description Component parameter values for the component instance */
|
2254
2254
|
parameters?: {
|
2255
|
-
[key: string]: external$
|
2255
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2256
2256
|
};
|
2257
2257
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2258
2258
|
variant?: string;
|
2259
2259
|
/** @description Slots containing any child components */
|
2260
2260
|
slots?: {
|
2261
|
-
[key: string]: external$
|
2261
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2262
2262
|
};
|
2263
2263
|
/**
|
2264
2264
|
* @description Unique identifier of the component within the composition.
|
@@ -2268,13 +2268,13 @@ interface external$3 {
|
|
2268
2268
|
_id?: string;
|
2269
2269
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2270
2270
|
_pattern?: string;
|
2271
|
-
_dataResources?: external$
|
2271
|
+
_dataResources?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2272
2272
|
/**
|
2273
2273
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2274
2274
|
* Means nothing for PUTs; it will be ignored.
|
2275
2275
|
*/
|
2276
2276
|
_patternDataResources?: {
|
2277
|
-
[key: string]: external$
|
2277
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2278
2278
|
};
|
2279
2279
|
/**
|
2280
2280
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2298,7 +2298,7 @@ interface external$3 {
|
|
2298
2298
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2299
2299
|
*/
|
2300
2300
|
_overrides?: {
|
2301
|
-
[key: string]: external$
|
2301
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2302
2302
|
};
|
2303
2303
|
/**
|
2304
2304
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2307,7 +2307,7 @@ interface external$3 {
|
|
2307
2307
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2308
2308
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2309
2309
|
*/
|
2310
|
-
_overridability?: external$
|
2310
|
+
_overridability?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2311
2311
|
};
|
2312
2312
|
/** @description Defines the shape of the root component in a composition */
|
2313
2313
|
RootComponentInstance: {
|
@@ -2315,15 +2315,15 @@ interface external$3 {
|
|
2315
2315
|
type: string;
|
2316
2316
|
/** @description Component parameter values for the component instance */
|
2317
2317
|
parameters?: {
|
2318
|
-
[key: string]: external$
|
2318
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2319
2319
|
};
|
2320
2320
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2321
2321
|
variant?: string;
|
2322
2322
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2323
|
-
projectMapNodes?: external$
|
2323
|
+
projectMapNodes?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2324
2324
|
/** @description Slots containing any child components */
|
2325
2325
|
slots?: {
|
2326
|
-
[key: string]: external$
|
2326
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2327
2327
|
};
|
2328
2328
|
/** @description The public UUID of the composition. */
|
2329
2329
|
_id: string;
|
@@ -2331,7 +2331,7 @@ interface external$3 {
|
|
2331
2331
|
_slug?: string | null;
|
2332
2332
|
/** @description Friendly name of this component. */
|
2333
2333
|
_name: string;
|
2334
|
-
_dataResources?: external$
|
2334
|
+
_dataResources?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2335
2335
|
/**
|
2336
2336
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2337
2337
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2345,7 +2345,7 @@ interface external$3 {
|
|
2345
2345
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2346
2346
|
*/
|
2347
2347
|
_overrides?: {
|
2348
|
-
[key: string]: external$
|
2348
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2349
2349
|
};
|
2350
2350
|
/**
|
2351
2351
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2354,7 +2354,7 @@ interface external$3 {
|
|
2354
2354
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2355
2355
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2356
2356
|
*/
|
2357
|
-
_overridability?: external$
|
2357
|
+
_overridability?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2358
2358
|
};
|
2359
2359
|
/**
|
2360
2360
|
* @description Defines how to override a specific component.
|
@@ -2364,7 +2364,7 @@ interface external$3 {
|
|
2364
2364
|
*/
|
2365
2365
|
ComponentOverride: {
|
2366
2366
|
parameters?: {
|
2367
|
-
[key: string]: external$
|
2367
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2368
2368
|
};
|
2369
2369
|
variant?: string;
|
2370
2370
|
};
|
@@ -2378,7 +2378,7 @@ interface external$3 {
|
|
2378
2378
|
ComponentOverridability: {
|
2379
2379
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2380
2380
|
parameters?: {
|
2381
|
-
[key: string]: external$
|
2381
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2382
2382
|
};
|
2383
2383
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2384
2384
|
variants?: boolean;
|
@@ -2419,7 +2419,7 @@ interface external$3 {
|
|
2419
2419
|
}[];
|
2420
2420
|
/** @description Variables needed to make calls to the data source */
|
2421
2421
|
variables?: {
|
2422
|
-
[key: string]: external$
|
2422
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2423
2423
|
};
|
2424
2424
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2425
2425
|
custom?: {
|
@@ -2476,7 +2476,7 @@ interface external$3 {
|
|
2476
2476
|
method: "GET" | "POST" | "HEAD";
|
2477
2477
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2478
2478
|
variables?: {
|
2479
|
-
[key: string]: external$
|
2479
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2480
2480
|
};
|
2481
2481
|
/** @description Custom configuration specific to the data source being defined */
|
2482
2482
|
custom?: {
|
@@ -2504,7 +2504,7 @@ interface external$3 {
|
|
2504
2504
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2505
2505
|
*/
|
2506
2506
|
DataResourceDefinitions: {
|
2507
|
-
[key: string]: external$
|
2507
|
+
[key: string]: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2508
2508
|
};
|
2509
2509
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2510
2510
|
DataResourceDefinition: {
|
@@ -2518,7 +2518,7 @@ interface external$3 {
|
|
2518
2518
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2519
2519
|
*/
|
2520
2520
|
ignorePatternParameterDefault?: boolean;
|
2521
|
-
variables?: external$
|
2521
|
+
variables?: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2522
2522
|
};
|
2523
2523
|
/** @description Variable values for a data resource. */
|
2524
2524
|
DataResourceVariables: {
|
@@ -2550,112 +2550,112 @@ interface external$3 {
|
|
2550
2550
|
parameters: {
|
2551
2551
|
query: {
|
2552
2552
|
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
2553
|
-
compositionId?: external$
|
2553
|
+
compositionId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
2554
2554
|
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
2555
|
-
compositionIDs?: external$
|
2555
|
+
compositionIDs?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
2556
2556
|
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2557
|
-
createdBy?: external$
|
2557
|
+
createdBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
2558
2558
|
/**
|
2559
2559
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2560
2560
|
* NOT a full text search; does not match composition contents.
|
2561
2561
|
*/
|
2562
|
-
keyword?: external$
|
2562
|
+
keyword?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
2563
2563
|
/** Max number of records to return */
|
2564
|
-
limit?: external$
|
2564
|
+
limit?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
2565
2565
|
/** Number of records to skip */
|
2566
|
-
offset?: external$
|
2566
|
+
offset?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
2567
2567
|
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2568
|
-
orderBy?: external$
|
2568
|
+
orderBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
2569
2569
|
/**
|
2570
2570
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2571
2571
|
* If true, only pattern compositions will be returned.
|
2572
2572
|
* If false, only regular compositions will be returned.
|
2573
2573
|
* If omitted, both pattern and regular compositions will be returned.
|
2574
2574
|
*/
|
2575
|
-
pattern?: external$
|
2575
|
+
pattern?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
2576
2576
|
/** The project the composition(s) are on. */
|
2577
|
-
projectId: external$
|
2577
|
+
projectId: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
2578
2578
|
/** Required when using project map node id or path for fetch. */
|
2579
|
-
projectMapId?: external$
|
2579
|
+
projectMapId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
2580
2580
|
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2581
|
-
projectMapNodeId?: external$
|
2581
|
+
projectMapNodeId?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
2582
2582
|
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2583
|
-
projectMapNodePath?: external$
|
2583
|
+
projectMapNodePath?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
2584
2584
|
/**
|
2585
2585
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2586
2586
|
* This improves performance if you do not require enhanced component data.
|
2587
2587
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2588
2588
|
*/
|
2589
|
-
skipEnhance?: external$
|
2589
|
+
skipEnhance?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
|
2590
2590
|
/**
|
2591
2591
|
* If true, any pattern references in the composition will be left unresolved.
|
2592
2592
|
* This is appropriate if you intend to serialize the composition without patterns
|
2593
2593
|
* embedded into it, and serialize the pattern data separately.
|
2594
2594
|
*/
|
2595
|
-
skipPatternResolution?: external$
|
2595
|
+
skipPatternResolution?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
2596
2596
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2597
|
-
skipParameterResolution?: external$
|
2597
|
+
skipParameterResolution?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2598
2598
|
/**
|
2599
2599
|
* If true, any pattern override data is not resolved by the API.
|
2600
2600
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2601
2601
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2602
2602
|
*/
|
2603
|
-
skipOverridesResolution?: external$
|
2603
|
+
skipOverridesResolution?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
2604
2604
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2605
|
-
slug?: external$
|
2605
|
+
slug?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
2606
2606
|
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
2607
|
-
state?: external$
|
2607
|
+
state?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
2608
2608
|
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
2609
|
-
type?: external$
|
2609
|
+
type?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
2610
2610
|
/**
|
2611
2611
|
* @deprecated Filters composition lists by the UI status of the composition.
|
2612
2612
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2613
2613
|
*/
|
2614
|
-
uiStatus?: external$
|
2614
|
+
uiStatus?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
2615
2615
|
/**
|
2616
2616
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
2617
2617
|
* in case of FALSE. If not specified - no filtration applied.
|
2618
2618
|
*/
|
2619
|
-
attachedToProjectMap?: external$
|
2619
|
+
attachedToProjectMap?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
2620
2620
|
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2621
|
-
updatedBy?: external$
|
2621
|
+
updatedBy?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
2622
2622
|
/**
|
2623
2623
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2624
2624
|
* If false, the `_id` will not be present in the API response.
|
2625
2625
|
*/
|
2626
|
-
withComponentIDs?: external$
|
2626
|
+
withComponentIDs?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
2627
2627
|
/**
|
2628
2628
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2629
2629
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2630
2630
|
*/
|
2631
|
-
withTotalCount?: external$
|
2631
|
+
withTotalCount?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
|
2632
2632
|
/**
|
2633
2633
|
* @deprecated Returns the UI status string of the composition.
|
2634
2634
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2635
2635
|
*/
|
2636
|
-
withUIStatus?: external$
|
2636
|
+
withUIStatus?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
2637
2637
|
/** Includes project map node information in the composition results */
|
2638
|
-
withProjectMapNodes?: external$
|
2638
|
+
withProjectMapNodes?: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
|
2639
2639
|
};
|
2640
2640
|
};
|
2641
2641
|
responses: {
|
2642
2642
|
/** OK */
|
2643
2643
|
200: {
|
2644
2644
|
content: {
|
2645
|
-
"application/json": external$
|
2645
|
+
"application/json": external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2646
2646
|
};
|
2647
2647
|
};
|
2648
|
-
400: external$
|
2649
|
-
401: external$
|
2650
|
-
403: external$
|
2648
|
+
400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2649
|
+
401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2650
|
+
403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2651
2651
|
/** Composition not found */
|
2652
2652
|
404: {
|
2653
2653
|
content: {
|
2654
2654
|
"text/plain": string;
|
2655
2655
|
};
|
2656
2656
|
};
|
2657
|
-
429: external$
|
2658
|
-
500: external$
|
2657
|
+
429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2658
|
+
500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2659
2659
|
};
|
2660
2660
|
};
|
2661
2661
|
/** Upserts a composition */
|
@@ -2663,11 +2663,11 @@ interface external$3 {
|
|
2663
2663
|
responses: {
|
2664
2664
|
/** OK */
|
2665
2665
|
204: never;
|
2666
|
-
400: external$
|
2667
|
-
401: external$
|
2668
|
-
403: external$
|
2669
|
-
429: external$
|
2670
|
-
500: external$
|
2666
|
+
400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2667
|
+
401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2668
|
+
403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2669
|
+
429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2670
|
+
500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2671
2671
|
};
|
2672
2672
|
requestBody: {
|
2673
2673
|
content: {
|
@@ -2679,7 +2679,7 @@ interface external$3 {
|
|
2679
2679
|
projectId: string;
|
2680
2680
|
/** @description The state of the composition to upsert into. 0 = draft, 64 = published */
|
2681
2681
|
state: number;
|
2682
|
-
composition: external$
|
2682
|
+
composition: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2683
2683
|
/**
|
2684
2684
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
2685
2685
|
* @default false
|
@@ -2698,11 +2698,11 @@ interface external$3 {
|
|
2698
2698
|
responses: {
|
2699
2699
|
/** OK */
|
2700
2700
|
204: never;
|
2701
|
-
400: external$
|
2702
|
-
401: external$
|
2703
|
-
403: external$
|
2704
|
-
429: external$
|
2705
|
-
500: external$
|
2701
|
+
400: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2702
|
+
401: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2703
|
+
403: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2704
|
+
429: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2705
|
+
500: external$5["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2706
2706
|
};
|
2707
2707
|
requestBody: {
|
2708
2708
|
content: {
|
@@ -2760,10 +2760,10 @@ interface external$3 {
|
|
2760
2760
|
modified: string;
|
2761
2761
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
2762
2762
|
pattern: boolean;
|
2763
|
-
composition: external$
|
2763
|
+
composition: external$5["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2764
2764
|
};
|
2765
2765
|
CompositionListResponse: {
|
2766
|
-
compositions: external$
|
2766
|
+
compositions: external$5["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
|
2767
2767
|
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
2768
2768
|
totalCount?: number;
|
2769
2769
|
};
|
@@ -2867,7 +2867,7 @@ interface external$3 {
|
|
2867
2867
|
|
2868
2868
|
type Components = components$1['schemas'];
|
2869
2869
|
type SharedComponents = components$2['schemas'];
|
2870
|
-
type Api = paths$
|
2870
|
+
type Api = paths$5['/api/v1/canvas'];
|
2871
2871
|
/** Query parameter options for GET /api/v1/canvas */
|
2872
2872
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
2873
2873
|
type?: string | string[];
|
@@ -3292,6 +3292,258 @@ declare class UncachedCanvasClient extends CanvasClient {
|
|
3292
3292
|
constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
|
3293
3293
|
}
|
3294
3294
|
|
3295
|
+
/**
|
3296
|
+
* This file was auto-generated by openapi-typescript.
|
3297
|
+
* Do not make direct changes to the file.
|
3298
|
+
*/
|
3299
|
+
interface paths$4 {
|
3300
|
+
"/api/v1/composition-relationships": {
|
3301
|
+
/** Gets the relationships for a composition */
|
3302
|
+
get: {
|
3303
|
+
parameters: {
|
3304
|
+
query: {
|
3305
|
+
projectId: string;
|
3306
|
+
type: "definition";
|
3307
|
+
definitionIds?: string;
|
3308
|
+
withCompositions?: boolean | null;
|
3309
|
+
};
|
3310
|
+
};
|
3311
|
+
responses: {
|
3312
|
+
/** 200 response */
|
3313
|
+
200: {
|
3314
|
+
content: {
|
3315
|
+
"application/json": {
|
3316
|
+
id: string;
|
3317
|
+
compositions?: {
|
3318
|
+
/** @enum {string} */
|
3319
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
3320
|
+
composition: {
|
3321
|
+
_id: string;
|
3322
|
+
_name: string;
|
3323
|
+
};
|
3324
|
+
pattern: boolean;
|
3325
|
+
}[];
|
3326
|
+
totalCount: number;
|
3327
|
+
}[];
|
3328
|
+
};
|
3329
|
+
};
|
3330
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3331
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3332
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3333
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3334
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3335
|
+
};
|
3336
|
+
};
|
3337
|
+
/** Reindexes the composition relationships for a project */
|
3338
|
+
post: {
|
3339
|
+
responses: {
|
3340
|
+
/** 200 response */
|
3341
|
+
200: {
|
3342
|
+
content: {
|
3343
|
+
"application/json": {
|
3344
|
+
success: boolean;
|
3345
|
+
};
|
3346
|
+
};
|
3347
|
+
};
|
3348
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3349
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3350
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3351
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3352
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3353
|
+
};
|
3354
|
+
requestBody: {
|
3355
|
+
content: {
|
3356
|
+
"application/json": {
|
3357
|
+
/** Format: uuid */
|
3358
|
+
projectId: string;
|
3359
|
+
/** @enum {string} */
|
3360
|
+
type: "clear" | "index";
|
3361
|
+
definitionId?: string;
|
3362
|
+
compositionId?: string;
|
3363
|
+
state?: number;
|
3364
|
+
};
|
3365
|
+
};
|
3366
|
+
};
|
3367
|
+
};
|
3368
|
+
};
|
3369
|
+
}
|
3370
|
+
interface external$4 {
|
3371
|
+
"swagger.yml": {
|
3372
|
+
paths: {};
|
3373
|
+
components: {
|
3374
|
+
schemas: {
|
3375
|
+
Error: {
|
3376
|
+
/** @description Error message(s) that occurred while processing the request */
|
3377
|
+
errorMessage?: string[] | string;
|
3378
|
+
};
|
3379
|
+
};
|
3380
|
+
responses: {
|
3381
|
+
/** Request input validation failed */
|
3382
|
+
BadRequestError: {
|
3383
|
+
content: {
|
3384
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3385
|
+
};
|
3386
|
+
};
|
3387
|
+
/** API key or token was not valid */
|
3388
|
+
UnauthorizedError: {
|
3389
|
+
content: {
|
3390
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3391
|
+
};
|
3392
|
+
};
|
3393
|
+
/** Permission was denied */
|
3394
|
+
ForbiddenError: {
|
3395
|
+
content: {
|
3396
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3397
|
+
};
|
3398
|
+
};
|
3399
|
+
/** Resource not found */
|
3400
|
+
NotFoundError: {
|
3401
|
+
content: {
|
3402
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3403
|
+
};
|
3404
|
+
};
|
3405
|
+
/** Too many requests in allowed time period */
|
3406
|
+
RateLimitError: unknown;
|
3407
|
+
/** Execution error occurred */
|
3408
|
+
InternalServerError: unknown;
|
3409
|
+
};
|
3410
|
+
};
|
3411
|
+
operations: {};
|
3412
|
+
};
|
3413
|
+
}
|
3414
|
+
|
3415
|
+
/**
|
3416
|
+
* This file was auto-generated by openapi-typescript.
|
3417
|
+
* Do not make direct changes to the file.
|
3418
|
+
*/
|
3419
|
+
interface paths$3 {
|
3420
|
+
"/api/v1/usage-tracking": {
|
3421
|
+
/** Gets current version of the usage tracking for a project */
|
3422
|
+
get: {
|
3423
|
+
parameters: {
|
3424
|
+
query: {
|
3425
|
+
projectId: string;
|
3426
|
+
};
|
3427
|
+
};
|
3428
|
+
responses: {
|
3429
|
+
/** 200 response */
|
3430
|
+
200: {
|
3431
|
+
content: {
|
3432
|
+
"application/json": {
|
3433
|
+
version: number;
|
3434
|
+
};
|
3435
|
+
};
|
3436
|
+
};
|
3437
|
+
400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3438
|
+
401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3439
|
+
403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3440
|
+
429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3441
|
+
500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3442
|
+
};
|
3443
|
+
};
|
3444
|
+
/** Sets version of the usage tracking for a project */
|
3445
|
+
post: {
|
3446
|
+
responses: {
|
3447
|
+
/** 200 response */
|
3448
|
+
200: {
|
3449
|
+
content: {
|
3450
|
+
"application/json": {
|
3451
|
+
version: number;
|
3452
|
+
};
|
3453
|
+
};
|
3454
|
+
};
|
3455
|
+
400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3456
|
+
401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3457
|
+
403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3458
|
+
429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3459
|
+
500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3460
|
+
};
|
3461
|
+
requestBody: {
|
3462
|
+
content: {
|
3463
|
+
"application/json": {
|
3464
|
+
/** Format: uuid */
|
3465
|
+
projectId: string;
|
3466
|
+
version: number;
|
3467
|
+
};
|
3468
|
+
};
|
3469
|
+
};
|
3470
|
+
};
|
3471
|
+
};
|
3472
|
+
}
|
3473
|
+
interface external$3 {
|
3474
|
+
"swagger.yml": {
|
3475
|
+
paths: {};
|
3476
|
+
components: {
|
3477
|
+
schemas: {
|
3478
|
+
Error: {
|
3479
|
+
/** @description Error message(s) that occurred while processing the request */
|
3480
|
+
errorMessage?: string[] | string;
|
3481
|
+
};
|
3482
|
+
};
|
3483
|
+
responses: {
|
3484
|
+
/** Request input validation failed */
|
3485
|
+
BadRequestError: {
|
3486
|
+
content: {
|
3487
|
+
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
3488
|
+
};
|
3489
|
+
};
|
3490
|
+
/** API key or token was not valid */
|
3491
|
+
UnauthorizedError: {
|
3492
|
+
content: {
|
3493
|
+
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
3494
|
+
};
|
3495
|
+
};
|
3496
|
+
/** Permission was denied */
|
3497
|
+
ForbiddenError: {
|
3498
|
+
content: {
|
3499
|
+
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
3500
|
+
};
|
3501
|
+
};
|
3502
|
+
/** Resource not found */
|
3503
|
+
NotFoundError: {
|
3504
|
+
content: {
|
3505
|
+
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
3506
|
+
};
|
3507
|
+
};
|
3508
|
+
/** Too many requests in allowed time period */
|
3509
|
+
RateLimitError: unknown;
|
3510
|
+
/** Execution error occurred */
|
3511
|
+
InternalServerError: unknown;
|
3512
|
+
};
|
3513
|
+
};
|
3514
|
+
operations: {};
|
3515
|
+
};
|
3516
|
+
}
|
3517
|
+
|
3518
|
+
type CompositionRelationshipsDefinitionApi = paths$4['/api/v1/composition-relationships'];
|
3519
|
+
type CompositionRelationshipsDefinitionGetParameters = CompositionRelationshipsDefinitionApi['get']['parameters']['query'];
|
3520
|
+
type CompositionRelationshipsDDefinitionGetResponse = CompositionRelationshipsDefinitionApi['get']['responses']['200']['content']['application/json'];
|
3521
|
+
type UsageTrackingApi = paths$3['/api/v1/usage-tracking'];
|
3522
|
+
type UsageTrackingGetParameters = UsageTrackingApi['get']['parameters']['query'];
|
3523
|
+
type UsageTrackingGetResponse = UsageTrackingApi['get']['responses']['200']['content']['application/json'];
|
3524
|
+
type UsageTrackingPostParameters = UsageTrackingApi['post']['requestBody']['content']['application/json'];
|
3525
|
+
type UsageTrackingPostResponse = UsageTrackingApi['post']['responses']['200']['content']['application/json'];
|
3526
|
+
type CompositionRelationshipsClientOptions = ClientOptions;
|
3527
|
+
declare class unstable_CompositionRelationshipClient extends ApiClient<CompositionRelationshipsClientOptions> {
|
3528
|
+
private readonly _options;
|
3529
|
+
constructor(options: CompositionRelationshipsClientOptions);
|
3530
|
+
getDefinitionsRelationships: ({ definitionIds, withCompositions, }: {
|
3531
|
+
definitionIds: string[];
|
3532
|
+
withCompositions?: boolean | undefined;
|
3533
|
+
}) => Promise<CompositionRelationshipsDDefinitionGetResponse>;
|
3534
|
+
clearAllRelationships: () => Promise<{
|
3535
|
+
success: boolean;
|
3536
|
+
}>;
|
3537
|
+
indexCompositionRelationships: ({ state, compositionId, }: {
|
3538
|
+
state: number;
|
3539
|
+
compositionId: string;
|
3540
|
+
}) => Promise<{
|
3541
|
+
success: boolean;
|
3542
|
+
}>;
|
3543
|
+
getVersion: () => Promise<UsageTrackingGetResponse['version']>;
|
3544
|
+
setVersion: (version: UsageTrackingPostParameters['version']) => Promise<UsageTrackingPostResponse>;
|
3545
|
+
}
|
3546
|
+
|
3295
3547
|
type PreviewPanelSettings = {
|
3296
3548
|
isInteractive: boolean;
|
3297
3549
|
};
|
@@ -5692,4 +5944,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
5692
5944
|
|
5693
5945
|
declare const CanvasClientError: typeof ApiClientError;
|
5694
5946
|
|
5695
|
-
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_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, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
|
5947
|
+
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_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, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
|