Merge pull request #1527 from Adyen/predefinedcontent-referenceid-helper

TerminalAPI: PredefinedContentHelper for managing Display Events

Author: gcatanese

src/__tests__/terminalAPIPredefinedContentHelper.spec.ts

@@ -0,0 +1,46 @@
+import { PredefinedContentHelper, DisplayNotificationEvent } from "../typings/terminal/predefinedContentHelper";
+
+describe("PredefinedContentHelper", () => {
+    it("should extract a valid event", () => {
+        
+        const ReferenceID = "TransactionID=oLkO001517998574000&TimeStamp=2018-02-07T10%3a16%3a14.000Z&event=PIN_ENTERED";
+        
+        const helper = new PredefinedContentHelper(ReferenceID);
+        expect(helper.getEvent()).toBe(DisplayNotificationEvent.PIN_ENTERED);
+    });
+
+    it("should return null for an invalid event", () => {
+        const helper = new PredefinedContentHelper("event=INVALID_EVENT");
+        expect(helper.getEvent()).toBeNull();
+    });
+
+    it("should extract TransactionID", () => {
+        const helper = new PredefinedContentHelper("TransactionID=12345&TimeStamp=2018-02-07T10%3a16%3a14.000Z&event=PIN_ENTERED");
+        expect(helper.getTransactionId()).toBe("12345");
+    });
+
+    it("should extract query parameter", () => {
+        const helper = new PredefinedContentHelper("TimeStamp=2024-07-11T12:00:00Z");
+        expect(helper.getTimeStamp()).toBe("2024-07-11T12:00:00Z");
+    });
+
+    it("should extract arbitrary key", () => {
+        const helper = new PredefinedContentHelper("foo=bar&baz=qux");
+        expect(helper.get("foo")).toBe("bar");
+        expect(helper.get("baz")).toBe("qux");
+        expect(helper.get("missing")).toBeNull();
+    });
+
+    it("should convert params to object", () => {
+        const helper = new PredefinedContentHelper("a=1&b=2&event=WAIT_FOR_PIN");
+        expect(helper.toObject()).toEqual({ a: "1", b: "2", event: "WAIT_FOR_PIN" });
+    });
+
+    it("should handle empty referenceId", () => {
+        const helper = new PredefinedContentHelper("");
+        expect(helper.getEvent()).toBeNull();
+        expect(helper.getTransactionId()).toBeNull();
+        expect(helper.getTimeStamp()).toBeNull();
+        expect(helper.toObject()).toEqual({});
+    });
+});

src/__tests__/terminalCloudAPI.spec.ts

@@ -4,7 +4,7 @@ import { asyncRes } from "../__mocks__/terminalApi/async";
 import { syncRefund, syncRes, syncResEventNotification, syncResEventNotificationWithAdditionalAttributes, syncResEventNotificationWithUnknownEnum } from "../__mocks__/terminalApi/sync";
 import Client from "../client";
 import TerminalCloudAPI from "../services/terminalCloudAPI";
-import { terminal} from "../typings";
+import { terminal } from "../typings";
 
 let client: Client;
 let terminalCloudAPI: TerminalCloudAPI;

src/typings/terminal/models.ts

@@ -265,6 +265,8 @@ export * from "./transmitResponse";
 export * from "./uTMCoordinates";
 export * from "./unitOfMeasureType";
 export * from "./versionType";
+// helpers
+export * from "./predefinedContentHelper";
 
 import { AbortRequest } from "./abortRequest";
 import { AccountType } from "./accountType";

src/typings/terminal/predefinedContentHelper.ts

@@ -15,43 +15,17 @@ export class PredefinedContentHelper {
      *
      * @example
      * const helper = new PredefinedContentHelper("...&event=PIN_ENTERED");
-     * const event = helper.getEvent(); // "PIN_ENTERED" or null
+     * const event = helper.getEvent(); // DisplayNotificationEvent.PIN_ENTERED or null
      */
     getEvent(): DisplayNotificationEvent | null {
         const event = this.params.get("event");
 
-        switch (event) {
-            case "TENDER_CREATED":
-            case "CARD_INSERTED":
-            case "CARD_PRESENTED":
-            case "CARD_SWIPED":
-            case "WAIT_FOR_APP_SELECTION":
-            case "APPLICATION_SELECTED":
-            case "ASK_SIGNATURE":
-            case "CHECK_SIGNATURE":
-            case "SIGNATURE_CHECKED":
-            case "WAIT_FOR_PIN":
-            case "PIN_ENTERED":
-            case "PRINT_RECEIPT":
-            case "RECEIPT_PRINTED":
-            case "CARD_REMOVED":
-            case "TENDER_FINAL":
-            case "ASK_DCC":
-            case "DCC_ACCEPTED":
-            case "DCC_REJECTED":
-            case "ASK_GRATUITY":
-            case "GRATUITY_ENTERED":
-            case "BALANCE_QUERY_STARTED":
-            case "BALANCE_QUERY_COMPLETED":
-            case "LOAD_STARTED":
-            case "LOAD_COMPLETED":
-            case "PROVIDE_CARD_DETAILS":
-            case "CARD_DETAILS_PROVIDED":
-                return event as DisplayNotificationEvent;
-            default:
-                return null;
+        if (event && Object.values(DisplayNotificationEvent).includes(event as DisplayNotificationEvent)) {
+            return event as DisplayNotificationEvent;
         }
+        return null;
     }
+
     getTransactionId(): string | null {
         return this.params.get("TransactionID");
     }
@@ -65,14 +39,11 @@ export class PredefinedContentHelper {
     }
 
     toObject(): Record<string, string> {
-        const result: Record<string, string> = {};
-        for (const [key, value] of this.params.entries()) {
-            result[key] = value;
-        }
-        return result;
+        return Object.fromEntries(this.params);
     }
 }
 
+// Supported events for display notifications
 export enum DisplayNotificationEvent {
     TENDER_CREATED = "TENDER_CREATED",
     CARD_INSERTED = "CARD_INSERTED",