@uniformdev/canvas 17.1.1-alpha.231 → 17.2.1-alpha.134

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.
@@ -4,7 +4,7 @@ import Pusher from 'pusher-js';
4
4
  * This file was auto-generated by openapi-typescript.
5
5
  * Do not make direct changes to the file.
6
6
  */
7
- interface paths$1 {
7
+ interface paths$4 {
8
8
  "/api/v1/canvas-definitions": {
9
9
  get: {
10
10
  parameters: {
@@ -27,15 +27,15 @@ interface paths$1 {
27
27
  content: {
28
28
  "application/json": {
29
29
  /** @description Component definitions that match the query */
30
- componentDefinitions: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
30
+ componentDefinitions: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
31
31
  };
32
32
  };
33
33
  };
34
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
35
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
36
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
37
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
38
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
34
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
35
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
36
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
37
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
38
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
39
39
  };
40
40
  };
41
41
  /** Upserts a component definition */
@@ -43,11 +43,11 @@ interface paths$1 {
43
43
  responses: {
44
44
  /** OK */
45
45
  204: never;
46
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
47
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
48
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
49
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
50
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
46
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
47
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
48
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
49
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
50
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
51
51
  };
52
52
  requestBody: {
53
53
  content: {
@@ -57,7 +57,7 @@ interface paths$1 {
57
57
  * @description The project ID to upsert the component definition to
58
58
  */
59
59
  projectId: string;
60
- componentDefinition: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
60
+ componentDefinition: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
61
61
  };
62
62
  };
63
63
  };
@@ -67,11 +67,11 @@ interface paths$1 {
67
67
  responses: {
68
68
  /** OK */
69
69
  204: never;
70
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
71
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
72
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
73
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
74
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
70
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
71
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
72
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
73
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
74
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
75
75
  };
76
76
  requestBody: {
77
77
  content: {
@@ -96,7 +96,7 @@ interface paths$1 {
96
96
  };
97
97
  };
98
98
  }
99
- interface external$1 {
99
+ interface external$4 {
100
100
  "swagger.yml": {
101
101
  paths: {};
102
102
  components: {
@@ -110,25 +110,25 @@ interface external$1 {
110
110
  /** Request input validation failed */
111
111
  BadRequestError: {
112
112
  content: {
113
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
113
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
114
114
  };
115
115
  };
116
116
  /** API key or token was not valid */
117
117
  UnauthorizedError: {
118
118
  content: {
119
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
119
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
120
120
  };
121
121
  };
122
122
  /** Permission was denied */
123
123
  ForbiddenError: {
124
124
  content: {
125
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
125
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
126
126
  };
127
127
  };
128
128
  /** Resource not found */
129
129
  NotFoundError: {
130
130
  content: {
131
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
131
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
132
132
  };
133
133
  };
134
134
  /** Too many requests in allowed time period */
@@ -147,7 +147,7 @@ interface external$1 {
147
147
  PublicIdProperty: string;
148
148
  /** @description The definition of a component parameter */
149
149
  ComponentDefinitionParameter: {
150
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
150
+ id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
151
151
  /** @description Friendly name of the parameter */
152
152
  name: string;
153
153
  /** @description Appears next to the parameter in the Composition editor */
@@ -159,7 +159,7 @@ interface external$1 {
159
159
  };
160
160
  /** @description The definition of a named component slot that can contain other components */
161
161
  ComponentDefinitionSlot: {
162
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
162
+ id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
163
163
  /** @description Friendly name of the slot */
164
164
  name: string;
165
165
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -205,13 +205,13 @@ interface external$1 {
205
205
  };
206
206
  /** @description The definition of a component variant */
207
207
  ComponentDefinitionVariant: {
208
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
208
+ id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
209
209
  /** @description Friendly name of the variant */
210
210
  name: string;
211
211
  };
212
212
  /** @description Permission set for a component defintion */
213
213
  ComponentDefinitionPermission: {
214
- roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
214
+ roleId: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
215
215
  /**
216
216
  * @description Permission type for this permission ComponentDefinition:
217
217
  * read | write | create | delete
@@ -224,7 +224,7 @@ interface external$1 {
224
224
  };
225
225
  /** @description Defines a component type that can live on a Composition */
226
226
  ComponentDefinition: {
227
- id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
227
+ id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
228
228
  /** @description Friendly name of the component definition */
229
229
  name: string;
230
230
  /**
@@ -243,21 +243,21 @@ interface external$1 {
243
243
  */
244
244
  canBeComposition?: boolean;
245
245
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
246
- parameters?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
246
+ parameters?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
247
247
  /**
248
248
  * @description if this component uses team permissions or custom permissions
249
249
  * @default true
250
250
  */
251
251
  useTeamPermissions?: boolean;
252
252
  /** @description Custom role permissions for this component definition */
253
- permissions?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
253
+ permissions?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
254
254
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
255
- slots?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
256
- slugSettings?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
255
+ slots?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
256
+ slugSettings?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
257
257
  /** @description Default component instance value */
258
- defaults?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
258
+ defaults?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
259
259
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
260
- variants?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
260
+ variants?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
261
261
  /** @description Created date string for this definition (ignored for writes) */
262
262
  created?: string;
263
263
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -269,7 +269,7 @@ interface external$1 {
269
269
  value: unknown;
270
270
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
271
271
  type: string;
272
- binding?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
272
+ binding?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
273
273
  };
274
274
  /**
275
275
  * @deprecated
@@ -298,26 +298,26 @@ interface external$1 {
298
298
  type: string;
299
299
  /** @description Component parameter values for the component instance */
300
300
  parameters?: {
301
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
301
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
302
302
  };
303
303
  /** @description Public ID of alternate visual appearance for this component, if any selected */
304
304
  variant?: string;
305
305
  /** @description Slots containing any child components */
306
306
  slots?: {
307
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
307
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
308
308
  };
309
309
  /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
310
310
  _id?: string;
311
311
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
312
312
  _pattern?: string;
313
- _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
313
+ _data?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
314
314
  /**
315
315
  * @deprecated
316
316
  * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
317
317
  * Means nothing for PUTs; it will be ignored.
318
318
  */
319
319
  _patternData?: {
320
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
320
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
321
321
  };
322
322
  /**
323
323
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -335,13 +335,13 @@ interface external$1 {
335
335
  type: string;
336
336
  /** @description Component parameter values for the component instance */
337
337
  parameters?: {
338
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
338
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
339
339
  };
340
340
  /** @description Public ID of alternate visual appearance for this component, if any selected */
341
341
  variant?: string;
342
342
  /** @description Slots containing any child components */
343
343
  slots?: {
344
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
344
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
345
345
  };
346
346
  /** @description The public UUID of the composition. */
347
347
  _id: string;
@@ -349,7 +349,7 @@ interface external$1 {
349
349
  _slug?: string | null;
350
350
  /** @description Friendly name of this component. */
351
351
  _name: string;
352
- _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
352
+ _data?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
353
353
  };
354
354
  /**
355
355
  * @deprecated
@@ -363,7 +363,7 @@ interface external$1 {
363
363
  /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
364
364
  connectorType: string;
365
365
  /** @description Base resource URL of the data connector. No trailing slash. */
366
- baseUrl?: string;
366
+ baseUrl: string;
367
367
  };
368
368
  /**
369
369
  * @deprecated
@@ -388,7 +388,7 @@ interface external$1 {
388
388
  };
389
389
  /** @description Variables needed to make calls to the data connection */
390
390
  variables?: {
391
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
391
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
392
392
  };
393
393
  /** @description Custom configuration specific to the data connection being defined */
394
394
  custom?: {
@@ -412,6 +412,7 @@ interface external$1 {
412
412
  * no special UI or processing is required.
413
413
  */
414
414
  archetype?: string;
415
+ allowedOnComponents?: string[];
415
416
  /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
416
417
  path: string;
417
418
  /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
@@ -432,7 +433,7 @@ interface external$1 {
432
433
  method: "GET" | "POST" | "HEAD";
433
434
  /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
434
435
  variables?: {
435
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
436
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
436
437
  };
437
438
  /** @description Custom configuration specific to the data connection being defined */
438
439
  custom?: {
@@ -465,7 +466,7 @@ interface external$1 {
465
466
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
466
467
  */
467
468
  CompositionDataDefinitions: {
468
- [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
469
+ [key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
469
470
  };
470
471
  /**
471
472
  * @deprecated
@@ -476,7 +477,7 @@ interface external$1 {
476
477
  type: string;
477
478
  /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
478
479
  isPatternParameter?: boolean;
479
- variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
480
+ variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
480
481
  };
481
482
  /**
482
483
  * @deprecated
@@ -713,7 +714,7 @@ interface components$1 {
713
714
  /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
714
715
  connectorType: string;
715
716
  /** @description Base resource URL of the data connector. No trailing slash. */
716
- baseUrl?: string;
717
+ baseUrl: string;
717
718
  };
718
719
  /**
719
720
  * @deprecated
@@ -762,6 +763,7 @@ interface components$1 {
762
763
  * no special UI or processing is required.
763
764
  */
764
765
  archetype?: string;
766
+ allowedOnComponents?: string[];
765
767
  /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
766
768
  path: string;
767
769
  /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
@@ -839,7 +841,7 @@ interface components$1 {
839
841
  }
840
842
 
841
843
  declare type SharedComponents$1 = components$1['schemas'];
842
- declare type Api$1 = paths$1['/api/v1/canvas-definitions'];
844
+ declare type Api$1 = paths$4['/api/v1/canvas-definitions'];
843
845
  /** Shape of the GET response from /api/v1/canvas-definitions */
844
846
  declare type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
845
847
  /** Shape of the PUT request body for /api/v1/canvas-definitions */
@@ -877,7 +879,7 @@ declare type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'c
877
879
  * This file was auto-generated by openapi-typescript.
878
880
  * Do not make direct changes to the file.
879
881
  */
880
- interface paths {
882
+ interface paths$3 {
881
883
  "/api/v1/canvas": {
882
884
  get: {
883
885
  parameters: {
@@ -952,17 +954,17 @@ interface paths {
952
954
  "application/json": components["schemas"]["CompositionListResponse"] | components["schemas"]["CompositionApiResponse"];
953
955
  };
954
956
  };
955
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
956
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
957
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
957
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
958
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
959
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
958
960
  /** Composition not found */
959
961
  404: {
960
962
  content: {
961
963
  "text/plain": string;
962
964
  };
963
965
  };
964
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
965
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
966
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
967
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
966
968
  };
967
969
  };
968
970
  /** Upserts a composition */
@@ -970,11 +972,11 @@ interface paths {
970
972
  responses: {
971
973
  /** OK */
972
974
  204: never;
973
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
974
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
975
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
976
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
977
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
975
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
976
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
977
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
978
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
979
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
978
980
  };
979
981
  requestBody: {
980
982
  content: {
@@ -986,7 +988,7 @@ interface paths {
986
988
  projectId: string;
987
989
  /** @description The state of the composition to upsert into. 0 = draft, 64 = published */
988
990
  state: number;
989
- composition: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
991
+ composition: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
990
992
  /**
991
993
  * @description True if the composition is a pattern (which can be referenced on other compositions)
992
994
  * @default false
@@ -1005,11 +1007,11 @@ interface paths {
1005
1007
  responses: {
1006
1008
  /** OK */
1007
1009
  204: never;
1008
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1009
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1010
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1011
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1012
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1010
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
1011
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1012
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1013
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
1014
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
1013
1015
  };
1014
1016
  requestBody: {
1015
1017
  content: {
@@ -1067,14 +1069,14 @@ interface components {
1067
1069
  modified: string;
1068
1070
  /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
1069
1071
  pattern: boolean;
1070
- composition: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1072
+ composition: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
1071
1073
  };
1072
1074
  CompositionListResponse: {
1073
1075
  compositions: components["schemas"]["CompositionApiResponse"][];
1074
1076
  };
1075
1077
  };
1076
1078
  }
1077
- interface external {
1079
+ interface external$3 {
1078
1080
  "swagger.yml": {
1079
1081
  paths: {};
1080
1082
  components: {
@@ -1088,25 +1090,25 @@ interface external {
1088
1090
  /** Request input validation failed */
1089
1091
  BadRequestError: {
1090
1092
  content: {
1091
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1093
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
1092
1094
  };
1093
1095
  };
1094
1096
  /** API key or token was not valid */
1095
1097
  UnauthorizedError: {
1096
1098
  content: {
1097
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1099
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
1098
1100
  };
1099
1101
  };
1100
1102
  /** Permission was denied */
1101
1103
  ForbiddenError: {
1102
1104
  content: {
1103
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1105
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
1104
1106
  };
1105
1107
  };
1106
1108
  /** Resource not found */
1107
1109
  NotFoundError: {
1108
1110
  content: {
1109
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1111
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
1110
1112
  };
1111
1113
  };
1112
1114
  /** Too many requests in allowed time period */
@@ -1125,7 +1127,7 @@ interface external {
1125
1127
  PublicIdProperty: string;
1126
1128
  /** @description The definition of a component parameter */
1127
1129
  ComponentDefinitionParameter: {
1128
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1130
+ id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1129
1131
  /** @description Friendly name of the parameter */
1130
1132
  name: string;
1131
1133
  /** @description Appears next to the parameter in the Composition editor */
@@ -1137,7 +1139,7 @@ interface external {
1137
1139
  };
1138
1140
  /** @description The definition of a named component slot that can contain other components */
1139
1141
  ComponentDefinitionSlot: {
1140
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1142
+ id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1141
1143
  /** @description Friendly name of the slot */
1142
1144
  name: string;
1143
1145
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -1183,13 +1185,13 @@ interface external {
1183
1185
  };
1184
1186
  /** @description The definition of a component variant */
1185
1187
  ComponentDefinitionVariant: {
1186
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1188
+ id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1187
1189
  /** @description Friendly name of the variant */
1188
1190
  name: string;
1189
1191
  };
1190
1192
  /** @description Permission set for a component defintion */
1191
1193
  ComponentDefinitionPermission: {
1192
- roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1194
+ roleId: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1193
1195
  /**
1194
1196
  * @description Permission type for this permission ComponentDefinition:
1195
1197
  * read | write | create | delete
@@ -1202,7 +1204,7 @@ interface external {
1202
1204
  };
1203
1205
  /** @description Defines a component type that can live on a Composition */
1204
1206
  ComponentDefinition: {
1205
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1207
+ id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1206
1208
  /** @description Friendly name of the component definition */
1207
1209
  name: string;
1208
1210
  /**
@@ -1221,21 +1223,21 @@ interface external {
1221
1223
  */
1222
1224
  canBeComposition?: boolean;
1223
1225
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
1224
- parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1226
+ parameters?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1225
1227
  /**
1226
1228
  * @description if this component uses team permissions or custom permissions
1227
1229
  * @default true
1228
1230
  */
1229
1231
  useTeamPermissions?: boolean;
1230
1232
  /** @description Custom role permissions for this component definition */
1231
- permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1233
+ permissions?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1232
1234
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
1233
- slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1234
- slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1235
+ slots?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1236
+ slugSettings?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1235
1237
  /** @description Default component instance value */
1236
- defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1238
+ defaults?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1237
1239
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
1238
- variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1240
+ variants?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1239
1241
  /** @description Created date string for this definition (ignored for writes) */
1240
1242
  created?: string;
1241
1243
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -1247,7 +1249,7 @@ interface external {
1247
1249
  value: unknown;
1248
1250
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1249
1251
  type: string;
1250
- binding?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
1252
+ binding?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
1251
1253
  };
1252
1254
  /**
1253
1255
  * @deprecated
@@ -1276,26 +1278,26 @@ interface external {
1276
1278
  type: string;
1277
1279
  /** @description Component parameter values for the component instance */
1278
1280
  parameters?: {
1279
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1281
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1280
1282
  };
1281
1283
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1282
1284
  variant?: string;
1283
1285
  /** @description Slots containing any child components */
1284
1286
  slots?: {
1285
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1287
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1286
1288
  };
1287
1289
  /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
1288
1290
  _id?: string;
1289
1291
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1290
1292
  _pattern?: string;
1291
- _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1293
+ _data?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1292
1294
  /**
1293
1295
  * @deprecated
1294
1296
  * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
1295
1297
  * Means nothing for PUTs; it will be ignored.
1296
1298
  */
1297
1299
  _patternData?: {
1298
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1300
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1299
1301
  };
1300
1302
  /**
1301
1303
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -1313,13 +1315,13 @@ interface external {
1313
1315
  type: string;
1314
1316
  /** @description Component parameter values for the component instance */
1315
1317
  parameters?: {
1316
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1318
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1317
1319
  };
1318
1320
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1319
1321
  variant?: string;
1320
1322
  /** @description Slots containing any child components */
1321
1323
  slots?: {
1322
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1324
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1323
1325
  };
1324
1326
  /** @description The public UUID of the composition. */
1325
1327
  _id: string;
@@ -1327,7 +1329,7 @@ interface external {
1327
1329
  _slug?: string | null;
1328
1330
  /** @description Friendly name of this component. */
1329
1331
  _name: string;
1330
- _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1332
+ _data?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1331
1333
  };
1332
1334
  /**
1333
1335
  * @deprecated
@@ -1341,7 +1343,7 @@ interface external {
1341
1343
  /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1342
1344
  connectorType: string;
1343
1345
  /** @description Base resource URL of the data connector. No trailing slash. */
1344
- baseUrl?: string;
1346
+ baseUrl: string;
1345
1347
  };
1346
1348
  /**
1347
1349
  * @deprecated
@@ -1366,7 +1368,7 @@ interface external {
1366
1368
  };
1367
1369
  /** @description Variables needed to make calls to the data connection */
1368
1370
  variables?: {
1369
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1371
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1370
1372
  };
1371
1373
  /** @description Custom configuration specific to the data connection being defined */
1372
1374
  custom?: {
@@ -1390,6 +1392,7 @@ interface external {
1390
1392
  * no special UI or processing is required.
1391
1393
  */
1392
1394
  archetype?: string;
1395
+ allowedOnComponents?: string[];
1393
1396
  /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1394
1397
  path: string;
1395
1398
  /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
@@ -1410,7 +1413,7 @@ interface external {
1410
1413
  method: "GET" | "POST" | "HEAD";
1411
1414
  /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
1412
1415
  variables?: {
1413
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1416
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1414
1417
  };
1415
1418
  /** @description Custom configuration specific to the data connection being defined */
1416
1419
  custom?: {
@@ -1443,7 +1446,7 @@ interface external {
1443
1446
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1444
1447
  */
1445
1448
  CompositionDataDefinitions: {
1446
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1449
+ [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1447
1450
  };
1448
1451
  /**
1449
1452
  * @deprecated
@@ -1454,7 +1457,7 @@ interface external {
1454
1457
  type: string;
1455
1458
  /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
1456
1459
  isPatternParameter?: boolean;
1457
- variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
1460
+ variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
1458
1461
  };
1459
1462
  /**
1460
1463
  * @deprecated
@@ -1471,7 +1474,7 @@ interface external {
1471
1474
 
1472
1475
  declare type Components = components['schemas'];
1473
1476
  declare type SharedComponents = components$1['schemas'];
1474
- declare type Api = paths['/api/v1/canvas'];
1477
+ declare type Api = paths$3['/api/v1/canvas'];
1475
1478
  /** Query parameter options for GET /api/v1/canvas */
1476
1479
  declare type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
1477
1480
  type?: string | string[];
@@ -1519,8 +1522,1398 @@ declare type RootComponentInstance = SharedComponents['RootComponentInstance'];
1519
1522
  declare type CanvasDefinitions = {
1520
1523
  components?: Array<ComponentDefinition>;
1521
1524
  compositions?: Array<CompositionGetResponse>;
1525
+ dataTypes?: Array<DataType>;
1522
1526
  };
1523
1527
 
1528
+ /**
1529
+ * This file was auto-generated by openapi-typescript.
1530
+ * Do not make direct changes to the file.
1531
+ */
1532
+ interface paths$2 {
1533
+ "/api/v1/data-types": {
1534
+ get: {
1535
+ parameters: {
1536
+ query: {
1537
+ projectId: string;
1538
+ };
1539
+ };
1540
+ responses: {
1541
+ /** OK */
1542
+ 200: {
1543
+ content: {
1544
+ "application/json": {
1545
+ results: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
1546
+ };
1547
+ };
1548
+ };
1549
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
1550
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1551
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1552
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
1553
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
1554
+ };
1555
+ };
1556
+ put: {
1557
+ responses: {
1558
+ /** OK */
1559
+ 204: never;
1560
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
1561
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1562
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1563
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
1564
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
1565
+ };
1566
+ requestBody: {
1567
+ content: {
1568
+ "application/json": {
1569
+ data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
1570
+ /** Format: uuid */
1571
+ projectId: string;
1572
+ };
1573
+ };
1574
+ };
1575
+ };
1576
+ delete: {
1577
+ responses: {
1578
+ /** OK */
1579
+ 204: never;
1580
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
1581
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1582
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1583
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
1584
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
1585
+ };
1586
+ requestBody: {
1587
+ content: {
1588
+ "application/json": {
1589
+ typeId: string;
1590
+ /** Format: uuid */
1591
+ projectId: string;
1592
+ };
1593
+ };
1594
+ };
1595
+ };
1596
+ };
1597
+ }
1598
+ interface external$2 {
1599
+ "swagger.yml": {
1600
+ paths: {};
1601
+ components: {
1602
+ schemas: {
1603
+ Error: {
1604
+ /** @description Error message(s) that occurred while processing the request */
1605
+ errorMessage?: string[] | string;
1606
+ };
1607
+ };
1608
+ responses: {
1609
+ /** Request input validation failed */
1610
+ BadRequestError: {
1611
+ content: {
1612
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
1613
+ };
1614
+ };
1615
+ /** API key or token was not valid */
1616
+ UnauthorizedError: {
1617
+ content: {
1618
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
1619
+ };
1620
+ };
1621
+ /** Permission was denied */
1622
+ ForbiddenError: {
1623
+ content: {
1624
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
1625
+ };
1626
+ };
1627
+ /** Resource not found */
1628
+ NotFoundError: {
1629
+ content: {
1630
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
1631
+ };
1632
+ };
1633
+ /** Too many requests in allowed time period */
1634
+ RateLimitError: unknown;
1635
+ /** Execution error occurred */
1636
+ InternalServerError: unknown;
1637
+ };
1638
+ };
1639
+ operations: {};
1640
+ };
1641
+ "uniform-canvas-types.swagger.yml": {
1642
+ paths: {};
1643
+ components: {
1644
+ schemas: {
1645
+ /** @description Public ID (used in code). Do not change after creation. */
1646
+ PublicIdProperty: string;
1647
+ /** @description The definition of a component parameter */
1648
+ ComponentDefinitionParameter: {
1649
+ id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1650
+ /** @description Friendly name of the parameter */
1651
+ name: string;
1652
+ /** @description Appears next to the parameter in the Composition editor */
1653
+ helpText?: string;
1654
+ /** @description Type name of the parameter (provided by a Uniform integration) */
1655
+ type: string;
1656
+ /** @description The configuration object for the type (type-specific) */
1657
+ typeConfig?: unknown;
1658
+ };
1659
+ /** @description The definition of a named component slot that can contain other components */
1660
+ ComponentDefinitionSlot: {
1661
+ id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1662
+ /** @description Friendly name of the slot */
1663
+ name: string;
1664
+ /** @description A list of component definition public IDs that are allowed in this named slot */
1665
+ allowedComponents: string[];
1666
+ /**
1667
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
1668
+ * @default false
1669
+ */
1670
+ inheritAllowedComponents: boolean;
1671
+ /** @description Minimum valid number of components in this slot */
1672
+ minComponents?: number;
1673
+ /** @description Maximum valid number of components in this slot */
1674
+ maxComponents?: number;
1675
+ };
1676
+ /** @description The definition of a composition's slug settings */
1677
+ ComponentDefinitionSlugSettings: {
1678
+ /**
1679
+ * @description Whether the slug is required
1680
+ * no: slug is optional
1681
+ * yes: slug is required
1682
+ * disabled: slug is disabled and will not be shown in the editor
1683
+ *
1684
+ * @default no
1685
+ * @enum {string}
1686
+ */
1687
+ required?: "no" | "yes" | "disabled";
1688
+ /**
1689
+ * @description Slug uniqueness configuration.
1690
+ * no = no unique constraint
1691
+ * local = must be unique within this component type
1692
+ * global = must be unique across all component types
1693
+ *
1694
+ * @enum {string}
1695
+ */
1696
+ unique?: "no" | "local" | "global";
1697
+ /** @description Regular expression slugs must match */
1698
+ regularExpression?: string;
1699
+ /**
1700
+ * @description Custom error message when regular expression validation fails.
1701
+ * Has no effect if `regularExpression` is not set.
1702
+ */
1703
+ regularExpressionMessage?: string;
1704
+ };
1705
+ /** @description The definition of a component variant */
1706
+ ComponentDefinitionVariant: {
1707
+ id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1708
+ /** @description Friendly name of the variant */
1709
+ name: string;
1710
+ };
1711
+ /** @description Permission set for a component defintion */
1712
+ ComponentDefinitionPermission: {
1713
+ roleId: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1714
+ /**
1715
+ * @description Permission type for this permission ComponentDefinition:
1716
+ * read | write | create | delete
1717
+ *
1718
+ * @enum {string}
1719
+ */
1720
+ permission: "read" | "write" | "create" | "delete";
1721
+ /** @description State of the component that this permission applies to */
1722
+ state: number;
1723
+ };
1724
+ /** @description Defines a component type that can live on a Composition */
1725
+ ComponentDefinition: {
1726
+ id: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1727
+ /** @description Friendly name of the component definition */
1728
+ name: string;
1729
+ /**
1730
+ * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
1731
+ * @default screen
1732
+ */
1733
+ icon?: string;
1734
+ /**
1735
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
1736
+ * The parameter type must support being used as a title parameter for this to work.
1737
+ */
1738
+ titleParameter?: string | null;
1739
+ /**
1740
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
1741
+ * @default false
1742
+ */
1743
+ canBeComposition?: boolean;
1744
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
1745
+ parameters?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1746
+ /**
1747
+ * @description if this component uses team permissions or custom permissions
1748
+ * @default true
1749
+ */
1750
+ useTeamPermissions?: boolean;
1751
+ /** @description Custom role permissions for this component definition */
1752
+ permissions?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1753
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
1754
+ slots?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1755
+ slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1756
+ /** @description Default component instance value */
1757
+ defaults?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1758
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
1759
+ variants?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1760
+ /** @description Created date string for this definition (ignored for writes) */
1761
+ created?: string;
1762
+ /** @description Last modified date string for this definition (ignored for writes) */
1763
+ updated?: string;
1764
+ };
1765
+ /** @description Defines an editable parameter on a component. */
1766
+ ComponentParameter: {
1767
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
1768
+ value: unknown;
1769
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1770
+ type: string;
1771
+ binding?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
1772
+ };
1773
+ /**
1774
+ * @deprecated
1775
+ * @description Defines a binding from a resource data value to a component parameter value. Do not use.
1776
+ */
1777
+ ComponentParameterBinding: {
1778
+ /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
1779
+ pointer: string;
1780
+ /**
1781
+ * @description The syntax of the binding (currently always 'jptr')
1782
+ * @enum {string}
1783
+ */
1784
+ syntax: "jptr";
1785
+ /**
1786
+ * @description Whether the binding should cause an error if it cannot be resolved.
1787
+ * If true, and the binding cannot be resolved, an error will be returned by the binding process.
1788
+ * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
1789
+ *
1790
+ * @default false
1791
+ */
1792
+ required?: boolean;
1793
+ };
1794
+ /** @description Defines the shape of a component instance served by the composition API. */
1795
+ ComponentInstance: {
1796
+ /** @description Type of the component instance (public_id of its definition) */
1797
+ type: string;
1798
+ /** @description Component parameter values for the component instance */
1799
+ parameters?: {
1800
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1801
+ };
1802
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
1803
+ variant?: string;
1804
+ /** @description Slots containing any child components */
1805
+ slots?: {
1806
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1807
+ };
1808
+ /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
1809
+ _id?: string;
1810
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1811
+ _pattern?: string;
1812
+ _data?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1813
+ /**
1814
+ * @deprecated
1815
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
1816
+ * Means nothing for PUTs; it will be ignored.
1817
+ */
1818
+ _patternData?: {
1819
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1820
+ };
1821
+ /**
1822
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
1823
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
1824
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
1825
+ * Means nothing for PUTs; it will be ignored.
1826
+ *
1827
+ * @enum {string}
1828
+ */
1829
+ _patternError?: "NOTFOUND" | "CYCLIC";
1830
+ };
1831
+ /** @description Defines the shape of the root component in a composition */
1832
+ RootComponentInstance: {
1833
+ /** @description Type of the component instance (public_id of its definition) */
1834
+ type: string;
1835
+ /** @description Component parameter values for the component instance */
1836
+ parameters?: {
1837
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1838
+ };
1839
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
1840
+ variant?: string;
1841
+ /** @description Slots containing any child components */
1842
+ slots?: {
1843
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1844
+ };
1845
+ /** @description The public UUID of the composition. */
1846
+ _id: string;
1847
+ /** @description Slug pattern of this component. */
1848
+ _slug?: string | null;
1849
+ /** @description Friendly name of this component. */
1850
+ _name: string;
1851
+ _data?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
1852
+ };
1853
+ /**
1854
+ * @deprecated
1855
+ * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
1856
+ */
1857
+ DataConnectionInfo: {
1858
+ /** @description Public ID of the data connector */
1859
+ id: string;
1860
+ /** @description Display name of the data connector */
1861
+ displayName: string;
1862
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1863
+ connectorType: string;
1864
+ /** @description Base resource URL of the data connector. No trailing slash. */
1865
+ baseUrl: string;
1866
+ };
1867
+ /**
1868
+ * @deprecated
1869
+ * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
1870
+ */
1871
+ DataConnection: {
1872
+ /** @description Public ID of the data connection */
1873
+ id: string;
1874
+ /** @description Display name of the data connection */
1875
+ displayName: string;
1876
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1877
+ connectorType: string;
1878
+ /** @description Base resource URL of the data connection. No trailing slash. */
1879
+ baseUrl: string;
1880
+ /** @description HTTP headers to pass with requests to the data connection */
1881
+ headers?: {
1882
+ [key: string]: string;
1883
+ };
1884
+ /** @description Query String parameters to pass with requests to the data connection */
1885
+ parameters?: {
1886
+ [key: string]: string;
1887
+ };
1888
+ /** @description Variables needed to make calls to the data connection */
1889
+ variables?: {
1890
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1891
+ };
1892
+ /** @description Custom configuration specific to the data connection being defined */
1893
+ custom?: {
1894
+ [key: string]: unknown;
1895
+ };
1896
+ };
1897
+ /**
1898
+ * @deprecated
1899
+ * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
1900
+ */
1901
+ DataType: {
1902
+ /** @description Public ID of the data type */
1903
+ id: string;
1904
+ /** @description Display name of the data type */
1905
+ displayName: string;
1906
+ /** @description Public ID of the associated data connection */
1907
+ connectionId: string;
1908
+ /**
1909
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
1910
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
1911
+ * no special UI or processing is required.
1912
+ */
1913
+ archetype?: string;
1914
+ allowedOnComponents?: string[];
1915
+ /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1916
+ path: string;
1917
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
1918
+ headers?: {
1919
+ [key: string]: string;
1920
+ };
1921
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
1922
+ parameters?: {
1923
+ [key: string]: string;
1924
+ };
1925
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
1926
+ body?: string;
1927
+ /**
1928
+ * @description HTTP method to use with requests to the data type.
1929
+ * @default GET
1930
+ * @enum {string}
1931
+ */
1932
+ method: "GET" | "POST" | "HEAD";
1933
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
1934
+ variables?: {
1935
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
1936
+ };
1937
+ /** @description Custom configuration specific to the data connection being defined */
1938
+ custom?: {
1939
+ [key: string]: unknown;
1940
+ };
1941
+ };
1942
+ /**
1943
+ * @deprecated
1944
+ * @description Defines the shape of a data variable on a Data Connector or Data Type
1945
+ */
1946
+ DataVariable: {
1947
+ /** @description Display name of the data variable */
1948
+ displayName?: string;
1949
+ /**
1950
+ * @description Type of the data variable
1951
+ * @default text
1952
+ */
1953
+ type: string;
1954
+ /** @description Default value of the data variable */
1955
+ default: string;
1956
+ /**
1957
+ * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
1958
+ * @enum {string}
1959
+ */
1960
+ setBy: "static" | "dynamic";
1961
+ };
1962
+ /**
1963
+ * @deprecated
1964
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
1965
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1966
+ */
1967
+ CompositionDataDefinitions: {
1968
+ [key: string]: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
1969
+ };
1970
+ /**
1971
+ * @deprecated
1972
+ * @description Data definition attached to this component
1973
+ */
1974
+ CompositionDataDefinition: {
1975
+ /** @description Public ID of the data type that provides this data */
1976
+ type: string;
1977
+ /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
1978
+ isPatternParameter?: boolean;
1979
+ variables?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
1980
+ };
1981
+ /**
1982
+ * @deprecated
1983
+ * @description Static variable values for this composition.
1984
+ */
1985
+ CompositionDataVariables: {
1986
+ [key: string]: string;
1987
+ };
1988
+ };
1989
+ };
1990
+ operations: {};
1991
+ };
1992
+ }
1993
+
1994
+ /**
1995
+ * This file was auto-generated by openapi-typescript.
1996
+ * Do not make direct changes to the file.
1997
+ */
1998
+ interface paths$1 {
1999
+ "/api/v1/data-connection": {
2000
+ get: {
2001
+ parameters: {
2002
+ query: {
2003
+ dataConnectionId: string;
2004
+ projectId: string;
2005
+ };
2006
+ };
2007
+ responses: {
2008
+ /** OK */
2009
+ 200: {
2010
+ content: {
2011
+ "application/json": {
2012
+ result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
2013
+ };
2014
+ };
2015
+ };
2016
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
2017
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2018
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2019
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
2020
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
2021
+ };
2022
+ };
2023
+ put: {
2024
+ responses: {
2025
+ /** OK */
2026
+ 204: never;
2027
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
2028
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2029
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2030
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
2031
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
2032
+ };
2033
+ requestBody: {
2034
+ content: {
2035
+ "application/json": {
2036
+ data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnection"];
2037
+ /** Format: uuid */
2038
+ projectId: string;
2039
+ /** Format: uuid */
2040
+ integrationId: string;
2041
+ };
2042
+ };
2043
+ };
2044
+ };
2045
+ delete: {
2046
+ responses: {
2047
+ /** OK */
2048
+ 204: never;
2049
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
2050
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2051
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2052
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
2053
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
2054
+ };
2055
+ requestBody: {
2056
+ content: {
2057
+ "application/json": {
2058
+ connectionId: string;
2059
+ /** Format: uuid */
2060
+ projectId: string;
2061
+ };
2062
+ };
2063
+ };
2064
+ };
2065
+ };
2066
+ }
2067
+ interface external$1 {
2068
+ "swagger.yml": {
2069
+ paths: {};
2070
+ components: {
2071
+ schemas: {
2072
+ Error: {
2073
+ /** @description Error message(s) that occurred while processing the request */
2074
+ errorMessage?: string[] | string;
2075
+ };
2076
+ };
2077
+ responses: {
2078
+ /** Request input validation failed */
2079
+ BadRequestError: {
2080
+ content: {
2081
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
2082
+ };
2083
+ };
2084
+ /** API key or token was not valid */
2085
+ UnauthorizedError: {
2086
+ content: {
2087
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
2088
+ };
2089
+ };
2090
+ /** Permission was denied */
2091
+ ForbiddenError: {
2092
+ content: {
2093
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
2094
+ };
2095
+ };
2096
+ /** Resource not found */
2097
+ NotFoundError: {
2098
+ content: {
2099
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
2100
+ };
2101
+ };
2102
+ /** Too many requests in allowed time period */
2103
+ RateLimitError: unknown;
2104
+ /** Execution error occurred */
2105
+ InternalServerError: unknown;
2106
+ };
2107
+ };
2108
+ operations: {};
2109
+ };
2110
+ "uniform-canvas-types.swagger.yml": {
2111
+ paths: {};
2112
+ components: {
2113
+ schemas: {
2114
+ /** @description Public ID (used in code). Do not change after creation. */
2115
+ PublicIdProperty: string;
2116
+ /** @description The definition of a component parameter */
2117
+ ComponentDefinitionParameter: {
2118
+ id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2119
+ /** @description Friendly name of the parameter */
2120
+ name: string;
2121
+ /** @description Appears next to the parameter in the Composition editor */
2122
+ helpText?: string;
2123
+ /** @description Type name of the parameter (provided by a Uniform integration) */
2124
+ type: string;
2125
+ /** @description The configuration object for the type (type-specific) */
2126
+ typeConfig?: unknown;
2127
+ };
2128
+ /** @description The definition of a named component slot that can contain other components */
2129
+ ComponentDefinitionSlot: {
2130
+ id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2131
+ /** @description Friendly name of the slot */
2132
+ name: string;
2133
+ /** @description A list of component definition public IDs that are allowed in this named slot */
2134
+ allowedComponents: string[];
2135
+ /**
2136
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
2137
+ * @default false
2138
+ */
2139
+ inheritAllowedComponents: boolean;
2140
+ /** @description Minimum valid number of components in this slot */
2141
+ minComponents?: number;
2142
+ /** @description Maximum valid number of components in this slot */
2143
+ maxComponents?: number;
2144
+ };
2145
+ /** @description The definition of a composition's slug settings */
2146
+ ComponentDefinitionSlugSettings: {
2147
+ /**
2148
+ * @description Whether the slug is required
2149
+ * no: slug is optional
2150
+ * yes: slug is required
2151
+ * disabled: slug is disabled and will not be shown in the editor
2152
+ *
2153
+ * @default no
2154
+ * @enum {string}
2155
+ */
2156
+ required?: "no" | "yes" | "disabled";
2157
+ /**
2158
+ * @description Slug uniqueness configuration.
2159
+ * no = no unique constraint
2160
+ * local = must be unique within this component type
2161
+ * global = must be unique across all component types
2162
+ *
2163
+ * @enum {string}
2164
+ */
2165
+ unique?: "no" | "local" | "global";
2166
+ /** @description Regular expression slugs must match */
2167
+ regularExpression?: string;
2168
+ /**
2169
+ * @description Custom error message when regular expression validation fails.
2170
+ * Has no effect if `regularExpression` is not set.
2171
+ */
2172
+ regularExpressionMessage?: string;
2173
+ };
2174
+ /** @description The definition of a component variant */
2175
+ ComponentDefinitionVariant: {
2176
+ id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2177
+ /** @description Friendly name of the variant */
2178
+ name: string;
2179
+ };
2180
+ /** @description Permission set for a component defintion */
2181
+ ComponentDefinitionPermission: {
2182
+ roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2183
+ /**
2184
+ * @description Permission type for this permission ComponentDefinition:
2185
+ * read | write | create | delete
2186
+ *
2187
+ * @enum {string}
2188
+ */
2189
+ permission: "read" | "write" | "create" | "delete";
2190
+ /** @description State of the component that this permission applies to */
2191
+ state: number;
2192
+ };
2193
+ /** @description Defines a component type that can live on a Composition */
2194
+ ComponentDefinition: {
2195
+ id: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2196
+ /** @description Friendly name of the component definition */
2197
+ name: string;
2198
+ /**
2199
+ * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
2200
+ * @default screen
2201
+ */
2202
+ icon?: string;
2203
+ /**
2204
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
2205
+ * The parameter type must support being used as a title parameter for this to work.
2206
+ */
2207
+ titleParameter?: string | null;
2208
+ /**
2209
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
2210
+ * @default false
2211
+ */
2212
+ canBeComposition?: boolean;
2213
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
2214
+ parameters?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2215
+ /**
2216
+ * @description if this component uses team permissions or custom permissions
2217
+ * @default true
2218
+ */
2219
+ useTeamPermissions?: boolean;
2220
+ /** @description Custom role permissions for this component definition */
2221
+ permissions?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2222
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
2223
+ slots?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2224
+ slugSettings?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2225
+ /** @description Default component instance value */
2226
+ defaults?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2227
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
2228
+ variants?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2229
+ /** @description Created date string for this definition (ignored for writes) */
2230
+ created?: string;
2231
+ /** @description Last modified date string for this definition (ignored for writes) */
2232
+ updated?: string;
2233
+ };
2234
+ /** @description Defines an editable parameter on a component. */
2235
+ ComponentParameter: {
2236
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
2237
+ value: unknown;
2238
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2239
+ type: string;
2240
+ binding?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
2241
+ };
2242
+ /**
2243
+ * @deprecated
2244
+ * @description Defines a binding from a resource data value to a component parameter value. Do not use.
2245
+ */
2246
+ ComponentParameterBinding: {
2247
+ /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
2248
+ pointer: string;
2249
+ /**
2250
+ * @description The syntax of the binding (currently always 'jptr')
2251
+ * @enum {string}
2252
+ */
2253
+ syntax: "jptr";
2254
+ /**
2255
+ * @description Whether the binding should cause an error if it cannot be resolved.
2256
+ * If true, and the binding cannot be resolved, an error will be returned by the binding process.
2257
+ * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
2258
+ *
2259
+ * @default false
2260
+ */
2261
+ required?: boolean;
2262
+ };
2263
+ /** @description Defines the shape of a component instance served by the composition API. */
2264
+ ComponentInstance: {
2265
+ /** @description Type of the component instance (public_id of its definition) */
2266
+ type: string;
2267
+ /** @description Component parameter values for the component instance */
2268
+ parameters?: {
2269
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2270
+ };
2271
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
2272
+ variant?: string;
2273
+ /** @description Slots containing any child components */
2274
+ slots?: {
2275
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2276
+ };
2277
+ /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
2278
+ _id?: string;
2279
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
2280
+ _pattern?: string;
2281
+ _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
2282
+ /**
2283
+ * @deprecated
2284
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
2285
+ * Means nothing for PUTs; it will be ignored.
2286
+ */
2287
+ _patternData?: {
2288
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
2289
+ };
2290
+ /**
2291
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
2292
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
2293
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
2294
+ * Means nothing for PUTs; it will be ignored.
2295
+ *
2296
+ * @enum {string}
2297
+ */
2298
+ _patternError?: "NOTFOUND" | "CYCLIC";
2299
+ };
2300
+ /** @description Defines the shape of the root component in a composition */
2301
+ RootComponentInstance: {
2302
+ /** @description Type of the component instance (public_id of its definition) */
2303
+ type: string;
2304
+ /** @description Component parameter values for the component instance */
2305
+ parameters?: {
2306
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2307
+ };
2308
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
2309
+ variant?: string;
2310
+ /** @description Slots containing any child components */
2311
+ slots?: {
2312
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2313
+ };
2314
+ /** @description The public UUID of the composition. */
2315
+ _id: string;
2316
+ /** @description Slug pattern of this component. */
2317
+ _slug?: string | null;
2318
+ /** @description Friendly name of this component. */
2319
+ _name: string;
2320
+ _data?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
2321
+ };
2322
+ /**
2323
+ * @deprecated
2324
+ * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
2325
+ */
2326
+ DataConnectionInfo: {
2327
+ /** @description Public ID of the data connector */
2328
+ id: string;
2329
+ /** @description Display name of the data connector */
2330
+ displayName: string;
2331
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
2332
+ connectorType: string;
2333
+ /** @description Base resource URL of the data connector. No trailing slash. */
2334
+ baseUrl: string;
2335
+ };
2336
+ /**
2337
+ * @deprecated
2338
+ * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
2339
+ */
2340
+ DataConnection: {
2341
+ /** @description Public ID of the data connection */
2342
+ id: string;
2343
+ /** @description Display name of the data connection */
2344
+ displayName: string;
2345
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
2346
+ connectorType: string;
2347
+ /** @description Base resource URL of the data connection. No trailing slash. */
2348
+ baseUrl: string;
2349
+ /** @description HTTP headers to pass with requests to the data connection */
2350
+ headers?: {
2351
+ [key: string]: string;
2352
+ };
2353
+ /** @description Query String parameters to pass with requests to the data connection */
2354
+ parameters?: {
2355
+ [key: string]: string;
2356
+ };
2357
+ /** @description Variables needed to make calls to the data connection */
2358
+ variables?: {
2359
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
2360
+ };
2361
+ /** @description Custom configuration specific to the data connection being defined */
2362
+ custom?: {
2363
+ [key: string]: unknown;
2364
+ };
2365
+ };
2366
+ /**
2367
+ * @deprecated
2368
+ * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
2369
+ */
2370
+ DataType: {
2371
+ /** @description Public ID of the data type */
2372
+ id: string;
2373
+ /** @description Display name of the data type */
2374
+ displayName: string;
2375
+ /** @description Public ID of the associated data connection */
2376
+ connectionId: string;
2377
+ /**
2378
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
2379
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
2380
+ * no special UI or processing is required.
2381
+ */
2382
+ archetype?: string;
2383
+ allowedOnComponents?: string[];
2384
+ /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
2385
+ path: string;
2386
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
2387
+ headers?: {
2388
+ [key: string]: string;
2389
+ };
2390
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
2391
+ parameters?: {
2392
+ [key: string]: string;
2393
+ };
2394
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
2395
+ body?: string;
2396
+ /**
2397
+ * @description HTTP method to use with requests to the data type.
2398
+ * @default GET
2399
+ * @enum {string}
2400
+ */
2401
+ method: "GET" | "POST" | "HEAD";
2402
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
2403
+ variables?: {
2404
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
2405
+ };
2406
+ /** @description Custom configuration specific to the data connection being defined */
2407
+ custom?: {
2408
+ [key: string]: unknown;
2409
+ };
2410
+ };
2411
+ /**
2412
+ * @deprecated
2413
+ * @description Defines the shape of a data variable on a Data Connector or Data Type
2414
+ */
2415
+ DataVariable: {
2416
+ /** @description Display name of the data variable */
2417
+ displayName?: string;
2418
+ /**
2419
+ * @description Type of the data variable
2420
+ * @default text
2421
+ */
2422
+ type: string;
2423
+ /** @description Default value of the data variable */
2424
+ default: string;
2425
+ /**
2426
+ * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
2427
+ * @enum {string}
2428
+ */
2429
+ setBy: "static" | "dynamic";
2430
+ };
2431
+ /**
2432
+ * @deprecated
2433
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
2434
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
2435
+ */
2436
+ CompositionDataDefinitions: {
2437
+ [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
2438
+ };
2439
+ /**
2440
+ * @deprecated
2441
+ * @description Data definition attached to this component
2442
+ */
2443
+ CompositionDataDefinition: {
2444
+ /** @description Public ID of the data type that provides this data */
2445
+ type: string;
2446
+ /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
2447
+ isPatternParameter?: boolean;
2448
+ variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
2449
+ };
2450
+ /**
2451
+ * @deprecated
2452
+ * @description Static variable values for this composition.
2453
+ */
2454
+ CompositionDataVariables: {
2455
+ [key: string]: string;
2456
+ };
2457
+ };
2458
+ };
2459
+ operations: {};
2460
+ };
2461
+ }
2462
+
2463
+ /**
2464
+ * This file was auto-generated by openapi-typescript.
2465
+ * Do not make direct changes to the file.
2466
+ */
2467
+ interface paths {
2468
+ "/api/v1/data-connections": {
2469
+ get: {
2470
+ parameters: {
2471
+ query: {
2472
+ projectId: string;
2473
+ };
2474
+ };
2475
+ responses: {
2476
+ /** OK */
2477
+ 200: {
2478
+ content: {
2479
+ "application/json": {
2480
+ results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataConnectionInfo"][];
2481
+ };
2482
+ };
2483
+ };
2484
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
2485
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2486
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2487
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
2488
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
2489
+ };
2490
+ };
2491
+ };
2492
+ }
2493
+ interface external {
2494
+ "swagger.yml": {
2495
+ paths: {};
2496
+ components: {
2497
+ schemas: {
2498
+ Error: {
2499
+ /** @description Error message(s) that occurred while processing the request */
2500
+ errorMessage?: string[] | string;
2501
+ };
2502
+ };
2503
+ responses: {
2504
+ /** Request input validation failed */
2505
+ BadRequestError: {
2506
+ content: {
2507
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
2508
+ };
2509
+ };
2510
+ /** API key or token was not valid */
2511
+ UnauthorizedError: {
2512
+ content: {
2513
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
2514
+ };
2515
+ };
2516
+ /** Permission was denied */
2517
+ ForbiddenError: {
2518
+ content: {
2519
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
2520
+ };
2521
+ };
2522
+ /** Resource not found */
2523
+ NotFoundError: {
2524
+ content: {
2525
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
2526
+ };
2527
+ };
2528
+ /** Too many requests in allowed time period */
2529
+ RateLimitError: unknown;
2530
+ /** Execution error occurred */
2531
+ InternalServerError: unknown;
2532
+ };
2533
+ };
2534
+ operations: {};
2535
+ };
2536
+ "uniform-canvas-types.swagger.yml": {
2537
+ paths: {};
2538
+ components: {
2539
+ schemas: {
2540
+ /** @description Public ID (used in code). Do not change after creation. */
2541
+ PublicIdProperty: string;
2542
+ /** @description The definition of a component parameter */
2543
+ ComponentDefinitionParameter: {
2544
+ id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2545
+ /** @description Friendly name of the parameter */
2546
+ name: string;
2547
+ /** @description Appears next to the parameter in the Composition editor */
2548
+ helpText?: string;
2549
+ /** @description Type name of the parameter (provided by a Uniform integration) */
2550
+ type: string;
2551
+ /** @description The configuration object for the type (type-specific) */
2552
+ typeConfig?: unknown;
2553
+ };
2554
+ /** @description The definition of a named component slot that can contain other components */
2555
+ ComponentDefinitionSlot: {
2556
+ id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2557
+ /** @description Friendly name of the slot */
2558
+ name: string;
2559
+ /** @description A list of component definition public IDs that are allowed in this named slot */
2560
+ allowedComponents: string[];
2561
+ /**
2562
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
2563
+ * @default false
2564
+ */
2565
+ inheritAllowedComponents: boolean;
2566
+ /** @description Minimum valid number of components in this slot */
2567
+ minComponents?: number;
2568
+ /** @description Maximum valid number of components in this slot */
2569
+ maxComponents?: number;
2570
+ };
2571
+ /** @description The definition of a composition's slug settings */
2572
+ ComponentDefinitionSlugSettings: {
2573
+ /**
2574
+ * @description Whether the slug is required
2575
+ * no: slug is optional
2576
+ * yes: slug is required
2577
+ * disabled: slug is disabled and will not be shown in the editor
2578
+ *
2579
+ * @default no
2580
+ * @enum {string}
2581
+ */
2582
+ required?: "no" | "yes" | "disabled";
2583
+ /**
2584
+ * @description Slug uniqueness configuration.
2585
+ * no = no unique constraint
2586
+ * local = must be unique within this component type
2587
+ * global = must be unique across all component types
2588
+ *
2589
+ * @enum {string}
2590
+ */
2591
+ unique?: "no" | "local" | "global";
2592
+ /** @description Regular expression slugs must match */
2593
+ regularExpression?: string;
2594
+ /**
2595
+ * @description Custom error message when regular expression validation fails.
2596
+ * Has no effect if `regularExpression` is not set.
2597
+ */
2598
+ regularExpressionMessage?: string;
2599
+ };
2600
+ /** @description The definition of a component variant */
2601
+ ComponentDefinitionVariant: {
2602
+ id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2603
+ /** @description Friendly name of the variant */
2604
+ name: string;
2605
+ };
2606
+ /** @description Permission set for a component defintion */
2607
+ ComponentDefinitionPermission: {
2608
+ roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2609
+ /**
2610
+ * @description Permission type for this permission ComponentDefinition:
2611
+ * read | write | create | delete
2612
+ *
2613
+ * @enum {string}
2614
+ */
2615
+ permission: "read" | "write" | "create" | "delete";
2616
+ /** @description State of the component that this permission applies to */
2617
+ state: number;
2618
+ };
2619
+ /** @description Defines a component type that can live on a Composition */
2620
+ ComponentDefinition: {
2621
+ id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2622
+ /** @description Friendly name of the component definition */
2623
+ name: string;
2624
+ /**
2625
+ * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
2626
+ * @default screen
2627
+ */
2628
+ icon?: string;
2629
+ /**
2630
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
2631
+ * The parameter type must support being used as a title parameter for this to work.
2632
+ */
2633
+ titleParameter?: string | null;
2634
+ /**
2635
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
2636
+ * @default false
2637
+ */
2638
+ canBeComposition?: boolean;
2639
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
2640
+ parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2641
+ /**
2642
+ * @description if this component uses team permissions or custom permissions
2643
+ * @default true
2644
+ */
2645
+ useTeamPermissions?: boolean;
2646
+ /** @description Custom role permissions for this component definition */
2647
+ permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2648
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
2649
+ slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2650
+ slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2651
+ /** @description Default component instance value */
2652
+ defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2653
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
2654
+ variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2655
+ /** @description Created date string for this definition (ignored for writes) */
2656
+ created?: string;
2657
+ /** @description Last modified date string for this definition (ignored for writes) */
2658
+ updated?: string;
2659
+ };
2660
+ /** @description Defines an editable parameter on a component. */
2661
+ ComponentParameter: {
2662
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
2663
+ value: unknown;
2664
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2665
+ type: string;
2666
+ binding?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterBinding"];
2667
+ };
2668
+ /**
2669
+ * @deprecated
2670
+ * @description Defines a binding from a resource data value to a component parameter value. Do not use.
2671
+ */
2672
+ ComponentParameterBinding: {
2673
+ /** @description A JSON Pointer expression that defines the binding directly to the parameter value */
2674
+ pointer: string;
2675
+ /**
2676
+ * @description The syntax of the binding (currently always 'jptr')
2677
+ * @enum {string}
2678
+ */
2679
+ syntax: "jptr";
2680
+ /**
2681
+ * @description Whether the binding should cause an error if it cannot be resolved.
2682
+ * If true, and the binding cannot be resolved, an error will be returned by the binding process.
2683
+ * If false, and the binding cannot be resolved, the parameter will be removed from the bound composition.
2684
+ *
2685
+ * @default false
2686
+ */
2687
+ required?: boolean;
2688
+ };
2689
+ /** @description Defines the shape of a component instance served by the composition API. */
2690
+ ComponentInstance: {
2691
+ /** @description Type of the component instance (public_id of its definition) */
2692
+ type: string;
2693
+ /** @description Component parameter values for the component instance */
2694
+ parameters?: {
2695
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2696
+ };
2697
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
2698
+ variant?: string;
2699
+ /** @description Slots containing any child components */
2700
+ slots?: {
2701
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2702
+ };
2703
+ /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
2704
+ _id?: string;
2705
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
2706
+ _pattern?: string;
2707
+ _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
2708
+ /**
2709
+ * @deprecated
2710
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
2711
+ * Means nothing for PUTs; it will be ignored.
2712
+ */
2713
+ _patternData?: {
2714
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
2715
+ };
2716
+ /**
2717
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
2718
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
2719
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
2720
+ * Means nothing for PUTs; it will be ignored.
2721
+ *
2722
+ * @enum {string}
2723
+ */
2724
+ _patternError?: "NOTFOUND" | "CYCLIC";
2725
+ };
2726
+ /** @description Defines the shape of the root component in a composition */
2727
+ RootComponentInstance: {
2728
+ /** @description Type of the component instance (public_id of its definition) */
2729
+ type: string;
2730
+ /** @description Component parameter values for the component instance */
2731
+ parameters?: {
2732
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2733
+ };
2734
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
2735
+ variant?: string;
2736
+ /** @description Slots containing any child components */
2737
+ slots?: {
2738
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2739
+ };
2740
+ /** @description The public UUID of the composition. */
2741
+ _id: string;
2742
+ /** @description Slug pattern of this component. */
2743
+ _slug?: string | null;
2744
+ /** @description Friendly name of this component. */
2745
+ _name: string;
2746
+ _data?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinitions"];
2747
+ };
2748
+ /**
2749
+ * @deprecated
2750
+ * @description Basic information about an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
2751
+ */
2752
+ DataConnectionInfo: {
2753
+ /** @description Public ID of the data connector */
2754
+ id: string;
2755
+ /** @description Display name of the data connector */
2756
+ displayName: string;
2757
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
2758
+ connectorType: string;
2759
+ /** @description Base resource URL of the data connector. No trailing slash. */
2760
+ baseUrl: string;
2761
+ };
2762
+ /**
2763
+ * @deprecated
2764
+ * @description An instance of an integration data connector (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
2765
+ */
2766
+ DataConnection: {
2767
+ /** @description Public ID of the data connection */
2768
+ id: string;
2769
+ /** @description Display name of the data connection */
2770
+ displayName: string;
2771
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
2772
+ connectorType: string;
2773
+ /** @description Base resource URL of the data connection. No trailing slash. */
2774
+ baseUrl: string;
2775
+ /** @description HTTP headers to pass with requests to the data connection */
2776
+ headers?: {
2777
+ [key: string]: string;
2778
+ };
2779
+ /** @description Query String parameters to pass with requests to the data connection */
2780
+ parameters?: {
2781
+ [key: string]: string;
2782
+ };
2783
+ /** @description Variables needed to make calls to the data connection */
2784
+ variables?: {
2785
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
2786
+ };
2787
+ /** @description Custom configuration specific to the data connection being defined */
2788
+ custom?: {
2789
+ [key: string]: unknown;
2790
+ };
2791
+ };
2792
+ /**
2793
+ * @deprecated
2794
+ * @description A specific type of data that a Data Connection can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
2795
+ */
2796
+ DataType: {
2797
+ /** @description Public ID of the data type */
2798
+ id: string;
2799
+ /** @description Display name of the data type */
2800
+ displayName: string;
2801
+ /** @description Public ID of the associated data connection */
2802
+ connectionId: string;
2803
+ /**
2804
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
2805
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
2806
+ * no special UI or processing is required.
2807
+ */
2808
+ archetype?: string;
2809
+ allowedOnComponents?: string[];
2810
+ /** @description Resource path, appended to the data connection's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
2811
+ path: string;
2812
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
2813
+ headers?: {
2814
+ [key: string]: string;
2815
+ };
2816
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
2817
+ parameters?: {
2818
+ [key: string]: string;
2819
+ };
2820
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
2821
+ body?: string;
2822
+ /**
2823
+ * @description HTTP method to use with requests to the data type.
2824
+ * @default GET
2825
+ * @enum {string}
2826
+ */
2827
+ method: "GET" | "POST" | "HEAD";
2828
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
2829
+ variables?: {
2830
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
2831
+ };
2832
+ /** @description Custom configuration specific to the data connection being defined */
2833
+ custom?: {
2834
+ [key: string]: unknown;
2835
+ };
2836
+ };
2837
+ /**
2838
+ * @deprecated
2839
+ * @description Defines the shape of a data variable on a Data Connector or Data Type
2840
+ */
2841
+ DataVariable: {
2842
+ /** @description Display name of the data variable */
2843
+ displayName?: string;
2844
+ /**
2845
+ * @description Type of the data variable
2846
+ * @default text
2847
+ */
2848
+ type: string;
2849
+ /** @description Default value of the data variable */
2850
+ default: string;
2851
+ /**
2852
+ * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
2853
+ * @enum {string}
2854
+ */
2855
+ setBy: "static" | "dynamic";
2856
+ };
2857
+ /**
2858
+ * @deprecated
2859
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
2860
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
2861
+ */
2862
+ CompositionDataDefinitions: {
2863
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataDefinition"];
2864
+ };
2865
+ /**
2866
+ * @deprecated
2867
+ * @description Data definition attached to this component
2868
+ */
2869
+ CompositionDataDefinition: {
2870
+ /** @description Public ID of the data type that provides this data */
2871
+ type: string;
2872
+ /** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
2873
+ isPatternParameter?: boolean;
2874
+ variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionDataVariables"];
2875
+ };
2876
+ /**
2877
+ * @deprecated
2878
+ * @description Static variable values for this composition.
2879
+ */
2880
+ CompositionDataVariables: {
2881
+ [key: string]: string;
2882
+ };
2883
+ };
2884
+ };
2885
+ operations: {};
2886
+ };
2887
+ }
2888
+
2889
+ declare type DataTypeApi = paths$2['/api/v1/data-types'];
2890
+ declare type DataConnectionsApi = paths['/api/v1/data-connections'];
2891
+ declare type DataConnectionApi = paths$1['/api/v1/data-connection'];
2892
+ /** Query parameter options for GET /api/v1/data-types */
2893
+ declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
2894
+ /** The GET response from /api/v1/data-types */
2895
+ declare type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
2896
+ /** The PUT request body for /api/v1/data-types */
2897
+ declare type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
2898
+ /** Shape of the DELETE request body for /api/v1/data-types */
2899
+ declare type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
2900
+ /** Query parameter options for GET /api/v1/data-connection */
2901
+ declare type DataConnectionGetParameters = DataConnectionApi['get']['parameters']['query'];
2902
+ /** Query parameter options for GET /api/v1/data-connections */
2903
+ declare type DataConnectionsGetParameters = DataConnectionsApi['get']['parameters']['query'];
2904
+ /** The GET response from /api/v1/data-connections */
2905
+ declare type DataConnectionGetResponse = DataConnectionApi['get']['responses']['200']['content']['application/json'];
2906
+ /** The GET response from /api/v1/data-connections */
2907
+ declare type DataConnectionsGetResponse = DataConnectionsApi['get']['responses']['200']['content']['application/json'];
2908
+ /** The PUT request body for /api/v1/data-connection */
2909
+ declare type DataConnectionPutParameters = DataConnectionApi['put']['requestBody']['content']['application/json'];
2910
+ /** Shape of the DELETE request body for /api/v1/data-connection */
2911
+ declare type DataConnectionDeleteParameters = DataConnectionApi['delete']['requestBody']['content']['application/json'];
2912
+ declare type DataType = components$1['schemas']['DataType'];
2913
+ declare type DataConnection = components$1['schemas']['DataConnection'];
2914
+ declare type DataConnectionInfo = components$1['schemas']['DataConnectionInfo'];
2915
+ declare type DataVariable = components$1['schemas']['DataVariable'];
2916
+
1524
2917
  /**
1525
2918
  * Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
1526
2919
  * when it's only needed during preview mode. To avoid bundling it for all, we use an old-school
@@ -1546,4 +2939,4 @@ declare global {
1546
2939
  */
1547
2940
  declare function createEventBus(): Promise<PreviewEventBus | undefined>;
1548
2941
 
1549
- export { CompositionListAPIResponse as A, CompositionAPIOptions as B, ComponentInstance as C, ComponentParameterBinding as D, CompositionDataVariables as E, CompositionDataDefinitions as F, CompositionDataDefinition as G, CanvasDefinitions as H, ChannelSubscription as I, createEventBus as J, PreviewEventBus as P, RootComponentInstance as R, ComponentParameter as a, CompositionGetParameters as b, components$1 as c, CompositionPutParameters as d, CompositionDeleteParameters as e, ComponentDefinitionGetParameters as f, ComponentDefinitionPutParameters as g, ComponentDefinitionDeleteParameters as h, CompositionGetResponse as i, ComponentDefinitionGetResponse as j, ComponentDefinitionAPIResponse as k, ComponentDefinitionAPIPutRequest as l, ComponentDefinitionAPIDeleteRequest as m, ComponentDefinitionListAPIOptions as n, ComponentDefinitionParameter as o, ComponentDefinitionVariant as p, ComponentDefinitionSlugSettings as q, ComponentDefinitionSlot as r, ComponentDefinitionPermission as s, ComponentDefinition as t, CreatingComponentDefinition as u, CompositionGetOrderBy as v, CompositionUIStatus as w, CompositionGetListResponse as x, CompositionAPIResponse as y, CompositionAPIDeleteRequest as z };
2942
+ export { CreatingComponentDefinition as A, CompositionGetOrderBy as B, ComponentInstance as C, DataConnectionGetParameters as D, CompositionUIStatus as E, CompositionGetListResponse as F, CompositionAPIResponse as G, CompositionAPIDeleteRequest as H, CompositionListAPIResponse as I, CompositionAPIOptions as J, ComponentParameterBinding as K, CompositionDataVariables as L, CompositionDataDefinitions as M, CompositionDataDefinition as N, CanvasDefinitions as O, PreviewEventBus as P, DataConnectionGetResponse as Q, RootComponentInstance as R, DataConnectionsGetResponse as S, DataType as T, DataConnection as U, DataConnectionInfo as V, DataVariable as W, ChannelSubscription as X, createEventBus as Y, ComponentParameter as a, CompositionGetParameters as b, CompositionPutParameters as c, CompositionDeleteParameters as d, ComponentDefinitionGetParameters as e, ComponentDefinitionPutParameters as f, ComponentDefinitionDeleteParameters as g, DataConnectionsGetParameters as h, DataConnectionPutParameters as i, DataConnectionDeleteParameters as j, DataTypeGetParameters as k, DataTypeGetResponse as l, DataTypePutParameters as m, DataTypeDeleteParameters as n, CompositionGetResponse as o, ComponentDefinitionGetResponse as p, ComponentDefinitionAPIResponse as q, ComponentDefinitionAPIPutRequest as r, ComponentDefinitionAPIDeleteRequest as s, ComponentDefinitionListAPIOptions as t, ComponentDefinitionParameter as u, ComponentDefinitionVariant as v, ComponentDefinitionSlugSettings as w, ComponentDefinitionSlot as x, ComponentDefinitionPermission as y, ComponentDefinition as z };