@coderoftime/fints 0.1.0 → 0.3.0

package/dist/v3/parameter-store.js

@@ -0,0 +1,197 @@
+// Internal to the package, and named after the FinTS specification. Documentation is where the meaning is not evident.
+import { FormatError } from '../util/errors.js';
+import { readOptionalBoolean, readOptionalObject, readOptionalString } from '../util/json.js';
+import { trimBlanks } from '../util/text.js';
+import { Bpd3, decodeSegments, Upd3 } from './parameters.js';
+import { Verbatim } from './syntax.js';
+/**
+ * The parameter data and IDs the bank sends the user `config` names, which the messages and business transactions
+ * take, and which the saved state keeps: the bank and user parameter data, the customer system ID, and the names of
+ * the TAN media as the bank sent them.
+ */
+export class ParameterStore {
+    config;
+    systemIdValue;
+    bpd;
+    /**
+     * Whether the bank parameter data came from the anonymous dialog. They serve until those of a dialog signed with the
+     * PIN come: the bank may send a user other ones (PIN/TAN B.4.3.1), and the anonymous dialog may have had to do
+     * without the announcement of strong customer authentication. So signed dialogs report version 0 for them, which has
+     * the bank send its parameter data anew.
+     */
+    bpdAnonymous = false;
+    /** The limits a refresh took from the anonymous dialog's parameter data (`keepRefreshedLimits`). */
+    refreshedLimits;
+    upd;
+    /**
+     * The names of the TAN media in the bank's last list whose text would not go back as the bank sent them, by their
+     * text, as `parseTanMedia` notes them (`readTanMediumNames` for a state of 0.2.0). Saved with the state, as the
+     * medium in use is.
+     */
+    tanMediumNames = new Map();
+    constructor(config) {
+        this.config = config;
+    }
+    /** The bank parameter data received so far, if any. */
+    get bankParameters() {
+        return this.bpd;
+    }
+    /** The user parameter data received so far, if any. */
+    get userParameters() {
+        return this.upd;
+    }
+    /**
+     * The customer system ID the bank assigned in the synchronization, as `Segment.verbatim` reads it; `undefined`
+     * before. No dialog signed with the PIN starts without it.
+     */
+    get systemId() {
+        return this.systemIdValue;
+    }
+    /**
+     * The limits on the messages the client sends: those of the bank parameter data, unless a refresh took others
+     * (`keepRefreshedLimits`).
+     */
+    get limits() {
+        const bpd = this.bpd;
+        return this.refreshedLimits ?? { pinLength: bpd?.pinTan.pinLength, maxMessageSize: bpd?.bankInfo.maxMessageSize };
+    }
+    /**
+     * The version of the bank parameter data a dialog reports: 0 where there are none, only the anonymous dialog's, or
+     * where limits a refresh took stand in for theirs (`keepRefreshedLimits`).
+     */
+    get reportedBpdVersion() {
+        return this.bpd === undefined || this.bpdAnonymous || this.refreshedLimits !== undefined ? 0 : this.bpd.version;
+    }
+    /**
+     * The version of the user parameter data a signed dialog reports: 0 where there are none, or where they name another
+     * user ID than the one logging in, so that the bank sends the user's anew. They may be another user's, as where a
+     * relay mixed up the answers to the synchronizations of two users and the bank takes the other user's customer system
+     * ID. A bank that names the user by another ID than the login's, such as for an alias, only sends its user parameter
+     * data at every login.
+     */
+    get reportedUpdVersion() {
+        const upd = this.upd;
+        return upd !== undefined && upd.userId === this.config.userId ? upd.version : 0;
+    }
+    /**
+     * Drops the customer system ID the bank no longer accepts, so that a synchronization is required again, and with it
+     * the user parameter data, which the next login delivers anew: what came along with an ID the bank does not know may
+     * not be the user's either (`reportedUpdVersion`). Returns whether there was an ID.
+     */
+    forgetSystemId() {
+        const had = this.systemIdValue !== undefined;
+        this.systemIdValue = undefined;
+        this.upd = undefined;
+        return had;
+    }
+    /**
+     * Keeps the parameter data and IDs in `response`, an answer to the opening of a signed dialog: the login, which may be
+     * a synchronization, or its approval. The bank sends them there (Formals C.3.1); taken from the answer to an order,
+     * the parameter data a bank repeats there in part would replace the complete ones.
+     */
+    keep(response) {
+        this.keepBankParameters(response, false);
+        this.upd = Upd3.fromSegments(response.segments, this.config.bankCode, this.config.countryCode) ?? this.upd;
+        this.systemIdValue = response.find('HISYN')?.verbatim(1) ?? this.systemIdValue;
+    }
+    /**
+     * Keeps the bank parameter data in `response`, the answer of an anonymous dialog, where there are none from a dialog
+     * signed with the PIN: until those come, the dialogs signed with the PIN have the bank send its parameter data anew,
+     * since it may send a user other ones (PIN/TAN B.4.3.1). Keeps nothing that belongs to a user.
+     */
+    keepAnonymous(response) {
+        if (this.bpd === undefined || this.bpdAnonymous)
+            this.keepBankParameters(response, true);
+    }
+    /**
+     * Keeps the limits of the bank parameter data in `response`, the answer of an anonymous dialog the client asked for
+     * after the limits kept ruled out a login: those may be outdated, as saved ones are. Parameter data of the version
+     * kept tell nothing new, and the bank may send a user other ones than the anonymous dialog (PIN/TAN B.4.3.1), so of
+     * those of another version it keeps the limits only, and the PIN lengths only where they state them (HIPINS). They
+     * stand in for those kept until a dialog signed with the PIN brings parameter data.
+     */
+    keepRefreshedLimits(response) {
+        const fresh = Bpd3.fromSegments(response.segments, this.config.bankCode);
+        if (fresh === undefined || fresh.version === this.bpd?.version)
+            return;
+        this.refreshedLimits = {
+            pinLength: fresh.pinTan.pinLength ?? this.limits.pinLength,
+            maxMessageSize: fresh.bankInfo.maxMessageSize,
+        };
+    }
+    keepBankParameters(response, anonymous) {
+        const bpd = Bpd3.fromSegments(response.segments, this.config.bankCode);
+        if (bpd === undefined)
+            return;
+        this.bpd = bpd;
+        this.bpdAnonymous = anonymous;
+        this.refreshedLimits = undefined;
+    }
+    /** Keeps `names`, the names of the bank's latest list of TAN media as `parseTanMedia` notes them. */
+    keepTanMediumNames(names) {
+        this.tanMediumNames = names;
+    }
+    /**
+     * The TAN medium `name` to send: as the bank sent it, where its last list of TAN media noted that (`parseTanMedia`);
+     * otherwise as text, which goes out without the blanks at either end a name the app passes may have.
+     */
+    tanMediumToSend(name) {
+        const asSent = this.tanMediumNames.get(name);
+        return asSent === undefined ? name : new Verbatim(asSent);
+    }
+    /** The parameter data and IDs as JSON data, for the client's saved state. */
+    saveState() {
+        return {
+            systemId: this.systemIdValue ?? null,
+            bpd: this.bpd?.encoded ?? null,
+            bpdAnonymous: this.bpdAnonymous,
+            upd: this.upd?.encoded ?? null,
+            tanMediumNames: Object.fromEntries(this.tanMediumNames),
+            [blanksNotedKey]: true,
+        };
+    }
+    /**
+     * Restores what `saveState` saved, with `tanMedium`, the medium in use the state holds; throws if `saved` is damaged,
+     * leaving the store unchanged.
+     */
+    restoreState(saved, tanMedium) {
+        const bpd = readOptionalString(saved, 'bpd');
+        const upd = readOptionalString(saved, 'upd');
+        const restoredSystemId = readOptionalString(saved, 'systemId');
+        // A state of fints-ts 0.1 or the Dart package 0.2.0 does not tell, so its parameter data are fetched anew.
+        const restoredBpdAnonymous = readOptionalBoolean(saved, 'bpdAnonymous') ?? true;
+        const restoredBpd = bpd === undefined ? undefined : Bpd3.fromSegments(decodeSegments(bpd), this.config.bankCode);
+        const restoredUpd = upd === undefined
+            ? undefined
+            : Upd3.fromSegments(decodeSegments(upd), this.config.bankCode, this.config.countryCode);
+        const restoredNames = readTanMediumNames(saved, tanMedium);
+        this.systemIdValue = restoredSystemId;
+        this.bpd = restoredBpd;
+        this.bpdAnonymous = restoredBpdAnonymous;
+        this.refreshedLimits = undefined;
+        this.upd = restoredUpd;
+        this.tanMediumNames = restoredNames;
+    }
+}
+/** The key of the saved state that tells the TAN medium names apart from those version 0.2.0 saved. */
+const blanksNotedKey = 'tanMediumBlanksNoted';
+/**
+ * The TAN medium names `saveState` saved; none in a state of fints-ts 0.1 or the Dart package 0.2.0.
+ *
+ * Version 0.2.0 noted no name with blanks at either end, and sent every name as it is, so `tanMedium` keeps going out
+ * with its blanks from such a state: the bank may have listed it so.
+ */
+function readTanMediumNames(saved, tanMedium) {
+    const listed = readOptionalObject(saved, 'tanMediumNames');
+    const names = new Map(Object.entries(listed ?? {}).map(([name, asSent]) => {
+        if (typeof asSent !== 'string')
+            throw new FormatError('Saved state: a TAN medium name is not a string');
+        return [name, asSent];
+    }));
+    const savedBy020 = listed !== undefined && readOptionalBoolean(saved, blanksNotedKey) !== true;
+    if (savedBy020 && tanMedium !== undefined && trimBlanks(tanMedium) !== tanMedium && !names.has(tanMedium)) {
+        names.set(tanMedium, tanMedium);
+    }
+    return names;
+}
+//# sourceMappingURL=parameter-store.js.map

