@pisell/core 1.0.13 → 1.0.15

package/lib/socket/reconnect.d.ts

@@ -0,0 +1,61 @@
+import { ReconnectOptions } from "./types";
+/**
+ * Socket重连管理器
+ * 处理断线重连逻辑
+ */
+export declare class ReconnectManager {
+    private options;
+    private attempts;
+    private timer;
+    private isReconnecting;
+    private reconnectCallback;
+    private onAttempt;
+    private onSuccess;
+    private onFail;
+    private onMaxAttemptsExceeded;
+    /**
+     * 创建重连管理器实例
+     * @param options 重连配置
+     * @param reconnectCallback 重连执行函数
+     * @param callbacks 回调函数集合
+     */
+    constructor(options: ReconnectOptions, reconnectCallback: () => Promise<boolean>, callbacks?: {
+        onAttempt?: (attempt: number) => void;
+        onSuccess?: () => void;
+        onFail?: (error: Error) => void;
+        onMaxAttemptsExceeded?: () => void;
+    });
+    /**
+     * 启动重连过程
+     */
+    startReconnect(): void;
+    /**
+     * 停止重连过程
+     */
+    stopReconnect(): void;
+    /**
+     * 获取当前重连尝试次数
+     */
+    getReconnectAttempts(): number;
+    /**
+     * 获取当前是否正在重连
+     */
+    isActive(): boolean;
+    /**
+     * 重置重连状态
+     */
+    reset(): void;
+    /**
+     * 安排下一次重连尝试
+     */
+    private scheduleReconnect;
+    /**
+     * 执行重连操作
+     */
+    private executeReconnect;
+    /**
+     * 计算重连延迟时间
+     * 支持指数退避算法，增加随机抖动
+     */
+    private getReconnectDelay;
+}

package/lib/socket/socket.d.ts

@@ -0,0 +1,130 @@
+import { SocketOptions, SocketStatus } from "./types";
+import { SocketMonitor, SocketMonitorOptions } from "./monitor";
+/**
+ * Socket主类
+ * 负责管理WebSocket连接、消息收发、事件处理、心跳检测和断线重连
+ */
+export declare class Socket {
+    private ws;
+    private url;
+    private options;
+    private status;
+    private eventHandlers;
+    private heartbeatManager;
+    private reconnectManager;
+    private monitor;
+    private messageIdCounter;
+    /**
+     * 创建Socket实例
+     * @param options Socket配置选项
+     */
+    constructor(options: SocketOptions);
+    /**
+     * 建立WebSocket连接
+     */
+    connect(): Promise<void>;
+    /**
+     * 关闭WebSocket连接
+     * @param isManual 是否手动关闭
+     */
+    disconnect(isManual?: boolean): void;
+    /**
+     * 发送消息到服务器
+     * @param event 事件名称
+     * @param data 消息数据
+     * @param id 消息ID（可选，默认自动生成）
+     */
+    send(type: string, data?: any, id?: string): void;
+    /**
+     * 发送原始消息
+     * @param message 消息对象
+     */
+    private sendRaw;
+    /**
+     * 注册事件监听器
+     * @param event 事件名称
+     * @param handler 事件处理函数
+     */
+    on(event: string, handler: (...args: any[]) => void): void;
+    /**
+     * 移除事件监听器
+     * @param event 事件名称
+     * @param handler 事件处理函数（可选，不提供则移除所有该事件的处理函数）
+     */
+    off(event: string, handler?: (...args: any[]) => void): void;
+    /**
+     * 触发事件
+     * @param event 事件名称
+     * @param args 事件参数
+     */
+    private emit;
+    /**
+     * 获取当前连接状态
+     */
+    getStatus(): SocketStatus;
+    /**
+     * 获取当前状态描述
+     */
+    getStatusText(): string;
+    /**
+     * 检查是否已连接
+     */
+    isConnected(): boolean;
+    /**
+     * 设置连接状态
+     */
+    private setStatus;
+    /**
+     * 设置WebSocket事件监听器
+     */
+    private setupWebSocketListeners;
+    /**
+     * 处理接收到的消息
+     */
+    private handleMessage;
+    /**
+     * 处理连接关闭
+     */
+    private handleConnectionClosed;
+    /**
+     * 处理连接失败
+     */
+    private handleConnectionFailure;
+    /**
+     * 处理心跳响应
+     */
+    private handleHeartbeatResponse;
+    /**
+     * 初始化心跳检测
+     */
+    private initHeartbeat;
+    /**
+     * 初始化重连管理
+     */
+    private initReconnect;
+    /**
+     * 开始重连过程
+     */
+    private startReconnection;
+    /**
+     * 生成消息ID
+     */
+    private generateMessageId;
+    /**
+     * 启用监控功能
+     * @param options 监控配置选项
+     */
+    enableMonitoring(options?: SocketMonitorOptions): SocketMonitor;
+    /**
+     * 禁用监控功能
+     */
+    disableMonitoring(): void;
+    /**
+     * 获取监控器实例
+     */
+    getMonitor(): SocketMonitor | null;
+    /**
+     * 释放资源
+     */
+    destroy(): void;
+}

