@ruiapp/rapid-core 0.9.0 → 0.9.1

package/src/plugins/notification/NotificationPlugin.ts

@@ -1,68 +1,68 @@
-/**
- * Notification plugin
- */
-
-import { RpdApplicationConfig } from "~/types";
-import {
-  IRpdServer,
-  RapidPlugin,
-  RpdConfigurationItemOptions,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdServerPluginExtendingAbilities,
-} from "~/core/server";
-
-import pluginActionHandlers from "./actionHandlers";
-import pluginModels from "./models";
-import pluginRoutes from "./routes";
-import NotificationService from "./NotificationService";
-
-class SequencePlugin implements RapidPlugin {
-  #notificationService!: NotificationService;
-
-  get notificationService() {
-    return this.#notificationService;
-  }
-
-  get code(): string {
-    return "notification";
-  }
-
-  get description(): string {
-    return null;
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async registerActionHandlers(server: IRpdServer): Promise<any> {
-    for (const actionHandler of pluginActionHandlers) {
-      server.registerActionHandler(this, actionHandler);
-    }
-  }
-
-  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ models: pluginModels });
-  }
-
-  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    this.#notificationService = new NotificationService(server);
-    server.registerService("notificationService", this.#notificationService);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ routes: pluginRoutes });
-  }
-
-  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {}
-}
-
-export default SequencePlugin;
+/**
+ * Notification plugin
+ */
+
+import { RpdApplicationConfig } from "~/types";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
+
+import pluginActionHandlers from "./actionHandlers";
+import pluginModels from "./models";
+import pluginRoutes from "./routes";
+import NotificationService from "./NotificationService";
+
+class SequencePlugin implements RapidPlugin {
+  #notificationService!: NotificationService;
+
+  get notificationService() {
+    return this.#notificationService;
+  }
+
+  get code(): string {
+    return "notification";
+  }
+
+  get description(): string {
+    return null;
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async registerActionHandlers(server: IRpdServer): Promise<any> {
+    for (const actionHandler of pluginActionHandlers) {
+      server.registerActionHandler(this, actionHandler);
+    }
+  }
+
+  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ models: pluginModels });
+  }
+
+  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    this.#notificationService = new NotificationService(server);
+    server.registerService("notificationService", this.#notificationService);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {}
+}
+
+export default SequencePlugin;

package/src/plugins/notification/NotificationPluginTypes.ts

@@ -1,13 +1,13 @@
-export type RpdNotification = {
-  id?: number;
-  title: string;
-  content?: string;
-  details?: any;
-};
-
-export type SendNotificationOptions = {
-  userId: number;
-  title: string;
-  content?: string;
-  details?: any;
-};
+export type RpdNotification = {
+  id?: number;
+  title: string;
+  content?: string;
+  details?: any;
+};
+
+export type SendNotificationOptions = {
+  userId: number;
+  title: string;
+  content?: string;
+  details?: any;
+};

package/src/plugins/notification/NotificationService.ts

@@ -1,25 +1,25 @@
-import { IRpdServer } from "~/core/server";
-import { SendNotificationOptions, RpdNotification } from "./NotificationPluginTypes";
-import { RouteContext } from "~/core/routeContext";
-
-export default class NotificationService {
-  #server: IRpdServer;
-
-  constructor(server: IRpdServer) {
-    this.#server = server;
-  }
-
-  async sendNotification(routeContext: RouteContext, server: IRpdServer, options: SendNotificationOptions): Promise<RpdNotification> {
-    const notificationManager = server.getEntityManager("notification");
-
-    return await notificationManager.createEntity({
-      routeContext,
-      entity: {
-        title: options.title,
-        content: options.content,
-        details: options.details,
-        user: options.userId,
-      },
-    });
-  }
-}
+import { IRpdServer } from "~/core/server";
+import { SendNotificationOptions, RpdNotification } from "./NotificationPluginTypes";
+import { RouteContext } from "~/core/routeContext";
+
+export default class NotificationService {
+  #server: IRpdServer;
+
+  constructor(server: IRpdServer) {
+    this.#server = server;
+  }
+
+  async sendNotification(routeContext: RouteContext, server: IRpdServer, options: SendNotificationOptions): Promise<RpdNotification> {
+    const notificationManager = server.getEntityManager("notification");
+
+    return await notificationManager.createEntity({
+      routeContext,
+      entity: {
+        title: options.title,
+        content: options.content,
+        details: options.details,
+        user: options.userId,
+      },
+    });
+  }
+}

