validator-tax-id 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# Tax ID Validator
+
+A lightweight, zero-dependency, and universal TypeScript library to validate Tax IDs (Identification Numbers)
+
+It uses precise mathematical algorithms to verify the integrity of the document number and follow guides of the country goberments
+
+## Features
+
+- 🚀 **Lightweight:** Zero external dependencies.
+- 🔒 **Type-Safe:** Written in TypeScript with full type definitions.
+- 🌍 **Universal:** Works in Node.js, React, Vue, Next.js, and Browsers (Legacy Script Tag).
+- ⚡ **Tree-shakeable:** Only import what you need (if using advanced exports).
+
+## Installation
+
+```bash
+npm install tax-id-validator
+# or
+yarn add tax-id-validator
+# or
+pnpm add tax-id-validator
+```
+
+## Usage
+
+### Basic Usage
+
+The main function `validateIdentification` takes two arguments: the **country code** (ISO 3166-1 alpha-2) and the **value** to validate.
+
+```typescript
+import { validateIdentification } from "tax-id-validator";
+
+// 🇪🇸 Spain (ES)
+// Validates DNI (8 digits + letter)
+const isDniValid = validateIdentification("es", "12345678Z"); // true
+
+// Validates NIE (X/Y/Z + 7 digits + letter)
+const isNieValid = validateIdentification("es", "X1234567L"); // true
+
+// 🇵🇹 Portugal (PT)
+// Validates NIF (9 digits with checksum)
+const isNifValid = validateIdentification("pt", "232013969"); // true
+```
+
+## API Reference
+
+### `validateIdentification(country, value)`
+
+- **country**: `CountryCode` ('es' | 'pt') - The ISO code of the country.
+- **value**: `string` | `any` - The document string to validate.
+- **Returns**: `boolean` (`true` if valid, `false` otherwise).
+
+_Note: The validator sanitizes the input automatically (removes spaces, hyphens, and is case-insensitive)._
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,25 @@
+"use strict";var s=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var m=(e,t)=>{for(var o in t)s(e,o,{get:t[o],enumerable:!0})},g=(e,t,o,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of u(t))!y.call(e,r)&&r!==o&&s(e,r,{get:()=>t[r],enumerable:!(n=d(t,r))||n.enumerable});return e};var x=e=>g(s({},"__esModule",{value:!0}),e);var T={};m(T,{validateIdentification:()=>I});module.exports=x(T);var C="TRWAGMYFPDXBNJZSQVHLCKE";var l=e=>{if(typeof e!="string")return!1;let t=e.toUpperCase().replace(/\s|-/g,"");if(!/^([0-9]{8}|[XYZ][0-9]{7})[A-Z]$/.test(t))return!1;let n=t.slice(0,-1),r=t.slice(-1);n=n.replace("X","0").replace("Y","1").replace("Z","2");let a=parseInt(n,10);return C[a%23]===r};var i=e=>{if(typeof e!="string")return!1;let t=e.replace(/\s|-/g,"");if(!/^[0-9]{9}$/.test(t))return!1;let r=11-t.slice(0,8).split("").reduce((a,c,p)=>{let f=9-p;return a+parseInt(c,10)*f},0)%11;return r>=10&&(r=0),r===parseInt(t[8],10)};var v={es:l,pt:i};var I=(e,t)=>{let o=v[e];return o?o(t):(console.warn(`[TaxIDValidator] Country '${e}' not supported yet.`),!1)};0&&(module.exports={validateIdentification});
+/**
+ * Validate Spanish DNI/NIE numbers.
+ * @param value - The DNI or NIE number to validate
+ * @returns boolean indicating whether the DNI/NIE is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/dni/calculo-del-digito-de-control-del-nif-nie/
+ */
+/**
+ * Validates a Portuguese NIF (Número de Identificação Fiscal).
+ * @param value - The NIF number to validate
+ * @returns boolean indicating whether the NIF is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://en.wikipedia.org/wiki/Tax_identification_number#Portugal
+ */
+/**
+ * Function to validate identification numbers based on country/type.
+ * @param Country - The country code representing the type of identification number (e.g., 'es' for Spain, 'pt' for Portugal)
+ * @param value - The identification number to validate
+ * @returns boolean indicating whether the identification number is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ */

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+declare const validators: {
+    es: (value: any) => boolean;
+    pt: (value: any) => boolean;
+};
+type CountryCode = keyof typeof validators;
+/**
+ * Function to validate identification numbers based on country/type.
+ * @param Country - The country code representing the type of identification number (e.g., 'es' for Spain, 'pt' for Portugal)
+ * @param value - The identification number to validate
+ * @returns boolean indicating whether the identification number is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ */
+declare const validateIdentification: (country: CountryCode, value: any) => boolean;
+
+export { type CountryCode, validateIdentification };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+declare const validators: {
+    es: (value: any) => boolean;
+    pt: (value: any) => boolean;
+};
+type CountryCode = keyof typeof validators;
+/**
+ * Function to validate identification numbers based on country/type.
+ * @param Country - The country code representing the type of identification number (e.g., 'es' for Spain, 'pt' for Portugal)
+ * @param value - The identification number to validate
+ * @returns boolean indicating whether the identification number is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ */
+declare const validateIdentification: (country: CountryCode, value: any) => boolean;
+
+export { type CountryCode, validateIdentification };

