@codenameryuu/adonis-lucid-filter 2.5.0 → 2.7.0

package/README.md

@@ -1,12 +1,6 @@
 # @codenameryuu/adonis-lucid-filter
 
-> Works with Adonis JS V7
-
-[![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
-
-This addon adds the functionality to filter Lucid Models
-
-> Inspired by [EloquentFilter](https://github.com/Tucker-Eric/EloquentFilter)
+This addon adds the functionality to filter Lucid Models Adonis JS 7. Inspired by [EloquentFilter](https://github.com/Tucker-Eric/EloquentFilter)
 
 ## Introduction
 
@@ -27,7 +21,7 @@ Example, we want to return a list of users filtered by multiple parameters. When
 
 To filter by all those parameters we would need to do something like:
 
-```ts
+```typescript
 import type { HttpContext } from '@adonisjs/core/http'
 import User from '#models/user'
 
@@ -52,7 +46,7 @@ export default class UsersController {
 
 To filter that same input with Lucid Filters:
 
-```ts
+```typescript
 import type { HttpContext } from '@adonisjs/core/http'
 import User from '#models/user'
 
@@ -81,7 +75,7 @@ node ace configure @codenameryuu/adonis-lucid-filter
 
 * Register the provider and commands inside `adonisrc.ts` file.
 
-```ts
+```typescript
 providers: [
   // ...
   () => import('@codenameryuu/adonis-lucid-filter/provider'),
@@ -128,7 +122,7 @@ To define methods for the following input:
 
 You would use the following methods:
 
-```ts
+```typescript
 import { BaseModelFilter } from 'adonis-lucid-filter'
 import type { ModelQueryBuilderContract } from '@adonisjs/lucid/types/model'
 import User from '#models/user'
@@ -168,7 +162,7 @@ The `whitelistMethod()` methods can be used to dynamically blacklist methods.
 
 Example:
 
-```ts
+```typescript
 setup($query) {
   this.whitelistMethod('secretMethod')
   this.$query.where('is_admin', true)
@@ -184,7 +178,7 @@ In order to call this method it would need to be whitelisted dynamically:
 
 #### Static properties
 
-```ts
+```typescript
 export default class UserFilter extends BaseModelFilter {
   // Blacklisted methods
   static blacklist: string[] = []
@@ -202,7 +196,7 @@ export default class UserFilter extends BaseModelFilter {
 
 ### Applying The Filter To A Model
 
-```ts
+```typescript
 import UserFilter from '#models/filters/user_filter'
 import { compose } from '@adonisjs/core/helpers'
 import { Filterable } from 'adonis-lucid-filter'
@@ -216,7 +210,7 @@ export default class User extends compose(BaseModel, Filterable) {
 
 This gives you access to the `filter()` method that accepts an object of input:
 
-```ts
+```typescript
 import type { HttpContext } from '@adonisjs/core/http'
 import User from '#models/user'
 
@@ -239,7 +233,7 @@ export default class UsersController {
 You can define the filter dynamically by passing the filter to use as the second parameter of the filter() method.
 Defining a filter dynamically will take precedent over any other filters defined for the model.
 
-```ts
+```typescript
 import type { HttpContext } from '@adonisjs/core/http'
 import AdminFilter from '#models/filters/admin_filter'
 import UserFilter from '#models/filters/user_filter'
@@ -256,7 +250,7 @@ export default class UsersController {
 
 For filtering relations of model may be use `.query().filter()` or scope `filtration` , example:
 
-```ts
+```typescript
 import type { HttpContext } from '@adonisjs/core/http'
 import User from '#models/user'
 
@@ -284,10 +278,3 @@ 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
-
-[npm-image]: https://img.shields.io/npm/v/adonis-lucid-filter?logo=npm&style=for-the-badge
-[npm-url]: https://www.npmjs.com/package/adonis-lucid-filter
-[license-image]: https://img.shields.io/npm/l/adonis-lucid-filter?style=for-the-badge&color=blueviolet
-[license-url]: https://github.com/lookinlab/adonis-lucid-filter/blob/develop/LICENSE.md
-[typescript-image]: https://img.shields.io/npm/types/adonis-lucid-filter?color=294E80&label=%20&logo=typescript&style=for-the-badge
-[typescript-url]: https://github.com/lookinlab

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codenameryuu/adonis-lucid-filter",
   "description": "Addon for filtering Adonis JS 7 Lucid ORM",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "author": "codenameryuu",
   "license": "MIT",
   "homepage": "https://github.com/codenameryuu/adonis-lucid-filter#readme",
@@ -12,7 +12,6 @@
   "engines": {
     "node": ">=24.0.0"
   },
-  "main": "./build/index.js",
   "type": "module",
   "files": [
     "build",
@@ -31,18 +30,17 @@
     "format": "prettier --write .",
     "clean": "del-cli build",
     "precompile": "npm run lint && npm run clean",
-    "postcompile": "npm run copy:stubs && npm run index:commands",
     "compile": "tsup-node && 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",
     "version": "npm run build",
     "prepublishOnly": "npm run build",
-    "release": "np"
+    "release": "np",
+    "quick:test": "NODE_DEBUG=\"adonis-lucid-filter\" node --enable-source-maps --loader=ts-node/esm bin/test.ts",
+    "copy:stubs": "copyfiles \"stubs/**/**/*.stub\" --up=\"1\" build",
+    "index:commands": "adonis-kit index build/commands"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.7.0",
@@ -66,17 +64,15 @@
     "knex": "^3.1.0",
     "lodash": "^4.17.23",
     "luxon": "^3.4.4",
+    "np": "^11.0.2",
     "prettier": "^3.8.1",
     "reflect-metadata": "^0.2.2",
-    "sqlite3": "^5.1.7",
     "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"
@@ -91,9 +87,6 @@
     "adonis-filter",
     "adonis-lucid-filter"
   ],
-  "eslintConfig": {
-    "extends": "@adonisjs/eslint-config/package"
-  },
   "prettier": "@adonisjs/prettier-config",
   "publishConfig": {
     "access": "public",

package/build/commands/commands.json

@@ -1 +0,0 @@
-{"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/main.d.ts

@@ -1,4 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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

@@ -1,20 +0,0 @@
-{{#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)
-  }
-}