@kadirgun/lucid-bravo 0.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,98 @@
+# Lucid Bravo
+
+Lucid Bravo is a fluent query builder for AdonisJS Lucid models. It helps you keep filtering, sorting, relation preloading, and pagination in one place instead of spreading that logic across controllers.
+
+## Installation
+
+```bash
+npm install @kadirgun/lucid-bravo
+```
+
+## Configure
+
+Run the package configure command once in your AdonisJS app:
+
+```bash
+node ace configure @kadirgun/lucid-bravo
+```
+
+This registers the package command so you can generate new Bravo classes with the scaffold command.
+
+## Generate a Bravo class
+
+```bash
+node ace make:bravo User
+```
+
+The command creates a file like `app/bravos/user_bravo.ts` with a ready-to-edit class that extends `LucidBravo`.
+
+## Basic usage
+
+Create a Bravo class for each model and define the allowed sort fields, preload relations, and model-specific filters. The generated scaffold already includes the base-class import, so the example below shows only the parts you normally customize.
+
+```ts
+export default class UserBravo extends LucidBravo<typeof User> {
+  protected defaultLimit = 20
+  protected defaultSort = { field: 'name', order: 'asc' as const }
+
+  public override getSortable(): string[] {
+    return ['id', 'name']
+  }
+
+  public override getAllowedIncludes(): string[] {
+    return ['posts']
+  }
+
+  public async name(value: string) {
+    this.$query.where('name', value)
+  }
+}
+```
+
+Use the class in a controller or service with the query builder and request params:
+
+```ts
+const bravo = new UserBravo(User.query(), {
+  sort: { field: 'name', order: 'asc' },
+  include: ['posts'],
+  limit: 20,
+  page: 1,
+  name: 'Alice',
+})
+
+const users = await bravo.apply()
+const result = await bravo.paginate()
+```
+
+## Query params
+
+Lucid Bravo understands these params out of the box:
+
+- `sort.field` and `sort.order`
+- `limit`
+- `page`
+- `include`
+- any custom filter key that matches a camelCase method on your Bravo class
+
+For example, `first_name` maps to a `firstName()` method.
+
+## Notes
+
+- `LucidBravo` expects to run inside an active HTTP context.
+- Only relations returned by `getAllowedIncludes()` are preloaded.
+- If you want request validation, create a Vine schema in your app that matches the same query shape.
+
+## Authorization
+
+If you need authorization inside a Bravo method or a controller that uses the same HTTP context, you can access Bouncer from `this.$http`:
+
+```ts
+const { bouncer } = this.$http
+
+await bouncer.authorize(viewPosts)
+await bouncer.with(PostsPolicy).authorize('viewAny')
+```
+
+## License
+
+MIT

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/commands/make_bravo.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+export default class MakeBravo extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    name: string;
+    run(): Promise<import("@adonisjs/core/types/app").GeneratedStub>;
+}

package/build/configure.d.ts

@@ -0,0 +1,2 @@
+import type Configure from '@adonisjs/core/commands/configure';
+export declare function configure(_command: Configure): Promise<void>;

package/build/configure.js

@@ -0,0 +1,8 @@
+//#region configure.ts
+async function configure(_command) {
+	await (await _command.createCodemods()).updateRcFile((rcFile) => {
+		rcFile.addCommand("@kadirgun/lucid-bravo/commands");
+	});
+}
+//#endregion
+export { configure };

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export { configure } from './configure.ts';
+export { stubsRoot } from './stubs/main.ts';

package/build/index.js

@@ -0,0 +1,9 @@
+import { configure } from "./configure.js";
+//#region stubs/main.ts
+/**
+* Path to the root directory where the stubs are stored. We use
+* this path within commands and the configure hook
+*/
+const stubsRoot = import.meta.dirname;
+//#endregion
+export { configure, stubsRoot };

package/build/src/lucid_bravo.d.ts

