@ghxstship/xos-sdk

中文文档
4.16.0发布于 2026/11/15MITTypeScriptES Module零依赖近 30 天下载 3193

TypeScript SDK for XOS 公共API,由OpenAPI v1文档生成.

中文使用文档
文档目录4 节
  1. 使用
  2. 文档
  3. 版本
  4. 许可证

@ghxstship/xos-sdk (英语)

用于XOS公共API的TypeScript SDK. 模型,方法签名和操作表都是由OpenAPI v1文档所生成的,因此API参考文献中的每一个操作都是被打出的方法. 它运行于Node.js 22.12或后期,在浏览器和边缘运行时段,没有依赖性.

npm install @ghxstship/xos-sdk

使用

import { XosClient } from "@ghxstship/xos-sdk";

const xos = new XosClient({
  baseUrl: "https://api.ghxstship.tech/v1",
  apiKey: process.env.XOS_API_KEY,
});

const { data: project, etag } = await xos.projects.get(projectId);
await xos.projects.update(projectId, { name: "Harborfront Fall Series" }, { ifMatch: etag! });

for await (const po of xos.purchaseOrders.listAll({ filter: { po_state: { eq: "Approved" } } })) {
  console.log(po.po_number);
}
  • POST 方法发送 Idempotency-Key 并在复试时重新使用.
  • 需要更新 ifMatch; Stale ETag 失败 XosPreconditionFailedError。 。 。 .
  • 问题答案按类型提出 XosApiError 子类,例如 XosValidationError 财务报告和审定财务报表 XosNotFoundError。 。 。 .
  • 费率限额和 Retry-After 我很荣幸 maxRetries (违约2)和 timeoutMs (默认3000).

使用 @ghxstship/xos-sdk/webhooks 切入点 :

import { verifyWebhookSignature } from "@ghxstship/xos-sdk/webhooks";

const result = await verifyWebhookSignature({
  payload: rawBody, // the body exactly as received
  header: request.headers.get("XOS-Signature") ?? "",
  secret: process.env.XOS_WEBHOOK_SECRET!,
});

文档

版本

软件包版本遵循了 XOS 发布( )v4.0.0 发表 4.0.0) (中文(简体) ). 内部 /v1 aPI只是添加了变化,所以一个更新的SDK继续针对每个操作的更老的服务器工作,两者都知道.

许可证

麻省理工学院. 见 自由主义XOS平台本身为AGPL-3.0-只.

版本与发布记录

@ghxstship/xos-sdk 共发布 17 个版本,首次发布于 2026/11/01;过去 12 个月发布了 17 个版本。

版本发布日期距今
4.16.0latest2026/11/15今天
4.15.02026/11/141 天前
4.14.02026/11/142 天前
4.13.02026/11/142 天前
4.12.02026/11/142 天前
4.11.02026/11/132 天前

关于 @ghxstship/xos-sdk 的常见问题

@ghxstship/xos-sdk 是什么?

TypeScript SDK for XOS 公共API,由OpenAPI v1文档生成.

如何安装 @ghxstship/xos-sdk?

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

@ghxstship/xos-sdk 支持 TypeScript 吗?

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

@ghxstship/xos-sdk 支持 ESM 还是 CommonJS?

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

@ghxstship/xos-sdk 需要什么版本的 Node.js?

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

@ghxstship/xos-sdk 可以商用吗?

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

@ghxstship/xos-sdk 的下载量有多少?

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

@ghxstship/xos-sdk 还在维护吗?

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