@fin.cx/opendata 4.1.0 → 4.3.0

package/.smartconfig.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "fin.cx",
       "gitrepo": "opendata",
-      "description": "Open business and financial data for TypeScript: register lookups on the German register portal (handelsregister.de) without storage, the statutory public holidays of the German federal states, and stock and crypto prices and fundamentals from several providers.",
+      "description": "Open business and financial data for TypeScript: register lookups on the German register portal (handelsregister.de) without storage, the statutory public holidays of the German federal states, the base rate of § 247 BGB, and stock and crypto prices and fundamentals from several providers.",
       "npmPackagename": "@fin.cx/opendata",
       "license": "MIT",
       "projectDomain": "fin.cx",
@@ -25,7 +25,9 @@
         "fundamentals",
         "public holidays",
         "Feiertage",
-        "working days"
+        "working days",
+        "Basiszinssatz",
+        "base rate"
       ]
     },
     "release": {

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@fin.cx/opendata',
-    version: '4.1.0',
-    description: 'Open business and financial data for TypeScript: register lookups on the German register portal (handelsregister.de) without storage, the statutory public holidays of the German federal states, and stock and crypto prices and fundamentals from several providers.'
+    version: '4.3.0',
+    description: 'Open business and financial data for TypeScript: register lookups on the German register portal (handelsregister.de) without storage, the statutory public holidays of the German federal states, the base rate of § 247 BGB, and stock and crypto prices and fundamentals from several providers.'
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxrQkFBa0I7SUFDeEIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLHdRQUF3UTtDQUN0UixDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxrQkFBa0I7SUFDeEIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLG9TQUFvUztDQUNsVCxDQUFBIn0=

package/dist_ts/baserate/baserate.d.ts

@@ -0,0 +1,9 @@
+import type { IBaseRatePeriod, IBaseRateSpan, TIsoDate } from './interfaces.js';
+/** The base rate in force on a day: the published period that contains it. */
+export declare const getBaseRate: (dateArg: TIsoDate) => IBaseRatePeriod;
+/**
+ * A span of days, both inclusive, split where the base rate changes: one piece per published
+ * period it touches, oldest first. Interest under § 288 BGB is computed per piece, since the rate
+ * of each half-year applies to the days in it.
+ */
+export declare const splitByBaseRate: (fromArg: TIsoDate, toArg: TIsoDate) => IBaseRateSpan[];

package/dist_ts/baserate/baserate.js

@@ -0,0 +1,49 @@
+import { BaseRateError } from './classes.baserateerror.js';
+import { baseRateFirstDay, baseRatePeriods, baseRatesReadOn } from './data.baserate.js';
+const ISO_DATE = /^(\d{4})-(\d{2})-(\d{2})$/;
+const checkDate = (dateArg) => {
+    const match = typeof dateArg === 'string' ? ISO_DATE.exec(dateArg) : null;
+    const utc = match ? new Date(Date.UTC(Number(match[1]), Number(match[2]) - 1, Number(match[3]))) : null;
+    if (!match || !utc || utc.toISOString().slice(0, 10) !== dateArg) {
+        throw new BaseRateError('invalid_date', `${JSON.stringify(dateArg)} is not a calendar date written YYYY-MM-DD.`);
+    }
+};
+const addDay = (dateArg) => {
+    const utc = new Date(`${dateArg}T00:00:00Z`);
+    utc.setUTCDate(utc.getUTCDate() + 1);
+    return utc.toISOString().slice(0, 10);
+};
+/** The base rate in force on a day: the published period that contains it. */
+export const getBaseRate = (dateArg) => {
+    checkDate(dateArg);
+    if (dateArg < baseRateFirstDay) {
+        throw new BaseRateError('before_first_period', `${dateArg} lies before ${baseRateFirstDay}, the first day of the Bundesbank's table.`);
+    }
+    const period = baseRatePeriods.find((periodArg) => periodArg.validFrom <= dateArg && dateArg <= periodArg.validTo);
+    if (!period) {
+        throw new BaseRateError('not_published', `${dateArg} lies after ${baseRatePeriods[baseRatePeriods.length - 1].validTo}; the base rate of its half-year was not published when the table was read on ${baseRatesReadOn}.`);
+    }
+    return period;
+};
+/**
+ * A span of days, both inclusive, split where the base rate changes: one piece per published
+ * period it touches, oldest first. Interest under § 288 BGB is computed per piece, since the rate
+ * of each half-year applies to the days in it.
+ */
+export const splitByBaseRate = (fromArg, toArg) => {
+    checkDate(fromArg);
+    checkDate(toArg);
+    if (toArg < fromArg) {
+        throw new BaseRateError('invalid_range', `${toArg} lies before ${fromArg}.`);
+    }
+    const spans = [];
+    let day = fromArg;
+    while (day <= toArg) {
+        const period = getBaseRate(day);
+        const to = period.validTo < toArg ? period.validTo : toArg;
+        spans.push({ from: day, to, ratePercent: period.ratePercent });
+        day = addDay(to);
+    }
+    return spans;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9iYXNlcmF0ZS9iYXNlcmF0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFDM0QsT0FBTyxFQUFFLGdCQUFnQixFQUFFLGVBQWUsRUFBRSxlQUFlLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUd4RixNQUFNLFFBQVEsR0FBRywyQkFBMkIsQ0FBQztBQUU3QyxNQUFNLFNBQVMsR0FBRyxDQUFDLE9BQWlCLEVBQVEsRUFBRTtJQUM1QyxNQUFNLEtBQUssR0FBRyxPQUFPLE9BQU8sS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztJQUMxRSxNQUFNLEdBQUcsR0FBRyxLQUFLLENBQUMsQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLEVBQUUsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO0lBQ3hHLElBQUksQ0FBQyxLQUFLLElBQUksQ0FBQyxHQUFHLElBQUksR0FBRyxDQUFDLFdBQVcsRUFBRSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLEtBQUssT0FBTyxFQUFFLENBQUM7UUFDakUsTUFBTSxJQUFJLGFBQWEsQ0FBQyxjQUFjLEVBQUUsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0lBQ25ILENBQUM7QUFDSCxDQUFDLENBQUM7QUFFRixNQUFNLE1BQU0sR0FBRyxDQUFDLE9BQWlCLEVBQVksRUFBRTtJQUM3QyxNQUFNLEdBQUcsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLE9BQU8sWUFBWSxDQUFDLENBQUM7SUFDN0MsR0FBRyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsVUFBVSxFQUFFLEdBQUcsQ0FBQyxDQUFDLENBQUM7SUFDckMsT0FBTyxHQUFHLENBQUMsV0FBVyxFQUFFLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztBQUN4QyxDQUFDLENBQUM7QUFFRiw4RUFBOEU7QUFDOUUsTUFBTSxDQUFDLE1BQU0sV0FBVyxHQUFHLENBQUMsT0FBaUIsRUFBbUIsRUFBRTtJQUNoRSxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbkIsSUFBSSxPQUFPLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQztRQUMvQixNQUFNLElBQUksYUFBYSxDQUFDLHFCQUFxQixFQUFFLEdBQUcsT0FBTyxnQkFBZ0IsZ0JBQWdCLDRDQUE0QyxDQUFDLENBQUM7SUFDekksQ0FBQztJQUNELE1BQU0sTUFBTSxHQUFHLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLFNBQVMsQ0FBQyxTQUFTLElBQUksT0FBTyxJQUFJLE9BQU8sSUFBSSxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbkgsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ1osTUFBTSxJQUFJLGFBQWEsQ0FDckIsZUFBZSxFQUNmLEdBQUcsT0FBTyxlQUFlLGVBQWUsQ0FBQyxlQUFlLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLE9BQU8saUZBQWlGLGVBQWUsR0FBRyxDQUNoTCxDQUFDO0lBQ0osQ0FBQztJQUNELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsQ0FBQyxPQUFpQixFQUFFLEtBQWUsRUFBbUIsRUFBRTtJQUNyRixTQUFTLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbkIsU0FBUyxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2pCLElBQUksS0FBSyxHQUFHLE9BQU8sRUFBRSxDQUFDO1FBQ3BCLE1BQU0sSUFBSSxhQUFhLENBQUMsZUFBZSxFQUFFLEdBQUcsS0FBSyxnQkFBZ0IsT0FBTyxHQUFHLENBQUMsQ0FBQztJQUMvRSxDQUFDO0lBQ0QsTUFBTSxLQUFLLEdBQW9CLEVBQUUsQ0FBQztJQUNsQyxJQUFJLEdBQUcsR0FBRyxPQUFPLENBQUM7SUFDbEIsT0FBTyxHQUFHLElBQUksS0FBSyxFQUFFLENBQUM7UUFDcEIsTUFBTSxNQUFNLEdBQUcsV0FBVyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ2hDLE1BQU0sRUFBRSxHQUFHLE1BQU0sQ0FBQyxPQUFPLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7UUFDM0QsS0FBSyxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsRUFBRSxFQUFFLFdBQVcsRUFBRSxNQUFNLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQztRQUMvRCxHQUFHLEdBQUcsTUFBTSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ25CLENBQUM7SUFDRCxPQUFPLEtBQUssQ0FBQztBQUNmLENBQUMsQ0FBQyJ9

package/dist_ts/baserate/classes.baserateerror.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Why a question to the base-rate table was refused:
+ * - `invalid_date`: the value is not a calendar date written `YYYY-MM-DD`;
+ * - `invalid_range`: a span ends before it begins;
+ * - `before_first_period`: the day lies before the first period the table holds (1 July 2002);
+ * - `not_published`: the day lies after the half-year of the last period the table holds, whose
+ *   rate the Bundesbank had not published when the table was read (`baseRatesReadOn`).
+ */
+export type TBaseRateErrorCode = 'invalid_date' | 'invalid_range' | 'before_first_period' | 'not_published';
+/** The typed error of the base-rate table. */
+export declare class BaseRateError extends Error {
+    readonly code: TBaseRateErrorCode;
+    constructor(code: TBaseRateErrorCode, message: string);
+}

package/dist_ts/baserate/classes.baserateerror.js

@@ -0,0 +1,10 @@
+/** The typed error of the base-rate table. */
+export class BaseRateError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.name = 'BaseRateError';
+        this.code = code;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5iYXNlcmF0ZWVycm9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYmFzZXJhdGUvY2xhc3Nlcy5iYXNlcmF0ZWVycm9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQVVBLDhDQUE4QztBQUM5QyxNQUFNLE9BQU8sYUFBYyxTQUFRLEtBQUs7SUFDdEIsSUFBSSxDQUFxQjtJQUV6QyxZQUFZLElBQXdCLEVBQUUsT0FBZTtRQUNuRCxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDZixJQUFJLENBQUMsSUFBSSxHQUFHLGVBQWUsQ0FBQztRQUM1QixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztJQUNuQixDQUFDO0NBQ0YifQ==

package/dist_ts/baserate/data.baserate.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The base rate (Basiszinssatz) of § 247 BGB, as the Deutsche Bundesbank publishes it: "Gemäß
+ * § 247 Abs. 2 BGB ist die Deutsche Bundesbank verpflichtet, den aktuellen Stand des
+ * Basiszinssatzes im Bundesanzeiger zu veröffentlichen." It changes on 1 January and 1 July
+ * (§ 247 Abs. 1 Satz 2 BGB). The table below is the Bundesbank's table "Basiszinssatz nach § 247
+ * BGB" (https://www.bundesbank.de/de/bundesbank/organisation/agb-und-regelungen/basiszinssatz-607820),
+ * read on 2026-09-27, unaltered: every row from 1 July 2002, the first one it lists, to the
+ * current one. A later half-year needs a new release.
+ */
+import type { IBaseRatePeriod } from './interfaces.js';
+/** the first day the table answers for */
+export declare const baseRateFirstDay = "2002-07-01";
+/** the day the Bundesbank's table was read; later half-years need a new release */
+export declare const baseRatesReadOn = "2026-09-27";
+/** the page the table was read from */
+export declare const baseRateSource = "https://www.bundesbank.de/de/bundesbank/organisation/agb-und-regelungen/basiszinssatz-607820";
+/** every published period, oldest first */
+export declare const baseRatePeriods: readonly IBaseRatePeriod[];

package/dist_ts/baserate/data.baserate.js

@@ -0,0 +1,63 @@
+/** the first day the table answers for */
+export const baseRateFirstDay = '2002-07-01';
+/** the day the Bundesbank's table was read; later half-years need a new release */
+export const baseRatesReadOn = '2026-09-27';
+/** the page the table was read from */
+export const baseRateSource = 'https://www.bundesbank.de/de/bundesbank/organisation/agb-und-regelungen/basiszinssatz-607820';
+const rows = [
+    // gültig ab, Basiszinssatz in Prozent, as the table of the Deutsche Bundesbank states them
+    ['2002-07-01', 2.47],
+    ['2003-01-01', 1.97],
+    ['2003-07-01', 1.22],
+    ['2004-01-01', 1.14],
+    ['2004-07-01', 1.13],
+    ['2005-01-01', 1.21],
+    ['2005-07-01', 1.17],
+    ['2006-01-01', 1.37],
+    ['2006-07-01', 1.95],
+    ['2007-01-01', 2.70],
+    ['2007-07-01', 3.19],
+    ['2008-01-01', 3.32],
+    ['2008-07-01', 3.19],
+    ['2009-01-01', 1.62],
+    ['2009-07-01', 0.12],
+    ['2010-01-01', 0.12],
+    ['2010-07-01', 0.12],
+    ['2011-01-01', 0.12],
+    ['2011-07-01', 0.37],
+    ['2012-01-01', 0.12],
+    ['2012-07-01', 0.12],
+    ['2013-01-01', -0.13],
+    ['2013-07-01', -0.38],
+    ['2014-01-01', -0.63],
+    ['2014-07-01', -0.73],
+    ['2015-01-01', -0.83],
+    ['2015-07-01', -0.83],
+    ['2016-01-01', -0.83],
+    ['2016-07-01', -0.88],
+    ['2017-01-01', -0.88],
+    ['2017-07-01', -0.88],
+    ['2018-01-01', -0.88],
+    ['2018-07-01', -0.88],
+    ['2019-01-01', -0.88],
+    ['2019-07-01', -0.88],
+    ['2020-01-01', -0.88],
+    ['2020-07-01', -0.88],
+    ['2021-01-01', -0.88],
+    ['2021-07-01', -0.88],
+    ['2022-01-01', -0.88],
+    ['2022-07-01', -0.88],
+    ['2023-01-01', 1.62],
+    ['2023-07-01', 3.12],
+    ['2024-01-01', 3.62],
+    ['2024-07-01', 3.37],
+    ['2025-01-01', 2.27],
+    ['2025-07-01', 1.27],
+    ['2026-01-01', 1.27],
+    ['2026-07-01', 1.52],
+];
+/** the last day of the half-year a period begins in */
+const halfYearEndOf = (validFromArg) => `${validFromArg.slice(0, 4)}-${validFromArg.slice(5, 7) === '01' ? '06-30' : '12-31'}`;
+/** every published period, oldest first */
+export const baseRatePeriods = Object.freeze(rows.map(([validFrom, ratePercent]) => Object.freeze({ validFrom, validTo: halfYearEndOf(validFrom), ratePercent })));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YS5iYXNlcmF0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2Jhc2VyYXRlL2RhdGEuYmFzZXJhdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBV0EsMENBQTBDO0FBQzFDLE1BQU0sQ0FBQyxNQUFNLGdCQUFnQixHQUFHLFlBQVksQ0FBQztBQUU3QyxtRkFBbUY7QUFDbkYsTUFBTSxDQUFDLE1BQU0sZUFBZSxHQUFHLFlBQVksQ0FBQztBQUU1Qyx1Q0FBdUM7QUFDdkMsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLDhGQUE4RixDQUFDO0FBRTdILE1BQU0sSUFBSSxHQUE2QztJQUNyRCwyRkFBMkY7SUFDM0YsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDckIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztJQUNwQixDQUFDLFlBQVksRUFBRSxJQUFJLENBQUM7SUFDcEIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDO0lBQ3BCLENBQUMsWUFBWSxFQUFFLElBQUksQ0FBQztDQUNyQixDQUFDO0FBRUYsdURBQXVEO0FBQ3ZELE1BQU0sYUFBYSxHQUFHLENBQUMsWUFBb0IsRUFBVSxFQUFFLENBQ3JELEdBQUcsWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLElBQUksWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE9BQU8sRUFBRSxDQUFDO0FBRXpGLDJDQUEyQztBQUMzQyxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQStCLE1BQU0sQ0FBQyxNQUFNLENBQ3RFLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLFNBQVMsRUFBRSxXQUFXLENBQUMsRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxFQUFFLFNBQVMsRUFBRSxPQUFPLEVBQUUsYUFBYSxDQUFDLFNBQVMsQ0FBQyxFQUFFLFdBQVcsRUFBRSxDQUFDLENBQUMsQ0FDckgsQ0FBQyJ9

package/dist_ts/baserate/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interfaces.js';
+export { BaseRateError, type TBaseRateErrorCode } from './classes.baserateerror.js';
+export { baseRateFirstDay, baseRatePeriods, baseRateSource, baseRatesReadOn } from './data.baserate.js';
+export { getBaseRate, splitByBaseRate } from './baserate.js';

package/dist_ts/baserate/index.js

@@ -0,0 +1,7 @@
+// This entry point stands alone: it imports nothing from the rest of the package, has no
+// dependencies and needs no storage or network.
+export * from './interfaces.js';
+export { BaseRateError } from './classes.baserateerror.js';
+export { baseRateFirstDay, baseRatePeriods, baseRateSource, baseRatesReadOn } from './data.baserate.js';
+export { getBaseRate, splitByBaseRate } from './baserate.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9iYXNlcmF0ZS9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSx5RkFBeUY7QUFDekYsZ0RBQWdEO0FBQ2hELGNBQWMsaUJBQWlCLENBQUM7QUFDaEMsT0FBTyxFQUFFLGFBQWEsRUFBMkIsTUFBTSw0QkFBNEIsQ0FBQztBQUNwRixPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsZUFBZSxFQUFFLGNBQWMsRUFBRSxlQUFlLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUN4RyxPQUFPLEVBQUUsV0FBVyxFQUFFLGVBQWUsRUFBRSxNQUFNLGVBQWUsQ0FBQyJ9

package/dist_ts/baserate/interfaces.d.ts

@@ -0,0 +1,19 @@
+/** A plain calendar date, `YYYY-MM-DD`. */
+export type TIsoDate = string;
+/**
+ * One half-year's base rate (Basiszinssatz, § 247 BGB) as the Deutsche
+ * Bundesbank publishes it: valid from 1 January or 1 July to the last day of
+ * that half-year, both inclusive.
+ */
+export interface IBaseRatePeriod {
+    validFrom: TIsoDate;
+    validTo: TIsoDate;
+    /** percent a year; it can be negative (2013 to 2022) */
+    ratePercent: number;
+}
+/** A span of days within one base-rate period, both days inclusive. */
+export interface IBaseRateSpan {
+    from: TIsoDate;
+    to: TIsoDate;
+    ratePercent: number;
+}

package/dist_ts/baserate/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2Jhc2VyYXRlL2ludGVyZmFjZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist_ts/vatid/classes.evatrclient.d.ts

@@ -0,0 +1,15 @@
+import type { IEvatrConfirmation, IEvatrConfirmationInput, IVatIdClientOptions, IVatIdTraderData } from './interfaces.js';
+/**
+ * The BZSt's confirmation of foreign VAT IDs (§ 18e Nr. 1 UStG) over its eVatR REST API
+ * (`https://api.evatr.vies.bzst.de/api-docs`). A simple confirmation says whether a VAT ID is valid
+ * when asked; a qualified one also compares the business's name, city, and where given street and
+ * postal code with what its member state registered. The BZSt confirms to a business with a German
+ * VAT ID of its own, which every request names. Nothing is kept: each answer goes to the caller.
+ */
+export declare class EvatrClient {
+    private readonly options;
+    constructor(options?: IVatIdClientOptions);
+    confirm(inputArg: IEvatrConfirmationInput): Promise<IEvatrConfirmation>;
+}
+/** The business data as a qualified confirmation sends it: trimmed, with the name and the city required. */
+export declare const traderOf: (traderArg: IVatIdTraderData) => IVatIdTraderData | undefined;

package/dist_ts/vatid/classes.evatrclient.js

@@ -0,0 +1,169 @@
+import { VatIdError } from './classes.vatiderror.js';
+import { evatrBaseUrl, evatrConfirmationPath, evatrStatusCodes } from './constants.js';
+import { postJson, textField } from './request.js';
+import { splitVatId } from './vatid.js';
+/** The status codes that are an answer about the VAT ID asked about, and whether they say it is valid. */
+const ANSWERS = {
+    'evatr-0000': true,
+    'evatr-2008': true,
+    'evatr-2001': false,
+    'evatr-2002': false,
+    'evatr-2006': false,
+};
+/** What every other status code means for the caller (`VatIdError`). */
+const REFUSALS = {
+    'evatr-0001': 'invalid_input',
+    'evatr-0002': 'invalid_input',
+    'evatr-0003': 'invalid_input',
+    'evatr-0004': 'requester_invalid',
+    'evatr-0005': 'vat_id_malformed',
+    'evatr-0006': 'not_permitted',
+    'evatr-0007': 'invalid_input',
+    'evatr-0008': 'qualified_limit_reached',
+    'evatr-0011': 'unavailable',
+    'evatr-0012': 'vat_id_malformed',
+    'evatr-0013': 'unavailable',
+    'evatr-1001': 'unavailable',
+    'evatr-1002': 'unavailable',
+    'evatr-1003': 'unavailable',
+    'evatr-1004': 'unavailable',
+    'evatr-2003': 'vat_id_malformed',
+    'evatr-2004': 'unavailable',
+    'evatr-2005': 'requester_invalid',
+    'evatr-2007': 'member_state_unavailable',
+    'evatr-2011': 'unavailable',
+    'evatr-3011': 'unavailable',
+};
+const FIELD_RESULTS = ['A', 'B', 'C', 'D'];
+const fieldResult = (bodyArg, keyArg) => {
+    const value = textField(bodyArg, keyArg);
+    return value !== undefined && FIELD_RESULTS.includes(value) ? value : undefined;
+};
+/**
+ * The BZSt's confirmation of foreign VAT IDs (§ 18e Nr. 1 UStG) over its eVatR REST API
+ * (`https://api.evatr.vies.bzst.de/api-docs`). A simple confirmation says whether a VAT ID is valid
+ * when asked; a qualified one also compares the business's name, city, and where given street and
+ * postal code with what its member state registered. The BZSt confirms to a business with a German
+ * VAT ID of its own, which every request names. Nothing is kept: each answer goes to the caller.
+ */
+export class EvatrClient {
+    options;
+    constructor(options = {}) {
+        this.options = options;
+    }
+    async confirm(inputArg) {
+        const requester = splitVatId(inputArg.requesterVatId);
+        if (!requester || requester.countryCode !== 'DE') {
+            throw new VatIdError('invalid_input', 'the requester is named by its German VAT ID', { service: 'bzst-evatr', field: 'requesterVatId' });
+        }
+        const asked = splitVatId(inputArg.vatId);
+        if (!asked) {
+            throw new VatIdError('invalid_input', 'the VAT ID asked about starts with no member state\'s code', { service: 'bzst-evatr', field: 'vatId' });
+        }
+        const trader = inputArg.trader ? traderOf(inputArg.trader) : undefined;
+        if (inputArg.trader && !trader) {
+            throw new VatIdError('invalid_input', 'a qualified confirmation needs the name and the city', { service: 'bzst-evatr', field: 'trader' });
+        }
+        const answer = await postJson(this.options, 'bzst-evatr', `${this.options.baseUrl ?? evatrBaseUrl}${evatrConfirmationPath}`, {
+            anfragendeUstid: requester.vatId,
+            angefragteUstid: asked.vatId,
+            ...(trader
+                ? {
+                    firmenname: trader.name,
+                    ort: trader.city,
+                    ...(trader.street ? { strasse: trader.street } : {}),
+                    ...(trader.postalCode ? { plz: trader.postalCode } : {}),
+                }
+                : {}),
+        }, inputArg.signal);
+        const status = textField(answer.body, 'status');
+        if (!status || !evatrStatusCodes.includes(status)) {
+            throw new VatIdError('unexpected_answer', `the BZSt answered HTTP ${answer.httpStatus} without a status it documents`, {
+                service: 'bzst-evatr',
+                httpStatus: answer.httpStatus,
+                ...(status ? { serviceCode: status } : {}),
+                answer: answer.answer,
+            });
+        }
+        const code = status;
+        const valid = ANSWERS[code];
+        if (valid === undefined) {
+            throw new VatIdError(REFUSALS[code] ?? 'unexpected_answer', `the BZSt answered ${code}`, {
+                service: 'bzst-evatr',
+                serviceCode: code,
+                httpStatus: answer.httpStatus,
+                answer: answer.answer,
+            });
+        }
+        const requestedAt = textField(answer.body, 'anfrageZeitpunkt');
+        const requestedAtMs = requestedAt ? Date.parse(requestedAt) : Number.NaN;
+        if (!requestedAt || Number.isNaN(requestedAtMs)) {
+            throw new VatIdError('unexpected_answer', 'the BZSt answered without the moment of the request', {
+                service: 'bzst-evatr',
+                serviceCode: code,
+                httpStatus: answer.httpStatus,
+                answer: answer.answer,
+            });
+        }
+        const requestId = textField(answer.body, 'id');
+        const validFrom = textField(answer.body, 'gueltigAb');
+        const validTo = textField(answer.body, 'gueltigBis');
+        const qualified = trader && valid ? qualifiedResultOf(trader, code, answer.body) : undefined;
+        if (qualified === null) {
+            // a qualified request answered valid without a result for each field sent would read as a simple
+            // confirmation; it is refused instead of being passed on as one
+            throw new VatIdError('unexpected_answer', `the BZSt answered ${code} to a qualified request without a documented result for each field sent`, {
+                service: 'bzst-evatr',
+                serviceCode: code,
+                httpStatus: answer.httpStatus,
+                answer: answer.answer,
+            });
+        }
+        return {
+            service: 'bzst-evatr',
+            ...(requestId ? { requestId } : {}),
+            requestedAt,
+            requestedAtMs,
+            status: code,
+            valid,
+            ...(validFrom ? { validFrom } : {}),
+            ...(validTo ? { validTo } : {}),
+            requesterVatId: requester.vatId,
+            vatId: asked.vatId,
+            ...(qualified ? { qualified } : {}),
+            answer: answer.answer,
+        };
+    }
+}
+/**
+ * The comparison of a qualified request whose VAT ID is valid: `evatr-2008` says it has a
+ * particularity and gives no result (`answered: false`); otherwise every field sent has a documented
+ * result (`A`…`D`), or the answer is not one this client reads (`null`). A result the BZSt gives for a
+ * field not sent is kept as it is.
+ */
+const qualifiedResultOf = (traderArg, codeArg, bodyArg) => {
+    if (codeArg === 'evatr-2008') {
+        return { asked: traderArg, answered: false };
+    }
+    const name = fieldResult(bodyArg, 'ergFirmenname');
+    const city = fieldResult(bodyArg, 'ergOrt');
+    // a field not sent may still carry its result (`C`, not asked); one sent must
+    const street = fieldResult(bodyArg, 'ergStrasse');
+    const postalCode = fieldResult(bodyArg, 'ergPlz');
+    if (!name || !city || (traderArg.street && !street) || (traderArg.postalCode && !postalCode)) {
+        return null;
+    }
+    return { asked: traderArg, answered: true, name, city, ...(street ? { street } : {}), ...(postalCode ? { postalCode } : {}) };
+};
+/** The business data as a qualified confirmation sends it: trimmed, with the name and the city required. */
+export const traderOf = (traderArg) => {
+    const name = traderArg.name.trim();
+    const city = traderArg.city.trim();
+    if (!name || !city) {
+        return undefined;
+    }
+    const street = traderArg.street?.trim();
+    const postalCode = traderArg.postalCode?.trim();
+    return { name, city, ...(street ? { street } : {}), ...(postalCode ? { postalCode } : {}) };
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"classes.evatrclient.js","sourceRoot":"","sources":["../../ts/vatid/classes.evatrclient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAwB,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAUvF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,0GAA0G;AAC1G,MAAM,OAAO,GAAyD;IACpE,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,KAAK;CACpB,CAAC;AAEF,wEAAwE;AACxE,MAAM,QAAQ,GAAiE;IAC7E,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,mBAAmB;IACjC,YAAY,EAAE,kBAAkB;IAChC,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,yBAAyB;IACvC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,kBAAkB;IAChC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,kBAAkB;IAChC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,mBAAmB;IACjC,YAAY,EAAE,0BAA0B;IACxC,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;CAC5B,CAAC;AAEF,MAAM,aAAa,GAAiC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEzE,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAE,MAAc,EAAiC,EAAE;IACtF,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzC,OAAO,KAAK,KAAK,SAAS,IAAK,aAAmC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAA2B,CAAC,CAAC,CAAC,SAAS,CAAC;AAChI,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,OAAO,WAAW;IACO;IAA7B,YAA6B,UAA+B,EAAE;QAAjC,YAAO,GAAP,OAAO,CAA0B;IAAG,CAAC;IAE3D,KAAK,CAAC,OAAO,CAAC,QAAiC;QACpD,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YACjD,MAAM,IAAI,UAAU,CAAC,eAAe,EAAE,6CAA6C,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC3I,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,UAAU,CAAC,eAAe,EAAE,4DAA4D,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QACjJ,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,IAAI,UAAU,CAAC,eAAe,EAAE,sDAAsD,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5I,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,YAAY,GAAG,qBAAqB,EAAE,EAAE;YAC3H,eAAe,EAAE,SAAS,CAAC,KAAK;YAChC,eAAe,EAAE,KAAK,CAAC,KAAK;YAC5B,GAAG,CAAC,MAAM;gBACR,CAAC,CAAC;oBACA,UAAU,EAAE,MAAM,CAAC,IAAI;oBACvB,GAAG,EAAE,MAAM,CAAC,IAAI;oBAChB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACpD,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACzD;gBACD,CAAC,CAAC,EAAE,CAAC;SACR,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,IAAI,CAAE,gBAAsC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,0BAA0B,MAAM,CAAC,UAAU,gCAAgC,EAAE;gBACrH,OAAO,EAAE,YAAY;gBACrB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1C,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,MAA0B,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,mBAAmB,EAAE,qBAAqB,IAAI,EAAE,EAAE;gBACvF,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QAC/D,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QACzE,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,qDAAqD,EAAE;gBAC/F,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACrD,MAAM,SAAS,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7F,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,iGAAiG;YACjG,gEAAgE;YAChE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,qBAAqB,IAAI,yEAAyE,EAAE;gBAC5I,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QACD,OAAO;YACL,OAAO,EAAE,YAAY;YACrB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,WAAW;YACX,aAAa;YACb,MAAM,EAAE,IAAoC;YAC5C,KAAK;YACL,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,cAAc,EAAE,SAAS,CAAC,KAAK;YAC/B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAAC,SAA2B,EAAE,OAAyB,EAAE,OAAgB,EAAgC,EAAE;IACnI,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;QAC7B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5C,8EAA8E;IAC9E,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAChI,CAAC,CAAC;AAEF,4GAA4G;AAC5G,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAA2B,EAAgC,EAAE;IACpF,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACnC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;IACxC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;IAChD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAC9F,CAAC,CAAC"}

package/dist_ts/vatid/classes.vatiderror.d.ts

@@ -0,0 +1,51 @@
+import type { IVatIdServiceAnswer } from './interfaces.js';
+/**
+ * Why a VAT ID could not be confirmed. Every code means that the service gave no answer about the
+ * validity of the VAT ID asked about:
+ * - `invalid_input`: what was asked is incomplete or not a VAT ID of a member state (checked before
+ *   sending, or refused by the service: eVatR `evatr-0002`, `evatr-0003`, `evatr-0007`, VIES
+ *   `INVALID_INPUT`);
+ * - `vat_id_malformed`: the service says the VAT ID asked about does not have the form its member
+ *   state gives (eVatR `evatr-0005`, `evatr-0012`, `evatr-2003`);
+ * - `requester_invalid`: the requester's own VAT ID is malformed or not valid (eVatR `evatr-0004`,
+ *   `evatr-2005`, VIES `INVALID_REQUESTER_INFO`);
+ * - `not_permitted`: a German VAT ID asked about by a German one (eVatR `evatr-0006`);
+ * - `qualified_limit_reached`: the qualified confirmations of this session are used up (eVatR
+ *   `evatr-0008`); a simple one is still possible;
+ * - `unavailable`: the service cannot answer now (eVatR `evatr-0011`, `-0013`, `-1001`…`-1004`,
+ *   `-2004`, `-2011`, `-3011`; VIES `SERVICE_UNAVAILABLE`);
+ * - `member_state_unavailable`: the member state's system did not answer or failed (eVatR
+ *   `evatr-2007`; VIES `MS_UNAVAILABLE`, `TIMEOUT`);
+ * - `busy`: too many requests at once (VIES `GLOBAL_MAX_CONCURRENT_REQ`, `MS_MAX_CONCURRENT_REQ`
+ *   and their `_TIME` forms);
+ * - `blocked`: the service blocks this address or this VAT ID (VIES `IP_BLOCKED`, `VAT_BLOCKED`);
+ * - `unreachable`: no answer arrived — the name, the connection or TLS failed;
+ * - `timeout`: the answer did not arrive within the client's time;
+ * - `aborted`: the caller's signal ended the request;
+ * - `unexpected_answer`: an answer this client cannot read, or a status it does not know.
+ */
+export type TVatIdErrorCode = 'invalid_input' | 'vat_id_malformed' | 'requester_invalid' | 'not_permitted' | 'qualified_limit_reached' | 'unavailable' | 'member_state_unavailable' | 'busy' | 'blocked' | 'unreachable' | 'timeout' | 'aborted' | 'unexpected_answer';
+export interface IVatIdErrorDetails {
+    service: 'bzst-evatr' | 'vies';
+    /** the service's own code: `evatr-0008`, `MS_UNAVAILABLE` */
+    serviceCode?: string;
+    /** the HTTP status of the answer, where one arrived */
+    httpStatus?: number;
+    /** which input a local check refused */
+    field?: 'requesterVatId' | 'vatId' | 'trader';
+    /** the answer as it arrived, where one did */
+    answer?: IVatIdServiceAnswer;
+}
+/** The typed error of the VAT ID clients. */
+export declare class VatIdError extends Error {
+    readonly code: TVatIdErrorCode;
+    readonly service: IVatIdErrorDetails['service'];
+    readonly serviceCode?: string;
+    readonly httpStatus?: number;
+    readonly field?: IVatIdErrorDetails['field'];
+    /** the answer as it arrived, where one did: a refusal, or an answer this client cannot read */
+    readonly answer?: IVatIdServiceAnswer;
+    constructor(code: TVatIdErrorCode, message: string, detailsArg: IVatIdErrorDetails, options?: {
+        cause?: unknown;
+    });
+}

package/dist_ts/vatid/classes.vatiderror.js

@@ -0,0 +1,29 @@
+/** The typed error of the VAT ID clients. */
+export class VatIdError extends Error {
+    code;
+    service;
+    serviceCode;
+    httpStatus;
+    field;
+    /** the answer as it arrived, where one did: a refusal, or an answer this client cannot read */
+    answer;
+    constructor(code, message, detailsArg, options) {
+        super(message, options);
+        this.name = 'VatIdError';
+        this.code = code;
+        this.service = detailsArg.service;
+        if (detailsArg.serviceCode !== undefined) {
+            this.serviceCode = detailsArg.serviceCode;
+        }
+        if (detailsArg.httpStatus !== undefined) {
+            this.httpStatus = detailsArg.httpStatus;
+        }
+        if (detailsArg.field !== undefined) {
+            this.field = detailsArg.field;
+        }
+        if (detailsArg.answer !== undefined) {
+            this.answer = detailsArg.answer;
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy52YXRpZGVycm9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvdmF0aWQvY2xhc3Nlcy52YXRpZGVycm9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQXNEQSw2Q0FBNkM7QUFDN0MsTUFBTSxPQUFPLFVBQVcsU0FBUSxLQUFLO0lBQ25CLElBQUksQ0FBa0I7SUFDdEIsT0FBTyxDQUFnQztJQUN2QyxXQUFXLENBQVU7SUFDckIsVUFBVSxDQUFVO0lBQ3BCLEtBQUssQ0FBK0I7SUFDcEQsK0ZBQStGO0lBQy9FLE1BQU0sQ0FBdUI7SUFFN0MsWUFBWSxJQUFxQixFQUFFLE9BQWUsRUFBRSxVQUE4QixFQUFFLE9BQTZCO1FBQy9HLEtBQUssQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDeEIsSUFBSSxDQUFDLElBQUksR0FBRyxZQUFZLENBQUM7UUFDekIsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7UUFDakIsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFDO1FBQ2xDLElBQUksVUFBVSxDQUFDLFdBQVcsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUN6QyxJQUFJLENBQUMsV0FBVyxHQUFHLFVBQVUsQ0FBQyxXQUFXLENBQUM7UUFDNUMsQ0FBQztRQUNELElBQUksVUFBVSxDQUFDLFVBQVUsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUN4QyxJQUFJLENBQUMsVUFBVSxHQUFHLFVBQVUsQ0FBQyxVQUFVLENBQUM7UUFDMUMsQ0FBQztRQUNELElBQUksVUFBVSxDQUFDLEtBQUssS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUNuQyxJQUFJLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUM7UUFDaEMsQ0FBQztRQUNELElBQUksVUFBVSxDQUFDLE1BQU0sS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUNwQyxJQUFJLENBQUMsTUFBTSxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7UUFDbEMsQ0FBQztJQUNILENBQUM7Q0FDRiJ9

package/dist_ts/vatid/classes.viesclient.d.ts

@@ -0,0 +1,12 @@
+import type { IViesCheck, IViesCheckInput, IVatIdClientOptions } from './interfaces.js';
+/**
+ * The European Commission's VIES over its REST API ("Vies on-the-Web", `swagger_publicVAT.yaml`):
+ * whether a VAT ID is valid, and with the business data a comparison of each field. A request that
+ * names the requester's own VAT ID gets VIES's request identifier. Errors arrive with HTTP 200 and
+ * `actionSucceed: false`; they are thrown as `VatIdError`. Nothing is kept.
+ */
+export declare class ViesClient {
+    private readonly options;
+    constructor(options?: IVatIdClientOptions);
+    check(inputArg: IViesCheckInput): Promise<IViesCheck>;
+}