@sdflc/backend-helpers 1.0.25 → 1.0.28
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 +175 -0
- package/build/{baseController.d.ts → BaseController.d.ts} +0 -0
- package/build/{baseController.js → BaseController.js} +0 -0
- package/build/{baseCore.d.ts → BaseCore.d.ts} +13 -19
- package/build/{baseCore.js → BaseCore.js} +115 -157
- package/build/{baseGateway.d.ts → BaseGateway.d.ts} +15 -11
- package/build/{baseGateway.js → BaseGateway.js} +148 -97
- package/build/{dataCache.d.ts → DataCache.d.ts} +0 -0
- package/build/{dataCache.js → DataCache.js} +2 -2
- package/build/{database.d.ts → Database.d.ts} +0 -0
- package/build/{database.js → Database.js} +0 -0
- package/build/{dbMigratorAndSeeder.d.ts → DbMigratorAndSeeder.d.ts} +0 -0
- package/build/{dbMigratorAndSeeder.js → DbMigratorAndSeeder.js} +5 -1
- package/build/apiContext.d.ts +3 -3
- package/build/apiContext.js +89 -32
- package/build/constants.d.ts +4 -5
- package/build/constants.js +23 -4
- package/build/dbSeeder.js +5 -1
- package/build/dbTableHelpers.d.ts +2 -0
- package/build/dbTableHelpers.js +48 -27
- package/build/index.d.ts +9 -11
- package/build/index.js +19 -20
- package/build/interfaces/ApiContext.d.ts +23 -0
- package/build/interfaces/{BaseCoreInterface.js → ApiContext.js} +0 -0
- package/build/interfaces/ApiContextInterface.d.ts +5 -1
- package/build/interfaces/BaseCorePropsInterface.d.ts +31 -0
- package/build/interfaces/{BaseGatewayInterface.js → BaseCorePropsInterface.js} +0 -0
- package/build/interfaces/BaseGatewayPropsInterface.d.ts +29 -0
- package/build/interfaces/BaseGatewayPropsInterface.js +2 -0
- package/build/interfaces/CacheInterface.d.ts +3 -3
- package/build/interfaces/CoreActionInterface.d.ts +1 -1
- package/build/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
- package/build/interfaces/JwtTokenSecretAndSettings.js +2 -0
- package/build/interfaces/index.d.ts +4 -2
- package/build/resolversHelpers.js +11 -10
- package/build/userToken.js +3 -3
- package/package.json +68 -68
- package/build/baseGatewayHelpers.d.ts +0 -20
- package/build/baseGatewayHelpers.js +0 -87
- package/build/interfaces/BaseCoreInterface.d.ts +0 -43
- package/build/interfaces/BaseGatewayInterface.d.ts +0 -26
package/build/apiContext.js
CHANGED
|
@@ -51,40 +51,59 @@ exports.createContextDefault = exports.createApiContext = void 0;
|
|
|
51
51
|
var lodash_1 = require("lodash");
|
|
52
52
|
var uuid_1 = require("uuid");
|
|
53
53
|
var utils_1 = require("@sdflc/utils");
|
|
54
|
-
var
|
|
54
|
+
var Database_1 = require("./Database");
|
|
55
|
+
var constants_1 = require("./constants");
|
|
55
56
|
/**
|
|
56
57
|
* Creates a GraphQL context object with all available cores.
|
|
57
58
|
* @returns {object} A context object with all available cores
|
|
58
59
|
*/
|
|
59
60
|
var createApiContext = function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
60
|
-
var _a, cores, req, getCoreContext, extendContext, inRequestId,
|
|
61
|
-
return __generator(this, function (
|
|
62
|
-
switch (
|
|
61
|
+
var _a, cores, gateways, req, getCoreContext, getGatewayContext, extendContext, inRequestId, requestId, coreContext, _b, gatewayContext, _c, context;
|
|
62
|
+
return __generator(this, function (_d) {
|
|
63
|
+
switch (_d.label) {
|
|
63
64
|
case 0:
|
|
64
|
-
_a = args || {}, cores = _a.cores, req = _a.req, getCoreContext = _a.getCoreContext, extendContext = _a.extendContext, inRequestId = _a.requestId;
|
|
65
|
-
keys = Object.keys(cores || {});
|
|
65
|
+
_a = args || {}, cores = _a.cores, gateways = _a.gateways, req = _a.req, getCoreContext = _a.getCoreContext, getGatewayContext = _a.getGatewayContext, extendContext = _a.extendContext, inRequestId = _a.requestId;
|
|
66
66
|
requestId = inRequestId || (0, uuid_1.v4)();
|
|
67
67
|
if (!(typeof getCoreContext === 'function')) return [3 /*break*/, 2];
|
|
68
68
|
return [4 /*yield*/, getCoreContext({ req: req })];
|
|
69
69
|
case 1:
|
|
70
|
-
_b =
|
|
70
|
+
_b = _d.sent();
|
|
71
71
|
return [3 /*break*/, 3];
|
|
72
72
|
case 2:
|
|
73
73
|
_b = {};
|
|
74
|
-
|
|
74
|
+
_d.label = 3;
|
|
75
75
|
case 3:
|
|
76
76
|
coreContext = _b;
|
|
77
|
-
|
|
78
|
-
|
|
77
|
+
if (!(typeof getGatewayContext === 'function')) return [3 /*break*/, 5];
|
|
78
|
+
return [4 /*yield*/, getGatewayContext({ req: req })];
|
|
79
|
+
case 4:
|
|
80
|
+
_c = _d.sent();
|
|
81
|
+
return [3 /*break*/, 6];
|
|
82
|
+
case 5:
|
|
83
|
+
_c = {};
|
|
84
|
+
_d.label = 6;
|
|
85
|
+
case 6:
|
|
86
|
+
gatewayContext = _c;
|
|
87
|
+
context = {
|
|
88
|
+
requestId: requestId,
|
|
89
|
+
cores: {},
|
|
90
|
+
gateways: {},
|
|
91
|
+
req: req,
|
|
92
|
+
};
|
|
93
|
+
context.cores = Object.keys(cores || {}).reduce(function (acc, key) {
|
|
94
|
+
acc[(0, lodash_1.camelCase)(key)] = new cores[key](__assign(__assign({}, coreContext), { context: context }));
|
|
95
|
+
return acc;
|
|
96
|
+
}, {});
|
|
97
|
+
context.gateways = Object.keys(gateways || {}).reduce(function (acc, key) {
|
|
98
|
+
acc[(0, lodash_1.camelCase)(key)] = new gateways[key](__assign(__assign({}, gatewayContext), { context: context }));
|
|
79
99
|
return acc;
|
|
80
100
|
}, {});
|
|
81
|
-
|
|
82
|
-
if (!(typeof extendContext === 'function')) return [3 /*break*/, 5];
|
|
101
|
+
if (!(typeof extendContext === 'function')) return [3 /*break*/, 8];
|
|
83
102
|
return [4 /*yield*/, extendContext({ context: context, req: req })];
|
|
84
|
-
case
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
case
|
|
103
|
+
case 7:
|
|
104
|
+
_d.sent();
|
|
105
|
+
_d.label = 8;
|
|
106
|
+
case 8: return [2 /*return*/, context];
|
|
88
107
|
}
|
|
89
108
|
});
|
|
90
109
|
}); };
|
|
@@ -94,31 +113,49 @@ exports.createApiContext = createApiContext;
|
|
|
94
113
|
* @returns {object} A context object with all available cores
|
|
95
114
|
*/
|
|
96
115
|
var createContextDefault = function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
97
|
-
var _a, knexConfig, dbSchema, cores, req, extendContext, getCoreContext, authorization, spaceId, apiKey, managementApiKey, accountId, roleId, userId, userAgent, referer, ipAddress, acceptLanguage, languages, requestedLang, requestId, db;
|
|
116
|
+
var _a, knexConfig, isProduction, logger, doAuth, spaceGw, interserviceApiKey, jwtSecret, verifyTokenArgs, dbSchema, cores, gateways, req, extendContext, getCoreContext, getGatewayContext, authorization, spaceId, apiKey, managementApiKey, accountId, roleId, userId, userAgent, referer, ipAddress, acceptLanguage, languages, requestedLang, requestId, db, sharedContext;
|
|
98
117
|
return __generator(this, function (_b) {
|
|
99
118
|
switch (_b.label) {
|
|
100
119
|
case 0:
|
|
101
|
-
_a = args || {}, knexConfig = _a.knexConfig, dbSchema = _a.dbSchema, cores = _a.cores, req = _a.req, extendContext = _a.extendContext, getCoreContext = _a.getCoreContext;
|
|
102
|
-
authorization = req.headers[
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
120
|
+
_a = args || {}, knexConfig = _a.knexConfig, isProduction = _a.isProduction, logger = _a.logger, doAuth = _a.doAuth, spaceGw = _a.spaceGw, interserviceApiKey = _a.interserviceApiKey, jwtSecret = _a.jwtSecret, verifyTokenArgs = _a.verifyTokenArgs, dbSchema = _a.dbSchema, cores = _a.cores, gateways = _a.gateways, req = _a.req, extendContext = _a.extendContext, getCoreContext = _a.getCoreContext, getGatewayContext = _a.getGatewayContext;
|
|
121
|
+
authorization = req.headers[constants_1.HEADERS.AUTHORIZATION]
|
|
122
|
+
? req.headers[constants_1.HEADERS.AUTHORIZATION].replace('Bearer ', '')
|
|
123
|
+
: undefined;
|
|
124
|
+
spaceId = req.headers[constants_1.HEADERS.SPACE_ID];
|
|
125
|
+
apiKey = req.headers[constants_1.HEADERS.API_KEY];
|
|
126
|
+
managementApiKey = req.headers[constants_1.HEADERS.MANAGEMENT_API_KEY];
|
|
127
|
+
accountId = req.headers[constants_1.HEADERS.ACCOUNT_ID];
|
|
128
|
+
roleId = req.headers[constants_1.HEADERS.ROLE_ID];
|
|
129
|
+
userId = req.headers[constants_1.HEADERS.USER_ID];
|
|
130
|
+
userAgent = req.headers[constants_1.HEADERS.USER_AGENT];
|
|
131
|
+
referer = req.headers[constants_1.HEADERS.REFERER];
|
|
132
|
+
ipAddress = req.headers[constants_1.HEADERS.IP_ADDRESS] || req.connection.remoteAddress;
|
|
133
|
+
acceptLanguage = req.headers[constants_1.HEADERS.ACCEPT_LANGUAGE];
|
|
113
134
|
languages = (0, utils_1.extractLanguages)(acceptLanguage);
|
|
114
|
-
requestedLang = req.query[
|
|
135
|
+
requestedLang = req.headers[constants_1.HEADERS.ACCEPT_LANGUAGE] || req.query[constants_1.HEADERS.ACCEPT_LANGUAGE];
|
|
115
136
|
requestId = (0, uuid_1.v4)();
|
|
116
|
-
db = new
|
|
137
|
+
db = new Database_1.Database({
|
|
117
138
|
knexConfig: knexConfig,
|
|
118
139
|
dbSchema: dbSchema,
|
|
119
140
|
});
|
|
141
|
+
sharedContext = {
|
|
142
|
+
spaceId: spaceId,
|
|
143
|
+
apiKey: apiKey,
|
|
144
|
+
managementApiKey: managementApiKey,
|
|
145
|
+
userAgent: userAgent,
|
|
146
|
+
referer: referer,
|
|
147
|
+
ipAddress: ipAddress,
|
|
148
|
+
acceptLanguage: acceptLanguage,
|
|
149
|
+
languages: languages,
|
|
150
|
+
requestedLang: requestedLang,
|
|
151
|
+
authorization: authorization,
|
|
152
|
+
accountId: accountId,
|
|
153
|
+
roleId: roleId,
|
|
154
|
+
userId: userId,
|
|
155
|
+
};
|
|
120
156
|
return [4 /*yield*/, (0, exports.createApiContext)({
|
|
121
157
|
cores: cores,
|
|
158
|
+
gateways: gateways,
|
|
122
159
|
req: req,
|
|
123
160
|
requestId: requestId,
|
|
124
161
|
extendContext: function (_a) {
|
|
@@ -139,7 +176,27 @@ var createContextDefault = function (args) { return __awaiter(void 0, void 0, vo
|
|
|
139
176
|
case 1:
|
|
140
177
|
extendCoreConext = _a.sent();
|
|
141
178
|
_a.label = 2;
|
|
142
|
-
case 2: return [2 /*return*/, __assign(__assign({ db: db
|
|
179
|
+
case 2: return [2 /*return*/, __assign(__assign({ db: db, gatewayName: '', isProduction: isProduction, logger: logger, doAuth: doAuth, spaceGw: spaceGw, interserviceApiKey: interserviceApiKey, jwtSecret: jwtSecret, verifyTokenArgs: verifyTokenArgs }, (0, lodash_1.omit)(extendCoreConext, ['context'])), { context: __assign(__assign({}, sharedContext), (extendCoreConext.context || {})) })];
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
}); },
|
|
183
|
+
getGatewayContext: function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
184
|
+
var extendGatewayConext;
|
|
185
|
+
return __generator(this, function (_a) {
|
|
186
|
+
switch (_a.label) {
|
|
187
|
+
case 0:
|
|
188
|
+
extendGatewayConext = {};
|
|
189
|
+
if (!(typeof getGatewayContext === 'function')) return [3 /*break*/, 2];
|
|
190
|
+
return [4 /*yield*/, getGatewayContext(args)];
|
|
191
|
+
case 1:
|
|
192
|
+
extendGatewayConext = _a.sent();
|
|
193
|
+
_a.label = 2;
|
|
194
|
+
case 2: return [2 /*return*/, {
|
|
195
|
+
db: db,
|
|
196
|
+
isProduction: isProduction,
|
|
197
|
+
logger: logger,
|
|
198
|
+
context: __assign(__assign({}, sharedContext), (extendGatewayConext.context || {})),
|
|
199
|
+
}];
|
|
143
200
|
}
|
|
144
201
|
});
|
|
145
202
|
}); },
|
package/build/constants.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
declare const
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
};
|
|
5
|
-
export default _default;
|
|
1
|
+
declare const FIELDS: any;
|
|
2
|
+
declare const HEADERS: any;
|
|
3
|
+
declare const ID_FIELD: any;
|
|
4
|
+
export { ID_FIELD, FIELDS, HEADERS };
|
package/build/constants.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.HEADERS = exports.FIELDS = exports.ID_FIELD = void 0;
|
|
3
4
|
var FIELDS = {
|
|
4
5
|
ID: 'id',
|
|
5
6
|
STATUS: 'status',
|
|
@@ -17,9 +18,27 @@ var FIELDS = {
|
|
|
17
18
|
USER_ID: 'user_id',
|
|
18
19
|
ORDER_NO: 'order_no',
|
|
19
20
|
SPACE_ID: 'space_id',
|
|
21
|
+
DISPLAY_NAME: 'display_name',
|
|
22
|
+
NAME: 'name',
|
|
23
|
+
USERNAME: 'username',
|
|
24
|
+
EMAIL: 'email',
|
|
25
|
+
PHONE: 'phone',
|
|
20
26
|
};
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
27
|
+
exports.FIELDS = FIELDS;
|
|
28
|
+
var HEADERS = {
|
|
29
|
+
AUTHORIZATION: 'authorization',
|
|
30
|
+
SPACE_ID: 'x-space-id',
|
|
31
|
+
API_KEY: 'x-api-key',
|
|
32
|
+
MANAGEMENT_API_KEY: 'x-management-api-key',
|
|
33
|
+
ACCOUNT_ID: 'x-account-id',
|
|
34
|
+
ROLE_ID: 'x-role-id',
|
|
35
|
+
USER_ID: 'x-user-id',
|
|
36
|
+
USER_AGENT: 'user-agent',
|
|
37
|
+
REFERER: 'referer',
|
|
38
|
+
IP_ADDRESS: 'x-forwarded-for',
|
|
39
|
+
ACCEPT_LANGUAGE: 'accept-language',
|
|
40
|
+
REQUESTED_LANGUAGE: 'x-lang',
|
|
25
41
|
};
|
|
42
|
+
exports.HEADERS = HEADERS;
|
|
43
|
+
var ID_FIELD = FIELDS.ID;
|
|
44
|
+
exports.ID_FIELD = ID_FIELD;
|
package/build/dbSeeder.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
|
@@ -4,6 +4,8 @@ export declare const addOrderNo: (table: any, opt?: any) => any;
|
|
|
4
4
|
export declare const addAmount: (table: any, fieldName: string) => any;
|
|
5
5
|
export declare const addSpaceId: (table: any, opt?: any) => any;
|
|
6
6
|
export declare const addUserId: (table: any, opt?: any) => any;
|
|
7
|
+
export declare const addAccountId: (table: any, opt?: any) => any;
|
|
8
|
+
export declare const addLang: (table: any, opt?: any) => any;
|
|
7
9
|
export declare const defaultFields: (opt?: any) => {
|
|
8
10
|
[x: number]: string;
|
|
9
11
|
};
|
package/build/dbTableHelpers.js
CHANGED
|
@@ -1,51 +1,47 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.defaultFields = exports.addUserId = exports.addSpaceId = exports.addAmount = exports.addOrderNo = exports.dbFieldAddDefaults = void 0;
|
|
3
|
+
exports.defaultFields = exports.addLang = exports.addAccountId = exports.addUserId = exports.addSpaceId = exports.addAmount = exports.addOrderNo = exports.dbFieldAddDefaults = void 0;
|
|
7
4
|
var utils_1 = require("@sdflc/utils");
|
|
8
|
-
var constants_1 =
|
|
9
|
-
var FIELDS = constants_1.default.FIELDS;
|
|
5
|
+
var constants_1 = require("./constants");
|
|
10
6
|
var dbFieldAddDefaults = function (table, opt) {
|
|
11
7
|
var _a = opt || {}, addUserInfo = _a.addUserInfo, addVersion = _a.addVersion, addStatus = _a.addStatus, skipTimestamps = _a.skipTimestamps, skipRemovedAtStr = _a.skipRemovedAtStr;
|
|
12
8
|
if (addStatus) {
|
|
13
9
|
table
|
|
14
|
-
.integer(FIELDS.STATUS)
|
|
10
|
+
.integer(constants_1.FIELDS.STATUS)
|
|
15
11
|
.defaultTo(utils_1.STATUSES.ACTIVE)
|
|
16
12
|
.comment('The field is used to specify record status: 50 - Test, 100 - Active, 200 - Draft, 300 - Pending, 1000 - Blocked, 5000 - Disabled, 10000 - Removed');
|
|
17
13
|
}
|
|
18
14
|
if (addVersion) {
|
|
19
|
-
table.integer(FIELDS.VERSION).defaultTo(0).comment('The field is used to control versioning');
|
|
15
|
+
table.integer(constants_1.FIELDS.VERSION).defaultTo(0).comment('The field is used to control versioning');
|
|
20
16
|
}
|
|
21
17
|
if (addUserInfo) {
|
|
22
|
-
table.uuid(FIELDS.CREATED_BY).comment('ID of user who created the record');
|
|
23
|
-
table.uuid(FIELDS.UPDATED_BY).comment('ID of the last user who update the record');
|
|
24
|
-
table.uuid(FIELDS.REMOVED_BY).comment('ID of user who removed the record');
|
|
18
|
+
table.uuid(constants_1.FIELDS.CREATED_BY).comment('ID of user who created the record');
|
|
19
|
+
table.uuid(constants_1.FIELDS.UPDATED_BY).comment('ID of the last user who update the record');
|
|
20
|
+
table.uuid(constants_1.FIELDS.REMOVED_BY).comment('ID of user who removed the record');
|
|
25
21
|
}
|
|
26
22
|
if (skipTimestamps !== true) {
|
|
27
23
|
table.timestamps(true, true);
|
|
28
24
|
table
|
|
29
|
-
.dateTime(FIELDS.REMOVED_AT)
|
|
25
|
+
.dateTime(constants_1.FIELDS.REMOVED_AT)
|
|
30
26
|
.comment('Date and time of removal. As it is nullable it cannot be used in any unique index');
|
|
31
27
|
if (skipRemovedAtStr !== true) {
|
|
32
|
-
table.text(FIELDS.REMOVED_AT_STR).defaultTo('').comment('Used to create unique indexes.');
|
|
28
|
+
table.text(constants_1.FIELDS.REMOVED_AT_STR).defaultTo('').comment('Used to create unique indexes.');
|
|
33
29
|
}
|
|
34
|
-
table.index([FIELDS.CREATED_AT]);
|
|
35
|
-
table.index([FIELDS.UPDATED_AT]);
|
|
30
|
+
table.index([constants_1.FIELDS.CREATED_AT]);
|
|
31
|
+
table.index([constants_1.FIELDS.UPDATED_AT]);
|
|
36
32
|
}
|
|
37
33
|
if (addStatus) {
|
|
38
|
-
table.index([FIELDS.STATUS]);
|
|
34
|
+
table.index([constants_1.FIELDS.STATUS]);
|
|
39
35
|
}
|
|
40
36
|
if (skipRemovedAtStr !== true) {
|
|
41
|
-
table.index([FIELDS.REMOVED_AT_STR]);
|
|
37
|
+
table.index([constants_1.FIELDS.REMOVED_AT_STR]);
|
|
42
38
|
}
|
|
43
39
|
};
|
|
44
40
|
exports.dbFieldAddDefaults = dbFieldAddDefaults;
|
|
45
41
|
var addOrderNo = function (table, opt) {
|
|
46
|
-
var chain = table.text(FIELDS.ORDER_NO).notNullable().defaultTo('10000000');
|
|
42
|
+
var chain = table.text(constants_1.FIELDS.ORDER_NO).notNullable().defaultTo('10000000');
|
|
47
43
|
if ((opt === null || opt === void 0 ? void 0 : opt.addIndex) === true) {
|
|
48
|
-
table.index([FIELDS.ORDER_NO]);
|
|
44
|
+
table.index([constants_1.FIELDS.ORDER_NO]);
|
|
49
45
|
}
|
|
50
46
|
return chain;
|
|
51
47
|
};
|
|
@@ -55,31 +51,56 @@ var addAmount = function (table, fieldName) {
|
|
|
55
51
|
};
|
|
56
52
|
exports.addAmount = addAmount;
|
|
57
53
|
var addSpaceId = function (table, opt) {
|
|
58
|
-
var chain = table.text(FIELDS.SPACE_ID).notNullable().comment('Reference to the space table');
|
|
54
|
+
var chain = table.text(constants_1.FIELDS.SPACE_ID).notNullable().comment('Reference to the space table');
|
|
59
55
|
if ((opt === null || opt === void 0 ? void 0 : opt.addForeignKey) === true) {
|
|
60
|
-
table.foreign(FIELDS.SPACE_ID).references("space.".concat(FIELDS.ID)).onUpdate('CASCADE').onDelete('CASCADE');
|
|
56
|
+
table.foreign(constants_1.FIELDS.SPACE_ID).references("space.".concat(constants_1.FIELDS.ID)).onUpdate('CASCADE').onDelete('CASCADE');
|
|
61
57
|
}
|
|
62
58
|
return chain;
|
|
63
59
|
};
|
|
64
60
|
exports.addSpaceId = addSpaceId;
|
|
65
61
|
var addUserId = function (table, opt) {
|
|
66
|
-
var chain = table.uuid(FIELDS.USER_ID).notNullable().comment('Reference to the user table');
|
|
62
|
+
var chain = table.uuid(constants_1.FIELDS.USER_ID).notNullable().comment('Reference to the user table');
|
|
67
63
|
if ((opt === null || opt === void 0 ? void 0 : opt.addForeignKey) === true) {
|
|
68
|
-
table.foreign(FIELDS.
|
|
64
|
+
table.foreign(constants_1.FIELDS.USER_ID).references("user.".concat(constants_1.FIELDS.ID)).onUpdate('CASCADE').onDelete('CASCADE');
|
|
65
|
+
}
|
|
66
|
+
if ((opt === null || opt === void 0 ? void 0 : opt.addIndex) === true) {
|
|
67
|
+
table.index([constants_1.FIELDS.USER_ID]);
|
|
69
68
|
}
|
|
70
69
|
return chain;
|
|
71
70
|
};
|
|
72
71
|
exports.addUserId = addUserId;
|
|
72
|
+
var addAccountId = function (table, opt) {
|
|
73
|
+
var chain = table.uuid(constants_1.FIELDS.ACCOUNT_ID).notNullable().comment('Reference to the user table');
|
|
74
|
+
if ((opt === null || opt === void 0 ? void 0 : opt.addForeignKey) === true) {
|
|
75
|
+
table.foreign(constants_1.FIELDS.ACCOUNT_ID).references("account.".concat(constants_1.FIELDS.ID)).onUpdate('CASCADE').onDelete('CASCADE');
|
|
76
|
+
}
|
|
77
|
+
if ((opt === null || opt === void 0 ? void 0 : opt.addIndex) === true) {
|
|
78
|
+
table.index([constants_1.FIELDS.ACCOUNT_ID]);
|
|
79
|
+
}
|
|
80
|
+
return chain;
|
|
81
|
+
};
|
|
82
|
+
exports.addAccountId = addAccountId;
|
|
83
|
+
var addLang = function (table, opt) {
|
|
84
|
+
var chain = table.text(constants_1.FIELDS.LANG).defaultTo('en').notNullable().comment('Language, example: en, ru, en_CA, etc');
|
|
85
|
+
if ((opt === null || opt === void 0 ? void 0 : opt.addForeignKey) === true) {
|
|
86
|
+
table.foreign(constants_1.FIELDS.LANG).references("language.".concat(constants_1.FIELDS.ID)).onUpdate('CASCADE').onDelete('CASCADE');
|
|
87
|
+
}
|
|
88
|
+
if ((opt === null || opt === void 0 ? void 0 : opt.addIndex) === true) {
|
|
89
|
+
table.index([constants_1.FIELDS.LANG]);
|
|
90
|
+
}
|
|
91
|
+
return chain;
|
|
92
|
+
};
|
|
93
|
+
exports.addLang = addLang;
|
|
73
94
|
var defaultFields = function (opt) {
|
|
74
95
|
var _a;
|
|
75
96
|
var addUserInfo = (opt || {}).addUserInfo;
|
|
76
97
|
var obj = (_a = {},
|
|
77
|
-
_a[FIELDS.CREATED_AT] = '2021-01-01T00:00:00Z',
|
|
78
|
-
_a[FIELDS.UPDATED_AT] = '2021-01-01T00:00:00Z',
|
|
98
|
+
_a[constants_1.FIELDS.CREATED_AT] = '2021-01-01T00:00:00Z',
|
|
99
|
+
_a[constants_1.FIELDS.UPDATED_AT] = '2021-01-01T00:00:00Z',
|
|
79
100
|
_a);
|
|
80
101
|
if (addUserInfo === true) {
|
|
81
|
-
obj[FIELDS.CREATED_BY] = utils_1.UUID_EMPTY;
|
|
82
|
-
obj[FIELDS.UPDATED_BY] = utils_1.UUID_EMPTY;
|
|
102
|
+
obj[constants_1.FIELDS.CREATED_BY] = utils_1.UUID_EMPTY;
|
|
103
|
+
obj[constants_1.FIELDS.UPDATED_BY] = utils_1.UUID_EMPTY;
|
|
83
104
|
}
|
|
84
105
|
return obj;
|
|
85
106
|
};
|
package/build/index.d.ts
CHANGED
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
|
|
2
|
-
export { CacheInterface, LoaderInterface,
|
|
1
|
+
export { ID_FIELD, FIELDS, HEADERS } from './constants';
|
|
2
|
+
export { CacheInterface, LoaderInterface, BaseGatewayPropsInterface, ListArgsInterface, SortItemInterface, PaginationInterface, BaseCorePropsInterface, BaseCoreDoingWhatInterface, CoreActionInterface, ApiContextInterface, DbFieldAddDefaultInterface, BuildConfigOptions, DatabaseOptions, DatabaseReadInterface, BuildDefaultResolvers, BaseCoreValidatorsInterface, UserTokenParams, CreateUserTokenArgs, VerifyUserTokenArgs, BaseCoreActionsInterface, } from './interfaces';
|
|
3
3
|
export { buildConfig } from './configBulder';
|
|
4
|
-
export { Database } from './
|
|
4
|
+
export { Database } from './Database';
|
|
5
5
|
export { dbCleanTable, dbListTables, dbClean, dbWipe, dbReset, dbTransformSeedsToObject, dbRunMigrations, } from './dbHelpers';
|
|
6
|
-
export { DbMigratorAndSeeder } from './
|
|
6
|
+
export { DbMigratorAndSeeder } from './DbMigratorAndSeeder';
|
|
7
7
|
export { dbSeed } from './dbSeeder';
|
|
8
8
|
export { buildKnexConfig } from './knexConfigBuilder';
|
|
9
9
|
export { createRedisClient } from './redisClient';
|
|
10
10
|
export { checkArray, createErrorOnCheckError } from './checkItHelpers';
|
|
11
|
-
export { DataCache } from './
|
|
12
|
-
export { BaseGateway } from './
|
|
13
|
-
export { BaseCore } from './
|
|
11
|
+
export { DataCache } from './DataCache';
|
|
12
|
+
export { BaseGateway } from './BaseGateway';
|
|
13
|
+
export { BaseCore } from './BaseCore';
|
|
14
14
|
export { createApiContext, createContextDefault } from './apiContext';
|
|
15
|
-
export { BaseController } from './
|
|
16
|
-
export { dbFieldAddDefaults, addOrderNo, addAmount, addSpaceId, addUserId, defaultFields } from './dbTableHelpers';
|
|
15
|
+
export { BaseController } from './BaseController';
|
|
16
|
+
export { dbFieldAddDefaults, addOrderNo, addAmount, addSpaceId, addUserId, addAccountId, addLang, defaultFields, } from './dbTableHelpers';
|
|
17
17
|
export { buildDefaultResolvers } from './resolversHelpers';
|
|
18
18
|
export { createUserToken, verifyUserToken } from './userToken';
|
|
19
|
-
export { constants };
|
|
20
|
-
export { buildDefaultGatewayProps } from './baseGatewayHelpers';
|
|
21
19
|
export { getSaltAndHash, checkPassword } from './passwordHelpers';
|
package/build/index.js
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.checkPassword = exports.getSaltAndHash = exports.
|
|
7
|
-
var constants_1 =
|
|
8
|
-
exports
|
|
3
|
+
exports.checkPassword = exports.getSaltAndHash = exports.verifyUserToken = exports.createUserToken = exports.buildDefaultResolvers = exports.defaultFields = exports.addLang = exports.addAccountId = exports.addUserId = exports.addSpaceId = exports.addAmount = exports.addOrderNo = exports.dbFieldAddDefaults = exports.BaseController = exports.createContextDefault = exports.createApiContext = exports.BaseCore = exports.BaseGateway = exports.DataCache = exports.createErrorOnCheckError = exports.checkArray = exports.createRedisClient = exports.buildKnexConfig = exports.dbSeed = exports.DbMigratorAndSeeder = exports.dbRunMigrations = exports.dbTransformSeedsToObject = exports.dbReset = exports.dbWipe = exports.dbClean = exports.dbListTables = exports.dbCleanTable = exports.Database = exports.buildConfig = exports.HEADERS = exports.FIELDS = exports.ID_FIELD = void 0;
|
|
4
|
+
var constants_1 = require("./constants");
|
|
5
|
+
Object.defineProperty(exports, "ID_FIELD", { enumerable: true, get: function () { return constants_1.ID_FIELD; } });
|
|
6
|
+
Object.defineProperty(exports, "FIELDS", { enumerable: true, get: function () { return constants_1.FIELDS; } });
|
|
7
|
+
Object.defineProperty(exports, "HEADERS", { enumerable: true, get: function () { return constants_1.HEADERS; } });
|
|
9
8
|
var configBulder_1 = require("./configBulder");
|
|
10
9
|
Object.defineProperty(exports, "buildConfig", { enumerable: true, get: function () { return configBulder_1.buildConfig; } });
|
|
11
|
-
var
|
|
12
|
-
Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return
|
|
10
|
+
var Database_1 = require("./Database");
|
|
11
|
+
Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return Database_1.Database; } });
|
|
13
12
|
var dbHelpers_1 = require("./dbHelpers");
|
|
14
13
|
Object.defineProperty(exports, "dbCleanTable", { enumerable: true, get: function () { return dbHelpers_1.dbCleanTable; } });
|
|
15
14
|
Object.defineProperty(exports, "dbListTables", { enumerable: true, get: function () { return dbHelpers_1.dbListTables; } });
|
|
@@ -18,8 +17,8 @@ Object.defineProperty(exports, "dbWipe", { enumerable: true, get: function () {
|
|
|
18
17
|
Object.defineProperty(exports, "dbReset", { enumerable: true, get: function () { return dbHelpers_1.dbReset; } });
|
|
19
18
|
Object.defineProperty(exports, "dbTransformSeedsToObject", { enumerable: true, get: function () { return dbHelpers_1.dbTransformSeedsToObject; } });
|
|
20
19
|
Object.defineProperty(exports, "dbRunMigrations", { enumerable: true, get: function () { return dbHelpers_1.dbRunMigrations; } });
|
|
21
|
-
var
|
|
22
|
-
Object.defineProperty(exports, "DbMigratorAndSeeder", { enumerable: true, get: function () { return
|
|
20
|
+
var DbMigratorAndSeeder_1 = require("./DbMigratorAndSeeder");
|
|
21
|
+
Object.defineProperty(exports, "DbMigratorAndSeeder", { enumerable: true, get: function () { return DbMigratorAndSeeder_1.DbMigratorAndSeeder; } });
|
|
23
22
|
var dbSeeder_1 = require("./dbSeeder");
|
|
24
23
|
Object.defineProperty(exports, "dbSeed", { enumerable: true, get: function () { return dbSeeder_1.dbSeed; } });
|
|
25
24
|
var knexConfigBuilder_1 = require("./knexConfigBuilder");
|
|
@@ -29,31 +28,31 @@ Object.defineProperty(exports, "createRedisClient", { enumerable: true, get: fun
|
|
|
29
28
|
var checkItHelpers_1 = require("./checkItHelpers");
|
|
30
29
|
Object.defineProperty(exports, "checkArray", { enumerable: true, get: function () { return checkItHelpers_1.checkArray; } });
|
|
31
30
|
Object.defineProperty(exports, "createErrorOnCheckError", { enumerable: true, get: function () { return checkItHelpers_1.createErrorOnCheckError; } });
|
|
32
|
-
var
|
|
33
|
-
Object.defineProperty(exports, "DataCache", { enumerable: true, get: function () { return
|
|
34
|
-
var
|
|
35
|
-
Object.defineProperty(exports, "BaseGateway", { enumerable: true, get: function () { return
|
|
36
|
-
var
|
|
37
|
-
Object.defineProperty(exports, "BaseCore", { enumerable: true, get: function () { return
|
|
31
|
+
var DataCache_1 = require("./DataCache");
|
|
32
|
+
Object.defineProperty(exports, "DataCache", { enumerable: true, get: function () { return DataCache_1.DataCache; } });
|
|
33
|
+
var BaseGateway_1 = require("./BaseGateway");
|
|
34
|
+
Object.defineProperty(exports, "BaseGateway", { enumerable: true, get: function () { return BaseGateway_1.BaseGateway; } });
|
|
35
|
+
var BaseCore_1 = require("./BaseCore");
|
|
36
|
+
Object.defineProperty(exports, "BaseCore", { enumerable: true, get: function () { return BaseCore_1.BaseCore; } });
|
|
38
37
|
var apiContext_1 = require("./apiContext");
|
|
39
38
|
Object.defineProperty(exports, "createApiContext", { enumerable: true, get: function () { return apiContext_1.createApiContext; } });
|
|
40
39
|
Object.defineProperty(exports, "createContextDefault", { enumerable: true, get: function () { return apiContext_1.createContextDefault; } });
|
|
41
|
-
var
|
|
42
|
-
Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return
|
|
40
|
+
var BaseController_1 = require("./BaseController");
|
|
41
|
+
Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return BaseController_1.BaseController; } });
|
|
43
42
|
var dbTableHelpers_1 = require("./dbTableHelpers");
|
|
44
43
|
Object.defineProperty(exports, "dbFieldAddDefaults", { enumerable: true, get: function () { return dbTableHelpers_1.dbFieldAddDefaults; } });
|
|
45
44
|
Object.defineProperty(exports, "addOrderNo", { enumerable: true, get: function () { return dbTableHelpers_1.addOrderNo; } });
|
|
46
45
|
Object.defineProperty(exports, "addAmount", { enumerable: true, get: function () { return dbTableHelpers_1.addAmount; } });
|
|
47
46
|
Object.defineProperty(exports, "addSpaceId", { enumerable: true, get: function () { return dbTableHelpers_1.addSpaceId; } });
|
|
48
47
|
Object.defineProperty(exports, "addUserId", { enumerable: true, get: function () { return dbTableHelpers_1.addUserId; } });
|
|
48
|
+
Object.defineProperty(exports, "addAccountId", { enumerable: true, get: function () { return dbTableHelpers_1.addAccountId; } });
|
|
49
|
+
Object.defineProperty(exports, "addLang", { enumerable: true, get: function () { return dbTableHelpers_1.addLang; } });
|
|
49
50
|
Object.defineProperty(exports, "defaultFields", { enumerable: true, get: function () { return dbTableHelpers_1.defaultFields; } });
|
|
50
51
|
var resolversHelpers_1 = require("./resolversHelpers");
|
|
51
52
|
Object.defineProperty(exports, "buildDefaultResolvers", { enumerable: true, get: function () { return resolversHelpers_1.buildDefaultResolvers; } });
|
|
52
53
|
var userToken_1 = require("./userToken");
|
|
53
54
|
Object.defineProperty(exports, "createUserToken", { enumerable: true, get: function () { return userToken_1.createUserToken; } });
|
|
54
55
|
Object.defineProperty(exports, "verifyUserToken", { enumerable: true, get: function () { return userToken_1.verifyUserToken; } });
|
|
55
|
-
var baseGatewayHelpers_1 = require("./baseGatewayHelpers");
|
|
56
|
-
Object.defineProperty(exports, "buildDefaultGatewayProps", { enumerable: true, get: function () { return baseGatewayHelpers_1.buildDefaultGatewayProps; } });
|
|
57
56
|
var passwordHelpers_1 = require("./passwordHelpers");
|
|
58
57
|
Object.defineProperty(exports, "getSaltAndHash", { enumerable: true, get: function () { return passwordHelpers_1.getSaltAndHash; } });
|
|
59
58
|
Object.defineProperty(exports, "checkPassword", { enumerable: true, get: function () { return passwordHelpers_1.checkPassword; } });
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface of application API interface which should be created on receiving of a request
|
|
3
|
+
*/
|
|
4
|
+
export interface ApiContext {
|
|
5
|
+
requestId: string;
|
|
6
|
+
cores: any;
|
|
7
|
+
gateways: any;
|
|
8
|
+
req: any;
|
|
9
|
+
spaceId?: string;
|
|
10
|
+
apiKey?: string;
|
|
11
|
+
managementApiKey?: string;
|
|
12
|
+
userAgent?: string;
|
|
13
|
+
referer?: string;
|
|
14
|
+
ipAddress?: string;
|
|
15
|
+
acceptLanguage?: string;
|
|
16
|
+
languages?: string[];
|
|
17
|
+
requestedLang?: string;
|
|
18
|
+
authorization?: string;
|
|
19
|
+
accountId?: string;
|
|
20
|
+
roleId?: string;
|
|
21
|
+
userId?: string;
|
|
22
|
+
[key: string]: any;
|
|
23
|
+
}
|
|
File without changes
|
|
@@ -1,7 +1,11 @@
|
|
|
1
|
+
import { BaseCorePropsInterface } from './BaseCorePropsInterface';
|
|
2
|
+
import { BaseGatewayPropsInterface } from './BaseGatewayPropsInterface';
|
|
1
3
|
export interface ApiContextInterface {
|
|
2
4
|
cores: any;
|
|
5
|
+
gateways: any;
|
|
3
6
|
req: any;
|
|
4
7
|
requestId: any;
|
|
5
|
-
getCoreContext?(args: any):
|
|
8
|
+
getCoreContext?(args: any): Promise<BaseCorePropsInterface>;
|
|
9
|
+
getGatewayContext?(args: any): Promise<BaseGatewayPropsInterface>;
|
|
6
10
|
extendContext?(args: any): any;
|
|
7
11
|
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Logger } from '@sdflc/utils';
|
|
2
|
+
import { Database } from '../Database';
|
|
3
|
+
import { BaseGateway } from '../BaseGateway';
|
|
4
|
+
import { BaseCoreValidatorsInterface } from './BaseCoreValidatorsInterface';
|
|
5
|
+
import { BaseCoreDoingWhatInterface } from './BaseCoreDoingWhatInterface';
|
|
6
|
+
import { VerifyUserTokenArgs } from './VerifyUserTokenArgs';
|
|
7
|
+
import { ApiContext } from './ApiContext';
|
|
8
|
+
export interface BaseCorePropsInterface {
|
|
9
|
+
/**
|
|
10
|
+
* Application API context with all necessary information about request
|
|
11
|
+
*/
|
|
12
|
+
context: ApiContext;
|
|
13
|
+
/**
|
|
14
|
+
* Database instance to handle queries to DB within one request
|
|
15
|
+
*/
|
|
16
|
+
db: Database;
|
|
17
|
+
/**
|
|
18
|
+
* Name of a gateway that will perform default CRUD operations, it should be initialized in the API context
|
|
19
|
+
*/
|
|
20
|
+
gatewayName: string;
|
|
21
|
+
isProduction: boolean;
|
|
22
|
+
logger: Logger;
|
|
23
|
+
name?: string;
|
|
24
|
+
doAuth: boolean;
|
|
25
|
+
doingWhat?: BaseCoreDoingWhatInterface;
|
|
26
|
+
validators?: BaseCoreValidatorsInterface;
|
|
27
|
+
spaceGw?: BaseGateway;
|
|
28
|
+
interserviceApiKey?: string;
|
|
29
|
+
jwtSecret?: string;
|
|
30
|
+
verifyTokenArgs?: VerifyUserTokenArgs;
|
|
31
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { Logger } from '@sdflc/utils';
|
|
2
|
+
import { ApiContext } from '.';
|
|
3
|
+
import { CacheInterface } from '..';
|
|
4
|
+
import { LoaderInterface } from './LoaderInterface';
|
|
5
|
+
import { SortItemInterface } from './SortItemInterface';
|
|
6
|
+
export interface BaseGatewayPropsInterface extends CacheInterface {
|
|
7
|
+
context: ApiContext;
|
|
8
|
+
setFields?: string[] | string;
|
|
9
|
+
hasStatus?: boolean;
|
|
10
|
+
hasCreatedBy?: boolean;
|
|
11
|
+
hasUpdatedBy?: boolean;
|
|
12
|
+
hasRemovedBy?: boolean;
|
|
13
|
+
hasCreatedAt?: boolean;
|
|
14
|
+
hasUpdatedAt?: boolean;
|
|
15
|
+
hasRemovedAt?: boolean;
|
|
16
|
+
hasRemovedAtStr?: boolean;
|
|
17
|
+
hasSpace?: boolean;
|
|
18
|
+
hasVersion?: boolean;
|
|
19
|
+
hasLang?: boolean;
|
|
20
|
+
defaultSorting?: SortItemInterface[];
|
|
21
|
+
fieldForKeyword?: string;
|
|
22
|
+
insertChunkSize?: number;
|
|
23
|
+
loader?: LoaderInterface;
|
|
24
|
+
noCache?: boolean;
|
|
25
|
+
returnFields?: any[];
|
|
26
|
+
activeStatuses?: number[];
|
|
27
|
+
logger: Logger;
|
|
28
|
+
isProduction: boolean;
|
|
29
|
+
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { Database } from '../
|
|
1
|
+
import { Database } from '../Database';
|
|
2
2
|
export interface CacheInterface {
|
|
3
3
|
db: Database;
|
|
4
|
-
loaderFn?(args?: any): any;
|
|
5
4
|
keyPrefix?: string;
|
|
6
5
|
context?: any;
|
|
7
|
-
buildKey?(args: any): string;
|
|
8
6
|
table?: string;
|
|
9
7
|
idField?: string;
|
|
10
8
|
selectFields?: any[];
|
|
11
9
|
readAll?: boolean;
|
|
12
10
|
redisClient?: any;
|
|
13
11
|
cacheTtl?: number;
|
|
12
|
+
loaderFn?(args?: any): any;
|
|
13
|
+
buildKey?(args: any): string;
|
|
14
14
|
}
|