@pisell/core 1.0.14 → 1.0.15

package/es/app/app.d.ts

@@ -0,0 +1,87 @@
+import { RouterManager } from '../routes';
+import { ApplicationManager } from '../applicationManager';
+import { History, HistoryOptions } from '../history';
+import { Data } from '../data';
+import { Locales, LocalesOptions } from '../locales';
+import { Storage, StorageOptions } from '../storage';
+import { MenuManager } from '../menuManager';
+import LoggerManager, { LoggerOptions } from '../logger';
+import { TasksManager } from '../tasks';
+import IndexDBManager, { DBOptions } from '../indexDB';
+import CMD from "../cmd";
+import AWS from "../aws";
+declare global {
+    interface Window {
+        app: App;
+    }
+}
+export interface AppOptions {
+    logger?: LoggerOptions;
+    db?: DBOptions;
+    constants?: any;
+    history?: HistoryOptions;
+    storage?: StorageOptions;
+    locales?: LocalesOptions;
+}
+declare class App {
+    private static instance;
+    private plugins;
+    globalData: any;
+    router: RouterManager;
+    applicationManager: ApplicationManager;
+    history: History;
+    data: Data;
+    hooks: import("../hooks").HooksExport;
+    locales: Locales;
+    models: {
+        getStore: () => import("../models").Store;
+        StoreProvider: typeof import("react-redux").Provider;
+        setConfig: (models: any[]) => void;
+    };
+    request: {
+        get: (url: string, data: any, config: import("../request").RequestSetting | undefined) => Promise<any>;
+        post: (url: string, data: any, config: import("../request").RequestSetting | undefined) => Promise<any>;
+        put: (url: string, data: any, config: import("../request").RequestSetting | undefined) => Promise<any>;
+        remove: (url: string, data: any, config: import("../request").RequestSetting | undefined) => Promise<any>;
+        custom: (url: string, config: import("../request").RequestSetting | undefined) => Promise<any>;
+        setConfig: (newConfig: Partial<import("../request").RequestConfig>) => void;
+        getConfig: () => import("../request").RequestConfig;
+    };
+    storage: Storage;
+    menuManager: MenuManager;
+    cookie: {
+        setCookie: (name: string, value: string, domain?: string | undefined) => void;
+        getCookie: (name: string) => string | null;
+        deleteCookie: (name: string, domain?: string | undefined) => void;
+        checkCookie: (name: string) => boolean;
+        updateCookie: (name: string, value: string, domain?: string | undefined) => void;
+    };
+    website: {
+        setTitle: (title: string) => void;
+        setIcon: (paramsIcon: string) => void;
+        setAppleWebAppTitle: (title: string) => void;
+    };
+    logger: LoggerManager;
+    pubsub: import("../pubsub").PubSub;
+    cmd: CMD;
+    aws: AWS;
+    tasksManager: TasksManager;
+    dbManager: IndexDBManager | null;
+    constants: {
+        channel: string;
+        [key: string]: string;
+    };
+    private constructor();
+    static getInstance(options?: AppOptions): App;
+    setGlobalData(globalData: any): void;
+    usePlugin(name: string, plugin: any): void;
+    usePlugins(plugins: {
+        name: string;
+        plugin: any;
+    }[]): void;
+    getPlugin(name: string): any;
+    getGlobalData(): any;
+    install(): void;
+    unInstall(): void;
+}
+export default App;

package/es/app/const.d.ts

@@ -0,0 +1,4 @@
+export declare enum APPEvent {
+    APP_INSTALL = "app.install",
+    APP_UNINSTALL = "app.uninstall"
+}

package/es/app/index.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+import App, { AppOptions } from "./app";
+declare type AppContextType = {
+    globalData: any;
+    setGlobalData: React.Dispatch<React.SetStateAction<any>>;
+    app: App;
+};
+export declare const AppProvider: React.FC<{
+    children: React.ReactNode;
+    options: AppOptions;
+}>;
+export declare const useApp: () => AppContextType;
+export declare const getApp: typeof App.getInstance;
+export default App;

package/es/applicationManager/application.d.ts

