@ruiapp/rapid-core 0.3.1 → 0.3.3

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 (187) hide show
  1. package/CHANGELOG.md +7 -7
  2. package/dist/index.d.ts +5 -0
  3. package/dist/index.js +403 -158
  4. package/dist/plugins/license/LicensePlugin.d.ts +23 -0
  5. package/dist/plugins/license/LicensePluginTypes.d.ts +78 -0
  6. package/dist/plugins/license/LicenseService.d.ts +22 -0
  7. package/dist/plugins/license/actionHandlers/getLicense.d.ts +6 -0
  8. package/dist/plugins/license/actionHandlers/index.d.ts +3 -0
  9. package/dist/plugins/license/helpers/certHelper.d.ts +2 -0
  10. package/dist/plugins/license/helpers/cryptoHelper.d.ts +8 -0
  11. package/dist/plugins/license/models/index.d.ts +2 -0
  12. package/dist/plugins/license/routes/getLicense.d.ts +12 -0
  13. package/dist/plugins/license/routes/index.d.ts +12 -0
  14. package/dist/utilities/entityUtility.d.ts +1 -0
  15. package/dist/utilities/typeUtility.d.ts +1 -0
  16. package/package.json +1 -1
  17. package/rollup.config.js +16 -16
  18. package/src/bootstrapApplicationConfig.ts +631 -631
  19. package/src/core/actionHandler.ts +22 -22
  20. package/src/core/eventManager.ts +20 -20
  21. package/src/core/facility.ts +7 -7
  22. package/src/core/http/formDataParser.ts +89 -89
  23. package/src/core/http-types.ts +4 -4
  24. package/src/core/pluginManager.ts +175 -175
  25. package/src/core/providers/runtimeProvider.ts +5 -5
  26. package/src/core/request.ts +86 -86
  27. package/src/core/response.ts +76 -76
  28. package/src/core/routeContext.ts +47 -47
  29. package/src/core/routesBuilder.ts +88 -88
  30. package/src/core/server.ts +142 -142
  31. package/src/dataAccess/columnTypeMapper.ts +22 -22
  32. package/src/dataAccess/dataAccessTypes.ts +163 -163
  33. package/src/dataAccess/dataAccessor.ts +135 -135
  34. package/src/dataAccess/entityManager.ts +1718 -1718
  35. package/src/dataAccess/entityMapper.ts +100 -100
  36. package/src/dataAccess/propertyMapper.ts +28 -28
  37. package/src/deno-std/assert/assert.ts +9 -9
  38. package/src/deno-std/assert/assertion_error.ts +7 -7
  39. package/src/deno-std/datetime/to_imf.ts +32 -32
  40. package/src/deno-std/encoding/base64.ts +141 -141
  41. package/src/deno-std/http/cookie.ts +372 -372
  42. package/src/facilities/log/LogFacility.ts +35 -35
  43. package/src/helpers/entityHelpers.ts +76 -76
  44. package/src/helpers/filterHelper.ts +148 -148
  45. package/src/helpers/inputHelper.ts +11 -11
  46. package/src/helpers/metaHelper.ts +89 -89
  47. package/src/helpers/runCollectionEntityActionHandler.ts +27 -27
  48. package/src/index.ts +60 -54
  49. package/src/plugins/auth/AuthPlugin.ts +85 -85
  50. package/src/plugins/auth/actionHandlers/changePassword.ts +54 -54
  51. package/src/plugins/auth/actionHandlers/createSession.ts +75 -63
  52. package/src/plugins/auth/actionHandlers/deleteSession.ts +18 -18
  53. package/src/plugins/auth/actionHandlers/getMyProfile.ts +35 -35
  54. package/src/plugins/auth/actionHandlers/index.ts +8 -8
  55. package/src/plugins/auth/actionHandlers/resetPassword.ts +38 -38
  56. package/src/plugins/auth/models/AccessToken.ts +56 -56
  57. package/src/plugins/auth/models/index.ts +3 -3
  58. package/src/plugins/auth/routes/changePassword.ts +15 -15
  59. package/src/plugins/auth/routes/getMyProfile.ts +15 -15
  60. package/src/plugins/auth/routes/index.ts +7 -7
  61. package/src/plugins/auth/routes/resetPassword.ts +15 -15
  62. package/src/plugins/auth/routes/signin.ts +15 -15
  63. package/src/plugins/auth/routes/signout.ts +15 -15
  64. package/src/plugins/cronJob/CronJobPlugin.ts +112 -112
  65. package/src/plugins/cronJob/CronJobPluginTypes.ts +49 -49
  66. package/src/plugins/cronJob/actionHandlers/index.ts +4 -4
  67. package/src/plugins/cronJob/actionHandlers/runCronJob.ts +29 -29
  68. package/src/plugins/cronJob/routes/index.ts +3 -3
  69. package/src/plugins/cronJob/routes/runCronJob.ts +15 -15
  70. package/src/plugins/dataManage/DataManagePlugin.ts +163 -163
  71. package/src/plugins/dataManage/actionHandlers/addEntityRelations.ts +20 -20
  72. package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts +16 -16
  73. package/src/plugins/dataManage/actionHandlers/createCollectionEntitiesBatch.ts +42 -42
  74. package/src/plugins/dataManage/actionHandlers/createCollectionEntity.ts +24 -24
  75. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntities.ts +38 -38
  76. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntityById.ts +22 -22
  77. package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts +26 -26
  78. package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts +21 -21
  79. package/src/plugins/dataManage/actionHandlers/queryDatabase.ts +22 -22
  80. package/src/plugins/dataManage/actionHandlers/removeEntityRelations.ts +20 -20
  81. package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts +41 -41
  82. package/src/plugins/entityAccessControl/EntityAccessControlPlugin.ts +146 -146
  83. package/src/plugins/fileManage/FileManagePlugin.ts +52 -52
  84. package/src/plugins/fileManage/actionHandlers/downloadDocument.ts +65 -65
  85. package/src/plugins/fileManage/actionHandlers/downloadFile.ts +44 -44
  86. package/src/plugins/fileManage/actionHandlers/uploadFile.ts +33 -33
  87. package/src/plugins/fileManage/routes/downloadDocument.ts +15 -15
  88. package/src/plugins/fileManage/routes/downloadFile.ts +15 -15
  89. package/src/plugins/fileManage/routes/index.ts +5 -5
  90. package/src/plugins/fileManage/routes/uploadFile.ts +15 -15
  91. package/src/plugins/license/LicensePlugin.ts +79 -0
  92. package/src/plugins/license/LicensePluginTypes.ts +95 -0
  93. package/src/plugins/license/LicenseService.ts +112 -0
  94. package/src/plugins/license/actionHandlers/getLicense.ts +18 -0
  95. package/src/plugins/license/actionHandlers/index.ts +4 -0
  96. package/src/plugins/license/helpers/certHelper.ts +21 -0
  97. package/src/plugins/license/helpers/cryptoHelper.ts +47 -0
  98. package/src/plugins/license/models/index.ts +1 -0
  99. package/src/plugins/license/routes/getLicense.ts +15 -0
  100. package/src/plugins/license/routes/index.ts +3 -0
  101. package/src/plugins/mail/MailPlugin.ts +74 -74
  102. package/src/plugins/mail/MailPluginTypes.ts +27 -27
  103. package/src/plugins/mail/MailService.ts +38 -38
  104. package/src/plugins/mail/actionHandlers/index.ts +3 -3
  105. package/src/plugins/mail/models/index.ts +1 -1
  106. package/src/plugins/mail/routes/index.ts +1 -1
  107. package/src/plugins/metaManage/MetaManagePlugin.ts +504 -504
  108. package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts +10 -10
  109. package/src/plugins/metaManage/actionHandlers/listMetaModels.ts +9 -9
  110. package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts +9 -9
  111. package/src/plugins/notification/NotificationPlugin.ts +68 -68
  112. package/src/plugins/notification/NotificationPluginTypes.ts +13 -13
  113. package/src/plugins/notification/NotificationService.ts +25 -25
  114. package/src/plugins/notification/actionHandlers/index.ts +3 -3
  115. package/src/plugins/notification/models/Notification.ts +60 -60
  116. package/src/plugins/notification/models/index.ts +3 -3
  117. package/src/plugins/notification/routes/index.ts +1 -1
  118. package/src/plugins/routeManage/RouteManagePlugin.ts +62 -62
  119. package/src/plugins/routeManage/actionHandlers/httpProxy.ts +13 -13
  120. package/src/plugins/sequence/SequencePlugin.ts +136 -136
  121. package/src/plugins/sequence/SequencePluginTypes.ts +69 -69
  122. package/src/plugins/sequence/SequenceService.ts +81 -81
  123. package/src/plugins/sequence/actionHandlers/generateSn.ts +32 -32
  124. package/src/plugins/sequence/actionHandlers/index.ts +4 -4
  125. package/src/plugins/sequence/models/SequenceAutoIncrementRecord.ts +49 -49
  126. package/src/plugins/sequence/models/SequenceRule.ts +42 -42
  127. package/src/plugins/sequence/models/index.ts +4 -4
  128. package/src/plugins/sequence/routes/generateSn.ts +15 -15
  129. package/src/plugins/sequence/routes/index.ts +3 -3
  130. package/src/plugins/sequence/segment-utility.ts +11 -11
  131. package/src/plugins/sequence/segments/autoIncrement.ts +78 -78
  132. package/src/plugins/sequence/segments/dayOfMonth.ts +17 -17
  133. package/src/plugins/sequence/segments/index.ts +9 -9
  134. package/src/plugins/sequence/segments/literal.ts +14 -14
  135. package/src/plugins/sequence/segments/month.ts +17 -17
  136. package/src/plugins/sequence/segments/parameter.ts +18 -18
  137. package/src/plugins/sequence/segments/year.ts +17 -17
  138. package/src/plugins/serverOperation/ServerOperationPlugin.ts +91 -91
  139. package/src/plugins/serverOperation/ServerOperationPluginTypes.ts +15 -15
  140. package/src/plugins/serverOperation/actionHandlers/index.ts +4 -4
  141. package/src/plugins/serverOperation/actionHandlers/runServerOperation.ts +15 -15
  142. package/src/plugins/setting/SettingPlugin.ts +68 -68
  143. package/src/plugins/setting/SettingPluginTypes.ts +37 -37
  144. package/src/plugins/setting/SettingService.ts +213 -213
  145. package/src/plugins/setting/actionHandlers/getSystemSettingValues.ts +30 -30
  146. package/src/plugins/setting/actionHandlers/getUserSettingValues.ts +38 -38
  147. package/src/plugins/setting/actionHandlers/index.ts +6 -6
  148. package/src/plugins/setting/actionHandlers/setSystemSettingValues.ts +30 -30
  149. package/src/plugins/setting/models/SystemSettingGroupSetting.ts +57 -57
  150. package/src/plugins/setting/models/SystemSettingItem.ts +48 -42
  151. package/src/plugins/setting/models/SystemSettingItemSetting.ts +73 -73
  152. package/src/plugins/setting/models/UserSettingGroupSetting.ts +57 -57
  153. package/src/plugins/setting/models/UserSettingItem.ts +55 -49
  154. package/src/plugins/setting/models/UserSettingItemSetting.ts +73 -73
  155. package/src/plugins/setting/models/index.ts +8 -8
  156. package/src/plugins/setting/routes/getSystemSettingValues.ts +15 -15
  157. package/src/plugins/setting/routes/getUserSettingValues.ts +15 -15
  158. package/src/plugins/setting/routes/index.ts +5 -5
  159. package/src/plugins/setting/routes/setSystemSettingValues.ts +15 -15
  160. package/src/plugins/stateMachine/StateMachinePlugin.ts +186 -186
  161. package/src/plugins/stateMachine/StateMachinePluginTypes.ts +48 -48
  162. package/src/plugins/stateMachine/actionHandlers/index.ts +4 -4
  163. package/src/plugins/stateMachine/actionHandlers/sendStateMachineEvent.ts +51 -51
  164. package/src/plugins/stateMachine/models/StateMachine.ts +42 -42
  165. package/src/plugins/stateMachine/models/index.ts +3 -3
  166. package/src/plugins/stateMachine/routes/index.ts +3 -3
  167. package/src/plugins/stateMachine/routes/sendStateMachineEvent.ts +15 -15
  168. package/src/plugins/stateMachine/stateMachineHelper.ts +36 -36
  169. package/src/plugins/webhooks/WebhooksPlugin.ts +148 -148
  170. package/src/plugins/webhooks/pluginConfig.ts +75 -75
  171. package/src/polyfill.ts +5 -5
  172. package/src/proxy/mod.ts +38 -38
  173. package/src/proxy/types.ts +21 -21
  174. package/src/queryBuilder/index.ts +1 -1
  175. package/src/queryBuilder/queryBuilder.ts +665 -665
  176. package/src/server.ts +463 -463
  177. package/src/types.ts +701 -701
  178. package/src/utilities/accessControlUtility.ts +33 -33
  179. package/src/utilities/entityUtility.ts +18 -0
  180. package/src/utilities/errorUtility.ts +15 -15
  181. package/src/utilities/fsUtility.ts +61 -61
  182. package/src/utilities/httpUtility.ts +19 -19
  183. package/src/utilities/jwtUtility.ts +26 -26
  184. package/src/utilities/pathUtility.ts +14 -14
  185. package/src/utilities/timeUtility.ts +9 -9
  186. package/src/utilities/typeUtility.ts +15 -11
  187. package/tsconfig.json +19 -19
