aipexbase-js 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,398 @@
+# AipexBase JS SDK
+
+一个简洁易用的 BaaS (Backend as a Service) JavaScript SDK，提供认证、数据库操作和自定义 API 调用功能。
+
+## 特性
+
+- 🔐 **用户认证** - 登录、注册、登出和用户信息管理
+- 📊 **数据库操作** - 支持链式调用的 CRUD 操作
+- 🔌 **自定义 API** - 灵活的 API 调用接口
+- 🎯 **链式调用** - 优雅的 API 设计，支持流式编程
+- 🔑 **自动 Token 管理** - 自动存储和管理用户认证 Token
+- 📦 **多格式支持** - 同时支持 CommonJS 和 ES Module
+
+## 安装
+
+```bash
+npm install aipexbase-js
+```
+
+## 快速开始
+
+### 初始化客户端
+
+```javascript
+import { createClient } from 'aipexbase-js';
+
+const client = createClient({
+  baseUrl: 'https://your-api-endpoint.com',
+  apiKey: 'your-api-key'
+});
+```
+
+## API 文档
+
+### 认证模块 (Auth)
+
+#### 登录
+
+支持用户名、手机号或邮箱登录：
+
+```javascript
+// 使用手机号登录
+const result = await client.auth.login({
+  phone: '13800138000',
+  password: 'your-password'
+});
+
+// 使用邮箱登录
+const result = await client.auth.login({
+  email: 'user@example.com',
+  password: 'your-password'
+});
+
+// 使用用户名登录
+const result = await client.auth.login({
+  user_name: 'username',
+  password: 'your-password'
+});
+```
+
+#### 注册
+
+```javascript
+const result = await client.auth.register({
+  user_name: 'newuser',
+  phone: '13800138000',
+  email: 'user@example.com',
+  password: 'your-password',
+  // 其他自定义字段.这里与AipexBase管理后台是否开发登录有关联。
+});
+```
+
+#### 获取用户信息
+
+```javascript
+const user = await client.auth.getUser();
+```
+
+#### 登出
+
+```javascript
+await client.auth.logout();
+```
+
+#### 手动设置 Token
+
+```javascript
+client.setToken('your-auth-token');
+```
+
+### 数据库模块 (DB)
+
+数据库模块提供了丰富的链式查询接口。
+
+#### 查询数据
+
+##### 列表查询
+
+```javascript
+// 简单查询
+const result = await client.db
+  .from('users')
+  .list();
+
+// 带过滤条件
+const result = await client.db
+  .from('users')
+  .list()
+  .eq('status', 'active')
+  .gt('age', 18);
+
+// 排序
+const result = await client.db
+  .from('users')
+  .list()
+  .order('created_at', 'desc');
+```
+
+##### 分页查询
+
+```javascript
+const result = await client.db
+  .from('users')
+  .page()
+  .page(1, 20)  // 页码，每页数量
+  .eq('status', 'active');
+```
+
+##### 获取单条数据
+
+```javascript
+const result = await client.db
+  .from('users')
+  .get()
+  .eq('id', 123);
+```
+
+#### 过滤条件
+
+支持多种过滤操作符：
+
+```javascript
+// 等于
+.eq('field', value)
+
+// 不等于
+.neq('field', value)
+
+// 大于
+.gt('field', value)
+
+// 大于等于
+.gte('field', value)
+
+// 小于
+.lt('field', value)
+
+// 小于等于
+.lte('field', value)
+
+// 在范围内
+.in('field', [value1, value2, value3])
+
+// 在区间内
+.between('field', [min, max])
+```
+
+#### OR 条件查询
+
+```javascript
+const result = await client.db
+  .from('users')
+  .list()
+  .eq('status', 'active')
+  .or((q) => {
+    q.eq('role', 'admin')
+     .eq('role', 'moderator');
+  });
+```
+
+#### 排序
+
+```javascript
+// 升序
+.order('created_at', 'asc')
+
+// 降序
+.order('created_at', 'desc')
+
+// 对象形式
+.order('created_at', { ascending: true })
+.order('created_at', { direction: 'desc' })
+```
+
+#### 插入数据
+
+```javascript
+const result = await client.db
+  .from('users')
+  .insert()
+  .values({
+    name: 'John Doe',
+    email: 'john@example.com',
+    age: 25
+  });
+```
+
+#### 更新数据
+
+```javascript
+const result = await client.db
+  .from('users')
+  .update()
+  .set({
+    status: 'inactive'
+  })
+  .eq('id', 123);
+```
+
+#### 删除数据
+
+```javascript
+const result = await client.db
+  .from('users')
+  .delete()
+  .eq('id', 123);
+```
+
+### API 模块
+
+用于调用自定义 API 接口。
+
+#### 基本调用
+
+```javascript
+const result = await client.api
+  .call('yourApiName')
+  .param('key1', 'value1')
+  .param('key2', 'value2');
+```
+
+#### 批量设置参数
+
+```javascript
+const result = await client.api
+  .call('yourApiName')
+  .params({
+    key1: 'value1',
+    key2: 'value2',
+    key3: 'value3'
+  });
+```
+
+#### 自定义请求头
+
+```javascript
+const result = await client.api
+  .call('yourApiName')
+  .header('X-Custom-Header', 'value')
+  .params({ data: 'value' });
+
+// 批量设置请求头
+const result = await client.api
+  .call('yourApiName')
+  .headers({
+    'X-Custom-Header-1': 'value1',
+    'X-Custom-Header-2': 'value2'
+  })
+  .params({ data: 'value' });
+```
+
+## 完整示例
+
+```javascript
+import { createClient } from 'aipexbase-js';
+
+// 初始化客户端
+const client = createClient({
+  baseUrl: 'https://your-api-endpoint.com',
+  apiKey: 'your-api-key'
+});
+
+// 用户登录
+async function login() {
+  try {
+    const result = await client.auth.login({
+      phone: '13800138000',
+      password: 'password123'
+    });
+    
+    if (result.success) {
+      console.log('登录成功！');
+    }
+  } catch (error) {
+    console.error('登录失败:', error);
+  }
+}
+
+// 查询用户列表
+async function getUserList() {
+  try {
+    const result = await client.db
+      .from('users')
+      .page()
+      .page(1, 20)
+      .eq('status', 'active')
+      .gte('age', 18)
+      .order('created_at', 'desc');
+    
+    console.log('用户列表:', result);
+  } catch (error) {
+    console.error('查询失败:', error);
+  }
+}
+
+// 创建新用户
+async function createUser() {
+  try {
+    const result = await client.db
+      .from('users')
+      .insert()
+      .values({
+        name: 'John Doe',
+        email: 'john@example.com',
+        age: 25,
+        status: 'active'
+      });
+    
+    console.log('用户创建成功:', result);
+  } catch (error) {
+    console.error('创建失败:', error);
+  }
+}
+
+// 调用自定义 API
+async function callCustomApi() {
+  try {
+    const result = await client.api
+      .call('sendEmail')
+      .params({
+        to: 'user@example.com',
+        subject: 'Hello',
+        body: 'Welcome to our service!'
+      });
+    
+    console.log('API 调用成功:', result);
+  } catch (error) {
+    console.error('API 调用失败:', error);
+  }
+}
+```
+
+## 开发
+
+### 本地开发
+
+```bash
+# 安装依赖
+npm install
+
+# 构建项目
+npm run build
+```
+
+### 项目结构
+
+```
+aipexbase-js/
+├── src/
+│   ├── client.js          # 核心客户端
+│   ├── index.js           # 入口文件
+│   └── modules/
+│       ├── auth.js        # 认证模块
+│       ├── db.js          # 数据库模块
+│       ├── api.js         # API 模块
+│       └── ai.js          # AI 模块（开发中）
+├── dist/                  # 构建输出
+│   ├── index.cjs.js      # CommonJS 格式
+│   └── index.esm.js      # ES Module 格式
+├── package.json
+├── rollup.config.mjs
+└── README.md
+```
+
+## 技术栈
+
+- **构建工具**: Rollup
+- **模块格式**: CommonJS & ES Module
+- **代码压缩**: Terser
+
+## License
+
+ISC
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aipexbase-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",