@flowy-agent-store/sdk 0.1.0-beta.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025-2026 Flowy (nomifun.com)
+
+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,138 @@
+# `@flowy-agent-store/sdk`
+
+Node.js host for the Agent Store runtime (`docs/agent-store/12-sdk-packaging.md P1-3`): spawn `agent-store`, wait for its stdout readiness line, connect over loopback with `@flowy-agent-store/client`.
+
+```ts
+import { launchHarness } from "@flowy-agent-store/sdk";
+
+const harness = await launchHarness({
+  client: { name: "my-app", version: "0.1.0" },
+});
+
+// 获取：浏览 / 搜索目录（含每个条目的安装状态）
+const items = await harness.store.search("software");
+
+// 安装：导入 + 注册，并等到组件真的可用（默认 waitForReady: true）
+const outcome = await harness.store.install(items[0]);
+if (outcome.readyIssue === "authorization_required") {
+  const id = outcome.readyComponentId!;
+  // 失败有两条通道，别只看一条：浏览器**之前**的失败由 authStart 同步回
+  // state:"error"；**之后**的失败（换 token 被拒、回调超时、被限流）只会出现在
+  // authStatus 的 error 里，state 一直停在 not_authenticated。
+  // waitForAuth 把第二条通道包成一次调用，并在结束时说清原因。
+  const started = await harness.connectors.authStart(id);
+  if (started.state === "error") throw new Error(started.error ?? "authorization failed to start");
+  const auth = await harness.connectors.waitForAuth(id);
+  if (auth.state !== "authenticated") {
+    throw new Error(auth.state === "error" ? auth.error : "timed out in the browser");
+  }
+}
+
+// 禁用 / 启用：连接器改 mcp_servers.enabled，专家/专家团改 Preset.enabled
+await harness.store.setEnabled(items[0], false);
+
+// 卸载：真的释放运行时产物（技能目录 / Preset / MCP server 行），再清记录
+const released = await harness.store.uninstall(items[0]);
+if (!released.ok) console.warn(released.components.filter((c) => !c.ok));
+
+// 一次 close 收掉传输与子进程（退订 → 关传输 → 杀进程 → 删临时 data-dir）
+await harness.close();
+```
+
+## 导出专家 / 专家团并写到目录（`exportAgent` / `exportTeam` / `materializePack`）
+
+`agents.export` / `teams.export` 只给**定义**（`ExpertPack`），技能是**引用**（`{name, id}`，没有字节）。
+下面三个函数把「定义 + 技能字节」一次**写成一个目录**（`docs/agent-store/35`；它把 doc `32` §6.5 的
+11 行配方提升成了 API）：
+
+```ts
+import { exportTeam } from "@flowy-agent-store/sdk";
+
+// 多 agent 的专家团：递归展开 + 整包失败（成员缺一即失败并点名），leader 在首位
+const result = await exportTeam(harness, teamId, "./frontend-backend-experts");
+// 单 agent 专家用 exportAgent(harness, agentId, dir)
+// 已有 pack（比如缓存/网络传来的）用 materializePack(harness, pack, dir) 只写目录
+
+result.pack;                 // ExpertPack —— 内存里也拿得到，不落盘也能用
+result.writtenSkills;        // 实际写入的技能名（去重后）
+result.writtenAssets;        // 实际写入的插件级资产路径（doc 38，快照相对路径）
+result.danglingSkills;       // 声明了但本机取不到的技能：{ id, error }，如实上报，不静默跳过
+```
+
+写出的布局：
+
+```text
+<dir>/
+  expert-pack.json           # 线上 pack 逐字节
+  persona.md                 # 仅 agent 形态（团没有自己的 persona）
+  members/<id>/persona.md    # 仅 team 形态，每个成员一个
+  skills/<name>/…            # 团包级技能与成员声明合并去重后的技能字节
+  avatars/… bin/… scripts/…  # 插件级资产（doc 38 / pack_format 2）：按快照相对路径落位，
+                             # 字节走 client.readImportAsset；目录因此是完整的插件根
+```
+
+团的技能有**两个来源**，`materializePack` 把两者合并后按 id 去重：顶层 `pack.skills`（该团**包级**声明、
+装机时已物化到托管技能根目录的技能）与 `team.members[].skills`（各成员 frontmatter 的 `skills:` 声明）。
+官方团大多**只在包级声明**技能（例如 `stock-partner-team`：包级 3 个、7 名成员零声明），所以两者都要算进来。
+
+插件级资产（`avatars/`、`bin/`、`scripts/`，与 `skills/` 平级）由 `pack.assets` **按引用**列出
+（`{path, kind: "avatar"|"script", size, digest}`，按 `path` 排序），`materializePack` 逐条拉字节后按
+快照相对路径落盘，`ExportResult.writtenAssets` 记录实际写出的路径。`kind` 是类别标注不是许可——宿主
+自己从不执行插件级脚本，字节按 0644 交付，怎么用是消费方的决定；运营者可用 `[expert_export] scripts = false`
+把这一类从包里减掉。资产是**快照作用域**的：成员 pack 的 `assets` 恒为空表，读顶层 pack；宿主能力位
+`snapshot_assets` 为 false 时同样恒空（区分「没接」与「没有」）。很多团的自带脚本按插件根寻址
+（如 `render.py` 的 `PLUGIN_ROOT/bin/init_task.py`），物化目录现在真的满足这个假设。
+
+错误语义：wire 导出失败（`agent_not_installed` / `agent_disabled` / `policy_denied` /
+`version_mismatch` / `response_too_large`…）**先于任何写盘**，不留半成品目录；`skill/files`
+失败进 `danglingSkills` 并继续；`skill/file` 在列文件成功后失败则**抛出**——那是宿主 I/O 错误，
+吞掉会造出「列了文件却缺内容」的残目录。
+
+**`launchHarness` 解析出的对象就是那个 client**（`docs/agent-store/31` §5 方案 B）：`harness.store` / `harness.conversations` / `harness.models` 直接可用，没有 `.client` 一跳；子进程是 `harness.server`（`readiness` / `dataDir` / `exited`），握手响应是 `harness.handshake`。
+
+五个动词都在 SDK 里可用，但**它们不是 `@flowy-agent-store/sdk` 自己实现的**：本包只负责进程与传输，返回的对象就是一个 `@flowy-agent-store/client` 的 `AppServerClient`（sdk 另挂 `server` / `handshake` / `close()`），其中 `store` 子客户端把 `install` / `uninstall` / `setEnabled` 编排成一条状态机（`search → install → … → uninstall`）。这样分层是刻意的——见 `docs/agent-store/12-sdk-packaging.md` §2 的职责划分。
+
+几条使用上的事实（都是实测结论，不是约定）：
+
+- `store.install` 默认**等到可用**才 resolve。技能拷完即可用，连接器不然：它注册出来是 **disabled** 的（安装器的既定默认），所以就绪检查会先把它 enable，再跑一次探针——只轮询状态永远到不了 `connected`，因为状态派生自上一次探针。探针**有节奏**：首轮（以及之后每 `readyProbeMs`，默认 5s）真连一次，其余轮次只读状态。这是刻意的：一次探针会解析已存 token（临近过期就刷新，401 再刷新一次），按 400ms 的轮询间隔去探针，30 秒预算里能对连接器及其授权服务器打出约 10 次连接 / 最多约 20 次 token 请求，而没有任何人点过按钮。
+- 就绪超时**不会丢掉安装结果**：返回成功的安装 + `ready: false` / `readyIssue: "ready_timeout"`。需要 OAuth 的连接器立刻返回 `authorization_required`，不把超时预算烧光。
+- `connectors.waitForAuth(id)` 是「等授权完成」的写法：它轮询 `authStatus`，一拿到 `error` 就立刻带原因返回（`{state:"error", error}`），成功返回 `{state:"authenticated"}`，预算用完返回 `{state:"timeout"}`；只有状态读本身失败才 reject。手写 `while (state !== "authenticated")` 循环的典型结局是「它就是没变成 authenticated」——而原因（换 token 被拒、回调超时、`slow_down` 限流）早就躺在它每次读到的 `error` 里。
+- 没有「更新」动词。`store.checkUpdates()` 只报告哪些条目有新版，`store.updateHint(item)` 告诉你该怎么做——当前是 `"uninstall_reinstall"`：卸载后重装，安装路径会按版本漂移重新导入，取到市场当前版本。
+- 卸载是**可重入**的：产物已不在算成功。部分失败时那些组件保持已安装、`ok: false` 且点名到组件，重试有意义。
+- `store.setEnabled(item, false)` 对技能只翻一个目录层标记，返回 `code: "skill_disable_flag_only"`——技能语料没有启用状态，要让技能离开运行时只能 `uninstall`。这个 code 会原样透出，不会被吞。
+- **手上只有连接器 id 时，用 `store.findByConnector(id)` 拿回那个 `StoreItem`**。目录条目里**没有**任何字段承载它装出来的连接器名：真实例子是条目 `fenbi-baokao-decision`（显示名「粉笔」）装出来的 server 叫 `fenbi_mcp`——`store.search("fenbi_mcp")` 命中零条，而 `setEnabled` / `uninstall` 要的正是 `StoreItem`（要它的 `snapshot_id`）。`findByConnector` 走 `installed()` 的每个快照组件做**精确**匹配，`id` 与 `name` 两种标识都收；找不到返回 `null`，不猜。
+
+  ```ts
+  // 已安装的连接器：`connectors.list()` 给的是 { id, name }，两者都能查。
+  const item = await harness.store.findByConnector("fenbi_mcp");
+  if (item) await harness.store.setEnabled(item, true);
+  ```
+
+规则（P0 实测结论）：
+
+- 子进程固定 `--host 127.0.0.1 --no-open`；非回环一律拒绝（`isLoopbackUrl`）。
+- 工具面不用改宿主自己的 `~/.agent-store/config.toml`：`env.AGENT_STORE_TOOLS` 直接指定，值是 JSON（形状同 `[tools]` 表），**整份替换**文件里的策略，`{}` = 全开。它只在 Store 宿主生效（桌面 / Web 宿主不采纳 `[tools]`），且子进程启动时读一次。
+
+  ```ts
+  const harness = await launchHarness({
+    client: { name: "my-app", version: "0.1.0" },
+    env: {
+      // 只要基础能力：关掉桌面控制/浏览器与几个域
+      AGENT_STORE_TOOLS: JSON.stringify({
+        web: true,
+        computer: false,
+        browser: false,
+        domains: { cron: false, knowledge: false, media: false },
+      }),
+    },
+  });
+  ```
+- 默认自带临时 `--data-dir` 并在 `close()` 删除；传自己的目录即表示独占——后端单实例锁会 fail-fast。
+- 二进制定位：`bin` 参数 → `AGENT_STORE_BIN` → 平台 runtime 包的 `vendor/` → `PATH`；找不到直接报错（**不下载**，见 P2）。
+- 就绪行 `protocol_version` 与 SDK 不一致时杀掉子进程并报错（含两端版本）。该值是**契约指纹**，不是版本号：任何 wire 变更都会 bump。
+
+不在本包范围内（`07-typescript-sdk.md` §非目标）：`config/*` 与 `skill/*` **写**面。它们的**类型**在
+`@flowy-agent-store/protocol`（wire 上存在的方法就有形状），但**没有** typed 方法——因为这些面跟着
+宿主自己的设置文件与技能目录走，是最易变的部分。**技能的读面是例外**：`skill/files` / `skill/file`
+有 typed 方法（`harness.skills.*`），且被上面的导出函数消费。这是可发现性边界，不是权限边界：
+`harness.transport` 是公开的，服务端按磁盘归属判定可写性。要用就直连 `transport.request`，并自担变动。