@uniformdev/canvas 20.50.2-alpha.167 → 20.50.2-alpha.180

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.
Files changed (6) hide show
  1. package/dist/index.d.mts +1439 -1952
  2. package/dist/index.d.ts +1439 -1952
  3. package/dist/index.esm.js +177 -814
  4. package/dist/index.js +176 -819
  5. package/dist/index.mjs +177 -814
  6. package/package.json +5 -5
package/dist/index.d.ts CHANGED
@@ -9,7 +9,7 @@ import { Options } from 'p-throttle';
9
9
  import { 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/categories": {
12
+ "/api/v1/canvas-definitions": {
13
13
  parameters: {
14
14
  query?: never;
15
15
  header?: never;
@@ -19,7 +19,18 @@ interface paths$n {
19
19
  get: {
20
20
  parameters: {
21
21
  query: {
22
+ /** @description The project ID to get component definitions for */
22
23
  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[];
23
34
  };
24
35
  header?: never;
25
36
  path?: never;
@@ -34,7 +45,8 @@ interface paths$n {
34
45
  };
35
46
  content: {
36
47
  "application/json": {
37
- categories: components$r["schemas"]["Category"][];
48
+ /** @description Component definitions that match the query */
49
+ componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
38
50
  };
39
51
  };
40
52
  };
@@ -45,6 +57,7 @@ interface paths$n {
45
57
  500: components$r["responses"]["InternalServerError"];
46
58
  };
47
59
  };
60
+ /** @description Upserts a component definition */
48
61
  put: {
49
62
  parameters: {
50
63
  query?: never;
@@ -55,9 +68,12 @@ interface paths$n {
55
68
  requestBody: {
56
69
  content: {
57
70
  "application/json": {
58
- /** Format: uuid */
71
+ /**
72
+ * Format: uuid
73
+ * @description The project ID to upsert the component definition to
74
+ */
59
75
  projectId: string;
60
- categories: components$r["schemas"]["Category"][];
76
+ componentDefinition: components$r["schemas"]["ComponentDefinition"];
61
77
  };
62
78
  };
63
79
  };
@@ -77,6 +93,7 @@ interface paths$n {
77
93
  };
78
94
  };
79
95
  post?: never;
96
+ /** @description Deletes a component definition */
80
97
  delete: {
81
98
  parameters: {
82
99
  query?: never;
@@ -87,9 +104,12 @@ interface paths$n {
87
104
  requestBody: {
88
105
  content: {
89
106
  "application/json": {
90
- /** Format: uuid */
91
- categoryId: string;
92
- /** Format: uuid */
107
+ /** @description The public ID of the component definition to delete */
108
+ componentId: string;
109
+ /**
110
+ * Format: uuid
111
+ * @description The project ID the component definition to delete belongs to
112
+ */
93
113
  projectId: string;
94
114
  };
95
115
  };
@@ -109,90 +129,37 @@ interface paths$n {
109
129
  500: components$r["responses"]["InternalServerError"];
110
130
  };
111
131
  };
112
- options?: never;
132
+ /** @description Handles preflight requests. This endpoint allows CORS */
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
+ };
113
151
  head?: never;
114
152
  patch?: never;
115
153
  trace?: never;
116
154
  };
117
155
  }
118
156
  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 {
190
157
  schemas: {
191
158
  /** @description Public ID (used in code). Do not change after creation */
192
159
  PublicIdProperty: string;
193
160
  /** @description The definition of a component parameter */
194
161
  ComponentDefinitionParameter: {
195
- id: components$q["schemas"]["PublicIdProperty"];
162
+ id: components$r["schemas"]["PublicIdProperty"];
196
163
  /** @description Friendly name of the parameter */
197
164
  name: string;
198
165
  /** @description Appears next to the parameter in the Composition editor */
@@ -224,9 +191,21 @@ interface components$q {
224
191
  /** @description The configuration object for the type (type-specific) */
225
192
  typeConfig?: unknown;
226
193
  };
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
+ };
227
206
  /** @description The definition of a named component slot that can contain other components */
228
207
  ComponentDefinitionSlot: {
229
- id: components$q["schemas"]["PublicIdProperty"];
208
+ id: components$r["schemas"]["PublicIdProperty"];
230
209
  /** @description Friendly name of the slot */
231
210
  name: string;
232
211
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -279,155 +258,97 @@ interface components$q {
279
258
  */
280
259
  regularExpressionMessage?: string;
281
260
  };
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"];
261
+ /** @description Defines a connection to a dynamic token on a data resource */
262
+ DataElementConnectionDefinition: {
263
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value */
264
+ pointer: string;
291
265
  /**
292
- * @description Permission type for this permission ComponentDefinition:
293
- * read | write | create | delete
266
+ * @description The syntax used to select the dynamic token to bind to
294
267
  * @enum {string}
295
268
  */
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;
269
+ syntax: "jptr";
305
270
  /**
306
- * @description Icon name for the component definition (e.g. 'screen')
307
- * @default screen
271
+ * @description The action to take if the dynamic token cannot be resolved
272
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
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}
308
282
  */
309
- icon?: string;
283
+ failureAction?: "t" | "p" | "c" | "a";
310
284
  /**
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
285
+ * @description How to report when the dynamic token cannot be resolved
286
+ * - e: ERROR: Report an error message (this will prevent publishing)
287
+ * - w: WARNING: Report a warning message [default]
288
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
289
+ * @enum {string}
314
290
  */
315
- titleParameter?: string | null;
291
+ failureLogLevel?: "e" | "w" | "i";
316
292
  /**
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
293
+ * @description The default value to use if the dynamic token cannot be resolved.
294
+ * This is only used if the failureAction is the default (undefined, or explicitly token)
319
295
  */
320
- thumbnailParameter?: string | null;
296
+ failureDefault?: string;
297
+ };
298
+ /**
299
+ * @deprecated
300
+ * @description beta functionality subject to change
301
+ */
302
+ VisibilityCriteria: {
303
+ /** @description The rule type to execute */
304
+ rule: string;
321
305
  /**
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
306
+ * @description The source value of the rule.
307
+ * 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.
324
308
  */
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"][];
309
+ source?: string;
310
+ /** @description The rule-definition-specific operator to test against */
311
+ op: string;
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: {
328
320
  /**
329
- * Format: uuid
330
- * @description Reference to the category this component definition belongs to
331
- * @default null
321
+ * @description The boolean operator to join the clauses with. Defaults to & if not specified.
322
+ * @enum {string}
332
323
  */
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;
324
+ op?: "&" | "|";
325
+ clauses: (components$r["schemas"]["VisibilityCriteria"] | components$r["schemas"]["VisibilityCriteriaGroup"])[];
326
+ };
327
+ /** @description Defines a conditional value for a component parameter */
328
+ ComponentParameterConditionalValue: {
329
+ when: components$r["schemas"]["VisibilityCriteriaGroup"];
338
330
  /**
339
- * @description if this component uses team permissions or custom permissions
340
- * @default true
331
+ * @description The value of the parameter. Any JSON-serializable value is acceptable.
332
+ * A value of `null` will cause the parameter value to be removed, if it matches.
341
333
  */
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;
334
+ value: unknown;
356
335
  /**
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
336
+ * @description Unique sequence identifier of the conditional value within the component parameter.
337
+ * This value must be unique within the conditional values array, and it should not change after a condition is created.
359
338
  */
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
- };
339
+ id: number;
430
340
  };
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"][];
431
352
  /** @description Defines an editable parameter on a component */
432
353
  ComponentParameter: {
433
354
  /** @description The value of the parameter. Any JSON-serializable value is acceptable */
@@ -435,7 +356,7 @@ interface components$q {
435
356
  /** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
436
357
  type: string;
437
358
  /** @deprecated */
438
- connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
359
+ connectedData?: components$r["schemas"]["DataElementConnectionDefinition"];
439
360
  /**
440
361
  * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
441
362
  * Note that locales must be registered on the entry/composition `_locales` before being used
@@ -443,116 +364,25 @@ interface components$q {
443
364
  locales?: {
444
365
  [key: string]: unknown;
445
366
  };
446
- conditions?: components$q["schemas"]["ComponentParameterConditions"];
367
+ conditions?: components$r["schemas"]["ComponentParameterConditions"];
447
368
  /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
448
369
  localesConditions?: {
449
- [key: string]: components$q["schemas"]["ComponentParameterConditions"];
370
+ [key: string]: components$r["schemas"]["ComponentParameterConditions"];
450
371
  };
451
372
  };
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
- };
543
373
  /** @description Defines the shape of a component instance served by the composition API */
544
374
  ComponentInstance: {
545
375
  /** @description Type of the component instance (public_id of its definition) */
546
376
  type: string;
547
377
  /** @description Component parameter values for the component instance */
548
378
  parameters?: {
549
- [key: string]: components$q["schemas"]["ComponentParameter"];
379
+ [key: string]: components$r["schemas"]["ComponentParameter"];
550
380
  };
551
381
  /** @description Public ID of alternate visual appearance for this component, if any selected */
552
382
  variant?: string;
553
383
  /** @description Slots containing any child components */
554
384
  slots?: {
555
- [key: string]: components$q["schemas"]["ComponentInstance"][];
385
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
556
386
  };
557
387
  /**
558
388
  * @description Unique identifier of the component within the composition.
@@ -563,15 +393,15 @@ interface components$q {
563
393
  _id?: string;
564
394
  /** @description Indicates this component instance should be sourced from a pattern library pattern */
565
395
  _pattern?: string;
566
- _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
396
+ _dataResources?: components$r["schemas"]["DataResourceDefinitions"];
567
397
  /**
568
398
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
569
399
  * Means nothing for PUTs; it will be ignored
570
400
  */
571
401
  _patternDataResources?: {
572
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
402
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
573
403
  };
574
- _patternError?: components$q["schemas"]["PatternError"];
404
+ _patternError?: components$r["schemas"]["PatternError"];
575
405
  /**
576
406
  * @description Defines patch overrides to component IDs that live in the composition.
577
407
  * This can be used to override parameters that are defined on patterns,
@@ -585,14 +415,14 @@ interface components$q {
585
415
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
586
416
  */
587
417
  _overrides?: {
588
- [key: string]: components$q["schemas"]["ComponentOverride"];
418
+ [key: string]: components$r["schemas"]["ComponentOverride"];
589
419
  };
590
420
  /**
591
421
  * @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
592
422
  * Means nothing for PUTs; it will be ignored
593
423
  */
594
424
  _patternOverrides?: {
595
- [key: string]: components$q["schemas"]["ComponentOverride"];
425
+ [key: string]: components$r["schemas"]["ComponentOverride"];
596
426
  };
597
427
  /**
598
428
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -601,107 +431,79 @@ interface components$q {
601
431
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
602
432
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
603
433
  */
604
- _overridability?: components$q["schemas"]["ComponentOverridability"];
434
+ _overridability?: components$r["schemas"]["ComponentOverridability"];
605
435
  /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
606
436
  _locales?: string[];
607
437
  };
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) */
438
+ /** @description Variable values for a data resource */
439
+ DataResourceVariables: {
440
+ [key: string]: string;
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 */
611
445
  type: string;
612
- /** @description Component parameter values for the component instance */
446
+ /** @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 */
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: {
613
483
  parameters?: {
614
- [key: string]: components$q["schemas"]["ComponentParameter"];
484
+ [key: string]: components$r["schemas"]["ComponentParameter"];
615
485
  };
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 */
621
486
  slots?: {
622
- [key: string]: components$q["schemas"]["ComponentInstance"][];
487
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
623
488
  };
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;
489
+ variant?: string;
640
490
  /**
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
491
+ * @description Overrides data resource definitions for a pattern component.
492
+ * Object keys defined under this property override the corresponding keys in the pattern's data resources.
493
+ * Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
643
494
  */
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"];
495
+ dataResources?: {
496
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
670
497
  };
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[];
681
498
  };
682
499
  /**
683
- * @description Defines how to override a specific component.
500
+ * @description Whether a parameter is overridable
684
501
  *
685
502
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
686
503
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
504
+ * @enum {string}
687
505
  */
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
- };
506
+ OverrideOptions: "yes" | "no";
705
507
  /**
706
508
  * @description Defines how a component on a pattern may have its values overridden.
707
509
  * NOTE: Data resources' overridability is defined in the data resource definition, not here.
@@ -712,7 +514,7 @@ interface components$q {
712
514
  ComponentOverridability: {
713
515
  /** @description Defines component parameter value overrides. Keys are the parameter public ID */
714
516
  parameters?: {
715
- [key: string]: components$q["schemas"]["OverrideOptions"];
517
+ [key: string]: components$r["schemas"]["OverrideOptions"];
716
518
  };
717
519
  /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
718
520
  variants?: boolean;
@@ -723,1084 +525,1313 @@ interface components$q {
723
525
  */
724
526
  hideLockedParameters?: boolean;
725
527
  };
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
- };
528
+ /** @description The definition of a component variant */
529
+ ComponentDefinitionVariant: {
530
+ id: components$r["schemas"]["PublicIdProperty"];
531
+ /** @description Friendly name of the variant */
532
+ name: string;
754
533
  };
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
- };
534
+ /** @description Defines a component type that can live on a Composition */
535
+ ComponentDefinition: {
536
+ id: components$r["schemas"]["PublicIdProperty"];
537
+ /** @description Friendly name of the component definition */
538
+ name: string;
784
539
  /**
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
540
+ * @description Icon name for the component definition (e.g. 'screen')
541
+ * @default screen
787
542
  */
788
- localeMapping?: {
789
- [key: string]: string;
790
- };
543
+ icon?: string;
791
544
  /**
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.
545
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
546
+ * The parameter type must support being used as a title parameter for this to work
547
+ * @default null
794
548
  */
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;
549
+ titleParameter?: string | null;
825
550
  /**
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
551
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
552
+ * @default null
829
553
  */
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;
554
+ thumbnailParameter?: string | null;
854
555
  /**
855
- * @description HTTP method to use with requests to the data type
856
- * @default GET
857
- * @enum {string}
556
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
557
+ * @default false
858
558
  */
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;
559
+ canBeComposition?: boolean;
560
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
561
+ parameters?: components$r["schemas"]["ComponentDefinitionParameter"][];
883
562
  /**
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
563
+ * Format: uuid
564
+ * @description Reference to the category this component definition belongs to
565
+ * @default null
886
566
  */
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;
567
+ categoryId?: string | null;
568
+ /** @description Description of the component definition */
569
+ description?: string;
570
+ /** @description Preview image URL for the component definition (shown in the UI) */
571
+ previewImageUrl?: string;
892
572
  /**
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'
573
+ * @description if this component uses team permissions or custom permissions
574
+ * @default true
895
575
  */
896
- source?: string;
897
- };
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"];
904
- };
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 */
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;
911
- /**
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
915
- */
916
- ignorePatternParameterDefault?: boolean;
576
+ useTeamPermissions?: boolean;
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;
917
590
  /**
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
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
920
593
  */
921
- optionalPatternParameter?: boolean;
922
- variables?: components$q["schemas"]["DataResourceVariables"];
594
+ workflowId?: string;
923
595
  };
924
- /** @description Variable values for a data resource */
925
- DataResourceVariables: {
926
- [key: string]: string;
596
+ Error: {
597
+ /** @description Error message(s) that occurred while processing the request */
598
+ errorMessage?: string[] | string;
927
599
  };
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: {
937
- /**
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
940
- */
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"][];
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
+ };
946
610
  };
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 */
958
- state: number;
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
+ };
959
619
  };
960
- /** @description Category for tagging canvas entities */
961
- Category: {
962
- /**
963
- * Format: uuid
964
- * @description Unique identifier for the category
965
- */
966
- id: string;
967
- /** @description Display name of the category */
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;
635
+ };
636
+ /** @description Execution error occurred */
637
+ InternalServerError: {
638
+ headers: {
639
+ [name: string]: unknown;
640
+ };
641
+ content?: never;
642
+ };
643
+ };
644
+ parameters: never;
645
+ requestBodies: never;
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 */
968
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) */
664
+ type: string;
969
665
  /**
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
666
+ * @description If true, this property can have locale-specific values. If false or not defined,
667
+ * this property will have a single value that is shared for all locales
972
668
  */
973
- order?: number;
974
- };
975
- /** @description Project map node information related to a component */
976
- CompositionProjectMapNodeInfo: {
669
+ localizable?: boolean;
977
670
  /**
978
- * Format: uuid
979
- * @description Unique identifier for the project map node
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.
980
676
  */
981
- id: string;
677
+ notLocalizedByDefault?: boolean;
982
678
  /**
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
679
+ * @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
680
+ * When combined with a localized value, each locale has independent conditional values.
681
+ *
682
+ * When not defined, conditional values are not allowed.
985
683
  */
986
- path: string;
684
+ allowConditionalValues?: boolean;
685
+ /** @description The configuration object for the type (type-specific) */
686
+ typeConfig?: unknown;
687
+ };
688
+ /** @description The definition of a named component slot that can contain other components */
689
+ ComponentDefinitionSlot: {
690
+ id: components$q["schemas"]["PublicIdProperty"];
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[];
987
695
  /**
988
- * Format: uuid
989
- * @description Unique identifier for the project map that this node belongs to
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
990
699
  */
991
- projectMapId: string;
992
- data?: components$q["schemas"]["ProjectMapNodeData"];
700
+ inheritAllowedComponents: boolean;
993
701
  /**
994
- * @description Locale-specific paths of the project map node.
995
- * Keys are locale codes
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`
996
704
  */
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: {
705
+ allowAllComponents?: boolean;
1008
706
  /**
1009
- * Format: uuid
1010
- * @description Unique identifier for the prompt
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>`
1011
709
  */
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;
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;
1029
715
  };
1030
- /** @description Definition of a workflow that can be assigned to entities */
1031
- WorkflowDefinition: {
716
+ /** @description The definition of a composition's slug settings */
717
+ ComponentDefinitionSlugSettings: {
1032
718
  /**
1033
- * Format: uuid
1034
- * @description Unique identifier of the workflow definition
719
+ * @description Whether the slug is required
720
+ * no: slug is optional
721
+ * yes: slug is required
722
+ * disabled: slug is disabled and will not be shown in the editor
723
+ * @default no
724
+ * @enum {string}
1035
725
  */
1036
- id: string;
1037
- /** @description Workflow name */
1038
- name: string;
726
+ required?: "no" | "yes" | "disabled";
1039
727
  /**
1040
- * Format: uuid
1041
- * @description The ID of the initial stage in the stages object.
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}
1042
733
  */
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;
734
+ unique?: "no" | "local" | "global";
735
+ /** @description Regular expression slugs must match */
736
+ regularExpression?: string;
1052
737
  /**
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
738
+ * @description Custom error message when regular expression validation fails.
739
+ * Has no effect if `regularExpression` is not set
1056
740
  */
1057
- createdBy?: string;
741
+ regularExpressionMessage?: string;
742
+ };
743
+ /** @description The definition of a component variant */
744
+ ComponentDefinitionVariant: {
745
+ id: components$q["schemas"]["PublicIdProperty"];
746
+ /** @description Friendly name of the variant */
747
+ name: string;
748
+ };
749
+ /** @description Permission set for a component definition */
750
+ ComponentDefinitionPermission: {
751
+ roleId: components$q["schemas"]["PublicIdProperty"];
1058
752
  /**
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
753
+ * @description Permission type for this permission ComponentDefinition:
754
+ * read | write | create | delete
755
+ * @enum {string}
1062
756
  */
1063
- modifiedBy?: string;
757
+ permission: "read" | "write" | "create" | "delete";
758
+ /** @description State of the component that this permission applies to */
759
+ state: number;
1064
760
  };
1065
- /** @description Definition of a stage in a workflow */
1066
- WorkflowStage: {
1067
- /** @description Name of the stage */
761
+ /** @description Defines a component type that can live on a Composition */
762
+ ComponentDefinition: {
763
+ id: components$q["schemas"]["PublicIdProperty"];
764
+ /** @description Friendly name of the component definition */
1068
765
  name: string;
1069
766
  /**
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
767
+ * @description Icon name for the component definition (e.g. 'screen')
768
+ * @default screen
1074
769
  */
1075
- permissions: {
1076
- [key: string]: components$q["schemas"]["WorkflowStagePermission"];
1077
- };
770
+ icon?: string;
1078
771
  /**
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
772
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
773
+ * The parameter type must support being used as a title parameter for this to work
774
+ * @default null
1083
775
  */
1084
- autoPublish?: boolean;
776
+ titleParameter?: string | null;
1085
777
  /**
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
778
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
779
+ * @default null
1089
780
  */
1090
- requireValidity?: boolean;
781
+ thumbnailParameter?: string | null;
1091
782
  /**
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
783
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
784
+ * @default false
1095
785
  */
1096
- transitions: components$q["schemas"]["WorkflowStageTransition"][];
786
+ canBeComposition?: boolean;
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"][];
1097
789
  /**
1098
- * @description Icon name for the stage (e.g. 'chevron-double-right-o')
1099
- * @default chevron-double-right-o
790
+ * Format: uuid
791
+ * @description Reference to the category this component definition belongs to
792
+ * @default null
1100
793
  */
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;
794
+ categoryId?: string | null;
795
+ /** @description Description of the component definition */
796
+ description?: string;
797
+ /** @description Preview image URL for the component definition (shown in the UI) */
798
+ previewImageUrl?: string;
799
+ /**
800
+ * @description if this component uses team permissions or custom permissions
801
+ * @default true
802
+ */
803
+ useTeamPermissions?: boolean;
804
+ /** @description Custom role permissions for this component definition */
805
+ permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
806
+ /** @description The named slots for this component; placement areas where arrays of other components can be added */
807
+ slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
808
+ slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
809
+ /** @description Default component instance value */
810
+ defaults?: components$q["schemas"]["ComponentInstance"] | null;
811
+ /** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
812
+ variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
813
+ /** @description Created date string for this definition (ignored for writes) */
814
+ created?: string;
815
+ /** @description Last modified date string for this definition (ignored for writes) */
816
+ updated?: string;
817
+ /**
818
+ * Format: uuid
819
+ * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
820
+ */
821
+ workflowId?: string;
1104
822
  };
1105
- /** @description Definition of a transition from one stage to another in a workflow */
1106
- WorkflowStageTransition: {
823
+ /** @description Defines a content type */
824
+ ContentType: {
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";
858
+ /**
859
+ * @description if this content type uses team permissions or custom permissions
860
+ * @default true
861
+ */
862
+ useTeamPermissions?: boolean;
863
+ /** @description Custom role permissions for this content type */
864
+ permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
1107
865
  /**
1108
866
  * Format: uuid
1109
- * @description The target stage to transition to
867
+ * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
1110
868
  */
1111
- to: string;
869
+ workflowId?: string;
870
+ /** @description Configurations for previewing an entry on a consuming pattern or composition. */
871
+ previewConfigurations?: components$q["schemas"]["ContentTypePreviewConfiguration"][];
872
+ };
873
+ /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
874
+ ContentTypePreviewConfiguration: {
1112
875
  /**
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
876
+ * @description The type of preview configuration
877
+ * @enum {string}
1115
878
  */
1116
- name: string;
879
+ type: "pattern" | "project-map";
880
+ /** @description Display label for the preview configuration */
881
+ label: string;
1117
882
  /**
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
883
+ * Format: uuid
884
+ * @description Target preview entity ID (project map node ID or pattern ID)
1120
885
  */
1121
- permissions: {
1122
- [key: string]: components$q["schemas"]["WorkflowStageTransitionPermission"];
886
+ id: string;
887
+ /** @description Optional mapping of dynamic input names to their values */
888
+ dynamicInputs?: {
889
+ [key: string]: string;
1123
890
  };
1124
891
  };
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;
1131
- };
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;
1136
- };
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
- }[];
892
+ /** @description Defines an editable parameter on a component */
893
+ ComponentParameter: {
894
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable */
895
+ value?: unknown;
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"];
900
+ /**
901
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
902
+ * Note that locales must be registered on the entry/composition `_locales` before being used
903
+ */
904
+ locales?: {
905
+ [key: string]: unknown;
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"];
1161
911
  };
1162
912
  };
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"][];
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"];
1168
927
  /**
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
928
+ * @description The value of the parameter. Any JSON-serializable value is acceptable.
929
+ * A value of `null` will cause the parameter value to be removed, if it matches.
1172
930
  */
1173
- previewValue?: string;
1174
- };
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;
931
+ value: unknown;
932
+ /**
933
+ * @description Unique sequence identifier of the conditional value within the component parameter.
934
+ * This value must be unique within the conditional values array, and it should not change after a condition is created.
935
+ */
936
+ id: number;
1227
937
  };
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;
938
+ /**
939
+ * @deprecated
940
+ * @description beta functionality subject to change
941
+ */
942
+ VisibilityCriteriaGroup: {
943
+ /**
944
+ * @description The boolean operator to join the clauses with. Defaults to & if not specified.
945
+ * @enum {string}
946
+ */
947
+ op?: "&" | "|";
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;
957
+ /**
958
+ * @description The source value of the rule.
959
+ * 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.
960
+ */
961
+ source?: string;
962
+ /** @description The rule-definition-specific operator to test against */
963
+ op: string;
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[];
966
+ };
967
+ /** @description Defines a connection to a dynamic token on a data resource */
968
+ DataElementConnectionDefinition: {
969
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value */
970
+ pointer: string;
971
+ /**
972
+ * @description The syntax used to select the dynamic token to bind to
973
+ * @enum {string}
974
+ */
975
+ syntax: "jptr";
976
+ /**
977
+ * @description The action to take if the dynamic token cannot be resolved
978
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
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}
988
+ */
989
+ failureAction?: "t" | "p" | "c" | "a";
990
+ /**
991
+ * @description How to report when the dynamic token cannot be resolved
992
+ * - e: ERROR: Report an error message (this will prevent publishing)
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}
996
+ */
997
+ failureLogLevel?: "e" | "w" | "i";
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"];
1247
1011
  };
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"];
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"];
1057
+ };
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
+ };
1069
+ /** @description Defines the shape of the root component in a composition */
1070
+ RootComponentInstance: {
1071
+ /** @description Type of the component instance (public_id of its definition) */
1072
+ type: string;
1073
+ /** @description Component parameter values for the component instance */
1074
+ parameters?: {
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[];
1142
+ };
1143
+ /**
1144
+ * @description Defines how to override a specific component.
1145
+ *
1146
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
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"];
1267
1152
  };
1268
- };
1269
- /** @description Upserts a component definition */
1270
- put: {
1271
- parameters: {
1272
- query?: never;
1273
- header?: never;
1274
- path?: never;
1275
- cookie?: never;
1153
+ slots?: {
1154
+ [key: string]: components$q["schemas"]["ComponentInstance"][];
1276
1155
  };
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
- };
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"];
1288
1164
  };
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"];
1165
+ };
1166
+ /**
1167
+ * @description Defines how a component on a pattern may have its values overridden.
1168
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
1169
+ *
1170
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1171
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
1172
+ */
1173
+ ComponentOverridability: {
1174
+ /** @description Defines component parameter value overrides. Keys are the parameter public ID */
1175
+ parameters?: {
1176
+ [key: string]: components$q["schemas"]["OverrideOptions"];
1302
1177
  };
1178
+ /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
1179
+ variants?: boolean;
1180
+ /**
1181
+ * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
1182
+ * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
1183
+ * If not set, the default is false
1184
+ */
1185
+ hideLockedParameters?: boolean;
1303
1186
  };
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;
1187
+ /**
1188
+ * @description Whether a parameter is overridable
1189
+ *
1190
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1191
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
1192
+ * @enum {string}
1193
+ */
1194
+ OverrideOptions: "yes" | "no";
1195
+ /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
1196
+ AlternativeDataSourceData: {
1197
+ /** @description Base resource URL of the data source. No trailing slash */
1198
+ baseUrl: string;
1199
+ /** @description HTTP headers to pass with requests to the data source */
1200
+ headers?: {
1201
+ key: string;
1202
+ value: string;
1203
+ omitIfEmpty?: boolean;
1204
+ }[];
1205
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
1206
+ parameters?: {
1207
+ key: string;
1208
+ value: string;
1209
+ omitIfEmpty?: boolean;
1210
+ }[];
1211
+ /** @description Variables needed to make calls to the data source */
1212
+ variables?: {
1213
+ [key: string]: components$q["schemas"]["DataVariableDefinition"];
1312
1214
  };
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
- };
1215
+ };
1216
+ /**
1217
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
1218
+ * These are created in the UI and shared across a whole project.
1219
+ * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
1220
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value
1221
+ */
1222
+ DataSource: {
1223
+ /** @description Public ID of the data source */
1224
+ id: string;
1225
+ /** @description Display name of the data source */
1226
+ displayName: string;
1227
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
1228
+ connectorType: string;
1229
+ /** @description Base resource URL of the data source. No trailing slash */
1230
+ baseUrl: string;
1231
+ /** @description HTTP headers to pass with requests to the data source */
1232
+ headers?: {
1233
+ key: string;
1234
+ value: string;
1235
+ }[];
1236
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
1237
+ parameters?: {
1238
+ key: string;
1239
+ value: string;
1240
+ }[];
1241
+ /** @description Variables needed to make calls to the data source */
1242
+ variables?: {
1243
+ [key: string]: components$q["schemas"]["DataVariableDefinition"];
1325
1244
  };
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"];
1245
+ /**
1246
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
1247
+ * If a locale is not mapped, it will be passed through to the data source as-is
1248
+ */
1249
+ localeMapping?: {
1250
+ [key: string]: string;
1251
+ };
1252
+ /**
1253
+ * @description If true, data source will require additional credentials to access unpublished data.
1254
+ * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
1255
+ */
1256
+ enableUnpublishedMode?: boolean;
1257
+ /** @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 */
1258
+ customPublic?: {
1259
+ [key: string]: unknown;
1260
+ };
1261
+ /** @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 */
1262
+ custom?: {
1263
+ [key: string]: unknown;
1264
+ };
1265
+ /** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
1266
+ variants?: {
1267
+ unpublished?: components$q["schemas"]["AlternativeDataSourceData"];
1339
1268
  };
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;
1340
1277
  };
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;
1278
+ /** @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 */
1279
+ DataType: {
1280
+ /** @description Public ID of the data type */
1281
+ id: string;
1282
+ /** @description Display name of the data type */
1283
+ displayName: string;
1284
+ /** @description Public ID of the associated data source */
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"];
1348
1324
  };
1349
- requestBody?: never;
1350
- responses: {
1351
- /** @description OK */
1352
- 204: {
1353
- headers: {
1354
- [name: string]: unknown;
1355
- };
1356
- content?: never;
1357
- };
1325
+ /** @description Custom configuration specific to the data source being defined */
1326
+ custom?: {
1327
+ [key: string]: unknown;
1358
1328
  };
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;
1359
1337
  };
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 */
1338
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
1339
+ DataVariableDefinition: {
1340
+ /** @description Display name of the data variable */
1341
+ displayName?: string;
1342
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
1375
1343
  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;
1380
1344
  /**
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
1345
+ * @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
1346
+ * @default text
1383
1347
  */
1384
- localizable?: boolean;
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;
1385
1353
  /**
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.
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'
1391
1356
  */
1392
- notLocalizedByDefault?: boolean;
1357
+ source?: string;
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;
1393
1372
  /**
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.
1373
+ * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
1374
+ * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
1375
+ * If isPatternParameter is false or undefined, this has no meaning
1398
1376
  */
1399
- allowConditionalValues?: boolean;
1400
- /** @description The configuration object for the type (type-specific) */
1401
- typeConfig?: unknown;
1377
+ ignorePatternParameterDefault?: boolean;
1378
+ /**
1379
+ * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
1380
+ * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1381
+ */
1382
+ optionalPatternParameter?: boolean;
1383
+ variables?: components$q["schemas"]["DataResourceVariables"];
1402
1384
  };
1403
- /** @description Permission set for a component definition */
1404
- ComponentDefinitionPermission: {
1405
- roleId: components$p["schemas"]["PublicIdProperty"];
1385
+ /** @description Variable values for a data resource */
1386
+ DataResourceVariables: {
1387
+ [key: string]: string;
1388
+ };
1389
+ /**
1390
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
1391
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
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: {
1406
1398
  /**
1407
- * @description Permission type for this permission ComponentDefinition:
1408
- * read | write | create | delete
1409
- * @enum {string}
1399
+ * @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.
1400
+ * If this is undefined then no more results are available
1410
1401
  */
1411
- permission: "read" | "write" | "create" | "delete";
1412
- /** @description State of the component that this permission applies to */
1402
+ cursor?: string;
1403
+ /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
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 */
1413
1417
  state: number;
1414
1418
  };
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
+ /** @description Category for tagging canvas entities */
1420
+ Category: {
1421
+ /**
1422
+ * Format: uuid
1423
+ * @description Unique identifier for the category
1424
+ */
1425
+ id: string;
1426
+ /** @description Display name of the category */
1419
1427
  name: string;
1420
- /** @description A list of component definition public IDs that are allowed in this named slot */
1421
- allowedComponents: string[];
1422
1428
  /**
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
1429
+ * @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
1430
+ * @default 0
1426
1431
  */
1427
- inheritAllowedComponents: boolean;
1432
+ order?: number;
1433
+ };
1434
+ /** @description Project map node information related to a component */
1435
+ CompositionProjectMapNodeInfo: {
1428
1436
  /**
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`
1437
+ * Format: uuid
1438
+ * @description Unique identifier for the project map node
1431
1439
  */
1432
- allowAllComponents?: boolean;
1440
+ id: string;
1433
1441
  /**
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>`
1442
+ * @description Fallback path of the project map node.
1443
+ * Note that the node may have matched via a locale-specific path which is in the `locales` object
1436
1444
  */
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: {
1445
+ path: string;
1445
1446
  /**
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}
1447
+ * Format: uuid
1448
+ * @description Unique identifier for the project map that this node belongs to
1452
1449
  */
1453
- required?: "no" | "yes" | "disabled";
1450
+ projectMapId: string;
1451
+ data?: components$q["schemas"]["ProjectMapNodeData"];
1454
1452
  /**
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}
1453
+ * @description Locale-specific paths of the project map node.
1454
+ * Keys are locale codes
1460
1455
  */
1461
- unique?: "no" | "local" | "global";
1462
- /** @description Regular expression slugs must match */
1463
- regularExpression?: string;
1456
+ locales?: {
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
+ };
1464
+ };
1465
+ /** @description AI Prompt definition */
1466
+ Prompt: {
1464
1467
  /**
1465
- * @description Custom error message when regular expression validation fails.
1466
- * Has no effect if `regularExpression` is not set
1468
+ * Format: uuid
1469
+ * @description Unique identifier for the prompt
1467
1470
  */
1468
- regularExpressionMessage?: string;
1471
+ id: string;
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;
1469
1488
  };
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;
1489
+ /** @description Definition of a workflow that can be assigned to entities */
1490
+ WorkflowDefinition: {
1474
1491
  /**
1475
- * @description The syntax used to select the dynamic token to bind to
1476
- * @enum {string}
1492
+ * Format: uuid
1493
+ * @description Unique identifier of the workflow definition
1477
1494
  */
1478
- syntax: "jptr";
1495
+ id: string;
1496
+ /** @description Workflow name */
1497
+ name: string;
1479
1498
  /**
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}
1499
+ * Format: uuid
1500
+ * @description The ID of the initial stage in the stages object.
1491
1501
  */
1492
- failureAction?: "t" | "p" | "c" | "a";
1502
+ initialStage: string;
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;
1493
1511
  /**
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}
1512
+ * @description Name of the original creator of the workflow.
1513
+ * If undefined, the user has been removed from the team.
1514
+ * Ignored for writes
1499
1515
  */
1500
- failureLogLevel?: "e" | "w" | "i";
1516
+ createdBy?: string;
1501
1517
  /**
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)
1518
+ * @description Name of the last modifier of the workflow.
1519
+ * If undefined, the user has been removed from the team.
1520
+ * Ignored for writes
1504
1521
  */
1505
- failureDefault?: string;
1522
+ modifiedBy?: string;
1506
1523
  };
1507
- /**
1508
- * @deprecated
1509
- * @description beta functionality subject to change
1510
- */
1511
- VisibilityCriteria: {
1512
- /** @description The rule type to execute */
1513
- rule: string;
1524
+ /** @description Definition of a stage in a workflow */
1525
+ WorkflowStage: {
1526
+ /** @description Name of the stage */
1527
+ name: string;
1514
1528
  /**
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.
1529
+ * @description Defines roles which have permissions to this workflow stage
1530
+ * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
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
1517
1533
  */
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
- };
1524
- /**
1525
- * @deprecated
1526
- * @description beta functionality subject to change
1527
- */
1528
- VisibilityCriteriaGroup: {
1534
+ permissions: {
1535
+ [key: string]: components$q["schemas"]["WorkflowStagePermission"];
1536
+ };
1529
1537
  /**
1530
- * @description The boolean operator to join the clauses with. Defaults to & if not specified.
1531
- * @enum {string}
1538
+ * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
1539
+ * 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.
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
1532
1542
  */
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"];
1543
+ autoPublish?: boolean;
1539
1544
  /**
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.
1545
+ * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
1546
+ * If the entity is not valid, the transition will not be allowed.
1547
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
1542
1548
  */
1543
- value: unknown;
1549
+ requireValidity?: boolean;
1544
1550
  /**
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.
1551
+ * @description Defines transitions to other stages
1552
+ * Every stage must define at least one transition, to avoid creating a workflow that
1553
+ * has a stage that can never be escaped
1547
1554
  */
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"];
1555
+ transitions: components$q["schemas"]["WorkflowStageTransition"][];
1569
1556
  /**
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
1557
+ * @description Icon name for the stage (e.g. 'chevron-double-right-o')
1558
+ * @default chevron-double-right-o
1572
1559
  */
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
- };
1560
+ icon?: string;
1561
+ /** @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 */
1562
+ order?: number;
1581
1563
  };
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
- };
1564
+ /** @description Definition of a transition from one stage to another in a workflow */
1565
+ WorkflowStageTransition: {
1596
1566
  /**
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
1567
+ * Format: uuid
1568
+ * @description The target stage to transition to
1601
1569
  */
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"];
1570
+ to: string;
1606
1571
  /**
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
1572
+ * @description Name shown to the user when they execute this transition.
1573
+ * If not provided, a default name will be assigned automatically based on the target stage
1609
1574
  */
1610
- _patternDataResources?: {
1611
- [key: string]: components$p["schemas"]["DataResourceDefinition"];
1612
- };
1613
- _patternError?: components$p["schemas"]["PatternError"];
1575
+ name: string;
1614
1576
  /**
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
1577
+ * @description Permissions for the stage transition.
1578
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
1625
1579
  */
1626
- _overrides?: {
1627
- [key: string]: components$p["schemas"]["ComponentOverride"];
1580
+ permissions: {
1581
+ [key: string]: components$q["schemas"]["WorkflowStageTransitionPermission"];
1628
1582
  };
1629
- /**
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
1632
- */
1633
- _patternOverrides?: {
1634
- [key: string]: components$p["schemas"]["ComponentOverride"];
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;
1595
+ };
1596
+ /** @enum {string} */
1597
+ ReleaseState: "open" | "locked" | "queued" | "launching" | "launched" | "deleting";
1598
+ /** @enum {string} */
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
+ }[];
1635
1620
  };
1621
+ };
1622
+ ProjectMapNodeData: {
1623
+ /** @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 */
1624
+ isSearchHit?: boolean;
1625
+ /** @description Query strings that are allowed to be passed to the node */
1626
+ queryStrings?: components$q["schemas"]["ProjectMapNodeAllowedQueryString"][];
1636
1627
  /**
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
1628
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
1629
+ * The preview value is used when editing a connected composition, and is the default
1630
+ * dynamic node value unless the author has explicitly chosen a different value
1642
1631
  */
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[];
1632
+ previewValue?: string;
1646
1633
  };
