@uniformdev/canvas 19.17.0 → 19.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +865 -425
- package/dist/index.esm.js +8 -0
- package/dist/index.js +8 -0
- package/dist/index.mjs +8 -0
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { ApiClient,
|
1
|
+
import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
3
3
|
import Pusher from 'pusher-js';
|
4
4
|
import { Options as Options$1 } from 'p-retry';
|
@@ -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$4 {
|
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$4["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$3 {
|
|
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$4["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$3 {
|
|
82
82
|
};
|
83
83
|
/** @description The definition of a component variant */
|
84
84
|
ComponentDefinitionVariant: {
|
85
|
-
id: components$
|
85
|
+
id: components$4["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$4["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$3 {
|
|
101
101
|
};
|
102
102
|
/** @description Defines a component type that can live on a Composition */
|
103
103
|
ComponentDefinition: {
|
104
|
-
id: components$
|
104
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
105
105
|
/** @description Friendly name of the component definition */
|
106
106
|
name: string;
|
107
107
|
/**
|
@@ -112,6 +112,8 @@ interface components$3 {
|
|
112
112
|
/**
|
113
113
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
114
114
|
* The parameter type must support being used as a title parameter for this to work.
|
115
|
+
*
|
116
|
+
* @default null
|
115
117
|
*/
|
116
118
|
titleParameter?: string | null;
|
117
119
|
/**
|
@@ -120,21 +122,21 @@ interface components$3 {
|
|
120
122
|
*/
|
121
123
|
canBeComposition?: boolean;
|
122
124
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
123
|
-
parameters?: components$
|
125
|
+
parameters?: components$4["schemas"]["ComponentDefinitionParameter"][];
|
124
126
|
/**
|
125
127
|
* @description if this component uses team permissions or custom permissions
|
126
128
|
* @default true
|
127
129
|
*/
|
128
130
|
useTeamPermissions?: boolean;
|
129
131
|
/** @description Custom role permissions for this component definition */
|
130
|
-
permissions?: components$
|
132
|
+
permissions?: components$4["schemas"]["ComponentDefinitionPermission"][];
|
131
133
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
132
|
-
slots?: components$
|
133
|
-
slugSettings?: components$
|
134
|
+
slots?: components$4["schemas"]["ComponentDefinitionSlot"][];
|
135
|
+
slugSettings?: components$4["schemas"]["ComponentDefinitionSlugSettings"];
|
134
136
|
/** @description Default component instance value */
|
135
|
-
defaults?: components$
|
137
|
+
defaults?: components$4["schemas"]["ComponentInstance"] | null;
|
136
138
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
137
|
-
variants?: components$
|
139
|
+
variants?: components$4["schemas"]["ComponentDefinitionVariant"][];
|
138
140
|
/** @description Created date string for this definition (ignored for writes) */
|
139
141
|
created?: string;
|
140
142
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -142,7 +144,7 @@ interface components$3 {
|
|
142
144
|
};
|
143
145
|
/** @description Defines a content type */
|
144
146
|
ContentType: {
|
145
|
-
id: components$
|
147
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
146
148
|
/** @description Friendly name of the content type */
|
147
149
|
name: string;
|
148
150
|
/**
|
@@ -151,7 +153,7 @@ interface components$3 {
|
|
151
153
|
*/
|
152
154
|
titleField?: string | null;
|
153
155
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
154
|
-
fields?: components$
|
156
|
+
fields?: components$4["schemas"]["ComponentDefinitionParameter"][];
|
155
157
|
/** @description Created date string for this content type (ignored for writes) */
|
156
158
|
created?: string;
|
157
159
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -163,7 +165,7 @@ interface components$3 {
|
|
163
165
|
value: unknown;
|
164
166
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
165
167
|
type: string;
|
166
|
-
connectedData?: components$
|
168
|
+
connectedData?: components$4["schemas"]["DataElementConnectionDefinition"];
|
167
169
|
};
|
168
170
|
/**
|
169
171
|
* @description Defines a connection to a data element on a data resource.
|
@@ -186,13 +188,13 @@ interface components$3 {
|
|
186
188
|
type: string;
|
187
189
|
/** @description Component parameter values for the component instance */
|
188
190
|
parameters?: {
|
189
|
-
[key: string]: components$
|
191
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
190
192
|
};
|
191
193
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
192
194
|
variant?: string;
|
193
195
|
/** @description Slots containing any child components */
|
194
196
|
slots?: {
|
195
|
-
[key: string]: components$
|
197
|
+
[key: string]: components$4["schemas"]["ComponentInstance"][];
|
196
198
|
};
|
197
199
|
/**
|
198
200
|
* @description Unique identifier of the component within the composition.
|
@@ -202,13 +204,13 @@ interface components$3 {
|
|
202
204
|
_id?: string;
|
203
205
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
204
206
|
_pattern?: string;
|
205
|
-
_dataResources?: components$
|
207
|
+
_dataResources?: components$4["schemas"]["DataResourceDefinitions"];
|
206
208
|
/**
|
207
209
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
208
210
|
* Means nothing for PUTs; it will be ignored.
|
209
211
|
*/
|
210
212
|
_patternDataResources?: {
|
211
|
-
[key: string]: components$
|
213
|
+
[key: string]: components$4["schemas"]["DataResourceDefinition"];
|
212
214
|
};
|
213
215
|
/**
|
214
216
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -232,7 +234,7 @@ interface components$3 {
|
|
232
234
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
233
235
|
*/
|
234
236
|
_overrides?: {
|
235
|
-
[key: string]: components$
|
237
|
+
[key: string]: components$4["schemas"]["ComponentOverride"];
|
236
238
|
};
|
237
239
|
/**
|
238
240
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -241,7 +243,7 @@ interface components$3 {
|
|
241
243
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
242
244
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
243
245
|
*/
|
244
|
-
_overridability?: components$
|
246
|
+
_overridability?: components$4["schemas"]["ComponentOverridability"];
|
245
247
|
};
|
246
248
|
/** @description Defines the shape of the root component in a composition */
|
247
249
|
RootComponentInstance: {
|
@@ -249,15 +251,15 @@ interface components$3 {
|
|
249
251
|
type: string;
|
250
252
|
/** @description Component parameter values for the component instance */
|
251
253
|
parameters?: {
|
252
|
-
[key: string]: components$
|
254
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
253
255
|
};
|
254
256
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
255
257
|
variant?: string;
|
256
258
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
257
|
-
projectMapNodes?: components$
|
259
|
+
projectMapNodes?: components$4["schemas"]["CompositionProjectMapNodeInfo"][];
|
258
260
|
/** @description Slots containing any child components */
|
259
261
|
slots?: {
|
260
|
-
[key: string]: components$
|
262
|
+
[key: string]: components$4["schemas"]["ComponentInstance"][];
|
261
263
|
};
|
262
264
|
/** @description The public UUID of the composition. */
|
263
265
|
_id: string;
|
@@ -265,7 +267,7 @@ interface components$3 {
|
|
265
267
|
_slug?: string | null;
|
266
268
|
/** @description Friendly name of this component. */
|
267
269
|
_name: string;
|
268
|
-
_dataResources?: components$
|
270
|
+
_dataResources?: components$4["schemas"]["DataResourceDefinitions"];
|
269
271
|
/**
|
270
272
|
* @description Defines patch overrides to component IDs that live in the composition.
|
271
273
|
* This can be used to override parameters that are defined on patterns,
|
@@ -279,7 +281,7 @@ interface components$3 {
|
|
279
281
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
280
282
|
*/
|
281
283
|
_overrides?: {
|
282
|
-
[key: string]: components$
|
284
|
+
[key: string]: components$4["schemas"]["ComponentOverride"];
|
283
285
|
};
|
284
286
|
/**
|
285
287
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -288,7 +290,7 @@ interface components$3 {
|
|
288
290
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
289
291
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
290
292
|
*/
|
291
|
-
_overridability?: components$
|
293
|
+
_overridability?: components$4["schemas"]["ComponentOverridability"];
|
292
294
|
};
|
293
295
|
/**
|
294
296
|
* @description Defines how to override a specific component.
|
@@ -298,7 +300,7 @@ interface components$3 {
|
|
298
300
|
*/
|
299
301
|
ComponentOverride: {
|
300
302
|
parameters?: {
|
301
|
-
[key: string]: components$
|
303
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
302
304
|
};
|
303
305
|
variant?: string;
|
304
306
|
};
|
@@ -312,7 +314,7 @@ interface components$3 {
|
|
312
314
|
ComponentOverridability: {
|
313
315
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
314
316
|
parameters?: {
|
315
|
-
[key: string]: components$
|
317
|
+
[key: string]: components$4["schemas"]["OverrideOptions"];
|
316
318
|
};
|
317
319
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
318
320
|
variants?: boolean;
|
@@ -353,7 +355,7 @@ interface components$3 {
|
|
353
355
|
}[];
|
354
356
|
/** @description Variables needed to make calls to the data source */
|
355
357
|
variables?: {
|
356
|
-
[key: string]: components$
|
358
|
+
[key: string]: components$4["schemas"]["DataVariableDefinition"];
|
357
359
|
};
|
358
360
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
359
361
|
custom?: {
|
@@ -410,7 +412,7 @@ interface components$3 {
|
|
410
412
|
method: "GET" | "POST" | "HEAD";
|
411
413
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
412
414
|
variables?: {
|
413
|
-
[key: string]: components$
|
415
|
+
[key: string]: components$4["schemas"]["DataVariableDefinition"];
|
414
416
|
};
|
415
417
|
/** @description Custom configuration specific to the data source being defined */
|
416
418
|
custom?: {
|
@@ -438,7 +440,7 @@ interface components$3 {
|
|
438
440
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
439
441
|
*/
|
440
442
|
DataResourceDefinitions: {
|
441
|
-
[key: string]: components$
|
443
|
+
[key: string]: components$4["schemas"]["DataResourceDefinition"];
|
442
444
|
};
|
443
445
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
444
446
|
DataResourceDefinition: {
|
@@ -452,7 +454,7 @@ interface components$3 {
|
|
452
454
|
* If isPatternParameter is false or undefined, this has no meaning.
|
453
455
|
*/
|
454
456
|
ignorePatternParameterDefault?: boolean;
|
455
|
-
variables?: components$
|
457
|
+
variables?: components$4["schemas"]["DataResourceVariables"];
|
456
458
|
};
|
457
459
|
/** @description Variable values for a data resource. */
|
458
460
|
DataResourceVariables: {
|
@@ -480,7 +482,7 @@ interface components$3 {
|
|
480
482
|
* This file was auto-generated by openapi-typescript.
|
481
483
|
* Do not make direct changes to the file.
|
482
484
|
*/
|
483
|
-
interface paths$
|
485
|
+
interface paths$8 {
|
484
486
|
"/api/v1/canvas-definitions": {
|
485
487
|
get: {
|
486
488
|
parameters: {
|
@@ -503,15 +505,15 @@ interface paths$7 {
|
|
503
505
|
content: {
|
504
506
|
"application/json": {
|
505
507
|
/** @description Component definitions that match the query */
|
506
|
-
componentDefinitions: external$
|
508
|
+
componentDefinitions: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
507
509
|
};
|
508
510
|
};
|
509
511
|
};
|
510
|
-
400: external$
|
511
|
-
401: external$
|
512
|
-
403: external$
|
513
|
-
429: external$
|
514
|
-
500: external$
|
512
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
513
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
514
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
515
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
516
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
515
517
|
};
|
516
518
|
};
|
517
519
|
/** Upserts a component definition */
|
@@ -519,11 +521,11 @@ interface paths$7 {
|
|
519
521
|
responses: {
|
520
522
|
/** OK */
|
521
523
|
204: never;
|
522
|
-
400: external$
|
523
|
-
401: external$
|
524
|
-
403: external$
|
525
|
-
429: external$
|
526
|
-
500: external$
|
524
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
525
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
526
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
527
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
528
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
527
529
|
};
|
528
530
|
requestBody: {
|
529
531
|
content: {
|
@@ -533,7 +535,7 @@ interface paths$7 {
|
|
533
535
|
* @description The project ID to upsert the component definition to
|
534
536
|
*/
|
535
537
|
projectId: string;
|
536
|
-
componentDefinition: external$
|
538
|
+
componentDefinition: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
537
539
|
};
|
538
540
|
};
|
539
541
|
};
|
@@ -543,11 +545,11 @@ interface paths$7 {
|
|
543
545
|
responses: {
|
544
546
|
/** OK */
|
545
547
|
204: never;
|
546
|
-
400: external$
|
547
|
-
401: external$
|
548
|
-
403: external$
|
549
|
-
429: external$
|
550
|
-
500: external$
|
548
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
549
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
550
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
551
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
552
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
551
553
|
};
|
552
554
|
requestBody: {
|
553
555
|
content: {
|
@@ -572,7 +574,7 @@ interface paths$7 {
|
|
572
574
|
};
|
573
575
|
};
|
574
576
|
}
|
575
|
-
interface external$
|
577
|
+
interface external$9 {
|
576
578
|
"swagger.yml": {
|
577
579
|
paths: {};
|
578
580
|
components: {
|
@@ -586,25 +588,25 @@ interface external$8 {
|
|
586
588
|
/** Request input validation failed */
|
587
589
|
BadRequestError: {
|
588
590
|
content: {
|
589
|
-
"application/json": external$
|
591
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
590
592
|
};
|
591
593
|
};
|
592
594
|
/** API key or token was not valid */
|
593
595
|
UnauthorizedError: {
|
594
596
|
content: {
|
595
|
-
"application/json": external$
|
597
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
596
598
|
};
|
597
599
|
};
|
598
600
|
/** Permission was denied */
|
599
601
|
ForbiddenError: {
|
600
602
|
content: {
|
601
|
-
"application/json": external$
|
603
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
602
604
|
};
|
603
605
|
};
|
604
606
|
/** Resource not found */
|
605
607
|
NotFoundError: {
|
606
608
|
content: {
|
607
|
-
"application/json": external$
|
609
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
608
610
|
};
|
609
611
|
};
|
610
612
|
/** Too many requests in allowed time period */
|
@@ -623,7 +625,7 @@ interface external$8 {
|
|
623
625
|
PublicIdProperty: string;
|
624
626
|
/** @description The definition of a component parameter */
|
625
627
|
ComponentDefinitionParameter: {
|
626
|
-
id: external$
|
628
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
627
629
|
/** @description Friendly name of the parameter */
|
628
630
|
name: string;
|
629
631
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -635,7 +637,7 @@ interface external$8 {
|
|
635
637
|
};
|
636
638
|
/** @description The definition of a named component slot that can contain other components */
|
637
639
|
ComponentDefinitionSlot: {
|
638
|
-
id: external$
|
640
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
639
641
|
/** @description Friendly name of the slot */
|
640
642
|
name: string;
|
641
643
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -693,13 +695,13 @@ interface external$8 {
|
|
693
695
|
};
|
694
696
|
/** @description The definition of a component variant */
|
695
697
|
ComponentDefinitionVariant: {
|
696
|
-
id: external$
|
698
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
697
699
|
/** @description Friendly name of the variant */
|
698
700
|
name: string;
|
699
701
|
};
|
700
702
|
/** @description Permission set for a component defintion */
|
701
703
|
ComponentDefinitionPermission: {
|
702
|
-
roleId: external$
|
704
|
+
roleId: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
703
705
|
/**
|
704
706
|
* @description Permission type for this permission ComponentDefinition:
|
705
707
|
* read | write | create | delete
|
@@ -712,7 +714,7 @@ interface external$8 {
|
|
712
714
|
};
|
713
715
|
/** @description Defines a component type that can live on a Composition */
|
714
716
|
ComponentDefinition: {
|
715
|
-
id: external$
|
717
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
716
718
|
/** @description Friendly name of the component definition */
|
717
719
|
name: string;
|
718
720
|
/**
|
@@ -723,6 +725,8 @@ interface external$8 {
|
|
723
725
|
/**
|
724
726
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
725
727
|
* The parameter type must support being used as a title parameter for this to work.
|
728
|
+
*
|
729
|
+
* @default null
|
726
730
|
*/
|
727
731
|
titleParameter?: string | null;
|
728
732
|
/**
|
@@ -731,21 +735,21 @@ interface external$8 {
|
|
731
735
|
*/
|
732
736
|
canBeComposition?: boolean;
|
733
737
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
734
|
-
parameters?: external$
|
738
|
+
parameters?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
735
739
|
/**
|
736
740
|
* @description if this component uses team permissions or custom permissions
|
737
741
|
* @default true
|
738
742
|
*/
|
739
743
|
useTeamPermissions?: boolean;
|
740
744
|
/** @description Custom role permissions for this component definition */
|
741
|
-
permissions?: external$
|
745
|
+
permissions?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
742
746
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
743
|
-
slots?: external$
|
744
|
-
slugSettings?: external$
|
747
|
+
slots?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
748
|
+
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
745
749
|
/** @description Default component instance value */
|
746
|
-
defaults?: external$
|
750
|
+
defaults?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
747
751
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
748
|
-
variants?: external$
|
752
|
+
variants?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
749
753
|
/** @description Created date string for this definition (ignored for writes) */
|
750
754
|
created?: string;
|
751
755
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -753,7 +757,7 @@ interface external$8 {
|
|
753
757
|
};
|
754
758
|
/** @description Defines a content type */
|
755
759
|
ContentType: {
|
756
|
-
id: external$
|
760
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
757
761
|
/** @description Friendly name of the content type */
|
758
762
|
name: string;
|
759
763
|
/**
|
@@ -762,7 +766,7 @@ interface external$8 {
|
|
762
766
|
*/
|
763
767
|
titleField?: string | null;
|
764
768
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
765
|
-
fields?: external$
|
769
|
+
fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
766
770
|
/** @description Created date string for this content type (ignored for writes) */
|
767
771
|
created?: string;
|
768
772
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -774,7 +778,7 @@ interface external$8 {
|
|
774
778
|
value: unknown;
|
775
779
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
776
780
|
type: string;
|
777
|
-
connectedData?: external$
|
781
|
+
connectedData?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
778
782
|
};
|
779
783
|
/**
|
780
784
|
* @description Defines a connection to a data element on a data resource.
|
@@ -797,13 +801,13 @@ interface external$8 {
|
|
797
801
|
type: string;
|
798
802
|
/** @description Component parameter values for the component instance */
|
799
803
|
parameters?: {
|
800
|
-
[key: string]: external$
|
804
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
801
805
|
};
|
802
806
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
803
807
|
variant?: string;
|
804
808
|
/** @description Slots containing any child components */
|
805
809
|
slots?: {
|
806
|
-
[key: string]: external$
|
810
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
807
811
|
};
|
808
812
|
/**
|
809
813
|
* @description Unique identifier of the component within the composition.
|
@@ -813,13 +817,13 @@ interface external$8 {
|
|
813
817
|
_id?: string;
|
814
818
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
815
819
|
_pattern?: string;
|
816
|
-
_dataResources?: external$
|
820
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
817
821
|
/**
|
818
822
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
819
823
|
* Means nothing for PUTs; it will be ignored.
|
820
824
|
*/
|
821
825
|
_patternDataResources?: {
|
822
|
-
[key: string]: external$
|
826
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
823
827
|
};
|
824
828
|
/**
|
825
829
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -843,7 +847,7 @@ interface external$8 {
|
|
843
847
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
844
848
|
*/
|
845
849
|
_overrides?: {
|
846
|
-
[key: string]: external$
|
850
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
847
851
|
};
|
848
852
|
/**
|
849
853
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -852,7 +856,7 @@ interface external$8 {
|
|
852
856
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
853
857
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
854
858
|
*/
|
855
|
-
_overridability?: external$
|
859
|
+
_overridability?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
856
860
|
};
|
857
861
|
/** @description Defines the shape of the root component in a composition */
|
858
862
|
RootComponentInstance: {
|
@@ -860,15 +864,15 @@ interface external$8 {
|
|
860
864
|
type: string;
|
861
865
|
/** @description Component parameter values for the component instance */
|
862
866
|
parameters?: {
|
863
|
-
[key: string]: external$
|
867
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
864
868
|
};
|
865
869
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
866
870
|
variant?: string;
|
867
871
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
868
|
-
projectMapNodes?: external$
|
872
|
+
projectMapNodes?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
869
873
|
/** @description Slots containing any child components */
|
870
874
|
slots?: {
|
871
|
-
[key: string]: external$
|
875
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
872
876
|
};
|
873
877
|
/** @description The public UUID of the composition. */
|
874
878
|
_id: string;
|
@@ -876,7 +880,7 @@ interface external$8 {
|
|
876
880
|
_slug?: string | null;
|
877
881
|
/** @description Friendly name of this component. */
|
878
882
|
_name: string;
|
879
|
-
_dataResources?: external$
|
883
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
880
884
|
/**
|
881
885
|
* @description Defines patch overrides to component IDs that live in the composition.
|
882
886
|
* This can be used to override parameters that are defined on patterns,
|
@@ -890,7 +894,7 @@ interface external$8 {
|
|
890
894
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
891
895
|
*/
|
892
896
|
_overrides?: {
|
893
|
-
[key: string]: external$
|
897
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
894
898
|
};
|
895
899
|
/**
|
896
900
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -899,7 +903,7 @@ interface external$8 {
|
|
899
903
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
900
904
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
901
905
|
*/
|
902
|
-
_overridability?: external$
|
906
|
+
_overridability?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
903
907
|
};
|
904
908
|
/**
|
905
909
|
* @description Defines how to override a specific component.
|
@@ -909,7 +913,7 @@ interface external$8 {
|
|
909
913
|
*/
|
910
914
|
ComponentOverride: {
|
911
915
|
parameters?: {
|
912
|
-
[key: string]: external$
|
916
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
913
917
|
};
|
914
918
|
variant?: string;
|
915
919
|
};
|
@@ -923,7 +927,7 @@ interface external$8 {
|
|
923
927
|
ComponentOverridability: {
|
924
928
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
925
929
|
parameters?: {
|
926
|
-
[key: string]: external$
|
930
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
927
931
|
};
|
928
932
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
929
933
|
variants?: boolean;
|
@@ -964,7 +968,7 @@ interface external$8 {
|
|
964
968
|
}[];
|
965
969
|
/** @description Variables needed to make calls to the data source */
|
966
970
|
variables?: {
|
967
|
-
[key: string]: external$
|
971
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
968
972
|
};
|
969
973
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
970
974
|
custom?: {
|
@@ -1021,7 +1025,7 @@ interface external$8 {
|
|
1021
1025
|
method: "GET" | "POST" | "HEAD";
|
1022
1026
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1023
1027
|
variables?: {
|
1024
|
-
[key: string]: external$
|
1028
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1025
1029
|
};
|
1026
1030
|
/** @description Custom configuration specific to the data source being defined */
|
1027
1031
|
custom?: {
|
@@ -1049,7 +1053,7 @@ interface external$8 {
|
|
1049
1053
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1050
1054
|
*/
|
1051
1055
|
DataResourceDefinitions: {
|
1052
|
-
[key: string]: external$
|
1056
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1053
1057
|
};
|
1054
1058
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1055
1059
|
DataResourceDefinition: {
|
@@ -1063,7 +1067,7 @@ interface external$8 {
|
|
1063
1067
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1064
1068
|
*/
|
1065
1069
|
ignorePatternParameterDefault?: boolean;
|
1066
|
-
variables?: external$
|
1070
|
+
variables?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1067
1071
|
};
|
1068
1072
|
/** @description Variable values for a data resource. */
|
1069
1073
|
DataResourceVariables: {
|
@@ -1090,8 +1094,8 @@ interface external$8 {
|
|
1090
1094
|
};
|
1091
1095
|
}
|
1092
1096
|
|
1093
|
-
type SharedComponents$1 = components$
|
1094
|
-
type Api$1 = paths$
|
1097
|
+
type SharedComponents$1 = components$4['schemas'];
|
1098
|
+
type Api$1 = paths$8['/api/v1/canvas-definitions'];
|
1095
1099
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1096
1100
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1097
1101
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1101,7 +1105,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
|
|
1101
1105
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1102
1106
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
1103
1107
|
/** The definition of a component parameter */
|
1104
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
1108
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$4['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1105
1109
|
typeConfig?: TConfig;
|
1106
1110
|
};
|
1107
1111
|
/** The definition of a component visual variant */
|
@@ -1119,7 +1123,7 @@ type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
|
1119
1123
|
* This file was auto-generated by openapi-typescript.
|
1120
1124
|
* Do not make direct changes to the file.
|
1121
1125
|
*/
|
1122
|
-
interface paths$
|
1126
|
+
interface paths$7 {
|
1123
1127
|
"/api/v1/data-source": {
|
1124
1128
|
get: {
|
1125
1129
|
parameters: {
|
@@ -1133,31 +1137,31 @@ interface paths$6 {
|
|
1133
1137
|
200: {
|
1134
1138
|
content: {
|
1135
1139
|
"application/json": {
|
1136
|
-
result: external$
|
1140
|
+
result: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
1137
1141
|
};
|
1138
1142
|
};
|
1139
1143
|
};
|
1140
|
-
400: external$
|
1141
|
-
401: external$
|
1142
|
-
403: external$
|
1143
|
-
429: external$
|
1144
|
-
500: external$
|
1144
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1145
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1146
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1147
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1148
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1145
1149
|
};
|
1146
1150
|
};
|
1147
1151
|
put: {
|
1148
1152
|
responses: {
|
1149
1153
|
/** OK */
|
1150
1154
|
204: never;
|
1151
|
-
400: external$
|
1152
|
-
401: external$
|
1153
|
-
403: external$
|
1154
|
-
429: external$
|
1155
|
-
500: external$
|
1155
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1156
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1157
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1158
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1159
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1156
1160
|
};
|
1157
1161
|
requestBody: {
|
1158
1162
|
content: {
|
1159
1163
|
"application/json": {
|
1160
|
-
data: external$
|
1164
|
+
data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
1161
1165
|
/** Format: uuid */
|
1162
1166
|
projectId: string;
|
1163
1167
|
/**
|
@@ -1176,11 +1180,11 @@ interface paths$6 {
|
|
1176
1180
|
responses: {
|
1177
1181
|
/** OK */
|
1178
1182
|
204: never;
|
1179
|
-
400: external$
|
1180
|
-
401: external$
|
1181
|
-
403: external$
|
1182
|
-
429: external$
|
1183
|
-
500: external$
|
1183
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1184
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1185
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1186
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1187
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1184
1188
|
};
|
1185
1189
|
requestBody: {
|
1186
1190
|
content: {
|
@@ -1194,7 +1198,7 @@ interface paths$6 {
|
|
1194
1198
|
};
|
1195
1199
|
};
|
1196
1200
|
}
|
1197
|
-
interface external$
|
1201
|
+
interface external$8 {
|
1198
1202
|
"swagger.yml": {
|
1199
1203
|
paths: {};
|
1200
1204
|
components: {
|
@@ -1208,25 +1212,25 @@ interface external$7 {
|
|
1208
1212
|
/** Request input validation failed */
|
1209
1213
|
BadRequestError: {
|
1210
1214
|
content: {
|
1211
|
-
"application/json": external$
|
1215
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1212
1216
|
};
|
1213
1217
|
};
|
1214
1218
|
/** API key or token was not valid */
|
1215
1219
|
UnauthorizedError: {
|
1216
1220
|
content: {
|
1217
|
-
"application/json": external$
|
1221
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1218
1222
|
};
|
1219
1223
|
};
|
1220
1224
|
/** Permission was denied */
|
1221
1225
|
ForbiddenError: {
|
1222
1226
|
content: {
|
1223
|
-
"application/json": external$
|
1227
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1224
1228
|
};
|
1225
1229
|
};
|
1226
1230
|
/** Resource not found */
|
1227
1231
|
NotFoundError: {
|
1228
1232
|
content: {
|
1229
|
-
"application/json": external$
|
1233
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1230
1234
|
};
|
1231
1235
|
};
|
1232
1236
|
/** Too many requests in allowed time period */
|
@@ -1245,7 +1249,7 @@ interface external$7 {
|
|
1245
1249
|
PublicIdProperty: string;
|
1246
1250
|
/** @description The definition of a component parameter */
|
1247
1251
|
ComponentDefinitionParameter: {
|
1248
|
-
id: external$
|
1252
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1249
1253
|
/** @description Friendly name of the parameter */
|
1250
1254
|
name: string;
|
1251
1255
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1257,7 +1261,7 @@ interface external$7 {
|
|
1257
1261
|
};
|
1258
1262
|
/** @description The definition of a named component slot that can contain other components */
|
1259
1263
|
ComponentDefinitionSlot: {
|
1260
|
-
id: external$
|
1264
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1261
1265
|
/** @description Friendly name of the slot */
|
1262
1266
|
name: string;
|
1263
1267
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1315,13 +1319,13 @@ interface external$7 {
|
|
1315
1319
|
};
|
1316
1320
|
/** @description The definition of a component variant */
|
1317
1321
|
ComponentDefinitionVariant: {
|
1318
|
-
id: external$
|
1322
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1319
1323
|
/** @description Friendly name of the variant */
|
1320
1324
|
name: string;
|
1321
1325
|
};
|
1322
1326
|
/** @description Permission set for a component defintion */
|
1323
1327
|
ComponentDefinitionPermission: {
|
1324
|
-
roleId: external$
|
1328
|
+
roleId: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1325
1329
|
/**
|
1326
1330
|
* @description Permission type for this permission ComponentDefinition:
|
1327
1331
|
* read | write | create | delete
|
@@ -1334,7 +1338,7 @@ interface external$7 {
|
|
1334
1338
|
};
|
1335
1339
|
/** @description Defines a component type that can live on a Composition */
|
1336
1340
|
ComponentDefinition: {
|
1337
|
-
id: external$
|
1341
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1338
1342
|
/** @description Friendly name of the component definition */
|
1339
1343
|
name: string;
|
1340
1344
|
/**
|
@@ -1345,6 +1349,8 @@ interface external$7 {
|
|
1345
1349
|
/**
|
1346
1350
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
1347
1351
|
* The parameter type must support being used as a title parameter for this to work.
|
1352
|
+
*
|
1353
|
+
* @default null
|
1348
1354
|
*/
|
1349
1355
|
titleParameter?: string | null;
|
1350
1356
|
/**
|
@@ -1353,21 +1359,21 @@ interface external$7 {
|
|
1353
1359
|
*/
|
1354
1360
|
canBeComposition?: boolean;
|
1355
1361
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1356
|
-
parameters?: external$
|
1362
|
+
parameters?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1357
1363
|
/**
|
1358
1364
|
* @description if this component uses team permissions or custom permissions
|
1359
1365
|
* @default true
|
1360
1366
|
*/
|
1361
1367
|
useTeamPermissions?: boolean;
|
1362
1368
|
/** @description Custom role permissions for this component definition */
|
1363
|
-
permissions?: external$
|
1369
|
+
permissions?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1364
1370
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1365
|
-
slots?: external$
|
1366
|
-
slugSettings?: external$
|
1371
|
+
slots?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1372
|
+
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1367
1373
|
/** @description Default component instance value */
|
1368
|
-
defaults?: external$
|
1374
|
+
defaults?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1369
1375
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1370
|
-
variants?: external$
|
1376
|
+
variants?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1371
1377
|
/** @description Created date string for this definition (ignored for writes) */
|
1372
1378
|
created?: string;
|
1373
1379
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1375,7 +1381,7 @@ interface external$7 {
|
|
1375
1381
|
};
|
1376
1382
|
/** @description Defines a content type */
|
1377
1383
|
ContentType: {
|
1378
|
-
id: external$
|
1384
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1379
1385
|
/** @description Friendly name of the content type */
|
1380
1386
|
name: string;
|
1381
1387
|
/**
|
@@ -1384,7 +1390,7 @@ interface external$7 {
|
|
1384
1390
|
*/
|
1385
1391
|
titleField?: string | null;
|
1386
1392
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1387
|
-
fields?: external$
|
1393
|
+
fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1388
1394
|
/** @description Created date string for this content type (ignored for writes) */
|
1389
1395
|
created?: string;
|
1390
1396
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -1396,7 +1402,7 @@ interface external$7 {
|
|
1396
1402
|
value: unknown;
|
1397
1403
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1398
1404
|
type: string;
|
1399
|
-
connectedData?: external$
|
1405
|
+
connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1400
1406
|
};
|
1401
1407
|
/**
|
1402
1408
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1419,13 +1425,13 @@ interface external$7 {
|
|
1419
1425
|
type: string;
|
1420
1426
|
/** @description Component parameter values for the component instance */
|
1421
1427
|
parameters?: {
|
1422
|
-
[key: string]: external$
|
1428
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1423
1429
|
};
|
1424
1430
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1425
1431
|
variant?: string;
|
1426
1432
|
/** @description Slots containing any child components */
|
1427
1433
|
slots?: {
|
1428
|
-
[key: string]: external$
|
1434
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1429
1435
|
};
|
1430
1436
|
/**
|
1431
1437
|
* @description Unique identifier of the component within the composition.
|
@@ -1435,13 +1441,13 @@ interface external$7 {
|
|
1435
1441
|
_id?: string;
|
1436
1442
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1437
1443
|
_pattern?: string;
|
1438
|
-
_dataResources?: external$
|
1444
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1439
1445
|
/**
|
1440
1446
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1441
1447
|
* Means nothing for PUTs; it will be ignored.
|
1442
1448
|
*/
|
1443
1449
|
_patternDataResources?: {
|
1444
|
-
[key: string]: external$
|
1450
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1445
1451
|
};
|
1446
1452
|
/**
|
1447
1453
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1465,7 +1471,7 @@ interface external$7 {
|
|
1465
1471
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1466
1472
|
*/
|
1467
1473
|
_overrides?: {
|
1468
|
-
[key: string]: external$
|
1474
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1469
1475
|
};
|
1470
1476
|
/**
|
1471
1477
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1474,7 +1480,7 @@ interface external$7 {
|
|
1474
1480
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1475
1481
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1476
1482
|
*/
|
1477
|
-
_overridability?: external$
|
1483
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1478
1484
|
};
|
1479
1485
|
/** @description Defines the shape of the root component in a composition */
|
1480
1486
|
RootComponentInstance: {
|
@@ -1482,15 +1488,15 @@ interface external$7 {
|
|
1482
1488
|
type: string;
|
1483
1489
|
/** @description Component parameter values for the component instance */
|
1484
1490
|
parameters?: {
|
1485
|
-
[key: string]: external$
|
1491
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1486
1492
|
};
|
1487
1493
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1488
1494
|
variant?: string;
|
1489
1495
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1490
|
-
projectMapNodes?: external$
|
1496
|
+
projectMapNodes?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1491
1497
|
/** @description Slots containing any child components */
|
1492
1498
|
slots?: {
|
1493
|
-
[key: string]: external$
|
1499
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1494
1500
|
};
|
1495
1501
|
/** @description The public UUID of the composition. */
|
1496
1502
|
_id: string;
|
@@ -1498,7 +1504,7 @@ interface external$7 {
|
|
1498
1504
|
_slug?: string | null;
|
1499
1505
|
/** @description Friendly name of this component. */
|
1500
1506
|
_name: string;
|
1501
|
-
_dataResources?: external$
|
1507
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1502
1508
|
/**
|
1503
1509
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1504
1510
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1512,7 +1518,7 @@ interface external$7 {
|
|
1512
1518
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1513
1519
|
*/
|
1514
1520
|
_overrides?: {
|
1515
|
-
[key: string]: external$
|
1521
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1516
1522
|
};
|
1517
1523
|
/**
|
1518
1524
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1521,7 +1527,7 @@ interface external$7 {
|
|
1521
1527
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1522
1528
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1523
1529
|
*/
|
1524
|
-
_overridability?: external$
|
1530
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1525
1531
|
};
|
1526
1532
|
/**
|
1527
1533
|
* @description Defines how to override a specific component.
|
@@ -1531,7 +1537,7 @@ interface external$7 {
|
|
1531
1537
|
*/
|
1532
1538
|
ComponentOverride: {
|
1533
1539
|
parameters?: {
|
1534
|
-
[key: string]: external$
|
1540
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1535
1541
|
};
|
1536
1542
|
variant?: string;
|
1537
1543
|
};
|
@@ -1545,7 +1551,7 @@ interface external$7 {
|
|
1545
1551
|
ComponentOverridability: {
|
1546
1552
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1547
1553
|
parameters?: {
|
1548
|
-
[key: string]: external$
|
1554
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1549
1555
|
};
|
1550
1556
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1551
1557
|
variants?: boolean;
|
@@ -1586,7 +1592,7 @@ interface external$7 {
|
|
1586
1592
|
}[];
|
1587
1593
|
/** @description Variables needed to make calls to the data source */
|
1588
1594
|
variables?: {
|
1589
|
-
[key: string]: external$
|
1595
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1590
1596
|
};
|
1591
1597
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1592
1598
|
custom?: {
|
@@ -1643,7 +1649,7 @@ interface external$7 {
|
|
1643
1649
|
method: "GET" | "POST" | "HEAD";
|
1644
1650
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1645
1651
|
variables?: {
|
1646
|
-
[key: string]: external$
|
1652
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1647
1653
|
};
|
1648
1654
|
/** @description Custom configuration specific to the data source being defined */
|
1649
1655
|
custom?: {
|
@@ -1671,7 +1677,7 @@ interface external$7 {
|
|
1671
1677
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1672
1678
|
*/
|
1673
1679
|
DataResourceDefinitions: {
|
1674
|
-
[key: string]: external$
|
1680
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1675
1681
|
};
|
1676
1682
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1677
1683
|
DataResourceDefinition: {
|
@@ -1685,7 +1691,7 @@ interface external$7 {
|
|
1685
1691
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1686
1692
|
*/
|
1687
1693
|
ignorePatternParameterDefault?: boolean;
|
1688
|
-
variables?: external$
|
1694
|
+
variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1689
1695
|
};
|
1690
1696
|
/** @description Variable values for a data resource. */
|
1691
1697
|
DataResourceVariables: {
|
@@ -1716,7 +1722,7 @@ interface external$7 {
|
|
1716
1722
|
* This file was auto-generated by openapi-typescript.
|
1717
1723
|
* Do not make direct changes to the file.
|
1718
1724
|
*/
|
1719
|
-
interface paths$
|
1725
|
+
interface paths$6 {
|
1720
1726
|
"/api/v1/data-sources": {
|
1721
1727
|
get: {
|
1722
1728
|
parameters: {
|
@@ -1734,20 +1740,20 @@ interface paths$5 {
|
|
1734
1740
|
200: {
|
1735
1741
|
content: {
|
1736
1742
|
"application/json": {
|
1737
|
-
results: external$
|
1743
|
+
results: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
|
1738
1744
|
};
|
1739
1745
|
};
|
1740
1746
|
};
|
1741
|
-
400: external$
|
1742
|
-
401: external$
|
1743
|
-
403: external$
|
1744
|
-
429: external$
|
1745
|
-
500: external$
|
1747
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1748
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1749
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1750
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1751
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1746
1752
|
};
|
1747
1753
|
};
|
1748
1754
|
};
|
1749
1755
|
}
|
1750
|
-
interface external$
|
1756
|
+
interface external$7 {
|
1751
1757
|
"swagger.yml": {
|
1752
1758
|
paths: {};
|
1753
1759
|
components: {
|
@@ -1761,25 +1767,25 @@ interface external$6 {
|
|
1761
1767
|
/** Request input validation failed */
|
1762
1768
|
BadRequestError: {
|
1763
1769
|
content: {
|
1764
|
-
"application/json": external$
|
1770
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1765
1771
|
};
|
1766
1772
|
};
|
1767
1773
|
/** API key or token was not valid */
|
1768
1774
|
UnauthorizedError: {
|
1769
1775
|
content: {
|
1770
|
-
"application/json": external$
|
1776
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1771
1777
|
};
|
1772
1778
|
};
|
1773
1779
|
/** Permission was denied */
|
1774
1780
|
ForbiddenError: {
|
1775
1781
|
content: {
|
1776
|
-
"application/json": external$
|
1782
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1777
1783
|
};
|
1778
1784
|
};
|
1779
1785
|
/** Resource not found */
|
1780
1786
|
NotFoundError: {
|
1781
1787
|
content: {
|
1782
|
-
"application/json": external$
|
1788
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1783
1789
|
};
|
1784
1790
|
};
|
1785
1791
|
/** Too many requests in allowed time period */
|
@@ -1798,7 +1804,7 @@ interface external$6 {
|
|
1798
1804
|
PublicIdProperty: string;
|
1799
1805
|
/** @description The definition of a component parameter */
|
1800
1806
|
ComponentDefinitionParameter: {
|
1801
|
-
id: external$
|
1807
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1802
1808
|
/** @description Friendly name of the parameter */
|
1803
1809
|
name: string;
|
1804
1810
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1810,7 +1816,7 @@ interface external$6 {
|
|
1810
1816
|
};
|
1811
1817
|
/** @description The definition of a named component slot that can contain other components */
|
1812
1818
|
ComponentDefinitionSlot: {
|
1813
|
-
id: external$
|
1819
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1814
1820
|
/** @description Friendly name of the slot */
|
1815
1821
|
name: string;
|
1816
1822
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1868,13 +1874,13 @@ interface external$6 {
|
|
1868
1874
|
};
|
1869
1875
|
/** @description The definition of a component variant */
|
1870
1876
|
ComponentDefinitionVariant: {
|
1871
|
-
id: external$
|
1877
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1872
1878
|
/** @description Friendly name of the variant */
|
1873
1879
|
name: string;
|
1874
1880
|
};
|
1875
1881
|
/** @description Permission set for a component defintion */
|
1876
1882
|
ComponentDefinitionPermission: {
|
1877
|
-
roleId: external$
|
1883
|
+
roleId: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1878
1884
|
/**
|
1879
1885
|
* @description Permission type for this permission ComponentDefinition:
|
1880
1886
|
* read | write | create | delete
|
@@ -1887,7 +1893,7 @@ interface external$6 {
|
|
1887
1893
|
};
|
1888
1894
|
/** @description Defines a component type that can live on a Composition */
|
1889
1895
|
ComponentDefinition: {
|
1890
|
-
id: external$
|
1896
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1891
1897
|
/** @description Friendly name of the component definition */
|
1892
1898
|
name: string;
|
1893
1899
|
/**
|
@@ -1898,6 +1904,8 @@ interface external$6 {
|
|
1898
1904
|
/**
|
1899
1905
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
1900
1906
|
* The parameter type must support being used as a title parameter for this to work.
|
1907
|
+
*
|
1908
|
+
* @default null
|
1901
1909
|
*/
|
1902
1910
|
titleParameter?: string | null;
|
1903
1911
|
/**
|
@@ -1906,21 +1914,21 @@ interface external$6 {
|
|
1906
1914
|
*/
|
1907
1915
|
canBeComposition?: boolean;
|
1908
1916
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1909
|
-
parameters?: external$
|
1917
|
+
parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1910
1918
|
/**
|
1911
1919
|
* @description if this component uses team permissions or custom permissions
|
1912
1920
|
* @default true
|
1913
1921
|
*/
|
1914
1922
|
useTeamPermissions?: boolean;
|
1915
1923
|
/** @description Custom role permissions for this component definition */
|
1916
|
-
permissions?: external$
|
1924
|
+
permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1917
1925
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1918
|
-
slots?: external$
|
1919
|
-
slugSettings?: external$
|
1926
|
+
slots?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1927
|
+
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1920
1928
|
/** @description Default component instance value */
|
1921
|
-
defaults?: external$
|
1929
|
+
defaults?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1922
1930
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1923
|
-
variants?: external$
|
1931
|
+
variants?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1924
1932
|
/** @description Created date string for this definition (ignored for writes) */
|
1925
1933
|
created?: string;
|
1926
1934
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1928,7 +1936,7 @@ interface external$6 {
|
|
1928
1936
|
};
|
1929
1937
|
/** @description Defines a content type */
|
1930
1938
|
ContentType: {
|
1931
|
-
id: external$
|
1939
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1932
1940
|
/** @description Friendly name of the content type */
|
1933
1941
|
name: string;
|
1934
1942
|
/**
|
@@ -1937,7 +1945,7 @@ interface external$6 {
|
|
1937
1945
|
*/
|
1938
1946
|
titleField?: string | null;
|
1939
1947
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1940
|
-
fields?: external$
|
1948
|
+
fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1941
1949
|
/** @description Created date string for this content type (ignored for writes) */
|
1942
1950
|
created?: string;
|
1943
1951
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -1949,7 +1957,7 @@ interface external$6 {
|
|
1949
1957
|
value: unknown;
|
1950
1958
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1951
1959
|
type: string;
|
1952
|
-
connectedData?: external$
|
1960
|
+
connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1953
1961
|
};
|
1954
1962
|
/**
|
1955
1963
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1972,13 +1980,13 @@ interface external$6 {
|
|
1972
1980
|
type: string;
|
1973
1981
|
/** @description Component parameter values for the component instance */
|
1974
1982
|
parameters?: {
|
1975
|
-
[key: string]: external$
|
1983
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1976
1984
|
};
|
1977
1985
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1978
1986
|
variant?: string;
|
1979
1987
|
/** @description Slots containing any child components */
|
1980
1988
|
slots?: {
|
1981
|
-
[key: string]: external$
|
1989
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1982
1990
|
};
|
1983
1991
|
/**
|
1984
1992
|
* @description Unique identifier of the component within the composition.
|
@@ -1988,13 +1996,13 @@ interface external$6 {
|
|
1988
1996
|
_id?: string;
|
1989
1997
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1990
1998
|
_pattern?: string;
|
1991
|
-
_dataResources?: external$
|
1999
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1992
2000
|
/**
|
1993
2001
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1994
2002
|
* Means nothing for PUTs; it will be ignored.
|
1995
2003
|
*/
|
1996
2004
|
_patternDataResources?: {
|
1997
|
-
[key: string]: external$
|
2005
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1998
2006
|
};
|
1999
2007
|
/**
|
2000
2008
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2018,7 +2026,7 @@ interface external$6 {
|
|
2018
2026
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2019
2027
|
*/
|
2020
2028
|
_overrides?: {
|
2021
|
-
[key: string]: external$
|
2029
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2022
2030
|
};
|
2023
2031
|
/**
|
2024
2032
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2027,7 +2035,7 @@ interface external$6 {
|
|
2027
2035
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2028
2036
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2029
2037
|
*/
|
2030
|
-
_overridability?: external$
|
2038
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2031
2039
|
};
|
2032
2040
|
/** @description Defines the shape of the root component in a composition */
|
2033
2041
|
RootComponentInstance: {
|
@@ -2035,15 +2043,15 @@ interface external$6 {
|
|
2035
2043
|
type: string;
|
2036
2044
|
/** @description Component parameter values for the component instance */
|
2037
2045
|
parameters?: {
|
2038
|
-
[key: string]: external$
|
2046
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2039
2047
|
};
|
2040
2048
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2041
2049
|
variant?: string;
|
2042
2050
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2043
|
-
projectMapNodes?: external$
|
2051
|
+
projectMapNodes?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2044
2052
|
/** @description Slots containing any child components */
|
2045
2053
|
slots?: {
|
2046
|
-
[key: string]: external$
|
2054
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2047
2055
|
};
|
2048
2056
|
/** @description The public UUID of the composition. */
|
2049
2057
|
_id: string;
|
@@ -2051,7 +2059,7 @@ interface external$6 {
|
|
2051
2059
|
_slug?: string | null;
|
2052
2060
|
/** @description Friendly name of this component. */
|
2053
2061
|
_name: string;
|
2054
|
-
_dataResources?: external$
|
2062
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2055
2063
|
/**
|
2056
2064
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2057
2065
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2065,7 +2073,7 @@ interface external$6 {
|
|
2065
2073
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2066
2074
|
*/
|
2067
2075
|
_overrides?: {
|
2068
|
-
[key: string]: external$
|
2076
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2069
2077
|
};
|
2070
2078
|
/**
|
2071
2079
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2074,7 +2082,7 @@ interface external$6 {
|
|
2074
2082
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2075
2083
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2076
2084
|
*/
|
2077
|
-
_overridability?: external$
|
2085
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2078
2086
|
};
|
2079
2087
|
/**
|
2080
2088
|
* @description Defines how to override a specific component.
|
@@ -2084,7 +2092,7 @@ interface external$6 {
|
|
2084
2092
|
*/
|
2085
2093
|
ComponentOverride: {
|
2086
2094
|
parameters?: {
|
2087
|
-
[key: string]: external$
|
2095
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2088
2096
|
};
|
2089
2097
|
variant?: string;
|
2090
2098
|
};
|
@@ -2098,7 +2106,7 @@ interface external$6 {
|
|
2098
2106
|
ComponentOverridability: {
|
2099
2107
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2100
2108
|
parameters?: {
|
2101
|
-
[key: string]: external$
|
2109
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2102
2110
|
};
|
2103
2111
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2104
2112
|
variants?: boolean;
|
@@ -2139,7 +2147,7 @@ interface external$6 {
|
|
2139
2147
|
}[];
|
2140
2148
|
/** @description Variables needed to make calls to the data source */
|
2141
2149
|
variables?: {
|
2142
|
-
[key: string]: external$
|
2150
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2143
2151
|
};
|
2144
2152
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2145
2153
|
custom?: {
|
@@ -2196,7 +2204,7 @@ interface external$6 {
|
|
2196
2204
|
method: "GET" | "POST" | "HEAD";
|
2197
2205
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2198
2206
|
variables?: {
|
2199
|
-
[key: string]: external$
|
2207
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2200
2208
|
};
|
2201
2209
|
/** @description Custom configuration specific to the data source being defined */
|
2202
2210
|
custom?: {
|
@@ -2224,7 +2232,7 @@ interface external$6 {
|
|
2224
2232
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2225
2233
|
*/
|
2226
2234
|
DataResourceDefinitions: {
|
2227
|
-
[key: string]: external$
|
2235
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2228
2236
|
};
|
2229
2237
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2230
2238
|
DataResourceDefinition: {
|
@@ -2238,7 +2246,7 @@ interface external$6 {
|
|
2238
2246
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2239
2247
|
*/
|
2240
2248
|
ignorePatternParameterDefault?: boolean;
|
2241
|
-
variables?: external$
|
2249
|
+
variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2242
2250
|
};
|
2243
2251
|
/** @description Variable values for a data resource. */
|
2244
2252
|
DataResourceVariables: {
|
@@ -2269,7 +2277,7 @@ interface external$6 {
|
|
2269
2277
|
* This file was auto-generated by openapi-typescript.
|
2270
2278
|
* Do not make direct changes to the file.
|
2271
2279
|
*/
|
2272
|
-
interface paths$
|
2280
|
+
interface paths$5 {
|
2273
2281
|
"/api/v1/data-types": {
|
2274
2282
|
get: {
|
2275
2283
|
parameters: {
|
@@ -2282,31 +2290,31 @@ interface paths$4 {
|
|
2282
2290
|
200: {
|
2283
2291
|
content: {
|
2284
2292
|
"application/json": {
|
2285
|
-
results: external$
|
2293
|
+
results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
2286
2294
|
};
|
2287
2295
|
};
|
2288
2296
|
};
|
2289
|
-
400: external$
|
2290
|
-
401: external$
|
2291
|
-
403: external$
|
2292
|
-
429: external$
|
2293
|
-
500: external$
|
2297
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2298
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2299
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2300
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2301
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2294
2302
|
};
|
2295
2303
|
};
|
2296
2304
|
put: {
|
2297
2305
|
responses: {
|
2298
2306
|
/** OK */
|
2299
2307
|
204: never;
|
2300
|
-
400: external$
|
2301
|
-
401: external$
|
2302
|
-
403: external$
|
2303
|
-
429: external$
|
2304
|
-
500: external$
|
2308
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2309
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2310
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2311
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2312
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2305
2313
|
};
|
2306
2314
|
requestBody: {
|
2307
2315
|
content: {
|
2308
2316
|
"application/json": {
|
2309
|
-
data: external$
|
2317
|
+
data: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
2310
2318
|
/** Format: uuid */
|
2311
2319
|
projectId: string;
|
2312
2320
|
};
|
@@ -2317,11 +2325,11 @@ interface paths$4 {
|
|
2317
2325
|
responses: {
|
2318
2326
|
/** OK */
|
2319
2327
|
204: never;
|
2320
|
-
400: external$
|
2321
|
-
401: external$
|
2322
|
-
403: external$
|
2323
|
-
429: external$
|
2324
|
-
500: external$
|
2328
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2329
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2330
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2331
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2332
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2325
2333
|
};
|
2326
2334
|
requestBody: {
|
2327
2335
|
content: {
|
@@ -2335,7 +2343,7 @@ interface paths$4 {
|
|
2335
2343
|
};
|
2336
2344
|
};
|
2337
2345
|
}
|
2338
|
-
interface external$
|
2346
|
+
interface external$6 {
|
2339
2347
|
"swagger.yml": {
|
2340
2348
|
paths: {};
|
2341
2349
|
components: {
|
@@ -2349,25 +2357,25 @@ interface external$5 {
|
|
2349
2357
|
/** Request input validation failed */
|
2350
2358
|
BadRequestError: {
|
2351
2359
|
content: {
|
2352
|
-
"application/json": external$
|
2360
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2353
2361
|
};
|
2354
2362
|
};
|
2355
2363
|
/** API key or token was not valid */
|
2356
2364
|
UnauthorizedError: {
|
2357
2365
|
content: {
|
2358
|
-
"application/json": external$
|
2366
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2359
2367
|
};
|
2360
2368
|
};
|
2361
2369
|
/** Permission was denied */
|
2362
2370
|
ForbiddenError: {
|
2363
2371
|
content: {
|
2364
|
-
"application/json": external$
|
2372
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2365
2373
|
};
|
2366
2374
|
};
|
2367
2375
|
/** Resource not found */
|
2368
2376
|
NotFoundError: {
|
2369
2377
|
content: {
|
2370
|
-
"application/json": external$
|
2378
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2371
2379
|
};
|
2372
2380
|
};
|
2373
2381
|
/** Too many requests in allowed time period */
|
@@ -2386,7 +2394,7 @@ interface external$5 {
|
|
2386
2394
|
PublicIdProperty: string;
|
2387
2395
|
/** @description The definition of a component parameter */
|
2388
2396
|
ComponentDefinitionParameter: {
|
2389
|
-
id: external$
|
2397
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2390
2398
|
/** @description Friendly name of the parameter */
|
2391
2399
|
name: string;
|
2392
2400
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2398,7 +2406,7 @@ interface external$5 {
|
|
2398
2406
|
};
|
2399
2407
|
/** @description The definition of a named component slot that can contain other components */
|
2400
2408
|
ComponentDefinitionSlot: {
|
2401
|
-
id: external$
|
2409
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2402
2410
|
/** @description Friendly name of the slot */
|
2403
2411
|
name: string;
|
2404
2412
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2456,13 +2464,13 @@ interface external$5 {
|
|
2456
2464
|
};
|
2457
2465
|
/** @description The definition of a component variant */
|
2458
2466
|
ComponentDefinitionVariant: {
|
2459
|
-
id: external$
|
2467
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2460
2468
|
/** @description Friendly name of the variant */
|
2461
2469
|
name: string;
|
2462
2470
|
};
|
2463
2471
|
/** @description Permission set for a component defintion */
|
2464
2472
|
ComponentDefinitionPermission: {
|
2465
|
-
roleId: external$
|
2473
|
+
roleId: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2466
2474
|
/**
|
2467
2475
|
* @description Permission type for this permission ComponentDefinition:
|
2468
2476
|
* read | write | create | delete
|
@@ -2475,7 +2483,7 @@ interface external$5 {
|
|
2475
2483
|
};
|
2476
2484
|
/** @description Defines a component type that can live on a Composition */
|
2477
2485
|
ComponentDefinition: {
|
2478
|
-
id: external$
|
2486
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2479
2487
|
/** @description Friendly name of the component definition */
|
2480
2488
|
name: string;
|
2481
2489
|
/**
|
@@ -2486,6 +2494,8 @@ interface external$5 {
|
|
2486
2494
|
/**
|
2487
2495
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
2488
2496
|
* The parameter type must support being used as a title parameter for this to work.
|
2497
|
+
*
|
2498
|
+
* @default null
|
2489
2499
|
*/
|
2490
2500
|
titleParameter?: string | null;
|
2491
2501
|
/**
|
@@ -2494,21 +2504,21 @@ interface external$5 {
|
|
2494
2504
|
*/
|
2495
2505
|
canBeComposition?: boolean;
|
2496
2506
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2497
|
-
parameters?: external$
|
2507
|
+
parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2498
2508
|
/**
|
2499
2509
|
* @description if this component uses team permissions or custom permissions
|
2500
2510
|
* @default true
|
2501
2511
|
*/
|
2502
2512
|
useTeamPermissions?: boolean;
|
2503
2513
|
/** @description Custom role permissions for this component definition */
|
2504
|
-
permissions?: external$
|
2514
|
+
permissions?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2505
2515
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2506
|
-
slots?: external$
|
2507
|
-
slugSettings?: external$
|
2516
|
+
slots?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2517
|
+
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2508
2518
|
/** @description Default component instance value */
|
2509
|
-
defaults?: external$
|
2519
|
+
defaults?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2510
2520
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2511
|
-
variants?: external$
|
2521
|
+
variants?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2512
2522
|
/** @description Created date string for this definition (ignored for writes) */
|
2513
2523
|
created?: string;
|
2514
2524
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2516,7 +2526,7 @@ interface external$5 {
|
|
2516
2526
|
};
|
2517
2527
|
/** @description Defines a content type */
|
2518
2528
|
ContentType: {
|
2519
|
-
id: external$
|
2529
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2520
2530
|
/** @description Friendly name of the content type */
|
2521
2531
|
name: string;
|
2522
2532
|
/**
|
@@ -2525,7 +2535,7 @@ interface external$5 {
|
|
2525
2535
|
*/
|
2526
2536
|
titleField?: string | null;
|
2527
2537
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2528
|
-
fields?: external$
|
2538
|
+
fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2529
2539
|
/** @description Created date string for this content type (ignored for writes) */
|
2530
2540
|
created?: string;
|
2531
2541
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -2537,7 +2547,7 @@ interface external$5 {
|
|
2537
2547
|
value: unknown;
|
2538
2548
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2539
2549
|
type: string;
|
2540
|
-
connectedData?: external$
|
2550
|
+
connectedData?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2541
2551
|
};
|
2542
2552
|
/**
|
2543
2553
|
* @description Defines a connection to a data element on a data resource.
|
@@ -2560,13 +2570,13 @@ interface external$5 {
|
|
2560
2570
|
type: string;
|
2561
2571
|
/** @description Component parameter values for the component instance */
|
2562
2572
|
parameters?: {
|
2563
|
-
[key: string]: external$
|
2573
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2564
2574
|
};
|
2565
2575
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2566
2576
|
variant?: string;
|
2567
2577
|
/** @description Slots containing any child components */
|
2568
2578
|
slots?: {
|
2569
|
-
[key: string]: external$
|
2579
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2570
2580
|
};
|
2571
2581
|
/**
|
2572
2582
|
* @description Unique identifier of the component within the composition.
|
@@ -2576,13 +2586,13 @@ interface external$5 {
|
|
2576
2586
|
_id?: string;
|
2577
2587
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2578
2588
|
_pattern?: string;
|
2579
|
-
_dataResources?: external$
|
2589
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2580
2590
|
/**
|
2581
2591
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2582
2592
|
* Means nothing for PUTs; it will be ignored.
|
2583
2593
|
*/
|
2584
2594
|
_patternDataResources?: {
|
2585
|
-
[key: string]: external$
|
2595
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2586
2596
|
};
|
2587
2597
|
/**
|
2588
2598
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2606,7 +2616,7 @@ interface external$5 {
|
|
2606
2616
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2607
2617
|
*/
|
2608
2618
|
_overrides?: {
|
2609
|
-
[key: string]: external$
|
2619
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2610
2620
|
};
|
2611
2621
|
/**
|
2612
2622
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2615,7 +2625,7 @@ interface external$5 {
|
|
2615
2625
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2616
2626
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2617
2627
|
*/
|
2618
|
-
_overridability?: external$
|
2628
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2619
2629
|
};
|
2620
2630
|
/** @description Defines the shape of the root component in a composition */
|
2621
2631
|
RootComponentInstance: {
|
@@ -2623,15 +2633,15 @@ interface external$5 {
|
|
2623
2633
|
type: string;
|
2624
2634
|
/** @description Component parameter values for the component instance */
|
2625
2635
|
parameters?: {
|
2626
|
-
[key: string]: external$
|
2636
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2627
2637
|
};
|
2628
2638
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2629
2639
|
variant?: string;
|
2630
2640
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2631
|
-
projectMapNodes?: external$
|
2641
|
+
projectMapNodes?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2632
2642
|
/** @description Slots containing any child components */
|
2633
2643
|
slots?: {
|
2634
|
-
[key: string]: external$
|
2644
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2635
2645
|
};
|
2636
2646
|
/** @description The public UUID of the composition. */
|
2637
2647
|
_id: string;
|
@@ -2639,7 +2649,7 @@ interface external$5 {
|
|
2639
2649
|
_slug?: string | null;
|
2640
2650
|
/** @description Friendly name of this component. */
|
2641
2651
|
_name: string;
|
2642
|
-
_dataResources?: external$
|
2652
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2643
2653
|
/**
|
2644
2654
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2645
2655
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2653,7 +2663,7 @@ interface external$5 {
|
|
2653
2663
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2654
2664
|
*/
|
2655
2665
|
_overrides?: {
|
2656
|
-
[key: string]: external$
|
2666
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2657
2667
|
};
|
2658
2668
|
/**
|
2659
2669
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2662,7 +2672,7 @@ interface external$5 {
|
|
2662
2672
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2663
2673
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2664
2674
|
*/
|
2665
|
-
_overridability?: external$
|
2675
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2666
2676
|
};
|
2667
2677
|
/**
|
2668
2678
|
* @description Defines how to override a specific component.
|
@@ -2672,7 +2682,7 @@ interface external$5 {
|
|
2672
2682
|
*/
|
2673
2683
|
ComponentOverride: {
|
2674
2684
|
parameters?: {
|
2675
|
-
[key: string]: external$
|
2685
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2676
2686
|
};
|
2677
2687
|
variant?: string;
|
2678
2688
|
};
|
@@ -2686,7 +2696,7 @@ interface external$5 {
|
|
2686
2696
|
ComponentOverridability: {
|
2687
2697
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2688
2698
|
parameters?: {
|
2689
|
-
[key: string]: external$
|
2699
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2690
2700
|
};
|
2691
2701
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2692
2702
|
variants?: boolean;
|
@@ -2727,7 +2737,7 @@ interface external$5 {
|
|
2727
2737
|
}[];
|
2728
2738
|
/** @description Variables needed to make calls to the data source */
|
2729
2739
|
variables?: {
|
2730
|
-
[key: string]: external$
|
2740
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2731
2741
|
};
|
2732
2742
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2733
2743
|
custom?: {
|
@@ -2784,7 +2794,7 @@ interface external$5 {
|
|
2784
2794
|
method: "GET" | "POST" | "HEAD";
|
2785
2795
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2786
2796
|
variables?: {
|
2787
|
-
[key: string]: external$
|
2797
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2788
2798
|
};
|
2789
2799
|
/** @description Custom configuration specific to the data source being defined */
|
2790
2800
|
custom?: {
|
@@ -2812,7 +2822,7 @@ interface external$5 {
|
|
2812
2822
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2813
2823
|
*/
|
2814
2824
|
DataResourceDefinitions: {
|
2815
|
-
[key: string]: external$
|
2825
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2816
2826
|
};
|
2817
2827
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2818
2828
|
DataResourceDefinition: {
|
@@ -2826,7 +2836,7 @@ interface external$5 {
|
|
2826
2836
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2827
2837
|
*/
|
2828
2838
|
ignorePatternParameterDefault?: boolean;
|
2829
|
-
variables?: external$
|
2839
|
+
variables?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2830
2840
|
};
|
2831
2841
|
/** @description Variable values for a data resource. */
|
2832
2842
|
DataResourceVariables: {
|
@@ -2853,9 +2863,9 @@ interface external$5 {
|
|
2853
2863
|
};
|
2854
2864
|
}
|
2855
2865
|
|
2856
|
-
type DataTypeApi = paths$
|
2857
|
-
type DataSourcesApi = paths$
|
2858
|
-
type DataSourceApi = paths$
|
2866
|
+
type DataTypeApi = paths$5['/api/v1/data-types'];
|
2867
|
+
type DataSourcesApi = paths$6['/api/v1/data-sources'];
|
2868
|
+
type DataSourceApi = paths$7['/api/v1/data-source'];
|
2859
2869
|
/** Query parameter options for GET /api/v1/data-types */
|
2860
2870
|
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
2861
2871
|
/** The GET response from /api/v1/data-types */
|
@@ -2876,128 +2886,177 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
2876
2886
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
2877
2887
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
2878
2888
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
2879
|
-
type DataType = components$
|
2880
|
-
type DataSource = components$
|
2881
|
-
type DataVariableDefinition = components$
|
2889
|
+
type DataType = components$4['schemas']['DataType'];
|
2890
|
+
type DataSource = components$4['schemas']['DataSource'];
|
2891
|
+
type DataVariableDefinition = components$4['schemas']['DataVariableDefinition'];
|
2882
2892
|
|
2883
2893
|
/**
|
2884
2894
|
* This file was auto-generated by openapi-typescript.
|
2885
2895
|
* Do not make direct changes to the file.
|
2886
2896
|
*/
|
2887
|
-
interface paths$
|
2897
|
+
interface paths$4 {
|
2888
2898
|
"/api/v1/canvas": {
|
2889
2899
|
get: {
|
2890
2900
|
parameters: {
|
2891
2901
|
query: {
|
2892
|
-
/**
|
2893
|
-
|
2894
|
-
|
2895
|
-
|
2896
|
-
|
2897
|
-
|
2902
|
+
/**
|
2903
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
2904
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2905
|
+
*/
|
2906
|
+
compositionId?: components$3["parameters"]["compositionId"];
|
2907
|
+
/**
|
2908
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
2909
|
+
* Must be used with the `compositionId` parameter.
|
2910
|
+
*/
|
2911
|
+
versionId?: components$3["parameters"]["versionId"];
|
2912
|
+
/**
|
2913
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
2914
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2915
|
+
*/
|
2916
|
+
compositionIDs?: components$3["parameters"]["compositionIDs"];
|
2917
|
+
/**
|
2918
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
2919
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2920
|
+
*/
|
2921
|
+
createdBy?: components$3["parameters"]["createdBy"];
|
2898
2922
|
/**
|
2899
2923
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2900
2924
|
* NOT a full text search; does not match composition contents.
|
2925
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2901
2926
|
*/
|
2902
|
-
keyword?: components$
|
2903
|
-
/**
|
2904
|
-
|
2905
|
-
|
2906
|
-
|
2907
|
-
|
2908
|
-
|
2927
|
+
keyword?: components$3["parameters"]["keyword"];
|
2928
|
+
/**
|
2929
|
+
* Max number of records to return
|
2930
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2931
|
+
*/
|
2932
|
+
limit?: components$3["parameters"]["limit"];
|
2933
|
+
/**
|
2934
|
+
* Number of records to skip
|
2935
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2936
|
+
*/
|
2937
|
+
offset?: components$3["parameters"]["offset"];
|
2938
|
+
/**
|
2939
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
2940
|
+
* When using primary query parameters, this parameter is ignored.
|
2941
|
+
*/
|
2942
|
+
orderBy?: components$3["parameters"]["orderBy"];
|
2909
2943
|
/**
|
2910
2944
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2911
2945
|
* If true, only pattern compositions will be returned.
|
2912
2946
|
* If false, only regular compositions will be returned.
|
2913
2947
|
* If omitted, both pattern and regular compositions will be returned.
|
2948
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2914
2949
|
*/
|
2915
|
-
pattern?: components$
|
2950
|
+
pattern?: components$3["parameters"]["pattern"];
|
2916
2951
|
/** The project the composition(s) are on. */
|
2917
|
-
projectId: components$
|
2918
|
-
/**
|
2919
|
-
|
2920
|
-
|
2921
|
-
|
2922
|
-
|
2923
|
-
|
2952
|
+
projectId: components$3["parameters"]["projectId"];
|
2953
|
+
/**
|
2954
|
+
* Specify a project map ID to fetch by path or node ID from.
|
2955
|
+
* If not specified, the default project map for the projectId is used.
|
2956
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
2957
|
+
*/
|
2958
|
+
projectMapId?: components$3["parameters"]["projectMapId"];
|
2959
|
+
/**
|
2960
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
2961
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2962
|
+
*/
|
2963
|
+
projectMapNodeId?: components$3["parameters"]["projectMapNodeId"];
|
2964
|
+
/**
|
2965
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
2966
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2967
|
+
*/
|
2968
|
+
projectMapNodePath?: components$3["parameters"]["projectMapNodePath"];
|
2924
2969
|
/**
|
2925
2970
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2926
2971
|
* This improves performance if you do not require enhanced component data.
|
2927
2972
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2928
2973
|
*/
|
2929
|
-
skipEnhance?: components$
|
2974
|
+
skipEnhance?: components$3["parameters"]["skipEnhance"];
|
2930
2975
|
/**
|
2931
2976
|
* If true, any pattern references in the composition will be left unresolved.
|
2932
2977
|
* This is appropriate if you intend to serialize the composition without patterns
|
2933
2978
|
* embedded into it, and serialize the pattern data separately.
|
2934
2979
|
*/
|
2935
|
-
skipPatternResolution?: components$
|
2980
|
+
skipPatternResolution?: components$3["parameters"]["skipPatternResolution"];
|
2936
2981
|
/** @deprecated This parameter is unused and has no effect. Passing this parameter will become an error in the future. */
|
2937
|
-
skipParameterResolution?: components$
|
2982
|
+
skipParameterResolution?: components$3["parameters"]["skipParameterResolution"];
|
2938
2983
|
/**
|
2939
2984
|
* If true, any pattern override data is not resolved by the API.
|
2940
2985
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2941
2986
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2942
2987
|
*/
|
2943
|
-
skipOverridesResolution?: components$
|
2944
|
-
/**
|
2945
|
-
|
2946
|
-
|
2947
|
-
|
2948
|
-
|
2949
|
-
|
2988
|
+
skipOverridesResolution?: components$3["parameters"]["skipOverridesResolution"];
|
2989
|
+
/**
|
2990
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
2991
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2992
|
+
*/
|
2993
|
+
slug?: components$3["parameters"]["slug"];
|
2994
|
+
/**
|
2995
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
2996
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2997
|
+
*/
|
2998
|
+
state?: components$3["parameters"]["state"];
|
2999
|
+
/**
|
3000
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
3001
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3002
|
+
*/
|
3003
|
+
type?: components$3["parameters"]["type"];
|
2950
3004
|
/**
|
2951
3005
|
* @deprecated Filters composition lists by the UI status of the composition.
|
2952
3006
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
3007
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2953
3008
|
*/
|
2954
|
-
uiStatus?: components$
|
3009
|
+
uiStatus?: components$3["parameters"]["uiStatus"];
|
2955
3010
|
/**
|
2956
3011
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
2957
3012
|
* in case of FALSE. If not specified - no filtration applied.
|
3013
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3014
|
+
*/
|
3015
|
+
attachedToProjectMap?: components$3["parameters"]["attachedToProjectMap"];
|
3016
|
+
/**
|
3017
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
3018
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2958
3019
|
*/
|
2959
|
-
|
2960
|
-
/** Filters composition lists by the user who last updated them. The user is specified by their identity subject. */
|
2961
|
-
updatedBy?: components$2["parameters"]["updatedBy"];
|
3020
|
+
updatedBy?: components$3["parameters"]["updatedBy"];
|
2962
3021
|
/**
|
2963
3022
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2964
3023
|
* If false, the `_id` will not be present in the API response.
|
2965
3024
|
*/
|
2966
|
-
withComponentIDs?: components$
|
3025
|
+
withComponentIDs?: components$3["parameters"]["withComponentIDs"];
|
2967
3026
|
/**
|
2968
3027
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2969
3028
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2970
3029
|
*/
|
2971
|
-
withTotalCount?: components$
|
3030
|
+
withTotalCount?: components$3["parameters"]["withTotalCount"];
|
2972
3031
|
/**
|
2973
3032
|
* @deprecated Returns the UI status string of the composition.
|
2974
3033
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2975
3034
|
*/
|
2976
|
-
withUIStatus?: components$
|
3035
|
+
withUIStatus?: components$3["parameters"]["withUIStatus"];
|
2977
3036
|
/** Includes project map node information in the composition results */
|
2978
|
-
withProjectMapNodes?: components$
|
3037
|
+
withProjectMapNodes?: components$3["parameters"]["withProjectMapNodes"];
|
2979
3038
|
/** @deprecated Includes content source map metadata on supported parameters */
|
2980
|
-
withContentSourceMap?: components$
|
3039
|
+
withContentSourceMap?: components$3["parameters"]["withContentSourceMap"];
|
2981
3040
|
};
|
2982
3041
|
};
|
2983
3042
|
responses: {
|
2984
3043
|
/** OK */
|
2985
3044
|
200: {
|
2986
3045
|
content: {
|
2987
|
-
"application/json": components$
|
3046
|
+
"application/json": components$3["schemas"]["CompositionListResponse"] | components$3["schemas"]["CompositionApiResponse"];
|
2988
3047
|
};
|
2989
3048
|
};
|
2990
|
-
400: external$
|
2991
|
-
401: external$
|
2992
|
-
403: external$
|
3049
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3050
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3051
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2993
3052
|
/** Composition not found */
|
2994
3053
|
404: {
|
2995
3054
|
content: {
|
2996
3055
|
"text/plain": string;
|
2997
3056
|
};
|
2998
3057
|
};
|
2999
|
-
429: external$
|
3000
|
-
500: external$
|
3058
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3059
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3001
3060
|
};
|
3002
3061
|
};
|
3003
3062
|
/** Upserts a composition */
|
@@ -3005,11 +3064,11 @@ interface paths$3 {
|
|
3005
3064
|
responses: {
|
3006
3065
|
/** OK */
|
3007
3066
|
204: never;
|
3008
|
-
400: external$
|
3009
|
-
401: external$
|
3010
|
-
403: external$
|
3011
|
-
429: external$
|
3012
|
-
500: external$
|
3067
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3068
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3069
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3070
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3071
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3013
3072
|
};
|
3014
3073
|
requestBody: {
|
3015
3074
|
content: {
|
@@ -3021,7 +3080,7 @@ interface paths$3 {
|
|
3021
3080
|
projectId: string;
|
3022
3081
|
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
3023
3082
|
state: number;
|
3024
|
-
composition: external$
|
3083
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
3025
3084
|
/**
|
3026
3085
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
3027
3086
|
* @default false
|
@@ -3040,11 +3099,11 @@ interface paths$3 {
|
|
3040
3099
|
responses: {
|
3041
3100
|
/** OK */
|
3042
3101
|
204: never;
|
3043
|
-
400: external$
|
3044
|
-
401: external$
|
3045
|
-
403: external$
|
3046
|
-
429: external$
|
3047
|
-
500: external$
|
3102
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3103
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3104
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3105
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3106
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3048
3107
|
};
|
3049
3108
|
requestBody: {
|
3050
3109
|
content: {
|
@@ -3074,7 +3133,7 @@ interface paths$3 {
|
|
3074
3133
|
};
|
3075
3134
|
};
|
3076
3135
|
}
|
3077
|
-
interface components$
|
3136
|
+
interface components$3 {
|
3078
3137
|
schemas: {
|
3079
3138
|
CompositionApiResponse: {
|
3080
3139
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -3084,7 +3143,7 @@ interface components$2 {
|
|
3084
3143
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
3085
3144
|
* @enum {string}
|
3086
3145
|
*/
|
3087
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
3146
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
3088
3147
|
/**
|
3089
3148
|
* Format: uuid
|
3090
3149
|
* @description The project ID that this layout data is part of
|
@@ -3102,10 +3161,10 @@ interface components$2 {
|
|
3102
3161
|
modified: string;
|
3103
3162
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
3104
3163
|
pattern: boolean;
|
3105
|
-
composition: external$
|
3164
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
3106
3165
|
};
|
3107
3166
|
CompositionListResponse: {
|
3108
|
-
compositions: components$
|
3167
|
+
compositions: components$3["schemas"]["CompositionApiResponse"][];
|
3109
3168
|
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
3110
3169
|
totalCount?: number;
|
3111
3170
|
};
|
@@ -3113,25 +3172,61 @@ interface components$2 {
|
|
3113
3172
|
parameters: {
|
3114
3173
|
/** @description The project the composition(s) are on. */
|
3115
3174
|
projectId: string;
|
3116
|
-
/**
|
3175
|
+
/**
|
3176
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
3177
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3178
|
+
*/
|
3117
3179
|
compositionId: string;
|
3118
|
-
/**
|
3180
|
+
/**
|
3181
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
3182
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3183
|
+
*/
|
3119
3184
|
compositionIDs: string[];
|
3120
|
-
/**
|
3185
|
+
/**
|
3186
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
3187
|
+
* Must be used with the `compositionId` parameter.
|
3188
|
+
*/
|
3189
|
+
versionId: string;
|
3190
|
+
/**
|
3191
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
3192
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3193
|
+
*/
|
3121
3194
|
slug: string;
|
3122
|
-
/**
|
3195
|
+
/**
|
3196
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
3197
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3198
|
+
*/
|
3123
3199
|
projectMapNodeId: string;
|
3124
|
-
/**
|
3200
|
+
/**
|
3201
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
3202
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3203
|
+
*/
|
3125
3204
|
projectMapNodePath: string;
|
3126
|
-
/**
|
3205
|
+
/**
|
3206
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
3207
|
+
* If not specified, the default project map for the projectId is used.
|
3208
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
3209
|
+
*/
|
3127
3210
|
projectMapId: string;
|
3128
|
-
/**
|
3211
|
+
/**
|
3212
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
3213
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3214
|
+
*/
|
3129
3215
|
type: string[];
|
3130
|
-
/**
|
3216
|
+
/**
|
3217
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
3218
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3219
|
+
*/
|
3131
3220
|
state: number;
|
3132
|
-
/**
|
3221
|
+
/**
|
3222
|
+
* @description Number of records to skip
|
3223
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3224
|
+
*/
|
3133
3225
|
offset: number;
|
3134
|
-
/**
|
3226
|
+
/**
|
3227
|
+
* @description Max number of records to return
|
3228
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3229
|
+
*/
|
3135
3230
|
limit: number;
|
3136
3231
|
/**
|
3137
3232
|
* @deprecated
|
@@ -3165,6 +3260,7 @@ interface components$2 {
|
|
3165
3260
|
/**
|
3166
3261
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
3167
3262
|
* NOT a full text search; does not match composition contents.
|
3263
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3168
3264
|
*/
|
3169
3265
|
keyword: string;
|
3170
3266
|
/**
|
@@ -3172,9 +3268,13 @@ interface components$2 {
|
|
3172
3268
|
* If true, only pattern compositions will be returned.
|
3173
3269
|
* If false, only regular compositions will be returned.
|
3174
3270
|
* If omitted, both pattern and regular compositions will be returned.
|
3271
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3175
3272
|
*/
|
3176
3273
|
pattern: boolean;
|
3177
|
-
/**
|
3274
|
+
/**
|
3275
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
3276
|
+
* When using primary query parameters, this parameter is ignored.
|
3277
|
+
*/
|
3178
3278
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
3179
3279
|
/**
|
3180
3280
|
* @deprecated
|
@@ -3186,11 +3286,13 @@ interface components$2 {
|
|
3186
3286
|
* @deprecated
|
3187
3287
|
* @description Filters composition lists by the UI status of the composition.
|
3188
3288
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
3289
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3189
3290
|
*/
|
3190
3291
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
3191
3292
|
/**
|
3192
3293
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
3193
3294
|
* in case of FALSE. If not specified - no filtration applied.
|
3295
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3194
3296
|
*/
|
3195
3297
|
attachedToProjectMap: boolean;
|
3196
3298
|
/** @description Includes project map node information in the composition results */
|
@@ -3200,9 +3302,15 @@ interface components$2 {
|
|
3200
3302
|
* @description Includes content source map metadata on supported parameters
|
3201
3303
|
*/
|
3202
3304
|
withContentSourceMap: boolean;
|
3203
|
-
/**
|
3305
|
+
/**
|
3306
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
3307
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3308
|
+
*/
|
3204
3309
|
createdBy: string;
|
3205
|
-
/**
|
3310
|
+
/**
|
3311
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
3312
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3313
|
+
*/
|
3206
3314
|
updatedBy: string;
|
3207
3315
|
/**
|
3208
3316
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -3211,7 +3319,7 @@ interface components$2 {
|
|
3211
3319
|
withTotalCount: boolean;
|
3212
3320
|
};
|
3213
3321
|
}
|
3214
|
-
interface external$
|
3322
|
+
interface external$5 {
|
3215
3323
|
"swagger.yml": {
|
3216
3324
|
paths: {};
|
3217
3325
|
components: {
|
@@ -3225,25 +3333,25 @@ interface external$4 {
|
|
3225
3333
|
/** Request input validation failed */
|
3226
3334
|
BadRequestError: {
|
3227
3335
|
content: {
|
3228
|
-
"application/json": external$
|
3336
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3229
3337
|
};
|
3230
3338
|
};
|
3231
3339
|
/** API key or token was not valid */
|
3232
3340
|
UnauthorizedError: {
|
3233
3341
|
content: {
|
3234
|
-
"application/json": external$
|
3342
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3235
3343
|
};
|
3236
3344
|
};
|
3237
3345
|
/** Permission was denied */
|
3238
3346
|
ForbiddenError: {
|
3239
3347
|
content: {
|
3240
|
-
"application/json": external$
|
3348
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3241
3349
|
};
|
3242
3350
|
};
|
3243
3351
|
/** Resource not found */
|
3244
3352
|
NotFoundError: {
|
3245
3353
|
content: {
|
3246
|
-
"application/json": external$
|
3354
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3247
3355
|
};
|
3248
3356
|
};
|
3249
3357
|
/** Too many requests in allowed time period */
|
@@ -3262,7 +3370,7 @@ interface external$4 {
|
|
3262
3370
|
PublicIdProperty: string;
|
3263
3371
|
/** @description The definition of a component parameter */
|
3264
3372
|
ComponentDefinitionParameter: {
|
3265
|
-
id: external$
|
3373
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3266
3374
|
/** @description Friendly name of the parameter */
|
3267
3375
|
name: string;
|
3268
3376
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -3274,7 +3382,7 @@ interface external$4 {
|
|
3274
3382
|
};
|
3275
3383
|
/** @description The definition of a named component slot that can contain other components */
|
3276
3384
|
ComponentDefinitionSlot: {
|
3277
|
-
id: external$
|
3385
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3278
3386
|
/** @description Friendly name of the slot */
|
3279
3387
|
name: string;
|
3280
3388
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -3332,13 +3440,13 @@ interface external$4 {
|
|
3332
3440
|
};
|
3333
3441
|
/** @description The definition of a component variant */
|
3334
3442
|
ComponentDefinitionVariant: {
|
3335
|
-
id: external$
|
3443
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3336
3444
|
/** @description Friendly name of the variant */
|
3337
3445
|
name: string;
|
3338
3446
|
};
|
3339
3447
|
/** @description Permission set for a component defintion */
|
3340
3448
|
ComponentDefinitionPermission: {
|
3341
|
-
roleId: external$
|
3449
|
+
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3342
3450
|
/**
|
3343
3451
|
* @description Permission type for this permission ComponentDefinition:
|
3344
3452
|
* read | write | create | delete
|
@@ -3351,7 +3459,7 @@ interface external$4 {
|
|
3351
3459
|
};
|
3352
3460
|
/** @description Defines a component type that can live on a Composition */
|
3353
3461
|
ComponentDefinition: {
|
3354
|
-
id: external$
|
3462
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3355
3463
|
/** @description Friendly name of the component definition */
|
3356
3464
|
name: string;
|
3357
3465
|
/**
|
@@ -3362,6 +3470,8 @@ interface external$4 {
|
|
3362
3470
|
/**
|
3363
3471
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
3364
3472
|
* The parameter type must support being used as a title parameter for this to work.
|
3473
|
+
*
|
3474
|
+
* @default null
|
3365
3475
|
*/
|
3366
3476
|
titleParameter?: string | null;
|
3367
3477
|
/**
|
@@ -3370,21 +3480,21 @@ interface external$4 {
|
|
3370
3480
|
*/
|
3371
3481
|
canBeComposition?: boolean;
|
3372
3482
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
3373
|
-
parameters?: external$
|
3483
|
+
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3374
3484
|
/**
|
3375
3485
|
* @description if this component uses team permissions or custom permissions
|
3376
3486
|
* @default true
|
3377
3487
|
*/
|
3378
3488
|
useTeamPermissions?: boolean;
|
3379
3489
|
/** @description Custom role permissions for this component definition */
|
3380
|
-
permissions?: external$
|
3490
|
+
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
3381
3491
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
3382
|
-
slots?: external$
|
3383
|
-
slugSettings?: external$
|
3492
|
+
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3493
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3384
3494
|
/** @description Default component instance value */
|
3385
|
-
defaults?: external$
|
3495
|
+
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
3386
3496
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
3387
|
-
variants?: external$
|
3497
|
+
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
3388
3498
|
/** @description Created date string for this definition (ignored for writes) */
|
3389
3499
|
created?: string;
|
3390
3500
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -3392,7 +3502,7 @@ interface external$4 {
|
|
3392
3502
|
};
|
3393
3503
|
/** @description Defines a content type */
|
3394
3504
|
ContentType: {
|
3395
|
-
id: external$
|
3505
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3396
3506
|
/** @description Friendly name of the content type */
|
3397
3507
|
name: string;
|
3398
3508
|
/**
|
@@ -3401,7 +3511,7 @@ interface external$4 {
|
|
3401
3511
|
*/
|
3402
3512
|
titleField?: string | null;
|
3403
3513
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3404
|
-
fields?: external$
|
3514
|
+
fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3405
3515
|
/** @description Created date string for this content type (ignored for writes) */
|
3406
3516
|
created?: string;
|
3407
3517
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -3413,7 +3523,7 @@ interface external$4 {
|
|
3413
3523
|
value: unknown;
|
3414
3524
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
3415
3525
|
type: string;
|
3416
|
-
connectedData?: external$
|
3526
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3417
3527
|
};
|
3418
3528
|
/**
|
3419
3529
|
* @description Defines a connection to a data element on a data resource.
|
@@ -3436,13 +3546,13 @@ interface external$4 {
|
|
3436
3546
|
type: string;
|
3437
3547
|
/** @description Component parameter values for the component instance */
|
3438
3548
|
parameters?: {
|
3439
|
-
[key: string]: external$
|
3549
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3440
3550
|
};
|
3441
3551
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3442
3552
|
variant?: string;
|
3443
3553
|
/** @description Slots containing any child components */
|
3444
3554
|
slots?: {
|
3445
|
-
[key: string]: external$
|
3555
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3446
3556
|
};
|
3447
3557
|
/**
|
3448
3558
|
* @description Unique identifier of the component within the composition.
|
@@ -3452,13 +3562,13 @@ interface external$4 {
|
|
3452
3562
|
_id?: string;
|
3453
3563
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3454
3564
|
_pattern?: string;
|
3455
|
-
_dataResources?: external$
|
3565
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3456
3566
|
/**
|
3457
3567
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3458
3568
|
* Means nothing for PUTs; it will be ignored.
|
3459
3569
|
*/
|
3460
3570
|
_patternDataResources?: {
|
3461
|
-
[key: string]: external$
|
3571
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3462
3572
|
};
|
3463
3573
|
/**
|
3464
3574
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -3482,7 +3592,7 @@ interface external$4 {
|
|
3482
3592
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3483
3593
|
*/
|
3484
3594
|
_overrides?: {
|
3485
|
-
[key: string]: external$
|
3595
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3486
3596
|
};
|
3487
3597
|
/**
|
3488
3598
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -3491,7 +3601,7 @@ interface external$4 {
|
|
3491
3601
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3492
3602
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3493
3603
|
*/
|
3494
|
-
_overridability?: external$
|
3604
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3495
3605
|
};
|
3496
3606
|
/** @description Defines the shape of the root component in a composition */
|
3497
3607
|
RootComponentInstance: {
|
@@ -3499,15 +3609,15 @@ interface external$4 {
|
|
3499
3609
|
type: string;
|
3500
3610
|
/** @description Component parameter values for the component instance */
|
3501
3611
|
parameters?: {
|
3502
|
-
[key: string]: external$
|
3612
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3503
3613
|
};
|
3504
3614
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3505
3615
|
variant?: string;
|
3506
3616
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
3507
|
-
projectMapNodes?: external$
|
3617
|
+
projectMapNodes?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
3508
3618
|
/** @description Slots containing any child components */
|
3509
3619
|
slots?: {
|
3510
|
-
[key: string]: external$
|
3620
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3511
3621
|
};
|
3512
3622
|
/** @description The public UUID of the composition. */
|
3513
3623
|
_id: string;
|
@@ -3515,7 +3625,7 @@ interface external$4 {
|
|
3515
3625
|
_slug?: string | null;
|
3516
3626
|
/** @description Friendly name of this component. */
|
3517
3627
|
_name: string;
|
3518
|
-
_dataResources?: external$
|
3628
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3519
3629
|
/**
|
3520
3630
|
* @description Defines patch overrides to component IDs that live in the composition.
|
3521
3631
|
* This can be used to override parameters that are defined on patterns,
|
@@ -3529,7 +3639,7 @@ interface external$4 {
|
|
3529
3639
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3530
3640
|
*/
|
3531
3641
|
_overrides?: {
|
3532
|
-
[key: string]: external$
|
3642
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3533
3643
|
};
|
3534
3644
|
/**
|
3535
3645
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -3538,7 +3648,7 @@ interface external$4 {
|
|
3538
3648
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3539
3649
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3540
3650
|
*/
|
3541
|
-
_overridability?: external$
|
3651
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3542
3652
|
};
|
3543
3653
|
/**
|
3544
3654
|
* @description Defines how to override a specific component.
|
@@ -3548,7 +3658,7 @@ interface external$4 {
|
|
3548
3658
|
*/
|
3549
3659
|
ComponentOverride: {
|
3550
3660
|
parameters?: {
|
3551
|
-
[key: string]: external$
|
3661
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3552
3662
|
};
|
3553
3663
|
variant?: string;
|
3554
3664
|
};
|
@@ -3562,7 +3672,7 @@ interface external$4 {
|
|
3562
3672
|
ComponentOverridability: {
|
3563
3673
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3564
3674
|
parameters?: {
|
3565
|
-
[key: string]: external$
|
3675
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3566
3676
|
};
|
3567
3677
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3568
3678
|
variants?: boolean;
|
@@ -3603,7 +3713,7 @@ interface external$4 {
|
|
3603
3713
|
}[];
|
3604
3714
|
/** @description Variables needed to make calls to the data source */
|
3605
3715
|
variables?: {
|
3606
|
-
[key: string]: external$
|
3716
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3607
3717
|
};
|
3608
3718
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
3609
3719
|
custom?: {
|
@@ -3660,7 +3770,7 @@ interface external$4 {
|
|
3660
3770
|
method: "GET" | "POST" | "HEAD";
|
3661
3771
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
3662
3772
|
variables?: {
|
3663
|
-
[key: string]: external$
|
3773
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3664
3774
|
};
|
3665
3775
|
/** @description Custom configuration specific to the data source being defined */
|
3666
3776
|
custom?: {
|
@@ -3688,7 +3798,7 @@ interface external$4 {
|
|
3688
3798
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3689
3799
|
*/
|
3690
3800
|
DataResourceDefinitions: {
|
3691
|
-
[key: string]: external$
|
3801
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3692
3802
|
};
|
3693
3803
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3694
3804
|
DataResourceDefinition: {
|
@@ -3702,7 +3812,7 @@ interface external$4 {
|
|
3702
3812
|
* If isPatternParameter is false or undefined, this has no meaning.
|
3703
3813
|
*/
|
3704
3814
|
ignorePatternParameterDefault?: boolean;
|
3705
|
-
variables?: external$
|
3815
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3706
3816
|
};
|
3707
3817
|
/** @description Variable values for a data resource. */
|
3708
3818
|
DataResourceVariables: {
|
@@ -3729,6 +3839,116 @@ interface external$4 {
|
|
3729
3839
|
};
|
3730
3840
|
}
|
3731
3841
|
|
3842
|
+
/**
|
3843
|
+
* This file was auto-generated by openapi-typescript.
|
3844
|
+
* Do not make direct changes to the file.
|
3845
|
+
*/
|
3846
|
+
interface paths$3 {
|
3847
|
+
"/api/v1/canvas-history": {
|
3848
|
+
get: {
|
3849
|
+
parameters: {
|
3850
|
+
query: {
|
3851
|
+
/** Specify the composition ID to get history for */
|
3852
|
+
compositionId: string;
|
3853
|
+
/** The project the composition(s) are on. */
|
3854
|
+
projectId: string;
|
3855
|
+
/** If a request returns a cursor, pass it in this query parameter to get the next page of results. */
|
3856
|
+
cursor?: string;
|
3857
|
+
};
|
3858
|
+
};
|
3859
|
+
responses: {
|
3860
|
+
/** OK */
|
3861
|
+
200: {
|
3862
|
+
content: {
|
3863
|
+
"application/json": components$2["schemas"]["ComponentInstanceHistoryApiResponse"];
|
3864
|
+
};
|
3865
|
+
};
|
3866
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3867
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3868
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3869
|
+
/** Composition not found */
|
3870
|
+
404: {
|
3871
|
+
content: {
|
3872
|
+
"text/plain": string;
|
3873
|
+
};
|
3874
|
+
};
|
3875
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3876
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3877
|
+
};
|
3878
|
+
};
|
3879
|
+
};
|
3880
|
+
}
|
3881
|
+
interface components$2 {
|
3882
|
+
schemas: {
|
3883
|
+
ComponentInstanceHistoryApiResponse: {
|
3884
|
+
/**
|
3885
|
+
* @description If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
|
3886
|
+
* If this is undefined then no more results are available.
|
3887
|
+
*/
|
3888
|
+
cursor?: string;
|
3889
|
+
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
3890
|
+
truncated?: boolean;
|
3891
|
+
/** @description Version history entries. */
|
3892
|
+
results?: components$2["schemas"]["ComponentInstanceHistoryEntry"][];
|
3893
|
+
};
|
3894
|
+
ComponentInstanceHistoryEntry: {
|
3895
|
+
/** @description The version ID of the component instance. This can be used to fetch the version's data via the composition API. */
|
3896
|
+
versionId: string;
|
3897
|
+
/** @description The timestamp when the version was created in epoch milliseconds. */
|
3898
|
+
timestamp: number;
|
3899
|
+
/** @description The name (full name) of the user who created the version. */
|
3900
|
+
authorName: string;
|
3901
|
+
authorIsApiKey: boolean;
|
3902
|
+
/** @description The state of the component instance when the history entry was made. */
|
3903
|
+
state: number;
|
3904
|
+
};
|
3905
|
+
};
|
3906
|
+
}
|
3907
|
+
interface external$4 {
|
3908
|
+
"swagger.yml": {
|
3909
|
+
paths: {};
|
3910
|
+
components: {
|
3911
|
+
schemas: {
|
3912
|
+
Error: {
|
3913
|
+
/** @description Error message(s) that occurred while processing the request */
|
3914
|
+
errorMessage?: string[] | string;
|
3915
|
+
};
|
3916
|
+
};
|
3917
|
+
responses: {
|
3918
|
+
/** Request input validation failed */
|
3919
|
+
BadRequestError: {
|
3920
|
+
content: {
|
3921
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3922
|
+
};
|
3923
|
+
};
|
3924
|
+
/** API key or token was not valid */
|
3925
|
+
UnauthorizedError: {
|
3926
|
+
content: {
|
3927
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3928
|
+
};
|
3929
|
+
};
|
3930
|
+
/** Permission was denied */
|
3931
|
+
ForbiddenError: {
|
3932
|
+
content: {
|
3933
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3934
|
+
};
|
3935
|
+
};
|
3936
|
+
/** Resource not found */
|
3937
|
+
NotFoundError: {
|
3938
|
+
content: {
|
3939
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3940
|
+
};
|
3941
|
+
};
|
3942
|
+
/** Too many requests in allowed time period */
|
3943
|
+
RateLimitError: unknown;
|
3944
|
+
/** Execution error occurred */
|
3945
|
+
InternalServerError: unknown;
|
3946
|
+
};
|
3947
|
+
};
|
3948
|
+
operations: {};
|
3949
|
+
};
|
3950
|
+
}
|
3951
|
+
|
3732
3952
|
interface components$1 {
|
3733
3953
|
schemas: {
|
3734
3954
|
CompositionResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
@@ -4051,6 +4271,8 @@ interface external$3 {
|
|
4051
4271
|
/**
|
4052
4272
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
4053
4273
|
* The parameter type must support being used as a title parameter for this to work.
|
4274
|
+
*
|
4275
|
+
* @default null
|
4054
4276
|
*/
|
4055
4277
|
titleParameter?: string | null;
|
4056
4278
|
/**
|
@@ -4422,37 +4644,72 @@ interface external$3 {
|
|
4422
4644
|
get: {
|
4423
4645
|
parameters: {
|
4424
4646
|
query: {
|
4425
|
-
/**
|
4647
|
+
/**
|
4648
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
4649
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4650
|
+
*/
|
4426
4651
|
compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
4427
|
-
/**
|
4652
|
+
/**
|
4653
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
4654
|
+
* Must be used with the `compositionId` parameter.
|
4655
|
+
*/
|
4656
|
+
versionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
|
4657
|
+
/**
|
4658
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
4659
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4660
|
+
*/
|
4428
4661
|
compositionIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
4429
|
-
/**
|
4662
|
+
/**
|
4663
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
4664
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4665
|
+
*/
|
4430
4666
|
createdBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
4431
4667
|
/**
|
4432
4668
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
4433
4669
|
* NOT a full text search; does not match composition contents.
|
4670
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4434
4671
|
*/
|
4435
4672
|
keyword?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
4436
|
-
/**
|
4673
|
+
/**
|
4674
|
+
* Max number of records to return
|
4675
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4676
|
+
*/
|
4437
4677
|
limit?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
4438
|
-
/**
|
4678
|
+
/**
|
4679
|
+
* Number of records to skip
|
4680
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4681
|
+
*/
|
4439
4682
|
offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
4440
|
-
/**
|
4683
|
+
/**
|
4684
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
4685
|
+
* When using primary query parameters, this parameter is ignored.
|
4686
|
+
*/
|
4441
4687
|
orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
4442
4688
|
/**
|
4443
4689
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
4444
4690
|
* If true, only pattern compositions will be returned.
|
4445
4691
|
* If false, only regular compositions will be returned.
|
4446
4692
|
* If omitted, both pattern and regular compositions will be returned.
|
4693
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4447
4694
|
*/
|
4448
4695
|
pattern?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
4449
4696
|
/** The project the composition(s) are on. */
|
4450
4697
|
projectId: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
4451
|
-
/**
|
4698
|
+
/**
|
4699
|
+
* Specify a project map ID to fetch by path or node ID from.
|
4700
|
+
* If not specified, the default project map for the projectId is used.
|
4701
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
4702
|
+
*/
|
4452
4703
|
projectMapId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
4453
|
-
/**
|
4704
|
+
/**
|
4705
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
4706
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4707
|
+
*/
|
4454
4708
|
projectMapNodeId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
4455
|
-
/**
|
4709
|
+
/**
|
4710
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
4711
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4712
|
+
*/
|
4456
4713
|
projectMapNodePath?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
4457
4714
|
/**
|
4458
4715
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
@@ -4474,23 +4731,37 @@ interface external$3 {
|
|
4474
4731
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
4475
4732
|
*/
|
4476
4733
|
skipOverridesResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
4477
|
-
/**
|
4734
|
+
/**
|
4735
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
4736
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4737
|
+
*/
|
4478
4738
|
slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
4479
|
-
/**
|
4739
|
+
/**
|
4740
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
4741
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4742
|
+
*/
|
4480
4743
|
state?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
4481
|
-
/**
|
4744
|
+
/**
|
4745
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
4746
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4747
|
+
*/
|
4482
4748
|
type?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
4483
4749
|
/**
|
4484
4750
|
* @deprecated Filters composition lists by the UI status of the composition.
|
4485
4751
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
4752
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4486
4753
|
*/
|
4487
4754
|
uiStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
4488
4755
|
/**
|
4489
4756
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
4490
4757
|
* in case of FALSE. If not specified - no filtration applied.
|
4758
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4491
4759
|
*/
|
4492
4760
|
attachedToProjectMap?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
4493
|
-
/**
|
4761
|
+
/**
|
4762
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
4763
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4764
|
+
*/
|
4494
4765
|
updatedBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
4495
4766
|
/**
|
4496
4767
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
@@ -4617,7 +4888,7 @@ interface external$3 {
|
|
4617
4888
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
4618
4889
|
* @enum {string}
|
4619
4890
|
*/
|
4620
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
4891
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
4621
4892
|
/**
|
4622
4893
|
* Format: uuid
|
4623
4894
|
* @description The project ID that this layout data is part of
|
@@ -4646,25 +4917,61 @@ interface external$3 {
|
|
4646
4917
|
parameters: {
|
4647
4918
|
/** @description The project the composition(s) are on. */
|
4648
4919
|
projectId: string;
|
4649
|
-
/**
|
4920
|
+
/**
|
4921
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
4922
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4923
|
+
*/
|
4650
4924
|
compositionId: string;
|
4651
|
-
/**
|
4925
|
+
/**
|
4926
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
4927
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4928
|
+
*/
|
4652
4929
|
compositionIDs: string[];
|
4653
|
-
/**
|
4930
|
+
/**
|
4931
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
4932
|
+
* Must be used with the `compositionId` parameter.
|
4933
|
+
*/
|
4934
|
+
versionId: string;
|
4935
|
+
/**
|
4936
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
4937
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4938
|
+
*/
|
4654
4939
|
slug: string;
|
4655
|
-
/**
|
4940
|
+
/**
|
4941
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
4942
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4943
|
+
*/
|
4656
4944
|
projectMapNodeId: string;
|
4657
|
-
/**
|
4945
|
+
/**
|
4946
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
4947
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4948
|
+
*/
|
4658
4949
|
projectMapNodePath: string;
|
4659
|
-
/**
|
4950
|
+
/**
|
4951
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
4952
|
+
* If not specified, the default project map for the projectId is used.
|
4953
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
4954
|
+
*/
|
4660
4955
|
projectMapId: string;
|
4661
|
-
/**
|
4956
|
+
/**
|
4957
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
4958
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4959
|
+
*/
|
4662
4960
|
type: string[];
|
4663
|
-
/**
|
4961
|
+
/**
|
4962
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
4963
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4964
|
+
*/
|
4664
4965
|
state: number;
|
4665
|
-
/**
|
4966
|
+
/**
|
4967
|
+
* @description Number of records to skip
|
4968
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4969
|
+
*/
|
4666
4970
|
offset: number;
|
4667
|
-
/**
|
4971
|
+
/**
|
4972
|
+
* @description Max number of records to return
|
4973
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4974
|
+
*/
|
4668
4975
|
limit: number;
|
4669
4976
|
/**
|
4670
4977
|
* @deprecated
|
@@ -4698,6 +5005,7 @@ interface external$3 {
|
|
4698
5005
|
/**
|
4699
5006
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
4700
5007
|
* NOT a full text search; does not match composition contents.
|
5008
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4701
5009
|
*/
|
4702
5010
|
keyword: string;
|
4703
5011
|
/**
|
@@ -4705,9 +5013,13 @@ interface external$3 {
|
|
4705
5013
|
* If true, only pattern compositions will be returned.
|
4706
5014
|
* If false, only regular compositions will be returned.
|
4707
5015
|
* If omitted, both pattern and regular compositions will be returned.
|
5016
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4708
5017
|
*/
|
4709
5018
|
pattern: boolean;
|
4710
|
-
/**
|
5019
|
+
/**
|
5020
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
5021
|
+
* When using primary query parameters, this parameter is ignored.
|
5022
|
+
*/
|
4711
5023
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
4712
5024
|
/**
|
4713
5025
|
* @deprecated
|
@@ -4719,11 +5031,13 @@ interface external$3 {
|
|
4719
5031
|
* @deprecated
|
4720
5032
|
* @description Filters composition lists by the UI status of the composition.
|
4721
5033
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
5034
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4722
5035
|
*/
|
4723
5036
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
4724
5037
|
/**
|
4725
5038
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
4726
5039
|
* in case of FALSE. If not specified - no filtration applied.
|
5040
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4727
5041
|
*/
|
4728
5042
|
attachedToProjectMap: boolean;
|
4729
5043
|
/** @description Includes project map node information in the composition results */
|
@@ -4733,9 +5047,15 @@ interface external$3 {
|
|
4733
5047
|
* @description Includes content source map metadata on supported parameters
|
4734
5048
|
*/
|
4735
5049
|
withContentSourceMap: boolean;
|
4736
|
-
/**
|
5050
|
+
/**
|
5051
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
5052
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5053
|
+
*/
|
4737
5054
|
createdBy: string;
|
4738
|
-
/**
|
5055
|
+
/**
|
5056
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
5057
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5058
|
+
*/
|
4739
5059
|
updatedBy: string;
|
4740
5060
|
/**
|
4741
5061
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -5368,6 +5688,8 @@ interface external$2 {
|
|
5368
5688
|
/**
|
5369
5689
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
5370
5690
|
* The parameter type must support being used as a title parameter for this to work.
|
5691
|
+
*
|
5692
|
+
* @default null
|
5371
5693
|
*/
|
5372
5694
|
titleParameter?: string | null;
|
5373
5695
|
/**
|
@@ -5739,37 +6061,72 @@ interface external$2 {
|
|
5739
6061
|
get: {
|
5740
6062
|
parameters: {
|
5741
6063
|
query: {
|
5742
|
-
/**
|
6064
|
+
/**
|
6065
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
6066
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6067
|
+
*/
|
5743
6068
|
compositionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
5744
|
-
/**
|
6069
|
+
/**
|
6070
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
6071
|
+
* Must be used with the `compositionId` parameter.
|
6072
|
+
*/
|
6073
|
+
versionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
|
6074
|
+
/**
|
6075
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
6076
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6077
|
+
*/
|
5745
6078
|
compositionIDs?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
5746
|
-
/**
|
6079
|
+
/**
|
6080
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
6081
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6082
|
+
*/
|
5747
6083
|
createdBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
5748
6084
|
/**
|
5749
6085
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
5750
6086
|
* NOT a full text search; does not match composition contents.
|
6087
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5751
6088
|
*/
|
5752
6089
|
keyword?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
5753
|
-
/**
|
6090
|
+
/**
|
6091
|
+
* Max number of records to return
|
6092
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6093
|
+
*/
|
5754
6094
|
limit?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
5755
|
-
/**
|
6095
|
+
/**
|
6096
|
+
* Number of records to skip
|
6097
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6098
|
+
*/
|
5756
6099
|
offset?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
5757
|
-
/**
|
6100
|
+
/**
|
6101
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
6102
|
+
* When using primary query parameters, this parameter is ignored.
|
6103
|
+
*/
|
5758
6104
|
orderBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
5759
6105
|
/**
|
5760
6106
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
5761
6107
|
* If true, only pattern compositions will be returned.
|
5762
6108
|
* If false, only regular compositions will be returned.
|
5763
6109
|
* If omitted, both pattern and regular compositions will be returned.
|
6110
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5764
6111
|
*/
|
5765
6112
|
pattern?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
5766
6113
|
/** The project the composition(s) are on. */
|
5767
6114
|
projectId: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
5768
|
-
/**
|
6115
|
+
/**
|
6116
|
+
* Specify a project map ID to fetch by path or node ID from.
|
6117
|
+
* If not specified, the default project map for the projectId is used.
|
6118
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
6119
|
+
*/
|
5769
6120
|
projectMapId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
5770
|
-
/**
|
6121
|
+
/**
|
6122
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
6123
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6124
|
+
*/
|
5771
6125
|
projectMapNodeId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
5772
|
-
/**
|
6126
|
+
/**
|
6127
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
6128
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6129
|
+
*/
|
5773
6130
|
projectMapNodePath?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
5774
6131
|
/**
|
5775
6132
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
@@ -5791,23 +6148,37 @@ interface external$2 {
|
|
5791
6148
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
5792
6149
|
*/
|
5793
6150
|
skipOverridesResolution?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
5794
|
-
/**
|
6151
|
+
/**
|
6152
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
6153
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6154
|
+
*/
|
5795
6155
|
slug?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
5796
|
-
/**
|
6156
|
+
/**
|
6157
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
6158
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6159
|
+
*/
|
5797
6160
|
state?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
5798
|
-
/**
|
6161
|
+
/**
|
6162
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
6163
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6164
|
+
*/
|
5799
6165
|
type?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
5800
6166
|
/**
|
5801
6167
|
* @deprecated Filters composition lists by the UI status of the composition.
|
5802
6168
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
6169
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5803
6170
|
*/
|
5804
6171
|
uiStatus?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
5805
6172
|
/**
|
5806
6173
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
5807
6174
|
* in case of FALSE. If not specified - no filtration applied.
|
6175
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5808
6176
|
*/
|
5809
6177
|
attachedToProjectMap?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
5810
|
-
/**
|
6178
|
+
/**
|
6179
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
6180
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6181
|
+
*/
|
5811
6182
|
updatedBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
5812
6183
|
/**
|
5813
6184
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
@@ -5934,7 +6305,7 @@ interface external$2 {
|
|
5934
6305
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
5935
6306
|
* @enum {string}
|
5936
6307
|
*/
|
5937
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
6308
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
5938
6309
|
/**
|
5939
6310
|
* Format: uuid
|
5940
6311
|
* @description The project ID that this layout data is part of
|
@@ -5963,25 +6334,61 @@ interface external$2 {
|
|
5963
6334
|
parameters: {
|
5964
6335
|
/** @description The project the composition(s) are on. */
|
5965
6336
|
projectId: string;
|
5966
|
-
/**
|
6337
|
+
/**
|
6338
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
6339
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6340
|
+
*/
|
5967
6341
|
compositionId: string;
|
5968
|
-
/**
|
6342
|
+
/**
|
6343
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
6344
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6345
|
+
*/
|
5969
6346
|
compositionIDs: string[];
|
5970
|
-
/**
|
6347
|
+
/**
|
6348
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
6349
|
+
* Must be used with the `compositionId` parameter.
|
6350
|
+
*/
|
6351
|
+
versionId: string;
|
6352
|
+
/**
|
6353
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
6354
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6355
|
+
*/
|
5971
6356
|
slug: string;
|
5972
|
-
/**
|
6357
|
+
/**
|
6358
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
6359
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6360
|
+
*/
|
5973
6361
|
projectMapNodeId: string;
|
5974
|
-
/**
|
6362
|
+
/**
|
6363
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
6364
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6365
|
+
*/
|
5975
6366
|
projectMapNodePath: string;
|
5976
|
-
/**
|
6367
|
+
/**
|
6368
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
6369
|
+
* If not specified, the default project map for the projectId is used.
|
6370
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
6371
|
+
*/
|
5977
6372
|
projectMapId: string;
|
5978
|
-
/**
|
6373
|
+
/**
|
6374
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
6375
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6376
|
+
*/
|
5979
6377
|
type: string[];
|
5980
|
-
/**
|
6378
|
+
/**
|
6379
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
6380
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6381
|
+
*/
|
5981
6382
|
state: number;
|
5982
|
-
/**
|
6383
|
+
/**
|
6384
|
+
* @description Number of records to skip
|
6385
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6386
|
+
*/
|
5983
6387
|
offset: number;
|
5984
|
-
/**
|
6388
|
+
/**
|
6389
|
+
* @description Max number of records to return
|
6390
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6391
|
+
*/
|
5985
6392
|
limit: number;
|
5986
6393
|
/**
|
5987
6394
|
* @deprecated
|
@@ -6015,6 +6422,7 @@ interface external$2 {
|
|
6015
6422
|
/**
|
6016
6423
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
6017
6424
|
* NOT a full text search; does not match composition contents.
|
6425
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6018
6426
|
*/
|
6019
6427
|
keyword: string;
|
6020
6428
|
/**
|
@@ -6022,9 +6430,13 @@ interface external$2 {
|
|
6022
6430
|
* If true, only pattern compositions will be returned.
|
6023
6431
|
* If false, only regular compositions will be returned.
|
6024
6432
|
* If omitted, both pattern and regular compositions will be returned.
|
6433
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6025
6434
|
*/
|
6026
6435
|
pattern: boolean;
|
6027
|
-
/**
|
6436
|
+
/**
|
6437
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
6438
|
+
* When using primary query parameters, this parameter is ignored.
|
6439
|
+
*/
|
6028
6440
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
6029
6441
|
/**
|
6030
6442
|
* @deprecated
|
@@ -6036,11 +6448,13 @@ interface external$2 {
|
|
6036
6448
|
* @deprecated
|
6037
6449
|
* @description Filters composition lists by the UI status of the composition.
|
6038
6450
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
6451
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6039
6452
|
*/
|
6040
6453
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
6041
6454
|
/**
|
6042
6455
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
6043
6456
|
* in case of FALSE. If not specified - no filtration applied.
|
6457
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6044
6458
|
*/
|
6045
6459
|
attachedToProjectMap: boolean;
|
6046
6460
|
/** @description Includes project map node information in the composition results */
|
@@ -6050,9 +6464,15 @@ interface external$2 {
|
|
6050
6464
|
* @description Includes content source map metadata on supported parameters
|
6051
6465
|
*/
|
6052
6466
|
withContentSourceMap: boolean;
|
6053
|
-
/**
|
6467
|
+
/**
|
6468
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
6469
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6470
|
+
*/
|
6054
6471
|
createdBy: string;
|
6055
|
-
/**
|
6472
|
+
/**
|
6473
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
6474
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6475
|
+
*/
|
6056
6476
|
updatedBy: string;
|
6057
6477
|
/**
|
6058
6478
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -6261,9 +6681,11 @@ interface external$2 {
|
|
6261
6681
|
};
|
6262
6682
|
}
|
6263
6683
|
|
6264
|
-
type Components = components$
|
6265
|
-
type SharedComponents = components$
|
6266
|
-
type
|
6684
|
+
type Components = components$3['schemas'];
|
6685
|
+
type SharedComponents = components$4['schemas'];
|
6686
|
+
type HistoryComponents = components$2['schemas'];
|
6687
|
+
type Api = paths$4['/api/v1/canvas'];
|
6688
|
+
type HistoryApi = paths$3['/api/v1/canvas-history'];
|
6267
6689
|
/** Query parameter options for GET /api/v1/canvas */
|
6268
6690
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
6269
6691
|
type?: string | string[];
|
@@ -6271,6 +6693,12 @@ type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'>
|
|
6271
6693
|
type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
|
6272
6694
|
/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
|
6273
6695
|
type CompositionGetResponse = Components['CompositionApiResponse'];
|
6696
|
+
/** The GET response from /api/v1/canvas-history (history for one composition) */
|
6697
|
+
type ComponentInstanceHistoryGetParameters = HistoryApi['get']['parameters']['query'];
|
6698
|
+
/** The GET response from /api/v1/canvas-history */
|
6699
|
+
type ComponentInstanceHistoryGetResponse = HistoryComponents['ComponentInstanceHistoryApiResponse'];
|
6700
|
+
/** A historical version of a composition */
|
6701
|
+
type ComponentInstanceHistoryEntry = HistoryComponents['ComponentInstanceHistoryEntry'];
|
6274
6702
|
/** @deprecated - internal use, do not rely on this value */
|
6275
6703
|
type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
|
6276
6704
|
/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
|
@@ -6332,7 +6760,7 @@ type CanvasDefinitions = {
|
|
6332
6760
|
dataTypes?: Array<DataType>;
|
6333
6761
|
};
|
6334
6762
|
/** Defines shared parameters for requests getting a single composition */
|
6335
|
-
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap'>;
|
6763
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
|
6336
6764
|
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
6337
6765
|
type SpecificProjectMap = {
|
6338
6766
|
projectMapId?: string;
|
@@ -6427,7 +6855,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
6427
6855
|
getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
|
6428
6856
|
compositions: {
|
6429
6857
|
state: number;
|
6430
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
|
6858
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | undefined;
|
6431
6859
|
projectId: string;
|
6432
6860
|
created: string;
|
6433
6861
|
modified: string;
|
@@ -6567,6 +6995,18 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
6567
6995
|
getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
6568
6996
|
getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
6569
6997
|
getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
6998
|
+
/** Fetches historical versions of a composition or pattern */
|
6999
|
+
unstable_getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
|
7000
|
+
cursor?: string | undefined;
|
7001
|
+
truncated?: boolean | undefined;
|
7002
|
+
results?: {
|
7003
|
+
versionId: string;
|
7004
|
+
timestamp: number;
|
7005
|
+
authorName: string;
|
7006
|
+
authorIsApiKey: boolean;
|
7007
|
+
state: number;
|
7008
|
+
}[] | undefined;
|
7009
|
+
}>;
|
6570
7010
|
private getOneComposition;
|
6571
7011
|
/** Updates or creates a Canvas component definition */
|
6572
7012
|
updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
|
@@ -7054,7 +7494,7 @@ type ProjectMapLinkComponentParameterValue = ProjectMapLinkParamValue | undefine
|
|
7054
7494
|
type LinkComponentParameterValue = LinkParamValue;
|
7055
7495
|
|
7056
7496
|
type RichTextBuiltInFormat = 'code' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'superscript' | 'subscript';
|
7057
|
-
type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link';
|
7497
|
+
type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link' | 'quote' | 'code';
|
7058
7498
|
type RichTextParamConfiguration = {
|
7059
7499
|
required?: boolean;
|
7060
7500
|
formatting?: {
|
@@ -7752,4 +8192,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
7752
8192
|
|
7753
8193
|
declare const CanvasClientError: typeof ApiClientError;
|
7754
8194
|
|
7755
|
-
export { 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, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
|
8195
|
+
export { 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, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
|