@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.
Files changed (209) hide show
  1. package/build/BaseCore.d.ts +88 -0
  2. package/build/BaseCore.js +736 -0
  3. package/build/BaseGateway.d.ts +56 -0
  4. package/build/BaseGateway.js +477 -0
  5. package/build/DataCache.d.ts +16 -0
  6. package/build/DataCache.js +113 -0
  7. package/build/Database.d.ts +36 -0
  8. package/build/Database.js +195 -0
  9. package/build/DbMigratorAndSeeder.d.ts +49 -0
  10. package/build/DbMigratorAndSeeder.js +212 -0
  11. package/build/RedisDataLoader.d.ts +41 -0
  12. package/build/RedisDataLoader.js +212 -0
  13. package/build/apiContext.d.ts +11 -0
  14. package/build/apiContext.js +146 -0
  15. package/build/baseController.d.ts +17 -0
  16. package/build/baseController.js +63 -0
  17. package/build/checkItHelpers.d.ts +3 -0
  18. package/build/checkItHelpers.js +28 -0
  19. package/build/commonValidators.d.ts +17 -0
  20. package/build/commonValidators.js +311 -0
  21. package/build/configBulder.d.ts +2 -0
  22. package/build/configBulder.js +36 -0
  23. package/build/constants.d.ts +30 -0
  24. package/build/constants.js +80 -0
  25. package/build/dbHelpers.d.ts +43 -0
  26. package/build/dbHelpers.js +156 -0
  27. package/build/dbSeeder.d.ts +2 -0
  28. package/build/dbSeeder.js +83 -0
  29. package/build/dbTableHelpers.d.ts +14 -0
  30. package/build/dbTableHelpers.js +118 -0
  31. package/build/downloadHelpers.d.ts +2 -0
  32. package/build/downloadHelpers.js +73 -0
  33. package/build/esm/BaseCore.d.ts +88 -0
  34. package/build/esm/BaseCore.js +730 -0
  35. package/build/esm/BaseGateway.d.ts +56 -0
  36. package/build/esm/BaseGateway.js +471 -0
  37. package/build/esm/DataCache.d.ts +16 -0
  38. package/build/esm/DataCache.js +107 -0
  39. package/build/esm/Database.d.ts +36 -0
  40. package/build/esm/Database.js +189 -0
  41. package/build/esm/DbMigratorAndSeeder.d.ts +49 -0
  42. package/build/esm/DbMigratorAndSeeder.js +173 -0
  43. package/build/esm/RedisDataLoader.d.ts +41 -0
  44. package/build/esm/RedisDataLoader.js +206 -0
  45. package/build/esm/apiContext.d.ts +11 -0
  46. package/build/esm/apiContext.js +138 -0
  47. package/build/esm/baseController.d.ts +17 -0
  48. package/build/esm/baseController.js +57 -0
  49. package/build/esm/checkItHelpers.d.ts +3 -0
  50. package/build/esm/checkItHelpers.js +23 -0
  51. package/build/esm/commonValidators.d.ts +17 -0
  52. package/build/esm/commonValidators.js +291 -0
  53. package/build/esm/configBulder.d.ts +2 -0
  54. package/build/esm/configBulder.js +32 -0
  55. package/build/esm/constants.d.ts +30 -0
  56. package/build/esm/constants.js +69 -0
  57. package/build/esm/dbHelpers.d.ts +43 -0
  58. package/build/esm/dbHelpers.js +144 -0
  59. package/build/esm/dbSeeder.d.ts +2 -0
  60. package/build/esm/dbSeeder.js +44 -0
  61. package/build/esm/dbTableHelpers.d.ts +14 -0
  62. package/build/esm/dbTableHelpers.js +106 -0
  63. package/build/esm/downloadHelpers.d.ts +2 -0
  64. package/build/esm/downloadHelpers.js +66 -0
  65. package/build/esm/index.d.ts +21 -0
  66. package/build/esm/index.js +21 -0
  67. package/build/esm/interfaces/ApiContext.d.ts +25 -0
  68. package/build/esm/interfaces/ApiContext.js +1 -0
  69. package/build/esm/interfaces/ApiContextInterface.d.ts +12 -0
  70. package/build/esm/interfaces/ApiContextInterface.js +1 -0
  71. package/build/esm/interfaces/BaseCoreActionsInterface.d.ts +38 -0
  72. package/build/esm/interfaces/BaseCoreActionsInterface.js +1 -0
  73. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
  74. package/build/esm/interfaces/BaseCoreDoAuthOnActionInterface.js +1 -0
  75. package/build/esm/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
  76. package/build/esm/interfaces/BaseCoreDoingWhatInterface.js +1 -0
  77. package/build/esm/interfaces/BaseCorePropsInterface.d.ts +37 -0
  78. package/build/esm/interfaces/BaseCorePropsInterface.js +1 -0
  79. package/build/esm/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
  80. package/build/esm/interfaces/BaseCoreValidatorsInterface.js +1 -0
  81. package/build/esm/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
  82. package/build/esm/interfaces/BaseGatewayPropsInterface.js +1 -0
  83. package/build/esm/interfaces/BuildConfigOptions.d.ts +6 -0
  84. package/build/esm/interfaces/BuildConfigOptions.js +1 -0
  85. package/build/esm/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
  86. package/build/esm/interfaces/BuildDefaultResolversOptions.js +1 -0
  87. package/build/esm/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
  88. package/build/esm/interfaces/BuildListQueryArgsInterface.js +1 -0
  89. package/build/esm/interfaces/CacheInterface.d.ts +15 -0
  90. package/build/esm/interfaces/CacheInterface.js +1 -0
  91. package/build/esm/interfaces/CommonValidatorArgs.d.ts +3 -0
  92. package/build/esm/interfaces/CommonValidatorArgs.js +1 -0
  93. package/build/esm/interfaces/CoreActionInterface.d.ts +16 -0
  94. package/build/esm/interfaces/CoreActionInterface.js +1 -0
  95. package/build/esm/interfaces/CreateUserTokenArgs.d.ts +11 -0
  96. package/build/esm/interfaces/CreateUserTokenArgs.js +1 -0
  97. package/build/esm/interfaces/CreateUserTokenResult.d.ts +4 -0
  98. package/build/esm/interfaces/CreateUserTokenResult.js +1 -0
  99. package/build/esm/interfaces/DatabaseOptions.d.ts +26 -0
  100. package/build/esm/interfaces/DatabaseOptions.js +1 -0
  101. package/build/esm/interfaces/DatabaseReadInterface.d.ts +14 -0
  102. package/build/esm/interfaces/DatabaseReadInterface.js +1 -0
  103. package/build/esm/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
  104. package/build/esm/interfaces/DbFieldAddDefaultInterface.js +1 -0
  105. package/build/esm/interfaces/DownloadFileArgs.d.ts +6 -0
  106. package/build/esm/interfaces/DownloadFileArgs.js +1 -0
  107. package/build/esm/interfaces/ExtractCredentialsArgs.d.ts +19 -0
  108. package/build/esm/interfaces/ExtractCredentialsArgs.js +1 -0
  109. package/build/esm/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
  110. package/build/esm/interfaces/JwtTokenSecretAndSettings.js +1 -0
  111. package/build/esm/interfaces/ListArgsInterface.d.ts +7 -0
  112. package/build/esm/interfaces/ListArgsInterface.js +1 -0
  113. package/build/esm/interfaces/LoaderInterface.d.ts +7 -0
  114. package/build/esm/interfaces/LoaderInterface.js +1 -0
  115. package/build/esm/interfaces/PaginationInterface.d.ts +10 -0
  116. package/build/esm/interfaces/PaginationInterface.js +1 -0
  117. package/build/esm/interfaces/SortItemInterface.d.ts +4 -0
  118. package/build/esm/interfaces/SortItemInterface.js +1 -0
  119. package/build/esm/interfaces/UserTokenParams.d.ts +8 -0
  120. package/build/esm/interfaces/UserTokenParams.js +1 -0
  121. package/build/esm/interfaces/VerifyUserTokenArgs.d.ts +13 -0
  122. package/build/esm/interfaces/VerifyUserTokenArgs.js +1 -0
  123. package/build/esm/interfaces/index.d.ts +28 -0
  124. package/build/esm/interfaces/index.js +27 -0
  125. package/build/esm/knexConfigBuilder.d.ts +1 -0
  126. package/build/esm/knexConfigBuilder.js +84 -0
  127. package/build/esm/passwordHelpers.d.ts +5 -0
  128. package/build/esm/passwordHelpers.js +13 -0
  129. package/build/esm/redisClient.d.ts +17 -0
  130. package/build/esm/redisClient.js +97 -0
  131. package/build/esm/resolversHelpers.d.ts +3 -0
  132. package/build/esm/resolversHelpers.js +66 -0
  133. package/build/esm/userToken.d.ts +8 -0
  134. package/build/esm/userToken.js +80 -0
  135. package/build/esm/utils.d.ts +2 -0
  136. package/build/esm/utils.js +13 -0
  137. package/build/index.d.ts +21 -0
  138. package/build/index.js +37 -0
  139. package/build/interfaces/ApiContext.d.ts +25 -0
  140. package/build/interfaces/ApiContext.js +2 -0
  141. package/build/interfaces/ApiContextInterface.d.ts +12 -0
  142. package/build/interfaces/ApiContextInterface.js +2 -0
  143. package/build/interfaces/BaseCoreActionsInterface.d.ts +38 -0
  144. package/build/interfaces/BaseCoreActionsInterface.js +2 -0
  145. package/build/interfaces/BaseCoreDoAuthOnActionInterface.d.ts +12 -0
  146. package/build/interfaces/BaseCoreDoAuthOnActionInterface.js +2 -0
  147. package/build/interfaces/BaseCoreDoingWhatInterface.d.ts +13 -0
  148. package/build/interfaces/BaseCoreDoingWhatInterface.js +2 -0
  149. package/build/interfaces/BaseCorePropsInterface.d.ts +37 -0
  150. package/build/interfaces/BaseCorePropsInterface.js +2 -0
  151. package/build/interfaces/BaseCoreValidatorsInterface.d.ts +13 -0
  152. package/build/interfaces/BaseCoreValidatorsInterface.js +2 -0
  153. package/build/interfaces/BaseGatewayPropsInterface.d.ts +39 -0
  154. package/build/interfaces/BaseGatewayPropsInterface.js +2 -0
  155. package/build/interfaces/BuildConfigOptions.d.ts +6 -0
  156. package/build/interfaces/BuildConfigOptions.js +2 -0
  157. package/build/interfaces/BuildDefaultResolversOptions.d.ts +17 -0
  158. package/build/interfaces/BuildDefaultResolversOptions.js +2 -0
  159. package/build/interfaces/BuildListQueryArgsInterface.d.ts +6 -0
  160. package/build/interfaces/BuildListQueryArgsInterface.js +2 -0
  161. package/build/interfaces/CacheInterface.d.ts +15 -0
  162. package/build/interfaces/CacheInterface.js +2 -0
  163. package/build/interfaces/CommonValidatorArgs.d.ts +3 -0
  164. package/build/interfaces/CommonValidatorArgs.js +2 -0
  165. package/build/interfaces/CoreActionInterface.d.ts +16 -0
  166. package/build/interfaces/CoreActionInterface.js +2 -0
  167. package/build/interfaces/CreateUserTokenArgs.d.ts +11 -0
  168. package/build/interfaces/CreateUserTokenArgs.js +2 -0
  169. package/build/interfaces/CreateUserTokenResult.d.ts +4 -0
  170. package/build/interfaces/CreateUserTokenResult.js +2 -0
  171. package/build/interfaces/DatabaseOptions.d.ts +26 -0
  172. package/build/interfaces/DatabaseOptions.js +2 -0
  173. package/build/interfaces/DatabaseReadInterface.d.ts +14 -0
  174. package/build/interfaces/DatabaseReadInterface.js +2 -0
  175. package/build/interfaces/DbFieldAddDefaultInterface.d.ts +9 -0
  176. package/build/interfaces/DbFieldAddDefaultInterface.js +2 -0
  177. package/build/interfaces/DownloadFileArgs.d.ts +6 -0
  178. package/build/interfaces/DownloadFileArgs.js +2 -0
  179. package/build/interfaces/ExtractCredentialsArgs.d.ts +19 -0
  180. package/build/interfaces/ExtractCredentialsArgs.js +2 -0
  181. package/build/interfaces/JwtTokenSecretAndSettings.d.ts +5 -0
  182. package/build/interfaces/JwtTokenSecretAndSettings.js +2 -0
  183. package/build/interfaces/ListArgsInterface.d.ts +7 -0
  184. package/build/interfaces/ListArgsInterface.js +2 -0
  185. package/build/interfaces/LoaderInterface.d.ts +7 -0
  186. package/build/interfaces/LoaderInterface.js +2 -0
  187. package/build/interfaces/PaginationInterface.d.ts +10 -0
  188. package/build/interfaces/PaginationInterface.js +2 -0
  189. package/build/interfaces/SortItemInterface.d.ts +4 -0
  190. package/build/interfaces/SortItemInterface.js +2 -0
  191. package/build/interfaces/UserTokenParams.d.ts +8 -0
  192. package/build/interfaces/UserTokenParams.js +2 -0
  193. package/build/interfaces/VerifyUserTokenArgs.d.ts +13 -0
  194. package/build/interfaces/VerifyUserTokenArgs.js +2 -0
  195. package/build/interfaces/index.d.ts +28 -0
  196. package/build/interfaces/index.js +43 -0
  197. package/build/knexConfigBuilder.d.ts +1 -0
  198. package/build/knexConfigBuilder.js +91 -0
  199. package/build/passwordHelpers.d.ts +5 -0
  200. package/build/passwordHelpers.js +21 -0
  201. package/build/redisClient.d.ts +17 -0
  202. package/build/redisClient.js +100 -0
  203. package/build/resolversHelpers.d.ts +3 -0
  204. package/build/resolversHelpers.js +69 -0
  205. package/build/userToken.d.ts +8 -0
  206. package/build/userToken.js +92 -0
  207. package/build/utils.d.ts +2 -0
  208. package/build/utils.js +21 -0
  209. package/package.json +1 -1
