fi-pin 0.0.8 → 0.0.10

package/README.md

@@ -1,24 +1,34 @@
 # Finnish Person ID Check
 
+[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
+[![npm version](https://badge.fury.io/js/fi-pin.svg)](https://badge.fury.io/js/fi-pin)
+[![Maintainability](https://qlty.sh/gh/mharj/projects/hetu/maintainability.svg)](https://qlty.sh/gh/mharj/projects/hetu)
+[![Code Coverage](https://qlty.sh/gh/mharj/projects/hetu/coverage.svg)](https://qlty.sh/gh/mharj/projects/hetu)
 ![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)
 
 ## 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
+- `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
 
+To install the module, run the following command:
+
 ```bash
 npm install fi-pin
 ```
 
+or direct import from unpkg (i.e., on a web page):
+
+```typescript
+import {isValidPersonId, isMale, isFemale} from 'https://unpkg.com/fi-pin@latest/dist/index.mjs';
+```
+
 ## Usage
 
 ```typescript

package/dist/index.cjs

@@ -0,0 +1,111 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/index.ts
+const checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+const checkSumMapLength = 31;
+/**
+* Parse string to integer
+* @throws TypeError if value is not a number
+* @param {string | undefined} value - string to parse
+* @returns {number} value as number
+* @since v0.0.7
+*/
+function parseStringToInt(value) {
+	if (!value) throw new TypeError("Value is undefined");
+	const parsedValue = parseInt(value, 10);
+	if (isNaN(parsedValue)) throw new TypeError(`Value is not a number: ${value}`);
+	return parsedValue;
+}
+/**
+* Validate that value is a string
+* @throws TypeError if value is not a string
+* @param {unknown} value - value to validate
+* @returns {string} value as string
+* @since v0.0.7
+*/
+function validateString(value) {
+	if (typeof value !== "string") throw new TypeError(`${String(value)} not a string`);
+	return value;
+}
+/**
+* Returns the checksum character from the checksum index map.
+* @param {number} index The index of the checksum character.
+* @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.
+* @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.
+* @since v0.0.7
+*/
+function getCheckSum(index) {
+	const checkSumChar = checksumCharacterSet[index];
+	if (!checkSumChar) throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
+	return checkSumChar;
+}
+/**
+* Validates whether 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 {string} personId The person ID string to validate.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} 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
+*/
+function isValidPersonId(personId) {
+	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;
+	}
+}
+/**
+* Checks whether a person ID belongs to a Finnish male.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a male, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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
+*/
+function isMale(personId) {
+	if (!isValidPersonId(personId)) throw new TypeError(`${String(personId)} is not valid person id`);
+	return parseStringToInt(personId.slice(7, 10)) % 2 === 1;
+}
+/**
+* Checks whether a person ID belongs to a Finnish female.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a female, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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
+*/
+function isFemale(personId) {
+	return !isMale(personId);
+}
+//#endregion
+exports.getCheckSum = getCheckSum;
+exports.isFemale = isFemale;
+exports.isMale = isMale;
+exports.isValidPersonId = isValidPersonId;
+exports.parseStringToInt = parseStringToInt;
+exports.validateString = validateString;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"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 {string | undefined} value - string to parse\n * @returns {number} value as number\n * @since v0.0.7\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 {unknown} value - value to validate\n * @returns {string} value as string\n * @since v0.0.7\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 * Returns the checksum character from the checksum index map.\n * @param {number} index The index of the checksum character.\n * @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.\n * @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.\n * @since v0.0.7\n */\nexport function getCheckSum(index: number): string {\n\tconst checkSumChar = checksumCharacterSet[index];\n\tif (!checkSumChar) {\n\t\tthrow new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);\n\t}\n\treturn checkSumChar;\n}\n\n/**\n * Validates whether 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 {string} personId The person ID string to validate.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} 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 * Checks whether a person ID belongs to a Finnish male.\n * @param {string} personId The Finnish person ID string.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} True if the person ID belongs to a male, false otherwise.\n * @throws {TypeError} If the person ID is not valid.\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 * Checks whether a person ID belongs to a Finnish female.\n * @param {string} personId The Finnish person ID string.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} True if the person ID belongs to a female, false otherwise.\n * @throws {TypeError} If the person ID is not valid.\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,MAAM,uBAAuB;AAC7B,MAAM,oBAAoB;;;;;;;;AAS1B,SAAgB,iBAAiB,OAAmC;CACnE,IAAI,CAAC,OACJ,MAAM,IAAI,UAAU,oBAAoB;CAEzC,MAAM,cAAc,SAAS,OAAO,EAAE;CACtC,IAAI,MAAM,WAAW,GACpB,MAAM,IAAI,UAAU,0BAA0B,OAAO;CAEtD,OAAO;AACR;;;;;;;;AASA,SAAgB,eAAe,OAAwB;CACtD,IAAI,OAAO,UAAU,UACpB,MAAM,IAAI,UAAU,GAAG,OAAO,KAAK,EAAE,cAAc;CAEpD,OAAO;AACR;;;;;;;;AASA,SAAgB,YAAY,OAAuB;CAClD,MAAM,eAAe,qBAAqB;CAC1C,IAAI,CAAC,cACJ,MAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,EAAE,mBAAmB,OAAO,oBAAoB,CAAC,EAAE,EAAE;CAElH,OAAO;AACR;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAAgB,gBAAgC,UAA8C;CAC7F,IAAI,OAAO,aAAa,YAAY,SAAS,WAAW,IACvD,OAAO;CAER,MAAM,gBAAgB,SAAS,YAAY;CAC3C,IAAI;EACH,OAAO,cAAc,QAAQ,YAAY,iBAAiB,cAAc,MAAM,GAAG,CAAC,IAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAAI,iBAAiB;CACtI,SAAS,QAAQ;EAChB,OAAO;CACR;AACD;;;;;;;;;;;;;AAcA,SAAgB,OAAuB,UAA8C;CACpF,IAAI,CAAC,gBAAgB,QAAQ,GAC5B,MAAM,IAAI,UAAU,GAAG,OAAO,QAAQ,EAAE,wBAAwB;CAEjE,OAAO,iBAAiB,SAAS,MAAM,GAAG,EAAE,CAAC,IAAI,MAAM;AACxD;;;;;;;;;;;;;AAcA,SAAgB,SAAyB,UAA8C;CACtF,OAAO,CAAC,OAAO,QAAQ;AACxB"}

package/dist/index.d.cts

@@ -0,0 +1,77 @@
+//#region src/index.d.ts
+/**
+* Parse string to integer
+* @throws TypeError if value is not a number
+* @param {string | undefined} value - string to parse
+* @returns {number} value as number
+* @since v0.0.7
+*/
+declare function parseStringToInt(value: string | undefined): number;
+/**
+* Validate that value is a string
+* @throws TypeError if value is not a string
+* @param {unknown} value - value to validate
+* @returns {string} value as string
+* @since v0.0.7
+*/
+declare function validateString(value: unknown): string;
+/**
+* Returns the checksum character from the checksum index map.
+* @param {number} index The index of the checksum character.
+* @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.
+* @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.
+* @since v0.0.7
+*/
+declare function getCheckSum(index: number): string;
+/**
+* Validates whether 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 {string} personId The person ID string to validate.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} 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<BRAND = string>(personId: string): personId is string & BRAND;
+/**
+* Checks whether a person ID belongs to a Finnish male.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a male, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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<BRAND = string>(personId: string): personId is string & BRAND;
+/**
+* Checks whether a person ID belongs to a Finnish female.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a female, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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<BRAND = string>(personId: string): personId is string & BRAND;
+//#endregion
+export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -1,71 +1,77 @@
+//#region src/index.d.ts
 /**
- * Parse string to integer
- * @throws TypeError if value is not a number
- * @param value - string to parse
- * @returns value as number
- */
+* Parse string to integer
+* @throws TypeError if value is not a number
+* @param {string | undefined} value - string to parse
+* @returns {number} value as number
+* @since v0.0.7
+*/
 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
- */
+* Validate that value is a string
+* @throws TypeError if value is not a string
+* @param {unknown} value - value to validate
+* @returns {string} value as string
+* @since v0.0.7
+*/
 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;
+* Returns the checksum character from the checksum index map.
+* @param {number} index The index of the checksum character.
+* @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.
+* @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.
+* @since v0.0.7
+*/
+declare function getCheckSum(index: number): string;
 /**
- * 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
- */
+* Validates whether 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 {string} personId The person ID string to validate.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} 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<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId belongs to a Finnish male
- * @throws TypeError if personId is not valid
- * @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
- */
+* Checks whether a person ID belongs to a Finnish male.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a male, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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<BRAND = string>(personId: string): personId is string & BRAND;
 /**
- * Check if personId belongs to a Finnish female
- * @throws TypeError if personId is not valid
- * @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
- */
+* Checks whether a person ID belongs to a Finnish female.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a female, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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<BRAND = string>(personId: string): personId is string & BRAND;
-
+//#endregion
 export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,54 +1,105 @@
-// src/index.ts
-var checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
-var checkSumMapLength = checksumCharacterSet.length;
+//#region src/index.ts
+const checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+const checkSumMapLength = 31;
+/**
+* Parse string to integer
+* @throws TypeError if value is not a number
+* @param {string | undefined} value - string to parse
+* @returns {number} value as number
+* @since v0.0.7
+*/
 function parseStringToInt(value) {
-  if (!value) {
-    throw new TypeError("Value is undefined");
-  }
-  const parsedValue = parseInt(value, 10);
-  if (isNaN(parsedValue)) {
-    throw new TypeError(`Value is not a number: ${value}`);
-  }
-  return parsedValue;
+	if (!value) throw new TypeError("Value is undefined");
+	const parsedValue = parseInt(value, 10);
+	if (isNaN(parsedValue)) throw new TypeError(`Value is not a number: ${value}`);
+	return parsedValue;
 }
+/**
+* Validate that value is a string
+* @throws TypeError if value is not a string
+* @param {unknown} value - value to validate
+* @returns {string} value as string
+* @since v0.0.7
+*/
 function validateString(value) {
-  if (typeof value !== "string") {
-    throw new TypeError(`${String(value)} not a string`);
-  }
-  return value;
+	if (typeof value !== "string") throw new TypeError(`${String(value)} not a string`);
+	return value;
 }
+/**
+* Returns the checksum character from the checksum index map.
+* @param {number} index The index of the checksum character.
+* @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.
+* @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.
+* @since v0.0.7
+*/
 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];
+	const checkSumChar = checksumCharacterSet[index];
+	if (!checkSumChar) throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
+	return checkSumChar;
 }
+/**
+* Validates whether 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 {string} personId The person ID string to validate.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} 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
+*/
 function isValidPersonId(personId) {
-  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;
-  }
+	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;
+	}
 }
