@eienjs/adonisjs-api-query 1.1.1 → 3.0.0

package/package.json

@@ -1,60 +1,8 @@
 {
   "name": "@eienjs/adonisjs-api-query",
-  "description": "Easily build Lucid queries from API requests",
-  "version": "1.1.1",
   "type": "module",
-  "module": "./build/index.js",
-  "types": "./build/index.d.ts",
-  "files": [
-    "build",
-    "!build/bin",
-    "!build/tests"
-  ],
-  "exports": {
-    ".": "./build/index.js",
-    "./types": "./build/src/types.js",
-    "./api_query_provider": "./build/providers/api_query_provider.js"
-  },
-  "devDependencies": {
-    "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/core": "^6.17.2",
-    "@adonisjs/lucid": "^21.6.0",
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@japa/assert": "^4.1.1",
-    "@japa/file-system": "^2.3.2",
-    "@japa/runner": "^4.3.0",
-    "@nodecfdi/eslint-config": "^3.5.1",
-    "@nodecfdi/prettier-config": "^1.4.1",
-    "@nodecfdi/tsconfig": "^1.7.4",
-    "@poppinss/hooks": "^7.2.6",
-    "@swc/core": "^1.13.2",
-    "@types/luxon": "^3.6.2",
-    "@types/node": "^22.16.5",
-    "adonis-lucid-soft-deletes": "^2.1.0",
-    "auto-changelog": "^2.5.0",
-    "better-sqlite3": "^12.2.0",
-    "c8": "^10.1.3",
-    "del-cli": "^6.0.0",
-    "enforce-unique": "^1.3.0",
-    "eslint": "^9.31.0",
-    "husky": "^9.1.7",
-    "is-in-ci": "^1.0.0",
-    "luxon": "^3.7.1",
-    "native-copyfiles": "^1.3.5",
-    "np": "^10.2.0",
-    "prettier": "^3.6.2",
-    "ts-node-maintained": "^10.9.5",
-    "tsup": "^8.5.0",
-    "typescript": "^5.8.3"
-  },
-  "dependencies": {
-    "collect.js": "^4.36.1"
-  },
-  "peerDependencies": {
-    "@adonisjs/core": "^6.17.2",
-    "@adonisjs/lucid": "^21.6.0"
-  },
+  "version": "3.0.0",
+  "description": "Easily build Lucid queries from API requests",
   "author": "Fernando Isidro <luffynando@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/eienjs/adonisjs-api-query",
@@ -76,8 +24,64 @@
     "sort",
     "includes"
   ],
+  "exports": {
+    ".": "./build/index.js",
+    "./providers/api_query_provider": "./build/providers/api_query_provider.js",
+    "./types": "./build/types.js",
+    "./package.json": "./package.json"
+  },
+  "types": "build/index.d.ts",
+  "files": [
+    "build"
+  ],
   "engines": {
-    "node": ">=20.6.0"
+    "node": ">=24.0.0"
+  },
+  "peerDependencies": {
+    "@adonisjs/assembler": "^8.4.0",
+    "@adonisjs/core": "^7.3.4",
+    "@adonisjs/lucid": "^22.4.2",
+    "@vinejs/vine": ">=4.4.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/assembler": {
+      "optional": true
+    },
+    "@vinejs/vine": {
+      "optional": true
+    }
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@adonisjs/assembler": "^8.6.0",
+    "@adonisjs/core": "^7.6.0",
+    "@adonisjs/eslint-plugin": "^2.2.2",
+    "@adonisjs/lucid": "^22.4.2",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@commitlint/cli": "^21.2.4",
+    "@commitlint/config-conventional": "^21.2.4",
+    "@eienjs/adonisjs-soft-deletes": "^1.0.1",
+    "@eienjs/eslint-config": "^2.3.1",
+    "@japa/assert": "^4.2.0",
+    "@japa/file-system": "^3.0.0",
+    "@japa/runner": "^5.4.0",
+    "@poppinss/hooks": "^7.3.1",
+    "@poppinss/ts-exec": "^1.5.1",
+    "@types/luxon": "^3.7.6",
+    "@types/node": "^26.6.6",
+    "@vinejs/vine": "^4.4.0",
+    "auto-changelog": "^2.7.0",
+    "better-sqlite3": "^13.0.3",
+    "c8": "^12.0.0",
+    "enforce-unique": "^1.3.0",
+    "eslint": "^10.13.0",
+    "eslint-plugin-erasable-syntax-only": "^0.7.2",
+    "husky": "^9.1.7",
+    "is-in-ci": "^2.0.0",
+    "luxon": "^3.7.2",
+    "release-it": "^21.1.1",
+    "tsdown": "^0.23.3",
+    "typescript": "^6.0.3"
   },
   "c8": {
     "reporter": [
@@ -94,51 +98,60 @@
       "@commitlint/config-conventional"
     ]
   },
