@coworkee/client

中文文档
0.0.1054发布于 2026/11/01MITTypeScriptES Module构建来源已验证

Typed client for the API of Coworkee apps: OpenAPI types, BFF session, theme, texts and OData helpers

原始使用文档

@coworkee/client

Typed TypeScript client for the API of apps built on Coworkee: types generated from the OpenAPI description of the library endpoints, createCoworkeeClient() (openapi-fetch), apiRequest, ApiError with problem details, the realtime hub (createRealtime(), SignalR), streamed answers (postNdjson), and helpers for the BFF session, theme, texts and OData.

npm install @coworkee/client
import { createCoworkeeClient, createRealtime, unwrap } from '@coworkee/client';

const api = createCoworkeeClient();               // in a page served by the app's BFF: session cookie + CSRF header
const me = unwrap(await api.GET('/api/v1/identity/me'));
const stop = createRealtime().subscribe(`user:${userId}`, ({ type, payload }) => console.log(type, payload));
  • Every Coworkee release publishes it in the version of the release (a.b.c.d becomes a.b.(c*1000+d), npm knows no fourth part).
  • npm run openapi -- <url of /openapi/v1.json> [more documents] refreshes openapi.json, npm run generate the types.
  • Documentation: SDKs

License: MIT

版本与发布记录

@coworkee/client 共发布 33 个版本,首次发布于 2026/10/15;过去 12 个月发布了 33 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.0.1054latest2026/11/012 天前
0.0.10532026/10/312 天前
0.0.10522026/10/313 天前
0.0.10512026/10/313 天前
0.0.10502026/10/313 天前
0.0.10492026/10/313 天前

关于 @coworkee/client 的常见问题

@coworkee/client 是什么?

coworkkee应用API的类型化客户端:OpenAPI类型,BFF会话,主题,文本和OData助手

如何安装 @coworkee/client?

在项目目录运行 npm install @coworkee/client,或使用 pnpm add / yarn add / bun add。

@coworkee/client 支持 TypeScript 吗?

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

@coworkee/client 支持 ESM 还是 CommonJS?

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

@coworkee/client 可以商用吗?

@coworkee/client 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@coworkee/client 还在维护吗?

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