@z_06/relay-temp-mail 1.0.2 → 2.0.1

package/README.zh-CN.md

@@ -1,195 +1,307 @@
-# relay-temp-mail
-
-[English](README.md) | [中文](README.zh-CN.md)
-
-一个用于管�?Firefox Relay 邮箱别名和通过 Cloudflare 临时邮箱 API 接收邮件�?TypeScript/JavaScript 包�?
-## 功能特�?
-- **创建 Firefox Relay 别名** - 按需生成新的邮箱别名
-- **列出已有别名** - 查看所有已配置的邮箱别�?- **获取指定别名的邮�?* - 获取并解析发送到特定地址的邮�?- **删除别名** - 以编程方式清理未使用的别�?- **TypeScript 支持** - 所�?API 都有完整的类型定�?- **支持 ESM + CommonJS** - 兼容两种模块系统
-
-## 安装
-
-```bash
-npm install @z_06/relay-temp-mail
-# �?pnpm add @z_06/relay-temp-mail
-# �?bun add @z_06/relay-temp-mail
-```
-
-## 快速开�?
-```typescript
-import { RelayClient } from '@z_06/relay-temp-mail';
-
-const client = new RelayClient({
-  csrfToken: 'your-csrf-token',
-  sessionId: 'your-session-id',
-  cfApiUrl: 'https://your-cf-api.com',
-  cfToken: 'your-cf-token',
-});
-
-// 创建新别�?const alias = await client.createAlias();
-console.log('新别�?', alias.fullAddress);
-
-// 列出所有别�?const aliases = await client.listAliases();
-
-// 获取指定别名的邮�?const emails = await client.getEmails(alias.fullAddress, { limit: 10 });
-```
-
-## 配置
-
-### Firefox Relay Token
-
-获取 `csrfToken` �?`sessionId` 的方法：
-
-1. 登录 [relay.firefox.com](https://relay.firefox.com)
-2. 打开浏览器开发者工�?(F12)
-3. 切换�?Application/Storage 标签�?4. 找到 `relay.firefox.com` �?Cookies
-5. 复制 `csrftoken` �?`sessionid` 的�?
-### CF 临时邮箱
-
-本项目使�?[cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email) 作为临时邮箱后端，你需要先部署该服务才能使用�?
-#### 快速部署步�?
-1. **Fork 仓库**
-   - 访问 [cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email)
-   - 点击右上�?"Fork" 按钮，将仓库复制到你�?GitHub 账户
-
-2. **一键部署到 Cloudflare**
-   - 点击仓库 README 中的 "Deploy to Cloudflare Workers" 按钮
-   - 或参�?[部署文档](https://temp-mail-docs.awsl.uk) 进行手动部署
-
-3. **配置域名和邮件路�?*
-   - �?Cloudflare Dashboard 中添加你的域�?   - 配置 Email Routing（邮件路由）
-   - 创建 catch-all 规则将所有邮件转发到 Worker
-
-4. **获取 API 地址�?Token**
-   - 部署完成后，你的 API 地址格式为：`https://<你的worker名称>.<你的子域>.workers.dev`
-   - 登录前端界面（部署后会有 Pages 地址�?   - 在用户设置或 Admin 后台生成 API Token
-   - �?API 地址�?Token 填入 `RelayClient` 配置
-
-#### 获取 `cfApiUrl` �?`cfToken`
-
-```typescript
-const client = new RelayClient({
-  csrfToken: 'your-csrf-token',
-  sessionId: 'your-session-id',
-  cfApiUrl: 'https://your-worker-name.your-subdomain.workers.dev', // CF Worker API 地址
-  cfToken: 'your-api-token', // �?Admin 后台或用户设置中生成
-});
-```
-
-更多详细配置请参�?[cloudflare_temp_email 官方文档](https://temp-mail-docs.awsl.uk)�?
-## API 文档
-
-### RelayClient
-
-用于�?Firefox Relay �?Cloudflare 临时邮箱服务交互的主类�?
-#### 构造函数选项
-
-```typescript
-interface RelayConfig {
-  csrfToken: string;    // Firefox Relay CSRF token
-  sessionId: string;    // Firefox Relay session ID
-  cfApiUrl: string;     // Cloudflare 临时邮箱 API 地址
-  cfToken: string;      // Cloudflare API token
-  timeout?: number;     // 请求超时时间，毫秒（默认: 30000�?}
-```
-
-#### 方法
-
-##### `listAliases()`
-
-列出所�?Firefox Relay 邮箱别名�?
-```typescript
-const aliases = await client.listAliases();
-// 返回: RelayAlias[]
-```
-
-##### `createAlias()`
-
-创建一个新的随�?Firefox Relay 邮箱别名�?
-```typescript
-const alias = await client.createAlias();
-// 返回: RelayAlias
-console.log(alias.fullAddress); // 例如: "random123@mozmail.com"
-```
-
-##### `deleteAlias(id)`
-
-根据 ID 删除别名�?
-```typescript
-await client.deleteAlias(12345);
-```
-
-##### `getEmails(aliasAddress?, options?)`
-
-�?Cloudflare 临时邮箱 API 检索和解析邮件。如果提供了 `aliasAddress`，则只返回发送到该地址的邮件�?
-```typescript
-// 获取所有邮件（默认数量限制�?const allEmails = await client.getEmails();
-
-// 获取指定别名的邮�?const emails = await client.getEmails('alias@mozmail.com', { limit: 10 });
-
-// 分页获取
-const page2 = await client.getEmails('alias@mozmail.com', { limit: 10, offset: 10 });
-```
-
-选项�?
-- `limit` - 返回的最大邮件数量（默认: 20�?- `offset` - 分页偏移量，�?0 开始（默认: 0�?
-## 错误处理
-
-本包导出了多个错误类，用于处理不同的失败场景�?
-```typescript
-import {
-  RelayTempMailError,
-  NetworkError,
-  AuthError,
-  NotFoundError,
-  ParseError,
-  RateLimitError,
-} from '@z_06/relay-temp-mail';
-
-try {
-  const alias = await client.createAlias();
-} catch (error) {
-  if (error instanceof AuthError) {
-    console.error('认证失败:', error.message);
-  } else if (error instanceof NetworkError) {
-    console.error('网络问题:', error.message);
-  } else if (error instanceof RateLimitError) {
-    console.error('请求过于频繁，请稍后重试:', error.response?.retryAfter);
-  } else if (error instanceof RelayTempMailError) {
-    console.error('Relay 错误:', error.code, error.message);
-  }
-}
-```
-
-### 错误�?
-| 类名 | 描述 | 状态码 |
-|------|------|--------|
-| `RelayTempMailError` | 所有包错误的基�?| - |
-| `NetworkError` | 网络连接问题 | - |
-| `AuthError` | 认证或授权失�?| 401/403 |
-| `NotFoundError` | 请求的资源不存在 | 404 |
-| `ParseError` | 邮件 MIME 解析失败 | - |
-| `RateLimitError` | API 请求频率限制 exceeded | 429 |
-
-所有错误类都继承自 `RelayTempMailError`，并提供以下属性：
-
-- `code` - 机器可读的错误代�?- `statusCode` - HTTP 状态码（如适用�?- `response` - API 返回的原始响应数据（如可用）
-
-## TypeScript
-
-所有类型都已导出，可在 TypeScript 项目中使用：
-
-```typescript
-import type {
-  RelayConfig,
-  RelayAlias,
-  Email,
-  ParsedEmail,
-  ListAliasesOptions,
-  GetEmailsOptions,
-} from 'relay-temp-mail';
-```
-
-本包使用严格�?TypeScript 设置构建，为所�?API 提供全面的类型定义�?
-## 许可�?
-MIT
+# relay-temp-mail
+
+[English](README.md) | [中文](README.zh-CN.md)
+
+一个模块化的 TypeScript/JavaScript 包，通过可插拔的 Provider 管理邮箱别名和接收临时邮件。
+
+基于 Provider 架构 — 自由组合**别名提供商**与**邮件提供商**。当前内置 Firefox Relay 和 CloudFlare 临时邮箱支持，更多提供商即将推出。
+
+## 功能特性
+
+- **Provider 架构** — 自由组合别名与邮件提供商
+- **Firefox Relay** — 创建、列出、删除邮箱别名
+- **CloudFlare 临时邮箱** — 通过 API 获取并解析邮件
+- **TypeScript 支持** — 所有 API 均有完整类型定义，包括 Provider 接口
+- **ESM + CommonJS 支持** — 兼容两种模块系统
+- **可扩展** — 实现 `AliasProvider` 或 `MailProvider` 即可接入新服务
+
+## 安装
+
+```bash
+npm install @z_06/relay-temp-mail
+# 或
+pnpm add @z_06/relay-temp-mail
+# 或
+bun add @z_06/relay-temp-mail
+```
+
+## 快速开始
+
+```typescript
+import { TempMailClient } from '@z_06/relay-temp-mail';
+
+const client = new TempMailClient({
+  aliasProvider: {
+    type: 'firefox-relay',
+    csrfToken: 'your-csrf-token',
+    sessionId: 'your-session-id',
+  },
+  mailProvider: {
+    type: 'cf-temp-mail',
+    apiUrl: 'https://your-cf-api.com',
+    token: 'your-cf-token',
+  },
+});
+
+// 创建新别名
+const alias = await client.createAlias();
+console.log('新别名:', alias.fullAddress);
+
+// 列出所有别名
+const aliases = await client.listAliases();
+
+// 获取指定别名的邮件
+const emails = await client.getEmails(alias.fullAddress, { limit: 10 });
+```
+
+## Providers
+
+本库使用两种可独立组合的 Provider：
+
+| Provider 类型 | 接口 | 当前实现 |
+|---|---|---|
+| **别名提供商** | `AliasProvider` | `firefox-relay` |
+| **邮件提供商** | `MailProvider` | `cf-temp-mail` |
+
+### 别名提供商
+
+#### `firefox-relay`
+
+通过 [Firefox Relay](https://relay.firefox.com) 管理邮箱别名。
+
+**配置：**
+
+```typescript
+{
+  type: 'firefox-relay',
+  csrfToken: string;   // relay.firefox.com 的 CSRF token
+  sessionId: string;   // relay.firefox.com 的 Session ID
+}
+```
+
+**获取 Token：**
+
+1. 登录 [relay.firefox.com](https://relay.firefox.com)
+2. 打开浏览器开发者工具（F12）
+3. 切换到 Application/Storage 标签页
+4. 找到 `relay.firefox.com` 的 Cookies
+5. 复制 `csrftoken` 和 `sessionid` 的值
+
+### 邮件提供商
+
+#### `cf-temp-mail`
+
+从 [cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email) 实例获取邮件。
+
+**配置：**
+
+```typescript
+{
+  type: 'cf-temp-mail',
+  apiUrl: string;  // CF 临时邮箱 API 的基础 URL
+  token: string;    // API Bearer Token
+}
+```
+
+**部署后端：**
+
+1. Fork [cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email)
+2. 部署到 Cloudflare Workers（一键部署或参考[部署文档](https://temp-mail-docs.awsl.uk)手动部署）
+3. 在 Cloudflare Dashboard 中配置域名和 Email Routing 的 catch-all 规则
+4. 从管理后台或用户设置中生成 API Token
+
+## API 文档
+
+### TempMailClient
+
+主客户端类。接受 `aliasProvider` 和 `mailProvider` 配置，提供统一接口。
+
+#### 构造函数
+
+```typescript
+new TempMailClient(config: TempMailConfig)
+
+interface TempMailConfig {
+  aliasProvider: AliasProviderConfig;  // 别名提供商配置（鉴别联合类型）
+  mailProvider: MailProviderConfig;    // 邮件提供商配置（鉴别联合类型）
+  timeout?: number;                    // 请求超时时间，毫秒（默认: 30000）
+}
+```
+
+#### 方法
+
+##### `listAliases()`
+
+列出配置的别名提供商中的所有邮箱别名。
+
+```typescript
+const aliases = await client.listAliases();
+// 返回: RelayAlias[]
+```
+
+##### `createAlias()`
+
+通过配置的别名提供商创建新的邮箱别名。
+
+```typescript
+const alias = await client.createAlias();
+// 返回: RelayAlias
+console.log(alias.fullAddress); // 例如: "random123@mozmail.com"
+```
+
+##### `deleteAlias(id)`
+
+根据 ID 删除别名。
+
+```typescript
+await client.deleteAlias(12345);
+```
+
+##### `getEmails(aliasAddress?, options?)`
+
+从配置的邮件提供商获取并解析邮件。如果提供了 `aliasAddress`，则只返回发送到该地址的邮件。
+
+```typescript
+// 获取所有邮件（默认数量限制）
+const allEmails = await client.getEmails();
+
+// 获取指定别名的邮件
+const emails = await client.getEmails('alias@mozmail.com', { limit: 10 });
+
+// 分页获取
+const page2 = await client.getEmails('alias@mozmail.com', { limit: 10, offset: 10 });
+```
+
+选项：
+
+- `limit` - 返回的最大邮件数量（默认: 20）
+- `offset` - 分页偏移量，从 0 开始（默认: 0）
+
+## 自定义 Provider
+
+实现 `AliasProvider` 或 `MailProvider` 接口即可接入新服务：
+
+```typescript
+import type { AliasProvider, RelayAlias } from '@z_06/relay-temp-mail';
+
+class MyAliasProvider implements AliasProvider {
+  async listAliases(): Promise<RelayAlias[]> { /* ... */ }
+  async createAlias(): Promise<RelayAlias> { /* ... */ }
+  async deleteAlias(id: number): Promise<void> { /* ... */ }
+}
+```
+
+```typescript
+import type { MailProvider, Email } from '@z_06/relay-temp-mail';
+
+class MyMailProvider implements MailProvider {
+  async getMails(limit: number, offset: number): Promise<Email[]> { /* ... */ }
+}
+```
+
+## 错误处理
+
+本包导出了多个错误类，用于处理不同的失败场景：
+
+```typescript
+import {
+  RelayTempMailError,
+  NetworkError,
+  AuthError,
+  NotFoundError,
+  ParseError,
+  RateLimitError,
+} from '@z_06/relay-temp-mail';
+
+try {
+  const alias = await client.createAlias();
+} catch (error) {
+  if (error instanceof AuthError) {
+    console.error('认证失败:', error.message);
+  } else if (error instanceof NetworkError) {
+    console.error('网络问题:', error.message);
+  } else if (error instanceof RateLimitError) {
+    console.error('请求过于频繁，请稍后重试:', error.response?.retryAfter);
+  } else if (error instanceof RelayTempMailError) {
+    console.error('错误:', error.code, error.message);
+  }
+}
+```
+
+### 错误类
+
+| 类名 | 描述 | 状态码 |
+|------|------|--------|
+| `RelayTempMailError` | 所有包错误的基类 | - |
+| `NetworkError` | 网络连接问题 | - |
+| `AuthError` | 认证或授权失败 | 401/403 |
+| `NotFoundError` | 请求的资源不存在 | 404 |
+| `ParseError` | 邮件 MIME 解析失败 | - |
+| `RateLimitError` | API 请求频率超限 | 429 |
+
+所有错误类都继承自 `RelayTempMailError`，并提供以下属性：
+
+- `code` - 机器可读的错误代码
+- `statusCode` - HTTP 状态码（如适用）
+- `response` - API 返回的原始响应数据（如可用）
+
+## TypeScript
+
+所有类型均已导出，包括 Provider 接口：
+
+```typescript
+import type {
+  AliasProvider,
+  MailProvider,
+  TempMailConfig,
+  FirefoxRelayConfig,
+  CFTempMailConfig,
+  RelayAlias,
+  Email,
+  ParsedEmail,
+  GetEmailsOptions,
+} from '@z_06/relay-temp-mail';
+```
+
+## 从 v1 迁移
+
+<details>
+<summary>v1 → v2 迁移指南</summary>
+
+**`RelayClient` → `TempMailClient`**
+
+```typescript
+// v1（已废弃）
+import { RelayClient } from '@z_06/relay-temp-mail';
+const client = new RelayClient({
+  csrfToken: '...',
+  sessionId: '...',
+  cfApiUrl: 'https://...',
+  cfToken: '...',
+});
+
+// v2
+import { TempMailClient } from '@z_06/relay-temp-mail';
+const client = new TempMailClient({
+  aliasProvider: {
+    type: 'firefox-relay',
+    csrfToken: '...',
+    sessionId: '...',
+  },
+  mailProvider: {
+    type: 'cf-temp-mail',
+    apiUrl: 'https://...',
+    token: '...',
+  },
+});
+```
+
+**`RelayAPIClient` → `FirefoxRelayProvider`**，**`CFEmailClient` → `CFTempMailProvider`**
+
+旧名称仍作为已废弃别名导出。方法签名不变。
+
+</details>
+
+## 许可证
+
+MIT