diff --git a/.eslintrc.yaml b/.eslintrc.yaml index 1310ac4..9b60fbd 100644 --- a/.eslintrc.yaml +++ b/.eslintrc.yaml @@ -3,7 +3,19 @@ env: node: true -extends: prettier +extends: + - prettier + +parser: "@typescript-eslint/parser" parserOptions: - ecmaVersion: 2017 + ecmaVersion: 2020 + sourceType: module + extraFileExtensions: + - .mjs + - .mts + +plugins: + - "@typescript-eslint" + - import + - jsdoc diff --git a/.mocharc.yml b/.mocharc.yml new file mode 100644 index 0000000..f9af2a0 --- /dev/null +++ b/.mocharc.yml @@ -0,0 +1,10 @@ +color: true +diff: true +loader: ts-node/esm +no-warnings: true +package: ./package.json +spec: + - test/*.ts +timeout: 90000 +throw-deprecation: true +ui: bdd diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..0aaf202 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +nodejs 16.12.0 diff --git a/.travis.yml b/.travis.yml index 1f0eadd..55e308d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,17 +5,17 @@ language: node_js matrix: include: - node_js: 'node' - env: NPM_RUN_SCRIPT=test NPM_AUDIT=true MOCHA_ARGS="-- --node-arg=--pending-deprecation --node-arg=--throw-deprecation" NYC="nyc --reporter json" - - node_js: '10' - - node_js: '8' - - node_js: '6' + env: NPM_RUN_SCRIPT=test:coverage NPM_AUDIT=true + - node_js: '16' + - node_js: '14' install: - npm install - if [ "$NPM_AUDIT" = true ]; then npm audit; fi script: - - echo "--reporter dot --color" > test/mocha.opts + - > + echo "reporter: dot" >> .mocharc.yml - npm run build - - $NYC npm run ${NPM_RUN_SCRIPT:-test:spec} -- ${MOCHA_ARGS} - - if [ -n "$NYC" ]; then nyc report --color && nyc report --reporter=text-lcov | coveralls; fi + - npm run ${NPM_RUN_SCRIPT:-test:spec} -- ${MOCHA_ARGS} + - if [ "$NPM_RUN_SCRIPT" = "test:coverage" ]; then coveralls < coverage/lcov.info; fi diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fc857d..e8f16ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,29 +1,35 @@ # Changelog +## v1.0.0 2021-10-24 + +- Convert to ESM module. +- Requires Node >= 14. +- Upgraded nrv2e-decompress@1.0.0. + ## v0.5.0 2019-05-08 -* Ported fix dex4er/drpdecompress#2 for omitted word in C.1.2 field's description. -* Compiled as ES5. +- Ported fix dex4er/drpdecompress#2 for omitted word in C.1.2 field's description. +- Compiled as ES5. ## v0.4.1 2018-09-07 -* Correct import syntax in documentation and examples. +- Correct import syntax in documentation and examples. ## v0.4.0 2018-08-29 -* Rewritten in Typescript +- Rewritten in Typescript ## v0.3.0 2018-08-18 -* Decoding of fuel code to `valueDescription` property. +- Decoding of fuel code to `valueDescription` property. ## v0.2.0 2018-08-06 -* Support for old data format. -* Data object is an instance of +- Support for old data format. +- Data object is an instance of `PolishVehicleRegistrationCertificateNewFormatData` or `PolishVehicleRegistrationCertificateOldFormatData` class. ## v0.1.0 2018-07-28 -* Initial release +- Initial release diff --git a/LICENSE b/LICENSE index 191be5e..78dc76b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,100 +1,102 @@ GPL-2.0 -Copyright (c) 2018-2019 Piotr Roszatycki +Copyright (c) 2018-2021 Piotr Roszatycki GNU GENERAL PUBLIC LICENSE Version 2, June 1991 - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +Copyright (C) 1989, 1991 Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. Preamble - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public +The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This +software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to your programs, too. - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. - To protect your rights, we need to make restrictions that forbid +To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. - For example, if you distribute copies of such a program, whether +For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their rights. - We protect your rights with two steps: (1) copyright the software, and +We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. - Also, for each author's protection and ours, we want to make certain +Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we +software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any +program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. - The precise terms and conditions for copying, distribution and +The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains + a notice placed by the copyright holder saying it may be distributed + under the terms of this General Public License. The "Program", below, + refers to any such program or work, and a "work based on the Program" + means either the Program or any derivative work under copyright law: + that is to say, a work containing the Program or a portion of it, + either verbatim or with modifications and/or translated into another + language. (Hereinafter, translation is included without limitation in + the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of +covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. +1. You may copy and distribute verbatim copies of the Program's + source code as you receive it, in any medium, provided that you + conspicuously and appropriately publish on each copy an appropriate + copyright notice and disclaimer of warranty; keep intact all the + notices that refer to this License and to the absence of any warranty; + and give any other recipients of the Program a copy of this License + along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: +2. You may modify your copy or copies of the Program or any portion + of it, thus forming a work based on the Program, and copy and + distribute such modifications or work under the terms of Section 1 + above, provided that you also meet all of these conditions: + a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. @@ -115,11 +117,11 @@ above, provided that you also meet all of these conditions: does not normally print such an announcement, your work based on the Program is not required to print an announcement.) -These requirements apply to the modified work as a whole. If +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you +sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the @@ -135,9 +137,10 @@ with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: +3. You may copy and distribute the Program (or a work based on it, + under Section 2) in object code or executable form under the terms of + Sections 1 and 2 above provided that you also do one of the following: + a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections @@ -157,10 +160,10 @@ Sections 1 and 2 above provided that you also do one of the following: an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source +making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a +control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the @@ -173,43 +176,43 @@ access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. +4. You may not copy, modify, sublicense, or distribute the Program + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense or distribute the Program is + void, and will automatically terminate your rights under this License. + However, parties who have received copies, or rights, from you under + this License will not have their licenses terminated so long as such + parties remain in full compliance. + +5. You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Program or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Program (or any work based on the + Program), you indicate your acceptance of this License to do so, and + all its terms and conditions for copying, distributing or modifying + the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the + Program), the recipient automatically receives a license from the + original licensor to copy, distribute or modify the Program subject to + these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted herein. + You are not responsible for enforcing compliance by third parties to + this License. + +7. If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent issues), + conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot + distribute so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you + may not distribute the Program at all. For example, if a patent + license would not permit royalty-free redistribution of the Program by + all those who receive copies directly or indirectly through you, then + the only way you could satisfy both it and this License would be to + refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to @@ -220,7 +223,7 @@ It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is -implemented by public license practices. Many people have made +implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing @@ -230,66 +233,66 @@ impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. +8. If the distribution and/or use of the Program is restricted in + certain countries either by patents or by copyrighted interfaces, the + original copyright holder who places the Program under this License + may add an explicit geographical distribution limitation excluding + those countries, so that distribution is permitted only in or among + countries not thus excluded. In such case, this License incorporates + the limitation as if written in the body of this License. - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. +9. The Free Software Foundation may publish revised and/or new versions + of the General Public License from time to time. Such new versions will + be similar in spirit to the present version, but may differ in detail to + address new problems or concerns. -Each version is given a distinguishing version number. If the Program +Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of +Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest +10. If you wish to incorporate parts of the Program into other free + programs whose distribution conditions are different, write to the author + to ask for permission. For software which is copyrighted by the Free + Software Foundation, write to the Free Software Foundation; we sometimes + make exceptions for this. Our decision will be guided by the two goals + of preserving the free status of all derivatives of our free software and + of promoting the sharing and reuse of software generally. + + NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY + FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN + OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES + PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED + OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS + TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE + PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, + REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR + REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, + INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING + OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED + TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY + YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER + PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE + POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - To do so, attach the following notices to the program. It is safest +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. @@ -322,22 +325,22 @@ when it starts in an interactive mode: under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may +parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: +necessary. Here is a sample; alter the names: - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. +Yoyodyne, Inc., hereby disclaims all copyright interest in the program +`Gnomovision' (which makes passes at compilers) written by James Hacker. - , 1 April 1989 - Ty Coon, President of Vice +, 1 April 1989 +Ty Coon, President of Vice This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may +proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General +library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. diff --git a/README.md b/README.md index 6da67e9..6d41d13 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # polish-vehicle-registration-certificate-decoder -[![Build Status](https://secure.travis-ci.org/dex4er/js-polish-vehicle-registration-certificate-decoder.svg)](http://travis-ci.org/dex4er/js-polish-vehicle-registration-certificate-decoder) [![Coverage Status](https://coveralls.io/repos/github/dex4er/js-polish-vehicle-registration-certificate-decoder/badge.svg)](https://coveralls.io/github/dex4er/js-polish-vehicle-registration-certificate-decoder) [![npm](https://img.shields.io/npm/v/polish-vehicle-registration-certificate-decoder.svg)](https://www.npmjs.com/package/polish-vehicle-registration-certificate-decoder) + +[![Build Status](https://api.travis-ci.com/dex4er/js-polish-vehicle-registration-certificate-decoder.svg)](https://api.travis-ci.com/github/dex4er/js-polish-vehicle-registration-certificate-decoder) [![Coverage Status](https://coveralls.io/repos/github/dex4er/js-polish-vehicle-registration-certificate-decoder/badge.svg)](https://coveralls.io/github/dex4er/js-polish-vehicle-registration-certificate-decoder) [![npm](https://img.shields.io/npm/v/polish-vehicle-registration-certificate-decoder.svg)](https://www.npmjs.com/package/polish-vehicle-registration-certificate-decoder) + Decode Polish Vehicle Registration Certificate Aztec 2D barcode data. ## Requirements -This module requires ES6 with Node >= 4. +This is ESM module which requires ES2020 and Node >= 14. ## Installation @@ -25,47 +27,19 @@ npm install -D @types/node ## Usage ```js -const { PolishVehicleRegistrationCertificateDecoder } = require('polish-vehicle-registration-certificate-decoder') -``` - -or: - -```js -const { - PolishVehicleRegistrationCertificateDecoder, - PolishVehicleRegistrationCertificateNewFormatData, - PolishVehicleRegistrationCertificateOldFormatData -} = require('polish-vehicle-registration-certificate-decoder') -``` - -_Typescript:_ - -```ts import PolishVehicleRegistrationCertificateDecoder from 'polish-vehicle-registration-certificate-decoder' ``` or: -```ts +```js import { PolishVehicleRegistrationCertificateDecoder, PolishVehicleRegistrationCertificateNewFormatData, - PolishVehicleRegistrationCertificateOldFormatData + PolishVehicleRegistrationCertificateOldFormatData, } from 'polish-vehicle-registration-certificate-decoder' ``` -Transpiling this module with own settings in `tsconfig.json`: - -```json -{ - "compilerOptions": { - "paths": { - "polish-vehicle-registration-certificate-decoder": ["node_modules/polish-vehicle-registration-certificate-decoder/src/polish-vehicle-registration-certificate-decoder"] - } - } -} -``` - ### constructor ```js @@ -74,7 +48,7 @@ const decoder = new PolishVehicleRegistrationCertificateDecoder(b64Input) _Arguments:_ -* `b64Input` is a string with base64 data scanned from Aztec 2D barcode +- `b64Input` is a string with base64 data scanned from Aztec 2D barcode ## data @@ -128,12 +102,7 @@ Output: "organWydajacy": { "name": "ORGAN WYDAJĄCY", "description": "", - "value": [ - "PREZYDENT M. ST. WARSZAWY", - "DZIELNICA MOKOTÓW", - "UL. RAKOWIECKA 25/27", - "02-517 WARSZAWA" - ] + "value": ["PREZYDENT M. ST. WARSZAWY", "DZIELNICA MOKOTÓW", "UL. RAKOWIECKA 25/27", "02-517 WARSZAWA"] }, "numerRejestracyjnyPojazdu": { "name": "A", @@ -438,6 +407,6 @@ Output: ## License -Copyright (c) 2018-2019 Piotr Roszatycki +Copyright (c) 2018-2021 Piotr Roszatycki [GPL-2.0](https://opensource.org/licenses/GPL-2.0) diff --git a/examples/polish-vehicle-registration-certificate.js b/examples/polish-vehicle-registration-certificate.js index c2a922a..8d93d2b 100644 --- a/examples/polish-vehicle-registration-certificate.js +++ b/examples/polish-vehicle-registration-certificate.js @@ -1,6 +1,6 @@ #!/usr/bin/env node -const {PolishVehicleRegistrationCertificateDecoder} = require('../lib/polish-vehicle-registration-certificate-decoder') +import {PolishVehicleRegistrationCertificateDecoder} from 'polish-vehicle-registration-certificate-decoder' // Scanned from https://www.pwpw.pl/binaries/content/gallery/pwpwcms_pl/Dla_mediow/zdjecia_do_artykulow/2016/03/dsc_1548.jpg const b64Input = diff --git a/index.js b/index.js deleted file mode 100644 index 7b50064..0000000 --- a/index.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('./lib/polish-vehicle-registration-certificate-decoder') diff --git a/package.json b/package.json index f089649..9729056 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,14 @@ { "name": "polish-vehicle-registration-certificate-decoder", - "version": "0.5.0", + "version": "1.0.0", "description": "Decode Polish Vehicle Registration Certificate Aztec 2D barcode data", + "type": "module", + "exports": { + ".": { + "default": "./lib/polish-vehicle-registration-certificate-decoder.js", + "typings": "./lib/polish-vehicle-registration-certificate-decoder.d.ts" + } + }, "main": "lib/polish-vehicle-registration-certificate-decoder.js", "typings": "lib/polish-vehicle-registration-certificate-decoder.d.ts", "repository": { @@ -24,53 +31,51 @@ }, "homepage": "http://github.com/dex4er/js-polish-vehicle-registration-certificate-decoder", "engines": { - "node": ">=4.0.0" + "node": ">=14.0.0" }, "dependencies": { - "nrv2e-decompress": "^0.3.0", - "tslib": "^1.9.3" + "nrv2e-decompress": "^1.0.0", + "tslib": "^2.3.1" }, "devDependencies": { - "@types/chai": "^4.1.7", - "@types/mocha": "^5.2.6", - "@types/node": "^12.0.0", - "chai": "^4.2.0", - "coveralls": "^3.0.3", - "eslint": "^5.16.0", - "eslint-config-prettier": "^4.2.0", - "eslint-plugin-import": "^2.17.2", - "eslint-plugin-node": "^9.0.1", - "eslint-plugin-promise": "^4.1.1", - "eslint-plugin-react": "^7.13.0", - "markdownlint-cli": "^0.15.0", - "mocha": "^6.1.4", - "nyc": "^14.1.0", - "prettier": "^1.17.0", - "shx": "^0.3.2", - "source-map-support": "^0.5.12", - "ts-node": "^8.1.0", - "tslint": "^5.16.0", - "tslint-config-prettier": "^1.18.0", - "typescript": "^3.4.5" + "@tsconfig/node14": "^1.0.1", + "@types/chai": "^4.2.22", + "@types/mocha": "^9.0.0", + "@types/node": "^16.11.4", + "@typescript-eslint/eslint-plugin": "^5.1.0", + "@typescript-eslint/parser": "^5.1.0", + "c8": "^7.10.0", + "chai": "^4.3.4", + "coveralls": "^3.1.1", + "eslint": "^8.1.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-import": "^2.25.2", + "eslint-plugin-jsdoc": "^37.0.0", + "eslint-plugin-node": "^11.1.0", + "markdownlint-cli": "^0.29.0", + "mocha": "^9.1.3", + "mocha-steps": "^1.3.0", + "prettier": "^2.4.1", + "shx": "^0.3.3", + "ts-node": "^10.4.0", + "typescript": "^4.4.4" }, "scripts": { "build": "npm run compile", - "compile": "tsc --pretty", + "compile": "tsc --pretty --project .", "clean": "shx rm -rf lib", + "lint": "npm run lint:tsc:src && npm run lint:tsc:test && npm run lint:tsc:examples && npm run lint:eslint && npm run lint:prettier && npm run lint:markdownlint", + "lint:tsc:examples": "tsc --noEmit --pretty --project examples", + "lint:tsc:src": "tsc --noEmit --pretty --project .", + "lint:tsc:test": "tsc --noEmit --pretty --project test", + "lint:eslint": "eslint --ext .js,.ts .", + "lint:prettier": "prettier --ignore-path .gitignore --list-different '**/*.{js,json,md,ts,yml}'", + "lint:markdownlint": "markdownlint \"*.md\"", "postpublish": "git tag v$npm_package_version -a -m \"Release v$npm_package_version\" && git push --tags", "prepublishOnly": "npm run build", - "pretest": "npm run build && tsc --pretty -p examples && tsc --pretty -p test && eslint . && tslint -t stylish -p . && tslint -t stylish -p examples && tslint -t stylish -p test && prettier --ignore-path .gitignore --list-different '**/*.js' '**/*.ts' '**/*.yaml' && markdownlint \"*.md\"", + "pretest": "npm run lint", "test": "npm run test:spec", - "test:spec": "npm run ts-mocha -- \"test/*.ts\"", - "test:coverage": "nyc --reporter json npm run test:spec && nyc report", - "ts-mocha": "mocha --use_strict --throw-deprecation --require source-map-support/register --require ts-node/register --timeout 90000" - }, - "nyc": { - "extension": [ - ".ts" - ], - "exclude": [ - "**/*.d.ts" - ] + "test:spec": "mocha", + "test:coverage": "c8 --no-clean --reporter=lcov npm run test:spec && c8 report --reporter=text-summary --color" } } diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..fe3dfa6 --- /dev/null +++ b/renovate.json @@ -0,0 +1,18 @@ +{ + "extends": [ + "config:base", + "group:allNonMajor", + "group:definitelyTyped", + "group:linters", + "group:monorepos", + "group:testNonMajor" + ], + "packageRules": [ + { + "packageNames": ["node"], + "enabled": false + } + ], + "rangeStrategy": "bump", + "semanticCommits": false +} diff --git a/src/polish-vehicle-registration-certificate-decoder.ts b/src/polish-vehicle-registration-certificate-decoder.ts index ca6df8a..07ee72f 100644 --- a/src/polish-vehicle-registration-certificate-decoder.ts +++ b/src/polish-vehicle-registration-certificate-decoder.ts @@ -1,7 +1,7 @@ /// -import {PolishVehicleRegistrationCertificateNewFormatData} from './polish-vehicle-registration-certificate-new-format-data' -import {PolishVehicleRegistrationCertificateOldFormatData} from './polish-vehicle-registration-certificate-old-format-data' +import {PolishVehicleRegistrationCertificateNewFormatData} from './polish-vehicle-registration-certificate-new-format-data.js' +import {PolishVehicleRegistrationCertificateOldFormatData} from './polish-vehicle-registration-certificate-old-format-data.js' import nrv2eDecompress from 'nrv2e-decompress' @@ -10,12 +10,8 @@ import { PolishVehicleRegistrationCertificateFuel, PolishVehicleRegistrationCertificateFuelCode, } from './polish-vehicle-registration-certificate-fields' -export { - PolishVehicleRegistrationCertificateNewFormatData, -} from './polish-vehicle-registration-certificate-new-format-data' -export { - PolishVehicleRegistrationCertificateOldFormatData, -} from './polish-vehicle-registration-certificate-old-format-data' +export {PolishVehicleRegistrationCertificateNewFormatData} from './polish-vehicle-registration-certificate-new-format-data.js' +export {PolishVehicleRegistrationCertificateOldFormatData} from './polish-vehicle-registration-certificate-old-format-data.js' export type PolishVehicleRegistrationCertificateData = | PolishVehicleRegistrationCertificateOldFormatData diff --git a/src/polish-vehicle-registration-certificate-new-format-data.ts b/src/polish-vehicle-registration-certificate-new-format-data.ts index de067e8..254342a 100644 --- a/src/polish-vehicle-registration-certificate-new-format-data.ts +++ b/src/polish-vehicle-registration-certificate-new-format-data.ts @@ -2,7 +2,7 @@ import { PolishVehicleRegistrationCertificateFuel, PolishVehicleRegistrationCertificateIssuer, PolishVehicleRegistrationCertificateValue, -} from './polish-vehicle-registration-certificate-fields' +} from './polish-vehicle-registration-certificate-fields.js' export class PolishVehicleRegistrationCertificateNewFormatData { /** identyfikator formatu */ diff --git a/src/polish-vehicle-registration-certificate-old-format-data.ts b/src/polish-vehicle-registration-certificate-old-format-data.ts index b9efb7f..f9d661c 100644 --- a/src/polish-vehicle-registration-certificate-old-format-data.ts +++ b/src/polish-vehicle-registration-certificate-old-format-data.ts @@ -3,7 +3,7 @@ import { PolishVehicleRegistrationCertificateFuel, PolishVehicleRegistrationCertificateIssuer, PolishVehicleRegistrationCertificateValue, -} from './polish-vehicle-registration-certificate-fields' +} from './polish-vehicle-registration-certificate-fields.js' export class PolishVehicleRegistrationCertificateOldFormatData { /** seria dowodu rejestracyjnego */ diff --git a/test/polish-vehicle-registration-certificate-decoder.ts b/test/polish-vehicle-registration-certificate-decoder.ts index d57a5f6..5f3cfc8 100644 --- a/test/polish-vehicle-registration-certificate-decoder.ts +++ b/test/polish-vehicle-registration-certificate-decoder.ts @@ -1,6 +1,6 @@ -import {Feature, Given, Scenario, Then, When} from './lib/steps' +import {Feature, Given, Scenario, Then, When} from './lib/steps.js' -import PolishVehicleRegistrationCertificateDecoder from '../src/polish-vehicle-registration-certificate-decoder' +import PolishVehicleRegistrationCertificateDecoder from '../src/polish-vehicle-registration-certificate-decoder.js' Feature('Test nrv2eDecompress', () => { Scenario('Decompress file', () => { diff --git a/tsconfig.json b/tsconfig.json index 4a5c3a7..cb2f5d4 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,18 +1,19 @@ { + "extends": "@tsconfig/node14/tsconfig.json", "compilerOptions": { "declaration": true, - "esModuleInterop": true, "importHelpers": true, - "lib": ["es5"], - "module": "commonjs", + "module": "es2020", + "moduleResolution": "node", "noImplicitAny": true, "noImplicitReturns": true, "noUnusedLocals": true, "noUnusedParameters": true, "outDir": "./lib", - "target": "es5", - "strict": true, "typeRoots": ["node_modules/@types"] }, - "exclude": ["./examples/**/*", "./lib/**/*", "./test/**/*"] + "exclude": ["./examples/**/*", "./lib/**/*", "./test/**/*"], + "ts-node": { + "transpileOnly": true + } } diff --git a/tslint.yaml b/tslint.yaml deleted file mode 100644 index d3193ad..0000000 --- a/tslint.yaml +++ /dev/null @@ -1,24 +0,0 @@ -extends: - - tslint:recommended - - tslint-config-prettier -rules: - await-promise: [true, Promise, PromiseLike] # chai-as-promised - curly: [true, ignore-same-line] # too strict - interface-name: false # don't like hungarian notation - max-line-length: false # prettier will handle it - member-access: [true, no-public] # public is implicit - no-console: [true, log] # `console.log` is for temporary debugging only - no-empty-interface: false # too strict - no-unused-variable: false # no-unused-variable is deprecated. Since TypeScript 2.9. - object-literal-sort-keys: false # too problematic - typedef: # types are mandatory - - true - - call-signature - - parameter - - property-declaration - variable-name: # allow leading underscore - - true - - check-format - - allow-leading-underscore - - require-const-for-all-caps - - ban-keywords