@ackplus/nest-crud-request 1.1.8 → 1.1.16

package/README.md

@@ -1,11 +1,713 @@
-# nest-crud-request
+# @ackplus/nest-crud-request
 
-This library was generated with [Nx](https://nx.dev).
+Framework-agnostic query builder for REST APIs - build complex queries with filtering, relations, and pagination for both frontend and backend.
 
-## Building
+## Features
 
-Run `nx build nest-crud-request` to build the library.
+- 🎯 **Framework-agnostic** - Works with any JavaScript/TypeScript framework
+- 🌐 **Frontend & Backend** - Use in React, Angular, Vue, Node.js, or any other environment
+- 🔍 **Type-safe** - Full TypeScript support with comprehensive type definitions
+- 🔗 **Fluent API** - Chainable methods for building complex queries
+- 📦 **Zero dependencies** - Lightweight with minimal footprint
+- 🎨 **Clean syntax** - Intuitive and readable query construction
+- 🔄 **Flexible output** - Export as query string, JSON, or object
 
-## Running unit tests
+## Installation
 
-Run `nx test nest-crud-request` to execute the unit tests via [Jest](https://jestjs.io).
+```bash
+npm install @ackplus/nest-crud-request
+# or
+pnpm add @ackplus/nest-crud-request
+# or
+yarn add @ackplus/nest-crud-request
+```
+
+## Quick Start
+
+```typescript
+import { QueryBuilder, WhereOperatorEnum, OrderDirectionEnum } from '@ackplus/nest-crud-request';
+
+// Create a query builder
+const query = new QueryBuilder()
+  .where('isActive', WhereOperatorEnum.EQ, true)
+  .andWhere('role', WhereOperatorEnum.IN, ['admin', 'moderator'])
+  .addRelation('posts', ['id', 'title'])
+  .setSkip(0)
+  .setTake(10)
+  .addOrder('createdAt', OrderDirectionEnum.DESC);
+
+// Convert to query string parameters
+const params = query.toObject();
+// {
+//   where: '{"isActive":{"$eq":true},"$and":[{"role":{"$in":["admin","moderator"]}}]}',
+//   relations: '{"posts":{"select":["id","title"]}}',
+//   skip: 0,
+//   take: 10,
+//   order: '{"createdAt":"DESC"}'
+// }
+
+// Use with fetch or axios
+const response = await fetch(`/api/users?${new URLSearchParams(params)}`);
+```
+
+## Usage Examples
+
+### Frontend Usage (React)
+
+```typescript
+import { QueryBuilder, WhereOperatorEnum, OrderDirectionEnum } from '@ackplus/nest-crud-request';
+import { useState, useEffect } from 'react';
+
+function UserList() {
+  const [users, setUsers] = useState([]);
+  const [page, setPage] = useState(0);
+  const pageSize = 10;
+
+  useEffect(() => {
+    const fetchUsers = async () => {
+      const query = new QueryBuilder()
+        .where('isActive', WhereOperatorEnum.EQ, true)
+        .addRelation('posts')
+        .setSkip(page * pageSize)
+        .setTake(pageSize)
+        .addOrder('createdAt', OrderDirectionEnum.DESC);
+
+      const params = query.toObject();
+      const queryString = new URLSearchParams(params).toString();
+      
+      const response = await fetch(`/api/users?${queryString}`);
+      const data = await response.json();
+      setUsers(data);
+    };
+
+    fetchUsers();
+  }, [page]);
+
+  return (
+    <div>
+      {users.map(user => (
+        <div key={user.id}>{user.email}</div>
+      ))}
+      <button onClick={() => setPage(page - 1)} disabled={page === 0}>
+        Previous
+      </button>
+      <button onClick={() => setPage(page + 1)}>
+        Next
+      </button>
+    </div>
+  );
+}
+```
+
+### Frontend Usage (Angular)
+
+```typescript
+import { QueryBuilder, WhereOperatorEnum, OrderDirectionEnum } from '@ackplus/nest-crud-request';
+import { HttpClient } from '@angular/common/http';
+import { Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+
+@Injectable()
+export class UserService {
+  constructor(private http: HttpClient) {}
+
+  getUsers(page: number = 0, pageSize: number = 10): Observable<User[]> {
+    const query = new QueryBuilder()
+      .where('isActive', WhereOperatorEnum.EQ, true)
+      .addRelation('posts')
+      .setSkip(page * pageSize)
+      .setTake(pageSize)
+      .addOrder('createdAt', OrderDirectionEnum.DESC);
+
+    const params = query.toObject();
+    
+    return this.http.get<User[]>('/api/users', { params });
+  }
+
+  searchUsers(searchTerm: string): Observable<User[]> {
+    const query = new QueryBuilder()
+      .where((builder) => {
+        builder
+          .where('email', WhereOperatorEnum.ILIKE, `%${searchTerm}%`)
+          .orWhere('firstName', WhereOperatorEnum.ILIKE, `%${searchTerm}%`)
+          .orWhere('lastName', WhereOperatorEnum.ILIKE, `%${searchTerm}%`);
+      })
+      .addOrder('email', OrderDirectionEnum.ASC);
+
+    const params = query.toObject();
+    
+    return this.http.get<User[]>('/api/users', { params });
+  }
+}
+```
+
+### Frontend Usage (Vue 3)
+
+```typescript
+import { QueryBuilder, WhereOperatorEnum, OrderDirectionEnum } from '@ackplus/nest-crud-request';
+import { ref, onMounted } from 'vue';
+import axios from 'axios';
+
+export function useUsers() {
+  const users = ref([]);
+  const loading = ref(false);
+  const page = ref(0);
+  const pageSize = 10;
+
+  const fetchUsers = async () => {
+    loading.value = true;
+    
+    const query = new QueryBuilder()
+      .where('isActive', WhereOperatorEnum.EQ, true)
+      .addRelation('posts')
+      .setSkip(page.value * pageSize)
+      .setTake(pageSize)
+      .addOrder('createdAt', OrderDirectionEnum.DESC);
+
+    const params = query.toObject();
+    
+    const response = await axios.get('/api/users', { params });
+    users.value = response.data;
+    loading.value = false;
+  };
+
+  const searchUsers = async (searchTerm: string) => {
+    const query = new QueryBuilder()
+      .where((builder) => {
+        builder
+          .where('email', WhereOperatorEnum.ILIKE, `%${searchTerm}%`)
+          .orWhere('firstName', WhereOperatorEnum.ILIKE, `%${searchTerm}%`);
+      });
+
+    const params = query.toObject();
+    const response = await axios.get('/api/users', { params });
+    users.value = response.data;
+  };
+
+  onMounted(fetchUsers);
+
+  return {
+    users,
+    loading,
+    page,
+    fetchUsers,
+    searchUsers,
+  };
+}
+```
+
+### Backend Usage (Node.js/Express)
+
+```typescript
+import { QueryBuilder, WhereOperatorEnum } from '@ackplus/nest-crud-request';
+
+// Parse query from request
+app.get('/api/users', (req, res) => {
+  // Build query from request params
+  const query = new QueryBuilder({
+    where: req.query.where,
+    relations: req.query.relations,
+    select: req.query.select,
+    skip: req.query.skip ? parseInt(req.query.skip) : 0,
+    take: req.query.take ? parseInt(req.query.take) : 10,
+    order: req.query.order,
+  });
+
+  // Use the query to fetch data from database
+  // ... your database logic
+});
+```
+
+## API Reference
+
+### QueryBuilder
+
+#### Constructor
+
+```typescript
+new QueryBuilder(options?: QueryBuilderOptions)
+```
+
+#### Methods
+
+##### `setOptions(options: QueryBuilderOptions): this`
+
+Set all options at once.
+
+```typescript
+query.setOptions({
+  where: { isActive: { $eq: true } },
+  relations: ['posts'],
+  skip: 0,
+  take: 10,
+});
+```
+
+##### `mergeOptions(options: QueryBuilderOptions, deep?: boolean): this`
+
+Merge options with existing options.
+
+```typescript
+query.mergeOptions({
+  skip: 10,
+  take: 20,
+});
+```
+
+##### `addSelect(fields: string | string[]): this`
+
+Add fields to select.
+
+```typescript
+query.addSelect(['id', 'email', 'firstName']);
+query.addSelect('lastName');
+```
+
+##### `removeSelect(fields: string | string[]): this`
+
+Remove fields from select.
+
+```typescript
+query.removeSelect(['password', 'secretKey']);
+```
+
+##### `addRelation(relation: string, select?: string[], where?: Record<string, any>): this`
+
+Add a relation to load.
+
+```typescript
+// Simple relation
+query.addRelation('posts');
+
+// Relation with specific fields
+query.addRelation('posts', ['id', 'title', 'content']);
+
+// Relation with filter
+query.addRelation('posts', ['id', 'title'], {
+  published: { $eq: true }
+});
+```
+
+##### `removeRelation(relation: string): this`
+
+Remove a relation.
+
+```typescript
+query.removeRelation('posts');
+```
+
+##### `where(...args: WhereBuilderCondition): this`
+
+Set where condition (replaces existing).
+
+```typescript
+// Simple equality
+query.where('email', 'john@example.com');
+
+// With operator
+query.where('age', WhereOperatorEnum.GT, 18);
+
+// Object syntax
+query.where({ isActive: { $eq: true } });
+
+// Function syntax for complex conditions
+query.where((builder) => {
+  builder
+    .where('role', WhereOperatorEnum.EQ, 'admin')
+    .orWhere('role', WhereOperatorEnum.EQ, 'moderator');
+});
+```
+
+##### `andWhere(...args: WhereBuilderCondition): this`
+
+Add an AND where condition.
+
+```typescript
+query.where('isActive', WhereOperatorEnum.EQ, true)
+     .andWhere('role', WhereOperatorEnum.EQ, 'admin');
+```
+
+##### `orWhere(...args: WhereBuilderCondition): this`
+
+Add an OR where condition.
+
+```typescript
+query.where('role', WhereOperatorEnum.EQ, 'admin')
+     .orWhere('role', WhereOperatorEnum.EQ, 'moderator');
+```
+
+##### `addOrder(orderBy: string, order: OrderDirectionEnum): this`
+
+Add an order clause.
+
+```typescript
+query.addOrder('createdAt', OrderDirectionEnum.DESC);
+query.addOrder('email', OrderDirectionEnum.ASC);
+```
+
+##### `removeOrder(orderBy: string): this`
+
+Remove an order clause.
+
+```typescript
+query.removeOrder('createdAt');
+```
+
+##### `setSkip(skip: number): this`
+
+Set the skip (offset) value.
+
+```typescript
+query.setSkip(10);
+```
+
+##### `setTake(take: number): this`
+
+Set the take (limit) value.
+
+```typescript
+query.setTake(10);
+```
+
+##### `setWithDeleted(withDeleted: boolean): this`
+
+Include soft-deleted records.
+
+```typescript
+query.setWithDeleted(true);
+```
+
+##### `setOnlyDeleted(onlyDeleted: boolean): this`
+
+Only show soft-deleted records.
+
+```typescript
+query.setOnlyDeleted(true);
+```
+
+##### `set(key: string, value: any): this`
+
+Set a custom option.
+
+```typescript
+query.set('customField', 'customValue');
+```
+
+##### `toObject(constrainToNestedObject?: boolean): QueryBuilderOptions`
+
+Convert to object (suitable for query parameters).
+
+```typescript
+const params = query.toObject();
+// By default, nested objects are converted to JSON strings
+// {
+//   where: '{"isActive":{"$eq":true}}',
+//   relations: '["posts"]',
+//   skip: 0,
+//   take: 10
+// }
+
+// Keep nested objects as objects
+const paramsNested = query.toObject(true);
+// {
+//   where: { isActive: { $eq: true } },
+//   relations: ['posts'],
+//   skip: 0,
+//   take: 10
+// }
+```
+
+##### `toJson(): string`
+
+Convert to JSON string.
+
+```typescript
+const json = query.toJson();
+// '{"where":{"isActive":{"$eq":true}},"relations":["posts"],"skip":0,"take":10}'
+```
+
+### WhereBuilder
+
+The WhereBuilder is used internally by QueryBuilder but can also be used standalone.
+
+```typescript
+import { WhereBuilder, WhereOperatorEnum } from '@ackplus/nest-crud-request';
+
+const whereBuilder = new WhereBuilder()
+  .where('isActive', WhereOperatorEnum.EQ, true)
+  .andWhere('role', WhereOperatorEnum.IN, ['admin', 'moderator']);
+
+const whereObject = whereBuilder.toObject();
+const whereJson = whereBuilder.toJson();
+```
+
+### Operators
+
+```typescript
+enum WhereOperatorEnum {
+  EQ = '$eq',              // Equal
+  NOT_EQ = '$ne',          // Not equal
+  GT = '$gt',              // Greater than
+  GT_OR_EQ = '$gte',       // Greater than or equal
+  LT = '$lt',              // Less than
+  LT_OR_EQ = '$lte',       // Less than or equal
+  IN = '$in',              // In array
+  NOT_IN = '$notIn',       // Not in array
+  LIKE = '$like',          // Like (case-sensitive)
+  NOT_LIKE = '$notLike',   // Not like
+  ILIKE = '$iLike',        // Like (case-insensitive)
+  NOT_ILIKE = '$notIlike', // Not like (case-insensitive)
+  IS_NULL = '$isNull',     // Is null
+  IS_NOT_NULL = '$isNotNull', // Is not null
+  BETWEEN = '$between',    // Between
+  NOT_BETWEEN = '$notBetween', // Not between
+  IS_TRUE = '$isTrue',     // Is true
+  IS_FALSE = '$isFalse',   // Is false
+}
+```
+
+### Order Direction
+
+```typescript
+enum OrderDirectionEnum {
+  ASC = 'ASC',
+  DESC = 'DESC',
+}
+```
+
+## Advanced Examples
+
+### Complex Filtering
+
+```typescript
+const query = new QueryBuilder()
+  .where((builder) => {
+    builder
+      .where('isActive', WhereOperatorEnum.EQ, true)
+      .andWhere((subBuilder) => {
+        subBuilder
+          .where('role', WhereOperatorEnum.EQ, 'admin')
+          .orWhere('role', WhereOperatorEnum.EQ, 'moderator');
+      })
+      .andWhere('age', WhereOperatorEnum.BETWEEN, [18, 65]);
+  });
+
+// Results in:
+// {
+//   isActive: { $eq: true },
+//   $and: [
+//     {
+//       $or: [
+//         { role: { $eq: 'admin' } },
+//         { role: { $eq: 'moderator' } }
+//       ]
+//     },
+//     { age: { $between: [18, 65] } }
+//   ]
+// }
+```
+
+### Search Functionality
+
+```typescript
+function buildSearchQuery(searchTerm: string) {
+  return new QueryBuilder()
+    .where((builder) => {
+      builder
+        .where('email', WhereOperatorEnum.ILIKE, `%${searchTerm}%`)
+        .orWhere('firstName', WhereOperatorEnum.ILIKE, `%${searchTerm}%`)
+        .orWhere('lastName', WhereOperatorEnum.ILIKE, `%${searchTerm}%`);
+    })
+    .addOrder('email', OrderDirectionEnum.ASC);
+}
+
+// Usage
+const searchQuery = buildSearchQuery('john');
+const params = searchQuery.toObject();
+```
+
+### Pagination Helper
+
+```typescript
+function buildPaginatedQuery(page: number, pageSize: number = 10) {
+  return new QueryBuilder()
+    .setSkip(page * pageSize)
+    .setTake(pageSize);
+}
+
+// Usage
+const paginatedQuery = buildPaginatedQuery(2, 20); // Page 3, 20 items per page
+```
+
+### Reusable Query Builder
+
+```typescript
+class UserQueryBuilder {
+  private builder: QueryBuilder;
+
+  constructor() {
+    this.builder = new QueryBuilder();
+  }
+
+  activeUsers() {
+    this.builder.andWhere('isActive', WhereOperatorEnum.EQ, true);
+    return this;
+  }
+
+  admins() {
+    this.builder.andWhere('role', WhereOperatorEnum.EQ, 'admin');
+    return this;
+  }
+
+  withPosts() {
+    this.builder.addRelation('posts', ['id', 'title', 'createdAt']);
+    return this;
+  }
+
+  paginate(page: number, pageSize: number = 10) {
+    this.builder.setSkip(page * pageSize).setTake(pageSize);
+    return this;
+  }
+
+  orderByNewest() {
+    this.builder.addOrder('createdAt', OrderDirectionEnum.DESC);
+    return this;
+  }
+
+  build() {
+    return this.builder.toObject();
+  }
+}
+
+// Usage
+const params = new UserQueryBuilder()
+  .activeUsers()
+  .admins()
+  .withPosts()
+  .paginate(0, 10)
+  .orderByNewest()
+  .build();
+```
+
+### Dynamic Filters
+
+```typescript
+interface FilterOptions {
+  search?: string;
+  role?: string;
+  isActive?: boolean;
+  minAge?: number;
+  maxAge?: number;
+}
+
+function buildDynamicQuery(filters: FilterOptions) {
+  const query = new QueryBuilder();
+
+  if (filters.search) {
+    query.where((builder) => {
+      builder
+        .where('email', WhereOperatorEnum.ILIKE, `%${filters.search}%`)
+        .orWhere('firstName', WhereOperatorEnum.ILIKE, `%${filters.search}%`)
+        .orWhere('lastName', WhereOperatorEnum.ILIKE, `%${filters.search}%`);
+    });
+  }
+
+  if (filters.role) {
+    query.andWhere('role', WhereOperatorEnum.EQ, filters.role);
+  }
+
+  if (filters.isActive !== undefined) {
+    query.andWhere('isActive', WhereOperatorEnum.EQ, filters.isActive);
+  }
+
+  if (filters.minAge !== undefined && filters.maxAge !== undefined) {
+    query.andWhere('age', WhereOperatorEnum.BETWEEN, [filters.minAge, filters.maxAge]);
+  } else if (filters.minAge !== undefined) {
+    query.andWhere('age', WhereOperatorEnum.GT_OR_EQ, filters.minAge);
+  } else if (filters.maxAge !== undefined) {
+    query.andWhere('age', WhereOperatorEnum.LT_OR_EQ, filters.maxAge);
+  }
+
+  return query;
+}
+
+// Usage
+const params = buildDynamicQuery({
+  search: 'john',
+  role: 'admin',
+  isActive: true,
+  minAge: 18,
+  maxAge: 65,
+}).toObject();
+```
+
+## TypeScript Support
+
+Full TypeScript support with type definitions:
+
+```typescript
+import {
+  QueryBuilder,
+  QueryBuilderOptions,
+  WhereOperatorEnum,
+  OrderDirectionEnum,
+  WhereBuilder,
+  WhereOptions,
+  RelationOptions,
+} from '@ackplus/nest-crud-request';
+
+// Type-safe query building
+const options: QueryBuilderOptions = {
+  where: { isActive: { $eq: true } },
+  relations: ['posts'],
+  select: ['id', 'email'],
+  skip: 0,
+  take: 10,
+  order: { createdAt: 'DESC' },
+};
+
+const query = new QueryBuilder(options);
+```
+
+## Best Practices
+
+1. **Validate user input** - Always sanitize and validate search terms and filters from user input
+2. **Set reasonable limits** - Use `setTake()` with reasonable defaults to prevent large data transfers
+3. **Use select fields** - Only select fields you need to reduce payload size
+4. **Reuse query builders** - Create reusable query builder classes for common patterns
+5. **Type your responses** - Use TypeScript interfaces for API responses
+6. **Handle errors** - Always handle network errors and invalid responses
+7. **Cache when possible** - Cache query results when data doesn't change frequently
+8. **Optimize relations** - Only load relations you actually need
+
+## Framework-Specific Tips
+
+### React
+
+- Use `useMemo` to memoize query builders
+- Create custom hooks for common queries
+- Combine with React Query or SWR for caching
+
+### Angular
+
+- Create service classes for query building
+- Use Angular's HttpClient for automatic JSON parsing
+- Leverage RxJS operators for query composition
+
+### Vue
+
+- Use composables for query logic
+- Leverage Vue's reactivity for dynamic queries
+- Combine with Pinia for state management
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Related Packages
+
+- [@ackplus/nest-crud](../nest-crud) - NestJS CRUD operations with TypeORM

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './lib/query-builder';
+export * from './lib/where-builder';
+export * from './lib/types';

package/dist/lib/query-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-builder.d.ts","sourceRoot":"","sources":["../../src/lib/query-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElE,OAAO,EAAgB,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGtE,qBAAa,YAAY;IAErB,OAAO,CAAC,OAAO,CAA2B;IAE1C,OAAO,CAAC,YAAY,CAAoC;IAExD,OAAO,CAAC,eAAe,CAA0C;gBAErD,OAAO,CAAC,EAAE,mBAAmB;IAMzC,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAO9C,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,UAAQ,GAAG,IAAI;IAc9D,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAa1C,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAY7C,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAKnF,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKtC,KAAK,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK3C,QAAQ,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK9C,OAAO,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK7C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAQ1D,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOlC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAK1C,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAK1C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAKlC,QAAQ,CAAC,uBAAuB,UAAQ;;;;;;;;;;;IAoDxC,MAAM;CAKT"}

package/{src → dist}/lib/query-builder.js

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryBuilder = void 0;
-const relation_builder_1 = require("./relation-builder");
-const utils_1 = require("./utils");
-const where_builder_1 = require("./where-builder");
-class QueryBuilder {
+import { RelationBuilder } from './relation-builder';
+import { deepMerge } from './utils';
+import { WhereBuilder } from './where-builder';
+export class QueryBuilder {
     options = {};
-    whereBuilder = new where_builder_1.WhereBuilder();
-    relationBuilder = new relation_builder_1.RelationBuilder();
+    whereBuilder = new WhereBuilder();
+    relationBuilder = new RelationBuilder();
     constructor(options) {
         if (options) {
             this.setOptions(options);
@@ -15,14 +12,14 @@ class QueryBuilder {
     }
     setOptions(options) {
         this.options = options;
-        this.whereBuilder = new where_builder_1.WhereBuilder(options.where);
-        this.relationBuilder = new relation_builder_1.RelationBuilder(options.relations);
+        this.whereBuilder = new WhereBuilder(options.where);
+        this.relationBuilder = new RelationBuilder(options.relations);
         return this;
     }
     mergeOptions(options, deep = false) {
         let updatedOptions = {};
         if (deep) {
-            updatedOptions = (0, utils_1.deepMerge)(this.options, options);
+            updatedOptions = deepMerge(this.options, options);
         }
         else {
             updatedOptions = {
@@ -170,4 +167,3 @@ class QueryBuilder {
         return JSON.stringify(obj);
     }
 }
-exports.QueryBuilder = QueryBuilder;

package/dist/lib/relation-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation-builder.d.ts","sourceRoot":"","sources":["../../src/lib/relation-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,eAAe,EAAE,MAAM,SAAS,CAAC;AAG/E,qBAAa,eAAe;IAExB,OAAO,CAAC,SAAS,CAAsB;gBAE3B,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM;IAOhD,YAAY,CAAC,SAAS,EAAE,eAAe,GAAG,IAAI;IAe9C,KAAK,IAAI,IAAI;IAKb,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAgB3E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK9B,YAAY,IAAI,OAAO;IAIvB,QAAQ,IAAI,cAAc;IAI1B,MAAM,IAAI,MAAM;CAInB"}

package/{src → dist}/lib/relation-builder.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelationBuilder = void 0;
-class RelationBuilder {
+export class RelationBuilder {
     relations = {};
     constructor(relations) {
         if (relations) {
@@ -59,4 +56,3 @@ class RelationBuilder {
         return JSON.stringify(this.relations);
     }
 }
-exports.RelationBuilder = RelationBuilder;

package/dist/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,KAAK,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,MAAM,CAAC;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,oBAAY,wBAAwB;IAChC,GAAG,SAAS;IACZ,EAAE,QAAQ;CACb;AAED,oBAAY,iBAAiB;IACzB,EAAE,QAAQ;IACV,MAAM,QAAQ;IACd,EAAE,QAAQ;IACV,QAAQ,SAAS;IACjB,EAAE,QAAQ;IACV,QAAQ,SAAS;IACjB,EAAE,QAAQ;IACV,MAAM,WAAW;IACjB,IAAI,UAAU;IACd,QAAQ,aAAa;IACrB,KAAK,WAAW;IAChB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,WAAW,eAAe;IAC1B,OAAO,aAAa;IACpB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACxB;AAED,oBAAY,kBAAkB;IAC1B,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACnC,GAAG,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAGvD,MAAM,MAAM,mBAAmB,GAAG;IAC9B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,CAAC;AAE3E,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,cAAc,CAAC"}

package/{src → dist}/lib/types.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderDirectionEnum = exports.WhereOperatorEnum = exports.WhereLogicalOperatorEnum = void 0;
-var WhereLogicalOperatorEnum;
+export var WhereLogicalOperatorEnum;
 (function (WhereLogicalOperatorEnum) {
     WhereLogicalOperatorEnum["AND"] = "$and";
     WhereLogicalOperatorEnum["OR"] = "$or";
-})(WhereLogicalOperatorEnum || (exports.WhereLogicalOperatorEnum = WhereLogicalOperatorEnum = {}));
-var WhereOperatorEnum;
+})(WhereLogicalOperatorEnum || (WhereLogicalOperatorEnum = {}));
+export var WhereOperatorEnum;
 (function (WhereOperatorEnum) {
     WhereOperatorEnum["EQ"] = "$eq";
     WhereOperatorEnum["NOT_EQ"] = "$ne";
@@ -26,9 +23,9 @@ var WhereOperatorEnum;
     WhereOperatorEnum["NOT_BETWEEN"] = "$notBetween";
     WhereOperatorEnum["IS_TRUE"] = "$isTrue";
     WhereOperatorEnum["IS_FALSE"] = "$isFalse";
-})(WhereOperatorEnum || (exports.WhereOperatorEnum = WhereOperatorEnum = {}));
-var OrderDirectionEnum;
+})(WhereOperatorEnum || (WhereOperatorEnum = {}));
+export var OrderDirectionEnum;
 (function (OrderDirectionEnum) {
     OrderDirectionEnum["ASC"] = "ASC";
     OrderDirectionEnum["DESC"] = "DESC";
-})(OrderDirectionEnum || (exports.OrderDirectionEnum = OrderDirectionEnum = {}));
+})(OrderDirectionEnum || (OrderDirectionEnum = {}));

package/dist/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,CAUvD"}

package/{src → dist}/lib/utils.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepMerge = deepMerge;
-function deepMerge(target, source) {
+export function deepMerge(target, source) {
     for (const key in source) {
         if (source[key] instanceof Object && key in target) {
             Object.assign(source[key], deepMerge(target[key], source[key]));

package/dist/lib/where-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-builder.d.ts","sourceRoot":"","sources":["../../src/lib/where-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGtE,MAAM,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC,CAAC;AAEjJ,qBAAa,YAAY;IAErB,OAAO,CAAC,WAAW,CAA2B;gBAElC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM;IAIhD,OAAO,CAAC,UAAU;IAIlB,KAAK,IAAI,IAAI;IAKb,KAAK,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK3C,QAAQ,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK9C,OAAO,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK7C,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAehC,aAAa,IAAI,OAAO;IAIxB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAI/B,MAAM,IAAI,MAAM;IAIhB,OAAO,CAAC,cAAc;IAuDtB,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,OAAO,CAAC,eAAe;CA0B1B"}

package/{src → dist}/lib/where-builder.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WhereBuilder = void 0;
-const types_1 = require("./types");
-class WhereBuilder {
+import { WhereLogicalOperatorEnum, WhereOperatorEnum } from './types';
+export class WhereBuilder {
     whereObject = {};
     constructor(where) {
         this.whereObject = typeof where === 'string' ? JSON.parse(where) : where || {};
@@ -19,11 +16,11 @@ class WhereBuilder {
         return this;
     }
     andWhere(...args) {
-        this.parseCondition(types_1.WhereLogicalOperatorEnum.AND, ...args);
+        this.parseCondition(WhereLogicalOperatorEnum.AND, ...args);
         return this;
     }
     orWhere(...args) {
-        this.parseCondition(types_1.WhereLogicalOperatorEnum.OR, ...args);
+        this.parseCondition(WhereLogicalOperatorEnum.OR, ...args);
         return this;
     }
     removeWhere(field) {
@@ -83,14 +80,14 @@ class WhereBuilder {
                         this.updateCondition({ [field]: value }, type);
                     }
                     else {
-                        this.updateCondition({ [field]: { [types_1.WhereOperatorEnum.EQ]: value } }, type);
+                        this.updateCondition({ [field]: { [WhereOperatorEnum.EQ]: value } }, type);
                     }
                 }
                 else if (this.isOperator(value)) {
                     this.updateCondition({ [field]: { [value]: true } }, type);
                 }
                 else {
-                    this.updateCondition({ [field]: { [types_1.WhereOperatorEnum.EQ]: value } }, type);
+                    this.updateCondition({ [field]: { [WhereOperatorEnum.EQ]: value } }, type);
                 }
             }
             else {
@@ -147,4 +144,3 @@ class WhereBuilder {
         }
     }
 }
-exports.WhereBuilder = WhereBuilder;

package/package.json

@@ -1,10 +1,47 @@
 {
   "name": "@ackplus/nest-crud-request",
-  "version": "1.1.8",
+  "version": "1.1.16",
+  "description": "Framework-agnostic query builder for REST APIs - build complex queries with filtering, relations, and pagination for both frontend and backend",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.build.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "query-builder",
+    "rest",
+    "api",
+    "frontend",
+    "backend",
+    "filtering",
+    "pagination",
+    "relations",
+    "typescript",
+    "nestjs",
+    "react",
+    "angular",
+    "vue"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ack-solutions/nest-crud"
+  },
+  "license": "MIT",
+  "author": "Ackplus",
   "dependencies": {
     "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3"
   }
-}
+}

package/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/nest-crud-request/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}

package/src/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/query-builder"), exports);
-tslib_1.__exportStar(require("./lib/where-builder"), exports);
-tslib_1.__exportStar(require("./lib/types"), exports);

package/src/lib/query-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-builder.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-crud-request/src/lib/query-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElE,OAAO,EAAgB,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGtE,qBAAa,YAAY;IAErB,OAAO,CAAC,OAAO,CAA2B;IAE1C,OAAO,CAAC,YAAY,CAAoC;IAExD,OAAO,CAAC,eAAe,CAA0C;gBAErD,OAAO,CAAC,EAAE,mBAAmB;IAMzC,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAO9C,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,UAAQ,GAAG,IAAI;IAc9D,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAa1C,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAY7C,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAKnF,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKtC,KAAK,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK3C,QAAQ,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK9C,OAAO,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK7C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAQ1D,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOlC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAK1C,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAK1C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAKlC,QAAQ,CAAC,uBAAuB,UAAQ;;;;;;;;;;;IAoDxC,MAAM;CAKT"}

package/src/lib/relation-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"relation-builder.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-crud-request/src/lib/relation-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,eAAe,EAAE,MAAM,SAAS,CAAC;AAG/E,qBAAa,eAAe;IAExB,OAAO,CAAC,SAAS,CAAsB;gBAE3B,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM;IAOhD,YAAY,CAAC,SAAS,EAAE,eAAe,GAAG,IAAI;IAe9C,KAAK,IAAI,IAAI;IAKb,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAgB3E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK9B,YAAY,IAAI,OAAO;IAIvB,QAAQ,IAAI,cAAc;IAI1B,MAAM,IAAI,MAAM;CAInB"}

package/src/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-crud-request/src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,KAAK,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,MAAM,CAAC;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,oBAAY,wBAAwB;IAChC,GAAG,SAAS;IACZ,EAAE,QAAQ;CACb;AAED,oBAAY,iBAAiB;IACzB,EAAE,QAAQ;IACV,MAAM,QAAQ;IACd,EAAE,QAAQ;IACV,QAAQ,SAAS;IACjB,EAAE,QAAQ;IACV,QAAQ,SAAS;IACjB,EAAE,QAAQ;IACV,MAAM,WAAW;IACjB,IAAI,UAAU;IACd,QAAQ,aAAa;IACrB,KAAK,WAAW;IAChB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,WAAW,eAAe;IAC1B,OAAO,aAAa;IACpB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACxB;AAED,oBAAY,kBAAkB;IAC1B,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACnC,GAAG,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAGvD,MAAM,MAAM,mBAAmB,GAAG;IAC9B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,CAAC;AAE3E,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,cAAc,CAAC"}

package/src/lib/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-crud-request/src/lib/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,CAUvD"}

package/src/lib/where-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"where-builder.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-crud-request/src/lib/where-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGtE,MAAM,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC,CAAC;AAEjJ,qBAAa,YAAY;IAErB,OAAO,CAAC,WAAW,CAA2B;gBAElC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM;IAIhD,OAAO,CAAC,UAAU;IAIlB,KAAK,IAAI,IAAI;IAKb,KAAK,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK3C,QAAQ,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK9C,OAAO,CAAC,GAAG,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAK7C,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAehC,aAAa,IAAI,OAAO;IAIxB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAI/B,MAAM,IAAI,MAAM;IAIhB,OAAO,CAAC,cAAc;IAuDtB,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,OAAO,CAAC,eAAe;CA0B1B"}