@@ -0,0 +1,39 @@
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
+ table?: string;
9
+ idField?: string;
10
+ idFieldUpdateRemove?: string;
11
+ idFieldAs?: string;
12
+ setFields?: string[] | string;
13
+ mergeFields?: string[];
14
+ hasStatus?: boolean;
15
+ hasCreatedBy?: boolean;
16
+ hasUpdatedBy?: boolean;
17
+ hasRemovedBy?: boolean;
18
+ hasCreatedAt?: boolean;
19
+ hasUpdatedAt?: boolean;
20
+ hasRemovedAt?: boolean;
21
+ hasRemovedAtStr?: boolean;
22
+ hasSpace?: boolean;
23
+ hasVersion?: boolean;
24
+ hasLang?: boolean;
25
+ hasUserId?: boolean;
26
+ localizationForField?: string;
27
+ defaultSorting?: SortItemInterface[];
28
+ fieldForKeyword?: string;
29
+ filterByUserField?: string;
30
+ insertChunkSize?: number;
31
+ hardRemove?: boolean;
32
+ loader?: LoaderInterface;
33
+ noCache?: boolean;
34
+ returnFields?: any[];
35
+ activeStatuses?: number[];
36
+ logger: Logger;
37
+ isProduction: boolean;
38
+ usedKeyPrefixes?: any;
39
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ export interface BuildConfigOptions {
2
+ envFile?: string;
3
+ envFileExample?: string;
4
+ defaultNodeEnv?: string;
5
+ allowEmptyValues?: boolean;
6
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,17 @@
1
+ export interface BuildDefaultResolvers {
2
+ prefix: string;
3
+ core: string;
4
+ query?: any;
5
+ mutation?: any;
6
+ types?: any;
7
+ disableList?: boolean;
8
+ disableGet?: boolean;
9
+ disableGetMany?: boolean;
10
+ disableCreate?: boolean;
11
+ disableCreateMany?: boolean;
12
+ disableUpdate?: boolean;
13
+ disableUpdateMany?: boolean;
14
+ disableSet?: boolean;
15
+ disableRemove?: boolean;
16
+ disableRemoveMany?: boolean;
17
+ }
@@ -0,0 +1,6 @@
1
+ export interface BuildListQueryArgsInterface {
2
+ filter: any;
3
+ params: any;
4
+ fieldsToUse: any;
5
+ useCache: boolean;
6
+ }
@@ -0,0 +1,15 @@
1
+ import { Database } from '../Database';
2
+ export interface CacheInterface {
3
+ db: Database;
4
+ keyPrefix?: string;
5
+ context?: any;
6
+ table?: string;
7
+ idField?: string;
8
+ idFieldAs?: string;
9
+ selectFields?: any[];
10
+ readAll?: boolean;
11
+ redisClient?: any;
12
+ cacheTtl?: number;
13
+ loaderFn?(args?: any): any;
14
+ buildKey?(args: any): string;
15
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,3 @@
1
+ export interface CommonValidatorArgs {
2
+ rules: any;
3
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,16 @@
1
+ import { BaseCoreActionsInterface } from './BaseCoreActionsInterface';
2
+ export interface CoreActionInterface {
3
+ args: any;
4
+ actionName?: string;
5
+ doAuth?: boolean;
6
+ accessRights?: any[];
7
+ roles?: string[];
8
+ validate?(args: any, opt: BaseCoreActionsInterface): Promise<any[]> | any[];
9
+ action(args?: any, opt?: any): any;
10
+ hasTransaction: boolean;
11
+ doingWhat?: string;
12
+ onException?(params: any, opt?: BaseCoreActionsInterface): Promise<any | undefined | null>;
13
+ shouldLogArgs?: boolean;
14
+ requireSpace?: boolean;
15
+ skipCheckResult?: boolean;
16
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,11 @@
1
+ export interface CreateUserTokenArgs {
2
+ algorithm?: any;
3
+ audience?: string | string[];
4
+ issuer?: string;
5
+ jwtid?: string;
6
+ noTimestamp?: boolean;
7
+ header?: any;
8
+ keyid?: any;
9
+ expiresIn?: number;
10
+ useFingerprint?: boolean;
11
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface CreateUserTokenResult {
2
+ token: string;
3
+ fingerprint: string;
4
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,26 @@
1
+ import { Logger } from '@sdflc/utils';
2
+ /**
3
+ * Interface to initialize Database object
4
+ */
5
+ export interface DatabaseOptions {
6
+ /**
7
+ * Knex configuration object
8
+ */
9
+ knexConfig: any;
10
+ /**
11
+ * Database type: pg, msql, etc
12
+ */
13
+ dbType: string;
14
+ /**
15
+ * Name of database schema
16
+ */
17
+ dbSchema: string;
18
+ /**
19
+ * Knex transaction object
20
+ */
21
+ trx?: any;
22
+ /**
23
+ * Logger for debugging/logging
24
+ */
25
+ logger?: Logger;
26
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Interface for Database.ReadAll method
3
+ */
4
+ export interface DatabaseReadInterface {
5
+ table?: string;
6
+ selectFields?: string[];
7
+ sortBy?: any;
8
+ where?: any;
9
+ whereIn?: any;
10
+ extendQuery?(query: any): any;
11
+ mapBy?: string;
12
+ calculated?: any[];
13
+ buildKey?(key: string): string;
14
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ export interface DbFieldAddDefaultInterface {
2
+ addUserInfo?: boolean;
3
+ addVersion?: boolean;
4
+ addStatus?: boolean;
5
+ skipTimestamps?: boolean;
6
+ skipRemovedAtStr?: boolean;
7
+ statusComment?: string;
8
+ versionComment?: string;
9
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ export interface DownloadFileArgs {
2
+ url: string;
3
+ fileName: string;
4
+ folder?: string;
5
+ stream?: any;
6
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,19 @@
1
+ export interface ExtractCredentialsArgs {
2
+ /**
3
+ * Req is a request object of the Express library
4
+ */
5
+ req: any;
6
+ /**
7
+ * Space is an object with configuration where to get data from
8
+ */
9
+ space: any;
10
+ /**
11
+ * Authorization is a token from the Authorization header
12
+ */
13
+ authorization?: string;
14
+ fingerprint?: string;
15
+ /**
16
+ * An object with parameters passed to the authenticate methods
17
+ */
18
+ params?: any;
19
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { VerifyUserTokenArgs } from '..';
2
+ export interface JwtTokenSecretAndSettings {
3
+ jwtSecret: string;
4
+ verifyTokenArgs?: VerifyUserTokenArgs;
5
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ import { PaginationAndSortingInterface } from '..';
2
+ export interface ListArgsInterface {
3
+ filter: any;
4
+ params?: PaginationAndSortingInterface;
5
+ useCache?: boolean;
6
+ skipAuth?: boolean;
7
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ export interface LoaderInterface {
2
+ load(id: any): Promise<any>;
3
+ loadMany(id: any): Promise<any[]>;
4
+ clear(key: any | any[]): this;
5
+ clearAll(): this;
6
+ prime(key: any, value: any): this;
7
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,10 @@
1
+ import { SortItemInterface } from './SortItemInterface';
2
+ export interface PaginationInterface {
3
+ page?: number;
4
+ pageSize?: number;
5
+ cursor?: string;
6
+ }
7
+ export interface PaginationAndSortingInterface {
8
+ pagination?: PaginationInterface;
9
+ sortBy: SortItemInterface[];
10
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface SortItemInterface {
2
+ name: string;
3
+ order: string;
4
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface UserTokenParams {
2
+ spaceId: string;
3
+ accountId: string;
4
+ roleId: string;
5
+ userId: string;
6
+ lang: string;
7
+ [tokenProp: string]: string;
8
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,13 @@
1
+ export interface VerifyUserTokenArgs {
2
+ algorithms?: any;
3
+ audience?: string | string[];
4
+ issuer?: string | string[];
5
+ ignoreExpiration?: boolean;
6
+ ignoreNotBefore?: boolean;
7
+ subject?: string;
8
+ clockTolerance?: number;
9
+ maxAge?: number;
10
+ clockTimestamp?: number;
11
+ nonce?: string;
12
+ fingerprint?: string;
13
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ export { CacheInterface } from './CacheInterface';
2
+ export * from './LoaderInterface';
3
+ export * from './BaseGatewayPropsInterface';
4
+ export * from './ListArgsInterface';
5
+ export * from './SortItemInterface';
6
+ export * from './PaginationInterface';
7
+ export * from './BaseCorePropsInterface';
8
+ export * from './CoreActionInterface';
9
+ export * from './ApiContextInterface';
10
+ export * from './ApiContext';
11
+ export * from './DbFieldAddDefaultInterface';
12
+ export * from './BuildConfigOptions';
13
+ export * from './DatabaseOptions';
14
+ export * from './DatabaseReadInterface';
15
+ export * from './BuildDefaultResolversOptions';
16
+ export * from './BaseCoreValidatorsInterface';
17
+ export * from './UserTokenParams';
18
+ export * from './CreateUserTokenArgs';
19
+ export * from './VerifyUserTokenArgs';
20
+ export * from './BaseCoreActionsInterface';
21
+ export * from './BaseCoreDoingWhatInterface';
22
+ export * from './JwtTokenSecretAndSettings';
23
+ export * from './CommonValidatorArgs';
24
+ export * from './CreateUserTokenResult';
25
+ export * from './ExtractCredentialsArgs';
26
+ export * from './DownloadFileArgs';
27
+ export * from './BuildListQueryArgsInterface';
28
+ export * from './BaseCoreDoAuthOnActionInterface';
@@ -0,0 +1,27 @@
1
+ export * from './LoaderInterface';
2
+ export * from './BaseGatewayPropsInterface';
3
+ export * from './ListArgsInterface';
4
+ export * from './SortItemInterface';
5
+ export * from './PaginationInterface';
6
+ export * from './BaseCorePropsInterface';
7
+ export * from './CoreActionInterface';
8
+ export * from './ApiContextInterface';
9
+ export * from './ApiContext';
10
+ export * from './DbFieldAddDefaultInterface';
11
+ export * from './BuildConfigOptions';
12
+ export * from './DatabaseOptions';
13
+ export * from './DatabaseReadInterface';
14
+ export * from './BuildDefaultResolversOptions';
15
+ export * from './BaseCoreValidatorsInterface';
16
+ export * from './UserTokenParams';
17
+ export * from './CreateUserTokenArgs';
18
+ export * from './VerifyUserTokenArgs';
19
+ export * from './BaseCoreActionsInterface';
20
+ export * from './BaseCoreDoingWhatInterface';
21
+ export * from './JwtTokenSecretAndSettings';
22
+ export * from './CommonValidatorArgs';
23
+ export * from './CreateUserTokenResult';
24
+ export * from './ExtractCredentialsArgs';
25
+ export * from './DownloadFileArgs';
26
+ export * from './BuildListQueryArgsInterface';
27
+ export * from './BaseCoreDoAuthOnActionInterface';
@@ -0,0 +1 @@
1
+ export declare const buildKnexConfig: (dirName: string, appConfig: any) => any;
@@ -0,0 +1,84 @@
1
+ import path from 'path';
2
+ import { snakeCase, get } from 'lodash';
3
+ import { camelKeys } from '@sdflc/utils';
4
+ const defaultMigrationsTable = 'migrations';
5
+ const defaultMigrationsFolder = 'migrations';
6
+ const defaultMigrationsTemplateFileName = 'migrations-template.js';
7
+ const defaultSeedsFolder = 'seeds';
8
+ const camelResponse = (result) => {
9
+ if (!result || result.rows) {
10
+ return result;
11
+ }
12
+ return camelKeys(result);
13
+ };
14
+ export const buildKnexConfig = (dirName, appConfig) => {
15
+ const { dbType, dbHost, dbPort, dbName, dbSchema, dbUser, dbPassword, dbPoolMin, dbPoolMax, debug, nodeEnv, migrationsTemplateFileName, migrationsFolder, migrationsTable, useSchemaForMigrationsTable, seedsFolder, seedsFolderDev, seedsFolderProd, wrapIdentifierOverrideMap, dbPool, } = appConfig;
16
+ const sharedConfig = {
17
+ client: dbType || 'pg',
18
+ postProcessResponse: camelResponse,
19
+ wrapIdentifier: (value, origImpl) => {
20
+ if (value === '*') {
21
+ return origImpl(value);
22
+ }
23
+ const value2use = wrapIdentifierOverrideMap?.[value] || origImpl(snakeCase(value));
24
+ return value2use;
25
+ },
26
+ connection: {
27
+ host: dbHost,
28
+ port: dbPort,
29
+ user: dbUser,
30
+ password: dbPassword,
31
+ database: dbName,
32
+ //ssl: database.ssl,
33
+ },
34
+ };
35
+ if (typeof dbPool === 'object') {
36
+ sharedConfig.pool = dbPool;
37
+ }
38
+ else {
39
+ sharedConfig.pool = {
40
+ min: dbPoolMin != null && !isNaN(dbPoolMin) ? dbPoolMin : 0,
41
+ max: dbPoolMax != null && !isNaN(dbPoolMax) ? dbPoolMax : 50,
42
+ acquireTimeoutMillis: 30000,
43
+ createTimeoutMillis: 30000,
44
+ destroyTimeoutMillis: 5000,
45
+ idleTimeoutMillis: 30000,
46
+ reapIntervalMillis: 1000,
47
+ createRetryIntervalMillis: 200,
48
+ propagateCreateError: false,
49
+ };
50
+ }
51
+ const config = {
52
+ development: {
53
+ ...sharedConfig,
54
+ debug,
55
+ migrations: {
56
+ // https://knexjs.org/guide/migrations.html#migration-api
57
+ stub: path.join(dirName, migrationsTemplateFileName || defaultMigrationsTemplateFileName),
58
+ directory: path.join(dirName, migrationsFolder || defaultMigrationsFolder),
59
+ schemaName: useSchemaForMigrationsTable ? dbSchema : undefined,
60
+ tableName: migrationsTable || defaultMigrationsTable,
61
+ },
62
+ seeds: {
63
+ directory: path.join(dirName, seedsFolderDev || seedsFolder || defaultSeedsFolder),
64
+ },
65
+ },
66
+ production: {
67
+ ...sharedConfig,
68
+ debug,
69
+ migrations: {
70
+ directory: path.join(dirName, migrationsFolder || defaultMigrationsFolder),
71
+ schemaName: useSchemaForMigrationsTable ? dbSchema : undefined,
72
+ tableName: migrationsTable || defaultMigrationsTable,
73
+ },
74
+ seeds: {
75
+ directory: path.join(dirName, seedsFolderProd || seedsFolder || defaultSeedsFolder),
76
+ },
77
+ },
78
+ };
79
+ let config2use = get(config, nodeEnv);
80
+ if (!config2use) {
81
+ config2use = config.development;
82
+ }
83
+ return config2use;
84
+ };
@@ -0,0 +1,5 @@
1
+ export declare const getSaltAndHash: (password: string, saltRounds?: number) => Promise<{
2
+ salt: string;
3
+ hash: string;
4
+ }>;
5
+ export declare const checkPassword: (password: string, hashedPassword: string) => Promise<boolean>;
@@ -0,0 +1,13 @@
1
+ import bcrypt from 'bcrypt';
2
+ export const getSaltAndHash = async (password, saltRounds = 10) => {
3
+ const salt = await bcrypt.genSalt(saltRounds);
4
+ const hash = await bcrypt.hash(password, salt);
5
+ return {
6
+ salt,
7
+ hash,
8
+ };
9
+ };
10
+ export const checkPassword = async (password, hashedPassword) => {
11
+ const isCorrect = await bcrypt.compare(password, hashedPassword);
12
+ return isCorrect;
13
+ };
@@ -0,0 +1,17 @@
1
+ interface CreateRedisClientInterface {
2
+ redisHost: string;
3
+ redisPort: string | number;
4
+ redisPassword: string;
5
+ redisSsl: boolean;
6
+ retryAttempts?: number;
7
+ firstTimeout?: number;
8
+ pingInterval?: number;
9
+ connectionTimeout?: number;
10
+ onConnecting?(): void;
11
+ onConnected?(): void;
12
+ onDisconnected?(): void;
13
+ onReconnecting?(): void;
14
+ onError?(err: any): void;
15
+ }
16
+ declare const createRedisClient: (args: CreateRedisClientInterface) => any;
17
+ export { createRedisClient };
@@ -0,0 +1,97 @@
1
+ import { createClient } from 'redis';
2
+ // const DEFAULT_RETRY_ATTEMPTS = 10;
3
+ // const DEFAULT_FIRST_TIMEOUT = 3000;
4
+ const createRedisClient = (args) => {
5
+ const { redisHost, redisPort, redisPassword, redisSsl,
6
+ //retryAttempts,
7
+ //firstTimeout,
8
+ pingInterval, connectionTimeout, onConnecting, onConnected, onDisconnected, onReconnecting, onError, } = args || {};
9
+ if (!redisHost) {
10
+ return null;
11
+ }
12
+ const baseSocketConfig = {
13
+ host: redisHost,
14
+ port: Number(redisPort),
15
+ family: 0,
16
+ connectTimeout: connectionTimeout != undefined ? connectionTimeout : 5000,
17
+ noDelay: true,
18
+ keepAlive: true,
19
+ keepAliveInitialDelay: pingInterval != undefined ? pingInterval : 5000,
20
+ reconnectStrategy: (retries) => Math.min(retries * 50, 500),
21
+ };
22
+ const socketConfig = redisSsl
23
+ ? { ...baseSocketConfig, tls: true, rejectUnauthorized: false }
24
+ : { ...baseSocketConfig, tls: false };
25
+ const cfg = {
26
+ socket: socketConfig,
27
+ password: redisPassword || undefined,
28
+ };
29
+ const redisClient = createClient(cfg);
30
+ redisClient.on('connect', () => {
31
+ if (typeof onConnecting === 'function') {
32
+ onConnecting();
33
+ }
34
+ });
35
+ redisClient.on('ready', () => {
36
+ if (typeof onConnected === 'function') {
37
+ onConnected();
38
+ }
39
+ });
40
+ redisClient.on('end', () => {
41
+ if (typeof onDisconnected === 'function') {
42
+ onDisconnected();
43
+ }
44
+ });
45
+ redisClient.on('reconnecting', () => {
46
+ if (typeof onReconnecting === 'function') {
47
+ onReconnecting();
48
+ }
49
+ });
50
+ redisClient.on('error', (err) => {
51
+ if (typeof onError === 'function') {
52
+ onError(err);
53
+ }
54
+ });
55
+ // const redisClientOld = redis.createClient({
56
+ // host: redisHost,
57
+ // port: Number(redisPort),
58
+ // password: redisPassword || undefined,
59
+ // no_ready_check: true,
60
+ // retry_strategy: function (options) {
61
+ // if (options.error && options.error.code === 'ECONNREFUSED') {
62
+ // // End reconnecting on a specific error and flush all commands with
63
+ // // a individual error
64
+ // return new Error('The server refused the connection');
65
+ // }
66
+ // if (options.total_retry_time > 1000 * 60 * 60) {
67
+ // // End reconnecting after a specific timeout and flush all commands
68
+ // // with a individual error
69
+ // return new Error('Retry time exhausted');
70
+ // }
71
+ // const attempts =
72
+ // !retryAttempts || retryAttempts == null || isNaN(retryAttempts)
73
+ // ? DEFAULT_RETRY_ATTEMPTS
74
+ // : Number(retryAttempts);
75
+ // if (options.attempt > attempts) {
76
+ // // End reconnecting with built in error
77
+ // return undefined;
78
+ // }
79
+ // const timeout =
80
+ // !firstTimeout || firstTimeout == null || isNaN(firstTimeout) ? DEFAULT_FIRST_TIMEOUT : Number(firstTimeout);
81
+ // // reconnect after
82
+ // return Math.min(options.attempt * 100, timeout);
83
+ // },
84
+ // tls: redisSsl
85
+ // ? {
86
+ // servername: redisHost,
87
+ // }
88
+ // : undefined,
89
+ // });
90
+ // if (pingInterval && !isNaN(pingInterval) && pingInterval > 1000) {
91
+ // setInterval(async () => {
92
+ // redisClient.ping();
93
+ // }, pingInterval);
94
+ // }
95
+ return redisClient;
96
+ };
97
+ export { createRedisClient };
@@ -0,0 +1,3 @@
1
+ import { BuildDefaultResolvers } from './interfaces';
2
+ declare const buildDefaultResolvers: (args: BuildDefaultResolvers) => any;
3
+ export { buildDefaultResolvers };