@ deliverart/ sdk- js- 用户

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

安装

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

导出类型

核心类型

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

用户角色类型

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

IRI 类型

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

可用请求

创建用户

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

const user = await sdk.call(new CreateUser({
  email: '[email protected]',
  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 (可选) - 电话号码

获取用户

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 - 页号

获取用户详情

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

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

更新用户

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

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

删除用户

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

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

当前用户电子邮件验证

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

await sdk.call(new SendCurrentUserEmailVerificationCode());

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

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

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

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

await sdk.call(new SendEmailVerificationCodeByEmail({
  email: '[email protected]'
}));

const status = await sdk.call(new VerifyEmailVerificationCodeByEmail({
  email: '[email protected]',
  code: '123456'
}));

完成使用示例

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: '[email protected]',
    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。 。 。 .