-  "prettier": "@nodecfdi/prettier-config/pkg",
   "publishConfig": {
     "access": "public",
     "tag": "latest"
   },
   "auto-changelog": {
     "template": "keepachangelog",
-    "hideCredit": true
+    "hideCredit": true,
+    "commitLimit": false
   },
-  "np": {
-    "message": "chore(release): :tada: %s",
-    "tag": "latest",
-    "branch": "main",
-    "testScript": "test"
-  },
-  "tsup": {
-    "entry": [
-      "index.ts",
-      "src/types.ts",
-      "providers/api_query_provider.ts"
-    ],
-    "outDir": "./build",
-    "clean": true,
-    "format": "esm",
-    "dts": false,
-    "sourcemap": true,
-    "target": "esnext"
+  "release-it": {
+    "git": {
+      "commit": true,
+      "tag": true,
+      "push": true,
+      "requireCleanWorkingDir": true,
+      "commitMessage": "chore(release): :tada: v${version}",
+      "tagAnnotation": "chore(release): :tada: v${version}"
+    },
+    "github": {
+      "release": true,
+      "web": true,
+      "releaseName": "Release v${version}"
+    },
+    "npm": {
+      "publish": true,
+      "publishPackageManager": "pnpm",
+      "publishArgs": [
+        "--no-git-checks"
+      ]
+    },
+    "hooks": {
+      "before:init": [
+        "pnpm run lint:check",
+        "pnpm run typecheck",
+        "pnpm test"
+      ],
+      "after:bump": [
+        "pnpm run build",
+        "pnpm run changelog"
+      ]
+    }
   },
   "scripts": {
-    "clean": "del-cli build",
-    "copy:templates": "copyfiles \"stubs/**/*.stub\" build --up 1",
-    "changelog": "auto-changelog -p && git add CHANGELOG.md",
-    "typecheck": "tsc --noEmit",
+    "changelog": "auto-changelog -u -p",
+    "commitlint": "commitlint --edit",
+    "index:commands": "adonis-kit index build/commands",
     "lint": "eslint . --fix",
     "lint:check": "eslint .",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "test": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
     "test:coverage": "c8 pnpm run test",
-    "tool:code": "pnpm run lint:check && pnpm run format:check && pnpm run typecheck",
+    "tool:code": "pnpm run lint:check && pnpm run typecheck",
     "tool:build": "pnpm run tool:code && pnpm run test",
-    "prebuild": "pnpm run tool:code && pnpm run clean",
-    "build": "tsup-node --metafile && tsc --emitDeclarationOnly --declaration",
-    "postbuild": "pnpm run copy:templates",
-    "release": "np",
-    "version": "pnpm run build && pnpm run changelog"
+    "build": "tsdown",
+    "release": "release-it"
   }
 }

package/build/api_query_request-QXOB4BN6.js

@@ -1,18 +0,0 @@
-import {
-  ApiQueryBuilderRequest
-} from "./chunk-MKQ3HMMA.js";
-
-// src/bindings/api_query_request.ts
-var extendModelQueryBuilderWithRequest = function(builder) {
-  builder.macro("withRequest", function(request) {
-    this.$queryBuilderRequest = ApiQueryBuilderRequest.fromRequest(request);
-    return this;
-  });
-  builder.getter("$apiQueryBuilderRequest", function() {
-    return this.$queryBuilderRequest ?? new ApiQueryBuilderRequest();
-  });
-};
-export {
-  extendModelQueryBuilderWithRequest
-};
-//# sourceMappingURL=api_query_request-QXOB4BN6.js.map

package/build/api_query_request-QXOB4BN6.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/bindings/api_query_request.ts"],"sourcesContent":["import { type Request } from '@adonisjs/core/http';\nimport { type ModelQueryBuilder } from '@adonisjs/lucid/orm';\nimport { ApiQueryBuilderRequest } from '../api_query_builder_request.js';\n\ntype ModelQueryBuilderWithRequest = ModelQueryBuilder & { $queryBuilderRequest?: ApiQueryBuilderRequest };\n\nexport const extendModelQueryBuilderWithRequest = function (builder: typeof ModelQueryBuilder): void {\n  builder.macro('withRequest', function (this: ModelQueryBuilderWithRequest, request: Request) {\n    this.$queryBuilderRequest = ApiQueryBuilderRequest.fromRequest(request);\n\n    return this;\n  });\n\n  builder.getter('$apiQueryBuilderRequest', function (this: ModelQueryBuilderWithRequest) {\n    return this.$queryBuilderRequest ?? new ApiQueryBuilderRequest();\n  });\n};\n"],"mappings":";;;;;AAMO,IAAM,qCAAqC,SAAU,SAAyC;AACnG,UAAQ,MAAM,eAAe,SAA8C,SAAkB;AAC3F,SAAK,uBAAuB,uBAAuB,YAAY,OAAO;AAEtE,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,OAAO,2BAA2B,WAA8C;AACtF,WAAO,KAAK,wBAAwB,IAAI,uBAAuB;AAAA,EACjE,CAAC;AACH;","names":[]}

