@sdflc/backend-helpers 1.0.106 → 1.0.107

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 (209) hide show
  1. package/build/BaseCore.d.ts +88 -0
  2. package/build/BaseCore.js +734 -0
  3. package/build/BaseGateway.d.ts +56 -0
  4. package/build/BaseGateway.js +477 -0
  5. package/build/DataCache.d.ts +16 -0
  6. package/build/DataCache.js +113 -0
  7. package/build/Database.d.ts +36 -0
  8. package/build/Database.js +195 -0
  9. package/build/DbMigratorAndSeeder.d.ts +49 -0
  10. package/build/DbMigratorAndSeeder.js +212 -0
  11. package/build/RedisDataLoader.d.ts +41 -0
  12. package/build/RedisDataLoader.js +212 -0
  13. package/build/apiContext.d.ts +11 -0
  14. package/build/apiContext.js +146 -0
  15. package/build/baseController.d.ts +17 -0
  16. package/build/baseController.js +59 -0
  17. package/build/checkItHelpers.d.ts +3 -0
  18. package/build/checkItHelpers.js +28 -0
  19. package/build/commonValidators.d.ts +17 -0
  20. package/build/commonValidators.js +311 -0
  21. package/build/configBulder.d.ts +2 -0
  22. package/build/configBulder.js +36 -0
  23. package/build/constants.d.ts +30 -0
  24. package/build/constants.js +80 -0
  25. package/build/dbHelpers.d.ts +43 -0
  26. package/build/dbHelpers.js +156 -0
  27. package/build/dbSeeder.d.ts +2 -0
  28. package/build/dbSeeder.js +83 -0
  29. package/build/dbTableHelpers.d.ts +14 -0
  30. package/build/dbTableHelpers.js +118 -0
  31. package/build/downloadHelpers.d.ts +2 -0
  32. package/build/downloadHelpers.js +73 -0
  33. package/build/esm/BaseCore.d.ts +88 -0
  34. package/build/esm/BaseCore.js +728 -0
  35. package/build/esm/BaseGateway.d.ts +56 -0
  36. package/build/esm/BaseGateway.js +471 -0
  37. package/build/esm/DataCache.d.ts +16 -0
  38. package/build/esm/DataCache.js +107 -0
  39. package/build/esm/Database.d.ts +36 -0
  40. package/build/esm/Database.js +189 -0
  41. package/build/esm/DbMigratorAndSeeder.d.ts +49 -0
  42. package/build/esm/DbMigratorAndSeeder.js +173 -0
  43. package/build/esm/RedisDataLoader.d.ts +41 -0
  44. package/build/esm/RedisDataLoader.js +206 -0
  45. package/build/esm/apiContext.d.ts +11 -0
  46. package/build/esm/apiContext.js +138 -0
  47. package/build/esm/baseController.d.ts +17 -0
  48. package/build/esm/baseController.js +53 -0
  49. package/build/esm/checkItHelpers.d.ts +3 -0
  50. package/build/esm/checkItHelpers.js +23 -0
  51. package/build/esm/commonValidators.d.ts +17 -0
  52. package/build/esm/commonValidators.js +291 -0
  53. package/build/esm/configBulder.d.ts +2 -0
  54. package/build/esm/configBulder.js +32 -0
  55. package/build/esm/constants.d.ts +30 -0
  56. package/build/esm/constants.js +69 -0
  57. package/build/esm/dbHelpers.d.ts +43 -0
  58. package/build/esm/dbHelpers.js +144 -0
  59. package/build/esm/dbSeeder.d.ts +2 -0
  60. package/build/esm/dbSeeder.js +44 -0
  61. package/build/esm/dbTableHelpers.d.ts +14 -0
  62. package/build/esm/dbTableHelpers.js +106 -0
  63. package/build/esm/downloadHelpers.d.ts +2 -0
  64. package/build/esm/downloadHelpers.js +66 -0
  65. package/build/esm/index.d.ts +21 -0
  66. package/build/esm/index.js +21 -0
  67. package/build/esm/interfaces/ApiContext.d.ts +25 -0
  68. package/build/esm/interfaces/ApiContext.js +1 -0
  69. package/build/esm/interfaces/ApiContextInterface.d.ts +12 -0
  70. package/build/esm/interfaces/ApiContextInterface.js +1 -0
  71. package/build/esm/interfaces/BaseCoreActionsInterface.d.ts +38 -0
  72. package/build/esm/interfaces/BaseCoreActionsInterface.js +1 -0
  73. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
  74. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.js +1 -0
  75. package/build/esm/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
  76. package/build/esm/interfaces/BaseCoreDoingWhatInterface.js +1 -0
  77. package/build/esm/interfaces/BaseCorePropsInterface.d.ts +37 -0
  78. package/build/esm/interfaces/BaseCorePropsInterface.js +1 -0
  79. package/build/esm/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
  80. package/build/esm/interfaces/BaseCoreValidatorsInterface.js +1 -0
  81. package/build/esm/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
  82. package/build/esm/interfaces/BaseGatewayPropsInterface.js +1 -0
  83. package/build/esm/interfaces/BuildConfigOptions.d.ts +6 -0
  84. package/build/esm/interfaces/BuildConfigOptions.js +1 -0
  85. package/build/esm/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
  86. package/build/esm/interfaces/BuildDefaultResolversOptions.js +1 -0
  87. package/build/esm/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
  88. package/build/esm/interfaces/BuildListQueryArgsInterface.js +1 -0
  89. package/build/esm/interfaces/CacheInterface.d.ts +15 -0
  90. package/build/esm/interfaces/CacheInterface.js +1 -0
  91. package/build/esm/interfaces/CommonValidatorArgs.d.ts +3 -0
  92. package/build/esm/interfaces/CommonValidatorArgs.js +1 -0
  93. package/build/esm/interfaces/CoreActionInterface.d.ts +15 -0
  94. package/build/esm/interfaces/CoreActionInterface.js +1 -0
  95. package/build/esm/interfaces/CreateUserTokenArgs.d.ts +11 -0
  96. package/build/esm/interfaces/CreateUserTokenArgs.js +1 -0
  97. package/build/esm/interfaces/CreateUserTokenResult.d.ts +4 -0
  98. package/build/esm/interfaces/CreateUserTokenResult.js +1 -0
  99. package/build/esm/interfaces/DatabaseOptions.d.ts +26 -0
  100. package/build/esm/interfaces/DatabaseOptions.js +1 -0
  101. package/build/esm/interfaces/DatabaseReadInterface.d.ts +14 -0
  102. package/build/esm/interfaces/DatabaseReadInterface.js +1 -0
  103. package/build/esm/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
  104. package/build/esm/interfaces/DbFieldAddDefaultInterface.js +1 -0
  105. package/build/esm/interfaces/DownloadFileArgs.d.ts +6 -0
  106. package/build/esm/interfaces/DownloadFileArgs.js +1 -0
  107. package/build/esm/interfaces/ExtractCredentialsArgs.d.ts +19 -0
  108. package/build/esm/interfaces/ExtractCredentialsArgs.js +1 -0
  109. package/build/esm/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
  110. package/build/esm/interfaces/JwtTokenSecretAndSettings.js +1 -0
  111. package/build/esm/interfaces/ListArgsInterface.d.ts +7 -0
  112. package/build/esm/interfaces/ListArgsInterface.js +1 -0
  113. package/build/esm/interfaces/LoaderInterface.d.ts +7 -0
  114. package/build/esm/interfaces/LoaderInterface.js +1 -0
  115. package/build/esm/interfaces/PaginationInterface.d.ts +10 -0
  116. package/build/esm/interfaces/PaginationInterface.js +1 -0
  117. package/build/esm/interfaces/SortItemInterface.d.ts +4 -0
  118. package/build/esm/interfaces/SortItemInterface.js +1 -0
  119. package/build/esm/interfaces/UserTokenParams.d.ts +8 -0
  120. package/build/esm/interfaces/UserTokenParams.js +1 -0
  121. package/build/esm/interfaces/VerifyUserTokenArgs.d.ts +13 -0
  122. package/build/esm/interfaces/VerifyUserTokenArgs.js +1 -0
  123. package/build/esm/interfaces/index.d.ts +28 -0
  124. package/build/esm/interfaces/index.js +27 -0
  125. package/build/esm/knexConfigBuilder.d.ts +1 -0
  126. package/build/esm/knexConfigBuilder.js +84 -0
  127. package/build/esm/passwordHelpers.d.ts +5 -0
  128. package/build/esm/passwordHelpers.js +13 -0
  129. package/build/esm/redisClient.d.ts +17 -0
  130. package/build/esm/redisClient.js +97 -0
  131. package/build/esm/resolversHelpers.d.ts +3 -0
  132. package/build/esm/resolversHelpers.js +66 -0
  133. package/build/esm/userToken.d.ts +8 -0
  134. package/build/esm/userToken.js +80 -0
  135. package/build/esm/utils.d.ts +2 -0
  136. package/build/esm/utils.js +13 -0
  137. package/build/index.d.ts +21 -0
  138. package/build/index.js +37 -0
  139. package/build/interfaces/ApiContext.d.ts +25 -0
  140. package/build/interfaces/ApiContext.js +2 -0
  141. package/build/interfaces/ApiContextInterface.d.ts +12 -0
  142. package/build/interfaces/ApiContextInterface.js +2 -0
  143. package/build/interfaces/BaseCoreActionsInterface.d.ts +38 -0
  144. package/build/interfaces/BaseCoreActionsInterface.js +2 -0
  145. package/build/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
  146. package/build/interfaces/BaseCoreDoAuthOnActionInterface.js +2 -0
  147. package/build/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
  148. package/build/interfaces/BaseCoreDoingWhatInterface.js +2 -0
  149. package/build/interfaces/BaseCorePropsInterface.d.ts +37 -0
  150. package/build/interfaces/BaseCorePropsInterface.js +2 -0
  151. package/build/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
  152. package/build/interfaces/BaseCoreValidatorsInterface.js +2 -0
  153. package/build/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
  154. package/build/interfaces/BaseGatewayPropsInterface.js +2 -0
  155. package/build/interfaces/BuildConfigOptions.d.ts +6 -0
  156. package/build/interfaces/BuildConfigOptions.js +2 -0
  157. package/build/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
  158. package/build/interfaces/BuildDefaultResolversOptions.js +2 -0
  159. package/build/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
  160. package/build/interfaces/BuildListQueryArgsInterface.js +2 -0
  161. package/build/interfaces/CacheInterface.d.ts +15 -0
  162. package/build/interfaces/CacheInterface.js +2 -0
  163. package/build/interfaces/CommonValidatorArgs.d.ts +3 -0
  164. package/build/interfaces/CommonValidatorArgs.js +2 -0
  165. package/build/interfaces/CoreActionInterface.d.ts +15 -0
  166. package/build/interfaces/CoreActionInterface.js +2 -0
  167. package/build/interfaces/CreateUserTokenArgs.d.ts +11 -0
  168. package/build/interfaces/CreateUserTokenArgs.js +2 -0
  169. package/build/interfaces/CreateUserTokenResult.d.ts +4 -0
  170. package/build/interfaces/CreateUserTokenResult.js +2 -0
  171. package/build/interfaces/DatabaseOptions.d.ts +26 -0
  172. package/build/interfaces/DatabaseOptions.js +2 -0
  173. package/build/interfaces/DatabaseReadInterface.d.ts +14 -0
  174. package/build/interfaces/DatabaseReadInterface.js +2 -0
  175. package/build/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
  176. package/build/interfaces/DbFieldAddDefaultInterface.js +2 -0
  177. package/build/interfaces/DownloadFileArgs.d.ts +6 -0
  178. package/build/interfaces/DownloadFileArgs.js +2 -0
  179. package/build/interfaces/ExtractCredentialsArgs.d.ts +19 -0
  180. package/build/interfaces/ExtractCredentialsArgs.js +2 -0
  181. package/build/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
  182. package/build/interfaces/JwtTokenSecretAndSettings.js +2 -0
  183. package/build/interfaces/ListArgsInterface.d.ts +7 -0
  184. package/build/interfaces/ListArgsInterface.js +2 -0
  185. package/build/interfaces/LoaderInterface.d.ts +7 -0
  186. package/build/interfaces/LoaderInterface.js +2 -0
  187. package/build/interfaces/PaginationInterface.d.ts +10 -0
  188. package/build/interfaces/PaginationInterface.js +2 -0
  189. package/build/interfaces/SortItemInterface.d.ts +4 -0
  190. package/build/interfaces/SortItemInterface.js +2 -0
  191. package/build/interfaces/UserTokenParams.d.ts +8 -0
  192. package/build/interfaces/UserTokenParams.js +2 -0
  193. package/build/interfaces/VerifyUserTokenArgs.d.ts +13 -0
  194. package/build/interfaces/VerifyUserTokenArgs.js +2 -0
  195. package/build/interfaces/index.d.ts +28 -0
  196. package/build/interfaces/index.js +43 -0
  197. package/build/knexConfigBuilder.d.ts +1 -0
  198. package/build/knexConfigBuilder.js +91 -0
  199. package/build/passwordHelpers.d.ts +5 -0
  200. package/build/passwordHelpers.js +21 -0
  201. package/build/redisClient.d.ts +17 -0
  202. package/build/redisClient.js +100 -0
  203. package/build/resolversHelpers.d.ts +3 -0
  204. package/build/resolversHelpers.js +69 -0
  205. package/build/userToken.d.ts +8 -0
  206. package/build/userToken.js +92 -0
  207. package/build/utils.d.ts +2 -0
  208. package/build/utils.js +21 -0
  209. package/package.json +1 -1
