@adonis-agora/filter 0.7.1 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # @adonis-agora/filter
 
+## 0.8.0
+
+### Minor Changes
+
+- [#29](https://github.com/DavideCarvalho/adonis-agora-filter/pull/29) [`2fd4700`](https://github.com/DavideCarvalho/adonis-agora-filter/commit/2fd47000b87b025edf4c117ef97b1d9b731731a0) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - Filter classes — the `adonis-lucid-filter` authoring shape, with the whole pipeline behind it.
+
+  A filter can now be a class:
+
+  ```ts
+  @inject()
+  export default class UserFilter extends BaseModelFilter {
+    declare $query: ModelQueryBuilderContract<typeof User>;
+    constructor(private tenants: TenantsService) {
+      super();
+    }
+
+    static model = User;
+    static filterable = ["name", "email", "status"];
+    static sortable = ["name", "createdAt"];
+    static searchable = ["name", "email"];
+
+    setup() {
+      this.$query.where("tenantId", this.tenants.current(this.$ctx));
+    }
+
+    fullName(value: string) {
+      this.$query.whereRaw("first_name || ' ' || last_name ilike ?", [
+        `%${value}%`,
+      ]);
+    }
+  }
+  ```
+
+  - **`BaseModelFilter`** — a method per request key, the builder on `this.$query`, a `setup()` that
+    runs before anything the request asked for. Writing the method is what exposes the key, so it
+    needs no allow-list entry; plain columns stay declarative in the statics.
+  - **Container-resolved** — the class is constructed through the request's IoC resolver, so
+    `@inject()` on the constructor works exactly as it does in a controller.
+  - **`Filterable` model mixin** — `static $filter = () => UserFilter`, then
+    `User.filterPaginate(ctx)` for the whole endpoint, or `const { query } = await User.filter(ctx)`
+    to keep composing and `query.filterPaginate()` to page it with what the request asked for.
+  - **The macros take a class** too, and `filterPaginate()` with no arguments pages a query a
+    previous call already filtered.
+  - **`node ace make:filter user`** scaffolds the class.
+  - Key matching follows the same conventions as `adonis-lucid-filter`: `static blacklist`,
+    `static dropId`, `static camelCase`, and a bare top-level key (`?minAge=21`) reaching a method of
+    that name. Keys the wire format owns (`sort`, `page`, `search`, …) are never dispatched.
+
+  Everything compiles to the same `FilterSpec` the declarative `defineFilter` produces, so classes
+  and specs share one runner — same allow-listing, operators, search, sort and page clamping.
+
+  Note for the class form: `applyFilterFromRequest(query, UserFilter, ctx)` and `User.filter(ctx)`
+  resolve to `{ page, size }` and `{ query, page, size }` respectively, never to the builder as the
+  promise's own value — a Lucid query builder is thenable, so a promise resolving to one would run
+  the query instead of handing it back.
+
+- [#30](https://github.com/DavideCarvalho/adonis-agora-filter/pull/30) [`9796b85`](https://github.com/DavideCarvalho/adonis-agora-filter/commit/9796b851b078d6d1aa977bbe5a396058d8059d55) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - Decorators for the class form, and a `FilterClass` type fix.
+
+  `@filterFor('team.name')` binds a filter method to the request key(s) it answers, for keys a method
+  name could never spell and for one method answering several keys; a bound method stops answering to
+  its own name, so the public key survives a rename. A key the wire format owns (`sort`, `page`, …)
+  is refused when the class is defined.
+
+  `@filterable()`, `@sortable()` and `@searchable()` declare a model's filterable surface on the
+  columns themselves, stacked under Lucid's `@column()`; a filter picks them up through its
+  `static model`, and a static on the filter still replaces the list outright so a stricter filter can
+  narrow a shared model. `@filterable('number')` also declares the field's kind.
+
+  Both work under legacy (`experimentalDecorators`, what AdonisJS compiles) and standard TC39
+  decorators — the flavour is detected at call time.
+
+  Fixes `FilterClass`, which intersected `Record<string, unknown>`: no concrete
+  `class UserFilter extends BaseModelFilter` satisfied that, so `static $filter = () => UserFilter`
+  on a model did not typecheck. A type test over a real Lucid model now covers it.
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/commands/main.d.ts

@@ -1,17 +1,19 @@
 import { ListLoader } from '@adonisjs/core/ace';
+import MakeFilter from './make_filter.js';
 import MakeFilterClient from './make_filter_client.js';
 /**
  * The commands barrel for `@adonis-agora/filter`. An app registers it in its
  * `adonisrc` via `rcFile.addCommand('@adonis-agora/filter/commands')`. A
  * {@link ListLoader} exposes the `make:filter-client` command's metadata and
- * constructor to the ace kernel.
+ * constructors to the ace kernel: `make:filter` (scaffold a filter class) and
+ * `make:filter-client` (emit the typed front-end builders).
  *
  * `@adonisjs/core` is an *optional* peer of this otherwise framework-free core —
  * only this `./commands` subpath imports it, so the main entrypoint stays
  * dependency-free.
  */
-declare const loader: ListLoader<typeof MakeFilterClient>;
+declare const loader: ListLoader<typeof MakeFilter | typeof MakeFilterClient>;
 export declare const getMetaData: () => Promise<import("@adonisjs/core/types/ace").CommandMetaData[]>;
-export declare const getCommand: (metaData: import("@adonisjs/core/types/ace").CommandMetaData) => Promise<typeof MakeFilterClient | null>;
+export declare const getCommand: (metaData: import("@adonisjs/core/types/ace").CommandMetaData) => Promise<typeof MakeFilter | typeof MakeFilterClient | null>;
 export default loader;
 //# sourceMappingURL=main.d.ts.map

package/dist/commands/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../commands/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;GASG;AACH,QAAA,MAAM,MAAM,qCAAqC,CAAC;AAElD,eAAO,MAAM,WAAW,qEAAkC,CAAC;AAC3D,eAAO,MAAM,UAAU,2GAAiC,CAAC;AAEzD,eAAe,MAAM,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../commands/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,QAAA,MAAM,MAAM,yDAAiD,CAAC;AAE9D,eAAO,MAAM,WAAW,qEAAkC,CAAC;AAC3D,eAAO,MAAM,UAAU,+HAAiC,CAAC;AAEzD,eAAe,MAAM,CAAC"}

package/dist/commands/main.js

@@ -1,16 +1,18 @@
 import { ListLoader } from '@adonisjs/core/ace';
+import MakeFilter from './make_filter.js';
 import MakeFilterClient from './make_filter_client.js';
 /**
  * The commands barrel for `@adonis-agora/filter`. An app registers it in its
  * `adonisrc` via `rcFile.addCommand('@adonis-agora/filter/commands')`. A
  * {@link ListLoader} exposes the `make:filter-client` command's metadata and
- * constructor to the ace kernel.
+ * constructors to the ace kernel: `make:filter` (scaffold a filter class) and
+ * `make:filter-client` (emit the typed front-end builders).
  *
  * `@adonisjs/core` is an *optional* peer of this otherwise framework-free core —
  * only this `./commands` subpath imports it, so the main entrypoint stays
  * dependency-free.
  */
-const loader = new ListLoader([MakeFilterClient]);
+const loader = new ListLoader([MakeFilter, MakeFilterClient]);
 export const getMetaData = loader.getMetaData.bind(loader);
 export const getCommand = loader.getCommand.bind(loader);
 export default loader;

package/dist/commands/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../commands/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAElD,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAEzD,eAAe,MAAM,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../commands/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAEzD,eAAe,MAAM,CAAC"}

package/dist/commands/make_filter.d.ts

@@ -0,0 +1,18 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+/**
+ * `node ace make:filter <name>` — scaffold a filter class under `app/filters/`.
+ *
+ * The generated class extends `BaseModelFilter`: allow-lists as statics for the plain columns, a
+ * `setup()` for the scope the client cannot relax, and a method per key that needs SQL of its own.
+ * It is `@inject()`ed, so a constructor dependency resolves through the container exactly as a
+ * controller's does.
+ */
+export default class MakeFilter extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    name: string;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=make_filter.d.ts.map

package/dist/commands/make_filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"make_filter.d.ts","sourceRoot":"","sources":["../../commands/make_filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAQ,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG/D;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,OAAgB,WAAW,SAAiB;IAC5C,OAAgB,WAAW,SAA+B;IAC1D,OAAgB,OAAO,EAAE,cAAc,CAA+B;IAG9D,IAAI,EAAE,MAAM,CAAC;IAEN,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAOpC"}

package/dist/commands/make_filter.js

@@ -0,0 +1,32 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { BaseCommand, args } from '@adonisjs/core/ace';
+import { stubsRoot } from '../stubs/main.js';
+/**
+ * `node ace make:filter <name>` — scaffold a filter class under `app/filters/`.
+ *
+ * The generated class extends `BaseModelFilter`: allow-lists as statics for the plain columns, a
+ * `setup()` for the scope the client cannot relax, and a method per key that needs SQL of its own.
+ * It is `@inject()`ed, so a constructor dependency resolves through the container exactly as a
+ * controller's does.
+ */
+export default class MakeFilter extends BaseCommand {
+    static commandName = 'make:filter';
+    static description = 'Create a new filter class';
+    static options = { allowUnknownFlags: true };
+    async run() {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, 'make/filter/main.stub', {
+            flags: this.parsed.flags,
+            entity: this.app.generators.createEntity(this.name),
+        });
+    }
+}
+__decorate([
+    args.string({ description: 'Name of the filter (e.g. user)' })
+], MakeFilter.prototype, "name", void 0);
+//# sourceMappingURL=make_filter.js.map

package/dist/commands/make_filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make_filter.js","sourceRoot":"","sources":["../../commands/make_filter.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,MAAM,CAAU,WAAW,GAAG,aAAa,CAAC;IAC5C,MAAM,CAAU,WAAW,GAAG,2BAA2B,CAAC;IAC1D,MAAM,CAAU,OAAO,GAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;IAK7D,KAAK,CAAC,GAAG;QAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,uBAAuB,EAAE;YAC/D,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;SACpD,CAAC,CAAC;IACL,CAAC;;AARO;IADP,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;wCAC1C"}

package/dist/src/apply_from_request.d.ts

@@ -1,4 +1,5 @@
 import type { ResolvedCursor } from './cursor.js';
+import { type FilterClass } from './filter_class.js';
 import { type FilterSpec } from './filter_spec.js';
 import { type QueryBuilderLike } from './lucid_adapter.js';
 import { type ResolvedPagination } from './runner.js';
@@ -59,6 +60,13 @@ export interface ApplyCursorFromRequestOptions extends ApplyFromRequestOptions {
  * ```
  */
 export declare function applyFilterFromRequest(query: QueryBuilderLike, spec: FilterSpec, ctx: FilterRequestContext | undefined, options?: ApplyFromRequestOptions): ResolvedPagination;
+/**
+ * The class form: the filter is resolved through the IoC container (so an `@inject()`ed
+ * constructor works), its `setup()` runs before anything the request asked for, and every request
+ * key the class owns a method for is dispatched to that method instead of the declarative path.
+ * Resolution is async, so this overload returns a promise.
+ */
+export declare function applyFilterFromRequest(query: QueryBuilderLike, filter: FilterClass, ctx: FilterRequestContext | undefined, options?: ApplyFromRequestOptions): Promise<ResolvedPagination>;
 /**
  * The keyset (cursor) counterpart of {@link applyFilterFromRequest}. Sources the
  * request filters and the `after`/`before`/`first`/`last` cursor params from ctx,

package/dist/src/apply_from_request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apply_from_request.d.ts","sourceRoot":"","sources":["../../src/apply_from_request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,KAAK,UAAU,EAAsB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,KAAK,gBAAgB,EAAsB,MAAM,oBAAoB,CAAC;AAG/E,OAAO,EAAqB,KAAK,kBAAkB,EAA4B,MAAM,aAAa,CAAC;AACnG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IAEjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,kDAAkD;AAClD,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA6CD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,oBAAoB,GAAG,SAAS,EACrC,OAAO,GAAE,uBAA4B,GACpC,kBAAkB,CAQpB;AA8BD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,oBAAoB,GAAG,SAAS,EACrC,OAAO,GAAE,6BAAkC,GAC1C,cAAc,CAahB"}
+{"version":3,"file":"apply_from_request.d.ts","sourceRoot":"","sources":["../../src/apply_from_request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EACL,KAAK,WAAW,EAIjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,UAAU,EAAsB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,KAAK,gBAAgB,EAAsB,MAAM,oBAAoB,CAAC;AAG/E,OAAO,EAAqB,KAAK,kBAAkB,EAA4B,MAAM,aAAa,CAAC;AACnG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IAEjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,kDAAkD;AAClD,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA6CD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,oBAAoB,GAAG,SAAS,EACrC,OAAO,CAAC,EAAE,uBAAuB,GAChC,kBAAkB,CAAC;AACtB;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,gBAAgB,EACvB,MAAM,EAAE,WAAW,EACnB,GAAG,EAAE,oBAAoB,GAAG,SAAS,EACrC,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAyI/B;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,oBAAoB,GAAG,SAAS,EACrC,OAAO,GAAE,6BAAkC,GAC1C,cAAc,CAahB"}

package/dist/src/apply_from_request.js

@@ -1,3 +1,4 @@
+import { isFilterClass, methodForKey, specFromFilterClass, } from './filter_class.js';
 import { specToFilterConfig } from './filter_spec.js';
 import { applyColumnFilters } from './lucid_adapter.js';
 import { parseFilterRequest } from './parse_request.js';
@@ -38,27 +39,13 @@ function withDefaultSort(input, spec) {
     }
     return input;
 }
-/**
- * Apply a {@link FilterSpec} to a Lucid query from a request context, returning
- * the resolved offset pagination — the single explicit call an AdonisJS
- * controller makes (the idiomatic replacement for the NestJS
- * `ApplyFilterInterceptor` + `@ApplyFilter` param decorator).
- *
- * It resolves the request input from `ctx.request.qs()`, injects the server
- * scope (tenant + default filters) that is never exposed to the allow-list, and
- * delegates the allow-listed filter/sort/search + pagination resolution to
- * {@link applyFilter}.
- *
- * ```ts
- * const spec = defineFilter({ filterable: ['name', 'age'], tenant: { column: 'tenantId', resolve: (ctx) => ctx.auth.user.tenantId } })
- *
- * // in a controller:
- * const query = User.query()
- * const { page, size } = applyFilterFromRequest(query, spec, ctx)
- * return query.paginate(page, size)
- * ```
- */
-export function applyFilterFromRequest(query, spec, ctx, options = {}) {
+export function applyFilterFromRequest(query, specOrClass, ctx, options = {}) {
+    if (isFilterClass(specOrClass)) {
+        return applyFilterClass(query, specOrClass, ctx, options);
+    }
+    return applySpec(query, specOrClass, ctx, options);
+}
+function applySpec(query, spec, ctx, options) {
     const parsed = options.input ?? parseFilterRequest(rawQs(ctx));
     const withVector = options.vectorSimilarity !== undefined
         ? { ...parsed, vectorSimilarity: options.vectorSimilarity }
@@ -66,6 +53,68 @@ export function applyFilterFromRequest(query, spec, ctx, options = {}) {
     applyServerScope(query, spec, ctx);
     return applyFilter(query, withDefaultSort(withVector, spec), specToFilterConfig(spec));
 }
+/**
+ * Resolve a filter class through the request's IoC container when there is one — the same
+ * resolver a controller is constructed with, so `@inject()` on the filter behaves identically —
+ * and fall back to plain construction outside an AdonisJS request (a test, a script).
+ */
+async function resolveFilter(cls, ctx) {
+    const resolver = ctx?.containerResolver;
+    if (resolver && typeof resolver.make === 'function') {
+        return (await resolver.make(cls));
+    }
+    return new cls();
+}
+/**
+ * Run a filter class against the query: bind the per-request state onto the instance, run
+ * `setup()`, apply everything the class declared statically through the ordinary spec path, then
+ * hand each key the class owns to its own method.
+ *
+ * The split matters: a key with a method is removed from the declarative input **before** the
+ * runner sees it, so `fullName` never becomes `where "fullName" = ?` on a column that may not
+ * exist — the method is the only thing that touches it.
+ */
+async function applyFilterClass(query, cls, ctx, options) {
+    const raw = rawQs(ctx);
+    const parsed = options.input ?? parseFilterRequest(raw);
+    const instance = await resolveFilter(cls, ctx);
+    const owned = [];
+    const rest = [];
+    for (const condition of parsed.filters ?? []) {
+        const method = methodForKey(cls, condition.field);
+        if (method === undefined) {
+            rest.push(condition);
+            continue;
+        }
+        owned.push({ method, value: condition.value, operator: condition.operator });
+    }
+    // A bare top-level key (`?minAge=21`) reaches a method of the same name too — the shape
+    // `adonis-lucid-filter` dispatches on — as long as the wire format does not own the key.
+    for (const [key, value] of Object.entries(raw)) {
+        const method = methodForKey(cls, key);
+        if (method !== undefined && !owned.some((entry) => entry.method === method)) {
+            owned.push({ method, value, operator: 'equals' });
+        }
+    }
+    Object.assign(instance, {
+        $query: query,
+        $input: raw,
+        $parsed: parsed,
+        $ctx: ctx,
+    });
+    await instance.setup?.();
+    const pagination = applySpec(query, specFromFilterClass(cls), ctx, {
+        ...options,
+        input: { ...parsed, filters: rest },
+    });
+    for (const { method, value, operator } of owned) {
+        const fn = instance[method];
+        if (typeof fn === 'function') {
+            await fn.call(instance, value, operator);
+        }
+    }
+    return pagination;
+}
 /** Parse cursor (keyset) params from a decoded query string (Spatie `page[...]` shapes). */
 function parseCursorParams(qs) {
     const out = {};

package/dist/src/apply_from_request.js.map

@@ -1 +1 @@
-{"version":3,"file":"apply_from_request.js","sourceRoot":"","sources":["../../src/apply_from_request.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAyB,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAA8C,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAwCnG,4EAA4E;AAC5E,SAAS,KAAK,CAAC,GAAqC;IAClD,MAAM,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC;IAC5B,IAAI,OAAO,EAAE,KAAK,UAAU;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CACvB,KAAuB,EACvB,IAAgB,EAChB,GAAqC;IAErC,MAAM,aAAa,GAAmB,EAAE,CAAC;IAEzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YAChD,aAAa,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,GAAI,IAAI,CAAC,cAAiC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,SAAS,eAAe,CAAC,KAAkB,EAAE,IAAgB;IAC3D,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAuB,EACvB,IAAgB,EAChB,GAAqC,EACrC,UAAmC,EAAE;IAErC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,MAAM,UAAU,GACd,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACpC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,EAAE;QAC3D,CAAC,CAAC,MAAM,CAAC;IACb,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,OAAO,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,4FAA4F;AAC5F,SAAS,iBAAiB,CAAC,EAA2B;IACpD,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,IAAI,GACR,EAAE,CAAC,IAAI,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC;QACvE,CAAC,CAAE,EAAE,CAAC,IAAgC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,KAAK,CAAC;IACtC,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,IAAI,IAAI,EAAE,MAAM,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;SAChE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IAE9E,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,KAAK,CAAC;IACtC,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,CAAU,EAAsB,EAAE;QAC/C,MAAM,CAAC,GACL,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QAChG,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,CAAC,CAAC;IACF,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,SAAS;QAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAElC,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAuB,EACvB,IAAgB,EAChB,GAAqC,EACrC,UAAyC,EAAE;IAE3C,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAA+B;QACvC,GAAG,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;QAChC,GAAG,iBAAiB,CAAC,EAAE,CAAC;KACzB,CAAC;IACF,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,MAAM,MAAM,GAAiB;QAC3B,GAAG,kBAAkB,CAAC,IAAI,CAAC;QAC3B,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;KAC5E,CAAC;IACF,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"apply_from_request.js","sourceRoot":"","sources":["../../src/apply_from_request.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,aAAa,EACb,YAAY,EACZ,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAmB,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAyB,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAA8C,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAwCnG,4EAA4E;AAC5E,SAAS,KAAK,CAAC,GAAqC;IAClD,MAAM,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC;IAC5B,IAAI,OAAO,EAAE,KAAK,UAAU;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CACvB,KAAuB,EACvB,IAAgB,EAChB,GAAqC;IAErC,MAAM,aAAa,GAAmB,EAAE,CAAC;IAEzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YAChD,aAAa,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,GAAI,IAAI,CAAC,cAAiC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,SAAS,eAAe,CAAC,KAAkB,EAAE,IAAgB;IAC3D,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAwCD,MAAM,UAAU,sBAAsB,CACpC,KAAuB,EACvB,WAAqC,EACrC,GAAqC,EACrC,UAAmC,EAAE;IAErC,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,OAAO,gBAAgB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,SAAS,CAChB,KAAuB,EACvB,IAAgB,EAChB,GAAqC,EACrC,OAAgC;IAEhC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,MAAM,UAAU,GACd,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACpC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,EAAE;QAC3D,CAAC,CAAC,MAAM,CAAC;IACb,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,OAAO,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAC1B,GAAgB,EAChB,GAAqC;IAErC,MAAM,QAAQ,GAAG,GAAG,EAAE,iBAET,CAAC;IACd,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACpD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAoB,CAAC;IACvD,CAAC;IACD,OAAO,IAAI,GAAG,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,gBAAgB,CAC7B,KAAuB,EACvB,GAAgB,EAChB,GAAqC,EACrC,OAAgC;IAEhC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE/C,MAAM,KAAK,GAA2D,EAAE,CAAC;IACzE,MAAM,IAAI,GAAmB,EAAE,CAAC;IAChC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrB,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,wFAAwF;IACxF,yFAAyF;IACzF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,CAAC;YAC5E,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;QACtB,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,GAAG;QACX,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;IAEzB,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE;QACjE,GAAG,OAAO;QACV,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE;KACpC,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,KAAK,EAAE,CAAC;QAChD,MAAM,EAAE,GAAI,QAA+C,CAAC,MAAM,CAAC,CAAC;QACpE,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAO,EAA0C,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,4FAA4F;AAC5F,SAAS,iBAAiB,CAAC,EAA2B;IACpD,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,IAAI,GACR,EAAE,CAAC,IAAI,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC;QACvE,CAAC,CAAE,EAAE,CAAC,IAAgC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,KAAK,CAAC;IACtC,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,IAAI,IAAI,EAAE,MAAM,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;SAChE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IAE9E,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,KAAK,CAAC;IACtC,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,CAAU,EAAsB,EAAE;QAC/C,MAAM,CAAC,GACL,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QAChG,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,CAAC,CAAC;IACF,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,SAAS;QAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAElC,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAuB,EACvB,IAAgB,EAChB,GAAqC,EACrC,UAAyC,EAAE;IAE3C,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAA+B;QACvC,GAAG,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;QAChC,GAAG,iBAAiB,CAAC,EAAE,CAAC;KACzB,CAAC;IACF,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,MAAM,MAAM,GAAiB;QAC3B,GAAG,kBAAkB,CAAC,IAAI,CAAC;QAC3B,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;KAC5E,CAAC;IACF,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/dist/src/base_model_filter.d.ts

@@ -0,0 +1,109 @@
+import type { LucidModelLike } from './aggregate.js';
+import type { FieldAliases } from './field_aliases.js';
+import type { FilterableInput, RelationColumns, RelationSpec, TenantScopeSpec } from './filter_spec.js';
+import type { FilterFieldTypeInfo } from './generate_client.js';
+import type { QueryBuilderLike } from './lucid_adapter.js';
+import type { ColumnFilter } from './operators.js';
+import type { ComputedFields, FilterInput, FullTextSearchConfig, SortItem, VectorSimilarityConfig } from './types.js';
+/**
+ * The class-authoring form of a filter — the counterpart of `defineFilter`, in the shape
+ * AdonisJS developers already know from `adonis-lucid-filter`: **a method per request key**,
+ * with the query builder on `this.$query`.
+ *
+ * A method's name IS the key it owns. `?filter[fullName]=silva` calls `fullName('silva')`, and
+ * because you wrote the method, the key needs no allow-list entry — writing the code is the
+ * decision to expose it. Plain columns that need no custom SQL stay declarative: list them in
+ * `static filterable` and the runner applies the operators, search, sort and pagination for you.
+ *
+ * The class is resolved through the IoC container, so an `@inject()`ed constructor works: a
+ * filter can depend on a service exactly like a controller does.
+ *
+ * ```ts
+ * @inject()
+ * export default class UserFilter extends BaseModelFilter {
+ *   declare $query: ModelQueryBuilderContract<typeof User>
+ *
+ *   constructor(private tenants: TenantsService) { super() }
+ *
+ *   static model = User
+ *   static filterable = ['name', 'email', 'status']
+ *   static sortable = ['name', 'createdAt']
+ *   static searchable = ['name', 'email']
+ *
+ *   // always applied, before anything the request asked for
+ *   setup() {
+ *     this.$query.where('tenantId', this.tenants.current(this.$ctx))
+ *   }
+ *
+ *   // the one key this class owns itself
+ *   fullName(value: string) {
+ *     this.$query.whereILike('full_name', `%${value}%`)
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class BaseModelFilter<Q extends QueryBuilderLike = QueryBuilderLike> {
+    /**
+     * The query builder being filtered — the one the caller created. Methods mutate it directly;
+     * nothing here constructs or executes a query.
+     */
+    $query: Q;
+    /** The raw decoded request input the dispatch reads (query string, or the body on a POST). */
+    $input: Readonly<Record<string, unknown>>;
+    /** The parsed input — filters, sort, search, pagination — after the wire format is read. */
+    $parsed: FilterInput;
+    /** The request context handed to the call (a real `HttpContext` in an AdonisJS app). */
+    $ctx: unknown;
+    /** The owning Lucid model. Unlocks to-many aggregates and supplies the root table name. */
+    static model?: LucidModelLike;
+    /** Columns clients may filter on with the standard operators. `'*'` allows any base column. */
+    static filterable?: FilterableInput;
+    /** Columns clients may sort on. Defaults to `filterable`. */
+    static sortable?: RelationColumns;
+    /** Columns the free-text `search` term scans with a portable ILIKE. */
+    static searchable?: string[];
+    /** Whitelisted relations and the columns reachable through them. */
+    static relations?: Record<string, RelationSpec>;
+    /** Client-alias → target-field remapping. */
+    static aliases?: FieldAliases;
+    /** Virtual fields — alias → SQL expression. */
+    static computed?: ComputedFields;
+    /** Per-field value kinds, driving coercion and typed client codegen. */
+    static fieldTypes?: Record<string, FilterFieldTypeInfo>;
+    /** Opt-in Postgres tsvector search for the `search` term. */
+    static fullText?: FullTextSearchConfig;
+    /** Opt-in pgvector embedding-similarity ordering. */
+    static vectorSimilarity?: VectorSimilarityConfig;
+    /** Auto-scope a column to the tenant resolved from ctx (the declarative form of `setup`). */
+    static tenant?: TenantScopeSpec;
+    /** Server-declared filters always AND-combined with the request. */
+    static defaultFilters?: ColumnFilter[];
+    /** Sort applied when the request carries none. */
+    static defaultSort?: SortItem[];
+    /** Page size when the request asks for none. Default 25. */
+    static defaultSize?: number;
+    /** Hard cap on page size. Default 100. */
+    static maxSize?: number;
+    /** Max relation-path hops. Defaults to the deepest declared relation nesting. */
+    static maxDepth?: number;
+    /** Root table name — defaults to `model.table`. */
+    static table?: string;
+    /** Throw `InvalidColumnFilterError` on a disallowed field instead of dropping it. */
+    static throwOnInvalid?: boolean;
+    /** Method names that must never be dispatched from request input, whatever the key says. */
+    static blacklist?: string[];
+    /** Strip a trailing `Id` from an input key before looking for a method (`companyId` → `company`). */
+    static dropId?: boolean;
+    /** Match `snake_case` input keys against camelCase methods (`first_name` → `firstName`). Default true. */
+    static camelCase?: boolean;
+    /**
+     * Runs on every filter call, before the request's own filters — the place for a scope the
+     * client cannot relax (a tenant, a soft-delete guard, an ownership check).
+     */
+    setup?(): void | Promise<void>;
+    /** The whole raw input, one key of it, or a fallback when the key is absent. */
+    input(): Readonly<Record<string, unknown>>;
+    input(key: string): unknown;
+    input(key: string, fallback: unknown): unknown;
+}
+//# sourceMappingURL=base_model_filter.d.ts.map

package/dist/src/base_model_filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base_model_filter.d.ts","sourceRoot":"","sources":["../../src/base_model_filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACZ,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,QAAQ,EACR,sBAAsB,EACvB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,8BAAsB,eAAe,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IACjF;;;OAGG;IACK,MAAM,EAAE,CAAC,CAAC;IAElB,8FAA8F;IACtF,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAElD,4FAA4F;IACpF,OAAO,EAAE,WAAW,CAAC;IAE7B,wFAAwF;IAChF,IAAI,EAAE,OAAO,CAAC;IAItB,2FAA2F;IAC3F,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAC9B,+FAA+F;IAC/F,MAAM,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC;IACpC,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;IAClC,uEAAuE;IACvE,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAChD,6CAA6C;IAC7C,MAAM,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAC9B,+CAA+C;IAC/C,MAAM,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC;IACjC,wEAAwE;IACxE,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACxD,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IACvC,qDAAqD;IACrD,MAAM,CAAC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IACjD,6FAA6F;IAC7F,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAChC,oEAAoE;IACpE,MAAM,CAAC,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IACvC,kDAAkD;IAClD,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChC,4DAA4D;IAC5D,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB,iFAAiF;IACjF,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAIhC,4FAA4F;IAC5F,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,qGAAqG;IACrG,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IACxB,0GAA0G;IAC1G,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9B,gFAAgF;IAChF,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAC3B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO;CAK/C"}

package/dist/src/base_model_filter.js

@@ -0,0 +1,89 @@
+/**
+ * The class-authoring form of a filter — the counterpart of `defineFilter`, in the shape
+ * AdonisJS developers already know from `adonis-lucid-filter`: **a method per request key**,
+ * with the query builder on `this.$query`.
+ *
+ * A method's name IS the key it owns. `?filter[fullName]=silva` calls `fullName('silva')`, and
+ * because you wrote the method, the key needs no allow-list entry — writing the code is the
+ * decision to expose it. Plain columns that need no custom SQL stay declarative: list them in
+ * `static filterable` and the runner applies the operators, search, sort and pagination for you.
+ *
+ * The class is resolved through the IoC container, so an `@inject()`ed constructor works: a
+ * filter can depend on a service exactly like a controller does.
+ *
+ * ```ts
+ * @inject()
+ * export default class UserFilter extends BaseModelFilter {
+ *   declare $query: ModelQueryBuilderContract<typeof User>
+ *
+ *   constructor(private tenants: TenantsService) { super() }
+ *
+ *   static model = User
+ *   static filterable = ['name', 'email', 'status']
+ *   static sortable = ['name', 'createdAt']
+ *   static searchable = ['name', 'email']
+ *
+ *   // always applied, before anything the request asked for
+ *   setup() {
+ *     this.$query.where('tenantId', this.tenants.current(this.$ctx))
+ *   }
+ *
+ *   // the one key this class owns itself
+ *   fullName(value: string) {
+ *     this.$query.whereILike('full_name', `%${value}%`)
+ *   }
+ * }
+ * ```
+ */
+export class BaseModelFilter {
+    // ── the declarative half: everything a plain column needs, without writing a method ──────────
+    /** The owning Lucid model. Unlocks to-many aggregates and supplies the root table name. */
+    static model;
+    /** Columns clients may filter on with the standard operators. `'*'` allows any base column. */
+    static filterable;
+    /** Columns clients may sort on. Defaults to `filterable`. */
+    static sortable;
+    /** Columns the free-text `search` term scans with a portable ILIKE. */
+    static searchable;
+    /** Whitelisted relations and the columns reachable through them. */
+    static relations;
+    /** Client-alias → target-field remapping. */
+    static aliases;
+    /** Virtual fields — alias → SQL expression. */
+    static computed;
+    /** Per-field value kinds, driving coercion and typed client codegen. */
+    static fieldTypes;
+    /** Opt-in Postgres tsvector search for the `search` term. */
+    static fullText;
+    /** Opt-in pgvector embedding-similarity ordering. */
+    static vectorSimilarity;
+    /** Auto-scope a column to the tenant resolved from ctx (the declarative form of `setup`). */
+    static tenant;
+    /** Server-declared filters always AND-combined with the request. */
+    static defaultFilters;
+    /** Sort applied when the request carries none. */
+    static defaultSort;
+    /** Page size when the request asks for none. Default 25. */
+    static defaultSize;
+    /** Hard cap on page size. Default 100. */
+    static maxSize;
+    /** Max relation-path hops. Defaults to the deepest declared relation nesting. */
+    static maxDepth;
+    /** Root table name — defaults to `model.table`. */
+    static table;
+    /** Throw `InvalidColumnFilterError` on a disallowed field instead of dropping it. */
+    static throwOnInvalid;
+    // ── dispatch controls (the `adonis-lucid-filter` knobs) ──────────────────────────────────────
+    /** Method names that must never be dispatched from request input, whatever the key says. */
+    static blacklist;
+    /** Strip a trailing `Id` from an input key before looking for a method (`companyId` → `company`). */
+    static dropId;
+    /** Match `snake_case` input keys against camelCase methods (`first_name` → `firstName`). Default true. */
+    static camelCase;
+    input(key, fallback) {
+        if (key === undefined)
+            return this.$input;
+        return Object.hasOwn(this.$input, key) ? this.$input[key] : fallback;
+    }
+}
+//# sourceMappingURL=base_model_filter.js.map

package/dist/src/base_model_filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base_model_filter.js","sourceRoot":"","sources":["../../src/base_model_filter.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAgB,eAAe;IAgBnC,gGAAgG;IAEhG,2FAA2F;IAC3F,MAAM,CAAC,KAAK,CAAkB;IAC9B,+FAA+F;IAC/F,MAAM,CAAC,UAAU,CAAmB;IACpC,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAmB;IAClC,uEAAuE;IACvE,MAAM,CAAC,UAAU,CAAY;IAC7B,oEAAoE;IACpE,MAAM,CAAC,SAAS,CAAgC;IAChD,6CAA6C;IAC7C,MAAM,CAAC,OAAO,CAAgB;IAC9B,+CAA+C;IAC/C,MAAM,CAAC,QAAQ,CAAkB;IACjC,wEAAwE;IACxE,MAAM,CAAC,UAAU,CAAuC;IACxD,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAwB;IACvC,qDAAqD;IACrD,MAAM,CAAC,gBAAgB,CAA0B;IACjD,6FAA6F;IAC7F,MAAM,CAAC,MAAM,CAAmB;IAChC,oEAAoE;IACpE,MAAM,CAAC,cAAc,CAAkB;IACvC,kDAAkD;IAClD,MAAM,CAAC,WAAW,CAAc;IAChC,4DAA4D;IAC5D,MAAM,CAAC,WAAW,CAAU;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,OAAO,CAAU;IACxB,iFAAiF;IACjF,MAAM,CAAC,QAAQ,CAAU;IACzB,mDAAmD;IACnD,MAAM,CAAC,KAAK,CAAU;IACtB,qFAAqF;IACrF,MAAM,CAAC,cAAc,CAAW;IAEhC,gGAAgG;IAEhG,4FAA4F;IAC5F,MAAM,CAAC,SAAS,CAAY;IAC5B,qGAAqG;IACrG,MAAM,CAAC,MAAM,CAAW;IACxB,0GAA0G;IAC1G,MAAM,CAAC,SAAS,CAAW;IAY3B,KAAK,CAAC,GAAY,EAAE,QAAkB;QACpC,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC;QAC1C,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACvE,CAAC;CACF"}

package/dist/src/decorator_metadata.d.ts

@@ -0,0 +1,41 @@
+import type { FilterFieldKind } from './types.js';
+/**
+ * What the decorators record about a class, per declaration site.
+ *
+ * Two storage channels back this, because two decorator flavours exist in the wild:
+ *
+ * - **legacy** (`experimentalDecorators`, what AdonisJS uses today — Lucid's `@column` requires
+ *   it) hands the decorator the *prototype*, so the record is kept in a `WeakMap` keyed by it;
+ * - **standard** (TC39 stage 3, TypeScript 5's default when the flag is off) hands the decorator
+ *   a context object carrying a per-class `metadata` bag, so the record is kept in there.
+ *
+ * Both are read back the same way, so a class works under either flavour — and inheritance falls
+ * out of the walk: prototype chain for the first, the metadata object's own prototype chain
+ * (which the standard emit links to the base class's) for the second.
+ */
+export interface FilterDecoratorRecord {
+    /** Method name → the request keys `@filterFor` bound it to. */
+    filterFor?: Record<string, string[]>;
+    /** Column name → the kind `@filterable` declared, or `null` when it declared none. */
+    filterable?: Record<string, FilterFieldKind | null>;
+    /** Columns marked `@sortable`. */
+    sortable?: string[];
+    /** Columns marked `@searchable`. */
+    searchable?: string[];
+}
+/** The record a legacy decorator writes into, created on first use. */
+export declare function legacyRecord(prototype: object): FilterDecoratorRecord;
+/**
+ * The record a standard decorator writes into. The bag a subclass receives *inherits* from its
+ * base's, so the record is defined as an **own** property — writing through the inherited one
+ * would leak a subclass's bindings back onto the parent.
+ */
+export declare function standardRecord(metadata: object): FilterDecoratorRecord;
+/**
+ * The merged declaration for a class — its own decorators layered over everything it inherits.
+ *
+ * Not memoized: decorators run at class-definition time, but a model's columns and a filter's
+ * methods are read once per compiled spec, which is itself cached by the caller.
+ */
+export declare function readDecorators(cls: object): FilterDecoratorRecord;
+//# sourceMappingURL=decorator_metadata.d.ts.map

package/dist/src/decorator_metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator_metadata.d.ts","sourceRoot":"","sources":["../../src/decorator_metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,qBAAqB;IACpC,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACrC,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC,CAAC;IACpD,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAoBD,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,qBAAqB,CAMrE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,qBAAqB,CAUtE;AA6BD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CASjE"}