@seaverse/data-sdk 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -205,83 +205,6 @@ interface EnvironmentConfig {
     /** 是否为生产环境 */
     isProduction: boolean;
 }
-/**
- * 预定义的环境配置
- *
- * 使用说明：
- * - production: 正式生产环境
- * - staging: 预发布环境
- * - development: 开发测试环境
- * - local: 本地开发环境
- */
-declare const ENVIRONMENT_CONFIGS: Record<Environment, EnvironmentConfig>;
-/**
- * 根据当前运行环境自动检测应该使用的环境配置
- *
- * 检测规则：
- * 1. localhost/127.0.0.1 → local
- * 2. 包含 -dev 或 .dev → development
- * 3. 包含 staging → staging
- * 4. 其他 → production (默认)
- *
- * @returns 检测到的环境类型
- */
-declare function detectEnvironment(): Environment;
-/**
- * 获取环境配置
- *
- * @param env 环境类型，如果不提供则自动检测
- * @returns 环境配置对象
- */
-declare function getEnvironmentConfig(env?: Environment): EnvironmentConfig;
-/**
- * 解析用户配置，返回最终的 baseURL
- *
- * 优先级：
- * 1. 显式传入的 baseURL（最高优先级）
- * 2. environment 参数指定的环境
- * 3. 自动检测环境（最低优先级）
- *
- * @param options 用户配置选项
- * @returns 最终使用的 baseURL
- */
-declare function resolveBaseURL(options: {
-    baseURL?: string;
-    environment?: Environment;
-}): string;
-/**
- * 默认超时时间（毫秒）
- */
-declare const DEFAULT_TIMEOUT = 10000;
-/**
- * API 端点路径
- */
-declare const ENDPOINTS: {
-    APP_DATA: string;
-    APP_ADMINS: string;
-};
-/**
- * 动态获取 API Token
- * 优先级：
- * 1. 传入的 apiKey（最高优先级）
- * 2. 通过 PostMessage 从父页面获取
- * 3. 没有找到 → 返回空字符串
- *
- * @param providedApiKey 用户提供的 apiKey（可选）
- * @returns API Token
- */
-declare function getApiToken(providedApiKey?: string): Promise<string | undefined>;
-/**
- * 动态获取 App ID
- * 优先级：
- * 1. 传入的 appId（最高优先级）
- * 2. 通过 PostMessage 从父页面获取
- * 3. 没有找到 → 返回空字符串
- *
- * @param providedAppId 用户提供的 appId（可选）
- * @returns App ID
- */
-declare function getAppId(providedAppId?: string): Promise<string | undefined>;
 
 /**
  * Data SDK Client
@@ -567,255 +490,26 @@ declare class DataClient {
      */
     isAdmin(): Promise<boolean>;
     /**
-     * Update token
+     * Get current SDK configuration
      *
-     * 更新 JWT token
+     * 获取当前 SDK 配置信息
      *
-     * @param token - New JWT token
-     */
-    updateToken(token: string): void;
-    /**
-     * Update app ID
-     *
-     * 更新应用 ID
+     * @returns SDK 配置对象（包含 appId、token、url）
      *
-     * @param appId - New application ID
-     */
-    updateAppId(appId: string): void;
-    /**
-     * Get current app ID
-     */
-    getAppId(): string;
-    /**
-     * Get current user ID
+     * @example
+     * ```typescript
+     * const config = client.getConfig();
+     * console.log('App ID:', config.appId);
+     * console.log('Token:', config.token);
+     * console.log('API URL:', config.url);
+     * ```
      */
-    getUserId(): string;
-}
-
-/**
- * Global Configuration for Data SDK
- * 全局配置模块 - 支持无缝接入
- */
-
-/**
- * 初始化选项接口（扩展）
- */
-interface InitDataOptions extends Partial<DataClientOptions> {
+    getConfig(): {
+        appId: string;
+        token: string;
+        url: string;
+    };
 }
