@ruiapp/rapid-core 0.9.9 → 0.10.1

package/src/helpers/runCollectionEntityActionHandler.ts

@@ -1,58 +1,58 @@
-import { IDatabaseClient, RunEntityActionHandlerOptions } from "~/types";
-import { mergeInput } from "./inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import EntityManager from "~/dataAccess/entityManager";
-
-type EntityActionHandler = (entityManager: EntityManager, input: any) => Promise<any>;
-
-export default async function runCollectionEntityActionHandler(
-  ctx: ActionHandlerContext,
-  options: RunEntityActionHandlerOptions,
-  code: string,
-  autoMergeInput: boolean,
-  runInTransaction: boolean,
-  handleEntityAction: EntityActionHandler,
-) {
-  const { logger, server, input, routerContext: routeContext } = ctx;
-
-  const { defaultInput, fixedInput } = options;
-  let mergedInput: any;
-  if (autoMergeInput) {
-    mergedInput = mergeInput(defaultInput, input, fixedInput);
-  }
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-
-  const entityManager = server.getEntityManager(options.singularCode);
-
-  if (runInTransaction) {
-    let transactionDbClient: IDatabaseClient;
-
-    try {
-      transactionDbClient = await routeContext.initDbTransactionClient();
-      await routeContext.beginDbTransaction();
-
-      const result = handleEntityAction(entityManager, autoMergeInput ? mergedInput : input);
-      if (result instanceof Promise) {
-        ctx.output = await result;
-      } else {
-        ctx.output = result;
-      }
-
-      await routeContext.commitDbTransaction();
-    } catch (ex) {
-      await routeContext.rollbackDbTransaction();
-      throw ex;
-    } finally {
-      if (transactionDbClient) {
-        transactionDbClient.release();
-      }
-    }
-  } else {
-    const result = handleEntityAction(entityManager, mergedInput);
-    if (result instanceof Promise) {
-      ctx.output = await result;
-    } else {
-      ctx.output = result;
-    }
-  }
-}
+import { IDatabaseClient, RunEntityActionHandlerOptions } from "~/types";
+import { mergeInput } from "./inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import EntityManager from "~/dataAccess/entityManager";
+
+type EntityActionHandler = (entityManager: EntityManager, input: any) => Promise<any>;
+
+export default async function runCollectionEntityActionHandler(
+  ctx: ActionHandlerContext,
+  options: RunEntityActionHandlerOptions,
+  code: string,
+  autoMergeInput: boolean,
+  runInTransaction: boolean,
+  handleEntityAction: EntityActionHandler,
+) {
+  const { logger, server, input, routerContext: routeContext } = ctx;
+
+  const { defaultInput, fixedInput } = options;
+  let mergedInput: any;
+  if (autoMergeInput) {
+    mergedInput = mergeInput(defaultInput, input, fixedInput);
+  }
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+
+  const entityManager = server.getEntityManager(options.singularCode);
+
+  if (runInTransaction) {
+    let transactionDbClient: IDatabaseClient;
+
+    try {
+      transactionDbClient = await routeContext.initDbTransactionClient();
+      await routeContext.beginDbTransaction();
+
+      const result = handleEntityAction(entityManager, autoMergeInput ? mergedInput : input);
+      if (result instanceof Promise) {
+        ctx.output = await result;
+      } else {
+        ctx.output = result;
+      }
+
+      await routeContext.commitDbTransaction();
+    } catch (ex) {
+      await routeContext.rollbackDbTransaction();
+      throw ex;
+    } finally {
+      if (transactionDbClient) {
+        transactionDbClient.release();
+      }
+    }
+  } else {
+    const result = handleEntityAction(entityManager, mergedInput);
+    if (result instanceof Promise) {
+      ctx.output = await result;
+    } else {
+      ctx.output = result;
+    }
+  }
+}

package/src/index.ts