package/dist/v3/parameter-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter-store.js","sourceRoot":"","sources":["../../src/v3/parameter-store.ts"],"names":[],"mappings":"AAAA,uHAAuH;AAGvH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,kBAAkB,EAAmB,MAAM,iBAAiB,CAAC;AAC/G,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAWvC;;;;GAIG;AACH,MAAM,OAAO,cAAc;IAuBJ;IAtBb,aAAa,CAAqB;IAClC,GAAG,CAAmB;IAE9B;;;;;OAKG;IACK,YAAY,GAAG,KAAK,CAAC;IAE7B,oGAAoG;IAC5F,eAAe,CAA4B;IAC3C,GAAG,CAAmB;IAE9B;;;;OAIG;IACK,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEnD,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C,uDAAuD;IACvD,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,uDAAuD;IACvD,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,OAAO,IAAI,CAAC,eAAe,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,EAAE,QAAQ,CAAC,cAAc,EAAE,CAAC;IACpH,CAAC;IAED;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;IAClH,CAAC;IAED;;;;;;OAMG;IACH,IAAI,kBAAkB;QACpB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,QAA0B;QAC7B,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC;QAC3G,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,QAA0B;QACtC,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY;YAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,QAA0B;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,GAAG,EAAE,OAAO;YAAE,OAAO;QACvE,IAAI,CAAC,eAAe,GAAG;YACrB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS;YAC1D,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,cAAc;SAC9C,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,QAA0B,EAAE,SAAkB;QACvE,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvE,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO;QAC9B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;IACnC,CAAC;IAED,qGAAqG;IACrG,kBAAkB,CAAC,KAA0B;QAC3C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,IAAY;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,6EAA6E;IAC7E,SAAS;QACP,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,IAAI;YAC9B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,IAAI;YAC9B,cAAc,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC;YACvD,CAAC,cAAc,CAAC,EAAE,IAAI;SACvB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,KAAiB,EAAE,SAAkB;QAChD,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC/D,2GAA2G;QAC3G,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,KAAK,EAAE,cAAc,CAAC,IAAI,IAAI,CAAC;QAChF,MAAM,WAAW,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjH,MAAM,WAAW,GACf,GAAG,KAAK,SAAS;YACf,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5F,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC;QACzC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;CACF;AAED,uGAAuG;AACvG,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAE9C;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,KAAiB,EAAE,SAA6B;IAC1E,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QAClD,IAAI,OAAO,MAAM,KAAK,QAAQ;YAAE,MAAM,IAAI,WAAW,CAAC,gDAAgD,CAAC,CAAC;QACxG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CACH,CAAC;IACF,MAAM,UAAU,GAAG,MAAM,KAAK,SAAS,IAAI,mBAAmB,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,CAAC;IAC/F,IAAI,UAAU,IAAI,SAAS,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1G,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/v3/parameters.d.ts

