Merge pull request #1525 from Adyen/add-tests-serialization

gcatanese · web-flow · commit 9d8767e59891 · 2025-07-11T10:42:23.000+02:00
Tests serialization additional data
diff --git a/src/__tests__/terminalAPISerialization.spec.ts b/src/__tests__/terminalAPISerialization.spec.ts
@@ -0,0 +1,173 @@
+import { MessageCategoryType, MessageClassType, MessageType, ObjectSerializer, TerminalApiRequest } from "../typings/terminal/models";
+
+
+describe("ObjectSerializer.serialize", () => {
+
+    it("should serialize TerminalAPIPaymentRequest", () => {
+        const terminalAPIPaymentRequest = newTerminalAPIPaymentRequest();
+
+        const json = ObjectSerializer.serialize(terminalAPIPaymentRequest, "TerminalApiRequest");
+
+        expect(json).toBeTruthy();
+        expect(json).toHaveProperty("SaleToPOIRequest");
+        expect(json.SaleToPOIRequest).toHaveProperty("MessageHeader");
+        expect(json.SaleToPOIRequest).toHaveProperty("PaymentRequest");
+
+        expect(json.SaleToPOIRequest.PaymentRequest).toHaveProperty("SaleData");
+        expect(json.SaleToPOIRequest.PaymentRequest.SaleData).toHaveProperty("SaleTransactionID");
+        expect(json.SaleToPOIRequest.PaymentRequest.SaleData.SaleTransactionID).toHaveProperty("TimeStamp");
+        expect(json.SaleToPOIRequest.PaymentRequest.SaleData).toHaveProperty("SaleToAcquirerData");
+
+        const saleToAcquirerData = json.SaleToPOIRequest.PaymentRequest.SaleData.SaleToAcquirerData;
+        // SaleToAcquirerData should be a string
+        expect(typeof(saleToAcquirerData)).toBe("string");
+        // SaleToAcquirerData should be base64 encoded
+        expect(() => Buffer.from(saleToAcquirerData, "base64").toString("utf-8")).not.toThrow();
+
+        // decode and test metadata
+        const decoded = JSON.parse(Buffer.from(saleToAcquirerData, "base64").toString("utf-8"));
+        expect(decoded).toHaveProperty("applicationInfo");
+
+        expect(decoded).toHaveProperty("metadata");
+        expect(decoded.metadata).toHaveProperty("someMetaDataKey1");
+        expect(decoded.metadata).toHaveProperty("someMetaDataKey2");
+        expect(decoded.metadata.someMetaDataKey1).toBe("YOUR_VALUE");
+        expect(decoded.metadata.someMetaDataKey2).toBe("YOUR_VALUE");
+    });
+
+    it("should serialize SaleToAcquirerData as base64 if object", () => {
+        const obj = { foo: "bar" };
+        const expected = Buffer.from(JSON.stringify(obj)).toString("base64");
+        expect(ObjectSerializer.serialize(obj, "SaleToAcquirerData")).toBe(expected);
+    });
+
+    it("should serialize TerminalAPIPaymentRequest with additionalData as JSON object", () => {
+        const terminalAPIPaymentRequest = newTerminalAPIPaymentRequestWithAdditionalDataAsJSONObject();
+
+        const json = ObjectSerializer.serialize(terminalAPIPaymentRequest, "TerminalApiRequest");
+
+        expect(json).toBeTruthy();
+        expect(json).toHaveProperty("SaleToPOIRequest");
+        expect(json.SaleToPOIRequest).toHaveProperty("MessageHeader");
+        expect(json.SaleToPOIRequest).toHaveProperty("PaymentRequest");
+
+        expect(json.SaleToPOIRequest.PaymentRequest).toHaveProperty("SaleData");
+        expect(json.SaleToPOIRequest.PaymentRequest.SaleData).toHaveProperty("SaleToAcquirerData");
+        const saleToAcquirerData = json.SaleToPOIRequest.PaymentRequest.SaleData.SaleToAcquirerData;
+        // SaleToAcquirerData should be a string
+        expect(typeof(saleToAcquirerData)).toBe("string");
+        // SaleToAcquirerData should be base64 encoded
+        expect(() => Buffer.from(saleToAcquirerData, "base64").toString("utf-8")).not.toThrow();
+
+        // decode and test metadata
+        const decoded = JSON.parse(Buffer.from(saleToAcquirerData, "base64").toString("utf-8"));
+        // verify manualCapture
+        expect(decoded).toHaveProperty("additionalData");
+        expect(decoded.additionalData).toHaveProperty("manualCapture");
+        expect(decoded.additionalData.manualCapture).toBe("true");
+    });
+
+    it("should return undefined when data is undefined", () => {
+        expect(ObjectSerializer.serialize(undefined, "string")).toBeUndefined();
+    });
+
+    it("should serialize primitive types", () => {
+        expect(ObjectSerializer.serialize("hello", "string")).toBe("hello");
+        expect(ObjectSerializer.serialize(123, "number")).toBe(123);
+        expect(ObjectSerializer.serialize(true, "boolean")).toBe(true);
+    });
+
+    it("should serialize Date to ISO string", () => {
+        const date = new Date("2024-01-01T12:00:00Z");
+        expect(ObjectSerializer.serialize(date, "Date")).toBe(date.toISOString());
+    });
+
+    it("should serialize Array of primitives", () => {
+        expect(ObjectSerializer.serialize([1, 2, 3], "Array<number>")).toEqual([1, 2, 3]);
+        expect(ObjectSerializer.serialize(["a", "b"], "Array<string>")).toEqual(["a", "b"]);
+    });
+
+    it("should serialize SaleToAcquirerData as string if already string", () => {
+        expect(ObjectSerializer.serialize("somestring", "SaleToAcquirerData")).toBe("somestring");
+    });
+
+    it("should serialize enums as is", () => {
+        expect(ObjectSerializer.serialize("Default", "AccountType")).toBe("Default");
+    });
+
+});
+
+const newTerminalAPIPaymentRequest = (): TerminalApiRequest => {
+    const messageHeader = {
+        MessageCategory: MessageCategoryType.Payment,
+        MessageClass: MessageClassType.Service,
+        MessageType: MessageType.Request,
+        POIID: "V400m-324688179",
+        ProtocolVersion: "3.0",
+        SaleID: "POSSystemID12345",
+        ServiceID: "0207111104",
+    };
+
+    const paymentRequest = {
+        PaymentTransaction: {
+            AmountsReq: {
+                Currency: "EUR",
+                RequestedAmount: 1000, 
+            },
+        },
+        SaleData: {
+            SaleTransactionID: {
+                TimeStamp: new Date().toISOString(),
+                TransactionID: "1234567890",
+            },
+            SaleToAcquirerData: {
+                applicationInfo: {
+                    merchantApplication: {
+                        version: "1.0",
+                        name: "TestApp",
+                    },
+                },
+                metadata: {
+                    someMetaDataKey1: "YOUR_VALUE",
+                    someMetaDataKey2: "YOUR_VALUE",
+                },
+            },
+        },
+    };
+
+    return { SaleToPOIRequest: {MessageHeader: messageHeader, PaymentRequest: paymentRequest} };
+};
+
+const newTerminalAPIPaymentRequestWithAdditionalDataAsJSONObject = (): TerminalApiRequest => {
+    const messageHeader = {
+        MessageCategory: MessageCategoryType.Payment,
+        MessageClass: MessageClassType.Service,
+        MessageType: MessageType.Request,
+        POIID: "V400m-324688179",
+        ProtocolVersion: "3.0",
+        SaleID: "POSSystemID12345",
+        ServiceID: "0207111104",
+    };
+
+    const paymentRequest = {
+        PaymentTransaction: {
+            AmountsReq: {
+                Currency: "EUR",
+                RequestedAmount: 1000, 
+            },
+        },
+        SaleData: {
+            SaleTransactionID: {
+                TimeStamp: new Date().toISOString(),
+                TransactionID: "1234567890",
+            },
+            SaleToAcquirerData: {
+                additionalData: {
+                    manualCapture: "true"
+                },
+            },
+        },
+    };
+
+    return { SaleToPOIRequest: {MessageHeader: messageHeader, PaymentRequest: paymentRequest} };
+};
diff --git a/src/__tests__/webhooks/notification.spec.ts b/src/__tests__/webhooks/notification.spec.ts
@@ -91,4 +91,54 @@ describe("Notification Tests", function (): void {
         }
     });
 
