# @base44/sdk 中文文档

规范地址：https://npmcn.com/package/%40base44/sdk/

版本：0\.8\.59
npm 元数据更新时间：2026-11-04T10:49:32.028Z
中文译文更新时间：2026-11-07T17:32:46.782Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40base44/sdk
原文对照：https://npmcn.com/package/%40base44/sdk/?lang=original
项目主页：https://github.com/base44/javascript-sdk/tree/main/packages/sdk#readme
源码仓库：https://github.com/base44/javascript-sdk

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

- 包体积（解压后）：425 kB，95 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2025-02-25T18:35:12.074Z
- 最新版本发布：2026-11-04T10:49:31.649Z
- 近 30 天下载量：32801463（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 58 个）

## 中文简介

基础44 API 的 JavaScript SDK

## 安装

```sh
npm install @base44/sdk
```

也可以使用：`pnpm add @base44/sdk`、`yarn add @base44/sdk`、`bun add @base44/sdk`

## README

# 基础44 JavaScript SDK

Base44 SDK提供JavaScript接口,用于在Base44平台上构建应用程序.

你可以用两种方式:

-   **Base44软件内部**:当 Base44 生成您的应用程序时,SDK已经设置并准备使用.
-   **外部应用程序**:使用SDK来构建自己的前端或后端,使用Base44作为后端服务.

## 安装

**Base44软件内部**: SDK已经可用. 无需安装.

**外部应用程序**: 通过 npm 安装 SDK :

```bash
npm install @base44/sdk
```

## 模块

SDK通过下列模块提供对 Base44 功能的访问:

-   **[`agents`](https://docs.base44.com/developers/references/sdk/docs/interfaces/agents)**:与AI代理进行互动并管理对话.
-   **[`analytics`](https://docs.base44.com/developers/references/sdk/docs/interfaces/analytics)**:在您的应用程序中跟踪自定义事件.
-   **[`app-logs`](https://docs.base44.com/developers/references/sdk/docs/interfaces/app-logs)**: 访问和查询应用程序日志.
-   **[`auth`](https://docs.base44.com/developers/references/sdk/docs/interfaces/auth)**: 管理用户认证,注册,和会话处理.
-   **[`connectors`](https://docs.base44.com/developers/references/sdk/docs/interfaces/connectors)**: 为第三方服务管理OAuth连接和访问符.
-   **[`entities`](https://docs.base44.com/developers/references/sdk/docs/interfaces/entities)**: 与您的应用程序使用 CRUD 操作的数据实体合作.
-   **[`functions`](https://docs.base44.com/developers/references/sdk/docs/interfaces/functions)**:执行后端功能.
-   **[`integrations`](https://docs.base44.com/developers/references/sdk/docs/type-aliases/integrations)**: 接入预建和第三方集成.
-   **[`payments`](https://docs.base44.com/developers/references/sdk/docs/interfaces/payments)**:嵌入式出票,查购,并按服务角色处理退款及订阅.

## 快速启动

你是如何开始的取决于你是在Base44生成的应用软件内工作,还是在自己建造.

### Base44软件内部

在 Base44 生成的应用程序中,客户端被预配置. 只需导入并使用 :

```typescript
import { base44 } from "@/api/base44Client";

// Create a new task
const newTask = await base44.entities.Task.create({
  title: "Complete project documentation",
  status: "pending",
  dueDate: "2024-12-31",
});

// Update the task
await base44.entities.Task.update(newTask.id, {
  status: "in-progress",
});

// List all tasks
const tasks = await base44.entities.Task.list();
```

### 外部应用程序

当使用Base44作为自己应用程序的后端时,安装了SDK并自己创建客户端:

```typescript
import { createClient } from "@base44/sdk";

// Create a client for your Base44 app
const base44 = createClient({
  appId: "your-app-id", // Find this in the Base44 editor URL
});

// Read public data
const products = await base44.entities.Products.list();

// Authenticate a user (token is automatically set)
await base44.auth.loginViaEmailPassword("user@example.com", "password");

// Access user's data
const userOrders = await base44.entities.Orders.list();
```

### 服务作用

默认情况下,客户端使用用户级权限进行操作,限制了对当前用户所能看到和做的事情的访问. 服务角色为后端操作提供更高的权限,并仅在Base44托管后端功能中提供. 外部后端不能使用服务角色权限.

```typescript
import { createClientFromRequest } from "npm:@base44/sdk";

Deno.serve(async (req) => {
  const base44 = createClientFromRequest(req);

  // Access all data with admin-level permissions
  const allOrders = await base44.asServiceRole.entities.Orders.list();

  return Response.json({ orders: allOrders });
});
```

## 学多点

用JavaScript SDK开始的最好方法是让Base44为您建立一个应用程序. 一旦有了应用程序,就可以探索生成的代码并用SDK进行实验,看看它在实践中是如何工作的. 也可以请Base44演示SDK的具体特征.

为了加深理解,请查看这些指南:

1.  [基础44客户端](https://docs.base44.com/developers/references/sdk/getting-started/client) - 在前端、后端和外部应用程序上下文中与客户端合作.
2.  [数据工作](https://docs.base44.com/developers/references/sdk/getting-started/work-with-data) - 创建、读取、更新和删除数据.
3.  [常见 SDK 模式](https://docs.base44.com/developers/references/sdk/getting-started/work-with-sdk) - 认证、整合、功能和错误处理.

欲了解完整的文件和API的参考资料,请访问 **[Base44 开发者文档](https://docs.base44.com/developers/home)**。 。 。 .

## 发展

### 构建 SDK

从源代码构建 SDK :

```bash
npm install
npm run build
```

### 运行测试

运行测试套件 :

```bash
# Run all tests
npm test

# Run unit tests only
npm run test:unit

# Run with coverage
npm run test:coverage
```

对于E2E测试,创建一个 `tests/.env` 文件为 :

```
BASE44_APP_ID=your_app_id
BASE44_AUTH_TOKEN=your_auth_token
```

### 生成文档

本地生成 API 文档 :

```bash
# Process and preview locally
npm run create-docs
cd docs
mintlify dev
```

## 常见问题

### @base44/sdk 是什么？

基础44 API 的 JavaScript SDK

### 如何安装 @base44/sdk？

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

### @base44/sdk 支持 TypeScript 吗？

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

### @base44/sdk 支持 ESM 还是 CommonJS？

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

### @base44/sdk 可以商用吗？

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

### @base44/sdk 的下载量有多少？

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

### @base44/sdk 还在维护吗？

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