+/**
+* Checks whether a person ID belongs to a Finnish male.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a male, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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
+*/
 function isMale(personId) {
-  if (!isValidPersonId(personId)) {
-    throw new TypeError(`${String(personId)} is not valid person id`);
-  }
-  return parseStringToInt(personId.slice(7, 10)) % 2 === 1;
+	if (!isValidPersonId(personId)) throw new TypeError(`${String(personId)} is not valid person id`);
+	return parseStringToInt(personId.slice(7, 10)) % 2 === 1;
 }
+/**
+* Checks whether a person ID belongs to a Finnish female.
+* @param {string} personId The Finnish person ID string.
+* @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).
+* @returns {boolean} True if the person ID belongs to a female, false otherwise.
+* @throws {TypeError} If the person ID is not valid.
+* @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
+*/
 function isFemale(personId) {
-  return !isMale(personId);
+	return !isMale(personId);
 }
-export {
-  getCheckSum,
-  isFemale,
-  isMale,
-  isValidPersonId,
-  parseStringToInt,
-  validateString
-};
+//#endregion
+export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };
+
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"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":[]}
+{"version":3,"file":"index.mjs","names":[],"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 {string | undefined} value - string to parse\n * @returns {number} value as number\n * @since v0.0.7\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 {unknown} value - value to validate\n * @returns {string} value as string\n * @since v0.0.7\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 * Returns the checksum character from the checksum index map.\n * @param {number} index The index of the checksum character.\n * @returns {string} The checksum character at the specified index, or undefined if the index is out of bounds.\n * @throws {RangeError} If the index is less than 0 or greater than or equal to checkSumMapLength.\n * @since v0.0.7\n */\nexport function getCheckSum(index: number): string {\n\tconst checkSumChar = checksumCharacterSet[index];\n\tif (!checkSumChar) {\n\t\tthrow new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);\n\t}\n\treturn checkSumChar;\n}\n\n/**\n * Validates whether 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 {string} personId The person ID string to validate.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} 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 * Checks whether a person ID belongs to a Finnish male.\n * @param {string} personId The Finnish person ID string.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} True if the person ID belongs to a male, false otherwise.\n * @throws {TypeError} If the person ID is not valid.\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 * Checks whether a person ID belongs to a Finnish female.\n * @param {string} personId The Finnish person ID string.\n * @template BRAND Optional brand type for a more strict type (e.g., use Zod branded type or custom type).\n * @returns {boolean} True if the person ID belongs to a female, false otherwise.\n * @throws {TypeError} If the person ID is not valid.\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,MAAM,uBAAuB;AAC7B,MAAM,oBAAoB;;;;;;;;AAS1B,SAAgB,iBAAiB,OAAmC;CACnE,IAAI,CAAC,OACJ,MAAM,IAAI,UAAU,oBAAoB;CAEzC,MAAM,cAAc,SAAS,OAAO,EAAE;CACtC,IAAI,MAAM,WAAW,GACpB,MAAM,IAAI,UAAU,0BAA0B,OAAO;CAEtD,OAAO;AACR;;;;;;;;AASA,SAAgB,eAAe,OAAwB;CACtD,IAAI,OAAO,UAAU,UACpB,MAAM,IAAI,UAAU,GAAG,OAAO,KAAK,EAAE,cAAc;CAEpD,OAAO;AACR;;;;;;;;AASA,SAAgB,YAAY,OAAuB;CAClD,MAAM,eAAe,qBAAqB;CAC1C,IAAI,CAAC,cACJ,MAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,EAAE,mBAAmB,OAAO,oBAAoB,CAAC,EAAE,EAAE;CAElH,OAAO;AACR;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAAgB,gBAAgC,UAA8C;CAC7F,IAAI,OAAO,aAAa,YAAY,SAAS,WAAW,IACvD,OAAO;CAER,MAAM,gBAAgB,SAAS,YAAY;CAC3C,IAAI;EACH,OAAO,cAAc,QAAQ,YAAY,iBAAiB,cAAc,MAAM,GAAG,CAAC,IAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAAI,iBAAiB;CACtI,SAAS,QAAQ;EAChB,OAAO;CACR;AACD;;;;;;;;;;;;;AAcA,SAAgB,OAAuB,UAA8C;CACpF,IAAI,CAAC,gBAAgB,QAAQ,GAC5B,MAAM,IAAI,UAAU,GAAG,OAAO,QAAQ,EAAE,wBAAwB;CAEjE,OAAO,iBAAiB,SAAS,MAAM,GAAG,EAAE,CAAC,IAAI,MAAM;AACxD;;;;;;;;;;;;;AAcA,SAAgB,SAAyB,UAA8C;CACtF,OAAO,CAAC,OAAO,QAAQ;AACxB"}

