@seaverse/auth-sdk 0.1.1 → 0.1.2

package/dist/index.d.ts

@@ -631,17 +631,112 @@ declare namespace models {
   export type { models_ApiError as ApiError, models_ApiServiceTokenResponse as ApiServiceTokenResponse, models_CodeToTokenRequest as CodeToTokenRequest, models_CodeToTokenResponse as CodeToTokenResponse, models_Container as Container, models_ContainerDetailResponse as ContainerDetailResponse, models_ContainerListResponse as ContainerListResponse, models_ContainerStatsResponse as ContainerStatsResponse, models_ConversationStatus as ConversationStatus, models_CreateMarketplaceSkillRequest as CreateMarketplaceSkillRequest, models_CreateVideoShareRequest as CreateVideoShareRequest, models_CreateVideoShareResponse as CreateVideoShareResponse, models_ForgotPasswordRequest as ForgotPasswordRequest, models_ForkProjectRequest as ForkProjectRequest, models_ForkProjectResponse as ForkProjectResponse, models_HealthResponse as HealthResponse, models_HubProject as HubProject, models_HubProjectsListResponse as HubProjectsListResponse, models_InviteApplication as InviteApplication, models_InviteApplicationListResponse as InviteApplicationListResponse, models_InviteCodeBindRequest as InviteCodeBindRequest, models_InviteCodeGenerateResponse as InviteCodeGenerateResponse, models_InviteCodeVerifyResponse as InviteCodeVerifyResponse, models_LoginRequest as LoginRequest, models_LoginResponse as LoginResponse, models_MarketplaceSkill as MarketplaceSkill, models_MarketplaceSkillsListResponse as MarketplaceSkillsListResponse, models_PublishProjectRequest as PublishProjectRequest, models_PublishSkillRequest as PublishSkillRequest, models_RegisterContainerRequest as RegisterContainerRequest, models_RegisterContainerResponse as RegisterContainerResponse, models_RegisterRequest as RegisterRequest, models_RegisterResponse as RegisterResponse, models_ResetPasswordRequest as ResetPasswordRequest, models_SocialMediaLink as SocialMediaLink, models_SocialMediaLinksResponse as SocialMediaLinksResponse, models_SpeechTokenResponse as SpeechTokenResponse, models_SubmitInviteApplicationRequest as SubmitInviteApplicationRequest, models_SuccessResponse as SuccessResponse, models_TrackAppTypeRequest as TrackAppTypeRequest, models_User as User, models_UserInstalledSkill as UserInstalledSkill, models_UserInstalledSkillsListResponse as UserInstalledSkillsListResponse, models_VideoDetails as VideoDetails };
 }
 
