fi-pin 0.0.6 → 0.0.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Marko Harjula
-
-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.
+MIT License
+
+Copyright (c) 2017 Marko Harjula
+
+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

@@ -1,19 +1,101 @@
-### Finnish Person ID check [![Build Status](https://travis-ci.org/mharj/hetu.svg?branch=master)](https://travis-ci.org/mharj/hetu) [![Maintainability](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/maintainability)](https://codeclimate.com/github/mharj/hetu/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/test_coverage)](https://codeclimate.com/github/mharj/hetu/test_coverage)
+# Finnish Person ID Check
 
-```javascript
-const {isFemale, isMale, isValidPersonId} = require('fi-pin');
+![github action](https://github.com/mharj/hetu/actions/workflows/main.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/maintainability)](https://codeclimate.com/github/mharj/hetu/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/test_coverage)](https://codeclimate.com/github/mharj/hetu/test_coverage)
 
-if (isValidPersonId('131052-308T')) {
-	console.log('male', isMale('131052-308T'));
-	console.log('female', isFemale('131052-308T'));
-}
+## Overview
+
+This module provides functions to validate Finnish person IDs (Henkilötunnus) and determine the gender based on the ID. A valid Finnish person ID consists of 11 characters in the format `DDMMYYCZZZQ`, where:
+
+- `DDMMYY` represents the date of birth
+- `C` is the century sign ('+' for 1800s, '-' for 1900s, 'A' for 2000s)
+- `ZZZ` is an individual number (odd numbers are males, even numbers are females)
+- `Q` is a checksum character
+
+## Installation
+
+```bash
+npm install fi-pin
 ```
 
+## Usage
+
 ```typescript
-import {isFemale, isMale, isValidPersonId} from 'fi-pin';
+const personId = '131052-308T';
 
