hyper-scheduler 1.0.0 → 1.0.1

package/docs/api/devtools.md

@@ -1,232 +0,0 @@
-# DevTools
-
-浏览器环境下的可视化调试工具插件，提供任务监控、时间线视图和实时日志等功能。
-
-## 构造函数
-
-```typescript
-new DevTools(options?: DevToolsOptions)
-```
-
-### 参数
-
-- **options** `DevToolsOptions` - 可选配置对象
-
-| 属性 | 类型 | 默认值 | 说明 |
-|------|------|--------|------|
-| `theme` | `'light' \| 'dark' \| 'auto'` | `'auto'` | 主题模式 |
-| `dockPosition` | `'right' \| 'bottom'` | `'right'` | 面板停靠位置 |
-| `language` | `'en' \| 'zh'` | `'en'` | 界面语言 |
-| `defaultZoom` | `number` | `1` | 时间线默认缩放级别 (0.5-5) |
-| `trigger` | `TriggerOptions` | - | 悬浮按钮配置 |
-
-### TriggerOptions
-
-| 属性 | 类型 | 默认值 | 说明 |
-|------|------|--------|------|
-| `backgroundColor` | `string` | `'#3b82f6'` | 背景色 |
-| `textColor` | `string` | `'#ffffff'` | 文字/图标颜色 |
-| `position` | `'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left'` | `'bottom-right'` | 位置 |
-
-## 使用方法
-
-### 基础用法
-
-```typescript
-import { Scheduler, DevTools } from 'hyper-scheduler';
-
-const scheduler = new Scheduler({
-  plugins: [
-    new DevTools()
-  ]
-});
-```
-
-### 自定义配置
-
-```typescript
-import { Scheduler, DevTools } from 'hyper-scheduler';
-
-const scheduler = new Scheduler({
-  plugins: [
-    new DevTools({
-      theme: 'dark',
-      dockPosition: 'bottom',
-      language: 'zh',
-      defaultZoom: 2,
-      trigger: {
-        backgroundColor: '#10b981',
-        textColor: '#ffffff',
-        position: 'bottom-left'
-      }
-    })
-  ]
-});
-```
-
-## 功能特性
-
-### 任务列表
-
-- 查看所有已注册任务
-- 实时显示任务状态（idle、running、stopped、error）
-- 显示上次执行时间和下次执行时间
-- 按标签过滤任务
-- 搜索任务
-- **任务驱动 (Task Driver)**
-    - 在任务列表中，任务 ID 旁会显示一个标记：
-        - **`M`**: 表示该任务在 **主线程 (Main Thread)** 中运行。
-        - **`W`**: 表示该任务在 **Web Worker 线程** 中运行。
-    - 这允许你快速识别任务的执行上下文，特别是对于需要避免阻塞 UI 的繁重任务。
-    - **注意**：`driver` 是 `Scheduler` 或 `Task` 的配置选项，而不是 `DevTools` 本身的配置。`DevTools` 仅负责可视化其状态。
-
-### 任务控制
-
-- 手动触发任务执行
-- 暂停/恢复任务
-- 删除任务
-- 查看任务详情
-
-### 时间线视图
-
-- 可视化任务执行时间线
-- 缩放时间轴（0.5x - 5x）
-- 显示任务执行时长
-- 区分成功/失败状态
-
-### 执行历史
-
-- 查看任务执行历史记录
-- 显示执行时间、耗时、状态
-- 查看错误信息
-- 统计成功率
-
-### 实时日志
-
-- 实时显示调度器事件
-- 任务注册、启动、完成、失败等事件
-- 可过滤日志级别
-
-## 主题配置
-
-### auto（自动）
-
-根据系统主题自动切换：
-
-```typescript
-new DevTools({
-  theme: 'auto'
-})
-```
-
-### light（浅色）
-
-```typescript
-new DevTools({
-  theme: 'light'
-})
-```
-
-### dark（深色）
-
-```typescript
-new DevTools({
-  theme: 'dark'
-})
-```
-
-## 停靠位置
-
-### right（右侧）
-
-面板停靠在浏览器窗口右侧：
-
-```typescript
-new DevTools({
-  dockPosition: 'right'
-})
-```
-
-### bottom（底部）
-
-面板停靠在浏览器窗口底部：
-
-```typescript
-new DevTools({
-  dockPosition: 'bottom'
-})
-```
-
-## 语言设置
-
-### 中文
-
-```typescript
-new DevTools({
-  language: 'zh'
-})
-```
-
-### 英文
-
-```typescript
-new DevTools({
-  language: 'en'
-})
-```
-
-## 时间线缩放
-
-控制时间线视图的默认缩放级别，范围 0.5 - 5：
-
-```typescript
-new DevTools({
-  defaultZoom: 2  // 2倍缩放
-})
-```
-
-- `0.5` - 显示更长时间范围
-- `1` - 默认缩放
-- `2` - 显示更多细节
-- `5` - 最大缩放
-
-## 悬浮按钮自定义
-
-### 位置
-
-```typescript
-new DevTools({
-  trigger: {
-    position: 'bottom-right'  // 右下角
-  }
-})
-```
-
-可选值：
-- `'bottom-right'` - 右下角（默认）
-- `'bottom-left'` - 左下角
-- `'top-right'` - 右上角
-- `'top-left'` - 左上角
-
-### 颜色
-
-```typescript
-new DevTools({
-  trigger: {
-    backgroundColor: '#10b981',  // 绿色背景
-    textColor: '#ffffff'         // 白色文字
-  }
-})
-```
-
-支持任何有效的 CSS 颜色值：
-- 十六进制：`'#3b82f6'`
-- RGB：`'rgb(59, 130, 246)'`
-- RGBA：`'rgba(59, 130, 246, 0.8)'`
-- 颜色名：`'blue'`
-
-## 相关链接
-
-- [Scheduler API](./scheduler.md) - 调度器 API
-- [快速开始](../guide/getting-started.md) - 使用指南
-- [类型定义](./types.md) - 完整类型定义

