@coderoftime/fints 0.0.0-stage → 0.2.0

package/dist/session/signed-dialog.js

@@ -0,0 +1,170 @@
+import { requireLatin1 } from '../core/config.js';
+import { bankErrorFor, FinTsLoginDataChangedError, FinTsProtocolError, FinTsTanCancelledError, } from '../core/errors.js';
+import { allowedTanMethodsIn, FeedbackCodes, hasCode, hasErrors, userWarnings } from '../core/feedback.js';
+import { invalidArgument } from '../util/errors.js';
+import { IncomingMessage3 } from '../v3/message.js';
+import { appApprovalWait } from './app-approval.js';
+/**
+ * A dialog signed with the PIN, which settles each answer before it hands it out: it keeps the parameter data of the
+ * dialog's opening, passes the notices on, has the `LoginGuard` judge the answer and throws its errors, and completes
+ * the approval the bank asks for. The session sends every message signed with the PIN through it, so that the guard
+ * judges every answer, that to the dialog's end included.
+ */
+export class SignedDialog {
+    dialog;
+    session;
+    constructor(dialog, session) {
+        this.dialog = dialog;
+        this.session = session;
+    }
+    /** Whether the bank knows this dialog and it has not ended. */
+    get isActive() {
+        return this.dialog.isActive;
+    }
+    /** Logs in, which opens the dialog; with `synchronize` the bank also assigns a customer system ID. */
+    async login(synchronize = false) {
+        return this.settle(await this.dialog.start(synchronize), 'login');
+    }
+    /**
+     * Logs in, asking strong authentication for `order`, then sends `order` in a message of its own, as for listing the
+     * TAN media while no medium is chosen yet (`FinTs3Dialog.startWith`); returns both answers.
+     */
+    async loginWith(order) {
+        const start = this.dialog.startWith(order);
+        const login = await this.settle(await start.login(), 'login');
+        return [login, await this.settle(await start.order(), 'order')];
+    }
+    /** Sends `order`, the first page of a query, and completes the approval the bank asks for. */
+    async send(order) {
+        return this.settle(await this.dialog.send(order), 'order');
+    }
+    /**
+     * Sends `order` for a further page of a query (Formals B.6.3), whose answer must not ask for an approval: the client
+     * completes that of the first page only, so that a bank that asks anew for every page cannot prompt the user once per
+     * page. Throws `FinTsProtocolError` if it asks for one.
+     */
+    async sendFurtherPage(order) {
+        const response = await this.dialog.send(order);
+        this.receive(response, 'order', false);
+        if (this.dialog.approvalAskedIn(response) !== undefined) {
+            throw new FinTsProtocolError('The bank asks for an approval of a further page of the same query');
+        }
+        return response;
+    }
+    /**
+     * Ends the dialog at the bank; does nothing if it is not active. Of the answer only a rejected PIN counts, which the
+     * guard judges: the dialog is over either way.
+     */
+    async end() {
+        const response = await this.dialog.end();
+        if (response !== undefined && hasErrors(response.feedback)) {
+            this.session.guard.judge(bankErrorFor(response.feedback), 'order', this.dialog.method);
+        }
+    }
+    /**
+     * Receives `response`, the answer to a request of `kind`: keeps its parameter data where it answers the `opening` of
+     * the dialog, the login or its approval, even alongside errors, since the remedy for a refused login may need them;
+     * passes its notices on; and has the guard judge it, then throws its errors, as the refusal of the login where they
+     * amount to one.
+     */
+    receive(response, kind, opening) {
+        if (opening)
+            this.session.parameters.keep(response);
+        this.readNotices(response);
+        const error = hasErrors(response.feedback) ? bankErrorFor(response.feedback, kind === 'approval') : undefined;
+        const refusal = this.session.guard.judge(error, kind, this.dialog.method);
+        // Every further message of a refused login's dialog would carry the refused PIN.
+        if (refusal !== undefined)
+            this.dialog.discard();
+        if (error !== undefined)
+            throw refusal ?? error;
+    }
+    /**
+     * Where `response` answers a login, a request of `kind` other than `order`, or its approval with new login data: ends
+     * the dialog, stops the client from logging in with the old ones, and fails the call with
+     * `FinTsLoginDataChangedError` (Rückmeldungscodes C.6). It runs before any approval, which would cost the user a TAN
+     * for a session that ends anyway. New login data next to an error are the login's refusal already
+     * (`loginRefusalFor`).
+     */
+    async retireOldLoginData(response, kind) {
+        if (kind === 'order' || !hasCode(response.feedback, FeedbackCodes.newLoginData))
+            return;
+        await this.end();
+        const error = new FinTsLoginDataChangedError(response.feedback);
+        throw this.session.guard.judge(error, kind, this.dialog.method) ?? error;
+    }
+    /**
+     * Receives `response`, the answer to a request of `kind`, then completes the approval it asks for; returns it joined
+     * with the response that completes the approval.
+     *
+     * Throws `FinTsProtocolError` if that response asks for an approval once more: the bank has not executed the message
+     * then either, and read as done it would report an empty result.
+     */
+    async settle(response, kind) {
+        const opening = kind !== 'order';
+        this.receive(response, kind, opening);
+        await this.retireOldLoginData(response, kind);
+        const approval = this.dialog.approvalAskedIn(response);
+        if (approval === undefined)
+            return response;
+        const approved = approval.challenge.isDecoupled
+            ? await this.awaitAppApproval(approval, opening)
+            : await this.enterTan(approval, opening);
+        await this.retireOldLoginData(approved, kind);
+        if (this.dialog.approvalAskedIn(approved) !== undefined) {
+            throw new FinTsProtocolError('The bank asks for another approval in answer to the approval');
+        }
+        return IncomingMessage3.combine(response, approved);
+    }
+    /** Passes on the notices in `response`: the TAN methods the user may use (3920), the bank's messages and warnings. */
+    readNotices(response) {
+        const allowed = allowedTanMethodsIn(response.feedback);
+        if (allowed.length > 0)
+            this.session.state.rememberAllowedMethods(allowed);
+        for (const message of response.bankMessages)
+            this.session.prompts.showBankMessage(message);
+        for (const warning of userWarnings(response.feedback))
+            this.session.prompts.showWarning(warning);
+    }
+    /** Asks the user for the TAN `approval` takes and sends it; `opening` tells whether it approves the login. */
+    async enterTan(approval, opening) {
+        const answer = await this.session.prompts.askTan(approval.challenge);
+        if (answer.kind === 'approved') {
+            throw invalidArgument('Answered a TAN challenge with an approval in the banking app', 'tanCallback');
+        }
+        // NFKC, so that digits of another width, such as those of a Japanese input method, go out as the digits they are.
+        const tan = answer.kind === 'tan' ? answer.tan.normalize('NFKC').trim() : '';
+        if (tan === '')
+            throw new FinTsTanCancelledError();
+        const response = await approval.submitTan(requireTanOf(approval.challenge.method, tan));
+        this.receive(response, 'approval', opening);
+        return response;
+    }
+    /** Waits for the user to approve in the banking app; `opening` tells whether the approval is that of the login. */
+    awaitAppApproval(approval, opening) {
+        const prompts = this.session.prompts;
+        return appApprovalWait(approval, {
+            ask: (challenge) => prompts.askTan(challenge),
+            pause: (delayMs, interrupt) => prompts.pause(delayMs, interrupt),
+            receive: (response) => {
+                this.receive(response, 'approval', opening);
+            },
+        }).run();
+    }
+}
+/**
+ * Throws `TypeError` for a TAN that `method` rules out, which the bank would count as a failed attempt: one longer than
+ * `TanMethod.maxTanLength`, or with other characters than digits for a `TanMethod.numericTan` method; and for one that
+ * FinTS 3.0 cannot send. The message leaves out the TAN.
+ */
+function requireTanOf(method, tan) {
+    const max = method.maxTanLength;
+    if (max !== undefined && max > 0 && tan.length > max) {
+        throw invalidArgument(`The TAN method ${method.name} takes TANs of at most ${max} characters`, 'tan');
+    }
+    if (method.numericTan && !/^[0-9]+$/.test(tan)) {
+        throw invalidArgument(`The TAN method ${method.name} takes digits only`, 'tan');
+    }
+    return requireLatin1(tan, 'tan');
+}
+//# sourceMappingURL=signed-dialog.js.map

