README.zh.md 4.9 KB


description: "当前 Cordis Loader 插件状态的只读投影:面向 web GUI 宿主客户端的 pluginInventory 服务及其 pluginInventory/list Remote。"

kind: "package-reference"

@deepseek-ai/dsh-host-plugin-inventory

English | 中文

概述

客户端与设置页可以展示宿主当前组合了什么:调用 pluginInventory/list 即按 Loader 顺序返回当前的非组条目——条目 id、模块标识、有效启用状态与根 Fiber 阶段(pending、loading、active、failed 或 unloading;条目没有存活根 Fiber 时为 null)。该快照只表示调用当下:Loader 是唯一的生命周期权威,本包不拥有缓存、历史、来源模型、事件流或修改路径。Client 包通过显式的 api-remotes 组合消费这个 Remote,而不导入 Host 实现。

目录


使用本包

当客户端或设置页需要展示宿主当前组合了什么——哪些插件已加载、已启用、是否存活——时调用 pluginInventory/list。Remote 是唯一入口:该服务仅供 Remote 使用,刻意不声明同进程 Cordis Context merge。

快照包含什么

每一行是一个非组 Loader 条目:其条目 id、精确模块标识、有效启用状态(含被禁用的祖先组)与当前根 Fiber 阶段。pending 表示条目等待加载,loading 表示正在读取,active 表示正在运行,failed 表示其 fiber 被拒绝,unloading 表示正在拆除;null 表示完全不存在存活的根 Fiber。结构性的 group 行会被跳过。

你能用它做什么、不能做什么

该清单是供展示与诊断的快照:客户端可以渲染名单、标出失败条目,并通过比较快照检测变化。它不能启用、停用、添加或移除插件,也不携带历史——已经失败并被移除的 fiber 缺席。由于服务每次调用都读取 Loader,答案总是反映当前组合,而不是缓存视图。


理解实现

实现细节——点击展开 ### 设计理念 网关是一层没有第二个生命周期真源的直接投影:每次 `list()` 调用都读取 `ctx.loader.entries()`,并把每个非组条目映射为公共行。Cordis 内部的 plugin/status 事件已经维护了 `Entry.fiber` 与 `Fiber.state`,因此再加缓存只会多出一个需要同步的生命周期真源。 ### 阶段映射 Fiber 状态映射到公共阶段词汇,其中 `disposed` 折叠为 `null`——fiber 已消失的条目没有可报告的存活根。因此阶段从不区分为什么没有存活根:条目可能从未启动,也可能其 fiber 已被释放。 ### 源码地图 | 文件 | 职责 | |---|---| | [`src/index.ts`](src/index.ts) | `PluginInventoryGateway`:`pluginInventory` Remote 服务与 Loader 投影 | | [`src/types.ts`](src/types.ts) | 公共 payload 类型:`PluginInventoryEntry`、`PluginInventorySnapshot`、`PluginFiberPhase` | | [`src/invariant.ts`](src/invariant.ts) | 不变式伴生插件(无运行时不变式;每个快照都投影 Loader 持有的状态) | Typert 生成由 `./typert` 与 `./remote` 导出的 Host 和 Client Remote 产物。

进一步探索

当清单约定不够用时阅读以下内容:先看 Remote 如何到达客户端,再看它所投影的 Loader 与渲染它的界面。


模型体验

无。这个仅限 Host 的只读 Loader 投影不注册任何面向模型的内容。

KV Cache 影响

无;该包既不组装也不发送提供方请求。

已知限制与延期工作

这些限制说明一个点时刻清单无法告诉客户端什么。它们是当前包约束,不是任务积压。

  • 仅表示调用当下——结果不包含持久的失败历史或订阅;只要不存在存活的根 Fiber,就会报告 null,而不区分其原因。
  • 无来源与修改能力——服务不识别条目由哪个 bundle、profile 或 override 引入,也不能启用、停用、添加或移除插件。

开发备注

维护者的工作上下文——点击展开 无。