@jctrans-materials/comps-vue3 1.0.32 → 1.0.33-beta.1

package/dist/components/JcLoginDialog/composables/useThirdPartyLogin.d.ts

@@ -14,6 +14,54 @@ export declare const getThirdPartySessions: () => {
     thirdPartyUserName: string;
     mobileEmailList: any;
 };
+/**
+ * 第三方 OAuth 登录组合式函数（Facebook、LinkedIn）
+ *
+ * 管理完整的 OAuth 流程，包括：
+ * - 打开认证弹窗
+ * - 通过 postMessage 接收并验证授权码
+ * - 处理登录成功/失败状态
+ * - 管理绑定和注册对话框
+ * - 防止弹窗检测和消息处理之间的竞态条件
+ *
+ * @param {ThirdPartyConfig} 配置 - 包含以下属性的配置对象：
+ *   - appId: 应用标识符（例如："CPA"）
+ *   - redirectPath: 登录后的重定向目标
+ *   - isEn: 语言标志，用于错误消息
+ *   - onSuccess: 登录成功时的回调函数
+ *   - onNeedBind: 需要账号绑定时的回调函数
+ *   - onError: 登录失败时的回调函数
+ *
+ * @returns {Object} 登录组合式接口，包含：
+ *   - isLoading: 布尔响应式引用，表示登录操作是否进行中
+ *   - isBindDialogVisible: 布尔响应式引用，控制绑定对话框的可见性
+ *   - isRegisterVisible: 布尔响应式引用，控制注册对话框的可见性
+ *   - isUserClosed: 布尔响应式引用，表示用户是否手动关闭了弹窗
+ *   - bindList: 数组响应式引用，存储需要绑定的账号列表
+ *   - loginResult: 对象响应式引用，存储登录响应数据
+ *   - startLogin: 函数，用于启动 OAuth 登录流程，参数为 ("FACEBOOK" | "LINKEDIN" | "TEST")
+ *   - resetState: 函数，完全重置所有登录状态并清理监听器
+ *
+ * @remarks
+ * - 使用实例锁（hookInstanceId）处理多个同时进行的登录尝试
+ * - 通过 isHandlingMessage 标志实现竞态条件防止
+ * - 根据允许列表验证 postMessage 来源，保证安全性
+ * - 支持生产和预发布环境，使用不同的 OAuth 端点
+ * - 组件卸载时自动清理事件监听器和定时器
+ *
+ * @example
+ * ```typescript
+ * const { startLogin, isLoading, isBindDialogVisible } = useThirdPartyLogin({
+ *   appId: "CPA",
+ *   redirectPath: "/dashboard",
+ *   onSuccess: (data) => console.log("登录成功", data),
+ *   onNeedBind: (list) => console.log("需要绑定", list)
+ * });
+ *
+ * // 触发登录
+ * startLogin("FACEBOOK");
+ * ```
+ */
 export declare function useThirdPartyLogin(config: ThirdPartyConfig): {
     isLoading: import('vue').Ref<boolean, boolean>;
     isBindDialogVisible: import('vue').Ref<boolean, boolean>;