Merge pull request #1505 from Adyen/typescript-openapi-generator

WIP Typescript OpenAPI Generator v7

Author: gcatanese

.eslintignore

@@ -1,2 +1 @@
-/src/typings/**/*.ts
 /examples

.eslintrc.js

@@ -1,46 +1,49 @@
-const path = require('path');
+const path = require("path");
 
 module.exports = {
   parser: "@typescript-eslint/parser",
   plugins: ["@typescript-eslint", "unused-imports"],
   env: {
     es6: true,
-    node: true
+    node: true,
   },
   parserOptions: {
     ecmaVersion: 6,
     sourceType: "module",
     ecmaFeatures: {
-      modules: true
+      modules: true,
     },
     project: path.resolve(__dirname, "./tsconfig.json"),
-    tsconfigRootDir: __dirname
-  },
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  rules: {
-    quotes: ["error", "double"],
-    semi: ["error", "always"],
-    "@typescript-eslint/no-non-null-assertion": 0,
-    "@typescript-eslint/ban-types": [
-      "error",
-      {
-        "extendDefaults": true,
-        "types": {
-          "{}": false
-        }
-      }
-    ],
-    "unused-imports/no-unused-imports": "warn",
+    tsconfigRootDir: __dirname,
   },
   overrides: [
+    // Override for src/typings/**/*.ts — only unused-imports
     {
-      files: ["*.ts"],
+      files: ["src/typings/**/*.ts"],
       rules: {
-        "no-dupe-class-members": "off"
-      }
-    }
-  ]
-}
+        "unused-imports/no-unused-imports": "warn",
+      },
+    },
+    // Default rule set for everything else
+    {
+      files: ["*.ts", "**/*.ts"],
+      excludedFiles: ["src/typings/**/*.ts"],
+      rules: {
+        quotes: ["error", "double"],
+        semi: ["error", "always"],
+        "@typescript-eslint/no-non-null-assertion": 0,
+        "@typescript-eslint/ban-types": [
+          "error",
+          {
+            extendDefaults: true,
+            types: {
+              "{}": false,
+            },
+          },
+        ],
+        "unused-imports/no-unused-imports": "warn",
+        "no-dupe-class-members": "off",
+      },
+    },
+  ],
+};

src/__mocks__/checkout/payments3DS2NativeAction.ts

@@ -0,0 +1,32 @@
+/*
+ *                       ######
+ *                       ######
+ * ############    ####( ######  #####. ######  ############   ############
+ * #############  #####( ######  #####. ######  #############  #############
+ *        ######  #####( ######  #####. ######  #####  ######  #####  ######
+ * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
+ * ###### ######  #####( ######  #####. ######  #####          #####  ######
+ * #############  #############  #############  #############  #####  ######
+ *  ############   ############  #############   ############  #####  ######
+ *                                      ######
+ *                               #############
+ *                               ############
+ * Adyen NodeJS API Library
+ * Copyright (c) 2020 Adyen B.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ */
+
+/* tslint:disable */
+export const payments3DS2NativeAction = JSON.stringify({
+    action:{
+        type:"threeDS2",
+        subtype: "fingerprint",
+        paymentData:"Ab02b4c0!BQABAgCuZFJrQOjSslzt+...",
+        paymentMethodType:"scheme",
+        authorisationToken : "Ab02b4c0!BQABAgAvrX03p...",
+        token:"eyJ0aHJlZURTTWV0aG9kTm90aWZpY..."
+    },
+    pspReference: "JLCMPCQ8HXSKGK82",
+    resultCode:"IdentifyShopper",  
+}, null, 2);

src/__mocks__/checkout/paymentsRedirectAction.ts

