@authing/react-ui-components 3.1.1 → 3.1.3

package/src/components/AuthingGuard/types/GuardConfig.ts

@@ -1,424 +0,0 @@
-import {
-  AuthenticationClient,
-  AuthenticationClientOptions,
-  CommonMessage,
-  SocialConnectionProvider,
-  User,
-} from 'authing-js-sdk'
-import { QrCodeAuthenticationClient } from 'authing-js-sdk/build/main/lib/authentication/QrCodeAuthenticationClient'
-
-import {
-  SocialConnectionItem,
-  EnterpriseConnectionItem,
-  ApplicationConfig,
-  PasswordLoginMethods,
-  Agreement,
-  QrcodeTabsSettings,
-} from '../../../components/AuthingGuard/api'
-import { Lang } from './Locales'
-
-export type { AuthenticationClient, CommonMessage, User } from 'authing-js-sdk'
-
-export enum GuardMode {
-  Modal = 'modal',
-  Normal = 'normal',
-}
-
-export enum LoginMethods {
-  LDAP = 'ldap',
-  AppQr = 'app-qrcode',
-  Password = 'password',
-  PhoneCode = 'phone-code',
-  WxMinQr = 'wechat-miniprogram-qrcode', // 对应社会化登录的 wechat:miniprogram:qrconnect(小程序扫码登录)
-  AD = 'ad', // 对应企业身份源的 Windows AD 登录
-  WechatMpQrcode = 'wechatmp-qrcode', // 微信扫码关注登录
-}
-
-export enum RegisterMethods {
-  Email = 'email',
-  Phone = 'phone',
-}
-
-export enum GuardScenes {
-  Login = 'login',
-  Register = 'register',
-  MfaVerify = 'mfaVerify',
-  AppMfaVerify = 'appMfaVerify',
-  RestPassword = 'restPassword',
-  CompleteUserInfo = 'completeUserInfo',
-}
-
-export enum ResetPwdMethods {
-  Email = 'email',
-  Phone = 'phone',
-}
-
-export enum SocialConnections {
-  Qq = 'qq',
-  Weibo = 'weibo',
-  Github = 'github',
-  Google = 'google',
-  WxPc = 'wechat:pc',
-  Dingtalk = 'dingtalk',
-  WxWCorpQr = 'wechatwork:corp:qrconnect',
-  WxWSPQr = 'wechatwork:service-provider:qrconnect',
-  WxWSPAuth = 'wechatwork:service-provider:authorization',
-  AlipayWeb = 'alipay:web',
-  AppleWeb = 'apple:web',
-  Baidu = 'baidu',
-  LarkInternalApp = 'lark-internal',
-  LarkMarketPlaceApp = 'lark-public',
-}
-
-export enum Protocol {
-  AD = 'ad',
-  CAS = 'cas',
-  LDAP = 'ldap',
-  OIDC = 'oidc',
-  SAML = 'saml',
-  OAUTH = 'oauth',
-  AZURE_AD = 'azure-ad',
-}
-
-// export enum GuardEventsKebab {
-//   // 加载完成，userPool 配置和应用配置（如果有 appId）加载完成
-//   Load = 'load',
-//   // 加载失败
-//   LoadError = 'load-error',
-//   // 用户登录成功
-//   Login = 'login',
-//   // 用户登录失败
-//   LoginError = 'login-error',
-//   // 注册成功
-//   Register = 'register',
-//   // 注册失败
-//   RegisterError = 'register-error',
-//   // 忘记密码邮件发送成功
-//   PwdEmailSend = 'pwd-email-send',
-//   // 忘记密码邮件发送失败
-//   PwdEmailSendError = 'pwd-email-send-error',
-//   // 忘记密码手机验证码发送成功
-//   PwdPhoneSend = 'pwd-phone-send',
-//   // 忘记密码手机验证码发送失败
-//   PwdPhoneSendError = 'pwd-phone-send-error',
-//   // 重置密码成功
-//   PwdReset = 'pwd-reset',
-//   // 重置密码失败
-//   PwdResetError = 'pwd-reset-error',
-//   // 表单关闭事件
-//   Close = 'close',
-// }
-
-// export interface GuardEventsCamelCase {
-//   // 加载完成，userPool 配置和应用配置（如果有 appId）加载完成
-//   [GuardEvents.Load]: 'onLoad'
-//   // 加载失败
-//   [GuardEvents.LoadError]: 'onLoadError'
-//   // 用户登录成功
-//   [GuardEvents.Login]: 'onLogin'
-//   // 用户登录失败
-//   [GuardEvents.LoginError]: 'onLoginError'
-//   // 注册成功
-//   [GuardEvents.Register]: 'onRegister'
-//   // 注册失败
-//   [GuardEvents.RegisterError]: 'onRegisterError'
-//   // 忘记密码邮件发送成功
-//   [GuardEvents.PwdEmailSend]: 'onPwdEmailSend'
-//   // 忘记密码邮件发送失败
-//   [GuardEvents.PwdEmailSendError]: 'onPwdEmailSendError'
-//   // 忘记密码手机验证码发送成功
-//   [GuardEvents.PwdPhoneSend]: 'onPwdPhoneSend'
-//   // 忘记密码手机验证码发送失败
-//   [GuardEvents.PwdPhoneSendError]: 'onPwdPhoneSendError'
-//   // 重置密码成功
-//   [GuardEvents.PwdReset]: 'onPwdReset'
-//   // 重置密码失败
-//   [GuardEvents.PwdResetError]: 'onPwdResetError'
-//   // 表单关闭事件
-//   [GuardEvents.Close]: 'onClose'
-// }
-
-// export enum GuardEvents {
-//   // 加载完成，userPool 配置和应用配置（如果有 appId）加载完成
-//   Load = 'onLoad',
-//   // 加载失败
-//   LoadError = 'onLoadError',
-//   // 用户登录成功
-//   Login = 'onLogin',
-//   // 用户登录失败
-//   LoginError = 'onLoginError',
-//   // 注册成功
-//   Register = 'onRegister',
-//   // 注册失败
-//   RegisterError = 'onRegisterError',
-//   // 忘记密码邮件发送成功
-//   PwdEmailSend = 'onPwdEmailSend',
-//   // 忘记密码邮件发送失败
-//   PwdEmailSendError = 'onPwdEmailSendError',
-//   // 忘记密码手机验证码发送成功
-//   PwdPhoneSend = 'onPwdPhoneSend',
-//   // 忘记密码手机验证码发送失败
-//   PwdPhoneSendError = 'onPwdPhoneSendError',
-//   // 重置密码成功
-//   PwdReset = 'onPwdReset',
-//   // 重置密码失败
-//   PwdResetError = 'onPwdResetError',
-//   // 表单关闭事件
-//   Close = 'onClose',
-// }
-
-export const GuardEventsCamelToKebabMap = {
-  onLoad: 'load',
-  onLoadError: 'load-error',
-  onLogin: 'login',
-  onBeforeLogin: 'before-login',
-  onLoginError: 'login-error',
-  onRegister: 'register',
-  onBeforeRegister: 'before-register',
-  onRegisterError: 'register-error',
-  onPwdEmailSend: 'pwd-email-send',
-  onPwdEmailSendError: 'pwd-email-send-error',
-  onPwdPhoneSend: 'pwd-phone-send',
-  onPwdPhoneSendError: 'pwd-phone-send-error',
-  onPwdReset: 'pwd-reset',
-  onPwdResetError: 'pwd-reset-error',
-  onClose: 'close',
-  onLoginTabChange: 'login-tab-change',
-  onRegisterTabChange: 'register-tab-change',
-  onRegisterInfoCompleted: 'register-info-completed',
-  onRegisterInfoCompletedError: 'register-info-completed-error',
-} as const
-
-export interface GuardEventsHandlerKebab {
-  // 加载完成，userPool 配置和应用配置（如果有 appId）加载完成
-  load: GuardEventsHandler['onLoad']
-  // 加载失败
-  'load-error': GuardEventsHandler['onLoadError']
-  // 登录前，即表单校验完成，请求接口前
-  'before-login': GuardEventsHandler['onBeforeLogin']
-  // 用户登录成功
-  login: GuardEventsHandler['onLogin']
-  // 用户登录失败
-  'login-error': GuardEventsHandler['onLoginError']
-  // 注册前，即表单校验完成，请求接口前
-  'before-register': GuardEventsHandler['onBeforeRegister']
-  // 注册成功
-  register: GuardEventsHandler['onRegister']
-  // 注册失败
-  'register-error': GuardEventsHandler['onRegisterError']
-  // 忘记密码邮件发送成功
-  'pwd-email-send': GuardEventsHandler['onPwdEmailSend']
-  // 忘记密码邮件发送失败
-  'pwd-email-send-error': GuardEventsHandler['onPwdEmailSendError']
-  // 忘记密码手机验证码发送成功
-  'pwd-phone-send': GuardEventsHandler['onPwdPhoneSend']
-  // 忘记密码手机验证码发送失败
-  'pwd-phone-send-error': GuardEventsHandler['onPwdPhoneSendError']
-  // 重置密码成功
-  'pwd-reset': GuardEventsHandler['onPwdReset']
-  // 重置密码失败
-  'pwd-reset-error': GuardEventsHandler['onPwdResetError']
-  // 表单关闭事件
-  close: GuardEventsHandler['onClose']
-  // 登录的 tab 切换
-  'login-tab-change': GuardEventsHandler['onLoginTabChange']
-  // 注册的 tab 切换
-  'register-tab-change': GuardEventsHandler['onRegisterTabChange']
-  // 注册信息补充完毕
-  'register-info-completed': GuardEventsHandler['onRegisterInfoCompleted']
-  // 注册信息补充失败
-  'register-info-completed-error': GuardEventsHandler['onRegisterInfoCompletedError']
-}
-
-export interface PasswordLoginParams {
-  type: LoginMethods.Password
-  data: {
-    // 标识，可能是用户名、邮箱、手机号
-    identity: string
-    // 密码
-    password: string
-    // 图形验证码
-    captchaCode?: string
-  }
-}
-
-export interface LDAPLoginParams {
-  type: LoginMethods.LDAP
-  data: {
-    // 标识，可能是用户名、邮箱、手机号
-    identity: string
-    // 密码
-    password: string
-    // 图形验证码
-    captchaCode?: string
-  }
-}
-
-export interface ADLoginParams {
-  type: LoginMethods.AD
-  data: {
-    // 标识，可能是用户名、邮箱、手机号
-    identity: string
-    // 密码
-    password: string
-  }
-}
-
-export interface PhoneCodeLoginParams {
-  type: LoginMethods.PhoneCode
-  data: {
-    // 手机号
-    phone: string
-    // 手机验证码
-    code: string
-  }
-}
-
-export interface EmailRegisterParams {
-  type: RegisterMethods.Email
-  data: {
-    // 邮箱
-    email: string
-    // 密码
-    password: string
-  }
-}
-
-export interface PhoneRegisterParams {
-  type: RegisterMethods.Phone
-  data: {
-    // 手机号
-    phone: string
-    // 密码
-    password: string
-    // 手机验证码
-    code: string
-  }
-}
-
-export interface GuardEventsHandler {
-  onLoad?: (authClient: AuthenticationClient) => void
-  onLoadError?: (error: CommonMessage) => void
-  onBeforeLogin?: (
-    loginInfo:
-      | PasswordLoginParams
-      | LDAPLoginParams
-      | ADLoginParams
-      | PhoneCodeLoginParams,
-    authClient: AuthenticationClient
-  ) => boolean | Promise<boolean>
-  onLogin?: (user: User, authClient: AuthenticationClient) => void
-  onLoginError?: (user: User, authClient: AuthenticationClient) => void
-  onBeforeRegister?: (
-    registerInfo: EmailRegisterParams | PhoneRegisterParams,
-    authClient: AuthenticationClient
-  ) => boolean | Promise<boolean>
-  onRegister?: (user: User, authClient: AuthenticationClient) => void
-  onRegisterError?: (user: User, authClient: AuthenticationClient) => void
-  onPwdEmailSend?: (authClient: AuthenticationClient) => void
-  onPwdEmailSendError?: (
-    error: CommonMessage,
-    authClient: AuthenticationClient
-  ) => void
-  onPwdPhoneSend?: (authClient: AuthenticationClient) => void
-  onPwdPhoneSendError?: (
-    error: CommonMessage,
-    authClient: AuthenticationClient
-  ) => void
-  onPwdReset?: (authClient: AuthenticationClient) => void
-  onPwdResetError?: (
-    error: CommonMessage,
-    authClient: AuthenticationClient
-  ) => void
-  onClose?: () => void
-  onLoginTabChange?: (activeTab: LoginMethods) => void
-  onRegisterTabChange?: (activeTab: RegisterMethods) => void
-  onRegisterInfoCompleted?: (
-    user: User,
-    udfs: {
-      definition: any
-      value: any
-    }[],
-    authClient: AuthenticationClient
-  ) => void
-  onRegisterInfoCompletedError?: (
-    error: CommonMessage,
-    udfs: {
-      definition: any
-      value: any
-    }[],
-    authClient: AuthenticationClient
-  ) => void
-}
-
-export interface UserConfig {
-  logo?: string
-  title?: string
-  description?: string
-  zIndex?: number
-  isSSO?: boolean
-  mode?: GuardMode
-  /**
-   * @deprecated 使用 appHost
-   */
-  apiHost?: string
-  /**
-   * @deprecated 使用 appHost
-   */
-  appDomain?: string
-  appHost?: string
-  contentCss?: string
-  text?: {
-    loginBtn?: {
-      normal?: string
-      loading?: string
-    }
-    registerBtn?: {
-      normal?: string
-      loading?: string
-    }
-    // 登录 tab
-    loginTabs?: Partial<Record<LoginMethods, string>>
-  }
-  escCloseable?: boolean
-  autoRegister?: boolean
-  clickCloseable?: boolean
-  disableResetPwd?: boolean
-  disableRegister?: boolean
-  defaultScenes?: GuardScenes
-  loginMethods?: LoginMethods[]
-  target?: string | HTMLElement
-  enterpriseConnections?: string[]
-  defaultLoginMethod?: LoginMethods
-  registerMethods?: RegisterMethods[]
-  socialConnections?: (SocialConnections | SocialConnectionProvider)[]
-  defaultRegisterMethod?: RegisterMethods
-  qrCodeScanOptions?: Parameters<QrCodeAuthenticationClient['startScanning']>[1]
-  /**
-   * 国际化处理
-   */
-  localesConfig?: LocalesConfig
-  lang?: Lang
-  /**
-   * 用于去品牌化
-   */
-  headers?: AuthenticationClientOptions['headers']
-  passwordLoginMethods?: PasswordLoginMethods[]
-}
-
-export interface GuardConfig extends UserConfig {
-  socialConnectionObjs: SocialConnectionItem[]
-  enterpriseConnectionObjs: EnterpriseConnectionItem[]
-  extendsFields: ApplicationConfig['extendsFields']
-  publicKey: ApplicationConfig['publicKey']
-  agreementEnabled: boolean
-  agreements: Agreement[]
-  loginMethodTitleMapping: Record<string, string>
-  qrcodeTabsSettings: QrcodeTabsSettings
-}
-
-export interface LocalesConfig {
-  defaultLang?: Lang
-  isShowChange?: boolean
-  onChange?: (lang: Lang) => void
-}

