save transaction parameters in BPD, consider supported CAMT formats when sending HKCAZ with allowed formats, some refactoring

Author: robocode13

src/bankTransaction.ts

@@ -1,5 +1,25 @@
+import type { HICAZSParameter } from './segments/HICAZS.js';
+import type { HIKAZSParameter } from './segments/HIKAZS.js';
+import type { HISPASParameter } from './segments/HISPAS.js';
+
 export type BankTransaction = {
 	transId: string;
 	tanRequired: boolean;
 	versions: number[];
+	params?: unknown;
+};
+
+export type SepaBankTransaction = BankTransaction & {
+	transId: 'HKSPA';
+	params: HISPASParameter;
+};
+
+export type StatementTransactionMT940 = BankTransaction & {
+	transId: 'HKKAZ';
+	params: HIKAZSParameter;
+};
+
+export type StatementTransactionCAMT = BankTransaction & {
+	transId: 'HKCAZ';
+	params: HICAZSParameter;
 };

src/config.ts

@@ -204,6 +204,18 @@ export class FinTSConfig {
 		return this.availableTanMethods.find((t) => t.id === this.tanMethodId);
 	}
 
+	/**
+	 * Gets the transaction parameters for a specific transaction ID
+	 * @param transId The transaction ID
+	 * @returns The transaction parameters or undefined if not available
+	 */
+	getTransactionParameters<T>(transId: string): T | undefined {
+		const transaction = this.bankingInformation.bpd?.allowedTransactions.find(
+			(t) => t.transId === transId,
+		);
+		return transaction?.params as T | undefined;
+	}
+
 	/**
 	 * Checks if a transaction is supported by the bank
 	 * @param transId The transaction ID

src/dataGroups/SepaAccountParameters.ts

@@ -6,6 +6,7 @@ import { Language, SyncMode, TanMediaRequirement } from '../codes.js';
 import type { FinTSConfig } from '../config.js';
 import type { Message } from '../message.js';
 import type { Segment } from '../segment.js';
+import type { BusinessTransactionParameterSegment } from '../segments/businessTransactionParameter.js';
 import { HIBPA, type HIBPASegment } from '../segments/HIBPA.js';
 import { HIKIM, type HIKIMSegment } from '../segments/HIKIM.js';
 import { HIKOM, type HIKOMSegment } from '../segments/HIKOM.js';
@@ -140,11 +141,19 @@ export class InitDialogInteraction extends CustomerInteraction {
 				if (transaction.transId.startsWith('HK') || transaction.transId.startsWith('DK')) {
 					const paramSegId = `HI${transaction.transId.slice(2)}S`;
 					const paramSegments = [
-						...response.findAllSegments(paramSegId),
-						...response.findAllUnknownSegments(paramSegId),
+						...response.findAllSegments<BusinessTransactionParameterSegment<unknown>>(paramSegId),
 					];
 
+					const unknownParamSegments = [...response.findAllUnknownSegments(paramSegId)];
+
 					paramSegments.forEach((paramSegment) => {
+						if (paramSegment) {
+							transaction.versions.push(paramSegment.header.version);
+							transaction.params = paramSegment.params;
+						}
+					});
+
+					unknownParamSegments.forEach((paramSegment) => {
 						if (paramSegment) {
 							transaction.versions.push(paramSegment.header.version);
 						}

src/interactions/initDialogInteraction.ts

@@ -53,7 +53,7 @@ export class SepaAccountInteraction extends CustomerOrderInteraction {
 
 			clientResponse.sepaAccounts.forEach((sepaAccount) => {
 				const bankAccount = this.dialog?.config.getBankAccount(sepaAccount.accountNumber);
-				if (bankAccount) {
+				if (bankAccount && !bankAccount.isSepaAccount) {
 					bankAccount.isSepaAccount = sepaAccount.isSepaAccount;
 					bankAccount.iban = sepaAccount.iban;
 					bankAccount.bic = sepaAccount.bic;

src/interactions/sepaAccountInteraction.ts

@@ -3,13 +3,12 @@ import type { FinTSConfig } from '../config.js';
 import type { Message } from '../message.js';
 import type { Segment } from '../segment.js';
 import { HICAZ, type HICAZSegment } from '../segments/HICAZ.js';
+import type { HICAZSParameter } from '../segments/HICAZS.js';
 import { HKCAZ, type HKCAZSegment } from '../segments/HKCAZ.js';
 import type { Statement } from '../statement.js';
 import { CustomerOrderInteraction, type StatementResponse } from './customerInteraction.js';
 
 export class StatementInteractionCAMT extends CustomerOrderInteraction {
-	private acceptedCamtFormats: string[] = ['urn:iso:std:iso:20022:tech:xsd:camt.052.001.08'];
-
 	constructor(
 		public accountNumber: string,
 		public from?: Date,
@@ -25,10 +24,20 @@ export class StatementInteractionCAMT extends CustomerOrderInteraction {
 			throw Error(`There is no supported version for business transaction '${HKCAZ.Id}'`);
 		}
 
+		let acceptedCamtFormats = ['urn:iso:std:iso:20022:tech:xsd:camt.052.001.08'];
+
+		const params = init.getTransactionParameters<HICAZSParameter>(HKCAZ.Id);
+
+		if (params && params.supportedCamtFormats.length > 0) {
+			acceptedCamtFormats = params.supportedCamtFormats.filter((format) =>
+				format.startsWith('urn:iso:std:iso:20022:tech:xsd:camt.052.001.'),
+			);
+		}
+
 		const hkcaz: HKCAZSegment = {
 			header: { segId: HKCAZ.Id, segNr: 0, version: version },
 			account: bankAccount,
-			acceptedCamtFormats: this.acceptedCamtFormats,
+			acceptedCamtFormats: acceptedCamtFormats,
 			allAccounts: false,
 			from: this.from,
 			to: this.to,

src/interactions/statementInteractionCAMT.ts

@@ -1,15 +1,21 @@
-import {
-	type SepaAccountParameters,
-	SepaAccountParametersGroup,
-} from '../dataGroups/SepaAccountParameters.js';
+import { AlphaNumeric } from '../dataElements/AlphaNumeric.js';
+import { Numeric } from '../dataElements/Numeric.js';
+import { YesNo } from '../dataElements/YesNo.js';
 import {
 	BusinessTransactionParameter,
 	type BusinessTransactionParameterSegment,
 } from './businessTransactionParameter.js';
 
-export type HISPASSegment = BusinessTransactionParameterSegment<SepaAccountParameters>;
+export type HISPASSegment = BusinessTransactionParameterSegment<HISPASParameter>;
 
-export type HISPASParameter = SepaAccountParameters;
+export type HISPASParameter = {
+	individualAccountRetrievalAllowed: boolean;
+	nationalAccountAllowed: boolean;
+	structuredPurposeAllowed: boolean;
+	maxEntriesAllowed?: boolean; // version 2+
+	reservedPurposePositions?: number; // version 3+
+	supportedSepaFormats?: string[]; // optional, up to 99 entries
+};
 
 /**
  * Parameters for HKSPA business transaction - SEPA account connection request
@@ -22,7 +28,14 @@ export class HISPAS extends BusinessTransactionParameter {
 	constructor() {
 		super(
 			HISPAS.Id,
-			[new SepaAccountParametersGroup('sepaAccountParams', 1, 1)],
+			[
+				new YesNo('individualAccountRetrievalAllowed', 1, 1),
+				new YesNo('nationalAccountAllowed', 1, 1),
+				new YesNo('structuredPurposeAllowed', 1, 1),
+				new YesNo('maxEntriesAllowed', 1, 1, 2), // version 2+
+				new Numeric('reservedPurposePositions', 1, 1, 2, 3), // version 3+
+				new AlphaNumeric('supportedSepaFormats', 0, 99, 256), // optional, up to 99 entries
+			],
 			1, // secClassMinVersion
 		);
 	}