package/package.json

@@ -1,90 +1,53 @@
 {
-  "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"
+    "name": "fi-pin",
+    "version": "0.0.10",
+    "description": "Finnish Personal Identification Number validate + gender check",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.mts",
+    "exports": {
+        "import": {
+            "types": "./dist/index.d.mts",
+            "default": "./dist/index.mjs"
+        },
+        "require": {
+            "types": "./dist/index.d.cts",
+            "default": "./dist/index.cjs"
+        },
+        "default": "./dist/index.mjs"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "2.5.2",
+        "@types/node": "^25.9.4",
+        "@vitest/coverage-v8": "^4.1.9",
+        "c8": "^11.0.0",
+        "tsdown": "^0.22.3",
+        "typescript": "^6.0.3",
+        "vite": "^8.1.3",
+        "vitest": "^4.1.9",
+        "zod": "^4.4.3"
+    },
+    "scripts": {
+        "build": "tsdown src/index.ts --sourcemap --format cjs,esm --dts --clean",
+        "prepublishOnly": "npm run build",
+        "test": "vitest test --typecheck --run --no-isolate --coverage",
+        "lint": "biome check",
+        "validate": "tsc --noEmit"
+    },
+    "keywords": [
+        "pin",
+        "personid",
+        "finnish"
     ],
-    "recursive": true,
-    "require": [
-      "ts-node/register",
-      "source-map-support/register"
+    "files": [
+        "dist"
     ],
-    "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"
-  }
-}
+    "repository": "github:mharj/hetu",
+    "author": "mharj",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/mharj/hetu/issues"
+    },
+    "homepage": "https://github.com/mharj/hetu#readme",
+    "packageManager": "pnpm@10.34.3+sha512.f2c531b08829d7be7f03c90addc266615f9c5477463e4bf1d275cb263ce9ea57cf0d5599110d94649a9bb3fed9f0b5efcea74a7016b61532a24cb9ad87860c1d"
+}

