@ruiapp/rapid-core 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,327 @@
+export type RapidServerConfig = {
+    sessionCookieName: string;
+    jwtKey: string;
+    localFileStoragePath: string;
+};
+export interface IDatabaseConfig {
+    dbHost?: string;
+    dbPort?: number;
+    dbName?: string;
+    dbUser?: string;
+    dbPassword?: string;
+    dbDefaultSchema?: string;
+    dbPoolConnections?: number;
+}
+export interface IDatabaseAccessor {
+    queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
+}
+export interface RunEntityHttpHandlerOptions {
+    /** 模型所在的命名空间 */
+    namespace: string;
+    /** 模型Code的单数表示 */
+    singularCode: string;
+    /** 默认输入 */
+    defaultInput: Record<string, any>;
+    /** 固定输入 */
+    fixedInput: Record<string, any>;
+}
+export interface RunQueryDatabaseHandlerOptions {
+    sql: string;
+    querySingle?: boolean;
+    /** 默认输入 */
+    defaultInput: Record<string, any>;
+    /** 固定输入 */
+    fixedInput: Record<string, any>;
+}
+export interface RunProxyHandlerOptions {
+    /** Timeout milli seconds, default as 60000 */
+    timeout?: number;
+    /** Target url to proxy */
+    target: string;
+}
+export interface GetDataAccessorOptions {
+    namespace?: string;
+    singularCode: string;
+}
+export interface GetModelOptions {
+    namespace?: string;
+    singularCode: string;
+}
+export type RpdServerEventTypes = {
+    "entity.create": [IPluginInstance, RpdEntityCreateEventPayload];
+    "entity.update": [IPluginInstance, RpdEntityUpdateEventPayload];
+    "entity.delete": [IPluginInstance, RpdEntityDeleteEventPayload];
+    "entity.addRelations": [IPluginInstance, RpdEntityAddRelationsEventPayload];
+    "entity.removeRelations": [IPluginInstance, RpdEntityRemoveRelationsEventPayload];
+};
+export interface RpdEntityCreateEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    after: any;
+}
+export interface RpdEntityUpdateEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    before: any;
+    after: any;
+    changes: any;
+}
+export interface RpdEntityDeleteEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    before: any;
+}
+export interface RpdEntityAddRelationsEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    entity: any;
+    property: string;
+    relations: any[];
+}
+export interface RpdEntityRemoveRelationsEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    entity: any;
+    property: string;
+    relations: any[];
+}
+export interface QuoteTableOptions {
+    schema?: string;
+    tableName: string;
+}
+export interface IQueryBuilder {
+    quoteTable: (options: QuoteTableOptions) => string;
+    quoteObject: (name: string) => string;
+}
+export interface RpdApplicationConfig {
+    code?: string;
+    name?: string;
+    models: RpdDataModel[];
+    routes: RpdRoute[];
+}
+export interface RpdDataModel {
+    maintainedBy?: string;
+    name: string;
+    namespace: string;
+    singularCode: string;
+    pluralCode: string;
+    schema?: string;
+    tableName: string;
+    properties: RpdDataModelProperty[];
+    extensions?: RpdDataModelExtension[];
+}
+export interface RpdDataModelProperty {
+    /**
+     * 表示此属性由谁来维护
+     */
+    maintainedBy?: string;
+    /**
+     * 字段名称。可以包含中文。
+     */
+    name: string;
+    /**
+     * 字段代码。会用于数据表列名和 API 的字段名。
+     */
+    code: string;
+    /**
+     * 数据表列名。如果没有设置则使用 code。
+     */
+    columnName?: string;
+    /**
+     * 字段类型。
+     */
+    type: RpdDataPropertyTypes;
+    /**
+     * 是否必须有值。默认为 false。
+     */
+    required?: boolean;
+    /**
+     * 默认值。使用默认值的 SQL 表达式表示。
+     */
+    defaultValue?: string;
+    /**
+     * 属性配置。
+     */
+    config?: Record<string, any>;
+    /**
+     * 是否自增长。
+     */
+    autoIncrement?: boolean;
+    /**
+     * 字段值的最小长度。
+     */
+    minLength?: number;
+    /**
+     * 字段值的最大长度。
+     */
+    maxLength?: number;
+    /**
+     * 当 type 为 relation 时，设置关联实体为一个还是多个。
+     */
+    relation?: "one" | "many";
+    /**
+     * 关联实体的singular code，不管 relation 为 one 或者 many 都需要设置。
+     */
+    targetSingularCode?: string;
+    /**
+     * 当 relation 为 one 时，设置当前模型表中表示关联实体 id 的列名。
+     * 当 relation 为 many，并且使用关联关系表保存关联信息时，设置关联关系表中表示关联实体 id 的列名。
+     * 当 relation 为 many，并且不使用关联关系表保存关联信息时，关联实体 id 的列名默认为`id`，此时可以不设置 targetIdColumnName。
+     */
+    targetIdColumnName?: string;
+    /**
+     * 当 relation 为 many 时，设置目标模型表或关联关系表中表示自身实体 id 的列名。
+     */
+    selfIdColumnName?: string;
+    /**
+     * 当 relation 为 many 时，可以使用关联关系表保存关联信息，此时需要设置关联关系表的名称。
+     */
+    linkTableName?: string;
+    /**
+     * 当设置了 linkTableName 时，可以设置关联关系表所在的 Schema。
+     */
+    linkSchema?: string;
+}
+export type RpdDataPropertyTypes = "integer" | "long" | "float" | "double" | "decimal" | "text" | "boolean" | "date" | "datetime" | "json" | "relation" | "relation[]" | "option";
+/**
+ * 数据字典
+ */
+export type RpdDataDictionary = {
+    /**
+     * 字典编码
+     */
+    code: string;
+    /**
+     * 字典名称
+     */
+    description?: string;
+    /**
+     * 字典项值类型
+     */
+    type: 'string' | 'integer';
+    /**
+     * 字典项
+     */
+    entries: RpdDataDictionaryEntry[];
+};
+/**
+ * 数据字典项
+ */
+export type RpdDataDictionaryEntry = {
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 值
+     */
+    value: string;
+    /**
+     * 描述
+     */
+    description?: string;
+    /**
+     * 排序号
+     */
+    orderNum: number;
+    /**
+     * 是否禁用
+     */
+    disabled: boolean;
+};
+export interface RpdDataModelExtension {
+    code: string;
+    config: any;
+}
+export interface IPluginInstance {
+    getName(): string;
+}
+export type EventHandler<T = any> = (sender: IPluginInstance, payload: T) => void;
+export interface RpdRoute {
+    name: string;
+    namespace: string;
+    code: string;
+    type: "RESTful";
+    method: RpdHttpMethod;
+    endpoint: string;
+    handlers: RpdHttpHandler[];
+}
+export type RpdHttpMethod = "get" | "post" | "put" | "delete";
+export interface RpdHttpHandler {
+    code: string;
+    config: any;
+}
+export interface IRpdDataAccessor<T = any> {
+    getModel(): RpdDataModel;
+    create(entity: any): Promise<any>;
+    updateById(id: any, entity: any): Promise<any>;
+    find(options: FindEntityOptions): Promise<T[]>;
+    findOne(options: FindEntityOptions): Promise<T | null>;
+    findById(id: any): Promise<T | null>;
+    count(options: CountEntityOptions): Promise<any>;
+    deleteById(id: any): Promise<void>;
+}
+export type EntityFilterRelationalOperators = "eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "contains" | "notContains" | "containsCS" | "notContainsCS" | "startsWith" | "notStartsWith" | "endsWith" | "notEndsWith";
+export type EntityFilterSetOperators = "in" | "notIn";
+export type EntityFilterLogicalOperators = "or" | "and";
+export type EntityFilterUnaryOperators = "null" | "notNull";
+export type EntityFilterExistenceOperators = "exists" | "notExists";
+export type EntityFilterOperators = EntityFilterRelationalOperators | EntityFilterSetOperators | EntityFilterLogicalOperators | EntityFilterUnaryOperators | EntityFilterExistenceOperators;
+export type EntityFilterOptions = FindEntityRelationalFilterOptions | FindEntitySetFilterOptions | FindEntityLogicalFilterOptions | FindEntityUnaryFilterOptions | FindEntityExistenceFilterOptions;
+export interface FindEntityOptions {
+    filters?: EntityFilterOptions[];
+    orderBy?: FindEntityOrderByOptions[];
+    pagination?: FindEntityPaginationOptions;
+    properties?: string[] | Record<string, any>;
+}
+export interface FindEntityRelationalFilterOptions {
+    field: string;
+    operator: EntityFilterRelationalOperators;
+    value: any;
+}
+export interface FindEntitySetFilterOptions {
+    field: string;
+    operator: EntityFilterSetOperators;
+    value: any[];
+    itemType?: string;
+}
+export interface FindEntityLogicalFilterOptions {
+    operator: EntityFilterLogicalOperators;
+    filters: EntityFilterOptions[];
+}
+export interface FindEntityUnaryFilterOptions {
+    field: string;
+    operator: EntityFilterUnaryOperators;
+}
+export interface FindEntityExistenceFilterOptions {
+    field: string;
+    operator: EntityFilterExistenceOperators;
+    filters: EntityFilterOptions[];
+}
+export interface FindEntityPaginationOptions {
+    offset: number;
+    limit: number;
+    withoutTotal?: boolean;
+}
+export interface FindEntityOrderByOptions {
+    field: string;
+    desc?: boolean;
+}
+export interface CountEntityOptions {
+    filters?: EntityFilterOptions[];
+}
+export interface CreateEntityOptions {
+    entity: any;
+}
+export interface UpdateEntityOptions {
+    filters?: EntityFilterOptions[];
+    entity: any;
+}
+export interface UpdateEntityByIdOptions {
+    id: any;
+    entity: any;
+    changes: any;
+}
+export interface DeleteEntityOptions {
+    filters?: EntityFilterOptions[];
+}

