@ruiapp/rapid-core 0.9.9 → 0.10.1

package/src/plugins/auth/services/AuthService.ts

@@ -1,39 +1,66 @@
-import { IRpdServer } from "~/core/server";
-import { createJwt } from "~/utilities/jwtUtility";
-
-export interface UserAccessToken {
-  sub: "userAccessToken";
-  aud: string;
-}
-
-export interface CreateUserAccessTokenOptions {
-  issuer: string;
-  userId: number;
-  userLogin: string;
-}
-
-export default class AuthService {
-  #server: IRpdServer;
-  #jwtKey: string;
-
-  constructor(server: IRpdServer, jwtKey: string) {
-    this.#server = server;
-    this.#jwtKey = jwtKey;
-  }
-
-  createUserAccessToken(options: CreateUserAccessTokenOptions): string {
-    const secretKey = Buffer.from(this.#jwtKey, "base64");
-    const token = createJwt(
-      {
-        iss: options.issuer,
-        sub: "userAccessToken",
-        aud: "" + options.userId,
-        iat: Math.floor(Date.now() / 1000),
-        act: options.userLogin,
-      } as UserAccessToken,
-      secretKey,
-    );
-
-    return token;
-  }
-}
+import { IRpdServer } from "~/core/server";
+import { createJwt } from "~/utilities/jwtUtility";
+
+export type AuthServiceOptions = {
+  jwtKey: string;
+  userEntitySingularCode?: string;
+  profilePropertyCodes?: string[];
+};
+
+export interface UserAccessToken {
+  sub: "userAccessToken";
+  aud: string;
+}
+
+export interface CreateUserAccessTokenOptions {
+  issuer: string;
+  userId: number;
+  userLogin: string;
+}
+
+export default class AuthService {
+  #server: IRpdServer;
+  #jwtKey: string;
+  #userEntitySingularCode?: string;
+  #profilePropertyCodes?: string[];
+
+  constructor(server: IRpdServer, options: AuthServiceOptions) {
+    this.#server = server;
+    this.#jwtKey = options.jwtKey;
+    this.#userEntitySingularCode = options.userEntitySingularCode;
+    this.#profilePropertyCodes = options.profilePropertyCodes;
+  }
+
+  createUserAccessToken(options: CreateUserAccessTokenOptions): string {
+    const secretKey = Buffer.from(this.#jwtKey, "base64");
+    const token = createJwt(
+      {
+        iss: options.issuer,
+        sub: "userAccessToken",
+        aud: "" + options.userId,
+        iat: Math.floor(Date.now() / 1000),
+        act: options.userLogin,
+      } as UserAccessToken,
+      secretKey,
+    );
+
+    return token;
+  }
+
+  async getProfileOfUser(userId: number) {
+    const userEntitySingularCode = this.#userEntitySingularCode || "oc_user";
+    const profilePropertyCodes = this.#profilePropertyCodes || ["id", "name", "login", "email", "department", "roles", "state", "createdAt"];
+    const entityManager = this.#server.getEntityManager(userEntitySingularCode);
+    const user = await entityManager.findEntity({
+      filters: [
+        {
+          operator: "eq",
+          field: "id",
+          value: userId,
+        },
+      ],
+      properties: profilePropertyCodes,
+    });
+    return user;
+  }
+}

package/src/plugins/cronJob/CronJobPlugin.ts

@@ -1,104 +1,104 @@
-import type { RpdApplicationConfig } from "~/types";
-import pluginModels from "./models";
-import pluginActionHandlers from "./actionHandlers";
-import pluginRoutes from "./routes";
-import pluginEntityWatchers from "./entityWatchers";
-import {
-  IRpdServer,
-  RapidPlugin,
-  RpdConfigurationItemOptions,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdServerPluginExtendingAbilities,
-} from "~/core/server";
-import CronJobService from "./services/CronJobService";
-import { SysCronJob } from "./CronJobPluginTypes";
-import { pick } from "lodash";
-
-class CronJobPlugin implements RapidPlugin {
-  #server: IRpdServer;
-  #cronJobService!: CronJobService;
-
-  constructor() {}
-
-  get code(): string {
-    return "cronJob";
-  }
-
-  get description(): string {
-    return "";
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async initPlugin(server: IRpdServer): Promise<any> {
-    this.#server = server;
-  }
-
-  async registerMiddlewares(server: IRpdServer): Promise<any> {}
-
-  async registerActionHandlers(server: IRpdServer): Promise<any> {
-    for (const actionHandler of pluginActionHandlers) {
-      server.registerActionHandler(this, actionHandler);
-    }
-  }
-
-  async registerEventHandlers(server: IRpdServer): Promise<any> {
-    for (const entityWatcher of pluginEntityWatchers) server.registerEntityWatcher(entityWatcher);
-  }
-  async registerMessageHandlers(server: IRpdServer): Promise<any> {}
-
-  async registerTaskProcessors(server: IRpdServer): Promise<any> {}
-
-  async onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
-
-  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ models: pluginModels });
-  }
-
-  async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
-
-  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    this.#cronJobService = new CronJobService(server);
-    server.registerService("cronJobService", this.#cronJobService);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ routes: pluginRoutes });
-  }
-
-  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    await saveCronJobsToDatabase(server);
-  }
-
-  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    await this.#cronJobService.reloadJobs();
-  }
-}
-
-export default CronJobPlugin;
-
-async function saveCronJobsToDatabase(server: IRpdServer) {
-  const cronJobManager = server.getEntityManager<SysCronJob>("sys_cron_job");
-
-  for (const cronJobToSave of server.listCronJobs()) {
-    const currentCronJob = await cronJobManager.findEntity({
-      filters: [{ operator: "eq", field: "code", value: cronJobToSave.code }],
-    });
-
-    if (!currentCronJob) {
-      await cronJobManager.createEntity({
-        entity: pick(cronJobToSave, ["code", "description", "cronTime", "disabled"]),
-      });
-    }
-  }
-}
+import type { RpdApplicationConfig } from "~/types";
+import pluginModels from "./models";
+import pluginActionHandlers from "./actionHandlers";
+import pluginRoutes from "./routes";
+import pluginEntityWatchers from "./entityWatchers";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
+import CronJobService from "./services/CronJobService";
+import { SysCronJob } from "./CronJobPluginTypes";
+import { pick } from "lodash";
+
+class CronJobPlugin implements RapidPlugin {
+  #server: IRpdServer;
+  #cronJobService!: CronJobService;
+
+  constructor() {}
+
+  get code(): string {
+    return "cronJob";
+  }
+
+  get description(): string {
+    return "";
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async initPlugin(server: IRpdServer): Promise<any> {
+    this.#server = server;
+  }
+
+  async registerMiddlewares(server: IRpdServer): Promise<any> {}
+
+  async registerActionHandlers(server: IRpdServer): Promise<any> {
+    for (const actionHandler of pluginActionHandlers) {
+      server.registerActionHandler(this, actionHandler);
+    }
+  }
+
+  async registerEventHandlers(server: IRpdServer): Promise<any> {
+    for (const entityWatcher of pluginEntityWatchers) server.registerEntityWatcher(entityWatcher);
+  }
+  async registerMessageHandlers(server: IRpdServer): Promise<any> {}
+
+  async registerTaskProcessors(server: IRpdServer): Promise<any> {}
+
+  async onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
+
+  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ models: pluginModels });
+  }
+
+  async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
+
+  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    this.#cronJobService = new CronJobService(server);
+    server.registerService("cronJobService", this.#cronJobService);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    await saveCronJobsToDatabase(server);
+  }
+
+  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    await this.#cronJobService.reloadJobs();
+  }
+}
+
+export default CronJobPlugin;
+
+async function saveCronJobsToDatabase(server: IRpdServer) {
+  const cronJobManager = server.getEntityManager<SysCronJob>("sys_cron_job");
+
+  for (const cronJobToSave of server.listCronJobs()) {
+    const currentCronJob = await cronJobManager.findEntity({
+      filters: [{ operator: "eq", field: "code", value: cronJobToSave.code }],
+    });
+
+    if (!currentCronJob) {
+      await cronJobManager.createEntity({
+        entity: pick(cronJobToSave, ["code", "description", "cronTime", "disabled"]),
+      });
+    }
+  }
+}

