@jctrans-materials/comps-vue3 1.0.42-beta.1 → 1.0.42-beta.3

package/dist/components/JcLoginDialog/cmps/AuthBottomTip.d.ts

@@ -1,5 +1,8 @@
+/** 组件属性类型定义 */
 interface Props {
+    /** 当前表单模式：login=登录 / register=注册 */
     formMode: "login" | "register";
+    /** 是否为英文界面 */
     isEn: boolean;
 }
 declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {

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

@@ -1,14 +1,48 @@
 import { ComputedRef } from 'vue';
 import { AreaCodeData, CaptchaData, LoginFormData } from '../loginDialog';
 
+/**
+ * useAuthLogin 配置选项
+ *
+ * 控制登录认证流程的行为，包括成功回调、语言环境、
+ * 完善信息拦截以及测试模式开关。
+ */
 interface AuthOptions {
+    /** 应用标识，默认 "ERA"，用于区分不同业务线的登录请求 */
     appId?: string;
+    /** 是否为英文环境，支持布尔值或计算属性 */
     isEn?: boolean | ComputedRef<boolean>;
+    /** 登录成功后的回调，传入登录返回数据 */
     onSuccess?: (data: any) => void;
+    /** 需要完善企业信息时的回调（improveComp 拦截），传入登录返回数据 */
     onNeedComplete?: (data: any) => void;
+    /** 测试模式：true 时跳过 redirect 与 token 持久化，改为 console.log 打印完整返回值 */
     test?: boolean | ComputedRef<boolean>;
 }
+/**
+ * 登录方式类型
+ * - "account":  账号密码登录
+ * - "code":     手机/邮箱验证码登录
+ * - "wechat":   微信扫码登录
+ * - "TEST":     测试模式
+ * - "linkedin": LinkedIn OAuth 登录
+ * - "facebook": Facebook OAuth 登录
+ */
 type LoginType = "account" | "code" | "wechat" | "TEST" | "linkedin" | "facebook";
+/**
+ * 认证登录组合式函数
+ *
+ * 负责处理三种核心认证场景：
+ * 1. 常规登录（账号密码 / 验证码 / 微信扫码）
+ * 2. 微信绑定已有账号（账号密码绑定 / 验证码绑定）
+ * 3. 登录成功后的统一跳转与完善信息拦截
+ *
+ * 内部包含踢人确认（Kick Confirm）递归流程、improveComp 拦截模式、
+ * 以及测试模式下的登录结果打印。
+ *
+ * @param options - 配置选项，见 {@link AuthOptions}
+ * @returns 返回 loading 状态、登录/绑定方法、跳转方法、完善信息状态标志
+ */
 export declare function useAuthLogin(options?: AuthOptions): {
     loading: import('vue').Ref<boolean, boolean>;
     handleAuthSubmit: (params: {

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

@@ -2,10 +2,30 @@ import { ComputedRef, Ref } from 'vue';
 import { FormInstance } from 'element-plus';
 import { AreaCodeData, CaptchaData, LoginFormData, LoginMethod, LoginType } from '../loginDialog';
 
+/**
+ * useLoginForm 配置选项
+ *
+ * 提供登录表单所需的响应式依赖项。
+ */
 interface UseLoginFormOptions {
+    /** 是否为英文环境（计算属性，由父组件传入） */
     isEn: ComputedRef<boolean>;
+    /** 当前登录方式（响应式引用，表单内部可修改以触发视图切换） */
     loginType: Ref<LoginType>;
 }
+/**
+ * 登录表单管理组合式函数
+ *
+ * 负责登录表单的所有核心交互逻辑：
+ * 1. 表单状态管理 —— 维护 loginForm、verifyData、areaCodeData 等响应式状态
+ * 2. 表单校验规则 —— 根据登录方式（account/code）动态生成 Element Plus 校验规则
+ * 3. 验证码发送 —— 调用短信/邮件发送 API，处理 NO_ACCOUNT 特殊场景
+ * 4. 登录方式切换 —— 切换 account/code/wechat 时重置表单状态与校验凭证
+ * 5. 区号加载 —— 根据 IP 自动定位区号，支持手动切换区号
+ *
+ * @param options - 配置选项，见 {@link UseLoginFormOptions}
+ * @returns 返回表单 ref、状态字段、校验规则、交互方法
+ */
 export declare function useLoginForm(options: UseLoginFormOptions): {
     loginFormRef: Ref<FormInstance | undefined, FormInstance | undefined>;
     loginForm: Ref<{

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

@@ -1,15 +1,36 @@
 import { ComputedRef } from 'vue';
 
+/**
+ * 第三方 OAuth 登录配置接口
+ *
+ * 定义 Facebook / LinkedIn 登录流程所需的全部配置项，
+ * 包括应用标识、回调钩子以及测试模式开关。
+ */
 interface ThirdPartyConfig {
+    /** 应用标识（如 "CPA"），用于区分不同业务线的登录请求 */
     appId: string;
+    /** OAuth 认证服务的基础 URL */
     baseUrl?: string;
+    /** 登录成功后的跳转路径 */
     redirectPath?: string;
+    /** 是否为英文环境，支持布尔值或计算属性 */
     isEn?: boolean | ComputedRef<boolean>;
+    /** 直接登录成功的回调（无需绑定/注册时触发） */
     onSuccess?: (data: any) => void;
+    /** 登录失败时的回调 */
     onError?: (error: any) => void;
+    /** 需要账号绑定时回调，传入冲突账号列表 */
     onNeedBind?: (list: any[]) => void;
+    /** 需要完善企业信息时的回调（improveComp 拦截） */
+    onNeedComplete?: (data: any) => void;
+    /** 测试模式：true 时跳过 redirect 与 token 持久化，改为 console.log 打印完整返回值 */
     test?: boolean | ComputedRef<boolean>;
 }
+/**
+ * 从 sessionStorage 读取第三方登录信息
+ *
+ * @returns 包含 thirdPartyId、thirdPartyEmail、thirdPartyType、thirdPartyUserName、mobileEmailList 的对象
+ */
 export declare const getThirdPartySessions: () => {
     thirdPartyId: string;
     thirdPartyEmail: string;
@@ -17,6 +38,7 @@ export declare const getThirdPartySessions: () => {
     thirdPartyUserName: string;
     mobileEmailList: any;
 };
+/** 设置第三方邮箱验证列表到 sessionStorage */
 export declare const setThirdPartyEmailVerifyList: (data: any[]) => void;
 export declare const getThirdPartyEmailVerifyList: () => any;
 export declare const setThirdPartyMobileVerifyList: (data: any[]) => void;