@ackplus/nest-crud-request 0.0.1 → 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ack Solutions
+
+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

@@ -1,11 +1,135 @@
-# nest-crud-request
+# @ackplus/nest-crud-request
 
-This library was generated with [Nx](https://nx.dev).
+A frontend utility package for building and formatting requests compatible with @ackplus/nest-crud backend. This package provides a type-safe way to construct CRUD requests with proper query parameters, filters, sorting, and pagination.
 
-## Building
+## Features
 
-Run `nx build nest-crud-request` to build the library.
+- Type-safe request builder
+- Query parameter construction
+- Filter builder
+- Sort builder
+- Search builder
+- Pagination builder
+- Request validation
+- Automatic URL parameter encoding
 
-## 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
+yarn add @ackplus/nest-crud-request
+```
+
+## Quick Start
+
+1. Import the request builder:
+
+```typescript
+import { CrudRequestBuilder } from '@ackplus/nest-crud-request';
+```
+
+2. Create and use the request builder:
+
+```typescript
+// Create a new request builder
+const request = new CrudRequestBuilder();
+
+// Add pagination
+request.paginate(1, 10);
+
+// Add sorting
+request.sort('name', 'asc');
+
+// Add filters
+request.filter('status', 'active');
+
+// Add search
+request.search('john');
+
+// Build the request
+const queryParams = request.build();
+// Result: ?page=1&limit=10&sort=name&order=asc&filter[status]=active&search=john
+
+// Use with your HTTP client
+const response = await axios.get(`/api/users${queryParams}`);
+```
+
+## API Documentation
+
+### CrudRequestBuilder
+
+The main class for building CRUD requests.
+
+#### Methods
+
+- `paginate(page: number, limit: number)` - Set pagination parameters
+- `sort(field: string, order: 'asc' | 'desc')` - Add sort parameters
+- `filter(field: string, value: any)` - Add filter conditions
+- `search(term: string)` - Add search term
+- `build()` - Build the request and return query string
+
+### Types
+
+- `CrudRequest` - Type definition for the request structure
+- `Filter` - Type for filter conditions
+- `Sort` - Type for sort conditions
+- `Pagination` - Type for pagination parameters
+
+## Examples
+
+### Basic Usage
+
+```typescript
+const request = new CrudRequestBuilder()
+  .paginate(1, 10)
+  .sort('createdAt', 'desc')
+  .filter('status', 'active')
+  .search('john')
+  .build();
+
+// Use with fetch
+const response = await fetch(`/api/users${request}`);
+```
+
+### Advanced Filtering
+
+```typescript
+const request = new CrudRequestBuilder()
+  .filter('age', { $gt: 18 })
+  .filter('status', { $in: ['active', 'pending'] })
+  .build();
+
+// Result: ?filter[age][$gt]=18&filter[status][$in]=active,pending
+```
+
+### Multiple Sorts
+
+```typescript
+const request = new CrudRequestBuilder()
+  .sort('name', 'asc')
+  .sort('age', 'desc')
+  .build();
+
+// Result: ?sort=name,age&order=asc,desc
+```
+
+### Complex Search
+
+```typescript
+const request = new CrudRequestBuilder()
+  .search('john doe')
+  .filter('department', 'IT')
+  .paginate(1, 20)
+  .build();
+
+// Result: ?search=john%20doe&filter[department]=IT&page=1&limit=20
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the terms of the MIT license.

package/eslint.config.cjs

@@ -0,0 +1,22 @@
+const baseConfig = require('../../eslint.base.config.js');
+
+module.exports = [
+    ...baseConfig,
+    {
+        files: ['**/*.json'],
+        rules: {
+            '@nx/dependency-checks': [
+                'error',
+                {
+                    ignoredFiles: [
+                        '{projectRoot}/eslint.config.{js,cjs,mjs}',
+                        '{projectRoot}/vite.config.{js,ts,mjs,mts}',
+                    ],
+                },
+            ],
+        },
+        languageOptions: {
+            parser: require('jsonc-eslint-parser'),
+        },
+    },
+];

package/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+    displayName: 'nest-crud-request',
+    preset: '../../jest.preset.js',
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../coverage/packages/nest-crud-request',
+};

package/package.json

@@ -1,10 +1,16 @@
 {
-    "name": "@ackplus/nest-crud-request",
-    "version": "0.0.1",
-    "type": "module",
-    "main": "./index.js",
-    "types": "./index.d.ts",
-    "dependencies": {
-        "tslib": "^2.3.0"
-    }
+  "name": "@ackplus/nest-crud-request",
+  "version": "0.0.6",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ack-solutions/packages.git"
+  },
+  "homepage": "https://github.com/ack-solutions/packages.git#readme",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
 }

