@lovrabet/sdk 1.1.7-beta.0 → 1.1.11-beta.0

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

@@ -11,5 +11,5 @@ export declare class AuthManager implements IAuthManager {
      * Check if we're using cookie-based authentication
      */
     isCookieAuth(): boolean;
-    setToken(token: string): void;
+    setToken(token: string, timestamp?: number): void;
 }

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

@@ -0,0 +1,72 @@
+/**
+ * OpenAPI 认证工具函数
+ *
+ * 包含认证相关的共享工具函数和常量
+ */
+/**
+ * 默认的 Secret Access Key
+ * @internal
+ */
+export declare const DEFAULT_SECRET_KEY = "sk-9Wc0wdYTNdEYXX1nFLcx0zPDU3wVNrSDroByjrgAbU4";
+/**
+ * Token 有效期（毫秒）
+ */
+export declare const TOKEN_VALIDITY_MS: number;
+/**
+ * 生成 HMAC-SHA256 签名
+ *
+ * @param data 要签名的数据
+ * @param key 密钥
+ * @returns Base64 编码的签名
+ */
+export declare function hmacSha256(data: string, key: string): Promise<string>;
+/**
+ * 构建签名字符串
+ *
+ * @param params 参数对象
+ * @returns 按字母顺序排序的查询字符串
+ */
+export declare function buildSignatureString(params: Record<string, string>): string;
+/**
+ * 生成 OpenAPI Token
+ *
+ * @param params Token 生成参数
+ * @returns 生成的 token 字符串
+ */
+export declare function generateToken(params: {
+    accessKey: string;
+    timestamp: number;
+    appCode: string;
+    datasetCode: string;
+    secretKey?: string;
+}): Promise<string>;
+/**
+ * 验证必需的参数
+ *
+ * @param params 参数对象
+ * @param required 必需的参数名列表
+ * @throws 当缺少必需参数时抛出错误
+ */
+export declare function validateRequiredParams(params: Record<string, any>, required: string[]): void;
+/**
+ * 计算 Token 过期时间
+ *
+ * @param timestamp Token 创建时间戳
+ * @returns 过期时间戳
+ */
+export declare function calculateExpiresAt(timestamp: number): number;
+/**
+ * 检查 Token 是否即将过期
+ *
+ * @param timestamp Token 的时间戳
+ * @param bufferMinutes 提前多少分钟认为过期（默认1分钟）
+ * @returns 是否即将过期
+ */
+export declare function isTokenExpiring(timestamp: number, bufferMinutes?: number): boolean;
+/**
+ * 计算 Token 剩余有效时间
+ *
+ * @param timestamp Token 的时间戳
+ * @returns 剩余有效时间（毫秒），如果已过期返回 0
+ */
+export declare function getTokenRemainingTime(timestamp: number): number;

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

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

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

@@ -3,6 +3,4 @@ export declare class OpenApiAuth {
     private config;
     constructor(config: OpenApiAuthConfig);
     getAuthHeaders(appCode: string, datasetCode: string): Promise<AuthHeaders>;
-    private generateToken;
-    private hmacSha256;
 }

package/dist/src/auth/token-generator.d.ts

