@kyun.si/codex-hongguo 0.0.0-stage → 0.0.21

package/dist/vendor/openhongguo/GO_LICENSE

@@ -0,0 +1,27 @@
+Copyright 2009 The Go Authors.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Google LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/vendor/openhongguo/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 [yyyy] [name of copyright owner]
+
+   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/dist/vendor/openhongguo/README.md

@@ -0,0 +1,283 @@
+# openhongguo（Node.js）
+
+openhongguo 是红果短剧（Hongguo）的非官方 Node.js SDK。SDK 可以浏览短剧目录、搜索短剧，并取得分集的播放地址。
+
+SDK 用匿名设备发送所有请求。SDK 不需要登录。
+
+SDK 的核心是 Go SDK 编译成的 WebAssembly，所以 Node.js SDK 与 Go SDK 的行为相同。
+
+> **免责声明**：本仓库的所有内容仅供学习和参考之用，禁止用于商业用途。使用前请阅读[完整的免责声明](https://github.com/beilunyang/openhongguo#免责声明)。使用本仓库的内容即表示您同意其所有条款和条件。
+
+术语的含义见[根目录 README 的术语表](https://github.com/beilunyang/openhongguo#术语)。
+
+## 快速上手
+
+下面的代码搜索一部短剧，然后取得第 1 集的播放地址。
+
+```js
+import { createClient } from 'openhongguo';
+
+const client = await createClient();
+const page = await client.search('全球死考');
+const episodes = await client.listEpisodes(page.items[0].id);
+const { playback } = await client.resolvePlayback(episodes.items[0].id);
+console.log(playback.streams.map((s) => `${s.definition} ${s.url}`));
+```
+
+第一次请求时，SDK 注册一台匿名设备，并保存设备档案。以后的请求都使用这台匿名设备。
+
+## 安装
+
+需要 Node.js 20 或更高版本。
+
+```sh
+npm install openhongguo
+```
+
+> **注意**：这个包只支持 ES 模块（`import`）。
+
+## 接口
+
+所有方法都返回 Promise。如果方法失败，它抛出 `OpenhongguoError`。
+
+<!-- gen:methods -->
+<!-- 由 go run ./bindings/docgen 生成，请修改 sdk 的 Go 注释，不要手工修改。 -->
+
+### 发现与搜索
+
+| 方法 | 作用 |
+|---|---|
+| `discover(options)` | 加载书城的一个频道，默认是“推荐” |
+| `discoverAll(options)` | 逐页遍历书城的一个频道，并去掉跨页重复的短剧 |
+| `search(query, options)` | 搜索短剧，可以按真人剧、漫剧等筛选 |
+| `searchAll(query, options)` | 逐页遍历搜索结果，并去掉跨页重复的短剧 |
+| `suggest(prefix)` | 返回某个前缀的搜索联想词 |
+| `hotSearch()` | 加载搜索页的“猜你想搜”和各个热搜榜 |
+| `searchCues()` | 加载搜索框里轮播的提示词 |
+| `newReleases(query)` | 加载上新日历的一页 |
+
+### 短剧与分集
+
+| 方法 | 作用 |
+|---|---|
+| `getSeries(seriesId)` | 加载一部短剧的详情 |
+| `getSeriesBatch(seriesIds)` | 加载多部短剧及其分集，按请求顺序返回 |
+| `listEpisodes(seriesId, options)` | 加载一部短剧的分集列表 |
+| `seasons(seriesId)` | 列出多季短剧的全部季 |
+| `seriesRecommend(seriesId)` | 加载一部短剧的相关推荐 |
+| `getAlbum(albumId)` | 加载一个合集（多季合集）及其各季 |
+
+### 榜单与分类
+
+| 方法 | 作用 |
+|---|---|
+| `shortRank(query)` | 加载短剧排行榜的一页，包括演员榜 |
+| `shortFilterPanel(genre)` | 加载短剧筛选面板的各个选择行 |
+| `shortFilter(query)` | 按条件筛选短剧，一次一页 |
+| `rankRows(cellId, offset)` | 加载书城榜单的一页（经典频道的榜单入口） |
+| `rankGroups()` | 列出书城榜单的类型（经典频道的各个榜单） |
+| `ranking(activityId, rankListId)` | 加载一个活动榜单 |
+| `categories(categoryId)` | 加载书籍分类的标签页：全部、男生、女生和默认标签页 |
+| `categoryLanding(categoryId, options)` | 加载书籍分类下列表的一页，以及它的筛选面板 |
+
+### 演员
+
+| 方法 | 作用 |
+|---|---|
+| `person(userId)` | 加载一位演员或一个角色的主页 |
+| `personWorks(userId, cursor)` | 加载一位演员参演的短剧，一次一页（主页上的作品 › 剧作） |
+
+### 播放与设备
+
+| 方法 | 作用 |
+|---|---|
+| `resolvePlayback(episodeId)` | 加载一集的播放模型：各清晰度的地址、编码和码率 |
+| `resetDevice()` | 丢弃当前匿名设备，并注册一台新设备 |
+<!-- /gen:methods -->
+
+参数和返回值的类型见 `index.d.ts` 和 `types.d.ts`。类型定义由 Go 源码生成，字段说明与 Go SDK 相同。
+
+### 翻页
+
+`discoverAll` 和 `searchAll` 逐部遍历带游标的列表。服务端会在不同的页中返回同一部短剧。这两个方法删除重复的短剧。
+
+```js
+for await (const series of client.searchAll('末世', {}, { maxPages: 3 })) {
+  console.log(series.id, series.title);
+}
+```
+
+### 搜索筛选
+
+`SearchFilter` 提供“综合”分类的筛选项。
+
+```js
+import { SearchFilter } from 'openhongguo';
+
+await client.search('奇幻', { filters: [SearchFilter.ShortPlay, SearchFilter.Film] });
+```
+
+| 筛选项 | 含义 |
+|---|---|
+| `ShortPlay` | 真人剧 |
+| `Comic` | 漫剧 |
+| `AIComic` | AI 剧 |
+| `Film` | 影视剧 |
+| `Unwatched` | 未看过 |
+
+### 加密分集
+
+`resolvePlayback` 返回 `{ playback, contentKey }`。如果分集是加密的，`playback.protected` 是 `true`，`contentKey.key` 是内容密钥。加密方式是 cenc-aes-ctr。
+
+```js
+const { playback, contentKey } = await client.resolvePlayback(episodeId);
+if (playback.protected) {
+  // 例如：ffmpeg -decryption_key <key> -i <url> -c copy out.mp4
+  console.log(contentKey.key);
+}
+```
+
+如果 SDK 不能推导内容密钥，结果中没有 `contentKey`。`contentKeyError` 给出原因。播放模型仍然正常返回。
+
+## 字段命名
+
+| 方向 | 风格 | 示例 |
+|---|---|---|
+| 返回值 | 下划线风格，与 Go SDK 的 JSON 相同 | `has_more`、`cover_url`、`episode_count` |
+| 查询参数 | 驼峰风格 | `pageSize`、`cursor` |
+
+返回值的字段名也与 CLI 的 `--json` 输出相同。
+
+## 设置
+
+`createClient(options)` 的设置都是可选的。
+
+| 设置 | 作用 |
+|---|---|
+| `profile` | 设备档案的位置：文件路径，或自定义的存储对象 |
+| `transport` | 自定义的请求发送函数 |
+| `timeoutMs` | 默认发送函数的超时，单位是毫秒。默认值是 30000 |
+| `retryAttempts` | 可重试的失败的最多尝试次数。默认值是 3 |
+| `deviceResets` | 设备被拒或播放返回空结果时，一次调用最多更换几台匿名设备。默认值是 2，0 表示关闭 |
+| `device` | 新匿名设备的机型。空字段使用默认值（小米 14） |
+| `log` | 接收诊断日志的函数。日志中的 URL 已经脱敏 |
+| `apiOrigin`、`registerOrigin`、`distributionOrigin` | 接口地址。默认值与 App 相同 |
+
+### 设备档案
+
+设备档案的默认位置是 `<用户配置目录>/openhongguo/anonymous.json`。CLI 使用同一个设备档案。
+
+| 系统 | 默认位置 |
+|---|---|
+| macOS | `~/Library/Application Support/openhongguo/anonymous.json` |
+| 其他系统 | `<用户配置目录>/openhongguo/anonymous.json` |
+
+如果要更改目录，设置环境变量 `OHG_CONFIG_DIR`。
+
+如果只把设备档案保存在内存中，使用 `memoryProfileStore`。进程退出后，设备档案丢失。
+
+```js
+import { createClient, memoryProfileStore } from 'openhongguo';
+
+const client = await createClient({ profile: memoryProfileStore() });
+```
+
+自定义的存储对象必须实现三个异步方法：
+
+| 方法 | 作用 |
+|---|---|
+| `load()` | 读取设备档案。如果没有设备档案，返回 `null` |
+| `save(json)` | 保存设备档案 |
+| `reset()` | 删除设备档案 |
+
+### 自定义请求
+
+`transport` 接收一个请求对象，返回一个响应对象。
+
+```js
+const client = await createClient({
+  transport: async ({ method, url, headers, body }) => {
+    // ……发送请求……
+    return { status, headers, cookies, body }; // body 是 Uint8Array
+  },
+});
+```
+
+> **注意**：响应体必须是原始字节。不要自动解压响应体。SDK 根据 `Content-Encoding` 自己解压。
+
+> **注意**：只在没有收到响应时，`transport` 才抛出错误。如果收到 HTTP 错误状态码，正常返回响应。SDK 判断状态码。
+
+## 错误处理
+
+所有错误都是 `OpenhongguoError`。`OpenhongguoError` 有三个属性：
+
+| 属性 | 含义 |
+|---|---|
+| `code` | 错误码，例如 `RATE_LIMITED`、`CONTENT_UNAVAILABLE`、`DEVICE_REJECTED` |
+| `retryable` | 重试同一请求能否成功 |
+| `retryAfterMs` | 服务端建议的等待时间，单位是毫秒。0 表示没有建议 |
+
+```js
+import { OpenhongguoError } from 'openhongguo';
+
+try {
+  await client.getSeries(seriesId);
+} catch (e) {
+  if (e instanceof OpenhongguoError && e.code === 'CONTENT_UNAVAILABLE') {
+    console.log('这部短剧已下架');
+  }
+}
+```
+
+下表列出所有错误码。
+
+<!-- gen:errors -->
+<!-- 由 go run ./bindings/docgen 生成，请修改 sdk 的 Go 注释，不要手工修改。 -->
+
+| 错误码 | 含义 | 可重试 |
+|---|---|---|
+| `INVALID_OPTIONS` | 客户端的设置或调用参数无效 | 否 |
+| `PROFILE_NOT_FOUND` | 还没有保存过设备档案 | 否 |
+| `SIGNER_UNAVAILABLE` | 请求需要签名，而客户端没有可用的签名器 | 否 |
+| `AUTHENTICATION_REQUIRED` | 内容需要登录才能访问，匿名客户端无法继续 | 否 |
+| `NOT_PROTECTED` | 为未加密的播放模型请求了内容密钥 | 否 |
+| `DRM_PROTECTED` | 分集是加密的，需要内容密钥才能解密 | 否 |
+| `ANONYMOUS_LIMITED` | 服务端给匿名设备返回了空结果 | 否 |
+| `RATE_LIMITED` | 请求太频繁，被服务端限流 | 是 |
+| `TRANSPORT` | 网络请求失败 | 是 |
+| `SIGNATURE_REJECTED` | 服务端拒绝了请求的签名 | 否 |
+| `CONTENT_UNAVAILABLE` | 内容已下架、不存在，或当前调用方无权访问 | 否 |
+| `PARAM_INVALID` | 服务端认为请求参数无效 | 否 |
+| `CHALLENGE_REQUIRED` | 服务端要求验证码或其他验证，匿名客户端无法继续 | 否 |
+| `DEVICE_REJECTED` | 匿名设备被拒绝，需要重置设备后重新注册 | 否 |
+| `END_OF_LIST` | 列表已经没有更多内容 | 否 |
+| `ALBUM_UNAVAILABLE` | 匿名读取不到这个合集，或者这部短剧没有其他季 | 否 |
+| `CANCELLED` | 调用被取消 | 否 |
+<!-- /gen:errors -->
+
+## 实现原理
+
+`dist/openhongguo.wasm` 是 Go SDK 编译成的 WebAssembly。桥接代码在 `bindings/node/wasm` 中。方法表在 `bindings/internal/dispatch` 中，Android SDK 和 iOS SDK 也使用它。
+
+| 工作 | 执行者 |
+|---|---|
+| 发送请求 | JS。Go 把请求传给 `transport`。默认的 `transport` 使用 `node:https` |
+| 读写设备档案 | JS。Go 通过 `profile` 的三个方法读写 JSON |
+| 执行 SDK 方法 | Go。每个方法在一个 goroutine 中运行，结果以 JSON 返回给 JS |
+
+第一次调用 `createClient` 时，SDK 加载 wasm。加载需要几百毫秒。同一进程中的所有客户端共用一个 wasm 实例。
+
+## 开发
+
+从源码构建需要 Go 1.22 或更高版本。在本目录中运行以下命令。
+
+| 命令 | 作用 |
+|---|---|
+| `npm run build` | 编译 wasm，复制 `wasm_exec.js`，重新生成 `types.d.ts` |
+| `npm test` | 用 `testdata/protocol` 的样本回放测试。测试不访问网络 |
+
+> **注意**：不要手工修改 `types.d.ts`。`go run ./bindings/node/tsgen` 生成这个文件。仓库根目录的 `go test ./...` 检查它是否过时。
+
+## 许可证
+
+本包使用 Apache License 2.0 许可证。`dist/wasm_exec.js` 来自 Go 项目，使用 BSD 许可证，全文见 `GO_LICENSE`。