@lovrabet/sdk 1.2.8 → 1.2.9-beta.0

package/dist/src/api/bff-client.d.ts

@@ -0,0 +1,44 @@
+import type { HttpClient } from "../http/http-client";
+import type { FxResult } from "./types";
+/**
+ * BFF 客户端 - 调用 Backend For Frontend 端点
+ *
+ * @example
+ * ```typescript
+ * // 无参数调用
+ * const result = await client.bff.execute('getBundleTemplates');
+ * if (result.success) {
+ *   console.log(result.data);
+ * }
+ *
+ * // 带参数调用
+ * const result = await client.bff.execute('calculatePrice', {
+ *   productId: '123',
+ *   quantity: 10
+ * });
+ *
+ * // 带类型提示
+ * interface BundleTemplate {
+ *   id: string;
+ *   name: string;
+ *   items: string[];
+ * }
+ * const result = await client.bff.execute<BundleTemplate>('getBundleTemplates');
+ * if (result.success && result.data) {
+ *   result.data.forEach(template => console.log(template.name));
+ * }
+ * ```
+ */
+export declare class BffClient {
+    private httpClient;
+    private appCode;
+    constructor(httpClient: HttpClient, appCode: string);
+    /**
+     * 调用 Backend For Frontend (BFF) 端点
+     *
+     * @param scriptName 脚本名称（endpoint 函数名）
+     * @param bodyParams 请求体参数（可选）
+     * @returns Function 执行结果（包含 success 和 data）
+     */
+    execute<T = any>(scriptName: string, bodyParams?: Record<string, any>): Promise<FxResult<T>>;
+}

package/dist/src/api/get-user-list.d.ts

@@ -1,10 +1,4 @@
 import type { HttpClient } from "../http";
+import type { User } from "./types";
 export declare function getUserList(httpClient: HttpClient): Promise<User[]>;
-export type User = {
-    code: string;
-    userName: string;
-    nickName?: string | null;
-    mobile: string;
-    email?: string | null;
-    avatar?: string | null;
-};
+export type { User };

package/dist/src/api/index.d.ts

@@ -1,54 +1,87 @@
 import type { HttpClient } from "../http/http-client";
