# @faiber/faiber-ts-sdk 中文文档

规范地址：https://npmcn.com/package/%40faiber/faiber-ts-sdk/

版本：2\.8\.0
npm 元数据更新时间：2026-11-14T10:09:30.892Z
中文译文更新时间：2026-11-14T09:24:15.024Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40faiber/faiber-ts-sdk
原文对照：https://npmcn.com/package/%40faiber/faiber-ts-sdk/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：128 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：22 个
- 首次发布：2026-07-18T14:47:33.571Z
- 最新版本发布：2026-11-14T10:09:30.688Z
- 近 30 天下载量：3284（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 63 个）

## 中文简介

所有公共Faiber服务的完整打字外观.

## 安装

```sh
npm install @faiber/faiber-ts-sdk
```

也可以使用：`pnpm add @faiber/faiber-ts-sdk`、`yarn add @faiber/faiber-ts-sdk`、`bun add @faiber/faiber-ts-sdk`

## README

# @faiber/faiber-ts-sdk

所有公共Faiber服务的完整打字外观.

## 安装和配置

```bash
npm install @faiber/faiber-ts-sdk
```

服务器端登录已注册的机密客户端 :

```ts
import { FaiberSDK, MemoryTokenProvider, domainsFromEnv } from "@faiber/faiber-ts-sdk";

const tokens = new MemoryTokenProvider();
const sdk = new FaiberSDK({
  domains: domainsFromEnv(process.env),
  authMode: "bearer",
  tokenProvider: tokens,
  axios: { timeout: 15_000, withCredentials: true },
});

const login = await sdk.idp.login({
  grant_type: "password",
  username,
  password,
  client_id,
  client_secret,
});
await tokens.setTokens({
  accessToken: login.data.data.access_token,
  refreshToken: login.data.data.refresh_token,
});

const [products, profile, slots] = await Promise.all([
  sdk.modules.products.list({ page_number: 1, page_size: 24 }),
  sdk.profile.full(userId),
  sdk.reservation.availableSlots({ provider_id: providerId }),
]);
```

外表会暴露 `idp`, (中文(简体) ), `profile`, (中文(简体) ), `modules`, (中文(简体) ), `social`, (中文(简体) ), `asset`, (中文(简体) ), `payment`, (中文(简体) ), `messenger`, (中文(简体) ), `crm`, (中文(简体) ), `lms`, (中文(简体) ), `reservation`, (中文(简体) ), `session`, (中文(简体) ), `version`, (中文(简体) ), `flow`, (中文(简体) ), `knowledge`, (中文(简体) ), `chat`, (中文(简体) ), `state`, (中文(简体) ), `drm`, (中文(简体) ), `task`, (中文(简体) ), `manage`,以及 `gis`每个常规的REST服务都具有管理便利方法、看守的REST资源、低水平认证客户端和 `operations` 包含每个已挂载后端路由的对象。 DRM包括其完整的管理面板合同(图书馆,类别,组成,混合媒体,工作流程,运算表,包工作,状态,审计,操作设置,多段媒体,和二进制块上传). 会议内容包括房间生命周期、LMS/聊天集成、录音/播放、品牌制作、分析、以及犬科室/录音/回放视图URL。 聊天包括助理行政管理和全程对话/实时/AI运行时间合同. 信使和支付披露了它们的全面管理、地位、整合和核查合同。 实时状态、任务、版本和管理保留其专门的运输意识客户端。 管理提供了工程范围代理源外加被审查的Agentic动作和POST-SSE API.

`FaiberSDK.capabilities`, (中文(简体) ), `sdk.capabilities`,以及 `sdk.describe(service?)` 曝光机可读描述,认证规则,传输,环境变量,操作计数,以及AI-代理使用指南等. 每个服务包也导出为命名空间, 如 `IdpService`, (中文(简体) ), `DrmService`,或 `StateService`,所以应用程序代码可以完全从这个外观导入运行时间 API和类型.

所有方法都返回 Axios 的全部响应并接受请求选项,用于头,取消,超时,以及运输覆盖. 使用 `authMode: "cookie"` 用于安全 Http 唯一的cookie 授权,或 `authMode: "bearer"` 与内存/服务器代号提供商。 在服务器上保密客户端机密;浏览器应用程序使用已注册浏览器登录流或服务器管理会话. 服务来源通过 `domains`, (中文(简体) ), `defaultDomain`,或 `domainsFromEnv`; SDK 从不硬码部署域.

请查看每个服务包README的容量和权限表,请求/清空合同,响应信封,上传,格式编码,出错,以及实例.

### Poulstar 办公室扩展

Poulstar Office使用其项目拥有的API客户端和部署配置. 平台外观覆盖上述注册的Infera服务.

## 每日和每周语文管理系统日历

自1.2.0起,一个经认证的SDK实例在 一个请求。 要求数 `lms:classroom:read` 和带有日历的 LMS 部署 终点 适用现有的能见度规则;没有单独的配置/报告权限 或需要浓缩请求.

```ts
const controller = new AbortController();
const response = await sdk.lms.classroomCalendar({
  date: '2026-10-25',
  timezone: 'Asia/Tehran',
}, { signal: controller.signal });
const { sessions, summary, type_counts } = response.data.data;
```

一个星期,替换 `date` 与 `from: '2026-10-25T00:00:00+03:30'` 财务报告和审定财务报表 `to: '2026-11-01T00:00:00+03:30'`。结尾是排他性的;完全范围可能 当地1-7天。 所有结果均不作帕吉化还原. 多老师 和类型过滤器是数组。 类型计数忽略选中的类型过滤器, 而 概要参数描述返回的会话。 保留零学生数 使用请求的时区格式化时间戳即时。 呼叫保留了 axios 完全响应,取消和错误。 见 [@faiber/faiber-lms 向导](https://www.npmjs.com/package/@faiber/faiber-lms) 用于完整字段、过滤和无语义以及每周例.

## 常见问题

### @faiber/faiber-ts-sdk 是什么？

所有公共Faiber服务的完整打字外观\.

### 如何安装 @faiber/faiber-ts-sdk？

在项目目录运行 npm install @faiber/faiber-ts-sdk，或使用 pnpm add / yarn add / bun add。

### @faiber/faiber-ts-sdk 支持 TypeScript 吗？

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

### @faiber/faiber-ts-sdk 支持 ESM 还是 CommonJS？

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

### @faiber/faiber-ts-sdk 可以商用吗？

@faiber/faiber-ts-sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @faiber/faiber-ts-sdk 的下载量有多少？

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

### @faiber/faiber-ts-sdk 还在维护吗？

最新版本 2\.8\.0 发布于 2026/11/14（今天）；至今共发布 63 个版本，其中过去 12 个月发布了 63 个；首次发布于 2026/07/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。