@uniformdev/canvas 17.4.1-alpha.37 → 17.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -2
- package/dist/chunk-3DNK2OLJ.mjs +4 -0
- package/dist/cli/cli.d.ts +1 -1
- package/dist/cli/cli.js +60 -60
- package/dist/cli/cli.mjs +45 -45
- package/dist/{createEventBus-a8e85b6e.d.ts → createEventBus-ae757f10.d.ts} +1302 -316
- package/dist/index.d.ts +43 -400
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/package.json +5 -5
- package/dist/chunk-IK3FODEI.mjs +0 -4
- package/dist/chunk-O4RYVPVV.mjs +0 -4
- package/dist/chunk-YBMT3VRI.mjs +0 -4
- package/dist/createEventBus-33bac5ac.d.ts +0 -3030
@@ -27,15 +27,15 @@ interface paths$4 {
|
|
27
27
|
content: {
|
28
28
|
"application/json": {
|
29
29
|
/** @description Component definitions that match the query */
|
30
|
-
componentDefinitions: external$
|
30
|
+
componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
31
31
|
};
|
32
32
|
};
|
33
33
|
};
|
34
|
-
400: external$
|
35
|
-
401: external$
|
36
|
-
403: external$
|
37
|
-
429: external$
|
38
|
-
500: external$
|
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
39
|
};
|
40
40
|
};
|
41
41
|
/** Upserts a component definition */
|
@@ -43,11 +43,11 @@ interface paths$4 {
|
|
43
43
|
responses: {
|
44
44
|
/** OK */
|
45
45
|
204: never;
|
46
|
-
400: external$
|
47
|
-
401: external$
|
48
|
-
403: external$
|
49
|
-
429: external$
|
50
|
-
500: external$
|
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
51
|
};
|
52
52
|
requestBody: {
|
53
53
|
content: {
|
@@ -57,7 +57,7 @@ interface paths$4 {
|
|
57
57
|
* @description The project ID to upsert the component definition to
|
58
58
|
*/
|
59
59
|
projectId: string;
|
60
|
-
componentDefinition: external$
|
60
|
+
componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
61
61
|
};
|
62
62
|
};
|
63
63
|
};
|
@@ -67,11 +67,11 @@ interface paths$4 {
|
|
67
67
|
responses: {
|
68
68
|
/** OK */
|
69
69
|
204: never;
|
70
|
-
400: external$
|
71
|
-
401: external$
|
72
|
-
403: external$
|
73
|
-
429: external$
|
74
|
-
500: external$
|
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
75
|
};
|
76
76
|
requestBody: {
|
77
77
|
content: {
|
@@ -96,7 +96,7 @@ interface paths$4 {
|
|
96
96
|
};
|
97
97
|
};
|
98
98
|
}
|
99
|
-
interface external$
|
99
|
+
interface external$5 {
|
100
100
|
"swagger.yml": {
|
101
101
|
paths: {};
|
102
102
|
components: {
|
@@ -110,25 +110,25 @@ interface external$4 {
|
|
110
110
|
/** Request input validation failed */
|
111
111
|
BadRequestError: {
|
112
112
|
content: {
|
113
|
-
"application/json": external$
|
113
|
+
"application/json": external$5["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$
|
119
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
120
120
|
};
|
121
121
|
};
|
122
122
|
/** Permission was denied */
|
123
123
|
ForbiddenError: {
|
124
124
|
content: {
|
125
|
-
"application/json": external$
|
125
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
126
126
|
};
|
127
127
|
};
|
128
128
|
/** Resource not found */
|
129
129
|
NotFoundError: {
|
130
130
|
content: {
|
131
|
-
"application/json": external$
|
131
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
132
132
|
};
|
133
133
|
};
|
134
134
|
/** Too many requests in allowed time period */
|
@@ -147,7 +147,7 @@ interface external$4 {
|
|
147
147
|
PublicIdProperty: string;
|
148
148
|
/** @description The definition of a component parameter */
|
149
149
|
ComponentDefinitionParameter: {
|
150
|
-
id: external$
|
150
|
+
id: external$5["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$4 {
|
|
159
159
|
};
|
160
160
|
/** @description The definition of a named component slot that can contain other components */
|
161
161
|
ComponentDefinitionSlot: {
|
162
|
-
id: external$
|
162
|
+
id: external$5["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$4 {
|
|
205
205
|
};
|
206
206
|
/** @description The definition of a component variant */
|
207
207
|
ComponentDefinitionVariant: {
|
208
|
-
id: external$
|
208
|
+
id: external$5["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$
|
214
|
+
roleId: external$5["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$4 {
|
|
224
224
|
};
|
225
225
|
/** @description Defines a component type that can live on a Composition */
|
226
226
|
ComponentDefinition: {
|
227
|
-
id: external$
|
227
|
+
id: external$5["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$4 {
|
|
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$
|
246
|
+
parameters?: external$5["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$
|
253
|
+
permissions?: external$5["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$
|
256
|
-
slugSettings?: external$
|
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
257
|
/** @description Default component instance value */
|
258
|
-
defaults?: external$
|
258
|
+
defaults?: external$5["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$
|
260
|
+
variants?: external$5["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$4 {
|
|
269
269
|
value: unknown;
|
270
270
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
271
271
|
type: string;
|
272
|
-
connectedData?: external$
|
272
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
273
273
|
};
|
274
274
|
/**
|
275
275
|
* @deprecated
|
@@ -298,26 +298,26 @@ interface external$4 {
|
|
298
298
|
type: string;
|
299
299
|
/** @description Component parameter values for the component instance */
|
300
300
|
parameters?: {
|
301
|
-
[key: string]: external$
|
301
|
+
[key: string]: external$5["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$
|
307
|
+
[key: string]: external$5["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
|
-
_dataResources?: external$
|
313
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
314
314
|
/**
|
315
315
|
* @deprecated
|
316
316
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
317
317
|
* Means nothing for PUTs; it will be ignored.
|
318
318
|
*/
|
319
319
|
_patternDataResources?: {
|
320
|
-
[key: string]: external$
|
320
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
321
321
|
};
|
322
322
|
/**
|
323
323
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -335,13 +335,13 @@ interface external$4 {
|
|
335
335
|
type: string;
|
336
336
|
/** @description Component parameter values for the component instance */
|
337
337
|
parameters?: {
|
338
|
-
[key: string]: external$
|
338
|
+
[key: string]: external$5["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$
|
344
|
+
[key: string]: external$5["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$4 {
|
|
349
349
|
_slug?: string | null;
|
350
350
|
/** @description Friendly name of this component. */
|
351
351
|
_name: string;
|
352
|
-
_dataResources?: external$
|
352
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
353
353
|
};
|
354
354
|
/**
|
355
355
|
* @deprecated
|
@@ -392,7 +392,7 @@ interface external$4 {
|
|
392
392
|
}[];
|
393
393
|
/** @description Variables needed to make calls to the data source */
|
394
394
|
variables?: {
|
395
|
-
[key: string]: external$
|
395
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
396
396
|
};
|
397
397
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
398
398
|
custom?: {
|
@@ -423,12 +423,16 @@ interface external$4 {
|
|
423
423
|
ttl?: number;
|
424
424
|
/** @description A key for the resource data cache purging. */
|
425
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. */
|
426
429
|
headers?: {
|
427
430
|
[key: string]: string;
|
428
431
|
} | {
|
429
432
|
key: string;
|
430
433
|
value: string;
|
431
434
|
}[];
|
435
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
432
436
|
parameters?: {
|
433
437
|
[key: string]: string;
|
434
438
|
} | {
|
@@ -445,7 +449,7 @@ interface external$4 {
|
|
445
449
|
method: "GET" | "POST" | "HEAD";
|
446
450
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
447
451
|
variables?: {
|
448
|
-
[key: string]: external$
|
452
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
449
453
|
};
|
450
454
|
/** @description Custom configuration specific to the data source being defined */
|
451
455
|
custom?: {
|
@@ -454,23 +458,22 @@ interface external$4 {
|
|
454
458
|
};
|
455
459
|
/**
|
456
460
|
* @deprecated
|
457
|
-
* @description Defines the shape of a data variable on a Data
|
461
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
458
462
|
*/
|
459
463
|
DataVariableDefinition: {
|
460
464
|
/** @description Display name of the data variable */
|
461
465
|
displayName?: string;
|
466
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
467
|
+
helpText?: string;
|
462
468
|
/**
|
463
|
-
* @description Type of the data variable
|
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.
|
464
470
|
* @default text
|
465
471
|
*/
|
466
|
-
type
|
472
|
+
type?: string;
|
467
473
|
/** @description Default value of the data variable */
|
468
474
|
default: string;
|
469
|
-
/**
|
470
|
-
|
471
|
-
* @enum {string}
|
472
|
-
*/
|
473
|
-
setBy: "static" | "dynamic";
|
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;
|
474
477
|
};
|
475
478
|
/**
|
476
479
|
* @deprecated
|
@@ -478,7 +481,7 @@ interface external$4 {
|
|
478
481
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
479
482
|
*/
|
480
483
|
DataResourceDefinitions: {
|
481
|
-
[key: string]: external$
|
484
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
482
485
|
};
|
483
486
|
/**
|
484
487
|
* @deprecated
|
@@ -489,7 +492,7 @@ interface external$4 {
|
|
489
492
|
type: string;
|
490
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. */
|
491
494
|
isPatternParameter?: boolean;
|
492
|
-
variables?: external$
|
495
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
493
496
|
};
|
494
497
|
/**
|
495
498
|
* @deprecated
|
@@ -504,13 +507,13 @@ interface external$4 {
|
|
504
507
|
};
|
505
508
|
}
|
506
509
|
|
507
|
-
interface components$
|
510
|
+
interface components$2 {
|
508
511
|
schemas: {
|
509
512
|
/** @description Public ID (used in code). Do not change after creation. */
|
510
513
|
PublicIdProperty: string;
|
511
514
|
/** @description The definition of a component parameter */
|
512
515
|
ComponentDefinitionParameter: {
|
513
|
-
id: components$
|
516
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
514
517
|
/** @description Friendly name of the parameter */
|
515
518
|
name: string;
|
516
519
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -522,7 +525,7 @@ interface components$1 {
|
|
522
525
|
};
|
523
526
|
/** @description The definition of a named component slot that can contain other components */
|
524
527
|
ComponentDefinitionSlot: {
|
525
|
-
id: components$
|
528
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
526
529
|
/** @description Friendly name of the slot */
|
527
530
|
name: string;
|
528
531
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -568,13 +571,13 @@ interface components$1 {
|
|
568
571
|
};
|
569
572
|
/** @description The definition of a component variant */
|
570
573
|
ComponentDefinitionVariant: {
|
571
|
-
id: components$
|
574
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
572
575
|
/** @description Friendly name of the variant */
|
573
576
|
name: string;
|
574
577
|
};
|
575
578
|
/** @description Permission set for a component defintion */
|
576
579
|
ComponentDefinitionPermission: {
|
577
|
-
roleId: components$
|
580
|
+
roleId: components$2["schemas"]["PublicIdProperty"];
|
578
581
|
/**
|
579
582
|
* @description Permission type for this permission ComponentDefinition:
|
580
583
|
* read | write | create | delete
|
@@ -587,7 +590,7 @@ interface components$1 {
|
|
587
590
|
};
|
588
591
|
/** @description Defines a component type that can live on a Composition */
|
589
592
|
ComponentDefinition: {
|
590
|
-
id: components$
|
593
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
591
594
|
/** @description Friendly name of the component definition */
|
592
595
|
name: string;
|
593
596
|
/**
|
@@ -606,21 +609,21 @@ interface components$1 {
|
|
606
609
|
*/
|
607
610
|
canBeComposition?: boolean;
|
608
611
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
609
|
-
parameters?: components$
|
612
|
+
parameters?: components$2["schemas"]["ComponentDefinitionParameter"][];
|
610
613
|
/**
|
611
614
|
* @description if this component uses team permissions or custom permissions
|
612
615
|
* @default true
|
613
616
|
*/
|
614
617
|
useTeamPermissions?: boolean;
|
615
618
|
/** @description Custom role permissions for this component definition */
|
616
|
-
permissions?: components$
|
619
|
+
permissions?: components$2["schemas"]["ComponentDefinitionPermission"][];
|
617
620
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
618
|
-
slots?: components$
|
619
|
-
slugSettings?: components$
|
621
|
+
slots?: components$2["schemas"]["ComponentDefinitionSlot"][];
|
622
|
+
slugSettings?: components$2["schemas"]["ComponentDefinitionSlugSettings"];
|
620
623
|
/** @description Default component instance value */
|
621
|
-
defaults?: components$
|
624
|
+
defaults?: components$2["schemas"]["ComponentInstance"] | null;
|
622
625
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
623
|
-
variants?: components$
|
626
|
+
variants?: components$2["schemas"]["ComponentDefinitionVariant"][];
|
624
627
|
/** @description Created date string for this definition (ignored for writes) */
|
625
628
|
created?: string;
|
626
629
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -632,7 +635,7 @@ interface components$1 {
|
|
632
635
|
value: unknown;
|
633
636
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
634
637
|
type: string;
|
635
|
-
connectedData?: components$
|
638
|
+
connectedData?: components$2["schemas"]["DataElementConnectionDefinition"];
|
636
639
|
};
|
637
640
|
/**
|
638
641
|
* @deprecated
|
@@ -661,26 +664,26 @@ interface components$1 {
|
|
661
664
|
type: string;
|
662
665
|
/** @description Component parameter values for the component instance */
|
663
666
|
parameters?: {
|
664
|
-
[key: string]: components$
|
667
|
+
[key: string]: components$2["schemas"]["ComponentParameter"];
|
665
668
|
};
|
666
669
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
667
670
|
variant?: string;
|
668
671
|
/** @description Slots containing any child components */
|
669
672
|
slots?: {
|
670
|
-
[key: string]: components$
|
673
|
+
[key: string]: components$2["schemas"]["ComponentInstance"][];
|
671
674
|
};
|
672
675
|
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
673
676
|
_id?: string;
|
674
677
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
675
678
|
_pattern?: string;
|
676
|
-
_dataResources?: components$
|
679
|
+
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
677
680
|
/**
|
678
681
|
* @deprecated
|
679
682
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
680
683
|
* Means nothing for PUTs; it will be ignored.
|
681
684
|
*/
|
682
685
|
_patternDataResources?: {
|
683
|
-
[key: string]: components$
|
686
|
+
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
684
687
|
};
|
685
688
|
/**
|
686
689
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -698,13 +701,13 @@ interface components$1 {
|
|
698
701
|
type: string;
|
699
702
|
/** @description Component parameter values for the component instance */
|
700
703
|
parameters?: {
|
701
|
-
[key: string]: components$
|
704
|
+
[key: string]: components$2["schemas"]["ComponentParameter"];
|
702
705
|
};
|
703
706
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
704
707
|
variant?: string;
|
705
708
|
/** @description Slots containing any child components */
|
706
709
|
slots?: {
|
707
|
-
[key: string]: components$
|
710
|
+
[key: string]: components$2["schemas"]["ComponentInstance"][];
|
708
711
|
};
|
709
712
|
/** @description The public UUID of the composition. */
|
710
713
|
_id: string;
|
@@ -712,7 +715,7 @@ interface components$1 {
|
|
712
715
|
_slug?: string | null;
|
713
716
|
/** @description Friendly name of this component. */
|
714
717
|
_name: string;
|
715
|
-
_dataResources?: components$
|
718
|
+
_dataResources?: components$2["schemas"]["DataResourceDefinitions"];
|
716
719
|
};
|
717
720
|
/**
|
718
721
|
* @deprecated
|
@@ -755,7 +758,7 @@ interface components$1 {
|
|
755
758
|
}[];
|
756
759
|
/** @description Variables needed to make calls to the data source */
|
757
760
|
variables?: {
|
758
|
-
[key: string]: components$
|
761
|
+
[key: string]: components$2["schemas"]["DataVariableDefinition"];
|
759
762
|
};
|
760
763
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
761
764
|
custom?: {
|
@@ -786,12 +789,16 @@ interface components$1 {
|
|
786
789
|
ttl?: number;
|
787
790
|
/** @description A key for the resource data cache purging. */
|
788
791
|
purgeKey?: string;
|
792
|
+
/** @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. */
|
793
|
+
badgeIconUrl?: string;
|
794
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
789
795
|
headers?: {
|
790
796
|
[key: string]: string;
|
791
797
|
} | {
|
792
798
|
key: string;
|
793
799
|
value: string;
|
794
800
|
}[];
|
801
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
795
802
|
parameters?: {
|
796
803
|
[key: string]: string;
|
797
804
|
} | {
|
@@ -808,7 +815,7 @@ interface components$1 {
|
|
808
815
|
method: "GET" | "POST" | "HEAD";
|
809
816
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
810
817
|
variables?: {
|
811
|
-
[key: string]: components$
|
818
|
+
[key: string]: components$2["schemas"]["DataVariableDefinition"];
|
812
819
|
};
|
813
820
|
/** @description Custom configuration specific to the data source being defined */
|
814
821
|
custom?: {
|
@@ -817,23 +824,22 @@ interface components$1 {
|
|
817
824
|
};
|
818
825
|
/**
|
819
826
|
* @deprecated
|
820
|
-
* @description Defines the shape of a data variable on a Data
|
827
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
821
828
|
*/
|
822
829
|
DataVariableDefinition: {
|
823
830
|
/** @description Display name of the data variable */
|
824
831
|
displayName?: string;
|
832
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
833
|
+
helpText?: string;
|
825
834
|
/**
|
826
|
-
* @description Type of the data variable
|
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.
|
827
836
|
* @default text
|
828
837
|
*/
|
829
|
-
type
|
838
|
+
type?: string;
|
830
839
|
/** @description Default value of the data variable */
|
831
840
|
default: string;
|
832
|
-
/**
|
833
|
-
|
834
|
-
* @enum {string}
|
835
|
-
*/
|
836
|
-
setBy: "static" | "dynamic";
|
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;
|
837
843
|
};
|
838
844
|
/**
|
839
845
|
* @deprecated
|
@@ -841,7 +847,7 @@ interface components$1 {
|
|
841
847
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
842
848
|
*/
|
843
849
|
DataResourceDefinitions: {
|
844
|
-
[key: string]: components$
|
850
|
+
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
845
851
|
};
|
846
852
|
/**
|
847
853
|
* @deprecated
|
@@ -852,7 +858,7 @@ interface components$1 {
|
|
852
858
|
type: string;
|
853
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. */
|
854
860
|
isPatternParameter?: boolean;
|
855
|
-
variables?: components$
|
861
|
+
variables?: components$2["schemas"]["DataResourceVariables"];
|
856
862
|
};
|
857
863
|
/**
|
858
864
|
* @deprecated
|
@@ -864,7 +870,7 @@ interface components$1 {
|
|
864
870
|
};
|
865
871
|
}
|
866
872
|
|
867
|
-
declare type SharedComponents$1 = components$
|
873
|
+
declare type SharedComponents$1 = components$2['schemas'];
|
868
874
|
declare type Api$1 = paths$4['/api/v1/canvas-definitions'];
|
869
875
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
870
876
|
declare type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
@@ -883,7 +889,7 @@ declare type ComponentDefinitionAPIDeleteRequest = ComponentDefinitionDeletePara
|
|
883
889
|
/** @deprecated use ComponentDefinitionGetParameters */
|
884
890
|
declare type ComponentDefinitionListAPIOptions = ComponentDefinitionGetParameters;
|
885
891
|
/** The definition of a component parameter */
|
886
|
-
declare type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
892
|
+
declare type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$2['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
887
893
|
typeConfig?: TConfig;
|
888
894
|
};
|
889
895
|
/** The definition of a component visual variant */
|
@@ -908,213 +914,810 @@ interface paths$3 {
|
|
908
914
|
get: {
|
909
915
|
parameters: {
|
910
916
|
query: {
|
911
|
-
/** The project the composition(s) are on. */
|
912
|
-
projectId: string;
|
913
917
|
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
914
|
-
compositionId?:
|
918
|
+
compositionId?: components$1["parameters"]["compositionId"];
|
915
919
|
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
916
|
-
compositionIDs?:
|
917
|
-
/**
|
918
|
-
|
920
|
+
compositionIDs?: components$1["parameters"]["compositionIDs"];
|
921
|
+
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
922
|
+
createdBy?: components$1["parameters"]["createdBy"];
|
923
|
+
/**
|
924
|
+
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
925
|
+
* NOT a full text search; does not match composition contents.
|
926
|
+
*/
|
927
|
+
keyword?: components$1["parameters"]["keyword"];
|
928
|
+
/** Max number of records to return */
|
929
|
+
limit?: components$1["parameters"]["limit"];
|
930
|
+
/** Number of records to skip */
|
931
|
+
offset?: components$1["parameters"]["offset"];
|
932
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
933
|
+
orderBy?: components$1["parameters"]["orderBy"];
|
934
|
+
/**
|
935
|
+
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
936
|
+
* If true, only pattern compositions will be returned.
|
937
|
+
* If false, only regular compositions will be returned.
|
938
|
+
* If omitted, both pattern and regular compositions will be returned.
|
939
|
+
*/
|
940
|
+
pattern?: components$1["parameters"]["pattern"];
|
941
|
+
/** The project the composition(s) are on. */
|
942
|
+
projectId: components$1["parameters"]["projectId"];
|
943
|
+
/** Required when using project map node id or path for fetch. */
|
944
|
+
projectMapId?: components$1["parameters"]["projectMapId"];
|
919
945
|
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
920
|
-
projectMapNodeId?:
|
946
|
+
projectMapNodeId?: components$1["parameters"]["projectMapNodeId"];
|
921
947
|
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
922
|
-
projectMapNodePath?:
|
923
|
-
/** Required when using project map node id or path for fetch. */
|
924
|
-
projectMapId?: string;
|
925
|
-
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
926
|
-
type?: string[];
|
927
|
-
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
928
|
-
state?: number;
|
929
|
-
/** Number of records to skip */
|
930
|
-
offset?: number;
|
931
|
-
/** Max number of records to return */
|
932
|
-
limit?: number;
|
948
|
+
projectMapNodePath?: components$1["parameters"]["projectMapNodePath"];
|
933
949
|
/**
|
934
950
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
935
951
|
* This improves performance if you do not require enhanced component data.
|
936
952
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
937
953
|
*/
|
938
|
-
skipEnhance?:
|
954
|
+
skipEnhance?: components$1["parameters"]["skipEnhance"];
|
939
955
|
/**
|
940
956
|
* If true, any pattern references in the composition will be left unresolved.
|
941
957
|
* This is appropriate if you intend to serialize the composition without patterns
|
942
958
|
* embedded into it, and serialize the pattern data separately.
|
943
959
|
*/
|
944
|
-
skipPatternResolution?:
|
960
|
+
skipPatternResolution?: components$1["parameters"]["skipPatternResolution"];
|
961
|
+
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
962
|
+
slug?: components$1["parameters"]["slug"];
|
963
|
+
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
964
|
+
state?: components$1["parameters"]["state"];
|
965
|
+
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
966
|
+
type?: components$1["parameters"]["type"];
|
945
967
|
/**
|
946
|
-
*
|
947
|
-
*
|
968
|
+
* @deprecated Filters composition lists by the UI status of the composition.
|
969
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
948
970
|
*/
|
949
|
-
|
971
|
+
uiStatus?: components$1["parameters"]["uiStatus"];
|
972
|
+
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
973
|
+
updatedBy?: components$1["parameters"]["updatedBy"];
|
950
974
|
/**
|
951
|
-
*
|
952
|
-
*
|
975
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
976
|
+
* If false, the `_id` will not be present in the API response.
|
953
977
|
*/
|
954
|
-
|
978
|
+
withComponentIDs?: components$1["parameters"]["withComponentIDs"];
|
955
979
|
/**
|
956
|
-
*
|
957
|
-
*
|
958
|
-
* If false, only regular compositions will be returned.
|
959
|
-
* If omitted, both pattern and regular compositions will be returned.
|
980
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
981
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
960
982
|
*/
|
961
|
-
|
962
|
-
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
963
|
-
orderBy?: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
983
|
+
withTotalCount?: components$1["parameters"]["withTotalCount"];
|
964
984
|
/**
|
965
985
|
* @deprecated Returns the UI status string of the composition.
|
966
986
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
967
987
|
*/
|
968
|
-
withUIStatus?:
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
975
|
-
|
976
|
-
|
977
|
-
|
988
|
+
withUIStatus?: components$1["parameters"]["withUIStatus"];
|
989
|
+
};
|
990
|
+
};
|
991
|
+
responses: {
|
992
|
+
/** OK */
|
993
|
+
200: {
|
994
|
+
content: {
|
995
|
+
"application/json": components$1["schemas"]["CompositionListResponse"] | components$1["schemas"]["CompositionApiResponse"];
|
996
|
+
};
|
997
|
+
};
|
998
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
999
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1000
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1001
|
+
/** Composition not found */
|
1002
|
+
404: {
|
1003
|
+
content: {
|
1004
|
+
"text/plain": string;
|
1005
|
+
};
|
1006
|
+
};
|
1007
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1008
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1009
|
+
};
|
1010
|
+
};
|
1011
|
+
/** Upserts a composition */
|
1012
|
+
put: {
|
1013
|
+
responses: {
|
1014
|
+
/** OK */
|
1015
|
+
204: never;
|
1016
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1017
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1018
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1019
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1020
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1021
|
+
};
|
1022
|
+
requestBody: {
|
1023
|
+
content: {
|
1024
|
+
"application/json": {
|
1025
|
+
/**
|
1026
|
+
* Format: uuid
|
1027
|
+
* @description The project ID to upsert the composition to
|
1028
|
+
*/
|
1029
|
+
projectId: string;
|
1030
|
+
/** @description The state of the composition to upsert into. 0 = draft, 64 = published */
|
1031
|
+
state: number;
|
1032
|
+
composition: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1033
|
+
/**
|
1034
|
+
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
1035
|
+
* @default false
|
1036
|
+
*/
|
1037
|
+
pattern?: boolean;
|
1038
|
+
/** @description Ignored if present */
|
1039
|
+
created?: string;
|
1040
|
+
/** @description Ignored if present */
|
1041
|
+
modified?: string;
|
1042
|
+
};
|
1043
|
+
};
|
1044
|
+
};
|
1045
|
+
};
|
1046
|
+
/** Deletes or unpublishes a composition */
|
1047
|
+
delete: {
|
1048
|
+
responses: {
|
1049
|
+
/** OK */
|
1050
|
+
204: never;
|
1051
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1052
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1053
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1054
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1055
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1056
|
+
};
|
1057
|
+
requestBody: {
|
1058
|
+
content: {
|
1059
|
+
"application/json": {
|
1060
|
+
/**
|
1061
|
+
* Format: uuid
|
1062
|
+
* @description The ID of the composition to delete
|
1063
|
+
*/
|
1064
|
+
compositionId: string;
|
1065
|
+
/**
|
1066
|
+
* Format: uuid
|
1067
|
+
* @description The ID of the project the composition to delete belongs to
|
1068
|
+
*/
|
1069
|
+
projectId: string;
|
1070
|
+
/** @description The state of the composition to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
1071
|
+
state?: number;
|
1072
|
+
};
|
1073
|
+
};
|
1074
|
+
};
|
1075
|
+
};
|
1076
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
1077
|
+
options: {
|
1078
|
+
responses: {
|
1079
|
+
/** OK */
|
1080
|
+
204: never;
|
1081
|
+
};
|
1082
|
+
};
|
1083
|
+
};
|
1084
|
+
}
|
1085
|
+
interface components$1 {
|
1086
|
+
schemas: {
|
1087
|
+
CompositionApiResponse: {
|
1088
|
+
/** @description State of compositions to fetch. 0 = draft, 64 = published. */
|
1089
|
+
state: number;
|
1090
|
+
/**
|
1091
|
+
* @deprecated
|
1092
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
1093
|
+
* @enum {string}
|
1094
|
+
*/
|
1095
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
1096
|
+
/**
|
1097
|
+
* Format: uuid
|
1098
|
+
* @description The project ID that this layout data is part of
|
1099
|
+
*/
|
1100
|
+
projectId: string;
|
1101
|
+
/**
|
1102
|
+
* Format: date-time,
|
1103
|
+
* @description Created date string for this definition
|
1104
|
+
*/
|
1105
|
+
created: string;
|
1106
|
+
/**
|
1107
|
+
* Format: date-time,
|
1108
|
+
* @description Modified date string for this definition
|
1109
|
+
*/
|
1110
|
+
modified: string;
|
1111
|
+
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
1112
|
+
pattern: boolean;
|
1113
|
+
composition: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1114
|
+
};
|
1115
|
+
CompositionListResponse: {
|
1116
|
+
compositions: components$1["schemas"]["CompositionApiResponse"][];
|
1117
|
+
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
1118
|
+
totalCount?: number;
|
1119
|
+
};
|
1120
|
+
};
|
1121
|
+
parameters: {
|
1122
|
+
/** @description The project the composition(s) are on. */
|
1123
|
+
projectId: string;
|
1124
|
+
/** @description Specify a single composition ID to fetch. Changes response from list to single. */
|
1125
|
+
compositionId: string;
|
1126
|
+
/** @description Specify multiple composition IDs to fetch. Response type will be a list. */
|
1127
|
+
compositionIDs: string[];
|
1128
|
+
/** @description Specify a single composition to fetch by slug. Changes response from list to single. */
|
1129
|
+
slug: string;
|
1130
|
+
/** @description Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
1131
|
+
projectMapNodeId: string;
|
1132
|
+
/** @description Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
1133
|
+
projectMapNodePath: string;
|
1134
|
+
/** @description Required when using project map node id or path for fetch. */
|
1135
|
+
projectMapId: string;
|
1136
|
+
/** @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
1137
|
+
type: string[];
|
1138
|
+
/** @description State of compositions to fetch. 0 = draft, 64 = published. */
|
1139
|
+
state: number;
|
1140
|
+
/** @description Number of records to skip */
|
1141
|
+
offset: number;
|
1142
|
+
/** @description Max number of records to return */
|
1143
|
+
limit: number;
|
1144
|
+
/**
|
1145
|
+
* @deprecated
|
1146
|
+
* @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
1147
|
+
* This improves performance if you do not require enhanced component data.
|
1148
|
+
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
1149
|
+
*/
|
1150
|
+
skipEnhance: boolean;
|
1151
|
+
/**
|
1152
|
+
* @description If true, any pattern references in the composition will be left unresolved.
|
1153
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
1154
|
+
* embedded into it, and serialize the pattern data separately.
|
1155
|
+
*/
|
1156
|
+
skipPatternResolution: boolean;
|
1157
|
+
/**
|
1158
|
+
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
1159
|
+
* If false, the `_id` will not be present in the API response.
|
1160
|
+
*/
|
1161
|
+
withComponentIDs: boolean;
|
1162
|
+
/**
|
1163
|
+
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
1164
|
+
* NOT a full text search; does not match composition contents.
|
1165
|
+
*/
|
1166
|
+
keyword: string;
|
1167
|
+
/**
|
1168
|
+
* @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
1169
|
+
* If true, only pattern compositions will be returned.
|
1170
|
+
* If false, only regular compositions will be returned.
|
1171
|
+
* If omitted, both pattern and regular compositions will be returned.
|
1172
|
+
*/
|
1173
|
+
pattern: boolean;
|
1174
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
1175
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
1176
|
+
/**
|
1177
|
+
* @deprecated
|
1178
|
+
* @description Returns the UI status string of the composition.
|
1179
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
1180
|
+
*/
|
1181
|
+
withUIStatus: boolean;
|
1182
|
+
/**
|
1183
|
+
* @deprecated
|
1184
|
+
* @description Filters composition lists by the UI status of the composition.
|
1185
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
1186
|
+
*/
|
1187
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
1188
|
+
/** @description Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
1189
|
+
createdBy: string;
|
1190
|
+
/** @description Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
1191
|
+
updatedBy: string;
|
1192
|
+
/**
|
1193
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
1194
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
1195
|
+
*/
|
1196
|
+
withTotalCount: boolean;
|
1197
|
+
};
|
1198
|
+
}
|
1199
|
+
interface external$4 {
|
1200
|
+
"swagger.yml": {
|
1201
|
+
paths: {};
|
1202
|
+
components: {
|
1203
|
+
schemas: {
|
1204
|
+
Error: {
|
1205
|
+
/** @description Error message(s) that occurred while processing the request */
|
1206
|
+
errorMessage?: string[] | string;
|
1207
|
+
};
|
1208
|
+
};
|
1209
|
+
responses: {
|
1210
|
+
/** Request input validation failed */
|
1211
|
+
BadRequestError: {
|
1212
|
+
content: {
|
1213
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
1214
|
+
};
|
1215
|
+
};
|
1216
|
+
/** API key or token was not valid */
|
1217
|
+
UnauthorizedError: {
|
1218
|
+
content: {
|
1219
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
1220
|
+
};
|
1221
|
+
};
|
1222
|
+
/** Permission was denied */
|
1223
|
+
ForbiddenError: {
|
1224
|
+
content: {
|
1225
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
1226
|
+
};
|
1227
|
+
};
|
1228
|
+
/** Resource not found */
|
1229
|
+
NotFoundError: {
|
1230
|
+
content: {
|
1231
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
1232
|
+
};
|
1233
|
+
};
|
1234
|
+
/** Too many requests in allowed time period */
|
1235
|
+
RateLimitError: unknown;
|
1236
|
+
/** Execution error occurred */
|
1237
|
+
InternalServerError: unknown;
|
1238
|
+
};
|
1239
|
+
};
|
1240
|
+
operations: {};
|
1241
|
+
};
|
1242
|
+
"uniform-canvas-types.swagger.yml": {
|
1243
|
+
paths: {};
|
1244
|
+
components: {
|
1245
|
+
schemas: {
|
1246
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
1247
|
+
PublicIdProperty: string;
|
1248
|
+
/** @description The definition of a component parameter */
|
1249
|
+
ComponentDefinitionParameter: {
|
1250
|
+
id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1251
|
+
/** @description Friendly name of the parameter */
|
1252
|
+
name: string;
|
1253
|
+
/** @description Appears next to the parameter in the Composition editor */
|
1254
|
+
helpText?: string;
|
1255
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
1256
|
+
type: string;
|
1257
|
+
/** @description The configuration object for the type (type-specific) */
|
1258
|
+
typeConfig?: unknown;
|
1259
|
+
};
|
1260
|
+
/** @description The definition of a named component slot that can contain other components */
|
1261
|
+
ComponentDefinitionSlot: {
|
1262
|
+
id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1263
|
+
/** @description Friendly name of the slot */
|
1264
|
+
name: string;
|
1265
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
1266
|
+
allowedComponents: string[];
|
1267
|
+
/**
|
1268
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
1269
|
+
* @default false
|
1270
|
+
*/
|
1271
|
+
inheritAllowedComponents: boolean;
|
1272
|
+
/** @description Minimum valid number of components in this slot */
|
1273
|
+
minComponents?: number;
|
1274
|
+
/** @description Maximum valid number of components in this slot */
|
1275
|
+
maxComponents?: number;
|
1276
|
+
};
|
1277
|
+
/** @description The definition of a composition's slug settings */
|
1278
|
+
ComponentDefinitionSlugSettings: {
|
1279
|
+
/**
|
1280
|
+
* @description Whether the slug is required
|
1281
|
+
* no: slug is optional
|
1282
|
+
* yes: slug is required
|
1283
|
+
* disabled: slug is disabled and will not be shown in the editor
|
1284
|
+
*
|
1285
|
+
* @default no
|
1286
|
+
* @enum {string}
|
1287
|
+
*/
|
1288
|
+
required?: "no" | "yes" | "disabled";
|
1289
|
+
/**
|
1290
|
+
* @description Slug uniqueness configuration.
|
1291
|
+
* no = no unique constraint
|
1292
|
+
* local = must be unique within this component type
|
1293
|
+
* global = must be unique across all component types
|
1294
|
+
*
|
1295
|
+
* @enum {string}
|
1296
|
+
*/
|
1297
|
+
unique?: "no" | "local" | "global";
|
1298
|
+
/** @description Regular expression slugs must match */
|
1299
|
+
regularExpression?: string;
|
1300
|
+
/**
|
1301
|
+
* @description Custom error message when regular expression validation fails.
|
1302
|
+
* Has no effect if `regularExpression` is not set.
|
1303
|
+
*/
|
1304
|
+
regularExpressionMessage?: string;
|
1305
|
+
};
|
1306
|
+
/** @description The definition of a component variant */
|
1307
|
+
ComponentDefinitionVariant: {
|
1308
|
+
id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1309
|
+
/** @description Friendly name of the variant */
|
1310
|
+
name: string;
|
1311
|
+
};
|
1312
|
+
/** @description Permission set for a component defintion */
|
1313
|
+
ComponentDefinitionPermission: {
|
1314
|
+
roleId: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1315
|
+
/**
|
1316
|
+
* @description Permission type for this permission ComponentDefinition:
|
1317
|
+
* read | write | create | delete
|
1318
|
+
*
|
1319
|
+
* @enum {string}
|
1320
|
+
*/
|
1321
|
+
permission: "read" | "write" | "create" | "delete";
|
1322
|
+
/** @description State of the component that this permission applies to */
|
1323
|
+
state: number;
|
1324
|
+
};
|
1325
|
+
/** @description Defines a component type that can live on a Composition */
|
1326
|
+
ComponentDefinition: {
|
1327
|
+
id: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1328
|
+
/** @description Friendly name of the component definition */
|
1329
|
+
name: string;
|
1330
|
+
/**
|
1331
|
+
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
1332
|
+
* @default screen
|
1333
|
+
*/
|
1334
|
+
icon?: string;
|
1335
|
+
/**
|
1336
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
1337
|
+
* The parameter type must support being used as a title parameter for this to work.
|
1338
|
+
*/
|
1339
|
+
titleParameter?: string | null;
|
1340
|
+
/**
|
1341
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
1342
|
+
* @default false
|
1343
|
+
*/
|
1344
|
+
canBeComposition?: boolean;
|
1345
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1346
|
+
parameters?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1347
|
+
/**
|
1348
|
+
* @description if this component uses team permissions or custom permissions
|
1349
|
+
* @default true
|
1350
|
+
*/
|
1351
|
+
useTeamPermissions?: boolean;
|
1352
|
+
/** @description Custom role permissions for this component definition */
|
1353
|
+
permissions?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1354
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1355
|
+
slots?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1356
|
+
slugSettings?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1357
|
+
/** @description Default component instance value */
|
1358
|
+
defaults?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1359
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1360
|
+
variants?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1361
|
+
/** @description Created date string for this definition (ignored for writes) */
|
1362
|
+
created?: string;
|
1363
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
1364
|
+
updated?: string;
|
1365
|
+
};
|
1366
|
+
/** @description Defines an editable parameter on a component. */
|
1367
|
+
ComponentParameter: {
|
1368
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
1369
|
+
value: unknown;
|
1370
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1371
|
+
type: string;
|
1372
|
+
connectedData?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1373
|
+
};
|
1374
|
+
/**
|
1375
|
+
* @deprecated
|
1376
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
1377
|
+
*/
|
1378
|
+
DataElementConnectionDefinition: {
|
1379
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
1380
|
+
pointer: string;
|
1381
|
+
/**
|
1382
|
+
* @description The syntax used to select the data element to bind to
|
1383
|
+
* @enum {string}
|
1384
|
+
*/
|
1385
|
+
syntax: "jptr";
|
1386
|
+
/**
|
1387
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
1388
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
1389
|
+
* 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.
|
1390
|
+
*
|
1391
|
+
* @default false
|
1392
|
+
*/
|
1393
|
+
required?: boolean;
|
1394
|
+
};
|
1395
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
1396
|
+
ComponentInstance: {
|
1397
|
+
/** @description Type of the component instance (public_id of its definition) */
|
1398
|
+
type: string;
|
1399
|
+
/** @description Component parameter values for the component instance */
|
1400
|
+
parameters?: {
|
1401
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1402
|
+
};
|
1403
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1404
|
+
variant?: string;
|
1405
|
+
/** @description Slots containing any child components */
|
1406
|
+
slots?: {
|
1407
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1408
|
+
};
|
1409
|
+
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
1410
|
+
_id?: string;
|
1411
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1412
|
+
_pattern?: string;
|
1413
|
+
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1414
|
+
/**
|
1415
|
+
* @deprecated
|
1416
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1417
|
+
* Means nothing for PUTs; it will be ignored.
|
1418
|
+
*/
|
1419
|
+
_patternDataResources?: {
|
1420
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1421
|
+
};
|
1422
|
+
/**
|
1423
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
1424
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
1425
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
1426
|
+
* Means nothing for PUTs; it will be ignored.
|
1427
|
+
*
|
1428
|
+
* @enum {string}
|
1429
|
+
*/
|
1430
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
1431
|
+
};
|
1432
|
+
/** @description Defines the shape of the root component in a composition */
|
1433
|
+
RootComponentInstance: {
|
1434
|
+
/** @description Type of the component instance (public_id of its definition) */
|
1435
|
+
type: string;
|
1436
|
+
/** @description Component parameter values for the component instance */
|
1437
|
+
parameters?: {
|
1438
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1439
|
+
};
|
1440
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1441
|
+
variant?: string;
|
1442
|
+
/** @description Slots containing any child components */
|
1443
|
+
slots?: {
|
1444
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1445
|
+
};
|
1446
|
+
/** @description The public UUID of the composition. */
|
1447
|
+
_id: string;
|
1448
|
+
/** @description Slug pattern of this component. */
|
1449
|
+
_slug?: string | null;
|
1450
|
+
/** @description Friendly name of this component. */
|
1451
|
+
_name: string;
|
1452
|
+
_dataResources?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1453
|
+
};
|
1454
|
+
/**
|
1455
|
+
* @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.
|
1471
|
+
*/
|
1472
|
+
DataSource: {
|
1473
|
+
/** @description Public ID of the data source */
|
1474
|
+
id: string;
|
1475
|
+
/** @description Display name of the data source */
|
1476
|
+
displayName: string;
|
1477
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1478
|
+
connectorType: string;
|
1479
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1480
|
+
baseUrl: string;
|
1481
|
+
headers?: {
|
1482
|
+
[key: string]: string;
|
1483
|
+
} | {
|
1484
|
+
key: string;
|
1485
|
+
value: string;
|
1486
|
+
}[];
|
1487
|
+
parameters?: {
|
1488
|
+
[key: string]: string;
|
1489
|
+
} | {
|
1490
|
+
key: string;
|
1491
|
+
value: string;
|
1492
|
+
}[];
|
1493
|
+
/** @description Variables needed to make calls to the data source */
|
1494
|
+
variables?: {
|
1495
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1496
|
+
};
|
1497
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1498
|
+
custom?: {
|
1499
|
+
[key: string]: unknown;
|
1500
|
+
};
|
1501
|
+
};
|
1502
|
+
/**
|
1503
|
+
* @deprecated
|
1504
|
+
* @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.
|
1505
|
+
*/
|
1506
|
+
DataType: {
|
1507
|
+
/** @description Public ID of the data type */
|
1508
|
+
id: string;
|
1509
|
+
/** @description Display name of the data type */
|
1510
|
+
displayName: string;
|
1511
|
+
/** @description Public ID of the associated data source */
|
1512
|
+
dataSourceId: string;
|
1513
|
+
/**
|
1514
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1515
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
1516
|
+
* no special UI or processing is required.
|
1517
|
+
*/
|
1518
|
+
archetype?: string;
|
1519
|
+
allowedOnComponents?: string[];
|
1520
|
+
/** @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
|
+
path: string;
|
1522
|
+
/** @description Time-to-live for the resource data cache. */
|
1523
|
+
ttl?: number;
|
1524
|
+
/** @description A key for the resource data cache purging. */
|
1525
|
+
purgeKey?: string;
|
1526
|
+
/** @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. */
|
1527
|
+
badgeIconUrl?: string;
|
1528
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1529
|
+
headers?: {
|
1530
|
+
[key: string]: string;
|
1531
|
+
} | {
|
1532
|
+
key: string;
|
1533
|
+
value: string;
|
1534
|
+
}[];
|
1535
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1536
|
+
parameters?: {
|
1537
|
+
[key: string]: string;
|
1538
|
+
} | {
|
1539
|
+
key: string;
|
1540
|
+
value: string;
|
1541
|
+
}[];
|
1542
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1543
|
+
body?: string;
|
1544
|
+
/**
|
1545
|
+
* @description HTTP method to use with requests to the data type.
|
1546
|
+
* @default GET
|
1547
|
+
* @enum {string}
|
1548
|
+
*/
|
1549
|
+
method: "GET" | "POST" | "HEAD";
|
1550
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1551
|
+
variables?: {
|
1552
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1553
|
+
};
|
1554
|
+
/** @description Custom configuration specific to the data source being defined */
|
1555
|
+
custom?: {
|
1556
|
+
[key: string]: unknown;
|
1557
|
+
};
|
1558
|
+
};
|
1559
|
+
/**
|
1560
|
+
* @deprecated
|
1561
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1562
|
+
*/
|
1563
|
+
DataVariableDefinition: {
|
1564
|
+
/** @description Display name of the data variable */
|
1565
|
+
displayName?: string;
|
1566
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
1567
|
+
helpText?: string;
|
978
1568
|
/**
|
979
|
-
*
|
980
|
-
*
|
1569
|
+
* @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.
|
1570
|
+
* @default text
|
981
1571
|
*/
|
982
|
-
|
1572
|
+
type?: string;
|
1573
|
+
/** @description Default value of the data variable */
|
1574
|
+
default: string;
|
1575
|
+
/** @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. */
|
1576
|
+
order?: number;
|
983
1577
|
};
|
984
|
-
|
985
|
-
|
986
|
-
|
987
|
-
|
988
|
-
|
989
|
-
|
990
|
-
|
1578
|
+
/**
|
1579
|
+
* @deprecated
|
1580
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1581
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1582
|
+
*/
|
1583
|
+
DataResourceDefinitions: {
|
1584
|
+
[key: string]: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
991
1585
|
};
|
992
|
-
|
993
|
-
|
994
|
-
|
995
|
-
|
996
|
-
|
997
|
-
|
998
|
-
|
999
|
-
|
1586
|
+
/**
|
1587
|
+
* @deprecated
|
1588
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
1589
|
+
*/
|
1590
|
+
DataResourceDefinition: {
|
1591
|
+
/** @description Public ID of the data type that provides this data */
|
1592
|
+
type: string;
|
1593
|
+
/** @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. */
|
1594
|
+
isPatternParameter?: boolean;
|
1595
|
+
variables?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1596
|
+
};
|
1597
|
+
/**
|
1598
|
+
* @deprecated
|
1599
|
+
* @description Variable values for a data resource.
|
1600
|
+
*/
|
1601
|
+
DataResourceVariables: {
|
1602
|
+
[key: string]: string;
|
1000
1603
|
};
|
1001
|
-
429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1002
|
-
500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1003
1604
|
};
|
1004
1605
|
};
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1606
|
+
operations: {};
|
1607
|
+
};
|
1608
|
+
}
|
1609
|
+
|
1610
|
+
interface components {
|
1611
|
+
schemas: {
|
1612
|
+
EdgehancersError: {
|
1613
|
+
message: string;
|
1614
|
+
status: number;
|
1615
|
+
statusText: string;
|
1616
|
+
};
|
1617
|
+
UniformError: components["schemas"]["EdgehancersError"] | external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1618
|
+
InvalidationPayload: {
|
1619
|
+
variables?: {
|
1620
|
+
name: string;
|
1621
|
+
value: string;
|
1622
|
+
}[];
|
1623
|
+
};
|
1624
|
+
DataDiagnostic: {
|
1625
|
+
componentPath: string;
|
1626
|
+
dataType: string;
|
1627
|
+
dataName: string;
|
1628
|
+
performance: {
|
1629
|
+
cacheHit: boolean;
|
1630
|
+
total: number;
|
1631
|
+
retryCount: number;
|
1632
|
+
retryDelay: number;
|
1015
1633
|
};
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
/** @description Ignored if present */
|
1035
|
-
modified?: string;
|
1036
|
-
};
|
1634
|
+
data: unknown;
|
1635
|
+
};
|
1636
|
+
CompositionIssue: {
|
1637
|
+
componentPath: string;
|
1638
|
+
componentType: string;
|
1639
|
+
message: string;
|
1640
|
+
type: string;
|
1641
|
+
};
|
1642
|
+
InvalidationResult: {
|
1643
|
+
ok: boolean;
|
1644
|
+
input: {
|
1645
|
+
/** Format: uuid */
|
1646
|
+
projectId: string;
|
1647
|
+
/** Format: uuid */
|
1648
|
+
dataTypeId: string;
|
1649
|
+
dataVariable?: {
|
1650
|
+
name: string;
|
1651
|
+
value: string;
|
1037
1652
|
};
|
1038
1653
|
};
|
1039
1654
|
};
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1044
|
-
|
1045
|
-
|
1046
|
-
401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1047
|
-
403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1048
|
-
429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1049
|
-
500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1655
|
+
};
|
1656
|
+
responses: {
|
1657
|
+
/** Invalid caller input came with the request */
|
1658
|
+
BadRequestError: {
|
1659
|
+
content: {
|
1660
|
+
"application/json": components["schemas"]["UniformError"];
|
1050
1661
|
};
|
1051
|
-
|
1052
|
-
|
1053
|
-
|
1054
|
-
|
1055
|
-
* Format: uuid
|
1056
|
-
* @description The ID of the composition to delete
|
1057
|
-
*/
|
1058
|
-
compositionId: string;
|
1059
|
-
/**
|
1060
|
-
* Format: uuid
|
1061
|
-
* @description The ID of the project the composition to delete belongs to
|
1062
|
-
*/
|
1063
|
-
projectId: string;
|
1064
|
-
/** @description The state of the composition to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
1065
|
-
state?: number;
|
1066
|
-
};
|
1067
|
-
};
|
1662
|
+
};
|
1663
|
+
UnauthorizedError: {
|
1664
|
+
content: {
|
1665
|
+
"application/json": components["schemas"]["UniformError"];
|
1068
1666
|
};
|
1069
1667
|
};
|
1070
|
-
|
1071
|
-
|
1072
|
-
|
1073
|
-
/** OK */
|
1074
|
-
204: never;
|
1668
|
+
ForbiddenError: {
|
1669
|
+
content: {
|
1670
|
+
"application/json": components["schemas"]["UniformError"];
|
1075
1671
|
};
|
1076
1672
|
};
|
1077
|
-
|
1078
|
-
|
1079
|
-
|
1080
|
-
|
1081
|
-
|
1082
|
-
/** @description State of compositions to fetch. 0 = draft, 64 = published. */
|
1083
|
-
state: number;
|
1084
|
-
/**
|
1085
|
-
* @deprecated
|
1086
|
-
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
1087
|
-
* @enum {string}
|
1088
|
-
*/
|
1089
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
1090
|
-
/**
|
1091
|
-
* Format: uuid
|
1092
|
-
* @description The project ID that this layout data is part of
|
1093
|
-
*/
|
1094
|
-
projectId: string;
|
1095
|
-
/**
|
1096
|
-
* Format: date-time,
|
1097
|
-
* @description Created date string for this definition
|
1098
|
-
*/
|
1099
|
-
created: string;
|
1100
|
-
/**
|
1101
|
-
* Format: date-time,
|
1102
|
-
* @description Modified date string for this definition
|
1103
|
-
*/
|
1104
|
-
modified: string;
|
1105
|
-
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
1106
|
-
pattern: boolean;
|
1107
|
-
composition: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1673
|
+
/** The requested resource does not exist */
|
1674
|
+
NotFoundError: {
|
1675
|
+
content: {
|
1676
|
+
"application/json": components["schemas"]["UniformError"];
|
1677
|
+
};
|
1108
1678
|
};
|
1109
|
-
|
1110
|
-
|
1111
|
-
|
1112
|
-
|
1679
|
+
/** Invalid method was used to call the endpoint */
|
1680
|
+
MethodNotAllowedError: {
|
1681
|
+
content: {
|
1682
|
+
"application/json": components["schemas"]["UniformError"];
|
1683
|
+
};
|
1684
|
+
};
|
1685
|
+
/** The request body could not be parsed or understood */
|
1686
|
+
UnprocessableEntityError: {
|
1687
|
+
content: {
|
1688
|
+
"application/json": components["schemas"]["UniformError"];
|
1689
|
+
};
|
1690
|
+
};
|
1691
|
+
RateLimitError: {
|
1692
|
+
content: {
|
1693
|
+
"application/json": components["schemas"]["UniformError"];
|
1694
|
+
};
|
1695
|
+
};
|
1696
|
+
/** An unexpected error occurred */
|
1697
|
+
InternalServerError: {
|
1698
|
+
content: {
|
1699
|
+
"application/json": components["schemas"]["UniformError"];
|
1700
|
+
};
|
1701
|
+
};
|
1702
|
+
CompositionResult: {
|
1703
|
+
content: {
|
1704
|
+
"application/json": {
|
1705
|
+
dataDiagnostics?: components["schemas"]["DataDiagnostic"][];
|
1706
|
+
errors?: components["schemas"]["CompositionIssue"][];
|
1707
|
+
warnings?: components["schemas"]["CompositionIssue"][];
|
1708
|
+
} & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
1709
|
+
};
|
1710
|
+
};
|
1711
|
+
/** Invalidation request was processed; ok indicates if it succeeded */
|
1712
|
+
InvalidationResult: {
|
1713
|
+
content: {
|
1714
|
+
"application/json": components["schemas"]["InvalidationResult"];
|
1715
|
+
};
|
1113
1716
|
};
|
1114
1717
|
};
|
1115
1718
|
}
|
1116
1719
|
interface external$3 {
|
1117
|
-
"swagger.yml": {
|
1720
|
+
"../../../lambda/functions/swagger.yml": {
|
1118
1721
|
paths: {};
|
1119
1722
|
components: {
|
1120
1723
|
schemas: {
|
@@ -1127,25 +1730,25 @@ interface external$3 {
|
|
1127
1730
|
/** Request input validation failed */
|
1128
1731
|
BadRequestError: {
|
1129
1732
|
content: {
|
1130
|
-
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
1733
|
+
"application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1131
1734
|
};
|
1132
1735
|
};
|
1133
1736
|
/** API key or token was not valid */
|
1134
1737
|
UnauthorizedError: {
|
1135
1738
|
content: {
|
1136
|
-
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
1739
|
+
"application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1137
1740
|
};
|
1138
1741
|
};
|
1139
1742
|
/** Permission was denied */
|
1140
1743
|
ForbiddenError: {
|
1141
1744
|
content: {
|
1142
|
-
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
1745
|
+
"application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1143
1746
|
};
|
1144
1747
|
};
|
1145
1748
|
/** Resource not found */
|
1146
1749
|
NotFoundError: {
|
1147
1750
|
content: {
|
1148
|
-
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
1751
|
+
"application/json": external$3["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1149
1752
|
};
|
1150
1753
|
};
|
1151
1754
|
/** Too many requests in allowed time period */
|
@@ -1156,7 +1759,7 @@ interface external$3 {
|
|
1156
1759
|
};
|
1157
1760
|
operations: {};
|
1158
1761
|
};
|
1159
|
-
"uniform-canvas-types.swagger.yml": {
|
1762
|
+
"../../../lambda/functions/uniform-canvas-types.swagger.yml": {
|
1160
1763
|
paths: {};
|
1161
1764
|
components: {
|
1162
1765
|
schemas: {
|
@@ -1164,7 +1767,7 @@ interface external$3 {
|
|
1164
1767
|
PublicIdProperty: string;
|
1165
1768
|
/** @description The definition of a component parameter */
|
1166
1769
|
ComponentDefinitionParameter: {
|
1167
|
-
id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1770
|
+
id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1168
1771
|
/** @description Friendly name of the parameter */
|
1169
1772
|
name: string;
|
1170
1773
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1176,7 +1779,7 @@ interface external$3 {
|
|
1176
1779
|
};
|
1177
1780
|
/** @description The definition of a named component slot that can contain other components */
|
1178
1781
|
ComponentDefinitionSlot: {
|
1179
|
-
id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1782
|
+
id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1180
1783
|
/** @description Friendly name of the slot */
|
1181
1784
|
name: string;
|
1182
1785
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1222,13 +1825,13 @@ interface external$3 {
|
|
1222
1825
|
};
|
1223
1826
|
/** @description The definition of a component variant */
|
1224
1827
|
ComponentDefinitionVariant: {
|
1225
|
-
id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1828
|
+
id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1226
1829
|
/** @description Friendly name of the variant */
|
1227
1830
|
name: string;
|
1228
1831
|
};
|
1229
1832
|
/** @description Permission set for a component defintion */
|
1230
1833
|
ComponentDefinitionPermission: {
|
1231
|
-
roleId: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1834
|
+
roleId: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1232
1835
|
/**
|
1233
1836
|
* @description Permission type for this permission ComponentDefinition:
|
1234
1837
|
* read | write | create | delete
|
@@ -1241,7 +1844,7 @@ interface external$3 {
|
|
1241
1844
|
};
|
1242
1845
|
/** @description Defines a component type that can live on a Composition */
|
1243
1846
|
ComponentDefinition: {
|
1244
|
-
id: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1847
|
+
id: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1245
1848
|
/** @description Friendly name of the component definition */
|
1246
1849
|
name: string;
|
1247
1850
|
/**
|
@@ -1260,21 +1863,21 @@ interface external$3 {
|
|
1260
1863
|
*/
|
1261
1864
|
canBeComposition?: boolean;
|
1262
1865
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1263
|
-
parameters?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1866
|
+
parameters?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1264
1867
|
/**
|
1265
1868
|
* @description if this component uses team permissions or custom permissions
|
1266
1869
|
* @default true
|
1267
1870
|
*/
|
1268
1871
|
useTeamPermissions?: boolean;
|
1269
1872
|
/** @description Custom role permissions for this component definition */
|
1270
|
-
permissions?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1873
|
+
permissions?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1271
1874
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1272
|
-
slots?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1273
|
-
slugSettings?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1875
|
+
slots?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1876
|
+
slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1274
1877
|
/** @description Default component instance value */
|
1275
|
-
defaults?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1878
|
+
defaults?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1276
1879
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1277
|
-
variants?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1880
|
+
variants?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1278
1881
|
/** @description Created date string for this definition (ignored for writes) */
|
1279
1882
|
created?: string;
|
1280
1883
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1286,7 +1889,7 @@ interface external$3 {
|
|
1286
1889
|
value: unknown;
|
1287
1890
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1288
1891
|
type: string;
|
1289
|
-
connectedData?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1892
|
+
connectedData?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1290
1893
|
};
|
1291
1894
|
/**
|
1292
1895
|
* @deprecated
|
@@ -1315,26 +1918,26 @@ interface external$3 {
|
|
1315
1918
|
type: string;
|
1316
1919
|
/** @description Component parameter values for the component instance */
|
1317
1920
|
parameters?: {
|
1318
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1921
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1319
1922
|
};
|
1320
1923
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1321
1924
|
variant?: string;
|
1322
1925
|
/** @description Slots containing any child components */
|
1323
1926
|
slots?: {
|
1324
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1927
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1325
1928
|
};
|
1326
1929
|
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
1327
1930
|
_id?: string;
|
1328
1931
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1329
1932
|
_pattern?: string;
|
1330
|
-
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1933
|
+
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1331
1934
|
/**
|
1332
1935
|
* @deprecated
|
1333
1936
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
1334
1937
|
* Means nothing for PUTs; it will be ignored.
|
1335
1938
|
*/
|
1336
1939
|
_patternDataResources?: {
|
1337
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1940
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1338
1941
|
};
|
1339
1942
|
/**
|
1340
1943
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1352,13 +1955,13 @@ interface external$3 {
|
|
1352
1955
|
type: string;
|
1353
1956
|
/** @description Component parameter values for the component instance */
|
1354
1957
|
parameters?: {
|
1355
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1958
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1356
1959
|
};
|
1357
1960
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1358
1961
|
variant?: string;
|
1359
1962
|
/** @description Slots containing any child components */
|
1360
1963
|
slots?: {
|
1361
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1964
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1362
1965
|
};
|
1363
1966
|
/** @description The public UUID of the composition. */
|
1364
1967
|
_id: string;
|
@@ -1366,7 +1969,7 @@ interface external$3 {
|
|
1366
1969
|
_slug?: string | null;
|
1367
1970
|
/** @description Friendly name of this component. */
|
1368
1971
|
_name: string;
|
1369
|
-
_dataResources?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1972
|
+
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1370
1973
|
};
|
1371
1974
|
/**
|
1372
1975
|
* @deprecated
|
@@ -1409,7 +2012,7 @@ interface external$3 {
|
|
1409
2012
|
}[];
|
1410
2013
|
/** @description Variables needed to make calls to the data source */
|
1411
2014
|
variables?: {
|
1412
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2015
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1413
2016
|
};
|
1414
2017
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1415
2018
|
custom?: {
|
@@ -1440,12 +2043,16 @@ interface external$3 {
|
|
1440
2043
|
ttl?: number;
|
1441
2044
|
/** @description A key for the resource data cache purging. */
|
1442
2045
|
purgeKey?: string;
|
2046
|
+
/** @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. */
|
2047
|
+
badgeIconUrl?: string;
|
2048
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1443
2049
|
headers?: {
|
1444
2050
|
[key: string]: string;
|
1445
2051
|
} | {
|
1446
2052
|
key: string;
|
1447
2053
|
value: string;
|
1448
2054
|
}[];
|
2055
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1449
2056
|
parameters?: {
|
1450
2057
|
[key: string]: string;
|
1451
2058
|
} | {
|
@@ -1462,7 +2069,7 @@ interface external$3 {
|
|
1462
2069
|
method: "GET" | "POST" | "HEAD";
|
1463
2070
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1464
2071
|
variables?: {
|
1465
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2072
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1466
2073
|
};
|
1467
2074
|
/** @description Custom configuration specific to the data source being defined */
|
1468
2075
|
custom?: {
|
@@ -1471,23 +2078,22 @@ interface external$3 {
|
|
1471
2078
|
};
|
1472
2079
|
/**
|
1473
2080
|
* @deprecated
|
1474
|
-
* @description Defines the shape of a data variable on a Data
|
2081
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
1475
2082
|
*/
|
1476
2083
|
DataVariableDefinition: {
|
1477
2084
|
/** @description Display name of the data variable */
|
1478
2085
|
displayName?: string;
|
2086
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
2087
|
+
helpText?: string;
|
1479
2088
|
/**
|
1480
|
-
* @description Type of the data variable
|
2089
|
+
* @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.
|
1481
2090
|
* @default text
|
1482
2091
|
*/
|
1483
|
-
type
|
2092
|
+
type?: string;
|
1484
2093
|
/** @description Default value of the data variable */
|
1485
2094
|
default: string;
|
1486
|
-
/**
|
1487
|
-
|
1488
|
-
* @enum {string}
|
1489
|
-
*/
|
1490
|
-
setBy: "static" | "dynamic";
|
2095
|
+
/** @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. */
|
2096
|
+
order?: number;
|
1491
2097
|
};
|
1492
2098
|
/**
|
1493
2099
|
* @deprecated
|
@@ -1495,7 +2101,7 @@ interface external$3 {
|
|
1495
2101
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1496
2102
|
*/
|
1497
2103
|
DataResourceDefinitions: {
|
1498
|
-
[key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2104
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1499
2105
|
};
|
1500
2106
|
/**
|
1501
2107
|
* @deprecated
|
@@ -1506,7 +2112,7 @@ interface external$3 {
|
|
1506
2112
|
type: string;
|
1507
2113
|
/** @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. */
|
1508
2114
|
isPatternParameter?: boolean;
|
1509
|
-
variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2115
|
+
variables?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1510
2116
|
};
|
1511
2117
|
/**
|
1512
2118
|
* @deprecated
|
@@ -1519,10 +2125,300 @@ interface external$3 {
|
|
1519
2125
|
};
|
1520
2126
|
operations: {};
|
1521
2127
|
};
|
2128
|
+
"../../../lambda/functions/v1-canvas.swagger.yml": {
|
2129
|
+
paths: {
|
2130
|
+
"/api/v1/canvas": {
|
2131
|
+
get: {
|
2132
|
+
parameters: {
|
2133
|
+
query: {
|
2134
|
+
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
2135
|
+
compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
2136
|
+
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
2137
|
+
compositionIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
2138
|
+
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2139
|
+
createdBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
2140
|
+
/**
|
2141
|
+
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2142
|
+
* NOT a full text search; does not match composition contents.
|
2143
|
+
*/
|
2144
|
+
keyword?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
2145
|
+
/** Max number of records to return */
|
2146
|
+
limit?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
2147
|
+
/** Number of records to skip */
|
2148
|
+
offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
2149
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2150
|
+
orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
2151
|
+
/**
|
2152
|
+
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2153
|
+
* If true, only pattern compositions will be returned.
|
2154
|
+
* If false, only regular compositions will be returned.
|
2155
|
+
* If omitted, both pattern and regular compositions will be returned.
|
2156
|
+
*/
|
2157
|
+
pattern?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
2158
|
+
/** The project the composition(s) are on. */
|
2159
|
+
projectId: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
2160
|
+
/** Required when using project map node id or path for fetch. */
|
2161
|
+
projectMapId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
2162
|
+
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2163
|
+
projectMapNodeId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
2164
|
+
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2165
|
+
projectMapNodePath?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
2166
|
+
/**
|
2167
|
+
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2168
|
+
* This improves performance if you do not require enhanced component data.
|
2169
|
+
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2170
|
+
*/
|
2171
|
+
skipEnhance?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
|
2172
|
+
/**
|
2173
|
+
* If true, any pattern references in the composition will be left unresolved.
|
2174
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
2175
|
+
* embedded into it, and serialize the pattern data separately.
|
2176
|
+
*/
|
2177
|
+
skipPatternResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
2178
|
+
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2179
|
+
slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
2180
|
+
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
2181
|
+
state?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
2182
|
+
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
2183
|
+
type?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
2184
|
+
/**
|
2185
|
+
* @deprecated Filters composition lists by the UI status of the composition.
|
2186
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2187
|
+
*/
|
2188
|
+
uiStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
2189
|
+
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2190
|
+
updatedBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
2191
|
+
/**
|
2192
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2193
|
+
* If false, the `_id` will not be present in the API response.
|
2194
|
+
*/
|
2195
|
+
withComponentIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
2196
|
+
/**
|
2197
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2198
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2199
|
+
*/
|
2200
|
+
withTotalCount?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
|
2201
|
+
/**
|
2202
|
+
* @deprecated Returns the UI status string of the composition.
|
2203
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2204
|
+
*/
|
2205
|
+
withUIStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
2206
|
+
};
|
2207
|
+
};
|
2208
|
+
responses: {
|
2209
|
+
/** OK */
|
2210
|
+
200: {
|
2211
|
+
content: {
|
2212
|
+
"application/json": external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2213
|
+
};
|
2214
|
+
};
|
2215
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2216
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2217
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2218
|
+
/** Composition not found */
|
2219
|
+
404: {
|
2220
|
+
content: {
|
2221
|
+
"text/plain": string;
|
2222
|
+
};
|
2223
|
+
};
|
2224
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2225
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2226
|
+
};
|
2227
|
+
};
|
2228
|
+
/** Upserts a composition */
|
2229
|
+
put: {
|
2230
|
+
responses: {
|
2231
|
+
/** OK */
|
2232
|
+
204: never;
|
2233
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2234
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2235
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2236
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2237
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2238
|
+
};
|
2239
|
+
requestBody: {
|
2240
|
+
content: {
|
2241
|
+
"application/json": {
|
2242
|
+
/**
|
2243
|
+
* Format: uuid
|
2244
|
+
* @description The project ID to upsert the composition to
|
2245
|
+
*/
|
2246
|
+
projectId: string;
|
2247
|
+
/** @description The state of the composition to upsert into. 0 = draft, 64 = published */
|
2248
|
+
state: number;
|
2249
|
+
composition: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2250
|
+
/**
|
2251
|
+
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
2252
|
+
* @default false
|
2253
|
+
*/
|
2254
|
+
pattern?: boolean;
|
2255
|
+
/** @description Ignored if present */
|
2256
|
+
created?: string;
|
2257
|
+
/** @description Ignored if present */
|
2258
|
+
modified?: string;
|
2259
|
+
};
|
2260
|
+
};
|
2261
|
+
};
|
2262
|
+
};
|
2263
|
+
/** Deletes or unpublishes a composition */
|
2264
|
+
delete: {
|
2265
|
+
responses: {
|
2266
|
+
/** OK */
|
2267
|
+
204: never;
|
2268
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2269
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2270
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2271
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2272
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2273
|
+
};
|
2274
|
+
requestBody: {
|
2275
|
+
content: {
|
2276
|
+
"application/json": {
|
2277
|
+
/**
|
2278
|
+
* Format: uuid
|
2279
|
+
* @description The ID of the composition to delete
|
2280
|
+
*/
|
2281
|
+
compositionId: string;
|
2282
|
+
/**
|
2283
|
+
* Format: uuid
|
2284
|
+
* @description The ID of the project the composition to delete belongs to
|
2285
|
+
*/
|
2286
|
+
projectId: string;
|
2287
|
+
/** @description The state of the composition to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
2288
|
+
state?: number;
|
2289
|
+
};
|
2290
|
+
};
|
2291
|
+
};
|
2292
|
+
};
|
2293
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
2294
|
+
options: {
|
2295
|
+
responses: {
|
2296
|
+
/** OK */
|
2297
|
+
204: never;
|
2298
|
+
};
|
2299
|
+
};
|
2300
|
+
};
|
2301
|
+
};
|
2302
|
+
components: {
|
2303
|
+
schemas: {
|
2304
|
+
CompositionApiResponse: {
|
2305
|
+
/** @description State of compositions to fetch. 0 = draft, 64 = published. */
|
2306
|
+
state: number;
|
2307
|
+
/**
|
2308
|
+
* @deprecated
|
2309
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
2310
|
+
* @enum {string}
|
2311
|
+
*/
|
2312
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
2313
|
+
/**
|
2314
|
+
* Format: uuid
|
2315
|
+
* @description The project ID that this layout data is part of
|
2316
|
+
*/
|
2317
|
+
projectId: string;
|
2318
|
+
/**
|
2319
|
+
* Format: date-time,
|
2320
|
+
* @description Created date string for this definition
|
2321
|
+
*/
|
2322
|
+
created: string;
|
2323
|
+
/**
|
2324
|
+
* Format: date-time,
|
2325
|
+
* @description Modified date string for this definition
|
2326
|
+
*/
|
2327
|
+
modified: string;
|
2328
|
+
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
2329
|
+
pattern: boolean;
|
2330
|
+
composition: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2331
|
+
};
|
2332
|
+
CompositionListResponse: {
|
2333
|
+
compositions: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
|
2334
|
+
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
2335
|
+
totalCount?: number;
|
2336
|
+
};
|
2337
|
+
};
|
2338
|
+
parameters: {
|
2339
|
+
/** @description The project the composition(s) are on. */
|
2340
|
+
projectId: string;
|
2341
|
+
/** @description Specify a single composition ID to fetch. Changes response from list to single. */
|
2342
|
+
compositionId: string;
|
2343
|
+
/** @description Specify multiple composition IDs to fetch. Response type will be a list. */
|
2344
|
+
compositionIDs: string[];
|
2345
|
+
/** @description Specify a single composition to fetch by slug. Changes response from list to single. */
|
2346
|
+
slug: string;
|
2347
|
+
/** @description Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2348
|
+
projectMapNodeId: string;
|
2349
|
+
/** @description Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2350
|
+
projectMapNodePath: string;
|
2351
|
+
/** @description Required when using project map node id or path for fetch. */
|
2352
|
+
projectMapId: string;
|
2353
|
+
/** @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
2354
|
+
type: string[];
|
2355
|
+
/** @description State of compositions to fetch. 0 = draft, 64 = published. */
|
2356
|
+
state: number;
|
2357
|
+
/** @description Number of records to skip */
|
2358
|
+
offset: number;
|
2359
|
+
/** @description Max number of records to return */
|
2360
|
+
limit: number;
|
2361
|
+
/**
|
2362
|
+
* @deprecated
|
2363
|
+
* @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2364
|
+
* This improves performance if you do not require enhanced component data.
|
2365
|
+
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2366
|
+
*/
|
2367
|
+
skipEnhance: boolean;
|
2368
|
+
/**
|
2369
|
+
* @description If true, any pattern references in the composition will be left unresolved.
|
2370
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
2371
|
+
* embedded into it, and serialize the pattern data separately.
|
2372
|
+
*/
|
2373
|
+
skipPatternResolution: boolean;
|
2374
|
+
/**
|
2375
|
+
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2376
|
+
* If false, the `_id` will not be present in the API response.
|
2377
|
+
*/
|
2378
|
+
withComponentIDs: boolean;
|
2379
|
+
/**
|
2380
|
+
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2381
|
+
* NOT a full text search; does not match composition contents.
|
2382
|
+
*/
|
2383
|
+
keyword: string;
|
2384
|
+
/**
|
2385
|
+
* @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
2386
|
+
* If true, only pattern compositions will be returned.
|
2387
|
+
* If false, only regular compositions will be returned.
|
2388
|
+
* If omitted, both pattern and regular compositions will be returned.
|
2389
|
+
*/
|
2390
|
+
pattern: boolean;
|
2391
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2392
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
2393
|
+
/**
|
2394
|
+
* @deprecated
|
2395
|
+
* @description Returns the UI status string of the composition.
|
2396
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2397
|
+
*/
|
2398
|
+
withUIStatus: boolean;
|
2399
|
+
/**
|
2400
|
+
* @deprecated
|
2401
|
+
* @description Filters composition lists by the UI status of the composition.
|
2402
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2403
|
+
*/
|
2404
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
2405
|
+
/** @description Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2406
|
+
createdBy: string;
|
2407
|
+
/** @description Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2408
|
+
updatedBy: string;
|
2409
|
+
/**
|
2410
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
2411
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2412
|
+
*/
|
2413
|
+
withTotalCount: boolean;
|
2414
|
+
};
|
2415
|
+
};
|
2416
|
+
operations: {};
|
2417
|
+
};
|
1522
2418
|
}
|
1523
2419
|
|
1524
|
-
declare type Components = components['schemas'];
|
1525
|
-
declare type SharedComponents = components$
|
2420
|
+
declare type Components = components$1['schemas'];
|
2421
|
+
declare type SharedComponents = components$2['schemas'];
|
1526
2422
|
declare type Api = paths$3['/api/v1/canvas'];
|
1527
2423
|
/** Query parameter options for GET /api/v1/canvas */
|
1528
2424
|
declare type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
@@ -1576,6 +2472,87 @@ declare type CanvasDefinitions = {
|
|
1576
2472
|
compositions?: Array<CompositionGetResponse>;
|
1577
2473
|
dataTypes?: Array<DataType>;
|
1578
2474
|
};
|
2475
|
+
/** Defines shared parameters for requests getting a single composition */
|
2476
|
+
declare type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
|
2477
|
+
declare type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
2478
|
+
/** Defines exact parameters for specific requests getting a single composition */
|
2479
|
+
declare type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath' | 'projectMapId'>;
|
2480
|
+
declare type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId' | 'projectMapId'>;
|
2481
|
+
declare type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
|
2482
|
+
declare type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
|
2483
|
+
/** Switches for data resolution */
|
2484
|
+
declare type DataResolutionOption = {
|
2485
|
+
unstable_resolveData?: boolean;
|
2486
|
+
};
|
2487
|
+
declare type DataResolutionOptionNegative = {
|
2488
|
+
unstable_resolveData?: false;
|
2489
|
+
};
|
2490
|
+
declare type DataResolutionOptionPositive = {
|
2491
|
+
unstable_resolveData: true;
|
2492
|
+
};
|
2493
|
+
declare type DataResolutionParameters = {
|
2494
|
+
/**
|
2495
|
+
* Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
|
2496
|
+
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
2497
|
+
*/
|
2498
|
+
unstable_dataDiagnostics?: boolean;
|
2499
|
+
/**
|
2500
|
+
* Pass dynamic variables to the composition that are required for resolving bindings and datas,
|
2501
|
+
* such as language, detail page ID, etc.
|
2502
|
+
*/
|
2503
|
+
unstable_dynamicVariables?: Record<string, string>;
|
2504
|
+
};
|
2505
|
+
/** Types of issue that can occur when fetching composition data */
|
2506
|
+
declare type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
|
2507
|
+
declare type CompositionIssueCore = components['schemas']['CompositionIssue'];
|
2508
|
+
/** An error that occured resolving a pattern that is referenced on the composition */
|
2509
|
+
declare type CompositionPatternIssue = CompositionIssueCore & {
|
2510
|
+
type: 'pattern';
|
2511
|
+
code: NonNullable<ComponentInstance['_patternError']>;
|
2512
|
+
};
|
2513
|
+
/** An error while binding a data element from a data resource to a component parameter (i.e. a missing property in the data resource) */
|
2514
|
+
declare type DataElementBindingIssue = CompositionIssueCore & {
|
2515
|
+
type: 'binding';
|
2516
|
+
parameterName: string;
|
2517
|
+
};
|
2518
|
+
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
2519
|
+
declare type DataResourceIssue = CompositionIssueCore & {
|
2520
|
+
type: 'data';
|
2521
|
+
dataName: string;
|
2522
|
+
dataType: string;
|
2523
|
+
};
|
2524
|
+
/** An issue that occurred while binding dynamic variables to composition data resources */
|
2525
|
+
declare type DataResourceVariableIssue = CompositionIssueCore & {
|
2526
|
+
type: 'variable';
|
2527
|
+
variableName: string;
|
2528
|
+
};
|
2529
|
+
declare type DataResolutionConfigIssue = {
|
2530
|
+
message: string;
|
2531
|
+
type: 'config';
|
2532
|
+
};
|
2533
|
+
/** Diagnostic data about the load performance of attached composition datas */
|
2534
|
+
declare type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
|
2535
|
+
/** Response as it comes from the data resolution endpoint */
|
2536
|
+
declare type CompositionResolvedGetResponse = CompositionGetResponse & {
|
2537
|
+
/**
|
2538
|
+
* Copies of resolved data and how long it took to resolve each data.
|
2539
|
+
* Only set when dataDiagnostics=true is passed to the options.
|
2540
|
+
*/
|
2541
|
+
dataDiagnostics?: Array<CompositionDataDiagnostic>;
|
2542
|
+
/**
|
2543
|
+
* Any failures to bind to data that occured on bindings marked 'must exist'.
|
2544
|
+
* If no failures occurred, this will be undefined.
|
2545
|
+
* NOTE: No exception will be thrown if this type of error occurs. You must inspect this property if you care to cause client errors.
|
2546
|
+
*/
|
2547
|
+
errors?: Array<CompositionIssue>;
|
2548
|
+
/**
|
2549
|
+
* Any failures to bind to data that occurred on optional bindings. In most cases, these are only informational (i.e. data is bound to a property that does not always exist)
|
2550
|
+
* If no failures occurred, this will be undefined.
|
2551
|
+
*/
|
2552
|
+
warnings?: Array<CompositionIssue>;
|
2553
|
+
};
|
2554
|
+
/** All valid response types */
|
2555
|
+
declare type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
1579
2556
|
|
1580
2557
|
/**
|
1581
2558
|
* This file was auto-generated by openapi-typescript.
|
@@ -1974,12 +2951,16 @@ interface external$2 {
|
|
1974
2951
|
ttl?: number;
|
1975
2952
|
/** @description A key for the resource data cache purging. */
|
1976
2953
|
purgeKey?: string;
|
2954
|
+
/** @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. */
|
2955
|
+
badgeIconUrl?: string;
|
2956
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1977
2957
|
headers?: {
|
1978
2958
|
[key: string]: string;
|
1979
2959
|
} | {
|
1980
2960
|
key: string;
|
1981
2961
|
value: string;
|
1982
2962
|
}[];
|
2963
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1983
2964
|
parameters?: {
|
1984
2965
|
[key: string]: string;
|
1985
2966
|
} | {
|
@@ -2005,23 +2986,22 @@ interface external$2 {
|
|
2005
2986
|
};
|
2006
2987
|
/**
|
2007
2988
|
* @deprecated
|
2008
|
-
* @description Defines the shape of a data variable on a Data
|
2989
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2009
2990
|
*/
|
2010
2991
|
DataVariableDefinition: {
|
2011
2992
|
/** @description Display name of the data variable */
|
2012
2993
|
displayName?: string;
|
2994
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
2995
|
+
helpText?: string;
|
2013
2996
|
/**
|
2014
|
-
* @description Type of the data variable
|
2997
|
+
* @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.
|
2015
2998
|
* @default text
|
2016
2999
|
*/
|
2017
|
-
type
|
3000
|
+
type?: string;
|
2018
3001
|
/** @description Default value of the data variable */
|
2019
3002
|
default: string;
|
2020
|
-
/**
|
2021
|
-
|
2022
|
-
* @enum {string}
|
2023
|
-
*/
|
2024
|
-
setBy: "static" | "dynamic";
|
3003
|
+
/** @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. */
|
3004
|
+
order?: number;
|
2025
3005
|
};
|
2026
3006
|
/**
|
2027
3007
|
* @deprecated
|
@@ -2455,12 +3435,16 @@ interface external$1 {
|
|
2455
3435
|
ttl?: number;
|
2456
3436
|
/** @description A key for the resource data cache purging. */
|
2457
3437
|
purgeKey?: string;
|
3438
|
+
/** @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. */
|
3439
|
+
badgeIconUrl?: string;
|
3440
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2458
3441
|
headers?: {
|
2459
3442
|
[key: string]: string;
|
2460
3443
|
} | {
|
2461
3444
|
key: string;
|
2462
3445
|
value: string;
|
2463
3446
|
}[];
|
3447
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2464
3448
|
parameters?: {
|
2465
3449
|
[key: string]: string;
|
2466
3450
|
} | {
|
@@ -2486,23 +3470,22 @@ interface external$1 {
|
|
2486
3470
|
};
|
2487
3471
|
/**
|
2488
3472
|
* @deprecated
|
2489
|
-
* @description Defines the shape of a data variable on a Data
|
3473
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2490
3474
|
*/
|
2491
3475
|
DataVariableDefinition: {
|
2492
3476
|
/** @description Display name of the data variable */
|
2493
3477
|
displayName?: string;
|
3478
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
3479
|
+
helpText?: string;
|
2494
3480
|
/**
|
2495
|
-
* @description Type of the data variable
|
3481
|
+
* @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.
|
2496
3482
|
* @default text
|
2497
3483
|
*/
|
2498
|
-
type
|
3484
|
+
type?: string;
|
2499
3485
|
/** @description Default value of the data variable */
|
2500
3486
|
default: string;
|
2501
|
-
/**
|
2502
|
-
|
2503
|
-
* @enum {string}
|
2504
|
-
*/
|
2505
|
-
setBy: "static" | "dynamic";
|
3487
|
+
/** @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. */
|
3488
|
+
order?: number;
|
2506
3489
|
};
|
2507
3490
|
/**
|
2508
3491
|
* @deprecated
|
@@ -2893,12 +3876,16 @@ interface external {
|
|
2893
3876
|
ttl?: number;
|
2894
3877
|
/** @description A key for the resource data cache purging. */
|
2895
3878
|
purgeKey?: string;
|
3879
|
+
/** @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. */
|
3880
|
+
badgeIconUrl?: string;
|
3881
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2896
3882
|
headers?: {
|
2897
3883
|
[key: string]: string;
|
2898
3884
|
} | {
|
2899
3885
|
key: string;
|
2900
3886
|
value: string;
|
2901
3887
|
}[];
|
3888
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2902
3889
|
parameters?: {
|
2903
3890
|
[key: string]: string;
|
2904
3891
|
} | {
|
@@ -2924,23 +3911,22 @@ interface external {
|
|
2924
3911
|
};
|
2925
3912
|
/**
|
2926
3913
|
* @deprecated
|
2927
|
-
* @description Defines the shape of a data variable on a Data
|
3914
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
2928
3915
|
*/
|
2929
3916
|
DataVariableDefinition: {
|
2930
3917
|
/** @description Display name of the data variable */
|
2931
3918
|
displayName?: string;
|
3919
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
3920
|
+
helpText?: string;
|
2932
3921
|
/**
|
2933
|
-
* @description Type of the data variable
|
3922
|
+
* @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.
|
2934
3923
|
* @default text
|
2935
3924
|
*/
|
2936
|
-
type
|
3925
|
+
type?: string;
|
2937
3926
|
/** @description Default value of the data variable */
|
2938
3927
|
default: string;
|
2939
|
-
/**
|
2940
|
-
|
2941
|
-
* @enum {string}
|
2942
|
-
*/
|
2943
|
-
setBy: "static" | "dynamic";
|
3928
|
+
/** @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. */
|
3929
|
+
order?: number;
|
2944
3930
|
};
|
2945
3931
|
/**
|
2946
3932
|
* @deprecated
|
@@ -2997,10 +3983,10 @@ declare type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200'][
|
|
2997
3983
|
declare type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
2998
3984
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
2999
3985
|
declare type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
3000
|
-
declare type DataType = components$
|
3001
|
-
declare type DataSource = components$
|
3002
|
-
declare type DataSourceInfo = components$
|
3003
|
-
declare type DataVariableDefinition = components$
|
3986
|
+
declare type DataType = components$2['schemas']['DataType'];
|
3987
|
+
declare type DataSource = components$2['schemas']['DataSource'];
|
3988
|
+
declare type DataSourceInfo = components$2['schemas']['DataSourceInfo'];
|
3989
|
+
declare type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
|
3004
3990
|
|
3005
3991
|
/**
|
3006
3992
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
@@ -3027,4 +4013,4 @@ declare global {
|
|
3027
4013
|
*/
|
3028
4014
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
3029
4015
|
|
3030
|
-
export {
|
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 };
|