-if (isValidPersonId('131052-308T')) {
-	console.log('male', isMale('131052-308T'));
-	console.log('female', isFemale('131052-308T'));
+if (isValidPersonId(personId)) {
+	console.log('male', isMale(personId));
+	console.log('female', isFemale(personId));
 }
+
+// functions can also be extended with branded types to narrow down the type guard of the personId (as example with zod BRAND)
+if (isValidPersonId<z.BRAND<'PersonID'>>(personId)) {
+	// personId is typed as: string & z.BRAND<'PersonID'>
+	if (isMale<z.BRAND<'MalePersonID'>>(personId)) {
+		// personId is typed as: string & z.BRAND<'PersonID'> & z.BRAND<'MalePersonID'>
+	}
+	if (isFemale<z.BRAND<'FemalePersonID'>>(personId)) {
+		// personId is typed as: string & z.BRAND<'PersonID'> & z.BRAND<'FemalePersonID'>
+	}
+}
+```
+
+## Functions
+
+### `isValidPersonId<BRAND = string>(personId: string): personId is string & BRAND`
+
+Validates if the provided string is a valid Finnish person ID.
+
+**Parameters:**
+
+- `personId` - The person ID string to validate
+
+**Returns:**
+
+- `true` if the person ID is valid, `false` otherwise
+
+**Example:**
+
+```javascript
+isValidPersonId('131052-308T'); // true
+isValidPersonId('131052-3082'); // false
+```
+
+### `isMale<BRAND = string>(personId: string): personId is string & BRAND`
+
+Checks if the provided Finnish person ID belongs to a male.
+
+**Parameters:**
+
+- `personId` - The Finnish person ID string
+
+**Returns:**
+
+- `true` if the person ID belongs to a male, `false` otherwise
+
+**Example:**
+
+```javascript
+isMale('131052-309U'); // true
+isMale('131052-308T'); // false
+```
+
+### `isFemale<BRAND = string>(personId: string): personId is string & BRAND`
+
+Checks if the provided Finnish person ID belongs to a female.
+
+**Parameters:**
+
+- `personId` - The Finnish person ID string
+
+**Returns:**
+
+- `true` if the person ID belongs to a female, `false` otherwise
+
+**Example:**
+
+```javascript
+isFemale('131052-308T'); // true
+isFemale('131052-309U'); // false
 ```

package/dist/index.d.mts

@@ -1,29 +1,71 @@
 /**
- * Validate if string is a valid personId
- * @param personId - personId string
- * @returns true if valid, false if not
+ * Parse string to integer
+ * @throws TypeError if value is not a number
+ * @param value - string to parse
+ * @returns value as number
+ */
+declare function parseStringToInt(value: string | undefined): number;
+/**
+ * Validate that value is a string
+ * @throws TypeError if value is not a string
+ * @param value - value to validate
+ * @returns value as string
+ */
+declare function validateString(value: unknown): string;
+/**
+ * Get checksum for check sum index number
+ * @param index - index number to lookup checksum character
+ * @returns checksum character from checksum index map
+ */
+declare function getCheckSum(index: number): string | undefined;
+/**
+ * Validate if a string is a valid Finnish person ID
+ *
+ * A valid Finnish person ID consists of 11 characters in the format DDMMYYCZZZQ, where:
+ * - DDMMYY represents the date of birth
+ * - C is the century sign ('+' for 1800s, '-' for 1900s, 'A' for 2000s)
+ * - ZZZ is an individual number (odd numbers are males, even numbers are females)
+ * - Q is a checksum character
+ *
+ * The checksum character is calculated based on the first 10 characters.
+ * @param personId - The person ID string to validate
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the person ID is valid, false otherwise
  * @example
  * isValidPersonId('131052-308T') // true
  * isValidPersonId('131052-3082') // false
+ * const personId = '131052-308T';
+ * if(isValidPersonId<z.BRAND<'PersonID'>>(personId)) { // personId type is now: string & z.BRAND<'PersonID'>
+ *   // personId type is now: string & z.BRAND<'PersonID'>
+ * }
+ * @since v0.0.1
  */
-declare function isValidPersonId(personId: string): boolean;
+declare function isValidPersonId<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId is for male
+ * Check if personId belongs to a Finnish male
  * @throws TypeError if personId is not valid
- * @param personId - personId string
- * @returns true if valid, false if not
+ * @param personId - Finnish personId string
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the personId belongs to a male, false otherwise
  * @example
+ * isMale('131052-309U') // true
  * isMale('131052-308T') // false
+ * isMale<z.BRAND<'PersonIdMale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdMale'>
+ * @since v0.0.1
  */
-declare function isMale(personId: string): boolean;
+declare function isMale<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId is for female
+ * Check if personId belongs to a Finnish female
  * @throws TypeError if personId is not valid
- * @param personId - personId string
- * @returns true if valid, false if not
+ * @param personId - Finnish personId string
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the personId belongs to a female, false otherwise
  * @example
  * isFemale('131052-308T') // true
+ * isFemale('131052-309U') // false
+ * isFemale<z.BRAND<'PersonIdFemale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdFemale'>
+ * @since v0.0.1
  */
-declare function isFemale(personId: string): boolean;
+declare function isFemale<BRAND = string>(personId: string): personId is string & BRAND;
 
-export { isFemale, isMale, isValidPersonId };
+export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };

package/dist/index.d.ts

@@ -1,29 +1,71 @@
 /**
- * Validate if string is a valid personId
- * @param personId - personId string
- * @returns true if valid, false if not
+ * Parse string to integer
+ * @throws TypeError if value is not a number
+ * @param value - string to parse
+ * @returns value as number
+ */
+declare function parseStringToInt(value: string | undefined): number;
+/**
+ * Validate that value is a string
+ * @throws TypeError if value is not a string
+ * @param value - value to validate
+ * @returns value as string
+ */
+declare function validateString(value: unknown): string;
+/**
+ * Get checksum for check sum index number
+ * @param index - index number to lookup checksum character
+ * @returns checksum character from checksum index map
+ */
+declare function getCheckSum(index: number): string | undefined;
+/**
+ * Validate if a string is a valid Finnish person ID
+ *
+ * A valid Finnish person ID consists of 11 characters in the format DDMMYYCZZZQ, where:
+ * - DDMMYY represents the date of birth
+ * - C is the century sign ('+' for 1800s, '-' for 1900s, 'A' for 2000s)
+ * - ZZZ is an individual number (odd numbers are males, even numbers are females)
+ * - Q is a checksum character
+ *
+ * The checksum character is calculated based on the first 10 characters.
+ * @param personId - The person ID string to validate
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the person ID is valid, false otherwise
  * @example
  * isValidPersonId('131052-308T') // true
  * isValidPersonId('131052-3082') // false
+ * const personId = '131052-308T';
+ * if(isValidPersonId<z.BRAND<'PersonID'>>(personId)) { // personId type is now: string & z.BRAND<'PersonID'>
+ *   // personId type is now: string & z.BRAND<'PersonID'>
+ * }
+ * @since v0.0.1
  */
-declare function isValidPersonId(personId: string): boolean;
+declare function isValidPersonId<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId is for male
+ * Check if personId belongs to a Finnish male
  * @throws TypeError if personId is not valid
- * @param personId - personId string
- * @returns true if valid, false if not
+ * @param personId - Finnish personId string
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the personId belongs to a male, false otherwise
  * @example
+ * isMale('131052-309U') // true
  * isMale('131052-308T') // false
+ * isMale<z.BRAND<'PersonIdMale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdMale'>
+ * @since v0.0.1
  */
-declare function isMale(personId: string): boolean;
+declare function isMale<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId is for female
+ * Check if personId belongs to a Finnish female
  * @throws TypeError if personId is not valid
- * @param personId - personId string
- * @returns true if valid, false if not
+ * @param personId - Finnish personId string
+ * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)
+ * @returns true if the personId belongs to a female, false otherwise
  * @example
  * isFemale('131052-308T') // true
+ * isFemale('131052-309U') // false
+ * isFemale<z.BRAND<'PersonIdFemale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdFemale'>
+ * @since v0.0.1
  */
-declare function isFemale(personId: string): boolean;
+declare function isFemale<BRAND = string>(personId: string): personId is string & BRAND;
 
-export { isFemale, isMale, isValidPersonId };
+export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };

package/dist/index.js

@@ -20,67 +20,65 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  getCheckSum: () => getCheckSum,
   isFemale: () => isFemale,
   isMale: () => isMale,
-  isValidPersonId: () => isValidPersonId
+  isValidPersonId: () => isValidPersonId,
+  parseStringToInt: () => parseStringToInt,
+  validateString: () => validateString
 });
 module.exports = __toCommonJS(src_exports);
-var c = "0123456789ABCDEFHJKLMNPRSTUVWXY";
-function toInt(value) {
+var checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+var checkSumMapLength = checksumCharacterSet.length;
+function parseStringToInt(value) {
   if (!value) {
-    throw new TypeError("undefined");
+    throw new TypeError("Value is undefined");
   }
-  const outValue = parseInt(value, 10);
-  if (isNaN(outValue)) {
-    throw new TypeError(`${value} not a number`);
+  const parsedValue = parseInt(value, 10);
+  if (isNaN(parsedValue)) {
+    throw new TypeError(`Value is not a number: ${value}`);
   }
-  return outValue;
+  return parsedValue;
 }
-function getString(value) {
+function validateString(value) {
   if (typeof value !== "string") {
-    throw new TypeError(`${JSON.stringify(value)} not a string`);
+    throw new TypeError(`${String(value)} not a string`);
   }
   return value;
 }
-function buildCheckSum(num) {
-  return c[num];
-}
-function buildCcValues(personId) {
-  return [
-    getString(personId[0]),
-    getString(personId[1]),
-    getString(personId[2]),
-    getString(personId[3]),
-    getString(personId[4]),
-    getString(personId[5]),
-    getString(personId[6]),
-    getString(personId[7]),
-    getString(personId[8]),
-    getString(personId[9]),
-    getString(personId[10])
-  ];
+function getCheckSum(index) {
+  if (index < 0 || index >= checkSumMapLength) {
+    throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
+  }
+  return checksumCharacterSet[index];
 }
 function isValidPersonId(personId) {
-  if (personId.length !== 11) {
+  if (typeof personId !== "string" || personId.length !== 11) {
+    return false;
+  }
+  const upperPersonId = personId.toUpperCase();
+  try {
+    return upperPersonId[10] === getCheckSum(parseStringToInt(upperPersonId.slice(0, 6) + upperPersonId.slice(7, 10)) % checkSumMapLength);
+  } catch (_error) {
     return false;
   }
-  const d = buildCcValues(personId.toUpperCase());
-  return d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);
 }
 function isMale(personId) {
   if (!isValidPersonId(personId)) {
-    throw new TypeError("not valid person id");
+    throw new TypeError(`${String(personId)} is not valid person id`);
   }
-  const d = buildCcValues(personId);
-  return toInt(d[7] + d[8] + d[9]) % 2 === 1;
+  return parseStringToInt(personId.slice(7, 10)) % 2 === 1;
 }
 function isFemale(personId) {
   return !isMale(personId);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getCheckSum,
   isFemale,
   isMale,
-  isValidPersonId
+  isValidPersonId,
+  parseStringToInt,
+  validateString
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const c = '0123456789ABCDEFHJKLMNPRSTUVWXY';\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value\n * @returns value as number\n */\nfunction toInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('undefined');\n\t}\n\tconst outValue = parseInt(value, 10);\n\tif (isNaN(outValue)) {\n\t\tthrow new TypeError(`${value} not a number`);\n\t}\n\treturn outValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value\n * @returns value as string\n */\nfunction getString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${JSON.stringify(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Build checksum for personId (last character)\n * @param num - number to build checksum from\n * @returns checksum character\n */\nfunction buildCheckSum(num: number): string | undefined {\n\treturn c[num];\n}\n\n/**\n * Construct array of string values from personId string\n * @param personId - personId string\n * @returns\n */\nfunction buildCcValues(personId: string): [string, string, string, string, string, string, string, string, string, string, string] {\n\treturn [\n\t\tgetString(personId[0]),\n\t\tgetString(personId[1]),\n\t\tgetString(personId[2]),\n\t\tgetString(personId[3]),\n\t\tgetString(personId[4]),\n\t\tgetString(personId[5]),\n\t\tgetString(personId[6]),\n\t\tgetString(personId[7]),\n\t\tgetString(personId[8]),\n\t\tgetString(personId[9]),\n\t\tgetString(personId[10]),\n\t];\n}\n\n/**\n * Validate if string is a valid personId\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n */\nexport function isValidPersonId(personId: string): boolean {\n\tif (personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst d = buildCcValues(personId.toUpperCase());\n\treturn d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);\n}\n\n/**\n * Check if personId is for male\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isMale('131052-308T') // false\n */\nexport function isMale(personId: string): boolean {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError('not valid person id');\n\t}\n\tconst d = buildCcValues(personId);\n\treturn toInt(d[7] + d[8] + d[9]) % 2 === 1;\n}\n\n/**\n * Check if personId is for female\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isFemale('131052-308T') // true\n */\nexport function isFemale(personId: string): boolean {\n\treturn !isMale(personId);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAM,IAAI;AAQV,SAAS,MAAM,OAAmC;AACjD,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,WAAW;AAAA,EAChC;AACA,QAAM,WAAW,SAAS,OAAO,EAAE;AACnC,MAAI,MAAM,QAAQ,GAAG;AACpB,UAAM,IAAI,UAAU,GAAG,KAAK,eAAe;AAAA,EAC5C;AACA,SAAO;AACR;AAQA,SAAS,UAAU,OAAwB;AAC1C,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,KAAK,UAAU,KAAK,CAAC,eAAe;AAAA,EAC5D;AACA,SAAO;AACR;AAOA,SAAS,cAAc,KAAiC;AACvD,SAAO,EAAE,GAAG;AACb;AAOA,SAAS,cAAc,UAA4G;AAClI,SAAO;AAAA,IACN,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,EAAE,CAAC;AAAA,EACvB;AACD;AAUO,SAAS,gBAAgB,UAA2B;AAC1D,MAAI,SAAS,WAAW,IAAI;AAC3B,WAAO;AAAA,EACR;AACA,QAAM,IAAI,cAAc,SAAS,YAAY,CAAC;AAC9C,SAAO,EAAE,EAAE,MAAM,cAAc,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;AACxG;AAUO,SAAS,OAAO,UAA2B;AACjD,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,qBAAqB;AAAA,EAC1C;AACA,QAAM,IAAI,cAAc,QAAQ;AAChC,SAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM;AAC1C;AAUO,SAAS,SAAS,UAA2B;AACnD,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const checksumCharacterSet = '0123456789ABCDEFHJKLMNPRSTUVWXY';\nconst checkSumMapLength = checksumCharacterSet.length; // is always 31\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value - string to parse\n * @returns value as number\n */\nexport function parseStringToInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('Value is undefined');\n\t}\n\tconst parsedValue = parseInt(value, 10);\n\tif (isNaN(parsedValue)) {\n\t\tthrow new TypeError(`Value is not a number: ${value}`);\n\t}\n\treturn parsedValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value - value to validate\n * @returns value as string\n */\nexport function validateString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${String(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Get checksum for check sum index number\n * @param index - index number to lookup checksum character\n * @returns checksum character from checksum index map\n */\nexport function getCheckSum(index: number): string | undefined {\n\tif (index < 0 || index >= checkSumMapLength) {\n\t\tthrow new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);\n\t}\n\treturn checksumCharacterSet[index];\n}\n\n/**\n * Validate if a string is a valid Finnish person ID\n *\n * A valid Finnish person ID consists of 11 characters in the format DDMMYYCZZZQ, where:\n * - DDMMYY represents the date of birth\n * - C is the century sign ('+' for 1800s, '-' for 1900s, 'A' for 2000s)\n * - ZZZ is an individual number (odd numbers are males, even numbers are females)\n * - Q is a checksum character\n *\n * The checksum character is calculated based on the first 10 characters.\n * @param personId - The person ID string to validate\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the person ID is valid, false otherwise\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n * const personId = '131052-308T';\n * if(isValidPersonId<z.BRAND<'PersonID'>>(personId)) { // personId type is now: string & z.BRAND<'PersonID'>\n *   // personId type is now: string & z.BRAND<'PersonID'>\n * }\n * @since v0.0.1\n */\nexport function isValidPersonId<BRAND = string>(personId: string): personId is string & BRAND {\n\tif (typeof personId !== 'string' || personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst upperPersonId = personId.toUpperCase();\n\ttry {\n\t\treturn upperPersonId[10] === getCheckSum(parseStringToInt(upperPersonId.slice(0, 6) + upperPersonId.slice(7, 10)) % checkSumMapLength);\n\t} catch (_error) {\n\t\treturn false;\n\t}\n}\n\n/**\n * Check if personId belongs to a Finnish male\n * @throws TypeError if personId is not valid\n * @param personId - Finnish personId string\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the personId belongs to a male, false otherwise\n * @example\n * isMale('131052-309U') // true\n * isMale('131052-308T') // false\n * isMale<z.BRAND<'PersonIdMale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdMale'>\n * @since v0.0.1\n */\nexport function isMale<BRAND = string>(personId: string): personId is string & BRAND {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError(`${String(personId)} is not valid person id`);\n\t}\n\treturn parseStringToInt(personId.slice(7, 10)) % 2 === 1; // check if the individual number is odd\n}\n\n/**\n * Check if personId belongs to a Finnish female\n * @throws TypeError if personId is not valid\n * @param personId - Finnish personId string\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the personId belongs to a female, false otherwise\n * @example\n * isFemale('131052-308T') // true\n * isFemale('131052-309U') // false\n * isFemale<z.BRAND<'PersonIdFemale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdFemale'>\n * @since v0.0.1\n */\nexport function isFemale<BRAND = string>(personId: string): personId is string & BRAND {\n\treturn !isMale(personId);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAM,uBAAuB;AAC7B,IAAM,oBAAoB,qBAAqB;AAQxC,SAAS,iBAAiB,OAAmC;AACnE,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,oBAAoB;AAAA,EACzC;AACA,QAAM,cAAc,SAAS,OAAO,EAAE;AACtC,MAAI,MAAM,WAAW,GAAG;AACvB,UAAM,IAAI,UAAU,0BAA0B,KAAK,EAAE;AAAA,EACtD;AACA,SAAO;AACR;AAQO,SAAS,eAAe,OAAwB;AACtD,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,OAAO,KAAK,CAAC,eAAe;AAAA,EACpD;AACA,SAAO;AACR;AAOO,SAAS,YAAY,OAAmC;AAC9D,MAAI,QAAQ,KAAK,SAAS,mBAAmB;AAC5C,UAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,CAAC,oBAAoB,OAAO,oBAAoB,CAAC,CAAC,GAAG;AAAA,EAClH;AACA,SAAO,qBAAqB,KAAK;AAClC;AAwBO,SAAS,gBAAgC,UAA8C;AAC7F,MAAI,OAAO,aAAa,YAAY,SAAS,WAAW,IAAI;AAC3D,WAAO;AAAA,EACR;AACA,QAAM,gBAAgB,SAAS,YAAY;AAC3C,MAAI;AACH,WAAO,cAAc,EAAE,MAAM,YAAY,iBAAiB,cAAc,MAAM,GAAG,CAAC,IAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAAI,iBAAiB;AAAA,EACtI,SAAS,QAAQ;AAChB,WAAO;AAAA,EACR;AACD;AAcO,SAAS,OAAuB,UAA8C;AACpF,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,GAAG,OAAO,QAAQ,CAAC,yBAAyB;AAAA,EACjE;AACA,SAAO,iBAAiB,SAAS,MAAM,GAAG,EAAE,CAAC,IAAI,MAAM;AACxD;AAcO,SAAS,SAAyB,UAA8C;AACtF,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}

package/dist/index.mjs

@@ -1,59 +1,54 @@
 // src/index.ts
-var c = "0123456789ABCDEFHJKLMNPRSTUVWXY";
-function toInt(value) {
+var checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+var checkSumMapLength = checksumCharacterSet.length;
+function parseStringToInt(value) {
   if (!value) {
-    throw new TypeError("undefined");
+    throw new TypeError("Value is undefined");
   }
-  const outValue = parseInt(value, 10);
-  if (isNaN(outValue)) {
-    throw new TypeError(`${value} not a number`);
+  const parsedValue = parseInt(value, 10);
+  if (isNaN(parsedValue)) {
+    throw new TypeError(`Value is not a number: ${value}`);
   }
-  return outValue;
+  return parsedValue;
 }
-function getString(value) {
+function validateString(value) {
   if (typeof value !== "string") {
-    throw new TypeError(`${JSON.stringify(value)} not a string`);
+    throw new TypeError(`${String(value)} not a string`);
   }
   return value;
 }
-function buildCheckSum(num) {
-  return c[num];
-}
-function buildCcValues(personId) {
-  return [
-    getString(personId[0]),
-    getString(personId[1]),
-    getString(personId[2]),
-    getString(personId[3]),
-    getString(personId[4]),
-    getString(personId[5]),
-    getString(personId[6]),
-    getString(personId[7]),
-    getString(personId[8]),
-    getString(personId[9]),
-    getString(personId[10])
-  ];
+function getCheckSum(index) {
+  if (index < 0 || index >= checkSumMapLength) {
+    throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
+  }
+  return checksumCharacterSet[index];
 }
 function isValidPersonId(personId) {
-  if (personId.length !== 11) {
+  if (typeof personId !== "string" || personId.length !== 11) {
+    return false;
+  }
+  const upperPersonId = personId.toUpperCase();
+  try {
+    return upperPersonId[10] === getCheckSum(parseStringToInt(upperPersonId.slice(0, 6) + upperPersonId.slice(7, 10)) % checkSumMapLength);
+  } catch (_error) {
     return false;
   }
-  const d = buildCcValues(personId.toUpperCase());
-  return d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);
 }
 function isMale(personId) {
   if (!isValidPersonId(personId)) {
-    throw new TypeError("not valid person id");
+    throw new TypeError(`${String(personId)} is not valid person id`);
   }
-  const d = buildCcValues(personId);
-  return toInt(d[7] + d[8] + d[9]) % 2 === 1;
+  return parseStringToInt(personId.slice(7, 10)) % 2 === 1;
 }
 function isFemale(personId) {
   return !isMale(personId);
 }
 export {
+  getCheckSum,
   isFemale,
   isMale,
-  isValidPersonId
+  isValidPersonId,
+  parseStringToInt,
+  validateString
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const c = '0123456789ABCDEFHJKLMNPRSTUVWXY';\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value\n * @returns value as number\n */\nfunction toInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('undefined');\n\t}\n\tconst outValue = parseInt(value, 10);\n\tif (isNaN(outValue)) {\n\t\tthrow new TypeError(`${value} not a number`);\n\t}\n\treturn outValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value\n * @returns value as string\n */\nfunction getString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${JSON.stringify(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Build checksum for personId (last character)\n * @param num - number to build checksum from\n * @returns checksum character\n */\nfunction buildCheckSum(num: number): string | undefined {\n\treturn c[num];\n}\n\n/**\n * Construct array of string values from personId string\n * @param personId - personId string\n * @returns\n */\nfunction buildCcValues(personId: string): [string, string, string, string, string, string, string, string, string, string, string] {\n\treturn [\n\t\tgetString(personId[0]),\n\t\tgetString(personId[1]),\n\t\tgetString(personId[2]),\n\t\tgetString(personId[3]),\n\t\tgetString(personId[4]),\n\t\tgetString(personId[5]),\n\t\tgetString(personId[6]),\n\t\tgetString(personId[7]),\n\t\tgetString(personId[8]),\n\t\tgetString(personId[9]),\n\t\tgetString(personId[10]),\n\t];\n}\n\n/**\n * Validate if string is a valid personId\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n */\nexport function isValidPersonId(personId: string): boolean {\n\tif (personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst d = buildCcValues(personId.toUpperCase());\n\treturn d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);\n}\n\n/**\n * Check if personId is for male\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isMale('131052-308T') // false\n */\nexport function isMale(personId: string): boolean {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError('not valid person id');\n\t}\n\tconst d = buildCcValues(personId);\n\treturn toInt(d[7] + d[8] + d[9]) % 2 === 1;\n}\n\n/**\n * Check if personId is for female\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isFemale('131052-308T') // true\n */\nexport function isFemale(personId: string): boolean {\n\treturn !isMale(personId);\n}\n"],"mappings":";AAAA,IAAM,IAAI;AAQV,SAAS,MAAM,OAAmC;AACjD,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,WAAW;AAAA,EAChC;AACA,QAAM,WAAW,SAAS,OAAO,EAAE;AACnC,MAAI,MAAM,QAAQ,GAAG;AACpB,UAAM,IAAI,UAAU,GAAG,KAAK,eAAe;AAAA,EAC5C;AACA,SAAO;AACR;AAQA,SAAS,UAAU,OAAwB;AAC1C,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,KAAK,UAAU,KAAK,CAAC,eAAe;AAAA,EAC5D;AACA,SAAO;AACR;AAOA,SAAS,cAAc,KAAiC;AACvD,SAAO,EAAE,GAAG;AACb;AAOA,SAAS,cAAc,UAA4G;AAClI,SAAO;AAAA,IACN,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,EAAE,CAAC;AAAA,EACvB;AACD;AAUO,SAAS,gBAAgB,UAA2B;AAC1D,MAAI,SAAS,WAAW,IAAI;AAC3B,WAAO;AAAA,EACR;AACA,QAAM,IAAI,cAAc,SAAS,YAAY,CAAC;AAC9C,SAAO,EAAE,EAAE,MAAM,cAAc,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;AACxG;AAUO,SAAS,OAAO,UAA2B;AACjD,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,qBAAqB;AAAA,EAC1C;AACA,QAAM,IAAI,cAAc,QAAQ;AAChC,SAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM;AAC1C;AAUO,SAAS,SAAS,UAA2B;AACnD,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const checksumCharacterSet = '0123456789ABCDEFHJKLMNPRSTUVWXY';\nconst checkSumMapLength = checksumCharacterSet.length; // is always 31\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value - string to parse\n * @returns value as number\n */\nexport function parseStringToInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('Value is undefined');\n\t}\n\tconst parsedValue = parseInt(value, 10);\n\tif (isNaN(parsedValue)) {\n\t\tthrow new TypeError(`Value is not a number: ${value}`);\n\t}\n\treturn parsedValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value - value to validate\n * @returns value as string\n */\nexport function validateString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${String(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Get checksum for check sum index number\n * @param index - index number to lookup checksum character\n * @returns checksum character from checksum index map\n */\nexport function getCheckSum(index: number): string | undefined {\n\tif (index < 0 || index >= checkSumMapLength) {\n\t\tthrow new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);\n\t}\n\treturn checksumCharacterSet[index];\n}\n\n/**\n * Validate if a string is a valid Finnish person ID\n *\n * A valid Finnish person ID consists of 11 characters in the format DDMMYYCZZZQ, where:\n * - DDMMYY represents the date of birth\n * - C is the century sign ('+' for 1800s, '-' for 1900s, 'A' for 2000s)\n * - ZZZ is an individual number (odd numbers are males, even numbers are females)\n * - Q is a checksum character\n *\n * The checksum character is calculated based on the first 10 characters.\n * @param personId - The person ID string to validate\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the person ID is valid, false otherwise\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n * const personId = '131052-308T';\n * if(isValidPersonId<z.BRAND<'PersonID'>>(personId)) { // personId type is now: string & z.BRAND<'PersonID'>\n *   // personId type is now: string & z.BRAND<'PersonID'>\n * }\n * @since v0.0.1\n */\nexport function isValidPersonId<BRAND = string>(personId: string): personId is string & BRAND {\n\tif (typeof personId !== 'string' || personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst upperPersonId = personId.toUpperCase();\n\ttry {\n\t\treturn upperPersonId[10] === getCheckSum(parseStringToInt(upperPersonId.slice(0, 6) + upperPersonId.slice(7, 10)) % checkSumMapLength);\n\t} catch (_error) {\n\t\treturn false;\n\t}\n}\n\n/**\n * Check if personId belongs to a Finnish male\n * @throws TypeError if personId is not valid\n * @param personId - Finnish personId string\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the personId belongs to a male, false otherwise\n * @example\n * isMale('131052-309U') // true\n * isMale('131052-308T') // false\n * isMale<z.BRAND<'PersonIdMale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdMale'>\n * @since v0.0.1\n */\nexport function isMale<BRAND = string>(personId: string): personId is string & BRAND {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError(`${String(personId)} is not valid person id`);\n\t}\n\treturn parseStringToInt(personId.slice(7, 10)) % 2 === 1; // check if the individual number is odd\n}\n\n/**\n * Check if personId belongs to a Finnish female\n * @throws TypeError if personId is not valid\n * @param personId - Finnish personId string\n * @template BRAND - Optional: brand type for more strict type (i.e. use Zod branded type or custom type)\n * @returns true if the personId belongs to a female, false otherwise\n * @example\n * isFemale('131052-308T') // true\n * isFemale('131052-309U') // false\n * isFemale<z.BRAND<'PersonIdFemale'>>(personId) // if true, personId type is now: string & z.BRAND<'PersonIdFemale'>\n * @since v0.0.1\n */\nexport function isFemale<BRAND = string>(personId: string): personId is string & BRAND {\n\treturn !isMale(personId);\n}\n"],"mappings":";AAAA,IAAM,uBAAuB;AAC7B,IAAM,oBAAoB,qBAAqB;AAQxC,SAAS,iBAAiB,OAAmC;AACnE,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,oBAAoB;AAAA,EACzC;AACA,QAAM,cAAc,SAAS,OAAO,EAAE;AACtC,MAAI,MAAM,WAAW,GAAG;AACvB,UAAM,IAAI,UAAU,0BAA0B,KAAK,EAAE;AAAA,EACtD;AACA,SAAO;AACR;AAQO,SAAS,eAAe,OAAwB;AACtD,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,OAAO,KAAK,CAAC,eAAe;AAAA,EACpD;AACA,SAAO;AACR;AAOO,SAAS,YAAY,OAAmC;AAC9D,MAAI,QAAQ,KAAK,SAAS,mBAAmB;AAC5C,UAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,CAAC,oBAAoB,OAAO,oBAAoB,CAAC,CAAC,GAAG;AAAA,EAClH;AACA,SAAO,qBAAqB,KAAK;AAClC;AAwBO,SAAS,gBAAgC,UAA8C;AAC7F,MAAI,OAAO,aAAa,YAAY,SAAS,WAAW,IAAI;AAC3D,WAAO;AAAA,EACR;AACA,QAAM,gBAAgB,SAAS,YAAY;AAC3C,MAAI;AACH,WAAO,cAAc,EAAE,MAAM,YAAY,iBAAiB,cAAc,MAAM,GAAG,CAAC,IAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAAI,iBAAiB;AAAA,EACtI,SAAS,QAAQ;AAChB,WAAO;AAAA,EACR;AACD;AAcO,SAAS,OAAuB,UAA8C;AACpF,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,GAAG,OAAO,QAAQ,CAAC,yBAAyB;AAAA,EACjE;AACA,SAAO,iBAAiB,SAAS,MAAM,GAAG,EAAE,CAAC,IAAI,MAAM;AACxD;AAcO,SAAS,SAAyB,UAA8C;AACtF,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}

package/package.json

@@ -1,89 +1,90 @@
 {
-    "name": "fi-pin",
-    "version": "0.0.6",
-    "description": "Finnish Personal Identification Number validate + gender check",
-    "main": "./dist/index.js",
-    "module": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "exports": {
-        ".": {
-            "require": "./dist/index.js",
-            "import": "./dist/index.mjs",
-            "types": "./dist/index.d.ts"
-        }
-    },
-    "devDependencies": {
-        "@types/chai": "^4.3.16",
-        "@types/mocha": "^9.1.1",
-        "@types/node": "^14.18.63",
-        "@typescript-eslint/eslint-plugin": "^7.8.0",
-        "@typescript-eslint/parser": "^7.8.0",
-        "chai": "^4.4.1",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-config-standard": "^17.1.0",
-        "eslint-plugin-deprecation": "^2.0.0",
-        "eslint-plugin-jsdoc": "^48.2.3",
-        "eslint-plugin-prettier": "^5.1.3",
-        "eslint-plugin-sonarjs": "^0.23.0",
-        "mocha": "^10.4.0",
-        "mocha-junit-reporter": "^2.2.1",
-        "nyc": "^15.1.0",
-        "source-map-support": "^0.5.21",
-        "ts-node": "^10.9.2",
-        "tsup": "^8.0.2",
-        "typescript": "^5.4.5"
-    },
-    "scripts": {
-        "build": "tsup src/index.ts --sourcemap --format cjs,esm --dts --clean",
-        "prepublishOnly": "npm run test && npm run build",
-        "test": "nyc mocha",
-        "lint": "eslint src/ test/"
-    },
-    "mocha": {
-        "exit": true,
-        "extension": [
-            "ts",
-            "js"
-        ],
-        "recursive": true,
-        "require": [
-            "ts-node/register",
-            "source-map-support/register"
-        ],
-        "reporters": [
-            "spec",
-            "mocha-junit-reporter"
-        ]
-    },
-    "keywords": [
-        "pin",
-        "personid"
+  "name": "fi-pin",
+  "version": "0.0.8",
+  "description": "Finnish Personal Identification Number validate + gender check",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.10.0",
+    "@stylistic/eslint-plugin-ts": "^2.10.0",
+    "@types/node": "^18.19.61",
+    "@typescript-eslint/eslint-plugin": "^8.12.2",
+    "@typescript-eslint/parser": "^8.12.2",
+    "@vitest/coverage-v8": "^2.1.4",
+    "c8": "^10.1.2",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-deprecation": "^3.0.0",
+    "eslint-plugin-jsdoc": "^50.4.3",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "source-map-support": "^0.5.21",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10",
+    "vitest": "^2.1.4",
+    "zod": "^3.23.8"
+  },
+  "mocha": {
+    "exit": true,
+    "extension": [
+      "ts",
+      "js"
     ],
-    "files": [
-        "dist"
+    "recursive": true,
+    "require": [
+      "ts-node/register",
+      "source-map-support/register"
     ],
-    "nyc": {
-        "extension": [
-            ".ts"
-        ],
-        "include": [
-            "src"
-        ],
-        "reporter": [
-            "text",
-            "lcovonly"
-        ],
-        "all": true
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mharj/hetu.git"
-    },
-    "author": "mharj",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/mharj/hetu/issues"
-    },
-    "homepage": "https://github.com/mharj/hetu#readme"
-}
+    "reporters": [
+      "spec",
+      "mocha-junit-reporter"
+    ]
+  },
+  "keywords": [
+    "pin",
+    "personid"
+  ],
+  "files": [
+    "dist"
+  ],
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "include": [
+      "src"
+    ],
+    "reporter": [
+      "text",
+      "lcovonly"
+    ],
+    "all": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mharj/hetu.git"
+  },
+  "author": "mharj",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mharj/hetu/issues"
+  },
+  "homepage": "https://github.com/mharj/hetu#readme",
+  "scripts": {
+    "build": "tsup src/index.ts --sourcemap --format cjs,esm --dts --clean",
+    "test": "vitest test --run --no-isolate --coverage",
+    "coverage": "vitest test --run --no-isolate --reporter=dot --coverage --coverage.reporter=lcov",
+    "lint": "eslint . --ext .ts",
+    "validate": "tsc --noEmit"
+  }
+}