@uniformdev/assets 20.74.4 → 20.74.5-alpha.5

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 +41 -6
  2. package/dist/index.d.ts +41 -6
  3. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -1120,6 +1120,14 @@ interface paths {
1120
1120
  * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1121
1121
  */
1122
1122
  withUIStatus?: components["parameters"]["withUIStatus"];
1123
+ /**
1124
+ * @description Controls filtering of trashed items.
1125
+ *
1126
+ * exclude: (default) Only return items not in trash.
1127
+ * only: Only return trashed items (for trash view).
1128
+ * include: Return both trashed and non-trashed items.
1129
+ */
1130
+ deleted?: components["parameters"]["deleted"];
1123
1131
  };
1124
1132
  header?: never;
1125
1133
  path?: never;
@@ -1155,7 +1163,10 @@ interface paths {
1155
1163
  500: components["responses"]["InternalServerError"];
1156
1164
  };
1157
1165
  };
1158
- /** @description Upserts an asset */
1166
+ /**
1167
+ * @description Creates or updates assets. Submitting the ID of a trashed asset restores it.
1168
+ * A file-backed asset must include its original file reference when restored.
1169
+ */
1159
1170
  put: {
1160
1171
  parameters: {
1161
1172
  query?: never;
@@ -1197,7 +1208,10 @@ interface paths {
1197
1208
  };
1198
1209
  };
1199
1210
  post?: never;
1200
- /** @description Deletes or unpublishes an asset */
1211
+ /**
1212
+ * @description Moves an asset to trash. Trashed assets are omitted from default GET results and
1213
+ * permanently deleted after the configured retention period.
1214
+ */
1201
1215
  delete: {
1202
1216
  parameters: {
1203
1217
  query?: never;
@@ -1210,12 +1224,12 @@ interface paths {
1210
1224
  "application/json": {
1211
1225
  /**
1212
1226
  * Format: uuid
1213
- * @description The ID of the asset to delete
1227
+ * @description The ID of the asset to move to trash
1214
1228
  */
1215
1229
  assetId: string;
1216
1230
  /**
1217
1231
  * Format: uuid
1218
- * @description The ID of the project the asset to delete belongs to
1232
+ * @description The ID of the project the asset belongs to
1219
1233
  */
1220
1234
  projectId: string;
1221
1235
  /**
@@ -1298,8 +1312,12 @@ interface components {
1298
1312
  /** @constant */
1299
1313
  type: "text";
1300
1314
  };
1315
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1301
1316
  file?: {
1302
- /** Format: uuid */
1317
+ /**
1318
+ * Format: uuid
1319
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1320
+ */
1303
1321
  value: string;
1304
1322
  /** @constant */
1305
1323
  type: "file";
@@ -1368,8 +1386,12 @@ interface components {
1368
1386
  /** @constant */
1369
1387
  type: "text";
1370
1388
  };
1389
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1371
1390
  file?: {
1372
- /** Format: uuid */
1391
+ /**
1392
+ * Format: uuid
1393
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1394
+ */
1373
1395
  value: string;
1374
1396
  /** @constant */
1375
1397
  type: "file";
@@ -1403,6 +1425,11 @@ interface components {
1403
1425
  * @description Modified date string for this definition
1404
1426
  */
1405
1427
  modified: string;
1428
+ /**
1429
+ * Format: date-time
1430
+ * @description Timestamp when the item was moved to trash. Omitted if not in trash.
1431
+ */
1432
+ deletedAt?: string;
1406
1433
  /**
1407
1434
  * Format: uuid
1408
1435
  * @description The release this asset belongs to. If not set, the asset belongs to the base
@@ -1705,6 +1732,14 @@ interface components {
1705
1732
  * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1706
1733
  */
1707
1734
  withUIStatus: boolean;
1735
+ /**
1736
+ * @description Controls filtering of trashed items.
1737
+ *
1738
+ * exclude: (default) Only return items not in trash.
1739
+ * only: Only return trashed items (for trash view).
1740
+ * include: Return both trashed and non-trashed items.
1741
+ */
1742
+ deleted: "exclude" | "only" | "include";
1708
1743
  };
1709
1744
  requestBodies: never;
1710
1745
  headers: never;
package/dist/index.d.ts CHANGED
@@ -1120,6 +1120,14 @@ interface paths {
1120
1120
  * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1121
1121
  */
1122
1122
  withUIStatus?: components["parameters"]["withUIStatus"];
1123
+ /**
1124
+ * @description Controls filtering of trashed items.
1125
+ *
1126
+ * exclude: (default) Only return items not in trash.
1127
+ * only: Only return trashed items (for trash view).
1128
+ * include: Return both trashed and non-trashed items.
1129
+ */
1130
+ deleted?: components["parameters"]["deleted"];
1123
1131
  };
1124
1132
  header?: never;
1125
1133
  path?: never;
@@ -1155,7 +1163,10 @@ interface paths {
1155
1163
  500: components["responses"]["InternalServerError"];
1156
1164
  };
1157
1165
  };
1158
- /** @description Upserts an asset */
1166
+ /**
1167
+ * @description Creates or updates assets. Submitting the ID of a trashed asset restores it.
1168
+ * A file-backed asset must include its original file reference when restored.
1169
+ */
1159
1170
  put: {
1160
1171
  parameters: {
1161
1172
  query?: never;
@@ -1197,7 +1208,10 @@ interface paths {
1197
1208
  };
1198
1209
  };
1199
1210
  post?: never;
1200
- /** @description Deletes or unpublishes an asset */
1211
+ /**
1212
+ * @description Moves an asset to trash. Trashed assets are omitted from default GET results and
1213
+ * permanently deleted after the configured retention period.
1214
+ */
1201
1215
  delete: {
1202
1216
  parameters: {
1203
1217
  query?: never;
@@ -1210,12 +1224,12 @@ interface paths {
1210
1224
  "application/json": {
1211
1225
  /**
1212
1226
  * Format: uuid
1213
- * @description The ID of the asset to delete
1227
+ * @description The ID of the asset to move to trash
1214
1228
  */
1215
1229
  assetId: string;
1216
1230
  /**
1217
1231
  * Format: uuid
1218
- * @description The ID of the project the asset to delete belongs to
1232
+ * @description The ID of the project the asset belongs to
1219
1233
  */
1220
1234
  projectId: string;
1221
1235
  /**
@@ -1298,8 +1312,12 @@ interface components {
1298
1312
  /** @constant */
1299
1313
  type: "text";
1300
1314
  };
1315
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1301
1316
  file?: {
1302
- /** Format: uuid */
1317
+ /**
1318
+ * Format: uuid
1319
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1320
+ */
1303
1321
  value: string;
1304
1322
  /** @constant */
1305
1323
  type: "file";
@@ -1368,8 +1386,12 @@ interface components {
1368
1386
  /** @constant */
1369
1387
  type: "text";
1370
1388
  };
1389
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1371
1390
  file?: {
1372
- /** Format: uuid */
1391
+ /**
1392
+ * Format: uuid
1393
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1394
+ */
1373
1395
  value: string;
1374
1396
  /** @constant */
1375
1397
  type: "file";
@@ -1403,6 +1425,11 @@ interface components {
1403
1425
  * @description Modified date string for this definition
1404
1426
  */
1405
1427
  modified: string;
1428
+ /**
1429
+ * Format: date-time
1430
+ * @description Timestamp when the item was moved to trash. Omitted if not in trash.
1431
+ */
1432
+ deletedAt?: string;
1406
1433
  /**
1407
1434
  * Format: uuid
1408
1435
  * @description The release this asset belongs to. If not set, the asset belongs to the base
@@ -1705,6 +1732,14 @@ interface components {
1705
1732
  * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1706
1733
  */
1707
1734
  withUIStatus: boolean;
1735
+ /**
1736
+ * @description Controls filtering of trashed items.
1737
+ *
1738
+ * exclude: (default) Only return items not in trash.
1739
+ * only: Only return trashed items (for trash view).
1740
+ * include: Return both trashed and non-trashed items.
1741
+ */
1742
+ deleted: "exclude" | "only" | "include";
1708
1743
  };
1709
1744
  requestBodies: never;
1710
1745
  headers: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "20.74.4",
3
+ "version": "20.74.5-alpha.5+f0dbc3befe",
4
4
  "description": "Uniform Assets",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -37,11 +37,11 @@
37
37
  "access": "public"
38
38
  },
39
39
  "dependencies": {
40
- "@uniformdev/context": "20.74.4",
41
- "@uniformdev/files": "20.74.4"
40
+ "@uniformdev/context": "20.74.5-alpha.5+f0dbc3befe",
41
+ "@uniformdev/files": "20.74.5-alpha.5+f0dbc3befe"
42
42
  },
43
43
  "devDependencies": {
44
44
  "ts-xor": "^1.3.0"
45
45
  },
46
- "gitHead": "a929ae8eded833daa45768fe470bed14b5e6af65"
46
+ "gitHead": "f0dbc3befe92a152b47994f7b20448ca027ae39a"
47
47
  }