-import type { SqlExecuteResult } from "./types";
+import { SqlClient } from "./sql-client";
+import { BffClient } from "./bff-client";
+import { UserClient } from "./user-client";
 /**
- * API 命名空间 - 管理通用 API 调用（SQL、Function 等）
+ * API 命名空间 - 别名入口
  *
- * 设计原则：
- * 1. 依赖注入 - 通过构造函数注入 HttpClient
- * 2. 类型安全 - 支持泛型，提供 TypeScript 类型推断
- * 3. 统一错误处理 - 成功返回数据，失败抛出 LovrabetError
- * 4. 风格一致 - 与 Model 的 getList/getOne 保持一致
+ * 推荐使用客户端方式：
+ * - SQL: `client.sql.execute()`
+ * - BFF: `client.bff.execute()`
+ * - User: `client.user.getList()`
+ *
+ * 此命名空间提供向后兼容的别名：
+ * - `client.api.sql()` → `client.sql.execute()`
+ * - `client.api.bff()` → `client.bff.execute()`
+ * - `client.api.getUserList()` → `client.user.getList()`
  */
 export declare class ApiNamespace {
     private httpClient;
-    constructor(httpClient: HttpClient);
+    private appCode;
+    constructor(httpClient: HttpClient, appCode: string);
+    /**
+     * SQL 客户端实例
+     */
+    private _sql?;
+    /**
+     * SQL 查询别名 - 推荐使用 `client.sql.execute()`
+     *
+     * @example
+     * ```typescript
+     * // 推荐用法
+     * const data = await client.sql.execute('fc8e7777-06e3847d');
+     *
+     * // 别名用法（兼容）
+     * const data = await client.api.sql('fc8e7777-06e3847d');
+     * ```
+     */
+    get sql(): SqlClient["execute"];
     /**
-     * 执行自定义 SQL 查询
+     * SQL 查询别名（旧名称）- 向后兼容
      *
-     * @param sqlCode SQL代码（字符串格式 "appCode-sqlId" 或数字ID）
-     * @param params SQL参数对象（可选）
-     * @returns SQL执行结果（包含 execSuccess 和 execResult）
+     * @deprecated 使用 `client.sql.execute()` 或 `client.api.sql()`
+     */
+    get executeSql(): SqlClient["execute"];
+    /**
+     * BFF 客户端实例
+     */
+    private _bff?;
+    /**
+     * BFF 查询别名 - 推荐使用 `client.bff.execute()`
      *
      * @example
      * ```typescript
-     * // 无参数查询
-     * const data = await client.api.executeSql('fc8e7777-06e3847d');
-     * if (data.execSuccess) {
-     *   const results = data.execResult;
-     *   results.forEach(item => console.log(item));
-     * }
-     *
-     * // 参数化查询
-     * const data = await client.api.executeSql('fc8e7777-xxxxx', {
-     *   userId: '123',
-     *   startDate: '2025-01-01'
-     * });
-     *
-     * // 带类型提示
-     * interface PageStat {
-     *   creation_date: string;
-     *   page_count: number;
-     * }
-     * const data = await client.api.executeSql<PageStat>('fc8e7777-06e3847d');
-     * if (data.execSuccess && data.execResult) {
-     *   data.execResult.forEach(stat => {
-     *     console.log(stat.creation_date, stat.page_count);
-     *   });
-     * }
+     * // 推荐用法
+     * const result = await client.bff.execute('getBundleTemplates');
+     *
+     * // 别名用法（兼容）
+     * const result = await client.api.bff('getBundleTemplates');
      * ```
      */
-    executeSql<T = Record<string, any>>(sqlCode: string | number, params?: Record<string, string | number>): Promise<SqlExecuteResult<T>>;
-    user: {
-        getList: () => Promise<import("./get-user-list").User[]>;
+    get bff(): BffClient["execute"];
+    /**
+     * User 客户端实例
+     */
+    private _user?;
+    /**
+     * User 查询别名 - 推荐使用 `client.user.getList()`
+     *
+     * @example
+     * ```typescript
+     * // 推荐用法
+     * const userList = await client.user.getList();
+     *
+     * // 别名用法（兼容）
+     * const userList = await client.api.getUserList();
+     * ```
+     */
+    get getUserList(): UserClient["getList"];
+    /**
+     * User 客户端别名 - 推荐使用 `client.user.getList()`
+     *
+     * @deprecated 使用 `client.user.getList()`
+     */
+    get user(): {
+        getList: UserClient["getList"];
     };
 }

package/dist/src/api/sql-client.d.ts

@@ -0,0 +1,45 @@
+import type { HttpClient } from "../http/http-client";
+import type { SqlExecuteResult } from "./types";
+/**
+ * SQL 客户端 - 执行自定义 SQL 查询
+ *
+ * @example
+ * ```typescript
+ * // 方式1：直接传参（推荐）
+ * const data = await client.sql.execute('fc8e7777-06e3847d', {
+ *   userId: '123',
+ *   startDate: '2025-01-01'
+ * });
+ *
+ * // 方式2：对象参数（兼容 customSql.execute）
+ * const data = await client.sql.execute({
+ *   sqlCode: 'fc8e7777-06e3847d',
+ *   params: { userId: '123' }
+ * });
+ *
+ * // 带类型提示
+ * interface PageStat {
+ *   creation_date: string;
+ *   page_count: number;
+ * }
+ * const data = await client.sql.execute<PageStat>('fc8e7777-06e3847d');
+ * ```
+ */
+export declare class SqlClient {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * 执行自定义 SQL 查询
+     *
+     * 支持两种调用方式：
+     * 1. execute(sqlCode, params) - 直接传参（推荐）
+     * 2. execute({ sqlCode, params }) - 对象参数（兼容 customSql.execute）
+     *
+     * @returns SQL执行结果（包含 execSuccess 和 execResult）
+     */
+    execute<T = Record<string, any>>(sqlCode: string | number, params?: Record<string, string | number>): Promise<SqlExecuteResult<T>>;
+    execute<T = Record<string, any>>(options: {
+        sqlCode: string | number;
+        params?: Record<string, string | number>;
+    }): Promise<SqlExecuteResult<T>>;
+}

package/dist/src/api/types.d.ts

@@ -16,3 +16,38 @@ export interface SqlExecuteResult<T = Record<string, any>> {
     /** SQL 查询结果数组 */
     execResult?: T[];
 }
+/**
+ * Backend Function (独立端点) 请求参数
+ */
+export interface FxRequest {
+    /** 请求体参数，由调用方传递任意 JSON 数据 */
+    [key: string]: any;
+}
+/**
+ * Backend Function (独立端点) 执行结果数据
+ */
+export interface FxResult<T = any> {
+    /** Function 执行是否成功 */
+    success: boolean;
+    /** Function 返回的业务数据 */
+    data?: T;
+    /** 错误消息（执行失败时） */
+    message?: string;
+}
+/**
+ * 用户信息
+ */
+export interface User {
+    /** 用户代码 */
+    code: string;
+    /** 用户名 */
+    userName: string;
+    /** 昵称 */
+    nickName?: string | null;
+    /** 手机号 */
+    mobile: string;
+    /** 邮箱 */
+    email?: string | null;
+    /** 头像 */
+    avatar?: string | null;
+}

package/dist/src/api/user-client.d.ts

@@ -0,0 +1,20 @@
+import type { HttpClient } from "../http/http-client";
+/**
+ * User 客户端 - 用户信息相关 API
+ *
+ * @example
+ * ```typescript
+ * const userList = await client.user.getList();
+ * console.log(userList);
+ * ```
+ */
+export declare class UserClient {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * 获取用户列表
+     *
+     * @returns 用户列表数组
+     */
+    getList: () => Promise<import("./types").User[]>;
+}

package/dist/src/client/client.d.ts

@@ -1,5 +1,8 @@
 import type { ClientConfig, LovrabetClient as ILovrabetClient, Environment, BaseModelMethods } from '../types';
 import { ApiNamespace } from '../api';
+import { SqlClient } from '../api/sql-client';
+import { BffClient } from '../api/bff-client';
+import { UserClient } from '../api/user-client';
 /**
  * Lovrabet SDK 核心客户端类
  *
@@ -25,7 +28,24 @@ export declare class LovrabetClient implements ILovrabetClient {
         [modelName: string]: BaseModelMethods;
     };
     /**
-     * API 命名空间 - 提供通用 API 调用（SQL、Function 等）
+     * SQL 客户端 - 执行自定义 SQL 查询
+     */
+    readonly sql: SqlClient;
+    /**
+     * BFF 客户端 - 调用 Backend For Frontend 端点
+     */
+    readonly bff: BffClient;
+    /**
+     * User 客户端 - 用户信息相关 API
+     */
+    readonly user: UserClient;
+    /**
+     * API 命名空间 - 别名入口（向后兼容）
+     *
+     * 推荐使用命名空间方式：
+     * - `client.sql.execute()` 而非 `client.api.sql()`
+     * - `client.bff.execute()` 而非 `client.api.bff()`
+     * - `client.user.getList()` 而非 `client.api.getUserList()`
      */
     readonly api: ApiNamespace;
     constructor(config: ClientConfig);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/sdk",
-  "version": "1.2.8",
+  "version": "1.2.9-beta.0",
   "license": "SEE LICENSE IN LICENSE",
   "main": "dist/index.js",
   "module": "dist/index.js",