package/src/components/AuthingGuard/types/GuardState.ts

@@ -1,7 +0,0 @@
-import { LoginMethods, RegisterMethods } from './GuardConfig'
-import { GuardScenes } from '../../../components/AuthingGuard/types/GuardConfig'
-
-export interface ActiveTabs {
-  [GuardScenes.Login]: LoginMethods
-  [GuardScenes.Register]: RegisterMethods
-}

package/src/components/AuthingGuard/types/Locales.ts

@@ -1,12 +0,0 @@
-export type Lang = 'zh-CN' | 'en-US'
-
-export const LANG_MAP = [
-  {
-    label: '中文',
-    value: 'zh-CN',
-  },
-  {
-    label: 'English',
-    value: 'en-US',
-  },
-]

package/src/components/AuthingGuard/types/index.ts

@@ -1,4 +0,0 @@
-export * from './Forms'
-export * from './GuardState'
-export * from './GuardConfig'
-export * from './Locales'

package/src/components/index.ts

@@ -1,7 +0,0 @@
-import { AuthingGuard } from './AuthingGuard'
-
-export * from './AuthingGuard/types'
-export * from './AuthingGuard/hooks'
-export type { AuthenticationClientOptions } from 'authing-js-sdk'
-
-export { AuthingGuard }

package/src/context/base.tsx