package/dist/index.d.ts

@@ -1,71 +0,0 @@
-/**
- * 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<BRAND = string>(personId: string): personId is string & BRAND;
-/**
- * Check if personId belongs to a Finnish male
- * @throws TypeError if personId is not valid
- * @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<BRAND = string>(personId: string): personId is string & BRAND;
-/**
- * Check if personId belongs to a Finnish female
- * @throws TypeError if personId is not valid
- * @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<BRAND = string>(personId: string): personId is string & BRAND;
-
-export { getCheckSum, isFemale, isMale, isValidPersonId, parseStringToInt, validateString };

package/dist/index.js

@@ -1,84 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  getCheckSum: () => getCheckSum,
-  isFemale: () => isFemale,
-  isMale: () => isMale,
-  isValidPersonId: () => isValidPersonId,
-  parseStringToInt: () => parseStringToInt,
-  validateString: () => validateString
-});
-module.exports = __toCommonJS(src_exports);
-var checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
-var checkSumMapLength = checksumCharacterSet.length;
-function parseStringToInt(value) {
-  if (!value) {
-    throw new TypeError("Value is undefined");
-  }
-  const parsedValue = parseInt(value, 10);
-  if (isNaN(parsedValue)) {
-    throw new TypeError(`Value is not a number: ${value}`);
-  }
-  return parsedValue;
-}
-function validateString(value) {
-  if (typeof value !== "string") {
-    throw new TypeError(`${String(value)} not a string`);
-  }
-  return value;
-}
-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 (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;
-  }
-}
-function isMale(personId) {
-  if (!isValidPersonId(personId)) {
-    throw new TypeError(`${String(personId)} is not valid person id`);
-  }
-  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,
-  parseStringToInt,
-  validateString
-});
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"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":[]}