@ruiapp/rapid-core 0.5.11 → 0.6.0

package/dist/bootstrapApplicationConfig.d.ts

@@ -43,17 +43,6 @@ declare const _default: {
             targetSingularCode?: undefined;
             selfIdColumnName?: undefined;
             defaultValue?: undefined;
-        } | {
-            name: string;
-            code: string;
-            type: "relation[]";
-            relation: "many";
-            targetSingularCode: string;
-            selfIdColumnName: string;
-            columnName?: undefined;
-            required?: undefined;
-            autoIncrement?: undefined;
-            defaultValue?: undefined;
         } | {
             name: string;
             code: string;
@@ -65,6 +54,17 @@ declare const _default: {
             targetSingularCode?: undefined;
             selfIdColumnName?: undefined;
             defaultValue?: undefined;
+        } | {
+            name: string;
+            code: string;
+            type: "relation[]";
+            relation: "many";
+            targetSingularCode: string;
+            selfIdColumnName: string;
+            columnName?: undefined;
+            required?: undefined;
+            autoIncrement?: undefined;
+            defaultValue?: undefined;
         } | {
             name: string;
             code: string;
@@ -110,6 +110,7 @@ declare const _default: {
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
             defaultValue?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
@@ -121,6 +122,7 @@ declare const _default: {
             columnName?: undefined;
             autoIncrement?: undefined;
             defaultValue?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
@@ -132,6 +134,7 @@ declare const _default: {
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
             defaultValue?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
@@ -143,6 +146,19 @@ declare const _default: {
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
             defaultValue?: undefined;
+            description?: undefined;
+        } | {
+            name: string;
+            code: string;
+            columnName: string;
+            type: "json";
+            required: false;
+            autoIncrement?: undefined;
+            relation?: undefined;
+            targetSingularCode?: undefined;
+            targetIdColumnName?: undefined;
+            defaultValue?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
@@ -154,22 +170,25 @@ declare const _default: {
             relation?: undefined;
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
             columnName: string;
-            type: "json";
+            type: "integer";
             required: false;
             autoIncrement?: undefined;
             relation?: undefined;
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
             defaultValue?: undefined;
+            description?: undefined;
         } | {
             name: string;
             code: string;
             columnName: string;
-            type: "integer";
+            description: string;
+            type: "text";
             required: false;
             autoIncrement?: undefined;
             relation?: undefined;
@@ -336,6 +355,17 @@ declare const _default: {
             targetSingularCode?: undefined;
             targetIdColumnName?: undefined;
             defaultValue?: undefined;
+        } | {
+            name: string;
+            code: string;
+            columnName: string;
+            type: "json";
+            required: false;
+            autoIncrement?: undefined;
+            relation?: undefined;
+            targetSingularCode?: undefined;
+            targetIdColumnName?: undefined;
+            defaultValue?: undefined;
         })[];
         indexes?: undefined;
     })[];

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,10 @@ 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 "./deno-std/http/cookie";
 export { mapDbRowToEntity } from "./dataAccess/entityMapper";
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";

package/dist/index.js

@@ -1641,6 +1641,13 @@ var bootstrapApplicationConfig = {
                     type: "text",
                     required: false,
                 },
+                {
+                    name: "locales",
+                    code: "locales",
+                    columnName: "locales",
+                    type: "json",
+                    required: false,
+                },
                 {
                     name: "code",
                     code: "code",
@@ -1813,6 +1820,13 @@ var bootstrapApplicationConfig = {
                     type: "text",
                     required: false,
                 },
+                {
+                    name: "locales",
+                    code: "locales",
+                    columnName: "locales",
+                    type: "json",
+                    required: false,
+                },
                 {
                     name: "column name",
                     code: "columnName",
@@ -1935,6 +1949,14 @@ var bootstrapApplicationConfig = {
                     type: "text",
                     required: false,
                 },
+                {
+                    name: "i18n string storage",
+                    code: "i18nStringStorage",
+                    columnName: "i18n_string_storage",
+                    description: "The storage type of i18n strings. `json` or `i18nStringsTable`.",
+                    type: "text",
+                    required: false,
+                },
             ],
             indexes: [
                 {
@@ -2041,6 +2063,13 @@ var bootstrapApplicationConfig = {
                     targetSingularCode: "data_dictionary_entry",
                     selfIdColumnName: "dictionary_id",
                 },
+                {
+                    name: "locales",
+                    code: "locales",
+                    columnName: "locales",
+                    type: "json",
+                    required: false,
+                },
             ],
         },
         {
@@ -2119,6 +2148,13 @@ var bootstrapApplicationConfig = {
                     type: "boolean",
                     required: false,
                 },
+                {
+                    name: "locales",
+                    code: "locales",
+                    columnName: "locales",
+                    type: "json",
+                    required: false,
+                },
             ],
         },
         {
@@ -2197,6 +2233,54 @@ var bootstrapApplicationConfig = {
                 },
             ],
         },
+        {
+            maintainedBy: "dataManager",
+            namespace: "meta",
+            name: "i18n strings",
+            code: "I18nString",
+            singularCode: "i18n_string",
+            pluralCode: "i18n_strings",
+            schema: "public",
+            tableName: "meta_i18n_strings",
+            properties: [
+                {
+                    name: "id",
+                    code: "id",
+                    columnName: "id",
+                    type: "integer",
+                    required: true,
+                    autoIncrement: true,
+                },
+                {
+                    name: "namespace",
+                    code: "namespace",
+                    columnName: "namespace",
+                    type: "text",
+                    required: true,
+                },
+                {
+                    name: "lingual",
+                    code: "lingual",
+                    columnName: "lingual",
+                    type: "text",
+                    required: true,
+                },
+                {
+                    name: "name",
+                    code: "name",
+                    columnName: "name",
+                    type: "text",
+                    required: true,
+                },
+                {
+                    name: "text",
+                    code: "text",
+                    columnName: "text",
+                    type: "text",
+                    required: false,
+                },
+            ],
+        },
     ],
     dataDictionaries: [],
     routes: [
@@ -2509,6 +2593,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");
 }
@@ -4511,6 +4598,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.
 /**
@@ -4655,29 +4782,41 @@ async function generateJwtSecretKey() {
 }
 
 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 +4838,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);
         }
@@ -8591,30 +8730,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() {
@@ -8762,7 +8877,11 @@ exports.decodeJwt = decodeJwt;
 exports.deleteCookie = deleteCookie;
 exports.generateJwtSecretKey = generateJwtSecretKey;
 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.verifyJwt = verifyJwt;

package/dist/types.d.ts

@@ -196,7 +196,19 @@ export interface RpdDataModel {
      * 是否使用软删除
      */
     softDelete?: boolean;
+    /**
+     * 多语言配置
+     */
+    locales?: Record<string, RpdDataModelLocale>;
 }
+/**
+ * 实体多语言配置
+ */
+export type RpdDataModelLocale = {
+    name: string;
+    description?: string;
+    properties?: Record<string, RpdDataModelPropertyLocale>;
+};
 export interface RpdDataModelPermissionPolicies {
     find?: PermissionPolicy;
     create?: PermissionPolicy;
@@ -224,6 +236,10 @@ export interface RpdDataModelProperty {
      * 字段代码。会用于数据表列名和 API 的字段名。
      */
     code: string;
+    /**
+     * 字段描述。
+     */
+    description?: string;
     /**
      * 数据表列名。如果没有设置则使用 code。
      */
@@ -290,7 +306,15 @@ export interface RpdDataModelProperty {
      * 当设置为`true`时，仅允许在创建时设置此属性的值，不允许更新。
      */
     readonly?: boolean;
+    /**
+     * 多语言配置
+     */
+    locales?: Record<string, RpdDataModelPropertyLocale>;
 }
+export type RpdDataModelPropertyLocale = {
+    name: string;
+    description?: string;
+};
 export type RpdDataPropertyTypes = "integer" | "long" | "float" | "double" | "decimal" | "text" | "boolean" | "date" | "time" | "datetime" | "json" | "relation" | "relation[]" | "option" | "option[]" | "file" | "file[]" | "image" | "image[]";
 export type RpdEntityDeleteRelationPropertyReaction = "doNothing" | "unlink" | "cascadingDelete";
 /**
@@ -561,3 +585,9 @@ export type EntityWatchHandlerContext<TEventName extends keyof RpdServerEventTyp
 export interface EntityWatchPluginInitOptions {
     watchers: EntityWatcherType[];
 }
+export interface I18nString {
+    namespace: string;
+    name: string;
+    lingual: string;
+    text?: string;
+}

package/dist/utilities/entityUtility.d.ts

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

package/package.json

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

package/src/bootstrapApplicationConfig.ts

@@ -36,6 +36,13 @@ export default {
           type: "text",
           required: false,
         },
+        {
+          name: "locales",
+          code: "locales",
+          columnName: "locales",
+          type: "json",
+          required: false,
+        },
         {
           name: "code",
           code: "code",
@@ -208,6 +215,13 @@ export default {
           type: "text",
           required: false,
         },
+        {
+          name: "locales",
+          code: "locales",
+          columnName: "locales",
+          type: "json",
+          required: false,
+        },
         {
           name: "column name",
           code: "columnName",
@@ -330,6 +344,14 @@ export default {
           type: "text",
           required: false,
         },
+        {
+          name: "i18n string storage",
+          code: "i18nStringStorage",
+          columnName: "i18n_string_storage",
+          description: "The storage type of i18n strings. `json` or `i18nStringsTable`.",
+          type: "text",
+          required: false,
+        },
       ],
       indexes: [
         {
@@ -436,6 +458,13 @@ export default {
           targetSingularCode: "data_dictionary_entry",
           selfIdColumnName: "dictionary_id",
         },
+        {
+          name: "locales",
+          code: "locales",
+          columnName: "locales",
+          type: "json",
+          required: false,
+        },
       ],
     },
     {
@@ -514,6 +543,13 @@ export default {
           type: "boolean",
           required: false,
         },
+        {
+          name: "locales",
+          code: "locales",
+          columnName: "locales",
+          type: "json",
+          required: false,
+        },
       ],
     },
     {
@@ -592,6 +628,54 @@ export default {
         },
       ],
     },
+    {
+      maintainedBy: "dataManager",
+      namespace: "meta",
+      name: "i18n strings",
+      code: "I18nString",
+      singularCode: "i18n_string",
+      pluralCode: "i18n_strings",
+      schema: "public",
+      tableName: "meta_i18n_strings",
+      properties: [
+        {
+          name: "id",
+          code: "id",
+          columnName: "id",
+          type: "integer",
+          required: true,
+          autoIncrement: true,
+        },
+        {
+          name: "namespace",
+          code: "namespace",
+          columnName: "namespace",
+          type: "text",
+          required: true,
+        },
+        {
+          name: "lingual",
+          code: "lingual",
+          columnName: "lingual",
+          type: "text",
+          required: true,
+        },
+        {
+          name: "name",
+          code: "name",
+          columnName: "name",
+          type: "text",
+          required: true,
+        },
+        {
+          name: "text",
+          code: "text",
+          columnName: "text",
+          type: "text",
+          required: false,
+        },
+      ],
+    },
   ],
   dataDictionaries: [],
   routes: [

package/src/facilities/cache/CacheFacilityTypes.ts

@@ -10,8 +10,10 @@ export interface CacheProvider {
 }
 
 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>;
 }
 

package/src/facilities/cache/CacheFactory.ts

@@ -10,10 +10,10 @@ export default class CacheFactory implements FacilityFactory<Cache, CreateCacheF
   constructor(config: CacheFactoryConfig) {
     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);

package/src/facilities/cache/MemoryCache.ts

@@ -7,33 +7,49 @@ export type MemoryCacheItem<TValue = any> = {
 
 const values: Map<string, MemoryCacheItem> = new Map();
 
-export default class MemoryCache implements Cache {
-  async set(key: string, value: any, options?: SetValueOptions) {
-    let expireAt = -1;
-    if (options && options.ttl > 0) {
-      expireAt = new Date().valueOf() + options.ttl;
+async function set(key: string, value: any, options?: SetValueOptions) {
+  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: string) {
+  const cacheItem = values.get(key);
+  if (cacheItem) {
+    if (cacheItem.expireAt === -1) {
+      return cacheItem.value;
     }
 
-    const cacheItem = {
-      value,
-      expireAt,
-    };
-    values.set(key, cacheItem);
+    if (cacheItem.expireAt >= new Date().valueOf()) {
+      return cacheItem.value;
+    }
+  }
+
+  return undefined;
+}
+
+export default class MemoryCache implements Cache {
+  async set(key: string, value: string, options?: SetValueOptions) {
+    await set(key, value, options);
+  }
+
+  async setObject(key: string, value: Record<string, any>, options?: SetValueOptions) {
+    await set(key, value, options);
   }
 
   async get(key: string) {
-    const cacheItem = values.get(key);
-    if (cacheItem) {
-      if (cacheItem.expireAt === -1) {
-        return cacheItem.value;
-      }
-
-      if (cacheItem.expireAt >= new Date().valueOf()) {
-        return cacheItem.value;
-      }
-    }
+    return get(key);
+  }
 
-    return undefined;
+  async getObject(key: string) {
+    return get(key);
   }
 
   async del(key: string) {

package/src/index.ts

@@ -11,7 +11,10 @@ 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 "./deno-std/http/cookie";
 

package/src/types.ts

@@ -223,8 +223,22 @@ export interface RpdDataModel {
    * 是否使用软删除
    */
   softDelete?: boolean;
+
+  /**
+   * 多语言配置
+   */
+  locales?: Record<string, RpdDataModelLocale>;
 }
 
+/**
+ * 实体多语言配置
+ */
+export type RpdDataModelLocale = {
+  name: string;
+  description?: string;
+  properties?: Record<string, RpdDataModelPropertyLocale>;
+};
+
 export interface RpdDataModelPermissionPolicies {
   find?: PermissionPolicy;
   create?: PermissionPolicy;
@@ -254,6 +268,10 @@ export interface RpdDataModelProperty {
    * 字段代码。会用于数据表列名和 API 的字段名。
    */
   code: string;
+  /**
+   * 字段描述。
+   */
+  description?: string;
   /**
    * 数据表列名。如果没有设置则使用 code。
    */
@@ -323,8 +341,18 @@ export interface RpdDataModelProperty {
    * 当设置为`true`时，仅允许在创建时设置此属性的值，不允许更新。
    */
   readonly?: boolean;
+
+  /**
+   * 多语言配置
+   */
+  locales?: Record<string, RpdDataModelPropertyLocale>;
 }
 
+export type RpdDataModelPropertyLocale = {
+  name: string;
+  description?: string;
+};
+
 export type RpdDataPropertyTypes =
   | "integer"
   | "long"
@@ -720,3 +748,10 @@ export type EntityWatchHandlerContext<TEventName extends keyof RpdServerEventTyp
 export interface EntityWatchPluginInitOptions {
   watchers: EntityWatcherType[];
 }
+
+export interface I18nString {
+  namespace: string;
+  name: string;
+  lingual: string;
+  text?: string;
+}

package/src/utilities/entityUtility.ts

@@ -0,0 +1,18 @@
+import { isObject } from "lodash";
+
+export function getEntityRelationTargetId(entity: Record<string, any>, propName: string, targetColumnName?: string) {
+  if (!entity) {
+    throw new Error(`"entity" parameter is required.`);
+  }
+
+  let targetId: number | { id?: number } = entity[propName];
+  if (!targetId && targetColumnName) {
+    targetId = entity[targetColumnName];
+  }
+
+  if (isObject(targetId)) {
+    return targetId.id;
+  } else {
+    return targetId;
+  }
+}