@@ -1,82 +1,82 @@
-import { fixBigIntJSONSerialize } from "./polyfill";
-fixBigIntJSONSerialize();
-
-export * from "./types";
-export * from "./types/cron-job-types";
-export * from "./server";
-
-export * from "./core/facility";
-export * from "./core/request";
-export * from "./core/routeContext";
-export * from "./core/server";
-export * from "./core/http-types";
-export * from "./core/actionHandler";
-
-export { default as DataAccessor } from "./dataAccess/dataAccessor";
-export * from "./dataAccess/dataAccessor";
-
-export { default as EntityManager } from "./dataAccess/entityManager";
-export * from "./dataAccess/entityManager";
-
-export * from "./utilities/accessControlUtility";
-export * from "./utilities/entityUtility";
-export * from "./utilities/fsUtility";
-export * from "./utilities/jwtUtility";
-export * from "./utilities/timeUtility";
-export * from "./utilities/passwordUtility";
-
-export * from "./helpers/entityHelper";
-export * from "./helpers/licenseHelper";
-export * as entityHelper from "./helpers/entityHelper";
-export * as licenseHelper from "./helpers/licenseHelper";
-export * as metaHelper from "./helpers/metaHelper";
-
-export * from "./deno-std/http/cookie";
-
-export { mapDbRowToEntity } from "./dataAccess/entityMapper";
-
-export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";
-
-export { default as CacheFactory } from "./facilities/cache/CacheFactory";
-export * from "./facilities/cache/CacheFacilityTypes";
-
-export { default as MetaManagePlugin } from "./plugins/metaManage/MetaManagePlugin";
-
-export { default as DataManagePlugin } from "./plugins/dataManage/DataManagePlugin";
-
-export { default as RouteManagePlugin } from "./plugins/routeManage/RouteManagePlugin";
-
-export { default as SequencePlugin } from "./plugins/sequence/SequencePlugin";
-export * from "./plugins/sequence/SequencePluginTypes";
-
-export { default as WebhooksPlugin } from "./plugins/webhooks/WebhooksPlugin";
-
-export { default as AuthPlugin } from "./plugins/auth/AuthPlugin";
-export * from "./plugins/auth/AuthPluginTypes";
-
-export { default as FileManagePlugin } from "./plugins/fileManage/FileManagePlugin";
-
-export { default as LicensePlugin } from "./plugins/license/LicensePlugin";
-export * from "./plugins/license/LicensePluginTypes";
-
-export { default as MailPlugin } from "./plugins/mail/MailPlugin";
-export * from "./plugins/mail/MailPluginTypes";
-
-export { default as NotificationPlugin } from "./plugins/notification/NotificationPlugin";
-export * from "./plugins/notification/NotificationPluginTypes";
-
-export { default as ServerOperationPlugin } from "./plugins/serverOperation/ServerOperationPlugin";
-export * from "./plugins/serverOperation/ServerOperationPluginTypes";
-
-export { default as SettingPlugin } from "./plugins/setting/SettingPlugin";
-export * from "./plugins/setting/SettingPluginTypes";
-
-export { default as CronJobPlugin } from "./plugins/cronJob/CronJobPlugin";
-export * from "./plugins/cronJob/CronJobPluginTypes";
-
-export { default as StateMachinePlugin } from "./plugins/stateMachine/StateMachinePlugin";
-export * from "./plugins/stateMachine/StateMachinePluginTypes";
-
-export { default as EntityAccessControlPlugin } from "./plugins/entityAccessControl/EntityAccessControlPlugin";
-
-export * from "./facilities/log/LogFacility";
+import { fixBigIntJSONSerialize } from "./polyfill";
+fixBigIntJSONSerialize();
+
+export * from "./types";
+export * from "./types/cron-job-types";
+export * from "./server";
+
+export * from "./core/facility";
+export * from "./core/request";
+export * from "./core/routeContext";
+export * from "./core/server";
+export * from "./core/http-types";
+export * from "./core/actionHandler";
+
+export { default as DataAccessor } from "./dataAccess/dataAccessor";
+export * from "./dataAccess/dataAccessor";
+
+export { default as EntityManager } from "./dataAccess/entityManager";
+export * from "./dataAccess/entityManager";
+
+export * from "./utilities/accessControlUtility";
+export * from "./utilities/entityUtility";
+export * from "./utilities/fsUtility";
+export * from "./utilities/jwtUtility";
+export * from "./utilities/timeUtility";
+export * from "./utilities/passwordUtility";
+
+export * from "./helpers/entityHelper";
+export * from "./helpers/licenseHelper";
+export * as entityHelper from "./helpers/entityHelper";
+export * as licenseHelper from "./helpers/licenseHelper";
+export * as metaHelper from "./helpers/metaHelper";
+
+export * from "./deno-std/http/cookie";
+
+export { mapDbRowToEntity } from "./dataAccess/entityMapper";
+
+export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";
+
+export { default as CacheFactory } from "./facilities/cache/CacheFactory";
+export * from "./facilities/cache/CacheFacilityTypes";
+
+export { default as MetaManagePlugin } from "./plugins/metaManage/MetaManagePlugin";
+
+export { default as DataManagePlugin } from "./plugins/dataManage/DataManagePlugin";
+
+export { default as RouteManagePlugin } from "./plugins/routeManage/RouteManagePlugin";
+
+export { default as SequencePlugin } from "./plugins/sequence/SequencePlugin";
+export * from "./plugins/sequence/SequencePluginTypes";
+
+export { default as WebhooksPlugin } from "./plugins/webhooks/WebhooksPlugin";
+
+export { default as AuthPlugin } from "./plugins/auth/AuthPlugin";
+export * from "./plugins/auth/AuthPluginTypes";
+
+export { default as FileManagePlugin } from "./plugins/fileManage/FileManagePlugin";
+
+export { default as LicensePlugin } from "./plugins/license/LicensePlugin";
+export * from "./plugins/license/LicensePluginTypes";
+
+export { default as MailPlugin } from "./plugins/mail/MailPlugin";
+export * from "./plugins/mail/MailPluginTypes";
+
+export { default as NotificationPlugin } from "./plugins/notification/NotificationPlugin";
+export * from "./plugins/notification/NotificationPluginTypes";
+
+export { default as ServerOperationPlugin } from "./plugins/serverOperation/ServerOperationPlugin";
+export * from "./plugins/serverOperation/ServerOperationPluginTypes";
+
+export { default as SettingPlugin } from "./plugins/setting/SettingPlugin";
+export * from "./plugins/setting/SettingPluginTypes";
+
+export { default as CronJobPlugin } from "./plugins/cronJob/CronJobPlugin";
+export * from "./plugins/cronJob/CronJobPluginTypes";
+
+export { default as StateMachinePlugin } from "./plugins/stateMachine/StateMachinePlugin";
+export * from "./plugins/stateMachine/StateMachinePluginTypes";
+
+export { default as EntityAccessControlPlugin } from "./plugins/entityAccessControl/EntityAccessControlPlugin";
+
+export * from "./facilities/log/LogFacility";