+/**
+ * Environment Configuration for SeaVerse SDK
+ * 环境配置模块 - 支持多环境部署
+ */
+/**
+ * 支持的环境类型
+ */
+type Environment = 'production' | 'staging' | 'development' | 'local';
+/**
+ * 环境配置接口
+ */
+interface EnvironmentConfig {
+    /** 环境名称 */
+    name: Environment;
+    /** API Base URL */
+    baseURL: string;
+    /** WebSocket URL (可选，未来扩展) */
+    wsURL?: string;
+    /** 是否为生产环境 */
+    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;
+
+/**
+ * SeaVerse Backend API Client 配置选项
+ */
 interface SeaVerseBackendAPIClientOptions {
+    /**
+     * API Base URL
+     * 如果提供，将覆盖 environment 配置
+     * @example 'https://api.seaverse.com'
+     */
     baseURL?: string;
+    /**
+     * 环境类型
+     * 如果不提供 baseURL，将使用此环境的预设配置
+     * 如果也不提供此参数，将自动检测当前环境
+     * @example 'production' | 'staging' | 'development' | 'local'
+     */
+    environment?: Environment;
+    /**
+     * 请求超时时间（毫秒）
+     */
     timeout?: number;
+    /**
+     * 自定义请求头
+     */
     headers?: Record<string, string>;
+    /**
+     * 认证提供者
+     */
     auth?: AuthProvider;
+    /**
+     * Hook 配置
+     */
     hooks?: HookManagerOptions;
 }
 /**
  * SeaVerse Backend API Client
  * SeaVerse Dispatcher API - 云原生 AI Agent 平台的统一网关服务
+ *
  * @version 2.0.0
+ *
+ * @example
+ * // 方式 1: 自动检测环境（推荐本地开发）
+ * const client = new SeaVerseBackendAPIClient();
+ *
+ * @example
+ * // 方式 2: 指定环境（推荐生产部署）
+ * const client = new SeaVerseBackendAPIClient({
+ *   environment: 'production',
+ * });
+ *
+ * @example
+ * // 方式 3: 自定义 URL（特殊需求）
+ * const client = new SeaVerseBackendAPIClient({
+ *   baseURL: 'https://custom-api.example.com',
+ * });
  */
 declare class SeaVerseBackendAPIClient {
     private httpClient;
@@ -899,5 +994,5 @@ declare class AuthModal {
  */
 declare function createAuthModal(options: AuthModalOptions): AuthModal;
 
-export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, SeaVerseBackendAPIClient, createAuthModal, models };
-export type { ApiError, ApiServiceTokenResponse, AuthModalOptions, AuthModalResult, CodeToTokenRequest, CodeToTokenResponse, Container, ContainerDetailResponse, ContainerListResponse, ContainerStatsResponse, ConversationStatus, CreateMarketplaceSkillRequest, CreateVideoShareRequest, CreateVideoShareResponse, ForgotPasswordRequest, ForkProjectRequest, ForkProjectResponse, HealthResponse, HubProject, HubProjectsListResponse, InviteApplication, InviteApplicationListResponse, InviteCodeBindRequest, InviteCodeGenerateResponse, InviteCodeVerifyResponse, LoginRequest, LoginResponse, MarketplaceSkill, MarketplaceSkillsListResponse, OAuthConfig, PublishProjectRequest, PublishSkillRequest, RegisterContainerRequest, RegisterContainerResponse, RegisterRequest, RegisterResponse, ResetPasswordRequest, SeaVerseBackendAPIClientOptions, SocialMediaLink, SocialMediaLinksResponse, SpeechTokenResponse, SubmitInviteApplicationRequest, SuccessResponse, TrackAppTypeRequest, User, UserInstalledSkill, UserInstalledSkillsListResponse, VideoDetails };
+export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, ENVIRONMENT_CONFIGS, SeaVerseBackendAPIClient, createAuthModal, detectEnvironment, getEnvironmentConfig, models };
+export type { ApiError, ApiServiceTokenResponse, AuthModalOptions, AuthModalResult, CodeToTokenRequest, CodeToTokenResponse, Container, ContainerDetailResponse, ContainerListResponse, ContainerStatsResponse, ConversationStatus, CreateMarketplaceSkillRequest, CreateVideoShareRequest, CreateVideoShareResponse, Environment, EnvironmentConfig, ForgotPasswordRequest, ForkProjectRequest, ForkProjectResponse, HealthResponse, HubProject, HubProjectsListResponse, InviteApplication, InviteApplicationListResponse, InviteCodeBindRequest, InviteCodeGenerateResponse, InviteCodeVerifyResponse, LoginRequest, LoginResponse, MarketplaceSkill, MarketplaceSkillsListResponse, OAuthConfig, PublishProjectRequest, PublishSkillRequest, RegisterContainerRequest, RegisterContainerResponse, RegisterRequest, RegisterResponse, ResetPasswordRequest, SeaVerseBackendAPIClientOptions, SocialMediaLink, SocialMediaLinksResponse, SpeechTokenResponse, SubmitInviteApplicationRequest, SuccessResponse, TrackAppTypeRequest, User, UserInstalledSkill, UserInstalledSkillsListResponse, VideoDetails };

package/dist/index.js

@@ -1003,6 +1003,112 @@ class AuthFactory {
     }
 }
 
