@stamhoofd/backend 2.143.1 → 2.145.0

package/tests/helpers/MollieMocker.ts

@@ -25,6 +25,9 @@ export type MollieMockPayment = {
     mandateId: string | null;
     isCancelable: boolean;
     details: Record<string, unknown> | null;
+    description?: string;
+    profileId?: string | null;
+    createdAt?: string;
 };
 
 export type MollieMockMandate = {
@@ -53,13 +56,6 @@ export type MollieMockRefund = {
     metadata: Record<string, unknown> | null;
 };
 
-export type MollieMockSettlementCost = {
-    description: string;
-    method: string | null;
-    amountNet: { currency: string; value: string };
-    amountVat: { currency: string; value: string } | null;
-};
-
 export type MollieMockSettlement = {
     id: string;
     reference: string;
@@ -68,10 +64,6 @@ export type MollieMockSettlement = {
     createdAt: string;
     /** null for the still-open settlement, a date once it has been paid out */
     settledAt: string | null;
-    /** id of the invoice Mollie created for the settlement costs, null until it exists */
-    invoiceId: string | null;
-    /** Mollie's own costs per period, keyed year → month */
-    periods: Record<string, Record<string, { costs: MollieMockSettlementCost[]; invoiceId?: string | null }>>;
     /** Mollie payment ids (tr_...) settled in this settlement */
     paymentIds: string[];
     /** Mollie refund ids (re_...) settled in this settlement */
@@ -80,14 +72,21 @@ export type MollieMockSettlement = {
     chargebackIds: string[];
 };
 
+export type MollieMockBalanceTransaction = {
+    id: string;
+    type: string;
+    createdAt: string;
+    deductions: { currency: string; value: string } | null;
+    deductionDetails: { fees?: { currency: string; value: string } } | null;
+    context: Record<string, string> | null;
+};
+
 const MOLLIE_CHECKOUT_URL = 'https://molliecheckout/';
 
 /**
  * Mirrors the StripeMocker (tests/helpers/StripeMocker.ts) but for Mollie.
  *
- * The Mollie node client (@mollie/api-client v4) performs its HTTP requests through node-fetch v2,
- * which uses Node's http/https module under the hood. nock can therefore intercept every call to
- * https://api.mollie.com - exactly like the StripeMocker does for Stripe.
+ * The Mollie client sends every API call to https://api.mollie.com, which nock intercepts here.
  *
  * Usage:
  *   const mollieMocker = new MollieMocker();
@@ -104,6 +103,7 @@ export class MollieMocker {
     chargebacks: MollieMockChargeback[] = [];
     refunds: MollieMockRefund[] = [];
     settlements: MollieMockSettlement[] = [];
+    balanceTransactions: MollieMockBalanceTransaction[] = [];
 
     /**
      * Cap the settlements list page size below the requested limit, to exercise pagination
@@ -111,8 +111,30 @@ export class MollieMocker {
      */
     settlementsPageSize: number | null = null;
 
+    /**
+     * Same, for the balance transactions list.
+     */
+    balanceTransactionsPageSize: number | null = null;
+
     #forceFailure = false;
 
+    // The SDK validates responses with zod: these links are required on most resources
+    #dashboardLink = { href: 'https://www.mollie.com/dashboard', type: 'text/html' };
+    #documentationLink = { href: 'https://docs.mollie.com', type: 'text/html' };
+
+    /**
+     * A Mollie error body, complete enough for the SDK to parse it as an ErrorResponse.
+     */
+    #errorBody(status: number, title: string, detail: string, field?: string) {
+        return {
+            status,
+            title,
+            detail,
+            field,
+            _links: { documentation: this.#documentationLink },
+        };
+    }
+
     reset() {
         this.payments = [];
         this.customers = [];
@@ -120,7 +142,9 @@ export class MollieMocker {
         this.chargebacks = [];
         this.refunds = [];
         this.settlements = [];
+        this.balanceTransactions = [];
         this.settlementsPageSize = null;
+        this.balanceTransactionsPageSize = null;
         this.#forceFailure = false;
     }
 
@@ -162,15 +186,18 @@ export class MollieMocker {
         const interceptor = nock('https://api.mollie.com').persist();
 
         interceptor.get(matcher).reply((uri) => {
-            return this.#handle('GET', uri, undefined);
+            const [status, body] = this.#handle('GET', uri, undefined);
+            return [status, body, { 'content-type': 'application/hal+json' }];
         });
 
         interceptor.post(matcher).reply((uri, body) => {
-            return this.#handle('POST', uri, body);
+            const [status, responseBody] = this.#handle('POST', uri, body);
+            return [status, responseBody, { 'content-type': 'application/hal+json' }];
         });
 
         interceptor.delete(matcher).reply((uri, body) => {
-            return this.#handle('DELETE', uri, body);
+            const [status, responseBody] = this.#handle('DELETE', uri, body);
+            return [status, responseBody, { 'content-type': 'application/hal+json' }];
         });
     }
 
@@ -238,10 +265,19 @@ export class MollieMocker {
             return [200, this.#onboarding()];
         }
 
+        if (parts[0] === 'onboarding' && method === 'POST') {
+            return [204];
+        }
+
         if (parts[0] === 'chargebacks' && method === 'GET') {
             return this.#listResource('chargebacks', this.chargebacks.map(c => this.#chargebackResource(c)));
         }
 
+        // balance transactions (drives the transaction fee part of the settlements sync)
+        if (parts[0] === 'balances' && method === 'GET' && parts.length === 3 && parts[2] === 'transactions') {
+            return this.#listBalanceTransactions(uri);
+        }
+
         // settlements + nested payments/refunds (drives the settlements sync)
         if (parts[0] === 'settlements' && method === 'GET') {
             if (parts.length === 1) {
@@ -283,6 +319,9 @@ export class MollieMocker {
             mandateId: body.mandateId ?? null,
             isCancelable: true,
             details: null,
+            description: body.description ?? '',
+            profileId: body.profileId ?? null,
+            createdAt: new Date().toISOString(),
         };
         this.payments.push(payment);
         return [201, this.#paymentResource(payment)];
@@ -291,7 +330,7 @@ export class MollieMocker {
     #getPayment(id: string): [number, unknown] {
         const payment = this.payments.find(p => p.id === id);
         if (!payment) {
-            return [404, { detail: 'Payment not found' }];
+            return [404, this.#errorBody(404, 'Not Found', 'No payment exists with token ' + id)];
         }
         return [200, this.#paymentResource(payment)];
     }
@@ -299,7 +338,7 @@ export class MollieMocker {
     #cancelPayment(id: string): [number, unknown] {
         const payment = this.payments.find(p => p.id === id);
         if (!payment) {
-            return [404, { detail: 'Payment not found' }];
+            return [404, this.#errorBody(404, 'Not Found', 'No payment exists with token ' + id)];
         }
         payment.status = 'canceled';
         return [200, this.#paymentResource(payment)];
@@ -318,9 +357,14 @@ export class MollieMocker {
             mandateId: payment.mandateId ?? undefined,
             details: payment.details ?? undefined,
             metadata: payment.internalPaymentId ? { paymentId: payment.internalPaymentId } : undefined,
+            description: payment.description ?? '',
+            profileId: payment.profileId ?? 'pfl_test',
+            createdAt: payment.createdAt ?? new Date().toISOString(),
             _links: {
                 self: { href: 'https://api.mollie.com/v2/payments/' + payment.id, type: 'application/hal+json' },
                 checkout: { href: MOLLIE_CHECKOUT_URL, type: 'text/html' },
+                dashboard: this.#dashboardLink,
+                documentation: this.#documentationLink,
             },
         };
     }
@@ -347,9 +391,15 @@ export class MollieMocker {
             id,
             mode: 'test',
             name: body.name ?? 'Test',
-            email: body.email ?? undefined,
-            metadata: body.metadata ?? undefined,
-            _links: { self: { href: 'https://api.mollie.com/v2/customers/' + id, type: 'application/hal+json' } },
+            email: body.email ?? null,
+            locale: null,
+            metadata: body.metadata ?? null,
+            createdAt: new Date().toISOString(),
+            _links: {
+                self: { href: 'https://api.mollie.com/v2/customers/' + id, type: 'application/hal+json' },
+                dashboard: this.#dashboardLink,
+                documentation: this.#documentationLink,
+            },
         };
     }
 
@@ -395,8 +445,14 @@ export class MollieMocker {
             method: mandate.method,
             details: mandate.details,
             customerId: mandate.customerId,
+            mandateReference: null,
+            signatureDate: mandate.createdAt.substring(0, 10),
             createdAt: mandate.createdAt,
-            _links: { self: { href: 'https://api.mollie.com/v2/customers/' + mandate.customerId + '/mandates/' + mandate.id, type: 'application/hal+json' } },
+            _links: {
+                self: { href: 'https://api.mollie.com/v2/customers/' + mandate.customerId + '/mandates/' + mandate.id, type: 'application/hal+json' },
+                customer: { href: 'https://api.mollie.com/v2/customers/' + mandate.customerId, type: 'application/hal+json' },
+                documentation: this.#documentationLink,
+            },
         };
     }
 
@@ -410,8 +466,16 @@ export class MollieMocker {
             mode: 'test',
             name: 'Stamhoofd',
             website: 'https://www.stamhoofd.be',
+            email: 'hallo@stamhoofd.be',
+            phone: '+32499999999',
+            businessCategory: 'SOCIAL_ASSOCIATIONS',
             status: 'verified',
-            _links: { self: { href: 'https://api.mollie.com/v2/profiles/' + id, type: 'application/hal+json' } },
+            createdAt: new Date().toISOString(),
+            _links: {
+                self: { href: 'https://api.mollie.com/v2/profiles/' + id, type: 'application/hal+json' },
+                dashboard: this.#dashboardLink,
+                documentation: this.#documentationLink,
+            },
         };
     }
 
@@ -422,6 +486,7 @@ export class MollieMocker {
             status: 'completed',
             canReceivePayments: true,
             canReceiveSettlements: true,
+            signedUpAt: new Date().toISOString(),
             _links: { self: { href: 'https://api.mollie.com/v2/onboarding/me', type: 'application/hal+json' } },
         };
     }
@@ -450,7 +515,11 @@ export class MollieMocker {
             amount: chargeback.amount,
             paymentId: chargeback.paymentId,
             createdAt: chargeback.createdAt,
-            _links: { self: { href: 'https://api.mollie.com/v2/payments/' + chargeback.paymentId + '/chargebacks/' + chargeback.id, type: 'application/hal+json' } },
+            _links: {
+                self: { href: 'https://api.mollie.com/v2/payments/' + chargeback.paymentId + '/chargebacks/' + chargeback.id, type: 'application/hal+json' },
+                payment: { href: 'https://api.mollie.com/v2/payments/' + chargeback.paymentId, type: 'application/hal+json' },
+                documentation: this.#documentationLink,
+            },
         };
     }
 
@@ -473,20 +542,20 @@ export class MollieMocker {
     #createRefund(paymentId: string, body: Record<string, any>): [number, unknown] {
         const payment = this.payments.find(p => p.id === paymentId);
         if (!payment) {
-            return [404, { status: 404, title: 'Not Found', detail: 'No payment exists with token ' + paymentId }];
+            return [404, this.#errorBody(404, 'Not Found', 'No payment exists with token ' + paymentId)];
         }
 
         if (payment.status !== 'paid') {
-            return [422, { status: 422, title: 'Unprocessable Entity', detail: 'The payment is not paid; you can only refund paid payments' }];
+            return [422, this.#errorBody(422, 'Unprocessable Entity', 'The payment is not paid; you can only refund paid payments')];
         }
 
         const value = parseFloat(String(body.amount?.value ?? '0'));
         if (!(value > 0)) {
-            return [422, { status: 422, title: 'Unprocessable Entity', detail: 'The amount is invalid', field: 'amount' }];
+            return [422, this.#errorBody(422, 'Unprocessable Entity', 'The amount is invalid', 'amount')];
         }
 
         if (value > this.getRemainingAmount(payment) + 0.000001) {
-            return [422, { status: 422, title: 'Unprocessable Entity', detail: 'The amount is higher than the remaining payment amount', field: 'amount' }];
+            return [422, this.#errorBody(422, 'Unprocessable Entity', 'The amount is higher than the remaining payment amount', 'amount')];
         }
 
         const refund: MollieMockRefund = {
@@ -505,7 +574,7 @@ export class MollieMocker {
     #getRefund(paymentId: string, refundId: string): [number, unknown] {
         const refund = this.refunds.find(r => r.id === refundId && r.paymentId === paymentId);
         if (!refund) {
-            return [404, { status: 404, title: 'Not Found', detail: 'No refund exists with token ' + refundId }];
+            return [404, this.#errorBody(404, 'Not Found', 'No refund exists with token ' + refundId)];
         }
         return [200, this.#refundResource(refund)];
     }
@@ -563,8 +632,12 @@ export class MollieMocker {
             description: refund.description,
             paymentId: refund.paymentId,
             createdAt: refund.createdAt,
-            metadata: refund.metadata ?? undefined,
-            _links: { self: { href: 'https://api.mollie.com/v2/payments/' + refund.paymentId + '/refunds/' + refund.id, type: 'application/hal+json' } },
+            metadata: refund.metadata ?? null,
+            _links: {
+                self: { href: 'https://api.mollie.com/v2/payments/' + refund.paymentId + '/refunds/' + refund.id, type: 'application/hal+json' },
+                payment: { href: 'https://api.mollie.com/v2/payments/' + refund.paymentId, type: 'application/hal+json' },
+                documentation: this.#documentationLink,
+            },
         };
     }
 
@@ -574,7 +647,7 @@ export class MollieMocker {
      * Register a settled (paid out) settlement that groups the given payments and refunds.
      * Used to drive the MollieSettlementSync walk.
      */
-    createSettlement(options: { payments?: MollieMockPayment[]; refunds?: MollieMockRefund[]; chargebacks?: MollieMockChargeback[]; value?: string; settledAt?: Date; invoiceId?: string | null; periods?: Record<string, Record<string, { costs: MollieMockSettlementCost[]; invoiceId?: string | null }>> } = {}): MollieMockSettlement {
+    createSettlement(options: { payments?: MollieMockPayment[]; refunds?: MollieMockRefund[]; chargebacks?: MollieMockChargeback[]; value?: string; settledAt?: Date } = {}): MollieMockSettlement {
         const settlement: MollieMockSettlement = {
             id: this.createId('stl'),
             reference: '1234567.' + (this.settlements.length + 1).toString().padStart(4, '0') + '.01',
@@ -582,8 +655,6 @@ export class MollieMocker {
             amount: { currency: 'EUR', value: options.value ?? '0.00' },
             createdAt: new Date().toISOString(),
             settledAt: (options.settledAt ?? new Date()).toISOString(),
-            invoiceId: options.invoiceId ?? null,
-            periods: options.periods ?? {},
             paymentIds: (options.payments ?? []).map(p => p.id),
             refundIds: (options.refunds ?? []).map(r => r.id),
             chargebackIds: (options.chargebacks ?? []).map(c => c.id),
@@ -617,7 +688,7 @@ export class MollieMocker {
         const from = query.get('from');
         const startIndex = from ? sorted.findIndex(s => s.id === from) : 0;
         if (startIndex === -1) {
-            return [404, { status: 404, title: 'Not Found', detail: 'No settlement exists with token ' + from }];
+            return [404, this.#errorBody(404, 'Not Found', 'No settlement exists with token ' + from)];
         }
 
         const page = sorted.slice(startIndex, startIndex + limit);
@@ -637,12 +708,76 @@ export class MollieMocker {
             amount: settlement.amount,
             createdAt: settlement.createdAt,
             settledAt: settlement.settledAt ?? null,
-            invoiceId: settlement.invoiceId,
-            periods: settlement.periods,
             _links: { self: { href: 'https://api.mollie.com/v2/settlements/' + settlement.id, type: 'application/hal+json' } },
         };
     }
 
+    // ---- Balance transactions ---------------------------------------------
+
+    /**
+     * Register the balance transaction of a payment, refund or chargeback, carrying the fee Mollie
+     * deducted for it. `fee` and `deductions` are positive euro values, stored negated like Mollie
+     * reports them. Pass only `deductions` for a transaction without the deductionDetails breakdown.
+     */
+    createBalanceTransaction(options: {
+        type: 'payment' | 'refund' | 'chargeback';
+        entryId: string;
+        fee?: string;
+        deductions?: string;
+        createdAt?: Date;
+    }): MollieMockBalanceTransaction {
+        const contextKey = options.type === 'payment' ? 'paymentId' : options.type === 'refund' ? 'refundId' : 'chargebackId';
+        const deductions = options.deductions ?? options.fee;
+
+        const transaction: MollieMockBalanceTransaction = {
+            id: this.createId('baltr'),
+            type: options.type,
+            createdAt: (options.createdAt ?? new Date()).toISOString(),
+            deductions: deductions ? { currency: 'EUR', value: '-' + deductions } : null,
+            deductionDetails: options.fee ? { fees: { currency: 'EUR', value: '-' + options.fee } } : null,
+            context: { [contextKey]: options.entryId },
+        };
+        this.balanceTransactions.push(transaction);
+        return transaction;
+    }
+
+    /**
+     * Mollie lists balance transactions newest-first, paginated like the settlements list.
+     */
+    #listBalanceTransactions(uri: string): [number, unknown] {
+        const query = new URLSearchParams(uri.split('?')[1] ?? '');
+
+        const sorted = this.balanceTransactions.slice().sort((a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime());
+
+        const requestedLimit = parseInt(query.get('limit') ?? '250');
+        const limit = Math.min(requestedLimit, this.balanceTransactionsPageSize ?? requestedLimit);
+
+        const from = query.get('from');
+        const startIndex = from ? sorted.findIndex(t => t.id === from) : 0;
+        if (startIndex === -1) {
+            return [404, this.#errorBody(404, 'Not Found', 'No balance transaction exists with token ' + from)];
+        }
+
+        const page = sorted.slice(startIndex, startIndex + limit);
+        const nextItem = sorted[startIndex + limit];
+
+        return this.#listResource('balance_transactions', page.map(t => this.#balanceTransactionResource(t)), {
+            next: nextItem ? 'https://api.mollie.com/v2/balances/primary/transactions?limit=' + requestedLimit + '&from=' + nextItem.id : null,
+        });
+    }
+
+    #balanceTransactionResource(transaction: MollieMockBalanceTransaction) {
+        return {
+            resource: 'balance-transaction',
+            id: transaction.id,
+            type: transaction.type,
+            createdAt: transaction.createdAt,
+            deductions: transaction.deductions,
+            deductionDetails: transaction.deductionDetails,
+            context: transaction.context,
+        };
+    }
+
     // ---- List helper ------------------------------------------------------
 
     #listResource(binderName: string, items: unknown[], options: { next?: string | null } = {}): [number, unknown] {

package/tests/init/initAdmin.ts

@@ -3,6 +3,7 @@ import { Token, UserFactory } from '@stamhoofd/models';
 import type { AccessRight } from '@stamhoofd/structures';
 import { PermissionLevel, PermissionRole, Permissions } from '@stamhoofd/structures';
 import { initPermissionRole } from './initPermissionRole.js';
+import { SessionService } from '../../src/services/SessionService.js';
 
 /**
  * You cannot assign access rights directy to a user, but it can be done using roles. So when setting accessRights, a role wil be created and assigned to the user.
@@ -25,6 +26,6 @@ export async function initAdmin({ organization, permissions, accessRights }: { o
         permissions,
     }).create();
 
-    const adminToken = await Token.createToken(admin);
+    const adminToken = await SessionService.createSession(admin);
     return { admin, adminToken };
 }

package/tests/init/initPlatformAdmin.ts

@@ -1,5 +1,6 @@
 import { Token, UserFactory } from '@stamhoofd/models';
 import { PermissionLevel, Permissions } from '@stamhoofd/structures';
+import { SessionService } from '../../src/services/SessionService.js';
 
 export async function initPlatformAdmin() {
     const admin = await new UserFactory({
@@ -8,6 +9,6 @@ export async function initPlatformAdmin() {
         }),
     }).create();
 
-    const adminToken = await Token.createToken(admin);
+    const adminToken = await SessionService.createSession(admin);
     return { admin, adminToken };
 }