@seaverse/data-sdk 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -260,6 +260,32 @@ declare const ENDPOINTS: {
     APP_DATA: string;
     APP_ADMINS: string;
 };
+/**
+ * 自动获取 API Token
+ *
+ * 按照以下优先级获取 token：
+ * 1. 传入的 token 参数
+ * 2. localStorage 中的 auth_token
+ * 3. PostMessage 从父窗口获取（iframe 场景）
+ * 4. 环境变量 DATA_SDK_TOKEN
+ *
+ * @param providedToken - 可选的直接提供的 token
+ * @returns token 字符串
+ */
+declare function getApiToken(providedToken?: string): Promise<string>;
+/**
+ * 自动获取 App ID
+ *
+ * 按照以下优先级获取 appId：
+ * 1. 传入的 appId 参数
+ * 2. localStorage 中的 app_id
+ * 3. PostMessage 从父窗口获取（iframe 场景）
+ * 4. 环境变量 DATA_SDK_APP_ID
+ *
+ * @param providedAppId - 可选的直接提供的 appId
+ * @returns appId 字符串
+ */
+declare function getAppId(providedAppId?: string): Promise<string>;
 
 /**
  * Data SDK Client
@@ -538,5 +564,219 @@ declare class DataClient {
     getUserId(): string;
 }
 
-export { DEFAULT_TIMEOUT, DataClient, DataSDKError, ENDPOINTS, ENVIRONMENT_CONFIGS, NotFoundError, PermissionError, RateLimitError, SDKError, ValidationError, detectEnvironment, getEnvironmentConfig, resolveBaseURL };
+/**
+ * Global Configuration for Data SDK
+ * 全局配置模块 - 支持无缝接入
+ */
+
+/**
+ * 初始化 Data SDK（可选）
+ *
+ * 可以在应用启动时调用，也可以完全不调用（SDK会自动从localStorage获取配置）
+ *
+ * @param options - 初始化选项（所有参数都是可选的）
+ *
+ * @example
+ * ```typescript
+ * // 方式1: 显式初始化（推荐用于需要自定义配置的场景）
+ * await initData({
+ *   appId: 'my-app-123',
+ *   token: 'user-jwt-token',
+ *   debug: true,
+ * });
+ *
+ * // 方式2: 不初始化，直接使用（推荐用于SeaVerse平台应用）
+ * // SDK 会自动从 localStorage 读取 auth_token 和 app_id
+ * const notes = await query({ table: 'notes' });
+ * ```
+ */
+declare function initData(options?: Partial<DataClientOptions>): 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 type { AdminRole, CreateDataOptions, DataClientOptions, DataRecord, Environment, EnvironmentConfig, FilterOperator, JWTClaims, PaginatedResponse, QueryOptions, UpdateDataOptions, Visibility };