@lucianpacurar/iso20022.js 0.2.7

package/dist/src/pain/001/rtp-credit-payment-initiation.d.ts

@@ -0,0 +1,118 @@
+import { Party, RTPCreditPaymentInstruction } from '../../lib/types';
+import { PaymentInitiation } from './payment-initiation';
+type AtLeastOne<T> = [T, ...T[]];
+/**
+ * Configuration for RTP Credit Payment Initiation.
+ *
+ * @property {Party} initiatingParty - The party initiating the RTP credit transfer.
+ * @property {AtLeastOne<RTPCreditPaymentInstruction>} paymentInstructions - Array containing at least one payment instruction for the RTP credit transfer.
+ * @property {string} [messageId] - Optional unique identifier for the message. If not provided, a UUID will be generated.
+ * @property {Date} [creationDate] - Optional creation date for the message. If not provided, current date will be used.
+ */
+export interface RTPCreditPaymentInitiationConfig {
+    /** The party initiating the RTP credit transfer. */
+    initiatingParty: Party;
+    /** Array containing at least one payment instruction for the RTP credit transfer. */
+    paymentInstructions: AtLeastOne<RTPCreditPaymentInstruction>;
+    /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
+    messageId?: string;
+    /** Optional creation date for the message. If not provided, current date will be used. */
+    creationDate?: Date;
+}
+/**
+ * Represents a RTP Credit Payment Initiation.
+ * This class handles the creation and serialization of RTP credit transfer messages
+ * according to the ISO20022 standard.
+ * @class
+ * @extends PaymentInitiation
+ * @param {RTPCreditPaymentInitiationConfig} config - The configuration for the RTP Credit Payment Initiation message.
+ * @example
+ * ```typescript
+ * // Creating a payment message
+ * const payment = new RTPCreditPaymentInitiation({
+ *   ...
+ * });
+ * // Uploading to fiatwebservices.com
+ * client.paymentTransfers.create(payment);
+ * // Parsing from XML
+ * const xml = '<xml>...</xml>';
+ * const parsedTransfer = RTPCreditPaymentInitiation.fromXML(xml);
+ * ```
+ * @see {@link https://docs.iso20022js.com/pain/rtpcredit} for more information.
+ */
+export declare class RTPCreditPaymentInitiation extends PaymentInitiation {
+    initiatingParty: Party;
+    paymentInstructions: AtLeastOne<RTPCreditPaymentInstruction>;
+    messageId: string;
+    creationDate: Date;
+    paymentInformationId: string;
+    private formattedPaymentSum;
+    constructor(config: RTPCreditPaymentInitiationConfig);
+    /**
+     * Calculates the sum of all payment instructions.
+     * @private
+     * @param {AtLeastOne<RTPCreditPaymentInstruction>} instructions - Array of payment instructions.
+     * @returns {string} The total sum formatted as a string with 2 decimal places.
+     * @throws {Error} If payment instructions have different currencies.
+     */
+    private sumPaymentInstructions;
+    /**
+     * Validates the payment initiation data according to SEPA requirements.
+     * @private
+     * @throws {Error} If messageId exceeds 35 characters.
+     * @throws {Error} If payment instructions have different currencies.
+     * @throws {Error} If any creditor has incomplete address information.
+     */
+    private validate;
+    /**
+     * Generates payment information for a single SEPA credit transfer instruction.
+     * @param {RTPCreditPaymentInstruction} instruction - The payment instruction.
+     * @returns {Object} The payment information object formatted according to SEPA specifications.
+     */
+    creditTransfer(instruction: RTPCreditPaymentInstruction): {
+        PmtId: {
+            InstrId: string;
+            EndToEndId: string;
+        };
+        Amt: {
+            InstdAmt: {
+                '#': string;
+                '@Ccy': "USD";
+            };
+        };
+        CdtrAgt: {
+            FinInstnId: {
+                BIC: string;
+                ClrSysMmbId?: undefined;
+            };
+        } | {
+            FinInstnId: {
+                ClrSysMmbId: {
+                    ClrSysId: {
+                        Cd: string;
+                    };
+                    MmbId: string;
+                };
+                BIC?: undefined;
+            };
+        };
+        Cdtr: any;
+        CdtrAcct: {
+            Id: {
+                Othr: {
+                    Id: string;
+                };
+            };
+        };
+        RmtInf: {
+            Ustrd: string;
+        } | undefined;
+    };
+    /**
+     * Serializes the RTP credit transfer initiation to an XML string.
+     * @returns {string} The XML representation of the RTP credit transfer initiation.
+     */
+    serialize(): string;
+    static fromXML(rawXml: string): RTPCreditPaymentInitiation;
+}
+export {};

