@uniformdev/assets 19.186.2-alpha.14 → 19.186.4-alpha.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +142 -28
  2. package/dist/index.d.ts +142 -28
  3. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -414,7 +414,7 @@ interface components$1 {
414
414
  slots?: {
415
415
  [key: string]: components$1["schemas"]["ComponentInstance"][];
416
416
  };
417
- /** @description The public UUID of the composition */
417
+ /** @description The ID of the composition */
418
418
  _id: string;
419
419
  /** @description Slug pattern of this component */
420
420
  _slug?: string | null;
@@ -682,12 +682,6 @@ interface components$1 {
682
682
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
683
683
  */
684
684
  optionalPatternParameter?: boolean;
685
- /**
686
- * @description Resolve this data resource with draft mode content. TBD
687
- *
688
- * @enum {string}
689
- */
690
- dataSourceVariant?: "unpublished";
691
685
  variables?: components$1["schemas"]["DataResourceVariables"];
692
686
  };
693
687
  /** @description Variable values for a data resource */
@@ -971,7 +965,7 @@ interface external$1 {
971
965
  id?: string;
972
966
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
973
967
  path?: string;
974
- /** Composition id to find associated sitemap nodes for */
968
+ /** Composition id to find associated project map node for */
975
969
  compositionId?: string;
976
970
  /** Limit the number or records returned by a number */
977
971
  limit?: number;
@@ -1190,18 +1184,27 @@ interface external$1 {
1190
1184
  */
1191
1185
  id?: string;
1192
1186
  }[];
1193
- /** @description Basic information about a composition from the context of a project map node */
1187
+ /**
1188
+ * @description Basic information about the linked composition from the context of a project map node.
1189
+ * If the linked composition has editions, the editions are included in the `editions` property.
1190
+ */
1194
1191
  ProjectMapNodeCompositionData: {
1195
- /** @description Type of the composition instance (public_id of its definition) */
1192
+ /** @description Type of the linked composition (id of its definition) */
1196
1193
  type: string;
1197
1194
  /**
1198
1195
  * Format: uuid
1199
- * @description The public UUID of the composition
1196
+ * @description The UUID of the linked composition
1200
1197
  */
1201
1198
  id: string;
1202
- /** @description Slug pattern of this composition */
1199
+ /**
1200
+ * Format: uuid
1201
+ * @description The edition UUID underneath the linked composition
1202
+ * This is only present if the composition has not been published, but an edition has
1203
+ */
1204
+ editionId?: string;
1205
+ /** @description Slug pattern of the linked composition or edition */
1203
1206
  slug?: string | null;
1204
- /** @description Friendly name of this composition */
1207
+ /** @description Friendly name of this composition or edition */
1205
1208
  name: string;
1206
1209
  /**
1207
1210
  * @deprecated
@@ -1216,7 +1219,61 @@ interface external$1 {
1216
1219
  icon?: string;
1217
1220
  /** @description Friendly name of this Composition's Definition */
1218
1221
  typeName?: string;
1219
- /** @description List of locales that the composition is available in. If empty, available in all locales */
1222
+ /**
1223
+ * @description List of locales that the composition _or any of its editions_ is available in.
1224
+ * If empty, available in all locales.
1225
+ */
1226
+ locales: string[];
1227
+ /** @description Priority of the composition relative to any editions */
1228
+ editionPriority?: number;
1229
+ /** @description Friendly name of the edition */
1230
+ editionName?: string;
1231
+ /**
1232
+ * @deprecated
1233
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
1234
+ * where the editionID equals the node's compositionID.
1235
+ */
1236
+ editions?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
1237
+ };
1238
+ /**
1239
+ * @deprecated
1240
+ * @description Basic information about a composition edition from the context of a project map node
1241
+ */
1242
+ ProjectMapNodeCompositionEditionData: {
1243
+ /**
1244
+ * Format: uuid
1245
+ * @description The UUID of the linked composition
1246
+ */
1247
+ id: string;
1248
+ /** @description Type of the edition instance (public_id of its definition) */
1249
+ type: string;
1250
+ /**
1251
+ * Format: uuid
1252
+ * @description The edition UUID underneath the linked composition
1253
+ */
1254
+ editionId?: string;
1255
+ /** @description Slug pattern of this edition */
1256
+ slug?: string | null;
1257
+ /** @description Friendly name of the linked composition */
1258
+ name: string;
1259
+ /** @description Friendly name of the edition */
1260
+ editionName?: string;
1261
+ /** @description Priority of the edition */
1262
+ editionPriority?: number;
1263
+ /**
1264
+ * @deprecated
1265
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1266
+ * @enum {string}
1267
+ */
1268
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1269
+ /**
1270
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
1271
+ * @default screen
1272
+ */
1273
+ icon?: string;
1274
+ /** @description Friendly name of this edition's definition */
1275
+ typeName?: string;
1276
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
1220
1277
  locales: string[];
1221
1278
  /**
1222
1279
  * Format: date-time
@@ -2066,7 +2123,7 @@ interface external {
2066
2123
  slots?: {
2067
2124
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2068
2125
  };
2069
- /** @description The public UUID of the composition */
2126
+ /** @description The ID of the composition */
2070
2127
  _id: string;
2071
2128
  /** @description Slug pattern of this component */
2072
2129
  _slug?: string | null;
@@ -2334,12 +2391,6 @@ interface external {
2334
2391
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
2335
2392
  */
2336
2393
  optionalPatternParameter?: boolean;
2337
- /**
2338
- * @description Resolve this data resource with draft mode content. TBD
2339
- *
2340
- * @enum {string}
2341
- */
2342
- dataSourceVariant?: "unpublished";
2343
2394
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2344
2395
  };
2345
2396
  /** @description Variable values for a data resource */
@@ -2582,7 +2633,7 @@ interface external {
2582
2633
  id?: string;
2583
2634
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
2584
2635
  path?: string;
2585
- /** Composition id to find associated sitemap nodes for */
2636
+ /** Composition id to find associated project map node for */
2586
2637
  compositionId?: string;
2587
2638
  /** Limit the number or records returned by a number */
2588
2639
  limit?: number;
@@ -2801,18 +2852,27 @@ interface external {
2801
2852
  */
2802
2853
  id?: string;
2803
2854
  }[];
2804
- /** @description Basic information about a composition from the context of a project map node */
2855
+ /**
2856
+ * @description Basic information about the linked composition from the context of a project map node.
2857
+ * If the linked composition has editions, the editions are included in the `editions` property.
2858
+ */
2805
2859
  ProjectMapNodeCompositionData: {
2806
- /** @description Type of the composition instance (public_id of its definition) */
2860
+ /** @description Type of the linked composition (id of its definition) */
2807
2861
  type: string;
2808
2862
  /**
2809
2863
  * Format: uuid
2810
- * @description The public UUID of the composition
2864
+ * @description The UUID of the linked composition
2811
2865
  */
2812
2866
  id: string;
2813
- /** @description Slug pattern of this composition */
2867
+ /**
2868
+ * Format: uuid
2869
+ * @description The edition UUID underneath the linked composition
2870
+ * This is only present if the composition has not been published, but an edition has
2871
+ */
2872
+ editionId?: string;
2873
+ /** @description Slug pattern of the linked composition or edition */
2814
2874
  slug?: string | null;
2815
- /** @description Friendly name of this composition */
2875
+ /** @description Friendly name of this composition or edition */
2816
2876
  name: string;
2817
2877
  /**
2818
2878
  * @deprecated
@@ -2827,7 +2887,61 @@ interface external {
2827
2887
  icon?: string;
2828
2888
  /** @description Friendly name of this Composition's Definition */
2829
2889
  typeName?: string;
2830
- /** @description List of locales that the composition is available in. If empty, available in all locales */
2890
+ /**
2891
+ * @description List of locales that the composition _or any of its editions_ is available in.
2892
+ * If empty, available in all locales.
2893
+ */
2894
+ locales: string[];
2895
+ /** @description Priority of the composition relative to any editions */
2896
+ editionPriority?: number;
2897
+ /** @description Friendly name of the edition */
2898
+ editionName?: string;
2899
+ /**
2900
+ * @deprecated
2901
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
2902
+ * where the editionID equals the node's compositionID.
2903
+ */
2904
+ editions?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
2905
+ };
2906
+ /**
2907
+ * @deprecated
2908
+ * @description Basic information about a composition edition from the context of a project map node
2909
+ */
2910
+ ProjectMapNodeCompositionEditionData: {
2911
+ /**
2912
+ * Format: uuid
2913
+ * @description The UUID of the linked composition
2914
+ */
2915
+ id: string;
2916
+ /** @description Type of the edition instance (public_id of its definition) */
2917
+ type: string;
2918
+ /**
2919
+ * Format: uuid
2920
+ * @description The edition UUID underneath the linked composition
2921
+ */
2922
+ editionId?: string;
2923
+ /** @description Slug pattern of this edition */
2924
+ slug?: string | null;
2925
+ /** @description Friendly name of the linked composition */
2926
+ name: string;
2927
+ /** @description Friendly name of the edition */
2928
+ editionName?: string;
2929
+ /** @description Priority of the edition */
2930
+ editionPriority?: number;
2931
+ /**
2932
+ * @deprecated
2933
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
2934
+ * @enum {string}
2935
+ */
2936
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
2937
+ /**
2938
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
2939
+ * @default screen
2940
+ */
2941
+ icon?: string;
2942
+ /** @description Friendly name of this edition's definition */
2943
+ typeName?: string;
2944
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
2831
2945
  locales: string[];
2832
2946
  /**
2833
2947
  * Format: date-time
package/dist/index.d.ts CHANGED
@@ -414,7 +414,7 @@ interface components$1 {
414
414
  slots?: {
415
415
  [key: string]: components$1["schemas"]["ComponentInstance"][];
416
416
  };
417
- /** @description The public UUID of the composition */
417
+ /** @description The ID of the composition */
418
418
  _id: string;
419
419
  /** @description Slug pattern of this component */
420
420
  _slug?: string | null;
@@ -682,12 +682,6 @@ interface components$1 {
682
682
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
683
683
  */
684
684
  optionalPatternParameter?: boolean;
685
- /**
686
- * @description Resolve this data resource with draft mode content. TBD
687
- *
688
- * @enum {string}
689
- */
690
- dataSourceVariant?: "unpublished";
691
685
  variables?: components$1["schemas"]["DataResourceVariables"];
692
686
  };
693
687
  /** @description Variable values for a data resource */
@@ -971,7 +965,7 @@ interface external$1 {
971
965
  id?: string;
972
966
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
973
967
  path?: string;
974
- /** Composition id to find associated sitemap nodes for */
968
+ /** Composition id to find associated project map node for */
975
969
  compositionId?: string;
976
970
  /** Limit the number or records returned by a number */
977
971
  limit?: number;
@@ -1190,18 +1184,27 @@ interface external$1 {
1190
1184
  */
1191
1185
  id?: string;
1192
1186
  }[];
1193
- /** @description Basic information about a composition from the context of a project map node */
1187
+ /**
1188
+ * @description Basic information about the linked composition from the context of a project map node.
1189
+ * If the linked composition has editions, the editions are included in the `editions` property.
1190
+ */
1194
1191
  ProjectMapNodeCompositionData: {
1195
- /** @description Type of the composition instance (public_id of its definition) */
1192
+ /** @description Type of the linked composition (id of its definition) */
1196
1193
  type: string;
1197
1194
  /**
1198
1195
  * Format: uuid
1199
- * @description The public UUID of the composition
1196
+ * @description The UUID of the linked composition
1200
1197
  */
1201
1198
  id: string;
1202
- /** @description Slug pattern of this composition */
1199
+ /**
1200
+ * Format: uuid
1201
+ * @description The edition UUID underneath the linked composition
1202
+ * This is only present if the composition has not been published, but an edition has
1203
+ */
1204
+ editionId?: string;
1205
+ /** @description Slug pattern of the linked composition or edition */
1203
1206
  slug?: string | null;
1204
- /** @description Friendly name of this composition */
1207
+ /** @description Friendly name of this composition or edition */
1205
1208
  name: string;
1206
1209
  /**
1207
1210
  * @deprecated
@@ -1216,7 +1219,61 @@ interface external$1 {
1216
1219
  icon?: string;
1217
1220
  /** @description Friendly name of this Composition's Definition */
1218
1221
  typeName?: string;
1219
- /** @description List of locales that the composition is available in. If empty, available in all locales */
1222
+ /**
1223
+ * @description List of locales that the composition _or any of its editions_ is available in.
1224
+ * If empty, available in all locales.
1225
+ */
1226
+ locales: string[];
1227
+ /** @description Priority of the composition relative to any editions */
1228
+ editionPriority?: number;
1229
+ /** @description Friendly name of the edition */
1230
+ editionName?: string;
1231
+ /**
1232
+ * @deprecated
1233
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
1234
+ * where the editionID equals the node's compositionID.
1235
+ */
1236
+ editions?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
1237
+ };
1238
+ /**
1239
+ * @deprecated
1240
+ * @description Basic information about a composition edition from the context of a project map node
1241
+ */
1242
+ ProjectMapNodeCompositionEditionData: {
1243
+ /**
1244
+ * Format: uuid
1245
+ * @description The UUID of the linked composition
1246
+ */
1247
+ id: string;
1248
+ /** @description Type of the edition instance (public_id of its definition) */
1249
+ type: string;
1250
+ /**
1251
+ * Format: uuid
1252
+ * @description The edition UUID underneath the linked composition
1253
+ */
1254
+ editionId?: string;
1255
+ /** @description Slug pattern of this edition */
1256
+ slug?: string | null;
1257
+ /** @description Friendly name of the linked composition */
1258
+ name: string;
1259
+ /** @description Friendly name of the edition */
1260
+ editionName?: string;
1261
+ /** @description Priority of the edition */
1262
+ editionPriority?: number;
1263
+ /**
1264
+ * @deprecated
1265
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1266
+ * @enum {string}
1267
+ */
1268
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1269
+ /**
1270
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
1271
+ * @default screen
1272
+ */
1273
+ icon?: string;
1274
+ /** @description Friendly name of this edition's definition */
1275
+ typeName?: string;
1276
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
1220
1277
  locales: string[];
1221
1278
  /**
1222
1279
  * Format: date-time
@@ -2066,7 +2123,7 @@ interface external {
2066
2123
  slots?: {
2067
2124
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2068
2125
  };
2069
- /** @description The public UUID of the composition */
2126
+ /** @description The ID of the composition */
2070
2127
  _id: string;
2071
2128
  /** @description Slug pattern of this component */
2072
2129
  _slug?: string | null;
@@ -2334,12 +2391,6 @@ interface external {
2334
2391
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
2335
2392
  */
2336
2393
  optionalPatternParameter?: boolean;
2337
- /**
2338
- * @description Resolve this data resource with draft mode content. TBD
2339
- *
2340
- * @enum {string}
2341
- */
2342
- dataSourceVariant?: "unpublished";
2343
2394
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2344
2395
  };
2345
2396
  /** @description Variable values for a data resource */
@@ -2582,7 +2633,7 @@ interface external {
2582
2633
  id?: string;
2583
2634
  /** The path of the root node to retrieve, cannot have both this parameter and `id` */
2584
2635
  path?: string;
2585
- /** Composition id to find associated sitemap nodes for */
2636
+ /** Composition id to find associated project map node for */
2586
2637
  compositionId?: string;
2587
2638
  /** Limit the number or records returned by a number */
2588
2639
  limit?: number;
@@ -2801,18 +2852,27 @@ interface external {
2801
2852
  */
2802
2853
  id?: string;
2803
2854
  }[];
2804
- /** @description Basic information about a composition from the context of a project map node */
2855
+ /**
2856
+ * @description Basic information about the linked composition from the context of a project map node.
2857
+ * If the linked composition has editions, the editions are included in the `editions` property.
2858
+ */
2805
2859
  ProjectMapNodeCompositionData: {
2806
- /** @description Type of the composition instance (public_id of its definition) */
2860
+ /** @description Type of the linked composition (id of its definition) */
2807
2861
  type: string;
2808
2862
  /**
2809
2863
  * Format: uuid
2810
- * @description The public UUID of the composition
2864
+ * @description The UUID of the linked composition
2811
2865
  */
2812
2866
  id: string;
2813
- /** @description Slug pattern of this composition */
2867
+ /**
2868
+ * Format: uuid
2869
+ * @description The edition UUID underneath the linked composition
2870
+ * This is only present if the composition has not been published, but an edition has
2871
+ */
2872
+ editionId?: string;
2873
+ /** @description Slug pattern of the linked composition or edition */
2814
2874
  slug?: string | null;
2815
- /** @description Friendly name of this composition */
2875
+ /** @description Friendly name of this composition or edition */
2816
2876
  name: string;
2817
2877
  /**
2818
2878
  * @deprecated
@@ -2827,7 +2887,61 @@ interface external {
2827
2887
  icon?: string;
2828
2888
  /** @description Friendly name of this Composition's Definition */
2829
2889
  typeName?: string;
2830
- /** @description List of locales that the composition is available in. If empty, available in all locales */
2890
+ /**
2891
+ * @description List of locales that the composition _or any of its editions_ is available in.
2892
+ * If empty, available in all locales.
2893
+ */
2894
+ locales: string[];
2895
+ /** @description Priority of the composition relative to any editions */
2896
+ editionPriority?: number;
2897
+ /** @description Friendly name of the edition */
2898
+ editionName?: string;
2899
+ /**
2900
+ * @deprecated
2901
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
2902
+ * where the editionID equals the node's compositionID.
2903
+ */
2904
+ editions?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
2905
+ };
2906
+ /**
2907
+ * @deprecated
2908
+ * @description Basic information about a composition edition from the context of a project map node
2909
+ */
2910
+ ProjectMapNodeCompositionEditionData: {
2911
+ /**
2912
+ * Format: uuid
2913
+ * @description The UUID of the linked composition
2914
+ */
2915
+ id: string;
2916
+ /** @description Type of the edition instance (public_id of its definition) */
2917
+ type: string;
2918
+ /**
2919
+ * Format: uuid
2920
+ * @description The edition UUID underneath the linked composition
2921
+ */
2922
+ editionId?: string;
2923
+ /** @description Slug pattern of this edition */
2924
+ slug?: string | null;
2925
+ /** @description Friendly name of the linked composition */
2926
+ name: string;
2927
+ /** @description Friendly name of the edition */
2928
+ editionName?: string;
2929
+ /** @description Priority of the edition */
2930
+ editionPriority?: number;
2931
+ /**
2932
+ * @deprecated
2933
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
2934
+ * @enum {string}
2935
+ */
2936
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
2937
+ /**
2938
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
2939
+ * @default screen
2940
+ */
2941
+ icon?: string;
2942
+ /** @description Friendly name of this edition's definition */
2943
+ typeName?: string;
2944
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
2831
2945
  locales: string[];
2832
2946
  /**
2833
2947
  * Format: date-time
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.186.2-alpha.14+2868049c36",
3
+ "version": "19.186.4-alpha.29+03de47b2a8",
4
4
  "description": "Uniform Assets",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -36,7 +36,7 @@
36
36
  "access": "public"
37
37
  },
38
38
  "dependencies": {
39
- "@uniformdev/context": "19.186.2-alpha.14+2868049c36"
39
+ "@uniformdev/context": "19.186.4-alpha.29+03de47b2a8"
40
40
  },
41
- "gitHead": "2868049c365d370abc91762e89dc845c61c02b78"
41
+ "gitHead": "03de47b2a82e853fe3a989a5a60f352c74ed2777"
42
42
  }