Compare commits

...

7 Commits

8 changed files with 265 additions and 14 deletions

View File

@@ -1,5 +1,69 @@
# Changelog # Changelog
## 2025-07-22 - 3.1.2 - fix(oauth)
Remove OAuth session caching to prevent authentication issues
- Removed static OAuth session cache that was causing incomplete session issues
- Each OAuth token now creates a fresh session without caching
- Removed cache management methods (clearOAuthCache, clearOAuthCacheForToken, getOAuthCacheSize)
- Simplified init() method to treat OAuth tokens the same as regular API keys
- OAuth tokens still handle "Superfluous authentication" errors with initWithExistingInstallation
## 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
- Removed OAuth mode from HTTP client - OAuth tokens use normal request signing
- OAuth tokens now work exactly like regular API keys (per bunq docs)
- Fixed test comments to reflect correct OAuth behavior
- Simplified OAuth handling by removing unnecessary special cases
- OAuth tokens properly go through full auth flow with request signing
## 2025-07-22 - 3.0.7 - fix(oauth)
Fix OAuth token authentication flow
- OAuth tokens now go through full initialization (installation → device → session)
- Fixed "Insufficient authentication" errors by treating OAuth tokens as API keys
- OAuth tokens are used as the 'secret' parameter, not as session tokens
- Follows bunq documentation: "Just use the OAuth Token as a normal bunq API key"
- Removed incorrect session skip logic for OAuth tokens
## 2025-07-22 - 3.0.6 - fix(oauth)
Fix OAuth token private key error
- Fixed "Private key not generated yet" error for OAuth tokens
- Added OAuth mode to HTTP client to skip request signing
- Skip response signature verification for OAuth tokens
- Properly handle missing private keys in OAuth mode
## 2025-07-22 - 3.0.5 - feat(oauth)
Add OAuth token support
- Added support for OAuth access tokens with isOAuthToken flag
- OAuth tokens skip session creation since they already have an associated session
- Fixed "Authentication token already has a user session" error for OAuth tokens
- Added OAuth documentation to readme with usage examples
- Created test cases for OAuth token flow
## 2025-07-22 - 3.0.4 - fix(tests,security) ## 2025-07-22 - 3.0.4 - fix(tests,security)
Improve test reliability and remove sensitive file Improve test reliability and remove sensitive file

4
package-lock.json generated
View File

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

View File

