@sdflc/backend-helpers 1.0.106 → 1.0.107
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 +734 -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 +59 -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 +728 -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 +53 -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 +15 -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 +15 -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,88 @@
|
|
|
1
|
+
import { OpResult } from '@sdflc/api-helpers';
|
|
2
|
+
import { Logger, MeasureTool } from '@sdflc/utils';
|
|
3
|
+
import { ID_TYPES } from './constants';
|
|
4
|
+
import { Database } from './Database';
|
|
5
|
+
import { BaseCorePropsInterface, BaseCoreActionsInterface, CoreActionInterface, JwtTokenSecretAndSettings, ApiContext, ExtractCredentialsArgs, ListArgsInterface } from './interfaces';
|
|
6
|
+
declare class BaseCore {
|
|
7
|
+
protected measureTool: MeasureTool;
|
|
8
|
+
protected config: BaseCorePropsInterface;
|
|
9
|
+
protected logger: Logger;
|
|
10
|
+
constructor(props: BaseCorePropsInterface);
|
|
11
|
+
getIdType(): ID_TYPES;
|
|
12
|
+
getDb(): Database;
|
|
13
|
+
getRequestId(): string;
|
|
14
|
+
getContext(): ApiContext;
|
|
15
|
+
getGateways(): any;
|
|
16
|
+
getGateway(name?: string): any;
|
|
17
|
+
getValidators(): any;
|
|
18
|
+
success(data: any, code?: number): any;
|
|
19
|
+
failure(code: number, errorMsg: string, data?: any): any;
|
|
20
|
+
validationFailure(ex: OpResult | any): any;
|
|
21
|
+
exceptionFailure(ex: any, doingWhat: string, data?: any): any;
|
|
22
|
+
checkResult(args: any): Promise<void>;
|
|
23
|
+
runAction(opt: CoreActionInterface): Promise<any>;
|
|
24
|
+
list(args: ListArgsInterface): Promise<any>;
|
|
25
|
+
get(args: any): Promise<any>;
|
|
26
|
+
getMany(args: any): Promise<any>;
|
|
27
|
+
getGatewayToSetOrerNo(): any;
|
|
28
|
+
getFilterToSetOrderNo(args: any): {};
|
|
29
|
+
create(args: any): Promise<any>;
|
|
30
|
+
createMany(args: any): Promise<any>;
|
|
31
|
+
update(args: any): Promise<any>;
|
|
32
|
+
updateMany(args: any): Promise<any>;
|
|
33
|
+
set(args: any): Promise<any>;
|
|
34
|
+
remove(args: any): Promise<any>;
|
|
35
|
+
removeMany(args: any): Promise<any>;
|
|
36
|
+
defaultAfterAndBefore(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
37
|
+
/**
|
|
38
|
+
* Used to transform an object before sending it in the response
|
|
39
|
+
* @param {any} item An object coming from the database
|
|
40
|
+
* @param {BaseCoreActionsInterface} opt Options
|
|
41
|
+
* @returns {any} transformed object
|
|
42
|
+
*/
|
|
43
|
+
processItemOnOut(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
44
|
+
/**
|
|
45
|
+
* Used to transform an object before processing it on the request
|
|
46
|
+
* @param {any} item An object coming from the outside
|
|
47
|
+
* @param {BaseCoreActionsInterface} opt Options
|
|
48
|
+
* @returns {any} transformed object
|
|
49
|
+
*/
|
|
50
|
+
processItemOnIn(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
51
|
+
beforeGet(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
52
|
+
beforeGetMany(items: any[], opt?: BaseCoreActionsInterface): Promise<any>;
|
|
53
|
+
beforeList(filter: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
54
|
+
afterGet(item: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
55
|
+
afterGetMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
56
|
+
afterList(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
57
|
+
beforeCreate(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
58
|
+
afterCreate(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
59
|
+
beforeCreateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
60
|
+
afterCreateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
61
|
+
beforeUpdate(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
62
|
+
afterUpdate(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
63
|
+
beforeUpdateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
64
|
+
afterUpdateMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
65
|
+
beforeSet(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
66
|
+
afterSet(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
67
|
+
beforeRemove(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
68
|
+
afterRemove(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
69
|
+
beforeRemoveMany(params: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
70
|
+
afterRemoveMany(items: any, opt?: BaseCoreActionsInterface): Promise<any>;
|
|
71
|
+
onException(params: any, opt?: BaseCoreActionsInterface): Promise<string | null | undefined>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns JWT secret and its settings to verify received JWT token
|
|
74
|
+
* @param params Object of parameters passed to the authenticate method
|
|
75
|
+
* @returns Object with the jwtSecret and verifyTokenArgs
|
|
76
|
+
*/
|
|
77
|
+
getJwtTokenSecretAndSettings(params: any): Promise<JwtTokenSecretAndSettings>;
|
|
78
|
+
findSpace(): Promise<any[]>;
|
|
79
|
+
extractCredentials(args: ExtractCredentialsArgs): Promise<{
|
|
80
|
+
token: any;
|
|
81
|
+
fingerprint: any;
|
|
82
|
+
}>;
|
|
83
|
+
authenticate(params: any, opt?: BaseCoreActionsInterface): Promise<any[]>;
|
|
84
|
+
processRemovedRecord(record: any): any;
|
|
85
|
+
addRemovedModifierToFields(fields: string | string[]): any;
|
|
86
|
+
setOrderNo(args: any): Promise<void>;
|
|
87
|
+
}
|
|
88
|
+
export { BaseCore };
|