@lovrabet/sdk 1.3.8 → 1.4.1

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

@@ -0,0 +1,31 @@
+import type { HttpClient } from "../http/http-client";
+/**
+ * BFF 客户端请求参数
+ */
+export interface ClientAkBffExecuteRequest {
+    /** 脚本名称（endpoint 函数名） */
+    scriptName: string;
+    /** 请求体参数（可选），序列化为 JSON 作为 POST body */
+    params?: Record<string, any>;
+    /** Fetch 请求选项（可选） */
+    options?: RequestInit;
+}
+/**
+ * Client AK BFF 客户端 ——「执行 BFF 独立端点」（client-ak 模式）。
+ *
+ * **与自定义 SQL 无关**（SQL 见 `ClientAkSqlClient` / `client.sql.execute` → `POST /client/sql/execute`）。
+ *
+ * 与服务端约定一致（路径中拼写为 **excute**，非 execute）：
+ * `POST /client/bff/excute/{appCode}/{scriptName}`
+ * - Header：`X-User-AK`、`Content-Type: application/json`（由 HttpClient 注入）
+ * - Body：业务 JSON，例如 `{ "testCase": "basic_insert" }` → 对应本类 `params`
+ *
+ * 示例：`appCode=app-cf50ad43`，`scriptName=sqlTest` →
+ * `POST .../client/bff/excute/app-cf50ad43/sqlTest`，body `{ "testCase": "basic_insert" }`。
+ */
+export declare class ClientAkBffClient {
+    private httpClient;
+    private appCode;
+    constructor(httpClient: HttpClient, appCode: string);
+    execute<T = any>(request: ClientAkBffExecuteRequest): Promise<T>;
+}

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

