@ruiapp/rapid-core 0.9.9 → 0.10.1

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 (198) hide show
  1. package/CHANGELOG.md +11 -11
  2. package/dist/bootstrapApplicationConfig.d.ts +51 -0
  3. package/dist/index.js +168 -40
  4. package/dist/plugins/auth/services/AuthService.d.ts +7 -1
  5. package/dist/types.d.ts +4 -0
  6. package/package.json +1 -1
  7. package/rollup.config.js +16 -16
  8. package/src/bootstrapApplicationConfig.ts +897 -782
  9. package/src/core/actionHandler.ts +23 -23
  10. package/src/core/eventManager.ts +20 -20
  11. package/src/core/facility.ts +7 -7
  12. package/src/core/http/formDataParser.ts +89 -89
  13. package/src/core/http-types.ts +4 -4
  14. package/src/core/pluginManager.ts +193 -193
  15. package/src/core/providers/runtimeProvider.ts +5 -5
  16. package/src/core/request.ts +96 -96
  17. package/src/core/response.ts +79 -79
  18. package/src/core/routeContext.ts +127 -127
  19. package/src/core/routes/healthz.ts +20 -20
  20. package/src/core/routes/index.ts +3 -3
  21. package/src/core/routesBuilder.ts +110 -110
  22. package/src/core/server.ts +156 -156
  23. package/src/dataAccess/columnTypeMapper.ts +22 -22
  24. package/src/dataAccess/dataAccessTypes.ts +165 -165
  25. package/src/dataAccess/dataAccessor.ts +135 -135
  26. package/src/dataAccess/entityManager.ts +1932 -1932
  27. package/src/dataAccess/entityMapper.ts +111 -111
  28. package/src/dataAccess/entityValidator.ts +33 -33
  29. package/src/dataAccess/propertyMapper.ts +28 -28
  30. package/src/deno-std/assert/assert.ts +9 -9
  31. package/src/deno-std/assert/assertion_error.ts +7 -7
  32. package/src/deno-std/datetime/to_imf.ts +32 -32
  33. package/src/deno-std/encoding/base64.ts +141 -141
  34. package/src/deno-std/http/cookie.ts +372 -372
  35. package/src/facilities/cache/CacheFacilityTypes.ts +29 -29
  36. package/src/facilities/cache/CacheFactory.ts +31 -31
  37. package/src/facilities/cache/MemoryCache.ts +58 -58
  38. package/src/facilities/cache/MemoryCacheProvider.ts +15 -15
  39. package/src/facilities/log/LogFacility.ts +35 -35
  40. package/src/helpers/entityHelper.ts +89 -89
  41. package/src/helpers/filterHelper.ts +148 -148
  42. package/src/helpers/inputHelper.ts +11 -11
  43. package/src/helpers/licenseHelper.ts +29 -29
  44. package/src/helpers/metaHelper.ts +111 -111
  45. package/src/helpers/runCollectionEntityActionHandler.ts +58 -58
  46. package/src/index.ts +82 -82
  47. package/src/plugins/auth/AuthPlugin.ts +107 -103
  48. package/src/plugins/auth/AuthPluginTypes.ts +11 -11
  49. package/src/plugins/auth/actionHandlers/changePassword.ts +61 -61
  50. package/src/plugins/auth/actionHandlers/createSession.ts +68 -68
  51. package/src/plugins/auth/actionHandlers/deleteSession.ts +18 -18
  52. package/src/plugins/auth/actionHandlers/getMyProfile.ts +28 -38
  53. package/src/plugins/auth/actionHandlers/index.ts +8 -8
  54. package/src/plugins/auth/actionHandlers/resetPassword.ts +45 -45
  55. package/src/plugins/auth/models/AccessToken.ts +56 -56
  56. package/src/plugins/auth/models/index.ts +3 -3
  57. package/src/plugins/auth/routes/changePassword.ts +15 -15
  58. package/src/plugins/auth/routes/getMyProfile.ts +15 -15
  59. package/src/plugins/auth/routes/index.ts +7 -7
  60. package/src/plugins/auth/routes/resetPassword.ts +15 -15
  61. package/src/plugins/auth/routes/signin.ts +15 -15
  62. package/src/plugins/auth/routes/signout.ts +15 -15
  63. package/src/plugins/auth/services/AuthService.ts +66 -39
  64. package/src/plugins/cronJob/CronJobPlugin.ts +104 -104
  65. package/src/plugins/cronJob/CronJobPluginTypes.ts +44 -44
  66. package/src/plugins/cronJob/actionHandlers/index.ts +4 -4
  67. package/src/plugins/cronJob/actionHandlers/runCronJob.ts +32 -32
  68. package/src/plugins/cronJob/entityWatchers/cronJobEntityWatchers.ts +24 -24
  69. package/src/plugins/cronJob/entityWatchers/index.ts +4 -4
  70. package/src/plugins/cronJob/models/CronJob.ts +129 -129
  71. package/src/plugins/cronJob/models/index.ts +3 -3
  72. package/src/plugins/cronJob/routes/index.ts +3 -3
  73. package/src/plugins/cronJob/routes/runCronJob.ts +15 -15
  74. package/src/plugins/cronJob/services/CronJobService.ts +252 -252
  75. package/src/plugins/dataManage/DataManagePlugin.ts +163 -163
  76. package/src/plugins/dataManage/actionHandlers/addEntityRelations.ts +15 -15
  77. package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts +17 -17
  78. package/src/plugins/dataManage/actionHandlers/createCollectionEntitiesBatch.ts +81 -81
  79. package/src/plugins/dataManage/actionHandlers/createCollectionEntity.ts +20 -20
  80. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntities.ts +45 -45
  81. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntityById.ts +20 -20
  82. package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts +27 -27
  83. package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts +30 -30
  84. package/src/plugins/dataManage/actionHandlers/queryDatabase.ts +22 -22
  85. package/src/plugins/dataManage/actionHandlers/removeEntityRelations.ts +15 -15
  86. package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts +38 -38
  87. package/src/plugins/entityAccessControl/EntityAccessControlPlugin.ts +146 -146
  88. package/src/plugins/fileManage/FileManagePlugin.ts +52 -52
  89. package/src/plugins/fileManage/actionHandlers/downloadDocument.ts +65 -65
  90. package/src/plugins/fileManage/actionHandlers/downloadFile.ts +44 -44
  91. package/src/plugins/fileManage/actionHandlers/uploadFile.ts +33 -33
  92. package/src/plugins/fileManage/routes/downloadDocument.ts +15 -15
  93. package/src/plugins/fileManage/routes/downloadFile.ts +15 -15
  94. package/src/plugins/fileManage/routes/index.ts +5 -5
  95. package/src/plugins/fileManage/routes/uploadFile.ts +15 -15
  96. package/src/plugins/license/LicensePlugin.ts +79 -79
  97. package/src/plugins/license/LicensePluginTypes.ts +95 -95
  98. package/src/plugins/license/LicenseService.ts +137 -137
  99. package/src/plugins/license/actionHandlers/getLicense.ts +18 -18
  100. package/src/plugins/license/actionHandlers/index.ts +5 -5
  101. package/src/plugins/license/actionHandlers/updateLicense.ts +24 -24
  102. package/src/plugins/license/helpers/certHelper.ts +21 -21
  103. package/src/plugins/license/helpers/cryptoHelper.ts +47 -47
  104. package/src/plugins/license/models/index.ts +1 -1
  105. package/src/plugins/license/routes/getLicense.ts +15 -15
  106. package/src/plugins/license/routes/index.ts +4 -4
  107. package/src/plugins/license/routes/updateLicense.ts +15 -15
  108. package/src/plugins/mail/MailPlugin.ts +74 -74
  109. package/src/plugins/mail/MailPluginTypes.ts +27 -27
  110. package/src/plugins/mail/MailService.ts +38 -38
  111. package/src/plugins/mail/actionHandlers/index.ts +3 -3
  112. package/src/plugins/mail/models/index.ts +1 -1
  113. package/src/plugins/mail/routes/index.ts +1 -1
  114. package/src/plugins/metaManage/MetaManagePlugin.ts +198 -198
  115. package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts +10 -10
  116. package/src/plugins/metaManage/actionHandlers/listMetaModels.ts +9 -9
  117. package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts +9 -9
  118. package/src/plugins/metaManage/services/MetaService.ts +376 -376
  119. package/src/plugins/notification/NotificationPlugin.ts +68 -68
  120. package/src/plugins/notification/NotificationPluginTypes.ts +13 -13
  121. package/src/plugins/notification/NotificationService.ts +25 -25
  122. package/src/plugins/notification/actionHandlers/index.ts +3 -3
  123. package/src/plugins/notification/models/Notification.ts +60 -60
  124. package/src/plugins/notification/models/index.ts +3 -3
  125. package/src/plugins/notification/routes/index.ts +1 -1
  126. package/src/plugins/routeManage/RouteManagePlugin.ts +64 -64
  127. package/src/plugins/routeManage/actionHandlers/httpProxy.ts +13 -13
  128. package/src/plugins/routeManage/actionHandlers/mock.ts +28 -28
  129. package/src/plugins/sequence/SequencePlugin.ts +146 -146
  130. package/src/plugins/sequence/SequencePluginTypes.ts +69 -69
  131. package/src/plugins/sequence/SequenceService.ts +92 -92
  132. package/src/plugins/sequence/actionHandlers/generateSn.ts +32 -32
  133. package/src/plugins/sequence/actionHandlers/index.ts +4 -4
  134. package/src/plugins/sequence/models/SequenceAutoIncrementRecord.ts +49 -49
  135. package/src/plugins/sequence/models/SequenceRule.ts +42 -42
  136. package/src/plugins/sequence/models/index.ts +4 -4
  137. package/src/plugins/sequence/routes/generateSn.ts +15 -15
  138. package/src/plugins/sequence/routes/index.ts +3 -3
  139. package/src/plugins/sequence/segment-utility.ts +11 -11
  140. package/src/plugins/sequence/segments/autoIncrement.ts +90 -90
  141. package/src/plugins/sequence/segments/dayOfMonth.ts +19 -19
  142. package/src/plugins/sequence/segments/index.ts +9 -9
  143. package/src/plugins/sequence/segments/literal.ts +16 -16
  144. package/src/plugins/sequence/segments/month.ts +19 -19
  145. package/src/plugins/sequence/segments/parameter.ts +20 -20
  146. package/src/plugins/sequence/segments/year.ts +19 -19
  147. package/src/plugins/serverOperation/ServerOperationPlugin.ts +91 -91
  148. package/src/plugins/serverOperation/ServerOperationPluginTypes.ts +15 -15
  149. package/src/plugins/serverOperation/actionHandlers/index.ts +4 -4
  150. package/src/plugins/serverOperation/actionHandlers/runServerOperation.ts +15 -15
  151. package/src/plugins/setting/SettingPlugin.ts +68 -68
  152. package/src/plugins/setting/SettingPluginTypes.ts +37 -37
  153. package/src/plugins/setting/SettingService.ts +213 -213
  154. package/src/plugins/setting/actionHandlers/getSystemSettingValues.ts +30 -30
  155. package/src/plugins/setting/actionHandlers/getUserSettingValues.ts +38 -38
  156. package/src/plugins/setting/actionHandlers/index.ts +6 -6
  157. package/src/plugins/setting/actionHandlers/setSystemSettingValues.ts +30 -30
  158. package/src/plugins/setting/models/SystemSettingGroupSetting.ts +57 -57
  159. package/src/plugins/setting/models/SystemSettingItem.ts +48 -48
  160. package/src/plugins/setting/models/SystemSettingItemSetting.ts +73 -73
  161. package/src/plugins/setting/models/UserSettingGroupSetting.ts +57 -57
  162. package/src/plugins/setting/models/UserSettingItem.ts +55 -55
  163. package/src/plugins/setting/models/UserSettingItemSetting.ts +73 -73
  164. package/src/plugins/setting/models/index.ts +8 -8
  165. package/src/plugins/setting/routes/getSystemSettingValues.ts +15 -15
  166. package/src/plugins/setting/routes/getUserSettingValues.ts +15 -15
  167. package/src/plugins/setting/routes/index.ts +5 -5
  168. package/src/plugins/setting/routes/setSystemSettingValues.ts +15 -15
  169. package/src/plugins/stateMachine/StateMachinePlugin.ts +196 -196
  170. package/src/plugins/stateMachine/StateMachinePluginTypes.ts +48 -48
  171. package/src/plugins/stateMachine/actionHandlers/index.ts +4 -4
  172. package/src/plugins/stateMachine/actionHandlers/sendStateMachineEvent.ts +54 -54
  173. package/src/plugins/stateMachine/models/StateMachine.ts +42 -42
  174. package/src/plugins/stateMachine/models/index.ts +3 -3
  175. package/src/plugins/stateMachine/routes/index.ts +3 -3
  176. package/src/plugins/stateMachine/routes/sendStateMachineEvent.ts +15 -15
  177. package/src/plugins/stateMachine/stateMachineHelper.ts +36 -36
  178. package/src/plugins/webhooks/WebhooksPlugin.ts +148 -148
  179. package/src/plugins/webhooks/pluginConfig.ts +75 -75
  180. package/src/polyfill.ts +5 -5
  181. package/src/proxy/mod.ts +38 -38
  182. package/src/proxy/types.ts +21 -21
  183. package/src/queryBuilder/index.ts +1 -1
  184. package/src/queryBuilder/queryBuilder.ts +755 -755
  185. package/src/server.ts +530 -530
  186. package/src/types/cron-job-types.ts +66 -66
  187. package/src/types.ts +862 -856
  188. package/src/utilities/accessControlUtility.ts +33 -33
  189. package/src/utilities/entityUtility.ts +18 -18
  190. package/src/utilities/errorUtility.ts +15 -15
  191. package/src/utilities/fsUtility.ts +137 -137
  192. package/src/utilities/httpUtility.ts +19 -19
  193. package/src/utilities/jwtUtility.ts +26 -26
  194. package/src/utilities/passwordUtility.ts +26 -26
  195. package/src/utilities/pathUtility.ts +14 -14
  196. package/src/utilities/timeUtility.ts +17 -17
  197. package/src/utilities/typeUtility.ts +15 -15
  198. package/tsconfig.json +19 -19