package/dist/index.global.js

@@ -0,0 +1,25 @@
+"use strict";var TaxIdValidator=(()=>{var s=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var m=(e,t)=>{for(var o in t)s(e,o,{get:t[o],enumerable:!0})},g=(e,t,o,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of u(t))!y.call(e,r)&&r!==o&&s(e,r,{get:()=>t[r],enumerable:!(n=d(t,r))||n.enumerable});return e};var x=e=>g(s({},"__esModule",{value:!0}),e);var T={};m(T,{validateIdentification:()=>I});var C="TRWAGMYFPDXBNJZSQVHLCKE";var l=e=>{if(typeof e!="string")return!1;let t=e.toUpperCase().replace(/\s|-/g,"");if(!/^([0-9]{8}|[XYZ][0-9]{7})[A-Z]$/.test(t))return!1;let n=t.slice(0,-1),r=t.slice(-1);n=n.replace("X","0").replace("Y","1").replace("Z","2");let a=parseInt(n,10);return C[a%23]===r};var i=e=>{if(typeof e!="string")return!1;let t=e.replace(/\s|-/g,"");if(!/^[0-9]{9}$/.test(t))return!1;let r=11-t.slice(0,8).split("").reduce((a,c,p)=>{let f=9-p;return a+parseInt(c,10)*f},0)%11;return r>=10&&(r=0),r===parseInt(t[8],10)};var v={es:l,pt:i};var I=(e,t)=>{let o=v[e];return o?o(t):(console.warn(`[TaxIDValidator] Country '${e}' not supported yet.`),!1)};return x(T);})();
+/**
+ * Validate Spanish DNI/NIE numbers.
+ * @param value - The DNI or NIE number to validate
+ * @returns boolean indicating whether the DNI/NIE is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/dni/calculo-del-digito-de-control-del-nif-nie/
+ */
+/**
+ * Validates a Portuguese NIF (Número de Identificação Fiscal).
+ * @param value - The NIF number to validate
+ * @returns boolean indicating whether the NIF is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://en.wikipedia.org/wiki/Tax_identification_number#Portugal
+ */
+/**
+ * Function to validate identification numbers based on country/type.
+ * @param Country - The country code representing the type of identification number (e.g., 'es' for Spain, 'pt' for Portugal)
+ * @param value - The identification number to validate
+ * @returns boolean indicating whether the identification number is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ */

package/dist/index.js

@@ -0,0 +1,25 @@
+var f="TRWAGMYFPDXBNJZSQVHLCKE";var s=e=>{if(typeof e!="string")return!1;let t=e.toUpperCase().replace(/\s|-/g,"");if(!/^([0-9]{8}|[XYZ][0-9]{7})[A-Z]$/.test(t))return!1;let n=t.slice(0,-1),r=t.slice(-1);n=n.replace("X","0").replace("Y","1").replace("Z","2");let a=parseInt(n,10);return f[a%23]===r};var l=e=>{if(typeof e!="string")return!1;let t=e.replace(/\s|-/g,"");if(!/^[0-9]{9}$/.test(t))return!1;let r=11-t.slice(0,8).split("").reduce((a,i,c)=>{let p=9-c;return a+parseInt(i,10)*p},0)%11;return r>=10&&(r=0),r===parseInt(t[8],10)};var d={es:s,pt:l};var x=(e,t)=>{let o=d[e];return o?o(t):(console.warn(`[TaxIDValidator] Country '${e}' not supported yet.`),!1)};export{x as validateIdentification};
+/**
+ * Validate Spanish DNI/NIE numbers.
+ * @param value - The DNI or NIE number to validate
+ * @returns boolean indicating whether the DNI/NIE is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/dni/calculo-del-digito-de-control-del-nif-nie/
+ */
+/**
+ * Validates a Portuguese NIF (Número de Identificação Fiscal).
+ * @param value - The NIF number to validate
+ * @returns boolean indicating whether the NIF is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ * @documentation https://en.wikipedia.org/wiki/Tax_identification_number#Portugal
+ */
+/**
+ * Function to validate identification numbers based on country/type.
+ * @param Country - The country code representing the type of identification number (e.g., 'es' for Spain, 'pt' for Portugal)
+ * @param value - The identification number to validate
+ * @returns boolean indicating whether the identification number is valid (true) or not (false)
+ * @author AngelBlanco97
+ * @license MIT
+ */

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "validator-tax-id",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.17"
+  }
+}