@@ -1,28 +0,0 @@
-import React from 'react'
-
-// create context with no upfront defaultValue
-// without having to do undefined check all the time
-export function createBaseContext<C>() {
-  const ctx = React.createContext<C | undefined>(undefined)
-  function useBaseContext() {
-    const ctxConst = React.useContext(ctx)
-    if (!ctxConst)
-      throw new Error('useBaseContext must be inside a Provider with a value')
-    return ctxConst
-  }
-  // make TypeScript infer a tuple, not an array of union types
-  return [ctx, useBaseContext] as const
-}
-
-export interface IBaseAction<ActionType = string> {
-  type: ActionType & string
-  payload?: any
-  [key: string]: string
-}
-
-export interface IBaseContext<S> {
-  state: S
-  [k: string]: any
-}
-
-export type BaseContextComponent<Props> = React.PropsWithChildren<Props>

package/src/context/global/context.tsx

@@ -1,39 +0,0 @@
-import React, { useCallback, useReducer } from 'react'
-import { createBaseContext, IBaseContext, BaseContextComponent } from '../base'
-import { reducer, IState } from './reducer'
-
-// 页面上下文，除了状态外还有公开的方法
-export interface IGuardContext extends IBaseContext<IState> {
-  dispatch: Function
-  getValue: (key: keyof IState) => any
-  setValue: (key: keyof IState, value: any) => void
-}
-
-// 实例化上下文，这里避免了为空检查
-const [Context, useBaseContext] = createBaseContext<IGuardContext>()
-
-export function useGuardContext(): IGuardContext {
-  const guardContext = useBaseContext()
-  // TODO: custom some
-  return guardContext
-}
-
-export function GuardContext({
-  children = null,
-  value,
-}: BaseContextComponent<Record<string, any>>) {
-  const [state, dispatch] = useReducer(reducer, value)
-  const getValue = (key: keyof IState) => state[key]
-  const setValue = useCallback((key: keyof IState, value: any) => {
-    dispatch({ type: 'SET_VALUE', key, value })
-  }, [])
-
-  let ctx: IGuardContext = {
-    state,
-    dispatch,
-    getValue,
-    setValue,
-  }
-
-  return <Context.Provider value={ctx}>{children}</Context.Provider>
-}

