@fin.cx/opendata 3.6.0 → 4.0.0

package/ts/handelsregister/references.ts

@@ -0,0 +1,115 @@
+import { registerTypes } from './constants.js';
+import { registerCourts } from './data.codelists.js';
+import type { IRegisterCourt, IRegisterReference, TRegisterType } from './interfaces.js';
+
+/** a register number split into its digits and its location suffix */
+export interface IRegisterNumberParts {
+  digits: string;
+  /** upper case, for example `HB` */
+  suffix?: string;
+}
+
+/** a register reference read from text; the court is absent when the text names none */
+export interface IParsedRegisterReferenceText {
+  court?: IRegisterCourt;
+  /** the court as the text names it, when it names one */
+  courtText?: string;
+  type: TRegisterType;
+  /** digits and location suffix, for example `35230 HB` */
+  number: string;
+}
+
+const collapse = (textArg: string): string => textArg.replace(/\s+/g, ' ').trim();
+
+const courtKey = (textArg: string): string =>
+  collapse(textArg)
+    .replace(/^(?:amtsgericht|registergericht|ag)\s+/i, '')
+    .toLocaleLowerCase('de-DE');
+
+/** the alternative name the portal puts in brackets: `Berlin (Charlottenburg)` → `charlottenburg` */
+const courtAliasKey = (nameArg: string): string | undefined => {
+  const bracket = /\(([^()]+)\)\s*$/.exec(nameArg);
+  return bracket ? courtKey(bracket[1]) : undefined;
+};
+
+/**
+ * Finds a register court by its code or its name: `H1101`, `Bremen`, `Amtsgericht Bremen`,
+ * `Berlin (Charlottenburg)` or `Charlottenburg`. Returns undefined unless exactly one court fits.
+ */
+export const findRegisterCourt = (
+  codeOrNameArg: string,
+  courtsArg: readonly IRegisterCourt[] = registerCourts
+): IRegisterCourt | undefined => {
+  const text = collapse(codeOrNameArg);
+  if (!text) {
+    return undefined;
+  }
+  const byCode = courtsArg.find((courtArg) => courtArg.code.toUpperCase() === text.toUpperCase());
+  if (byCode) {
+    return byCode;
+  }
+  const key = courtKey(text);
+  const byName = courtsArg.filter((courtArg) => courtKey(courtArg.name) === key);
+  if (byName.length === 1) {
+    return byName[0];
+  }
+  if (byName.length > 1) {
+    return undefined;
+  }
+  const byAlias = courtsArg.filter((courtArg) => courtAliasKey(courtArg.name) === key);
+  return byAlias.length === 1 ? byAlias[0] : undefined;
+};
+
+/** returns the canonical register type for `hrb`, `HRB`, `gnr` …, or undefined */
+export const toRegisterType = (textArg: string): TRegisterType | undefined =>
+  registerTypes.find((typeArg) => typeArg.toLowerCase() === collapse(textArg).toLowerCase());
+
+/** splits `35230 HB`, `35230HB` or `35230` into digits and location suffix */
+export const parseRegisterNumber = (textArg: string): IRegisterNumberParts | undefined => {
+  const match = /^(\d{1,9})\s*([A-Za-zÄÖÜäöü]{1,5})?$/.exec(collapse(textArg));
+  if (!match) {
+    return undefined;
+  }
+  return match[2] ? { digits: match[1], suffix: match[2].toLocaleUpperCase('de-DE') } : { digits: match[1] };
+};
+
+export const formatRegisterNumber = (partsArg: IRegisterNumberParts): string =>
+  partsArg.suffix ? `${partsArg.digits} ${partsArg.suffix}` : partsArg.digits;
+
+/**
+ * Reads a register reference as businesses print it: `Amtsgericht Bremen HRB 35230 HB`,
+ * `AG Bremen, HRB 35230`, `HRB 35230 HB`. Returns undefined for text it cannot read. A court name
+ * that fits no register court leaves `court` absent and keeps the text in `courtText`.
+ */
+export const parseRegisterReferenceText = (
+  textArg: string,
+  courtsArg: readonly IRegisterCourt[] = registerCourts
+): IParsedRegisterReferenceText | undefined => {
+  const text = collapse(textArg);
+  const match =
+    /^(.*?)[\s,;:]*\b(HRA|HRB|GnR|PR|VR|GsR)\b\.?\s*(?:Nr\.?\s*)?(\d{1,9}(?:\s*[A-Za-zÄÖÜäöü]{1,5})?)(?=\s|$)(?:\s+früher\s+Amtsgericht\s+.+)?$/i.exec(
+      text
+    );
+  if (!match) {
+    return undefined;
+  }
+  const type = toRegisterType(match[2]);
+  const number = parseRegisterNumber(match[3]);
+  if (!type || !number) {
+    return undefined;
+  }
+  const courtText = collapse(match[1].replace(/[,;:]+$/, ''));
+  const result: IParsedRegisterReferenceText = { type, number: formatRegisterNumber(number) };
+  if (courtText) {
+    result.courtText = courtText;
+    const court = findRegisterCourt(courtText, courtsArg);
+    if (court) {
+      result.court = court;
+    }
+  }
+  return result;
+};
+
+/** `Amtsgericht Bremen HRB 35230 HB` */
+export const formatRegisterReference = (referenceArg: IRegisterReference): string =>
+  `Amtsgericht ${referenceArg.court.name} ${referenceArg.type} ${referenceArg.number}`;