+/**
+ * Environment Configuration for SeaVerse SDK
+ * 环境配置模块 - 支持多环境部署
+ */
+/**
+ * 预定义的环境配置
+ *
+ * 使用说明：
+ * - production: 正式生产环境
+ * - staging: 预发布环境（当前默认）
+ * - development: 开发测试环境
+ * - local: 本地开发环境
+ */
+const ENVIRONMENT_CONFIGS = {
+    production: {
+        name: 'production',
+        baseURL: 'https://api.seaverse.com',
+        wsURL: 'wss://api.seaverse.com',
+        isProduction: true,
+    },
+    staging: {
+        name: 'staging',
+        baseURL: 'https://account-hub.sg.seaverse.dev',
+        wsURL: 'wss://account-hub.sg.seaverse.dev',
+        isProduction: false,
+    },
+    development: {
+        name: 'development',
+        baseURL: 'https://api-dev.seaverse.dev',
+        wsURL: 'wss://api-dev.seaverse.dev',
+        isProduction: false,
+    },
+    local: {
+        name: 'local',
+        baseURL: 'http://localhost:8001',
+        wsURL: 'ws://localhost:8000',
+        isProduction: false,
+    },
+};
+/**
+ * 根据当前运行环境自动检测应该使用的环境配置
+ *
+ * 检测规则：
+ * 1. localhost/127.0.0.1 → local
+ * 2. 包含 -dev 或 .dev → development
+ * 3. 包含 staging → staging
+ * 4. 其他 → production (默认)
+ *
+ * @returns 检测到的环境类型
+ */
+function detectEnvironment() {
+    // Node.js 环境或非浏览器环境，默认返回 staging（安全起见）
+    if (typeof window === 'undefined' || typeof window.location === 'undefined') {
+        return 'staging';
+    }
+    const hostname = window.location.hostname.toLowerCase();
+    // 本地开发环境
+    if (hostname === 'localhost' || hostname === '127.0.0.1' || hostname === '0.0.0.0') {
+        return 'local';
+    }
+    // 开发环境 (包含 -dev 或 .dev)
+    if (hostname.includes('-dev.') || hostname.includes('.dev') || hostname.endsWith('.dev')) {
+        return 'development';
+    }
+    // Staging 环境
+    if (hostname.includes('-staging.') || hostname.includes('staging.')) {
+        return 'staging';
+    }
+    // 默认使用 production
+    return 'production';
+}
+/**
+ * 获取环境配置
+ *
+ * @param env 环境类型，如果不提供则自动检测
+ * @returns 环境配置对象
+ */
+function getEnvironmentConfig(env) {
+    const targetEnv = env || detectEnvironment();
+    return ENVIRONMENT_CONFIGS[targetEnv];
+}
+/**
+ * 解析用户配置，返回最终的 baseURL
+ *
+ * 优先级：
+ * 1. 显式传入的 baseURL（最高优先级）
+ * 2. environment 参数指定的环境
+ * 3. 自动检测环境（最低优先级）
+ *
+ * @param options 用户配置选项
+ * @returns 最终使用的 baseURL
+ */
+function resolveBaseURL(options) {
+    // 优先级 1: 显式传入的 baseURL
+    if (options.baseURL) {
+        return options.baseURL;
+    }
+    // 优先级 2: environment 参数
+    if (options.environment) {
+        return ENVIRONMENT_CONFIGS[options.environment].baseURL;
+    }
+    // 优先级 3: 自动检测
+    const detectedEnv = detectEnvironment();
+    return ENVIRONMENT_CONFIGS[detectedEnv].baseURL;
+}
+
 /**
  * Type definitions for SeaVerse Dispatcher API
  * Generated from auth.yaml OpenAPI specification
@@ -1015,12 +1121,37 @@ var models = /*#__PURE__*/Object.freeze({
 /**
  * SeaVerse Backend API Client
  * SeaVerse Dispatcher API - 云原生 AI Agent 平台的统一网关服务
+ *
  * @version 2.0.0
+ *
+ * @example
+ * // 方式 1: 自动检测环境（推荐本地开发）
+ * const client = new SeaVerseBackendAPIClient();
+ *
+ * @example
+ * // 方式 2: 指定环境（推荐生产部署）
+ * const client = new SeaVerseBackendAPIClient({
+ *   environment: 'production',
+ * });
+ *
+ * @example
+ * // 方式 3: 自定义 URL（特殊需求）
+ * const client = new SeaVerseBackendAPIClient({
+ *   baseURL: 'https://custom-api.example.com',
+ * });
  */
 class SeaVerseBackendAPIClient {
     constructor(options = {}) {
+        // 使用智能配置解析，支持三种优先级：
+        // 1. 显式 baseURL（最高）
+        // 2. environment 参数
+        // 3. 自动检测（默认）
+        const finalBaseURL = resolveBaseURL({
+            baseURL: options.baseURL,
+            environment: options.environment,
+        });
         const httpOptions = {
-            baseURL: options.baseURL || 'https://web.seaverse.dev',
+            baseURL: finalBaseURL,
             timeout: options.timeout,
             headers: options.headers,
             auth: options.auth || this.getDefaultAuth(),
@@ -2399,5 +2530,5 @@ function createAuthModal(options) {
     return new AuthModal(options);
 }
 
-export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, SeaVerseBackendAPIClient, createAuthModal, models };
+export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, ENVIRONMENT_CONFIGS, SeaVerseBackendAPIClient, createAuthModal, detectEnvironment, getEnvironmentConfig, models };
 //# sourceMappingURL=index.js.map