@pisell/core 1.0.41 → 1.0.43

package/lib/request/utils.d.ts

@@ -0,0 +1,46 @@
+import { InternalAxiosRequestConfig } from "axios";
+import { RequestSetting, RequestConfig, RequestWrapperProps } from "./type";
+export declare const getRequestHeaders: (config: InternalAxiosRequestConfig<RequestSetting> & Record<string, any>) => Record<string, string | null>;
+/**
+ * @title: 请求前拦截
+ * @description:
+ * @param {any} config
+ * @return {*}
+ * @Author: zhiwei.Wang
+ * @Date: 2024-07-04 10:51
+ */
+export declare const interceptorsRequest: (config: InternalAxiosRequestConfig<RequestSetting> & Record<string, any>) => Promise<InternalAxiosRequestConfig<RequestSetting> & Record<string, any>>;
+/**
+ * @title: 请求前error
+ * @description:
+ * @param {any} err
+ * @return {*}
+ * @Author: zhiwei.Wang
+ * @Date: 2024-07-04 10:51
+ */
+export declare const interceptorsRequestError: (err: RequestConfig["interceptorsRequestError"]) => any;
+/**
+ * @title: 请求后拦截
+ * @description:
+ * @param {any} response
+ * @return {*}
+ * @Author: zhiwei.Wang
+ * @Date: 2024-07-04 10:51
+ */
+export declare const interceptorsResponse: (response: RequestConfig["interceptorsResponse"]) => any;
+/**
+ * @title: 请求后错误拦截
+ * @description:
+ * @param {any} response
+ * @return {*}
+ * @Author: zhiwei.Wang
+ * @Date: 2024-07-04 10:51
+ */
+export declare const interceptorsResponseError: (response: RequestConfig["interceptorsResponseError"]) => any;
+export declare const requestCallback: (resData: {
+    res?: any;
+    props: RequestWrapperProps;
+    resolve: (value: unknown) => void;
+    reject: () => void;
+    err?: any;
+}) => void;

package/lib/tasks/index.d.ts

@@ -0,0 +1,127 @@
+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: 清除任务定时器
+     */
+    private clearTaskTimer;
+    /**
+     * @title: 计算下一次执行时间
+     * @description: 根据定时任务配置计算下一次执行时间
+     * @param {Task} task
+     * @return {string | null} 下一次执行时间
+     */
+    private calculateNextExecuteTime;
+    /**
+     * @title: 启动定时任务
+     * @description: 在特定时间点执行任务（仅在 scheduledTasks 模块中生效）
+     * @param {Task} task
+     * @return {*}
+     */
+    private startScheduledTask;
+    /**
+     * @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;
+    /**
+     * @title: 更新队列运行状态
+     * @description: 标记队列是否正在执行
+     */
+    private updateQueueRunningState;
+    private setTasksData;
+    private setTasks;
+    clearAllTaskTimer(tasks: Task[]): void;
+    clearTasks(payload: RunTaskParams): void;
+    clearAllTasks(): void;
+    watchTask(callback: (taskModule: TasksModule) => void): void;
+    /**
+     * @title: 获取队列执行状态
+     * @description: 获取指定队列的执行状态和进度信息
+     * @param {string} module - 模块名
+     * @param {string} queueId - 队列ID
+     * @return {object} 队列状态信息
+     */
+    getQueueStatus(module: string, queueId: string): {
+        isRunning: boolean;
+        status: "uncompleted" | "completed";
+        progress: {
+            total: number;
+            completed: number;
+            failed: number;
+            inProgress: number;
+        };
+        lastRunAt: string | null;
+        tasksCount: number;
+    } | null;
+    /**
+     * @title: 获取所有队列状态
+     * @description: 获取所有任务队列的执行状态概览
+     * @return {object} 所有队列的状态信息
+     */
+    getAllQueuesStatus(): any;
+}

