@openfort/openfort-js 0.7.7 → 0.7.9

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-import { SessionKey, AuthResponse, OAuthProvider as OAuthProvider$1, InitializeOAuthOptions as InitializeOAuthOptions$1, InitAuthResponse, SIWEInitResponse, ThirdPartyOAuthProvider as ThirdPartyOAuthProvider$1, TokenType as TokenType$1, AuthPlayerResponse as AuthPlayerResponse$1, Auth, TransactionIntentResponse as TransactionIntentResponse$1, SessionResponse as SessionResponse$1, EmbeddedState as EmbeddedState$1, SDKOverrides as SDKOverrides$1 } from 'types';
-import { SDKConfiguration as SDKConfiguration$1 } from 'config';
-import { Provider as Provider$1 } from 'evm/types';
-
 declare type Bytes = ArrayLike<number>;
 declare type BytesLike = Bytes | string;
 interface Hexable {
@@ -56,121 +52,6 @@ interface TypedDataField {
     type: string;
 }
 
-interface ShieldAuthentication {
-    auth: AuthType;
-    token: string;
-    authProvider?: string;
-    tokenType?: string;
-}
-declare enum AuthType {
-    OPENFORT = "openfort",
-    CUSTOM = "custom"
-}
-
-declare class Openfort {
-    private signer?;
-    private readonly authManager;
-    private readonly config;
-    private readonly backendApiClients;
-    private readonly instanceManager;
-    private readonly iframeManager;
-    private readonly openfortEventEmitter;
-    constructor(sdkConfiguration: SDKConfiguration$1);
-    logout(): Promise<void>;
-    getEthereumProvider(options?: {
-        announceProvider: boolean;
-        policy?: string;
-    }): Provider$1;
-    private flushSigner;
-    configureSessionKey(): SessionKey;
-    configureEmbeddedSigner(chainId?: number, shieldAuthentication?: ShieldAuthentication, recoveryPassword?: string): Promise<void>;
-    private newEmbeddedSigner;
-    loginWithEmailPassword({ email, password, }: {
-        email: string;
-        password: string;
-    }): Promise<AuthResponse>;
-    signUpWithEmailPassword({ email, password, options, }: {
-        email: string;
-        password: string;
-        options?: {
-            data: {
-                name: string;
-            };
-        };
-    }): Promise<AuthResponse>;
-    requestEmailVerification({ email, redirectUrl }: {
-        email: string;
-        redirectUrl: string;
-    }): Promise<void>;
-    resetPassword({ email, password, state }: {
-        email: string;
-        password: string;
-        state: string;
-    }): Promise<void>;
-    requestResetPassword({ email, redirectUrl }: {
-        email: string;
-        redirectUrl: string;
-    }): Promise<void>;
-    verifyEmail({ email, state }: {
-        email: string;
-        state: string;
-    }): Promise<void>;
-    initOAuth({ provider, options }: {
-        provider: OAuthProvider$1;
-        options?: InitializeOAuthOptions$1;
-    }): Promise<InitAuthResponse>;
-    initLinkOAuth({ provider, playerToken, options }: {
-        provider: OAuthProvider$1;
-        playerToken: string;
-        options?: InitializeOAuthOptions$1;
-    }): Promise<InitAuthResponse>;
-    poolOAuth(key: string): Promise<AuthResponse>;
-    initSIWE({ address }: {
-        address: string;
-    }): Promise<SIWEInitResponse>;
-    authenticateWithThirdPartyProvider({ provider, token, tokenType }: {
-        provider: ThirdPartyOAuthProvider$1;
-        token: string;
-        tokenType: TokenType$1;
-    }): Promise<AuthPlayerResponse$1>;
-    authenticateWithSIWE({ signature, message, walletClientType, connectorType, }: {
-        signature: string;
-        message: string;
-        walletClientType: string;
-        connectorType: string;
-    }): Promise<AuthResponse>;
-    storeCredentials(auth: Auth): void;
-    sendSignatureTransactionIntentRequest(transactionIntentId: string, userOperationHash?: string | null, signature?: string | null): Promise<TransactionIntentResponse$1>;
-    signMessage(message: string | Uint8Array, options?: {
-        hashMessage?: boolean;
-        arrayifyMessage?: boolean;
-    }): Promise<string>;
-    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
-    sendRegisterSessionRequest(sessionId: string, signature: string, optimistic?: boolean): Promise<SessionResponse$1>;
-    private recoverSigner;
-    private waitSigner;
-    getEmbeddedState(): EmbeddedState$1;
-    private credentialsProvided;
-    getAccessToken(): string | null;
-    isLoaded(): boolean;
-    getUser(): Promise<AuthPlayerResponse$1>;
-    validateAndRefreshToken(): Promise<void>;
-}
-
-declare enum ShieldAuthProvider {
-    OPENFORT = "openfort",
-    CUSTOM = "custom"
-}
-
-interface ShieldOptions {
-    baseURL?: string;
-    apiKey: string;
-}
-
-interface ShieldAuthOptions {
-    authProvider: ShieldAuthProvider;
-}
-
 declare enum EmbeddedState {
     NONE = 0,
     UNAUTHENTICATED = 1,
@@ -178,6 +59,28 @@ declare enum EmbeddedState {
     CREATING_ACCOUNT = 3,
     READY = 4
 }
+type SessionKey = {
+    address: string;
+    isRegistered: boolean;
+};
+declare enum AuthType {
+    OPENFORT = "openfort",
+    THIRD_PARTY = "thirdParty"
+}
+type Auth = {
+    player?: string;
+    accessToken: string;
+    refreshToken: string;
+};
+type InitAuthResponse = {
+    url: string;
+    key: string;
+};
+type SIWEInitResponse = {
+    address: string;
+    nonce: string;
+    expiresAt: number;
+};
 type InitializeOAuthOptions = {
     usePooling?: boolean;
     /** A URL to send the user to after they are confirmed. */
@@ -419,59 +322,12 @@ interface AuthPlayerResponse {
     'createdAt': number;
     'linkedAccounts': Array<LinkedAccountResponse>;
 }
-
-/**
- * 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 AuthResponse {
+    'player': AuthPlayerResponse;
+    'token': string;
+    'refreshToken': string;
 }
 
-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;
-    isOpenfort: boolean;
-};
-
 /**
  * Openfort API
  * Complete Openfort API references and guides can be found at: https://openfort.xyz/docs
@@ -590,8 +446,419 @@ declare class SDKConfiguration {
     constructor({ baseConfiguration, shieldConfiguration, overrides, }: {
         baseConfiguration: OpenfortConfiguration;
         shieldConfiguration?: ShieldConfiguration;
-        overrides?: SDKOverrides$1;
+        overrides?: SDKOverrides;
     });
 }
 
-export { AuthPlayerResponse, AuthType, BasicAuthProvider, EmbeddedState, InitializeOAuthOptions, OAuthProvider, OpenfortConfiguration, Provider, SDKConfiguration, SDKOverrides, SessionResponse, ShieldAuthOptions, ShieldAuthentication, ShieldConfiguration, ShieldOptions, ThirdPartyOAuthProvider, TokenType, TransactionIntentResponse, TypedDataDomain, TypedDataField, Openfort as default };
+/**
+ * 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 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;
+    isOpenfort: boolean;
+};
+
+interface ShieldAuthentication {
+    auth: ShieldAuthType;
+    token: string;
+    authProvider?: string;
+    tokenType?: string;
+}
+declare enum ShieldAuthType {
+    OPENFORT = "openfort",
+    CUSTOM = "custom"
+}
+
+declare class Openfort {
+    private signer?;
+    private readonly authManager;
+    private readonly config;
+    private readonly backendApiClients;
+    private readonly instanceManager;
+    private readonly iframeManager;
+    private readonly openfortEventEmitter;
+    constructor(sdkConfiguration: SDKConfiguration);
+    /**
+     * Logs the user out by flushing the signer and removing credentials.
+     */
+    logout(): Promise<void>;
+    /**
+     * Returns an Ethereum provider using the configured signer.
+     *
+     * @param options - Configuration options for the Ethereum provider.
+     * @returns A Provider instance.
+     * @throws {OpenfortError} If the signer is not an EmbeddedSigner.
+     */
+    getEthereumProvider(options?: {
+        announceProvider: boolean;
+        policy?: string;
+    }): Provider;
+    /**
+     * Configures a session key and returns the session key details.
+     *
+     * @returns A SessionKey object containing the address and registration status.
+     */
+    configureSessionKey(): SessionKey;
+    /**
+     * Configures an embedded signer.
+     *
+     * @param chainId - The chain ID for the embedded signer.
+     * @param shieldAuthentication - Shield authentication details.
+     * @param recoveryPassword - Recovery password.
+     */
+    configureEmbeddedSigner(chainId?: number, shieldAuthentication?: ShieldAuthentication, recoveryPassword?: string): Promise<void>;
+    /**
+     * Logs in a user with email and password.
+     *
+     * @param email - User's email.
+     * @param password - User's password.
+     * @returns An AuthResponse object containing authentication details.
+     */
+    logInWithEmailPassword({ email, password }: {
+        email: string;
+        password: string;
+    }): Promise<AuthResponse>;
+    /**
+     * Signs up a new user with email and password.
+     *
+     * @param email - User's email.
+     * @param password - User's password.
+     * @param options - Additional options for the sign-up process.
+     * @returns An AuthResponse object containing authentication details.
+     */
+    signUpWithEmailPassword({ email, password, options }: {
+        email: string;
+        password: string;
+        options?: {
+            data: {
+                name: string;
+            };
+        };
+    }): Promise<AuthResponse>;
+    /**
+     * Links an email and password to an existing account using an authentication token.
+     *
+     * @param email - User's email.
+     * @param password - User's password.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    linkEmailPassword({ email, password, authToken }: {
+        email: string;
+        password: string;
+        authToken: string;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Unlinks an email and password from an existing account using an authentication token.
+     *
+     * @param email - User's email.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    unlinkEmailPassword({ email, authToken }: {
+        email: string;
+        authToken: string;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Requests an email verification link.
+     *
+     * @param email - User's email.
+     * @param redirectUrl - Redirect URL after verification.
+     */
+    requestEmailVerification({ email, redirectUrl }: {
+        email: string;
+        redirectUrl: string;
+    }): Promise<void>;
+    /**
+     * Resets the user's password.
+     *
+     * @param email - User's email.
+     * @param password - New password.
+     * @param state - Verification state.
+     */
+    resetPassword({ email, password, state }: {
+        email: string;
+        password: string;
+        state: string;
+    }): Promise<void>;
+    /**
+     * Requests a password reset link.
+     *
+     * @param email - User's email.
+     * @param redirectUrl - Redirect URL after resetting password.
+     */
+    requestResetPassword({ email, redirectUrl }: {
+        email: string;
+        redirectUrl: string;
+    }): Promise<void>;
+    /**
+     * Verifies the user's email.
+     *
+     * @param email - User's email.
+     * @param state - Verification state.
+     */
+    verifyEmail({ email, state }: {
+        email: string;
+        state: string;
+    }): Promise<void>;
+    /**
+     * Initializes an OAuth authentication process.
+     *
+     * @param provider - OAuth provider.
+     * @param options - Additional options for initialization.
+     * @returns An InitAuthResponse object.
+     */
+    initOAuth({ provider, options }: {
+        provider: OAuthProvider;
+        options?: InitializeOAuthOptions;
+    }): Promise<InitAuthResponse>;
+    /**
+     * Initializes an OAuth linking process.
+     *
+     * @param provider - OAuth provider.
+     * @param authToken - Authentication token.
+     * @param options - Additional options for initialization.
+     * @returns An InitAuthResponse object.
+     */
+    initLinkOAuth({ provider, authToken, options }: {
+        provider: OAuthProvider;
+        authToken: string;
+        options?: InitializeOAuthOptions;
+    }): Promise<InitAuthResponse>;
+    /**
+     * Unlinks an OAuth provider from the account.
+     *
+     * @param provider - OAuth provider.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    unlinkOAuth({ provider, authToken }: {
+        provider: OAuthProvider;
+        authToken: string;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Polls for OAuth authentication completion.
+     *
+     * @param key - OAuth polling key.
+     * @returns An AuthResponse object.
+     */
+    poolOAuth(key: string): Promise<AuthResponse>;
+    /**
+     * Authenticates using a third-party OAuth provider.
+     *
+     * @param provider - Third-party OAuth provider.
+     * @param token - OAuth token.
+     * @param tokenType - Type of the OAuth token.
+     * @returns An AuthPlayerResponse object.
+     */
+    authenticateWithThirdPartyProvider({ provider, token, tokenType }: {
+        provider: ThirdPartyOAuthProvider;
+        token: string;
+        tokenType: TokenType;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Initializes Sign-In with Ethereum (SIWE).
+     *
+     * @param address - Ethereum address.
+     * @returns A SIWEInitResponse object.
+     */
+    initSIWE({ address }: {
+        address: string;
+    }): Promise<SIWEInitResponse>;
+    /**
+     * Authenticates using Sign-In with Ethereum (SIWE).
+     *
+     * @param signature - SIWE signature.
+     * @param message - SIWE message.
+     * @param walletClientType - Wallet client type.
+     * @param connectorType - Connector type.
+     * @returns An AuthResponse object.
+     */
+    authenticateWithSIWE({ signature, message, walletClientType, connectorType, }: {
+        signature: string;
+        message: string;
+        walletClientType: string;
+        connectorType: string;
+    }): Promise<AuthResponse>;
+    /**
+     * Links a wallet using SIWE.
+     *
+     * @param signature - SIWE signature.
+     * @param message - SIWE message.
+     * @param walletClientType - Wallet client type.
+     * @param connectorType - Connector type.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    linkWallet({ signature, message, walletClientType, connectorType, authToken, }: {
+        signature: string;
+        message: string;
+        walletClientType: string;
+        connectorType: string;
+        authToken: string;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Unlinks a wallet.
+     *
+     * @param address - Wallet address.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    unlinkWallet({ address, authToken }: {
+        address: string;
+        authToken: string;
+    }): Promise<AuthPlayerResponse>;
+    /**
+     * Stores authentication credentials.
+     *
+     * @param auth - Authentication details.
+     */
+    storeCredentials(auth: Auth): void;
+    /**
+     * Sends a signature transaction intent request.
+     *
+     * @param transactionIntentId - Transaction intent ID.
+     * @param userOperationHash - User operation hash.
+     * @param signature - Transaction signature.
+     * @param optimistic - Whether the request is optimistic.
+     * @returns A TransactionIntentResponse object.
+     * @throws {OpenfortError} If no userOperationHash or signature is provided.
+     */
+    sendSignatureTransactionIntentRequest(transactionIntentId: string, userOperationHash?: string | null, signature?: string | null, optimistic?: boolean): Promise<TransactionIntentResponse>;
+    /**
+     * Signs a message.
+     *
+     * @param message - Message to sign.
+     * @param options - Additional options for signing.
+     * @returns The signature.
+     * @throws {OpenfortError} If no signer is configured.
+     */
+    signMessage(message: string | Uint8Array, options?: {
+        hashMessage?: boolean;
+        arrayifyMessage?: boolean;
+    }): Promise<string>;
+    /**
+     * Signs typed data.
+     *
+     * @param domain - EIP-712 domain.
+     * @param types - Typed data types.
+     * @param value - Typed data value.
+     * @returns The signature.
+     * @throws {OpenfortError} If no signer is configured.
+     */
+    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
+    /**
+     * Sends a session registration request.
+     *
+     * @param sessionId - Session ID.
+     * @param signature - Session signature.
+     * @param optimistic - Whether the request is optimistic.
+     * @returns A SessionResponse object.
+     */
+    sendRegisterSessionRequest(sessionId: string, signature: string, optimistic?: boolean): Promise<SessionResponse>;
+    /**
+     * Gets the embedded state of the current session.
+     *
+     * @returns The embedded state.
+     */
+    getEmbeddedState(): EmbeddedState;
+    /**
+     * Gets the current access token.
+     *
+     * @returns The access token, or null if not available.
+     */
+    getAccessToken(): string | null;
+    /**
+     * Retrieves the user details.
+     *
+     * @returns An AuthPlayerResponse object.
+     * @throws {OpenfortError} If no access token is found.
+     */
+    getUser(): Promise<AuthPlayerResponse>;
+    /**
+     * Validates and refreshes the access token if needed.
+     */
+    validateAndRefreshToken(): Promise<void>;
+    private credentialsProvided;
+    private recoverSigner;
+    private waitSigner;
+    private newEmbeddedSigner;
+    private flushSigner;
+}
+
+declare enum OpenfortErrorType {
+    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
+    INVALID_CONFIGURATION = "INVALID_CONFIGURATION",
+    NOT_LOGGED_IN_ERROR = "NOT_LOGGED_IN_ERROR",
+    REFRESH_TOKEN_ERROR = "REFRESH_TOKEN_ERROR",
+    USER_REGISTRATION_ERROR = "USER_REGISTRATION_ERROR",
+    LOGOUT_ERROR = "LOGOUT_ERROR",
+    OPERATION_NOT_SUPPORTED_ERROR = "OPERATION_NOT_SUPPORTED_ERROR",
+    MISSING_SESSION_SIGNER_ERROR = "MISSING_SESSION_SIGNER_ERROR",
+    MISSING_EMBEDDED_SIGNER_ERROR = "MISSING_EMBEDDED_SIGNER_ERROR",
+    MISSING_SIGNER_ERROR = "MISSING_SIGNER_ERROR"
+}
+declare class OpenfortError extends Error {
+    type: OpenfortErrorType;
+    constructor(message: string, type: OpenfortErrorType);
+}
+
+declare enum ShieldAuthProvider {
+    OPENFORT = "openfort",
+    CUSTOM = "custom"
+}
+
+interface ShieldOptions {
+    baseURL?: string;
+    apiKey: string;
+}
+
+interface ShieldAuthOptions {
+    authProvider: ShieldAuthProvider;
+}
+
+export { AuthPlayerResponse, AuthType, BasicAuthProvider, EmbeddedState, InitializeOAuthOptions, OAuthProvider, OpenfortConfiguration, OpenfortError, Provider, SDKConfiguration, SDKOverrides, SessionResponse, ShieldAuthOptions, ShieldAuthType, ShieldAuthentication, ShieldConfiguration, ShieldOptions, ThirdPartyOAuthProvider, TokenType, TransactionIntentResponse, TypedDataDomain, TypedDataField, Openfort as default };