@fin.cx/opendata 3.6.0 → 4.1.0

package/dist_ts/handelsregister/forms.d.ts

@@ -0,0 +1,27 @@
+import * as html from './html.js';
+/** an option of a select element */
+export interface IFormOption {
+    value: string;
+    label: string;
+}
+/** a form as a browser would submit it */
+export interface IPortalForm {
+    id: string;
+    /** the action as the page states it, relative to the page */
+    action: string;
+    /** the successful controls with their current values, in document order */
+    fields: Array<[string, string]>;
+    /** the options of each select element, by name */
+    options: Map<string, IFormOption[]>;
+    /** the names of every control, including unchecked boxes and buttons */
+    controlNames: Set<string>;
+}
+/**
+ * Reads a form the way a browser collects it for submission: text and hidden inputs with their
+ * values, checked boxes and radios, textareas, and the selected (or first) option of each select.
+ */
+export declare const readForm: (documentArg: html.THtmlDocument, formIdArg: string) => IPortalForm | undefined;
+/** sets a field to one value, replacing every earlier value of that name */
+export declare const setField: (fieldsArg: Array<[string, string]>, nameArg: string, valueArg: string) => void;
+/** removes every value of a field */
+export declare const removeField: (fieldsArg: Array<[string, string]>, nameArg: string) => void;

package/dist_ts/handelsregister/forms.js