-/**
- * 初始化 Data SDK（可选）
- *
- * 可以在应用启动时调用，也可以完全不调用（SDK会自动从localStorage获取配置）
- *
- * @param options - 初始化选项（所有参数都是可选的）
- *
- * @example
- * ```typescript
- * // 方式1: 从 localStorage 自动获取 appId 和 token（最常用）
- * await initData();
- * // appId 自动从 localStorage.app_id 读取
- * // token 自动从 localStorage.auth_token 读取
- *
- * // 方式2: 显式提供 appId
- * await initData({
- *   appId: 'my-app-123'
- *   // token 自动从 localStorage.auth_token 读取
- * });
- *
- * // 方式3: 显式提供 appId 和 token
- * await initData({
- *   appId: 'my-app-123',
- *   token: 'user-jwt-token'
- * });
- * ```
- */
-declare function initData(options?: InitDataOptions): Promise<void>;
-/**
- * 获取或创建 DataClient 实例
- *
- * 如果已经初始化，返回已有实例；否则自动创建新实例
- *
- * @returns DataClient 实例
- * @throws 如果无法获取必需的配置
- */
-declare function getClient(): Promise<DataClient>;
-/**
- * 更新全局 token（用于 token 刷新场景）
- *
- * @param token - 新的 JWT token
- *
- * @example
- * ```typescript
- * // Token 刷新后更新
- * updateToken('new-jwt-token');
- * ```
- */
-declare function updateToken(token: string): void;
-/**
- * 更新全局 appId（用于切换应用场景）
- *
- * @param appId - 新的应用 ID
- *
- * @example
- * ```typescript
- * // 切换到其他应用
- * updateAppId('another-app-id');
- * ```
- */
-declare function updateAppId(appId: string): void;
-/**
- * 获取当前配置的 appId
- *
- * @returns 当前的 appId 或 undefined
- */
-declare function getCurrentAppId(): string | undefined;
-/**
- * 清除全局配置（用于登出场景）
- *
- * @example
- * ```typescript
- * // 用户登出时清除配置
- * clearConfig();
- * ```
- */
-declare function clearConfig(): void;
-
-/**
- * Convenient Function-based APIs
- * 便捷的函数式 API 封装 - 无需创建 client 实例
- */
-
-/**
- * 查询数据列表
- *
- * 便捷函数 - 无需创建 client 实例
- *
- * @param options - 查询选项
- * @returns 数据记录数组
- *
- * @example
- * ```typescript
- * import { query } from '@seaverse/data-sdk';
- *
- * const notes = await query({
- *   table: 'notes',
- *   filters: { category: 'work' },
- *   order: { field: 'created_at', direction: 'desc' },
- * });
- * ```
- */
-declare function query(options: QueryOptions): Promise<DataRecord[]>;
-/**
- * 获取单条数据
- *
- * @param id - 数据 ID
- * @returns 数据记录或 null
- *
- * @example
- * ```typescript
- * import { get } from '@seaverse/data-sdk';
- *
- * const note = await get('note-id-123');
- * ```
- */
-declare function get(id: string): Promise<DataRecord | null>;
-/**
- * 创建数据
- *
- * @param options - 创建选项
- * @returns 创建的数据记录
- *
- * @example
- * ```typescript
- * import { create } from '@seaverse/data-sdk';
- *
- * const newNote = await create({
- *   table: 'notes',
- *   data: { title: 'My Note', content: '...' },
- *   visibility: 'private',
- * });
- * ```
- */
-declare function create(options: CreateDataOptions): Promise<DataRecord>;
-/**
- * 更新数据
- *
- * @param id - 数据 ID
- * @param options - 更新选项
- * @returns 更新后的数据记录
- *
- * @example
- * ```typescript
- * import { update } from '@seaverse/data-sdk';
- *
- * const updated = await update('note-id-123', {
- *   data: { title: 'Updated Title' },
- * });
- * ```
- */
-declare function update(id: string, options: UpdateDataOptions): Promise<DataRecord>;
-/**
- * 删除数据
- *
- * @param id - 数据 ID
- *
- * @example
- * ```typescript
- * import { deleteData } from '@seaverse/data-sdk';
- *
- * await deleteData('note-id-123');
- * ```
- */
-declare function deleteData(id: string): Promise<void>;
-/**
- * 批量删除数据
- *
- * @param ids - 数据 ID 数组
- *
- * @example
- * ```typescript
- * import { batchDelete } from '@seaverse/data-sdk';
- *
- * await batchDelete(['id-1', 'id-2', 'id-3']);
- * ```
- */
-declare function batchDelete(ids: string[]): Promise<void>;
-/**
- * 查询数据并返回分页信息
- *
- * @param options - 查询选项
- * @returns 分页响应（包含 total, hasMore 等元数据）
- *
- * @example
- * ```typescript
- * import { queryWithPagination } from '@seaverse/data-sdk';
- *
- * const result = await queryWithPagination({
- *   table: 'posts',
- *   pagination: { limit: 10, offset: 0 },
- * });
- *
- * console.log(`总共 ${result.total} 条数据`);
- * console.log(`是否还有更多: ${result.hasMore}`);
- * ```
- */
-declare function queryWithPagination(options: QueryOptions): Promise<PaginatedResponse<DataRecord>>;
-/**
- * 检查当前用户是否是管理员
- *
- * @returns 是否是管理员
- *
- * @example
- * ```typescript
- * import { isAdmin } from '@seaverse/data-sdk';
- *
- * const admin = await isAdmin();
- * if (admin) {
- *   console.log('当前用户是管理员');
- * }
- * ```
- */
-declare function isAdmin(): Promise<boolean>;
 
-export { DEFAULT_TIMEOUT, DataClient, DataSDKError, ENDPOINTS, ENVIRONMENT_CONFIGS, NotFoundError, PermissionError, RateLimitError, SDKError, ValidationError, batchDelete, clearConfig, create, deleteData, detectEnvironment, get, getApiToken, getAppId, getClient, getCurrentAppId, getEnvironmentConfig, initData, isAdmin, query, queryWithPagination, resolveBaseURL, update, updateAppId, updateToken };
+export { DataClient, DataSDKError, NotFoundError, PermissionError, RateLimitError, SDKError, ValidationError };
 export type { AdminRole, CreateDataOptions, DataClientOptions, DataRecord, Environment, EnvironmentConfig, FilterOperator, JWTClaims, PaginatedResponse, QueryOptions, UpdateDataOptions, Visibility };