# @geins/crm 中文文档

规范地址：https://npmcn.com/package/%40geins/crm/

版本：0\.13\.0
npm 元数据更新时间：2026-11-09T15:49:05.905Z
中文译文更新时间：2026-11-16T02:06:46.589Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：180 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@geins/core \*
- 首次发布：2024-11-12T08:54:10.357Z
- 最新版本发布：2026-11-09T15:49:05.719Z
- 近 30 天下载量：1971（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：103（近 12 个月 51 个）

## 中文简介

Geins SDK的客户关系管理包. 提供用户认证(登录,刷新,密码重置)和配置管理.

## 安装

```sh
npm install @geins/crm
```

也可以使用：`pnpm add @geins/crm`、`yarn add @geins/crm`、`bun add @geins/crm`

## README

# @ geins/ crm (英语)

Geins SDK的客户关系管理包. 提供用户认证(登录,刷新,密码重置)和配置管理.

## 安装

```bash
npm install @geins/crm @geins/core
# or
yarn add @geins/crm @geins/core
```

`@geins/core` 是一个对等依赖,必须在此套件旁边安装.

## 快开始

### 无国籍人( 服务器侧)

```ts
import { GeinsCore } from '@geins/core';
import { GeinsCRM } from '@geins/crm';

const core = new GeinsCore({ apiKey: '...', accountName: '...', channel: '...' });
const crm = new GeinsCRM(core);

// Login
const response = await crm.auth.login({ username: 'user@example.com', password: '...' });

// Get user profile (requires a valid user token)
const user = await crm.user.get(userToken);
```

### 会话( 浏览器侧面)

```ts
import { CrmSession } from '@geins/crm';

const session = new CrmSession(crm, {
  storage: customStorageAdapter, // optional, defaults to cookies
  events: core.events,           // optional, enables cross-tab sync
});

await session.login({ username: 'user@example.com', password: '...' });
const user = await session.getUser(); // auto-refreshes expired tokens
session.logout();
```

## API 概览

| 导出 | 说明 |
| --- | --- |
| `GeinsCRM` | 无国籍客户关系管理入境点——曝光 `auth` 财务报告和审定财务报表 `user` 服务. |
| `CrmSession` | 浏览器侧会话带有符号持续、自动更新和事件排放. |

### GeinsCRM服务

-   **`crm.auth`** —— 说 `login()`, (中文(简体) ), `refresh()`, (中文(简体) ), `getUser()`, (中文(简体) ), `authorized()`, (中文(简体) ), `changePassword()`
-   **`crm.user`** —— 说 `get(token)`, (中文(简体) ), `update(input, token)`, (中文(简体) ), `create(input)`

### 届会

-   **`session.login(credentials)`** ——登录并坚持征兆.
-   **`session.getUser()`** - 用自动更新的图像.
-   **`session.authorized()`** 检查会话有效性 .
-   **`session.logout()`** - 清除所有存储的代币.

## 文档

见 [完整文档](https://sdk.geins.dev/packages/crm/) 供详细使用.

## 许可证

麻省理工学院

## 常见问题

### @geins/crm 是什么？

Geins SDK的客户关系管理包\. 提供用户认证\(登录,刷新,密码重置\)和配置管理\.

### 如何安装 @geins/crm？

在项目目录运行 npm install @geins/crm，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@geins/core（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @geins/crm 支持 TypeScript 吗？

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

### @geins/crm 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @geins/crm 可以商用吗？

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

### @geins/crm 的下载量有多少？

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

### @geins/crm 还在维护吗？

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

