@uniformdev/canvas 20.72.3-alpha.5 → 20.72.3-alpha.52
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +2064 -1455
- package/dist/index.d.ts +2064 -1455
- package/dist/index.esm.js +825 -186
- package/dist/index.js +830 -185
- package/dist/index.mjs +825 -186
- package/package.json +6 -6
package/dist/index.d.mts
CHANGED
|
@@ -9,7 +9,7 @@ import { Options } from 'p-throttle';
|
|
|
9
9
|
import { LinkAttributesConfiguration, RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
|
|
10
10
|
|
|
11
11
|
interface paths$n {
|
|
12
|
-
"/api/v1/
|
|
12
|
+
"/api/v1/categories": {
|
|
13
13
|
parameters: {
|
|
14
14
|
query?: never;
|
|
15
15
|
header?: never;
|
|
@@ -19,18 +19,7 @@ interface paths$n {
|
|
|
19
19
|
get: {
|
|
20
20
|
parameters: {
|
|
21
21
|
query: {
|
|
22
|
-
/** @description The project ID to get component definitions for */
|
|
23
22
|
projectId: string;
|
|
24
|
-
/** @description Limit the list to one result by ID (response remains an array) */
|
|
25
|
-
componentId?: string;
|
|
26
|
-
/** @description Number of records to skip */
|
|
27
|
-
offset?: number;
|
|
28
|
-
/** @description Maximum number of records to return */
|
|
29
|
-
limit?: number;
|
|
30
|
-
/** @description Whether to fetch system meta-component definitions (personalize, test, etc.) */
|
|
31
|
-
includeSystem?: boolean;
|
|
32
|
-
/** @description Filter by category ID */
|
|
33
|
-
categories?: string[];
|
|
34
23
|
};
|
|
35
24
|
header?: never;
|
|
36
25
|
path?: never;
|
|
@@ -45,8 +34,7 @@ interface paths$n {
|
|
|
45
34
|
};
|
|
46
35
|
content: {
|
|
47
36
|
"application/json": {
|
|
48
|
-
|
|
49
|
-
componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
|
|
37
|
+
categories: components$r["schemas"]["Category"][];
|
|
50
38
|
};
|
|
51
39
|
};
|
|
52
40
|
};
|
|
@@ -57,7 +45,6 @@ interface paths$n {
|
|
|
57
45
|
500: components$r["responses"]["InternalServerError"];
|
|
58
46
|
};
|
|
59
47
|
};
|
|
60
|
-
/** @description Upserts a component definition */
|
|
61
48
|
put: {
|
|
62
49
|
parameters: {
|
|
63
50
|
query?: never;
|
|
@@ -68,12 +55,9 @@ interface paths$n {
|
|
|
68
55
|
requestBody: {
|
|
69
56
|
content: {
|
|
70
57
|
"application/json": {
|
|
71
|
-
/**
|
|
72
|
-
* Format: uuid
|
|
73
|
-
* @description The project ID to upsert the component definition to
|
|
74
|
-
*/
|
|
58
|
+
/** Format: uuid */
|
|
75
59
|
projectId: string;
|
|
76
|
-
|
|
60
|
+
categories: components$r["schemas"]["Category"][];
|
|
77
61
|
};
|
|
78
62
|
};
|
|
79
63
|
};
|
|
@@ -93,7 +77,6 @@ interface paths$n {
|
|
|
93
77
|
};
|
|
94
78
|
};
|
|
95
79
|
post?: never;
|
|
96
|
-
/** @description Deletes a component definition */
|
|
97
80
|
delete: {
|
|
98
81
|
parameters: {
|
|
99
82
|
query?: never;
|
|
@@ -104,12 +87,9 @@ interface paths$n {
|
|
|
104
87
|
requestBody: {
|
|
105
88
|
content: {
|
|
106
89
|
"application/json": {
|
|
107
|
-
/**
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Format: uuid
|
|
111
|
-
* @description The project ID the component definition to delete belongs to
|
|
112
|
-
*/
|
|
90
|
+
/** Format: uuid */
|
|
91
|
+
categoryId: string;
|
|
92
|
+
/** Format: uuid */
|
|
113
93
|
projectId: string;
|
|
114
94
|
};
|
|
115
95
|
};
|
|
@@ -129,37 +109,90 @@ interface paths$n {
|
|
|
129
109
|
500: components$r["responses"]["InternalServerError"];
|
|
130
110
|
};
|
|
131
111
|
};
|
|
132
|
-
|
|
133
|
-
options: {
|
|
134
|
-
parameters: {
|
|
135
|
-
query?: never;
|
|
136
|
-
header?: never;
|
|
137
|
-
path?: never;
|
|
138
|
-
cookie?: never;
|
|
139
|
-
};
|
|
140
|
-
requestBody?: never;
|
|
141
|
-
responses: {
|
|
142
|
-
/** @description OK */
|
|
143
|
-
204: {
|
|
144
|
-
headers: {
|
|
145
|
-
[name: string]: unknown;
|
|
146
|
-
};
|
|
147
|
-
content?: never;
|
|
148
|
-
};
|
|
149
|
-
};
|
|
150
|
-
};
|
|
112
|
+
options?: never;
|
|
151
113
|
head?: never;
|
|
152
114
|
patch?: never;
|
|
153
115
|
trace?: never;
|
|
154
116
|
};
|
|
155
117
|
}
|
|
156
118
|
interface components$r {
|
|
119
|
+
schemas: {
|
|
120
|
+
/** @description Category for tagging canvas entities */
|
|
121
|
+
Category: {
|
|
122
|
+
/**
|
|
123
|
+
* Format: uuid
|
|
124
|
+
* @description Unique identifier for the category
|
|
125
|
+
*/
|
|
126
|
+
id: string;
|
|
127
|
+
/** @description Display name of the category */
|
|
128
|
+
name: string;
|
|
129
|
+
/**
|
|
130
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list
|
|
131
|
+
* @default 0
|
|
132
|
+
*/
|
|
133
|
+
order?: number;
|
|
134
|
+
};
|
|
135
|
+
Error: {
|
|
136
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
137
|
+
errorMessage?: string[] | string;
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
responses: {
|
|
141
|
+
/** @description Request input validation failed */
|
|
142
|
+
BadRequestError: {
|
|
143
|
+
headers: {
|
|
144
|
+
[name: string]: unknown;
|
|
145
|
+
};
|
|
146
|
+
content: {
|
|
147
|
+
"application/json": components$r["schemas"]["Error"];
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
/** @description API key or token was not valid */
|
|
151
|
+
UnauthorizedError: {
|
|
152
|
+
headers: {
|
|
153
|
+
[name: string]: unknown;
|
|
154
|
+
};
|
|
155
|
+
content: {
|
|
156
|
+
"application/json": components$r["schemas"]["Error"];
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
/** @description Permission was denied */
|
|
160
|
+
ForbiddenError: {
|
|
161
|
+
headers: {
|
|
162
|
+
[name: string]: unknown;
|
|
163
|
+
};
|
|
164
|
+
content: {
|
|
165
|
+
"application/json": components$r["schemas"]["Error"];
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
/** @description Too many requests in allowed time period */
|
|
169
|
+
RateLimitError: {
|
|
170
|
+
headers: {
|
|
171
|
+
[name: string]: unknown;
|
|
172
|
+
};
|
|
173
|
+
content?: never;
|
|
174
|
+
};
|
|
175
|
+
/** @description Execution error occurred */
|
|
176
|
+
InternalServerError: {
|
|
177
|
+
headers: {
|
|
178
|
+
[name: string]: unknown;
|
|
179
|
+
};
|
|
180
|
+
content?: never;
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
parameters: never;
|
|
184
|
+
requestBodies: never;
|
|
185
|
+
headers: never;
|
|
186
|
+
pathItems: never;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
interface components$q {
|
|
157
190
|
schemas: {
|
|
158
191
|
/** @description Public ID (used in code). Do not change after creation */
|
|
159
192
|
PublicIdProperty: string;
|
|
160
193
|
/** @description The definition of a component parameter */
|
|
161
194
|
ComponentDefinitionParameter: {
|
|
162
|
-
id: components$
|
|
195
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
163
196
|
/** @description Friendly name of the parameter */
|
|
164
197
|
name: string;
|
|
165
198
|
/** @description Appears next to the parameter in the Composition editor */
|
|
@@ -191,21 +224,9 @@ interface components$r {
|
|
|
191
224
|
/** @description The configuration object for the type (type-specific) */
|
|
192
225
|
typeConfig?: unknown;
|
|
193
226
|
};
|
|
194
|
-
/** @description Permission set for a component definition */
|
|
195
|
-
ComponentDefinitionPermission: {
|
|
196
|
-
roleId: components$r["schemas"]["PublicIdProperty"];
|
|
197
|
-
/**
|
|
198
|
-
* @description Permission type for this permission ComponentDefinition:
|
|
199
|
-
* read | write | create | delete
|
|
200
|
-
* @enum {string}
|
|
201
|
-
*/
|
|
202
|
-
permission: "read" | "write" | "create" | "delete";
|
|
203
|
-
/** @description State of the component that this permission applies to */
|
|
204
|
-
state: number;
|
|
205
|
-
};
|
|
206
227
|
/** @description The definition of a named component slot that can contain other components */
|
|
207
228
|
ComponentDefinitionSlot: {
|
|
208
|
-
id: components$
|
|
229
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
209
230
|
/** @description Friendly name of the slot */
|
|
210
231
|
name: string;
|
|
211
232
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
@@ -258,97 +279,155 @@ interface components$r {
|
|
|
258
279
|
*/
|
|
259
280
|
regularExpressionMessage?: string;
|
|
260
281
|
};
|
|
261
|
-
/** @description
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
282
|
+
/** @description The definition of a component variant */
|
|
283
|
+
ComponentDefinitionVariant: {
|
|
284
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
285
|
+
/** @description Friendly name of the variant */
|
|
286
|
+
name: string;
|
|
287
|
+
};
|
|
288
|
+
/** @description Permission set for a component definition */
|
|
289
|
+
ComponentDefinitionPermission: {
|
|
290
|
+
roleId: components$q["schemas"]["PublicIdProperty"];
|
|
265
291
|
/**
|
|
266
|
-
* @description
|
|
292
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
293
|
+
* read | write | create | delete
|
|
267
294
|
* @enum {string}
|
|
268
295
|
*/
|
|
269
|
-
|
|
296
|
+
permission: "read" | "write" | "create" | "delete";
|
|
297
|
+
/** @description State of the component that this permission applies to */
|
|
298
|
+
state: number;
|
|
299
|
+
};
|
|
300
|
+
/** @description Defines a component type that can live on a Composition */
|
|
301
|
+
ComponentDefinition: {
|
|
302
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
303
|
+
/** @description Friendly name of the component definition */
|
|
304
|
+
name: string;
|
|
270
305
|
/**
|
|
271
|
-
* @description
|
|
272
|
-
*
|
|
273
|
-
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
274
|
-
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
275
|
-
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
276
|
-
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
277
|
-
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
278
|
-
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
279
|
-
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
280
|
-
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
281
|
-
* @enum {string}
|
|
306
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
|
307
|
+
* @default screen
|
|
282
308
|
*/
|
|
283
|
-
|
|
309
|
+
icon?: string;
|
|
284
310
|
/**
|
|
285
|
-
* @description
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
289
|
-
* @enum {string}
|
|
311
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
312
|
+
* The parameter type must support being used as a title parameter for this to work
|
|
313
|
+
* @default null
|
|
290
314
|
*/
|
|
291
|
-
|
|
315
|
+
titleParameter?: string | null;
|
|
292
316
|
/**
|
|
293
|
-
* @description The
|
|
294
|
-
*
|
|
317
|
+
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
318
|
+
* @default null
|
|
295
319
|
*/
|
|
296
|
-
|
|
297
|
-
};
|
|
298
|
-
/**
|
|
299
|
-
* @deprecated
|
|
300
|
-
* @description beta functionality subject to change
|
|
301
|
-
*/
|
|
302
|
-
VisibilityCriteria: {
|
|
303
|
-
/** @description The rule type to execute */
|
|
304
|
-
rule: string;
|
|
320
|
+
thumbnailParameter?: string | null;
|
|
305
321
|
/**
|
|
306
|
-
* @description
|
|
307
|
-
*
|
|
322
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
323
|
+
* @default false
|
|
308
324
|
*/
|
|
309
|
-
|
|
310
|
-
/** @description The
|
|
311
|
-
|
|
312
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
313
|
-
value: string | string[];
|
|
314
|
-
};
|
|
315
|
-
/**
|
|
316
|
-
* @deprecated
|
|
317
|
-
* @description beta functionality subject to change
|
|
318
|
-
*/
|
|
319
|
-
VisibilityCriteriaGroup: {
|
|
325
|
+
canBeComposition?: boolean;
|
|
326
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
327
|
+
parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
320
328
|
/**
|
|
321
|
-
*
|
|
322
|
-
* @
|
|
329
|
+
* Format: uuid
|
|
330
|
+
* @description Reference to the category this component definition belongs to
|
|
331
|
+
* @default null
|
|
323
332
|
*/
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
when: components$r["schemas"]["VisibilityCriteriaGroup"];
|
|
333
|
+
categoryId?: string | null;
|
|
334
|
+
/** @description Description of the component definition */
|
|
335
|
+
description?: string;
|
|
336
|
+
/** @description Preview image URL for the component definition (shown in the UI) */
|
|
337
|
+
previewImageUrl?: string;
|
|
330
338
|
/**
|
|
331
|
-
* @description
|
|
332
|
-
*
|
|
339
|
+
* @description if this component uses team permissions or custom permissions
|
|
340
|
+
* @default true
|
|
333
341
|
*/
|
|
334
|
-
|
|
342
|
+
useTeamPermissions?: boolean;
|
|
343
|
+
/** @description Custom role permissions for this component definition */
|
|
344
|
+
permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
|
|
345
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
346
|
+
slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
|
|
347
|
+
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
348
|
+
/** @description Default component instance value */
|
|
349
|
+
defaults?: components$q["schemas"]["ComponentInstance"] | null;
|
|
350
|
+
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
351
|
+
variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
|
|
352
|
+
/** @description Created date string for this definition (ignored for writes) */
|
|
353
|
+
created?: string;
|
|
354
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
|
355
|
+
updated?: string;
|
|
335
356
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
357
|
+
* Format: uuid
|
|
358
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
338
359
|
*/
|
|
339
|
-
|
|
360
|
+
workflowId?: string;
|
|
361
|
+
};
|
|
362
|
+
/** @description Defines a content type */
|
|
363
|
+
ContentType: {
|
|
364
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
365
|
+
/** @description Friendly name of the content type */
|
|
366
|
+
name: string;
|
|
367
|
+
/**
|
|
368
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
369
|
+
* The field type must support being used as an entry name for this to work
|
|
370
|
+
*/
|
|
371
|
+
entryName?: string | null;
|
|
372
|
+
/**
|
|
373
|
+
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
374
|
+
* @default null
|
|
375
|
+
*/
|
|
376
|
+
thumbnailField?: string | null;
|
|
377
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
378
|
+
fields?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
379
|
+
/** @description Description of the content type */
|
|
380
|
+
description?: string;
|
|
381
|
+
/**
|
|
382
|
+
* @description Icon name for the content type (e.g. 'screen')
|
|
383
|
+
* @default file-document
|
|
384
|
+
*/
|
|
385
|
+
icon?: string;
|
|
386
|
+
/** @description Created date string for this content type (ignored for writes) */
|
|
387
|
+
created?: string;
|
|
388
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
|
389
|
+
updated?: string;
|
|
390
|
+
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
391
|
+
/**
|
|
392
|
+
* @description The definition type of this content type (block or content type)
|
|
393
|
+
* @default contentType
|
|
394
|
+
* @enum {string}
|
|
395
|
+
*/
|
|
396
|
+
type?: "contentType" | "block";
|
|
397
|
+
/**
|
|
398
|
+
* @description if this content type uses team permissions or custom permissions
|
|
399
|
+
* @default true
|
|
400
|
+
*/
|
|
401
|
+
useTeamPermissions?: boolean;
|
|
402
|
+
/** @description Custom role permissions for this content type */
|
|
403
|
+
permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
|
|
404
|
+
/**
|
|
405
|
+
* Format: uuid
|
|
406
|
+
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
407
|
+
*/
|
|
408
|
+
workflowId?: string;
|
|
409
|
+
/** @description Configurations for previewing an entry on a consuming pattern or composition. */
|
|
410
|
+
previewConfigurations?: components$q["schemas"]["ContentTypePreviewConfiguration"][];
|
|
411
|
+
};
|
|
412
|
+
/** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
|
|
413
|
+
ContentTypePreviewConfiguration: {
|
|
414
|
+
/**
|
|
415
|
+
* @description The type of preview configuration
|
|
416
|
+
* @enum {string}
|
|
417
|
+
*/
|
|
418
|
+
type: "pattern" | "project-map";
|
|
419
|
+
/** @description Display label for the preview configuration */
|
|
420
|
+
label: string;
|
|
421
|
+
/**
|
|
422
|
+
* Format: uuid
|
|
423
|
+
* @description Target preview entity ID (project map node ID or pattern ID)
|
|
424
|
+
*/
|
|
425
|
+
id: string;
|
|
426
|
+
/** @description Optional mapping of dynamic input names to their values */
|
|
427
|
+
dynamicInputs?: {
|
|
428
|
+
[key: string]: string;
|
|
429
|
+
};
|
|
340
430
|
};
|
|
341
|
-
/**
|
|
342
|
-
* @description Array of alternate values which are based on conditions.
|
|
343
|
-
*
|
|
344
|
-
* When requested with an explicit locale parameter, or via the route API:
|
|
345
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
346
|
-
* * If no conditions match, the `value` property is used.
|
|
347
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
348
|
-
*
|
|
349
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
350
|
-
*/
|
|
351
|
-
ComponentParameterConditions: components$r["schemas"]["ComponentParameterConditionalValue"][];
|
|
352
431
|
/** @description Defines an editable parameter on a component */
|
|
353
432
|
ComponentParameter: {
|
|
354
433
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -356,7 +435,7 @@ interface components$r {
|
|
|
356
435
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
357
436
|
type: string;
|
|
358
437
|
/** @deprecated */
|
|
359
|
-
connectedData?: components$
|
|
438
|
+
connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
|
|
360
439
|
/**
|
|
361
440
|
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
362
441
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -364,25 +443,116 @@ interface components$r {
|
|
|
364
443
|
locales?: {
|
|
365
444
|
[key: string]: unknown;
|
|
366
445
|
};
|
|
367
|
-
conditions?: components$
|
|
446
|
+
conditions?: components$q["schemas"]["ComponentParameterConditions"];
|
|
368
447
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
369
448
|
localesConditions?: {
|
|
370
|
-
[key: string]: components$
|
|
449
|
+
[key: string]: components$q["schemas"]["ComponentParameterConditions"];
|
|
371
450
|
};
|
|
372
451
|
};
|
|
452
|
+
/**
|
|
453
|
+
* @description Array of alternate values which are based on conditions.
|
|
454
|
+
*
|
|
455
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
456
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
457
|
+
* * If no conditions match, the `value` property is used.
|
|
458
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
459
|
+
*
|
|
460
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
461
|
+
*/
|
|
462
|
+
ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
|
|
463
|
+
/** @description Defines a conditional value for a component parameter */
|
|
464
|
+
ComponentParameterConditionalValue: {
|
|
465
|
+
when: components$q["schemas"]["VisibilityCriteriaGroup"];
|
|
466
|
+
/**
|
|
467
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
468
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
469
|
+
*/
|
|
470
|
+
value: unknown;
|
|
471
|
+
/**
|
|
472
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
473
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
474
|
+
*/
|
|
475
|
+
id: number;
|
|
476
|
+
};
|
|
477
|
+
/**
|
|
478
|
+
* @deprecated
|
|
479
|
+
* @description beta functionality subject to change
|
|
480
|
+
*/
|
|
481
|
+
VisibilityCriteriaGroup: {
|
|
482
|
+
/**
|
|
483
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
484
|
+
* @enum {string}
|
|
485
|
+
*/
|
|
486
|
+
op?: "&" | "|";
|
|
487
|
+
clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
|
|
488
|
+
};
|
|
489
|
+
/**
|
|
490
|
+
* @deprecated
|
|
491
|
+
* @description beta functionality subject to change
|
|
492
|
+
*/
|
|
493
|
+
VisibilityCriteria: {
|
|
494
|
+
/** @description The rule type to execute */
|
|
495
|
+
rule: string;
|
|
496
|
+
/**
|
|
497
|
+
* @description The source value of the rule.
|
|
498
|
+
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
499
|
+
*/
|
|
500
|
+
source?: string;
|
|
501
|
+
/** @description The rule-definition-specific operator to test against */
|
|
502
|
+
op: string;
|
|
503
|
+
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
504
|
+
value: string | string[];
|
|
505
|
+
};
|
|
506
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
507
|
+
DataElementConnectionDefinition: {
|
|
508
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
509
|
+
pointer: string;
|
|
510
|
+
/**
|
|
511
|
+
* @description The syntax used to select the dynamic token to bind to
|
|
512
|
+
* @enum {string}
|
|
513
|
+
*/
|
|
514
|
+
syntax: "jptr";
|
|
515
|
+
/**
|
|
516
|
+
* @description The action to take if the dynamic token cannot be resolved
|
|
517
|
+
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
518
|
+
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
519
|
+
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
520
|
+
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
521
|
+
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
522
|
+
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
523
|
+
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
524
|
+
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
525
|
+
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
526
|
+
* @enum {string}
|
|
527
|
+
*/
|
|
528
|
+
failureAction?: "t" | "p" | "c" | "a";
|
|
529
|
+
/**
|
|
530
|
+
* @description How to report when the dynamic token cannot be resolved
|
|
531
|
+
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
532
|
+
* - w: WARNING: Report a warning message [default]
|
|
533
|
+
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
534
|
+
* @enum {string}
|
|
535
|
+
*/
|
|
536
|
+
failureLogLevel?: "e" | "w" | "i";
|
|
537
|
+
/**
|
|
538
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
539
|
+
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
540
|
+
*/
|
|
541
|
+
failureDefault?: string;
|
|
542
|
+
};
|
|
373
543
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
374
544
|
ComponentInstance: {
|
|
375
545
|
/** @description Type of the component instance (public_id of its definition) */
|
|
376
546
|
type: string;
|
|
377
547
|
/** @description Component parameter values for the component instance */
|
|
378
548
|
parameters?: {
|
|
379
|
-
[key: string]: components$
|
|
549
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
380
550
|
};
|
|
381
551
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
382
552
|
variant?: string;
|
|
383
553
|
/** @description Slots containing any child components */
|
|
384
554
|
slots?: {
|
|
385
|
-
[key: string]: components$
|
|
555
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
386
556
|
};
|
|
387
557
|
/**
|
|
388
558
|
* @description Unique identifier of the component within the composition.
|
|
@@ -393,15 +563,15 @@ interface components$r {
|
|
|
393
563
|
_id?: string;
|
|
394
564
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
395
565
|
_pattern?: string;
|
|
396
|
-
_dataResources?: components$
|
|
566
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
397
567
|
/**
|
|
398
568
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
399
569
|
* Means nothing for PUTs; it will be ignored
|
|
400
570
|
*/
|
|
401
571
|
_patternDataResources?: {
|
|
402
|
-
[key: string]: components$
|
|
572
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
403
573
|
};
|
|
404
|
-
_patternError?: components$
|
|
574
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
405
575
|
/**
|
|
406
576
|
* @description Defines patch overrides to component IDs that live in the composition.
|
|
407
577
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -415,14 +585,14 @@ interface components$r {
|
|
|
415
585
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
416
586
|
*/
|
|
417
587
|
_overrides?: {
|
|
418
|
-
[key: string]: components$
|
|
588
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
419
589
|
};
|
|
420
590
|
/**
|
|
421
591
|
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
422
592
|
* Means nothing for PUTs; it will be ignored
|
|
423
593
|
*/
|
|
424
594
|
_patternOverrides?: {
|
|
425
|
-
[key: string]: components$
|
|
595
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
426
596
|
};
|
|
427
597
|
/**
|
|
428
598
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -431,79 +601,107 @@ interface components$r {
|
|
|
431
601
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
432
602
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
433
603
|
*/
|
|
434
|
-
_overridability?: components$
|
|
604
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
435
605
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
436
606
|
_locales?: string[];
|
|
437
607
|
};
|
|
438
|
-
/** @description
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
};
|
|
442
|
-
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
443
|
-
DataResourceDefinition: {
|
|
444
|
-
/** @description Public ID of the data type that provides this data */
|
|
608
|
+
/** @description Defines the shape of the root component in a composition */
|
|
609
|
+
RootComponentInstance: {
|
|
610
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
445
611
|
type: string;
|
|
446
|
-
/** @description
|
|
447
|
-
isPatternParameter?: boolean;
|
|
448
|
-
/**
|
|
449
|
-
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
450
|
-
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
451
|
-
* If isPatternParameter is false or undefined, this has no meaning
|
|
452
|
-
*/
|
|
453
|
-
ignorePatternParameterDefault?: boolean;
|
|
454
|
-
/**
|
|
455
|
-
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
456
|
-
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
457
|
-
*/
|
|
458
|
-
optionalPatternParameter?: boolean;
|
|
459
|
-
variables?: components$r["schemas"]["DataResourceVariables"];
|
|
460
|
-
};
|
|
461
|
-
/**
|
|
462
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
463
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
464
|
-
*/
|
|
465
|
-
DataResourceDefinitions: {
|
|
466
|
-
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
467
|
-
};
|
|
468
|
-
/**
|
|
469
|
-
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
470
|
-
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
471
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
472
|
-
* Means nothing for PUTs; it will be ignored
|
|
473
|
-
* @enum {string}
|
|
474
|
-
*/
|
|
475
|
-
PatternError: "NOTFOUND" | "CYCLIC";
|
|
476
|
-
/**
|
|
477
|
-
* @description Defines how to override a specific component.
|
|
478
|
-
*
|
|
479
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
480
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
481
|
-
*/
|
|
482
|
-
ComponentOverride: {
|
|
612
|
+
/** @description Component parameter values for the component instance */
|
|
483
613
|
parameters?: {
|
|
484
|
-
[key: string]: components$
|
|
614
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
485
615
|
};
|
|
616
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
617
|
+
variant?: string;
|
|
618
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
619
|
+
projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
620
|
+
/** @description Slots containing any child components */
|
|
486
621
|
slots?: {
|
|
487
|
-
[key: string]: components$
|
|
622
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
488
623
|
};
|
|
489
|
-
|
|
624
|
+
/** @description The ID of the composition */
|
|
625
|
+
_id: string;
|
|
626
|
+
/** @description Slug pattern of this component */
|
|
627
|
+
_slug?: string | null;
|
|
628
|
+
/** @description Friendly name of this component */
|
|
629
|
+
_name: string;
|
|
630
|
+
/** @description Name of the author of the most recent change */
|
|
631
|
+
_author?: string;
|
|
632
|
+
/** @description Identity subject of the author of the most recent change */
|
|
633
|
+
_authorSubject?: string;
|
|
634
|
+
/** @description Name of the original creator */
|
|
635
|
+
_creator?: string;
|
|
636
|
+
/** @description Identity subject of the original creator */
|
|
637
|
+
_creatorSubject?: string;
|
|
638
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
639
|
+
_pattern?: string;
|
|
490
640
|
/**
|
|
491
|
-
* @description
|
|
492
|
-
*
|
|
493
|
-
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
641
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
642
|
+
* Means nothing for PUTs; it will be ignored
|
|
494
643
|
*/
|
|
495
|
-
|
|
496
|
-
[key: string]: components$
|
|
644
|
+
_patternDataResources?: {
|
|
645
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
646
|
+
};
|
|
647
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
648
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
649
|
+
/**
|
|
650
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
651
|
+
* This can be used to override parameters that are defined on patterns,
|
|
652
|
+
* including nested patterns, with values that are specific to this composition.
|
|
653
|
+
* The keys in this object are component IDs.
|
|
654
|
+
* Overrides are applied from the top down, so for example if both the composition
|
|
655
|
+
* and a pattern on the composition define an override on a nested pattern,
|
|
656
|
+
* the composition's override replaces the pattern's.
|
|
657
|
+
*
|
|
658
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
659
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
660
|
+
*/
|
|
661
|
+
_overrides?: {
|
|
662
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
663
|
+
};
|
|
664
|
+
/**
|
|
665
|
+
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
666
|
+
* Means nothing for PUTs; it will be ignored
|
|
667
|
+
*/
|
|
668
|
+
_patternOverrides?: {
|
|
669
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
497
670
|
};
|
|
671
|
+
/**
|
|
672
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
673
|
+
* by consumers of the pattern.
|
|
674
|
+
*
|
|
675
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
676
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
677
|
+
*/
|
|
678
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
679
|
+
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
680
|
+
_locales?: string[];
|
|
498
681
|
};
|
|
499
682
|
/**
|
|
500
|
-
* @description
|
|
683
|
+
* @description Defines how to override a specific component.
|
|
501
684
|
*
|
|
502
685
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
503
686
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
504
|
-
* @enum {string}
|
|
505
687
|
*/
|
|
506
|
-
|
|
688
|
+
ComponentOverride: {
|
|
689
|
+
parameters?: {
|
|
690
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
691
|
+
};
|
|
692
|
+
slots?: {
|
|
693
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
694
|
+
};
|
|
695
|
+
variant?: string;
|
|
696
|
+
/**
|
|
697
|
+
* @description Overrides data resource definitions for a pattern component.
|
|
698
|
+
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
699
|
+
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
700
|
+
*/
|
|
701
|
+
dataResources?: {
|
|
702
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
703
|
+
};
|
|
704
|
+
};
|
|
507
705
|
/**
|
|
508
706
|
* @description Defines how a component on a pattern may have its values overridden.
|
|
509
707
|
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
@@ -514,7 +712,7 @@ interface components$r {
|
|
|
514
712
|
ComponentOverridability: {
|
|
515
713
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
516
714
|
parameters?: {
|
|
517
|
-
[key: string]: components$
|
|
715
|
+
[key: string]: components$q["schemas"]["OverrideOptions"];
|
|
518
716
|
};
|
|
519
717
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
520
718
|
variants?: boolean;
|
|
@@ -525,1331 +723,1084 @@ interface components$r {
|
|
|
525
723
|
*/
|
|
526
724
|
hideLockedParameters?: boolean;
|
|
527
725
|
};
|
|
528
|
-
/**
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
726
|
+
/**
|
|
727
|
+
* @description Whether a parameter is overridable
|
|
728
|
+
*
|
|
729
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
730
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
731
|
+
* @enum {string}
|
|
732
|
+
*/
|
|
733
|
+
OverrideOptions: "yes" | "no";
|
|
734
|
+
/** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
|
|
735
|
+
AlternativeDataSourceData: {
|
|
736
|
+
/** @description Base resource URL of the data source. No trailing slash */
|
|
737
|
+
baseUrl: string;
|
|
738
|
+
/** @description HTTP headers to pass with requests to the data source */
|
|
739
|
+
headers?: {
|
|
740
|
+
key: string;
|
|
741
|
+
value: string;
|
|
742
|
+
omitIfEmpty?: boolean;
|
|
743
|
+
}[];
|
|
744
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
745
|
+
parameters?: {
|
|
746
|
+
key: string;
|
|
747
|
+
value: string;
|
|
748
|
+
omitIfEmpty?: boolean;
|
|
749
|
+
}[];
|
|
750
|
+
/** @description Variables needed to make calls to the data source */
|
|
751
|
+
variables?: {
|
|
752
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
753
|
+
};
|
|
533
754
|
};
|
|
534
|
-
/**
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
755
|
+
/**
|
|
756
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
757
|
+
* These are created in the UI and shared across a whole project.
|
|
758
|
+
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
759
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
760
|
+
*/
|
|
761
|
+
DataSource: {
|
|
762
|
+
/** @description Public ID of the data source */
|
|
763
|
+
id: string;
|
|
764
|
+
/** @description Display name of the data source */
|
|
765
|
+
displayName: string;
|
|
766
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
|
|
767
|
+
connectorType: string;
|
|
768
|
+
/** @description Base resource URL of the data source. No trailing slash */
|
|
769
|
+
baseUrl: string;
|
|
770
|
+
/** @description HTTP headers to pass with requests to the data source */
|
|
771
|
+
headers?: {
|
|
772
|
+
key: string;
|
|
773
|
+
value: string;
|
|
774
|
+
}[];
|
|
775
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
776
|
+
parameters?: {
|
|
777
|
+
key: string;
|
|
778
|
+
value: string;
|
|
779
|
+
}[];
|
|
780
|
+
/** @description Variables needed to make calls to the data source */
|
|
781
|
+
variables?: {
|
|
782
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
783
|
+
};
|
|
539
784
|
/**
|
|
540
|
-
* @description
|
|
541
|
-
*
|
|
785
|
+
* @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
786
|
+
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
542
787
|
*/
|
|
543
|
-
|
|
788
|
+
localeMapping?: {
|
|
789
|
+
[key: string]: string;
|
|
790
|
+
};
|
|
544
791
|
/**
|
|
545
|
-
* @description
|
|
546
|
-
*
|
|
547
|
-
* @default null
|
|
792
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
|
793
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
|
548
794
|
*/
|
|
549
|
-
|
|
795
|
+
enableUnpublishedMode?: boolean;
|
|
796
|
+
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
|
797
|
+
customPublic?: {
|
|
798
|
+
[key: string]: unknown;
|
|
799
|
+
};
|
|
800
|
+
/** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
|
|
801
|
+
custom?: {
|
|
802
|
+
[key: string]: unknown;
|
|
803
|
+
};
|
|
804
|
+
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
805
|
+
variants?: {
|
|
806
|
+
unpublished?: components$q["schemas"]["AlternativeDataSourceData"];
|
|
807
|
+
};
|
|
808
|
+
/** @description Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
809
|
+
created?: string;
|
|
810
|
+
/** @description Last modified date of the data source in ISO 8601 format (ignored for writes) */
|
|
811
|
+
modified?: string;
|
|
812
|
+
/** @description User or API key ID that created the data source (ignored for writes) */
|
|
813
|
+
createdBy?: string;
|
|
814
|
+
/** @description User or API key ID that last modified the data source (ignored for writes) */
|
|
815
|
+
modifiedBy?: string;
|
|
816
|
+
};
|
|
817
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
|
|
818
|
+
DataType: {
|
|
819
|
+
/** @description Public ID of the data type */
|
|
820
|
+
id: string;
|
|
821
|
+
/** @description Display name of the data type */
|
|
822
|
+
displayName: string;
|
|
823
|
+
/** @description Public ID of the associated data source */
|
|
824
|
+
dataSourceId: string;
|
|
550
825
|
/**
|
|
551
|
-
* @description
|
|
552
|
-
*
|
|
826
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
827
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
828
|
+
* no special UI or processing is required
|
|
553
829
|
*/
|
|
554
|
-
|
|
830
|
+
archetype?: string;
|
|
831
|
+
allowedOnComponents?: string[];
|
|
832
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
833
|
+
path: string;
|
|
834
|
+
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
835
|
+
ttl?: number;
|
|
836
|
+
/** @description A key for the resource data cache purging */
|
|
837
|
+
purgeKey?: string;
|
|
838
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons */
|
|
839
|
+
badgeIconUrl?: string;
|
|
840
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
841
|
+
headers?: {
|
|
842
|
+
key: string;
|
|
843
|
+
value: string;
|
|
844
|
+
omitIfEmpty?: boolean;
|
|
845
|
+
}[];
|
|
846
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
847
|
+
parameters?: {
|
|
848
|
+
key: string;
|
|
849
|
+
value: string;
|
|
850
|
+
omitIfEmpty?: boolean;
|
|
851
|
+
}[];
|
|
852
|
+
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
853
|
+
body?: string;
|
|
555
854
|
/**
|
|
556
|
-
* @description
|
|
557
|
-
* @default
|
|
855
|
+
* @description HTTP method to use with requests to the data type
|
|
856
|
+
* @default GET
|
|
857
|
+
* @enum {string}
|
|
558
858
|
*/
|
|
559
|
-
|
|
560
|
-
/** @description
|
|
561
|
-
|
|
859
|
+
method: "GET" | "POST" | "HEAD";
|
|
860
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
861
|
+
variables?: {
|
|
862
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
863
|
+
};
|
|
864
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
865
|
+
custom?: {
|
|
866
|
+
[key: string]: unknown;
|
|
867
|
+
};
|
|
868
|
+
/** @description Created date of the data type in ISO 8601 format (ignored for writes) */
|
|
869
|
+
created?: string;
|
|
870
|
+
/** @description Last modified date of the data type in ISO 8601 format (ignored for writes) */
|
|
871
|
+
modified?: string;
|
|
872
|
+
/** @description User or API key ID that created the data type (ignored for writes) */
|
|
873
|
+
createdBy?: string;
|
|
874
|
+
/** @description User or API key ID that last modified the data type (ignored for writes) */
|
|
875
|
+
modifiedBy?: string;
|
|
876
|
+
};
|
|
877
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
878
|
+
DataVariableDefinition: {
|
|
879
|
+
/** @description Display name of the data variable */
|
|
880
|
+
displayName?: string;
|
|
881
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
882
|
+
helpText?: string;
|
|
562
883
|
/**
|
|
563
|
-
*
|
|
564
|
-
* @
|
|
565
|
-
* @default null
|
|
884
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable
|
|
885
|
+
* @default text
|
|
566
886
|
*/
|
|
567
|
-
|
|
568
|
-
/** @description
|
|
569
|
-
|
|
570
|
-
/** @description
|
|
571
|
-
|
|
887
|
+
type?: string;
|
|
888
|
+
/** @description Default value of the data variable */
|
|
889
|
+
default: string;
|
|
890
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
891
|
+
order?: number;
|
|
572
892
|
/**
|
|
573
|
-
* @description
|
|
574
|
-
*
|
|
893
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
894
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
575
895
|
*/
|
|
576
|
-
|
|
577
|
-
/** @description Custom role permissions for this component definition */
|
|
578
|
-
permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
|
|
579
|
-
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
580
|
-
slots?: components$r["schemas"]["ComponentDefinitionSlot"][];
|
|
581
|
-
slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
|
|
582
|
-
/** @description Default component instance value */
|
|
583
|
-
defaults?: components$r["schemas"]["ComponentInstance"] | null;
|
|
584
|
-
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
585
|
-
variants?: components$r["schemas"]["ComponentDefinitionVariant"][];
|
|
586
|
-
/** @description Created date string for this definition (ignored for writes) */
|
|
587
|
-
created?: string;
|
|
588
|
-
/** @description Last modified date string for this definition (ignored for writes) */
|
|
589
|
-
updated?: string;
|
|
590
|
-
/**
|
|
591
|
-
* Format: uuid
|
|
592
|
-
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
593
|
-
*/
|
|
594
|
-
workflowId?: string;
|
|
595
|
-
};
|
|
596
|
-
Error: {
|
|
597
|
-
/** @description Error message(s) that occurred while processing the request */
|
|
598
|
-
errorMessage?: string[] | string;
|
|
599
|
-
};
|
|
600
|
-
};
|
|
601
|
-
responses: {
|
|
602
|
-
/** @description Request input validation failed */
|
|
603
|
-
BadRequestError: {
|
|
604
|
-
headers: {
|
|
605
|
-
[name: string]: unknown;
|
|
606
|
-
};
|
|
607
|
-
content: {
|
|
608
|
-
"application/json": components$r["schemas"]["Error"];
|
|
609
|
-
};
|
|
610
|
-
};
|
|
611
|
-
/** @description API key or token was not valid */
|
|
612
|
-
UnauthorizedError: {
|
|
613
|
-
headers: {
|
|
614
|
-
[name: string]: unknown;
|
|
615
|
-
};
|
|
616
|
-
content: {
|
|
617
|
-
"application/json": components$r["schemas"]["Error"];
|
|
618
|
-
};
|
|
619
|
-
};
|
|
620
|
-
/** @description Permission was denied */
|
|
621
|
-
ForbiddenError: {
|
|
622
|
-
headers: {
|
|
623
|
-
[name: string]: unknown;
|
|
624
|
-
};
|
|
625
|
-
content: {
|
|
626
|
-
"application/json": components$r["schemas"]["Error"];
|
|
627
|
-
};
|
|
628
|
-
};
|
|
629
|
-
/** @description Too many requests in allowed time period */
|
|
630
|
-
RateLimitError: {
|
|
631
|
-
headers: {
|
|
632
|
-
[name: string]: unknown;
|
|
633
|
-
};
|
|
634
|
-
content?: never;
|
|
896
|
+
source?: string;
|
|
635
897
|
};
|
|
636
|
-
/**
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
898
|
+
/**
|
|
899
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
900
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
901
|
+
*/
|
|
902
|
+
DataResourceDefinitions: {
|
|
903
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
642
904
|
};
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
headers: never;
|
|
647
|
-
pathItems: never;
|
|
648
|
-
}
|
|
649
|
-
|
|
650
|
-
interface components$q {
|
|
651
|
-
schemas: {
|
|
652
|
-
/** @description Public ID (used in code). Do not change after creation */
|
|
653
|
-
PublicIdProperty: string;
|
|
654
|
-
/** @description The definition of a component parameter */
|
|
655
|
-
ComponentDefinitionParameter: {
|
|
656
|
-
id: components$q["schemas"]["PublicIdProperty"];
|
|
657
|
-
/** @description Friendly name of the parameter */
|
|
658
|
-
name: string;
|
|
659
|
-
/** @description Appears next to the parameter in the Composition editor */
|
|
660
|
-
helpText?: string;
|
|
661
|
-
/** @description Context provided to AI when generating content for this parameter. May also be shown to humans. */
|
|
662
|
-
guidance?: string;
|
|
663
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
905
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
906
|
+
DataResourceDefinition: {
|
|
907
|
+
/** @description Public ID of the data type that provides this data */
|
|
664
908
|
type: string;
|
|
909
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false */
|
|
910
|
+
isPatternParameter?: boolean;
|
|
665
911
|
/**
|
|
666
|
-
* @description
|
|
667
|
-
*
|
|
668
|
-
|
|
669
|
-
localizable?: boolean;
|
|
670
|
-
/**
|
|
671
|
-
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
672
|
-
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
673
|
-
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
674
|
-
*
|
|
675
|
-
* If `localized` is false, this has no effect.
|
|
912
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
913
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
914
|
+
* If isPatternParameter is false or undefined, this has no meaning
|
|
676
915
|
*/
|
|
677
|
-
|
|
916
|
+
ignorePatternParameterDefault?: boolean;
|
|
678
917
|
/**
|
|
679
|
-
* @description
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
* When not defined, conditional values are not allowed.
|
|
918
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
919
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
683
920
|
*/
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
typeConfig?: unknown;
|
|
921
|
+
optionalPatternParameter?: boolean;
|
|
922
|
+
variables?: components$q["schemas"]["DataResourceVariables"];
|
|
687
923
|
};
|
|
688
|
-
/** @description
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
/** @description Friendly name of the slot */
|
|
692
|
-
name: string;
|
|
693
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
694
|
-
allowedComponents: string[];
|
|
695
|
-
/**
|
|
696
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
697
|
-
* If `allowAllComponents` is true, this value is ignored
|
|
698
|
-
* @default false
|
|
699
|
-
*/
|
|
700
|
-
inheritAllowedComponents: boolean;
|
|
701
|
-
/**
|
|
702
|
-
* @description When false or not defined, only components in `allowedComponents` may be added to this slot - and if `allowedComponents` is empty, nothing can be added.
|
|
703
|
-
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
704
|
-
*/
|
|
705
|
-
allowAllComponents?: boolean;
|
|
706
|
-
/**
|
|
707
|
-
* @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
708
|
-
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
709
|
-
*/
|
|
710
|
-
patternsInAllowedComponents?: boolean;
|
|
711
|
-
/** @description Minimum valid number of components in this slot */
|
|
712
|
-
minComponents?: number;
|
|
713
|
-
/** @description Maximum valid number of components in this slot */
|
|
714
|
-
maxComponents?: number;
|
|
924
|
+
/** @description Variable values for a data resource */
|
|
925
|
+
DataResourceVariables: {
|
|
926
|
+
[key: string]: string;
|
|
715
927
|
};
|
|
716
|
-
/**
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
*/
|
|
726
|
-
required?: "no" | "yes" | "disabled";
|
|
727
|
-
/**
|
|
728
|
-
* @description Slug uniqueness configuration.
|
|
729
|
-
* no = no unique constraint
|
|
730
|
-
* local = must be unique within this component type
|
|
731
|
-
* global = must be unique across all component types
|
|
732
|
-
* @enum {string}
|
|
733
|
-
*/
|
|
734
|
-
unique?: "no" | "local" | "global";
|
|
735
|
-
/** @description Regular expression slugs must match */
|
|
736
|
-
regularExpression?: string;
|
|
928
|
+
/**
|
|
929
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
930
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
931
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
932
|
+
* Means nothing for PUTs; it will be ignored
|
|
933
|
+
* @enum {string}
|
|
934
|
+
*/
|
|
935
|
+
PatternError: "NOTFOUND" | "CYCLIC";
|
|
936
|
+
HistoryApiResponse: {
|
|
737
937
|
/**
|
|
738
|
-
* @description
|
|
739
|
-
*
|
|
938
|
+
* @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.
|
|
939
|
+
* If this is undefined then no more results are available
|
|
740
940
|
*/
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
/** @description Friendly name of the variant */
|
|
747
|
-
name: string;
|
|
941
|
+
cursor?: string;
|
|
942
|
+
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
943
|
+
truncated?: boolean;
|
|
944
|
+
/** @description Version history entries */
|
|
945
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
748
946
|
};
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
/**
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
947
|
+
HistoryEntry: {
|
|
948
|
+
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
949
|
+
versionId: string;
|
|
950
|
+
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
951
|
+
timestamp: number;
|
|
952
|
+
/** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
953
|
+
authorName: string;
|
|
954
|
+
authorIsApiKey: boolean;
|
|
955
|
+
/** @description The identity who created the version; absent on old history entries. */
|
|
956
|
+
authorSubject?: string;
|
|
957
|
+
/** @description The state of the entity when the history entry was made */
|
|
759
958
|
state: number;
|
|
760
959
|
};
|
|
761
|
-
/** @description
|
|
762
|
-
|
|
763
|
-
id: components$q["schemas"]["PublicIdProperty"];
|
|
764
|
-
/** @description Friendly name of the component definition */
|
|
765
|
-
name: string;
|
|
960
|
+
/** @description Category for tagging canvas entities */
|
|
961
|
+
Category: {
|
|
766
962
|
/**
|
|
767
|
-
*
|
|
768
|
-
* @
|
|
963
|
+
* Format: uuid
|
|
964
|
+
* @description Unique identifier for the category
|
|
769
965
|
*/
|
|
770
|
-
|
|
966
|
+
id: string;
|
|
967
|
+
/** @description Display name of the category */
|
|
968
|
+
name: string;
|
|
771
969
|
/**
|
|
772
|
-
* @description
|
|
773
|
-
*
|
|
774
|
-
* @default null
|
|
970
|
+
* @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list
|
|
971
|
+
* @default 0
|
|
775
972
|
*/
|
|
776
|
-
|
|
973
|
+
order?: number;
|
|
974
|
+
};
|
|
975
|
+
/** @description Project map node information related to a component */
|
|
976
|
+
CompositionProjectMapNodeInfo: {
|
|
777
977
|
/**
|
|
778
|
-
*
|
|
779
|
-
* @
|
|
978
|
+
* Format: uuid
|
|
979
|
+
* @description Unique identifier for the project map node
|
|
780
980
|
*/
|
|
781
|
-
|
|
981
|
+
id: string;
|
|
782
982
|
/**
|
|
783
|
-
* @description
|
|
784
|
-
*
|
|
983
|
+
* @description Fallback path of the project map node.
|
|
984
|
+
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
785
985
|
*/
|
|
786
|
-
|
|
787
|
-
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
788
|
-
parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
986
|
+
path: string;
|
|
789
987
|
/**
|
|
790
988
|
* Format: uuid
|
|
791
|
-
* @description
|
|
792
|
-
* @default null
|
|
989
|
+
* @description Unique identifier for the project map that this node belongs to
|
|
793
990
|
*/
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
description?: string;
|
|
797
|
-
/** @description Preview image URL for the component definition (shown in the UI) */
|
|
798
|
-
previewImageUrl?: string;
|
|
991
|
+
projectMapId: string;
|
|
992
|
+
data?: components$q["schemas"]["ProjectMapNodeData"];
|
|
799
993
|
/**
|
|
800
|
-
* @description
|
|
801
|
-
*
|
|
994
|
+
* @description Locale-specific paths of the project map node.
|
|
995
|
+
* Keys are locale codes
|
|
802
996
|
*/
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
created?: string;
|
|
815
|
-
/** @description Last modified date string for this definition (ignored for writes) */
|
|
816
|
-
updated?: string;
|
|
997
|
+
locales?: {
|
|
998
|
+
[key: string]: {
|
|
999
|
+
/** @description Locale-specific path of the project map node */
|
|
1000
|
+
path: string;
|
|
1001
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
1002
|
+
inherited: boolean;
|
|
1003
|
+
};
|
|
1004
|
+
};
|
|
1005
|
+
};
|
|
1006
|
+
/** @description AI Prompt definition */
|
|
1007
|
+
Prompt: {
|
|
817
1008
|
/**
|
|
818
1009
|
* Format: uuid
|
|
819
|
-
* @description
|
|
1010
|
+
* @description Unique identifier for the prompt
|
|
820
1011
|
*/
|
|
821
|
-
|
|
1012
|
+
id: string;
|
|
1013
|
+
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
1014
|
+
integrationType: string;
|
|
1015
|
+
/** @description Name for the prompt */
|
|
1016
|
+
name?: string | null;
|
|
1017
|
+
/** @description Text for the prompt */
|
|
1018
|
+
text?: string | null;
|
|
1019
|
+
/** @description Data for the prompt */
|
|
1020
|
+
data?: {
|
|
1021
|
+
[key: string]: unknown;
|
|
1022
|
+
} | null;
|
|
1023
|
+
/** @description Turn off/on prompt */
|
|
1024
|
+
enabled?: boolean | null;
|
|
1025
|
+
/** @description Integration default prompt */
|
|
1026
|
+
builtIn?: boolean | null;
|
|
1027
|
+
/** @description Supported parameter types */
|
|
1028
|
+
parameterTypes?: string[] | null;
|
|
822
1029
|
};
|
|
823
|
-
/** @description
|
|
824
|
-
|
|
825
|
-
id: components$q["schemas"]["PublicIdProperty"];
|
|
826
|
-
/** @description Friendly name of the content type */
|
|
827
|
-
name: string;
|
|
828
|
-
/**
|
|
829
|
-
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
830
|
-
* The field type must support being used as an entry name for this to work
|
|
831
|
-
*/
|
|
832
|
-
entryName?: string | null;
|
|
833
|
-
/**
|
|
834
|
-
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
835
|
-
* @default null
|
|
836
|
-
*/
|
|
837
|
-
thumbnailField?: string | null;
|
|
838
|
-
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
839
|
-
fields?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
840
|
-
/** @description Description of the content type */
|
|
841
|
-
description?: string;
|
|
842
|
-
/**
|
|
843
|
-
* @description Icon name for the content type (e.g. 'screen')
|
|
844
|
-
* @default file-document
|
|
845
|
-
*/
|
|
846
|
-
icon?: string;
|
|
847
|
-
/** @description Created date string for this content type (ignored for writes) */
|
|
848
|
-
created?: string;
|
|
849
|
-
/** @description Last modified date string for this content type (ignored for writes) */
|
|
850
|
-
updated?: string;
|
|
851
|
-
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
852
|
-
/**
|
|
853
|
-
* @description The definition type of this content type (block or content type)
|
|
854
|
-
* @default contentType
|
|
855
|
-
* @enum {string}
|
|
856
|
-
*/
|
|
857
|
-
type?: "contentType" | "block";
|
|
1030
|
+
/** @description Definition of a workflow that can be assigned to entities */
|
|
1031
|
+
WorkflowDefinition: {
|
|
858
1032
|
/**
|
|
859
|
-
*
|
|
860
|
-
* @
|
|
1033
|
+
* Format: uuid
|
|
1034
|
+
* @description Unique identifier of the workflow definition
|
|
861
1035
|
*/
|
|
862
|
-
|
|
863
|
-
/** @description
|
|
864
|
-
|
|
1036
|
+
id: string;
|
|
1037
|
+
/** @description Workflow name */
|
|
1038
|
+
name: string;
|
|
865
1039
|
/**
|
|
866
1040
|
* Format: uuid
|
|
867
|
-
* @description ID of the
|
|
1041
|
+
* @description The ID of the initial stage in the stages object.
|
|
868
1042
|
*/
|
|
869
|
-
|
|
870
|
-
/** @description
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
1043
|
+
initialStage: string;
|
|
1044
|
+
/** @description All stages of the workflow */
|
|
1045
|
+
stages: {
|
|
1046
|
+
[key: string]: components$q["schemas"]["WorkflowStage"];
|
|
1047
|
+
};
|
|
1048
|
+
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1049
|
+
modified?: string;
|
|
1050
|
+
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
1051
|
+
created?: string;
|
|
875
1052
|
/**
|
|
876
|
-
* @description
|
|
877
|
-
*
|
|
1053
|
+
* @description Name of the original creator of the workflow.
|
|
1054
|
+
* If undefined, the user has been removed from the team.
|
|
1055
|
+
* Ignored for writes
|
|
878
1056
|
*/
|
|
879
|
-
|
|
880
|
-
/** @description Display label for the preview configuration */
|
|
881
|
-
label: string;
|
|
1057
|
+
createdBy?: string;
|
|
882
1058
|
/**
|
|
883
|
-
*
|
|
884
|
-
*
|
|
1059
|
+
* @description Name of the last modifier of the workflow.
|
|
1060
|
+
* If undefined, the user has been removed from the team.
|
|
1061
|
+
* Ignored for writes
|
|
885
1062
|
*/
|
|
886
|
-
|
|
887
|
-
/** @description Optional mapping of dynamic input names to their values */
|
|
888
|
-
dynamicInputs?: {
|
|
889
|
-
[key: string]: string;
|
|
890
|
-
};
|
|
1063
|
+
modifiedBy?: string;
|
|
891
1064
|
};
|
|
892
|
-
/** @description
|
|
893
|
-
|
|
894
|
-
/** @description
|
|
895
|
-
|
|
896
|
-
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
897
|
-
type: string;
|
|
898
|
-
/** @deprecated */
|
|
899
|
-
connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
|
|
1065
|
+
/** @description Definition of a stage in a workflow */
|
|
1066
|
+
WorkflowStage: {
|
|
1067
|
+
/** @description Name of the stage */
|
|
1068
|
+
name: string;
|
|
900
1069
|
/**
|
|
901
|
-
* @description
|
|
902
|
-
*
|
|
1070
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
1071
|
+
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
1072
|
+
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
1073
|
+
* listed here, the stage is read-only and publishing is disabled
|
|
903
1074
|
*/
|
|
904
|
-
|
|
905
|
-
[key: string]:
|
|
906
|
-
};
|
|
907
|
-
conditions?: components$q["schemas"]["ComponentParameterConditions"];
|
|
908
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
909
|
-
localesConditions?: {
|
|
910
|
-
[key: string]: components$q["schemas"]["ComponentParameterConditions"];
|
|
1075
|
+
permissions: {
|
|
1076
|
+
[key: string]: components$q["schemas"]["WorkflowStagePermission"];
|
|
911
1077
|
};
|
|
912
|
-
};
|
|
913
|
-
/**
|
|
914
|
-
* @description Array of alternate values which are based on conditions.
|
|
915
|
-
*
|
|
916
|
-
* When requested with an explicit locale parameter, or via the route API:
|
|
917
|
-
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
918
|
-
* * If no conditions match, the `value` property is used.
|
|
919
|
-
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
920
|
-
*
|
|
921
|
-
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
922
|
-
*/
|
|
923
|
-
ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
|
|
924
|
-
/** @description Defines a conditional value for a component parameter */
|
|
925
|
-
ComponentParameterConditionalValue: {
|
|
926
|
-
when: components$q["schemas"]["VisibilityCriteriaGroup"];
|
|
927
1078
|
/**
|
|
928
|
-
* @description
|
|
929
|
-
*
|
|
1079
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
1080
|
+
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
1081
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
1082
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
930
1083
|
*/
|
|
931
|
-
|
|
1084
|
+
autoPublish?: boolean;
|
|
932
1085
|
/**
|
|
933
|
-
* @description
|
|
934
|
-
*
|
|
1086
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
1087
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
1088
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
935
1089
|
*/
|
|
936
|
-
|
|
937
|
-
};
|
|
938
|
-
/**
|
|
939
|
-
* @deprecated
|
|
940
|
-
* @description beta functionality subject to change
|
|
941
|
-
*/
|
|
942
|
-
VisibilityCriteriaGroup: {
|
|
1090
|
+
requireValidity?: boolean;
|
|
943
1091
|
/**
|
|
944
|
-
* @description
|
|
945
|
-
*
|
|
1092
|
+
* @description Defines transitions to other stages
|
|
1093
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1094
|
+
* has a stage that can never be escaped
|
|
946
1095
|
*/
|
|
947
|
-
|
|
948
|
-
clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
|
|
949
|
-
};
|
|
950
|
-
/**
|
|
951
|
-
* @deprecated
|
|
952
|
-
* @description beta functionality subject to change
|
|
953
|
-
*/
|
|
954
|
-
VisibilityCriteria: {
|
|
955
|
-
/** @description The rule type to execute */
|
|
956
|
-
rule: string;
|
|
1096
|
+
transitions: components$q["schemas"]["WorkflowStageTransition"][];
|
|
957
1097
|
/**
|
|
958
|
-
* @description
|
|
959
|
-
*
|
|
1098
|
+
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1099
|
+
* @default chevron-double-right-o
|
|
960
1100
|
*/
|
|
961
|
-
|
|
962
|
-
/** @description
|
|
963
|
-
|
|
964
|
-
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
965
|
-
value: string | string[];
|
|
1101
|
+
icon?: string;
|
|
1102
|
+
/** @description Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
1103
|
+
order?: number;
|
|
966
1104
|
};
|
|
967
|
-
/** @description
|
|
968
|
-
|
|
969
|
-
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
970
|
-
pointer: string;
|
|
1105
|
+
/** @description Definition of a transition from one stage to another in a workflow */
|
|
1106
|
+
WorkflowStageTransition: {
|
|
971
1107
|
/**
|
|
972
|
-
*
|
|
973
|
-
* @
|
|
1108
|
+
* Format: uuid
|
|
1109
|
+
* @description The target stage to transition to
|
|
974
1110
|
*/
|
|
975
|
-
|
|
1111
|
+
to: string;
|
|
976
1112
|
/**
|
|
977
|
-
* @description
|
|
978
|
-
*
|
|
979
|
-
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
980
|
-
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
981
|
-
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
982
|
-
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
983
|
-
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
984
|
-
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
985
|
-
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
986
|
-
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
987
|
-
* @enum {string}
|
|
1113
|
+
* @description Name shown to the user when they execute this transition.
|
|
1114
|
+
* If not provided, a default name will be assigned automatically based on the target stage
|
|
988
1115
|
*/
|
|
989
|
-
|
|
1116
|
+
name: string;
|
|
990
1117
|
/**
|
|
991
|
-
* @description
|
|
992
|
-
*
|
|
993
|
-
* - w: WARNING: Report a warning message [default]
|
|
994
|
-
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
995
|
-
* @enum {string}
|
|
1118
|
+
* @description Permissions for the stage transition.
|
|
1119
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
996
1120
|
*/
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
* @description The default value to use if the dynamic token cannot be resolved.
|
|
1000
|
-
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
1001
|
-
*/
|
|
1002
|
-
failureDefault?: string;
|
|
1003
|
-
};
|
|
1004
|
-
/** @description Defines the shape of a component instance served by the composition API */
|
|
1005
|
-
ComponentInstance: {
|
|
1006
|
-
/** @description Type of the component instance (public_id of its definition) */
|
|
1007
|
-
type: string;
|
|
1008
|
-
/** @description Component parameter values for the component instance */
|
|
1009
|
-
parameters?: {
|
|
1010
|
-
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1011
|
-
};
|
|
1012
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
1013
|
-
variant?: string;
|
|
1014
|
-
/** @description Slots containing any child components */
|
|
1015
|
-
slots?: {
|
|
1016
|
-
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1017
|
-
};
|
|
1018
|
-
/**
|
|
1019
|
-
* @description Unique identifier of the component within the composition.
|
|
1020
|
-
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
1021
|
-
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
1022
|
-
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
1023
|
-
*/
|
|
1024
|
-
_id?: string;
|
|
1025
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
1026
|
-
_pattern?: string;
|
|
1027
|
-
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
1028
|
-
/**
|
|
1029
|
-
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1030
|
-
* Means nothing for PUTs; it will be ignored
|
|
1031
|
-
*/
|
|
1032
|
-
_patternDataResources?: {
|
|
1033
|
-
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1034
|
-
};
|
|
1035
|
-
_patternError?: components$q["schemas"]["PatternError"];
|
|
1036
|
-
/**
|
|
1037
|
-
* @description Defines patch overrides to component IDs that live in the composition.
|
|
1038
|
-
* This can be used to override parameters that are defined on patterns,
|
|
1039
|
-
* including nested patterns, with values that are specific to this composition.
|
|
1040
|
-
* The keys in this object are component IDs.
|
|
1041
|
-
* Overrides are applied from the top down, so for example if both the composition
|
|
1042
|
-
* and a pattern on the composition define an override on a nested pattern,
|
|
1043
|
-
* the composition's override replaces the pattern's.
|
|
1044
|
-
*
|
|
1045
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1046
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1047
|
-
*/
|
|
1048
|
-
_overrides?: {
|
|
1049
|
-
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1050
|
-
};
|
|
1051
|
-
/**
|
|
1052
|
-
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1053
|
-
* Means nothing for PUTs; it will be ignored
|
|
1054
|
-
*/
|
|
1055
|
-
_patternOverrides?: {
|
|
1056
|
-
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1121
|
+
permissions: {
|
|
1122
|
+
[key: string]: components$q["schemas"]["WorkflowStageTransitionPermission"];
|
|
1057
1123
|
};
|
|
1058
|
-
/**
|
|
1059
|
-
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1060
|
-
* by consumers of the pattern.
|
|
1061
|
-
*
|
|
1062
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1063
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1064
|
-
*/
|
|
1065
|
-
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
1066
|
-
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
1067
|
-
_locales?: string[];
|
|
1068
1124
|
};
|
|
1069
|
-
/** @description
|
|
1070
|
-
|
|
1071
|
-
/** @description
|
|
1072
|
-
|
|
1073
|
-
/** @description
|
|
1074
|
-
|
|
1075
|
-
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1076
|
-
};
|
|
1077
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
1078
|
-
variant?: string;
|
|
1079
|
-
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
1080
|
-
projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
1081
|
-
/** @description Slots containing any child components */
|
|
1082
|
-
slots?: {
|
|
1083
|
-
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1084
|
-
};
|
|
1085
|
-
/** @description The ID of the composition */
|
|
1086
|
-
_id: string;
|
|
1087
|
-
/** @description Slug pattern of this component */
|
|
1088
|
-
_slug?: string | null;
|
|
1089
|
-
/** @description Friendly name of this component */
|
|
1090
|
-
_name: string;
|
|
1091
|
-
/** @description Name of the author of the most recent change */
|
|
1092
|
-
_author?: string;
|
|
1093
|
-
/** @description Identity subject of the author of the most recent change */
|
|
1094
|
-
_authorSubject?: string;
|
|
1095
|
-
/** @description Name of the original creator */
|
|
1096
|
-
_creator?: string;
|
|
1097
|
-
/** @description Identity subject of the original creator */
|
|
1098
|
-
_creatorSubject?: string;
|
|
1099
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
1100
|
-
_pattern?: string;
|
|
1101
|
-
/**
|
|
1102
|
-
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1103
|
-
* Means nothing for PUTs; it will be ignored
|
|
1104
|
-
*/
|
|
1105
|
-
_patternDataResources?: {
|
|
1106
|
-
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1107
|
-
};
|
|
1108
|
-
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
1109
|
-
_patternError?: components$q["schemas"]["PatternError"];
|
|
1110
|
-
/**
|
|
1111
|
-
* @description Defines patch overrides to component IDs that live in the composition.
|
|
1112
|
-
* This can be used to override parameters that are defined on patterns,
|
|
1113
|
-
* including nested patterns, with values that are specific to this composition.
|
|
1114
|
-
* The keys in this object are component IDs.
|
|
1115
|
-
* Overrides are applied from the top down, so for example if both the composition
|
|
1116
|
-
* and a pattern on the composition define an override on a nested pattern,
|
|
1117
|
-
* the composition's override replaces the pattern's.
|
|
1118
|
-
*
|
|
1119
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1120
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1121
|
-
*/
|
|
1122
|
-
_overrides?: {
|
|
1123
|
-
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1124
|
-
};
|
|
1125
|
-
/**
|
|
1126
|
-
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1127
|
-
* Means nothing for PUTs; it will be ignored
|
|
1128
|
-
*/
|
|
1129
|
-
_patternOverrides?: {
|
|
1130
|
-
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1131
|
-
};
|
|
1132
|
-
/**
|
|
1133
|
-
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1134
|
-
* by consumers of the pattern.
|
|
1135
|
-
*
|
|
1136
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1137
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1138
|
-
*/
|
|
1139
|
-
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
1140
|
-
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
1141
|
-
_locales?: string[];
|
|
1125
|
+
/** @description Permissions for a workflow stage */
|
|
1126
|
+
WorkflowStagePermission: {
|
|
1127
|
+
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
1128
|
+
write?: boolean;
|
|
1129
|
+
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
1130
|
+
publish?: boolean;
|
|
1142
1131
|
};
|
|
1143
|
-
/**
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1148
|
-
*/
|
|
1149
|
-
ComponentOverride: {
|
|
1150
|
-
parameters?: {
|
|
1151
|
-
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1152
|
-
};
|
|
1153
|
-
slots?: {
|
|
1154
|
-
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1155
|
-
};
|
|
1156
|
-
variant?: string;
|
|
1157
|
-
/**
|
|
1158
|
-
* @description Overrides data resource definitions for a pattern component.
|
|
1159
|
-
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
1160
|
-
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
1161
|
-
*/
|
|
1162
|
-
dataResources?: {
|
|
1163
|
-
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1164
|
-
};
|
|
1132
|
+
/** @description Permissions for a workflow stage transition */
|
|
1133
|
+
WorkflowStageTransitionPermission: {
|
|
1134
|
+
/** @description Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it */
|
|
1135
|
+
execute?: boolean;
|
|
1165
1136
|
};
|
|
1166
|
-
/**
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1137
|
+
/** @enum {string} */
|
|
1138
|
+
ReleaseState: "open" | "locked" | "queued" | "launching" | "launched" | "deleting";
|
|
1139
|
+
/** @enum {string} */
|
|
1140
|
+
ReleaseScheduleState: "scheduled" | "unscheduled";
|
|
1141
|
+
ProjectMapNodeAllowedQueryString: {
|
|
1142
|
+
/** @description The name of the query string parameter */
|
|
1143
|
+
name: string;
|
|
1144
|
+
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1145
|
+
value?: string;
|
|
1146
|
+
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1147
|
+
helpText?: string;
|
|
1148
|
+
/** @description Configuration for providing a list of allowed values for this query string */
|
|
1149
|
+
optionsSource?: {
|
|
1150
|
+
/**
|
|
1151
|
+
* @description The source type for the options
|
|
1152
|
+
* @enum {string}
|
|
1153
|
+
*/
|
|
1154
|
+
source: "static";
|
|
1155
|
+
options: {
|
|
1156
|
+
/** @description Display name for the option */
|
|
1157
|
+
name: string;
|
|
1158
|
+
/** @description The actual value to be used */
|
|
1159
|
+
value: string;
|
|
1160
|
+
}[];
|
|
1177
1161
|
};
|
|
1178
|
-
|
|
1179
|
-
|
|
1162
|
+
};
|
|
1163
|
+
ProjectMapNodeData: {
|
|
1164
|
+
/** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
1165
|
+
isSearchHit?: boolean;
|
|
1166
|
+
/** @description Query strings that are allowed to be passed to the node */
|
|
1167
|
+
queryStrings?: components$q["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1180
1168
|
/**
|
|
1181
|
-
* @description
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
1169
|
+
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1170
|
+
* The preview value is used when editing a connected composition, and is the default
|
|
1171
|
+
* dynamic node value unless the author has explicitly chosen a different value
|
|
1184
1172
|
*/
|
|
1185
|
-
|
|
1173
|
+
previewValue?: string;
|
|
1186
1174
|
};
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1175
|
+
};
|
|
1176
|
+
responses: never;
|
|
1177
|
+
parameters: never;
|
|
1178
|
+
requestBodies: never;
|
|
1179
|
+
headers: never;
|
|
1180
|
+
pathItems: never;
|
|
1181
|
+
}
|
|
1182
|
+
|
|
1183
|
+
type SharedComponents$3 = components$q['schemas'];
|
|
1184
|
+
type Api$2 = paths$n['/api/v1/categories'];
|
|
1185
|
+
/** Shape of the GET response from /api/v1/category */
|
|
1186
|
+
type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
|
1187
|
+
/** Shape of the PUT request body for /api/v1/category */
|
|
1188
|
+
type CategoriesPutParameters = Api$2['put']['requestBody']['content']['application/json'];
|
|
1189
|
+
/** Shape of the DELETE request body for /api/v1/category */
|
|
1190
|
+
type CategoriesDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
|
|
1191
|
+
/** Query parameter options for GET /api/v1/category */
|
|
1192
|
+
type CategoriesGetParameters = Api$2['get']['parameters']['query'];
|
|
1193
|
+
/** Defines a component type that can live on a Composition */
|
|
1194
|
+
type Category = SharedComponents$3['Category'];
|
|
1195
|
+
|
|
1196
|
+
declare class CategoryClient extends ApiClient {
|
|
1197
|
+
constructor(options: ClientOptions);
|
|
1198
|
+
/** Fetches a list of categories created in given project */
|
|
1199
|
+
list(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
1200
|
+
categories: components$r["schemas"]["Category"][];
|
|
1201
|
+
}>;
|
|
1202
|
+
/** @deprecated Use {@link list} instead. */
|
|
1203
|
+
getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
1204
|
+
categories: components$r["schemas"]["Category"][];
|
|
1205
|
+
}>;
|
|
1206
|
+
/** Updates or creates a category, also used to re-order them */
|
|
1207
|
+
save(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
1208
|
+
/** @deprecated Use {@link save} instead. */
|
|
1209
|
+
upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
1210
|
+
/** Deletes a category */
|
|
1211
|
+
remove(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
|
|
1212
|
+
/** @deprecated Use {@link remove} instead. */
|
|
1213
|
+
removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
|
|
1214
|
+
}
|
|
1215
|
+
/** @deprecated Pass `bypassCache: true` to {@link CategoryClient} instead. */
|
|
1216
|
+
declare class UncachedCategoryClient extends CategoryClient {
|
|
1217
|
+
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1218
|
+
}
|
|
1219
|
+
|
|
1220
|
+
interface paths$m {
|
|
1221
|
+
"/api/v1/canvas-definitions": {
|
|
1222
|
+
parameters: {
|
|
1223
|
+
query?: never;
|
|
1224
|
+
header?: never;
|
|
1225
|
+
path?: never;
|
|
1226
|
+
cookie?: never;
|
|
1215
1227
|
};
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
}
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1228
|
+
get: {
|
|
1229
|
+
parameters: {
|
|
1230
|
+
query: {
|
|
1231
|
+
/** @description The project ID to get component definitions for */
|
|
1232
|
+
projectId: string;
|
|
1233
|
+
/** @description Limit the list to one result by ID (response remains an array) */
|
|
1234
|
+
componentId?: string;
|
|
1235
|
+
/** @description Number of records to skip */
|
|
1236
|
+
offset?: number;
|
|
1237
|
+
/** @description Maximum number of records to return */
|
|
1238
|
+
limit?: number;
|
|
1239
|
+
/** @description Whether to fetch system meta-component definitions (personalize, test, etc.) */
|
|
1240
|
+
includeSystem?: boolean;
|
|
1241
|
+
/** @description Filter by category ID */
|
|
1242
|
+
categories?: string[];
|
|
1243
|
+
};
|
|
1244
|
+
header?: never;
|
|
1245
|
+
path?: never;
|
|
1246
|
+
cookie?: never;
|
|
1247
|
+
};
|
|
1248
|
+
requestBody?: never;
|
|
1249
|
+
responses: {
|
|
1250
|
+
/** @description OK */
|
|
1251
|
+
200: {
|
|
1252
|
+
headers: {
|
|
1253
|
+
[name: string]: unknown;
|
|
1254
|
+
};
|
|
1255
|
+
content: {
|
|
1256
|
+
"application/json": {
|
|
1257
|
+
/** @description Component definitions that match the query */
|
|
1258
|
+
componentDefinitions: components$p["schemas"]["ComponentDefinition"][];
|
|
1259
|
+
};
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1263
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1264
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1265
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1266
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1244
1267
|
};
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1268
|
+
};
|
|
1269
|
+
/** @description Upserts a component definition */
|
|
1270
|
+
put: {
|
|
1271
|
+
parameters: {
|
|
1272
|
+
query?: never;
|
|
1273
|
+
header?: never;
|
|
1274
|
+
path?: never;
|
|
1275
|
+
cookie?: never;
|
|
1251
1276
|
};
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1277
|
+
requestBody: {
|
|
1278
|
+
content: {
|
|
1279
|
+
"application/json": {
|
|
1280
|
+
/**
|
|
1281
|
+
* Format: uuid
|
|
1282
|
+
* @description The project ID to upsert the component definition to
|
|
1283
|
+
*/
|
|
1284
|
+
projectId: string;
|
|
1285
|
+
componentDefinition: components$p["schemas"]["ComponentDefinition"];
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1260
1288
|
};
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1289
|
+
responses: {
|
|
1290
|
+
/** @description OK */
|
|
1291
|
+
204: {
|
|
1292
|
+
headers: {
|
|
1293
|
+
[name: string]: unknown;
|
|
1294
|
+
};
|
|
1295
|
+
content?: never;
|
|
1296
|
+
};
|
|
1297
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1298
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1299
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1300
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1301
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1264
1302
|
};
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1303
|
+
};
|
|
1304
|
+
post?: never;
|
|
1305
|
+
/** @description Deletes a component definition */
|
|
1306
|
+
delete: {
|
|
1307
|
+
parameters: {
|
|
1308
|
+
query?: never;
|
|
1309
|
+
header?: never;
|
|
1310
|
+
path?: never;
|
|
1311
|
+
cookie?: never;
|
|
1312
|
+
};
|
|
1313
|
+
requestBody: {
|
|
1314
|
+
content: {
|
|
1315
|
+
"application/json": {
|
|
1316
|
+
/** @description The public ID of the component definition to delete */
|
|
1317
|
+
componentId: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Format: uuid
|
|
1320
|
+
* @description The project ID the component definition to delete belongs to
|
|
1321
|
+
*/
|
|
1322
|
+
projectId: string;
|
|
1323
|
+
};
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
responses: {
|
|
1327
|
+
/** @description OK */
|
|
1328
|
+
204: {
|
|
1329
|
+
headers: {
|
|
1330
|
+
[name: string]: unknown;
|
|
1331
|
+
};
|
|
1332
|
+
content?: never;
|
|
1333
|
+
};
|
|
1334
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1335
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1336
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1337
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1338
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1268
1339
|
};
|
|
1269
|
-
/** @description Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
1270
|
-
created?: string;
|
|
1271
|
-
/** @description Last modified date of the data source in ISO 8601 format (ignored for writes) */
|
|
1272
|
-
modified?: string;
|
|
1273
|
-
/** @description User or API key ID that created the data source (ignored for writes) */
|
|
1274
|
-
createdBy?: string;
|
|
1275
|
-
/** @description User or API key ID that last modified the data source (ignored for writes) */
|
|
1276
|
-
modifiedBy?: string;
|
|
1277
1340
|
};
|
|
1278
|
-
/** @description
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
dataSourceId: string;
|
|
1286
|
-
/**
|
|
1287
|
-
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
1288
|
-
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
1289
|
-
* no special UI or processing is required
|
|
1290
|
-
*/
|
|
1291
|
-
archetype?: string;
|
|
1292
|
-
allowedOnComponents?: string[];
|
|
1293
|
-
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
1294
|
-
path: string;
|
|
1295
|
-
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
1296
|
-
ttl?: number;
|
|
1297
|
-
/** @description A key for the resource data cache purging */
|
|
1298
|
-
purgeKey?: string;
|
|
1299
|
-
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons */
|
|
1300
|
-
badgeIconUrl?: string;
|
|
1301
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
1302
|
-
headers?: {
|
|
1303
|
-
key: string;
|
|
1304
|
-
value: string;
|
|
1305
|
-
omitIfEmpty?: boolean;
|
|
1306
|
-
}[];
|
|
1307
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
1308
|
-
parameters?: {
|
|
1309
|
-
key: string;
|
|
1310
|
-
value: string;
|
|
1311
|
-
omitIfEmpty?: boolean;
|
|
1312
|
-
}[];
|
|
1313
|
-
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
1314
|
-
body?: string;
|
|
1315
|
-
/**
|
|
1316
|
-
* @description HTTP method to use with requests to the data type
|
|
1317
|
-
* @default GET
|
|
1318
|
-
* @enum {string}
|
|
1319
|
-
*/
|
|
1320
|
-
method: "GET" | "POST" | "HEAD";
|
|
1321
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
1322
|
-
variables?: {
|
|
1323
|
-
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
1341
|
+
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
1342
|
+
options: {
|
|
1343
|
+
parameters: {
|
|
1344
|
+
query?: never;
|
|
1345
|
+
header?: never;
|
|
1346
|
+
path?: never;
|
|
1347
|
+
cookie?: never;
|
|
1324
1348
|
};
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1349
|
+
requestBody?: never;
|
|
1350
|
+
responses: {
|
|
1351
|
+
/** @description OK */
|
|
1352
|
+
204: {
|
|
1353
|
+
headers: {
|
|
1354
|
+
[name: string]: unknown;
|
|
1355
|
+
};
|
|
1356
|
+
content?: never;
|
|
1357
|
+
};
|
|
1328
1358
|
};
|
|
1329
|
-
/** @description Created date of the data type in ISO 8601 format (ignored for writes) */
|
|
1330
|
-
created?: string;
|
|
1331
|
-
/** @description Last modified date of the data type in ISO 8601 format (ignored for writes) */
|
|
1332
|
-
modified?: string;
|
|
1333
|
-
/** @description User or API key ID that created the data type (ignored for writes) */
|
|
1334
|
-
createdBy?: string;
|
|
1335
|
-
/** @description User or API key ID that last modified the data type (ignored for writes) */
|
|
1336
|
-
modifiedBy?: string;
|
|
1337
1359
|
};
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1360
|
+
head?: never;
|
|
1361
|
+
patch?: never;
|
|
1362
|
+
trace?: never;
|
|
1363
|
+
};
|
|
1364
|
+
}
|
|
1365
|
+
interface components$p {
|
|
1366
|
+
schemas: {
|
|
1367
|
+
/** @description Public ID (used in code). Do not change after creation */
|
|
1368
|
+
PublicIdProperty: string;
|
|
1369
|
+
/** @description The definition of a component parameter */
|
|
1370
|
+
ComponentDefinitionParameter: {
|
|
1371
|
+
id: components$p["schemas"]["PublicIdProperty"];
|
|
1372
|
+
/** @description Friendly name of the parameter */
|
|
1373
|
+
name: string;
|
|
1374
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
1343
1375
|
helpText?: string;
|
|
1376
|
+
/** @description Context provided to AI when generating content for this parameter. May also be shown to humans. */
|
|
1377
|
+
guidance?: string;
|
|
1378
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
1379
|
+
type: string;
|
|
1344
1380
|
/**
|
|
1345
|
-
* @description
|
|
1346
|
-
*
|
|
1347
|
-
*/
|
|
1348
|
-
type?: string;
|
|
1349
|
-
/** @description Default value of the data variable */
|
|
1350
|
-
default: string;
|
|
1351
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
1352
|
-
order?: number;
|
|
1353
|
-
/**
|
|
1354
|
-
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
1355
|
-
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
1381
|
+
* @description If true, this property can have locale-specific values. If false or not defined,
|
|
1382
|
+
* this property will have a single value that is shared for all locales
|
|
1356
1383
|
*/
|
|
1357
|
-
|
|
1358
|
-
};
|
|
1359
|
-
/**
|
|
1360
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1361
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1362
|
-
*/
|
|
1363
|
-
DataResourceDefinitions: {
|
|
1364
|
-
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1365
|
-
};
|
|
1366
|
-
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
1367
|
-
DataResourceDefinition: {
|
|
1368
|
-
/** @description Public ID of the data type that provides this data */
|
|
1369
|
-
type: string;
|
|
1370
|
-
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false */
|
|
1371
|
-
isPatternParameter?: boolean;
|
|
1384
|
+
localizable?: boolean;
|
|
1372
1385
|
/**
|
|
1373
|
-
* @description When true, the default
|
|
1374
|
-
*
|
|
1375
|
-
*
|
|
1386
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
1387
|
+
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
1388
|
+
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
1389
|
+
*
|
|
1390
|
+
* If `localized` is false, this has no effect.
|
|
1376
1391
|
*/
|
|
1377
|
-
|
|
1392
|
+
notLocalizedByDefault?: boolean;
|
|
1378
1393
|
/**
|
|
1379
|
-
* @description
|
|
1380
|
-
*
|
|
1394
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
1395
|
+
* When combined with a localized value, each locale has independent conditional values.
|
|
1396
|
+
*
|
|
1397
|
+
* When not defined, conditional values are not allowed.
|
|
1381
1398
|
*/
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
/** @description Variable values for a data resource */
|
|
1386
|
-
DataResourceVariables: {
|
|
1387
|
-
[key: string]: string;
|
|
1399
|
+
allowConditionalValues?: boolean;
|
|
1400
|
+
/** @description The configuration object for the type (type-specific) */
|
|
1401
|
+
typeConfig?: unknown;
|
|
1388
1402
|
};
|
|
1389
|
-
/**
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
1393
|
-
* Means nothing for PUTs; it will be ignored
|
|
1394
|
-
* @enum {string}
|
|
1395
|
-
*/
|
|
1396
|
-
PatternError: "NOTFOUND" | "CYCLIC";
|
|
1397
|
-
HistoryApiResponse: {
|
|
1403
|
+
/** @description Permission set for a component definition */
|
|
1404
|
+
ComponentDefinitionPermission: {
|
|
1405
|
+
roleId: components$p["schemas"]["PublicIdProperty"];
|
|
1398
1406
|
/**
|
|
1399
|
-
* @description
|
|
1400
|
-
*
|
|
1407
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
1408
|
+
* read | write | create | delete
|
|
1409
|
+
* @enum {string}
|
|
1401
1410
|
*/
|
|
1402
|
-
|
|
1403
|
-
/** @description
|
|
1404
|
-
truncated?: boolean;
|
|
1405
|
-
/** @description Version history entries */
|
|
1406
|
-
results?: components$q["schemas"]["HistoryEntry"][];
|
|
1407
|
-
};
|
|
1408
|
-
HistoryEntry: {
|
|
1409
|
-
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
1410
|
-
versionId: string;
|
|
1411
|
-
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
1412
|
-
timestamp: number;
|
|
1413
|
-
/** @description The name (full name) of the user who created the version */
|
|
1414
|
-
authorName: string;
|
|
1415
|
-
authorIsApiKey: boolean;
|
|
1416
|
-
/** @description The state of the entity when the history entry was made */
|
|
1411
|
+
permission: "read" | "write" | "create" | "delete";
|
|
1412
|
+
/** @description State of the component that this permission applies to */
|
|
1417
1413
|
state: number;
|
|
1418
1414
|
};
|
|
1419
|
-
/** @description
|
|
1420
|
-
|
|
1415
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
1416
|
+
ComponentDefinitionSlot: {
|
|
1417
|
+
id: components$p["schemas"]["PublicIdProperty"];
|
|
1418
|
+
/** @description Friendly name of the slot */
|
|
1419
|
+
name: string;
|
|
1420
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
1421
|
+
allowedComponents: string[];
|
|
1421
1422
|
/**
|
|
1422
|
-
*
|
|
1423
|
-
*
|
|
1423
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
1424
|
+
* If `allowAllComponents` is true, this value is ignored
|
|
1425
|
+
* @default false
|
|
1424
1426
|
*/
|
|
1425
|
-
|
|
1426
|
-
/** @description Display name of the category */
|
|
1427
|
-
name: string;
|
|
1427
|
+
inheritAllowedComponents: boolean;
|
|
1428
1428
|
/**
|
|
1429
|
-
* @description
|
|
1430
|
-
*
|
|
1429
|
+
* @description When false or not defined, only components in `allowedComponents` may be added to this slot - and if `allowedComponents` is empty, nothing can be added.
|
|
1430
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
1431
1431
|
*/
|
|
1432
|
-
|
|
1433
|
-
};
|
|
1434
|
-
/** @description Project map node information related to a component */
|
|
1435
|
-
CompositionProjectMapNodeInfo: {
|
|
1432
|
+
allowAllComponents?: boolean;
|
|
1436
1433
|
/**
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1434
|
+
* @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
1435
|
+
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
1439
1436
|
*/
|
|
1440
|
-
|
|
1437
|
+
patternsInAllowedComponents?: boolean;
|
|
1438
|
+
/** @description Minimum valid number of components in this slot */
|
|
1439
|
+
minComponents?: number;
|
|
1440
|
+
/** @description Maximum valid number of components in this slot */
|
|
1441
|
+
maxComponents?: number;
|
|
1442
|
+
};
|
|
1443
|
+
/** @description The definition of a composition's slug settings */
|
|
1444
|
+
ComponentDefinitionSlugSettings: {
|
|
1441
1445
|
/**
|
|
1442
|
-
* @description
|
|
1443
|
-
*
|
|
1446
|
+
* @description Whether the slug is required
|
|
1447
|
+
* no: slug is optional
|
|
1448
|
+
* yes: slug is required
|
|
1449
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
1450
|
+
* @default no
|
|
1451
|
+
* @enum {string}
|
|
1444
1452
|
*/
|
|
1445
|
-
|
|
1453
|
+
required?: "no" | "yes" | "disabled";
|
|
1446
1454
|
/**
|
|
1447
|
-
*
|
|
1448
|
-
*
|
|
1455
|
+
* @description Slug uniqueness configuration.
|
|
1456
|
+
* no = no unique constraint
|
|
1457
|
+
* local = must be unique within this component type
|
|
1458
|
+
* global = must be unique across all component types
|
|
1459
|
+
* @enum {string}
|
|
1449
1460
|
*/
|
|
1450
|
-
|
|
1451
|
-
|
|
1461
|
+
unique?: "no" | "local" | "global";
|
|
1462
|
+
/** @description Regular expression slugs must match */
|
|
1463
|
+
regularExpression?: string;
|
|
1452
1464
|
/**
|
|
1453
|
-
* @description
|
|
1454
|
-
*
|
|
1465
|
+
* @description Custom error message when regular expression validation fails.
|
|
1466
|
+
* Has no effect if `regularExpression` is not set
|
|
1455
1467
|
*/
|
|
1456
|
-
|
|
1457
|
-
[key: string]: {
|
|
1458
|
-
/** @description Locale-specific path of the project map node */
|
|
1459
|
-
path: string;
|
|
1460
|
-
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
1461
|
-
inherited: boolean;
|
|
1462
|
-
};
|
|
1463
|
-
};
|
|
1468
|
+
regularExpressionMessage?: string;
|
|
1464
1469
|
};
|
|
1465
|
-
/** @description
|
|
1466
|
-
|
|
1470
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
1471
|
+
DataElementConnectionDefinition: {
|
|
1472
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
1473
|
+
pointer: string;
|
|
1467
1474
|
/**
|
|
1468
|
-
*
|
|
1469
|
-
* @
|
|
1475
|
+
* @description The syntax used to select the dynamic token to bind to
|
|
1476
|
+
* @enum {string}
|
|
1470
1477
|
*/
|
|
1471
|
-
|
|
1472
|
-
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
1473
|
-
integrationType: string;
|
|
1474
|
-
/** @description Name for the prompt */
|
|
1475
|
-
name?: string | null;
|
|
1476
|
-
/** @description Text for the prompt */
|
|
1477
|
-
text?: string | null;
|
|
1478
|
-
/** @description Data for the prompt */
|
|
1479
|
-
data?: {
|
|
1480
|
-
[key: string]: unknown;
|
|
1481
|
-
} | null;
|
|
1482
|
-
/** @description Turn off/on prompt */
|
|
1483
|
-
enabled?: boolean | null;
|
|
1484
|
-
/** @description Integration default prompt */
|
|
1485
|
-
builtIn?: boolean | null;
|
|
1486
|
-
/** @description Supported parameter types */
|
|
1487
|
-
parameterTypes?: string[] | null;
|
|
1488
|
-
};
|
|
1489
|
-
/** @description Definition of a workflow that can be assigned to entities */
|
|
1490
|
-
WorkflowDefinition: {
|
|
1478
|
+
syntax: "jptr";
|
|
1491
1479
|
/**
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1480
|
+
* @description The action to take if the dynamic token cannot be resolved
|
|
1481
|
+
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
1482
|
+
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
1483
|
+
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
1484
|
+
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
1485
|
+
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
1486
|
+
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
1487
|
+
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
1488
|
+
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
1489
|
+
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
1490
|
+
* @enum {string}
|
|
1494
1491
|
*/
|
|
1495
|
-
|
|
1496
|
-
/** @description Workflow name */
|
|
1497
|
-
name: string;
|
|
1492
|
+
failureAction?: "t" | "p" | "c" | "a";
|
|
1498
1493
|
/**
|
|
1499
|
-
*
|
|
1500
|
-
*
|
|
1494
|
+
* @description How to report when the dynamic token cannot be resolved
|
|
1495
|
+
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
1496
|
+
* - w: WARNING: Report a warning message [default]
|
|
1497
|
+
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
1498
|
+
* @enum {string}
|
|
1501
1499
|
*/
|
|
1502
|
-
|
|
1503
|
-
/** @description All stages of the workflow */
|
|
1504
|
-
stages: {
|
|
1505
|
-
[key: string]: components$q["schemas"]["WorkflowStage"];
|
|
1506
|
-
};
|
|
1507
|
-
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1508
|
-
modified?: string;
|
|
1509
|
-
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
1510
|
-
created?: string;
|
|
1500
|
+
failureLogLevel?: "e" | "w" | "i";
|
|
1511
1501
|
/**
|
|
1512
|
-
* @description
|
|
1513
|
-
*
|
|
1514
|
-
* Ignored for writes
|
|
1502
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
1503
|
+
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
1515
1504
|
*/
|
|
1516
|
-
|
|
1505
|
+
failureDefault?: string;
|
|
1506
|
+
};
|
|
1507
|
+
/**
|
|
1508
|
+
* @deprecated
|
|
1509
|
+
* @description beta functionality subject to change
|
|
1510
|
+
*/
|
|
1511
|
+
VisibilityCriteria: {
|
|
1512
|
+
/** @description The rule type to execute */
|
|
1513
|
+
rule: string;
|
|
1517
1514
|
/**
|
|
1518
|
-
* @description
|
|
1519
|
-
*
|
|
1520
|
-
* Ignored for writes
|
|
1515
|
+
* @description The source value of the rule.
|
|
1516
|
+
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
1521
1517
|
*/
|
|
1522
|
-
|
|
1518
|
+
source?: string;
|
|
1519
|
+
/** @description The rule-definition-specific operator to test against */
|
|
1520
|
+
op: string;
|
|
1521
|
+
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
1522
|
+
value: string | string[];
|
|
1523
1523
|
};
|
|
1524
|
-
/**
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1524
|
+
/**
|
|
1525
|
+
* @deprecated
|
|
1526
|
+
* @description beta functionality subject to change
|
|
1527
|
+
*/
|
|
1528
|
+
VisibilityCriteriaGroup: {
|
|
1528
1529
|
/**
|
|
1529
|
-
* @description
|
|
1530
|
-
*
|
|
1531
|
-
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
1532
|
-
* listed here, the stage is read-only and publishing is disabled
|
|
1530
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
1531
|
+
* @enum {string}
|
|
1533
1532
|
*/
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1533
|
+
op?: "&" | "|";
|
|
1534
|
+
clauses: (components$p["schemas"]["VisibilityCriteria"] | components$p["schemas"]["VisibilityCriteriaGroup"])[];
|
|
1535
|
+
};
|
|
1536
|
+
/** @description Defines a conditional value for a component parameter */
|
|
1537
|
+
ComponentParameterConditionalValue: {
|
|
1538
|
+
when: components$p["schemas"]["VisibilityCriteriaGroup"];
|
|
1537
1539
|
/**
|
|
1538
|
-
* @description
|
|
1539
|
-
*
|
|
1540
|
-
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
1541
|
-
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
1540
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
1541
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
1542
1542
|
*/
|
|
1543
|
-
|
|
1543
|
+
value: unknown;
|
|
1544
1544
|
/**
|
|
1545
|
-
* @description
|
|
1546
|
-
*
|
|
1547
|
-
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
1545
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
1546
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
1548
1547
|
*/
|
|
1549
|
-
|
|
1548
|
+
id: number;
|
|
1549
|
+
};
|
|
1550
|
+
/**
|
|
1551
|
+
* @description Array of alternate values which are based on conditions.
|
|
1552
|
+
*
|
|
1553
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
1554
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
1555
|
+
* * If no conditions match, the `value` property is used.
|
|
1556
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
1557
|
+
*
|
|
1558
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
1559
|
+
*/
|
|
1560
|
+
ComponentParameterConditions: components$p["schemas"]["ComponentParameterConditionalValue"][];
|
|
1561
|
+
/** @description Defines an editable parameter on a component */
|
|
1562
|
+
ComponentParameter: {
|
|
1563
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
1564
|
+
value?: unknown;
|
|
1565
|
+
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
1566
|
+
type: string;
|
|
1567
|
+
/** @deprecated */
|
|
1568
|
+
connectedData?: components$p["schemas"]["DataElementConnectionDefinition"];
|
|
1569
|
+
/**
|
|
1570
|
+
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
1571
|
+
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
1572
|
+
*/
|
|
1573
|
+
locales?: {
|
|
1574
|
+
[key: string]: unknown;
|
|
1575
|
+
};
|
|
1576
|
+
conditions?: components$p["schemas"]["ComponentParameterConditions"];
|
|
1577
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
1578
|
+
localesConditions?: {
|
|
1579
|
+
[key: string]: components$p["schemas"]["ComponentParameterConditions"];
|
|
1580
|
+
};
|
|
1581
|
+
};
|
|
1582
|
+
/** @description Defines the shape of a component instance served by the composition API */
|
|
1583
|
+
ComponentInstance: {
|
|
1584
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
1585
|
+
type: string;
|
|
1586
|
+
/** @description Component parameter values for the component instance */
|
|
1587
|
+
parameters?: {
|
|
1588
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
1589
|
+
};
|
|
1590
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
1591
|
+
variant?: string;
|
|
1592
|
+
/** @description Slots containing any child components */
|
|
1593
|
+
slots?: {
|
|
1594
|
+
[key: string]: components$p["schemas"]["ComponentInstance"][];
|
|
1595
|
+
};
|
|
1550
1596
|
/**
|
|
1551
|
-
* @description
|
|
1552
|
-
*
|
|
1553
|
-
*
|
|
1597
|
+
* @description Unique identifier of the component within the composition.
|
|
1598
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
1599
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
1600
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
1554
1601
|
*/
|
|
1555
|
-
|
|
1602
|
+
_id?: string;
|
|
1603
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
1604
|
+
_pattern?: string;
|
|
1605
|
+
_dataResources?: components$p["schemas"]["DataResourceDefinitions"];
|
|
1556
1606
|
/**
|
|
1557
|
-
* @description
|
|
1558
|
-
*
|
|
1607
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1608
|
+
* Means nothing for PUTs; it will be ignored
|
|
1559
1609
|
*/
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
/** @description Definition of a transition from one stage to another in a workflow */
|
|
1565
|
-
WorkflowStageTransition: {
|
|
1610
|
+
_patternDataResources?: {
|
|
1611
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
1612
|
+
};
|
|
1613
|
+
_patternError?: components$p["schemas"]["PatternError"];
|
|
1566
1614
|
/**
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1615
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
1616
|
+
* This can be used to override parameters that are defined on patterns,
|
|
1617
|
+
* including nested patterns, with values that are specific to this composition.
|
|
1618
|
+
* The keys in this object are component IDs.
|
|
1619
|
+
* Overrides are applied from the top down, so for example if both the composition
|
|
1620
|
+
* and a pattern on the composition define an override on a nested pattern,
|
|
1621
|
+
* the composition's override replaces the pattern's.
|
|
1622
|
+
*
|
|
1623
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1624
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1569
1625
|
*/
|
|
1570
|
-
|
|
1626
|
+
_overrides?: {
|
|
1627
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
1628
|
+
};
|
|
1571
1629
|
/**
|
|
1572
|
-
* @description
|
|
1573
|
-
*
|
|
1630
|
+
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1631
|
+
* Means nothing for PUTs; it will be ignored
|
|
1574
1632
|
*/
|
|
1575
|
-
|
|
1633
|
+
_patternOverrides?: {
|
|
1634
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
1635
|
+
};
|
|
1576
1636
|
/**
|
|
1577
|
-
* @description
|
|
1578
|
-
*
|
|
1637
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1638
|
+
* by consumers of the pattern.
|
|
1639
|
+
*
|
|
1640
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1641
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1579
1642
|
*/
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
};
|
|
1584
|
-
/** @description Permissions for a workflow stage */
|
|
1585
|
-
WorkflowStagePermission: {
|
|
1586
|
-
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
1587
|
-
write?: boolean;
|
|
1588
|
-
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
1589
|
-
publish?: boolean;
|
|
1590
|
-
};
|
|
1591
|
-
/** @description Permissions for a workflow stage transition */
|
|
1592
|
-
WorkflowStageTransitionPermission: {
|
|
1593
|
-
/** @description Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it */
|
|
1594
|
-
execute?: boolean;
|
|
1643
|
+
_overridability?: components$p["schemas"]["ComponentOverridability"];
|
|
1644
|
+
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
1645
|
+
_locales?: string[];
|
|
1595
1646
|
};
|
|
1596
|
-
/** @
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
ReleaseScheduleState: "scheduled" | "unscheduled";
|
|
1600
|
-
ProjectMapNodeAllowedQueryString: {
|
|
1601
|
-
/** @description The name of the query string parameter */
|
|
1602
|
-
name: string;
|
|
1603
|
-
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1604
|
-
value?: string;
|
|
1605
|
-
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1606
|
-
helpText?: string;
|
|
1607
|
-
/** @description Configuration for providing a list of allowed values for this query string */
|
|
1608
|
-
optionsSource?: {
|
|
1609
|
-
/**
|
|
1610
|
-
* @description The source type for the options
|
|
1611
|
-
* @enum {string}
|
|
1612
|
-
*/
|
|
1613
|
-
source: "static";
|
|
1614
|
-
options: {
|
|
1615
|
-
/** @description Display name for the option */
|
|
1616
|
-
name: string;
|
|
1617
|
-
/** @description The actual value to be used */
|
|
1618
|
-
value: string;
|
|
1619
|
-
}[];
|
|
1620
|
-
};
|
|
1647
|
+
/** @description Variable values for a data resource */
|
|
1648
|
+
DataResourceVariables: {
|
|
1649
|
+
[key: string]: string;
|
|
1621
1650
|
};
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1651
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
1652
|
+
DataResourceDefinition: {
|
|
1653
|
+
/** @description Public ID of the data type that provides this data */
|
|
1654
|
+
type: string;
|
|
1655
|
+
/** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false */
|
|
1656
|
+
isPatternParameter?: boolean;
|
|
1627
1657
|
/**
|
|
1628
|
-
* @description
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1658
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
1659
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
1660
|
+
* If isPatternParameter is false or undefined, this has no meaning
|
|
1631
1661
|
*/
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
pathItems: never;
|
|
1640
|
-
}
|
|
1641
|
-
|
|
1642
|
-
/**
|
|
1643
|
-
* Data projection wire grammar (`select.*` query parameters) and shared spec
|
|
1644
|
-
* type used by every consumer of projections: API serializers (SDK clients),
|
|
1645
|
-
* the origin pruner (lib/canvas-sdk applyProjection), and localize (for the
|
|
1646
|
-
* representation-modifier operator `fields[locales]`).
|
|
1647
|
-
*
|
|
1648
|
-
* Wire grammar (mirrors `filters.*`):
|
|
1649
|
-
*
|
|
1650
|
-
* select.fields[only]=name,seo_*
|
|
1651
|
-
* select.fields[except]=internalNote
|
|
1652
|
-
* select.fields[only]= // strip every field
|
|
1653
|
-
* select.fields[except]=* // strip every field (wildcard form)
|
|
1654
|
-
* select.fields[locales]=slug,seo_*
|
|
1655
|
-
* select.fieldTypes[only]=text,number
|
|
1656
|
-
* select.fieldTypes[except]=richText
|
|
1657
|
-
* select.slots[only]=hero
|
|
1658
|
-
* select.slots[except]=footer
|
|
1659
|
-
* select.slots[depth]=2
|
|
1660
|
-
* select.slots.<name>[depth]=1
|
|
1661
|
-
* select.fields[blockDepth]=2
|
|
1662
|
-
* select.fields[blockDepth]=preserveAll
|
|
1663
|
-
*/
|
|
1664
|
-
/**
|
|
1665
|
-
* Prefix used by every `select.*` query parameter on the wire. Exported so
|
|
1666
|
-
* downstream prefix scans (lambda validator, edge search-param reader,
|
|
1667
|
-
* origin handler short-circuits) and key builders don't hand-roll the
|
|
1668
|
-
* literal at every call site.
|
|
1669
|
-
*/
|
|
1670
|
-
declare const SELECT_QUERY_PREFIX = "select.";
|
|
1671
|
-
type FieldsProjection = {
|
|
1672
|
-
/** Include only fields whose name matches one of these patterns. */
|
|
1673
|
-
only?: string[];
|
|
1674
|
-
/** Exclude fields whose name matches one of these patterns. */
|
|
1675
|
-
except?: string[];
|
|
1676
|
-
/**
|
|
1677
|
-
* Field-name patterns whose value should retain its full per-locale map
|
|
1678
|
-
* (`locales` / `localesConditions`) after `localize` runs. Representation
|
|
1679
|
-
* modifier; the pruner ignores this — see lib/canvas-sdk applyProjection.
|
|
1680
|
-
*/
|
|
1681
|
-
locales?: string[];
|
|
1682
|
-
/**
|
|
1683
|
-
* Controls how far projection descends into block-typed fields (`$block`).
|
|
1684
|
-
* A block field's value is an array of structured content, each with its own
|
|
1685
|
-
* fields, so projection can recurse into it like any other node.
|
|
1686
|
-
*
|
|
1687
|
-
* - Omitted (default): projection descends into blocks without limit,
|
|
1688
|
-
* applying `only`/`except` at every block level.
|
|
1689
|
-
* - A non-negative integer `N`: keep block nesting up to `N` levels. Block
|
|
1690
|
-
* fields on a node at depth `>= N` are dropped; `only`/`except` still
|
|
1691
|
-
* apply within the levels that are kept. `0` removes every block-typed
|
|
1692
|
-
* field; `1` keeps top-level blocks but not blocks nested inside them.
|
|
1693
|
-
* - `'preserveAll'`: Projection does not evaluate within blocks at all:
|
|
1694
|
-
* `only`/`except` do not apply to fields within blocks. The top level block field
|
|
1695
|
-
* is still subject to projection rules, but its descendants are not.
|
|
1696
|
-
*/
|
|
1697
|
-
blockDepth?: number | 'preserveAll';
|
|
1698
|
-
};
|
|
1699
|
-
type FieldTypesProjection = {
|
|
1700
|
-
/** Include only fields whose `type` matches one of these patterns. */
|
|
1701
|
-
only?: string[];
|
|
1702
|
-
/** Exclude fields whose `type` matches one of these patterns. */
|
|
1703
|
-
except?: string[];
|
|
1704
|
-
};
|
|
1705
|
-
type SlotsProjection = {
|
|
1706
|
-
/** Include only slots whose name matches one of these patterns. */
|
|
1707
|
-
only?: string[];
|
|
1708
|
-
/** Exclude slots whose name matches one of these patterns. */
|
|
1709
|
-
except?: string[];
|
|
1710
|
-
/**
|
|
1711
|
-
* Container-wide recursion-depth cap counted in slot levels from the root.
|
|
1712
|
-
* 0 means "no slots at all on the root"; 1 means "root's own slots but no
|
|
1713
|
-
* grandchildren slots". Per-name depth (see `named`) overrides this for
|
|
1714
|
-
* its specific slot.
|
|
1715
|
-
*/
|
|
1716
|
-
depth?: number;
|
|
1717
|
-
/** Per-slot depth caps. Keyed by slot name. */
|
|
1718
|
-
named?: {
|
|
1719
|
-
[slotName: string]: {
|
|
1720
|
-
depth?: number;
|
|
1721
|
-
};
|
|
1722
|
-
};
|
|
1723
|
-
};
|
|
1724
|
-
type ProjectionSpec = {
|
|
1725
|
-
fields?: FieldsProjection;
|
|
1726
|
-
fieldTypes?: FieldTypesProjection;
|
|
1727
|
-
slots?: SlotsProjection;
|
|
1728
|
-
};
|
|
1729
|
-
|
|
1730
|
-
interface paths$m {
|
|
1731
|
-
"/api/v1/categories": {
|
|
1732
|
-
parameters: {
|
|
1733
|
-
query?: never;
|
|
1734
|
-
header?: never;
|
|
1735
|
-
path?: never;
|
|
1736
|
-
cookie?: never;
|
|
1737
|
-
};
|
|
1738
|
-
get: {
|
|
1739
|
-
parameters: {
|
|
1740
|
-
query: {
|
|
1741
|
-
projectId: string;
|
|
1742
|
-
};
|
|
1743
|
-
header?: never;
|
|
1744
|
-
path?: never;
|
|
1745
|
-
cookie?: never;
|
|
1746
|
-
};
|
|
1747
|
-
requestBody?: never;
|
|
1748
|
-
responses: {
|
|
1749
|
-
/** @description OK */
|
|
1750
|
-
200: {
|
|
1751
|
-
headers: {
|
|
1752
|
-
[name: string]: unknown;
|
|
1753
|
-
};
|
|
1754
|
-
content: {
|
|
1755
|
-
"application/json": {
|
|
1756
|
-
categories: components$p["schemas"]["Category"][];
|
|
1757
|
-
};
|
|
1758
|
-
};
|
|
1759
|
-
};
|
|
1760
|
-
400: components$p["responses"]["BadRequestError"];
|
|
1761
|
-
401: components$p["responses"]["UnauthorizedError"];
|
|
1762
|
-
403: components$p["responses"]["ForbiddenError"];
|
|
1763
|
-
429: components$p["responses"]["RateLimitError"];
|
|
1764
|
-
500: components$p["responses"]["InternalServerError"];
|
|
1765
|
-
};
|
|
1662
|
+
ignorePatternParameterDefault?: boolean;
|
|
1663
|
+
/**
|
|
1664
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
1665
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1666
|
+
*/
|
|
1667
|
+
optionalPatternParameter?: boolean;
|
|
1668
|
+
variables?: components$p["schemas"]["DataResourceVariables"];
|
|
1766
1669
|
};
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1670
|
+
/**
|
|
1671
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1672
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1673
|
+
*/
|
|
1674
|
+
DataResourceDefinitions: {
|
|
1675
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
1676
|
+
};
|
|
1677
|
+
/**
|
|
1678
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
1679
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
1680
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
1681
|
+
* Means nothing for PUTs; it will be ignored
|
|
1682
|
+
* @enum {string}
|
|
1683
|
+
*/
|
|
1684
|
+
PatternError: "NOTFOUND" | "CYCLIC";
|
|
1685
|
+
/**
|
|
1686
|
+
* @description Defines how to override a specific component.
|
|
1687
|
+
*
|
|
1688
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1689
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1690
|
+
*/
|
|
1691
|
+
ComponentOverride: {
|
|
1692
|
+
parameters?: {
|
|
1693
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
1773
1694
|
};
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
"application/json": {
|
|
1777
|
-
/** Format: uuid */
|
|
1778
|
-
projectId: string;
|
|
1779
|
-
categories: components$p["schemas"]["Category"][];
|
|
1780
|
-
};
|
|
1781
|
-
};
|
|
1695
|
+
slots?: {
|
|
1696
|
+
[key: string]: components$p["schemas"]["ComponentInstance"][];
|
|
1782
1697
|
};
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
400: components$p["responses"]["BadRequestError"];
|
|
1792
|
-
401: components$p["responses"]["UnauthorizedError"];
|
|
1793
|
-
403: components$p["responses"]["ForbiddenError"];
|
|
1794
|
-
429: components$p["responses"]["RateLimitError"];
|
|
1795
|
-
500: components$p["responses"]["InternalServerError"];
|
|
1698
|
+
variant?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* @description Overrides data resource definitions for a pattern component.
|
|
1701
|
+
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
1702
|
+
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
1703
|
+
*/
|
|
1704
|
+
dataResources?: {
|
|
1705
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
1796
1706
|
};
|
|
1797
1707
|
};
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
/** @description OK */
|
|
1818
|
-
204: {
|
|
1819
|
-
headers: {
|
|
1820
|
-
[name: string]: unknown;
|
|
1821
|
-
};
|
|
1822
|
-
content?: never;
|
|
1823
|
-
};
|
|
1824
|
-
400: components$p["responses"]["BadRequestError"];
|
|
1825
|
-
401: components$p["responses"]["UnauthorizedError"];
|
|
1826
|
-
403: components$p["responses"]["ForbiddenError"];
|
|
1827
|
-
429: components$p["responses"]["RateLimitError"];
|
|
1828
|
-
500: components$p["responses"]["InternalServerError"];
|
|
1708
|
+
/**
|
|
1709
|
+
* @description Whether a parameter is overridable
|
|
1710
|
+
*
|
|
1711
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1712
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1713
|
+
* @enum {string}
|
|
1714
|
+
*/
|
|
1715
|
+
OverrideOptions: "yes" | "no";
|
|
1716
|
+
/**
|
|
1717
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
|
1718
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
1719
|
+
*
|
|
1720
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1721
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1722
|
+
*/
|
|
1723
|
+
ComponentOverridability: {
|
|
1724
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
1725
|
+
parameters?: {
|
|
1726
|
+
[key: string]: components$p["schemas"]["OverrideOptions"];
|
|
1829
1727
|
};
|
|
1728
|
+
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
1729
|
+
variants?: boolean;
|
|
1730
|
+
/**
|
|
1731
|
+
* @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
1732
|
+
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
1733
|
+
* If not set, the default is false
|
|
1734
|
+
*/
|
|
1735
|
+
hideLockedParameters?: boolean;
|
|
1830
1736
|
};
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
}
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1737
|
+
/** @description The definition of a component variant */
|
|
1738
|
+
ComponentDefinitionVariant: {
|
|
1739
|
+
id: components$p["schemas"]["PublicIdProperty"];
|
|
1740
|
+
/** @description Friendly name of the variant */
|
|
1741
|
+
name: string;
|
|
1742
|
+
};
|
|
1743
|
+
/** @description Defines a component type that can live on a Composition */
|
|
1744
|
+
ComponentDefinition: {
|
|
1745
|
+
id: components$p["schemas"]["PublicIdProperty"];
|
|
1746
|
+
/** @description Friendly name of the component definition */
|
|
1747
|
+
name: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
|
1750
|
+
* @default screen
|
|
1751
|
+
*/
|
|
1752
|
+
icon?: string;
|
|
1753
|
+
/**
|
|
1754
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
1755
|
+
* The parameter type must support being used as a title parameter for this to work
|
|
1756
|
+
* @default null
|
|
1757
|
+
*/
|
|
1758
|
+
titleParameter?: string | null;
|
|
1759
|
+
/**
|
|
1760
|
+
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
1761
|
+
* @default null
|
|
1762
|
+
*/
|
|
1763
|
+
thumbnailParameter?: string | null;
|
|
1764
|
+
/**
|
|
1765
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
1766
|
+
* @default false
|
|
1767
|
+
*/
|
|
1768
|
+
canBeComposition?: boolean;
|
|
1769
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
1770
|
+
parameters?: components$p["schemas"]["ComponentDefinitionParameter"][];
|
|
1841
1771
|
/**
|
|
1842
1772
|
* Format: uuid
|
|
1843
|
-
* @description
|
|
1773
|
+
* @description Reference to the category this component definition belongs to
|
|
1774
|
+
* @default null
|
|
1844
1775
|
*/
|
|
1845
|
-
|
|
1846
|
-
/** @description
|
|
1847
|
-
|
|
1776
|
+
categoryId?: string | null;
|
|
1777
|
+
/** @description Description of the component definition */
|
|
1778
|
+
description?: string;
|
|
1779
|
+
/** @description Preview image URL for the component definition (shown in the UI) */
|
|
1780
|
+
previewImageUrl?: string;
|
|
1848
1781
|
/**
|
|
1849
|
-
* @description
|
|
1850
|
-
* @default
|
|
1782
|
+
* @description if this component uses team permissions or custom permissions
|
|
1783
|
+
* @default true
|
|
1851
1784
|
*/
|
|
1852
|
-
|
|
1785
|
+
useTeamPermissions?: boolean;
|
|
1786
|
+
/** @description Custom role permissions for this component definition */
|
|
1787
|
+
permissions?: components$p["schemas"]["ComponentDefinitionPermission"][];
|
|
1788
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
1789
|
+
slots?: components$p["schemas"]["ComponentDefinitionSlot"][];
|
|
1790
|
+
slugSettings?: components$p["schemas"]["ComponentDefinitionSlugSettings"];
|
|
1791
|
+
/** @description Default component instance value */
|
|
1792
|
+
defaults?: components$p["schemas"]["ComponentInstance"] | null;
|
|
1793
|
+
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
1794
|
+
variants?: components$p["schemas"]["ComponentDefinitionVariant"][];
|
|
1795
|
+
/** @description Created date string for this definition (ignored for writes) */
|
|
1796
|
+
created?: string;
|
|
1797
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
|
1798
|
+
updated?: string;
|
|
1799
|
+
/**
|
|
1800
|
+
* Format: uuid
|
|
1801
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
1802
|
+
*/
|
|
1803
|
+
workflowId?: string;
|
|
1853
1804
|
};
|
|
1854
1805
|
Error: {
|
|
1855
1806
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -1905,21 +1856,8 @@ interface components$p {
|
|
|
1905
1856
|
pathItems: never;
|
|
1906
1857
|
}
|
|
1907
1858
|
|
|
1908
|
-
type SharedComponents$3 = components$q['schemas'];
|
|
1909
|
-
type Api$2 = paths$m['/api/v1/categories'];
|
|
1910
|
-
/** Shape of the GET response from /api/v1/category */
|
|
1911
|
-
type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
|
1912
|
-
/** Shape of the PUT request body for /api/v1/category */
|
|
1913
|
-
type CategoriesPutParameters = Api$2['put']['requestBody']['content']['application/json'];
|
|
1914
|
-
/** Shape of the DELETE request body for /api/v1/category */
|
|
1915
|
-
type CategoriesDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
|
|
1916
|
-
/** Query parameter options for GET /api/v1/category */
|
|
1917
|
-
type CategoriesGetParameters = Api$2['get']['parameters']['query'];
|
|
1918
|
-
/** Defines a component type that can live on a Composition */
|
|
1919
|
-
type Category = SharedComponents$3['Category'];
|
|
1920
|
-
|
|
1921
1859
|
type SharedComponents$2 = components$q['schemas'];
|
|
1922
|
-
type Api$1 = paths$
|
|
1860
|
+
type Api$1 = paths$m['/api/v1/canvas-definitions'];
|
|
1923
1861
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
|
1924
1862
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
|
1925
1863
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
|
@@ -1943,6 +1881,31 @@ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPerm
|
|
|
1943
1881
|
/** Defines a component type that can live on a Composition */
|
|
1944
1882
|
type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
|
|
1945
1883
|
|
|
1884
|
+
/**
|
|
1885
|
+
* Internal base for the canvas content clients: applies a default limit policy
|
|
1886
|
+
* and the per-client `bypassCache` default. Not exported from the package surface.
|
|
1887
|
+
*/
|
|
1888
|
+
declare abstract class ContentClientBase extends ApiClient<ClientOptions> {
|
|
1889
|
+
protected constructor(options: ClientOptions, defaultBypassCache: boolean);
|
|
1890
|
+
}
|
|
1891
|
+
|
|
1892
|
+
/**
|
|
1893
|
+
* Management client for component definitions.
|
|
1894
|
+
*/
|
|
1895
|
+
declare class ComponentDefinitionClient extends ContentClientBase {
|
|
1896
|
+
constructor(options: ClientOptions);
|
|
1897
|
+
/** Fetches one component definition by id (throws `ApiClientError(404)` if absent). */
|
|
1898
|
+
get(args: {
|
|
1899
|
+
componentId: string;
|
|
1900
|
+
}): Promise<ComponentDefinition>;
|
|
1901
|
+
/** Fetches a list of component definitions. */
|
|
1902
|
+
list(args?: ExceptProject<ComponentDefinitionGetParameters>): Promise<ComponentDefinitionGetResponse>;
|
|
1903
|
+
/** Creates or updates a component definition. */
|
|
1904
|
+
save(def: ExceptProject<ComponentDefinitionPutParameters>): Promise<void>;
|
|
1905
|
+
/** Deletes a component definition. */
|
|
1906
|
+
remove(args: ExceptProject<ComponentDefinitionDeleteParameters>): Promise<void>;
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1946
1909
|
/** Public ID of Canvas personalization component type */
|
|
1947
1910
|
declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
|
|
1948
1911
|
/** Public ID of Canvas A/B test component type */
|
|
@@ -2223,6 +2186,11 @@ interface components$o {
|
|
|
2223
2186
|
* @description Modified date string for this definition
|
|
2224
2187
|
*/
|
|
2225
2188
|
modified: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* Format: date-time
|
|
2191
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
2192
|
+
*/
|
|
2193
|
+
deletedAt?: string;
|
|
2226
2194
|
/**
|
|
2227
2195
|
* @description True if the entry is a pattern (which can be referenced on other entries)
|
|
2228
2196
|
* @default false
|
|
@@ -2693,7 +2661,9 @@ interface components$o {
|
|
|
2693
2661
|
withWorkflowDefinition: boolean;
|
|
2694
2662
|
/**
|
|
2695
2663
|
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
|
2696
|
-
* If false, the `_id` will not be present in the API response
|
|
2664
|
+
* If false, the `_id` will not be present in the API response.
|
|
2665
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
2666
|
+
* Prefer selecting a `format` rather than using this option.
|
|
2697
2667
|
*/
|
|
2698
2668
|
withComponentIDs: boolean;
|
|
2699
2669
|
/**
|
|
@@ -2713,16 +2683,33 @@ interface components$o {
|
|
|
2713
2683
|
withTotalCount: boolean;
|
|
2714
2684
|
/** @description Performs keyword search on the entries */
|
|
2715
2685
|
keyword: string;
|
|
2686
|
+
/**
|
|
2687
|
+
* @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
2688
|
+
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
2689
|
+
* - `canonical`: PUT-safe structure — patterns and overrides left
|
|
2690
|
+
* unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
|
|
2691
|
+
* (skipPatternResolution=true, skipOverridesResolution=true,
|
|
2692
|
+
* withComponentIDs=true).
|
|
2693
|
+
* - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
|
|
2694
|
+
* the expanded pattern nodes.
|
|
2695
|
+
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
2696
|
+
* and component `_id`s removed.
|
|
2697
|
+
*/
|
|
2698
|
+
format: "canonical" | "editor" | "delivery";
|
|
2716
2699
|
/**
|
|
2717
2700
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
2718
2701
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
2719
|
-
* embedded into it, and serialize the pattern data separately
|
|
2702
|
+
* embedded into it, and serialize the pattern data separately.
|
|
2703
|
+
* Default: true when `format` is canonical. False otherwise
|
|
2704
|
+
* Prefer selecting a `format` rather than using this option.
|
|
2720
2705
|
*/
|
|
2721
2706
|
skipPatternResolution: boolean;
|
|
2722
2707
|
/**
|
|
2723
2708
|
* @description If true, any pattern override data is not resolved by the API.
|
|
2724
2709
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
2725
|
-
* Passing this parameter automatically implies withComponentIDs to be true
|
|
2710
|
+
* Passing this parameter automatically implies withComponentIDs to be true.
|
|
2711
|
+
* Default: true when `format` is canonical or editor. False otherwise.
|
|
2712
|
+
* Prefer selecting a `format` rather than using this option.
|
|
2726
2713
|
*/
|
|
2727
2714
|
skipOverridesResolution: boolean;
|
|
2728
2715
|
/**
|
|
@@ -2789,6 +2776,14 @@ interface components$o {
|
|
|
2789
2776
|
* If versionId is passed, this is always enabled.
|
|
2790
2777
|
*/
|
|
2791
2778
|
editions: "auto" | "all" | "raw";
|
|
2779
|
+
/**
|
|
2780
|
+
* @description Controls filtering of trashed items.
|
|
2781
|
+
*
|
|
2782
|
+
* exclude: (default) Only return items not in trash.
|
|
2783
|
+
* only: Only return trashed items (for trash view).
|
|
2784
|
+
* include: Return both trashed and non-trashed items.
|
|
2785
|
+
*/
|
|
2786
|
+
deleted: "exclude" | "only" | "include";
|
|
2792
2787
|
};
|
|
2793
2788
|
requestBodies: never;
|
|
2794
2789
|
headers: never;
|
|
@@ -2814,6 +2809,8 @@ interface paths$l {
|
|
|
2814
2809
|
limit?: number;
|
|
2815
2810
|
/** @description Limit the types of content type to return. If not specified, both block types and content types are returned */
|
|
2816
2811
|
type?: "block" | "contentType";
|
|
2812
|
+
/** @description Limit the response to the content types (or block types) matching these public IDs. */
|
|
2813
|
+
contentTypeIDs?: string[];
|
|
2817
2814
|
};
|
|
2818
2815
|
header?: never;
|
|
2819
2816
|
path?: never;
|
|
@@ -3311,7 +3308,9 @@ interface paths$k {
|
|
|
3311
3308
|
withWorkflowDefinition?: components$m["parameters"]["withWorkflowDefinition"];
|
|
3312
3309
|
/**
|
|
3313
3310
|
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
|
3314
|
-
* If false, the `_id` will not be present in the API response
|
|
3311
|
+
* If false, the `_id` will not be present in the API response.
|
|
3312
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
3313
|
+
* Prefer selecting a `format` rather than using this option.
|
|
3315
3314
|
*/
|
|
3316
3315
|
withComponentIDs?: components$m["parameters"]["withComponentIDs"];
|
|
3317
3316
|
/** @description Performs keyword search on the entries */
|
|
@@ -3319,7 +3318,9 @@ interface paths$k {
|
|
|
3319
3318
|
/**
|
|
3320
3319
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
3321
3320
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
3322
|
-
* embedded into it, and serialize the pattern data separately
|
|
3321
|
+
* embedded into it, and serialize the pattern data separately.
|
|
3322
|
+
* Default: true when `format` is canonical. False otherwise
|
|
3323
|
+
* Prefer selecting a `format` rather than using this option.
|
|
3323
3324
|
*/
|
|
3324
3325
|
skipPatternResolution?: components$m["parameters"]["skipPatternResolution"];
|
|
3325
3326
|
/**
|
|
@@ -3330,7 +3331,9 @@ interface paths$k {
|
|
|
3330
3331
|
/**
|
|
3331
3332
|
* @description If true, any pattern override data is not resolved by the API.
|
|
3332
3333
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
3333
|
-
* Passing this parameter automatically implies withComponentIDs to be true
|
|
3334
|
+
* Passing this parameter automatically implies withComponentIDs to be true.
|
|
3335
|
+
* Default: true when `format` is canonical or editor. False otherwise.
|
|
3336
|
+
* Prefer selecting a `format` rather than using this option.
|
|
3334
3337
|
*/
|
|
3335
3338
|
skipOverridesResolution?: components$m["parameters"]["skipOverridesResolution"];
|
|
3336
3339
|
/**
|
|
@@ -3385,6 +3388,27 @@ interface paths$k {
|
|
|
3385
3388
|
* If versionId is passed, this is always enabled.
|
|
3386
3389
|
*/
|
|
3387
3390
|
editions?: components$m["parameters"]["editions"];
|
|
3391
|
+
/**
|
|
3392
|
+
* @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
3393
|
+
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
3394
|
+
* - `canonical`: PUT-safe structure — patterns and overrides left
|
|
3395
|
+
* unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
|
|
3396
|
+
* (skipPatternResolution=true, skipOverridesResolution=true,
|
|
3397
|
+
* withComponentIDs=true).
|
|
3398
|
+
* - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
|
|
3399
|
+
* the expanded pattern nodes.
|
|
3400
|
+
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
3401
|
+
* and component `_id`s removed.
|
|
3402
|
+
*/
|
|
3403
|
+
format?: components$m["parameters"]["format"];
|
|
3404
|
+
/**
|
|
3405
|
+
* @description Controls filtering of trashed items.
|
|
3406
|
+
*
|
|
3407
|
+
* exclude: (default) Only return items not in trash.
|
|
3408
|
+
* only: Only return trashed items (for trash view).
|
|
3409
|
+
* include: Return both trashed and non-trashed items.
|
|
3410
|
+
*/
|
|
3411
|
+
deleted?: components$m["parameters"]["deleted"];
|
|
3388
3412
|
};
|
|
3389
3413
|
header?: never;
|
|
3390
3414
|
path?: never;
|
|
@@ -4066,6 +4090,11 @@ interface components$m {
|
|
|
4066
4090
|
* @description Modified date string for this definition
|
|
4067
4091
|
*/
|
|
4068
4092
|
modified: string;
|
|
4093
|
+
/**
|
|
4094
|
+
* Format: date-time
|
|
4095
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
4096
|
+
*/
|
|
4097
|
+
deletedAt?: string;
|
|
4069
4098
|
/**
|
|
4070
4099
|
* @description True if the entry is a pattern (which can be referenced on other entries)
|
|
4071
4100
|
* @default false
|
|
@@ -4296,7 +4325,9 @@ interface components$m {
|
|
|
4296
4325
|
withWorkflowDefinition: boolean;
|
|
4297
4326
|
/**
|
|
4298
4327
|
* @description If true the `_id` unique identifier of blocks will be part of the response data.
|
|
4299
|
-
* If false, the `_id` will not be present in the API response
|
|
4328
|
+
* If false, the `_id` will not be present in the API response.
|
|
4329
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
4330
|
+
* Prefer selecting a `format` rather than using this option.
|
|
4300
4331
|
*/
|
|
4301
4332
|
withComponentIDs: boolean;
|
|
4302
4333
|
/** @description Performs keyword search on the entries */
|
|
@@ -4304,7 +4335,9 @@ interface components$m {
|
|
|
4304
4335
|
/**
|
|
4305
4336
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
4306
4337
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
4307
|
-
* embedded into it, and serialize the pattern data separately
|
|
4338
|
+
* embedded into it, and serialize the pattern data separately.
|
|
4339
|
+
* Default: true when `format` is canonical. False otherwise
|
|
4340
|
+
* Prefer selecting a `format` rather than using this option.
|
|
4308
4341
|
*/
|
|
4309
4342
|
skipPatternResolution: boolean;
|
|
4310
4343
|
/**
|
|
@@ -4315,7 +4348,9 @@ interface components$m {
|
|
|
4315
4348
|
/**
|
|
4316
4349
|
* @description If true, any pattern override data is not resolved by the API.
|
|
4317
4350
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
4318
|
-
* Passing this parameter automatically implies withComponentIDs to be true
|
|
4351
|
+
* Passing this parameter automatically implies withComponentIDs to be true.
|
|
4352
|
+
* Default: true when `format` is canonical or editor. False otherwise.
|
|
4353
|
+
* Prefer selecting a `format` rather than using this option.
|
|
4319
4354
|
*/
|
|
4320
4355
|
skipOverridesResolution: boolean;
|
|
4321
4356
|
/**
|
|
@@ -4370,6 +4405,27 @@ interface components$m {
|
|
|
4370
4405
|
* If versionId is passed, this is always enabled.
|
|
4371
4406
|
*/
|
|
4372
4407
|
editions: "auto" | "all" | "raw";
|
|
4408
|
+
/**
|
|
4409
|
+
* @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
4410
|
+
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
4411
|
+
* - `canonical`: PUT-safe structure — patterns and overrides left
|
|
4412
|
+
* unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
|
|
4413
|
+
* (skipPatternResolution=true, skipOverridesResolution=true,
|
|
4414
|
+
* withComponentIDs=true).
|
|
4415
|
+
* - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
|
|
4416
|
+
* the expanded pattern nodes.
|
|
4417
|
+
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
4418
|
+
* and component `_id`s removed.
|
|
4419
|
+
*/
|
|
4420
|
+
format: "canonical" | "editor" | "delivery";
|
|
4421
|
+
/**
|
|
4422
|
+
* @description Controls filtering of trashed items.
|
|
4423
|
+
*
|
|
4424
|
+
* exclude: (default) Only return items not in trash.
|
|
4425
|
+
* only: Only return trashed items (for trash view).
|
|
4426
|
+
* include: Return both trashed and non-trashed items.
|
|
4427
|
+
*/
|
|
4428
|
+
deleted: "exclude" | "only" | "include";
|
|
4373
4429
|
};
|
|
4374
4430
|
requestBodies: never;
|
|
4375
4431
|
headers: never;
|
|
@@ -4448,9 +4504,11 @@ interface components$l {
|
|
|
4448
4504
|
versionId: string;
|
|
4449
4505
|
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
4450
4506
|
timestamp: number;
|
|
4451
|
-
/** @description The name (full name) of the user who created the version */
|
|
4507
|
+
/** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
4452
4508
|
authorName: string;
|
|
4453
4509
|
authorIsApiKey: boolean;
|
|
4510
|
+
/** @description The identity who created the version; absent on old history entries. */
|
|
4511
|
+
authorSubject?: string;
|
|
4454
4512
|
/** @description The state of the entity when the history entry was made */
|
|
4455
4513
|
state: number;
|
|
4456
4514
|
};
|
|
@@ -6582,6 +6640,11 @@ interface components$e {
|
|
|
6582
6640
|
* @description Modified date string for this composition
|
|
6583
6641
|
*/
|
|
6584
6642
|
modified: string;
|
|
6643
|
+
/**
|
|
6644
|
+
* Format: date-time
|
|
6645
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
6646
|
+
*/
|
|
6647
|
+
deletedAt?: string;
|
|
6585
6648
|
/** @description User name of the creator of this composition */
|
|
6586
6649
|
creator?: string;
|
|
6587
6650
|
/** @description User name of the last editor of this composition */
|
|
@@ -6672,7 +6735,7 @@ interface components$e {
|
|
|
6672
6735
|
withComponentIDs: boolean;
|
|
6673
6736
|
/**
|
|
6674
6737
|
* @deprecated
|
|
6675
|
-
* @description
|
|
6738
|
+
* @description Has no effect.
|
|
6676
6739
|
*/
|
|
6677
6740
|
withContentSourceMap: boolean;
|
|
6678
6741
|
/**
|
|
@@ -6939,7 +7002,9 @@ interface paths$c {
|
|
|
6939
7002
|
/**
|
|
6940
7003
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
6941
7004
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
6942
|
-
* embedded into it, and serialize the pattern data separately
|
|
7005
|
+
* embedded into it, and serialize the pattern data separately.
|
|
7006
|
+
* Default: true when `format` is canonical. False otherwise.
|
|
7007
|
+
* Prefer selecting a `format` rather than using this option.
|
|
6943
7008
|
*/
|
|
6944
7009
|
skipPatternResolution?: components$d["parameters"]["skipPatternResolution"];
|
|
6945
7010
|
/**
|
|
@@ -6950,7 +7015,9 @@ interface paths$c {
|
|
|
6950
7015
|
/**
|
|
6951
7016
|
* @description If true, any pattern override data is not resolved by the API.
|
|
6952
7017
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
6953
|
-
* Passing this parameter automatically implies `withComponentIDs` is true
|
|
7018
|
+
* Passing this parameter automatically implies `withComponentIDs` is true.
|
|
7019
|
+
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7020
|
+
* Prefer selecting a `format` rather than using this option.
|
|
6954
7021
|
*/
|
|
6955
7022
|
skipOverridesResolution?: components$d["parameters"]["skipOverridesResolution"];
|
|
6956
7023
|
/**
|
|
@@ -6990,7 +7057,9 @@ interface paths$c {
|
|
|
6990
7057
|
updatedBy?: components$d["parameters"]["updatedBy"];
|
|
6991
7058
|
/**
|
|
6992
7059
|
* @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
6993
|
-
* If false, the `_id` will not be present in the API response
|
|
7060
|
+
* If false, the `_id` will not be present in the API response.
|
|
7061
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7062
|
+
* Prefer selecting a `format` rather than using this option.
|
|
6994
7063
|
*/
|
|
6995
7064
|
withComponentIDs?: components$d["parameters"]["withComponentIDs"];
|
|
6996
7065
|
/**
|
|
@@ -7010,7 +7079,7 @@ interface paths$c {
|
|
|
7010
7079
|
withProjectMapNodes?: components$d["parameters"]["withProjectMapNodes"];
|
|
7011
7080
|
/**
|
|
7012
7081
|
* @deprecated
|
|
7013
|
-
* @description
|
|
7082
|
+
* @description Has no effect.
|
|
7014
7083
|
*/
|
|
7015
7084
|
withContentSourceMap?: components$d["parameters"]["withContentSourceMap"];
|
|
7016
7085
|
/**
|
|
@@ -7067,6 +7136,27 @@ interface paths$c {
|
|
|
7067
7136
|
* If versionId is passed, this is always enabled.
|
|
7068
7137
|
*/
|
|
7069
7138
|
editions?: components$d["parameters"]["editions"];
|
|
7139
|
+
/**
|
|
7140
|
+
* @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7141
|
+
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
7142
|
+
* - `canonical`: PUT-safe structure — patterns and overrides left
|
|
7143
|
+
* unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
|
|
7144
|
+
* (skipPatternResolution=true, skipOverridesResolution=true,
|
|
7145
|
+
* withComponentIDs=true).
|
|
7146
|
+
* - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
|
|
7147
|
+
* the expanded pattern nodes.
|
|
7148
|
+
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7149
|
+
* and component `_id`s removed.
|
|
7150
|
+
*/
|
|
7151
|
+
format?: components$d["parameters"]["format"];
|
|
7152
|
+
/**
|
|
7153
|
+
* @description Controls filtering of trashed items.
|
|
7154
|
+
*
|
|
7155
|
+
* exclude: (default) Only return items not in trash.
|
|
7156
|
+
* only: Only return trashed items (for trash view).
|
|
7157
|
+
* include: Return both trashed and non-trashed items.
|
|
7158
|
+
*/
|
|
7159
|
+
deleted?: components$d["parameters"]["deleted"];
|
|
7070
7160
|
};
|
|
7071
7161
|
header?: never;
|
|
7072
7162
|
path?: never;
|
|
@@ -7314,6 +7404,11 @@ interface components$d {
|
|
|
7314
7404
|
* @description Modified date string for this composition
|
|
7315
7405
|
*/
|
|
7316
7406
|
modified: string;
|
|
7407
|
+
/**
|
|
7408
|
+
* Format: date-time
|
|
7409
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7410
|
+
*/
|
|
7411
|
+
deletedAt?: string;
|
|
7317
7412
|
/** @description User name of the creator of this composition */
|
|
7318
7413
|
creator?: string;
|
|
7319
7414
|
/** @description User name of the last editor of this composition */
|
|
@@ -8015,16 +8110,33 @@ interface components$d {
|
|
|
8015
8110
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
8016
8111
|
*/
|
|
8017
8112
|
skipEnhance: boolean;
|
|
8113
|
+
/**
|
|
8114
|
+
* @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
8115
|
+
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
8116
|
+
* - `canonical`: PUT-safe structure — patterns and overrides left
|
|
8117
|
+
* unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
|
|
8118
|
+
* (skipPatternResolution=true, skipOverridesResolution=true,
|
|
8119
|
+
* withComponentIDs=true).
|
|
8120
|
+
* - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
|
|
8121
|
+
* the expanded pattern nodes.
|
|
8122
|
+
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
8123
|
+
* and component `_id`s removed.
|
|
8124
|
+
*/
|
|
8125
|
+
format: "canonical" | "editor" | "delivery";
|
|
8018
8126
|
/**
|
|
8019
8127
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
8020
8128
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
8021
|
-
* embedded into it, and serialize the pattern data separately
|
|
8129
|
+
* embedded into it, and serialize the pattern data separately.
|
|
8130
|
+
* Default: true when `format` is canonical. False otherwise.
|
|
8131
|
+
* Prefer selecting a `format` rather than using this option.
|
|
8022
8132
|
*/
|
|
8023
8133
|
skipPatternResolution: boolean;
|
|
8024
8134
|
/**
|
|
8025
8135
|
* @description If true, any pattern override data is not resolved by the API.
|
|
8026
8136
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
8027
|
-
* Passing this parameter automatically implies `withComponentIDs` is true
|
|
8137
|
+
* Passing this parameter automatically implies `withComponentIDs` is true.
|
|
8138
|
+
* Default: true when `format` is canonical or editor. False otherwise.
|
|
8139
|
+
* Prefer selecting a `format` rather than using this option.
|
|
8028
8140
|
*/
|
|
8029
8141
|
skipOverridesResolution: boolean;
|
|
8030
8142
|
/**
|
|
@@ -8034,7 +8146,9 @@ interface components$d {
|
|
|
8034
8146
|
skipParameterResolution: boolean;
|
|
8035
8147
|
/**
|
|
8036
8148
|
* @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
8037
|
-
* If false, the `_id` will not be present in the API response
|
|
8149
|
+
* If false, the `_id` will not be present in the API response.
|
|
8150
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
8151
|
+
* Prefer selecting a `format` rather than using this option.
|
|
8038
8152
|
*/
|
|
8039
8153
|
withComponentIDs: boolean;
|
|
8040
8154
|
/**
|
|
@@ -8100,7 +8214,7 @@ interface components$d {
|
|
|
8100
8214
|
withProjectMapNodes: boolean;
|
|
8101
8215
|
/**
|
|
8102
8216
|
* @deprecated
|
|
8103
|
-
* @description
|
|
8217
|
+
* @description Has no effect.
|
|
8104
8218
|
*/
|
|
8105
8219
|
withContentSourceMap: boolean;
|
|
8106
8220
|
/**
|
|
@@ -8172,6 +8286,14 @@ interface components$d {
|
|
|
8172
8286
|
* If versionId is passed, this is always enabled.
|
|
8173
8287
|
*/
|
|
8174
8288
|
editions: "auto" | "all" | "raw";
|
|
8289
|
+
/**
|
|
8290
|
+
* @description Controls filtering of trashed items.
|
|
8291
|
+
*
|
|
8292
|
+
* exclude: (default) Only return items not in trash.
|
|
8293
|
+
* only: Only return trashed items (for trash view).
|
|
8294
|
+
* include: Return both trashed and non-trashed items.
|
|
8295
|
+
*/
|
|
8296
|
+
deleted: "exclude" | "only" | "include";
|
|
8175
8297
|
};
|
|
8176
8298
|
requestBodies: never;
|
|
8177
8299
|
headers: never;
|
|
@@ -8247,9 +8369,11 @@ interface components$c {
|
|
|
8247
8369
|
versionId: string;
|
|
8248
8370
|
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
8249
8371
|
timestamp: number;
|
|
8250
|
-
/** @description The name (full name) of the user who created the version */
|
|
8372
|
+
/** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
8251
8373
|
authorName: string;
|
|
8252
8374
|
authorIsApiKey: boolean;
|
|
8375
|
+
/** @description The identity who created the version; absent on old history entries. */
|
|
8376
|
+
authorSubject?: string;
|
|
8253
8377
|
/** @description The state of the entity when the history entry was made */
|
|
8254
8378
|
state: number;
|
|
8255
8379
|
};
|
|
@@ -8995,6 +9119,11 @@ interface components$b {
|
|
|
8995
9119
|
* @description Modified date string for this composition
|
|
8996
9120
|
*/
|
|
8997
9121
|
modified: string;
|
|
9122
|
+
/**
|
|
9123
|
+
* Format: date-time
|
|
9124
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9125
|
+
*/
|
|
9126
|
+
deletedAt?: string;
|
|
8998
9127
|
/** @description User name of the creator of this composition */
|
|
8999
9128
|
creator?: string;
|
|
9000
9129
|
/** @description User name of the last editor of this composition */
|
|
@@ -9225,6 +9354,11 @@ interface components$b {
|
|
|
9225
9354
|
* @description Modified date string for this definition
|
|
9226
9355
|
*/
|
|
9227
9356
|
modified: string;
|
|
9357
|
+
/**
|
|
9358
|
+
* Format: date-time
|
|
9359
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9360
|
+
*/
|
|
9361
|
+
deletedAt?: string;
|
|
9228
9362
|
/**
|
|
9229
9363
|
* @description True if the entry is a pattern (which can be referenced on other entries)
|
|
9230
9364
|
* @default false
|
|
@@ -9437,7 +9571,9 @@ interface components$b {
|
|
|
9437
9571
|
/**
|
|
9438
9572
|
* @description If true, any pattern references in the composition will be left unresolved.
|
|
9439
9573
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
9440
|
-
* embedded into it, and serialize the pattern data separately
|
|
9574
|
+
* embedded into it, and serialize the pattern data separately.
|
|
9575
|
+
* Default: true when `format` is canonical. False otherwise.
|
|
9576
|
+
* Prefer selecting a `format` rather than using this option.
|
|
9441
9577
|
*/
|
|
9442
9578
|
skipPatternResolution: boolean;
|
|
9443
9579
|
/**
|
|
@@ -9469,7 +9605,9 @@ interface components$b {
|
|
|
9469
9605
|
updatedBy: string;
|
|
9470
9606
|
/**
|
|
9471
9607
|
* @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
9472
|
-
* If false, the `_id` will not be present in the API response
|
|
9608
|
+
* If false, the `_id` will not be present in the API response.
|
|
9609
|
+
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
9610
|
+
* Prefer selecting a `format` rather than using this option.
|
|
9473
9611
|
*/
|
|
9474
9612
|
withComponentIDs: boolean;
|
|
9475
9613
|
/**
|
|
@@ -9485,7 +9623,7 @@ interface components$b {
|
|
|
9485
9623
|
withUIStatus: boolean;
|
|
9486
9624
|
/**
|
|
9487
9625
|
* @deprecated
|
|
9488
|
-
* @description
|
|
9626
|
+
* @description Has no effect.
|
|
9489
9627
|
*/
|
|
9490
9628
|
withContentSourceMap: boolean;
|
|
9491
9629
|
/**
|
|
@@ -9739,7 +9877,7 @@ interface paths$a {
|
|
|
9739
9877
|
withComponentIDs?: components$a["parameters"]["withComponentIDs"];
|
|
9740
9878
|
/**
|
|
9741
9879
|
* @deprecated
|
|
9742
|
-
* @description
|
|
9880
|
+
* @description Has no effect.
|
|
9743
9881
|
*/
|
|
9744
9882
|
withContentSourceMap?: components$a["parameters"]["withContentSourceMap"];
|
|
9745
9883
|
/**
|
|
@@ -10421,6 +10559,11 @@ interface components$a {
|
|
|
10421
10559
|
* @description Modified date string for this composition
|
|
10422
10560
|
*/
|
|
10423
10561
|
modified: string;
|
|
10562
|
+
/**
|
|
10563
|
+
* Format: date-time
|
|
10564
|
+
* @description Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
10565
|
+
*/
|
|
10566
|
+
deletedAt?: string;
|
|
10424
10567
|
/** @description User name of the creator of this composition */
|
|
10425
10568
|
creator?: string;
|
|
10426
10569
|
/** @description User name of the last editor of this composition */
|
|
@@ -10586,7 +10729,7 @@ interface components$a {
|
|
|
10586
10729
|
withComponentIDs: boolean;
|
|
10587
10730
|
/**
|
|
10588
10731
|
* @deprecated
|
|
10589
|
-
* @description
|
|
10732
|
+
* @description Has no effect.
|
|
10590
10733
|
*/
|
|
10591
10734
|
withContentSourceMap: boolean;
|
|
10592
10735
|
/**
|
|
@@ -10784,7 +10927,7 @@ type CanvasDefinitions = {
|
|
|
10784
10927
|
webhooks?: Array<WebhookDefinition>;
|
|
10785
10928
|
};
|
|
10786
10929
|
/** Defines shared parameters for requests getting a single composition */
|
|
10787
|
-
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId' | 'editions' | 'pattern' | 'withPatternType'>;
|
|
10930
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId' | 'editions' | 'deleted' | 'pattern' | 'withPatternType'>;
|
|
10788
10931
|
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
|
10789
10932
|
type SpecificProjectMap = {
|
|
10790
10933
|
projectMapId?: string;
|
|
@@ -10911,6 +11054,33 @@ type RouteGetResponseEdgehancedNotFound = RouteGetResponseNotFound & {
|
|
|
10911
11054
|
compositionApiResponse?: Pick<CompositionResolvedGetResponse, 'errors' | 'warnings' | 'infos' | 'diagnostics' | 'wholeResponseCacheDiagnostics'>;
|
|
10912
11055
|
};
|
|
10913
11056
|
|
|
11057
|
+
/**
|
|
11058
|
+
* Constructor options for the delivery (edge) clients. Adds the edge-only fields
|
|
11059
|
+
* to the shared client options.
|
|
11060
|
+
*/
|
|
11061
|
+
type DeliveryClientOptions = ClientOptions & {
|
|
11062
|
+
/** Host used for delivery (edge) reads. Defaults to `https://uniform.global`. */
|
|
11063
|
+
edgeApiHost?: string;
|
|
11064
|
+
/**
|
|
11065
|
+
* When true, skips stale-while-revalidate behavior on data resource caches
|
|
11066
|
+
* May result in increased latency for requests that refetch expired data resources,
|
|
11067
|
+
* but is useful if you are caching responses outside of Uniform and require consistency.
|
|
11068
|
+
*/
|
|
11069
|
+
disableSWR?: boolean;
|
|
11070
|
+
};
|
|
11071
|
+
/**
|
|
11072
|
+
* Internal base for the read-only delivery clients: adds edge-host selection,
|
|
11073
|
+
* the SWR header, and diagnostics coercion. Defaults `bypassCache` to false.
|
|
11074
|
+
* Not exported from the package surface.
|
|
11075
|
+
*/
|
|
11076
|
+
declare abstract class DeliveryClientBase extends ContentClientBase {
|
|
11077
|
+
protected readonly edgeApiHost: string;
|
|
11078
|
+
protected readonly edgeRequestInit?: RequestInit;
|
|
11079
|
+
protected constructor(options: DeliveryClientOptions);
|
|
11080
|
+
/** Coerces the `diagnostics` option into the shape the edge endpoints accept. */
|
|
11081
|
+
protected coerceDiagnostics(diagnostics?: boolean | 'no-data'): boolean | 'no-data' | undefined;
|
|
11082
|
+
}
|
|
11083
|
+
|
|
10914
11084
|
type PreviewPanelSettings = {
|
|
10915
11085
|
isVisualEditingDisabled?: boolean;
|
|
10916
11086
|
};
|
|
@@ -12131,6 +12301,14 @@ interface paths$5 {
|
|
|
12131
12301
|
limit?: number;
|
|
12132
12302
|
/** @description Matches release contents where their public ID is one of a list */
|
|
12133
12303
|
publicIDs?: components$5["schemas"]["PublicIdProperty"][];
|
|
12304
|
+
/**
|
|
12305
|
+
* @description Controls filtering of trashed items.
|
|
12306
|
+
*
|
|
12307
|
+
* exclude: (default) Only return items not in trash.
|
|
12308
|
+
* only: Only return trashed items (for trash view).
|
|
12309
|
+
* include: Return both trashed and non-trashed items.
|
|
12310
|
+
*/
|
|
12311
|
+
deleted?: components$5["parameters"]["deleted"];
|
|
12134
12312
|
};
|
|
12135
12313
|
header?: never;
|
|
12136
12314
|
path?: never;
|
|
@@ -12317,7 +12495,16 @@ interface components$5 {
|
|
|
12317
12495
|
content?: never;
|
|
12318
12496
|
};
|
|
12319
12497
|
};
|
|
12320
|
-
parameters:
|
|
12498
|
+
parameters: {
|
|
12499
|
+
/**
|
|
12500
|
+
* @description Controls filtering of trashed items.
|
|
12501
|
+
*
|
|
12502
|
+
* exclude: (default) Only return items not in trash.
|
|
12503
|
+
* only: Only return trashed items (for trash view).
|
|
12504
|
+
* include: Return both trashed and non-trashed items.
|
|
12505
|
+
*/
|
|
12506
|
+
deleted: "exclude" | "only" | "include";
|
|
12507
|
+
};
|
|
12321
12508
|
requestBodies: never;
|
|
12322
12509
|
headers: never;
|
|
12323
12510
|
pathItems: never;
|
|
@@ -12930,13 +13117,358 @@ type WorkflowsPutParameters = WorkflowsApi['put']['requestBody']['content']['app
|
|
|
12930
13117
|
/** Shape of the DELETE request body for /api/v1/workflows */
|
|
12931
13118
|
type WorkflowsDeleteParameters = WorkflowsApi['delete']['requestBody']['content']['application/json'];
|
|
12932
13119
|
|
|
12933
|
-
|
|
12934
|
-
|
|
12935
|
-
|
|
13120
|
+
/**
|
|
13121
|
+
* Data projection wire grammar (`select.*` query parameters) and shared spec
|
|
13122
|
+
* type used by every consumer of projections: API serializers (SDK clients),
|
|
13123
|
+
* the origin pruner (lib/canvas-sdk applyProjection), and localize (for the
|
|
13124
|
+
* representation-modifier operator `fields[locales]`).
|
|
13125
|
+
*
|
|
13126
|
+
* Wire grammar (mirrors `filters.*`):
|
|
13127
|
+
*
|
|
13128
|
+
* select.fields[only]=name,seo_*
|
|
13129
|
+
* select.fields[except]=internalNote
|
|
13130
|
+
* select.fields[only]= // strip every field
|
|
13131
|
+
* select.fields[except]=* // strip every field (wildcard form)
|
|
13132
|
+
* select.fields[locales]=slug,seo_*
|
|
13133
|
+
* select.fieldTypes[only]=text,number
|
|
13134
|
+
* select.fieldTypes[except]=richText
|
|
13135
|
+
* select.slots[only]=hero
|
|
13136
|
+
* select.slots[except]=footer
|
|
13137
|
+
* select.slots[depth]=2
|
|
13138
|
+
* select.slots.<name>[depth]=1
|
|
13139
|
+
* select.fields[blockDepth]=2
|
|
13140
|
+
* select.fields[blockDepth]=preserveAll
|
|
13141
|
+
*/
|
|
13142
|
+
/**
|
|
13143
|
+
* Prefix used by every `select.*` query parameter on the wire. Exported so
|
|
13144
|
+
* downstream prefix scans (lambda validator, edge search-param reader,
|
|
13145
|
+
* origin handler short-circuits) and key builders don't hand-roll the
|
|
13146
|
+
* literal at every call site.
|
|
13147
|
+
*/
|
|
13148
|
+
declare const SELECT_QUERY_PREFIX = "select.";
|
|
13149
|
+
type FieldsProjection = {
|
|
13150
|
+
/** Include only fields whose name matches one of these patterns. */
|
|
13151
|
+
only?: string[];
|
|
13152
|
+
/** Exclude fields whose name matches one of these patterns. */
|
|
13153
|
+
except?: string[];
|
|
13154
|
+
/**
|
|
13155
|
+
* Field-name patterns whose value should retain its full per-locale map
|
|
13156
|
+
* (`locales` / `localesConditions`) after `localize` runs. Representation
|
|
13157
|
+
* modifier; the pruner ignores this — see lib/canvas-sdk applyProjection.
|
|
13158
|
+
*/
|
|
13159
|
+
locales?: string[];
|
|
13160
|
+
/**
|
|
13161
|
+
* Controls how far projection descends into block-typed fields (`$block`).
|
|
13162
|
+
* A block field's value is an array of structured content, each with its own
|
|
13163
|
+
* fields, so projection can recurse into it like any other node.
|
|
13164
|
+
*
|
|
13165
|
+
* - Omitted (default): projection descends into blocks without limit,
|
|
13166
|
+
* applying `only`/`except` at every block level.
|
|
13167
|
+
* - A non-negative integer `N`: keep block nesting up to `N` levels. Block
|
|
13168
|
+
* fields on a node at depth `>= N` are dropped; `only`/`except` still
|
|
13169
|
+
* apply within the levels that are kept. `0` removes every block-typed
|
|
13170
|
+
* field; `1` keeps top-level blocks but not blocks nested inside them.
|
|
13171
|
+
* - `'preserveAll'`: Projection does not evaluate within blocks at all:
|
|
13172
|
+
* `only`/`except` do not apply to fields within blocks. The top level block field
|
|
13173
|
+
* is still subject to projection rules, but its descendants are not.
|
|
13174
|
+
*/
|
|
13175
|
+
blockDepth?: number | 'preserveAll';
|
|
13176
|
+
};
|
|
13177
|
+
type FieldTypesProjection = {
|
|
13178
|
+
/** Include only fields whose `type` matches one of these patterns. */
|
|
13179
|
+
only?: string[];
|
|
13180
|
+
/** Exclude fields whose `type` matches one of these patterns. */
|
|
13181
|
+
except?: string[];
|
|
13182
|
+
};
|
|
13183
|
+
type SlotsProjection = {
|
|
13184
|
+
/** Include only slots whose name matches one of these patterns. */
|
|
13185
|
+
only?: string[];
|
|
13186
|
+
/** Exclude slots whose name matches one of these patterns. */
|
|
13187
|
+
except?: string[];
|
|
13188
|
+
/**
|
|
13189
|
+
* Container-wide recursion-depth cap counted in slot levels from the root.
|
|
13190
|
+
* 0 means "no slots at all on the root"; 1 means "root's own slots but no
|
|
13191
|
+
* grandchildren slots". Per-name depth (see `named`) overrides this for
|
|
13192
|
+
* its specific slot.
|
|
13193
|
+
*/
|
|
13194
|
+
depth?: number;
|
|
13195
|
+
/** Per-slot depth caps. Keyed by slot name. */
|
|
13196
|
+
named?: {
|
|
13197
|
+
[slotName: string]: {
|
|
13198
|
+
depth?: number;
|
|
13199
|
+
};
|
|
13200
|
+
};
|
|
13201
|
+
};
|
|
13202
|
+
type ProjectionSpec = {
|
|
13203
|
+
fields?: FieldsProjection;
|
|
13204
|
+
fieldTypes?: FieldTypesProjection;
|
|
13205
|
+
slots?: SlotsProjection;
|
|
13206
|
+
};
|
|
13207
|
+
|
|
13208
|
+
/**
|
|
13209
|
+
* Optional data projection, shared by delivery + management `get`/`list` for
|
|
13210
|
+
* entries and compositions. Serialized to `select.*` querystring parameters
|
|
13211
|
+
* (mirroring `filters.*`) via `projectionToQuery`; the API prunes the response
|
|
13212
|
+
* tree before any downstream processing (dynamic params, localize, edge-side
|
|
13213
|
+
* data fetches). See {@link ProjectionSpec}.
|
|
13214
|
+
*/
|
|
13215
|
+
type Projection = {
|
|
13216
|
+
select?: ProjectionSpec;
|
|
13217
|
+
};
|
|
13218
|
+
/** Lookup keys hoisted into the composition selector unions (so they are not
|
|
13219
|
+
* also accepted in the free-form read-options bag). */
|
|
13220
|
+
type CompositionSelectorKey = 'compositionId' | 'editionId' | 'versionId' | 'slug' | 'projectMapNodeId' | 'projectMapNodePath' | 'projectMapId' | 'componentId';
|
|
13221
|
+
/** Params retired from the new client surface (still accepted by the endpoint). */
|
|
13222
|
+
type CompositionRetiredKey = 'withContentSourceMap' | 'skipEnhance' | 'withWorkflowDefinition';
|
|
13223
|
+
/** `format` is client-owned: management reads use the `'canonical' | 'editor'`
|
|
13224
|
+
* alias (see {@link ManagementFormat}); delivery reads don't send it. */
|
|
13225
|
+
type CompositionClientOwnedKey = 'format';
|
|
13226
|
+
/**
|
|
13227
|
+
* Options shared by composition `get` and `list`, derived from the generated
|
|
13228
|
+
* `/api/v1/canvas` query type. Client-owned keys are removed: `projectId` is
|
|
13229
|
+
* supplied by the client, `editions` is derived per persona, and the selector
|
|
13230
|
+
* lookup keys are hoisted into the selector unions. `state` and the shaping
|
|
13231
|
+
* flags ride along as optional per-call overrides.
|
|
13232
|
+
*/
|
|
13233
|
+
type CompositionReadOptions = Omit<CompositionGetParameters, 'projectId' | 'editions' | CompositionSelectorKey | CompositionRetiredKey | CompositionClientOwnedKey> & Projection;
|
|
13234
|
+
/** Edition resolution for composition list reads (lists take no `editionId`). */
|
|
13235
|
+
type ListEditions = {
|
|
13236
|
+
editions?: 'auto' | 'all' | 'raw';
|
|
13237
|
+
};
|
|
13238
|
+
/** Composition `list` query (shared by delivery + management). */
|
|
13239
|
+
type CompositionListQuery = CompositionReadOptions & ListEditions & {
|
|
13240
|
+
/** Structured filters serialized to `filters.*` on the wire. */
|
|
13241
|
+
filters?: CompositionFilters;
|
|
13242
|
+
};
|
|
13243
|
+
/** Delivery reads expose the data-resolution knobs (depth/variant/diagnostics). */
|
|
13244
|
+
type CompositionDeliveryReadOptions = CompositionReadOptions & DataResolutionParameters;
|
|
13245
|
+
type CompositionDeliveryListQuery = CompositionListQuery & DataResolutionParameters;
|
|
13246
|
+
/**
|
|
13247
|
+
* Read shape for the management clients, selected via the public `format` alias:
|
|
13248
|
+
* - `canonical` (default) — compact PUT-safe shape;
|
|
13249
|
+
* - `editor` — canonical with patterns expanded for display (still PUT-safe).
|
|
13250
|
+
* The individual shaping flags still ride along and override the preset.
|
|
13251
|
+
*/
|
|
13252
|
+
type ManagementFormat = {
|
|
13253
|
+
format?: 'canonical' | 'editor';
|
|
13254
|
+
};
|
|
13255
|
+
/**
|
|
13256
|
+
* Optional edition-mode override for management single-`get`. By default a bare
|
|
13257
|
+
* id reads `raw` and a locale-scoped read resolves editions (`auto`); set this
|
|
13258
|
+
* to force one mode (see {@link resolveManagementEditions}).
|
|
13259
|
+
*/
|
|
13260
|
+
type ManagementEditionsOverride = {
|
|
13261
|
+
editions?: 'raw' | 'auto';
|
|
13262
|
+
};
|
|
13263
|
+
type CompositionManagementReadOptions = CompositionReadOptions & ManagementFormat & ManagementEditionsOverride;
|
|
13264
|
+
type CompositionManagementListQuery = CompositionListQuery & ManagementFormat;
|
|
13265
|
+
type CompositionIdSelector = {
|
|
13266
|
+
compositionId: string;
|
|
13267
|
+
editionId?: string;
|
|
13268
|
+
versionId?: string;
|
|
13269
|
+
};
|
|
13270
|
+
type CompositionSlugSelector = {
|
|
13271
|
+
slug: string;
|
|
13272
|
+
};
|
|
13273
|
+
type CompositionNodeIdSelector = {
|
|
13274
|
+
projectMapNodeId: string;
|
|
13275
|
+
projectMapId?: string;
|
|
13276
|
+
};
|
|
13277
|
+
type CompositionNodePathSelector = {
|
|
13278
|
+
projectMapNodePath: string;
|
|
13279
|
+
projectMapId?: string;
|
|
13280
|
+
};
|
|
13281
|
+
/** Reads a component definition's stored `defaults` tree as a synthetic draft
|
|
13282
|
+
* composition (management-only; `state` is ignored server-side). */
|
|
13283
|
+
type CompositionDefaultsSelector = {
|
|
13284
|
+
componentId: string;
|
|
13285
|
+
};
|
|
13286
|
+
/** Single-composition selector for the delivery client. */
|
|
13287
|
+
type CompositionDeliverySelector = CompositionIdSelector | CompositionSlugSelector | CompositionNodeIdSelector | CompositionNodePathSelector;
|
|
13288
|
+
/** Single-composition selector for the management client (adds the defaults selector). */
|
|
13289
|
+
type CompositionManagementSelector = CompositionDeliverySelector | CompositionDefaultsSelector;
|
|
13290
|
+
/** Selector for write/delete operations that target a specific edition group. */
|
|
13291
|
+
type CompositionWriteSelector = Omit<ExceptProject<CompositionDeleteParameters>, 'state'>;
|
|
13292
|
+
type EntrySelectorKey = 'entryIDs' | 'slug' | 'versionId';
|
|
13293
|
+
type EntryRetiredKey = 'withWorkflowDefinition';
|
|
13294
|
+
/** See {@link CompositionClientOwnedKey} — `format` is replaced by {@link ManagementFormat}. */
|
|
13295
|
+
type EntryClientOwnedKey = 'format';
|
|
13296
|
+
/**
|
|
13297
|
+
* Options shared by entry `get` and `list`, derived from the generated
|
|
13298
|
+
* `/api/v1/entries` query type, with the same client-owned removals as
|
|
13299
|
+
* compositions (see {@link CompositionReadOptions}).
|
|
13300
|
+
*/
|
|
13301
|
+
type EntryReadOptions = Omit<GetEntriesOptions, 'projectId' | 'editions' | EntrySelectorKey | EntryRetiredKey | EntryClientOwnedKey> & Projection;
|
|
13302
|
+
/** Entry `list` query (shared by delivery + management). */
|
|
13303
|
+
type EntryListQuery = EntryReadOptions & ListEditions & {
|
|
13304
|
+
/** Fetch specific entries (or, with `editions: 'raw'`, specific editions) by id. */
|
|
13305
|
+
entryIDs?: string[];
|
|
13306
|
+
/** Filter the list to the entry matching this slug (returns 0 or 1 rows). */
|
|
13307
|
+
slug?: string;
|
|
13308
|
+
/** Structured filters serialized to `filters.*` on the wire. */
|
|
13309
|
+
filters?: EntryFilters;
|
|
13310
|
+
};
|
|
13311
|
+
type EntryDeliveryReadOptions = EntryReadOptions & DataResolutionParameters;
|
|
13312
|
+
type EntryDeliveryListQuery = EntryListQuery & DataResolutionParameters;
|
|
13313
|
+
type EntryManagementReadOptions = EntryReadOptions & ManagementFormat & ManagementEditionsOverride;
|
|
13314
|
+
type EntryManagementListQuery = EntryListQuery & ManagementFormat;
|
|
13315
|
+
/** Single-entry selector. */
|
|
13316
|
+
type EntrySelector = {
|
|
13317
|
+
entryId: string;
|
|
13318
|
+
editionId?: string;
|
|
13319
|
+
versionId?: string;
|
|
13320
|
+
} | {
|
|
13321
|
+
slug: string;
|
|
13322
|
+
};
|
|
13323
|
+
/** Selector for entry write/delete operations targeting a specific edition group. */
|
|
13324
|
+
type EntryWriteSelector = Omit<ExceptProject<DeleteEntryOptions>, 'state'>;
|
|
13325
|
+
/** Optimistic-concurrency option for save / saveAndPublish. */
|
|
13326
|
+
type SaveOptions = {
|
|
13327
|
+
/**
|
|
13328
|
+
* If provided, sends `x-if-unmodified-since`; the server rejects the write
|
|
13329
|
+
* (409) when the target row changed since this timestamp.
|
|
13330
|
+
*/
|
|
13331
|
+
ifUnmodifiedSince?: string;
|
|
12936
13332
|
};
|
|
13333
|
+
/** Result of a write: the new modification timestamp (from `x-modified-at`), or null. */
|
|
13334
|
+
type SaveResult = {
|
|
13335
|
+
modified: string | null;
|
|
13336
|
+
};
|
|
13337
|
+
|
|
13338
|
+
/**
|
|
13339
|
+
* Read-only delivery client for compositions. Hits the edge host with patterns
|
|
13340
|
+
* + overrides + data resources resolved and component `_id`s stripped — the
|
|
13341
|
+
* shape sites/edge serve. Defaults `state` to published and `bypassCache` to
|
|
13342
|
+
* false (cached). It has no write methods by design: you cannot read a
|
|
13343
|
+
* delivery-shaped tree and PUT it back through this client.
|
|
13344
|
+
*/
|
|
13345
|
+
declare class CompositionDeliveryClient extends DeliveryClientBase {
|
|
13346
|
+
constructor(options: DeliveryClientOptions);
|
|
13347
|
+
/** Fetches exactly one composition (throws `ApiClientError(404)` if absent). */
|
|
13348
|
+
get(args: CompositionDeliverySelector & CompositionDeliveryReadOptions): Promise<CompositionResolvedGetResponse>;
|
|
13349
|
+
/** Fetches a list of compositions, optionally filtered. */
|
|
13350
|
+
list(args?: CompositionDeliveryListQuery): Promise<CompositionResolvedListResponse>;
|
|
13351
|
+
}
|
|
13352
|
+
|
|
13353
|
+
/**
|
|
13354
|
+
* Full-CRUD management client for compositions. Reads the canonical (PUT-safe)
|
|
13355
|
+
* shape from the origin host and defaults `state` to draft and `bypassCache` to
|
|
13356
|
+
* true. Pass `format: 'editor'` per call for the editor read shape (patterns
|
|
13357
|
+
* expanded, still PUT-safe).
|
|
13358
|
+
*/
|
|
13359
|
+
declare class CompositionManagementClient extends ContentClientBase {
|
|
13360
|
+
constructor(options: ClientOptions);
|
|
13361
|
+
/**
|
|
13362
|
+
* Fetches one composition in canonical shape (throws `ApiClientError(404)` if
|
|
13363
|
+
* absent).
|
|
13364
|
+
*/
|
|
13365
|
+
get(args: CompositionManagementSelector & CompositionManagementReadOptions): Promise<CompositionGetResponse>;
|
|
13366
|
+
/** Fetches a list of compositions in canonical shape. */
|
|
13367
|
+
list(args?: CompositionManagementListQuery): Promise<CompositionGetListResponse>;
|
|
13368
|
+
/** Creates or updates a composition. Returns the new `x-modified-at` timestamp. */
|
|
13369
|
+
save(body: ExceptProject<CompositionPutParameters>, opts?: SaveOptions): Promise<SaveResult>;
|
|
13370
|
+
/**
|
|
13371
|
+
* Saves the draft and publishes in one call (two PUTs). The optimistic
|
|
13372
|
+
* concurrency guard, if any, applies to the draft write.
|
|
13373
|
+
*/
|
|
13374
|
+
saveAndPublish(body: ExceptProject<Omit<CompositionPutParameters, 'state'>>, opts?: SaveOptions): Promise<SaveResult>;
|
|
13375
|
+
/**
|
|
13376
|
+
* Removes only the published state, leaving the draft intact. Scoped to a
|
|
13377
|
+
* single edition when `editionId` is supplied; otherwise unpublishes all editions.
|
|
13378
|
+
* To unpublish only the base edition, pass editionId and compositionId as the same value.
|
|
13379
|
+
*/
|
|
13380
|
+
unpublish(selector: CompositionWriteSelector): Promise<void>;
|
|
13381
|
+
/**
|
|
13382
|
+
* Deletes across all states. Scoped to a single edition when `editionId` is
|
|
13383
|
+
* supplied; otherwise deletes all states and editions.
|
|
13384
|
+
* Use `unpublish` to drop only the published state.
|
|
13385
|
+
*/
|
|
13386
|
+
remove(selector: CompositionWriteSelector): Promise<void>;
|
|
13387
|
+
/** Fetches historical versions of a composition or pattern. */
|
|
13388
|
+
history(args: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<ComponentInstanceHistoryGetResponse>;
|
|
13389
|
+
private deleteComposition;
|
|
13390
|
+
}
|
|
13391
|
+
|
|
13392
|
+
/**
|
|
13393
|
+
* Management client for content types.
|
|
13394
|
+
*/
|
|
13395
|
+
declare class ContentTypeClient extends ContentClientBase {
|
|
13396
|
+
constructor(options: ClientOptions);
|
|
13397
|
+
/** Fetches one content type by id (throws `ApiClientError(404)` if absent). */
|
|
13398
|
+
get(args: {
|
|
13399
|
+
contentTypeId: string;
|
|
13400
|
+
}): Promise<ContentType>;
|
|
13401
|
+
/** Fetches a list of content types. */
|
|
13402
|
+
list(args?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
|
|
13403
|
+
/** Creates or updates a content type. */
|
|
13404
|
+
save(body: ExceptProject<PutContentTypeBody>, opts?: {
|
|
13405
|
+
autogenerateDataTypes?: boolean;
|
|
13406
|
+
}): Promise<void>;
|
|
13407
|
+
/** Deletes a content type. */
|
|
13408
|
+
remove(args: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
|
|
13409
|
+
}
|
|
13410
|
+
|
|
13411
|
+
/**
|
|
13412
|
+
* Read-only delivery client for entries. Hits the edge host with data resources
|
|
13413
|
+
* resolved and component `_id`s stripped. Defaults `state` to published and
|
|
13414
|
+
* `bypassCache` to false (cached). No write methods by design.
|
|
13415
|
+
*/
|
|
13416
|
+
declare class EntryDeliveryClient extends DeliveryClientBase {
|
|
13417
|
+
constructor(options: DeliveryClientOptions);
|
|
13418
|
+
/** Fetches exactly one entry by id or slug (throws `ApiClientError(404)` if absent). */
|
|
13419
|
+
get(args: EntrySelector & EntryDeliveryReadOptions): Promise<Entry>;
|
|
13420
|
+
/** Fetches a list of entries, optionally filtered. */
|
|
13421
|
+
list(args?: EntryDeliveryListQuery): Promise<GetEntriesResponse>;
|
|
13422
|
+
}
|
|
13423
|
+
|
|
13424
|
+
/**
|
|
13425
|
+
* Full-CRUD management client for entries. Reads the canonical (PUT-safe) shape
|
|
13426
|
+
* from the origin host and defaults `state` to draft and `bypassCache` to true.
|
|
13427
|
+
*/
|
|
13428
|
+
declare class EntryManagementClient extends ContentClientBase {
|
|
13429
|
+
constructor(options: ClientOptions);
|
|
13430
|
+
/**
|
|
13431
|
+
* Fetches one entry by id or slug in canonical shape (throws
|
|
13432
|
+
* `ApiClientError(404)` if absent).
|
|
13433
|
+
*/
|
|
13434
|
+
get(args: EntrySelector & EntryManagementReadOptions): Promise<Entry>;
|
|
13435
|
+
/** Fetches a list of entries in canonical shape. */
|
|
13436
|
+
list(args?: EntryManagementListQuery): Promise<GetEntriesResponse>;
|
|
13437
|
+
/** Creates or updates an entry. Returns the new `x-modified-at` timestamp. */
|
|
13438
|
+
save(body: ExceptProject<PutEntryBody>, opts?: SaveOptions): Promise<SaveResult>;
|
|
13439
|
+
/** Saves the draft and publishes in one call (two PUTs). */
|
|
13440
|
+
saveAndPublish(body: ExceptProject<Omit<PutEntryBody, 'state'>>, opts?: SaveOptions): Promise<SaveResult>;
|
|
13441
|
+
/**
|
|
13442
|
+
* Removes only the published state, leaving the draft intact. Scoped to a
|
|
13443
|
+
* single edition when `editionId` is supplied; otherwise unpublishes all editions.
|
|
13444
|
+
* To unpublish only the base edition, pass editionId and entryId as the same value.
|
|
13445
|
+
*/
|
|
13446
|
+
unpublish(selector: EntryWriteSelector): Promise<void>;
|
|
13447
|
+
/**
|
|
13448
|
+
* Deletes across all states. Scoped to a single edition when `editionId` is
|
|
13449
|
+
* supplied; otherwise deletes all states and editions.
|
|
13450
|
+
* Use `unpublish` to drop only the published state.
|
|
13451
|
+
*/
|
|
13452
|
+
remove(selector: EntryWriteSelector): Promise<void>;
|
|
13453
|
+
/** Fetches historical versions of an entry. */
|
|
13454
|
+
history(args: ExceptProject<EntriesHistoryGetParameters>): Promise<EntriesHistoryGetResponse>;
|
|
13455
|
+
private deleteEntry;
|
|
13456
|
+
}
|
|
13457
|
+
|
|
13458
|
+
type CanvasClientOptions = DeliveryClientOptions;
|
|
12937
13459
|
type UpdateCompositionOptions = {
|
|
12938
13460
|
ifUnmodifiedSince?: string;
|
|
12939
13461
|
};
|
|
13462
|
+
/**
|
|
13463
|
+
* @deprecated Use the persona-shaped clients instead:
|
|
13464
|
+
* - {@link CompositionDeliveryClient} for read-only delivery (resolved) reads,
|
|
13465
|
+
* - {@link CompositionManagementClient} for canonical (PUT-safe) read/write,
|
|
13466
|
+
* - {@link ComponentDefinitionClient} for component definitions.
|
|
13467
|
+
*
|
|
13468
|
+
* The mode (delivery vs management) is now the client class rather than the
|
|
13469
|
+
* `skipDataResolution` flag, which makes the "read resolved → write back →
|
|
13470
|
+
* corrupt" failure unrepresentable.
|
|
13471
|
+
*/
|
|
12940
13472
|
declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
12941
13473
|
private edgeApiHost;
|
|
12942
13474
|
private edgeApiRequestInit?;
|
|
@@ -12992,39 +13524,31 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
12992
13524
|
removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
|
|
12993
13525
|
/** Fetches all Canvas component definitions */
|
|
12994
13526
|
getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
|
|
12995
|
-
componentDefinitions: components$
|
|
13527
|
+
componentDefinitions: components$p["schemas"]["ComponentDefinition"][];
|
|
12996
13528
|
}>;
|
|
12997
13529
|
/** Updates or creates a Canvas component definition */
|
|
12998
13530
|
updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
|
|
12999
13531
|
/** Deletes a Canvas component definition */
|
|
13000
13532
|
removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
|
|
13001
13533
|
}
|
|
13534
|
+
/**
|
|
13535
|
+
* @deprecated Use {@link CompositionManagementClient} (which defaults
|
|
13536
|
+
* `bypassCache: true`), or pass `bypassCache: true` to a delivery client.
|
|
13537
|
+
*/
|
|
13002
13538
|
declare class UncachedCanvasClient extends CanvasClient {
|
|
13003
13539
|
constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
|
|
13004
13540
|
}
|
|
13005
13541
|
|
|
13006
|
-
declare class CategoryClient extends ApiClient {
|
|
13007
|
-
constructor(options: ClientOptions);
|
|
13008
|
-
/** Fetches all categories created in given project */
|
|
13009
|
-
getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
13010
|
-
categories: components$p["schemas"]["Category"][];
|
|
13011
|
-
}>;
|
|
13012
|
-
/** Updates or creates a category, also used to re-order them */
|
|
13013
|
-
upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
13014
|
-
/** Deletes a category */
|
|
13015
|
-
removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
|
|
13016
|
-
}
|
|
13017
|
-
declare class UncachedCategoryClient extends CategoryClient {
|
|
13018
|
-
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
13019
|
-
}
|
|
13020
|
-
|
|
13021
13542
|
type UpsertEntryOptions = {
|
|
13022
13543
|
ifUnmodifiedSince?: string;
|
|
13023
13544
|
};
|
|
13024
|
-
type ContentClientOptions =
|
|
13025
|
-
|
|
13026
|
-
|
|
13027
|
-
}
|
|
13545
|
+
type ContentClientOptions = DeliveryClientOptions;
|
|
13546
|
+
/**
|
|
13547
|
+
* @deprecated Use the persona-shaped clients instead:
|
|
13548
|
+
* - {@link EntryDeliveryClient} for read-only delivery (resolved) reads,
|
|
13549
|
+
* - {@link EntryManagementClient} for canonical (PUT-safe) read/write,
|
|
13550
|
+
* - {@link ContentTypeClient} for content types.
|
|
13551
|
+
*/
|
|
13028
13552
|
declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
13029
13553
|
#private;
|
|
13030
13554
|
private edgeApiHost;
|
|
@@ -13054,6 +13578,10 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
|
13054
13578
|
deleteEntry(body: ExceptProject<DeleteEntryOptions>): Promise<void>;
|
|
13055
13579
|
private getEdgeOptions;
|
|
13056
13580
|
}
|
|
13581
|
+
/**
|
|
13582
|
+
* @deprecated Use {@link EntryManagementClient} (which defaults
|
|
13583
|
+
* `bypassCache: true`), or pass `bypassCache: true` to a delivery client.
|
|
13584
|
+
*/
|
|
13057
13585
|
declare class UncachedContentClient extends ContentClient {
|
|
13058
13586
|
constructor(options: Omit<ContentClientOptions, 'bypassCache'>);
|
|
13059
13587
|
}
|
|
@@ -13061,15 +13589,21 @@ declare class UncachedContentClient extends ContentClient {
|
|
|
13061
13589
|
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
|
13062
13590
|
declare class DataSourceClient extends ApiClient {
|
|
13063
13591
|
constructor(options: ClientOptions);
|
|
13064
|
-
/** Fetches
|
|
13592
|
+
/** Fetches a single DataSource by id (with decrypted secrets). */
|
|
13065
13593
|
get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
|
|
13066
13594
|
result: components$k["schemas"]["DataSource"];
|
|
13067
13595
|
}>;
|
|
13068
|
-
/** Fetches
|
|
13596
|
+
/** Fetches the list of DataSources for a project (secrets masked). */
|
|
13597
|
+
list(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
13598
|
+
results: components$j["schemas"]["DataSource"][];
|
|
13599
|
+
}>;
|
|
13600
|
+
/** @deprecated Use {@link list} instead. */
|
|
13069
13601
|
getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
13070
13602
|
results: components$j["schemas"]["DataSource"][];
|
|
13071
13603
|
}>;
|
|
13072
13604
|
/** Updates or creates (based on id) a DataSource */
|
|
13605
|
+
save(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
|
|
13606
|
+
/** @deprecated Use {@link save} instead. */
|
|
13073
13607
|
upsert(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
|
|
13074
13608
|
/** Deletes a DataSource */
|
|
13075
13609
|
remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
|
|
@@ -13079,9 +13613,13 @@ declare class DataSourceClient extends ApiClient {
|
|
|
13079
13613
|
declare class DataTypeClient extends ApiClient {
|
|
13080
13614
|
#private;
|
|
13081
13615
|
constructor(options: ClientOptions);
|
|
13082
|
-
/** Fetches
|
|
13616
|
+
/** Fetches a list of DataTypes for a project */
|
|
13617
|
+
list(options?: ExceptProject<DataTypeGetParameters>): Promise<DataTypeGetResponse>;
|
|
13618
|
+
/** @deprecated Use {@link list} instead. */
|
|
13083
13619
|
get(options?: ExceptProject<DataTypeGetParameters>): Promise<DataTypeGetResponse>;
|
|
13084
13620
|
/** Updates or creates (based on id) a DataType */
|
|
13621
|
+
save(body: ExceptProject<DataTypePutParameters>): Promise<void>;
|
|
13622
|
+
/** @deprecated Use {@link save} instead. */
|
|
13085
13623
|
upsert(body: ExceptProject<DataTypePutParameters>): Promise<void>;
|
|
13086
13624
|
/** Deletes a DataType */
|
|
13087
13625
|
remove(body: ExceptProject<DataTypeDeleteParameters>): Promise<void>;
|
|
@@ -13347,8 +13885,8 @@ declare function findParameterInNodeTree(data: ComponentInstance | EntryData | A
|
|
|
13347
13885
|
|
|
13348
13886
|
/** Returns the JSON pointer of a component based on its location */
|
|
13349
13887
|
declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference>): string;
|
|
13350
|
-
declare function getNounForLocation(parentLocation: NodeLocationReference | undefined): "
|
|
13351
|
-
declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "
|
|
13888
|
+
declare function getNounForLocation(parentLocation: NodeLocationReference | undefined): "parameters" | "fields";
|
|
13889
|
+
declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "parameters" | "fields";
|
|
13352
13890
|
|
|
13353
13891
|
declare function getComponentPath(ancestorsAndSelf: Array<NodeLocationReference>): string;
|
|
13354
13892
|
|
|
@@ -13611,6 +14149,11 @@ declare function walkPropertyValues(property: ComponentParameter, visitor: (opti
|
|
|
13611
14149
|
declare class EntityReleasesClient extends ApiClient {
|
|
13612
14150
|
constructor(options: ClientOptions);
|
|
13613
14151
|
/** Fetches entity across all releases (and base) */
|
|
14152
|
+
list(options?: ExceptProject<EntityReleasesGetParameters>): Promise<{
|
|
14153
|
+
results: components$6["schemas"]["EntityInRelease"][];
|
|
14154
|
+
totalCount: number;
|
|
14155
|
+
}>;
|
|
14156
|
+
/** @deprecated Use {@link list} instead. */
|
|
13614
14157
|
get(options?: ExceptProject<EntityReleasesGetParameters>): Promise<{
|
|
13615
14158
|
results: components$6["schemas"]["EntityInRelease"][];
|
|
13616
14159
|
totalCount: number;
|
|
@@ -13640,7 +14183,27 @@ declare class IntegrationPropertyEditorsClient extends ApiClient<IntegrationProp
|
|
|
13640
14183
|
}
|
|
13641
14184
|
|
|
13642
14185
|
declare class LabelClient extends ApiClient {
|
|
13643
|
-
/** Fetches labels for the current project. */
|
|
14186
|
+
/** Fetches a list of labels for the current project. */
|
|
14187
|
+
list(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
|
|
14188
|
+
labels: {
|
|
14189
|
+
projectId: string;
|
|
14190
|
+
label: {
|
|
14191
|
+
publicId: string;
|
|
14192
|
+
displayName: string;
|
|
14193
|
+
isGroup: boolean;
|
|
14194
|
+
parent?: string;
|
|
14195
|
+
color: string;
|
|
14196
|
+
description?: string;
|
|
14197
|
+
scope: string[];
|
|
14198
|
+
};
|
|
14199
|
+
created: string;
|
|
14200
|
+
modified: string;
|
|
14201
|
+
createdBy?: string;
|
|
14202
|
+
modifiedBy?: string;
|
|
14203
|
+
}[];
|
|
14204
|
+
totalCount: number;
|
|
14205
|
+
}>;
|
|
14206
|
+
/** @deprecated Use {@link list} instead. */
|
|
13644
14207
|
getLabels(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
|
|
13645
14208
|
labels: {
|
|
13646
14209
|
projectId: string;
|
|
@@ -13661,10 +14224,15 @@ declare class LabelClient extends ApiClient {
|
|
|
13661
14224
|
totalCount: number;
|
|
13662
14225
|
}>;
|
|
13663
14226
|
/** Updates or creates a label. */
|
|
14227
|
+
save(body: Omit<LabelPut, 'projectId'>): Promise<void>;
|
|
14228
|
+
/** @deprecated Use {@link save} instead. */
|
|
13664
14229
|
upsertLabel(body: Omit<LabelPut, 'projectId'>): Promise<void>;
|
|
13665
14230
|
/** Deletes a label by id. */
|
|
14231
|
+
remove(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
|
|
14232
|
+
/** @deprecated Use {@link remove} instead. */
|
|
13666
14233
|
removeLabel(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
|
|
13667
14234
|
}
|
|
14235
|
+
/** @deprecated Pass `bypassCache: true` to {@link LabelClient} instead. */
|
|
13668
14236
|
declare class UncachedLabelClient extends LabelClient {
|
|
13669
14237
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
13670
14238
|
}
|
|
@@ -13672,11 +14240,17 @@ declare class UncachedLabelClient extends LabelClient {
|
|
|
13672
14240
|
/** API client to enable managing project locales */
|
|
13673
14241
|
declare class LocaleClient extends ApiClient {
|
|
13674
14242
|
constructor(options: ClientOptions);
|
|
13675
|
-
/** Fetches
|
|
14243
|
+
/** Fetches a list of locales for a project */
|
|
14244
|
+
list(options?: ExceptProject<LocalesGetParameters>): Promise<{
|
|
14245
|
+
results: components$f["schemas"]["Locale"][];
|
|
14246
|
+
}>;
|
|
14247
|
+
/** @deprecated Use {@link list} instead. */
|
|
13676
14248
|
get(options?: ExceptProject<LocalesGetParameters>): Promise<{
|
|
13677
14249
|
results: components$f["schemas"]["Locale"][];
|
|
13678
14250
|
}>;
|
|
13679
14251
|
/** Updates or creates (based on id) a locale */
|
|
14252
|
+
save(body: ExceptProject<LocalePutParameters>): Promise<void>;
|
|
14253
|
+
/** @deprecated Use {@link save} instead. */
|
|
13680
14254
|
upsert(body: ExceptProject<LocalePutParameters>): Promise<void>;
|
|
13681
14255
|
/** Deletes a locale */
|
|
13682
14256
|
remove(body: ExceptProject<LocaleDeleteParameters>): Promise<void>;
|
|
@@ -14472,10 +15046,16 @@ declare class ProjectClient extends ApiClient {
|
|
|
14472
15046
|
* When teamId is provided, returns a single team with its projects.
|
|
14473
15047
|
* When omitted, returns all accessible teams and their projects.
|
|
14474
15048
|
*/
|
|
15049
|
+
list(options?: ProjectsGetParameters): Promise<ProjectsGetResponse>;
|
|
15050
|
+
/** @deprecated Use {@link list} instead. */
|
|
14475
15051
|
getProjects(options?: ProjectsGetParameters): Promise<ProjectsGetResponse>;
|
|
14476
15052
|
/** Updates or creates (based on id) a Project */
|
|
15053
|
+
save(body: ExceptProject<ProjectPutParameters>): Promise<ProjectPutResponse>;
|
|
15054
|
+
/** @deprecated Use {@link save} instead. */
|
|
14477
15055
|
upsert(body: ExceptProject<ProjectPutParameters>): Promise<ProjectPutResponse>;
|
|
14478
15056
|
/** Deletes a Project */
|
|
15057
|
+
remove(body: ExceptProject<ProjectDeleteParameters>): Promise<void>;
|
|
15058
|
+
/** @deprecated Use {@link remove} instead. */
|
|
14479
15059
|
delete(body: ExceptProject<ProjectDeleteParameters>): Promise<void>;
|
|
14480
15060
|
}
|
|
14481
15061
|
|
|
@@ -14543,7 +15123,11 @@ declare function projectionToQuery(spec: ProjectionSpec | undefined): Record<str
|
|
|
14543
15123
|
*/
|
|
14544
15124
|
declare function queryToProjection(source: URLSearchParams | Record<string, unknown> | null | undefined): ProjectionSpec | undefined;
|
|
14545
15125
|
|
|
14546
|
-
/**
|
|
15126
|
+
/**
|
|
15127
|
+
* API client for the Prompts API.
|
|
15128
|
+
*
|
|
15129
|
+
* @deprecated This client is deprecated and will be removed in a future release.
|
|
15130
|
+
*/
|
|
14547
15131
|
declare class PromptClient extends ApiClient {
|
|
14548
15132
|
constructor(options: ClientOptions);
|
|
14549
15133
|
/** Fetches Prompts for a project */
|
|
@@ -14726,18 +15310,27 @@ declare class RelationshipClient extends ApiClient<ClientOptions & {
|
|
|
14726
15310
|
constructor(options: ClientOptions & {
|
|
14727
15311
|
projectId: string;
|
|
14728
15312
|
});
|
|
15313
|
+
list: (options: ExceptProject<RelationshipsGetParameters>) => Promise<RelationshipsGetResponse>;
|
|
15314
|
+
/** @deprecated Use {@link list} instead. */
|
|
14729
15315
|
get: (options: ExceptProject<RelationshipsGetParameters>) => Promise<RelationshipsGetResponse>;
|
|
14730
15316
|
}
|
|
14731
15317
|
|
|
14732
15318
|
/** API client to enable managing project releases */
|
|
14733
15319
|
declare class ReleaseClient extends ApiClient {
|
|
14734
15320
|
constructor(options: ClientOptions);
|
|
14735
|
-
/** Fetches
|
|
15321
|
+
/** Fetches a list of releases for a project */
|
|
15322
|
+
list(options?: ExceptProject<ReleasesGetParameters>): Promise<{
|
|
15323
|
+
results: components$4["schemas"]["Release"][];
|
|
15324
|
+
totalCount: number;
|
|
15325
|
+
}>;
|
|
15326
|
+
/** @deprecated Use {@link list} instead. */
|
|
14736
15327
|
get(options?: ExceptProject<ReleasesGetParameters>): Promise<{
|
|
14737
15328
|
results: components$4["schemas"]["Release"][];
|
|
14738
15329
|
totalCount: number;
|
|
14739
15330
|
}>;
|
|
14740
15331
|
/** Updates or creates (based on id) a release */
|
|
15332
|
+
save(body: ExceptProject<ReleasePutParameters>): Promise<void>;
|
|
15333
|
+
/** @deprecated Use {@link save} instead. */
|
|
14741
15334
|
upsert(body: ExceptProject<ReleasePutParameters>): Promise<void>;
|
|
14742
15335
|
/** Deletes a release */
|
|
14743
15336
|
remove(body: ExceptProject<ReleaseDeleteParameters>): Promise<void>;
|
|
@@ -14748,7 +15341,12 @@ declare class ReleaseClient extends ApiClient {
|
|
|
14748
15341
|
/** API client interact with release contents */
|
|
14749
15342
|
declare class ReleaseContentsClient extends ApiClient {
|
|
14750
15343
|
constructor(options: ClientOptions);
|
|
14751
|
-
/** Fetches
|
|
15344
|
+
/** Fetches a list of entities added to a release */
|
|
15345
|
+
list(options?: ExceptProject<ReleaseContentsGetParameters>): Promise<{
|
|
15346
|
+
results: components$5["schemas"]["ReleaseContent"][];
|
|
15347
|
+
totalCount: number;
|
|
15348
|
+
}>;
|
|
15349
|
+
/** @deprecated Use {@link list} instead. */
|
|
14752
15350
|
get(options?: ExceptProject<ReleaseContentsGetParameters>): Promise<{
|
|
14753
15351
|
results: components$5["schemas"]["ReleaseContent"][];
|
|
14754
15352
|
totalCount: number;
|
|
@@ -14770,15 +15368,16 @@ type ResolvedRouteGetResponse = RouteGetResponseEdgehancedNotFound | RouteGetRes
|
|
|
14770
15368
|
declare class RouteClient extends ApiClient<RouteClientOptions> {
|
|
14771
15369
|
private edgeApiHost;
|
|
14772
15370
|
constructor(options: RouteClientOptions);
|
|
14773
|
-
/**
|
|
14774
|
-
|
|
14775
|
-
|
|
14776
|
-
|
|
14777
|
-
|
|
14778
|
-
|
|
14779
|
-
|
|
14780
|
-
|
|
14781
|
-
})
|
|
15371
|
+
/**
|
|
15372
|
+
* Resolves a route to a composition, redirect, or not-found result.
|
|
15373
|
+
*
|
|
15374
|
+
* An optional `select` projection applies to the resolved composition when
|
|
15375
|
+
* the route matches one; redirect / notFound responses pass through
|
|
15376
|
+
* untouched.
|
|
15377
|
+
*/
|
|
15378
|
+
get(options?: Omit<RouteGetParameters, 'projectId'> & Projection): Promise<ResolvedRouteGetResponse>;
|
|
15379
|
+
/** @deprecated use {@link RouteClient.get} instead (renamed). */
|
|
15380
|
+
getRoute(options?: Omit<RouteGetParameters, 'projectId'> & Projection): Promise<ResolvedRouteGetResponse>;
|
|
14782
15381
|
}
|
|
14783
15382
|
|
|
14784
15383
|
declare const mergeAssetConfigWithDefaults: (config: AssetParamConfig) => AssetParamConfig;
|
|
@@ -15049,21 +15648,31 @@ declare function createVariableReference(variableName: string): string;
|
|
|
15049
15648
|
declare function hasReferencedVariables(value: string | undefined): number;
|
|
15050
15649
|
|
|
15051
15650
|
/**
|
|
15052
|
-
* Parses an expression that may contain Uniform variables and invokes a callback for each text or variable token found
|
|
15651
|
+
* Parses an expression that may contain Uniform variables and invokes a callback for each text or variable token found.
|
|
15652
|
+
* The callback receives the token, its type, and `offset` — the index in `serialized` where the token's content
|
|
15653
|
+
* begins. Because text tokens are always contiguous substrings of `serialized`, `offset + token.indexOf(x)` maps a
|
|
15654
|
+
* position inside a text token back to the original string (which reconstructing from token lengths cannot do, since
|
|
15655
|
+
* escape characters are stripped from token values).
|
|
15053
15656
|
* @returns the number of tokens found in the string (variable or text)
|
|
15054
15657
|
*/
|
|
15055
|
-
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
|
|
15658
|
+
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
15056
15659
|
|
|
15057
|
-
declare const version = "20.
|
|
15660
|
+
declare const version = "20.74.5";
|
|
15058
15661
|
|
|
15059
15662
|
/** API client to enable managing workflow definitions */
|
|
15060
15663
|
declare class WorkflowClient extends ApiClient {
|
|
15061
15664
|
constructor(options: ClientOptions);
|
|
15062
|
-
/** Fetches workflows for a project */
|
|
15665
|
+
/** Fetches a list of workflows for a project */
|
|
15666
|
+
list(options?: ExceptProject<WorkflowsGetParameters>): Promise<{
|
|
15667
|
+
results: components$3["schemas"]["WorkflowDefinition"][];
|
|
15668
|
+
}>;
|
|
15669
|
+
/** @deprecated Use {@link list} instead. */
|
|
15063
15670
|
get(options?: ExceptProject<WorkflowsGetParameters>): Promise<{
|
|
15064
15671
|
results: components$3["schemas"]["WorkflowDefinition"][];
|
|
15065
15672
|
}>;
|
|
15066
15673
|
/** Updates or creates a workflow definition */
|
|
15674
|
+
save(body: ExceptProject<WorkflowsPutParameters>): Promise<void>;
|
|
15675
|
+
/** @deprecated Use {@link save} instead. */
|
|
15067
15676
|
upsert(body: ExceptProject<WorkflowsPutParameters>): Promise<void>;
|
|
15068
15677
|
/** Deletes a workflow definition */
|
|
15069
15678
|
remove(body: ExceptProject<WorkflowsDeleteParameters>): Promise<void>;
|
|
@@ -15071,4 +15680,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
15071
15680
|
|
|
15072
15681
|
declare const CanvasClientError: typeof ApiClientError;
|
|
15073
15682
|
|
|
15074
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
|
|
15683
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
|