@ruiapp/rapid-core 0.5.11 → 0.5.13

package/src/plugins/license/LicenseService.ts

@@ -1,118 +1,118 @@
-import { IRpdServer } from "~/core/server";
-import EntityManager from "~/dataAccess/entityManager";
-import { LicenseSettings, RpdCert, RpdLicense } from "./LicensePluginTypes";
-import { SystemSettingItem } from "../setting/SettingPluginTypes";
-import SettingService from "../setting/SettingService";
-import { extractCertLicense } from "./helpers/certHelper";
-import dayjs from "dayjs";
-import { get, isString } from "lodash";
-import { isNullOrUndefinedOrEmpty } from "~/utilities/typeUtility";
-
-export interface GetSystemSettingValuesInput {
-  groupCode: string;
-}
-
-export interface SetSystemSettingValuesInput {
-  groupCode: string;
-  values: Record<string, any>;
-}
-
-export interface GetUserSettingValuesInput {
-  groupCode: string;
-}
-
-export default class LicenseService {
-  #server: IRpdServer;
-  #systemSettingItemManager: EntityManager<SystemSettingItem>;
-  #encryptionKey: string;
-  #license: RpdLicense;
-
-  constructor(server: IRpdServer, encryptionKey: string) {
-    this.#server = server;
-    this.#encryptionKey = encryptionKey;
-
-    this.#systemSettingItemManager = server.getEntityManager("system_setting_item");
-  }
-
-  async loadLicense(): Promise<void> {
-    const settingService = this.#server.getService<SettingService>("settingService");
-    const licenseSettings = await settingService.getSystemSettingValues("license");
-    const { deployId } = licenseSettings as LicenseSettings;
-    const certText = licenseSettings.cert;
-
-    if (!deployId || !certText) {
-      this.#server.getLogger().warn("License was not loaded properly.");
-      return;
-    }
-
-    const certJSON = Buffer.from(certText, "base64").toString();
-    const cert: RpdCert = JSON.parse(certJSON);
-
-    try {
-      const license = extractCertLicense(this.#encryptionKey, deployId, cert);
-      this.#license = license;
-    } catch (error) {
-      this.#server.getLogger().error("Loading license failed.", error);
-      throw new Error("Loading license failed.");
-    }
-  }
-
-  getLicense() {
-    return this.#license;
-  }
-
-  isExpired() {
-    if (!this.#license) {
-      return true;
-    }
-
-    const { neverExpire, expireDate } = this.#license.authority;
-
-    if (neverExpire) {
-      return false;
-    }
-
-    if (!expireDate) {
-      return true;
-    }
-
-    const today = dayjs(dayjs().format("YYYY-MM-DD"));
-    return today.isAfter(dayjs(expireDate));
-  }
-
-  getQuota(name: string) {
-    if (!this.#license) {
-      return null;
-    }
-
-    return get(this.#license.authority, `quota.${name}`, null);
-  }
-
-  isOutOfQuota(name: string, currentAmount: number) {
-    const quotaLimit = this.getQuota(name);
-
-    if (isNullOrUndefinedOrEmpty(quotaLimit)) {
-      return true;
-    }
-
-    let quotaLimitAmount: string | number = quotaLimit;
-    if (isString(quotaLimitAmount)) {
-      quotaLimitAmount = parseInt(quotaLimit, 10);
-    }
-
-    if (quotaLimitAmount === -1) {
-      return true;
-    }
-
-    return currentAmount > quotaLimitAmount;
-  }
-
-  isFunctionAllowed(name: string) {
-    if (!this.#license) {
-      return false;
-    }
-
-    const functions = get(this.#license.authority, "functions", []);
-    return functions.includes(name);
-  }
-}
+import { IRpdServer } from "~/core/server";
+import EntityManager from "~/dataAccess/entityManager";
+import { LicenseSettings, RpdCert, RpdLicense } from "./LicensePluginTypes";
+import { SystemSettingItem } from "../setting/SettingPluginTypes";
+import SettingService from "../setting/SettingService";
+import { extractCertLicense } from "./helpers/certHelper";
+import dayjs from "dayjs";
+import { get, isString } from "lodash";
+import { isNullOrUndefinedOrEmpty } from "~/utilities/typeUtility";
+
+export interface GetSystemSettingValuesInput {
+  groupCode: string;
+}
+
+export interface SetSystemSettingValuesInput {
+  groupCode: string;
+  values: Record<string, any>;
+}
+
+export interface GetUserSettingValuesInput {
+  groupCode: string;
+}
+
+export default class LicenseService {
+  #server: IRpdServer;
+  #systemSettingItemManager: EntityManager<SystemSettingItem>;
+  #encryptionKey: string;
+  #license: RpdLicense;
+
+  constructor(server: IRpdServer, encryptionKey: string) {
+    this.#server = server;
+    this.#encryptionKey = encryptionKey;
+
+    this.#systemSettingItemManager = server.getEntityManager("system_setting_item");
+  }
+
+  async loadLicense(): Promise<void> {
+    const settingService = this.#server.getService<SettingService>("settingService");
+    const licenseSettings = await settingService.getSystemSettingValues("license");
+    const { deployId } = licenseSettings as LicenseSettings;
+    const certText = licenseSettings.cert;
+
+    if (!deployId || !certText) {
+      this.#server.getLogger().warn("License was not loaded properly.");
+      return;
+    }
+
+    const certJSON = Buffer.from(certText, "base64").toString();
+    const cert: RpdCert = JSON.parse(certJSON);
+
+    try {
+      const license = extractCertLicense(this.#encryptionKey, deployId, cert);
+      this.#license = license;
+    } catch (error) {
+      this.#server.getLogger().error("Loading license failed.", error);
+      throw new Error("Loading license failed.");
+    }
+  }
+
+  getLicense() {
+    return this.#license;
+  }
+
+  isExpired() {
+    if (!this.#license) {
+      return true;
+    }
+
+    const { neverExpire, expireDate } = this.#license.authority;
+
+    if (neverExpire) {
+      return false;
+    }
+
+    if (!expireDate) {
+      return true;
+    }
+
+    const today = dayjs(dayjs().format("YYYY-MM-DD"));
+    return today.isAfter(dayjs(expireDate));
+  }
+
+  getQuota(name: string) {
+    if (!this.#license) {
+      return null;
+    }
+
+    return get(this.#license.authority, `quota.${name}`, null);
+  }
+
+  isOutOfQuota(name: string, currentAmount: number) {
+    const quotaLimit = this.getQuota(name);
+
+    if (isNullOrUndefinedOrEmpty(quotaLimit)) {
+      return true;
+    }
+
+    let quotaLimitAmount: string | number = quotaLimit;
+    if (isString(quotaLimitAmount)) {
+      quotaLimitAmount = parseInt(quotaLimit, 10);
+    }
+
+    if (quotaLimitAmount === -1) {
+      return true;
+    }
+
+    return currentAmount > quotaLimitAmount;
+  }
+
+  isFunctionAllowed(name: string) {
+    if (!this.#license) {
+      return false;
+    }
+
+    const functions = get(this.#license.authority, "functions", []);
+    return functions.includes(name);
+  }
+}

package/src/plugins/license/actionHandlers/getLicense.ts

@@ -1,18 +1,18 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import LicenseService from "../LicenseService";
-
-export interface GetLicenseOptions {}
-
-export const code = "getLicense";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GetLicenseOptions) {
-  const { server, routerContext } = ctx;
-  const { response } = routerContext;
-
-  const licenseService = server.getService<LicenseService>("licenseService");
-
-  const license = licenseService.getLicense();
-
-  ctx.output = license;
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import LicenseService from "../LicenseService";
+
+export interface GetLicenseOptions {}
+
+export const code = "getLicense";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GetLicenseOptions) {
+  const { server, routerContext } = ctx;
+  const { response } = routerContext;
+
+  const licenseService = server.getService<LicenseService>("licenseService");
+
+  const license = licenseService.getLicense();
+
+  ctx.output = license;
+}

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

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

package/src/plugins/license/helpers/certHelper.ts

@@ -1,21 +1,21 @@
-import { RpdCert } from "../LicensePluginTypes";
-import { decryptData, getEncryptionIV, validateDigitalSignature, generatePubKeyFileContent } from "./cryptoHelper";
-
-export function extractCertLicense(encryptionKey: string, deployId: string, cert: RpdCert) {
-  const iv = getEncryptionIV(deployId);
-  const signature = cert.sig;
-  const pub = generatePubKeyFileContent(cert.pub);
-  const valid = validateDigitalSignature(cert.lic, "base64", signature, "base64", pub);
-  if (!valid) {
-    throw new Error("Certification validate failed.");
-  }
-
-  try {
-    const licenseText = decryptData(cert.lic, "base64", "utf-8", encryptionKey, iv, cert.tag);
-    return JSON.parse(licenseText);
-  } catch (ex) {
-    throw new Error("Certification parse failed.", {
-      cause: ex,
-    });
-  }
-}
+import { RpdCert } from "../LicensePluginTypes";
+import { decryptData, getEncryptionIV, validateDigitalSignature, generatePubKeyFileContent } from "./cryptoHelper";
+
+export function extractCertLicense(encryptionKey: string, deployId: string, cert: RpdCert) {
+  const iv = getEncryptionIV(deployId);
+  const signature = cert.sig;
+  const pub = generatePubKeyFileContent(cert.pub);
+  const valid = validateDigitalSignature(cert.lic, "base64", signature, "base64", pub);
+  if (!valid) {
+    throw new Error("Certification validate failed.");
+  }
+
+  try {
+    const licenseText = decryptData(cert.lic, "base64", "utf-8", encryptionKey, iv, cert.tag);
+    return JSON.parse(licenseText);
+  } catch (ex) {
+    throw new Error("Certification parse failed.", {
+      cause: ex,
+    });
+  }
+}

package/src/plugins/license/helpers/cryptoHelper.ts

@@ -1,47 +1,47 @@
-import crypto, { BinaryToTextEncoding } from "crypto";
-
-export function getEncryptionIV(input: string) {
-  const hash = crypto.createHash("sha512").update(input).digest("hex");
-  return hash.substring(0, 12);
-}
-
-export function generatePubKeyFileContent(base64EncodedPubKey: string) {
-  return `-----BEGIN PUBLIC KEY-----\n${base64EncodedPubKey}\n-----END PUBLIC KEY-----`;
-}
-
-const ENC_ALGORITHM: crypto.CipherGCMTypes = "aes-256-gcm";
-
-// Decrypt data
-export function decryptData(
-  encryptedData: string,
-  encryptedDataEncoding: BufferEncoding,
-  decryptedDataEncoding: BufferEncoding,
-  encryptionKey: string,
-  encryptionIV: string,
-  authTag: string,
-) {
-  const decipher = crypto.createDecipheriv(ENC_ALGORITHM, Buffer.from(encryptionKey, "base64"), encryptionIV);
-  decipher.setAuthTag(Buffer.from(authTag, "base64"));
-  const buff = Buffer.from(encryptedData, encryptedDataEncoding);
-  return Buffer.concat([decipher.update(buff), decipher.final()]).toString(decryptedDataEncoding); // Decrypts data and converts to utf8
-}
-
-export function generateDigitalSignature(data: string, dataEncoding: BufferEncoding, privateKey: string): string {
-  const sign = crypto.createSign("RSA-SHA256");
-  const buffer = Buffer.from(data, dataEncoding);
-  sign.update(buffer);
-  return sign.sign(privateKey, "base64");
-}
-
-export function validateDigitalSignature(
-  data: string,
-  dataEncoding: BufferEncoding,
-  signature: string,
-  signatureEncoding: BinaryToTextEncoding,
-  publicKey: string,
-): boolean {
-  const verify = crypto.createVerify("RSA-SHA256");
-  const buffer = Buffer.from(data, dataEncoding);
-  verify.update(buffer);
-  return verify.verify(publicKey, signature, signatureEncoding);
-}
+import crypto, { BinaryToTextEncoding } from "crypto";
+
+export function getEncryptionIV(input: string) {
+  const hash = crypto.createHash("sha512").update(input).digest("hex");
+  return hash.substring(0, 12);
+}
+
+export function generatePubKeyFileContent(base64EncodedPubKey: string) {
+  return `-----BEGIN PUBLIC KEY-----\n${base64EncodedPubKey}\n-----END PUBLIC KEY-----`;
+}
+
+const ENC_ALGORITHM: crypto.CipherGCMTypes = "aes-256-gcm";
+
+// Decrypt data
+export function decryptData(
+  encryptedData: string,
+  encryptedDataEncoding: BufferEncoding,
+  decryptedDataEncoding: BufferEncoding,
+  encryptionKey: string,
+  encryptionIV: string,
+  authTag: string,
+) {
+  const decipher = crypto.createDecipheriv(ENC_ALGORITHM, Buffer.from(encryptionKey, "base64"), encryptionIV);
+  decipher.setAuthTag(Buffer.from(authTag, "base64"));
+  const buff = Buffer.from(encryptedData, encryptedDataEncoding);
+  return Buffer.concat([decipher.update(buff), decipher.final()]).toString(decryptedDataEncoding); // Decrypts data and converts to utf8
+}
+
+export function generateDigitalSignature(data: string, dataEncoding: BufferEncoding, privateKey: string): string {
+  const sign = crypto.createSign("RSA-SHA256");
+  const buffer = Buffer.from(data, dataEncoding);
+  sign.update(buffer);
+  return sign.sign(privateKey, "base64");
+}
+
+export function validateDigitalSignature(
+  data: string,
+  dataEncoding: BufferEncoding,
+  signature: string,
+  signatureEncoding: BinaryToTextEncoding,
+  publicKey: string,
+): boolean {
+  const verify = crypto.createVerify("RSA-SHA256");
+  const buffer = Buffer.from(data, dataEncoding);
+  verify.update(buffer);
+  return verify.verify(publicKey, signature, signatureEncoding);
+}

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

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

package/src/plugins/license/routes/getLicense.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "svc",
-  name: "svc.getLicense",
-  code: "svc.getLicense",
-  type: "RESTful",
-  method: "GET",
-  endpoint: "/svc/license",
-  actions: [
-    {
-      code: "getLicense",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "svc",
+  name: "svc.getLicense",
+  code: "svc.getLicense",
+  type: "RESTful",
+  method: "GET",
+  endpoint: "/svc/license",
+  actions: [
+    {
+      code: "getLicense",
+    },
+  ],
+} satisfies RpdRoute;

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

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

package/src/plugins/mail/MailPlugin.ts

@@ -1,74 +1,74 @@
-/**
- * Mail 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 MailService from "./MailService";
-import { MailPluginConfig } from "./MailPluginTypes";
-
-class MailPlugin implements RapidPlugin {
-  #mailService!: MailService;
-  #config: MailPluginConfig;
-
-  constructor(config: MailPluginConfig) {
-    this.#config = config;
-  }
-
-  get mailService() {
-    return this.#mailService;
-  }
-
-  get code(): string {
-    return "mail";
-  }
-
-  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.#mailService = new MailService(server, this.#config.smtpServer);
-    server.registerService("mailService", this.#mailService);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ routes: pluginRoutes });
-  }
-
-  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {}
-}
-
-export default MailPlugin;
+/**
+ * Mail 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 MailService from "./MailService";
+import { MailPluginConfig } from "./MailPluginTypes";
+
+class MailPlugin implements RapidPlugin {
+  #mailService!: MailService;
+  #config: MailPluginConfig;
+
+  constructor(config: MailPluginConfig) {
+    this.#config = config;
+  }
+
+  get mailService() {
+    return this.#mailService;
+  }
+
+  get code(): string {
+    return "mail";
+  }
+
+  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.#mailService = new MailService(server, this.#config.smtpServer);
+    server.registerService("mailService", this.#mailService);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {}
+}
+
+export default MailPlugin;

package/src/plugins/mail/MailPluginTypes.ts

@@ -1,27 +1,27 @@
-export type MailPluginConfig = {
-  smtpServer: RpdMailSmtpServer;
-};
-
-export type RpdMailSmtpServer = {
-  host: string;
-  port: number;
-  secure: boolean; // true for port 465, false for other ports (normally 587).
-  username: string;
-  password: string;
-};
-
-export type RpdMail = {
-  from?: string;
-  to?: string;
-  subject?: string;
-  text?: string;
-  html?: string;
-};
-
-export type SendMailOptions = {
-  from?: string;
-  to?: string;
-  subject?: string;
-  text?: string;
-  html?: string;
-};
+export type MailPluginConfig = {
+  smtpServer: RpdMailSmtpServer;
+};
+
+export type RpdMailSmtpServer = {
+  host: string;
+  port: number;
+  secure: boolean; // true for port 465, false for other ports (normally 587).
+  username: string;
+  password: string;
+};
+
+export type RpdMail = {
+  from?: string;
+  to?: string;
+  subject?: string;
+  text?: string;
+  html?: string;
+};
+
+export type SendMailOptions = {
+  from?: string;
+  to?: string;
+  subject?: string;
+  text?: string;
+  html?: string;
+};