package/dist/src/pain/001/sepa-credit-payment-initiation.d.ts

@@ -0,0 +1,126 @@
+import { ExternalCategoryPurpose, Party, SEPACreditPaymentInstruction } from "../../lib/types";
+import { PaymentInitiation } from './payment-initiation';
+type AtLeastOne<T> = [T, ...T[]];
+/**
+ * Configuration for SEPA Credit Payment Initiation.
+ *
+ * @property {Party} initiatingParty - The party initiating the SEPA credit transfer.
+ * @property {AtLeastOne<SEPACreditPaymentInstruction>} paymentInstructions - An array containing at least one payment instruction for SEPA credit transfer.
+ * @property {string} [messageId] - Optional unique identifier for the message. If not provided, a UUID will be generated.
+ * @property {Date} [creationDate] - Optional creation date for the message. If not provided, current date will be used.
+ * @property {ExternalCategoryPurpose} [categoryPurpose] - Optional category purpose code following ISO20022 ExternalCategoryPurpose1Code standard.
+ */
+export interface SEPACreditPaymentInitiationConfig {
+    /** The party initiating the SEPA credit transfer. */
+    initiatingParty: Party;
+    /** An array containing at least one payment instruction for SEPA credit transfer. */
+    paymentInstructions: AtLeastOne<SEPACreditPaymentInstruction>;
+    /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
+    messageId?: string;
+    /** Optional creation date for the message. If not provided, current date will be used. */
+    creationDate?: Date;
+    /** Optional category purpose code following ISO20022 ExternalCategoryPurpose1Code standard */
+    categoryPurpose?: ExternalCategoryPurpose;
+}
+/**
+ * Represents a SEPA Credit Payment Initiation.
+ * This class handles the creation and serialization of SEPA credit transfer messages
+ * according to the ISO20022 standard.
+ * @class
+ * @extends PaymentInitiation
+ * @param {SEPACreditPaymentInitiationConfig} config - The configuration for the SEPA Credit Payment Initiation message.
+ * @example
+ * ```typescript
+ * // Creating a SEPA payment message
+ * const payment = new SEPACreditPaymentInitiation({
+ *   // configuration options
+ * });
+ * // Uploading the payment
+ * client.paymentTransfers.create(payment);
+ * // Parsing from XML
+ * const xml = '<xml>...</xml>';
+ * const parsedTransfer = SEPACreditPaymentInitiation.fromXML(xml);
+ * ```
+ * @see {@link https://docs.iso20022js.com/pain/sepacredit} for more information.
+ */
+export declare class SEPACreditPaymentInitiation extends PaymentInitiation {
+    initiatingParty: Party;
+    messageId: string;
+    creationDate: Date;
+    paymentInstructions: AtLeastOne<SEPACreditPaymentInstruction>;
+    paymentInformationId: string;
+    categoryPurpose?: ExternalCategoryPurpose;
+    private formattedPaymentSum;
+    /**
+     * Creates an instance of SEPACreditPaymentInitiation.
+     * @param {SEPACreditPaymentInitiationConfig} config - The configuration object for the SEPA credit transfer.
+     */
+    constructor(config: SEPACreditPaymentInitiationConfig);
+    /**
+     * Calculates the sum of all payment instructions.
+     * @private
+     * @param {AtLeastOne<SEPACreditPaymentInstruction>} instructions - Array of payment instructions.
+     * @returns {string} The total sum formatted as a string with 2 decimal places.
+     * @throws {Error} If payment instructions have different currencies.
+     */
+    private sumPaymentInstructions;
+    /**
+     * Validates the payment initiation data according to SEPA requirements.
+     * @private
+     * @throws {Error} If messageId exceeds 35 characters.
+     * @throws {Error} If payment instructions have different currencies.
+     * @throws {Error} If any creditor has incomplete address information.
+     */
+    private validate;
+    private validateAllInstructionsHaveSameCurrency;
+    /**
+     * Generates payment information for a single SEPA credit transfer instruction.
+     * @param {SEPACreditPaymentInstruction} instruction - The payment instruction.
+     * @returns {Object} The payment information object formatted according to SEPA specifications.
+     */
+    creditTransfer(instruction: SEPACreditPaymentInstruction): {
+        Cdtr: any;
+        CdtrAcct: {
+            Id: {
+                IBAN: string;
+            };
+            Ccy: "EUR";
+        };
+        RmtInf: {
+            Ustrd: string;
+        } | undefined;
+        CdtrAgt?: {
+            FinInstnId: {
+                BIC: string;
+                ClrSysMmbId?: undefined;
+            };
+        } | {
+            FinInstnId: {
+                ClrSysMmbId: {
+                    ClrSysId: {
+                        Cd: string;
+                    };
+                    MmbId: string;
+                };
+                BIC?: undefined;
+            };
+        } | undefined;
+        PmtId: {
+            InstrId: string;
+            EndToEndId: string;
+        };
+        Amt: {
+            InstdAmt: {
+                '#': string;
+                '@Ccy': "EUR";
+            };
+        };
+    };
+    /**
+     * Serializes the SEPA credit transfer initiation to an XML string.
+     * @returns {string} The XML representation of the SEPA credit transfer initiation.
+     */
+    serialize(): string;
+    static fromXML(rawXml: string): SEPACreditPaymentInitiation;
+}
+export {};

package/dist/src/pain/001/swift-credit-payment-initiation.d.ts

@@ -0,0 +1,72 @@
+import { Party, SWIFTCreditPaymentInstruction } from '../../lib/types.js';
+import { PaymentInitiation } from './payment-initiation';
+type AtLeastOne<T> = [T, ...T[]];
+/**
+ * Configuration for SWIFT Credit Payment Initiation.
+ *
+ * @property {Party} initiatingParty - The party initiating the payment.
+ * @property {AtLeastOne<SWIFTCreditPaymentInstruction>} paymentInstructions - An array of payment instructions.
+ * @property {string} [messageId] - Optional unique identifier for the message. If not provided, a UUID will be generated.
+ * @property {Date} [creationDate] - Optional creation date for the message. If not provided, current date will be used.
+ */
+export interface SWIFTCreditPaymentInitiationConfig {
+    /** The party initiating the payment. */
+    initiatingParty: Party;
+    /** An array of payment instructions. */
+    paymentInstructions: AtLeastOne<SWIFTCreditPaymentInstruction>;
+    /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
+    messageId?: string;
+    /** Optional creation date for the message. If not provided, current date will be used. */
+    creationDate?: Date;
+}
+/**
+ * Represents a SWIFT Credit Payment v3 Initiation message (pain.001.001.03).
+ * @class
+ * @extends PaymentInitiation
+ * @param {SWIFTCreditPaymentInitiationConfig} config - The configuration for the SWIFT Credit Payment Initiation message.
+ * @example
+ * ```typescript
+ * // Creating a payment message
+ * const payment = new SWIFTCreditPaymentInitiation({
+ *   ...
+ * });
+ * // Uploading to fiatwebservices.com
+ * client.paymentTransfers.create(payment);
+ * // Parsing from XML
+ * const xml = '<xml>...</xml>';
+ * const parsedTransfer = SWIFTCreditPaymentInitiation.fromXML(xml);
+ * ```
+ * @see {@link https://docs.iso20022js.com/pain/sepacredit} for more information.
+ */
+export declare class SWIFTCreditPaymentInitiation extends PaymentInitiation {
+    initiatingParty: Party;
+    messageId: string;
+    creationDate: Date;
+    paymentInstructions: SWIFTCreditPaymentInstruction[];
+    paymentInformationId: string;
+    /**
+     * Creates an instance of SWIFTCreditPaymentInitiation.
+     * @param {SWIFTCreditPaymentInitiationConfig} config - The configuration object.
+     */
+    constructor(config: SWIFTCreditPaymentInitiationConfig);
+    /**
+     * Validates the payment initiation data has the information required to create a valid XML file.
+     * @private
+     * @throws {Error} If messageId exceeds 35 characters.
+     * @throws {Error} If any creditor has incomplete address information.
+     */
+    private validate;
+    /**
+     * Generates payment information for a single payment instruction.
+     * @param {SWIFTCreditPaymentInstruction} paymentInstruction - The payment instruction.
+     * @returns {Object} The credit transfer object.
+     */
+    creditTransfer(paymentInstruction: SWIFTCreditPaymentInstruction): Record<string, any>;
+    /**
+     * Serializes the payment initiation to an XML string.
+     * @returns {string} The XML representation of the payment initiation.
+     */
+    static fromXML(rawXml: string): SWIFTCreditPaymentInitiation;
+    serialize(): string;
+}
+export {};

package/dist/src/pain/002/payment-status-report.d.ts

@@ -0,0 +1,75 @@
+import { Party } from '../../lib/types';
+import { StatusInformation, PaymentStatus, OriginalGroupInformation } from './types';
+/**
+ * Configuration interface for creating a PaymentStatusReport instance.
+ */
+interface PaymentStatusReportConfig {
+    /** Unique identifier for the message */
+    messageId: string;
+    creationDate: Date;
+    initatingParty: Party;
+    originalGroupInformation: OriginalGroupInformation;
+    statusInformations: StatusInformation[];
+}
+/**
+ * Represents a Payment Status Report, containing information about the status of payments and transactions.
+ */
+export declare class PaymentStatusReport {
+    private _messageId;
+    private _creationDate;
+    private _initatingParty;
+    private _originalGroupInformation;
+    private _statusInformations;
+    /**
+     * Creates a new PaymentStatusReport instance.
+     * @param {PaymentStatusReportConfig} config - The configuration object for the PaymentStatusReport.
+     */
+    constructor(config: PaymentStatusReportConfig);
+    /**
+     * Creates a PaymentStatusReport instance from an XML string.
+     * @param {string} rawXml - The raw XML string to parse.
+     * @returns {PaymentStatusReport} A new PaymentStatusReport instance.
+     */
+    static fromXML(rawXml: string): PaymentStatusReport;
+    /**
+     * Gets the message ID of the Payment Status Report.
+     * @returns {string} The message ID.
+     */
+    get messageId(): string;
+    /**
+     * Gets the creation date of the Payment Status Report.
+     * @returns {Date} The creation date.
+     */
+    get creationDate(): Date;
+    /**
+     * Gets the initiating party of the Payment Status Report.
+     * @returns {Party} The initiating party.
+     */
+    get initatingParty(): Party;
+    /**
+     * Gets the original message ID from the original group information.
+     * @returns {string} The original message ID.
+     */
+    get originalMessageId(): string;
+    /**
+     * Gets all status information entries in the Payment Status Report.
+     * @returns {StatusInformation[]} An array of StatusInformation objects.
+     */
+    get statusInformations(): StatusInformation[];
+    /**
+     * Gets the first status information entry in the Payment Status Report.
+     * @returns {StatusInformation} The first StatusInformation object in the statuses array.
+     */
+    get firstStatusInformation(): StatusInformation;
+    /**
+     * Gets the original ID based on the type of the first status information.
+     * @returns {string} The original ID, which could be the original message ID, payment ID, or end-to-end ID.
+     */
+    get originalId(): string;
+    /**
+     * Gets the status from the first status information entry.
+     * @returns {PaymentStatus} The Status from the first status information.
+     */
+    get status(): PaymentStatus;
+}
+export {};

package/dist/src/pain/002/types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Represents the original group information in a payment status report.
+ */
+export interface OriginalGroupInformation {
+    /** The original message ID associated with the group. */
+    originalMessageId: string;
+}
+/**
+ * Represents the type of status in a payment status report.
+ */
+export type StatusType = 'group' | 'payment' | 'transaction';
+/**
+ * Represents the status codes in a payment status report.
+ * @see {@link https://www.iso20022.org/sites/default/files/2022-03/externalcodesets_4q2021_v2_1.xlsx}
+ */
+export declare const PaymentStatusCode: {
+    readonly Rejected: "RJCT";
+    readonly PartiallyAccepted: "ACCP";
+    readonly Pending: "PNDG";
+    readonly Accepted: "ACCP";
+    readonly AcceptedSettlementInProgress: "ACSP";
+    readonly AcceptedCreditSettlementCompleted: "ACSC";
+    readonly AcceptedSettlementCompleted: "ACSC";
+    readonly AcceptedTechnicalValidation: "ACTC";
+};
+export type PaymentStatus = (typeof PaymentStatusCode)[keyof typeof PaymentStatusCode];
+/**
+ * Represents the base structure for status information in a payment status report.
+ */
+export interface BaseStatusInformation {
+    /** The type of status (group, payment, or transaction). */
+    type: StatusType;
+    /** The status value. */
+    status: PaymentStatus;
+    /** Optional reason for the status. */
+    reason?: {
+        /** Optional reason code. */
+        code?: string;
+        /** Optional additional information about the reason. */
+        additionalInformation?: string;
+    };
+}
+/**
+ * Represents the status information for a group in a payment status report.
+ */
+export interface GroupStatusInformation extends BaseStatusInformation {
+    /** The type is always 'group' for GroupStatus. */
+    type: 'group';
+    /** The original message ID associated with the group. */
+    originalMessageId: string;
+}
+/**
+ * Represents the status information for a payment in a payment status report.
+ */
+export interface PaymentStatusInformation extends BaseStatusInformation {
+    /** The type is always 'payment' for PaymentStatus. */
+    type: 'payment';
+    /** The original payment ID associated with the payment. */
+    originalPaymentId: string;
+}
+/**
+ * Represents the status information for a transaction in a payment status report.
+ */
+export interface TransactionStatusInformation extends BaseStatusInformation {
+    /** The type is always 'transaction' for TransactionStatus. */
+    type: 'transaction';
+    /** The original end-to-end ID associated with the transaction. */
+    originalEndToEndId: string;
+}
+/**
+ * Represents the union type of all possible status information types in a payment status report.
+ */
+export type StatusInformation = GroupStatusInformation | PaymentStatusInformation | TransactionStatusInformation;

package/dist/src/pain/002/utils.d.ts

@@ -0,0 +1,4 @@
+import { GroupStatusInformation, PaymentStatusInformation, TransactionStatusInformation } from './types';
+export declare const parseGroupStatusInformation: (originalGroupInfAndStatus: any) => GroupStatusInformation | null;
+export declare const parsePaymentStatusInformations: (originalPaymentInfAndStatuses: any) => PaymentStatusInformation[];
+export declare const parseTransactionStatusInformations: (allTxnsInfoAndStatuses: any[]) => TransactionStatusInformation[];

package/dist/src/parseUtils.d.ts

@@ -0,0 +1,21 @@
+import { Account, AccountIdentification, Agent, MessageHeader, Party, StructuredAddress } from 'lib/types';
+import { Currency } from 'dinero.js';
+export declare const parseAccount: (account: any) => Account;
+export declare const exportAccount: (account: Account) => any;
+export declare const parseAccountIdentification: (accountId: any) => AccountIdentification;
+export declare const exportAccountIdentification: (accountId: AccountIdentification) => any;
+export declare const parseAgent: (agent: any) => Agent;
+export declare const exportAgent: (agent: Agent) => any;
+export declare const parseAmountToMinorUnits: (rawAmount: number, currency?: Currency) => number;
+export declare const exportAmountToString: (amount: number, currency?: Currency) => string;
+export declare const parseDate: (dateElement: any) => Date;
+export declare const parseParty: (party: any) => Party;
+export declare const parseRecipient: (recipient: any) => {
+    id?: string;
+    name?: string;
+    address?: StructuredAddress;
+};
+export declare const exportRecipient: (recipient: ReturnType<typeof parseRecipient>) => any;
+export declare const parseAdditionalInformation: (additionalInformation: any) => string | undefined;
+export declare const parseMessageHeader: (rawHeader: any) => MessageHeader;
+export declare const exportMessageHeader: (header: MessageHeader) => any;

package/dist/src/utils/format.d.ts

@@ -0,0 +1 @@
+export declare const sanitize: (value: string, length: 35) => string;

package/dist/test/camt/003/cash-management-get-account.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/camt/004/cash-management-return-account.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/camt/005/cash-management-get-transaction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/camt/006/cash-management-return-transaction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/camt/053/cash-management-end-of-day-report.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pain/001/ach-credit-payment-initiation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pain/001/rtp-credit-payment-initiation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pain/001/sepa-credit-payment-initiation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pain/001/swift-credit-payment-initiation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pain/002/payment-status-report.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/parseUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@lucianpacurar/iso20022.js",
+  "version": "0.2.7",
+  "readme": "README.md",
+  "description": "Library to create payment messages.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "scripts": {
+    "test": "npx jest",
+    "coverage": "npx jest --coverage",
+    "shell": "npx tsx --experimental-repl-await",
+    "build": "rollup -c",
+    "type-check": "tsc --noEmit",
+    "create-patch-version": "npm run build && npm version patch && git push origin --tags && npm publish",
+    "example:swift": "npx tsx examples/swift-credit-transfer.ts",
+    "example:sepa": "npx tsx examples/sepa-credit-transfer.ts",
+    "example:rtp": "npx tsx examples/rtp-credit-transfer.ts",
+    "example:ach": "npx tsx examples/ach-credit-transfer.ts",
+    "coveralls": "npm run coverage && coveralls report"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "keywords": [
+    "iso20022",
+    "finance",
+    "fintech",
+    "payments"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,css,scss,md}": [
+      "prettier --write"
+    ]
+  },
+  "homepage": "https://iso20022js.com",
+  "author": "svapnil",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.24.7",
+    "@faker-js/faker": "^8.4.1",
+    "@jest/globals": "^29.7.0",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/dinero.js": "^1.9.4",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.12",
+    "@types/uuid": "^10.0.0",
+    "husky": "^9.1.4",
+    "jest": "^29.7.0",
+    "libxmljs": "^1.0.11",
+    "lint-staged": "^15.2.8",
+    "prettier": "^3.3.3",
+    "rollup": "^4.19.2",
+    "rollup-plugin-dts": "^6.1.1",
+    "ts-jest": "^29.2.3",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.3",
+    "tsx": "^4.20.5",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "decimal.js": "^10.6.0",
+    "dinero.js": "^1.9.1",
+    "fast-xml-parser": "^4.4.1",
+    "uuid": "^10.0.0"
+  }
+}