package/src/plugins/notification/actionHandlers/index.ts

@@ -1,3 +1,3 @@
-import { IPluginActionHandler } from "~/core/actionHandler";
-
-export default [] satisfies IPluginActionHandler[];
+import { IPluginActionHandler } from "~/core/actionHandler";
+
+export default [] satisfies IPluginActionHandler[];

package/src/plugins/notification/models/Notification.ts

@@ -1,60 +1,60 @@
-import { RpdDataModel } from "~/types";
-
-export default {
-  maintainedBy: "notification",
-  namespace: "svc",
-  name: "notification",
-  singularCode: "notification",
-  pluralCode: "notifications",
-  schema: "public",
-  tableName: "notifications",
-  properties: [
-    {
-      name: "id",
-      code: "id",
-      columnName: "id",
-      type: "integer",
-      required: true,
-      autoIncrement: true,
-    },
-    {
-      name: "标题",
-      code: "title",
-      columnName: "title",
-      type: "text",
-      required: true,
-    },
-    {
-      name: "内容",
-      code: "content",
-      columnName: "content",
-      type: "text",
-      required: false,
-    },
-    {
-      name: "已读",
-      code: "read",
-      columnName: "read",
-      type: "boolean",
-      required: false,
-      defaultValue: "false",
-    },
-    {
-      name: "详细信息",
-      code: "details",
-      columnName: "details",
-      description: '{"url": "", "actions": [{"text": "", "url": ""}]}',
-      type: "json",
-      required: false,
-    },
-    {
-      name: "用户",
-      code: "user",
-      type: "relation",
-      required: false,
-      relation: "one",
-      targetSingularCode: "oc_user",
-      targetIdColumnName: "user_id",
-    },
-  ],
-} as RpdDataModel;
+import { RpdDataModel } from "~/types";
+
+export default {
+  maintainedBy: "notification",
+  namespace: "svc",
+  name: "notification",
+  singularCode: "notification",
+  pluralCode: "notifications",
+  schema: "public",
+  tableName: "notifications",
+  properties: [
+    {
+      name: "id",
+      code: "id",
+      columnName: "id",
+      type: "integer",
+      required: true,
+      autoIncrement: true,
+    },
+    {
+      name: "标题",
+      code: "title",
+      columnName: "title",
+      type: "text",
+      required: true,
+    },
+    {
+      name: "内容",
+      code: "content",
+      columnName: "content",
+      type: "text",
+      required: false,
+    },
+    {
+      name: "已读",
+      code: "read",
+      columnName: "read",
+      type: "boolean",
+      required: false,
+      defaultValue: "false",
+    },
+    {
+      name: "详细信息",
+      code: "details",
+      columnName: "details",
+      description: '{"url": "", "actions": [{"text": "", "url": ""}]}',
+      type: "json",
+      required: false,
+    },
+    {
+      name: "用户",
+      code: "user",
+      type: "relation",
+      required: false,
+      relation: "one",
+      targetSingularCode: "oc_user",
+      targetIdColumnName: "user_id",
+    },
+  ],
+} as RpdDataModel;

package/src/plugins/notification/models/index.ts

@@ -1,3 +1,3 @@
-import Notification from "./Notification";
-
-export default [Notification];
+import Notification from "./Notification";
+
+export default [Notification];

package/src/plugins/notification/routes/index.ts

@@ -1 +1 @@
-export default [];
+export default [];

package/src/plugins/routeManage/RouteManagePlugin.ts

