@z_06/relay-temp-mail 2.1.2 → 2.1.3

package/README.md

@@ -59,104 +59,12 @@ const emails = await client.getEmails(alias.fullAddress, { limit: 10 });
 
 The library uses two types of providers that can be combined independently:
 
-| Provider Type | Interface | Current Implementations |
+| Provider Type | Interface | Available Providers |
 |---|---|---|
 | **Alias Provider** | `AliasProvider` | `firefox-relay`, `duckduckgo-email` |
 | **Mail Provider** | `MailProvider` | `cf-temp-mail` |
 
-### Alias Providers
-
-#### `firefox-relay`
-
-Manages email aliases through [Firefox Relay](https://relay.firefox.com).
-
-**Configuration:**
-
-```typescript
-{
-  type: 'firefox-relay',
-  csrfToken: string;   // CSRF token from relay.firefox.com cookies
-  sessionId: string;   // Session ID from relay.firefox.com cookies
-}
-```
-
-**Getting your tokens:**
-
-1. Login to [relay.firefox.com](https://relay.firefox.com)
-2. Open your browser's developer tools (F12)
-3. Go to the Application/Storage tab
-4. Find Cookies for `relay.firefox.com`
-5. Copy the values for `csrftoken` and `sessionid`
-
-#### `duckduckgo-email`
-
-Manages email aliases through [DuckDuckGo Email Protection](https://duckduckgo.com/email/).
-
-Since the DuckDuckGo API does not provide endpoints for listing or deleting aliases, this provider uses a local store. A default in-memory store is included; implement `DuckDuckGoAliasStore` for custom persistence (e.g., file-based, database).
-
-**Configuration:**
-
-```typescript
-{
-  type: 'duckduckgo-email',
-  jwtToken: string;             // JWT token from DuckDuckGo Email Protection
-  store?: DuckDuckGoAliasStore; // Optional custom store (default: in-memory)
-}
-```
-
-**Getting your JWT token:**
-
-1. Visit [duckduckgo.com/email](https://duckduckgo.com/email/) and register an account
-2. Open your browser's developer tools (F12)
-3. Click "Generate New Address" in the DuckDuckGo Email UI
-4. In the Network tab, find the request to `quack.duckduckgo.com`
-5. Copy the Bearer token from the `Authorization` header
-
-**Custom persistence:**
-
-```typescript
-import type { DuckDuckGoAliasStore, RelayAlias } from '@z_06/relay-temp-mail';
-
-class MyFileStore implements DuckDuckGoAliasStore {
-  getAll(): RelayAlias[] { /* read from file */ }
-  add(alias: RelayAlias): void { /* append to file */ }
-  remove(id: number): void { /* remove from file */ }
-}
-
-const client = new TempMailClient({
-  aliasProvider: {
-    type: 'duckduckgo-email',
-    jwtToken: 'your-jwt-token',
-    store: new MyFileStore(),
-  },
-  mailProvider: { /* ... */ },
-});
-```
-
-**Duplicate detection:** The DuckDuckGo API may occasionally return a previously-generated address with a 201 response. The provider detects this and throws a `RelayTempMailError` with code `DUPLICATE_ALIAS`.
-
-### Mail Providers
-
-#### `cf-temp-mail`
-
-Retrieves emails from a [cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email) instance.
-
-**Configuration:**
-
-```typescript
-{
-  type: 'cf-temp-mail',
-  apiUrl: string;  // Base URL of your CF temp email API
-  token: string;   // Bearer token for API authentication
-}
-```
-
-**Deploying the backend:**
-
-1. Fork [cloudflare_temp_email](https://github.com/dreamhunter2333/cloudflare_temp_email)
-2. Deploy to Cloudflare Workers (one-click or manual via [docs](https://temp-mail-docs.awsl.uk))
-3. Configure Email Routing and catch-all rules in Cloudflare Dashboard
-4. Generate an API Token from the admin panel or user settings
+For detailed configuration parameters and credential acquisition guides, see **[Provider Setup Guide](PROVIDERS.md)**.
 
 ## API Documentation
 

package/README.zh-CN.md

@@ -59,104 +59,12 @@ const emails = await client.getEmails(alias.fullAddress, { limit: 10 });
 
 本库使用两种可独立组合的 Provider：
 
-| Provider 类型 | 接口 | 当前实现 |
+| Provider 类型 | 接口 | 可用提供商 |
 |---|---|---|
 | **别名提供商** | `AliasProvider` | `firefox-relay`, `duckduckgo-email` |
 | **邮件提供商** | `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` 的值
-
-#### `duckduckgo-email`
-
-通过 [DuckDuckGo 邮件保护](https://duckduckgo.com/email/) 管理邮箱别名。
-
-由于 DuckDuckGo API 不提供列出或删除别名的接口，该提供商使用本地存储。内置内存存储；可通过实现 `DuckDuckGoAliasStore` 接口自定义持久化（如文件、数据库）。
-
-**配置：**
-
-```typescript
-{
-  type: 'duckduckgo-email',
-  jwtToken: string;             // DuckDuckGo 邮件保护的 JWT token
-  store?: DuckDuckGoAliasStore; // 可选自定义存储（默认: 内存存储）
-}
-```
-
-**获取 JWT Token：**
-
-1. 访问 [duckduckgo.com/email](https://duckduckgo.com/email/) 并注册账户
-2. 打开浏览器开发者工具（F12）
-3. 在 DuckDuckGo 邮件界面点击"生成新地址"
-4. 在网络请求栏中找到发往 `quack.duckduckgo.com` 的请求
-5. 从 `Authorization` 请求头中复制 Bearer token
-
-**自定义持久化：**
-
-```typescript
-import type { DuckDuckGoAliasStore, RelayAlias } from '@z_06/relay-temp-mail';
-
-class MyFileStore implements DuckDuckGoAliasStore {
-  getAll(): RelayAlias[] { /* 从文件读取 */ }
-  add(alias: RelayAlias): void { /* 追加到文件 */ }
-  remove(id: number): void { /* 从文件中删除 */ }
-}
-
-const client = new TempMailClient({
-  aliasProvider: {
-    type: 'duckduckgo-email',
-    jwtToken: 'your-jwt-token',
-    store: new MyFileStore(),
-  },
-  mailProvider: { /* ... */ },
-});
-```
-
-**重复检测：** DuckDuckGo API 偶尔会返回之前已生成过的地址（仍返回 201）。该提供商会检测这种情况并抛出 `RelayTempMailError`，错误代码为 `DUPLICATE_ALIAS`。
-
-### 邮件提供商
-
-#### `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
+详细的配置参数和凭证获取指南，请参阅 **[提供商配置指南](PROVIDERS.zh-CN.md)**。
 
 ## API 文档
 

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@z_06/relay-temp-mail",
-  "version": "2.1.2",
-  "type": "module",
-  "description": "TypeScript npm package for Firefox Relay + CF temp email API",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --ext .ts",
-    "coverage": "vitest run --coverage"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "vitest": "^1.0.0"
-  },
-  "engines": {
-    "node": ">=18"
-  }
-}
+{
+  "name": "@z_06/relay-temp-mail",
+  "version": "2.1.3",
+  "type": "module",
+  "description": "TypeScript npm package for Firefox Relay + CF temp email API",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts",
+    "coverage": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}