@@ -0,0 +1,56 @@
1
+ import { DateTimeHelpers, Logger } from '@sdflc/utils';
2
+ import { DataCache } from './DataCache';
3
+ import { ApiContext, BaseGatewayPropsInterface, BuildListQueryArgsInterface, CacheInterface, ListArgsInterface, LoaderInterface } from './interfaces';
4
+ import { Database } from './Database';
5
+ declare class BaseGateway {
6
+ protected config: BaseGatewayPropsInterface;
7
+ protected logger: Logger;
8
+ protected loader: LoaderInterface | DataCache;
9
+ protected dateTime: DateTimeHelpers;
10
+ protected dateTimeNow: Date;
11
+ constructor(props: BaseGatewayPropsInterface);
12
+ getConfig(): BaseGatewayPropsInterface;
13
+ setConfigPart(props: BaseGatewayPropsInterface): this;
14
+ setLoader(loader: LoaderInterface): this;
15
+ setLoaderConfig(config: CacheInterface): this;
16
+ /**
17
+ * Generates object's ID
18
+ * @param object use them when overriding the generate method and you may need data from an object
19
+ * @returns unique ID, by default it is UUID v4
20
+ */
21
+ generateId(object?: any): Promise<string>;
22
+ onListFilter(query: any, filterParams: any): Promise<void>;
23
+ onUpdateFilter(query: any, filterParams: any): Promise<number>;
24
+ onRemoveFilter(query: any, filterParams: any): Promise<number>;
25
+ transformOnCreate(params: any): Promise<any>;
26
+ transformOnUpdate(params: any, where?: any): Promise<any>;
27
+ transformOnSet(params: any): Promise<any>;
28
+ transformOnRemove(args?: any): Promise<any>;
29
+ protected transformOnOut(item: any): any;
30
+ getRequestId(): string;
31
+ getContext(): ApiContext;
32
+ getGateways(): any;
33
+ getDb(): Database;
34
+ getBuilder(): any;
35
+ getIdField(): string;
36
+ getIdFieldUpdateRemove(): string;
37
+ get(id: any): Promise<any>;
38
+ getMany(ids: any[]): Promise<any>;
39
+ buildListQuery(args?: BuildListQueryArgsInterface): Promise<any>;
40
+ list(args?: ListArgsInterface): Promise<any>;
41
+ create(args: any): Promise<any[]>;
42
+ update(where: any, params: any): Promise<any>;
43
+ updateMany(params: any): Promise<any[]>;
44
+ increment(where: any, params: any): Promise<any>;
45
+ decrement(where: any, params: any): Promise<any>;
46
+ /**
47
+ * Inserts or updates data in the database.
48
+ * If the element of given array has not empty id field then the record is updated
49
+ * oterwise inserted
50
+ * @param params Array of objects to update or create
51
+ * @returns Array of updated or inserted objects
52
+ */
53
+ set(params: any): Promise<any[]>;
54
+ remove(where: any): Promise<any>;
55
+ }
56
+ export { BaseGateway };
@@ -0,0 +1,471 @@
1
+ import { v4 } from 'uuid';
2
+ import dayjs from 'dayjs';
3
+ import check from 'check-types';
4
+ import { camelCase, castArray, pullAll } from 'lodash';
5
+ import { arrToChunks, STATUSES, DateTimeHelpers, buildKey, Logger, LoggerLevels } from '@sdflc/utils';
6
+ import { DataCache } from './DataCache';
7
+ import { FIELDS, ID_FIELD } from './constants';
8
+ const DEFAULT_CHUNCK_SIZE = 2500;
9
+ class BaseGateway {
10
+ config;
11
+ logger;
12
+ loader;
13
+ dateTime = new DateTimeHelpers();
14
+ dateTimeNow = new Date();
15
+ constructor(props) {
16
+ this.config = props;
17
+ this.config.returnFields =
18
+ Array.isArray(this.config.returnFields) && this.config.returnFields.length > 0 ? this.config.returnFields : ['*'];
19
+ this.config.activeStatuses = Array.isArray(this.config.activeStatuses)
20
+ ? this.config.activeStatuses
21
+ : [STATUSES.ACTIVE];
22
+ this.config.keyPrefix = this.config.context?.keyPrefix || this.config.keyPrefix || this.config.table;
23
+ if (this.config.keyPrefix && this.config.context?.usedKeyPrefixes) {
24
+ if (this.config.context.usedKeyPrefixes[this.config.keyPrefix]) {
25
+ throw new Error(`The "${this.config.keyPrefix}" is already used as the "keyPrefix" in the application. Please use another one that is not as: ${Object.keys(this.config.context.usedKeyPrefixes).join(', ')}`);
26
+ }
27
+ this.config.context.usedKeyPrefixes[this.config.keyPrefix] = true;
28
+ }
29
+ this.logger = props?.logger instanceof Logger ? props.logger : new Logger({ level: LoggerLevels.WARNING });
30
+ this.loader = check.function(this.config?.loader) ? this.config.loader : new DataCache(this.config);
31
+ }
32
+ getConfig() {
33
+ return this.config;
34
+ }
35
+ setConfigPart(props) {
36
+ Object.assign(this.config, props);
37
+ return this;
38
+ }
39
+ setLoader(loader) {
40
+ this.loader = loader;
41
+ return this;
42
+ }
43
+ setLoaderConfig(config) {
44
+ this.loader = new DataCache({ ...this.config, ...config });
45
+ return this;
46
+ }
47
+ /**
48
+ * Generates object's ID
49
+ * @param object use them when overriding the generate method and you may need data from an object
50
+ * @returns unique ID, by default it is UUID v4
51
+ */
52
+ async generateId(object) {
53
+ return v4();
54
+ }
55
+ async onListFilter(query, filterParams) {
56
+ const { table, hasStatus, hasRemovedAt, hasSpace, activeStatuses, hasLang, fieldForKeyword, filterByUserField } = this.config || {};
57
+ // This function should be overriden
58
+ if (hasStatus) {
59
+ query.whereIn(`${table}.${FIELDS.STATUS}`, filterParams?.[FIELDS.STATUS] != null ? castArray(filterParams?.[FIELDS.STATUS]) : castArray(activeStatuses));
60
+ }
61
+ if (hasRemovedAt) {
62
+ query.whereNull(`${table}.${FIELDS.REMOVED_AT}`);
63
+ }
64
+ if (hasSpace && (filterParams?.[FIELDS.SPACE_ID] != undefined || this.config.context.spaceId)) {
65
+ query.where({
66
+ [`${table}.${FIELDS.SPACE_ID}`]: filterParams?.[FIELDS.SPACE_ID] != undefined ? filterParams?.[FIELDS.SPACE_ID] : this.config.context.spaceId,
67
+ });
68
+ }
69
+ if (hasLang && filterParams?.[FIELDS.LANG] != undefined) {
70
+ query.whereIn(`${table}.${FIELDS.LANG}`, castArray(filterParams?.[FIELDS.LANG]));
71
+ }
72
+ const idField = this.getIdField();
73
+ if (filterParams?.[idField]) {
74
+ query.whereIn(idField.includes('.') ? `${idField}` : `${table}.${idField}`, castArray(filterParams?.[idField]));
75
+ }
76
+ if (fieldForKeyword && filterParams.keyword) {
77
+ // const opLike = this.getDb().getDbType() === 'pg' ? 'ILIKE' : 'LIKE';
78
+ // query.whereRaw(`?? ${opLike} ?`, [fieldForKeyword, `%${filterParams.keyword}%`]);
79
+ query.whereILike(fieldForKeyword, `%${filterParams.keyword}%`);
80
+ }
81
+ if (filterByUserField) {
82
+ query.where({ [filterByUserField]: this.getContext().userId });
83
+ }
84
+ // TODO: prse filterParams and buils where clause automatically here
85
+ }
86
+ async onUpdateFilter(query, filterParams) {
87
+ // This function should be overriden
88
+ const { hasStatus, hasVersion } = this.config;
89
+ const idName = this.getIdFieldUpdateRemove();
90
+ let filtersAppliedQty = 0;
91
+ if (filterParams[idName]) {
92
+ filtersAppliedQty++;
93
+ query.whereIn(idName, castArray(filterParams[idName]));
94
+ }
95
+ if (hasVersion) {
96
+ if (filterParams[FIELDS.VERSION] != null && !isNaN(filterParams[FIELDS.VERSION])) {
97
+ filtersAppliedQty++;
98
+ query.where({ [FIELDS.VERSION]: filterParams[FIELDS.VERSION] });
99
+ }
100
+ }
101
+ if (hasStatus) {
102
+ filtersAppliedQty++;
103
+ if (Array.isArray(filterParams?.[FIELDS.STATUS])) {
104
+ query.whereIn(FIELDS.STATUS, filterParams?.[FIELDS.STATUS]);
105
+ }
106
+ else {
107
+ query.where(FIELDS.STATUS, '!=', STATUSES.REMOVED);
108
+ }
109
+ }
110
+ return filtersAppliedQty;
111
+ }
112
+ async onRemoveFilter(query, filterParams) {
113
+ // This function should be overriden
114
+ const { hasStatus } = this.config;
115
+ const arr = filterParams ? castArray(filterParams) : [];
116
+ let filtersAppliedQty = 0;
117
+ const idName = this.getIdFieldUpdateRemove();
118
+ const ids = [];
119
+ for (let filter of arr) {
120
+ if (filter[idName]) {
121
+ ids.push(filter[idName]);
122
+ }
123
+ }
124
+ if (ids.length > 0) {
125
+ filtersAppliedQty++;
126
+ query.whereIn(idName, ids);
127
+ }
128
+ if (hasStatus === true) {
129
+ filtersAppliedQty++;
130
+ query.where(FIELDS.STATUS, '!=', STATUSES.REMOVED);
131
+ }
132
+ return filtersAppliedQty;
133
+ }
134
+ async transformOnCreate(params) {
135
+ const { hasCreatedAt, hasCreatedBy, hasSpace, hasVersion, hasLang, localizationForField, hasUserId } = this.config;
136
+ if (hasCreatedAt) {
137
+ params[camelCase(FIELDS.CREATED_AT)] = this.dateTime.dbFormat(this.dateTimeNow);
138
+ }
139
+ if (hasCreatedBy) {
140
+ const createdBy = camelCase(FIELDS.CREATED_BY);
141
+ if (params[createdBy] === undefined) {
142
+ params[createdBy] = this.getContext().userId;
143
+ }
144
+ }
145
+ if (hasUserId) {
146
+ const userId = camelCase(FIELDS.USER_ID);
147
+ if (params[userId] === undefined) {
148
+ params[userId] = this.getContext().userId;
149
+ }
150
+ }
151
+ if (hasSpace) {
152
+ params[camelCase(FIELDS.SPACE_ID)] = this.getContext().spaceId;
153
+ }
154
+ if (hasVersion) {
155
+ params[camelCase(FIELDS.VERSION)] = 0;
156
+ }
157
+ if (hasLang && localizationForField) {
158
+ params[this.getIdField()] = buildKey([params[camelCase(localizationForField)], params[camelCase(FIELDS.LANG)]]);
159
+ }
160
+ return params;
161
+ }
162
+ async transformOnUpdate(params, where) {
163
+ const { hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField } = this.config;
164
+ if (hasUpdatedAt) {
165
+ params[camelCase(FIELDS.UPDATED_AT)] = this.dateTime.dbFormat(this.dateTimeNow);
166
+ }
167
+ if (hasUpdatedBy) {
168
+ const updatedBy = camelCase(FIELDS.UPDATED_BY);
169
+ if (params[updatedBy] === undefined) {
170
+ params[updatedBy] = this.getContext().userId;
171
+ }
172
+ }
173
+ if (hasVersion) {
174
+ const version = camelCase(FIELDS.VERSION);
175
+ if (params[version] != null && !isNaN(params[version])) {
176
+ params[version] = params[version] + 1;
177
+ }
178
+ }
179
+ if (hasLang && localizationForField) {
180
+ params[this.getIdField()] = buildKey([params[camelCase(localizationForField)], params[camelCase(FIELDS.LANG)]]);
181
+ }
182
+ return params;
183
+ }
184
+ async transformOnSet(params) {
185
+ const { hasCreatedAt, hasCreatedBy, hasSpace, hasUpdatedAt, hasUpdatedBy, hasVersion, hasLang, localizationForField, hasUserId, } = this.config;
186
+ if (hasCreatedAt) {
187
+ params[camelCase(FIELDS.CREATED_AT)] = this.dateTime.dbFormat(this.dateTimeNow);
188
+ }
189
+ if (hasCreatedBy) {
190
+ const createdBy = camelCase(FIELDS.CREATED_BY);
191
+ if (params[createdBy] === undefined) {
192
+ params[createdBy] = this.getContext().userId;
193
+ }
194
+ }
195
+ if (hasUserId) {
196
+ const userId = camelCase(FIELDS.USER_ID);
197
+ if (params[userId] === undefined) {
198
+ params[userId] = this.getContext().userId;
199
+ }
200
+ }
201
+ if (hasSpace) {
202
+ params[camelCase(FIELDS.SPACE_ID)] = this.getContext().spaceId;
203
+ }
204
+ if (hasUpdatedAt) {
205
+ params[camelCase(FIELDS.UPDATED_AT)] = this.dateTime.dbFormat(this.dateTimeNow);
206
+ }
207
+ if (hasUpdatedBy) {
208
+ const updatedBy = camelCase(FIELDS.UPDATED_BY);
209
+ if (params[updatedBy] === undefined) {
210
+ params[updatedBy] = this.getContext().userId;
211
+ }
212
+ }
213
+ if (hasVersion) {
214
+ const version = camelCase(FIELDS.VERSION);
215
+ if (params[version] != null && !isNaN(params[version])) {
216
+ params[version] = params[version] + 1;
217
+ }
218
+ else {
219
+ params[version] = 0;
220
+ }
221
+ }
222
+ if (hasLang && localizationForField) {
223
+ params[this.getIdField()] = buildKey([params[camelCase(localizationForField)], params[camelCase(FIELDS.LANG)]]);
224
+ }
225
+ return params;
226
+ }
227
+ async transformOnRemove(args) {
228
+ const { hasRemovedAt, hasRemovedAtStr, hasStatus, hasRemovedBy, hasLang, localizationForField } = this.config;
229
+ const removalTime = dayjs();
230
+ const removalTimeStr = removalTime.format('YYYYMMDDTHHmmssZ');
231
+ const obj = {
232
+ ...(args || {}),
233
+ };
234
+ if (hasRemovedAt) {
235
+ obj[FIELDS.REMOVED_AT] = removalTime.toDate();
236
+ }
237
+ if (hasRemovedAtStr === true) {
238
+ obj[FIELDS.REMOVED_AT_STR] = removalTimeStr;
239
+ }
240
+ if (hasStatus) {
241
+ obj[FIELDS.STATUS] = STATUSES.REMOVED;
242
+ }
243
+ if (hasRemovedBy) {
244
+ if (obj[FIELDS.REMOVED_BY] === undefined) {
245
+ obj[FIELDS.REMOVED_BY] = this.getContext().userId;
246
+ }
247
+ }
248
+ if (hasLang && localizationForField) {
249
+ obj[this.getIdField()] = this.getDb().raw(`CONCAT(id, '-${removalTimeStr}')`);
250
+ }
251
+ return obj;
252
+ }
253
+ transformOnOut(item) {
254
+ return item;
255
+ }
256
+ getRequestId() {
257
+ return this.config.context.requestId;
258
+ }
259
+ getContext() {
260
+ return this.config.context;
261
+ }
262
+ getGateways() {
263
+ return this.config.context.gateways || {};
264
+ }
265
+ getDb() {
266
+ return this.config.db;
267
+ }
268
+ getBuilder() {
269
+ return this.getDb()?.getBuilder(this.config.table);
270
+ }
271
+ getIdField() {
272
+ return this.config.idField || ID_FIELD;
273
+ }
274
+ getIdFieldUpdateRemove() {
275
+ return this.config.idFieldUpdateRemove || this.config.idField || ID_FIELD;
276
+ }
277
+ async get(id) {
278
+ return this.loader.load(id);
279
+ }
280
+ async getMany(ids) {
281
+ return this.loader.loadMany(ids);
282
+ }
283
+ async buildListQuery(args) {
284
+ const { fieldsToUse } = args || {};
285
+ const query = this.getBuilder();
286
+ query.select(fieldsToUse || '*');
287
+ return { query };
288
+ }
289
+ async list(args) {
290
+ const { filter, params, useCache } = args || {};
291
+ const { limit, offset, sortBy } = this.getDb().createLimitOffsetSortBy(params, this.config.defaultSorting || []);
292
+ if (!this.config.table) {
293
+ return [];
294
+ }
295
+ const shouldUseCache = useCache != null ? useCache : !this.config.noCache;
296
+ const fieldsToUse = !shouldUseCache && Array.isArray(this.config.selectFields) ? this.config.selectFields : this.getIdField();
297
+ const { query } = await this.buildListQuery({ filter, params, fieldsToUse, useCache: shouldUseCache });
298
+ await this.onListFilter(query, filter);
299
+ if (limit && !isNaN(limit) && limit > 0) {
300
+ query.offset(offset).limit(limit);
301
+ }
302
+ if (sortBy) {
303
+ query.orderBy(sortBy);
304
+ }
305
+ const items = await query;
306
+ const result = shouldUseCache ? await this.getMany(items.map((row) => row.id)) : items;
307
+ return result.map((item) => this.transformOnOut(item));
308
+ }
309
+ async create(args) {
310
+ const objects = castArray(args);
311
+ if (!args || objects.length === 0) {
312
+ return [];
313
+ }
314
+ for (let idx = 0, len = objects.length; idx < len; ++idx) {
315
+ const object = objects[idx];
316
+ const id = await this.generateId(object);
317
+ objects[idx] = await this.transformOnCreate({ id, ...object });
318
+ //objects.push(obj);
319
+ }
320
+ const result = [];
321
+ const chunks = arrToChunks(objects, this.config?.insertChunkSize || DEFAULT_CHUNCK_SIZE);
322
+ for (let idx = 0, len = chunks.length; idx < len; ++idx) {
323
+ const items = await this.getBuilder().insert(chunks[idx]).returning(this.config.returnFields);
324
+ result.push(...items);
325
+ }
326
+ return result.map((item) => this.transformOnOut(item));
327
+ }
328
+ async update(where, params) {
329
+ const object = await this.transformOnUpdate(params, where);
330
+ const query = this.getBuilder().update(object).returning(this.config.returnFields);
331
+ const filtersAppliedQty = await this.onUpdateFilter(query, where);
332
+ if (filtersAppliedQty == null || filtersAppliedQty <= 0) {
333
+ throw new Error(`Failed to update the table '${this.config.table}' as none of filters applied: ${JSON.stringify(where, null, 2)}`);
334
+ }
335
+ const items = await query;
336
+ if (items.length > 0 && this.config.noCache !== true) {
337
+ const idName = this.getIdFieldUpdateRemove();
338
+ items.forEach((item) => {
339
+ if (item[idName]) {
340
+ this.loader.clear(item[idName]);
341
+ }
342
+ });
343
+ }
344
+ return items.map((item) => this.transformOnOut(item));
345
+ }
346
+ async updateMany(params) {
347
+ if (!Array.isArray(params)) {
348
+ params = [params];
349
+ }
350
+ const results = [];
351
+ for (let idx = 0, len = params.length; idx < len; ++idx) {
352
+ const item = params[idx];
353
+ const items = await this.update(item.where, item.params);
354
+ results.push(...items);
355
+ }
356
+ if (results.length > 0 && this.config.noCache !== true) {
357
+ const idName = this.getIdFieldUpdateRemove();
358
+ results.forEach((item) => {
359
+ if (item[idName]) {
360
+ this.loader.clear(item[idName]);
361
+ }
362
+ });
363
+ }
364
+ return results.map((item) => this.transformOnOut(item));
365
+ }
366
+ async increment(where, params) {
367
+ const object = await this.transformOnUpdate(params, where);
368
+ const query = this.getBuilder().increment(object).returning(this.config.returnFields);
369
+ const filtersAppliedQty = await this.onUpdateFilter(query, where);
370
+ if (filtersAppliedQty == null || filtersAppliedQty <= 0) {
371
+ throw new Error(`Failed to update the table '${this.config.table}' as none of filters applied: ${JSON.stringify(where, null, 2)}`);
372
+ }
373
+ const items = await query;
374
+ if (items.length > 0 && this.config.noCache !== true) {
375
+ const idName = this.getIdFieldUpdateRemove();
376
+ items.forEach((item) => {
377
+ if (item[idName]) {
378
+ this.loader.clear(item[idName]);
379
+ }
380
+ });
381
+ }
382
+ return items.map((item) => this.transformOnOut(item));
383
+ }
384
+ async decrement(where, params) {
385
+ const object = await this.transformOnUpdate(params, where);
386
+ const query = this.getBuilder().decrement(object).returning(this.config.returnFields);
387
+ const filtersAppliedQty = await this.onUpdateFilter(query, where);
388
+ if (filtersAppliedQty == null || filtersAppliedQty <= 0) {
389
+ throw new Error(`Failed to update the table '${this.config.table}' as none of filters applied: ${JSON.stringify(where, null, 2)}`);
390
+ }
391
+ const items = await query;
392
+ if (items.length > 0 && this.config.noCache !== true) {
393
+ const idName = this.getIdFieldUpdateRemove();
394
+ items.forEach((item) => {
395
+ if (item[idName]) {
396
+ this.loader.clear(item[idName]);
397
+ }
398
+ });
399
+ }
400
+ return items.map((item) => this.transformOnOut(item));
401
+ }
402
+ /**
403
+ * Inserts or updates data in the database.
404
+ * If the element of given array has not empty id field then the record is updated
405
+ * oterwise inserted
406
+ * @param params Array of objects to update or create
407
+ * @returns Array of updated or inserted objects
408
+ */
409
+ async set(params) {
410
+ const { hasCreatedAt, hasCreatedBy, hasSpace, mergeFields } = this.config || {};
411
+ const objects = castArray(params);
412
+ if (!params || objects.length === 0) {
413
+ return [];
414
+ }
415
+ const skipFields = [];
416
+ if (hasCreatedAt) {
417
+ skipFields.push(FIELDS.CREATED_AT);
418
+ }
419
+ if (hasCreatedBy) {
420
+ skipFields.push(FIELDS.CREATED_BY);
421
+ }
422
+ if (hasSpace) {
423
+ skipFields.push(FIELDS.SPACE_ID);
424
+ }
425
+ for (let idx = 0, len = objects.length; idx < len; ++idx) {
426
+ const object = objects[idx];
427
+ objects[idx] = await this.transformOnSet(object);
428
+ if (objects[idx][this.getIdField()] == null) {
429
+ objects[idx][this.getIdField()] = await this.generateId(object);
430
+ }
431
+ }
432
+ const fields = Array.isArray(mergeFields) ? mergeFields : Object.keys(objects[0]);
433
+ const result = [];
434
+ const chunks = arrToChunks(objects, this.config?.insertChunkSize || DEFAULT_CHUNCK_SIZE);
435
+ for (let idx = 0, len = chunks.length; idx < len; ++idx) {
436
+ const items = await this.getBuilder()
437
+ .insert(chunks[idx])
438
+ .returning(this.config.returnFields)
439
+ .onConflict(this.config.setFields || this.getIdField())
440
+ .merge(pullAll(fields, skipFields));
441
+ result.push(...items);
442
+ }
443
+ return result.map((item) => this.transformOnOut(item));
444
+ }
445
+ async remove(where) {
446
+ const { hardRemove, hasRemovedAt } = this.config || {};
447
+ const query = this.getBuilder();
448
+ if (hardRemove || !hasRemovedAt) {
449
+ query.delete(this.config.returnFields);
450
+ }
451
+ else {
452
+ const object = await this.transformOnRemove();
453
+ query.update(object).returning(this.config.returnFields);
454
+ }
455
+ const filtersAppliedQty = await this.onRemoveFilter(query, where);
456
+ if (filtersAppliedQty == null || filtersAppliedQty <= 0) {
457
+ throw new Error(`Failed to remove records in the table '${this.config.table}' as none of filters applied: ${JSON.stringify(where, null, 2)}`);
458
+ }
459
+ const items = await query;
460
+ if (items.length > 0 && this.config.noCache !== true) {
461
+ const idName = this.getIdFieldUpdateRemove();
462
+ items.forEach((item) => {
463
+ if (item[idName]) {
464
+ this.loader.clear(item[idName]);
465
+ }
466
+ });
467
+ }
468
+ return items.map((item) => this.transformOnOut(item));
469
+ }
470
+ }
471
+ export { BaseGateway };
@@ -0,0 +1,16 @@
1
+ import { CacheInterface, LoaderInterface } from './interfaces';
2
+ declare class DataCache implements LoaderInterface {
3
+ private buildKey;
4
+ private loader;
5
+ private config;
6
+ private redisClient;
7
+ constructor(props: CacheInterface);
8
+ batchLoaderDefault(props: CacheInterface): (ids: any[]) => Promise<any[]>;
9
+ init(batchFunction: any, keyPrefix?: string, context?: any): void;
10
+ load(key: any): any;
11
+ loadMany(keys: any[]): any;
12
+ prime(key: any, value: any): this;
13
+ clear(key: any | any[]): this;
14
+ clearAll(): this;
15
+ }
16
+ export { DataCache };
@@ -0,0 +1,107 @@
1
+ import DataLoader from 'dataloader';
2
+ import { RedisDataLoader } from './RedisDataLoader';
3
+ import { buildKey as defaultBuildKey } from '@sdflc/utils';
4
+ import { FIELDS } from '.';
5
+ import { castArray } from 'lodash';
6
+ class DataCache {
7
+ buildKey;
8
+ loader;
9
+ config;
10
+ redisClient;
11
+ constructor(props) {
12
+ const { loaderFn, keyPrefix, context, buildKey, redisClient, table } = props || {};
13
+ const innerProps = {
14
+ ...props,
15
+ idField: props?.idField || FIELDS.ID,
16
+ idFieldAs: props?.idFieldAs || FIELDS.ID,
17
+ };
18
+ this.config = innerProps;
19
+ this.redisClient = redisClient;
20
+ this.buildKey = typeof buildKey === 'function' ? buildKey : defaultBuildKey;
21
+ this.batchLoaderDefault = this.batchLoaderDefault.bind(this);
22
+ const fn = typeof loaderFn === 'function' ? loaderFn : this.batchLoaderDefault(innerProps);
23
+ const prefixToUse = context?.keyPrefix || keyPrefix || table;
24
+ this.init(fn, prefixToUse, context);
25
+ }
26
+ batchLoaderDefault(props) {
27
+ const { table, idField, idFieldAs, readAll, db } = props;
28
+ if (!table) {
29
+ throw Error(`DataCache requires 'table' property to be setup`);
30
+ }
31
+ else if (!idField && readAll == null) {
32
+ throw Error(`DataCache requires 'idField' or 'readAll' property to be setup`);
33
+ }
34
+ else if (!db) {
35
+ throw Error(`DataCache requires 'db' property to be setup`);
36
+ }
37
+ return async (ids) => {
38
+ const resultItems = [];
39
+ const readCfg = {
40
+ ...props,
41
+ buildKey: this.buildKey,
42
+ };
43
+ const idsToUse = castArray(ids);
44
+ if (!readAll) {
45
+ readCfg.mapBy = idFieldAs || idField;
46
+ readCfg.whereIn = {
47
+ field: idField,
48
+ values: idsToUse.filter((id) => id),
49
+ };
50
+ }
51
+ const dbItems = await db.read(readCfg);
52
+ if (readAll) {
53
+ resultItems.push(...dbItems);
54
+ }
55
+ else {
56
+ resultItems.push(...idsToUse.map((id) => dbItems[this.buildKey(id)] || null));
57
+ }
58
+ return resultItems;
59
+ };
60
+ }
61
+ init(batchFunction, keyPrefix, context) {
62
+ if (this.redisClient) {
63
+ this.loader = new RedisDataLoader(this.redisClient,
64
+ // set a prefix for the keys stored in redis. This way you can avoid key
65
+ // collisions for different data-sets in your redis instance.
66
+ keyPrefix,
67
+ // create a regular loader. This should always be set with caching disabled.
68
+ {
69
+ load: (ids) => batchFunction(ids, context),
70
+ }, {
71
+ cache: true,
72
+ expire: this.config.cacheTtl,
73
+ });
74
+ }
75
+ else {
76
+ this.loader = new DataLoader((ids) => batchFunction(ids, context));
77
+ }
78
+ }
79
+ load(key) {
80
+ const builtKey = this.buildKey(key);
81
+ if (builtKey == null) {
82
+ return Promise.resolve(null);
83
+ }
84
+ return this.loader.load(builtKey);
85
+ }
86
+ loadMany(keys) {
87
+ return this.loader.loadMany(keys.map((key) => this.buildKey(key)));
88
+ }
89
+ prime(key, value) {
90
+ this.loader?.prime(this.buildKey(key), value);
91
+ return this;
92
+ }
93
+ clear(key) {
94
+ if (Array.isArray(key)) {
95
+ key.forEach((item) => this.loader?.clear(this.buildKey(item)));
96
+ }
97
+ else {
98
+ this.loader?.clear(this.buildKey(key));
99
+ }
100
+ return this;
101
+ }
102
+ clearAll() {
103
+ this.loader?.clearAll();
104
+ return this;
105
+ }
106
+ }
107
+ export { DataCache };
@@ -0,0 +1,36 @@
1
+ import { DatabaseOptions, DatabaseReadInterface } from './interfaces';
2
+ declare class Database {
3
+ private trx;
4
+ private dbType;
5
+ private knexHandle;
6
+ private dbSchema;
7
+ private logger;
8
+ constructor(props: DatabaseOptions);
9
+ destroy(): void;
10
+ isDbError(ex: any): any[];
11
+ createTransaction(trx: any): Promise<unknown>;
12
+ getDbType(): string;
13
+ getSchema(): string;
14
+ getBuilder(arg: any): any;
15
+ raw(query: string, bindings?: any): any;
16
+ runRawQuery(query: string, bindings: any): Promise<any>;
17
+ startTransaction(): Promise<unknown>;
18
+ setTransaction(trx: any): void;
19
+ getTransaction(): any;
20
+ commitTransaction(): Promise<void>;
21
+ rollbackTransaction(): Promise<void>;
22
+ doCalculated(item: any, calculatedFields: any[]): void;
23
+ read(args: DatabaseReadInterface): Promise<any>;
24
+ createSortBy(sortBy: any[], defaultSortBy?: any): any[] | null;
25
+ createLimitOffset(page: number, pageSize: number): {
26
+ limit: number | undefined;
27
+ offset: number;
28
+ };
29
+ createLimitOffsetSortBy(params: any, defaultSortBy: any): {
30
+ limit: number | undefined;
31
+ offset: number;
32
+ sortBy: any[] | null;
33
+ };
34
+ static destroyHandle(props: DatabaseOptions): void;
35
+ }
36
+ export { Database };