@openfort/openfort-js 0.7.8 → 0.7.9

package/dist/index.js

@@ -10,60 +10,6 @@ import { secp256k1 } from '@noble/curves/secp256k1';
 import { SigningKey } from '@ethersproject/signing-key';
 import { computeAddress } from '@ethersproject/transactions';
 
-var EmbeddedState;
-(function (EmbeddedState) {
-    EmbeddedState[EmbeddedState["NONE"] = 0] = "NONE";
-    EmbeddedState[EmbeddedState["UNAUTHENTICATED"] = 1] = "UNAUTHENTICATED";
-    EmbeddedState[EmbeddedState["EMBEDDED_SIGNER_NOT_CONFIGURED"] = 2] = "EMBEDDED_SIGNER_NOT_CONFIGURED";
-    EmbeddedState[EmbeddedState["CREATING_ACCOUNT"] = 3] = "CREATING_ACCOUNT";
-    EmbeddedState[EmbeddedState["READY"] = 4] = "READY";
-})(EmbeddedState || (EmbeddedState = {}));
-var OpenfortEvents;
-(function (OpenfortEvents) {
-    OpenfortEvents["LOGGED_OUT"] = "loggedOut";
-})(OpenfortEvents || (OpenfortEvents = {}));
-var AccountType;
-(function (AccountType) {
-    AccountType["UPGRADEABLE_V4"] = "Upgradeable_v04";
-    AccountType["MANAGED_V4"] = "Managed_v04";
-    AccountType["ERC6551_V4"] = "ERC6551_v04";
-    AccountType["ERC6551_V5"] = "ERC6551_v05";
-    AccountType["RECOVERABLE_V4"] = "Recoverable_v04";
-    AccountType["MANAGED_V5"] = "Managed_v05";
-    AccountType["UPGRADEABLE_V5"] = "Upgradeable_v05";
-})(AccountType || (AccountType = {}));
-var TokenType;
-(function (TokenType) {
-    TokenType["ID_TOKEN"] = "idToken";
-    TokenType["CUSTOM_TOKEN"] = "customToken";
-})(TokenType || (TokenType = {}));
-var ThirdPartyOAuthProvider;
-(function (ThirdPartyOAuthProvider) {
-    ThirdPartyOAuthProvider["ACCELBYTE"] = "accelbyte";
-    ThirdPartyOAuthProvider["FIREBASE"] = "firebase";
-    ThirdPartyOAuthProvider["LOOTLOCKER"] = "lootlocker";
-    ThirdPartyOAuthProvider["PLAYFAB"] = "playfab";
-    ThirdPartyOAuthProvider["SUPABASE"] = "supabase";
-    ThirdPartyOAuthProvider["CUSTOM"] = "custom";
-    ThirdPartyOAuthProvider["OIDC"] = "oidc";
-})(ThirdPartyOAuthProvider || (ThirdPartyOAuthProvider = {}));
-var BasicAuthProvider;
-(function (BasicAuthProvider) {
-    BasicAuthProvider["EMAIL"] = "email";
-    BasicAuthProvider["WALLET"] = "wallet";
-})(BasicAuthProvider || (BasicAuthProvider = {}));
-var OAuthProvider;
-(function (OAuthProvider) {
-    OAuthProvider["GOOGLE"] = "google";
-    OAuthProvider["TWITTER"] = "twitter";
-    OAuthProvider["FACEBOOK"] = "facebook";
-})(OAuthProvider || (OAuthProvider = {}));
-var CodeChallengeMethodEnum;
-(function (CodeChallengeMethodEnum) {
-    CodeChallengeMethodEnum["PLAIN"] = "plain";
-    CodeChallengeMethodEnum["S256"] = "S256";
-})(CodeChallengeMethodEnum || (CodeChallengeMethodEnum = {}));
-
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -3067,6 +3013,65 @@ const createConfig = ({ basePath, accessToken, }) => {
     return new Configuration(apiConfigOptions);
 };
 
