@sdflc/backend-helpers 1.0.27 → 1.0.30
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 +1 -1
- package/build/BaseCore.js +26 -22
- package/build/BaseGateway.js +20 -10
- package/build/apiContext.js +3 -3
- package/build/index.d.ts +1 -1
- package/build/interfaces/BaseCorePropsInterface.d.ts +1 -1
- package/build/interfaces/BaseGatewayPropsInterface.d.ts +1 -0
- package/build/interfaces/CoreActionInterface.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ Here are the props to be passed to the BaseCore constructor:
|
|
|
24
24
|
- doAuth: boolean - call authorize method or not an incoming request
|
|
25
25
|
- doingWhat?: BaseCoreDoingWhatInterface - an object with text descriptions of each action, used to generate generic error message sent to user on an exception
|
|
26
26
|
- validators?: BaseCoreValidatorsInterface - an object with validator functions to be used to validate incoming data
|
|
27
|
-
-
|
|
27
|
+
- spaceGw?: BaseGateway - gateway to find a space, i.e. configration of the app. Each app can have several configurations to be used as one instance for different applications
|
|
28
28
|
- interserviceApiKey?: string - API key to be used to authenticate incoming request from another microservice, optional
|
|
29
29
|
- jwtSecret?: string - secret to be used to validate Authorize Bearer token on incoming request, optional
|
|
30
30
|
- verifytokenArgs?: VerifyUserTokenArgs - optional parameters for JWT token validation, like algorithm, etc
|
package/build/BaseCore.js
CHANGED
|
@@ -728,23 +728,42 @@ var BaseCore = /** @class */ (function () {
|
|
|
728
728
|
*/
|
|
729
729
|
BaseCore.prototype.getJwtTokenSecretAndSettings = function (params) {
|
|
730
730
|
return __awaiter(this, void 0, void 0, function () {
|
|
731
|
+
var space;
|
|
731
732
|
return __generator(this, function (_a) {
|
|
732
|
-
|
|
733
|
+
space = this.getContext().space;
|
|
734
|
+
return [2 /*return*/, {
|
|
735
|
+
jwtSecret: (space === null || space === void 0 ? void 0 : space.tokenSecret) || this.config.jwtSecret || '',
|
|
736
|
+
verifyTokenArgs: this.config.verifyTokenArgs,
|
|
737
|
+
}];
|
|
733
738
|
});
|
|
734
739
|
});
|
|
735
740
|
};
|
|
736
741
|
BaseCore.prototype.authenticate = function (params, opt) {
|
|
737
|
-
var _a;
|
|
738
742
|
return __awaiter(this, void 0, void 0, function () {
|
|
739
|
-
var context, authByToken,
|
|
740
|
-
return __generator(this, function (
|
|
741
|
-
switch (
|
|
743
|
+
var context, space, authByToken, _a, jwtSecret, verifyTokenArgs, verifyResult, token;
|
|
744
|
+
return __generator(this, function (_b) {
|
|
745
|
+
switch (_b.label) {
|
|
742
746
|
case 0:
|
|
743
747
|
context = this.config.context;
|
|
748
|
+
space = null;
|
|
749
|
+
if (!this.config.spaceGw) return [3 /*break*/, 2];
|
|
750
|
+
if (!context.spaceId) {
|
|
751
|
+
return [2 /*return*/, [false, 'Space not specified']];
|
|
752
|
+
}
|
|
753
|
+
return [4 /*yield*/, this.config.spaceGw.get(context.spaceId || '')];
|
|
754
|
+
case 1:
|
|
755
|
+
// Lookup space in case we have gateway
|
|
756
|
+
space = _b.sent();
|
|
757
|
+
if (!space) {
|
|
758
|
+
return [2 /*return*/, [false, 'Space not found']];
|
|
759
|
+
}
|
|
760
|
+
context.space = space;
|
|
761
|
+
_b.label = 2;
|
|
762
|
+
case 2:
|
|
744
763
|
authByToken = false;
|
|
745
764
|
return [4 /*yield*/, this.getJwtTokenSecretAndSettings(params)];
|
|
746
|
-
case
|
|
747
|
-
|
|
765
|
+
case 3:
|
|
766
|
+
_a = _b.sent(), jwtSecret = _a.jwtSecret, verifyTokenArgs = _a.verifyTokenArgs;
|
|
748
767
|
if (context.authorization && jwtSecret) {
|
|
749
768
|
verifyResult = (0, userToken_1.verifyUserToken)(context.authorization, jwtSecret, verifyTokenArgs);
|
|
750
769
|
if (verifyResult.didFail()) {
|
|
@@ -757,21 +776,6 @@ var BaseCore = /** @class */ (function () {
|
|
|
757
776
|
context.spaceId = token.spaceId || context.spaceId;
|
|
758
777
|
authByToken = true;
|
|
759
778
|
}
|
|
760
|
-
space = null;
|
|
761
|
-
if (!this.config.gwSpace) return [3 /*break*/, 3];
|
|
762
|
-
if (!context.spaceId) {
|
|
763
|
-
return [2 /*return*/, [false, 'Space not specified']];
|
|
764
|
-
}
|
|
765
|
-
return [4 /*yield*/, ((_a = this.config.gwSpace) === null || _a === void 0 ? void 0 : _a.get(context.spaceId || ''))];
|
|
766
|
-
case 2:
|
|
767
|
-
// Lookup space in case we have gateway
|
|
768
|
-
space = _c.sent();
|
|
769
|
-
if (!space) {
|
|
770
|
-
return [2 /*return*/, [false, 'Space not found']];
|
|
771
|
-
}
|
|
772
|
-
context.space = space;
|
|
773
|
-
_c.label = 3;
|
|
774
|
-
case 3:
|
|
775
779
|
if (!authByToken) {
|
|
776
780
|
if (this.config.interserviceApiKey && context.apiKey === this.config.interserviceApiKey) {
|
|
777
781
|
return [2 /*return*/, [true, '']];
|
package/build/BaseGateway.js
CHANGED
|
@@ -80,22 +80,25 @@ var BaseGateway = /** @class */ (function () {
|
|
|
80
80
|
};
|
|
81
81
|
BaseGateway.prototype.onListFilter = function (query, filterParams) {
|
|
82
82
|
return __awaiter(this, void 0, void 0, function () {
|
|
83
|
-
var _a, hasStatus, hasRemovedAt, hasSpace, activeStatuses, fieldForKeyword;
|
|
83
|
+
var _a, hasStatus, hasRemovedAt, hasSpace, activeStatuses, hasLang, fieldForKeyword;
|
|
84
84
|
var _b;
|
|
85
85
|
return __generator(this, function (_c) {
|
|
86
|
-
_a = this.config || {}, hasStatus = _a.hasStatus, hasRemovedAt = _a.hasRemovedAt, hasSpace = _a.hasSpace, activeStatuses = _a.activeStatuses, fieldForKeyword = _a.fieldForKeyword;
|
|
86
|
+
_a = this.config || {}, hasStatus = _a.hasStatus, hasRemovedAt = _a.hasRemovedAt, hasSpace = _a.hasSpace, activeStatuses = _a.activeStatuses, hasLang = _a.hasLang, fieldForKeyword = _a.fieldForKeyword;
|
|
87
87
|
// This function should be overriden
|
|
88
88
|
if (hasStatus) {
|
|
89
|
-
query.whereIn(constants_1.FIELDS.STATUS, Array.isArray(filterParams.
|
|
89
|
+
query.whereIn(constants_1.FIELDS.STATUS, Array.isArray(filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS]) ? filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS] : (0, lodash_1.castArray)(activeStatuses));
|
|
90
90
|
}
|
|
91
|
-
if (hasRemovedAt
|
|
91
|
+
if (hasRemovedAt) {
|
|
92
92
|
query.whereNull(constants_1.FIELDS.REMOVED_AT);
|
|
93
93
|
}
|
|
94
94
|
if (hasSpace) {
|
|
95
|
-
query.where((_b = {}, _b[constants_1.FIELDS.SPACE_ID] = filterParams === null || filterParams === void 0 ? void 0 : filterParams.
|
|
95
|
+
query.where((_b = {}, _b[constants_1.FIELDS.SPACE_ID] = filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.SPACE_ID], _b));
|
|
96
|
+
}
|
|
97
|
+
if (hasLang && (filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.LANG])) {
|
|
98
|
+
query.whereIn(constants_1.FIELDS.LANG, (0, lodash_1.castArray)(filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.LANG]));
|
|
96
99
|
}
|
|
97
|
-
if (filterParams === null || filterParams === void 0 ? void 0 : filterParams.
|
|
98
|
-
query.whereIn(constants_1.FIELDS.ID, (0, lodash_1.castArray)(filterParams === null || filterParams === void 0 ? void 0 : filterParams.
|
|
100
|
+
if (filterParams === null || filterParams === void 0 ? void 0 : filterParams[this.getIdField()]) {
|
|
101
|
+
query.whereIn(constants_1.FIELDS.ID, (0, lodash_1.castArray)(filterParams === null || filterParams === void 0 ? void 0 : filterParams[this.getIdField()]));
|
|
99
102
|
}
|
|
100
103
|
if (fieldForKeyword && filterParams.keyword) {
|
|
101
104
|
query.whereRaw("".concat(fieldForKeyword, " ILIKE ?"), "%".concat(filterParams.keyword, "%"));
|
|
@@ -109,13 +112,20 @@ var BaseGateway = /** @class */ (function () {
|
|
|
109
112
|
var _a, hasStatus, hasVersion, idName;
|
|
110
113
|
return __generator(this, function (_b) {
|
|
111
114
|
_a = this.config, hasStatus = _a.hasStatus, hasVersion = _a.hasVersion;
|
|
112
|
-
idName = this.
|
|
113
|
-
|
|
115
|
+
idName = this.getIdField();
|
|
116
|
+
if (filterParams[idName]) {
|
|
117
|
+
query.where(idName, filterParams[idName]);
|
|
118
|
+
}
|
|
114
119
|
if (hasVersion && filterParams[constants_1.FIELDS.VERSION]) {
|
|
115
120
|
query.where(constants_1.FIELDS.VERSION, filterParams[constants_1.FIELDS.VERSION]);
|
|
116
121
|
}
|
|
117
122
|
if (hasStatus) {
|
|
118
|
-
|
|
123
|
+
if (Array.isArray(filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS])) {
|
|
124
|
+
query.whereIn(constants_1.FIELDS.STATUS, filterParams === null || filterParams === void 0 ? void 0 : filterParams[constants_1.FIELDS.STATUS]);
|
|
125
|
+
}
|
|
126
|
+
else {
|
|
127
|
+
query.where(constants_1.FIELDS.STATUS, '!=', utils_1.STATUSES.REMOVED);
|
|
128
|
+
}
|
|
119
129
|
}
|
|
120
130
|
return [2 /*return*/];
|
|
121
131
|
});
|
package/build/apiContext.js
CHANGED
|
@@ -113,11 +113,11 @@ exports.createApiContext = createApiContext;
|
|
|
113
113
|
* @returns {object} A context object with all available cores
|
|
114
114
|
*/
|
|
115
115
|
var createContextDefault = function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
116
|
-
var _a, knexConfig, isProduction, logger, doAuth,
|
|
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;
|
|
117
117
|
return __generator(this, function (_b) {
|
|
118
118
|
switch (_b.label) {
|
|
119
119
|
case 0:
|
|
120
|
-
_a = args || {}, knexConfig = _a.knexConfig, isProduction = _a.isProduction, logger = _a.logger, doAuth = _a.doAuth,
|
|
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
121
|
authorization = req.headers[constants_1.HEADERS.AUTHORIZATION]
|
|
122
122
|
? req.headers[constants_1.HEADERS.AUTHORIZATION].replace('Bearer ', '')
|
|
123
123
|
: undefined;
|
|
@@ -176,7 +176,7 @@ var createContextDefault = function (args) { return __awaiter(void 0, void 0, vo
|
|
|
176
176
|
case 1:
|
|
177
177
|
extendCoreConext = _a.sent();
|
|
178
178
|
_a.label = 2;
|
|
179
|
-
case 2: return [2 /*return*/, __assign(__assign({ db: db, gatewayName: '', isProduction: isProduction, logger: logger, doAuth: doAuth,
|
|
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
180
|
}
|
|
181
181
|
});
|
|
182
182
|
}); },
|
package/build/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
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';
|
|
2
|
+
export { CacheInterface, LoaderInterface, BaseGatewayPropsInterface, ListArgsInterface, SortItemInterface, PaginationInterface, BaseCorePropsInterface, BaseCoreDoingWhatInterface, CoreActionInterface, ApiContextInterface, DbFieldAddDefaultInterface, BuildConfigOptions, DatabaseOptions, DatabaseReadInterface, BuildDefaultResolvers, BaseCoreValidatorsInterface, UserTokenParams, CreateUserTokenArgs, VerifyUserTokenArgs, BaseCoreActionsInterface, JwtTokenSecretAndSettings, } from './interfaces';
|
|
3
3
|
export { buildConfig } from './configBulder';
|
|
4
4
|
export { Database } from './Database';
|
|
5
5
|
export { dbCleanTable, dbListTables, dbClean, dbWipe, dbReset, dbTransformSeedsToObject, dbRunMigrations, } from './dbHelpers';
|
|
@@ -24,7 +24,7 @@ export interface BaseCorePropsInterface {
|
|
|
24
24
|
doAuth: boolean;
|
|
25
25
|
doingWhat?: BaseCoreDoingWhatInterface;
|
|
26
26
|
validators?: BaseCoreValidatorsInterface;
|
|
27
|
-
|
|
27
|
+
spaceGw?: BaseGateway;
|
|
28
28
|
interserviceApiKey?: string;
|
|
29
29
|
jwtSecret?: string;
|
|
30
30
|
verifyTokenArgs?: VerifyUserTokenArgs;
|
|
@@ -16,6 +16,7 @@ export interface BaseGatewayPropsInterface extends CacheInterface {
|
|
|
16
16
|
hasRemovedAtStr?: boolean;
|
|
17
17
|
hasSpace?: boolean;
|
|
18
18
|
hasVersion?: boolean;
|
|
19
|
+
hasLang?: boolean;
|
|
19
20
|
defaultSorting?: SortItemInterface[];
|
|
20
21
|
fieldForKeyword?: string;
|
|
21
22
|
insertChunkSize?: number;
|
package/package.json
CHANGED