@lucianpacurar/iso20022.js 0.2.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Svapnil Ankolkar
+
+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.

package/README.md

@@ -0,0 +1,212 @@
+<div align="center">
+  <a href="https://iso20022js.com">
+    <img alt="iso20022.js logo" src="https://github.com/user-attachments/assets/662bc55f-2be0-41dc-b79e-d62f325b1f80" height="128">
+  </a>
+  <h1>iso20022.js</h1>
+  <a href=""><img alt="github stars" src="https://img.shields.io/github/stars/svapnil/iso20022.js?color=FFD700&label=Stars&logo=Github"></a>
+  <a href="https://coveralls.io/github/svapnil/iso20022.js?branch=main"><img alt="coverage" src="https://coveralls.io/repos/github/svapnil/iso20022.js/badge.svg?branch=main"></a>
+</div>
+
+
+This package is meant for companies using ISO20022 to send and receive payment information, specifically initiating SEPA, ACH, FedWire, RTP, SWIFT payments and receiving cash management files.
+
+Read the Docs: https://docs.iso20022js.com
+
+The mission of this NPM package is to connect the most widely used programming language to the most widely used payment standard.
+
+If you're interested in using iso20022.js and would like to use different payment types or ingest files using CAMT, please email [iso20022js@woodside.sh](mailto:iso20022js@woodside.sh).
+
+[![Book with Cal](https://cal.com/book-with-cal-dark.svg)](https://cal.com/woodside/iso20022js?utm_source=banner&utm_campaign=oss)
+
+<a href="https://news.ycombinator.com/item?id=41163645">
+  <img
+    style="width: 250px; height: 54px;" width="250" height="54"
+    alt="Featured on Hacker News"
+    src="https://hackernews-badge.vercel.app/api?id=41163645"
+  />
+</a>
+
+
+# Installation
+
+```bash
+npm install iso20022.js
+```
+
+# Examples 
+
+Examples of ISO20022 messages being created across different payment types:
+
+```bash
+npx tsx examples/sepa-credit-transfer.ts
+npx tsx examples/rtp-credit-transfer.ts
+npx tsx examples/swift-credit-transfer.ts
+npx tsx examples/get-account-messages.ts
+```
+
+# Usage
+
+### Full Payment Initiation Example: Sending a SEPA Transfer
+
+```ts
+import { ISO20022 } from 'iso20022.js';
+
+const iso20022 = new ISO20022({
+  initiatingParty: {
+    name: 'Acme Corporation',
+    id: 'ACMECORP',
+    account: {
+      iban: 'ES1234567890123456789012'
+    },
+    agent: {
+      bic: 'BANKESMMXXX',
+      bankAddress: {
+        country: 'ES'
+      }
+    }
+  },
+});
+
+const creditPaymentInitiation = iso20022.createSEPACreditPaymentInitiation([
+  {
+    type: 'sepa',
+    direction: 'credit',
+    amount: 1000,
+    currency: 'EUR',
+    creditor: {
+      name: 'Hans Schmidt',
+      account: {
+        iban: 'DE1234567890123456789012'
+      },
+      agent: {
+        bic: 'DEUTDEFFXXX'
+      },
+      address: {
+        streetName: 'Example Street',
+        buildingNumber: '123',
+        townName: 'Berlin',
+        countrySubDivision: 'Berlin',
+        postalCode: '10115',
+        country: 'DE'
+      }
+    }
+  }
+]);
+
+console.log(creditPaymentInitiation.toString());
+```
+
+Note that amounts are reresented in the smallest decimal unit (`$100.55` is stored as a number `10055`) and the decimal precision of a currency can be retrieved from `getCurrencyPrecision(Ccy)`
+
+### Example: Sending an ACH Payment
+
+```ts
+// Send an ACH Payment Anywhere in the U.S.
+const payment = iso20022.createACHCreditPaymentInitiation({
+    paymentInstructions: [
+        {
+        type: 'ach',
+        direction: 'credit',
+        amount: 1250000, // $12,500.00 Dollars
+        currency: 'USD',
+        creditor: {
+            name: 'Alex Kan',
+            account: {
+                accountNumber: '333456118812',
+            },
+            agent: {
+                abaRoutingNumber: '021000021',
+            }
+        },
+        remittanceInformation: 'PAYROLL - BIWEEKLY SALARY SR SOFTWARE ENGINEER'
+    }],
+});
+```
+
+### Cash Management: Ingesting a CAMT.053 file
+
+```ts
+import { CashManagementEndOfDayReport } from 'iso20022.js';
+
+const xml = fs.readFileSync('balance_report.xml', 'utf8');
+const report = CashManagementEndOfDayReport.fromXML(xml);
+
+console.log(report.transactions);
+```
+
+### Cash Management: Create an account request CAMT.003 file
+
+```ts
+import { ISO20022 } from 'iso20022.js';
+import { CashManagementGetAccount } from 'iso20022.js';
+
+const msg = new CashManagementGetAccount({
+  ...
+});
+const xml = msg.serialize();
+const json = msg.toJSON();
+
+const msg2 = CashManagementGetAccount.fromXML(xml);
+const msg3 = CashManagementGetAccount.fromJSON(json);
+```
+
+### Generic class implementation (preview)
+
+If you need generic implementation to a type of message implemented you can do the following
+
+```ts
+const type = "CAMT.006"; // can come as an input
+import { getISO20022Implementation } from 'iso20022.js';
+
+let impl = getISO20022Implementation(type);
+if (impl) {
+  const msg1 = impl.fromXml("some xml content");
+  const msg2 = impl.fromJSON({ some: object }); // following the ISO format
+  const msg3 = new impl({config: object}); // following the internal data definition
+  const xml1 = msg1.serialize(); // generate a xml message as string
+  const json2 = msg1.toJSON(); // generate a js object that can then be stringify
+  const data = msg1.data; // the internal representation of the message
+}
+```
+
+### Testing
+
+```bash
+npm run test
+```
+
+## About ISO20022
+
+ISO20022 is the standard format for financial transactions. This library aims to build a powerful yet simple API to create these files, following Typescript conventions.
+
+You might want to use this package if you need to create these types of files.
+
+# Features
+
+| Feature                | Description                                          | Todo |
+| ---------------------- | ---------------------------------------------------- | ---- |
+| SWIFT Credit Transfer  | Create SWIFT credit transfer messages                | ✅   |
+| CAMT Transactions      | Ingest transaction data from CAMT files              | ✅   |
+| CAMT Requests      | Query and Responses on accounts and transactions   | ✅   |
+| SEPA Credit Transfer   | Create SEPA credit transfer messages                 | ✅   |
+| ACH Credit Transfer    | Create ACH credit transfer messages                  | ✅   |
+| RTP / Fednow Credit Transfer | Create Fednow credit transfer messages         | ✅   |
+| FedWire Credit Transfer | Create FedWire credit transfer messages               | 🚧   |
+
+
+# Reasons to use `iso20022.js`
+
+| Feature                | Description                                          |      |
+| ---------------------- | ---------------------------------------------------- | ---- |
+| XML Generation         | Generate valid ISO 20022 XML files                   | ✅   |
+| Type Safety            | Built with TypeScript for enhanced type checking     | ✅   |
+| Extensible             | Easy to extend for custom message types              | ✅   |
+| Validation             | Built-in validation for ISO 20022 message structures | ✅   |
+
+# Security
+
+`iso20022.js` is local, open source, and free to use. This means that payment instructions are created on your machine, not on a remote server.
+
+We take security seriously, and are consistently looking for ways to improve. If you have any suggestions or find any security issues, please [open an issue](https://github.com/svapnil/iso20022.js/issues/new/choose).
+
+**NOTE: We are tracking the [libxmljs vulnerability](https://github.com/svapnil/iso20022.js/issues/26), a dependency we use in our unit tests and have a plan to deprecate. Note that production use of `iso20022.js` is not affected by this vulnerability.**