# @deliverart/sdk-js-user 中文文档

规范地址：https://npmcn.com/package/%40deliverart/sdk-js-user/

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:26:54.172Z
中文译文更新时间：2026-11-11T21:43:31.677Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：182 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-06-16T15:41:10.389Z
- 最新版本发布：2026-11-10T20:26:53.930Z
- 近 30 天下载量：5958（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：333（近 12 个月 232 个）

## 中文简介

为用户管理交付 JavaScript SDK

## 安装

```sh
npm install @deliverart/sdk-js-user
```

也可以使用：`pnpm add @deliverart/sdk-js-user`、`yarn add @deliverart/sdk-js-user`、`bun add @deliverart/sdk-js-user`

## README

# @ deliverart/ sdk- js- 用户

交付艺术JavaScript SDK的用户管理软件包.

## 安装

```bash
npm install @deliverart/sdk-js-user @deliverart/sdk-js-core
```

## 导出类型

### 核心类型

-   `User` - 用户信息
-   `UserDetails` - 有作用和权限的扩展用户
-   `UserRole` - 用户角色类型

### 用户角色类型

```typescript
type UserRole = 
  | 'ROLE_ADMIN'
  | 'ROLE_COMPANY_ADMIN'
  | 'ROLE_MANAGER'
  | 'ROLE_STAFF'
  | 'ROLE_DRIVER'
  | 'ROLE_CUSTOMER'
  | 'ROLE_ECOMMERCE_CUSTOMER'
```

### IRI 类型

-   `UserIri` - 用户IRI(`/users/:id`(中文(简体) )

## 可用请求

### 创建用户

```typescript
import { CreateUser } from '@deliverart/sdk-js-user';

const user = await sdk.call(new CreateUser({
  email: 'user@example.com',
  password: 'securePassword123',
  firstName: 'John',
  lastName: 'Doe',
  roles: ['ROLE_STAFF'],
  company: '/companies/123'
}));
```

**输入参数:**

-   `email: string` (需要) - 电子邮件地址
-   `password: string` (需要) - 密码
-   `firstName: string` (必须) - 姓名
-   `lastName: string` (必须) - 姓
-   `roles: UserRole[]` (需要) - 用户角色
-   `company?: string` (可选) - 公司IRI
-   `phoneNumber?: string` (可选) - 电话号码

* * *

### 获取用户

```typescript
import { GetUsers } from '@deliverart/sdk-js-user';

const users = await sdk.call(new GetUsers({
  query: {
    'roles[]': ['ROLE_STAFF', 'ROLE_MANAGER'],
    company: '/companies/123',
    page: 1
  }
}));
```

**查询参数:**

-   `email?: string` - 通过电子邮件过滤
-   `roles[]?: UserRole[]` - 按角色过滤
-   `company?: string` - 按公司过滤
-   `page?: number` - 页号

* * *

### 获取用户详情

```typescript
import { GetUserDetails } from '@deliverart/sdk-js-user';

const user = await sdk.call(new GetUserDetails('user-123'));
```

* * *

### 更新用户

```typescript
import { UpdateUser } from '@deliverart/sdk-js-user';

const updated = await sdk.call(new UpdateUser('user-123', {
  firstName: 'Jane',
  roles: ['ROLE_MANAGER']
}));
```

* * *

### 删除用户

```typescript
import { DeleteUser } from '@deliverart/sdk-js-user';

await sdk.call(new DeleteUser('user-123'));
```

* * *

### 当前用户电子邮件验证

```typescript
import {
  SendCurrentUserEmailVerificationCode,
  VerifyCurrentUserEmailVerificationCode
} from '@deliverart/sdk-js-user';

await sdk.call(new SendCurrentUserEmailVerificationCode());

const status = await sdk.call(new VerifyCurrentUserEmailVerificationCode({
  code: '123456'
}));
```

使用这些对第一当事方电子商务客户账户的要求。 API发送了六位数的电子邮件代码并返回了校验状态,冷却,过期和剩余尝试.

对于尚未登录的电子商务登记,请使用服务器边的登记标志拨打电子邮件扫描请求。 仅从后端/ BFF 边界进行此操作; 注册符号绝不能被浏览器代码曝光 :

```typescript
import {
  SendEmailVerificationCodeByEmail,
  VerifyEmailVerificationCodeByEmail
} from '@deliverart/sdk-js-user';

await sdk.call(new SendEmailVerificationCodeByEmail({
  email: 'customer@example.com'
}));

const status = await sdk.call(new VerifyEmailVerificationCodeByEmail({
  email: 'customer@example.com',
  code: '123456'
}));
```

* * *

## 完成使用示例

```typescript
import { sdk } from './lib/sdk';
import { CreateUser, GetUsers, UpdateUser } from '@deliverart/sdk-js-user';

async function userManagement() {
  // Create staff user
  const staff = await sdk.call(new CreateUser({
    email: 'staff@restaurant.com',
    password: 'tempPassword123',
    firstName: 'Mario',
    lastName: 'Rossi',
    roles: ['ROLE_STAFF'],
    company: '/companies/123',
    phoneNumber: '+39123456789'
  }));

  // Get all staff members
  const staffMembers = await sdk.call(new GetUsers({
    query: {
      'roles[]': ['ROLE_STAFF'],
      company: '/companies/123'
    }
  }));

  // Promote to manager
  await sdk.call(new UpdateUser(staff.id, {
    roles: ['ROLE_MANAGER']
  }));
}
```

## 许可证

麻省理工学院

## 行政电子邮件核查

超级管理员可以调用 `sdk.call(new SetUserEmailVerification(userId, true))` 以验证已有账户(或通过) `false` 没有电子邮件链接。 二元操作返回更新的用户,同步验证步骤,清除待发邮件代码,并保留角色和暂停. 通用创建用户/最新用户有效载荷不接受 `emailVerified`。 。 。 .

## 常见问题

### @deliverart/sdk-js-user 是什么？

为用户管理交付 JavaScript SDK

### 如何安装 @deliverart/sdk-js-user？

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

### @deliverart/sdk-js-user 支持 TypeScript 吗？

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

### @deliverart/sdk-js-user 支持 ESM 还是 CommonJS？

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

### @deliverart/sdk-js-user 可以商用吗？

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

### @deliverart/sdk-js-user 的下载量有多少？

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

### @deliverart/sdk-js-user 还在维护吗？

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