@arcblock/did-connect-react 3.4.15 → 3.5.1

package/src/components/PassportSwitcher.jsx

@@ -1,160 +0,0 @@
-/* eslint-disable react/prop-types */
-import pick from 'lodash/pick';
-import { Confirm } from '@arcblock/ux/lib/Dialog';
-import { Box } from '@mui/material';
-import Toast from '@arcblock/ux/lib/Toast';
-import CardSelector from '@arcblock/ux/lib/CardSelector';
-import { translate } from '@arcblock/ux/lib/Locale/util';
-import { useCreation, useMemoizedFn } from 'ahooks';
-import { createPassportSvg } from '@arcblock/ux/lib/Util/passport';
-
-// eslint-disable-next-line import/no-unresolved
-import { ReactGA } from '@arcblock/ux/lib/withTracker';
-// eslint-disable-next-line import/no-unresolved
-import Guest from '../OAuth/guest.svg?react';
-
-export const parseResponse = (data) => {
-  if (!data) {
-    return {};
-  }
-
-  // for backward compatibility
-  if (typeof data === 'string') {
-    return { sessionToken: data };
-  }
-
-  return pick(data, ['sessionToken', 'refreshToken', 'visitorId', 'destroySessionId', 'csrfToken']);
-};
-
-const translations = {
-  zh: {
-    switchPassport: '切换通行证',
-    switchPassportFailed: '切换通行证失败',
-    switchPassportSucceed: '切换通行证成功',
-    selectedPassport: '请选择一个通行证',
-    switch: '切换',
-    cancel: '取消',
-    currentRole: '当前角色：',
-    passport: '通行证',
-    getPassportFailed: '获取通行证失败',
-  },
-  en: {
-    switchPassport: 'Switch passport',
-    switchPassportFailed: 'Switch passport failed',
-    switchPassportSucceed: 'Switch passport succeed',
-    selectedPassport: 'Select a passport to switch',
-    switch: 'Switch',
-    cancel: 'Cancel',
-    currentRole: 'Current role: ',
-    passport: 'Passport',
-    getPassportFailed: 'Get passports failed',
-  },
-};
-
-export function PassportSwitcher({ api, locale, switchState, onSwitchPassport, session }) {
-  const t = useMemoizedFn((key, data = {}) => {
-    return translate(translations, key, locale, 'en', data);
-  });
-
-  const visiblePassports = useCreation(() => {
-    return switchState.passports.filter((x) => x.role !== switchState.currentUser?.role);
-  }, [switchState.passports, switchState.currentUser?.role]);
-
-  const onSwitch = async () => {
-    const passportId = switchState.selectedPassport;
-    const fromRole = session?.user?.role;
-    const toRole = session?.user?.passports?.find((x) => x.id === passportId)?.role ?? 'guest';
-    const change = `${fromRole} -> ${toRole}`;
-    try {
-      const { data } = await api.post('/switch', { passportId });
-      const { sessionToken, refreshToken, csrfToken } = parseResponse(data);
-      onSwitchPassport({ sessionToken, refreshToken, csrfToken });
-      Toast.success(t('switchPassportSucceed'));
-
-      /**
-       * @type {import('@arcblock/ux/lib/withTracker/action/switch-passport').SwitchPassportSuccessEvent}
-       */
-      const switchPassportSuccessEvent = {
-        action: 'switchPassportSuccess',
-        change,
-        success: true,
-      };
-      ReactGA.event(switchPassportSuccessEvent.action, switchPassportSuccessEvent);
-    } catch (err) {
-      const errorMessage = err.message || t('switchPassportFailed');
-      /**
-       * @type {import('@arcblock/ux/lib/withTracker/action/switch-passport').SwitchPassportFailedEvent}
-       */
-      const switchPassportFailedEvent = {
-        action: 'switchPassportFailed',
-        success: false,
-        change,
-        errorMessage,
-      };
-      ReactGA.event(switchPassportFailedEvent.action, switchPassportFailedEvent);
-      Toast.error(errorMessage);
-    }
-  };
-
-  return (
-    <Confirm
-      open={switchState.open}
-      title={t('switchPassport')}
-      onConfirm={onSwitch}
-      onCancel={switchState.reset}
-      confirmButton={{
-        text: t('switch'),
-        props: {
-          variant: 'contained',
-          color: 'primary',
-        },
-      }}
-      cancelButton={{
-        text: t('cancel'),
-        props: {
-          color: 'inherit',
-        },
-      }}
-      PaperProps={{ style: { width: 600 } }}>
-      <Box
-        sx={{
-          mb: 2,
-        }}>
-        {t('currentRole')}
-        {switchState.currentUser?.role}
-      </Box>
-      <CardSelector
-        width={160}
-        height={240}
-        cardSpace={24}
-        list={[
-          // eslint-disable-next-line react/no-unstable-nested-components
-          () => <Guest />,
-          ...visiblePassports.map((x) => {
-            if (x.display) {
-              return {
-                src: x.display,
-                name: x.title,
-              };
-            }
-
-            // eslint-disable-next-line react/no-unstable-nested-components, react/function-component-definition
-            return () => (
-              <Box
-                key={x.id}
-                sx={{ width: '100%' }}
-                dangerouslySetInnerHTML={{
-                  __html: createPassportSvg(x),
-                }}
-              />
-            );
-          }),
-        ]}
-        onSelect={(index) => {
-          switchState.selectedPassport = index > 0 ? visiblePassports[index - 1].id : undefined;
-        }}
-        defaultIndex={0}
-      />
-    </Confirm>
-  );
-}

