@arcblock/did-connect-js 1.30.0 → 4.0.0-beta.10

package/esm/authenticator/wallet.d.mts

@@ -1,270 +0,0 @@
-import BaseAuthenticator from "./base.mjs";
-
-//#region src/authenticator/wallet.d.ts
-interface ApplicationInfo {
-  name: string;
-  description: string;
-  icon: string;
-  link?: string;
-  path?: string;
-  publisher?: string;
-}
-interface ChainInfo {
-  id: string;
-  type: string;
-  host: string;
-}
-interface WalletAuthenticatorConfig {
-  wallet: any;
-  appInfo: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>);
-  memberAppInfo?: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>) | null;
-  delegator?: any;
-  delegation?: string | ((params: any) => string | Promise<string>);
-  timeout?: number;
-  chainInfo?: ChainInfo | ((params: any) => ChainInfo | Promise<ChainInfo>);
-  baseUrl?: string;
-  tokenKey?: string;
-}
-declare class WalletAuthenticator extends BaseAuthenticator {
-  wallet: any;
-  appInfo: any;
-  memberAppInfo: any;
-  chainInfo: any;
-  delegator: any;
-  delegation: any;
-  baseUrl: string;
-  tokenKey: string;
-  timeout: number;
-  static formatDisplay(display: any): string;
-  /**
-   * Creates an instance of DID Authenticator.
-   *
-   * @class
-   * @param {object} config
-   * @param {WalletObject|Function} config.wallet - wallet instance {@see @ocap/wallet} or a function that returns wallet instance
-   * @param {WalletObject|Function} [config.delegator] - the party that authorizes `wallet` to perform actions on behalf of `wallet`
-   * @param {string|Function} [config.delegation] - the jwt token that proves delegation relationship
-   * @param {ApplicationInfo|Function} config.appInfo - application basic info or a function that returns application info
-   * @param {ChainInfo|Function} config.chainInfo - application chain info or a function that returns chain info
-   * @param {Number} [config.timeout=8000] - timeout in milliseconds when generating claim
-   * @param {object} [config.baseUrl] - url to assemble wallet request uri, can be inferred from request object
-   * @param {string} [config.tokenKey='_t_'] - query param key for `token`
-   */
-  constructor({
-    wallet,
-    appInfo,
-    memberAppInfo,
-    delegator,
-    delegation,
-    timeout,
-    chainInfo,
-    baseUrl,
-    tokenKey
-  }: WalletAuthenticatorConfig);
-  /**
-   * Generate a deep link url that can be displayed as QRCode for DID Wallet to consume
-   *
-   * @method
-   * @param {object} params
-   * @param {string} params.baseUrl - baseUrl inferred from request object
-   * @param {string} params.pathname - wallet callback pathname
-   * @param {string} params.token - action token
-   * @param {object} params.query - params that should be persisted in wallet callback url
-   * @returns {string}
-   */
-  uri({
-    baseUrl,
-    pathname,
-    token,
-    query
-  }?: {
-    baseUrl?: string;
-    pathname?: string;
-    token?: string;
-    query?: Record<string, any>;
-  }): string;
-  /**
-   * Compute public url to return to wallet
-   *
-   * @method
-   * @param {string} pathname
-   * @param {object} params
-   * @returns {string}
-   */
-  getPublicUrl(pathname: string, params?: Record<string, any>, baseUrl?: string): string;
-  /**
-   * Sign a plain response, usually on auth success or error
-   *
-   * @method
-   * @param {object} params
-   * @param {object} params.response - response
-   * @param {string} params.errorMessage - error message, default to empty
-   * @param {string} params.successMessage - success message, default to empty
-   * @param {string} params.nextWorkflow - https://github.com/ArcBlock/ABT-DID-Protocol#concatenate-multiple-workflow
-   * @param {string} params.nextUrl - tell wallet do open this url in webview
-   * @param {object} params.cookies - key-value pairs to be set as cookie before open nextUrl
-   * @param {object} params.storages - key-value pairs to be set as localStorage before open nextUrl
-   * @param {string} baseUrl
-   * @param {object} request
-   * @returns {Promise<object>} { appPk, agentPk, authInfo }
-   */
-  signResponse({
-    response,
-    errorMessage,
-    successMessage,
-    nextWorkflow,
-    nextUrl,
-    cookies,
-    storages
-  }: {
-    response?: any;
-    errorMessage?: string;
-    successMessage?: string;
-    nextWorkflow?: string;
-    nextUrl?: string;
-    cookies?: Record<string, any>;
-    storages?: any;
-  }, baseUrl: string, request: any, extraParams?: Record<string, any>): Promise<any>;
-  /**
-   * Sign a auth response that returned to wallet: tell the wallet the appInfo/chainInfo
-   *
-   * @method
-   * @param {object} params
-   * @param {object} params.claims - info required by application to complete the auth
-   * @param {string} params.pathname - pathname to assemble callback url
-   * @param {string} params.baseUrl - baseUrl
-   * @param {object} params.challenge - random challenge to be included in the body
-   * @param {object} params.extraParams - extra query params and locale
-   * @param {object} params.request
-   * @param {object} params.context
-   * @param {string} params.context.token - action token
-   * @param {number} params.context.currentStep - current step
-   * @param {string} [params.context.sharedKey] - shared key between app and wallet
-   * @param {string} [params.context.encryptionKey] - encryption key from wallet
-   * @param {Function} [params.context.mfaCode] - function used to generate mfa code
-   * @param {string} params.context.userDid - decoded from req.query, base58
-   * @param {string} params.context.userPk - decoded from req.query, base58
-   * @param {string} params.context.didwallet - DID Wallet os and version
-   * @returns {Promise<object>} { appPk, agentPk, sharedKey, authInfo }
-   */
-  sign({
-    context,
-    request,
-    claims,
-    pathname,
-    baseUrl,
-    challenge,
-    extraParams
-  }: {
-    context: any;
-    request: any;
-    claims: any;
-    pathname?: string;
-    baseUrl?: string;
-    challenge?: string;
-    extraParams?: Record<string, any>;
-  }): Promise<any>;
-  /**
-   * Determine chainInfo on the fly
-   *
-   * @param {object} params - contains the context of this request
-   * @param {object|undefined} [info=undefined] - chain info object or function
-   * @returns {Promise<ChainInfo>}
-   * @memberof WalletAuthenticator
-   */
-  getChainInfo(params: any, info?: any): Promise<ChainInfo>;
-  /**
-   * Determine appInfo/memberAppInfo on the fly
-   *
-   * @param {object} params - contains the context of this request
-   * @param {string} key - appInfo | memberAppInfo
-   * @returns {Promise<ApplicationInfo>}
-   * @memberof WalletAuthenticator
-   */
-  getAppInfo(params: any, key?: 'appInfo' | 'memberAppInfo'): Promise<any>;
-  getWalletInfo(params: any): Promise<any>;
-  getDelegator(params: any): Promise<any>;
-  getDelegation(params: any): Promise<any>;
-  /**
-   * Verify a DID auth response sent from DID Wallet
-   *
-   * @method
-   * @param {object} data
-   * @param {string} [locale=en]
-   * @param {boolean} [enforceTimestamp=true]
-   * @returns Promise<boolean>
-   */
-  verify(data: any, locale?: string, enforceTimestamp?: boolean): Promise<{
-    token: any;
-    userDid: string;
-    userPk: any;
-    claims: any;
-    action: any;
-    challenge: any;
-    timestamp: string;
-  }>;
-  genRequestedClaims({
-    claims,
-    context,
-    extraParams
-  }: {
-    claims: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<any[]>;
-  getClaimInfo({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<any>;
-  signature({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<{
-    type: string;
-    description: any;
-    origin: string;
-    typeUrl: any;
-    display: string;
-    method: any;
-    digest: any;
-    chainInfo: any;
-    meta: any;
-    mfa: any;
-    nonce: any;
-    requirement: any;
-  }>;
-  prepareTx({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<{
-    type: string;
-    description: any;
-    partialTx: string;
-    display: string;
-    requirement: any;
-    chainInfo: any;
-    meta: any;
-    mfa: any;
-    nonce: any;
-  }>;
-  _validateAppInfo(info: any, allowEmpty?: boolean): any;
-  _isValidChainInfo(x: any): boolean;
-  tryWithTimeout<T>(asyncFn: () => Promise<T>, label?: string): Promise<T>;
-}
-//#endregion
-export { ApplicationInfo, ChainInfo, WalletAuthenticatorConfig, WalletAuthenticator as default };