package/src/plugins/auth/AuthPlugin.ts

@@ -1,103 +1,107 @@
-/**
- * Auth manager 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 { RouteContext } from "~/core/routeContext";
-import { verifyJwt } from "~/utilities/jwtUtility";
-import AuthService from "./services/AuthService";
-import { AuthPluginInitOptions } from "./AuthPluginTypes";
-
-class AuthPlugin implements RapidPlugin {
-  #options: AuthPluginInitOptions;
-  #authService!: AuthService;
-
-  constructor(options: AuthPluginInitOptions) {
-    this.#options = Object.freeze(options);
-  }
-
-  get options(): AuthPluginInitOptions {
-    return this.#options;
-  }
-
-  get code(): string {
-    return "authManager";
-  }
-
-  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.#authService = new AuthService(server, server.config.jwtKey);
-    server.registerService("authService", this.#authService);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ routes: pluginRoutes });
-  }
-
-  async onPrepareRouteContext(server: IRpdServer, routeContext: RouteContext) {
-    const request = routeContext.request;
-    let token: string;
-
-    const headers = request.headers;
-    // No Authorization header
-    if (headers.has("Authorization")) {
-      // Authorization header has no Bearer or no token
-      const authHeader = headers.get("Authorization")!;
-      if (!authHeader.startsWith("Bearer ") || authHeader.length <= 7) {
-        throw new Error("AUTHORIZATION_HEADER_INVALID");
-      }
-
-      token = authHeader.slice(7);
-    } else {
-      token = request.cookies[server.config.sessionCookieName];
-    }
-
-    try {
-      const secretKey = Buffer.from(server.config.jwtKey, "base64");
-      const tokenPayload = verifyJwt(token, secretKey);
-      routeContext.state.userId = Number(tokenPayload.aud as string);
-      routeContext.state.userLogin = tokenPayload.act as string;
-    } catch (error) {
-      const logger = server.getLogger();
-      logger.debug("Verify JWT failed.", { error });
-    }
-  }
-}
-
-export default AuthPlugin;
+/**
+ * Auth manager 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 { RouteContext } from "~/core/routeContext";
+import { verifyJwt } from "~/utilities/jwtUtility";
+import AuthService from "./services/AuthService";
+import { AuthPluginInitOptions } from "./AuthPluginTypes";
+
+class AuthPlugin implements RapidPlugin {
+  #options: AuthPluginInitOptions;
+  #authService!: AuthService;
+
+  constructor(options: AuthPluginInitOptions) {
+    this.#options = Object.freeze(options);
+  }
+
+  get options(): AuthPluginInitOptions {
+    return this.#options;
+  }
+
+  get code(): string {
+    return "authManager";
+  }
+
+  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.#authService = new AuthService(server, {
+      jwtKey: server.config.jwtKey,
+      userEntitySingularCode: this.#options.userEntitySingularCode,
+      profilePropertyCodes: this.#options.profilePropertyCodes,
+    });
+    server.registerService("authService", this.#authService);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onPrepareRouteContext(server: IRpdServer, routeContext: RouteContext) {
+    const request = routeContext.request;
+    let token: string;
+
+    const headers = request.headers;
+    // No Authorization header
+    if (headers.has("Authorization")) {
+      // Authorization header has no Bearer or no token
+      const authHeader = headers.get("Authorization")!;
+      if (!authHeader.startsWith("Bearer ") || authHeader.length <= 7) {
+        throw new Error("AUTHORIZATION_HEADER_INVALID");
+      }
+
+      token = authHeader.slice(7);
+    } else {
+      token = request.cookies[server.config.sessionCookieName];
+    }
+
+    try {
+      const secretKey = Buffer.from(server.config.jwtKey, "base64");
+      const tokenPayload = verifyJwt(token, secretKey);
+      routeContext.state.userId = Number(tokenPayload.aud as string);
+      routeContext.state.userLogin = tokenPayload.act as string;
+    } catch (error) {
+      const logger = server.getLogger();
+      logger.debug("Verify JWT failed.", { error });
+    }
+  }
+}
+
+export default AuthPlugin;

package/src/plugins/auth/AuthPluginTypes.ts

@@ -1,11 +1,11 @@
-export type AuthPluginInitOptions = {
-  /**
-   * 用户实体代号。默认为`oc_user`
-   */
-  userEntitySingularCode?: string;
-
-  /**
-   * 个人资料属性。默认为`["id", "name", "login", "email", "department", "roles", "state", "createdAt"]`
-   */
-  profilePropertyCodes?: string[];
-};
+export type AuthPluginInitOptions = {
+  /**
+   * 用户实体代号。默认为`oc_user`
+   */
+  userEntitySingularCode?: string;
+
+  /**
+   * 个人资料属性。默认为`["id", "name", "login", "email", "department", "roles", "state", "createdAt"]`
+   */
+  profilePropertyCodes?: string[];
+};