@@ -0,0 +1,50 @@
+import App from "../app";
+import { LoadLibraryByUrlParams } from "../locales/type";
+import { MenuItem } from "../menuManager/index";
+export declare type ApplicationInterface = {
+    page_type: "low_code" | "code";
+    page_id: number | string;
+    page_code: string;
+    page_version?: string;
+    page_name: string;
+    router: string;
+    category: "page" | "component" | "function";
+    Component?: any;
+    children?: any;
+    layout?: string;
+    originalUrl?: string;
+};
+export declare type ApplicationData = {
+    app_id: number;
+    app_name: string;
+    app_type: "system" | "custom";
+    interfaces: ApplicationInterface[];
+    functions?: any[];
+    menu?: {
+        [key: string]: MenuItem[];
+    };
+    locales?: LoadLibraryByUrlParams;
+    [key: string]: any;
+};
+export declare class Application {
+    options: ApplicationData;
+    name: ApplicationData["app_name"];
+    interfaces: Map<ApplicationInterface["page_name"], ApplicationInterface>;
+    components: Map<string, any>;
+    functions: Map<string, any>;
+    app: App;
+    constructor(options: ApplicationData, app: App);
+    afterAdd(application: Application): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    initInterfaces(interfaces: ApplicationData["interfaces"]): void;
+    initFunctions(functions: ApplicationData["functions"]): void;
+    loadInterface(interfaceItem: ApplicationInterface): Promise<ApplicationInterface>;
+    setInterface(code: string, interfaceItem: ApplicationInterface): void;
+    setComponent(code: string, component: ApplicationInterface): void;
+    setFunction(code: string, functionItem: ApplicationInterface): void;
+    getInterface(code: string): ApplicationInterface | undefined;
+    getComponent(code: string): any;
+    getFunction(code: string): any;
+    runFunction(code: string, params?: any, ...args: any): any;
+}

package/es/applicationManager/index.d.ts

@@ -0,0 +1,13 @@
+import APP from "../app";
+import { Application, ApplicationData } from "./application";
+export declare class ApplicationManager {
+    applicationList: Application[];
+    protected app: APP;
+    applications: Map<string, Application>;
+    constructor(applicationList: Application[], app: APP);
+    init(applicationList: Application[] | ApplicationData[]): Promise<unknown>;
+    add(application: Application): Promise<void>;
+    get(appName: Application["name"]): Application | undefined;
+    remove(appName: Application["name"]): void;
+    load(): Promise<void>;
+}

package/es/aws/index.d.ts

@@ -0,0 +1,16 @@
+import { S3ClientConfig, PutObjectCommandInput } from '@aws-sdk/client-s3';
+import App from '../app';
+export interface AWSOptions extends S3ClientConfig {
+    s3Config: S3ClientConfig;
+    bucketName?: string;
+}
+export interface UploadParams extends PutObjectCommandInput {
+}
+declare class AWS {
+    private s3Client?;
+    private app;
+    private config?;
+    constructor(app: App, options?: AWSOptions);
+    upload(params: UploadParams): Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput | undefined>;
+}
+export default AWS;

package/es/cmd/const.d.ts

@@ -0,0 +1,11 @@
+export declare enum CMDCoreEnum {
+    CMD_CONNECT,
+    CMD_DISCONNECT,
+    CMD_RECONNECT,
+    CMD_MESSAGE,
+    CMD_ERROR
+}
+declare const _default: {
+    CMDCoreEnum: typeof CMDCoreEnum;
+};
+export default _default;

package/es/cmd/index.d.ts

@@ -0,0 +1,13 @@
+import App from "../app";
+import { CMDCoreEnum } from "./const";
+export interface CMDOptions {
+    socketUrl?: string;
+}
+declare class CMD {
+    private app;
+    private options?;
+    constructor(app: App, options?: CMDOptions);
+    init(): void;
+}
+export { CMDCoreEnum };
+export default CMD;

package/es/cmd/type.d.ts

@@ -0,0 +1,5 @@
+export interface CDMItem {
+    key: string;
+    code: string;
+    [key: string]: any;
+}

package/es/config.d.ts

@@ -0,0 +1,3 @@
+import { CoreConfig } from './type';
+export declare const setConfig: (newConfig: Partial<CoreConfig>) => void;
+export declare const getConfig: () => CoreConfig;

package/es/cookie/index.d.ts

@@ -0,0 +1,13 @@
+declare function setCookie(name: string, value: string, domain?: string): void;
+declare function getCookie(name: string): string | null;
+declare function deleteCookie(name: string, domain?: string): void;
+declare function checkCookie(name: string): boolean;
+declare function updateCookie(name: string, value: string, domain?: string): void;
+declare const _default: {
+    setCookie: typeof setCookie;
+    getCookie: typeof getCookie;
+    deleteCookie: typeof deleteCookie;
+    checkCookie: typeof checkCookie;
+    updateCookie: typeof updateCookie;
+};
+export default _default;

