crud-query-parser 0.0.1

package/LICENSE

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

package/README.md

@@ -0,0 +1,154 @@
+# crud-query-parser
+
+This library parses HTTP requests and converts them to TypeORM query builders, allowing advanced filtering, column selection, pagination and relations.
+
+## Install
+
+```sh
+npm install @crud-query-parser/core
+```
+
+### Other modules
+
+- `@crud-query-parser/typeorm`: TypeORM adapter
+- `@crud-query-parser/nestjs`: NestJS utilities
+
+## Usage
+
+You have to pick a request parser and a query adapter.
+
+```ts
+const userRepository = AppDataSource.getRepository(UserEntity); // TypeORM repository
+
+// ...
+
+// The request query object
+// This object will likely come from the HTTP request
+const requestQuery = { ... };  
+
+// Parses the query into a CrudRequest object
+const crudRequest = parser.parse(requestQuery);
+
+// Using the query adapter, you can query in your ORM from the CrudRequest
+const result = adapter.getMany(userRepository.createQueryBuilder(), crudRequest); // GetManyResult<UserEntity>
+
+// The result object has properties like data, page, total
+console.log(result);
+```
+
+## Request parsers
+
+### CRUD
+
+This parser fully compatible with `@nestjsx/crud`
+
+```ts
+import { CrudRequestParser } from 'crud-query-parser/parsers/crud';
+
+const parser = new CrudRequestParser();
+```
+
+## Database adapters
+
+### TypeORM
+
+This adapter works with TypeORM 0.3.x and 0.2.x
+
+```ts
+import { TypeormQueryAdapter } from 'crud-query-parser/adapters/typeorm';
+
+const adapter = new TypeormQueryAdapter();
+
+// 
+```
+
+## Helpers
+
+### NestJS
+
+The NestJS integration has OpenAPI support and decorators that automatically parses the request.
+
+Sample code:
+
+```ts
+@Controller('users')
+export class UserController {
+
+  @Get()
+  @Crud(CrudRequestParser)
+  public async getMany(@ParseCrudRequest() crudRequest: CrudRequest) {
+    return this.service.getMany(crudRequest);
+  }
+
+}
+```
+
+## Filters
+
+You may need to filter what the user can or cannot query. You can modify the `CrudRequest` object as needed.
+
+There are a few filters provided by the library, which are listed below.
+
+### Enforce a "where" condition
+
+This filter will add the condition on top of all other where conditions
+
+```ts
+import { ensureCondition } from 'crud-query-parser/filters';
+
+// ...
+
+crudRequest = ensureCondition(crudRequest, {
+  field: ['isActive'],
+  operator: ParsedRequestWhereOperator.EQ,
+  value: true,
+});
+```
+
+### Ensure page limit
+
+This filter will ensure that the requested limit does not go above the maximum.
+It also sets the default limit whenever the limit is omitted. 
+
+```ts
+import { ensureLimit } from 'crud-query-parser/filters';
+
+// ...
+
+const defaultLimit = 25;
+const maxLimit = 100;
+
+crudRequest = ensureLimit(crudRequest, defaultLimit, maxLimit);
+```
+
+### Filter property access
+
+This filter removes any property from the request that is not in the allowlist.
+It removes unallowed properties from the select fields, where conditions, relations and sorting.
+
+```ts
+import { filterProperties } from 'crud-query-parser/filters';
+
+// ...
+
+crudRequest = filterProperties(crudRequest, [
+  'id',
+  'name',
+  'posts',
+  'posts.id',
+  'posts.name',
+]);
+```
+
+### Filter relations
+
+This filter removes any relation from the request that is not in the allowlist.
+It's the same as the `filterProperties` but only filters relations.
+
+```ts
+import { filterRelations } from 'crud-query-parser/filters';
+
+// ...
+
+crudRequest = filterRelations(crudRequest, ['posts']);
+```

package/dist/adapters/typeorm/index.d.mts

@@ -0,0 +1,84 @@
+import { SelectQueryBuilder, ObjectLiteral, WhereExpressionBuilder } from 'typeorm';
+import { Q as QueryAdapter, G as GetManyResult } from '../../query-adapter-BliD9hJN.mjs';
+import { c as CrudRequest, P as ParsedRequestSelect, a as CrudRequestRelation, b as CrudRequestOrder, d as CrudRequestWhere, g as CrudRequestWhereField } from '../../crud-request-CvDKp6Iy.mjs';
+
+/**
+ * Adapts queries to TypeORM query builder object
+ */
+declare class TypeormQueryAdapter implements QueryAdapter<SelectQueryBuilder<any>, ObjectLiteral> {
+    /**
+     * @inheritDoc
+     */
+    build<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * @inheritDoc
+     */
+    getOne<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<E | null>;
+    /**
+     * @inheritDoc
+     */
+    getMany<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<GetManyResult<E>>;
+    /**
+     * Creates a query filtered from the parsed request
+     *
+     * @param qb The base query builder
+     * @param query The parsed query
+     */
+    protected createBaseQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * Paginates a query based on the parsed request
+     *
+     * @param qb The query builder
+     * @param query The parsed query
+     */
+    protected paginateQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * Adapts a select
+     *
+     * @param qb The query builder
+     * @param select The parsed select fields
+     */
+    protected adaptSelect<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, select: ParsedRequestSelect): void;
+    /**
+     * Adapts the join relation list
+     *
+     * @param qb The query builder
+     * @param relations The parsed relation list
+     */
+    protected adaptRelations<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, relations: CrudRequestRelation[]): void;
+    /**
+     * Adapts the order by list
+     *
+     * @param qb The query builder
+     * @param ordering The parsed ordering
+     */
+    protected adaptOrder<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, ordering: CrudRequestOrder[]): void;
+    /**
+     * Adapts a where condition
+     *
+     * @param qb The query builder
+     * @param where The quere condition
+     * @param or Whether this where condition is AND/OR
+     * @param params The registered parameter name list
+     */
+    protected adaptWhere(qb: WhereExpressionBuilder, where: CrudRequestWhere, or: boolean, params: string[]): void;
+    /**
+     * Creates a query parameter name based on a field
+     *
+     * @param paramsDefined The array the parameter will be registered onto
+     * @param field The field path
+     */
+    protected createParam(paramsDefined: string[], field: string[]): string;
+    /**
+     * Maps where operators to a pseudo-SQL statement and a parameter map
+     *
+     * @param where The where condition
+     * @param param The parameter name
+     */
+    protected mapWhereOperators(where: CrudRequestWhereField, param: string): {
+        where: string;
+        params: ObjectLiteral;
+    };
+}
+
+export { TypeormQueryAdapter };

package/dist/adapters/typeorm/index.d.ts

@@ -0,0 +1,84 @@
+import { SelectQueryBuilder, ObjectLiteral, WhereExpressionBuilder } from 'typeorm';
+import { Q as QueryAdapter, G as GetManyResult } from '../../query-adapter-Vebxws3V.js';
+import { c as CrudRequest, P as ParsedRequestSelect, a as CrudRequestRelation, b as CrudRequestOrder, d as CrudRequestWhere, g as CrudRequestWhereField } from '../../crud-request-CvDKp6Iy.js';
+
+/**
+ * Adapts queries to TypeORM query builder object
+ */
+declare class TypeormQueryAdapter implements QueryAdapter<SelectQueryBuilder<any>, ObjectLiteral> {
+    /**
+     * @inheritDoc
+     */
+    build<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * @inheritDoc
+     */
+    getOne<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<E | null>;
+    /**
+     * @inheritDoc
+     */
+    getMany<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<GetManyResult<E>>;
+    /**
+     * Creates a query filtered from the parsed request
+     *
+     * @param qb The base query builder
+     * @param query The parsed query
+     */
+    protected createBaseQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * Paginates a query based on the parsed request
+     *
+     * @param qb The query builder
+     * @param query The parsed query
+     */
+    protected paginateQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E>;
+    /**
+     * Adapts a select
+     *
+     * @param qb The query builder
+     * @param select The parsed select fields
+     */
+    protected adaptSelect<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, select: ParsedRequestSelect): void;
+    /**
+     * Adapts the join relation list
+     *
+     * @param qb The query builder
+     * @param relations The parsed relation list
+     */
+    protected adaptRelations<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, relations: CrudRequestRelation[]): void;
+    /**
+     * Adapts the order by list
+     *
+     * @param qb The query builder
+     * @param ordering The parsed ordering
+     */
+    protected adaptOrder<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, ordering: CrudRequestOrder[]): void;
+    /**
+     * Adapts a where condition
+     *
+     * @param qb The query builder
+     * @param where The quere condition
+     * @param or Whether this where condition is AND/OR
+     * @param params The registered parameter name list
+     */
+    protected adaptWhere(qb: WhereExpressionBuilder, where: CrudRequestWhere, or: boolean, params: string[]): void;
+    /**
+     * Creates a query parameter name based on a field
+     *
+     * @param paramsDefined The array the parameter will be registered onto
+     * @param field The field path
+     */
+    protected createParam(paramsDefined: string[], field: string[]): string;
+    /**
+     * Maps where operators to a pseudo-SQL statement and a parameter map
+     *
+     * @param where The where condition
+     * @param param The parameter name
+     */
+    protected mapWhereOperators(where: CrudRequestWhereField, param: string): {
+        where: string;
+        params: ObjectLiteral;
+    };
+}
+
+export { TypeormQueryAdapter };