@@ -0,0 +1,117 @@
+/**
+ * OpenAPI Token 生成工具
+ *
+ * 为 Node.js 服务端提供 token 生成功能，用于：
+ * 1. 后端生成 token 和 timestamp 配对
+ * 2. 返回给前端使用，避免前端存储 accessKey
+ * 3. 保证 token 和 timestamp 的正确配对
+ */
+import { isTokenExpiring as isTokenExpiringInternal, getTokenRemainingTime as getTokenRemainingTimeInternal } from './auth-utils';
+/**
+ * Token 生成参数
+ */
+export interface GenerateTokenParams {
+    /** 应用代码 */
+    appCode: string;
+    /** 数据集代码 */
+    datasetCode: string;
+    /** API 访问密钥 */
+    accessKey: string;
+    /** API 密钥（可选，有默认值） */
+    secretKey?: string;
+    /** 自定义时间戳（可选，默认为当前时间） */
+    timestamp?: number;
+}
+/**
+ * Token 生成结果
+ */
+export interface TokenResult {
+    /** 生成的 token */
+    token: string;
+    /** 配对的时间戳 */
+    timestamp: number;
+    /** Token 过期时间（10分钟后） */
+    expiresAt: number;
+}
+/**
+ * 生成 OpenAPI 认证 Token
+ *
+ * @description
+ * 用于后端生成 token 和 timestamp 配对，返回给前端使用。
+ * Token 有效期为 10 分钟，由服务端验证。
+ *
+ * @example
+ * ```typescript
+ * // Node.js 后端代码
+ * import { generateOpenApiToken } from '@lovrabet/sdk';
+ *
+ * // 生成 token
+ * const result = await generateOpenApiToken({
+ *   appCode: 'app-123',
+ *   datasetCode: 'dataset-456',
+ *   accessKey: process.env.ACCESS_KEY,
+ *   secretKey: process.env.SECRET_KEY // 可选
+ * });
+ *
+ * // 返回给前端
+ * res.json({
+ *   token: result.token,
+ *   timestamp: result.timestamp,
+ *   expiresAt: result.expiresAt
+ * });
+ * ```
+ *
+ * @param params Token 生成参数
+ * @returns Token 和配对的 timestamp
+ */
+export declare function generateOpenApiToken(params: GenerateTokenParams): Promise<TokenResult>;
+/**
+ * Token 生成器类（可选的面向对象接口）
+ *
+ * @example
+ * ```typescript
+ * const generator = new TokenGenerator({
+ *   accessKey: 'ak-xxx',
+ *   secretKey: 'sk-xxx'
+ * });
+ *
+ * const result = await generator.generate({
+ *   appCode: 'app-123',
+ *   datasetCode: 'dataset-456'
+ * });
+ * ```
+ */
+export declare class TokenGenerator {
+    private accessKey;
+    private secretKey;
+    constructor(config: {
+        accessKey: string;
+        secretKey?: string;
+    });
+    /**
+     * 生成 Token
+     */
+    generate(params: {
+        appCode: string;
+        datasetCode: string;
+        timestamp?: number;
+    }): Promise<TokenResult>;
+    /**
+     * 批量生成 Token（为多个数据集生成 token）
+     */
+    generateBatch(params: {
+        appCode: string;
+        datasetCodes: string[];
+        timestamp?: number;
+    }): Promise<Map<string, TokenResult>>;
+}
+/**
+ * 验证 Token 是否即将过期
+ * @description 重新导出共享工具函数
+ */
+export declare const isTokenExpiring: typeof isTokenExpiringInternal;
+/**
+ * 计算 Token 剩余有效时间
+ * @description 重新导出共享工具函数
+ */
+export declare const getTokenRemainingTime: typeof getTokenRemainingTimeInternal;

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

