@remato/personal-code-to-birthday 0.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: build
+
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Setup node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+
+            - name: Install dependencies
+              run: npm install
+
+            - name: Check code format
+              run: npm run prettier
+
+            - name: Lint
+              run: npm run lint
+
+            - name: Test
+              run: npm run test
+
+            - name: Upload coverage reports to Codecov
+              uses: codecov/codecov-action@v4.0.1
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
+
+            - name: Build
+              run: npm run build

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Remato
+
+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

@@ -0,0 +1,48 @@
+# Personal Code to Birthday
+
+[![Build](https://img.shields.io/github/actions/workflow/status/rematocorp/personal-code-to-birthday/ci.yml)](https://github.com/rematocorp/personal-code-to-birthday/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/rematocorp/personal-code-to-birthday?token=NDT35FM2LG&style=flat)](https://codecov.io/gh/rematocorp/personal-code-to-birthday)
+
+Converts personal identification codes (or national ID numbers) from various countries into birthdate.
+
+### Install
+
+```bash
+npm install @remato/personal-code-to-birthday
+```
+
+### How to use
+
+```ts
+const birthday = personalCodeToBirthday('39309262855')
+
+console.log(birthday) // outputs { day: 26, month: 9, year: 1993 }
+```
+
+### Countries supported
+
+-   🇪🇪 Estonia
+-   🇱🇻 Latvia
+-   🇱🇹 Lithuania
+-   🇫🇮 Finland
+-   🇸🇪 Sweden
+-   🇳🇴 Norway
+-   🇩🇰 Denmark
+
+Countries we would like to support (PRs are welcome):
+
+-   Iceland
+-   South Africa
+-   Romania
+-   Hungary
+-   Bulgaria
+-   North Macedonia
+-   Czech Republic
+-   Slovakia
+-   Poland
+-   South Korea
+-   Turkey
+-   Moldova
+-   Azerbaijan
+-   Russia
+-   Ukraine

package/index.test.ts

@@ -0,0 +1,79 @@
+import personalCodeToBirthday from './index'
+
+describe('valid codes', () => {
+	test('Estonia', () => {
+		expect(personalCodeToBirthday('39405280299')).toEqual({ day: 28, month: 5, year: 1994 })
+		expect(personalCodeToBirthday('60105280299')).toEqual({ day: 28, month: 5, year: 2001 })
+	})
+
+	test('Latvia', () => {
+		expect(personalCodeToBirthday('050393-12344')).toEqual({ day: 5, month: 3, year: 1993 })
+		expect(personalCodeToBirthday('050303-22344')).toEqual({ day: 5, month: 3, year: 2003 })
+	})
+
+	test('Lithuania', () => {
+		expect(personalCodeToBirthday('39905280217')).toEqual({ day: 28, month: 5, year: 1999 })
+	})
+
+	test('Finland', () => {
+		expect(personalCodeToBirthday('101085-7001')).toEqual({ day: 10, month: 10, year: 1985 })
+		expect(personalCodeToBirthday('101085+789W')).toEqual({ day: 10, month: 10, year: 1885 })
+		expect(personalCodeToBirthday('150752-308N')).toEqual({ day: 15, month: 7, year: 1952 })
+		expect(personalCodeToBirthday('010100A123D')).toEqual({ day: 1, month: 1, year: 2000 })
+	})
+
+	test('Sweden', () => {
+		expect(personalCodeToBirthday('199001011234')).toEqual({ day: 1, month: 1, year: 1990 })
+	})
+
+	test('Norway', () => {
+		expect(personalCodeToBirthday('01020352345')).toEqual({ day: 1, month: 2, year: 2003 })
+	})
+
+	test('Denmark', () => {
+		expect(personalCodeToBirthday('0503054567')).toEqual({ day: 5, month: 3, year: 2005 })
+		expect(personalCodeToBirthday('0503841235')).toEqual({ day: 5, month: 3, year: 1984 })
+		expect(personalCodeToBirthday('050384-1235')).toEqual({ day: 5, month: 3, year: 1984 })
+		expect(personalCodeToBirthday('0503844567')).toEqual({ day: 5, month: 3, year: 1984 })
+	})
+})
+
+describe('invalid personal code', () => {
+	test('Estonia', () => {
+		const result = personalCodeToBirthday('39913025555')
+		expect(result).toBeNull()
+	})
+
+	test('Latvia', () => {
+		expect(personalCodeToBirthday('123456-12345')).toBeNull()
+	})
+
+	test('Lithuania', () => {
+		expect(personalCodeToBirthday('99905280217')).toBeNull()
+	})
+
+	test('Finland', () => {
+		expect(personalCodeToBirthday('999999A123T')).toBeNull()
+		expect(personalCodeToBirthday('131052Z3087')).toBeNull()
+		expect(personalCodeToBirthday('321052A3087')).toBeNull()
+	})
+
+	test('Sweden', () => {
+		expect(personalCodeToBirthday('1990010123456')).toBeNull()
+		expect(personalCodeToBirthday('199013011234')).toBeNull()
+		expect(personalCodeToBirthday('199001341234')).toBeNull()
+	})
+
+	test('Norway', () => {
+		expect(personalCodeToBirthday('32129999999')).toBeNull()
+	})
+
+	test('Denmark', () => {
+		expect(personalCodeToBirthday('9999991234')).toBeNull()
+	})
+
+	test('unsupported personal code format', () => {
+		const result = personalCodeToBirthday('abcd1234')
+		expect(result).toBeNull()
+	})
+})

package/index.ts

@@ -0,0 +1,192 @@
+interface ParsedDate {
+	day: number
+	month: number
+	year: number
+}
+
+export default function personalCodeToBirthday(code: string): ParsedDate | null {
+	if (/^\d{11}$/.test(code)) {
+		// Could be Estonia, Lithuania, or Norway
+		const birthday = estonianLithuanianParser(code)
+		if (birthday) {
+			return birthday
+		}
+
+		return norwayParser(code)
+	} else if (/^\d{6}-\d{5}$/.test(code)) {
+		return latvianParser(code)
+	} else if (/^\d{6}[+-A]\d{3}[A-Za-z]$/.test(code)) {
+		return finlandParser(code)
+	} else if (/^\d{6}[+-A]\d{4}$/.test(code)) {
+		// Could be Finland or Denmark
+		const birthday = finlandParser(code)
+		if (birthday) {
+			return birthday
+		}
+
+		return denmarkParser(code)
+	} else if (/^\d{12}$/.test(code)) {
+		return swedenParser(code)
+	} else if (/^\d{10}$/.test(code)) {
+		return denmarkParser(code)
+	}
+
+	return null
+}
+
+// Estonia (EE) and Lithuanian (LT) Parser
+function estonianLithuanianParser(code: string): ParsedDate | null {
+	const centuryCode = parseInt(code[0], 10)
+	const day = parseInt(code.slice(5, 7), 10)
+	const month = parseInt(code.slice(3, 5), 10)
+	let year = parseInt(code.slice(1, 3), 10)
+
+	if (centuryCode === 3 || centuryCode === 4) {
+		year += 1900
+	}
+	if (centuryCode === 5 || centuryCode === 6) {
+		year += 2000
+	}
+
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+// Latvia (LV) Parser
+// Correct old school format is DDMMYY-CXXXX
+function latvianParser(code: string): ParsedDate | null {
+	const day = parseInt(code.slice(0, 2), 10)
+	const month = parseInt(code.slice(2, 4), 10)
+	let year = parseInt(code.slice(4, 6), 10)
+	const centuryCode = parseInt(code[7], 10)
+
+	// Latvian codes are always from the 20th century, so add 1900
+	if (centuryCode === 2) {
+		year += 2000
+	} else {
+		year += 1900
+	}
+
+	// Validate the parsed date
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+// Finland (FI) Parser
+function finlandParser(code: string): ParsedDate | null {
+	const day = parseInt(code.slice(0, 2), 10)
+	const month = parseInt(code.slice(2, 4), 10)
+	const yearSuffix = parseInt(code.slice(4, 6), 10)
+	const centuryMarker = code[6]
+
+	let year = yearSuffix
+
+	// Handle the century based on the marker
+	if (centuryMarker === '+') {
+		year += 1800
+	} else if (centuryMarker === '-') {
+		year += 1900
+	} else if (centuryMarker === 'A') {
+		year += 2000
+	}
+
+	// Validate the parsed date
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	if (!isValidFinnishChecksum(code)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+function isValidFinnishChecksum(code: string): boolean {
+	const validChars = '0123456789ABCDEFHJKLMNPRSTUVWXY'
+
+	const serial = code.slice(0, 6) + code.slice(7, 10)
+	const checksum = code[10]
+	const num = parseInt(serial, 10)
+	const remainder = num % 31
+	const expectedChecksum = validChars.charAt(remainder)
+
+	return expectedChecksum === checksum.toUpperCase()
+}
+
+// Sweden (SE) Parser
+function swedenParser(code: string): ParsedDate | null {
+	const year = parseInt(code.slice(0, 4), 10)
+	const month = parseInt(code.slice(4, 6), 10)
+	const day = parseInt(code.slice(6, 8), 10)
+
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+// Norway (NO) Parser
+function norwayParser(code: string): ParsedDate | null {
+	const day = parseInt(code.slice(0, 2), 10)
+	const month = parseInt(code.slice(2, 4), 10)
+	let year = parseInt(code.slice(4, 6), 10)
+
+	const individual = parseInt(code.slice(6, 9), 10)
+
+	// Determine century based on individual number and year
+	if (individual <= 499 || (individual >= 500 && year >= 40)) {
+		year += 1900
+	} else if (individual <= 999 && year <= 39) {
+		year += 2000
+	}
+
+	// Now validate the date after adjusting the century
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+// Denmark (DK) Parser
+function denmarkParser(code: string): ParsedDate | null {
+	if (code.includes('-')) {
+		code = code.replace('-', '')
+	}
+
+	const day = parseInt(code.slice(0, 2), 10)
+	const month = parseInt(code.slice(2, 4), 10)
+	let year = parseInt(code.slice(4, 6), 10)
+	const centuryIndicator = parseInt(code.slice(6, 7), 10)
+
+	// Determine century based on the 7th digit and the year
+	if (centuryIndicator >= 0 && centuryIndicator <= 3) {
+		year += 1900
+	} else if (centuryIndicator >= 4 && centuryIndicator <= 9) {
+		if (year >= 0 && year <= 36) {
+			year += 2000
+		} else {
+			year += 1900
+		}
+	}
+
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+function isValidDate(day: number, month: number, year: number): boolean {
+	const date = new Date(year, month - 1, day) // month is zero-indexed in JS Date
+
+	return date.getFullYear() === year && date.getMonth() === month - 1 && date.getDate() === day
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@remato/personal-code-to-birthday",
+	"version": "0.0.0",
+	"description": "Converts personal identification codes from various countries into birthdate",
+	"license": "MIT",
+	"main": "index.ts",
+	"scripts": {
+		"build": "ncc build index.ts",
+		"test": "jest",
+		"prettier": "prettier --list-different \"**/*.ts\"",
+		"lint": "eslint \"**/*.ts\""
+	},
+	"devDependencies": {
+		"@remato/eslint-config": "^1.14.0",
+		"@remato/prettier-config": "^1.0.0",
+		"@types/jest": "^29.5.14",
+		"@vercel/ncc": "^0.38.2",
+		"eslint": "^8.57.1",
+		"jest": "^29.7.0",
+		"prettier": "^3.3.3",
+		"ts-jest": "^29.2.5",
+		"typescript": "^5.6.3"
+	},
+	"jest": {
+		"preset": "ts-jest",
+		"testEnvironment": "node",
+		"moduleFileExtensions": [
+			"js",
+			"ts"
+		],
+		"testMatch": [
+			"**/*.test.ts"
+		],
+		"testPathIgnorePatterns": [
+			"/node_modules/",
+			"/dist/"
+		],
+		"transform": {
+			"^.+\\.ts$": "ts-jest"
+		},
+		"collectCoverage": true,
+		"collectCoverageFrom": [
+			"index.ts"
+		]
+	},
+	"eslintConfig": {
+		"extends": [
+			"@remato/eslint-config/typescript"
+		]
+	}
+}

package/prettier.config.js

@@ -0,0 +1 @@
+module.exports = require("@remato/prettier-config");

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"compilerOptions": {
+		"target": "ES2022",
+		"module": "NodeNext",
+		"rootDir": "./",
+		"moduleResolution": "NodeNext",
+		"baseUrl": "./",
+		"sourceMap": true,
+		"outDir": "./dist",
+		"noImplicitAny": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"strict": true,
+		"skipLibCheck": true,
+		"newLine": "lf"
+	},
+	"exclude": ["./node_modules"]
+}