@codenameryuu/adonis-lucid-filter 3.1.0 → 3.2.0

package/README.md

@@ -4,24 +4,24 @@ This addon adds the functionality to filter Lucid Models Adonis JS 7. Inspired b
 
 ## Requirement
 
-- Adonis Js 7
-- Lucid 22 or higher
+* Adonis Js 7
+* Lucid 22 or higher
 
 ## Installation
 
-- Install the package
+* Install the package
 
 ```bash
 yarn add @codenameryuu/adonis-lucid-filter
 ```
 
-- Configure the package
+* Configure the package
 
 ```bash
 node ace configure @codenameryuu/adonis-lucid-filter
 ```
 
-- Make sure to register the provider inside `adonisrc.ts` file.
+* Make sure to register the provider inside `adonisrc.ts` file.
 
 ```typescript
 providers: [
@@ -48,13 +48,13 @@ Where `product` is the Lucid Model you are creating the filter for. This will cr
 
 Define the filter logic based on the camel cased input key passed to the `filter()` method.
 
-- 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 `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
-- All QueryBuilder methods are accessible in `this.$query` object in the model filter class.
+* 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 `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
+* All QueryBuilder methods are accessible in `this.$query` object in the model filter class.
 
 To define methods for the following input:
 

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[],"version":1}
+{"commands":[{"commandName":"make:filter","description":"Make a new Lucid filter","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the model file","type":"string"}],"options":{},"filePath":"make_filter.js"}],"version":1}

package/build/commands/make_filter.js

@@ -0,0 +1,32 @@
+/*
+ * 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

@@ -0,0 +1,15 @@
+/*
+ * 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

@@ -0,0 +1,12 @@
+/*
+ * 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

@@ -0,0 +1,19 @@
+/*
+ * 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

@@ -0,0 +1,93 @@
+/*
+ * 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

@@ -0,0 +1,17 @@
+/*
+ * 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

@@ -0,0 +1,27 @@
+/*
+ * 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

@@ -0,0 +1,9 @@
+/*
+ * 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

@@ -0,0 +1,9 @@
+/*
+ * 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

@@ -0,0 +1,11 @@
+/*
+ * 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));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codenameryuu/adonis-lucid-filter",
   "description": "Addon for filtering Adonis JS 7 Lucid ORM",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "author": "codenameryuu",
   "license": "MIT",
   "homepage": "https://github.com/codenameryuu/adonis-lucid-filter#readme",
@@ -31,7 +31,7 @@
     "clean": "del-cli build",
     "precompile": "npm run lint && npm run clean",
     "postcompile": "npm run copy:stubs && npm run index:commands",
-    "compile": "tsc --emitDeclarationOnly --declaration",
+    "compile": "tsc",
     "build": "npm run compile",
     "copy:stubs": "copyfiles \"stubs/**/**/*.stub\" --up=\"1\" build",
     "index:commands": "adonis-kit index build/commands",