package/src/plugins/cronJob/CronJobPluginTypes.ts

@@ -1,44 +1,44 @@
-import { CronJob } from "cron";
-import { CronJobConfiguration } from "~/types/cron-job-types";
-
-export type RunCronJobActionHandlerOptions = {
-  code?: string;
-};
-
-export type RunCronJobInput = {
-  code?: string;
-  input?: any;
-};
-
-export type NamedCronJobInstance = {
-  code: string;
-  instance: CronJob;
-};
-
-export type JobRunningResult = "success" | "failed" | "error";
-
-export type SysCronJob = {
-  id: number;
-  code: string;
-  description: string;
-  cronTime: string;
-  disabled: boolean;
-  jobOptions: CronJobConfiguration["jobOptions"];
-  isRunning: boolean;
-  nextRunningTime: string;
-  lastRunningTime: string;
-  lastRunningResult?: JobRunningResult;
-  lastErrorMessage?: string;
-  lastErrorStack?: string;
-  actionHandlerCode?: string;
-  handler?: string;
-  handleOptions?: Record<string, any>;
-  onError?: string;
-};
-
-export type UpdateJobConfigOptions = {
-  code: string;
-  cronTime?: string;
-  disabled?: boolean;
-  jobOptions?: CronJobConfiguration["jobOptions"];
-};
+import { CronJob } from "cron";
+import { CronJobConfiguration } from "~/types/cron-job-types";
+
+export type RunCronJobActionHandlerOptions = {
+  code?: string;
+};
+
+export type RunCronJobInput = {
+  code?: string;
+  input?: any;
+};
+
+export type NamedCronJobInstance = {
+  code: string;
+  instance: CronJob;
+};
+
+export type JobRunningResult = "success" | "failed" | "error";
+
+export type SysCronJob = {
+  id: number;
+  code: string;
+  description: string;
+  cronTime: string;
+  disabled: boolean;
+  jobOptions: CronJobConfiguration["jobOptions"];
+  isRunning: boolean;
+  nextRunningTime: string;
+  lastRunningTime: string;
+  lastRunningResult?: JobRunningResult;
+  lastErrorMessage?: string;
+  lastErrorStack?: string;
+  actionHandlerCode?: string;
+  handler?: string;
+  handleOptions?: Record<string, any>;
+  onError?: string;
+};
+
+export type UpdateJobConfigOptions = {
+  code: string;
+  cronTime?: string;
+  disabled?: boolean;
+  jobOptions?: CronJobConfiguration["jobOptions"];
+};

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

