@eienjs/adonisjs-api-query 0.1.0

package/build/index.d.ts

@@ -0,0 +1,19 @@
+export { configure } from './configure.js';
+export { AllowedFilter } from './src/allowed_filter.js';
+export { AllowedInclude } from './src/allowed_include.js';
+export { AllowedSort } from './src/allowed_sort.js';
+export { ApiQueryBuilderRequest } from './src/api_query_builder_request.js';
+export { defineConfig } from './src/define_config.js';
+export { FilterOperator } from './src/enums/filter_operator.js';
+export { SortDirection } from './src/enums/sort_direction.js';
+export { AllowedFieldsMustBeCalledBeforeAllowedIncludes } from './src/exceptions/allowed_fields_must_be_called_before_allowed_includes.js';
+export { InvalidAppendQuery } from './src/exceptions/invalid_append_query.js';
+export { InvalidDirection } from './src/exceptions/invalid_direction.js';
+export { InvalidFilterQuery } from './src/exceptions/invalid_filter_query.js';
+export { InvalidFilterValue } from './src/exceptions/invalid_filter_value.js';
+export { InvalidIncludeQuery } from './src/exceptions/invalid_include_query.js';
+export { InvalidQuery } from './src/exceptions/invalid_query.js';
+export { InvalidSortQuery } from './src/exceptions/invalid_sort_query.js';
+export { UnknownIncludedFieldsQuery } from './src/exceptions/unknown_included_fields_query.js';
+export { stubsRoot } from './stubs/main.js';
+export * from 'collect.js';

package/build/index.js

