@ruiapp/rapid-core 0.5.11 → 0.5.13

package/CHANGELOG.md

@@ -1,7 +1,7 @@
-# @ruiapp/rapid-core
-
-## 0.2.4
-
-### Patch Changes
-
-- 146a99d: add between filterMode, range is deprecated
+# @ruiapp/rapid-core
+
+## 0.2.4
+
+### Patch Changes
+
+- 146a99d: add between filterMode, range is deprecated

package/dist/facilities/cache/CacheFacilityTypes.d.ts

@@ -7,8 +7,10 @@ export interface CacheProvider {
     createCache: (server: IRpdServer) => Promise<Cache>;
 }
 export interface Cache {
-    set: (key: string, value: any, options?: SetValueOptions) => Promise<void>;
-    get: (key: string) => Promise<any>;
+    set: (key: string, value: string, options?: SetValueOptions) => Promise<void>;
+    setObject: (key: string, value: Record<string, any>, options?: SetValueOptions) => Promise<void>;
+    get: (key: string) => Promise<string | null>;
+    getObject: (key: string) => Promise<Record<string, any> | null>;
     del: (key: string) => Promise<void>;
 }
 export interface SetValueOptions {

package/dist/facilities/cache/MemoryCache.d.ts

@@ -4,7 +4,9 @@ export type MemoryCacheItem<TValue = any> = {
     expireAt: number;
 };
 export default class MemoryCache implements Cache {
-    set(key: string, value: any, options?: SetValueOptions): Promise<void>;
+    set(key: string, value: string, options?: SetValueOptions): Promise<void>;
+    setObject(key: string, value: Record<string, any>, options?: SetValueOptions): Promise<void>;
     get(key: string): Promise<any>;
+    getObject(key: string): Promise<any>;
     del(key: string): Promise<void>;
 }

package/dist/index.d.ts

@@ -6,7 +6,11 @@ export * from "./core/routeContext";
 export * from "./core/server";
 export * from "./core/http-types";
 export * from "./core/actionHandler";
+export * from "./utilities/accessControlUtility";
+export * from "./utilities/entityUtility";
 export * from "./utilities/jwtUtility";
+export * from "./utilities/timeUtility";
+export * from "./utilities/passwordUtility";
 export * from "./deno-std/http/cookie";
 export { mapDbRowToEntity } from "./dataAccess/entityMapper";
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";

package/dist/index.js

@@ -9,7 +9,7 @@ var qs = require('qs');
 var dayjs = require('dayjs');
 var jsonwebtoken = require('jsonwebtoken');
 var crypto = require('crypto');
-var bcrypt = require('bcrypt');
+var bcrypt = require('bcryptjs');
 var path = require('path');
 var fs = require('fs');
 var uuid = require('uuid');
@@ -2509,6 +2509,9 @@ function getEntityPartChanges(server, model, before, after) {
     return null;
 }
 
+function getNowString() {
+    return dayjs__default["default"]().format("YYYY-MM-DD HH:mm:ss.SSS");
+}
 function getNowStringWithTimezone() {
     return dayjs__default["default"]().format("YYYY-MM-DD HH:mm:ss.SSSZ");
 }
@@ -3013,8 +3016,8 @@ async function findManyRelationLinksViaLinkTable(options) {
     const command = `SELECT * FROM ${server.queryBuilder.quoteTable({
         schema: relationProperty.linkSchema,
         tableName: relationProperty.linkTableName,
-    })} WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = ANY($1::int[])
-    ORDER BY id
+    })} WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = ANY($1::int[])
+    ORDER BY id
   `;
     const params = [mainEntityIds];
     const links = await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
@@ -3636,7 +3639,7 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
             await server.queryDatabaseObject(`DELETE FROM ${server.queryBuilder.quoteTable({
                 schema: property.linkSchema,
                 tableName: property.linkTableName,
-            })} WHERE ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = $1
+            })} WHERE ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = $1
               AND ${server.queryBuilder.quoteObject(property.targetIdColumnName)} <> ALL($2::int[])`, [id, targetIdsToKeep], routeContext?.getDbTransactionClient());
         }
         else {
@@ -3665,8 +3668,8 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
                     await server.queryDatabaseObject(`UPDATE ${server.queryBuilder.quoteTable({
                         schema: relationModel.schema,
                         tableName: relationModel.tableName,
-                    })}
-            SET ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = null
+                    })}
+            SET ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = null
             WHERE id = ANY($1::int[])`, [targetIdsToRemove], routeContext?.getDbTransactionClient());
                 }
                 else {
@@ -3951,7 +3954,7 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
                         await server.queryDatabaseObject(`DELETE FROM ${server.queryBuilder.quoteTable({
                             schema: relationProperty.linkSchema,
                             tableName: relationProperty.linkTableName,
-                        })}
+                        })}
               WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = $1`, [id], routeContext?.getDbTransactionClient());
                     }
                     else {
@@ -3961,8 +3964,8 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
                         await server.queryDatabaseObject(`UPDATE ${server.queryBuilder.quoteTable({
                             schema: relationModel.schema,
                             tableName: relationModel.tableName,
-                        })}
-              SET ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = null
+                        })}
+              SET ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = null
               WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = $1`, [id], routeContext?.getDbTransactionClient());
                     }
                 }