package/src/constant.js

@@ -1,27 +0,0 @@
-export const DEFAULT_TIMEOUT = 5 * 60;
-export const DEFAULT_WINDOW_TIMEOUT = 30 * 60;
-export const BLOCKLET_SERVICE_PATH_PREFIX = '/.well-known/service';
-export const SESSION_TOKEN_STORAGE_KEY = 'login_token';
-export const CSRF_TOKEN_STORAGE_KEY = 'x-csrf-token';
-export const REFRESH_TOKEN_STORAGE_KEY = 'refresh_token';
-
-export const RELAY_SOCKET_PREFIX = '/.well-known/service';
-export const API_DID_PREFIX = '/api/did';
-
-export const DEFAULT_NAME = 'DID Connect';
-
-export const DID_CONNECT_URL_PARAMS_NAME = '__did-connect__';
-
-export const BUSY_STATUS = ['scanned', 'succeed', 'error', 'busy'];
-export const EXT_DOWNLOAD_URL = {
-  chrome: 'https://chromewebstore.google.com/detail/did-wallet/ibjflpbmadchofnbpppegdbnifdgincp',
-  edge: 'https://microsoftedge.microsoft.com/addons/detail/did-wallet/hjgoblidjnnnamdkinbichnfbmghmafd',
-};
-
-export const CHECK_STATUS_INTERVAL = 2 * 1000;
-export const VERIFY_CODE_LENGTH = 6;
-
-export const LANG_COOKIE_NAME = 'nf_lang';
-export const CHECK_INTERVAL_TIME = 1000;
-
-export const DID_SPACES_BASE_URL = window?.blocklet?.DID_SPACES_BASE_URL || 'https://www.didspaces.com/app';

package/src/error.js

@@ -1,6 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export class NotOpenError extends Error {
-  constructor() {
-    super('Failed to open popup');
-  }
-}

package/src/hooks/use-locale.jsx

@@ -1,6 +0,0 @@
-/* eslint-disable import/prefer-default-export */
-import { getBrowserLang } from '../utils';
-
-export function useLocale() {
-  return getBrowserLang();
-}

package/src/index.js

