@sdflc/backend-helpers 1.0.39 → 1.0.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/BaseCore.js CHANGED
@@ -602,6 +602,7 @@ var BaseCore = /** @class */ (function () {
602
602
  });
603
603
  });
604
604
  };
605
+ // eslint-disable-next-line
605
606
  BaseCore.prototype.defaultAfterAndBefore = function (params, opt) {
606
607
  return __awaiter(this, void 0, void 0, function () {
607
608
  return __generator(this, function (_a) {
@@ -733,6 +734,7 @@ var BaseCore = /** @class */ (function () {
733
734
  * @param params Object of parameters passed to the authenticate method
734
735
  * @returns Object with the jwtSecret and verifyTokenArgs
735
736
  */
737
+ // eslint-disable-next-line
736
738
  BaseCore.prototype.getJwtTokenSecretAndSettings = function (params) {
737
739
  return __awaiter(this, void 0, void 0, function () {
738
740
  var space;
@@ -774,6 +776,7 @@ var BaseCore = /** @class */ (function () {
774
776
  });
775
777
  });
776
778
  };
779
+ // eslint-disable-next-line
777
780
  BaseCore.prototype.authenticate = function (params, opt) {
778
781
  return __awaiter(this, void 0, void 0, function () {
779
782
  var context, authByToken, _a, spaceResult, space, _b, jwtSecret, verifyTokenArgs, verifyResult, token;
@@ -12,8 +12,9 @@ declare class BaseGateway {
12
12
  onListFilter(query: any, filterParams: any): Promise<void>;
13
13
  onUpdateFilter(query: any, filterParams: any): Promise<void>;
14
14
  onRemoveFilter(query: any, filterParams: any): Promise<void>;
15
- transformOnCreate(args: any): Promise<any>;
15
+ transformOnCreate(params: any): Promise<any>;
16
16
  transformOnUpdate(params: any, where?: any): Promise<any>;
17
+ transformOnSet(params: any): Promise<any>;
17
18
  transformOnRemove(args?: any): Promise<any>;
18
19
  getRequestId(): string;
19
20
  getContext(): ApiContext;
@@ -37,6 +38,6 @@ declare class BaseGateway {
37
38
  * @returns Array of updated or inserted objects
38
39
  */
39
40
  set(params: any): Promise<any[]>;
40
- remove(where: any, hardRemove?: boolean): Promise<any>;
41
+ remove(where: any): Promise<any>;
41
42
  }
42
43
  export { BaseGateway };
@@ -74,6 +74,7 @@ var BaseGateway = /** @class */ (function () {
74
74
  Object.assign(this.config, props);
75
75
  return this;
76
76
  };
77
+ // eslint-disable-next-line
77
78
  BaseGateway.prototype.generateId = function (args) {
78
79
  return __awaiter(this, void 0, void 0, function () {
79
80
  return __generator(this, function (_a) {
@@ -142,10 +143,11 @@ var BaseGateway = /** @class */ (function () {
142
143
  BaseGateway.prototype.onRemoveFilter = function (query, filterParams) {
143
144
  return __awaiter(this, void 0, void 0, function () {
144
145
  var hasStatus, arr;
146
+ var _this = this;
145
147
  return __generator(this, function (_a) {
146
148
  hasStatus = this.config.hasStatus;
147
149
  arr = (0, lodash_1.castArray)(filterParams);
148
- query = query.whereIn(constants_1.FIELDS.ID, arr.map(function (item) { return item[constants_1.FIELDS.ID]; }));
150
+ query = query.whereIn(this.getIdField(), arr.map(function (item) { return item[_this.getIdField()]; }));
149
151
  if (hasStatus === true) {
150
152
  query.where(constants_1.FIELDS.STATUS, '!=', utils_1.STATUSES.REMOVED);
151
153
  }
@@ -153,32 +155,33 @@ var BaseGateway = /** @class */ (function () {
153
155
  });
154
156
  });
155
157
  };
156
- BaseGateway.prototype.transformOnCreate = function (args) {
158
+ BaseGateway.prototype.transformOnCreate = function (params) {
157
159
  return __awaiter(this, void 0, void 0, function () {
158
160
  var _a, hasCreatedAt, hasCreatedBy, hasSpace, hasVersion, hasLang, localizationForField;
159
161
  return __generator(this, function (_b) {
160
162
  _a = this.config, hasCreatedAt = _a.hasCreatedAt, hasCreatedBy = _a.hasCreatedBy, hasSpace = _a.hasSpace, hasVersion = _a.hasVersion, hasLang = _a.hasLang, localizationForField = _a.localizationForField;
161
163
  if (hasCreatedAt) {
162
- args[constants_1.FIELDS.CREATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
164
+ params[constants_1.FIELDS.CREATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
163
165
  }
164
166
  if (hasCreatedBy) {
165
- if (args[constants_1.FIELDS.CREATED_BY] === undefined) {
166
- args[constants_1.FIELDS.CREATED_BY] = this.getContext().userId;
167
+ if (params[constants_1.FIELDS.CREATED_BY] === undefined) {
168
+ params[constants_1.FIELDS.CREATED_BY] = this.getContext().userId;
167
169
  }
168
170
  }
169
171
  if (hasSpace) {
170
- args[constants_1.FIELDS.SPACE_ID] = this.getContext().spaceId;
172
+ params[constants_1.FIELDS.SPACE_ID] = this.getContext().spaceId;
171
173
  }
172
174
  if (hasVersion) {
173
- args[constants_1.FIELDS.VERSION] = 0;
175
+ params[constants_1.FIELDS.VERSION] = 0;
174
176
  }
175
177
  if (hasLang && localizationForField) {
176
- args[constants_1.FIELDS.ID] = (0, utils_1.buildKey)([args[localizationForField], args[constants_1.FIELDS.LANG]]);
178
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
177
179
  }
178
- return [2 /*return*/, args];
180
+ return [2 /*return*/, params];
179
181
  });
180
182
  });
181
183
  };
184
+ // eslint-disable-next-line
182
185
  BaseGateway.prototype.transformOnUpdate = function (params, where) {
183
186
  return __awaiter(this, void 0, void 0, function () {
184
187
  var _a, hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField;
@@ -198,7 +201,46 @@ var BaseGateway = /** @class */ (function () {
198
201
  }
199
202
  }
200
203
  if (hasLang && localizationForField) {
201
- params[constants_1.FIELDS.ID] = (0, utils_1.buildKey)([params[localizationForField], params[constants_1.FIELDS.LANG]]);
204
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
205
+ }
206
+ return [2 /*return*/, params];
207
+ });
208
+ });
209
+ };
210
+ BaseGateway.prototype.transformOnSet = function (params) {
211
+ return __awaiter(this, void 0, void 0, function () {
212
+ var _a, hasCreatedAt, hasCreatedBy, hasSpace, hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField;
213
+ return __generator(this, function (_b) {
214
+ _a = this.config, hasCreatedAt = _a.hasCreatedAt, hasCreatedBy = _a.hasCreatedBy, hasSpace = _a.hasSpace, hasUpdatedAt = _a.hasUpdatedAt, hasUpdatedBy = _a.hasUpdatedBy, hasVersion = _a.hasVersion, hasLang = _a.hasLang, localizationForField = _a.localizationForField;
215
+ if (hasCreatedAt) {
216
+ params[constants_1.FIELDS.CREATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
217
+ }
218
+ if (hasCreatedBy) {
219
+ if (params[constants_1.FIELDS.CREATED_BY] === undefined) {
220
+ params[constants_1.FIELDS.CREATED_BY] = this.getContext().userId;
221
+ }
222
+ }
223
+ if (hasSpace) {
224
+ params[constants_1.FIELDS.SPACE_ID] = this.getContext().spaceId;
225
+ }
226
+ if (hasUpdatedAt) {
227
+ params[constants_1.FIELDS.UPDATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
228
+ }
229
+ if (hasUpdatedBy) {
230
+ if (params[constants_1.FIELDS.UPDATED_BY] === undefined) {
231
+ params[constants_1.FIELDS.UPDATED_BY] = this.getContext().userId;
232
+ }
233
+ }
234
+ if (hasVersion) {
235
+ if (params[constants_1.FIELDS.VERSION] != null && !isNaN(params[constants_1.FIELDS.VERSION])) {
236
+ params[constants_1.FIELDS.VERSION] = params[constants_1.FIELDS.VERSION] + 1;
237
+ }
238
+ else {
239
+ params[constants_1.FIELDS.VERSION] = 0;
240
+ }
241
+ }
242
+ if (hasLang && localizationForField) {
243
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
202
244
  }
203
245
  return [2 /*return*/, params];
204
246
  });
@@ -206,16 +248,17 @@ var BaseGateway = /** @class */ (function () {
206
248
  };
207
249
  BaseGateway.prototype.transformOnRemove = function (args) {
208
250
  return __awaiter(this, void 0, void 0, function () {
209
- var _a, hasRemovedAt, hasRemovedAtStr, hasStatus, hasRemovedBy, removalTime, obj;
251
+ var _a, hasRemovedAt, hasRemovedAtStr, hasStatus, hasRemovedBy, hasLang, localizationForField, removalTime, removalTimeStr, obj;
210
252
  return __generator(this, function (_b) {
211
- _a = this.config, hasRemovedAt = _a.hasRemovedAt, hasRemovedAtStr = _a.hasRemovedAtStr, hasStatus = _a.hasStatus, hasRemovedBy = _a.hasRemovedBy;
253
+ _a = this.config, hasRemovedAt = _a.hasRemovedAt, hasRemovedAtStr = _a.hasRemovedAtStr, hasStatus = _a.hasStatus, hasRemovedBy = _a.hasRemovedBy, hasLang = _a.hasLang, localizationForField = _a.localizationForField;
212
254
  removalTime = (0, dayjs_1.default)();
255
+ removalTimeStr = removalTime.format('YYYYMMDDTHHmmssZ');
213
256
  obj = __assign({}, (args || {}));
214
257
  if (hasRemovedAt) {
215
258
  obj[constants_1.FIELDS.REMOVED_AT] = removalTime.toDate();
216
259
  }
217
260
  if (hasRemovedAtStr === true) {
218
- obj[constants_1.FIELDS.REMOVED_AT_STR] = removalTime.format('YYYYMMDDTHHmmssZ');
261
+ obj[constants_1.FIELDS.REMOVED_AT_STR] = removalTimeStr;
219
262
  }
220
263
  if (hasStatus) {
221
264
  obj[constants_1.FIELDS.STATUS] = utils_1.STATUSES.REMOVED;
@@ -225,6 +268,9 @@ var BaseGateway = /** @class */ (function () {
225
268
  obj[constants_1.FIELDS.REMOVED_BY] = this.getContext().userId;
226
269
  }
227
270
  }
271
+ if (hasLang && localizationForField) {
272
+ obj[this.getIdField()] = this.getDb().raw("CONCAT(id, '-".concat(removalTimeStr, "')"));
273
+ }
228
274
  return [2 /*return*/, obj];
229
275
  });
230
276
  });
@@ -463,50 +509,95 @@ var BaseGateway = /** @class */ (function () {
463
509
  * @returns Array of updated or inserted objects
464
510
  */
465
511
  BaseGateway.prototype.set = function (params) {
512
+ var _a;
466
513
  return __awaiter(this, void 0, void 0, function () {
467
- var results, idField, items;
468
- return __generator(this, function (_a) {
469
- switch (_a.label) {
514
+ var _b, hasCreatedAt, hasCreatedBy, hasSpace, mergeFields, objects, skipFields, idx, len, object, _c, _d, _e, _f, fields, result, chunks, idx, len, items;
515
+ return __generator(this, function (_g) {
516
+ switch (_g.label) {
470
517
  case 0:
471
- results = [];
472
- idField = this.getIdField();
518
+ _b = this.config || {}, hasCreatedAt = _b.hasCreatedAt, hasCreatedBy = _b.hasCreatedBy, hasSpace = _b.hasSpace, mergeFields = _b.mergeFields;
519
+ objects = (0, lodash_1.castArray)(params);
520
+ if (!params || objects.length === 0) {
521
+ return [2 /*return*/, []];
522
+ }
523
+ skipFields = [];
524
+ if (hasCreatedAt) {
525
+ skipFields.push(constants_1.FIELDS.CREATED_AT);
526
+ }
527
+ if (hasCreatedBy) {
528
+ skipFields.push(constants_1.FIELDS.CREATED_BY);
529
+ }
530
+ if (hasSpace) {
531
+ skipFields.push(constants_1.FIELDS.SPACE_ID);
532
+ }
533
+ idx = 0, len = objects.length;
534
+ _g.label = 1;
535
+ case 1:
536
+ if (!(idx < len)) return [3 /*break*/, 5];
537
+ object = objects[idx];
538
+ _c = objects;
539
+ _d = idx;
540
+ return [4 /*yield*/, this.transformOnSet(object)];
541
+ case 2:
542
+ _c[_d] = _g.sent();
543
+ if (!(objects[idx][this.getIdField()] == null)) return [3 /*break*/, 4];
544
+ _e = objects[idx];
545
+ _f = this.getIdField();
546
+ return [4 /*yield*/, this.generateId(object)];
547
+ case 3:
548
+ _e[_f] = _g.sent();
549
+ _g.label = 4;
550
+ case 4:
551
+ ++idx;
552
+ return [3 /*break*/, 1];
553
+ case 5:
554
+ fields = Array.isArray(mergeFields) ? mergeFields : Object.keys(objects[0]);
555
+ result = [];
556
+ chunks = (0, utils_1.arrToChunks)(objects, ((_a = this.config) === null || _a === void 0 ? void 0 : _a.insertChunkSize) || DEFAULT_CHUNCK_SIZE);
557
+ idx = 0, len = chunks.length;
558
+ _g.label = 6;
559
+ case 6:
560
+ if (!(idx < len)) return [3 /*break*/, 9];
473
561
  return [4 /*yield*/, this.getBuilder()
474
- .insert((0, lodash_1.castArray)(params))
562
+ .insert(chunks[idx])
475
563
  .returning(this.config.returnFields)
476
- .onConflict(this.config.setFields || idField)
477
- .merge()];
478
- case 1:
479
- items = _a.sent();
480
- results.push.apply(results, items);
481
- return [2 /*return*/, results];
564
+ .onConflict(this.config.setFields || this.getIdField())
565
+ .merge((0, lodash_1.pullAll)(fields, skipFields))];
566
+ case 7:
567
+ items = _g.sent();
568
+ result.push.apply(result, items);
569
+ _g.label = 8;
570
+ case 8:
571
+ ++idx;
572
+ return [3 /*break*/, 6];
573
+ case 9: return [2 /*return*/, result];
482
574
  }
483
575
  });
484
576
  });
485
577
  };
486
- BaseGateway.prototype.remove = function (where, hardRemove) {
487
- if (hardRemove === void 0) { hardRemove = false; }
578
+ BaseGateway.prototype.remove = function (where) {
488
579
  return __awaiter(this, void 0, void 0, function () {
489
- var query, _a, _b, items;
580
+ var hardRemove, query, object, items;
490
581
  var _this = this;
491
- return __generator(this, function (_c) {
492
- switch (_c.label) {
582
+ return __generator(this, function (_a) {
583
+ switch (_a.label) {
493
584
  case 0:
585
+ hardRemove = (this.config || {}).hardRemove;
494
586
  query = this.getBuilder();
495
587
  if (!hardRemove) return [3 /*break*/, 1];
496
588
  query.delete(this.config.returnFields);
497
589
  return [3 /*break*/, 3];
498
- case 1:
499
- _b = (_a = query).update;
500
- return [4 /*yield*/, this.transformOnRemove()];
590
+ case 1: return [4 /*yield*/, this.transformOnRemove()];
501
591
  case 2:
502
- _b.apply(_a, [_c.sent()]).returning(this.config.returnFields);
503
- _c.label = 3;
592
+ object = _a.sent();
593
+ query.update(object).returning(this.config.returnFields);
594
+ _a.label = 3;
504
595
  case 3: return [4 /*yield*/, this.onRemoveFilter(query, where)];
505
596
  case 4:
506
- _c.sent();
597
+ _a.sent();
507
598
  return [4 /*yield*/, query];
508
599
  case 5:
509
- items = _c.sent();
600
+ items = _a.sent();
510
601
  if (items.length > 0 && this.config.noCache !== true) {
511
602
  items.forEach(function (item) { return _this.loader.clear(item[_this.getIdField()]); });
512
603
  }
@@ -9,7 +9,7 @@ declare class Database {
9
9
  createTransaction(trx: any): Promise<unknown>;
10
10
  getSchema(): string;
11
11
  getBuilder(arg: any): any;
12
- raw(query: string, bindings: any): any;
12
+ raw(query: string, bindings?: any): any;
13
13
  runRawQuery(query: string, bindings: any): Promise<any>;
14
14
  startTransaction(): Promise<unknown>;
15
15
  setTransaction(trx: any): void;
@@ -60,6 +60,7 @@ var shouldHaveId = function (id) {
60
60
  exports.shouldHaveId = shouldHaveId;
61
61
  var validateList = function (_a) {
62
62
  var rules = _a.rules;
63
+ // eslint-disable-next-line
63
64
  return function (args, opt) { return __awaiter(void 0, void 0, void 0, function () {
64
65
  var filter, result;
65
66
  return __generator(this, function (_a) {
@@ -75,6 +76,7 @@ var validateList = function (_a) {
75
76
  exports.validateList = validateList;
76
77
  var validateCreate = function (_a) {
77
78
  var rules = _a.rules;
79
+ // eslint-disable-next-line
78
80
  return function (args, opt) { return __awaiter(void 0, void 0, void 0, function () {
79
81
  var params, paramsCheck, result;
80
82
  return __generator(this, function (_a) {
@@ -94,6 +96,7 @@ var validateCreate = function (_a) {
94
96
  exports.validateCreate = validateCreate;
95
97
  var validateUpdate = function (_a) {
96
98
  var rules = _a.rules;
99
+ // eslint-disable-next-line
97
100
  return function (args, opt) { return __awaiter(void 0, void 0, void 0, function () {
98
101
  var _a, id, params, idCheck, paramsCheck, result;
99
102
  return __generator(this, function (_b) {
@@ -6,6 +6,7 @@ import { SortItemInterface } from './SortItemInterface';
6
6
  export interface BaseGatewayPropsInterface extends CacheInterface {
7
7
  context: ApiContext;
8
8
  setFields?: string[] | string;
9
+ mergeFields?: string[];
9
10
  hasStatus?: boolean;
10
11
  hasCreatedBy?: boolean;
11
12
  hasUpdatedBy?: boolean;
@@ -17,10 +18,11 @@ export interface BaseGatewayPropsInterface extends CacheInterface {
17
18
  hasSpace?: boolean;
18
19
  hasVersion?: boolean;
19
20
  hasLang?: boolean;
20
- localizationForField: string;
21
+ localizationForField?: string;
21
22
  defaultSorting?: SortItemInterface[];
22
23
  fieldForKeyword?: string;
23
24
  insertChunkSize?: number;
25
+ hardRemove?: boolean;
24
26
  loader?: LoaderInterface;
25
27
  noCache?: boolean;
26
28
  returnFields?: any[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sdflc/backend-helpers",
3
- "version": "1.0.39",
3
+ "version": "1.0.42",
4
4
  "description": "Set of helper functions and classes to simplify building backend apps within @sdflc ecosystem",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",