package/lib/socket/types.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Socket配置选项
+ */
+export interface SocketOptions {
+    /** 是否自动连接 */
+    autoConnect?: boolean;
+    /** 是否启用重连功能 */
+    reconnection?: boolean;
+    /** 最大重连尝试次数，默认无限 */
+    reconnectionAttempts?: number;
+    /** 重连延迟时间（毫秒） */
+    reconnectionDelay?: number;
+    /** 最大重连延迟时间（毫秒） */
+    reconnectionDelayMax?: number;
+    /** 是否启用心跳检测 */
+    heartbeat?: boolean;
+    /** 心跳间隔时间（毫秒） */
+    heartbeatInterval?: number;
+    /** 请求超时时间（毫秒） */
+    timeout?: number;
+    /** 心跳超时时间（毫秒） */
+    heartbeatTimeout?: number;
+    /** 自定义协议 */
+    protocols?: string | string[];
+    /** 连接URL */
+    url: string;
+}
+/**
+ * Socket连接状态
+ */
+export declare enum SocketStatus {
+    CONNECTING = 0,
+    OPEN = 1,
+    CLOSING = 2,
+    CLOSED = 3,
+    RECONNECTING = 4
+}
+/**
+ * Socket消息格式
+ */
+export interface SocketMessage<T = any> {
+    /** 事件类型 */
+    type: string;
+    /** 消息数据 */
+    data?: T;
+    /** 消息ID */
+    id?: string;
+}
+/**
+ * 心跳配置选项
+ */
+export interface HeartbeatOptions {
+    /** 心跳间隔时间（毫秒） */
+    interval: number;
+    /** 心跳超时时间（毫秒） */
+    timeout: number;
+    /** 心跳探测消息 */
+    message?: SocketMessage;
+}
+/**
+ * 重连配置选项
+ */
+export interface ReconnectOptions {
+    /** 是否启用重连 */
+    enabled: boolean;
+    /** 最大重连尝试次数 */
+    attempts?: number;
+    /** 重连延迟时间（毫秒） */
+    delay: number;
+    /** 最大重连延迟时间（毫秒） */
+    delayMax?: number;
+    /** 是否使用指数退避算法 */
+    jitter?: boolean;
+}
+/**
+ * 事件处理函数类型
+ */
+export declare type EventHandler = (...args: any[]) => void;
+/**
+ * 事件处理函数映射
+ */
+export interface EventHandlerMap {
+    [event: string]: EventHandler[];
+}

package/lib/storage/index.d.ts

@@ -0,0 +1,17 @@
+import App from '../app';
+export interface StorageOptions {
+    storageKey?: string;
+    removeStorageAfter?: (key: string) => void;
+    setStorageAfter?: (key: string, value: string) => void;
+}
+export declare class Storage {
+    private storageKey;
+    private app?;
+    private options;
+    constructor(app?: App, options?: StorageOptions);
+    createKey: (key: string) => string;
+    setStorage: (key: string, value: string) => void;
+    getStorage: (key: string) => string | null;
+    removeStorage: (key: string) => void;
+    clear: () => void;
+}

package/lib/tasks/index.d.ts

@@ -0,0 +1,83 @@
+import { Task, TasksModule, RunTaskParams, AddTaskParams, DeleteTaskParams } from "./type";
+import App from "../app";
+export declare class TasksManager {
+    private static instance;
+    private taskFunctions;
+    private tasks;
+    private app;
+    private db;
+    useTasks: () => {
+        tasks: TasksModule;
+    };
+    watchTaskCallback: (taskModule: TasksModule) => void;
+    private timerIds;
+    constructor(app: App);
+    static getInstance(app?: App): TasksManager;
+    addTaskFunction<T>(name: string, fun: T): void;
+    addTaskFunctions<T>(tasks: {
+        name: string;
+        fun: T;
+    }[]): void;
+    getTasks(): TasksModule;
+    getTaskFunction(name: string): any;
+    init(): Promise<void>;
+    private saveTaskQueueToLocal;
+    private loadTaskQueueFromLocal;
+    /**
+     * @title: 执行任务
+     * @description:
+     * @param {Task} task
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:53
+     */
+    private runTask;
+    /**
+     * @title: 清除任务定时器
+     * @param {NodeJS.Timeout} timerId
+     */
+    private clearTaskTimer;
+    /**
+     * @title: 启动轮询
+     * @description: 根据轮询间隔定期执行任务
+     * @param {Task} task
+     * @return {*}
+     */
+    private startPolling;
+    /**
+     * @title: 创建任务数据
+     * @description:
+     * @param {Partial} payload
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:54
+     */
+    private createTaskData;
+    private getTaskQueue;
+    private timeout;
+    /**
+     * @title: 执行任务队列
+     * @description:
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:52
+     */
+    run(payload: RunTaskParams): Promise<void>;
+    deleteTask(payload: DeleteTaskParams): void;
+    /**
+     * @title: 重试任务
+     * @description:
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:53
+     */
+    retryTask(payload: RunTaskParams): void;
+    addTask(payload: AddTaskParams): void;
+    private updateTask;
+    private updateQueueStatus;
+    private setTasks;
+    clearAllTaskTimer(tasks: Task[]): void;
+    clearTasks(payload: RunTaskParams): void;
+    clearAllTasks(): void;
+    watchTask(callback: (taskModule: TasksModule) => void): void;
+}

