ausweischeck 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/LICENSE.md +9 -0
- package/README.md +89 -0
- package/build/index.d.ts +5 -0
- package/build/index.js +2 -0
- package/build/index.js.map +1 -0
- package/build/types.d.ts +19 -0
- package/build/types.js +2 -0
- package/build/types.js.map +1 -0
- package/package.json +69 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
## [1.1.1](https://github.com/LILA-IT/ausweischeck/compare/v1.1.0...v1.1.1) (2023-12-06)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **release:** fix Release on NPM and publish the package again ([9b0a014](https://github.com/LILA-IT/ausweischeck/commit/9b0a014607649d58d6cbb22350781ce38925cd24))
|
package/LICENSE.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 LILA.SCHULE GmbH
|
|
4
|
+
|
|
5
|
+
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:
|
|
6
|
+
|
|
7
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
8
|
+
|
|
9
|
+
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
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# AusweisCheck 🇩🇪 (EU-ID Card Check)
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
[](https://github.com/prettier/prettier)
|
|
7
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
8
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
9
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
10
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
11
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
12
|
+
[](https://sonarqube.lila.systems/dashboard?id=AusweisCheck)
|
|
13
|
+
|
|
14
|
+
## ✨ Features
|
|
15
|
+
|
|
16
|
+
Just plain typescript lib to check the validity of German ID card and passport numbers with the help of the serial number.
|
|
17
|
+
Special thanks to [Deniz Celebi (@derDeno)](https://github.com/derDeno) for the [original implementation](https://github.com/derDeno/AusweisCheck).
|
|
18
|
+
|
|
19
|
+
## 🔧 Installation
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npm install ausweischeck
|
|
23
|
+
yarn add ausweischeck
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## 🎬 Getting started
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { checkPerso, checkReisepass } from "ausweischeck";
|
|
30
|
+
|
|
31
|
+
const persoResult = checkPerso("L01X00T471");
|
|
32
|
+
const reisepassResult = checkReisepass("C01X00T478D", "en");
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 📜 API
|
|
36
|
+
|
|
37
|
+
### `checkPerso(idNumber: string, language?: "de" | "en"): AusweisCheckResult`
|
|
38
|
+
|
|
39
|
+
This method checks for the validity of a German Personalausweis (ID card) number.
|
|
40
|
+
The language parameter is optional and defaults to "de". The language parameter is only used for the error message.
|
|
41
|
+
|
|
42
|
+
**Example:**
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
const persoResult = checkPerso("L01X00T471");
|
|
46
|
+
|
|
47
|
+
console.log(persoResult);
|
|
48
|
+
// {
|
|
49
|
+
// result: true,
|
|
50
|
+
// ausweis: {
|
|
51
|
+
// number: "L01X00T47",
|
|
52
|
+
// type: "EU ID",
|
|
53
|
+
// },
|
|
54
|
+
// }
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### `checkEuId(idNumber: string): AusweisCheckResult`
|
|
58
|
+
|
|
59
|
+
This method duplicates the checkPerso method. It defaults to the English error message.
|
|
60
|
+
It's only there for usability reasons.
|
|
61
|
+
|
|
62
|
+
### `checkReisepass(idNumber: string, language?: "de" | "en"): AusweisCheckResult`
|
|
63
|
+
|
|
64
|
+
This method checks for the validity of a German Reisepass (passport) number.
|
|
65
|
+
The language parameter is optional and defaults to "de". The language parameter is only used for the error message.
|
|
66
|
+
|
|
67
|
+
**Example:**
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
const reisepassResult = checkReisepass("C01X00T478D");
|
|
71
|
+
|
|
72
|
+
console.log(reisepassResult);
|
|
73
|
+
// {
|
|
74
|
+
// result: true,
|
|
75
|
+
// ausweis: {
|
|
76
|
+
// number: "C01X00T478",
|
|
77
|
+
// type: "Passport",
|
|
78
|
+
// },
|
|
79
|
+
// }
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### `checkGermanPassport(idNumber: string): AusweisCheckResult`
|
|
83
|
+
|
|
84
|
+
This method duplicates the checkReisepass method. It defaults to the English error message.
|
|
85
|
+
It's only there for usability reasons.
|
|
86
|
+
|
|
87
|
+
## 🥂 License
|
|
88
|
+
|
|
89
|
+
[MIT](./LICENSE.md)
|
package/build/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { AusweisCheckResult, Language } from "./types.js";
|
|
2
|
+
export declare function checkPerso(idNumber: string, language?: Language): AusweisCheckResult;
|
|
3
|
+
export declare function checkReisepass(idNumber: string, language?: Language): AusweisCheckResult;
|
|
4
|
+
export declare function checkEuId(idNumber: string): AusweisCheckResult;
|
|
5
|
+
export declare function checkGermanPassport(idNumber: string): AusweisCheckResult;
|
package/build/index.js
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
function _class_call_check(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function")}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor)}}function _create_class(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor}function _define_property(obj,key,value){if(key in obj){Object.defineProperty(obj,key,{value:value,enumerable:true,configurable:true,writable:true})}else{obj[key]=value}return obj}import{AusweisType,LanguageEnum}from"./types.js";var AusweisCheck=function(){"use strict";function AusweisCheck(ausweisNumber){var language=arguments.length>1&&arguments[1]!==void 0?arguments[1]:LanguageEnum.de;_class_call_check(this,AusweisCheck);_define_property(this,"number",void 0);_define_property(this,"language",void 0);_define_property(this,"alphas",void 0);this.number=ausweisNumber.toUpperCase();this.language=language;this.alphas={"0":0,"1":1,"2":2,"3":3,"4":4,"5":5,"6":6,"7":7,"8":8,"9":9,A:10,B:11,C:12,D:13,E:14,F:15,G:16,H:17,I:18,J:19,K:20,L:21,M:22,N:23,O:24,P:25,Q:26,R:27,S:28,T:29,U:30,V:31,W:32,X:33,Y:34,Z:35}}_create_class(AusweisCheck,[{key:"checkSum",value:function checkSum(idNumber,checkDigit,type,nation){var arr=idNumber.split("");var iter=7;var arrNumbers=[];var endDigits=0;var _iteratorNormalCompletion=true,_didIteratorError=false,_iteratorError=undefined;try{for(var _iterator=arr[Symbol.iterator](),_step;!(_iteratorNormalCompletion=(_step=_iterator.next()).done);_iteratorNormalCompletion=true){var element=_step.value;if(iter===7){var result=this.alphas[element]*iter;arrNumbers.push(result);iter=3}else if(iter===3){var result1=this.alphas[element]*iter;arrNumbers.push(result1);iter=1}else if(iter===1){var result2=this.alphas[element]*iter;arrNumbers.push(result2);iter=7}}}catch(err){_didIteratorError=true;_iteratorError=err}finally{try{if(!_iteratorNormalCompletion&&_iterator.return!=null){_iterator.return()}}finally{if(_didIteratorError){throw _iteratorError}}}for(var i=0;i<9;i++){var val=String(arrNumbers[i]);var temp=val.substring(val.length-1);endDigits+=parseInt(temp,10)}var end=endDigits%10;if(end===checkDigit){return{result:true,ausweis:{number:idNumber,type:type,nation:nation}}}else{var error=this.language===LanguageEnum.de?"Pr\xfcfsumme stimmt nicht \xfcberein":"Checksum does not match";return{result:false,error:error}}}},{key:"checkPerso",get:function get(){if(this.number.length<10){var error=this.language===LanguageEnum.de?"Personalausweisnummer muss mindestens 10 Zeichen lang sein":"Identity card number must be at least 10 characters long";return{result:false,error:error}}var checkDigit=parseInt(this.number.substring(9),10);var persoNumber=this.number.substring(0,9);return this.checkSum(persoNumber,checkDigit,AusweisType.EuId)}},{key:"checkReisepass",get:function get(){if(this.number.length<11){var error=this.language===LanguageEnum.de?"Reisepassnummer muss mindestens 11 Zeichen lang sein":"Passport number must be at least 11 characters long";return{result:false,error:error}}var passNumber=this.number.substring(0,9);var checkDigit=parseInt(this.number.charAt(9),10);var nation=this.number.substring(10);return this.checkSum(passNumber,checkDigit,AusweisType.Passport,nation)}}]);return AusweisCheck}();export function checkPerso(idNumber,language){return new AusweisCheck(idNumber,language).checkPerso}export function checkReisepass(idNumber,language){return new AusweisCheck(idNumber,language).checkReisepass}export function checkEuId(idNumber){return new AusweisCheck(idNumber,"en").checkPerso}export function checkGermanPassport(idNumber){return new AusweisCheck(idNumber,"en").checkReisepass}
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/* AusweisCheck has been created by Deniz Celebi in 2018 and modified by LILA.SCHULE GmbH in 2023\n *\n * Version: 1.0.1\n * Author: LILA.SCHULE GmbH, Deniz Celebi\n *\n * Eine mini Library um Personalausweise oder Internationale Reisepässe auf // cspell:disable-line\n * Echtheit zu überprüfen mit Hilfe der Seriennummer // cspell:disable-line\n *\n * Just plain typescript lib to check the validity of German ID card and passport numbers\n * with the help of the serial number.\n *\n *\n * License: MIT\n */\n\nimport {\n AusweisCheckResult,\n AusweisType,\n Language,\n LanguageEnum,\n} from \"./types.js\";\n\nclass AusweisCheck {\n private number: string;\n private language: Language;\n private alphas: Record<string, number>;\n\n constructor(ausweisNumber: string, language: Language = LanguageEnum.de) {\n this.number = ausweisNumber.toUpperCase();\n this.language = language;\n this.alphas = {\n \"0\": 0,\n \"1\": 1,\n \"2\": 2,\n \"3\": 3,\n \"4\": 4,\n \"5\": 5,\n \"6\": 6,\n \"7\": 7,\n \"8\": 8,\n \"9\": 9,\n A: 10,\n B: 11,\n C: 12,\n D: 13,\n E: 14,\n F: 15,\n G: 16,\n H: 17,\n I: 18,\n J: 19,\n K: 20,\n L: 21,\n M: 22,\n N: 23,\n O: 24,\n P: 25,\n Q: 26,\n R: 27,\n S: 28,\n T: 29,\n U: 30,\n V: 31,\n W: 32,\n X: 33,\n Y: 34,\n Z: 35,\n };\n }\n\n private checkSum(\n idNumber: string,\n checkDigit: number,\n type: AusweisType,\n nation?: string,\n ): AusweisCheckResult {\n const arr = idNumber.split(\"\");\n let iter = 7;\n const arrNumbers: number[] = [];\n let endDigits = 0;\n\n // Replace each character with the corresponding number and multiply it.\n for (const element of arr) {\n if (iter === 7) {\n const result = this.alphas[element] * iter;\n arrNumbers.push(result);\n iter = 3;\n } else if (iter === 3) {\n const result = this.alphas[element] * iter;\n arrNumbers.push(result);\n iter = 1;\n } else if (iter === 1) {\n const result = this.alphas[element] * iter;\n arrNumbers.push(result);\n iter = 7;\n }\n }\n\n // Add the last digits of the individual results\n for (let i = 0; i < 9; i++) {\n const val = String(arrNumbers[i]);\n const temp = val.substring(val.length - 1);\n endDigits += parseInt(temp, 10);\n }\n\n const end = endDigits % 10;\n if (end === checkDigit) {\n return {\n result: true,\n ausweis: {\n number: idNumber,\n type: type,\n nation: nation,\n },\n };\n } else {\n const error =\n this.language === LanguageEnum.de\n ? \"Prüfsumme stimmt nicht überein\" // cspell:disable-line\n : \"Checksum does not match\";\n return { result: false, error: error };\n }\n }\n\n get checkPerso(): AusweisCheckResult {\n // If entered identity card number has less than 10 characters cancel\n if (this.number.length < 10) {\n const error =\n this.language === LanguageEnum.de\n ? \"Personalausweisnummer muss mindestens 10 Zeichen lang sein\" // cspell:disable-line\n : \"Identity card number must be at least 10 characters long\";\n return {\n result: false,\n error: error,\n };\n }\n\n const checkDigit = parseInt(this.number.substring(9), 10);\n const persoNumber = this.number.substring(0, 9);\n return this.checkSum(persoNumber, checkDigit, AusweisType.EuId);\n }\n\n get checkReisepass(): AusweisCheckResult {\n // If entered passport number has less than 11 characters cancel\n if (this.number.length < 11) {\n const error =\n this.language === LanguageEnum.de\n ? \"Reisepassnummer muss mindestens 11 Zeichen lang sein\" // cspell:disable-line\n : \"Passport number must be at least 11 characters long\";\n return {\n result: false,\n error: error,\n };\n }\n\n const passNumber = this.number.substring(0, 9);\n const checkDigit = parseInt(this.number.charAt(9), 10);\n const nation = this.number.substring(10);\n\n return this.checkSum(passNumber, checkDigit, AusweisType.Passport, nation);\n }\n}\n\nexport function checkPerso(\n idNumber: string,\n language?: Language,\n): AusweisCheckResult {\n return new AusweisCheck(idNumber, language).checkPerso;\n}\n\nexport function checkReisepass(\n idNumber: string,\n language?: Language,\n): AusweisCheckResult {\n return new AusweisCheck(idNumber, language).checkReisepass;\n}\n\n// Renamed based on change to EU ID\nexport function checkEuId(idNumber: string): AusweisCheckResult {\n return new AusweisCheck(idNumber, \"en\").checkPerso;\n}\n\nexport function checkGermanPassport(idNumber: string): AusweisCheckResult {\n return new AusweisCheck(idNumber, \"en\").checkReisepass;\n}\n"],"names":["AusweisType","LanguageEnum","AusweisCheck","ausweisNumber","language","de","number","alphas","toUpperCase","A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z","checkSum","idNumber","checkDigit","type","nation","arr","split","iter","arrNumbers","endDigits","element","result","push","i","val","String","temp","substring","length","parseInt","end","ausweis","error","checkPerso","persoNumber","EuId","checkReisepass","passNumber","charAt","Passport","checkEuId","checkGermanPassport"],"mappings":"2yBAeA,OAEEA,WAAW,CAEXC,YAAY,KACP,YAAa,CAEpB,IAAA,AAAMC,aA6IH,AA7IH,iCAAMA,aAKQC,aAAqB,MAAEC,SAAAA,uDAAqBH,aAAaI,EAAE,wBALnEH,cACJ,sBAAQI,SAAR,KAAA,GACA,sBAAQF,WAAR,KAAA,GACA,sBAAQG,SAAR,KAAA,EAGE,CAAA,IAAI,CAACD,MAAM,CAAGH,cAAcK,WAAW,EACvC,CAAA,IAAI,CAACJ,QAAQ,CAAGA,QAChB,CAAA,IAAI,CAACG,MAAM,CAAG,CACZ,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACL,IAAK,EACLE,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,GACHC,EAAG,EACL,gBA7CEhC,eAgDIiC,IAAAA,iBAAR,SAAQA,SACNC,QAAgB,CAChBC,UAAkB,CAClBC,IAAiB,CACjBC,MAAe,EAEf,IAAMC,IAAMJ,SAASK,KAAK,CAAC,IAC3B,IAAIC,KAAO,EACX,IAAMC,WAAuB,EAAE,CAC/B,IAAIC,UAAY,MAGX,+BAAA,wBAAA,6BAAL,QAAK,UAAiBJ,uBAAjB,QAAA,2BAAA,MAAA,wBAAA,+BAAsB,CAAtB,IAAMK,QAAN,YACH,GAAIH,OAAS,EAAG,CACd,IAAMI,OAAS,IAAI,CAACvC,MAAM,CAACsC,QAAQ,CAAGH,KACtCC,WAAWI,IAAI,CAACD,QAChBJ,KAAO,CACT,MAAO,GAAIA,OAAS,EAAG,CACrB,IAAMI,QAAS,IAAI,CAACvC,MAAM,CAACsC,QAAQ,CAAGH,KACtCC,WAAWI,IAAI,CAACD,SAChBJ,KAAO,CACT,MAAO,GAAIA,OAAS,EAAG,CACrB,IAAMI,QAAS,IAAI,CAACvC,MAAM,CAACsC,QAAQ,CAAGH,KACtCC,WAAWI,IAAI,CAACD,SAChBJ,KAAO,CACT,CACF,aAdK,uBAAA,mCAAA,2BAAA,wBAAA,+BAAA,yBAAA,iBAiBL,IAAK,IAAIM,EAAI,EAAGA,EAAI,EAAGA,IAAK,CAC1B,IAAMC,IAAMC,OAAOP,UAAU,CAACK,EAAE,EAChC,IAAMG,KAAOF,IAAIG,SAAS,CAACH,IAAII,MAAM,CAAG,GACxCT,WAAaU,SAASH,KAAM,GAC9B,CAEA,IAAMI,IAAMX,UAAY,GACxB,GAAIW,MAAQlB,WAAY,CACtB,MAAO,CACLS,OAAQ,KACRU,QAAS,CACPlD,OAAQ8B,SACRE,KAAMA,KACNC,OAAQA,MACV,CACF,CACF,KAAO,CACL,IAAMkB,MACJ,IAAI,CAACrD,QAAQ,GAAKH,aAAaI,EAAE,CAC7B,uCACA,0BACN,MAAO,CAAEyC,OAAQ,MAAOW,MAAOA,KAAM,CACvC,CACF,IAEIC,IAAAA,iBAAJ,eAEE,GAAI,IAAI,CAACpD,MAAM,CAAC+C,MAAM,CAAG,GAAI,CAC3B,IAAMI,MACJ,IAAI,CAACrD,QAAQ,GAAKH,aAAaI,EAAE,CAC7B,6DACA,2DACN,MAAO,CACLyC,OAAQ,MACRW,MAAOA,KACT,CACF,CAEA,IAAMpB,WAAaiB,SAAS,IAAI,CAAChD,MAAM,CAAC8C,SAAS,CAAC,GAAI,IACtD,IAAMO,YAAc,IAAI,CAACrD,MAAM,CAAC8C,SAAS,CAAC,EAAG,GAC7C,OAAO,IAAI,CAACjB,QAAQ,CAACwB,YAAatB,WAAYrC,YAAY4D,IAAI,CAChE,IAEIC,IAAAA,qBAAJ,eAEE,GAAI,IAAI,CAACvD,MAAM,CAAC+C,MAAM,CAAG,GAAI,CAC3B,IAAMI,MACJ,IAAI,CAACrD,QAAQ,GAAKH,aAAaI,EAAE,CAC7B,uDACA,sDACN,MAAO,CACLyC,OAAQ,MACRW,MAAOA,KACT,CACF,CAEA,IAAMK,WAAa,IAAI,CAACxD,MAAM,CAAC8C,SAAS,CAAC,EAAG,GAC5C,IAAMf,WAAaiB,SAAS,IAAI,CAAChD,MAAM,CAACyD,MAAM,CAAC,GAAI,IACnD,IAAMxB,OAAS,IAAI,CAACjC,MAAM,CAAC8C,SAAS,CAAC,IAErC,OAAO,IAAI,CAACjB,QAAQ,CAAC2B,WAAYzB,WAAYrC,YAAYgE,QAAQ,CAAEzB,OACrE,YA1IIrC,eA6IN,QAAO,SAASwD,WACdtB,QAAgB,CAChBhC,QAAmB,EAEnB,OAAO,IAAIF,aAAakC,SAAUhC,UAAUsD,UAAU,AACxD,CAEA,OAAO,SAASG,eACdzB,QAAgB,CAChBhC,QAAmB,EAEnB,OAAO,IAAIF,aAAakC,SAAUhC,UAAUyD,cAAc,AAC5D,CAGA,OAAO,SAASI,UAAU7B,QAAgB,EACxC,OAAO,IAAIlC,aAAakC,SAAU,MAAMsB,UAAU,AACpD,CAEA,OAAO,SAASQ,oBAAoB9B,QAAgB,EAClD,OAAO,IAAIlC,aAAakC,SAAU,MAAMyB,cAAc,AACxD"}
|
package/build/types.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export declare enum AusweisType {
|
|
2
|
+
EuId = "EU ID",
|
|
3
|
+
Passport = "Passport"
|
|
4
|
+
}
|
|
5
|
+
export declare enum LanguageEnum {
|
|
6
|
+
de = "de",
|
|
7
|
+
en = "en"
|
|
8
|
+
}
|
|
9
|
+
export type Language = keyof typeof LanguageEnum | LanguageEnum;
|
|
10
|
+
export interface AusweisCheckResult {
|
|
11
|
+
result: boolean;
|
|
12
|
+
ausweis?: Ausweis;
|
|
13
|
+
error?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface Ausweis {
|
|
16
|
+
number: string;
|
|
17
|
+
type: AusweisType;
|
|
18
|
+
nation?: string;
|
|
19
|
+
}
|
package/build/types.js
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export var AusweisType;(function(AusweisType){AusweisType["EuId"]="EU ID";AusweisType["Passport"]="Passport"})(AusweisType||(AusweisType={}));export var LanguageEnum;(function(LanguageEnum){LanguageEnum["de"]="de";LanguageEnum["en"]="en"})(LanguageEnum||(LanguageEnum={}));
|
|
2
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export enum AusweisType {\n // Renamed based on change to EU ID\n EuId = \"EU ID\",\n Passport = \"Passport\",\n}\n\nexport enum LanguageEnum {\n de = \"de\",\n en = \"en\",\n}\n\nexport type Language = keyof typeof LanguageEnum | LanguageEnum;\n\nexport interface AusweisCheckResult {\n result: boolean;\n ausweis?: Ausweis;\n error?: string;\n}\n\nexport interface Ausweis {\n number: string;\n type: AusweisType;\n nation?: string;\n}\n"],"names":["AusweisType","LanguageEnum"],"mappings":"iCAAYA,8EAAAA,cAAAA,mDAMAC,gEAAAA,eAAAA"}
|
package/package.json
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ausweischeck",
|
|
3
|
+
"version": "1.1.1",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"exports": "./build/index.js",
|
|
6
|
+
"types": "./build/index.d.ts",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"engines": {
|
|
9
|
+
"node": ">=16.20.0",
|
|
10
|
+
"npm": ">=8.19.0"
|
|
11
|
+
},
|
|
12
|
+
"volta": {
|
|
13
|
+
"node": "18.17.1",
|
|
14
|
+
"npm": "9.6.7"
|
|
15
|
+
},
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public"
|
|
18
|
+
},
|
|
19
|
+
"scripts": {
|
|
20
|
+
"build": "npm run clean && npm run type:dts && npm run build:main",
|
|
21
|
+
"build:main": "swc ./src -d ./build",
|
|
22
|
+
"clean": "rimraf build coverage nyc_output",
|
|
23
|
+
"type:dts": "tsc --emitDeclarationOnly --project tsconfig.build.json",
|
|
24
|
+
"type:check": "tsc --noEmit",
|
|
25
|
+
"format": "prettier \"src/**/*.ts\" --write",
|
|
26
|
+
"format:check": "prettier \"src/**/*.ts\" --check",
|
|
27
|
+
"lint": "eslint src --ext .ts --fix",
|
|
28
|
+
"lint:check": "eslint src --ext .ts",
|
|
29
|
+
"test": "vitest run",
|
|
30
|
+
"test:watch": "vitest watch",
|
|
31
|
+
"test:coverage": "vitest run --coverage",
|
|
32
|
+
"spell:check": "cspell \"{README.md,CODE_OF_CONDUCT.md,CONTRIBUTING.md,.github/*.md,src/**/*.ts}\"",
|
|
33
|
+
"cz": "cz",
|
|
34
|
+
"semantic-release": "semantic-release",
|
|
35
|
+
"commit": "cz"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@ryansonshine/commitizen": "^4.2.8",
|
|
39
|
+
"@ryansonshine/cz-conventional-changelog": "^3.3.4",
|
|
40
|
+
"@semantic-release/changelog": "^6.0.3",
|
|
41
|
+
"@semantic-release/commit-analyzer": "^11.1.0",
|
|
42
|
+
"@semantic-release/github": "^9.0.3",
|
|
43
|
+
"@semantic-release/npm": "^11.0.1",
|
|
44
|
+
"@semantic-release/release-notes-generator": "^12.1.0",
|
|
45
|
+
"@swc/cli": "^0.1.62",
|
|
46
|
+
"@swc/core": "^1.3.62",
|
|
47
|
+
"@types/node": "^20.9.0",
|
|
48
|
+
"@types/prompts": "^2.4.4",
|
|
49
|
+
"@typescript-eslint/eslint-plugin": "^6.10.0",
|
|
50
|
+
"@typescript-eslint/parser": "^6.10.0",
|
|
51
|
+
"@vitest/coverage-v8": "^1.0.1",
|
|
52
|
+
"c8": "^8.0.0",
|
|
53
|
+
"cspell": "^8.0.0",
|
|
54
|
+
"eslint": "^8.42.0",
|
|
55
|
+
"eslint-config-prettier": "^9.0.0",
|
|
56
|
+
"eslint-import-resolver-typescript": "^3.5.5",
|
|
57
|
+
"eslint-plugin-eslint-comments": "^3.2.0",
|
|
58
|
+
"eslint-plugin-import": "^2.27.5",
|
|
59
|
+
"eslint-plugin-simple-import-sort": "^10.0.0",
|
|
60
|
+
"nyc": "^15.1.0",
|
|
61
|
+
"prettier": "^3.0.3",
|
|
62
|
+
"rimraf": "^5.0.1",
|
|
63
|
+
"semantic-release": "^22.0.7",
|
|
64
|
+
"source-map-support": "^0.5.21",
|
|
65
|
+
"typescript": "^5.1.3",
|
|
66
|
+
"vitest": "^1.0.1",
|
|
67
|
+
"vitest-sonar-reporter": "^1.0.0"
|
|
68
|
+
}
|
|
69
|
+
}
|