bysquare 1.0.2 → 1.0.6

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2021 Filip Seman
-
-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:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-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.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+    Copyright 2021 Filip Seman
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

package/README.md

@@ -1,216 +1,149 @@
-bysquare
-========
+# bysquare
 
-Simple Node.js library to generate `QR` string
-"_PAY by square – platby QR kódom_".
+![build][build] ![build][license] ![build][version]
 
-💰 **What is `PAY by square`?**
+<!-- Dependency free simple  -->
 
-It's standard for encoding of payment information into `QR` codes for Slovak
-banks.
+Simple `Node.js` library to generate "PAY by square" `QR` string.
 
-🖨️ **Can I generate an image?**
+**What is `PAY by square`?**
 
-This module is independent of the image generator, it's up to you how you create
-an image from the generated string.
+It's a national standard for payment QR codes adopted by Slovak Banking
+Association (SBA) in 2013. It is part of a large number of invoices, reminders
+and other payment regulations.
 
-Usage
------
+**Can I generate an image?**
 
-📦 **Install**
+This library is un-opinionated about generating images. Image generation from
+qr-code string depends on your implementation. See the [examples](examples).
 
-```bash
+## Install
+
+Node.js
+
+```sh
 npm install bysquare
 ```
 
+## API
+
 **Available functions**
 
-<details>
-    <summary>Model</summary>
+### `generate(model: Model): Promise<string>`
 
 ```typescript
-interface Model {
-    /** Max length 10 */
-    InvoiceID?: string,
-    /** count */
-    Payments: number,
-    /** Max length 1 */
-    PaymentOptions: number,
-    /**
-     * Max length 15
-     * Format #.########
-     * */
-    Amount: number,
-    /**
-     * Max length 3
-     * Representation ISO 4217
-     *  */
-    CurrencyCode: CurrencyCodes,
-    /**
-     * Max length 8
-     * Format YYYYMMDD
-     * */
-    PaymentDueDate?: string,
-    /** Max length 10 */
-    VariableSymbol?: string,
-    /** Max length 4 */
-    ConstantSymbol?: string,
-    /** Max length 10 */
-    SpecificSymbol?: string,
-    /** Max length 35 */
-    OriginatorsReferenceInformation?: string,
-    /** Max length 140 */
-    PaymentNote?: string,
-    /** count */
-    BankAccounts: number,
-    /** Max length 34 */
-    IBAN: string,
-    /**
-     * Max length 11
-     * Format ISO 9362, 8 or 11 characters long
-     * */
-    BIC?: string,
-    /** Max length 1 */
-    StandingOrderExt?: number,
-    /** Max length 2 */
-    Day?: number,
-    /** Max length 4 */
-    Month?: number,
-    /** Max length 1 */
-    Periodicity?: string,
-    /**
-     * Max length 8
-     * Format YYYYMMDD
-     * */
-    LastDate?: string,
-    /** Max length 1 */
-    DirectDebitExt?: number,
-    /** Max length 1 */
-    DirectDebitScheme?: number,
-    /** Max length 1 */
-    DirectDebitType?: number,
-    /** Max length 10 */
-    VariableSymbol_?: string,
-    /** Max length 10 */
-    SpecificSymbol_?: string,
-    /** Max length 35 */
-    OriginatorsReferenceInformation_?: string,
-    /** Max length 35 */
-    MandateID?: string,
-    /** Max length 35 */
-    CreditorID?: string,
-    /** Max length 35 */
-    ContractID?: string,
-    /**
-     * Max length 15
-     * Format #.########
-     * */
-    MaxAmount?: number,
-    /**
-     * Max length 8
-     * Format YYYYMMDD
-     */
-    ValidTillDate?: string,
-    /** Max length 70 */
-    BeneficiaryName?: string,
-    /** Max length 70 */
-    BeneficiaryAddressLine1?: string,
-    /** Max length 70 */
-    BeneficiaryAddressLine2?: string,
-}
+import { generate, Model } from 'bysquare';
+
+const model: Model = {
+    IBAN: 'SK9611000000002918599669',
+    Amount: 100.0,
+    CurrencyCode: "EUR",
+    VariableSymbol: "123",
+    Payments: 1,
+    PaymentOptions: 1,
+    BankAccounts: 1,
+};
+
+generate(model).then((qrString) => {
+    // your logic...
+})
 ```
 
-</details>
+### `parse(qrString: string): Promise<Model>`
 
 ```typescript
