@sdflc/backend-helpers 1.0.112 → 1.0.114
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.
- package/README.md +1422 -146
- package/build/BaseController.d.ts +20 -0
- package/build/BaseController.js +64 -0
- package/build/BaseCore.d.ts +586 -33
- package/build/BaseCore.js +821 -127
- package/build/BaseExternalApiGateway.d.ts +16 -0
- package/build/BaseExternalApiGateway.js +54 -0
- package/build/BaseGateway.d.ts +455 -17
- package/build/BaseGateway.js +502 -56
- package/build/BaseRestApiCrudController.d.ts +37 -0
- package/build/BaseRestApiCrudController.js +134 -0
- package/build/DataCache.d.ts +116 -5
- package/build/DataCache.js +144 -22
- package/build/Database.d.ts +165 -4
- package/build/Database.js +224 -51
- package/build/DbMigratorAndSeeder.d.ts +127 -26
- package/build/DbMigratorAndSeeder.js +180 -69
- package/build/IpRateLimiter.d.ts +105 -0
- package/build/IpRateLimiter.js +104 -0
- package/build/RedisDataLoader.d.ts +144 -21
- package/build/RedisDataLoader.js +178 -49
- package/build/apiContext.d.ts +0 -8
- package/build/apiContext.js +30 -32
- package/build/checkItHelpers.d.ts +32 -0
- package/build/checkItHelpers.js +73 -7
- package/build/commonValidators.d.ts +107 -16
- package/build/commonValidators.js +211 -106
- package/build/configBuilder.d.ts +23 -0
- package/build/configBuilder.js +73 -0
- package/build/constants.d.ts +134 -17
- package/build/constants.js +95 -15
- package/build/dbHelpers.d.ts +89 -29
- package/build/dbHelpers.js +175 -86
- package/build/dbSeeder.d.ts +10 -1
- package/build/dbSeeder.js +80 -15
- package/build/dbTableHelpers.d.ts +122 -5
- package/build/dbTableHelpers.js +151 -13
- package/build/downloadHelpers.d.ts +24 -1
- package/build/downloadHelpers.js +51 -21
- package/build/esm/BaseController.d.ts +20 -0
- package/build/esm/BaseController.js +58 -0
- package/build/esm/BaseCore.d.ts +586 -33
- package/build/esm/BaseCore.js +812 -118
- package/build/esm/BaseExternalApiGateway.d.ts +16 -0
- package/build/esm/BaseExternalApiGateway.js +48 -0
- package/build/esm/BaseGateway.d.ts +455 -17
- package/build/esm/BaseGateway.js +503 -57
- package/build/esm/BaseRestApiCrudController.d.ts +37 -0
- package/build/esm/BaseRestApiCrudController.js +131 -0
- package/build/esm/DataCache.d.ts +116 -5
- package/build/esm/DataCache.js +142 -20
- package/build/esm/Database.d.ts +165 -4
- package/build/esm/Database.js +224 -51
- package/build/esm/DbMigratorAndSeeder.d.ts +127 -26
- package/build/esm/DbMigratorAndSeeder.js +184 -71
- package/build/esm/IpRateLimiter.d.ts +105 -0
- package/build/esm/IpRateLimiter.js +100 -0
- package/build/esm/RedisDataLoader.d.ts +144 -21
- package/build/esm/RedisDataLoader.js +179 -50
- package/build/esm/apiContext.d.ts +0 -8
- package/build/esm/apiContext.js +30 -32
- package/build/esm/checkItHelpers.d.ts +32 -0
- package/build/esm/checkItHelpers.js +73 -7
- package/build/esm/commonValidators.d.ts +107 -16
- package/build/esm/commonValidators.js +209 -105
- package/build/esm/configBuilder.d.ts +23 -0
- package/build/esm/configBuilder.js +69 -0
- package/build/esm/constants.d.ts +134 -17
- package/build/esm/constants.js +94 -14
- package/build/esm/dbHelpers.d.ts +89 -29
- package/build/esm/dbHelpers.js +171 -81
- package/build/esm/dbSeeder.d.ts +10 -1
- package/build/esm/dbSeeder.js +81 -16
- package/build/esm/dbTableHelpers.d.ts +122 -5
- package/build/esm/dbTableHelpers.js +152 -14
- package/build/esm/downloadHelpers.d.ts +24 -1
- package/build/esm/downloadHelpers.js +51 -21
- package/build/esm/index.d.ts +6 -2
- package/build/esm/index.js +6 -2
- package/build/esm/interfaces/ApiContext.d.ts +33 -3
- package/build/esm/interfaces/ApiContext.js +1 -0
- package/build/esm/interfaces/ApiContextInterface.d.ts +1 -1
- package/build/esm/interfaces/BaseControllerPropsInterface.d.ts +5 -0
- package/build/esm/interfaces/BaseControllerPropsInterface.js +1 -0
- package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +1 -0
- package/build/esm/interfaces/BaseCoreDoingWhatInterface.d.ts +11 -11
- package/build/esm/interfaces/BaseCorePropsInterface.d.ts +146 -9
- package/build/esm/interfaces/BaseCorePropsInterface.js +1 -0
- package/build/esm/interfaces/BaseExternalApiGatewayPropsInterface.d.ts +19 -0
- package/build/esm/interfaces/BaseExternalApiGatewayPropsInterface.js +2 -0
- package/build/esm/interfaces/BaseGatewayPropsInterface.d.ts +78 -3
- package/build/esm/interfaces/BaseGatewayPropsInterface.js +1 -0
- package/build/esm/interfaces/BaseRestApiCrudControllerPropsInterface.d.ts +28 -0
- package/build/esm/interfaces/BaseRestApiCrudControllerPropsInterface.js +2 -0
- package/build/esm/interfaces/BuildConfigOptions.d.ts +18 -0
- package/build/esm/interfaces/BuildConfigOptions.js +1 -0
- package/build/esm/interfaces/BuildListQueryArgsInterface.d.ts +22 -4
- package/build/esm/interfaces/BuildListQueryArgsInterface.js +1 -0
- package/build/esm/interfaces/CacheInterface.d.ts +18 -1
- package/build/esm/interfaces/CacheInterface.js +1 -0
- package/build/esm/interfaces/CoreActionInterface.d.ts +60 -0
- package/build/esm/interfaces/CoreActionInterface.js +1 -0
- package/build/esm/interfaces/CreateUserTokenArgs.d.ts +38 -4
- package/build/esm/interfaces/CreateUserTokenArgs.js +1 -0
- package/build/esm/interfaces/DataCachePropsInterface.d.ts +21 -0
- package/build/esm/interfaces/DataCachePropsInterface.js +2 -0
- package/build/esm/interfaces/DatabaseOptions.d.ts +24 -10
- package/build/esm/interfaces/DatabaseOptions.js +1 -0
- package/build/esm/interfaces/DatabaseReadInterface.d.ts +58 -3
- package/build/esm/interfaces/DatabaseReadInterface.js +1 -0
- package/build/esm/interfaces/DbFieldAddDefaultInterface.d.ts +35 -4
- package/build/esm/interfaces/DbFieldAddDefaultInterface.js +1 -0
- package/build/esm/interfaces/DownloadFileArgs.d.ts +21 -2
- package/build/esm/interfaces/ExtractCredentialsArgs.d.ts +15 -4
- package/build/esm/interfaces/ExtractCredentialsArgs.js +1 -0
- package/build/esm/interfaces/ListArgsInterface.d.ts +18 -0
- package/build/esm/interfaces/ListArgsInterface.js +1 -0
- package/build/esm/interfaces/LoaderInterface.d.ts +36 -1
- package/build/esm/interfaces/LoaderInterface.js +1 -0
- package/build/esm/interfaces/UserTokenParams.d.ts +23 -5
- package/build/esm/interfaces/UserTokenParams.js +1 -0
- package/build/esm/interfaces/VerifyUserTokenArgs.d.ts +42 -2
- package/build/esm/interfaces/VerifyUserTokenArgs.js +1 -0
- package/build/esm/interfaces/index.d.ts +4 -0
- package/build/esm/interfaces/index.js +4 -0
- package/build/esm/knexConfigBuilder.d.ts +25 -0
- package/build/esm/knexConfigBuilder.js +100 -36
- package/build/esm/parseIds.d.ts +6 -0
- package/build/esm/parseIds.js +13 -0
- package/build/esm/passwordHelpers.d.ts +22 -0
- package/build/esm/passwordHelpers.js +40 -8
- package/build/esm/redisClient.d.ts +57 -4
- package/build/esm/redisClient.js +40 -54
- package/build/esm/resolveClientIp.d.ts +15 -0
- package/build/esm/resolveClientIp.js +34 -0
- package/build/esm/resolversHelpers.d.ts +21 -1
- package/build/esm/resolversHelpers.js +48 -26
- package/build/esm/userToken.d.ts +50 -1
- package/build/esm/userToken.js +85 -20
- package/build/esm/utils.d.ts +20 -2
- package/build/esm/utils.js +23 -13
- package/build/index.d.ts +6 -2
- package/build/index.js +6 -2
- package/build/interfaces/ApiContext.d.ts +33 -3
- package/build/interfaces/ApiContext.js +1 -0
- package/build/interfaces/ApiContextInterface.d.ts +1 -1
- package/build/interfaces/BaseControllerPropsInterface.d.ts +5 -0
- package/build/interfaces/BaseControllerPropsInterface.js +2 -0
- package/build/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +1 -0
- package/build/interfaces/BaseCoreDoingWhatInterface.d.ts +11 -11
- package/build/interfaces/BaseCorePropsInterface.d.ts +146 -9
- package/build/interfaces/BaseCorePropsInterface.js +1 -0
- package/build/interfaces/BaseExternalApiGatewayPropsInterface.d.ts +19 -0
- package/build/interfaces/BaseExternalApiGatewayPropsInterface.js +3 -0
- package/build/interfaces/BaseGatewayPropsInterface.d.ts +78 -3
- package/build/interfaces/BaseGatewayPropsInterface.js +1 -0
- package/build/interfaces/BaseRestApiCrudControllerPropsInterface.d.ts +28 -0
- package/build/interfaces/BaseRestApiCrudControllerPropsInterface.js +3 -0
- package/build/interfaces/BuildConfigOptions.d.ts +18 -0
- package/build/interfaces/BuildConfigOptions.js +1 -0
- package/build/interfaces/BuildListQueryArgsInterface.d.ts +22 -4
- package/build/interfaces/BuildListQueryArgsInterface.js +1 -0
- package/build/interfaces/CacheInterface.d.ts +18 -1
- package/build/interfaces/CacheInterface.js +1 -0
- package/build/interfaces/CoreActionInterface.d.ts +60 -0
- package/build/interfaces/CoreActionInterface.js +1 -0
- package/build/interfaces/CreateUserTokenArgs.d.ts +38 -4
- package/build/interfaces/CreateUserTokenArgs.js +1 -0
- package/build/interfaces/DataCachePropsInterface.d.ts +21 -0
- package/build/interfaces/DataCachePropsInterface.js +3 -0
- package/build/interfaces/DatabaseOptions.d.ts +24 -10
- package/build/interfaces/DatabaseOptions.js +1 -0
- package/build/interfaces/DatabaseReadInterface.d.ts +58 -3
- package/build/interfaces/DatabaseReadInterface.js +1 -0
- package/build/interfaces/DbFieldAddDefaultInterface.d.ts +35 -4
- package/build/interfaces/DbFieldAddDefaultInterface.js +1 -0
- package/build/interfaces/DownloadFileArgs.d.ts +21 -2
- package/build/interfaces/ExtractCredentialsArgs.d.ts +15 -4
- package/build/interfaces/ExtractCredentialsArgs.js +1 -0
- package/build/interfaces/ListArgsInterface.d.ts +18 -0
- package/build/interfaces/ListArgsInterface.js +1 -0
- package/build/interfaces/LoaderInterface.d.ts +36 -1
- package/build/interfaces/LoaderInterface.js +1 -0
- package/build/interfaces/UserTokenParams.d.ts +23 -5
- package/build/interfaces/UserTokenParams.js +1 -0
- package/build/interfaces/VerifyUserTokenArgs.d.ts +42 -2
- package/build/interfaces/VerifyUserTokenArgs.js +1 -0
- package/build/interfaces/index.d.ts +4 -0
- package/build/interfaces/index.js +4 -0
- package/build/knexConfigBuilder.d.ts +25 -0
- package/build/knexConfigBuilder.js +99 -35
- package/build/parseIds.d.ts +6 -0
- package/build/parseIds.js +17 -0
- package/build/passwordHelpers.d.ts +22 -0
- package/build/passwordHelpers.js +40 -8
- package/build/redisClient.d.ts +57 -4
- package/build/redisClient.js +40 -54
- package/build/resolveClientIp.d.ts +15 -0
- package/build/resolveClientIp.js +38 -0
- package/build/resolversHelpers.d.ts +21 -1
- package/build/resolversHelpers.js +48 -26
- package/build/userToken.d.ts +50 -1
- package/build/userToken.js +85 -20
- package/build/utils.d.ts +20 -2
- package/build/utils.js +24 -16
- package/package.json +19 -18
- package/build/baseController.d.ts +0 -17
- package/build/baseController.js +0 -64
- package/build/configBulder.d.ts +0 -2
- package/build/configBulder.js +0 -36
- package/build/esm/baseController.d.ts +0 -17
- package/build/esm/baseController.js +0 -58
- package/build/esm/configBulder.d.ts +0 -2
- package/build/esm/configBulder.js +0 -32
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sdflc/backend-helpers",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.114",
|
|
4
4
|
"description": "Set of helper functions and classes to simplify building backend apps within @sdflc ecosystem",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"exports": {
|
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
"author": "Sergey Demidenko",
|
|
32
32
|
"license": "ISC",
|
|
33
33
|
"devDependencies": {
|
|
34
|
+
"@eslint/js": "^10.0.1",
|
|
34
35
|
"@types/bcrypt": "^6.0.0",
|
|
35
36
|
"@types/bluebird": "^3.5.42",
|
|
36
37
|
"@types/check-types": "^11.2.2",
|
|
@@ -38,41 +39,41 @@
|
|
|
38
39
|
"@types/is-uuid": "^1.0.2",
|
|
39
40
|
"@types/jest": "^30.0.0",
|
|
40
41
|
"@types/jsonwebtoken": "^9.0.10",
|
|
41
|
-
"@types/lodash": "^4.17.
|
|
42
|
-
"@types/node": "^25.
|
|
42
|
+
"@types/lodash": "^4.17.24",
|
|
43
|
+
"@types/node": "^25.5.0",
|
|
43
44
|
"@types/uuid": "^10.0.0",
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
45
|
-
"@typescript-eslint/parser": "^8.
|
|
46
|
-
"eslint": "^
|
|
45
|
+
"@typescript-eslint/eslint-plugin": "^8.57.2",
|
|
46
|
+
"@typescript-eslint/parser": "^8.57.2",
|
|
47
|
+
"eslint": "^10.1.0",
|
|
47
48
|
"eslint-config-prettier": "^10.1.8",
|
|
48
|
-
"eslint-plugin-jest": "^29.
|
|
49
|
-
"eslint-plugin-prettier": "^5.5.
|
|
49
|
+
"eslint-plugin-jest": "^29.15.1",
|
|
50
|
+
"eslint-plugin-prettier": "^5.5.5",
|
|
50
51
|
"husky": "^9.1.7",
|
|
51
|
-
"jest": "^30.
|
|
52
|
-
"prettier": "^3.
|
|
53
|
-
"rimraf": "^6.1.
|
|
52
|
+
"jest": "^30.3.0",
|
|
53
|
+
"prettier": "^3.8.1",
|
|
54
|
+
"rimraf": "^6.1.3",
|
|
54
55
|
"run-script-os": "^1.1.6",
|
|
55
56
|
"ts-jest": "^29.4.6",
|
|
56
57
|
"ts-node": "^10.9.2",
|
|
57
58
|
"typescript": "^5.9.3"
|
|
58
59
|
},
|
|
59
60
|
"dependencies": {
|
|
60
|
-
"@sdflc/api-helpers": "^1.1.
|
|
61
|
-
"@sdflc/utils": "^1.0.
|
|
61
|
+
"@sdflc/api-helpers": "^1.1.16",
|
|
62
|
+
"@sdflc/utils": "^1.0.28",
|
|
62
63
|
"bcrypt": "^6.0.0",
|
|
63
64
|
"bluebird": "^3.7.2",
|
|
64
65
|
"check-types": "^11.2.3",
|
|
65
66
|
"checkit": "^0.7.0",
|
|
66
67
|
"dataloader": "^2.2.3",
|
|
67
|
-
"dayjs": "^1.11.
|
|
68
|
+
"dayjs": "^1.11.20",
|
|
68
69
|
"dotenv-safe": "^9.1.0",
|
|
69
70
|
"is-uuid": "^1.0.2",
|
|
70
71
|
"json-stable-stringify": "^1.3.0",
|
|
71
72
|
"jsonwebtoken": "^9.0.3",
|
|
72
|
-
"knex": "^3.
|
|
73
|
-
"lodash": "^4.17.
|
|
74
|
-
"pg": "^8.
|
|
75
|
-
"redis": "^5.
|
|
73
|
+
"knex": "^3.2.6",
|
|
74
|
+
"lodash": "^4.17.23",
|
|
75
|
+
"pg": "^8.20.0",
|
|
76
|
+
"redis": "^5.11.0",
|
|
76
77
|
"uuid": "^13.0.0"
|
|
77
78
|
}
|
|
78
79
|
}
|
|
@@ -1,17 +0,0 @@
|
|
|
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 };
|
package/build/baseController.js
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.BaseController = void 0;
|
|
7
|
-
const check_types_1 = __importDefault(require("check-types"));
|
|
8
|
-
const api_helpers_1 = require("@sdflc/api-helpers");
|
|
9
|
-
const utils_1 = require("@sdflc/utils");
|
|
10
|
-
const utils_2 = require("./utils");
|
|
11
|
-
/**
|
|
12
|
-
* Base class for REST API controllers.
|
|
13
|
-
*/
|
|
14
|
-
class BaseController {
|
|
15
|
-
onResponse;
|
|
16
|
-
logger;
|
|
17
|
-
constructor(props) {
|
|
18
|
-
if (check_types_1.default.function(props?.onResponse)) {
|
|
19
|
-
this.onResponse = props?.onResponse;
|
|
20
|
-
}
|
|
21
|
-
else {
|
|
22
|
-
this.onResponse = () => {
|
|
23
|
-
/* TODO */
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
|
-
this.logger = props?.logger instanceof utils_1.Logger ? props.logger : new utils_1.Logger({ level: utils_1.LoggerLevels.ERROR });
|
|
27
|
-
}
|
|
28
|
-
init(props) {
|
|
29
|
-
// const { app } = props;
|
|
30
|
-
// set express app routes here:
|
|
31
|
-
// app.post(`${root}/event-webhook`, this.json(this.eventWebhook));
|
|
32
|
-
}
|
|
33
|
-
/**
|
|
34
|
-
* Executes an action method and returns result in consistent way.
|
|
35
|
-
* @param method a function to be executed
|
|
36
|
-
* @returns HTTP response
|
|
37
|
-
*/
|
|
38
|
-
json(method) {
|
|
39
|
-
return async (req, res, next) => {
|
|
40
|
-
try {
|
|
41
|
-
const result = await method(req, res, next);
|
|
42
|
-
if ((0, utils_2.isOpResult)(result)) {
|
|
43
|
-
res.status(result.getHttpStatus()).json(result.toJS());
|
|
44
|
-
}
|
|
45
|
-
else if (result?.redirectUrl) {
|
|
46
|
-
res.redirect(result?.redirectUrl);
|
|
47
|
-
next();
|
|
48
|
-
}
|
|
49
|
-
else if (result) {
|
|
50
|
-
res.status(200).json(result);
|
|
51
|
-
}
|
|
52
|
-
else {
|
|
53
|
-
res.status(204).json(new api_helpers_1.OpResult());
|
|
54
|
-
}
|
|
55
|
-
await this.onResponse(req, res, next);
|
|
56
|
-
}
|
|
57
|
-
catch (ex) {
|
|
58
|
-
this.logger.log(`An exception has occured when processing REST API request on the entry point '${req.method} ${req.originalUrl}' from ${req.ip}`);
|
|
59
|
-
next(ex);
|
|
60
|
-
}
|
|
61
|
-
};
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
exports.BaseController = BaseController;
|
package/build/configBulder.d.ts
DELETED
package/build/configBulder.js
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.buildConfig = void 0;
|
|
4
|
-
const lodash_1 = require("lodash");
|
|
5
|
-
const path_1 = require("path");
|
|
6
|
-
const dotenv_safe_1 = require("dotenv-safe");
|
|
7
|
-
const buildConfig = (dirName, opt) => {
|
|
8
|
-
const opt2use = opt || {};
|
|
9
|
-
(0, dotenv_safe_1.config)({
|
|
10
|
-
path: (0, path_1.resolve)(dirName, opt2use.envFile || '.env'),
|
|
11
|
-
allowEmptyValues: opt2use.allowEmptyValues != null ? opt2use.allowEmptyValues : true,
|
|
12
|
-
example: (0, path_1.join)(dirName, opt2use.envFileExample || '.env.example'),
|
|
13
|
-
});
|
|
14
|
-
const env = Object.assign({ NODE_ENV: opt2use.defaultNodeEnv || 'development' }, process.env);
|
|
15
|
-
/**
|
|
16
|
-
* Creates an application settings consisting of environment variables
|
|
17
|
-
*/
|
|
18
|
-
const envVars = Object.keys(env).reduce((acc, key) => {
|
|
19
|
-
let value = env[key];
|
|
20
|
-
const tryValue = (value || '').toLowerCase();
|
|
21
|
-
if (tryValue === 'false') {
|
|
22
|
-
value = false;
|
|
23
|
-
}
|
|
24
|
-
else if (tryValue === 'true') {
|
|
25
|
-
value = true;
|
|
26
|
-
}
|
|
27
|
-
acc[(0, lodash_1.camelCase)(key)] = value;
|
|
28
|
-
return acc;
|
|
29
|
-
}, {});
|
|
30
|
-
return {
|
|
31
|
-
...envVars,
|
|
32
|
-
nodeEnv: env.NODE_ENV,
|
|
33
|
-
isProduction: env.NODE_ENV === 'production',
|
|
34
|
-
};
|
|
35
|
-
};
|
|
36
|
-
exports.buildConfig = buildConfig;
|
|
@@ -1,17 +0,0 @@
|
|
|
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 };
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import check from 'check-types';
|
|
2
|
-
import { OpResult } from '@sdflc/api-helpers';
|
|
3
|
-
import { Logger, LoggerLevels } from '@sdflc/utils';
|
|
4
|
-
import { isOpResult } from './utils';
|
|
5
|
-
/**
|
|
6
|
-
* Base class for REST API controllers.
|
|
7
|
-
*/
|
|
8
|
-
class BaseController {
|
|
9
|
-
onResponse;
|
|
10
|
-
logger;
|
|
11
|
-
constructor(props) {
|
|
12
|
-
if (check.function(props?.onResponse)) {
|
|
13
|
-
this.onResponse = props?.onResponse;
|
|
14
|
-
}
|
|
15
|
-
else {
|
|
16
|
-
this.onResponse = () => {
|
|
17
|
-
/* TODO */
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
this.logger = props?.logger instanceof Logger ? props.logger : new Logger({ level: LoggerLevels.ERROR });
|
|
21
|
-
}
|
|
22
|
-
init(props) {
|
|
23
|
-
// const { app } = props;
|
|
24
|
-
// set express app routes here:
|
|
25
|
-
// app.post(`${root}/event-webhook`, this.json(this.eventWebhook));
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* Executes an action method and returns result in consistent way.
|
|
29
|
-
* @param method a function to be executed
|
|
30
|
-
* @returns HTTP response
|
|
31
|
-
*/
|
|
32
|
-
json(method) {
|
|
33
|
-
return async (req, res, next) => {
|
|
34
|
-
try {
|
|
35
|
-
const result = await method(req, res, next);
|
|
36
|
-
if (isOpResult(result)) {
|
|
37
|
-
res.status(result.getHttpStatus()).json(result.toJS());
|
|
38
|
-
}
|
|
39
|
-
else if (result?.redirectUrl) {
|
|
40
|
-
res.redirect(result?.redirectUrl);
|
|
41
|
-
next();
|
|
42
|
-
}
|
|
43
|
-
else if (result) {
|
|
44
|
-
res.status(200).json(result);
|
|
45
|
-
}
|
|
46
|
-
else {
|
|
47
|
-
res.status(204).json(new OpResult());
|
|
48
|
-
}
|
|
49
|
-
await this.onResponse(req, res, next);
|
|
50
|
-
}
|
|
51
|
-
catch (ex) {
|
|
52
|
-
this.logger.log(`An exception has occured when processing REST API request on the entry point '${req.method} ${req.originalUrl}' from ${req.ip}`);
|
|
53
|
-
next(ex);
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
export { BaseController };
|
|
@@ -1,32 +0,0 @@
|
|
|
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
|
-
};
|