跳到主要内容

TypeScript SDK 介绍

Lovrabet TypeScript SDK 是一个轻量级的 JavaScript/TypeScript SDK，为 Web 端和 Node.js 端提供便捷的 Lovrabet 平台数据访问能力。

💡 技术特点​

使用 TypeScript 编写并编译为 JavaScript，可同时在浏览器和 Node.js 环境运行：

🌐 Web 端​

支持所有主流前端框架：

  • React - Create React App、Vite、Remix 等
  • Vue - Vue 3、Vite、Vue CLI 等
  • Angular - Angular 14+ 等
  • 其他 - Svelte、Solid.js、原生 JavaScript 等

🖥️ Node.js 端​

支持所有主流 Node.js 框架和运行时：

  • SSR 框架 - Next.js、Nuxt.js、Astro 等
  • 后端框架 - Express、Koa、Fastify、Nest.js、Hono 等
  • 运行时 - Node.js 18+、Bun、Deno 等

📱 跨端支持​

  • 小程序 - 微信小程序、支付宝小程序、uni-app 等
  • 桌面应用 - Electron、Tauri 等

🎯 核心特性​

  • 🚀 极简易用 - 5 分钟快速上手，API 设计简洁直观
  • 🔧 配置灵活 - 支持多种配置方式，满足不同项目需求
  • 🔐 多重认证 - 支持用户 Token、OpenAPI 密钥、Cookie 等认证方式
  • 📊 完整 CRUD - 提供增删改查等完整的数据操作功能
  • 🎯 TypeScript 原生支持 - 完整的类型定义，享受类型安全开发
  • ⚡ 高性能 - 内置缓存、请求去重、批量处理等优化功能
  • 🏷️ 模型别名 v1.2.0+ - 支持友好的模型别名访问方式

🛠️ 主要功能​

数据操作​

  • 列表查询（支持分页、筛选、排序）
  • 单条记录获取
  • 创建新记录
  • 更新现有记录
  • 删除记录

高级查询​

  • Filter 高级查询 - 复杂条件筛选、字段选择、多字段排序
  • SQL 自定义查询 v1.1.19+ - 执行已注册的自定义 SQL
  • BFF 端点调用 v1.2.0+ - 调用后端函数

高级特性​

  • 多项目支持
  • 请求缓存和优化
  • 错误处理和重试
  • 性能监控

📖 文档导航​

🚀 快速开始​

5 分钟上手指南，包含安装、配置和基础使用

🔧 配置详解​

详细介绍各种配置方式和多项目支持

🔐 认证配置​

用户 Token、OpenAPI AcessKey、Cookies 等多种认证方式的配置

📊 API 使用指南​

CRUD 操作、查询参数、批量处理等核心 API 使用

🎯 TypeScript 支持​

类型定义、类型安全的 API 调用和最佳实践

🚀 高级功能​

多项目管理、性能优化、错误处理等高级特性

🛠️ 实际应用示例​

React、Vue、Node.js 等不同环境的完整集成示例

🔧 故障排查​

常见问题诊断、调试技巧和解决方案

🚀 快速预览​

安装​

npm install @lovrabet/sdk

基础使用​

推荐方式

使用 Lovrabet CLI 可以一键生成配置，省去手动配置的麻烦。

import { registerModels, createClient } from "@lovrabet/sdk";

// 注册配置
registerModels({
  appCode: "your-app-code",
  models: [
    {
      datasetCode: "8d2dcbae08b54bdd84c00be558ed48df",
      tableName: "users",
      alias: "users",
    },
  ],
});

// 创建客户端
const client = createClient();

// 标准方式访问（推荐）
const users = await client.models.dataset_8d2dcbae08b54bdd84c00be558ed48df.filter();
const user = await client.models.dataset_8d2dcbae08b54bdd84c00be558ed48df.create({
  name: "John",
  email: "john@example.com",
});

模型访问方式 v1.2.0+​

SDK 支持两种访问方式，功能完全一致：

// 标准方式（推荐）- 使用 dataset_ 前缀 + datasetCode，全局唯一，AI 友好
const users = await client.models.dataset_8d2dcbae08b54bdd84c00be558ed48df.filter();

// 别名方式（语法糖）- 使用配置的 alias，方便人类阅读
const users = await client.models.users.filter();

💡 别名只是语法糖，内部仍使用 datasetCode 访问。推荐使用标准方式，AI 工具生成代码时能精确定位。

💡 设计理念​

Lovrabet TypeScript SDK 秉承以下设计原则：

  • 简单优先 - API 设计简洁，降低学习成本
  • 类型安全 - 完整的 TypeScript 支持，编译时错误检测
  • 性能优化 - 内置多种性能优化策略
  • 灵活配置 - 支持多种配置方式，适应不同项目需求
  • 开发者友好 - 详细的错误信息和调试工具

🔗 生态系统​

Lovrabet TypeScript SDK 是 Rabetbase 生态的重要组成部分：

  • Lovrabet CLI - 脚手架工具，自动生成 SDK 配置
  • Lovrabet Templates - 开箱即用的项目模板
  • OpenAPI - 丰富的后端数据服务

📞 获得帮助​

  • 📖 文档 - 查看详细的使用文档和示例
  • 💬 社区支持 - 加入开发者社区交流
  • 🐛 问题反馈 - 遇到 Bug 请及时反馈
  • 📧 技术支持 - 企业用户可获得专业技术支持

开始您的 Lovrabet TypeScript SDK 之旅！ 🎉