-function generate(model: Model): Promise<string>;
-function generate(model: Model, cbResult: (qrString: string) => void): void;
-```
+import { parse } from 'bysquare';
+
+const qr: string = '0005FO5V6G02NE0JSD04M4KD3R71IEMDHVJGQVQ6H573788QDK16QE2RLPHHHGVV7T9FG9OBDJI1V9MAE5A7B4T8FVVS9FOG00';
 
-Examples
---------
-
-**Promise**
-
-```javascript
-const generate = require("bysquare").generate;
-
-(async () => {
-    const result = await generate({
-        IBAN: "SK9611000000002918599669",
-        Amount: 100.0,
-        CurrencyCode: "EUR",
-        VariableSymbol: "123",
-        Payments: 1,
-        PaymentOptions: 1,
-        BankAccounts: 1,
-    });
-    // Your logic...
-})();
+parse(qrString).then((parsed) => {
+    // your logic...
+});
 ```
 
-**Callback**
+<!-- ## How it works -->
+<!-- TODO: diagram -->
 
-```javascript
-const generate = require('bysquare').generate;
+## CLI
 
-generate(
-    {
-        IBAN: "SK9611000000002918599669",
-        Amount: 100.0,
-        CurrencyCode: "EUR",
-        VariableSymbol: "123",
-        Payments: 1,
-        PaymentOptions: 1,
-        BankAccounts: 1,
-    },
-    (result) => {
-        // Your logic...
-    }
-);
+Local executable install
+
+```sh
+npm install --global bysquare
+bysquare ./example.json
 ```
 
-**Express**
+Executable without installation
 
-```typescript
+```sh
+npx bysquare ./example.json
 ```
 
-**Express + qr-image generation (server)**
+**file**
 
-```typescript
+```sh
+bysquare ./example.json
 ```
 
-**Express + qr-image generation (client)**
+```sh
+$ 0005FO5V6G02NE0JSD04M4KD3R71IEMDHVJGQVQ6H573788QDK16QE2RLPHHHGVV7T9FG9OBDJI1V9MAE5A7B4T8FVVS9FOG00
+```
 
-```typescript
+**standard input**
+
+```sh
+$ echo '
+    {
+        "IBAN": "SK9611000000002918599669",
+        "Amount": 100.0,
+        "CurrencyCode": "EUR",
+        "VariableSymbol": "123",
+        "Payments": 1,
+        "PaymentOptions": 1,
+        "BankAccounts": 1
+    }' \
+| bysquare
 ```
 
-Versioning
-----------
+```sh
+$ 0005FO5V6G02NE0JSD04M4KD3R71IEMDHVJGQVQ6H573788QDK16QE2RLPHHHGVV7T9FG9OBDJI1V9MAE5A7B4T8FVVS9FOG00
+```
 
-- Run the `preversion` script.
-- Bump version in `package.json` as requested (patch, minor, major, etc).
-- Run the `version` script.
-- Commit and tag.
-- Run the `postversion` script.
-- Push tag, changes
+## License
 
-License
--------
+Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
 
-Distributed under the MIT License. See `LICENSE` for more information.
+## Contributors
 
-Contact
--------
+![Contributors](https://contrib.rocks/image?repo=xseman/bysquare)
 
-If you have any questions, do not hesitate to contact me.
+<!-- Links -->
 
-Filip Seman - seman.filip@gmail.com
+[build]: https://img.shields.io/github/workflow/status/xseman/bysquare/tests
+[version]: https://img.shields.io/npm/v/bysquare
+[license]: https://img.shields.io/github/license/xseman/bysquare
 
-References
-----------
+## Resources
 
 - <https://bysquare.com/>
 - <https://github.com/matusf/pay-by-square>
 - <https://www.vutbr.cz/studenti/zav-prace/detail/78439>
 - <https://www.sbaonline.sk/wp-content/uploads/2020/03/pay-by-square-specifications-1_1_0.pdf>
+
+<!--
+
+Versioning
+----------
+
+- Stash unfinished work
+- Run the `preversion` script
+- Bump version in `package.json` as requested (patch, minor, major, etc)
+- Build app
+- Run the `version` script
+- Commit and tag
+- Run the `postversion` script
+- Checkout to master
+- Push commits and tag, git push, git push --tags
+- Publish to npm, npm publish
+
+-->

package/lib/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};