+    it("should return notification items with additional data as key-value map", function (): void {
+        const notificationRequestItem = new NotificationRequestItem();
+
+        notificationRequestItem.amount = { currency: "EUR", value: 1000 };
+        notificationRequestItem.pspReference = "123456789";
+        notificationRequestItem.eventCode = NotificationEnum.Authorisation;
+        notificationRequestItem.eventDate = "2023-10-01T12:00:00+00:00";
+        notificationRequestItem.merchantAccountCode = "TestMerchant";
+        notificationRequestItem.merchantReference = "TestReference";
+        notificationRequestItem.success = SuccessEnum.True;
+        notificationRequestItem.additionalData = {
+            orderId: "12345",
+            customerId: "67890"
+        };
+
+        expect(notificationRequestItem.amount).toBeDefined();
+        expect(notificationRequestItem.additionalData).toBeDefined();
+        expect(notificationRequestItem.additionalData).toHaveProperty("orderId", "12345");
+        expect(notificationRequestItem.additionalData).toHaveProperty("customerId", "67890");
+
+    });
+
+    // test additionanDalata with medata as key-value pairs prefixed with "metadata." i.e. "metadata.myKey": "myValue"
+    it("should return notification items with additional data as key-value object", function (): void {
+        const notificationRequestItem = new NotificationRequestItem();
+
+        notificationRequestItem.amount = { currency: "EUR", value: 1000 };
+        notificationRequestItem.pspReference = "123456789";
+        notificationRequestItem.eventCode = NotificationEnum.Authorisation;
+        notificationRequestItem.eventDate = "2023-10-01T12:00:00+00:00";
+        notificationRequestItem.merchantAccountCode = "TestMerchant";
+        notificationRequestItem.merchantReference = "TestReference";
+        notificationRequestItem.success = SuccessEnum.True;
+        notificationRequestItem.additionalData = {
+            orderId: "12345",
+            customerId: "67890",
+            "metadata.myKey": "myValue",
+            "metadata.anotherKey": "anotherValue"
+        };
+
+        expect(notificationRequestItem.amount).toBeDefined();
+        expect(notificationRequestItem.additionalData).toBeDefined();
+        expect(notificationRequestItem.additionalData).toHaveProperty("orderId", "12345");
+        expect(notificationRequestItem.additionalData).toHaveProperty("customerId", "67890");
+        expect(notificationRequestItem.additionalData["metadata.myKey"]).toBeDefined();
+        expect(notificationRequestItem.additionalData["metadata.anotherKey"]).toBeDefined();
+        expect(notificationRequestItem.additionalData["metadata.myKey"]).toEqual("myValue");
+        expect(notificationRequestItem.additionalData["metadata.anotherKey"]).toEqual("anotherValue");
+
+    });
 });