@@ -0,0 +1,77 @@
+import * as html from './html.js';
+const skippedInputTypes = new Set(['submit', 'button', 'image', 'reset', 'file']);
+/**
+ * Reads a form the way a browser collects it for submission: text and hidden inputs with their
+ * values, checked boxes and radios, textareas, and the selected (or first) option of each select.
+ */
+export const readForm = (documentArg, formIdArg) => {
+    const form = html.findById(documentArg, formIdArg);
+    if (!form || form.tagName !== 'form') {
+        return undefined;
+    }
+    const action = html.getAttribute(form, 'action');
+    if (!action) {
+        return undefined;
+    }
+    const fields = [];
+    const options = new Map();
+    const controlNames = new Set();
+    for (const element of html.descendants(form)) {
+        const name = html.getAttribute(element, 'name');
+        if (!name) {
+            continue;
+        }
+        if (element.tagName === 'input') {
+            controlNames.add(name);
+            const type = (html.getAttribute(element, 'type') ?? 'text').toLowerCase();
+            if (skippedInputTypes.has(type)) {
+                continue;
+            }
+            if (type === 'checkbox' || type === 'radio') {
+                if (html.getAttribute(element, 'checked') !== undefined) {
+                    fields.push([name, html.getAttribute(element, 'value') ?? 'on']);
+                }
+                continue;
+            }
+            fields.push([name, html.getAttribute(element, 'value') ?? '']);
+        }
+        else if (element.tagName === 'textarea') {
+            controlNames.add(name);
+            fields.push([name, element.childNodes.map((childArg) => ('value' in childArg ? childArg.value : '')).join('')]);
+        }
+        else if (element.tagName === 'select') {
+            controlNames.add(name);
+            const selectOptions = html
+                .findAll(element, (optionArg) => optionArg.tagName === 'option')
+                .map((optionArg) => ({
+                value: html.getAttribute(optionArg, 'value') ?? html.textOf(optionArg),
+                label: html.textOf(optionArg),
+                selected: html.getAttribute(optionArg, 'selected') !== undefined,
+            }));
+            options.set(name, selectOptions.map((optionArg) => ({ value: optionArg.value, label: optionArg.label })));
+            const chosen = selectOptions.find((optionArg) => optionArg.selected) ?? selectOptions[0];
+            if (chosen) {
+                fields.push([name, chosen.value]);
+            }
+        }
+        else if (element.tagName === 'button') {
+            controlNames.add(name);
+        }
+    }
+    return { id: formIdArg, action, fields, options, controlNames };
+};
+/** sets a field to one value, replacing every earlier value of that name */
+export const setField = (fieldsArg, nameArg, valueArg) => {
+    const index = fieldsArg.findIndex(([fieldName]) => fieldName === nameArg);
+    const remaining = fieldsArg.filter(([fieldName]) => fieldName !== nameArg);
+    fieldsArg.length = 0;
+    fieldsArg.push(...remaining);
+    fieldsArg.splice(index >= 0 ? index : fieldsArg.length, 0, [nameArg, valueArg]);
+};
+/** removes every value of a field */
+export const removeField = (fieldsArg, nameArg) => {
+    const remaining = fieldsArg.filter(([fieldName]) => fieldName !== nameArg);
+    fieldsArg.length = 0;
+    fieldsArg.push(...remaining);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9oYW5kZWxzcmVnaXN0ZXIvZm9ybXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLElBQUksTUFBTSxXQUFXLENBQUM7QUFxQmxDLE1BQU0saUJBQWlCLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxRQUFRLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQztBQUVsRjs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxRQUFRLEdBQUcsQ0FBQyxXQUErQixFQUFFLFNBQWlCLEVBQTJCLEVBQUU7SUFDdEcsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLEVBQUUsU0FBUyxDQUFDLENBQUM7SUFDbkQsSUFBSSxDQUFDLElBQUksSUFBSSxJQUFJLENBQUMsT0FBTyxLQUFLLE1BQU0sRUFBRSxDQUFDO1FBQ3JDLE9BQU8sU0FBUyxDQUFDO0lBQ25CLENBQUM7SUFDRCxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksRUFBRSxRQUFRLENBQUMsQ0FBQztJQUNqRCxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDWixPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBQ0QsTUFBTSxNQUFNLEdBQTRCLEVBQUUsQ0FBQztJQUMzQyxNQUFNLE9BQU8sR0FBRyxJQUFJLEdBQUcsRUFBeUIsQ0FBQztJQUNqRCxNQUFNLFlBQVksR0FBRyxJQUFJLEdBQUcsRUFBVSxDQUFDO0lBQ3ZDLEtBQUssTUFBTSxPQUFPLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQzdDLE1BQU0sSUFBSSxHQUFHLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQ2hELElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUNWLFNBQVM7UUFDWCxDQUFDO1FBQ0QsSUFBSSxPQUFPLENBQUMsT0FBTyxLQUFLLE9BQU8sRUFBRSxDQUFDO1lBQ2hDLFlBQVksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDdkIsTUFBTSxJQUFJLEdBQUcsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsSUFBSSxNQUFNLENBQUMsQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUMxRSxJQUFJLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO2dCQUNoQyxTQUFTO1lBQ1gsQ0FBQztZQUNELElBQUksSUFBSSxLQUFLLFVBQVUsSUFBSSxJQUFJLEtBQUssT0FBTyxFQUFFLENBQUM7Z0JBQzVDLElBQUksSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsU0FBUyxDQUFDLEtBQUssU0FBUyxFQUFFLENBQUM7b0JBQ3hELE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQztnQkFDbkUsQ0FBQztnQkFDRCxTQUFTO1lBQ1gsQ0FBQztZQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztRQUNqRSxDQUFDO2FBQU0sSUFBSSxPQUFPLENBQUMsT0FBTyxLQUFLLFVBQVUsRUFBRSxDQUFDO1lBQzFDLFlBQVksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDdkIsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksRUFBRSxPQUFPLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLElBQUksUUFBUSxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbEgsQ0FBQzthQUFNLElBQUksT0FBTyxDQUFDLE9BQU8sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUN4QyxZQUFZLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ3ZCLE1BQU0sYUFBYSxHQUFHLElBQUk7aUJBQ3ZCLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLFNBQVMsQ0FBQyxPQUFPLEtBQUssUUFBUSxDQUFDO2lCQUMvRCxHQUFHLENBQUMsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUM7Z0JBQ25CLEtBQUssRUFBRSxJQUFJLENBQUMsWUFBWSxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQztnQkFDdEUsS0FBSyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDO2dCQUM3QixRQUFRLEVBQUUsSUFBSSxDQUFDLFlBQVksQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLEtBQUssU0FBUzthQUNqRSxDQUFDLENBQUMsQ0FBQztZQUNOLE9BQU8sQ0FBQyxHQUFHLENBQ1QsSUFBSSxFQUNKLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsU0FBUyxDQUFDLEtBQUssRUFBRSxLQUFLLEVBQUUsU0FBUyxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUMsQ0FDdkYsQ0FBQztZQUNGLE1BQU0sTUFBTSxHQUFHLGFBQWEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsSUFBSSxhQUFhLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDekYsSUFBSSxNQUFNLEVBQUUsQ0FBQztnQkFDWCxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO1lBQ3BDLENBQUM7UUFDSCxDQUFDO2FBQU0sSUFBSSxPQUFPLENBQUMsT0FBTyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3hDLFlBQVksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDekIsQ0FBQztJQUNILENBQUM7SUFDRCxPQUFPLEVBQUUsRUFBRSxFQUFFLFNBQVMsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxZQUFZLEVBQUUsQ0FBQztBQUNsRSxDQUFDLENBQUM7QUFFRiw0RUFBNEU7QUFDNUUsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUFHLENBQUMsU0FBa0MsRUFBRSxPQUFlLEVBQUUsUUFBZ0IsRUFBUSxFQUFFO0lBQ3RHLE1BQU0sS0FBSyxHQUFHLFNBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxTQUFTLEtBQUssT0FBTyxDQUFDLENBQUM7SUFDMUUsTUFBTSxTQUFTLEdBQUcsU0FBUyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLEVBQUUsRUFBRSxDQUFDLFNBQVMsS0FBSyxPQUFPLENBQUMsQ0FBQztJQUMzRSxTQUFTLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztJQUNyQixTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsU0FBUyxDQUFDLENBQUM7SUFDN0IsU0FBUyxDQUFDLE1BQU0sQ0FBQyxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLFFBQVEsQ0FBQyxDQUFDLENBQUM7QUFDbEYsQ0FBQyxDQUFDO0FBRUYscUNBQXFDO0FBQ3JDLE1BQU0sQ0FBQyxNQUFNLFdBQVcsR0FBRyxDQUFDLFNBQWtDLEVBQUUsT0FBZSxFQUFRLEVBQUU7SUFDdkYsTUFBTSxTQUFTLEdBQUcsU0FBUyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLEVBQUUsRUFBRSxDQUFDLFNBQVMsS0FBSyxPQUFPLENBQUMsQ0FBQztJQUMzRSxTQUFTLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztJQUNyQixTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsU0FBUyxDQUFDLENBQUM7QUFDL0IsQ0FBQyxDQUFDIn0=

package/dist_ts/handelsregister/html.d.ts

@@ -0,0 +1,26 @@
+import * as plugins from './plugins.js';
+export type THtmlDocument = plugins.parse5.DefaultTreeAdapterTypes.Document;
+export type THtmlElement = plugins.parse5.DefaultTreeAdapterTypes.Element;
+type THtmlParentNode = plugins.parse5.DefaultTreeAdapterTypes.ParentNode;
+type THtmlChildNode = plugins.parse5.DefaultTreeAdapterTypes.ChildNode;
+export declare const parseHtml: (htmlArg: string) => THtmlDocument;
+/** the element children of a node */
+export declare const elementChildren: (nodeArg: THtmlParentNode) => THtmlElement[];
+/** every element below a node, in document order */
+export declare const descendants: (nodeArg: THtmlParentNode) => THtmlElement[];
+export declare const getAttribute: (elementArg: THtmlElement, nameArg: string) => string | undefined;
+export declare const hasClass: (elementArg: THtmlElement, classArg: string) => boolean;
+export declare const findById: (nodeArg: THtmlParentNode, idArg: string) => THtmlElement | undefined;
+export declare const findAll: (nodeArg: THtmlParentNode, predicateArg: (elementArg: THtmlElement) => boolean) => THtmlElement[];
+export declare const findFirst: (nodeArg: THtmlParentNode, predicateArg: (elementArg: THtmlElement) => boolean) => THtmlElement | undefined;
+/** the text of a node with white space collapsed */
+export declare const textOf: (nodeArg: THtmlChildNode | THtmlParentNode) => string;
+/** the text of the text nodes directly inside an element */
+export declare const ownTextOf: (elementArg: THtmlElement) => string;
+/** the next element sibling */
+export declare const nextElementSibling: (elementArg: THtmlElement) => THtmlElement | undefined;
+/** the previous element sibling */
+export declare const previousElementSibling: (elementArg: THtmlElement) => THtmlElement | undefined;
+/** the language the document declares on its root element */
+export declare const documentLanguage: (documentArg: THtmlDocument) => string | undefined;
+export {};

package/dist_ts/handelsregister/html.js

@@ -0,0 +1,82 @@
+import * as plugins from './plugins.js';
+export const parseHtml = (htmlArg) => plugins.parse5.parse(htmlArg);
+const isElement = (nodeArg) => 'tagName' in nodeArg;
+/** the element children of a node */
+export const elementChildren = (nodeArg) => nodeArg.childNodes.filter(isElement);
+/** every element below a node, in document order */
+export const descendants = (nodeArg) => {
+    const result = [];
+    const stack = elementChildren(nodeArg).reverse();
+    while (stack.length > 0) {
+        const element = stack.pop();
+        result.push(element);
+        const children = element.tagName === 'template' ? [] : elementChildren(element);
+        for (let index = children.length - 1; index >= 0; index--) {
+            stack.push(children[index]);
+        }
+    }
+    return result;
+};
+export const getAttribute = (elementArg, nameArg) => elementArg.attrs.find((attrArg) => attrArg.name === nameArg)?.value;
+export const hasClass = (elementArg, classArg) => (getAttribute(elementArg, 'class') ?? '').split(/\s+/).includes(classArg);
+export const findById = (nodeArg, idArg) => descendants(nodeArg).find((elementArg) => getAttribute(elementArg, 'id') === idArg);
+export const findAll = (nodeArg, predicateArg) => descendants(nodeArg).filter(predicateArg);
+export const findFirst = (nodeArg, predicateArg) => descendants(nodeArg).find(predicateArg);
+/**
+ * the raw text of a node and everything below it, scripts and styles left out: the text nodes in
+ * document order, separated by spaces. Walks the tree with its own stack, so no nesting depth a page
+ * can have exhausts the call stack.
+ */
+const rawText = (nodeArg) => {
+    const pieces = [];
+    const stack = [nodeArg];
+    for (let node = stack.pop(); node !== undefined; node = stack.pop()) {
+        if ('value' in node && node.nodeName === '#text') {
+            pieces.push(node.value);
+            continue;
+        }
+        if (!('childNodes' in node)) {
+            continue;
+        }
+        if ('tagName' in node && (node.tagName === 'script' || node.tagName === 'style')) {
+            continue;
+        }
+        for (let index = node.childNodes.length - 1; index >= 0; index--) {
+            stack.push(node.childNodes[index]);
+        }
+    }
+    return pieces.join(' ');
+};
+/** the text of a node with white space collapsed */
+export const textOf = (nodeArg) => rawText(nodeArg).replace(/\s+/g, ' ').trim();
+/** the text of the text nodes directly inside an element */
+export const ownTextOf = (elementArg) => elementArg.childNodes
+    .map((childArg) => ('value' in childArg && childArg.nodeName === '#text' ? childArg.value : ''))
+    .join(' ')
+    .replace(/\s+/g, ' ')
+    .trim();
+/** the next element sibling */
+export const nextElementSibling = (elementArg) => {
+    const parent = elementArg.parentNode;
+    if (!parent) {
+        return undefined;
+    }
+    const siblings = elementChildren(parent);
+    return siblings[siblings.indexOf(elementArg) + 1];
+};
+/** the previous element sibling */
+export const previousElementSibling = (elementArg) => {
+    const parent = elementArg.parentNode;
+    if (!parent) {
+        return undefined;
+    }
+    const siblings = elementChildren(parent);
+    const index = siblings.indexOf(elementArg);
+    return index > 0 ? siblings[index - 1] : undefined;
+};
+/** the language the document declares on its root element */
+export const documentLanguage = (documentArg) => {
+    const root = elementChildren(documentArg).find((elementArg) => elementArg.tagName === 'html');
+    return root ? getAttribute(root, 'lang') : undefined;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHRtbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2hhbmRlbHNyZWdpc3Rlci9odG1sLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBT3hDLE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBRyxDQUFDLE9BQWUsRUFBaUIsRUFBRSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBRTNGLE1BQU0sU0FBUyxHQUFHLENBQUMsT0FBdUIsRUFBMkIsRUFBRSxDQUFDLFNBQVMsSUFBSSxPQUFPLENBQUM7QUFFN0YscUNBQXFDO0FBQ3JDLE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBRyxDQUFDLE9BQXdCLEVBQWtCLEVBQUUsQ0FDMUUsT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUM7QUFFdkMsb0RBQW9EO0FBQ3BELE1BQU0sQ0FBQyxNQUFNLFdBQVcsR0FBRyxDQUFDLE9BQXdCLEVBQWtCLEVBQUU7SUFDdEUsTUFBTSxNQUFNLEdBQW1CLEVBQUUsQ0FBQztJQUNsQyxNQUFNLEtBQUssR0FBbUIsZUFBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2pFLE9BQU8sS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUN4QixNQUFNLE9BQU8sR0FBRyxLQUFLLENBQUMsR0FBRyxFQUFrQixDQUFDO1FBQzVDLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDckIsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLE9BQU8sS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsZUFBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2hGLEtBQUssSUFBSSxLQUFLLEdBQUcsUUFBUSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsS0FBSyxJQUFJLENBQUMsRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDO1lBQzFELEtBQUssQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7UUFDOUIsQ0FBQztJQUNILENBQUM7SUFDRCxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDLENBQUM7QUFFRixNQUFNLENBQUMsTUFBTSxZQUFZLEdBQUcsQ0FBQyxVQUF3QixFQUFFLE9BQWUsRUFBc0IsRUFBRSxDQUM1RixVQUFVLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksS0FBSyxPQUFPLENBQUMsRUFBRSxLQUFLLENBQUM7QUFFdEUsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUFHLENBQUMsVUFBd0IsRUFBRSxRQUFnQixFQUFXLEVBQUUsQ0FDOUUsQ0FBQyxZQUFZLENBQUMsVUFBVSxFQUFFLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7QUFFNUUsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUFHLENBQUMsT0FBd0IsRUFBRSxLQUFhLEVBQTRCLEVBQUUsQ0FDNUYsV0FBVyxDQUFDLE9BQU8sQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQUMsWUFBWSxDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsS0FBSyxLQUFLLENBQUMsQ0FBQztBQUV0RixNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsQ0FDckIsT0FBd0IsRUFDeEIsWUFBbUQsRUFDbkMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7QUFFL0QsTUFBTSxDQUFDLE1BQU0sU0FBUyxHQUFHLENBQ3ZCLE9BQXdCLEVBQ3hCLFlBQW1ELEVBQ3pCLEVBQUUsQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBRXZFOzs7O0dBSUc7QUFDSCxNQUFNLE9BQU8sR0FBRyxDQUFDLE9BQXlDLEVBQVUsRUFBRTtJQUNwRSxNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7SUFDNUIsTUFBTSxLQUFLLEdBQTRDLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDakUsS0FBSyxJQUFJLElBQUksR0FBRyxLQUFLLENBQUMsR0FBRyxFQUFFLEVBQUUsSUFBSSxLQUFLLFNBQVMsRUFBRSxJQUFJLEdBQUcsS0FBSyxDQUFDLEdBQUcsRUFBRSxFQUFFLENBQUM7UUFDcEUsSUFBSSxPQUFPLElBQUksSUFBSSxJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssT0FBTyxFQUFFLENBQUM7WUFDakQsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDeEIsU0FBUztRQUNYLENBQUM7UUFDRCxJQUFJLENBQUMsQ0FBQyxZQUFZLElBQUksSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUM1QixTQUFTO1FBQ1gsQ0FBQztRQUNELElBQUksU0FBUyxJQUFJLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEtBQUssUUFBUSxJQUFJLElBQUksQ0FBQyxPQUFPLEtBQUssT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNqRixTQUFTO1FBQ1gsQ0FBQztRQUNELEtBQUssSUFBSSxLQUFLLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLEtBQUssSUFBSSxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FBQztZQUNqRSxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztRQUNyQyxDQUFDO0lBQ0gsQ0FBQztJQUNELE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUMxQixDQUFDLENBQUM7QUFFRixvREFBb0Q7QUFDcEQsTUFBTSxDQUFDLE1BQU0sTUFBTSxHQUFHLENBQUMsT0FBeUMsRUFBVSxFQUFFLENBQzFFLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO0FBRS9DLDREQUE0RDtBQUM1RCxNQUFNLENBQUMsTUFBTSxTQUFTLEdBQUcsQ0FBQyxVQUF3QixFQUFVLEVBQUUsQ0FDNUQsVUFBVSxDQUFDLFVBQVU7S0FDbEIsR0FBRyxDQUFDLENBQUMsUUFBUSxFQUFFLEVBQUUsQ0FBQyxDQUFDLE9BQU8sSUFBSSxRQUFRLElBQUksUUFBUSxDQUFDLFFBQVEsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0tBQy9GLElBQUksQ0FBQyxHQUFHLENBQUM7S0FDVCxPQUFPLENBQUMsTUFBTSxFQUFFLEdBQUcsQ0FBQztLQUNwQixJQUFJLEVBQUUsQ0FBQztBQUVaLCtCQUErQjtBQUMvQixNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxDQUFDLFVBQXdCLEVBQTRCLEVBQUU7SUFDdkYsTUFBTSxNQUFNLEdBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQztJQUNyQyxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDWixPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBQ0QsTUFBTSxRQUFRLEdBQUcsZUFBZSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ3pDLE9BQU8sUUFBUSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFDcEQsQ0FBQyxDQUFDO0FBRUYsbUNBQW1DO0FBQ25DLE1BQU0sQ0FBQyxNQUFNLHNCQUFzQixHQUFHLENBQUMsVUFBd0IsRUFBNEIsRUFBRTtJQUMzRixNQUFNLE1BQU0sR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFDO0lBQ3JDLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNaLE9BQU8sU0FBUyxDQUFDO0lBQ25CLENBQUM7SUFDRCxNQUFNLFFBQVEsR0FBRyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDekMsTUFBTSxLQUFLLEdBQUcsUUFBUSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUMzQyxPQUFPLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztBQUNyRCxDQUFDLENBQUM7QUFFRiw2REFBNkQ7QUFDN0QsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxXQUEwQixFQUFzQixFQUFFO0lBQ2pGLE1BQU0sSUFBSSxHQUFHLGVBQWUsQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDLFVBQVUsQ0FBQyxPQUFPLEtBQUssTUFBTSxDQUFDLENBQUM7SUFDOUYsT0FBTyxJQUFJLENBQUMsQ0FBQyxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztBQUN2RCxDQUFDLENBQUMifQ==

package/dist_ts/handelsregister/index.d.ts

@@ -0,0 +1,9 @@
+export * from './interfaces.js';
+export { HandelsregisterError, type IHandelsregisterErrorDetails, type THandelsregisterErrorCode, type THandelsregisterStep, } from './classes.handelsregistererror.js';
+export { HandelsregisterClient } from './classes.handelsregisterclient.js';
+export { SlidingWindowGate, type ISlidingWindowGateOptions } from './classes.slidingwindowgate.js';
+export { portalMaximumHits, portalRequestsPerHour, registerDocuments, registerTypes, structuredContentNotice, } from './constants.js';
+export { registerCourts } from './data.codelists.js';
+export { findRegisterCourt, formatRegisterReference, parseRegisterNumber, parseRegisterReferenceText, type IParsedRegisterReferenceText, type IRegisterNumberParts, } from './references.js';
+export { parseSearchResults, type IParsedSearchResults } from './parse.searchresults.js';
+export { parseStructuredContent } from './parse.structuredcontent.js';

package/dist_ts/handelsregister/index.js

@@ -0,0 +1,10 @@
+export * from './interfaces.js';
+export { HandelsregisterError, } from './classes.handelsregistererror.js';
+export { HandelsregisterClient } from './classes.handelsregisterclient.js';
+export { SlidingWindowGate } from './classes.slidingwindowgate.js';
+export { portalMaximumHits, portalRequestsPerHour, registerDocuments, registerTypes, structuredContentNotice, } from './constants.js';
+export { registerCourts } from './data.codelists.js';
+export { findRegisterCourt, formatRegisterReference, parseRegisterNumber, parseRegisterReferenceText, } from './references.js';
+export { parseSearchResults } from './parse.searchresults.js';
+export { parseStructuredContent } from './parse.structuredcontent.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9oYW5kZWxzcmVnaXN0ZXIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxPQUFPLEVBQ0wsb0JBQW9CLEdBSXJCLE1BQU0sbUNBQW1DLENBQUM7QUFDM0MsT0FBTyxFQUFFLHFCQUFxQixFQUFFLE1BQU0sb0NBQW9DLENBQUM7QUFDM0UsT0FBTyxFQUFFLGlCQUFpQixFQUFrQyxNQUFNLGdDQUFnQyxDQUFDO0FBQ25HLE9BQU8sRUFDTCxpQkFBaUIsRUFDakIscUJBQXFCLEVBQ3JCLGlCQUFpQixFQUNqQixhQUFhLEVBQ2IsdUJBQXVCLEdBQ3hCLE1BQU0sZ0JBQWdCLENBQUM7QUFDeEIsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ3JELE9BQU8sRUFDTCxpQkFBaUIsRUFDakIsdUJBQXVCLEVBQ3ZCLG1CQUFtQixFQUNuQiwwQkFBMEIsR0FHM0IsTUFBTSxpQkFBaUIsQ0FBQztBQUN6QixPQUFPLEVBQUUsa0JBQWtCLEVBQTZCLE1BQU0sMEJBQTBCLENBQUM7QUFDekYsT0FBTyxFQUFFLHNCQUFzQixFQUFFLE1BQU0sOEJBQThCLENBQUMifQ==

package/dist_ts/handelsregister/interfaces.d.ts

@@ -0,0 +1,240 @@
+/**
+ * The register types the register portal searches: Handelsregister A and B, Genossenschafts-,
+ * Partnerschafts-, Vereins- and Gesellschaftsregister.
+ */
+export type TRegisterType = 'HRA' | 'HRB' | 'GnR' | 'PR' | 'VR' | 'GsR';
+/** a register court of the portal */
+export interface IRegisterCourt {
+    /** XJustiz court code, for example `H1101` */
+    code: string;
+    /** the court's name as the portal writes it after "Amtsgericht", for example `Bremen` */
+    name: string;
+}
+/** one register sheet, as the portal identifies it */
+export interface IRegisterReference {
+    court: IRegisterCourt;
+    type: TRegisterType;
+    /**
+     * the register number as the portal shows it, with the location suffix where the court uses
+     * one: `35230 HB`, `999928 NM`, `12345`
+     */
+    number: string;
+}
+/** what a caller passes to identify one register sheet */
+export interface IRegisterReferenceInput {
+    /** XJustiz court code, see `registerCourts` and `findRegisterCourt()` */
+    courtCode: string;
+    type: TRegisterType;
+    /** `35230`, `35230 HB` or `35230HB`; a location suffix is compared when it is given */
+    number: string;
+}
+/** the documents the portal offers for an entry */
+export type TRegisterDocument = 'AD' | 'CD' | 'HD' | 'DK' | 'UT' | 'VÖ' | 'SI';
+/** an earlier name of an entry, from the portal's result list */
+export interface IRegisterFormerName {
+    name: string;
+    /** the seat at the time, when the portal names one */
+    seat?: string;
+}
+/**
+ * The state of a register sheet in the portal's result list:
+ * - `current`: the portal's "aktuell";
+ * - `closed`: the portal's "Geschlossenes Registerblatt". The entry was deleted, or its sheet was
+ *   closed because the entity moved to another court, changed its legal form or merged. The list
+ *   does not say which;
+ * - `other`: a word this version does not know; `sheetStatusText` carries it.
+ */
+export type TRegisterSheetStatus = 'current' | 'closed' | 'other';
+/** one row of the portal's result list */
+export interface IRegisterMatch {
+    reference: IRegisterReference;
+    /** the court that kept the sheet before ("früher Amtsgericht …"), as the portal names it */
+    formerCourt?: string;
+    /** the federal state of the register court, as the portal names it */
+    federalState: string;
+    /** the current name (Firma) */
+    name: string;
+    /** the seat, as the portal shows it */
+    seat: string;
+    sheetStatus: TRegisterSheetStatus;
+    /** the portal's own word for the sheet status, German */
+    sheetStatusText: string;
+    /** earlier names, as the portal numbers them */
+    formerNames: IRegisterFormerName[];
+    /** the documents the portal offers for this entry; `SI` is the structured register content */
+    documents: TRegisterDocument[];
+}
+/**
+ * The portal's note on the structured register content. Every result carries it, because the
+ * structured content is not binding: the current printout (AD) is.
+ */
+export interface IStructuredContentNotice {
+    /** the portal's words, German, verbatim */
+    de: string;
+    /** the same in English */
+    en: string;
+}
+export interface IRegisterSearchResult {
+    /** every row the portal returned, in its order; never narrowed down to one */
+    matches: IRegisterMatch[];
+    /** the portal stopped at its maximum number of hits (100) and asked for a narrower search */
+    truncated: boolean;
+    /** the portal's notice above the list, German, when it shows one */
+    portalNotice?: string;
+    /** epoch ms: when the result list arrived */
+    retrievedAt: number;
+    /** requests of this call that count against the portal's limit of 60 per hour (always 1) */
+    countedRequests: number;
+    notice: IStructuredContentNotice;
+}
+/**
+ * The state of the legal entity, from the structured register content (XJustiz list
+ * reg.status-rechtstraeger):
+ * - `active` ("aktiv");
+ * - `deleted` ("gelöscht");
+ * - `in_liquidation`: dissolved and being wound up ("in Abwicklung");
+ * - `insolvent` ("insolvent");
+ * - `merged`: merged into an entity that is not registered;
+ * - `unknown`: a code this version does not know.
+ */
+export type TRegisterEntityState = 'active' | 'deleted' | 'in_liquidation' | 'insolvent' | 'merged' | 'unknown';
+export interface IRegisterEntityStatus {
+    state: TRegisterEntityState;
+    /** code of the XJustiz list reg.status-rechtstraeger */
+    code: string;
+    /** its German designation, when the code is known */
+    label?: string;
+}
+export interface IRegisterLegalForm {
+    /** code of the XUnternehmen list of legal forms, for example `221110` */
+    code: string;
+    /** short designation, for example `GmbH`, when the code is known */
+    short?: string;
+    /** full designation, for example `Gesellschaft mit beschränkter Haftung`, when the code is known */
+    long?: string;
+}
+export interface IRegisterSeat {
+    city: string;
+    /** ISO 3166-1 alpha-2, when the state key is known */
+    country?: string;
+    /** the BfJ state key as the content gives it; `000` is Germany */
+    countryKey?: string;
+}
+/** a business address; private addresses are never read */
+export interface IRegisterAddress {
+    street?: string;
+    houseNumber?: string;
+    postalCode?: string;
+    city?: string;
+    /** ISO 3166-1 alpha-2, when the state key is known */
+    country?: string;
+    /** the BfJ state key as the content gives it; `000` is Germany */
+    countryKey?: string;
+}
+/**
+ * Someone the structured content names as entitled to represent the entity. Only the name and the
+ * function are read: birth dates, places of residence and addresses of people never leave the parser.
+ */
+export interface IRegisterRepresentative {
+    /** for a person: title, given names, name prefix, family name and suffix; for an organisation its name */
+    name: string;
+    kind: 'person' | 'organisation';
+    /** the function, German, for example `Geschäftsführer(in)`; absent for a code this version does not know */
+    function?: string;
+    /** code of the XJustiz list gds.rollenbezeichnung */
+    functionCode: string;
+}
+/** the register sheet as the structured content states it */
+export interface IRegisterContentRegister {
+    courtCode?: string;
+    type?: string;
+    number?: string;
+}
+/** the parsed structured register content (SI) of one entry */
+export interface IRegisterStructuredContent {
+    /** whether the content describes the entity as an organisation or as a natural person */
+    entityKind: 'organisation' | 'person';
+    name: string;
+    legalForm?: IRegisterLegalForm;
+    seat?: IRegisterSeat;
+    address?: IRegisterAddress;
+    register: IRegisterContentRegister;
+    /** absent when the content states no status */
+    status?: IRegisterEntityStatus;
+    /** ISO date of the most recent entry on the sheet; the content states no date for the status itself */
+    lastEntryOn?: string;
+    /** whether the content names who may represent the entity */
+    representationStated: boolean;
+    representatives: IRegisterRepresentative[];
+    /** when the portal produced the content, as it states it (ISO 8601) */
+    producedAt?: string;
+    binding: false;
+    notice: IStructuredContentNotice;
+}
+export interface IRegisterEntry {
+    /** the entry's row in the portal's result list */
+    match: IRegisterMatch;
+    /** the parsed structured content; null when the portal offers none for this entry */
+    structuredContent: IRegisterStructuredContent | null;
+    /** epoch ms: when the last answer of the portal arrived */
+    retrievedAt: number;
+    /** requests of this call that count against the portal's limit: 2, or 1 without structured content */
+    countedRequests: number;
+    notice: IStructuredContentNotice;
+}
+/** a search by the name (Firma) */
+export interface IRegisterNameQuery {
+    /** keywords of the name */
+    name: string;
+    /** `all` keywords (default), `any` keyword, or the `exact` name */
+    match?: 'all' | 'any' | 'exact';
+    /** the seat or the place of a branch */
+    seat?: string;
+    type?: TRegisterType;
+    courtCode?: string;
+    /** also closed register sheets (deleted entries) */
+    includeClosed?: boolean;
+}
+/** a search by register number; without a court, every court's entry with that number is returned */
+export interface IRegisterNumberQuery {
+    type: TRegisterType;
+    /** `35230`, `35230 HB` or `35230HB`; with a location suffix only rows with that suffix are returned */
+    number: string;
+    courtCode?: string;
+    /** also closed register sheets (deleted entries) */
+    includeClosed?: boolean;
+}
+export type TRegisterSearchQuery = IRegisterNameQuery | IRegisterNumberQuery;
+/** the two kinds of request the portal's terms count: at most 60 together per hour */
+export type TRegisterCountedRequestKind = 'search' | 'retrieval';
+export interface IRegisterCountedRequest {
+    kind: TRegisterCountedRequestKind;
+}
+/**
+ * Decides whether the next counted request may be made. The client calls `acquire()` before
+ * every search and every retrieval, before the step contacts the portal. Resolve to allow the
+ * request; throw to refuse it, and nothing is sent. A `HandelsregisterError` reaches the caller
+ * with the refused step and the requests the call counted before it; any other error reaches the
+ * caller unchanged.
+ */
+export interface IRegisterRequestGate {
+    acquire(request: IRegisterCountedRequest): Promise<void>;
+}
+export interface IHandelsregisterClientOptions {
+    /** decides before every counted request whether it may be made; see `SlidingWindowGate` */
+    gate: IRegisterRequestGate;
+    /** default `https://www.handelsregister.de` */
+    portalUrl?: string;
+    /** sent as User-Agent; name your installation and a contact */
+    userAgent?: string;
+    /** limit for each HTTP request, including its body; default 20000 ms */
+    requestTimeoutMs?: number;
+    /** limit for each response body; default 5 MiB */
+    maxResponseBytes?: number;
+    /** clock for `retrievedAt`; default `Date.now` */
+    now?: () => number;
+}
+export interface IRegisterCallOptions {
+    /** aborts the call; a request already sent may still have counted */
+    signal?: AbortSignal;
+}

package/dist_ts/handelsregister/interfaces.js

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

package/dist_ts/handelsregister/parse.searchresults.d.ts

@@ -0,0 +1,35 @@
+import * as forms from './forms.js';
+import type { IRegisterCourt, IRegisterMatch, IStructuredContentNotice, TRegisterDocument } from './interfaces.js';
+export declare const resultFormId = "ergebnissForm";
+/** one row of the result list with what is needed to retrieve its documents */
+export interface IResultRow {
+    match: IRegisterMatch;
+    /** the extra fields a click on each document link submits with the result form */
+    documentSubmissions: Map<TRegisterDocument, Array<[string, string]>>;
+}
+export interface IParsedResultList {
+    rows: IResultRow[];
+    truncated: boolean;
+    portalNotice?: string;
+    /** the number of hits the portal reports */
+    hitCount?: number;
+    /** the result form, for retrieving documents */
+    form?: forms.IPortalForm;
+}
+/** the public shape of a parsed result list */
+export interface IParsedSearchResults {
+    matches: IRegisterMatch[];
+    truncated: boolean;
+    portalNotice?: string;
+    notice: IStructuredContentNotice;
+}
+/**
+ * Reads the portal's result list. `courtsArg` are the register courts the rows are resolved
+ * against; by default the courts this version knows.
+ */
+export declare const readResultList: (htmlArg: string, courtsArg?: readonly IRegisterCourt[]) => IParsedResultList;
+/**
+ * Parses a result list page of the register portal, as saved from a browser, into matches.
+ * Makes no request.
+ */
+export declare const parseSearchResults: (htmlArg: string) => IParsedSearchResults;