package/dist/session/signed-dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signed-dialog.js","sourceRoot":"","sources":["../../src/session/signed-dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAE3G,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAapD;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAEJ;IACA;IAFnB,YACmB,MAAoB,EACpB,OAAqB;QADrB,WAAM,GAAN,MAAM,CAAc;QACpB,YAAO,GAAP,OAAO,CAAc;IACrC,CAAC;IAEJ,+DAA+D;IAC/D,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,sGAAsG;IACtG,KAAK,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,KAAkB;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9D,OAAO,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,8FAA8F;IAC9F,KAAK,CAAC,IAAI,CAAC,KAAkB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,KAAkB;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,kBAAkB,CAAC,mEAAmE,CAAC,CAAC;QACpG,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG;QACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,OAAO,CAAC,QAA0B,EAAE,IAAiB,EAAE,OAAgB;QAC7E,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9G,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,iFAAiF;QACjF,IAAI,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,OAAO,IAAI,KAAK,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,kBAAkB,CAAC,QAA0B,EAAE,IAAiB;QAC5E,IAAI,IAAI,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC;YAAE,OAAO;QACxF,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,IAAI,0BAA0B,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,MAAM,CAAC,QAA0B,EAAE,IAAiB;QAChE,MAAM,OAAO,GAAG,IAAI,KAAK,OAAO,CAAC;QACjC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC;QAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW;YAC7C,CAAC,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;YAChD,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,kBAAkB,CAAC,8DAA8D,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,sHAAsH;IAC9G,WAAW,CAAC,QAA0B;QAC5C,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC3E,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,YAAY;YAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC3F,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACnG,CAAC;IAED,8GAA8G;IACtG,KAAK,CAAC,QAAQ,CAAC,QAAoC,EAAE,OAAgB;QAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,MAAM,eAAe,CAAC,8DAA8D,EAAE,aAAa,CAAC,CAAC;QACvG,CAAC;QACD,kHAAkH;QAClH,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,IAAI,GAAG,KAAK,EAAE;YAAE,MAAM,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mHAAmH;IAC3G,gBAAgB,CAAC,QAAoC,EAAE,OAAgB;QAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QACrC,OAAO,eAAe,CAAC,QAAQ,EAAE;YAC/B,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;YAC7C,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC;YAChE,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YAC9C,CAAC;SACF,CAAC,CAAC,GAAG,EAAE,CAAC;IACX,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,MAAiB,EAAE,GAAW;IAClD,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC;IAChC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACrD,MAAM,eAAe,CAAC,kBAAkB,MAAM,CAAC,IAAI,0BAA0B,GAAG,aAAa,EAAE,KAAK,CAAC,CAAC;IACxG,CAAC;IACD,IAAI,MAAM,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,MAAM,eAAe,CAAC,kBAAkB,MAAM,CAAC,IAAI,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACnC,CAAC"}