+var EmbeddedState;
+(function (EmbeddedState) {
+    EmbeddedState[EmbeddedState["NONE"] = 0] = "NONE";
+    EmbeddedState[EmbeddedState["UNAUTHENTICATED"] = 1] = "UNAUTHENTICATED";
+    EmbeddedState[EmbeddedState["EMBEDDED_SIGNER_NOT_CONFIGURED"] = 2] = "EMBEDDED_SIGNER_NOT_CONFIGURED";
+    EmbeddedState[EmbeddedState["CREATING_ACCOUNT"] = 3] = "CREATING_ACCOUNT";
+    EmbeddedState[EmbeddedState["READY"] = 4] = "READY";
+})(EmbeddedState || (EmbeddedState = {}));
+var OpenfortEvents;
+(function (OpenfortEvents) {
+    OpenfortEvents["LOGGED_OUT"] = "loggedOut";
+})(OpenfortEvents || (OpenfortEvents = {}));
+var AccountType;
+(function (AccountType) {
+    AccountType["UPGRADEABLE_V4"] = "Upgradeable_v04";
+    AccountType["MANAGED_V4"] = "Managed_v04";
+    AccountType["ERC6551_V4"] = "ERC6551_v04";
+    AccountType["ERC6551_V5"] = "ERC6551_v05";
+    AccountType["RECOVERABLE_V4"] = "Recoverable_v04";
+    AccountType["MANAGED_V5"] = "Managed_v05";
+    AccountType["UPGRADEABLE_V5"] = "Upgradeable_v05";
+})(AccountType || (AccountType = {}));
+var AuthType;
+(function (AuthType) {
+    AuthType["OPENFORT"] = "openfort";
+    AuthType["THIRD_PARTY"] = "thirdParty";
+})(AuthType || (AuthType = {}));
+var TokenType;
+(function (TokenType) {
+    TokenType["ID_TOKEN"] = "idToken";
+    TokenType["CUSTOM_TOKEN"] = "customToken";
+})(TokenType || (TokenType = {}));
+var ThirdPartyOAuthProvider;
+(function (ThirdPartyOAuthProvider) {
+    ThirdPartyOAuthProvider["ACCELBYTE"] = "accelbyte";
+    ThirdPartyOAuthProvider["FIREBASE"] = "firebase";
+    ThirdPartyOAuthProvider["LOOTLOCKER"] = "lootlocker";
+    ThirdPartyOAuthProvider["PLAYFAB"] = "playfab";
+    ThirdPartyOAuthProvider["SUPABASE"] = "supabase";
+    ThirdPartyOAuthProvider["CUSTOM"] = "custom";
+    ThirdPartyOAuthProvider["OIDC"] = "oidc";
+})(ThirdPartyOAuthProvider || (ThirdPartyOAuthProvider = {}));
+var BasicAuthProvider;
+(function (BasicAuthProvider) {
+    BasicAuthProvider["EMAIL"] = "email";
+    BasicAuthProvider["WALLET"] = "wallet";
+})(BasicAuthProvider || (BasicAuthProvider = {}));
+var OAuthProvider;
+(function (OAuthProvider) {
+    OAuthProvider["GOOGLE"] = "google";
+    OAuthProvider["TWITTER"] = "twitter";
+    OAuthProvider["FACEBOOK"] = "facebook";
+})(OAuthProvider || (OAuthProvider = {}));
+var CodeChallengeMethodEnum;
+(function (CodeChallengeMethodEnum) {
+    CodeChallengeMethodEnum["PLAIN"] = "plain";
+    CodeChallengeMethodEnum["S256"] = "S256";
+})(CodeChallengeMethodEnum || (CodeChallengeMethodEnum = {}));
+
 var OpenfortErrorType;
 (function (OpenfortErrorType) {
     OpenfortErrorType["AUTHENTICATION_ERROR"] = "AUTHENTICATION_ERROR";
@@ -4601,8 +4606,8 @@ class EvmProvider {
 const openfortProviderInfo = {
     // eslint-disable-next-line max-len
     icon: 'data:image/svg+xml,<svg aria-hidden="true" viewBox="597.32 331.34 171.36 105.32" ><g><rect x="673.9" y="404.26" width="18.2" height="32.4" /><polygon points="768.68,331.36 768.68,331.36 768.68,331.34 610.78,331.34 610.78,331.36 597.32,331.36 597.32,436.64    615.52,436.64 615.52,349.54 750.48,349.54 750.48,436.64 768.68,436.64  " /><polygon points="732.16,367.79 633.83,367.79 633.83,370.19 633.79,370.19 633.79,436.64 651.99,436.64 651.99,385.99    713.9,385.99 713.9,436.64 732.09,436.64 732.09,385.99 732.16,385.99  " /></g></svg>',
-    name: 'Ecosystem ID',
-    rdns: 'com.ecosystem.id',
+    name: 'Openfort',
+    rdns: 'xyz.openfort',
     uuid: v4(),
 };
 function announceProvider(detail) {
@@ -4660,11 +4665,14 @@ class AuthManager {
         this.instanceManager = instanceManager;
     }
     async initOAuth(provider, options) {
+        const usePooling = options?.usePooling ?? false;
+        // eslint-disable-next-line no-param-reassign
+        delete options?.usePooling;
         const request = {
             oAuthInitRequest: {
                 provider,
                 options,
-                usePooling: options?.usePooling || false,
+                usePooling,
             },
         };
         const result = await this.backendApiClients.authenticationApi.initOAuth(request);
@@ -4846,7 +4854,13 @@ class AuthManager {
             return response.data;
         }, OpenfortErrorType.USER_REGISTRATION_ERROR);
     }
-    async validateCredentials(accessToken, refreshToken, jwk) {
+    async validateCredentials() {
+        const jwk = await this.instanceManager.getJWK();
+        const accessToken = this.instanceManager.getAccessToken()?.token;
+        const refreshToken = this.instanceManager.getRefreshToken();
+        if (!accessToken || !refreshToken || !jwk) {
+            throw new OpenfortError('Must be logged in to validate and refresh token', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
+        }
         try {
             const key = (await importJWK({
                 kty: jwk.kty,
@@ -5022,6 +5036,8 @@ const chainIDStorageKey = 'openfort.chain_id';
 const jwksStorageKey = 'openfort.jwk';
 const deviceIDStorageKey = 'openfort.device_id';
 const accountTypeStorageKey = 'openfort.account_type';
+const shieldAuthTypeStorageKey = 'openfort.shield_auth_type';
+const shieldAuthTokenStorageKey = 'openfort.shield_auth_token';
 const accountAddressStorageKey = 'openfort.account_address';
 
 class InstanceManager {
@@ -5031,6 +5047,7 @@ class InstanceManager {
     jwk = null;
     sessionKey = null;
     deviceID = null;
+    shieldAuthType = null;
     chainId = null;
     accountAddress = null;
     accountType = null;
@@ -5162,9 +5179,10 @@ class InstanceManager {
             };
             const response = await this.backendApiClients.authenticationApi.getJwks(request);
             if (response.data.keys.length === 0) {
-                throw new Error('No keys found');
+                throw new Error('Internal error: No JWKS keys found');
             }
             const jwtKey = response.data.keys[0];
+            this.setJWK(jwtKey);
             this.jwk = {
                 kty: jwtKey.kty,
                 crv: jwtKey.crv,
@@ -5249,6 +5267,34 @@ class InstanceManager {
         this.accountType = null;
         this.persistentStorage.remove(accountTypeStorageKey);
     }
+    setShieldAuthType(accountType) {
+        this.accountType = accountType;
+        this.persistentStorage.save(shieldAuthTypeStorageKey, accountType);
+    }
+    getShieldAuthType() {
+        if (!this.accountType) {
+            this.accountType = this.persistentStorage.get(shieldAuthTypeStorageKey);
+        }
+        return this.accountType;
+    }
+    removeShieldAuthType() {
+        this.accountType = null;
+        this.persistentStorage.remove(shieldAuthTypeStorageKey);
+    }
+    setShieldAuthToken(accountType) {
+        this.accountType = accountType;
+        this.persistentStorage.save(shieldAuthTokenStorageKey, accountType);
+    }
+    getShieldAuthToken() {
+        if (!this.accountType) {
+            this.accountType = this.persistentStorage.get(shieldAuthTokenStorageKey);
+        }
+        return this.accountType;
+    }
+    removeShieldAuthToken() {
+        this.accountType = null;
+        this.persistentStorage.remove(shieldAuthTokenStorageKey);
+    }
 }
 
 class LocalStorage {
@@ -5594,11 +5640,11 @@ class UpdateAuthenticationRequest {
         this.recovery = recovery;
     }
 }
-var AuthType;
-(function (AuthType) {
-    AuthType["OPENFORT"] = "openfort";
-    AuthType["CUSTOM"] = "custom";
-})(AuthType || (AuthType = {}));
+var ShieldAuthType;
+(function (ShieldAuthType) {
+    ShieldAuthType["OPENFORT"] = "openfort";
+    ShieldAuthType["CUSTOM"] = "custom";
+})(ShieldAuthType || (ShieldAuthType = {}));
 
 class MissingRecoveryPasswordError extends Error {
     constructor() {
@@ -5879,6 +5925,8 @@ class Openfort {
             this.instanceManager.removeChainID();
             this.instanceManager.removeDeviceID();
             this.instanceManager.removeJWK();
+            this.instanceManager.removeShieldAuthType();
+            this.instanceManager.removeShieldAuthToken();
         }
     }
     /**
@@ -5915,6 +5963,9 @@ class Openfort {
      * @returns A SessionKey object containing the address and registration status.
      */
     configureSessionKey() {
+        if (this.instanceManager.getSignerType() === SignerType.EMBEDDED) {
+            throw new OpenfortError('Session signer must be configured to sign a session', OpenfortErrorType.MISSING_SESSION_SIGNER_ERROR);
+        }
         const signer = new SessionSigner(this.instanceManager);
         this.signer = signer;
         const publicKey = signer.loadKeys();
@@ -5933,8 +5984,14 @@ class Openfort {
      * @param recoveryPassword - Recovery password.
      */
     async configureEmbeddedSigner(chainId, shieldAuthentication, recoveryPassword) {
-        const signer = this.newEmbeddedSigner(chainId, shieldAuthentication);
         await this.validateAndRefreshToken();
+        if (shieldAuthentication) {
+            this.instanceManager.setShieldAuthType(shieldAuthentication?.auth);
+            if (shieldAuthentication?.auth === ShieldAuthType.CUSTOM) {
+                this.instanceManager.setShieldAuthToken(shieldAuthentication?.token);
+            }
+        }
+        const signer = this.newEmbeddedSigner(chainId);
         await signer.ensureEmbeddedAccount(recoveryPassword);
         this.signer = signer;
         this.instanceManager.setSignerType(SignerType.EMBEDDED);
@@ -5946,10 +6003,8 @@ class Openfort {
      * @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();
+    async logInWithEmailPassword({ email, password }) {
+        this.logout();
         const result = await this.authManager.loginEmailPassword(email, password);
         this.storeCredentials({
             player: result.player.id,
@@ -5967,9 +6022,7 @@ class Openfort {
      * @returns An AuthResponse object containing authentication details.
      */
     async signUpWithEmailPassword({ email, password, options }) {
-        this.instanceManager.removeAccessToken();
-        this.instanceManager.removeRefreshToken();
-        this.instanceManager.removePlayerID();
+        this.logout();
         const result = await this.authManager.signupEmailPassword(email, password, options?.data.name);
         this.storeCredentials({
             player: result.player.id,
@@ -6046,6 +6099,7 @@ class Openfort {
      * @returns An InitAuthResponse object.
      */
     async initOAuth({ provider, options }) {
+        this.logout();
         const authResponse = await this.authManager.initOAuth(provider, options);
         return authResponse;
     }
@@ -6168,7 +6222,8 @@ class Openfort {
             thirdPartyTokenType: null,
         });
         this.instanceManager.setRefreshToken(auth.refreshToken);
-        this.instanceManager.setPlayerID(auth.player);
+        if (auth.player)
+            this.instanceManager.setPlayerID(auth.player);
     }
     /**
      * Sends a signature transaction intent request.
@@ -6176,10 +6231,11 @@ class Openfort {
      * @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.
      */
-    async sendSignatureTransactionIntentRequest(transactionIntentId, userOperationHash = null, signature = null) {
+    async sendSignatureTransactionIntentRequest(transactionIntentId, userOperationHash = null, signature = null, optimistic = false) {
         let newSignature = signature;
         if (!newSignature) {
             if (!userOperationHash) {
@@ -6198,6 +6254,7 @@ class Openfort {
             id: transactionIntentId,
             signatureRequest: {
                 signature: newSignature,
+                optimistic,
             },
         };
         const result = await this.backendApiClients.transactionIntentsApi.signature(request);
@@ -6271,17 +6328,8 @@ class Openfort {
      * @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) {
-            throw new OpenfortError('No signer configured nor signature provided', OpenfortErrorType.MISSING_SIGNER_ERROR);
-        }
-        if (this.signer.getSingerType() !== SignerType.SESSION) {
-            throw new OpenfortError('Session signer must be configured to sign a session', OpenfortErrorType.MISSING_SESSION_SIGNER_ERROR);
-        }
         const request = {
             id: sessionId,
             signatureRequest: {
@@ -6338,28 +6386,31 @@ class Openfort {
      * Validates and refreshes the access token if needed.
      */
     async validateAndRefreshToken() {
-        if (!this.credentialsProvided()) {
-            return;
+        const authType = this.credentialsProvided();
+        if (!authType) {
+            throw new OpenfortError('Must be logged in to validate and refresh token', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
         }
-        const accessToken = this.instanceManager.getAccessToken();
-        const refreshToken = this.instanceManager.getRefreshToken();
-        const jwk = await this.instanceManager.getJWK();
-        if (!accessToken || !refreshToken || !jwk) {
-            return;
-        }
-        const auth = await this.authManager.validateCredentials(accessToken.token, refreshToken, jwk);
-        if (auth.accessToken !== accessToken.token) {
+        if (authType === AuthType.OPENFORT) {
+            const auth = await this.authManager.validateCredentials();
             this.storeCredentials(auth);
-        }
-        if (this.signer && this.signer.useCredentials()) {
-            await this.signer.updateAuthentication();
+            if (this.signer && this.signer.useCredentials()) {
+                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));
+        if (!token) {
+            return null;
+        }
+        if (token.token && token.thirdPartyProvider && token.thirdPartyTokenType) {
+            return AuthType.THIRD_PARTY;
+        }
+        if (token.token && refreshToken) {
+            return AuthType.OPENFORT;
+        }
+        return null;
     }
     async recoverSigner() {
         if (this.signer) {
@@ -6394,16 +6445,33 @@ class Openfort {
         };
         await checkSignerType(0);
     }
-    newEmbeddedSigner(chainId, shieldAuthentication) {
+    newEmbeddedSigner(chainId) {
         if (!this.credentialsProvided()) {
             throw new OpenfortError('Must be logged in to configure embedded signer', OpenfortErrorType.NOT_LOGGED_IN_ERROR);
         }
+        let shieldAuthType = this.instanceManager.getShieldAuthType();
+        if (!shieldAuthType) {
+            // TODO: remove, this is for backward compatibility
+            this.instanceManager.setShieldAuthType(ShieldAuthType.OPENFORT);
+            shieldAuthType = ShieldAuthType.OPENFORT;
+            // throw new OpenfortError('Shield auth type is not set', OpenfortErrorType.INVALID_CONFIGURATION);
+        }
+        const token = shieldAuthType === ShieldAuthType.OPENFORT
+            ? this.instanceManager.getAccessToken()?.token
+            : this.instanceManager.getShieldAuthToken();
+        if (!token) {
+            throw new OpenfortError('Shield auth token is not set', OpenfortErrorType.INVALID_CONFIGURATION);
+        }
+        const shieldAuth = {
+            auth: shieldAuthType,
+            token,
+        };
         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,
+            recovery: shieldAuth,
         };
         return new EmbeddedSigner(this.iframeManager, this.instanceManager, iframeConfiguration);
     }
@@ -6435,4 +6503,4 @@ class Openfort {
     }
 }
 
-export { AuthType, BasicAuthProvider, EmbeddedState, OAuthProvider, OpenfortConfiguration, OpenfortError, SDKConfiguration, ShieldConfiguration, ThirdPartyOAuthProvider, TokenType, Openfort as default };
+export { AuthType, BasicAuthProvider, EmbeddedState, OAuthProvider, OpenfortConfiguration, OpenfortError, SDKConfiguration, ShieldAuthType, ShieldConfiguration, ThirdPartyOAuthProvider, TokenType, Openfort as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfort/openfort-js",
-  "version": "0.7.8",
+  "version": "0.7.9",
   "author": "Openfort (https://www.openfort.xyz)",
   "bugs": "https://github.com/openfort-xyz/openfort-js/issues",
   "repository": "openfort-xyz/openfort-js.git",