@remato/personal-code-to-birthday 1.1.1 → 1.2.0

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/" 
+    schedule:
+      interval: "weekly"

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,2 @@
+-   Make sure your changes are [prettified](https://prettier.io/) (you can use `npm run prettier`)
+-   Add unit tests to maintain 100% coverage

package/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+##### Checklist
+
+-   [ ] Updated README.md
+-   [ ] Wrote tests

package/README.md

@@ -3,15 +3,26 @@
 [![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.
+Converts personal identification codes from various countries into birthdate.
 
-### Install
+### Features
+
+-   **Automatic Birthdate Extraction**: Effortlessly extracts birthdates from national ID codes.
+-   **Built-in Validation**: Confirms personal code validity using checksum verification before returning a date.
+-   **Country-Agnostic**: Automatically identifies and processes the country format, requiring no additional parameters.
+-   **Lightweight & Seamless Integration**: Designed for easy integration into any project with minimal setup.
+
+### Limitations
+
+-   **Date Range Restriction**: Only supports personal codes issued from 1900 to the present. Future-dated codes are not currently supported.
+
+### Installation
 
 ```bash
 npm install @remato/personal-code-to-birthday
 ```
 
-### How to use
+### Usage
 
 ```ts
 const birthday = personalCodeToBirthday('39309262855')
@@ -21,28 +32,15 @@ console.log(birthday) // outputs { day: 26, month: 9, year: 1993 }
 
 ### Countries supported
 
--   🇪🇪 Estonia
--   🇱🇻 Latvia
--   🇱🇹 Lithuania
--   🇫🇮 Finland
--   🇸🇪 Sweden
--   🇳🇴 Norway
--   🇩🇰 Denmark
--   🇺🇦 Ukraine
--   🇵🇱 Poland
-
-Countries we would like to support (PRs are welcome):
-
--   Iceland
--   Romania
--   Hungary
--   Bulgaria
--   Moldova
--   Azerbaijan
--   North Macedonia
--   Czech Republic
--   Slovakia
--   South Korea
--   Turkey
--   South Africa
--   Russia
+1. 🇺🇦 Ukraine
+2. 🇪🇪 Estonia
+3. 🇱🇻 Latvia
+4. 🇱🇹 Lithuania
+5. 🇵🇱 Poland
+6. 🇫🇮 Finland
+7. 🇸🇪 Sweden
+8. 🇳🇴 Norway
+9. 🇩🇰 Denmark
+10. 🇷🇴 Romania
+
+Need support for a new country or have feedback? [Create an issue.](https://github.com/rematocorp/personal-code-to-birthday/issues/new)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remato/personal-code-to-birthday",
-	"version": "1.1.1",
+	"version": "1.2.0",
 	"description": "Converts personal identification codes from various countries into birthdate",
 	"license": "MIT",
 	"main": "src/index.ts",

package/src/index.test.ts

@@ -58,6 +58,12 @@ describe('valid codes', () => {
 		expect(personalCodeToBirthday('02070803628')).toEqual({ day: 8, month: 7, year: 1902 })
 		expect(personalCodeToBirthday('24231012344')).toEqual({ day: 10, month: 3, year: 2024 })
 	})
+
+	test('Romania', () => {
+		expect(personalCodeToBirthday('1900101220018')).toEqual({ day: 1, month: 1, year: 1990 })
+		expect(personalCodeToBirthday('6010303275841')).toEqual({ day: 3, month: 3, year: 2001 })
+		expect(personalCodeToBirthday('2990721275847')).toEqual({ day: 21, month: 7, year: 1999 })
+	})
 })
 
 describe('invalid personal code', () => {
@@ -108,6 +114,11 @@ describe('invalid personal code', () => {
 		expect(personalCodeToBirthday('24234012341')).toBeNull()
 	})
 
+	test('Romania', () => {
+		expect(personalCodeToBirthday('1980521275840')).toBeNull()
+		expect(personalCodeToBirthday('1234567890128')).toBeNull()
+	})
+
 	test('unidentified personal code format', () => {
 		expect(personalCodeToBirthday('abcd1234')).toBeNull()
 	})

package/src/index.ts

@@ -4,6 +4,7 @@ import finlandParser from './parsers/finland'
 import latviaParser from './parsers/latvia'
 import norwayParser from './parsers/norway'
 import polandParser from './parsers/poland'
+import romaniaParser from './parsers/romania'
 import swedenParser from './parsers/sweden'
 import ukraineParser from './parsers/ukraine'
 import { ParsedDate } from './types'
@@ -17,6 +18,8 @@ export default function personalCodeToBirthday(code: string): ParsedDate | null
 		return estoniaLithuaniaParser(code) || polandParser(code) || norwayParser(code)
 	} else if (/^\d{12}$/.test(code)) {
 		return swedenParser(code)
+	} else if (/^\d{13}$/.test(code)) {
+		return romaniaParser(code)
 	} else if (/^\d{6}-\d{5}$/.test(code)) {
 		return latviaParser(code)
 	} else if (/^\d{6}[+-A]\d{3}[A-Za-z]$/.test(code)) {

package/src/parsers/romania.ts

@@ -0,0 +1,38 @@
+import { ParsedDate } from '../types'
+import { isValidDate } from '../utils'
+
+export default function romaniaParser(code: string): ParsedDate | null {
+	if (!isValidChecksum(code)) {
+		return null
+	}
+
+	let year = parseInt(code.slice(1, 3), 10)
+	const month = parseInt(code.slice(3, 5), 10)
+	const day = parseInt(code.slice(5, 7), 10)
+	const gender = parseInt(code[0], 10)
+
+	if (gender === 1 || gender === 2) {
+		year += 1900
+	} else if (gender === 5 || gender === 6) {
+		year += 2000
+	}
+
+	if (!isValidDate(day, month, year)) {
+		return null
+	}
+
+	return { day, month, year }
+}
+
+function isValidChecksum(code: string): boolean {
+	const weights = [2, 7, 9, 1, 4, 6, 3, 5, 8, 2, 7, 9]
+	let sum = 0
+
+	for (let i = 0; i < 12; i++) {
+		sum += parseInt(code[i]) * weights[i]
+	}
+
+	const checksum = sum % 11 === 10 ? 1 : sum % 11
+
+	return checksum === parseInt(code[12])
+}

package/src/parsers/sweden.ts

@@ -35,7 +35,7 @@ export default function swedenParser(code: string): ParsedDate | null {
 	return { day, month, year }
 }
 
-function isValidChecksum(code: string) {
+function isValidChecksum(code: string): boolean {
 	// Use the last 9 digits without checksum number
 	const digits = code.length === 12 ? code.slice(2, 11) : code.slice(0, 9)