@coderoftime/fints 0.1.0 → 0.3.0

package/dist/core/config.js

@@ -1,11 +1,25 @@
+import { optionalBoolean, optionalString, requireString } from '../util/arguments.js';
 import { invalidArgument } from '../util/errors.js';
-/** Numeric country code of Germany (ISO 3166), where FinTS banks are. */
+import { inspectCustom } from '../util/inspect.js';
+import { isLatin1, trimBlanks } from '../util/text.js';
+/**
+ * The country code FinTS gives Germany, where FinTS banks are: the ISO 3166 code of the Federal Republic before 1990,
+ * not today's `276`.
+ */
 export const defaultCountryCode = '280';
-/** Connection and login data for one bank user. */
+/**
+ * Longest bank code (Kreditinstitutscode), user or customer ID (data type `id`), product ID (Produktbezeichnung) and
+ * product version FinTS 3.0 takes.
+ */
+const maxBankCodeLength = 30;
+const maxIdLength = 30;
+const maxProductIdLength = 25;
+const maxProductVersionLength = 5;
+/** Connection and login data for one bank user; frozen, so that the client sends what the constructor has checked. */
 export class FinTsConfig {
-    /** Numeric country code of Germany (ISO 3166), where FinTS banks are. */
+    /** The country code FinTS gives Germany, where FinTS banks are: `280`, not today's ISO 3166 code `276`. */
     static defaultCountryCode = defaultCountryCode;
-    url;
+    href;
     bankCode;
     userId;
     explicitCustomerId;
@@ -14,8 +28,17 @@ export class FinTsConfig {
     countryCode;
     allowInsecureUrl;
     /**
-     * Throws `TypeError` if `url` is not a valid URL, has no host or is not https, unless `allowInsecureUrl` is set and
-     * `url` is a loopback address, and if a login detail or the product is empty: the bank would refuse the login.
+     * Throws `TypeError` if `url` is not a valid URL, has no host, holds a user name or password, or is not https, unless
+     * `allowInsecureUrl` is set and `url` is a loopback address. Throws as well where the bank would refuse the login: for
+     * a login or product detail that is empty, has characters FinTS 3.0 cannot send (it uses ISO 8859-1, so `€` and most
+     * non-Latin letters are not possible) or is longer than its field (30 characters for the bank code, the user ID and
+     * the customer ID, 25 for the product ID, 5 for its version), for a country code of other than three digits, and for
+     * a German bank code of other than eight. Throws as well for a detail of another type than `FinTsConfigInit` names,
+     * such as a number as `bankCode` or the string `'false'` as `allowInsecureUrl`; `null` counts as a detail not given.
+     * The message leaves out the value.
+     *
+     * Drops leading and trailing blanks of the login details and the product, as FinTS sends them without (Formals
+     * B.4.1): `'alice '` is the user `alice`, also for a saved state.
      */
     constructor(init) {
         // `URL` would read `https:bank` and `https:///bank` as the host `bank`; such a URL is a mistake, not a host.
@@ -29,31 +52,59 @@ export class FinTsConfig {
         catch {
             throw invalidArgument('Not a valid URL', 'url');
         }
-        this.url = url;
-        this.bankCode = init.bankCode;
-        this.userId = init.userId;
-        this.explicitCustomerId = init.customerId;
-        this.productId = init.productId;
-        this.productVersion = init.productVersion ?? '1.0';
-        this.countryCode = init.countryCode ?? defaultCountryCode;
-        this.allowInsecureUrl = init.allowInsecureUrl ?? false;
+        this.href = url.href;
+        this.allowInsecureUrl = optionalBoolean(init.allowInsecureUrl, 'allowInsecureUrl') ?? false;
         requireSecureUrl(url, this.allowInsecureUrl);
-        requireNotBlank(this.bankCode, 'bankCode');
-        requireNotBlank(this.userId, 'userId');
-        if (this.explicitCustomerId !== undefined)
-            requireNotBlank(this.explicitCustomerId, 'customerId');
-        requireNotBlank(this.productId, 'productId');
-        requireNotBlank(this.productVersion, 'productVersion');
-        requireNotBlank(this.countryCode, 'countryCode');
+        this.countryCode = requireValue(init.countryCode ?? defaultCountryCode, 'countryCode');
+        if (!/^\d{3}$/.test(this.countryCode)) {
+            throw invalidArgument('Must be three digits, 280 for Germany', 'countryCode');
+        }
+        this.bankCode = requireValue(init.bankCode, 'bankCode', maxBankCodeLength);
+        if (this.countryCode === defaultCountryCode && !/^\d{8}$/.test(this.bankCode)) {
+            throw invalidArgument('A German bank code (BLZ) has eight digits', 'bankCode');
+        }
+        this.userId = requireValue(init.userId, 'userId', maxIdLength);
+        const customerId = optionalString(init.customerId, 'customerId');
+        this.explicitCustomerId =
+            customerId === undefined ? undefined : requireValue(customerId, 'customerId', maxIdLength);
+        this.productId = requireValue(init.productId, 'productId', maxProductIdLength);
+        this.productVersion = requireValue(init.productVersion ?? '1.0', 'productVersion', maxProductVersionLength);
+        Object.freeze(this);
+    }
+    /**
+     * The bank's FinTS PIN/TAN endpoint, as checked by the constructor. A new `URL` on each access, so that changing one
+     * cannot change where the client posts the PIN.
+     */
+    get url() {
+        return new URL(this.href);
     }
     /** Customer ID; defaults to `userId`. */
     get customerId() {
         return this.explicitCustomerId ?? this.userId;
     }
+    /** What Node.js's `util.inspect` and `console.log` show: the bank code, neither the login data nor the product ID. */
+    [inspectCustom]() {
+        return `FinTsConfig(${this.bankCode})`;
+    }
 }
-function requireNotBlank(value, name) {
-    if (value.trim() === '')
+/**
+ * `value` without leading and trailing blanks; throws `TypeError` if it is no string, nothing is left, or what is left
+ * is not sendable (`requireLatin1`) or longer than `maxLength`: cut short, a value would be one the bank does not know.
+ */
+function requireValue(value, name, maxLength = Number.POSITIVE_INFINITY) {
+    const trimmed = trimBlanks(requireString(value, name));
+    if (trimmed === '')
         throw invalidArgument('Must not be empty', name);
+    requireLatin1(trimmed, name);
+    if (trimmed.length > maxLength)
+        throw invalidArgument(`At most ${maxLength} characters in FinTS 3.0`, name);
+    return trimmed;
+}
+/** `text`, unless it has characters FinTS 3.0 cannot send (ISO 8859-1 only); the message leaves out the value. */
+export function requireLatin1(text, name) {
+    if (!isLatin1(text))
+        throw invalidArgument('Contains characters FinTS 3.0 cannot send (ISO 8859-1 only)', name);
+    return text;
 }
 /** The host of `url` without the brackets of an IPv6 address, as `URL` writes it. */
 export function hostOf(url) {
@@ -63,27 +114,31 @@ export function hostOf(url) {
 /**
  * Throws `TypeError` unless `url` names a host and uses https: the PIN travels with every message.
  *
- * With `allowInsecure`, http is accepted for loopback hosts only.
+ * With `allowInsecure`, http is accepted for loopback hosts only. Throws as well for a user name or password in `url`:
+ * `fetch` refuses such a URL, with the whole URL in its error message. The message leaves them out.
  */
-export function requireSecureUrl(url, allowInsecure = false) {
+function requireSecureUrl(url, allowInsecure = false) {
     if (hostOf(url) === '')
         throw invalidArgument('The URL has no host', 'url');
+    if (url.username !== '' || url.password !== '')
+        throw invalidArgument('The URL must not contain credentials', 'url');
     const loopbackHttp = allowInsecure && url.protocol === 'http:' && isLoopback(hostOf(url));
     if (url.protocol !== 'https:' && !loopbackHttp)
         throw invalidArgument('PIN/TAN requires an https URL', 'url');
 }
 /**
- * Throws `TypeError` for an empty PIN, which the bank would count as a failed attempt, and for one with leading or
- * trailing blanks: FinTS values carry none (Formals B.4.1), so such a PIN could only go out changed.
+ * `pin`, unless FinTS 3.0 cannot send it: throws `TypeError` for an empty PIN, which the bank would count as a failed
+ * attempt, for one with leading or trailing blanks, which would go out without them since FinTS values carry none
+ * (Formals B.4.1), and for one with characters outside ISO 8859-1.
  *
  * The message leaves out the value.
  */
 export function requirePin(pin) {
-    if (pin.trim() === '')
+    if (trimBlanks(pin) === '')
         throw invalidArgument('The PIN is empty', 'pin');
-    if (pin.trim() !== pin)
+    if (trimBlanks(pin) !== pin)
         throw invalidArgument('The PIN begins or ends with a blank', 'pin');
-    return pin;
+    return requireLatin1(pin, 'pin');
 }
 /**
  * Throws `TypeError` if `pin` is shorter than `min` or longer than `max` characters, the bank's limits: the bank would

package/dist/core/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AA0BxC,mDAAmD;AACnD,MAAM,OAAO,WAAW;IACtB,yEAAyE;IACzE,MAAM,CAAU,kBAAkB,GAAG,kBAAkB,CAAC;IAE/C,GAAG,CAAM;IACT,QAAQ,CAAS;IACjB,MAAM,CAAS;IACP,kBAAkB,CAAqB;IAC/C,SAAS,CAAS;IAClB,cAAc,CAAS;IACvB,WAAW,CAAS;IACpB,gBAAgB,CAAU;IAEnC;;;OAGG;IACH,YAAY,IAAqB;QAC/B,6GAA6G;QAC7G,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnF,MAAM,eAAe,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,GAAQ,CAAC;QACb,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,KAAK,CAAC;QACvD,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7C,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC3C,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS;YAAE,eAAe,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;QAClG,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC7C,eAAe,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACvD,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,yCAAyC;IACzC,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,MAAM,CAAC;IAChD,CAAC;;AAGH,SAAS,eAAe,CAAC,KAAa,EAAE,IAAY;IAClD,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AAC5E,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,MAAM,CAAC,GAAQ;IAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAChG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAQ,EAAE,aAAa,GAAG,KAAK;IAC9D,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;IAC5E,MAAM,YAAY,GAAG,aAAa,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1F,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,YAAY;QAAE,MAAM,eAAe,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;AAChH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;IACxE,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG;QAAE,MAAM,eAAe,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;IAC5F,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,GAAuB,EAAE,GAAuB;IAC5F,MAAM,QAAQ,GAAG,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IAClE,MAAM,OAAO,GAAG,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACjE,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG;YACZ,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChB,MAAM,eAAe,CAAC,0BAA0B,KAAK,aAAa,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,MAAM,eAAe,GAAG,+CAA+C,CAAC;AAExE;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,KAAK,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9E,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAExC;;;GAGG;AACH,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,uBAAuB,GAAG,CAAC,CAAC;AA6BlC,sHAAsH;AACtH,MAAM,OAAO,WAAW;IACtB,2GAA2G;IAC3G,MAAM,CAAU,kBAAkB,GAAG,kBAAkB,CAAC;IAEvC,IAAI,CAAS;IACrB,QAAQ,CAAS;IACjB,MAAM,CAAS;IACP,kBAAkB,CAAqB;IAC/C,SAAS,CAAS;IAClB,cAAc,CAAS;IACvB,WAAW,CAAS;IACpB,gBAAgB,CAAU;IAEnC;;;;;;;;;;;;OAYG;IACH,YAAY,IAAqB;QAC/B,6GAA6G;QAC7G,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnF,MAAM,eAAe,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,GAAQ,CAAC;QACb,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,IAAI,KAAK,CAAC;QAC5F,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,IAAI,kBAAkB,EAAE,aAAa,CAAC,CAAC;QACvF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACtC,MAAM,eAAe,CAAC,uCAAuC,EAAE,aAAa,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAC3E,IAAI,IAAI,CAAC,WAAW,KAAK,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9E,MAAM,eAAe,CAAC,2CAA2C,EAAE,UAAU,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,kBAAkB;YACrB,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC7F,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,cAAc,IAAI,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,CAAC,CAAC;QAC5G,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,yCAAyC;IACzC,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,MAAM,CAAC;IAChD,CAAC;IAED,sHAAsH;IACtH,CAAC,aAAa,CAAC;QACb,OAAO,eAAe,IAAI,CAAC,QAAQ,GAAG,CAAC;IACzC,CAAC;;AAGH;;;GAGG;AACH,SAAS,YAAY,CAAC,KAAc,EAAE,IAAY,EAAE,SAAS,GAAG,MAAM,CAAC,iBAAiB;IACtF,MAAM,OAAO,GAAG,UAAU,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IACvD,IAAI,OAAO,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACrE,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS;QAAE,MAAM,eAAe,CAAC,WAAW,SAAS,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAC5G,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kHAAkH;AAClH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,IAAY;IACtD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,MAAM,eAAe,CAAC,6DAA6D,EAAE,IAAI,CAAC,CAAC;IAChH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,MAAM,CAAC,GAAQ;IAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAChG,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,GAAQ,EAAE,aAAa,GAAG,KAAK;IACvD,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;IAC5E,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;IACrH,MAAM,YAAY,GAAG,aAAa,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1F,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,YAAY;QAAE,MAAM,eAAe,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;AAChH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE;QAAE,MAAM,eAAe,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;IAC7E,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,GAAG;QAAE,MAAM,eAAe,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;IACjG,OAAO,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,GAAuB,EAAE,GAAuB;IAC5F,MAAM,QAAQ,GAAG,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IAClE,MAAM,OAAO,GAAG,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACjE,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG;YACZ,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChB,MAAM,eAAe,CAAC,0BAA0B,KAAK,aAAa,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,MAAM,eAAe,GAAG,+CAA+C,CAAC;AAExE;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,KAAK,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9E,CAAC"}

package/dist/core/errors.d.ts

@@ -1,54 +1,101 @@
 import { type FinTsFeedback } from './feedback.js';
-/** Base class of all errors the client raises about the bank and its data. */
+/**
+ * Base class of all errors the client raises about the bank and its data.
+ *
+ * Each error class states its `name`: a minifier renames classes, and `constructor.name` would show a meaningless one.
+ */
 export declare abstract class FinTsError extends Error {
-    protected constructor(name: string, message: string, cause?: unknown);
+    abstract name: string;
 }
-/** The connection to the bank failed or returned an HTTP error. */
+/**
+ * The connection to the bank failed or returned an HTTP error.
+ *
+ * It carries no `cause`: the transport's own error may hold the message it was sending, PIN and TAN included.
+ */
 export declare class FinTsTransportError extends FinTsError {
-    /** The HTTP status code of the response, `undefined` if there was none, for example after a timeout. */
+    name: string;
+    /**
+     * The HTTP status code of the bank's answer, `undefined` where none came, for example after a timeout; the client
+     * acts on it (`FinTsTransport.post`).
+     */
     readonly statusCode: number | undefined;
     constructor(message: string, options?: {
         statusCode?: number;
-        cause?: unknown;
     });
 }
 /** The bank's response could not be understood. */
 export declare class FinTsProtocolError extends FinTsError {
-    constructor(message: string);
+    name: string;
 }
 /** The bank does not offer the requested business transaction. */
 export declare class FinTsUnsupportedError extends FinTsError {
-    constructor(message: string);
+    name: string;
+}
+/**
+ * The client has no TAN method or medium to log in with: the method in use needs a TAN medium the client could not
+ * learn, or the bank offers the user only TAN methods the client cannot run. Pass a medium to
+ * `FinTsClient.selectTanMethod`, or choose another method.
+ *
+ * The client does not send a login the bank would refuse for it, but the steps before, such as the synchronization or
+ * the lookup of the TAN media, may have gone out.
+ */
+export declare class FinTsTanSetupError extends FinTsError {
+    name: string;
 }
 /**
- * The bank rejected the request; `feedback` holds all return codes.
+ * The bank rejected the request; `feedback` holds all return codes. A refused login is a `FinTsLoginRefusedError`.
  *
- * After a refused login every later call that would send the PIN fails with the same error, without contacting the
- * bank; create a new client to try again. The README tells which errors refuse a login.
+ * The message is not safe to log: by default it holds the code, text and parameters of each error the bank names, such
+ * as an IBAN or a login name, and so does `stack`. Log `codes` instead. `feedback` is a getter, not a field, so that
+ * `JSON.stringify` and Node.js's report of an uncaught error, which show an error's fields as they are, leave out at
+ * least the warnings and successes, such as the new login data of return code 3072.
  */
 export declare class FinTsBankError extends FinTsError {
+    #private;
+    name: string;
+    /**
+     * A rejection with the return codes in `feedback`; `message` defaults to the errors among them, with the bank's texts
+     * and parameters, such as `9010: Konto gesperrt [DE89370400440532013000]`, so it is not safe to log.
+     */
+    constructor(feedback: readonly FinTsFeedback[], message?: string);
     /** All return codes of the response, warnings and successes included. */
-    readonly feedback: readonly FinTsFeedback[];
-    /** A rejection with the return codes in `feedback`; `message` defaults to the errors among them. */
-    constructor(feedback: readonly FinTsFeedback[], message?: string, name?: string);
+    get feedback(): readonly FinTsFeedback[];
     /** The return codes of `feedback`. */
     get codes(): string[];
 }
-/** Wrong or blocked PIN, a refused login as `FinTsBankError` describes it. */
-export declare class FinTsPinError extends FinTsBankError {
-    constructor(feedback: readonly FinTsFeedback[]);
+/**
+ * The bank refused the login, so the client sends the PIN no more: every later call that would send it fails with this
+ * error without contacting the bank, also in a client restored from the saved state, until
+ * `FinTsClient.clearLoginRefusal` takes a PIN the user has entered anew; for good where the bank has changed the login
+ * data (`FinTsLoginDataChangedError`).
+ *
+ * Banks lock the access after a few failed logins, and a return code does not always tell whether the PIN was the
+ * reason, so any error in the answer to a login refuses it, also one that ends the dialog, and so does a wrong PIN
+ * wherever the bank reports it. Only where the bank names a reason the client can take care of, another TAN method or a
+ * new customer system ID, does the same call log in once more, for each reason once. The client refuses the login
+ * itself where it could not read the answers to two logins in a row, which the bank may have counted as failed
+ * attempts; `feedback` is empty then.
+ */
+export declare class FinTsLoginRefusedError extends FinTsBankError {
+    name: string;
+}
+/** Wrong or blocked PIN. */
+export declare class FinTsPinError extends FinTsLoginRefusedError {
+    name: string;
 }
 /** Invalid, expired or rejected TAN, as the bank reports it in answer to a TAN or to an approval status request. */
 export declare class FinTsTanError extends FinTsBankError {
-    constructor(feedback: readonly FinTsFeedback[]);
+    name: string;
 }
 /**
- * The bank has changed the user's login data and expects the new ones from now on (return code 3072).
+ * The bank has changed the user's login data and expects the new ones from now on (return code 3072), also where it
+ * names an error next to them, but for a rejected PIN, which is a `FinTsPinError`.
  *
- * The client has ended the dialog, and every later call fails with this error. Create a new client with the new data; a
- * `loginName` replaces user ID and customer ID: pass it as `userId`, without a customer ID.
+ * The client has ended the dialog, where the bank opened one, and logs in with the old data no more. Create a new
+ * client with the new data; a `loginName` replaces user ID and customer ID: pass it as `userId`, without a customer ID.
  */
-export declare class FinTsLoginDataChangedError extends FinTsBankError {
+export declare class FinTsLoginDataChangedError extends FinTsLoginRefusedError {
+    name: string;
     constructor(feedback: readonly FinTsFeedback[]);
     /** The new user ID (Benutzerkennung); `undefined` where the bank names none. */
     get userId(): string | undefined;
@@ -58,16 +105,24 @@ export declare class FinTsLoginDataChangedError extends FinTsBankError {
     get loginName(): string | undefined;
     private parameter;
 }
-/** The bank ended the dialog, for example after a timeout. */
+/**
+ * The bank ended the dialog, for example after a timeout; the next call logs in anew. Where the bank ends the dialog
+ * in answer to a login, the call fails with `FinTsLoginRefusedError` instead.
+ */
 export declare class FinTsDialogAbortedError extends FinTsBankError {
-    constructor(feedback: readonly FinTsFeedback[]);
+    name: string;
 }
 /** The user cancelled the TAN entry or the approval in the banking app. */
 export declare class FinTsTanCancelledError extends FinTsError {
+    name: string;
     constructor();
 }
-/** The user did not approve in the banking app within the bank's polling limit. */
+/**
+ * The user did not approve in the banking app in time: within the status requests the bank allows, 60 where it states
+ * none, and 10 minutes of polling at most.
+ */
 export declare class FinTsDecoupledTimeoutError extends FinTsError {
+    name: string;
     constructor();
 }
 /**
@@ -76,8 +131,10 @@ export declare class FinTsDecoupledTimeoutError extends FinTsError {
  * It does not extend `FinTsError`: it tells about the app's use of the client, not about the bank.
  */
 export declare class FinTsStateError extends Error {
-    constructor(message: string);
+    name: string;
 }
+/** The error of whatever a closed client is asked to do. */
+export declare function clientClosedError(): FinTsStateError;
 /**
  * The most specific error for the errors in `feedback`, the answer to a message that `completesApproval` or not.
  *
@@ -86,6 +143,23 @@ export declare class FinTsStateError extends Error {
  * for a wrong TAN, after which it would send the PIN again.
  */
 export declare function bankErrorFor(feedback: readonly FinTsFeedback[], completesApproval?: boolean): FinTsBankError;
-/** Runs `parse` on data from the bank and reports malformed data as `FinTsProtocolError`. */
+/**
+ * The refusal of a login whose answer carried `feedback`: `FinTsPinError` for a rejected PIN, else
+ * `FinTsLoginDataChangedError` for new login data, also next to other errors, and `FinTsLoginRefusedError` for anything
+ * else. The same for a refusal restored from the saved state, which keeps only `feedback`.
+ *
+ * New login data end the old ones for good, so the session takes care of no other reason the answer names.
+ */
+export declare function loginRefusalFor(feedback: readonly FinTsFeedback[]): FinTsLoginRefusedError;
+/**
+ * Runs `parse` on data from the bank and reports malformed data as `FinTsProtocolError`, whose message leaves the data
+ * out (`FormatError`).
+ */
 export declare function parseBankData<T>(parse: () => T): T;
+/**
+ * Runs `lookup`, which only completes data, such as the SEPA account list; `undefined` where the bank rejects it, so
+ * that the caller carries on without it. An aborted dialog counts as a rejection: banks end the dialog along with many.
+ * A refused login and a rejected TAN fail the call: the user must hear of them.
+ */
+export declare function tryLookUp<T>(lookup: () => Promise<T>): Promise<T | undefined>;
 //# sourceMappingURL=errors.d.ts.map

package/dist/core/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9E,8EAA8E;AAC9E,8BAAsB,UAAW,SAAQ,KAAK;IAC5C,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAKrE;AAED,mEAAmE;AACnE,qBAAa,mBAAoB,SAAQ,UAAU;IACjD,wGAAwG;IACxG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;CAIhF;AAED,mDAAmD;AACnD,qBAAa,kBAAmB,SAAQ,UAAU;gBACpC,OAAO,EAAE,MAAM;CAG5B;AAED,kEAAkE;AAClE,qBAAa,qBAAsB,SAAQ,UAAU;gBACvC,OAAO,EAAE,MAAM;CAG5B;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IAE5C,oGAAoG;gBACxF,QAAQ,EAAE,SAAS,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,SAAmB;IAYzF,sCAAsC;IACtC,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;CACF;AAED,8EAA8E;AAC9E,qBAAa,aAAc,SAAQ,cAAc;gBACnC,QAAQ,EAAE,SAAS,aAAa,EAAE;CAG/C;AAED,oHAAoH;AACpH,qBAAa,aAAc,SAAQ,cAAc;gBACnC,QAAQ,EAAE,SAAS,aAAa,EAAE;CAG/C;AAED;;;;;GAKG;AACH,qBAAa,0BAA2B,SAAQ,cAAc;gBAChD,QAAQ,EAAE,SAAS,aAAa,EAAE;IAI9C,gFAAgF;IAChF,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED,8EAA8E;IAC9E,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,+EAA+E;IAC/E,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,OAAO,CAAC,SAAS;CAKlB;AAED,8DAA8D;AAC9D,qBAAa,uBAAwB,SAAQ,cAAc;gBAC7C,QAAQ,EAAE,SAAS,aAAa,EAAE;CAG/C;AAED,2EAA2E;AAC3E,qBAAa,sBAAuB,SAAQ,UAAU;;CAIrD;AAED,mFAAmF;AACnF,qBAAa,0BAA2B,SAAQ,UAAU;;CAIzD;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAI5B;AAkCD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,EAAE,iBAAiB,UAAQ,GAAG,cAAc,CAO1G;AAED,6FAA6F;AAC7F,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAOlD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsC,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvF;;;;GAIG;AACH,8BAAsB,UAAW,SAAQ,KAAK;IAC5C,SAAkB,IAAI,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,UAAU;IACxC,IAAI,SAAyB;IAEtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;CAI/D;AAED,mDAAmD;AACnD,qBAAa,kBAAmB,SAAQ,UAAU;IACvC,IAAI,SAAwB;CACtC;AAED,kEAAkE;AAClE,qBAAa,qBAAsB,SAAQ,UAAU;IAC1C,IAAI,SAA2B;CACzC;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IACvC,IAAI,SAAwB;CACtC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,UAAU;;IACnC,IAAI,SAAoB;IAIjC;;;OAGG;gBACS,QAAQ,EAAE,SAAS,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM;IAWhE,yEAAyE;IACzE,IAAI,QAAQ,IAAI,SAAS,aAAa,EAAE,CAEvC;IAED,sCAAsC;IACtC,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;CACF;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,sBAAuB,SAAQ,cAAc;IAC/C,IAAI,SAA4B;CAC1C;AAED,4BAA4B;AAC5B,qBAAa,aAAc,SAAQ,sBAAsB;IAC9C,IAAI,SAAmB;CACjC;AAED,oHAAoH;AACpH,qBAAa,aAAc,SAAQ,cAAc;IACtC,IAAI,SAAmB;CACjC;AAED;;;;;;GAMG;AACH,qBAAa,0BAA2B,SAAQ,sBAAsB;IAC3D,IAAI,SAAgC;gBAEjC,QAAQ,EAAE,SAAS,aAAa,EAAE;IAI9C,gFAAgF;IAChF,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED,8EAA8E;IAC9E,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED,+EAA+E;IAC/E,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,OAAO,CAAC,SAAS;CAIlB;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IAChD,IAAI,SAA6B;CAC3C;AAED,2EAA2E;AAC3E,qBAAa,sBAAuB,SAAQ,UAAU;IAC3C,IAAI,SAA4B;;CAK1C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,UAAU;IAC/C,IAAI,SAAgC;;CAK9C;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IAC/B,IAAI,SAAqB;CACnC;AAED,4DAA4D;AAC5D,wBAAgB,iBAAiB,IAAI,eAAe,CAEnD;AAuCD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,EAAE,iBAAiB,UAAQ,GAAG,cAAc,CAO1G;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,GAAG,sBAAsB,CAI1F;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAOlD;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAanF"}