@@ -29,8 +29,11 @@ export declare class LovrabetClient implements ILovrabetClient {
      * 1. 用户登录后可能需要更新 token
      * 2. token 可能会过期需要刷新
      * 3. 支持动态认证切换（比如用户切换账号）
+     *
+     * @param token - 认证 token
+     * @param timestamp - 与 token 配对的时间戳（OpenAPI 模式必需）
      */
-    setToken(token: string): void;
+    setToken(token: string, timestamp?: number): void;
     /**
      * 获取当前配置的副本
      * 为什么返回副本而不是原始对象：

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

@@ -98,6 +98,8 @@ export interface ClientConfig {
     env?: Environment;
     /** 用户 Token，用于 Bearer 认证 */
     token?: string;
+    /** 与 token 配对的时间戳（OpenAPI 模式必需） */
+    timestamp?: number;
     /** API 访问密钥，用于签名认证 */
     accessKey?: string;
     /** API 密钥，用于签名认证 */
@@ -259,7 +261,7 @@ export interface AuthHeaders {
  * OpenAPI 密钥认证配置
  * @description 用于签名认证方式，支持两种模式：
  * 1. Server 端：传入 accessKey，内部生成 token
- * 2. Client 端：直接传入预计算的 token
+ * 2. Client 端：直接传入预计算的 token 和对应的 timestamp
  */
 export interface OpenApiAuthConfig {
     /** API 访问密钥（Server 端使用） */
@@ -268,6 +270,8 @@ export interface OpenApiAuthConfig {
     secretKey?: string;
     /** 预计算的 token（Client 端使用，避免在浏览器暴露 accessKey） */
     token?: string;
+    /** 与 token 配对的时间戳（Client 端使用，必须与 token 一起使用） */
+    timestamp?: number;
 }
 /**
  * 认证管理器接口
@@ -300,8 +304,9 @@ export interface AuthManager {
     /**
      * 设置用户 Token
      * @param token 用户认证 Token
+     * @param timestamp 与 token 配对的时间戳（OpenAPI 模式必需）
      */
-    setToken(token: string): void;
+    setToken(token: string, timestamp?: number): void;
     /**
      * 检查是否使用 Cookie 认证
      * @description 当没有 Token 和 API 密钥时，会降级到 Cookie 认证
@@ -347,9 +352,10 @@ export interface LovrabetClient {
     /**
      * 设置用户认证 Token
      * @param token 用户认证 Token
+     * @param timestamp 与 token 配对的时间戳（OpenAPI 模式必需）
      * @description 设置后所有 API 请求将使用此 Token 进行认证
      */
-    setToken(token: string): void;
+    setToken(token: string, timestamp?: number): void;
     /**
      * 获取客户端配置
      * @returns 当前客户端的完整配置信息

package/dist/src/utils/browser-detection.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 浏览器环境检测工具
+ */
+/**
+ * 检测是否在浏览器环境中运行
+ * @returns {boolean} 如果在浏览器环境中返回 true，否则返回 false
+ */
+export declare function isBrowser(): boolean;
+/**
+ * 在浏览器环境中使用 accessKey 时显示安全警告
+ * @param message - 自定义警告消息（可选）
+ */
+export declare function warnBrowserAccessKey(message?: string): void;

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

@@ -0,0 +1,2 @@
+export { LovrabetError, createErrorHandler } from "./errors";
+export { isBrowser, warnBrowserAccessKey } from './browser-detection';

package/dist/src/version.d.ts

@@ -0,0 +1,17 @@
+/**
+ * SDK 版本信息
+ * 此文件由构建脚本自动生成，请勿手动修改
+ * @generated
+ */
+/** SDK 版本号 */
+export declare const VERSION = "1.1.10";
+/** SDK 包名 */
+export declare const PACKAGE_NAME = "@lovrabet/sdk";
+/** 获取完整的版本信息 */
+export declare function getVersionInfo(): {
+    version: string;
+    package: string;
+    userAgent: string;
+};
+/** 默认导出版本号 */
+export default VERSION;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lovrabet/sdk",
-  "version": "1.1.7-beta.0",
+  "version": "1.1.11-beta.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,18 +26,22 @@
     "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"
+    "release": "bun run build && bun pm version patch && git push && git push origin --tag && bun publish",
+    "version:generate": "node scripts/generate-version.js",
+    "prebuild": "npm run version:generate",
+    "prebuild:dev": "npm run version:generate"
   },
   "files": [
     "dist"
   ],
   "devDependencies": {
     "@types/bun": "latest",
-    "javascript-obfuscator": "^4.1.1",
-    "chokidar-cli": "^3.0.0",
-    "vitest": "^2.1.8",
+    "@vitest/coverage-v8": "^2.1.9",
     "@vitest/ui": "^2.1.8",
-    "c8": "^10.1.2"
+    "c8": "^10.1.2",
+    "chokidar-cli": "^3.0.0",
+    "javascript-obfuscator": "^4.1.1",
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "typescript": "^5"