package/dist/session/tan-selection.d.ts

@@ -0,0 +1,96 @@
+import { TanMethod, type TanMedium } from '../tan/tan-models.js';
+import { FinTs3Dialog } from '../v3/dialog.js';
+import type { FinTs3Protocol } from '../v3/protocol.js';
+import type { SessionState } from './session-state.js';
+import type { UserPrompts } from './user-prompts.js';
+/**
+ * The TAN method and medium the session's messages are signed with, chosen by the user among what the bank offers and
+ * the user may use, and kept in the session state.
+ */
+export declare class TanSelection {
+    private readonly protocol;
+    private readonly state;
+    private readonly prompts;
+    /**
+     * The lookups of this session that found no medium to choose, by TAN method, with the list each gave; `undefined`
+     * where the bank gave none. Such a lookup is not repeated for its method until `select` or `forgetMedium` drops it.
+     */
+    private readonly lookupsWithoutMedium;
+    /** Whether the bank refused a login signed with the one-step method in this session. */
+    private oneStepRefused;
+    constructor(protocol: FinTs3Protocol, state: SessionState, prompts: UserPrompts);
+    /** The TAN method in use; the one-step method until one is chosen. */
+    get method(): TanMethod;
+    /** Switches to `securityFunction` and `tanMedium` for the dialogs to come. */
+    select(securityFunction: string, tanMedium: string | undefined): void;
+    /**
+     * Forgets the medium in use and the lookups of this session, so that the next login looks the media up anew where the
+     * method needs one: the bank may have refused the medium, such as that of a phone the user has replaced.
+     */
+    forgetMedium(): void;
+    /**
+     * A dialog signed with the TAN method in use and its medium.
+     *
+     * Throws `FinTsTanSetupError` if the method needs a medium the user has not chosen: the bank would refuse the
+     * login, and the client would not send the PIN again.
+     */
+    newDialog(): FinTs3Dialog;
+    /**
+     * The dialog that looks up the TAN media, signed with the TAN method in use.
+     *
+     * It runs before the medium is known, so it names a placeholder where the method needs one; the bank ignores the
+     * medium in this dialog (PIN/TAN B.4.3.1.3).
+     */
+    lookupDialog(): FinTs3Dialog;
+    /**
+     * The synchronization dialog. It runs before the TAN media are looked up, so its method must do without a medium the
+     * user has not chosen: the placeholder for one is meant for the lookup only (PIN/TAN B.4.3.1.3). The first method
+     * that does signs it:
+     * 1. the TAN method in use;
+     * 2. the one-step method, as for a user whose methods are not known yet (PIN/TAN B.4.3.1), unless the bank has refused
+     *    a one-step login;
+     * 3. another two-step method the user may use.
+     *
+     * Throws `FinTsTanSetupError` if none does, before the bank could refuse the login.
+     */
+    synchronizationDialog(): FinTs3Dialog;
+    /** Whether `method` needs a medium the user has not chosen. */
+    private lacksMedium;
+    /**
+     * The two-step TAN methods the bank offers, the user may use and this client can run; the one-step method if there
+     * are none.
+     *
+     * Throws `FinTsTanSetupError` if the bank offers the user nothing but methods the client cannot run.
+     */
+    available(): TanMethod[];
+    /**
+     * Stops using `rejected`, the method of a login the bank refused; returns whether another available method is left.
+     *
+     * The user chooses that method, unless the one in use is still available: a refused one-step synchronization does
+     * not rule out the method the user chose before.
+     */
+    replace(rejected: TanMethod): Promise<boolean>;
+    /** Keeps the chosen TAN method if it is still available, otherwise lets the user choose. */
+    ensureMethodChosen(): Promise<void>;
+    /**
+     * Whether the media of the method in use have to be looked up: it needs a medium the user has not chosen, and they
+     * were not looked up in vain for it in this session.
+     */
+    get mediumToLookUp(): boolean;
+    /**
+     * Lets the user choose the medium of the method in use among the active ones in `media`, the result of a lookup;
+     * none where the lookup gave no list or no active medium.
+     */
+    chooseMedium(media: TanMedium[] | undefined): Promise<void>;
+    /**
+     * The list of the lookup that found no medium for the method in use; `undefined` where there was none, or the bank
+     * gave no list.
+     *
+     * It outlasts the call that failed for want of the medium, so that `getTanMedia` can show the user the list that tells
+     * why: the client neither looks the media up again for the method nor can list them in a dialog without a medium.
+     */
+    get lookedUpMedia(): TanMedium[] | undefined;
+    /** The name of the medium the user chooses among the active ones in `media`; `undefined` if none is active. */
+    private chooseMediumOf;
+}
+//# sourceMappingURL=tan-selection.d.ts.map