package/lib/tasks/type.d.ts

@@ -0,0 +1,62 @@
+export declare type TaskRunStatus = "pending" | "in-progress" | "success" | "failure";
+export interface Task {
+    id?: string;
+    type?: "local" | "cloud";
+    retries?: number;
+    maxRetries?: number;
+    status?: TaskRunStatus;
+    action: string;
+    payload: any;
+    beforeAction?: string;
+    beforePayload?: any;
+    afterAction?: string;
+    afterPayload?: any;
+    polling?: {
+        interval?: number;
+    };
+    pollingResult?: {
+        count: number;
+        timerId?: any;
+    };
+    manual?: boolean;
+    destroy?: boolean;
+    [key: string]: any;
+}
+export interface TaskConfig {
+    tasks: Task[];
+}
+declare type TaskModuleName = string;
+declare type TaskQueueName = string;
+declare type TaskStatus = "uncompleted" | "completed";
+export interface TaskQueue {
+    status: TaskStatus;
+    tasks: Task[];
+}
+export interface RunTaskParams {
+    module: TaskModuleName;
+    queueId: TaskQueueName;
+    callback?: () => void;
+}
+export interface DeleteTaskParams {
+    module: TaskModuleName;
+    queueId: TaskQueueName;
+    taskId: string;
+}
+export interface AddTaskParams {
+    module: TaskModuleName;
+    queueId: TaskQueueName;
+    tasks: Task[];
+}
+export interface TaskRunResult {
+    status: TaskRunStatus;
+    [key: string]: any;
+}
+export interface TasksModule {
+    [key: TaskModuleName]: {
+        [key: TaskQueueName]: {
+            status: TaskStatus;
+            tasks: Task[];
+        };
+    };
+}
+export {};

package/lib/tasks/useTasks.d.ts

@@ -0,0 +1,5 @@
+import { TasksModule } from './type';
+declare const useTasks: () => {
+    tasks: TasksModule;
+};
+export default useTasks;

package/lib/type.d.ts

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

package/lib/variables/VariablesProvider.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export declare const useVariablesContext: () => any;
+interface VariablesProviderProps {
+    children: React.ReactNode;
+}
+export declare const VariablesProvider: React.FC<VariablesProviderProps>;
+export {};

package/lib/variables/config.d.ts

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

package/lib/variables/index.d.ts

@@ -0,0 +1,6 @@
+export declare type VariableMap = Record<string, string>;
+declare const _default: {
+    setConfig: (newConfig: Partial<import("./type").VariablesConfig>) => void;
+    getConfig: () => import("./type").VariablesConfig;
+};
+export default _default;

package/lib/variables/type.d.ts

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

package/lib/website/index.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    setTitle: (title: string) => void;
+    setIcon: (paramsIcon: string) => void;
+    setAppleWebAppTitle: (title: string) => void;
+};
+export default _default;

package/package.json

@@ -1,12 +1,6 @@
 {
   "name": "@pisell/core",
-  "version": "1.0.13",
-  "scripts": {
-    "build": "father build",
-    "dev": "father dev",
-    "build:types": "tsc --project tsconfig.types.json",
-    "publish:types": "npm run build:types && cd types && cp ../types-package.json package.json && npm publish"
-  },
+  "version": "1.0.15",
   "sideEffects": false,
   "main": "./lib/index.js",
   "module": "./es/index.js",
@@ -29,7 +23,7 @@
     "history": "^4.9.0",
     "react-router-dom": "^5.3.4",
     "react-redux": "^9.1.2",
-    "@pisell/utils": "3.0.1",
+    "@pisell/utils": "3.0.2",
     "dva": "^2.4.1",
     "dva-core": "^2.0.4",
     "js-md5": "^0.8.3",
@@ -44,5 +38,11 @@
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "father build",
+    "dev": "father dev",
+    "build:types": "tsc --project tsconfig.types.json",
+    "publish:types": "npm run build:types && cd types && cp ../types-package.json package.json && npm publish"
   }
 }