@uniformdev/assets 20.72.3-alpha.3 → 20.72.3-alpha.45

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;
         };
@@ -1809,9 +1811,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']>;
@@ -1870,14 +1883,20 @@ type ImageFromTransformProps = XOR<{
         y: number;
     };
 }>;
+/**
+ * Fluent API for reading and transforming an asset image URL.
+ */
+interface ImageFromApi {
+    /** Returns the image URL with the current transformations applied. */
+    url: () => string;
+    /** Applies image transformations and returns the same fluent API. */
+    transform: (transformProps: ImageFromTransformProps) => ImageFromApi;
+}
 /**
  * A helper function for extracting the image URL from an asset and optionally
  * applying transformation URL query parameters.
  */
-declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => {
-    url: () => string;
-    transform: (transformProps: ImageFromTransformProps) => /*elided*/ any;
-};
+declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => ImageFromApi;
 
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
@@ -1888,4 +1907,4 @@ declare function convertAssetToPutAsset(asset: {
     projectId: string;
 }): AssetUpsertRequest;
 
-export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };
+export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

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;
         };
@@ -1809,9 +1811,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']>;
@@ -1870,14 +1883,20 @@ type ImageFromTransformProps = XOR<{
         y: number;
     };
 }>;
+/**
+ * Fluent API for reading and transforming an asset image URL.
+ */
+interface ImageFromApi {
+    /** Returns the image URL with the current transformations applied. */
+    url: () => string;
+    /** Applies image transformations and returns the same fluent API. */
+    transform: (transformProps: ImageFromTransformProps) => ImageFromApi;
+}
 /**
  * A helper function for extracting the image URL from an asset and optionally
  * applying transformation URL query parameters.
  */
-declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => {
-    url: () => string;
-    transform: (transformProps: ImageFromTransformProps) => /*elided*/ any;
-};
+declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => ImageFromApi;
 
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
@@ -1888,4 +1907,4 @@ declare function convertAssetToPutAsset(asset: {
     projectId: string;
 }): AssetUpsertRequest;
 
-export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };
+export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

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.72.3-alpha.3+3e396259ba",
+  "version": "20.72.3-alpha.45+2b8b05d58a",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -21,11 +21,12 @@
   "sideEffects": false,
   "scripts": {
     "build": "run-s update-openapi build:ts",
-    "build:ts": "tsup",
+    "build:ts": "tsup && pnpm test:types",
     "dev": "run-s update-openapi dev:ts",
     "dev:ts": "tsup --watch",
     "clean": "rimraf dist",
     "test": "vitest run",
+    "test:types": "tsc --ignoreConfig --noEmit --strict --skipLibCheck --module esnext --moduleResolution bundler --target es2018 type-tests/imageFrom.ts",
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
     "update-openapi": "tsx ./scripts/update-openapi.cts"
   },
@@ -36,11 +37,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.72.3-alpha.3+3e396259ba",
-    "@uniformdev/files": "20.72.3-alpha.3+3e396259ba"
+    "@uniformdev/context": "20.72.3-alpha.45+2b8b05d58a",
+    "@uniformdev/files": "20.72.3-alpha.45+2b8b05d58a"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "3e396259bafc25b69071cda4102cea340b866922"
+  "gitHead": "2b8b05d58ab275b4d29a9647feeaad47b0ab5cce"
 }