package/src/plugins/auth/actionHandlers/changePassword.ts

@@ -1,61 +1,61 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import AuthPlugin from "../AuthPlugin";
-import { generatePasswordHash, validatePassword } from "~/utilities/passwordUtility";
-
-export const code = "changePassword";
-
-export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input, routerContext: routeContext } = ctx;
-  const { response } = routeContext;
-  const { id, oldPassword, newPassword } = input;
-
-  const userId = routeContext.state.userId;
-  if (!userId) {
-    ctx.status = 401;
-    ctx.output = {
-      error: {
-        message: "You are not signed in.",
-      },
-    };
-    return;
-  }
-
-  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
-  const userDataAccessor = server.getDataAccessor({
-    singularCode: userEntitySingularCode,
-  });
-
-  const user = await userDataAccessor.findOne(
-    {
-      filters: [
-        {
-          operator: "eq",
-          field: "id",
-          value: userId,
-        },
-      ],
-    },
-    routeContext?.getDbTransactionClient(),
-  );
-
-  if (!user) {
-    throw new Error("User not found.");
-  }
-
-  const isMatch = await validatePassword(oldPassword, user.password);
-  if (!isMatch) {
-    throw new Error("旧密码错误。");
-  }
-
-  const passwordHash = await generatePasswordHash(newPassword);
-
-  await userDataAccessor.updateById(
-    user.id,
-    {
-      password: passwordHash,
-    },
-    routeContext?.getDbTransactionClient(),
-  );
-
-  ctx.output = {};
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import AuthPlugin from "../AuthPlugin";
+import { generatePasswordHash, validatePassword } from "~/utilities/passwordUtility";
+
+export const code = "changePassword";
+
+export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, input, routerContext: routeContext } = ctx;
+  const { response } = routeContext;
+  const { id, oldPassword, newPassword } = input;
+
+  const userId = routeContext.state.userId;
+  if (!userId) {
+    ctx.status = 401;
+    ctx.output = {
+      error: {
+        message: "You are not signed in.",
+      },
+    };
+    return;
+  }
+
+  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
+  const userDataAccessor = server.getDataAccessor({
+    singularCode: userEntitySingularCode,
+  });
+
+  const user = await userDataAccessor.findOne(
+    {
+      filters: [
+        {
+          operator: "eq",
+          field: "id",
+          value: userId,
+        },
+      ],
+    },
+    routeContext?.getDbTransactionClient(),
+  );
+
+  if (!user) {
+    throw new Error("User not found.");
+  }
+
+  const isMatch = await validatePassword(oldPassword, user.password);
+  if (!isMatch) {
+    throw new Error("旧密码错误。");
+  }
+
+  const passwordHash = await generatePasswordHash(newPassword);
+
+  await userDataAccessor.updateById(
+    user.id,
+    {
+      password: passwordHash,
+    },
+    routeContext?.getDbTransactionClient(),
+  );
+
+  ctx.output = {};
+}