package/dist/utilities/httpUtility.d.ts

@@ -0,0 +1 @@
+export declare function fetchWithTimeout(url: string, reqInit: RequestInit, timeout?: number): Promise<Response>;

package/dist/utilities/jwtUtility.d.ts

@@ -0,0 +1,8 @@
+export declare function getJWTKey(): string;
+export declare function createJWT(payload: Record<string, any>): Promise<string>;
+export declare function verifyJWT(jwt: string): Promise<{}>;
+export declare function decodeJWT(jwt: string): Promise<{
+    header: {};
+    payload: {};
+    signature: {};
+}>;

package/dist/utilities/rapidUtility.d.ts

@@ -0,0 +1,2 @@
+import { RpdDataModelProperty } from "../types";
+export declare function isRelationProperty(property: RpdDataModelProperty): boolean;

package/dist/utilities/typeUtility.d.ts

@@ -0,0 +1,3 @@
+export declare function isUndefined(val: any): boolean;
+export declare function isNull(val: any): boolean;
+export declare function isNullOrUndefined(val: any): boolean;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@ruiapp/rapid-core",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "keywords": [],
+  "author": "Fossil",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/lodash": "^4.14.186",
+    "@types/node": "^20.11.16",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-tsconfig-paths": "^1.5.2",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^4.8.4"
+  },
+  "peerDependencies": {},
+  "dependencies": {
+    "koa-tree-router": "^0.12.1",
+    "lodash": "^4.17.21",
+    "qs": "^6.11.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && rollup --config",
+    "dev": "rollup --config",
+    "test": "echo \"Error: no test specified\""
+  }
+}

package/rollup.config.js

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