@sdflc/backend-helpers 1.0.78 → 1.0.79

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.
Files changed (109) hide show
  1. package/build/BaseCore.js +0 -3
  2. package/build/BaseGateway.js +0 -2
  3. package/build/RedisDataLoader.js +7 -12
  4. package/build/commonValidators.js +3 -9
  5. package/build/esm/BaseCore.d.ts +88 -0
  6. package/build/esm/BaseCore.js +810 -0
  7. package/build/esm/BaseGateway.d.ts +49 -0
  8. package/build/esm/BaseGateway.js +476 -0
  9. package/build/esm/DataCache.d.ts +14 -0
  10. package/build/esm/DataCache.js +98 -0
  11. package/build/esm/Database.d.ts +32 -0
  12. package/build/esm/Database.js +192 -0
  13. package/build/esm/DbMigratorAndSeeder.d.ts +49 -0
  14. package/build/esm/DbMigratorAndSeeder.js +199 -0
  15. package/build/esm/RedisDataLoader.d.ts +41 -0
  16. package/build/esm/RedisDataLoader.js +237 -0
  17. package/build/esm/apiContext.d.ts +11 -0
  18. package/build/esm/apiContext.js +135 -0
  19. package/build/esm/baseController.d.ts +17 -0
  20. package/build/esm/baseController.js +60 -0
  21. package/build/esm/checkItHelpers.d.ts +3 -0
  22. package/build/esm/checkItHelpers.js +23 -0
  23. package/build/esm/commonValidators.d.ts +17 -0
  24. package/build/esm/commonValidators.js +273 -0
  25. package/build/esm/configBulder.d.ts +2 -0
  26. package/build/esm/configBulder.js +28 -0
  27. package/build/esm/constants.d.ts +30 -0
  28. package/build/esm/constants.js +69 -0
  29. package/build/esm/dbHelpers.d.ts +43 -0
  30. package/build/esm/dbHelpers.js +154 -0
  31. package/build/esm/dbSeeder.d.ts +2 -0
  32. package/build/esm/dbSeeder.js +53 -0
  33. package/build/esm/dbTableHelpers.d.ts +11 -0
  34. package/build/esm/dbTableHelpers.js +99 -0
  35. package/build/esm/downloadHelpers.d.ts +2 -0
  36. package/build/esm/downloadHelpers.js +76 -0
  37. package/build/esm/index.d.ts +21 -0
  38. package/build/esm/index.js +21 -0
  39. package/build/esm/interfaces/ApiContext.d.ts +24 -0
  40. package/build/esm/interfaces/ApiContext.js +1 -0
  41. package/build/esm/interfaces/ApiContextInterface.d.ts +12 -0
  42. package/build/esm/interfaces/ApiContextInterface.js +1 -0
  43. package/build/esm/interfaces/BaseCoreActionsInterface.d.ts +38 -0
  44. package/build/esm/interfaces/BaseCoreActionsInterface.js +1 -0
  45. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
  46. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.js +1 -0
  47. package/build/esm/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
  48. package/build/esm/interfaces/BaseCoreDoingWhatInterface.js +1 -0
  49. package/build/esm/interfaces/BaseCorePropsInterface.d.ts +36 -0
  50. package/build/esm/interfaces/BaseCorePropsInterface.js +1 -0
  51. package/build/esm/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
  52. package/build/esm/interfaces/BaseCoreValidatorsInterface.js +1 -0
  53. package/build/esm/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
  54. package/build/esm/interfaces/BaseGatewayPropsInterface.js +1 -0
  55. package/build/esm/interfaces/BuildConfigOptions.d.ts +6 -0
  56. package/build/esm/interfaces/BuildConfigOptions.js +1 -0
  57. package/build/esm/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
  58. package/build/esm/interfaces/BuildDefaultResolversOptions.js +1 -0
  59. package/build/esm/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
  60. package/build/esm/interfaces/BuildListQueryArgsInterface.js +1 -0
  61. package/build/esm/interfaces/CacheInterface.d.ts +15 -0
  62. package/build/esm/interfaces/CacheInterface.js +1 -0
  63. package/build/esm/interfaces/CommonValidatorArgs.d.ts +3 -0
  64. package/build/esm/interfaces/CommonValidatorArgs.js +1 -0
  65. package/build/esm/interfaces/CoreActionInterface.d.ts +14 -0
  66. package/build/esm/interfaces/CoreActionInterface.js +1 -0
  67. package/build/esm/interfaces/CreateUserTokenArgs.d.ts +11 -0
  68. package/build/esm/interfaces/CreateUserTokenArgs.js +1 -0
  69. package/build/esm/interfaces/CreateUserTokenResult.d.ts +4 -0
  70. package/build/esm/interfaces/CreateUserTokenResult.js +1 -0
  71. package/build/esm/interfaces/DatabaseOptions.d.ts +22 -0
  72. package/build/esm/interfaces/DatabaseOptions.js +1 -0
  73. package/build/esm/interfaces/DatabaseReadInterface.d.ts +14 -0
  74. package/build/esm/interfaces/DatabaseReadInterface.js +1 -0
  75. package/build/esm/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
  76. package/build/esm/interfaces/DbFieldAddDefaultInterface.js +1 -0
  77. package/build/esm/interfaces/DownloadFileArgs.d.ts +6 -0
  78. package/build/esm/interfaces/DownloadFileArgs.js +1 -0
  79. package/build/esm/interfaces/ExtractCredentialsArgs.d.ts +19 -0
  80. package/build/esm/interfaces/ExtractCredentialsArgs.js +1 -0
  81. package/build/esm/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
  82. package/build/esm/interfaces/JwtTokenSecretAndSettings.js +1 -0
  83. package/build/esm/interfaces/ListArgsInterface.d.ts +5 -0
  84. package/build/esm/interfaces/ListArgsInterface.js +1 -0
  85. package/build/esm/interfaces/LoaderInterface.d.ts +4 -0
  86. package/build/esm/interfaces/LoaderInterface.js +1 -0
  87. package/build/esm/interfaces/PaginationInterface.d.ts +7 -0
  88. package/build/esm/interfaces/PaginationInterface.js +1 -0
  89. package/build/esm/interfaces/SortItemInterface.d.ts +4 -0
  90. package/build/esm/interfaces/SortItemInterface.js +1 -0
  91. package/build/esm/interfaces/UserTokenParams.d.ts +8 -0
  92. package/build/esm/interfaces/UserTokenParams.js +1 -0
  93. package/build/esm/interfaces/VerifyUserTokenArgs.d.ts +13 -0
  94. package/build/esm/interfaces/VerifyUserTokenArgs.js +1 -0
  95. package/build/esm/interfaces/index.d.ts +28 -0
  96. package/build/esm/interfaces/index.js +27 -0
  97. package/build/esm/knexConfigBuilder.d.ts +1 -0
  98. package/build/esm/knexConfigBuilder.js +73 -0
  99. package/build/esm/passwordHelpers.d.ts +5 -0
  100. package/build/esm/passwordHelpers.js +22 -0
  101. package/build/esm/redisClient.d.ts +17 -0
  102. package/build/esm/redisClient.js +94 -0
  103. package/build/esm/resolversHelpers.d.ts +3 -0
  104. package/build/esm/resolversHelpers.js +59 -0
  105. package/build/esm/userToken.d.ts +8 -0
  106. package/build/esm/userToken.js +74 -0
  107. package/build/esm/utils.d.ts +2 -0
  108. package/build/esm/utils.js +13 -0
  109. package/package.json +13 -5