package/es/data/index.d.ts

@@ -0,0 +1,8 @@
+import { Storage } from '../storage';
+import App from '../app';
+export declare class Data {
+    private app;
+    storage: Storage;
+    store: any;
+    constructor(app: App);
+}

package/es/history/config.d.ts

@@ -0,0 +1,24 @@
+import { HistoryConfig } from './type';
+/**
+ * @title: 默认配置
+ * @description:
+ * @return {*}
+ * @Author: zhiwei.Wang
+ */
+export declare const defaultConfig: HistoryConfig;
+/**
+ * @title: 设置配置
+ * @description:
+ * @param {Partial} newConfig
+ * @return {*}
+ * @Author: zhiwei.Wang
+ */
+export declare const setConfig: (newConfig: Partial<HistoryConfig>) => HistoryConfig;
+/**
+ * @title: 获取配置
+ * @description:
+ * @param {*} HistoryConfig
+ * @return {*}
+ * @Author: zhiwei.Wang
+ */
+export declare const getConfig: () => HistoryConfig;

package/es/history/index.d.ts

@@ -0,0 +1,20 @@
+import type { History as HistoryType } from "history";
+import { useHistory, useLocation, useParams } from "react-router-dom";
+import App from "../app";
+export interface HistoryOptions {
+    basename?: string;
+}
+export declare class History {
+    instance: HistoryType<unknown>;
+    useHistory: typeof useHistory;
+    useLocation: typeof useLocation;
+    useParams: typeof useParams;
+    app: App;
+    constructor(app: App, options?: HistoryOptions);
+    push: HistoryType["push"];
+    replace: HistoryType["replace"];
+    reload: () => void;
+    reloadTo: (path: string) => void;
+    externalPage: (path: string) => void;
+    goLogin: () => any;
+}

package/es/history/type.d.ts

@@ -0,0 +1,2 @@
+export interface HistoryConfig {
+}

package/es/hooks/index.d.ts

@@ -0,0 +1,12 @@
+import useLowCode from './useLowCode';
+import useDelayedValue from './useDelayedValue';
+import useStore from './useStore';
+import useDispatch from './useDispatch';
+export interface HooksExport {
+    useLowCode: typeof useLowCode;
+    useDelayedValue: typeof useDelayedValue;
+    useStore: typeof useStore;
+    useDispatch: typeof useDispatch;
+}
+declare const _default: HooksExport;
+export default _default;

package/es/hooks/useDelayedValue/index.d.ts

@@ -0,0 +1,2 @@
+declare function useDelayedValue<T>(value: T, timeout?: number): T;
+export default useDelayedValue;

package/es/hooks/useDispatch/index.d.ts

@@ -0,0 +1,2 @@
+import { useDispatch } from "react-redux";
+export default useDispatch;

package/es/hooks/useLowCode/index.d.ts

@@ -0,0 +1,13 @@
+export interface useLowCodeProps {
+    onChange: (e: any) => void;
+    onReady: (e: any) => void;
+}
+export interface useLowCodeResult {
+    lowcodeRef: {
+        onReady: (e: any) => void;
+        onChange: (e: any) => void;
+    };
+    setState: (values: any, callback?: any) => any;
+}
+declare const useLowCode: (props: Partial<useLowCodeProps>) => useLowCodeResult;
+export default useLowCode;

package/es/hooks/useStore/index.d.ts

@@ -0,0 +1,6 @@
+import { ModelsState } from "../../models";
+declare const useStore: <T extends "global", D extends keyof ModelsState[T]>(props: {
+    models: T;
+    key?: D | undefined;
+}) => D extends undefined ? ModelsState[T] : ModelsState[T][D];
+export default useStore;

package/es/index.d.ts

@@ -0,0 +1,6 @@
+export { default as request } from './request';
+export { default as hooks } from './hooks';
+export { default as models } from './models';
+export { default as pubsub } from './pubsub';
+export { default as socket } from './socket';
+export * from './app';

package/es/indexDB/index.d.ts