@@ -0,0 +1,130 @@
+import {
+  AllowedSort,
+  InvalidDirection,
+  InvalidSortQuery,
+  SortDirection
+} from "./chunk-HQN7LHVO.js";
+import {
+  AllowedFilter,
+  FilterOperator,
+  InvalidFilterQuery
+} from "./chunk-PBQFWYKU.js";
+import {
+  ApiQueryBuilderRequest
+} from "./chunk-MKQ3HMMA.js";
+import {
+  AllowedInclude,
+  InvalidIncludeQuery
+} from "./chunk-OS75QJZN.js";
+import {
+  InvalidQuery
+} from "./chunk-XIRHVLVQ.js";
+
+// stubs/main.ts
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+var stubsRoot = path.dirname(fileURLToPath(import.meta.url));
+
+// configure.ts
+var configure = async (command) => {
+  const codemods = await command.createCodemods();
+  await codemods.updateRcFile((rcFile) => {
+    rcFile.addProvider("@eienjs/adonisjs-api-query/api_query_provider");
+  });
+  await codemods.makeUsingStub(stubsRoot, "config.stub", {});
+};
+
+// src/define_config.ts
+import { configProvider } from "@adonisjs/core";
+var defineConfig = function(config) {
+  return configProvider.create(async (_) => {
+    return {
+      parameters: {
+        include: config.parameters?.include ?? "include",
+        filter: config.parameters?.filter ?? "filter",
+        sort: config.parameters?.sort ?? "sort",
+        fields: config.parameters?.fields ?? "fields",
+        append: config.parameters?.append ?? "append"
+      },
+      countSuffix: config.countSuffix ?? "Count",
+      existsSuffix: config.existsSuffix ?? "Exists",
+      disableInvalidFilterQueryException: config.disableInvalidFilterQueryException ?? false,
+      disableInvalidSortQueryException: config.disableInvalidSortQueryException ?? false,
+      disableInvalidIncludesQueryException: config.disableInvalidIncludesQueryException ?? false,
+      convertRelationNamesToSnakeCasePlural: config.convertRelationNamesToSnakeCasePlural ?? false,
+      convertRelationTableNameStrategy: config.convertRelationTableNameStrategy ?? false,
+      convertFieldNamesToSnakeCase: config.convertFieldNamesToSnakeCase ?? false
+    };
+  });
+};
+
+// src/exceptions/allowed_fields_must_be_called_before_allowed_includes.ts
+import { Exception } from "@adonisjs/core/exceptions";
+var AllowedFieldsMustBeCalledBeforeAllowedIncludes = class extends Exception {
+  static code;
+  static status;
+  constructor() {
+    super("The QueryBuilder's `allowedFields` method must be called before the `allowedIncludes` method");
+  }
+};
+
+// src/exceptions/invalid_append_query.ts
+import { ResponseStatus } from "@adonisjs/core/http";
+var InvalidAppendQuery = class _InvalidAppendQuery extends InvalidQuery {
+  constructor(appendsNotAllowed, allowedAppends) {
+    const notAllowed = appendsNotAllowed.join(", ");
+    const allowed = allowedAppends.join(", ");
+    const message = `Requested append(s) \`${notAllowed}\` are not allowed. Allowed append(s) are \`${allowed}\``;
+    super(message, { status: ResponseStatus.BadRequest });
+  }
+  static appendsNotAllowed(appendsNotAllowed, allowedAppends) {
+    return new _InvalidAppendQuery(appendsNotAllowed, allowedAppends);
+  }
+};
+
+// src/exceptions/invalid_filter_value.ts
+import { Exception as Exception2 } from "@adonisjs/core/exceptions";
+var InvalidFilterValue = class _InvalidFilterValue extends Exception2 {
+  static make(value) {
+    return new _InvalidFilterValue(`Filter value \`${value}\` is invalid`);
+  }
+};
+
+// src/exceptions/unknown_included_fields_query.ts
+import { ResponseStatus as ResponseStatus2 } from "@adonisjs/core/http";
+var UnknownIncludedFieldsQuery = class extends InvalidQuery {
+  unknownFields;
+  constructor(unknownFields) {
+    const notAllowed = unknownFields.join(", ");
+    const message = [
+      `Requested field(s) \`${notAllowed}\` are not allowed (yet). `,
+      "If you want to allow these fields, please make sure to call the QueryBuilder's `allowedFields` method before the `allowedIncludes` method"
+    ].join("");
+    super(message, { status: ResponseStatus2.BadRequest });
+    this.unknownFields = unknownFields;
+  }
+};
+
+// index.ts
+export * from "collect.js";
+export {
+  AllowedFieldsMustBeCalledBeforeAllowedIncludes,
+  AllowedFilter,
+  AllowedInclude,
+  AllowedSort,
+  ApiQueryBuilderRequest,
+  FilterOperator,
+  InvalidAppendQuery,
+  InvalidDirection,
+  InvalidFilterQuery,
+  InvalidFilterValue,
+  InvalidIncludeQuery,
+  InvalidQuery,
+  InvalidSortQuery,
+  SortDirection,
+  UnknownIncludedFieldsQuery,
+  configure,
+  defineConfig,
+  stubsRoot
+};
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../stubs/main.ts","../configure.ts","../src/define_config.ts","../src/exceptions/allowed_fields_must_be_called_before_allowed_includes.ts","../src/exceptions/invalid_append_query.ts","../src/exceptions/invalid_filter_value.ts","../src/exceptions/unknown_included_fields_query.ts","../index.ts"],"sourcesContent":["import path from 'node:path';\nimport { fileURLToPath } from 'node:url';\n\nexport const stubsRoot = path.dirname(fileURLToPath(import.meta.url));\n","import type Configure from '@adonisjs/core/commands/configure';\nimport { stubsRoot } from './stubs/main.js';\n\nexport const configure = async (command: Configure): Promise<void> => {\n  const codemods = await command.createCodemods();\n\n  await codemods.updateRcFile((rcFile) => {\n    rcFile.addProvider('@eienjs/adonisjs-api-query/api_query_provider');\n  });\n\n  await codemods.makeUsingStub(stubsRoot, 'config.stub', {});\n};\n","import { configProvider } from '@adonisjs/core';\nimport { type ConfigProvider } from '@adonisjs/core/types';\nimport { type ApiQueryConfig, type ResolvedApiQueryConfig } from './types.js';\n\nexport const defineConfig = function (config: ApiQueryConfig): ConfigProvider<ResolvedApiQueryConfig> {\n  return configProvider.create(async (_) => {\n    return {\n      parameters: {\n        include: config.parameters?.include ?? 'include',\n        filter: config.parameters?.filter ?? 'filter',\n        sort: config.parameters?.sort ?? 'sort',\n        fields: config.parameters?.fields ?? 'fields',\n        append: config.parameters?.append ?? 'append',\n      },\n      countSuffix: config.countSuffix ?? 'Count',\n      existsSuffix: config.existsSuffix ?? 'Exists',\n      disableInvalidFilterQueryException: config.disableInvalidFilterQueryException ?? false,\n      disableInvalidSortQueryException: config.disableInvalidSortQueryException ?? false,\n      disableInvalidIncludesQueryException: config.disableInvalidIncludesQueryException ?? false,\n      convertRelationNamesToSnakeCasePlural: config.convertRelationNamesToSnakeCasePlural ?? false,\n      convertRelationTableNameStrategy: config.convertRelationTableNameStrategy ?? false,\n      convertFieldNamesToSnakeCase: config.convertFieldNamesToSnakeCase ?? false,\n    };\n  });\n};\n","import { Exception } from '@adonisjs/core/exceptions';\n\nexport class AllowedFieldsMustBeCalledBeforeAllowedIncludes extends Exception {\n  public static readonly code: 'E_BAD_METHOD_CALL_EXCEPTION';\n\n  public static readonly status: 500;\n\n  public constructor() {\n    super(\"The QueryBuilder's `allowedFields` method must be called before the `allowedIncludes` method\");\n  }\n}\n","import { ResponseStatus } from '@adonisjs/core/http';\nimport { InvalidQuery } from './invalid_query.js';\n\nexport class InvalidAppendQuery extends InvalidQuery {\n  public constructor(appendsNotAllowed: string[], allowedAppends: string[]) {\n    const notAllowed = appendsNotAllowed.join(', ');\n    const allowed = allowedAppends.join(', ');\n    const message = `Requested append(s) \\`${notAllowed}\\` are not allowed. Allowed append(s) are \\`${allowed}\\``;\n\n    super(message, { status: ResponseStatus.BadRequest });\n  }\n\n  public static appendsNotAllowed(appendsNotAllowed: string[], allowedAppends: string[]): InvalidAppendQuery {\n    return new InvalidAppendQuery(appendsNotAllowed, allowedAppends);\n  }\n}\n","import { Exception } from '@adonisjs/core/exceptions';\n\nexport class InvalidFilterValue extends Exception {\n  public static make(value: unknown): InvalidFilterValue {\n    return new InvalidFilterValue(`Filter value \\`${value}\\` is invalid`);\n  }\n}\n","import { ResponseStatus } from '@adonisjs/core/http';\nimport { InvalidQuery } from './invalid_query.js';\n\nexport class UnknownIncludedFieldsQuery extends InvalidQuery {\n  public readonly unknownFields: string[];\n\n  public constructor(unknownFields: string[]) {\n    const notAllowed = unknownFields.join(', ');\n    const message = [\n      `Requested field(s) \\`${notAllowed}\\` are not allowed (yet). `,\n      \"If you want to allow these fields, please make sure to call the QueryBuilder's `allowedFields` method before the `allowedIncludes` method\",\n    ].join('');\n\n    super(message, { status: ResponseStatus.BadRequest });\n\n    this.unknownFields = unknownFields;\n  }\n}\n","export { configure } from './configure.js';\nexport { AllowedFilter } from './src/allowed_filter.js';\nexport { AllowedInclude } from './src/allowed_include.js';\nexport { AllowedSort } from './src/allowed_sort.js';\nexport { ApiQueryBuilderRequest } from './src/api_query_builder_request.js';\nexport { defineConfig } from './src/define_config.js';\nexport { FilterOperator } from './src/enums/filter_operator.js';\nexport { SortDirection } from './src/enums/sort_direction.js';\nexport { AllowedFieldsMustBeCalledBeforeAllowedIncludes } from './src/exceptions/allowed_fields_must_be_called_before_allowed_includes.js';\nexport { InvalidAppendQuery } from './src/exceptions/invalid_append_query.js';\nexport { InvalidDirection } from './src/exceptions/invalid_direction.js';\nexport { InvalidFilterQuery } from './src/exceptions/invalid_filter_query.js';\nexport { InvalidFilterValue } from './src/exceptions/invalid_filter_value.js';\nexport { InvalidIncludeQuery } from './src/exceptions/invalid_include_query.js';\nexport { InvalidQuery } from './src/exceptions/invalid_query.js';\nexport { InvalidSortQuery } from './src/exceptions/invalid_sort_query.js';\nexport { UnknownIncludedFieldsQuery } from './src/exceptions/unknown_included_fields_query.js';\nexport { stubsRoot } from './stubs/main.js';\nexport * from 'collect.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,UAAU;AACjB,SAAS,qBAAqB;AAEvB,IAAM,YAAY,KAAK,QAAQ,cAAc,YAAY,GAAG,CAAC;;;ACA7D,IAAM,YAAY,OAAO,YAAsC;AACpE,QAAM,WAAW,MAAM,QAAQ,eAAe;AAE9C,QAAM,SAAS,aAAa,CAAC,WAAW;AACtC,WAAO,YAAY,+CAA+C;AAAA,EACpE,CAAC;AAED,QAAM,SAAS,cAAc,WAAW,eAAe,CAAC,CAAC;AAC3D;;;ACXA,SAAS,sBAAsB;AAIxB,IAAM,eAAe,SAAU,QAAgE;AACpG,SAAO,eAAe,OAAO,OAAO,MAAM;AACxC,WAAO;AAAA,MACL,YAAY;AAAA,QACV,SAAS,OAAO,YAAY,WAAW;AAAA,QACvC,QAAQ,OAAO,YAAY,UAAU;AAAA,QACrC,MAAM,OAAO,YAAY,QAAQ;AAAA,QACjC,QAAQ,OAAO,YAAY,UAAU;AAAA,QACrC,QAAQ,OAAO,YAAY,UAAU;AAAA,MACvC;AAAA,MACA,aAAa,OAAO,eAAe;AAAA,MACnC,cAAc,OAAO,gBAAgB;AAAA,MACrC,oCAAoC,OAAO,sCAAsC;AAAA,MACjF,kCAAkC,OAAO,oCAAoC;AAAA,MAC7E,sCAAsC,OAAO,wCAAwC;AAAA,MACrF,uCAAuC,OAAO,yCAAyC;AAAA,MACvF,kCAAkC,OAAO,oCAAoC;AAAA,MAC7E,8BAA8B,OAAO,gCAAgC;AAAA,IACvE;AAAA,EACF,CAAC;AACH;;;ACxBA,SAAS,iBAAiB;AAEnB,IAAM,iDAAN,cAA6D,UAAU;AAAA,EAC5E,OAAuB;AAAA,EAEvB,OAAuB;AAAA,EAEhB,cAAc;AACnB,UAAM,8FAA8F;AAAA,EACtG;AACF;;;ACVA,SAAS,sBAAsB;AAGxB,IAAM,qBAAN,MAAM,4BAA2B,aAAa;AAAA,EAC5C,YAAY,mBAA6B,gBAA0B;AACxE,UAAM,aAAa,kBAAkB,KAAK,IAAI;AAC9C,UAAM,UAAU,eAAe,KAAK,IAAI;AACxC,UAAM,UAAU,yBAAyB,UAAU,+CAA+C,OAAO;AAEzG,UAAM,SAAS,EAAE,QAAQ,eAAe,WAAW,CAAC;AAAA,EACtD;AAAA,EAEA,OAAc,kBAAkB,mBAA6B,gBAA8C;AACzG,WAAO,IAAI,oBAAmB,mBAAmB,cAAc;AAAA,EACjE;AACF;;;ACfA,SAAS,aAAAA,kBAAiB;AAEnB,IAAM,qBAAN,MAAM,4BAA2BA,WAAU;AAAA,EAChD,OAAc,KAAK,OAAoC;AACrD,WAAO,IAAI,oBAAmB,kBAAkB,KAAK,eAAe;AAAA,EACtE;AACF;;;ACNA,SAAS,kBAAAC,uBAAsB;AAGxB,IAAM,6BAAN,cAAyC,aAAa;AAAA,EAC3C;AAAA,EAET,YAAY,eAAyB;AAC1C,UAAM,aAAa,cAAc,KAAK,IAAI;AAC1C,UAAM,UAAU;AAAA,MACd,wBAAwB,UAAU;AAAA,MAClC;AAAA,IACF,EAAE,KAAK,EAAE;AAET,UAAM,SAAS,EAAE,QAAQC,gBAAe,WAAW,CAAC;AAEpD,SAAK,gBAAgB;AAAA,EACvB;AACF;;;ACCA,cAAc;","names":["Exception","ResponseStatus","ResponseStatus"]}

package/build/metafile-esm.json

@@ -0,0 +1 @@
+{"inputs":{"stubs/main.ts":{"bytes":144,"imports":[{"path":"node:path","kind":"import-statement","external":true},{"path":"node:url","kind":"import-statement","external":true}],"format":"esm"},"configure.ts":{"bytes":423,"imports":[{"path":"stubs/main.ts","kind":"import-statement","original":"./stubs/main.js"}],"format":"esm"},"src/utils/helpers.ts":{"bytes":931,"imports":[],"format":"esm"},"src/api_query_builder_request.ts":{"bytes":6640,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/utils/helpers.ts","kind":"import-statement","original":"./utils/helpers.js"}],"format":"esm"},"src/filters/filters_exact.ts":{"bytes":2526,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/filters/filters_partial.ts":{"bytes":2387,"imports":[{"path":"@adonisjs/lucid/types/database","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true},{"path":"src/filters/filters_exact.ts","kind":"import-statement","original":"./filters_exact.js"}],"format":"esm"},"src/filters/filters_begin_with_strict.ts":{"bytes":768,"imports":[{"path":"@adonisjs/lucid/types/database","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true},{"path":"src/filters/filters_partial.ts","kind":"import-statement","original":"./filters_partial.js"}],"format":"esm"},"src/filters/filters_callback.ts":{"bytes":527,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/filters/filters_ends_with_strict.ts":{"bytes":765,"imports":[{"path":"@adonisjs/lucid/types/database","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true},{"path":"src/filters/filters_partial.ts","kind":"import-statement","original":"./filters_partial.js"}],"format":"esm"},"src/enums/filter_operator.ts":{"bytes":265,"imports":[],"format":"esm"},"src/filters/filters_operator.ts":{"bytes":2380,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"src/enums/filter_operator.ts","kind":"import-statement","original":"../enums/filter_operator.js"},{"path":"../types.js","kind":"import-statement","external":true},{"path":"src/utils/helpers.ts","kind":"import-statement","original":"../utils/helpers.js"},{"path":"src/filters/filters_exact.ts","kind":"import-statement","original":"./filters_exact.js"}],"format":"esm"},"src/filters/filters_trashed.ts":{"bytes":885,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/allowed_filter.ts":{"bytes":6731,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/api_query_builder_request.ts","kind":"import-statement","original":"./api_query_builder_request.js"},{"path":"./enums/filter_operator.js","kind":"import-statement","external":true},{"path":"src/filters/filters_begin_with_strict.ts","kind":"import-statement","original":"./filters/filters_begin_with_strict.js"},{"path":"src/filters/filters_callback.ts","kind":"import-statement","original":"./filters/filters_callback.js"},{"path":"src/filters/filters_ends_with_strict.ts","kind":"import-statement","original":"./filters/filters_ends_with_strict.js"},{"path":"src/filters/filters_exact.ts","kind":"import-statement","original":"./filters/filters_exact.js"},{"path":"src/filters/filters_operator.ts","kind":"import-statement","original":"./filters/filters_operator.js"},{"path":"src/filters/filters_partial.ts","kind":"import-statement","original":"./filters/filters_partial.js"},{"path":"src/filters/filters_trashed.ts","kind":"import-statement","original":"./filters/filters_trashed.js"},{"path":"./types.js","kind":"import-statement","external":true}],"format":"esm"},"src/includes/included_callback.ts":{"bytes":809,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/includes/included_count.ts":{"bytes":742,"imports":[{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/includes/included_relationship.ts":{"bytes":2731,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/allowed_include.ts":{"bytes":3602,"imports":[{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/includes/included_callback.ts","kind":"import-statement","original":"./includes/included_callback.js"},{"path":"src/includes/included_count.ts","kind":"import-statement","original":"./includes/included_count.js"},{"path":"src/includes/included_relationship.ts","kind":"import-statement","original":"./includes/included_relationship.js"},{"path":"./types.js","kind":"import-statement","external":true}],"format":"esm"},"src/enums/sort_direction.ts":{"bytes":166,"imports":[],"format":"esm"},"src/exceptions/invalid_direction.ts":{"bytes":387,"imports":[{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"src/enums/sort_direction.ts","kind":"import-statement","original":"../enums/sort_direction.js"}],"format":"esm"},"src/sorts/sorts_callback.ts":{"bytes":551,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/sorts/sorts_field.ts":{"bytes":385,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/allowed_sort.ts":{"bytes":2724,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"src/enums/sort_direction.ts","kind":"import-statement","original":"./enums/sort_direction.js"},{"path":"src/exceptions/invalid_direction.ts","kind":"import-statement","original":"./exceptions/invalid_direction.js"},{"path":"src/sorts/sorts_callback.ts","kind":"import-statement","original":"./sorts/sorts_callback.js"},{"path":"src/sorts/sorts_field.ts","kind":"import-statement","original":"./sorts/sorts_field.js"},{"path":"./types.js","kind":"import-statement","external":true}],"format":"esm"},"src/define_config.ts":{"bytes":1326,"imports":[{"path":"@adonisjs/core","kind":"import-statement","external":true},{"path":"@adonisjs/core/types","kind":"import-statement","external":true},{"path":"./types.js","kind":"import-statement","external":true}],"format":"esm"},"src/exceptions/allowed_fields_must_be_called_before_allowed_includes.ts":{"bytes":376,"imports":[{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true}],"format":"esm"},"src/exceptions/invalid_query.ts":{"bytes":174,"imports":[{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true}],"format":"esm"},"src/exceptions/invalid_append_query.ts":{"bytes":706,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./invalid_query.js"}],"format":"esm"},"src/exceptions/invalid_filter_query.ts":{"bytes":739,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./invalid_query.js"}],"format":"esm"},"src/exceptions/invalid_filter_value.ts":{"bytes":248,"imports":[{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true}],"format":"esm"},"src/exceptions/invalid_include_query.ts":{"bytes":900,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./invalid_query.js"}],"format":"esm"},"src/exceptions/invalid_sort_query.ts":{"bytes":710,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./invalid_query.js"}],"format":"esm"},"src/exceptions/unknown_included_fields_query.ts":{"bytes":672,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./invalid_query.js"}],"format":"esm"},"index.ts":{"bytes":1315,"imports":[{"path":"configure.ts","kind":"import-statement","original":"./configure.js"},{"path":"src/allowed_filter.ts","kind":"import-statement","original":"./src/allowed_filter.js"},{"path":"src/allowed_include.ts","kind":"import-statement","original":"./src/allowed_include.js"},{"path":"src/allowed_sort.ts","kind":"import-statement","original":"./src/allowed_sort.js"},{"path":"src/api_query_builder_request.ts","kind":"import-statement","original":"./src/api_query_builder_request.js"},{"path":"src/define_config.ts","kind":"import-statement","original":"./src/define_config.js"},{"path":"src/enums/filter_operator.ts","kind":"import-statement","original":"./src/enums/filter_operator.js"},{"path":"src/enums/sort_direction.ts","kind":"import-statement","original":"./src/enums/sort_direction.js"},{"path":"src/exceptions/allowed_fields_must_be_called_before_allowed_includes.ts","kind":"import-statement","original":"./src/exceptions/allowed_fields_must_be_called_before_allowed_includes.js"},{"path":"src/exceptions/invalid_append_query.ts","kind":"import-statement","original":"./src/exceptions/invalid_append_query.js"},{"path":"src/exceptions/invalid_direction.ts","kind":"import-statement","original":"./src/exceptions/invalid_direction.js"},{"path":"src/exceptions/invalid_filter_query.ts","kind":"import-statement","original":"./src/exceptions/invalid_filter_query.js"},{"path":"src/exceptions/invalid_filter_value.ts","kind":"import-statement","original":"./src/exceptions/invalid_filter_value.js"},{"path":"src/exceptions/invalid_include_query.ts","kind":"import-statement","original":"./src/exceptions/invalid_include_query.js"},{"path":"src/exceptions/invalid_query.ts","kind":"import-statement","original":"./src/exceptions/invalid_query.js"},{"path":"src/exceptions/invalid_sort_query.ts","kind":"import-statement","original":"./src/exceptions/invalid_sort_query.js"},{"path":"src/exceptions/unknown_included_fields_query.ts","kind":"import-statement","original":"./src/exceptions/unknown_included_fields_query.js"},{"path":"stubs/main.ts","kind":"import-statement","original":"./stubs/main.js"},{"path":"collect.js","kind":"import-statement","external":true}],"format":"esm"},"src/bindings/api_query_request.ts":{"bytes":770,"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"src/api_query_builder_request.ts","kind":"import-statement","original":"../api_query_builder_request.js"}],"format":"esm"},"src/bindings/sorts_query.ts":{"bytes":2829,"imports":[{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/allowed_sort.ts","kind":"import-statement","original":"../allowed_sort.js"},{"path":"src/exceptions/invalid_sort_query.ts","kind":"import-statement","original":"../exceptions/invalid_sort_query.js"},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/bindings/filters_query.ts":{"bytes":2528,"imports":[{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/allowed_filter.ts","kind":"import-statement","original":"../allowed_filter.js"},{"path":"src/exceptions/invalid_filter_query.ts","kind":"import-statement","original":"../exceptions/invalid_filter_query.js"},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"src/bindings/includes_query.ts":{"bytes":3412,"imports":[{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"src/allowed_include.ts","kind":"import-statement","original":"../allowed_include.js"},{"path":"src/exceptions/invalid_include_query.ts","kind":"import-statement","original":"../exceptions/invalid_include_query.js"},{"path":"../types.js","kind":"import-statement","external":true}],"format":"esm"},"providers/api_query_provider.ts":{"bytes":4064,"imports":[{"path":"@adonisjs/core","kind":"import-statement","external":true},{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"@adonisjs/core/types","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/relations","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"../src/allowed_filter.js","kind":"import-statement","external":true},{"path":"../src/allowed_include.js","kind":"import-statement","external":true},{"path":"../src/allowed_sort.js","kind":"import-statement","external":true},{"path":"../src/api_query_builder_request.js","kind":"import-statement","external":true},{"path":"../src/types.js","kind":"import-statement","external":true},{"path":"src/bindings/api_query_request.ts","kind":"dynamic-import","original":"../src/bindings/api_query_request.js"},{"path":"src/bindings/sorts_query.ts","kind":"dynamic-import","original":"../src/bindings/sorts_query.js"},{"path":"src/bindings/filters_query.ts","kind":"dynamic-import","original":"../src/bindings/filters_query.js"},{"path":"src/bindings/includes_query.ts","kind":"dynamic-import","original":"../src/bindings/includes_query.js"}],"format":"esm"},"src/types.ts":{"bytes":4261,"imports":[{"path":"@adonisjs/lucid/types/model","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/types/querybuilder","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"build/index.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":7495},"build/index.js":{"imports":[{"path":"build/chunk-HQN7LHVO.js","kind":"import-statement"},{"path":"build/chunk-PBQFWYKU.js","kind":"import-statement"},{"path":"build/chunk-MKQ3HMMA.js","kind":"import-statement"},{"path":"build/chunk-OS75QJZN.js","kind":"import-statement"},{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"node:path","kind":"import-statement","external":true},{"path":"node:url","kind":"import-statement","external":true},{"path":"@adonisjs/core","kind":"import-statement","external":true},{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true}],"exports":["AllowedFieldsMustBeCalledBeforeAllowedIncludes","AllowedFilter","AllowedInclude","AllowedSort","ApiQueryBuilderRequest","FilterOperator","InvalidAppendQuery","InvalidDirection","InvalidFilterQuery","InvalidFilterValue","InvalidIncludeQuery","InvalidQuery","InvalidSortQuery","SortDirection","UnknownIncludedFieldsQuery","configure","defineConfig","stubsRoot"],"entryPoint":"index.ts","inputs":{"stubs/main.ts":{"bytesInOutput":134},"configure.ts":{"bytesInOutput":276},"index.ts":{"bytesInOutput":28},"src/define_config.ts":{"bytesInOutput":1118},"src/exceptions/allowed_fields_must_be_called_before_allowed_includes.ts":{"bytesInOutput":298},"src/exceptions/invalid_append_query.ts":{"bytesInOutput":599},"src/exceptions/invalid_filter_value.ts":{"bytesInOutput":247},"src/exceptions/unknown_included_fields_query.ts":{"bytesInOutput":593}},"bytes":4371},"build/providers/api_query_provider.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":4876},"build/providers/api_query_provider.js":{"imports":[{"path":"@adonisjs/core","kind":"import-statement","external":true},{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"@adonisjs/lucid/orm","kind":"import-statement","external":true},{"path":"build/api_query_request-QXOB4BN6.js","kind":"dynamic-import"},{"path":"build/sorts_query-LUETK3FD.js","kind":"dynamic-import"},{"path":"build/filters_query-ZXNA4X75.js","kind":"dynamic-import"},{"path":"build/includes_query-2XNHHWJB.js","kind":"dynamic-import"}],"exports":["default"],"entryPoint":"providers/api_query_provider.ts","inputs":{"providers/api_query_provider.ts":{"bytesInOutput":1261}},"bytes":1338},"build/src/types.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"build/src/types.js":{"imports":[],"exports":[],"entryPoint":"src/types.ts","inputs":{"src/types.ts":{"bytesInOutput":0}},"bytes":0},"build/api_query_request-QXOB4BN6.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":1131},"build/api_query_request-QXOB4BN6.js":{"imports":[{"path":"build/chunk-MKQ3HMMA.js","kind":"import-statement"}],"exports":["extendModelQueryBuilderWithRequest"],"entryPoint":"src/bindings/api_query_request.ts","inputs":{"src/bindings/api_query_request.ts":{"bytesInOutput":348}},"bytes":499},"build/sorts_query-LUETK3FD.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":4447},"build/sorts_query-LUETK3FD.js":{"imports":[{"path":"build/chunk-HQN7LHVO.js","kind":"import-statement"},{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"collect.js","kind":"import-statement","external":true}],"exports":["extendModelQueryBuilderWithSortsQuery"],"entryPoint":"src/bindings/sorts_query.ts","inputs":{"src/bindings/sorts_query.ts":{"bytesInOutput":1877}},"bytes":2064},"build/chunk-HQN7LHVO.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":7217},"build/chunk-HQN7LHVO.js":{"imports":[{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true}],"exports":["AllowedSort","InvalidDirection","InvalidSortQuery","SortDirection"],"inputs":{"src/enums/sort_direction.ts":{"bytesInOutput":66},"src/exceptions/invalid_direction.ts":{"bytesInOutput":311},"src/sorts/sorts_callback.ts":{"bytesInOutput":187},"src/sorts/sorts_field.ts":{"bytesInOutput":135},"src/allowed_sort.ts":{"bytesInOutput":1415},"src/exceptions/invalid_sort_query.ts":{"bytesInOutput":634}},"bytes":3084},"build/filters_query-ZXNA4X75.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":3812},"build/filters_query-ZXNA4X75.js":{"imports":[{"path":"build/chunk-PBQFWYKU.js","kind":"import-statement"},{"path":"build/chunk-MKQ3HMMA.js","kind":"import-statement"},{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"collect.js","kind":"import-statement","external":true}],"exports":["extendModelQueryBuilderWithFiltersQuery"],"entryPoint":"src/bindings/filters_query.ts","inputs":{"src/bindings/filters_query.ts":{"bytesInOutput":1613}},"bytes":1838},"build/chunk-PBQFWYKU.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":26281},"build/chunk-PBQFWYKU.js":{"imports":[{"path":"build/chunk-MKQ3HMMA.js","kind":"import-statement"},{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"collect.js","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true}],"exports":["AllowedFilter","FilterOperator","InvalidFilterQuery"],"inputs":{"src/enums/filter_operator.ts":{"bytesInOutput":162},"src/allowed_filter.ts":{"bytesInOutput":3816},"src/filters/filters_exact.ts":{"bytesInOutput":1632},"src/filters/filters_partial.ts":{"bytesInOutput":1577},"src/filters/filters_begin_with_strict.ts":{"bytesInOutput":316},"src/filters/filters_callback.ts":{"bytesInOutput":175},"src/filters/filters_ends_with_strict.ts":{"bytesInOutput":312},"src/filters/filters_operator.ts":{"bytesInOutput":1750},"src/filters/filters_trashed.ts":{"bytesInOutput":371},"src/exceptions/invalid_filter_query.ts":{"bytesInOutput":671}},"bytes":11378},"build/chunk-MKQ3HMMA.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":12289},"build/chunk-MKQ3HMMA.js":{"imports":[{"path":"@adonisjs/core/http","kind":"import-statement","external":true},{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true}],"exports":["ApiQueryBuilderRequest","substrReplace"],"inputs":{"src/api_query_builder_request.ts":{"bytesInOutput":5775},"src/utils/helpers.ts":{"bytesInOutput":804}},"bytes":6732},"build/includes_query-2XNHHWJB.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":5167},"build/includes_query-2XNHHWJB.js":{"imports":[{"path":"build/chunk-OS75QJZN.js","kind":"import-statement"},{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"collect.js","kind":"import-statement","external":true}],"exports":["extendModelQueryBuilderWithIncludesQuery"],"entryPoint":"src/bindings/includes_query.ts","inputs":{"src/bindings/includes_query.ts":{"bytesInOutput":2315}},"bytes":2514},"build/chunk-OS75QJZN.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":12703},"build/chunk-OS75QJZN.js":{"imports":[{"path":"build/chunk-XIRHVLVQ.js","kind":"import-statement"},{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"@adonisjs/core/services/app","kind":"import-statement","external":true},{"path":"collect.js","kind":"import-statement","external":true},{"path":"@adonisjs/core/http","kind":"import-statement","external":true}],"exports":["AllowedInclude","InvalidIncludeQuery"],"inputs":{"src/allowed_include.ts":{"bytesInOutput":1841},"src/includes/included_callback.ts":{"bytesInOutput":173},"src/includes/included_count.ts":{"bytesInOutput":297},"src/includes/included_relationship.ts":{"bytesInOutput":1845},"src/exceptions/invalid_include_query.ts":{"bytesInOutput":835}},"bytes":5311},"build/chunk-XIRHVLVQ.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":383},"build/chunk-XIRHVLVQ.js":{"imports":[{"path":"@adonisjs/core/exceptions","kind":"import-statement","external":true}],"exports":["InvalidQuery"],"inputs":{"src/exceptions/invalid_query.ts":{"bytesInOutput":148}},"bytes":211}}}

package/build/providers/api_query_provider.d.ts

@@ -0,0 +1,42 @@
+import { type Request } from '@adonisjs/core/http';
+import { type ApplicationService } from '@adonisjs/core/types';
+import { type LucidModel } from '@adonisjs/lucid/types/model';
+import { type ExtractModelRelations } from '@adonisjs/lucid/types/relations';
+import { type Collection } from 'collect.js';
+import { type AllowedFilter } from '../src/allowed_filter.js';
+import { type AllowedInclude } from '../src/allowed_include.js';
+import { type AllowedSort } from '../src/allowed_sort.js';
+import { type ApiQueryBuilderRequest } from '../src/api_query_builder_request.js';
+import { type ExtractKeys, type HintedString, type SortUnionKeyParams } from '../src/types.js';
+export default class ApiQueryProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    boot(): Promise<void>;
+}
+declare module '@adonisjs/lucid/orm' {
+    interface ModelQueryBuilder {
+        withRequest(request: Request): this;
+        $apiQueryBuilderRequest: ApiQueryBuilderRequest;
+        allowedSorts(...sorts: (AllowedSort<LucidModel> | string)[]): this;
+        allowedSorts(sorts: (AllowedSort<LucidModel> | string)[]): this;
+        defaultSort(...sorts: (AllowedSort<LucidModel> | string)[]): this;
+        defaultSort(sorts: (AllowedSort<LucidModel> | string)[]): this;
+        allowedFilters(...filters: (AllowedFilter<LucidModel> | string)[]): this;
+        allowedFilters(filters: (AllowedFilter<LucidModel> | string)[]): this;
+        allowedIncludes(...includes: (Collection<AllowedInclude<LucidModel>> | string)[]): this;
+        allowedIncludes(includes: (Collection<AllowedInclude<LucidModel>> | string)[]): this;
+    }
+}
+declare module '@adonisjs/lucid/types/model' {
+    interface ModelQueryBuilderContract<Model extends LucidModel, Result = InstanceType<Model>> {
+        withRequest(request: Request): this;
+        allowedSorts(...sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;
+        allowedSorts(sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;
+        defaultSort(...sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;
+        defaultSort(sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;
+        allowedFilters(...filters: (AllowedFilter<Model> | ExtractKeys<ModelAttributes<InstanceType<Model>>>)[]): this;
+        allowedFilters(filters: (AllowedFilter<Model> | ExtractKeys<ModelAttributes<InstanceType<Model>>>)[]): this;
+        allowedIncludes(...includes: (Collection<AllowedInclude<Model>> | HintedString<ExtractModelRelations<InstanceType<Model>>>)[]): this;
+        allowedIncludes(includes: (Collection<AllowedInclude<Model>> | HintedString<ExtractModelRelations<InstanceType<Model>>>)[]): this;
+    }
+}

package/build/providers/api_query_provider.js

@@ -0,0 +1,30 @@
+// providers/api_query_provider.ts
+import { configProvider } from "@adonisjs/core";
+import { RuntimeException } from "@adonisjs/core/exceptions";
+import { ModelQueryBuilder } from "@adonisjs/lucid/orm";
+var ApiQueryProvider = class {
+  constructor(app) {
+    this.app = app;
+  }
+  async boot() {
+    const { extendModelQueryBuilderWithRequest } = await import("../api_query_request-QXOB4BN6.js");
+    const { extendModelQueryBuilderWithSortsQuery } = await import("../sorts_query-LUETK3FD.js");
+    const { extendModelQueryBuilderWithFiltersQuery } = await import("../filters_query-ZXNA4X75.js");
+    const { extendModelQueryBuilderWithIncludesQuery } = await import("../includes_query-2XNHHWJB.js");
+    const apiQueryConfigProvider = this.app.config.get("apiquery");
+    const config = await configProvider.resolve(this.app, apiQueryConfigProvider);
+    if (!config) {
+      throw new RuntimeException(
+        'Invalid "config/apiquery.ts" file. Make sure you are using the "defineConfig" method'
+      );
+    }
+    extendModelQueryBuilderWithRequest(ModelQueryBuilder);
+    extendModelQueryBuilderWithSortsQuery(ModelQueryBuilder, config);
+    extendModelQueryBuilderWithFiltersQuery(ModelQueryBuilder, config);
+    extendModelQueryBuilderWithIncludesQuery(ModelQueryBuilder, config);
+  }
+};
+export {
+  ApiQueryProvider as default
+};
+//# sourceMappingURL=api_query_provider.js.map

package/build/providers/api_query_provider.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../providers/api_query_provider.ts"],"sourcesContent":["import { configProvider } from '@adonisjs/core';\nimport { RuntimeException } from '@adonisjs/core/exceptions';\nimport { type Request } from '@adonisjs/core/http';\nimport { type ApplicationService } from '@adonisjs/core/types';\nimport { ModelQueryBuilder } from '@adonisjs/lucid/orm';\nimport { type LucidModel } from '@adonisjs/lucid/types/model';\nimport { type ExtractModelRelations } from '@adonisjs/lucid/types/relations';\nimport { type Collection } from 'collect.js';\nimport { type AllowedFilter } from '../src/allowed_filter.js';\nimport { type AllowedInclude } from '../src/allowed_include.js';\nimport { type AllowedSort } from '../src/allowed_sort.js';\nimport { type ApiQueryBuilderRequest } from '../src/api_query_builder_request.js';\nimport {\n  type ApiQueryConfig,\n  type ExtractKeys,\n  type HintedString,\n  type ResolvedApiQueryConfig,\n  type SortUnionKeyParams,\n} from '../src/types.js';\n\nexport default class ApiQueryProvider {\n  public constructor(protected app: ApplicationService) {}\n\n  public async boot(): Promise<void> {\n    const { extendModelQueryBuilderWithRequest } = await import('../src/bindings/api_query_request.js');\n    const { extendModelQueryBuilderWithSortsQuery } = await import('../src/bindings/sorts_query.js');\n    const { extendModelQueryBuilderWithFiltersQuery } = await import('../src/bindings/filters_query.js');\n    const { extendModelQueryBuilderWithIncludesQuery } = await import('../src/bindings/includes_query.js');\n    const apiQueryConfigProvider = this.app.config.get<ApiQueryConfig>('apiquery');\n    const config = await configProvider.resolve<ResolvedApiQueryConfig>(this.app, apiQueryConfigProvider);\n\n    if (!config) {\n      throw new RuntimeException(\n        'Invalid \"config/apiquery.ts\" file. Make sure you are using the \"defineConfig\" method',\n      );\n    }\n\n    extendModelQueryBuilderWithRequest(ModelQueryBuilder);\n    extendModelQueryBuilderWithSortsQuery(ModelQueryBuilder, config);\n    extendModelQueryBuilderWithFiltersQuery(ModelQueryBuilder, config);\n    extendModelQueryBuilderWithIncludesQuery(ModelQueryBuilder, config);\n  }\n}\n\ndeclare module '@adonisjs/lucid/orm' {\n  interface ModelQueryBuilder {\n    withRequest(request: Request): this;\n    $apiQueryBuilderRequest: ApiQueryBuilderRequest;\n\n    allowedSorts(...sorts: (AllowedSort<LucidModel> | string)[]): this;\n    allowedSorts(sorts: (AllowedSort<LucidModel> | string)[]): this;\n    defaultSort(...sorts: (AllowedSort<LucidModel> | string)[]): this;\n    defaultSort(sorts: (AllowedSort<LucidModel> | string)[]): this;\n\n    allowedFilters(...filters: (AllowedFilter<LucidModel> | string)[]): this;\n    allowedFilters(filters: (AllowedFilter<LucidModel> | string)[]): this;\n\n    allowedIncludes(...includes: (Collection<AllowedInclude<LucidModel>> | string)[]): this;\n    allowedIncludes(includes: (Collection<AllowedInclude<LucidModel>> | string)[]): this;\n  }\n}\n\ndeclare module '@adonisjs/lucid/types/model' {\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  interface ModelQueryBuilderContract<Model extends LucidModel, Result = InstanceType<Model>> {\n    withRequest(request: Request): this;\n\n    allowedSorts(...sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;\n    allowedSorts(sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;\n    defaultSort(...sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;\n    defaultSort(sorts: (AllowedSort<Model> | HintedString<SortUnionKeyParams<Model>>)[]): this;\n\n    allowedFilters(...filters: (AllowedFilter<Model> | ExtractKeys<ModelAttributes<InstanceType<Model>>>)[]): this;\n    allowedFilters(filters: (AllowedFilter<Model> | ExtractKeys<ModelAttributes<InstanceType<Model>>>)[]): this;\n\n    allowedIncludes(\n      ...includes: (Collection<AllowedInclude<Model>> | HintedString<ExtractModelRelations<InstanceType<Model>>>)[]\n    ): this;\n    allowedIncludes(\n      includes: (Collection<AllowedInclude<Model>> | HintedString<ExtractModelRelations<InstanceType<Model>>>)[],\n    ): this;\n  }\n}\n"],"mappings":";AAAA,SAAS,sBAAsB;AAC/B,SAAS,wBAAwB;AAGjC,SAAS,yBAAyB;AAgBlC,IAAqB,mBAArB,MAAsC;AAAA,EAC7B,YAAsB,KAAyB;AAAzB;AAAA,EAA0B;AAAA,EAEvD,MAAa,OAAsB;AACjC,UAAM,EAAE,mCAAmC,IAAI,MAAM,OAAO,kCAAsC;AAClG,UAAM,EAAE,sCAAsC,IAAI,MAAM,OAAO,4BAAgC;AAC/F,UAAM,EAAE,wCAAwC,IAAI,MAAM,OAAO,8BAAkC;AACnG,UAAM,EAAE,yCAAyC,IAAI,MAAM,OAAO,+BAAmC;AACrG,UAAM,yBAAyB,KAAK,IAAI,OAAO,IAAoB,UAAU;AAC7E,UAAM,SAAS,MAAM,eAAe,QAAgC,KAAK,KAAK,sBAAsB;AAEpG,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,uCAAmC,iBAAiB;AACpD,0CAAsC,mBAAmB,MAAM;AAC/D,4CAAwC,mBAAmB,MAAM;AACjE,6CAAyC,mBAAmB,MAAM;AAAA,EACpE;AACF;","names":[]}

package/build/sorts_query-LUETK3FD.js

@@ -0,0 +1,63 @@
+import {
+  AllowedSort,
+  InvalidSortQuery
+} from "./chunk-HQN7LHVO.js";
+import "./chunk-XIRHVLVQ.js";
+
+// src/bindings/sorts_query.ts
+import { collect } from "collect.js";
+var extendModelQueryBuilderWithSortsQuery = function(builder, config) {
+  const ensureAllSortsExist = (self) => {
+    if (config.disableInvalidSortQueryException) {
+      return;
+    }
+    const requestedSortNames = self.$apiQueryBuilderRequest.sorts().map((sort) => sort.replace(/^-+/, ""));
+    const allowedSortNames = self._allowedSorts.map((sort) => sort.getName());
+    const unknownSort = requestedSortNames.diff(allowedSortNames);
+    if (unknownSort.isNotEmpty()) {
+      throw InvalidSortQuery.sortsNotAllowed(unknownSort.all(), allowedSortNames.all());
+    }
+  };
+  const findSort = (self, property) => {
+    return self._allowedSorts.first((sort) => sort.isSort(property));
+  };
+  const addRequestedSortsToQuery = (self) => {
+    self.$apiQueryBuilderRequest.sorts().each((property) => {
+      const descending = property.startsWith("-");
+      const key = property.replace(/^-+/, "");
+      const sort = findSort(self, key);
+      sort?.sort(self, descending);
+    });
+  };
+  builder.macro("allowedSorts", function(...sorts) {
+    const arraySorts = Array.isArray(sorts.at(0)) ? sorts.at(0) : sorts;
+    this._allowedSorts = collect(arraySorts).map((sort) => {
+      if (sort instanceof AllowedSort) {
+        return sort;
+      }
+      return AllowedSort.field(sort.replace(/^-+/, ""));
+    });
+    ensureAllSortsExist(this);
+    addRequestedSortsToQuery(this);
+    return this;
+  });
+  builder.macro("defaultSort", function(...sorts) {
+    if (this.$apiQueryBuilderRequest.sorts().isNotEmpty()) {
+      return this;
+    }
+    const arraySorts = Array.isArray(sorts.at(0)) ? sorts.at(0) : sorts;
+    collect(arraySorts).map((sort) => {
+      if (sort instanceof AllowedSort) {
+        return sort;
+      }
+      return AllowedSort.field(sort);
+    }).each((sort) => {
+      sort.sort(this);
+    });
+    return this;
+  });
+};
+export {
+  extendModelQueryBuilderWithSortsQuery
+};
+//# sourceMappingURL=sorts_query-LUETK3FD.js.map

package/build/sorts_query-LUETK3FD.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/bindings/sorts_query.ts"],"sourcesContent":["import { type ModelQueryBuilder } from '@adonisjs/lucid/orm';\nimport { type LucidModel } from '@adonisjs/lucid/types/model';\nimport { collect, type Collection } from 'collect.js';\nimport { AllowedSort } from '../allowed_sort.js';\nimport { InvalidSortQuery } from '../exceptions/invalid_sort_query.js';\nimport { type ResolvedApiQueryConfig } from '../types.js';\n\ntype ModelQueryBuilderWithAllowedSorts = ModelQueryBuilder & { _allowedSorts: Collection<AllowedSort<LucidModel>> };\n\nexport const extendModelQueryBuilderWithSortsQuery = function (\n  builder: typeof ModelQueryBuilder,\n  config: ResolvedApiQueryConfig,\n): void {\n  const ensureAllSortsExist = (self: ModelQueryBuilderWithAllowedSorts): void => {\n    if (config.disableInvalidSortQueryException) {\n      return;\n    }\n\n    const requestedSortNames = self.$apiQueryBuilderRequest.sorts().map((sort) => sort.replace(/^-+/, ''));\n    const allowedSortNames = self._allowedSorts.map((sort) => sort.getName());\n    const unknownSort = requestedSortNames.diff(allowedSortNames);\n\n    if (unknownSort.isNotEmpty()) {\n      throw InvalidSortQuery.sortsNotAllowed(unknownSort.all(), allowedSortNames.all());\n    }\n  };\n\n  const findSort = (self: ModelQueryBuilderWithAllowedSorts, property: string): AllowedSort<LucidModel> | undefined => {\n    return self._allowedSorts.first((sort) => sort.isSort(property));\n  };\n\n  const addRequestedSortsToQuery = (self: ModelQueryBuilderWithAllowedSorts): void => {\n    self.$apiQueryBuilderRequest.sorts().each((property) => {\n      const descending = property.startsWith('-');\n      const key = property.replace(/^-+/, '');\n      const sort = findSort(self, key);\n\n      sort?.sort(self, descending);\n    });\n  };\n\n  builder.macro('allowedSorts', function (this: ModelQueryBuilderWithAllowedSorts, ...sorts) {\n    const arraySorts = Array.isArray(sorts.at(0)) ? sorts.at(0) : (sorts as (AllowedSort<LucidModel> | string)[]);\n\n    this._allowedSorts = collect(arraySorts).map((sort) => {\n      if (sort instanceof AllowedSort) {\n        return sort;\n      }\n\n      return AllowedSort.field(sort.replace(/^-+/, ''));\n    });\n\n    ensureAllSortsExist(this);\n    addRequestedSortsToQuery(this);\n\n    return this;\n  });\n\n  builder.macro('defaultSort', function (this: ModelQueryBuilderWithAllowedSorts, ...sorts) {\n    if (this.$apiQueryBuilderRequest.sorts().isNotEmpty()) {\n      // We've got requested sorts. No need to parse defaults.\n\n      return this;\n    }\n\n    const arraySorts = Array.isArray(sorts.at(0)) ? sorts.at(0) : (sorts as (AllowedSort<LucidModel> | string)[]);\n\n    collect(arraySorts)\n      .map((sort) => {\n        if (sort instanceof AllowedSort) {\n          return sort;\n        }\n\n        return AllowedSort.field(sort);\n      })\n      .each((sort) => {\n        sort.sort(this);\n      });\n\n    return this;\n  });\n};\n"],"mappings":";;;;;;;AAEA,SAAS,eAAgC;AAOlC,IAAM,wCAAwC,SACnD,SACA,QACM;AACN,QAAM,sBAAsB,CAAC,SAAkD;AAC7E,QAAI,OAAO,kCAAkC;AAC3C;AAAA,IACF;AAEA,UAAM,qBAAqB,KAAK,wBAAwB,MAAM,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,OAAO,EAAE,CAAC;AACrG,UAAM,mBAAmB,KAAK,cAAc,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC;AACxE,UAAM,cAAc,mBAAmB,KAAK,gBAAgB;AAE5D,QAAI,YAAY,WAAW,GAAG;AAC5B,YAAM,iBAAiB,gBAAgB,YAAY,IAAI,GAAG,iBAAiB,IAAI,CAAC;AAAA,IAClF;AAAA,EACF;AAEA,QAAM,WAAW,CAAC,MAAyC,aAA0D;AACnH,WAAO,KAAK,cAAc,MAAM,CAAC,SAAS,KAAK,OAAO,QAAQ,CAAC;AAAA,EACjE;AAEA,QAAM,2BAA2B,CAAC,SAAkD;AAClF,SAAK,wBAAwB,MAAM,EAAE,KAAK,CAAC,aAAa;AACtD,YAAM,aAAa,SAAS,WAAW,GAAG;AAC1C,YAAM,MAAM,SAAS,QAAQ,OAAO,EAAE;AACtC,YAAM,OAAO,SAAS,MAAM,GAAG;AAE/B,YAAM,KAAK,MAAM,UAAU;AAAA,IAC7B,CAAC;AAAA,EACH;AAEA,UAAQ,MAAM,gBAAgB,YAAsD,OAAO;AACzF,UAAM,aAAa,MAAM,QAAQ,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,IAAK;AAE/D,SAAK,gBAAgB,QAAQ,UAAU,EAAE,IAAI,CAAC,SAAS;AACrD,UAAI,gBAAgB,aAAa;AAC/B,eAAO;AAAA,MACT;AAEA,aAAO,YAAY,MAAM,KAAK,QAAQ,OAAO,EAAE,CAAC;AAAA,IAClD,CAAC;AAED,wBAAoB,IAAI;AACxB,6BAAyB,IAAI;AAE7B,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,MAAM,eAAe,YAAsD,OAAO;AACxF,QAAI,KAAK,wBAAwB,MAAM,EAAE,WAAW,GAAG;AAGrD,aAAO;AAAA,IACT;AAEA,UAAM,aAAa,MAAM,QAAQ,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,IAAK;AAE/D,YAAQ,UAAU,EACf,IAAI,CAAC,SAAS;AACb,UAAI,gBAAgB,aAAa;AAC/B,eAAO;AAAA,MACT;AAEA,aAAO,YAAY,MAAM,IAAI;AAAA,IAC/B,CAAC,EACA,KAAK,CAAC,SAAS;AACd,WAAK,KAAK,IAAI;AAAA,IAChB,CAAC;AAEH,WAAO;AAAA,EACT,CAAC;AACH;","names":[]}

package/build/src/allowed_filter.d.ts

@@ -0,0 +1,37 @@
+import { type LucidModel, type ModelAttributes, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
+import { type StrictValuesWithoutRaw } from '@adonisjs/lucid/types/querybuilder';
+import { Collection } from 'collect.js';
+import { type FilterOperator } from './enums/filter_operator.js';
+import { type ExtractKeys, type Filter } from './types.js';
+export declare class AllowedFilter<Model extends LucidModel> {
+    static setFilterArrayValueDelimiter(delimiter?: string): void;
+    static exact<Model extends LucidModel>(name: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, addRelationConstraint?: boolean, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static partial<Model extends LucidModel>(name: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, addRelationConstraint?: boolean, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static beginsWithStrict<Model extends LucidModel>(name: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, addRelationConstraint?: boolean, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static endsWithStrict<Model extends LucidModel>(name: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, addRelationConstraint?: boolean, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static callback<Model extends LucidModel>(name: string, callback: (query: ModelQueryBuilderContract<Model>, value: unknown, property: string) => void, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static trashed<Model extends LucidModel>(name?: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>): AllowedFilter<Model>;
+    static custom<Model extends LucidModel>(name: string, filterClass: Filter<Model>, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    static operator<Model extends LucidModel>(name: string, filterOperator: FilterOperator, boolean?: 'and' | 'or', internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>, addRelationConstraint?: boolean, arrayValueDelimiter?: string): AllowedFilter<Model>;
+    protected name: string;
+    protected filterClass: Filter<Model>;
+    protected internalName: string;
+    protected ignored: Collection<unknown>;
+    protected default: unknown;
+    protected $hasDefault: boolean;
+    protected nullable: boolean;
+    constructor(name: string, filterClass: Filter<Model>, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>);
+    filter(query: ModelQueryBuilderContract<Model>, value: unknown): void;
+    getFilterClass(): Filter<Model>;
+    getName(): string;
+    isForFilter(filterName: string): boolean;
+    ignore(...values: unknown[]): this;
+    getIgnored(): unknown[];
+    getInternalName(): string;
+    setDefault(defaultValue: unknown): this;
+    getDefault(): unknown;
+    hasDefault(): boolean;
+    setNullable(nullable?: boolean): this;
+    unsetDefault(): this;
+    protected resolveValueForFiltering(value: unknown): StrictValuesWithoutRaw | null;
+}

package/build/src/allowed_include.d.ts

@@ -0,0 +1,17 @@
+import { type LucidModel, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
+import { type ModelRelations } from '@adonisjs/lucid/types/relations';
+import { Collection } from 'collect.js';
+import { type Include } from './types.js';
+export declare class AllowedInclude<Model extends LucidModel> {
+    static relationship<ParentModel extends LucidModel>(name: string, internalName?: string): Collection<AllowedInclude<ParentModel>>;
+    static count<ParentModel extends LucidModel>(name: string, internalName?: string): Collection<AllowedInclude<ParentModel>>;
+    static callback<ParentModel extends LucidModel, RelatedModel extends LucidModel>(name: string, callback: (query: ModelRelations<RelatedModel, ParentModel>['builder'] | ModelRelations<RelatedModel, ParentModel>['subQuery']) => void, internalName?: string): Collection<AllowedInclude<ParentModel>>;
+    static custom<ParentModel extends LucidModel>(name: string, includeClass: Include<ParentModel>, internalName?: string): Collection<AllowedInclude<ParentModel>>;
+    protected internalName: string;
+    protected name: string;
+    protected includeClass: Include<Model>;
+    constructor(name: string, includeClass: Include<Model>, internalName?: string);
+    include(query: ModelQueryBuilderContract<Model>): void;
+    getName(): string;
+    isForInclude(includeName: string): boolean;
+}

package/build/src/allowed_sort.d.ts

@@ -0,0 +1,18 @@
+import { type LucidModel, type ModelAttributes, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
+import { type ExtractKeys, type Sort } from './types.js';
+export declare class AllowedSort<Model extends LucidModel> {
+    static parseSortDirection(name: string): string;
+    static field<Model extends LucidModel>(name: string, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>): AllowedSort<Model>;
+    static custom<Model extends LucidModel>(name: string, sortClass: Sort<Model>, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>): AllowedSort<Model>;
+    static callback<Model extends LucidModel>(name: string, callback: (query: ModelQueryBuilderContract<Model>, descending: boolean, property: string) => void, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>): AllowedSort<Model>;
+    protected defaultDirection: string;
+    protected internalName: string;
+    protected name: string;
+    protected sortClass: Sort<Model>;
+    constructor(name: string, sortClass: Sort<Model>, internalName?: ExtractKeys<ModelAttributes<InstanceType<Model>>>);
+    sort(query: ModelQueryBuilderContract<Model>, descending?: boolean): void;
+    getName(): string;
+    isSort(sortName: string): boolean;
+    getInternalName(): string;
+    setDefaultDirection(defaultDirection: string): this;
+}

package/build/src/api_query_builder_request.d.ts

@@ -0,0 +1,31 @@
+import { type Request } from '@adonisjs/core/http';
+import { Collection } from 'collect.js';
+export declare class ApiQueryBuilderRequest {
+    protected static includesArrayValueDelimiter: string;
+    protected static appendsArrayValueDelimiter: string;
+    protected static fieldsArrayValueDelimiter: string;
+    protected static sortsArrayValueDelimiter: string;
+    protected static filterArrayValueDelimiter: string;
+    static setArrayValueDelimiter(delimiter: string): void;
+    static setIncludesArrayValueDelimiter(includesArrayValueDelimiter: string): void;
+    static setAppendsArrayValueDelimiter(appendsArrayValueDelimiter: string): void;
+    static setFieldsArrayValueDelimiter(fieldsArrayValueDelimiter: string): void;
+    static setSortsArrayValueDelimiter(sortsArrayValueDelimiter: string): void;
+    static setFilterArrayValueDelimiter(filterArrayValueDelimiter: string): void;
+    static getIncludesArrayValueDelimiter(): string;
+    static getAppendsArrayValueDelimiter(): string;
+    static getFieldsArrayValueDelimiter(): string;
+    static getSortsArrayValueDelimiter(): string;
+    static getFilterArrayValueDelimiter(): string;
+    static resetDelimiters(): void;
+    static fromRequest(request: Request): ApiQueryBuilderRequest;
+    private readonly _request;
+    constructor(request?: Request);
+    includes(): Collection<string>;
+    appends(): Collection<unknown>;
+    fields(): Collection<unknown>;
+    sorts(): Collection<string>;
+    filters(): Collection<unknown>;
+    protected getFilterValue(value: unknown): unknown;
+    protected getRequestData<T = unknown>(key: string, defaultValue?: T): T;
+}

package/build/src/bindings/api_query_request.d.ts

@@ -0,0 +1,2 @@
+import { type ModelQueryBuilder } from '@adonisjs/lucid/orm';
+export declare const extendModelQueryBuilderWithRequest: (builder: typeof ModelQueryBuilder) => void;

package/build/src/bindings/filters_query.d.ts

@@ -0,0 +1,3 @@
+import { type ModelQueryBuilder } from '@adonisjs/lucid/orm';
+import { type ResolvedApiQueryConfig } from '../types.js';
+export declare const extendModelQueryBuilderWithFiltersQuery: (builder: typeof ModelQueryBuilder, config: ResolvedApiQueryConfig) => void;

package/build/src/bindings/includes_query.d.ts

@@ -0,0 +1,3 @@
+import { type ModelQueryBuilder } from '@adonisjs/lucid/orm';
+import { type ResolvedApiQueryConfig } from '../types.js';
+export declare const extendModelQueryBuilderWithIncludesQuery: (builder: typeof ModelQueryBuilder, config: ResolvedApiQueryConfig) => void;

package/build/src/bindings/sorts_query.d.ts

@@ -0,0 +1,3 @@
+import { type ModelQueryBuilder } from '@adonisjs/lucid/orm';
+import { type ResolvedApiQueryConfig } from '../types.js';
+export declare const extendModelQueryBuilderWithSortsQuery: (builder: typeof ModelQueryBuilder, config: ResolvedApiQueryConfig) => void;

package/build/src/define_config.d.ts

@@ -0,0 +1,3 @@
+import { type ConfigProvider } from '@adonisjs/core/types';
+import { type ApiQueryConfig, type ResolvedApiQueryConfig } from './types.js';
+export declare const defineConfig: (config: ApiQueryConfig) => ConfigProvider<ResolvedApiQueryConfig>;

package/build/src/enums/filter_operator.d.ts

@@ -0,0 +1,10 @@
+export declare const FilterOperator: {
+    readonly Dynamic: "";
+    readonly Equal: "=";
+    readonly LessThan: "<";
+    readonly GreaterThan: ">";
+    readonly LessThanOrEqual: "<=";
+    readonly GreaterThanOrEqual: ">=";
+    readonly NotEqual: "<>";
+};
+export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];

package/build/src/enums/sort_direction.d.ts

@@ -0,0 +1,5 @@
+export declare const SortDirection: {
+    readonly Ascending: "asc";
+    readonly Descending: "desc";
+};
+export type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];

package/build/src/exceptions/allowed_fields_must_be_called_before_allowed_includes.d.ts

@@ -0,0 +1,6 @@
+import { Exception } from '@adonisjs/core/exceptions';
+export declare class AllowedFieldsMustBeCalledBeforeAllowedIncludes extends Exception {
+    static readonly code: 'E_BAD_METHOD_CALL_EXCEPTION';
+    static readonly status: 500;
+    constructor();
+}

package/build/src/exceptions/invalid_append_query.d.ts

@@ -0,0 +1,5 @@
+import { InvalidQuery } from './invalid_query.js';
+export declare class InvalidAppendQuery extends InvalidQuery {
+    constructor(appendsNotAllowed: string[], allowedAppends: string[]);
+    static appendsNotAllowed(appendsNotAllowed: string[], allowedAppends: string[]): InvalidAppendQuery;
+}

package/build/src/exceptions/invalid_direction.d.ts

@@ -0,0 +1,4 @@
+import { Exception } from '@adonisjs/core/exceptions';
+export declare class InvalidDirection extends Exception {
+    static make(sort: string): InvalidDirection;
+}

package/build/src/exceptions/invalid_field_query.d.ts

@@ -0,0 +1,5 @@
+import { InvalidQuery } from './invalid_query.js';
+export declare class InvalidFieldQuery extends InvalidQuery {
+    constructor(unknownFields: string[], allowedFields: string[]);
+    static fieldsNotAllowed(unknownFields: string[], allowedFields: string[]): InvalidFieldQuery;
+}