@lovrabet/sdk 1.1.5 → 1.1.6

package/dist/src/auth/auth-manager.d.ts

@@ -1,12 +1,11 @@
 import type { ClientConfig, AuthHeaders, AuthManager as IAuthManager } from '../types';
 export declare class AuthManager implements IAuthManager {
     private config;
-    private userAuth?;
     private openApiAuth?;
     private cookieAuth?;
     constructor(config: ClientConfig);
     private initAuthMethods;
-    getAuthHeaders(): Promise<AuthHeaders>;
+    getAuthHeaders(appCode?: string, datasetCode?: string): Promise<AuthHeaders>;
     validateAuth(): Promise<boolean>;
     /**
      * Check if we're using cookie-based authentication

package/dist/src/auth/openapi-auth.d.ts

@@ -2,6 +2,7 @@ import type { OpenApiAuthConfig, AuthHeaders } from '../types';
 export declare class OpenApiAuth {
     private config;
     constructor(config: OpenApiAuthConfig);
-    getAuthHeaders(): Promise<AuthHeaders>;
-    private generateSignature;
+    getAuthHeaders(appCode: string, datasetCode: string): Promise<AuthHeaders>;
+    private generateToken;
+    private hmacSha256;
 }

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

@@ -74,4 +74,13 @@ export declare class LovrabetClient implements ILovrabetClient {
      * 3. 作为 models.xxx 语法糖的底层实现
      */
     getModel(indexOrName: number | string): import("../models/base-model").BaseModel;
+    /**
+     * 检查当前是否为 OpenAPI 模式
+     * 为什么提供这个方法：
+     * 1. 让用户能够了解当前使用的认证和API模式
+     * 2. 支持根据模式执行不同的业务逻辑
+     * 3. 便于调试和排查问题
+     * 4. 与 BaseModel 的逻辑保持一致
+     */
+    isOpenApiMode(): boolean;
 }

package/dist/src/config/constants.d.ts

@@ -67,7 +67,7 @@ export declare const ERROR_MESSAGES: {
  */
 export declare const API_PATHS: {
     /** 基础 API 路径模板 */
-    readonly BASE: "/api/{appCode}/{datasetId}";
+    readonly BASE: "/api/{appCode}/{datasetCode}";
     /** 列表查询路径 */
     readonly LIST: "";
     /** 单条记录路径 */

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

@@ -5,8 +5,10 @@ export declare class BaseModel implements BaseModelMethods {
     private httpClient;
     private config;
     private appCode;
+    private globalConfig;
     constructor(modelName: string, httpClient: HttpClient, globalConfig: ClientConfig);
     private resolveModelConfig;
+    private isOpenApiMode;
     private getApiPath;
     getList<T = any>(params?: ListParams): Promise<ListResponse<T>>;
     getOne<T = any>(id: string | number): Promise<T>;

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

@@ -11,7 +11,7 @@ export declare class ModelManager implements IModelManager {
     clearCache(): void;
     addModel(modelName: string, config: {
         tableName: string;
-        datasetId: string;
+        datasetCode: string;
     }): void;
     list(): string[];
     get(indexOrName: number | string): BaseModel;

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

@@ -47,8 +47,8 @@ export interface ListResponse<T> {
 export interface ModelConfig {
     /** 数据表名称 */
     tableName: string;
-    /** 数据集 ID */
-    datasetId: string;
+    /** 数据集代码 */
+    datasetCode: string;
 }
 /**
  * 模型配置集合接口
@@ -58,8 +58,8 @@ export interface ModelConfig {
  * const config: ModelsConfig = {
  *   appCode: 'my-app',
  *   models: {
- *     Users: { tableName: 'users', datasetId: 'user-dataset-id' },
- *     Posts: { tableName: 'posts', datasetId: 'post-dataset-id' }
+ *     Users: { tableName: 'users', datasetCode: 'user-dataset-code' },
+ *     Posts: { tableName: 'posts', datasetCode: 'post-dataset-code' }
  *   }
  * };
  * ```
@@ -206,7 +206,7 @@ export interface ModelManager {
      */
     addModel(modelName: string, config: {
         tableName: string;
-        datasetId: string;
+        datasetCode: string;
     }): void;
     /**
      * 获取所有可用模型列表
@@ -248,23 +248,19 @@ export interface AuthHeaders {
     /** 请求头键值对 */
     [key: string]: string;
 }
-/**
- * 用户 Token 认证配置
- * @description 用于 Bearer Token 认证方式
- */
-export interface UserAuthConfig {
-    /** 用户认证 Token */
-    token: string;
-}
 /**
  * OpenAPI 密钥认证配置
- * @description 用于签名认证方式
+ * @description 用于签名认证方式，支持两种模式：
+ * 1. Server 端：传入 accessKey，内部生成 token
+ * 2. Client 端：直接传入预计算的 token
  */
 export interface OpenApiAuthConfig {
-    /** API 访问密钥 */
-    accessKey: string;
-    /** API 密钥，用于计算签名 */
-    secretKey: string;
+    /** API 访问密钥（Server 端使用） */
+    accessKey?: string;
+    /** API 密钥，用于计算签名（可选，有默认值） */
+    secretKey?: string;
+    /** 预计算的 token（Client 端使用，避免在浏览器暴露 accessKey） */
+    token?: string;
 }
 /**
  * 认证管理器接口
@@ -284,9 +280,11 @@ export interface AuthManager {
     /**
      * 获取认证请求头
      * @description 根据当前配置的认证方式生成对应的请求头
+     * @param appCode 应用代码（OpenAPI 认证时必需）
+     * @param datasetCode 数据集代码（OpenAPI 认证时必需）
      * @returns 包含认证信息的请求头对象
      */
-    getAuthHeaders(): Promise<AuthHeaders>;
+    getAuthHeaders(appCode?: string, datasetCode?: string): Promise<AuthHeaders>;
     /**
      * 验证当前认证是否有效
      * @returns 认证是否有效
@@ -390,4 +388,18 @@ export interface LovrabetClient {
      * ```
      */
     getModel(indexOrName: number | string): BaseModelMethods;
+    /**
+     * 检查当前是否为 OpenAPI 模式
+     * @returns 如果配置了 accessKey 或 token 则返回 true，否则返回 false
+     * @description OpenAPI 模式会使用不同的 URL 路径和认证方式
+     * @example
+     * ```typescript
+     * const client = createClient({ accessKey: 'ak-xxx' });
+     * console.log(client.isOpenApiMode()); // true
+     *
+     * const cookieClient = createClient({});
+     * console.log(cookieClient.isOpenApiMode()); // false
+     * ```
+     */
+    isOpenApiMode(): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/sdk",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/src/auth/user-auth.d.ts

@@ -1,8 +0,0 @@
-import type { UserAuthConfig, AuthHeaders } from '../types';
-export declare class UserAuth {
-    private config;
-    constructor(config: UserAuthConfig);
-    getAuthHeaders(): Promise<AuthHeaders>;
-    getToken(): string;
-    setToken(token: string): void;
-}