add support for originalCreditorId

Author: Julien Alric

README.md

@@ -65,6 +65,7 @@ info.creditorIBAN = "DE87123456781234567890";
 info.creditorBIC = "XMPLDEM0XXX";
 info.creditorName = "Example LLC";
 info.creditorId = "DE98ZZZ09999999999";
+info.originalCreditorId = "IT66ZZZA1B2C3D4E5F6G7H8"; //optional
 info.batchBooking = true; //optional
 doc.addPaymentInfo(info);
 

examples/example.js

@@ -16,6 +16,7 @@ info.creditorIBAN = 'DE87123456781234567890';
 info.creditorBIC = 'XMPLDEM0XXX';
 info.creditorName = 'Example LLC';
 info.creditorId = 'DE98ZZZ09999999999';
+info.originalCreditorId = 'IT66ZZZA1B2C3D4E5F6G7H8';
 doc.addPaymentInfo(info);
 
 var tx = info.createTransaction();

lib/sepa.js

@@ -287,6 +287,9 @@
     /** Id assigned to the creditor */
     creditorId: '',
 
+    /** Original creditor id (optional, for creditor id migrations) */
+    originalCreditorId: null,
+
     /** Name, Address, IBAN and BIC of the creditor */
     creditorName: '',
     creditorStreet: null,
@@ -367,6 +370,10 @@
         assert_cid(this[pullFrom + 'Id'], pullFrom + 'Id');
       }
 
+      if (this.originalCreditorId) {
+        assert_cid(this.originalCreditorId, 'originalCreditorId');
+      }
+
       assert_length(this[pullFrom + 'Name'], null, 70, pullFrom + 'Name');
       assert_length(this[pullFrom + 'Street'], null, 70, pullFrom + 'Street');
       assert_length(this[pullFrom + 'City'], null, 70, pullFrom + 'City');
@@ -453,6 +460,12 @@
         var creditorScheme = n(pmtInf, 'CdtrSchmeId', 'Id', 'PrvtId', 'Othr');
         r(creditorScheme, 'Id', this.creditorId);
         r(creditorScheme, 'SchmeNm', 'Prtry', 'SEPA');
+
+        if (this.originalCreditorId) {
+          var originalCreditorScheme = n(pmtInf, 'OrgnlCdtrSchmeId', 'Id', 'PrvtId', 'Othr');
+          r(originalCreditorScheme, 'Id', this.originalCreditorId);
+          r(originalCreditorScheme, 'SchmeNm', 'Prtry', 'SEPA');
+        }
       }
 
       for (var i = 0, l = this._payments.length; i < l; ++i) {

lib/sepa.test.js

@@ -3,6 +3,7 @@ var xpath = require('xpath');
 
 // The following debtor id is provided by German Bundesbank for testing purposes.
 const A_VALID_CREDITOR_ID = 'DE98ZZZ09999999999';
+const ANOTHER_VALID_CREDITOR_ID = 'IT66ZZZA1B2C3D4E5F6G7H8';
 
 const A_VALID_IBAN = 'DE43500105178994141576';
 
@@ -336,14 +337,15 @@ describe('xml generation for transfer documents', () => {
 
 describe('xml generation for direct debit documents', () => {
   const PAIN_FOR_DIRECT_DEBIT = 'pain.008.001.08';
-  function validDirectDebitDocument({creditorId=A_VALID_CREDITOR_ID}) {
+  function validDirectDebitDocument({creditorId=A_VALID_CREDITOR_ID, originalCreditorId=null}) {
     var doc = new SEPA.Document(PAIN_FOR_DIRECT_DEBIT);
     doc.grpHdr.created = new Date();
 
     var info = doc.createPaymentInfo();
     info.collectionDate = new Date();
     info.creditorIBAN = A_VALID_IBAN;
     info.creditorId = creditorId;
+    info.originalCreditorId = originalCreditorId;
     doc.addPaymentInfo(info);
 
     var tx = info.createTransaction();
@@ -388,6 +390,39 @@ describe('xml generation for direct debit documents', () => {
     expect(creditorId).toBeUndefined();
   });
 
+  test('includes original creditor id when set', () => {
+    // GIVEN
+    const doc = validDirectDebitDocument({originalCreditorId: ANOTHER_VALID_CREDITOR_ID});
+
+    // WHEN
+    const dom = doc.toXML();
+
+    // THEN
+    const select = xpath.useNamespaces({
+      p: `urn:iso:std:iso:20022:tech:xsd:${PAIN_FOR_DIRECT_DEBIT}`,
+    });
+
+    const originalCreditorId = select('/p:Document/p:CstmrDrctDbtInitn/p:PmtInf/p:OrgnlCdtrSchmeId/p:Id/p:PrvtId/p:Othr/p:Id', dom, true);
+    expect(originalCreditorId).not.toBeUndefined();
+    expect(originalCreditorId.textContent).toBe(ANOTHER_VALID_CREDITOR_ID);
+  });
+
+  test('works without setting original creditor id', () => {
+    // GIVEN
+    const doc = validDirectDebitDocument({originalCreditorId: null});
+
+    // WHEN
+    const dom = doc.toXML();
+
+    // THEN
+    const select = xpath.useNamespaces({
+      p: `urn:iso:std:iso:20022:tech:xsd:${PAIN_FOR_DIRECT_DEBIT}`,
+    });
+
+    const originalCreditorId = select('/p:Document/p:CstmrDrctDbtInitn/p:PmtInf/p:OrgnlCdtrSchmeId', dom, true);
+    expect(originalCreditorId).toBeUndefined();
+  });
+
   test('serialized document starts with proper xml declaration', () => {
     // GIVEN
     const doc = validDirectDebitDocument({});

types/sepa.d.ts

@@ -168,6 +168,8 @@ declare module "sepa" {
 
     /** Id assigned to the creditor */
     creditorId: string;
+    /** Original creditor id (optional, for creditor id migrations) */
+    originalCreditorId: string | null;
     /** Name of the creditor */
     creditorName: string;
     /** Street of the creditor */