@openfort/openfort-js 0.7.7 → 0.7.8

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-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 { SessionKey, AuthResponse, AuthPlayerResponse as AuthPlayerResponse$1, OAuthProvider as OAuthProvider$1, InitializeOAuthOptions as InitializeOAuthOptions$1, InitAuthResponse, ThirdPartyOAuthProvider as ThirdPartyOAuthProvider$1, TokenType as TokenType$1, SIWEInitResponse, 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';
 
@@ -76,20 +76,55 @@ declare class Openfort {
     private readonly iframeManager;
     private readonly openfortEventEmitter;
     constructor(sdkConfiguration: SDKConfiguration$1);
+    /**
+     * 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$1;
-    private flushSigner;
+    /**
+     * 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>;
-    private newEmbeddedSigner;
-    loginWithEmailPassword({ email, password, }: {
+    /**
+     * 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>;
-    signUpWithEmailPassword({ email, password, options, }: {
+    /**
+     * 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?: {
@@ -98,63 +133,273 @@ declare class Openfort {
             };
         };
     }): 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$1>;
+    /**
+     * 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$1>;
+    /**
+     * 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$1;
         options?: InitializeOAuthOptions$1;
     }): Promise<InitAuthResponse>;
-    initLinkOAuth({ provider, playerToken, options }: {
+    /**
+     * 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$1;
-        playerToken: string;
+        authToken: string;
         options?: InitializeOAuthOptions$1;
     }): 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$1;
+        authToken: string;
+    }): Promise<AuthPlayerResponse$1>;
+    /**
+     * Polls for OAuth authentication completion.
+     *
+     * @param key - OAuth polling key.
+     * @returns An AuthResponse object.
+     */
     poolOAuth(key: string): Promise<AuthResponse>;
-    initSIWE({ address }: {
-        address: string;
-    }): Promise<SIWEInitResponse>;
+    /**
+     * 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$1;
         token: string;
         tokenType: TokenType$1;
     }): Promise<AuthPlayerResponse$1>;
+    /**
+     * 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$1>;
+    /**
+     * Unlinks a wallet.
+     *
+     * @param address - Wallet address.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    unlinkWallet({ address, authToken }: {
+        address: string;
+        authToken: string;
+    }): Promise<AuthPlayerResponse$1>;
+    /**
+     * 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.
+     * @returns A TransactionIntentResponse object.
+     * @throws {OpenfortError} If no userOperationHash or signature is provided.
+     */
     sendSignatureTransactionIntentRequest(transactionIntentId: string, userOperationHash?: string | null, signature?: string | null): Promise<TransactionIntentResponse$1>;
+    /**
+     * 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.
+     * @throws {OpenfortError} If no signer is configured.
+     * @throws {OpenfortError} If the signer is not a SessionSigner.
+     */
     sendRegisterSessionRequest(sessionId: string, signature: string, optimistic?: boolean): Promise<SessionResponse$1>;
-    private recoverSigner;
-    private waitSigner;
+    /**
+     * Gets the embedded state of the current session.
+     *
+     * @returns The embedded state.
+     */
     getEmbeddedState(): EmbeddedState$1;
-    private credentialsProvided;
+    /**
+     * Gets the current access token.
+     *
+     * @returns The access token, or null if not available.
+     */
     getAccessToken(): string | null;
-    isLoaded(): boolean;
+    /**
+     * Retrieves the user details.
+     *
+     * @returns An AuthPlayerResponse object.
+     * @throws {OpenfortError} If no access token is found.
+     */
     getUser(): Promise<AuthPlayerResponse$1>;
+    /**
+     * 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 {
@@ -594,4 +839,4 @@ declare class SDKConfiguration {
     });
 }
 
-export { AuthPlayerResponse, AuthType, BasicAuthProvider, EmbeddedState, InitializeOAuthOptions, OAuthProvider, OpenfortConfiguration, Provider, SDKConfiguration, SDKOverrides, SessionResponse, ShieldAuthOptions, ShieldAuthentication, ShieldConfiguration, ShieldOptions, ThirdPartyOAuthProvider, TokenType, TransactionIntentResponse, TypedDataDomain, TypedDataField, Openfort as default };
+export { AuthPlayerResponse, AuthType, BasicAuthProvider, EmbeddedState, InitializeOAuthOptions, OAuthProvider, OpenfortConfiguration, OpenfortError, Provider, SDKConfiguration, SDKOverrides, SessionResponse, ShieldAuthOptions, ShieldAuthentication, ShieldConfiguration, ShieldOptions, ThirdPartyOAuthProvider, TokenType, TransactionIntentResponse, TypedDataDomain, TypedDataField, Openfort as default };