@@ -0,0 +1,248 @@
+import App from "../app";
+/**
+ * IndexDB 管理器模块
+ *
+ * 这个模块提供了对浏览器 IndexedDB 的简单封装，并在不支持 IndexedDB 的环境中
+ * 自动降级使用 localStorage 作为备选存储方案。
+ */
+/**
+ * 数据库配置选项接口
+ * @interface DBOptions
+ * @property {string} dbName - 数据库名称
+ * @property {number} version - 数据库版本号
+ * @property {Array} stores - 存储对象配置数组
+ * @property {string} stores[].name - 存储对象名称
+ * @property {string} stores[].keyPath - 主键路径
+ * @property {Array} [stores[].indexes] - 索引配置数组（可选）
+ * @property {string} stores[].indexes[].name - 索引名称
+ * @property {string} stores[].indexes[].keyPath - 索引键路径
+ * @property {IDBIndexParameters} [stores[].indexes[].options] - 索引选项（可选）
+ */
+export interface DBOptions {
+    dbName: string;
+    version: number;
+    stores: {
+        name: string;
+        keyPath: string;
+        indexes?: {
+            name: string;
+            keyPath: string;
+            options?: IDBIndexParameters;
+        }[];
+    }[];
+}
+/**
+ * IndexDB 管理器类
+ * 提供对 IndexedDB 的简单封装，支持自动降级到 localStorage
+ * @class IndexDBManager
+ */
+declare class IndexDBManager {
+    /**
+     * 检查环境是否支持 IndexedDB
+     * @returns {boolean} 是否支持 IndexedDB
+     * @private
+     */
+    private static isSupported;
+    private db;
+    private dbName;
+    private version;
+    private stores;
+    private useIndexDB;
+    private app;
+    /**
+     * 创建 IndexDBManager 实例
+     * @param {DBOptions} options - 数据库配置选项
+     */
+    constructor(app: App, options: DBOptions);
+    /**
+     * 初始化数据库连接
+     * 如果环境不支持 IndexedDB，将自动使用 localStorage
+     * @returns {Promise<boolean>} 连接是否成功
+     */
+    connect(): Promise<boolean>;
+    /**
+     * 生成用于 localStorage 的存储键
+     * @param {string} storeName - 存储对象名称
+     * @param {string|number} [key] - 可选的键值
+     * @returns {string} 格式化的存储键
+     * @private
+     */
+    private getStorageKey;
+    /**
+     * 添加数据到指定的存储对象
+     * @param {string} storeName - 存储对象名称
+     * @param {T} data - 要添加的数据
+     * @returns {Promise<T>} 添加的数据
+     * @template T
+     */
+    add<T>(storeName: string, data: T): Promise<T>;
+    /**
+     * 快速检查指定存储对象中的数据是否存在
+     * @param {string} storeName - 存储对象名称
+     * @param {string|number} key - 数据主键
+     * @returns {Promise<boolean>} 数据是否存在
+     */
+    exists(storeName: string, key: string | number): Promise<boolean>;
+    /**
+     * 获取指定存储对象中的数据
+     * @param {string} storeName - 存储对象名称
+     * @param {string|number} key - 数据主键
+     * @returns {Promise<T|null>} 获取的数据，不存在则返回 null
+     * @template T
+     */
+    get<T>(storeName: string, key: string | number): Promise<T | null>;
+    /**
+     * 更新指定存储对象中的数据
+     * @param {string} storeName - 存储对象名称
+     * @param {T} data - 要更新的数据
+     * @returns {Promise<T>} 更新后的数据
+     * @template T
+     */
+    update<T>(storeName: string, data: T): Promise<T>;
+    /**
+     * 删除指定存储对象中的数据
+     * @param {string} storeName - 存储对象名称
+     * @param {string|number} key - 数据主键
+     * @returns {Promise<boolean>} 删除是否成功
+     */
+    delete(storeName: string, key: string | number): Promise<boolean>;
+    /**
+     * 通过索引获取数据
+     * @param {string} storeName - 存储对象名称
+     * @param {string} indexName - 索引名称
+     * @param {string|number} indexValue - 索引值
+     * @returns {Promise<T|null>} 获取的数据，不存在则返回 null
+     * @template T
+     */
+    getByIndex<T>(storeName: string, indexName: string, indexValue: string | number): Promise<T | null>;
+    /**
+     * 通过索引检查数据是否存在
+     * @param {string} storeName - 存储对象名称
+     * @param {string} indexName - 索引名称
+     * @param {string|number} indexValue - 索引值
+     * @returns {Promise<boolean>} 数据是否存在
+     */
+    existsByIndex(storeName: string, indexName: string, indexValue: string | number): Promise<boolean>;
+    /**
+     * 通过索引获取多条数据
+     * @param {string} storeName - 存储对象名称
+     * @param {string} indexName - 索引名称
+     * @param {string|number} indexValue - 索引值
+     * @returns {Promise<T[]>} 数据数组
+     * @template T
+     */
+    getAllByIndex<T>(storeName: string, indexName: string, indexValue: string | number): Promise<T[]>;
+    /**
+     * 统计指定存储对象中的数据数量
+     * @param {string} storeName - 存储对象名称
+     * @returns {Promise<number>} 数据数量
+     */
+    count(storeName: string): Promise<number>;
+    /**
+     * 通过索引统计数据数量
+     * @param {string} storeName - 存储对象名称
+     * @param {string} indexName - 索引名称
+     * @param {string|number} indexValue - 索引值
+     * @returns {Promise<number>} 数据数量
+     */
+    countByIndex(storeName: string, indexName: string, indexValue: string | number): Promise<number>;
+    /**
+     * 获取指定存储对象中的所有数据
+     * @param {string} storeName - 存储对象名称
+     * @returns {Promise<T[]>} 数据数组
+     * @template T
+     */
+    getAll<T>(storeName: string): Promise<T[]>;
+    /**
+     * 清空指定存储对象中的所有数据
+     * @param {string} storeName - 存储对象名称
+     * @returns {Promise<boolean>} 清空是否成功
+     */
+    clear(storeName: string): Promise<boolean>;
+    /**
+     * 关闭数据库连接
+     * 在不再需要使用数据库时调用，释放资源
+     */
+    close(): void;
+    /**
+     * 获取当前使用的存储方式
+     * @returns {'indexDB'|'localStorage'} 当前使用的存储方式
+     */
+    getCurrentStorage(): 'indexDB' | 'localStorage';
+}
+/**
+ * 使用示例:
+ *
+ * // 1. 创建数据库配置
+ * const dbOptions: DBOptions = {
+ *   dbName: 'myApp',
+ *   version: 1,
+ *   stores: [
+ *     {
+ *       name: 'users',
+ *       keyPath: 'id',
+ *       indexes: [
+ *         { name: 'email', keyPath: 'email', options: { unique: true } },
+ *         { name: 'department', keyPath: 'department', options: { unique: false } }
+ *       ]
+ *     },
+ *     {
+ *       name: 'products',
+ *       keyPath: 'id'
+ *     }
+ *   ]
+ * };
+ *
+ * // 2. 创建并连接数据库
+ * const db = new IndexDBManager(app, dbOptions);
+ * await db.connect();
+ *
+ * // 3. 添加数据
+ * const user = { id: '1', name: '张三', email: 'zhangsan@example.com', department: 'IT' };
+ * await db.add('users', user);
+ *
+ * // 4. 获取数据
+ * const retrievedUser = await db.get('users', '1');
+ *
+ * // 5. 快速检查数据是否存在（推荐用法）
+ * const userExists = await db.exists('users', '1'); // 返回 true/false，比 get 更高效
+ *
+ * // 6. 通过索引获取数据
+ * const userByEmail = await db.getByIndex('users', 'email', 'zhangsan@example.com');
+ *
+ * // 7. 通过索引检查数据是否存在
+ * const emailExists = await db.existsByIndex('users', 'email', 'zhangsan@example.com');
+ *
+ * // 8. 通过索引获取多条数据
+ * const itUsers = await db.getAllByIndex('users', 'department', 'IT');
+ *
+ * // 9. 统计数据数量
+ * const totalUsers = await db.count('users');
+ * const itUserCount = await db.countByIndex('users', 'department', 'IT');
+ *
+ * // 10. 更新数据
+ * user.name = '张三 (已更新)';
+ * await db.update('users', user);
+ *
+ * // 11. 获取所有数据
+ * const allUsers = await db.getAll('users');
+ *
+ * // 12. 删除数据
+ * await db.delete('users', '1');
+ *
+ * // 13. 清空存储对象
+ * await db.clear('users');
+ *
+ * // 14. 关闭数据库连接
+ * db.close();
+ *
+ * // 15. 检查当前使用的存储方式
+ * const storageType = db.getCurrentStorage(); // 'indexDB' 或 'localStorage'
+ *
+ * // 性能优化建议：
+ * // - 使用 exists() 而不是 get() 来检查数据是否存在
+ * // - 为常用查询字段创建索引
+ * // - 使用索引查询方法来提高查询效率
+ * // - 批量操作时使用事务（可以考虑后续扩展）
+ */
+export default IndexDBManager;