@h-ai/reach 0.1.0-alpha5

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] [idealworld.group]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,161 @@
+# @h-ai/reach
+
+用户触达模块，支持同时注册多个 Provider（邮件、短信、API 回调等），通过模板绑定 Provider 实现按场景路由发送。内置免打扰（DND）机制，支持通过配置文件定义模板。
+
+## 依赖
+
+- `@h-ai/reldb` — 数据库（发送日志与模板持久化），可选；已初始化时自动启用持久化
+- `@h-ai/cache` — 缓存（DND delay 策略分布式锁），可选；已初始化时自动启用分布式锁
+
+## 支持的 Provider
+
+| Provider     | 渠道 | 说明                                        |
+| ------------ | ---- | ------------------------------------------- |
+| `console`    | 通用 | 控制台输出（开发/测试用）                   |
+| `smtp`       | 邮件 | SMTP 协议发送邮件（需安装 nodemailer）      |
+| `aliyun-sms` | 短信 | 阿里云短信服务（直接调用 HTTP API，无 SDK） |
+| `api`        | 通用 | HTTP API 回调（通用 webhook）               |
+
+## 快速开始
+
+### 安装
+
+```bash
+pnpm add @h-ai/reach
+```
+
+邮件发送需安装 `nodemailer`。
+
+### 多 Provider 初始化
+
+```ts
+import { cache } from '@h-ai/cache'
+import { reach } from '@h-ai/reach'
+import { reldb } from '@h-ai/reldb'
+
+// 1. 初始化可选依赖（按需）
+await reldb.init({ type: 'sqlite', database: './data.db' }) // 可选，启用发送日志与模板持久化
+await cache.init({ type: 'memory' }) // 可选，启用 DND delay 策略分布式锁
+
+// 2. 初始化触达模块（自动检测已初始化的 reldb/cache 单例）
+await reach.init({
+  providers: [
+    { name: 'email', type: 'smtp', host: 'smtp.example.com', from: 'noreply@example.com' },
+    { name: 'sms', type: 'aliyun-sms', accessKeyId: '...', accessKeySecret: '...', signName: '某某科技' },
+    { name: 'webhook', type: 'api', url: 'https://api.example.com/notify' },
+  ],
+  templates: [
+    { name: 'welcome_email', provider: 'email', subject: '欢迎 {userName}', body: '亲爱的 {userName}，欢迎！' },
+    { name: 'sms_code', provider: 'sms', body: '验证码: {code}，{minutes} 分钟内有效。' },
+  ],
+  dnd: { enabled: true, strategy: 'delay', start: '22:00', end: '08:00' },
+})
+
+// 通过 provider 字段选择发送渠道
+await reach.send({
+  provider: 'email',
+  to: 'user@example.com',
+  template: 'welcome_email',
+  vars: { userName: '张三' },
+})
+
+// 发送短信（通过 extra 传递 Provider 特有参数）
+await reach.send({
+  provider: 'sms',
+  to: '13800138000',
+  extra: { templateCode: 'SMS_123456' },
+  vars: { code: '123456' },
+})
+
+// 关闭所有 Provider
+await reach.close()
+```
+
+## 配置
+
+### Console（开发/测试）
+
+```ts
+const config = { name: 'dev', type: 'console' }
+```
+
+### SMTP
+
+| 字段     | 类型      | 必填 | 默认值 | 说明            |
+| -------- | --------- | ---- | ------ | --------------- |
+| `name`   | `string`  | ✅   | —      | Provider 名称   |
+| `type`   | `string`  | ✅   | —      | 固定 `'smtp'`   |
+| `host`   | `string`  | ✅   | —      | SMTP 服务器地址 |
+| `port`   | `number`  | —    | `465`  | SMTP 端口       |
+| `secure` | `boolean` | —    | `true` | 是否使用 TLS    |
+| `user`   | `string`  | —    | —      | 认证用户名      |
+| `pass`   | `string`  | —    | —      | 认证密码        |
+| `from`   | `string`  | ✅   | —      | 发件人地址      |
+
+### 阿里云短信
+
+| 字段              | 类型     | 必填 | 默认值                  | 说明                |
+| ----------------- | -------- | ---- | ----------------------- | ------------------- |
+| `name`            | `string` | ✅   | —                       | Provider 名称       |
+| `type`            | `string` | ✅   | —                       | 固定 `'aliyun-sms'` |
+| `accessKeyId`     | `string` | ✅   | —                       | AccessKey ID        |
+| `accessKeySecret` | `string` | ✅   | —                       | AccessKey Secret    |
+| `signName`        | `string` | ✅   | —                       | 短信签名            |
+| `endpoint`        | `string` | —    | `dysmsapi.aliyuncs.com` | API 端点            |
+
+### API 回调
+
+| 字段      | 类型                     | 必填 | 默认值  | 说明          |
+| --------- | ------------------------ | ---- | ------- | ------------- |
+| `name`    | `string`                 | ✅   | —       | Provider 名称 |
+| `type`    | `string`                 | ✅   | —       | 固定 `'api'`  |
+| `url`     | `string`                 | ✅   | —       | 回调 URL      |
+| `method`  | `'POST' \| 'PUT'`        | —    | `POST`  | HTTP 方法     |
+| `headers` | `Record<string, string>` | —    | —       | 自定义请求头  |
+| `timeout` | `number`                 | —    | `10000` | 超时毫秒数    |
+
+### DND（免打扰）
+
+| 字段       | 类型                   | 必填 | 默认值    | 说明                                    |
+| ---------- | ---------------------- | ---- | --------- | --------------------------------------- |
+| `enabled`  | `boolean`              | —    | `false`   | 是否启用                                |
+| `strategy` | `'discard' \| 'delay'` | —    | `discard` | discard 丢弃 / delay 延时（DND 后发送） |
+| `start`    | `string`               | —    | `00:00`   | 开始时间（HH:mm 格式）                  |
+| `end`      | `string`               | —    | `00:00`   | 结束时间（HH:mm 格式）                  |
+
+## 错误处理
+
+所有操作返回 `HaiResult<T>`，错误码定义在 `HaiReachError`：
+
+| 错误码                             | code            | 说明            |
+| ---------------------------------- | --------------- | --------------- |
+| `HaiReachError.SEND_FAILED`        | `hai:reach:001` | 发送失败        |
+| `HaiReachError.PROVIDER_NOT_FOUND` | `hai:reach:002` | Provider 未注册 |
+| `HaiReachError.TEMPLATE_NOT_FOUND` | `hai:reach:003` | 模板不存在      |
+| `HaiReachError.CONFIG_ERROR`       | `hai:reach:007` | 配置错误        |
+| `HaiReachError.NOT_INITIALIZED`    | `hai:reach:010` | 未初始化        |
+
+```ts
+const result = await reach.send({ provider: 'email', to: 'user@example.com', body: 'hello' })
+if (!result.success) {
+  // result.error.code / result.error.message
+}
+```
+
+## 分布式锁
+
+多节点部署时，DND（delay 策略）的 pending 消息 flush 操作通过 `@h-ai/cache` 分布式锁保护，确保同一时刻只有一个节点执行 flush。
+
+- 锁基于 `cache.lock.acquire('reach:flush-pending')`，TTL 60 秒
+- 若 `@h-ai/cache` 未初始化，分布式锁自动禁用，不影响单节点运行
+- 使用稳定的进程级 owner 标识，防止误释放他人锁
+
+## 测试
+
+```bash
+pnpm --filter @h-ai/reach test
+```
+
+## License
+
+Apache-2.0