package/lib/tasks/scheduledTasksExample.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 定时任务示例代码
+ * 本文件展示了如何使用定时任务功能
+ *
+ * 重要提示：
+ * - 定时任务必须添加到 'scheduledTasks' 模块才能生效
+ * - 在其他模块中，scheduled 配置会被忽略，任务将作为普通任务立即执行
+ * - 这是为了性能优化，避免在所有模块中检查定时任务配置
+ */
+import { TasksManager } from './index';
+/**
+ * 示例1：创建一次性定时任务
+ * 在特定时间点执行一次
+ *
+ * 注意：定时任务必须添加到 'scheduledTasks' 模块才能生效
+ */
+export declare function createOnceScheduledTask(tasksManager: TasksManager): void;
+/**
+ * 示例2：创建每日重复的定时任务
+ * 每天在固定时间执行
+ */
+export declare function createDailyScheduledTask(tasksManager: TasksManager): void;
+/**
+ * 示例3：创建带结束时间的重复任务
+ * 在特定时间段内重复执行
+ */
+export declare function createLimitedRepeatTask(tasksManager: TasksManager): void;
+/**
+ * 示例4：创建多个时间点的任务
+ * 在一天中的多个时间点分别执行
+ */
+export declare function createMultiTimeTask(tasksManager: TasksManager): void;
+/**
+ * 示例5：创建每周重复任务
+ * 每周一早上9点执行周报
+ */
+export declare function createWeeklyTask(tasksManager: TasksManager): void;
+/**
+ * 示例6：创建每月重复任务
+ * 每月1号生成月报
+ */
+export declare function createMonthlyTask(tasksManager: TasksManager): void;
+/**
+ * 示例7：查询和管理定时任务
+ */
+export declare function manageScheduledTasks(tasksManager: TasksManager): void;
+/**
+ * 完整使用示例
+ */
+export declare function fullExample(app: any): void;
+declare const _default: {
+    createOnceScheduledTask: typeof createOnceScheduledTask;
+    createDailyScheduledTask: typeof createDailyScheduledTask;
+    createLimitedRepeatTask: typeof createLimitedRepeatTask;
+    createMultiTimeTask: typeof createMultiTimeTask;
+    createWeeklyTask: typeof createWeeklyTask;
+    createMonthlyTask: typeof createMonthlyTask;
+    manageScheduledTasks: typeof manageScheduledTasks;
+    fullExample: typeof fullExample;
+};
+export default _default;

package/lib/tasks/type.d.ts

@@ -0,0 +1,100 @@
+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;
+    };
+    scheduled?: {
+        executeAt: string | string[];
+        repeat?: boolean;
+        repeatType?: 'daily' | 'weekly' | 'monthly' | 'yearly';
+        repeatInterval?: number;
+        endAt?: string;
+    };
+    scheduledResult?: {
+        count: number;
+        timerId?: any;
+        nextExecuteTime?: string;
+    };
+    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[];
+    isRunning?: boolean;
+    progress?: {
+        total: number;
+        completed: number;
+        failed: number;
+        inProgress: number;
+    };
+    lastRunAt?: string;
+}
+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 AddTaskDataParams {
+    module: TaskModuleName;
+    queueId: TaskQueueName;
+    [key: string]: any;
+}
+export interface TaskRunResult {
+    status: TaskRunStatus;
+    [key: string]: any;
+}
+/**
+ * 任务模块
+ * 注意：'scheduledTasks' 是保留的模块名，专门用于定时任务
+ * 在其他模块中，scheduled 配置会被忽略，任务将作为普通任务执行
+ */
+export interface TasksModule {
+    [key: TaskModuleName]: {
+        [key: TaskQueueName]: {
+            status: TaskStatus;
+            tasks: Task[];
+            isRunning?: boolean;
+            progress?: {
+                total: number;
+                completed: number;
+                failed: number;
+                inProgress: number;
+            };
+            lastRunAt?: string;
+        };
+    };
+}
+export {};

package/lib/utils/adaptiveThrottle/index.d.ts