package/dist/session/tan-selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tan-selection.d.ts","sourceRoot":"","sources":["../../src/session/tan-selection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;GAGG;AACH,qBAAa,YAAY;IAWrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAZ1B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8C;IAEnF,wFAAwF;IACxF,OAAO,CAAC,cAAc,CAAS;gBAGZ,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,WAAW;IAGvC,sEAAsE;IACtE,IAAI,MAAM,IAAI,SAAS,CAKtB;IAED,8EAA8E;IAC9E,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAKrE;;;OAGG;IACH,YAAY,IAAI,IAAI;IAKpB;;;;;OAKG;IACH,SAAS,IAAI,YAAY;IAYzB;;;;;OAKG;IACH,YAAY,IAAI,YAAY;IAK5B;;;;;;;;;;OAUG;IACH,qBAAqB,IAAI,YAAY;IAYrC,+DAA+D;IAC/D,OAAO,CAAC,WAAW;IAInB;;;;;OAKG;IACH,SAAS,IAAI,SAAS,EAAE;IAgBxB;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IASpD,4FAA4F;IACtF,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQzC;;;OAGG;IACH,IAAI,cAAc,IAAI,OAAO,CAG5B;IAED;;;OAGG;IACG,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjE;;;;;;OAMG;IACH,IAAI,aAAa,IAAI,SAAS,EAAE,GAAG,SAAS,CAE3C;IAED,+GAA+G;YACjG,cAAc;CAQ7B"}

package/dist/session/tan-selection.js

@@ -0,0 +1,189 @@
+import { FinTsTanSetupError } from '../core/errors.js';
+import { TanMethod } from '../tan/tan-models.js';
+import { FinTs3Dialog } from '../v3/dialog.js';
+import { noReference } from '../v3/segments.js';
+/**
+ * The TAN method and medium the session's messages are signed with, chosen by the user among what the bank offers and
+ * the user may use, and kept in the session state.
+ */
+export class TanSelection {
+    protocol;
+    state;
+    prompts;
+    /**
+     * The lookups of this session that found no medium to choose, by TAN method, with the list each gave; `undefined`
+     * where the bank gave none. Such a lookup is not repeated for its method until `select` or `forgetMedium` drops it.
+     */
+    lookupsWithoutMedium = new Map();
+    /** Whether the bank refused a login signed with the one-step method in this session. */
+    oneStepRefused = false;
+    constructor(protocol, state, prompts) {
+        this.protocol = protocol;
+        this.state = state;
+        this.prompts = prompts;
+    }
+    /** The TAN method in use; the one-step method until one is chosen. */
+    get method() {
+        const code = this.state.tanMethod;
+        if (code === undefined || code === TanMethod.oneStep.securityFunction)
+            return TanMethod.oneStep;
+        const methods = this.protocol.parameters.bankParameters?.tanMethods ?? [];
+        return methods.find((m) => m.securityFunction === code) ?? TanMethod.oneStep;
+    }
+    /** Switches to `securityFunction` and `tanMedium` for the dialogs to come. */
+    select(securityFunction, tanMedium) {
+        this.state.useTanMethod(securityFunction, tanMedium);
+        this.lookupsWithoutMedium.delete(securityFunction);
+    }
+    /**
+     * Forgets the medium in use and the lookups of this session, so that the next login looks the media up anew where the
+     * method needs one: the bank may have refused the medium, such as that of a phone the user has replaced.
+     */
+    forgetMedium() {
+        this.state.useTanMedium(undefined);
+        this.lookupsWithoutMedium.clear();
+    }
+    /**
+     * A dialog signed with the TAN method in use and its medium.
+     *
+     * Throws `FinTsTanSetupError` if the method needs a medium the user has not chosen: the bank would refuse the
+     * login, and the client would not send the PIN again.
+     */
+    newDialog() {
+        const method = this.method;
+        if (this.lacksMedium(method)) {
+            throw new FinTsTanSetupError(`The TAN method ${method.name} needs a TAN medium, and the client could not learn one: the bank lists no ` +
+                'active medium for it, or does not offer or permit the list of TAN media, or rejected it. Pass a medium to ' +
+                'selectTanMethod, or choose another method');
+        }
+        return FinTs3Dialog.signed(this.protocol, method, this.state.tanMedium);
+    }
+    /**
+     * The dialog that looks up the TAN media, signed with the TAN method in use.
+     *
+     * It runs before the medium is known, so it names a placeholder where the method needs one; the bank ignores the
+     * medium in this dialog (PIN/TAN B.4.3.1.3).
+     */
+    lookupDialog() {
+        const method = this.method;
+        return FinTs3Dialog.signed(this.protocol, method, this.lacksMedium(method) ? noReference : this.state.tanMedium);
+    }
+    /**
+     * The synchronization dialog. It runs before the TAN media are looked up, so its method must do without a medium the
+     * user has not chosen: the placeholder for one is meant for the lookup only (PIN/TAN B.4.3.1.3). The first method
+     * that does signs it:
+     * 1. the TAN method in use;
+     * 2. the one-step method, as for a user whose methods are not known yet (PIN/TAN B.4.3.1), unless the bank has refused
+     *    a one-step login;
+     * 3. another two-step method the user may use.
+     *
+     * Throws `FinTsTanSetupError` if none does, before the bank could refuse the login.
+     */
+    synchronizationDialog() {
+        const method = this.method;
+        if (!this.lacksMedium(method))
+            return FinTs3Dialog.signed(this.protocol, method, this.state.tanMedium);
+        if (!this.oneStepRefused)
+            return FinTs3Dialog.signed(this.protocol, TanMethod.oneStep);
+        const other = this.available().find((m) => !m.isOneStep && !this.lacksMedium(m));
+        if (other !== undefined)
+            return FinTs3Dialog.signed(this.protocol, other);
+        throw new FinTsTanSetupError(`The bank refuses the one-step method, and the TAN method ${method.name} needs a TAN medium, which the client ` +
+            'can look up only after the synchronization. Pass the medium to selectTanMethod, or choose another method');
+    }
+    /** Whether `method` needs a medium the user has not chosen. */
+    lacksMedium(method) {
+        return this.state.tanMedium === undefined && needsMediumChoice(method);
+    }
+    /**
+     * The two-step TAN methods the bank offers, the user may use and this client can run; the one-step method if there
+     * are none.
+     *
+     * Throws `FinTsTanSetupError` if the bank offers the user nothing but methods the client cannot run.
+     */
+    available() {
+        const bpd = this.protocol.parameters.bankParameters;
+        if (bpd === undefined)
+            return [TanMethod.oneStep];
+        const allowed = this.state.allowedMethods;
+        const isAllowed = (securityFunction) => allowed === undefined || allowed.length === 0 || allowed.includes(securityFunction);
+        const runnable = bpd.tanMethods.filter((m) => isAllowed(m.securityFunction));
+        if (runnable.length === 0 && bpd.unsupportedTanMethods.some(isAllowed)) {
+            throw new FinTsTanSetupError('The bank offers only TAN methods this client cannot run: process variant 1, or methods that need an SMS ' +
+                'charge account or an HHD_UC answer');
+        }
+        return runnable.length === 0 ? [TanMethod.oneStep] : runnable;
+    }
+    /**
+     * Stops using `rejected`, the method of a login the bank refused; returns whether another available method is left.
+     *
+     * The user chooses that method, unless the one in use is still available: a refused one-step synchronization does
+     * not rule out the method the user chose before.
+     */
+    async replace(rejected) {
+        if (rejected.isOneStep)
+            this.oneStepRefused = true;
+        const others = this.available().filter((m) => m.securityFunction !== rejected.securityFunction);
+        if (others.some((m) => m.securityFunction === this.state.tanMethod))
+            return true;
+        if (others.length === 0)
+            return false;
+        this.state.useTanMethod((await this.prompts.chooseMethod(others)).securityFunction);
+        return true;
+    }
+    /** Keeps the chosen TAN method if it is still available, otherwise lets the user choose. */
+    async ensureMethodChosen() {
+        const candidates = this.available();
+        const method = candidates.find((m) => m.securityFunction === this.state.tanMethod) ??
+            (await this.prompts.chooseMethod(candidates));
+        if (method.securityFunction !== this.state.tanMethod)
+            this.state.useTanMethod(method.securityFunction);
+    }
+    /**
+     * Whether the media of the method in use have to be looked up: it needs a medium the user has not chosen, and they
+     * were not looked up in vain for it in this session.
+     */
+    get mediumToLookUp() {
+        const method = this.method;
+        return this.lacksMedium(method) && !this.lookupsWithoutMedium.has(method.securityFunction);
+    }
+    /**
+     * Lets the user choose the medium of the method in use among the active ones in `media`, the result of a lookup;
+     * none where the lookup gave no list or no active medium.
+     */
+    async chooseMedium(media) {
+        const method = this.method;
+        const medium = media === undefined ? undefined : await this.chooseMediumOf(method, media);
+        this.state.useTanMedium(medium);
+        if (medium === undefined)
+            this.lookupsWithoutMedium.set(method.securityFunction, media);
+    }
+    /**
+     * The list of the lookup that found no medium for the method in use; `undefined` where there was none, or the bank
+     * gave no list.
+     *
+     * It outlasts the call that failed for want of the medium, so that `getTanMedia` can show the user the list that tells
+     * why: the client neither looks the media up again for the method nor can list them in a dialog without a medium.
+     */
+    get lookedUpMedia() {
+        return this.lookupsWithoutMedium.get(this.method.securityFunction);
+    }
+    /** The name of the medium the user chooses among the active ones in `media`; `undefined` if none is active. */
+    async chooseMediumOf(method, media) {
+        const active = media.filter((m) => m.isActive && m.name !== undefined);
+        // HITAB version 5 names the method each medium belongs to; a medium of another method would not do.
+        const ofMethod = active.filter((m) => m.securityFunction === method.securityFunction);
+        const candidates = ofMethod.length === 0 ? active : ofMethod;
+        if (candidates.length === 0)
+            return undefined;
+        return (await this.prompts.chooseMedium(candidates)).name;
+    }
+}
+/**
+ * Whether messages signed with `method` must name the TAN medium: the method requires the name, and the user may have
+ * several media (PIN/TAN, HKTAN "Bezeichnung des TAN-Mediums").
+ */
+function needsMediumChoice(method) {
+    return method.needsMediumName && (method.activeMediaCount ?? 0) > 1;
+}
+//# sourceMappingURL=tan-selection.js.map

package/dist/session/tan-selection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tan-selection.js","sourceRoot":"","sources":["../../src/session/tan-selection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAkB,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD;;;GAGG;AACH,MAAM,OAAO,YAAY;IAWJ;IACA;IACA;IAZnB;;;OAGG;IACc,oBAAoB,GAAG,IAAI,GAAG,EAAmC,CAAC;IAEnF,wFAAwF;IAChF,cAAc,GAAG,KAAK,CAAC;IAE/B,YACmB,QAAwB,EACxB,KAAmB,EACnB,OAAoB;QAFpB,aAAQ,GAAR,QAAQ,CAAgB;QACxB,UAAK,GAAL,KAAK,CAAc;QACnB,YAAO,GAAP,OAAO,CAAa;IACpC,CAAC;IAEJ,sEAAsE;IACtE,IAAI,MAAM;QACR,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,CAAC,OAAO,CAAC,gBAAgB;YAAE,OAAO,SAAS,CAAC,OAAO,CAAC;QAChG,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,UAAU,IAAI,EAAE,CAAC;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC;IAC/E,CAAC;IAED,8EAA8E;IAC9E,MAAM,CAAC,gBAAwB,EAAE,SAA6B;QAC5D,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACnC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,kBAAkB,CAC1B,kBAAkB,MAAM,CAAC,IAAI,6EAA6E;gBACxG,4GAA4G;gBAC5G,2CAA2C,CAC9C,CAAC;QACJ,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACnH,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YAAE,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACvG,IAAI,CAAC,IAAI,CAAC,cAAc;YAAE,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACvF,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QACjF,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1E,MAAM,IAAI,kBAAkB,CAC1B,4DAA4D,MAAM,CAAC,IAAI,wCAAwC;YAC7G,0GAA0G,CAC7G,CAAC;IACJ,CAAC;IAED,+DAA+D;IACvD,WAAW,CAAC,MAAiB;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC;QACpD,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QAC1C,MAAM,SAAS,GAAG,CAAC,gBAAwB,EAAW,EAAE,CACtD,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtF,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC7E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,kBAAkB,CAC1B,0GAA0G;gBACxG,oCAAoC,CACvC,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,QAAmB;QAC/B,IAAI,QAAQ,CAAC,SAAS;YAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QAChG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;YAAE,OAAO,IAAI,CAAC;QACjF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,kBAAkB;QACtB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,MAAM,GACV,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;YACnE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAChD,IAAI,MAAM,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,IAAI,cAAc;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,KAA8B;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,MAAM,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC1F,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACrE,CAAC;IAED,+GAA+G;IACvG,KAAK,CAAC,cAAc,CAAC,MAAiB,EAAE,KAA2B;QACzE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACvE,oGAAoG;QACpG,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtF,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC7D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAC9C,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5D,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,MAAiB;IAC1C,OAAO,MAAM,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;AACtE,CAAC"}