@@ -1,32 +0,0 @@
-import DidConnect from './Connect';
-import Button from './Button';
-import Logo from './Logo';
-import Session from './Session';
-
-export * from './OAuth';
-export * from './Passkey';
-export * from './Session';
-export * from './User';
-export * from './Federated';
-export * from './constant';
-export * from './utils';
-export * from './error';
-
-export { default as SessionManager } from './SessionManager';
-export { default as Address } from './Address';
-export { default as Avatar } from './Avatar';
-export { default as useConnect } from './Connect/use-connect';
-
-export {
-  // DID Connect
-  DidConnect,
-  DidConnect as Connect,
-  DidConnect as DIDConnect,
-  Logo,
-  Logo as DIDLogo,
-  Button,
-  Button as DIDButton,
-
-  // DEPRECATED
-  Session,
-};

package/src/locales/en.jsx

@@ -1,15 +0,0 @@
-import flat from 'flat';
-
-export default flat({
-  didSpacesGuide: {
-    title: 'Connect to DID Spaces',
-    description: 'Your secure, private, and reliable decentralized digital storage space.',
-    feature: {
-      dataSecurity: 'Data Security',
-      dataSharing: 'Data Sharing',
-      dataSync: 'Data Sync',
-      dataIntegration: 'Data Integration',
-    },
-    connectNow: 'Connect Now',
-  },
-});

package/src/locales/index.jsx

@@ -1,13 +0,0 @@
-/* eslint-disable import/prefer-default-export */
-import en from './en';
-import zh from './zh';
-
-const locales = { en, zh };
-
-const replace = (template, data) =>
-  template.replace(/{(\w*)}/g, (_, key) => (Object.prototype.hasOwnProperty.call(data, key) ? data[key] : ''));
-
-export function t(key, locale = 'en', params = {}) {
-  const _locale = locale in locales ? locale : 'en';
-  return replace(locales[_locale][key], params) || key;
-}

package/src/locales/zh.jsx

@@ -1,15 +0,0 @@
-import flat from 'flat';
-
-export default flat({
-  didSpacesGuide: {
-    title: '连接到 DID Spaces',
-    description: '您的安全、私密、可靠的分散式数字存储空间。',
-    feature: {
-      dataSecurity: '数据安全',
-      dataSharing: '数据共享',
-      dataSync: '数据同步',
-      dataIntegration: '数据集成',
-    },
-    connectNow: '立即连接',
-  },
-});

package/src/types.d.ts