package/build/BaseCore.js CHANGED
@@ -544,7 +544,6 @@ class BaseCore {
544
544
  });
545
545
  });
546
546
  }
547
- // eslint-disable-next-line
548
547
  defaultAfterAndBefore(params, opt) {
549
548
  return __awaiter(this, void 0, void 0, function* () {
550
549
  return params;
@@ -683,7 +682,6 @@ class BaseCore {
683
682
  * @param params Object of parameters passed to the authenticate method
684
683
  * @returns Object with the jwtSecret and verifyTokenArgs
685
684
  */
686
- // eslint-disable-next-line
687
685
  getJwtTokenSecretAndSettings(params) {
688
686
  return __awaiter(this, void 0, void 0, function* () {
689
687
  const { space } = this.getContext();
@@ -726,7 +724,6 @@ class BaseCore {
726
724
  };
727
725
  });
728
726
  }
729
- // eslint-disable-next-line
730
727
  authenticate(params, opt) {
731
728
  return __awaiter(this, void 0, void 0, function* () {
732
729
  //const { accessRights } = params || {};
@@ -57,7 +57,6 @@ class BaseGateway {
57
57
  this.loader = new DataCache_1.DataCache(Object.assign(Object.assign({}, this.config), config));
58
58
  return this;
59
59
  }
60
- // eslint-disable-next-line
61
60
  generateId(args) {
62
61
  return __awaiter(this, void 0, void 0, function* () {
63
62
  return (0, uuid_1.v4)();
@@ -170,7 +169,6 @@ class BaseGateway {
170
169
  return params;
171
170
  });
172
171
  }
173
- // eslint-disable-next-line
174
172
  transformOnUpdate(params, where) {
175
173
  return __awaiter(this, void 0, void 0, function* () {
176
174
  const { hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField } = this.config;
@@ -63,19 +63,14 @@ class RedisDataLoader {
63
63
  */
64
64
  parse(str) {
65
65
  return __awaiter(this, void 0, void 0, function* () {
66
- try {
67
- if (str === '' || str === null) {
68
- return str;
69
- }
70
- else if (typeof this.opt.deserialize === 'function') {
71
- return yield this.opt.deserialize(str);
72
- }
73
- else {
74
- return JSON.parse(str);
75
- }
66
+ if (str === '' || str === null) {
67
+ return str;
76
68
  }
77
- catch (ex) {
78
- throw ex;
69
+ else if (typeof this.opt.deserialize === 'function') {
70
+ return yield this.opt.deserialize(str);
71
+ }
72
+ else {
73
+ return JSON.parse(str);
79
74
  }
80
75
  });
81
76
  }
@@ -201,9 +201,7 @@ const validateMultipleTextIds = (args, opt) => __awaiter(void 0, void 0, void 0,
201
201
  return [true, {}];
202
202
  });
203
203
  exports.validateMultipleTextIds = validateMultipleTextIds;
204
- const validateList = ({ rules }) =>
205
- // eslint-disable-next-line
206
- (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
204
+ const validateList = ({ rules }) => (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
207
205
  const { filter } = args || {};
208
206
  const [result] = rules.validateSync(filter);
209
207
  if (result) {
@@ -262,9 +260,7 @@ const validateGetMany = (args, opt) => __awaiter(void 0, void 0, void 0, functio
262
260
  });
263
261
  exports.validateGetMany = validateGetMany;
264
262
  exports.validateRemoveMany = exports.validateGetMany;
265
- const validateCreate = ({ rules }) =>
266
- // eslint-disable-next-line
267
- (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
263
+ const validateCreate = ({ rules }) => (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
268
264
  const { params } = args || {};
269
265
  const [paramsCheck] = (0, exports.shouldHaveParams)(params);
270
266
  if (paramsCheck !== true) {
@@ -277,9 +273,7 @@ const validateCreate = ({ rules }) =>
277
273
  return [true, {}];
278
274
  });
279
275
  exports.validateCreate = validateCreate;
280
- const validateUpdate = ({ rules }) =>
281
- // eslint-disable-next-line
282
- (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
276
+ const validateUpdate = ({ rules }) => (args, opt) => __awaiter(void 0, void 0, void 0, function* () {
283
277
  const { where, params } = args || {};
284
278
  const [idCheck] = (0, exports.shouldHaveParams)(where);
285
279
  if (idCheck !== true) {
@@ -0,0 +1,88 @@
1
+ import { OpResult } from '@sdflc/api-helpers';
2
+ import { Logger, MeasureTool } from '@sdflc/utils';
3
+ import { ID_TYPES } from './constants';
4
+ import { Database } from './Database';
5
+ import { BaseCorePropsInterface, BaseCoreActionsInterface, CoreActionInterface, JwtTokenSecretAndSettings, ApiContext, ExtractCredentialsArgs } from './interfaces';
6
+ declare class BaseCore {
7
+ protected measureTool: MeasureTool;
8
+ protected config: BaseCorePropsInterface;
9
+ protected logger: Logger;
10
+ constructor(props: BaseCorePropsInterface);
11
+ getIdType(): ID_TYPES;
12
+ getDb(): Database;
13
+ getRequestId(): string;
14
+ getContext(): ApiContext;
15
+ getGateways(): any;
16
+ getGateway(name?: string): any;
17
+ getValidators(): any;
18
+ success(data: any, code?: number): any;
19
+ failure(code: number, errorMsg: string, data?: any): any;
20
+ validationFailure(ex: OpResult | any): any;
21
+ exceptionFailure(ex: any, doingWhat: string, data?: any): any;
22
+ checkResult(args: any): Promise<void>;
23
+ runAction(opt: CoreActionInterface): Promise<any>;
24
+ list(args: any): Promise<any>;
25
+ get(args: any): Promise<any>;
26
+ getMany(args: any): Promise<any>;
27
+ getGatewayToSetOrerNo(): any;
28
+ getFilterToSetOrderNo(args: any): {};
29
+ create(args: any): Promise<any>;
30
+ createMany(args: any): Promise<any>;
31
+ update(args: any): Promise<any>;
32
+ updateMany(args: any): Promise<any>;
33
+ set(args: any): Promise<any>;
34
+ remove(args: any): Promise<any>;
35
+ removeMany(args: any): Promise<any>;
36
+ defaultAfterAndBefore(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
37
+ /**
38
+ * Used to transform an object before sending it in the response
39
+ * @param {any} item An object coming from the database
40
+ * @param {BaseCoreActionsInterface} opt Options
41
+ * @returns {any} transformed object
42
+ */
43
+ processItemOnOut(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
44
+ /**
45
+ * Used to transform an object before processing it on the request
46
+ * @param {any} item An object coming from the outside
47
+ * @param {BaseCoreActionsInterface} opt Options
48
+ * @returns {any} transformed object
49
+ */
50
+ processItemOnIn(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
51
+ beforeGet(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
52
+ beforeGetMany(items: any[], opt?: BaseCoreActionsInterface): Promise<any>;
53
+ beforeList(filter: any, opt?: BaseCoreActionsInterface): Promise<any>;
54
+ afterGet(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
55
+ afterGetMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
56
+ afterList(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
57
+ beforeCreate(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
58
+ afterCreate(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
59
+ beforeCreateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
60
+ afterCreateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
61
+ beforeUpdate(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
62
+ afterUpdate(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
63
+ beforeUpdateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
64
+ afterUpdateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
65
+ beforeSet(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
66
+ afterSet(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
67
+ beforeRemove(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
68
+ afterRemove(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
69
+ beforeRemoveMany(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
70
+ afterRemoveMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
71
+ onException(params: any, opt?: BaseCoreActionsInterface): Promise<string | null | undefined>;
72
+ /**
73
+ * Returns JWT secret and its settings to verify received JWT token
74
+ * @param params Object of parameters passed to the authenticate method
75
+ * @returns Object with the jwtSecret and verifyTokenArgs
76
+ */
77
+ getJwtTokenSecretAndSettings(params: any): Promise<JwtTokenSecretAndSettings>;
78
+ findSpace(): Promise<any[]>;
79
+ extractCredentials(args: ExtractCredentialsArgs): Promise<{
80
+ token: any;
81
+ fingerprint: any;
82
+ }>;
83
+ authenticate(params: any, opt?: BaseCoreActionsInterface): Promise<any[]>;
84
+ processRemovedRecord(record: any): any;
85
+ addRemovedModifierToFields(fields: string | string[]): any;
86
+ setOrderNo(args: any): Promise<void>;
87
+ }
88
+ export { BaseCore };