@@ -0,0 +1,19 @@
+import type { HttpClient } from "../http/http-client";
+import type { SqlExecuteResult } from "./types";
+/**
+ * Client AK SQL 客户端 - 执行自定义 SQL 查询（client-ak 模式）
+ *
+ * 端点：`POST /client/sql/execute`，请求体：`{ sqlCode, params? }`（与运行态技术文档 curl 一致）。
+ * 鉴权：X-User-AK（由 HttpClient 通过 AuthManager 自动注入）。
+ *
+ * BFF 调用请使用 `ClientAkBffClient`，勿与本类混用。
+ */
+export declare class ClientAkSqlClient {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    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/auth/auth-manager.d.ts

@@ -1,19 +1,15 @@
-import type { ClientConfig, AuthHeaders, AuthManager as IAuthManager } from '../types';
-export declare class AuthManager implements IAuthManager {
+import type { ClientConfig, AuthHeaders } from '../types';
+export declare class AuthManager {
     private config;
     private openApiAuth?;
     private cookieAuth?;
+    private clientAkAuth?;
     constructor(config: ClientConfig);
     private initAuthMethods;
     getAuthHeaders(appCode?: string, datasetCode?: string): Promise<AuthHeaders>;
     validateAuth(): Promise<boolean>;
-    /**
-     * Check if we're using cookie-based authentication
-     */
     isCookieAuth(): boolean;
-    /**
-     * Check if an explicit cookie string was provided (vs browser auto-cookie)
-     */
+    isClientAkAuth(): boolean;
     hasExplicitCookie(): boolean;
     setToken(token: string, timestamp?: number): void;
 }

package/dist/src/auth/client-ak-auth.d.ts

@@ -0,0 +1,13 @@
+import type { AuthHeaders } from '../types';
+/**
+ * Client AK 认证
+ *
+ * 使用 X-User-AK 请求头进行鉴权，无需签名。
+ * 适用于运行态 /client/ 接口。
+ */
+export declare class ClientAkAuth {
+    private accessKey;
+    constructor(accessKey: string);
+    getAuthHeaders(): Promise<AuthHeaders>;
+    isValid(): boolean;
+}

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

@@ -1,4 +1,5 @@
 export { AuthManager } from './auth-manager';
 export { OpenApiAuth } from './openapi-auth';
+export { ClientAkAuth } from './client-ak-auth';
 export type { AuthHeaders, OpenApiAuthConfig } from '../types';
 export { generateOpenApiToken, TokenGenerator, isTokenExpiring, getTokenRemainingTime, type GenerateTokenParams, type TokenResult } from './token-generator';

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

@@ -2,7 +2,9 @@ import type { ClientConfig, LovrabetClient as ILovrabetClient, Environment, Base
 import { ApiNamespace } from '../api';
 import { SqlClient } from '../api/sql-client';
 import { OpenApiSqlClient } from '../api/openapi-sql-client';
+import { ClientAkSqlClient } from '../api/client-ak-sql-client';
 import { BffClient } from '../api/bff-client';
+import { ClientAkBffClient } from '../api/client-ak-bff-client';
 import { UserClient } from '../api/user-client';
 /**
  * Lovrabet SDK 核心客户端类
@@ -34,11 +36,11 @@ export declare class LovrabetClient implements ILovrabetClient {
      * - OpenAPI 模式：使用 OpenApiSqlClient（/openapi/data/custom-sql）
      * - WebAPI 模式：使用 SqlClient（/api/custom/executeSql）
      */
-    readonly sql: SqlClient | OpenApiSqlClient;
+    readonly sql: SqlClient | OpenApiSqlClient | ClientAkSqlClient;
     /**
      * BFF 客户端 - 调用 Backend For Frontend 端点
      */
-    readonly bff: BffClient;
+    readonly bff: BffClient | ClientAkBffClient;
     /**
      * User 客户端 - 用户信息相关 API
      */
@@ -130,11 +132,10 @@ export declare class LovrabetClient implements ILovrabetClient {
     getModel(indexOrName: number | string): BaseModelMethods;
     /**
      * 检查当前是否为 OpenAPI 模式
-     * 为什么提供这个方法：
-     * 1. 让用户能够了解当前使用的认证和API模式
-     * 2. 支持根据模式执行不同的业务逻辑
-     * 3. 便于调试和排查问题
-     * 4. 与 BaseModel 的逻辑保持一致
      */
     isOpenApiMode(): boolean;
+    /**
+     * 解析鉴权模式。无 authMode → cookie；有则严格遵循。
+     */
+    private resolveAuthMode;
 }

package/dist/src/models/abstract-base-model.d.ts

@@ -36,6 +36,7 @@ export declare abstract class AbstractBaseModel implements BaseModelMethods {
         id: string | number;
     }): Promise<T>;
     create<T = any>(data: Record<string, any>): Promise<T>;
+    batchCreate<T = any>(items: Record<string, any>[]): Promise<T>;
     /**
      * 更新记录，支持单条和批量。
      *

package/dist/src/models/client-ak-model.d.ts

@@ -0,0 +1,14 @@
+import { AbstractBaseModel } from './abstract-base-model';
+import type { SortList } from '../types';
+/**
+ * Client AK 模型实现
+ *
+ * 路由到 /client/{appCode}/{datasetCode}/ 前缀，
+ * 鉴权使用 X-User-AK（由 AuthManager 在 HttpClient 层自动注入）。
+ *
+ * 请求体策略：直接透传（不包装 paramMap）。
+ */
+export declare class ClientAkModel extends AbstractBaseModel {
+    protected getApiPath(sdkMethod: string): string;
+    protected buildRequestBody(method: string, data: any, sortList?: SortList): any;
+}

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

@@ -1,6 +1,7 @@
 export { AbstractBaseModel } from './abstract-base-model';
 export { OpenApiModel } from './openapi-model';
 export { WebApiModel } from './webapi-model';
+export { ClientAkModel } from './client-ak-model';
 export { ModelFactory } from './model-factory';
 export { ModelManager } from './model-manager';
 export type { BaseModelMethods, ModelManager as IModelManager } from '../types';

package/dist/src/models/model-factory.d.ts

@@ -2,23 +2,15 @@ import type { BaseModelMethods, ClientConfig, ModelConfig } from '../types';
 import type { HttpClient } from '../http/http-client';
 /**
  * 模型工厂类
- * 根据配置决定创建 OpenAPI 或 WebAPI 模型实例
+ * 根据配置决定创建 OpenAPI、WebAPI 或 ClientAK 模型实例
+ *
+ * 规则：无 authMode → cookie(即 webapi)；有 authMode 则严格遵循。
  */
 export declare class ModelFactory {
-    /**
-     * 创建模型实例
-     * @param datasetCode 数据集代码（作为模型标识）
-     * @param httpClient HTTP 客户端
-     * @param globalConfig 全局配置
-     * @param modelConfig 模型配置（直接传入，不再从 globalConfig 中查找）
-     */
     static createModel(datasetCode: string, httpClient: HttpClient, globalConfig: ClientConfig, modelConfig: ModelConfig): BaseModelMethods;
     /**
-     * 判断是否为 OpenAPI 模式
-     */
-    private static isOpenApiMode;
-    /**
-     * 获取当前模式名称（用于调试）
+     * 无 authMode → cookie(webapi)；有 authMode 则严格遵循
      */
-    static getModeName(config: ClientConfig): 'OpenAPI' | 'WebAPI';
+    private static resolveAuthMode;
+    static getModeName(config: ClientConfig): 'OpenAPI' | 'WebAPI' | 'ClientAK';
 }

package/dist/src/models/openapi-model.d.ts

@@ -12,7 +12,7 @@ export declare class OpenApiModel extends AbstractBaseModel {
     /**
      * OpenAPI 模式的请求体构建策略
      * 认证信息（token、timeStamp）由 HttpClient 自动添加到请求头（Header）中
-     * 请求体格式：{ appCode, datasetCode, paramMap }
+     * 请求体格式：{ appCode, datasetCode, paramMap }；batchCreate 为数组体，使用 paramList（与 paramMap 互斥语义）
      */
     protected buildRequestBody(method: string, data: any, sortList?: SortList): any;
     /**

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

@@ -109,8 +109,9 @@ export interface ListResponse<T> {
  * - $contain: 包含（模糊匹配）
  * - $startWith: 以...开头
  * - $endWith: 以...结尾
+ * - $notNull: 非空判断
  */
-export type ConditionOperator = "$eq" | "$ne" | "$gte" | "$gteq" | "$lte" | "$lteq" | "$in" | "$contain" | "$startWith" | "$endWith";
+export type ConditionOperator = "$eq" | "$ne" | "$gte" | "$gteq" | "$lte" | "$lteq" | "$in" | "$contain" | "$startWith" | "$endWith" | "$notNull";
 /**
  * 字段条件类型
  * @description 单个字段的查询条件
@@ -124,6 +125,8 @@ export type ConditionOperator = "$eq" | "$ne" | "$gte" | "$gteq" | "$lte" | "$lt
  * { country: { $in: ['中国', '美国', '日本'] } }
  * // 模糊匹配
  * { name: { $contain: 'hello' } }
+ * // 非空判断
+ * { app_code: { $notNull: true } }
  * ```
  */
 export type FieldCondition = {
@@ -383,6 +386,13 @@ export interface ModelsConfig {
  * };
  * ```
  */
+/**
+ * 鉴权模式类型
+ * - "openapi": OpenAPI 签名模式（accessKey + secretKey），走 /openapi/ 前缀
+ * - "client-ak": Client AK 模式（仅 accessKey），走 /client/ 前缀，X-User-AK 鉴权
+ * - "cookie": Cookie 模式，走 /api/ 前缀
+ */
+export type AuthMode = "openapi" | "client-ak" | "cookie";
 export interface ClientConfig {
     /** 应用代码，用于标识不同的应用 */
     appCode?: string;
@@ -416,6 +426,8 @@ export interface ClientConfig {
     cookie?: string;
     /** 是否需要认证，默认为 true */
     requiresAuth?: boolean;
+    /** 显式声明鉴权模式，优先于字段组合推断。向下兼容：未设置时保持旧推断逻辑 */
+    authMode?: AuthMode;
     /**
      * 模型配置
      * - 数组格式（推荐）：直接使用 datasetCode 访问
@@ -522,6 +534,13 @@ export interface BaseModelMethods {
      * @returns 返回创建后的数据
      */
     create<T = any>(data: Record<string, any>): Promise<T>;
+    /**
+     * 批量创建数据
+     * @template T 返回数据的类型
+     * @param items 要创建的数据对象数组，最多 1000 条
+     * @returns 返回创建后的数据
+     */
+    batchCreate<T = any>(items: Record<string, any>[]): Promise<T>;
     /**
      * 更新数据，支持单条和批量
      * @template T 返回数据的类型

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/sdk",
-  "version": "1.3.8",
+  "version": "1.4.1",
   "license": "SEE LICENSE IN LICENSE",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -47,4 +47,4 @@
   "peerDependencies": {
     "typescript": "^5"
   }
-}
+}