diff --git a/src/typings/terminal/predefinedContentHelper.ts b/src/typings/terminal/predefinedContentHelper.ts
@@ -0,0 +1,103 @@
+/**
+ * PredefinedContentHelper class to parse and manage predefined content reference IDs.
+ */
+export class PredefinedContentHelper {
+    private params: URLSearchParams;
+
+    constructor(referenceId: string) {
+        this.params = new URLSearchParams(referenceId);
+    }
+
+    /**
+     * Extracts and validates the `event` value from the ReferenceID.
+     *
+     * @returns A valid `DisplayNotificationEvent`, otherwise `null`.
+     *
+     * @example
+     * const helper = new PredefinedContentHelper("...&event=PIN_ENTERED");
+     * const event = helper.getEvent(); // "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;
+        }
+    }
+    getTransactionId(): string | null {
+        return this.params.get("TransactionID");
+    }
+
+    getTimeStamp(): string | null {
+        return this.params.get("TimeStamp");
+    }
+
+    get(key: string): string | null {
+        return this.params.get(key);
+    }
+
+    toObject(): Record<string, string> {
+        const result: Record<string, string> = {};
+        for (const [key, value] of this.params.entries()) {
+            result[key] = value;
+        }
+        return result;
+    }
+}
+
+export enum DisplayNotificationEvent {
+    TENDER_CREATED = "TENDER_CREATED",
+    CARD_INSERTED = "CARD_INSERTED",
+    CARD_PRESENTED = "CARD_PRESENTED",
+    CARD_SWIPED = "CARD_SWIPED",
+    WAIT_FOR_APP_SELECTION = "WAIT_FOR_APP_SELECTION",
+    APPLICATION_SELECTED = "APPLICATION_SELECTED",
+    ASK_SIGNATURE = "ASK_SIGNATURE",
+    CHECK_SIGNATURE = "CHECK_SIGNATURE",
+    SIGNATURE_CHECKED = "SIGNATURE_CHECKED",
+    WAIT_FOR_PIN = "WAIT_FOR_PIN",
+    PIN_ENTERED = "PIN_ENTERED",
+    PRINT_RECEIPT = "PRINT_RECEIPT",
+    RECEIPT_PRINTED = "RECEIPT_PRINTED",
+    CARD_REMOVED = "CARD_REMOVED",
+    TENDER_FINAL = "TENDER_FINAL",
+    ASK_DCC = "ASK_DCC",
+    DCC_ACCEPTED = "DCC_ACCEPTED",
+    DCC_REJECTED = "DCC_REJECTED",
+    ASK_GRATUITY = "ASK_GRATUITY",
+    GRATUITY_ENTERED = "GRATUITY_ENTERED",
+    BALANCE_QUERY_STARTED = "BALANCE_QUERY_STARTED",
+    BALANCE_QUERY_COMPLETED = "BALANCE_QUERY_COMPLETED",
+    LOAD_STARTED = "LOAD_STARTED",
+    LOAD_COMPLETED = "LOAD_COMPLETED",
+    PROVIDE_CARD_DETAILS = "PROVIDE_CARD_DETAILS",
+    CARD_DETAILS_PROVIDED = "CARD_DETAILS_PROVIDED",
+}