package/src/context/global/reducer.tsx

@@ -1,56 +0,0 @@
-import {
-  GuardConfig,
-  ActiveTabs,
-  GuardScenes,
-  UserConfig,
-  GuardEventsHandler,
-  LocalesConfig,
-  Lang,
-} from '../../components/AuthingGuard/types'
-import { AuthenticationClient } from 'authing-js-sdk'
-import { IBaseAction } from '../base'
-import { ApplicationMfaType } from '../../components/AuthingGuard/api/appConfig'
-
-export type IState = {
-  config: GuardConfig // 处理后的 Guard 配置
-  userConfig: UserConfig // 用户传入的配置
-  authClient: AuthenticationClient
-  activeTabs: ActiveTabs // 登录、注册方式
-  guardScenes: GuardScenes // 当前在哪个界面
-  guardTitle: string
-  // 需要 mfa 登录时后端返回的错误信息
-  mfaData: {
-    mfaToken: string
-    phone?: string
-    email?: string
-    applicationMfa?: {
-      status: 0 | 1
-      mfaPolicy: ApplicationMfaType
-      sort: number
-    }[]
-  }
-  userPoolId: string
-  appId: string
-  guardEvents: GuardEventsHandler
-  localesConfig: LocalesConfig
-  lang?: Lang
-  realHost: string
-}
-
-const handlers: any = {
-  // eslint-disable-next-line
-  ['SET_VALUE']: (state: IState, payloads: any) => {
-    return {
-      ...state,
-      [payloads.key]: payloads.value,
-    }
-  },
-}
-
-export const reducer = (state: IState, { type, ...payloads }: IBaseAction) => {
-  const handler = handlers[type]
-  if (handler) {
-    return handler(state, payloads)
-  }
-  return state
-}