package/dist/adapters/typeorm/index.js

@@ -0,0 +1,2 @@
+"use strict";var c=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var _=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var u=(i,t)=>c(i,"name",{value:t,configurable:!0});var O=(i,t)=>{for(var e in t)c(i,e,{get:t[e],enumerable:!0})},S=(i,t,e,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of _(t))!y.call(i,s)&&s!==e&&c(i,s,{get:()=>t[s],enumerable:!(r=f(t,s))||r.enumerable});return i};var w=i=>S(c({},"__esModule",{value:!0}),i);var R={};O(R,{TypeormQueryAdapter:()=>N});module.exports=w(R);var E=require("typeorm");function a(i,t,e=0){if(!Array.isArray(t)||t.length<e)throw new Error(`${i} must be an array with at least ${e} items`);return t}u(a,"ensureArray");function d(i,t){if(t)throw new Error(`${i} must be null`)}u(d,"ensureFalsy");var N=class{static{u(this,"TypeormQueryAdapter")}build(t,e){return t=this.createBaseQuery(t,e),t=this.paginateQuery(t,e),t}async getOne(t,e){return await this.createBaseQuery(t,e).getOne()??null}async getMany(t,e){let r=this.createBaseQuery(t,e),n=await this.paginateQuery(r.clone(),e).getMany(),o=await r.getCount(),l=e.offset??0,$=e.limit??o,L=n.length,h=Math.floor(l/$)+1,T=Math.ceil(o/$);return{data:n,count:L,page:h,pageCount:T,total:o}}createBaseQuery(t,e){let r=[];return this.adaptSelect(t,e.select),this.adaptRelations(t,e.relations),this.adaptWhere(t,e.where,!1,r),this.adaptOrder(t,e.order),t}paginateQuery(t,e){return t.limit(e.limit).offset(e.offset)}adaptSelect(t,e){t.addSelect(e.map(r=>r.field.join(".")))}adaptRelations(t,e){for(let r of e){let s=r.field.join("."),n=r.alias||s.replace(".","_");t.leftJoin(s,n)}}adaptOrder(t,e){for(let r of e){let s=r.field.join(".");t.addOrderBy(s,r.order)}}adaptWhere(t,e,r,s){let n=(r?t.orWhere:t.andWhere).bind(t);if(e.or&&e.or.length>0)n(new E.Brackets(o=>e.or.forEach(l=>this.adaptWhere(o,l,!0,s))));else if(e.and&&e.and.length>0)n(new E.Brackets(o=>e.and.forEach(l=>this.adaptWhere(o,l,!1,s))));else if(e.field){let o=this.createParam(s,e.field),l=this.mapWhereOperators(e,o);n(l.where,l.params)}}createParam(t,e){let r=e.length>0?e[e.length-1]:"",s,n=0;do s="req_"+r+"_"+n,n++;while(t.includes(s));return t.push(s),s}mapWhereOperators(t,e){let r=t.field.join("."),s=t.operator,n=t.value;switch(s){case"eq":return{where:`${r} = :${e}`,params:{[e]:n}};case"neq":return{where:`${r} != :${e}`,params:{[e]:n}};case"gt":return{where:`${r} > :${e}`,params:{[e]:n}};case"gte":return{where:`${r} >= :${e}`,params:{[e]:n}};case"lt":return{where:`${r} < :${e}`,params:{[e]:n}};case"lte":return{where:`${r} <= :${e}`,params:{[e]:n}};case"starts":return{where:`${r} LIKE :${e}`,params:{[e]:`${n}%`}};case"ends":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}`}};case"contains":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}%`}};case"not_contains":return{where:`${r} NOT LIKE :${e}`,params:{[e]:`%${n}%`}};case"in":return n=a("IN operator",n,1),{where:`${r} IN (:...${e})`,params:{[e]:n}};case"not_in":return n=a("NOT IN operator",n,1),{where:`${r} NOT IN (:...${e})`,params:{[e]:n}};case"between":let o=a("BETWEEN operator",n,2);return{where:`${r} BETWEEN :${e}_start AND :${e}_end`,params:{[`${e}_start`]:o[0],[`${e}_end`]:o[1]}};case"is_null":return d("IS NULL operator",n),{where:`${r} IS NULL`,params:{}};case"not_null":return d("NOT NULL operator",n),{where:`${r} IS NOT NULL`,params:{}};case"eq_lower":return{where:`LOWER(${r}) = :${e}`,params:{[e]:n}};case"neq_lower":return{where:`LOWER(${r}) != :${e}`,params:{[e]:n}};case"starts_lower":return{where:`LOWER(${r}) LIKE :${e}`,params:{[e]:`${n}%`}};case"ends_lower":return{where:`LOWER(${r}) LIKE :${e}`,params:{[e]:`%${n}`}};case"contains_lower":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}%`}};case"not_contains_lower":return{where:`${r} NOT LIKE :${e}`,params:{[e]:`%${n}%`}};case"in_lower":return a("IN operator",n,1),{where:`${r} IN (...:${e})`,params:{[e]:n}};case"not_in_lower":return a("NOT IN operator",n,1),{where:`${r} NOT IN (...:${e})`,params:{[e]:n}};default:throw new Error(`Unknown operator "${s}"`)}}};0&&(module.exports={TypeormQueryAdapter});
+//# sourceMappingURL=index.js.map

package/dist/adapters/typeorm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/adapters/typeorm/index.ts","../../../src/adapters/typeorm/typeorm.query-adapter.ts","../../../src/utils/functions.ts"],"sourcesContent":["\r\nexport * from './typeorm.query-adapter';\r\n","import { Brackets, ObjectLiteral, SelectQueryBuilder, WhereExpressionBuilder } from 'typeorm';\r\nimport { QueryAdapter } from '../../models/query-adapter';\r\nimport {\r\n  CrudRequest,\r\n  CrudRequestOrder,\r\n  CrudRequestRelation,\r\n  ParsedRequestSelect\r\n} from '../../models/crud-request';\r\nimport {\r\n  CrudRequestWhere,\r\n  CrudRequestWhereField,\r\n  CrudRequestWhereOperator\r\n} from '../../models/crud-request-where';\r\nimport { GetManyResult } from '../../models/get-many-result';\r\nimport { ensureArray, ensureFalsy } from '../../utils/functions';\r\n\r\n/**\r\n * Adapts queries to TypeORM query builder object\r\n */\r\nexport class TypeormQueryAdapter implements QueryAdapter<SelectQueryBuilder<any>, ObjectLiteral> {\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public build<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    qb = this.createBaseQuery(qb, query);\r\n    qb = this.paginateQuery(qb, query);\r\n\r\n    return qb;\r\n  }\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public async getOne<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<E | null> {\r\n    const query = this.createBaseQuery(qb, request);\r\n    const entity = await query.getOne();\r\n\r\n    return entity ?? null;\r\n  }\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public async getMany<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<GetManyResult<E>> {\r\n    const fullQuery = this.createBaseQuery(qb, request);\r\n    const paginatedQuery = this.paginateQuery(fullQuery.clone(), request);\r\n\r\n    const data = await paginatedQuery.getMany();\r\n    const total = await fullQuery.getCount();\r\n\r\n    const offset = request.offset ?? 0;\r\n    const limit = request.limit ?? total;\r\n\r\n    const count = data.length;\r\n    const page = Math.floor(offset / limit) + 1;\r\n    const pageCount = Math.ceil(total / limit);\r\n\r\n    return {\r\n      data,\r\n      count,\r\n      page,\r\n      pageCount,\r\n      total,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Creates a query filtered from the parsed request\r\n   *\r\n   * @param qb The base query builder\r\n   * @param query The parsed query\r\n   */\r\n  protected createBaseQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    const paramsDefined: string[] = [];\r\n\r\n    this.adaptSelect(qb, query.select);\r\n    this.adaptRelations(qb, query.relations);\r\n    this.adaptWhere(qb, query.where, false, paramsDefined);\r\n    this.adaptOrder(qb, query.order);\r\n\r\n    return qb;\r\n  }\r\n\r\n  /**\r\n   * Paginates a query based on the parsed request\r\n   *\r\n   * @param qb The query builder\r\n   * @param query The parsed query\r\n   */\r\n  protected paginateQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    return qb.limit(query.limit).offset(query.offset);\r\n  }\r\n\r\n  /**\r\n   * Adapts a select\r\n   *\r\n   * @param qb The query builder\r\n   * @param select The parsed select fields\r\n   */\r\n  protected adaptSelect<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, select: ParsedRequestSelect): void {\r\n    qb.addSelect(select.map(s => s.field.join('.')));\r\n  }\r\n\r\n  /**\r\n   * Adapts the join relation list\r\n   *\r\n   * @param qb The query builder\r\n   * @param relations The parsed relation list\r\n   */\r\n  protected adaptRelations<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, relations: CrudRequestRelation[]): void {\r\n    for (const relation of relations) {\r\n      const path = relation.field.join('.');\r\n      const alias = relation.alias || path.replace('.', '_');\r\n\r\n      qb.leftJoin(path, alias);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adapts the order by list\r\n   *\r\n   * @param qb The query builder\r\n   * @param ordering The parsed ordering\r\n   */\r\n  protected adaptOrder<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, ordering: CrudRequestOrder[]): void {\r\n    for (const order of ordering) {\r\n      const path = order.field.join('.');\r\n\r\n      qb.addOrderBy(path, order.order);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adapts a where condition\r\n   *\r\n   * @param qb The query builder\r\n   * @param where The quere condition\r\n   * @param or Whether this where condition is AND/OR\r\n   * @param params The registered parameter name list\r\n   */\r\n  protected adaptWhere(qb: WhereExpressionBuilder, where: CrudRequestWhere, or: boolean, params: string[]): void {\r\n    const addWhere = (or ? qb.orWhere : qb.andWhere).bind(qb);\r\n\r\n    if (where.or && where.or.length > 0) {\r\n      addWhere(new Brackets(\r\n        wqb => where.or!.forEach(item => this.adaptWhere(wqb, item, true, params))\r\n      ));\r\n    } else if (where.and && where.and.length > 0) {\r\n      addWhere(new Brackets(\r\n        wqb => where.and!.forEach(item => this.adaptWhere(wqb, item, false, params))\r\n      ));\r\n    } else if (where.field) {\r\n      const param = this.createParam(params, where.field);\r\n      const query = this.mapWhereOperators(where as CrudRequestWhereField, param);\r\n\r\n      addWhere(query.where, query.params);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates a query parameter name based on a field\r\n   *\r\n   * @param paramsDefined The array the parameter will be registered onto\r\n   * @param field The field path\r\n   */\r\n  protected createParam(paramsDefined: string[], field: string[]): string {\r\n    const name = field.length > 0 ? field[field.length - 1] : '';\r\n    let param: string;\r\n    let iteration: number = 0;\r\n\r\n    do {\r\n      param = 'req_' + name + '_' + iteration;\r\n      iteration++;\r\n    } while (paramsDefined.includes(param));\r\n\r\n    paramsDefined.push(param);\r\n    return param;\r\n  }\r\n\r\n  /**\r\n   * Maps where operators to a pseudo-SQL statement and a parameter map\r\n   *\r\n   * @param where The where condition\r\n   * @param param The parameter name\r\n   */\r\n  protected mapWhereOperators(where: CrudRequestWhereField, param: string): { where: string, params: ObjectLiteral } {\r\n    const field = where.field.join('.');\r\n    const operator = where.operator;\r\n    let value: unknown = where.value;\r\n\r\n    switch (operator) {\r\n      case CrudRequestWhereOperator.EQ:\r\n        return { where: `${field} = :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NEQ:\r\n        return { where: `${field} != :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.GT:\r\n        return { where: `${field} > :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.GTE:\r\n        return { where: `${field} >= :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.LT:\r\n        return { where: `${field} < :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.LTE:\r\n        return { where: `${field} <= :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.STARTS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.ENDS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}` } };\r\n\r\n      case CrudRequestWhereOperator.CONTAINS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.NOT_CONTAINS:\r\n        return { where: `${field} NOT LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.IN:\r\n        value = ensureArray('IN operator', value, 1);\r\n\r\n        return { where: `${field} IN (:...${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NOT_IN:\r\n        value = ensureArray('NOT IN operator', value, 1);\r\n\r\n        return { where: `${field} NOT IN (:...${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.BETWEEN:\r\n        const arr = ensureArray('BETWEEN operator', value, 2);\r\n\r\n        return {\r\n          where: `${field} BETWEEN :${param}_start AND :${param}_end`,\r\n          params: { [`${param}_start`]: arr[0], [`${param}_end`]: arr[1] },\r\n        };\r\n\r\n      case CrudRequestWhereOperator.IS_NULL:\r\n        ensureFalsy('IS NULL operator', value);\r\n\r\n        return { where: `${field} IS NULL`, params: {} };\r\n\r\n      case CrudRequestWhereOperator.NOT_NULL:\r\n        ensureFalsy('NOT NULL operator', value);\r\n\r\n        return { where: `${field} IS NOT NULL`, params: {} };\r\n\r\n      case CrudRequestWhereOperator.EQ_LOWER:\r\n        return { where: `LOWER(${field}) = :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NEQ_LOWER:\r\n        return { where: `LOWER(${field}) != :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.STARTS_LOWER:\r\n        return { where: `LOWER(${field}) LIKE :${param}`, params: { [param]: `${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.ENDS_LOWER:\r\n        return { where: `LOWER(${field}) LIKE :${param}`, params: { [param]: `%${value}` } };\r\n\r\n      case CrudRequestWhereOperator.CONTAINS_LOWER:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.NOT_CONTAINS_LOWER:\r\n        return { where: `${field} NOT LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.IN_LOWER:\r\n        ensureArray('IN operator', value, 1);\r\n\r\n        return { where: `${field} IN (...:${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NOT_IN_LOWER:\r\n        ensureArray('NOT IN operator', value, 1);\r\n\r\n        return { where: `${field} NOT IN (...:${param})`, params: { [param]: value } };\r\n\r\n      default:\r\n        throw new Error(`Unknown operator \"${operator}\"`);\r\n    }\r\n  }\r\n\r\n}\r\n","import { CrudRequestFields } from '../models/crud-request';\r\n\r\n/*export function setFieldByPath<T>(obj: ParsedRequestFields<T>, field: string, value: T): void {\r\n  const parts = field.split('.');\r\n\r\n  while (parts.length > 1) {\r\n    const name = parts.shift();\r\n\r\n    if (!Array.isArray(obj[name]))\r\n      obj[name] = {};\r\n\r\n    obj = obj[name] as ParsedRequestFields<T>;\r\n  }\r\n\r\n  obj[parts.shift()] = value;\r\n}*/\r\n\r\nexport function ensureArray<T>(fieldName: string, data: T[] | any, minLength: number = 0): T[] {\r\n  if (!Array.isArray(data) || data.length < minLength)\r\n    throw new Error(`${fieldName} must be an array with at least ${minLength} items`);\r\n\r\n  return data;\r\n}\r\n\r\nexport function ensureFalsy(fieldName: string, data: any) {\r\n  if (data)\r\n    throw new Error(`${fieldName} must be null`);\r\n}\r\n\r\nexport function isValid(value: any): value is object {\r\n  return value !== null && value !== undefined;\r\n}\r\n"],"mappings":"4dAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,yBAAAE,IAAA,eAAAC,EAAAH,GCAA,IAAAI,EAAoF,mBCiB7E,SAASC,EAAeC,EAAmBC,EAAiBC,EAAoB,EAAQ,CAC7F,GAAI,CAAC,MAAM,QAAQD,CAAI,GAAKA,EAAK,OAASC,EACxC,MAAM,IAAI,MAAM,GAAGF,CAAS,mCAAmCE,CAAS,QAAQ,EAElF,OAAOD,CACT,CALgBE,EAAAJ,EAAA,eAOT,SAASK,EAAYJ,EAAmBC,EAAW,CACxD,GAAIA,EACF,MAAM,IAAI,MAAM,GAAGD,CAAS,eAAe,CAC/C,CAHgBG,EAAAC,EAAA,eDLT,IAAMC,EAAN,KAA0F,CAnBjG,MAmBiG,CAAAC,EAAA,4BAKxF,MAA+BC,EAA2BC,EAA2C,CAC1G,OAAAD,EAAK,KAAK,gBAAgBA,EAAIC,CAAK,EACnCD,EAAK,KAAK,cAAcA,EAAIC,CAAK,EAE1BD,CACT,CAKA,MAAa,OAAgCA,EAAiCE,EAAyC,CAIrH,OAFe,MADD,KAAK,gBAAgBF,EAAIE,CAAO,EACnB,OAAO,GAEjB,IACnB,CAKA,MAAa,QAAiCF,EAAiCE,EAAiD,CAC9H,IAAMC,EAAY,KAAK,gBAAgBH,EAAIE,CAAO,EAG5CE,EAAO,MAFU,KAAK,cAAcD,EAAU,MAAM,EAAGD,CAAO,EAElC,QAAQ,EACpCG,EAAQ,MAAMF,EAAU,SAAS,EAEjCG,EAASJ,EAAQ,QAAU,EAC3BK,EAAQL,EAAQ,OAASG,EAEzBG,EAAQJ,EAAK,OACbK,EAAO,KAAK,MAAMH,EAASC,CAAK,EAAI,EACpCG,EAAY,KAAK,KAAKL,EAAQE,CAAK,EAEzC,MAAO,CACL,KAAAH,EACA,MAAAI,EACA,KAAAC,EACA,UAAAC,EACA,MAAAL,CACF,CACF,CAQU,gBAAyCL,EAA2BC,EAA2C,CACvH,IAAMU,EAA0B,CAAC,EAEjC,YAAK,YAAYX,EAAIC,EAAM,MAAM,EACjC,KAAK,eAAeD,EAAIC,EAAM,SAAS,EACvC,KAAK,WAAWD,EAAIC,EAAM,MAAO,GAAOU,CAAa,EACrD,KAAK,WAAWX,EAAIC,EAAM,KAAK,EAExBD,CACT,CAQU,cAAuCA,EAA2BC,EAA2C,CACrH,OAAOD,EAAG,MAAMC,EAAM,KAAK,EAAE,OAAOA,EAAM,MAAM,CAClD,CAQU,YAAqCD,EAA2BY,EAAmC,CAC3GZ,EAAG,UAAUY,EAAO,IAAIC,GAAKA,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC,CACjD,CAQU,eAAwCb,EAA2Bc,EAAwC,CACnH,QAAWC,KAAYD,EAAW,CAChC,IAAME,EAAOD,EAAS,MAAM,KAAK,GAAG,EAC9BE,EAAQF,EAAS,OAASC,EAAK,QAAQ,IAAK,GAAG,EAErDhB,EAAG,SAASgB,EAAMC,CAAK,CACzB,CACF,CAQU,WAAoCjB,EAA2BkB,EAAoC,CAC3G,QAAWC,KAASD,EAAU,CAC5B,IAAMF,EAAOG,EAAM,MAAM,KAAK,GAAG,EAEjCnB,EAAG,WAAWgB,EAAMG,EAAM,KAAK,CACjC,CACF,CAUU,WAAWnB,EAA4BoB,EAAyBC,EAAaC,EAAwB,CAC7G,IAAMC,GAAYF,EAAKrB,EAAG,QAAUA,EAAG,UAAU,KAAKA,CAAE,EAExD,GAAIoB,EAAM,IAAMA,EAAM,GAAG,OAAS,EAChCG,EAAS,IAAI,WACXC,GAAOJ,EAAM,GAAI,QAAQK,GAAQ,KAAK,WAAWD,EAAKC,EAAM,GAAMH,CAAM,CAAC,CAC3E,CAAC,UACQF,EAAM,KAAOA,EAAM,IAAI,OAAS,EACzCG,EAAS,IAAI,WACXC,GAAOJ,EAAM,IAAK,QAAQK,GAAQ,KAAK,WAAWD,EAAKC,EAAM,GAAOH,CAAM,CAAC,CAC7E,CAAC,UACQF,EAAM,MAAO,CACtB,IAAMM,EAAQ,KAAK,YAAYJ,EAAQF,EAAM,KAAK,EAC5CnB,EAAQ,KAAK,kBAAkBmB,EAAgCM,CAAK,EAE1EH,EAAStB,EAAM,MAAOA,EAAM,MAAM,CACpC,CACF,CAQU,YAAYU,EAAyBgB,EAAyB,CACtE,IAAMC,EAAOD,EAAM,OAAS,EAAIA,EAAMA,EAAM,OAAS,CAAC,EAAI,GACtDD,EACAG,EAAoB,EAExB,GACEH,EAAQ,OAASE,EAAO,IAAMC,EAC9BA,UACOlB,EAAc,SAASe,CAAK,GAErC,OAAAf,EAAc,KAAKe,CAAK,EACjBA,CACT,CAQU,kBAAkBN,EAA8BM,EAAyD,CACjH,IAAMC,EAAQP,EAAM,MAAM,KAAK,GAAG,EAC5BU,EAAWV,EAAM,SACnBW,EAAiBX,EAAM,MAE3B,OAAQU,EAAU,CAChB,SACE,MAAO,CAAE,MAAO,GAAGH,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,SACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,SACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,aACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,GAAGK,CAAK,GAAI,CAAE,EAE9E,WACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,EAAG,CAAE,EAE9E,eACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAE/E,mBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,cAAcD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAEnF,SACE,OAAAA,EAAQC,EAAY,cAAeD,EAAO,CAAC,EAEpC,CAAE,MAAO,GAAGJ,CAAK,YAAYD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE3E,aACE,OAAAA,EAAQC,EAAY,kBAAmBD,EAAO,CAAC,EAExC,CAAE,MAAO,GAAGJ,CAAK,gBAAgBD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE/E,cACE,IAAME,EAAMD,EAAY,mBAAoBD,EAAO,CAAC,EAEpD,MAAO,CACL,MAAO,GAAGJ,CAAK,aAAaD,CAAK,eAAeA,CAAK,OACrD,OAAQ,CAAE,CAAC,GAAGA,CAAK,QAAQ,EAAGO,EAAI,CAAC,EAAG,CAAC,GAAGP,CAAK,MAAM,EAAGO,EAAI,CAAC,CAAE,CACjE,EAEF,cACE,OAAAC,EAAY,mBAAoBH,CAAK,EAE9B,CAAE,MAAO,GAAGJ,CAAK,WAAY,OAAQ,CAAC,CAAE,EAEjD,eACE,OAAAO,EAAY,oBAAqBH,CAAK,EAE/B,CAAE,MAAO,GAAGJ,CAAK,eAAgB,OAAQ,CAAC,CAAE,EAErD,eACE,MAAO,CAAE,MAAO,SAASA,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE5E,gBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,SAASD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE7E,mBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,WAAWD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,GAAGK,CAAK,GAAI,CAAE,EAErF,iBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,WAAWD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,EAAG,CAAE,EAErF,qBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAE/E,yBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,cAAcD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAEnF,eACE,OAAAC,EAAY,cAAeD,EAAO,CAAC,EAE5B,CAAE,MAAO,GAAGJ,CAAK,YAAYD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE3E,mBACE,OAAAC,EAAY,kBAAmBD,EAAO,CAAC,EAEhC,CAAE,MAAO,GAAGJ,CAAK,gBAAgBD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE/E,QACE,MAAM,IAAI,MAAM,qBAAqBD,CAAQ,GAAG,CACpD,CACF,CAEF","names":["typeorm_exports","__export","TypeormQueryAdapter","__toCommonJS","import_typeorm","ensureArray","fieldName","data","minLength","__name","ensureFalsy","TypeormQueryAdapter","__name","qb","query","request","fullQuery","data","total","offset","limit","count","page","pageCount","paramsDefined","select","s","relations","relation","path","alias","ordering","order","where","or","params","addWhere","wqb","item","param","field","name","iteration","operator","value","ensureArray","arr","ensureFalsy"]}

package/dist/adapters/typeorm/index.mjs

@@ -0,0 +1,2 @@
+var T=Object.defineProperty;var u=(l,t)=>T(l,"name",{value:t,configurable:!0});import{Brackets as E}from"typeorm";function a(l,t,e=0){if(!Array.isArray(t)||t.length<e)throw new Error(`${l} must be an array with at least ${e} items`);return t}u(a,"ensureArray");function c(l,t){if(t)throw new Error(`${l} must be null`)}u(c,"ensureFalsy");var N=class{static{u(this,"TypeormQueryAdapter")}build(t,e){return t=this.createBaseQuery(t,e),t=this.paginateQuery(t,e),t}async getOne(t,e){return await this.createBaseQuery(t,e).getOne()??null}async getMany(t,e){let r=this.createBaseQuery(t,e),n=await this.paginateQuery(r.clone(),e).getMany(),i=await r.getCount(),o=e.offset??0,d=e.limit??i,$=n.length,L=Math.floor(o/d)+1,h=Math.ceil(i/d);return{data:n,count:$,page:L,pageCount:h,total:i}}createBaseQuery(t,e){let r=[];return this.adaptSelect(t,e.select),this.adaptRelations(t,e.relations),this.adaptWhere(t,e.where,!1,r),this.adaptOrder(t,e.order),t}paginateQuery(t,e){return t.limit(e.limit).offset(e.offset)}adaptSelect(t,e){t.addSelect(e.map(r=>r.field.join(".")))}adaptRelations(t,e){for(let r of e){let s=r.field.join("."),n=r.alias||s.replace(".","_");t.leftJoin(s,n)}}adaptOrder(t,e){for(let r of e){let s=r.field.join(".");t.addOrderBy(s,r.order)}}adaptWhere(t,e,r,s){let n=(r?t.orWhere:t.andWhere).bind(t);if(e.or&&e.or.length>0)n(new E(i=>e.or.forEach(o=>this.adaptWhere(i,o,!0,s))));else if(e.and&&e.and.length>0)n(new E(i=>e.and.forEach(o=>this.adaptWhere(i,o,!1,s))));else if(e.field){let i=this.createParam(s,e.field),o=this.mapWhereOperators(e,i);n(o.where,o.params)}}createParam(t,e){let r=e.length>0?e[e.length-1]:"",s,n=0;do s="req_"+r+"_"+n,n++;while(t.includes(s));return t.push(s),s}mapWhereOperators(t,e){let r=t.field.join("."),s=t.operator,n=t.value;switch(s){case"eq":return{where:`${r} = :${e}`,params:{[e]:n}};case"neq":return{where:`${r} != :${e}`,params:{[e]:n}};case"gt":return{where:`${r} > :${e}`,params:{[e]:n}};case"gte":return{where:`${r} >= :${e}`,params:{[e]:n}};case"lt":return{where:`${r} < :${e}`,params:{[e]:n}};case"lte":return{where:`${r} <= :${e}`,params:{[e]:n}};case"starts":return{where:`${r} LIKE :${e}`,params:{[e]:`${n}%`}};case"ends":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}`}};case"contains":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}%`}};case"not_contains":return{where:`${r} NOT LIKE :${e}`,params:{[e]:`%${n}%`}};case"in":return n=a("IN operator",n,1),{where:`${r} IN (:...${e})`,params:{[e]:n}};case"not_in":return n=a("NOT IN operator",n,1),{where:`${r} NOT IN (:...${e})`,params:{[e]:n}};case"between":let i=a("BETWEEN operator",n,2);return{where:`${r} BETWEEN :${e}_start AND :${e}_end`,params:{[`${e}_start`]:i[0],[`${e}_end`]:i[1]}};case"is_null":return c("IS NULL operator",n),{where:`${r} IS NULL`,params:{}};case"not_null":return c("NOT NULL operator",n),{where:`${r} IS NOT NULL`,params:{}};case"eq_lower":return{where:`LOWER(${r}) = :${e}`,params:{[e]:n}};case"neq_lower":return{where:`LOWER(${r}) != :${e}`,params:{[e]:n}};case"starts_lower":return{where:`LOWER(${r}) LIKE :${e}`,params:{[e]:`${n}%`}};case"ends_lower":return{where:`LOWER(${r}) LIKE :${e}`,params:{[e]:`%${n}`}};case"contains_lower":return{where:`${r} LIKE :${e}`,params:{[e]:`%${n}%`}};case"not_contains_lower":return{where:`${r} NOT LIKE :${e}`,params:{[e]:`%${n}%`}};case"in_lower":return a("IN operator",n,1),{where:`${r} IN (...:${e})`,params:{[e]:n}};case"not_in_lower":return a("NOT IN operator",n,1),{where:`${r} NOT IN (...:${e})`,params:{[e]:n}};default:throw new Error(`Unknown operator "${s}"`)}}};export{N as TypeormQueryAdapter};
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/typeorm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/adapters/typeorm/typeorm.query-adapter.ts","../../../src/utils/functions.ts"],"sourcesContent":["import { Brackets, ObjectLiteral, SelectQueryBuilder, WhereExpressionBuilder } from 'typeorm';\r\nimport { QueryAdapter } from '../../models/query-adapter';\r\nimport {\r\n  CrudRequest,\r\n  CrudRequestOrder,\r\n  CrudRequestRelation,\r\n  ParsedRequestSelect\r\n} from '../../models/crud-request';\r\nimport {\r\n  CrudRequestWhere,\r\n  CrudRequestWhereField,\r\n  CrudRequestWhereOperator\r\n} from '../../models/crud-request-where';\r\nimport { GetManyResult } from '../../models/get-many-result';\r\nimport { ensureArray, ensureFalsy } from '../../utils/functions';\r\n\r\n/**\r\n * Adapts queries to TypeORM query builder object\r\n */\r\nexport class TypeormQueryAdapter implements QueryAdapter<SelectQueryBuilder<any>, ObjectLiteral> {\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public build<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    qb = this.createBaseQuery(qb, query);\r\n    qb = this.paginateQuery(qb, query);\r\n\r\n    return qb;\r\n  }\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public async getOne<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<E | null> {\r\n    const query = this.createBaseQuery(qb, request);\r\n    const entity = await query.getOne();\r\n\r\n    return entity ?? null;\r\n  }\r\n\r\n  /**\r\n   * @inheritDoc\r\n   */\r\n  public async getMany<E extends ObjectLiteral>(qb: SelectQueryBuilder<E | any>, request: CrudRequest): Promise<GetManyResult<E>> {\r\n    const fullQuery = this.createBaseQuery(qb, request);\r\n    const paginatedQuery = this.paginateQuery(fullQuery.clone(), request);\r\n\r\n    const data = await paginatedQuery.getMany();\r\n    const total = await fullQuery.getCount();\r\n\r\n    const offset = request.offset ?? 0;\r\n    const limit = request.limit ?? total;\r\n\r\n    const count = data.length;\r\n    const page = Math.floor(offset / limit) + 1;\r\n    const pageCount = Math.ceil(total / limit);\r\n\r\n    return {\r\n      data,\r\n      count,\r\n      page,\r\n      pageCount,\r\n      total,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Creates a query filtered from the parsed request\r\n   *\r\n   * @param qb The base query builder\r\n   * @param query The parsed query\r\n   */\r\n  protected createBaseQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    const paramsDefined: string[] = [];\r\n\r\n    this.adaptSelect(qb, query.select);\r\n    this.adaptRelations(qb, query.relations);\r\n    this.adaptWhere(qb, query.where, false, paramsDefined);\r\n    this.adaptOrder(qb, query.order);\r\n\r\n    return qb;\r\n  }\r\n\r\n  /**\r\n   * Paginates a query based on the parsed request\r\n   *\r\n   * @param qb The query builder\r\n   * @param query The parsed query\r\n   */\r\n  protected paginateQuery<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, query: CrudRequest): SelectQueryBuilder<E> {\r\n    return qb.limit(query.limit).offset(query.offset);\r\n  }\r\n\r\n  /**\r\n   * Adapts a select\r\n   *\r\n   * @param qb The query builder\r\n   * @param select The parsed select fields\r\n   */\r\n  protected adaptSelect<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, select: ParsedRequestSelect): void {\r\n    qb.addSelect(select.map(s => s.field.join('.')));\r\n  }\r\n\r\n  /**\r\n   * Adapts the join relation list\r\n   *\r\n   * @param qb The query builder\r\n   * @param relations The parsed relation list\r\n   */\r\n  protected adaptRelations<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, relations: CrudRequestRelation[]): void {\r\n    for (const relation of relations) {\r\n      const path = relation.field.join('.');\r\n      const alias = relation.alias || path.replace('.', '_');\r\n\r\n      qb.leftJoin(path, alias);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adapts the order by list\r\n   *\r\n   * @param qb The query builder\r\n   * @param ordering The parsed ordering\r\n   */\r\n  protected adaptOrder<E extends ObjectLiteral>(qb: SelectQueryBuilder<E>, ordering: CrudRequestOrder[]): void {\r\n    for (const order of ordering) {\r\n      const path = order.field.join('.');\r\n\r\n      qb.addOrderBy(path, order.order);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adapts a where condition\r\n   *\r\n   * @param qb The query builder\r\n   * @param where The quere condition\r\n   * @param or Whether this where condition is AND/OR\r\n   * @param params The registered parameter name list\r\n   */\r\n  protected adaptWhere(qb: WhereExpressionBuilder, where: CrudRequestWhere, or: boolean, params: string[]): void {\r\n    const addWhere = (or ? qb.orWhere : qb.andWhere).bind(qb);\r\n\r\n    if (where.or && where.or.length > 0) {\r\n      addWhere(new Brackets(\r\n        wqb => where.or!.forEach(item => this.adaptWhere(wqb, item, true, params))\r\n      ));\r\n    } else if (where.and && where.and.length > 0) {\r\n      addWhere(new Brackets(\r\n        wqb => where.and!.forEach(item => this.adaptWhere(wqb, item, false, params))\r\n      ));\r\n    } else if (where.field) {\r\n      const param = this.createParam(params, where.field);\r\n      const query = this.mapWhereOperators(where as CrudRequestWhereField, param);\r\n\r\n      addWhere(query.where, query.params);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates a query parameter name based on a field\r\n   *\r\n   * @param paramsDefined The array the parameter will be registered onto\r\n   * @param field The field path\r\n   */\r\n  protected createParam(paramsDefined: string[], field: string[]): string {\r\n    const name = field.length > 0 ? field[field.length - 1] : '';\r\n    let param: string;\r\n    let iteration: number = 0;\r\n\r\n    do {\r\n      param = 'req_' + name + '_' + iteration;\r\n      iteration++;\r\n    } while (paramsDefined.includes(param));\r\n\r\n    paramsDefined.push(param);\r\n    return param;\r\n  }\r\n\r\n  /**\r\n   * Maps where operators to a pseudo-SQL statement and a parameter map\r\n   *\r\n   * @param where The where condition\r\n   * @param param The parameter name\r\n   */\r\n  protected mapWhereOperators(where: CrudRequestWhereField, param: string): { where: string, params: ObjectLiteral } {\r\n    const field = where.field.join('.');\r\n    const operator = where.operator;\r\n    let value: unknown = where.value;\r\n\r\n    switch (operator) {\r\n      case CrudRequestWhereOperator.EQ:\r\n        return { where: `${field} = :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NEQ:\r\n        return { where: `${field} != :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.GT:\r\n        return { where: `${field} > :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.GTE:\r\n        return { where: `${field} >= :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.LT:\r\n        return { where: `${field} < :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.LTE:\r\n        return { where: `${field} <= :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.STARTS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.ENDS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}` } };\r\n\r\n      case CrudRequestWhereOperator.CONTAINS:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.NOT_CONTAINS:\r\n        return { where: `${field} NOT LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.IN:\r\n        value = ensureArray('IN operator', value, 1);\r\n\r\n        return { where: `${field} IN (:...${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NOT_IN:\r\n        value = ensureArray('NOT IN operator', value, 1);\r\n\r\n        return { where: `${field} NOT IN (:...${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.BETWEEN:\r\n        const arr = ensureArray('BETWEEN operator', value, 2);\r\n\r\n        return {\r\n          where: `${field} BETWEEN :${param}_start AND :${param}_end`,\r\n          params: { [`${param}_start`]: arr[0], [`${param}_end`]: arr[1] },\r\n        };\r\n\r\n      case CrudRequestWhereOperator.IS_NULL:\r\n        ensureFalsy('IS NULL operator', value);\r\n\r\n        return { where: `${field} IS NULL`, params: {} };\r\n\r\n      case CrudRequestWhereOperator.NOT_NULL:\r\n        ensureFalsy('NOT NULL operator', value);\r\n\r\n        return { where: `${field} IS NOT NULL`, params: {} };\r\n\r\n      case CrudRequestWhereOperator.EQ_LOWER:\r\n        return { where: `LOWER(${field}) = :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NEQ_LOWER:\r\n        return { where: `LOWER(${field}) != :${param}`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.STARTS_LOWER:\r\n        return { where: `LOWER(${field}) LIKE :${param}`, params: { [param]: `${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.ENDS_LOWER:\r\n        return { where: `LOWER(${field}) LIKE :${param}`, params: { [param]: `%${value}` } };\r\n\r\n      case CrudRequestWhereOperator.CONTAINS_LOWER:\r\n        return { where: `${field} LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.NOT_CONTAINS_LOWER:\r\n        return { where: `${field} NOT LIKE :${param}`, params: { [param]: `%${value}%` } };\r\n\r\n      case CrudRequestWhereOperator.IN_LOWER:\r\n        ensureArray('IN operator', value, 1);\r\n\r\n        return { where: `${field} IN (...:${param})`, params: { [param]: value } };\r\n\r\n      case CrudRequestWhereOperator.NOT_IN_LOWER:\r\n        ensureArray('NOT IN operator', value, 1);\r\n\r\n        return { where: `${field} NOT IN (...:${param})`, params: { [param]: value } };\r\n\r\n      default:\r\n        throw new Error(`Unknown operator \"${operator}\"`);\r\n    }\r\n  }\r\n\r\n}\r\n","import { CrudRequestFields } from '../models/crud-request';\r\n\r\n/*export function setFieldByPath<T>(obj: ParsedRequestFields<T>, field: string, value: T): void {\r\n  const parts = field.split('.');\r\n\r\n  while (parts.length > 1) {\r\n    const name = parts.shift();\r\n\r\n    if (!Array.isArray(obj[name]))\r\n      obj[name] = {};\r\n\r\n    obj = obj[name] as ParsedRequestFields<T>;\r\n  }\r\n\r\n  obj[parts.shift()] = value;\r\n}*/\r\n\r\nexport function ensureArray<T>(fieldName: string, data: T[] | any, minLength: number = 0): T[] {\r\n  if (!Array.isArray(data) || data.length < minLength)\r\n    throw new Error(`${fieldName} must be an array with at least ${minLength} items`);\r\n\r\n  return data;\r\n}\r\n\r\nexport function ensureFalsy(fieldName: string, data: any) {\r\n  if (data)\r\n    throw new Error(`${fieldName} must be null`);\r\n}\r\n\r\nexport function isValid(value: any): value is object {\r\n  return value !== null && value !== undefined;\r\n}\r\n"],"mappings":"+EAAA,OAAS,YAAAA,MAA2E,UCiB7E,SAASC,EAAeC,EAAmBC,EAAiBC,EAAoB,EAAQ,CAC7F,GAAI,CAAC,MAAM,QAAQD,CAAI,GAAKA,EAAK,OAASC,EACxC,MAAM,IAAI,MAAM,GAAGF,CAAS,mCAAmCE,CAAS,QAAQ,EAElF,OAAOD,CACT,CALgBE,EAAAJ,EAAA,eAOT,SAASK,EAAYJ,EAAmBC,EAAW,CACxD,GAAIA,EACF,MAAM,IAAI,MAAM,GAAGD,CAAS,eAAe,CAC/C,CAHgBG,EAAAC,EAAA,eDLT,IAAMC,EAAN,KAA0F,CAnBjG,MAmBiG,CAAAC,EAAA,4BAKxF,MAA+BC,EAA2BC,EAA2C,CAC1G,OAAAD,EAAK,KAAK,gBAAgBA,EAAIC,CAAK,EACnCD,EAAK,KAAK,cAAcA,EAAIC,CAAK,EAE1BD,CACT,CAKA,MAAa,OAAgCA,EAAiCE,EAAyC,CAIrH,OAFe,MADD,KAAK,gBAAgBF,EAAIE,CAAO,EACnB,OAAO,GAEjB,IACnB,CAKA,MAAa,QAAiCF,EAAiCE,EAAiD,CAC9H,IAAMC,EAAY,KAAK,gBAAgBH,EAAIE,CAAO,EAG5CE,EAAO,MAFU,KAAK,cAAcD,EAAU,MAAM,EAAGD,CAAO,EAElC,QAAQ,EACpCG,EAAQ,MAAMF,EAAU,SAAS,EAEjCG,EAASJ,EAAQ,QAAU,EAC3BK,EAAQL,EAAQ,OAASG,EAEzBG,EAAQJ,EAAK,OACbK,EAAO,KAAK,MAAMH,EAASC,CAAK,EAAI,EACpCG,EAAY,KAAK,KAAKL,EAAQE,CAAK,EAEzC,MAAO,CACL,KAAAH,EACA,MAAAI,EACA,KAAAC,EACA,UAAAC,EACA,MAAAL,CACF,CACF,CAQU,gBAAyCL,EAA2BC,EAA2C,CACvH,IAAMU,EAA0B,CAAC,EAEjC,YAAK,YAAYX,EAAIC,EAAM,MAAM,EACjC,KAAK,eAAeD,EAAIC,EAAM,SAAS,EACvC,KAAK,WAAWD,EAAIC,EAAM,MAAO,GAAOU,CAAa,EACrD,KAAK,WAAWX,EAAIC,EAAM,KAAK,EAExBD,CACT,CAQU,cAAuCA,EAA2BC,EAA2C,CACrH,OAAOD,EAAG,MAAMC,EAAM,KAAK,EAAE,OAAOA,EAAM,MAAM,CAClD,CAQU,YAAqCD,EAA2BY,EAAmC,CAC3GZ,EAAG,UAAUY,EAAO,IAAIC,GAAKA,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC,CACjD,CAQU,eAAwCb,EAA2Bc,EAAwC,CACnH,QAAWC,KAAYD,EAAW,CAChC,IAAME,EAAOD,EAAS,MAAM,KAAK,GAAG,EAC9BE,EAAQF,EAAS,OAASC,EAAK,QAAQ,IAAK,GAAG,EAErDhB,EAAG,SAASgB,EAAMC,CAAK,CACzB,CACF,CAQU,WAAoCjB,EAA2BkB,EAAoC,CAC3G,QAAWC,KAASD,EAAU,CAC5B,IAAMF,EAAOG,EAAM,MAAM,KAAK,GAAG,EAEjCnB,EAAG,WAAWgB,EAAMG,EAAM,KAAK,CACjC,CACF,CAUU,WAAWnB,EAA4BoB,EAAyBC,EAAaC,EAAwB,CAC7G,IAAMC,GAAYF,EAAKrB,EAAG,QAAUA,EAAG,UAAU,KAAKA,CAAE,EAExD,GAAIoB,EAAM,IAAMA,EAAM,GAAG,OAAS,EAChCG,EAAS,IAAIC,EACXC,GAAOL,EAAM,GAAI,QAAQM,GAAQ,KAAK,WAAWD,EAAKC,EAAM,GAAMJ,CAAM,CAAC,CAC3E,CAAC,UACQF,EAAM,KAAOA,EAAM,IAAI,OAAS,EACzCG,EAAS,IAAIC,EACXC,GAAOL,EAAM,IAAK,QAAQM,GAAQ,KAAK,WAAWD,EAAKC,EAAM,GAAOJ,CAAM,CAAC,CAC7E,CAAC,UACQF,EAAM,MAAO,CACtB,IAAMO,EAAQ,KAAK,YAAYL,EAAQF,EAAM,KAAK,EAC5CnB,EAAQ,KAAK,kBAAkBmB,EAAgCO,CAAK,EAE1EJ,EAAStB,EAAM,MAAOA,EAAM,MAAM,CACpC,CACF,CAQU,YAAYU,EAAyBiB,EAAyB,CACtE,IAAMC,EAAOD,EAAM,OAAS,EAAIA,EAAMA,EAAM,OAAS,CAAC,EAAI,GACtDD,EACAG,EAAoB,EAExB,GACEH,EAAQ,OAASE,EAAO,IAAMC,EAC9BA,UACOnB,EAAc,SAASgB,CAAK,GAErC,OAAAhB,EAAc,KAAKgB,CAAK,EACjBA,CACT,CAQU,kBAAkBP,EAA8BO,EAAyD,CACjH,IAAMC,EAAQR,EAAM,MAAM,KAAK,GAAG,EAC5BW,EAAWX,EAAM,SACnBY,EAAiBZ,EAAM,MAE3B,OAAQW,EAAU,CAChB,SACE,MAAO,CAAE,MAAO,GAAGH,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,SACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,SACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,OAAOD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAErE,UACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAEtE,aACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,GAAGK,CAAK,GAAI,CAAE,EAE9E,WACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,EAAG,CAAE,EAE9E,eACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAE/E,mBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,cAAcD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAEnF,SACE,OAAAA,EAAQC,EAAY,cAAeD,EAAO,CAAC,EAEpC,CAAE,MAAO,GAAGJ,CAAK,YAAYD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE3E,aACE,OAAAA,EAAQC,EAAY,kBAAmBD,EAAO,CAAC,EAExC,CAAE,MAAO,GAAGJ,CAAK,gBAAgBD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE/E,cACE,IAAME,EAAMD,EAAY,mBAAoBD,EAAO,CAAC,EAEpD,MAAO,CACL,MAAO,GAAGJ,CAAK,aAAaD,CAAK,eAAeA,CAAK,OACrD,OAAQ,CAAE,CAAC,GAAGA,CAAK,QAAQ,EAAGO,EAAI,CAAC,EAAG,CAAC,GAAGP,CAAK,MAAM,EAAGO,EAAI,CAAC,CAAE,CACjE,EAEF,cACE,OAAAC,EAAY,mBAAoBH,CAAK,EAE9B,CAAE,MAAO,GAAGJ,CAAK,WAAY,OAAQ,CAAC,CAAE,EAEjD,eACE,OAAAO,EAAY,oBAAqBH,CAAK,EAE/B,CAAE,MAAO,GAAGJ,CAAK,eAAgB,OAAQ,CAAC,CAAE,EAErD,eACE,MAAO,CAAE,MAAO,SAASA,CAAK,QAAQD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE5E,gBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,SAASD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE7E,mBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,WAAWD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,GAAGK,CAAK,GAAI,CAAE,EAErF,iBACE,MAAO,CAAE,MAAO,SAASJ,CAAK,WAAWD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,EAAG,CAAE,EAErF,qBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,UAAUD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAE/E,yBACE,MAAO,CAAE,MAAO,GAAGJ,CAAK,cAAcD,CAAK,GAAI,OAAQ,CAAE,CAACA,CAAK,EAAG,IAAIK,CAAK,GAAI,CAAE,EAEnF,eACE,OAAAC,EAAY,cAAeD,EAAO,CAAC,EAE5B,CAAE,MAAO,GAAGJ,CAAK,YAAYD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE3E,mBACE,OAAAC,EAAY,kBAAmBD,EAAO,CAAC,EAEhC,CAAE,MAAO,GAAGJ,CAAK,gBAAgBD,CAAK,IAAK,OAAQ,CAAE,CAACA,CAAK,EAAGK,CAAM,CAAE,EAE/E,QACE,MAAM,IAAI,MAAM,qBAAqBD,CAAQ,GAAG,CACpD,CACF,CAEF","names":["Brackets","ensureArray","fieldName","data","minLength","__name","ensureFalsy","TypeormQueryAdapter","__name","qb","query","request","fullQuery","data","total","offset","limit","count","page","pageCount","paramsDefined","select","s","relations","relation","path","alias","ordering","order","where","or","params","addWhere","Brackets","wqb","item","param","field","name","iteration","operator","value","ensureArray","arr","ensureFalsy"]}

package/dist/crud-request-CvDKp6Iy.d.mts

@@ -0,0 +1,83 @@
+/**
+ * Field path
+ *
+ * For post.category.name, this would be ["post", "category", "name"]
+ */
+type FieldPath = string[];
+
+type CrudRequestWhere = CrudRequestWhereAND | CrudRequestWhereOR | CrudRequestWhereField;
+interface CrudRequestWhereAND {
+    field?: never;
+    or?: never;
+    and: CrudRequestWhere[];
+}
+interface CrudRequestWhereOR {
+    field?: never;
+    or: CrudRequestWhere[];
+    and?: never;
+}
+interface CrudRequestWhereField {
+    /**
+     * Field path
+     *
+     * For post.category.name, this would be ["post", "category", "name"]
+     */
+    field: FieldPath;
+    /**
+     * The operator of the comparison
+     */
+    operator: CrudRequestWhereOperator;
+    /**
+     * The value to compare
+     */
+    value: CrudRequestWhereValueType | CrudRequestWhereValueType[];
+    or?: never;
+    and?: never;
+}
+type CrudRequestWhereValueType = string | number | boolean | Date | null | undefined;
+declare enum CrudRequestWhereOperator {
+    EQ = "eq",
+    NEQ = "neq",
+    GT = "gt",
+    GTE = "gte",
+    LT = "lt",
+    LTE = "lte",
+    STARTS = "starts",
+    ENDS = "ends",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "not_contains",
+    IN = "in",
+    NOT_IN = "not_in",
+    BETWEEN = "between",
+    IS_NULL = "is_null",
+    NOT_NULL = "not_null",
+    EQ_LOWER = "eq_lower",
+    NEQ_LOWER = "neq_lower",
+    STARTS_LOWER = "starts_lower",
+    ENDS_LOWER = "ends_lower",
+    CONTAINS_LOWER = "contains_lower",
+    NOT_CONTAINS_LOWER = "not_contains_lower",
+    IN_LOWER = "in_lower",
+    NOT_IN_LOWER = "not_in_lower"
+}
+
+interface CrudRequestFields {
+    field: FieldPath;
+}
+interface CrudRequestRelation extends CrudRequestFields {
+    alias?: string;
+}
+interface CrudRequestOrder extends CrudRequestFields {
+    order: 'ASC' | 'DESC';
+}
+type ParsedRequestSelect = CrudRequestFields[];
+interface CrudRequest {
+    select: ParsedRequestSelect;
+    relations: CrudRequestRelation[];
+    order: CrudRequestOrder[];
+    where: CrudRequestWhere;
+    limit?: number;
+    offset?: number;
+}
+
+export { type CrudRequestFields as C, type FieldPath as F, type ParsedRequestSelect as P, type CrudRequestRelation as a, type CrudRequestOrder as b, type CrudRequest as c, type CrudRequestWhere as d, type CrudRequestWhereAND as e, type CrudRequestWhereOR as f, type CrudRequestWhereField as g, type CrudRequestWhereValueType as h, CrudRequestWhereOperator as i };

package/dist/crud-request-CvDKp6Iy.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Field path
+ *
+ * For post.category.name, this would be ["post", "category", "name"]
+ */
+type FieldPath = string[];
+
+type CrudRequestWhere = CrudRequestWhereAND | CrudRequestWhereOR | CrudRequestWhereField;
+interface CrudRequestWhereAND {
+    field?: never;
+    or?: never;
+    and: CrudRequestWhere[];
+}
+interface CrudRequestWhereOR {
+    field?: never;
+    or: CrudRequestWhere[];
+    and?: never;
+}
+interface CrudRequestWhereField {
+    /**
+     * Field path
+     *
+     * For post.category.name, this would be ["post", "category", "name"]
+     */
+    field: FieldPath;
+    /**
+     * The operator of the comparison
+     */
+    operator: CrudRequestWhereOperator;
+    /**
+     * The value to compare
+     */
+    value: CrudRequestWhereValueType | CrudRequestWhereValueType[];
+    or?: never;
+    and?: never;
+}
+type CrudRequestWhereValueType = string | number | boolean | Date | null | undefined;
+declare enum CrudRequestWhereOperator {
+    EQ = "eq",
+    NEQ = "neq",
+    GT = "gt",
+    GTE = "gte",
+    LT = "lt",
+    LTE = "lte",
+    STARTS = "starts",
+    ENDS = "ends",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "not_contains",
+    IN = "in",
+    NOT_IN = "not_in",
+    BETWEEN = "between",
+    IS_NULL = "is_null",
+    NOT_NULL = "not_null",
+    EQ_LOWER = "eq_lower",
+    NEQ_LOWER = "neq_lower",
+    STARTS_LOWER = "starts_lower",
+    ENDS_LOWER = "ends_lower",
+    CONTAINS_LOWER = "contains_lower",
+    NOT_CONTAINS_LOWER = "not_contains_lower",
+    IN_LOWER = "in_lower",
+    NOT_IN_LOWER = "not_in_lower"
+}
+
+interface CrudRequestFields {
+    field: FieldPath;
+}
+interface CrudRequestRelation extends CrudRequestFields {
+    alias?: string;
+}
+interface CrudRequestOrder extends CrudRequestFields {
+    order: 'ASC' | 'DESC';
+}
+type ParsedRequestSelect = CrudRequestFields[];
+interface CrudRequest {
+    select: ParsedRequestSelect;
+    relations: CrudRequestRelation[];
+    order: CrudRequestOrder[];
+    where: CrudRequestWhere;
+    limit?: number;
+    offset?: number;
+}
+
+export { type CrudRequestFields as C, type FieldPath as F, type ParsedRequestSelect as P, type CrudRequestRelation as a, type CrudRequestOrder as b, type CrudRequest as c, type CrudRequestWhere as d, type CrudRequestWhereAND as e, type CrudRequestWhereOR as f, type CrudRequestWhereField as g, type CrudRequestWhereValueType as h, CrudRequestWhereOperator as i };

package/dist/filters/index.d.mts

@@ -0,0 +1,37 @@
+import { c as CrudRequest, d as CrudRequestWhere } from '../crud-request-CvDKp6Iy.mjs';
+
+/**
+ * Ensures a condition is always applied to the query
+ *
+ * @param request The parsed request
+ * @param condition The condition that needs to be applied
+ */
+declare function ensureCondition(request: CrudRequest, condition: CrudRequestWhere): CrudRequest;
+
+/**
+ * Ensures that the limit will be set following a maximum rule
+ *
+ * @param request The parsed request
+ * @param defaultLimit The default limit number
+ * @param maxLimit The maximum allowed limit number
+ */
+declare function ensureLimit(request: CrudRequest, defaultLimit: number, maxLimit: number): CrudRequest;
+
+/**
+ * Filters access to an allowlist of properties and relations.
+ * No selecting, filtering, sorting and joining can be done on a property that is not listed.
+ *
+ * @param request The parsed request
+ * @param allowedProperties The list of properties (in case of a field path, separated by dot) that will be allowed
+ */
+declare function filterProperties(request: CrudRequest, allowedProperties: string[]): CrudRequest;
+
+/**
+ * Filters access to an allowlist of relations.
+ *
+ * @param request The parsed request
+ * @param allowedRelations The list of relations (in case of a field path, separated by dot) that will be allowed
+ */
+declare function filterRelations(request: CrudRequest, allowedRelations: string[]): CrudRequest;
+
+export { ensureCondition, ensureLimit, filterProperties, filterRelations };