@codex-app-sdk/web

中文文档
0.23.0发布于 2026/11/10Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 6505

Framework-neutral WebSocket bindings for browser-based Codex applications.

原始使用文档

@codex-app-sdk/web

Framework-neutral WebSocket transport for browser Codex surfaces.

npm install @codex-app-sdk/core @codex-app-sdk/web
  • @codex-app-sdk/web/client creates a reconnecting browser-side CodexSurfaceRendererApi.
  • @codex-app-sdk/web/server binds an already accepted socket to a host-authorized surface lease.
  • @codex-app-sdk/web/protocol exports versioned envelopes for custom transport integrations.

Both endpoints default to a 64 MiB message ceiling. The server adapter can wrap the EventEmitter-style subset implemented by ws, or the host can implement CodexWebSocketPort for another library.

The package does not create an HTTP server, parse cookies, authenticate users, store tokens, manage codexHome directories, pool app-server processes, create upload routes, or depend on Express or a WebSocket implementation. Those are host-application responsibilities.

See the web integration guide, web API, and Basic Express sample.

版本与发布记录

@codex-app-sdk/web 共发布 44 个版本,首次发布于 2026/10/06;过去 12 个月发布了 44 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.23.0latest2026/11/10今天
0.22.12026/11/091 天前
0.22.02026/11/073 天前
0.21.72026/11/073 天前
0.21.62026/11/064 天前
0.21.52026/11/064 天前

关于 @codex-app-sdk/web 的常见问题

@codex-app-sdk/web 是什么?

Framework-neutral WebSocket bindings for browser-based Codex applications.

如何安装 @codex-app-sdk/web?

在项目目录运行 npm install @codex-app-sdk/web,或使用 pnpm add / yarn add / bun add。

@codex-app-sdk/web 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@codex-app-sdk/web 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@codex-app-sdk/web 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@codex-app-sdk/web 可以商用吗?

@codex-app-sdk/web 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@codex-app-sdk/web 的下载量有多少?

根据 npm 官方下载统计,@codex-app-sdk/web 在 2026/10/10 – 2026/11/08 这 30 天内被下载 6,505 次,日均约 217 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@codex-app-sdk/web 还在维护吗?

最新版本 0.23.0 发布于 2026/11/10(今天);至今共发布 44 个版本,其中过去 12 个月发布了 44 个;首次发布于 2026/10/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。