@seaverse/auth-sdk 0.4.4 → 0.4.6

package/dist/index.d.ts

@@ -88,12 +88,16 @@ declare class AuthFactory {
     static fromEnv(): AuthProvider;
     /**
      * 从配置文件创建认证提供者
+     * @deprecated This method requires Node.js fs module and should not be used in browser environments.
+     * Use AuthFactory.create() with a config object instead.
      */
-    static fromFile(path: string): Promise<AuthProvider>;
+    static fromFile(_path: string): Promise<AuthProvider>;
     /**
      * 从profile创建认证提供者
+     * @deprecated This method requires Node.js fs module and should not be used in browser environments.
+     * Use AuthFactory.create() with a config object instead.
      */
-    static fromProfile(profileName?: string): Promise<AuthProvider>;
+    static fromProfile(_profileName?: string): Promise<AuthProvider>;
 }
 
 type HookType = 'beforeRequest' | 'afterResponse' | 'onError' | 'onRetry';
@@ -1647,5 +1651,238 @@ declare class Toast {
     private static injectCSS;
 }
 
-export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, ENVIRONMENT_CONFIGS, ErrorCode, SeaVerseBackendAPIClient, Toast, createAuthModal, detectEnvironment, getEnvironmentConfig, models };
-export type { AccountExistsErrorDetails, ApiError, ApiServiceTokenResponse, ApplyInviteResponse, AuthModalOptions, AuthModalResult, BindInviteCodeRequest, BindInviteCodeResponse, Container, ContainerDetailResponse, ContainerListResponse, ContainerStatsResponse, ConversationStatus, CreateMarketplaceSkillRequest, CreateVideoShareRequest, CreateVideoShareResponse, EmailVerificationResponse, Environment, EnvironmentConfig, ForgotPasswordRequest, ForkProjectRequest, ForkProjectResponse, HealthResponse, HubProject, HubProjectsListResponse, IframeTokenErrorMessage, IframeTokenRequestMessage, IframeTokenResponseMessage, InviteApplication, InviteApplicationListResponse, InviteCode, InviteCodeBindRequest, InviteCodeDetailResponse, InviteCodeGenerateResponse, InviteCodeRequiredErrorData, InviteCodeVerifyResponse, InviteStats, InviteStatsResponse, InviteUsage, ListInviteUsagesRequest, ListInviteUsagesResponse, ListInvitesRequest, ListInvitesResponse, LoginRequest, LoginResponse, MarketplaceSkill, MarketplaceSkillsListResponse, OAuthAuthorizeRequest, OAuthAuthorizeResponse, PublishProjectRequest, PublishSkillRequest, RegisterContainerRequest, RegisterContainerResponse, RegisterRequest, RegisterResponse, ResetPasswordRequest, RetryOptions, SeaVerseBackendAPIClientOptions, SocialMediaLink, SocialMediaLinksResponse, SpeechTokenResponse, SubmitInviteApplicationRequest, SuccessResponse, ToastOptions, ToastType, TrackAppTypeRequest, User, UserInstalledSkill, UserInstalledSkillsListResponse, VideoDetails };
+/**
+ * Google One-Tap Sign-In SDK
+ *
+ * 用于在用户未登录 SeaVerse 但已登录 Google 的情况下，
+ * 自动显示 Google One-Tap 快速登录界面
+ */
+declare global {
+    interface Window {
+        google?: {
+            accounts: {
+                id: {
+                    initialize(config: GoogleIdConfiguration): void;
+                    prompt(momentListener?: (notification: PromptMomentNotification) => void): void;
+                    cancel(): void;
+                    renderButton(parent: HTMLElement, options: GsiButtonConfiguration): void;
+                    disableAutoSelect(): void;
+                };
+            };
+        };
+    }
+}
+interface GoogleIdConfiguration {
+    client_id: string;
+    callback: (response: CredentialResponse) => void;
+    auto_select?: boolean;
+    cancel_on_tap_outside?: boolean;
+    context?: 'signin' | 'signup' | 'use';
+    use_fedcm_for_prompt?: boolean;
+}
+interface CredentialResponse {
+    credential: string;
+    select_by?: string;
+}
+interface PromptMomentNotification {
+    isDisplayMoment(): boolean;
+    isDisplayed(): boolean;
+    isNotDisplayed(): boolean;
+    getNotDisplayedReason(): string;
+    isSkippedMoment(): boolean;
+    getSkippedReason(): string;
+    isDismissedMoment(): boolean;
+    getDismissedReason(): string;
+}
+interface GsiButtonConfiguration {
+    type?: 'standard' | 'icon';
+    theme?: 'outline' | 'filled_blue' | 'filled_black';
+    size?: 'large' | 'medium' | 'small';
+    text?: 'signin_with' | 'signup_with' | 'continue_with' | 'signin';
+    shape?: 'rectangular' | 'pill' | 'circle' | 'square';
+    logo_alignment?: 'left' | 'center';
+    width?: number;
+    locale?: string;
+}
+/**
+ * Google One-Tap 配置选项
+ */
+interface GoogleOneTapOptions {
+    /**
+     * Google OAuth Client ID（必需）
+     * 从 Google Cloud Console 获取
+     *
+     * @example '827924048330-xxxxxx.apps.googleusercontent.com'
+     */
+    clientId: string;
+    /**
+     * 检查用户是否已登录 SeaVerse（必需）
+     * SDK 会在初始化时和显示 One-Tap 前调用此函数
+     * 只有返回 false 时才会显示 Google One-Tap
+     *
+     * @returns true - 已登录，SDK 不显示 One-Tap
+     *          false - 未登录，SDK 显示 One-Tap
+     *
+     * @example
+     * isLoggedIn: () => !!localStorage.getItem('seaverse_token')
+     *
+     * @example
+     * isLoggedIn: () => document.cookie.includes('auth_token')
+     */
+    isLoggedIn: () => boolean;
+    /**
+     * 获取到 Google credential 后的回调（必需）
+     * SDK 获取到 Google 返回的 JWT credential 后会调用此函数
+     * 前端在此函数中决定如何处理 credential（调用后端验证、保存 token 等）
+     *
+     * @param credential - Google 返回的 JWT token
+     *
+     * @example
+     * onCredentialReceived: async (credential) => {
+     *   const res = await fetch('/api/auth/google/verify', {
+     *     method: 'POST',
+     *     body: JSON.stringify({ credential })
+     *   });
+     *   const data = await res.json();
+     *   localStorage.setItem('token', data.token);
+     *   window.location.href = '/dashboard';
+     * }
+     */
+    onCredentialReceived: (credential: string) => void | Promise<void>;
+    /**
+     * 错误回调（可选）
+     *
+     * @param error - 错误对象
+     */
+    onError?: (error: Error) => void;
+    /**
+     * 是否自动显示 One-Tap 提示（可选，默认 true）
+     * 注意：即使设置为 true，也只在 isLoggedIn() 返回 false 时才显示
+     */
+    autoPrompt?: boolean;
+    /**
+     * 点击 One-Tap 弹窗外部时是否取消（可选，默认 true）
+     */
+    cancelOnTapOutside?: boolean;
+    /**
+     * 登录上下文（可选，默认 'signin'）
+     */
+    context?: 'signin' | 'signup' | 'use';
+    /**
+     * 自定义按钮配置（可选）
+     * 用于 renderButton() 方法
+     */
+    button?: {
+        type?: 'standard' | 'icon';
+        theme?: 'outline' | 'filled_blue' | 'filled_black';
+        size?: 'large' | 'medium' | 'small';
+        text?: 'signin_with' | 'signup_with' | 'continue_with' | 'signin';
+        shape?: 'rectangular' | 'pill' | 'circle' | 'square';
+        logoAlignment?: 'left' | 'center';
+        width?: number;
+        locale?: string;
+    };
+    /**
+     * 是否启用调试日志（可选，默认 false）
+     */
+    debug?: boolean;
+    /**
+     * 是否使用 FedCM (Federated Credential Management) 进行提示（可选，默认 false）
+     *
+     * FedCM 是 Chrome 的新 API，用于替代第三方 Cookie。
+     * 如果遇到 CORS 错误或 FedCM 请求失败，可以设置为 false 使用传统的 iframe 方式。
+     *
+     * @default false
+     *
+     * @example
+     * useFedcmForPrompt: false  // 禁用 FedCM，使用传统方式
+     */
+    useFedcmForPrompt?: boolean;
+}
+/**
+ * Google One-Tap 快速登录
+ *
+ * 用法示例：
+ * ```typescript
+ * const googleLogin = new GoogleOneTap({
+ *   clientId: 'YOUR_GOOGLE_CLIENT_ID',
+ *   isLoggedIn: () => !!localStorage.getItem('token'),
+ *   onCredentialReceived: async (credential) => {
+ *     // 调用后端验证
+ *     const res = await fetch('/api/auth/google', {
+ *       method: 'POST',
+ *       body: JSON.stringify({ credential })
+ *     });
+ *     const data = await res.json();
+ *     localStorage.setItem('token', data.token);
+ *     window.location.reload();
+ *   }
+ * });
+ * ```
+ */
+declare class GoogleOneTap {
+    private options;
+    private isInitialized;
+    private scriptLoaded;
+    private static scriptLoadPromise;
+    constructor(options: GoogleOneTapOptions);
+    /**
+     * 检查登录状态并初始化
+     */
+    private checkAndInit;
+    /**
+     * 初始化 Google One-Tap API
+     */
+    private init;
+    /**
+     * 处理 Google 返回的 credential
+     */
+    private handleCredentialResponse;
+    /**
+     * 显示 Google One-Tap 提示
+     * 会先检查登录状态
+     */
+    prompt(): void;
+    /**
+     * 取消 Google One-Tap 提示
+     */
+    cancel(): void;
+    /**
+     * 渲染 Google 登录按钮到指定元素
+     *
+     * @param element - 要渲染按钮的 HTML 元素
+     *
+     * @example
+     * const container = document.getElementById('google-btn');
+     * googleLogin.renderButton(container);
+     */
+    renderButton(element: HTMLElement): void;
+    /**
+     * 禁用自动选择
+     * 用户关闭 One-Tap 后，下次不会自动选择账号
+     */
+    disableAutoSelect(): void;
+    /**
+     * 等待 Google API 完全就绪
+     */
+    private waitForGoogleAPI;
+    /**
+     * 加载 Google One-Tap 脚本
+     */
+    private loadGoogleScript;
+    /**
+     * 处理错误
+     */
+    private handleError;
+    /**
+     * 调试日志
+     */
+    private log;
+    /**
+     * 检查 Google One-Tap 是否可用
+     */
+    static isAvailable(): boolean;
+}
+
+export { AuthFactory, AuthModal, AuthProvider, BuiltInHooks, ENVIRONMENT_CONFIGS, ErrorCode, GoogleOneTap, SeaVerseBackendAPIClient, Toast, createAuthModal, detectEnvironment, getEnvironmentConfig, models };
+export type { AccountExistsErrorDetails, ApiError, ApiServiceTokenResponse, ApplyInviteResponse, AuthModalOptions, AuthModalResult, BindInviteCodeRequest, BindInviteCodeResponse, Container, ContainerDetailResponse, ContainerListResponse, ContainerStatsResponse, ConversationStatus, CreateMarketplaceSkillRequest, CreateVideoShareRequest, CreateVideoShareResponse, EmailVerificationResponse, Environment, EnvironmentConfig, ForgotPasswordRequest, ForkProjectRequest, ForkProjectResponse, GoogleOneTapOptions, HealthResponse, HubProject, HubProjectsListResponse, IframeTokenErrorMessage, IframeTokenRequestMessage, IframeTokenResponseMessage, InviteApplication, InviteApplicationListResponse, InviteCode, InviteCodeBindRequest, InviteCodeDetailResponse, InviteCodeGenerateResponse, InviteCodeRequiredErrorData, InviteCodeVerifyResponse, InviteStats, InviteStatsResponse, InviteUsage, ListInviteUsagesRequest, ListInviteUsagesResponse, ListInvitesRequest, ListInvitesResponse, LoginRequest, LoginResponse, MarketplaceSkill, MarketplaceSkillsListResponse, OAuthAuthorizeRequest, OAuthAuthorizeResponse, PublishProjectRequest, PublishSkillRequest, RegisterContainerRequest, RegisterContainerResponse, RegisterRequest, RegisterResponse, ResetPasswordRequest, RetryOptions, SeaVerseBackendAPIClientOptions, SocialMediaLink, SocialMediaLinksResponse, SpeechTokenResponse, SubmitInviteApplicationRequest, SuccessResponse, ToastOptions, ToastType, TrackAppTypeRequest, User, UserInstalledSkill, UserInstalledSkillsListResponse, VideoDetails };