@@ -1,4 +1,4 @@
-import { IPluginActionHandler } from "~/core/actionHandler";
-import * as runCronJob from "./runCronJob";
-
-export default [runCronJob] satisfies IPluginActionHandler[];
+import { IPluginActionHandler } from "~/core/actionHandler";
+import * as runCronJob from "./runCronJob";
+
+export default [runCronJob] satisfies IPluginActionHandler[];

package/src/plugins/cronJob/actionHandlers/runCronJob.ts

@@ -1,32 +1,32 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RunCronJobActionHandlerOptions, RunCronJobInput } from "../CronJobPluginTypes";
-import type CronJobPlugin from "../CronJobPlugin";
-import CronJobService from "../services/CronJobService";
-
-export const code = "runCronJob";
-
-export async function handler(plugin: CronJobPlugin, ctx: ActionHandlerContext, options: RunCronJobActionHandlerOptions) {
-  const { server, routerContext: routeContext } = ctx;
-  const { response } = routeContext;
-
-  const input: RunCronJobInput = ctx.input;
-
-  if (options?.code) {
-    input.code = options.code;
-  }
-
-  if (!input.code) {
-    throw new Error(`Cron job code is required.`);
-  }
-
-  const cronJobService = server.getService<CronJobService>("cronJobService");
-  const jobConfig = cronJobService.getJobConfigurationByCode(input.code);
-  if (!jobConfig) {
-    throw new Error(`Cron job with code '${input.code}' was not found.`);
-  }
-
-  // running job in background.
-  cronJobService.executeJob(jobConfig, input.input);
-
-  response.json({});
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RunCronJobActionHandlerOptions, RunCronJobInput } from "../CronJobPluginTypes";
+import type CronJobPlugin from "../CronJobPlugin";
+import CronJobService from "../services/CronJobService";
+
+export const code = "runCronJob";
+
+export async function handler(plugin: CronJobPlugin, ctx: ActionHandlerContext, options: RunCronJobActionHandlerOptions) {
+  const { server, routerContext: routeContext } = ctx;
+  const { response } = routeContext;
+
+  const input: RunCronJobInput = ctx.input;
+
+  if (options?.code) {
+    input.code = options.code;
+  }
+
+  if (!input.code) {
+    throw new Error(`Cron job code is required.`);
+  }
+
+  const cronJobService = server.getService<CronJobService>("cronJobService");
+  const jobConfig = cronJobService.getJobConfigurationByCode(input.code);
+  if (!jobConfig) {
+    throw new Error(`Cron job with code '${input.code}' was not found.`);
+  }
+
+  // running job in background.
+  cronJobService.executeJob(jobConfig, input.input);
+
+  response.json({});
+}