@@ -1,20 +1,27 @@
 import { Account } from '../core/account.js';
 import type { Balance } from '../core/balance.js';
 import { BankInfo } from '../core/bank-info.js';
-import { type BankParameters, type UserParameters } from '../session/parameter-data.js';
 import { TanMethod } from '../tan/tan-models.js';
 import { type Segment } from './syntax.js';
+/** `bpd`, or `FinTsProtocolError` if the bank has not sent its parameter data yet. */
+export declare function requireBankParameters(bpd: Bpd3 | undefined): Bpd3;
 /** FinTS 3.0 bank parameter data (BPD): HIBPA and the parameter segments (`HI…S`), parsed once. */
-export declare class Bpd3 implements BankParameters {
-    readonly segments: readonly Segment[];
+export declare class Bpd3 {
     readonly bankInfo: BankInfo;
     /** The two-step TAN methods of HITANS versions 6 and 7, by security function. */
     private readonly offeredMethods;
+    /** Two-step TAN methods the bank offers and the client can run. */
     readonly tanMethods: readonly TanMethod[];
+    /** Security functions of the two-step methods the bank offers in a form the client cannot run. */
     readonly unsupportedTanMethods: readonly string[];
     readonly pinTan: PinTanParameters;
-    /** camt formats the bank offers for HKCAZ. */
+    /** The camt.052 formats the bank offers for HKCAZ, the one camt message the client reads. */
     readonly camtFormats: readonly string[];
+    /**
+     * Whether an international account (KTI) may name the national account as well: HISPAS does not rule it out
+     * ("Nationale Kontoverbindung erlaubt").
+     */
+    readonly nationalAccountAllowed: boolean;
     /** Versions of each parameter segment, by segment type. */
     private readonly versions;
     /**
@@ -22,17 +29,16 @@ export declare class Bpd3 implements BankParameters {
      * these may be sent once the parameter data are known; `0`, the default, only before (Formals C.3.1.3).
      */
     readonly dialogLanguage: number;
+    /** The segments as the saved state keeps them. */
+    readonly encoded: string;
     private constructor();
+    /** The version of the parameter data, which the client reports back so that the bank sends newer ones only. */
     get version(): number;
-    get pinLength(): {
-        min: number | undefined;
-        max: number | undefined;
-    };
-    allowsWithPinTan(transaction: string): boolean;
     /** The BPD in `all`, or `undefined` if they contain no HIBPA segment. */
     static fromSegments(all: readonly Segment[], fallbackBankCode: string): Bpd3 | undefined;
     /** The parameter segment type of a business transaction: `HKSAL` → `HISALS`. */
     static parameterName(transaction: string): string;
+    /** The highest version of `transaction` that the bank offers and the client `implemented`. */
     bestVersion(transaction: string, implemented: ReadonlySet<number>): number | undefined;
     /** The version of the HKTAN segments that go with `method`; `undefined` for a method the bank does not offer. */
     tanVersion(method: TanMethod): number | undefined;
@@ -43,11 +49,11 @@ export declare class Bpd3 implements BankParameters {
  */
 export declare class PinTanParameters {
     private readonly tanRequired;
-    /** The shortest and longest PIN the bank takes. */
+    /** The shortest and longest PIN the bank takes; `undefined` where the bank parameter data have no HIPINS. */
     readonly pinLength: {
         min: number | undefined;
         max: number | undefined;
-    };
+    } | undefined;
     private constructor();
     /** Reads the HIPINS segment of the highest version. */
     static parse(segments: readonly Segment[]): PinTanParameters;
@@ -57,23 +63,44 @@ export declare class PinTanParameters {
     allowsWithPinTan(segmentType: string): boolean;
 }
 /** FinTS 3.0 user parameter data (UPD): HIUPA and the accounts (HIUPD), parsed once. */
-export declare class Upd3 implements UserParameters {
-    readonly segments: readonly Segment[];
+export declare class Upd3 {
+    /** The user the bank sent them for; `undefined` where it names none. */
+    readonly userId: string | undefined;
+    /** The version of the parameter data, which the client reports back so that the bank sends newer ones only. */
     readonly version: number;
+    /**
+     * Whether the lists of permitted transactions are complete: the bank permits nothing they leave out ("UPD-Verwendung"
+     * 0).
+     */
     readonly listsAllTransactions: boolean;
+    /** The transactions any entry lists as permitted, with or without an account. */
     readonly listedTransactions: ReadonlySet<string>;
     /** The accounts with the extension each carries, where it does. */
     private readonly entries;
+    /** The accounts the user may access. */
     readonly accounts: readonly Account[];
+    /** The segments as the saved state keeps them. */
+    readonly encoded: string;
     /** `listsAll` tells whether HIUPA declares the lists of permitted transactions complete ("UPD-Verwendung" 0). */
     private constructor();
-    /** FinTS 3.0 UPD do not list the allowed TAN methods; the bank reports them with return code 3920. */
-    get allowedTanMethods(): readonly string[];
+    /**
+     * The balance of `account` the user parameter data carry, where it holds all a balance query would deliver, so that
+     * the client asks for none (Formals E.3.1, F.3.2); `undefined` otherwise.
+     */
     completeBalance(account: Account): Balance | undefined;
     /** The UPD in `all`, or `undefined` if they contain no HIUPA segment. */
     static fromSegments(all: readonly Segment[], defaultBankCode: string, defaultCountry: string): Upd3 | undefined;
 }
-/** Serializes parameter segments for the saved state. */
-export declare function encodeSegments(segments: readonly Segment[]): string;
+/**
+ * The version of `transaction` to send, for `account` where it concerns one: the highest the bank offers and the client
+ * `implemented`. `undefined` where there is none, or the parameter data do not permit the transaction
+ * (`permitsTransaction`).
+ */
+export declare function offeredVersion(bpd: Bpd3 | undefined, upd: Upd3 | undefined, transaction: string, implemented: ReadonlySet<number>, options: {
+    account?: Account;
+    requiresEntry?: boolean;
+}): number | undefined;
+/** Whether the bank lists `transaction`, such as `HKCAZ`, as permitted for `account`. */
+export declare function lists(account: Account, transaction: string): boolean;
 export declare function decodeSegments(data: string): Segment[];
 //# sourceMappingURL=parameters.d.ts.map

package/dist/v3/parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/v3/parameters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAwB,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9G,OAAO,EAAE,SAAS,EAA0B,MAAM,sBAAsB,CAAC;AAIzE,OAAO,EAAiB,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAsC1D,mGAAmG;AACnG,qBAAa,IAAK,YAAW,cAAc;IAuBvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE;IAtBvC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,iFAAiF;IACjF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqC;IAEpE,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC,8CAA8C;IAC9C,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAExC,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IAEpE;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,OAAO;IA8BP,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,SAAS,IAAI;QAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAEpE;IAED,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAI9C,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,gBAAgB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMxF,gFAAgF;IAChF,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIjD,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,SAAS;IAItF,iHAAiH;IACjH,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAGlD;AAsHD;;;GAGG;AACH,qBAAa,gBAAgB;IAEzB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;IAH1E,OAAO;IAMP,uDAAuD;IACvD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,GAAG,gBAAgB;IAgB5D,mGAAmG;IACnG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAIzC,uHAAuH;IACvH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;CAG/C;AAcD,wFAAwF;AACxF,qBAAa,IAAK,YAAW,cAAc;IAWvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE;IAVvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAEjD,mEAAmE;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAEtC,iHAAiH;IACjH,OAAO;IAiBP,sGAAsG;IACtG,IAAI,iBAAiB,IAAI,SAAS,MAAM,EAAE,CAEzC;IAED,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAItD,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;CAMhH;AA+FD,yDAAyD;AACzD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,CAInE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,CAEtD"}
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/v3/parameters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAE,SAAS,EAA0B,MAAM,sBAAsB,CAAC;AAIzE,OAAO,EAAiB,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AA4C1D,sFAAsF;AACtF,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,CAGjE;AAED,mGAAmG;AACnG,qBAAa,IAAI;IACf,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,iFAAiF;IACjF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqC;IAEpE,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAE1C,kGAAkG;IAClG,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC,6FAA6F;IAC7F,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IAEzC,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IAEpE;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,OAAO;IA4BP,+GAA+G;IAC/G,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,gBAAgB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMxF,gFAAgF;IAChF,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIjD,8FAA8F;IAC9F,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,SAAS;IAQtF,iHAAiH;IACjH,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAGlD;AAgID;;;GAGG;AACH,qBAAa,gBAAgB;IAEzB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,6GAA6G;IAC7G,QAAQ,CAAC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS;IAHtF,OAAO;IAMP,uDAAuD;IACvD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,GAAG,gBAAgB;IAa5D,mGAAmG;IACnG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAIzC,uHAAuH;IACvH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;CAG/C;AAeD,wFAAwF;AACxF,qBAAa,IAAI;IACf,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,+GAA+G;IAC/G,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAEvC,iFAAiF;IACjF,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAEjD,mEAAmE;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAEtC,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,iHAAiH;IACjH,OAAO;IAmBP;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAItD,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;CAMhH;AAkGD;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,IAAI,GAAG,SAAS,EACrB,GAAG,EAAE,IAAI,GAAG,SAAS,EACrB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,aAAa,CAAC,EAAE,OAAO,CAAA;CAAE,GACtD,MAAM,GAAG,SAAS,CAEpB;AA4BD,yFAAyF;AACzF,wBAAgB,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAEpE;AAeD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,CAEtD"}