package/build/chunk-3ITWUZL5.js

@@ -1,108 +0,0 @@
-import {
-  InvalidQuery
-} from "./chunk-XIRHVLVQ.js";
-
-// src/enums/sort_direction.ts
-var SortDirection = {
-  Ascending: "asc",
-  Descending: "desc"
-};
-
-// src/exceptions/invalid_direction.ts
-import { Exception } from "@adonisjs/core/exceptions";
-var InvalidDirection = class _InvalidDirection extends Exception {
-  static make(sort) {
-    return new _InvalidDirection(
-      `The direction should be either \`${SortDirection.Descending}\` or \`${SortDirection.Ascending}\` ${sort} given`
-    );
-  }
-};
-
-// src/sorts/sorts_callback.ts
-var SortsCallback = class {
-  constructor(_callback) {
-    this._callback = _callback;
-  }
-  handle(query, descending, property) {
-    this._callback(query, descending, property);
-  }
-};
-
-// src/sorts/sorts_field.ts
-var SortsField = class {
-  handle(query, descending, property) {
-    void query.orderBy(property, descending ? "desc" : "asc");
-  }
-};
-
-// src/allowed_sort.ts
-var AllowedSort = class _AllowedSort {
-  static parseSortDirection(name) {
-    return name.startsWith("-") ? SortDirection.Descending : SortDirection.Ascending;
-  }
-  static field(name, internalName) {
-    return new _AllowedSort(name, new SortsField(), internalName);
-  }
-  static custom(name, sortClass, internalName) {
-    return new _AllowedSort(name, sortClass, internalName);
-  }
-  static callback(name, callback, internalName) {
-    return new _AllowedSort(name, new SortsCallback(callback), internalName);
-  }
-  defaultDirection;
-  internalName;
-  name;
-  sortClass;
-  constructor(name, sortClass, internalName) {
-    this.name = name.replace(/^-+/, "");
-    this.defaultDirection = _AllowedSort.parseSortDirection(name);
-    this.sortClass = sortClass;
-    this.internalName = internalName ?? this.name;
-  }
-  sort(query, descending) {
-    descending = descending ?? this.defaultDirection === SortDirection.Descending;
-    this.sortClass.handle(query, descending, this.internalName);
-  }
-  getName() {
-    return this.name;
-  }
-  isSort(sortName) {
-    return this.name === sortName;
-  }
-  getInternalName() {
-    return this.internalName;
-  }
-  setDefaultDirection(defaultDirection) {
-    if (![SortDirection.Ascending, SortDirection.Descending].includes(defaultDirection)) {
-      throw InvalidDirection.make(defaultDirection);
-    }
-    this.defaultDirection = defaultDirection;
-    return this;
-  }
-};
-
-// src/exceptions/invalid_sort_query.ts
-import { ResponseStatus } from "@adonisjs/core/http";
-var InvalidSortQuery = class _InvalidSortQuery extends InvalidQuery {
-  constructor(unknownSorts, allowedSorts) {
-    const notAllowed = unknownSorts.join(", ");
-    const allowed = allowedSorts.join(", ");
-    const message = `Requested sort(s) \`${notAllowed}\` is not allowed. Allowed sort(s) are \`${allowed}\``;
-    super(message, { status: ResponseStatus.BadRequest });
-    this.unknownSorts = unknownSorts;
-    this.allowedSorts = allowedSorts;
-  }
-  static sortsNotAllowed(unknownSorts, allowedSorts) {
-    return new _InvalidSortQuery(unknownSorts, allowedSorts);
-  }
-};
-
-export {
-  SortDirection,
-  InvalidDirection,
-  SortsCallback,
-  SortsField,
-  AllowedSort,
-  InvalidSortQuery
-};
-//# sourceMappingURL=chunk-3ITWUZL5.js.map