@@ -0,0 +1,45 @@
+/*
+ *                       ######
+ *                       ######
+ * ############    ####( ######  #####. ######  ############   ############
+ * #############  #####( ######  #####. ######  #############  #############
+ *        ######  #####( ######  #####. ######  #####  ######  #####  ######
+ * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
+ * ###### ######  #####( ######  #####. ######  #####          #####  ######
+ * #############  #############  #############  #############  #####  ######
+ *  ############   ############  #############   ############  #####  ######
+ *                                      ######
+ *                               #############
+ *                               ############
+ * Adyen NodeJS API Library
+ * Copyright (c) 2020 Adyen B.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ */
+
+/* tslint:disable */
+export const paymentsRedirectAction = JSON.stringify({
+    additionalData: {
+        "cardSummary": "5454",
+        "threeds2.threeDS2ResponseData.messageVersion": "2.1.0",
+        "threeds2.threeDS2Token": "R5CZ2NWPJTGV9D82...",
+        "threeds2.threeDSServerTransID": "8835538461311270...",
+        "cardBin": "545454",
+        "threeds2.cardEnrolled": "true",
+        "paymentMethod": "mc",
+        "cardPaymentMethod": "mc",
+        "fundingSource": "CREDIT",
+        "merchantReference": "Your order number",
+        "issuerBin": "54545454",
+        "threeds2.threeDSMethodURL": "https://pal-test.adyen.com/threeds2simulator/acs/startMethod.shtml",
+        "cardIssuingCountry": "PL"
+    },
+    pspReference: "JLCMPCQ8HXSKGK82",
+    resultCode: "RedirectShopper",
+    action: {
+        paymentMethodType: "scheme",
+        url: "https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect...",
+        method: "GET",
+        type: "redirect"
+    }
+}, null, 2);

src/__tests__/binLookup.spec.ts

@@ -1,6 +1,6 @@
 import nock from "nock";
 import { createClient } from "../__mocks__/base";
-import BinLookup from "../services/binLookupApi";
+import { BinLookupAPI } from "../services";
 import Client from "../client";
 import HttpClientException from "../httpClient/httpClientException";
 import { binlookup } from "../typings";
@@ -15,15 +15,15 @@ const threeDSAvailabilitySuccess = {
 };
 
 let client: Client;
-let binLookupService: BinLookup;
+let binLookupService: BinLookupAPI;
 let scope: nock.Scope;
 
 beforeEach((): void => {
     if (!nock.isActive()) {
         nock.activate();
     }
     client = createClient();
-    binLookupService = new BinLookup(client);
+    binLookupService = new BinLookupAPI(client);
     scope = nock("https://pal-test.adyen.com/pal/servlet/BinLookup/v54");
 });
 
@@ -42,7 +42,7 @@ describe("Bin Lookup", function (): void {
         scope.post("/get3dsAvailability")
             .reply(200, threeDSAvailabilitySuccess);
 
-        const response = await binLookupService.get3dsAvailability(threeDSAvailabilityRequest);
+        const response = await binLookupService.BinLookupApi.get3dsAvailability(threeDSAvailabilityRequest);
 
         expect(response).toEqual< binlookup.ThreeDSAvailabilityResponse>(threeDSAvailabilitySuccess);
     });
@@ -58,7 +58,7 @@ describe("Bin Lookup", function (): void {
             .reply(403, JSON.stringify({status: 403, message: "Invalid Merchant Account", errorCode: "901", errorType: "security"}));
 
         try {
-            await binLookupService.get3dsAvailability(threeDSAvailabilityRequest as unknown as  binlookup.ThreeDSAvailabilityRequest);
+            await binLookupService.BinLookupApi.get3dsAvailability(threeDSAvailabilityRequest as unknown as  binlookup.ThreeDSAvailabilityRequest);
             fail("Expected request to fail");
         } catch (e) {
             expect(e instanceof HttpClientException).toBeTruthy();
@@ -101,7 +101,7 @@ describe("Bin Lookup", function (): void {
         scope.post("/getCostEstimate")
             .reply(200, expected);
 
-        const response = await binLookupService.getCostEstimate(costEstimateRequest);
+        const response = await binLookupService.BinLookupApi.getCostEstimate(costEstimateRequest);
 
         expect(response).toEqual(expected);
     });

src/__tests__/checkout.spec.ts

@@ -2,6 +2,7 @@ import nock from "nock";
 import {createClient} from "../__mocks__/base";
 import {paymentMethodsSuccess} from "../__mocks__/checkout/paymentMethodsSuccess";
 import {paymentsSuccess} from "../__mocks__/checkout/paymentsSuccess";
+import {paymentsRedirectAction} from "../__mocks__/checkout/paymentsRedirectAction";
 import {paymentDetailsSuccess} from "../__mocks__/checkout/paymentsDetailsSuccess";
 // import {paymentSessionSuccess} from "../__mocks__/checkout/paymentSessionSucess";
 import {originKeysSuccess} from "../__mocks__/checkout/originkeysSuccess";
@@ -14,6 +15,7 @@ import HttpClientException from "../httpClient/httpClientException";
 import { checkout } from "../typings";
 import { IRequest } from "../typings/requestOptions";
 import { SessionResultResponse } from "../typings/checkout/sessionResultResponse";
+import { payments3DS2NativeAction } from "../__mocks__/checkout/payments3DS2NativeAction";
 
 const merchantAccount = process.env.ADYEN_MERCHANT!;
 const reference = "Your order number";
@@ -79,8 +81,11 @@ function getPaymentLinkSuccess(expiresAt: Date): checkout.PaymentLinkResponse {
         url: "PaymentLinkResponse.url",
         id: "mocked_id",
         merchantAccount,
-        status: checkout.PaymentLinkResponse.StatusEnum.Active
-    };
+        status: checkout.PaymentLinkResponse.StatusEnum.Active,
+        requiredShopperFields: [
+            checkout.PaymentLinkResponse.RequiredShopperFieldsEnum.BillingAddress,
+            checkout.PaymentLinkResponse.RequiredShopperFieldsEnum.ShopperEmail]
+        };
 }
 
 function createPaymentLinkRequest(): checkout.PaymentLinkRequest {
@@ -108,7 +113,10 @@ function createPaymentLinkRequest(): checkout.PaymentLinkRequest {
             country: "BR",
             stateOrProvince: "SP"
         },
-        reference
+        reference,
+        requiredShopperFields: [
+            checkout.PaymentLinkRequest.RequiredShopperFieldsEnum.BillingAddress,
+            checkout.PaymentLinkRequest.RequiredShopperFieldsEnum.ShopperEmail]
     };
 }
 
