# @blux\.ai/web-sdk 中文文档

规范地址：https://npmcn.com/package/%40blux.ai/web-sdk/

版本：3\.1\.4
npm 元数据更新时间：2026-10-29T07:24:47.346Z
中文译文更新时间：2026-11-08T09:11:30.554Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：287 kB，123 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2024-06-05T08:49:39.007Z
- 最新版本发布：2026-10-29T07:24:47.152Z
- 近 30 天下载量：3333（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：85（近 12 个月 48 个）

## 中文简介

官方 Blux JavaScript 浏览器客户端库

## 安装

```sh
npm install @blux.ai/web-sdk
```

也可以使用：`pnpm add @blux.ai/web-sdk`、`yarn add @blux.ai/web-sdk`、`bun add @blux.ai/web-sdk`

## README

# Blux Web sdk # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # ################################################################################################################################################

### 安装

-   支持的节点.js版本 `>= 10.24.1`
-   npm/yarn을 이용하여 설치하실.

```shell
// NPM 이용
npm install @blux.ai/web-sdk

// Yarn 이용
yarn add @blux.ai/web-sdk
```

### **初始化**

* * *

-   필요: `Application ID`, (中文(简体) ), `API 키`

```typescript
const bluxClient = new BluxClient({
  bluxApplicationId: "BLUX_APPLICATION_ID",
  bluxAPIKey: "BLUX_API_KEY",
});
bluxClient.setLogLevel("warning");
```

-   **设置日志级别** :================================================================================================================================================== (================================为================================ (========= {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢.
    -   `'debug'`
    -   `'log'`
    -   `'warning'`
    -   `'error'`
    -   `'fatal'`

### 签名

-   {\\FN黑体\\FS22\\BORD1\\SHAD0\\3AHBE\\4AH00\\FSCX67\\FSCY66\\2CHFFFFFF\\3CH808080}你觉得呢.
-   豪华서비스에서 `UserId`를.
-   {\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得怎么样.
-   {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 `initialize` {\\fn华文仿宋\\fs16\\1cHD1D1D1}好.

```typescript
bluxClient.signIn({ userId: "USER ID" });
```

### 用户收益

-   {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢? 전화번호,이메일也.

```typescript
bluxClient.setUserProperties({
  userProperties: {
    phone_number: "01011112222",
    email_address: "test@example.com",
  },
});
```

### 用户收益

-   `setUserProperties`{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得呢.

```typescript
bluxClient.setCustomUserProperties({
  customUserProperties: {
    custom_key1: "any_value",
    custom_key2: true,
    custom_key4: 3,
  },
});
```

### 注册退出

-   {\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得呢.
-   {\\fn华文仿宋\\fs16\\1cHD1D1D1}好.

```typescript
bluxClient.signOut();
```

### 发送事件

#### {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

:==================================================================================================================================================================================为======================== (===================================== (============.

* * *

```typescript
bluxClient.sendEvent(
  new AddProductDetailViewEvent({
    itemId: "ITEM_ID",
  }),
);
```

#### 상품

\======================================================================================================= ====================================================================================================================== (=============================== (.

* * *

```typescript
bluxClient.sendEvent(
  new AddLikeEvent({
    itemId: "ITEM_ID",
  }),
);
```

#### {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得怎样.

* * *

```typescript
bluxClient.sendEvent(
  new AddCartaddEvent({
    itemId: "ITEM_ID",
  }),
);
```

#### 상품

{\\fn黑体\\fs20\\shad2\\2aH82\\3aH20\\4aH33\\fscx95\\3cH592001\\be1}你觉得怎么样? {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}我付了钱.

* * *

```typescript
bluxClient.sendEvent(
  new AddOrderEvent({
    orderId: "ORDER_ID",
    paidAmount: 1200,
    orderAmount: 2000,
    items: [
      {
        id: "ITEM_ID_1",
        price: 1000,
        quantity: 1,
      },
    ],
  }),
);
```

```typescript
// 복수 상품을 구매한 경우
bluxClient.sendEvent(
  new AddOrderEvent({
    orderId: "ORDER_ID",
    paidAmount: 1200,
    orderAmount: 2000,
    items: [
      {
        id: "ITEM_ID_1",
        price: 1000,
        quantity: 1,
      },
      {
        id: "ITEM_ID_2",
        price: 2000,
        quantity: 2,
      },
    ],
  }),
);
```

## 常见问题

### @blux\.ai/web-sdk 是什么？

官方 Blux JavaScript 浏览器客户端库

### 如何安装 @blux\.ai/web-sdk？

在项目目录运行 npm install @blux\.ai/web-sdk，或使用 pnpm add / yarn add / bun add。

### @blux\.ai/web-sdk 支持 TypeScript 吗？

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

### @blux\.ai/web-sdk 支持 ESM 还是 CommonJS？

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

### @blux\.ai/web-sdk 可以商用吗？

@blux\.ai/web-sdk 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @blux\.ai/web-sdk 的下载量有多少？

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

### @blux\.ai/web-sdk 还在维护吗？

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