package/build/chunk-3ITWUZL5.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/enums/sort_direction.ts","../src/exceptions/invalid_direction.ts","../src/sorts/sorts_callback.ts","../src/sorts/sorts_field.ts","../src/allowed_sort.ts","../src/exceptions/invalid_sort_query.ts"],"sourcesContent":["export const SortDirection = {\n  Ascending: 'asc',\n  Descending: 'desc',\n} as const;\n\nexport type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];\n","import { Exception } from '@adonisjs/core/exceptions';\nimport { SortDirection } from '../enums/sort_direction.js';\n\nexport class InvalidDirection extends Exception {\n  public static make(sort: string): InvalidDirection {\n    return new InvalidDirection(\n      `The direction should be either \\`${SortDirection.Descending}\\` or \\`${SortDirection.Ascending}\\` ${sort} given`,\n    );\n  }\n}\n","import { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type Sort } from '../types.js';\n\nexport class SortsCallback<Model extends LucidModel> implements Sort<Model> {\n  public constructor(\n    private readonly _callback: (\n      query: ModelQueryBuilderContract<Model>,\n      descending: boolean,\n      property: string,\n    ) => void,\n  ) {}\n\n  public handle(query: ModelQueryBuilderContract<Model>, descending: boolean, property: string): void {\n    this._callback(query, descending, property);\n  }\n}\n","import { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type Sort } from '../types.js';\n\nexport class SortsField<Model extends LucidModel> implements Sort<Model> {\n  public handle(query: ModelQueryBuilderContract<Model>, descending: boolean, property: string): void {\n    void query.orderBy(property, descending ? 'desc' : 'asc');\n  }\n}\n","import { type LucidModel, type ModelAttributes, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { SortDirection } from './enums/sort_direction.js';\nimport { InvalidDirection } from './exceptions/invalid_direction.js';\nimport { SortsCallback } from './sorts/sorts_callback.js';\nimport { SortsField } from './sorts/sorts_field.js';\nimport { type ExtractKeys, type Sort } from './types.js';\n\nexport class AllowedSort<Model extends LucidModel> {\n  public static parseSortDirection(name: string): string {\n    return name.startsWith('-') ? SortDirection.Descending : SortDirection.Ascending;\n  }\n\n  public static field<Model extends LucidModel>(\n    name: string,\n    internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>,\n  ): AllowedSort<Model> {\n    return new AllowedSort<Model>(name, new SortsField<Model>(), internalName);\n  }\n\n  public static custom<Model extends LucidModel>(\n    name: string,\n    sortClass: Sort<Model>,\n    internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>,\n  ): AllowedSort<Model> {\n    return new AllowedSort<Model>(name, sortClass, internalName);\n  }\n\n  public static callback<Model extends LucidModel>(\n    name: string,\n    callback: (query: ModelQueryBuilderContract<Model>, descending: boolean, property: string) => void,\n    internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>,\n  ): AllowedSort<Model> {\n    return new AllowedSort<Model>(name, new SortsCallback<Model>(callback), internalName);\n  }\n\n  protected defaultDirection: string;\n\n  protected internalName: string;\n\n  protected name: string;\n\n  protected sortClass: Sort<Model>;\n\n  public constructor(\n    name: string,\n    sortClass: Sort<Model>,\n    internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>,\n  ) {\n    this.name = name.replace(/^-+/, '');\n    this.defaultDirection = AllowedSort.parseSortDirection(name);\n    this.sortClass = sortClass;\n    this.internalName = internalName ?? this.name;\n  }\n\n  public sort(query: ModelQueryBuilderContract<Model>, descending?: boolean): void {\n    descending = descending ?? this.defaultDirection === SortDirection.Descending;\n\n    this.sortClass.handle(query, descending, this.internalName);\n  }\n\n  public getName(): string {\n    return this.name;\n  }\n\n  public isSort(sortName: string): boolean {\n    return this.name === sortName;\n  }\n\n  public getInternalName(): string {\n    return this.internalName;\n  }\n\n  public setDefaultDirection(defaultDirection: string): this {\n    if (!([SortDirection.Ascending, SortDirection.Descending] as string[]).includes(defaultDirection)) {\n      throw InvalidDirection.make(defaultDirection);\n    }\n\n    this.defaultDirection = defaultDirection;\n\n    return this;\n  }\n}\n","import { ResponseStatus } from '@adonisjs/core/http';\nimport { InvalidQuery } from './invalid_query.js';\n\nexport class InvalidSortQuery extends InvalidQuery {\n  public constructor(\n    public readonly unknownSorts: string[],\n    public readonly allowedSorts: string[],\n  ) {\n    const notAllowed = unknownSorts.join(', ');\n    const allowed = allowedSorts.join(', ');\n    const message = `Requested sort(s) \\`${notAllowed}\\` is not allowed. Allowed sort(s) are \\`${allowed}\\``;\n\n    super(message, { status: ResponseStatus.BadRequest });\n  }\n\n  public static sortsNotAllowed(unknownSorts: string[], allowedSorts: string[]): InvalidSortQuery {\n    return new InvalidSortQuery(unknownSorts, allowedSorts);\n  }\n}\n"],"mappings":";;;;;AAAO,IAAM,gBAAgB;AAAA,EAC3B,WAAW;AAAA,EACX,YAAY;AACd;;;ACHA,SAAS,iBAAiB;AAGnB,IAAM,mBAAN,MAAM,0BAAyB,UAAU;AAAA,EAC9C,OAAc,KAAK,MAAgC;AACjD,WAAO,IAAI;AAAA,MACT,oCAAoC,cAAc,UAAU,WAAW,cAAc,SAAS,MAAM,IAAI;AAAA,IAC1G;AAAA,EACF;AACF;;;ACNO,IAAM,gBAAN,MAAqE;AAAA,EACnE,YACY,WAKjB;AALiB;AAAA,EAKhB;AAAA,EAEI,OAAO,OAAyC,YAAqB,UAAwB;AAClG,SAAK,UAAU,OAAO,YAAY,QAAQ;AAAA,EAC5C;AACF;;;ACZO,IAAM,aAAN,MAAkE;AAAA,EAChE,OAAO,OAAyC,YAAqB,UAAwB;AAClG,SAAK,MAAM,QAAQ,UAAU,aAAa,SAAS,KAAK;AAAA,EAC1D;AACF;;;ACAO,IAAM,cAAN,MAAM,aAAsC;AAAA,EACjD,OAAc,mBAAmB,MAAsB;AACrD,WAAO,KAAK,WAAW,GAAG,IAAI,cAAc,aAAa,cAAc;AAAA,EACzE;AAAA,EAEA,OAAc,MACZ,MACA,cACoB;AACpB,WAAO,IAAI,aAAmB,MAAM,IAAI,WAAkB,GAAG,YAAY;AAAA,EAC3E;AAAA,EAEA,OAAc,OACZ,MACA,WACA,cACoB;AACpB,WAAO,IAAI,aAAmB,MAAM,WAAW,YAAY;AAAA,EAC7D;AAAA,EAEA,OAAc,SACZ,MACA,UACA,cACoB;AACpB,WAAO,IAAI,aAAmB,MAAM,IAAI,cAAqB,QAAQ,GAAG,YAAY;AAAA,EACtF;AAAA,EAEU;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEH,YACL,MACA,WACA,cACA;AACA,SAAK,OAAO,KAAK,QAAQ,OAAO,EAAE;AAClC,SAAK,mBAAmB,aAAY,mBAAmB,IAAI;AAC3D,SAAK,YAAY;AACjB,SAAK,eAAe,gBAAgB,KAAK;AAAA,EAC3C;AAAA,EAEO,KAAK,OAAyC,YAA4B;AAC/E,iBAAa,cAAc,KAAK,qBAAqB,cAAc;AAEnE,SAAK,UAAU,OAAO,OAAO,YAAY,KAAK,YAAY;AAAA,EAC5D;AAAA,EAEO,UAAkB;AACvB,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,OAAO,UAA2B;AACvC,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEO,kBAA0B;AAC/B,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,oBAAoB,kBAAgC;AACzD,QAAI,CAAE,CAAC,cAAc,WAAW,cAAc,UAAU,EAAe,SAAS,gBAAgB,GAAG;AACjG,YAAM,iBAAiB,KAAK,gBAAgB;AAAA,IAC9C;AAEA,SAAK,mBAAmB;AAExB,WAAO;AAAA,EACT;AACF;;;ACjFA,SAAS,sBAAsB;AAGxB,IAAM,mBAAN,MAAM,0BAAyB,aAAa;AAAA,EAC1C,YACW,cACA,cAChB;AACA,UAAM,aAAa,aAAa,KAAK,IAAI;AACzC,UAAM,UAAU,aAAa,KAAK,IAAI;AACtC,UAAM,UAAU,uBAAuB,UAAU,4CAA4C,OAAO;AAEpG,UAAM,SAAS,EAAE,QAAQ,eAAe,WAAW,CAAC;AAPpC;AACA;AAAA,EAOlB;AAAA,EAEA,OAAc,gBAAgB,cAAwB,cAA0C;AAC9F,WAAO,IAAI,kBAAiB,cAAc,YAAY;AAAA,EACxD;AACF;","names":[]}