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

package/dist/index.d.mts

@@ -1001,6 +1001,58 @@ interface paths {
             path?: never;
             cookie?: never;
         };
+        /**
+         * @description In addition to the named parameters below, this endpoint accepts the
+         *     following query parameter convention which is pattern-validated and
+         *     therefore not declared as named parameters:
+         *
+         *     * `filters.<field>[<op>]` — content filtering (documented below).
+         *
+         *     #### Content filtering (`filters.*`)
+         *
+         *     Filtering narrows list results to assets matching field values. The
+         *     allowed field names are project-specific — they come from the project's
+         *     asset definitions — which is why `filters.*` parameters are
+         *     pattern-validated rather than declared as named parameters.
+         *
+         *     Syntax: `filters.<field>[<operator>]=<value>`. `<field>` is one of:
+         *
+         *     * A system field such as `name`, `type`, `created`, `modified`,
+         *       `entityId`, `creator`, `creatorSubject`, `author`, `authorSubject`,
+         *       `categoryId`, `labels`, `labelGroups`, or `uiStatus`.
+         *     * An asset field, addressed as `fields.<fieldId>`. Unlike entries and
+         *       compositions, asset field filters do not require a single-type
+         *       filter — but if the same field ID has differing types across asset
+         *       types, HTTP 400 is returned and a single asset type must be
+         *       filtered.
+         *
+         *     | Operator | Effect |
+         *     |---|---|
+         *     | `[eq]` / `[neq]` | Exact equality / inequality. |
+         *     | `[match]` | Contains (text search) match; text-like fields only. |
+         *     | `[starts]` | Prefix match. Value limited to letters, numbers, `_`, `.`, `-`, and spaces. |
+         *     | `[lt]` / `[lte]` / `[gt]` / `[gte]` | Comparisons for number, date, and datetime fields (including `created` / `modified`). |
+         *     | `[in]` / `[nin]` | Comma-separated list; matches any (OR) / none of the values. |
+         *     | `[all]` | Comma-separated list; list-valued fields (e.g. `labels`, multi-selects) must contain every value (AND). |
+         *     | `[def]` | `true` or `false`; whether the field has a value at all. |
+         *
+         *     Behavior:
+         *
+         *     * Values are single strings, or comma-separated lists for `[in]`,
+         *       `[nin]`, and `[all]`. Dates accept `YYYY-MM-DD` or a full datetime
+         *       string. An empty value is rejected — use `[def]` to test presence.
+         *     * Not every operator is valid for every field; the allowed set depends
+         *       on the field's type. An unsupported combination returns HTTP 400
+         *       with the supported operators listed.
+         *     * Malformed keys, unknown operators, and unknown field names return
+         *       HTTP 400.
+         *
+         *     Examples:
+         *
+         *     * `filters.type[eq]=productImage` — only assets of type `productImage`.
+         *     * `filters.modified[gte]=2026-01-01` — modified this year.
+         *     * `filters.fields.altText[def]=false` — assets missing alt text.
+         */
         get: {
             parameters: {
                 query: {
@@ -1818,20 +1870,14 @@ 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) => ImageFromApi;
+declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => {
+    url: () => string;
+    transform: (transformProps: ImageFromTransformProps) => /*elided*/ any;
+};
 
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
@@ -1842,4 +1888,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 ImageFromApi, 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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/dist/index.d.ts

@@ -1001,6 +1001,58 @@ interface paths {
             path?: never;
             cookie?: never;
         };
+        /**
+         * @description In addition to the named parameters below, this endpoint accepts the
+         *     following query parameter convention which is pattern-validated and
+         *     therefore not declared as named parameters:
+         *
+         *     * `filters.<field>[<op>]` — content filtering (documented below).
+         *
+         *     #### Content filtering (`filters.*`)
+         *
+         *     Filtering narrows list results to assets matching field values. The
+         *     allowed field names are project-specific — they come from the project's
+         *     asset definitions — which is why `filters.*` parameters are
+         *     pattern-validated rather than declared as named parameters.
+         *
+         *     Syntax: `filters.<field>[<operator>]=<value>`. `<field>` is one of:
+         *
+         *     * A system field such as `name`, `type`, `created`, `modified`,
+         *       `entityId`, `creator`, `creatorSubject`, `author`, `authorSubject`,
+         *       `categoryId`, `labels`, `labelGroups`, or `uiStatus`.
+         *     * An asset field, addressed as `fields.<fieldId>`. Unlike entries and
+         *       compositions, asset field filters do not require a single-type
+         *       filter — but if the same field ID has differing types across asset
+         *       types, HTTP 400 is returned and a single asset type must be
+         *       filtered.
+         *
+         *     | Operator | Effect |
+         *     |---|---|
+         *     | `[eq]` / `[neq]` | Exact equality / inequality. |
+         *     | `[match]` | Contains (text search) match; text-like fields only. |
+         *     | `[starts]` | Prefix match. Value limited to letters, numbers, `_`, `.`, `-`, and spaces. |
+         *     | `[lt]` / `[lte]` / `[gt]` / `[gte]` | Comparisons for number, date, and datetime fields (including `created` / `modified`). |
+         *     | `[in]` / `[nin]` | Comma-separated list; matches any (OR) / none of the values. |
+         *     | `[all]` | Comma-separated list; list-valued fields (e.g. `labels`, multi-selects) must contain every value (AND). |
+         *     | `[def]` | `true` or `false`; whether the field has a value at all. |
+         *
+         *     Behavior:
+         *
+         *     * Values are single strings, or comma-separated lists for `[in]`,
+         *       `[nin]`, and `[all]`. Dates accept `YYYY-MM-DD` or a full datetime
+         *       string. An empty value is rejected — use `[def]` to test presence.
+         *     * Not every operator is valid for every field; the allowed set depends
+         *       on the field's type. An unsupported combination returns HTTP 400
+         *       with the supported operators listed.
+         *     * Malformed keys, unknown operators, and unknown field names return
+         *       HTTP 400.
+         *
+         *     Examples:
+         *
+         *     * `filters.type[eq]=productImage` — only assets of type `productImage`.
+         *     * `filters.modified[gte]=2026-01-01` — modified this year.
+         *     * `filters.fields.altText[def]=false` — assets missing alt text.
+         */
         get: {
             parameters: {
                 query: {
@@ -1818,20 +1870,14 @@ 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) => ImageFromApi;
+declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => {
+    url: () => string;
+    transform: (transformProps: ImageFromTransformProps) => /*elided*/ any;
+};
 
 /**
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
@@ -1842,4 +1888,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 ImageFromApi, 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 ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.72.3-alpha.2+36e92d30ab",
+  "version": "20.72.3-alpha.3+3e396259ba",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -21,12 +21,11 @@
   "sideEffects": false,
   "scripts": {
     "build": "run-s update-openapi build:ts",
-    "build:ts": "tsup && pnpm test:types",
+    "build:ts": "tsup",
     "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"
   },
@@ -37,11 +36,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.72.3-alpha.2+36e92d30ab",
-    "@uniformdev/files": "20.72.3-alpha.2+36e92d30ab"
+    "@uniformdev/context": "20.72.3-alpha.3+3e396259ba",
+    "@uniformdev/files": "20.72.3-alpha.3+3e396259ba"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "36e92d30ab1b97fc68cf16fc22c6f7865ac8ba97"
+  "gitHead": "3e396259bafc25b69071cda4102cea340b866922"
 }