-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathDao.ts
527 lines (497 loc) · 14.4 KB
/
Dao.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/ban-types */
import {
Between,
EntityManager,
EntityTarget,
FindManyOptions,
FindOneOptions,
FindOptionsWhere,
ILike,
In,
LessThanOrEqual,
MoreThanOrEqual,
} from "typeorm";
import { QueryDeepPartialEntity } from "typeorm/query-builder/QueryPartialEntity";
import { BaseEntity } from "./BaseEntity";
import Database from "./database";
import log from "./log";
import { ErrorCode, Result, ResultWithCount, WithCount } from "./result";
export type _QueryDeepPartialEntity<T> = {
[P in keyof T]?:
| (T[P] extends Array<infer U>
? Array<_QueryDeepPartialEntity<U>>
: T[P] extends ReadonlyArray<infer U>
? ReadonlyArray<_QueryDeepPartialEntity<U>>
: _QueryDeepPartialEntity<T[P]>)
| (() => string);
};
export interface QueryOption<E> {
/**
* Page number
*/
page?: number;
/**
* Number of items per Page
*/
count?: number;
/**
* Order in which the entries should be returned
*/
order?: "ASC" | "DESC";
/**
* Field on which the order should be applied
*/
field?: keyof BaseEntity | keyof E;
/**
* Where condition
*/
where?: FindOptionsWhere<E> | FindOptionsWhere<E>[];
/**
* Like Conditions
*/
like?: { [key: string]: string };
/**
* Like Behaviour
* @default 'and'
*/
likeBehaviour?: "and" | "or";
/**
* From Created Date
*/
fromCreatedDate?: Date;
/**
* To Created Date
*/
toCreatedDate?: Date;
/**
* Database options
*/
dbOptions?: FindManyOptions<E>;
/**
* Non paginated
*/
nonPaginated?: boolean;
}
export type ReadManyOption<E> = QueryOption<E>;
export type Class<T> =
| {
new(): T;
}
| Function;
/**
* Data Access Object for the entities
* @class getDao
* @param Entity Entity to be used for the getDao
* @param name Name of the entityName
* @returns Dao
*/
export class Dao<Entity extends BaseEntity> {
protected database: Database;
protected entity: EntityTarget<Entity>;
protected entityName: string;
constructor(database: Database, entity: EntityTarget<Entity>, name: string) {
this.database = database;
this.entity = entity;
this.entityName = name;
}
/**
* Create a new entity
* @param value Value to be inserted
* @param manager EntityManager to be used for the operation (optional). Use only for transactions
* @returns
*/
async create(
value: _QueryDeepPartialEntity<Entity> | _QueryDeepPartialEntity<Entity>[],
manager?: EntityManager
): Promise<Result<number | string>> {
if (!manager) {
manager = this.database.getConnection().createEntityManager();
}
const repository = manager.getRepository(this.entity);
try {
const result = await repository.insert(value);
if (!(value instanceof Array)) {
value.id =
result.identifiers[0].id ??
(result.identifiers[0] as [key: string])[0];
}
log.info("Successfully created", `${this.entityName}/create`, {});
return new Result(
false,
ErrorCode.Created,
"Success in insert",
result.identifiers[0].id
);
} catch (error) {
log.error(
`Error in inserting ${this.entityName}`,
`${this.entityName}/insert`,
error
);
return new Result(true, ErrorCode.InternalServerError, "Error in insert");
}
}
/**
* Read a single entity
* @param value Id of the entity to be read
* @param manager EntityManager to be used for the operation (optional). Use only for transactions
* @returns Result with the entity
*/
async read(
value: string | number | FindOneOptions<Entity>,
manager?: EntityManager
): Promise<Result<Entity>> {
if (!manager) {
manager = this.database.getConnection().createEntityManager();
}
const repository = manager.getRepository(this.entity);
try {
let options: FindOneOptions;
if (typeof value === "number" || typeof value === "string") {
options = { where: { id: value } };
} else {
options = value;
}
const result = await repository.findOne(options);
if (!result) {
log.debug("Find not found", `${this.entityName}/read`, { id: value });
return new Result(true, ErrorCode.NotFound, "Not found");
}
log.debug("Successfully found", `${this.entityName}/read`, { id: value });
return new Result(false, ErrorCode.Success, "Success in read", result);
} catch (error) {
log.error("Error in reading", `${this.update}/read`, error, {
id: value,
});
return new Result(
true,
ErrorCode.InternalServerError,
"Error in reading"
);
}
}
/**
* Update a single entity
* @param id Id or the find where options of the entity to be updated
* @param values Values to be updated
* @param manager EntityManager to be used for the operation (optional). Use only for transactions
* @returns Result with the number of rows updated
*/
async update(
id: string | number | FindOptionsWhere<Entity>,
values: QueryDeepPartialEntity<Entity>,
manager?: EntityManager
): Promise<Result<number | null>> {
if (!manager) {
manager = this.database.getConnection().createEntityManager();
}
const repository = manager.getRepository(this.entity);
const copy = { ...values };
try {
const result = await repository.update(id, copy);
if (result.affected === 0) {
log.debug("No rows updated", `${this.entityName}/update`, { id });
return new Result(
true,
ErrorCode.NoUpdatesPerformed,
"No updates performed"
);
}
log.debug("Successfully updated", `${this.entityName}/update`, { id });
return new Result(
false,
ErrorCode.Success,
"Success in update",
result.affected ?? null
);
} catch (error) {
log.error("Error in updating", `${this.entityName}/update`, error, {
id,
copy,
});
return new Result(
true,
ErrorCode.InternalServerError,
"Error in updating",
null
);
}
}
/**
* Parses the filter values. It parses the values like true and false which
* comes from query params as string to boolean and also converts the array
* based filters to In
*/
parseFilter(
where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]
): FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[] {
if (where instanceof Array) {
where = where.map((it) =>
this.parseFilter(it)
) as FindOptionsWhere<Entity>[];
return where;
}
Object.keys(where).forEach((key) => {
if ((where as any)[key] instanceof Array) {
(where as any)[key] = In((where as any)[key]);
}
if ((where as any)[key] === "true") {
(where as any)[key] = true;
}
if ((where as any)[key] === "false") {
(where as any)[key] = false;
}
});
return where;
}
/**
* Parses sort values. Sort object to work across relations need to have
* syntax: { entity: {field: ASC }}
*
*/
parseForSort(field: keyof Entity, order: "ASC" | "DESC") {
const result: any = {};
let level = result;
const sortLevels = field.toString().split(".") || [];
for (let i = sortLevels.length - 1; i >= 0; i--) {
const prop = sortLevels[i];
if (i === sortLevels.length - 1) {
level[prop] = order || "ASC";
} else {
const newLevel = { [prop]: level };
level = newLevel;
}
}
return level;
}
/**
* Parses the like values. It parses the values to ILike for case insensitive
* search. It takes a likeBehaviour which can be 'and' or 'or'. This dictates
* how the like values are combined. If 'and' is passed, all the values are
* combined with AND. If 'or' is passed, all the values are combined with OR.
*/
parseForLike(
like?: { [key: string]: string },
likeBehaviour: "and" | "or" = "and"
) {
let parsedLike: { [key: string]: string } | { [key: string]: string }[];
if (like && likeBehaviour === "and") {
parsedLike = Object.keys(like).reduce((acc, it) => {
acc[it] = ILike((like as any)[it] as string);
return acc;
}, {} as any);
} else if (like && likeBehaviour === "or") {
parsedLike = Object.keys(like).map((it) => ({
[it]: ILike((like as any)[it]),
})) as any;
if ((parsedLike?.length ?? 0) === 0) {
parsedLike = {};
}
} else {
parsedLike = {};
}
return parsedLike;
}
/**
* Parses the date values. It parses the values to MoreThanOrEqual AND
* LessThanOrEqual for date range search. It takes a from and to 2024-03-21
* values. If both are passed, it combines them with Between. If only fromCreatedDate
* is passed, it uses MoreThanOrEqual. If only toCreatedDate is passed, it uses
* LessThanOrEqual.
*/
parseForDates(
field: keyof Entity,
from?: Date | string,
to?: Date | string,
where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]
) {
if (from && to && !(where instanceof Array)) {
if (!where) {
where = {};
}
where = { ...where, [field]: Between(from, to) };
} else if (from && !(where instanceof Array)) {
if (!where) {
where = {};
}
where = { ...where, createdAt: MoreThanOrEqual(from) };
} else if (to && !(where instanceof Array)) {
if (!where) {
where = {};
}
where = { ...where, createdAt: LessThanOrEqual(to) };
}
return where;
}
/**
* Parses the where values. It combines all the values like where, like, fromCreatedDate
* and toCreatedDate to a single where object. It also takes a likeBehaviour which can
* be 'and' or 'or'. This dictates how the like values are combined. If 'and' is passed,
* all the values are combined with AND. If 'or' is passed, all the values are combined
* with OR.
*/
parseWhere(
where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[],
like?: { [key: string]: string },
likeBehaviour?: "and" | "or",
fromCreatedDate?: Date,
toCreatedDate?: Date
) {
if (where) {
where = this.parseFilter(where);
}
where = this.parseForDates(
"createdAt",
fromCreatedDate,
toCreatedDate,
where
);
const parsedLike = this.parseForLike(like, likeBehaviour);
where = this.mergeParseLikeWhere(parsedLike, like, likeBehaviour, where);
return where;
}
/**
* Merges the parsed like values with the where values. It takes a parsedLike
* which is the parsed like values, like which is the original like values, likeBehaviour
* which can be 'and' or 'or'.
*/
mergeParseLikeWhere(
parsedLike: { [key: string]: string } | { [key: string]: string }[],
like?: { [key: string]: string },
likeBehaviour?: "and" | "or",
where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[] = {}
) {
if (Array.isArray(where)) {
return where;
}
if (likeBehaviour === "and") {
where = { ...where, ...(parsedLike as any) };
} else if (likeBehaviour === "or" && parsedLike instanceof Array) {
where = parsedLike.map((a) => {
return { ...where, ...a };
}) as FindOptionsWhere<Entity>[];
} else {
where = { ...where, ...(parsedLike as any) };
}
return where;
}
/**
* Read a paginated list of entities
* @returns Result with the list of entities
*/
async readMany(
options?: ReadManyOption<Entity>,
manager?: EntityManager
): Promise<WithCount<Result<Entity[]>>> {
const {
page = 1,
count = 10,
order = "DESC",
field = "createdAt" as keyof Entity,
where,
fromCreatedDate,
toCreatedDate,
like,
likeBehaviour = "and",
nonPaginated = false,
dbOptions,
} = options ?? {};
if (!manager) {
manager = this.database.getConnection().createEntityManager();
}
const repository = manager.getRepository(this.entity);
try {
const parsedWhere = this.parseWhere(
where,
like,
likeBehaviour,
fromCreatedDate,
toCreatedDate
);
const orderValue: any = this.parseForSort(field, order);
log.debug("Read many values", "readMany", { orderValue, parsedWhere });
const findOptions = {
where: parsedWhere,
order: orderValue,
...dbOptions,
};
if (!nonPaginated) {
findOptions["skip"] = (page - 1) * count;
findOptions["take"] = count;
}
const result = await repository.find(findOptions);
log.debug("Successfully found", `${this.entityName}/readMany`, {
page,
count,
orderValue,
field,
});
const totalCount = await repository.count({ where: parsedWhere });
return new ResultWithCount(
false,
ErrorCode.Success,
"Success in readMany",
result,
totalCount
);
} catch (error) {
log.error("Error in reading", `${this.entityName}/readMany`, error, {
page,
count,
order,
field,
});
return new ResultWithCount(
true,
ErrorCode.InternalServerError,
"Error in reading",
null,
null
);
}
}
/**
* Delete entities
* @param id Id , ids or Conditions of the entity to be deleted
* @param manager EntityManager to be used for the operation (optional). Use only for transactions
* @returns
*/
async delete(
id: string | number | string[] | FindOptionsWhere<Entity>,
manager?: EntityManager
): Promise<Result<number>> {
if (!manager) {
manager = this.database.getConnection().createEntityManager();
}
const repository = manager.getRepository(this.entity);
try {
const result = await repository.delete(id);
if (result.affected === 0) {
log.debug("Delete not found", `${this.entityName}/delete`, { id });
return new Result(
true,
ErrorCode.NotFound,
"Not found",
result.affected
);
}
log.debug("Successfully deleted", `${this.entityName}/delete`, { id });
return new Result(
false,
ErrorCode.Success,
"Success in delete",
result.affected ?? 0
);
} catch (error) {
log.error("Error in deleting", `${this.entityName}/delete`, error, {
id,
});
return new Result(
true,
ErrorCode.InternalServerError,
"Error in deleting"
);
}
}
}