@ruiapp/rapid-core 0.9.1 → 0.9.2

package/dist/index.d.ts

@@ -29,6 +29,7 @@ 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";

package/dist/index.js

@@ -6876,8 +6876,9 @@ async function handler$e(plugin, ctx, options) {
         };
         return;
     }
+    const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
     const userDataAccessor = server.getDataAccessor({
-        singularCode: "oc_user",
+        singularCode: userEntitySingularCode,
     });
     const user = await userDataAccessor.findOne({
         filters: [
@@ -6915,8 +6916,9 @@ async function handler$d(plugin, ctx, options) {
     const { response } = routeContext;
     const { account, password } = input;
     validateLicense(server);
+    const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
     const userDataAccessor = server.getDataAccessor({
-        singularCode: "oc_user",
+        singularCode: userEntitySingularCode,
     });
     const user = await userDataAccessor.findOne({
         filters: [
@@ -6994,7 +6996,9 @@ async function handler$b(plugin, ctx, options) {
         };
         return;
     }
-    const entityManager = server.getEntityManager("oc_user");
+    const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
+    const profilePropertyCodes = plugin.options?.profilePropertyCodes || ["id", "name", "login", "email", "department", "roles", "state", "createdAt"];
+    const entityManager = server.getEntityManager(userEntitySingularCode);
     const user = await entityManager.findEntity({
         filters: [
             {
@@ -7003,7 +7007,7 @@ async function handler$b(plugin, ctx, options) {
                 value: userId,
             },
         ],
-        properties: ["id", "name", "login", "email", "department", "roles", "state", "createdAt"],
+        properties: profilePropertyCodes,
     });
     ctx.output = {
         user,
@@ -7020,8 +7024,9 @@ const code$a = "resetPassword";
 async function handler$a(plugin, ctx, options) {
     const { server, input, routerContext: routeContext } = ctx;
     const { userId, password } = input;
+    const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
     const userDataAccessor = server.getDataAccessor({
-        singularCode: "oc_user",
+        singularCode: userEntitySingularCode,
     });
     const user = await userDataAccessor.findOne({
         filters: [
@@ -7204,7 +7209,14 @@ class AuthService {
  * Auth manager plugin
  */
 class AuthPlugin {
+    #options;
     #authService;
+    constructor(options) {
+        this.#options = Object.freeze(options);
+    }
+    get options() {
+        return this.#options;
+    }
     get code() {
         return "authManager";
     }

package/dist/plugins/auth/AuthPlugin.d.ts

@@ -4,8 +4,11 @@
 import { RpdApplicationConfig } from "../../types";
 import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "../../core/server";
 import { RouteContext } from "../../core/routeContext";
+import { AuthPluginInitOptions } from "./AuthPluginTypes";
 declare class AuthPlugin implements RapidPlugin {
     #private;
+    constructor(options: AuthPluginInitOptions);
+    get options(): AuthPluginInitOptions;
     get code(): string;
     get description(): string;
     get extendingAbilities(): RpdServerPluginExtendingAbilities[];

package/dist/plugins/auth/AuthPluginTypes.d.ts

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

package/dist/plugins/auth/actionHandlers/changePassword.d.ts

@@ -1,4 +1,4 @@
 import { ActionHandlerContext } from "../../../core/actionHandler";
-import { RapidPlugin } from "../../../core/server";
+import AuthPlugin from "../AuthPlugin";
 export declare const code = "changePassword";
-export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;
+export declare function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;

package/dist/plugins/auth/actionHandlers/createSession.d.ts

@@ -1,4 +1,4 @@
 import { ActionHandlerContext } from "../../../core/actionHandler";
-import { RapidPlugin } from "../../../core/server";
+import AuthPlugin from "../AuthPlugin";
 export declare const code = "createSession";
-export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;
+export declare function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;

package/dist/plugins/auth/actionHandlers/getMyProfile.d.ts

@@ -1,4 +1,4 @@
 import { ActionHandlerContext } from "../../../core/actionHandler";
-import { RapidPlugin } from "../../../core/server";
+import AuthPlugin from "../AuthPlugin";
 export declare const code = "getMyProfile";
-export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;
+export declare function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;

package/dist/plugins/auth/actionHandlers/resetPassword.d.ts

@@ -1,4 +1,4 @@
 import { ActionHandlerContext } from "../../../core/actionHandler";
-import { RapidPlugin } from "../../../core/server";
+import AuthPlugin from "../AuthPlugin";
 export declare const code = "resetPassword";
-export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;
+export declare function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -47,6 +47,7 @@ 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";
 

package/src/plugins/auth/AuthPlugin.ts

@@ -17,10 +17,20 @@ 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";
   }

package/src/plugins/auth/AuthPluginTypes.ts

@@ -0,0 +1,11 @@
+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,10 +1,11 @@
 import bcrypt from "bcrypt";
 import { ActionHandlerContext } from "~/core/actionHandler";
 import { RapidPlugin } from "~/core/server";
+import AuthPlugin from "../AuthPlugin";
 
 export const code = "changePassword";
 
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
   const { server, input, routerContext: routeContext } = ctx;
   const { response } = routeContext;
   const { id, oldPassword, newPassword } = input;
@@ -20,8 +21,9 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
     return;
   }
 
+  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
   const userDataAccessor = server.getDataAccessor({
-    singularCode: "oc_user",
+    singularCode: userEntitySingularCode,
   });
 
   const user = await userDataAccessor.findOne(

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

@@ -4,18 +4,20 @@ import { ActionHandlerContext } from "~/core/actionHandler";
 import { RapidPlugin } from "~/core/server";
 import AuthService from "../services/AuthService";
 import { validateLicense } from "~/helpers/licenseHelper";
+import AuthPlugin from "../AuthPlugin";
 
 export const code = "createSession";
 
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
   const { server, input, routerContext: routeContext, logger } = ctx;
   const { response } = routeContext;
   const { account, password } = input;
 
   validateLicense(server);
 
+  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
   const userDataAccessor = server.getDataAccessor({
-    singularCode: "oc_user",
+    singularCode: userEntitySingularCode,
   });
 
   const user = await userDataAccessor.findOne(

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

@@ -1,9 +1,10 @@
 import { ActionHandlerContext } from "~/core/actionHandler";
 import { RapidPlugin } from "~/core/server";
+import AuthPlugin from "../AuthPlugin";
 
 export const code = "getMyProfile";
 
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
   const { server, input, routerContext } = ctx;
 
   const userId = routerContext.state.userId;
@@ -17,7 +18,9 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
     return;
   }
 
-  const entityManager = server.getEntityManager("oc_user");
+  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
+  const profilePropertyCodes = plugin.options?.profilePropertyCodes || ["id", "name", "login", "email", "department", "roles", "state", "createdAt"];
+  const entityManager = server.getEntityManager(userEntitySingularCode);
   const user = await entityManager.findEntity({
     filters: [
       {
@@ -26,7 +29,7 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
         value: userId,
       },
     ],
-    properties: ["id", "name", "login", "email", "department", "roles", "state", "createdAt"],
+    properties: profilePropertyCodes,
   });
 
   ctx.output = {

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

@@ -1,16 +1,18 @@
 import bcrypt from "bcrypt";
 import { ActionHandlerContext } from "~/core/actionHandler";
 import { RapidPlugin } from "~/core/server";
+import AuthPlugin from "../AuthPlugin";
 
 export const code = "resetPassword";
 
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+export async function handler(plugin: AuthPlugin, ctx: ActionHandlerContext, options: any) {
   const { server, input, routerContext: routeContext } = ctx;
   const { response } = routeContext;
   const { userId, password } = input;
 
+  const userEntitySingularCode = plugin.options?.userEntitySingularCode || "oc_user";
   const userDataAccessor = server.getDataAccessor({
-    singularCode: "oc_user",
+    singularCode: userEntitySingularCode,
   });
 
   const user = await userDataAccessor.findOne(