@metamask/connect-multichain 0.5.3 → 0.6.0

package/dist/browser/umd/connect-multichain.d.ts

@@ -435,6 +435,16 @@ type MultiChainFNOptions = Omit<MultichainOptions, 'storage' | 'ui'> & {
 } & {
     storage?: StoreClient;
 };
+/**
+ * Options that can be merged/overwritten when createMultichainClient is called
+ * with an existing singleton.
+ */
+type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' | 'storage' | 'api' | 'ui' | 'transport'> & {
+    api?: MultichainOptions['api'];
+    ui?: Pick<MultichainOptions['ui'], 'headless' | 'preferExtension' | 'showInstallModal'>;
+    transport?: Pick<NonNullable<MultichainOptions['transport']>, 'extensionId'>;
+    debug?: boolean;
+};
 /**
  * Complete options for Multichain SDK configuration.
  *
@@ -453,6 +463,8 @@ type ExtendedTransport = Omit<Transport, 'connect'> & {
         timeout?: number;
     }) => Promise<TResponse>;
     getActiveSession: () => Promise<Session | undefined>;
+    getStoredPendingSessionRequest: () => Promise<SessionRequest | null>;
+    disconnect: (scopes: Scope[]) => Promise<void>;
 };
 
 declare const infuraRpcUrls: RpcUrlsMap;
@@ -474,7 +486,7 @@ declare enum TransportType {
  * must provide, including session management, connection handling, and method invocation.
  */
 declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
-    protected readonly options: MultichainOptions;
+    protected options: MultichainOptions;
     abstract storage: StoreClient;
     abstract status: ConnectionStatus;
     abstract provider: MultichainApiClient<RPCAPI>;
@@ -491,7 +503,7 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
      *
      * @returns Promise that resolves when disconnection is complete
      */
-    abstract disconnect(): Promise<void>;
+    abstract disconnect(scopes?: Scope[]): Promise<void>;
     /**
      * Invokes an RPC method with the specified options.
      *
@@ -499,8 +511,19 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
      * @returns Promise that resolves to the method result
      */
     abstract invokeMethod(options: InvokeMethodOptions): Promise<Json>;
-    abstract openDeeplinkIfNeeded(): void;
+    abstract openSimpleDeeplinkIfNeeded(): void;
+    abstract emitSessionChanged(): Promise<void>;
     constructor(options: MultichainOptions);
+    /**
+     * Merges the given options into the current instance options.
+     * Only the mergeable keys are updated (api.supportedNetworks, ui.*, mobile.*, transport.extensionId, debug).
+     * The main thing to note is that the value for `dapp` is not merged as it does not make sense for
+     * subsequent calls to `createMultichainClient` to have a different `dapp` value.
+     * Used when createMultichainClient is called with an existing singleton.
+     *
+     * @param partial - Options to merge/overwrite onto the current instance
+     */
+    mergeOptions(partial: MergeableMultichainOptions): void;
 }
 declare function getTransportType(type: string): TransportType;
 
@@ -652,4 +675,4 @@ declare function getVersion(): string;
 
 declare const createMultichainClient: CreateMultichainFN;
 
-export { type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };
+export { type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, type MergeableMultichainOptions, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };