fi-pin 0.0.4 → 0.0.6

package/LICENSE

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

package/README.md

@@ -1,9 +1,19 @@
-### Finnish Person ID check [![Build Status](https://travis-ci.org/mharj/hetu.svg?branch=master)](https://travis-ci.org/mharj/hetu)
+### Finnish Person ID check [![Build Status](https://travis-ci.org/mharj/hetu.svg?branch=master)](https://travis-ci.org/mharj/hetu) [![Maintainability](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/maintainability)](https://codeclimate.com/github/mharj/hetu/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/3dca350166c6d1ea4105/test_coverage)](https://codeclimate.com/github/mharj/hetu/test_coverage)
+
 ```javascript
 const {isFemale, isMale, isValidPersonId} = require('fi-pin');
 
-if ( isValidPersonId('131052-308T') ) {
-    console.log('male', isMale('131052-308T') );
-    console.log('female', isFemale('131052-308T') );
+if (isValidPersonId('131052-308T')) {
+	console.log('male', isMale('131052-308T'));
+	console.log('female', isFemale('131052-308T'));
+}
+```
+
+```typescript
+import {isFemale, isMale, isValidPersonId} from 'fi-pin';
+
+if (isValidPersonId('131052-308T')) {
+	console.log('male', isMale('131052-308T'));
+	console.log('female', isFemale('131052-308T'));
 }
-```
+```

package/dist/index.d.mts

@@ -0,0 +1,29 @@
+/**
+ * Validate if string is a valid personId
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isValidPersonId('131052-308T') // true
+ * isValidPersonId('131052-3082') // false
+ */
+declare function isValidPersonId(personId: string): boolean;
+/**
+ * Check if personId is for male
+ * @throws TypeError if personId is not valid
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isMale('131052-308T') // false
+ */
+declare function isMale(personId: string): boolean;
+/**
+ * Check if personId is for female
+ * @throws TypeError if personId is not valid
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isFemale('131052-308T') // true
+ */
+declare function isFemale(personId: string): boolean;
+
+export { isFemale, isMale, isValidPersonId };

package/dist/index.d.ts

@@ -1,3 +1,29 @@
-export declare const isValidPersonId: (hetu: string) => boolean;
-export declare const isMale: (hetu: string) => boolean;
-export declare const isFemale: (hetu: string) => boolean;
+/**
+ * Validate if string is a valid personId
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isValidPersonId('131052-308T') // true
+ * isValidPersonId('131052-3082') // false
+ */
+declare function isValidPersonId(personId: string): boolean;
+/**
+ * Check if personId is for male
+ * @throws TypeError if personId is not valid
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isMale('131052-308T') // false
+ */
+declare function isMale(personId: string): boolean;
+/**
+ * Check if personId is for female
+ * @throws TypeError if personId is not valid
+ * @param personId - personId string
+ * @returns true if valid, false if not
+ * @example
+ * isFemale('131052-308T') // true
+ */
+declare function isFemale(personId: string): boolean;
+
+export { isFemale, isMale, isValidPersonId };

package/dist/index.js

@@ -1,23 +1,86 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var c = '0123456789ABCDEFHJKLMNPRSTUVWXY';
-var getCC = function (num) {
-    return c[num] ? c[num] : null;
-};
-exports.isValidPersonId = function (hetu) {
-    if (hetu.length !== 11) {
-        return false;
-    }
-    var d = hetu.toUpperCase();
-    return d[10] === getCC(parseInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9], 10) % 31);
-};
-exports.isMale = function (hetu) {
-    if (!exports.isValidPersonId(hetu)) {
-        throw new Error('not valid person id');
-    }
-    return parseInt(hetu[7] + hetu[8] + hetu[9], 10) % 2 === 1 ? true : false;
-};
-exports.isFemale = function (hetu) {
-    return !exports.isMale(hetu);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiLi9zcmMvIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLElBQU0sQ0FBQyxHQUFHLGlDQUFpQyxDQUFDO0FBRTVDLElBQU0sS0FBSyxHQUFHLFVBQUMsR0FBVztJQUN6QixPQUFPLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7QUFDL0IsQ0FBQyxDQUFDO0FBRVcsUUFBQSxlQUFlLEdBQUcsVUFBQyxJQUFZO0lBQzNDLElBQUksSUFBSSxDQUFDLE1BQU0sS0FBSyxFQUFFLEVBQUU7UUFDdkIsT0FBTyxLQUFLLENBQUM7S0FDYjtJQUNELElBQU0sQ0FBQyxHQUFHLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUM3QixPQUFPLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO0FBQ3pHLENBQUMsQ0FBQztBQUVXLFFBQUEsTUFBTSxHQUFHLFVBQUMsSUFBWTtJQUNsQyxJQUFJLENBQUMsdUJBQWUsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUMzQixNQUFNLElBQUksS0FBSyxDQUFDLHFCQUFxQixDQUFDLENBQUM7S0FDdkM7SUFDRCxPQUFPLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUMsQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQztBQUMzRSxDQUFDLENBQUM7QUFFVyxRQUFBLFFBQVEsR0FBRyxVQUFDLElBQVk7SUFDcEMsT0FBTyxDQUFDLGNBQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUN0QixDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJjb25zdCBjID0gJzAxMjM0NTY3ODlBQkNERUZISktMTU5QUlNUVVZXWFknO1xuXG5jb25zdCBnZXRDQyA9IChudW06IG51bWJlcik6IHN0cmluZyB8IG51bGwgPT4ge1xuXHRyZXR1cm4gY1tudW1dID8gY1tudW1dIDogbnVsbDtcbn07XG5cbmV4cG9ydCBjb25zdCBpc1ZhbGlkUGVyc29uSWQgPSAoaGV0dTogc3RyaW5nKTogYm9vbGVhbiA9PiB7XG5cdGlmIChoZXR1Lmxlbmd0aCAhPT0gMTEpIHtcblx0XHRyZXR1cm4gZmFsc2U7XG5cdH1cblx0Y29uc3QgZCA9IGhldHUudG9VcHBlckNhc2UoKTtcblx0cmV0dXJuIGRbMTBdID09PSBnZXRDQyhwYXJzZUludChkWzBdICsgZFsxXSArIGRbMl0gKyBkWzNdICsgZFs0XSArIGRbNV0gKyBkWzddICsgZFs4XSArIGRbOV0sIDEwKSAlIDMxKTtcbn07XG5cbmV4cG9ydCBjb25zdCBpc01hbGUgPSAoaGV0dTogc3RyaW5nKTogYm9vbGVhbiA9PiB7XG5cdGlmICghaXNWYWxpZFBlcnNvbklkKGhldHUpKSB7XG5cdFx0dGhyb3cgbmV3IEVycm9yKCdub3QgdmFsaWQgcGVyc29uIGlkJyk7XG5cdH1cblx0cmV0dXJuIHBhcnNlSW50KGhldHVbN10gKyBoZXR1WzhdICsgaGV0dVs5XSwgMTApICUgMiA9PT0gMSA/IHRydWUgOiBmYWxzZTtcbn07XG5cbmV4cG9ydCBjb25zdCBpc0ZlbWFsZSA9IChoZXR1OiBzdHJpbmcpOiBib29sZWFuID0+IHtcblx0cmV0dXJuICFpc01hbGUoaGV0dSk7XG59O1xuIl19
+"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, {
+  isFemale: () => isFemale,
+  isMale: () => isMale,
+  isValidPersonId: () => isValidPersonId
+});
+module.exports = __toCommonJS(src_exports);
+var c = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+function toInt(value) {
+  if (!value) {
+    throw new TypeError("undefined");
+  }
+  const outValue = parseInt(value, 10);
+  if (isNaN(outValue)) {
+    throw new TypeError(`${value} not a number`);
+  }
+  return outValue;
+}
+function getString(value) {
+  if (typeof value !== "string") {
+    throw new TypeError(`${JSON.stringify(value)} not a string`);
+  }
+  return value;
+}
+function buildCheckSum(num) {
+  return c[num];
+}
+function buildCcValues(personId) {
+  return [
+    getString(personId[0]),
+    getString(personId[1]),
+    getString(personId[2]),
+    getString(personId[3]),
+    getString(personId[4]),
+    getString(personId[5]),
+    getString(personId[6]),
+    getString(personId[7]),
+    getString(personId[8]),
+    getString(personId[9]),
+    getString(personId[10])
+  ];
+}
+function isValidPersonId(personId) {
+  if (personId.length !== 11) {
+    return false;
+  }
+  const d = buildCcValues(personId.toUpperCase());
+  return d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);
+}
+function isMale(personId) {
+  if (!isValidPersonId(personId)) {
+    throw new TypeError("not valid person id");
+  }
+  const d = buildCcValues(personId);
+  return toInt(d[7] + d[8] + d[9]) % 2 === 1;
+}
+function isFemale(personId) {
+  return !isMale(personId);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isFemale,
+  isMale,
+  isValidPersonId
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const c = '0123456789ABCDEFHJKLMNPRSTUVWXY';\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value\n * @returns value as number\n */\nfunction toInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('undefined');\n\t}\n\tconst outValue = parseInt(value, 10);\n\tif (isNaN(outValue)) {\n\t\tthrow new TypeError(`${value} not a number`);\n\t}\n\treturn outValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value\n * @returns value as string\n */\nfunction getString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${JSON.stringify(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Build checksum for personId (last character)\n * @param num - number to build checksum from\n * @returns checksum character\n */\nfunction buildCheckSum(num: number): string | undefined {\n\treturn c[num];\n}\n\n/**\n * Construct array of string values from personId string\n * @param personId - personId string\n * @returns\n */\nfunction buildCcValues(personId: string): [string, string, string, string, string, string, string, string, string, string, string] {\n\treturn [\n\t\tgetString(personId[0]),\n\t\tgetString(personId[1]),\n\t\tgetString(personId[2]),\n\t\tgetString(personId[3]),\n\t\tgetString(personId[4]),\n\t\tgetString(personId[5]),\n\t\tgetString(personId[6]),\n\t\tgetString(personId[7]),\n\t\tgetString(personId[8]),\n\t\tgetString(personId[9]),\n\t\tgetString(personId[10]),\n\t];\n}\n\n/**\n * Validate if string is a valid personId\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n */\nexport function isValidPersonId(personId: string): boolean {\n\tif (personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst d = buildCcValues(personId.toUpperCase());\n\treturn d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);\n}\n\n/**\n * Check if personId is for male\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isMale('131052-308T') // false\n */\nexport function isMale(personId: string): boolean {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError('not valid person id');\n\t}\n\tconst d = buildCcValues(personId);\n\treturn toInt(d[7] + d[8] + d[9]) % 2 === 1;\n}\n\n/**\n * Check if personId is for female\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isFemale('131052-308T') // true\n */\nexport function isFemale(personId: string): boolean {\n\treturn !isMale(personId);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAM,IAAI;AAQV,SAAS,MAAM,OAAmC;AACjD,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,WAAW;AAAA,EAChC;AACA,QAAM,WAAW,SAAS,OAAO,EAAE;AACnC,MAAI,MAAM,QAAQ,GAAG;AACpB,UAAM,IAAI,UAAU,GAAG,KAAK,eAAe;AAAA,EAC5C;AACA,SAAO;AACR;AAQA,SAAS,UAAU,OAAwB;AAC1C,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,KAAK,UAAU,KAAK,CAAC,eAAe;AAAA,EAC5D;AACA,SAAO;AACR;AAOA,SAAS,cAAc,KAAiC;AACvD,SAAO,EAAE,GAAG;AACb;AAOA,SAAS,cAAc,UAA4G;AAClI,SAAO;AAAA,IACN,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,EAAE,CAAC;AAAA,EACvB;AACD;AAUO,SAAS,gBAAgB,UAA2B;AAC1D,MAAI,SAAS,WAAW,IAAI;AAC3B,WAAO;AAAA,EACR;AACA,QAAM,IAAI,cAAc,SAAS,YAAY,CAAC;AAC9C,SAAO,EAAE,EAAE,MAAM,cAAc,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;AACxG;AAUO,SAAS,OAAO,UAA2B;AACjD,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,qBAAqB;AAAA,EAC1C;AACA,QAAM,IAAI,cAAc,QAAQ;AAChC,SAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM;AAC1C;AAUO,SAAS,SAAS,UAA2B;AACnD,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,59 @@
+// src/index.ts
+var c = "0123456789ABCDEFHJKLMNPRSTUVWXY";
+function toInt(value) {
+  if (!value) {
+    throw new TypeError("undefined");
+  }
+  const outValue = parseInt(value, 10);
+  if (isNaN(outValue)) {
+    throw new TypeError(`${value} not a number`);
+  }
+  return outValue;
+}
+function getString(value) {
+  if (typeof value !== "string") {
+    throw new TypeError(`${JSON.stringify(value)} not a string`);
+  }
+  return value;
+}
+function buildCheckSum(num) {
+  return c[num];
+}
+function buildCcValues(personId) {
+  return [
+    getString(personId[0]),
+    getString(personId[1]),
+    getString(personId[2]),
+    getString(personId[3]),
+    getString(personId[4]),
+    getString(personId[5]),
+    getString(personId[6]),
+    getString(personId[7]),
+    getString(personId[8]),
+    getString(personId[9]),
+    getString(personId[10])
+  ];
+}
+function isValidPersonId(personId) {
+  if (personId.length !== 11) {
+    return false;
+  }
+  const d = buildCcValues(personId.toUpperCase());
+  return d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);
+}
+function isMale(personId) {
+  if (!isValidPersonId(personId)) {
+    throw new TypeError("not valid person id");
+  }
+  const d = buildCcValues(personId);
+  return toInt(d[7] + d[8] + d[9]) % 2 === 1;
+}
+function isFemale(personId) {
+  return !isMale(personId);
+}
+export {
+  isFemale,
+  isMale,
+  isValidPersonId
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["const c = '0123456789ABCDEFHJKLMNPRSTUVWXY';\n\n/**\n * Parse string to integer\n * @throws TypeError if value is not a number\n * @param value\n * @returns value as number\n */\nfunction toInt(value: string | undefined): number {\n\tif (!value) {\n\t\tthrow new TypeError('undefined');\n\t}\n\tconst outValue = parseInt(value, 10);\n\tif (isNaN(outValue)) {\n\t\tthrow new TypeError(`${value} not a number`);\n\t}\n\treturn outValue;\n}\n\n/**\n * Validate that value is a string\n * @throws TypeError if value is not a string\n * @param value\n * @returns value as string\n */\nfunction getString(value: unknown): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new TypeError(`${JSON.stringify(value)} not a string`);\n\t}\n\treturn value;\n}\n\n/**\n * Build checksum for personId (last character)\n * @param num - number to build checksum from\n * @returns checksum character\n */\nfunction buildCheckSum(num: number): string | undefined {\n\treturn c[num];\n}\n\n/**\n * Construct array of string values from personId string\n * @param personId - personId string\n * @returns\n */\nfunction buildCcValues(personId: string): [string, string, string, string, string, string, string, string, string, string, string] {\n\treturn [\n\t\tgetString(personId[0]),\n\t\tgetString(personId[1]),\n\t\tgetString(personId[2]),\n\t\tgetString(personId[3]),\n\t\tgetString(personId[4]),\n\t\tgetString(personId[5]),\n\t\tgetString(personId[6]),\n\t\tgetString(personId[7]),\n\t\tgetString(personId[8]),\n\t\tgetString(personId[9]),\n\t\tgetString(personId[10]),\n\t];\n}\n\n/**\n * Validate if string is a valid personId\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isValidPersonId('131052-308T') // true\n * isValidPersonId('131052-3082') // false\n */\nexport function isValidPersonId(personId: string): boolean {\n\tif (personId.length !== 11) {\n\t\treturn false;\n\t}\n\tconst d = buildCcValues(personId.toUpperCase());\n\treturn d[10] === buildCheckSum(toInt(d[0] + d[1] + d[2] + d[3] + d[4] + d[5] + d[7] + d[8] + d[9]) % 31);\n}\n\n/**\n * Check if personId is for male\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isMale('131052-308T') // false\n */\nexport function isMale(personId: string): boolean {\n\tif (!isValidPersonId(personId)) {\n\t\tthrow new TypeError('not valid person id');\n\t}\n\tconst d = buildCcValues(personId);\n\treturn toInt(d[7] + d[8] + d[9]) % 2 === 1;\n}\n\n/**\n * Check if personId is for female\n * @throws TypeError if personId is not valid\n * @param personId - personId string\n * @returns true if valid, false if not\n * @example\n * isFemale('131052-308T') // true\n */\nexport function isFemale(personId: string): boolean {\n\treturn !isMale(personId);\n}\n"],"mappings":";AAAA,IAAM,IAAI;AAQV,SAAS,MAAM,OAAmC;AACjD,MAAI,CAAC,OAAO;AACX,UAAM,IAAI,UAAU,WAAW;AAAA,EAChC;AACA,QAAM,WAAW,SAAS,OAAO,EAAE;AACnC,MAAI,MAAM,QAAQ,GAAG;AACpB,UAAM,IAAI,UAAU,GAAG,KAAK,eAAe;AAAA,EAC5C;AACA,SAAO;AACR;AAQA,SAAS,UAAU,OAAwB;AAC1C,MAAI,OAAO,UAAU,UAAU;AAC9B,UAAM,IAAI,UAAU,GAAG,KAAK,UAAU,KAAK,CAAC,eAAe;AAAA,EAC5D;AACA,SAAO;AACR;AAOA,SAAS,cAAc,KAAiC;AACvD,SAAO,EAAE,GAAG;AACb;AAOA,SAAS,cAAc,UAA4G;AAClI,SAAO;AAAA,IACN,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,CAAC,CAAC;AAAA,IACrB,UAAU,SAAS,EAAE,CAAC;AAAA,EACvB;AACD;AAUO,SAAS,gBAAgB,UAA2B;AAC1D,MAAI,SAAS,WAAW,IAAI;AAC3B,WAAO;AAAA,EACR;AACA,QAAM,IAAI,cAAc,SAAS,YAAY,CAAC;AAC9C,SAAO,EAAE,EAAE,MAAM,cAAc,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;AACxG;AAUO,SAAS,OAAO,UAA2B;AACjD,MAAI,CAAC,gBAAgB,QAAQ,GAAG;AAC/B,UAAM,IAAI,UAAU,qBAAqB;AAAA,EAC1C;AACA,QAAM,IAAI,cAAc,QAAQ;AAChC,SAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM;AAC1C;AAUO,SAAS,SAAS,UAA2B;AACnD,SAAO,CAAC,OAAO,QAAQ;AACxB;","names":[]}

package/package.json

@@ -1,55 +1,89 @@
 {
-  "name": "fi-pin",
-  "version": "0.0.4",
-  "description": "Finnish Personal Identification Number validate + gender check",
-  "main": "dist/index.js",
-  "devDependencies": {
-    "@types/chai": "^4.2.8",
-    "@types/mocha": "^7.0.1",
-    "@types/node": "^13.7.0",
-    "chai": "^4.2.0",
-    "mocha": "^7.0.1",
-    "nyc": "^15.0.0",
-    "source-map-support": "^0.5.16",
-    "ts-node": "^8.6.2",
-    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.7.5"
-  },
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run test && npm run build",
-    "test": "mocha test/*.ts",
-    "coverage": "nyc mocha test/*.ts"
-  },
-  "keywords": [
-    "pin",
-    "personid"
-  ],
-  "files": [
-    "dist"
-  ],
-  "nyc": {
-    "extension": [
-      ".ts"
+    "name": "fi-pin",
+    "version": "0.0.6",
+    "description": "Finnish Personal Identification Number validate + gender check",
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/index.js",
+            "import": "./dist/index.mjs",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "devDependencies": {
+        "@types/chai": "^4.3.16",
+        "@types/mocha": "^9.1.1",
+        "@types/node": "^14.18.63",
+        "@typescript-eslint/eslint-plugin": "^7.8.0",
+        "@typescript-eslint/parser": "^7.8.0",
+        "chai": "^4.4.1",
+        "eslint": "^8.57.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-deprecation": "^2.0.0",
+        "eslint-plugin-jsdoc": "^48.2.3",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-sonarjs": "^0.23.0",
+        "mocha": "^10.4.0",
+        "mocha-junit-reporter": "^2.2.1",
+        "nyc": "^15.1.0",
+        "source-map-support": "^0.5.21",
+        "ts-node": "^10.9.2",
+        "tsup": "^8.0.2",
+        "typescript": "^5.4.5"
+    },
+    "scripts": {
+        "build": "tsup src/index.ts --sourcemap --format cjs,esm --dts --clean",
+        "prepublishOnly": "npm run test && npm run build",
+        "test": "nyc mocha",
+        "lint": "eslint src/ test/"
+    },
+    "mocha": {
+        "exit": true,
+        "extension": [
+            "ts",
+            "js"
+        ],
+        "recursive": true,
+        "require": [
+            "ts-node/register",
+            "source-map-support/register"
+        ],
+        "reporters": [
+            "spec",
+            "mocha-junit-reporter"
+        ]
+    },
+    "keywords": [
+        "pin",
+        "personid"
     ],
-    "include": [
-      "src"
+    "files": [
+        "dist"
     ],
-    "reporter": [
-      "text",
-      "html"
-    ],
-    "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"
+    "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"
 }