bsn-js 1.0.0 → 1.0.4

package/README.md

@@ -1,2 +1,62 @@
 [![lint-test-build](https://github.com/willemverbuyst/bsn-js/actions/workflows/lint-test-build.yml/badge.svg)](https://github.com/willemverbuyst/bsn-js/actions/workflows/lint-test-build.yml)
 [![pages-build-deployment](https://github.com/willemverbuyst/bsn-js/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/willemverbuyst/bsn-js/actions/workflows/pages/pages-build-deployment)
+
+# bsn-js
+
+bsn-js can be used to generate a test BSN (burger service nummer) or validate an existing BSN
+
+works for JavaScript and TypeScript (type definitions included)
+
+## installation
+
+`npm install bsn-js`
+
+or using yarn
+
+`yarn add bsn-js`
+
+<br>
+
+## usage
+
+#### validate existing BSN
+
+`import { isValidBSN } from 'bsn-js'`
+
+or
+
+`const { isValidBSN } = require('bsn-js')`
+
+pass the BSN (string) to the function and it will return `true` or `false`
+
+example: `const validBSN = isValidBSN('12312312') # false`
+
+<br>
+
+#### generate BSN for testing
+
+`import { generateBSN } from 'bsn-js'`
+
+or
+
+`const { generateBSN } = require('bsn-js)`
+
+test BSNs will consist of 9 characters
+
+the Dutch authority has reserved BSNs starting with 0000 and 99999 for testing
+
+the generetated BSN will start with 99999 by default
+
+`const bsn = generateBSN() # 999999400`
+
+when the function generateBSN is given true as argument, it will return a BSN starting with 0000
+
+`const bsn = generateBSN(true) # 000078840`
+
+<br>
+
+## information BSN
+
+[official docs](https://www.government.nl/topics/personal-data/citizen-service-number-bsn)
+
+[11 check](https://en.wikipedia.org/wiki/Check_digit)

package/lib/generator.js

@@ -4,7 +4,7 @@ exports.generateBSN = void 0;
 var generateBSN = function (withLeadingZeroes) {
     var bsn = {
         leading: '9999',
-        i4: Math.floor(Math.random() * 10),
+        i4: 9,
         i5: Math.floor(Math.random() * 10),
         i6: Math.floor(Math.random() * 10),
         i7: Math.floor(Math.random() * 10),

package/lib/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"/","sources":["generator.ts"],"names":[],"mappings":";;;AAgBO,IAAM,WAAW,GAAG,UAAC,iBAA2B;IACtD,IAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,MAAM;QACf,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,CAAC;KACL,CAAA;IAED,IAAI,iBAAiB;QAAE,GAAG,CAAC,OAAO,GAAG,MAAM,CAAA;IAE3C,IAAM,GAAG,GACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,CAC7C,UAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAf,CAAe,EAC5B,CAAC,CACD;QACD,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE,CAAA;IAEX,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;IAEpD,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE;QAC7B,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;QACX,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;KACV;IAED,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE;QAChC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;QACX,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;KACV;IAED,OAAO,UAAG,GAAG,CAAC,OAAO,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,CAAE,CAAA;AACrE,CAAC,CAAA;AAnCY,QAAA,WAAW,eAmCvB"}
+{"version":3,"file":"generator.js","sourceRoot":"/","sources":["generator.ts"],"names":[],"mappings":";;;AAgBO,IAAM,WAAW,GAAG,UAAC,iBAA2B;IACtD,IAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,MAAM;QACf,EAAE,EAAE,CAAC;QACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAClC,EAAE,EAAE,CAAC;KACL,CAAA;IAED,IAAI,iBAAiB;QAAE,GAAG,CAAC,OAAO,GAAG,MAAM,CAAA;IAE3C,IAAM,GAAG,GACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,CAC7C,UAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAf,CAAe,EAC5B,CAAC,CACD;QACD,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE;QACV,CAAC,GAAG,GAAG,CAAC,EAAE,CAAA;IAEX,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;IAEpD,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE;QAC7B,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;QACX,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;KACV;IAED,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE;QAChC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;QACX,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;KACV;IAED,OAAO,UAAG,GAAG,CAAC,OAAO,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,SAAG,GAAG,CAAC,EAAE,CAAE,CAAA;AACrE,CAAC,CAAA;AAnCY,QAAA,WAAW,eAmCvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "bsn-js",
-	"version": "1.0.0",
+	"version": "1.0.4",
 	"description": "Generator/validator for (Dutch) BSNs",
 	"repository": "https://github.com/willemverbuyst/bsn-js",
 	"author": "Willem Verbuyst",
@@ -29,7 +29,7 @@
 		"size": "size-limit",
 		"test": "jest",
 		"build": "tsc -p tsconfig.json",
-		"clean": "rm -rf lib build",
+		"clean": "rm -rf ./lib",
 		"docs": "typedoc --entryPoints src/index.ts",
 		"prepare": "npm run clean && npm run build",
 		"prepublishOnly": "npm test && npm run lint",

package/lib/generator.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/generator.spec.js

@@ -1,12 +0,0 @@
-"use strict";
-exports.__esModule = true;
-var generator_1 = require("./generator");
-var validator_1 = require("./validator");
-describe('#generateBSN', function () {
-    var testcases = Array.from({ length: 50 }, function (_, i) { return i + 1; });
-    test.each(testcases)('%s: should generate valid BSN)', function () {
-        return expect((0, validator_1.isValidBSN)((0, generator_1.generateBSN)())).toBe(true);
-    });
-    test.each(testcases)('%s: with leading "0000" should generate valid BSN)', function () { return expect((0, validator_1.isValidBSN)((0, generator_1.generateBSN)(true))).toBe(true); });
-});
-//# sourceMappingURL=generator.spec.js.map

package/lib/generator.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generator.spec.js","sourceRoot":"/","sources":["generator.spec.ts"],"names":[],"mappings":";;AAAA,yCAAyC;AACzC,yCAAwC;AAExC,QAAQ,CAAC,cAAc,EAAE;IACxB,IAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,GAAG,CAAC,EAAL,CAAK,CAAC,CAAA;IAE7D,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,gCAAgC,EAAE;QACtD,OAAA,MAAM,CAAC,IAAA,sBAAU,EAAC,IAAA,uBAAW,GAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAA5C,CAA4C,CAC5C,CAAA;IAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CACnB,oDAAoD,EACpD,cAAM,OAAA,MAAM,CAAC,IAAA,sBAAU,EAAC,IAAA,uBAAW,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAhD,CAAgD,CACtD,CAAA;AACF,CAAC,CAAC,CAAA"}

package/lib/validator.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/validator.spec.js

@@ -1,116 +0,0 @@
-"use strict";
-exports.__esModule = true;
-var validator_1 = require("./validator");
-var validBSNs = [
-    '000006944',
-    '000003086',
-    '000006154',
-    '999993239',
-    '000003803',
-    '000007900',
-    '999992089',
-    '799890054',
-    '000005083',
-    '000001533',
-    '000000681',
-    '999999941',
-    '999998882',
-    '999994505',
-    '999997282',
-    '000006506',
-    '000005642',
-    '000002082',
-    '000001156',
-    '999990202',
-    '000004583',
-    '999999606',
-    '000006580',
-    '999995315',
-    '000007006',
-    '000002264',
-    '000001880',
-    '000005551',
-    '000007560',
-    '000002963',
-    '000008230',
-    '999994657',
-    '999999357',
-    '999993768',
-    '000009611',
-    '000000929',
-    '999995224',
-    '000005873',
-    '000007869',
-    '999992260',
-    '999994438',
-    '999996526',
-    '999991541',
-    '999999229',
-    '000005137',
-    '999994256',
-    '000002501',
-    '999993562',
-    '999990779',
-    '999993306',
-];
-var invalidBSNs = [
-    '00001',
-    '0000000001',
-    '1212121212',
-    '999993237',
-    '000003802',
-    '000007901',
-    '999992189',
-    '799890053',
-    '000015083',
-    '000001532',
-    '0100006121',
-    '999999942',
-    '998882',
-    '999994504',
-    '99997282',
-    '000006505',
-    '200081642',
-    '000082083',
-    '000081156',
-    '999080202',
-    '000081880',
-    '000085551',
-    '000087560',
-    '000082963',
-    '000088230',
-    '999984657',
-    '999989357',
-    '999983768',
-    '000089611',
-    '000080929',
-    '999985224',
-    '000085873',
-    'fake-bsn',
-    '999982260',
-    '999984438',
-    '9999aa652',
-    '999981541',
-    '999989229',
-    '000085137',
-    '99998425x',
-    '000082501',
-    '999983562',
-    '999980779',
-    '979983306',
-    '070008230',
-    '97999465a',
-    '979999357',
-    '979993768',
-    '070009611',
-    '070000929',
-];
-describe('#isValidBSN', function () {
-    test.each(validBSNs)('isValidBSN(%s) returns true', function (BSN) {
-        return expect((0, validator_1.isValidBSN)(BSN)).toBe(true);
-    });
-    test.each(invalidBSNs)('isValidBSN(%s) returns false', function (BSN) {
-        return expect((0, validator_1.isValidBSN)(BSN)).toBe(false);
-    });
-});
-//# sourceMappingURL=validator.spec.js.map

package/lib/validator.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validator.spec.js","sourceRoot":"/","sources":["validator.spec.ts"],"names":[],"mappings":";;AAAA,yCAAwC;AAExC,IAAM,SAAS,GAAG;IACjB,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;CACX,CAAA;AAED,IAAM,WAAW,GAAG;IACnB,OAAO;IACP,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,YAAY;IACZ,WAAW;IACX,QAAQ;IACR,WAAW;IACX,UAAU;IACV,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,UAAU;IACV,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;CACX,CAAA;AAED,QAAQ,CAAC,aAAa,EAAE;IACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,6BAA6B,EAAE,UAAA,GAAG;QACtD,OAAA,MAAM,CAAC,IAAA,sBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAAlC,CAAkC,CAClC,CAAA;IAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,8BAA8B,EAAE,UAAA,GAAG;QACzD,OAAA,MAAM,CAAC,IAAA,sBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IAAnC,CAAmC,CACnC,CAAA;AACF,CAAC,CAAC,CAAA"}