@@ -0,0 +1,48 @@
+import type { LucidModel, ModelAttributes, ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
+import type { BravoParams, BravoSortOption } from './types.ts';
+import { HttpContext } from '@adonisjs/core/http';
+export declare abstract class LucidBravo<T extends LucidModel> {
+    protected $query: ModelQueryBuilderContract<T>;
+    protected $params: BravoParams;
+    protected $http: HttpContext;
+    protected $countQuery: ModelQueryBuilderContract<T>;
+    protected defaultLimit: number;
+    protected defaultSort: BravoSortOption | null;
+    constructor(query: ModelQueryBuilderContract<T>, params: BravoParams);
+    static build<T extends LucidModel, B extends LucidBravo<T>>(this: {
+        new (query: ModelQueryBuilderContract<T>, params: BravoParams): B;
+    }, query: ModelQueryBuilderContract<T>, params: BravoParams): B;
+    /**
+     * Return a whitelist of sortable columns
+     */
+    getSortable(): (keyof ModelAttributes<InstanceType<LucidModel>> | {})[];
+    /**
+     * Return a whitelist of allowed relations for preload include
+     */
+    getAllowedIncludes(): string[];
+    /**
+     * Main entry point to apply all filters, includes, sorting and pagination
+     */
+    apply(): Promise<InstanceType<T>[]>;
+    count(): Promise<number>;
+    paginate(): Promise<{
+        items: InstanceType<T>[];
+        total: number;
+    }>;
+    /**
+     * Automatically call methods that match camelCase version of snake_case params
+     */
+    protected applyFilters(): Promise<void>;
+    /**
+     * Apply preload include relations based on allowlist
+     */
+    protected applyIncludes(): Promise<void>;
+    /**
+     * Apply sorting based on sort[field] and sort[order] params
+     */
+    protected applySorting(): Promise<void>;
+    /**
+     * Apply simple limit and offset pagination
+     */
+    protected applyPagination(): Promise<void>;
+}

package/build/src/types.d.ts

@@ -0,0 +1,15 @@
+export type SortOrder = 'asc' | 'desc';
+export interface BravoSortOption {
+    field: string;
+    order: SortOrder;
+}
+export interface BravoParams {
+    page?: number;
+    limit?: number;
+    sort?: {
+        field?: string;
+        order?: SortOrder;
+    };
+    include?: string[];
+    [key: string]: any;
+}

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/make/bravos/main.stub

@@ -0,0 +1,20 @@
+{{#var modelName = generators.modelName(entity.name)}}
+{{#var modelFileName = generators.modelFileName(entity.name)}}
+{{#var bravoFileName = modelFileName.replace(/\.ts$/, '_bravo.ts')}}
+{{#var modelImportPath = generators.importPath('#models', entity.path, modelFileName.replace(/\.ts$/, ''))}}
+{{{
+  exports({
+    to: app.makePath('app/bravos', entity.path, bravoFileName)
+  })
+}}}
+import { LucidBravo } from '@kadirgun/lucid-bravo'
+import type {{ entity.name }} from '{{ modelImportPath }}'
+import type { ModelAttributes } from '@adonisjs/lucid/types/model'
+
+export default class {{ modelName }}Bravo extends LucidBravo<typeof {{ entity.name }}> {
+  public override getSortable(): string[] {
+    return []
+  }
+
+  protected defaultLimit = 20
+}

package/build/validators/bravo.d.ts

@@ -0,0 +1,60 @@
+export declare const bravoSchema: {
+    sort: import("@vinejs/vine").OptionalModifier<import("@vinejs/vine").VineObject<{
+        field: import("@vinejs/vine").VineString;
+        order: import("@vinejs/vine").VineEnum<readonly ["asc", "desc"]>;
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }>>;
+    limit: import("@vinejs/vine/schema/base/literal").OptionalModifier<import("@vinejs/vine").VineNumber>;
+    page: import("@vinejs/vine/schema/base/literal").OptionalModifier<import("@vinejs/vine").VineNumber>;
+    include: import("@vinejs/vine").OptionalModifier<import("@vinejs/vine").VineArray<import("@vinejs/vine").VineString>>;
+};
+export declare const bravoValidator: import("@vinejs/vine").VineValidator<import("@vinejs/vine").VineObject<{
+    sort: import("@vinejs/vine").OptionalModifier<import("@vinejs/vine").VineObject<{
+        field: import("@vinejs/vine").VineString;
+        order: import("@vinejs/vine").VineEnum<readonly ["asc", "desc"]>;
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }, {
+        field: string;
+        order: "asc" | "desc";
+    }>>;
+    limit: import("@vinejs/vine/schema/base/literal").OptionalModifier<import("@vinejs/vine").VineNumber>;
+    page: import("@vinejs/vine/schema/base/literal").OptionalModifier<import("@vinejs/vine").VineNumber>;
+    include: import("@vinejs/vine").OptionalModifier<import("@vinejs/vine").VineArray<import("@vinejs/vine").VineString>>;
+}, {
+    page?: string | number | null | undefined;
+    limit?: string | number | null | undefined;
+    sort?: {
+        field: string;
+        order: "asc" | "desc";
+    } | null | undefined;
+    include?: string[] | null | undefined;
+}, {
+    page?: number | undefined;
+    limit?: number | undefined;
+    sort?: {
+        field: string;
+        order: "asc" | "desc";
+    } | undefined;
+    include?: string[] | undefined;
+}, {
+    page?: number | undefined;
+    limit?: number | undefined;
+    sort?: {
+        field: string;
+        order: "asc" | "desc";
+    } | undefined;
+    include?: string[] | undefined;
+}>, Record<string, any> | undefined>;

package/package.json

@@ -0,0 +1,134 @@
+{
+  "name": "@kadirgun/lucid-bravo",
+  "description": "A powerful, fluent query builder for AdonisJS Lucid to handle filtering, sorting and pagination in a single flow",
+  "version": "0.0.1",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "type": "module",
+  "files": [
+    "build",
+    "!build/bin",
+    "!build/tests"
+  ],
+  "main": "build/index.js",
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  },
+  "scripts": {
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
+    "pretest": "pnpm lint",
+    "test": "c8 node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
+    "precompile": "pnpm lint",
+    "compile": "tsdown && tsc --emitDeclarationOnly --declaration",
+    "postcompile": "pnpm copy:templates && pnpm index:commands",
+    "build": "pnpm compile",
+    "release": "release-it",
+    "version": "pnpm build",
+    "prepublishOnly": "pnpm build",
+    "index:commands": "adonis-kit index build/commands"
+  },
+  "keywords": [
+    "adonisjs",
+    "lucid",
+    "query builder",
+    "filtering",
+    "sorting",
+    "pagination"
+  ],
+  "author": "kadirgun",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^8.0.0",
+    "@adonisjs/auth": "^10.0.0",
+    "@adonisjs/core": "^7.0.1",
+    "@adonisjs/eslint-config": "^3.0.0",
+    "@adonisjs/lucid": "^22.4.1",
+    "@adonisjs/prettier-config": "^1.4.5",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@japa/assert": "^4.2.0",
+    "@japa/file-system": "^3.0.0",
+    "@japa/runner": "^5.3.0",
+    "@poppinss/ts-exec": "^1.4.4",
+    "@release-it/conventional-changelog": "^10.0.5",
+    "@types/node": "^25.3.5",
+    "@vinejs/vine": "^4.3.0",
+    "better-sqlite3": "^12.8.0",
+    "c8": "^11.0.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^10.1.0",
+    "eslint": "^10.0.3",
+    "luxon": "^3.7.2",
+    "prettier": "^3.8.1",
+    "release-it": "^19.2.4",
+    "tsdown": "^0.21.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@adonisjs/assembler": "^8.0.0",
+    "@adonisjs/core": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/assembler": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "tsdown": {
+    "entry": [
+      "./index.ts",
+      "./configure.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "minify": "dce-only",
+    "fixedExtension": false,
+    "dts": false,
+    "treeshake": false,
+    "sourcemaps": false,
+    "target": "esnext"
+  },
+  "release-it": {
+    "git": {
+      "requireCleanWorkingDir": true,
+      "requireUpstream": true,
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "push": true,
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": true,
+      "skipChecks": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config"
+}