1647
- /** @description Variable values for a data resource */
1648
- DataResourceVariables: {
1649
- [key: string]: string;
1634
+ };
1635
+ responses: never;
1636
+ parameters: never;
1637
+ requestBodies: never;
1638
+ headers: never;
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
+ */
1662
+ /**
1663
+ * Prefix used by every `select.*` query parameter on the wire. Exported so
1664
+ * downstream prefix scans (lambda validator, edge search-param reader,
1665
+ * origin handler short-circuits) and key builders don't hand-roll the
1666
+ * literal at every call site.
1667
+ */
1668
+ declare const SELECT_QUERY_PREFIX = "select.";
1669
+ type FieldsProjection = {
1670
+ /** Include only fields whose name matches one of these patterns. */
1671
+ only?: string[];
1672
+ /** Exclude fields whose name matches one of these patterns. */
1673
+ except?: string[];
1674
+ /**
1675
+ * Field-name patterns whose value should retain its full per-locale map
1676
+ * (`locales` / `localesConditions`) after `localize` runs. Representation
1677
+ * modifier; the pruner ignores this — see lib/canvas-sdk applyProjection.
1678
+ */
1679
+ locales?: string[];
1680
+ };
1681
+ type FieldTypesProjection = {
1682
+ /** Include only fields whose `type` matches one of these patterns. */
1683
+ only?: string[];
1684
+ /** Exclude fields whose `type` matches one of these patterns. */
1685
+ except?: string[];
1686
+ };
1687
+ type SlotsProjection = {
1688
+ /** Include only slots whose name matches one of these patterns. */
1689
+ only?: string[];
1690
+ /** Exclude slots whose name matches one of these patterns. */
1691
+ except?: string[];
1692
+ /**
1693
+ * Container-wide recursion-depth cap counted in slot levels from the root.
1694
+ * 0 means "no slots at all on the root"; 1 means "root's own slots but no
1695
+ * grandchildren slots". Per-name depth (see `named`) overrides this for
1696
+ * its specific slot.
1697
+ */
1698
+ depth?: number;
1699
+ /** Per-slot depth caps. Keyed by slot name. */
1700
+ named?: {
1701
+ [slotName: string]: {
1702
+ depth?: number;
1650
1703
  };
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;
1657
- /**
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
1661
- */
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"];
1704
+ };
1705
+ };
1706
+ type ProjectionSpec = {
1707
+ fields?: FieldsProjection;
1708
+ fieldTypes?: FieldTypesProjection;
1709
+ slots?: SlotsProjection;
1710
+ };
1711
+
1712
+ interface paths$m {
1713
+ "/api/v1/categories": {
1714
+ parameters: {
1715
+ query?: never;
1716
+ header?: never;
1717
+ path?: never;
1718
+ cookie?: never;
1669
1719
  };
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"];
1720
+ get: {
1721
+ parameters: {
1722
+ query: {
1723
+ projectId: string;
1724
+ };
1725
+ header?: never;
1726
+ path?: never;
1727
+ cookie?: never;
1728
+ };
1729
+ requestBody?: never;
1730
+ responses: {
1731
+ /** @description OK */
1732
+ 200: {
1733
+ headers: {
1734
+ [name: string]: unknown;
1735
+ };
1736
+ content: {
1737
+ "application/json": {
1738
+ categories: components$p["schemas"]["Category"][];
1739
+ };
1740
+ };
1741
+ };
1742
+ 400: components$p["responses"]["BadRequestError"];
1743
+ 401: components$p["responses"]["UnauthorizedError"];
1744
+ 403: components$p["responses"]["ForbiddenError"];
1745
+ 429: components$p["responses"]["RateLimitError"];
1746
+ 500: components$p["responses"]["InternalServerError"];
1747
+ };
1676
1748
  };
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"];
1749
+ put: {
1750
+ parameters: {
1751
+ query?: never;
1752
+ header?: never;
1753
+ path?: never;
1754
+ cookie?: never;
1694
1755
  };
1695
- slots?: {
1696
- [key: string]: components$p["schemas"]["ComponentInstance"][];
1756
+ requestBody: {
1757
+ content: {
1758
+ "application/json": {
1759
+ /** Format: uuid */
1760
+ projectId: string;
1761
+ categories: components$p["schemas"]["Category"][];
1762
+ };
1763
+ };
1697
1764
  };
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"];
1765
+ responses: {
1766
+ /** @description OK */
1767
+ 204: {
1768
+ headers: {
1769
+ [name: string]: unknown;
1770
+ };
1771
+ content?: never;
1772
+ };
1773
+ 400: components$p["responses"]["BadRequestError"];
1774
+ 401: components$p["responses"]["UnauthorizedError"];
1775
+ 403: components$p["responses"]["ForbiddenError"];
1776
+ 429: components$p["responses"]["RateLimitError"];
1777
+ 500: components$p["responses"]["InternalServerError"];
1706
1778
  };
1707
1779
  };
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"];
1780
+ post?: never;
1781
+ delete: {
1782
+ parameters: {
1783
+ query?: never;
1784
+ header?: never;
1785
+ path?: never;
1786
+ cookie?: never;
1787
+ };
1788
+ requestBody: {
1789
+ content: {
1790
+ "application/json": {
1791
+ /** Format: uuid */
1792
+ categoryId: string;
1793
+ /** Format: uuid */
1794
+ projectId: string;
1795
+ };
1796
+ };
1797
+ };
1798
+ responses: {
1799
+ /** @description OK */
1800
+ 204: {
1801
+ headers: {
1802
+ [name: string]: unknown;
1803
+ };
1804
+ content?: never;
1805
+ };
1806
+ 400: components$p["responses"]["BadRequestError"];
1807
+ 401: components$p["responses"]["UnauthorizedError"];
1808
+ 403: components$p["responses"]["ForbiddenError"];
1809
+ 429: components$p["responses"]["RateLimitError"];
1810
+ 500: components$p["responses"]["InternalServerError"];
1727
1811
  };
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;
1736
- };
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
1812
  };
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"][];
1813
+ options?: never;
1814
+ head?: never;
1815
+ patch?: never;
1816
+ trace?: never;
1817
+ };
1818
+ }
1819
+ interface components$p {
1820
+ schemas: {
1821
+ /** @description Category for tagging canvas entities */
1822
+ Category: {
1771
1823
  /**
1772
1824
  * Format: uuid
1773
- * @description Reference to the category this component definition belongs to
1774
- * @default null
1775
- */
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;
1781
- /**
1782
- * @description if this component uses team permissions or custom permissions
1783
- * @default true
1825
+ * @description Unique identifier for the category
1784
1826
  */
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;
1827
+ id: string;
1828
+ /** @description Display name of the category */
1829
+ name: string;
1799
1830
  /**
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
1831
+ * @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
1832
+ * @default 0
1802
1833
  */
1803
- workflowId?: string;
1834
+ order?: number;
1804
1835
  };
1805
1836
  Error: {
1806
1837
  /** @description Error message(s) that occurred while processing the request */
@@ -1856,8 +1887,21 @@ interface components$p {
1856
1887
  pathItems: never;
1857
1888
  }
1858
1889
 
1890
+ type SharedComponents$3 = components$q['schemas'];
1891
+ type Api$2 = paths$m['/api/v1/categories'];
1892
+ /** Shape of the GET response from /api/v1/category */
1893
+ type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
1894
+ /** Shape of the PUT request body for /api/v1/category */
1895
+ type CategoriesPutParameters = Api$2['put']['requestBody']['content']['application/json'];
1896
+ /** Shape of the DELETE request body for /api/v1/category */
1897
+ type CategoriesDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
1898
+ /** Query parameter options for GET /api/v1/category */
1899
+ type CategoriesGetParameters = Api$2['get']['parameters']['query'];
1900
+ /** Defines a component type that can live on a Composition */
1901
+ type Category = SharedComponents$3['Category'];
1902
+
1859
1903
  type SharedComponents$2 = components$q['schemas'];
1860
- type Api$1 = paths$m['/api/v1/canvas-definitions'];
1904
+ type Api$1 = paths$n['/api/v1/canvas-definitions'];
1861
1905
  /** Shape of the GET response from /api/v1/canvas-definitions */
1862
1906
  type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
1863
1907
  /** Shape of the PUT request body for /api/v1/canvas-definitions */
@@ -1881,31 +1925,6 @@ type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPerm
1881
1925
  /** Defines a component type that can live on a Composition */
1882
1926
  type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
1883
1927
 
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
-
1909
1928
  /** Public ID of Canvas personalization component type */
1910
1929
  declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
1911
1930
  /** Public ID of Canvas A/B test component type */
@@ -2656,9 +2675,7 @@ interface components$o {
2656
2675
  withWorkflowDefinition: boolean;
2657
2676
  /**
2658
2677
  * @description If true the `_id` unique identifier of blocks will be part of the response data.
2659
- * If false, the `_id` will not be present in the API response.
2660
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
2661
- * Prefer selecting a `format` rather than using this option.
2678
+ * If false, the `_id` will not be present in the API response
2662
2679
  */
2663
2680
  withComponentIDs: boolean;
2664
2681
  /**
@@ -2678,33 +2695,16 @@ interface components$o {
2678
2695
  withTotalCount: boolean;
2679
2696
  /** @description Performs keyword search on the entries */
2680
2697
  keyword: string;
2681
- /**
2682
- * @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
2683
- * skipOverridesResolution, withComponentIDs) overrides this alias.
2684
- * - `canonical`: PUT-safe structure — patterns and overrides left
2685
- * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
2686
- * (skipPatternResolution=true, skipOverridesResolution=true,
2687
- * withComponentIDs=true).
2688
- * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
2689
- * the expanded pattern nodes.
2690
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
2691
- * and component `_id`s removed.
2692
- */
2693
- format: "canonical" | "editor" | "delivery";
2694
2698
  /**
2695
2699
  * @description If true, any pattern references in the composition will be left unresolved.
2696
2700
  * This is appropriate if you intend to serialize the composition without patterns
2697
- * embedded into it, and serialize the pattern data separately.
2698
- * Default: true when `format` is canonical. False otherwise
2699
- * Prefer selecting a `format` rather than using this option.
2701
+ * embedded into it, and serialize the pattern data separately
2700
2702
  */
2701
2703
  skipPatternResolution: boolean;
2702
2704
  /**
2703
2705
  * @description If true, any pattern override data is not resolved by the API.
2704
2706
  * This is intended for internal use in the Canvas editor, and should not be used.
2705
- * Passing this parameter automatically implies withComponentIDs to be true.
2706
- * Default: true when `format` is canonical or editor. False otherwise.
2707
- * Prefer selecting a `format` rather than using this option.
2707
+ * Passing this parameter automatically implies withComponentIDs to be true
2708
2708
  */
2709
2709
  skipOverridesResolution: boolean;
2710
2710
  /**
@@ -2796,8 +2796,6 @@ interface paths$l {
2796
2796
  limit?: number;
2797
2797
  /** @description Limit the types of content type to return. If not specified, both block types and content types are returned */
2798
2798
  type?: "block" | "contentType";
2799
- /** @description Limit the response to the content types (or block types) matching these public IDs. */
2800
- contentTypeIDs?: string[];
2801
2799
  };
2802
2800
  header?: never;
2803
2801
  path?: never;
@@ -3204,9 +3202,7 @@ interface paths$k {
3204
3202
  withWorkflowDefinition?: components$m["parameters"]["withWorkflowDefinition"];
3205
3203
  /**
3206
3204
  * @description If true the `_id` unique identifier of blocks will be part of the response data.
3207
- * If false, the `_id` will not be present in the API response.
3208
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
3209
- * Prefer selecting a `format` rather than using this option.
3205
+ * If false, the `_id` will not be present in the API response
3210
3206
  */
3211
3207
  withComponentIDs?: components$m["parameters"]["withComponentIDs"];
3212
3208
  /** @description Performs keyword search on the entries */
@@ -3214,9 +3210,7 @@ interface paths$k {
3214
3210
  /**
3215
3211
  * @description If true, any pattern references in the composition will be left unresolved.
3216
3212
  * This is appropriate if you intend to serialize the composition without patterns
3217
- * embedded into it, and serialize the pattern data separately.
3218
- * Default: true when `format` is canonical. False otherwise
3219
- * Prefer selecting a `format` rather than using this option.
3213
+ * embedded into it, and serialize the pattern data separately
3220
3214
  */
3221
3215
  skipPatternResolution?: components$m["parameters"]["skipPatternResolution"];
3222
3216
  /**
@@ -3227,9 +3221,7 @@ interface paths$k {
3227
3221
  /**
3228
3222
  * @description If true, any pattern override data is not resolved by the API.
3229
3223
  * This is intended for internal use in the Canvas editor, and should not be used.
3230
- * Passing this parameter automatically implies withComponentIDs to be true.
3231
- * Default: true when `format` is canonical or editor. False otherwise.
3232
- * Prefer selecting a `format` rather than using this option.
3224
+ * Passing this parameter automatically implies withComponentIDs to be true
3233
3225
  */
3234
3226
  skipOverridesResolution?: components$m["parameters"]["skipOverridesResolution"];
3235
3227
  /**
@@ -3284,19 +3276,6 @@ interface paths$k {
3284
3276
  * If versionId is passed, this is always enabled.
3285
3277
  */
3286
3278
  editions?: components$m["parameters"]["editions"];
3287
- /**
3288
- * @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
3289
- * skipOverridesResolution, withComponentIDs) overrides this alias.
3290
- * - `canonical`: PUT-safe structure — patterns and overrides left
3291
- * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
3292
- * (skipPatternResolution=true, skipOverridesResolution=true,
3293
- * withComponentIDs=true).
3294
- * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
3295
- * the expanded pattern nodes.
3296
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
3297
- * and component `_id`s removed.
3298
- */
3299
- format?: components$m["parameters"]["format"];
3300
3279
  };
3301
3280
  header?: never;
3302
3281
  path?: never;
@@ -4208,9 +4187,7 @@ interface components$m {
4208
4187
  withWorkflowDefinition: boolean;
4209
4188
  /**
4210
4189
  * @description If true the `_id` unique identifier of blocks will be part of the response data.
4211
- * If false, the `_id` will not be present in the API response.
4212
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
4213
- * Prefer selecting a `format` rather than using this option.
4190
+ * If false, the `_id` will not be present in the API response
4214
4191
  */
4215
4192
  withComponentIDs: boolean;
4216
4193
  /** @description Performs keyword search on the entries */
@@ -4218,9 +4195,7 @@ interface components$m {
4218
4195
  /**
4219
4196
  * @description If true, any pattern references in the composition will be left unresolved.
4220
4197
  * This is appropriate if you intend to serialize the composition without patterns
4221
- * embedded into it, and serialize the pattern data separately.
4222
- * Default: true when `format` is canonical. False otherwise
4223
- * Prefer selecting a `format` rather than using this option.
4198
+ * embedded into it, and serialize the pattern data separately
4224
4199
  */
4225
4200
  skipPatternResolution: boolean;
4226
4201
  /**
@@ -4231,9 +4206,7 @@ interface components$m {
4231
4206
  /**
4232
4207
  * @description If true, any pattern override data is not resolved by the API.
4233
4208
  * This is intended for internal use in the Canvas editor, and should not be used.
4234
- * Passing this parameter automatically implies withComponentIDs to be true.
4235
- * Default: true when `format` is canonical or editor. False otherwise.
4236
- * Prefer selecting a `format` rather than using this option.
4209
+ * Passing this parameter automatically implies withComponentIDs to be true
4237
4210
  */
4238
4211
  skipOverridesResolution: boolean;
4239
4212
  /**
@@ -4288,19 +4261,6 @@ interface components$m {
4288
4261
  * If versionId is passed, this is always enabled.
4289
4262
  */
4290
4263
  editions: "auto" | "all" | "raw";
4291
- /**
4292
- * @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
4293
- * skipOverridesResolution, withComponentIDs) overrides this alias.
4294
- * - `canonical`: PUT-safe structure — patterns and overrides left
4295
- * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
4296
- * (skipPatternResolution=true, skipOverridesResolution=true,
4297
- * withComponentIDs=true).
4298
- * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
4299
- * the expanded pattern nodes.
4300
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
4301
- * and component `_id`s removed.
4302
- */
4303
- format: "canonical" | "editor" | "delivery";
4304
4264
  };
4305
4265
  requestBodies: never;
4306
4266
  headers: never;
@@ -4379,11 +4339,9 @@ interface components$l {
4379
4339
  versionId: string;
4380
4340
  /** @description The timestamp when the version was created in epoch milliseconds */
4381
4341
  timestamp: number;
4382
- /** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
4342
+ /** @description The name (full name) of the user who created the version */
4383
4343
  authorName: string;
4384
4344
  authorIsApiKey: boolean;
4385
- /** @description The identity who created the version; absent on old history entries. */
4386
- authorSubject?: string;
4387
4345
  /** @description The state of the entity when the history entry was made */
4388
4346
  state: number;
4389
4347
  };
@@ -6605,7 +6563,7 @@ interface components$e {
6605
6563
  withComponentIDs: boolean;
6606
6564
  /**
6607
6565
  * @deprecated
6608
- * @description Has no effect.
6566
+ * @description Includes content source map metadata on supported parameters
6609
6567
  */
6610
6568
  withContentSourceMap: boolean;
6611
6569
  /**
@@ -6775,9 +6733,7 @@ interface paths$c {
6775
6733
  /**
6776
6734
  * @description If true, any pattern references in the composition will be left unresolved.
6777
6735
  * This is appropriate if you intend to serialize the composition without patterns
6778
- * embedded into it, and serialize the pattern data separately.
6779
- * Default: true when `format` is canonical. False otherwise.
6780
- * Prefer selecting a `format` rather than using this option.
6736
+ * embedded into it, and serialize the pattern data separately
6781
6737
  */
6782
6738
  skipPatternResolution?: components$d["parameters"]["skipPatternResolution"];
6783
6739
  /**
@@ -6788,9 +6744,7 @@ interface paths$c {
6788
6744
  /**
6789
6745
  * @description If true, any pattern override data is not resolved by the API.
6790
6746
  * This is intended for internal use in the Canvas editor and should not be used.
6791
- * Passing this parameter automatically implies `withComponentIDs` is true.
6792
- * Default: true when `format` is canonical or editor. False otherwise.
6793
- * Prefer selecting a `format` rather than using this option.
6747
+ * Passing this parameter automatically implies `withComponentIDs` is true
6794
6748
  */
6795
6749
  skipOverridesResolution?: components$d["parameters"]["skipOverridesResolution"];
6796
6750
  /**
@@ -6830,9 +6784,7 @@ interface paths$c {
6830
6784
  updatedBy?: components$d["parameters"]["updatedBy"];
6831
6785
  /**
6832
6786
  * @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
6833
- * If false, the `_id` will not be present in the API response.
6834
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
6835
- * Prefer selecting a `format` rather than using this option.
6787
+ * If false, the `_id` will not be present in the API response
6836
6788
  */
6837
6789
  withComponentIDs?: components$d["parameters"]["withComponentIDs"];
6838
6790
  /**
@@ -6852,7 +6804,7 @@ interface paths$c {
6852
6804
  withProjectMapNodes?: components$d["parameters"]["withProjectMapNodes"];
6853
6805
  /**
6854
6806
  * @deprecated
6855
- * @description Has no effect.
6807
+ * @description Includes content source map metadata on supported parameters
6856
6808
  */
6857
6809
  withContentSourceMap?: components$d["parameters"]["withContentSourceMap"];
6858
6810
  /**
@@ -6909,19 +6861,6 @@ interface paths$c {
6909
6861
  * If versionId is passed, this is always enabled.
6910
6862
  */
6911
6863
  editions?: components$d["parameters"]["editions"];
6912
- /**
6913
- * @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
6914
- * skipOverridesResolution, withComponentIDs) overrides this alias.
6915
- * - `canonical`: PUT-safe structure — patterns and overrides left
6916
- * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
6917
- * (skipPatternResolution=true, skipOverridesResolution=true,
6918
- * withComponentIDs=true).
6919
- * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
6920
- * the expanded pattern nodes.
6921
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
6922
- * and component `_id`s removed.
6923
- */
6924
- format?: components$d["parameters"]["format"];
6925
6864
  };
6926
6865
  header?: never;
6927
6866
  path?: never;
@@ -7870,33 +7809,16 @@ interface components$d {
7870
7809
  * If calling the Canvas API directly with no enhancer proxy, this has no effect
7871
7810
  */
7872
7811
  skipEnhance: boolean;
7873
- /**
7874
- * @description Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
7875
- * skipOverridesResolution, withComponentIDs) overrides this alias.
7876
- * - `canonical`: PUT-safe structure — patterns and overrides left
7877
- * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
7878
- * (skipPatternResolution=true, skipOverridesResolution=true,
7879
- * withComponentIDs=true).
7880
- * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
7881
- * the expanded pattern nodes.
7882
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
7883
- * and component `_id`s removed.
7884
- */
7885
- format: "canonical" | "editor" | "delivery";
7886
7812
  /**
7887
7813
  * @description If true, any pattern references in the composition will be left unresolved.
7888
7814
  * This is appropriate if you intend to serialize the composition without patterns
7889
- * embedded into it, and serialize the pattern data separately.
7890
- * Default: true when `format` is canonical. False otherwise.
7891
- * Prefer selecting a `format` rather than using this option.
7815
+ * embedded into it, and serialize the pattern data separately
7892
7816
  */
7893
7817
  skipPatternResolution: boolean;
7894
7818
  /**
7895
7819
  * @description If true, any pattern override data is not resolved by the API.
7896
7820
  * This is intended for internal use in the Canvas editor and should not be used.
7897
- * Passing this parameter automatically implies `withComponentIDs` is true.
7898
- * Default: true when `format` is canonical or editor. False otherwise.
7899
- * Prefer selecting a `format` rather than using this option.
7821
+ * Passing this parameter automatically implies `withComponentIDs` is true
7900
7822
  */
7901
7823
  skipOverridesResolution: boolean;
7902
7824
  /**
@@ -7906,9 +7828,7 @@ interface components$d {
7906
7828
  skipParameterResolution: boolean;
7907
7829
  /**
7908
7830
  * @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
7909
- * If false, the `_id` will not be present in the API response.
7910
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
7911
- * Prefer selecting a `format` rather than using this option.
7831
+ * If false, the `_id` will not be present in the API response
7912
7832
  */
7913
7833
  withComponentIDs: boolean;
7914
7834
  /**
@@ -7974,7 +7894,7 @@ interface components$d {
7974
7894
  withProjectMapNodes: boolean;
7975
7895
  /**
7976
7896
  * @deprecated
7977
- * @description Has no effect.
7897
+ * @description Includes content source map metadata on supported parameters
7978
7898
  */
7979
7899
  withContentSourceMap: boolean;
7980
7900
  /**
@@ -8121,11 +8041,9 @@ interface components$c {
8121
8041
  versionId: string;
8122
8042
  /** @description The timestamp when the version was created in epoch milliseconds */
8123
8043
  timestamp: number;
8124
- /** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
8044
+ /** @description The name (full name) of the user who created the version */
8125
8045
  authorName: string;
8126
8046
  authorIsApiKey: boolean;
8127
- /** @description The identity who created the version; absent on old history entries. */
8128
- authorSubject?: string;
8129
8047
  /** @description The state of the entity when the history entry was made */
8130
8048
  state: number;
8131
8049
  };
@@ -9313,9 +9231,7 @@ interface components$b {
9313
9231
  /**
9314
9232
  * @description If true, any pattern references in the composition will be left unresolved.
9315
9233
  * This is appropriate if you intend to serialize the composition without patterns
9316
- * embedded into it, and serialize the pattern data separately.
9317
- * Default: true when `format` is canonical. False otherwise.
9318
- * Prefer selecting a `format` rather than using this option.
9234
+ * embedded into it, and serialize the pattern data separately
9319
9235
  */
9320
9236
  skipPatternResolution: boolean;
9321
9237
  /**
@@ -9347,9 +9263,7 @@ interface components$b {
9347
9263
  updatedBy: string;
9348
9264
  /**
9349
9265
  * @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
9350
- * If false, the `_id` will not be present in the API response.
9351
- * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
9352
- * Prefer selecting a `format` rather than using this option.
9266
+ * If false, the `_id` will not be present in the API response
9353
9267
  */
9354
9268
  withComponentIDs: boolean;
9355
9269
  /**
@@ -9365,7 +9279,7 @@ interface components$b {
9365
9279
  withUIStatus: boolean;
9366
9280
  /**
9367
9281
  * @deprecated
9368
- * @description Has no effect.
9282
+ * @description Includes content source map metadata on supported parameters
9369
9283
  */
9370
9284
  withContentSourceMap: boolean;
9371
9285
  /**
@@ -9572,7 +9486,7 @@ interface paths$a {
9572
9486
  withComponentIDs?: components$a["parameters"]["withComponentIDs"];
9573
9487
  /**
9574
9488
  * @deprecated
9575
- * @description Has no effect.
9489
+ * @description Includes content source map metadata on supported parameters
9576
9490
  */
9577
9491
  withContentSourceMap?: components$a["parameters"]["withContentSourceMap"];
9578
9492
  /**
@@ -10419,7 +10333,7 @@ interface components$a {
10419
10333
  withComponentIDs: boolean;
10420
10334
  /**
10421
10335
  * @deprecated
10422
- * @description Has no effect.
10336
+ * @description Includes content source map metadata on supported parameters
10423
10337
  */
10424
10338
  withContentSourceMap: boolean;
10425
10339
  /**
@@ -10744,33 +10658,6 @@ type RouteGetResponseEdgehancedNotFound = RouteGetResponseNotFound & {
10744
10658
  compositionApiResponse?: Pick<CompositionResolvedGetResponse, 'errors' | 'warnings' | 'infos' | 'diagnostics' | 'wholeResponseCacheDiagnostics'>;
10745
10659
  };
10746
10660
 
10747
- /**
10748
- * Constructor options for the delivery (edge) clients. Adds the edge-only fields
10749
- * to the shared client options.
10750
- */
10751
- type DeliveryClientOptions = ClientOptions & {
10752
- /** Host used for delivery (edge) reads. Defaults to `https://uniform.global`. */
10753
- edgeApiHost?: string;
10754
- /**
10755
- * When true, skips stale-while-revalidate behavior on data resource caches
10756
- * May result in increased latency for requests that refetch expired data resources,
10757
- * but is useful if you are caching responses outside of Uniform and require consistency.
10758
- */
10759
- disableSWR?: boolean;
10760
- };
10761
- /**
10762
- * Internal base for the read-only delivery clients: adds edge-host selection,
10763
- * the SWR header, and diagnostics coercion. Defaults `bypassCache` to false.
10764
- * Not exported from the package surface.
10765
- */
10766
- declare abstract class DeliveryClientBase extends ContentClientBase {
10767
- protected readonly edgeApiHost: string;
10768
- protected readonly edgeRequestInit?: RequestInit;
10769
- protected constructor(options: DeliveryClientOptions);
10770
- /** Coerces the `diagnostics` option into the shape the edge endpoints accept. */
10771
- protected coerceDiagnostics(diagnostics?: boolean | 'no-data'): boolean | 'no-data' | undefined;
10772
- }
10773
-
10774
10661
  type PreviewPanelSettings = {
10775
10662
  isVisualEditingDisabled?: boolean;
10776
10663
  };
@@ -12783,340 +12670,13 @@ type WorkflowsPutParameters = WorkflowsApi['put']['requestBody']['content']['app
12783
12670
  /** Shape of the DELETE request body for /api/v1/workflows */
12784
12671
  type WorkflowsDeleteParameters = WorkflowsApi['delete']['requestBody']['content']['application/json'];
12785
12672
 
12786
- /**
12787
- * Data projection wire grammar (`select.*` query parameters) and shared spec
12788
- * type used by every consumer of projections: API serializers (SDK clients),
12789
- * the origin pruner (lib/canvas-sdk applyProjection), and localize (for the
12790
- * representation-modifier operator `fields[locales]`).
12791
- *
12792
- * Wire grammar (mirrors `filters.*`):
12793
- *
12794
- * select.fields[only]=name,seo_*
12795
- * select.fields[except]=internalNote
12796
- * select.fields[only]= // strip every field
12797
- * select.fields[except]=* // strip every field (wildcard form)
12798
- * select.fields[locales]=slug,seo_*
12799
- * select.fieldTypes[only]=text,number
12800
- * select.fieldTypes[except]=richText
12801
- * select.slots[only]=hero
12802
- * select.slots[except]=footer
12803
- * select.slots[depth]=2
12804
- * select.slots.<name>[depth]=1
12805
- */
12806
- /**
12807
- * Prefix used by every `select.*` query parameter on the wire. Exported so
12808
- * downstream prefix scans (lambda validator, edge search-param reader,
12809
- * origin handler short-circuits) and key builders don't hand-roll the
12810
- * literal at every call site.
12811
- */
12812
- declare const SELECT_QUERY_PREFIX = "select.";
12813
- type FieldsProjection = {
12814
- /** Include only fields whose name matches one of these patterns. */
12815
- only?: string[];
12816
- /** Exclude fields whose name matches one of these patterns. */
12817
- except?: string[];
12818
- /**
12819
- * Field-name patterns whose value should retain its full per-locale map
12820
- * (`locales` / `localesConditions`) after `localize` runs. Representation
12821
- * modifier; the pruner ignores this — see lib/canvas-sdk applyProjection.
12822
- */
12823
- locales?: string[];
12824
- };
12825
- type FieldTypesProjection = {
12826
- /** Include only fields whose `type` matches one of these patterns. */
12827
- only?: string[];
12828
- /** Exclude fields whose `type` matches one of these patterns. */
12829
- except?: string[];
12830
- };
12831
- type SlotsProjection = {
12832
- /** Include only slots whose name matches one of these patterns. */
12833
- only?: string[];
12834
- /** Exclude slots whose name matches one of these patterns. */
12835
- except?: string[];
12836
- /**
12837
- * Container-wide recursion-depth cap counted in slot levels from the root.
12838
- * 0 means "no slots at all on the root"; 1 means "root's own slots but no
12839
- * grandchildren slots". Per-name depth (see `named`) overrides this for
12840
- * its specific slot.
12841
- */
12842
- depth?: number;
12843
- /** Per-slot depth caps. Keyed by slot name. */
12844
- named?: {
12845
- [slotName: string]: {
12846
- depth?: number;
12847
- };
12848
- };
12849
- };
12850
- type ProjectionSpec = {
12851
- fields?: FieldsProjection;
12852
- fieldTypes?: FieldTypesProjection;
12853
- slots?: SlotsProjection;
12854
- };
12855
-
12856
- /**
12857
- * Optional data projection, shared by delivery + management `get`/`list` for
12858
- * entries and compositions. Serialized to `select.*` querystring parameters
12859
- * (mirroring `filters.*`) via `projectionToQuery`; the API prunes the response
12860
- * tree before any downstream processing (dynamic params, localize, edge-side
12861
- * data fetches). See {@link ProjectionSpec}.
12862
- */
12863
- type Projection = {
12864
- select?: ProjectionSpec;
12865
- };
12866
- /** Lookup keys hoisted into the composition selector unions (so they are not
12867
- * also accepted in the free-form read-options bag). */
12868
- type CompositionSelectorKey = 'compositionId' | 'editionId' | 'versionId' | 'slug' | 'projectMapNodeId' | 'projectMapNodePath' | 'projectMapId' | 'componentId';
12869
- /** Params retired from the new client surface (still accepted by the endpoint). */
12870
- type CompositionRetiredKey = 'withContentSourceMap' | 'skipEnhance' | 'withWorkflowDefinition';
12871
- /** `format` is client-owned: management reads use the `'canonical' | 'editor'`
12872
- * alias (see {@link ManagementFormat}); delivery reads don't send it. */
12873
- type CompositionClientOwnedKey = 'format';
12874
- /**
12875
- * Options shared by composition `get` and `list`, derived from the generated
12876
- * `/api/v1/canvas` query type. Client-owned keys are removed: `projectId` is
12877
- * supplied by the client, `editions` is derived per persona, and the selector
12878
- * lookup keys are hoisted into the selector unions. `state` and the shaping
12879
- * flags ride along as optional per-call overrides.
12880
- */
12881
- type CompositionReadOptions = Omit<CompositionGetParameters, 'projectId' | 'editions' | CompositionSelectorKey | CompositionRetiredKey | CompositionClientOwnedKey> & Projection;
12882
- /** Edition resolution for composition list reads (lists take no `editionId`). */
12883
- type ListEditions = {
12884
- editions?: 'auto' | 'all' | 'raw';
12885
- };
12886
- /** Composition `list` query (shared by delivery + management). */
12887
- type CompositionListQuery = CompositionReadOptions & ListEditions & {
12888
- /** Structured filters serialized to `filters.*` on the wire. */
12889
- filters?: CompositionFilters;
12890
- };
12891
- /** Delivery reads expose the data-resolution knobs (depth/variant/diagnostics). */
12892
- type CompositionDeliveryReadOptions = CompositionReadOptions & DataResolutionParameters;
12893
- type CompositionDeliveryListQuery = CompositionListQuery & DataResolutionParameters;
12894
- /**
12895
- * Read shape for the management clients, selected via the public `format` alias:
12896
- * - `canonical` (default) — compact PUT-safe shape;
12897
- * - `editor` — canonical with patterns expanded for display (still PUT-safe).
12898
- * The individual shaping flags still ride along and override the preset.
12899
- */
12900
- type ManagementFormat = {
12901
- format?: 'canonical' | 'editor';
12902
- };
12903
- /**
12904
- * Optional edition-mode override for management single-`get`. By default a bare
12905
- * id reads `raw` and a locale-scoped read resolves editions (`auto`); set this
12906
- * to force one mode (see {@link resolveManagementEditions}).
12907
- */
12908
- type ManagementEditionsOverride = {
12909
- editions?: 'raw' | 'auto';
12910
- };
12911
- type CompositionManagementReadOptions = CompositionReadOptions & ManagementFormat & ManagementEditionsOverride;
12912
- type CompositionManagementListQuery = CompositionListQuery & ManagementFormat;
12913
- type CompositionIdSelector = {
12914
- compositionId: string;
12915
- editionId?: string;
12916
- versionId?: string;
12917
- };
12918
- type CompositionSlugSelector = {
12919
- slug: string;
12920
- };
12921
- type CompositionNodeIdSelector = {
12922
- projectMapNodeId: string;
12923
- projectMapId?: string;
12924
- };
12925
- type CompositionNodePathSelector = {
12926
- projectMapNodePath: string;
12927
- projectMapId?: string;
12928
- };
12929
- /** Reads a component definition's stored `defaults` tree as a synthetic draft
12930
- * composition (management-only; `state` is ignored server-side). */
12931
- type CompositionDefaultsSelector = {
12932
- componentId: string;
12933
- };
12934
- /** Single-composition selector for the delivery client. */
12935
- type CompositionDeliverySelector = CompositionIdSelector | CompositionSlugSelector | CompositionNodeIdSelector | CompositionNodePathSelector;
12936
- /** Single-composition selector for the management client (adds the defaults selector). */
12937
- type CompositionManagementSelector = CompositionDeliverySelector | CompositionDefaultsSelector;
12938
- /** Selector for write/delete operations that target a specific edition group. */
12939
- type CompositionWriteSelector = Omit<ExceptProject<CompositionDeleteParameters>, 'state'>;
12940
- type EntrySelectorKey = 'entryIDs' | 'slug' | 'versionId';
12941
- type EntryRetiredKey = 'withWorkflowDefinition';
12942
- /** See {@link CompositionClientOwnedKey} — `format` is replaced by {@link ManagementFormat}. */
12943
- type EntryClientOwnedKey = 'format';
12944
- /**
12945
- * Options shared by entry `get` and `list`, derived from the generated
12946
- * `/api/v1/entries` query type, with the same client-owned removals as
12947
- * compositions (see {@link CompositionReadOptions}).
12948
- */
12949
- type EntryReadOptions = Omit<GetEntriesOptions, 'projectId' | 'editions' | EntrySelectorKey | EntryRetiredKey | EntryClientOwnedKey> & Projection;
12950
- /** Entry `list` query (shared by delivery + management). */
12951
- type EntryListQuery = EntryReadOptions & ListEditions & {
12952
- /** Fetch specific entries (or, with `editions: 'raw'`, specific editions) by id. */
12953
- entryIDs?: string[];
12954
- /** Filter the list to the entry matching this slug (returns 0 or 1 rows). */
12955
- slug?: string;
12956
- /** Structured filters serialized to `filters.*` on the wire. */
12957
- filters?: EntryFilters;
12958
- };
12959
- type EntryDeliveryReadOptions = EntryReadOptions & DataResolutionParameters;
12960
- type EntryDeliveryListQuery = EntryListQuery & DataResolutionParameters;
12961
- type EntryManagementReadOptions = EntryReadOptions & ManagementFormat & ManagementEditionsOverride;
12962
- type EntryManagementListQuery = EntryListQuery & ManagementFormat;
12963
- /** Single-entry selector. */
12964
- type EntrySelector = {
12965
- entryId: string;
12966
- editionId?: string;
12967
- versionId?: string;
12968
- } | {
12969
- slug: string;
12970
- };
12971
- /** Selector for entry write/delete operations targeting a specific edition group. */
12972
- type EntryWriteSelector = Omit<ExceptProject<DeleteEntryOptions>, 'state'>;
12973
- /** Optimistic-concurrency option for save / saveAndPublish. */
12974
- type SaveOptions = {
12975
- /**
12976
- * If provided, sends `x-if-unmodified-since`; the server rejects the write
12977
- * (409) when the target row changed since this timestamp.
12978
- */
12979
- ifUnmodifiedSince?: string;
12980
- };
12981
- /** Result of a write: the new modification timestamp (from `x-modified-at`), or null. */
12982
- type SaveResult = {
12983
- modified: string | null;
12673
+ type CanvasClientOptions = ClientOptions & {
12674
+ edgeApiHost?: string;
12675
+ disableSWR?: boolean;
12984
12676
  };
12985
-
12986
- /**
12987
- * Read-only delivery client for compositions. Hits the edge host with patterns
12988
- * + overrides + data resources resolved and component `_id`s stripped — the
12989
- * shape sites/edge serve. Defaults `state` to published and `bypassCache` to
12990
- * false (cached). It has no write methods by design: you cannot read a
12991
- * delivery-shaped tree and PUT it back through this client.
12992
- */
12993
- declare class CompositionDeliveryClient extends DeliveryClientBase {
12994
- constructor(options: DeliveryClientOptions);
12995
- /** Fetches exactly one composition (throws `ApiClientError(404)` if absent). */
12996
- get(args: CompositionDeliverySelector & CompositionDeliveryReadOptions): Promise<CompositionResolvedGetResponse>;
12997
- /** Fetches a list of compositions, optionally filtered. */
12998
- list(args?: CompositionDeliveryListQuery): Promise<CompositionResolvedListResponse>;
12999
- }
13000
-
13001
- /**
13002
- * Full-CRUD management client for compositions. Reads the canonical (PUT-safe)
13003
- * shape from the origin host and defaults `state` to draft and `bypassCache` to
13004
- * true. Pass `format: 'editor'` per call for the editor read shape (patterns
13005
- * expanded, still PUT-safe).
13006
- */
13007
- declare class CompositionManagementClient extends ContentClientBase {
13008
- constructor(options: ClientOptions);
13009
- /**
13010
- * Fetches one composition in canonical shape (throws `ApiClientError(404)` if
13011
- * absent).
13012
- */
13013
- get(args: CompositionManagementSelector & CompositionManagementReadOptions): Promise<CompositionGetResponse>;
13014
- /** Fetches a list of compositions in canonical shape. */
13015
- list(args?: CompositionManagementListQuery): Promise<CompositionGetListResponse>;
13016
- /** Creates or updates a composition. Returns the new `x-modified-at` timestamp. */
13017
- save(body: ExceptProject<CompositionPutParameters>, opts?: SaveOptions): Promise<SaveResult>;
13018
- /**
13019
- * Saves the draft and publishes in one call (two PUTs). The optimistic
13020
- * concurrency guard, if any, applies to the draft write.
13021
- */
13022
- saveAndPublish(body: ExceptProject<Omit<CompositionPutParameters, 'state'>>, opts?: SaveOptions): Promise<SaveResult>;
13023
- /**
13024
- * Removes only the published state, leaving the draft intact. Scoped to a
13025
- * single edition when `editionId` is supplied; otherwise unpublishes all editions.
13026
- * To unpublish only the base edition, pass editionId and compositionId as the same value.
13027
- */
13028
- unpublish(selector: CompositionWriteSelector): Promise<void>;
13029
- /**
13030
- * Deletes across all states. Scoped to a single edition when `editionId` is
13031
- * supplied; otherwise deletes all states and editions.
13032
- * Use `unpublish` to drop only the published state.
13033
- */
13034
- remove(selector: CompositionWriteSelector): Promise<void>;
13035
- /** Fetches historical versions of a composition or pattern. */
13036
- history(args: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<ComponentInstanceHistoryGetResponse>;
13037
- private deleteComposition;
13038
- }
13039
-
13040
- /**
13041
- * Management client for content types.
13042
- */
13043
- declare class ContentTypeClient extends ContentClientBase {
13044
- constructor(options: ClientOptions);
13045
- /** Fetches one content type by id (throws `ApiClientError(404)` if absent). */
13046
- get(args: {
13047
- contentTypeId: string;
13048
- }): Promise<ContentType>;
13049
- /** Fetches a list of content types. */
13050
- list(args?: ExceptProject<GetContentTypesOptions>): Promise<GetContentTypesResponse>;
13051
- /** Creates or updates a content type. */
13052
- save(body: ExceptProject<PutContentTypeBody>, opts?: {
13053
- autogenerateDataTypes?: boolean;
13054
- }): Promise<void>;
13055
- /** Deletes a content type. */
13056
- remove(args: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
13057
- }
13058
-
13059
- /**
13060
- * Read-only delivery client for entries. Hits the edge host with data resources
13061
- * resolved and component `_id`s stripped. Defaults `state` to published and
13062
- * `bypassCache` to false (cached). No write methods by design.
13063
- */
13064
- declare class EntryDeliveryClient extends DeliveryClientBase {
13065
- constructor(options: DeliveryClientOptions);
13066
- /** Fetches exactly one entry by id or slug (throws `ApiClientError(404)` if absent). */
13067
- get(args: EntrySelector & EntryDeliveryReadOptions): Promise<Entry>;
13068
- /** Fetches a list of entries, optionally filtered. */
13069
- list(args?: EntryDeliveryListQuery): Promise<GetEntriesResponse>;
13070
- }
13071
-
13072
- /**
13073
- * Full-CRUD management client for entries. Reads the canonical (PUT-safe) shape
13074
- * from the origin host and defaults `state` to draft and `bypassCache` to true.
13075
- */
13076
- declare class EntryManagementClient extends ContentClientBase {
13077
- constructor(options: ClientOptions);
13078
- /**
13079
- * Fetches one entry by id or slug in canonical shape (throws
13080
- * `ApiClientError(404)` if absent).
13081
- */
13082
- get(args: EntrySelector & EntryManagementReadOptions): Promise<Entry>;
13083
- /** Fetches a list of entries in canonical shape. */
13084
- list(args?: EntryManagementListQuery): Promise<GetEntriesResponse>;
13085
- /** Creates or updates an entry. Returns the new `x-modified-at` timestamp. */
13086
- save(body: ExceptProject<PutEntryBody>, opts?: SaveOptions): Promise<SaveResult>;
13087
- /** Saves the draft and publishes in one call (two PUTs). */
13088
- saveAndPublish(body: ExceptProject<Omit<PutEntryBody, 'state'>>, opts?: SaveOptions): Promise<SaveResult>;
13089
- /**
13090
- * Removes only the published state, leaving the draft intact. Scoped to a
13091
- * single edition when `editionId` is supplied; otherwise unpublishes all editions.
13092
- * To unpublish only the base edition, pass editionId and entryId as the same value.
13093
- */
13094
- unpublish(selector: EntryWriteSelector): Promise<void>;
13095
- /**
13096
- * Deletes across all states. Scoped to a single edition when `editionId` is
13097
- * supplied; otherwise deletes all states and editions.
13098
- * Use `unpublish` to drop only the published state.
13099
- */
13100
- remove(selector: EntryWriteSelector): Promise<void>;
13101
- /** Fetches historical versions of an entry. */
13102
- history(args: ExceptProject<EntriesHistoryGetParameters>): Promise<EntriesHistoryGetResponse>;
13103
- private deleteEntry;
13104
- }
13105
-
13106
- type CanvasClientOptions = DeliveryClientOptions;
13107
12677
  type UpdateCompositionOptions = {
13108
12678
  ifUnmodifiedSince?: string;
13109
12679
  };
13110
- /**
13111
- * @deprecated Use the persona-shaped clients instead:
13112
- * - {@link CompositionDeliveryClient} for read-only delivery (resolved) reads,
13113
- * - {@link CompositionManagementClient} for canonical (PUT-safe) read/write,
13114
- * - {@link ComponentDefinitionClient} for component definitions.
13115
- *
13116
- * The mode (delivery vs management) is now the client class rather than the
13117
- * `skipDataResolution` flag, which makes the "read resolved → write back →
13118
- * corrupt" failure unrepresentable.
13119
- */
13120
12680
  declare class CanvasClient extends ApiClient<CanvasClientOptions> {
13121
12681
  private edgeApiHost;
13122
12682
  private edgeApiRequestInit?;
@@ -13172,31 +12732,39 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
13172
12732
  removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
13173
12733
  /** Fetches all Canvas component definitions */
13174
12734
  getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
13175
- componentDefinitions: components$p["schemas"]["ComponentDefinition"][];
12735
+ componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
13176
12736
  }>;
13177
12737
  /** Updates or creates a Canvas component definition */
13178
12738
  updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
13179
12739
  /** Deletes a Canvas component definition */
13180
12740
  removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
13181
12741
  }
13182
- /**
13183
- * @deprecated Use {@link CompositionManagementClient} (which defaults
13184
- * `bypassCache: true`), or pass `bypassCache: true` to a delivery client.
13185
- */
13186
12742
  declare class UncachedCanvasClient extends CanvasClient {
13187
12743
  constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
13188
12744
  }
13189
12745
 
12746
+ declare class CategoryClient extends ApiClient {
12747
+ constructor(options: ClientOptions);
12748
+ /** Fetches all categories created in given project */
12749
+ getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
12750
+ categories: components$p["schemas"]["Category"][];
12751
+ }>;
12752
+ /** Updates or creates a category, also used to re-order them */
12753
+ upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
12754
+ /** Deletes a category */
12755
+ removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
12756
+ }
12757
+ declare class UncachedCategoryClient extends CategoryClient {
12758
+ constructor(options: Omit<ClientOptions, 'bypassCache'>);
12759
+ }
12760
+
13190
12761
  type UpsertEntryOptions = {
13191
12762
  ifUnmodifiedSince?: string;
13192
12763
  };
13193
- type ContentClientOptions = DeliveryClientOptions;
13194
- /**
13195
- * @deprecated Use the persona-shaped clients instead:
13196
- * - {@link EntryDeliveryClient} for read-only delivery (resolved) reads,
13197
- * - {@link EntryManagementClient} for canonical (PUT-safe) read/write,
13198
- * - {@link ContentTypeClient} for content types.
13199
- */
12764
+ type ContentClientOptions = ClientOptions & {
12765
+ edgeApiHost?: string;
12766
+ disableSWR?: boolean;
12767
+ };
13200
12768
  declare class ContentClient extends ApiClient<ContentClientOptions> {
13201
12769
  #private;
13202
12770
  private edgeApiHost;
@@ -13226,10 +12794,6 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
13226
12794
  deleteEntry(body: ExceptProject<DeleteEntryOptions>): Promise<void>;
13227
12795
  private getEdgeOptions;
13228
12796
  }
13229
- /**
13230
- * @deprecated Use {@link EntryManagementClient} (which defaults
13231
- * `bypassCache: true`), or pass `bypassCache: true` to a delivery client.
13232
- */
13233
12797
  declare class UncachedContentClient extends ContentClient {
13234
12798
  constructor(options: Omit<ContentClientOptions, 'bypassCache'>);
13235
12799
  }
@@ -13237,21 +12801,15 @@ declare class UncachedContentClient extends ContentClient {
13237
12801
  /** API client to make comms with the Next Gen Mesh Data Source API simpler */
13238
12802
  declare class DataSourceClient extends ApiClient {
13239
12803
  constructor(options: ClientOptions);
13240
- /** Fetches a single DataSource by id (with decrypted secrets). */
12804
+ /** Fetches all DataSources for a project */
13241
12805
  get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
13242
12806
  result: components$k["schemas"]["DataSource"];
13243
12807
  }>;
13244
- /** Fetches the list of DataSources for a project (secrets masked). */
13245
- list(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
13246
- results: components$j["schemas"]["DataSource"][];
13247
- }>;
13248
- /** @deprecated Use {@link list} instead. */
12808
+ /** Fetches all DataSources for a project */
13249
12809
  getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
13250
12810
  results: components$j["schemas"]["DataSource"][];
13251
12811
  }>;
13252
12812
  /** Updates or creates (based on id) a DataSource */
13253
- save(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
13254
- /** @deprecated Use {@link save} instead. */
13255
12813
  upsert(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
13256
12814
  /** Deletes a DataSource */
13257
12815
  remove(body: ExceptProject<DataSourceDeleteParameters>): Promise<void>;
@@ -13261,13 +12819,9 @@ declare class DataSourceClient extends ApiClient {
13261
12819
  declare class DataTypeClient extends ApiClient {
13262
12820
  #private;
13263
12821
  constructor(options: ClientOptions);
13264
- /** Fetches a list of DataTypes for a project */
13265
- list(options?: ExceptProject<DataTypeGetParameters>): Promise<DataTypeGetResponse>;
13266
- /** @deprecated Use {@link list} instead. */
12822
+ /** Fetches all DataTypes for a project */
13267
12823
  get(options?: ExceptProject<DataTypeGetParameters>): Promise<DataTypeGetResponse>;
13268
12824
  /** Updates or creates (based on id) a DataType */
13269
- save(body: ExceptProject<DataTypePutParameters>): Promise<void>;
13270
- /** @deprecated Use {@link save} instead. */
13271
12825
  upsert(body: ExceptProject<DataTypePutParameters>): Promise<void>;
13272
12826
  /** Deletes a DataType */
13273
12827
  remove(body: ExceptProject<DataTypeDeleteParameters>): Promise<void>;
@@ -13533,8 +13087,8 @@ declare function findParameterInNodeTree(data: ComponentInstance | EntryData | A
13533
13087
 
13534
13088
  /** Returns the JSON pointer of a component based on its location */
13535
13089
  declare function getComponentJsonPointer(ancestorsAndSelf: Array<NodeLocationReference>): string;
13536
- declare function getNounForLocation(parentLocation: NodeLocationReference | undefined): "parameters" | "fields";
13537
- declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "parameters" | "fields";
13090
+ declare function getNounForLocation(parentLocation: NodeLocationReference | undefined): "fields" | "parameters";
13091
+ declare function getNounForNode(node: ComponentInstance | EntryData | Array<NodeLocationReference>): "fields" | "parameters";
13538
13092
 
13539
13093
  declare function getComponentPath(ancestorsAndSelf: Array<NodeLocationReference>): string;
13540
13094
 
@@ -13797,11 +13351,6 @@ declare function walkPropertyValues(property: ComponentParameter, visitor: (opti
13797
13351
  declare class EntityReleasesClient extends ApiClient {
13798
13352
  constructor(options: ClientOptions);
13799
13353
  /** Fetches entity across all releases (and base) */
13800
- list(options?: ExceptProject<EntityReleasesGetParameters>): Promise<{
13801
- results: components$6["schemas"]["EntityInRelease"][];
13802
- totalCount: number;
13803
- }>;
13804
- /** @deprecated Use {@link list} instead. */
13805
13354
  get(options?: ExceptProject<EntityReleasesGetParameters>): Promise<{
13806
13355
  results: components$6["schemas"]["EntityInRelease"][];
13807
13356
  totalCount: number;
@@ -13831,27 +13380,7 @@ declare class IntegrationPropertyEditorsClient extends ApiClient<IntegrationProp
13831
13380
  }
13832
13381
 
13833
13382
  declare class LabelClient extends ApiClient {
13834
- /** Fetches a list of labels for the current project. */
13835
- list(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
13836
- labels: {
13837
- projectId: string;
13838
- label: {
13839
- publicId: string;
13840
- displayName: string;
13841
- isGroup: boolean;
13842
- parent?: string;
13843
- color: string;
13844
- description?: string;
13845
- scope: string[];
13846
- };
13847
- created: string;
13848
- modified: string;
13849
- createdBy?: string;
13850
- modifiedBy?: string;
13851
- }[];
13852
- totalCount: number;
13853
- }>;
13854
- /** @deprecated Use {@link list} instead. */
13383
+ /** Fetches labels for the current project. */
13855
13384
  getLabels(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
13856
13385
  labels: {
13857
13386
  projectId: string;
@@ -13872,15 +13401,10 @@ declare class LabelClient extends ApiClient {
13872
13401
  totalCount: number;
13873
13402
  }>;
13874
13403
  /** Updates or creates a label. */
13875
- save(body: Omit<LabelPut, 'projectId'>): Promise<void>;
13876
- /** @deprecated Use {@link save} instead. */
13877
13404
  upsertLabel(body: Omit<LabelPut, 'projectId'>): Promise<void>;
13878
13405
  /** Deletes a label by id. */
13879
- remove(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
13880
- /** @deprecated Use {@link remove} instead. */
13881
13406
  removeLabel(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
13882
13407
  }
13883
- /** @deprecated Pass `bypassCache: true` to {@link LabelClient} instead. */
13884
13408
  declare class UncachedLabelClient extends LabelClient {
13885
13409
  constructor(options: Omit<ClientOptions, 'bypassCache'>);
13886
13410
  }
@@ -13888,17 +13412,11 @@ declare class UncachedLabelClient extends LabelClient {
13888
13412
  /** API client to enable managing project locales */
13889
13413
  declare class LocaleClient extends ApiClient {
13890
13414
  constructor(options: ClientOptions);
13891
- /** Fetches a list of locales for a project */
13892
- list(options?: ExceptProject<LocalesGetParameters>): Promise<{
13893
- results: components$f["schemas"]["Locale"][];
13894
- }>;
13895
- /** @deprecated Use {@link list} instead. */
13415
+ /** Fetches all locales for a project */
13896
13416
  get(options?: ExceptProject<LocalesGetParameters>): Promise<{
13897
13417
  results: components$f["schemas"]["Locale"][];
13898
13418
  }>;
13899
13419
  /** Updates or creates (based on id) a locale */
13900
- save(body: ExceptProject<LocalePutParameters>): Promise<void>;
13901
- /** @deprecated Use {@link save} instead. */
13902
13420
  upsert(body: ExceptProject<LocalePutParameters>): Promise<void>;
13903
13421
  /** Deletes a locale */
13904
13422
  remove(body: ExceptProject<LocaleDeleteParameters>): Promise<void>;
@@ -14694,16 +14212,10 @@ declare class ProjectClient extends ApiClient {
14694
14212
  * When teamId is provided, returns a single team with its projects.
14695
14213
  * When omitted, returns all accessible teams and their projects.
14696
14214
  */
14697
- list(options?: ProjectsGetParameters): Promise<ProjectsGetResponse>;
14698
- /** @deprecated Use {@link list} instead. */
14699
14215
  getProjects(options?: ProjectsGetParameters): Promise<ProjectsGetResponse>;
14700
14216
  /** Updates or creates (based on id) a Project */
14701
- save(body: ExceptProject<ProjectPutParameters>): Promise<ProjectPutResponse>;
14702
- /** @deprecated Use {@link save} instead. */
14703
14217
  upsert(body: ExceptProject<ProjectPutParameters>): Promise<ProjectPutResponse>;
14704
14218
  /** Deletes a Project */
14705
- remove(body: ExceptProject<ProjectDeleteParameters>): Promise<void>;
14706
- /** @deprecated Use {@link remove} instead. */
14707
14219
  delete(body: ExceptProject<ProjectDeleteParameters>): Promise<void>;
14708
14220
  }
14709
14221
 
@@ -14771,11 +14283,7 @@ declare function projectionToQuery(spec: ProjectionSpec | undefined): Record<str
14771
14283
  */
14772
14284
  declare function queryToProjection(source: URLSearchParams | Record<string, unknown> | null | undefined): ProjectionSpec | undefined;
14773
14285
 
14774
- /**
14775
- * API client for the Prompts API.
14776
- *
14777
- * @deprecated This client is deprecated and will be removed in a future release.
14778
- */
14286
+ /** API client to make comms with the Next Gen Mesh Data Source API simpler */
14779
14287
  declare class PromptClient extends ApiClient {
14780
14288
  constructor(options: ClientOptions);
14781
14289
  /** Fetches Prompts for a project */
@@ -14958,27 +14466,18 @@ declare class RelationshipClient extends ApiClient<ClientOptions & {
14958
14466
  constructor(options: ClientOptions & {
14959
14467
  projectId: string;
14960
14468
  });
14961
- list: (options: ExceptProject<RelationshipsGetParameters>) => Promise<RelationshipsGetResponse>;
14962
- /** @deprecated Use {@link list} instead. */
14963
14469
  get: (options: ExceptProject<RelationshipsGetParameters>) => Promise<RelationshipsGetResponse>;
14964
14470
  }
14965
14471
 
14966
14472
  /** API client to enable managing project releases */
14967
14473
  declare class ReleaseClient extends ApiClient {
14968
14474
  constructor(options: ClientOptions);
14969
- /** Fetches a list of releases for a project */
14970
- list(options?: ExceptProject<ReleasesGetParameters>): Promise<{
14971
- results: components$4["schemas"]["Release"][];
14972
- totalCount: number;
14973
- }>;
14974
- /** @deprecated Use {@link list} instead. */
14475
+ /** Fetches all releases for a project */
14975
14476
  get(options?: ExceptProject<ReleasesGetParameters>): Promise<{
14976
14477
  results: components$4["schemas"]["Release"][];
14977
14478
  totalCount: number;
14978
14479
  }>;
14979
14480
  /** Updates or creates (based on id) a release */
14980
- save(body: ExceptProject<ReleasePutParameters>): Promise<void>;
14981
- /** @deprecated Use {@link save} instead. */
14982
14481
  upsert(body: ExceptProject<ReleasePutParameters>): Promise<void>;
14983
14482
  /** Deletes a release */
14984
14483
  remove(body: ExceptProject<ReleaseDeleteParameters>): Promise<void>;
@@ -14989,12 +14488,7 @@ declare class ReleaseClient extends ApiClient {
14989
14488
  /** API client interact with release contents */
14990
14489
  declare class ReleaseContentsClient extends ApiClient {
14991
14490
  constructor(options: ClientOptions);
14992
- /** Fetches a list of entities added to a release */
14993
- list(options?: ExceptProject<ReleaseContentsGetParameters>): Promise<{
14994
- results: components$5["schemas"]["ReleaseContent"][];
14995
- totalCount: number;
14996
- }>;
14997
- /** @deprecated Use {@link list} instead. */
14491
+ /** Fetches all entities added to a release */
14998
14492
  get(options?: ExceptProject<ReleaseContentsGetParameters>): Promise<{
14999
14493
  results: components$5["schemas"]["ReleaseContent"][];
15000
14494
  totalCount: number;
@@ -15016,16 +14510,15 @@ type ResolvedRouteGetResponse = RouteGetResponseEdgehancedNotFound | RouteGetRes
15016
14510
  declare class RouteClient extends ApiClient<RouteClientOptions> {
15017
14511
  private edgeApiHost;
15018
14512
  constructor(options: RouteClientOptions);
15019
- /**
15020
- * Resolves a route to a composition, redirect, or not-found result.
15021
- *
15022
- * An optional `select` projection applies to the resolved composition when
15023
- * the route matches one; redirect / notFound responses pass through
15024
- * untouched.
15025
- */
15026
- get(options?: Omit<RouteGetParameters, 'projectId'> & Projection): Promise<ResolvedRouteGetResponse>;
15027
- /** @deprecated use {@link RouteClient.get} instead (renamed). */
15028
- getRoute(options?: Omit<RouteGetParameters, 'projectId'> & Projection): Promise<ResolvedRouteGetResponse>;
14513
+ /** Fetches lists of Canvas compositions, optionally by type */
14514
+ getRoute(options?: Omit<RouteGetParameters, 'projectId'> & {
14515
+ /**
14516
+ * Optional data projection. Applies to the resolved composition when
14517
+ * the route matches one. Redirect / notFound responses pass through
14518
+ * untouched. Serialized as `select.*` querystring parameters.
14519
+ */
14520
+ select?: ProjectionSpec;
14521
+ }): Promise<ResolvedRouteGetResponse>;
15029
14522
  }
15030
14523
 
15031
14524
  declare const mergeAssetConfigWithDefaults: (config: AssetParamConfig) => AssetParamConfig;
@@ -15301,22 +14794,16 @@ declare function hasReferencedVariables(value: string | undefined): number;
15301
14794
  */
15302
14795
  declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
15303
14796
 
15304
- declare const version = "20.71.0";
14797
+ declare const version = "20.71.1";
15305
14798
 
15306
14799
  /** API client to enable managing workflow definitions */
15307
14800
  declare class WorkflowClient extends ApiClient {
15308
14801
  constructor(options: ClientOptions);
15309
- /** Fetches a list of workflows for a project */
15310
- list(options?: ExceptProject<WorkflowsGetParameters>): Promise<{
15311
- results: components$3["schemas"]["WorkflowDefinition"][];
15312
- }>;
15313
- /** @deprecated Use {@link list} instead. */
14802
+ /** Fetches workflows for a project */
15314
14803
  get(options?: ExceptProject<WorkflowsGetParameters>): Promise<{
15315
14804
  results: components$3["schemas"]["WorkflowDefinition"][];
15316
14805
  }>;
15317
14806
  /** Updates or creates a workflow definition */
15318
- save(body: ExceptProject<WorkflowsPutParameters>): Promise<void>;
15319
- /** @deprecated Use {@link save} instead. */
15320
14807
  upsert(body: ExceptProject<WorkflowsPutParameters>): Promise<void>;
15321
14808
  /** Deletes a workflow definition */
15322
14809
  remove(body: ExceptProject<WorkflowsDeleteParameters>): Promise<void>;
@@ -15324,4 +14811,4 @@ declare class WorkflowClient extends ApiClient {
15324
14811
 
15325
14812
  declare const CanvasClientError: typeof ApiClientError;
15326
14813
 
15327
- 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 };
14814
+ 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 };