@eienjs/adonisjs-api-query 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License
+
+Copyright (c) 2025 - EienJS
+
+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 NON INFRINGEMENT. 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,43 @@
+# @eienjs/adonisjs-api-query
+
+[![Source Code][badge-source]][source]
+[![Npm Node Version Support][badge-node-version]][node-version]
+[![Latest Version][badge-release]][release]
+[![Software License][badge-license]][license]
+[![Build Status][badge-build]][build]
+[![Total Downloads][badge-downloads]][downloads]
+
+<!-- [![Build Status][badge-build]][build] -->
+
+> Easily build Lucid queries from API requests
+
+## Introduction
+
+This package provides a set of macros on `ModelQueryBuilder` to build [Lucid](https://adonisjs.com/docs/lucid) queries from API requests. Inspired by [Spatie's Laravel Query Builder](https://github.com/spatie/laravel-query-builder).
+
+## Documentation
+
+The documentation is available on [EienJS](https://eienjs.com).
+
+## Contributing
+
+Contributions are welcome. Please read [CONTRIBUTING][] for more details and remember to check the [CHANGELOG][] file.
+
+## Copyright and License
+
+The `@eienjs/adonisjs-api-query` library is licensed for use under the MIT License (MIT). Please see [LICENSE][] for more information.
+
+[contributing]: https://github.com/eienjs/.github/blob/main/docs/CONTRIBUTING.md
+[changelog]: https://github.com/eienjs/adonisjs-api-query/blob/main/CHANGELOG.md
+[source]: https://github.com/eienjs/adonisjs-api-query
+[node-version]: https://www.npmjs.com/package/@eienjs/adonisjs-api-query
+[release]: https://www.npmjs.com/package/@eienjs/adonisjs-api-query
+[license]: https://github.com/eienjs/adonisjs-api-query/blob/main/LICENSE.md
+[build]: https://github.com/eienjs/adonisjs-api-query/actions/workflows/build.yml?query=branch:main
+[downloads]: https://www.npmjs.com/package/@eienjs/adonisjs-api-query
+[badge-source]: https://img.shields.io/badge/source-eienjs/adonisjs--api--query-blue.svg?logo=github
+[badge-node-version]: https://img.shields.io/node/v/@eienjs/adonisjs-api-query.svg?logo=nodedotjs
+[badge-release]: https://img.shields.io/npm/v/@eienjs/adonisjs-api-query.svg?logo=npm
+[badge-license]: https://img.shields.io/github/license/eienjs/adonisjs-api-query?logo=open-source-initiative
+[badge-build]: https://img.shields.io/github/actions/workflow/status/eienjs/adonisjs-api-query/build.yml?branch=main
+[badge-downloads]: https://img.shields.io/npm/dm/@eienjs/adonisjs-api-query.svg?logo=npm

package/build/api_query_request-QXOB4BN6.js

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

@@ -0,0 +1 @@
+{"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-HQN7LHVO.js

@@ -0,0 +1,106 @@
+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,
+  AllowedSort,
+  InvalidSortQuery
+};
+//# sourceMappingURL=chunk-HQN7LHVO.js.map

package/build/chunk-HQN7LHVO.js.map

@@ -0,0 +1 @@
+{"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":[]}

package/build/chunk-MKQ3HMMA.js

@@ -0,0 +1,198 @@
+// src/api_query_builder_request.ts
+import { HttpContext } from "@adonisjs/core/http";
+import app from "@adonisjs/core/services/app";
+import { Collection } from "collect.js";
+
+// src/utils/helpers.ts
+var substrReplace = (str, replace, start, length) => {
+  if (start < 0) {
+    start += str.length;
+  }
+  length = length ?? str.length;
+  if (length < 0) {
+    length = length + str.length - start;
+  }
+  return [
+    str.slice(0, start),
+    replace.slice(0, Math.max(0, length)),
+    replace.slice(length),
+    str.slice(start + length)
+  ].join("");
+};
+var strBeforeLast = (subject, search) => {
+  if (search === "") {
+    return subject;
+  }
+  const pos = subject.lastIndexOf(search);
+  if (pos === -1) {
+    return subject;
+  }
+  return subject.slice(0, Math.max(0, pos));
+};
+var strAfterLast = (subject, search) => {
+  if (search === "") {
+    return subject;
+  }
+  const pos = subject.lastIndexOf(search);
+  if (pos === -1) {
+    return subject;
+  }
+  return subject.slice(pos + search.length);
+};
+
+// src/api_query_builder_request.ts
+var ApiQueryBuilderRequest = class _ApiQueryBuilderRequest {
+  static includesArrayValueDelimiter = ",";
+  static appendsArrayValueDelimiter = ",";
+  static fieldsArrayValueDelimiter = ",";
+  static sortsArrayValueDelimiter = ",";
+  static filterArrayValueDelimiter = ",";
+  static setArrayValueDelimiter(delimiter) {
+    this.includesArrayValueDelimiter = delimiter;
+    this.appendsArrayValueDelimiter = delimiter;
+    this.fieldsArrayValueDelimiter = delimiter;
+    this.sortsArrayValueDelimiter = delimiter;
+    this.filterArrayValueDelimiter = delimiter;
+  }
+  static setIncludesArrayValueDelimiter(includesArrayValueDelimiter) {
+    this.includesArrayValueDelimiter = includesArrayValueDelimiter;
+  }
+  static setAppendsArrayValueDelimiter(appendsArrayValueDelimiter) {
+    this.appendsArrayValueDelimiter = appendsArrayValueDelimiter;
+  }
+  static setFieldsArrayValueDelimiter(fieldsArrayValueDelimiter) {
+    this.fieldsArrayValueDelimiter = fieldsArrayValueDelimiter;
+  }
+  static setSortsArrayValueDelimiter(sortsArrayValueDelimiter) {
+    this.sortsArrayValueDelimiter = sortsArrayValueDelimiter;
+  }
+  static setFilterArrayValueDelimiter(filterArrayValueDelimiter) {
+    this.filterArrayValueDelimiter = filterArrayValueDelimiter;
+  }
+  static getIncludesArrayValueDelimiter() {
+    return this.includesArrayValueDelimiter;
+  }
+  static getAppendsArrayValueDelimiter() {
+    return this.appendsArrayValueDelimiter;
+  }
+  static getFieldsArrayValueDelimiter() {
+    return this.fieldsArrayValueDelimiter;
+  }
+  static getSortsArrayValueDelimiter() {
+    return this.sortsArrayValueDelimiter;
+  }
+  static getFilterArrayValueDelimiter() {
+    return this.filterArrayValueDelimiter;
+  }
+  static resetDelimiters() {
+    this.includesArrayValueDelimiter = ",";
+    this.appendsArrayValueDelimiter = ",";
+    this.fieldsArrayValueDelimiter = ",";
+    this.sortsArrayValueDelimiter = ",";
+    this.filterArrayValueDelimiter = ",";
+  }
+  static fromRequest(request) {
+    return new _ApiQueryBuilderRequest(request);
+  }
+  _request;
+  constructor(request) {
+    if (!request) {
+      const ctx = HttpContext.getOrFail();
+      request = ctx.request;
+    }
+    this._request = request;
+  }
+  includes() {
+    const includeParameterName = app.config.get("apiquery.parameters.include", "include");
+    let includeParts = this.getRequestData(includeParameterName, []);
+    if (typeof includeParts === "string") {
+      includeParts = includeParts.split(_ApiQueryBuilderRequest.getIncludesArrayValueDelimiter());
+    }
+    return new Collection(includeParts).filter();
+  }
+  appends() {
+    const appendParameterName = app.config.get("apiquery.parameters.append", "append");
+    let appendParts = this.getRequestData(appendParameterName, {});
+    if (typeof appendParts === "string") {
+      appendParts = appendParts.split(_ApiQueryBuilderRequest.getAppendsArrayValueDelimiter());
+    }
+    return new Collection(appendParts).filter();
+  }
+  fields() {
+    const fieldsParameterName = app.config.get("apiquery.parameters.fields", "fields");
+    const fieldsData = this.getRequestData(fieldsParameterName, {});
+    const fieldsPerTable = new Collection(
+      typeof fieldsData === "string" ? fieldsData.split(_ApiQueryBuilderRequest.getFieldsArrayValueDelimiter()) : fieldsData
+    );
+    if (fieldsPerTable.isEmpty()) {
+      return new Collection();
+    }
+    const fields = {};
+    fieldsPerTable.each((tableFields, model) => {
+      if (!model || typeof model === "number") {
+        model = typeof tableFields === "string" && tableFields.includes(".") ? strBeforeLast(tableFields, ".") : "_";
+      }
+      if (!fields[model]) {
+        fields[model] = [];
+      }
+      if (typeof tableFields === "string") {
+        tableFields = tableFields.split(_ApiQueryBuilderRequest.getFieldsArrayValueDelimiter()).map((field) => {
+          return strAfterLast(field, ".");
+        });
+      }
+      fields[model] = [...fields[model], ...tableFields];
+    });
+    return new Collection(fields);
+  }
+  sorts() {
+    const sortParameterName = app.config.get("apiquery.parameters.sort", "sort");
+    let sortParts = this.getRequestData(sortParameterName, []);
+    if (typeof sortParts === "string") {
+      sortParts = sortParts.split(_ApiQueryBuilderRequest.getSortsArrayValueDelimiter());
+    }
+    return new Collection(sortParts).filter();
+  }
+  filters() {
+    const filterParameterName = app.config.get("apiquery.parameters.filter", "filter");
+    const filterParts = this.getRequestData(filterParameterName, []);
+    if (typeof filterParts === "string") {
+      return new Collection();
+    }
+    const filters = new Collection(filterParts);
+    return filters.map((value) => {
+      return this.getFilterValue(value);
+    });
+  }
+  getFilterValue(value) {
+    if (value === void 0 || value === null) {
+      return null;
+    }
+    if (value === "" || Array.isArray(value) && value.length === 0 || typeof value === "object" && Object.keys(value).length === 0) {
+      return typeof value === "object" ? [] : value;
+    }
+    if (Array.isArray(value) || typeof value === "object") {
+      return new Collection(value).map((valueValue) => {
+        return this.getFilterValue(valueValue);
+      }).all();
+    }
+    if (typeof value === "string" && value.includes(_ApiQueryBuilderRequest.getFilterArrayValueDelimiter())) {
+      return value.split(_ApiQueryBuilderRequest.getFilterArrayValueDelimiter());
+    }
+    if (value === "true") {
+      return true;
+    }
+    if (value === "false") {
+      return false;
+    }
+    return value;
+  }
+  getRequestData(key, defaultValue) {
+    return this._request.input(key, defaultValue);
+  }
+};
+
+export {
+  substrReplace,
+  ApiQueryBuilderRequest
+};
+//# sourceMappingURL=chunk-MKQ3HMMA.js.map

package/build/chunk-MKQ3HMMA.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/api_query_builder_request.ts","../src/utils/helpers.ts"],"sourcesContent":["import { HttpContext, type Request } from '@adonisjs/core/http';\nimport app from '@adonisjs/core/services/app';\nimport { Collection } from 'collect.js';\nimport { strAfterLast, strBeforeLast } from './utils/helpers.js';\n\nexport class ApiQueryBuilderRequest {\n  protected static includesArrayValueDelimiter = ',';\n\n  protected static appendsArrayValueDelimiter = ',';\n\n  protected static fieldsArrayValueDelimiter = ',';\n\n  protected static sortsArrayValueDelimiter = ',';\n\n  protected static filterArrayValueDelimiter = ',';\n\n  public static setArrayValueDelimiter(delimiter: string): void {\n    this.includesArrayValueDelimiter = delimiter;\n    this.appendsArrayValueDelimiter = delimiter;\n    this.fieldsArrayValueDelimiter = delimiter;\n    this.sortsArrayValueDelimiter = delimiter;\n    this.filterArrayValueDelimiter = delimiter;\n  }\n\n  public static setIncludesArrayValueDelimiter(includesArrayValueDelimiter: string): void {\n    this.includesArrayValueDelimiter = includesArrayValueDelimiter;\n  }\n\n  public static setAppendsArrayValueDelimiter(appendsArrayValueDelimiter: string): void {\n    this.appendsArrayValueDelimiter = appendsArrayValueDelimiter;\n  }\n\n  public static setFieldsArrayValueDelimiter(fieldsArrayValueDelimiter: string): void {\n    this.fieldsArrayValueDelimiter = fieldsArrayValueDelimiter;\n  }\n\n  public static setSortsArrayValueDelimiter(sortsArrayValueDelimiter: string): void {\n    this.sortsArrayValueDelimiter = sortsArrayValueDelimiter;\n  }\n\n  public static setFilterArrayValueDelimiter(filterArrayValueDelimiter: string): void {\n    this.filterArrayValueDelimiter = filterArrayValueDelimiter;\n  }\n\n  public static getIncludesArrayValueDelimiter(): string {\n    return this.includesArrayValueDelimiter;\n  }\n\n  public static getAppendsArrayValueDelimiter(): string {\n    return this.appendsArrayValueDelimiter;\n  }\n\n  public static getFieldsArrayValueDelimiter(): string {\n    return this.fieldsArrayValueDelimiter;\n  }\n\n  public static getSortsArrayValueDelimiter(): string {\n    return this.sortsArrayValueDelimiter;\n  }\n\n  public static getFilterArrayValueDelimiter(): string {\n    return this.filterArrayValueDelimiter;\n  }\n\n  public static resetDelimiters(): void {\n    this.includesArrayValueDelimiter = ',';\n    this.appendsArrayValueDelimiter = ',';\n    this.fieldsArrayValueDelimiter = ',';\n    this.sortsArrayValueDelimiter = ',';\n    this.filterArrayValueDelimiter = ',';\n  }\n\n  public static fromRequest(request: Request): ApiQueryBuilderRequest {\n    return new ApiQueryBuilderRequest(request);\n  }\n\n  private readonly _request: Request;\n\n  public constructor(request?: Request) {\n    if (!request) {\n      const ctx = HttpContext.getOrFail();\n      request = ctx.request;\n    }\n\n    this._request = request;\n  }\n\n  public includes(): Collection<string> {\n    const includeParameterName = app.config.get<string>('apiquery.parameters.include', 'include');\n    let includeParts = this.getRequestData<string[] | string>(includeParameterName, []);\n\n    if (typeof includeParts === 'string') {\n      includeParts = includeParts.split(ApiQueryBuilderRequest.getIncludesArrayValueDelimiter());\n    }\n\n    return new Collection(includeParts).filter();\n  }\n\n  public appends(): Collection<unknown> {\n    const appendParameterName = app.config.get<string>('apiquery.parameters.append', 'append');\n\n    let appendParts = this.getRequestData(appendParameterName, {});\n\n    if (typeof appendParts === 'string') {\n      appendParts = appendParts.split(ApiQueryBuilderRequest.getAppendsArrayValueDelimiter());\n    }\n\n    return new Collection(appendParts).filter();\n  }\n\n  public fields(): Collection<unknown> {\n    const fieldsParameterName = app.config.get<string>('apiquery.parameters.fields', 'fields');\n    const fieldsData = this.getRequestData(fieldsParameterName, {});\n    const fieldsPerTable = new Collection(\n      typeof fieldsData === 'string'\n        ? fieldsData.split(ApiQueryBuilderRequest.getFieldsArrayValueDelimiter())\n        : fieldsData,\n    );\n\n    if (fieldsPerTable.isEmpty()) {\n      return new Collection();\n    }\n\n    const fields: Record<string, unknown> = {};\n    fieldsPerTable.each((tableFields, model) => {\n      if (!model || typeof model === 'number') {\n        model = typeof tableFields === 'string' && tableFields.includes('.') ? strBeforeLast(tableFields, '.') : '_';\n      }\n\n      if (!fields[model]) {\n        fields[model] = [];\n      }\n\n      if (typeof tableFields === 'string') {\n        tableFields = tableFields.split(ApiQueryBuilderRequest.getFieldsArrayValueDelimiter()).map((field) => {\n          return strAfterLast(field, '.');\n        });\n      }\n\n      fields[model] = [...(fields[model] as string[]), ...(tableFields as string[])];\n    });\n\n    return new Collection(fields);\n  }\n\n  public sorts(): Collection<string> {\n    const sortParameterName = app.config.get<string>('apiquery.parameters.sort', 'sort');\n\n    let sortParts = this.getRequestData<string[] | string>(sortParameterName, []);\n\n    if (typeof sortParts === 'string') {\n      sortParts = sortParts.split(ApiQueryBuilderRequest.getSortsArrayValueDelimiter());\n    }\n\n    return new Collection<string>(sortParts).filter();\n  }\n\n  public filters(): Collection<unknown> {\n    const filterParameterName = app.config.get<string>('apiquery.parameters.filter', 'filter');\n\n    const filterParts = this.getRequestData(filterParameterName, []);\n\n    if (typeof filterParts === 'string') {\n      return new Collection();\n    }\n\n    const filters = new Collection(filterParts);\n\n    return filters.map((value) => {\n      return this.getFilterValue(value);\n    });\n  }\n\n  protected getFilterValue(value: unknown): unknown {\n    if (value === undefined || value === null) {\n      return null;\n    }\n\n    if (\n      value === '' ||\n      (Array.isArray(value) && value.length === 0) ||\n      (typeof value === 'object' && Object.keys(value).length === 0)\n    ) {\n      return typeof value === 'object' ? [] : value;\n    }\n\n    if (Array.isArray(value) || typeof value === 'object') {\n      return new Collection(value)\n        .map((valueValue) => {\n          return this.getFilterValue(valueValue);\n        })\n        .all();\n    }\n\n    if (typeof value === 'string' && value.includes(ApiQueryBuilderRequest.getFilterArrayValueDelimiter())) {\n      return value.split(ApiQueryBuilderRequest.getFilterArrayValueDelimiter());\n    }\n\n    if (value === 'true') {\n      return true;\n    }\n\n    if (value === 'false') {\n      return false;\n    }\n\n    return value;\n  }\n\n  protected getRequestData<T = unknown>(key: string, defaultValue?: T): T {\n    return this._request.input(key, defaultValue) as T;\n  }\n}\n","export const substrReplace = (str: string, replace: string, start: number, length?: number): string => {\n  if (start < 0) {\n    start += str.length;\n  }\n\n  length = length ?? str.length;\n  if (length < 0) {\n    length = length + str.length - start;\n  }\n\n  return [\n    str.slice(0, start),\n    replace.slice(0, Math.max(0, length)),\n    replace.slice(length),\n    str.slice(start + length),\n  ].join('');\n};\n\nexport const strBeforeLast = (subject: string, search: string): string => {\n  if (search === '') {\n    return subject;\n  }\n\n  const pos = subject.lastIndexOf(search);\n\n  if (pos === -1) {\n    return subject;\n  }\n\n  return subject.slice(0, Math.max(0, pos));\n};\n\nexport const strAfterLast = (subject: string, search: string): string => {\n  if (search === '') {\n    return subject;\n  }\n\n  const pos = subject.lastIndexOf(search);\n\n  if (pos === -1) {\n    return subject;\n  }\n\n  return subject.slice(pos + search.length);\n};\n"],"mappings":";AAAA,SAAS,mBAAiC;AAC1C,OAAO,SAAS;AAChB,SAAS,kBAAkB;;;ACFpB,IAAM,gBAAgB,CAAC,KAAa,SAAiB,OAAe,WAA4B;AACrG,MAAI,QAAQ,GAAG;AACb,aAAS,IAAI;AAAA,EACf;AAEA,WAAS,UAAU,IAAI;AACvB,MAAI,SAAS,GAAG;AACd,aAAS,SAAS,IAAI,SAAS;AAAA,EACjC;AAEA,SAAO;AAAA,IACL,IAAI,MAAM,GAAG,KAAK;AAAA,IAClB,QAAQ,MAAM,GAAG,KAAK,IAAI,GAAG,MAAM,CAAC;AAAA,IACpC,QAAQ,MAAM,MAAM;AAAA,IACpB,IAAI,MAAM,QAAQ,MAAM;AAAA,EAC1B,EAAE,KAAK,EAAE;AACX;AAEO,IAAM,gBAAgB,CAAC,SAAiB,WAA2B;AACxE,MAAI,WAAW,IAAI;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,QAAQ,YAAY,MAAM;AAEtC,MAAI,QAAQ,IAAI;AACd,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,MAAM,GAAG,KAAK,IAAI,GAAG,GAAG,CAAC;AAC1C;AAEO,IAAM,eAAe,CAAC,SAAiB,WAA2B;AACvE,MAAI,WAAW,IAAI;AACjB,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,QAAQ,YAAY,MAAM;AAEtC,MAAI,QAAQ,IAAI;AACd,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,MAAM,MAAM,OAAO,MAAM;AAC1C;;;ADvCO,IAAM,yBAAN,MAAM,wBAAuB;AAAA,EAClC,OAAiB,8BAA8B;AAAA,EAE/C,OAAiB,6BAA6B;AAAA,EAE9C,OAAiB,4BAA4B;AAAA,EAE7C,OAAiB,2BAA2B;AAAA,EAE5C,OAAiB,4BAA4B;AAAA,EAE7C,OAAc,uBAAuB,WAAyB;AAC5D,SAAK,8BAA8B;AACnC,SAAK,6BAA6B;AAClC,SAAK,4BAA4B;AACjC,SAAK,2BAA2B;AAChC,SAAK,4BAA4B;AAAA,EACnC;AAAA,EAEA,OAAc,+BAA+B,6BAA2C;AACtF,SAAK,8BAA8B;AAAA,EACrC;AAAA,EAEA,OAAc,8BAA8B,4BAA0C;AACpF,SAAK,6BAA6B;AAAA,EACpC;AAAA,EAEA,OAAc,6BAA6B,2BAAyC;AAClF,SAAK,4BAA4B;AAAA,EACnC;AAAA,EAEA,OAAc,4BAA4B,0BAAwC;AAChF,SAAK,2BAA2B;AAAA,EAClC;AAAA,EAEA,OAAc,6BAA6B,2BAAyC;AAClF,SAAK,4BAA4B;AAAA,EACnC;AAAA,EAEA,OAAc,iCAAyC;AACrD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAc,gCAAwC;AACpD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAc,+BAAuC;AACnD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAc,8BAAsC;AAClD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAc,+BAAuC;AACnD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAc,kBAAwB;AACpC,SAAK,8BAA8B;AACnC,SAAK,6BAA6B;AAClC,SAAK,4BAA4B;AACjC,SAAK,2BAA2B;AAChC,SAAK,4BAA4B;AAAA,EACnC;AAAA,EAEA,OAAc,YAAY,SAA0C;AAClE,WAAO,IAAI,wBAAuB,OAAO;AAAA,EAC3C;AAAA,EAEiB;AAAA,EAEV,YAAY,SAAmB;AACpC,QAAI,CAAC,SAAS;AACZ,YAAM,MAAM,YAAY,UAAU;AAClC,gBAAU,IAAI;AAAA,IAChB;AAEA,SAAK,WAAW;AAAA,EAClB;AAAA,EAEO,WAA+B;AACpC,UAAM,uBAAuB,IAAI,OAAO,IAAY,+BAA+B,SAAS;AAC5F,QAAI,eAAe,KAAK,eAAkC,sBAAsB,CAAC,CAAC;AAElF,QAAI,OAAO,iBAAiB,UAAU;AACpC,qBAAe,aAAa,MAAM,wBAAuB,+BAA+B,CAAC;AAAA,IAC3F;AAEA,WAAO,IAAI,WAAW,YAAY,EAAE,OAAO;AAAA,EAC7C;AAAA,EAEO,UAA+B;AACpC,UAAM,sBAAsB,IAAI,OAAO,IAAY,8BAA8B,QAAQ;AAEzF,QAAI,cAAc,KAAK,eAAe,qBAAqB,CAAC,CAAC;AAE7D,QAAI,OAAO,gBAAgB,UAAU;AACnC,oBAAc,YAAY,MAAM,wBAAuB,8BAA8B,CAAC;AAAA,IACxF;AAEA,WAAO,IAAI,WAAW,WAAW,EAAE,OAAO;AAAA,EAC5C;AAAA,EAEO,SAA8B;AACnC,UAAM,sBAAsB,IAAI,OAAO,IAAY,8BAA8B,QAAQ;AACzF,UAAM,aAAa,KAAK,eAAe,qBAAqB,CAAC,CAAC;AAC9D,UAAM,iBAAiB,IAAI;AAAA,MACzB,OAAO,eAAe,WAClB,WAAW,MAAM,wBAAuB,6BAA6B,CAAC,IACtE;AAAA,IACN;AAEA,QAAI,eAAe,QAAQ,GAAG;AAC5B,aAAO,IAAI,WAAW;AAAA,IACxB;AAEA,UAAM,SAAkC,CAAC;AACzC,mBAAe,KAAK,CAAC,aAAa,UAAU;AAC1C,UAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,gBAAQ,OAAO,gBAAgB,YAAY,YAAY,SAAS,GAAG,IAAI,cAAc,aAAa,GAAG,IAAI;AAAA,MAC3G;AAEA,UAAI,CAAC,OAAO,KAAK,GAAG;AAClB,eAAO,KAAK,IAAI,CAAC;AAAA,MACnB;AAEA,UAAI,OAAO,gBAAgB,UAAU;AACnC,sBAAc,YAAY,MAAM,wBAAuB,6BAA6B,CAAC,EAAE,IAAI,CAAC,UAAU;AACpG,iBAAO,aAAa,OAAO,GAAG;AAAA,QAChC,CAAC;AAAA,MACH;AAEA,aAAO,KAAK,IAAI,CAAC,GAAI,OAAO,KAAK,GAAgB,GAAI,WAAwB;AAAA,IAC/E,CAAC;AAED,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAAA,EAEO,QAA4B;AACjC,UAAM,oBAAoB,IAAI,OAAO,IAAY,4BAA4B,MAAM;AAEnF,QAAI,YAAY,KAAK,eAAkC,mBAAmB,CAAC,CAAC;AAE5E,QAAI,OAAO,cAAc,UAAU;AACjC,kBAAY,UAAU,MAAM,wBAAuB,4BAA4B,CAAC;AAAA,IAClF;AAEA,WAAO,IAAI,WAAmB,SAAS,EAAE,OAAO;AAAA,EAClD;AAAA,EAEO,UAA+B;AACpC,UAAM,sBAAsB,IAAI,OAAO,IAAY,8BAA8B,QAAQ;AAEzF,UAAM,cAAc,KAAK,eAAe,qBAAqB,CAAC,CAAC;AAE/D,QAAI,OAAO,gBAAgB,UAAU;AACnC,aAAO,IAAI,WAAW;AAAA,IACxB;AAEA,UAAM,UAAU,IAAI,WAAW,WAAW;AAE1C,WAAO,QAAQ,IAAI,CAAC,UAAU;AAC5B,aAAO,KAAK,eAAe,KAAK;AAAA,IAClC,CAAC;AAAA,EACH;AAAA,EAEU,eAAe,OAAyB;AAChD,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC,aAAO;AAAA,IACT;AAEA,QACE,UAAU,MACT,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,KACzC,OAAO,UAAU,YAAY,OAAO,KAAK,KAAK,EAAE,WAAW,GAC5D;AACA,aAAO,OAAO,UAAU,WAAW,CAAC,IAAI;AAAA,IAC1C;AAEA,QAAI,MAAM,QAAQ,KAAK,KAAK,OAAO,UAAU,UAAU;AACrD,aAAO,IAAI,WAAW,KAAK,EACxB,IAAI,CAAC,eAAe;AACnB,eAAO,KAAK,eAAe,UAAU;AAAA,MACvC,CAAC,EACA,IAAI;AAAA,IACT;AAEA,QAAI,OAAO,UAAU,YAAY,MAAM,SAAS,wBAAuB,6BAA6B,CAAC,GAAG;AACtG,aAAO,MAAM,MAAM,wBAAuB,6BAA6B,CAAC;AAAA,IAC1E;AAEA,QAAI,UAAU,QAAQ;AACpB,aAAO;AAAA,IACT;AAEA,QAAI,UAAU,SAAS;AACrB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAAA,EAEU,eAA4B,KAAa,cAAqB;AACtE,WAAO,KAAK,SAAS,MAAM,KAAK,YAAY;AAAA,EAC9C;AACF;","names":[]}

package/build/chunk-OS75QJZN.js

@@ -0,0 +1,159 @@
+import {
+  InvalidQuery
+} from "./chunk-XIRHVLVQ.js";
+
+// src/allowed_include.ts
+import app2 from "@adonisjs/core/services/app";
+import { Collection as Collection2 } from "collect.js";
+
+// src/includes/included_callback.ts
+var IncludedCallback = class {
+  constructor(callback) {
+    this.callback = callback;
+  }
+  handle(query, include) {
+    void query.preload(include, this.callback);
+  }
+};
+
+// src/includes/included_count.ts
+import app from "@adonisjs/core/services/app";
+var IncludedCount = class {
+  handle(query, count) {
+    const suffix = app.config.get("apiquery.countSuffix", "Count");
+    const relation = count.endsWith(suffix) ? count.slice(0, -suffix.length) : count;
+    void query.withCount(relation);
+  }
+};
+
+// src/includes/included_relationship.ts
+import { Collection } from "collect.js";
+var IncludedRelationship = class {
+  static getIndividualRelationshipPathsFromInclude(include) {
+    const originalInclude = new Collection(include.split("."));
+    return originalInclude.reduce((includes, relationship) => {
+      const includesArray = includes ?? new Collection();
+      if (includesArray.isEmpty()) {
+        return includesArray.push(relationship);
+      }
+      return includesArray.push(`${includes.last()}.${relationship}`);
+    }, new Collection());
+  }
+  getRequestedFieldsForRelatedTable;
+  handle(query, relationship) {
+    const relatedTables = relationship.split(".");
+    if (relatedTables.length === 0) {
+      return;
+    }
+    const [relation, ...rest] = relatedTables;
+    if (!query.model.$hasRelation(relation)) {
+      return;
+    }
+    void query.preload(relation, (subQuery) => {
+      if (this.getRequestedFieldsForRelatedTable !== void 0) {
+        const fields = this.getRequestedFieldsForRelatedTable(relation);
+        if (fields.length > 0) {
+          void subQuery.select(fields);
+        }
+      }
+      this.buildNestedQuery(rest, subQuery, relation);
+    });
+  }
+  buildNestedQuery(relatedTables, subQuery, parent = "") {
+    if (relatedTables.length === 0) {
+      return;
+    }
+    const [relation, ...rest] = relatedTables;
+    if (!subQuery.model.$hasRelation(relation)) {
+      return;
+    }
+    void subQuery.preload(relation, (nestedQuery) => {
+      const fullRelationName = parent === "" ? relation : `${parent}.${relation}`;
+      if (this.getRequestedFieldsForRelatedTable !== void 0) {
+        const fields = this.getRequestedFieldsForRelatedTable(fullRelationName);
+        if (fields.length > 0) {
+          void nestedQuery.select(fields);
+        }
+      }
+      this.buildNestedQuery(rest, nestedQuery, fullRelationName);
+    });
+  }
+};
+
+// src/allowed_include.ts
+var AllowedInclude = class _AllowedInclude {
+  static relationship(name, internalName) {
+    internalName = internalName ?? name;
+    return IncludedRelationship.getIndividualRelationshipPathsFromInclude(internalName).zip(IncludedRelationship.getIndividualRelationshipPathsFromInclude(name).toArray()).reduce((includes, args) => {
+      const [relationship, alias] = args;
+      includes = includes.push(
+        new _AllowedInclude(alias, new IncludedRelationship(), relationship)
+      );
+      if (!relationship.includes(".")) {
+        const countSuffix = app2.config.get("apiquery.countSuffix", "Count");
+        for (const countAllowedInclude of _AllowedInclude.count(
+          `${alias}${countSuffix}`,
+          `${relationship}${countSuffix}`
+        )) {
+          includes = includes.push(countAllowedInclude);
+        }
+      }
+      return includes;
+    }, new Collection2());
+  }
+  static count(name, internalName) {
+    return new Collection2([new _AllowedInclude(name, new IncludedCount(), internalName)]);
+  }
+  static callback(name, callback, internalName) {
+    return new Collection2([
+      new _AllowedInclude(name, new IncludedCallback(callback), internalName)
+    ]);
+  }
+  static custom(name, includeClass, internalName) {
+    return new Collection2([new _AllowedInclude(name, includeClass, internalName)]);
+  }
+  internalName;
+  name;
+  includeClass;
+  constructor(name, includeClass, internalName) {
+    this.name = name;
+    this.includeClass = includeClass;
+    this.internalName = internalName ?? this.name;
+  }
+  include(query) {
+    this.includeClass.handle(query, this.internalName);
+  }
+  getName() {
+    return this.name;
+  }
+  isForInclude(includeName) {
+    return this.name === includeName;
+  }
+};
+
+// src/exceptions/invalid_include_query.ts
+import { ResponseStatus } from "@adonisjs/core/http";
+var InvalidIncludeQuery = class _InvalidIncludeQuery extends InvalidQuery {
+  constructor(unknownIncludes, allowedIncludes) {
+    const notAllowed = unknownIncludes.join(", ");
+    let message = `Requested include(s) \`${notAllowed}\` are not allowed. `;
+    if (allowedIncludes.length > 0) {
+      const allowed = allowedIncludes.join(", ");
+      message = `${message}Allowed include(s) are \`${allowed}\``;
+    } else {
+      message = `${message}There are no allowed includes`;
+    }
+    super(message, { status: ResponseStatus.BadRequest });
+    this.unknownIncludes = unknownIncludes;
+    this.allowedIncludes = allowedIncludes;
+  }
+  static includesNotAllowed(unknownIncludes, allowedIncludes) {
+    return new _InvalidIncludeQuery(unknownIncludes, allowedIncludes);
+  }
+};
+
+export {
+  AllowedInclude,
+  InvalidIncludeQuery
+};
+//# sourceMappingURL=chunk-OS75QJZN.js.map

package/build/chunk-OS75QJZN.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/allowed_include.ts","../src/includes/included_callback.ts","../src/includes/included_count.ts","../src/includes/included_relationship.ts","../src/exceptions/invalid_include_query.ts"],"sourcesContent":["import app from '@adonisjs/core/services/app';\nimport { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type ModelRelations } from '@adonisjs/lucid/types/relations';\nimport { Collection } from 'collect.js';\nimport { IncludedCallback } from './includes/included_callback.js';\nimport { IncludedCount } from './includes/included_count.js';\nimport { IncludedRelationship } from './includes/included_relationship.js';\nimport { type Include } from './types.js';\n\nexport class AllowedInclude<Model extends LucidModel> {\n  public static relationship<ParentModel extends LucidModel>(\n    name: string,\n    internalName?: string,\n  ): Collection<AllowedInclude<ParentModel>> {\n    internalName = internalName ?? name;\n\n    return IncludedRelationship.getIndividualRelationshipPathsFromInclude(internalName)\n      .zip(IncludedRelationship.getIndividualRelationshipPathsFromInclude(name).toArray<string>())\n      .reduce((includes, args) => {\n        const [relationship, alias] = args;\n\n        includes = includes!.push(\n          new AllowedInclude<ParentModel>(alias, new IncludedRelationship<ParentModel>(), relationship),\n        );\n\n        if (!relationship.includes('.')) {\n          const countSuffix = app.config.get<string>('apiquery.countSuffix', 'Count');\n          for (const countAllowedInclude of AllowedInclude.count(\n            `${alias}${countSuffix}`,\n            `${relationship}${countSuffix}`,\n          )) {\n            includes = includes.push(countAllowedInclude);\n          }\n        }\n\n        return includes;\n      }, new Collection<AllowedInclude<ParentModel>>()) as Collection<AllowedInclude<ParentModel>>;\n  }\n\n  public static count<ParentModel extends LucidModel>(\n    name: string,\n    internalName?: string,\n  ): Collection<AllowedInclude<ParentModel>> {\n    return new Collection([new AllowedInclude<ParentModel>(name, new IncludedCount<ParentModel>(), internalName)]);\n  }\n\n  public static callback<ParentModel extends LucidModel, RelatedModel extends LucidModel>(\n    name: string,\n    callback: (\n      query:\n        | ModelRelations<RelatedModel, ParentModel>['builder']\n        | ModelRelations<RelatedModel, ParentModel>['subQuery'],\n    ) => void,\n    internalName?: string,\n  ): Collection<AllowedInclude<ParentModel>> {\n    return new Collection([\n      new AllowedInclude<ParentModel>(name, new IncludedCallback<ParentModel, RelatedModel>(callback), internalName),\n    ]);\n  }\n\n  public static custom<ParentModel extends LucidModel>(\n    name: string,\n    includeClass: Include<ParentModel>,\n    internalName?: string,\n  ): Collection<AllowedInclude<ParentModel>> {\n    return new Collection([new AllowedInclude<ParentModel>(name, includeClass, internalName)]);\n  }\n\n  protected internalName: string;\n\n  protected name: string;\n\n  protected includeClass: Include<Model>;\n\n  public constructor(name: string, includeClass: Include<Model>, internalName?: string) {\n    this.name = name;\n    this.includeClass = includeClass;\n    this.internalName = internalName ?? this.name;\n  }\n\n  public include(query: ModelQueryBuilderContract<Model>): void {\n    // if ('getRequestedFieldsForRelatedTable' in this.includeClass) {\n    //   this.includeClass.getRequestedFieldsForRelatedTable = (relationship: string) => {\n    //     return query.getRequestedFieldsForRelatedTable(relationship);\n    //   };\n    // }\n\n    this.includeClass.handle(query, this.internalName);\n  }\n\n  public getName(): string {\n    return this.name;\n  }\n\n  public isForInclude(includeName: string): boolean {\n    return this.name === includeName;\n  }\n}\n","import { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type ExtractModelRelations, type ModelRelations } from '@adonisjs/lucid/types/relations';\nimport { type Include } from '../types.js';\n\nexport class IncludedCallback<ParentModel extends LucidModel, RelatedModel extends LucidModel>\n  implements Include<ParentModel>\n{\n  public constructor(\n    public readonly callback: (\n      query:\n        | ModelRelations<RelatedModel, ParentModel>['builder']\n        | ModelRelations<RelatedModel, ParentModel>['subQuery'],\n    ) => void,\n  ) {}\n\n  public handle(query: ModelQueryBuilderContract<ParentModel, InstanceType<ParentModel>>, include: string): void {\n    void query.preload(include as ExtractModelRelations<InstanceType<ParentModel>>, this.callback);\n  }\n}\n","import app from '@adonisjs/core/services/app';\nimport { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type ExtractModelRelations } from '@adonisjs/lucid/types/relations';\nimport { type Include } from '../types.js';\n\nexport class IncludedCount<ParentModel extends LucidModel> implements Include<ParentModel> {\n  public handle(query: ModelQueryBuilderContract<ParentModel, InstanceType<ParentModel>>, count: string): void {\n    const suffix = app.config.get<string>('apiquery.countSuffix', 'Count');\n    const relation = (count.endsWith(suffix) ? count.slice(0, -suffix.length) : count) as ExtractModelRelations<\n      InstanceType<ParentModel>\n    >;\n\n    void query.withCount(relation);\n  }\n}\n","import { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';\nimport { type ExtractModelRelations, type ModelRelations } from '@adonisjs/lucid/types/relations';\nimport { Collection } from 'collect.js';\nimport { type Include } from '../types.js';\n\nexport class IncludedRelationship<ParentModel extends LucidModel> implements Include<ParentModel> {\n  public static getIndividualRelationshipPathsFromInclude(include: string): Collection<string> {\n    const originalInclude = new Collection(include.split('.'));\n\n    return originalInclude.reduce((includes, relationship) => {\n      const includesArray = includes ?? new Collection<string>();\n\n      if (includesArray.isEmpty()) {\n        return includesArray.push(relationship);\n      }\n\n      return includesArray.push(`${includes!.last()}.${relationship}`);\n    }, new Collection<string>()) as Collection<string>;\n  }\n\n  public getRequestedFieldsForRelatedTable?: (relationship: string) => string[];\n\n  public handle(query: ModelQueryBuilderContract<ParentModel, InstanceType<ParentModel>>, relationship: string): void {\n    const relatedTables = relationship.split('.');\n\n    if (relatedTables.length === 0) {\n      return;\n    }\n\n    const [relation, ...rest] = relatedTables;\n\n    if (!query.model.$hasRelation(relation)) {\n      return;\n    }\n\n    void query.preload(relation as ExtractModelRelations<InstanceType<ParentModel>>, (subQuery) => {\n      if (this.getRequestedFieldsForRelatedTable !== undefined) {\n        const fields = this.getRequestedFieldsForRelatedTable(relation);\n        if (fields.length > 0) {\n          void subQuery.select(fields);\n        }\n      }\n\n      this.buildNestedQuery(rest, subQuery, relation);\n    });\n  }\n\n  private buildNestedQuery<SubParentModel extends LucidModel, SubRelatedModel extends LucidModel>(\n    relatedTables: string[],\n    subQuery:\n      | ModelRelations<SubRelatedModel, SubParentModel>['builder']\n      | ModelRelations<SubRelatedModel, SubParentModel>['subQuery'],\n    parent = '',\n  ): void {\n    if (relatedTables.length === 0) {\n      return;\n    }\n\n    const [relation, ...rest] = relatedTables;\n\n    if (!subQuery.model.$hasRelation(relation)) {\n      return;\n    }\n\n    void subQuery.preload(relation as ExtractModelRelations<InstanceType<SubRelatedModel>>, (nestedQuery) => {\n      const fullRelationName = parent === '' ? relation : `${parent}.${relation}`;\n      if (this.getRequestedFieldsForRelatedTable !== undefined) {\n        const fields = this.getRequestedFieldsForRelatedTable(fullRelationName);\n        if (fields.length > 0) {\n          void nestedQuery.select(fields);\n        }\n      }\n\n      this.buildNestedQuery(rest, nestedQuery, fullRelationName);\n    });\n  }\n}\n","import { ResponseStatus } from '@adonisjs/core/http';\nimport { InvalidQuery } from './invalid_query.js';\n\nexport class InvalidIncludeQuery extends InvalidQuery {\n  public constructor(\n    public readonly unknownIncludes: string[],\n    public readonly allowedIncludes: string[],\n  ) {\n    const notAllowed = unknownIncludes.join(', ');\n    let message = `Requested include(s) \\`${notAllowed}\\` are not allowed. `;\n\n    if (allowedIncludes.length > 0) {\n      const allowed = allowedIncludes.join(', ');\n      message = `${message}Allowed include(s) are \\`${allowed}\\``;\n    } else {\n      message = `${message}There are no allowed includes`;\n    }\n\n    super(message, { status: ResponseStatus.BadRequest });\n  }\n\n  public static includesNotAllowed(unknownIncludes: string[], allowedIncludes: string[]): InvalidIncludeQuery {\n    return new InvalidIncludeQuery(unknownIncludes, allowedIncludes);\n  }\n}\n"],"mappings":";;;;;AAAA,OAAOA,UAAS;AAGhB,SAAS,cAAAC,mBAAkB;;;ACCpB,IAAM,mBAAN,MAEP;AAAA,EACS,YACW,UAKhB;AALgB;AAAA,EAKf;AAAA,EAEI,OAAO,OAA0E,SAAuB;AAC7G,SAAK,MAAM,QAAQ,SAA6D,KAAK,QAAQ;AAAA,EAC/F;AACF;;;AClBA,OAAO,SAAS;AAKT,IAAM,gBAAN,MAAoF;AAAA,EAClF,OAAO,OAA0E,OAAqB;AAC3G,UAAM,SAAS,IAAI,OAAO,IAAY,wBAAwB,OAAO;AACrE,UAAM,WAAY,MAAM,SAAS,MAAM,IAAI,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,IAAI;AAI5E,SAAK,MAAM,UAAU,QAAQ;AAAA,EAC/B;AACF;;;ACZA,SAAS,kBAAkB;AAGpB,IAAM,uBAAN,MAA2F;AAAA,EAChG,OAAc,0CAA0C,SAAqC;AAC3F,UAAM,kBAAkB,IAAI,WAAW,QAAQ,MAAM,GAAG,CAAC;AAEzD,WAAO,gBAAgB,OAAO,CAAC,UAAU,iBAAiB;AACxD,YAAM,gBAAgB,YAAY,IAAI,WAAmB;AAEzD,UAAI,cAAc,QAAQ,GAAG;AAC3B,eAAO,cAAc,KAAK,YAAY;AAAA,MACxC;AAEA,aAAO,cAAc,KAAK,GAAG,SAAU,KAAK,CAAC,IAAI,YAAY,EAAE;AAAA,IACjE,GAAG,IAAI,WAAmB,CAAC;AAAA,EAC7B;AAAA,EAEO;AAAA,EAEA,OAAO,OAA0E,cAA4B;AAClH,UAAM,gBAAgB,aAAa,MAAM,GAAG;AAE5C,QAAI,cAAc,WAAW,GAAG;AAC9B;AAAA,IACF;AAEA,UAAM,CAAC,UAAU,GAAG,IAAI,IAAI;AAE5B,QAAI,CAAC,MAAM,MAAM,aAAa,QAAQ,GAAG;AACvC;AAAA,IACF;AAEA,SAAK,MAAM,QAAQ,UAA8D,CAAC,aAAa;AAC7F,UAAI,KAAK,sCAAsC,QAAW;AACxD,cAAM,SAAS,KAAK,kCAAkC,QAAQ;AAC9D,YAAI,OAAO,SAAS,GAAG;AACrB,eAAK,SAAS,OAAO,MAAM;AAAA,QAC7B;AAAA,MACF;AAEA,WAAK,iBAAiB,MAAM,UAAU,QAAQ;AAAA,IAChD,CAAC;AAAA,EACH;AAAA,EAEQ,iBACN,eACA,UAGA,SAAS,IACH;AACN,QAAI,cAAc,WAAW,GAAG;AAC9B;AAAA,IACF;AAEA,UAAM,CAAC,UAAU,GAAG,IAAI,IAAI;AAE5B,QAAI,CAAC,SAAS,MAAM,aAAa,QAAQ,GAAG;AAC1C;AAAA,IACF;AAEA,SAAK,SAAS,QAAQ,UAAkE,CAAC,gBAAgB;AACvG,YAAM,mBAAmB,WAAW,KAAK,WAAW,GAAG,MAAM,IAAI,QAAQ;AACzE,UAAI,KAAK,sCAAsC,QAAW;AACxD,cAAM,SAAS,KAAK,kCAAkC,gBAAgB;AACtE,YAAI,OAAO,SAAS,GAAG;AACrB,eAAK,YAAY,OAAO,MAAM;AAAA,QAChC;AAAA,MACF;AAEA,WAAK,iBAAiB,MAAM,aAAa,gBAAgB;AAAA,IAC3D,CAAC;AAAA,EACH;AACF;;;AHnEO,IAAM,iBAAN,MAAM,gBAAyC;AAAA,EACpD,OAAc,aACZ,MACA,cACyC;AACzC,mBAAe,gBAAgB;AAE/B,WAAO,qBAAqB,0CAA0C,YAAY,EAC/E,IAAI,qBAAqB,0CAA0C,IAAI,EAAE,QAAgB,CAAC,EAC1F,OAAO,CAAC,UAAU,SAAS;AAC1B,YAAM,CAAC,cAAc,KAAK,IAAI;AAE9B,iBAAW,SAAU;AAAA,QACnB,IAAI,gBAA4B,OAAO,IAAI,qBAAkC,GAAG,YAAY;AAAA,MAC9F;AAEA,UAAI,CAAC,aAAa,SAAS,GAAG,GAAG;AAC/B,cAAM,cAAcC,KAAI,OAAO,IAAY,wBAAwB,OAAO;AAC1E,mBAAW,uBAAuB,gBAAe;AAAA,UAC/C,GAAG,KAAK,GAAG,WAAW;AAAA,UACtB,GAAG,YAAY,GAAG,WAAW;AAAA,QAC/B,GAAG;AACD,qBAAW,SAAS,KAAK,mBAAmB;AAAA,QAC9C;AAAA,MACF;AAEA,aAAO;AAAA,IACT,GAAG,IAAIC,YAAwC,CAAC;AAAA,EACpD;AAAA,EAEA,OAAc,MACZ,MACA,cACyC;AACzC,WAAO,IAAIA,YAAW,CAAC,IAAI,gBAA4B,MAAM,IAAI,cAA2B,GAAG,YAAY,CAAC,CAAC;AAAA,EAC/G;AAAA,EAEA,OAAc,SACZ,MACA,UAKA,cACyC;AACzC,WAAO,IAAIA,YAAW;AAAA,MACpB,IAAI,gBAA4B,MAAM,IAAI,iBAA4C,QAAQ,GAAG,YAAY;AAAA,IAC/G,CAAC;AAAA,EACH;AAAA,EAEA,OAAc,OACZ,MACA,cACA,cACyC;AACzC,WAAO,IAAIA,YAAW,CAAC,IAAI,gBAA4B,MAAM,cAAc,YAAY,CAAC,CAAC;AAAA,EAC3F;AAAA,EAEU;AAAA,EAEA;AAAA,EAEA;AAAA,EAEH,YAAY,MAAc,cAA8B,cAAuB;AACpF,SAAK,OAAO;AACZ,SAAK,eAAe;AACpB,SAAK,eAAe,gBAAgB,KAAK;AAAA,EAC3C;AAAA,EAEO,QAAQ,OAA+C;AAO5D,SAAK,aAAa,OAAO,OAAO,KAAK,YAAY;AAAA,EACnD;AAAA,EAEO,UAAkB;AACvB,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,aAAa,aAA8B;AAChD,WAAO,KAAK,SAAS;AAAA,EACvB;AACF;;;AIjGA,SAAS,sBAAsB;AAGxB,IAAM,sBAAN,MAAM,6BAA4B,aAAa;AAAA,EAC7C,YACW,iBACA,iBAChB;AACA,UAAM,aAAa,gBAAgB,KAAK,IAAI;AAC5C,QAAI,UAAU,0BAA0B,UAAU;AAElD,QAAI,gBAAgB,SAAS,GAAG;AAC9B,YAAM,UAAU,gBAAgB,KAAK,IAAI;AACzC,gBAAU,GAAG,OAAO,4BAA4B,OAAO;AAAA,IACzD,OAAO;AACL,gBAAU,GAAG,OAAO;AAAA,IACtB;AAEA,UAAM,SAAS,EAAE,QAAQ,eAAe,WAAW,CAAC;AAbpC;AACA;AAAA,EAalB;AAAA,EAEA,OAAc,mBAAmB,iBAA2B,iBAAgD;AAC1G,WAAO,IAAI,qBAAoB,iBAAiB,eAAe;AAAA,EACjE;AACF;","names":["app","Collection","app","Collection"]}