package/project.json

@@ -0,0 +1,9 @@
+{
+    "name": "nest-crud-request",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "packages/nest-crud-request/src",
+    "projectType": "library",
+    "tags": [],
+    "// targets": "to see all targets run: nx show project nest-crud-request --web",
+    "targets": {}
+}

package/src/index.js

@@ -0,0 +1,7 @@
+"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);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,8DAAoC;AACpC,sDAA4B"}

package/src/index.ts

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

package/{lib → src/lib}/query-builder.d.ts

@@ -20,7 +20,7 @@ export declare class QueryBuilder {
     setTake(take: number): this;
     toObject(): {
         select?: string[];
-        relations?: string[] | import('./types').Relation[];
+        relations?: string[] | import("./types").Relation[];
         where?: Record<string, any>;
         order?: Record<string, OrderDirectionEnum>;
         skip?: number;

package/src/lib/query-builder.js

@@ -0,0 +1,123 @@
+"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 {
+    constructor(options) {
+        this.options = {};
+        this.whereBuilder = new where_builder_1.WhereBuilder();
+        this.relationBuilder = new relation_builder_1.RelationBuilder();
+        this.options = options;
+        this.setOptions(options);
+    }
+    setOptions(options) {
+        this.options = options;
+        this.whereBuilder = new where_builder_1.WhereBuilder(options.where);
+        this.relationBuilder = new relation_builder_1.RelationBuilder(options.relations);
+        return this;
+    }
+    mergeOptions(options, deep = false) {
+        let updatedOptions = {};
+        if (deep) {
+            updatedOptions = (0, utils_1.deepMerge)(this.options, options);
+        }
+        else {
+            updatedOptions = {
+                ...this.options,
+                ...options,
+            };
+        }
+        this.setOptions(updatedOptions);
+        return this;
+    }
+    addSelect(fields) {
+        if (!this.options.select) {
+            this.options.select = [];
+        }
+        if (Array.isArray(fields)) {
+            this.options.select.push(...fields);
+        }
+        else {
+            this.options.select.push(fields);
+        }
+        return this;
+    }
+    removeSelect(fields) {
+        if (this.options.select) {
+            if (Array.isArray(fields)) {
+                this.options.select = this.options.select.filter(field => !fields.includes(field));
+            }
+            else {
+                this.options.select = this.options.select.filter(field => field !== fields);
+            }
+        }
+        return this;
+    }
+    addRelation(relation, select, where) {
+        this.relationBuilder.add(relation, select, where);
+        return this;
+    }
+    removeRelation(relation) {
+        this.relationBuilder.remove(relation);
+        return this;
+    }
+    where(...args) {
+        this.whereBuilder.where(...args);
+        return this;
+    }
+    andWhere(...args) {
+        this.whereBuilder.andWhere(...args);
+        return this;
+    }
+    orWhere(...args) {
+        this.whereBuilder.orWhere(...args);
+        return this;
+    }
+    addOrder(orderBy, order) {
+        if (!this.options.order) {
+            this.options.order = {};
+        }
+        this.options.order[orderBy] = order;
+        return this;
+    }
+    removeOrder(orderBy) {
+        if (this.options.order) {
+            delete this.options.order[orderBy];
+        }
+        return this;
+    }
+    setSkip(skip) {
+        this.options.skip = skip;
+        return this;
+    }
+    setTake(take) {
+        this.options.take = take;
+        return this;
+    }
+    toObject() {
+        const options = {
+            ...this.options,
+        };
+        if (this.whereBuilder.hasConditions()) {
+            options.where = this.whereBuilder.toObject();
+        }
+        else {
+            delete options.where;
+        }
+        if (this.relationBuilder.hasRelations()) {
+            options.relations = this.relationBuilder.toObject();
+        }
+        else {
+            delete options.relations;
+        }
+        return options;
+    }
+    toJson() {
+        const obj = this.toObject();
+        return JSON.stringify(obj);
+    }
+}
+exports.QueryBuilder = QueryBuilder;
+//# sourceMappingURL=query-builder.js.map

package/src/lib/query-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-builder.js","sourceRoot":"","sources":["query-builder.ts"],"names":[],"mappings":";;;AAAA,yDAAqD;AAErD,mCAAoC;AACpC,mDAAsE;AAGtE,MAAa,YAAY;IAQrB,YAAY,OAA4B;QANhC,YAAO,GAAwB,EAAE,CAAC;QAElC,iBAAY,GAAiB,IAAI,4BAAY,EAAE,CAAC;QAEhD,oBAAe,GAAoB,IAAI,kCAAe,EAAE,CAAC;QAG7D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED,UAAU,CAAC,OAA4B;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,IAAI,4BAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,kCAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY,CAAC,OAA4B,EAAE,IAAI,GAAG,KAAK;QACnD,IAAI,cAAc,GAAG,EAAE,CAAC;QACxB,IAAI,IAAI,EAAE,CAAC;YACP,cAAc,GAAG,IAAA,iBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACJ,cAAc,GAAG;gBACb,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,OAAO;aACb,CAAC;QACN,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,SAAS,CAAC,MAAyB;QAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY,CAAC,MAAyB;QAClC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YACvF,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;YAChF,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAiB,EAAE,KAA2B;QACxE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,QAAgB;QAC3B,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,GAAG,IAA2B;QAChC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,GAAG,IAA2B;QACnC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,GAAG,IAA2B;QAClC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,OAAe,EAAE,KAAyB;QAC/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ;QACJ,MAAM,OAAO,GAAG;YACZ,GAAG,IAAI,CAAC,OAAO;SAClB,CAAC;QAEF,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YACpC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,OAAO,OAAO,CAAC,KAAK,CAAC;QACzB,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,EAAE,CAAC;YACtC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;aAAM,CAAC;YACJ,OAAO,OAAO,CAAC,SAAS,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,MAAM;QACF,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;CAEJ;AApID,oCAoIC"}

package/src/lib/query-builder.ts

@@ -0,0 +1,139 @@
+import { RelationBuilder } from './relation-builder';
+import { QueryBuilderOptions, OrderDirectionEnum } from './types';
+import { deepMerge } from './utils';
+import { WhereBuilder, WhereBuilderCondition } from './where-builder';
+
+
+export class QueryBuilder {
+
+    private options: QueryBuilderOptions = {};
+
+    private whereBuilder: WhereBuilder = new WhereBuilder();
+
+    private relationBuilder: RelationBuilder = new RelationBuilder();
+
+    constructor(options: QueryBuilderOptions) {
+        this.options = options;
+        this.setOptions(options);
+    }
+
+    setOptions(options: QueryBuilderOptions): this {
+        this.options = options;
+        this.whereBuilder = new WhereBuilder(options.where);
+        this.relationBuilder = new RelationBuilder(options.relations);
+        return this;
+    }
+
+    mergeOptions(options: QueryBuilderOptions, deep = false): this {
+        let updatedOptions = {};
+        if (deep) {
+            updatedOptions = deepMerge(this.options, options);
+        } else {
+            updatedOptions = {
+                ...this.options,
+                ...options,
+            };
+        }
+        this.setOptions(updatedOptions);
+        return this;
+    }
+
+    addSelect(fields: string | string[]): this {
+        if (!this.options.select) {
+            this.options.select = [];
+        }
+        if (Array.isArray(fields)) {
+            this.options.select.push(...fields);
+        } else {
+            this.options.select.push(fields);
+        }
+        return this;
+    }
+
+    removeSelect(fields: string | string[]): this {
+        if (this.options.select) {
+            if (Array.isArray(fields)) {
+                this.options.select = this.options.select.filter(field => !fields.includes(field));
+            } else {
+                this.options.select = this.options.select.filter(field => field !== fields);
+            }
+        }
+        return this;
+    }
+
+    addRelation(relation: string, select?: string[], where?: Record<string, any>): this {
+        this.relationBuilder.add(relation, select, where);
+        return this;
+    }
+
+    removeRelation(relation: string): this {
+        this.relationBuilder.remove(relation);
+        return this;
+    }
+
+    where(...args: WhereBuilderCondition): this {
+        this.whereBuilder.where(...args);
+        return this;
+    }
+
+    andWhere(...args: WhereBuilderCondition): this {
+        this.whereBuilder.andWhere(...args);
+        return this;
+    }
+
+    orWhere(...args: WhereBuilderCondition): this {
+        this.whereBuilder.orWhere(...args);
+        return this;
+    }
+
+    addOrder(orderBy: string, order: OrderDirectionEnum): this {
+        if (!this.options.order) {
+            this.options.order = {};
+        }
+        this.options.order[orderBy] = order;
+        return this;
+    }
+
+    removeOrder(orderBy: string): this {
+        if (this.options.order) {
+            delete this.options.order[orderBy];
+        }
+        return this;
+    }
+
+    setSkip(skip: number): this {
+        this.options.skip = skip;
+        return this;
+    }
+
+    setTake(take: number): this {
+        this.options.take = take;
+        return this;
+    }
+
+    toObject() {
+        const options = {
+            ...this.options,
+        };
+
+        if (this.whereBuilder.hasConditions()) {
+            options.where = this.whereBuilder.toObject();
+        } else {
+            delete options.where;
+        }
+
+        if (this.relationBuilder.hasRelations()) {
+            options.relations = this.relationBuilder.toObject();
+        } else {
+            delete options.relations;
+        }
+
+        return options;
+    }
+
+    toJson() {
+        const obj = this.toObject();
+        return JSON.stringify(obj);
+    }
+
+}

package/src/lib/relation-builder.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationBuilder = void 0;
+class RelationBuilder {
+    constructor(relations) {
+        this.relations = {};
+        if (relations) {
+            this.setRelations(relations);
+        }
+    }
+    setRelations(relations) {
+        if (relations) {
+            if (Array.isArray(relations)) {
+                relations.forEach(relation => {
+                    if (typeof relation === 'string') {
+                        this.add(relation);
+                    }
+                    else {
+                        this.add(relation.relation, relation.select, relation.where);
+                    }
+                });
+            }
+            else if (typeof relations === 'string') {
+                this.add(relations);
+            }
+            else {
+                this.relations = relations || {};
+            }
+        }
+        return this;
+    }
+    clear() {
+        this.relations = {};
+        return this;
+    }
+    add(relation, select, where) {
+        this.relations[relation] = {
+            relation,
+            select,
+            where,
+        };
+        return this;
+    }
+    remove(relation) {
+        delete this.relations[relation];
+        return this;
+    }
+    hasRelations() {
+        return Object.keys(this.relations).length > 0;
+    }
+    toObject() {
+        return Object.values(this.relations);
+    }
+    toJson() {
+        return JSON.stringify(this.relations);
+    }
+}
+exports.RelationBuilder = RelationBuilder;
+//# sourceMappingURL=relation-builder.js.map

package/src/lib/relation-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation-builder.js","sourceRoot":"","sources":["relation-builder.ts"],"names":[],"mappings":";;;AAGA,MAAa,eAAe;IAIxB,YAAY,SAA0C;QAF9C,cAAS,GAA6B,EAAE,CAAC;QAG7C,IAAI,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,YAAY,CAAC,SAAyC;QAClD,IAAI,SAAS,EAAE,CAAC;YACZ,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3B,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC/B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACvB,CAAC;yBAAM,CAAC;wBACJ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;oBACjE,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC;iBAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;gBACvC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;YACrC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,QAAgB,EAAE,MAAiB,EAAE,KAA2B;QAChE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG;YACvB,QAAQ;YACR,MAAM;YACN,KAAK;SACR,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY;QACR,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,QAAQ;QACJ,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;CAEJ;AA5DD,0CA4DC"}

package/src/lib/relation-builder.ts

@@ -0,0 +1,64 @@
+import { Relation } from './types';
+
+
+export class RelationBuilder {
+
+    private relations: Record<string, Relation> = {};
+
+    constructor(relations?: Relation[] | string[] | string) {
+        if (relations) {
+            this.setRelations(relations);
+        }
+    }
+
+    setRelations(relations: Relation[] | string[] | string): this {
+        if (relations) {
+            if (Array.isArray(relations)) {
+                relations.forEach(relation => {
+                    if (typeof relation === 'string') {
+                        this.add(relation);
+                    } else {
+                        this.add(relation.relation, relation.select, relation.where);
+                    }
+                });
+            } else if (typeof relations === 'string') {
+                this.add(relations);
+            } else {
+                this.relations = relations || {};
+            }
+        }
+        return this;
+    }
+
+    clear(): this {
+        this.relations = {};
+        return this;
+    }
+
+    add(relation: string, select?: string[], where?: Record<string, any>): this {
+        this.relations[relation] = {
+            relation,
+            select,
+            where,
+        };
+        return this;
+    }
+
+    remove(relation: string): this {
+        delete this.relations[relation];
+        return this;
+    }
+
+    hasRelations(): boolean {
+        return Object.keys(this.relations).length > 0;
+    }
+
+    toObject(): Relation[] {
+        return Object.values(this.relations);
+    }
+
+    toJson(): string {
+        return JSON.stringify(this.relations);
+    }
+
+}