@uniformdev/canvas 19.45.0 → 19.45.2-alpha.6
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.mts +1873 -127
- package/dist/index.d.ts +1873 -127
- package/dist/index.esm.js +91 -7
- package/dist/index.js +97 -10
- package/dist/index.mjs +91 -7
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
@@ -6,13 +6,13 @@ import { Options } from 'p-throttle';
|
|
6
6
|
import { SerializedEditorState } from 'lexical';
|
7
7
|
import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
|
8
8
|
|
9
|
-
interface components$
|
9
|
+
interface components$5 {
|
10
10
|
schemas: {
|
11
11
|
/** @description Public ID (used in code). Do not change after creation. */
|
12
12
|
PublicIdProperty: string;
|
13
13
|
/** @description The definition of a component parameter */
|
14
14
|
ComponentDefinitionParameter: {
|
15
|
-
id: components$
|
15
|
+
id: components$5["schemas"]["PublicIdProperty"];
|
16
16
|
/** @description Friendly name of the parameter */
|
17
17
|
name: string;
|
18
18
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -24,7 +24,7 @@ interface components$4 {
|
|
24
24
|
};
|
25
25
|
/** @description The definition of a named component slot that can contain other components */
|
26
26
|
ComponentDefinitionSlot: {
|
27
|
-
id: components$
|
27
|
+
id: components$5["schemas"]["PublicIdProperty"];
|
28
28
|
/** @description Friendly name of the slot */
|
29
29
|
name: string;
|
30
30
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -82,13 +82,13 @@ interface components$4 {
|
|
82
82
|
};
|
83
83
|
/** @description The definition of a component variant */
|
84
84
|
ComponentDefinitionVariant: {
|
85
|
-
id: components$
|
85
|
+
id: components$5["schemas"]["PublicIdProperty"];
|
86
86
|
/** @description Friendly name of the variant */
|
87
87
|
name: string;
|
88
88
|
};
|
89
89
|
/** @description Permission set for a component defintion */
|
90
90
|
ComponentDefinitionPermission: {
|
91
|
-
roleId: components$
|
91
|
+
roleId: components$5["schemas"]["PublicIdProperty"];
|
92
92
|
/**
|
93
93
|
* @description Permission type for this permission ComponentDefinition:
|
94
94
|
* read | write | create | delete
|
@@ -101,7 +101,7 @@ interface components$4 {
|
|
101
101
|
};
|
102
102
|
/** @description Defines a component type that can live on a Composition */
|
103
103
|
ComponentDefinition: {
|
104
|
-
id: components$
|
104
|
+
id: components$5["schemas"]["PublicIdProperty"];
|
105
105
|
/** @description Friendly name of the component definition */
|
106
106
|
name: string;
|
107
107
|
/**
|
@@ -122,7 +122,7 @@ interface components$4 {
|
|
122
122
|
*/
|
123
123
|
canBeComposition?: boolean;
|
124
124
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
125
|
-
parameters?: components$
|
125
|
+
parameters?: components$5["schemas"]["ComponentDefinitionParameter"][];
|
126
126
|
/**
|
127
127
|
* Format: uuid
|
128
128
|
* @description Reference to the category this component definition belongs to
|
@@ -145,14 +145,14 @@ interface components$4 {
|
|
145
145
|
*/
|
146
146
|
useTeamPermissions?: boolean;
|
147
147
|
/** @description Custom role permissions for this component definition */
|
148
|
-
permissions?: components$
|
148
|
+
permissions?: components$5["schemas"]["ComponentDefinitionPermission"][];
|
149
149
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
150
|
-
slots?: components$
|
151
|
-
slugSettings?: components$
|
150
|
+
slots?: components$5["schemas"]["ComponentDefinitionSlot"][];
|
151
|
+
slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
|
152
152
|
/** @description Default component instance value */
|
153
|
-
defaults?: components$
|
153
|
+
defaults?: components$5["schemas"]["ComponentInstance"] | null;
|
154
154
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
155
|
-
variants?: components$
|
155
|
+
variants?: components$5["schemas"]["ComponentDefinitionVariant"][];
|
156
156
|
/** @description Created date string for this definition (ignored for writes) */
|
157
157
|
created?: string;
|
158
158
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -160,7 +160,7 @@ interface components$4 {
|
|
160
160
|
};
|
161
161
|
/** @description Defines a content type */
|
162
162
|
ContentType: {
|
163
|
-
id: components$
|
163
|
+
id: components$5["schemas"]["PublicIdProperty"];
|
164
164
|
/** @description Friendly name of the content type */
|
165
165
|
name: string;
|
166
166
|
/**
|
@@ -169,7 +169,7 @@ interface components$4 {
|
|
169
169
|
*/
|
170
170
|
entryName?: string | null;
|
171
171
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
172
|
-
fields?: components$
|
172
|
+
fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
|
173
173
|
/** @description Created date string for this content type (ignored for writes) */
|
174
174
|
created?: string;
|
175
175
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -182,7 +182,7 @@ interface components$4 {
|
|
182
182
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
183
183
|
type: string;
|
184
184
|
/** @deprecated */
|
185
|
-
connectedData?: components$
|
185
|
+
connectedData?: components$5["schemas"]["DataElementConnectionDefinition"];
|
186
186
|
};
|
187
187
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
188
188
|
DataElementConnectionDefinition: {
|
@@ -200,13 +200,13 @@ interface components$4 {
|
|
200
200
|
type: string;
|
201
201
|
/** @description Component parameter values for the component instance */
|
202
202
|
parameters?: {
|
203
|
-
[key: string]: components$
|
203
|
+
[key: string]: components$5["schemas"]["ComponentParameter"];
|
204
204
|
};
|
205
205
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
206
206
|
variant?: string;
|
207
207
|
/** @description Slots containing any child components */
|
208
208
|
slots?: {
|
209
|
-
[key: string]: components$
|
209
|
+
[key: string]: components$5["schemas"]["ComponentInstance"][];
|
210
210
|
};
|
211
211
|
/**
|
212
212
|
* @description Unique identifier of the component within the composition.
|
@@ -217,13 +217,13 @@ interface components$4 {
|
|
217
217
|
_id?: string;
|
218
218
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
219
219
|
_pattern?: string;
|
220
|
-
_dataResources?: components$
|
220
|
+
_dataResources?: components$5["schemas"]["DataResourceDefinitions"];
|
221
221
|
/**
|
222
222
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
223
223
|
* Means nothing for PUTs; it will be ignored.
|
224
224
|
*/
|
225
225
|
_patternDataResources?: {
|
226
|
-
[key: string]: components$
|
226
|
+
[key: string]: components$5["schemas"]["DataResourceDefinition"];
|
227
227
|
};
|
228
228
|
/**
|
229
229
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -247,7 +247,7 @@ interface components$4 {
|
|
247
247
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
248
248
|
*/
|
249
249
|
_overrides?: {
|
250
|
-
[key: string]: components$
|
250
|
+
[key: string]: components$5["schemas"]["ComponentOverride"];
|
251
251
|
};
|
252
252
|
/**
|
253
253
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -256,7 +256,7 @@ interface components$4 {
|
|
256
256
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
257
257
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
258
258
|
*/
|
259
|
-
_overridability?: components$
|
259
|
+
_overridability?: components$5["schemas"]["ComponentOverridability"];
|
260
260
|
};
|
261
261
|
/** @description Defines the shape of the root component in a composition */
|
262
262
|
RootComponentInstance: {
|
@@ -264,15 +264,15 @@ interface components$4 {
|
|
264
264
|
type: string;
|
265
265
|
/** @description Component parameter values for the component instance */
|
266
266
|
parameters?: {
|
267
|
-
[key: string]: components$
|
267
|
+
[key: string]: components$5["schemas"]["ComponentParameter"];
|
268
268
|
};
|
269
269
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
270
270
|
variant?: string;
|
271
271
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
272
|
-
projectMapNodes?: components$
|
272
|
+
projectMapNodes?: components$5["schemas"]["CompositionProjectMapNodeInfo"][];
|
273
273
|
/** @description Slots containing any child components */
|
274
274
|
slots?: {
|
275
|
-
[key: string]: components$
|
275
|
+
[key: string]: components$5["schemas"]["ComponentInstance"][];
|
276
276
|
};
|
277
277
|
/** @description The public UUID of the composition. */
|
278
278
|
_id: string;
|
@@ -280,7 +280,7 @@ interface components$4 {
|
|
280
280
|
_slug?: string | null;
|
281
281
|
/** @description Friendly name of this component. */
|
282
282
|
_name: string;
|
283
|
-
_dataResources?: components$
|
283
|
+
_dataResources?: components$5["schemas"]["DataResourceDefinitions"];
|
284
284
|
/**
|
285
285
|
* @description Defines patch overrides to component IDs that live in the composition.
|
286
286
|
* This can be used to override parameters that are defined on patterns,
|
@@ -294,7 +294,7 @@ interface components$4 {
|
|
294
294
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
295
295
|
*/
|
296
296
|
_overrides?: {
|
297
|
-
[key: string]: components$
|
297
|
+
[key: string]: components$5["schemas"]["ComponentOverride"];
|
298
298
|
};
|
299
299
|
/**
|
300
300
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -303,7 +303,7 @@ interface components$4 {
|
|
303
303
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
304
304
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
305
305
|
*/
|
306
|
-
_overridability?: components$
|
306
|
+
_overridability?: components$5["schemas"]["ComponentOverridability"];
|
307
307
|
};
|
308
308
|
/**
|
309
309
|
* @description Defines how to override a specific component.
|
@@ -313,7 +313,7 @@ interface components$4 {
|
|
313
313
|
*/
|
314
314
|
ComponentOverride: {
|
315
315
|
parameters?: {
|
316
|
-
[key: string]: components$
|
316
|
+
[key: string]: components$5["schemas"]["ComponentParameter"];
|
317
317
|
};
|
318
318
|
variant?: string;
|
319
319
|
};
|
@@ -327,7 +327,7 @@ interface components$4 {
|
|
327
327
|
ComponentOverridability: {
|
328
328
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
329
329
|
parameters?: {
|
330
|
-
[key: string]: components$
|
330
|
+
[key: string]: components$5["schemas"]["OverrideOptions"];
|
331
331
|
};
|
332
332
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
333
333
|
variants?: boolean;
|
@@ -368,7 +368,7 @@ interface components$4 {
|
|
368
368
|
}[];
|
369
369
|
/** @description Variables needed to make calls to the data source */
|
370
370
|
variables?: {
|
371
|
-
[key: string]: components$
|
371
|
+
[key: string]: components$5["schemas"]["DataVariableDefinition"];
|
372
372
|
};
|
373
373
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
374
374
|
custom?: {
|
@@ -427,7 +427,7 @@ interface components$4 {
|
|
427
427
|
method: "GET" | "POST" | "HEAD";
|
428
428
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
429
429
|
variables?: {
|
430
|
-
[key: string]: components$
|
430
|
+
[key: string]: components$5["schemas"]["DataVariableDefinition"];
|
431
431
|
};
|
432
432
|
/** @description Custom configuration specific to the data source being defined */
|
433
433
|
custom?: {
|
@@ -460,7 +460,7 @@ interface components$4 {
|
|
460
460
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
461
461
|
*/
|
462
462
|
DataResourceDefinitions: {
|
463
|
-
[key: string]: components$
|
463
|
+
[key: string]: components$5["schemas"]["DataResourceDefinition"];
|
464
464
|
};
|
465
465
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
466
466
|
DataResourceDefinition: {
|
@@ -474,7 +474,7 @@ interface components$4 {
|
|
474
474
|
* If isPatternParameter is false or undefined, this has no meaning.
|
475
475
|
*/
|
476
476
|
ignorePatternParameterDefault?: boolean;
|
477
|
-
variables?: components$
|
477
|
+
variables?: components$5["schemas"]["DataResourceVariables"];
|
478
478
|
};
|
479
479
|
/** @description Variable values for a data resource. */
|
480
480
|
DataResourceVariables: {
|
@@ -517,7 +517,7 @@ interface components$4 {
|
|
517
517
|
* This file was auto-generated by openapi-typescript.
|
518
518
|
* Do not make direct changes to the file.
|
519
519
|
*/
|
520
|
-
interface paths$
|
520
|
+
interface paths$b {
|
521
521
|
"/api/v1/canvas-definitions": {
|
522
522
|
get: {
|
523
523
|
parameters: {
|
@@ -542,15 +542,15 @@ interface paths$9 {
|
|
542
542
|
content: {
|
543
543
|
"application/json": {
|
544
544
|
/** @description Component definitions that match the query */
|
545
|
-
componentDefinitions: external$
|
545
|
+
componentDefinitions: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
546
546
|
};
|
547
547
|
};
|
548
548
|
};
|
549
|
-
400: external$
|
550
|
-
401: external$
|
551
|
-
403: external$
|
552
|
-
429: external$
|
553
|
-
500: external$
|
549
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
550
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
551
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
552
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
553
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
554
554
|
};
|
555
555
|
};
|
556
556
|
/** Upserts a component definition */
|
@@ -558,11 +558,11 @@ interface paths$9 {
|
|
558
558
|
responses: {
|
559
559
|
/** OK */
|
560
560
|
204: never;
|
561
|
-
400: external$
|
562
|
-
401: external$
|
563
|
-
403: external$
|
564
|
-
429: external$
|
565
|
-
500: external$
|
561
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
562
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
563
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
564
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
565
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
566
566
|
};
|
567
567
|
requestBody: {
|
568
568
|
content: {
|
@@ -572,7 +572,7 @@ interface paths$9 {
|
|
572
572
|
* @description The project ID to upsert the component definition to
|
573
573
|
*/
|
574
574
|
projectId: string;
|
575
|
-
componentDefinition: external$
|
575
|
+
componentDefinition: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
576
576
|
};
|
577
577
|
};
|
578
578
|
};
|
@@ -582,11 +582,11 @@ interface paths$9 {
|
|
582
582
|
responses: {
|
583
583
|
/** OK */
|
584
584
|
204: never;
|
585
|
-
400: external$
|
586
|
-
401: external$
|
587
|
-
403: external$
|
588
|
-
429: external$
|
589
|
-
500: external$
|
585
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
586
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
587
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
588
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
589
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
590
590
|
};
|
591
591
|
requestBody: {
|
592
592
|
content: {
|
@@ -611,7 +611,7 @@ interface paths$9 {
|
|
611
611
|
};
|
612
612
|
};
|
613
613
|
}
|
614
|
-
interface external$
|
614
|
+
interface external$c {
|
615
615
|
"swagger.yml": {
|
616
616
|
paths: {};
|
617
617
|
components: {
|
@@ -625,25 +625,25 @@ interface external$a {
|
|
625
625
|
/** Request input validation failed */
|
626
626
|
BadRequestError: {
|
627
627
|
content: {
|
628
|
-
"application/json": external$
|
628
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
629
629
|
};
|
630
630
|
};
|
631
631
|
/** API key or token was not valid */
|
632
632
|
UnauthorizedError: {
|
633
633
|
content: {
|
634
|
-
"application/json": external$
|
634
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
635
635
|
};
|
636
636
|
};
|
637
637
|
/** Permission was denied */
|
638
638
|
ForbiddenError: {
|
639
639
|
content: {
|
640
|
-
"application/json": external$
|
640
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
641
641
|
};
|
642
642
|
};
|
643
643
|
/** Resource not found */
|
644
644
|
NotFoundError: {
|
645
645
|
content: {
|
646
|
-
"application/json": external$
|
646
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
647
647
|
};
|
648
648
|
};
|
649
649
|
/** Too many requests in allowed time period */
|
@@ -662,7 +662,7 @@ interface external$a {
|
|
662
662
|
PublicIdProperty: string;
|
663
663
|
/** @description The definition of a component parameter */
|
664
664
|
ComponentDefinitionParameter: {
|
665
|
-
id: external$
|
665
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
666
666
|
/** @description Friendly name of the parameter */
|
667
667
|
name: string;
|
668
668
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -674,7 +674,7 @@ interface external$a {
|
|
674
674
|
};
|
675
675
|
/** @description The definition of a named component slot that can contain other components */
|
676
676
|
ComponentDefinitionSlot: {
|
677
|
-
id: external$
|
677
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
678
678
|
/** @description Friendly name of the slot */
|
679
679
|
name: string;
|
680
680
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -732,13 +732,13 @@ interface external$a {
|
|
732
732
|
};
|
733
733
|
/** @description The definition of a component variant */
|
734
734
|
ComponentDefinitionVariant: {
|
735
|
-
id: external$
|
735
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
736
736
|
/** @description Friendly name of the variant */
|
737
737
|
name: string;
|
738
738
|
};
|
739
739
|
/** @description Permission set for a component defintion */
|
740
740
|
ComponentDefinitionPermission: {
|
741
|
-
roleId: external$
|
741
|
+
roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
742
742
|
/**
|
743
743
|
* @description Permission type for this permission ComponentDefinition:
|
744
744
|
* read | write | create | delete
|
@@ -751,7 +751,7 @@ interface external$a {
|
|
751
751
|
};
|
752
752
|
/** @description Defines a component type that can live on a Composition */
|
753
753
|
ComponentDefinition: {
|
754
|
-
id: external$
|
754
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
755
755
|
/** @description Friendly name of the component definition */
|
756
756
|
name: string;
|
757
757
|
/**
|
@@ -772,7 +772,7 @@ interface external$a {
|
|
772
772
|
*/
|
773
773
|
canBeComposition?: boolean;
|
774
774
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
775
|
-
parameters?: external$
|
775
|
+
parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
776
776
|
/**
|
777
777
|
* Format: uuid
|
778
778
|
* @description Reference to the category this component definition belongs to
|
@@ -795,14 +795,14 @@ interface external$a {
|
|
795
795
|
*/
|
796
796
|
useTeamPermissions?: boolean;
|
797
797
|
/** @description Custom role permissions for this component definition */
|
798
|
-
permissions?: external$
|
798
|
+
permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
799
799
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
800
|
-
slots?: external$
|
801
|
-
slugSettings?: external$
|
800
|
+
slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
801
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
802
802
|
/** @description Default component instance value */
|
803
|
-
defaults?: external$
|
803
|
+
defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
804
804
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
805
|
-
variants?: external$
|
805
|
+
variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
806
806
|
/** @description Created date string for this definition (ignored for writes) */
|
807
807
|
created?: string;
|
808
808
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -810,7 +810,7 @@ interface external$a {
|
|
810
810
|
};
|
811
811
|
/** @description Defines a content type */
|
812
812
|
ContentType: {
|
813
|
-
id: external$
|
813
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
814
814
|
/** @description Friendly name of the content type */
|
815
815
|
name: string;
|
816
816
|
/**
|
@@ -819,7 +819,7 @@ interface external$a {
|
|
819
819
|
*/
|
820
820
|
entryName?: string | null;
|
821
821
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
822
|
-
fields?: external$
|
822
|
+
fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
823
823
|
/** @description Created date string for this content type (ignored for writes) */
|
824
824
|
created?: string;
|
825
825
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -832,7 +832,7 @@ interface external$a {
|
|
832
832
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
833
833
|
type: string;
|
834
834
|
/** @deprecated */
|
835
|
-
connectedData?: external$
|
835
|
+
connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
836
836
|
};
|
837
837
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
838
838
|
DataElementConnectionDefinition: {
|
@@ -850,13 +850,13 @@ interface external$a {
|
|
850
850
|
type: string;
|
851
851
|
/** @description Component parameter values for the component instance */
|
852
852
|
parameters?: {
|
853
|
-
[key: string]: external$
|
853
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
854
854
|
};
|
855
855
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
856
856
|
variant?: string;
|
857
857
|
/** @description Slots containing any child components */
|
858
858
|
slots?: {
|
859
|
-
[key: string]: external$
|
859
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
860
860
|
};
|
861
861
|
/**
|
862
862
|
* @description Unique identifier of the component within the composition.
|
@@ -867,13 +867,13 @@ interface external$a {
|
|
867
867
|
_id?: string;
|
868
868
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
869
869
|
_pattern?: string;
|
870
|
-
_dataResources?: external$
|
870
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
871
871
|
/**
|
872
872
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
873
873
|
* Means nothing for PUTs; it will be ignored.
|
874
874
|
*/
|
875
875
|
_patternDataResources?: {
|
876
|
-
[key: string]: external$
|
876
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
877
877
|
};
|
878
878
|
/**
|
879
879
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -897,7 +897,7 @@ interface external$a {
|
|
897
897
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
898
898
|
*/
|
899
899
|
_overrides?: {
|
900
|
-
[key: string]: external$
|
900
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
901
901
|
};
|
902
902
|
/**
|
903
903
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -906,7 +906,7 @@ interface external$a {
|
|
906
906
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
907
907
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
908
908
|
*/
|
909
|
-
_overridability?: external$
|
909
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
910
910
|
};
|
911
911
|
/** @description Defines the shape of the root component in a composition */
|
912
912
|
RootComponentInstance: {
|
@@ -914,15 +914,15 @@ interface external$a {
|
|
914
914
|
type: string;
|
915
915
|
/** @description Component parameter values for the component instance */
|
916
916
|
parameters?: {
|
917
|
-
[key: string]: external$
|
917
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
918
918
|
};
|
919
919
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
920
920
|
variant?: string;
|
921
921
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
922
|
-
projectMapNodes?: external$
|
922
|
+
projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
923
923
|
/** @description Slots containing any child components */
|
924
924
|
slots?: {
|
925
|
-
[key: string]: external$
|
925
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
926
926
|
};
|
927
927
|
/** @description The public UUID of the composition. */
|
928
928
|
_id: string;
|
@@ -930,7 +930,7 @@ interface external$a {
|
|
930
930
|
_slug?: string | null;
|
931
931
|
/** @description Friendly name of this component. */
|
932
932
|
_name: string;
|
933
|
-
_dataResources?: external$
|
933
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
934
934
|
/**
|
935
935
|
* @description Defines patch overrides to component IDs that live in the composition.
|
936
936
|
* This can be used to override parameters that are defined on patterns,
|
@@ -944,7 +944,7 @@ interface external$a {
|
|
944
944
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
945
945
|
*/
|
946
946
|
_overrides?: {
|
947
|
-
[key: string]: external$
|
947
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
948
948
|
};
|
949
949
|
/**
|
950
950
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -953,7 +953,7 @@ interface external$a {
|
|
953
953
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
954
954
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
955
955
|
*/
|
956
|
-
_overridability?: external$
|
956
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
957
957
|
};
|
958
958
|
/**
|
959
959
|
* @description Defines how to override a specific component.
|
@@ -963,7 +963,7 @@ interface external$a {
|
|
963
963
|
*/
|
964
964
|
ComponentOverride: {
|
965
965
|
parameters?: {
|
966
|
-
[key: string]: external$
|
966
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
967
967
|
};
|
968
968
|
variant?: string;
|
969
969
|
};
|
@@ -977,7 +977,7 @@ interface external$a {
|
|
977
977
|
ComponentOverridability: {
|
978
978
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
979
979
|
parameters?: {
|
980
|
-
[key: string]: external$
|
980
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
981
981
|
};
|
982
982
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
983
983
|
variants?: boolean;
|
@@ -1018,7 +1018,7 @@ interface external$a {
|
|
1018
1018
|
}[];
|
1019
1019
|
/** @description Variables needed to make calls to the data source */
|
1020
1020
|
variables?: {
|
1021
|
-
[key: string]: external$
|
1021
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1022
1022
|
};
|
1023
1023
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1024
1024
|
custom?: {
|
@@ -1077,7 +1077,7 @@ interface external$a {
|
|
1077
1077
|
method: "GET" | "POST" | "HEAD";
|
1078
1078
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1079
1079
|
variables?: {
|
1080
|
-
[key: string]: external$
|
1080
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1081
1081
|
};
|
1082
1082
|
/** @description Custom configuration specific to the data source being defined */
|
1083
1083
|
custom?: {
|
@@ -1110,7 +1110,7 @@ interface external$a {
|
|
1110
1110
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1111
1111
|
*/
|
1112
1112
|
DataResourceDefinitions: {
|
1113
|
-
[key: string]: external$
|
1113
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1114
1114
|
};
|
1115
1115
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1116
1116
|
DataResourceDefinition: {
|
@@ -1124,7 +1124,7 @@ interface external$a {
|
|
1124
1124
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1125
1125
|
*/
|
1126
1126
|
ignorePatternParameterDefault?: boolean;
|
1127
|
-
variables?: external$
|
1127
|
+
variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1128
1128
|
};
|
1129
1129
|
/** @description Variable values for a data resource. */
|
1130
1130
|
DataResourceVariables: {
|
@@ -1166,8 +1166,8 @@ interface external$a {
|
|
1166
1166
|
};
|
1167
1167
|
}
|
1168
1168
|
|
1169
|
-
type SharedComponents$2 = components$
|
1170
|
-
type Api$2 = paths$
|
1169
|
+
type SharedComponents$2 = components$5['schemas'];
|
1170
|
+
type Api$2 = paths$b['/api/v1/canvas-definitions'];
|
1171
1171
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1172
1172
|
type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
1173
1173
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1177,7 +1177,7 @@ type ComponentDefinitionDeleteParameters = Api$2['delete']['requestBody']['conte
|
|
1177
1177
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1178
1178
|
type ComponentDefinitionGetParameters = Api$2['get']['parameters']['query'];
|
1179
1179
|
/** The definition of a component parameter */
|
1180
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
1180
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$5['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1181
1181
|
typeConfig?: TConfig;
|
1182
1182
|
};
|
1183
1183
|
/** The definition of a component visual variant */
|
@@ -1195,7 +1195,7 @@ type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
|
|
1195
1195
|
* This file was auto-generated by openapi-typescript.
|
1196
1196
|
* Do not make direct changes to the file.
|
1197
1197
|
*/
|
1198
|
-
interface paths$
|
1198
|
+
interface paths$a {
|
1199
1199
|
"/api/v1/categories": {
|
1200
1200
|
get: {
|
1201
1201
|
parameters: {
|
@@ -1208,33 +1208,33 @@ interface paths$8 {
|
|
1208
1208
|
200: {
|
1209
1209
|
content: {
|
1210
1210
|
"application/json": {
|
1211
|
-
categories: external$
|
1211
|
+
categories: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1212
1212
|
};
|
1213
1213
|
};
|
1214
1214
|
};
|
1215
|
-
400: external$
|
1216
|
-
401: external$
|
1217
|
-
403: external$
|
1218
|
-
429: external$
|
1219
|
-
500: external$
|
1215
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1216
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1217
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1218
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1219
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1220
1220
|
};
|
1221
1221
|
};
|
1222
1222
|
put: {
|
1223
1223
|
responses: {
|
1224
1224
|
/** OK */
|
1225
1225
|
204: never;
|
1226
|
-
400: external$
|
1227
|
-
401: external$
|
1228
|
-
403: external$
|
1229
|
-
429: external$
|
1230
|
-
500: external$
|
1226
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1227
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1228
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1229
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1230
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1231
1231
|
};
|
1232
1232
|
requestBody: {
|
1233
1233
|
content: {
|
1234
1234
|
"application/json": {
|
1235
1235
|
/** Format: uuid */
|
1236
1236
|
projectId: string;
|
1237
|
-
categories: external$
|
1237
|
+
categories: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1238
1238
|
};
|
1239
1239
|
};
|
1240
1240
|
};
|
@@ -1243,11 +1243,11 @@ interface paths$8 {
|
|
1243
1243
|
responses: {
|
1244
1244
|
/** OK */
|
1245
1245
|
204: never;
|
1246
|
-
400: external$
|
1247
|
-
401: external$
|
1248
|
-
403: external$
|
1249
|
-
429: external$
|
1250
|
-
500: external$
|
1246
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1247
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1248
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1249
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1250
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1251
1251
|
};
|
1252
1252
|
requestBody: {
|
1253
1253
|
content: {
|
@@ -1262,6 +1262,1462 @@ interface paths$8 {
|
|
1262
1262
|
};
|
1263
1263
|
};
|
1264
1264
|
}
|
1265
|
+
interface external$b {
|
1266
|
+
"swagger.yml": {
|
1267
|
+
paths: {};
|
1268
|
+
components: {
|
1269
|
+
schemas: {
|
1270
|
+
Error: {
|
1271
|
+
/** @description Error message(s) that occurred while processing the request */
|
1272
|
+
errorMessage?: string[] | string;
|
1273
|
+
};
|
1274
|
+
};
|
1275
|
+
responses: {
|
1276
|
+
/** Request input validation failed */
|
1277
|
+
BadRequestError: {
|
1278
|
+
content: {
|
1279
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
1280
|
+
};
|
1281
|
+
};
|
1282
|
+
/** API key or token was not valid */
|
1283
|
+
UnauthorizedError: {
|
1284
|
+
content: {
|
1285
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
1286
|
+
};
|
1287
|
+
};
|
1288
|
+
/** Permission was denied */
|
1289
|
+
ForbiddenError: {
|
1290
|
+
content: {
|
1291
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
1292
|
+
};
|
1293
|
+
};
|
1294
|
+
/** Resource not found */
|
1295
|
+
NotFoundError: {
|
1296
|
+
content: {
|
1297
|
+
"application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
|
1298
|
+
};
|
1299
|
+
};
|
1300
|
+
/** Too many requests in allowed time period */
|
1301
|
+
RateLimitError: unknown;
|
1302
|
+
/** Execution error occurred */
|
1303
|
+
InternalServerError: unknown;
|
1304
|
+
};
|
1305
|
+
};
|
1306
|
+
operations: {};
|
1307
|
+
};
|
1308
|
+
"uniform-canvas-types.swagger.yml": {
|
1309
|
+
paths: {};
|
1310
|
+
components: {
|
1311
|
+
schemas: {
|
1312
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
1313
|
+
PublicIdProperty: string;
|
1314
|
+
/** @description The definition of a component parameter */
|
1315
|
+
ComponentDefinitionParameter: {
|
1316
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1317
|
+
/** @description Friendly name of the parameter */
|
1318
|
+
name: string;
|
1319
|
+
/** @description Appears next to the parameter in the Composition editor */
|
1320
|
+
helpText?: string;
|
1321
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
1322
|
+
type: string;
|
1323
|
+
/** @description The configuration object for the type (type-specific) */
|
1324
|
+
typeConfig?: unknown;
|
1325
|
+
};
|
1326
|
+
/** @description The definition of a named component slot that can contain other components */
|
1327
|
+
ComponentDefinitionSlot: {
|
1328
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1329
|
+
/** @description Friendly name of the slot */
|
1330
|
+
name: string;
|
1331
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
1332
|
+
allowedComponents: string[];
|
1333
|
+
/**
|
1334
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
1335
|
+
* If allowAllComponents is true, this value is ignored.
|
1336
|
+
*
|
1337
|
+
* @default false
|
1338
|
+
*/
|
1339
|
+
inheritAllowedComponents: boolean;
|
1340
|
+
/**
|
1341
|
+
* @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.
|
1342
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
1343
|
+
*/
|
1344
|
+
allowAllComponents?: boolean;
|
1345
|
+
/**
|
1346
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
1347
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
1348
|
+
*/
|
1349
|
+
patternsInAllowedComponents?: boolean;
|
1350
|
+
/** @description Minimum valid number of components in this slot */
|
1351
|
+
minComponents?: number;
|
1352
|
+
/** @description Maximum valid number of components in this slot */
|
1353
|
+
maxComponents?: number;
|
1354
|
+
};
|
1355
|
+
/** @description The definition of a composition's slug settings */
|
1356
|
+
ComponentDefinitionSlugSettings: {
|
1357
|
+
/**
|
1358
|
+
* @description Whether the slug is required
|
1359
|
+
* no: slug is optional
|
1360
|
+
* yes: slug is required
|
1361
|
+
* disabled: slug is disabled and will not be shown in the editor
|
1362
|
+
*
|
1363
|
+
* @default no
|
1364
|
+
* @enum {string}
|
1365
|
+
*/
|
1366
|
+
required?: "no" | "yes" | "disabled";
|
1367
|
+
/**
|
1368
|
+
* @description Slug uniqueness configuration.
|
1369
|
+
* no = no unique constraint
|
1370
|
+
* local = must be unique within this component type
|
1371
|
+
* global = must be unique across all component types
|
1372
|
+
*
|
1373
|
+
* @enum {string}
|
1374
|
+
*/
|
1375
|
+
unique?: "no" | "local" | "global";
|
1376
|
+
/** @description Regular expression slugs must match */
|
1377
|
+
regularExpression?: string;
|
1378
|
+
/**
|
1379
|
+
* @description Custom error message when regular expression validation fails.
|
1380
|
+
* Has no effect if `regularExpression` is not set.
|
1381
|
+
*/
|
1382
|
+
regularExpressionMessage?: string;
|
1383
|
+
};
|
1384
|
+
/** @description The definition of a component variant */
|
1385
|
+
ComponentDefinitionVariant: {
|
1386
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1387
|
+
/** @description Friendly name of the variant */
|
1388
|
+
name: string;
|
1389
|
+
};
|
1390
|
+
/** @description Permission set for a component defintion */
|
1391
|
+
ComponentDefinitionPermission: {
|
1392
|
+
roleId: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1393
|
+
/**
|
1394
|
+
* @description Permission type for this permission ComponentDefinition:
|
1395
|
+
* read | write | create | delete
|
1396
|
+
*
|
1397
|
+
* @enum {string}
|
1398
|
+
*/
|
1399
|
+
permission: "read" | "write" | "create" | "delete";
|
1400
|
+
/** @description State of the component that this permission applies to */
|
1401
|
+
state: number;
|
1402
|
+
};
|
1403
|
+
/** @description Defines a component type that can live on a Composition */
|
1404
|
+
ComponentDefinition: {
|
1405
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1406
|
+
/** @description Friendly name of the component definition */
|
1407
|
+
name: string;
|
1408
|
+
/**
|
1409
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
1410
|
+
* @default screen
|
1411
|
+
*/
|
1412
|
+
icon?: string;
|
1413
|
+
/**
|
1414
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
1415
|
+
* The parameter type must support being used as a title parameter for this to work.
|
1416
|
+
*
|
1417
|
+
* @default null
|
1418
|
+
*/
|
1419
|
+
titleParameter?: string | null;
|
1420
|
+
/**
|
1421
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
1422
|
+
* @default false
|
1423
|
+
*/
|
1424
|
+
canBeComposition?: boolean;
|
1425
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1426
|
+
parameters?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1427
|
+
/**
|
1428
|
+
* Format: uuid
|
1429
|
+
* @description Reference to the category this component definition belongs to
|
1430
|
+
* @default null
|
1431
|
+
*/
|
1432
|
+
categoryId?: string | null;
|
1433
|
+
/**
|
1434
|
+
* @description Description of the component definition
|
1435
|
+
* @default null
|
1436
|
+
*/
|
1437
|
+
description?: string;
|
1438
|
+
/**
|
1439
|
+
* @description Description of the component definition
|
1440
|
+
* @default null
|
1441
|
+
*/
|
1442
|
+
previewImageUrl?: string;
|
1443
|
+
/**
|
1444
|
+
* @description if this component uses team permissions or custom permissions
|
1445
|
+
* @default true
|
1446
|
+
*/
|
1447
|
+
useTeamPermissions?: boolean;
|
1448
|
+
/** @description Custom role permissions for this component definition */
|
1449
|
+
permissions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1450
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1451
|
+
slots?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1452
|
+
slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1453
|
+
/** @description Default component instance value */
|
1454
|
+
defaults?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1455
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1456
|
+
variants?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1457
|
+
/** @description Created date string for this definition (ignored for writes) */
|
1458
|
+
created?: string;
|
1459
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
1460
|
+
updated?: string;
|
1461
|
+
};
|
1462
|
+
/** @description Defines a content type */
|
1463
|
+
ContentType: {
|
1464
|
+
id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1465
|
+
/** @description Friendly name of the content type */
|
1466
|
+
name: string;
|
1467
|
+
/**
|
1468
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
1469
|
+
* The field type must support being used as an entry name for this to work.
|
1470
|
+
*/
|
1471
|
+
entryName?: string | null;
|
1472
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1473
|
+
fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1474
|
+
/** @description Created date string for this content type (ignored for writes) */
|
1475
|
+
created?: string;
|
1476
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
1477
|
+
updated?: string;
|
1478
|
+
};
|
1479
|
+
/** @description Defines an editable parameter on a component. */
|
1480
|
+
ComponentParameter: {
|
1481
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
1482
|
+
value: unknown;
|
1483
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1484
|
+
type: string;
|
1485
|
+
/** @deprecated */
|
1486
|
+
connectedData?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1487
|
+
};
|
1488
|
+
/** @description Defines a connection to a dynamic token on a data resource. */
|
1489
|
+
DataElementConnectionDefinition: {
|
1490
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value. */
|
1491
|
+
pointer: string;
|
1492
|
+
/**
|
1493
|
+
* @description The syntax used to select the dynamic token to bind to
|
1494
|
+
* @enum {string}
|
1495
|
+
*/
|
1496
|
+
syntax: "jptr";
|
1497
|
+
};
|
1498
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
1499
|
+
ComponentInstance: {
|
1500
|
+
/** @description Type of the component instance (public_id of its definition) */
|
1501
|
+
type: string;
|
1502
|
+
/** @description Component parameter values for the component instance */
|
1503
|
+
parameters?: {
|
1504
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1505
|
+
};
|
1506
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1507
|
+
variant?: string;
|
1508
|
+
/** @description Slots containing any child components */
|
1509
|
+
slots?: {
|
1510
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1511
|
+
};
|
1512
|
+
/**
|
1513
|
+
* @description Unique identifier of the component within the composition.
|
1514
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
1515
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
1516
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
|
1517
|
+
*/
|
1518
|
+
_id?: string;
|
1519
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1520
|
+
_pattern?: string;
|
1521
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1522
|
+
/**
|
1523
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1524
|
+
* Means nothing for PUTs; it will be ignored.
|
1525
|
+
*/
|
1526
|
+
_patternDataResources?: {
|
1527
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1528
|
+
};
|
1529
|
+
/**
|
1530
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
1531
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
1532
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
1533
|
+
* Means nothing for PUTs; it will be ignored.
|
1534
|
+
*
|
1535
|
+
* @enum {string}
|
1536
|
+
*/
|
1537
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
1538
|
+
/**
|
1539
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1540
|
+
* This can be used to override parameters that are defined on patterns,
|
1541
|
+
* including nested patterns, with values that are specific to this composition.
|
1542
|
+
* The keys in this object are component IDs.
|
1543
|
+
* Overrides are applied from the top down, so for example if both the composition
|
1544
|
+
* and a pattern on the composition define an override on a nested pattern,
|
1545
|
+
* the composition's override replaces the pattern's.
|
1546
|
+
*
|
1547
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1548
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1549
|
+
*/
|
1550
|
+
_overrides?: {
|
1551
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1552
|
+
};
|
1553
|
+
/**
|
1554
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1555
|
+
* by consumers of the pattern.
|
1556
|
+
*
|
1557
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1558
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1559
|
+
*/
|
1560
|
+
_overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1561
|
+
};
|
1562
|
+
/** @description Defines the shape of the root component in a composition */
|
1563
|
+
RootComponentInstance: {
|
1564
|
+
/** @description Type of the component instance (public_id of its definition) */
|
1565
|
+
type: string;
|
1566
|
+
/** @description Component parameter values for the component instance */
|
1567
|
+
parameters?: {
|
1568
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1569
|
+
};
|
1570
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1571
|
+
variant?: string;
|
1572
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1573
|
+
projectMapNodes?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1574
|
+
/** @description Slots containing any child components */
|
1575
|
+
slots?: {
|
1576
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1577
|
+
};
|
1578
|
+
/** @description The public UUID of the composition. */
|
1579
|
+
_id: string;
|
1580
|
+
/** @description Slug pattern of this component. */
|
1581
|
+
_slug?: string | null;
|
1582
|
+
/** @description Friendly name of this component. */
|
1583
|
+
_name: string;
|
1584
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1585
|
+
/**
|
1586
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
1587
|
+
* This can be used to override parameters that are defined on patterns,
|
1588
|
+
* including nested patterns, with values that are specific to this composition.
|
1589
|
+
* The keys in this object are component IDs.
|
1590
|
+
* Overrides are applied from the top down, so for example if both the composition
|
1591
|
+
* and a pattern on the composition define an override on a nested pattern,
|
1592
|
+
* the composition's override replaces the pattern's.
|
1593
|
+
*
|
1594
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1595
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1596
|
+
*/
|
1597
|
+
_overrides?: {
|
1598
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1599
|
+
};
|
1600
|
+
/**
|
1601
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
1602
|
+
* by consumers of the pattern.
|
1603
|
+
*
|
1604
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1605
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1606
|
+
*/
|
1607
|
+
_overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1608
|
+
};
|
1609
|
+
/**
|
1610
|
+
* @description Defines how to override a specific component.
|
1611
|
+
*
|
1612
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1613
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1614
|
+
*/
|
1615
|
+
ComponentOverride: {
|
1616
|
+
parameters?: {
|
1617
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1618
|
+
};
|
1619
|
+
variant?: string;
|
1620
|
+
};
|
1621
|
+
/**
|
1622
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
1623
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
1624
|
+
*
|
1625
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1626
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1627
|
+
*/
|
1628
|
+
ComponentOverridability: {
|
1629
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1630
|
+
parameters?: {
|
1631
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1632
|
+
};
|
1633
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1634
|
+
variants?: boolean;
|
1635
|
+
};
|
1636
|
+
/**
|
1637
|
+
* @description Whether a parameter is overridable
|
1638
|
+
*
|
1639
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1640
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1641
|
+
*
|
1642
|
+
* @enum {string}
|
1643
|
+
*/
|
1644
|
+
OverrideOptions: "yes" | "no";
|
1645
|
+
/**
|
1646
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
1647
|
+
* These are created in the UI and shared across a whole project.
|
1648
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
1649
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
1650
|
+
*/
|
1651
|
+
DataSource: {
|
1652
|
+
/** @description Public ID of the data source */
|
1653
|
+
id: string;
|
1654
|
+
/** @description Display name of the data source */
|
1655
|
+
displayName: string;
|
1656
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
1657
|
+
connectorType: string;
|
1658
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
1659
|
+
baseUrl: string;
|
1660
|
+
/** @description HTTP headers to pass with requests to the data source */
|
1661
|
+
headers?: {
|
1662
|
+
key: string;
|
1663
|
+
value: string;
|
1664
|
+
}[];
|
1665
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1666
|
+
parameters?: {
|
1667
|
+
key: string;
|
1668
|
+
value: string;
|
1669
|
+
}[];
|
1670
|
+
/** @description Variables needed to make calls to the data source */
|
1671
|
+
variables?: {
|
1672
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1673
|
+
};
|
1674
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1675
|
+
custom?: {
|
1676
|
+
[key: string]: unknown;
|
1677
|
+
};
|
1678
|
+
};
|
1679
|
+
/** @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. */
|
1680
|
+
DataType: {
|
1681
|
+
/** @description Public ID of the data type */
|
1682
|
+
id: string;
|
1683
|
+
/** @description Display name of the data type */
|
1684
|
+
displayName: string;
|
1685
|
+
/** @description Public ID of the associated data source */
|
1686
|
+
dataSourceId: string;
|
1687
|
+
/**
|
1688
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
1689
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
1690
|
+
* no special UI or processing is required.
|
1691
|
+
*/
|
1692
|
+
archetype?: string;
|
1693
|
+
allowedOnComponents?: string[];
|
1694
|
+
/** @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. */
|
1695
|
+
path: string;
|
1696
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
1697
|
+
ttl?: number;
|
1698
|
+
/** @description Long term data resource cache configuration. */
|
1699
|
+
longTermCache?: {
|
1700
|
+
/** @description A flag to turn the long term cache on. */
|
1701
|
+
enabled: boolean;
|
1702
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
1703
|
+
ttlInHours?: number;
|
1704
|
+
};
|
1705
|
+
/** @description A key for the resource data cache purging. */
|
1706
|
+
purgeKey?: string;
|
1707
|
+
/** @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. */
|
1708
|
+
badgeIconUrl?: string;
|
1709
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
1710
|
+
headers?: {
|
1711
|
+
key: string;
|
1712
|
+
value: string;
|
1713
|
+
omitIfEmpty?: boolean;
|
1714
|
+
}[];
|
1715
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
1716
|
+
parameters?: {
|
1717
|
+
key: string;
|
1718
|
+
value: string;
|
1719
|
+
omitIfEmpty?: boolean;
|
1720
|
+
}[];
|
1721
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
1722
|
+
body?: string;
|
1723
|
+
/**
|
1724
|
+
* @description HTTP method to use with requests to the data type.
|
1725
|
+
* @default GET
|
1726
|
+
* @enum {string}
|
1727
|
+
*/
|
1728
|
+
method: "GET" | "POST" | "HEAD";
|
1729
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1730
|
+
variables?: {
|
1731
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1732
|
+
};
|
1733
|
+
/** @description Custom configuration specific to the data source being defined */
|
1734
|
+
custom?: {
|
1735
|
+
[key: string]: unknown;
|
1736
|
+
};
|
1737
|
+
};
|
1738
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
1739
|
+
DataVariableDefinition: {
|
1740
|
+
/** @description Display name of the data variable */
|
1741
|
+
displayName?: string;
|
1742
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
1743
|
+
helpText?: string;
|
1744
|
+
/**
|
1745
|
+
* @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.
|
1746
|
+
* @default text
|
1747
|
+
*/
|
1748
|
+
type?: string;
|
1749
|
+
/** @description Default value of the data variable */
|
1750
|
+
default: string;
|
1751
|
+
/** @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. */
|
1752
|
+
order?: number;
|
1753
|
+
/**
|
1754
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
1755
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
|
1756
|
+
*/
|
1757
|
+
source?: string;
|
1758
|
+
};
|
1759
|
+
/**
|
1760
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
1761
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1762
|
+
*/
|
1763
|
+
DataResourceDefinitions: {
|
1764
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1765
|
+
};
|
1766
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1767
|
+
DataResourceDefinition: {
|
1768
|
+
/** @description Public ID of the data type that provides this data */
|
1769
|
+
type: string;
|
1770
|
+
/** @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. */
|
1771
|
+
isPatternParameter?: boolean;
|
1772
|
+
/**
|
1773
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
1774
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
1775
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
1776
|
+
*/
|
1777
|
+
ignorePatternParameterDefault?: boolean;
|
1778
|
+
variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1779
|
+
};
|
1780
|
+
/** @description Variable values for a data resource. */
|
1781
|
+
DataResourceVariables: {
|
1782
|
+
[key: string]: string;
|
1783
|
+
};
|
1784
|
+
/** @description Category for tagging canvas entities */
|
1785
|
+
Category: {
|
1786
|
+
/**
|
1787
|
+
* Format: uuid
|
1788
|
+
* @description Unique identifier for the category
|
1789
|
+
*/
|
1790
|
+
id: string;
|
1791
|
+
/** @description Display name of the category */
|
1792
|
+
name: string;
|
1793
|
+
/**
|
1794
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
|
1795
|
+
* @default 0
|
1796
|
+
*/
|
1797
|
+
order?: number;
|
1798
|
+
};
|
1799
|
+
/** @description Project map node information related to a component. */
|
1800
|
+
CompositionProjectMapNodeInfo: {
|
1801
|
+
/**
|
1802
|
+
* Format: uuid
|
1803
|
+
* @description Unique identifier for the project map node
|
1804
|
+
*/
|
1805
|
+
id: string;
|
1806
|
+
/** @description Path of the project map node */
|
1807
|
+
path: string;
|
1808
|
+
/**
|
1809
|
+
* Format: uuid
|
1810
|
+
* @description Unique identifier for the project map that this node belongs to.
|
1811
|
+
*/
|
1812
|
+
projectMapId: string;
|
1813
|
+
};
|
1814
|
+
};
|
1815
|
+
};
|
1816
|
+
operations: {};
|
1817
|
+
};
|
1818
|
+
}
|
1819
|
+
|
1820
|
+
type SharedComponents$1 = components$5['schemas'];
|
1821
|
+
type Api$1 = paths$a['/api/v1/categories'];
|
1822
|
+
/** Shape of the GET response from /api/v1/category */
|
1823
|
+
type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1824
|
+
/** Shape of the PUT request body for /api/v1/category */
|
1825
|
+
type CategoriesPutParameters = Api$1['put']['requestBody']['content']['application/json'];
|
1826
|
+
/** Shape of the DELETE request body for /api/v1/category */
|
1827
|
+
type CategoriesDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
|
1828
|
+
/** Query parameter options for GET /api/v1/category */
|
1829
|
+
type CategoriesGetParameters = Api$1['get']['parameters']['query'];
|
1830
|
+
/** Defines a component type that can live on a Composition */
|
1831
|
+
type Category = SharedComponents$1['Category'];
|
1832
|
+
|
1833
|
+
/**
|
1834
|
+
* This file was auto-generated by openapi-typescript.
|
1835
|
+
* Do not make direct changes to the file.
|
1836
|
+
*/
|
1837
|
+
interface paths$9 {
|
1838
|
+
"/api/v1/content-types": {
|
1839
|
+
get: {
|
1840
|
+
parameters: {
|
1841
|
+
query: {
|
1842
|
+
/** The project ID to get content type for. */
|
1843
|
+
projectId: string;
|
1844
|
+
/** Number of records to skip */
|
1845
|
+
offset?: number;
|
1846
|
+
/** Max number of records to return */
|
1847
|
+
limit?: number;
|
1848
|
+
};
|
1849
|
+
};
|
1850
|
+
responses: {
|
1851
|
+
/** OK */
|
1852
|
+
200: {
|
1853
|
+
content: {
|
1854
|
+
"application/json": {
|
1855
|
+
/** @description Content types that match the query */
|
1856
|
+
contentTypes: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
|
1857
|
+
};
|
1858
|
+
};
|
1859
|
+
};
|
1860
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1861
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1862
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1863
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1864
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1865
|
+
};
|
1866
|
+
};
|
1867
|
+
/** Upserts a content type */
|
1868
|
+
put: {
|
1869
|
+
responses: {
|
1870
|
+
/** OK */
|
1871
|
+
204: never;
|
1872
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1873
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1874
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1875
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1876
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1877
|
+
};
|
1878
|
+
requestBody: {
|
1879
|
+
content: {
|
1880
|
+
"application/json": {
|
1881
|
+
/**
|
1882
|
+
* Format: uuid
|
1883
|
+
* @description The project ID to upsert the content type to
|
1884
|
+
*/
|
1885
|
+
projectId: string;
|
1886
|
+
contentType: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"];
|
1887
|
+
};
|
1888
|
+
};
|
1889
|
+
};
|
1890
|
+
};
|
1891
|
+
/** Deletes a content type */
|
1892
|
+
delete: {
|
1893
|
+
responses: {
|
1894
|
+
/** OK */
|
1895
|
+
204: never;
|
1896
|
+
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1897
|
+
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1898
|
+
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1899
|
+
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1900
|
+
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1901
|
+
};
|
1902
|
+
requestBody: {
|
1903
|
+
content: {
|
1904
|
+
"application/json": {
|
1905
|
+
/** @description The public ID of the content type to delete */
|
1906
|
+
contentTypeId: string;
|
1907
|
+
/**
|
1908
|
+
* Format: uuid
|
1909
|
+
* @description The ID of the project the content type to delete belongs to
|
1910
|
+
*/
|
1911
|
+
projectId: string;
|
1912
|
+
};
|
1913
|
+
};
|
1914
|
+
};
|
1915
|
+
};
|
1916
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
1917
|
+
options: {
|
1918
|
+
responses: {
|
1919
|
+
/** OK */
|
1920
|
+
204: never;
|
1921
|
+
};
|
1922
|
+
};
|
1923
|
+
};
|
1924
|
+
}
|
1925
|
+
interface external$a {
|
1926
|
+
"swagger.yml": {
|
1927
|
+
paths: {};
|
1928
|
+
components: {
|
1929
|
+
schemas: {
|
1930
|
+
Error: {
|
1931
|
+
/** @description Error message(s) that occurred while processing the request */
|
1932
|
+
errorMessage?: string[] | string;
|
1933
|
+
};
|
1934
|
+
};
|
1935
|
+
responses: {
|
1936
|
+
/** Request input validation failed */
|
1937
|
+
BadRequestError: {
|
1938
|
+
content: {
|
1939
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
1940
|
+
};
|
1941
|
+
};
|
1942
|
+
/** API key or token was not valid */
|
1943
|
+
UnauthorizedError: {
|
1944
|
+
content: {
|
1945
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
1946
|
+
};
|
1947
|
+
};
|
1948
|
+
/** Permission was denied */
|
1949
|
+
ForbiddenError: {
|
1950
|
+
content: {
|
1951
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
1952
|
+
};
|
1953
|
+
};
|
1954
|
+
/** Resource not found */
|
1955
|
+
NotFoundError: {
|
1956
|
+
content: {
|
1957
|
+
"application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
|
1958
|
+
};
|
1959
|
+
};
|
1960
|
+
/** Too many requests in allowed time period */
|
1961
|
+
RateLimitError: unknown;
|
1962
|
+
/** Execution error occurred */
|
1963
|
+
InternalServerError: unknown;
|
1964
|
+
};
|
1965
|
+
};
|
1966
|
+
operations: {};
|
1967
|
+
};
|
1968
|
+
"uniform-canvas-types.swagger.yml": {
|
1969
|
+
paths: {};
|
1970
|
+
components: {
|
1971
|
+
schemas: {
|
1972
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
1973
|
+
PublicIdProperty: string;
|
1974
|
+
/** @description The definition of a component parameter */
|
1975
|
+
ComponentDefinitionParameter: {
|
1976
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1977
|
+
/** @description Friendly name of the parameter */
|
1978
|
+
name: string;
|
1979
|
+
/** @description Appears next to the parameter in the Composition editor */
|
1980
|
+
helpText?: string;
|
1981
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
1982
|
+
type: string;
|
1983
|
+
/** @description The configuration object for the type (type-specific) */
|
1984
|
+
typeConfig?: unknown;
|
1985
|
+
};
|
1986
|
+
/** @description The definition of a named component slot that can contain other components */
|
1987
|
+
ComponentDefinitionSlot: {
|
1988
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1989
|
+
/** @description Friendly name of the slot */
|
1990
|
+
name: string;
|
1991
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
1992
|
+
allowedComponents: string[];
|
1993
|
+
/**
|
1994
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
1995
|
+
* If allowAllComponents is true, this value is ignored.
|
1996
|
+
*
|
1997
|
+
* @default false
|
1998
|
+
*/
|
1999
|
+
inheritAllowedComponents: boolean;
|
2000
|
+
/**
|
2001
|
+
* @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.
|
2002
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
2003
|
+
*/
|
2004
|
+
allowAllComponents?: boolean;
|
2005
|
+
/**
|
2006
|
+
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
2007
|
+
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
2008
|
+
*/
|
2009
|
+
patternsInAllowedComponents?: boolean;
|
2010
|
+
/** @description Minimum valid number of components in this slot */
|
2011
|
+
minComponents?: number;
|
2012
|
+
/** @description Maximum valid number of components in this slot */
|
2013
|
+
maxComponents?: number;
|
2014
|
+
};
|
2015
|
+
/** @description The definition of a composition's slug settings */
|
2016
|
+
ComponentDefinitionSlugSettings: {
|
2017
|
+
/**
|
2018
|
+
* @description Whether the slug is required
|
2019
|
+
* no: slug is optional
|
2020
|
+
* yes: slug is required
|
2021
|
+
* disabled: slug is disabled and will not be shown in the editor
|
2022
|
+
*
|
2023
|
+
* @default no
|
2024
|
+
* @enum {string}
|
2025
|
+
*/
|
2026
|
+
required?: "no" | "yes" | "disabled";
|
2027
|
+
/**
|
2028
|
+
* @description Slug uniqueness configuration.
|
2029
|
+
* no = no unique constraint
|
2030
|
+
* local = must be unique within this component type
|
2031
|
+
* global = must be unique across all component types
|
2032
|
+
*
|
2033
|
+
* @enum {string}
|
2034
|
+
*/
|
2035
|
+
unique?: "no" | "local" | "global";
|
2036
|
+
/** @description Regular expression slugs must match */
|
2037
|
+
regularExpression?: string;
|
2038
|
+
/**
|
2039
|
+
* @description Custom error message when regular expression validation fails.
|
2040
|
+
* Has no effect if `regularExpression` is not set.
|
2041
|
+
*/
|
2042
|
+
regularExpressionMessage?: string;
|
2043
|
+
};
|
2044
|
+
/** @description The definition of a component variant */
|
2045
|
+
ComponentDefinitionVariant: {
|
2046
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2047
|
+
/** @description Friendly name of the variant */
|
2048
|
+
name: string;
|
2049
|
+
};
|
2050
|
+
/** @description Permission set for a component defintion */
|
2051
|
+
ComponentDefinitionPermission: {
|
2052
|
+
roleId: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2053
|
+
/**
|
2054
|
+
* @description Permission type for this permission ComponentDefinition:
|
2055
|
+
* read | write | create | delete
|
2056
|
+
*
|
2057
|
+
* @enum {string}
|
2058
|
+
*/
|
2059
|
+
permission: "read" | "write" | "create" | "delete";
|
2060
|
+
/** @description State of the component that this permission applies to */
|
2061
|
+
state: number;
|
2062
|
+
};
|
2063
|
+
/** @description Defines a component type that can live on a Composition */
|
2064
|
+
ComponentDefinition: {
|
2065
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2066
|
+
/** @description Friendly name of the component definition */
|
2067
|
+
name: string;
|
2068
|
+
/**
|
2069
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
2070
|
+
* @default screen
|
2071
|
+
*/
|
2072
|
+
icon?: string;
|
2073
|
+
/**
|
2074
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
2075
|
+
* The parameter type must support being used as a title parameter for this to work.
|
2076
|
+
*
|
2077
|
+
* @default null
|
2078
|
+
*/
|
2079
|
+
titleParameter?: string | null;
|
2080
|
+
/**
|
2081
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
2082
|
+
* @default false
|
2083
|
+
*/
|
2084
|
+
canBeComposition?: boolean;
|
2085
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2086
|
+
parameters?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2087
|
+
/**
|
2088
|
+
* Format: uuid
|
2089
|
+
* @description Reference to the category this component definition belongs to
|
2090
|
+
* @default null
|
2091
|
+
*/
|
2092
|
+
categoryId?: string | null;
|
2093
|
+
/**
|
2094
|
+
* @description Description of the component definition
|
2095
|
+
* @default null
|
2096
|
+
*/
|
2097
|
+
description?: string;
|
2098
|
+
/**
|
2099
|
+
* @description Description of the component definition
|
2100
|
+
* @default null
|
2101
|
+
*/
|
2102
|
+
previewImageUrl?: string;
|
2103
|
+
/**
|
2104
|
+
* @description if this component uses team permissions or custom permissions
|
2105
|
+
* @default true
|
2106
|
+
*/
|
2107
|
+
useTeamPermissions?: boolean;
|
2108
|
+
/** @description Custom role permissions for this component definition */
|
2109
|
+
permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2110
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2111
|
+
slots?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2112
|
+
slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2113
|
+
/** @description Default component instance value */
|
2114
|
+
defaults?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2115
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2116
|
+
variants?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2117
|
+
/** @description Created date string for this definition (ignored for writes) */
|
2118
|
+
created?: string;
|
2119
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
2120
|
+
updated?: string;
|
2121
|
+
};
|
2122
|
+
/** @description Defines a content type */
|
2123
|
+
ContentType: {
|
2124
|
+
id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2125
|
+
/** @description Friendly name of the content type */
|
2126
|
+
name: string;
|
2127
|
+
/**
|
2128
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
2129
|
+
* The field type must support being used as an entry name for this to work.
|
2130
|
+
*/
|
2131
|
+
entryName?: string | null;
|
2132
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2133
|
+
fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2134
|
+
/** @description Created date string for this content type (ignored for writes) */
|
2135
|
+
created?: string;
|
2136
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
2137
|
+
updated?: string;
|
2138
|
+
};
|
2139
|
+
/** @description Defines an editable parameter on a component. */
|
2140
|
+
ComponentParameter: {
|
2141
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
2142
|
+
value: unknown;
|
2143
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2144
|
+
type: string;
|
2145
|
+
/** @deprecated */
|
2146
|
+
connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2147
|
+
};
|
2148
|
+
/** @description Defines a connection to a dynamic token on a data resource. */
|
2149
|
+
DataElementConnectionDefinition: {
|
2150
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value. */
|
2151
|
+
pointer: string;
|
2152
|
+
/**
|
2153
|
+
* @description The syntax used to select the dynamic token to bind to
|
2154
|
+
* @enum {string}
|
2155
|
+
*/
|
2156
|
+
syntax: "jptr";
|
2157
|
+
};
|
2158
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
2159
|
+
ComponentInstance: {
|
2160
|
+
/** @description Type of the component instance (public_id of its definition) */
|
2161
|
+
type: string;
|
2162
|
+
/** @description Component parameter values for the component instance */
|
2163
|
+
parameters?: {
|
2164
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2165
|
+
};
|
2166
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2167
|
+
variant?: string;
|
2168
|
+
/** @description Slots containing any child components */
|
2169
|
+
slots?: {
|
2170
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2171
|
+
};
|
2172
|
+
/**
|
2173
|
+
* @description Unique identifier of the component within the composition.
|
2174
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
2175
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
2176
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
|
2177
|
+
*/
|
2178
|
+
_id?: string;
|
2179
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2180
|
+
_pattern?: string;
|
2181
|
+
_dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2182
|
+
/**
|
2183
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2184
|
+
* Means nothing for PUTs; it will be ignored.
|
2185
|
+
*/
|
2186
|
+
_patternDataResources?: {
|
2187
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2188
|
+
};
|
2189
|
+
/**
|
2190
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
2191
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
2192
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
2193
|
+
* Means nothing for PUTs; it will be ignored.
|
2194
|
+
*
|
2195
|
+
* @enum {string}
|
2196
|
+
*/
|
2197
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
2198
|
+
/**
|
2199
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2200
|
+
* This can be used to override parameters that are defined on patterns,
|
2201
|
+
* including nested patterns, with values that are specific to this composition.
|
2202
|
+
* The keys in this object are component IDs.
|
2203
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2204
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2205
|
+
* the composition's override replaces the pattern's.
|
2206
|
+
*
|
2207
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2208
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2209
|
+
*/
|
2210
|
+
_overrides?: {
|
2211
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2212
|
+
};
|
2213
|
+
/**
|
2214
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2215
|
+
* by consumers of the pattern.
|
2216
|
+
*
|
2217
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2218
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2219
|
+
*/
|
2220
|
+
_overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2221
|
+
};
|
2222
|
+
/** @description Defines the shape of the root component in a composition */
|
2223
|
+
RootComponentInstance: {
|
2224
|
+
/** @description Type of the component instance (public_id of its definition) */
|
2225
|
+
type: string;
|
2226
|
+
/** @description Component parameter values for the component instance */
|
2227
|
+
parameters?: {
|
2228
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2229
|
+
};
|
2230
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2231
|
+
variant?: string;
|
2232
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2233
|
+
projectMapNodes?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2234
|
+
/** @description Slots containing any child components */
|
2235
|
+
slots?: {
|
2236
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2237
|
+
};
|
2238
|
+
/** @description The public UUID of the composition. */
|
2239
|
+
_id: string;
|
2240
|
+
/** @description Slug pattern of this component. */
|
2241
|
+
_slug?: string | null;
|
2242
|
+
/** @description Friendly name of this component. */
|
2243
|
+
_name: string;
|
2244
|
+
_dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2245
|
+
/**
|
2246
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
2247
|
+
* This can be used to override parameters that are defined on patterns,
|
2248
|
+
* including nested patterns, with values that are specific to this composition.
|
2249
|
+
* The keys in this object are component IDs.
|
2250
|
+
* Overrides are applied from the top down, so for example if both the composition
|
2251
|
+
* and a pattern on the composition define an override on a nested pattern,
|
2252
|
+
* the composition's override replaces the pattern's.
|
2253
|
+
*
|
2254
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2255
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2256
|
+
*/
|
2257
|
+
_overrides?: {
|
2258
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2259
|
+
};
|
2260
|
+
/**
|
2261
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
2262
|
+
* by consumers of the pattern.
|
2263
|
+
*
|
2264
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2265
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2266
|
+
*/
|
2267
|
+
_overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2268
|
+
};
|
2269
|
+
/**
|
2270
|
+
* @description Defines how to override a specific component.
|
2271
|
+
*
|
2272
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2273
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2274
|
+
*/
|
2275
|
+
ComponentOverride: {
|
2276
|
+
parameters?: {
|
2277
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2278
|
+
};
|
2279
|
+
variant?: string;
|
2280
|
+
};
|
2281
|
+
/**
|
2282
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
2283
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
2284
|
+
*
|
2285
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2286
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2287
|
+
*/
|
2288
|
+
ComponentOverridability: {
|
2289
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2290
|
+
parameters?: {
|
2291
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2292
|
+
};
|
2293
|
+
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2294
|
+
variants?: boolean;
|
2295
|
+
};
|
2296
|
+
/**
|
2297
|
+
* @description Whether a parameter is overridable
|
2298
|
+
*
|
2299
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2300
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2301
|
+
*
|
2302
|
+
* @enum {string}
|
2303
|
+
*/
|
2304
|
+
OverrideOptions: "yes" | "no";
|
2305
|
+
/**
|
2306
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
2307
|
+
* These are created in the UI and shared across a whole project.
|
2308
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
2309
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
2310
|
+
*/
|
2311
|
+
DataSource: {
|
2312
|
+
/** @description Public ID of the data source */
|
2313
|
+
id: string;
|
2314
|
+
/** @description Display name of the data source */
|
2315
|
+
displayName: string;
|
2316
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
2317
|
+
connectorType: string;
|
2318
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
2319
|
+
baseUrl: string;
|
2320
|
+
/** @description HTTP headers to pass with requests to the data source */
|
2321
|
+
headers?: {
|
2322
|
+
key: string;
|
2323
|
+
value: string;
|
2324
|
+
}[];
|
2325
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2326
|
+
parameters?: {
|
2327
|
+
key: string;
|
2328
|
+
value: string;
|
2329
|
+
}[];
|
2330
|
+
/** @description Variables needed to make calls to the data source */
|
2331
|
+
variables?: {
|
2332
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2333
|
+
};
|
2334
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2335
|
+
custom?: {
|
2336
|
+
[key: string]: unknown;
|
2337
|
+
};
|
2338
|
+
};
|
2339
|
+
/** @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. */
|
2340
|
+
DataType: {
|
2341
|
+
/** @description Public ID of the data type */
|
2342
|
+
id: string;
|
2343
|
+
/** @description Display name of the data type */
|
2344
|
+
displayName: string;
|
2345
|
+
/** @description Public ID of the associated data source */
|
2346
|
+
dataSourceId: string;
|
2347
|
+
/**
|
2348
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
2349
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
2350
|
+
* no special UI or processing is required.
|
2351
|
+
*/
|
2352
|
+
archetype?: string;
|
2353
|
+
allowedOnComponents?: string[];
|
2354
|
+
/** @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. */
|
2355
|
+
path: string;
|
2356
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
2357
|
+
ttl?: number;
|
2358
|
+
/** @description Long term data resource cache configuration. */
|
2359
|
+
longTermCache?: {
|
2360
|
+
/** @description A flag to turn the long term cache on. */
|
2361
|
+
enabled: boolean;
|
2362
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
2363
|
+
ttlInHours?: number;
|
2364
|
+
};
|
2365
|
+
/** @description A key for the resource data cache purging. */
|
2366
|
+
purgeKey?: string;
|
2367
|
+
/** @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. */
|
2368
|
+
badgeIconUrl?: string;
|
2369
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
2370
|
+
headers?: {
|
2371
|
+
key: string;
|
2372
|
+
value: string;
|
2373
|
+
omitIfEmpty?: boolean;
|
2374
|
+
}[];
|
2375
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
2376
|
+
parameters?: {
|
2377
|
+
key: string;
|
2378
|
+
value: string;
|
2379
|
+
omitIfEmpty?: boolean;
|
2380
|
+
}[];
|
2381
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
2382
|
+
body?: string;
|
2383
|
+
/**
|
2384
|
+
* @description HTTP method to use with requests to the data type.
|
2385
|
+
* @default GET
|
2386
|
+
* @enum {string}
|
2387
|
+
*/
|
2388
|
+
method: "GET" | "POST" | "HEAD";
|
2389
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2390
|
+
variables?: {
|
2391
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2392
|
+
};
|
2393
|
+
/** @description Custom configuration specific to the data source being defined */
|
2394
|
+
custom?: {
|
2395
|
+
[key: string]: unknown;
|
2396
|
+
};
|
2397
|
+
};
|
2398
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
2399
|
+
DataVariableDefinition: {
|
2400
|
+
/** @description Display name of the data variable */
|
2401
|
+
displayName?: string;
|
2402
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
2403
|
+
helpText?: string;
|
2404
|
+
/**
|
2405
|
+
* @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.
|
2406
|
+
* @default text
|
2407
|
+
*/
|
2408
|
+
type?: string;
|
2409
|
+
/** @description Default value of the data variable */
|
2410
|
+
default: string;
|
2411
|
+
/** @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. */
|
2412
|
+
order?: number;
|
2413
|
+
/**
|
2414
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
2415
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
|
2416
|
+
*/
|
2417
|
+
source?: string;
|
2418
|
+
};
|
2419
|
+
/**
|
2420
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
2421
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2422
|
+
*/
|
2423
|
+
DataResourceDefinitions: {
|
2424
|
+
[key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2425
|
+
};
|
2426
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2427
|
+
DataResourceDefinition: {
|
2428
|
+
/** @description Public ID of the data type that provides this data */
|
2429
|
+
type: string;
|
2430
|
+
/** @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. */
|
2431
|
+
isPatternParameter?: boolean;
|
2432
|
+
/**
|
2433
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
2434
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
2435
|
+
* If isPatternParameter is false or undefined, this has no meaning.
|
2436
|
+
*/
|
2437
|
+
ignorePatternParameterDefault?: boolean;
|
2438
|
+
variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2439
|
+
};
|
2440
|
+
/** @description Variable values for a data resource. */
|
2441
|
+
DataResourceVariables: {
|
2442
|
+
[key: string]: string;
|
2443
|
+
};
|
2444
|
+
/** @description Category for tagging canvas entities */
|
2445
|
+
Category: {
|
2446
|
+
/**
|
2447
|
+
* Format: uuid
|
2448
|
+
* @description Unique identifier for the category
|
2449
|
+
*/
|
2450
|
+
id: string;
|
2451
|
+
/** @description Display name of the category */
|
2452
|
+
name: string;
|
2453
|
+
/**
|
2454
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
|
2455
|
+
* @default 0
|
2456
|
+
*/
|
2457
|
+
order?: number;
|
2458
|
+
};
|
2459
|
+
/** @description Project map node information related to a component. */
|
2460
|
+
CompositionProjectMapNodeInfo: {
|
2461
|
+
/**
|
2462
|
+
* Format: uuid
|
2463
|
+
* @description Unique identifier for the project map node
|
2464
|
+
*/
|
2465
|
+
id: string;
|
2466
|
+
/** @description Path of the project map node */
|
2467
|
+
path: string;
|
2468
|
+
/**
|
2469
|
+
* Format: uuid
|
2470
|
+
* @description Unique identifier for the project map that this node belongs to.
|
2471
|
+
*/
|
2472
|
+
projectMapId: string;
|
2473
|
+
};
|
2474
|
+
};
|
2475
|
+
};
|
2476
|
+
operations: {};
|
2477
|
+
};
|
2478
|
+
}
|
2479
|
+
|
2480
|
+
/**
|
2481
|
+
* This file was auto-generated by openapi-typescript.
|
2482
|
+
* Do not make direct changes to the file.
|
2483
|
+
*/
|
2484
|
+
interface paths$8 {
|
2485
|
+
"/api/v1/entries": {
|
2486
|
+
get: {
|
2487
|
+
parameters: {
|
2488
|
+
query: {
|
2489
|
+
/** Specify multiple entry IDs to fetch. Response type will be a list. */
|
2490
|
+
entryIDs?: components$4["parameters"]["entryIDs"];
|
2491
|
+
/** Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
2492
|
+
createdBy?: components$4["parameters"]["createdBy"];
|
2493
|
+
/** Max number of records to return */
|
2494
|
+
limit?: components$4["parameters"]["limit"];
|
2495
|
+
/** Number of records to skip */
|
2496
|
+
offset?: components$4["parameters"]["offset"];
|
2497
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2498
|
+
orderBy?: components$4["parameters"]["orderBy"];
|
2499
|
+
/** The project the entry/entries are on. */
|
2500
|
+
projectId: components$4["parameters"]["projectId"];
|
2501
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
2502
|
+
state?: components$4["parameters"]["state"];
|
2503
|
+
/** The content type ID to filter by. */
|
2504
|
+
type?: components$4["parameters"]["type"];
|
2505
|
+
/**
|
2506
|
+
* @deprecated Filters entries lists by the UI status of the entry.
|
2507
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2508
|
+
*/
|
2509
|
+
uiStatus?: components$4["parameters"]["uiStatus"];
|
2510
|
+
/** Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
|
2511
|
+
updatedBy?: components$4["parameters"]["updatedBy"];
|
2512
|
+
/**
|
2513
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2514
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2515
|
+
*/
|
2516
|
+
withTotalCount?: components$4["parameters"]["withTotalCount"];
|
2517
|
+
/**
|
2518
|
+
* @deprecated Returns the UI status string of the entry.
|
2519
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2520
|
+
*/
|
2521
|
+
withUIStatus?: components$4["parameters"]["withUIStatus"];
|
2522
|
+
};
|
2523
|
+
};
|
2524
|
+
responses: {
|
2525
|
+
/** OK */
|
2526
|
+
200: {
|
2527
|
+
content: {
|
2528
|
+
"application/json": components$4["schemas"]["EntryListResponse"];
|
2529
|
+
};
|
2530
|
+
};
|
2531
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2532
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2533
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2534
|
+
/** Entry not found */
|
2535
|
+
404: {
|
2536
|
+
content: {
|
2537
|
+
"text/plain": string;
|
2538
|
+
};
|
2539
|
+
};
|
2540
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2541
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2542
|
+
};
|
2543
|
+
};
|
2544
|
+
/** Upserts an entry */
|
2545
|
+
put: {
|
2546
|
+
responses: {
|
2547
|
+
/** OK */
|
2548
|
+
204: never;
|
2549
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2550
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2551
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2552
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2553
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2554
|
+
};
|
2555
|
+
requestBody: {
|
2556
|
+
content: {
|
2557
|
+
"application/json": {
|
2558
|
+
/**
|
2559
|
+
* Format: uuid
|
2560
|
+
* @description The project ID to upsert the entry to
|
2561
|
+
*/
|
2562
|
+
projectId: string;
|
2563
|
+
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
2564
|
+
state: number;
|
2565
|
+
entry: components$4["schemas"]["EntryInput"];
|
2566
|
+
/** @description Ignored if present */
|
2567
|
+
created?: string;
|
2568
|
+
/** @description Ignored if present */
|
2569
|
+
modified?: string;
|
2570
|
+
};
|
2571
|
+
};
|
2572
|
+
};
|
2573
|
+
};
|
2574
|
+
/** Deletes or unpublishes an entry */
|
2575
|
+
delete: {
|
2576
|
+
responses: {
|
2577
|
+
/** OK */
|
2578
|
+
204: never;
|
2579
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2580
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2581
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2582
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2583
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2584
|
+
};
|
2585
|
+
requestBody: {
|
2586
|
+
content: {
|
2587
|
+
"application/json": {
|
2588
|
+
/**
|
2589
|
+
* Format: uuid
|
2590
|
+
* @description The ID of the entry to delete
|
2591
|
+
*/
|
2592
|
+
entryId: string;
|
2593
|
+
/**
|
2594
|
+
* Format: uuid
|
2595
|
+
* @description The ID of the project the entry to delete belongs to
|
2596
|
+
*/
|
2597
|
+
projectId: string;
|
2598
|
+
/** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
2599
|
+
state?: number;
|
2600
|
+
};
|
2601
|
+
};
|
2602
|
+
};
|
2603
|
+
};
|
2604
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
2605
|
+
options: {
|
2606
|
+
responses: {
|
2607
|
+
/** OK */
|
2608
|
+
204: never;
|
2609
|
+
};
|
2610
|
+
};
|
2611
|
+
};
|
2612
|
+
}
|
2613
|
+
interface components$4 {
|
2614
|
+
schemas: {
|
2615
|
+
/** @description Defines the shape of the entry */
|
2616
|
+
Entry: {
|
2617
|
+
/** @description Content type of the entry. */
|
2618
|
+
type: string;
|
2619
|
+
/**
|
2620
|
+
* Format: uuid
|
2621
|
+
* @description The public UUID of the entry.
|
2622
|
+
*/
|
2623
|
+
_id: string;
|
2624
|
+
/** @description The name of the entry. */
|
2625
|
+
_name?: string;
|
2626
|
+
/** @description The slug of the entry, automatically generated. */
|
2627
|
+
_slug?: string;
|
2628
|
+
/** @description Name of the author of the most recent change. */
|
2629
|
+
_author?: string;
|
2630
|
+
/** @description Entry field values. */
|
2631
|
+
fields?: {
|
2632
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2633
|
+
};
|
2634
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2635
|
+
};
|
2636
|
+
/** @description Defines the shape of the entry input */
|
2637
|
+
EntryInput: {
|
2638
|
+
/** @description Content type of the entry. */
|
2639
|
+
type: string;
|
2640
|
+
/**
|
2641
|
+
* Format: uuid
|
2642
|
+
* @description The public UUID of the entry.
|
2643
|
+
*/
|
2644
|
+
_id?: string;
|
2645
|
+
/** @description Entry field values. */
|
2646
|
+
fields?: {
|
2647
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2648
|
+
};
|
2649
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2650
|
+
};
|
2651
|
+
EntryApiResponse: {
|
2652
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2653
|
+
state: number;
|
2654
|
+
/**
|
2655
|
+
* @deprecated
|
2656
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
2657
|
+
* @enum {string}
|
2658
|
+
*/
|
2659
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
2660
|
+
/**
|
2661
|
+
* Format: uuid
|
2662
|
+
* @description The project ID that this layout data is part of
|
2663
|
+
*/
|
2664
|
+
projectId: string;
|
2665
|
+
/**
|
2666
|
+
* Format: date-time,
|
2667
|
+
* @description Created date string for this definition
|
2668
|
+
*/
|
2669
|
+
created: string;
|
2670
|
+
/**
|
2671
|
+
* Format: date-time,
|
2672
|
+
* @description Modified date string for this definition
|
2673
|
+
*/
|
2674
|
+
modified: string;
|
2675
|
+
entry: components$4["schemas"]["Entry"];
|
2676
|
+
};
|
2677
|
+
EntryListResponse: {
|
2678
|
+
entries: components$4["schemas"]["EntryApiResponse"][];
|
2679
|
+
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true. */
|
2680
|
+
totalCount?: number;
|
2681
|
+
};
|
2682
|
+
};
|
2683
|
+
parameters: {
|
2684
|
+
/** @description The project the entry/entries are on. */
|
2685
|
+
projectId: string;
|
2686
|
+
/** @description Specify multiple entry IDs to fetch. Response type will be a list. */
|
2687
|
+
entryIDs: string[];
|
2688
|
+
/** @description The content type ID to filter by. */
|
2689
|
+
type: string[];
|
2690
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
2691
|
+
state: number;
|
2692
|
+
/** @description Number of records to skip */
|
2693
|
+
offset: number;
|
2694
|
+
/** @description Max number of records to return */
|
2695
|
+
limit: number;
|
2696
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
2697
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
|
2698
|
+
/**
|
2699
|
+
* @deprecated
|
2700
|
+
* @description Returns the UI status string of the entry.
|
2701
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2702
|
+
*/
|
2703
|
+
withUIStatus: boolean;
|
2704
|
+
/**
|
2705
|
+
* @deprecated
|
2706
|
+
* @description Filters entries lists by the UI status of the entry.
|
2707
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2708
|
+
*/
|
2709
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
2710
|
+
/** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
2711
|
+
createdBy: string;
|
2712
|
+
/** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
|
2713
|
+
updatedBy: string;
|
2714
|
+
/**
|
2715
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
2716
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2717
|
+
*/
|
2718
|
+
withTotalCount: boolean;
|
2719
|
+
};
|
2720
|
+
}
|
1265
2721
|
interface external$9 {
|
1266
2722
|
"swagger.yml": {
|
1267
2723
|
paths: {};
|
@@ -1817,18 +3273,17 @@ interface external$9 {
|
|
1817
3273
|
};
|
1818
3274
|
}
|
1819
3275
|
|
1820
|
-
type
|
1821
|
-
type
|
1822
|
-
|
1823
|
-
type
|
1824
|
-
|
1825
|
-
type
|
1826
|
-
|
1827
|
-
type
|
1828
|
-
|
1829
|
-
type
|
1830
|
-
|
1831
|
-
type Category = SharedComponents$1['Category'];
|
3276
|
+
type ContentType = components$5['schemas']['ContentType'];
|
3277
|
+
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
3278
|
+
type GetContentTypesOptions = paths$9['/api/v1/content-types']['get']['parameters']['query'];
|
3279
|
+
type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
3280
|
+
type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
3281
|
+
type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
3282
|
+
type Entry = components$4['schemas']['EntryApiResponse'];
|
3283
|
+
type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
|
3284
|
+
type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
3285
|
+
type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
3286
|
+
type PutEntryBody = paths$8['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
1832
3287
|
|
1833
3288
|
/**
|
1834
3289
|
* This file was auto-generated by openapi-typescript.
|
@@ -3702,9 +5157,9 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
3702
5157
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
3703
5158
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
3704
5159
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
3705
|
-
type DataType = components$
|
3706
|
-
type DataSource = components$
|
3707
|
-
type DataVariableDefinition = components$
|
5160
|
+
type DataType = components$5['schemas']['DataType'];
|
5161
|
+
type DataSource = components$5['schemas']['DataSource'];
|
5162
|
+
type DataVariableDefinition = components$5['schemas']['DataVariableDefinition'];
|
3708
5163
|
|
3709
5164
|
/**
|
3710
5165
|
* This file was auto-generated by openapi-typescript.
|
@@ -3998,6 +5453,10 @@ interface components$3 {
|
|
3998
5453
|
* @description Modified date string for this definition
|
3999
5454
|
*/
|
4000
5455
|
modified: string;
|
5456
|
+
/** @description User name who created this component */
|
5457
|
+
creator?: string;
|
5458
|
+
/** @description User name who last edited this component */
|
5459
|
+
author?: string;
|
4001
5460
|
/**
|
4002
5461
|
* Format: uuid
|
4003
5462
|
* @description Reference to the category this component definition belongs to
|
@@ -4842,6 +6301,7 @@ interface external$4 {
|
|
4842
6301
|
interface components$1 {
|
4843
6302
|
schemas: {
|
4844
6303
|
CompositionResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
6304
|
+
EntryResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"];
|
4845
6305
|
EdgehancerResult: {
|
4846
6306
|
diagnostics?: components$1["schemas"]["CompositionDiagnostics"];
|
4847
6307
|
errors?: components$1["schemas"]["CompositionIssue"][];
|
@@ -5857,6 +7317,10 @@ interface external$3 {
|
|
5857
7317
|
* @description Modified date string for this definition
|
5858
7318
|
*/
|
5859
7319
|
modified: string;
|
7320
|
+
/** @description User name who created this component */
|
7321
|
+
creator?: string;
|
7322
|
+
/** @description User name who last edited this component */
|
7323
|
+
author?: string;
|
5860
7324
|
/**
|
5861
7325
|
* Format: uuid
|
5862
7326
|
* @description Reference to the category this component definition belongs to
|
@@ -6035,6 +7499,246 @@ interface external$3 {
|
|
6035
7499
|
};
|
6036
7500
|
operations: {};
|
6037
7501
|
};
|
7502
|
+
"../../../lambda/functions/v1-entries.swagger.yml": {
|
7503
|
+
paths: {
|
7504
|
+
"/api/v1/entries": {
|
7505
|
+
get: {
|
7506
|
+
parameters: {
|
7507
|
+
query: {
|
7508
|
+
/** Specify multiple entry IDs to fetch. Response type will be a list. */
|
7509
|
+
entryIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
|
7510
|
+
/** Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
7511
|
+
createdBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["createdBy"];
|
7512
|
+
/** Max number of records to return */
|
7513
|
+
limit?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["limit"];
|
7514
|
+
/** Number of records to skip */
|
7515
|
+
offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
|
7516
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
7517
|
+
orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
|
7518
|
+
/** The project the entry/entries are on. */
|
7519
|
+
projectId: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["projectId"];
|
7520
|
+
/** Publishing state to fetch. 0 = draft, 64 = published. */
|
7521
|
+
state?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["state"];
|
7522
|
+
/** The content type ID to filter by. */
|
7523
|
+
type?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["type"];
|
7524
|
+
/**
|
7525
|
+
* @deprecated Filters entries lists by the UI status of the entry.
|
7526
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7527
|
+
*/
|
7528
|
+
uiStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
7529
|
+
/** Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
|
7530
|
+
updatedBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
7531
|
+
/**
|
7532
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
7533
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
7534
|
+
*/
|
7535
|
+
withTotalCount?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withTotalCount"];
|
7536
|
+
/**
|
7537
|
+
* @deprecated Returns the UI status string of the entry.
|
7538
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7539
|
+
*/
|
7540
|
+
withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
|
7541
|
+
};
|
7542
|
+
};
|
7543
|
+
responses: {
|
7544
|
+
/** OK */
|
7545
|
+
200: {
|
7546
|
+
content: {
|
7547
|
+
"application/json": external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
|
7548
|
+
};
|
7549
|
+
};
|
7550
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
7551
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
7552
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
7553
|
+
/** Entry not found */
|
7554
|
+
404: {
|
7555
|
+
content: {
|
7556
|
+
"text/plain": string;
|
7557
|
+
};
|
7558
|
+
};
|
7559
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
7560
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
7561
|
+
};
|
7562
|
+
};
|
7563
|
+
/** Upserts an entry */
|
7564
|
+
put: {
|
7565
|
+
responses: {
|
7566
|
+
/** OK */
|
7567
|
+
204: never;
|
7568
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
7569
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
7570
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
7571
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
7572
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
7573
|
+
};
|
7574
|
+
requestBody: {
|
7575
|
+
content: {
|
7576
|
+
"application/json": {
|
7577
|
+
/**
|
7578
|
+
* Format: uuid
|
7579
|
+
* @description The project ID to upsert the entry to
|
7580
|
+
*/
|
7581
|
+
projectId: string;
|
7582
|
+
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
7583
|
+
state: number;
|
7584
|
+
entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryInput"];
|
7585
|
+
/** @description Ignored if present */
|
7586
|
+
created?: string;
|
7587
|
+
/** @description Ignored if present */
|
7588
|
+
modified?: string;
|
7589
|
+
};
|
7590
|
+
};
|
7591
|
+
};
|
7592
|
+
};
|
7593
|
+
/** Deletes or unpublishes an entry */
|
7594
|
+
delete: {
|
7595
|
+
responses: {
|
7596
|
+
/** OK */
|
7597
|
+
204: never;
|
7598
|
+
400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
|
7599
|
+
401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
7600
|
+
403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
7601
|
+
429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
|
7602
|
+
500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
|
7603
|
+
};
|
7604
|
+
requestBody: {
|
7605
|
+
content: {
|
7606
|
+
"application/json": {
|
7607
|
+
/**
|
7608
|
+
* Format: uuid
|
7609
|
+
* @description The ID of the entry to delete
|
7610
|
+
*/
|
7611
|
+
entryId: string;
|
7612
|
+
/**
|
7613
|
+
* Format: uuid
|
7614
|
+
* @description The ID of the project the entry to delete belongs to
|
7615
|
+
*/
|
7616
|
+
projectId: string;
|
7617
|
+
/** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
7618
|
+
state?: number;
|
7619
|
+
};
|
7620
|
+
};
|
7621
|
+
};
|
7622
|
+
};
|
7623
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
7624
|
+
options: {
|
7625
|
+
responses: {
|
7626
|
+
/** OK */
|
7627
|
+
204: never;
|
7628
|
+
};
|
7629
|
+
};
|
7630
|
+
};
|
7631
|
+
};
|
7632
|
+
components: {
|
7633
|
+
schemas: {
|
7634
|
+
/** @description Defines the shape of the entry */
|
7635
|
+
Entry: {
|
7636
|
+
/** @description Content type of the entry. */
|
7637
|
+
type: string;
|
7638
|
+
/**
|
7639
|
+
* Format: uuid
|
7640
|
+
* @description The public UUID of the entry.
|
7641
|
+
*/
|
7642
|
+
_id: string;
|
7643
|
+
/** @description The name of the entry. */
|
7644
|
+
_name?: string;
|
7645
|
+
/** @description The slug of the entry, automatically generated. */
|
7646
|
+
_slug?: string;
|
7647
|
+
/** @description Name of the author of the most recent change. */
|
7648
|
+
_author?: string;
|
7649
|
+
/** @description Entry field values. */
|
7650
|
+
fields?: {
|
7651
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
7652
|
+
};
|
7653
|
+
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
7654
|
+
};
|
7655
|
+
/** @description Defines the shape of the entry input */
|
7656
|
+
EntryInput: {
|
7657
|
+
/** @description Content type of the entry. */
|
7658
|
+
type: string;
|
7659
|
+
/**
|
7660
|
+
* Format: uuid
|
7661
|
+
* @description The public UUID of the entry.
|
7662
|
+
*/
|
7663
|
+
_id?: string;
|
7664
|
+
/** @description Entry field values. */
|
7665
|
+
fields?: {
|
7666
|
+
[key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
7667
|
+
};
|
7668
|
+
_dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
7669
|
+
};
|
7670
|
+
EntryApiResponse: {
|
7671
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
7672
|
+
state: number;
|
7673
|
+
/**
|
7674
|
+
* @deprecated
|
7675
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
7676
|
+
* @enum {string}
|
7677
|
+
*/
|
7678
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
7679
|
+
/**
|
7680
|
+
* Format: uuid
|
7681
|
+
* @description The project ID that this layout data is part of
|
7682
|
+
*/
|
7683
|
+
projectId: string;
|
7684
|
+
/**
|
7685
|
+
* Format: date-time,
|
7686
|
+
* @description Created date string for this definition
|
7687
|
+
*/
|
7688
|
+
created: string;
|
7689
|
+
/**
|
7690
|
+
* Format: date-time,
|
7691
|
+
* @description Modified date string for this definition
|
7692
|
+
*/
|
7693
|
+
modified: string;
|
7694
|
+
entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["Entry"];
|
7695
|
+
};
|
7696
|
+
EntryListResponse: {
|
7697
|
+
entries: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"][];
|
7698
|
+
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true. */
|
7699
|
+
totalCount?: number;
|
7700
|
+
};
|
7701
|
+
};
|
7702
|
+
parameters: {
|
7703
|
+
/** @description The project the entry/entries are on. */
|
7704
|
+
projectId: string;
|
7705
|
+
/** @description Specify multiple entry IDs to fetch. Response type will be a list. */
|
7706
|
+
entryIDs: string[];
|
7707
|
+
/** @description The content type ID to filter by. */
|
7708
|
+
type: string[];
|
7709
|
+
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
7710
|
+
state: number;
|
7711
|
+
/** @description Number of records to skip */
|
7712
|
+
offset: number;
|
7713
|
+
/** @description Max number of records to return */
|
7714
|
+
limit: number;
|
7715
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
|
7716
|
+
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
|
7717
|
+
/**
|
7718
|
+
* @deprecated
|
7719
|
+
* @description Returns the UI status string of the entry.
|
7720
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7721
|
+
*/
|
7722
|
+
withUIStatus: boolean;
|
7723
|
+
/**
|
7724
|
+
* @deprecated
|
7725
|
+
* @description Filters entries lists by the UI status of the entry.
|
7726
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
7727
|
+
*/
|
7728
|
+
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
7729
|
+
/** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
|
7730
|
+
createdBy: string;
|
7731
|
+
/** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
|
7732
|
+
updatedBy: string;
|
7733
|
+
/**
|
7734
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
7735
|
+
* Has no effect when not fetching a list. This does impact performance when enabled.
|
7736
|
+
*/
|
7737
|
+
withTotalCount: boolean;
|
7738
|
+
};
|
7739
|
+
};
|
7740
|
+
operations: {};
|
7741
|
+
};
|
6038
7742
|
"../../../lambda/functions/v1-redirect.swagger.yml": {
|
6039
7743
|
paths: {
|
6040
7744
|
"/api/v1/redirect": {
|
@@ -6050,6 +7754,8 @@ interface external$3 {
|
|
6050
7754
|
ids?: string[];
|
6051
7755
|
/** Source url to attempt to find redirects for */
|
6052
7756
|
sourceUrl?: string;
|
7757
|
+
/** Find redirects that could redirect to this url */
|
7758
|
+
targetUrl?: string;
|
6053
7759
|
/** Id of the project map the source or target belongs to. */
|
6054
7760
|
projectMapId?: string;
|
6055
7761
|
/** Id of the project map node to find redirects for. */
|
@@ -7362,6 +9068,10 @@ interface external$2 {
|
|
7362
9068
|
* @description Modified date string for this definition
|
7363
9069
|
*/
|
7364
9070
|
modified: string;
|
9071
|
+
/** @description User name who created this component */
|
9072
|
+
creator?: string;
|
9073
|
+
/** @description User name who last edited this component */
|
9074
|
+
author?: string;
|
7365
9075
|
/**
|
7366
9076
|
* Format: uuid
|
7367
9077
|
* @description Reference to the category this component definition belongs to
|
@@ -7555,6 +9265,8 @@ interface external$2 {
|
|
7555
9265
|
ids?: string[];
|
7556
9266
|
/** Source url to attempt to find redirects for */
|
7557
9267
|
sourceUrl?: string;
|
9268
|
+
/** Find redirects that could redirect to this url */
|
9269
|
+
targetUrl?: string;
|
7558
9270
|
/** Id of the project map the source or target belongs to. */
|
7559
9271
|
projectMapId?: string;
|
7560
9272
|
/** Id of the project map node to find redirects for. */
|
@@ -7739,7 +9451,7 @@ interface external$2 {
|
|
7739
9451
|
}
|
7740
9452
|
|
7741
9453
|
type Components = components$3['schemas'];
|
7742
|
-
type SharedComponents = components$
|
9454
|
+
type SharedComponents = components$5['schemas'];
|
7743
9455
|
type HistoryComponents = components$2['schemas'];
|
7744
9456
|
type Api = paths$4['/api/v1/canvas'];
|
7745
9457
|
type HistoryApi = paths$3['/api/v1/canvas-history'];
|
@@ -7823,6 +9535,8 @@ type CanvasDefinitions = {
|
|
7823
9535
|
compositions?: Array<CompositionGetResponse>;
|
7824
9536
|
dataTypes?: Array<DataType>;
|
7825
9537
|
categories?: Array<Category>;
|
9538
|
+
contentTypes?: Array<ContentType>;
|
9539
|
+
entries?: Array<Entry>;
|
7826
9540
|
};
|
7827
9541
|
/** Defines shared parameters for requests getting a single composition */
|
7828
9542
|
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
|
@@ -7900,6 +9614,11 @@ type RouteGetResponseComposition = components['schemas']['RouteResponseCompositi
|
|
7900
9614
|
type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
|
7901
9615
|
type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
|
7902
9616
|
type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
|
9617
|
+
/** Response as it comes from uniform.global/api/v1/composition */
|
9618
|
+
type EntryResolvedGetResponse = components$1['schemas']['EntryResolvedGetResponse'];
|
9619
|
+
/** The GET response from /api/v1/entries */
|
9620
|
+
type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
9621
|
+
type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
|
7903
9622
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
7904
9623
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
7905
9624
|
compositionApiResponse: CompositionResolvedGetResponse;
|
@@ -7919,6 +9638,8 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
7919
9638
|
projectId: string;
|
7920
9639
|
created: string;
|
7921
9640
|
modified: string;
|
9641
|
+
creator?: string | undefined;
|
9642
|
+
author?: string | undefined;
|
7922
9643
|
categoryId?: string | undefined;
|
7923
9644
|
description?: string | undefined;
|
7924
9645
|
previewImageUrl?: string | undefined;
|
@@ -8608,6 +10329,25 @@ type RichTextParamConfiguration = {
|
|
8608
10329
|
};
|
8609
10330
|
type RichTextParamValue = SerializedEditorState | undefined | null;
|
8610
10331
|
|
10332
|
+
type ContentClientOptions = ClientOptions & {
|
10333
|
+
edgeApiHost?: string;
|
10334
|
+
};
|
10335
|
+
declare class ContentClient extends ApiClient<ContentClientOptions> {
|
10336
|
+
#private;
|
10337
|
+
private edgeApiHost;
|
10338
|
+
constructor(options: ContentClientOptions);
|
10339
|
+
getContentTypes(options?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
|
10340
|
+
getEntries(options: ExceptProject<GetEntriesOptions> & DataResolutionParameters & DataResolutionOption): Promise<GetEntriesResponse>;
|
10341
|
+
upsertContentType(body: ExceptProject<PutContentTypeBody>): Promise<void>;
|
10342
|
+
upsertEntry(body: ExceptProject<PutEntryBody>): Promise<void>;
|
10343
|
+
deleteContentType(body: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
|
10344
|
+
deleteEntry(body: ExceptProject<DeleteEntryOptions>): Promise<void>;
|
10345
|
+
private getEdgeOptions;
|
10346
|
+
}
|
10347
|
+
declare class UncachedContentClient extends ContentClient {
|
10348
|
+
constructor(options: Omit<ContentClientOptions, 'bypassCache'>);
|
10349
|
+
}
|
10350
|
+
|
8611
10351
|
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
8612
10352
|
declare class DataSourceClient extends ApiClient {
|
8613
10353
|
constructor(options: ClientOptions);
|
@@ -8958,7 +10698,10 @@ type ReportRenderedCompositionsMessage = {
|
|
8958
10698
|
compositionIds: string[];
|
8959
10699
|
url: string;
|
8960
10700
|
};
|
8961
|
-
type
|
10701
|
+
type EditorStateUpdatedMessage = {
|
10702
|
+
type: 'editor-state-updated';
|
10703
|
+
};
|
10704
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
|
8962
10705
|
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
8963
10706
|
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
8964
10707
|
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
@@ -8989,6 +10732,7 @@ type Channel = {
|
|
8989
10732
|
updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
|
8990
10733
|
updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
|
8991
10734
|
reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
|
10735
|
+
editorStateUpdated: () => void;
|
8992
10736
|
};
|
8993
10737
|
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
8994
10738
|
listenTo: Window[];
|
@@ -9072,6 +10816,8 @@ declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
|
9072
10816
|
declare const CANVAS_DRAFT_STATE = 0;
|
9073
10817
|
/** Constant for a published composition state. Subject to change. */
|
9074
10818
|
declare const CANVAS_PUBLISHED_STATE = 64;
|
10819
|
+
/** Constant for editor composition state. */
|
10820
|
+
declare const CANVAS_EDITOR_STATE = 63;
|
9075
10821
|
/** Public ID of the Uniform Context personalization parameter on Canvas components */
|
9076
10822
|
declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
9077
10823
|
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
@@ -9351,4 +11097,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
9351
11097
|
|
9352
11098
|
declare const CanvasClientError: typeof ApiClientError;
|
9353
11099
|
|
9354
|
-
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, 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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, 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, GetParameterAttributesProps, 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, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
|
11100
|
+
export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_EDITOR_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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, 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, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, Entry, EntryResolvedGetResponse, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, 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, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
|