@@ -154,7 +162,7 @@ describe("Checkout", (): void => {
             "returnUrl": "https://your-company.com/...",
             "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
         }`);
-        const paymentRequest: checkout.PaymentRequest = await checkout.ObjectSerializer.deserialize(requestJson,"PaymentRequest");
+        const paymentRequest: checkout.PaymentRequest = await checkout.ObjectSerializer.deserialize(requestJson, "PaymentRequest", "");
         expect(paymentRequest.returnUrl).toEqual("https://your-company.com/...");
         expect(paymentRequest.amount.value).toBe(1000);
         const paymentMethodDetails: checkout.ApplePayDetails = paymentRequest.paymentMethod as checkout.ApplePayDetails;
@@ -239,7 +247,6 @@ describe("Checkout", (): void => {
 
     });
 
-
     test("should make a payment.", async (): Promise<void> => {
         scope.post("/payments")
             .reply(200, paymentsSuccess);
@@ -311,7 +318,7 @@ describe("Checkout", (): void => {
         }
     });
 
-    test("should have valid payment link", async (): Promise<void> => {
+    test("should create valid payment link", async (): Promise<void> => {
         const expiresAt = "2019-12-17T10:05:29Z";
         const paymentLinkSuccess: checkout.PaymentLinkResponse = getPaymentLinkSuccess(new Date(expiresAt));
 
@@ -321,6 +328,28 @@ describe("Checkout", (): void => {
         expect(paymentSuccessLinkResponse).toBeTruthy();
     });
 
+    test("should create valid payment link with installmentOptions", async (): Promise<void> => {
+        const expiresAt = "2019-12-17T10:05:29Z";
+        const paymentLinkSuccess: checkout.PaymentLinkResponse = getPaymentLinkSuccess(new Date(expiresAt));
+
+        scope.post("/paymentLinks").reply(200, paymentLinkSuccess);
+
+        const request : checkout.PaymentLinkRequest = createPaymentLinkRequest();
+        request.installmentOptions = {
+            card: {
+                plans: [
+                    checkout.CheckoutSessionInstallmentOption.PlansEnum.Bonus,
+                    checkout.CheckoutSessionInstallmentOption.PlansEnum.BuynowPaylater
+                ]
+            }
+        };
+        const paymentSuccessLinkResponse = await checkoutService.PaymentLinksApi.paymentLinks(request);
+        expect(paymentSuccessLinkResponse).toBeTruthy();
+        expect(paymentSuccessLinkResponse.id).toBeTruthy();
+        expect(paymentSuccessLinkResponse.id).toBe("mocked_id");
+        expect(paymentSuccessLinkResponse.requiredShopperFields?.length).toBe(2);
+    });
+
     test("should get payment link", async (): Promise<void> => {
         const expiresAt = "2019-12-17T10:05:29Z";
         const paymentLinkSuccess: checkout.PaymentLinkResponse = getPaymentLinkSuccess(new Date(expiresAt));
@@ -401,6 +430,46 @@ describe("Checkout", (): void => {
         expect(paymentsResponse.additionalData).toBeTruthy();
     });
 
+    test("should return shopper redirect with a card payment.", async (): Promise<void> => {
+        scope.post("/payments")
+            .reply(200, paymentsRedirectAction);
+
+        const paymentsRequest: checkout.PaymentRequest = createPaymentsCheckoutRequest();
+        const paymentsResponse: checkout.PaymentResponse = await checkoutService.PaymentsApi.payments(paymentsRequest);
+
+        expect(paymentsResponse.pspReference).toBeTruthy();
+        expect(paymentsResponse.resultCode).toBeTruthy();
+        expect(paymentsResponse.resultCode).toEqual("RedirectShopper");
+        expect(paymentsResponse.action).toBeTruthy();
+        // check type redirect
+        expect(paymentsResponse.action?.type).toBeTruthy();
+        expect(paymentsResponse.action?.type).toEqual("redirect");
+        // TODO check action is polymorphic
+        //expect(paymentsResponse.action).toBeInstanceOf(CheckoutRedirectAction); 
+        //expect(paymentsResponse.action?.url).toBe("https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect...");
+
+    });
+
+    test("should return Native 3DS2 with a card payment.", async (): Promise<void> => {
+        scope.post("/payments")
+            .reply(200, payments3DS2NativeAction);
+
+        const paymentsRequest: checkout.PaymentRequest = createPaymentsCheckoutRequest();
+        const paymentsResponse: checkout.PaymentResponse = await checkoutService.PaymentsApi.payments(paymentsRequest);
+
+        expect(paymentsResponse.pspReference).toBeTruthy();
+        expect(paymentsResponse.resultCode).toBeTruthy();
+        expect(paymentsResponse.resultCode).toEqual("IdentifyShopper");
+        expect(paymentsResponse.action).toBeTruthy();
+        // check type threeDS2
+        expect(paymentsResponse.action?.type).toBeTruthy();
+        expect(paymentsResponse.action?.type).toEqual("threeDS2");
+        // TODO check action is polymorphic
+        //expect(paymentsResponse.action).toBeInstanceOf(CheckoutThreeDS2Action); 
+        //expect(paymentsResponse.action?.subtype).toEqual("threeDS2");
+
+    });
+
     test("should get origin keys", async (): Promise<void> => {
         const checkoutUtility = new CheckoutAPI(client);
         const originKeysRequest: checkout.UtilityRequest = {
@@ -508,6 +577,25 @@ describe("Checkout", (): void => {
         expect(sessionsResponse.expiresAt.getFullYear()).toBeGreaterThan(0);
     });
 
+    test("should create a session with installmentOptions.", async (): Promise<void> => {
+        scope.post("/sessions")
+            .reply(200, sessionsSuccess);
+
+        const sessionsRequest: checkout.CreateCheckoutSessionRequest = createSessionRequest();
+        sessionsRequest.installmentOptions = {
+            card: {
+                plans: [
+                    checkout.CheckoutSessionInstallmentOption.PlansEnum.Bonus,
+                    checkout.CheckoutSessionInstallmentOption.PlansEnum.BuynowPaylater
+                ]
+            }
+        };
+        const sessionsResponse: checkout.CreateCheckoutSessionResponse = await checkoutService.PaymentsApi.sessions(sessionsRequest);
+        expect(sessionsResponse.sessionData).toBeTruthy();
+        expect(sessionsResponse.expiresAt).toBeInstanceOf(Date);
+        expect(sessionsResponse.expiresAt.getFullYear()).toBeGreaterThan(0);
+    });
+
     test("Should get card details", async (): Promise<void> => {
         scope.post("/cardDetails")
             .reply(200, {