@ruiapp/rapid-core 0.1.83 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bootstrapApplicationConfig.d.ts +6 -0
- package/dist/helpers/metaHelper.d.ts +3 -3
- package/dist/index.js +56 -24
- package/dist/plugins/webhooks/pluginConfig.d.ts +1 -0
- package/dist/types.d.ts +19 -1
- package/package.json +1 -1
- package/rollup.config.js +16 -16
- package/src/bootstrapApplicationConfig.ts +615 -602
- package/src/core/actionHandler.ts +22 -22
- package/src/core/eventManager.ts +20 -20
- package/src/core/facility.ts +7 -7
- package/src/core/http/formDataParser.ts +89 -89
- package/src/core/pluginManager.ts +175 -175
- package/src/core/providers/runtimeProvider.ts +5 -5
- package/src/core/request.ts +86 -86
- package/src/core/response.ts +76 -76
- package/src/core/routeContext.ts +43 -43
- package/src/core/routesBuilder.ts +88 -88
- package/src/core/server.ts +142 -142
- package/src/dataAccess/columnTypeMapper.ts +22 -22
- package/src/dataAccess/dataAccessTypes.ts +151 -151
- package/src/dataAccess/dataAccessor.ts +137 -137
- package/src/dataAccess/entityManager.ts +1499 -1505
- package/src/dataAccess/entityMapper.ts +100 -100
- package/src/dataAccess/propertyMapper.ts +28 -28
- package/src/deno-std/datetime/to_imf.ts +32 -32
- package/src/deno-std/encoding/base64.ts +141 -141
- package/src/deno-std/http/cookie.ts +372 -372
- package/src/facilities/log/LogFacility.ts +35 -35
- package/src/helpers/entityHelpers.ts +76 -76
- package/src/helpers/filterHelper.ts +47 -47
- package/src/helpers/metaHelper.ts +80 -76
- package/src/helpers/runCollectionEntityActionHandler.ts +27 -27
- package/src/index.ts +46 -46
- package/src/plugins/auth/AuthPlugin.ts +85 -85
- package/src/plugins/auth/actionHandlers/changePassword.ts +54 -54
- package/src/plugins/auth/actionHandlers/createSession.ts +63 -63
- package/src/plugins/auth/actionHandlers/deleteSession.ts +18 -18
- package/src/plugins/auth/actionHandlers/getMyProfile.ts +35 -35
- package/src/plugins/auth/actionHandlers/index.ts +8 -8
- package/src/plugins/auth/actionHandlers/resetPassword.ts +38 -38
- package/src/plugins/auth/models/AccessToken.ts +56 -56
- package/src/plugins/auth/models/index.ts +3 -3
- package/src/plugins/auth/routes/changePassword.ts +15 -15
- package/src/plugins/auth/routes/getMyProfile.ts +15 -15
- package/src/plugins/auth/routes/index.ts +7 -7
- package/src/plugins/auth/routes/resetPassword.ts +15 -15
- package/src/plugins/auth/routes/signin.ts +15 -15
- package/src/plugins/auth/routes/signout.ts +15 -15
- package/src/plugins/cronJob/CronJobPlugin.ts +112 -112
- package/src/plugins/cronJob/CronJobPluginTypes.ts +49 -49
- package/src/plugins/cronJob/actionHandlers/index.ts +4 -4
- package/src/plugins/cronJob/actionHandlers/runCronJob.ts +29 -29
- package/src/plugins/cronJob/routes/index.ts +3 -3
- package/src/plugins/cronJob/routes/runCronJob.ts +15 -15
- package/src/plugins/dataManage/DataManagePlugin.ts +163 -163
- package/src/plugins/dataManage/actionHandlers/addEntityRelations.ts +20 -20
- package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts +15 -15
- package/src/plugins/dataManage/actionHandlers/createCollectionEntitiesBatch.ts +42 -42
- package/src/plugins/dataManage/actionHandlers/createCollectionEntity.ts +24 -24
- package/src/plugins/dataManage/actionHandlers/deleteCollectionEntities.ts +38 -38
- package/src/plugins/dataManage/actionHandlers/deleteCollectionEntityById.ts +22 -22
- package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts +26 -26
- package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts +21 -21
- package/src/plugins/dataManage/actionHandlers/queryDatabase.ts +22 -22
- package/src/plugins/dataManage/actionHandlers/removeEntityRelations.ts +20 -20
- package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts +35 -35
- package/src/plugins/entityAccessControl/EntityAccessControlPlugin.ts +146 -146
- package/src/plugins/fileManage/FileManagePlugin.ts +52 -52
- package/src/plugins/fileManage/actionHandlers/downloadDocument.ts +36 -36
- package/src/plugins/fileManage/actionHandlers/downloadFile.ts +44 -44
- package/src/plugins/fileManage/actionHandlers/uploadFile.ts +33 -33
- package/src/plugins/fileManage/routes/downloadDocument.ts +15 -15
- package/src/plugins/fileManage/routes/downloadFile.ts +15 -15
- package/src/plugins/fileManage/routes/index.ts +5 -5
- package/src/plugins/fileManage/routes/uploadFile.ts +15 -15
- package/src/plugins/metaManage/MetaManagePlugin.ts +500 -488
- package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts +10 -10
- package/src/plugins/metaManage/actionHandlers/listMetaModels.ts +9 -9
- package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts +9 -9
- package/src/plugins/routeManage/RouteManagePlugin.ts +62 -62
- package/src/plugins/routeManage/actionHandlers/httpProxy.ts +13 -13
- package/src/plugins/sequence/SequencePlugin.ts +136 -136
- package/src/plugins/sequence/SequencePluginTypes.ts +69 -69
- package/src/plugins/sequence/SequenceService.ts +81 -81
- package/src/plugins/sequence/actionHandlers/generateSn.ts +32 -32
- package/src/plugins/sequence/actionHandlers/index.ts +4 -4
- package/src/plugins/sequence/models/SequenceAutoIncrementRecord.ts +49 -49
- package/src/plugins/sequence/models/SequenceRule.ts +42 -42
- package/src/plugins/sequence/models/index.ts +4 -4
- package/src/plugins/sequence/routes/generateSn.ts +15 -15
- package/src/plugins/sequence/routes/index.ts +3 -3
- package/src/plugins/sequence/segment-utility.ts +11 -11
- package/src/plugins/sequence/segments/autoIncrement.ts +78 -78
- package/src/plugins/sequence/segments/dayOfMonth.ts +17 -17
- package/src/plugins/sequence/segments/index.ts +9 -9
- package/src/plugins/sequence/segments/literal.ts +14 -14
- package/src/plugins/sequence/segments/month.ts +17 -17
- package/src/plugins/sequence/segments/parameter.ts +18 -18
- package/src/plugins/sequence/segments/year.ts +17 -17
- package/src/plugins/serverOperation/ServerOperationPlugin.ts +91 -91
- package/src/plugins/serverOperation/ServerOperationPluginTypes.ts +15 -15
- package/src/plugins/serverOperation/actionHandlers/index.ts +4 -4
- package/src/plugins/setting/SettingPlugin.ts +68 -68
- package/src/plugins/setting/SettingPluginTypes.ts +37 -37
- package/src/plugins/setting/SettingService.ts +213 -213
- package/src/plugins/setting/actionHandlers/getSystemSettingValues.ts +30 -30
- package/src/plugins/setting/actionHandlers/getUserSettingValues.ts +38 -38
- package/src/plugins/setting/actionHandlers/index.ts +6 -6
- package/src/plugins/setting/actionHandlers/setSystemSettingValues.ts +30 -30
- package/src/plugins/setting/models/SystemSettingGroupSetting.ts +57 -57
- package/src/plugins/setting/models/SystemSettingItem.ts +42 -42
- package/src/plugins/setting/models/SystemSettingItemSetting.ts +73 -73
- package/src/plugins/setting/models/UserSettingGroupSetting.ts +57 -57
- package/src/plugins/setting/models/UserSettingItem.ts +49 -49
- package/src/plugins/setting/models/UserSettingItemSetting.ts +73 -73
- package/src/plugins/setting/models/index.ts +8 -8
- package/src/plugins/setting/routes/getSystemSettingValues.ts +15 -15
- package/src/plugins/setting/routes/getUserSettingValues.ts +15 -15
- package/src/plugins/setting/routes/index.ts +5 -5
- package/src/plugins/setting/routes/setSystemSettingValues.ts +15 -15
- package/src/plugins/stateMachine/StateMachinePlugin.ts +186 -186
- package/src/plugins/stateMachine/StateMachinePluginTypes.ts +48 -48
- package/src/plugins/stateMachine/actionHandlers/index.ts +4 -4
- package/src/plugins/stateMachine/actionHandlers/sendStateMachineEvent.ts +51 -51
- package/src/plugins/stateMachine/models/StateMachine.ts +42 -42
- package/src/plugins/stateMachine/models/index.ts +3 -3
- package/src/plugins/stateMachine/routes/index.ts +3 -3
- package/src/plugins/stateMachine/routes/sendStateMachineEvent.ts +15 -15
- package/src/plugins/webhooks/WebhooksPlugin.ts +148 -148
- package/src/plugins/webhooks/pluginConfig.ts +1 -0
- package/src/polyfill.ts +5 -5
- package/src/proxy/mod.ts +38 -38
- package/src/queryBuilder/queryBuilder.ts +637 -637
- package/src/server.ts +463 -451
- package/src/types.ts +659 -637
- package/src/utilities/accessControlUtility.ts +33 -33
- package/src/utilities/errorUtility.ts +15 -15
- package/src/utilities/fsUtility.ts +61 -61
- package/src/utilities/httpUtility.ts +19 -19
- package/src/utilities/jwtUtility.ts +26 -26
- package/src/utilities/timeUtility.ts +9 -9
- package/tsconfig.json +19 -19
|
@@ -1,56 +1,56 @@
|
|
|
1
|
-
import { RpdDataModel } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
maintainedBy: "authManager",
|
|
5
|
-
namespace: "auth",
|
|
6
|
-
name: "access_token",
|
|
7
|
-
singularCode: "access_token",
|
|
8
|
-
pluralCode: "access_tokens",
|
|
9
|
-
schema: "public",
|
|
10
|
-
tableName: "access_tokens",
|
|
11
|
-
properties: [
|
|
12
|
-
{
|
|
13
|
-
name: "id",
|
|
14
|
-
code: "id",
|
|
15
|
-
columnName: "id",
|
|
16
|
-
type: "integer",
|
|
17
|
-
required: true,
|
|
18
|
-
autoIncrement: true,
|
|
19
|
-
},
|
|
20
|
-
{
|
|
21
|
-
name: "token",
|
|
22
|
-
code: "token",
|
|
23
|
-
columnName: "token",
|
|
24
|
-
type: "text",
|
|
25
|
-
required: true,
|
|
26
|
-
},
|
|
27
|
-
{
|
|
28
|
-
name: "description",
|
|
29
|
-
code: "description",
|
|
30
|
-
columnName: "description",
|
|
31
|
-
type: "text",
|
|
32
|
-
required: false,
|
|
33
|
-
},
|
|
34
|
-
{
|
|
35
|
-
name: "ownerType",
|
|
36
|
-
code: "ownerType",
|
|
37
|
-
columnName: "owner_type",
|
|
38
|
-
type: "text",
|
|
39
|
-
required: true,
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
name: "ownerId",
|
|
43
|
-
code: "ownerId",
|
|
44
|
-
columnName: "owner_id",
|
|
45
|
-
type: "integer",
|
|
46
|
-
required: true,
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
name: "expirationTime",
|
|
50
|
-
code: "expirationTime",
|
|
51
|
-
columnName: "expiration_time",
|
|
52
|
-
type: "datetime",
|
|
53
|
-
required: true,
|
|
54
|
-
},
|
|
55
|
-
],
|
|
56
|
-
} as RpdDataModel;
|
|
1
|
+
import { RpdDataModel } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
maintainedBy: "authManager",
|
|
5
|
+
namespace: "auth",
|
|
6
|
+
name: "access_token",
|
|
7
|
+
singularCode: "access_token",
|
|
8
|
+
pluralCode: "access_tokens",
|
|
9
|
+
schema: "public",
|
|
10
|
+
tableName: "access_tokens",
|
|
11
|
+
properties: [
|
|
12
|
+
{
|
|
13
|
+
name: "id",
|
|
14
|
+
code: "id",
|
|
15
|
+
columnName: "id",
|
|
16
|
+
type: "integer",
|
|
17
|
+
required: true,
|
|
18
|
+
autoIncrement: true,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
name: "token",
|
|
22
|
+
code: "token",
|
|
23
|
+
columnName: "token",
|
|
24
|
+
type: "text",
|
|
25
|
+
required: true,
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
name: "description",
|
|
29
|
+
code: "description",
|
|
30
|
+
columnName: "description",
|
|
31
|
+
type: "text",
|
|
32
|
+
required: false,
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: "ownerType",
|
|
36
|
+
code: "ownerType",
|
|
37
|
+
columnName: "owner_type",
|
|
38
|
+
type: "text",
|
|
39
|
+
required: true,
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
name: "ownerId",
|
|
43
|
+
code: "ownerId",
|
|
44
|
+
columnName: "owner_id",
|
|
45
|
+
type: "integer",
|
|
46
|
+
required: true,
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
name: "expirationTime",
|
|
50
|
+
code: "expirationTime",
|
|
51
|
+
columnName: "expiration_time",
|
|
52
|
+
type: "datetime",
|
|
53
|
+
required: true,
|
|
54
|
+
},
|
|
55
|
+
],
|
|
56
|
+
} as RpdDataModel;
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import AccessToken from "./AccessToken";
|
|
2
|
-
|
|
3
|
-
export default [AccessToken];
|
|
1
|
+
import AccessToken from "./AccessToken";
|
|
2
|
+
|
|
3
|
+
export default [AccessToken];
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { RpdRoute } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
namespace: "auth",
|
|
5
|
-
name: "auth.changePassword",
|
|
6
|
-
code: "auth.changePassword",
|
|
7
|
-
type: "RESTful",
|
|
8
|
-
method: "POST",
|
|
9
|
-
endpoint: "/changePassword",
|
|
10
|
-
actions: [
|
|
11
|
-
{
|
|
12
|
-
code: "changePassword",
|
|
13
|
-
},
|
|
14
|
-
],
|
|
15
|
-
} satisfies RpdRoute;
|
|
1
|
+
import { RpdRoute } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
namespace: "auth",
|
|
5
|
+
name: "auth.changePassword",
|
|
6
|
+
code: "auth.changePassword",
|
|
7
|
+
type: "RESTful",
|
|
8
|
+
method: "POST",
|
|
9
|
+
endpoint: "/changePassword",
|
|
10
|
+
actions: [
|
|
11
|
+
{
|
|
12
|
+
code: "changePassword",
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
} satisfies RpdRoute;
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { RpdRoute } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
namespace: "auth",
|
|
5
|
-
name: "auth.getMyProfile",
|
|
6
|
-
code: "auth.getMyProfile",
|
|
7
|
-
type: "RESTful",
|
|
8
|
-
method: "GET",
|
|
9
|
-
endpoint: "/me",
|
|
10
|
-
actions: [
|
|
11
|
-
{
|
|
12
|
-
code: "getMyProfile",
|
|
13
|
-
},
|
|
14
|
-
],
|
|
15
|
-
} satisfies RpdRoute;
|
|
1
|
+
import { RpdRoute } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
namespace: "auth",
|
|
5
|
+
name: "auth.getMyProfile",
|
|
6
|
+
code: "auth.getMyProfile",
|
|
7
|
+
type: "RESTful",
|
|
8
|
+
method: "GET",
|
|
9
|
+
endpoint: "/me",
|
|
10
|
+
actions: [
|
|
11
|
+
{
|
|
12
|
+
code: "getMyProfile",
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
} satisfies RpdRoute;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import changePassword from "./changePassword";
|
|
2
|
-
import getMyProfile from "./getMyProfile";
|
|
3
|
-
import resetPassword from "./resetPassword";
|
|
4
|
-
import signin from "./signin";
|
|
5
|
-
import signout from "./signout";
|
|
6
|
-
|
|
7
|
-
export default [changePassword, getMyProfile, resetPassword, signin, signout];
|
|
1
|
+
import changePassword from "./changePassword";
|
|
2
|
+
import getMyProfile from "./getMyProfile";
|
|
3
|
+
import resetPassword from "./resetPassword";
|
|
4
|
+
import signin from "./signin";
|
|
5
|
+
import signout from "./signout";
|
|
6
|
+
|
|
7
|
+
export default [changePassword, getMyProfile, resetPassword, signin, signout];
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { RpdRoute } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
namespace: "auth",
|
|
5
|
-
name: "auth.resetPassword",
|
|
6
|
-
code: "auth.resetPassword",
|
|
7
|
-
type: "RESTful",
|
|
8
|
-
method: "POST",
|
|
9
|
-
endpoint: "/resetPassword",
|
|
10
|
-
actions: [
|
|
11
|
-
{
|
|
12
|
-
code: "resetPassword",
|
|
13
|
-
},
|
|
14
|
-
],
|
|
15
|
-
} satisfies RpdRoute;
|
|
1
|
+
import { RpdRoute } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
namespace: "auth",
|
|
5
|
+
name: "auth.resetPassword",
|
|
6
|
+
code: "auth.resetPassword",
|
|
7
|
+
type: "RESTful",
|
|
8
|
+
method: "POST",
|
|
9
|
+
endpoint: "/resetPassword",
|
|
10
|
+
actions: [
|
|
11
|
+
{
|
|
12
|
+
code: "resetPassword",
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
} satisfies RpdRoute;
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { RpdRoute } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
namespace: "auth",
|
|
5
|
-
name: "auth.signin",
|
|
6
|
-
code: "auth.signin",
|
|
7
|
-
type: "RESTful",
|
|
8
|
-
method: "POST",
|
|
9
|
-
endpoint: "/signin",
|
|
10
|
-
actions: [
|
|
11
|
-
{
|
|
12
|
-
code: "createSession",
|
|
13
|
-
},
|
|
14
|
-
],
|
|
15
|
-
} satisfies RpdRoute;
|
|
1
|
+
import { RpdRoute } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
namespace: "auth",
|
|
5
|
+
name: "auth.signin",
|
|
6
|
+
code: "auth.signin",
|
|
7
|
+
type: "RESTful",
|
|
8
|
+
method: "POST",
|
|
9
|
+
endpoint: "/signin",
|
|
10
|
+
actions: [
|
|
11
|
+
{
|
|
12
|
+
code: "createSession",
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
} satisfies RpdRoute;
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { RpdRoute } from "~/types";
|
|
2
|
-
|
|
3
|
-
export default {
|
|
4
|
-
namespace: "auth",
|
|
5
|
-
name: "auth.signout",
|
|
6
|
-
code: "auth.signout",
|
|
7
|
-
type: "RESTful",
|
|
8
|
-
method: "GET",
|
|
9
|
-
endpoint: "/signout",
|
|
10
|
-
actions: [
|
|
11
|
-
{
|
|
12
|
-
code: "deleteSession",
|
|
13
|
-
},
|
|
14
|
-
],
|
|
15
|
-
} satisfies RpdRoute;
|
|
1
|
+
import { RpdRoute } from "~/types";
|
|
2
|
+
|
|
3
|
+
export default {
|
|
4
|
+
namespace: "auth",
|
|
5
|
+
name: "auth.signout",
|
|
6
|
+
code: "auth.signout",
|
|
7
|
+
type: "RESTful",
|
|
8
|
+
method: "GET",
|
|
9
|
+
endpoint: "/signout",
|
|
10
|
+
actions: [
|
|
11
|
+
{
|
|
12
|
+
code: "deleteSession",
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
} satisfies RpdRoute;
|
|
@@ -1,112 +1,112 @@
|
|
|
1
|
-
import * as cron from "cron";
|
|
2
|
-
import type { RpdApplicationConfig } from "~/types";
|
|
3
|
-
import pluginActionHandlers from "./actionHandlers";
|
|
4
|
-
import pluginRoutes from "./routes";
|
|
5
|
-
import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
|
|
6
|
-
import {
|
|
7
|
-
IRpdServer,
|
|
8
|
-
RapidPlugin,
|
|
9
|
-
RpdConfigurationItemOptions,
|
|
10
|
-
RpdServerPluginConfigurableTargetOptions,
|
|
11
|
-
RpdServerPluginExtendingAbilities,
|
|
12
|
-
} from "~/core/server";
|
|
13
|
-
import { ActionHandlerContext } from "~/core/actionHandler";
|
|
14
|
-
import { find } from "lodash";
|
|
15
|
-
|
|
16
|
-
class CronJobPlugin implements RapidPlugin {
|
|
17
|
-
#jobs: CronJobConfiguration[];
|
|
18
|
-
|
|
19
|
-
constructor(options: CronJobPluginInitOptions) {
|
|
20
|
-
this.#jobs = options.jobs || [];
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
get code(): string {
|
|
24
|
-
return "cronJob";
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
get description(): string {
|
|
28
|
-
return "";
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
|
|
32
|
-
return [];
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
|
|
36
|
-
return [];
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
get configurations(): RpdConfigurationItemOptions[] {
|
|
40
|
-
return [];
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
async initPlugin(server: IRpdServer): Promise<any> {}
|
|
44
|
-
|
|
45
|
-
async registerMiddlewares(server: IRpdServer): Promise<any> {}
|
|
46
|
-
|
|
47
|
-
async registerActionHandlers(server: IRpdServer): Promise<any> {
|
|
48
|
-
for (const actionHandler of pluginActionHandlers) {
|
|
49
|
-
server.registerActionHandler(this, actionHandler);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
async registerEventHandlers(server: IRpdServer): Promise<any> {}
|
|
54
|
-
|
|
55
|
-
async registerMessageHandlers(server: IRpdServer): Promise<any> {}
|
|
56
|
-
|
|
57
|
-
async registerTaskProcessors(server: IRpdServer): Promise<any> {}
|
|
58
|
-
|
|
59
|
-
async onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
60
|
-
|
|
61
|
-
async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
62
|
-
|
|
63
|
-
async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
64
|
-
|
|
65
|
-
async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
|
|
66
|
-
server.appendApplicationConfig({ routes: pluginRoutes });
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
70
|
-
|
|
71
|
-
async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
|
|
72
|
-
for (const job of this.#jobs) {
|
|
73
|
-
const jobInstance = cron.CronJob.from({
|
|
74
|
-
cronTime: job.cronTime,
|
|
75
|
-
onTick: async () => {
|
|
76
|
-
server.getLogger().info(`Executing cron job '${job.code}'...`);
|
|
77
|
-
await this.executeJob(server, job);
|
|
78
|
-
},
|
|
79
|
-
});
|
|
80
|
-
jobInstance.start();
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
getJobConfigurationByCode(code: string) {
|
|
85
|
-
return find(this.#jobs, (job) => job.code === code);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
async executeJob(server: IRpdServer, job: CronJobConfiguration) {
|
|
89
|
-
const logger = server.getLogger();
|
|
90
|
-
try {
|
|
91
|
-
let handlerContext: ActionHandlerContext = {
|
|
92
|
-
logger,
|
|
93
|
-
routerContext: null,
|
|
94
|
-
next: null,
|
|
95
|
-
server,
|
|
96
|
-
applicationConfig: null,
|
|
97
|
-
input: null,
|
|
98
|
-
};
|
|
99
|
-
|
|
100
|
-
if (job.actionHandlerCode) {
|
|
101
|
-
const actionHandler = server.getActionHandlerByCode(job.code);
|
|
102
|
-
await actionHandler(handlerContext, job.handleOptions);
|
|
103
|
-
} else {
|
|
104
|
-
await job.handler(handlerContext, job.handleOptions);
|
|
105
|
-
}
|
|
106
|
-
} catch (ex) {
|
|
107
|
-
logger.error("Cron job execution error: " + ex.message);
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
export default CronJobPlugin;
|
|
1
|
+
import * as cron from "cron";
|
|
2
|
+
import type { RpdApplicationConfig } from "~/types";
|
|
3
|
+
import pluginActionHandlers from "./actionHandlers";
|
|
4
|
+
import pluginRoutes from "./routes";
|
|
5
|
+
import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
|
|
6
|
+
import {
|
|
7
|
+
IRpdServer,
|
|
8
|
+
RapidPlugin,
|
|
9
|
+
RpdConfigurationItemOptions,
|
|
10
|
+
RpdServerPluginConfigurableTargetOptions,
|
|
11
|
+
RpdServerPluginExtendingAbilities,
|
|
12
|
+
} from "~/core/server";
|
|
13
|
+
import { ActionHandlerContext } from "~/core/actionHandler";
|
|
14
|
+
import { find } from "lodash";
|
|
15
|
+
|
|
16
|
+
class CronJobPlugin implements RapidPlugin {
|
|
17
|
+
#jobs: CronJobConfiguration[];
|
|
18
|
+
|
|
19
|
+
constructor(options: CronJobPluginInitOptions) {
|
|
20
|
+
this.#jobs = options.jobs || [];
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
get code(): string {
|
|
24
|
+
return "cronJob";
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
get description(): string {
|
|
28
|
+
return "";
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
|
|
32
|
+
return [];
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
|
|
36
|
+
return [];
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
get configurations(): RpdConfigurationItemOptions[] {
|
|
40
|
+
return [];
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
async initPlugin(server: IRpdServer): Promise<any> {}
|
|
44
|
+
|
|
45
|
+
async registerMiddlewares(server: IRpdServer): Promise<any> {}
|
|
46
|
+
|
|
47
|
+
async registerActionHandlers(server: IRpdServer): Promise<any> {
|
|
48
|
+
for (const actionHandler of pluginActionHandlers) {
|
|
49
|
+
server.registerActionHandler(this, actionHandler);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
async registerEventHandlers(server: IRpdServer): Promise<any> {}
|
|
54
|
+
|
|
55
|
+
async registerMessageHandlers(server: IRpdServer): Promise<any> {}
|
|
56
|
+
|
|
57
|
+
async registerTaskProcessors(server: IRpdServer): Promise<any> {}
|
|
58
|
+
|
|
59
|
+
async onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
60
|
+
|
|
61
|
+
async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
62
|
+
|
|
63
|
+
async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
64
|
+
|
|
65
|
+
async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
|
|
66
|
+
server.appendApplicationConfig({ routes: pluginRoutes });
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
|
|
70
|
+
|
|
71
|
+
async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
|
|
72
|
+
for (const job of this.#jobs) {
|
|
73
|
+
const jobInstance = cron.CronJob.from({
|
|
74
|
+
cronTime: job.cronTime,
|
|
75
|
+
onTick: async () => {
|
|
76
|
+
server.getLogger().info(`Executing cron job '${job.code}'...`);
|
|
77
|
+
await this.executeJob(server, job);
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
jobInstance.start();
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
getJobConfigurationByCode(code: string) {
|
|
85
|
+
return find(this.#jobs, (job) => job.code === code);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
async executeJob(server: IRpdServer, job: CronJobConfiguration) {
|
|
89
|
+
const logger = server.getLogger();
|
|
90
|
+
try {
|
|
91
|
+
let handlerContext: ActionHandlerContext = {
|
|
92
|
+
logger,
|
|
93
|
+
routerContext: null,
|
|
94
|
+
next: null,
|
|
95
|
+
server,
|
|
96
|
+
applicationConfig: null,
|
|
97
|
+
input: null,
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
if (job.actionHandlerCode) {
|
|
101
|
+
const actionHandler = server.getActionHandlerByCode(job.code);
|
|
102
|
+
await actionHandler(handlerContext, job.handleOptions);
|
|
103
|
+
} else {
|
|
104
|
+
await job.handler(handlerContext, job.handleOptions);
|
|
105
|
+
}
|
|
106
|
+
} catch (ex) {
|
|
107
|
+
logger.error("Cron job execution error: " + ex.message);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export default CronJobPlugin;
|
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
import { ActionHandlerContext } from "~/core/actionHandler";
|
|
2
|
-
import { RpdHttpMethod } from "~/types";
|
|
3
|
-
|
|
4
|
-
export interface CronJobConfiguration {
|
|
5
|
-
/**
|
|
6
|
-
* 定时任务编号
|
|
7
|
-
*/
|
|
8
|
-
code: string;
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* 定时任务描述
|
|
12
|
-
*/
|
|
13
|
-
description?: string;
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* crontab 表达式
|
|
17
|
-
*/
|
|
18
|
-
cronTime: string;
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* 任务处理程序编号。当指定处理程序编号时,忽略 handler 配置。
|
|
22
|
-
*/
|
|
23
|
-
actionHandlerCode?: string;
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* 定时任务处理程序
|
|
27
|
-
* @param ctx
|
|
28
|
-
* @param options
|
|
29
|
-
* @returns
|
|
30
|
-
*/
|
|
31
|
-
handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* 处理定时任务时的设置选项
|
|
35
|
-
*/
|
|
36
|
-
handleOptions?: any;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
export interface CronJobPluginInitOptions {
|
|
40
|
-
jobs: CronJobConfiguration[];
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
export type RunCronJobActionHandlerOptions = {
|
|
44
|
-
code?: string;
|
|
45
|
-
};
|
|
46
|
-
|
|
47
|
-
export type RunCronJobInput = {
|
|
48
|
-
code?: string;
|
|
49
|
-
};
|
|
1
|
+
import { ActionHandlerContext } from "~/core/actionHandler";
|
|
2
|
+
import { RpdHttpMethod } from "~/types";
|
|
3
|
+
|
|
4
|
+
export interface CronJobConfiguration {
|
|
5
|
+
/**
|
|
6
|
+
* 定时任务编号
|
|
7
|
+
*/
|
|
8
|
+
code: string;
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* 定时任务描述
|
|
12
|
+
*/
|
|
13
|
+
description?: string;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* crontab 表达式
|
|
17
|
+
*/
|
|
18
|
+
cronTime: string;
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* 任务处理程序编号。当指定处理程序编号时,忽略 handler 配置。
|
|
22
|
+
*/
|
|
23
|
+
actionHandlerCode?: string;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* 定时任务处理程序
|
|
27
|
+
* @param ctx
|
|
28
|
+
* @param options
|
|
29
|
+
* @returns
|
|
30
|
+
*/
|
|
31
|
+
handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* 处理定时任务时的设置选项
|
|
35
|
+
*/
|
|
36
|
+
handleOptions?: any;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface CronJobPluginInitOptions {
|
|
40
|
+
jobs: CronJobConfiguration[];
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export type RunCronJobActionHandlerOptions = {
|
|
44
|
+
code?: string;
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
export type RunCronJobInput = {
|
|
48
|
+
code?: string;
|
|
49
|
+
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IPluginActionHandler } from "~/core/actionHandler";
|
|
2
|
-
import * as runCronJob from "./runCronJob";
|
|
3
|
-
|
|
4
|
-
export default [runCronJob] satisfies IPluginActionHandler[];
|
|
1
|
+
import { IPluginActionHandler } from "~/core/actionHandler";
|
|
2
|
+
import * as runCronJob from "./runCronJob";
|
|
3
|
+
|
|
4
|
+
export default [runCronJob] satisfies IPluginActionHandler[];
|