@@ -1,142 +1,142 @@
1
- import {
2
- CreateEntityOptions,
3
- EmitServerEventOptions,
4
- EntityWatcherType,
5
- GetDataAccessorOptions,
6
- GetModelOptions,
7
- IDatabaseConfig,
8
- IQueryBuilder,
9
- IRpdDataAccessor,
10
- RapidServerConfig,
11
- RpdApplicationConfig,
12
- RpdDataModel,
13
- RpdDataModelProperty,
14
- RpdServerEventTypes,
15
- UpdateEntityByIdOptions,
16
- } from "~/types";
17
- import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
18
- import { Next, RouteContext } from "./routeContext";
19
- import EntityManager from "~/dataAccess/entityManager";
20
- import { Logger } from "~/facilities/log/LogFacility";
21
- import { FacilityFactory } from "./facility";
22
-
23
- export interface IRpdServer {
24
- config: RapidServerConfig;
25
- databaseConfig: IDatabaseConfig;
26
- queryBuilder: IQueryBuilder;
27
- getLogger(): Logger;
28
-
29
- registerFacilityFactory(factory: FacilityFactory);
30
-
31
- getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
32
-
33
- queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
34
- tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
35
- registerMiddleware(middleware: any): void;
36
- registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
37
- getActionHandlerByCode(code: string): ActionHandler | undefined;
38
- getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
39
- getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
40
- registerService(name: string, service: any);
41
- getService<TService>(name: string): TService;
42
- getApplicationConfig(): RpdApplicationConfig;
43
- appendApplicationConfig(config: Partial<RpdApplicationConfig>);
44
- appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
45
- getModel(options: GetModelOptions): RpdDataModel | undefined;
46
- registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
47
- registerEntityWatcher(entityWatcher: EntityWatcherType);
48
- emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
49
- handleRequest(request: Request, next: Next): Promise<Response>;
50
- beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
51
- beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
52
- beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
53
- }
54
-
55
- export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
56
-
57
- export interface RpdConfigurationItemOptions {
58
- /**
59
- * 配置项名称。可以包含中文。
60
- */
61
- name: string;
62
- /**
63
- * 配置项代码。
64
- */
65
- code: string;
66
- /**
67
- * 配置项类型。
68
- */
69
- type: RpdConfigurationItemTypes;
70
- /**
71
- * 是否必须有值。默认为 false。
72
- */
73
- required?: boolean;
74
- /**
75
- * 默认值。使用默认值的 JavaScript 字面量表示。
76
- */
77
- defaultValue?: string;
78
- }
79
-
80
- export type RpdServerPluginExtendingAbilities =
81
- | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
82
- | /** 是指增加系统中的集合的能力。 */ "extendModel"
83
- | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
84
- | /** 是指增加接口动作的能力。 */ "extendActionHandler"
85
- | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
86
- | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
87
- | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
88
- | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
89
- | /** 对特定任务进行处理的能力。 */ "processTask";
90
-
91
- export interface RpdServerPluginConfigurableTargetOptions {
92
- targetCode: string;
93
-
94
- configurations: RpdConfigurationItemOptions[];
95
- }
96
-
97
- export interface RapidPlugin {
98
- /** 插件代码 */
99
- get code(): string;
100
- /** 插件描述 */
101
- get description(): string;
102
- /** 插件可以提供哪些扩展能力 */
103
- get extendingAbilities(): RpdServerPluginExtendingAbilities[];
104
- /** 插件可以配置的目标实体,以及和配置目标相关的配置项 */
105
- get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
106
- /** 插件的全局配置项 */
107
- get configurations(): RpdConfigurationItemOptions[];
108
- /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
109
- initPlugin?: (server: IRpdServer) => Promise<any>;
110
- /** 注册中间件 */
111
- registerMiddlewares?: (server: IRpdServer) => Promise<any>;
112
- /** 注册接口动作处理程序 */
113
- registerActionHandlers?: (server: IRpdServer) => Promise<any>;
114
- /** 注册事件处理程序 */
115
- registerEventHandlers?: (server: IRpdServer) => Promise<any>;
116
- /** 注册消息处理程序 */
117
- registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
118
- /** 注册任务处理程序 */
119
- registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
120
- /** 在加载应用前调用。 */
121
- onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
122
- /** 配置数据集合 */
123
- configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
124
- /** 配置模型属性 */
125
- configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
126
- /** 配置服务 */
127
- configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
128
- /** 配置路由 */
129
- configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
130
- /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
131
- onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
132
- /** 在应用准备完成后调用。此时服务器已经可以处理网络请求,可以对外广播消息。 */
133
- onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
134
- /** 在接收到HTTP请求,准备路由上下文时调用。 */
135
- onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
136
- /** 在接收到HTTP请求,执行 actions 前调用。 */
137
- beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
138
- /** 在创建实体前调用。 */
139
- beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
140
- /** 在更新实体前调用。 */
141
- beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
142
- }
1
+ import {
2
+ CreateEntityOptions,
3
+ EmitServerEventOptions,
4
+ EntityWatcherType,
5
+ GetDataAccessorOptions,
6
+ GetModelOptions,
7
+ IDatabaseConfig,
8
+ IQueryBuilder,
9
+ IRpdDataAccessor,
10
+ RapidServerConfig,
11
+ RpdApplicationConfig,
12
+ RpdDataModel,
13
+ RpdDataModelProperty,
14
+ RpdServerEventTypes,
15
+ UpdateEntityByIdOptions,
16
+ } from "~/types";
17
+ import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
18
+ import { Next, RouteContext } from "./routeContext";
19
+ import EntityManager from "~/dataAccess/entityManager";
20
+ import { Logger } from "~/facilities/log/LogFacility";
21
+ import { FacilityFactory } from "./facility";
22
+
23
+ export interface IRpdServer {
24
+ config: RapidServerConfig;
25
+ databaseConfig: IDatabaseConfig;
26
+ queryBuilder: IQueryBuilder;
27
+ getLogger(): Logger;
28
+
29
+ registerFacilityFactory(factory: FacilityFactory);
30
+
31
+ getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
32
+
33
+ queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
34
+ tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
35
+ registerMiddleware(middleware: any): void;
36
+ registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
37
+ getActionHandlerByCode(code: string): ActionHandler | undefined;
38
+ getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
39
+ getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
40
+ registerService(name: string, service: any);
41
+ getService<TService>(name: string): TService;
42
+ getApplicationConfig(): RpdApplicationConfig;
43
+ appendApplicationConfig(config: Partial<RpdApplicationConfig>);
44
+ appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
45
+ getModel(options: GetModelOptions): RpdDataModel | undefined;
46
+ registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
47
+ registerEntityWatcher(entityWatcher: EntityWatcherType);
48
+ emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
49
+ handleRequest(request: Request, next: Next): Promise<Response>;
50
+ beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
51
+ beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
52
+ beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
53
+ }
54
+
55
+ export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
56
+
57
+ export interface RpdConfigurationItemOptions {
58
+ /**
59
+ * 配置项名称。可以包含中文。
60
+ */
61
+ name: string;
62
+ /**
63
+ * 配置项代码。
64
+ */
65
+ code: string;
66
+ /**
67
+ * 配置项类型。
68
+ */
69
+ type: RpdConfigurationItemTypes;
70
+ /**
71
+ * 是否必须有值。默认为 false。
72
+ */
73
+ required?: boolean;
74
+ /**
75
+ * 默认值。使用默认值的 JavaScript 字面量表示。
76
+ */
77
+ defaultValue?: string;
78
+ }
79
+
80
+ export type RpdServerPluginExtendingAbilities =
81
+ | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
82
+ | /** 是指增加系统中的集合的能力。 */ "extendModel"
83
+ | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
84
+ | /** 是指增加接口动作的能力。 */ "extendActionHandler"
85
+ | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
86
+ | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
87
+ | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
88
+ | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
89
+ | /** 对特定任务进行处理的能力。 */ "processTask";
90
+
91
+ export interface RpdServerPluginConfigurableTargetOptions {
92
+ targetCode: string;
93
+
94
+ configurations: RpdConfigurationItemOptions[];
95
+ }
96
+
97
+ export interface RapidPlugin {
98
+ /** 插件代码 */
99
+ get code(): string;
100
+ /** 插件描述 */
101
+ get description(): string;
102
+ /** 插件可以提供哪些扩展能力 */
103
+ get extendingAbilities(): RpdServerPluginExtendingAbilities[];
104
+ /** 插件可以配置的目标实体,以及和配置目标相关的配置项 */
105
+ get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
106
+ /** 插件的全局配置项 */
107
+ get configurations(): RpdConfigurationItemOptions[];
108
+ /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
109
+ initPlugin?: (server: IRpdServer) => Promise<any>;
110
+ /** 注册中间件 */
111
+ registerMiddlewares?: (server: IRpdServer) => Promise<any>;
112
+ /** 注册接口动作处理程序 */
113
+ registerActionHandlers?: (server: IRpdServer) => Promise<any>;
114
+ /** 注册事件处理程序 */
115
+ registerEventHandlers?: (server: IRpdServer) => Promise<any>;
116
+ /** 注册消息处理程序 */
117
+ registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
118
+ /** 注册任务处理程序 */
119
+ registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
120
+ /** 在加载应用前调用。 */
121
+ onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
122
+ /** 配置数据集合 */
123
+ configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
124
+ /** 配置模型属性 */
125
+ configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
126
+ /** 配置服务 */
127
+ configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
128
+ /** 配置路由 */
129
+ configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
130
+ /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
131
+ onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
132
+ /** 在应用准备完成后调用。此时服务器已经可以处理网络请求,可以对外广播消息。 */
133
+ onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
134
+ /** 在接收到HTTP请求,准备路由上下文时调用。 */
135
+ onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
136
+ /** 在接收到HTTP请求,执行 actions 前调用。 */
137
+ beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
138
+ /** 在创建实体前调用。 */
139
+ beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
140
+ /** 在更新实体前调用。 */
141
+ beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
142
+ }
@@ -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
+ };
@@ -1,163 +1,163 @@
1
- export type DataAccessPgColumnTypes =
2
- | "int4"
3
- | "int8"
4
- | "float4"
5
- | "float8"
6
- | "decimal"
7
- | "text"
8
- | "text[]"
9
- | "bool"
10
- | "date"
11
- | "time"
12
- | "timestamptz"
13
- | "jsonb";
14
-
15
- export type RowFilterRelationalOperators =
16
- | "eq"
17
- | "ne"
18
- | "lt"
19
- | "lte"
20
- | "gt"
21
- | "gte"
22
- | "contains"
23
- | "notContains"
24
- | "containsCS"
25
- | "notContainsCS"
26
- | "startsWith"
27
- | "notStartsWith"
28
- | "endsWith"
29
- | "notEndsWith";
30
-
31
- export type RowFilterArrayOperators = "arrayContains" | "arrayOverlap";
32
-
33
- export type RowFilterSetOperators = "in" | "notIn";
34
-
35
- export type RowFilterRangeOperators = "between";
36
-
37
- export type RowFilterLogicalOperators = "or" | "and";
38
-
39
- export type RowFilterUnaryOperators = "null" | "notNull";
40
-
41
- export type RowFilterExistenceOperators = "exists" | "notExists";
42
-
43
- export type RowFilterOperators =
44
- | RowFilterRelationalOperators
45
- | RowFilterArrayOperators
46
- | RowFilterSetOperators
47
- | RowFilterRangeOperators
48
- | RowFilterLogicalOperators
49
- | RowFilterUnaryOperators
50
- | RowFilterExistenceOperators;
51
-
52
- export type RowFilterOptions =
53
- | FindRowRelationalFilterOptions
54
- | FindRowArrayFilterOptions
55
- | FindRowSetFilterOptions
56
- | FindRowRangeFilterOptions
57
- | FindRowLogicalFilterOptions
58
- | FindRowUnaryFilterOptions
59
- | FindRowExistenceFilterOptions;
60
-
61
- export type RowNonRelationPropertyFilterOptions =
62
- | FindRowRelationalFilterOptions
63
- | FindRowArrayFilterOptions
64
- | FindRowSetFilterOptions
65
- | FindRowRangeFilterOptions
66
- | FindRowUnaryFilterOptions;
67
-
68
- export type ColumnSelectOptions = string | ColumnNameWithTableName;
69
-
70
- export type ColumnNameWithTableName = {
71
- name: string;
72
- tableName?: string;
73
- schema?: string;
74
- };
75
-
76
- export interface FindRowOptions {
77
- filters?: RowFilterOptions[];
78
- orderBy?: FindRowOrderByOptions[];
79
- pagination?: FindRowPaginationOptions;
80
- // TODO: may be `columns` is a better name.
81
- fields?: ColumnSelectOptions[];
82
- keepNonPropertyFields?: boolean;
83
- }
84
-
85
- export interface FindRowRelationalFilterOptions {
86
- // TODO: may be `column` is a better name.
87
- field: ColumnSelectOptions;
88
- operator: RowFilterRelationalOperators;
89
- value: any;
90
- }
91
-
92
- export interface FindRowArrayFilterOptions {
93
- field: ColumnSelectOptions;
94
- operator: RowFilterArrayOperators;
95
- value: any[];
96
- itemType?: string;
97
- }
98
-
99
- export interface FindRowSetFilterOptions {
100
- field: ColumnSelectOptions;
101
- operator: RowFilterSetOperators;
102
- value: any[];
103
- itemType?: string;
104
- }
105
-
106
- export interface FindRowRangeFilterOptions {
107
- field: ColumnSelectOptions;
108
- operator: RowFilterRangeOperators;
109
- value: any[];
110
- itemType?: string;
111
- }
112
-
113
- export interface FindRowLogicalFilterOptions {
114
- operator: RowFilterLogicalOperators;
115
- filters: RowFilterOptions[];
116
- }
117
-
118
- export interface FindRowUnaryFilterOptions {
119
- field: ColumnSelectOptions;
120
- operator: RowFilterUnaryOperators;
121
- }
122
-
123
- export interface FindRowExistenceFilterOptions {
124
- field: ColumnSelectOptions;
125
- operator: RowFilterExistenceOperators;
126
- filters: RowFilterOptions[];
127
- }
128
-
129
- export interface FindRowPaginationOptions {
130
- offset: number;
131
- limit: number;
132
- withoutTotal?: boolean;
133
- }
134
-
135
- export interface FindRowOrderByOptions {
136
- /**
137
- * 排序字段
138
- */
139
- field: ColumnSelectOptions;
140
-
141
- /**
142
- * 是否倒序
143
- */
144
- desc?: boolean;
145
-
146
- /**
147
- * 关系字段
148
- */
149
- relationField?: ColumnNameWithTableName;
150
- }
151
-
152
- export interface CountRowOptions {
153
- filters?: RowFilterOptions[];
154
- }
155
-
156
- export interface UpdateRowOptions {
157
- filters?: RowFilterOptions[];
158
- entity: any;
159
- }
160
-
161
- export interface DeleteRowOptions {
162
- filters?: RowFilterOptions[];
163
- }
1
+ export type DataAccessPgColumnTypes =
2
+ | "int4"
3
+ | "int8"
4
+ | "float4"
5
+ | "float8"
6
+ | "decimal"
7
+ | "text"
8
+ | "text[]"
9
+ | "bool"
10
+ | "date"
11
+ | "time"
12
+ | "timestamptz"
13
+ | "jsonb";
14
+
15
+ export type RowFilterRelationalOperators =
16
+ | "eq"
17
+ | "ne"
18
+ | "lt"
19
+ | "lte"
20
+ | "gt"
21
+ | "gte"
22
+ | "contains"
23
+ | "notContains"
24
+ | "containsCS"
25
+ | "notContainsCS"
26
+ | "startsWith"
27
+ | "notStartsWith"
28
+ | "endsWith"
29
+ | "notEndsWith";
30
+
31
+ export type RowFilterArrayOperators = "arrayContains" | "arrayOverlap";
32
+
33
+ export type RowFilterSetOperators = "in" | "notIn";
34
+
35
+ export type RowFilterRangeOperators = "between";
36
+
37
+ export type RowFilterLogicalOperators = "or" | "and";
38
+
39
+ export type RowFilterUnaryOperators = "null" | "notNull";
40
+
41
+ export type RowFilterExistenceOperators = "exists" | "notExists";
42
+
43
+ export type RowFilterOperators =
44
+ | RowFilterRelationalOperators
45
+ | RowFilterArrayOperators
46
+ | RowFilterSetOperators
47
+ | RowFilterRangeOperators
48
+ | RowFilterLogicalOperators
49
+ | RowFilterUnaryOperators
50
+ | RowFilterExistenceOperators;
51
+
52
+ export type RowFilterOptions =
53
+ | FindRowRelationalFilterOptions
54
+ | FindRowArrayFilterOptions
55
+ | FindRowSetFilterOptions
56
+ | FindRowRangeFilterOptions
57
+ | FindRowLogicalFilterOptions
58
+ | FindRowUnaryFilterOptions
59
+ | FindRowExistenceFilterOptions;
60
+
61
+ export type RowNonRelationPropertyFilterOptions =
62
+ | FindRowRelationalFilterOptions
63
+ | FindRowArrayFilterOptions
64
+ | FindRowSetFilterOptions
65
+ | FindRowRangeFilterOptions
66
+ | FindRowUnaryFilterOptions;
67
+
68
+ export type ColumnSelectOptions = string | ColumnNameWithTableName;
69
+
70
+ export type ColumnNameWithTableName = {
71
+ name: string;
72
+ tableName?: string;
73
+ schema?: string;
74
+ };
75
+
76
+ export interface FindRowOptions {
77
+ filters?: RowFilterOptions[];
78
+ orderBy?: FindRowOrderByOptions[];
79
+ pagination?: FindRowPaginationOptions;
80
+ // TODO: may be `columns` is a better name.
81
+ fields?: ColumnSelectOptions[];
82
+ keepNonPropertyFields?: boolean;
83
+ }
84
+
85
+ export interface FindRowRelationalFilterOptions {
86
+ // TODO: may be `column` is a better name.
87
+ field: ColumnSelectOptions;
88
+ operator: RowFilterRelationalOperators;
89
+ value: any;
90
+ }
91
+
92
+ export interface FindRowArrayFilterOptions {
93
+ field: ColumnSelectOptions;
94
+ operator: RowFilterArrayOperators;
95
+ value: any[];
96
+ itemType?: string;
97
+ }
98
+
99
+ export interface FindRowSetFilterOptions {
100
+ field: ColumnSelectOptions;
101
+ operator: RowFilterSetOperators;
102
+ value: any[];
103
+ itemType?: string;
104
+ }
105
+
106
+ export interface FindRowRangeFilterOptions {
107
+ field: ColumnSelectOptions;
108
+ operator: RowFilterRangeOperators;
109
+ value: any[];
110
+ itemType?: string;
111
+ }
112
+
113
+ export interface FindRowLogicalFilterOptions {
114
+ operator: RowFilterLogicalOperators;
115
+ filters: RowFilterOptions[];
116
+ }
117
+
118
+ export interface FindRowUnaryFilterOptions {
119
+ field: ColumnSelectOptions;
120
+ operator: RowFilterUnaryOperators;
121
+ }
122
+
123
+ export interface FindRowExistenceFilterOptions {
124
+ field: ColumnSelectOptions;
125
+ operator: RowFilterExistenceOperators;
126
+ filters: RowFilterOptions[];
127
+ }
128
+
129
+ export interface FindRowPaginationOptions {
130
+ offset: number;
131
+ limit: number;
132
+ withoutTotal?: boolean;
133
+ }
134
+
135
+ export interface FindRowOrderByOptions {
136
+ /**
137
+ * 排序字段
138
+ */
139
+ field: ColumnSelectOptions;
140
+
141
+ /**
142
+ * 是否倒序
143
+ */
144
+ desc?: boolean;
145
+
146
+ /**
147
+ * 关系字段
148
+ */
149
+ relationField?: ColumnNameWithTableName;
150
+ }
151
+
152
+ export interface CountRowOptions {
153
+ filters?: RowFilterOptions[];
154
+ }
155
+
156
+ export interface UpdateRowOptions {
157
+ filters?: RowFilterOptions[];
158
+ entity: any;
159
+ }
160
+
161
+ export interface DeleteRowOptions {
162
+ filters?: RowFilterOptions[];
163
+ }