@@ -4059,11 +4062,11 @@ class EntityManager {
                 const command = `INSERT INTO ${queryBuilder.quoteTable({
                     schema: relationProperty.linkSchema,
                     tableName: relationProperty.linkTableName,
-                })} (${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)})
-    SELECT $1, $2 WHERE NOT EXISTS (
-      SELECT ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}
-        FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
-        WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2
+                })} (${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)})
+    SELECT $1, $2 WHERE NOT EXISTS (
+      SELECT ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}
+        FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
+        WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2
       )`;
                 const params = [id, relation.id];
                 await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
@@ -4103,7 +4106,7 @@ class EntityManager {
         const { queryBuilder } = server;
         if (relationProperty.linkTableName) {
             for (const relation of relations) {
-                const command = `DELETE FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
+                const command = `DELETE FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
     WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2;`;
                 const params = [id, relation.id];
                 await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
@@ -4511,6 +4514,46 @@ class RapidServer {
     }
 }
 
+function isAccessAllowed(policy, allowedActions) {
+    let isAnyCheckPassed = true;
+    let isAllCheckPassed = true;
+    if (policy.any) {
+        isAnyCheckPassed = false;
+        for (const action of policy.any) {
+            if (lodash.find(allowedActions, (item) => item === action) != null) {
+                isAnyCheckPassed = true;
+                break;
+            }
+        }
+    }
+    if (policy.all) {
+        isAllCheckPassed = true;
+        for (const action of policy.all) {
+            if (lodash.find(allowedActions, (item) => item === action) == null) {
+                isAnyCheckPassed = false;
+                break;
+            }
+        }
+    }
+    return isAnyCheckPassed && isAllCheckPassed;
+}
+
+function getEntityRelationTargetId(entity, propName, targetColumnName) {
+    if (!entity) {
+        throw new Error(`"entity" parameter is required.`);
+    }
+    let targetId = entity[propName];
+    if (!targetId && targetColumnName) {
+        targetId = entity[targetColumnName];
+    }
+    if (lodash.isObject(targetId)) {
+        return targetId.id;
+    }
+    else {
+        return targetId;
+    }
+}
+
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 // This module is browser compatible.
 /**
@@ -4654,30 +4697,66 @@ async function generateJwtSecretKey() {
     return encode(exportedKey);
 }
 
+/**
+ * Generates password hash.
+ * @param password
+ * @param salt
+ * @returns
+ */
+async function generatePasswordHash(password, salt) {
+    if (!salt) {
+        salt = 10;
+    }
+    const passwordHash = await bcrypt__default["default"].hash(password, salt);
+    return passwordHash;
+}
+/**
+ * Validates the password against the hash.
+ * @param password
+ * @param passwordHash
+ * @returns
+ */
+async function validatePassword(password, passwordHash) {
+    const isMatch = await bcrypt__default["default"].compare(password, passwordHash);
+    return isMatch;
+}
+
 const values = new Map();
+async function set(key, value, options) {
+    let expireAt = -1;
+    if (options && options.ttl > 0) {
+        expireAt = new Date().valueOf() + options.ttl;
+    }
+    const cacheItem = {
+        value,
+        expireAt,
+    };
+    values.set(key, cacheItem);
+}
+async function get(key) {
+    const cacheItem = values.get(key);
+    if (cacheItem) {
+        if (cacheItem.expireAt === -1) {
+            return cacheItem.value;
+        }
+        if (cacheItem.expireAt >= new Date().valueOf()) {
+            return cacheItem.value;
+        }
+    }
+    return undefined;
+}
 class MemoryCache {
     async set(key, value, options) {
-        let expireAt = -1;
-        if (options && options.ttl > 0) {
-            expireAt = new Date().valueOf() + options.ttl;
-        }
-        const cacheItem = {
-            value,
-            expireAt,
-        };
-        values.set(key, cacheItem);
+        await set(key, value, options);
+    }
+    async setObject(key, value, options) {
+        await set(key, value, options);
     }
     async get(key) {
-        const cacheItem = values.get(key);
-        if (cacheItem) {
-            if (cacheItem.expireAt === -1) {
-                return cacheItem.value;
-            }
-            if (cacheItem.expireAt >= new Date().valueOf()) {
-                return cacheItem.value;
-            }
-        }
-        return undefined;
+        return get(key);
+    }
+    async getObject(key) {
+        return get(key);
     }
     async del(key) {
         values.delete(key);
@@ -4699,9 +4778,9 @@ class CacheFactory {
     #providers;
     constructor(config) {
         this.name = "cache";
-        const memoryCacheCreator = new MemoryCacheProvider();
+        const memoryCacheProvider = new MemoryCacheProvider();
         this.#providers = new Map();
-        this.#providers.set(memoryCacheCreator.providerName, memoryCacheCreator);
+        this.#providers.set(memoryCacheProvider.providerName, memoryCacheProvider);
         for (const provider of config.providers) {
             this.#providers.set(provider.providerName, provider);
         }
@@ -5003,9 +5082,9 @@ async function syncDatabaseSchema(server, applicationConfig) {
             await server.queryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
         }
     }
-    const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
-    FROM information_schema.columns c
-    INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
+    const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
+    FROM information_schema.columns c
+    INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
     LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
     const columnsInDb = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
     for (const model of applicationConfig.models) {
@@ -6433,12 +6512,11 @@ async function handler$e(plugin, ctx, options) {
     if (!user) {
         throw new Error("User not found.");
     }
-    const isMatch = await bcrypt__default["default"].compare(oldPassword, user.password);
+    const isMatch = await validatePassword(oldPassword, user.password);
     if (!isMatch) {
         throw new Error("旧密码错误。");
     }
-    const saltRounds = 10;
-    const passwordHash = await bcrypt__default["default"].hash(newPassword, saltRounds);
+    const passwordHash = await generatePasswordHash(newPassword);
     await userDataAccessor.updateById(user.id, {
         password: passwordHash,
     }, routeContext?.getDbTransactionClient());
@@ -6480,7 +6558,7 @@ async function handler$d(plugin, ctx, options) {
     if (!user) {
         throw new Error("用户名或密码错误。");
     }
-    const isMatch = await bcrypt__default["default"].compare(password, user.password);
+    const isMatch = await validatePassword(password, user.password);
     if (!isMatch) {
         throw new Error("用户名或密码错误。");
     }
@@ -6578,8 +6656,7 @@ async function handler$a(plugin, ctx, options) {
     if (!user) {
         throw new Error("User not found.");
     }
-    const saltRounds = 10;
-    const passwordHash = await bcrypt__default["default"].hash(password, saltRounds);
+    const passwordHash = await generatePasswordHash(password);
     await userDataAccessor.updateById(user.id, {
         password: passwordHash,
     }, routeContext?.getDbTransactionClient());
@@ -8591,30 +8668,6 @@ function getStateMachineCode(model, property) {
     }
 }
 
-function isAccessAllowed(policy, allowedActions) {
-    let isAnyCheckPassed = true;
-    let isAllCheckPassed = true;
-    if (policy.any) {
-        isAnyCheckPassed = false;
-        for (const action of policy.any) {
-            if (lodash.find(allowedActions, (item) => item === action) != null) {
-                isAnyCheckPassed = true;
-                break;
-            }
-        }
-    }
-    if (policy.all) {
-        isAllCheckPassed = true;
-        for (const action of policy.all) {
-            if (lodash.find(allowedActions, (item) => item === action) == null) {
-                isAnyCheckPassed = false;
-                break;
-            }
-        }
-    }
-    return isAnyCheckPassed && isAllCheckPassed;
-}
-
 class EntityAccessControlPlugin {
     constructor() { }
     get code() {
@@ -8713,9 +8766,9 @@ class EntityAccessControlPlugin {
         if (!userId) {
             return;
         }
-        const actions = await server.queryDatabaseObject(`select distinct a.* from sys_actions a
-      inner join oc_role_sys_action_links ra on a.id = ra.action_id
-      inner join oc_role_user_links ru on ru.role_id = ra.role_id
+        const actions = await server.queryDatabaseObject(`select distinct a.* from sys_actions a
+      inner join oc_role_sys_action_links ra on a.id = ra.action_id
+      inner join oc_role_user_links ru on ru.role_id = ra.role_id
       where ru.user_id = $1;`, [userId]);
         routeContext.state.allowedActions = actions.map((item) => item.code);
     }
@@ -8761,8 +8814,14 @@ exports.createJwt = createJwt;
 exports.decodeJwt = decodeJwt;
 exports.deleteCookie = deleteCookie;
 exports.generateJwtSecretKey = generateJwtSecretKey;
+exports.generatePasswordHash = generatePasswordHash;
 exports.getCookies = getCookies;
+exports.getEntityRelationTargetId = getEntityRelationTargetId;
+exports.getNowString = getNowString;
+exports.getNowStringWithTimezone = getNowStringWithTimezone;
 exports.getSetCookies = getSetCookies;
+exports.isAccessAllowed = isAccessAllowed;
 exports.mapDbRowToEntity = mapDbRowToEntity;
 exports.setCookie = setCookie;
+exports.validatePassword = validatePassword;
 exports.verifyJwt = verifyJwt;

package/dist/utilities/entityUtility.d.ts

@@ -0,0 +1 @@
+export declare function getEntityRelationTargetId(entity: Record<string, any>, propName: string, targetColumnName?: string): number;

package/dist/utilities/passwordUtility.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generates password hash.
+ * @param password
+ * @param salt
+ * @returns
+ */
+export declare function generatePasswordHash(password: string, salt?: number | string): Promise<string>;
+/**
+ * Validates the password against the hash.
+ * @param password
+ * @param passwordHash
+ * @returns
+ */
+export declare function validatePassword(password: string, passwordHash: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.5.11",
+  "version": "0.5.13",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,7 +19,7 @@
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "bcrypt": "^5.1.1",
+    "bcryptjs": "^3.0.2",
     "cron": "^3.1.7",
     "dayjs": "^1.11.7",
     "jsonwebtoken": "^9.0.2",

package/rollup.config.js

@@ -1,16 +1,16 @@
-import typescript from "rollup-plugin-typescript2";
-import tscAlias from "rollup-plugin-tsc-alias";
-
-export default {
-  input: ["src/index.ts"],
-  output: [
-    {
-      dir: "dist",
-      entryFileNames: "[name].js",
-      format: "cjs",
-      exports: "named",
-    },
-  ],
-  plugins: [typescript(), tscAlias()],
-  external: [],
-};
+import typescript from "rollup-plugin-typescript2";
+import tscAlias from "rollup-plugin-tsc-alias";
+
+export default {
+  input: ["src/index.ts"],
+  output: [
+    {
+      dir: "dist",
+      entryFileNames: "[name].js",
+      format: "cjs",
+      exports: "named",
+    },
+  ],
+  plugins: [typescript(), tscAlias()],
+  external: [],
+};