@cloudbase/wx-cloud-client-sdk 1.7.2 → 1.8.1

package/README.md

@@ -1,9 +1,153 @@
-# 微信云开发客户端 SDK
+# @cloudbase/wx-cloud-client-sdk
 
-## 使用
+微信云开发客户端 SDK，提供数据模型、MySQL/RDB 数据库和用户认证能力。
 
-[初始化 SDK](https://docs.cloudbase.net/model/init-sdk)
+## 安装
+
+```bash
+npm install @cloudbase/wx-cloud-client-sdk
+```
+
+## 快速开始
+
+### 初始化
+
+```javascript
+import { init } from '@cloudbase/wx-cloud-client-sdk';
+
+// 使用微信云开发实例初始化
+const client = init(wx.cloud, {
+  envId: 'your-env-id',
+});
+```
+
+### 数据模型操作
+
+```javascript
+// 创建数据
+const { data } = await client.models.yourModel.create({
+  data: { title: 'Hello', content: 'World' },
+});
+
+// 查询列表
+const {
+  data: { records, total },
+} = await client.models.yourModel.list({
+  filter: { where: { title: { $eq: 'Hello' } } },
+  pageSize: 10,
+  pageNumber: 1,
+  getCount: true,
+});
+
+// 更新数据
+await client.models.yourModel.update({
+  data: { title: 'Updated' },
+  filter: { where: { _id: { $eq: 'record-id' } } },
+});
+
+// 删除数据
+await client.models.yourModel.delete({
+  filter: { where: { _id: { $eq: 'record-id' } } },
+});
+```
+
+### MySQL/RDB 数据库
+
+```javascript
+// 获取数据库客户端
+const mysql = client.mysql({ database: 'your-database' });
+// 或使用别名
+const rdb = client.rdb({ database: 'your-database' });
+```
+
+#### 查询数据
+
+```javascript
+// 查询所有字段
+const users = await mysql.from('users').select('*');
+
+// 查询指定字段
+const users = await mysql.from('users').select('id, name, email');
+
+// 条件查询
+const activeUsers = await mysql.from('users').select('*').eq('status', 'active');
+
+// 多条件查询
+const result = await mysql
+  .from('users')
+  .select('*')
+  .eq('status', 'active')
+  .gte('age', 18)
+  .order('created_at', { ascending: false })
+  .limit(10);
+```
+
+#### 插入数据
+
+```javascript
+// 插入单条
+await mysql.from('users').insert({ name: 'test', email: 'test@example.com' });
+
+// 插入多条
+await mysql.from('users').insert([
+  { name: 'user1', email: 'user1@example.com' },
+  { name: 'user2', email: 'user2@example.com' },
+]);
+```
+
+#### 更新数据
+
+```javascript
+await mysql.from('users').update({ status: 'inactive' }).eq('id', 1);
+```
+
+#### 删除数据
+
+```javascript
+await mysql.from('users').delete().eq('id', 1);
+```
+
+### 用户认证
+
+```javascript
+// 获取 auth 实例
+const auth = client.auth;
+
+// 微信小程序 OpenID 静默登录，用户不存在则注册成外部注册用户
+await auth.signInWithOpenId();
+
+// 获取登录状态
+const { data } = auth.getSession();
+
+// 登出
+await auth.signOut();
+```
+
+## API
+
+### init(cloud, options)
+
+初始化 SDK（使用云函数调用）。
+
+| 参数          | 类型              | 必填 | 说明           |
+| ------------- | ----------------- | ---- | -------------- |
+| cloud         | CloudBaseInstance | 是   | 微信云开发实例 |
+| options.envId | string            | 否   | 环境 ID        |
+
+### 数据模型方法
+
+- `create(params)` - 创建单条数据
+- `createMany(params)` - 批量创建数据
+- `update(params)` - 更新单条数据
+- `updateMany(params)` - 批量更新数据
+- `upsert(params)` - 创建或更新数据
+- `delete(params)` - 删除单条数据
+- `deleteMany(params)` - 批量删除数据
+- `get(params)` - 获取单条数据
+- `list(params)` - 获取数据列表
+- `runSQLTemplate(params)` - 执行 SQL 模板
 
 ## 参考文档
 
-[类型声明](https://docs.cloudbase.net/model/sdk-reference/globals)
+- [初始化 SDK](https://docs.cloudbase.net/model/init-sdk)
+- [类型声明](https://docs.cloudbase.net/model/sdk-reference/globals)

package/lib/api/datasouce-caller.d.ts

@@ -6,5 +6,5 @@ export declare const enum EQUERY_PARAM_TYPE {
     OBJECT = "OBJECT",
     STRING = "STRING"
 }
-export declare const callDataSource: ({ dataSourceName, methodName, params, realMethodName, callFunction, envType, mode, }: CallDataSourceParams) => Promise<MethodResponse<any>>;
-export declare const runMysqlCommand: ({ sql, params, config, callFunction, unsafe }: RunMysqlCommandParams) => Promise<MethodResponse<any>>;
+export declare const callDataSource: ({ dataSourceName, methodName, params, realMethodName, callFunction, envType, mode, cloud, }: CallDataSourceParams) => Promise<MethodResponse<any>>;
+export declare const runMysqlCommand: ({ sql, params, config, callFunction, unsafe, cloud, }: RunMysqlCommandParams) => Promise<MethodResponse<any>>;

package/lib/auth/index.d.ts

@@ -0,0 +1,4 @@
+import { CloudBaseInstance, Auth } from '../types';
+export declare const generateAuthClient: (cloud: CloudBaseInstance, options?: {
+    envId?: string;
+}) => Auth;

package/lib/index.d.ts

@@ -2,6 +2,7 @@ import { CloudBaseInstance, ExtendedCloudBaseInstance, IMySqlOptions, OrmClient
 import { generateHTTPClient } from './orm/http-orm-client';
 import { MySqlClient } from './db/mysql';
 import { Fetch } from './db/postgrest/types';
+export { getAccessToken } from './utils';
 export declare function initHTTPOverCallFunction(cloud: CloudBaseInstance, options?: {
     envId?: string;
     baseUrl?: string;
@@ -22,6 +23,7 @@ declare const _default: {
     init: typeof init;
     generateHTTPClient: (callFunction: import("./types").CallFunction, fetch: (options: import("@cloudbase/adapter-interface").IFetchOptions) => any, baseUrl: string, options?: {
         sqlBaseUrl?: string | undefined;
+        cloud?: CloudBaseInstance | undefined;
     } | undefined) => OrmClient;
     generateMySQLClient: typeof generateMySQLClient;
 };

package/lib/orm/http-orm-client.d.ts

@@ -1,4 +1,4 @@
-import { OrmClient, CallFunction, ModelFetch } from '../types';
+import { OrmClient, CallFunction, ModelFetch, CloudBaseInstance } from '../types';
 export declare const enum EQUERY_PARAM_TYPE {
     ARRAY = "ARRAY",
     BOOLEAN = "BOOLEAN",
@@ -8,4 +8,5 @@ export declare const enum EQUERY_PARAM_TYPE {
 }
 export declare const generateHTTPClient: (callFunction: CallFunction, fetch: ModelFetch, baseUrl: string, options?: {
     sqlBaseUrl?: string;
+    cloud?: CloudBaseInstance;
 }) => OrmClient;

package/lib/orm/orm-client.d.ts

@@ -1,3 +1,3 @@
-import { OrmClient, CallFunction } from '../types';
-export declare const generateClientByDataSourceName: (dataSourceName: string, callFunction: CallFunction) => OrmClient;
-export declare const generateClient: (callFunction: CallFunction) => OrmClient;
+import { OrmClient, CallFunction, CloudBaseInstance } from '../types';
+export declare const generateClientByDataSourceName: (dataSourceName: string, callFunction: CallFunction, cloud?: CloudBaseInstance) => OrmClient;
+export declare const generateClient: (callFunction: CallFunction, cloud?: CloudBaseInstance) => OrmClient;

package/lib/orm/rawQueryClient.d.ts

@@ -1,2 +1,2 @@
-import type { CallFunction, OrmRawQueryClient } from '../types';
-export declare const createRawQueryClient: (callFunction: CallFunction) => OrmRawQueryClient;
+import type { CallFunction, CloudBaseInstance, OrmRawQueryClient } from '../types';
+export declare const createRawQueryClient: (callFunction: CallFunction, cloud?: CloudBaseInstance) => OrmRawQueryClient;

package/lib/types/index.d.ts

@@ -1,5 +1,6 @@
 import { SDKRequestInterface } from '@cloudbase/adapter-interface';
 import { MySqlClient } from '../db/mysql';
+import { Auth as AuthInstance } from '@cloudbase/auth';
 /**
  * 基础 Model 类型定义
  */
@@ -690,6 +691,10 @@ export interface CallDataSourceParams {
      * @deprecated 使用 dataSourceName 替代。
      */
     mode?: string;
+    /**
+     * 云实例，用于执行云函数调用。
+     */
+    cloud?: CloudBaseInstance;
 }
 /**
  * 调用runMySQLCoommand 参数的结构定义，用于封装调用云函数时所需的参数。
@@ -701,6 +706,7 @@ export interface RunMysqlCommandParams {
     callFunction: CallFunction;
     config?: any;
     unsafe?: boolean;
+    cloud?: CloudBaseInstance;
 }
 /**
  * 云函数调用接口，包含调用函数和认证信息。
@@ -711,6 +717,12 @@ export type CloudBaseInstance = {
     auth: any;
 };
 export type IMySqlClient = (options?: IMySqlOptions) => MySqlClient;
+export interface Auth {
+    signInWithOpenId: AuthInstance['signInWithOpenId'];
+    getUser: AuthInstance['getUser'];
+    getSession: AuthInstance['getSession'];
+    refreshSession: AuthInstance['refreshSession'];
+}
 /**
  * 扩展的云实例接口，扩展了云函数调用接口并包含ORM客户端。
  * @hidden
@@ -719,6 +731,7 @@ export interface ExtendedCloudBaseInstance extends CloudBaseInstance {
     models: OrmClient & OrmRawQueryClient;
     mysql: IMySqlClient;
     rdb: IMySqlClient;
+    auth: Auth;
 }
 /**
  * 云函数调用方法定义。

package/lib/utils.d.ts

@@ -1,3 +1,4 @@
+import { CloudBaseInstance } from './types';
 /**
  * 获取全局对象 window
  *  小程序中可用, 但小程序中对象信息残缺, 无法访问 navigator 对象, ua 信息也无意义
@@ -9,3 +10,4 @@ export declare function getReferrer(): any;
 export declare function getUserAgent(): any;
 export declare const VERSION: string | undefined;
 export declare function getRandomString(): string;
+export declare const getAccessToken: (cloud?: CloudBaseInstance) => Promise<string>;