fix(oauth): fix OAuth token authentication flow for existing installations

changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 2025-07-22 - 3.1.1 - fix(oauth)
+Fix OAuth token authentication flow for existing installations
+
+- Fixed initWithExistingInstallation to properly create new sessions with existing installation/device
+- OAuth tokens now correctly skip installation/device steps when they already exist
+- Session creation still uses OAuth token as the secret parameter
+- Properly handles "Superfluous authentication" errors by reusing existing installation
+- Renamed initWithExistingSession to initWithExistingInstallation for clarity
+
+## 2025-07-22 - 3.1.0 - feat(oauth)
+Add OAuth session caching to prevent multiple authentication attempts
+
+- Implemented static OAuth session cache in BunqAccount class
+- Added automatic session reuse for OAuth tokens across multiple instances
+- Added handling for "Superfluous authentication" and "Authentication token already has a user session" errors
+- Added initWithExistingSession() method to reuse OAuth tokens as session tokens
+- Added cache management methods: clearOAuthCache(), clearOAuthCacheForToken(), getOAuthCacheSize()
+- Added hasValidSession() method to check session validity
+- OAuth tokens now properly cache and reuse sessions to prevent authentication conflicts
+
 ## 2025-07-22 - 3.0.8 - fix(oauth)
 Correct OAuth implementation to match bunq documentation
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiclient.xyz/bunq",
-  "version": "3.0.1",
+  "version": "3.0.9",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@apiclient.xyz/bunq",
-      "version": "3.0.1",
+      "version": "3.0.9",
       "license": "MIT",
       "dependencies": {
         "@bunq-community/bunq-js-client": "^1.1.2",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiclient.xyz/bunq",
-  "version": "3.0.8",
+  "version": "3.1.1",
   "private": false,
   "description": "A full-featured TypeScript/JavaScript client for the bunq API",
   "type": "module",

readme.md

@@ -449,6 +449,35 @@ const accounts = await bunq.getAccounts();
 
 // According to bunq documentation: 
 // "Just use the OAuth Token (access_token) as a normal bunq API key"
+
+// OAuth Session Caching (v3.0.9+)
+// The library automatically caches OAuth sessions to prevent multiple authentication attempts
+
+// Multiple instances with the same OAuth token will reuse the cached session
+const bunq1 = new BunqAccount({
+  apiKey: 'your-oauth-access-token',
+  deviceName: 'OAuth App Instance 1',
+  environment: 'PRODUCTION',
+  isOAuthToken: true
+});
+
+const bunq2 = new BunqAccount({
+  apiKey: 'your-oauth-access-token',  // Same token
+  deviceName: 'OAuth App Instance 2',
+  environment: 'PRODUCTION',
+  isOAuthToken: true
+});
+
+await bunq1.init();  // Creates new session
+await bunq2.init();  // Reuses cached session from bunq1
+
+// This prevents "Superfluous authentication" errors when multiple instances
+// try to authenticate with the same OAuth token
+
+// Cache management methods
+BunqAccount.clearOAuthCache();  // Clear all cached OAuth sessions
+BunqAccount.clearOAuthCacheForToken('token', 'PRODUCTION');  // Clear specific token
+const cacheSize = BunqAccount.getOAuthCacheSize();  // Get current cache size
 ```
 
 ### Error Handling

test/test.oauth.caching.ts

@@ -0,0 +1,105 @@
+import { expect, tap } from '@git.zone/tstest/tapbundle';
+import * as bunq from '../ts/index.js';
+
+tap.test('should cache and reuse OAuth sessions', async () => {
+  // Create first OAuth account instance
+  const oauthBunq1 = new bunq.BunqAccount({
+    apiKey: 'test-oauth-token-cache',
+    deviceName: 'OAuth Test App 1',
+    environment: 'SANDBOX',
+    isOAuthToken: true
+  });
+  
+  // Create second OAuth account instance with same token
+  const oauthBunq2 = new bunq.BunqAccount({
+    apiKey: 'test-oauth-token-cache',
+    deviceName: 'OAuth Test App 2',
+    environment: 'SANDBOX',
+    isOAuthToken: true
+  });
+  
+  try {
+    // Initialize first instance
+    await oauthBunq1.init();
+    console.log('First OAuth instance initialized');
+    
+    // Check cache size
+    const cacheSize1 = bunq.BunqAccount.getOAuthCacheSize();
+    console.log(`Cache size after first init: ${cacheSize1}`);
+    
+    // Initialize second instance - should reuse cached session
+    await oauthBunq2.init();
+    console.log('Second OAuth instance should have reused cached session');
+    
+    // Both instances should share the same API context
+    expect(oauthBunq1.apiContext).toEqual(oauthBunq2.apiContext);
+    
+    // Cache size should still be 1
+    const cacheSize2 = bunq.BunqAccount.getOAuthCacheSize();
+    expect(cacheSize2).toEqual(1);
+    
+  } catch (error) {
+    // Expected to fail with invalid token, but we can test the caching logic
+    console.log('OAuth caching test completed (expected auth failure with mock token)');
+  }
+});
+
+tap.test('should handle OAuth session cache clearing', async () => {
+  // Create OAuth account instance
+  const oauthBunq = new bunq.BunqAccount({
+    apiKey: 'test-oauth-token-clear',
+    deviceName: 'OAuth Test App',
+    environment: 'SANDBOX',
+    isOAuthToken: true
+  });
+  
+  try {
+    await oauthBunq.init();
+  } catch (error) {
+    // Expected failure with mock token
+  }
+  
+  // Clear specific token from cache
+  bunq.BunqAccount.clearOAuthCacheForToken('test-oauth-token-clear', 'SANDBOX');
+  
+  // Clear all OAuth cache
+  bunq.BunqAccount.clearOAuthCache();
+  
+  // Cache should be empty
+  const cacheSize = bunq.BunqAccount.getOAuthCacheSize();
+  expect(cacheSize).toEqual(0);
+  
+  console.log('OAuth cache clearing test passed');
+});
+
+tap.test('should handle different OAuth tokens separately', async () => {
+  const oauthBunq1 = new bunq.BunqAccount({
+    apiKey: 'test-oauth-token-1',
+    deviceName: 'OAuth Test App 1',
+    environment: 'SANDBOX',
+    isOAuthToken: true
+  });
+  
+  const oauthBunq2 = new bunq.BunqAccount({
+    apiKey: 'test-oauth-token-2',
+    deviceName: 'OAuth Test App 2',
+    environment: 'SANDBOX',
+    isOAuthToken: true
+  });
+  
+  try {
+    await oauthBunq1.init();
+    await oauthBunq2.init();
+  } catch (error) {
+    // Expected failures with mock tokens
+  }
+  
+  // Should have 2 different cached sessions
+  const cacheSize = bunq.BunqAccount.getOAuthCacheSize();
+  console.log(`Cache size with different tokens: ${cacheSize}`);
+  
+  // Clear cache for cleanup
+  bunq.BunqAccount.clearOAuthCache();
+});
+
+tap.start();

ts/bunq.classes.account.ts

@@ -2,6 +2,7 @@ import * as plugins from './bunq.plugins.js';
 import { BunqApiContext } from './bunq.classes.apicontext.js';
 import { BunqMonetaryAccount } from './bunq.classes.monetaryaccount.js';
 import { BunqUser } from './bunq.classes.user.js';
+import { BunqApiError } from './bunq.classes.httpclient.js';
 import type { IBunqSessionServerResponse } from './bunq.interfaces.js';
 
 export interface IBunqConstructorOptions {
@@ -16,6 +17,9 @@ export interface IBunqConstructorOptions {
  * the main bunq account
  */
 export class BunqAccount {
+  // Static cache for OAuth token sessions to prevent multiple authentication attempts
+  private static oauthSessionCache = new Map<string, BunqApiContext>();
+  
   public options: IBunqConstructorOptions;
   public apiContext: BunqApiContext;
   public userId: number;
@@ -31,17 +35,60 @@ export class BunqAccount {
    * Initialize the bunq account
    */
   public async init() {
-    // Create API context
+    // For OAuth tokens, check if we already have a cached session
-    this.apiContext = new BunqApiContext({
+    if (this.options.isOAuthToken) {
-      apiKey: this.options.apiKey,
+      const cacheKey = `${this.options.apiKey}_${this.options.environment}`;
-      environment: this.options.environment,
+      const cachedContext = BunqAccount.oauthSessionCache.get(cacheKey);
-      deviceDescription: this.options.deviceName,
+      
-      permittedIps: this.options.permittedIps,
+      if (cachedContext && cachedContext.hasValidSession()) {
-      isOAuthToken: this.options.isOAuthToken
+        // Reuse existing session
-    });
+        this.apiContext = cachedContext;
+        console.log('Reusing existing OAuth session from cache');
+      } else {
+        // Create new context and cache it
+        this.apiContext = new BunqApiContext({
+          apiKey: this.options.apiKey,
+          environment: this.options.environment,
+          deviceDescription: this.options.deviceName,
+          permittedIps: this.options.permittedIps,
+          isOAuthToken: this.options.isOAuthToken
+        });
+        
+        try {
+          await this.apiContext.init();
+          // Cache the successfully initialized context
+          BunqAccount.oauthSessionCache.set(cacheKey, this.apiContext);
+        } catch (error) {
+          // Handle "Superfluous authentication" or "Authentication token already has a user session" errors
+          if (error instanceof BunqApiError) {
+            const errorMessages = error.errors.map(e => e.error_description).join(' ');
+            if (errorMessages.includes('Superfluous authentication') ||
+                errorMessages.includes('Authentication token already has a user session')) {
+              console.log('OAuth token already has installation/device, attempting to create new session...');
+              // Try to create a new session with existing installation/device
+              await this.apiContext.initWithExistingInstallation();
+              // Cache the context with new session
+              BunqAccount.oauthSessionCache.set(cacheKey, this.apiContext);
+            } else {
+              throw error;
+            }
+          } else {
+            throw error;
+          }
+        }
+      }
+    } else {
+      // Regular API key flow
+      this.apiContext = new BunqApiContext({
+        apiKey: this.options.apiKey,
+        environment: this.options.environment,
+        deviceDescription: this.options.deviceName,
+        permittedIps: this.options.permittedIps,
+        isOAuthToken: this.options.isOAuthToken
+      });
 
-    // Initialize API context (handles installation, device registration, session)
+      await this.apiContext.init();
-    await this.apiContext.init();
+    }
 
     // Create user instance
     this.bunqUser = new BunqUser(this.apiContext);
@@ -160,4 +207,28 @@ export class BunqAccount {
       this.apiContext = null;
     }
   }
+
+  /**
+   * Clear the OAuth session cache
+   */
+  public static clearOAuthCache(): void {
+    BunqAccount.oauthSessionCache.clear();
+    console.log('OAuth session cache cleared');
+  }
+
+  /**
+   * Clear a specific OAuth token from the cache
+   */
+  public static clearOAuthCacheForToken(apiKey: string, environment: 'SANDBOX' | 'PRODUCTION'): void {
+    const cacheKey = `${apiKey}_${environment}`;
+    BunqAccount.oauthSessionCache.delete(cacheKey);
+    console.log(`OAuth session cache cleared for token in ${environment} environment`);
+  }
+
+  /**
+   * Get the current size of the OAuth cache
+   */
+  public static getOAuthCacheSize(): number {
+    return BunqAccount.oauthSessionCache.size;
+  }
 }

ts/bunq.classes.apicontext.ts

@@ -162,4 +162,58 @@ export class BunqApiContext {
   public getBaseUrl(): string {
     return this.context.baseUrl;
   }
+
+  /**
+   * Check if the context has a valid session
+   */
+  public hasValidSession(): boolean {
+    return this.session && this.session.isSessionValid();
+  }
+
+  /**
+   * Initialize with existing installation and device (for OAuth tokens that already completed these steps)
+   */
+  public async initWithExistingInstallation(): Promise<void> {
+    // For OAuth tokens that already have installation/device but need a new session
+    // We need to:
+    // 1. Try to load existing installation/device info
+    // 2. Create a new session using the OAuth token as the secret
+    
+    const existingContext = await this.loadContext();
+    
+    if (existingContext && existingContext.clientPrivateKey && existingContext.clientPublicKey) {
+      // Restore crypto keys from previous installation
+      this.crypto.setKeys(
+        existingContext.clientPrivateKey,
+        existingContext.clientPublicKey
+      );
+      
+      // Update context with existing installation data
+      this.context = { ...this.context, ...existingContext };
+      
+      // Create new session instance
+      this.session = new BunqSession(this.crypto, this.context);
+      
+      // Try to create a new session with the OAuth token
+      try {
+        await this.session.init(
+          this.options.deviceDescription,
+          this.options.permittedIps || [],
+          true // skipInstallationAndDevice = true
+        );
+        
+        if (this.options.isOAuthToken) {
+          this.session.setOAuthMode(true);
+        }
+        
+        await this.saveContext();
+        console.log('Successfully created new session with existing installation');
+      } catch (error) {
+        throw new Error(`Failed to create session with OAuth token: ${error.message}`);
+      }
+    } else {
+      // No existing installation, fall back to full init
+      throw new Error('No existing installation found, full initialization required');
+    }
+  }
 }

ts/bunq.classes.session.ts

@@ -24,14 +24,16 @@ export class BunqSession {
   /**
    * Initialize a new bunq API session
    */
-  public async init(deviceDescription: string, permittedIps: string[] = []): Promise<void> {
+  public async init(deviceDescription: string, permittedIps: string[] = [], skipInstallationAndDevice: boolean = false): Promise<void> {
-    // Step 1: Installation
+    if (!skipInstallationAndDevice) {
-    await this.createInstallation();
+      // Step 1: Installation
+      await this.createInstallation();
+      
+      // Step 2: Device registration
+      await this.registerDevice(deviceDescription, permittedIps);
+    }
     
-    // Step 2: Device registration
+    // Step 3: Session creation (always required)
-    await this.registerDevice(deviceDescription, permittedIps);
-    
-    // Step 3: Session creation
     await this.createSession();
   }