@ekwo-ai/xbrl-cbso 0.4.0

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/validate.d.ts

@@ -0,0 +1,4 @@
+import type { CbsoInput } from './types.js';
+/** Throws a {@link CbsoInputError} describing the first problem found. */
+export declare function validateInput(input: CbsoInput): void;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAiB,MAAM,YAAY,CAAC;AA8B3D,0EAA0E;AAC1E,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAwDpD"}

package/dist/validate.js

@@ -0,0 +1,84 @@
+import { CbsoInputError } from './errors.js';
+import { isValidEnterpriseNumber } from './enterprise-number.js';
+const ISO_DATE = /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/;
+function requireText(value, path) {
+    if (typeof value !== 'string' || value.trim() === '') {
+        throw new CbsoInputError('must be a non-empty string', path);
+    }
+}
+function requireDate(value, path) {
+    if (typeof value !== 'string' || !ISO_DATE.test(value)) {
+        throw new CbsoInputError('must be an ISO date (YYYY-MM-DD)', path);
+    }
+}
+function validateAddress(address, path) {
+    requireText(address.street, `${path}.street`);
+    requireText(address.number, `${path}.number`);
+    requireText(address.postalCode, `${path}.postalCode`);
+    requireText(address.city, `${path}.city`);
+    const country = (address.country ?? 'BE').toUpperCase();
+    if (!/^[A-Z]{2}$/.test(country)) {
+        throw new CbsoInputError('must be an ISO 3166-1 alpha-2 code', `${path}.country`);
+    }
+    if (country === 'BE' && !/^\d{4}$/.test(address.postalCode.trim())) {
+        throw new CbsoInputError('a Belgian postal code has four digits', `${path}.postalCode`);
+    }
+}
+/** Throws a {@link CbsoInputError} describing the first problem found. */
+export function validateInput(input) {
+    requireText(input.entityNumber, 'entityNumber');
+    if (!isValidEnterpriseNumber(input.entityNumber)) {
+        throw new CbsoInputError('invalid Belgian enterprise number (check digits)', 'entityNumber');
+    }
+    requireText(input.denomination, 'denomination');
+    requireText(input.legalForm, 'legalForm');
+    requireText(input.court, 'court');
+    validateAddress(input.address, 'address');
+    for (const key of [
+        'periodStart',
+        'periodEnd',
+        'prevPeriodStart',
+        'prevPeriodEnd',
+        'gaDate',
+        'deedDate',
+    ]) {
+        requireDate(input[key], key);
+    }
+    if (input.periodStart >= input.periodEnd) {
+        throw new CbsoInputError('must be before periodEnd', 'periodStart');
+    }
+    if (input.prevPeriodEnd >= input.periodStart) {
+        throw new CbsoInputError('must be before periodStart', 'prevPeriodEnd');
+    }
+    for (const [code, v] of Object.entries(input.values ?? {})) {
+        for (const col of ['n', 'p']) {
+            const x = v?.[col];
+            if (x != null && !Number.isFinite(x)) {
+                throw new CbsoInputError('must be a finite number or null', `values.${code}.${col}`);
+            }
+        }
+    }
+    (input.administrators ?? []).forEach((admin, i) => {
+        const path = `administrators[${i}]`;
+        if (admin.kind === 'person') {
+            requireText(admin.lastName, `${path}.lastName`);
+            requireText(admin.firstName, `${path}.firstName`);
+        }
+        else if (admin.kind === 'company') {
+            requireText(admin.name, `${path}.name`);
+            if (admin.representative) {
+                requireText(admin.representative.lastName, `${path}.representative.lastName`);
+                requireText(admin.representative.firstName, `${path}.representative.firstName`);
+            }
+            const country = (admin.country ?? 'BE').toUpperCase();
+            if (country === 'BE' && admin.enterpriseNumber && !isValidEnterpriseNumber(admin.enterpriseNumber)) {
+                throw new CbsoInputError('invalid Belgian enterprise number (check digits)', `${path}.enterpriseNumber`);
+            }
+        }
+        else {
+            throw new CbsoInputError('kind must be "person" or "company"', `${path}.kind`);
+        }
+        validateAddress(admin, path);
+    });
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAGjE,MAAM,QAAQ,GAAG,+CAA+C,CAAC;AAEjE,SAAS,WAAW,CAAC,KAAc,EAAE,IAAY;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,MAAM,IAAI,cAAc,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,KAAc,EAAE,IAAY;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,cAAc,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,OAAsB,EAAE,IAAY;IAC3D,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC;IAC9C,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC;IAC9C,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC;IACtD,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,cAAc,CAAC,oCAAoC,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,cAAc,CAAC,uCAAuC,EAAE,GAAG,IAAI,aAAa,CAAC,CAAC;IAC1F,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,aAAa,CAAC,KAAgB;IAC5C,WAAW,CAAC,KAAK,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAChD,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,cAAc,CAAC,kDAAkD,EAAE,cAAc,CAAC,CAAC;IAC/F,CAAC;IACD,WAAW,CAAC,KAAK,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAChD,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAC1C,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClC,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE1C,KAAK,MAAM,GAAG,IAAI;QAChB,aAAa;QACb,WAAW;QACX,iBAAiB;QACjB,eAAe;QACf,QAAQ;QACR,UAAU;KACF,EAAE,CAAC;QACX,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,IAAI,cAAc,CAAC,0BAA0B,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,IAAI,cAAc,CAAC,4BAA4B,EAAE,eAAe,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3D,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAU,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;YACnB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,cAAc,CAAC,iCAAiC,EAAE,UAAU,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;IACH,CAAC;IAED,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAChD,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC;YAChD,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,IAAI,YAAY,CAAC,CAAC;QACpD,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;YACxC,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,IAAI,0BAA0B,CAAC,CAAC;gBAC9E,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,IAAI,2BAA2B,CAAC,CAAC;YAClF,CAAC;YACD,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;YACtD,IAAI,OAAO,KAAK,IAAI,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnG,MAAM,IAAI,cAAc,CAAC,kDAAkD,EAAE,GAAG,IAAI,mBAAmB,CAAC,CAAC;YAC3G,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,cAAc,CAAC,oCAAoC,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;QACjF,CAAC;QACD,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@ekwo-ai/xbrl-cbso",
+  "version": "0.4.0",
+  "description": "Generate XBRL annual accounts for the National Bank of Belgium (CBSO taxonomy, abridged model) — pure TypeScript, zero dependencies.",
+  "keywords": [
+    "xbrl",
+    "cbso",
+    "nbb",
+    "bnb",
+    "belgium",
+    "annual-accounts",
+    "jaarrekening",
+    "comptes-annuels",
+    "accounting",
+    "pcmn"
+  ],
+  "license": "MIT",
+  "author": "Ekwo AI",
+  "homepage": "https://github.com/Ekwo-ai/ekwo-os/tree/main/packages/formats/xbrl-cbso#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ekwo-ai/ekwo-os.git",
+    "directory": "packages/formats/xbrl-cbso"
+  },
+  "bugs": {
+    "url": "https://github.com/Ekwo-ai/ekwo-os/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./pcmn": {
+      "types": "./dist/pcmn/index.d.ts",
+      "import": "./dist/pcmn/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "example": "tsx examples/basic.ts",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "tsx": "^4.20.0",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  }
+}