@imtbl/sdk 1.43.3 → 1.43.4

package/dist/Passport.d-011d5035.d.ts

@@ -0,0 +1,224 @@
+import { C as Configuration, A as AssetsApi, B as BalancesApi, a as CollectionsApi, D as DepositsApi, E as EncodingApi, b as ExchangesApi, M as MetadataApi, c as MetadataRefreshesApi, d as MintsApi, N as NftCheckoutPrimaryApi, O as OrdersApi, P as PrimarySalesApi, e as ProjectsApi, T as TokensApi, f as TradesApi, g as TransfersApi, U as UsersApi, W as WithdrawalsApi, I as IMXClient, h as IMXProvider } from './imxProvider.d-cac9e315.js';
+import { M as ModuleConfiguration } from './index.d-f0845744.js';
+
+/**
+ * Configuration for generated clients
+ */
+type ImmutableAPIConfiguration = Configuration;
+
+declare class ImxApiClients {
+    config: ImmutableAPIConfiguration;
+    assetApi: AssetsApi;
+    balanceApi: BalancesApi;
+    collectionApi: CollectionsApi;
+    depositsApi: DepositsApi;
+    encodingApi: EncodingApi;
+    exchangeApi: ExchangesApi;
+    metadataApi: MetadataApi;
+    metadataRefreshesApi: MetadataRefreshesApi;
+    mintsApi: MintsApi;
+    nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
+    ordersApi: OrdersApi;
+    primarySalesApi: PrimarySalesApi;
+    projectsApi: ProjectsApi;
+    tokensApi: TokensApi;
+    tradesApi: TradesApi;
+    transfersApi: TransfersApi;
+    usersApi: UsersApi;
+    withdrawalsApi: WithdrawalsApi;
+    constructor(config: ImmutableAPIConfiguration);
+}
+
+type UserProfile = {
+    email?: string;
+    nickname?: string;
+    sub: string;
+};
+interface OidcConfiguration {
+    clientId: string;
+    logoutRedirectUri?: string;
+    logoutMode?: 'redirect' | 'silent';
+    redirectUri: string;
+    scope?: string;
+    audience?: string;
+}
+interface PassportOverrides {
+    authenticationDomain: string;
+    magicPublishableApiKey: string;
+    magicProviderId: string;
+    passportDomain: string;
+    imxPublicApiDomain: string;
+    immutableXClient: IMXClient;
+    zkEvmRpcUrl: string;
+    relayerUrl: string;
+    indexerMrBasePath: string;
+    orderBookMrBasePath: string;
+    passportMrBasePath: string;
+    imxApiClients?: ImxApiClients;
+}
+interface PopupOverlayOptions {
+    disableGenericPopupOverlay?: boolean;
+    disableBlockedPopupOverlay?: boolean;
+}
+interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
+    /**
+     * This flag indicates that Passport is being used in a cross-sdk bridge scenario
+     * and not directly on the web.
+     */
+    crossSdkBridgeEnabled?: boolean;
+    /**
+     * Options for disabling the Passport popup overlays.
+     */
+    popupOverlayOptions?: PopupOverlayOptions;
+}
+type DeviceConnectResponse = {
+    code: string;
+    deviceCode: string;
+    url: string;
+    interval: number;
+};
+type DeviceTokenResponse = {
+    access_token: string;
+    refresh_token?: string;
+    id_token: string;
+    token_type: string;
+    expires_in: number;
+};
+
+/**
+ * ProviderErrors should take priority over RpcErrorCodes
+ * https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ * https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+declare enum ProviderErrorCode {
+    USER_REJECTED_REQUEST = 4001,
+    UNAUTHORIZED = 4100,
+    UNSUPPORTED_METHOD = 4200,
+    DISCONNECTED = 4900
+}
+declare enum RpcErrorCode {
+    RPC_SERVER_ERROR = -32000,
+    INVALID_REQUEST = -32600,
+    METHOD_NOT_FOUND = -32601,
+    INVALID_PARAMS = -32602,
+    INTERNAL_ERROR = -32603,
+    PARSE_ERROR = -32700,
+    TRANSACTION_REJECTED = -32003
+}
+declare class JsonRpcError extends Error {
+    readonly message: string;
+    readonly code: ProviderErrorCode | RpcErrorCode;
+    constructor(code: ProviderErrorCode | RpcErrorCode, message: string);
+}
+
+interface TypedDataPayload {
+    types: {
+        EIP712Domain: Array<{
+            name: string;
+            type: string;
+        }>;
+        [key: string]: Array<{
+            name: string;
+            type: string;
+        }>;
+    };
+    domain: {
+        name?: string;
+        version?: string;
+        chainId?: number;
+        verifyingContract?: string;
+        salt?: string;
+    };
+    primaryType: string;
+    message: Record<string, any>;
+}
+interface RequestArguments {
+    method: string;
+    params?: Array<any>;
+}
+type JsonRpcRequestPayload = RequestArguments & {
+    jsonrpc?: string;
+    id?: string | number;
+};
+interface JsonRpcRequestCallback {
+    (err: JsonRpcError | null, result?: JsonRpcResponsePayload | (JsonRpcResponsePayload | null)[] | null): void;
+}
+interface JsonRpcResponsePayload {
+    result?: Array<any> | null;
+    error?: JsonRpcError | null;
+    jsonrpc?: string;
+    id?: string | number;
+}
+type Provider = {
+    request: (request: RequestArguments) => Promise<any>;
+    sendAsync: (request: JsonRpcRequestPayload | JsonRpcRequestPayload[], callback: JsonRpcRequestCallback) => void;
+    send: (request: string | JsonRpcRequestPayload | JsonRpcRequestPayload[], callbackOrParams?: JsonRpcRequestCallback | Array<any>, callback?: JsonRpcRequestCallback) => void;
+    on: (event: string, listener: (...args: any[]) => void) => void;
+    removeListener: (event: string, listener: (...args: any[]) => void) => void;
+    isPassport: boolean;
+};
+declare enum ProviderEvent {
+    ACCOUNTS_CHANGED = "accountsChanged"
+}
+type AccountsChangedEvent = Array<string>;
+
+declare class Passport {
+    private readonly authManager;
+    private readonly config;
+    private readonly confirmationScreen;
+    private readonly immutableXClient;
+    private readonly magicAdapter;
+    private readonly multiRollupApiClients;
+    private readonly passportImxProviderFactory;
+    private readonly passportEventEmitter;
+    private readonly guardianClient;
+    constructor(passportModuleConfiguration: PassportModuleConfiguration);
+    /**
+     * @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
+     * `connectImx` instead.
+     */
+    connectImxSilent(): Promise<IMXProvider | null>;
+    connectImx(): Promise<IMXProvider>;
+    connectEvm(options?: {
+        announceProvider: boolean;
+    }): Provider;
+    /**
+     *
+     * Initiates the authorisation flow.
+     *
+     * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
+     * prompted to log in and the Promise will resolve with a null value.
+     * @param options.anonymousId - If provided, Passport internal metrics will be enriched with this value.
+     * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
+     */
+    login(options?: {
+        useCachedSession: boolean;
+        anonymousId?: string;
+    }): Promise<UserProfile | null>;
+    loginCallback(): Promise<void>;
+    loginWithDeviceFlow(options?: {
+        anonymousId?: string;
+    }): Promise<DeviceConnectResponse>;
+    loginWithDeviceFlowCallback(deviceCode: string, interval: number, timeoutMs?: number): Promise<UserProfile>;
+    loginWithPKCEFlow(): string;
+    loginWithPKCEFlowCallback(authorizationCode: string, state: string): Promise<UserProfile>;
+    logout(): Promise<void>;
+    /**
+     * Logs the user out of Passport when using device flow authentication.
+     *
+     * @returns {Promise<string>} The device flow end session endpoint. Consumers are responsible for
+     * opening this URL in the same browser that was used to log the user in.
+     */
+    logoutDeviceFlow(): Promise<string>;
+    /**
+     * This method should only be called from the logout redirect uri
+     * when logout mode is 'silent'.
+     */
+    logoutSilentCallback(url: string): Promise<void>;
+    getUserInfo(): Promise<UserProfile | undefined>;
+    getIdToken(): Promise<string | undefined>;
+    getAccessToken(): Promise<string | undefined>;
+    getLinkedAddresses(): Promise<string[]>;
+}
+
+export { AccountsChangedEvent as A, DeviceConnectResponse as D, JsonRpcError as J, Passport as P, RequestArguments as R, TypedDataPayload as T, UserProfile as U, DeviceTokenResponse as a, JsonRpcRequestCallback as b, JsonRpcRequestPayload as c, JsonRpcResponsePayload as d, PassportModuleConfiguration as e, PassportOverrides as f, Provider as g, ProviderErrorCode as h, ProviderEvent as i, RpcErrorCode as j };