Organization meta. Find all implementations on personnummer.dev.
Every package should have .meta.yaml file containing information about the name, maintainer, specification version and which workflow file to show the build badge from. The values of the meta file will be used for the implementations table on personnummer.dev
Example of .meta.yaml
name: "JavaScript"
maintainer: "@frozzare"
spec: 3.1
workflow: "nodejs.yml"We use the MIT license for all packages and the copyright row should look like this:
Copyright (c) Personnummer and Contributors
The personnummer package should have a valid method that can take both a number and a string as input.
personnummer.valid(string)
personnummer.valid(number)The personnummer package should have a valid method that can take both a number and a string as input.
The second argument should be a optional boolean that exclude coordination number (Samordningsnummer) from validation.
personnummer.valid(string, [bool includeCoordinationNumber = true])
personnummer.valid(number, [bool includeCoordinationNumber = true])The package should include a format method that can format the input value (string or number) as a short or long personnumer.
The second argument should be a optional boolean and true should format the input value as a long personnummer.
personnummer.format(number, [bool longFormat = false])
personnummer.format(string, [bool longFormat = false])The package should include a getAge method that returns the age from a personnummer. For coordination number (Samordningsnummer) we should remove 60 to get the right age.
The second argument should be a optional boolean that exclude coordination number (Samordningsnummer) from validation.
personnummer.getAge(number, [bool includeCoordinationNumber = true])
personnummer.getAge(string, [bool includeCoordinationNumber = true])Dash or plus should be optional.
YYMMDD-XXXX
YYMMDD+XXXX
YYMMDDXXXX
YYYYMMDD-XXXX
YYYYMMDD+XXXX
YYYYMMDDXXXX
Coordination number (Samordningsnummer) should also be a valid personnummer.
Output for format method
YYMMDD-XXXX
Output for format method
YYYYMMDDXXXX
This specification adds new features and includes all parts from 2.0.
The package should include isMale and isFemale methods that can check if the personnummer or coordination number is a female or male.
personnummer.isMale(number|string, [bool includeCoordinationNumber = true])
personnummer.isFemale(number|string, [bool includeCoordinationNumber = true])This methods should throw errors when input value is not a valid personnummer or coordination number.
Version 3 will contain breaking changes and will not be compatible with version 1 or 2.
These functions will be moved into the class:
formatgetAgeisFemaleisMale
The valid function can be a function or a static method on the class depending on language. The valid version that supports number arguments will be removed.
The package should include a class that which should be the return value of parse
class Personnummer {
public function __construct(string, array|object|languageSpecific)
}The package should include a parse method that creates a new instance of the new class.
The parse and the class constructor should contain a second argument with options for the feature.
personnummer.parse(string, array|object|languageSpecific = []) => new class instanceThe class should contain a static parse method that returns the class instance.
const pnr = Personnummer::parse(string, array|object|languageSpecific = [])The coordination number option will be removed for all methods and be replaced with isCoordinationNumber method or property instead.
const pnr = personnummer.parse(string)
if (pnr.isCoordinationNumber()) {
return
}All methods except for valid should throw an exception or return an error as a second return value. Error handling may be different depending on language. The exception/error class should be prefixed with Personnummer
Options may be different depending on language.
interface Personnummer {
string century;
string fullYear;
string year;
string month;
string day;
string sep;
string num;
string check;
public function __construct(string ssn, array|object|languageSpecific options = []);
public static function parse(string ssn);
public function format(boolean longFormat) : string;
public function getAge() : int;
public function isFemale() : boolean;
public function isMale() : boolean;
public function isCoordinationNumber() : boolean;
}
function valid(string ssn) {
try {
parse(ssn)
return true
} catch (PersonnummerParseException) {
return false
}
}
function parse(string ssn, array|object|languageSpecific options = []) {
return new Personnummer(ssn, options)
}This specification adds new features and includes all parts from 3.0.
The package should include getDate function to expose the underlying date value. For coordination numbers the day should be removed with 60 days to get the correct day for a real date.
Also called T-Number
The package should support Interim-numbers YYMMDD-Xnnn (where X is a letter rather than number) and include isInterimNumber function in the same way as isCoordinationNumber
The format function should respect Interim-number and format the number both in the long and short way with the letter at the first of the four in the 4-digit number.
Read more about interim-number at KTH and at sunet.
To make the package future-proof, we support all 11 interim letters: T, R, S, U, W, X, J, K, L, M, N where all are replaced with a 1 in the luhn calculation.
To not break the package for users whom do not want to make use of the interim-number implementation, the options object for the parse function and constructor have been re-added and should have two values:
{
"allowCoordinationNumber": true,
"allowInterimNumber": false
}As seen, the coordination-number should be true by default (as it's true by default in the v3.0 api) while the interim-number is false by default (as it does not exist yet and is used a lot more rarely).
interface Personnummer {
public function getDate() : Date;
public function isInterimNumber() : boolean;
}