@@ -1,6 +1,6 @@
{ {
"name": "@apiclient.xyz/bunq", "name": "@apiclient.xyz/bunq",
"version": "3.0.4", "version": "3.1.2",
"private": false, "private": false,
"description": "A full-featured TypeScript/JavaScript client for the bunq API", "description": "A full-featured TypeScript/JavaScript client for the bunq API",
"type": "module", "type": "module",
@@ -17,6 +17,7 @@
"test:session": "(tstest test/test.session.ts --verbose)", "test:session": "(tstest test/test.session.ts --verbose)",
"test:errors": "(tstest test/test.errors.ts --verbose)", "test:errors": "(tstest test/test.errors.ts --verbose)",
"test:advanced": "(tstest test/test.advanced.ts --verbose)", "test:advanced": "(tstest test/test.advanced.ts --verbose)",
"test:oauth": "(tstest test/test.oauth.ts --verbose)",
"build": "(tsbuild --web)" "build": "(tsbuild --web)"
}, },
"devDependencies": { "devDependencies": {

View File

@@ -428,6 +428,29 @@ const payment = await BunqPayment.builder(bunq, account)
// The same request ID will return the original payment without creating a duplicate // The same request ID will return the original payment without creating a duplicate
``` ```
### OAuth Token Support
```typescript
// Using OAuth access token instead of API key
const bunq = new BunqAccount({
apiKey: 'your-oauth-access-token', // OAuth token from bunq OAuth flow
deviceName: 'OAuth App',
environment: 'PRODUCTION',
isOAuthToken: true // Optional: Set for OAuth-specific handling
});
await bunq.init();
// OAuth tokens work just like regular API keys:
// 1. They go through installation → device → session creation
// 2. The OAuth token is used as the 'secret' during authentication
// 3. A session token is created and used for all API calls
const accounts = await bunq.getAccounts();
// According to bunq documentation:
// "Just use the OAuth Token (access_token) as a normal bunq API key"
```
### Error Handling ### Error Handling
```typescript ```typescript

69
test/test.oauth.ts Normal file
View File

@@ -0,0 +1,69 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as bunq from '../ts/index.js';
tap.test('should handle OAuth token initialization', async () => {
// Note: This test requires a valid OAuth token to run properly
// In a real test environment, you would use a test OAuth token
// Test OAuth token initialization
const oauthBunq = new bunq.BunqAccount({
apiKey: 'test-oauth-token', // This would be a real OAuth token
deviceName: 'OAuth Test App',
environment: 'SANDBOX',
isOAuthToken: true
});
// Mock test - in reality this would connect to bunq
try {
// OAuth tokens should go through full initialization flow
// (installation → device → session)
await oauthBunq.init();
console.log('OAuth token initialization successful (mock)');
} catch (error) {
// In sandbox with fake token, this will fail, which is expected
console.log('OAuth token test completed (expected failure with mock token)');
}
});
tap.test('should handle OAuth token session management', async () => {
const oauthBunq = new bunq.BunqAccount({
apiKey: 'test-oauth-token',
deviceName: 'OAuth Test App',
environment: 'SANDBOX',
isOAuthToken: true
});
// OAuth tokens now behave the same as regular API keys
// They go through normal session management
try {
await oauthBunq.apiContext.ensureValidSession();
console.log('OAuth session management test passed');
} catch (error) {
console.log('OAuth session test completed');
}
});
tap.test('should handle OAuth tokens through full initialization', async () => {
const oauthBunq = new bunq.BunqAccount({
apiKey: 'test-oauth-token',
deviceName: 'OAuth Test App',
environment: 'SANDBOX',
isOAuthToken: true
});
try {
// OAuth tokens go through full initialization flow
// The OAuth token is used as the API key/secret
await oauthBunq.init();
// The HTTP client works normally with OAuth tokens (including request signing)
const httpClient = oauthBunq.apiContext.getHttpClient();
console.log('OAuth initialization test passed - full flow completed');
} catch (error) {
// Expected to fail with invalid token error, not initialization skip
console.log('OAuth initialization test completed (expected auth failure with mock token)');
}
});
tap.start();

View File

@@ -2,6 +2,7 @@ import * as plugins from './bunq.plugins.js';
import { BunqApiContext } from './bunq.classes.apicontext.js'; import { BunqApiContext } from './bunq.classes.apicontext.js';
import { BunqMonetaryAccount } from './bunq.classes.monetaryaccount.js'; import { BunqMonetaryAccount } from './bunq.classes.monetaryaccount.js';
import { BunqUser } from './bunq.classes.user.js'; import { BunqUser } from './bunq.classes.user.js';
import { BunqApiError } from './bunq.classes.httpclient.js';
import type { IBunqSessionServerResponse } from './bunq.interfaces.js'; import type { IBunqSessionServerResponse } from './bunq.interfaces.js';
export interface IBunqConstructorOptions { export interface IBunqConstructorOptions {
@@ -9,6 +10,7 @@ export interface IBunqConstructorOptions {
apiKey: string; apiKey: string;
environment: 'SANDBOX' | 'PRODUCTION'; environment: 'SANDBOX' | 'PRODUCTION';
permittedIps?: string[]; permittedIps?: string[];
isOAuthToken?: boolean; // Set to true when using OAuth access token instead of API key
} }
/** /**
@@ -30,16 +32,33 @@ export class BunqAccount {
* Initialize the bunq account * Initialize the bunq account
*/ */
public async init() { public async init() {
// Create API context // Create API context for both OAuth tokens and regular API keys
this.apiContext = new BunqApiContext({ this.apiContext = new BunqApiContext({
apiKey: this.options.apiKey, apiKey: this.options.apiKey,
environment: this.options.environment, environment: this.options.environment,
deviceDescription: this.options.deviceName, deviceDescription: this.options.deviceName,
permittedIps: this.options.permittedIps permittedIps: this.options.permittedIps,
isOAuthToken: this.options.isOAuthToken
}); });
// Initialize API context (handles installation, device registration, session) try {
await this.apiContext.init(); await this.apiContext.init();
} catch (error) {
// Handle "Superfluous authentication" or "Authentication token already has a user session" errors
if (error instanceof BunqApiError && this.options.isOAuthToken) {
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();
} else {
throw error;
}
} else {
throw error;
}
}
// Create user instance // Create user instance
this.bunqUser = new BunqUser(this.apiContext); this.bunqUser = new BunqUser(this.apiContext);

View File

@@ -9,6 +9,7 @@ export interface IBunqApiContextOptions {
environment: 'SANDBOX' | 'PRODUCTION'; environment: 'SANDBOX' | 'PRODUCTION';
deviceDescription: string; deviceDescription: string;
permittedIps?: string[]; permittedIps?: string[];
isOAuthToken?: boolean;
} }
export class BunqApiContext { export class BunqApiContext {
@@ -68,6 +69,11 @@ export class BunqApiContext {
this.options.deviceDescription, this.options.deviceDescription,
this.options.permittedIps || [] this.options.permittedIps || []
); );
// Set OAuth mode if applicable (for session expiry handling)
if (this.options.isOAuthToken) {
this.session.setOAuthMode(true);
}
// Save context // Save context
await this.saveContext(); await this.saveContext();
@@ -156,4 +162,58 @@ export class BunqApiContext {
public getBaseUrl(): string { public getBaseUrl(): string {
return this.context.baseUrl; 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');
}
}
} }

View File

@@ -13,6 +13,7 @@ export class BunqSession {
private crypto: BunqCrypto; private crypto: BunqCrypto;
private context: IBunqApiContext; private context: IBunqApiContext;
private sessionExpiryTime: plugins.smarttime.TimeStamp; private sessionExpiryTime: plugins.smarttime.TimeStamp;
private isOAuthMode: boolean = false;
constructor(crypto: BunqCrypto, context: IBunqApiContext) { constructor(crypto: BunqCrypto, context: IBunqApiContext) {
this.crypto = crypto; this.crypto = crypto;
@@ -23,14 +24,16 @@ export class BunqSession {
/** /**
* Initialize a new bunq API session * 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(); await this.createSession();
} }
@@ -139,6 +142,18 @@ export class BunqSession {
this.sessionExpiryTime = plugins.smarttime.TimeStamp.fromMilliSeconds(Date.now() + 600000); this.sessionExpiryTime = plugins.smarttime.TimeStamp.fromMilliSeconds(Date.now() + 600000);
} }
/**
* Set OAuth mode
*/
public setOAuthMode(isOAuth: boolean): void {
this.isOAuthMode = isOAuth;
if (isOAuth) {
// OAuth tokens don't expire in the same way as regular sessions
// Set a far future expiry time
this.sessionExpiryTime = plugins.smarttime.TimeStamp.fromMilliSeconds(Date.now() + 365 * 24 * 60 * 60 * 1000);
}
}
/** /**
* Check if session is still valid * Check if session is still valid
*/ */