@uniformdev/assets 20.72.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: {

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: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/assets",
-  "version": "20.72.2",
+  "version": "20.72.3-alpha.3+3e396259ba",
   "description": "Uniform Assets",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -36,11 +36,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/context": "20.72.2",
-    "@uniformdev/files": "20.72.2"
+    "@uniformdev/context": "20.72.3-alpha.3+3e396259ba",
+    "@uniformdev/files": "20.72.3-alpha.3+3e396259ba"
   },
   "devDependencies": {
     "ts-xor": "^1.3.0"
   },
-  "gitHead": "8b65535fb3ec81e23f9eb8e0ed0b0be478f6e0e8"
+  "gitHead": "3e396259bafc25b69071cda4102cea340b866922"
 }