@@ -1,62 +1,64 @@
-/**
- * Route manager plugin
- */
-
-import { RpdApplicationConfig } from "~/types";
-import {
-  RpdServerPluginExtendingAbilities,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdConfigurationItemOptions,
-  IRpdServer,
-  RapidPlugin,
-} from "~/core/server";
-import * as httpProxy from "./actionHandlers/httpProxy";
-
-class RouteManager implements RapidPlugin {
-  get code(): string {
-    return "routeManager";
-  }
-
-  get description(): string {
-    return null;
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async registerActionHandlers(server: IRpdServer): Promise<any> {
-    server.registerActionHandler(this, httpProxy);
-  }
-
-  async registerEventHandlers(server: IRpdServer): Promise<any> {
-    // TODO: Should rebuild routes after route configurations changed.
-    // server.registerEventHandler("entity.create", handleEntityEvent.bind(null, server))
-    // server.registerEventHandler("entity.update", handleEntityEvent.bind(null, server))
-    // server.registerEventHandler("entity.delete", handleEntityEvent.bind(null, server))
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    const logger = server.getLogger();
-    try {
-      logger.info("Loading meta of routes...");
-      const entityManager = server.getEntityManager("route");
-      const routes = await entityManager.findEntities({
-        orderBy: [{ field: "endpoint" }],
-      });
-      applicationConfig.routes.push(...routes);
-    } catch (error) {
-      logger.crit("Failed to load meta of routes.", { error });
-    }
-  }
-}
-
-export default RouteManager;
+/**
+ * Route manager plugin
+ */
+
+import { RpdApplicationConfig } from "~/types";
+import {
+  RpdServerPluginExtendingAbilities,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdConfigurationItemOptions,
+  IRpdServer,
+  RapidPlugin,
+} from "~/core/server";
+import * as httpProxyActionHandler from "./actionHandlers/httpProxy";
+import * as mockActionHandler from "./actionHandlers/mock";
+
+class RouteManager implements RapidPlugin {
+  get code(): string {
+    return "routeManager";
+  }
+
+  get description(): string {
+    return null;
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async registerActionHandlers(server: IRpdServer): Promise<any> {
+    server.registerActionHandler(this, httpProxyActionHandler);
+    server.registerActionHandler(this, mockActionHandler);
+  }
+
+  async registerEventHandlers(server: IRpdServer): Promise<any> {
+    // TODO: Should rebuild routes after route configurations changed.
+    // server.registerEventHandler("entity.create", handleEntityEvent.bind(null, server))
+    // server.registerEventHandler("entity.update", handleEntityEvent.bind(null, server))
+    // server.registerEventHandler("entity.delete", handleEntityEvent.bind(null, server))
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    const logger = server.getLogger();
+    try {
+      logger.info("Loading meta of routes...");
+      const entityManager = server.getEntityManager("route");
+      const routes = await entityManager.findEntities({
+        orderBy: [{ field: "endpoint" }],
+      });
+      applicationConfig.routes.push(...routes);
+    } catch (error) {
+      logger.crit("Failed to load meta of routes.", { error });
+    }
+  }
+}
+
+export default RouteManager;

package/src/plugins/routeManage/actionHandlers/httpProxy.ts

@@ -1,13 +1,13 @@
-import { RunProxyHandlerOptions } from "~/types";
-import { doProxy } from "~/proxy/mod";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "httpProxy";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
-  const { logger } = ctx;
-  logger.debug(`Running ${code} handler...`);
-
-  await doProxy(ctx.routerContext, options);
-}
+import { RunProxyHandlerOptions } from "~/types";
+import { doProxy } from "~/proxy/mod";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "httpProxy";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
+  const { logger } = ctx;
+  logger.debug(`Running ${code} handler...`);
+
+  await doProxy(ctx.routerContext, options);
+}

package/src/plugins/routeManage/actionHandlers/mock.ts

@@ -0,0 +1,28 @@
+import { RunMockHandlerOptions } from "~/types";
+import { doProxy } from "~/proxy/mod";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "mock";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunMockHandlerOptions) {
+  const { logger, routerContext } = ctx;
+  const { response } = routerContext;
+
+  const { responseTime, responseStatus, responseHeaders, responseBody } = options;
+
+  if (responseTime) {
+    await waitMilliseconds(responseTime);
+  }
+
+  for (const [key, value] of Object.entries(responseHeaders)) {
+    response.headers.set(key, value as string);
+  }
+
+  response.status = responseStatus || 200;
+  response.body = responseBody || "";
+}
+
+function waitMilliseconds(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}