package/docs/api/index.md

@@ -1,178 +0,0 @@
-# API 参考
-
-Hyper Scheduler 的完整 API 文档。
-
-## 核心 API
-
-### [Scheduler](./scheduler.md)
-
-核心调度器类，负责任务的注册、调度和生命周期管理。
-
-**主要方法**：
-- `createTask()` - 注册新任务
-- `start()` / `stop()` - 启动/停止调度器
-- `startTask()` / `stopTask()` - 启动/停止指定任务
-- `triggerTask()` - 手动触发任务
-- `getTask()` / `getAllTasks()` - 查询任务
-- `deleteTask()` - 删除任务
-- `on()` - 订阅事件
-
-[查看完整文档 →](./scheduler.md)
-
----
-
-### [Task](./task.md)
-
-任务配置和运行时状态。
-
-**核心接口**：
-- `TaskDefinition` - 任务定义
-- `TaskOptions` - 任务选项
-- `Task` - 任务运行时对象
-
-**配置选项**：
-- 调度规则（Cron / 时间间隔）
-- 重试策略
-- 时区设置
-- 错误处理
-
-[查看完整文档 →](./task.md)
-
----
-
-### [DevTools](./devtools.md)
-
-浏览器环境下的可视化调试工具。
-
-**功能特性**：
-- 任务列表和状态监控
-- 时间线视图
-- 执行历史
-- 实时日志
-
-**配置选项**：
-- 主题模式
-- 停靠位置
-- 界面语言
-- 悬浮按钮自定义
-
-[查看完整文档 →](./devtools.md)
-
----
-
-### [类型定义](./types.md)
-
-完整的 TypeScript 类型定义。
-
-**核心类型**：
-- `SchedulerConfig`
-- `TaskDefinition`
-- `TaskOptions`
-- `Task`
-- `TaskStatus`
-- `ExecutionRecord`
-
-**插件类型**：
-- `HyperSchedulerPlugin`
-- `DevToolsOptions`
-
-[查看完整文档 →](./types.md)
-
----
-
-## 快速查找
-
-### 按功能分类
-
-#### 任务管理
-- [创建任务](./scheduler.md#createtask) - `scheduler.createTask()`
-- [删除任务](./scheduler.md#deletetask) - `scheduler.deleteTask()`
-- [查询任务](./scheduler.md#gettask) - `scheduler.getTask()`
-- [获取所有任务](./scheduler.md#getalltasks) - `scheduler.getAllTasks()`
-
-#### 任务控制
-- [启动调度器](./scheduler.md#start) - `scheduler.start()`
-- [停止调度器](./scheduler.md#stop) - `scheduler.stop()`
-- [启动任务](./scheduler.md#starttask) - `scheduler.startTask()`
-- [停止任务](./scheduler.md#stoptask) - `scheduler.stopTask()`
-- [手动触发](./scheduler.md#triggertask) - `scheduler.triggerTask()`
-
-#### 任务配置
-- [调度规则](./task.md#schedule) - Cron 表达式 / 时间间隔
-- [重试策略](./task.md#retry) - 失败重试配置
-- [时区设置](./task.md#timezone) - 任务专属时区
-- [错误处理](./task.md#onerror) - 错误回调函数
-
-#### 事件监听
-- [订阅事件](./scheduler.md#on) - `scheduler.on()`
-- [事件类型](./scheduler.md#支持的事件) - 完整事件列表
-
-#### 调试工具
-- [DevTools 配置](./devtools.md#构造函数) - 初始化选项
-- [主题设置](./devtools.md#主题配置) - light / dark / auto
-- [语言设置](./devtools.md#语言设置) - en / zh
-
----
-
-## 使用示例
-
-### 基础用法
-
-```typescript
-import { Scheduler } from 'hyper-scheduler';
-
-const scheduler = new Scheduler({ debug: true });
-
-scheduler.createTask({
-  id: 'my-task',
-  schedule: '*/5 * * * * *',
-  handler: () => console.log('Task executed')
-});
-
-scheduler.start();
-```
-
-### 带重试和错误处理
-
-```typescript
-scheduler.createTask({
-  id: 'api-sync',
-  schedule: '5m',
-  handler: async () => {
-    await syncWithAPI();
-  },
-  options: {
-    retry: {
-      maxAttempts: 3,
-      initialDelay: 1000,
-      factor: 2
-    },
-    onError: (error, taskId) => {
-      console.error(`Task ${taskId} failed:`, error);
-    }
-  }
-});
-```
-
-### 使用 DevTools
-
-```typescript
-import { Scheduler, DevTools } from 'hyper-scheduler';
-
-const scheduler = new Scheduler({
-  plugins: [
-    new DevTools({
-      theme: 'dark',
-      language: 'zh'
-    })
-  ]
-});
-```
-
----
-
-## 相关链接
-
-- [快速开始](../guide/getting-started.md) - 入门指南
-- [核心概念](../guide/core-concepts.md) - 深入理解
-- [最佳实践](../guide/best-practices.md) - 使用建议

package/docs/api/scheduler.md

@@ -1,322 +0,0 @@
-# Scheduler
-
-核心调度器类，负责任务的注册、调度和生命周期管理。
-
-## 概念说明：Scheduler vs Task
-
-在 Hyper Scheduler 中，理解这两个核心概念的区别至关重要：
-
-- **Scheduler (调度器)**：
-    - **角色**：管理者、指挥官。
-    - **职责**：维护任务列表、管理时间轴、触发执行、处理全局配置（如时区、插件）。
-    - **数量**：通常一个应用只需一个全局 Scheduler 实例。
-
-- **Task (任务)**：
-    - **角色**：执行单元、工兵。
-    - **职责**：包含具体的业务逻辑（`handler`）、调度规则（`schedule`）和运行配置（如 `driver`、重试策略）。
-    - **数量**：一个 Scheduler 可以管理成百上千个 Task。
-
-简而言之，**Scheduler** 决定了“**什么时候**”以及“**如何**”运行，而 **Task** 定义了“**做什么**”。
-
-## 构造函数
-
-```typescript
-new Scheduler(config?: SchedulerConfig)
-```
-
-### 参数
-
-- **config** `SchedulerConfig` - 可选配置对象
-
-| 属性 | 类型 | 默认值 | 说明 |
-|------|------|--------|------|
-| `debug` | `boolean` | `false` | 启用调试日志输出 |
-| `timezone` | `string` | 系统时区 | 全局时区设置，如 `'Asia/Shanghai'` |
-| `maxHistory` | `number` | `50` | 每个任务保留的最大执行历史记录数 |
-| `plugins` | `HyperSchedulerPlugin[]` | `[]` | 要在初始化时加载的插件实例数组 |
-
-### 示例
-
-```typescript
-import { Scheduler, DevTools } from 'hyper-scheduler';
-
-const scheduler = new Scheduler({
-  debug: true,
-  timezone: 'Asia/Shanghai',
-  maxHistory: 100,
-  plugins: [
-    new DevTools({ theme: 'dark' })
-  ]
-});
-```
-
-## 实例方法
-
-### createTask()
-
-注册新任务到调度器。
-
-```typescript
-createTask(definition: TaskDefinition): void
-```
-
-#### 参数
-
-- **definition** `TaskDefinition` - 任务定义对象
-
-| 属性 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| `id` | `string` | ✓ | 任务唯一标识符 |
-| `schedule` | `string` | ✓ | 调度规则（Cron 表达式或时间间隔） |
-| `handler` | `() => void \| Promise<void>` | ✓ | 任务执行函数 |
-| `tags` | `string[]` | - | 任务标签，用于分类过滤 |
-| `options` | `TaskOptions` | - | 任务选项 |
-
-详细的 `TaskOptions` 配置请参考 [Task API](./task.md)。
-
-#### 示例
-
-```typescript
-// 基础任务
-scheduler.createTask({
-  id: 'daily-backup',
-  schedule: '0 0 2 * * *', // 每天凌晨 2:00
-  handler: async () => {
-    await backupDatabase();
-  },
-  tags: ['backup', 'critical']
-});
-
-// 带重试和错误处理的任务
-scheduler.createTask({
-  id: 'api-sync',
-  schedule: '5m',
-  handler: async () => {
-    await syncWithAPI();
-  },
-  options: {
-    retry: {
-      maxAttempts: 3,
-      initialDelay: 1000,
-      factor: 2
-    },
-    onError: (error, taskId) => {
-      console.error(`Task ${taskId} failed:`, error.message);
-    }
-  }
-});
-```
-
-### start()
-
-启动调度器，开始执行所有已注册的任务。
-
-```typescript
-start(): void
-```
-
-#### 示例
-
-```typescript
-scheduler.start();
-```
-
-### stop()
-
-停止调度器，暂停所有任务的调度。已经在执行的任务会继续完成。
-
-```typescript
-stop(): void
-```
-
-#### 示例
-
-```typescript
-scheduler.stop();
-```
-
-### startTask()
-
-启动指定任务（从 stopped 状态恢复）。
-
-```typescript
-startTask(taskId: string): void
-```
-
-#### 参数
-
-- **taskId** `string` - 任务 ID
-
-#### 示例
-
-```typescript
-scheduler.startTask('daily-backup');
-```
-
-### stopTask()
-
-停止指定任务，任务状态变为 `stopped`，不再参与调度。
-
-```typescript
-stopTask(taskId: string): void
-```
-
-#### 参数
-
-- **taskId** `string` - 任务 ID
-
-#### 示例
-
-```typescript
-scheduler.stopTask('daily-backup');
-```
-
-### triggerTask()
-
-手动触发任务立即执行一次，不影响正常调度。执行完成后恢复到之前的状态。
-
-```typescript
-triggerTask(taskId: string): Promise<void>
-```
-
-#### 参数
-
-- **taskId** `string` - 任务 ID
-
-#### 返回值
-
-- `Promise<void>` - 任务执行完成后 resolve
-
-#### 示例
-
-```typescript
-await scheduler.triggerTask('daily-backup');
-console.log('Manual trigger completed');
-```
-
-### deleteTask()
-
-删除指定任务，任务将从调度器中移除。
-
-```typescript
-deleteTask(taskId: string): boolean
-```
-
-#### 参数
-
-- **taskId** `string` - 任务 ID
-
-#### 返回值
-
-- `boolean` - 删除成功返回 `true`，任务不存在返回 `false`
-
-#### 示例
-
-```typescript
-const deleted = scheduler.deleteTask('old-task');
-if (deleted) {
-  console.log('Task removed successfully');
-}
-```
-
-### getTask()
-
-获取指定任务的详细信息。
-
-```typescript
-getTask(taskId: string): Task | undefined
-```
-
-#### 参数
-
-- **taskId** `string` - 任务 ID
-
-#### 返回值
-
-- `Task | undefined` - 任务对象，不存在则返回 `undefined`
-
-#### 示例
-
-```typescript
-const task = scheduler.getTask('daily-backup');
-if (task) {
-  console.log('Task status:', task.status);
-  console.log('Next run:', new Date(task.nextRun));
-}
-```
-
-### getAllTasks()
-
-获取所有已注册任务的列表。
-
-```typescript
-getAllTasks(): Task[]
-```
-
-#### 返回值
-
-- `Task[]` - 任务对象数组
-
-#### 示例
-
-```typescript
-const tasks = scheduler.getAllTasks();
-console.log(`Total tasks: ${tasks.length}`);
-
-tasks.forEach(task => {
-  console.log(`${task.id}: ${task.status}`);
-});
-```
-
-### on()
-
-订阅调度器事件。
-
-```typescript
-on(event: string, handler: (payload: any) => void): () => void
-```
-
-#### 参数
-
-- **event** `string` - 事件名称
-- **handler** `(payload: any) => void` - 事件处理函数
-
-#### 返回值
-
-- `() => void` - 取消订阅函数
-
-#### 支持的事件
-
-| 事件名 | 触发时机 | payload 结构 |
-|--------|----------|--------------|
-| `task_registered` | 任务注册时 | `{ taskId: string, task: Task }` |
-| `task_started` | 任务开始执行时 | `{ taskId: string, task: Task }` |
-| `task_completed` | 任务执行成功时 | `{ taskId: string, task: Task, duration: number }` |
-| `task_failed` | 任务执行失败时 | `{ taskId: string, task: Task, error: Error, duration: number }` |
-| `task_stopped` | 任务停止时 | `{ taskId: string, task: Task }` |
-| `task_removed` | 任务删除时 | `{ taskId: string }` |
-
-#### 示例
-
-```typescript
-// 订阅任务完成事件
-const unsubscribe = scheduler.on('task_completed', ({ taskId, duration }) => {
-  console.log(`Task ${taskId} completed in ${duration}ms`);
-});
-
-// 订阅任务失败事件
-scheduler.on('task_failed', ({ taskId, error }) => {
-  console.error(`Task ${taskId} failed:`, error.message);
-  // 发送告警通知
-  sendAlert(taskId, error);
-});
-
-// 取消订阅
-unsubscribe();
-```
-
-## 相关链接
-
-- [Task API](./task.md) - 任务配置详解
-- [DevTools API](./devtools.md) - 调试工具配置
-- [类型定义](./types.md) - 完整类型定义