@@ -1,355 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import type { EventEmitter } from 'eventemitter3';
-import { DEFAULT_TIMEOUT } from './constant';
-import type { ReactNode } from 'react';
-
-export type ConnectMessages = {
-  title: string;
-  scan: string;
-  success: ReactNode;
-  confirm?: string; // 貌似没有地方使用，先设置为非必填
-  error?: string;
-};
-
-// FIXME: @zhanghan 将来需要改成 ts，直接从常量值 LOGIN_PROVIDER 中提取类型，目前只能写成这样
-export type WalletProvider = 'wallet' | 'auth0' | 'apple' | 'github' | 'google' | 'passkey';
-
-export type WalletOS = 'web' | 'android' | 'ios' | '';
-export type UserRole = 'guest' | 'member' | 'admin' | 'owner' | string;
-export type BaseLocale = 'en' | 'zh';
-export type UserLocale = BaseLocale | string;
-
-export type ConnectProps = {
-  /**
-   * @example login
-   */
-  action: string;
-  containerEl?: Element;
-  /**
-   * @default "/api/did"
-   */
-  prefix?: string;
-  /**
-   * @default "en"
-   */
-  locale?: 'en' | 'zh';
-  /**
-   * @default false
-   */
-  popup?: boolean;
-  /**
-   * @default 2*1000
-   */
-  checkInterval?: number;
-  /**
-   * @default 5*60*1000
-   */
-  checkTimeout?: number;
-  /**
-   * @default 2*1000
-   */
-  closeTimeout?: number;
-  /**
-   * @default {}
-   */
-  extraParams?: object;
-  /**
-   * @default "_t_"
-   */
-  tokenKey?: string;
-  /**
-   * @default "_ek_"
-   */
-  encKey?: string;
-  /**
-   * @default "''"
-   */
-  baseUrl?: string;
-  /**
-   * @default {
-        title: 'DID Connect',
-        scan: 'Scan QR code to complete this action',
-        confirm: 'Confirm on your DID Wallet',
-        success: 'Success!'
-      }
-   */
-  messages?: ConnectMessages;
-  /**
-   * @default true
-   */
-  autoConnect?: boolean;
-  /**
-   * @default true
-   */
-  forceConnected?: boolean | string;
-  /**
-   * @default true
-   */
-  saveConnect?: boolean;
-  /**
-   * @default true
-   */
-  useSocket?: boolean;
-  /**
-   * @default true
-   */
-  allowWallet?: boolean;
-  /**
-   * @default true
-   */
-  passkeyBehavior?: 'none' | 'both' | 'only-existing' | 'only-new';
-  /**
-   * @default "wallet"
-   */
-  provider?: 'wallet' | 'auth0' | '';
-  /**
-   * @default 160
-   */
-  qrcodeSize?: number;
-  /**
-   * @default true
-   */
-  showDownload?: boolean;
-  /**
-   * @default "https://web.abtwallet.io"
-   */
-  webWalletUrl?: string;
-  /**
-   * @default ["web", "mobile", "github", "apple", "google", "auth0", "passkey"]
-   */
-  enabledConnectTypes?: Array<'web' | 'mobile' | 'auth0', 'github' | 'apple' | 'google' | 'passkey'>;
-  extraContent?: any;
-  loadingEle?: any;
-  /**
-   * @default false
-   */
-  disableSwitchApp?: boolean;
-  /**
-   * @default false
-   */
-  hideCloseButton?: boolean;
-  /**
-   * @default {}
-   */
-  options?: {
-    /**
-     * @default true
-     */
-    showQuickConnect?: boolean;
-  };
-  onRecreateSession?: Function;
-  checkFn?: () => boolean;
-  onSuccess?: (result: object) => void;
-  onError?: (error: any) => void;
-  onClose?: Function;
-};
-
-export type OpenConnect = (params: ConnectProps) => void;
-export type OpenConnectPopup = (
-  params: ConnectProps,
-  options?: {
-    baseUrl?: string;
-    locale?: BaseLocale;
-  }
-) => void;
-
-export type OpenDidConnect = (
-  params: ConnectProps,
-  options?: {
-    /**
-     * 打开 DID Connect 的模式
-     * @default 'popup'
-     */
-    openMode?: 'redirect' | 'window' | 'popup';
-    requirements?: {
-      /**
-       * 是否要求登录
-       * @default true
-       */
-      login?: boolean;
-      /**
-       * 是否要求绑定 DID Wallet 账户
-       * @default true
-       */
-      bindWallet?: boolean;
-      /**
-       * 是否要求绑定 DID Spaces
-       * @default false
-       */
-      bindDidSpaces?: false | 'read' | 'full';
-      // bindOAuth?: boolea // 暂不支持，这里要配置的情况会稍微复杂一些
-    };
-    baseUrl?: string;
-    locale?: BaseLocale;
-  }
-) => void;
-
-export type CloseConnect = Function;
-
-export type CommonSessionFn = (done?: Function, params?: object) => void;
-
-export type LoginSessionFn = (
-  done?: Function,
-  params?: {
-    openMode: 'redirect' | 'window'; // iframe: 暂未启用
-    provider?: 'wallet';
-    redirect?: string;
-    forceConnected?: string;
-    sourceAppPid?: string;
-    passkeyBehavior?: string;
-    [key: string]: any;
-  },
-  origin?: string
-) => any;
-
-export type LogoutSessionFn = (done?: Function) => void;
-
-export type Passport = {
-  id: string;
-  name: string;
-  title: string;
-  role: UserRole;
-};
-export type ConnectAccount = {
-  provider: WalletProvider;
-  did: string;
-  pk: string;
-  id?: string;
-  firstLoginAt?: string;
-  lastLoginAt?: string;
-  lastLoginIp?: string;
-};
-
-export type SessionUser = {
-  avatar: string;
-  did: string;
-  email: string;
-  fullName: string;
-  remark?: string;
-  role?: UserRole;
-  sourceAppPid: null | string;
-  sourceProvider: WalletProvider;
-};
-
-export type UserSession = {
-  id: string;
-  appName: string;
-  appPid: string;
-  updatedAt: string;
-  userDid: string;
-  visitorId: string;
-  extra: object;
-  user: SessionUser;
-  passportId?: string;
-};
-
-export type User = {
-  approved: boolean;
-  avatar: string;
-  connectedAccounts: ConnectAccount[];
-  did: string;
-  pk: string;
-  email: string;
-  fullName: string;
-  role: UserRole;
-  locale: UserLocale;
-  passports: Passport[];
-  permissions: any[];
-  sourceAppPid?: string;
-  sourceProvider?: WalletProvider;
-  didSpace?: object;
-  remark?: string;
-  createdAt: string;
-  updatedAt: string;
-  firstLoginAt?: string;
-  lastLoginAt?: string;
-  lastLoginIp?: string;
-};
-
-export type SessionProps = {
-  action: string;
-  error: string;
-  initialized: boolean;
-  loading: boolean;
-  open: boolean;
-  walletOS: WalletOS;
-  user?: User;
-  locale: UserLocale;
-  provider?: WalletProvider;
-  baseUrl?: string;
-  federatedMaster?: object;
-  login: LoginSessionFn;
-  logout: LogoutSessionFn;
-  switch: Function;
-  switchDid: CommonSessionFn;
-  autoSwitchDid: Function;
-  switchProfile: CommonSessionFn;
-  switchPassport: CommonSessionFn;
-  bindWallet: CommonSessionFn;
-  refresh: Function;
-  updateConnectedInfo: (data: object) => void;
-  openDidConnect: OpenDidConnect;
-
-  useOAuth: Function;
-  OAuthProvider: Function;
-  OAuthConsumer: Function;
-  OAuthContext: object;
-
-  usePasskey: Function;
-  PasskeyProvider: Function;
-  PasskeyConsumer: Function;
-  PasskeyContext: object;
-
-  useDid: (options: { session: Session }) => void;
-  WrapDid: Function;
-  getUserSessions: () => Promise<UserSession[]>;
-};
-
-export type SessionStorageProps = {
-  getToken: Function;
-  setToken: Function;
-  removeToken: Function;
-};
-
-export type SessionContext = {
-  api: AxiosInstance; // api 实例(axios)
-  events: EventEmitter; // session 事件订阅器
-  storage: SessionStorageProps; // sessionToken 的存储实例
-  session: SessionProps; // session 实例
-  connectApi: {
-    open: OpenConnect;
-    close: CloseConnect;
-  }; // use-connect 的 connectApi
-};
-
-export interface TokenState {
-  checking: boolean;
-  loading: boolean;
-  token: string;
-  url: string;
-  store: object;
-  status: 'created' | 'scanned' | 'succeed' | 'error' | 'timeout' | 'busy' | 'forbidden';
-  error: string;
-  checkCount: number;
-  mfaCode?: number;
-  appInfo: object;
-  memberAppInfo: object;
-  connectedDid: string;
-  saveConnect: boolean;
-  inExistingSession: boolean;
-  nextWorkflow?: string;
-  baseUrl: string;
-  prefix: string;
-  extraParams: object;
-  checkFn: Function;
-  results: object;
-  action: string;
-  provider: 'wallet' | 'auth0' | 'apple' | 'github' | 'google';
-}
-
-export type SwitchBehavior = 'auto' | 'disabled' | 'required';
-export type DIDConnectUrlOptions = {
-  switchBehavior: SwitchBehavior;
-  sourceAppPid: string;
-  forceConnected: boolean | string;
-};