@sdflc/backend-helpers 1.0.106 → 1.0.108

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 +736 -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 +63 -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 +730 -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 +57 -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 +16 -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 +16 -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,138 @@
1
+ import { camelCase } from 'lodash';
2
+ import { v4 } from 'uuid';
3
+ import check from 'check-types';
4
+ import { extractLanguages } from '@sdflc/utils';
5
+ import { Database } from './Database';
6
+ import { HEADERS } from './constants';
7
+ /**
8
+ * Creates a GraphQL context object with all available cores.
9
+ * @returns {object} A context object with all available cores
10
+ */
11
+ export const createApiContext = async (args) => {
12
+ const { cores, gateways, req, res, getCoreContext, getGatewayContext, extendContext, requestId: inRequestId, } = args || {};
13
+ const requestId = inRequestId || v4();
14
+ const coreContext = check.function(getCoreContext) ? await getCoreContext({ req }) : {};
15
+ const gatewayContext = check.function(getGatewayContext) ? await getGatewayContext({ req }) : {};
16
+ const context = {
17
+ requestId,
18
+ cores: {},
19
+ gateways: {},
20
+ usedKeyPrefixes: {},
21
+ req,
22
+ res,
23
+ };
24
+ context.cores = Object.keys(cores || {}).reduce((acc, key) => {
25
+ acc[camelCase(key)] = new cores[key]({ ...coreContext, context });
26
+ return acc;
27
+ }, {});
28
+ context.gateways = Object.keys(gateways || {}).reduce((acc, key) => {
29
+ acc[camelCase(key)] = new gateways[key]({
30
+ ...gatewayContext,
31
+ context,
32
+ });
33
+ return acc;
34
+ }, {});
35
+ if (check.function(extendContext)) {
36
+ await extendContext({ context, req });
37
+ }
38
+ return context;
39
+ };
40
+ /**
41
+ * Creates default a GraphQL context object with all avilable cores.
42
+ * @returns {object} A context object with all available cores
43
+ */
44
+ export const createContextDefault = async (args) => {
45
+ const { knexConfig, isProduction, logger, doAuth, spaceGw, interserviceApiKey, jwtSecret, verifyTokenArgs, dbType, dbSchema, cores, gateways, req, res, extendContext, getCoreContext, getGatewayContext, authorizationToken, db: inDb, } = args || {};
46
+ const headers = req.headers || { noHeadersSetup: true };
47
+ const cookies = req.cookies || { noCookiesSetup: true };
48
+ const authorization = (headers[HEADERS.AUTHORIZATION] || authorizationToken || '').replace('Bearer ', '');
49
+ const fingerprint = headers[HEADERS.FINGERPRINT] || '';
50
+ const spaceId = headers[HEADERS.SPACE_ID];
51
+ const apiKey = headers[HEADERS.API_KEY];
52
+ const managementApiKey = headers[HEADERS.MANAGEMENT_API_KEY];
53
+ const userAgent = headers[HEADERS.USER_AGENT];
54
+ const referer = headers[HEADERS.REFERER];
55
+ const ipAddress = headers[HEADERS.IP_ADDRESS] || req.connection.remoteAddress;
56
+ const acceptLanguage = headers[HEADERS.ACCEPT_LANGUAGE];
57
+ const languages = extractLanguages(acceptLanguage);
58
+ const requestedLang = headers[HEADERS.REQUESTED_LANGUAGE] || languages?.[0] || 'en';
59
+ // const accountId = headers[HEADERS.ACCOUNT_ID];
60
+ // const roleId = headers[HEADERS.ROLE_ID];
61
+ // const userId = headers[HEADERS.USER_ID];
62
+ const requestId = v4();
63
+ const db = inDb
64
+ ? inDb
65
+ : new Database({
66
+ dbType: dbType || knexConfig.client || '',
67
+ knexConfig,
68
+ dbSchema,
69
+ logger,
70
+ });
71
+ const sharedContext = {
72
+ spaceId,
73
+ apiKey,
74
+ managementApiKey,
75
+ userAgent,
76
+ referer,
77
+ ipAddress,
78
+ acceptLanguage,
79
+ languages,
80
+ requestedLang,
81
+ authorization,
82
+ fingerprint,
83
+ // accountId,
84
+ // roleId,
85
+ // userId,
86
+ req,
87
+ res,
88
+ headers,
89
+ cookies,
90
+ authorizationToken,
91
+ isExternalDb: !!inDb,
92
+ };
93
+ return await createApiContext({
94
+ cores,
95
+ gateways,
96
+ req,
97
+ res,
98
+ requestId,
99
+ extendContext: async ({ context, req }) => {
100
+ context.db = db;
101
+ Object.assign(context, sharedContext);
102
+ if (check.function(extendContext)) {
103
+ await extendContext({ context, req });
104
+ }
105
+ },
106
+ getCoreContext: async (args) => {
107
+ // TODO: const { req } = args;
108
+ let extendCoreConext = {};
109
+ if (check.function(getCoreContext)) {
110
+ extendCoreConext = await getCoreContext(args);
111
+ }
112
+ return {
113
+ db,
114
+ gatewayName: '',
115
+ isProduction,
116
+ logger,
117
+ doAuth,
118
+ spaceGw,
119
+ interserviceApiKey,
120
+ jwtSecret,
121
+ verifyTokenArgs,
122
+ ...(extendCoreConext || {}),
123
+ };
124
+ },
125
+ getGatewayContext: async (args) => {
126
+ let extendGatewayConext = {};
127
+ if (check.function(getGatewayContext)) {
128
+ extendGatewayConext = await getGatewayContext(args);
129
+ }
130
+ return {
131
+ db,
132
+ isProduction,
133
+ logger,
134
+ ...(extendGatewayConext || {}),
135
+ };
136
+ },
137
+ });
138
+ };
@@ -0,0 +1,17 @@
1
+ import { Logger } from '@sdflc/utils';
2
+ /**
3
+ * Base class for REST API controllers.
4
+ */
5
+ declare class BaseController {
6
+ protected onResponse: any;
7
+ protected logger: Logger;
8
+ constructor(props: any);
9
+ init(props: any): void;
10
+ /**
11
+ * Executes an action method and returns result in consistent way.
12
+ * @param method a function to be executed
13
+ * @returns HTTP response
14
+ */
15
+ json(method: any): (req: any, res: any, next: any) => Promise<void>;
16
+ }
17
+ export { BaseController };
@@ -0,0 +1,57 @@
1
+ import check from 'check-types';
2
+ import { OpResult } from '@sdflc/api-helpers';
3
+ import { Logger, LoggerLevels } from '@sdflc/utils';
4
+ /**
5
+ * Base class for REST API controllers.
6
+ */
7
+ class BaseController {
8
+ onResponse;
9
+ logger;
10
+ constructor(props) {
11
+ if (check.function(props?.onResponse)) {
12
+ this.onResponse = props?.onResponse;
13
+ }
14
+ else {
15
+ this.onResponse = () => {
16
+ /* TODO */
17
+ };
18
+ }
19
+ this.logger = props?.logger instanceof Logger ? props.logger : new Logger({ level: LoggerLevels.ERROR });
20
+ }
21
+ init(props) {
22
+ // const { app } = props;
23
+ // set express app routes here:
24
+ // app.post(`${root}/event-webhook`, this.json(this.eventWebhook));
25
+ }
26
+ /**
27
+ * Executes an action method and returns result in consistent way.
28
+ * @param method a function to be executed
29
+ * @returns HTTP response
30
+ */
31
+ json(method) {
32
+ return async (req, res, next) => {
33
+ try {
34
+ const result = await method(req, res, next);
35
+ if (result instanceof OpResult) {
36
+ res.status(result.getHttpStatus()).json(result.toJS());
37
+ }
38
+ else if (result?.redirectUrl) {
39
+ res.redirect(result?.redirectUrl);
40
+ next();
41
+ }
42
+ else if (result) {
43
+ res.status(200).json(result);
44
+ }
45
+ else {
46
+ res.status(204).json(new OpResult());
47
+ }
48
+ await this.onResponse(req, res, next);
49
+ }
50
+ catch (ex) {
51
+ this.logger.log(`An exception has occured when processing REST API request on the entry point '${req.method} ${req.originalUrl}' from ${req.ip}`);
52
+ next(ex);
53
+ }
54
+ };
55
+ }
56
+ }
57
+ export { BaseController };
@@ -0,0 +1,3 @@
1
+ import { OpResult } from '@sdflc/api-helpers';
2
+ export declare const checkArray: (arr: any, validator: any, prefix?: string) => OpResult;
3
+ export declare const createErrorOnCheckError: (checkItResult: any) => OpResult;
@@ -0,0 +1,23 @@
1
+ import { OpResult, OP_RESULT_CODES } from '@sdflc/api-helpers';
2
+ export const checkArray = (arr, validator, prefix) => {
3
+ const result = new OpResult();
4
+ if (!Array.isArray(arr)) {
5
+ return result.addError(prefix || '', 'The value should be an array');
6
+ }
7
+ arr.forEach((item, idx) => {
8
+ const [itemResult] = validator.validateSync(item);
9
+ if (itemResult) {
10
+ Object.keys(itemResult.errors).forEach((key) => {
11
+ result.addError(`${prefix || ''}[${idx}].${key}`, itemResult.errors[key].message);
12
+ });
13
+ }
14
+ });
15
+ return result;
16
+ };
17
+ export const createErrorOnCheckError = (checkItResult) => {
18
+ const result = new OpResult({ code: OP_RESULT_CODES.VALIDATION_FAILED });
19
+ Object.keys(checkItResult.errors).forEach((key) => {
20
+ result.addError(key, checkItResult.errors[key].message);
21
+ });
22
+ return result;
23
+ };
@@ -0,0 +1,17 @@
1
+ import { OpResult } from '@sdflc/api-helpers';
2
+ import { BaseCoreActionsInterface, CommonValidatorArgs } from './interfaces';
3
+ export declare const shouldHaveParams: (args: any) => boolean[] | OpResult[];
4
+ export declare const shouldHaveId: (id: any) => boolean[] | OpResult[];
5
+ export declare const validateSingleIntId: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
6
+ export declare const validateSingleUuidId: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
7
+ export declare const validateSingleTextId: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
8
+ export declare const validateMultipleIntIds: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
9
+ export declare const validateMultipleUuidIds: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
10
+ export declare const validateMultipleTextIds: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
11
+ export declare const validateList: ({ rules }: CommonValidatorArgs) => (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
12
+ export declare const validateGet: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
13
+ export declare const validateRemove: (args: any, opt: BaseCoreActionsInterface) => Promise<{}[] | {}[]>;
14
+ export declare const validateGetMany: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
15
+ export declare const validateRemoveMany: (args: any, opt: BaseCoreActionsInterface) => Promise<OpResult[] | {}[]>;
16
+ export declare const validateCreate: ({ rules }: CommonValidatorArgs) => (args: any, opt: BaseCoreActionsInterface) => Promise<{}[] | {}[]>;
17
+ export declare const validateUpdate: ({ rules }: CommonValidatorArgs) => (args: any, opt: BaseCoreActionsInterface) => Promise<{}[] | {}[]>;
@@ -0,0 +1,291 @@
1
+ import { castArray } from 'lodash';
2
+ import Checkit from 'checkit';
3
+ import check from 'check-types';
4
+ import isUUID from 'is-uuid';
5
+ import { OpResult, OP_RESULT_CODES } from '@sdflc/api-helpers';
6
+ import { createErrorOnCheckError } from './checkItHelpers';
7
+ import { ID_TYPES } from './constants';
8
+ const rulesSingleIntId = new Checkit({
9
+ id: [
10
+ {
11
+ rule: 'required',
12
+ message: 'ID is required',
13
+ },
14
+ {
15
+ rule: 'integer',
16
+ message: 'ID should be an integer',
17
+ },
18
+ ],
19
+ });
20
+ const rulesSingleUuidId = new Checkit({
21
+ id: [
22
+ {
23
+ rule: 'required',
24
+ message: 'ID is required',
25
+ },
26
+ {
27
+ rule: 'uuid',
28
+ message: 'ID should be an integer',
29
+ },
30
+ ],
31
+ });
32
+ const rulesSingleTextId = new Checkit({
33
+ id: [
34
+ {
35
+ rule: 'required',
36
+ message: 'ID is required',
37
+ },
38
+ {
39
+ rule: 'string',
40
+ message: 'ID should be a string',
41
+ },
42
+ ],
43
+ });
44
+ const rulesMultipleIntIds = new Checkit({
45
+ ids: [
46
+ {
47
+ rule: 'required',
48
+ message: 'IDs is required',
49
+ },
50
+ {
51
+ rule: 'array',
52
+ message: 'IDs should be an array of integer',
53
+ },
54
+ {
55
+ rule: (values) => {
56
+ const opResult = new OpResult();
57
+ castArray(values).forEach((value, idx) => {
58
+ if (!check.integer(value)) {
59
+ opResult.addError('ids', `The ids[${idx}] should be an integer`);
60
+ }
61
+ });
62
+ if (opResult.hasErrors()) {
63
+ opResult.setCode(OP_RESULT_CODES.VALIDATION_FAILED);
64
+ throw opResult;
65
+ }
66
+ },
67
+ },
68
+ ],
69
+ });
70
+ const rulesMultipleUuidIds = new Checkit({
71
+ ids: [
72
+ {
73
+ rule: 'required',
74
+ message: 'IDs is required',
75
+ },
76
+ {
77
+ rule: 'array',
78
+ message: 'IDs should be an array of UUIDs',
79
+ },
80
+ {
81
+ rule: (values) => {
82
+ const opResult = new OpResult();
83
+ castArray(values).forEach((value, idx) => {
84
+ if (!isUUID.v4(value)) {
85
+ opResult.addError('ids', `The ids[${idx}] should be a UUID of version 4`);
86
+ }
87
+ });
88
+ if (opResult.hasErrors()) {
89
+ opResult.setCode(OP_RESULT_CODES.VALIDATION_FAILED);
90
+ throw opResult;
91
+ }
92
+ },
93
+ },
94
+ ],
95
+ });
96
+ const rulesMultipleTextIds = new Checkit({
97
+ ids: [
98
+ {
99
+ rule: 'required',
100
+ message: 'IDs is required',
101
+ },
102
+ {
103
+ rule: 'array',
104
+ message: 'IDs should be an array of strings',
105
+ },
106
+ {
107
+ rule: (values) => {
108
+ const opResult = new OpResult();
109
+ castArray(values).forEach((value, idx) => {
110
+ if (!check.string(value)) {
111
+ opResult.addError('ids', `The ids[${idx}] should be a string`);
112
+ }
113
+ });
114
+ if (opResult.hasErrors()) {
115
+ opResult.setCode(OP_RESULT_CODES.VALIDATION_FAILED);
116
+ throw opResult;
117
+ }
118
+ },
119
+ },
120
+ ],
121
+ });
122
+ export const shouldHaveParams = (args) => {
123
+ const keys = Object.keys(args || {});
124
+ if (keys.length === 0) {
125
+ const result = new OpResult({ code: OP_RESULT_CODES.VALIDATION_FAILED });
126
+ result.addError('', 'No params received');
127
+ return [result];
128
+ }
129
+ return [true];
130
+ };
131
+ export const shouldHaveId = (id) => {
132
+ if (!id) {
133
+ const result = new OpResult({ code: OP_RESULT_CODES.VALIDATION_FAILED });
134
+ result.addError('', 'ID is required');
135
+ return [result];
136
+ }
137
+ return [true];
138
+ };
139
+ export const validateSingleIntId = async (args, opt) => {
140
+ const [result] = rulesSingleIntId.validateSync(args);
141
+ if (result) {
142
+ return [createErrorOnCheckError(result)];
143
+ }
144
+ return [true, {}];
145
+ };
146
+ export const validateSingleUuidId = async (args, opt) => {
147
+ const [result] = rulesSingleUuidId.validateSync(args);
148
+ if (result) {
149
+ return [createErrorOnCheckError(result)];
150
+ }
151
+ return [true, {}];
152
+ };
153
+ export const validateSingleTextId = async (args, opt) => {
154
+ const [result] = rulesSingleTextId.validateSync(args);
155
+ if (result) {
156
+ return [createErrorOnCheckError(result)];
157
+ }
158
+ return [true, {}];
159
+ };
160
+ export const validateMultipleIntIds = async (args, opt) => {
161
+ const [result] = rulesMultipleIntIds.validateSync(args);
162
+ if (result) {
163
+ return [createErrorOnCheckError(result)];
164
+ }
165
+ return [true, {}];
166
+ };
167
+ export const validateMultipleUuidIds = async (args, opt) => {
168
+ const [result] = rulesMultipleUuidIds.validateSync(args);
169
+ if (result) {
170
+ return [createErrorOnCheckError(result)];
171
+ }
172
+ return [true, {}];
173
+ };
174
+ export const validateMultipleTextIds = async (args, opt) => {
175
+ const [result] = rulesMultipleTextIds.validateSync(args);
176
+ if (result) {
177
+ return [createErrorOnCheckError(result)];
178
+ }
179
+ return [true, {}];
180
+ };
181
+ export const validateList = ({ rules }) => async (args, opt) => {
182
+ const { filter } = args || {};
183
+ const [result] = rules.validateSync(filter);
184
+ if (result) {
185
+ return [createErrorOnCheckError(result)];
186
+ }
187
+ return [true, {}];
188
+ };
189
+ export const validateGet = async (args, opt) => {
190
+ const idType = opt.core.getIdType();
191
+ let rules = null;
192
+ switch (idType) {
193
+ case ID_TYPES.INT:
194
+ rules = rulesSingleIntId;
195
+ break;
196
+ case ID_TYPES.UUID:
197
+ rules = rulesSingleUuidId;
198
+ break;
199
+ case ID_TYPES.TEXT:
200
+ rules = rulesSingleTextId;
201
+ break;
202
+ }
203
+ if (!rules) {
204
+ return [true, {}];
205
+ }
206
+ const [result] = rules.validateSync(args);
207
+ if (result) {
208
+ return [createErrorOnCheckError(result)];
209
+ }
210
+ return [true, {}];
211
+ };
212
+ export const validateRemove = async (args, opt) => {
213
+ const { where } = args || {};
214
+ const [idCheck] = shouldHaveParams(where);
215
+ if (idCheck !== true) {
216
+ return [idCheck, {}];
217
+ }
218
+ const idType = opt.core.getIdType();
219
+ let rules = null;
220
+ switch (idType) {
221
+ case ID_TYPES.INT:
222
+ rules = rulesSingleIntId;
223
+ break;
224
+ case ID_TYPES.UUID:
225
+ rules = rulesSingleUuidId;
226
+ break;
227
+ case ID_TYPES.TEXT:
228
+ rules = rulesSingleTextId;
229
+ break;
230
+ }
231
+ if (!rules) {
232
+ return [true, {}];
233
+ }
234
+ const [result] = rules.validateSync(where);
235
+ if (result) {
236
+ return [createErrorOnCheckError(result)];
237
+ }
238
+ return [true, {}];
239
+ };
240
+ export const validateGetMany = async (args, opt) => {
241
+ const idType = opt.core.getIdType();
242
+ let rules = null;
243
+ switch (idType) {
244
+ case ID_TYPES.INT:
245
+ rules = rulesMultipleIntIds;
246
+ break;
247
+ case ID_TYPES.UUID:
248
+ rules = rulesMultipleUuidIds;
249
+ break;
250
+ case ID_TYPES.TEXT:
251
+ rules = rulesMultipleTextIds;
252
+ break;
253
+ }
254
+ if (!rules) {
255
+ return [true, {}];
256
+ }
257
+ const [result] = rules.validateSync(args);
258
+ if (result) {
259
+ return [createErrorOnCheckError(result)];
260
+ }
261
+ return [true, {}];
262
+ };
263
+ export const validateRemoveMany = validateGetMany;
264
+ export const validateCreate = ({ rules }) => async (args, opt) => {
265
+ const { params } = args || {};
266
+ const [paramsCheck] = shouldHaveParams(params);
267
+ if (paramsCheck !== true) {
268
+ return [paramsCheck, {}];
269
+ }
270
+ const [result] = rules.validateSync(params);
271
+ if (result) {
272
+ return [createErrorOnCheckError(result), {}];
273
+ }
274
+ return [true, {}];
275
+ };
276
+ export const validateUpdate = ({ rules }) => async (args, opt) => {
277
+ const { where, params } = args || {};
278
+ const [idCheck] = shouldHaveParams(where);
279
+ if (idCheck !== true) {
280
+ return [idCheck, {}];
281
+ }
282
+ const [paramsCheck] = shouldHaveParams(params);
283
+ if (paramsCheck !== true) {
284
+ return [paramsCheck, {}];
285
+ }
286
+ const [result] = rules.validateSync(params);
287
+ if (result) {
288
+ return [createErrorOnCheckError(result), {}];
289
+ }
290
+ return [true, {}];
291
+ };
@@ -0,0 +1,2 @@
1
+ import { BuildConfigOptions } from './interfaces';
2
+ export declare const buildConfig: (dirName: string, opt?: BuildConfigOptions) => any;
@@ -0,0 +1,32 @@
1
+ import { camelCase } from 'lodash';
2
+ import { join, resolve } from 'path';
3
+ import { config } from 'dotenv-safe';
4
+ export const buildConfig = (dirName, opt) => {
5
+ const opt2use = opt || {};
6
+ config({
7
+ path: resolve(dirName, opt2use.envFile || '.env'),
8
+ allowEmptyValues: opt2use.allowEmptyValues != null ? opt2use.allowEmptyValues : true,
9
+ example: join(dirName, opt2use.envFileExample || '.env.example'),
10
+ });
11
+ const env = Object.assign({ NODE_ENV: opt2use.defaultNodeEnv || 'development' }, process.env);
12
+ /**
13
+ * Creates an application settings consisting of environment variables
14
+ */
15
+ const envVars = Object.keys(env).reduce((acc, key) => {
16
+ let value = env[key];
17
+ const tryValue = (value || '').toLowerCase();
18
+ if (tryValue === 'false') {
19
+ value = false;
20
+ }
21
+ else if (tryValue === 'true') {
22
+ value = true;
23
+ }
24
+ acc[camelCase(key)] = value;
25
+ return acc;
26
+ }, {});
27
+ return {
28
+ ...envVars,
29
+ nodeEnv: env.NODE_ENV,
30
+ isProduction: env.NODE_ENV === 'production',
31
+ };
32
+ };
@@ -0,0 +1,30 @@
1
+ declare const FIELDS: any;
2
+ declare const ORDER_BYS: {
3
+ ASC: string;
4
+ DESC: string;
5
+ };
6
+ declare const HEADERS: any;
7
+ declare enum ID_TYPES {
8
+ UNKNOWN = 0,
9
+ INT = 1,
10
+ UUID = 2,
11
+ TEXT = 3
12
+ }
13
+ declare const ID_FIELD: any;
14
+ declare const DEFAULT_ORDER_NO = "10000000";
15
+ declare const DEFAULT_ORDER_NO_STEP = "1000";
16
+ declare const DEFAULT_JWT_ALGORITHM = "HS256";
17
+ declare const DEFAULT_JWT_ISSUER = "microservices-auth";
18
+ declare const ACTIONS: {
19
+ LIST: string;
20
+ GET: string;
21
+ GET_MANY: string;
22
+ CREATE: string;
23
+ CREATE_MANY: string;
24
+ UPDATE: string;
25
+ UPDATE_MANY: string;
26
+ SET: string;
27
+ REMOVE: string;
28
+ REMOVE_MANY: string;
29
+ };
30
+ export { ID_FIELD, FIELDS, ORDER_BYS, HEADERS, DEFAULT_ORDER_NO, DEFAULT_ORDER_NO_STEP, ID_TYPES, DEFAULT_JWT_ALGORITHM, DEFAULT_JWT_ISSUER, ACTIONS, };
@@ -0,0 +1,69 @@
1
+ const FIELDS = {
2
+ ID: 'id',
3
+ STATUS: 'status',
4
+ VERSION: 'version',
5
+ CREATED_BY: 'created_by',
6
+ UPDATED_BY: 'updated_by',
7
+ REMOVED_BY: 'removed_by',
8
+ CREATED_AT: 'created_at',
9
+ UPDATED_AT: 'updated_at',
10
+ REMOVED_AT: 'removed_at',
11
+ REMOVED_AT_STR: 'removed_at_str',
12
+ LANG: 'LANG',
13
+ ACCOUNT_ID: 'account_id',
14
+ ROLE_ID: 'role_id',
15
+ USER_ID: 'user_id',
16
+ ORDER_NO: 'order_no',
17
+ SPACE_ID: 'space_id',
18
+ DISPLAY_NAME: 'display_name',
19
+ NAME: 'name',
20
+ USERNAME: 'username',
21
+ EMAIL: 'email',
22
+ PHONE: 'phone',
23
+ };
24
+ const ORDER_BYS = {
25
+ ASC: 'asc',
26
+ DESC: 'desc',
27
+ };
28
+ const HEADERS = {
29
+ AUTHORIZATION: 'authorization',
30
+ FINGERPRINT: 'x-fingerprint',
31
+ SPACE_ID: 'x-space-id',
32
+ API_KEY: 'x-api-key',
33
+ MANAGEMENT_API_KEY: 'x-management-api-key',
34
+ ACCOUNT_ID: 'x-account-id',
35
+ ROLE_ID: 'x-role-id',
36
+ USER_ID: 'x-user-id',
37
+ USER_AGENT: 'user-agent',
38
+ REFERER: 'referer',
39
+ IP_ADDRESS: 'x-forwarded-for',
40
+ ACCEPT_LANGUAGE: 'accept-language',
41
+ REQUESTED_LANGUAGE: 'x-lang',
42
+ CONTENT_TYPE: 'content-type',
43
+ CONTENT_LENGTH: 'content-length',
44
+ };
45
+ var ID_TYPES;
46
+ (function (ID_TYPES) {
47
+ ID_TYPES[ID_TYPES["UNKNOWN"] = 0] = "UNKNOWN";
48
+ ID_TYPES[ID_TYPES["INT"] = 1] = "INT";
49
+ ID_TYPES[ID_TYPES["UUID"] = 2] = "UUID";
50
+ ID_TYPES[ID_TYPES["TEXT"] = 3] = "TEXT";
51
+ })(ID_TYPES || (ID_TYPES = {}));
52
+ const ID_FIELD = FIELDS.ID;
53
+ const DEFAULT_ORDER_NO = '10000000';
54
+ const DEFAULT_ORDER_NO_STEP = '1000';
55
+ const DEFAULT_JWT_ALGORITHM = 'HS256';
56
+ const DEFAULT_JWT_ISSUER = 'microservices-auth';
57
+ const ACTIONS = {
58
+ LIST: 'LIST',
59
+ GET: 'GET',
60
+ GET_MANY: 'GET_MANY',
61
+ CREATE: 'CREATE',
62
+ CREATE_MANY: 'CREATE_MANY',
63
+ UPDATE: 'UPDATE',
64
+ UPDATE_MANY: 'UPDATE_MANY',
65
+ SET: 'SET',
66
+ REMOVE: 'REMOVE',
67
+ REMOVE_MANY: 'REMOVE_MANY',
68
+ };
69
+ export { ID_FIELD, FIELDS, ORDER_BYS, HEADERS, DEFAULT_ORDER_NO, DEFAULT_ORDER_NO_STEP, ID_TYPES, DEFAULT_JWT_ALGORITHM, DEFAULT_JWT_ISSUER, ACTIONS, };