@lovrabet/sdk 1.1.5 → 1.1.7-beta.0

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/index.d.ts

@@ -0,0 +1,3 @@
+export { AuthManager } from './auth-manager';
+export { OpenApiAuth } from './openapi-auth';
+export type { AuthHeaders, OpenApiAuthConfig } from '../types';

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

@@ -73,5 +73,14 @@ export declare class LovrabetClient implements ILovrabetClient {
      * 2. 支持按索引快速获取第一个模型，便于演示和快速开发
      * 3. 作为 models.xxx 语法糖的底层实现
      */
-    getModel(indexOrName: number | string): import("../models/base-model").BaseModel;
+    getModel(indexOrName: number | string): import("../types").BaseModelMethods;
+    /**
+     * 检查当前是否为 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/http/http-client.d.ts

@@ -18,9 +18,9 @@ export declare class HttpClient {
      * 通用的fetch请求方法（用于PUT/DELETE等没有专门优化函数的方法）
      */
     private makeRequest;
-    get<T = any>(url: string, params?: Record<string, any>, options?: RequestInit): Promise<T>;
-    post<T = any>(url: string, data?: any, options?: RequestInit): Promise<T>;
-    put<T = any>(url: string, data?: any, options?: RequestInit): Promise<T>;
-    delete<T = any>(url: string, options?: RequestInit): Promise<T>;
-    request<T = any>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', url: string, data?: any, options?: RequestInit): Promise<T>;
+    get<T = any>(url: string, params?: Record<string, any>, options?: RequestInit, datasetCode?: string): Promise<T>;
+    post<T = any>(url: string, data?: any, options?: RequestInit, datasetCode?: string): Promise<T>;
+    put<T = any>(url: string, data?: any, options?: RequestInit, datasetCode?: string): Promise<T>;
+    delete<T = any>(url: string, options?: RequestInit, datasetCode?: string): Promise<T>;
+    request<T = any>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', url: string, data?: any, options?: RequestInit, datasetCode?: string): Promise<T>;
 }

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

@@ -0,0 +1,26 @@
+import type { BaseModelMethods, ListParams, ListResponse, ModelConfig, ClientConfig } from '../types';
+import type { HttpClient } from '../http/http-client';
+/**
+ * 抽象基础模型类
+ * 定义所有模型的通用接口和基础实现
+ */
+export declare abstract class AbstractBaseModel implements BaseModelMethods {
+    protected modelName: string;
+    protected httpClient: HttpClient;
+    protected config: ModelConfig;
+    protected appCode: string;
+    protected globalConfig: ClientConfig;
+    constructor(modelName: string, httpClient: HttpClient, globalConfig: ClientConfig);
+    private resolveModelConfig;
+    protected abstract getApiPath(method: string): string;
+    protected abstract buildRequestBody(method: string, data: any): any;
+    getList<T = any>(params?: ListParams): Promise<ListResponse<T>>;
+    getOne<T = any>(id: string | number): Promise<T>;
+    create<T = any>(data: Record<string, any>): Promise<T>;
+    update<T = any>(id: string | number, data: Record<string, any>): Promise<T>;
+    delete(id: string | number): Promise<void>;
+    getDatasetList<T = any>(): Promise<T[]>;
+    private isOpenApiMode;
+    getConfig(): ModelConfig;
+    getModelName(): string;
+}

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

@@ -0,0 +1,6 @@
+export { AbstractBaseModel } from './abstract-base-model';
+export { OpenApiModel } from './openapi-model';
+export { WebApiModel } from './webapi-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

@@ -0,0 +1,20 @@
+import type { BaseModelMethods, ClientConfig } from '../types';
+import type { HttpClient } from '../http/http-client';
+/**
+ * 模型工厂类
+ * 根据配置决定创建 OpenAPI 或 WebAPI 模型实例
+ */
+export declare class ModelFactory {
+    /**
+     * 创建模型实例
+     */
+    static createModel(modelName: string, httpClient: HttpClient, globalConfig: ClientConfig): BaseModelMethods;
+    /**
+     * 判断是否为 OpenAPI 模式
+     */
+    private static isOpenApiMode;
+    /**
+     * 获取当前模式名称（用于调试）
+     */
+    static getModeName(config: ClientConfig): 'OpenAPI' | 'WebAPI';
+}

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

@@ -1,6 +1,5 @@
-import type { ModelManager as IModelManager, ClientConfig } from '../types';
+import type { ModelManager as IModelManager, ClientConfig, BaseModelMethods } from '../types';
 import type { HttpClient } from '../http/http-client';
