# @descope/core-js-sdk 中文文档

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

版本：2\.78\.0
npm 元数据更新时间：2026-11-08T15:37:48.334Z
中文译文更新时间：2026-11-12T00:47:20.703Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40descope/core-js-sdk
原文对照：https://npmcn.com/package/%40descope/core-js-sdk/?lang=original
项目主页：https://github.com/descope/descope-js
源码仓库：https://github.com/descope/descope-js

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

- 包体积（解压后）：362 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-08-16T08:31:37.439Z
- 最新版本发布：2026-11-08T15:37:48.152Z
- 近 30 天下载量：3383403（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：353（近 12 个月 74 个）

## 中文简介

扫描器 JavaScript 核心 SDK

## 安装

```sh
npm install @descope/core-js-sdk
```

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

## README

# @ descope/ core-js- sdk (英语)

扫描器 JavaScript 核心 SDK

## 使用量

### 安装软件包

```bash
npm install @descope/core-js-sdk
```

### 用这个

```js
import createSdk from '@descope/core-js-sdk';

const projectId = '<project-id>';

const sdk = createSdk({ projectId });

const loginId = 'loginId';

sdk.otp.signIn.email(loginId);
```

## 通过短消息连接

魔法链接可以通过短信而不是电子邮件发送,使用 `signInWithPhone`, (中文(简体) ), `signUpWithPhone`, (中文(简体) ), `signUpOrInWithPhone` 财务报告和审定财务报表 `update.phone.sms`。登录ID是一个电话号码,和 反应是 `PhoneEnchantedLinkResponse`,包含 `maskedPhone` 改为 `maskedEmail`。 。 。 . 与电子邮件不同, 短信只包含正确的链接, 因此用户什么都没有 选择。 投票方式 `waitForSession` 核查则保持不变.

```js
const { data } = await sdk.enchantedLink.signUpOrInWithPhone(
  '+11234567890',
  'https://myapp.com/verify-enchanted-link',
);
const jwt = await sdk.enchantedLink.waitForSession(data.pendingRef);
```

## 外出连接

连接到出站的应用程序(如Google,微软),以访问外部服务的用户数据.

### 基本用途

```js
// Connect to an outbound application
const response = await sdk.outbound.connect('app-id', {
  redirectUrl: 'https://your-app.com/callback',
  scopes: ['email', 'profile'],
});

// Redirect user to the returned URL
window.location.href = response.data.url;
```

### 使用外部标识符

您可以通过一个外部标识符来映射外部用户的连接:

```js
const response = await sdk.outbound.connect('app-id', {
  redirectUrl: 'https://your-app.com/callback',
  scopes: ['email', 'profile'],
  externalIdentifier: 'external-user-id-123',
});
```

### 租户- 特定连接

对于多租户应用程序,您可以指定租户级连接:

```js
const response = await sdk.outbound.connect(
  'app-id',
  {
    redirectUrl: 'https://your-app.com/callback',
    scopes: ['email', 'profile'],
    externalIdentifier: 'external-user-id-123',
    tenantId: 'tenant-123',
    tenantLevel: true,
  },
  'user-session-token',
);
```

## 常见问题

### @descope/core-js-sdk 是什么？

扫描器 JavaScript 核心 SDK

### 如何安装 @descope/core-js-sdk？

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

### @descope/core-js-sdk 支持 TypeScript 吗？

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

### @descope/core-js-sdk 支持 ESM 还是 CommonJS？

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

### @descope/core-js-sdk 可以商用吗？

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

### @descope/core-js-sdk 的下载量有多少？

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

### @descope/core-js-sdk 还在维护吗？

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