package/src/plugins/cronJob/entityWatchers/cronJobEntityWatchers.ts

@@ -1,24 +1,24 @@
-import type { EntityWatcher, EntityWatchHandlerContext } from "~/types";
-import CronJobService from "../services/CronJobService";
-import { SysCronJob } from "../CronJobPluginTypes";
-
-export default [
-  {
-    eventName: "entity.update",
-    modelSingularCode: "sys_cron_job",
-    handler: async (ctx: EntityWatchHandlerContext<"entity.update">) => {
-      const { server, payload, routerContext: routeContext } = ctx;
-
-      const cronJobService = server.getService<CronJobService>("cronJobService");
-
-      const changes: Partial<SysCronJob> = payload.changes;
-      const after: SysCronJob = payload.after;
-      await cronJobService.updateJobConfig(routeContext, {
-        code: after.code,
-        cronTime: changes.cronTime,
-        disabled: changes.disabled,
-        jobOptions: changes.jobOptions,
-      });
-    },
-  },
-] satisfies EntityWatcher<any>[];
+import type { EntityWatcher, EntityWatchHandlerContext } from "~/types";
+import CronJobService from "../services/CronJobService";
+import { SysCronJob } from "../CronJobPluginTypes";
+
+export default [
+  {
+    eventName: "entity.update",
+    modelSingularCode: "sys_cron_job",
+    handler: async (ctx: EntityWatchHandlerContext<"entity.update">) => {
+      const { server, payload, routerContext: routeContext } = ctx;
+
+      const cronJobService = server.getService<CronJobService>("cronJobService");
+
+      const changes: Partial<SysCronJob> = payload.changes;
+      const after: SysCronJob = payload.after;
+      await cronJobService.updateJobConfig(routeContext, {
+        code: after.code,
+        cronTime: changes.cronTime,
+        disabled: changes.disabled,
+        jobOptions: changes.jobOptions,
+      });
+    },
+  },
+] satisfies EntityWatcher<any>[];

package/src/plugins/cronJob/entityWatchers/index.ts

@@ -1,4 +1,4 @@
-import { EntityWatcher } from "~/types";
-import cronJobEntityWatchers from "./cronJobEntityWatchers";
-
-export default [...cronJobEntityWatchers] satisfies EntityWatcher<any>[];
+import { EntityWatcher } from "~/types";
+import cronJobEntityWatchers from "./cronJobEntityWatchers";
+
+export default [...cronJobEntityWatchers] satisfies EntityWatcher<any>[];