@uniformdev/canvas 17.5.1-alpha.105 → 17.5.1-alpha.131

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.
Files changed (11) hide show
  1. package/dist/chunk-PVRSC7Y6.mjs +4 -0
  2. package/dist/cli/cli.d.ts +1 -1
  3. package/dist/cli/cli.js +41 -41
  4. package/dist/cli/cli.mjs +36 -36
  5. package/dist/{createEventBus-ae757f10.d.ts → createEventBus-aba716d8.d.ts} +792 -781
  6. package/dist/index.d.ts +465 -426
  7. package/dist/index.esm.js +1 -1
  8. package/dist/index.js +2 -2
  9. package/dist/index.mjs +1 -1
  10. package/package.json +5 -5
  11. package/dist/chunk-3DNK2OLJ.mjs +0 -4
package/dist/{createEventBus-ae757f10.d.ts → createEventBus-aba716d8.d.ts} RENAMED
@@ -1,592 +1,85 @@
1
1
  import Pusher from 'pusher-js';
2
2
 
3
- /**
4
- * This file was auto-generated by openapi-typescript.
5
- * Do not make direct changes to the file.
6
- */
7
- interface paths$4 {
8
- "/api/v1/canvas-definitions": {
9
- get: {
10
- parameters: {
11
- query: {
12
- /** The project ID to get component definitions for. */
13
- projectId: string;
14
- /** Limit list to one result by ID (response remains an array). */
15
- componentId?: string;
16
- /** Number of records to skip */
17
- offset?: number;
18
- /** Max number of records to return */
19
- limit?: number;
20
- /** Whether to fetch system meta-component definitions (personalize, test, etc) */
21
- includeSystem?: boolean;
22
- };
23
- };
24
- responses: {
25
- /** OK */
26
- 200: {
27
- content: {
28
- "application/json": {
29
- /** @description Component definitions that match the query */
30
- componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
31
- };
32
- };
33
- };
34
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
35
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
36
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
37
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
38
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
39
- };
3
+ interface components$2 {
4
+ schemas: {
5
+ /** @description Public ID (used in code). Do not change after creation. */
6
+ PublicIdProperty: string;
7
+ /** @description The definition of a component parameter */
8
+ ComponentDefinitionParameter: {
9
+ id: components$2["schemas"]["PublicIdProperty"];
10
+ /** @description Friendly name of the parameter */
11
+ name: string;
12
+ /** @description Appears next to the parameter in the Composition editor */
13
+ helpText?: string;
14
+ /** @description Type name of the parameter (provided by a Uniform integration) */
15
+ type: string;
16
+ /** @description The configuration object for the type (type-specific) */
17
+ typeConfig?: unknown;
40
18
  };
41
- /** Upserts a component definition */
42
- put: {
43
- responses: {
44
- /** OK */
45
- 204: never;
46
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
47
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
48
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
49
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
50
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
51
- };
52
- requestBody: {
53
- content: {
54
- "application/json": {
55
- /**
56
- * Format: uuid
57
- * @description The project ID to upsert the component definition to
58
- */
59
- projectId: string;
60
- componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
61
- };
62
- };
63
- };
19
+ /** @description The definition of a named component slot that can contain other components */
20
+ ComponentDefinitionSlot: {
21
+ id: components$2["schemas"]["PublicIdProperty"];
22
+ /** @description Friendly name of the slot */
23
+ name: string;
24
+ /** @description A list of component definition public IDs that are allowed in this named slot */
25
+ allowedComponents: string[];
26
+ /**
27
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
28
+ * @default false
29
+ */
30
+ inheritAllowedComponents: boolean;
31
+ /** @description Minimum valid number of components in this slot */
32
+ minComponents?: number;
33
+ /** @description Maximum valid number of components in this slot */
34
+ maxComponents?: number;
64
35
  };
65
- /** Deletes a component definition */
66
- delete: {
67
- responses: {
68
- /** OK */
69
- 204: never;
70
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
71
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
72
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
73
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
74
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
75
- };
76
- requestBody: {
77
- content: {
78
- "application/json": {
79
- /** @description The public ID of the component definition to delete */
80
- componentId: string;
81
- /**
82
- * Format: uuid
83
- * @description The ID of the project the composition to delete belongs to
84
- */
85
- projectId: string;
86
- };
87
- };
88
- };
36
+ /** @description The definition of a composition's slug settings */
37
+ ComponentDefinitionSlugSettings: {
38
+ /**
39
+ * @description Whether the slug is required
40
+ * no: slug is optional
41
+ * yes: slug is required
42
+ * disabled: slug is disabled and will not be shown in the editor
43
+ *
44
+ * @default no
45
+ * @enum {string}
46
+ */
47
+ required?: "no" | "yes" | "disabled";
48
+ /**
49
+ * @description Slug uniqueness configuration.
50
+ * no = no unique constraint
51
+ * local = must be unique within this component type
52
+ * global = must be unique across all component types
53
+ *
54
+ * @enum {string}
55
+ */
56
+ unique?: "no" | "local" | "global";
57
+ /** @description Regular expression slugs must match */
58
+ regularExpression?: string;
59
+ /**
60
+ * @description Custom error message when regular expression validation fails.
61
+ * Has no effect if `regularExpression` is not set.
62
+ */
63
+ regularExpressionMessage?: string;
89
64
  };
90
- /** Handles preflight requests. This endpoint allows CORS. */
91
- options: {
92
- responses: {
93
- /** OK */
94
- 204: never;
95
- };
65
+ /** @description The definition of a component variant */
66
+ ComponentDefinitionVariant: {
67
+ id: components$2["schemas"]["PublicIdProperty"];
68
+ /** @description Friendly name of the variant */
69
+ name: string;
96
70
  };
97
- };
98
- }
99
- interface external$5 {
100
- "swagger.yml": {
101
- paths: {};
102
- components: {
103
- schemas: {
104
- Error: {
105
- /** @description Error message(s) that occurred while processing the request */
106
- errorMessage?: string[] | string;
107
- };
108
- };
109
- responses: {
110
- /** Request input validation failed */
111
- BadRequestError: {
112
- content: {
113
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
114
- };
115
- };
116
- /** API key or token was not valid */
117
- UnauthorizedError: {
118
- content: {
119
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
120
- };
121
- };
122
- /** Permission was denied */
123
- ForbiddenError: {
124
- content: {
125
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
126
- };
127
- };
128
- /** Resource not found */
129
- NotFoundError: {
130
- content: {
131
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
132
- };
133
- };
134
- /** Too many requests in allowed time period */
135
- RateLimitError: unknown;
136
- /** Execution error occurred */
137
- InternalServerError: unknown;
138
- };
139
- };
140
- operations: {};
141
- };
142
- "uniform-canvas-types.swagger.yml": {
143
- paths: {};
144
- components: {
145
- schemas: {
146
- /** @description Public ID (used in code). Do not change after creation. */
147
- PublicIdProperty: string;
148
- /** @description The definition of a component parameter */
149
- ComponentDefinitionParameter: {
150
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
151
- /** @description Friendly name of the parameter */
152
- name: string;
153
- /** @description Appears next to the parameter in the Composition editor */
154
- helpText?: string;
155
- /** @description Type name of the parameter (provided by a Uniform integration) */
156
- type: string;
157
- /** @description The configuration object for the type (type-specific) */
158
- typeConfig?: unknown;
159
- };
160
- /** @description The definition of a named component slot that can contain other components */
161
- ComponentDefinitionSlot: {
162
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
163
- /** @description Friendly name of the slot */
164
- name: string;
165
- /** @description A list of component definition public IDs that are allowed in this named slot */
166
- allowedComponents: string[];
167
- /**
168
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
169
- * @default false
170
- */
171
- inheritAllowedComponents: boolean;
172
- /** @description Minimum valid number of components in this slot */
173
- minComponents?: number;
174
- /** @description Maximum valid number of components in this slot */
175
- maxComponents?: number;
176
- };
177
- /** @description The definition of a composition's slug settings */
178
- ComponentDefinitionSlugSettings: {
179
- /**
180
- * @description Whether the slug is required
181
- * no: slug is optional
182
- * yes: slug is required
183
- * disabled: slug is disabled and will not be shown in the editor
184
- *
185
- * @default no
186
- * @enum {string}
187
- */
188
- required?: "no" | "yes" | "disabled";
189
- /**
190
- * @description Slug uniqueness configuration.
191
- * no = no unique constraint
192
- * local = must be unique within this component type
193
- * global = must be unique across all component types
194
- *
195
- * @enum {string}
196
- */
197
- unique?: "no" | "local" | "global";
198
- /** @description Regular expression slugs must match */
199
- regularExpression?: string;
200
- /**
201
- * @description Custom error message when regular expression validation fails.
202
- * Has no effect if `regularExpression` is not set.
203
- */
204
- regularExpressionMessage?: string;
205
- };
206
- /** @description The definition of a component variant */
207
- ComponentDefinitionVariant: {
208
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
209
- /** @description Friendly name of the variant */
210
- name: string;
211
- };
212
- /** @description Permission set for a component defintion */
213
- ComponentDefinitionPermission: {
214
- roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
215
- /**
216
- * @description Permission type for this permission ComponentDefinition:
217
- * read | write | create | delete
218
- *
219
- * @enum {string}
220
- */
221
- permission: "read" | "write" | "create" | "delete";
222
- /** @description State of the component that this permission applies to */
223
- state: number;
224
- };
225
- /** @description Defines a component type that can live on a Composition */
226
- ComponentDefinition: {
227
- id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
228
- /** @description Friendly name of the component definition */
229
- name: string;
230
- /**
231
- * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
232
- * @default screen
233
- */
234
- icon?: string;
235
- /**
236
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
237
- * The parameter type must support being used as a title parameter for this to work.
238
- */
239
- titleParameter?: string | null;
240
- /**
241
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
242
- * @default false
243
- */
244
- canBeComposition?: boolean;
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$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
247
- /**
248
- * @description if this component uses team permissions or custom permissions
249
- * @default true
250
- */
251
- useTeamPermissions?: boolean;
252
- /** @description Custom role permissions for this component definition */
253
- permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
254
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
255
- slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
256
- slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
257
- /** @description Default component instance value */
258
- defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
259
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
260
- variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
261
- /** @description Created date string for this definition (ignored for writes) */
262
- created?: string;
263
- /** @description Last modified date string for this definition (ignored for writes) */
264
- updated?: string;
265
- };
266
- /** @description Defines an editable parameter on a component. */
267
- ComponentParameter: {
268
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
269
- value: unknown;
270
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
271
- type: string;
272
- connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
273
- };
274
- /**
275
- * @deprecated
276
- * @description Defines a connection to a data element on a data resource. Do not use.
277
- */
278
- DataElementConnectionDefinition: {
279
- /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
280
- pointer: string;
281
- /**
282
- * @description The syntax used to select the data element to bind to
283
- * @enum {string}
284
- */
285
- syntax: "jptr";
286
- /**
287
- * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
288
- * In all cases the binding process will remove the parameter data for the unresolvable data element.
289
- * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
290
- *
291
- * @default false
292
- */
293
- required?: boolean;
294
- };
295
- /** @description Defines the shape of a component instance served by the composition API. */
296
- ComponentInstance: {
297
- /** @description Type of the component instance (public_id of its definition) */
298
- type: string;
299
- /** @description Component parameter values for the component instance */
300
- parameters?: {
301
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
302
- };
303
- /** @description Public ID of alternate visual appearance for this component, if any selected */
304
- variant?: string;
305
- /** @description Slots containing any child components */
306
- slots?: {
307
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
308
- };
309
- /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
310
- _id?: string;
311
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
312
- _pattern?: string;
313
- _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
314
- /**
315
- * @deprecated
316
- * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
317
- * Means nothing for PUTs; it will be ignored.
318
- */
319
- _patternDataResources?: {
320
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
321
- };
322
- /**
323
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
324
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
325
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
326
- * Means nothing for PUTs; it will be ignored.
327
- *
328
- * @enum {string}
329
- */
330
- _patternError?: "NOTFOUND" | "CYCLIC";
331
- };
332
- /** @description Defines the shape of the root component in a composition */
333
- RootComponentInstance: {
334
- /** @description Type of the component instance (public_id of its definition) */
335
- type: string;
336
- /** @description Component parameter values for the component instance */
337
- parameters?: {
338
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
339
- };
340
- /** @description Public ID of alternate visual appearance for this component, if any selected */
341
- variant?: string;
342
- /** @description Slots containing any child components */
343
- slots?: {
344
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
345
- };
346
- /** @description The public UUID of the composition. */
347
- _id: string;
348
- /** @description Slug pattern of this component. */
349
- _slug?: string | null;
350
- /** @description Friendly name of this component. */
351
- _name: string;
352
- _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
353
- };
354
- /**
355
- * @deprecated
356
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
357
- */
358
- DataSourceInfo: {
359
- /** @description Public ID of the data source */
360
- id: string;
361
- /** @description Display name of the data source */
362
- displayName: string;
363
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
364
- connectorType: string;
365
- /** @description Base resource URL of the data source. No trailing slash. */
366
- baseUrl: string;
367
- };
368
- /**
369
- * @deprecated
370
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
371
- */
372
- DataSource: {
373
- /** @description Public ID of the data source */
374
- id: string;
375
- /** @description Display name of the data source */
376
- displayName: string;
377
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
378
- connectorType: string;
379
- /** @description Base resource URL of the data source. No trailing slash. */
380
- baseUrl: string;
381
- headers?: {
382
- [key: string]: string;
383
- } | {
384
- key: string;
385
- value: string;
386
- }[];
387
- parameters?: {
388
- [key: string]: string;
389
- } | {
390
- key: string;
391
- value: string;
392
- }[];
393
- /** @description Variables needed to make calls to the data source */
394
- variables?: {
395
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
396
- };
397
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
398
- custom?: {
399
- [key: string]: unknown;
400
- };
401
- };
402
- /**
403
- * @deprecated
404
- * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
405
- */
406
- DataType: {
407
- /** @description Public ID of the data type */
408
- id: string;
409
- /** @description Display name of the data type */
410
- displayName: string;
411
- /** @description Public ID of the associated data source */
412
- dataSourceId: string;
413
- /**
414
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
415
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
416
- * no special UI or processing is required.
417
- */
418
- archetype?: string;
419
- allowedOnComponents?: string[];
420
- /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
421
- path: string;
422
- /** @description Time-to-live for the resource data cache. */
423
- ttl?: number;
424
- /** @description A key for the resource data cache purging. */
425
- purgeKey?: string;
426
- /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
427
- badgeIconUrl?: string;
428
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
429
- headers?: {
430
- [key: string]: string;
431
- } | {
432
- key: string;
433
- value: string;
434
- }[];
435
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
436
- parameters?: {
437
- [key: string]: string;
438
- } | {
439
- key: string;
440
- value: string;
441
- }[];
442
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
443
- body?: string;
444
- /**
445
- * @description HTTP method to use with requests to the data type.
446
- * @default GET
447
- * @enum {string}
448
- */
449
- method: "GET" | "POST" | "HEAD";
450
- /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
451
- variables?: {
452
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
453
- };
454
- /** @description Custom configuration specific to the data source being defined */
455
- custom?: {
456
- [key: string]: unknown;
457
- };
458
- };
459
- /**
460
- * @deprecated
461
- * @description Defines the shape of a data variable on a Data Source or Data Type
462
- */
463
- DataVariableDefinition: {
464
- /** @description Display name of the data variable */
465
- displayName?: string;
466
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
467
- helpText?: string;
468
- /**
469
- * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
470
- * @default text
471
- */
472
- type?: string;
473
- /** @description Default value of the data variable */
474
- default: string;
475
- /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
476
- order?: number;
477
- };
478
- /**
479
- * @deprecated
480
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
481
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
482
- */
483
- DataResourceDefinitions: {
484
- [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
485
- };
486
- /**
487
- * @deprecated
488
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
489
- */
490
- DataResourceDefinition: {
491
- /** @description Public ID of the data type that provides this data */
492
- type: string;
493
- /** @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. */
494
- isPatternParameter?: boolean;
495
- variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
496
- };
497
- /**
498
- * @deprecated
499
- * @description Variable values for a data resource.
500
- */
501
- DataResourceVariables: {
502
- [key: string]: string;
503
- };
504
- };
505
- };
506
- operations: {};
507
- };
508
- }
509
-
510
- interface components$2 {
511
- schemas: {
512
- /** @description Public ID (used in code). Do not change after creation. */
513
- PublicIdProperty: string;
514
- /** @description The definition of a component parameter */
515
- ComponentDefinitionParameter: {
516
- id: components$2["schemas"]["PublicIdProperty"];
517
- /** @description Friendly name of the parameter */
518
- name: string;
519
- /** @description Appears next to the parameter in the Composition editor */
520
- helpText?: string;
521
- /** @description Type name of the parameter (provided by a Uniform integration) */
522
- type: string;
523
- /** @description The configuration object for the type (type-specific) */
524
- typeConfig?: unknown;
525
- };
526
- /** @description The definition of a named component slot that can contain other components */
527
- ComponentDefinitionSlot: {
528
- id: components$2["schemas"]["PublicIdProperty"];
529
- /** @description Friendly name of the slot */
530
- name: string;
531
- /** @description A list of component definition public IDs that are allowed in this named slot */
532
- allowedComponents: string[];
533
- /**
534
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
535
- * @default false
536
- */
537
- inheritAllowedComponents: boolean;
538
- /** @description Minimum valid number of components in this slot */
539
- minComponents?: number;
540
- /** @description Maximum valid number of components in this slot */
541
- maxComponents?: number;
542
- };
543
- /** @description The definition of a composition's slug settings */
544
- ComponentDefinitionSlugSettings: {
545
- /**
546
- * @description Whether the slug is required
547
- * no: slug is optional
548
- * yes: slug is required
549
- * disabled: slug is disabled and will not be shown in the editor
550
- *
551
- * @default no
552
- * @enum {string}
553
- */
554
- required?: "no" | "yes" | "disabled";
555
- /**
556
- * @description Slug uniqueness configuration.
557
- * no = no unique constraint
558
- * local = must be unique within this component type
559
- * global = must be unique across all component types
560
- *
561
- * @enum {string}
562
- */
563
- unique?: "no" | "local" | "global";
564
- /** @description Regular expression slugs must match */
565
- regularExpression?: string;
566
- /**
567
- * @description Custom error message when regular expression validation fails.
568
- * Has no effect if `regularExpression` is not set.
569
- */
570
- regularExpressionMessage?: string;
571
- };
572
- /** @description The definition of a component variant */
573
- ComponentDefinitionVariant: {
574
- id: components$2["schemas"]["PublicIdProperty"];
575
- /** @description Friendly name of the variant */
576
- name: string;
577
- };
578
- /** @description Permission set for a component defintion */
579
- ComponentDefinitionPermission: {
580
- roleId: components$2["schemas"]["PublicIdProperty"];
581
- /**
582
- * @description Permission type for this permission ComponentDefinition:
583
- * read | write | create | delete
584
- *
585
- * @enum {string}
586
- */
587
- permission: "read" | "write" | "create" | "delete";
588
- /** @description State of the component that this permission applies to */
589
- state: number;
71
+ /** @description Permission set for a component defintion */
72
+ ComponentDefinitionPermission: {
73
+ roleId: components$2["schemas"]["PublicIdProperty"];
74
+ /**
75
+ * @description Permission type for this permission ComponentDefinition:
76
+ * read | write | create | delete
77
+ *
78
+ * @enum {string}
79
+ */
80
+ permission: "read" | "write" | "create" | "delete";
81
+ /** @description State of the component that this permission applies to */
82
+ state: number;
590
83
  };
591
84
  /** @description Defines a component type that can live on a Composition */
592
85
  ComponentDefinition: {
@@ -715,25 +208,16 @@ interface components$2 {
715
208
  _slug?: string | null;
716
209
  /** @description Friendly name of this component. */
717
210
  _name: string;
211
+ /** @description Branch of this component. */
212
+ _branch: string;
718
213
  _dataResources?: components$2["schemas"]["DataResourceDefinitions"];
719
214
  };
720
215
  /**
721
216
  * @deprecated
722
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
723
- */
724
- DataSourceInfo: {
725
- /** @description Public ID of the data source */
726
- id: string;
727
- /** @description Display name of the data source */
728
- displayName: string;
729
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
730
- connectorType: string;
731
- /** @description Base resource URL of the data source. No trailing slash. */
732
- baseUrl: string;
733
- };
734
- /**
735
- * @deprecated
736
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
217
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
218
+ * These are created in the UI and shared across a whole project.
219
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
220
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
737
221
  */
738
222
  DataSource: {
739
223
  /** @description Public ID of the data source */
@@ -785,8 +269,15 @@ interface components$2 {
785
269
  allowedOnComponents?: string[];
786
270
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
787
271
  path: string;
788
- /** @description Time-to-live for the resource data cache. */
272
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
789
273
  ttl?: number;
274
+ /** @description Long term data resource cache configuration. */
275
+ longTermCache?: {
276
+ /** @description A flag to turn the long term cache on. */
277
+ enabled: boolean;
278
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
279
+ ttlInHours?: number;
280
+ };
790
281
  /** @description A key for the resource data cache purging. */
791
282
  purgeKey?: string;
792
283
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -822,51 +313,556 @@ interface components$2 {
822
313
  [key: string]: unknown;
823
314
  };
824
315
  };
825
- /**
826
- * @deprecated
827
- * @description Defines the shape of a data variable on a Data Source or Data Type
828
- */
829
- DataVariableDefinition: {
830
- /** @description Display name of the data variable */
831
- displayName?: string;
832
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
833
- helpText?: string;
834
- /**
835
- * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
836
- * @default text
837
- */
838
- type?: string;
839
- /** @description Default value of the data variable */
840
- default: string;
841
- /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
842
- order?: number;
843
- };
844
- /**
845
- * @deprecated
846
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
847
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
848
- */
849
- DataResourceDefinitions: {
850
- [key: string]: components$2["schemas"]["DataResourceDefinition"];
851
- };
852
- /**
853
- * @deprecated
854
- * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
855
- */
856
- DataResourceDefinition: {
857
- /** @description Public ID of the data type that provides this data */
858
- type: string;
859
- /** @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. */
860
- isPatternParameter?: boolean;
861
- variables?: components$2["schemas"]["DataResourceVariables"];
862
- };
863
- /**
864
- * @deprecated
865
- * @description Variable values for a data resource.
866
- */
867
- DataResourceVariables: {
868
- [key: string]: string;
869
- };
316
+ /**
317
+ * @deprecated
318
+ * @description Defines the shape of a data variable on a Data Source or Data Type
319
+ */
320
+ DataVariableDefinition: {
321
+ /** @description Display name of the data variable */
322
+ displayName?: string;
323
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
324
+ helpText?: string;
325
+ /**
326
+ * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
327
+ * @default text
328
+ */
329
+ type?: string;
330
+ /** @description Default value of the data variable */
331
+ default: string;
332
+ /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
333
+ order?: number;
334
+ };
335
+ /**
336
+ * @deprecated
337
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
338
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
339
+ */
340
+ DataResourceDefinitions: {
341
+ [key: string]: components$2["schemas"]["DataResourceDefinition"];
342
+ };
343
+ /**
344
+ * @deprecated
345
+ * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
346
+ */
347
+ DataResourceDefinition: {
348
+ /** @description Public ID of the data type that provides this data */
349
+ type: string;
350
+ /** @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. */
351
+ isPatternParameter?: boolean;
352
+ variables?: components$2["schemas"]["DataResourceVariables"];
353
+ };
354
+ /**
355
+ * @deprecated
356
+ * @description Variable values for a data resource.
357
+ */
358
+ DataResourceVariables: {
359
+ [key: string]: string;
360
+ };
361
+ };
362
+ }
363
+
364
+ /**
365
+ * This file was auto-generated by openapi-typescript.
366
+ * Do not make direct changes to the file.
367
+ */
368
+ interface paths$4 {
369
+ "/api/v1/canvas-definitions": {
370
+ get: {
371
+ parameters: {
372
+ query: {
373
+ /** The project ID to get component definitions for. */
374
+ projectId: string;
375
+ /** Limit list to one result by ID (response remains an array). */
376
+ componentId?: string;
377
+ /** Number of records to skip */
378
+ offset?: number;
379
+ /** Max number of records to return */
380
+ limit?: number;
381
+ /** Whether to fetch system meta-component definitions (personalize, test, etc) */
382
+ includeSystem?: boolean;
383
+ };
384
+ };
385
+ responses: {
386
+ /** OK */
387
+ 200: {
388
+ content: {
389
+ "application/json": {
390
+ /** @description Component definitions that match the query */
391
+ componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
392
+ };
393
+ };
394
+ };
395
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
396
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
397
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
398
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
399
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
400
+ };
401
+ };
402
+ /** Upserts a component definition */
403
+ put: {
404
+ responses: {
405
+ /** OK */
406
+ 204: never;
407
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
408
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
409
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
410
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
411
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
412
+ };
413
+ requestBody: {
414
+ content: {
415
+ "application/json": {
416
+ /**
417
+ * Format: uuid
418
+ * @description The project ID to upsert the component definition to
419
+ */
420
+ projectId: string;
421
+ componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
422
+ };
423
+ };
424
+ };
425
+ };
426
+ /** Deletes a component definition */
427
+ delete: {
428
+ responses: {
429
+ /** OK */
430
+ 204: never;
431
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
432
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
433
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
434
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
435
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
436
+ };
437
+ requestBody: {
438
+ content: {
439
+ "application/json": {
440
+ /** @description The public ID of the component definition to delete */
441
+ componentId: string;
442
+ /**
443
+ * Format: uuid
444
+ * @description The ID of the project the composition to delete belongs to
445
+ */
446
+ projectId: string;
447
+ };
448
+ };
449
+ };
450
+ };
451
+ /** Handles preflight requests. This endpoint allows CORS. */
452
+ options: {
453
+ responses: {
454
+ /** OK */
455
+ 204: never;
456
+ };
457
+ };
458
+ };
459
+ }
460
+ interface external$5 {
461
+ "swagger.yml": {
462
+ paths: {};
463
+ components: {
464
+ schemas: {
465
+ Error: {
466
+ /** @description Error message(s) that occurred while processing the request */
467
+ errorMessage?: string[] | string;
468
+ };
469
+ };
470
+ responses: {
471
+ /** Request input validation failed */
472
+ BadRequestError: {
473
+ content: {
474
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
475
+ };
476
+ };
477
+ /** API key or token was not valid */
478
+ UnauthorizedError: {
479
+ content: {
480
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
481
+ };
482
+ };
483
+ /** Permission was denied */
484
+ ForbiddenError: {
485
+ content: {
486
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
487
+ };
488
+ };
489
+ /** Resource not found */
490
+ NotFoundError: {
491
+ content: {
492
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
493
+ };
494
+ };
495
+ /** Too many requests in allowed time period */
496
+ RateLimitError: unknown;
497
+ /** Execution error occurred */
498
+ InternalServerError: unknown;
499
+ };
500
+ };
501
+ operations: {};
502
+ };
503
+ "uniform-canvas-types.swagger.yml": {
504
+ paths: {};
505
+ components: {
506
+ schemas: {
507
+ /** @description Public ID (used in code). Do not change after creation. */
508
+ PublicIdProperty: string;
509
+ /** @description The definition of a component parameter */
510
+ ComponentDefinitionParameter: {
511
+ id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
512
+ /** @description Friendly name of the parameter */
513
+ name: string;
514
+ /** @description Appears next to the parameter in the Composition editor */
515
+ helpText?: string;
516
+ /** @description Type name of the parameter (provided by a Uniform integration) */
517
+ type: string;
518
+ /** @description The configuration object for the type (type-specific) */
519
+ typeConfig?: unknown;
520
+ };
521
+ /** @description The definition of a named component slot that can contain other components */
522
+ ComponentDefinitionSlot: {
523
+ id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
524
+ /** @description Friendly name of the slot */
525
+ name: string;
526
+ /** @description A list of component definition public IDs that are allowed in this named slot */
527
+ allowedComponents: string[];
528
+ /**
529
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
530
+ * @default false
531
+ */
532
+ inheritAllowedComponents: boolean;
533
+ /** @description Minimum valid number of components in this slot */
534
+ minComponents?: number;
535
+ /** @description Maximum valid number of components in this slot */
536
+ maxComponents?: number;
537
+ };
538
+ /** @description The definition of a composition's slug settings */
539
+ ComponentDefinitionSlugSettings: {
540
+ /**
541
+ * @description Whether the slug is required
542
+ * no: slug is optional
543
+ * yes: slug is required
544
+ * disabled: slug is disabled and will not be shown in the editor
545
+ *
546
+ * @default no
547
+ * @enum {string}
548
+ */
549
+ required?: "no" | "yes" | "disabled";
550
+ /**
551
+ * @description Slug uniqueness configuration.
552
+ * no = no unique constraint
553
+ * local = must be unique within this component type
554
+ * global = must be unique across all component types
555
+ *
556
+ * @enum {string}
557
+ */
558
+ unique?: "no" | "local" | "global";
559
+ /** @description Regular expression slugs must match */
560
+ regularExpression?: string;
561
+ /**
562
+ * @description Custom error message when regular expression validation fails.
563
+ * Has no effect if `regularExpression` is not set.
564
+ */
565
+ regularExpressionMessage?: string;
566
+ };
567
+ /** @description The definition of a component variant */
568
+ ComponentDefinitionVariant: {
569
+ id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
570
+ /** @description Friendly name of the variant */
571
+ name: string;
572
+ };
573
+ /** @description Permission set for a component defintion */
574
+ ComponentDefinitionPermission: {
575
+ roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
576
+ /**
577
+ * @description Permission type for this permission ComponentDefinition:
578
+ * read | write | create | delete
579
+ *
580
+ * @enum {string}
581
+ */
582
+ permission: "read" | "write" | "create" | "delete";
583
+ /** @description State of the component that this permission applies to */
584
+ state: number;
585
+ };
586
+ /** @description Defines a component type that can live on a Composition */
587
+ ComponentDefinition: {
588
+ id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
589
+ /** @description Friendly name of the component definition */
590
+ name: string;
591
+ /**
592
+ * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
593
+ * @default screen
594
+ */
595
+ icon?: string;
596
+ /**
597
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
598
+ * The parameter type must support being used as a title parameter for this to work.
599
+ */
600
+ titleParameter?: string | null;
601
+ /**
602
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
603
+ * @default false
604
+ */
605
+ canBeComposition?: boolean;
606
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
607
+ parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
608
+ /**
609
+ * @description if this component uses team permissions or custom permissions
610
+ * @default true
611
+ */
612
+ useTeamPermissions?: boolean;
613
+ /** @description Custom role permissions for this component definition */
614
+ permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
615
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
616
+ slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
617
+ slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
618
+ /** @description Default component instance value */
619
+ defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
620
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
621
+ variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
622
+ /** @description Created date string for this definition (ignored for writes) */
623
+ created?: string;
624
+ /** @description Last modified date string for this definition (ignored for writes) */
625
+ updated?: string;
626
+ };
627
+ /** @description Defines an editable parameter on a component. */
628
+ ComponentParameter: {
629
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
630
+ value: unknown;
631
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
632
+ type: string;
633
+ connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
634
+ };
635
+ /**
636
+ * @deprecated
637
+ * @description Defines a connection to a data element on a data resource. Do not use.
638
+ */
639
+ DataElementConnectionDefinition: {
640
+ /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
641
+ pointer: string;
642
+ /**
643
+ * @description The syntax used to select the data element to bind to
644
+ * @enum {string}
645
+ */
646
+ syntax: "jptr";
647
+ /**
648
+ * @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
649
+ * In all cases the binding process will remove the parameter data for the unresolvable data element.
650
+ * When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
651
+ *
652
+ * @default false
653
+ */
654
+ required?: boolean;
655
+ };
656
+ /** @description Defines the shape of a component instance served by the composition API. */
657
+ ComponentInstance: {
658
+ /** @description Type of the component instance (public_id of its definition) */
659
+ type: string;
660
+ /** @description Component parameter values for the component instance */
661
+ parameters?: {
662
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
663
+ };
664
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
665
+ variant?: string;
666
+ /** @description Slots containing any child components */
667
+ slots?: {
668
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
669
+ };
670
+ /** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
671
+ _id?: string;
672
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
673
+ _pattern?: string;
674
+ _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
675
+ /**
676
+ * @deprecated
677
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
678
+ * Means nothing for PUTs; it will be ignored.
679
+ */
680
+ _patternDataResources?: {
681
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
682
+ };
683
+ /**
684
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
685
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
686
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
687
+ * Means nothing for PUTs; it will be ignored.
688
+ *
689
+ * @enum {string}
690
+ */
691
+ _patternError?: "NOTFOUND" | "CYCLIC";
692
+ };
693
+ /** @description Defines the shape of the root component in a composition */
694
+ RootComponentInstance: {
695
+ /** @description Type of the component instance (public_id of its definition) */
696
+ type: string;
697
+ /** @description Component parameter values for the component instance */
698
+ parameters?: {
699
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
700
+ };
701
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
702
+ variant?: string;
703
+ /** @description Slots containing any child components */
704
+ slots?: {
705
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
706
+ };
707
+ /** @description The public UUID of the composition. */
708
+ _id: string;
709
+ /** @description Slug pattern of this component. */
710
+ _slug?: string | null;
711
+ /** @description Friendly name of this component. */
712
+ _name: string;
713
+ /** @description Branch of this component. */
714
+ _branch: string;
715
+ _dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
716
+ };
717
+ /**
718
+ * @deprecated
719
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
720
+ * These are created in the UI and shared across a whole project.
721
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
722
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
723
+ */
724
+ DataSource: {
725
+ /** @description Public ID of the data source */
726
+ id: string;
727
+ /** @description Display name of the data source */
728
+ displayName: string;
729
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
730
+ connectorType: string;
731
+ /** @description Base resource URL of the data source. No trailing slash. */
732
+ baseUrl: string;
733
+ headers?: {
734
+ [key: string]: string;
735
+ } | {
736
+ key: string;
737
+ value: string;
738
+ }[];
739
+ parameters?: {
740
+ [key: string]: string;
741
+ } | {
742
+ key: string;
743
+ value: string;
744
+ }[];
745
+ /** @description Variables needed to make calls to the data source */
746
+ variables?: {
747
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
748
+ };
749
+ /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
750
+ custom?: {
751
+ [key: string]: unknown;
752
+ };
753
+ };
754
+ /**
755
+ * @deprecated
756
+ * @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
757
+ */
758
+ DataType: {
759
+ /** @description Public ID of the data type */
760
+ id: string;
761
+ /** @description Display name of the data type */
762
+ displayName: string;
763
+ /** @description Public ID of the associated data source */
764
+ dataSourceId: string;
765
+ /**
766
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
767
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
768
+ * no special UI or processing is required.
769
+ */
770
+ archetype?: string;
771
+ allowedOnComponents?: string[];
772
+ /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
773
+ path: string;
774
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
775
+ ttl?: number;
776
+ /** @description Long term data resource cache configuration. */
777
+ longTermCache?: {
778
+ /** @description A flag to turn the long term cache on. */
779
+ enabled: boolean;
780
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
781
+ ttlInHours?: number;
782
+ };
783
+ /** @description A key for the resource data cache purging. */
784
+ purgeKey?: string;
785
+ /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
786
+ badgeIconUrl?: string;
787
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
788
+ headers?: {
789
+ [key: string]: string;
790
+ } | {
791
+ key: string;
792
+ value: string;
793
+ }[];
794
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
795
+ parameters?: {
796
+ [key: string]: string;
797
+ } | {
798
+ key: string;
799
+ value: string;
800
+ }[];
801
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
802
+ body?: string;
803
+ /**
804
+ * @description HTTP method to use with requests to the data type.
805
+ * @default GET
806
+ * @enum {string}
807
+ */
808
+ method: "GET" | "POST" | "HEAD";
809
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
810
+ variables?: {
811
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
812
+ };
813
+ /** @description Custom configuration specific to the data source being defined */
814
+ custom?: {
815
+ [key: string]: unknown;
816
+ };
817
+ };
818
+ /**
819
+ * @deprecated
820
+ * @description Defines the shape of a data variable on a Data Source or Data Type
821
+ */
822
+ DataVariableDefinition: {
823
+ /** @description Display name of the data variable */
824
+ displayName?: string;
825
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
826
+ helpText?: string;
827
+ /**
828
+ * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
829
+ * @default text
830
+ */
831
+ type?: string;
832
+ /** @description Default value of the data variable */
833
+ default: string;
834
+ /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
835
+ order?: number;
836
+ };
837
+ /**
838
+ * @deprecated
839
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
840
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
841
+ */
842
+ DataResourceDefinitions: {
843
+ [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
844
+ };
845
+ /**
846
+ * @deprecated
847
+ * @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
848
+ */
849
+ DataResourceDefinition: {
850
+ /** @description Public ID of the data type that provides this data */
851
+ type: string;
852
+ /** @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. */
853
+ isPatternParameter?: boolean;
854
+ variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
855
+ };
856
+ /**
857
+ * @deprecated
858
+ * @description Variable values for a data resource.
859
+ */
860
+ DataResourceVariables: {
861
+ [key: string]: string;
862
+ };
863
+ };
864
+ };
865
+ operations: {};
870
866
  };
871
867
  }
872
868
 
@@ -986,6 +982,10 @@ interface paths$3 {
986
982
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
987
983
  */
988
984
  withUIStatus?: components$1["parameters"]["withUIStatus"];
985
+ /** Specify the branch to retrieve the composition from. */
986
+ branch?: components$1["parameters"]["branch"];
987
+ /** Disable branch inheritance */
988
+ disableBranchInheritance?: components$1["parameters"]["disableBranchInheritance"];
989
989
  };
990
990
  };
991
991
  responses: {
@@ -1039,6 +1039,8 @@ interface paths$3 {
1039
1039
  created?: string;
1040
1040
  /** @description Ignored if present */
1041
1041
  modified?: string;
1042
+ /** @description Branch to write composition to */
1043
+ branch?: string;
1042
1044
  };
1043
1045
  };
1044
1046
  };
@@ -1194,6 +1196,10 @@ interface components$1 {
1194
1196
  * Has no effect when not fetching a list. This does impact performance when enabled.
1195
1197
  */
1196
1198
  withTotalCount: boolean;
1199
+ /** @description Specify the branch to retrieve the composition from. */
1200
+ branch: string;
1201
+ /** @description Disable branch inheritance */
1202
+ disableBranchInheritance: boolean;
1197
1203
  };
1198
1204
  }
1199
1205
  interface external$4 {
@@ -1449,25 +1455,16 @@ interface external$4 {
1449
1455
  _slug?: string | null;
1450
1456
  /** @description Friendly name of this component. */
1451
1457
  _name: string;
1458
+ /** @description Branch of this component. */
1459
+ _branch: string;
1452
1460
  _dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1453
1461
  };
1454
1462
  /**
1455
1463
  * @deprecated
1456
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
1457
- */
1458
- DataSourceInfo: {
1459
- /** @description Public ID of the data source */
1460
- id: string;
1461
- /** @description Display name of the data source */
1462
- displayName: string;
1463
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1464
- connectorType: string;
1465
- /** @description Base resource URL of the data source. No trailing slash. */
1466
- baseUrl: string;
1467
- };
1468
- /**
1469
- * @deprecated
1470
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
1464
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
1465
+ * These are created in the UI and shared across a whole project.
1466
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
1467
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
1471
1468
  */
1472
1469
  DataSource: {
1473
1470
  /** @description Public ID of the data source */
@@ -1519,8 +1516,15 @@ interface external$4 {
1519
1516
  allowedOnComponents?: string[];
1520
1517
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1521
1518
  path: string;
1522
- /** @description Time-to-live for the resource data cache. */
1519
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
1523
1520
  ttl?: number;
1521
+ /** @description Long term data resource cache configuration. */
1522
+ longTermCache?: {
1523
+ /** @description A flag to turn the long term cache on. */
1524
+ enabled: boolean;
1525
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
1526
+ ttlInHours?: number;
1527
+ };
1524
1528
  /** @description A key for the resource data cache purging. */
1525
1529
  purgeKey?: string;
1526
1530
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -1630,6 +1634,7 @@ interface components {
1630
1634
  total: number;
1631
1635
  retryCount: number;
1632
1636
  retryDelay: number;
1637
+ sourceCache?: string;
1633
1638
  };
1634
1639
  data: unknown;
1635
1640
  };
@@ -1969,25 +1974,16 @@ interface external$3 {
1969
1974
  _slug?: string | null;
1970
1975
  /** @description Friendly name of this component. */
1971
1976
  _name: string;
1977
+ /** @description Branch of this component. */
1978
+ _branch: string;
1972
1979
  _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1973
1980
  };
1974
1981
  /**
1975
1982
  * @deprecated
1976
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
1977
- */
1978
- DataSourceInfo: {
1979
- /** @description Public ID of the data source */
1980
- id: string;
1981
- /** @description Display name of the data source */
1982
- displayName: string;
1983
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
1984
- connectorType: string;
1985
- /** @description Base resource URL of the data source. No trailing slash. */
1986
- baseUrl: string;
1987
- };
1988
- /**
1989
- * @deprecated
1990
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
1983
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
1984
+ * These are created in the UI and shared across a whole project.
1985
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
1986
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
1991
1987
  */
1992
1988
  DataSource: {
1993
1989
  /** @description Public ID of the data source */
@@ -2039,8 +2035,15 @@ interface external$3 {
2039
2035
  allowedOnComponents?: string[];
2040
2036
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
2041
2037
  path: string;
2042
- /** @description Time-to-live for the resource data cache. */
2038
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
2043
2039
  ttl?: number;
2040
+ /** @description Long term data resource cache configuration. */
2041
+ longTermCache?: {
2042
+ /** @description A flag to turn the long term cache on. */
2043
+ enabled: boolean;
2044
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
2045
+ ttlInHours?: number;
2046
+ };
2044
2047
  /** @description A key for the resource data cache purging. */
2045
2048
  purgeKey?: string;
2046
2049
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -2203,6 +2206,10 @@ interface external$3 {
2203
2206
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2204
2207
  */
2205
2208
  withUIStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
2209
+ /** Specify the branch to retrieve the composition from. */
2210
+ branch?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["branch"];
2211
+ /** Disable branch inheritance */
2212
+ disableBranchInheritance?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["disableBranchInheritance"];
2206
2213
  };
2207
2214
  };
2208
2215
  responses: {
@@ -2256,6 +2263,8 @@ interface external$3 {
2256
2263
  created?: string;
2257
2264
  /** @description Ignored if present */
2258
2265
  modified?: string;
2266
+ /** @description Branch to write composition to */
2267
+ branch?: string;
2259
2268
  };
2260
2269
  };
2261
2270
  };
@@ -2411,6 +2420,10 @@ interface external$3 {
2411
2420
  * Has no effect when not fetching a list. This does impact performance when enabled.
2412
2421
  */
2413
2422
  withTotalCount: boolean;
2423
+ /** @description Specify the branch to retrieve the composition from. */
2424
+ branch: string;
2425
+ /** @description Disable branch inheritance */
2426
+ disableBranchInheritance: boolean;
2414
2427
  };
2415
2428
  };
2416
2429
  operations: {};
@@ -2559,10 +2572,11 @@ declare type CompositionGetValidResponses = CompositionGetResponse | Composition
2559
2572
  * Do not make direct changes to the file.
2560
2573
  */
2561
2574
  interface paths$2 {
2562
- "/api/v1/data-types": {
2575
+ "/api/v1/data-source": {
2563
2576
  get: {
2564
2577
  parameters: {
2565
2578
  query: {
2579
+ dataSourceId: string;
2566
2580
  projectId: string;
2567
2581
  };
2568
2582
  };
@@ -2571,7 +2585,7 @@ interface paths$2 {
2571
2585
  200: {
2572
2586
  content: {
2573
2587
  "application/json": {
2574
- results: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
2588
+ result: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
2575
2589
  };
2576
2590
  };
2577
2591
  };
@@ -2595,9 +2609,11 @@ interface paths$2 {
2595
2609
  requestBody: {
2596
2610
  content: {
2597
2611
  "application/json": {
2598
- data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
2612
+ data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
2599
2613
  /** Format: uuid */
2600
2614
  projectId: string;
2615
+ /** Format: uuid */
2616
+ integrationId: string;
2601
2617
  };
2602
2618
  };
2603
2619
  };
@@ -2615,7 +2631,7 @@ interface paths$2 {
2615
2631
  requestBody: {
2616
2632
  content: {
2617
2633
  "application/json": {
2618
- typeId: string;
2634
+ dataSourceId: string;
2619
2635
  /** Format: uuid */
2620
2636
  projectId: string;
2621
2637
  };
@@ -2877,25 +2893,16 @@ interface external$2 {
2877
2893
  _slug?: string | null;
2878
2894
  /** @description Friendly name of this component. */
2879
2895
  _name: string;
2896
+ /** @description Branch of this component. */
2897
+ _branch: string;
2880
2898
  _dataResources?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2881
2899
  };
2882
2900
  /**
2883
2901
  * @deprecated
2884
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
2885
- */
2886
- DataSourceInfo: {
2887
- /** @description Public ID of the data source */
2888
- id: string;
2889
- /** @description Display name of the data source */
2890
- displayName: string;
2891
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
2892
- connectorType: string;
2893
- /** @description Base resource URL of the data source. No trailing slash. */
2894
- baseUrl: string;
2895
- };
2896
- /**
2897
- * @deprecated
2898
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
2902
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
2903
+ * These are created in the UI and shared across a whole project.
2904
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
2905
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
2899
2906
  */
2900
2907
  DataSource: {
2901
2908
  /** @description Public ID of the data source */
@@ -2947,8 +2954,15 @@ interface external$2 {
2947
2954
  allowedOnComponents?: string[];
2948
2955
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
2949
2956
  path: string;
2950
- /** @description Time-to-live for the resource data cache. */
2957
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
2951
2958
  ttl?: number;
2959
+ /** @description Long term data resource cache configuration. */
2960
+ longTermCache?: {
2961
+ /** @description A flag to turn the long term cache on. */
2962
+ enabled: boolean;
2963
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
2964
+ ttlInHours?: number;
2965
+ };
2952
2966
  /** @description A key for the resource data cache purging. */
2953
2967
  purgeKey?: string;
2954
2968
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -3040,20 +3054,24 @@ interface external$2 {
3040
3054
  * Do not make direct changes to the file.
3041
3055
  */
3042
3056
  interface paths$1 {
3043
- "/api/v1/data-source": {
3057
+ "/api/v1/data-sources": {
3044
3058
  get: {
3045
3059
  parameters: {
3046
3060
  query: {
3047
- dataSourceId: string;
3048
3061
  projectId: string;
3049
3062
  };
3050
3063
  };
3051
3064
  responses: {
3052
- /** OK */
3065
+ /**
3066
+ * Gets a list of data sources.
3067
+ * Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
3068
+ * requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
3069
+ * user, and fetch using the `data-source` endpoint for each data source.
3070
+ */
3053
3071
  200: {
3054
3072
  content: {
3055
3073
  "application/json": {
3056
- result: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
3074
+ results: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
3057
3075
  };
3058
3076
  };
3059
3077
  };
@@ -3064,48 +3082,6 @@ interface paths$1 {
3064
3082
  500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
3065
3083
  };
3066
3084
  };
3067
- put: {
3068
- responses: {
3069
- /** OK */
3070
- 204: never;
3071
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
3072
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3073
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3074
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
3075
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
3076
- };
3077
- requestBody: {
3078
- content: {
3079
- "application/json": {
3080
- data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
3081
- /** Format: uuid */
3082
- projectId: string;
3083
- /** Format: uuid */
3084
- integrationId: string;
3085
- };
3086
- };
3087
- };
3088
- };
3089
- delete: {
3090
- responses: {
3091
- /** OK */
3092
- 204: never;
3093
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
3094
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3095
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3096
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
3097
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
3098
- };
3099
- requestBody: {
3100
- content: {
3101
- "application/json": {
3102
- dataSourceId: string;
3103
- /** Format: uuid */
3104
- projectId: string;
3105
- };
3106
- };
3107
- };
3108
- };
3109
3085
  };
3110
3086
  }
3111
3087
  interface external$1 {
@@ -3361,25 +3337,16 @@ interface external$1 {
3361
3337
  _slug?: string | null;
3362
3338
  /** @description Friendly name of this component. */
3363
3339
  _name: string;
3340
+ /** @description Branch of this component. */
3341
+ _branch: string;
3364
3342
  _dataResources?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3365
3343
  };
3366
3344
  /**
3367
3345
  * @deprecated
3368
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
3369
- */
3370
- DataSourceInfo: {
3371
- /** @description Public ID of the data source */
3372
- id: string;
3373
- /** @description Display name of the data source */
3374
- displayName: string;
3375
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
3376
- connectorType: string;
3377
- /** @description Base resource URL of the data source. No trailing slash. */
3378
- baseUrl: string;
3379
- };
3380
- /**
3381
- * @deprecated
3382
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
3346
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
3347
+ * These are created in the UI and shared across a whole project.
3348
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
3349
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
3383
3350
  */
3384
3351
  DataSource: {
3385
3352
  /** @description Public ID of the data source */
@@ -3431,8 +3398,15 @@ interface external$1 {
3431
3398
  allowedOnComponents?: string[];
3432
3399
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
3433
3400
  path: string;
3434
- /** @description Time-to-live for the resource data cache. */
3401
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
3435
3402
  ttl?: number;
3403
+ /** @description Long term data resource cache configuration. */
3404
+ longTermCache?: {
3405
+ /** @description A flag to turn the long term cache on. */
3406
+ enabled: boolean;
3407
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
3408
+ ttlInHours?: number;
3409
+ };
3436
3410
  /** @description A key for the resource data cache purging. */
3437
3411
  purgeKey?: string;
3438
3412
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -3524,7 +3498,7 @@ interface external$1 {
3524
3498
  * Do not make direct changes to the file.
3525
3499
  */
3526
3500
  interface paths {
3527
- "/api/v1/data-sources": {
3501
+ "/api/v1/data-types": {
3528
3502
  get: {
3529
3503
  parameters: {
3530
3504
  query: {
@@ -3536,7 +3510,7 @@ interface paths {
3536
3510
  200: {
3537
3511
  content: {
3538
3512
  "application/json": {
3539
- results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSourceInfo"][];
3513
+ results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
3540
3514
  };
3541
3515
  };
3542
3516
  };
@@ -3547,6 +3521,46 @@ interface paths {
3547
3521
  500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
3548
3522
  };
3549
3523
  };
3524
+ put: {
3525
+ responses: {
3526
+ /** OK */
3527
+ 204: never;
3528
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
3529
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3530
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3531
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
3532
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
3533
+ };
3534
+ requestBody: {
3535
+ content: {
3536
+ "application/json": {
3537
+ data: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
3538
+ /** Format: uuid */
3539
+ projectId: string;
3540
+ };
3541
+ };
3542
+ };
3543
+ };
3544
+ delete: {
3545
+ responses: {
3546
+ /** OK */
3547
+ 204: never;
3548
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
3549
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3550
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3551
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
3552
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
3553
+ };
3554
+ requestBody: {
3555
+ content: {
3556
+ "application/json": {
3557
+ typeId: string;
3558
+ /** Format: uuid */
3559
+ projectId: string;
3560
+ };
3561
+ };
3562
+ };
3563
+ };
3550
3564
  };
3551
3565
  }
3552
3566
  interface external {
@@ -3802,25 +3816,16 @@ interface external {
3802
3816
  _slug?: string | null;
3803
3817
  /** @description Friendly name of this component. */
3804
3818
  _name: string;
3819
+ /** @description Branch of this component. */
3820
+ _branch: string;
3805
3821
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3806
3822
  };
3807
3823
  /**
3808
3824
  * @deprecated
3809
- * @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
3810
- */
3811
- DataSourceInfo: {
3812
- /** @description Public ID of the data source */
3813
- id: string;
3814
- /** @description Display name of the data source */
3815
- displayName: string;
3816
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
3817
- connectorType: string;
3818
- /** @description Base resource URL of the data source. No trailing slash. */
3819
- baseUrl: string;
3820
- };
3821
- /**
3822
- * @deprecated
3823
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
3825
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
3826
+ * These are created in the UI and shared across a whole project.
3827
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
3828
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
3824
3829
  */
3825
3830
  DataSource: {
3826
3831
  /** @description Public ID of the data source */
@@ -3872,8 +3877,15 @@ interface external {
3872
3877
  allowedOnComponents?: string[];
3873
3878
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
3874
3879
  path: string;
3875
- /** @description Time-to-live for the resource data cache. */
3880
+ /** @description Time-to-live (in seconds) for the primary resource data cache. */
3876
3881
  ttl?: number;
3882
+ /** @description Long term data resource cache configuration. */
3883
+ longTermCache?: {
3884
+ /** @description A flag to turn the long term cache on. */
3885
+ enabled: boolean;
3886
+ /** @description Time-to-live (in hours) for the long term resource data cache. */
3887
+ ttlInHours?: number;
3888
+ };
3877
3889
  /** @description A key for the resource data cache purging. */
3878
3890
  purgeKey?: string;
3879
3891
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -3960,9 +3972,9 @@ interface external {
3960
3972
  };
3961
3973
  }
3962
3974
 
3963
- declare type DataTypeApi = paths$2['/api/v1/data-types'];
3964
- declare type DataSourcesApi = paths['/api/v1/data-sources'];
3965
- declare type DataSourceApi = paths$1['/api/v1/data-source'];
3975
+ declare type DataTypeApi = paths['/api/v1/data-types'];
3976
+ declare type DataSourcesApi = paths$1['/api/v1/data-sources'];
3977
+ declare type DataSourceApi = paths$2['/api/v1/data-source'];
3966
3978
  /** Query parameter options for GET /api/v1/data-types */
3967
3979
  declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
3968
3980
  /** The GET response from /api/v1/data-types */
@@ -3985,7 +3997,6 @@ declare type DataSourcePutParameters = DataSourceApi['put']['requestBody']['cont
3985
3997
  declare type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
3986
3998
  declare type DataType = components$2['schemas']['DataType'];
3987
3999
  declare type DataSource = components$2['schemas']['DataSource'];
3988
- declare type DataSourceInfo = components$2['schemas']['DataSourceInfo'];
3989
4000
  declare type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
3990
4001
 
3991
4002
  /**
@@ -4013,4 +4024,4 @@ declare global {
4013
4024
  */
4014
4025
  declare function createEventBus(): Promise<PreviewEventBus | undefined>;
4015
4026
 
4016
- export { CanvasDefinitions as $, ComponentDefinitionGetResponse as A, ComponentDefinitionAPIResponse as B, ComponentInstance as C, DataResolutionOptionNegative as D, ComponentDefinitionAPIPutRequest as E, ComponentDefinitionAPIDeleteRequest as F, ComponentDefinitionListAPIOptions as G, ComponentDefinitionParameter as H, ComponentDefinitionVariant as I, ComponentDefinitionSlugSettings as J, ComponentDefinitionSlot as K, ComponentDefinitionPermission as L, ComponentDefinition as M, CreatingComponentDefinition as N, CompositionGetOrderBy as O, PreviewEventBus as P, CompositionUIStatus as Q, RootComponentInstance as R, CompositionGetListResponse as S, CompositionAPIResponse as T, CompositionAPIDeleteRequest as U, CompositionListAPIResponse as V, CompositionAPIOptions as W, DataElementConnectionDefinition as X, DataResourceVariables as Y, DataResourceDefinitions as Z, DataResourceDefinition as _, ComponentParameter as a, CompositionIssue as a0, CompositionPatternIssue as a1, DataElementBindingIssue as a2, DataResourceIssue as a3, DataResourceVariableIssue as a4, DataResolutionConfigIssue as a5, CompositionDataDiagnostic as a6, DataSourceGetResponse as a7, DataSourcesGetResponse as a8, DataType as a9, DataSource as aa, DataSourceInfo as ab, DataVariableDefinition as ac, ChannelSubscription as ad, createEventBus as ae, CompositionGetParameters as b, components as c, CompositionGetByNodePathParameters as d, CompositionGetResponse as e, DataResolutionOptionPositive as f, DataResolutionParameters as g, CompositionResolvedGetResponse as h, CompositionGetValidResponses as i, DataResolutionOption as j, CompositionGetByNodeIdParameters as k, CompositionGetBySlugParameters as l, CompositionGetByIdParameters as m, CompositionPutParameters as n, CompositionDeleteParameters as o, ComponentDefinitionGetParameters as p, ComponentDefinitionPutParameters as q, ComponentDefinitionDeleteParameters as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
4027
+ export { DataResourceDefinitions as $, ChannelSubscription as A, createEventBus as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, ComponentDefinitionGetResponse as E, ComponentDefinitionAPIResponse as F, ComponentDefinitionAPIPutRequest as G, ComponentDefinitionAPIDeleteRequest as H, ComponentDefinitionListAPIOptions as I, ComponentDefinitionParameter as J, ComponentDefinitionVariant as K, ComponentDefinitionSlugSettings as L, ComponentDefinitionSlot as M, ComponentDefinitionPermission as N, ComponentDefinition as O, PreviewEventBus as P, CreatingComponentDefinition as Q, RootComponentInstance as R, CompositionGetOrderBy as S, CompositionUIStatus as T, CompositionGetListResponse as U, CompositionAPIResponse as V, CompositionAPIDeleteRequest as W, CompositionListAPIResponse as X, CompositionAPIOptions as Y, DataElementConnectionDefinition as Z, DataResourceVariables as _, CompositionGetByNodePathParameters as a, DataResourceDefinition as a0, CanvasDefinitions as a1, CompositionIssue as a2, CompositionPatternIssue as a3, DataElementBindingIssue as a4, DataResourceIssue as a5, DataResourceVariableIssue as a6, DataResolutionConfigIssue as a7, CompositionDataDiagnostic as a8, DataSourceGetResponse as a9, DataSourcesGetResponse as aa, DataType as ab, DataSource as ac, DataVariableDefinition as ad, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };