@lucianpacurar/iso20022.js 0.2.7

package/dist/src/iso20022.d.ts

@@ -0,0 +1,375 @@
+import { Party, SWIFTCreditPaymentInstruction, SEPACreditPaymentInstruction, RTPCreditPaymentInstruction, ACHCreditPaymentInstruction } from './lib/types.js';
+import { SWIFTCreditPaymentInitiation } from './pain/001/swift-credit-payment-initiation';
+import { SEPACreditPaymentInitiation } from './pain/001/sepa-credit-payment-initiation';
+import { RTPCreditPaymentInitiation } from './pain/001/rtp-credit-payment-initiation';
+import { ACHCreditPaymentInitiation } from './pain/001/ach-credit-payment-initiation';
+import { GenericISO20022Message, ISO20022MessageTypeName } from './lib/interfaces';
+export * from './camt';
+export * from './lib';
+type AtLeastOne<T> = [T, ...T[]];
+/**
+ * Configuration interface for the ISO20022 class.
+ * @interface ISO20022Config
+ * @example
+ * const config: ISO20022Config = {
+ *     initiatingParty: {
+ *         name: 'Example Corp',
+ *         id: 'EXAMPLECORP',
+ *         account: {
+ *             accountNumber: '123456789',
+ *         },
+ *         agent: {
+ *             bic: 'CHASUS33',
+ *             bankAddress: {
+ *                 country: 'US',
+ *             },
+ *         },
+ *     },
+ * };
+ */
+export interface ISO20022Config {
+    /**
+     * The party initiating the ISO20022 messages.
+     * This party is typically the sender of the messages or the entity responsible for the transaction.
+     * @type {Party}
+     */
+    initiatingParty: Party;
+}
+/**
+ * Configuration interface for SWIFT Credit Payment Initiation.
+ * @interface SWIFTCreditPaymentInitiationConfig
+ * @example
+ * const config: SWIFTCreditPaymentInitiationConfig = {
+ *     paymentInstructions: [
+ *       {
+ *         type: 'swift',
+ *         direction: 'credit',
+ *         amount: 1000,
+ *         currency: 'USD',
+ *         creditor: {
+ *           name: 'Hans Schneider',
+ *           account: {
+ *             iban: 'DE1234567890123456',
+ *           },
+ *           agent: {
+ *             bic: 'DEUTDEFF',
+ *             bankAddress: {
+ *               country: 'DE',
+ *             },
+ *           },
+ *           address: {
+ *             streetName: 'Hauptstraße',
+ *             buildingNumber: '42',
+ *             postalCode: '10115',
+ *             townName: 'Berlin',
+ *             country: 'DE',
+ *           },
+ *         },
+ *         remittanceInformation: 'Invoice payment #123',
+ *       },
+ *     ],
+ *     messageId: 'MSGID123', // Optional
+ *     creationDate: new Date(), // Optional
+ * };
+ */
+export interface SWIFTCreditPaymentInitiationConfig {
+    /**
+     * An array of payment instructions.
+     * @type {AtLeastOne<SWIFTCreditPaymentInstruction>}
+     */
+    paymentInstructions: AtLeastOne<SWIFTCreditPaymentInstruction>;
+    /**
+     * Optional unique identifier for the message. If not provided, a UUID will be generated.
+     * @type {string}
+     */
+    messageId?: string;
+    /**
+     * Optional creation date for the message. If not provided, current date will be used.
+     * @type {Date}
+     */
+    creationDate?: Date;
+}
+/**
+ * Configuration interface for SEPA Credit Payment Initiation.
+ * @interface SEPACreditPaymentInitiationConfig
+ * @example
+ * const config: SEPACreditPaymentInitiationConfig = {
+ *     paymentInstructions: [
+ *       {
+ *         type: 'sepa',
+ *         direction: 'credit',
+ *         amount: 1000, // €10.00 Euros
+ *         currency: 'EUR',
+ *         creditor: {
+ *           name: 'Hans Schneider',
+ *           account: {
+ *             iban: 'DE1234567890123456',
+ *           },
+ *         },
+ *         remittanceInformation: 'Invoice payment #123',
+ *       },
+ *     ],
+ *     messageId: 'MSGID123', // Optional
+ *     creationDate: new Date(), // Optional
+ * };
+ */
+export interface SEPACreditPaymentInitiationConfig {
+    /**
+     * An array of payment instructions.
+     * @type {AtLeastOne<SEPACreditPaymentInstruction>}
+     */
+    paymentInstructions: AtLeastOne<SEPACreditPaymentInstruction>;
+    /**
+     * Optional unique identifier for the message. If not provided, a UUID will be generated.
+     * @type {string}
+     */
+    messageId?: string;
+    /**
+     * Optional creation date for the message. If not provided, current date will be used.
+     * @type {Date}
+     */
+    creationDate?: Date;
+}
+/**
+ * Configuration interface for RTP Credit Payment Initiation.
+ * @interface RTPCreditPaymentInitiationConfig
+ * @example
+ * const config: RTPCreditPaymentInitiationConfig = {
+ *     paymentInstructions: [
+ *       {
+ *         type: 'rtp',
+ *         direction: 'credit',
+ *         amount: 100000, // $1000.00
+ *         currency: 'USD',
+ *         creditor: {
+ *           name: 'All-American Dogs Co.',
+ *           account: {
+ *             accountNumber: '123456789012',
+ *           },
+ *           agent: {
+ *             abaRoutingNumber: '37714568112',
+ *           },
+ *         },
+ *         remittanceInformation: '1000 Hot Dogs Feb26',
+ *       },
+ *     ],
+ *     messageId: 'MSGID123', // Optional
+ *     creationDate: new Date(), // Optional
+ * };
+ */
+export interface RTPCreditPaymentInitiationConfig {
+    /**
+     * An array of payment instructions.
+     * @type {AtLeastOne<RTPCreditPaymentInstruction>}
+     */
+    paymentInstructions: AtLeastOne<RTPCreditPaymentInstruction>;
+    /**
+     * Optional unique identifier for the message. If not provided, a UUID will be generated.
+     * @type {string}
+     */
+    messageId?: string;
+    /**
+     * Optional creation date for the message. If not provided, current date will be used.
+     * @type {Date}
+     */
+    creationDate?: Date;
+}
+/**
+ * Configuration interface for ACH Credit Payment Initiation.
+ * @interface ACHCreditPaymentInitiationConfig
+ * @example
+ * const config: ACHCreditPaymentInitiationConfig = {
+ *     paymentInstructions: [
+ *       {
+ *         type: 'ach',
+ *         direction: 'credit',
+ *         amount: 100000, // $1000.00
+ *         currency: 'USD',
+ *         creditor: {
+ *           name: 'John Doe Funding LLC',
+ *           account: {
+ *             accountNumber: '123456789012',
+ *           },
+ *           agent: {
+ *             abaRoutingNumber: '123456789',
+ *           },
+ *         },
+ *         remittanceInformation: 'Invoice #12345',
+ *       },
+ *     ],
+ *     messageId: 'MSGID123', // Optional
+ *     creationDate: new Date(), // Optional
+ * };
+ */
+export interface ACHCreditPaymentInitiationConfig {
+    /**
+     * An array of payment instructions.
+     * @type {AtLeastOne<ACHCreditPaymentInstruction>}
+     */
+    paymentInstructions: AtLeastOne<ACHCreditPaymentInstruction>;
+    /**
+     * Optional unique identifier for the message. If not provided, a UUID will be generated.
+     * @type {string}
+     */
+    messageId?: string;
+    /**
+     * Optional creation date for the message. If not provided, current date will be used.
+     * @type {Date}
+     */
+    creationDate?: Date;
+}
+/**
+ * Represents an ISO20022 core message creator.
+ * This class provides methods to create various basic ISO20022 compliant messages.
+ *
+ * @example
+ * const iso20022 = new ISO20022({
+ *     initiatingParty: {
+ *         name: 'Example Corp',
+ *         id: 'EXAMPLECORP',
+ *         account: {
+ *             accountNumber: '123456789',
+ *         },
+ *         agent: {
+ *             bic: 'CHASUS33',
+ *             bankAddress: {
+ *                 country: 'US',
+ *             },
+ *         },
+ *     },
+ * });
+ */
+declare class ISO20022 {
+    private initiatingParty;
+    /**
+     * Creates an instance of ISO20022.
+     * @param {ISO20022Config} config - The configuration object for ISO20022.
+     */
+    constructor(config: ISO20022Config);
+    /**
+     * Creates a SWIFT Credit Payment Initiation message.
+     * @param {SWIFTCreditPaymentInitiationConfig} config - Configuration containing payment instructions and optional parameters.
+     * @example
+     * const payment = iso20022.createSWIFTCreditPaymentInitiation({
+     *   paymentInstructions: [
+     *     {
+     *       type: 'swift',
+     *       direction: 'credit',
+     *       amount: 1000,
+     *       currency: 'USD',
+     *       creditor: {
+     *         name: 'Hans Schneider',
+     *         account: {
+     *           iban: 'DE1234567890123456',
+     *         },
+     *         agent: {
+     *           bic: 'DEUTDEFF',
+     *           bankAddress: {
+     *             country: 'DE',
+     *           },
+     *         },
+     *         address: {
+     *           streetName: 'Hauptstraße',
+     *           buildingNumber: '42',
+     *           postalCode: '10115',
+     *           townName: 'Berlin',
+     *           country: 'DE',
+     *         },
+     *       },
+     *       remittanceInformation: 'Invoice payment #123',
+     *     },
+     *   ],
+     *   messageId: 'SWIFT-MSG-001', // Optional
+     *   creationDate: new Date('2025-03-01'), // Optional
+     * });
+     * @returns {SWIFTCreditPaymentInitiation} A new SWIFT Credit Payment Initiation object.
+     */
+    createSWIFTCreditPaymentInitiation(config: SWIFTCreditPaymentInitiationConfig): SWIFTCreditPaymentInitiation;
+    /**
+     * Creates a SEPA Credit Payment Initiation message.
+     * @param {SEPACreditPaymentInitiationConfig} config - Configuration containing payment instructions and optional parameters.
+     * @example
+     * const payment = iso20022.createSEPACreditPaymentInitiation({
+     *   paymentInstructions: [
+     *     {
+     *       type: 'sepa',
+     *       direction: 'credit',
+     *       amount: 1000, // €10.00 Euros
+     *       currency: 'EUR',
+     *       creditor: {
+     *         name: 'Hans Schneider',
+     *         account: {
+     *           iban: 'DE1234567890123456',
+     *         },
+     *       },
+     *       remittanceInformation: 'Invoice payment #123',
+     *     },
+     *   ],
+     *   messageId: 'SEPA-MSG-001', // Optional
+     *   creationDate: new Date('2025-03-01'), // Optional
+     * });
+     * @returns {SEPACreditPaymentInitiation} A new SEPA Credit Payment Initiation object.
+     */
+    createSEPACreditPaymentInitiation(config: SEPACreditPaymentInitiationConfig): SEPACreditPaymentInitiation;
+    /**
+     * Creates a RTP Credit Payment Initiation message.
+     * @param {RTPCreditPaymentInitiationConfig} config - Configuration containing payment instructions and optional parameters.
+     * @example
+     * const payment = iso20022.createRTPCreditPaymentInitiation({
+     *   paymentInstructions: [
+     *     {
+     *       type: 'rtp',
+     *       direction: 'credit',
+     *       amount: 100000, // $1000.00
+     *       currency: 'USD',
+     *       creditor: {
+     *         name: 'All-American Dogs Co.',
+     *         account: {
+     *           accountNumber: '123456789012',
+     *         },
+     *         agent: {
+     *           abaRoutingNumber: '37714568112',
+     *         },
+     *       },
+     *       remittanceInformation: '1000 Hot Dogs Feb26',
+     *     },
+     *   ],
+     *   messageId: 'RTP-MSG-001', // Optional
+     *   creationDate: new Date('2025-03-01'), // Optional
+     * });
+     * @returns {RTPCreditPaymentInitiation} A new RTP Credit Payment Initiation object.
+     */
+    createRTPCreditPaymentInitiation(config: RTPCreditPaymentInitiationConfig): RTPCreditPaymentInitiation;
+    /**
+     * Creates an ACH Credit Payment Initiation message.
+     * @param {ACHCreditPaymentInitiationConfig} config - Configuration containing payment instructions and optional parameters.
+     * @example
+     * const payment = iso20022.createACHCreditPaymentInitiation({
+     *   paymentInstructions: [
+     *     {
+     *       type: 'ach',
+     *       direction: 'credit',
+     *       amount: 100000, // $1000.00
+     *       currency: 'USD',
+     *       creditor: {
+     *         name: 'John Doe Funding LLC',
+     *         account: {
+     *           accountNumber: '123456789012',
+     *         },
+     *         agent: {
+     *           abaRoutingNumber: '123456789',
+     *         },
+     *       },
+     *       remittanceInformation: 'Invoice #12345',
+     *     },
+     *   ],
+     *   messageId: 'ACH-MSG-001', // Optional
+     *   creationDate: new Date('2025-03-01'), // Optional
+     * });
+     * @returns {ACHCreditPaymentInitiation} A new ACH Credit Payment Initiation object.
+     */
+    createACHCreditPaymentInitiation(config: ACHCreditPaymentInitiationConfig): ACHCreditPaymentInitiation;
+    /** Create a message CAMT or other */
+    createMessage(type: ISO20022MessageTypeName, config: any): GenericISO20022Message;
+}
+export default ISO20022;

package/dist/src/lib/countries.d.ts

@@ -0,0 +1,254 @@
+declare const Alpha2CountryCode: {
+    readonly AF: "AF";
+    readonly AL: "AL";
+    readonly DZ: "DZ";
+    readonly AS: "AS";
+    readonly AD: "AD";
+    readonly AO: "AO";
+    readonly AI: "AI";
+    readonly AQ: "AQ";
+    readonly AG: "AG";
+    readonly AR: "AR";
+    readonly AM: "AM";
+    readonly AW: "AW";
+    readonly AU: "AU";
+    readonly AT: "AT";
+    readonly AZ: "AZ";
+    readonly BS: "BS";
+    readonly BH: "BH";
+    readonly BD: "BD";
+    readonly BB: "BB";
+    readonly BY: "BY";
+    readonly BE: "BE";
+    readonly BZ: "BZ";
+    readonly BJ: "BJ";
+    readonly BM: "BM";
+    readonly BT: "BT";
+    readonly BO: "BO";
+    readonly BA: "BA";
+    readonly BW: "BW";
+    readonly BV: "BV";
+    readonly BR: "BR";
+    readonly IO: "IO";
+    readonly BN: "BN";
+    readonly BG: "BG";
+    readonly BF: "BF";
+    readonly BI: "BI";
+    readonly KH: "KH";
+    readonly CM: "CM";
+    readonly CA: "CA";
+    readonly CV: "CV";
+    readonly KY: "KY";
+    readonly CF: "CF";
+    readonly TD: "TD";
+    readonly CL: "CL";
+    readonly CN: "CN";
+    readonly CX: "CX";
+    readonly CC: "CC";
+    readonly CO: "CO";
+    readonly KM: "KM";
+    readonly CG: "CG";
+    readonly CD: "CD";
+    readonly CK: "CK";
+    readonly CR: "CR";
+    readonly CI: "CI";
+    readonly HR: "HR";
+    readonly CU: "CU";
+    readonly CY: "CY";
+    readonly CZ: "CZ";
+    readonly DK: "DK";
+    readonly DJ: "DJ";
+    readonly DM: "DM";
+    readonly DO: "DO";
+    readonly EC: "EC";
+    readonly EG: "EG";
+    readonly SV: "SV";
+    readonly GQ: "GQ";
+    readonly ER: "ER";
+    readonly EE: "EE";
+    readonly ET: "ET";
+    readonly FK: "FK";
+    readonly FO: "FO";
+    readonly FJ: "FJ";
+    readonly FI: "FI";
+    readonly FR: "FR";
+    readonly GF: "GF";
+    readonly PF: "PF";
+    readonly TF: "TF";
+    readonly GA: "GA";
+    readonly GM: "GM";
+    readonly GE: "GE";
+    readonly DE: "DE";
+    readonly GH: "GH";
+    readonly GI: "GI";
+    readonly GR: "GR";
+    readonly GL: "GL";
+    readonly GD: "GD";
+    readonly GP: "GP";
+    readonly GU: "GU";
+    readonly GT: "GT";
+    readonly GN: "GN";
+    readonly GW: "GW";
+    readonly GY: "GY";
+    readonly HT: "HT";
+    readonly HM: "HM";
+    readonly VA: "VA";
+    readonly HN: "HN";
+    readonly HK: "HK";
+    readonly HU: "HU";
+    readonly IS: "IS";
+    readonly IN: "IN";
+    readonly ID: "ID";
+    readonly IR: "IR";
+    readonly IQ: "IQ";
+    readonly IE: "IE";
+    readonly IL: "IL";
+    readonly IT: "IT";
+    readonly JM: "JM";
+    readonly JP: "JP";
+    readonly JO: "JO";
+    readonly KZ: "KZ";
+    readonly KE: "KE";
+    readonly KI: "KI";
+    readonly KP: "KP";
+    readonly KR: "KR";
+    readonly KW: "KW";
+    readonly KG: "KG";
+    readonly LA: "LA";
+    readonly LV: "LV";
+    readonly LB: "LB";
+    readonly LS: "LS";
+    readonly LR: "LR";
+    readonly LY: "LY";
+    readonly LI: "LI";
+    readonly LT: "LT";
+    readonly LU: "LU";
+    readonly MO: "MO";
+    readonly MG: "MG";
+    readonly MW: "MW";
+    readonly MY: "MY";
+    readonly MV: "MV";
+    readonly ML: "ML";
+    readonly MT: "MT";
+    readonly MH: "MH";
+    readonly MQ: "MQ";
+    readonly MR: "MR";
+    readonly MU: "MU";
+    readonly YT: "YT";
+    readonly MX: "MX";
+    readonly FM: "FM";
+    readonly MD: "MD";
+    readonly MC: "MC";
+    readonly MN: "MN";
+    readonly MS: "MS";
+    readonly MA: "MA";
+    readonly MZ: "MZ";
+    readonly MM: "MM";
+    readonly NA: "NA";
+    readonly NR: "NR";
+    readonly NP: "NP";
+    readonly NL: "NL";
+    readonly NC: "NC";
+    readonly NZ: "NZ";
+    readonly NI: "NI";
+    readonly NE: "NE";
+    readonly NG: "NG";
+    readonly NU: "NU";
+    readonly NF: "NF";
+    readonly MK: "MK";
+    readonly MP: "MP";
+    readonly NO: "NO";
+    readonly OM: "OM";
+    readonly PK: "PK";
+    readonly PW: "PW";
+    readonly PS: "PS";
+    readonly PA: "PA";
+    readonly PG: "PG";
+    readonly PY: "PY";
+    readonly PE: "PE";
+    readonly PH: "PH";
+    readonly PN: "PN";
+    readonly PL: "PL";
+    readonly PT: "PT";
+    readonly PR: "PR";
+    readonly QA: "QA";
+    readonly RE: "RE";
+    readonly RO: "RO";
+    readonly RU: "RU";
+    readonly RW: "RW";
+    readonly SH: "SH";
+    readonly KN: "KN";
+    readonly LC: "LC";
+    readonly PM: "PM";
+    readonly VC: "VC";
+    readonly WS: "WS";
+    readonly SM: "SM";
+    readonly ST: "ST";
+    readonly SA: "SA";
+    readonly SN: "SN";
+    readonly SC: "SC";
+    readonly SL: "SL";
+    readonly SG: "SG";
+    readonly SK: "SK";
+    readonly SI: "SI";
+    readonly SB: "SB";
+    readonly SO: "SO";
+    readonly ZA: "ZA";
+    readonly GS: "GS";
+    readonly ES: "ES";
+    readonly LK: "LK";
+    readonly SD: "SD";
+    readonly SR: "SR";
+    readonly SJ: "SJ";
+    readonly SZ: "SZ";
+    readonly SE: "SE";
+    readonly CH: "CH";
+    readonly SY: "SY";
+    readonly TW: "TW";
+    readonly TJ: "TJ";
+    readonly TZ: "TZ";
+    readonly TH: "TH";
+    readonly TL: "TL";
+    readonly TG: "TG";
+    readonly TK: "TK";
+    readonly TO: "TO";
+    readonly TT: "TT";
+    readonly TN: "TN";
+    readonly TR: "TR";
+    readonly TM: "TM";
+    readonly TC: "TC";
+    readonly TV: "TV";
+    readonly UG: "UG";
+    readonly UA: "UA";
+    readonly AE: "AE";
+    readonly GB: "GB";
+    readonly US: "US";
+    readonly UM: "UM";
+    readonly UY: "UY";
+    readonly UZ: "UZ";
+    readonly VU: "VU";
+    readonly VE: "VE";
+    readonly VN: "VN";
+    readonly VG: "VG";
+    readonly VI: "VI";
+    readonly WF: "WF";
+    readonly EH: "EH";
+    readonly YE: "YE";
+    readonly ZM: "ZM";
+    readonly ZW: "ZW";
+    readonly AX: "AX";
+    readonly BQ: "BQ";
+    readonly CW: "CW";
+    readonly GG: "GG";
+    readonly IM: "IM";
+    readonly JE: "JE";
+    readonly ME: "ME";
+    readonly BL: "BL";
+    readonly MF: "MF";
+    readonly RS: "RS";
+    readonly SX: "SX";
+    readonly SS: "SS";
+    readonly XK: "XK";
+};
+export type Alpha2Country = (typeof Alpha2CountryCode)[keyof typeof Alpha2CountryCode];
+export {};

package/dist/src/lib/currencies.d.ts

@@ -0,0 +1 @@
+export declare function getCurrencyPrecision(currency: string): number;

package/dist/src/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './countries';
+export * from './currencies';
+export * from './interfaces';
+export * from './types';

package/dist/src/lib/interfaces.d.ts

@@ -0,0 +1,30 @@
+import { XMLBuilder, XMLParser } from 'fast-xml-parser';
+export type ISO20022MessageTypeName = `${string}.${string}`;
+export declare const ISO20022Messages: {
+    [msg: string]: ISO20022MessageTypeName;
+};
+export interface GenericISO20022Message {
+    /** serialize to XML string */
+    serialize(): string;
+    /** export to a json object that can then be serialized */
+    toJSON(): any;
+    readonly data: any;
+}
+export interface GenericISO20022MessageFactory<T extends GenericISO20022Message> {
+    /** tells what messages are supported */
+    supportedMessages(): ISO20022MessageTypeName[];
+    fromXML(xml: string): T;
+    fromJSON(json: string): T;
+    new (data: any): T;
+}
+export declare function registerISO20022Implementation(cl: GenericISO20022MessageFactory<GenericISO20022Message>): void;
+export declare function getISO20022Implementation(type: ISO20022MessageTypeName): GenericISO20022MessageFactory<GenericISO20022Message> | undefined;
+export declare class XML {
+    /**
+     * Creates and configures the XML Parser
+     *
+     * @returns {XMLParser} A configured instance of XMLParser
+     */
+    static getParser(): XMLParser;
+    static getBuilder(): XMLBuilder;
+}