new way to send filters, removed include

Author: shivanshtalwar0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@januscaler/tsed-helper",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "type": "module",
   "publishConfig": {
     "@januscaler:registry": "https://npm.pkg.github.com"
@@ -36,9 +36,10 @@
     "@tsed/di": "8.15.0",
     "@tsed/prisma": "8.15.0",
     "@tsed/schema": "8.15.0",
+    "@types/lodash": "^4.17.20",
     "aigle": "1.14.1",
     "glob": "11.0.3",
     "lodash": "4.17.21",
     "rxjs": "7.8.2"
   }
-}
+}

src/baseCrud.ts

@@ -1,7 +1,8 @@
 import { useDecorators } from '@tsed/core';
 import { Delete, Get, inject, Post, Put, } from '@tsed/common';
-import { Any, CollectionOf, Default, Property, Returns, Summary } from '@tsed/schema';
+import { Any, CollectionOf, Default, Example, Property, Returns, Summary } from '@tsed/schema';
 import _ from 'lodash';
+import { SearchFilterRecord } from './types.js';
 
 function nameWithoutModel(model: any): string {
 	return _.replace(model.name, 'Model', '');
@@ -75,18 +76,9 @@ export interface GetItems {
 export class SearchParams {
 	@Default(10) limit?: number;
 	@Default(0) offset?: number;
-	@CollectionOf(Object) orderBy?: Record<string, 'asc' | 'desc'>;
-	@CollectionOf(String) fields?: string[];
-	@Any() @Default({}) filters?: Record<
-		string,
-		{
-			mode: string;
-			value: any;
-			isRelation?: boolean;
-		}
-	>;
-	@Any()
-	include?: any;
+	@Default({ id: 'asc' }) @CollectionOf(Object) orderBy?: Record<string, 'asc' | 'desc'>;
+	@Default(['name', 'roles.name']) @CollectionOf(String) fields?: string[];
+	@Default({ name: { mode: 'EQ', value: 'test', isRelation: false } }) @CollectionOf(Object) filters?: SearchFilterRecord[];
 }
 
 

src/baseService.ts

@@ -4,6 +4,7 @@ import { SearchParams } from './baseCrud.js';
 import { Subject } from 'rxjs';
 import { PrismaMapperEntity, PrismaMapperEntityField, PrismaMetaMapper } from './prismaMetaMapper.js'
 import { Generics } from '@tsed/schema';
+import { SearchFilterRecord, SearchFilterValue } from './types.js';
 
 export interface IBaseService {
 	onUpdate: Subject<{ id: number, inputData: any, result: any }>
@@ -129,7 +130,7 @@ export class BaseService<T> implements OnInit, IBaseService {
 		RG: 'RG'
 	};
 
-	protected modeToTypeMappers = {
+	protected modeToTypeMappers: Record<string, (prismaFilters: any, value: any, fieldName: string, fieldInfo: any, isRelation: boolean) => void> = {
 		EM: (prismaFilters: any, value: any, fieldName: string, fieldInfo: any, isRelation: boolean) => {
 			if (fieldInfo.type === 'Int' && !fieldInfo.isRequired) {
 				_.set(prismaFilters, `${fieldName}`, null);
@@ -211,41 +212,48 @@ export class BaseService<T> implements OnInit, IBaseService {
 		},
 	}
 
-	protected modeToFilter(filters?: Record<string, { mode: string; value: any, isRelation?: boolean }>) {
-		return _.transform(
-			filters ?? {},
-			(finalFilters: any, filter, fieldName) => {
-				const { mode, value, isRelation } = filter;
-				this.modeToTypeMappers[mode](finalFilters, value, fieldName, this.currentModelFieldsMapping[fieldName], isRelation);
-			},
-			{}
-		);
+	protected modeToPrismaFilter(filters: SearchFilterRecord) {
+		return _.transform<SearchFilterValue, any>(filters, (finalFilters, filter, fieldName) => {
+			const { mode, value, isRelation } = filter;
+			if (!_.has(this.modeToTypeMappers, mode)) {
+				throw new Error(`Unsupported filter mode: ${mode}`);
+			}
+			this.modeToTypeMappers[mode](finalFilters, value, fieldName, this.currentModelFieldsMapping[fieldName], isRelation);
+		}, {});
+	}
+
+	protected filtersToPrismaOrCondition(filters: SearchFilterRecord[]) {
+		return _.transform<SearchFilterRecord, any>(filters, (finalFilters, modeFilter) => {
+			if (!finalFilters.OR) {
+				finalFilters.OR = [];
+			}
+			const prismaFilter = this.modeToPrismaFilter(modeFilter);
+			finalFilters.OR.push(prismaFilter);
+		}, {});
 	}
 
-	async getAll({ filters, offset, limit, fields, include, orderBy }: SearchParams) {
+	async getAll({ filters, offset, limit, fields, orderBy }: SearchParams) {
+		const prismaWhere = this.filtersToPrismaOrCondition(filters)
+		const selectFields = _.transform(fields, (result, field) => {
+			if (_.includes(field, '.')) {
+				const [relations, relationColumnName] = _.split(field, '.')
+				if (!result[relations]) {
+					result[relations] = { select: {} };
+				}
+				result[relations].select[relationColumnName] = true;
+				return;
+			}
+			result[field] = true;
+		}, {})
 		const properties = {
 			skip: offset,
 			take: limit,
-			include: {
-				...include,
-				..._.transform(_.remove(fields, 'id'), (result, field) => {
-					result[field] = true;
-				}, {})
-			},
 			orderBy: orderBy,
-			where: this.modeToFilter(filters),
-			select: _.isNil(fields)
-				? null
-				: _.transform(fields, (result, field) => {
-					result[field] = true;
-				}, {})
+			where: prismaWhere,
+			select: selectFields
 		};
-		if (_.size(properties.include)) {
-			delete properties.select;
-		}
-
 		const { _count: { id: total } } = await this.injectedRepository.aggregate({
-			where: this.modeToFilter(filters),
+			where: prismaWhere,
 			_count: {
 				id: true,
 			}

src/index.ts

@@ -1,4 +1,5 @@
 export * from './baseCrud.js'
 export * from './baseService.js'
 export * from './prismaMetaMapper.js'
-export * from './seederHelper.js'
+export * from './seederHelper.js'
+export * from './types.js'

src/types.ts

@@ -0,0 +1,2 @@
+export type SearchFilterValue = { mode: string; value: any; isRelation?: boolean };
+export type SearchFilterRecord = Record<string, SearchFilterValue>