fi-pin 0.0.8 → 0.0.9

package/README.md

@@ -8,17 +8,25 @@
 
 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.d.mts

@@ -1,52 +1,56 @@
 /**
  * Parse string to integer
  * @throws TypeError if value is not a number
- * @param value - string to parse
- * @returns value as 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
+ * @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
+ * 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 | undefined;
+declare function getCheckSum(index: number): string;
 /**
- * Validate if a string is a valid Finnish person ID
+ * 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
+ * - 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
+ * @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'>
+ * 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
+ * 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
@@ -55,11 +59,11 @@ declare function isValidPersonId<BRAND = string>(personId: string): personId is
  */
 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
+ * 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

package/dist/index.d.ts

@@ -1,52 +1,56 @@
 /**
  * Parse string to integer
  * @throws TypeError if value is not a number
- * @param value - string to parse
- * @returns value as 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
+ * @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
+ * 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 | undefined;
+declare function getCheckSum(index: number): string;
 /**
- * Validate if a string is a valid Finnish person ID
+ * 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
+ * - 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
+ * @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'>
+ * 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
+ * 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
@@ -55,11 +59,11 @@ declare function isValidPersonId<BRAND = string>(personId: string): personId is
  */
 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
+ * 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

package/dist/index.js

@@ -18,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   getCheckSum: () => getCheckSum,
   isFemale: () => isFemale,
   isMale: () => isMale,
@@ -27,7 +27,7 @@ __export(src_exports, {
   parseStringToInt: () => parseStringToInt,
   validateString: () => validateString
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 var checksumCharacterSet = "0123456789ABCDEFHJKLMNPRSTUVWXY";
 var checkSumMapLength = checksumCharacterSet.length;
 function parseStringToInt(value) {
@@ -47,10 +47,11 @@ function validateString(value) {
   return value;
 }
 function getCheckSum(index) {
-  if (index < 0 || index >= checkSumMapLength) {
+  const checkSumChar = checksumCharacterSet[index];
+  if (!checkSumChar) {
     throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
   }
-  return checksumCharacterSet[index];
+  return checkSumChar;
 }
 function isValidPersonId(personId) {
   if (typeof personId !== "string" || personId.length !== 11) {

package/dist/index.js.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;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":[]}
+{"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 {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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAM,uBAAuB;AAC7B,IAAM,oBAAoB,qBAAqB;AASxC,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;AASO,SAAS,eAAe,OAAwB;AACtD,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,OAAO,KAAK,CAAC,eAAe;AAAA,EACpD;AACA,SAAO;AACR;AASO,SAAS,YAAY,OAAuB;AAClD,QAAM,eAAe,qBAAqB,KAAK;AAC/C,MAAI,CAAC,cAAc;AAClB,UAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,CAAC,oBAAoB,OAAO,oBAAoB,CAAC,CAAC,GAAG;AAAA,EAClH;AACA,SAAO;AACR;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

@@ -18,10 +18,11 @@ function validateString(value) {
   return value;
 }
 function getCheckSum(index) {
-  if (index < 0 || index >= checkSumMapLength) {
+  const checkSumChar = checksumCharacterSet[index];
+  if (!checkSumChar) {
     throw new RangeError(`Index out of bounds: ${index.toString()} (valid range: 0-${String(checkSumMapLength - 1)})`);
   }
-  return checksumCharacterSet[index];
+  return checkSumChar;
 }
 function isValidPersonId(personId) {
   if (typeof personId !== "string" || personId.length !== 11) {

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,"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,IAAM,uBAAuB;AAC7B,IAAM,oBAAoB,qBAAqB;AASxC,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;AASO,SAAS,eAAe,OAAwB;AACtD,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,OAAO,KAAK,CAAC,eAAe;AAAA,EACpD;AACA,SAAO;AACR;AASO,SAAS,YAAY,OAAuB;AAClD,QAAM,eAAe,qBAAqB,KAAK;AAC/C,MAAI,CAAC,cAAc;AAClB,UAAM,IAAI,WAAW,wBAAwB,MAAM,SAAS,CAAC,oBAAoB,OAAO,oBAAoB,CAAC,CAAC,GAAG;AAAA,EAClH;AACA,SAAO;AACR;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,6 +1,6 @@
 {
   "name": "fi-pin",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Finnish Personal Identification Number validate + gender check",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -13,26 +13,29 @@
     }
   },
   "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",
+    "@cspell/eslint-plugin": "^8.18.0",
+    "@eslint/js": "^9.23.0",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@stylistic/eslint-plugin-ts": "^4.2.0",
+    "@types/node": "^22.13.14",
+    "@typescript-eslint/eslint-plugin": "^8.28.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "@vitest/coverage-v8": "^3.0.9",
+    "c8": "^10.1.3",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-import-resolver-typescript": "^4.2.5",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsdoc": "^50.6.9",
+    "eslint-plugin-prettier": "^5.2.5",
+    "eslint-plugin-sonarjs": "^3.0.2",
     "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"
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0",
+    "vite": "^6.2.3",
+    "vitest": "^3.0.9",
+    "zod": "^3.24.2"
   },
   "mocha": {
     "exit": true,