@@ -1,110 +1,110 @@
1
- import Router from "koa-tree-router";
2
- import qs from "qs";
3
- import { ActionHandlerContext } from "~/core/actionHandler";
4
- import { IRpdServer } from "~/core/server";
5
- import { RpdApplicationConfig } from "~/types";
6
- import { isNullOrUndefined } from "~/utilities/typeUtility";
7
- import { Next, RouteContext } from "./routeContext";
8
- import { cloneDeep, isFunction, isString } from "lodash";
9
-
10
- export async function buildRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
11
- const logger = server.getLogger();
12
- const router = new Router();
13
-
14
- let baseUrl = server.config.baseUrl;
15
- if (baseUrl) {
16
- if (baseUrl.endsWith("/")) {
17
- baseUrl = baseUrl.substring(0, baseUrl.length - 1);
18
- }
19
- } else {
20
- baseUrl = "";
21
- }
22
-
23
- applicationConfig.routes.forEach((routeConfig) => {
24
- if (routeConfig.type !== "RESTful") {
25
- return;
26
- }
27
-
28
- const routePath = baseUrl + routeConfig.endpoint;
29
-
30
- (router as any)[routeConfig.method.toLowerCase()](routePath, async (routerContext: RouteContext, next: Next) => {
31
- routerContext.routeConfig = cloneDeep(routeConfig);
32
- const { request, params } = routerContext;
33
-
34
- let search = request.url.search;
35
- if (search && search.startsWith("?")) {
36
- search = search.substring(1);
37
- }
38
- const query = qs.parse(search);
39
- const input = Object.assign({}, params, query);
40
-
41
- const requestMethod = request.method;
42
- if (requestMethod === "POST" || requestMethod === "PUT" || requestMethod === "PATCH") {
43
- const body = request.body;
44
- if (body) {
45
- Object.assign(input, body.value);
46
- }
47
- }
48
-
49
- // Normalize input value
50
-
51
- logger.debug("Processing rapid request.", {
52
- method: requestMethod,
53
- url: request.url.toString(),
54
- input,
55
- });
56
-
57
- routerContext.response.status = 200;
58
-
59
- let handlerContext: ActionHandlerContext = {
60
- logger,
61
- routerContext,
62
- next,
63
- server,
64
- applicationConfig,
65
- input,
66
- };
67
-
68
- await server.beforeRunRouteActions(handlerContext);
69
-
70
- let handler = routeConfig.handler as any;
71
- if (handler) {
72
- if (isString(handler)) {
73
- handler = new Function(`return (${routeConfig.handler})`) as any;
74
- }
75
-
76
- if (isFunction(handler)) {
77
- const result = handler(handlerContext);
78
- if (result instanceof Promise) {
79
- await result;
80
- }
81
- } else {
82
- throw new Error(`Invalid handler for route ${routeConfig.code}: ${routeConfig.handler}`);
83
- }
84
- } else if (routeConfig.actions) {
85
- for (const actionConfig of routeConfig.actions) {
86
- const actionCode = actionConfig.code;
87
- const handler = server.getActionHandlerByCode(actionCode);
88
- if (!handler) {
89
- throw new Error("Unknown handler: " + actionCode);
90
- }
91
-
92
- await server.beforeRunActionHandler(handlerContext, actionConfig);
93
-
94
- const result = handler(handlerContext, actionConfig.config);
95
- if (result instanceof Promise) {
96
- await result;
97
- }
98
- }
99
- } else {
100
- throw new Error(`No handler or actions defined for route ${routeConfig.code}`);
101
- }
102
-
103
- if (!isNullOrUndefined(handlerContext.output)) {
104
- routerContext.json(handlerContext.output, handlerContext.status);
105
- }
106
- });
107
- });
108
-
109
- return router.routes();
110
- }
1
+ import Router from "koa-tree-router";
2
+ import qs from "qs";
3
+ import { ActionHandlerContext } from "~/core/actionHandler";
4
+ import { IRpdServer } from "~/core/server";
5
+ import { RpdApplicationConfig } from "~/types";
6
+ import { isNullOrUndefined } from "~/utilities/typeUtility";
7
+ import { Next, RouteContext } from "./routeContext";
8
+ import { cloneDeep, isFunction, isString } from "lodash";
9
+
10
+ export async function buildRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
11
+ const logger = server.getLogger();
12
+ const router = new Router();
13
+
14
+ let baseUrl = server.config.baseUrl;
15
+ if (baseUrl) {
16
+ if (baseUrl.endsWith("/")) {
17
+ baseUrl = baseUrl.substring(0, baseUrl.length - 1);
18
+ }
19
+ } else {
20
+ baseUrl = "";
21
+ }
22
+
23
+ applicationConfig.routes.forEach((routeConfig) => {
24
+ if (routeConfig.type !== "RESTful") {
25
+ return;
26
+ }
27
+
28
+ const routePath = baseUrl + routeConfig.endpoint;
29
+
30
+ (router as any)[routeConfig.method.toLowerCase()](routePath, async (routerContext: RouteContext, next: Next) => {
31
+ routerContext.routeConfig = cloneDeep(routeConfig);
32
+ const { request, params } = routerContext;
33
+
34
+ let search = request.url.search;
35
+ if (search && search.startsWith("?")) {
36
+ search = search.substring(1);
37
+ }
38
+ const query = qs.parse(search);
39
+ const input = Object.assign({}, params, query);
40
+
41
+ const requestMethod = request.method;
42
+ if (requestMethod === "POST" || requestMethod === "PUT" || requestMethod === "PATCH") {
43
+ const body = request.body;
44
+ if (body) {
45
+ Object.assign(input, body.value);
46
+ }
47
+ }
48
+
49
+ // Normalize input value
50
+
51
+ logger.debug("Processing rapid request.", {
52
+ method: requestMethod,
53
+ url: request.url.toString(),
54
+ input,
55
+ });
56
+
57
+ routerContext.response.status = 200;
58
+
59
+ let handlerContext: ActionHandlerContext = {
60
+ logger,
61
+ routerContext,
62
+ next,
63
+ server,
64
+ applicationConfig,
65
+ input,
66
+ };
67
+
68
+ await server.beforeRunRouteActions(handlerContext);
69
+
70
+ let handler = routeConfig.handler as any;
71
+ if (handler) {
72
+ if (isString(handler)) {
73
+ handler = new Function(`return (${routeConfig.handler})`) as any;
74
+ }
75
+
76
+ if (isFunction(handler)) {
77
+ const result = handler(handlerContext);
78
+ if (result instanceof Promise) {
79
+ await result;
80
+ }
81
+ } else {
82
+ throw new Error(`Invalid handler for route ${routeConfig.code}: ${routeConfig.handler}`);
83
+ }
84
+ } else if (routeConfig.actions) {
85
+ for (const actionConfig of routeConfig.actions) {
86
+ const actionCode = actionConfig.code;
87
+ const handler = server.getActionHandlerByCode(actionCode);
88
+ if (!handler) {
89
+ throw new Error("Unknown handler: " + actionCode);
90
+ }
91
+
92
+ await server.beforeRunActionHandler(handlerContext, actionConfig);
93
+
94
+ const result = handler(handlerContext, actionConfig.config);
95
+ if (result instanceof Promise) {
96
+ await result;
97
+ }
98
+ }
99
+ } else {
100
+ throw new Error(`No handler or actions defined for route ${routeConfig.code}`);
101
+ }
102
+
103
+ if (!isNullOrUndefined(handlerContext.output)) {
104
+ routerContext.json(handlerContext.output, handlerContext.status);
105
+ }
106
+ });
107
+ });
108
+
109
+ return router.routes();
110
+ }
@@ -1,156 +1,156 @@
1
- import {
2
- CreateEntityOptions,
3
- EmitServerEventOptions,
4
- EntityWatcherType,
5
- GetDataAccessorOptions,
6
- GetModelOptions,
7
- IDatabaseAccessor,
8
- IDatabaseClient,
9
- IDatabaseConfig,
10
- IQueryBuilder,
11
- IRpdDataAccessor,
12
- RapidServerConfig,
13
- RpdApplicationConfig,
14
- RpdDataModel,
15
- RpdDataModelProperty,
16
- RpdRouteActionConfig,
17
- RpdServerEventTypes,
18
- UpdateEntityByIdOptions,
19
- } from "~/types";
20
- import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
21
- import { Next, RouteContext } from "./routeContext";
22
- import EntityManager from "~/dataAccess/entityManager";
23
- import { Logger } from "~/facilities/log/LogFacility";
24
- import { FacilityFactory } from "./facility";
25
- import { CronJobConfiguration } from "~/types/cron-job-types";
26
- import { RapidRequest } from "./request";
27
-
28
- export interface IRpdServer {
29
- config: RapidServerConfig;
30
- databaseConfig: IDatabaseConfig;
31
- queryBuilder: IQueryBuilder;
32
- getLogger(): Logger;
33
-
34
- registerFacilityFactory(factory: FacilityFactory);
35
-
36
- getFacility<TFacility = any, TOptions = any>(name: string, options?: TOptions): Promise<TFacility>;
37
-
38
- getDatabaseAccessor(): IDatabaseAccessor;
39
- queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>, client?: IDatabaseClient, dropErrorLog?: boolean) => Promise<any[]>;
40
- tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>, client?: IDatabaseClient, dropErrorLog?: boolean) => Promise<any[]>;
41
- registerMiddleware(middleware: any): void;
42
- registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
43
- getActionHandlerByCode(code: string): ActionHandler | undefined;
44
- getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
45
- getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
46
- registerService(name: string, service: any);
47
- getService<TService>(name: string): TService;
48
- getApplicationConfig(): RpdApplicationConfig;
49
- appendApplicationConfig(config: Partial<RpdApplicationConfig>);
50
- appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
51
- getModel(options: GetModelOptions): RpdDataModel | undefined;
52
- registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
53
- registerEntityWatcher(entityWatcher: EntityWatcherType);
54
- emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
55
- handleRequest(request: RapidRequest, next: Next): Promise<Response>;
56
- beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
57
- beforeRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig): Promise<void>;
58
- beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
59
- beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
60
-
61
- registerCronJob(job: CronJobConfiguration): void;
62
- listCronJobs(): CronJobConfiguration[];
63
- }
64
-
65
- export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
66
-
67
- export interface RpdConfigurationItemOptions {
68
- /**
69
- * 配置项名称。可以包含中文。
70
- */
71
- name: string;
72
- /**
73
- * 配置项代码。
74
- */
75
- code: string;
76
- /**
77
- * 配置项类型。
78
- */
79
- type: RpdConfigurationItemTypes;
80
- /**
81
- * 是否必须有值。默认为 false。
82
- */
83
- required?: boolean;
84
- /**
85
- * 默认值。使用默认值的 JavaScript 字面量表示。
86
- */
87
- defaultValue?: string;
88
- }
89
-
90
- export type RpdServerPluginExtendingAbilities =
91
- | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
92
- | /** 是指增加系统中的集合的能力。 */ "extendModel"
93
- | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
94
- | /** 是指增加接口动作的能力。 */ "extendActionHandler"
95
- | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
96
- | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
97
- | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
98
- | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
99
- | /** 对特定任务进行处理的能力。 */ "processTask";
100
-
101
- export interface RpdServerPluginConfigurableTargetOptions {
102
- targetCode: string;
103
-
104
- configurations: RpdConfigurationItemOptions[];
105
- }
106
-
107
- export interface RapidPlugin {
108
- /** 插件代码 */
109
- get code(): string;
110
- /** 插件描述 */
111
- get description(): string;
112
- /** 插件可以提供哪些扩展能力 */
113
- get extendingAbilities(): RpdServerPluginExtendingAbilities[];
114
- /** 插件可以配置的目标实体,以及和配置目标相关的配置项 */
115
- get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
116
- /** 插件的全局配置项 */
117
- get configurations(): RpdConfigurationItemOptions[];
118
- /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
119
- initPlugin?: (server: IRpdServer) => Promise<any>;
120
- /** 注册中间件 */
121
- registerMiddlewares?: (server: IRpdServer) => Promise<any>;
122
- /** 注册接口动作处理程序 */
123
- registerActionHandlers?: (server: IRpdServer) => Promise<any>;
124
- /** 注册事件处理程序 */
125
- registerEventHandlers?: (server: IRpdServer) => Promise<any>;
126
- /** 注册消息处理程序 */
127
- registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
128
- /** 注册任务处理程序 */
129
- registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
130
- /** 在加载应用前调用。 */
131
- onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
132
- /** 配置数据集合 */
133
- configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
134
- /** 配置模型属性 */
135
- configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
136
- /** 配置服务 */
137
- configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
138
- /** 配置路由 */
139
- configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
140
- /** 注册定时任务 */
141
- registerCronJobs?: (server: IRpdServer) => Promise<any>;
142
- /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
143
- onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
144
- /** 在应用准备完成后调用。此时服务器已经可以处理网络请求,可以对外广播消息。 */
145
- onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
146
- /** 在接收到HTTP请求,准备路由上下文时调用。 */
147
- onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
148
- /** 在接收到HTTP请求,执行 actions 前调用。 */
149
- beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
150
- /** 在执行 action hanlder 前调用。 */
151
- beforeRunActionHandler?: (server: IRpdServer, handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig) => Promise<any>;
152
- /** 在创建实体前调用。 */
153
- beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
154
- /** 在更新实体前调用。 */
155
- beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
156
- }
1
+ import {
2
+ CreateEntityOptions,
3
+ EmitServerEventOptions,
4
+ EntityWatcherType,
5
+ GetDataAccessorOptions,
6
+ GetModelOptions,
7
+ IDatabaseAccessor,
8
+ IDatabaseClient,
9
+ IDatabaseConfig,
10
+ IQueryBuilder,
11
+ IRpdDataAccessor,
12
+ RapidServerConfig,
13
+ RpdApplicationConfig,
14
+ RpdDataModel,
15
+ RpdDataModelProperty,
16
+ RpdRouteActionConfig,
17
+ RpdServerEventTypes,
18
+ UpdateEntityByIdOptions,
19
+ } from "~/types";
20
+ import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
21
+ import { Next, RouteContext } from "./routeContext";
22
+ import EntityManager from "~/dataAccess/entityManager";
23
+ import { Logger } from "~/facilities/log/LogFacility";
24
+ import { FacilityFactory } from "./facility";
25
+ import { CronJobConfiguration } from "~/types/cron-job-types";
26
+ import { RapidRequest } from "./request";
27
+
28
+ export interface IRpdServer {
29
+ config: RapidServerConfig;
30
+ databaseConfig: IDatabaseConfig;
31
+ queryBuilder: IQueryBuilder;
32
+ getLogger(): Logger;
33
+
34
+ registerFacilityFactory(factory: FacilityFactory);
35
+
36
+ getFacility<TFacility = any, TOptions = any>(name: string, options?: TOptions): Promise<TFacility>;
37
+
38
+ getDatabaseAccessor(): IDatabaseAccessor;
39
+ queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>, client?: IDatabaseClient, dropErrorLog?: boolean) => Promise<any[]>;
40
+ tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>, client?: IDatabaseClient, dropErrorLog?: boolean) => Promise<any[]>;
41
+ registerMiddleware(middleware: any): void;
42
+ registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
43
+ getActionHandlerByCode(code: string): ActionHandler | undefined;
44
+ getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
45
+ getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
46
+ registerService(name: string, service: any);
47
+ getService<TService>(name: string): TService;
48
+ getApplicationConfig(): RpdApplicationConfig;
49
+ appendApplicationConfig(config: Partial<RpdApplicationConfig>);
50
+ appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
51
+ getModel(options: GetModelOptions): RpdDataModel | undefined;
52
+ registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
53
+ registerEntityWatcher(entityWatcher: EntityWatcherType);
54
+ emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
55
+ handleRequest(request: RapidRequest, next: Next): Promise<Response>;
56
+ beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
57
+ beforeRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig): Promise<void>;
58
+ beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
59
+ beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
60
+
61
+ registerCronJob(job: CronJobConfiguration): void;
62
+ listCronJobs(): CronJobConfiguration[];
63
+ }
64
+
65
+ export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
66
+
67
+ export interface RpdConfigurationItemOptions {
68
+ /**
69
+ * 配置项名称。可以包含中文。
70
+ */
71
+ name: string;
72
+ /**
73
+ * 配置项代码。
74
+ */
75
+ code: string;
76
+ /**
77
+ * 配置项类型。
78
+ */
79
+ type: RpdConfigurationItemTypes;
80
+ /**
81
+ * 是否必须有值。默认为 false。
82
+ */
83
+ required?: boolean;
84
+ /**
85
+ * 默认值。使用默认值的 JavaScript 字面量表示。
86
+ */
87
+ defaultValue?: string;
88
+ }
89
+
90
+ export type RpdServerPluginExtendingAbilities =
91
+ | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
92
+ | /** 是指增加系统中的集合的能力。 */ "extendModel"
93
+ | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
94
+ | /** 是指增加接口动作的能力。 */ "extendActionHandler"
95
+ | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
96
+ | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
97
+ | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
98
+ | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
99
+ | /** 对特定任务进行处理的能力。 */ "processTask";
100
+
101
+ export interface RpdServerPluginConfigurableTargetOptions {
102
+ targetCode: string;
103
+
104
+ configurations: RpdConfigurationItemOptions[];
105
+ }
106
+
107
+ export interface RapidPlugin {
108
+ /** 插件代码 */
109
+ get code(): string;
110
+ /** 插件描述 */
111
+ get description(): string;
112
+ /** 插件可以提供哪些扩展能力 */
113
+ get extendingAbilities(): RpdServerPluginExtendingAbilities[];
114
+ /** 插件可以配置的目标实体,以及和配置目标相关的配置项 */
115
+ get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
116
+ /** 插件的全局配置项 */
117
+ get configurations(): RpdConfigurationItemOptions[];
118
+ /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
119
+ initPlugin?: (server: IRpdServer) => Promise<any>;
120
+ /** 注册中间件 */
121
+ registerMiddlewares?: (server: IRpdServer) => Promise<any>;
122
+ /** 注册接口动作处理程序 */
123
+ registerActionHandlers?: (server: IRpdServer) => Promise<any>;
124
+ /** 注册事件处理程序 */
125
+ registerEventHandlers?: (server: IRpdServer) => Promise<any>;
126
+ /** 注册消息处理程序 */
127
+ registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
128
+ /** 注册任务处理程序 */
129
+ registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
130
+ /** 在加载应用前调用。 */
131
+ onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
132
+ /** 配置数据集合 */
133
+ configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
134
+ /** 配置模型属性 */
135
+ configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
136
+ /** 配置服务 */
137
+ configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
138
+ /** 配置路由 */
139
+ configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
140
+ /** 注册定时任务 */
141
+ registerCronJobs?: (server: IRpdServer) => Promise<any>;
142
+ /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
143
+ onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
144
+ /** 在应用准备完成后调用。此时服务器已经可以处理网络请求,可以对外广播消息。 */
145
+ onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
146
+ /** 在接收到HTTP请求,准备路由上下文时调用。 */
147
+ onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
148
+ /** 在接收到HTTP请求,执行 actions 前调用。 */
149
+ beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
150
+ /** 在执行 action hanlder 前调用。 */
151
+ beforeRunActionHandler?: (server: IRpdServer, handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig) => Promise<any>;
152
+ /** 在创建实体前调用。 */
153
+ beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
154
+ /** 在更新实体前调用。 */
155
+ beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
156
+ }
@@ -1,22 +1,22 @@
1
- import { RpdDataPropertyTypes } from "~/types";
2
- import { DataAccessPgColumnTypes } from "./dataAccessTypes";
3
-
4
- export const pgPropertyTypeColumnMap: Record<Exclude<RpdDataPropertyTypes, "relation" | "relation[]">, DataAccessPgColumnTypes> = {
5
- integer: "int4",
6
- long: "int8",
7
- float: "float4",
8
- double: "float8",
9
- decimal: "decimal",
10
- text: "text",
11
- boolean: "bool",
12
- date: "date",
13
- time: "time",
14
- datetime: "timestamptz",
15
- json: "jsonb",
16
- option: "text",
17
- "option[]": "text[]",
18
- file: "jsonb",
19
- "file[]": "jsonb",
20
- image: "jsonb",
21
- "image[]": "jsonb",
22
- };
1
+ import { RpdDataPropertyTypes } from "~/types";
2
+ import { DataAccessPgColumnTypes } from "./dataAccessTypes";
3
+
4
+ export const pgPropertyTypeColumnMap: Record<Exclude<RpdDataPropertyTypes, "relation" | "relation[]">, DataAccessPgColumnTypes> = {
5
+ integer: "int4",
6
+ long: "int8",
7
+ float: "float4",
8
+ double: "float8",
9
+ decimal: "decimal",
10
+ text: "text",
11
+ boolean: "bool",
12
+ date: "date",
13
+ time: "time",
14
+ datetime: "timestamptz",
15
+ json: "jsonb",
16
+ option: "text",
17
+ "option[]": "text[]",
18
+ file: "jsonb",
19
+ "file[]": "jsonb",
20
+ image: "jsonb",
21
+ "image[]": "jsonb",
22
+ };