-import { BaseModel } from './base-model';
 export declare class ModelManager implements IModelManager {
     private httpClient;
     private config;
@@ -11,8 +10,8 @@ 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;
+    get(indexOrName: number | string): BaseModelMethods;
 }

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

@@ -0,0 +1,15 @@
+import { AbstractBaseModel } from './abstract-base-model';
+/**
+ * OpenAPI 模型实现
+ * 处理 OpenAPI 模式下的 URL 生成和请求体构建
+ */
+export declare class OpenApiModel extends AbstractBaseModel {
+    /**
+     * OpenAPI 模式的 URL 生成策略
+     */
+    protected getApiPath(sdkMethod: string): string;
+    /**
+     * OpenAPI 模式的请求体构建策略
+     */
+    protected buildRequestBody(method: string, data: any): any;
+}

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

@@ -0,0 +1,15 @@
+import { AbstractBaseModel } from './abstract-base-model';
+/**
+ * WebAPI 模型实现
+ * 处理 WebAPI 模式下的 URL 生成和请求体构建
+ */
+export declare class WebApiModel extends AbstractBaseModel {
+    /**
+     * WebAPI 模式的 URL 生成策略
+     */
+    protected getApiPath(sdkMethod: string): string;
+    /**
+     * WebAPI 模式的请求体构建策略
+     */
+    protected buildRequestBody(method: string, data: any): any;
+}

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' }
  *   }
  * };
  * ```
@@ -173,6 +173,13 @@ export interface BaseModelMethods {
      * @returns Promise<void>
      */
     delete(id: string | number): Promise<void>;
+    /**
+     * 获取数据集列表
+     * @template T 返回数据的类型
+     * @returns 返回数据集列表
+     * @description 获取当前应用下的所有数据集列表，主要用于 OpenAPI 模式
+     */
+    getDatasetList<T = any>(): Promise<T[]>;
 }
 /**
  * 模型管理器接口
@@ -206,7 +213,7 @@ export interface ModelManager {
      */
     addModel(modelName: string, config: {
         tableName: string;
-        datasetId: string;
+        datasetCode: string;
     }): void;
     /**
      * 获取所有可用模型列表
@@ -248,23 +255,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 +287,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 +395,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.7-beta.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,6 +14,16 @@
   "type": "module",
   "scripts": {
     "build": "rm -rf dist && bun build index.ts --outdir=dist --target=browser --format=esm && javascript-obfuscator dist --output dist && npm run types",
+    "build:dev": "rm -rf dist && bun build index.ts --outdir=dist --target=browser --format=esm && npm run types",
+    "dev": "npm run build:dev",
+    "start": "npm run watch",
+    "watch": "npm run build:dev && npm run watch:files",
+    "watch:files": "chokidar \"src/**/*.ts\" \"index.ts\" -c \"npm run build:dev\"",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest watch",
     "types": "npx tsc --emitDeclarationOnly --declaration --outDir dist index.ts",
     "beta-release": "bun run build && sh scripts/update-beta-version.sh && git push && git push origin --tag && bun publish",
     "release": "bun run build && bun pm version patch && git push && git push origin --tag && bun publish"
@@ -23,7 +33,11 @@
   ],
   "devDependencies": {
     "@types/bun": "latest",
-    "javascript-obfuscator": "^4.1.1"
+    "javascript-obfuscator": "^4.1.1",
+    "chokidar-cli": "^3.0.0",
+    "vitest": "^2.1.8",
+    "@vitest/ui": "^2.1.8",
+    "c8": "^10.1.2"
   },
   "peerDependencies": {
     "typescript": "^5"

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;
-}

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

@@ -1,18 +0,0 @@
-import type { BaseModelMethods, ListParams, ListResponse, ClientConfig, ModelConfig } from '../types';
-import type { HttpClient } from '../http/http-client';
-export declare class BaseModel implements BaseModelMethods {
-    private modelName;
-    private httpClient;
-    private config;
-    private appCode;
-    constructor(modelName: string, httpClient: HttpClient, globalConfig: ClientConfig);
-    private resolveModelConfig;
-    private getApiPath;
-    getList<T = any>(params?: ListParams): Promise<ListResponse<T>>;
-    getOne<T = any>(id: string | number): Promise<T>;
-    create<T = any>(data: Record<string, any>): Promise<T>;
-    update<T = any>(id: string | number, data: Record<string, any>): Promise<T>;
-    delete(id: string | number): Promise<void>;
-    getConfig(): ModelConfig;
-    getModelName(): string;
-}