nestjs-paginate 14.0.0 → 15.0.0

package/README.md

@@ -41,11 +41,9 @@ updateGlobalConfig({
   defaultOrigin: undefined,
   defaultLimit: 20,
   defaultMaxLimit: 100,
-});
+})
 ```
 
-
-
 ### Example
 
 The following code exposes a route that can be utilized like so:
@@ -270,12 +268,12 @@ const paginateConfig: PaginateConfig<CatEntity> {
    * Description: TypeORM partial selection. Limit selection further by using `select` query param.
    * https://typeorm.io/select-query-builder#partial-selection
    * Note: if you do not contain the primary key in the select array, primary key will be added automatically.
-   * 
+   *
    * Wildcard support:
    * - Use '*' to select all columns from the main entity.
    * - Use 'relation.*' to select all columns from a relation.
    * - Use 'relation.subrelation.*' to select all columns from nested relations.
-   * 
+   *
    * Examples:
    * select: ['*'] - Selects all columns from main entity
    * select: ['id', 'name', 'toys.*'] - Selects id, name from main entity and all columns from toys relation
@@ -330,7 +328,7 @@ const paginateConfig: PaginateConfig<CatEntity> {
    * Type: RelationColumn<CatEntity>
    * Description: Indicates what relations of entity should be loaded.
    */
-  relations: [],
+  relations: {},
 
   /**
    * Required: false
@@ -495,7 +493,7 @@ http://localhost:3000/cats?filter.toys.name=$in:Mouse,String
 
 ```typescript
 const config: PaginateConfig<CatEntity> = {
-  relations: ['toys'],
+  relations: { toys: true },
   sortableColumns: ['id', 'name', 'toys.name'],
   filterableColumns: {
     'toys.name': [FilterOperator.IN],
@@ -511,7 +509,7 @@ const result = await paginate<CatEntity>(query, catRepo, config)
 const config: PaginateConfig<CatEntity> = {
   sortableColumns: ['id', 'name', 'toys.(size.height)', 'toys.(size.width)'],
   searchableColumns: ['name'],
-  relations: ['toys'],
+  relations: { toys: true },
 }
 ```
 
@@ -552,6 +550,7 @@ Quantifiers define how many related rows must satisfy the condition:
 - `$none`: no related rows match the condition
 
 ### Examples
+
 Assume `CatEntity` has a one‑to‑many relation `toys: CatToyEntity[]` where `CatToyEntity` has a string column `name`.
 
 - At least one toy named exactly "Ball":
@@ -584,46 +583,20 @@ Assume `CatEntity` has a one‑to‑many relation `toys: CatToyEntity[]` where `
   GET /cats?filter.toys.name=$any:$not:$eq:Squeaky
   ```
 
-### AND-mode: entity must have ALL of the specified related values
+### Requiring ALL of several related values
 
-Use the `$and` comparator to require that a parent entity has **all** of the specified related values.
-Each `$and` value produces a separate correlated EXISTS subquery, ANDed on the outer query.
+To require that a parent has **all** of several related values, use a [`filter=` expression](#filter-expressions-filter)
+with one term per value. Each relation term is an independent `EXISTS`, so ANDing them means
+"has a toy named Ball **and** has a toy named Mouse":
 
-Enable it in `filterableColumns`:
-
-```typescript
-filterableColumns: {
-  'toys.name': [FilterOperator.EQ, FilterComparator.AND],
-}
+```url
+GET /cats?filter=toys.name=$eq:Ball AND toys.name=$eq:Mouse
 ```
 
-- Cat must have **both** a toy named "Ball" **and** a toy named "Mouse":
-
-  ```url
-  GET /cats?filter.toys.name=$and:Ball&filter.toys.name=$and:Mouse
-  ```
-
-- Cat must have a toy named "Ball" **and** be friends with a cat named "Garfield" (two independent to-many paths):
-
-  ```url
-  GET /cats?filter.toys.name=$and:Ball&filter.friends.name=$and:Garfield
-  ```
-
-**Restrictions and performance notes**:
+This also composes across independent relation paths, e.g. has a Ball toy and is friends with Garfield:
 
-- `$and` may only be used on to-many relationship columns (one-to-many or many-to-many).
-- `$and` values may not be mixed with non-`$and` values on the same sub-column.
-- `$and` may not be combined with `$none` or `$all` quantifiers.
-- Each `$and` value adds one correlated EXISTS subquery. For N values and a relation path of depth D, this produces N × D joins. The default cap is 20 values per sub-column; override with `maxAndValues` in `PaginateConfig`.
-
-```typescript
-const config: PaginateConfig<CatEntity> = {
-  sortableColumns: ['id'],
-  filterableColumns: {
-    'toys.name': [FilterOperator.EQ, FilterComparator.AND],
-  },
-  maxAndValues: 10, // optional, default is 20
-}
+```url
+GET /cats?filter=toys.name=$eq:Ball AND friends.name=$eq:Garfield
 ```
 
 ## Usage with Eager Loading
@@ -678,7 +651,7 @@ or its nemesis's age when it has no best friend.
 const config: PaginateConfig<CatEntity> = {
   // Every column used in a group must be listed in sortableColumns.
   sortableColumns: ['id', 'bestFriend.age', 'nemesis.age'],
-  relations: ['bestFriend', 'nemesis'],
+  relations: { bestFriend: true, nemesis: true },
 }
 ```
 
@@ -739,27 +712,107 @@ const config: PaginateConfig<CatEntity> = {
 
 `?filter.roles=$contains:moderator,admin` where column `roles` is an array and contains the values `moderator` and `admin`
 
+### Filter expressions (`filter=`)
+
+The per-column `filter.<column>=` parameters above are always combined with `AND`. For
+arbitrary boolean logic, pass a single `filter=` expression instead. It uses the same
+column and `$op:value` syntax, combined with `AND`, `OR`, `NOT` (case-insensitive,
+precedence `NOT` > `AND` > `OR`) and parentheses:
+
+```
+?filter=color=$eq:black AND age=$gte:3
+?filter=(color=$eq:black OR color=$eq:white) AND NOT name=$eq:Leche
+?filter=home.name=$eq:House AND toys.name=$eq:String
+```
+
+- The columns and operators are validated against `filterableColumns`, exactly like the
+  per-column form. An unknown column or disallowed operator always returns `400 Bad Request`.
+- Relation columns are matched with correlated `EXISTS` subqueries, so they compose under
+  `OR`/`NOT` and never join the relation into the result set. `NOT toys.name=$eq:Ball` means
+  "no matching toy exists".
+- Root, embedded, [JSONB key-path](#jsonb-support), and [polymorphic (`~`)](#polymorphic-columns-)
+  columns are all valid leaves and apply as direct conditions. Every operator, suffix and
+  quantifier from the per-column form works unchanged (e.g. `age=$btw:3,5`, `age=$not:$null`,
+  `toys.name=$none:$eq:Ball`); JSONB filtering keeps its PostgreSQL/CockroachDB-only limitation.
+- A value containing whitespace or parentheses must be quoted with `"` or `'`:
+  `?filter=home.name=$eq:"Cat Mansion"`.
+
+Inside a quoted value, a backslash escapes a following quote or backslash (`\"`, `\'`, `\\`),
+so a value can contain either quote character:
+
+```
+?filter=name=$eq:"Milo \"the cat\""   # value: Milo "the cat"
+?filter=name=$eq:'it\'s mine'         # value: it's mine
+?filter=name=$eq:"a\"b\'c\\d"         # value: a"b'c\d
+```
+
+Any other backslash is kept literal, so Windows paths and regexes need no doubling
+(`?filter=path=$eq:"C:\Users"` → `C:\Users`). You can also switch quote styles instead of
+escaping — `?filter=name=$eq:'O'"'"'Malley'`-style concatenation still works — but the
+backslash form is usually clearer. Doubling a quote does **not** escape it
+(`"say ""hi"""` yields `say hi`). Remember to URL-encode the `filter=` value; the examples
+above are shown decoded for readability.
+
+The value-level `$not` suffix (negating a single comparison, e.g. `color=$not:$eq:white`) is
+distinct from the boolean `NOT` (negating a whole term or group).
+
+Because the expression is parsed recursively, an unbounded expression is a denial-of-service
+vector: a deeply nested or very wide payload can exhaust the call stack or blow up the
+generated SQL. Every leaf, `AND`/`OR`/`NOT` operator, and parenthesised group counts as one
+node, and the total is capped at **100** by default. Override the cap per endpoint with
+`filterExpressionMaxComplexity` in the config, or globally via `updateGlobalConfig({ defaultFilterExpressionMaxComplexity })`.
+An expression over the limit returns `400 Bad Request`.
+
+```typescript
+const config: PaginateConfig<CatEntity> = {
+  sortableColumns: ['id'],
+  filterableColumns: { color: true, name: true },
+  filterExpressionMaxComplexity: 50, // reject filter= expressions with more than 50 nodes
+}
+```
+
+### Polymorphic columns (`~`)
+
+A filter column may group several columns with `~` to filter on their `COALESCE` — the first
+non-null value per row (the same `~` syntax as polymorphic sorting). This works in both the
+`filter=` expression and the per-column form:
+
+```url
+?filter=bestFriend.age~nemesis.age=$eq:4
+?filter.bestFriend.age~nemesis.age=$gte:5
+```
+
+Each part must be a plain or **to-one** relation column (not embedded, virtual, JSONB, or to-many).
+Relation parts are left-joined automatically and are not added to the result set. Parts may be
+**nested** (`a.b.c.leaf`) as long as every segment before the leaf is a to-one relation; each hop is
+joined step by step, and a prefix shared across parts (e.g. two parts both starting `a.b`) reuses the
+same join rather than colliding:
+
+```url
+?filter=bestFriend.home.street~home.street=$eq:Downtown
+```
+
 ## JSONB Support
 
 You can sort, search, and filter on JSONB columns using dot notation to access nested fields.
 
 ### Database support matrix
 
-| Feature | PostgreSQL / CockroachDB | MySQL / MariaDB | SQLite |
-|---------|---|---|---|
-| **Sorting** (`sortableColumns`) | Yes (`#>>`) | Yes (`JSON_UNQUOTE(JSON_EXTRACT(...))`) | Yes (`json_extract`) |
-| **Searching** (`searchableColumns`) | Yes | Yes | Yes |
-| **Filtering** (`$eq`, `$in`, `$contains`) | Yes (`@>` containment) | No | No |
+| Feature                                   | PostgreSQL / CockroachDB | MySQL / MariaDB                         | SQLite               |
+| ----------------------------------------- | ------------------------ | --------------------------------------- | -------------------- |
+| **Sorting** (`sortableColumns`)           | Yes (`#>>`)              | Yes (`JSON_UNQUOTE(JSON_EXTRACT(...))`) | Yes (`json_extract`) |
+| **Searching** (`searchableColumns`)       | Yes                      | Yes                                     | Yes                  |
+| **Filtering** (`$eq`, `$in`, `$contains`) | Yes (`@>` containment)   | No                                      | No                   |
 
 > **Note:** Sorting and searching on JSONB paths is supported across all database engines — the library automatically uses the correct JSON extraction function for your DB. Filtering via `$eq`, `$in`, and `$contains` uses PostgreSQL's `@>` containment operator (via TypeORM's `JsonContains`) and is only supported on **PostgreSQL** and **CockroachDB**.
 
 ### Filtering operators (PostgreSQL / CockroachDB only)
 
-| Operator | Description |
-|----------|-------------|
+| Operator    | Description                                              |
+| ----------- | -------------------------------------------------------- |
 | `$eq`       | Exact match via containment (`col @> '{"key":"value"}'`) |
-| `$in`       | Match any of a comma-separated list of values |
-| `$contains` | Match if a JSON array contains the value |
+| `$in`       | Match any of a comma-separated list of values            |
+| `$contains` | Match if a JSON array contains the value                 |
 
 ### Direct JSONB column
 
@@ -781,7 +834,7 @@ where `settings` is a relation whose JSONB column `theme` is filtered.
 
 ```typescript
 const config: PaginateConfig<UserEntity> = {
-  relations: ['settings'],
+  relations: { settings: true },
   filterableColumns: {
     'settings.theme': [FilterOperator.EQ, FilterOperator.IN],
   },
@@ -817,29 +870,16 @@ Each value is expanded into its own `@>` condition joined with `OR`:
 ?filter.metadata.status=$not:$in:banned,suspended
 ```
 
-## Multi Filters
-
-Multi filters are filters that can be applied to a single column with a comparator.
-
-### Examples
-
-`?filter.createdAt=$gt:2022-02-02&filter.createdAt=$lt:2022-02-10` where column `createdAt` is after `2022-02-02` **and** before `2022-02-10`
+## Combining filters on one column
 
-`?filter.roles=$contains:moderator&filter.roles=$or:$contains:admin` where column `roles` is an array and contains `moderator` **or** `admin`
+Repeating a `filter.<column>=` parameter applies all of its conditions with **AND**, e.g. a range:
 
-`?filter.id=$gt:3&filter.id=$and:$lt:5&filter.id=$or:$eq:7` where column `id` is greater than `3` **and** less than `5` **or** equal to `7`
+`?filter.createdAt=$gt:2022-02-02&filter.createdAt=$lt:2022-02-10` — `createdAt` after `2022-02-02` **and** before `2022-02-10`
 
-**Note:** The `$and` comparators are not required. The above example is equivalent to:
+For **OR** (within a column or across columns) and arbitrary boolean logic, use a
+[`filter=` expression](#filter-expressions-filter):
 
-`?filter.id=$gt:3&filter.id=$lt:5&filter.id=$or:$eq:7`
-
-**Note:** The first comparator on the the first filter is ignored because the filters are grouped by the column name and chained with an `$and` to other filters.
-
-`...&filter.id=5&filter.id=$or:7&filter.name=Milo&...`
-
-is resolved to:
-
-`WHERE ... AND (id = 5 OR id = 7) AND name = 'Milo' AND ...`
+`?filter=id=$eq:5 OR id=$eq:7` — `id` equal to `5` **or** `7`
 
 ## Cursor-based Pagination
 
@@ -928,7 +968,6 @@ export function CustomSortBy(paginationConfig: PaginateConfig<any>) {
 Now you can create your version of the whole docs decorator and use it
 
 ```typescript
-
 const CustomApiPaginationQuery = (paginationConfig: PaginateConfig<any>) => {
   return applyDecorators(
     ...[
@@ -946,13 +985,10 @@ const CustomApiPaginationQuery = (paginationConfig: PaginateConfig<any>) => {
 function CustomPaginatedSwaggerDocs<DTO extends Type<unknown>>(dto: DTO, paginatedConfig: PaginateConfig<any>) {
   return applyDecorators(ApiOkPaginatedResponse(dto, paginatedConfig), CustomApiPaginationQuery(paginatedConfig))
 }
-
 ```
 
 You can use CustomPaginatedSwaggerDocs instead of default PaginatedSwaggerDocs
 
-
-
 ## Troubleshooting
 
 The package does not report error reasons in the response bodies. They are instead

package/lib/decorator.d.ts

@@ -7,6 +7,8 @@ export interface PaginateQuery {
     filter?: {
         [column: string]: string | string[];
     };
+    /** Boolean filter expression from a single `filter=` query parameter. */
+    filterExpression?: string;
     select?: string[];
     cursor?: string;
     withDeleted?: boolean;

package/lib/decorator.js

@@ -83,6 +83,7 @@ exports.Paginate = (0, common_1.createParamDecorator)((_data, ctx) => {
         search: query.search ? query.search.toString() : undefined,
         searchBy,
         filter: Object.keys(filter).length ? filter : undefined,
+        filterExpression: (0, lodash_1.isString)(query.filter) ? query.filter : undefined,
         select,
         cursor: query.cursor ? query.cursor.toString() : undefined,
         withDeleted: query.withDeleted === 'true' ? true : query.withDeleted === 'false' ? false : undefined,

package/lib/decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAGvE,mCAA8D;AAC9D,qCAAgC;AAEhC,SAAS,QAAQ,CAAC,IAAa;IAC3B,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAA;AACjE,CAAC;AAeD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAElE,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,KAAyB,CAAC,CAAA;IACvC,CAAC;AACL,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACzC,CAAC,CAAA;AAED,SAAS,UAAU,CAAI,UAAmB,EAAE,WAAgD;IACxF,MAAM,GAAG,GAAG,EAAE,CAAA;IACd,IAAI,UAAU,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;QACrE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;gBAClB,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC3B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;AACvC,CAAC;AAED,SAAS,aAAa,CAAC,CAAU;IAC7B,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;IAEhD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IACpB,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAEY,QAAA,QAAQ,GAAG,IAAA,6BAAoB,EAAC,CAAC,KAAc,EAAE,GAAqB,EAAiB,EAAE;;IAClG,IAAI,IAAY,CAAA;IAChB,IAAI,KAA8B,CAAA;IAElC,QAAQ,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QACpB,KAAK,MAAM;YACP,MAAM,OAAO,GAAoC,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAA;YAChF,KAAK,GAAG,OAAO,CAAC,KAAgC,CAAA;YAEhD,6GAA6G;YAC7G,IAAI,WAAmB,CAAA;YACvB,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAA;YACtF,CAAC;iBAAM,CAAC;gBACJ,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAA;YAC3E,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;YACrC,IAAI,GAAG,QAAQ,CAAC,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAA;YACnE,MAAK;QACT,KAAK,IAAI;YACL,KAAK,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,CAAA;YAClC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;QACT,KAAK,KAAK;YACN,KAAK,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,CAAA;YACnC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;IACb,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAS,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAChE,MAAM,MAAM,GAAG,MAAA,UAAU,CAAmB,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,0CAAE,GAAG,CACzE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAgC,CACjH,CAAA;IACD,MAAM,MAAM,GAAG,UAAU,CAAS,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAEtE,MAAM,MAAM,GAAG,IAAA,gBAAO,EAClB,IAAA,eAAM,EACF,KAAK,EACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,CAAC,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAK,KAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAC/D,EAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAChD,CAAA;IAED,OAAO;QACH,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;QACjC,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,QAAQ;QACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACvD,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,WAAW,EAAE,KAAK,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QACpG,IAAI;KACP,CAAA;AACL,CAAC,CAAC,CAAA"}
+{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAGvE,mCAA8D;AAC9D,qCAAgC;AAEhC,SAAS,QAAQ,CAAC,IAAa;IAC3B,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAA;AACjE,CAAC;AAiBD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAElE,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,KAAyB,CAAC,CAAA;IACvC,CAAC;AACL,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACzC,CAAC,CAAA;AAED,SAAS,UAAU,CAAI,UAAmB,EAAE,WAAgD;IACxF,MAAM,GAAG,GAAG,EAAE,CAAA;IACd,IAAI,UAAU,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;QACrE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;gBAClB,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC3B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;AACvC,CAAC;AAED,SAAS,aAAa,CAAC,CAAU;IAC7B,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;IAEhD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IACpB,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAEY,QAAA,QAAQ,GAAG,IAAA,6BAAoB,EAAC,CAAC,KAAc,EAAE,GAAqB,EAAiB,EAAE;;IAClG,IAAI,IAAY,CAAA;IAChB,IAAI,KAA8B,CAAA;IAElC,QAAQ,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QACpB,KAAK,MAAM;YACP,MAAM,OAAO,GAAoC,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAA;YAChF,KAAK,GAAG,OAAO,CAAC,KAAgC,CAAA;YAEhD,6GAA6G;YAC7G,IAAI,WAAmB,CAAA;YACvB,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAA;YACtF,CAAC;iBAAM,CAAC;gBACJ,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAA;YAC3E,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;YACrC,IAAI,GAAG,QAAQ,CAAC,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAA;YACnE,MAAK;QACT,KAAK,IAAI;YACL,KAAK,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,CAAA;YAClC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;QACT,KAAK,KAAK;YACN,KAAK,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,CAAA;YACnC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;IACb,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAS,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAChE,MAAM,MAAM,GAAG,MAAA,UAAU,CAAmB,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,0CAAE,GAAG,CACzE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAgC,CACjH,CAAA;IACD,MAAM,MAAM,GAAG,UAAU,CAAS,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAEtE,MAAM,MAAM,GAAG,IAAA,gBAAO,EAClB,IAAA,eAAM,EACF,KAAK,EACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,CAAC,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAK,KAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAC/D,EAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAChD,CAAA;IAED,OAAO;QACH,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;QACjC,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,QAAQ;QACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACvD,gBAAgB,EAAE,IAAA,iBAAQ,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACnE,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,WAAW,EAAE,KAAK,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QACpG,IAAI;KACP,CAAA;AACL,CAAC,CAAC,CAAA"}

package/lib/decorator.spec.js

@@ -106,6 +106,7 @@ describe('Decorator', () => {
             sortBy: undefined,
             search: undefined,
             searchBy: undefined,
+            filterExpression: undefined,
             filter: undefined,
             select: undefined,
             cursor: undefined,
@@ -122,6 +123,7 @@ describe('Decorator', () => {
             sortBy: undefined,
             search: undefined,
             searchBy: undefined,
+            filterExpression: undefined,
             filter: undefined,
             select: undefined,
             cursor: undefined,
@@ -129,6 +131,12 @@ describe('Decorator', () => {
             path: 'http://localhost/items',
         });
     });
+    it('should parse a bare filter= param into filterExpression', () => {
+        const context = expressContextFactory({ filter: 'color=$eq:black AND age=$gte:3' });
+        const result = decoratorfactory(null, context);
+        expect(result.filterExpression).toBe('color=$eq:black AND age=$gte:3');
+        expect(result.filter).toBeUndefined();
+    });
     it('should handle express defined query fields', () => {
         const context = expressContextFactory({
             page: '1',
@@ -151,6 +159,7 @@ describe('Decorator', () => {
             ],
             search: 'white',
             searchBy: undefined,
+            filterExpression: undefined,
             withDeleted: true,
             select: ['name', 'createdAt'],
             path: 'http://localhost/items',
@@ -193,6 +202,7 @@ describe('Decorator', () => {
             ],
             search: 'white',
             searchBy: undefined,
+            filterExpression: undefined,
             withDeleted: false,
             path: 'http://localhost/items',
             filter: {
@@ -221,6 +231,7 @@ describe('Decorator', () => {
             sortBy: [['NOTEXISTEN', 'BLABLA']],
             search: 'white',
             searchBy: undefined,
+            filterExpression: undefined,
             withDeleted: undefined,
             path: 'http://localhost/items',
             filter: {

package/lib/decorator.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.spec.js","sourceRoot":"","sources":["../src/decorator.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAA8D;AAW9D,2CAAqD;AAErD,wDAAwD;AACxD,SAAS,wBAAwB,CAAI,SAAmB;IACpD,MAAM,IAAI;QACC,IAAI,CAAc,MAAS;YAC9B,EAAE;QACN,CAAC;KACJ;IAHU;QAAM,WAAA,SAAS,EAAE,CAAA;;;;oCAEvB;IAEL,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,+BAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACnE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7C,CAAC;AACD,MAAM,gBAAgB,GAAG,wBAAwB,CAAgB,oBAAQ,CAAC,CAAA;AAE1E,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW;gBACtB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,WAAW;gBACrB,GAAG,EAAE,oBAAoB;gBACzB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,MAAM;YACnB,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,MAAM,EAAE,CAAC,gCAAgC,EAAE,WAAW,CAAC;SAC1D,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAChC,CAAC,CAAC,gBAAgB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC;YAC1C,CAAC,MAAM,EAAE,MAAM,CAAC;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,OAAO;YACpB,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE,KAAK;YAClB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,CAAC,mBAAmB,CAAC;YAC7B,MAAM,EAAE,OAAO;YACf,gBAAgB,EAAE,mBAAmB;YACrC,sBAAsB,EAAE,WAAW;YACnC,MAAM,EAAE,CAAC,YAAY,CAAC;YACtB,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAClC,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,OAAO,EAAE,mBAAmB;gBAC5B,aAAa,EAAE,WAAW;aAC7B;YACD,MAAM,EAAE,CAAC,YAAY,CAAC;YACtB,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}
+{"version":3,"file":"decorator.spec.js","sourceRoot":"","sources":["../src/decorator.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAA8D;AAW9D,2CAAqD;AAErD,wDAAwD;AACxD,SAAS,wBAAwB,CAAI,SAAmB;IACpD,MAAM,IAAI;QACC,IAAI,CAAc,MAAS;YAC9B,EAAE;QACN,CAAC;KACJ;IAHU;QAAM,WAAA,SAAS,EAAE,CAAA;;;;oCAEvB;IAEL,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,+BAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACnE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7C,CAAC;AACD,MAAM,gBAAgB,GAAG,wBAAwB,CAAgB,oBAAQ,CAAC,CAAA;AAE1E,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW;gBACtB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,WAAW;gBACrB,GAAG,EAAE,oBAAoB;gBACzB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;YAC3B,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;YAC3B,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QAC/D,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,MAAM,EAAE,gCAAgC,EAAE,CAAC,CAAA;QACnF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC7D,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;QACtE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAA;IACzC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,MAAM;YACnB,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;YAC3B,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,MAAM,EAAE,CAAC,gCAAgC,EAAE,WAAW,CAAC;SAC1D,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAChC,CAAC,CAAC,gBAAgB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC;YAC1C,CAAC,MAAM,EAAE,MAAM,CAAC;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,OAAO;YACpB,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;YAC3B,WAAW,EAAE,KAAK;YAClB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,CAAC,mBAAmB,CAAC;YAC7B,MAAM,EAAE,OAAO;YACf,gBAAgB,EAAE,mBAAmB;YACrC,sBAAsB,EAAE,WAAW;YACnC,MAAM,EAAE,CAAC,YAAY,CAAC;YACtB,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAClC,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;YAC3B,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,OAAO,EAAE,mBAAmB;gBAC5B,aAAa,EAAE,WAAW;aAC7B;YACD,MAAM,EAAE,CAAC,YAAY,CAAC;YACtB,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}

package/lib/filter-expression.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Boolean filter expression parsed from a single `filter=` query parameter.
+ *
+ * Grammar (precedence: NOT > AND > OR), case-insensitive keywords:
+ *   expr    := or
+ *   or      := and (OR and)*
+ *   and     := not (AND not)*
+ *   not     := NOT not | primary
+ *   primary := '(' expr ')' | leaf
+ *   leaf    := column '=' value          // value uses the existing $op:operand syntax
+ *
+ * Tokens are whitespace-delimited; `(` and `)` are punctuation. A value containing
+ * whitespace or a `(` `)` must be quoted with `"` or `'`. Inside a quoted value a backslash
+ * escapes a following quote or backslash (`\"`, `\'`, `\\`); any other backslash is literal.
+ */
+export type FilterExpression = {
+    type: 'and';
+    children: FilterExpression[];
+} | {
+    type: 'or';
+    children: FilterExpression[];
+} | {
+    type: 'not';
+    child: FilterExpression;
+} | {
+    type: 'leaf';
+    column: string;
+    value: string;
+};
+/**
+ * Default cap on the number of nodes (leaves, AND/OR/NOT operators, and parenthesised
+ * groups) a single `filter=` expression may contain. Because the parser is recursive, an
+ * unbounded expression is a denial-of-service vector: a deeply nested or very wide payload
+ * can exhaust the call stack or blow up the generated SQL. 100 nodes comfortably covers any
+ * realistic query while keeping the parse cheap. Override per-endpoint via
+ * `PaginateConfig.filterExpressionMaxComplexity`.
+ */
+export declare const DEFAULT_FILTER_EXPRESSION_MAX_COMPLEXITY = 100;
+/** Filter expression with negation pushed onto the leaves, so only AND/OR groups remain. */
+export type NormalizedFilterExpression = {
+    type: 'and';
+    children: NormalizedFilterExpression[];
+} | {
+    type: 'or';
+    children: NormalizedFilterExpression[];
+} | {
+    type: 'leaf';
+    column: string;
+    value: string;
+    negated: boolean;
+};
+export declare function parseFilterExpression(input: string, maxComplexity?: number): FilterExpression;
+/** Pushes every NOT down onto the leaves via De Morgan, leaving only AND/OR groups. */
+export declare function normalizeFilterExpression(node: FilterExpression, negated?: boolean): NormalizedFilterExpression;

package/lib/filter-expression.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_FILTER_EXPRESSION_MAX_COMPLEXITY = void 0;
+exports.parseFilterExpression = parseFilterExpression;
+exports.normalizeFilterExpression = normalizeFilterExpression;
+const common_1 = require("@nestjs/common");
+/**
+ * Default cap on the number of nodes (leaves, AND/OR/NOT operators, and parenthesised
+ * groups) a single `filter=` expression may contain. Because the parser is recursive, an
+ * unbounded expression is a denial-of-service vector: a deeply nested or very wide payload
+ * can exhaust the call stack or blow up the generated SQL. 100 nodes comfortably covers any
+ * realistic query while keeping the parse cheap. Override per-endpoint via
+ * `PaginateConfig.filterExpressionMaxComplexity`.
+ */
+exports.DEFAULT_FILTER_EXPRESSION_MAX_COMPLEXITY = 100;
+const WHITESPACE = new Set([' ', '\t', '\n', '\r']);
+function tokenize(input) {
+    const tokens = [];
+    let i = 0;
+    while (i < input.length) {
+        const c = input[i];
+        if (WHITESPACE.has(c)) {
+            i++;
+            continue;
+        }
+        if (c === '(') {
+            tokens.push({ type: 'lparen' });
+            i++;
+            continue;
+        }
+        if (c === ')') {
+            tokens.push({ type: 'rparen' });
+            i++;
+            continue;
+        }
+        let raw = '';
+        let quoted = false;
+        while (i < input.length) {
+            const ch = input[i];
+            if (WHITESPACE.has(ch) || ch === '(' || ch === ')')
+                break;
+            if (ch === '"' || ch === "'") {
+                quoted = true;
+                i++;
+                while (i < input.length && input[i] !== ch) {
+                    // Inside a quoted span a backslash escapes a following quote or backslash,
+                    // so either quote character (and a literal backslash) can appear without
+                    // switching quote styles. Any other backslash is kept literal, leaving
+                    // values such as Windows paths or regexes untouched.
+                    if (input[i] === '\\' && i + 1 < input.length) {
+                        const next = input[i + 1];
+                        if (next === '"' || next === "'" || next === '\\') {
+                            raw += next;
+                            i += 2;
+                            continue;
+                        }
+                    }
+                    raw += input[i];
+                    i++;
+                }
+                if (i >= input.length) {
+                    throw new common_1.BadRequestException('Unterminated quote in filter expression');
+                }
+                i++;
+                continue;
+            }
+            raw += ch;
+            i++;
+        }
+        if (!quoted) {
+            const keyword = raw.toUpperCase();
+            if (keyword === 'AND' || keyword === 'OR' || keyword === 'NOT') {
+                tokens.push({ type: keyword.toLowerCase() });
+                continue;
+            }
+        }
+        tokens.push({ type: 'leaf', raw });
+    }
+    return tokens;
+}
+function parse(tokens, maxComplexity) {
+    let pos = 0;
+    const peek = () => tokens[pos];
+    // Every leaf, AND/OR/NOT operator, and parenthesised descent counts as one unit of
+    // complexity. Tallied as the tree is built and checked eagerly, so a hostile payload is
+    // rejected before it can nest deep enough to overflow the recursion stack.
+    let complexity = 0;
+    const spend = () => {
+        if (++complexity > maxComplexity) {
+            throw new common_1.BadRequestException(`Filter expression is too complex (max ${maxComplexity} nodes)`);
+        }
+    };
+    function parseOr() {
+        var _a;
+        const children = [parseAnd()];
+        while (((_a = peek()) === null || _a === void 0 ? void 0 : _a.type) === 'or') {
+            pos++;
+            spend();
+            children.push(parseAnd());
+        }
+        return children.length === 1 ? children[0] : { type: 'or', children };
+    }
+    function parseAnd() {
+        var _a;
+        const children = [parseNot()];
+        while (((_a = peek()) === null || _a === void 0 ? void 0 : _a.type) === 'and') {
+            pos++;
+            spend();
+            children.push(parseNot());
+        }
+        return children.length === 1 ? children[0] : { type: 'and', children };
+    }
+    function parseNot() {
+        var _a;
+        if (((_a = peek()) === null || _a === void 0 ? void 0 : _a.type) === 'not') {
+            pos++;
+            spend();
+            return { type: 'not', child: parseNot() };
+        }
+        return parsePrimary();
+    }
+    function parsePrimary() {
+        var _a;
+        const token = peek();
+        if (!token) {
+            throw new common_1.BadRequestException('Unexpected end of filter expression');
+        }
+        if (token.type === 'lparen') {
+            pos++;
+            spend();
+            const expr = parseOr();
+            if (((_a = peek()) === null || _a === void 0 ? void 0 : _a.type) !== 'rparen') {
+                throw new common_1.BadRequestException('Expected ")" in filter expression');
+            }
+            pos++;
+            return expr;
+        }
+        if (token.type === 'leaf') {
+            pos++;
+            spend();
+            const eq = token.raw.indexOf('=');
+            if (eq < 1) {
+                throw new common_1.BadRequestException(`Invalid filter expression term "${token.raw}", expected "column=value"`);
+            }
+            return { type: 'leaf', column: token.raw.slice(0, eq), value: token.raw.slice(eq + 1) };
+        }
+        throw new common_1.BadRequestException(`Unexpected "${token.type}" in filter expression`);
+    }
+    if (tokens.length === 0) {
+        throw new common_1.BadRequestException('Empty filter expression');
+    }
+    const expr = parseOr();
+    if (pos < tokens.length) {
+        throw new common_1.BadRequestException('Unexpected trailing tokens in filter expression');
+    }
+    return expr;
+}
+function parseFilterExpression(input, maxComplexity = exports.DEFAULT_FILTER_EXPRESSION_MAX_COMPLEXITY) {
+    return parse(tokenize(input), maxComplexity);
+}
+/** Pushes every NOT down onto the leaves via De Morgan, leaving only AND/OR groups. */
+function normalizeFilterExpression(node, negated = false) {
+    switch (node.type) {
+        case 'leaf':
+            return { type: 'leaf', column: node.column, value: node.value, negated };
+        case 'not':
+            return normalizeFilterExpression(node.child, !negated);
+        case 'and':
+            return {
+                type: negated ? 'or' : 'and',
+                children: node.children.map((child) => normalizeFilterExpression(child, negated)),
+            };
+        case 'or':
+            return {
+                type: negated ? 'and' : 'or',
+                children: node.children.map((child) => normalizeFilterExpression(child, negated)),
+            };
+    }
+}
+//# sourceMappingURL=filter-expression.js.map