package/ts/index.ts

@@ -1,3 +1 @@
-export * from './classes.main.opendata.js';
-export * from './laws/index.js';
 export * from './stocks/index.js';

package/ts/plugins.ts

@@ -1,33 +1,15 @@
 // node native scope
-import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 
 export {
-  fs,
   path,
 }
 
 // @push.rocks scope
-import * as lik from '@push.rocks/lik';
 import * as qenv from '@push.rocks/qenv';
-import * as smartarchive from '@push.rocks/smartarchive';
-import * as smartarray from '@push.rocks/smartarray';
-import * as smartbrowser from '@push.rocks/smartbrowser';
-import * as smartdata from '@push.rocks/smartdata';
 import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartfile from '@push.rocks/smartfile';
-import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
-import * as smartlog from '@push.rocks/smartlog';
 import * as smartpath from '@push.rocks/smartpath';
-import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrequest from '@push.rocks/smartrequest';
-import * as smartdb from '@push.rocks/smartdb';
-import * as smartstream from '@push.rocks/smartstream';
-import * as smartunique from '@push.rocks/smartunique';
-import * as smartxml from '@push.rocks/smartxml'; 
-
-const smartfs = new SmartFs(new SmartFsProviderNode());
-const smartfileFactory = new smartfile.SmartFileFactory(smartfs);
 
 const getErrorMessage = (error: unknown) => {
   if (error instanceof Error) {
@@ -39,29 +21,8 @@ const getErrorMessage = (error: unknown) => {
 
 export {
   getErrorMessage,
-  lik,
   qenv,
-  smartarchive,
-  smartarray,
-  smartbrowser,
-  smartdb,
-  smartdata,
   smartdelay,
-  smartfile,
-  smartfileFactory,
-  smartfs,
-  smartlog,
   smartpath,
-  smartpromise,
   smartrequest,
-  smartstream,
-  smartunique,
-  smartxml,
-}
-
-// @tsclass scope
-import * as tsclass from '@tsclass/tsclass';
-
-export {
-  tsclass,
 }

package/dist_ts/classes.businessrecord.d.ts

@@ -1,38 +0,0 @@
-import * as plugins from './plugins.js';
-export declare class BusinessRecord extends plugins.smartdata.SmartDataDbDoc<BusinessRecord, BusinessRecord> {
-    static getByGermanParsedRegistration: (parsedGermanRegistrationArg: BusinessRecord["data"]["germanParsedRegistration"]) => Promise<BusinessRecord>;
-    id: string;
-    data: {
-        name?: string;
-        startDate?: string;
-        endDate?: string;
-        status?: 'active' | 'liquidating' | 'closed';
-        address?: string;
-        postalCode?: string;
-        city?: string;
-        country?: string;
-        phone?: string;
-        fax?: string;
-        email?: string;
-        website?: string;
-        businessType?: string;
-        registrationId?: string;
-        germanParsedRegistration?: {
-            court?: string;
-            type?: 'HRA' | 'HRB' | 'GnR' | 'PR' | 'VR' | 'GsR';
-            number?: string;
-        };
-        legalForm?: 'GmbH' | 'GmbH & Co. KG' | 'AG' | 'LLC' | 'LLP' | 'GmbH & Co. KGaA' | 'GmbH & Co. KGaA, LLC';
-        managingDirectors?: string[];
-        boardOfDirectors?: string[];
-        supervisoryBoard?: string[];
-        foundingDate?: string;
-        capital?: string;
-        purpose?: string;
-        lastUpdate?: string;
-    };
-    /**
-     * validates the record against the Handelregister.
-     */
-    validate(): Promise<void>;
-}

package/dist_ts/classes.businessrecord.js

@@ -1,90 +0,0 @@
-var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
-    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
-    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
-    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
-    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
-    var _, done = false;
-    for (var i = decorators.length - 1; i >= 0; i--) {
-        var context = {};
-        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
-        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
-        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
-        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
-        if (kind === "accessor") {
-            if (result === void 0) continue;
-            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
-            if (_ = accept(result.get)) descriptor.get = _;
-            if (_ = accept(result.set)) descriptor.set = _;
-            if (_ = accept(result.init)) initializers.unshift(_);
-        }
-        else if (_ = accept(result)) {
-            if (kind === "field") initializers.unshift(_);
-            else descriptor[key] = _;
-        }
-    }
-    if (target) Object.defineProperty(target, contextIn.name, descriptor);
-    done = true;
-};
-var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
-    var useValue = arguments.length > 2;
-    for (var i = 0; i < initializers.length; i++) {
-        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
-    }
-    return useValue ? value : void 0;
-};
-import * as plugins from './plugins.js';
-let BusinessRecord = (() => {
-    let _classDecorators = [plugins.smartdata.Manager()];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = plugins.smartdata.SmartDataDbDoc;
-    let _id_decorators;
-    let _id_initializers = [];
-    let _id_extraInitializers = [];
-    let _data_decorators;
-    let _data_initializers = [];
-    let _data_extraInitializers = [];
-    var BusinessRecord = class extends _classSuper {
-        static { _classThis = this; }
-        static {
-            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-            _id_decorators = [plugins.smartdata.unI()];
-            _data_decorators = [plugins.smartdata.svDb()];
-            __esDecorate(null, null, _id_decorators, { kind: "field", name: "id", static: false, private: false, access: { has: obj => "id" in obj, get: obj => obj.id, set: (obj, value) => { obj.id = value; } }, metadata: _metadata }, _id_initializers, _id_extraInitializers);
-            __esDecorate(null, null, _data_decorators, { kind: "field", name: "data", static: false, private: false, access: { has: obj => "data" in obj, get: obj => obj.data, set: (obj, value) => { obj.data = value; } }, metadata: _metadata }, _data_initializers, _data_extraInitializers);
-            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-            BusinessRecord = _classThis = _classDescriptor.value;
-            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        }
-        // STATIC
-        static getByGermanParsedRegistration = async (parsedGermanRegistrationArg) => {
-            const businessRecords = await BusinessRecord.getInstance({
-                data: {
-                    germanParsedRegistration: parsedGermanRegistrationArg,
-                }
-            });
-            return businessRecords;
-        };
-        // INSTANCE
-        id = __runInitializers(this, _id_initializers, void 0);
-        data = (__runInitializers(this, _id_extraInitializers), __runInitializers(this, _data_initializers, {}));
-        /**
-         * validates the record against the Handelregister.
-         */
-        async validate() {
-            if (!this.data.name)
-                throw new Error('Name is required.');
-        }
-        constructor() {
-            super(...arguments);
-            __runInitializers(this, _data_extraInitializers);
-        }
-        static {
-            __runInitializers(_classThis, _classExtraInitializers);
-        }
-    };
-    return BusinessRecord = _classThis;
-})();
-export { BusinessRecord };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5idXNpbmVzc3JlY29yZC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2NsYXNzZXMuYnVzaW5lc3NyZWNvcmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0lBRzNCLGNBQWM7NEJBRDFCLE9BQU8sQ0FBQyxTQUFTLENBQUMsT0FBTyxFQUFFOzs7O3NCQUNRLE9BQU8sQ0FBQyxTQUFTLENBQUMsY0FBYzs7Ozs7Ozs4QkFBeEMsU0FBUSxXQUduQzs7Ozs4QkFhRSxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsRUFBRTtnQ0FHdkIsT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUU7WUFGekIsd0pBQUEsRUFBRSw2QkFBRixFQUFFLCtFQUFVO1lBR1osOEpBQUEsSUFBSSw2QkFBSixJQUFJLG1GQW1DRztZQXZEVCw2S0ErREM7Ozs7UUEzREMsU0FBUztRQUNGLE1BQU0sQ0FBQyw2QkFBNkIsR0FBRyxLQUFLLEVBQUUsMkJBQStFLEVBQUUsRUFBRTtZQUN0SSxNQUFNLGVBQWUsR0FBRyxNQUFNLGNBQWMsQ0FBQyxXQUFXLENBQUM7Z0JBQ3ZELElBQUksRUFBRTtvQkFDSix3QkFBd0IsRUFBRSwyQkFBMkI7aUJBQ3REO2FBQ0YsQ0FBQyxDQUFDO1lBQ0gsT0FBTyxlQUFlLENBQUM7UUFDekIsQ0FBQyxDQUFDO1FBR0YsV0FBVztRQUVYLEVBQUUscURBQVU7UUFHWixJQUFJLGdHQW1DQSxFQUFFLEdBQUM7UUFFUDs7V0FFRztRQUNJLEtBQUssQ0FBQyxRQUFRO1lBQ25CLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUk7Z0JBQUUsTUFBTSxJQUFJLEtBQUssQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBQzVELENBQUM7Ozs7OztZQTlEVSx1REFBYzs7Ozs7U0FBZCxjQUFjIn0=

package/dist_ts/classes.handelsregister.d.ts

@@ -1,134 +0,0 @@
-import type { BusinessRecord } from './classes.businessrecord.js';
-import type { OpenData } from './classes.main.opendata.js';
-import * as plugins from './plugins.js';
-/**
- * the HandlesRegister exposed as a class
- */
-export declare class HandelsRegister {
-    private openDataRef;
-    private asyncExecutionStack;
-    private downloadDir;
-    private uniqueDowloadFolder;
-    smartbrowserInstance: plugins.smartbrowser.SmartBrowser;
-    constructor(openDataRef: OpenData, downloadDirArg: string);
-    private resetDownloadFolder;
-    private waitForDownloadedFile;
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    /**
-     * Creates a new page and configures it to allow file downloads
-     * to a predefined path.
-     */
-    getNewPage: () => Promise<plugins.smartbrowser.smartpuppeteer.puppeteer.Page>;
-    private navigateToPage;
-    private waitForResults;
-    private clickFindButton;
-    private downloadFile;
-    /**
-     * Helper method to parse the German registration string
-     */
-    private parseGermanRegistration;
-    /**
-     * Search for a company by name and return basic info
-     */
-    searchCompany(companyNameArg: string, resultsLimitArg?: number): Promise<{
-        name?: string;
-        startDate?: string;
-        endDate?: string;
-        status?: "active" | "liquidating" | "closed";
-        address?: string;
-        postalCode?: string;
-        city?: string;
-        country?: string;
-        phone?: string;
-        fax?: string;
-        email?: string;
-        website?: string;
-        businessType?: string;
-        registrationId?: string;
-        germanParsedRegistration?: {
-            court?: string;
-            type?: "HRA" | "HRB" | "GnR" | "PR" | "VR" | "GsR";
-            number?: string;
-        };
-        legalForm?: "GmbH" | "GmbH & Co. KG" | "AG" | "LLC" | "LLP" | "GmbH & Co. KGaA" | "GmbH & Co. KGaA, LLC";
-        managingDirectors?: string[];
-        boardOfDirectors?: string[];
-        supervisoryBoard?: string[];
-        foundingDate?: string;
-        capital?: string;
-        purpose?: string;
-        lastUpdate?: string;
-    }[]>;
-    /**
-     * Search for a specific company (known register type/number/court),
-     * then click on an element that triggers a file download.
-     */
-    getSpecificCompany(companyArg: BusinessRecord['data']['germanParsedRegistration']): Promise<{
-        businessRecords: {
-            name?: string;
-            startDate?: string;
-            endDate?: string;
-            status?: "active" | "liquidating" | "closed";
-            address?: string;
-            postalCode?: string;
-            city?: string;
-            country?: string;
-            phone?: string;
-            fax?: string;
-            email?: string;
-            website?: string;
-            businessType?: string;
-            registrationId?: string;
-            germanParsedRegistration?: {
-                court?: string;
-                type?: "HRA" | "HRB" | "GnR" | "PR" | "VR" | "GsR";
-                number?: string;
-            };
-            legalForm?: "GmbH" | "GmbH & Co. KG" | "AG" | "LLC" | "LLP" | "GmbH & Co. KGaA" | "GmbH & Co. KGaA, LLC";
-            managingDirectors?: string[];
-            boardOfDirectors?: string[];
-            supervisoryBoard?: string[];
-            foundingDate?: string;
-            capital?: string;
-            purpose?: string;
-            lastUpdate?: string;
-        }[];
-        files: plugins.smartfile.SmartFile[];
-    }>;
-    /**
-     * get specific company by full name
-     */
-    getSpecificCompanyByName(companyNameArg: string): Promise<{
-        businessRecords: {
-            name?: string;
-            startDate?: string;
-            endDate?: string;
-            status?: "active" | "liquidating" | "closed";
-            address?: string;
-            postalCode?: string;
-            city?: string;
-            country?: string;
-            phone?: string;
-            fax?: string;
-            email?: string;
-            website?: string;
-            businessType?: string;
-            registrationId?: string;
-            germanParsedRegistration?: {
-                court?: string;
-                type?: "HRA" | "HRB" | "GnR" | "PR" | "VR" | "GsR";
-                number?: string;
-            };
-            legalForm?: "GmbH" | "GmbH & Co. KG" | "AG" | "LLC" | "LLP" | "GmbH & Co. KGaA" | "GmbH & Co. KGaA, LLC";
-            managingDirectors?: string[];
-            boardOfDirectors?: string[];
-            supervisoryBoard?: string[];
-            foundingDate?: string;
-            capital?: string;
-            purpose?: string;
-            lastUpdate?: string;
-        }[];
-        files: plugins.smartfile.SmartFile[];
-    }>;
-}