@sdflc/backend-helpers 1.0.40 → 1.0.43

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.
@@ -38,6 +38,6 @@ declare class BaseGateway {
38
38
  * @returns Array of updated or inserted objects
39
39
  */
40
40
  set(params: any): Promise<any[]>;
41
- remove(where: any, hardRemove?: boolean): Promise<any>;
41
+ remove(where: any): Promise<any>;
42
42
  }
43
43
  export { BaseGateway };
@@ -84,10 +84,10 @@ var BaseGateway = /** @class */ (function () {
84
84
  };
85
85
  BaseGateway.prototype.onListFilter = function (query, filterParams) {
86
86
  return __awaiter(this, void 0, void 0, function () {
87
- var _a, hasStatus, hasRemovedAt, hasSpace, activeStatuses, hasLang, fieldForKeyword;
88
- var _b;
89
- return __generator(this, function (_c) {
90
- _a = this.config || {}, hasStatus = _a.hasStatus, hasRemovedAt = _a.hasRemovedAt, hasSpace = _a.hasSpace, activeStatuses = _a.activeStatuses, hasLang = _a.hasLang, fieldForKeyword = _a.fieldForKeyword;
87
+ var _a, hasStatus, hasRemovedAt, hasSpace, activeStatuses, hasLang, fieldForKeyword, filterByUserField;
88
+ var _b, _c;
89
+ return __generator(this, function (_d) {
90
+ _a = this.config || {}, hasStatus = _a.hasStatus, hasRemovedAt = _a.hasRemovedAt, hasSpace = _a.hasSpace, activeStatuses = _a.activeStatuses, hasLang = _a.hasLang, fieldForKeyword = _a.fieldForKeyword, filterByUserField = _a.filterByUserField;
91
91
  // This function should be overriden
92
92
  if (hasStatus) {
93
93
  query.whereIn(constants_1.FIELDS.STATUS, Array.isArray(filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS]) ? filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS] : (0, lodash_1.castArray)(activeStatuses));
@@ -109,6 +109,9 @@ var BaseGateway = /** @class */ (function () {
109
109
  if (fieldForKeyword && filterParams.keyword) {
110
110
  query.whereRaw("".concat(fieldForKeyword, " ILIKE ?"), "%".concat(filterParams.keyword, "%"));
111
111
  }
112
+ if (filterByUserField) {
113
+ query.where((_c = {}, _c[filterByUserField] = this.getContext().userId, _c));
114
+ }
112
115
  return [2 /*return*/];
113
116
  });
114
117
  });
@@ -143,10 +146,11 @@ var BaseGateway = /** @class */ (function () {
143
146
  BaseGateway.prototype.onRemoveFilter = function (query, filterParams) {
144
147
  return __awaiter(this, void 0, void 0, function () {
145
148
  var hasStatus, arr;
149
+ var _this = this;
146
150
  return __generator(this, function (_a) {
147
151
  hasStatus = this.config.hasStatus;
148
152
  arr = (0, lodash_1.castArray)(filterParams);
149
- query = query.whereIn(constants_1.FIELDS.ID, arr.map(function (item) { return item[constants_1.FIELDS.ID]; }));
153
+ query = query.whereIn(this.getIdField(), arr.map(function (item) { return item[_this.getIdField()]; }));
150
154
  if (hasStatus === true) {
151
155
  query.where(constants_1.FIELDS.STATUS, '!=', utils_1.STATUSES.REMOVED);
152
156
  }
@@ -174,7 +178,7 @@ var BaseGateway = /** @class */ (function () {
174
178
  params[constants_1.FIELDS.VERSION] = 0;
175
179
  }
176
180
  if (hasLang && localizationForField) {
177
- params[this.getIdField()] = (0, utils_1.buildKey)([params[localizationForField], params[constants_1.FIELDS.LANG]]);
181
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
178
182
  }
179
183
  return [2 /*return*/, params];
180
184
  });
@@ -200,7 +204,7 @@ var BaseGateway = /** @class */ (function () {
200
204
  }
201
205
  }
202
206
  if (hasLang && localizationForField) {
203
- params[this.getIdField()] = (0, utils_1.buildKey)([params[localizationForField], params[constants_1.FIELDS.LANG]]);
207
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
204
208
  }
205
209
  return [2 /*return*/, params];
206
210
  });
@@ -208,9 +212,20 @@ var BaseGateway = /** @class */ (function () {
208
212
  };
209
213
  BaseGateway.prototype.transformOnSet = function (params) {
210
214
  return __awaiter(this, void 0, void 0, function () {
211
- var _a, hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField;
215
+ var _a, hasCreatedAt, hasCreatedBy, hasSpace, hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField;
212
216
  return __generator(this, function (_b) {
213
- _a = this.config, hasUpdatedAt = _a.hasUpdatedAt, hasUpdatedBy = _a.hasUpdatedBy, hasVersion = _a.hasVersion, hasLang = _a.hasLang, localizationForField = _a.localizationForField;
217
+ _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;
218
+ if (hasCreatedAt) {
219
+ params[constants_1.FIELDS.CREATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
220
+ }
221
+ if (hasCreatedBy) {
222
+ if (params[constants_1.FIELDS.CREATED_BY] === undefined) {
223
+ params[constants_1.FIELDS.CREATED_BY] = this.getContext().userId;
224
+ }
225
+ }
226
+ if (hasSpace) {
227
+ params[constants_1.FIELDS.SPACE_ID] = this.getContext().spaceId;
228
+ }
214
229
  if (hasUpdatedAt) {
215
230
  params[constants_1.FIELDS.UPDATED_AT] = this.dateTime.dbFormat(this.dateTimeNow);
216
231
  }
@@ -223,9 +238,12 @@ var BaseGateway = /** @class */ (function () {
223
238
  if (params[constants_1.FIELDS.VERSION] != null && !isNaN(params[constants_1.FIELDS.VERSION])) {
224
239
  params[constants_1.FIELDS.VERSION] = params[constants_1.FIELDS.VERSION] + 1;
225
240
  }
241
+ else {
242
+ params[constants_1.FIELDS.VERSION] = 0;
243
+ }
226
244
  }
227
245
  if (hasLang && localizationForField) {
228
- params[this.getIdField()] = (0, utils_1.buildKey)([params[localizationForField], params[constants_1.FIELDS.LANG]]);
246
+ params[this.getIdField()] = (0, utils_1.buildKey)([params[(0, lodash_1.camelCase)(localizationForField)], params[(0, lodash_1.camelCase)(constants_1.FIELDS.LANG)]]);
229
247
  }
230
248
  return [2 /*return*/, params];
231
249
  });
@@ -233,16 +251,17 @@ var BaseGateway = /** @class */ (function () {
233
251
  };
234
252
  BaseGateway.prototype.transformOnRemove = function (args) {
235
253
  return __awaiter(this, void 0, void 0, function () {
236
- var _a, hasRemovedAt, hasRemovedAtStr, hasStatus, hasRemovedBy, removalTime, obj;
254
+ var _a, hasRemovedAt, hasRemovedAtStr, hasStatus, hasRemovedBy, hasLang, localizationForField, removalTime, removalTimeStr, obj;
237
255
  return __generator(this, function (_b) {
238
- _a = this.config, hasRemovedAt = _a.hasRemovedAt, hasRemovedAtStr = _a.hasRemovedAtStr, hasStatus = _a.hasStatus, hasRemovedBy = _a.hasRemovedBy;
256
+ _a = this.config, hasRemovedAt = _a.hasRemovedAt, hasRemovedAtStr = _a.hasRemovedAtStr, hasStatus = _a.hasStatus, hasRemovedBy = _a.hasRemovedBy, hasLang = _a.hasLang, localizationForField = _a.localizationForField;
239
257
  removalTime = (0, dayjs_1.default)();
258
+ removalTimeStr = removalTime.format('YYYYMMDDTHHmmssZ');
240
259
  obj = __assign({}, (args || {}));
241
260
  if (hasRemovedAt) {
242
261
  obj[constants_1.FIELDS.REMOVED_AT] = removalTime.toDate();
243
262
  }
244
263
  if (hasRemovedAtStr === true) {
245
- obj[constants_1.FIELDS.REMOVED_AT_STR] = removalTime.format('YYYYMMDDTHHmmssZ');
264
+ obj[constants_1.FIELDS.REMOVED_AT_STR] = removalTimeStr;
246
265
  }
247
266
  if (hasStatus) {
248
267
  obj[constants_1.FIELDS.STATUS] = utils_1.STATUSES.REMOVED;
@@ -252,6 +271,9 @@ var BaseGateway = /** @class */ (function () {
252
271
  obj[constants_1.FIELDS.REMOVED_BY] = this.getContext().userId;
253
272
  }
254
273
  }
274
+ if (hasLang && localizationForField) {
275
+ obj[this.getIdField()] = this.getDb().raw("CONCAT(id, '-".concat(removalTimeStr, "')"));
276
+ }
255
277
  return [2 /*return*/, obj];
256
278
  });
257
279
  });
@@ -492,11 +514,11 @@ var BaseGateway = /** @class */ (function () {
492
514
  BaseGateway.prototype.set = function (params) {
493
515
  var _a;
494
516
  return __awaiter(this, void 0, void 0, function () {
495
- var _b, hasCreatedAt, hasCreatedBy, mergeFields, objects, skipFields, fields, idx, len, object, _c, _d, _e, _f, result, chunks, idx, len, items;
517
+ var _b, hasCreatedAt, hasCreatedBy, hasSpace, mergeFields, objects, skipFields, idx, len, object, _c, _d, _e, _f, fields, result, chunks, idx, len, items;
496
518
  return __generator(this, function (_g) {
497
519
  switch (_g.label) {
498
520
  case 0:
499
- _b = this.config || {}, hasCreatedAt = _b.hasCreatedAt, hasCreatedBy = _b.hasCreatedBy, mergeFields = _b.mergeFields;
521
+ _b = this.config || {}, hasCreatedAt = _b.hasCreatedAt, hasCreatedBy = _b.hasCreatedBy, hasSpace = _b.hasSpace, mergeFields = _b.mergeFields;
500
522
  objects = (0, lodash_1.castArray)(params);
501
523
  if (!params || objects.length === 0) {
502
524
  return [2 /*return*/, []];
@@ -508,7 +530,9 @@ var BaseGateway = /** @class */ (function () {
508
530
  if (hasCreatedBy) {
509
531
  skipFields.push(constants_1.FIELDS.CREATED_BY);
510
532
  }
511
- fields = Array.isArray(mergeFields) ? mergeFields : Object.keys(objects[0]);
533
+ if (hasSpace) {
534
+ skipFields.push(constants_1.FIELDS.SPACE_ID);
535
+ }
512
536
  idx = 0, len = objects.length;
513
537
  _g.label = 1;
514
538
  case 1:
@@ -519,7 +543,7 @@ var BaseGateway = /** @class */ (function () {
519
543
  return [4 /*yield*/, this.transformOnSet(object)];
520
544
  case 2:
521
545
  _c[_d] = _g.sent();
522
- if (!!objects[idx][this.getIdField()]) return [3 /*break*/, 4];
546
+ if (!(objects[idx][this.getIdField()] == null)) return [3 /*break*/, 4];
523
547
  _e = objects[idx];
524
548
  _f = this.getIdField();
525
549
  return [4 /*yield*/, this.generateId(object)];
@@ -530,6 +554,7 @@ var BaseGateway = /** @class */ (function () {
530
554
  ++idx;
531
555
  return [3 /*break*/, 1];
532
556
  case 5:
557
+ fields = Array.isArray(mergeFields) ? mergeFields : Object.keys(objects[0]);
533
558
  result = [];
534
559
  chunks = (0, utils_1.arrToChunks)(objects, ((_a = this.config) === null || _a === void 0 ? void 0 : _a.insertChunkSize) || DEFAULT_CHUNCK_SIZE);
535
560
  idx = 0, len = chunks.length;
@@ -537,10 +562,10 @@ var BaseGateway = /** @class */ (function () {
537
562
  case 6:
538
563
  if (!(idx < len)) return [3 /*break*/, 9];
539
564
  return [4 /*yield*/, this.getBuilder()
540
- .insert((0, lodash_1.castArray)(params))
565
+ .insert(chunks[idx])
541
566
  .returning(this.config.returnFields)
542
567
  .onConflict(this.config.setFields || this.getIdField())
543
- .merge((0, lodash_1.omit)(fields, skipFields))];
568
+ .merge((0, lodash_1.pullAll)(fields, skipFields))];
544
569
  case 7:
545
570
  items = _g.sent();
546
571
  result.push.apply(result, items);
@@ -553,30 +578,29 @@ var BaseGateway = /** @class */ (function () {
553
578
  });
554
579
  });
555
580
  };
556
- BaseGateway.prototype.remove = function (where, hardRemove) {
557
- if (hardRemove === void 0) { hardRemove = false; }
581
+ BaseGateway.prototype.remove = function (where) {
558
582
  return __awaiter(this, void 0, void 0, function () {
559
- var query, _a, _b, items;
583
+ var hardRemove, query, object, items;
560
584
  var _this = this;
561
- return __generator(this, function (_c) {
562
- switch (_c.label) {
585
+ return __generator(this, function (_a) {
586
+ switch (_a.label) {
563
587
  case 0:
588
+ hardRemove = (this.config || {}).hardRemove;
564
589
  query = this.getBuilder();
565
590
  if (!hardRemove) return [3 /*break*/, 1];
566
591
  query.delete(this.config.returnFields);
567
592
  return [3 /*break*/, 3];
568
- case 1:
569
- _b = (_a = query).update;
570
- return [4 /*yield*/, this.transformOnRemove()];
593
+ case 1: return [4 /*yield*/, this.transformOnRemove()];
571
594
  case 2:
572
- _b.apply(_a, [_c.sent()]).returning(this.config.returnFields);
573
- _c.label = 3;
595
+ object = _a.sent();
596
+ query.update(object).returning(this.config.returnFields);
597
+ _a.label = 3;
574
598
  case 3: return [4 /*yield*/, this.onRemoveFilter(query, where)];
575
599
  case 4:
576
- _c.sent();
600
+ _a.sent();
577
601
  return [4 /*yield*/, query];
578
602
  case 5:
579
- items = _c.sent();
603
+ items = _a.sent();
580
604
  if (items.length > 0 && this.config.noCache !== true) {
581
605
  items.forEach(function (item) { return _this.loader.clear(item[_this.getIdField()]); });
582
606
  }
@@ -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;
@@ -6,7 +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
+ mergeFields?: string[];
10
10
  hasStatus?: boolean;
11
11
  hasCreatedBy?: boolean;
12
12
  hasUpdatedBy?: boolean;
@@ -18,10 +18,12 @@ export interface BaseGatewayPropsInterface extends CacheInterface {
18
18
  hasSpace?: boolean;
19
19
  hasVersion?: boolean;
20
20
  hasLang?: boolean;
21
- localizationForField: string;
21
+ localizationForField?: string;
22
22
  defaultSorting?: SortItemInterface[];
23
23
  fieldForKeyword?: string;
24
+ filterByUserField?: string;
24
25
  insertChunkSize?: number;
26
+ hardRemove?: boolean;
25
27
  loader?: LoaderInterface;
26
28
  noCache?: boolean;
27
29
  returnFields?: any[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sdflc/backend-helpers",
3
- "version": "1.0.40",
3
+ "version": "1.0.43",
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",