@uniformdev/canvas 19.1.0 → 19.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1645 -471
- package/dist/index.esm.js +49 -3
- package/dist/index.js +56 -6
- package/dist/index.mjs +49 -3
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -5,13 +5,13 @@ import { Options as Options$1 } from 'p-retry';
|
|
5
5
|
import { Options } from 'p-throttle';
|
6
6
|
import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
|
7
7
|
|
8
|
-
interface components$
|
8
|
+
interface components$3 {
|
9
9
|
schemas: {
|
10
10
|
/** @description Public ID (used in code). Do not change after creation. */
|
11
11
|
PublicIdProperty: string;
|
12
12
|
/** @description The definition of a component parameter */
|
13
13
|
ComponentDefinitionParameter: {
|
14
|
-
id: components$
|
14
|
+
id: components$3["schemas"]["PublicIdProperty"];
|
15
15
|
/** @description Friendly name of the parameter */
|
16
16
|
name: string;
|
17
17
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -23,7 +23,7 @@ interface components$2 {
|
|
23
23
|
};
|
24
24
|
/** @description The definition of a named component slot that can contain other components */
|
25
25
|
ComponentDefinitionSlot: {
|
26
|
-
id: components$
|
26
|
+
id: components$3["schemas"]["PublicIdProperty"];
|
27
27
|
/** @description Friendly name of the slot */
|
28
28
|
name: string;
|
29
29
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -81,13 +81,13 @@ interface components$2 {
|
|
81
81
|
};
|
82
82
|
/** @description The definition of a component variant */
|
83
83
|
ComponentDefinitionVariant: {
|
84
|
-
id: components$
|
84
|
+
id: components$3["schemas"]["PublicIdProperty"];
|
85
85
|
/** @description Friendly name of the variant */
|
86
86
|
name: string;
|
87
87
|
};
|
88
88
|
/** @description Permission set for a component defintion */
|
89
89
|
ComponentDefinitionPermission: {
|
90
|
-
roleId: components$
|
90
|
+
roleId: components$3["schemas"]["PublicIdProperty"];
|
91
91
|
/**
|
92
92
|
* @description Permission type for this permission ComponentDefinition:
|
93
93
|
* read | write | create | delete
|
@@ -100,7 +100,7 @@ interface components$2 {
|
|
100
100
|
};
|
101
101
|
/** @description Defines a component type that can live on a Composition */
|
102
102
|
ComponentDefinition: {
|
103
|
-
id: components$
|
103
|
+
id: components$3["schemas"]["PublicIdProperty"];
|
104
104
|
/** @description Friendly name of the component definition */
|
105
105
|
name: string;
|
106
106
|
/**
|
@@ -119,21 +119,21 @@ interface components$2 {
|
|
119
119
|
*/
|
120
120
|
canBeComposition?: boolean;
|
121
121
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
122
|
-
parameters?: components$
|
122
|
+
parameters?: components$3["schemas"]["ComponentDefinitionParameter"][];
|
123
123
|
/**
|
124
124
|
* @description if this component uses team permissions or custom permissions
|
125
125
|
* @default true
|
126
126
|
*/
|
127
127
|
useTeamPermissions?: boolean;
|
128
128
|
/** @description Custom role permissions for this component definition */
|
129
|
-
permissions?: components$
|
129
|
+
permissions?: components$3["schemas"]["ComponentDefinitionPermission"][];
|
130
130
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
131
|
-
slots?: components$
|
132
|
-
slugSettings?: components$
|
131
|
+
slots?: components$3["schemas"]["ComponentDefinitionSlot"][];
|
132
|
+
slugSettings?: components$3["schemas"]["ComponentDefinitionSlugSettings"];
|
133
133
|
/** @description Default component instance value */
|
134
|
-
defaults?: components$
|
134
|
+
defaults?: components$3["schemas"]["ComponentInstance"] | null;
|
135
135
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
136
|
-
variants?: components$
|
136
|
+
variants?: components$3["schemas"]["ComponentDefinitionVariant"][];
|
137
137
|
/** @description Created date string for this definition (ignored for writes) */
|
138
138
|
created?: string;
|
139
139
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -145,7 +145,7 @@ interface components$2 {
|
|
145
145
|
value: unknown;
|
146
146
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
147
147
|
type: string;
|
148
|
-
connectedData?: components$
|
148
|
+
connectedData?: components$3["schemas"]["DataElementConnectionDefinition"];
|
149
149
|
};
|
150
150
|
/**
|
151
151
|
* @description Defines a connection to a data element on a data resource.
|
@@ -168,13 +168,13 @@ interface components$2 {
|
|
168
168
|
type: string;
|
169
169
|
/** @description Component parameter values for the component instance */
|
170
170
|
parameters?: {
|
171
|
-
[key: string]: components$
|
171
|
+
[key: string]: components$3["schemas"]["ComponentParameter"];
|
172
172
|
};
|
173
173
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
174
174
|
variant?: string;
|
175
175
|
/** @description Slots containing any child components */
|
176
176
|
slots?: {
|
177
|
-
[key: string]: components$
|
177
|
+
[key: string]: components$3["schemas"]["ComponentInstance"][];
|
178
178
|
};
|
179
179
|
/**
|
180
180
|
* @description Unique identifier of the component within the composition.
|
@@ -184,13 +184,13 @@ interface components$2 {
|
|
184
184
|
_id?: string;
|
185
185
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
186
186
|
_pattern?: string;
|
187
|
-
_dataResources?: components$
|
187
|
+
_dataResources?: components$3["schemas"]["DataResourceDefinitions"];
|
188
188
|
/**
|
189
189
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
190
190
|
* Means nothing for PUTs; it will be ignored.
|
191
191
|
*/
|
192
192
|
_patternDataResources?: {
|
193
|
-
[key: string]: components$
|
193
|
+
[key: string]: components$3["schemas"]["DataResourceDefinition"];
|
194
194
|
};
|
195
195
|
/**
|
196
196
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -214,7 +214,7 @@ interface components$2 {
|
|
214
214
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
215
215
|
*/
|
216
216
|
_overrides?: {
|
217
|
-
[key: string]: components$
|
217
|
+
[key: string]: components$3["schemas"]["ComponentOverride"];
|
218
218
|
};
|
219
219
|
/**
|
220
220
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -223,7 +223,7 @@ interface components$2 {
|
|
223
223
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
224
224
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
225
225
|
*/
|
226
|
-
_overridability?: components$
|
226
|
+
_overridability?: components$3["schemas"]["ComponentOverridability"];
|
227
227
|
};
|
228
228
|
/** @description Defines the shape of the root component in a composition */
|
229
229
|
RootComponentInstance: {
|
@@ -231,15 +231,15 @@ interface components$2 {
|
|
231
231
|
type: string;
|
232
232
|
/** @description Component parameter values for the component instance */
|
233
233
|
parameters?: {
|
234
|
-
[key: string]: components$
|
234
|
+
[key: string]: components$3["schemas"]["ComponentParameter"];
|
235
235
|
};
|
236
236
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
237
237
|
variant?: string;
|
238
238
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
239
|
-
projectMapNodes?: components$
|
239
|
+
projectMapNodes?: components$3["schemas"]["CompositionProjectMapNodeInfo"][];
|
240
240
|
/** @description Slots containing any child components */
|
241
241
|
slots?: {
|
242
|
-
[key: string]: components$
|
242
|
+
[key: string]: components$3["schemas"]["ComponentInstance"][];
|
243
243
|
};
|
244
244
|
/** @description The public UUID of the composition. */
|
245
245
|
_id: string;
|
@@ -247,7 +247,7 @@ interface components$2 {
|
|
247
247
|
_slug?: string | null;
|
248
248
|
/** @description Friendly name of this component. */
|
249
249
|
_name: string;
|
250
|
-
_dataResources?: components$
|
250
|
+
_dataResources?: components$3["schemas"]["DataResourceDefinitions"];
|
251
251
|
/**
|
252
252
|
* @description Defines patch overrides to component IDs that live in the composition.
|
253
253
|
* This can be used to override parameters that are defined on patterns,
|
@@ -261,7 +261,7 @@ interface components$2 {
|
|
261
261
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
262
262
|
*/
|
263
263
|
_overrides?: {
|
264
|
-
[key: string]: components$
|
264
|
+
[key: string]: components$3["schemas"]["ComponentOverride"];
|
265
265
|
};
|
266
266
|
/**
|
267
267
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -270,7 +270,7 @@ interface components$2 {
|
|
270
270
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
271
271
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
272
272
|
*/
|
273
|
-
_overridability?: components$
|
273
|
+
_overridability?: components$3["schemas"]["ComponentOverridability"];
|
274
274
|
};
|
275
275
|
/**
|
276
276
|
* @description Defines how to override a specific component.
|
@@ -280,7 +280,7 @@ interface components$2 {
|
|
280
280
|
*/
|
281
281
|
ComponentOverride: {
|
282
282
|
parameters?: {
|
283
|
-
[key: string]: components$
|
283
|
+
[key: string]: components$3["schemas"]["ComponentParameter"];
|
284
284
|
};
|
285
285
|
variant?: string;
|
286
286
|
};
|
@@ -294,7 +294,7 @@ interface components$2 {
|
|
294
294
|
ComponentOverridability: {
|
295
295
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
296
296
|
parameters?: {
|
297
|
-
[key: string]: components$
|
297
|
+
[key: string]: components$3["schemas"]["OverrideOptions"];
|
298
298
|
};
|
299
299
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
300
300
|
variants?: boolean;
|
@@ -335,7 +335,7 @@ interface components$2 {
|
|
335
335
|
}[];
|
336
336
|
/** @description Variables needed to make calls to the data source */
|
337
337
|
variables?: {
|
338
|
-
[key: string]: components$
|
338
|
+
[key: string]: components$3["schemas"]["DataVariableDefinition"];
|
339
339
|
};
|
340
340
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
341
341
|
custom?: {
|
@@ -392,7 +392,7 @@ interface components$2 {
|
|
392
392
|
method: "GET" | "POST" | "HEAD";
|
393
393
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
394
394
|
variables?: {
|
395
|
-
[key: string]: components$
|
395
|
+
[key: string]: components$3["schemas"]["DataVariableDefinition"];
|
396
396
|
};
|
397
397
|
/** @description Custom configuration specific to the data source being defined */
|
398
398
|
custom?: {
|
@@ -420,7 +420,7 @@ interface components$2 {
|
|
420
420
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
421
421
|
*/
|
422
422
|
DataResourceDefinitions: {
|
423
|
-
[key: string]: components$
|
423
|
+
[key: string]: components$3["schemas"]["DataResourceDefinition"];
|
424
424
|
};
|
425
425
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
426
426
|
DataResourceDefinition: {
|
@@ -434,7 +434,7 @@ interface components$2 {
|
|
434
434
|
* If isPatternParameter is false or undefined, this has no meaning.
|
435
435
|
*/
|
436
436
|
ignorePatternParameterDefault?: boolean;
|
437
|
-
variables?: components$
|
437
|
+
variables?: components$3["schemas"]["DataResourceVariables"];
|
438
438
|
};
|
439
439
|
/** @description Variable values for a data resource. */
|
440
440
|
DataResourceVariables: {
|
@@ -462,7 +462,7 @@ interface components$2 {
|
|
462
462
|
* This file was auto-generated by openapi-typescript.
|
463
463
|
* Do not make direct changes to the file.
|
464
464
|
*/
|
465
|
-
interface paths$
|
465
|
+
interface paths$7 {
|
466
466
|
"/api/v1/canvas-definitions": {
|
467
467
|
get: {
|
468
468
|
parameters: {
|
@@ -485,15 +485,15 @@ interface paths$6 {
|
|
485
485
|
content: {
|
486
486
|
"application/json": {
|
487
487
|
/** @description Component definitions that match the query */
|
488
|
-
componentDefinitions: external$
|
488
|
+
componentDefinitions: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
489
489
|
};
|
490
490
|
};
|
491
491
|
};
|
492
|
-
400: external$
|
493
|
-
401: external$
|
494
|
-
403: external$
|
495
|
-
429: external$
|
496
|
-
500: external$
|
492
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
493
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
494
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
495
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
496
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
497
497
|
};
|
498
498
|
};
|
499
499
|
/** Upserts a component definition */
|
@@ -501,11 +501,11 @@ interface paths$6 {
|
|
501
501
|
responses: {
|
502
502
|
/** OK */
|
503
503
|
204: never;
|
504
|
-
400: external$
|
505
|
-
401: external$
|
506
|
-
403: external$
|
507
|
-
429: external$
|
508
|
-
500: external$
|
504
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
505
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
506
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
507
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
508
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
509
509
|
};
|
510
510
|
requestBody: {
|
511
511
|
content: {
|
@@ -515,7 +515,7 @@ interface paths$6 {
|
|
515
515
|
* @description The project ID to upsert the component definition to
|
516
516
|
*/
|
517
517
|
projectId: string;
|
518
|
-
componentDefinition: external$
|
518
|
+
componentDefinition: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
519
519
|
};
|
520
520
|
};
|
521
521
|
};
|
@@ -525,11 +525,11 @@ interface paths$6 {
|
|
525
525
|
responses: {
|
526
526
|
/** OK */
|
527
527
|
204: never;
|
528
|
-
400: external$
|
529
|
-
401: external$
|
530
|
-
403: external$
|
531
|
-
429: external$
|
532
|
-
500: external$
|
528
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
529
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
530
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
531
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
532
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
533
533
|
};
|
534
534
|
requestBody: {
|
535
535
|
content: {
|
@@ -554,7 +554,7 @@ interface paths$6 {
|
|
554
554
|
};
|
555
555
|
};
|
556
556
|
}
|
557
|
-
interface external$
|
557
|
+
interface external$8 {
|
558
558
|
"swagger.yml": {
|
559
559
|
paths: {};
|
560
560
|
components: {
|
@@ -568,25 +568,25 @@ interface external$7 {
|
|
568
568
|
/** Request input validation failed */
|
569
569
|
BadRequestError: {
|
570
570
|
content: {
|
571
|
-
"application/json": external$
|
571
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
572
572
|
};
|
573
573
|
};
|
574
574
|
/** API key or token was not valid */
|
575
575
|
UnauthorizedError: {
|
576
576
|
content: {
|
577
|
-
"application/json": external$
|
577
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
578
578
|
};
|
579
579
|
};
|
580
580
|
/** Permission was denied */
|
581
581
|
ForbiddenError: {
|
582
582
|
content: {
|
583
|
-
"application/json": external$
|
583
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
584
584
|
};
|
585
585
|
};
|
586
586
|
/** Resource not found */
|
587
587
|
NotFoundError: {
|
588
588
|
content: {
|
589
|
-
"application/json": external$
|
589
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
590
590
|
};
|
591
591
|
};
|
592
592
|
/** Too many requests in allowed time period */
|
@@ -605,7 +605,7 @@ interface external$7 {
|
|
605
605
|
PublicIdProperty: string;
|
606
606
|
/** @description The definition of a component parameter */
|
607
607
|
ComponentDefinitionParameter: {
|
608
|
-
id: external$
|
608
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
609
609
|
/** @description Friendly name of the parameter */
|
610
610
|
name: string;
|
611
611
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -617,7 +617,7 @@ interface external$7 {
|
|
617
617
|
};
|
618
618
|
/** @description The definition of a named component slot that can contain other components */
|
619
619
|
ComponentDefinitionSlot: {
|
620
|
-
id: external$
|
620
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
621
621
|
/** @description Friendly name of the slot */
|
622
622
|
name: string;
|
623
623
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -675,13 +675,13 @@ interface external$7 {
|
|
675
675
|
};
|
676
676
|
/** @description The definition of a component variant */
|
677
677
|
ComponentDefinitionVariant: {
|
678
|
-
id: external$
|
678
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
679
679
|
/** @description Friendly name of the variant */
|
680
680
|
name: string;
|
681
681
|
};
|
682
682
|
/** @description Permission set for a component defintion */
|
683
683
|
ComponentDefinitionPermission: {
|
684
|
-
roleId: external$
|
684
|
+
roleId: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
685
685
|
/**
|
686
686
|
* @description Permission type for this permission ComponentDefinition:
|
687
687
|
* read | write | create | delete
|
@@ -694,7 +694,7 @@ interface external$7 {
|
|
694
694
|
};
|
695
695
|
/** @description Defines a component type that can live on a Composition */
|
696
696
|
ComponentDefinition: {
|
697
|
-
id: external$
|
697
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
698
698
|
/** @description Friendly name of the component definition */
|
699
699
|
name: string;
|
700
700
|
/**
|
@@ -713,21 +713,21 @@ interface external$7 {
|
|
713
713
|
*/
|
714
714
|
canBeComposition?: boolean;
|
715
715
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
716
|
-
parameters?: external$
|
716
|
+
parameters?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
717
717
|
/**
|
718
718
|
* @description if this component uses team permissions or custom permissions
|
719
719
|
* @default true
|
720
720
|
*/
|
721
721
|
useTeamPermissions?: boolean;
|
722
722
|
/** @description Custom role permissions for this component definition */
|
723
|
-
permissions?: external$
|
723
|
+
permissions?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
724
724
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
725
|
-
slots?: external$
|
726
|
-
slugSettings?: external$
|
725
|
+
slots?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
726
|
+
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
727
727
|
/** @description Default component instance value */
|
728
|
-
defaults?: external$
|
728
|
+
defaults?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
729
729
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
730
|
-
variants?: external$
|
730
|
+
variants?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
731
731
|
/** @description Created date string for this definition (ignored for writes) */
|
732
732
|
created?: string;
|
733
733
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -739,7 +739,7 @@ interface external$7 {
|
|
739
739
|
value: unknown;
|
740
740
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
741
741
|
type: string;
|
742
|
-
connectedData?: external$
|
742
|
+
connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
743
743
|
};
|
744
744
|
/**
|
745
745
|
* @description Defines a connection to a data element on a data resource.
|
@@ -762,13 +762,13 @@ interface external$7 {
|
|
762
762
|
type: string;
|
763
763
|
/** @description Component parameter values for the component instance */
|
764
764
|
parameters?: {
|
765
|
-
[key: string]: external$
|
765
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
766
766
|
};
|
767
767
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
768
768
|
variant?: string;
|
769
769
|
/** @description Slots containing any child components */
|
770
770
|
slots?: {
|
771
|
-
[key: string]: external$
|
771
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
772
772
|
};
|
773
773
|
/**
|
774
774
|
* @description Unique identifier of the component within the composition.
|
@@ -778,13 +778,13 @@ interface external$7 {
|
|
778
778
|
_id?: string;
|
779
779
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
780
780
|
_pattern?: string;
|
781
|
-
_dataResources?: external$
|
781
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
782
782
|
/**
|
783
783
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
784
784
|
* Means nothing for PUTs; it will be ignored.
|
785
785
|
*/
|
786
786
|
_patternDataResources?: {
|
787
|
-
[key: string]: external$
|
787
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
788
788
|
};
|
789
789
|
/**
|
790
790
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -808,7 +808,7 @@ interface external$7 {
|
|
808
808
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
809
809
|
*/
|
810
810
|
_overrides?: {
|
811
|
-
[key: string]: external$
|
811
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
812
812
|
};
|
813
813
|
/**
|
814
814
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -817,7 +817,7 @@ interface external$7 {
|
|
817
817
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
818
818
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
819
819
|
*/
|
820
|
-
_overridability?: external$
|
820
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
821
821
|
};
|
822
822
|
/** @description Defines the shape of the root component in a composition */
|
823
823
|
RootComponentInstance: {
|
@@ -825,15 +825,15 @@ interface external$7 {
|
|
825
825
|
type: string;
|
826
826
|
/** @description Component parameter values for the component instance */
|
827
827
|
parameters?: {
|
828
|
-
[key: string]: external$
|
828
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
829
829
|
};
|
830
830
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
831
831
|
variant?: string;
|
832
832
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
833
|
-
projectMapNodes?: external$
|
833
|
+
projectMapNodes?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
834
834
|
/** @description Slots containing any child components */
|
835
835
|
slots?: {
|
836
|
-
[key: string]: external$
|
836
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
837
837
|
};
|
838
838
|
/** @description The public UUID of the composition. */
|
839
839
|
_id: string;
|
@@ -841,7 +841,7 @@ interface external$7 {
|
|
841
841
|
_slug?: string | null;
|
842
842
|
/** @description Friendly name of this component. */
|
843
843
|
_name: string;
|
844
|
-
_dataResources?: external$
|
844
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
845
845
|
/**
|
846
846
|
* @description Defines patch overrides to component IDs that live in the composition.
|
847
847
|
* This can be used to override parameters that are defined on patterns,
|
@@ -855,7 +855,7 @@ interface external$7 {
|
|
855
855
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
856
856
|
*/
|
857
857
|
_overrides?: {
|
858
|
-
[key: string]: external$
|
858
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
859
859
|
};
|
860
860
|
/**
|
861
861
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -864,7 +864,7 @@ interface external$7 {
|
|
864
864
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
865
865
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
866
866
|
*/
|
867
|
-
_overridability?: external$
|
867
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
868
868
|
};
|
869
869
|
/**
|
870
870
|
* @description Defines how to override a specific component.
|
@@ -874,7 +874,7 @@ interface external$7 {
|
|
874
874
|
*/
|
875
875
|
ComponentOverride: {
|
876
876
|
parameters?: {
|
877
|
-
[key: string]: external$
|
877
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
878
878
|
};
|
879
879
|
variant?: string;
|
880
880
|
};
|
@@ -888,7 +888,7 @@ interface external$7 {
|
|
888
888
|
ComponentOverridability: {
|
889
889
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
890
890
|
parameters?: {
|
891
|
-
[key: string]: external$
|
891
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
892
892
|
};
|
893
893
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
894
894
|
variants?: boolean;
|
@@ -929,7 +929,7 @@ interface external$7 {
|
|
929
929
|
}[];
|
930
930
|
/** @description Variables needed to make calls to the data source */
|
931
931
|
variables?: {
|
932
|
-
[key: string]: external$
|
932
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
933
933
|
};
|
934
934
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
935
935
|
custom?: {
|
@@ -986,7 +986,7 @@ interface external$7 {
|
|
986
986
|
method: "GET" | "POST" | "HEAD";
|
987
987
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
988
988
|
variables?: {
|
989
|
-
[key: string]: external$
|
989
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
990
990
|
};
|
991
991
|
/** @description Custom configuration specific to the data source being defined */
|
992
992
|
custom?: {
|
@@ -1014,7 +1014,7 @@ interface external$7 {
|
|
1014
1014
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1015
1015
|
*/
|
1016
1016
|
DataResourceDefinitions: {
|
1017
|
-
[key: string]: external$
|
1017
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1018
1018
|
};
|
1019
1019
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1020
1020
|
DataResourceDefinition: {
|
@@ -1028,7 +1028,7 @@ interface external$7 {
|
|
1028
1028
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1029
1029
|
*/
|
1030
1030
|
ignorePatternParameterDefault?: boolean;
|
1031
|
-
variables?: external$
|
1031
|
+
variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1032
1032
|
};
|
1033
1033
|
/** @description Variable values for a data resource. */
|
1034
1034
|
DataResourceVariables: {
|
@@ -1055,8 +1055,8 @@ interface external$7 {
|
|
1055
1055
|
};
|
1056
1056
|
}
|
1057
1057
|
|
1058
|
-
type SharedComponents$1 = components$
|
1059
|
-
type Api$1 = paths$
|
1058
|
+
type SharedComponents$1 = components$3['schemas'];
|
1059
|
+
type Api$1 = paths$7['/api/v1/canvas-definitions'];
|
1060
1060
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1061
1061
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1062
1062
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1066,7 +1066,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
|
|
1066
1066
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1067
1067
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
1068
1068
|
/** The definition of a component parameter */
|
1069
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
1069
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$3['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1070
1070
|
typeConfig?: TConfig;
|
1071
1071
|
};
|
1072
1072
|
/** The definition of a component visual variant */
|
@@ -1084,118 +1084,118 @@ type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
|
1084
1084
|
* This file was auto-generated by openapi-typescript.
|
1085
1085
|
* Do not make direct changes to the file.
|
1086
1086
|
*/
|
1087
|
-
interface paths$
|
1087
|
+
interface paths$6 {
|
1088
1088
|
"/api/v1/canvas": {
|
1089
1089
|
get: {
|
1090
1090
|
parameters: {
|
1091
1091
|
query: {
|
1092
1092
|
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
1093
|
-
compositionId?: components$
|
1093
|
+
compositionId?: components$2["parameters"]["compositionId"];
|
1094
1094
|
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
1095
|
-
compositionIDs?: components$
|
1095
|
+
compositionIDs?: components$2["parameters"]["compositionIDs"];
|
1096
1096
|
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
1097
|
-
createdBy?: components$
|
1097
|
+
createdBy?: components$2["parameters"]["createdBy"];
|
1098
1098
|
/**
|
1099
1099
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
1100
1100
|
* NOT a full text search; does not match composition contents.
|
1101
1101
|
*/
|
1102
|
-
keyword?: components$
|
1102
|
+
keyword?: components$2["parameters"]["keyword"];
|
1103
1103
|
/** Max number of records to return */
|
1104
|
-
limit?: components$
|
1104
|
+
limit?: components$2["parameters"]["limit"];
|
1105
1105
|
/** Number of records to skip */
|
1106
|
-
offset?: components$
|
1106
|
+
offset?: components$2["parameters"]["offset"];
|
1107
1107
|
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
1108
|
-
orderBy?: components$
|
1108
|
+
orderBy?: components$2["parameters"]["orderBy"];
|
1109
1109
|
/**
|
1110
1110
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
1111
1111
|
* If true, only pattern compositions will be returned.
|
1112
1112
|
* If false, only regular compositions will be returned.
|
1113
1113
|
* If omitted, both pattern and regular compositions will be returned.
|
1114
1114
|
*/
|
1115
|
-
pattern?: components$
|
1115
|
+
pattern?: components$2["parameters"]["pattern"];
|
1116
1116
|
/** The project the composition(s) are on. */
|
1117
|
-
projectId: components$
|
1118
|
-
/**
|
1119
|
-
projectMapId?: components$
|
1117
|
+
projectId: components$2["parameters"]["projectId"];
|
1118
|
+
/** Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
1119
|
+
projectMapId?: components$2["parameters"]["projectMapId"];
|
1120
1120
|
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
1121
|
-
projectMapNodeId?: components$
|
1121
|
+
projectMapNodeId?: components$2["parameters"]["projectMapNodeId"];
|
1122
1122
|
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
1123
|
-
projectMapNodePath?: components$
|
1123
|
+
projectMapNodePath?: components$2["parameters"]["projectMapNodePath"];
|
1124
1124
|
/**
|
1125
1125
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
1126
1126
|
* This improves performance if you do not require enhanced component data.
|
1127
1127
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
1128
1128
|
*/
|
1129
|
-
skipEnhance?: components$
|
1129
|
+
skipEnhance?: components$2["parameters"]["skipEnhance"];
|
1130
1130
|
/**
|
1131
1131
|
* If true, any pattern references in the composition will be left unresolved.
|
1132
1132
|
* This is appropriate if you intend to serialize the composition without patterns
|
1133
1133
|
* embedded into it, and serialize the pattern data separately.
|
1134
1134
|
*/
|
1135
|
-
skipPatternResolution?: components$
|
1135
|
+
skipPatternResolution?: components$2["parameters"]["skipPatternResolution"];
|
1136
1136
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
1137
|
-
skipParameterResolution?: components$
|
1137
|
+
skipParameterResolution?: components$2["parameters"]["skipParameterResolution"];
|
1138
1138
|
/**
|
1139
1139
|
* If true, any pattern override data is not resolved by the API.
|
1140
1140
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
1141
1141
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
1142
1142
|
*/
|
1143
|
-
skipOverridesResolution?: components$
|
1143
|
+
skipOverridesResolution?: components$2["parameters"]["skipOverridesResolution"];
|
1144
1144
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
1145
|
-
slug?: components$
|
1146
|
-
/**
|
1147
|
-
state?: components$
|
1145
|
+
slug?: components$2["parameters"]["slug"];
|
1146
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
1147
|
+
state?: components$2["parameters"]["state"];
|
1148
1148
|
/** 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. */
|
1149
|
-
type?: components$
|
1149
|
+
type?: components$2["parameters"]["type"];
|
1150
1150
|
/**
|
1151
1151
|
* @deprecated Filters composition lists by the UI status of the composition.
|
1152
1152
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
1153
1153
|
*/
|
1154
|
-
uiStatus?: components$
|
1154
|
+
uiStatus?: components$2["parameters"]["uiStatus"];
|
1155
1155
|
/**
|
1156
1156
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
1157
1157
|
* in case of FALSE. If not specified - no filtration applied.
|
1158
1158
|
*/
|
1159
|
-
attachedToProjectMap?: components$
|
1159
|
+
attachedToProjectMap?: components$2["parameters"]["attachedToProjectMap"];
|
1160
1160
|
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
1161
|
-
updatedBy?: components$
|
1161
|
+
updatedBy?: components$2["parameters"]["updatedBy"];
|
1162
1162
|
/**
|
1163
1163
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
1164
1164
|
* If false, the `_id` will not be present in the API response.
|
1165
1165
|
*/
|
1166
|
-
withComponentIDs?: components$
|
1166
|
+
withComponentIDs?: components$2["parameters"]["withComponentIDs"];
|
1167
1167
|
/**
|
1168
1168
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
1169
1169
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
1170
1170
|
*/
|
1171
|
-
withTotalCount?: components$
|
1171
|
+
withTotalCount?: components$2["parameters"]["withTotalCount"];
|
1172
1172
|
/**
|
1173
1173
|
* @deprecated Returns the UI status string of the composition.
|
1174
1174
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
1175
1175
|
*/
|
1176
|
-
withUIStatus?: components$
|
1176
|
+
withUIStatus?: components$2["parameters"]["withUIStatus"];
|
1177
1177
|
/** Includes project map node information in the composition results */
|
1178
|
-
withProjectMapNodes?: components$
|
1178
|
+
withProjectMapNodes?: components$2["parameters"]["withProjectMapNodes"];
|
1179
1179
|
};
|
1180
1180
|
};
|
1181
1181
|
responses: {
|
1182
1182
|
/** OK */
|
1183
1183
|
200: {
|
1184
1184
|
content: {
|
1185
|
-
"application/json": components$
|
1185
|
+
"application/json": components$2["schemas"]["CompositionListResponse"] | components$2["schemas"]["CompositionApiResponse"];
|
1186
1186
|
};
|
1187
1187
|
};
|
1188
|
-
400: external$
|
1189
|
-
401: external$
|
1190
|
-
403: external$
|
1188
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1189
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1190
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1191
1191
|
/** Composition not found */
|
1192
1192
|
404: {
|
1193
1193
|
content: {
|
1194
1194
|
"text/plain": string;
|
1195
1195
|
};
|
1196
1196
|
};
|
1197
|
-
429: external$
|
1198
|
-
500: external$
|
1197
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1198
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1199
1199
|
};
|
1200
1200
|
};
|
1201
1201
|
/** Upserts a composition */
|
@@ -1203,11 +1203,11 @@ interface paths$5 {
|
|
1203
1203
|
responses: {
|
1204
1204
|
/** OK */
|
1205
1205
|
204: never;
|
1206
|
-
400: external$
|
1207
|
-
401: external$
|
1208
|
-
403: external$
|
1209
|
-
429: external$
|
1210
|
-
500: external$
|
1206
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1207
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1208
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1209
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1210
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1211
1211
|
};
|
1212
1212
|
requestBody: {
|
1213
1213
|
content: {
|
@@ -1217,9 +1217,9 @@ interface paths$5 {
|
|
1217
1217
|
* @description The project ID to upsert the composition to
|
1218
1218
|
*/
|
1219
1219
|
projectId: string;
|
1220
|
-
/** @description The state
|
1220
|
+
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
1221
1221
|
state: number;
|
1222
|
-
composition: external$
|
1222
|
+
composition: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1223
1223
|
/**
|
1224
1224
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
1225
1225
|
* @default false
|
@@ -1238,11 +1238,11 @@ interface paths$5 {
|
|
1238
1238
|
responses: {
|
1239
1239
|
/** OK */
|
1240
1240
|
204: never;
|
1241
|
-
400: external$
|
1242
|
-
401: external$
|
1243
|
-
403: external$
|
1244
|
-
429: external$
|
1245
|
-
500: external$
|
1241
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1242
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1243
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1244
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1245
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1246
1246
|
};
|
1247
1247
|
requestBody: {
|
1248
1248
|
content: {
|
@@ -1257,7 +1257,7 @@ interface paths$5 {
|
|
1257
1257
|
* @description The ID of the project the composition to delete belongs to
|
1258
1258
|
*/
|
1259
1259
|
projectId: string;
|
1260
|
-
/** @description The state
|
1260
|
+
/** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
1261
1261
|
state?: number;
|
1262
1262
|
};
|
1263
1263
|
};
|
@@ -1272,10 +1272,10 @@ interface paths$5 {
|
|
1272
1272
|
};
|
1273
1273
|
};
|
1274
1274
|
}
|
1275
|
-
interface components$
|
1275
|
+
interface components$2 {
|
1276
1276
|
schemas: {
|
1277
1277
|
CompositionApiResponse: {
|
1278
|
-
/** @description
|
1278
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
1279
1279
|
state: number;
|
1280
1280
|
/**
|
1281
1281
|
* @deprecated
|
@@ -1300,10 +1300,10 @@ interface components$1 {
|
|
1300
1300
|
modified: string;
|
1301
1301
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
1302
1302
|
pattern: boolean;
|
1303
|
-
composition: external$
|
1303
|
+
composition: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
1304
1304
|
};
|
1305
1305
|
CompositionListResponse: {
|
1306
|
-
compositions: components$
|
1306
|
+
compositions: components$2["schemas"]["CompositionApiResponse"][];
|
1307
1307
|
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
1308
1308
|
totalCount?: number;
|
1309
1309
|
};
|
@@ -1321,11 +1321,11 @@ interface components$1 {
|
|
1321
1321
|
projectMapNodeId: string;
|
1322
1322
|
/** @description Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
1323
1323
|
projectMapNodePath: string;
|
1324
|
-
/** @description
|
1324
|
+
/** @description Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
1325
1325
|
projectMapId: string;
|
1326
1326
|
/** @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. */
|
1327
1327
|
type: string[];
|
1328
|
-
/** @description
|
1328
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
1329
1329
|
state: number;
|
1330
1330
|
/** @description Number of records to skip */
|
1331
1331
|
offset: number;
|
@@ -1401,7 +1401,7 @@ interface components$1 {
|
|
1401
1401
|
withTotalCount: boolean;
|
1402
1402
|
};
|
1403
1403
|
}
|
1404
|
-
interface external$
|
1404
|
+
interface external$7 {
|
1405
1405
|
"swagger.yml": {
|
1406
1406
|
paths: {};
|
1407
1407
|
components: {
|
@@ -1415,25 +1415,25 @@ interface external$6 {
|
|
1415
1415
|
/** Request input validation failed */
|
1416
1416
|
BadRequestError: {
|
1417
1417
|
content: {
|
1418
|
-
"application/json": external$
|
1418
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1419
1419
|
};
|
1420
1420
|
};
|
1421
1421
|
/** API key or token was not valid */
|
1422
1422
|
UnauthorizedError: {
|
1423
1423
|
content: {
|
1424
|
-
"application/json": external$
|
1424
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1425
1425
|
};
|
1426
1426
|
};
|
1427
1427
|
/** Permission was denied */
|
1428
1428
|
ForbiddenError: {
|
1429
1429
|
content: {
|
1430
|
-
"application/json": external$
|
1430
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1431
1431
|
};
|
1432
1432
|
};
|
1433
1433
|
/** Resource not found */
|
1434
1434
|
NotFoundError: {
|
1435
1435
|
content: {
|
1436
|
-
"application/json": external$
|
1436
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1437
1437
|
};
|
1438
1438
|
};
|
1439
1439
|
/** Too many requests in allowed time period */
|
@@ -1452,7 +1452,7 @@ interface external$6 {
|
|
1452
1452
|
PublicIdProperty: string;
|
1453
1453
|
/** @description The definition of a component parameter */
|
1454
1454
|
ComponentDefinitionParameter: {
|
1455
|
-
id: external$
|
1455
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1456
1456
|
/** @description Friendly name of the parameter */
|
1457
1457
|
name: string;
|
1458
1458
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1464,7 +1464,7 @@ interface external$6 {
|
|
1464
1464
|
};
|
1465
1465
|
/** @description The definition of a named component slot that can contain other components */
|
1466
1466
|
ComponentDefinitionSlot: {
|
1467
|
-
id: external$
|
1467
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1468
1468
|
/** @description Friendly name of the slot */
|
1469
1469
|
name: string;
|
1470
1470
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1522,13 +1522,13 @@ interface external$6 {
|
|
1522
1522
|
};
|
1523
1523
|
/** @description The definition of a component variant */
|
1524
1524
|
ComponentDefinitionVariant: {
|
1525
|
-
id: external$
|
1525
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1526
1526
|
/** @description Friendly name of the variant */
|
1527
1527
|
name: string;
|
1528
1528
|
};
|
1529
1529
|
/** @description Permission set for a component defintion */
|
1530
1530
|
ComponentDefinitionPermission: {
|
1531
|
-
roleId: external$
|
1531
|
+
roleId: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1532
1532
|
/**
|
1533
1533
|
* @description Permission type for this permission ComponentDefinition:
|
1534
1534
|
* read | write | create | delete
|
@@ -1541,7 +1541,7 @@ interface external$6 {
|
|
1541
1541
|
};
|
1542
1542
|
/** @description Defines a component type that can live on a Composition */
|
1543
1543
|
ComponentDefinition: {
|
1544
|
-
id: external$
|
1544
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1545
1545
|
/** @description Friendly name of the component definition */
|
1546
1546
|
name: string;
|
1547
1547
|
/**
|
@@ -1560,21 +1560,21 @@ interface external$6 {
|
|
1560
1560
|
*/
|
1561
1561
|
canBeComposition?: boolean;
|
1562
1562
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1563
|
-
parameters?: external$
|
1563
|
+
parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1564
1564
|
/**
|
1565
1565
|
* @description if this component uses team permissions or custom permissions
|
1566
1566
|
* @default true
|
1567
1567
|
*/
|
1568
1568
|
useTeamPermissions?: boolean;
|
1569
1569
|
/** @description Custom role permissions for this component definition */
|
1570
|
-
permissions?: external$
|
1570
|
+
permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1571
1571
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1572
|
-
slots?: external$
|
1573
|
-
slugSettings?: external$
|
1572
|
+
slots?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1573
|
+
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1574
1574
|
/** @description Default component instance value */
|
1575
|
-
defaults?: external$
|
1575
|
+
defaults?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1576
1576
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1577
|
-
variants?: external$
|
1577
|
+
variants?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1578
1578
|
/** @description Created date string for this definition (ignored for writes) */
|
1579
1579
|
created?: string;
|
1580
1580
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1586,7 +1586,7 @@ interface external$6 {
|
|
1586
1586
|
value: unknown;
|
1587
1587
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1588
1588
|
type: string;
|
1589
|
-
connectedData?: external$
|
1589
|
+
connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1590
1590
|
};
|
1591
1591
|
/**
|
1592
1592
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1609,13 +1609,13 @@ interface external$6 {
|
|
1609
1609
|
type: string;
|
1610
1610
|
/** @description Component parameter values for the component instance */
|
1611
1611
|
parameters?: {
|
1612
|
-
[key: string]: external$
|
1612
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1613
1613
|
};
|
1614
1614
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1615
1615
|
variant?: string;
|
1616
1616
|
/** @description Slots containing any child components */
|
1617
1617
|
slots?: {
|
1618
|
-
[key: string]: external$
|
1618
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1619
1619
|
};
|
1620
1620
|
/**
|
1621
1621
|
* @description Unique identifier of the component within the composition.
|
@@ -1625,13 +1625,13 @@ interface external$6 {
|
|
1625
1625
|
_id?: string;
|
1626
1626
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1627
1627
|
_pattern?: string;
|
1628
|
-
_dataResources?: external$
|
1628
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1629
1629
|
/**
|
1630
1630
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1631
1631
|
* Means nothing for PUTs; it will be ignored.
|
1632
1632
|
*/
|
1633
1633
|
_patternDataResources?: {
|
1634
|
-
[key: string]: external$
|
1634
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1635
1635
|
};
|
1636
1636
|
/**
|
1637
1637
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1655,7 +1655,7 @@ interface external$6 {
|
|
1655
1655
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1656
1656
|
*/
|
1657
1657
|
_overrides?: {
|
1658
|
-
[key: string]: external$
|
1658
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1659
1659
|
};
|
1660
1660
|
/**
|
1661
1661
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1664,7 +1664,7 @@ interface external$6 {
|
|
1664
1664
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1665
1665
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1666
1666
|
*/
|
1667
|
-
_overridability?: external$
|
1667
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1668
1668
|
};
|
1669
1669
|
/** @description Defines the shape of the root component in a composition */
|
1670
1670
|
RootComponentInstance: {
|
@@ -1672,15 +1672,15 @@ interface external$6 {
|
|
1672
1672
|
type: string;
|
1673
1673
|
/** @description Component parameter values for the component instance */
|
1674
1674
|
parameters?: {
|
1675
|
-
[key: string]: external$
|
1675
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1676
1676
|
};
|
1677
1677
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1678
1678
|
variant?: string;
|
1679
1679
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1680
|
-
projectMapNodes?: external$
|
1680
|
+
projectMapNodes?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1681
1681
|
/** @description Slots containing any child components */
|
1682
1682
|
slots?: {
|
1683
|
-
[key: string]: external$
|
1683
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1684
1684
|
};
|
1685
1685
|
/** @description The public UUID of the composition. */
|
1686
1686
|
_id: string;
|
@@ -1688,7 +1688,7 @@ interface external$6 {
|
|
1688
1688
|
_slug?: string | null;
|
1689
1689
|
/** @description Friendly name of this component. */
|
1690
1690
|
_name: string;
|
1691
|
-
_dataResources?: external$
|
1691
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1692
1692
|
/**
|
1693
1693
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1694
1694
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1702,7 +1702,7 @@ interface external$6 {
|
|
1702
1702
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1703
1703
|
*/
|
1704
1704
|
_overrides?: {
|
1705
|
-
[key: string]: external$
|
1705
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1706
1706
|
};
|
1707
1707
|
/**
|
1708
1708
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1711,7 +1711,7 @@ interface external$6 {
|
|
1711
1711
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1712
1712
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1713
1713
|
*/
|
1714
|
-
_overridability?: external$
|
1714
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1715
1715
|
};
|
1716
1716
|
/**
|
1717
1717
|
* @description Defines how to override a specific component.
|
@@ -1721,7 +1721,7 @@ interface external$6 {
|
|
1721
1721
|
*/
|
1722
1722
|
ComponentOverride: {
|
1723
1723
|
parameters?: {
|
1724
|
-
[key: string]: external$
|
1724
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1725
1725
|
};
|
1726
1726
|
variant?: string;
|
1727
1727
|
};
|
@@ -1735,7 +1735,7 @@ interface external$6 {
|
|
1735
1735
|
ComponentOverridability: {
|
1736
1736
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1737
1737
|
parameters?: {
|
1738
|
-
[key: string]: external$
|
1738
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1739
1739
|
};
|
1740
1740
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1741
1741
|
variants?: boolean;
|
@@ -1776,7 +1776,7 @@ interface external$6 {
|
|
1776
1776
|
}[];
|
1777
1777
|
/** @description Variables needed to make calls to the data source */
|
1778
1778
|
variables?: {
|
1779
|
-
[key: string]: external$
|
1779
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1780
1780
|
};
|
1781
1781
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1782
1782
|
custom?: {
|
@@ -1833,7 +1833,7 @@ interface external$6 {
|
|
1833
1833
|
method: "GET" | "POST" | "HEAD";
|
1834
1834
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1835
1835
|
variables?: {
|
1836
|
-
[key: string]: external$
|
1836
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1837
1837
|
};
|
1838
1838
|
/** @description Custom configuration specific to the data source being defined */
|
1839
1839
|
custom?: {
|
@@ -1857,195 +1857,1334 @@ interface external$6 {
|
|
1857
1857
|
order?: number;
|
1858
1858
|
};
|
1859
1859
|
/**
|
1860
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1861
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1860
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1861
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1862
|
+
*/
|
1863
|
+
DataResourceDefinitions: {
|
1864
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1865
|
+
};
|
1866
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1867
|
+
DataResourceDefinition: {
|
1868
|
+
/** @description Public ID of the data type that provides this data */
|
1869
|
+
type: string;
|
1870
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
1871
|
+
isPatternParameter?: boolean;
|
1872
|
+
/**
|
1873
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
1874
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
1875
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
1876
|
+
*/
|
1877
|
+
ignorePatternParameterDefault?: boolean;
|
1878
|
+
variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1879
|
+
};
|
1880
|
+
/** @description Variable values for a data resource. */
|
1881
|
+
DataResourceVariables: {
|
1882
|
+
[key: string]: string;
|
1883
|
+
};
|
1884
|
+
/** @description Project map node information related to a component. */
|
1885
|
+
CompositionProjectMapNodeInfo: {
|
1886
|
+
/**
|
1887
|
+
* Format: uuid
|
1888
|
+
* @description Unique identifier for the project map node
|
1889
|
+
*/
|
1890
|
+
id: string;
|
1891
|
+
/** @description Path of the project map node */
|
1892
|
+
path: string;
|
1893
|
+
/**
|
1894
|
+
* Format: uuid
|
1895
|
+
* @description Unique identifier for the project map that this node belongs to.
|
1896
|
+
*/
|
1897
|
+
projectMapId: string;
|
1898
|
+
};
|
1899
|
+
};
|
1900
|
+
};
|
1901
|
+
operations: {};
|
1902
|
+
};
|
1903
|
+
}
|
1904
|
+
|
1905
|
+
interface components$1 {
|
1906
|
+
schemas: {
|
1907
|
+
CompositionResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
1908
|
+
EdgehancerResult: {
|
1909
|
+
diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
|
1910
|
+
errors?: components$1["schemas"]["CompositionIssue"][];
|
1911
|
+
warnings?: components$1["schemas"]["CompositionIssue"][];
|
1912
|
+
};
|
1913
|
+
EdgehancersError: {
|
1914
|
+
message: string;
|
1915
|
+
status: number;
|
1916
|
+
statusText: string;
|
1917
|
+
};
|
1918
|
+
UniformError: components$1["schemas"]["EdgehancersError"] | external$6["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
1919
|
+
InvalidationPayload: {
|
1920
|
+
/** @description List of variables with values to invalidate */
|
1921
|
+
variables?: {
|
1922
|
+
name: string;
|
1923
|
+
value: string;
|
1924
|
+
}[];
|
1925
|
+
/** @description List of surrogate keys to invalidate */
|
1926
|
+
surrogateKeys?: string[];
|
1927
|
+
};
|
1928
|
+
BatchInvalidationPayload: {
|
1929
|
+
dataTypeId: string;
|
1930
|
+
/** Format: uuid */
|
1931
|
+
purgeKey: string;
|
1932
|
+
conditions?: components$1["schemas"]["InvalidationPayload"];
|
1933
|
+
}[];
|
1934
|
+
DataDiagnostic: {
|
1935
|
+
componentPath: string;
|
1936
|
+
dataType: string;
|
1937
|
+
dataName: string;
|
1938
|
+
performance: {
|
1939
|
+
cacheHit: boolean;
|
1940
|
+
total: number;
|
1941
|
+
retryCount: number;
|
1942
|
+
retryDelay: number;
|
1943
|
+
sourceCache?: string;
|
1944
|
+
};
|
1945
|
+
data: unknown;
|
1946
|
+
};
|
1947
|
+
/**
|
1948
|
+
* @description Diagnostic information about request processing, including origin/config/data
|
1949
|
+
* * timings, edge locations, cache statuses and raw data.
|
1950
|
+
* * Only set when diagnostics=true is passed to the options.
|
1951
|
+
*/
|
1952
|
+
CompositionDiagnostics: {
|
1953
|
+
/** @description Edge location where the request was processed */
|
1954
|
+
edgeLocation?: string;
|
1955
|
+
compositionFetch?: {
|
1956
|
+
/** @description How long it took to fetch the composition (ms) */
|
1957
|
+
duration: number;
|
1958
|
+
/** @description Indicates if the composition was fetched from the cache */
|
1959
|
+
cacheHit: boolean;
|
1960
|
+
/** @description Indicates if the request results in a valid composition */
|
1961
|
+
hasValidComposition: boolean;
|
1962
|
+
/** @description Edge cache location used */
|
1963
|
+
cacheLocation?: string;
|
1964
|
+
/** @description Uniform-specifc request identifiers */
|
1965
|
+
requestId?: string;
|
1966
|
+
};
|
1967
|
+
configRetrieval?: {
|
1968
|
+
/** @description How long it took to retrieve the config (ms, in parallel to composition fetch) */
|
1969
|
+
duration: number;
|
1970
|
+
/** @description How many data type configs were retrieved */
|
1971
|
+
dataTypeCount: number;
|
1972
|
+
};
|
1973
|
+
data?: components$1["schemas"]["DataDiagnostic"][];
|
1974
|
+
};
|
1975
|
+
CompositionIssue: {
|
1976
|
+
componentPath?: string;
|
1977
|
+
componentType?: string;
|
1978
|
+
message: string;
|
1979
|
+
type: string;
|
1980
|
+
parameterName?: string;
|
1981
|
+
expression?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1982
|
+
dataName?: string;
|
1983
|
+
dataType?: string;
|
1984
|
+
inputName?: string;
|
1985
|
+
code?: string;
|
1986
|
+
};
|
1987
|
+
InvalidationResult: {
|
1988
|
+
ok: boolean;
|
1989
|
+
};
|
1990
|
+
BatchInvalidationResult: {
|
1991
|
+
ok: number;
|
1992
|
+
failed: number;
|
1993
|
+
};
|
1994
|
+
};
|
1995
|
+
responses: {
|
1996
|
+
/** Invalid caller input came with the request */
|
1997
|
+
BadRequestError: {
|
1998
|
+
content: {
|
1999
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2000
|
+
};
|
2001
|
+
};
|
2002
|
+
UnauthorizedError: {
|
2003
|
+
content: {
|
2004
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2005
|
+
};
|
2006
|
+
};
|
2007
|
+
ForbiddenError: {
|
2008
|
+
content: {
|
2009
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2010
|
+
};
|
2011
|
+
};
|
2012
|
+
/** The requested resource does not exist */
|
2013
|
+
NotFoundError: {
|
2014
|
+
content: {
|
2015
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2016
|
+
};
|
2017
|
+
};
|
2018
|
+
/** Invalid method was used to call the endpoint */
|
2019
|
+
MethodNotAllowedError: {
|
2020
|
+
content: {
|
2021
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2022
|
+
};
|
2023
|
+
};
|
2024
|
+
/** The request body could not be parsed or understood */
|
2025
|
+
UnprocessableEntityError: {
|
2026
|
+
content: {
|
2027
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2028
|
+
};
|
2029
|
+
};
|
2030
|
+
RateLimitError: {
|
2031
|
+
content: {
|
2032
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2033
|
+
};
|
2034
|
+
};
|
2035
|
+
/** An unexpected error occurred */
|
2036
|
+
InternalServerError: {
|
2037
|
+
content: {
|
2038
|
+
"application/json": components$1["schemas"]["UniformError"];
|
2039
|
+
};
|
2040
|
+
};
|
2041
|
+
CompositionResult: {
|
2042
|
+
content: {
|
2043
|
+
"application/json": {
|
2044
|
+
diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
|
2045
|
+
errors?: components$1["schemas"]["CompositionIssue"][];
|
2046
|
+
warnings?: components$1["schemas"]["CompositionIssue"][];
|
2047
|
+
} & external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2048
|
+
};
|
2049
|
+
};
|
2050
|
+
/** Edge route response */
|
2051
|
+
EdgeRouteResponse: {
|
2052
|
+
content: {
|
2053
|
+
"application/json": external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseRedirect"] | external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseNotFound"] | {
|
2054
|
+
matchedRoute?: string;
|
2055
|
+
dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
|
2056
|
+
/** @enum {string} */
|
2057
|
+
type?: "composition";
|
2058
|
+
compositionApiResponse?: components$1["schemas"]["CompositionResolvedGetResponse"];
|
2059
|
+
};
|
2060
|
+
};
|
2061
|
+
};
|
2062
|
+
/** Invalidation request was processed; ok indicates if it succeeded */
|
2063
|
+
InvalidationResult: {
|
2064
|
+
content: {
|
2065
|
+
"application/json": components$1["schemas"]["InvalidationResult"];
|
2066
|
+
};
|
2067
|
+
};
|
2068
|
+
/** Batch invalidation request was processed; number of successful and failed jobs is included */
|
2069
|
+
BatchInvalidationResult: {
|
2070
|
+
content: {
|
2071
|
+
"application/json": components$1["schemas"]["BatchInvalidationResult"];
|
2072
|
+
};
|
2073
|
+
};
|
2074
|
+
};
|
2075
|
+
}
|
2076
|
+
interface external$6 {
|
2077
|
+
"../../../lambda/functions/swagger.yml": {
|
2078
|
+
paths: {};
|
2079
|
+
components: {
|
2080
|
+
schemas: {
|
2081
|
+
Error: {
|
2082
|
+
/** @description Error message(s) that occurred while processing the request */
|
2083
|
+
errorMessage?: string[] | string;
|
2084
|
+
};
|
2085
|
+
};
|
2086
|
+
responses: {
|
2087
|
+
/** Request input validation failed */
|
2088
|
+
BadRequestError: {
|
2089
|
+
content: {
|
2090
|
+
"application/json": external$6["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2091
|
+
};
|
2092
|
+
};
|
2093
|
+
/** API key or token was not valid */
|
2094
|
+
UnauthorizedError: {
|
2095
|
+
content: {
|
2096
|
+
"application/json": external$6["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2097
|
+
};
|
2098
|
+
};
|
2099
|
+
/** Permission was denied */
|
2100
|
+
ForbiddenError: {
|
2101
|
+
content: {
|
2102
|
+
"application/json": external$6["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2103
|
+
};
|
2104
|
+
};
|
2105
|
+
/** Resource not found */
|
2106
|
+
NotFoundError: {
|
2107
|
+
content: {
|
2108
|
+
"application/json": external$6["../../../lambda/functions/swagger.yml"]["components"]["schemas"]["Error"];
|
2109
|
+
};
|
2110
|
+
};
|
2111
|
+
/** Too many requests in allowed time period */
|
2112
|
+
RateLimitError: unknown;
|
2113
|
+
/** Execution error occurred */
|
2114
|
+
InternalServerError: unknown;
|
2115
|
+
};
|
2116
|
+
};
|
2117
|
+
operations: {};
|
2118
|
+
};
|
2119
|
+
"../../../lambda/functions/uniform-canvas-types.swagger.yml": {
|
2120
|
+
paths: {};
|
2121
|
+
components: {
|
2122
|
+
schemas: {
|
2123
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
2124
|
+
PublicIdProperty: string;
|
2125
|
+
/** @description The definition of a component parameter */
|
2126
|
+
ComponentDefinitionParameter: {
|
2127
|
+
id: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2128
|
+
/** @description Friendly name of the parameter */
|
2129
|
+
name: string;
|
2130
|
+
/** @description Appears next to the parameter in the Composition editor */
|
2131
|
+
helpText?: string;
|
2132
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
2133
|
+
type: string;
|
2134
|
+
/** @description The configuration object for the type (type-specific) */
|
2135
|
+
typeConfig?: unknown;
|
2136
|
+
};
|
2137
|
+
/** @description The definition of a named component slot that can contain other components */
|
2138
|
+
ComponentDefinitionSlot: {
|
2139
|
+
id: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2140
|
+
/** @description Friendly name of the slot */
|
2141
|
+
name: string;
|
2142
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
2143
|
+
allowedComponents: string[];
|
2144
|
+
/**
|
2145
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
2146
|
+
* If allowAllComponents is true, this value is ignored.
|
2147
|
+
*
|
2148
|
+
* @default false
|
2149
|
+
*/
|
2150
|
+
inheritAllowedComponents: boolean;
|
2151
|
+
/**
|
2152
|
+
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
2153
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
2154
|
+
*/
|
2155
|
+
allowAllComponents?: boolean;
|
2156
|
+
/**
|
2157
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
2158
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
2159
|
+
*/
|
2160
|
+
patternsInAllowedComponents?: boolean;
|
2161
|
+
/** @description Minimum valid number of components in this slot */
|
2162
|
+
minComponents?: number;
|
2163
|
+
/** @description Maximum valid number of components in this slot */
|
2164
|
+
maxComponents?: number;
|
2165
|
+
};
|
2166
|
+
/** @description The definition of a composition's slug settings */
|
2167
|
+
ComponentDefinitionSlugSettings: {
|
2168
|
+
/**
|
2169
|
+
* @description Whether the slug is required
|
2170
|
+
* no: slug is optional
|
2171
|
+
* yes: slug is required
|
2172
|
+
* disabled: slug is disabled and will not be shown in the editor
|
2173
|
+
*
|
2174
|
+
* @default no
|
2175
|
+
* @enum {string}
|
2176
|
+
*/
|
2177
|
+
required?: "no" | "yes" | "disabled";
|
2178
|
+
/**
|
2179
|
+
* @description Slug uniqueness configuration.
|
2180
|
+
* no = no unique constraint
|
2181
|
+
* local = must be unique within this component type
|
2182
|
+
* global = must be unique across all component types
|
2183
|
+
*
|
2184
|
+
* @enum {string}
|
2185
|
+
*/
|
2186
|
+
unique?: "no" | "local" | "global";
|
2187
|
+
/** @description Regular expression slugs must match */
|
2188
|
+
regularExpression?: string;
|
2189
|
+
/**
|
2190
|
+
* @description Custom error message when regular expression validation fails.
|
2191
|
+
* Has no effect if `regularExpression` is not set.
|
2192
|
+
*/
|
2193
|
+
regularExpressionMessage?: string;
|
2194
|
+
};
|
2195
|
+
/** @description The definition of a component variant */
|
2196
|
+
ComponentDefinitionVariant: {
|
2197
|
+
id: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2198
|
+
/** @description Friendly name of the variant */
|
2199
|
+
name: string;
|
2200
|
+
};
|
2201
|
+
/** @description Permission set for a component defintion */
|
2202
|
+
ComponentDefinitionPermission: {
|
2203
|
+
roleId: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2204
|
+
/**
|
2205
|
+
* @description Permission type for this permission ComponentDefinition:
|
2206
|
+
* read | write | create | delete
|
2207
|
+
*
|
2208
|
+
* @enum {string}
|
2209
|
+
*/
|
2210
|
+
permission: "read" | "write" | "create" | "delete";
|
2211
|
+
/** @description State of the component that this permission applies to */
|
2212
|
+
state: number;
|
2213
|
+
};
|
2214
|
+
/** @description Defines a component type that can live on a Composition */
|
2215
|
+
ComponentDefinition: {
|
2216
|
+
id: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2217
|
+
/** @description Friendly name of the component definition */
|
2218
|
+
name: string;
|
2219
|
+
/**
|
2220
|
+
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
2221
|
+
* @default screen
|
2222
|
+
*/
|
2223
|
+
icon?: string;
|
2224
|
+
/**
|
2225
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
2226
|
+
* The parameter type must support being used as a title parameter for this to work.
|
2227
|
+
*/
|
2228
|
+
titleParameter?: string | null;
|
2229
|
+
/**
|
2230
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
2231
|
+
* @default false
|
2232
|
+
*/
|
2233
|
+
canBeComposition?: boolean;
|
2234
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2235
|
+
parameters?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2236
|
+
/**
|
2237
|
+
* @description if this component uses team permissions or custom permissions
|
2238
|
+
* @default true
|
2239
|
+
*/
|
2240
|
+
useTeamPermissions?: boolean;
|
2241
|
+
/** @description Custom role permissions for this component definition */
|
2242
|
+
permissions?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2243
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2244
|
+
slots?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2245
|
+
slugSettings?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2246
|
+
/** @description Default component instance value */
|
2247
|
+
defaults?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2248
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2249
|
+
variants?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2250
|
+
/** @description Created date string for this definition (ignored for writes) */
|
2251
|
+
created?: string;
|
2252
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
2253
|
+
updated?: string;
|
2254
|
+
};
|
2255
|
+
/** @description Defines an editable parameter on a component. */
|
2256
|
+
ComponentParameter: {
|
2257
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
2258
|
+
value: unknown;
|
2259
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2260
|
+
type: string;
|
2261
|
+
connectedData?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2262
|
+
};
|
2263
|
+
/**
|
2264
|
+
* @description Defines a connection to a data element on a data resource.
|
2265
|
+
*
|
2266
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2267
|
+
* Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
|
2268
|
+
*/
|
2269
|
+
DataElementConnectionDefinition: {
|
2270
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
2271
|
+
pointer: string;
|
2272
|
+
/**
|
2273
|
+
* @description The syntax used to select the data element to bind to
|
2274
|
+
* @enum {string}
|
2275
|
+
*/
|
2276
|
+
syntax: "jptr";
|
2277
|
+
};
|
2278
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
2279
|
+
ComponentInstance: {
|
2280
|
+
/** @description Type of the component instance (public_id of its definition) */
|
2281
|
+
type: string;
|
2282
|
+
/** @description Component parameter values for the component instance */
|
2283
|
+
parameters?: {
|
2284
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2285
|
+
};
|
2286
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2287
|
+
variant?: string;
|
2288
|
+
/** @description Slots containing any child components */
|
2289
|
+
slots?: {
|
2290
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2291
|
+
};
|
2292
|
+
/**
|
2293
|
+
* @description Unique identifier of the component within the composition.
|
2294
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
2295
|
+
* This is not set unless specifically requested via `withComponentIDs` API parameter.
|
2296
|
+
*/
|
2297
|
+
_id?: string;
|
2298
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2299
|
+
_pattern?: string;
|
2300
|
+
_dataResources?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2301
|
+
/**
|
2302
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2303
|
+
* Means nothing for PUTs; it will be ignored.
|
2304
|
+
*/
|
2305
|
+
_patternDataResources?: {
|
2306
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2307
|
+
};
|
2308
|
+
/**
|
2309
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
2310
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
2311
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
2312
|
+
* Means nothing for PUTs; it will be ignored.
|
2313
|
+
*
|
2314
|
+
* @enum {string}
|
2315
|
+
*/
|
2316
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
2317
|
+
/**
|
2318
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2319
|
+
* This can be used to override parameters that are defined on patterns,
|
2320
|
+
* including nested patterns, with values that are specific to this composition.
|
2321
|
+
* The keys in this object are component IDs.
|
2322
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2323
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2324
|
+
* the composition's override replaces the pattern's.
|
2325
|
+
*
|
2326
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2327
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2328
|
+
*/
|
2329
|
+
_overrides?: {
|
2330
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2331
|
+
};
|
2332
|
+
/**
|
2333
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2334
|
+
* by consumers of the pattern.
|
2335
|
+
*
|
2336
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2337
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2338
|
+
*/
|
2339
|
+
_overridability?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2340
|
+
};
|
2341
|
+
/** @description Defines the shape of the root component in a composition */
|
2342
|
+
RootComponentInstance: {
|
2343
|
+
/** @description Type of the component instance (public_id of its definition) */
|
2344
|
+
type: string;
|
2345
|
+
/** @description Component parameter values for the component instance */
|
2346
|
+
parameters?: {
|
2347
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2348
|
+
};
|
2349
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2350
|
+
variant?: string;
|
2351
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2352
|
+
projectMapNodes?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2353
|
+
/** @description Slots containing any child components */
|
2354
|
+
slots?: {
|
2355
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2356
|
+
};
|
2357
|
+
/** @description The public UUID of the composition. */
|
2358
|
+
_id: string;
|
2359
|
+
/** @description Slug pattern of this component. */
|
2360
|
+
_slug?: string | null;
|
2361
|
+
/** @description Friendly name of this component. */
|
2362
|
+
_name: string;
|
2363
|
+
_dataResources?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2364
|
+
/**
|
2365
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2366
|
+
* This can be used to override parameters that are defined on patterns,
|
2367
|
+
* including nested patterns, with values that are specific to this composition.
|
2368
|
+
* The keys in this object are component IDs.
|
2369
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2370
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2371
|
+
* the composition's override replaces the pattern's.
|
2372
|
+
*
|
2373
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2374
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2375
|
+
*/
|
2376
|
+
_overrides?: {
|
2377
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2378
|
+
};
|
2379
|
+
/**
|
2380
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2381
|
+
* by consumers of the pattern.
|
2382
|
+
*
|
2383
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2384
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2385
|
+
*/
|
2386
|
+
_overridability?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2387
|
+
};
|
2388
|
+
/**
|
2389
|
+
* @description Defines how to override a specific component.
|
2390
|
+
*
|
2391
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2392
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2393
|
+
*/
|
2394
|
+
ComponentOverride: {
|
2395
|
+
parameters?: {
|
2396
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2397
|
+
};
|
2398
|
+
variant?: string;
|
2399
|
+
};
|
2400
|
+
/**
|
2401
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
2402
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
2403
|
+
*
|
2404
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2405
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2406
|
+
*/
|
2407
|
+
ComponentOverridability: {
|
2408
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2409
|
+
parameters?: {
|
2410
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2411
|
+
};
|
2412
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2413
|
+
variants?: boolean;
|
2414
|
+
};
|
2415
|
+
/**
|
2416
|
+
* @description Whether a parameter is overridable
|
2417
|
+
*
|
2418
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2419
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2420
|
+
*
|
2421
|
+
* @enum {string}
|
2422
|
+
*/
|
2423
|
+
OverrideOptions: "yes" | "no";
|
2424
|
+
/**
|
2425
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
2426
|
+
* These are created in the UI and shared across a whole project.
|
2427
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
2428
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
2429
|
+
*/
|
2430
|
+
DataSource: {
|
2431
|
+
/** @description Public ID of the data source */
|
2432
|
+
id: string;
|
2433
|
+
/** @description Display name of the data source */
|
2434
|
+
displayName: string;
|
2435
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2436
|
+
connectorType: string;
|
2437
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2438
|
+
baseUrl: string;
|
2439
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2440
|
+
headers?: {
|
2441
|
+
key: string;
|
2442
|
+
value: string;
|
2443
|
+
}[];
|
2444
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2445
|
+
parameters?: {
|
2446
|
+
key: string;
|
2447
|
+
value: string;
|
2448
|
+
}[];
|
2449
|
+
/** @description Variables needed to make calls to the data source */
|
2450
|
+
variables?: {
|
2451
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2452
|
+
};
|
2453
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2454
|
+
custom?: {
|
2455
|
+
[key: string]: unknown;
|
2456
|
+
};
|
2457
|
+
};
|
2458
|
+
/** @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. */
|
2459
|
+
DataType: {
|
2460
|
+
/** @description Public ID of the data type */
|
2461
|
+
id: string;
|
2462
|
+
/** @description Display name of the data type */
|
2463
|
+
displayName: string;
|
2464
|
+
/** @description Public ID of the associated data source */
|
2465
|
+
dataSourceId: string;
|
2466
|
+
/**
|
2467
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2468
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
2469
|
+
* no special UI or processing is required.
|
2470
|
+
*/
|
2471
|
+
archetype?: string;
|
2472
|
+
allowedOnComponents?: string[];
|
2473
|
+
/** @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. */
|
2474
|
+
path: string;
|
2475
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
2476
|
+
ttl?: number;
|
2477
|
+
/** @description Long term data resource cache configuration. */
|
2478
|
+
longTermCache?: {
|
2479
|
+
/** @description A flag to turn the long term cache on. */
|
2480
|
+
enabled: boolean;
|
2481
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
2482
|
+
ttlInHours?: number;
|
2483
|
+
};
|
2484
|
+
/** @description A key for the resource data cache purging. */
|
2485
|
+
purgeKey?: string;
|
2486
|
+
/** @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. */
|
2487
|
+
badgeIconUrl?: string;
|
2488
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2489
|
+
headers?: {
|
2490
|
+
key: string;
|
2491
|
+
value: string;
|
2492
|
+
}[];
|
2493
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2494
|
+
parameters?: {
|
2495
|
+
key: string;
|
2496
|
+
value: string;
|
2497
|
+
}[];
|
2498
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2499
|
+
body?: string;
|
2500
|
+
/**
|
2501
|
+
* @description HTTP method to use with requests to the data type.
|
2502
|
+
* @default GET
|
2503
|
+
* @enum {string}
|
2504
|
+
*/
|
2505
|
+
method: "GET" | "POST" | "HEAD";
|
2506
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2507
|
+
variables?: {
|
2508
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2509
|
+
};
|
2510
|
+
/** @description Custom configuration specific to the data source being defined */
|
2511
|
+
custom?: {
|
2512
|
+
[key: string]: unknown;
|
2513
|
+
};
|
2514
|
+
};
|
2515
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
2516
|
+
DataVariableDefinition: {
|
2517
|
+
/** @description Display name of the data variable */
|
2518
|
+
displayName?: string;
|
2519
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
2520
|
+
helpText?: string;
|
2521
|
+
/**
|
2522
|
+
* @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.
|
2523
|
+
* @default text
|
2524
|
+
*/
|
2525
|
+
type?: string;
|
2526
|
+
/** @description Default value of the data variable */
|
2527
|
+
default: string;
|
2528
|
+
/** @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. */
|
2529
|
+
order?: number;
|
2530
|
+
};
|
2531
|
+
/**
|
2532
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2533
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2534
|
+
*/
|
2535
|
+
DataResourceDefinitions: {
|
2536
|
+
[key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2537
|
+
};
|
2538
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2539
|
+
DataResourceDefinition: {
|
2540
|
+
/** @description Public ID of the data type that provides this data */
|
2541
|
+
type: string;
|
2542
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
2543
|
+
isPatternParameter?: boolean;
|
2544
|
+
/**
|
2545
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
2546
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
2547
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
2548
|
+
*/
|
2549
|
+
ignorePatternParameterDefault?: boolean;
|
2550
|
+
variables?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2551
|
+
};
|
2552
|
+
/** @description Variable values for a data resource. */
|
2553
|
+
DataResourceVariables: {
|
2554
|
+
[key: string]: string;
|
2555
|
+
};
|
2556
|
+
/** @description Project map node information related to a component. */
|
2557
|
+
CompositionProjectMapNodeInfo: {
|
2558
|
+
/**
|
2559
|
+
* Format: uuid
|
2560
|
+
* @description Unique identifier for the project map node
|
2561
|
+
*/
|
2562
|
+
id: string;
|
2563
|
+
/** @description Path of the project map node */
|
2564
|
+
path: string;
|
2565
|
+
/**
|
2566
|
+
* Format: uuid
|
2567
|
+
* @description Unique identifier for the project map that this node belongs to.
|
2568
|
+
*/
|
2569
|
+
projectMapId: string;
|
2570
|
+
};
|
2571
|
+
};
|
2572
|
+
};
|
2573
|
+
operations: {};
|
2574
|
+
};
|
2575
|
+
"../../../lambda/functions/v1-canvas.swagger.yml": {
|
2576
|
+
paths: {
|
2577
|
+
"/api/v1/canvas": {
|
2578
|
+
get: {
|
2579
|
+
parameters: {
|
2580
|
+
query: {
|
2581
|
+
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
2582
|
+
compositionId?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
2583
|
+
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
2584
|
+
compositionIDs?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
2585
|
+
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2586
|
+
createdBy?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
2587
|
+
/**
|
2588
|
+
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2589
|
+
* NOT a full text search; does not match composition contents.
|
2590
|
+
*/
|
2591
|
+
keyword?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
2592
|
+
/** Max number of records to return */
|
2593
|
+
limit?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
2594
|
+
/** Number of records to skip */
|
2595
|
+
offset?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
2596
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2597
|
+
orderBy?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
2598
|
+
/**
|
2599
|
+
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2600
|
+
* If true, only pattern compositions will be returned.
|
2601
|
+
* If false, only regular compositions will be returned.
|
2602
|
+
* If omitted, both pattern and regular compositions will be returned.
|
2603
|
+
*/
|
2604
|
+
pattern?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
2605
|
+
/** The project the composition(s) are on. */
|
2606
|
+
projectId: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
2607
|
+
/** Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
2608
|
+
projectMapId?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
2609
|
+
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2610
|
+
projectMapNodeId?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
2611
|
+
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2612
|
+
projectMapNodePath?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
2613
|
+
/**
|
2614
|
+
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2615
|
+
* This improves performance if you do not require enhanced component data.
|
2616
|
+
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2617
|
+
*/
|
2618
|
+
skipEnhance?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
|
2619
|
+
/**
|
2620
|
+
* If true, any pattern references in the composition will be left unresolved.
|
2621
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
2622
|
+
* embedded into it, and serialize the pattern data separately.
|
2623
|
+
*/
|
2624
|
+
skipPatternResolution?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
2625
|
+
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2626
|
+
skipParameterResolution?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2627
|
+
/**
|
2628
|
+
* If true, any pattern override data is not resolved by the API.
|
2629
|
+
* This is intended for internal use in the Canvas editor, and should not be used.
|
2630
|
+
* Passing this parameter automatically implies withComponentIDs to be true.
|
2631
|
+
*/
|
2632
|
+
skipOverridesResolution?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
2633
|
+
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2634
|
+
slug?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
2635
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
2636
|
+
state?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
2637
|
+
/** 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. */
|
2638
|
+
type?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
2639
|
+
/**
|
2640
|
+
* @deprecated Filters composition lists by the UI status of the composition.
|
2641
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2642
|
+
*/
|
2643
|
+
uiStatus?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
2644
|
+
/**
|
2645
|
+
* Filters out compositions without attached node or filters out compositions with attached nodes
|
2646
|
+
* in case of FALSE. If not specified - no filtration applied.
|
2647
|
+
*/
|
2648
|
+
attachedToProjectMap?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
2649
|
+
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2650
|
+
updatedBy?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
2651
|
+
/**
|
2652
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2653
|
+
* If false, the `_id` will not be present in the API response.
|
2654
|
+
*/
|
2655
|
+
withComponentIDs?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
2656
|
+
/**
|
2657
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2658
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2659
|
+
*/
|
2660
|
+
withTotalCount?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
|
2661
|
+
/**
|
2662
|
+
* @deprecated Returns the UI status string of the composition.
|
2663
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2664
|
+
*/
|
2665
|
+
withUIStatus?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
2666
|
+
/** Includes project map node information in the composition results */
|
2667
|
+
withProjectMapNodes?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
|
2668
|
+
};
|
2669
|
+
};
|
2670
|
+
responses: {
|
2671
|
+
/** OK */
|
2672
|
+
200: {
|
2673
|
+
content: {
|
2674
|
+
"application/json": external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2675
|
+
};
|
2676
|
+
};
|
2677
|
+
400: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2678
|
+
401: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2679
|
+
403: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2680
|
+
/** Composition not found */
|
2681
|
+
404: {
|
2682
|
+
content: {
|
2683
|
+
"text/plain": string;
|
2684
|
+
};
|
2685
|
+
};
|
2686
|
+
429: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2687
|
+
500: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2688
|
+
};
|
2689
|
+
};
|
2690
|
+
/** Upserts a composition */
|
2691
|
+
put: {
|
2692
|
+
responses: {
|
2693
|
+
/** OK */
|
2694
|
+
204: never;
|
2695
|
+
400: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2696
|
+
401: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2697
|
+
403: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2698
|
+
429: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2699
|
+
500: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2700
|
+
};
|
2701
|
+
requestBody: {
|
2702
|
+
content: {
|
2703
|
+
"application/json": {
|
2704
|
+
/**
|
2705
|
+
* Format: uuid
|
2706
|
+
* @description The project ID to upsert the composition to
|
2707
|
+
*/
|
2708
|
+
projectId: string;
|
2709
|
+
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
2710
|
+
state: number;
|
2711
|
+
composition: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2712
|
+
/**
|
2713
|
+
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
2714
|
+
* @default false
|
2715
|
+
*/
|
2716
|
+
pattern?: boolean;
|
2717
|
+
/** @description Ignored if present */
|
2718
|
+
created?: string;
|
2719
|
+
/** @description Ignored if present */
|
2720
|
+
modified?: string;
|
2721
|
+
};
|
2722
|
+
};
|
2723
|
+
};
|
2724
|
+
};
|
2725
|
+
/** Deletes or unpublishes a composition */
|
2726
|
+
delete: {
|
2727
|
+
responses: {
|
2728
|
+
/** OK */
|
2729
|
+
204: never;
|
2730
|
+
400: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2731
|
+
401: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2732
|
+
403: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2733
|
+
429: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2734
|
+
500: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2735
|
+
};
|
2736
|
+
requestBody: {
|
2737
|
+
content: {
|
2738
|
+
"application/json": {
|
2739
|
+
/**
|
2740
|
+
* Format: uuid
|
2741
|
+
* @description The ID of the composition to delete
|
2742
|
+
*/
|
2743
|
+
compositionId: string;
|
2744
|
+
/**
|
2745
|
+
* Format: uuid
|
2746
|
+
* @description The ID of the project the composition to delete belongs to
|
2747
|
+
*/
|
2748
|
+
projectId: string;
|
2749
|
+
/** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
2750
|
+
state?: number;
|
2751
|
+
};
|
2752
|
+
};
|
2753
|
+
};
|
2754
|
+
};
|
2755
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
2756
|
+
options: {
|
2757
|
+
responses: {
|
2758
|
+
/** OK */
|
2759
|
+
204: never;
|
2760
|
+
};
|
2761
|
+
};
|
2762
|
+
};
|
2763
|
+
};
|
2764
|
+
components: {
|
2765
|
+
schemas: {
|
2766
|
+
CompositionApiResponse: {
|
2767
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2768
|
+
state: number;
|
2769
|
+
/**
|
2770
|
+
* @deprecated
|
2771
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
2772
|
+
* @enum {string}
|
2773
|
+
*/
|
2774
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
2775
|
+
/**
|
2776
|
+
* Format: uuid
|
2777
|
+
* @description The project ID that this layout data is part of
|
2778
|
+
*/
|
2779
|
+
projectId: string;
|
2780
|
+
/**
|
2781
|
+
* Format: date-time,
|
2782
|
+
* @description Created date string for this definition
|
2783
|
+
*/
|
2784
|
+
created: string;
|
2785
|
+
/**
|
2786
|
+
* Format: date-time,
|
2787
|
+
* @description Modified date string for this definition
|
2788
|
+
*/
|
2789
|
+
modified: string;
|
2790
|
+
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
2791
|
+
pattern: boolean;
|
2792
|
+
composition: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2793
|
+
};
|
2794
|
+
CompositionListResponse: {
|
2795
|
+
compositions: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
|
2796
|
+
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
2797
|
+
totalCount?: number;
|
2798
|
+
};
|
2799
|
+
};
|
2800
|
+
parameters: {
|
2801
|
+
/** @description The project the composition(s) are on. */
|
2802
|
+
projectId: string;
|
2803
|
+
/** @description Specify a single composition ID to fetch. Changes response from list to single. */
|
2804
|
+
compositionId: string;
|
2805
|
+
/** @description Specify multiple composition IDs to fetch. Response type will be a list. */
|
2806
|
+
compositionIDs: string[];
|
2807
|
+
/** @description Specify a single composition to fetch by slug. Changes response from list to single. */
|
2808
|
+
slug: string;
|
2809
|
+
/** @description Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2810
|
+
projectMapNodeId: string;
|
2811
|
+
/** @description Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2812
|
+
projectMapNodePath: string;
|
2813
|
+
/** @description Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
2814
|
+
projectMapId: string;
|
2815
|
+
/** @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. */
|
2816
|
+
type: string[];
|
2817
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2818
|
+
state: number;
|
2819
|
+
/** @description Number of records to skip */
|
2820
|
+
offset: number;
|
2821
|
+
/** @description Max number of records to return */
|
2822
|
+
limit: number;
|
2823
|
+
/**
|
2824
|
+
* @deprecated
|
2825
|
+
* @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2826
|
+
* This improves performance if you do not require enhanced component data.
|
2827
|
+
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2828
|
+
*/
|
2829
|
+
skipEnhance: boolean;
|
2830
|
+
/**
|
2831
|
+
* @description If true, any pattern references in the composition will be left unresolved.
|
2832
|
+
* This is appropriate if you intend to serialize the composition without patterns
|
2833
|
+
* embedded into it, and serialize the pattern data separately.
|
2834
|
+
*/
|
2835
|
+
skipPatternResolution: boolean;
|
2836
|
+
/**
|
2837
|
+
* @description If true, any pattern override data is not resolved by the API.
|
2838
|
+
* This is intended for internal use in the Canvas editor, and should not be used.
|
2839
|
+
* Passing this parameter automatically implies withComponentIDs to be true.
|
2840
|
+
*/
|
2841
|
+
skipOverridesResolution: boolean;
|
2842
|
+
/** @description If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2843
|
+
skipParameterResolution: boolean;
|
2844
|
+
/**
|
2845
|
+
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2846
|
+
* If false, the `_id` will not be present in the API response.
|
2847
|
+
*/
|
2848
|
+
withComponentIDs: boolean;
|
2849
|
+
/**
|
2850
|
+
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2851
|
+
* NOT a full text search; does not match composition contents.
|
2852
|
+
*/
|
2853
|
+
keyword: string;
|
2854
|
+
/**
|
2855
|
+
* @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
2856
|
+
* If true, only pattern compositions will be returned.
|
2857
|
+
* If false, only regular compositions will be returned.
|
2858
|
+
* If omitted, both pattern and regular compositions will be returned.
|
2859
|
+
*/
|
2860
|
+
pattern: boolean;
|
2861
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2862
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
2863
|
+
/**
|
2864
|
+
* @deprecated
|
2865
|
+
* @description Returns the UI status string of the composition.
|
2866
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2867
|
+
*/
|
2868
|
+
withUIStatus: boolean;
|
2869
|
+
/**
|
2870
|
+
* @deprecated
|
2871
|
+
* @description Filters composition lists by the UI status of the composition.
|
2872
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2873
|
+
*/
|
2874
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
2875
|
+
/**
|
2876
|
+
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
2877
|
+
* in case of FALSE. If not specified - no filtration applied.
|
2878
|
+
*/
|
2879
|
+
attachedToProjectMap: boolean;
|
2880
|
+
/** @description Includes project map node information in the composition results */
|
2881
|
+
withProjectMapNodes: boolean;
|
2882
|
+
/** @description Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2883
|
+
createdBy: string;
|
2884
|
+
/** @description Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2885
|
+
updatedBy: string;
|
2886
|
+
/**
|
2887
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
2888
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2889
|
+
*/
|
2890
|
+
withTotalCount: boolean;
|
2891
|
+
};
|
2892
|
+
};
|
2893
|
+
operations: {};
|
2894
|
+
};
|
2895
|
+
"../../../lambda/functions/v1-route.swagger.yml": {
|
2896
|
+
paths: {
|
2897
|
+
"/api/v1/route": {
|
2898
|
+
/** Fetches the correct response action for a given route (redirection, composition, not found) */
|
2899
|
+
get: {
|
2900
|
+
parameters: {
|
2901
|
+
query: {
|
2902
|
+
/** The project to fetch a route from */
|
2903
|
+
projectId: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["projectId"];
|
2904
|
+
/**
|
2905
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
2906
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
2907
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
2908
|
+
* be returned as as dynamic inputs to the composition.
|
2909
|
+
*
|
2910
|
+
* Examples:
|
2911
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
2912
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
2913
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
2914
|
+
*
|
2915
|
+
* Conflict resolution:
|
2916
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
2917
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
2918
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
2919
|
+
* * The route with the most path segments wins
|
2920
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
2921
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
2922
|
+
*/
|
2923
|
+
path: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["path"];
|
2924
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used. */
|
2925
|
+
projectMapId?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
2926
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
2927
|
+
state?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["state"];
|
2928
|
+
/**
|
2929
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2930
|
+
* If false, the `_id` will not be present in the API response.
|
2931
|
+
*/
|
2932
|
+
withComponentIDs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
2933
|
+
};
|
2934
|
+
};
|
2935
|
+
responses: {
|
2936
|
+
/** OK */
|
2937
|
+
200: {
|
2938
|
+
content: {
|
2939
|
+
"application/json": external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponse"];
|
2940
|
+
};
|
2941
|
+
};
|
2942
|
+
400: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2943
|
+
401: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2944
|
+
403: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2945
|
+
429: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2946
|
+
500: external$6["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2947
|
+
};
|
2948
|
+
};
|
2949
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
2950
|
+
options: {
|
2951
|
+
responses: {
|
2952
|
+
/** OK */
|
2953
|
+
204: never;
|
2954
|
+
};
|
2955
|
+
};
|
2956
|
+
};
|
2957
|
+
};
|
2958
|
+
components: {
|
2959
|
+
schemas: {
|
2960
|
+
RouteResponse: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseRedirect"] | external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseComposition"] | external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteResponseNotFound"];
|
2961
|
+
/** @description The route matches a redirection configured in Uniform. */
|
2962
|
+
RouteResponseRedirect: {
|
2963
|
+
/** @description The route that was matched in the redirects. */
|
2964
|
+
matchedRoute: string;
|
2965
|
+
dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
|
2966
|
+
/** @enum {string} */
|
2967
|
+
type: "redirect";
|
2968
|
+
redirect: {
|
2969
|
+
/** @description Target meant to be redirected to. */
|
2970
|
+
targetUrl: string;
|
2971
|
+
/**
|
2972
|
+
* @description Redirect type to occur from this redirect.
|
2973
|
+
* @enum {integer}
|
2974
|
+
*/
|
2975
|
+
targetStatusCode?: 301 | 302 | 307 | 308;
|
2976
|
+
};
|
2977
|
+
};
|
2978
|
+
/**
|
2979
|
+
* @description The route matches a composition.
|
2980
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response.
|
1862
2981
|
*/
|
1863
|
-
|
1864
|
-
|
2982
|
+
RouteResponseComposition: {
|
2983
|
+
/** @description The route that was matched in the project map. */
|
2984
|
+
matchedRoute: string;
|
2985
|
+
dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
|
2986
|
+
/** @enum {string} */
|
2987
|
+
type: "composition";
|
2988
|
+
compositionApiResponse: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
1865
2989
|
};
|
1866
|
-
/**
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
/**
|
1873
|
-
|
1874
|
-
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
1875
|
-
* If isPatternParameter is false or undefined, this has no meaning.
|
1876
|
-
*/
|
1877
|
-
ignorePatternParameterDefault?: boolean;
|
1878
|
-
variables?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2990
|
+
/**
|
2991
|
+
* @description The route does not match any configured redirections or compositions.
|
2992
|
+
* NOTE: this response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
2993
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything.
|
2994
|
+
*/
|
2995
|
+
RouteResponseNotFound: {
|
2996
|
+
/** @enum {string} */
|
2997
|
+
type: "notFound";
|
1879
2998
|
};
|
1880
|
-
|
1881
|
-
DataResourceVariables: {
|
2999
|
+
RouteDynamicInputs: {
|
1882
3000
|
[key: string]: string;
|
1883
3001
|
};
|
1884
|
-
|
1885
|
-
|
1886
|
-
|
1887
|
-
|
1888
|
-
|
1889
|
-
|
1890
|
-
|
1891
|
-
|
1892
|
-
|
1893
|
-
|
1894
|
-
|
1895
|
-
|
1896
|
-
|
1897
|
-
|
1898
|
-
|
3002
|
+
};
|
3003
|
+
parameters: {
|
3004
|
+
/** @description The project to fetch a route from */
|
3005
|
+
projectId: string;
|
3006
|
+
/**
|
3007
|
+
* @description The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
3008
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
3009
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
3010
|
+
* be returned as as dynamic inputs to the composition.
|
3011
|
+
*
|
3012
|
+
* Examples:
|
3013
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
3014
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
3015
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
3016
|
+
*
|
3017
|
+
* Conflict resolution:
|
3018
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
3019
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
3020
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
3021
|
+
* * The route with the most path segments wins
|
3022
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
3023
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
3024
|
+
*/
|
3025
|
+
path: string;
|
3026
|
+
/** @description Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used. */
|
3027
|
+
projectMapId: string;
|
3028
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
3029
|
+
state: number;
|
3030
|
+
/**
|
3031
|
+
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
3032
|
+
* If false, the `_id` will not be present in the API response.
|
3033
|
+
*/
|
3034
|
+
withComponentIDs: boolean;
|
1899
3035
|
};
|
1900
3036
|
};
|
1901
3037
|
operations: {};
|
1902
3038
|
};
|
1903
3039
|
}
|
1904
3040
|
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
|
1909
|
-
|
1910
|
-
|
1911
|
-
|
1912
|
-
|
1913
|
-
|
1914
|
-
|
1915
|
-
|
1916
|
-
|
1917
|
-
|
1918
|
-
|
1919
|
-
|
1920
|
-
|
1921
|
-
|
1922
|
-
|
1923
|
-
|
1924
|
-
|
1925
|
-
|
1926
|
-
|
1927
|
-
|
1928
|
-
|
1929
|
-
|
1930
|
-
|
1931
|
-
|
1932
|
-
|
1933
|
-
|
1934
|
-
|
1935
|
-
|
1936
|
-
|
1937
|
-
|
1938
|
-
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
|
1943
|
-
|
1944
|
-
|
1945
|
-
|
1946
|
-
|
1947
|
-
/** @description Indicates if the composition was fetched from the cache */
|
1948
|
-
cacheHit: boolean;
|
1949
|
-
/** @description Indicates if the request results in a valid composition */
|
1950
|
-
hasValidComposition: boolean;
|
1951
|
-
/** @description Edge cache location used */
|
1952
|
-
cacheLocation?: string;
|
1953
|
-
/** @description Uniform-specifc request identifiers */
|
1954
|
-
requestId?: string;
|
1955
|
-
};
|
1956
|
-
configRetrieval?: {
|
1957
|
-
/** @description How long it took to retrieve the config (ms, in parallel to composition fetch) */
|
1958
|
-
duration: number;
|
1959
|
-
/** @description How many data type configs were retrieved */
|
1960
|
-
dataTypeCount: number;
|
1961
|
-
};
|
1962
|
-
data?: components["schemas"]["DataDiagnostic"][];
|
1963
|
-
};
|
1964
|
-
CompositionIssue: {
|
1965
|
-
componentPath?: string;
|
1966
|
-
componentType?: string;
|
1967
|
-
message: string;
|
1968
|
-
type: string;
|
1969
|
-
};
|
1970
|
-
InvalidationResult: {
|
1971
|
-
ok: boolean;
|
1972
|
-
};
|
1973
|
-
BatchInvalidationResult: {
|
1974
|
-
ok: number;
|
1975
|
-
failed: number;
|
1976
|
-
};
|
1977
|
-
};
|
1978
|
-
responses: {
|
1979
|
-
/** Invalid caller input came with the request */
|
1980
|
-
BadRequestError: {
|
1981
|
-
content: {
|
1982
|
-
"application/json": components["schemas"]["UniformError"];
|
1983
|
-
};
|
1984
|
-
};
|
1985
|
-
UnauthorizedError: {
|
1986
|
-
content: {
|
1987
|
-
"application/json": components["schemas"]["UniformError"];
|
1988
|
-
};
|
1989
|
-
};
|
1990
|
-
ForbiddenError: {
|
1991
|
-
content: {
|
1992
|
-
"application/json": components["schemas"]["UniformError"];
|
1993
|
-
};
|
1994
|
-
};
|
1995
|
-
/** The requested resource does not exist */
|
1996
|
-
NotFoundError: {
|
1997
|
-
content: {
|
1998
|
-
"application/json": components["schemas"]["UniformError"];
|
1999
|
-
};
|
2000
|
-
};
|
2001
|
-
/** Invalid method was used to call the endpoint */
|
2002
|
-
MethodNotAllowedError: {
|
2003
|
-
content: {
|
2004
|
-
"application/json": components["schemas"]["UniformError"];
|
3041
|
+
/**
|
3042
|
+
* This file was auto-generated by openapi-typescript.
|
3043
|
+
* Do not make direct changes to the file.
|
3044
|
+
*/
|
3045
|
+
interface paths$5 {
|
3046
|
+
"/api/v1/route": {
|
3047
|
+
/** Fetches the correct response action for a given route (redirection, composition, not found) */
|
3048
|
+
get: {
|
3049
|
+
parameters: {
|
3050
|
+
query: {
|
3051
|
+
/** The project to fetch a route from */
|
3052
|
+
projectId: components["parameters"]["projectId"];
|
3053
|
+
/**
|
3054
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
3055
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
3056
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
3057
|
+
* be returned as as dynamic inputs to the composition.
|
3058
|
+
*
|
3059
|
+
* Examples:
|
3060
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
3061
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
3062
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
3063
|
+
*
|
3064
|
+
* Conflict resolution:
|
3065
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
3066
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
3067
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
3068
|
+
* * The route with the most path segments wins
|
3069
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
3070
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
3071
|
+
*/
|
3072
|
+
path: components["parameters"]["path"];
|
3073
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used. */
|
3074
|
+
projectMapId?: components["parameters"]["projectMapId"];
|
3075
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
3076
|
+
state?: components["parameters"]["state"];
|
3077
|
+
/**
|
3078
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
3079
|
+
* If false, the `_id` will not be present in the API response.
|
3080
|
+
*/
|
3081
|
+
withComponentIDs?: components["parameters"]["withComponentIDs"];
|
3082
|
+
};
|
2005
3083
|
};
|
2006
|
-
|
2007
|
-
|
2008
|
-
|
2009
|
-
|
2010
|
-
|
3084
|
+
responses: {
|
3085
|
+
/** OK */
|
3086
|
+
200: {
|
3087
|
+
content: {
|
3088
|
+
"application/json": components["schemas"]["RouteResponse"];
|
3089
|
+
};
|
3090
|
+
};
|
3091
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3092
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3093
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3094
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3095
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2011
3096
|
};
|
2012
3097
|
};
|
2013
|
-
|
2014
|
-
|
2015
|
-
|
3098
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
3099
|
+
options: {
|
3100
|
+
responses: {
|
3101
|
+
/** OK */
|
3102
|
+
204: never;
|
2016
3103
|
};
|
2017
3104
|
};
|
2018
|
-
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
3105
|
+
};
|
3106
|
+
}
|
3107
|
+
interface components {
|
3108
|
+
schemas: {
|
3109
|
+
RouteResponse: components["schemas"]["RouteResponseRedirect"] | components["schemas"]["RouteResponseComposition"] | components["schemas"]["RouteResponseNotFound"];
|
3110
|
+
/** @description The route matches a redirection configured in Uniform. */
|
3111
|
+
RouteResponseRedirect: {
|
3112
|
+
/** @description The route that was matched in the redirects. */
|
3113
|
+
matchedRoute: string;
|
3114
|
+
dynamicInputs?: components["schemas"]["RouteDynamicInputs"];
|
3115
|
+
/** @enum {string} */
|
3116
|
+
type: "redirect";
|
3117
|
+
redirect: {
|
3118
|
+
/** @description Target meant to be redirected to. */
|
3119
|
+
targetUrl: string;
|
3120
|
+
/**
|
3121
|
+
* @description Redirect type to occur from this redirect.
|
3122
|
+
* @enum {integer}
|
3123
|
+
*/
|
3124
|
+
targetStatusCode?: 301 | 302 | 307 | 308;
|
2022
3125
|
};
|
2023
3126
|
};
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2029
|
-
|
2030
|
-
|
2031
|
-
|
3127
|
+
/**
|
3128
|
+
* @description The route matches a composition.
|
3129
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response.
|
3130
|
+
*/
|
3131
|
+
RouteResponseComposition: {
|
3132
|
+
/** @description The route that was matched in the project map. */
|
3133
|
+
matchedRoute: string;
|
3134
|
+
dynamicInputs?: components["schemas"]["RouteDynamicInputs"];
|
3135
|
+
/** @enum {string} */
|
3136
|
+
type: "composition";
|
3137
|
+
compositionApiResponse: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2032
3138
|
};
|
2033
|
-
/**
|
2034
|
-
|
2035
|
-
|
2036
|
-
|
2037
|
-
|
3139
|
+
/**
|
3140
|
+
* @description The route does not match any configured redirections or compositions.
|
3141
|
+
* NOTE: this response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
3142
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything.
|
3143
|
+
*/
|
3144
|
+
RouteResponseNotFound: {
|
3145
|
+
/** @enum {string} */
|
3146
|
+
type: "notFound";
|
2038
3147
|
};
|
2039
|
-
|
2040
|
-
|
2041
|
-
content: {
|
2042
|
-
"application/json": components["schemas"]["BatchInvalidationResult"];
|
2043
|
-
};
|
3148
|
+
RouteDynamicInputs: {
|
3149
|
+
[key: string]: string;
|
2044
3150
|
};
|
2045
3151
|
};
|
3152
|
+
parameters: {
|
3153
|
+
/** @description The project to fetch a route from */
|
3154
|
+
projectId: string;
|
3155
|
+
/**
|
3156
|
+
* @description The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
3157
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
3158
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
3159
|
+
* be returned as as dynamic inputs to the composition.
|
3160
|
+
*
|
3161
|
+
* Examples:
|
3162
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
3163
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
3164
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
3165
|
+
*
|
3166
|
+
* Conflict resolution:
|
3167
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
3168
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
3169
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
3170
|
+
* * The route with the most path segments wins
|
3171
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
3172
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
3173
|
+
*/
|
3174
|
+
path: string;
|
3175
|
+
/** @description Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used. */
|
3176
|
+
projectMapId: string;
|
3177
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
3178
|
+
state: number;
|
3179
|
+
/**
|
3180
|
+
* @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
3181
|
+
* If false, the `_id` will not be present in the API response.
|
3182
|
+
*/
|
3183
|
+
withComponentIDs: boolean;
|
3184
|
+
};
|
2046
3185
|
}
|
2047
3186
|
interface external$5 {
|
2048
|
-
"
|
3187
|
+
"swagger.yml": {
|
2049
3188
|
paths: {};
|
2050
3189
|
components: {
|
2051
3190
|
schemas: {
|
@@ -2058,25 +3197,25 @@ interface external$5 {
|
|
2058
3197
|
/** Request input validation failed */
|
2059
3198
|
BadRequestError: {
|
2060
3199
|
content: {
|
2061
|
-
"application/json": external$5["
|
3200
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
2062
3201
|
};
|
2063
3202
|
};
|
2064
3203
|
/** API key or token was not valid */
|
2065
3204
|
UnauthorizedError: {
|
2066
3205
|
content: {
|
2067
|
-
"application/json": external$5["
|
3206
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
2068
3207
|
};
|
2069
3208
|
};
|
2070
3209
|
/** Permission was denied */
|
2071
3210
|
ForbiddenError: {
|
2072
3211
|
content: {
|
2073
|
-
"application/json": external$5["
|
3212
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
2074
3213
|
};
|
2075
3214
|
};
|
2076
3215
|
/** Resource not found */
|
2077
3216
|
NotFoundError: {
|
2078
3217
|
content: {
|
2079
|
-
"application/json": external$5["
|
3218
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
2080
3219
|
};
|
2081
3220
|
};
|
2082
3221
|
/** Too many requests in allowed time period */
|
@@ -2087,7 +3226,7 @@ interface external$5 {
|
|
2087
3226
|
};
|
2088
3227
|
operations: {};
|
2089
3228
|
};
|
2090
|
-
"
|
3229
|
+
"uniform-canvas-types.swagger.yml": {
|
2091
3230
|
paths: {};
|
2092
3231
|
components: {
|
2093
3232
|
schemas: {
|
@@ -2095,7 +3234,7 @@ interface external$5 {
|
|
2095
3234
|
PublicIdProperty: string;
|
2096
3235
|
/** @description The definition of a component parameter */
|
2097
3236
|
ComponentDefinitionParameter: {
|
2098
|
-
id: external$5["
|
3237
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2099
3238
|
/** @description Friendly name of the parameter */
|
2100
3239
|
name: string;
|
2101
3240
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2107,7 +3246,7 @@ interface external$5 {
|
|
2107
3246
|
};
|
2108
3247
|
/** @description The definition of a named component slot that can contain other components */
|
2109
3248
|
ComponentDefinitionSlot: {
|
2110
|
-
id: external$5["
|
3249
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2111
3250
|
/** @description Friendly name of the slot */
|
2112
3251
|
name: string;
|
2113
3252
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2165,13 +3304,13 @@ interface external$5 {
|
|
2165
3304
|
};
|
2166
3305
|
/** @description The definition of a component variant */
|
2167
3306
|
ComponentDefinitionVariant: {
|
2168
|
-
id: external$5["
|
3307
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2169
3308
|
/** @description Friendly name of the variant */
|
2170
3309
|
name: string;
|
2171
3310
|
};
|
2172
3311
|
/** @description Permission set for a component defintion */
|
2173
3312
|
ComponentDefinitionPermission: {
|
2174
|
-
roleId: external$5["
|
3313
|
+
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2175
3314
|
/**
|
2176
3315
|
* @description Permission type for this permission ComponentDefinition:
|
2177
3316
|
* read | write | create | delete
|
@@ -2184,7 +3323,7 @@ interface external$5 {
|
|
2184
3323
|
};
|
2185
3324
|
/** @description Defines a component type that can live on a Composition */
|
2186
3325
|
ComponentDefinition: {
|
2187
|
-
id: external$5["
|
3326
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2188
3327
|
/** @description Friendly name of the component definition */
|
2189
3328
|
name: string;
|
2190
3329
|
/**
|
@@ -2203,21 +3342,21 @@ interface external$5 {
|
|
2203
3342
|
*/
|
2204
3343
|
canBeComposition?: boolean;
|
2205
3344
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2206
|
-
parameters?: external$5["
|
3345
|
+
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2207
3346
|
/**
|
2208
3347
|
* @description if this component uses team permissions or custom permissions
|
2209
3348
|
* @default true
|
2210
3349
|
*/
|
2211
3350
|
useTeamPermissions?: boolean;
|
2212
3351
|
/** @description Custom role permissions for this component definition */
|
2213
|
-
permissions?: external$5["
|
3352
|
+
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2214
3353
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2215
|
-
slots?: external$5["
|
2216
|
-
slugSettings?: external$5["
|
3354
|
+
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3355
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2217
3356
|
/** @description Default component instance value */
|
2218
|
-
defaults?: external$5["
|
3357
|
+
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2219
3358
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2220
|
-
variants?: external$5["
|
3359
|
+
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2221
3360
|
/** @description Created date string for this definition (ignored for writes) */
|
2222
3361
|
created?: string;
|
2223
3362
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2229,7 +3368,7 @@ interface external$5 {
|
|
2229
3368
|
value: unknown;
|
2230
3369
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2231
3370
|
type: string;
|
2232
|
-
connectedData?: external$5["
|
3371
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2233
3372
|
};
|
2234
3373
|
/**
|
2235
3374
|
* @description Defines a connection to a data element on a data resource.
|
@@ -2252,13 +3391,13 @@ interface external$5 {
|
|
2252
3391
|
type: string;
|
2253
3392
|
/** @description Component parameter values for the component instance */
|
2254
3393
|
parameters?: {
|
2255
|
-
[key: string]: external$5["
|
3394
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2256
3395
|
};
|
2257
3396
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2258
3397
|
variant?: string;
|
2259
3398
|
/** @description Slots containing any child components */
|
2260
3399
|
slots?: {
|
2261
|
-
[key: string]: external$5["
|
3400
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2262
3401
|
};
|
2263
3402
|
/**
|
2264
3403
|
* @description Unique identifier of the component within the composition.
|
@@ -2268,13 +3407,13 @@ interface external$5 {
|
|
2268
3407
|
_id?: string;
|
2269
3408
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2270
3409
|
_pattern?: string;
|
2271
|
-
_dataResources?: external$5["
|
3410
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2272
3411
|
/**
|
2273
3412
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2274
3413
|
* Means nothing for PUTs; it will be ignored.
|
2275
3414
|
*/
|
2276
3415
|
_patternDataResources?: {
|
2277
|
-
[key: string]: external$5["
|
3416
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2278
3417
|
};
|
2279
3418
|
/**
|
2280
3419
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2298,7 +3437,7 @@ interface external$5 {
|
|
2298
3437
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2299
3438
|
*/
|
2300
3439
|
_overrides?: {
|
2301
|
-
[key: string]: external$5["
|
3440
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2302
3441
|
};
|
2303
3442
|
/**
|
2304
3443
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2307,7 +3446,7 @@ interface external$5 {
|
|
2307
3446
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2308
3447
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2309
3448
|
*/
|
2310
|
-
_overridability?: external$5["
|
3449
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2311
3450
|
};
|
2312
3451
|
/** @description Defines the shape of the root component in a composition */
|
2313
3452
|
RootComponentInstance: {
|
@@ -2315,15 +3454,15 @@ interface external$5 {
|
|
2315
3454
|
type: string;
|
2316
3455
|
/** @description Component parameter values for the component instance */
|
2317
3456
|
parameters?: {
|
2318
|
-
[key: string]: external$5["
|
3457
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2319
3458
|
};
|
2320
3459
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2321
3460
|
variant?: string;
|
2322
3461
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2323
|
-
projectMapNodes?: external$5["
|
3462
|
+
projectMapNodes?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2324
3463
|
/** @description Slots containing any child components */
|
2325
3464
|
slots?: {
|
2326
|
-
[key: string]: external$5["
|
3465
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2327
3466
|
};
|
2328
3467
|
/** @description The public UUID of the composition. */
|
2329
3468
|
_id: string;
|
@@ -2331,7 +3470,7 @@ interface external$5 {
|
|
2331
3470
|
_slug?: string | null;
|
2332
3471
|
/** @description Friendly name of this component. */
|
2333
3472
|
_name: string;
|
2334
|
-
_dataResources?: external$5["
|
3473
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2335
3474
|
/**
|
2336
3475
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2337
3476
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2345,7 +3484,7 @@ interface external$5 {
|
|
2345
3484
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2346
3485
|
*/
|
2347
3486
|
_overrides?: {
|
2348
|
-
[key: string]: external$5["
|
3487
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2349
3488
|
};
|
2350
3489
|
/**
|
2351
3490
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2354,7 +3493,7 @@ interface external$5 {
|
|
2354
3493
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2355
3494
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2356
3495
|
*/
|
2357
|
-
_overridability?: external$5["
|
3496
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2358
3497
|
};
|
2359
3498
|
/**
|
2360
3499
|
* @description Defines how to override a specific component.
|
@@ -2364,7 +3503,7 @@ interface external$5 {
|
|
2364
3503
|
*/
|
2365
3504
|
ComponentOverride: {
|
2366
3505
|
parameters?: {
|
2367
|
-
[key: string]: external$5["
|
3506
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2368
3507
|
};
|
2369
3508
|
variant?: string;
|
2370
3509
|
};
|
@@ -2378,7 +3517,7 @@ interface external$5 {
|
|
2378
3517
|
ComponentOverridability: {
|
2379
3518
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2380
3519
|
parameters?: {
|
2381
|
-
[key: string]: external$5["
|
3520
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2382
3521
|
};
|
2383
3522
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2384
3523
|
variants?: boolean;
|
@@ -2419,7 +3558,7 @@ interface external$5 {
|
|
2419
3558
|
}[];
|
2420
3559
|
/** @description Variables needed to make calls to the data source */
|
2421
3560
|
variables?: {
|
2422
|
-
[key: string]: external$5["
|
3561
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2423
3562
|
};
|
2424
3563
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2425
3564
|
custom?: {
|
@@ -2476,7 +3615,7 @@ interface external$5 {
|
|
2476
3615
|
method: "GET" | "POST" | "HEAD";
|
2477
3616
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2478
3617
|
variables?: {
|
2479
|
-
[key: string]: external$5["
|
3618
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2480
3619
|
};
|
2481
3620
|
/** @description Custom configuration specific to the data source being defined */
|
2482
3621
|
custom?: {
|
@@ -2504,7 +3643,7 @@ interface external$5 {
|
|
2504
3643
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2505
3644
|
*/
|
2506
3645
|
DataResourceDefinitions: {
|
2507
|
-
[key: string]: external$5["
|
3646
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2508
3647
|
};
|
2509
3648
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2510
3649
|
DataResourceDefinition: {
|
@@ -2518,7 +3657,7 @@ interface external$5 {
|
|
2518
3657
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2519
3658
|
*/
|
2520
3659
|
ignorePatternParameterDefault?: boolean;
|
2521
|
-
variables?: external$5["
|
3660
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2522
3661
|
};
|
2523
3662
|
/** @description Variable values for a data resource. */
|
2524
3663
|
DataResourceVariables: {
|
@@ -2543,119 +3682,119 @@ interface external$5 {
|
|
2543
3682
|
};
|
2544
3683
|
operations: {};
|
2545
3684
|
};
|
2546
|
-
"
|
3685
|
+
"v1-canvas.swagger.yml": {
|
2547
3686
|
paths: {
|
2548
3687
|
"/api/v1/canvas": {
|
2549
3688
|
get: {
|
2550
3689
|
parameters: {
|
2551
3690
|
query: {
|
2552
3691
|
/** Specify a single composition ID to fetch. Changes response from list to single. */
|
2553
|
-
compositionId?: external$5["
|
3692
|
+
compositionId?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
2554
3693
|
/** Specify multiple composition IDs to fetch. Response type will be a list. */
|
2555
|
-
compositionIDs?: external$5["
|
3694
|
+
compositionIDs?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
2556
3695
|
/** Filters composition lists by the user who created them. The user is specified by their identity subject. */
|
2557
|
-
createdBy?: external$5["
|
3696
|
+
createdBy?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
2558
3697
|
/**
|
2559
3698
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2560
3699
|
* NOT a full text search; does not match composition contents.
|
2561
3700
|
*/
|
2562
|
-
keyword?: external$5["
|
3701
|
+
keyword?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
2563
3702
|
/** Max number of records to return */
|
2564
|
-
limit?: external$5["
|
3703
|
+
limit?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
2565
3704
|
/** Number of records to skip */
|
2566
|
-
offset?: external$5["
|
3705
|
+
offset?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
2567
3706
|
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2568
|
-
orderBy?: external$5["
|
3707
|
+
orderBy?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
2569
3708
|
/**
|
2570
3709
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2571
3710
|
* If true, only pattern compositions will be returned.
|
2572
3711
|
* If false, only regular compositions will be returned.
|
2573
3712
|
* If omitted, both pattern and regular compositions will be returned.
|
2574
3713
|
*/
|
2575
|
-
pattern?: external$5["
|
3714
|
+
pattern?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
2576
3715
|
/** The project the composition(s) are on. */
|
2577
|
-
projectId: external$5["
|
2578
|
-
/**
|
2579
|
-
projectMapId?: external$5["
|
3716
|
+
projectId: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
3717
|
+
/** Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
3718
|
+
projectMapId?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
2580
3719
|
/** Specify a single composition to fetch by assodicated project map node ID. Changes response from list to single. */
|
2581
|
-
projectMapNodeId?: external$5["
|
3720
|
+
projectMapNodeId?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
2582
3721
|
/** Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2583
|
-
projectMapNodePath?: external$5["
|
3722
|
+
projectMapNodePath?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
2584
3723
|
/**
|
2585
3724
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2586
3725
|
* This improves performance if you do not require enhanced component data.
|
2587
3726
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2588
3727
|
*/
|
2589
|
-
skipEnhance?: external$5["
|
3728
|
+
skipEnhance?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["skipEnhance"];
|
2590
3729
|
/**
|
2591
3730
|
* If true, any pattern references in the composition will be left unresolved.
|
2592
3731
|
* This is appropriate if you intend to serialize the composition without patterns
|
2593
3732
|
* embedded into it, and serialize the pattern data separately.
|
2594
3733
|
*/
|
2595
|
-
skipPatternResolution?: external$5["
|
3734
|
+
skipPatternResolution?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["skipPatternResolution"];
|
2596
3735
|
/** If true, any dynamic parameters will be left with their raw data. Project map link path is a dynamic parameter. */
|
2597
|
-
skipParameterResolution?: external$5["
|
3736
|
+
skipParameterResolution?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["skipParameterResolution"];
|
2598
3737
|
/**
|
2599
3738
|
* If true, any pattern override data is not resolved by the API.
|
2600
3739
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2601
3740
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2602
3741
|
*/
|
2603
|
-
skipOverridesResolution?: external$5["
|
3742
|
+
skipOverridesResolution?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
2604
3743
|
/** Specify a single composition to fetch by slug. Changes response from list to single. */
|
2605
|
-
slug?: external$5["
|
2606
|
-
/**
|
2607
|
-
state?: external$5["
|
3744
|
+
slug?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
3745
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
3746
|
+
state?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
2608
3747
|
/** The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter. */
|
2609
|
-
type?: external$5["
|
3748
|
+
type?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
2610
3749
|
/**
|
2611
3750
|
* @deprecated Filters composition lists by the UI status of the composition.
|
2612
3751
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2613
3752
|
*/
|
2614
|
-
uiStatus?: external$5["
|
3753
|
+
uiStatus?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
2615
3754
|
/**
|
2616
3755
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
2617
3756
|
* in case of FALSE. If not specified - no filtration applied.
|
2618
3757
|
*/
|
2619
|
-
attachedToProjectMap?: external$5["
|
3758
|
+
attachedToProjectMap?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
2620
3759
|
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2621
|
-
updatedBy?: external$5["
|
3760
|
+
updatedBy?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
2622
3761
|
/**
|
2623
3762
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2624
3763
|
* If false, the `_id` will not be present in the API response.
|
2625
3764
|
*/
|
2626
|
-
withComponentIDs?: external$5["
|
3765
|
+
withComponentIDs?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withComponentIDs"];
|
2627
3766
|
/**
|
2628
3767
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2629
3768
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2630
3769
|
*/
|
2631
|
-
withTotalCount?: external$5["
|
3770
|
+
withTotalCount?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withTotalCount"];
|
2632
3771
|
/**
|
2633
3772
|
* @deprecated Returns the UI status string of the composition.
|
2634
3773
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2635
3774
|
*/
|
2636
|
-
withUIStatus?: external$5["
|
3775
|
+
withUIStatus?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
2637
3776
|
/** Includes project map node information in the composition results */
|
2638
|
-
withProjectMapNodes?: external$5["
|
3777
|
+
withProjectMapNodes?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withProjectMapNodes"];
|
2639
3778
|
};
|
2640
3779
|
};
|
2641
3780
|
responses: {
|
2642
3781
|
/** OK */
|
2643
3782
|
200: {
|
2644
3783
|
content: {
|
2645
|
-
"application/json": external$5["
|
3784
|
+
"application/json": external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"] | external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
2646
3785
|
};
|
2647
3786
|
};
|
2648
|
-
400: external$5["
|
2649
|
-
401: external$5["
|
2650
|
-
403: external$5["
|
3787
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3788
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3789
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2651
3790
|
/** Composition not found */
|
2652
3791
|
404: {
|
2653
3792
|
content: {
|
2654
3793
|
"text/plain": string;
|
2655
3794
|
};
|
2656
3795
|
};
|
2657
|
-
429: external$5["
|
2658
|
-
500: external$5["
|
3796
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3797
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2659
3798
|
};
|
2660
3799
|
};
|
2661
3800
|
/** Upserts a composition */
|
@@ -2663,11 +3802,11 @@ interface external$5 {
|
|
2663
3802
|
responses: {
|
2664
3803
|
/** OK */
|
2665
3804
|
204: never;
|
2666
|
-
400: external$5["
|
2667
|
-
401: external$5["
|
2668
|
-
403: external$5["
|
2669
|
-
429: external$5["
|
2670
|
-
500: external$5["
|
3805
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3806
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3807
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3808
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3809
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2671
3810
|
};
|
2672
3811
|
requestBody: {
|
2673
3812
|
content: {
|
@@ -2677,9 +3816,9 @@ interface external$5 {
|
|
2677
3816
|
* @description The project ID to upsert the composition to
|
2678
3817
|
*/
|
2679
3818
|
projectId: string;
|
2680
|
-
/** @description The state
|
3819
|
+
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
2681
3820
|
state: number;
|
2682
|
-
composition: external$5["
|
3821
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2683
3822
|
/**
|
2684
3823
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
2685
3824
|
* @default false
|
@@ -2698,11 +3837,11 @@ interface external$5 {
|
|
2698
3837
|
responses: {
|
2699
3838
|
/** OK */
|
2700
3839
|
204: never;
|
2701
|
-
400: external$5["
|
2702
|
-
401: external$5["
|
2703
|
-
403: external$5["
|
2704
|
-
429: external$5["
|
2705
|
-
500: external$5["
|
3840
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3841
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3842
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3843
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3844
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2706
3845
|
};
|
2707
3846
|
requestBody: {
|
2708
3847
|
content: {
|
@@ -2717,7 +3856,7 @@ interface external$5 {
|
|
2717
3856
|
* @description The ID of the project the composition to delete belongs to
|
2718
3857
|
*/
|
2719
3858
|
projectId: string;
|
2720
|
-
/** @description The state
|
3859
|
+
/** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
2721
3860
|
state?: number;
|
2722
3861
|
};
|
2723
3862
|
};
|
@@ -2735,7 +3874,7 @@ interface external$5 {
|
|
2735
3874
|
components: {
|
2736
3875
|
schemas: {
|
2737
3876
|
CompositionApiResponse: {
|
2738
|
-
/** @description
|
3877
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2739
3878
|
state: number;
|
2740
3879
|
/**
|
2741
3880
|
* @deprecated
|
@@ -2760,10 +3899,10 @@ interface external$5 {
|
|
2760
3899
|
modified: string;
|
2761
3900
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
2762
3901
|
pattern: boolean;
|
2763
|
-
composition: external$5["
|
3902
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
2764
3903
|
};
|
2765
3904
|
CompositionListResponse: {
|
2766
|
-
compositions: external$5["
|
3905
|
+
compositions: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
|
2767
3906
|
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
2768
3907
|
totalCount?: number;
|
2769
3908
|
};
|
@@ -2781,11 +3920,11 @@ interface external$5 {
|
|
2781
3920
|
projectMapNodeId: string;
|
2782
3921
|
/** @description Specify a single composition to fetch by assodicated project map node path. Changes response from list to single. */
|
2783
3922
|
projectMapNodePath: string;
|
2784
|
-
/** @description
|
3923
|
+
/** @description Specify a project map ID to fetch by path or node ID from. If not specified, the default project map for the projectId is used. */
|
2785
3924
|
projectMapId: string;
|
2786
3925
|
/** @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. */
|
2787
3926
|
type: string[];
|
2788
|
-
/** @description
|
3927
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2789
3928
|
state: number;
|
2790
3929
|
/** @description Number of records to skip */
|
2791
3930
|
offset: number;
|
@@ -2865,9 +4004,9 @@ interface external$5 {
|
|
2865
4004
|
};
|
2866
4005
|
}
|
2867
4006
|
|
2868
|
-
type Components = components$
|
2869
|
-
type SharedComponents = components$
|
2870
|
-
type Api = paths$
|
4007
|
+
type Components = components$2['schemas'];
|
4008
|
+
type SharedComponents = components$3['schemas'];
|
4009
|
+
type Api = paths$6['/api/v1/canvas'];
|
2871
4010
|
/** Query parameter options for GET /api/v1/canvas */
|
2872
4011
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
2873
4012
|
type?: string | string[];
|
@@ -2888,6 +4027,13 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
|
|
2888
4027
|
/** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2889
4028
|
value: TValue;
|
2890
4029
|
};
|
4030
|
+
/** The type of the parameters in contextual editing mode. */
|
4031
|
+
type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
|
4032
|
+
/** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
|
4033
|
+
_contextualEditing?: {
|
4034
|
+
isEditable?: boolean;
|
4035
|
+
};
|
4036
|
+
};
|
2891
4037
|
/** Defines a connection to a data element on a data resource. */
|
2892
4038
|
type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
|
2893
4039
|
/** Variable values for a data resource. */
|
@@ -2955,15 +4101,10 @@ type DataResolutionParameters = {
|
|
2955
4101
|
* Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
|
2956
4102
|
*/
|
2957
4103
|
diagnostics?: boolean;
|
2958
|
-
/**
|
2959
|
-
* Pass dynamic variables to the composition that are required for resolving bindings and datas,
|
2960
|
-
* such as language, detail page ID, etc.
|
2961
|
-
*/
|
2962
|
-
unstable_dynamicVariables?: Record<string, string>;
|
2963
4104
|
};
|
2964
4105
|
/** Types of issue that can occur when fetching composition data */
|
2965
|
-
type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue |
|
2966
|
-
type CompositionIssueCore = components['schemas']['CompositionIssue'];
|
4106
|
+
type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceInputIssue | DataResolutionConfigIssue | OverrideIssue;
|
4107
|
+
type CompositionIssueCore = components$1['schemas']['CompositionIssue'];
|
2967
4108
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
2968
4109
|
type CompositionPatternIssue = CompositionIssueCore & {
|
2969
4110
|
type: 'pattern';
|
@@ -2973,6 +4114,7 @@ type CompositionPatternIssue = CompositionIssueCore & {
|
|
2973
4114
|
type DataElementBindingIssue = CompositionIssueCore & {
|
2974
4115
|
type: 'binding';
|
2975
4116
|
parameterName: string;
|
4117
|
+
expression?: DataElementConnectionDefinition;
|
2976
4118
|
};
|
2977
4119
|
/** An error that occurred fetching a data defined on the composition or a pattern within */
|
2978
4120
|
type DataResourceIssue = CompositionIssueCore & {
|
@@ -2980,10 +4122,13 @@ type DataResourceIssue = CompositionIssueCore & {
|
|
2980
4122
|
dataName: string;
|
2981
4123
|
dataType: string;
|
2982
4124
|
};
|
2983
|
-
/**
|
2984
|
-
|
2985
|
-
|
2986
|
-
|
4125
|
+
/**
|
4126
|
+
* An issue that occurred while binding dynamic inputs to composition data resources,
|
4127
|
+
* specifically when an expected dynamic input did not have a value.
|
4128
|
+
*/
|
4129
|
+
type DataResourceInputIssue = CompositionIssueCore & {
|
4130
|
+
type: 'input';
|
4131
|
+
inputName: string;
|
2987
4132
|
};
|
2988
4133
|
/** Error in data resolution configuration (internal error) */
|
2989
4134
|
type DataResolutionConfigIssue = {
|
@@ -2996,31 +4141,24 @@ type OverrideIssue = CompositionIssueCore & {
|
|
2996
4141
|
type: 'override';
|
2997
4142
|
};
|
2998
4143
|
/** Diagnostics about edge request processing */
|
2999
|
-
type CompositionDiagnostics = components['schemas']['CompositionDiagnostics'];
|
4144
|
+
type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
|
3000
4145
|
/** Diagnostic data about the load performance of attached composition datas */
|
3001
|
-
type CompositionDataDiagnostic = components['schemas']['DataDiagnostic'];
|
3002
|
-
/** Response as it comes from
|
3003
|
-
type CompositionResolvedGetResponse =
|
3004
|
-
/**
|
3005
|
-
* Diagnostic information about request processing, including origin/config/data
|
3006
|
-
* timings, edge locations, cache statuses and raw data.
|
3007
|
-
* Only set when diagnostics=true is passed to the options.
|
3008
|
-
*/
|
3009
|
-
diagnostics?: CompositionDiagnostics;
|
3010
|
-
/**
|
3011
|
-
* Any failures to bind to data that occured on bindings marked 'must exist'.
|
3012
|
-
* If no failures occurred, this will be undefined.
|
3013
|
-
* NOTE: No exception will be thrown if this type of error occurs. You must inspect this property if you care to cause client errors.
|
3014
|
-
*/
|
3015
|
-
errors?: Array<CompositionIssue>;
|
3016
|
-
/**
|
3017
|
-
* 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)
|
3018
|
-
* If no failures occurred, this will be undefined.
|
3019
|
-
*/
|
3020
|
-
warnings?: Array<CompositionIssue>;
|
3021
|
-
};
|
4146
|
+
type CompositionDataDiagnostic = components$1['schemas']['DataDiagnostic'];
|
4147
|
+
/** Response as it comes from uniform.global/api/v1/composition */
|
4148
|
+
type CompositionResolvedGetResponse = components$1['schemas']['CompositionResolvedGetResponse'];
|
3022
4149
|
/** All valid response types */
|
3023
4150
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
4151
|
+
/** The GET response from /api/v1/route */
|
4152
|
+
type RouteGetParameters = paths$5['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
4153
|
+
type RouteGetResponse = components['schemas']['RouteResponse'];
|
4154
|
+
type RouteGetResponseComposition = components['schemas']['RouteResponseComposition'];
|
4155
|
+
type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
|
4156
|
+
type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
|
4157
|
+
type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
|
4158
|
+
/** GET response from uniform.global/api/v1/route when result is a composition */
|
4159
|
+
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
4160
|
+
compositionApiResponse: CompositionResolvedGetResponse;
|
4161
|
+
};
|
3024
4162
|
|
3025
4163
|
type CanvasClientOptions = ClientOptions & {
|
3026
4164
|
edgeApiHost?: string;
|
@@ -5258,9 +6396,9 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
5258
6396
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
5259
6397
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
5260
6398
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
5261
|
-
type DataType = components$
|
5262
|
-
type DataSource = components$
|
5263
|
-
type DataVariableDefinition = components$
|
6399
|
+
type DataType = components$3['schemas']['DataType'];
|
6400
|
+
type DataSource = components$3['schemas']['DataSource'];
|
6401
|
+
type DataVariableDefinition = components$3['schemas']['DataVariableDefinition'];
|
5264
6402
|
|
5265
6403
|
type EnhancerContext = {
|
5266
6404
|
preview?: boolean;
|
@@ -5340,7 +6478,7 @@ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TCo
|
|
5340
6478
|
completeAll?: () => Promise<number>;
|
5341
6479
|
};
|
5342
6480
|
|
5343
|
-
type schemas = components['schemas'];
|
6481
|
+
type schemas = components$1['schemas'];
|
5344
6482
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
5345
6483
|
type InvalidationResult = schemas['InvalidationResult'];
|
5346
6484
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
@@ -5640,6 +6778,11 @@ type UpdateCompositionMessage = {
|
|
5640
6778
|
composition: RootComponentInstance;
|
5641
6779
|
hash: number | undefined;
|
5642
6780
|
};
|
6781
|
+
type UpdateCompositionInternalMessage = {
|
6782
|
+
type: 'update-composition-internal';
|
6783
|
+
composition: RootComponentInstance;
|
6784
|
+
hash: number | undefined;
|
6785
|
+
};
|
5643
6786
|
type AddComponentMessage = {
|
5644
6787
|
type: 'add-component';
|
5645
6788
|
parentId: string;
|
@@ -5653,6 +6796,12 @@ type MoveComponentMessage = {
|
|
5653
6796
|
index: number;
|
5654
6797
|
direction: 'up' | 'down';
|
5655
6798
|
};
|
6799
|
+
type UpdateComponentParameterMessage = {
|
6800
|
+
type: 'update-component-parameter';
|
6801
|
+
componentId: string;
|
6802
|
+
parameterId: string;
|
6803
|
+
value: string | number | undefined;
|
6804
|
+
};
|
5656
6805
|
type DismissPlaceholderMessage = {
|
5657
6806
|
type: 'dismiss-placeholder';
|
5658
6807
|
parentId: string;
|
@@ -5667,12 +6816,14 @@ type ReportRenderedCompositionsMessage = {
|
|
5667
6816
|
compositionIds: string[];
|
5668
6817
|
url: string;
|
5669
6818
|
};
|
5670
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
|
6819
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | DismissPlaceholderMessage;
|
5671
6820
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
5672
6821
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
5673
6822
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
6823
|
+
declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
|
5674
6824
|
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
5675
6825
|
declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
|
6826
|
+
declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => message is UpdateComponentParameterMessage;
|
5676
6827
|
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
5677
6828
|
declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
|
5678
6829
|
declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
|
@@ -5682,9 +6833,11 @@ type Channel = {
|
|
5682
6833
|
ready: () => void;
|
5683
6834
|
destroy: () => void;
|
5684
6835
|
selectComponent: (id: string) => void;
|
5685
|
-
updateComposition: (
|
6836
|
+
updateComposition: (composition: RootComponentInstance, secret?: string) => void;
|
6837
|
+
updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
|
5686
6838
|
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
5687
6839
|
moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
|
6840
|
+
updateComponentParameter: (options: Omit<UpdateComponentParameterMessage, 'type'>) => void;
|
5688
6841
|
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
5689
6842
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
5690
6843
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
@@ -5735,6 +6888,22 @@ type UnsubscribeCallback = () => void;
|
|
5735
6888
|
/** Subscribes to a composition event */
|
5736
6889
|
declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { subscribe }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;
|
5737
6890
|
|
6891
|
+
type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
|
6892
|
+
edgeApiHost?: string;
|
6893
|
+
};
|
6894
|
+
/** A route API response with edgehancer composition result */
|
6895
|
+
type ResolvedRouteGetResponse = RouteGetResponseNotFound | RouteGetResponseRedirect | RouteGetResponseEdgehancedComposition;
|
6896
|
+
/**
|
6897
|
+
* Resolves a route using Uniform Project Map and Uniform Redirects,
|
6898
|
+
* returning a composition, redirection, or not found result.
|
6899
|
+
*/
|
6900
|
+
declare class unstable_RouteClient extends ApiClient<RouteClientOptions> {
|
6901
|
+
private edgeApiHost;
|
6902
|
+
constructor(options: RouteClientOptions);
|
6903
|
+
/** Fetches lists of Canvas compositions, optionally by type */
|
6904
|
+
getRoute(options?: Omit<RouteGetParameters, 'projectId'>): Promise<ResolvedRouteGetResponse>;
|
6905
|
+
}
|
6906
|
+
|
5738
6907
|
/** Public ID of Canvas personalization component type */
|
5739
6908
|
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
5740
6909
|
/** Public ID of Canvas A/B test component type */
|
@@ -5769,6 +6938,11 @@ declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start"
|
|
5769
6938
|
declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
|
5770
6939
|
/** The ID of the Contextual Editing script that gets embedded in frontend apps */
|
5771
6940
|
declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
|
6941
|
+
/**
|
6942
|
+
* The name of the attribute added to the elements rendered by Uniform.
|
6943
|
+
* Use to allow interacting with them by default in the preview panel
|
6944
|
+
*/
|
6945
|
+
declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
|
5772
6946
|
/** The ID we give to placeholder components */
|
5773
6947
|
declare const PLACEHOLDER_ID = "placeholder";
|
5774
6948
|
/** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
|
@@ -5805,7 +6979,7 @@ declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
|
|
5805
6979
|
*/
|
5806
6980
|
declare const createUniformApiEnhancer: ({ apiUrl }: {
|
5807
6981
|
apiUrl: string;
|
5808
|
-
}) => (message: UpdateCompositionMessage) => Promise<{
|
6982
|
+
}) => (message: Pick<UpdateCompositionMessage, 'composition' | 'hash'>) => Promise<{
|
5809
6983
|
type: string;
|
5810
6984
|
parameters?: {
|
5811
6985
|
[key: string]: {
|
@@ -5944,4 +7118,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
5944
7118
|
|
5945
7119
|
declare const CanvasClientError: typeof ApiClientError;
|
5946
7120
|
|
5947
|
-
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions,
|
7121
|
+
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
|