@uniformdev/assets 20.74.1 → 20.74.2-alpha.26

package/dist/index.d.mts

@@ -764,9 +764,11 @@ interface components$1 {
             versionId: string;
             /** @description The timestamp when the version was created in epoch milliseconds */
             timestamp: number;
-            /** @description The name (full name) of the user who created the version */
+            /** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
             authorName: string;
             authorIsApiKey: boolean;
+            /** @description The identity who created the version; absent on old history entries. */
+            authorSubject?: string;
             /** @description The state of the entity when the history entry was made */
             state: number;
         };
@@ -1120,6 +1122,14 @@ interface paths {
                      *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
                      */
                     withUIStatus?: components["parameters"]["withUIStatus"];
+                    /**
+                     * @description Controls filtering of trashed items.
+                     *
+                     *     exclude: (default) Only return items not in trash.
+                     *     only: Only return trashed items (for trash view).
+                     *     include: Return both trashed and non-trashed items.
+                     */
+                    deleted?: components["parameters"]["deleted"];
                 };
                 header?: never;
                 path?: never;
@@ -1155,7 +1165,10 @@ interface paths {
                 500: components["responses"]["InternalServerError"];
             };
         };
-        /** @description Upserts an asset */
+        /**
+         * @description Creates or updates assets. Submitting the ID of a trashed asset restores it.
+         *     A file-backed asset must include its original file reference when restored.
+         */
         put: {
             parameters: {
                 query?: never;
@@ -1197,7 +1210,10 @@ interface paths {
             };
         };
         post?: never;
-        /** @description Deletes or unpublishes an asset */
+        /**
+         * @description Moves an asset to trash. Trashed assets are omitted from default GET results and
+         *     permanently deleted after the configured retention period.
+         */
         delete: {
             parameters: {
                 query?: never;
@@ -1210,12 +1226,12 @@ interface paths {
                     "application/json": {
                         /**
                          * Format: uuid
-                         * @description The ID of the asset to delete
+                         * @description The ID of the asset to move to trash
                          */
                         assetId: string;
                         /**
                          * Format: uuid
-                         * @description The ID of the project the asset to delete belongs to
+                         * @description The ID of the project the asset belongs to
                          */
                         projectId: string;
                         /**
@@ -1298,8 +1314,12 @@ interface components {
                     /** @constant */
                     type: "text";
                 };
+                /** @description An asset can reference at most one file. A file can be attached to only one asset. */
                 file?: {
-                    /** Format: uuid */
+                    /**
+                     * Format: uuid
+                     * @description File ID to attach. A trashed file cannot be attached to an active asset.
+                     */
                     value: string;
                     /** @constant */
                     type: "file";
@@ -1368,8 +1388,12 @@ interface components {
                     /** @constant */
                     type: "text";
                 };
+                /** @description An asset can reference at most one file. A file can be attached to only one asset. */
                 file?: {
-                    /** Format: uuid */
+                    /**
+                     * Format: uuid
+                     * @description File ID to attach. A trashed file cannot be attached to an active asset.
+                     */
                     value: string;
                     /** @constant */
                     type: "file";
@@ -1403,6 +1427,11 @@ interface components {
              * @description Modified date string for this definition
              */
             modified: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the item was moved to trash. Omitted if not in trash.
+             */
+            deletedAt?: string;
             /**
              * Format: uuid
              * @description The release this asset belongs to. If not set, the asset belongs to the base
@@ -1705,6 +1734,14 @@ interface components {
          *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
          */
         withUIStatus: boolean;
+        /**
+         * @description Controls filtering of trashed items.
+         *
+         *     exclude: (default) Only return items not in trash.
+         *     only: Only return trashed items (for trash view).
+         *     include: Return both trashed and non-trashed items.
+         */
+        deleted: "exclude" | "only" | "include";
     };
     requestBodies: never;
     headers: never;
@@ -1809,9 +1846,20 @@ declare class AssetClient extends ApiClient {
     get(options: WithoutProjectId<AssetGetRequestList> & {
         filters?: Record<string, unknown>;
     }): Promise<AssetGetResponseList>;
+    /**
+     * Fetches a list of assets
+     */
+    list(options?: WithoutProjectId<AssetGetRequestList> & {
+        filters?: Record<string, unknown>;
+    }): Promise<AssetGetResponseList>;
+    save(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
+    /** @deprecated Use {@link save} instead. */
     upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
+    remove(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
+    /** @deprecated Use {@link remove} instead. */
     delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
 }
+/** @deprecated Pass `bypassCache: true` to {@link AssetClient} instead. */
 declare class UncachedAssetClient extends AssetClient {
     constructor(options: Omit<ClientOptions & {
         projectId: NonNullable<ClientOptions['projectId']>;

package/dist/index.d.ts

@@ -764,9 +764,11 @@ interface components$1 {
             versionId: string;
             /** @description The timestamp when the version was created in epoch milliseconds */
             timestamp: number;
-            /** @description The name (full name) of the user who created the version */
+            /** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
             authorName: string;
             authorIsApiKey: boolean;
+            /** @description The identity who created the version; absent on old history entries. */
+            authorSubject?: string;
             /** @description The state of the entity when the history entry was made */
             state: number;
         };
@@ -1120,6 +1122,14 @@ interface paths {
                      *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
                      */
                     withUIStatus?: components["parameters"]["withUIStatus"];
+                    /**
+                     * @description Controls filtering of trashed items.
+                     *
+                     *     exclude: (default) Only return items not in trash.
+                     *     only: Only return trashed items (for trash view).
+                     *     include: Return both trashed and non-trashed items.
+                     */
+                    deleted?: components["parameters"]["deleted"];
                 };
                 header?: never;
                 path?: never;
@@ -1155,7 +1165,10 @@ interface paths {
                 500: components["responses"]["InternalServerError"];
             };
         };
-        /** @description Upserts an asset */
+        /**
+         * @description Creates or updates assets. Submitting the ID of a trashed asset restores it.
+         *     A file-backed asset must include its original file reference when restored.
+         */
         put: {
             parameters: {
                 query?: never;
@@ -1197,7 +1210,10 @@ interface paths {
             };
         };
         post?: never;
-        /** @description Deletes or unpublishes an asset */
+        /**
+         * @description Moves an asset to trash. Trashed assets are omitted from default GET results and
+         *     permanently deleted after the configured retention period.
+         */
         delete: {
             parameters: {
                 query?: never;
@@ -1210,12 +1226,12 @@ interface paths {
                     "application/json": {
                         /**
                          * Format: uuid
-                         * @description The ID of the asset to delete
+                         * @description The ID of the asset to move to trash
                          */
                         assetId: string;
                         /**
                          * Format: uuid
-                         * @description The ID of the project the asset to delete belongs to
+                         * @description The ID of the project the asset belongs to
                          */
                         projectId: string;
                         /**
@@ -1298,8 +1314,12 @@ interface components {
                     /** @constant */
                     type: "text";
                 };
+                /** @description An asset can reference at most one file. A file can be attached to only one asset. */
                 file?: {
-                    /** Format: uuid */
+                    /**
+                     * Format: uuid
+                     * @description File ID to attach. A trashed file cannot be attached to an active asset.
+                     */
                     value: string;
                     /** @constant */
                     type: "file";
@@ -1368,8 +1388,12 @@ interface components {
                     /** @constant */
                     type: "text";
                 };
+                /** @description An asset can reference at most one file. A file can be attached to only one asset. */
                 file?: {
-                    /** Format: uuid */
+                    /**
+                     * Format: uuid
+                     * @description File ID to attach. A trashed file cannot be attached to an active asset.
+                     */
                     value: string;
                     /** @constant */
                     type: "file";
@@ -1403,6 +1427,11 @@ interface components {
              * @description Modified date string for this definition
              */
             modified: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the item was moved to trash. Omitted if not in trash.
+             */
+            deletedAt?: string;
             /**
              * Format: uuid
              * @description The release this asset belongs to. If not set, the asset belongs to the base
@@ -1705,6 +1734,14 @@ interface components {
          *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
          */
         withUIStatus: boolean;
+        /**
+         * @description Controls filtering of trashed items.
+         *
+         *     exclude: (default) Only return items not in trash.
+         *     only: Only return trashed items (for trash view).
+         *     include: Return both trashed and non-trashed items.
+         */
+        deleted: "exclude" | "only" | "include";
     };
     requestBodies: never;
     headers: never;
@@ -1809,9 +1846,20 @@ declare class AssetClient extends ApiClient {
     get(options: WithoutProjectId<AssetGetRequestList> & {
         filters?: Record<string, unknown>;
     }): Promise<AssetGetResponseList>;
+    /**
+     * Fetches a list of assets
+     */
+    list(options?: WithoutProjectId<AssetGetRequestList> & {
+        filters?: Record<string, unknown>;
+    }): Promise<AssetGetResponseList>;
+    save(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
+    /** @deprecated Use {@link save} instead. */
     upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
+    remove(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
+    /** @deprecated Use {@link remove} instead. */
     delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
 }
+/** @deprecated Pass `bypassCache: true` to {@link AssetClient} instead. */
 declare class UncachedAssetClient extends AssetClient {
     constructor(options: Omit<ClientOptions & {
         projectId: NonNullable<ClientOptions['projectId']>;

package/dist/index.esm.js

@@ -16,7 +16,21 @@ var AssetClient = class extends ApiClient {
     });
     return this.apiClient(fetchUri);
   }
-  async upsert(options) {
+  /**
+   * Fetches a list of assets
+   */
+  async list(options = {}) {
+    const { projectId } = this.options;
+    const { filters, ...params } = options;
+    const rewrittenFilters = rewriteFiltersForApi(filters);
+    const fetchUri = this.createUrl(ASSET_BASE_PATH, {
+      ...params,
+      projectId,
+      ...rewrittenFilters
+    });
+    return this.apiClient(fetchUri);
+  }
+  async save(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -25,7 +39,11 @@ var AssetClient = class extends ApiClient {
       expectNoContent: true
     });
   }
-  async delete(options) {
+  /** @deprecated Use {@link save} instead. */
+  async upsert(options) {
+    return this.save(options);
+  }
+  async remove(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -34,6 +52,10 @@ var AssetClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link remove} instead. */
+  async delete(options) {
+    return this.remove(options);
+  }
 };
 var UncachedAssetClient = class extends AssetClient {
   constructor(options) {

package/dist/index.js

@@ -47,7 +47,21 @@ var AssetClient = class extends import_api.ApiClient {
     });
     return this.apiClient(fetchUri);
   }
-  async upsert(options) {
+  /**
+   * Fetches a list of assets
+   */
+  async list(options = {}) {
+    const { projectId } = this.options;
+    const { filters, ...params } = options;
+    const rewrittenFilters = (0, import_api.rewriteFiltersForApi)(filters);
+    const fetchUri = this.createUrl(ASSET_BASE_PATH, {
+      ...params,
+      projectId,
+      ...rewrittenFilters
+    });
+    return this.apiClient(fetchUri);
+  }
+  async save(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -56,7 +70,11 @@ var AssetClient = class extends import_api.ApiClient {
       expectNoContent: true
     });
   }
-  async delete(options) {
+  /** @deprecated Use {@link save} instead. */
+  async upsert(options) {
+    return this.save(options);
+  }
+  async remove(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -65,6 +83,10 @@ var AssetClient = class extends import_api.ApiClient {
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link remove} instead. */
+  async delete(options) {
+    return this.remove(options);
+  }
 };
 var UncachedAssetClient = class extends AssetClient {
   constructor(options) {

package/dist/index.mjs

@@ -16,7 +16,21 @@ var AssetClient = class extends ApiClient {
     });
     return this.apiClient(fetchUri);
   }
-  async upsert(options) {
+  /**
+   * Fetches a list of assets
+   */
+  async list(options = {}) {
+    const { projectId } = this.options;
+    const { filters, ...params } = options;
+    const rewrittenFilters = rewriteFiltersForApi(filters);
+    const fetchUri = this.createUrl(ASSET_BASE_PATH, {
+      ...params,
+      projectId,
+      ...rewrittenFilters
+    });
+    return this.apiClient(fetchUri);
+  }
+  async save(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -25,7 +39,11 @@ var AssetClient = class extends ApiClient {
       expectNoContent: true
     });
   }
-  async delete(options) {
+  /** @deprecated Use {@link save} instead. */
+  async upsert(options) {
+    return this.save(options);
+  }
+  async remove(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ASSET_BASE_PATH);
     await this.apiClient(fetchUri, {
@@ -34,6 +52,10 @@ var AssetClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** @deprecated Use {@link remove} instead. */
+  async delete(options) {
+    return this.remove(options);
+  }
 };
 var UncachedAssetClient = class extends AssetClient {
   constructor(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.74.1",
+  "version": "20.74.2-alpha.26+464c3f6dc2",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -37,11 +37,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.74.1",
-    "@uniformdev/files": "20.74.1"
+    "@uniformdev/context": "20.74.2-alpha.26+464c3f6dc2",
+    "@uniformdev/files": "20.74.2-alpha.26+464c3f6dc2"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "92f9b8945a45169eaa57d41dbb7ba8d3a32564cd"
+  "gitHead": "464c3f6dc27746f5e89e2f61542ed2c458c35cc5"
 }