@sdflc/backend-helpers 1.0.9 → 1.0.14

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.
@@ -16,6 +16,7 @@ declare class BaseCore {
16
16
  protected beforeCreateMany: any;
17
17
  protected beforeUpdate: any;
18
18
  protected beforeUpdateMany: any;
19
+ protected beforeSet: any;
19
20
  protected beforeRemove: any;
20
21
  protected beforeRemoveMany: any;
21
22
  protected afterList: any;
@@ -23,6 +24,7 @@ declare class BaseCore {
23
24
  protected afterCreateMany: any;
24
25
  protected afterUpdate: any;
25
26
  protected afterUpdateMany: any;
27
+ protected afterSet: any;
26
28
  protected afterRemove: any;
27
29
  protected afterRemoveMany: any;
28
30
  protected requestId: string;
@@ -47,6 +49,7 @@ declare class BaseCore {
47
49
  createMany(args: any): Promise<any>;
48
50
  update(args: any): Promise<any>;
49
51
  updateMany(args: any): Promise<any>;
52
+ set(args: any): Promise<any>;
50
53
  remove(args: any): Promise<any>;
51
54
  removeMany(args: any): Promise<any>;
52
55
  }
package/build/baseCore.js CHANGED
@@ -70,6 +70,7 @@ var defaultValidators = {
70
70
  createMany: defaultValidate,
71
71
  update: defaultValidate,
72
72
  updateMany: defaultValidate,
73
+ set: defaultValidate,
73
74
  remove: defaultValidate,
74
75
  removeMany: defaultValidate,
75
76
  };
@@ -93,6 +94,7 @@ var BaseCore = /** @class */ (function () {
93
94
  this.beforeUpdate = typeof props.beforeUpdate === 'function' ? props.beforeUpdate : defaultAfterAndBefore;
94
95
  this.beforeUpdateMany =
95
96
  typeof props.beforeUpdateMany === 'function' ? props.beforeUpdateMany : defaultAfterAndBefore;
97
+ this.beforeSet = typeof props.beforeSet === 'function' ? props.beforeSet : defaultAfterAndBefore;
96
98
  this.beforeRemove = typeof props.beforeRemove === 'function' ? props.beforeRemove : defaultAfterAndBefore;
97
99
  this.beforeRemoveMany =
98
100
  typeof props.beforeRemoveMany === 'function' ? props.beforeRemoveMany : defaultAfterAndBefore;
@@ -101,6 +103,7 @@ var BaseCore = /** @class */ (function () {
101
103
  this.afterCreateMany = typeof props.afterCreateMany === 'function' ? props.afterCreateMany : defaultAfterAndBefore;
102
104
  this.afterUpdate = typeof props.afterUpdate === 'function' ? props.afterUpdate : defaultAfterAndBefore;
103
105
  this.afterUpdateMany = typeof props.afterUpdateMany === 'function' ? props.afterUpdateMany : defaultAfterAndBefore;
106
+ this.afterSet = typeof props.afterSet === 'function' ? props.afterSet : defaultAfterAndBefore;
104
107
  this.afterRemove = typeof props.afterRemove === 'function' ? props.afterRemove : defaultAfterAndBefore;
105
108
  this.afterRemoveMany = typeof props.afterRemoveMany === 'function' ? props.afterRemoveMany : defaultAfterAndBefore;
106
109
  this.validators = utils_2.setFunctions((props === null || props === void 0 ? void 0 : props.validators) || {}, this.validators);
@@ -513,6 +516,42 @@ var BaseCore = /** @class */ (function () {
513
516
  });
514
517
  });
515
518
  };
519
+ BaseCore.prototype.set = function (args) {
520
+ var _a, _b, _c;
521
+ return __awaiter(this, void 0, void 0, function () {
522
+ var _this = this;
523
+ return __generator(this, function (_d) {
524
+ return [2 /*return*/, this.runAction({
525
+ args: args,
526
+ validate: this.validators.set,
527
+ accessRights: [ACCESS_RIGHTS.CREATE, ACCESS_RIGHTS.UPDATE],
528
+ action: function (args) { return __awaiter(_this, void 0, void 0, function () {
529
+ var params, object, items, result;
530
+ var _a;
531
+ return __generator(this, function (_b) {
532
+ switch (_b.label) {
533
+ case 0:
534
+ params = (args || {}).params;
535
+ this.logger.log("Requesting setting of item(s) for " + this.name + ":", args);
536
+ return [4 /*yield*/, this.beforeSet(params, this.getGateways())];
537
+ case 1:
538
+ object = _b.sent();
539
+ return [4 /*yield*/, ((_a = this.gateway) === null || _a === void 0 ? void 0 : _a.set(object))];
540
+ case 2:
541
+ items = _b.sent();
542
+ return [4 /*yield*/, this.afterSet(items, this.getGateways())];
543
+ case 3:
544
+ result = _b.sent();
545
+ return [2 /*return*/, this.success(result)];
546
+ }
547
+ });
548
+ }); },
549
+ hasTransaction: false,
550
+ doingWhat: (_c = (_b = (_a = this.doingWhat) === null || _a === void 0 ? void 0 : _a.updateMany) !== null && _b !== void 0 ? _b : this.name) !== null && _c !== void 0 ? _c : 'updating multiple items',
551
+ })];
552
+ });
553
+ });
554
+ };
516
555
  BaseCore.prototype.remove = function (args) {
517
556
  var _a, _b, _c;
518
557
  return __awaiter(this, void 0, void 0, function () {
@@ -19,6 +19,16 @@ declare class BaseGateway {
19
19
  create(args: any): Promise<any>;
20
20
  update(where: any, params: any): Promise<any>;
21
21
  updateMany(params: any): Promise<any[]>;
22
+ increment(where: any, params: any): Promise<any>;
23
+ decrement(where: any, params: any): Promise<any>;
24
+ /**
25
+ * Inserts or updates data in the database.
26
+ * If the element of given array has not empty id field then the record is updated
27
+ * oterwise inserted
28
+ * @param params Array of objects to update or create
29
+ * @returns Array of updated or inserted objects
30
+ */
31
+ set(params: any): Promise<any[]>;
22
32
  remove(where: any, hardRemove?: boolean): Promise<any>;
23
33
  }
24
34
  export { BaseGateway };
@@ -53,6 +53,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
53
53
  exports.BaseGateway = void 0;
54
54
  var dataCache_1 = require("./dataCache");
55
55
  var constants_1 = __importDefault(require("./constants"));
56
+ var lodash_1 = require("lodash");
56
57
  var ID_FIELD = constants_1.default.ID_FIELD;
57
58
  var defaultIdGenerator = function () {
58
59
  return undefined;
@@ -65,7 +66,7 @@ var defaultUpdateFormatter = function (args) {
65
66
  };
66
67
  var defaultUpdateRemoveFilter = function (config) { return function (query, params) {
67
68
  var idName = config.idField || ID_FIELD;
68
- return query.where(idName, params[idName]);
69
+ query.where(idName, params[idName]);
69
70
  }; };
70
71
  var BaseGateway = /** @class */ (function () {
71
72
  function BaseGateway(props) {
@@ -216,7 +217,7 @@ var BaseGateway = /** @class */ (function () {
216
217
  };
217
218
  BaseGateway.prototype.updateMany = function (params) {
218
219
  return __awaiter(this, void 0, void 0, function () {
219
- var results, idx, len, items;
220
+ var results, idx, len, item, items;
220
221
  return __generator(this, function (_a) {
221
222
  switch (_a.label) {
222
223
  case 0:
@@ -228,10 +229,11 @@ var BaseGateway = /** @class */ (function () {
228
229
  _a.label = 1;
229
230
  case 1:
230
231
  if (!(idx < len)) return [3 /*break*/, 4];
231
- return [4 /*yield*/, this.update(params.where, params.params)];
232
+ item = params[idx];
233
+ return [4 /*yield*/, this.update(item.where, item.params)];
232
234
  case 2:
233
235
  items = _a.sent();
234
- results.push(items);
236
+ results.push.apply(results, items);
235
237
  _a.label = 3;
236
238
  case 3:
237
239
  ++idx;
@@ -241,6 +243,82 @@ var BaseGateway = /** @class */ (function () {
241
243
  });
242
244
  });
243
245
  };
246
+ BaseGateway.prototype.increment = function (where, params) {
247
+ return __awaiter(this, void 0, void 0, function () {
248
+ var object, query, items;
249
+ var _this = this;
250
+ return __generator(this, function (_a) {
251
+ switch (_a.label) {
252
+ case 0: return [4 /*yield*/, this.updateFormatter(params)];
253
+ case 1:
254
+ object = _a.sent();
255
+ query = this.getBuilder().increment(object).returning(this.returnFields);
256
+ return [4 /*yield*/, this.updateFilter(query, where)];
257
+ case 2:
258
+ _a.sent();
259
+ return [4 /*yield*/, query];
260
+ case 3:
261
+ items = _a.sent();
262
+ if (items.length > 0 && this.config.noCache !== true) {
263
+ items.forEach(function (item) { return _this.loader.clear(item[_this.getIdField()]); });
264
+ }
265
+ return [2 /*return*/, items];
266
+ }
267
+ });
268
+ });
269
+ };
270
+ BaseGateway.prototype.decrement = function (where, params) {
271
+ return __awaiter(this, void 0, void 0, function () {
272
+ var object, query, items;
273
+ var _this = this;
274
+ return __generator(this, function (_a) {
275
+ switch (_a.label) {
276
+ case 0: return [4 /*yield*/, this.updateFormatter(params)];
277
+ case 1:
278
+ object = _a.sent();
279
+ query = this.getBuilder().decrement(object).returning(this.returnFields);
280
+ return [4 /*yield*/, this.updateFilter(query, where)];
281
+ case 2:
282
+ _a.sent();
283
+ return [4 /*yield*/, query];
284
+ case 3:
285
+ items = _a.sent();
286
+ if (items.length > 0 && this.config.noCache !== true) {
287
+ items.forEach(function (item) { return _this.loader.clear(item[_this.getIdField()]); });
288
+ }
289
+ return [2 /*return*/, items];
290
+ }
291
+ });
292
+ });
293
+ };
294
+ /**
295
+ * Inserts or updates data in the database.
296
+ * If the element of given array has not empty id field then the record is updated
297
+ * oterwise inserted
298
+ * @param params Array of objects to update or create
299
+ * @returns Array of updated or inserted objects
300
+ */
301
+ BaseGateway.prototype.set = function (params) {
302
+ return __awaiter(this, void 0, void 0, function () {
303
+ var results, idField, items;
304
+ return __generator(this, function (_a) {
305
+ switch (_a.label) {
306
+ case 0:
307
+ results = [];
308
+ idField = this.getIdField();
309
+ return [4 /*yield*/, this.getBuilder()
310
+ .insert(lodash_1.castArray(params))
311
+ .returning(this.returnFields)
312
+ .onConflict(this.config.setFields || idField)
313
+ .merge()];
314
+ case 1:
315
+ items = _a.sent();
316
+ results.push.apply(results, items);
317
+ return [2 /*return*/, results];
318
+ }
319
+ });
320
+ });
321
+ };
244
322
  BaseGateway.prototype.remove = function (where, hardRemove) {
245
323
  if (hardRemove === void 0) { hardRemove = false; }
246
324
  return __awaiter(this, void 0, void 0, function () {
@@ -1,5 +1,7 @@
1
1
  /**
2
- * Removes all the records from provided table
2
+ * Removes all the records from provided table.
3
+ * If appSettings has cleanTable object with table names then
4
+ * it is used to add extra filters to clear the table to avoid for example users data
3
5
  * @param table Name of table from which to remove all the records
4
6
  * @param knexHandle Knex handle object with configured connection to DB
5
7
  * @param appSettings settings with db related information
@@ -40,23 +40,42 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
40
40
  };
41
41
  Object.defineProperty(exports, "__esModule", { value: true });
42
42
  exports.dbRunMigrations = exports.dbTransformSeedsToObject = exports.dbReset = exports.dbWipe = exports.dbClean = exports.dbListTables = exports.dbCleanTable = void 0;
43
- var lodash_1 = require("lodash");
44
43
  var bluebird_1 = __importDefault(require("bluebird"));
44
+ var lodash_1 = require("lodash");
45
+ var SQLS = {
46
+ pg: {
47
+ listTablesSchema: function (appSettings) { return "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + "';\n "; },
48
+ listTables: function () { return "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES\n "; },
49
+ dropTablesSchema: function (appSettings) { return "\n SELECT 'DROP TABLE IF EXISTS " + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + ".' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + "';\n "; },
50
+ dropTables: function () { return "\n SELECT 'DROP TABLE IF EXISTS ' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES';\n "; },
51
+ },
52
+ };
45
53
  /**
46
- * Removes all the records from provided table
54
+ * Removes all the records from provided table.
55
+ * If appSettings has cleanTable object with table names then
56
+ * it is used to add extra filters to clear the table to avoid for example users data
47
57
  * @param table Name of table from which to remove all the records
48
58
  * @param knexHandle Knex handle object with configured connection to DB
49
59
  * @param appSettings settings with db related information
50
60
  */
51
61
  var dbCleanTable = function (table, knexHandle, appSettings) { return __awaiter(void 0, void 0, void 0, function () {
52
- var tableName;
53
- return __generator(this, function (_a) {
54
- switch (_a.label) {
62
+ var query, cleanTableFilters;
63
+ var _a;
64
+ return __generator(this, function (_b) {
65
+ switch (_b.label) {
55
66
  case 0:
56
- tableName = appSettings.dbSchema ? appSettings.dbSchema + "." + table : table;
57
- return [4 /*yield*/, knexHandle.raw("DELETE FROM " + tableName)];
67
+ query = knexHandle(table).withSchema(appSettings.dbSchema).delete();
68
+ cleanTableFilters = (_a = appSettings === null || appSettings === void 0 ? void 0 : appSettings.cleanTableFilters) === null || _a === void 0 ? void 0 : _a[table];
69
+ if (cleanTableFilters != undefined) {
70
+ if (Array.isArray(cleanTableFilters.where)) {
71
+ cleanTableFilters.where.forEach(function (whereItem) {
72
+ query.where(whereItem.fieldName, whereItem.operand, whereItem.value);
73
+ });
74
+ }
75
+ }
76
+ return [4 /*yield*/, query];
58
77
  case 1:
59
- _a.sent();
78
+ _b.sent();
60
79
  return [2 /*return*/];
61
80
  }
62
81
  });
@@ -74,9 +93,9 @@ var dbListTables = function (knexHandle, appSettings) { return __awaiter(void 0,
74
93
  switch (_a.label) {
75
94
  case 0:
76
95
  skipTables = (appSettings || {}).skipTables || [];
77
- query = "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + appSettings.dbSchema + "';";
96
+ query = SQLS[appSettings.dbType].listTablesSchema(appSettings);
78
97
  if (!appSettings.dbSchema) {
79
- query = "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES";
98
+ query = SQLS[appSettings.dbType].listTables(appSettings);
80
99
  }
81
100
  return [4 /*yield*/, knexHandle.raw(query)];
82
101
  case 1:
@@ -124,12 +143,12 @@ exports.dbClean = dbClean;
124
143
  * TODO: Remove all constraints and then drop tables.
125
144
  */
126
145
  var dbWipe = function (knexHandle, appSettings) {
127
- var qyery = "\n SELECT 'DROP TABLE IF EXISTS " + appSettings.dbSchema + ".' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + appSettings.dbSchema + "';\n ";
146
+ var query = SQLS[appSettings.dbType].dropTablesSchema(appSettings);
128
147
  if (!appSettings.dbSchema) {
129
- qyery = "\n SELECT 'DROP TABLE IF EXISTS ' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES';\n ";
148
+ query = SQLS[appSettings.dbType].dropTables(appSettings);
130
149
  }
131
150
  return knexHandle
132
- .raw(qyery)
151
+ .raw(query)
133
152
  .then(function (result) { return result.rows.map(function (r) { return r.cmd; }); })
134
153
  .then(function (commands) { return bluebird_1.default.each(commands, function (cmd) { return knexHandle.raw(cmd); }); });
135
154
  };
@@ -0,0 +1,49 @@
1
+ declare class DbMigratorAndSeeder {
2
+ private knexHandle;
3
+ private config;
4
+ private logger;
5
+ constructor(knexHandle: any, config?: any);
6
+ runMigrations(): Promise<void>;
7
+ /**
8
+ * Go from array of objects which contain keys of object names which have an array value of seeded objects
9
+ * to a single object with keys of object names and arrays of seeded objects
10
+ * ie from [{table1: [], table2: [] }, { table3: [] }]
11
+ * to { table1: [], table2: [], table3: []}
12
+ */
13
+ transformSeedsToObject(generatedSeedArrays: any[]): any;
14
+ /**
15
+ * Drop all tables, run migrations, then seed the tables
16
+ */
17
+ resetDb(): Promise<void>;
18
+ /**
19
+ * Selects all the tables in the schema and drops them.
20
+ * This approach does not work in case we have constraints.
21
+ * TODO: Remove all constraints and then drop tables.
22
+ */
23
+ wipeDb(): Promise<void>;
24
+ /**
25
+ * Removes all the records from provided list of tables
26
+ * @param tablesToClean array of table names
27
+ * @param knexHandle Knex handle object with configured connection to DB
28
+ * @param appSettings settings with db related information
29
+ * @returns promise
30
+ */
31
+ cleanDb(tablesToClean: any[]): Promise<unknown>;
32
+ /**
33
+ * Removes all the records from provided table.
34
+ * If appSettings has cleanTable object with table names then
35
+ * it is used to add extra filters to clear the table to avoid for example users data
36
+ * @param table Name of table from which to remove all the records
37
+ */
38
+ cleanDbTable(table: string): Promise<void>;
39
+ /**
40
+ * Returns a list of tables in db schedm specified in settings
41
+ * @returns arrays of table names in the provided db schema
42
+ */
43
+ listDbTables(): Promise<any>;
44
+ generateSeeds(dirname: string, seedFiles: any): Promise<any>;
45
+ removeSeedsFromDb(seedFiles: any): Promise<unknown>;
46
+ insertRecords(seedGroups: any): Promise<any>;
47
+ runSeeds(dirname: string, seedFiles: any): Promise<any>;
48
+ }
49
+ export { DbMigratorAndSeeder };
@@ -0,0 +1,331 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
10
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
11
+ }) : function(o, v) {
12
+ o["default"] = v;
13
+ });
14
+ var __importStar = (this && this.__importStar) || function (mod) {
15
+ if (mod && mod.__esModule) return mod;
16
+ var result = {};
17
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
18
+ __setModuleDefault(result, mod);
19
+ return result;
20
+ };
21
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
22
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
23
+ return new (P || (P = Promise))(function (resolve, reject) {
24
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
25
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
26
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
27
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
28
+ });
29
+ };
30
+ var __generator = (this && this.__generator) || function (thisArg, body) {
31
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
32
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
33
+ function verb(n) { return function (v) { return step([n, v]); }; }
34
+ function step(op) {
35
+ if (f) throw new TypeError("Generator is already executing.");
36
+ while (_) try {
37
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
38
+ if (y = 0, t) op = [op[0] & 2, t.value];
39
+ switch (op[0]) {
40
+ case 0: case 1: t = op; break;
41
+ case 4: _.label++; return { value: op[1], done: false };
42
+ case 5: _.label++; y = op[1]; op = [0]; continue;
43
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
44
+ default:
45
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
46
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
47
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
48
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
49
+ if (t[2]) _.ops.pop();
50
+ _.trys.pop(); continue;
51
+ }
52
+ op = body.call(thisArg, _);
53
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
54
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
55
+ }
56
+ };
57
+ var __importDefault = (this && this.__importDefault) || function (mod) {
58
+ return (mod && mod.__esModule) ? mod : { "default": mod };
59
+ };
60
+ Object.defineProperty(exports, "__esModule", { value: true });
61
+ exports.DbMigratorAndSeeder = void 0;
62
+ var path_1 = __importDefault(require("path"));
63
+ var bluebird_1 = __importDefault(require("bluebird"));
64
+ var lodash_1 = require("lodash");
65
+ var utils_1 = require("@sdflc/utils");
66
+ var SQLS = {
67
+ pg: {
68
+ listTablesSchema: function (appSettings) { return "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + "';\n "; },
69
+ listTables: function () { return "\n SELECT TABLE_NAME as table_name\n FROM INFORMATION_SCHEMA.TABLES\n "; },
70
+ dropTablesSchema: function (appSettings) { return "\n SELECT 'DROP TABLE IF EXISTS " + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + ".' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES\n WHERE TABLE_SCHEMA = '" + (appSettings === null || appSettings === void 0 ? void 0 : appSettings.dbSchema) + "';\n "; },
71
+ dropTables: function () { return "\n SELECT 'DROP TABLE IF EXISTS ' || TABLE_NAME || ';' as cmd\n FROM INFORMATION_SCHEMA.TABLES';\n "; },
72
+ },
73
+ };
74
+ var DbMigratorAndSeeder = /** @class */ (function () {
75
+ function DbMigratorAndSeeder(knexHandle, config) {
76
+ this.knexHandle = knexHandle;
77
+ this.config = config;
78
+ this.logger = (config === null || config === void 0 ? void 0 : config.logger) instanceof utils_1.Logger ? config.logger : new utils_1.Logger({ level: utils_1.LoggerLevels.LOG });
79
+ }
80
+ DbMigratorAndSeeder.prototype.runMigrations = function () {
81
+ return __awaiter(this, void 0, void 0, function () {
82
+ var result, version;
83
+ return __generator(this, function (_a) {
84
+ switch (_a.label) {
85
+ case 0: return [4 /*yield*/, this.knexHandle.migrate.latest()];
86
+ case 1:
87
+ result = _a.sent();
88
+ if (!(this.config && this.config.runDbSeed && result[1].length > 0)) return [3 /*break*/, 3];
89
+ return [4 /*yield*/, this.knexHandle.seed.run()];
90
+ case 2:
91
+ _a.sent();
92
+ _a.label = 3;
93
+ case 3:
94
+ this.logger.log("Ran " + result[1].length + " migration(s)");
95
+ version = this.knexHandle.migrate.currentVersion();
96
+ this.logger.log("Current version of database: " + version);
97
+ return [2 /*return*/];
98
+ }
99
+ });
100
+ });
101
+ };
102
+ /**
103
+ * Go from array of objects which contain keys of object names which have an array value of seeded objects
104
+ * to a single object with keys of object names and arrays of seeded objects
105
+ * ie from [{table1: [], table2: [] }, { table3: [] }]
106
+ * to { table1: [], table2: [], table3: []}
107
+ */
108
+ DbMigratorAndSeeder.prototype.transformSeedsToObject = function (generatedSeedArrays) {
109
+ return lodash_1.reduce(generatedSeedArrays, function (acc, cur) {
110
+ for (var key in cur) {
111
+ acc[key] = cur[key];
112
+ }
113
+ return acc;
114
+ }, {});
115
+ };
116
+ /**
117
+ * Drop all tables, run migrations, then seed the tables
118
+ */
119
+ DbMigratorAndSeeder.prototype.resetDb = function () {
120
+ return __awaiter(this, void 0, void 0, function () {
121
+ var ex_1;
122
+ return __generator(this, function (_a) {
123
+ switch (_a.label) {
124
+ case 0:
125
+ _a.trys.push([0, 3, , 4]);
126
+ return [4 /*yield*/, this.wipeDb()];
127
+ case 1:
128
+ _a.sent();
129
+ return [4 /*yield*/, this.runMigrations()];
130
+ case 2:
131
+ _a.sent();
132
+ return [3 /*break*/, 4];
133
+ case 3:
134
+ ex_1 = _a.sent();
135
+ this.logger.error('An exception has occurred on resetting database: ', ex_1);
136
+ return [3 /*break*/, 4];
137
+ case 4: return [2 /*return*/];
138
+ }
139
+ });
140
+ });
141
+ };
142
+ /**
143
+ * Selects all the tables in the schema and drops them.
144
+ * This approach does not work in case we have constraints.
145
+ * TODO: Remove all constraints and then drop tables.
146
+ */
147
+ DbMigratorAndSeeder.prototype.wipeDb = function () {
148
+ return __awaiter(this, void 0, void 0, function () {
149
+ var query, result, commands;
150
+ var _this = this;
151
+ return __generator(this, function (_a) {
152
+ switch (_a.label) {
153
+ case 0:
154
+ query = this.config.dbSchema
155
+ ? SQLS[this.config.dbType].dropTablesSchema(this.config)
156
+ : SQLS[this.config.dbType].dropTables(this.config);
157
+ return [4 /*yield*/, this.knexHandle.raw(query)];
158
+ case 1:
159
+ result = _a.sent();
160
+ commands = result.rows.map(function (r) { return r.cmd; });
161
+ bluebird_1.default.each(commands, function (cmd) { return _this.knexHandle.raw(cmd); });
162
+ return [2 /*return*/];
163
+ }
164
+ });
165
+ });
166
+ };
167
+ /**
168
+ * Removes all the records from provided list of tables
169
+ * @param tablesToClean array of table names
170
+ * @param knexHandle Knex handle object with configured connection to DB
171
+ * @param appSettings settings with db related information
172
+ * @returns promise
173
+ */
174
+ DbMigratorAndSeeder.prototype.cleanDb = function (tablesToClean) {
175
+ return __awaiter(this, void 0, void 0, function () {
176
+ var idx, len;
177
+ return __generator(this, function (_a) {
178
+ switch (_a.label) {
179
+ case 0:
180
+ idx = 0, len = tablesToClean.length;
181
+ _a.label = 1;
182
+ case 1:
183
+ if (!(idx < len)) return [3 /*break*/, 4];
184
+ return [4 /*yield*/, this.cleanDbTable(tablesToClean[idx])];
185
+ case 2:
186
+ _a.sent();
187
+ _a.label = 3;
188
+ case 3:
189
+ ++idx;
190
+ return [3 /*break*/, 1];
191
+ case 4: return [2 /*return*/, new bluebird_1.default(function (resolve) {
192
+ resolve(tablesToClean);
193
+ })];
194
+ }
195
+ });
196
+ });
197
+ };
198
+ /**
199
+ * Removes all the records from provided table.
200
+ * If appSettings has cleanTable object with table names then
201
+ * it is used to add extra filters to clear the table to avoid for example users data
202
+ * @param table Name of table from which to remove all the records
203
+ */
204
+ DbMigratorAndSeeder.prototype.cleanDbTable = function (table) {
205
+ var _a, _b;
206
+ return __awaiter(this, void 0, void 0, function () {
207
+ var query, cleanTableFilters;
208
+ return __generator(this, function (_c) {
209
+ switch (_c.label) {
210
+ case 0:
211
+ query = this.knexHandle(table).withSchema(this.config.dbSchema).delete();
212
+ cleanTableFilters = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.cleanTableFilters) === null || _b === void 0 ? void 0 : _b[table];
213
+ if (cleanTableFilters != undefined) {
214
+ if (Array.isArray(cleanTableFilters.where)) {
215
+ cleanTableFilters.where.forEach(function (whereItem) {
216
+ if (whereItem.fieldName) {
217
+ query.where(whereItem.fieldName, whereItem.operand, whereItem.value);
218
+ }
219
+ });
220
+ }
221
+ }
222
+ return [4 /*yield*/, query];
223
+ case 1:
224
+ _c.sent();
225
+ return [2 /*return*/];
226
+ }
227
+ });
228
+ });
229
+ };
230
+ /**
231
+ * Returns a list of tables in db schedm specified in settings
232
+ * @returns arrays of table names in the provided db schema
233
+ */
234
+ DbMigratorAndSeeder.prototype.listDbTables = function () {
235
+ var _a, _b;
236
+ return __awaiter(this, void 0, void 0, function () {
237
+ var skipTables, query, tables;
238
+ return __generator(this, function (_c) {
239
+ switch (_c.label) {
240
+ case 0:
241
+ skipTables = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.skipTables) !== null && _b !== void 0 ? _b : [];
242
+ query = this.config.dbSchema
243
+ ? SQLS[this.config.dbType].listTablesSchema(this.config)
244
+ : SQLS[this.config.dbType].listTables(this.config);
245
+ return [4 /*yield*/, this.knexHandle.raw(query)];
246
+ case 1:
247
+ tables = _c.sent();
248
+ return [2 /*return*/, (tables.rows || [])
249
+ .map(function (row) { return row.table_name; })
250
+ .filter(function (table) { return skipTables.indexOf(table) === -1; })];
251
+ }
252
+ });
253
+ });
254
+ };
255
+ DbMigratorAndSeeder.prototype.generateSeeds = function (dirname, seedFiles) {
256
+ return __awaiter(this, void 0, void 0, function () {
257
+ var seedGroups, seedFileNames, seedFnExports, seedFns, seedFnsMap, i, seedFileName;
258
+ return __generator(this, function (_a) {
259
+ switch (_a.label) {
260
+ case 0:
261
+ seedGroups = [];
262
+ seedFileNames = lodash_1.flatten(seedFiles);
263
+ return [4 /*yield*/, Promise.all(lodash_1.map(seedFileNames, function (filename) { return Promise.resolve().then(function () { return __importStar(require(path_1.default.join(dirname, "./objects/" + filename + ".js"))); }); }))];
264
+ case 1:
265
+ seedFnExports = _a.sent();
266
+ seedFns = lodash_1.map(seedFnExports, 'default');
267
+ seedFnsMap = {};
268
+ for (i = 0; i < seedFileNames.length; i++) {
269
+ seedFileName = seedFileNames[i];
270
+ seedFnsMap[seedFileName] = seedFns[i];
271
+ }
272
+ seedFiles.reduce(function (seeds, fileGroup) {
273
+ seedGroups = seedGroups.concat(fileGroup.reduce(function (group, filename) {
274
+ var _a;
275
+ var seedFn = seedFnsMap[filename];
276
+ var seed = seedFn(seeds);
277
+ var filenameCamel = lodash_1.camelCase(filename);
278
+ seeds[filenameCamel] = seed;
279
+ return Object.assign((_a = {}, _a[filenameCamel] = seed, _a), group);
280
+ }, {}));
281
+ return seeds;
282
+ }, {});
283
+ return [2 /*return*/, seedGroups];
284
+ }
285
+ });
286
+ });
287
+ };
288
+ DbMigratorAndSeeder.prototype.removeSeedsFromDb = function (seedFiles) {
289
+ var tablesToReset = lodash_1.flatten(seedFiles).reverse();
290
+ this.logger.log('Deleting records from tables: ', tablesToReset);
291
+ return this.cleanDb(tablesToReset);
292
+ };
293
+ DbMigratorAndSeeder.prototype.insertRecords = function (seedGroups) {
294
+ return __awaiter(this, void 0, void 0, function () {
295
+ var _this = this;
296
+ return __generator(this, function (_a) {
297
+ this.logger.log('Inserting seeds records into tables...');
298
+ return [2 /*return*/, seedGroups.reduce(function (previousGroup, group) { return __awaiter(_this, void 0, void 0, function () {
299
+ var _this = this;
300
+ return __generator(this, function (_a) {
301
+ switch (_a.label) {
302
+ case 0: return [4 /*yield*/, previousGroup];
303
+ case 1:
304
+ _a.sent();
305
+ return [2 /*return*/, Promise.all(Object.keys(group).map(function (table) { return _this.knexHandle(table).withSchema(_this.config.dbSchema).insert(group[table]); }))];
306
+ }
307
+ });
308
+ }); }, Promise.resolve())];
309
+ });
310
+ });
311
+ };
312
+ DbMigratorAndSeeder.prototype.runSeeds = function (dirname, seedFiles) {
313
+ return __awaiter(this, void 0, void 0, function () {
314
+ var groups;
315
+ return __generator(this, function (_a) {
316
+ switch (_a.label) {
317
+ case 0: return [4 /*yield*/, this.generateSeeds(dirname, seedFiles)];
318
+ case 1:
319
+ groups = _a.sent();
320
+ return [4 /*yield*/, this.removeSeedsFromDb(seedFiles)];
321
+ case 2:
322
+ _a.sent();
323
+ return [4 /*yield*/, this.insertRecords(groups)];
324
+ case 3: return [2 /*return*/, _a.sent()];
325
+ }
326
+ });
327
+ });
328
+ };
329
+ return DbMigratorAndSeeder;
330
+ }());
331
+ exports.DbMigratorAndSeeder = DbMigratorAndSeeder;
package/build/index.d.ts CHANGED
@@ -3,6 +3,7 @@ export { CacheInterface, LoaderInterface, BaseGatewayInterface, ListArgsInterfac
3
3
  export { buildConfig } from './configBulder';
4
4
  export { Database } from './database';
5
5
  export { dbCleanTable, dbListTables, dbClean, dbWipe, dbReset, dbTransformSeedsToObject, dbRunMigrations, } from './dbHelpers';
6
+ export { DbMigratorAndSeeder } from './dbMigratorAndSeeder';
6
7
  export { dbSeed } from './dbSeeder';
7
8
  export { buildKnexConfig } from './knexConfigBuilder';
8
9
  export { createRedisClient } from './redisClient';
package/build/index.js CHANGED
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.constants = exports.buildDefaultResolvers = exports.dbFieldAddDefaults = exports.BaseController = exports.createApiContext = exports.BaseCore = exports.BaseGateway = exports.DataCache = exports.createErrorOnCheckError = exports.checkArray = exports.createRedisClient = exports.buildKnexConfig = exports.dbSeed = exports.dbRunMigrations = exports.dbTransformSeedsToObject = exports.dbReset = exports.dbWipe = exports.dbClean = exports.dbListTables = exports.dbCleanTable = exports.Database = exports.buildConfig = void 0;
6
+ exports.constants = exports.buildDefaultResolvers = exports.dbFieldAddDefaults = exports.BaseController = exports.createApiContext = exports.BaseCore = exports.BaseGateway = exports.DataCache = exports.createErrorOnCheckError = exports.checkArray = exports.createRedisClient = exports.buildKnexConfig = exports.dbSeed = exports.DbMigratorAndSeeder = exports.dbRunMigrations = exports.dbTransformSeedsToObject = exports.dbReset = exports.dbWipe = exports.dbClean = exports.dbListTables = exports.dbCleanTable = exports.Database = exports.buildConfig = void 0;
7
7
  var constants_1 = __importDefault(require("./constants"));
8
8
  exports.constants = constants_1.default;
9
9
  var configBulder_1 = require("./configBulder");
@@ -18,6 +18,8 @@ Object.defineProperty(exports, "dbWipe", { enumerable: true, get: function () {
18
18
  Object.defineProperty(exports, "dbReset", { enumerable: true, get: function () { return dbHelpers_1.dbReset; } });
19
19
  Object.defineProperty(exports, "dbTransformSeedsToObject", { enumerable: true, get: function () { return dbHelpers_1.dbTransformSeedsToObject; } });
20
20
  Object.defineProperty(exports, "dbRunMigrations", { enumerable: true, get: function () { return dbHelpers_1.dbRunMigrations; } });
21
+ var dbMigratorAndSeeder_1 = require("./dbMigratorAndSeeder");
22
+ Object.defineProperty(exports, "DbMigratorAndSeeder", { enumerable: true, get: function () { return dbMigratorAndSeeder_1.DbMigratorAndSeeder; } });
21
23
  var dbSeeder_1 = require("./dbSeeder");
22
24
  Object.defineProperty(exports, "dbSeed", { enumerable: true, get: function () { return dbSeeder_1.dbSeed; } });
23
25
  var knexConfigBuilder_1 = require("./knexConfigBuilder");
@@ -10,6 +10,7 @@ export interface DoingWhatInterface {
10
10
  createMany: string;
11
11
  update: string;
12
12
  updateMany: string;
13
+ set: string;
13
14
  remove: string;
14
15
  removeMany: string;
15
16
  [key: string]: string;
@@ -29,6 +30,7 @@ export interface BaseCoreInterface {
29
30
  beforeCreateMany?(params: any, gateways?: any): any;
30
31
  beforeUpdate?(params: any, gateways?: any): any;
31
32
  beforeUpdateMany?(params: any, gateways?: any): any;
33
+ beforeSet?(params: any, gateways?: any): any;
32
34
  beforeRemove?(params: any, gateways?: any): any;
33
35
  beforeRemoveMany?(params: any, gateways?: any): any;
34
36
  afterList?(params: any, gateways?: any): any;
@@ -36,6 +38,7 @@ export interface BaseCoreInterface {
36
38
  afterCreateMany?(params: any, gateways?: any): any;
37
39
  afterUpdate?(params: any, gateways?: any): any;
38
40
  afterUpdateMany?(params: any, gateways?: any): any;
41
+ afterSet?(params: any, gateways?: any): any;
39
42
  afterRemove?(params: any, gateways?: any): any;
40
43
  afterRemoveMany?(params: any, gateways?: any): any;
41
44
  validateList?(params: any, gateways?: any): Promise<any[]> | any[];
@@ -45,6 +48,7 @@ export interface BaseCoreInterface {
45
48
  validateCreateMany?(params: any, gateways?: any): Promise<any[]> | any[];
46
49
  validateUpdate?(params: any, gateways?: any): Promise<any[]> | any[];
47
50
  validateUpdateMany?(params: any, gateways?: any): Promise<any[]> | any[];
51
+ validateSet?(params: any, gateways?: any): Promise<any[]> | any[];
48
52
  validateRemove?(params: any, gateways?: any): Promise<any[]> | any[];
49
53
  validateRemoveMany?(params: any, gateways?: any): Promise<any[]> | any[];
50
54
  validators?: BaseCoreValidatorsInterface;
@@ -6,6 +6,7 @@ export interface BaseCoreValidatorsInterface {
6
6
  createMany?(params: any, gateways?: any): Promise<any[]> | any[];
7
7
  update?(params: any, gateways?: any): Promise<any[]> | any[];
8
8
  updateMany?(params: any, gateways?: any): Promise<any[]> | any[];
9
+ set?(params: any, gateways?: any): Promise<any[]> | any[];
9
10
  remove?(params: any, gateways?: any): Promise<any[]> | any[];
10
11
  removeMany?(params: any, gateways?: any): Promise<any[]> | any[];
11
12
  }
@@ -6,6 +6,7 @@ export interface BaseGatewayInterface {
6
6
  db: Database;
7
7
  table?: string;
8
8
  idField?: string;
9
+ setFields?: string[] | string;
9
10
  selectFields?: any[];
10
11
  defaultSorting?: SortItemInterface[];
11
12
  filter?(query: any, params: any): any;
@@ -11,6 +11,7 @@ export interface BuildDefaultResolvers {
11
11
  disableCreateMany?: boolean;
12
12
  disableUpdate?: boolean;
13
13
  disableUpdateMany?: boolean;
14
+ disableSet?: boolean;
14
15
  disableRemove?: boolean;
15
16
  disableRemoveMany?: boolean;
16
17
  }
@@ -3,4 +3,5 @@ export interface PaginationInterface {
3
3
  page: number;
4
4
  pageSize?: number;
5
5
  sortBy: SortItemInterface[];
6
+ cursor: string;
6
7
  }
@@ -13,7 +13,7 @@ var __assign = (this && this.__assign) || function () {
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
14
  exports.buildDefaultResolvers = void 0;
15
15
  var buildDefaultResolvers = function (args) {
16
- var _a = args || {}, prefix = _a.prefix, core = _a.core, query = _a.query, mutation = _a.mutation, types = _a.types, disableList = _a.disableList, disableGet = _a.disableGet, disableGetMany = _a.disableGetMany, disableCreate = _a.disableCreate, disableCreateMany = _a.disableCreateMany, disableUpdate = _a.disableUpdate, disableUpdateMany = _a.disableUpdateMany, disableRemove = _a.disableRemove, disableRemoveMany = _a.disableRemoveMany;
16
+ var _a = args || {}, prefix = _a.prefix, core = _a.core, query = _a.query, mutation = _a.mutation, types = _a.types, disableList = _a.disableList, disableGet = _a.disableGet, disableGetMany = _a.disableGetMany, disableCreate = _a.disableCreate, disableCreateMany = _a.disableCreateMany, disableUpdate = _a.disableUpdate, disableUpdateMany = _a.disableUpdateMany, disableSet = _a.disableSet, disableRemove = _a.disableRemove, disableRemoveMany = _a.disableRemoveMany;
17
17
  var Query = __assign({}, (query || {}));
18
18
  var Mutation = __assign({}, (mutation || {}));
19
19
  if (disableList !== true) {
@@ -51,6 +51,11 @@ var buildDefaultResolvers = function (args) {
51
51
  return context[core].updateMany(args);
52
52
  };
53
53
  }
54
+ if (disableSet !== true) {
55
+ Mutation[prefix + "Set"] = function (parent, args, context) {
56
+ return context[core].set(args);
57
+ };
58
+ }
54
59
  if (disableRemove !== true) {
55
60
  Mutation[prefix + "Remove"] = function (parent, args, context) {
56
61
  return context[core].remove(args);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sdflc/backend-helpers",
3
- "version": "1.0.9",
3
+ "version": "1.0.14",
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",