package/dist/session/user-prompts.d.ts

@@ -0,0 +1,65 @@
+import type { BankMessage } from '../core/bank-info.js';
+import type { FinTsClientOptions, MessageLogger } from '../core/client.js';
+import type { FinTsFeedback } from '../core/feedback.js';
+import { TanAnswer, type TanChallenge } from '../tan/challenge.js';
+import type { TanMedium, TanMethod } from '../tan/tan-models.js';
+/**
+ * Everything a session tells the app, asks of it or waits for: the bank's messages, warnings and log, the TAN callback,
+ * the selectors and the pauses between status requests.
+ *
+ * Once the client is closed nothing is told or asked, and every wait ends with `FinTsStateError`. Errors of the
+ * callbacks that only inform the app wait for `reportingCallbackErrors`, as `FinTsClientOptions` promises.
+ */
+export declare class UserPrompts {
+    private readonly options;
+    private closed;
+    /** The first error an informing callback threw during the running call. */
+    private callbackError;
+    /** Aborts the waits under way; each wait removes its abort when it is over, or when nothing waits for it any more. */
+    private readonly aborts;
+    constructor(options: FinTsClientOptions);
+    /** Ends every wait; the client calls it once. */
+    close(): void;
+    /** Throws `FinTsStateError` once `close` was called. */
+    checkOpen(): void;
+    /**
+     * Runs `call` and then fails it with the first error an informing callback threw meanwhile; an error of `call` itself
+     * takes precedence.
+     */
+    reportingCallbackErrors<T>(call: () => Promise<T>): Promise<T>;
+    /** The app's logger, whose errors are kept for `reportingCallbackErrors`; `undefined` without one. */
+    get logger(): MessageLogger | undefined;
+    /** Passes the bank's `message` to the app, unless the client is closed. */
+    showBankMessage(message: BankMessage): void;
+    /** Passes the bank's `warning` to the app, unless the client is closed. */
+    showWarning(warning: FinTsFeedback): void;
+    private inform;
+    /**
+     * Shows `challenge` through the TAN callback and returns its answer; rejects with `TypeError` for anything but a
+     * `TanAnswer`. Once `TanChallenge.resolved` settles, nothing waits for the answer any more.
+     */
+    askTan(challenge: TanChallenge): Promise<TanAnswer>;
+    /** Waits for `delayMs` milliseconds, or until `interrupt` settles. */
+    pause(delayMs: number, interrupt?: Promise<unknown>): Promise<void>;
+    /**
+     * The TAN method to use among `candidates`: the app's choice, or the first without a selector or an answer.
+     *
+     * Throws `TypeError` if the selector returns a method that is not among `candidates`.
+     */
+    chooseMethod(candidates: readonly TanMethod[]): Promise<TanMethod>;
+    /**
+     * The TAN medium to use among the active `media`: the app's choice, or the first without a selector or an answer.
+     *
+     * Throws `TypeError` if the selector returns a medium that is not among `media`.
+     */
+    chooseMedium(media: readonly TanMedium[]): Promise<TanMedium>;
+    /**
+     * Starts `wait` and ends it with `FinTsStateError` if `close` is called before it is over. Once `unwanted` settles,
+     * nothing waits for it any more: it is forgotten then, rather than kept until a callback that never answers does.
+     *
+     * Once the client is closed, the returned promise rejects rather than this function throwing: a caller that starts
+     * several waits at once would otherwise leave the failure of those started first unheard.
+     */
+    private unlessClosed;
+}
+//# sourceMappingURL=user-prompts.d.ts.map

package/dist/session/user-prompts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-prompts.d.ts","sourceRoot":"","sources":["../../src/session/user-prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE3E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIjE;;;;;;GAMG;AACH,qBAAa,WAAW;IASV,OAAO,CAAC,QAAQ,CAAC,OAAO;IARpC,OAAO,CAAC,MAAM,CAAS;IAEvB,2EAA2E;IAC3E,OAAO,CAAC,aAAa,CAAiC;IAEtD,sHAAsH;IACtH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;gBAEnB,OAAO,EAAE,kBAAkB;IAExD,iDAAiD;IACjD,KAAK,IAAI,IAAI;IAMb,wDAAwD;IACxD,SAAS,IAAI,IAAI;IAIjB;;;OAGG;IACG,uBAAuB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IASpE,sGAAsG;IACtG,IAAI,MAAM,IAAI,aAAa,GAAG,SAAS,CAQtC;IAED,2EAA2E;IAC3E,eAAe,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAS3C,2EAA2E;IAC3E,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IASzC,OAAO,CAAC,MAAM;IAQd;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAInD,sEAAsE;IACtE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnE;;;;OAIG;IACG,YAAY,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC;IAUxE;;;;OAIG;IACG,YAAY,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC;IAUnE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CA0BrB"}