@uniformdev/canvas 19.186.4-alpha.3 → 19.187.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -564,7 +564,7 @@ interface external$j {
564
564
  slots?: {
565
565
  [key: string]: external$j["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
566
566
  };
567
- /** @description The public UUID of the composition */
567
+ /** @description The ID of the composition */
568
568
  _id: string;
569
569
  /** @description Slug pattern of this component */
570
570
  _slug?: string | null;
@@ -832,12 +832,6 @@ interface external$j {
832
832
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
833
833
  */
834
834
  optionalPatternParameter?: boolean;
835
- /**
836
- * @description Resolve this data resource with draft mode content. TBD
837
- *
838
- * @enum {string}
839
- */
840
- dataSourceVariant?: "unpublished";
841
835
  variables?: external$j["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
842
836
  };
843
837
  /** @description Variable values for a data resource */
@@ -1080,7 +1074,7 @@ interface external$j {
1080
1074
  id?: string;
1081
1075
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
1082
1076
  path?: string;
1083
- /** Composition id to find associated sitemap nodes for */
1077
+ /** Composition id to find associated project map node for */
1084
1078
  compositionId?: string;
1085
1079
  /** Limit the number or records returned by a number */
1086
1080
  limit?: number;
@@ -1299,18 +1293,27 @@ interface external$j {
1299
1293
  */
1300
1294
  id?: string;
1301
1295
  }[];
1302
- /** @description Basic information about a composition from the context of a project map node */
1296
+ /**
1297
+ * @description Basic information about the linked composition from the context of a project map node.
1298
+ * If the linked composition has editions, the editions are included in the `editions` property.
1299
+ */
1303
1300
  ProjectMapNodeCompositionData: {
1304
- /** @description Type of the composition instance (public_id of its definition) */
1301
+ /** @description Type of the linked composition (id of its definition) */
1305
1302
  type: string;
1306
1303
  /**
1307
1304
  * Format: uuid
1308
- * @description The public UUID of the composition
1305
+ * @description The UUID of the linked composition
1309
1306
  */
1310
1307
  id: string;
1311
- /** @description Slug pattern of this composition */
1308
+ /**
1309
+ * Format: uuid
1310
+ * @description The edition UUID underneath the linked composition
1311
+ * This is only present if the composition has not been published, but an edition has
1312
+ */
1313
+ editionId?: string;
1314
+ /** @description Slug pattern of the linked composition or edition */
1312
1315
  slug?: string | null;
1313
- /** @description Friendly name of this composition */
1316
+ /** @description Friendly name of this composition or edition */
1314
1317
  name: string;
1315
1318
  /**
1316
1319
  * @deprecated
@@ -1325,7 +1328,61 @@ interface external$j {
1325
1328
  icon?: string;
1326
1329
  /** @description Friendly name of this Composition's Definition */
1327
1330
  typeName?: string;
1328
- /** @description List of locales that the composition is available in. If empty, available in all locales */
1331
+ /**
1332
+ * @description List of locales that the composition _or any of its editions_ is available in.
1333
+ * If empty, available in all locales.
1334
+ */
1335
+ locales: string[];
1336
+ /** @description Priority of the composition relative to any editions */
1337
+ editionPriority?: number;
1338
+ /** @description Friendly name of the edition */
1339
+ editionName?: string;
1340
+ /**
1341
+ * @deprecated
1342
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
1343
+ * where the editionID equals the node's compositionID.
1344
+ */
1345
+ editions?: external$j["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
1346
+ };
1347
+ /**
1348
+ * @deprecated
1349
+ * @description Basic information about a composition edition from the context of a project map node
1350
+ */
1351
+ ProjectMapNodeCompositionEditionData: {
1352
+ /**
1353
+ * Format: uuid
1354
+ * @description The UUID of the linked composition
1355
+ */
1356
+ id: string;
1357
+ /** @description Type of the edition instance (public_id of its definition) */
1358
+ type: string;
1359
+ /**
1360
+ * Format: uuid
1361
+ * @description The edition UUID underneath the linked composition
1362
+ */
1363
+ editionId?: string;
1364
+ /** @description Slug pattern of this edition */
1365
+ slug?: string | null;
1366
+ /** @description Friendly name of the linked composition */
1367
+ name: string;
1368
+ /** @description Friendly name of the edition */
1369
+ editionName?: string;
1370
+ /** @description Priority of the edition */
1371
+ editionPriority?: number;
1372
+ /**
1373
+ * @deprecated
1374
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1375
+ * @enum {string}
1376
+ */
1377
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1378
+ /**
1379
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
1380
+ * @default screen
1381
+ */
1382
+ icon?: string;
1383
+ /** @description Friendly name of this edition's definition */
1384
+ typeName?: string;
1385
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
1329
1386
  locales: string[];
1330
1387
  /**
1331
1388
  * Format: date-time
@@ -1822,7 +1879,7 @@ interface components$8 {
1822
1879
  slots?: {
1823
1880
  [key: string]: components$8["schemas"]["ComponentInstance"][];
1824
1881
  };
1825
- /** @description The public UUID of the composition */
1882
+ /** @description The ID of the composition */
1826
1883
  _id: string;
1827
1884
  /** @description Slug pattern of this component */
1828
1885
  _slug?: string | null;
@@ -2090,12 +2147,6 @@ interface components$8 {
2090
2147
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
2091
2148
  */
2092
2149
  optionalPatternParameter?: boolean;
2093
- /**
2094
- * @description Resolve this data resource with draft mode content. TBD
2095
- *
2096
- * @enum {string}
2097
- */
2098
- dataSourceVariant?: "unpublished";
2099
2150
  variables?: components$8["schemas"]["DataResourceVariables"];
2100
2151
  };
2101
2152
  /** @description Variable values for a data resource */
@@ -2379,7 +2430,7 @@ interface external$i {
2379
2430
  id?: string;
2380
2431
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
2381
2432
  path?: string;
2382
- /** Composition id to find associated sitemap nodes for */
2433
+ /** Composition id to find associated project map node for */
2383
2434
  compositionId?: string;
2384
2435
  /** Limit the number or records returned by a number */
2385
2436
  limit?: number;
@@ -2598,18 +2649,27 @@ interface external$i {
2598
2649
  */
2599
2650
  id?: string;
2600
2651
  }[];
2601
- /** @description Basic information about a composition from the context of a project map node */
2652
+ /**
2653
+ * @description Basic information about the linked composition from the context of a project map node.
2654
+ * If the linked composition has editions, the editions are included in the `editions` property.
2655
+ */
2602
2656
  ProjectMapNodeCompositionData: {
2603
- /** @description Type of the composition instance (public_id of its definition) */
2657
+ /** @description Type of the linked composition (id of its definition) */
2604
2658
  type: string;
2605
2659
  /**
2606
2660
  * Format: uuid
2607
- * @description The public UUID of the composition
2661
+ * @description The UUID of the linked composition
2608
2662
  */
2609
2663
  id: string;
2610
- /** @description Slug pattern of this composition */
2664
+ /**
2665
+ * Format: uuid
2666
+ * @description The edition UUID underneath the linked composition
2667
+ * This is only present if the composition has not been published, but an edition has
2668
+ */
2669
+ editionId?: string;
2670
+ /** @description Slug pattern of the linked composition or edition */
2611
2671
  slug?: string | null;
2612
- /** @description Friendly name of this composition */
2672
+ /** @description Friendly name of this composition or edition */
2613
2673
  name: string;
2614
2674
  /**
2615
2675
  * @deprecated
@@ -2624,7 +2684,61 @@ interface external$i {
2624
2684
  icon?: string;
2625
2685
  /** @description Friendly name of this Composition's Definition */
2626
2686
  typeName?: string;
2627
- /** @description List of locales that the composition is available in. If empty, available in all locales */
2687
+ /**
2688
+ * @description List of locales that the composition _or any of its editions_ is available in.
2689
+ * If empty, available in all locales.
2690
+ */
2691
+ locales: string[];
2692
+ /** @description Priority of the composition relative to any editions */
2693
+ editionPriority?: number;
2694
+ /** @description Friendly name of the edition */
2695
+ editionName?: string;
2696
+ /**
2697
+ * @deprecated
2698
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
2699
+ * where the editionID equals the node's compositionID.
2700
+ */
2701
+ editions?: external$i["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
2702
+ };
2703
+ /**
2704
+ * @deprecated
2705
+ * @description Basic information about a composition edition from the context of a project map node
2706
+ */
2707
+ ProjectMapNodeCompositionEditionData: {
2708
+ /**
2709
+ * Format: uuid
2710
+ * @description The UUID of the linked composition
2711
+ */
2712
+ id: string;
2713
+ /** @description Type of the edition instance (public_id of its definition) */
2714
+ type: string;
2715
+ /**
2716
+ * Format: uuid
2717
+ * @description The edition UUID underneath the linked composition
2718
+ */
2719
+ editionId?: string;
2720
+ /** @description Slug pattern of this edition */
2721
+ slug?: string | null;
2722
+ /** @description Friendly name of the linked composition */
2723
+ name: string;
2724
+ /** @description Friendly name of the edition */
2725
+ editionName?: string;
2726
+ /** @description Priority of the edition */
2727
+ editionPriority?: number;
2728
+ /**
2729
+ * @deprecated
2730
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
2731
+ * @enum {string}
2732
+ */
2733
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
2734
+ /**
2735
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
2736
+ * @default screen
2737
+ */
2738
+ icon?: string;
2739
+ /** @description Friendly name of this edition's definition */
2740
+ typeName?: string;
2741
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
2628
2742
  locales: string[];
2629
2743
  /**
2630
2744
  * Format: date-time
@@ -3237,7 +3351,7 @@ interface external$h {
3237
3351
  slots?: {
3238
3352
  [key: string]: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3239
3353
  };
3240
- /** @description The public UUID of the composition */
3354
+ /** @description The ID of the composition */
3241
3355
  _id: string;
3242
3356
  /** @description Slug pattern of this component */
3243
3357
  _slug?: string | null;
@@ -3505,12 +3619,6 @@ interface external$h {
3505
3619
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
3506
3620
  */
3507
3621
  optionalPatternParameter?: boolean;
3508
- /**
3509
- * @description Resolve this data resource with draft mode content. TBD
3510
- *
3511
- * @enum {string}
3512
- */
3513
- dataSourceVariant?: "unpublished";
3514
3622
  variables?: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3515
3623
  };
3516
3624
  /** @description Variable values for a data resource */
@@ -3753,7 +3861,7 @@ interface external$h {
3753
3861
  id?: string;
3754
3862
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
3755
3863
  path?: string;
3756
- /** Composition id to find associated sitemap nodes for */
3864
+ /** Composition id to find associated project map node for */
3757
3865
  compositionId?: string;
3758
3866
  /** Limit the number or records returned by a number */
3759
3867
  limit?: number;
@@ -3972,18 +4080,27 @@ interface external$h {
3972
4080
  */
3973
4081
  id?: string;
3974
4082
  }[];
3975
- /** @description Basic information about a composition from the context of a project map node */
4083
+ /**
4084
+ * @description Basic information about the linked composition from the context of a project map node.
4085
+ * If the linked composition has editions, the editions are included in the `editions` property.
4086
+ */
3976
4087
  ProjectMapNodeCompositionData: {
3977
- /** @description Type of the composition instance (public_id of its definition) */
4088
+ /** @description Type of the linked composition (id of its definition) */
3978
4089
  type: string;
3979
4090
  /**
3980
4091
  * Format: uuid
3981
- * @description The public UUID of the composition
4092
+ * @description The UUID of the linked composition
3982
4093
  */
3983
4094
  id: string;
3984
- /** @description Slug pattern of this composition */
4095
+ /**
4096
+ * Format: uuid
4097
+ * @description The edition UUID underneath the linked composition
4098
+ * This is only present if the composition has not been published, but an edition has
4099
+ */
4100
+ editionId?: string;
4101
+ /** @description Slug pattern of the linked composition or edition */
3985
4102
  slug?: string | null;
3986
- /** @description Friendly name of this composition */
4103
+ /** @description Friendly name of this composition or edition */
3987
4104
  name: string;
3988
4105
  /**
3989
4106
  * @deprecated
@@ -3998,7 +4115,61 @@ interface external$h {
3998
4115
  icon?: string;
3999
4116
  /** @description Friendly name of this Composition's Definition */
4000
4117
  typeName?: string;
4001
- /** @description List of locales that the composition is available in. If empty, available in all locales */
4118
+ /**
4119
+ * @description List of locales that the composition _or any of its editions_ is available in.
4120
+ * If empty, available in all locales.
4121
+ */
4122
+ locales: string[];
4123
+ /** @description Priority of the composition relative to any editions */
4124
+ editionPriority?: number;
4125
+ /** @description Friendly name of the edition */
4126
+ editionName?: string;
4127
+ /**
4128
+ * @deprecated
4129
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
4130
+ * where the editionID equals the node's compositionID.
4131
+ */
4132
+ editions?: external$h["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
4133
+ };
4134
+ /**
4135
+ * @deprecated
4136
+ * @description Basic information about a composition edition from the context of a project map node
4137
+ */
4138
+ ProjectMapNodeCompositionEditionData: {
4139
+ /**
4140
+ * Format: uuid
4141
+ * @description The UUID of the linked composition
4142
+ */
4143
+ id: string;
4144
+ /** @description Type of the edition instance (public_id of its definition) */
4145
+ type: string;
4146
+ /**
4147
+ * Format: uuid
4148
+ * @description The edition UUID underneath the linked composition
4149
+ */
4150
+ editionId?: string;
4151
+ /** @description Slug pattern of this edition */
4152
+ slug?: string | null;
4153
+ /** @description Friendly name of the linked composition */
4154
+ name: string;
4155
+ /** @description Friendly name of the edition */
4156
+ editionName?: string;
4157
+ /** @description Priority of the edition */
4158
+ editionPriority?: number;
4159
+ /**
4160
+ * @deprecated
4161
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
4162
+ * @enum {string}
4163
+ */
4164
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
4165
+ /**
4166
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
4167
+ * @default screen
4168
+ */
4169
+ icon?: string;
4170
+ /** @description Friendly name of this edition's definition */
4171
+ typeName?: string;
4172
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
4002
4173
  locales: string[];
4003
4174
  /**
4004
4175
  * Format: date-time
@@ -4753,7 +4924,7 @@ interface external$g {
4753
4924
  slots?: {
4754
4925
  [key: string]: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
4755
4926
  };
4756
- /** @description The public UUID of the composition */
4927
+ /** @description The ID of the composition */
4757
4928
  _id: string;
4758
4929
  /** @description Slug pattern of this component */
4759
4930
  _slug?: string | null;
@@ -5021,12 +5192,6 @@ interface external$g {
5021
5192
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
5022
5193
  */
5023
5194
  optionalPatternParameter?: boolean;
5024
- /**
5025
- * @description Resolve this data resource with draft mode content. TBD
5026
- *
5027
- * @enum {string}
5028
- */
5029
- dataSourceVariant?: "unpublished";
5030
5195
  variables?: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
5031
5196
  };
5032
5197
  /** @description Variable values for a data resource */
@@ -5269,7 +5434,7 @@ interface external$g {
5269
5434
  id?: string;
5270
5435
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
5271
5436
  path?: string;
5272
- /** Composition id to find associated sitemap nodes for */
5437
+ /** Composition id to find associated project map node for */
5273
5438
  compositionId?: string;
5274
5439
  /** Limit the number or records returned by a number */
5275
5440
  limit?: number;
@@ -5488,18 +5653,27 @@ interface external$g {
5488
5653
  */
5489
5654
  id?: string;
5490
5655
  }[];
5491
- /** @description Basic information about a composition from the context of a project map node */
5656
+ /**
5657
+ * @description Basic information about the linked composition from the context of a project map node.
5658
+ * If the linked composition has editions, the editions are included in the `editions` property.
5659
+ */
5492
5660
  ProjectMapNodeCompositionData: {
5493
- /** @description Type of the composition instance (public_id of its definition) */
5661
+ /** @description Type of the linked composition (id of its definition) */
5494
5662
  type: string;
5495
5663
  /**
5496
5664
  * Format: uuid
5497
- * @description The public UUID of the composition
5665
+ * @description The UUID of the linked composition
5498
5666
  */
5499
5667
  id: string;
5500
- /** @description Slug pattern of this composition */
5668
+ /**
5669
+ * Format: uuid
5670
+ * @description The edition UUID underneath the linked composition
5671
+ * This is only present if the composition has not been published, but an edition has
5672
+ */
5673
+ editionId?: string;
5674
+ /** @description Slug pattern of the linked composition or edition */
5501
5675
  slug?: string | null;
5502
- /** @description Friendly name of this composition */
5676
+ /** @description Friendly name of this composition or edition */
5503
5677
  name: string;
5504
5678
  /**
5505
5679
  * @deprecated
@@ -5514,7 +5688,61 @@ interface external$g {
5514
5688
  icon?: string;
5515
5689
  /** @description Friendly name of this Composition's Definition */
5516
5690
  typeName?: string;
5517
- /** @description List of locales that the composition is available in. If empty, available in all locales */
5691
+ /**
5692
+ * @description List of locales that the composition _or any of its editions_ is available in.
5693
+ * If empty, available in all locales.
5694
+ */
5695
+ locales: string[];
5696
+ /** @description Priority of the composition relative to any editions */
5697
+ editionPriority?: number;
5698
+ /** @description Friendly name of the edition */
5699
+ editionName?: string;
5700
+ /**
5701
+ * @deprecated
5702
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
5703
+ * where the editionID equals the node's compositionID.
5704
+ */
5705
+ editions?: external$g["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
5706
+ };
5707
+ /**
5708
+ * @deprecated
5709
+ * @description Basic information about a composition edition from the context of a project map node
5710
+ */
5711
+ ProjectMapNodeCompositionEditionData: {
5712
+ /**
5713
+ * Format: uuid
5714
+ * @description The UUID of the linked composition
5715
+ */
5716
+ id: string;
5717
+ /** @description Type of the edition instance (public_id of its definition) */
5718
+ type: string;
5719
+ /**
5720
+ * Format: uuid
5721
+ * @description The edition UUID underneath the linked composition
5722
+ */
5723
+ editionId?: string;
5724
+ /** @description Slug pattern of this edition */
5725
+ slug?: string | null;
5726
+ /** @description Friendly name of the linked composition */
5727
+ name: string;
5728
+ /** @description Friendly name of the edition */
5729
+ editionName?: string;
5730
+ /** @description Priority of the edition */
5731
+ editionPriority?: number;
5732
+ /**
5733
+ * @deprecated
5734
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
5735
+ * @enum {string}
5736
+ */
5737
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
5738
+ /**
5739
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
5740
+ * @default screen
5741
+ */
5742
+ icon?: string;
5743
+ /** @description Friendly name of this edition's definition */
5744
+ typeName?: string;
5745
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
5518
5746
  locales: string[];
5519
5747
  /**
5520
5748
  * Format: date-time
@@ -5606,7 +5834,11 @@ interface paths$e {
5606
5834
  get: {
5607
5835
  parameters: {
5608
5836
  query: {
5609
- /** Specify multiple entry IDs to fetch */
5837
+ /**
5838
+ * Specify one or more entry IDs to fetch.
5839
+ * When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
5840
+ * When `versionId` is passed, this parameter is required and must contain only one entry ID.
5841
+ */
5610
5842
  entryIDs?: components$7["parameters"]["entryIDs"];
5611
5843
  /**
5612
5844
  * Specify a historical entry version ID to fetch (retrieved from the entries-history API).
@@ -5706,6 +5938,20 @@ interface paths$e {
5706
5938
  * Example: ?search=hello
5707
5939
  */
5708
5940
  search?: components$7["parameters"]["search"];
5941
+ /**
5942
+ * @deprecated Controls the edition resolution behavior.
5943
+ *
5944
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
5945
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
5946
+ * Without a locale, the default edition is matched
5947
+ *
5948
+ * all: Every edition is returned as a separate row.
5949
+ *
5950
+ * raw: the entryIDs parameter targets exact edition/entry IDs and no edition resolution is performed.
5951
+ * entryIDs MUST be provided with this option.
5952
+ * If versionId is passed, this is always enabled.
5953
+ */
5954
+ editions?: components$7["parameters"]["editions"];
5709
5955
  };
5710
5956
  };
5711
5957
  responses: {
@@ -5774,6 +6020,24 @@ interface paths$e {
5774
6020
  * @description The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
5775
6021
  */
5776
6022
  workflowStageId?: string;
6023
+ /**
6024
+ * Format: uuid
6025
+ * @deprecated
6026
+ * @description The edition ID. When set, this is a child edition of the entry in _id.
6027
+ */
6028
+ editionId?: string;
6029
+ /**
6030
+ * @deprecated
6031
+ * @description The name of the entry or edition as shown in the editions listing.
6032
+ * Describes the purpose of an edition.
6033
+ */
6034
+ editionName?: string;
6035
+ /**
6036
+ * @deprecated
6037
+ * @description The priority of the edition or entry. Higher numbers are higher priority.
6038
+ * When multiple editions enable the same locale, the highest priority edition is used.
6039
+ */
6040
+ editionPriority?: number;
5777
6041
  };
5778
6042
  };
5779
6043
  };
@@ -5794,9 +6058,19 @@ interface paths$e {
5794
6058
  "application/json": {
5795
6059
  /**
5796
6060
  * Format: uuid
5797
- * @description The ID of the entry to delete
6061
+ * @description The ID of the entry to delete.
6062
+ * When editionId is also passed, the entry remains and an edition under it is deleted.
6063
+ * When editionId is omitted, and the entry has editions, all editions will also be deleted along with the entry.
5798
6064
  */
5799
6065
  entryId: string;
6066
+ /**
6067
+ * Format: uuid
6068
+ * @deprecated
6069
+ * @description The edition ID to delete. When set, this deletes a child edition of the entryId.
6070
+ * The entry will remain when an edition is deleted.
6071
+ * If the entry ID is specified as the edition ID, the entry will be deleted _but any other editions will remain_ (this is used for unpublishing).
6072
+ */
6073
+ editionId?: string;
5800
6074
  /**
5801
6075
  * Format: uuid
5802
6076
  * @description The ID of the project the entry to delete belongs to
@@ -5831,7 +6105,7 @@ interface components$7 {
5831
6105
  type: string;
5832
6106
  /**
5833
6107
  * Format: uuid
5834
- * @description The public UUID of the entry
6108
+ * @description The ID of the entry
5835
6109
  */
5836
6110
  _id: string;
5837
6111
  /** @description The name of the entry */
@@ -6016,6 +6290,24 @@ interface components$7 {
6016
6290
  * @enum {string}
6017
6291
  */
6018
6292
  stubType?: "missing" | "tooDeep";
6293
+ /**
6294
+ * Format: uuid
6295
+ * @deprecated
6296
+ * @description The edition ID. When set, this is a child edition of the entry in _id.
6297
+ */
6298
+ editionId?: string;
6299
+ /**
6300
+ * @deprecated
6301
+ * @description The name of the entry or edition as shown in the editions listing.
6302
+ * Describes the purpose of an edition.
6303
+ */
6304
+ editionName?: string;
6305
+ /**
6306
+ * @deprecated
6307
+ * @description The priority of the edition or entry. Higher numbers are higher priority.
6308
+ * When multiple editions enable the same locale, the highest priority edition is used.
6309
+ */
6310
+ editionPriority?: number;
6019
6311
  };
6020
6312
  EntryListResponse: {
6021
6313
  entries: components$7["schemas"]["EntryApiResponse"][];
@@ -6026,7 +6318,11 @@ interface components$7 {
6026
6318
  parameters: {
6027
6319
  /** @description The project the entry/entries are on */
6028
6320
  projectId: string;
6029
- /** @description Specify multiple entry IDs to fetch */
6321
+ /**
6322
+ * @description Specify one or more entry IDs to fetch.
6323
+ * When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
6324
+ * When `versionId` is passed, this parameter is required and must contain only one entry ID.
6325
+ */
6030
6326
  entryIDs: string[];
6031
6327
  /**
6032
6328
  * @description Specify a historical entry version ID to fetch (retrieved from the entries-history API).
@@ -6129,6 +6425,21 @@ interface components$7 {
6129
6425
  * Example: ?search=hello
6130
6426
  */
6131
6427
  search: string;
6428
+ /**
6429
+ * @deprecated
6430
+ * @description Controls the edition resolution behavior.
6431
+ *
6432
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
6433
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
6434
+ * Without a locale, the default edition is matched
6435
+ *
6436
+ * all: Every edition is returned as a separate row.
6437
+ *
6438
+ * raw: the entryIDs parameter targets exact edition/entry IDs and no edition resolution is performed.
6439
+ * entryIDs MUST be provided with this option.
6440
+ * If versionId is passed, this is always enabled.
6441
+ */
6442
+ editions: "auto" | "all" | "raw";
6132
6443
  };
6133
6444
  }
6134
6445
  interface external$f {
@@ -6590,7 +6901,7 @@ interface external$f {
6590
6901
  slots?: {
6591
6902
  [key: string]: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
6592
6903
  };
6593
- /** @description The public UUID of the composition */
6904
+ /** @description The ID of the composition */
6594
6905
  _id: string;
6595
6906
  /** @description Slug pattern of this component */
6596
6907
  _slug?: string | null;
@@ -6858,12 +7169,6 @@ interface external$f {
6858
7169
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
6859
7170
  */
6860
7171
  optionalPatternParameter?: boolean;
6861
- /**
6862
- * @description Resolve this data resource with draft mode content. TBD
6863
- *
6864
- * @enum {string}
6865
- */
6866
- dataSourceVariant?: "unpublished";
6867
7172
  variables?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
6868
7173
  };
6869
7174
  /** @description Variable values for a data resource */
@@ -7106,7 +7411,7 @@ interface external$f {
7106
7411
  id?: string;
7107
7412
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
7108
7413
  path?: string;
7109
- /** Composition id to find associated sitemap nodes for */
7414
+ /** Composition id to find associated project map node for */
7110
7415
  compositionId?: string;
7111
7416
  /** Limit the number or records returned by a number */
7112
7417
  limit?: number;
@@ -7325,18 +7630,27 @@ interface external$f {
7325
7630
  */
7326
7631
  id?: string;
7327
7632
  }[];
7328
- /** @description Basic information about a composition from the context of a project map node */
7633
+ /**
7634
+ * @description Basic information about the linked composition from the context of a project map node.
7635
+ * If the linked composition has editions, the editions are included in the `editions` property.
7636
+ */
7329
7637
  ProjectMapNodeCompositionData: {
7330
- /** @description Type of the composition instance (public_id of its definition) */
7638
+ /** @description Type of the linked composition (id of its definition) */
7331
7639
  type: string;
7332
7640
  /**
7333
7641
  * Format: uuid
7334
- * @description The public UUID of the composition
7642
+ * @description The UUID of the linked composition
7335
7643
  */
7336
7644
  id: string;
7337
- /** @description Slug pattern of this composition */
7645
+ /**
7646
+ * Format: uuid
7647
+ * @description The edition UUID underneath the linked composition
7648
+ * This is only present if the composition has not been published, but an edition has
7649
+ */
7650
+ editionId?: string;
7651
+ /** @description Slug pattern of the linked composition or edition */
7338
7652
  slug?: string | null;
7339
- /** @description Friendly name of this composition */
7653
+ /** @description Friendly name of this composition or edition */
7340
7654
  name: string;
7341
7655
  /**
7342
7656
  * @deprecated
@@ -7351,7 +7665,61 @@ interface external$f {
7351
7665
  icon?: string;
7352
7666
  /** @description Friendly name of this Composition's Definition */
7353
7667
  typeName?: string;
7354
- /** @description List of locales that the composition is available in. If empty, available in all locales */
7668
+ /**
7669
+ * @description List of locales that the composition _or any of its editions_ is available in.
7670
+ * If empty, available in all locales.
7671
+ */
7672
+ locales: string[];
7673
+ /** @description Priority of the composition relative to any editions */
7674
+ editionPriority?: number;
7675
+ /** @description Friendly name of the edition */
7676
+ editionName?: string;
7677
+ /**
7678
+ * @deprecated
7679
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
7680
+ * where the editionID equals the node's compositionID.
7681
+ */
7682
+ editions?: external$f["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
7683
+ };
7684
+ /**
7685
+ * @deprecated
7686
+ * @description Basic information about a composition edition from the context of a project map node
7687
+ */
7688
+ ProjectMapNodeCompositionEditionData: {
7689
+ /**
7690
+ * Format: uuid
7691
+ * @description The UUID of the linked composition
7692
+ */
7693
+ id: string;
7694
+ /** @description Type of the edition instance (public_id of its definition) */
7695
+ type: string;
7696
+ /**
7697
+ * Format: uuid
7698
+ * @description The edition UUID underneath the linked composition
7699
+ */
7700
+ editionId?: string;
7701
+ /** @description Slug pattern of this edition */
7702
+ slug?: string | null;
7703
+ /** @description Friendly name of the linked composition */
7704
+ name: string;
7705
+ /** @description Friendly name of the edition */
7706
+ editionName?: string;
7707
+ /** @description Priority of the edition */
7708
+ editionPriority?: number;
7709
+ /**
7710
+ * @deprecated
7711
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
7712
+ * @enum {string}
7713
+ */
7714
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
7715
+ /**
7716
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
7717
+ * @default screen
7718
+ */
7719
+ icon?: string;
7720
+ /** @description Friendly name of this edition's definition */
7721
+ typeName?: string;
7722
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
7355
7723
  locales: string[];
7356
7724
  /**
7357
7725
  * Format: date-time
@@ -7445,6 +7813,8 @@ interface paths$d {
7445
7813
  query: {
7446
7814
  /** Specify the entry ID to get history for */
7447
7815
  entryId: string;
7816
+ /** @deprecated The edition ID. When set, gets history for a child edition of the entryId. */
7817
+ editionId?: string;
7448
7818
  /** The project the entries(s) are on. */
7449
7819
  projectId: string;
7450
7820
  /** If a request returns a cursor, pass it in this query parameter to get the next page of results. */
@@ -7934,7 +8304,7 @@ interface external$e {
7934
8304
  slots?: {
7935
8305
  [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
7936
8306
  };
7937
- /** @description The public UUID of the composition */
8307
+ /** @description The ID of the composition */
7938
8308
  _id: string;
7939
8309
  /** @description Slug pattern of this component */
7940
8310
  _slug?: string | null;
@@ -8202,12 +8572,6 @@ interface external$e {
8202
8572
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
8203
8573
  */
8204
8574
  optionalPatternParameter?: boolean;
8205
- /**
8206
- * @description Resolve this data resource with draft mode content. TBD
8207
- *
8208
- * @enum {string}
8209
- */
8210
- dataSourceVariant?: "unpublished";
8211
8575
  variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
8212
8576
  };
8213
8577
  /** @description Variable values for a data resource */
@@ -8450,7 +8814,7 @@ interface external$e {
8450
8814
  id?: string;
8451
8815
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
8452
8816
  path?: string;
8453
- /** Composition id to find associated sitemap nodes for */
8817
+ /** Composition id to find associated project map node for */
8454
8818
  compositionId?: string;
8455
8819
  /** Limit the number or records returned by a number */
8456
8820
  limit?: number;
@@ -8669,18 +9033,27 @@ interface external$e {
8669
9033
  */
8670
9034
  id?: string;
8671
9035
  }[];
8672
- /** @description Basic information about a composition from the context of a project map node */
9036
+ /**
9037
+ * @description Basic information about the linked composition from the context of a project map node.
9038
+ * If the linked composition has editions, the editions are included in the `editions` property.
9039
+ */
8673
9040
  ProjectMapNodeCompositionData: {
8674
- /** @description Type of the composition instance (public_id of its definition) */
9041
+ /** @description Type of the linked composition (id of its definition) */
8675
9042
  type: string;
8676
9043
  /**
8677
9044
  * Format: uuid
8678
- * @description The public UUID of the composition
9045
+ * @description The UUID of the linked composition
8679
9046
  */
8680
9047
  id: string;
8681
- /** @description Slug pattern of this composition */
9048
+ /**
9049
+ * Format: uuid
9050
+ * @description The edition UUID underneath the linked composition
9051
+ * This is only present if the composition has not been published, but an edition has
9052
+ */
9053
+ editionId?: string;
9054
+ /** @description Slug pattern of the linked composition or edition */
8682
9055
  slug?: string | null;
8683
- /** @description Friendly name of this composition */
9056
+ /** @description Friendly name of this composition or edition */
8684
9057
  name: string;
8685
9058
  /**
8686
9059
  * @deprecated
@@ -8695,15 +9068,69 @@ interface external$e {
8695
9068
  icon?: string;
8696
9069
  /** @description Friendly name of this Composition's Definition */
8697
9070
  typeName?: string;
8698
- /** @description List of locales that the composition is available in. If empty, available in all locales */
9071
+ /**
9072
+ * @description List of locales that the composition _or any of its editions_ is available in.
9073
+ * If empty, available in all locales.
9074
+ */
8699
9075
  locales: string[];
9076
+ /** @description Priority of the composition relative to any editions */
9077
+ editionPriority?: number;
9078
+ /** @description Friendly name of the edition */
9079
+ editionName?: string;
8700
9080
  /**
8701
- * Format: date-time
8702
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
9081
+ * @deprecated
9082
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
9083
+ * where the editionID equals the node's compositionID.
8703
9084
  */
8704
- modified?: string;
9085
+ editions?: external$e["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
8705
9086
  };
8706
- ProjectMapNodeUpdate: {
9087
+ /**
9088
+ * @deprecated
9089
+ * @description Basic information about a composition edition from the context of a project map node
9090
+ */
9091
+ ProjectMapNodeCompositionEditionData: {
9092
+ /**
9093
+ * Format: uuid
9094
+ * @description The UUID of the linked composition
9095
+ */
9096
+ id: string;
9097
+ /** @description Type of the edition instance (public_id of its definition) */
9098
+ type: string;
9099
+ /**
9100
+ * Format: uuid
9101
+ * @description The edition UUID underneath the linked composition
9102
+ */
9103
+ editionId?: string;
9104
+ /** @description Slug pattern of this edition */
9105
+ slug?: string | null;
9106
+ /** @description Friendly name of the linked composition */
9107
+ name: string;
9108
+ /** @description Friendly name of the edition */
9109
+ editionName?: string;
9110
+ /** @description Priority of the edition */
9111
+ editionPriority?: number;
9112
+ /**
9113
+ * @deprecated
9114
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
9115
+ * @enum {string}
9116
+ */
9117
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
9118
+ /**
9119
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
9120
+ * @default screen
9121
+ */
9122
+ icon?: string;
9123
+ /** @description Friendly name of this edition's definition */
9124
+ typeName?: string;
9125
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
9126
+ locales: string[];
9127
+ /**
9128
+ * Format: date-time
9129
+ * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
9130
+ */
9131
+ modified?: string;
9132
+ };
9133
+ ProjectMapNodeUpdate: {
8707
9134
  /**
8708
9135
  * Format: uuid
8709
9136
  * @description The id of the projectMap entry
@@ -9335,7 +9762,7 @@ interface external$d {
9335
9762
  slots?: {
9336
9763
  [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
9337
9764
  };
9338
- /** @description The public UUID of the composition */
9765
+ /** @description The ID of the composition */
9339
9766
  _id: string;
9340
9767
  /** @description Slug pattern of this component */
9341
9768
  _slug?: string | null;
@@ -9603,12 +10030,6 @@ interface external$d {
9603
10030
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
9604
10031
  */
9605
10032
  optionalPatternParameter?: boolean;
9606
- /**
9607
- * @description Resolve this data resource with draft mode content. TBD
9608
- *
9609
- * @enum {string}
9610
- */
9611
- dataSourceVariant?: "unpublished";
9612
10033
  variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
9613
10034
  };
9614
10035
  /** @description Variable values for a data resource */
@@ -9851,7 +10272,7 @@ interface external$d {
9851
10272
  id?: string;
9852
10273
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
9853
10274
  path?: string;
9854
- /** Composition id to find associated sitemap nodes for */
10275
+ /** Composition id to find associated project map node for */
9855
10276
  compositionId?: string;
9856
10277
  /** Limit the number or records returned by a number */
9857
10278
  limit?: number;
@@ -10070,18 +10491,27 @@ interface external$d {
10070
10491
  */
10071
10492
  id?: string;
10072
10493
  }[];
10073
- /** @description Basic information about a composition from the context of a project map node */
10494
+ /**
10495
+ * @description Basic information about the linked composition from the context of a project map node.
10496
+ * If the linked composition has editions, the editions are included in the `editions` property.
10497
+ */
10074
10498
  ProjectMapNodeCompositionData: {
10075
- /** @description Type of the composition instance (public_id of its definition) */
10499
+ /** @description Type of the linked composition (id of its definition) */
10076
10500
  type: string;
10077
10501
  /**
10078
10502
  * Format: uuid
10079
- * @description The public UUID of the composition
10503
+ * @description The UUID of the linked composition
10080
10504
  */
10081
10505
  id: string;
10082
- /** @description Slug pattern of this composition */
10506
+ /**
10507
+ * Format: uuid
10508
+ * @description The edition UUID underneath the linked composition
10509
+ * This is only present if the composition has not been published, but an edition has
10510
+ */
10511
+ editionId?: string;
10512
+ /** @description Slug pattern of the linked composition or edition */
10083
10513
  slug?: string | null;
10084
- /** @description Friendly name of this composition */
10514
+ /** @description Friendly name of this composition or edition */
10085
10515
  name: string;
10086
10516
  /**
10087
10517
  * @deprecated
@@ -10096,7 +10526,61 @@ interface external$d {
10096
10526
  icon?: string;
10097
10527
  /** @description Friendly name of this Composition's Definition */
10098
10528
  typeName?: string;
10099
- /** @description List of locales that the composition is available in. If empty, available in all locales */
10529
+ /**
10530
+ * @description List of locales that the composition _or any of its editions_ is available in.
10531
+ * If empty, available in all locales.
10532
+ */
10533
+ locales: string[];
10534
+ /** @description Priority of the composition relative to any editions */
10535
+ editionPriority?: number;
10536
+ /** @description Friendly name of the edition */
10537
+ editionName?: string;
10538
+ /**
10539
+ * @deprecated
10540
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
10541
+ * where the editionID equals the node's compositionID.
10542
+ */
10543
+ editions?: external$d["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
10544
+ };
10545
+ /**
10546
+ * @deprecated
10547
+ * @description Basic information about a composition edition from the context of a project map node
10548
+ */
10549
+ ProjectMapNodeCompositionEditionData: {
10550
+ /**
10551
+ * Format: uuid
10552
+ * @description The UUID of the linked composition
10553
+ */
10554
+ id: string;
10555
+ /** @description Type of the edition instance (public_id of its definition) */
10556
+ type: string;
10557
+ /**
10558
+ * Format: uuid
10559
+ * @description The edition UUID underneath the linked composition
10560
+ */
10561
+ editionId?: string;
10562
+ /** @description Slug pattern of this edition */
10563
+ slug?: string | null;
10564
+ /** @description Friendly name of the linked composition */
10565
+ name: string;
10566
+ /** @description Friendly name of the edition */
10567
+ editionName?: string;
10568
+ /** @description Priority of the edition */
10569
+ editionPriority?: number;
10570
+ /**
10571
+ * @deprecated
10572
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
10573
+ * @enum {string}
10574
+ */
10575
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
10576
+ /**
10577
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
10578
+ * @default screen
10579
+ */
10580
+ icon?: string;
10581
+ /** @description Friendly name of this edition's definition */
10582
+ typeName?: string;
10583
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
10100
10584
  locales: string[];
10101
10585
  /**
10102
10586
  * Format: date-time
@@ -10673,7 +11157,7 @@ interface external$c {
10673
11157
  slots?: {
10674
11158
  [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
10675
11159
  };
10676
- /** @description The public UUID of the composition */
11160
+ /** @description The ID of the composition */
10677
11161
  _id: string;
10678
11162
  /** @description Slug pattern of this component */
10679
11163
  _slug?: string | null;
@@ -10941,12 +11425,6 @@ interface external$c {
10941
11425
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
10942
11426
  */
10943
11427
  optionalPatternParameter?: boolean;
10944
- /**
10945
- * @description Resolve this data resource with draft mode content. TBD
10946
- *
10947
- * @enum {string}
10948
- */
10949
- dataSourceVariant?: "unpublished";
10950
11428
  variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
10951
11429
  };
10952
11430
  /** @description Variable values for a data resource */
@@ -11189,7 +11667,7 @@ interface external$c {
11189
11667
  id?: string;
11190
11668
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
11191
11669
  path?: string;
11192
- /** Composition id to find associated sitemap nodes for */
11670
+ /** Composition id to find associated project map node for */
11193
11671
  compositionId?: string;
11194
11672
  /** Limit the number or records returned by a number */
11195
11673
  limit?: number;
@@ -11408,18 +11886,27 @@ interface external$c {
11408
11886
  */
11409
11887
  id?: string;
11410
11888
  }[];
11411
- /** @description Basic information about a composition from the context of a project map node */
11889
+ /**
11890
+ * @description Basic information about the linked composition from the context of a project map node.
11891
+ * If the linked composition has editions, the editions are included in the `editions` property.
11892
+ */
11412
11893
  ProjectMapNodeCompositionData: {
11413
- /** @description Type of the composition instance (public_id of its definition) */
11894
+ /** @description Type of the linked composition (id of its definition) */
11414
11895
  type: string;
11415
11896
  /**
11416
11897
  * Format: uuid
11417
- * @description The public UUID of the composition
11898
+ * @description The UUID of the linked composition
11418
11899
  */
11419
11900
  id: string;
11420
- /** @description Slug pattern of this composition */
11901
+ /**
11902
+ * Format: uuid
11903
+ * @description The edition UUID underneath the linked composition
11904
+ * This is only present if the composition has not been published, but an edition has
11905
+ */
11906
+ editionId?: string;
11907
+ /** @description Slug pattern of the linked composition or edition */
11421
11908
  slug?: string | null;
11422
- /** @description Friendly name of this composition */
11909
+ /** @description Friendly name of this composition or edition */
11423
11910
  name: string;
11424
11911
  /**
11425
11912
  * @deprecated
@@ -11434,7 +11921,61 @@ interface external$c {
11434
11921
  icon?: string;
11435
11922
  /** @description Friendly name of this Composition's Definition */
11436
11923
  typeName?: string;
11437
- /** @description List of locales that the composition is available in. If empty, available in all locales */
11924
+ /**
11925
+ * @description List of locales that the composition _or any of its editions_ is available in.
11926
+ * If empty, available in all locales.
11927
+ */
11928
+ locales: string[];
11929
+ /** @description Priority of the composition relative to any editions */
11930
+ editionPriority?: number;
11931
+ /** @description Friendly name of the edition */
11932
+ editionName?: string;
11933
+ /**
11934
+ * @deprecated
11935
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
11936
+ * where the editionID equals the node's compositionID.
11937
+ */
11938
+ editions?: external$c["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
11939
+ };
11940
+ /**
11941
+ * @deprecated
11942
+ * @description Basic information about a composition edition from the context of a project map node
11943
+ */
11944
+ ProjectMapNodeCompositionEditionData: {
11945
+ /**
11946
+ * Format: uuid
11947
+ * @description The UUID of the linked composition
11948
+ */
11949
+ id: string;
11950
+ /** @description Type of the edition instance (public_id of its definition) */
11951
+ type: string;
11952
+ /**
11953
+ * Format: uuid
11954
+ * @description The edition UUID underneath the linked composition
11955
+ */
11956
+ editionId?: string;
11957
+ /** @description Slug pattern of this edition */
11958
+ slug?: string | null;
11959
+ /** @description Friendly name of the linked composition */
11960
+ name: string;
11961
+ /** @description Friendly name of the edition */
11962
+ editionName?: string;
11963
+ /** @description Priority of the edition */
11964
+ editionPriority?: number;
11965
+ /**
11966
+ * @deprecated
11967
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
11968
+ * @enum {string}
11969
+ */
11970
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
11971
+ /**
11972
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
11973
+ * @default screen
11974
+ */
11975
+ icon?: string;
11976
+ /** @description Friendly name of this edition's definition */
11977
+ typeName?: string;
11978
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
11438
11979
  locales: string[];
11439
11980
  /**
11440
11981
  * Format: date-time
@@ -12046,7 +12587,7 @@ interface external$b {
12046
12587
  slots?: {
12047
12588
  [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
12048
12589
  };
12049
- /** @description The public UUID of the composition */
12590
+ /** @description The ID of the composition */
12050
12591
  _id: string;
12051
12592
  /** @description Slug pattern of this component */
12052
12593
  _slug?: string | null;
@@ -12314,12 +12855,6 @@ interface external$b {
12314
12855
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
12315
12856
  */
12316
12857
  optionalPatternParameter?: boolean;
12317
- /**
12318
- * @description Resolve this data resource with draft mode content. TBD
12319
- *
12320
- * @enum {string}
12321
- */
12322
- dataSourceVariant?: "unpublished";
12323
12858
  variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
12324
12859
  };
12325
12860
  /** @description Variable values for a data resource */
@@ -12562,7 +13097,7 @@ interface external$b {
12562
13097
  id?: string;
12563
13098
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
12564
13099
  path?: string;
12565
- /** Composition id to find associated sitemap nodes for */
13100
+ /** Composition id to find associated project map node for */
12566
13101
  compositionId?: string;
12567
13102
  /** Limit the number or records returned by a number */
12568
13103
  limit?: number;
@@ -12781,18 +13316,27 @@ interface external$b {
12781
13316
  */
12782
13317
  id?: string;
12783
13318
  }[];
12784
- /** @description Basic information about a composition from the context of a project map node */
13319
+ /**
13320
+ * @description Basic information about the linked composition from the context of a project map node.
13321
+ * If the linked composition has editions, the editions are included in the `editions` property.
13322
+ */
12785
13323
  ProjectMapNodeCompositionData: {
12786
- /** @description Type of the composition instance (public_id of its definition) */
13324
+ /** @description Type of the linked composition (id of its definition) */
12787
13325
  type: string;
12788
13326
  /**
12789
13327
  * Format: uuid
12790
- * @description The public UUID of the composition
13328
+ * @description The UUID of the linked composition
12791
13329
  */
12792
13330
  id: string;
12793
- /** @description Slug pattern of this composition */
13331
+ /**
13332
+ * Format: uuid
13333
+ * @description The edition UUID underneath the linked composition
13334
+ * This is only present if the composition has not been published, but an edition has
13335
+ */
13336
+ editionId?: string;
13337
+ /** @description Slug pattern of the linked composition or edition */
12794
13338
  slug?: string | null;
12795
- /** @description Friendly name of this composition */
13339
+ /** @description Friendly name of this composition or edition */
12796
13340
  name: string;
12797
13341
  /**
12798
13342
  * @deprecated
@@ -12807,7 +13351,61 @@ interface external$b {
12807
13351
  icon?: string;
12808
13352
  /** @description Friendly name of this Composition's Definition */
12809
13353
  typeName?: string;
12810
- /** @description List of locales that the composition is available in. If empty, available in all locales */
13354
+ /**
13355
+ * @description List of locales that the composition _or any of its editions_ is available in.
13356
+ * If empty, available in all locales.
13357
+ */
13358
+ locales: string[];
13359
+ /** @description Priority of the composition relative to any editions */
13360
+ editionPriority?: number;
13361
+ /** @description Friendly name of the edition */
13362
+ editionName?: string;
13363
+ /**
13364
+ * @deprecated
13365
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
13366
+ * where the editionID equals the node's compositionID.
13367
+ */
13368
+ editions?: external$b["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
13369
+ };
13370
+ /**
13371
+ * @deprecated
13372
+ * @description Basic information about a composition edition from the context of a project map node
13373
+ */
13374
+ ProjectMapNodeCompositionEditionData: {
13375
+ /**
13376
+ * Format: uuid
13377
+ * @description The UUID of the linked composition
13378
+ */
13379
+ id: string;
13380
+ /** @description Type of the edition instance (public_id of its definition) */
13381
+ type: string;
13382
+ /**
13383
+ * Format: uuid
13384
+ * @description The edition UUID underneath the linked composition
13385
+ */
13386
+ editionId?: string;
13387
+ /** @description Slug pattern of this edition */
13388
+ slug?: string | null;
13389
+ /** @description Friendly name of the linked composition */
13390
+ name: string;
13391
+ /** @description Friendly name of the edition */
13392
+ editionName?: string;
13393
+ /** @description Priority of the edition */
13394
+ editionPriority?: number;
13395
+ /**
13396
+ * @deprecated
13397
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
13398
+ * @enum {string}
13399
+ */
13400
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
13401
+ /**
13402
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
13403
+ * @default screen
13404
+ */
13405
+ icon?: string;
13406
+ /** @description Friendly name of this edition's definition */
13407
+ typeName?: string;
13408
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
12811
13409
  locales: string[];
12812
13410
  /**
12813
13411
  * Format: date-time
@@ -13419,7 +14017,7 @@ interface external$a {
13419
14017
  slots?: {
13420
14018
  [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
13421
14019
  };
13422
- /** @description The public UUID of the composition */
14020
+ /** @description The ID of the composition */
13423
14021
  _id: string;
13424
14022
  /** @description Slug pattern of this component */
13425
14023
  _slug?: string | null;
@@ -13687,12 +14285,6 @@ interface external$a {
13687
14285
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
13688
14286
  */
13689
14287
  optionalPatternParameter?: boolean;
13690
- /**
13691
- * @description Resolve this data resource with draft mode content. TBD
13692
- *
13693
- * @enum {string}
13694
- */
13695
- dataSourceVariant?: "unpublished";
13696
14288
  variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
13697
14289
  };
13698
14290
  /** @description Variable values for a data resource */
@@ -13935,7 +14527,7 @@ interface external$a {
13935
14527
  id?: string;
13936
14528
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
13937
14529
  path?: string;
13938
- /** Composition id to find associated sitemap nodes for */
14530
+ /** Composition id to find associated project map node for */
13939
14531
  compositionId?: string;
13940
14532
  /** Limit the number or records returned by a number */
13941
14533
  limit?: number;
@@ -14154,18 +14746,27 @@ interface external$a {
14154
14746
  */
14155
14747
  id?: string;
14156
14748
  }[];
14157
- /** @description Basic information about a composition from the context of a project map node */
14749
+ /**
14750
+ * @description Basic information about the linked composition from the context of a project map node.
14751
+ * If the linked composition has editions, the editions are included in the `editions` property.
14752
+ */
14158
14753
  ProjectMapNodeCompositionData: {
14159
- /** @description Type of the composition instance (public_id of its definition) */
14754
+ /** @description Type of the linked composition (id of its definition) */
14160
14755
  type: string;
14161
14756
  /**
14162
14757
  * Format: uuid
14163
- * @description The public UUID of the composition
14758
+ * @description The UUID of the linked composition
14164
14759
  */
14165
14760
  id: string;
14166
- /** @description Slug pattern of this composition */
14761
+ /**
14762
+ * Format: uuid
14763
+ * @description The edition UUID underneath the linked composition
14764
+ * This is only present if the composition has not been published, but an edition has
14765
+ */
14766
+ editionId?: string;
14767
+ /** @description Slug pattern of the linked composition or edition */
14167
14768
  slug?: string | null;
14168
- /** @description Friendly name of this composition */
14769
+ /** @description Friendly name of this composition or edition */
14169
14770
  name: string;
14170
14771
  /**
14171
14772
  * @deprecated
@@ -14180,7 +14781,61 @@ interface external$a {
14180
14781
  icon?: string;
14181
14782
  /** @description Friendly name of this Composition's Definition */
14182
14783
  typeName?: string;
14183
- /** @description List of locales that the composition is available in. If empty, available in all locales */
14784
+ /**
14785
+ * @description List of locales that the composition _or any of its editions_ is available in.
14786
+ * If empty, available in all locales.
14787
+ */
14788
+ locales: string[];
14789
+ /** @description Priority of the composition relative to any editions */
14790
+ editionPriority?: number;
14791
+ /** @description Friendly name of the edition */
14792
+ editionName?: string;
14793
+ /**
14794
+ * @deprecated
14795
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
14796
+ * where the editionID equals the node's compositionID.
14797
+ */
14798
+ editions?: external$a["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
14799
+ };
14800
+ /**
14801
+ * @deprecated
14802
+ * @description Basic information about a composition edition from the context of a project map node
14803
+ */
14804
+ ProjectMapNodeCompositionEditionData: {
14805
+ /**
14806
+ * Format: uuid
14807
+ * @description The UUID of the linked composition
14808
+ */
14809
+ id: string;
14810
+ /** @description Type of the edition instance (public_id of its definition) */
14811
+ type: string;
14812
+ /**
14813
+ * Format: uuid
14814
+ * @description The edition UUID underneath the linked composition
14815
+ */
14816
+ editionId?: string;
14817
+ /** @description Slug pattern of this edition */
14818
+ slug?: string | null;
14819
+ /** @description Friendly name of the linked composition */
14820
+ name: string;
14821
+ /** @description Friendly name of the edition */
14822
+ editionName?: string;
14823
+ /** @description Priority of the edition */
14824
+ editionPriority?: number;
14825
+ /**
14826
+ * @deprecated
14827
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
14828
+ * @enum {string}
14829
+ */
14830
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
14831
+ /**
14832
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
14833
+ * @default screen
14834
+ */
14835
+ icon?: string;
14836
+ /** @description Friendly name of this edition's definition */
14837
+ typeName?: string;
14838
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
14184
14839
  locales: string[];
14185
14840
  /**
14186
14841
  * Format: date-time
@@ -14493,7 +15148,8 @@ interface paths$7 {
14493
15148
  query: {
14494
15149
  /**
14495
15150
  * Specify a single composition ID to fetch. The response will be a single composition.
14496
- * This is a primary query parameter and cannot be used with any other primary query parameters
15151
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
15152
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
14497
15153
  */
14498
15154
  compositionId?: components$5["parameters"]["compositionId"];
14499
15155
  /**
@@ -14508,7 +15164,8 @@ interface paths$7 {
14508
15164
  versionId?: components$5["parameters"]["versionId"];
14509
15165
  /**
14510
15166
  * Specify multiple composition IDs to fetch. The response type will be a list.
14511
- * This is a primary query parameter and cannot be used with any other primary query parameters
15167
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
15168
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
14512
15169
  */
14513
15170
  compositionIDs?: components$5["parameters"]["compositionIDs"];
14514
15171
  /**
@@ -14678,6 +15335,21 @@ interface paths$7 {
14678
15335
  * Example: ?search=hello
14679
15336
  */
14680
15337
  search?: components$5["parameters"]["search"];
15338
+ /**
15339
+ * @deprecated Controls the edition resolution behavior.
15340
+ *
15341
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
15342
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
15343
+ * Without a locale, the default edition is matched
15344
+ *
15345
+ * all: Every edition is returned as a separate row.
15346
+ * Note: this has no effect when used with compositionId which always returns a single result.
15347
+ *
15348
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
15349
+ * compositionId or compositionIDs MUST be provided with this option.
15350
+ * If versionId is passed, this is always enabled.
15351
+ */
15352
+ editions?: components$5["parameters"]["editions"];
14681
15353
  };
14682
15354
  };
14683
15355
  responses: {
@@ -14762,6 +15434,24 @@ interface paths$7 {
14762
15434
  * @description The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
14763
15435
  */
14764
15436
  workflowStageId?: string;
15437
+ /**
15438
+ * Format: uuid
15439
+ * @deprecated
15440
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
15441
+ */
15442
+ editionId?: string;
15443
+ /**
15444
+ * @deprecated
15445
+ * @description The name of the composition or edition as shown in the editions listing.
15446
+ * Describes the purpose of an edition.
15447
+ */
15448
+ editionName?: string;
15449
+ /**
15450
+ * @deprecated
15451
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
15452
+ * When multiple editions enable the same locale, the highest priority edition is used.
15453
+ */
15454
+ editionPriority?: number;
14765
15455
  };
14766
15456
  };
14767
15457
  };
@@ -14782,9 +15472,19 @@ interface paths$7 {
14782
15472
  "application/json": {
14783
15473
  /**
14784
15474
  * Format: uuid
14785
- * @description The ID of the composition to delete
15475
+ * @description The ID of the composition to delete.
15476
+ * When editionId is also passed, the composition remains and an edition under it is deleted.
15477
+ * When editionId is omitted, and the composition has editions, all editions will also be deleted along with the composition.
14786
15478
  */
14787
15479
  compositionId: string;
15480
+ /**
15481
+ * Format: uuid
15482
+ * @deprecated
15483
+ * @description The edition ID to delete. When set, this deletes a child edition of the compositionId.
15484
+ * The composition will remain when an edition is deleted.
15485
+ * If the composition ID is specified as the edition ID, the composition will be deleted _but any other editions will remain_ (this is used for unpublishing).
15486
+ */
15487
+ editionId?: string;
14788
15488
  /**
14789
15489
  * Format: uuid
14790
15490
  * @description The ID of the project the composition to delete belongs to
@@ -14875,6 +15575,24 @@ interface components$5 {
14875
15575
  workflowStageId?: string;
14876
15576
  /** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
14877
15577
  workflowDefinition?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowDefinition"];
15578
+ /**
15579
+ * Format: uuid
15580
+ * @deprecated
15581
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
15582
+ */
15583
+ editionId?: string;
15584
+ /**
15585
+ * @deprecated
15586
+ * @description The name of the composition or edition as shown in the editions listing.
15587
+ * Describes the purpose of an edition.
15588
+ */
15589
+ editionName?: string;
15590
+ /**
15591
+ * @deprecated
15592
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
15593
+ * When multiple editions enable the same locale, the highest priority edition is used.
15594
+ */
15595
+ editionPriority?: number;
14878
15596
  };
14879
15597
  CompositionListResponse: {
14880
15598
  compositions: components$5["schemas"]["CompositionApiResponse"][];
@@ -14887,7 +15605,8 @@ interface components$5 {
14887
15605
  projectId: string;
14888
15606
  /**
14889
15607
  * @description Specify a single composition ID to fetch. The response will be a single composition.
14890
- * This is a primary query parameter and cannot be used with any other primary query parameters
15608
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
15609
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
14891
15610
  */
14892
15611
  compositionId: string;
14893
15612
  /**
@@ -14897,7 +15616,8 @@ interface components$5 {
14897
15616
  componentId: string;
14898
15617
  /**
14899
15618
  * @description Specify multiple composition IDs to fetch. The response type will be a list.
14900
- * This is a primary query parameter and cannot be used with any other primary query parameters
15619
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
15620
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
14901
15621
  */
14902
15622
  compositionIDs: string[];
14903
15623
  /**
@@ -15082,6 +15802,22 @@ interface components$5 {
15082
15802
  * Example: ?search=hello
15083
15803
  */
15084
15804
  search: string;
15805
+ /**
15806
+ * @deprecated
15807
+ * @description Controls the edition resolution behavior.
15808
+ *
15809
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
15810
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
15811
+ * Without a locale, the default edition is matched
15812
+ *
15813
+ * all: Every edition is returned as a separate row.
15814
+ * Note: this has no effect when used with compositionId which always returns a single result.
15815
+ *
15816
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
15817
+ * compositionId or compositionIDs MUST be provided with this option.
15818
+ * If versionId is passed, this is always enabled.
15819
+ */
15820
+ editions: "auto" | "all" | "raw";
15085
15821
  };
15086
15822
  }
15087
15823
  interface external$8 {
@@ -15543,7 +16279,7 @@ interface external$8 {
15543
16279
  slots?: {
15544
16280
  [key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
15545
16281
  };
15546
- /** @description The public UUID of the composition */
16282
+ /** @description The ID of the composition */
15547
16283
  _id: string;
15548
16284
  /** @description Slug pattern of this component */
15549
16285
  _slug?: string | null;
@@ -15811,12 +16547,6 @@ interface external$8 {
15811
16547
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
15812
16548
  */
15813
16549
  optionalPatternParameter?: boolean;
15814
- /**
15815
- * @description Resolve this data resource with draft mode content. TBD
15816
- *
15817
- * @enum {string}
15818
- */
15819
- dataSourceVariant?: "unpublished";
15820
16550
  variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
15821
16551
  };
15822
16552
  /** @description Variable values for a data resource */
@@ -16059,7 +16789,7 @@ interface external$8 {
16059
16789
  id?: string;
16060
16790
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
16061
16791
  path?: string;
16062
- /** Composition id to find associated sitemap nodes for */
16792
+ /** Composition id to find associated project map node for */
16063
16793
  compositionId?: string;
16064
16794
  /** Limit the number or records returned by a number */
16065
16795
  limit?: number;
@@ -16278,18 +17008,27 @@ interface external$8 {
16278
17008
  */
16279
17009
  id?: string;
16280
17010
  }[];
16281
- /** @description Basic information about a composition from the context of a project map node */
17011
+ /**
17012
+ * @description Basic information about the linked composition from the context of a project map node.
17013
+ * If the linked composition has editions, the editions are included in the `editions` property.
17014
+ */
16282
17015
  ProjectMapNodeCompositionData: {
16283
- /** @description Type of the composition instance (public_id of its definition) */
17016
+ /** @description Type of the linked composition (id of its definition) */
16284
17017
  type: string;
16285
17018
  /**
16286
17019
  * Format: uuid
16287
- * @description The public UUID of the composition
17020
+ * @description The UUID of the linked composition
16288
17021
  */
16289
17022
  id: string;
16290
- /** @description Slug pattern of this composition */
17023
+ /**
17024
+ * Format: uuid
17025
+ * @description The edition UUID underneath the linked composition
17026
+ * This is only present if the composition has not been published, but an edition has
17027
+ */
17028
+ editionId?: string;
17029
+ /** @description Slug pattern of the linked composition or edition */
16291
17030
  slug?: string | null;
16292
- /** @description Friendly name of this composition */
17031
+ /** @description Friendly name of this composition or edition */
16293
17032
  name: string;
16294
17033
  /**
16295
17034
  * @deprecated
@@ -16304,7 +17043,61 @@ interface external$8 {
16304
17043
  icon?: string;
16305
17044
  /** @description Friendly name of this Composition's Definition */
16306
17045
  typeName?: string;
16307
- /** @description List of locales that the composition is available in. If empty, available in all locales */
17046
+ /**
17047
+ * @description List of locales that the composition _or any of its editions_ is available in.
17048
+ * If empty, available in all locales.
17049
+ */
17050
+ locales: string[];
17051
+ /** @description Priority of the composition relative to any editions */
17052
+ editionPriority?: number;
17053
+ /** @description Friendly name of the edition */
17054
+ editionName?: string;
17055
+ /**
17056
+ * @deprecated
17057
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
17058
+ * where the editionID equals the node's compositionID.
17059
+ */
17060
+ editions?: external$8["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
17061
+ };
17062
+ /**
17063
+ * @deprecated
17064
+ * @description Basic information about a composition edition from the context of a project map node
17065
+ */
17066
+ ProjectMapNodeCompositionEditionData: {
17067
+ /**
17068
+ * Format: uuid
17069
+ * @description The UUID of the linked composition
17070
+ */
17071
+ id: string;
17072
+ /** @description Type of the edition instance (public_id of its definition) */
17073
+ type: string;
17074
+ /**
17075
+ * Format: uuid
17076
+ * @description The edition UUID underneath the linked composition
17077
+ */
17078
+ editionId?: string;
17079
+ /** @description Slug pattern of this edition */
17080
+ slug?: string | null;
17081
+ /** @description Friendly name of the linked composition */
17082
+ name: string;
17083
+ /** @description Friendly name of the edition */
17084
+ editionName?: string;
17085
+ /** @description Priority of the edition */
17086
+ editionPriority?: number;
17087
+ /**
17088
+ * @deprecated
17089
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
17090
+ * @enum {string}
17091
+ */
17092
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
17093
+ /**
17094
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
17095
+ * @default screen
17096
+ */
17097
+ icon?: string;
17098
+ /** @description Friendly name of this edition's definition */
17099
+ typeName?: string;
17100
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
16308
17101
  locales: string[];
16309
17102
  /**
16310
17103
  * Format: date-time
@@ -16398,6 +17191,8 @@ interface paths$6 {
16398
17191
  query: {
16399
17192
  /** Specify the composition ID to get history for */
16400
17193
  compositionId: string;
17194
+ /** @deprecated The edition ID. When set, gets history for a child edition of the compositionId. */
17195
+ editionId?: string;
16401
17196
  /** The project the composition(s) are on */
16402
17197
  projectId: string;
16403
17198
  /** If a request returns a cursor, pass it in this query parameter to get the next page of results */
@@ -16887,7 +17682,7 @@ interface external$7 {
16887
17682
  slots?: {
16888
17683
  [key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
16889
17684
  };
16890
- /** @description The public UUID of the composition */
17685
+ /** @description The ID of the composition */
16891
17686
  _id: string;
16892
17687
  /** @description Slug pattern of this component */
16893
17688
  _slug?: string | null;
@@ -17155,12 +17950,6 @@ interface external$7 {
17155
17950
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
17156
17951
  */
17157
17952
  optionalPatternParameter?: boolean;
17158
- /**
17159
- * @description Resolve this data resource with draft mode content. TBD
17160
- *
17161
- * @enum {string}
17162
- */
17163
- dataSourceVariant?: "unpublished";
17164
17953
  variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
17165
17954
  };
17166
17955
  /** @description Variable values for a data resource */
@@ -17403,7 +18192,7 @@ interface external$7 {
17403
18192
  id?: string;
17404
18193
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
17405
18194
  path?: string;
17406
- /** Composition id to find associated sitemap nodes for */
18195
+ /** Composition id to find associated project map node for */
17407
18196
  compositionId?: string;
17408
18197
  /** Limit the number or records returned by a number */
17409
18198
  limit?: number;
@@ -17622,18 +18411,27 @@ interface external$7 {
17622
18411
  */
17623
18412
  id?: string;
17624
18413
  }[];
17625
- /** @description Basic information about a composition from the context of a project map node */
18414
+ /**
18415
+ * @description Basic information about the linked composition from the context of a project map node.
18416
+ * If the linked composition has editions, the editions are included in the `editions` property.
18417
+ */
17626
18418
  ProjectMapNodeCompositionData: {
17627
- /** @description Type of the composition instance (public_id of its definition) */
18419
+ /** @description Type of the linked composition (id of its definition) */
17628
18420
  type: string;
17629
18421
  /**
17630
18422
  * Format: uuid
17631
- * @description The public UUID of the composition
18423
+ * @description The UUID of the linked composition
17632
18424
  */
17633
18425
  id: string;
17634
- /** @description Slug pattern of this composition */
18426
+ /**
18427
+ * Format: uuid
18428
+ * @description The edition UUID underneath the linked composition
18429
+ * This is only present if the composition has not been published, but an edition has
18430
+ */
18431
+ editionId?: string;
18432
+ /** @description Slug pattern of the linked composition or edition */
17635
18433
  slug?: string | null;
17636
- /** @description Friendly name of this composition */
18434
+ /** @description Friendly name of this composition or edition */
17637
18435
  name: string;
17638
18436
  /**
17639
18437
  * @deprecated
@@ -17648,7 +18446,61 @@ interface external$7 {
17648
18446
  icon?: string;
17649
18447
  /** @description Friendly name of this Composition's Definition */
17650
18448
  typeName?: string;
17651
- /** @description List of locales that the composition is available in. If empty, available in all locales */
18449
+ /**
18450
+ * @description List of locales that the composition _or any of its editions_ is available in.
18451
+ * If empty, available in all locales.
18452
+ */
18453
+ locales: string[];
18454
+ /** @description Priority of the composition relative to any editions */
18455
+ editionPriority?: number;
18456
+ /** @description Friendly name of the edition */
18457
+ editionName?: string;
18458
+ /**
18459
+ * @deprecated
18460
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
18461
+ * where the editionID equals the node's compositionID.
18462
+ */
18463
+ editions?: external$7["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
18464
+ };
18465
+ /**
18466
+ * @deprecated
18467
+ * @description Basic information about a composition edition from the context of a project map node
18468
+ */
18469
+ ProjectMapNodeCompositionEditionData: {
18470
+ /**
18471
+ * Format: uuid
18472
+ * @description The UUID of the linked composition
18473
+ */
18474
+ id: string;
18475
+ /** @description Type of the edition instance (public_id of its definition) */
18476
+ type: string;
18477
+ /**
18478
+ * Format: uuid
18479
+ * @description The edition UUID underneath the linked composition
18480
+ */
18481
+ editionId?: string;
18482
+ /** @description Slug pattern of this edition */
18483
+ slug?: string | null;
18484
+ /** @description Friendly name of the linked composition */
18485
+ name: string;
18486
+ /** @description Friendly name of the edition */
18487
+ editionName?: string;
18488
+ /** @description Priority of the edition */
18489
+ editionPriority?: number;
18490
+ /**
18491
+ * @deprecated
18492
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
18493
+ * @enum {string}
18494
+ */
18495
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
18496
+ /**
18497
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
18498
+ * @default screen
18499
+ */
18500
+ icon?: string;
18501
+ /** @description Friendly name of this edition's definition */
18502
+ typeName?: string;
18503
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
17652
18504
  locales: string[];
17653
18505
  /**
17654
18506
  * Format: date-time
@@ -18388,7 +19240,7 @@ interface external$6 {
18388
19240
  slots?: {
18389
19241
  [key: string]: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
18390
19242
  };
18391
- /** @description The public UUID of the composition */
19243
+ /** @description The ID of the composition */
18392
19244
  _id: string;
18393
19245
  /** @description Slug pattern of this component */
18394
19246
  _slug?: string | null;
@@ -18656,12 +19508,6 @@ interface external$6 {
18656
19508
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
18657
19509
  */
18658
19510
  optionalPatternParameter?: boolean;
18659
- /**
18660
- * @description Resolve this data resource with draft mode content. TBD
18661
- *
18662
- * @enum {string}
18663
- */
18664
- dataSourceVariant?: "unpublished";
18665
19511
  variables?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
18666
19512
  };
18667
19513
  /** @description Variable values for a data resource */
@@ -18888,7 +19734,8 @@ interface external$6 {
18888
19734
  query: {
18889
19735
  /**
18890
19736
  * Specify a single composition ID to fetch. The response will be a single composition.
18891
- * This is a primary query parameter and cannot be used with any other primary query parameters
19737
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
19738
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
18892
19739
  */
18893
19740
  compositionId?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
18894
19741
  /**
@@ -18903,7 +19750,8 @@ interface external$6 {
18903
19750
  versionId?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
18904
19751
  /**
18905
19752
  * Specify multiple composition IDs to fetch. The response type will be a list.
18906
- * This is a primary query parameter and cannot be used with any other primary query parameters
19753
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
19754
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
18907
19755
  */
18908
19756
  compositionIDs?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
18909
19757
  /**
@@ -19073,6 +19921,21 @@ interface external$6 {
19073
19921
  * Example: ?search=hello
19074
19922
  */
19075
19923
  search?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
19924
+ /**
19925
+ * @deprecated Controls the edition resolution behavior.
19926
+ *
19927
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
19928
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
19929
+ * Without a locale, the default edition is matched
19930
+ *
19931
+ * all: Every edition is returned as a separate row.
19932
+ * Note: this has no effect when used with compositionId which always returns a single result.
19933
+ *
19934
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
19935
+ * compositionId or compositionIDs MUST be provided with this option.
19936
+ * If versionId is passed, this is always enabled.
19937
+ */
19938
+ editions?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["editions"];
19076
19939
  };
19077
19940
  };
19078
19941
  responses: {
@@ -19157,6 +20020,24 @@ interface external$6 {
19157
20020
  * @description The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
19158
20021
  */
19159
20022
  workflowStageId?: string;
20023
+ /**
20024
+ * Format: uuid
20025
+ * @deprecated
20026
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
20027
+ */
20028
+ editionId?: string;
20029
+ /**
20030
+ * @deprecated
20031
+ * @description The name of the composition or edition as shown in the editions listing.
20032
+ * Describes the purpose of an edition.
20033
+ */
20034
+ editionName?: string;
20035
+ /**
20036
+ * @deprecated
20037
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
20038
+ * When multiple editions enable the same locale, the highest priority edition is used.
20039
+ */
20040
+ editionPriority?: number;
19160
20041
  };
19161
20042
  };
19162
20043
  };
@@ -19177,9 +20058,19 @@ interface external$6 {
19177
20058
  "application/json": {
19178
20059
  /**
19179
20060
  * Format: uuid
19180
- * @description The ID of the composition to delete
20061
+ * @description The ID of the composition to delete.
20062
+ * When editionId is also passed, the composition remains and an edition under it is deleted.
20063
+ * When editionId is omitted, and the composition has editions, all editions will also be deleted along with the composition.
20064
+ */
20065
+ compositionId: string;
20066
+ /**
20067
+ * Format: uuid
20068
+ * @deprecated
20069
+ * @description The edition ID to delete. When set, this deletes a child edition of the compositionId.
20070
+ * The composition will remain when an edition is deleted.
20071
+ * If the composition ID is specified as the edition ID, the composition will be deleted _but any other editions will remain_ (this is used for unpublishing).
19181
20072
  */
19182
- compositionId: string;
20073
+ editionId?: string;
19183
20074
  /**
19184
20075
  * Format: uuid
19185
20076
  * @description The ID of the project the composition to delete belongs to
@@ -19270,6 +20161,24 @@ interface external$6 {
19270
20161
  workflowStageId?: string;
19271
20162
  /** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
19272
20163
  workflowDefinition?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowDefinition"];
20164
+ /**
20165
+ * Format: uuid
20166
+ * @deprecated
20167
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
20168
+ */
20169
+ editionId?: string;
20170
+ /**
20171
+ * @deprecated
20172
+ * @description The name of the composition or edition as shown in the editions listing.
20173
+ * Describes the purpose of an edition.
20174
+ */
20175
+ editionName?: string;
20176
+ /**
20177
+ * @deprecated
20178
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
20179
+ * When multiple editions enable the same locale, the highest priority edition is used.
20180
+ */
20181
+ editionPriority?: number;
19273
20182
  };
19274
20183
  CompositionListResponse: {
19275
20184
  compositions: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
@@ -19282,7 +20191,8 @@ interface external$6 {
19282
20191
  projectId: string;
19283
20192
  /**
19284
20193
  * @description Specify a single composition ID to fetch. The response will be a single composition.
19285
- * This is a primary query parameter and cannot be used with any other primary query parameters
20194
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
20195
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
19286
20196
  */
19287
20197
  compositionId: string;
19288
20198
  /**
@@ -19292,7 +20202,8 @@ interface external$6 {
19292
20202
  componentId: string;
19293
20203
  /**
19294
20204
  * @description Specify multiple composition IDs to fetch. The response type will be a list.
19295
- * This is a primary query parameter and cannot be used with any other primary query parameters
20205
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
20206
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
19296
20207
  */
19297
20208
  compositionIDs: string[];
19298
20209
  /**
@@ -19477,6 +20388,22 @@ interface external$6 {
19477
20388
  * Example: ?search=hello
19478
20389
  */
19479
20390
  search: string;
20391
+ /**
20392
+ * @deprecated
20393
+ * @description Controls the edition resolution behavior.
20394
+ *
20395
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
20396
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
20397
+ * Without a locale, the default edition is matched
20398
+ *
20399
+ * all: Every edition is returned as a separate row.
20400
+ * Note: this has no effect when used with compositionId which always returns a single result.
20401
+ *
20402
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
20403
+ * compositionId or compositionIDs MUST be provided with this option.
20404
+ * If versionId is passed, this is always enabled.
20405
+ */
20406
+ editions: "auto" | "all" | "raw";
19480
20407
  };
19481
20408
  };
19482
20409
  operations: {};
@@ -19487,7 +20414,11 @@ interface external$6 {
19487
20414
  get: {
19488
20415
  parameters: {
19489
20416
  query: {
19490
- /** Specify multiple entry IDs to fetch */
20417
+ /**
20418
+ * Specify one or more entry IDs to fetch.
20419
+ * When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
20420
+ * When `versionId` is passed, this parameter is required and must contain only one entry ID.
20421
+ */
19491
20422
  entryIDs?: external$6["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
19492
20423
  /**
19493
20424
  * Specify a historical entry version ID to fetch (retrieved from the entries-history API).
@@ -19587,6 +20518,20 @@ interface external$6 {
19587
20518
  * Example: ?search=hello
19588
20519
  */
19589
20520
  search?: external$6["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["search"];
20521
+ /**
20522
+ * @deprecated Controls the edition resolution behavior.
20523
+ *
20524
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
20525
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
20526
+ * Without a locale, the default edition is matched
20527
+ *
20528
+ * all: Every edition is returned as a separate row.
20529
+ *
20530
+ * raw: the entryIDs parameter targets exact edition/entry IDs and no edition resolution is performed.
20531
+ * entryIDs MUST be provided with this option.
20532
+ * If versionId is passed, this is always enabled.
20533
+ */
20534
+ editions?: external$6["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["editions"];
19590
20535
  };
19591
20536
  };
19592
20537
  responses: {
@@ -19655,6 +20600,24 @@ interface external$6 {
19655
20600
  * @description The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
19656
20601
  */
19657
20602
  workflowStageId?: string;
20603
+ /**
20604
+ * Format: uuid
20605
+ * @deprecated
20606
+ * @description The edition ID. When set, this is a child edition of the entry in _id.
20607
+ */
20608
+ editionId?: string;
20609
+ /**
20610
+ * @deprecated
20611
+ * @description The name of the entry or edition as shown in the editions listing.
20612
+ * Describes the purpose of an edition.
20613
+ */
20614
+ editionName?: string;
20615
+ /**
20616
+ * @deprecated
20617
+ * @description The priority of the edition or entry. Higher numbers are higher priority.
20618
+ * When multiple editions enable the same locale, the highest priority edition is used.
20619
+ */
20620
+ editionPriority?: number;
19658
20621
  };
19659
20622
  };
19660
20623
  };
@@ -19675,9 +20638,19 @@ interface external$6 {
19675
20638
  "application/json": {
19676
20639
  /**
19677
20640
  * Format: uuid
19678
- * @description The ID of the entry to delete
20641
+ * @description The ID of the entry to delete.
20642
+ * When editionId is also passed, the entry remains and an edition under it is deleted.
20643
+ * When editionId is omitted, and the entry has editions, all editions will also be deleted along with the entry.
19679
20644
  */
19680
20645
  entryId: string;
20646
+ /**
20647
+ * Format: uuid
20648
+ * @deprecated
20649
+ * @description The edition ID to delete. When set, this deletes a child edition of the entryId.
20650
+ * The entry will remain when an edition is deleted.
20651
+ * If the entry ID is specified as the edition ID, the entry will be deleted _but any other editions will remain_ (this is used for unpublishing).
20652
+ */
20653
+ editionId?: string;
19681
20654
  /**
19682
20655
  * Format: uuid
19683
20656
  * @description The ID of the project the entry to delete belongs to
@@ -19712,7 +20685,7 @@ interface external$6 {
19712
20685
  type: string;
19713
20686
  /**
19714
20687
  * Format: uuid
19715
- * @description The public UUID of the entry
20688
+ * @description The ID of the entry
19716
20689
  */
19717
20690
  _id: string;
19718
20691
  /** @description The name of the entry */
@@ -19897,6 +20870,24 @@ interface external$6 {
19897
20870
  * @enum {string}
19898
20871
  */
19899
20872
  stubType?: "missing" | "tooDeep";
20873
+ /**
20874
+ * Format: uuid
20875
+ * @deprecated
20876
+ * @description The edition ID. When set, this is a child edition of the entry in _id.
20877
+ */
20878
+ editionId?: string;
20879
+ /**
20880
+ * @deprecated
20881
+ * @description The name of the entry or edition as shown in the editions listing.
20882
+ * Describes the purpose of an edition.
20883
+ */
20884
+ editionName?: string;
20885
+ /**
20886
+ * @deprecated
20887
+ * @description The priority of the edition or entry. Higher numbers are higher priority.
20888
+ * When multiple editions enable the same locale, the highest priority edition is used.
20889
+ */
20890
+ editionPriority?: number;
19900
20891
  };
19901
20892
  EntryListResponse: {
19902
20893
  entries: external$6["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"][];
@@ -19907,7 +20898,11 @@ interface external$6 {
19907
20898
  parameters: {
19908
20899
  /** @description The project the entry/entries are on */
19909
20900
  projectId: string;
19910
- /** @description Specify multiple entry IDs to fetch */
20901
+ /**
20902
+ * @description Specify one or more entry IDs to fetch.
20903
+ * When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
20904
+ * When `versionId` is passed, this parameter is required and must contain only one entry ID.
20905
+ */
19911
20906
  entryIDs: string[];
19912
20907
  /**
19913
20908
  * @description Specify a historical entry version ID to fetch (retrieved from the entries-history API).
@@ -20010,6 +21005,21 @@ interface external$6 {
20010
21005
  * Example: ?search=hello
20011
21006
  */
20012
21007
  search: string;
21008
+ /**
21009
+ * @deprecated
21010
+ * @description Controls the edition resolution behavior.
21011
+ *
21012
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
21013
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
21014
+ * Without a locale, the default edition is matched
21015
+ *
21016
+ * all: Every edition is returned as a separate row.
21017
+ *
21018
+ * raw: the entryIDs parameter targets exact edition/entry IDs and no edition resolution is performed.
21019
+ * entryIDs MUST be provided with this option.
21020
+ * If versionId is passed, this is always enabled.
21021
+ */
21022
+ editions: "auto" | "all" | "raw";
20013
21023
  };
20014
21024
  };
20015
21025
  operations: {};
@@ -20038,7 +21048,7 @@ interface external$6 {
20038
21048
  id?: string;
20039
21049
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
20040
21050
  path?: string;
20041
- /** Composition id to find associated sitemap nodes for */
21051
+ /** Composition id to find associated project map node for */
20042
21052
  compositionId?: string;
20043
21053
  /** Limit the number or records returned by a number */
20044
21054
  limit?: number;
@@ -20257,18 +21267,27 @@ interface external$6 {
20257
21267
  */
20258
21268
  id?: string;
20259
21269
  }[];
20260
- /** @description Basic information about a composition from the context of a project map node */
21270
+ /**
21271
+ * @description Basic information about the linked composition from the context of a project map node.
21272
+ * If the linked composition has editions, the editions are included in the `editions` property.
21273
+ */
20261
21274
  ProjectMapNodeCompositionData: {
20262
- /** @description Type of the composition instance (public_id of its definition) */
21275
+ /** @description Type of the linked composition (id of its definition) */
20263
21276
  type: string;
20264
21277
  /**
20265
21278
  * Format: uuid
20266
- * @description The public UUID of the composition
21279
+ * @description The UUID of the linked composition
20267
21280
  */
20268
21281
  id: string;
20269
- /** @description Slug pattern of this composition */
21282
+ /**
21283
+ * Format: uuid
21284
+ * @description The edition UUID underneath the linked composition
21285
+ * This is only present if the composition has not been published, but an edition has
21286
+ */
21287
+ editionId?: string;
21288
+ /** @description Slug pattern of the linked composition or edition */
20270
21289
  slug?: string | null;
20271
- /** @description Friendly name of this composition */
21290
+ /** @description Friendly name of this composition or edition */
20272
21291
  name: string;
20273
21292
  /**
20274
21293
  * @deprecated
@@ -20283,7 +21302,61 @@ interface external$6 {
20283
21302
  icon?: string;
20284
21303
  /** @description Friendly name of this Composition's Definition */
20285
21304
  typeName?: string;
20286
- /** @description List of locales that the composition is available in. If empty, available in all locales */
21305
+ /**
21306
+ * @description List of locales that the composition _or any of its editions_ is available in.
21307
+ * If empty, available in all locales.
21308
+ */
21309
+ locales: string[];
21310
+ /** @description Priority of the composition relative to any editions */
21311
+ editionPriority?: number;
21312
+ /** @description Friendly name of the edition */
21313
+ editionName?: string;
21314
+ /**
21315
+ * @deprecated
21316
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
21317
+ * where the editionID equals the node's compositionID.
21318
+ */
21319
+ editions?: external$6["../../../lambda/functions/v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
21320
+ };
21321
+ /**
21322
+ * @deprecated
21323
+ * @description Basic information about a composition edition from the context of a project map node
21324
+ */
21325
+ ProjectMapNodeCompositionEditionData: {
21326
+ /**
21327
+ * Format: uuid
21328
+ * @description The UUID of the linked composition
21329
+ */
21330
+ id: string;
21331
+ /** @description Type of the edition instance (public_id of its definition) */
21332
+ type: string;
21333
+ /**
21334
+ * Format: uuid
21335
+ * @description The edition UUID underneath the linked composition
21336
+ */
21337
+ editionId?: string;
21338
+ /** @description Slug pattern of this edition */
21339
+ slug?: string | null;
21340
+ /** @description Friendly name of the linked composition */
21341
+ name: string;
21342
+ /** @description Friendly name of the edition */
21343
+ editionName?: string;
21344
+ /** @description Priority of the edition */
21345
+ editionPriority?: number;
21346
+ /**
21347
+ * @deprecated
21348
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
21349
+ * @enum {string}
21350
+ */
21351
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
21352
+ /**
21353
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
21354
+ * @default screen
21355
+ */
21356
+ icon?: string;
21357
+ /** @description Friendly name of this edition's definition */
21358
+ typeName?: string;
21359
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
20287
21360
  locales: string[];
20288
21361
  /**
20289
21362
  * Format: date-time
@@ -21453,7 +22526,7 @@ interface external$5 {
21453
22526
  slots?: {
21454
22527
  [key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
21455
22528
  };
21456
- /** @description The public UUID of the composition */
22529
+ /** @description The ID of the composition */
21457
22530
  _id: string;
21458
22531
  /** @description Slug pattern of this component */
21459
22532
  _slug?: string | null;
@@ -21721,12 +22794,6 @@ interface external$5 {
21721
22794
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
21722
22795
  */
21723
22796
  optionalPatternParameter?: boolean;
21724
- /**
21725
- * @description Resolve this data resource with draft mode content. TBD
21726
- *
21727
- * @enum {string}
21728
- */
21729
- dataSourceVariant?: "unpublished";
21730
22797
  variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
21731
22798
  };
21732
22799
  /** @description Variable values for a data resource */
@@ -21953,7 +23020,8 @@ interface external$5 {
21953
23020
  query: {
21954
23021
  /**
21955
23022
  * Specify a single composition ID to fetch. The response will be a single composition.
21956
- * This is a primary query parameter and cannot be used with any other primary query parameters
23023
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
23024
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
21957
23025
  */
21958
23026
  compositionId?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
21959
23027
  /**
@@ -21968,7 +23036,8 @@ interface external$5 {
21968
23036
  versionId?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
21969
23037
  /**
21970
23038
  * Specify multiple composition IDs to fetch. The response type will be a list.
21971
- * This is a primary query parameter and cannot be used with any other primary query parameters
23039
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
23040
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
21972
23041
  */
21973
23042
  compositionIDs?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
21974
23043
  /**
@@ -22138,6 +23207,21 @@ interface external$5 {
22138
23207
  * Example: ?search=hello
22139
23208
  */
22140
23209
  search?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["search"];
23210
+ /**
23211
+ * @deprecated Controls the edition resolution behavior.
23212
+ *
23213
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
23214
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
23215
+ * Without a locale, the default edition is matched
23216
+ *
23217
+ * all: Every edition is returned as a separate row.
23218
+ * Note: this has no effect when used with compositionId which always returns a single result.
23219
+ *
23220
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
23221
+ * compositionId or compositionIDs MUST be provided with this option.
23222
+ * If versionId is passed, this is always enabled.
23223
+ */
23224
+ editions?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["editions"];
22141
23225
  };
22142
23226
  };
22143
23227
  responses: {
@@ -22222,6 +23306,24 @@ interface external$5 {
22222
23306
  * @description The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
22223
23307
  */
22224
23308
  workflowStageId?: string;
23309
+ /**
23310
+ * Format: uuid
23311
+ * @deprecated
23312
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
23313
+ */
23314
+ editionId?: string;
23315
+ /**
23316
+ * @deprecated
23317
+ * @description The name of the composition or edition as shown in the editions listing.
23318
+ * Describes the purpose of an edition.
23319
+ */
23320
+ editionName?: string;
23321
+ /**
23322
+ * @deprecated
23323
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
23324
+ * When multiple editions enable the same locale, the highest priority edition is used.
23325
+ */
23326
+ editionPriority?: number;
22225
23327
  };
22226
23328
  };
22227
23329
  };
@@ -22242,9 +23344,19 @@ interface external$5 {
22242
23344
  "application/json": {
22243
23345
  /**
22244
23346
  * Format: uuid
22245
- * @description The ID of the composition to delete
23347
+ * @description The ID of the composition to delete.
23348
+ * When editionId is also passed, the composition remains and an edition under it is deleted.
23349
+ * When editionId is omitted, and the composition has editions, all editions will also be deleted along with the composition.
22246
23350
  */
22247
23351
  compositionId: string;
23352
+ /**
23353
+ * Format: uuid
23354
+ * @deprecated
23355
+ * @description The edition ID to delete. When set, this deletes a child edition of the compositionId.
23356
+ * The composition will remain when an edition is deleted.
23357
+ * If the composition ID is specified as the edition ID, the composition will be deleted _but any other editions will remain_ (this is used for unpublishing).
23358
+ */
23359
+ editionId?: string;
22248
23360
  /**
22249
23361
  * Format: uuid
22250
23362
  * @description The ID of the project the composition to delete belongs to
@@ -22335,6 +23447,24 @@ interface external$5 {
22335
23447
  workflowStageId?: string;
22336
23448
  /** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
22337
23449
  workflowDefinition?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowDefinition"];
23450
+ /**
23451
+ * Format: uuid
23452
+ * @deprecated
23453
+ * @description The edition ID. When set, this is a child edition of the composition in _id.
23454
+ */
23455
+ editionId?: string;
23456
+ /**
23457
+ * @deprecated
23458
+ * @description The name of the composition or edition as shown in the editions listing.
23459
+ * Describes the purpose of an edition.
23460
+ */
23461
+ editionName?: string;
23462
+ /**
23463
+ * @deprecated
23464
+ * @description The priority of the edition or composition. Higher numbers are higher priority.
23465
+ * When multiple editions enable the same locale, the highest priority edition is used.
23466
+ */
23467
+ editionPriority?: number;
22338
23468
  };
22339
23469
  CompositionListResponse: {
22340
23470
  compositions: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"][];
@@ -22347,7 +23477,8 @@ interface external$5 {
22347
23477
  projectId: string;
22348
23478
  /**
22349
23479
  * @description Specify a single composition ID to fetch. The response will be a single composition.
22350
- * This is a primary query parameter and cannot be used with any other primary query parameters
23480
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
23481
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
22351
23482
  */
22352
23483
  compositionId: string;
22353
23484
  /**
@@ -22357,7 +23488,8 @@ interface external$5 {
22357
23488
  componentId: string;
22358
23489
  /**
22359
23490
  * @description Specify multiple composition IDs to fetch. The response type will be a list.
22360
- * This is a primary query parameter and cannot be used with any other primary query parameters
23491
+ * This is a primary query parameter and cannot be used with any other primary query parameters.
23492
+ * When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
22361
23493
  */
22362
23494
  compositionIDs: string[];
22363
23495
  /**
@@ -22542,6 +23674,22 @@ interface external$5 {
22542
23674
  * Example: ?search=hello
22543
23675
  */
22544
23676
  search: string;
23677
+ /**
23678
+ * @deprecated
23679
+ * @description Controls the edition resolution behavior.
23680
+ *
23681
+ * auto: (default) Editions are evaluated automatically and the best matching edition is returned.
23682
+ * When a locale is provided, the edition with the highest priority that enables that locale matches
23683
+ * Without a locale, the default edition is matched
23684
+ *
23685
+ * all: Every edition is returned as a separate row.
23686
+ * Note: this has no effect when used with compositionId which always returns a single result.
23687
+ *
23688
+ * raw: the compositionId and compositionIDs parameters target exact edition/composition IDs and no edition resolution is performed.
23689
+ * compositionId or compositionIDs MUST be provided with this option.
23690
+ * If versionId is passed, this is always enabled.
23691
+ */
23692
+ editions: "auto" | "all" | "raw";
22545
23693
  };
22546
23694
  };
22547
23695
  operations: {};
@@ -22570,7 +23718,7 @@ interface external$5 {
22570
23718
  id?: string;
22571
23719
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
22572
23720
  path?: string;
22573
- /** Composition id to find associated sitemap nodes for */
23721
+ /** Composition id to find associated project map node for */
22574
23722
  compositionId?: string;
22575
23723
  /** Limit the number or records returned by a number */
22576
23724
  limit?: number;
@@ -22789,18 +23937,27 @@ interface external$5 {
22789
23937
  */
22790
23938
  id?: string;
22791
23939
  }[];
22792
- /** @description Basic information about a composition from the context of a project map node */
23940
+ /**
23941
+ * @description Basic information about the linked composition from the context of a project map node.
23942
+ * If the linked composition has editions, the editions are included in the `editions` property.
23943
+ */
22793
23944
  ProjectMapNodeCompositionData: {
22794
- /** @description Type of the composition instance (public_id of its definition) */
23945
+ /** @description Type of the linked composition (id of its definition) */
22795
23946
  type: string;
22796
23947
  /**
22797
23948
  * Format: uuid
22798
- * @description The public UUID of the composition
23949
+ * @description The UUID of the linked composition
22799
23950
  */
22800
23951
  id: string;
22801
- /** @description Slug pattern of this composition */
23952
+ /**
23953
+ * Format: uuid
23954
+ * @description The edition UUID underneath the linked composition
23955
+ * This is only present if the composition has not been published, but an edition has
23956
+ */
23957
+ editionId?: string;
23958
+ /** @description Slug pattern of the linked composition or edition */
22802
23959
  slug?: string | null;
22803
- /** @description Friendly name of this composition */
23960
+ /** @description Friendly name of this composition or edition */
22804
23961
  name: string;
22805
23962
  /**
22806
23963
  * @deprecated
@@ -22815,7 +23972,61 @@ interface external$5 {
22815
23972
  icon?: string;
22816
23973
  /** @description Friendly name of this Composition's Definition */
22817
23974
  typeName?: string;
22818
- /** @description List of locales that the composition is available in. If empty, available in all locales */
23975
+ /**
23976
+ * @description List of locales that the composition _or any of its editions_ is available in.
23977
+ * If empty, available in all locales.
23978
+ */
23979
+ locales: string[];
23980
+ /** @description Priority of the composition relative to any editions */
23981
+ editionPriority?: number;
23982
+ /** @description Friendly name of the edition */
23983
+ editionName?: string;
23984
+ /**
23985
+ * @deprecated
23986
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
23987
+ * where the editionID equals the node's compositionID.
23988
+ */
23989
+ editions?: external$5["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
23990
+ };
23991
+ /**
23992
+ * @deprecated
23993
+ * @description Basic information about a composition edition from the context of a project map node
23994
+ */
23995
+ ProjectMapNodeCompositionEditionData: {
23996
+ /**
23997
+ * Format: uuid
23998
+ * @description The UUID of the linked composition
23999
+ */
24000
+ id: string;
24001
+ /** @description Type of the edition instance (public_id of its definition) */
24002
+ type: string;
24003
+ /**
24004
+ * Format: uuid
24005
+ * @description The edition UUID underneath the linked composition
24006
+ */
24007
+ editionId?: string;
24008
+ /** @description Slug pattern of this edition */
24009
+ slug?: string | null;
24010
+ /** @description Friendly name of the linked composition */
24011
+ name: string;
24012
+ /** @description Friendly name of the edition */
24013
+ editionName?: string;
24014
+ /** @description Priority of the edition */
24015
+ editionPriority?: number;
24016
+ /**
24017
+ * @deprecated
24018
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
24019
+ * @enum {string}
24020
+ */
24021
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
24022
+ /**
24023
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
24024
+ * @default screen
24025
+ */
24026
+ icon?: string;
24027
+ /** @description Friendly name of this edition's definition */
24028
+ typeName?: string;
24029
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
22819
24030
  locales: string[];
22820
24031
  /**
22821
24032
  * Format: date-time
@@ -23228,7 +24439,7 @@ type CanvasDefinitions = {
23228
24439
  workflows?: Array<WorkflowDefinition>;
23229
24440
  };
23230
24441
  /** Defines shared parameters for requests getting a single composition */
23231
- type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId'>;
24442
+ type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId' | 'editions'>;
23232
24443
  type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
23233
24444
  type SpecificProjectMap = {
23234
24445
  projectMapId?: string;
@@ -23827,7 +25038,7 @@ interface paths$3 {
23827
25038
  };
23828
25039
  };
23829
25040
  responses: {
23830
- /** Gets a list of all defined releases for a project */
25041
+ /** Gets a list all changes that are part of a release */
23831
25042
  200: {
23832
25043
  content: {
23833
25044
  "application/json": {
@@ -23868,6 +25079,17 @@ interface components$1 {
23868
25079
  /** @description Friendly name of the entity */
23869
25080
  name: string;
23870
25081
  publicId: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
25082
+ /**
25083
+ * Format: uuid
25084
+ * @description The edition ID of the release content underneath its public ID
25085
+ * NOTE: This is only set when the release content references an edition.
25086
+ */
25087
+ editionId?: string;
25088
+ /**
25089
+ * @description The edition name the release content belongs to, if any.
25090
+ * NOTE: This may be set even when the release content refers to a composition/entry.
25091
+ */
25092
+ editionName?: string;
23871
25093
  /**
23872
25094
  * @description Entity type (i.e. composition, entry, asset, ...).
23873
25095
  * NOTE: New values may be added to this list without being considered a breaking API change
@@ -23914,6 +25136,12 @@ interface components$1 {
23914
25136
  */
23915
25137
  projectId: string;
23916
25138
  publicId: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
25139
+ /**
25140
+ * Format: uuid
25141
+ * @description The edition ID of the release content underneath its public ID
25142
+ * NOTE: This is only required if the release content has an edition ID
25143
+ */
25144
+ editionId?: string;
23917
25145
  /**
23918
25146
  * @description Entity type (i.e. composition, entry, asset, ...).
23919
25147
  * NOTE: New values may be added to this list without being considered a breaking API change.
@@ -24383,7 +25611,7 @@ interface external$3 {
24383
25611
  slots?: {
24384
25612
  [key: string]: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
24385
25613
  };
24386
- /** @description The public UUID of the composition */
25614
+ /** @description The ID of the composition */
24387
25615
  _id: string;
24388
25616
  /** @description Slug pattern of this component */
24389
25617
  _slug?: string | null;
@@ -24651,12 +25879,6 @@ interface external$3 {
24651
25879
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
24652
25880
  */
24653
25881
  optionalPatternParameter?: boolean;
24654
- /**
24655
- * @description Resolve this data resource with draft mode content. TBD
24656
- *
24657
- * @enum {string}
24658
- */
24659
- dataSourceVariant?: "unpublished";
24660
25882
  variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
24661
25883
  };
24662
25884
  /** @description Variable values for a data resource */
@@ -24899,7 +26121,7 @@ interface external$3 {
24899
26121
  id?: string;
24900
26122
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
24901
26123
  path?: string;
24902
- /** Composition id to find associated sitemap nodes for */
26124
+ /** Composition id to find associated project map node for */
24903
26125
  compositionId?: string;
24904
26126
  /** Limit the number or records returned by a number */
24905
26127
  limit?: number;
@@ -25118,18 +26340,27 @@ interface external$3 {
25118
26340
  */
25119
26341
  id?: string;
25120
26342
  }[];
25121
- /** @description Basic information about a composition from the context of a project map node */
26343
+ /**
26344
+ * @description Basic information about the linked composition from the context of a project map node.
26345
+ * If the linked composition has editions, the editions are included in the `editions` property.
26346
+ */
25122
26347
  ProjectMapNodeCompositionData: {
25123
- /** @description Type of the composition instance (public_id of its definition) */
26348
+ /** @description Type of the linked composition (id of its definition) */
25124
26349
  type: string;
25125
26350
  /**
25126
26351
  * Format: uuid
25127
- * @description The public UUID of the composition
26352
+ * @description The UUID of the linked composition
25128
26353
  */
25129
26354
  id: string;
25130
- /** @description Slug pattern of this composition */
26355
+ /**
26356
+ * Format: uuid
26357
+ * @description The edition UUID underneath the linked composition
26358
+ * This is only present if the composition has not been published, but an edition has
26359
+ */
26360
+ editionId?: string;
26361
+ /** @description Slug pattern of the linked composition or edition */
25131
26362
  slug?: string | null;
25132
- /** @description Friendly name of this composition */
26363
+ /** @description Friendly name of this composition or edition */
25133
26364
  name: string;
25134
26365
  /**
25135
26366
  * @deprecated
@@ -25144,7 +26375,61 @@ interface external$3 {
25144
26375
  icon?: string;
25145
26376
  /** @description Friendly name of this Composition's Definition */
25146
26377
  typeName?: string;
25147
- /** @description List of locales that the composition is available in. If empty, available in all locales */
26378
+ /**
26379
+ * @description List of locales that the composition _or any of its editions_ is available in.
26380
+ * If empty, available in all locales.
26381
+ */
26382
+ locales: string[];
26383
+ /** @description Priority of the composition relative to any editions */
26384
+ editionPriority?: number;
26385
+ /** @description Friendly name of the edition */
26386
+ editionName?: string;
26387
+ /**
26388
+ * @deprecated
26389
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
26390
+ * where the editionID equals the node's compositionID.
26391
+ */
26392
+ editions?: external$3["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
26393
+ };
26394
+ /**
26395
+ * @deprecated
26396
+ * @description Basic information about a composition edition from the context of a project map node
26397
+ */
26398
+ ProjectMapNodeCompositionEditionData: {
26399
+ /**
26400
+ * Format: uuid
26401
+ * @description The UUID of the linked composition
26402
+ */
26403
+ id: string;
26404
+ /** @description Type of the edition instance (public_id of its definition) */
26405
+ type: string;
26406
+ /**
26407
+ * Format: uuid
26408
+ * @description The edition UUID underneath the linked composition
26409
+ */
26410
+ editionId?: string;
26411
+ /** @description Slug pattern of this edition */
26412
+ slug?: string | null;
26413
+ /** @description Friendly name of the linked composition */
26414
+ name: string;
26415
+ /** @description Friendly name of the edition */
26416
+ editionName?: string;
26417
+ /** @description Priority of the edition */
26418
+ editionPriority?: number;
26419
+ /**
26420
+ * @deprecated
26421
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
26422
+ * @enum {string}
26423
+ */
26424
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
26425
+ /**
26426
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
26427
+ * @default screen
26428
+ */
26429
+ icon?: string;
26430
+ /** @description Friendly name of this edition's definition */
26431
+ typeName?: string;
26432
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
25148
26433
  locales: string[];
25149
26434
  /**
25150
26435
  * Format: date-time
@@ -26013,7 +27298,7 @@ interface external$1 {
26013
27298
  slots?: {
26014
27299
  [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
26015
27300
  };
26016
- /** @description The public UUID of the composition */
27301
+ /** @description The ID of the composition */
26017
27302
  _id: string;
26018
27303
  /** @description Slug pattern of this component */
26019
27304
  _slug?: string | null;
@@ -26281,12 +27566,6 @@ interface external$1 {
26281
27566
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
26282
27567
  */
26283
27568
  optionalPatternParameter?: boolean;
26284
- /**
26285
- * @description Resolve this data resource with draft mode content. TBD
26286
- *
26287
- * @enum {string}
26288
- */
26289
- dataSourceVariant?: "unpublished";
26290
27569
  variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
26291
27570
  };
26292
27571
  /** @description Variable values for a data resource */
@@ -26529,7 +27808,7 @@ interface external$1 {
26529
27808
  id?: string;
26530
27809
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
26531
27810
  path?: string;
26532
- /** Composition id to find associated sitemap nodes for */
27811
+ /** Composition id to find associated project map node for */
26533
27812
  compositionId?: string;
26534
27813
  /** Limit the number or records returned by a number */
26535
27814
  limit?: number;
@@ -26748,18 +28027,27 @@ interface external$1 {
26748
28027
  */
26749
28028
  id?: string;
26750
28029
  }[];
26751
- /** @description Basic information about a composition from the context of a project map node */
28030
+ /**
28031
+ * @description Basic information about the linked composition from the context of a project map node.
28032
+ * If the linked composition has editions, the editions are included in the `editions` property.
28033
+ */
26752
28034
  ProjectMapNodeCompositionData: {
26753
- /** @description Type of the composition instance (public_id of its definition) */
28035
+ /** @description Type of the linked composition (id of its definition) */
26754
28036
  type: string;
26755
28037
  /**
26756
28038
  * Format: uuid
26757
- * @description The public UUID of the composition
28039
+ * @description The UUID of the linked composition
26758
28040
  */
26759
28041
  id: string;
26760
- /** @description Slug pattern of this composition */
28042
+ /**
28043
+ * Format: uuid
28044
+ * @description The edition UUID underneath the linked composition
28045
+ * This is only present if the composition has not been published, but an edition has
28046
+ */
28047
+ editionId?: string;
28048
+ /** @description Slug pattern of the linked composition or edition */
26761
28049
  slug?: string | null;
26762
- /** @description Friendly name of this composition */
28050
+ /** @description Friendly name of this composition or edition */
26763
28051
  name: string;
26764
28052
  /**
26765
28053
  * @deprecated
@@ -26774,7 +28062,61 @@ interface external$1 {
26774
28062
  icon?: string;
26775
28063
  /** @description Friendly name of this Composition's Definition */
26776
28064
  typeName?: string;
26777
- /** @description List of locales that the composition is available in. If empty, available in all locales */
28065
+ /**
28066
+ * @description List of locales that the composition _or any of its editions_ is available in.
28067
+ * If empty, available in all locales.
28068
+ */
28069
+ locales: string[];
28070
+ /** @description Priority of the composition relative to any editions */
28071
+ editionPriority?: number;
28072
+ /** @description Friendly name of the edition */
28073
+ editionName?: string;
28074
+ /**
28075
+ * @deprecated
28076
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
28077
+ * where the editionID equals the node's compositionID.
28078
+ */
28079
+ editions?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
28080
+ };
28081
+ /**
28082
+ * @deprecated
28083
+ * @description Basic information about a composition edition from the context of a project map node
28084
+ */
28085
+ ProjectMapNodeCompositionEditionData: {
28086
+ /**
28087
+ * Format: uuid
28088
+ * @description The UUID of the linked composition
28089
+ */
28090
+ id: string;
28091
+ /** @description Type of the edition instance (public_id of its definition) */
28092
+ type: string;
28093
+ /**
28094
+ * Format: uuid
28095
+ * @description The edition UUID underneath the linked composition
28096
+ */
28097
+ editionId?: string;
28098
+ /** @description Slug pattern of this edition */
28099
+ slug?: string | null;
28100
+ /** @description Friendly name of the linked composition */
28101
+ name: string;
28102
+ /** @description Friendly name of the edition */
28103
+ editionName?: string;
28104
+ /** @description Priority of the edition */
28105
+ editionPriority?: number;
28106
+ /**
28107
+ * @deprecated
28108
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
28109
+ * @enum {string}
28110
+ */
28111
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
28112
+ /**
28113
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
28114
+ * @default screen
28115
+ */
28116
+ icon?: string;
28117
+ /** @description Friendly name of this edition's definition */
28118
+ typeName?: string;
28119
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
26778
28120
  locales: string[];
26779
28121
  /**
26780
28122
  * Format: date-time