@codenameryuu/adonis-lucid-filter 2.9.0 → 3.1.0

package/README.md

@@ -2,60 +2,10 @@
 
 This addon adds the functionality to filter Lucid Models Adonis JS 7. Inspired by [EloquentFilter](https://github.com/Tucker-Eric/EloquentFilter)
 
-## Introduction
+## Requirement
 
-Example, we want to return a list of users filtered by multiple parameters. When we navigate to:
-
-`/users?name=Tony&lastName=&companyId=2&industry=5`
-
-`request.all()` or `request.qs()` will return:
-
-```json
-{
-  "name": "Tony",
-  "lastName": "",
-  "companyId": 2,
-  "industry": 5
-}
-```
-
-To filter by all those parameters we would need to do something like:
-
-```typescript
-import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
-
-export default class UsersController {
-  async index({ request }: HttpContext): Promise<User[]> {
-    const { companyId, lastName, name, industry } = request.qs()
-
-    const query = User.query().where('company_id', +companyId)
-
-    if (lastName) {
-      query.where('last_name', 'LIKE', `%${lastName}%`)
-    }
-    if (name) {
-      query.where(function () {
-        this.where('first_name', 'LIKE', `%${name}%`).orWhere('last_name', 'LIKE', `%${name}%`)
-      })
-    }
-    return query.exec()
-  }
-}
-```
-
-To filter that same input with Lucid Filters:
-
-```typescript
-import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
-
-export default class UsersController {
-  async index({ request }: HttpContext): Promise<User[]> {
-    return User.filter(request.qs()).exec()
-  }
-}
-```
+- Adonis Js 7
+- Lucid 22 or higher
 
 ## Installation
 
@@ -71,9 +21,7 @@ yarn add @codenameryuu/adonis-lucid-filter
 node ace configure @codenameryuu/adonis-lucid-filter
 ```
 
-## Usage
-
-- Register the provider and commands inside `adonisrc.ts` file.
+- Make sure to register the provider inside `adonisrc.ts` file.
 
 ```typescript
 providers: [
@@ -86,17 +34,15 @@ commands: [
 ]
 ```
 
-### Generating The Filter
-
-> Only available if you have added `@codenameryuu/adonis-lucid-filter/commands` in `commands` array in your `adonisrc.ts'
+## Usage
 
 You can create a model filter with the following ace command:
 
 ```bash
-node ace make:filter user
+node ace make:filter product
 ```
 
-Where `user` is the Lucid Model you are creating the filter for. This will create `app/models/filters/user_filter.js`
+Where `product` is the Lucid Model you are creating the filter for. This will create `app/models/filters/product_filter.ts`
 
 ### Defining The Filter Logic
 
@@ -104,7 +50,7 @@ Define the filter logic based on the camel cased input key passed to the `filter
 
 - Empty strings are ignored
 - `setup()` will be called regardless of input
-- `_id` is dropped from the end of the input to define the method so filtering `user_id` would use the `user()` method
+- `_id` is dropped from the end of the input to define the method so filtering `product_id` would use the `product()` method
 - Input without a corresponding filter method are ignored
 - The value of the key is injected into the method
 - All values are accessible through the `this.$input` a property
@@ -114,37 +60,45 @@ To define methods for the following input:
 
 ```json
 {
-  "companyId": 5,
-  "name": "Tony",
-  "mobilePhone": "888555"
+  "productCategoryId": 1,
+  "name": "Car",
+  "price": 100000
 }
 ```
 
 You would use the following methods:
 
 ```typescript
-import { BaseModelFilter } from 'adonis-lucid-filter'
+import { BaseModelFilter } from '@codenameryuu/adonis-lucid-filter'
 import type { ModelQueryBuilderContract } from '@adonisjs/lucid/types/model'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UserFilter extends BaseModelFilter {
-  declare $query: ModelQueryBuilderContract<typeof User>
+export default class ProductFilter extends BaseModelFilter {
+  declare $query: ModelQueryBuilderContract<typeof Product>
 
+  // Blacklisted methods
   static blacklist: string[] = ['secretMethod']
 
-  // This will filter 'companyId', 'company_id' OR 'company'
-  company(id: number) {
-    this.$query.where('company_id', id)
+  // Dropped `_id` from the end of the input
+  // Doing this would allow you to have a `company()` filter method as well as a `companyId()` filter method.
+  static dropId: boolean = true
+
+  // Doing this would allow you to have a mobile_phone() filter method instead of mobilePhone().
+  // By default, mobilePhone() filter method can be called thanks to one of the following input key:
+  // mobile_phone, mobilePhone, mobile_phone_id, mobilePhoneId
+  static camelCase: boolean = true
+
+  // This will filter 'productCategoryId', 'product_category_id' OR 'productCategory'
+  productCategory(id: number) {
+    this.$query.where('product_category_id', id)
   }
 
   name(name: string) {
-    this.$query.where((builder) => {
-      builder.where('first_name', 'LIKE', `%${name}%`).orWhere('last_name', 'LIKE', `%${name}%`)
-    })
+    this.$query.where('name', 'LIKE', `%${name}%`)
   }
 
-  mobilePhone(phone: string) {
-    this.$query.where('mobile_phone', 'LIKE', `${phone}%`)
+  price(price: number) {
+    this.$query.where('price', price)
   }
 
   secretMethod(secretParameter: any) {
@@ -176,33 +130,16 @@ setup($query) {
 In the example above `secretMethod()` will not be called, even if there is a `secret_method` key in the input object.
 In order to call this method it would need to be whitelisted dynamically:
 
-#### Static properties
-
-```typescript
-export default class UserFilter extends BaseModelFilter {
-  // Blacklisted methods
-  static blacklist: string[] = []
-
-  // Dropped `_id` from the end of the input
-  // Doing this would allow you to have a `company()` filter method as well as a `companyId()` filter method.
-  static dropId: boolean = true
-
-  // Doing this would allow you to have a mobile_phone() filter method instead of mobilePhone().
-  // By default, mobilePhone() filter method can be called thanks to one of the following input key:
-  // mobile_phone, mobilePhone, mobile_phone_id, mobilePhoneId
-  static camelCase: boolean = true
-}
-```
-
 ### Applying The Filter To A Model
 
 ```typescript
-import UserFilter from '#models/filters/user_filter'
 import { compose } from '@adonisjs/core/helpers'
-import { Filterable } from 'adonis-lucid-filter'
+import { Filterable } from '@codenameryuu/adonis-lucid-filter'
 
-export default class User extends compose(BaseModel, Filterable) {
-  static $filter = () => UserFilter
+import ProductFilter from '#models/filters/product_filter'
+
+export default class Product extends compose(BaseModel, Filterable) {
+  static $filter = () => ProductFilter
 
   // ...columns and props
 }
@@ -212,18 +149,17 @@ This gives you access to the `filter()` method that accepts an object of input:
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import Product from '#models/product'
 
-export default class UsersController {
-  async index({ request }: HttpContext): Promise<User[]> {
-    return User.filter(request.qs()).exec()
+export default class ProductsController {
+  async index({ request }: HttpContext): Promise<Product[]> {
+    return Product.filter(request.all()).orderBy('created_at', 'desc')
   }
 
   // or with paginate method
 
-  async index({ request }: HttpContext): Promise<ModelPaginatorContract<User>> {
-    const { page = 1, ...input } = request.qs()
-    return User.filter(input).paginate(page, 15)
+  async index({ request }: HttpContext): Promise<ModelPaginatorContract<Product>> {
+    return Product.filter(request.all()).paginate(1, 10)
   }
 }
 ```
@@ -235,13 +171,13 @@ Defining a filter dynamically will take precedent over any other filters defined
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import AdminFilter from '#models/filters/admin_filter'
-import UserFilter from '#models/filters/user_filter'
+import ProductFilter from '#models/filters/product_filter'
+import ProductExclusiveFilter from '#models/filters/product_exclusive_filter'
 
-export default class UsersController {
-  async index({ request, auth }: HttpContext): Promise<User[]> {
-    const filter = auth.user.isAdmin() ? AdminFilter : UserFilter
-    return User.filter(request.qs(), filter).exec()
+export default class ProductsController {
+  async index({ request, auth }: HttpContext): Promise<Product[]> {
+    const filter = auth.user.isAdmin() ? ProductFilter : ProductExclusiveFilter
+    return Product.filter(request.all(), filter).orderBy('created_at', 'desc')
   }
 }
 ```
@@ -252,25 +188,23 @@ For filtering relations of model may be use `.query().filter()` or scope `filtra
 
 ```typescript
 import type { HttpContext } from '@adonisjs/core/http'
-import User from '#models/user'
+import ProductCategory from '#models/product_category'
 
-export default class UserPostsController {
+export default class ProductCategoriesController {
   /**
-   * Get a list posts of user
-   * GET /users/:user_id/posts
+   * Get a list products of product category
+   * GET /product-categories/:product_category_id/products
    */
-  async index({ params, request }: HttpContext): Promise<Post[]> {
-    const user: User = await User.findOrFail(params.user_id)
+  async index({ params, request }: HttpContext): Promise<Product[]> {
+    const productCategory: ProductCategory = await ProductCategory.findOrFail(
+      params.product_category_id
+    )
 
-    return user
-      .related('posts')
+    return productCategory
+      .related('products')
       .query()
-      .apply((scopes) => scopes.filtration(request.qs()))
-      .exec()
-
-    // or
-
-    return user.related('posts').query().filter(request.qs()).exec()
+      .filter(request.all())
+      .orderBy('created_at', 'desc')
   }
 }
 ```
@@ -278,3 +212,7 @@ export default class UserPostsController {
 Documentation by [Query Scopes](https://lucid.adonisjs.com/docs/model-query-scopes)
 
 **Note:** The relation model must be `Filterable` and `$filter` must be defined in it
+
+## License
+
+This project is [MIT](https://github.com/codenameryuu/adonis-lucid-filter/blob/master/LICENSE.md) licensed.

package/build/commands/commands.json

@@ -0,0 +1 @@
+{"commands":[],"version":1}

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

package/build/commands/main.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises'
+
+/**
+ * In-memory cache of commands after they have been loaded
+ */
+let commandsMetaData
+
+/**
+ * Reads the commands from the "./commands.json" file. Since, the commands.json
+ * file is generated automatically, we do not have to validate its contents
+ */
+export async function getMetaData() {
+  if (commandsMetaData) {
+    return commandsMetaData
+  }
+
+  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
+  commandsMetaData = JSON.parse(commandsIndex).commands
+
+  return commandsMetaData
+}
+
+/**
+ * Imports the command by lookingup its path from the commands
+ * metadata
+ */
+export async function getCommand(metaData) {
+  const commands = await getMetaData()
+  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
+  if (!command) {
+    return null
+  }
+
+  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
+  return commandConstructor
+}

package/build/make/filter/main.stub

@@ -0,0 +1,20 @@
+{{#var entity = generators.createEntity(name)}}
+{{#var modelName = generators.modelName(entity.name)}}
+{{#var modelFileName = string(modelName).removeExtension().snakeCase().toString()}}
+{{#var modelFilterName = string(modelName).removeSuffix('filter').pascalCase().suffix(string.pascalCase('filter')).toString()}}
+{{#var modelFilterFileName = string(modelName).snakeCase().suffix('_filter').ext('.ts').toString()}}
+{{{
+  exports({ to: app.modelsPath('filters', entity.path, modelFilterFileName) })
+}}}
+
+import { BaseModelFilter } from 'adonis-lucid-filter'
+import type { ModelQueryBuilderContract } from '@adonisjs/lucid/types/model'
+import {{ modelName }} from '#models/{{ modelFileName }}'
+
+export default class {{ modelFilterName }} extends BaseModelFilter {
+  declare $query: ModelQueryBuilderContract<typeof {{ modelName }}>
+
+  name(value: string): void {
+    this.$query.where('name', value)
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codenameryuu/adonis-lucid-filter",
   "description": "Addon for filtering Adonis JS 7 Lucid ORM",
-  "version": "2.9.0",
+  "version": "3.1.0",
   "author": "codenameryuu",
   "license": "MIT",
   "homepage": "https://github.com/codenameryuu/adonis-lucid-filter#readme",
@@ -26,15 +26,22 @@
     "./provider": "./build/providers/lucid_filter_provider.js"
   },
   "scripts": {
+    "lint": "eslint .",
+    "format": "prettier --write .",
     "clean": "del-cli build",
+    "precompile": "npm run lint && npm run clean",
+    "postcompile": "npm run copy:stubs && npm run index:commands",
+    "compile": "tsc --emitDeclarationOnly --declaration",
+    "build": "npm run compile",
+    "copy:stubs": "copyfiles \"stubs/**/**/*.stub\" --up=\"1\" build",
+    "index:commands": "adonis-kit index build/commands",
+    "quick:test": "NODE_DEBUG=\"adonis-lucid-filter\" node --enable-source-maps --loader=ts-node/esm bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
     "typecheck": "tsc --noEmit",
-    "lint": "eslint . --ext=.ts",
-    "format": "prettier --write .",
-    "prebuild": "npm run lint && npm run clean",
-    "build": "npm run clean && tsc",
-    "release": "release-it",
     "version": "npm run build",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "release": "np"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.7.0",
@@ -63,10 +70,12 @@
     "reflect-metadata": "^0.2.2",
     "ts-node": "^10.9.2",
     "tsup": "^8.1.0",
-    "type-fest": "^4.21.0",
     "typescript": "^5.5.3",
     "youch": "^4.1.0"
   },
+  "dependencies": {
+    "type-fest": "^4.21.0"
+  },
   "peerDependencies": {
     "@adonisjs/core": "^7.0.0",
     "@adonisjs/lucid": "^22.0.0"

package/build/commands/make_filter.js

@@ -1,32 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-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';
-export default class MakeFilter extends BaseCommand {
-    static commandName = 'make:filter';
-    static description = 'Make a new Lucid filter';
-    /**
-     * Run command
-     */
-    async run() {
-        const codemods = await this.createCodemods();
-        await codemods.makeUsingStub(stubsRoot, 'make/filter/main.stub', {
-            name: this.name,
-        });
-    }
-}
-__decorate([
-    args.string({ description: 'Name of the model file' })
-], MakeFilter.prototype, "name", void 0);

package/build/configure.js

@@ -1,15 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export async function configure(command) {
-    const codemods = await command.createCodemods();
-    await codemods.updateRcFile((rcFile) => {
-        rcFile.addProvider('@codenameryuu/adonis-lucid-filter/provider');
-        rcFile.addCommand('@codenameryuu/adonis-lucid-filter/commands');
-    });
-}

package/build/index.js

@@ -1,12 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export { configure } from './configure.js';
-export { stubsRoot } from './stubs/main.js';
-export { BaseModelFilter } from './src/base_model.js';
-export { Filterable } from './src/mixin.js';

package/build/providers/lucid_filter_provider.js

@@ -1,19 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { extendModelQueryBuilder } from '../src/bindings/model_query_builder.js';
-export default class LucidFilterProvider {
-    app;
-    constructor(app) {
-        this.app = app;
-    }
-    async boot() {
-        const { ModelQueryBuilder } = await this.app.import('@adonisjs/lucid/orm');
-        extendModelQueryBuilder(ModelQueryBuilder);
-    }
-}

package/build/src/base_model.js

@@ -1,93 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-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;
-};
-var BaseModelFilter_1;
-import camelCase from 'lodash/camelCase.js';
-function StaticImplements() {
-    return (_t) => { };
-}
-/**
- * Class to filtering AdonisJS Lucid ORM
- *
- * @class BaseModelFilter
- * @constructor
- */
-let BaseModelFilter = class BaseModelFilter {
-    static { BaseModelFilter_1 = this; }
-    $query;
-    $input;
-    static blacklist = [];
-    static dropId = true;
-    static camelCase = true;
-    constructor($query, $input) {
-        this.$query = $query;
-        this.$input = $input;
-        this.$input = BaseModelFilter_1.removeEmptyInput(this.$input);
-        this.$blacklist = this.constructor.blacklist;
-    }
-    handle() {
-        if (this.setup && typeof this.setup === 'function') {
-            this.setup(this.$query);
-        }
-        this.$filterByInput();
-        return this.$query;
-    }
-    whitelistMethod(method) {
-        const index = this.$blacklist.indexOf(method);
-        const isBlacklisted = index !== -1;
-        if (isBlacklisted)
-            this.$blacklist.splice(index, 1);
-        return isBlacklisted;
-    }
-    $filterByInput() {
-        for (const key in this.$input) {
-            const method = this.$getFilterMethod(key);
-            const keyName = key;
-            const value = this.$input[keyName];
-            if (this.$methodIsCallable(method)) {
-                ;
-                this[method](value);
-            }
-        }
-    }
-    $getFilterMethod(key) {
-        const methodName = this.constructor.dropId ? key.replace(/^(.*)(_id|Id)$/, '$1') : key;
-        return this.constructor.camelCase ? camelCase(methodName) : methodName;
-    }
-    static removeEmptyInput(input) {
-        const filteredInput = {};
-        for (const key in input) {
-            const keyName = key;
-            const value = input[keyName];
-            if (value !== '' && value !== null && value !== undefined) {
-                filteredInput[keyName] = value;
-            }
-        }
-        return filteredInput;
-    }
-    $methodIsCallable(method) {
-        const methodKey = method;
-        return (!!this[methodKey] &&
-            typeof this[methodKey] === 'function' &&
-            !this.$methodIsBlacklisted(method));
-    }
-    $methodIsBlacklisted(method) {
-        return this.$blacklist.includes(method);
-    }
-};
-BaseModelFilter = BaseModelFilter_1 = __decorate([
-    StaticImplements()
-], BaseModelFilter);
-export { BaseModelFilter };
-export default BaseModelFilter;

package/build/src/bindings/model_query_builder.js

@@ -1,17 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Define filter method to ModelQueryBuilder
- */
-export function extendModelQueryBuilder(builder) {
-    builder.macro('filter', function (input, filter) {
-        const Filter = filter || this.model.$filter();
-        return new Filter(this, input).handle();
-    });
-}

package/build/src/mixin.js

@@ -1,27 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export const Filterable = (superclass) => {
-    class FilterableModel extends superclass {
-        /**
-         * Filter method of filterable model
-         */
-        static filter(input, filter) {
-            const Filter = filter || this.$filter();
-            return new Filter(this.query(), input).handle();
-        }
-        /**
-         * Filtration scope of filterable model
-         */
-        static filtration = function (query, input, filter) {
-            const Filter = filter || this.$filter();
-            return new Filter(query, input).handle();
-        };
-    }
-    return FilterableModel;
-};

package/build/src/types/filter.js

@@ -1,9 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export {};

package/build/src/types/querybuilder.js

@@ -1,9 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export {};

package/build/stubs/main.js

@@ -1,11 +0,0 @@
-/*
- * adonis-lucid-filter
- *
- * (c) Lookin Anton <alf@lookinlab.ru>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { fileURLToPath } from 'node:url';
-import { dirname } from 'node:path';
-export const stubsRoot = dirname(fileURLToPath(import.meta.url));