Merge pull request #1 from wes4m/dev

Initial experimental release v0.10

Author: wes4m

.gitignore

@@ -102,3 +102,9 @@ dist
 
 # TernJS port file
 .tern-port
+
+
+/lib
+/testing_lib
+/src/tests
+.DS_STORE

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Wesam Alzahir 
+
+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.

README.md

@@ -0,0 +1,111 @@
+<div align="center">
+  <br/>
+  <img src="./docs/logo.png"/>
+  <p>v0.10 (experimental)</p>
+  <br/>
+  <br/>
+  <p>
+    An implementation of Saudi Arabia ZATCA's E-Invocing requirements, processes, and standards in TypeScript. <br/>
+  </p>
+  Read the <a href="/docs">documentation PDFs</a> or <a href="https://zatca.gov.sa/en/E-Invoicing/SystemsDevelopers/Pages/TechnicalRequirementsSpec.aspx">Systems Developers</a> for more details.
+  <br/>
+  <br/>
+  <p>
+  
+[![GitHub license](https://badgen.net/github/license/wes4m/zatca-xml-js)](https://github.com/wes4m/zatca-xml-js/blob/main/LICENSE)
+    <a href="https://github.com/wes4m">
+        <img src="https://img.shields.io/badge/maintainer-wes4m-blue"/>
+    </a>
+    <a href="https://badge.fury.io/js/zatca-xml-js">
+      <img src="https://badge.fury.io/js/zatca-xml-js.svg"/>
+    </a>
+  </p>
+</div>
+
+# Dependencies
+If you plan on using the built in `EGS` module to generate keys, and CSR. The `EGS` module in the package is dependent on <a href="https://www.openssl.org">OpenSSL</a> being installed in the system it's running on. It's being used to generate an `ECDSA` key pair using the `secp256k1` curve. also to generate and sign a CSR.
+
+All other parts of the package will work fine without `OpenSSL`. (meaning it supports react-native and other frameworks)
+
+# Supports
+All tha main futures required to on-board a new EGS. Create, sign, and report a simplified tax invoice are currently supported.
+- EGS (E-Invoice Generation System).
+    - Creation/on-boarding (Compliance and Production x.509 CSIDs).
+    - Cryptographic stamps generation.
+- Simplified Tax Invoice.
+    - Creation.
+    - Signing.
+    - Compliance checking.
+    - Reporting.
+
+# Installation
+```
+npm install zatca-xml-js
+```
+
+# Usage
+View full example at <a href="/examples">examples</a>
+```typescript
+import {
+    EGS, EGSUnitInfo,
+    ZATCASimplifiedTaxInvoice,
+} from "zatca-xml-js";
+
+
+// New Invoice and EGS Unit
+const invoice: ZATCASimplifiedTaxInvoice = {/*...*/};
+const egsunit: EGSUnitInfo = {/*...*/};
+
+// Init EGS unit
+const egs = new EGS(egsunit);
+// New Keys & CSR for the EGS
+await egs.generateNewKeysAndCSR(false);
+// Issue a new compliance cert for the EGS
+const compliance_rid = await egs.issueComplianceCertificate("123345");
+// Sign invoice
+const {signed_invoice_string, invoice_hash} = egs.signInvoice(invoice);
+// Check invoice compliance
+await egs.checkInvoiceCompliance(signed_invoice_string, invoice_hash);
+// Issue production certificate
+await egs.issueProductionCertificate(compliance_rid);
+// Report invoice
+await egs.reportInvoice(signed_invoice_string, invoice_hash);
+```
+
+# Implementation
+- General implementation (<a href="/docs/20220624_ZATCA_Electronic_Invoice_XML_Implementation_Standard_vF.pdf">More details</a>)
+    - KSA Rules & Business
+    - UBL 2.1 Spec
+    - ISO EN16931
+    - UN/CEFACT Code List 1001
+    - ISO 3166
+    - ISO 4217:2015
+    - UN/CEFACT Code List 5305, D.16B
+- Security standards (<a href="/docs/20220624_ZATCA_Electronic_Invoice_Security_Features_Implementation_Standards.pdf">More details</a>)
+    - NCA National Cryptographic Standards (NCS - 1 : 2020)
+    - NCDC Digital Signing Policy (Version 1.1: 2020)
+    - ETSI EN 319 102-1
+    - ETSI EN 319 132-1
+    - ETSI EN 319 142-1
+    - W3C XML-Signature Syntax and Processing
+    - ETSI EN 319 122-1
+    - IETF RFC 5035 (2007)
+    - RFC 5280
+    - ISO 32000-1
+    - IETF RFC 5652 (2009)
+    - RFP6749
+    - NIST SP 56A
+
+# Notice of Non-Affiliation and Disclaimer
+`zatca-xml-js` is not affiliated, associated, authorized, endorsed by, or in any way officially connected with ZATCA (Zakat, Tax and Customs Authority), or any of its subsidiaries or its affiliates. The official ZATCA website can be found at https://zatca.gov.sa.
+
+# Contribution
+All contributions are appreciated.
+
+## Roadmap
+- CSIDs renewal, revoking.
+- Populating templates using a template engine instead of `replace`
+- Getting ZATCA to hopefully minify the XMLs before hashing ?
+
+
+I'm not planning on supporting `Tax Invoices` (Not simplified ones). If any one wants to tackle that part.