@@ -0,0 +1,36 @@
+export declare type ThrottleLevel = number;
+export interface ThrottleExecuteContext {
+    /** 事务唯一 key */
+    key: string;
+    /** 当前节流窗口内的触发次数 */
+    count: number;
+    /** 是否首次立即执行 */
+    isFirst: boolean;
+    /** 当前节流等级 */
+    level: ThrottleLevel;
+    /** 上一次执行时间 */
+    lastExecuteTime: number;
+}
+export declare type ThrottleHandler = (ctx: ThrottleExecuteContext) => void | Promise<void>;
+export declare const DEFAULT_THROTTLE_INTERVALS: number[];
+export declare class AdaptiveThrottle {
+    private store;
+    private intervals;
+    constructor(intervals?: number[]);
+    /**
+     * 触发事务
+     */
+    trigger(key: string, handler: ThrottleHandler): void;
+    /**
+     * 调度下一次节流执行
+     */
+    private schedule;
+    /**
+     * 主动清理某个事务
+     */
+    clear(key: string): void;
+    /**
+     * 清空所有事务
+     */
+    clearAll(): void;
+}

package/lib/utils/adaptiveThrottle/index.js

@@ -0,0 +1,121 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/utils/adaptiveThrottle/index.ts
+var adaptiveThrottle_exports = {};
+__export(adaptiveThrottle_exports, {
+  AdaptiveThrottle: () => AdaptiveThrottle,
+  DEFAULT_THROTTLE_INTERVALS: () => DEFAULT_THROTTLE_INTERVALS
+});
+module.exports = __toCommonJS(adaptiveThrottle_exports);
+var DEFAULT_THROTTLE_INTERVALS = [
+  5 * 60 * 1e3,
+  // 5分钟
+  30 * 60 * 1e3,
+  // 30分钟
+  60 * 60 * 1e3,
+  // 1小时
+  6 * 60 * 60 * 1e3,
+  // 6小时
+  24 * 60 * 60 * 1e3
+  // 1天
+];
+var AdaptiveThrottle = class {
+  store = /* @__PURE__ */ new Map();
+  intervals;
+  constructor(intervals = DEFAULT_THROTTLE_INTERVALS) {
+    this.intervals = intervals;
+  }
+  /**
+   * 触发事务
+   */
+  trigger(key, handler) {
+    const now = Date.now();
+    let record = this.store.get(key);
+    if (!record) {
+      handler({
+        key,
+        count: 1,
+        isFirst: true,
+        level: 0,
+        lastExecuteTime: now
+      });
+      record = {
+        key,
+        count: 0,
+        level: 0,
+        lastExecuteTime: now
+      };
+      this.store.set(key, record);
+      this.schedule(key, handler, record);
+      return;
+    }
+    record.count++;
+  }
+  /**
+   * 调度下一次节流执行
+   */
+  schedule(key, handler, record) {
+    const interval = this.intervals[record.level];
+    record.timer = setTimeout(async () => {
+      const count = record.count;
+      if (count > 0) {
+        await handler({
+          key,
+          count,
+          isFirst: false,
+          level: record.level,
+          lastExecuteTime: record.lastExecuteTime
+        });
+      }
+      if (count > 0 && record.level < this.intervals.length - 1) {
+        record.level++;
+      }
+      record.count = 0;
+      record.lastExecuteTime = Date.now();
+      this.schedule(key, handler, record);
+    }, interval);
+  }
+  /**
+   * 主动清理某个事务
+   */
+  clear(key) {
+    const record = this.store.get(key);
+    if (!record) return;
+    if (record.timer) {
+      clearTimeout(record.timer);
+    }
+    this.store.delete(key);
+  }
+  /**
+   * 清空所有事务
+   */
+  clearAll() {
+    this.store.forEach((record) => {
+      if (record.timer) {
+        clearTimeout(record.timer);
+      }
+    });
+    this.store.clear();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AdaptiveThrottle,
+  DEFAULT_THROTTLE_INTERVALS
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pisell/core",
-  "version": "1.0.41",
+  "version": "1.0.43",
   "sideEffects": false,
   "main": "./lib/index.js",
   "module": "./es/index.js",