@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.
- package/build/BaseCore.d.ts +88 -0
- package/build/BaseCore.js +736 -0
- package/build/BaseGateway.d.ts +56 -0
- package/build/BaseGateway.js +477 -0
- package/build/DataCache.d.ts +16 -0
- package/build/DataCache.js +113 -0
- package/build/Database.d.ts +36 -0
- package/build/Database.js +195 -0
- package/build/DbMigratorAndSeeder.d.ts +49 -0
- package/build/DbMigratorAndSeeder.js +212 -0
- package/build/RedisDataLoader.d.ts +41 -0
- package/build/RedisDataLoader.js +212 -0
- package/build/apiContext.d.ts +11 -0
- package/build/apiContext.js +146 -0
- package/build/baseController.d.ts +17 -0
- package/build/baseController.js +63 -0
- package/build/checkItHelpers.d.ts +3 -0
- package/build/checkItHelpers.js +28 -0
- package/build/commonValidators.d.ts +17 -0
- package/build/commonValidators.js +311 -0
- package/build/configBulder.d.ts +2 -0
- package/build/configBulder.js +36 -0
- package/build/constants.d.ts +30 -0
- package/build/constants.js +80 -0
- package/build/dbHelpers.d.ts +43 -0
- package/build/dbHelpers.js +156 -0
- package/build/dbSeeder.d.ts +2 -0
- package/build/dbSeeder.js +83 -0
- package/build/dbTableHelpers.d.ts +14 -0
- package/build/dbTableHelpers.js +118 -0
- package/build/downloadHelpers.d.ts +2 -0
- package/build/downloadHelpers.js +73 -0
- package/build/esm/BaseCore.d.ts +88 -0
- package/build/esm/BaseCore.js +730 -0
- package/build/esm/BaseGateway.d.ts +56 -0
- package/build/esm/BaseGateway.js +471 -0
- package/build/esm/DataCache.d.ts +16 -0
- package/build/esm/DataCache.js +107 -0
- package/build/esm/Database.d.ts +36 -0
- package/build/esm/Database.js +189 -0
- package/build/esm/DbMigratorAndSeeder.d.ts +49 -0
- package/build/esm/DbMigratorAndSeeder.js +173 -0
- package/build/esm/RedisDataLoader.d.ts +41 -0
- package/build/esm/RedisDataLoader.js +206 -0
- package/build/esm/apiContext.d.ts +11 -0
- package/build/esm/apiContext.js +138 -0
- package/build/esm/baseController.d.ts +17 -0
- package/build/esm/baseController.js +57 -0
- package/build/esm/checkItHelpers.d.ts +3 -0
- package/build/esm/checkItHelpers.js +23 -0
- package/build/esm/commonValidators.d.ts +17 -0
- package/build/esm/commonValidators.js +291 -0
- package/build/esm/configBulder.d.ts +2 -0
- package/build/esm/configBulder.js +32 -0
- package/build/esm/constants.d.ts +30 -0
- package/build/esm/constants.js +69 -0
- package/build/esm/dbHelpers.d.ts +43 -0
- package/build/esm/dbHelpers.js +144 -0
- package/build/esm/dbSeeder.d.ts +2 -0
- package/build/esm/dbSeeder.js +44 -0
- package/build/esm/dbTableHelpers.d.ts +14 -0
- package/build/esm/dbTableHelpers.js +106 -0
- package/build/esm/downloadHelpers.d.ts +2 -0
- package/build/esm/downloadHelpers.js +66 -0
- package/build/esm/index.d.ts +21 -0
- package/build/esm/index.js +21 -0
- package/build/esm/interfaces/ApiContext.d.ts +25 -0
- package/build/esm/interfaces/ApiContext.js +1 -0
- package/build/esm/interfaces/ApiContextInterface.d.ts +12 -0
- package/build/esm/interfaces/ApiContextInterface.js +1 -0
- package/build/esm/interfaces/BaseCoreActionsInterface.d.ts +38 -0
- package/build/esm/interfaces/BaseCoreActionsInterface.js +1 -0
- package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
- package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.js +1 -0
- package/build/esm/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
- package/build/esm/interfaces/BaseCoreDoingWhatInterface.js +1 -0
- package/build/esm/interfaces/BaseCorePropsInterface.d.ts +37 -0
- package/build/esm/interfaces/BaseCorePropsInterface.js +1 -0
- package/build/esm/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
- package/build/esm/interfaces/BaseCoreValidatorsInterface.js +1 -0
- package/build/esm/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
- package/build/esm/interfaces/BaseGatewayPropsInterface.js +1 -0
- package/build/esm/interfaces/BuildConfigOptions.d.ts +6 -0
- package/build/esm/interfaces/BuildConfigOptions.js +1 -0
- package/build/esm/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
- package/build/esm/interfaces/BuildDefaultResolversOptions.js +1 -0
- package/build/esm/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
- package/build/esm/interfaces/BuildListQueryArgsInterface.js +1 -0
- package/build/esm/interfaces/CacheInterface.d.ts +15 -0
- package/build/esm/interfaces/CacheInterface.js +1 -0
- package/build/esm/interfaces/CommonValidatorArgs.d.ts +3 -0
- package/build/esm/interfaces/CommonValidatorArgs.js +1 -0
- package/build/esm/interfaces/CoreActionInterface.d.ts +16 -0
- package/build/esm/interfaces/CoreActionInterface.js +1 -0
- package/build/esm/interfaces/CreateUserTokenArgs.d.ts +11 -0
- package/build/esm/interfaces/CreateUserTokenArgs.js +1 -0
- package/build/esm/interfaces/CreateUserTokenResult.d.ts +4 -0
- package/build/esm/interfaces/CreateUserTokenResult.js +1 -0
- package/build/esm/interfaces/DatabaseOptions.d.ts +26 -0
- package/build/esm/interfaces/DatabaseOptions.js +1 -0
- package/build/esm/interfaces/DatabaseReadInterface.d.ts +14 -0
- package/build/esm/interfaces/DatabaseReadInterface.js +1 -0
- package/build/esm/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
- package/build/esm/interfaces/DbFieldAddDefaultInterface.js +1 -0
- package/build/esm/interfaces/DownloadFileArgs.d.ts +6 -0
- package/build/esm/interfaces/DownloadFileArgs.js +1 -0
- package/build/esm/interfaces/ExtractCredentialsArgs.d.ts +19 -0
- package/build/esm/interfaces/ExtractCredentialsArgs.js +1 -0
- package/build/esm/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
- package/build/esm/interfaces/JwtTokenSecretAndSettings.js +1 -0
- package/build/esm/interfaces/ListArgsInterface.d.ts +7 -0
- package/build/esm/interfaces/ListArgsInterface.js +1 -0
- package/build/esm/interfaces/LoaderInterface.d.ts +7 -0
- package/build/esm/interfaces/LoaderInterface.js +1 -0
- package/build/esm/interfaces/PaginationInterface.d.ts +10 -0
- package/build/esm/interfaces/PaginationInterface.js +1 -0
- package/build/esm/interfaces/SortItemInterface.d.ts +4 -0
- package/build/esm/interfaces/SortItemInterface.js +1 -0
- package/build/esm/interfaces/UserTokenParams.d.ts +8 -0
- package/build/esm/interfaces/UserTokenParams.js +1 -0
- package/build/esm/interfaces/VerifyUserTokenArgs.d.ts +13 -0
- package/build/esm/interfaces/VerifyUserTokenArgs.js +1 -0
- package/build/esm/interfaces/index.d.ts +28 -0
- package/build/esm/interfaces/index.js +27 -0
- package/build/esm/knexConfigBuilder.d.ts +1 -0
- package/build/esm/knexConfigBuilder.js +84 -0
- package/build/esm/passwordHelpers.d.ts +5 -0
- package/build/esm/passwordHelpers.js +13 -0
- package/build/esm/redisClient.d.ts +17 -0
- package/build/esm/redisClient.js +97 -0
- package/build/esm/resolversHelpers.d.ts +3 -0
- package/build/esm/resolversHelpers.js +66 -0
- package/build/esm/userToken.d.ts +8 -0
- package/build/esm/userToken.js +80 -0
- package/build/esm/utils.d.ts +2 -0
- package/build/esm/utils.js +13 -0
- package/build/index.d.ts +21 -0
- package/build/index.js +37 -0
- package/build/interfaces/ApiContext.d.ts +25 -0
- package/build/interfaces/ApiContext.js +2 -0
- package/build/interfaces/ApiContextInterface.d.ts +12 -0
- package/build/interfaces/ApiContextInterface.js +2 -0
- package/build/interfaces/BaseCoreActionsInterface.d.ts +38 -0
- package/build/interfaces/BaseCoreActionsInterface.js +2 -0
- package/build/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
- package/build/interfaces/BaseCoreDoAuthOnActionInterface.js +2 -0
- package/build/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
- package/build/interfaces/BaseCoreDoingWhatInterface.js +2 -0
- package/build/interfaces/BaseCorePropsInterface.d.ts +37 -0
- package/build/interfaces/BaseCorePropsInterface.js +2 -0
- package/build/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
- package/build/interfaces/BaseCoreValidatorsInterface.js +2 -0
- package/build/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
- package/build/interfaces/BaseGatewayPropsInterface.js +2 -0
- package/build/interfaces/BuildConfigOptions.d.ts +6 -0
- package/build/interfaces/BuildConfigOptions.js +2 -0
- package/build/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
- package/build/interfaces/BuildDefaultResolversOptions.js +2 -0
- package/build/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
- package/build/interfaces/BuildListQueryArgsInterface.js +2 -0
- package/build/interfaces/CacheInterface.d.ts +15 -0
- package/build/interfaces/CacheInterface.js +2 -0
- package/build/interfaces/CommonValidatorArgs.d.ts +3 -0
- package/build/interfaces/CommonValidatorArgs.js +2 -0
- package/build/interfaces/CoreActionInterface.d.ts +16 -0
- package/build/interfaces/CoreActionInterface.js +2 -0
- package/build/interfaces/CreateUserTokenArgs.d.ts +11 -0
- package/build/interfaces/CreateUserTokenArgs.js +2 -0
- package/build/interfaces/CreateUserTokenResult.d.ts +4 -0
- package/build/interfaces/CreateUserTokenResult.js +2 -0
- package/build/interfaces/DatabaseOptions.d.ts +26 -0
- package/build/interfaces/DatabaseOptions.js +2 -0
- package/build/interfaces/DatabaseReadInterface.d.ts +14 -0
- package/build/interfaces/DatabaseReadInterface.js +2 -0
- package/build/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
- package/build/interfaces/DbFieldAddDefaultInterface.js +2 -0
- package/build/interfaces/DownloadFileArgs.d.ts +6 -0
- package/build/interfaces/DownloadFileArgs.js +2 -0
- package/build/interfaces/ExtractCredentialsArgs.d.ts +19 -0
- package/build/interfaces/ExtractCredentialsArgs.js +2 -0
- package/build/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
- package/build/interfaces/JwtTokenSecretAndSettings.js +2 -0
- package/build/interfaces/ListArgsInterface.d.ts +7 -0
- package/build/interfaces/ListArgsInterface.js +2 -0
- package/build/interfaces/LoaderInterface.d.ts +7 -0
- package/build/interfaces/LoaderInterface.js +2 -0
- package/build/interfaces/PaginationInterface.d.ts +10 -0
- package/build/interfaces/PaginationInterface.js +2 -0
- package/build/interfaces/SortItemInterface.d.ts +4 -0
- package/build/interfaces/SortItemInterface.js +2 -0
- package/build/interfaces/UserTokenParams.d.ts +8 -0
- package/build/interfaces/UserTokenParams.js +2 -0
- package/build/interfaces/VerifyUserTokenArgs.d.ts +13 -0
- package/build/interfaces/VerifyUserTokenArgs.js +2 -0
- package/build/interfaces/index.d.ts +28 -0
- package/build/interfaces/index.js +43 -0
- package/build/knexConfigBuilder.d.ts +1 -0
- package/build/knexConfigBuilder.js +91 -0
- package/build/passwordHelpers.d.ts +5 -0
- package/build/passwordHelpers.js +21 -0
- package/build/redisClient.d.ts +17 -0
- package/build/redisClient.js +100 -0
- package/build/resolversHelpers.d.ts +3 -0
- package/build/resolversHelpers.js +69 -0
- package/build/userToken.d.ts +8 -0
- package/build/userToken.js +92 -0
- package/build/utils.d.ts +2 -0
- package/build/utils.js +21 -0
- package/package.json +1 -1
|
@@ -0,0 +1,212 @@
|
|
|
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.RedisDataLoader = void 0;
|
|
7
|
+
const lodash_1 = require("lodash");
|
|
8
|
+
const dataloader_1 = __importDefault(require("dataloader"));
|
|
9
|
+
const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
|
|
10
|
+
const customOptions = ['expire', 'serialize', 'deserialize', 'cacheKeyFn'];
|
|
11
|
+
const mapPromise = (promise, fn) => Promise.all(promise.map(fn));
|
|
12
|
+
class RedisDataLoader {
|
|
13
|
+
opt;
|
|
14
|
+
dataLoaderOpt;
|
|
15
|
+
keySpace;
|
|
16
|
+
loader;
|
|
17
|
+
redisClient;
|
|
18
|
+
static messages = {
|
|
19
|
+
keyRequired: 'The "key" parameter is required',
|
|
20
|
+
keysArrayRequired: 'The "keys" parameter is required and should be an array',
|
|
21
|
+
valueRequired: 'The "value" parameter is required',
|
|
22
|
+
valueObjectOrNull: 'The "value" parameter must be an object or null',
|
|
23
|
+
keysValuesLengths: 'The "keys" and "values" are expected to be the same',
|
|
24
|
+
};
|
|
25
|
+
constructor(redisClient, keySpace, userLoader, opt) {
|
|
26
|
+
this.redisClient = redisClient;
|
|
27
|
+
this.opt = (0, lodash_1.pick)(opt, customOptions) || {};
|
|
28
|
+
this.dataLoaderOpt = {
|
|
29
|
+
...(0, lodash_1.omit)(opt, customOptions),
|
|
30
|
+
cacheKeyFn: this.opt.cacheKeyFn,
|
|
31
|
+
};
|
|
32
|
+
this.opt.cacheKeyFn =
|
|
33
|
+
typeof this.opt.cacheKeyFn === 'function'
|
|
34
|
+
? this.opt.cacheKeyFn
|
|
35
|
+
: (key) => ((0, lodash_1.isObject)(key) ? (0, json_stable_stringify_1.default)(key) : key);
|
|
36
|
+
this.keySpace = keySpace ? keySpace + ':' : '';
|
|
37
|
+
this.loader = new dataloader_1.default(async (keys) => {
|
|
38
|
+
const results = await this.rMGet(keys);
|
|
39
|
+
const keysToRead = [];
|
|
40
|
+
const keysIdxsToRead = [];
|
|
41
|
+
keys.forEach((key, idx) => {
|
|
42
|
+
if (results[idx] == null) {
|
|
43
|
+
keysToRead.push(key);
|
|
44
|
+
keysIdxsToRead.push(idx);
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
if (keysToRead.length > 0) {
|
|
48
|
+
const loadedData = await userLoader.load(keysToRead);
|
|
49
|
+
const data = await this.rMSetAndGet(keysToRead, loadedData);
|
|
50
|
+
keysIdxsToRead.forEach((keyIdx, idx) => {
|
|
51
|
+
results[keyIdx] = data[idx];
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
return results;
|
|
55
|
+
}, this.dataLoaderOpt);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Adds a prefix to the passed key
|
|
59
|
+
* @param key Key value
|
|
60
|
+
* @returns Trasnformed key value that includes key space
|
|
61
|
+
*/
|
|
62
|
+
makeKey(key) {
|
|
63
|
+
return `${this.keySpace}${this.opt.cacheKeyFn(key)}`;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Deserializes response from Readis
|
|
67
|
+
* @param str String to deserialize
|
|
68
|
+
* @returns
|
|
69
|
+
*/
|
|
70
|
+
async parse(str) {
|
|
71
|
+
if (str === '' || str === null) {
|
|
72
|
+
return str;
|
|
73
|
+
}
|
|
74
|
+
else if (typeof this.opt.deserialize === 'function') {
|
|
75
|
+
return await this.opt.deserialize(str);
|
|
76
|
+
}
|
|
77
|
+
else {
|
|
78
|
+
return JSON.parse(str);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Serializes passed value to a string
|
|
83
|
+
* @param value A value to be serialized
|
|
84
|
+
* @returns serialized value in the form of string
|
|
85
|
+
*/
|
|
86
|
+
async toString(value) {
|
|
87
|
+
if (value === null) {
|
|
88
|
+
return '';
|
|
89
|
+
}
|
|
90
|
+
else if (typeof this.opt.serialize === 'function') {
|
|
91
|
+
return await this.opt.serialize(value);
|
|
92
|
+
}
|
|
93
|
+
else if ((0, lodash_1.isObject)(value)) {
|
|
94
|
+
return JSON.stringify(value);
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
throw new Error(RedisDataLoader.messages.valueObjectOrNull);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
async rSetAndGet(key, rawValue) {
|
|
101
|
+
const value = await this.toString(rawValue);
|
|
102
|
+
const fullKey = this.makeKey(key);
|
|
103
|
+
const multi = this.redisClient.multi();
|
|
104
|
+
multi.set(fullKey, value);
|
|
105
|
+
if (this.opt.expire) {
|
|
106
|
+
multi.expire(fullKey, this.opt.expire);
|
|
107
|
+
}
|
|
108
|
+
multi.get(fullKey);
|
|
109
|
+
const replies = await multi.exec();
|
|
110
|
+
const lastReply = (0, lodash_1.last)(replies);
|
|
111
|
+
const result = await this.parse(lastReply);
|
|
112
|
+
return result;
|
|
113
|
+
}
|
|
114
|
+
async rMSetAndGet(keys, rawValues) {
|
|
115
|
+
const multi = this.redisClient.multi();
|
|
116
|
+
const fullKeys = await mapPromise(keys, (key) => this.makeKey(key));
|
|
117
|
+
const values = await mapPromise(rawValues, (rawValue) => this.toString(rawValue));
|
|
118
|
+
multi.mSet(fullKeys.reduce((acc, fullKey, idx) => {
|
|
119
|
+
acc.push(fullKey);
|
|
120
|
+
acc.push(values[idx]);
|
|
121
|
+
return acc;
|
|
122
|
+
}, []));
|
|
123
|
+
if (this.opt.expire) {
|
|
124
|
+
for (const fullKey of fullKeys) {
|
|
125
|
+
multi.expire(fullKey, this.opt.expire);
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
multi.mGet(fullKeys);
|
|
129
|
+
const replies = await multi.exec();
|
|
130
|
+
const lastReplies = (0, lodash_1.last)(replies);
|
|
131
|
+
const result = await mapPromise(lastReplies, (lastReply) => this.parse(lastReply));
|
|
132
|
+
return result;
|
|
133
|
+
}
|
|
134
|
+
async rGet(key) {
|
|
135
|
+
const reply = await this.redisClient.get(this.makeKey(key));
|
|
136
|
+
const result = await this.parse(reply);
|
|
137
|
+
return result;
|
|
138
|
+
}
|
|
139
|
+
async rMGet(keys) {
|
|
140
|
+
const replies = await this.redisClient.mGet((0, lodash_1.map)(keys, (key) => this.makeKey(key)));
|
|
141
|
+
const results = await mapPromise(replies, (reply) => this.parse(reply));
|
|
142
|
+
return results;
|
|
143
|
+
}
|
|
144
|
+
async rSet(key, rawValue) {
|
|
145
|
+
const value = await this.toString(rawValue);
|
|
146
|
+
const reply = await this.redisClient.set(this.makeKey(key), value);
|
|
147
|
+
const result = await this.parse(reply);
|
|
148
|
+
// result is expected to be OK
|
|
149
|
+
return result;
|
|
150
|
+
}
|
|
151
|
+
async rMSet(keys, values) {
|
|
152
|
+
if (keys.length != values.length) {
|
|
153
|
+
throw new Error(RedisDataLoader.messages.keysValuesLengths);
|
|
154
|
+
}
|
|
155
|
+
const multi = this.redisClient.multi();
|
|
156
|
+
multi.mSet(keys.reduce((acc, key, idx) => {
|
|
157
|
+
acc.push(this.makeKey(key));
|
|
158
|
+
acc.push(values[idx]);
|
|
159
|
+
return acc;
|
|
160
|
+
}, []));
|
|
161
|
+
if (this.opt.expire) {
|
|
162
|
+
for (const key of keys) {
|
|
163
|
+
multi.expire(key, this.opt.expire);
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
// The reply is expected to be "OK"
|
|
167
|
+
const reply = await multi.exec();
|
|
168
|
+
return reply;
|
|
169
|
+
}
|
|
170
|
+
async rDel(key) {
|
|
171
|
+
return await this.redisClient.del(this.makeKey(key));
|
|
172
|
+
}
|
|
173
|
+
async load(key) {
|
|
174
|
+
if (!key) {
|
|
175
|
+
throw new TypeError(RedisDataLoader.messages.keyRequired);
|
|
176
|
+
}
|
|
177
|
+
return await this.loader.load(key);
|
|
178
|
+
}
|
|
179
|
+
async loadMany(keys) {
|
|
180
|
+
if (!Array.isArray(keys)) {
|
|
181
|
+
throw new TypeError(RedisDataLoader.messages.keysArrayRequired);
|
|
182
|
+
}
|
|
183
|
+
return await this.loader.loadMany(keys);
|
|
184
|
+
}
|
|
185
|
+
async prime(key, value) {
|
|
186
|
+
if (!key) {
|
|
187
|
+
throw new TypeError(RedisDataLoader.messages.keyRequired);
|
|
188
|
+
}
|
|
189
|
+
else if (value === undefined) {
|
|
190
|
+
throw new TypeError(RedisDataLoader.messages.valueRequired);
|
|
191
|
+
}
|
|
192
|
+
else {
|
|
193
|
+
const result = await this.rSetAndGet(key, value);
|
|
194
|
+
return await this.loader.clear(key).prime(key, result === '' ? null : result);
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
async clear(key) {
|
|
198
|
+
if (!key) {
|
|
199
|
+
throw new TypeError(RedisDataLoader.messages.keyRequired);
|
|
200
|
+
}
|
|
201
|
+
const resp = await this.rDel(key);
|
|
202
|
+
await this.loader.clear(key);
|
|
203
|
+
return resp;
|
|
204
|
+
}
|
|
205
|
+
async clearAllLocal() {
|
|
206
|
+
return await this.loader.clearAll();
|
|
207
|
+
}
|
|
208
|
+
async clearLocal(key) {
|
|
209
|
+
return await this.loader.clear(key);
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
exports.RedisDataLoader = RedisDataLoader;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ApiContext, ApiContextInterface } from './interfaces';
|
|
2
|
+
/**
|
|
3
|
+
* Creates a GraphQL context object with all available cores.
|
|
4
|
+
* @returns {object} A context object with all available cores
|
|
5
|
+
*/
|
|
6
|
+
export declare const createApiContext: (args: ApiContextInterface) => Promise<ApiContext>;
|
|
7
|
+
/**
|
|
8
|
+
* Creates default a GraphQL context object with all avilable cores.
|
|
9
|
+
* @returns {object} A context object with all available cores
|
|
10
|
+
*/
|
|
11
|
+
export declare const createContextDefault: (args: any) => Promise<ApiContext>;
|
|
@@ -0,0 +1,146 @@
|
|
|
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.createContextDefault = exports.createApiContext = void 0;
|
|
7
|
+
const lodash_1 = require("lodash");
|
|
8
|
+
const uuid_1 = require("uuid");
|
|
9
|
+
const check_types_1 = __importDefault(require("check-types"));
|
|
10
|
+
const utils_1 = require("@sdflc/utils");
|
|
11
|
+
const Database_1 = require("./Database");
|
|
12
|
+
const constants_1 = require("./constants");
|
|
13
|
+
/**
|
|
14
|
+
* Creates a GraphQL context object with all available cores.
|
|
15
|
+
* @returns {object} A context object with all available cores
|
|
16
|
+
*/
|
|
17
|
+
const createApiContext = async (args) => {
|
|
18
|
+
const { cores, gateways, req, res, getCoreContext, getGatewayContext, extendContext, requestId: inRequestId, } = args || {};
|
|
19
|
+
const requestId = inRequestId || (0, uuid_1.v4)();
|
|
20
|
+
const coreContext = check_types_1.default.function(getCoreContext) ? await getCoreContext({ req }) : {};
|
|
21
|
+
const gatewayContext = check_types_1.default.function(getGatewayContext) ? await getGatewayContext({ req }) : {};
|
|
22
|
+
const context = {
|
|
23
|
+
requestId,
|
|
24
|
+
cores: {},
|
|
25
|
+
gateways: {},
|
|
26
|
+
usedKeyPrefixes: {},
|
|
27
|
+
req,
|
|
28
|
+
res,
|
|
29
|
+
};
|
|
30
|
+
context.cores = Object.keys(cores || {}).reduce((acc, key) => {
|
|
31
|
+
acc[(0, lodash_1.camelCase)(key)] = new cores[key]({ ...coreContext, context });
|
|
32
|
+
return acc;
|
|
33
|
+
}, {});
|
|
34
|
+
context.gateways = Object.keys(gateways || {}).reduce((acc, key) => {
|
|
35
|
+
acc[(0, lodash_1.camelCase)(key)] = new gateways[key]({
|
|
36
|
+
...gatewayContext,
|
|
37
|
+
context,
|
|
38
|
+
});
|
|
39
|
+
return acc;
|
|
40
|
+
}, {});
|
|
41
|
+
if (check_types_1.default.function(extendContext)) {
|
|
42
|
+
await extendContext({ context, req });
|
|
43
|
+
}
|
|
44
|
+
return context;
|
|
45
|
+
};
|
|
46
|
+
exports.createApiContext = createApiContext;
|
|
47
|
+
/**
|
|
48
|
+
* Creates default a GraphQL context object with all avilable cores.
|
|
49
|
+
* @returns {object} A context object with all available cores
|
|
50
|
+
*/
|
|
51
|
+
const createContextDefault = async (args) => {
|
|
52
|
+
const { knexConfig, isProduction, logger, doAuth, spaceGw, interserviceApiKey, jwtSecret, verifyTokenArgs, dbType, dbSchema, cores, gateways, req, res, extendContext, getCoreContext, getGatewayContext, authorizationToken, db: inDb, } = args || {};
|
|
53
|
+
const headers = req.headers || { noHeadersSetup: true };
|
|
54
|
+
const cookies = req.cookies || { noCookiesSetup: true };
|
|
55
|
+
const authorization = (headers[constants_1.HEADERS.AUTHORIZATION] || authorizationToken || '').replace('Bearer ', '');
|
|
56
|
+
const fingerprint = headers[constants_1.HEADERS.FINGERPRINT] || '';
|
|
57
|
+
const spaceId = headers[constants_1.HEADERS.SPACE_ID];
|
|
58
|
+
const apiKey = headers[constants_1.HEADERS.API_KEY];
|
|
59
|
+
const managementApiKey = headers[constants_1.HEADERS.MANAGEMENT_API_KEY];
|
|
60
|
+
const userAgent = headers[constants_1.HEADERS.USER_AGENT];
|
|
61
|
+
const referer = headers[constants_1.HEADERS.REFERER];
|
|
62
|
+
const ipAddress = headers[constants_1.HEADERS.IP_ADDRESS] || req.connection.remoteAddress;
|
|
63
|
+
const acceptLanguage = headers[constants_1.HEADERS.ACCEPT_LANGUAGE];
|
|
64
|
+
const languages = (0, utils_1.extractLanguages)(acceptLanguage);
|
|
65
|
+
const requestedLang = headers[constants_1.HEADERS.REQUESTED_LANGUAGE] || languages?.[0] || 'en';
|
|
66
|
+
// const accountId = headers[HEADERS.ACCOUNT_ID];
|
|
67
|
+
// const roleId = headers[HEADERS.ROLE_ID];
|
|
68
|
+
// const userId = headers[HEADERS.USER_ID];
|
|
69
|
+
const requestId = (0, uuid_1.v4)();
|
|
70
|
+
const db = inDb
|
|
71
|
+
? inDb
|
|
72
|
+
: new Database_1.Database({
|
|
73
|
+
dbType: dbType || knexConfig.client || '',
|
|
74
|
+
knexConfig,
|
|
75
|
+
dbSchema,
|
|
76
|
+
logger,
|
|
77
|
+
});
|
|
78
|
+
const sharedContext = {
|
|
79
|
+
spaceId,
|
|
80
|
+
apiKey,
|
|
81
|
+
managementApiKey,
|
|
82
|
+
userAgent,
|
|
83
|
+
referer,
|
|
84
|
+
ipAddress,
|
|
85
|
+
acceptLanguage,
|
|
86
|
+
languages,
|
|
87
|
+
requestedLang,
|
|
88
|
+
authorization,
|
|
89
|
+
fingerprint,
|
|
90
|
+
// accountId,
|
|
91
|
+
// roleId,
|
|
92
|
+
// userId,
|
|
93
|
+
req,
|
|
94
|
+
res,
|
|
95
|
+
headers,
|
|
96
|
+
cookies,
|
|
97
|
+
authorizationToken,
|
|
98
|
+
isExternalDb: !!inDb,
|
|
99
|
+
};
|
|
100
|
+
return await (0, exports.createApiContext)({
|
|
101
|
+
cores,
|
|
102
|
+
gateways,
|
|
103
|
+
req,
|
|
104
|
+
res,
|
|
105
|
+
requestId,
|
|
106
|
+
extendContext: async ({ context, req }) => {
|
|
107
|
+
context.db = db;
|
|
108
|
+
Object.assign(context, sharedContext);
|
|
109
|
+
if (check_types_1.default.function(extendContext)) {
|
|
110
|
+
await extendContext({ context, req });
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
getCoreContext: async (args) => {
|
|
114
|
+
// TODO: const { req } = args;
|
|
115
|
+
let extendCoreConext = {};
|
|
116
|
+
if (check_types_1.default.function(getCoreContext)) {
|
|
117
|
+
extendCoreConext = await getCoreContext(args);
|
|
118
|
+
}
|
|
119
|
+
return {
|
|
120
|
+
db,
|
|
121
|
+
gatewayName: '',
|
|
122
|
+
isProduction,
|
|
123
|
+
logger,
|
|
124
|
+
doAuth,
|
|
125
|
+
spaceGw,
|
|
126
|
+
interserviceApiKey,
|
|
127
|
+
jwtSecret,
|
|
128
|
+
verifyTokenArgs,
|
|
129
|
+
...(extendCoreConext || {}),
|
|
130
|
+
};
|
|
131
|
+
},
|
|
132
|
+
getGatewayContext: async (args) => {
|
|
133
|
+
let extendGatewayConext = {};
|
|
134
|
+
if (check_types_1.default.function(getGatewayContext)) {
|
|
135
|
+
extendGatewayConext = await getGatewayContext(args);
|
|
136
|
+
}
|
|
137
|
+
return {
|
|
138
|
+
db,
|
|
139
|
+
isProduction,
|
|
140
|
+
logger,
|
|
141
|
+
...(extendGatewayConext || {}),
|
|
142
|
+
};
|
|
143
|
+
},
|
|
144
|
+
});
|
|
145
|
+
};
|
|
146
|
+
exports.createContextDefault = createContextDefault;
|
|
@@ -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,63 @@
|
|
|
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
|
+
/**
|
|
11
|
+
* Base class for REST API controllers.
|
|
12
|
+
*/
|
|
13
|
+
class BaseController {
|
|
14
|
+
onResponse;
|
|
15
|
+
logger;
|
|
16
|
+
constructor(props) {
|
|
17
|
+
if (check_types_1.default.function(props?.onResponse)) {
|
|
18
|
+
this.onResponse = props?.onResponse;
|
|
19
|
+
}
|
|
20
|
+
else {
|
|
21
|
+
this.onResponse = () => {
|
|
22
|
+
/* TODO */
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
this.logger = props?.logger instanceof utils_1.Logger ? props.logger : new utils_1.Logger({ level: utils_1.LoggerLevels.ERROR });
|
|
26
|
+
}
|
|
27
|
+
init(props) {
|
|
28
|
+
// const { app } = props;
|
|
29
|
+
// set express app routes here:
|
|
30
|
+
// app.post(`${root}/event-webhook`, this.json(this.eventWebhook));
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Executes an action method and returns result in consistent way.
|
|
34
|
+
* @param method a function to be executed
|
|
35
|
+
* @returns HTTP response
|
|
36
|
+
*/
|
|
37
|
+
json(method) {
|
|
38
|
+
return async (req, res, next) => {
|
|
39
|
+
try {
|
|
40
|
+
const result = await method(req, res, next);
|
|
41
|
+
if (result instanceof api_helpers_1.OpResult) {
|
|
42
|
+
res.status(result.getHttpStatus()).json(result.toJS());
|
|
43
|
+
}
|
|
44
|
+
else if (result?.redirectUrl) {
|
|
45
|
+
res.redirect(result?.redirectUrl);
|
|
46
|
+
next();
|
|
47
|
+
}
|
|
48
|
+
else if (result) {
|
|
49
|
+
res.status(200).json(result);
|
|
50
|
+
}
|
|
51
|
+
else {
|
|
52
|
+
res.status(204).json(new api_helpers_1.OpResult());
|
|
53
|
+
}
|
|
54
|
+
await this.onResponse(req, res, next);
|
|
55
|
+
}
|
|
56
|
+
catch (ex) {
|
|
57
|
+
this.logger.log(`An exception has occured when processing REST API request on the entry point '${req.method} ${req.originalUrl}' from ${req.ip}`);
|
|
58
|
+
next(ex);
|
|
59
|
+
}
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.BaseController = BaseController;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createErrorOnCheckError = exports.checkArray = void 0;
|
|
4
|
+
const api_helpers_1 = require("@sdflc/api-helpers");
|
|
5
|
+
const checkArray = (arr, validator, prefix) => {
|
|
6
|
+
const result = new api_helpers_1.OpResult();
|
|
7
|
+
if (!Array.isArray(arr)) {
|
|
8
|
+
return result.addError(prefix || '', 'The value should be an array');
|
|
9
|
+
}
|
|
10
|
+
arr.forEach((item, idx) => {
|
|
11
|
+
const [itemResult] = validator.validateSync(item);
|
|
12
|
+
if (itemResult) {
|
|
13
|
+
Object.keys(itemResult.errors).forEach((key) => {
|
|
14
|
+
result.addError(`${prefix || ''}[${idx}].${key}`, itemResult.errors[key].message);
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
return result;
|
|
19
|
+
};
|
|
20
|
+
exports.checkArray = checkArray;
|
|
21
|
+
const createErrorOnCheckError = (checkItResult) => {
|
|
22
|
+
const result = new api_helpers_1.OpResult({ code: api_helpers_1.OP_RESULT_CODES.VALIDATION_FAILED });
|
|
23
|
+
Object.keys(checkItResult.errors).forEach((key) => {
|
|
24
|
+
result.addError(key, checkItResult.errors[key].message);
|
|
25
|
+
});
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
exports.createErrorOnCheckError = createErrorOnCheckError;
|
|
@@ -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<{}[] | {}[]>;
|