@authing/guard-shim-react 4.5.40-alpha.2 → 4.5.40-alpha.21

package/dist/typings/src/ChangeLanguage/index.d.ts

@@ -4,6 +4,6 @@ export declare const LngTextMapping: Record<Lang, {
     label: string;
 }>;
 export declare const ChangeLanguage: (props: {
-    onLangChange?: ((lang: Lang) => void) | undefined;
-    langRange?: Lang[] | undefined;
+    onLangChange?: (lang: Lang) => void;
+    langRange?: Lang[];
 }) => JSX.Element | null;

package/dist/typings/src/CompleteInfo/interface.d.ts

@@ -21,7 +21,7 @@ export interface GuardCompleteInfoViewProps extends GuardCompleteInfoProps {
     initData: any;
     onLogin?: any;
 }
-export declare type ExtendsFieldType = 'user' | 'internal';
+export type ExtendsFieldType = 'user' | 'internal';
 export interface ExtendsField {
     type: ExtendsFieldType;
     name: string;

package/dist/typings/src/Guard/GuardModule/stateMachine.d.ts

@@ -14,7 +14,7 @@ export interface StateMachineLog {
     date: number;
     dataSource: ModuleState;
 }
-export declare type ChangeModuleEvent = (nextModule: GuardModuleType, initData?: any) => void;
+export type ChangeModuleEvent = (nextModule: GuardModuleType, initData?: any) => void;
 export declare class GuardStateMachine {
     private order;
     private config;

package/dist/typings/src/Guard/authClient.d.ts

@@ -1,14 +1,12 @@
 import { AuthenticationClient } from 'authing-js-sdk';
 import { GuardLocalConfig } from './config';
-declare let authClient: AuthenticationClient;
 export declare const initGuardAuthClient: (config: GuardLocalConfig, appId: string, tenantId?: string) => AuthenticationClient;
 export declare const useInitGuardAuthClient: (props: {
-    config?: GuardLocalConfig | undefined;
-    appId?: string | undefined;
-    authClient?: AuthenticationClient | undefined;
+    config?: GuardLocalConfig;
+    appId?: string;
+    authClient?: AuthenticationClient;
     setError?: any;
-    tenantId?: string | undefined;
+    tenantId?: string;
 }) => AuthenticationClient | undefined;
 export declare const getGuardAuthClient: () => AuthenticationClient;
 export declare const useGuardAuthClient: () => AuthenticationClient;
-export {};

package/dist/typings/src/Guard/core/hooks/useMultipleAccounts.d.ts

@@ -13,7 +13,7 @@ export declare const QR_CODE_WAY: LoginWay[];
  * 登录时所有支持的登录列表(前端定义列表)
  * 这里稍微有点乱 因为Login中的登录方式和这里的不匹配，暂时放在了一起
  */
-export declare type LoginWay = 'email' | 'phone' | 'password' | 'phone-code' | 'email-code' | 'social' | 'wechat-miniprogram-qrcode' | 'wechatmp-qrcode' | 'app-qrcode' | 'zjzwfw-qrcode' | 'ad' | 'ldap' | 'ldap-password' | 'ldap-email' | 'ldap-phone' | 'authing-otp-push';
+export type LoginWay = 'email' | 'phone' | 'password' | 'phone-code' | 'email-code' | 'social' | 'wechat-miniprogram-qrcode' | 'wechatmp-qrcode' | 'app-qrcode' | 'zjzwfw-qrcode' | 'ad' | 'ldap' | 'ldap-password' | 'ldap-email' | 'ldap-phone' | 'authing-otp-push';
 /**
  * when： 多账号页面跳转进入登录页面
  * 携带的回填数据信息
@@ -27,7 +27,7 @@ export interface BackFillMultipleState extends Omit<User, 'id' | 'name' | 'nickn
 /**
  * Store instance
  */
-export declare type StoreInstance = ReturnType<MultipleAccount['getStore']>;
+export type StoreInstance = ReturnType<MultipleAccount['getStore']>;
 /**
  * 当前 userId 对应的类型
  */
@@ -248,18 +248,18 @@ declare class MultipleAccount {
         }) => void;
         setUserInfo: (user: Omit<User & {
             id: string;
-            loginAccount?: string | undefined;
-            usertype?: string | undefined;
-        }, "way" | "tab" | "phoneCountryCode">) => void;
+            loginAccount?: string;
+            usertype?: string;
+        }, 'way' | 'tab' | 'phoneCountryCode'>) => void;
         setLoginWayByHttpData: (account: string, data: {
-            username?: string | undefined;
-            phone?: string | undefined;
-            email?: string | undefined;
+            username?: string;
+            phone?: string;
+            email?: string;
         }) => void;
         setLoginWayByLDAPData: (account: string, data: {
-            name?: string | undefined;
-            phone?: string | undefined;
-            email?: string | undefined;
+            name?: string;
+            phone?: string;
+            email?: string;
         }) => void;
         getMemoUser: (excludeWays?: LoginWay[]) => SelectOptions[];
         getMemoSingleUser: (id: string) => {
@@ -278,7 +278,7 @@ declare class MultipleAccount {
  * Finally Config 类型过滤
  */
 declare const useSelectAccounts: ({ appId, finallyConfig }: {
-    appId?: string | undefined;
+    appId?: string;
     finallyConfig?: any;
 }) => {
     instance: {
@@ -292,18 +292,18 @@ declare const useSelectAccounts: ({ appId, finallyConfig }: {
         }) => void;
         setUserInfo: (user: Omit<User & {
             id: string;
-            loginAccount?: string | undefined;
-            usertype?: string | undefined;
-        }, "way" | "tab" | "phoneCountryCode">) => void;
+            loginAccount?: string;
+            usertype?: string;
+        }, 'way' | 'tab' | 'phoneCountryCode'>) => void;
         setLoginWayByHttpData: (account: string, data: {
-            username?: string | undefined;
-            phone?: string | undefined;
-            email?: string | undefined;
+            username?: string;
+            phone?: string;
+            email?: string;
         }) => void;
         setLoginWayByLDAPData: (account: string, data: {
-            name?: string | undefined;
-            phone?: string | undefined;
-            email?: string | undefined;
+            name?: string;
+            phone?: string;
+            email?: string;
         }) => void;
         getMemoUser: (excludeWays?: LoginWay[]) => SelectOptions[];
         getMemoSingleUser: (id: string) => {

package/dist/typings/src/Guard/module.d.ts

@@ -1,38 +1,38 @@
 export declare enum GuardModuleType {
-    ERROR = "error",
-    LOGIN = "login",
-    REGISTER = "register",
-    MFA = "mfa",
-    FORGET_PWD = "forgetPassword",
-    FORCED_PASSWORD_RESET = "forcedPasswordReset",
-    NOTICE_PASSWORD_RESET = "noticePasswordReset",
-    FIRST_LOGIN_PASSWORD = "firstLoginPassword",
-    UNSAFE_PASSWORD_RESET = "unsafePasswordReset",
-    DOWNLOAD_AT = "downloadAT",
-    BIND_TOTP = "bindTotp",
-    ANY_QUESTIONS = "anyQuestions",
-    LOGIN_COMPLETE_INFO = "loginCompleteInfo",
-    REGISTER_PASSWORD = "registerPassword",
-    REGISTER_COMPLETE_INFO = "registerCompleteInfo",
-    RECOVERY_CODE = "recoveryCode",
-    SUBMIT_SUCCESS = "submitSuccess",
-    IDENTITY_BINDING_ASK = "identityBindingAsk",
-    IDENTITY_BINDING = "identityBinding",
-    IDENTITY_BINDING_NO_ASK = "identityBindingNoAsk",
-    SELF_UNLOCK = "selfUnlock",
-    FLOW_SELECT_ACCOUNT = "flowSelectAccount",
+    ERROR = "error",//错误页
+    LOGIN = "login",//登录页
+    REGISTER = "register",//注册页
+    MFA = "mfa",// 二次 mfa 认证页
+    FORGET_PWD = "forgetPassword",// 忘记密码页
+    FORCED_PASSWORD_RESET = "forcedPasswordReset",// 登陆安全策略 密码轮换页
+    NOTICE_PASSWORD_RESET = "noticePasswordReset",//提示修改密码页
+    FIRST_LOGIN_PASSWORD = "firstLoginPassword",//首次登录修改密码页
+    UNSAFE_PASSWORD_RESET = "unsafePasswordReset",// 密码强度不符合要求修改密码页
+    DOWNLOAD_AT = "downloadAT",//下载 Authenticator 页
+    BIND_TOTP = "bindTotp",// 绑定 TOTP页
+    ANY_QUESTIONS = "anyQuestions",// 问题反馈页
+    LOGIN_COMPLETE_INFO = "loginCompleteInfo",// 登录信息补全
+    REGISTER_PASSWORD = "registerPassword",// 验证码注册拉起密码补全页
+    REGISTER_COMPLETE_INFO = "registerCompleteInfo",//注册信息补全页
+    RECOVERY_CODE = "recoveryCode",// MFA 恢复码展示页
+    SUBMIT_SUCCESS = "submitSuccess",// 提交成功展示页
+    IDENTITY_BINDING_ASK = "identityBindingAsk",// 身份源绑定 问询页
+    IDENTITY_BINDING = "identityBinding",// 身份源绑定页
+    IDENTITY_BINDING_NO_ASK = "identityBindingNoAsk",// 身份源绑定页不问询
+    SELF_UNLOCK = "selfUnlock",// 自助解锁页
+    FLOW_SELECT_ACCOUNT = "flowSelectAccount",// 选择登录账号
     /** 多租户门户选择页 */
     TENANT_PORTAL = "tenant-portal",
-    New_SUBMIT_SUCCESS = "newSubmitSuccess",
-    SELECT_ACCOUNT_2_LOGIN = "selectAccout2Login",
+    New_SUBMIT_SUCCESS = "newSubmitSuccess",// 提交成功展示页
+    SELECT_ACCOUNT_2_LOGIN = "selectAccout2Login",// 选择登录身份
     RESET_ACCOUNT_NAME = "resetAccountName",
     APPLY_INVITATION = "applyInvitation",
     MESSAGE = "message",
     INVITE_AUTH = "inviteAuth",
     INVITE_COMPLETE = "inviteComplete",
-    INVITE_EXPIRE = "inviteExpire",
-    INVITE_PAGE_EXPIRE = "invitePageExpire",
-    INVITE_SUCCESS = "inviteSuccess",
+    INVITE_EXPIRE = "inviteExpire",// 邀请链接过期
+    INVITE_PAGE_EXPIRE = "invitePageExpire",// 页面过期
+    INVITE_SUCCESS = "inviteSuccess",// 邀请成功
     RESET_PASSWORD = "resetPassword"
 }
 export interface GuardModuleAction {

package/dist/typings/src/Invitation/interface.d.ts

@@ -63,4 +63,4 @@ export declare const useRegisterHandleHook: (initData: any, submitButtonRef?: {
     current: {
         onSpin: (arg0: boolean) => void;
     };
-} | undefined) => (context: any) => Promise<void>;
+}) => (context: any) => Promise<void>;

package/dist/typings/src/Login/core/withAuthingOtpPush/types.d.ts

@@ -10,7 +10,7 @@ export interface OnLoginProps {
     account: string;
     agreementIds?: (string | number)[];
 }
-export declare type LoginStatus = 'before' | 'pending';
+export type LoginStatus = 'before' | 'pending';
 export interface LoginWithAuthingOtpPushProps {
     onLoginSuccess?: any;
     multipleInstance?: StoreInstance;
@@ -21,9 +21,9 @@ export interface PushLoginGudeModalProps {
     visible: boolean;
     onClose: () => void;
 }
-export declare type Selector = 'howUsePushLogin' | 'howBindClient' | 'howGetAppLoginUrl';
+export type Selector = 'howUsePushLogin' | 'howBindClient' | 'howGetAppLoginUrl';
 export interface SelectorOption {
     value: Selector;
     label: string;
 }
-export declare type SelectorOptions = SelectorOption[];
+export type SelectorOptions = SelectorOption[];

package/dist/typings/src/MFA/businessRequest.d.ts

@@ -35,7 +35,7 @@ interface AssociateFaceContent {
     isExternalPhoto?: boolean;
     mfaToken?: string;
 }
-declare type BindPasskeyContent = PublicKeyCredentialWithAttestationJSON;
+type BindPasskeyContent = PublicKeyCredentialWithAttestationJSON;
 interface VerifyPasskeyContent {
     credential: PublicKeyCredentialWithAssertionJSON;
     ticket: string;

package/dist/typings/src/MFA/core/passkey.d.ts

@@ -9,7 +9,7 @@ interface VerifyPasskeyProps {
     mfaToken: string;
     mfaLogin: (code: any, data: any, message?: string) => void;
 }
-export declare type MFAPasskeyProps = BindPasskeyProps & VerifyPasskeyProps & {
+export type MFAPasskeyProps = BindPasskeyProps & VerifyPasskeyProps & {
     passkeyEnabled: boolean;
 };
 export declare const MFAPasskey: React.FC<MFAPasskeyProps>;

package/dist/typings/src/Qrcode/UiQrCode.d.ts

@@ -1,7 +1,7 @@
 import { React } from 'shim-react';
 import './index.less';
 import { CodeStatusDescriptions } from './WorkQrCode';
-export declare type CodeStatus = 'loading' | 'ready' | 'already' | 'success' | 'error' | 'expired' | 'cancel' | 'MFA';
+export type CodeStatus = 'loading' | 'ready' | 'already' | 'success' | 'error' | 'expired' | 'cancel' | 'MFA';
 export declare const prefix = "refactor";
 export interface UiQrProps {
     /**

package/dist/typings/src/Qrcode/WorkQrCode.d.ts

@@ -4,7 +4,7 @@ import { CodeStatus, UiQrProps } from './UiQrCode';
 /**
  * 二维码不同状态下的底部描述文字
  */
-export declare type CodeStatusDescriptions = Partial<Record<Exclude<CodeStatus, 'loading'>, React.ReactNode | ((referQrCode?: () => void) => React.ReactNode)>>;
+export type CodeStatusDescriptions = Partial<Record<Exclude<CodeStatus, 'loading'>, React.ReactNode | ((referQrCode?: () => void) => React.ReactNode)>>;
 export interface WorkQrCodeRef {
     referQrCode: () => Promise<{
         random: string;

package/dist/typings/src/Qrcode/hooks/useImage.d.ts

@@ -1,4 +1,4 @@
 declare const useImage: (src: string | undefined, options: {
-    onLoad?: (() => void) | undefined;
+    onLoad?: () => void;
 }) => (string | undefined)[];
 export { useImage };

package/dist/typings/src/Qrcode/hooks/usePreQrCode.d.ts

@@ -1,7 +1,7 @@
 import { React } from 'shim-react';
 import { CodeStatus } from '../UiQrCode';
-export declare type ReducerType = 'change' | 'changeStatus' | 'changeDesc';
-export declare type RootState = {
+export type ReducerType = 'change' | 'changeStatus' | 'changeDesc';
+export type RootState = {
     /**
      * 状态
      */

package/dist/typings/src/Qrcode/index.d.ts

@@ -1,9 +1,9 @@
 import { UiQrCode, LinkQrcode } from './UiQrCode';
 import { WorkQrCode, WorkGeneQrCode } from './WorkQrCode';
-declare type IQrCode = typeof WorkQrCode & {
+type IQrCode = typeof WorkQrCode & {
     UI: typeof UiQrCode;
 };
-declare type IGeneQrCode = typeof WorkGeneQrCode & {
+type IGeneQrCode = typeof WorkGeneQrCode & {
     UI: typeof LinkQrcode;
 };
 declare const QrCode: IQrCode;

package/dist/typings/src/SelfUnlock/core/selfUnlock.d.ts

@@ -4,5 +4,5 @@ export declare enum InputMethodMap {
     phone = "phone-code"
 }
 export declare const SelfUnlock: ({ identifyRef }: {
-    identifyRef?: React.MutableRefObject<string> | undefined;
+    identifyRef?: React.MutableRefObject<string>;
 }) => JSX.Element;

package/dist/typings/src/TenantPortalSelect/interface.d.ts

@@ -31,7 +31,7 @@ export interface TenantPortalEvents extends IG2Events {
     /** 租户门户选择回调 */
     onTenantSelect?: (data?: TenantPortalSelectType) => void;
 }
-export declare type TenantView = 'default' | 'join' | 'create';
+export type TenantView = 'default' | 'join' | 'create';
 export interface TenantButtonProps {
     className?: string;
     onClick?: () => void;

package/dist/typings/src/Type/application.d.ts

@@ -1,4 +1,4 @@
-export declare type Lang = 'zh-CN' | 'en-US' | 'zh-TW' | 'ja-JP';
+export type Lang = 'zh-CN' | 'en-US' | 'zh-TW' | 'ja-JP';
 import { MFAType } from '../MFA/interface';
 import { PasswordStrength } from '../_utils';
 export * from 'authing-js-sdk';
@@ -7,16 +7,16 @@ export declare enum LoginMethods {
     AppQr = "app-qrcode",
     Password = "password",
     PhoneCode = "phone-code",
-    EmailCode = "email-code",
-    WxMinQr = "wechat-miniprogram-qrcode",
-    AD = "ad",
-    WechatMpQrcode = "wechatmp-qrcode",
-    AuthingOtpPush = "authing-otp-push",
-    WechatworkCorpQrconnect = "wechatwork-corp-qrconnect",
-    WECHATWORKQRCONNECTOFAUTHINGAGENCY = "wechatwork-authing-agency-qrcode",
-    WECHATWORKAGENCYQRCONNECT = "wechatwork-agency-qrcode",
-    DingTalkQrcode = "dingtalk-qrcode",
-    Passkey = "passkey",
+    EmailCode = "email-code",// 这是前端单独加的，后端只会返回 phone-code
+    WxMinQr = "wechat-miniprogram-qrcode",// 对应社会化登录的 wechat:miniprogram:qrconnect(小程序扫码登录)
+    AD = "ad",// 对应企业身份源的 Windows AD 登录
+    WechatMpQrcode = "wechatmp-qrcode",// 微信扫码关注登录
+    AuthingOtpPush = "authing-otp-push",// App 扫码登录
+    WechatworkCorpQrconnect = "wechatwork-corp-qrconnect",// 微信企业扫码关注登录
+    WECHATWORKQRCONNECTOFAUTHINGAGENCY = "wechatwork-authing-agency-qrcode",// 代开发形式的以 authing 作为内部应用
+    WECHATWORKAGENCYQRCONNECT = "wechatwork-agency-qrcode",// 代开发形式的内部应用
+    DingTalkQrcode = "dingtalk-qrcode",//钉钉扫码
+    Passkey = "passkey",// passkey
     ZJZWFWQrcode = "zjzwfw-qrcode"
 }
 export declare enum OIDCConnectionMode {
@@ -37,8 +37,8 @@ export declare enum SocialConnectionProvider {
     WECHATWORK_ADDRESS_BOOK = "wechatwork:addressbook",
     WECHATWORK_CORP_QRCONNECT = "wechatwork:corp:qrconnect",
     WECHATWORK_SERVICEPROVIDER_QRCONNECT = "wechatwork:service-provider:qrconnect",
-    WECHATWORK_QRCONNECT_OF_AUTHING_AGENCY = "wechatwork:qrconnect:of:authing:agency",
-    WECHATWORK_AGENCY_QRCONNECT = "wechatwork:agency:qrconnect",
+    WECHATWORK_QRCONNECT_OF_AUTHING_AGENCY = "wechatwork:qrconnect:of:authing:agency",// 代开发形式的以 authing 作为内部应用
+    WECHATWORK_AGENCY_QRCONNECT = "wechatwork:agency:qrconnect",// 代开发形式的内部应用
     DINGTALK = "dingtalk",
     WEIBO = "weibo",
     APPLE = "apple",
@@ -135,7 +135,7 @@ export interface QrCodeItem {
         authorizationUrl?: string;
     };
 }
-export declare type QrcodeTabsSettings = Record<LoginMethods, Array<QrCodeItem>>;
+export type QrcodeTabsSettings = Record<LoginMethods, Array<QrCodeItem>>;
 export interface OidcClientMetadata {
     grant_types: string[];
     client_id: string;
@@ -170,7 +170,7 @@ export interface UserExtendsField {
     required: boolean;
     validateRules: any[];
 }
-export declare type ExtendsField = InternalExtendsField | UserExtendsField;
+export type ExtendsField = InternalExtendsField | UserExtendsField;
 export interface ApplicationPasswordTabConfig {
     enabledLoginMethods?: PasswordLoginMethods[];
     validRegisterMethods?: string[];
@@ -188,9 +188,9 @@ export interface Agreement {
     lang: Lang;
     availableAt?: number;
 }
-export declare type PasswordLoginMethods = 'username-password' | 'email-password' | 'phone-password';
-export declare type VerifyLoginMethods = 'email-code' | 'phone-code';
-export declare type ComplateFiledsPlace = 'register' | 'login';
+export type PasswordLoginMethods = 'username-password' | 'email-password' | 'phone-password';
+export type VerifyLoginMethods = 'email-code' | 'phone-code';
+export type ComplateFiledsPlace = 'register' | 'login';
 export interface TabFieldsI18nItem {
     key: string;
     label: string;

package/dist/typings/src/ValidatorRules/index.d.ts

@@ -21,7 +21,7 @@ export interface ValidatorFormItemMetaProps extends ValidatorFormItemProps {
 export interface ICheckProps {
     check: (values: any) => void;
 }
-declare type InternalFormItemType = typeof Form.Item;
+type InternalFormItemType = typeof Form.Item;
 interface FormItemInterface extends InternalFormItemType {
     Password: typeof PasswordFormItem;
     Email: typeof EmailFormItem;

package/dist/typings/src/_utils/http.d.ts

@@ -5,7 +5,7 @@ export declare const requestClient: {
     get<T>(path: string, query?: Record<string, any>, init?: AxiosRequestConfig): Promise<AuthingResponse<T>>;
     post<T_1>(path: string, data: any, config?: {
         headers: any;
-    } | undefined): Promise<AuthingResponse<T_1>>;
+    }): Promise<AuthingResponse<T_1>>;
     postForm<T_2>(path: string, formData: any, config?: {
         headers: any;
     }): Promise<AuthingResponse<T_2>>;

package/dist/typings/src/_utils/index.d.ts

@@ -14,7 +14,7 @@ export declare const validate: (type: keyof typeof VALIDATE_PATTERN, val: string
 export declare const getRequiredRules: (msg: string) => Rule[];
 export declare const fieldRequiredRule: (fieldRequiredRule: string, fieldRequiredRuleMessage?: string) => Rule[];
 export declare function getDeviceName(): string | null | undefined;
-export declare type STYLE_RECORD_KEY = 'appConfig' | 'userConfig';
+export type STYLE_RECORD_KEY = 'appConfig' | 'userConfig';
 export declare const insertStyles: (styles: string | any, recordKey?: STYLE_RECORD_KEY) => void;
 export declare const removeStyles: (recordKey: STYLE_RECORD_KEY) => void;
 export declare const getClassnames: (classnames: (string | boolean | undefined)[]) => string;

package/dist/typings/src/_utils/locales/index.d.ts

@@ -6,4 +6,5 @@ export interface InitGuardI18nOptions {
 }
 export declare const fallbackLng: (code?: string) => string[];
 export declare const initGuardI18n: (options: InitGuardI18nOptions, callback: React.Dispatch<React.SetStateAction<boolean>>) => Promise<void>;
+export declare const resolvedLanguage: string;
 export { i18n };

package/dist/typings/src/_utils/responseManagement/interface.d.ts

@@ -22,8 +22,8 @@ export declare enum ApiCode {
     FLOW_SELECT_ACCOUNT = 2921,
     TENANT_PORTAL = 1644,
     SELECT_ACCOUNT_2_LOGIN = 2930,
-    RESET_ACCOUNT_NAME = 1108,
-    INVITE_EXPIRE = 4032,
+    RESET_ACCOUNT_NAME = 1108,// 用户名重复
+    INVITE_EXPIRE = 4032,// 链接过期
     INVITE_PAGE_EXPIRE = 4033
 }
 export declare const ChangeModuleApiCodeMapping: Record<string, GuardModuleType>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authing/guard-shim-react",
-  "version": "4.5.40-alpha.2",
+  "version": "4.5.40-alpha.21",
   "description": "Guard shim for react 16 / 17, only be used to internal",
   "types": "dist/typings/src/index.d.ts",
   "module": "dist/guard.min.js",