@openfort/openfort-js 0.7.7 → 0.7.8

package/dist/index.cjs

@@ -5872,6 +5872,9 @@ class Openfort {
         this.openfortEventEmitter = new TypedEventEmitter();
         this.iframeManager = new IframeManager(this.config);
     }
+    /**
+     * Logs the user out by flushing the signer and removing credentials.
+     */
     async logout() {
         await this.flushSigner();
         if (this.credentialsProvided()) {
@@ -5901,9 +5904,14 @@ class Openfort {
             this.instanceManager.removeJWK();
         }
     }
-    getEthereumProvider(options = {
-        announceProvider: true,
-    }) {
+    /**
+     * 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: true }) {
         if (!(this.signer instanceof EmbeddedSigner)) {
             throw new OpenfortError('Embedded signer must be configured to get Ethereum provider', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
         }
@@ -5924,32 +5932,11 @@ class Openfort {
         }
         return provider;
     }
-    async flushSigner() {
-        if (this.signer) {
-            await this.signer.logout();
-            this.instanceManager.removeSignerType();
-            return;
-        }
-        const signerType = this.instanceManager.getSignerType();
-        switch (signerType) {
-            case SignerType.EMBEDDED: {
-                const iframeConfiguration = {
-                    accessToken: this.instanceManager.getAccessToken()?.token ?? null,
-                    thirdPartyProvider: this.instanceManager.getAccessToken()?.thirdPartyProvider ?? null,
-                    thirdPartyTokenType: this.instanceManager.getAccessToken()?.thirdPartyTokenType ?? null,
-                    chainId: null,
-                    recovery: null,
-                };
-                const embeddedSigner = new EmbeddedSigner(this.iframeManager, this.instanceManager, iframeConfiguration);
-                await embeddedSigner.logout();
-                break;
-            }
-            case SignerType.SESSION:
-                this.configureSessionKey();
-                break;
-        }
-        this.instanceManager.removeSignerType();
-    }
+    /**
+     * Configures a session key and returns the session key details.
+     *
+     * @returns A SessionKey object containing the address and registration status.
+     */
     configureSessionKey() {
         const signer = new SessionSigner(this.instanceManager);
         this.signer = signer;
@@ -5961,6 +5948,13 @@ class Openfort {
         this.instanceManager.setSignerType(SignerType.SESSION);
         return { address: publicKey, isRegistered: true };
     }
+    /**
+     * Configures an embedded signer.
+     *
+     * @param chainId - The chain ID for the embedded signer.
+     * @param shieldAuthentication - Shield authentication details.
+     * @param recoveryPassword - Recovery password.
+     */
     async configureEmbeddedSigner(chainId, shieldAuthentication, recoveryPassword) {
         const signer = this.newEmbeddedSigner(chainId, shieldAuthentication);
         await this.validateAndRefreshToken();
@@ -5968,20 +5962,14 @@ class Openfort {
         this.signer = signer;
         this.instanceManager.setSignerType(SignerType.EMBEDDED);
     }
-    newEmbeddedSigner(chainId, shieldAuthentication) {
-        if (!this.credentialsProvided()) {
-            throw new OpenfortError('Must be logged in to configure embedded signer', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
-        }
-        const iframeConfiguration = {
-            accessToken: this.instanceManager.getAccessToken()?.token ?? null,
-            thirdPartyProvider: this.instanceManager.getAccessToken()?.thirdPartyProvider ?? null,
-            thirdPartyTokenType: this.instanceManager.getAccessToken()?.thirdPartyTokenType ?? null,
-            chainId: !chainId ? Number(this.instanceManager.getChainID()) ?? null : chainId,
-            recovery: shieldAuthentication ?? null,
-        };
-        return new EmbeddedSigner(this.iframeManager, this.instanceManager, iframeConfiguration);
-    }
-    async 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.
+     */
+    async loginWithEmailPassword({ email, password }) {
         this.instanceManager.removeAccessToken();
         this.instanceManager.removeRefreshToken();
         this.instanceManager.removePlayerID();
@@ -5993,7 +5981,15 @@ class Openfort {
         });
         return result;
     }
-    async 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.
+     */
+    async signUpWithEmailPassword({ email, password, options }) {
         this.instanceManager.removeAccessToken();
         this.instanceManager.removeRefreshToken();
         this.instanceManager.removePlayerID();
@@ -6005,31 +6001,116 @@ class Openfort {
         });
         return result;
     }
+    /**
+     * 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.
+     */
+    async linkEmailPassword({ email, password, authToken }) {
+        const result = await this.authManager.linkEmail(email, password, authToken);
+        return result;
+    }
+    /**
+     * 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.
+     */
+    async unlinkEmailPassword({ email, authToken }) {
+        const result = await this.authManager.unlinkEmail(email, authToken);
+        return result;
+    }
+    /**
+     * Requests an email verification link.
+     *
+     * @param email - User's email.
+     * @param redirectUrl - Redirect URL after verification.
+     */
     async requestEmailVerification({ email, redirectUrl }) {
         await this.authManager.requestEmailVerification(email, redirectUrl);
     }
+    /**
+     * Resets the user's password.
+     *
+     * @param email - User's email.
+     * @param password - New password.
+     * @param state - Verification state.
+     */
     async resetPassword({ email, password, state }) {
         await this.authManager.resetPassword(email, password, state);
     }
+    /**
+     * Requests a password reset link.
+     *
+     * @param email - User's email.
+     * @param redirectUrl - Redirect URL after resetting password.
+     */
     async requestResetPassword({ email, redirectUrl }) {
         await this.authManager.requestResetPassword(email, redirectUrl);
     }
+    /**
+     * Verifies the user's email.
+     *
+     * @param email - User's email.
+     * @param state - Verification state.
+     */
     async verifyEmail({ email, state }) {
         await this.authManager.verifyEmail(email, state);
     }
+    /**
+     * Initializes an OAuth authentication process.
+     *
+     * @param provider - OAuth provider.
+     * @param options - Additional options for initialization.
+     * @returns An InitAuthResponse object.
+     */
     async initOAuth({ provider, options }) {
         const authResponse = await this.authManager.initOAuth(provider, options);
         return authResponse;
     }
-    async initLinkOAuth({ provider, playerToken, options }) {
-        return await this.authManager.linkOAuth(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.
+     */
+    async initLinkOAuth({ provider, authToken, options }) {
+        return await this.authManager.linkOAuth(provider, authToken, options);
+    }
+    /**
+     * Unlinks an OAuth provider from the account.
+     *
+     * @param provider - OAuth provider.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    async unlinkOAuth({ provider, authToken }) {
+        const result = await this.authManager.unlinkOAuth(provider, authToken);
+        return result;
     }
+    /**
+     * Polls for OAuth authentication completion.
+     *
+     * @param key - OAuth polling key.
+     * @returns An AuthResponse object.
+     */
     async poolOAuth(key) {
         return await this.authManager.poolOAuth(key);
     }
-    async initSIWE({ address }) {
-        return await this.authManager.initSIWE(address);
-    }
+    /**
+     * 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.
+     */
     async authenticateWithThirdPartyProvider({ provider, token, tokenType }) {
         const result = await this.authManager.authenticateThirdParty(provider, token, tokenType);
         this.instanceManager.setAccessToken({
@@ -6043,6 +6124,24 @@ class Openfort {
         }
         return result;
     }
+    /**
+     * Initializes Sign-In with Ethereum (SIWE).
+     *
+     * @param address - Ethereum address.
+     * @returns A SIWEInitResponse object.
+     */
+    async initSIWE({ address }) {
+        return await this.authManager.initSIWE(address);
+    }
+    /**
+     * 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.
+     */
     async authenticateWithSIWE({ signature, message, walletClientType, connectorType, }) {
         this.instanceManager.removeAccessToken();
         this.instanceManager.removeRefreshToken();
@@ -6055,6 +6154,36 @@ class Openfort {
         });
         return result;
     }
+    /**
+     * 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.
+     */
+    async linkWallet({ signature, message, walletClientType, connectorType, authToken, }) {
+        const result = await this.authManager.linkWallet(signature, message, walletClientType, connectorType, authToken);
+        return result;
+    }
+    /**
+     * Unlinks a wallet.
+     *
+     * @param address - Wallet address.
+     * @param authToken - Authentication token.
+     * @returns An AuthPlayerResponse object.
+     */
+    async unlinkWallet({ address, authToken }) {
+        const result = await this.authManager.unlinkWallet(address, authToken);
+        return result;
+    }
+    /**
+     * Stores authentication credentials.
+     *
+     * @param auth - Authentication details.
+     */
     storeCredentials(auth) {
         this.instanceManager.setAccessToken({
             token: auth.accessToken,
@@ -6064,6 +6193,15 @@ class Openfort {
         this.instanceManager.setRefreshToken(auth.refreshToken);
         this.instanceManager.setPlayerID(auth.player);
     }
+    /**
+     * 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.
+     */
     async sendSignatureTransactionIntentRequest(transactionIntentId, userOperationHash = null, signature = null) {
         let newSignature = signature;
         if (!newSignature) {
@@ -6088,6 +6226,14 @@ class Openfort {
         const result = await this.backendApiClients.transactionIntentsApi.signature(request);
         return result.data;
     }
+    /**
+     * Signs a message.
+     *
+     * @param message - Message to sign.
+     * @param options - Additional options for signing.
+     * @returns The signature.
+     * @throws {OpenfortError} If no signer is configured.
+     */
     async signMessage(message, options) {
         await this.recoverSigner();
         if (!this.signer) {
@@ -6099,6 +6245,15 @@ class Openfort {
         const { hashMessage = true, arrayifyMessage = false } = options || {};
         return await this.signer.sign(message, arrayifyMessage, hashMessage);
     }
+    /**
+     * 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.
+     */
     async signTypedData(domain, types, value) {
         await this.recoverSigner();
         if (!this.signer) {
@@ -6132,6 +6287,16 @@ class Openfort {
         }
         return await this.signer.sign(hash$1, false, false);
     }
+    /**
+     * 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.
+     */
     async sendRegisterSessionRequest(sessionId, signature, optimistic) {
         await this.recoverSigner();
         if (!this.signer) {
@@ -6150,39 +6315,11 @@ class Openfort {
         const result = await this.backendApiClients.sessionsApi.signatureSession(request);
         return result.data;
     }
-    async recoverSigner() {
-        if (this.signer) {
-            return;
-        }
-        const signerType = this.instanceManager.getSignerType();
-        if (signerType === SignerType.EMBEDDED) {
-            await this.configureEmbeddedSigner();
-            return;
-        }
-        if (signerType === SignerType.SESSION) {
-            this.configureSessionKey();
-            return;
-        }
-        await this.waitSigner();
-    }
-    async waitSigner() {
-        const retries = 100;
-        const delay = 100;
-        const checkSignerType = async (attempt) => {
-            if (attempt >= retries) {
-                return;
-            }
-            const signerType = this.instanceManager.getSignerType();
-            if (signerType) {
-                return;
-            }
-            await new Promise((resolve) => {
-                setTimeout(resolve, delay);
-            });
-            await checkSignerType(attempt + 1);
-        };
-        await checkSignerType(0);
-    }
+    /**
+     * Gets the embedded state of the current session.
+     *
+     * @returns The embedded state.
+     */
     getEmbeddedState() {
         if (!this.credentialsProvided()) {
             return exports.EmbeddedState.UNAUTHENTICATED;
@@ -6198,25 +6335,20 @@ class Openfort {
         }
         return exports.EmbeddedState.READY;
     }
-    credentialsProvided() {
-        const token = this.instanceManager.getAccessToken();
-        const refreshToken = this.instanceManager.getRefreshToken();
-        return (token
-            && ((token.token && token.thirdPartyProvider && token.thirdPartyTokenType)
-                || (token.token && refreshToken)));
-    }
+    /**
+     * Gets the current access token.
+     *
+     * @returns The access token, or null if not available.
+     */
     getAccessToken() {
         return this.instanceManager.getAccessToken()?.token ?? null;
     }
-    isLoaded() {
-        if (!this.instanceManager.getJWK()) {
-            return false;
-        }
-        if (this.signer && this.signer.getSingerType() === SignerType.EMBEDDED) {
-            return this.signer.iFrameLoaded();
-        }
-        return true;
-    }
+    /**
+     * Retrieves the user details.
+     *
+     * @returns An AuthPlayerResponse object.
+     * @throws {OpenfortError} If no access token is found.
+     */
     async getUser() {
         await this.validateAndRefreshToken();
         const accessToken = this.instanceManager.getAccessToken();
@@ -6225,6 +6357,9 @@ class Openfort {
         }
         return await this.authManager.getUser(accessToken.token);
     }
+    /**
+     * Validates and refreshes the access token if needed.
+     */
     async validateAndRefreshToken() {
         if (!this.credentialsProvided()) {
             return;
@@ -6243,9 +6378,88 @@ class Openfort {
             await this.signer.updateAuthentication();
         }
     }
+    credentialsProvided() {
+        const token = this.instanceManager.getAccessToken();
+        const refreshToken = this.instanceManager.getRefreshToken();
+        return token && ((token.token && token.thirdPartyProvider && token.thirdPartyTokenType)
+            || (token.token && refreshToken));
+    }
+    async recoverSigner() {
+        if (this.signer) {
+            return;
+        }
+        const signerType = this.instanceManager.getSignerType();
+        if (signerType === SignerType.EMBEDDED) {
+            await this.configureEmbeddedSigner();
+            return;
+        }
+        if (signerType === SignerType.SESSION) {
+            this.configureSessionKey();
+            return;
+        }
+        await this.waitSigner();
+    }
+    async waitSigner() {
+        const retries = 100;
+        const delay = 100;
+        const checkSignerType = async (attempt) => {
+            if (attempt >= retries) {
+                return;
+            }
+            const signerType = this.instanceManager.getSignerType();
+            if (signerType) {
+                return;
+            }
+            await new Promise((resolve) => {
+                setTimeout(resolve, delay);
+            });
+            await checkSignerType(attempt + 1);
+        };
+        await checkSignerType(0);
+    }
+    newEmbeddedSigner(chainId, shieldAuthentication) {
+        if (!this.credentialsProvided()) {
+            throw new OpenfortError('Must be logged in to configure embedded signer', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
+        }
+        const iframeConfiguration = {
+            accessToken: this.instanceManager.getAccessToken()?.token ?? null,
+            thirdPartyProvider: this.instanceManager.getAccessToken()?.thirdPartyProvider ?? null,
+            thirdPartyTokenType: this.instanceManager.getAccessToken()?.thirdPartyTokenType ?? null,
+            chainId: !chainId ? Number(this.instanceManager.getChainID()) ?? null : chainId,
+            recovery: shieldAuthentication ?? null,
+        };
+        return new EmbeddedSigner(this.iframeManager, this.instanceManager, iframeConfiguration);
+    }
+    async flushSigner() {
+        if (this.signer) {
+            await this.signer.logout();
+            this.instanceManager.removeSignerType();
+            return;
+        }
+        const signerType = this.instanceManager.getSignerType();
+        switch (signerType) {
+            case SignerType.EMBEDDED: {
+                const iframeConfiguration = {
+                    accessToken: this.instanceManager.getAccessToken()?.token ?? null,
+                    thirdPartyProvider: this.instanceManager.getAccessToken()?.thirdPartyProvider ?? null,
+                    thirdPartyTokenType: this.instanceManager.getAccessToken()?.thirdPartyTokenType ?? null,
+                    chainId: null,
+                    recovery: null,
+                };
+                const embeddedSigner = new EmbeddedSigner(this.iframeManager, this.instanceManager, iframeConfiguration);
+                await embeddedSigner.logout();
+                break;
+            }
+            case SignerType.SESSION:
+                this.configureSessionKey();
+                break;
+        }
+        this.instanceManager.removeSignerType();
+    }
 }
 
 exports.OpenfortConfiguration = OpenfortConfiguration;
+exports.OpenfortError = OpenfortError;
 exports.SDKConfiguration = SDKConfiguration;
 exports.ShieldConfiguration = ShieldConfiguration;
 exports.default = Openfort;