@uniformdev/assets 19.186.4-alpha.3 → 19.187.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1503 -15
- package/dist/index.d.ts +1503 -15
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,1361 @@
|
|
|
1
1
|
import { ApiClient, ClientOptions } from '@uniformdev/context/api';
|
|
2
2
|
|
|
3
|
+
interface components$1 {
|
|
4
|
+
schemas: {
|
|
5
|
+
/** @description Public ID (used in code). Do not change after creation */
|
|
6
|
+
PublicIdProperty: string;
|
|
7
|
+
/** @description The definition of a component parameter */
|
|
8
|
+
ComponentDefinitionParameter: {
|
|
9
|
+
id: components$1["schemas"]["PublicIdProperty"];
|
|
10
|
+
/** @description Friendly name of the parameter */
|
|
11
|
+
name: string;
|
|
12
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
13
|
+
helpText?: string;
|
|
14
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
15
|
+
type: string;
|
|
16
|
+
/**
|
|
17
|
+
* @description If true, this property can have locale-specific values. If false or not defined,
|
|
18
|
+
* this property will have a single value that is shared for all locales
|
|
19
|
+
*/
|
|
20
|
+
localizable?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
23
|
+
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
24
|
+
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
25
|
+
*
|
|
26
|
+
* If `localized` is false, this has no effect.
|
|
27
|
+
*/
|
|
28
|
+
notLocalizedByDefault?: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
31
|
+
* When combined with a localized value, each locale has independent conditional values.
|
|
32
|
+
*
|
|
33
|
+
* When not defined, conditional values are not allowed.
|
|
34
|
+
*/
|
|
35
|
+
allowConditionalValues?: boolean;
|
|
36
|
+
/** @description The configuration object for the type (type-specific) */
|
|
37
|
+
typeConfig?: unknown;
|
|
38
|
+
};
|
|
39
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
40
|
+
ComponentDefinitionSlot: {
|
|
41
|
+
id: components$1["schemas"]["PublicIdProperty"];
|
|
42
|
+
/** @description Friendly name of the slot */
|
|
43
|
+
name: string;
|
|
44
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
45
|
+
allowedComponents: string[];
|
|
46
|
+
/**
|
|
47
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
48
|
+
* If `allowAllComponents` is true, this value is ignored
|
|
49
|
+
*
|
|
50
|
+
* @default false
|
|
51
|
+
*/
|
|
52
|
+
inheritAllowedComponents: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* @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.
|
|
55
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
56
|
+
*/
|
|
57
|
+
allowAllComponents?: boolean;
|
|
58
|
+
/**
|
|
59
|
+
* @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
60
|
+
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
61
|
+
*/
|
|
62
|
+
patternsInAllowedComponents?: boolean;
|
|
63
|
+
/** @description Minimum valid number of components in this slot */
|
|
64
|
+
minComponents?: number;
|
|
65
|
+
/** @description Maximum valid number of components in this slot */
|
|
66
|
+
maxComponents?: number;
|
|
67
|
+
};
|
|
68
|
+
/** @description The definition of a composition's slug settings */
|
|
69
|
+
ComponentDefinitionSlugSettings: {
|
|
70
|
+
/**
|
|
71
|
+
* @description Whether the slug is required
|
|
72
|
+
* no: slug is optional
|
|
73
|
+
* yes: slug is required
|
|
74
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
75
|
+
*
|
|
76
|
+
* @default no
|
|
77
|
+
* @enum {string}
|
|
78
|
+
*/
|
|
79
|
+
required?: "no" | "yes" | "disabled";
|
|
80
|
+
/**
|
|
81
|
+
* @description Slug uniqueness configuration.
|
|
82
|
+
* no = no unique constraint
|
|
83
|
+
* local = must be unique within this component type
|
|
84
|
+
* global = must be unique across all component types
|
|
85
|
+
*
|
|
86
|
+
* @enum {string}
|
|
87
|
+
*/
|
|
88
|
+
unique?: "no" | "local" | "global";
|
|
89
|
+
/** @description Regular expression slugs must match */
|
|
90
|
+
regularExpression?: string;
|
|
91
|
+
/**
|
|
92
|
+
* @description Custom error message when regular expression validation fails.
|
|
93
|
+
* Has no effect if `regularExpression` is not set
|
|
94
|
+
*/
|
|
95
|
+
regularExpressionMessage?: string;
|
|
96
|
+
};
|
|
97
|
+
/** @description The definition of a component variant */
|
|
98
|
+
ComponentDefinitionVariant: {
|
|
99
|
+
id: components$1["schemas"]["PublicIdProperty"];
|
|
100
|
+
/** @description Friendly name of the variant */
|
|
101
|
+
name: string;
|
|
102
|
+
};
|
|
103
|
+
/** @description Permission set for a component definition */
|
|
104
|
+
ComponentDefinitionPermission: {
|
|
105
|
+
roleId: components$1["schemas"]["PublicIdProperty"];
|
|
106
|
+
/**
|
|
107
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
108
|
+
* read | write | create | delete
|
|
109
|
+
*
|
|
110
|
+
* @enum {string}
|
|
111
|
+
*/
|
|
112
|
+
permission: "read" | "write" | "create" | "delete";
|
|
113
|
+
/** @description State of the component that this permission applies to */
|
|
114
|
+
state: number;
|
|
115
|
+
};
|
|
116
|
+
/** @description Defines a component type that can live on a Composition */
|
|
117
|
+
ComponentDefinition: {
|
|
118
|
+
id: components$1["schemas"]["PublicIdProperty"];
|
|
119
|
+
/** @description Friendly name of the component definition */
|
|
120
|
+
name: string;
|
|
121
|
+
/**
|
|
122
|
+
* @description Icon name for the component definition (e.g. 'screen')
|
|
123
|
+
* @default screen
|
|
124
|
+
*/
|
|
125
|
+
icon?: string;
|
|
126
|
+
/**
|
|
127
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
128
|
+
* The parameter type must support being used as a title parameter for this to work
|
|
129
|
+
*
|
|
130
|
+
* @default null
|
|
131
|
+
*/
|
|
132
|
+
titleParameter?: string | null;
|
|
133
|
+
/**
|
|
134
|
+
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
135
|
+
*
|
|
136
|
+
* @default null
|
|
137
|
+
*/
|
|
138
|
+
thumbnailParameter?: string | null;
|
|
139
|
+
/**
|
|
140
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
141
|
+
* @default false
|
|
142
|
+
*/
|
|
143
|
+
canBeComposition?: boolean;
|
|
144
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
145
|
+
parameters?: components$1["schemas"]["ComponentDefinitionParameter"][];
|
|
146
|
+
/**
|
|
147
|
+
* Format: uuid
|
|
148
|
+
* @description Reference to the category this component definition belongs to
|
|
149
|
+
* @default null
|
|
150
|
+
*/
|
|
151
|
+
categoryId?: string | null;
|
|
152
|
+
/** @description Description of the component definition */
|
|
153
|
+
description?: string;
|
|
154
|
+
/** @description Description of the component definition */
|
|
155
|
+
previewImageUrl?: string;
|
|
156
|
+
/**
|
|
157
|
+
* @description if this component uses team permissions or custom permissions
|
|
158
|
+
* @default true
|
|
159
|
+
*/
|
|
160
|
+
useTeamPermissions?: boolean;
|
|
161
|
+
/** @description Custom role permissions for this component definition */
|
|
162
|
+
permissions?: components$1["schemas"]["ComponentDefinitionPermission"][];
|
|
163
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
164
|
+
slots?: components$1["schemas"]["ComponentDefinitionSlot"][];
|
|
165
|
+
slugSettings?: components$1["schemas"]["ComponentDefinitionSlugSettings"];
|
|
166
|
+
/** @description Default component instance value */
|
|
167
|
+
defaults?: components$1["schemas"]["ComponentInstance"] | null;
|
|
168
|
+
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
169
|
+
variants?: components$1["schemas"]["ComponentDefinitionVariant"][];
|
|
170
|
+
/** @description Created date string for this definition (ignored for writes) */
|
|
171
|
+
created?: string;
|
|
172
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
|
173
|
+
updated?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Format: uuid
|
|
176
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
177
|
+
*/
|
|
178
|
+
workflowId?: string;
|
|
179
|
+
};
|
|
180
|
+
/** @description Defines a content type */
|
|
181
|
+
ContentType: {
|
|
182
|
+
id: components$1["schemas"]["PublicIdProperty"];
|
|
183
|
+
/** @description Friendly name of the content type */
|
|
184
|
+
name: string;
|
|
185
|
+
/**
|
|
186
|
+
* @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.
|
|
187
|
+
* The field type must support being used as an entry name for this to work
|
|
188
|
+
*/
|
|
189
|
+
entryName?: string | null;
|
|
190
|
+
/**
|
|
191
|
+
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
192
|
+
*
|
|
193
|
+
* @default null
|
|
194
|
+
*/
|
|
195
|
+
thumbnailField?: string | null;
|
|
196
|
+
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
197
|
+
fields?: components$1["schemas"]["ComponentDefinitionParameter"][];
|
|
198
|
+
/** @description Description of the content type */
|
|
199
|
+
description?: string;
|
|
200
|
+
/**
|
|
201
|
+
* @description Icon name for the content type (e.g. 'screen')
|
|
202
|
+
* @default file-document
|
|
203
|
+
*/
|
|
204
|
+
icon?: string;
|
|
205
|
+
/** @description Created date string for this content type (ignored for writes) */
|
|
206
|
+
created?: string;
|
|
207
|
+
/** @description Last modified date string for this content type (ignored for writes) */
|
|
208
|
+
updated?: string;
|
|
209
|
+
slugSettings?: components$1["schemas"]["ComponentDefinitionSlugSettings"];
|
|
210
|
+
/**
|
|
211
|
+
* @description The definition type of this content type (block or content type)
|
|
212
|
+
* @default contentType
|
|
213
|
+
* @enum {string}
|
|
214
|
+
*/
|
|
215
|
+
type?: "contentType" | "block";
|
|
216
|
+
/**
|
|
217
|
+
* @description if this content type uses team permissions or custom permissions
|
|
218
|
+
* @default true
|
|
219
|
+
*/
|
|
220
|
+
useTeamPermissions?: boolean;
|
|
221
|
+
/** @description Custom role permissions for this content type */
|
|
222
|
+
permissions?: components$1["schemas"]["ComponentDefinitionPermission"][];
|
|
223
|
+
/**
|
|
224
|
+
* Format: uuid
|
|
225
|
+
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
226
|
+
*/
|
|
227
|
+
workflowId?: string;
|
|
228
|
+
};
|
|
229
|
+
/** @description Defines an editable parameter on a component */
|
|
230
|
+
ComponentParameter: {
|
|
231
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
232
|
+
value?: unknown;
|
|
233
|
+
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
234
|
+
type: string;
|
|
235
|
+
/** @deprecated */
|
|
236
|
+
connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
|
|
237
|
+
/**
|
|
238
|
+
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
239
|
+
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
240
|
+
*/
|
|
241
|
+
locales?: {
|
|
242
|
+
[key: string]: unknown;
|
|
243
|
+
};
|
|
244
|
+
conditions?: components$1["schemas"]["ComponentParameterConditions"];
|
|
245
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
246
|
+
localesConditions?: {
|
|
247
|
+
[key: string]: components$1["schemas"]["ComponentParameterConditions"];
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* @description Array of alternate values which are based on conditions.
|
|
252
|
+
*
|
|
253
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
254
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
255
|
+
* * If no conditions match, the `value` property is used.
|
|
256
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
257
|
+
*
|
|
258
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
259
|
+
*/
|
|
260
|
+
ComponentParameterConditions: components$1["schemas"]["ComponentParameterConditionalValue"][];
|
|
261
|
+
/** @description Defines a conditional value for a component parameter */
|
|
262
|
+
ComponentParameterConditionalValue: {
|
|
263
|
+
when: components$1["schemas"]["VisibilityCriteriaGroup"];
|
|
264
|
+
/**
|
|
265
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
266
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
267
|
+
*/
|
|
268
|
+
value: unknown;
|
|
269
|
+
/**
|
|
270
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
271
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
272
|
+
*/
|
|
273
|
+
id: number;
|
|
274
|
+
};
|
|
275
|
+
/**
|
|
276
|
+
* @deprecated
|
|
277
|
+
* @description beta functionality subject to change
|
|
278
|
+
*/
|
|
279
|
+
VisibilityCriteriaGroup: {
|
|
280
|
+
/**
|
|
281
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
282
|
+
* @enum {string}
|
|
283
|
+
*/
|
|
284
|
+
op?: "&" | "|";
|
|
285
|
+
clauses: (components$1["schemas"]["VisibilityCriteria"] | components$1["schemas"]["VisibilityCriteriaGroup"])[];
|
|
286
|
+
};
|
|
287
|
+
/**
|
|
288
|
+
* @deprecated
|
|
289
|
+
* @description beta functionality subject to change
|
|
290
|
+
*/
|
|
291
|
+
VisibilityCriteria: {
|
|
292
|
+
/** @description The rule type to execute */
|
|
293
|
+
rule: string;
|
|
294
|
+
/**
|
|
295
|
+
* @description The source value of the rule.
|
|
296
|
+
* 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.
|
|
297
|
+
*/
|
|
298
|
+
source?: string;
|
|
299
|
+
/** @description The rule-definition-specific operator to test against */
|
|
300
|
+
op: string;
|
|
301
|
+
/** @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. */
|
|
302
|
+
value: string | string[];
|
|
303
|
+
};
|
|
304
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
305
|
+
DataElementConnectionDefinition: {
|
|
306
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
307
|
+
pointer: string;
|
|
308
|
+
/**
|
|
309
|
+
* @description The syntax used to select the dynamic token to bind to
|
|
310
|
+
* @enum {string}
|
|
311
|
+
*/
|
|
312
|
+
syntax: "jptr";
|
|
313
|
+
/**
|
|
314
|
+
* @description The action to take if the dynamic token cannot be resolved
|
|
315
|
+
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
316
|
+
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
317
|
+
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
318
|
+
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
319
|
+
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
320
|
+
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
321
|
+
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
322
|
+
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
323
|
+
* - 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
|
|
324
|
+
*
|
|
325
|
+
* @enum {string}
|
|
326
|
+
*/
|
|
327
|
+
failureAction?: "t" | "p" | "c" | "a";
|
|
328
|
+
/**
|
|
329
|
+
* @description How to report when the dynamic token cannot be resolved
|
|
330
|
+
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
331
|
+
* - w: WARNING: Report a warning message [default]
|
|
332
|
+
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
333
|
+
*
|
|
334
|
+
* @enum {string}
|
|
335
|
+
*/
|
|
336
|
+
failureLogLevel?: "e" | "w" | "i";
|
|
337
|
+
/**
|
|
338
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
339
|
+
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
340
|
+
*/
|
|
341
|
+
failureDefault?: string;
|
|
342
|
+
};
|
|
343
|
+
/** @description Defines the shape of a component instance served by the composition API */
|
|
344
|
+
ComponentInstance: {
|
|
345
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
346
|
+
type: string;
|
|
347
|
+
/** @description Component parameter values for the component instance */
|
|
348
|
+
parameters?: {
|
|
349
|
+
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
350
|
+
};
|
|
351
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
352
|
+
variant?: string;
|
|
353
|
+
/** @description Slots containing any child components */
|
|
354
|
+
slots?: {
|
|
355
|
+
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
356
|
+
};
|
|
357
|
+
/**
|
|
358
|
+
* @description Unique identifier of the component within the composition.
|
|
359
|
+
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
360
|
+
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
361
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
362
|
+
*/
|
|
363
|
+
_id?: string;
|
|
364
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
365
|
+
_pattern?: string;
|
|
366
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
367
|
+
/**
|
|
368
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
369
|
+
* Means nothing for PUTs; it will be ignored
|
|
370
|
+
*/
|
|
371
|
+
_patternDataResources?: {
|
|
372
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
373
|
+
};
|
|
374
|
+
_patternError?: components$1["schemas"]["PatternError"];
|
|
375
|
+
/**
|
|
376
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
377
|
+
* This can be used to override parameters that are defined on patterns,
|
|
378
|
+
* including nested patterns, with values that are specific to this composition.
|
|
379
|
+
* The keys in this object are component IDs.
|
|
380
|
+
* Overrides are applied from the top down, so for example if both the composition
|
|
381
|
+
* and a pattern on the composition define an override on a nested pattern,
|
|
382
|
+
* the composition's override replaces the pattern's.
|
|
383
|
+
*
|
|
384
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
385
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
386
|
+
*/
|
|
387
|
+
_overrides?: {
|
|
388
|
+
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
389
|
+
};
|
|
390
|
+
/**
|
|
391
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
392
|
+
* by consumers of the pattern.
|
|
393
|
+
*
|
|
394
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
395
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
396
|
+
*/
|
|
397
|
+
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
398
|
+
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
399
|
+
_locales?: string[];
|
|
400
|
+
};
|
|
401
|
+
/** @description Defines the shape of the root component in a composition */
|
|
402
|
+
RootComponentInstance: {
|
|
403
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
404
|
+
type: string;
|
|
405
|
+
/** @description Component parameter values for the component instance */
|
|
406
|
+
parameters?: {
|
|
407
|
+
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
408
|
+
};
|
|
409
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
410
|
+
variant?: string;
|
|
411
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
412
|
+
projectMapNodes?: components$1["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
413
|
+
/** @description Slots containing any child components */
|
|
414
|
+
slots?: {
|
|
415
|
+
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
416
|
+
};
|
|
417
|
+
/** @description The ID of the composition */
|
|
418
|
+
_id: string;
|
|
419
|
+
/** @description Slug pattern of this component */
|
|
420
|
+
_slug?: string | null;
|
|
421
|
+
/** @description Friendly name of this component */
|
|
422
|
+
_name: string;
|
|
423
|
+
/** @description Name of the author of the most recent change */
|
|
424
|
+
_author?: string;
|
|
425
|
+
/** @description Identity subject of the author of the most recent change */
|
|
426
|
+
_authorSubject?: string;
|
|
427
|
+
/** @description Name of the original creator */
|
|
428
|
+
_creator?: string;
|
|
429
|
+
/** @description Identity subject of the original creator */
|
|
430
|
+
_creatorSubject?: string;
|
|
431
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
432
|
+
_pattern?: string;
|
|
433
|
+
/**
|
|
434
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
435
|
+
* Means nothing for PUTs; it will be ignored
|
|
436
|
+
*/
|
|
437
|
+
_patternDataResources?: {
|
|
438
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
439
|
+
};
|
|
440
|
+
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
441
|
+
_patternError?: components$1["schemas"]["PatternError"];
|
|
442
|
+
/**
|
|
443
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
444
|
+
* This can be used to override parameters that are defined on patterns,
|
|
445
|
+
* including nested patterns, with values that are specific to this composition.
|
|
446
|
+
* The keys in this object are component IDs.
|
|
447
|
+
* Overrides are applied from the top down, so for example if both the composition
|
|
448
|
+
* and a pattern on the composition define an override on a nested pattern,
|
|
449
|
+
* the composition's override replaces the pattern's.
|
|
450
|
+
*
|
|
451
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
452
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
453
|
+
*/
|
|
454
|
+
_overrides?: {
|
|
455
|
+
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
456
|
+
};
|
|
457
|
+
/**
|
|
458
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
459
|
+
* by consumers of the pattern.
|
|
460
|
+
*
|
|
461
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
462
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
463
|
+
*/
|
|
464
|
+
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
465
|
+
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
466
|
+
_locales?: string[];
|
|
467
|
+
};
|
|
468
|
+
/**
|
|
469
|
+
* @description Defines how to override a specific component.
|
|
470
|
+
*
|
|
471
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
472
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
473
|
+
*/
|
|
474
|
+
ComponentOverride: {
|
|
475
|
+
parameters?: {
|
|
476
|
+
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
477
|
+
};
|
|
478
|
+
slots?: {
|
|
479
|
+
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
480
|
+
};
|
|
481
|
+
variant?: string;
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
|
485
|
+
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
486
|
+
*
|
|
487
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
488
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
489
|
+
*/
|
|
490
|
+
ComponentOverridability: {
|
|
491
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
492
|
+
parameters?: {
|
|
493
|
+
[key: string]: components$1["schemas"]["OverrideOptions"];
|
|
494
|
+
};
|
|
495
|
+
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
496
|
+
variants?: boolean;
|
|
497
|
+
/**
|
|
498
|
+
* @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
499
|
+
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
500
|
+
* If not set, the default is false
|
|
501
|
+
*/
|
|
502
|
+
hideLockedParameters?: boolean;
|
|
503
|
+
};
|
|
504
|
+
/**
|
|
505
|
+
* @description Whether a parameter is overridable
|
|
506
|
+
*
|
|
507
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
508
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
509
|
+
*
|
|
510
|
+
* @enum {string}
|
|
511
|
+
*/
|
|
512
|
+
OverrideOptions: "yes" | "no";
|
|
513
|
+
/** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
|
|
514
|
+
AlternativeDataSourceData: {
|
|
515
|
+
/** @description Base resource URL of the data source. No trailing slash */
|
|
516
|
+
baseUrl: string;
|
|
517
|
+
/** @description HTTP headers to pass with requests to the data source */
|
|
518
|
+
headers?: {
|
|
519
|
+
key: string;
|
|
520
|
+
value: string;
|
|
521
|
+
omitIfEmpty?: boolean;
|
|
522
|
+
}[];
|
|
523
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
524
|
+
parameters?: {
|
|
525
|
+
key: string;
|
|
526
|
+
value: string;
|
|
527
|
+
omitIfEmpty?: boolean;
|
|
528
|
+
}[];
|
|
529
|
+
/** @description Variables needed to make calls to the data source */
|
|
530
|
+
variables?: {
|
|
531
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
/**
|
|
535
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
536
|
+
* These are created in the UI and shared across a whole project.
|
|
537
|
+
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
538
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
539
|
+
*/
|
|
540
|
+
DataSource: {
|
|
541
|
+
/** @description Public ID of the data source */
|
|
542
|
+
id: string;
|
|
543
|
+
/** @description Display name of the data source */
|
|
544
|
+
displayName: string;
|
|
545
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
|
|
546
|
+
connectorType: string;
|
|
547
|
+
/** @description Base resource URL of the data source. No trailing slash */
|
|
548
|
+
baseUrl: string;
|
|
549
|
+
/** @description HTTP headers to pass with requests to the data source */
|
|
550
|
+
headers?: {
|
|
551
|
+
key: string;
|
|
552
|
+
value: string;
|
|
553
|
+
}[];
|
|
554
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
555
|
+
parameters?: {
|
|
556
|
+
key: string;
|
|
557
|
+
value: string;
|
|
558
|
+
}[];
|
|
559
|
+
/** @description Variables needed to make calls to the data source */
|
|
560
|
+
variables?: {
|
|
561
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
562
|
+
};
|
|
563
|
+
/**
|
|
564
|
+
* @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
565
|
+
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
566
|
+
*/
|
|
567
|
+
localeMapping?: {
|
|
568
|
+
[key: string]: string;
|
|
569
|
+
};
|
|
570
|
+
/**
|
|
571
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
|
572
|
+
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
|
573
|
+
*/
|
|
574
|
+
enableUnpublishedMode?: boolean;
|
|
575
|
+
/** @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 */
|
|
576
|
+
customPublic?: {
|
|
577
|
+
[key: string]: unknown;
|
|
578
|
+
};
|
|
579
|
+
/** @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 */
|
|
580
|
+
custom?: {
|
|
581
|
+
[key: string]: unknown;
|
|
582
|
+
};
|
|
583
|
+
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
584
|
+
variants?: {
|
|
585
|
+
unpublished?: components$1["schemas"]["AlternativeDataSourceData"];
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
/** @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 */
|
|
589
|
+
DataType: {
|
|
590
|
+
/** @description Public ID of the data type */
|
|
591
|
+
id: string;
|
|
592
|
+
/** @description Display name of the data type */
|
|
593
|
+
displayName: string;
|
|
594
|
+
/** @description Public ID of the associated data source */
|
|
595
|
+
dataSourceId: string;
|
|
596
|
+
/**
|
|
597
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
598
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
599
|
+
* no special UI or processing is required
|
|
600
|
+
*/
|
|
601
|
+
archetype?: string;
|
|
602
|
+
allowedOnComponents?: string[];
|
|
603
|
+
/** @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 */
|
|
604
|
+
path: string;
|
|
605
|
+
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
606
|
+
ttl?: number;
|
|
607
|
+
/** @description A key for the resource data cache purging */
|
|
608
|
+
purgeKey?: string;
|
|
609
|
+
/** @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 */
|
|
610
|
+
badgeIconUrl?: string;
|
|
611
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
612
|
+
headers?: {
|
|
613
|
+
key: string;
|
|
614
|
+
value: string;
|
|
615
|
+
omitIfEmpty?: boolean;
|
|
616
|
+
}[];
|
|
617
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
618
|
+
parameters?: {
|
|
619
|
+
key: string;
|
|
620
|
+
value: string;
|
|
621
|
+
omitIfEmpty?: boolean;
|
|
622
|
+
}[];
|
|
623
|
+
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
624
|
+
body?: string;
|
|
625
|
+
/**
|
|
626
|
+
* @description HTTP method to use with requests to the data type
|
|
627
|
+
* @default GET
|
|
628
|
+
* @enum {string}
|
|
629
|
+
*/
|
|
630
|
+
method: "GET" | "POST" | "HEAD";
|
|
631
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
632
|
+
variables?: {
|
|
633
|
+
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
634
|
+
};
|
|
635
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
636
|
+
custom?: {
|
|
637
|
+
[key: string]: unknown;
|
|
638
|
+
};
|
|
639
|
+
};
|
|
640
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
641
|
+
DataVariableDefinition: {
|
|
642
|
+
/** @description Display name of the data variable */
|
|
643
|
+
displayName?: string;
|
|
644
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
645
|
+
helpText?: string;
|
|
646
|
+
/**
|
|
647
|
+
* @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
|
|
648
|
+
* @default text
|
|
649
|
+
*/
|
|
650
|
+
type?: string;
|
|
651
|
+
/** @description Default value of the data variable */
|
|
652
|
+
default: string;
|
|
653
|
+
/** @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 */
|
|
654
|
+
order?: number;
|
|
655
|
+
/**
|
|
656
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
657
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
658
|
+
*/
|
|
659
|
+
source?: string;
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
663
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
664
|
+
*/
|
|
665
|
+
DataResourceDefinitions: {
|
|
666
|
+
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
667
|
+
};
|
|
668
|
+
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
669
|
+
DataResourceDefinition: {
|
|
670
|
+
/** @description Public ID of the data type that provides this data */
|
|
671
|
+
type: string;
|
|
672
|
+
/** @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 */
|
|
673
|
+
isPatternParameter?: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
676
|
+
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
677
|
+
* If isPatternParameter is false or undefined, this has no meaning
|
|
678
|
+
*/
|
|
679
|
+
ignorePatternParameterDefault?: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
682
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
683
|
+
*/
|
|
684
|
+
optionalPatternParameter?: boolean;
|
|
685
|
+
variables?: components$1["schemas"]["DataResourceVariables"];
|
|
686
|
+
};
|
|
687
|
+
/** @description Variable values for a data resource */
|
|
688
|
+
DataResourceVariables: {
|
|
689
|
+
[key: string]: string;
|
|
690
|
+
};
|
|
691
|
+
/**
|
|
692
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
693
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
694
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
695
|
+
* Means nothing for PUTs; it will be ignored
|
|
696
|
+
*
|
|
697
|
+
* @enum {string}
|
|
698
|
+
*/
|
|
699
|
+
PatternError: "NOTFOUND" | "CYCLIC";
|
|
700
|
+
HistoryApiResponse: {
|
|
701
|
+
/**
|
|
702
|
+
* @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.
|
|
703
|
+
* If this is undefined then no more results are available
|
|
704
|
+
*/
|
|
705
|
+
cursor?: string;
|
|
706
|
+
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
707
|
+
truncated?: boolean;
|
|
708
|
+
/** @description Version history entries */
|
|
709
|
+
results?: components$1["schemas"]["HistoryEntry"][];
|
|
710
|
+
};
|
|
711
|
+
HistoryEntry: {
|
|
712
|
+
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
713
|
+
versionId: string;
|
|
714
|
+
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
715
|
+
timestamp: number;
|
|
716
|
+
/** @description The name (full name) of the user who created the version */
|
|
717
|
+
authorName: string;
|
|
718
|
+
authorIsApiKey: boolean;
|
|
719
|
+
/** @description The state of the entity when the history entry was made */
|
|
720
|
+
state: number;
|
|
721
|
+
};
|
|
722
|
+
/** @description Category for tagging canvas entities */
|
|
723
|
+
Category: {
|
|
724
|
+
/**
|
|
725
|
+
* Format: uuid
|
|
726
|
+
* @description Unique identifier for the category
|
|
727
|
+
*/
|
|
728
|
+
id: string;
|
|
729
|
+
/** @description Display name of the category */
|
|
730
|
+
name: string;
|
|
731
|
+
/**
|
|
732
|
+
* @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
|
|
733
|
+
* @default 0
|
|
734
|
+
*/
|
|
735
|
+
order?: number;
|
|
736
|
+
};
|
|
737
|
+
/** @description Project map node information related to a component */
|
|
738
|
+
CompositionProjectMapNodeInfo: {
|
|
739
|
+
/**
|
|
740
|
+
* Format: uuid
|
|
741
|
+
* @description Unique identifier for the project map node
|
|
742
|
+
*/
|
|
743
|
+
id: string;
|
|
744
|
+
/**
|
|
745
|
+
* @description Fallback path of the project map node.
|
|
746
|
+
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
747
|
+
*/
|
|
748
|
+
path: string;
|
|
749
|
+
/**
|
|
750
|
+
* Format: uuid
|
|
751
|
+
* @description Unique identifier for the project map that this node belongs to
|
|
752
|
+
*/
|
|
753
|
+
projectMapId: string;
|
|
754
|
+
data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
755
|
+
/**
|
|
756
|
+
* @description Locale-specific paths of the project map node.
|
|
757
|
+
* Keys are locale codes
|
|
758
|
+
*/
|
|
759
|
+
locales?: {
|
|
760
|
+
[key: string]: {
|
|
761
|
+
/** @description Locale-specific path of the project map node */
|
|
762
|
+
path: string;
|
|
763
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
764
|
+
inherited: boolean;
|
|
765
|
+
};
|
|
766
|
+
};
|
|
767
|
+
};
|
|
768
|
+
/** @description AI Prompt definition */
|
|
769
|
+
Prompt: {
|
|
770
|
+
/**
|
|
771
|
+
* Format: uuid
|
|
772
|
+
* @description Unique identifier for the prompt
|
|
773
|
+
*/
|
|
774
|
+
id: string;
|
|
775
|
+
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
776
|
+
integrationType: string;
|
|
777
|
+
/** @description Name for the prompt */
|
|
778
|
+
name?: string | null;
|
|
779
|
+
/** @description Text for the prompt */
|
|
780
|
+
text?: string | null;
|
|
781
|
+
/** @description Data for the prompt */
|
|
782
|
+
data?: {
|
|
783
|
+
[key: string]: unknown;
|
|
784
|
+
} | null;
|
|
785
|
+
/** @description Turn off/on prompt */
|
|
786
|
+
enabled?: boolean | null;
|
|
787
|
+
/** @description Integration default prompt */
|
|
788
|
+
builtIn?: boolean | null;
|
|
789
|
+
/** @description Supported parameter types */
|
|
790
|
+
parameterTypes?: string[] | null;
|
|
791
|
+
};
|
|
792
|
+
/** @description Definition of a workflow that can be assigned to entities */
|
|
793
|
+
WorkflowDefinition: {
|
|
794
|
+
/**
|
|
795
|
+
* Format: uuid
|
|
796
|
+
* @description Unique identifier of the workflow definition
|
|
797
|
+
*/
|
|
798
|
+
id: string;
|
|
799
|
+
/** @description Workflow name */
|
|
800
|
+
name: string;
|
|
801
|
+
/**
|
|
802
|
+
* Format: uuid
|
|
803
|
+
* @description The ID of the initial stage in the stages object.
|
|
804
|
+
*/
|
|
805
|
+
initialStage: string;
|
|
806
|
+
/** @description All stages of the workflow */
|
|
807
|
+
stages: {
|
|
808
|
+
[key: string]: components$1["schemas"]["WorkflowStage"];
|
|
809
|
+
};
|
|
810
|
+
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
811
|
+
modified?: string;
|
|
812
|
+
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
813
|
+
created?: string;
|
|
814
|
+
/**
|
|
815
|
+
* @description Name of the original creator of the workflow.
|
|
816
|
+
* If undefined, the user has been removed from the team.
|
|
817
|
+
* Ignored for writes
|
|
818
|
+
*/
|
|
819
|
+
createdBy?: string;
|
|
820
|
+
/**
|
|
821
|
+
* @description Name of the last modifier of the workflow.
|
|
822
|
+
* If undefined, the user has been removed from the team.
|
|
823
|
+
* Ignored for writes
|
|
824
|
+
*/
|
|
825
|
+
modifiedBy?: string;
|
|
826
|
+
};
|
|
827
|
+
/** @description Definition of a stage in a workflow */
|
|
828
|
+
WorkflowStage: {
|
|
829
|
+
/** @description Name of the stage */
|
|
830
|
+
name: string;
|
|
831
|
+
/**
|
|
832
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
833
|
+
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
834
|
+
* 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
|
|
835
|
+
* listed here, the stage is read-only and publishing is disabled
|
|
836
|
+
*/
|
|
837
|
+
permissions: {
|
|
838
|
+
[key: string]: components$1["schemas"]["WorkflowStagePermission"];
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
842
|
+
* 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.
|
|
843
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
844
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
845
|
+
*/
|
|
846
|
+
autoPublish?: boolean;
|
|
847
|
+
/**
|
|
848
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
849
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
850
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
851
|
+
*/
|
|
852
|
+
requireValidity?: boolean;
|
|
853
|
+
/**
|
|
854
|
+
* @description Defines transitions to other stages
|
|
855
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
856
|
+
* has a stage that can never be escaped
|
|
857
|
+
*/
|
|
858
|
+
transitions: components$1["schemas"]["WorkflowStageTransition"][];
|
|
859
|
+
/**
|
|
860
|
+
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
861
|
+
* @default chevron-double-right-o
|
|
862
|
+
*/
|
|
863
|
+
icon?: string;
|
|
864
|
+
/** @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 */
|
|
865
|
+
order?: number;
|
|
866
|
+
};
|
|
867
|
+
/** @description Definition of a transition from one stage to another in a workflow */
|
|
868
|
+
WorkflowStageTransition: {
|
|
869
|
+
/**
|
|
870
|
+
* Format: uuid
|
|
871
|
+
* @description The target stage to transition to
|
|
872
|
+
*/
|
|
873
|
+
to: string;
|
|
874
|
+
/**
|
|
875
|
+
* @description Name shown to the user when they execute this transition.
|
|
876
|
+
* If not provided, a default name will be assigned automatically based on the target stage
|
|
877
|
+
*/
|
|
878
|
+
name: string;
|
|
879
|
+
/**
|
|
880
|
+
* @description Permissions for the stage transition.
|
|
881
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
882
|
+
*/
|
|
883
|
+
permissions: {
|
|
884
|
+
[key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
|
|
885
|
+
};
|
|
886
|
+
};
|
|
887
|
+
/** @description Permissions for a workflow stage */
|
|
888
|
+
WorkflowStagePermission: {
|
|
889
|
+
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
890
|
+
write?: boolean;
|
|
891
|
+
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
892
|
+
publish?: boolean;
|
|
893
|
+
};
|
|
894
|
+
/** @description Permissions for a workflow stage transition */
|
|
895
|
+
WorkflowStageTransitionPermission: {
|
|
896
|
+
/** @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 */
|
|
897
|
+
execute?: boolean;
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
}
|
|
901
|
+
interface external$1 {
|
|
902
|
+
"swagger.yml": {
|
|
903
|
+
paths: {};
|
|
904
|
+
components: {
|
|
905
|
+
schemas: {
|
|
906
|
+
Error: {
|
|
907
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
908
|
+
errorMessage?: string[] | string;
|
|
909
|
+
};
|
|
910
|
+
};
|
|
911
|
+
responses: {
|
|
912
|
+
/** Request input validation failed */
|
|
913
|
+
BadRequestError: {
|
|
914
|
+
content: {
|
|
915
|
+
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
|
916
|
+
};
|
|
917
|
+
};
|
|
918
|
+
/** API key or token was not valid */
|
|
919
|
+
UnauthorizedError: {
|
|
920
|
+
content: {
|
|
921
|
+
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
/** Permission was denied */
|
|
925
|
+
ForbiddenError: {
|
|
926
|
+
content: {
|
|
927
|
+
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
/** Resource not found */
|
|
931
|
+
NotFoundError: {
|
|
932
|
+
content: {
|
|
933
|
+
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
|
934
|
+
};
|
|
935
|
+
};
|
|
936
|
+
/** Too many requests in allowed time period */
|
|
937
|
+
RateLimitError: unknown;
|
|
938
|
+
/** Execution error occurred */
|
|
939
|
+
InternalServerError: unknown;
|
|
940
|
+
};
|
|
941
|
+
};
|
|
942
|
+
operations: {};
|
|
943
|
+
};
|
|
944
|
+
"v1-project-map-nodes.swagger.yml": {
|
|
945
|
+
paths: {
|
|
946
|
+
"/api/v1/project-map-nodes": {
|
|
947
|
+
/** Called to get a list of nodes belonging to a specific path or Id */
|
|
948
|
+
get: {
|
|
949
|
+
parameters: {
|
|
950
|
+
query: {
|
|
951
|
+
/** The project map id that the desired nodes belong */
|
|
952
|
+
projectMapId?: string;
|
|
953
|
+
/** The project id that contains the project map tree that this node belongs to */
|
|
954
|
+
projectId: string;
|
|
955
|
+
/**
|
|
956
|
+
* The ID of a release to fetch the composition data for.
|
|
957
|
+
*
|
|
958
|
+
* - When unspecified, composition data is fetched from base.
|
|
959
|
+
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
960
|
+
*
|
|
961
|
+
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
|
|
962
|
+
*/
|
|
963
|
+
releaseId?: string;
|
|
964
|
+
/** The id of the node to retrieve, cannot have both this parameter and `path` */
|
|
965
|
+
id?: string;
|
|
966
|
+
/** The path of the root node to retrieve, cannot have both this parameter and `id` */
|
|
967
|
+
path?: string;
|
|
968
|
+
/** Composition id to find associated project map node for */
|
|
969
|
+
compositionId?: string;
|
|
970
|
+
/** Limit the number or records returned by a number */
|
|
971
|
+
limit?: number;
|
|
972
|
+
/** Number of records to skip before returning nodes */
|
|
973
|
+
offset?: number;
|
|
974
|
+
/** Depth of the tree to fetch. This only applies when fetching by path */
|
|
975
|
+
depth?: number;
|
|
976
|
+
/** State of compositions to fetch. 0 = draft, 64 = published */
|
|
977
|
+
state?: number;
|
|
978
|
+
/** should the data be returned as a json tree object (or a flat array) */
|
|
979
|
+
tree?: boolean;
|
|
980
|
+
/** text search filter */
|
|
981
|
+
search?: string;
|
|
982
|
+
/**
|
|
983
|
+
* Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
|
|
984
|
+
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
|
|
985
|
+
*/
|
|
986
|
+
includeAncestors?: boolean;
|
|
987
|
+
/** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
|
|
988
|
+
expanded?: boolean;
|
|
989
|
+
/** include basic composition information. ID, type, state, name, and definition id */
|
|
990
|
+
withCompositionData?: boolean;
|
|
991
|
+
/**
|
|
992
|
+
* @deprecated Returns the UI status string of the composition.
|
|
993
|
+
* This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
|
|
994
|
+
*/
|
|
995
|
+
withCompositionUIStatus?: boolean;
|
|
996
|
+
/** Include basic redirect information */
|
|
997
|
+
withRedirectData?: boolean;
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
responses: {
|
|
1001
|
+
/** OK */
|
|
1002
|
+
200: {
|
|
1003
|
+
content: {
|
|
1004
|
+
"application/json": {
|
|
1005
|
+
nodes?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
|
|
1006
|
+
tree?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
|
|
1007
|
+
};
|
|
1008
|
+
};
|
|
1009
|
+
};
|
|
1010
|
+
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1011
|
+
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1012
|
+
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1013
|
+
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1014
|
+
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
/** Called to insert or update a node or nodes */
|
|
1018
|
+
put: {
|
|
1019
|
+
responses: {
|
|
1020
|
+
/** OK */
|
|
1021
|
+
204: never;
|
|
1022
|
+
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1023
|
+
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1024
|
+
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1025
|
+
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1026
|
+
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1027
|
+
};
|
|
1028
|
+
requestBody: {
|
|
1029
|
+
content: {
|
|
1030
|
+
"application/json": {
|
|
1031
|
+
/** @description An array of projectMap node objects to be updated or inserted */
|
|
1032
|
+
nodes: {
|
|
1033
|
+
node: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
|
|
1034
|
+
/** @description The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
|
|
1035
|
+
previousSibling?: string;
|
|
1036
|
+
/** @description The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
|
|
1037
|
+
nextSibling?: string;
|
|
1038
|
+
}[];
|
|
1039
|
+
/**
|
|
1040
|
+
* Format: uuid
|
|
1041
|
+
* @description The project id of the project that the projectMap belongs to
|
|
1042
|
+
*/
|
|
1043
|
+
projectId: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* Format: uuid
|
|
1046
|
+
* @description The projectMap id that the changing or inserting nodes belong to
|
|
1047
|
+
*/
|
|
1048
|
+
projectMapId?: string;
|
|
1049
|
+
};
|
|
1050
|
+
};
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
/** Called to delete a particular projectMap node by id or path */
|
|
1054
|
+
delete: {
|
|
1055
|
+
responses: {
|
|
1056
|
+
/** OK */
|
|
1057
|
+
204: never;
|
|
1058
|
+
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1059
|
+
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1060
|
+
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1061
|
+
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1062
|
+
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1063
|
+
};
|
|
1064
|
+
requestBody: {
|
|
1065
|
+
content: {
|
|
1066
|
+
"application/json": {
|
|
1067
|
+
/**
|
|
1068
|
+
* Format: uuid
|
|
1069
|
+
* @description Id of the projectMap node to delete
|
|
1070
|
+
*/
|
|
1071
|
+
nodeId?: string;
|
|
1072
|
+
/** @description Path to the projectMap node to delete */
|
|
1073
|
+
path: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* Format: uuid
|
|
1076
|
+
* @description Project map id that the node to delete belongs to
|
|
1077
|
+
*/
|
|
1078
|
+
projectMapId?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Format: uuid
|
|
1081
|
+
* @description Project id that the project map belongs to
|
|
1082
|
+
*/
|
|
1083
|
+
projectId: string;
|
|
1084
|
+
} | {
|
|
1085
|
+
/**
|
|
1086
|
+
* Format: uuid
|
|
1087
|
+
* @description Id of the projectMap node to delete
|
|
1088
|
+
*/
|
|
1089
|
+
nodeId: string;
|
|
1090
|
+
/** @description Path to the projectMap node to delete */
|
|
1091
|
+
path?: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* Format: uuid
|
|
1094
|
+
* @description Project map id that the node to delete belongs to
|
|
1095
|
+
*/
|
|
1096
|
+
projectMapId?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* Format: uuid
|
|
1099
|
+
* @description Project id that the project map belongs to
|
|
1100
|
+
*/
|
|
1101
|
+
projectId: string;
|
|
1102
|
+
};
|
|
1103
|
+
};
|
|
1104
|
+
};
|
|
1105
|
+
};
|
|
1106
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
1107
|
+
options: {
|
|
1108
|
+
responses: {
|
|
1109
|
+
/** OK */
|
|
1110
|
+
204: never;
|
|
1111
|
+
};
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
};
|
|
1115
|
+
components: {
|
|
1116
|
+
schemas: {
|
|
1117
|
+
ProjectMapNodeDefinition: {
|
|
1118
|
+
/**
|
|
1119
|
+
* Format: uuid
|
|
1120
|
+
* @description The id of the projectMap entry
|
|
1121
|
+
*/
|
|
1122
|
+
id: string;
|
|
1123
|
+
/** @description Path representing the path to the current node */
|
|
1124
|
+
path: string;
|
|
1125
|
+
/** @description Ordering of the node, higher numbers go after lower numbers */
|
|
1126
|
+
order?: number;
|
|
1127
|
+
data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1128
|
+
/** @description The name of the projectMap entry */
|
|
1129
|
+
name: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* @description The type of the projectMap entry
|
|
1132
|
+
* @enum {string}
|
|
1133
|
+
*/
|
|
1134
|
+
type: "composition" | "placeholder";
|
|
1135
|
+
/**
|
|
1136
|
+
* Format: uuid
|
|
1137
|
+
* @description The composition id related to the projectMap entry
|
|
1138
|
+
*/
|
|
1139
|
+
compositionId?: string;
|
|
1140
|
+
/** @description Description of the projectMap node */
|
|
1141
|
+
description?: string;
|
|
1142
|
+
/** @description Parent path of the current node, only included if requested with the expanded flag */
|
|
1143
|
+
parentPath?: string;
|
|
1144
|
+
/** @description Last segment of the url */
|
|
1145
|
+
pathSegment?: string;
|
|
1146
|
+
/** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
|
|
1147
|
+
isLeaf?: boolean;
|
|
1148
|
+
compositionData?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
|
|
1149
|
+
sourceRedirects?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
|
|
1150
|
+
targetRedirects?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
|
|
1151
|
+
locales?: {
|
|
1152
|
+
[key: string]: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
|
|
1153
|
+
};
|
|
1154
|
+
};
|
|
1155
|
+
ProjectMapNodeLocale: {
|
|
1156
|
+
/** @description Name of node in the locale */
|
|
1157
|
+
name?: string;
|
|
1158
|
+
/** @description Full path to the current node in this locale, only included if requested with the expanded flag */
|
|
1159
|
+
path?: string;
|
|
1160
|
+
/** @description Last segment of the url in this locale */
|
|
1161
|
+
pathSegment: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* @description When false, the node explicitly defines a locale-specific path segment.
|
|
1164
|
+
*
|
|
1165
|
+
* When true, an ancestor defines a locale-specific path segment,
|
|
1166
|
+
* which makes its descendants resolvable using that segment.
|
|
1167
|
+
* This node does not define a locale-specific path segment.
|
|
1168
|
+
*
|
|
1169
|
+
* Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
|
|
1170
|
+
*/
|
|
1171
|
+
inherited?: boolean;
|
|
1172
|
+
};
|
|
1173
|
+
ProjectMapSourceRedirectData: {
|
|
1174
|
+
/**
|
|
1175
|
+
* Format: uuid
|
|
1176
|
+
* @description The public UUID of the source redirect
|
|
1177
|
+
*/
|
|
1178
|
+
id?: string;
|
|
1179
|
+
}[];
|
|
1180
|
+
ProjectMapTargetRedirectData: {
|
|
1181
|
+
/**
|
|
1182
|
+
* Format: uuid
|
|
1183
|
+
* @description The public UUID of the target redirect
|
|
1184
|
+
*/
|
|
1185
|
+
id?: string;
|
|
1186
|
+
}[];
|
|
1187
|
+
/**
|
|
1188
|
+
* @description Basic information about the linked composition from the context of a project map node.
|
|
1189
|
+
* If the linked composition has editions, the editions are included in the `editions` property.
|
|
1190
|
+
*/
|
|
1191
|
+
ProjectMapNodeCompositionData: {
|
|
1192
|
+
/** @description Type of the linked composition (id of its definition) */
|
|
1193
|
+
type: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* Format: uuid
|
|
1196
|
+
* @description The UUID of the linked composition
|
|
1197
|
+
*/
|
|
1198
|
+
id: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* Format: uuid
|
|
1201
|
+
* @description The edition UUID underneath the linked composition
|
|
1202
|
+
* This is only present if the composition has not been published, but an edition has
|
|
1203
|
+
*/
|
|
1204
|
+
editionId?: string;
|
|
1205
|
+
/** @description Slug pattern of the linked composition or edition */
|
|
1206
|
+
slug?: string | null;
|
|
1207
|
+
/** @description Friendly name of this composition or edition */
|
|
1208
|
+
name: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* @deprecated
|
|
1211
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
1212
|
+
* @enum {string}
|
|
1213
|
+
*/
|
|
1214
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
1215
|
+
/**
|
|
1216
|
+
* @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
1217
|
+
* @default screen
|
|
1218
|
+
*/
|
|
1219
|
+
icon?: string;
|
|
1220
|
+
/** @description Friendly name of this Composition's Definition */
|
|
1221
|
+
typeName?: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* @description List of locales that the composition _or any of its editions_ is available in.
|
|
1224
|
+
* If empty, available in all locales.
|
|
1225
|
+
*/
|
|
1226
|
+
locales: string[];
|
|
1227
|
+
/** @description Priority of the composition relative to any editions */
|
|
1228
|
+
editionPriority?: number;
|
|
1229
|
+
/** @description Friendly name of the edition */
|
|
1230
|
+
editionName?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* @deprecated
|
|
1233
|
+
* @description List of editions available for this composition. The composition is included in the list, it is the edition
|
|
1234
|
+
* where the editionID equals the node's compositionID.
|
|
1235
|
+
*/
|
|
1236
|
+
editions?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
|
|
1237
|
+
};
|
|
1238
|
+
/**
|
|
1239
|
+
* @deprecated
|
|
1240
|
+
* @description Basic information about a composition edition from the context of a project map node
|
|
1241
|
+
*/
|
|
1242
|
+
ProjectMapNodeCompositionEditionData: {
|
|
1243
|
+
/**
|
|
1244
|
+
* Format: uuid
|
|
1245
|
+
* @description The UUID of the linked composition
|
|
1246
|
+
*/
|
|
1247
|
+
id: string;
|
|
1248
|
+
/** @description Type of the edition instance (public_id of its definition) */
|
|
1249
|
+
type: string;
|
|
1250
|
+
/**
|
|
1251
|
+
* Format: uuid
|
|
1252
|
+
* @description The edition UUID underneath the linked composition
|
|
1253
|
+
*/
|
|
1254
|
+
editionId?: string;
|
|
1255
|
+
/** @description Slug pattern of this edition */
|
|
1256
|
+
slug?: string | null;
|
|
1257
|
+
/** @description Friendly name of the linked composition */
|
|
1258
|
+
name: string;
|
|
1259
|
+
/** @description Friendly name of the edition */
|
|
1260
|
+
editionName?: string;
|
|
1261
|
+
/** @description Priority of the edition */
|
|
1262
|
+
editionPriority?: number;
|
|
1263
|
+
/**
|
|
1264
|
+
* @deprecated
|
|
1265
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
1266
|
+
* @enum {string}
|
|
1267
|
+
*/
|
|
1268
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
1269
|
+
/**
|
|
1270
|
+
* @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
1271
|
+
* @default screen
|
|
1272
|
+
*/
|
|
1273
|
+
icon?: string;
|
|
1274
|
+
/** @description Friendly name of this edition's definition */
|
|
1275
|
+
typeName?: string;
|
|
1276
|
+
/** @description List of locales that the edition is available in. If empty, available in all locales */
|
|
1277
|
+
locales: string[];
|
|
1278
|
+
/**
|
|
1279
|
+
* Format: date-time
|
|
1280
|
+
* @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
|
|
1281
|
+
*/
|
|
1282
|
+
modified?: string;
|
|
1283
|
+
};
|
|
1284
|
+
ProjectMapNodeUpdate: {
|
|
1285
|
+
/**
|
|
1286
|
+
* Format: uuid
|
|
1287
|
+
* @description The id of the projectMap entry
|
|
1288
|
+
*/
|
|
1289
|
+
id?: string;
|
|
1290
|
+
/** @description Path representing the path to the current node */
|
|
1291
|
+
path: string;
|
|
1292
|
+
/** @description Ordering of the node, higher numbers go after lower numbers */
|
|
1293
|
+
order?: number;
|
|
1294
|
+
data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1295
|
+
/** @description The name of the projectMap entry */
|
|
1296
|
+
name: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* @description The type of the projectMap entry
|
|
1299
|
+
* @enum {string}
|
|
1300
|
+
*/
|
|
1301
|
+
type: "composition" | "placeholder";
|
|
1302
|
+
/**
|
|
1303
|
+
* Format: uuid
|
|
1304
|
+
* @description The composition id related to the projectMap entry
|
|
1305
|
+
*/
|
|
1306
|
+
compositionId?: string;
|
|
1307
|
+
/** @description Description of the projectMap node */
|
|
1308
|
+
description?: string;
|
|
1309
|
+
locales?: {
|
|
1310
|
+
[key: string]: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
ProjectMapNodeLocaleUpdate: {
|
|
1314
|
+
/** @description Name of node in the locale */
|
|
1315
|
+
name?: string;
|
|
1316
|
+
/** @description Locale specific path segment for this node (not a full path) */
|
|
1317
|
+
pathSegment: string;
|
|
1318
|
+
};
|
|
1319
|
+
ProjectMapNodeData: {
|
|
1320
|
+
/** @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 */
|
|
1321
|
+
isSearchHit?: boolean;
|
|
1322
|
+
/** @description Query strings that are allowed to be passed to the node */
|
|
1323
|
+
queryStrings?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1324
|
+
/**
|
|
1325
|
+
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1326
|
+
* The preview value is used when editing a connected composition, and is the default
|
|
1327
|
+
* dynamic node value unless the author has explicitly chosen a different value
|
|
1328
|
+
*/
|
|
1329
|
+
previewValue?: string;
|
|
1330
|
+
};
|
|
1331
|
+
ProjectMapNodeAllowedQueryString: {
|
|
1332
|
+
/** @description The name of the query string parameter */
|
|
1333
|
+
name: string;
|
|
1334
|
+
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1335
|
+
value?: string;
|
|
1336
|
+
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1337
|
+
helpText?: string;
|
|
1338
|
+
};
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
operations: {};
|
|
1342
|
+
};
|
|
1343
|
+
"v1-project-map-tree.swagger.yml": {
|
|
1344
|
+
paths: {};
|
|
1345
|
+
components: {
|
|
1346
|
+
schemas: {
|
|
1347
|
+
ProjectMapTreeNodeDefinition: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
|
|
1348
|
+
/** @description Children of the node */
|
|
1349
|
+
children?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
|
|
1350
|
+
} & {
|
|
1351
|
+
name: unknown;
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
operations: {};
|
|
1356
|
+
};
|
|
1357
|
+
}
|
|
1358
|
+
|
|
3
1359
|
/**
|
|
4
1360
|
* This file was auto-generated by openapi-typescript.
|
|
5
1361
|
* Do not make direct changes to the file.
|
|
@@ -767,7 +2123,7 @@ interface external {
|
|
|
767
2123
|
slots?: {
|
|
768
2124
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
769
2125
|
};
|
|
770
|
-
/** @description The
|
|
2126
|
+
/** @description The ID of the composition */
|
|
771
2127
|
_id: string;
|
|
772
2128
|
/** @description Slug pattern of this component */
|
|
773
2129
|
_slug?: string | null;
|
|
@@ -1035,12 +2391,6 @@ interface external {
|
|
|
1035
2391
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1036
2392
|
*/
|
|
1037
2393
|
optionalPatternParameter?: boolean;
|
|
1038
|
-
/**
|
|
1039
|
-
* @description Resolve this data resource with draft mode content. TBD
|
|
1040
|
-
*
|
|
1041
|
-
* @enum {string}
|
|
1042
|
-
*/
|
|
1043
|
-
dataSourceVariant?: "unpublished";
|
|
1044
2394
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
1045
2395
|
};
|
|
1046
2396
|
/** @description Variable values for a data resource */
|
|
@@ -1283,7 +2633,7 @@ interface external {
|
|
|
1283
2633
|
id?: string;
|
|
1284
2634
|
/** The path of the root node to retrieve, cannot have both this parameter and `id` */
|
|
1285
2635
|
path?: string;
|
|
1286
|
-
/** Composition id to find associated
|
|
2636
|
+
/** Composition id to find associated project map node for */
|
|
1287
2637
|
compositionId?: string;
|
|
1288
2638
|
/** Limit the number or records returned by a number */
|
|
1289
2639
|
limit?: number;
|
|
@@ -1502,18 +2852,27 @@ interface external {
|
|
|
1502
2852
|
*/
|
|
1503
2853
|
id?: string;
|
|
1504
2854
|
}[];
|
|
1505
|
-
/**
|
|
2855
|
+
/**
|
|
2856
|
+
* @description Basic information about the linked composition from the context of a project map node.
|
|
2857
|
+
* If the linked composition has editions, the editions are included in the `editions` property.
|
|
2858
|
+
*/
|
|
1506
2859
|
ProjectMapNodeCompositionData: {
|
|
1507
|
-
/** @description Type of the composition
|
|
2860
|
+
/** @description Type of the linked composition (id of its definition) */
|
|
1508
2861
|
type: string;
|
|
1509
2862
|
/**
|
|
1510
2863
|
* Format: uuid
|
|
1511
|
-
* @description The
|
|
2864
|
+
* @description The UUID of the linked composition
|
|
1512
2865
|
*/
|
|
1513
2866
|
id: string;
|
|
1514
|
-
/**
|
|
2867
|
+
/**
|
|
2868
|
+
* Format: uuid
|
|
2869
|
+
* @description The edition UUID underneath the linked composition
|
|
2870
|
+
* This is only present if the composition has not been published, but an edition has
|
|
2871
|
+
*/
|
|
2872
|
+
editionId?: string;
|
|
2873
|
+
/** @description Slug pattern of the linked composition or edition */
|
|
1515
2874
|
slug?: string | null;
|
|
1516
|
-
/** @description Friendly name of this composition */
|
|
2875
|
+
/** @description Friendly name of this composition or edition */
|
|
1517
2876
|
name: string;
|
|
1518
2877
|
/**
|
|
1519
2878
|
* @deprecated
|
|
@@ -1528,7 +2887,61 @@ interface external {
|
|
|
1528
2887
|
icon?: string;
|
|
1529
2888
|
/** @description Friendly name of this Composition's Definition */
|
|
1530
2889
|
typeName?: string;
|
|
1531
|
-
/**
|
|
2890
|
+
/**
|
|
2891
|
+
* @description List of locales that the composition _or any of its editions_ is available in.
|
|
2892
|
+
* If empty, available in all locales.
|
|
2893
|
+
*/
|
|
2894
|
+
locales: string[];
|
|
2895
|
+
/** @description Priority of the composition relative to any editions */
|
|
2896
|
+
editionPriority?: number;
|
|
2897
|
+
/** @description Friendly name of the edition */
|
|
2898
|
+
editionName?: string;
|
|
2899
|
+
/**
|
|
2900
|
+
* @deprecated
|
|
2901
|
+
* @description List of editions available for this composition. The composition is included in the list, it is the edition
|
|
2902
|
+
* where the editionID equals the node's compositionID.
|
|
2903
|
+
*/
|
|
2904
|
+
editions?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
|
|
2905
|
+
};
|
|
2906
|
+
/**
|
|
2907
|
+
* @deprecated
|
|
2908
|
+
* @description Basic information about a composition edition from the context of a project map node
|
|
2909
|
+
*/
|
|
2910
|
+
ProjectMapNodeCompositionEditionData: {
|
|
2911
|
+
/**
|
|
2912
|
+
* Format: uuid
|
|
2913
|
+
* @description The UUID of the linked composition
|
|
2914
|
+
*/
|
|
2915
|
+
id: string;
|
|
2916
|
+
/** @description Type of the edition instance (public_id of its definition) */
|
|
2917
|
+
type: string;
|
|
2918
|
+
/**
|
|
2919
|
+
* Format: uuid
|
|
2920
|
+
* @description The edition UUID underneath the linked composition
|
|
2921
|
+
*/
|
|
2922
|
+
editionId?: string;
|
|
2923
|
+
/** @description Slug pattern of this edition */
|
|
2924
|
+
slug?: string | null;
|
|
2925
|
+
/** @description Friendly name of the linked composition */
|
|
2926
|
+
name: string;
|
|
2927
|
+
/** @description Friendly name of the edition */
|
|
2928
|
+
editionName?: string;
|
|
2929
|
+
/** @description Priority of the edition */
|
|
2930
|
+
editionPriority?: number;
|
|
2931
|
+
/**
|
|
2932
|
+
* @deprecated
|
|
2933
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
2934
|
+
* @enum {string}
|
|
2935
|
+
*/
|
|
2936
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
2937
|
+
/**
|
|
2938
|
+
* @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
2939
|
+
* @default screen
|
|
2940
|
+
*/
|
|
2941
|
+
icon?: string;
|
|
2942
|
+
/** @description Friendly name of this edition's definition */
|
|
2943
|
+
typeName?: string;
|
|
2944
|
+
/** @description List of locales that the edition is available in. If empty, available in all locales */
|
|
1532
2945
|
locales: string[];
|
|
1533
2946
|
/**
|
|
1534
2947
|
* Format: date-time
|
|
@@ -1622,6 +3035,81 @@ type AssetGetResponse = paths['/api/v1/assets']['get']['responses']['200']['cont
|
|
|
1622
3035
|
type AssetGetResponseSingle = components['schemas']['AssetApiResponse'];
|
|
1623
3036
|
type AssetGetResponseList = components['schemas']['AssetListResponse'];
|
|
1624
3037
|
type Asset = components['schemas']['Asset'];
|
|
3038
|
+
type SharedComponents = components$1['schemas'];
|
|
3039
|
+
type AssetParamValueItem = {
|
|
3040
|
+
type: string;
|
|
3041
|
+
_id: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* Internal Uniform source ID or
|
|
3044
|
+
* dataType ID of the global integration library
|
|
3045
|
+
* which created this asset item
|
|
3046
|
+
*/
|
|
3047
|
+
_source?: string;
|
|
3048
|
+
fields: {
|
|
3049
|
+
url: {
|
|
3050
|
+
type: 'text';
|
|
3051
|
+
value: string;
|
|
3052
|
+
};
|
|
3053
|
+
id?: {
|
|
3054
|
+
type: 'text';
|
|
3055
|
+
value: string | undefined;
|
|
3056
|
+
};
|
|
3057
|
+
title?: {
|
|
3058
|
+
type: 'text';
|
|
3059
|
+
value: string | undefined;
|
|
3060
|
+
};
|
|
3061
|
+
description?: {
|
|
3062
|
+
type: 'text';
|
|
3063
|
+
value: string | undefined;
|
|
3064
|
+
};
|
|
3065
|
+
mediaType?: {
|
|
3066
|
+
type: 'text';
|
|
3067
|
+
value: string | undefined;
|
|
3068
|
+
};
|
|
3069
|
+
/**
|
|
3070
|
+
* The width of the original asset
|
|
3071
|
+
*
|
|
3072
|
+
* Should resolve to a number but might
|
|
3073
|
+
* be a string with a pointer reference
|
|
3074
|
+
*/
|
|
3075
|
+
width?: {
|
|
3076
|
+
type: 'number';
|
|
3077
|
+
value: number | string | undefined;
|
|
3078
|
+
};
|
|
3079
|
+
/**
|
|
3080
|
+
* The height of the original asset
|
|
3081
|
+
*
|
|
3082
|
+
* Should resolve to a number but might
|
|
3083
|
+
* be a string with a pointer reference
|
|
3084
|
+
*/
|
|
3085
|
+
height?: {
|
|
3086
|
+
type: 'number';
|
|
3087
|
+
value: number | string | undefined;
|
|
3088
|
+
};
|
|
3089
|
+
/**
|
|
3090
|
+
* The size in bytes of the original asset
|
|
3091
|
+
*
|
|
3092
|
+
* Should resolve to a number but might
|
|
3093
|
+
* be a string with a pointer reference
|
|
3094
|
+
*/
|
|
3095
|
+
size?: {
|
|
3096
|
+
type: 'number';
|
|
3097
|
+
value: number | string | undefined;
|
|
3098
|
+
};
|
|
3099
|
+
/**
|
|
3100
|
+
* Any key/value properties which the source
|
|
3101
|
+
* wants to attach to the asset data
|
|
3102
|
+
*/
|
|
3103
|
+
custom?: {
|
|
3104
|
+
type: string;
|
|
3105
|
+
value: Record<string, unknown>;
|
|
3106
|
+
};
|
|
3107
|
+
};
|
|
3108
|
+
_overrides?: {
|
|
3109
|
+
fields: SharedComponents['ComponentOverride']['parameters'];
|
|
3110
|
+
};
|
|
3111
|
+
};
|
|
3112
|
+
type AssetParamValue = AssetParamValueItem[];
|
|
1625
3113
|
|
|
1626
3114
|
type WithoutProjectId<T extends {
|
|
1627
3115
|
projectId: string;
|
|
@@ -1647,4 +3135,4 @@ declare class UncachedAssetClient extends AssetClient {
|
|
|
1647
3135
|
*/
|
|
1648
3136
|
declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
|
|
1649
3137
|
|
|
1650
|
-
export { type Asset, AssetClient, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
|
|
3138
|
+
export { type Asset, AssetClient, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
|