@slashlab/numerik-js 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sqrcz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# numerik-js
+
+[![License](https://img.shields.io/github/license/sqrcz/numerik-js.svg)](LICENSE)
+[![Tests](https://github.com/sqrcz/numerik-js/actions/workflows/tests.yml/badge.svg)](https://github.com/sqrcz/numerik-js/actions/workflows/tests.yml)
+[![CodeRabbit](https://img.shields.io/coderabbit/prs/github/sqrcz/numerik-js)](https://coderabbit.ai)
+[![Bundle size](https://img.shields.io/bundlephobia/minzip/@slashlab/numerik-js)](https://bundlephobia.com/package/@slashlab/numerik-js)
+[![npm](https://img.shields.io/npm/v/@slashlab/numerik-js.svg)](https://www.npmjs.com/package/@slashlab/numerik-js)
+[![npm downloads](https://img.shields.io/npm/dm/@slashlab/numerik-js.svg)](https://www.npmjs.com/package/@slashlab/numerik-js)
+
+> Validate and parse Polish identification numbers — PESEL, NIP, REGON, KRS, NRB, VAT-EU, IBAN, ID Card, and Passport. Rich value objects, detailed error reasons, zero production dependencies. TypeScript-first.
+
+JavaScript/TypeScript port of [slashlab/numerik](https://github.com/sqrcz/numerik) (PHP).
+
+## Installation
+
+```bash
+npm install @slashlab/numerik-js
+# or
+pnpm add @slashlab/numerik-js
+```
+
+## Quick Start
+
+```ts
+import { Numerik } from '@slashlab/numerik-js'
+
+// Simple boolean check
+Numerik.pesel().isValid('92060512186')  // true
+Numerik.nip().isValid('5260250274')     // true
+
+// Rich validation result with failure reasons
+const result = Numerik.pesel().validate('92060512185')  // wrong checksum
+result.isFailed()                         // true
+result.getFirstFailure().reason           // ValidationFailureReason.InvalidChecksum
+
+// Parse to value object
+const pesel = Numerik.pesel().parse('92060512186')
+pesel.getBirthDate()    // Date object: 1992-06-05
+pesel.getGender()       // Gender.Female
+pesel.isAdult()         // true
+
+// Try-parse (returns null on failure instead of throwing)
+const parsed = Numerik.nip().tryParse('5260250274')
+parsed?.getFormatted()  // '526-025-02-74'
+```
+
+## Strict mode
+
+All identifiers accept an optional `strict` flag (default: `true`). In non-strict mode formatting variations (spaces, dashes) are accepted:
+
+```ts
+Numerik.nip(false).isValid('526 025 02 74')  // true
+Numerik.nip(true).isValid('526 025 02 74')   // false
+```
+
+## Zod integration
+
+```ts
+import { peselSchema, nipParseSchema } from '@slashlab/numerik-js/zod'
+import { z } from 'zod'
+
+const schema = z.object({
+  pesel: peselSchema(),           // validates, keeps string
+  nip: nipParseSchema(),          // validates and transforms to Nip value object
+})
+```
+
+## Supported identifiers
+
+| Group    | Identifier | Class                |
+| -------- | ---------- | -------------------- |
+| Personal | PESEL      | `PeselIdentifier`    |
+| Personal | ID Card    | `IdCardIdentifier`   |
+| Personal | Passport   | `PassportIdentifier` |
+| Tax      | NIP        | `NipIdentifier`      |
+| Tax      | VAT-EU     | `VatEuIdentifier`    |
+| Business | REGON      | `RegonIdentifier`    |
+| Business | KRS        | `KrsIdentifier`      |
+| Banking  | NRB        | `NrbIdentifier`      |
+| Banking  | IBAN       | `IbanIdentifier`     |
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Security
+
+See [SECURITY.md](SECURITY.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+If this saved you time → [☕ Buy me a coffee](https://buymeacoffee.com/sqrcz)

package/dist/VatEu-BNRumLqo.d.cts

@@ -0,0 +1,142 @@
+interface IdentifierInterface {
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+}
+
+declare enum Gender {
+    Male = "male",
+    Female = "female"
+}
+
+declare enum RegonType {
+    Individual = "individual",
+    LegalEntity = "legal_entity"
+}
+
+declare class Iban implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getCountryCode(): string;
+    getNrb(): string;
+    getCheckDigits(): string;
+    getSortCode(): string;
+    getBankCode(): string;
+    getAccountNumber(): string;
+}
+
+declare class IdCard implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getSeries(): string;
+    getSequentialNumber(): string;
+    getCheckDigit(): string;
+}
+
+declare class Krs implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getNumericValue(): number;
+}
+
+declare class Nip implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getFormattedAlternative(): string;
+    getTaxOfficeCode(): string;
+}
+
+declare class Nrb implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getIban(): string;
+    getFormattedIban(): string;
+    getCheckDigits(): string;
+    getSortCode(): string;
+    getBankCode(): string;
+    getAccountNumber(): string;
+}
+
+declare class Passport implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getSeries(): string;
+    getSequentialNumber(): string;
+    getCheckDigit(): string;
+}
+
+declare class Pesel implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    private readonly gender;
+    private readonly ordinalNumber;
+    constructor(raw: string, normalized: string, birthDate: Date, gender: Gender, ordinalNumber: number);
+    private readonly birthDate;
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getBirthDate(): Date;
+    getGender(): Gender;
+    getOrdinalNumber(): number;
+    isMale(): boolean;
+    isFemale(): boolean;
+    getAge(): number;
+    isAdult(): boolean;
+    getCentury(): number;
+}
+
+declare class Regon implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    private readonly type;
+    constructor(raw: string, normalized: string, type: RegonType);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getType(): RegonType;
+    getBaseRegon(): string;
+    getLocalUnitSuffix(): string | null;
+    isLocalUnit(): boolean;
+}
+
+declare class VatEu implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getCountryCode(): string;
+    getNip(): string;
+    getFormatted(): string;
+}
+
+export { Gender as G, type IdentifierInterface as I, Krs as K, Nip as N, Passport as P, Regon as R, VatEu as V, Iban as a, IdCard as b, Nrb as c, Pesel as d, RegonType as e };

package/dist/VatEu-BNRumLqo.d.ts

@@ -0,0 +1,142 @@
+interface IdentifierInterface {
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+}
+
+declare enum Gender {
+    Male = "male",
+    Female = "female"
+}
+
+declare enum RegonType {
+    Individual = "individual",
+    LegalEntity = "legal_entity"
+}
+
+declare class Iban implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getCountryCode(): string;
+    getNrb(): string;
+    getCheckDigits(): string;
+    getSortCode(): string;
+    getBankCode(): string;
+    getAccountNumber(): string;
+}
+
+declare class IdCard implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getSeries(): string;
+    getSequentialNumber(): string;
+    getCheckDigit(): string;
+}
+
+declare class Krs implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getNumericValue(): number;
+}
+
+declare class Nip implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getFormattedAlternative(): string;
+    getTaxOfficeCode(): string;
+}
+
+declare class Nrb implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getFormatted(): string;
+    getIban(): string;
+    getFormattedIban(): string;
+    getCheckDigits(): string;
+    getSortCode(): string;
+    getBankCode(): string;
+    getAccountNumber(): string;
+}
+
+declare class Passport implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getSeries(): string;
+    getSequentialNumber(): string;
+    getCheckDigit(): string;
+}
+
+declare class Pesel implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    private readonly gender;
+    private readonly ordinalNumber;
+    constructor(raw: string, normalized: string, birthDate: Date, gender: Gender, ordinalNumber: number);
+    private readonly birthDate;
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getBirthDate(): Date;
+    getGender(): Gender;
+    getOrdinalNumber(): number;
+    isMale(): boolean;
+    isFemale(): boolean;
+    getAge(): number;
+    isAdult(): boolean;
+    getCentury(): number;
+}
+
+declare class Regon implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    private readonly type;
+    constructor(raw: string, normalized: string, type: RegonType);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getType(): RegonType;
+    getBaseRegon(): string;
+    getLocalUnitSuffix(): string | null;
+    isLocalUnit(): boolean;
+}
+
+declare class VatEu implements IdentifierInterface {
+    private readonly raw;
+    private readonly normalized;
+    constructor(raw: string, normalized: string);
+    getRaw(): string;
+    getNormalized(): string;
+    toString(): string;
+    getCountryCode(): string;
+    getNip(): string;
+    getFormatted(): string;
+}
+
+export { Gender as G, type IdentifierInterface as I, Krs as K, Nip as N, Passport as P, Regon as R, VatEu as V, Iban as a, IdCard as b, Nrb as c, Pesel as d, RegonType as e };