@uniformdev/assets 19.135.1-alpha.10 → 19.135.1-alpha.12

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 (3) hide show
  1. package/dist/index.d.mts +261 -186
  2. package/dist/index.d.ts +261 -186
  3. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -9,32 +9,32 @@ interface paths {
9
9
  get: {
10
10
  parameters: {
11
11
  query: {
12
- /** Specify a single asset ID to fetch. */
12
+ /** Specify a single asset ID to fetch */
13
13
  assetId?: components["parameters"]["assetId"];
14
- /** Specify multiple asset IDs to fetch. Response type will be a list. */
14
+ /** Specify multiple asset IDs to fetch. Response type will be a list */
15
15
  assetIDs?: components["parameters"]["assetIDs"];
16
- /** Filters asset lists by the user who created them. The user is specified by their identity subject. */
16
+ /** Filters asset lists by the user who created them. The user is specified by their identity subject */
17
17
  createdBy?: components["parameters"]["createdBy"];
18
18
  /**
19
19
  * Matches assets where their name or description contains the specified keyword.
20
- * This is a list query parameter, and cannot be used with any primary query parameters.
20
+ * This is a list query parameter, and cannot be used with any primary query parameters
21
21
  */
22
22
  keyword?: components["parameters"]["keyword"];
23
23
  /** Max number of records to return */
24
24
  limit?: components["parameters"]["limit"];
25
25
  /** Number of records to skip */
26
26
  offset?: components["parameters"]["offset"];
27
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
27
+ /** Sets the sorting of the results. If unspecified, results are sorted by name ascending */
28
28
  orderBy?: components["parameters"]["orderBy"];
29
- /** The project the asset/assets are on. */
29
+ /** The project the asset/assets are on */
30
30
  projectId: components["parameters"]["projectId"];
31
- /** The asset type ID to filter by. */
31
+ /** The asset type ID to filter by */
32
32
  type?: components["parameters"]["type"];
33
- /** Filters asset lists by the user who last updated them. The user is specified by their identity subject. */
33
+ /** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
34
34
  updatedBy?: components["parameters"]["updatedBy"];
35
35
  /**
36
36
  * Controls whether the total count of results will be returned along with the current results page in a list.
37
- * Has no effect when not fetching a list. This does impact performance when enabled.
37
+ * Has no effect when not fetching a list. This does impact performance when enabled
38
38
  */
39
39
  withTotalCount?: components["parameters"]["withTotalCount"];
40
40
  /**
@@ -43,7 +43,7 @@ interface paths {
43
43
  * - When unspecified, all release content is excluded from the result(s).
44
44
  * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
45
45
  *
46
- * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined.
46
+ * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
47
47
  */
48
48
  releaseId?: components["parameters"]["releaseId"];
49
49
  };
@@ -92,7 +92,7 @@ interface paths {
92
92
  projectId: string;
93
93
  /**
94
94
  * Format: uuid
95
- * @description The release ID to upsert the asset to. If unspecified the asset belongs to the base.
95
+ * @description The release ID to upsert the asset to. If unspecified the asset belongs to the base
96
96
  */
97
97
  releaseId?: string;
98
98
  asset?: components["schemas"]["AssetInput"];
@@ -128,14 +128,14 @@ interface paths {
128
128
  /**
129
129
  * Format: uuid
130
130
  * @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
131
- * Note: deleting an asset from a release will not delete the asset from the base.
131
+ * Note: deleting an asset from a release will not delete the asset from the base
132
132
  */
133
133
  releaseId?: string;
134
134
  };
135
135
  };
136
136
  };
137
137
  };
138
- /** Handles preflight requests. This endpoint allows CORS. */
138
+ /** Handles preflight requests. This endpoint allows CORS */
139
139
  options: {
140
140
  responses: {
141
141
  /** OK */
@@ -148,16 +148,16 @@ interface components {
148
148
  schemas: {
149
149
  /** @description Defines the shape of the asset */
150
150
  Asset: {
151
- /** @description Asset type of the asset. */
151
+ /** @description Asset type of the asset */
152
152
  type: string;
153
153
  /**
154
154
  * Format: uuid
155
- * @description The public UUID of the asset.
155
+ * @description The public UUID of the asset
156
156
  */
157
157
  _id: string;
158
- /** @description The name of the asset. */
158
+ /** @description The name of the asset */
159
159
  _name?: string;
160
- /** @description Name of the author of the most recent change. */
160
+ /** @description Name of the author of the most recent change */
161
161
  _author?: string;
162
162
  fields?: {
163
163
  title?: {
@@ -201,7 +201,7 @@ interface components {
201
201
  /** @constant */
202
202
  type: "number";
203
203
  };
204
- /** @description Asset field values. */
204
+ /** @description Asset field values */
205
205
  custom?: {
206
206
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
207
207
  };
@@ -210,14 +210,14 @@ interface components {
210
210
  };
211
211
  /** @description Defines the shape of the asset input */
212
212
  AssetInput: {
213
- /** @description Content type of the asset. */
213
+ /** @description Content type of the asset */
214
214
  type: string;
215
215
  /**
216
216
  * Format: uuid
217
- * @description The public UUID of the asset.
217
+ * @description The public UUID of the asset
218
218
  */
219
219
  _id?: string;
220
- /** @description The internal name of the asset. */
220
+ /** @description The internal name of the asset */
221
221
  _name?: string;
222
222
  fields?: {
223
223
  title?: {
@@ -246,36 +246,36 @@ interface components {
246
246
  */
247
247
  projectId: string;
248
248
  /**
249
- * Format: date-time,
249
+ * Format: date-time
250
250
  * @description Created date string for this definition
251
251
  */
252
252
  created: string;
253
253
  /**
254
- * Format: date-time,
254
+ * Format: date-time
255
255
  * @description Modified date string for this definition
256
256
  */
257
257
  modified: string;
258
258
  /**
259
259
  * Format: uuid
260
- * @description The release this asset belongs to. If not set, the asset belongs to the base.
260
+ * @description The release this asset belongs to. If not set, the asset belongs to the base
261
261
  */
262
262
  releaseId?: string;
263
263
  asset: components["schemas"]["Asset"];
264
264
  };
265
265
  AssetListResponse: {
266
266
  assets: components["schemas"]["AssetApiResponse"][];
267
- /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true. */
267
+ /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
268
268
  totalCount?: number;
269
269
  };
270
270
  };
271
271
  parameters: {
272
- /** @description The project the asset/assets are on. */
272
+ /** @description The project the asset/assets are on */
273
273
  projectId: string;
274
- /** @description Specify a single asset ID to fetch. */
274
+ /** @description Specify a single asset ID to fetch */
275
275
  assetId: string;
276
- /** @description Specify multiple asset IDs to fetch. Response type will be a list. */
276
+ /** @description Specify multiple asset IDs to fetch. Response type will be a list */
277
277
  assetIDs: string[];
278
- /** @description The asset type ID to filter by. */
278
+ /** @description The asset type ID to filter by */
279
279
  type: ("image" | "video" | "audio" | "document")[];
280
280
  /** @description Number of records to skip */
281
281
  offset: number;
@@ -283,18 +283,18 @@ interface components {
283
283
  limit: number;
284
284
  /**
285
285
  * @description Matches assets where their name or description contains the specified keyword.
286
- * This is a list query parameter, and cannot be used with any primary query parameters.
286
+ * This is a list query parameter, and cannot be used with any primary query parameters
287
287
  */
288
288
  keyword: string;
289
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
289
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending */
290
290
  orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
291
- /** @description Filters asset lists by the user who created them. The user is specified by their identity subject. */
291
+ /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
292
292
  createdBy: string;
293
- /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject. */
293
+ /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
294
294
  updatedBy: string;
295
295
  /**
296
296
  * @description Controls whether the total count of results will be returned along with the current results page in a list.
297
- * Has no effect when not fetching a list. This does impact performance when enabled.
297
+ * Has no effect when not fetching a list. This does impact performance when enabled
298
298
  */
299
299
  withTotalCount: boolean;
300
300
  /**
@@ -303,7 +303,7 @@ interface components {
303
303
  * - When unspecified, all release content is excluded from the result(s).
304
304
  * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
305
305
  *
306
- * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined.
306
+ * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
307
307
  */
308
308
  releaseId: string;
309
309
  };
@@ -355,7 +355,7 @@ interface external {
355
355
  paths: {};
356
356
  components: {
357
357
  schemas: {
358
- /** @description Public ID (used in code). Do not change after creation. */
358
+ /** @description Public ID (used in code). Do not change after creation */
359
359
  PublicIdProperty: string;
360
360
  /** @description The definition of a component parameter */
361
361
  ComponentDefinitionParameter: {
@@ -368,9 +368,24 @@ interface external {
368
368
  type: string;
369
369
  /**
370
370
  * @description If true, this property can have locale-specific values. If false or not defined,
371
- * this property will have a single value that is shared for all locales.
371
+ * this property will have a single value that is shared for all locales
372
372
  */
373
373
  localizable?: boolean;
374
+ /**
375
+ * @description When `localizable` is true, this property controls the default localizability of the property.
376
+ * true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
377
+ * false/undefined - when the property has no existing value, it will store separate values for each enabled locale
378
+ *
379
+ * If `localized` is false, this has no effect.
380
+ */
381
+ notLocalizedByDefault?: boolean;
382
+ /**
383
+ * @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
384
+ * When combined with a localized value, each locale has independent conditional values.
385
+ *
386
+ * When not defined, conditional values are not allowed.
387
+ */
388
+ allowConditionalValues?: boolean;
374
389
  /** @description The configuration object for the type (type-specific) */
375
390
  typeConfig?: unknown;
376
391
  };
@@ -382,20 +397,20 @@ interface external {
382
397
  /** @description A list of component definition public IDs that are allowed in this named slot */
383
398
  allowedComponents: string[];
384
399
  /**
385
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
386
- * If allowAllComponents is true, this value is ignored.
400
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
401
+ * If `allowAllComponents` is true, this value is ignored
387
402
  *
388
403
  * @default false
389
404
  */
390
405
  inheritAllowedComponents: boolean;
391
406
  /**
392
- * @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.
393
- * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
407
+ * @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.
408
+ * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
394
409
  */
395
410
  allowAllComponents?: boolean;
396
411
  /**
397
- * @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
398
- * When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
412
+ * @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
413
+ * When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
399
414
  */
400
415
  patternsInAllowedComponents?: boolean;
401
416
  /** @description Minimum valid number of components in this slot */
@@ -428,7 +443,7 @@ interface external {
428
443
  regularExpression?: string;
429
444
  /**
430
445
  * @description Custom error message when regular expression validation fails.
431
- * Has no effect if `regularExpression` is not set.
446
+ * Has no effect if `regularExpression` is not set
432
447
  */
433
448
  regularExpressionMessage?: string;
434
449
  };
@@ -438,7 +453,7 @@ interface external {
438
453
  /** @description Friendly name of the variant */
439
454
  name: string;
440
455
  };
441
- /** @description Permission set for a component defintion */
456
+ /** @description Permission set for a component definition */
442
457
  ComponentDefinitionPermission: {
443
458
  roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
444
459
  /**
@@ -463,23 +478,23 @@ interface external {
463
478
  icon?: string;
464
479
  /**
465
480
  * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
466
- * The parameter type must support being used as a title parameter for this to work.
481
+ * The parameter type must support being used as a title parameter for this to work
467
482
  *
468
483
  * @default null
469
484
  */
470
485
  titleParameter?: string | null;
471
486
  /**
472
- * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
487
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
473
488
  *
474
489
  * @default null
475
490
  */
476
491
  thumbnailParameter?: string | null;
477
492
  /**
478
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
493
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
479
494
  * @default false
480
495
  */
481
496
  canBeComposition?: boolean;
482
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
497
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
483
498
  parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
484
499
  /**
485
500
  * Format: uuid
@@ -487,15 +502,9 @@ interface external {
487
502
  * @default null
488
503
  */
489
504
  categoryId?: string | null;
490
- /**
491
- * @description Description of the component definition
492
- * @default null
493
- */
505
+ /** @description Description of the component definition */
494
506
  description?: string;
495
- /**
496
- * @description Description of the component definition
497
- * @default null
498
- */
507
+ /** @description Description of the component definition */
499
508
  previewImageUrl?: string;
500
509
  /**
501
510
  * @description if this component uses team permissions or custom permissions
@@ -504,12 +513,12 @@ interface external {
504
513
  useTeamPermissions?: boolean;
505
514
  /** @description Custom role permissions for this component definition */
506
515
  permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
507
- /** @description The named slots for this component; placement areas where arrays of other components can be added. */
516
+ /** @description The named slots for this component; placement areas where arrays of other components can be added */
508
517
  slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
509
518
  slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
510
519
  /** @description Default component instance value */
511
520
  defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
512
- /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
521
+ /** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
513
522
  variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
514
523
  /** @description Created date string for this definition (ignored for writes) */
515
524
  created?: string;
@@ -517,7 +526,7 @@ interface external {
517
526
  updated?: string;
518
527
  /**
519
528
  * Format: uuid
520
- * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached.
529
+ * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
521
530
  */
522
531
  workflowId?: string;
523
532
  };
@@ -528,21 +537,18 @@ interface external {
528
537
  name: string;
529
538
  /**
530
539
  * @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.
531
- * The field type must support being used as an entry name for this to work.
540
+ * The field type must support being used as an entry name for this to work
532
541
  */
533
542
  entryName?: string | null;
534
543
  /**
535
- * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
544
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
536
545
  *
537
546
  * @default null
538
547
  */
539
548
  thumbnailField?: string | null;
540
549
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
541
550
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
542
- /**
543
- * @description Description of the content type
544
- * @default null
545
- */
551
+ /** @description Description of the content type */
546
552
  description?: string;
547
553
  /**
548
554
  * @description Icon name for the content type (e.g. 'screen')
@@ -569,29 +575,88 @@ interface external {
569
575
  permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
570
576
  /**
571
577
  * Format: uuid
572
- * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached.
578
+ * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
573
579
  */
574
580
  workflowId?: string;
575
581
  };
576
- /** @description Defines an editable parameter on a component. */
582
+ /** @description Defines an editable parameter on a component */
577
583
  ComponentParameter: {
578
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
584
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable */
579
585
  value?: unknown;
580
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
586
+ /** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
581
587
  type: string;
582
588
  /** @deprecated */
583
589
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
584
590
  /**
585
591
  * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
586
- * Note that locales must be registered on the entry/composition `_locales` before being used.
592
+ * Note that locales must be registered on the entry/composition `_locales` before being used
587
593
  */
588
594
  locales?: {
589
595
  [key: string]: unknown;
590
596
  };
597
+ conditions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
598
+ /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
599
+ localesConditions?: {
600
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
601
+ };
602
+ };
603
+ /**
604
+ * @description Array of alternate values which are based on conditions.
605
+ *
606
+ * When requested with an explicit locale parameter, or via the route API:
607
+ * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
608
+ * * If no conditions match, the `value` property is used.
609
+ * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
610
+ *
611
+ * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
612
+ */
613
+ ComponentParameterConditions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
614
+ /** @description Defines a conditional value for a component parameter */
615
+ ComponentParameterConditionalValue: {
616
+ when: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
617
+ /**
618
+ * @description The value of the parameter. Any JSON-serializable value is acceptable.
619
+ * A value of `null` will cause the parameter value to be removed, if it matches.
620
+ */
621
+ value: unknown;
622
+ /**
623
+ * @description Unique sequence identifier of the conditional value within the component parameter.
624
+ * This value must be unique within the conditional values array, and it should not change after a condition is created.
625
+ */
626
+ id: number;
591
627
  };
592
- /** @description Defines a connection to a dynamic token on a data resource. */
628
+ /**
629
+ * @deprecated
630
+ * @description beta functionality subject to change
631
+ */
632
+ VisibilityCriteriaGroup: {
633
+ /**
634
+ * @description The boolean operator to join the clauses with. Defaults to & if not specified.
635
+ * @enum {string}
636
+ */
637
+ op?: "&" | "|";
638
+ clauses: (external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
639
+ };
640
+ /**
641
+ * @deprecated
642
+ * @description beta functionality subject to change
643
+ */
644
+ VisibilityCriteria: {
645
+ /** @description The rule type to execute */
646
+ rule: string;
647
+ /**
648
+ * @description The source value of the rule.
649
+ * 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.
650
+ */
651
+ source?: string;
652
+ /** @description The rule-definition-specific operator to test against */
653
+ op: string;
654
+ /** @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. */
655
+ value: string | string[];
656
+ };
657
+ /** @description Defines a connection to a dynamic token on a data resource */
593
658
  DataElementConnectionDefinition: {
594
- /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
659
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value */
595
660
  pointer: string;
596
661
  /**
597
662
  * @description The syntax used to select the dynamic token to bind to
@@ -601,14 +666,14 @@ interface external {
601
666
  /**
602
667
  * @description The action to take if the dynamic token cannot be resolved
603
668
  * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
604
- * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
605
- * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
606
- * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
669
+ * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
670
+ * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
671
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
607
672
  * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
608
673
  * - c: COMPONENT: Removes the whole parent component or block that contains the property.
609
- * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
610
- * it is treated as an 'a' failure because removing the root means we must remove all.
611
- * - 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.
674
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
675
+ * it is treated as an 'a' failure because removing the root means we must remove all
676
+ * - 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
612
677
  *
613
678
  * @enum {string}
614
679
  */
@@ -624,11 +689,11 @@ interface external {
624
689
  failureLogLevel?: "e" | "w" | "i";
625
690
  /**
626
691
  * @description The default value to use if the dynamic token cannot be resolved.
627
- * This is only used if the failureAction is the default (undefined, or explicitly token).
692
+ * This is only used if the failureAction is the default (undefined, or explicitly token)
628
693
  */
629
694
  failureDefault?: string;
630
695
  };
631
- /** @description Defines the shape of a component instance served by the composition API. */
696
+ /** @description Defines the shape of a component instance served by the composition API */
632
697
  ComponentInstance: {
633
698
  /** @description Type of the component instance (public_id of its definition) */
634
699
  type: string;
@@ -646,15 +711,15 @@ interface external {
646
711
  * @description Unique identifier of the component within the composition.
647
712
  * No assumptions should be made about the format of this value other than "it will be unique."
648
713
  * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
649
- * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
714
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
650
715
  */
651
716
  _id?: string;
652
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
717
+ /** @description Indicates this component instance should be sourced from a pattern library pattern */
653
718
  _pattern?: string;
654
719
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
655
720
  /**
656
721
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
657
- * Means nothing for PUTs; it will be ignored.
722
+ * Means nothing for PUTs; it will be ignored
658
723
  */
659
724
  _patternDataResources?: {
660
725
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -670,7 +735,7 @@ interface external {
670
735
  * the composition's override replaces the pattern's.
671
736
  *
672
737
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
673
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
738
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
674
739
  */
675
740
  _overrides?: {
676
741
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
@@ -680,10 +745,10 @@ interface external {
680
745
  * by consumers of the pattern.
681
746
  *
682
747
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
683
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
748
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
684
749
  */
685
750
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
686
- /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
751
+ /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
687
752
  _locales?: string[];
688
753
  };
689
754
  /** @description Defines the shape of the root component in a composition */
@@ -696,31 +761,31 @@ interface external {
696
761
  };
697
762
  /** @description Public ID of alternate visual appearance for this component, if any selected */
698
763
  variant?: string;
699
- /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
764
+ /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
700
765
  projectMapNodes?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
701
766
  /** @description Slots containing any child components */
702
767
  slots?: {
703
768
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
704
769
  };
705
- /** @description The public UUID of the composition. */
770
+ /** @description The public UUID of the composition */
706
771
  _id: string;
707
- /** @description Slug pattern of this component. */
772
+ /** @description Slug pattern of this component */
708
773
  _slug?: string | null;
709
- /** @description Friendly name of this component. */
774
+ /** @description Friendly name of this component */
710
775
  _name: string;
711
- /** @description Name of the author of the most recent change. */
776
+ /** @description Name of the author of the most recent change */
712
777
  _author?: string;
713
- /** @description Identity subject of the author of the most recent change. */
778
+ /** @description Identity subject of the author of the most recent change */
714
779
  _authorSubject?: string;
715
- /** @description Name of the original creator. */
780
+ /** @description Name of the original creator */
716
781
  _creator?: string;
717
- /** @description Identity subject of the original creator. */
782
+ /** @description Identity subject of the original creator */
718
783
  _creatorSubject?: string;
719
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
784
+ /** @description Indicates this component instance should be sourced from a pattern library pattern */
720
785
  _pattern?: string;
721
786
  /**
722
787
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
723
- * Means nothing for PUTs; it will be ignored.
788
+ * Means nothing for PUTs; it will be ignored
724
789
  */
725
790
  _patternDataResources?: {
726
791
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -737,7 +802,7 @@ interface external {
737
802
  * the composition's override replaces the pattern's.
738
803
  *
739
804
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
740
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
805
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
741
806
  */
742
807
  _overrides?: {
743
808
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
@@ -747,17 +812,17 @@ interface external {
747
812
  * by consumers of the pattern.
748
813
  *
749
814
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
750
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
815
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
751
816
  */
752
817
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
753
- /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
818
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
754
819
  _locales?: string[];
755
820
  };
756
821
  /**
757
822
  * @description Defines how to override a specific component.
758
823
  *
759
824
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
760
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
825
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
761
826
  */
762
827
  ComponentOverride: {
763
828
  parameters?: {
@@ -773,19 +838,19 @@ interface external {
773
838
  * NOTE: Data resources' overridability is defined in the data resource definition, not here.
774
839
  *
775
840
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
776
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
841
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
777
842
  */
778
843
  ComponentOverridability: {
779
- /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
844
+ /** @description Defines component parameter value overrides. Keys are the parameter public ID */
780
845
  parameters?: {
781
846
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
782
847
  };
783
- /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
848
+ /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
784
849
  variants?: boolean;
785
850
  /**
786
851
  * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
787
852
  * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
788
- * If not set, the default is false.
853
+ * If not set, the default is false
789
854
  */
790
855
  hideLockedParameters?: boolean;
791
856
  };
@@ -793,7 +858,7 @@ interface external {
793
858
  * @description Whether a parameter is overridable
794
859
  *
795
860
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
796
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
861
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
797
862
  *
798
863
  * @enum {string}
799
864
  */
@@ -801,8 +866,8 @@ interface external {
801
866
  /**
802
867
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
803
868
  * These are created in the UI and shared across a whole project.
804
- * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
805
- * for all header, parameter, and variable values to obscure the actual encrypted secret value.
869
+ * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
870
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value
806
871
  */
807
872
  DataSource: {
808
873
  /** @description Public ID of the data source */
@@ -811,14 +876,14 @@ interface external {
811
876
  displayName: string;
812
877
  /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
813
878
  connectorType: string;
814
- /** @description Base resource URL of the data source. No trailing slash. */
879
+ /** @description Base resource URL of the data source. No trailing slash */
815
880
  baseUrl: string;
816
881
  /** @description HTTP headers to pass with requests to the data source */
817
882
  headers?: {
818
883
  key: string;
819
884
  value: string;
820
885
  }[];
821
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
886
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
822
887
  parameters?: {
823
888
  key: string;
824
889
  value: string;
@@ -829,21 +894,21 @@ interface external {
829
894
  };
830
895
  /**
831
896
  * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
832
- * If a locale is not mapped, it will be passed through to the data source as-is.
897
+ * If a locale is not mapped, it will be passed through to the data source as-is
833
898
  */
834
899
  localeMapping?: {
835
900
  [key: string]: string;
836
901
  };
837
- /** @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. */
902
+ /** @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 */
838
903
  customPublic?: {
839
904
  [key: string]: unknown;
840
905
  };
841
- /** @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. */
906
+ /** @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 */
842
907
  custom?: {
843
908
  [key: string]: unknown;
844
909
  };
845
910
  };
846
- /** @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. */
911
+ /** @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 */
847
912
  DataType: {
848
913
  /** @description Public ID of the data type */
849
914
  id: string;
@@ -854,39 +919,39 @@ interface external {
854
919
  /**
855
920
  * @description A connector-specific archetype for this data type; used to select UI as well as perform any
856
921
  * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
857
- * no special UI or processing is required.
922
+ * no special UI or processing is required
858
923
  */
859
924
  archetype?: string;
860
925
  allowedOnComponents?: string[];
861
- /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
926
+ /** @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 */
862
927
  path: string;
863
- /** @description Time-to-live (in seconds) for the resource data cache. */
928
+ /** @description Time-to-live (in seconds) for the resource data cache */
864
929
  ttl?: number;
865
- /** @description A key for the resource data cache purging. */
930
+ /** @description A key for the resource data cache purging */
866
931
  purgeKey?: string;
867
- /** @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. */
932
+ /** @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 */
868
933
  badgeIconUrl?: string;
869
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
934
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
870
935
  headers?: {
871
936
  key: string;
872
937
  value: string;
873
938
  omitIfEmpty?: boolean;
874
939
  }[];
875
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
940
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
876
941
  parameters?: {
877
942
  key: string;
878
943
  value: string;
879
944
  omitIfEmpty?: boolean;
880
945
  }[];
881
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
946
+ /** @description Body to pass with requests to the data type (ignored unless the method is POST) */
882
947
  body?: string;
883
948
  /**
884
- * @description HTTP method to use with requests to the data type.
949
+ * @description HTTP method to use with requests to the data type
885
950
  * @default GET
886
951
  * @enum {string}
887
952
  */
888
953
  method: "GET" | "POST" | "HEAD";
889
- /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
954
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
890
955
  variables?: {
891
956
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
892
957
  };
@@ -899,26 +964,26 @@ interface external {
899
964
  DataVariableDefinition: {
900
965
  /** @description Display name of the data variable */
901
966
  displayName?: string;
902
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
967
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
903
968
  helpText?: string;
904
969
  /**
905
- * @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.
970
+ * @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
906
971
  * @default text
907
972
  */
908
973
  type?: string;
909
974
  /** @description Default value of the data variable */
910
975
  default: string;
911
- /** @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. */
976
+ /** @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 */
912
977
  order?: number;
913
978
  /**
914
979
  * @description An optional arbitrary human readable source identifier to describe where this variable is from.
915
- * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
980
+ * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
916
981
  */
917
982
  source?: string;
918
983
  };
919
984
  /**
920
985
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
921
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
986
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
922
987
  */
923
988
  DataResourceDefinitions: {
924
989
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -927,25 +992,30 @@ interface external {
927
992
  DataResourceDefinition: {
928
993
  /** @description Public ID of the data type that provides this data */
929
994
  type: string;
930
- /** @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. */
995
+ /** @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 */
931
996
  isPatternParameter?: boolean;
932
997
  /**
933
998
  * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
934
999
  * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
935
- * If isPatternParameter is false or undefined, this has no meaning.
1000
+ * If isPatternParameter is false or undefined, this has no meaning
936
1001
  */
937
1002
  ignorePatternParameterDefault?: boolean;
1003
+ /**
1004
+ * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
1005
+ * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1006
+ */
1007
+ optionalPatternParameter?: boolean;
938
1008
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
939
1009
  };
940
- /** @description Variable values for a data resource. */
1010
+ /** @description Variable values for a data resource */
941
1011
  DataResourceVariables: {
942
1012
  [key: string]: string;
943
1013
  };
944
1014
  /**
945
1015
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
946
1016
  * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
947
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
948
- * Means nothing for PUTs; it will be ignored.
1017
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
1018
+ * Means nothing for PUTs; it will be ignored
949
1019
  *
950
1020
  * @enum {string}
951
1021
  */
@@ -953,23 +1023,23 @@ interface external {
953
1023
  HistoryApiResponse: {
954
1024
  /**
955
1025
  * @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.
956
- * If this is undefined then no more results are available.
1026
+ * If this is undefined then no more results are available
957
1027
  */
958
1028
  cursor?: string;
959
1029
  /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
960
1030
  truncated?: boolean;
961
- /** @description Version history entries. */
1031
+ /** @description Version history entries */
962
1032
  results?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
963
1033
  };
964
1034
  HistoryEntry: {
965
- /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
1035
+ /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
966
1036
  versionId: string;
967
- /** @description The timestamp when the version was created in epoch milliseconds. */
1037
+ /** @description The timestamp when the version was created in epoch milliseconds */
968
1038
  timestamp: number;
969
- /** @description The name (full name) of the user who created the version. */
1039
+ /** @description The name (full name) of the user who created the version */
970
1040
  authorName: string;
971
1041
  authorIsApiKey: boolean;
972
- /** @description The state of the entity when the history entry was made. */
1042
+ /** @description The state of the entity when the history entry was made */
973
1043
  state: number;
974
1044
  };
975
1045
  /** @description Category for tagging canvas entities */
@@ -982,12 +1052,12 @@ interface external {
982
1052
  /** @description Display name of the category */
983
1053
  name: string;
984
1054
  /**
985
- * @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.
1055
+ * @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
986
1056
  * @default 0
987
1057
  */
988
1058
  order?: number;
989
1059
  };
990
- /** @description Project map node information related to a component. */
1060
+ /** @description Project map node information related to a component */
991
1061
  CompositionProjectMapNodeInfo: {
992
1062
  /**
993
1063
  * Format: uuid
@@ -996,36 +1066,36 @@ interface external {
996
1066
  id: string;
997
1067
  /**
998
1068
  * @description Fallback path of the project map node.
999
- * Note that the node may have matched via a locale-specific path which is in the `locales` object.
1069
+ * Note that the node may have matched via a locale-specific path which is in the `locales` object
1000
1070
  */
1001
1071
  path: string;
1002
1072
  /**
1003
1073
  * Format: uuid
1004
- * @description Unique identifier for the project map that this node belongs to.
1074
+ * @description Unique identifier for the project map that this node belongs to
1005
1075
  */
1006
1076
  projectMapId: string;
1007
1077
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1008
1078
  /**
1009
1079
  * @description Locale-specific paths of the project map node.
1010
- * Keys are locale codes.
1080
+ * Keys are locale codes
1011
1081
  */
1012
1082
  locales?: {
1013
1083
  [key: string]: {
1014
- /** @description Locale-specific path of the project map node. */
1084
+ /** @description Locale-specific path of the project map node */
1015
1085
  path: string;
1016
- /** @description Whether the path is inherited from a parent node which defined a path segment in this locale. */
1086
+ /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
1017
1087
  inherited: boolean;
1018
1088
  };
1019
1089
  };
1020
1090
  };
1021
- /** @description AI Prompt definition. */
1091
+ /** @description AI Prompt definition */
1022
1092
  Prompt: {
1023
1093
  /**
1024
1094
  * Format: uuid
1025
1095
  * @description Unique identifier for the prompt
1026
1096
  */
1027
1097
  id: string;
1028
- /** @description Unique identifier for the integration that this prompt belongs to. */
1098
+ /** @description Unique identifier for the integration that this prompt belongs to */
1029
1099
  integrationType: string;
1030
1100
  /** @description Name for the prompt */
1031
1101
  name?: string | null;
@@ -1067,13 +1137,13 @@ interface external {
1067
1137
  /**
1068
1138
  * @description Name of the original creator of the workflow.
1069
1139
  * If undefined, the user has been removed from the team.
1070
- * Ignored for writes.
1140
+ * Ignored for writes
1071
1141
  */
1072
1142
  createdBy?: string;
1073
1143
  /**
1074
1144
  * @description Name of the last modifier of the workflow.
1075
1145
  * If undefined, the user has been removed from the team.
1076
- * Ignored for writes.
1146
+ * Ignored for writes
1077
1147
  */
1078
1148
  modifiedBy?: string;
1079
1149
  };
@@ -1083,9 +1153,9 @@ interface external {
1083
1153
  name: string;
1084
1154
  /**
1085
1155
  * @description Defines roles which have permissions to this workflow stage
1086
- * NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1156
+ * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1087
1157
  * 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
1088
- * listed here, the stage is read only and publishing is disabled.
1158
+ * listed here, the stage is read-only and publishing is disabled
1089
1159
  */
1090
1160
  permissions: {
1091
1161
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
@@ -1094,19 +1164,19 @@ interface external {
1094
1164
  * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
1095
1165
  * 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.
1096
1166
  * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
1097
- * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1167
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
1098
1168
  */
1099
1169
  autoPublish?: boolean;
1100
1170
  /**
1101
1171
  * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
1102
1172
  * If the entity is not valid, the transition will not be allowed.
1103
- * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1173
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
1104
1174
  */
1105
1175
  requireValidity?: boolean;
1106
1176
  /**
1107
1177
  * @description Defines transitions to other stages
1108
1178
  * Every stage must define at least one transition, to avoid creating a workflow that
1109
- * has a stage that can never be escaped.
1179
+ * has a stage that can never be escaped
1110
1180
  */
1111
1181
  transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
1112
1182
  /**
@@ -1114,7 +1184,7 @@ interface external {
1114
1184
  * @default chevron-double-right-o
1115
1185
  */
1116
1186
  icon?: string;
1117
- /** @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. */
1187
+ /** @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 */
1118
1188
  order?: number;
1119
1189
  };
1120
1190
  /** @description Definition of a transition from one stage to another in a workflow */
@@ -1126,12 +1196,12 @@ interface external {
1126
1196
  to: string;
1127
1197
  /**
1128
1198
  * @description Name shown to the user when they execute this transition.
1129
- * If not provided, a default name will be assigned automatically based on the target stage.
1199
+ * If not provided, a default name will be assigned automatically based on the target stage
1130
1200
  */
1131
1201
  name: string;
1132
1202
  /**
1133
1203
  * @description Permissions for the stage transition.
1134
- * NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
1204
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
1135
1205
  */
1136
1206
  permissions: {
1137
1207
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
@@ -1139,14 +1209,14 @@ interface external {
1139
1209
  };
1140
1210
  /** @description Permissions for a workflow stage */
1141
1211
  WorkflowStagePermission: {
1142
- /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
1212
+ /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
1143
1213
  write?: boolean;
1144
- /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
1214
+ /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
1145
1215
  publish?: boolean;
1146
1216
  };
1147
1217
  /** @description Permissions for a workflow stage transition */
1148
1218
  WorkflowStageTransitionPermission: {
1149
- /** @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. */
1219
+ /** @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 */
1150
1220
  execute?: boolean;
1151
1221
  };
1152
1222
  };
@@ -1170,12 +1240,12 @@ interface external {
1170
1240
  * - When unspecified, composition data is fetched from base.
1171
1241
  * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
1172
1242
  *
1173
- * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined.
1243
+ * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
1174
1244
  */
1175
1245
  releaseId?: string;
1176
- /** The id of the node to retrieve, cannot have both this parameter and Path */
1246
+ /** The id of the node to retrieve, cannot have both this parameter and `path` */
1177
1247
  id?: string;
1178
- /** The path of the root node to retrieve, cannot have both this parameter and Id */
1248
+ /** The path of the root node to retrieve, cannot have both this parameter and `id` */
1179
1249
  path?: string;
1180
1250
  /** Composition id to find associated sitemap nodes for */
1181
1251
  compositionId?: string;
@@ -1183,9 +1253,9 @@ interface external {
1183
1253
  limit?: number;
1184
1254
  /** Number of records to skip before returning nodes */
1185
1255
  offset?: number;
1186
- /** Depth of the tree to fetch. Only applies when fetching by path. */
1256
+ /** Depth of the tree to fetch. This only applies when fetching by path */
1187
1257
  depth?: number;
1188
- /** State of compositions to fetch. 0 = draft, 64 = published. */
1258
+ /** State of compositions to fetch. 0 = draft, 64 = published */
1189
1259
  state?: number;
1190
1260
  /** should the data be returned as a json tree object (or a flat array) */
1191
1261
  tree?: boolean;
@@ -1193,19 +1263,19 @@ interface external {
1193
1263
  search?: string;
1194
1264
  /**
1195
1265
  * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
1196
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
1266
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
1197
1267
  */
1198
1268
  includeAncestors?: boolean;
1199
- /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
1269
+ /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
1200
1270
  expanded?: boolean;
1201
- /** include basic composition information. ID, type, state, name, and definition id. */
1271
+ /** include basic composition information. ID, type, state, name, and definition id */
1202
1272
  withCompositionData?: boolean;
1203
1273
  /**
1204
1274
  * @deprecated Returns the UI status string of the composition.
1205
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
1275
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
1206
1276
  */
1207
1277
  withCompositionUIStatus?: boolean;
1208
- /** Include basic redirect information. */
1278
+ /** Include basic redirect information */
1209
1279
  withRedirectData?: boolean;
1210
1280
  };
1211
1281
  };
@@ -1315,7 +1385,7 @@ interface external {
1315
1385
  };
1316
1386
  };
1317
1387
  };
1318
- /** Handles preflight requests. This endpoint allows CORS. */
1388
+ /** Handles preflight requests. This endpoint allows CORS */
1319
1389
  options: {
1320
1390
  responses: {
1321
1391
  /** OK */
@@ -1334,7 +1404,7 @@ interface external {
1334
1404
  id: string;
1335
1405
  /** @description Path representing the path to the current node */
1336
1406
  path: string;
1337
- /** @description Ordering of the node, higher numbers go after lower numbers. */
1407
+ /** @description Ordering of the node, higher numbers go after lower numbers */
1338
1408
  order?: number;
1339
1409
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1340
1410
  /** @description The name of the projectMap entry */
@@ -1372,13 +1442,13 @@ interface external {
1372
1442
  /** @description Last segment of the url in this locale */
1373
1443
  pathSegment: string;
1374
1444
  /**
1375
- * @description When false, the node explicitly defines a locale specific path segment.
1445
+ * @description When false, the node explicitly defines a locale-specific path segment.
1376
1446
  *
1377
- * When true, an ancestor defines a locale specific path segment,
1447
+ * When true, an ancestor defines a locale-specific path segment,
1378
1448
  * which makes its descendants resolvable using that segment.
1379
- * This node does not define a locale specific path segment.
1449
+ * This node does not define a locale-specific path segment.
1380
1450
  *
1381
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
1451
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
1382
1452
  */
1383
1453
  inherited?: boolean;
1384
1454
  };
@@ -1396,22 +1466,22 @@ interface external {
1396
1466
  */
1397
1467
  id?: string;
1398
1468
  }[];
1399
- /** @description Basic information about a composition from the context of a project map node. */
1469
+ /** @description Basic information about a composition from the context of a project map node */
1400
1470
  ProjectMapNodeCompositionData: {
1401
1471
  /** @description Type of the composition instance (public_id of its definition) */
1402
1472
  type: string;
1403
1473
  /**
1404
1474
  * Format: uuid
1405
- * @description The public UUID of the composition.
1475
+ * @description The public UUID of the composition
1406
1476
  */
1407
1477
  id: string;
1408
- /** @description Slug pattern of this composition. */
1478
+ /** @description Slug pattern of this composition */
1409
1479
  slug?: string | null;
1410
- /** @description Friendly name of this composition. */
1480
+ /** @description Friendly name of this composition */
1411
1481
  name: string;
1412
1482
  /**
1413
1483
  * @deprecated
1414
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
1484
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1415
1485
  * @enum {string}
1416
1486
  */
1417
1487
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
@@ -1422,8 +1492,13 @@ interface external {
1422
1492
  icon?: string;
1423
1493
  /** @description Friendly name of this Composition's Definition */
1424
1494
  typeName?: string;
1425
- /** @description List of locales that the composition is available in. If empty, available in all locales. */
1495
+ /** @description List of locales that the composition is available in. If empty, available in all locales */
1426
1496
  locales: string[];
1497
+ /**
1498
+ * Format: date-time
1499
+ * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
1500
+ */
1501
+ modified?: string;
1427
1502
  };
1428
1503
  ProjectMapNodeUpdate: {
1429
1504
  /**
@@ -1433,7 +1508,7 @@ interface external {
1433
1508
  id?: string;
1434
1509
  /** @description Path representing the path to the current node */
1435
1510
  path: string;
1436
- /** @description Ordering of the node, higher numbers go after lower numbers. */
1511
+ /** @description Ordering of the node, higher numbers go after lower numbers */
1437
1512
  order?: number;
1438
1513
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1439
1514
  /** @description The name of the projectMap entry */
@@ -1468,7 +1543,7 @@ interface external {
1468
1543
  /**
1469
1544
  * @description For dynamic nodes, this is the preview value for the dynamic value.
1470
1545
  * The preview value is used when editing a connected composition, and is the default
1471
- * dynamic node value unless the author has explicitly chosen a different value.
1546
+ * dynamic node value unless the author has explicitly chosen a different value
1472
1547
  */
1473
1548
  previewValue?: string;
1474
1549
  };