Merge pull request #689 from Adyen/develop

Release 8.1.0

Author: wboereboom

README.md

@@ -8,24 +8,28 @@
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/Adyen/adyen-node-api-library.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Adyen/adyen-node-api-library/alerts/)
 [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Adyen/adyen-node-api-library.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Adyen/adyen-node-api-library/context:javascript)
 
-The Adyen API Library for NodeJS enables you to work with Adyen APIs.
+This is the officially supported NodeJS library for using Adyen's APIs.
 
 ## Integration
 The Library supports all APIs under the following services:
 
-* [x] checkout
-* [x] checkout utility
-* [x] payments
-* [x] modifications
-* [x] payouts
-* [x] recurring
-* [x] notifications
-* [x] BIN lookup
-* [x] Terminal API
+* [Checkout API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/overview): Our latest integration for accepting online payments. Current supported version: **v67**
+* [Payments API](https://docs.adyen.com/api-explorer/#/Payment/v64/overview): Our classic integration for online payments. Current supported version: **v64**
+* [Recurring API](https://docs.adyen.com/api-explorer/#/Recurring/v49/overview): Endpoints for managing saved payment details. Current supported version: **v49**
+* [Payouts API](https://docs.adyen.com/api-explorer/#/Payout/v64/overview): Endpoints for sending funds to your customers. Current supported version: **v64**
+* [Platforms APIs](https://docs.adyen.com/platforms/api): Set of APIs when using Adyen for Platforms. 
+  * [Account API](https://docs.adyen.com/api-explorer/#/Account/v6/overview) Current supported version: **v6**
+  * [Fund API](https://docs.adyen.com/api-explorer/#/Fund/v6/overview) Current supported version: **v6**
+  * [Notification Configuration API](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/v6/overview) Current supported version: **v6**
+* [Local/Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/terminal-api-reference): Our point-of-sale integration.
+* [BIN lookup API](https://docs.adyen.com/api-explorer/#/BinLookup/v50/overview): The BIN Lookup API provides endpoints for retrieving information based on a given BIN.  Current supported version: **v50**
 
-## Requirements
+For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 
-* Node 10 or higher
+## Prerequisites
+-   [Adyen test account](https://docs.adyen.com/get-started-with-adyen)
+-   [API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). For testing, your API credential needs to have the [API PCI Payments role](https://docs.adyen.com/development-resources/api-credentials#roles).
+-   Node 10 or higher
 
 ## Installation
 
@@ -37,12 +41,28 @@ You can use NPM to add our library to your project
 npm install --save @adyen/api-library
 ```
 
-## Documentation
-* https://docs.adyen.com/developers/development-resources/libraries
-* https://docs.adyen.com/developers/checkout
-
-## HTTP Client Configuration
-
+Alternatively, you can download the [release on GitHub](https://github.com/Adyen/adyen-node-api-library/releases).
+
+
+## Using the library
+
+### General use with API key
+ 
+Set up the client as a singleton resource; you can then use it to create service objects for the API calls that you make to Adyen:
+ 
+```typescript
+    const client = new Client({apiKey: "YOUR_API_KEY", environment: "TEST"});
+``` 
+### General use with API key for live environment
+ ```typescript
+     const client = new Client({apiKey: "YOUR_API_KEY", environment: "LIVE"});
+ ``` 
+### General use with basic auth
+```typescript
+    const client = new Client({username: "YOUR_USERNAME", password: "YOUR_PASSWORD", environment: "TEST"});
+``` 
+ 
+### Custom HTTP Client Configuration
 By default, NodeJS [https](https://nodejs.org/api/https.html) will be used to submit requests to the API. But you can change that by injecting your own HttpClient on your client instance. In the example below, we use `axios`:
 
 ```javascript
@@ -89,20 +109,23 @@ client.httpClient = httpClient;
 ...
 ```
 
-## Testing
-`$ npm run test`
-
-## Support
-If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420).
+### Example integration
+ 
+For a closer look at how our PHP library works, clone our [example integration](https://github.com/adyen-examples/adyen-node-online-payments). This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.
 
-## Contributing
+## Contributing 
 We strongly encourage you to join us in contributing to this repository so everyone can benefit from:
 * New features and functionality
 * Resolved bug fixes and issues
 * Any general improvements
 
-Read our [**contribution guidelines**](CONTRIBUTING.md) to find out how.
+Read our [**contribution guidelines**](CONTRIBUTING.md) to find out how to create a pull request.
+
+## Support
+If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/).
 
 ## Licence
+This repository is available under the [MIT license](LICENSE).
 
-MIT license. For more information, see the LICENSE file.
+## See also
+* [example integration](https://github.com/adyen-examples/adyen-node-online-payments)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/api-library",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
@@ -41,7 +41,7 @@
     "@typescript-eslint/parser": "2.34.0",
     "acorn": "^8.0.1",
     "coveralls": "3.1.0",
-    "dotenv": "^8.2.0",
+    "dotenv": "^9.0.0",
     "eslint": "6.8.0",
     "jest": "25.5.4",
     "jest-ts-auto-mock": "^2.0.0",

package.json

@@ -0,0 +1,28 @@
+/*
+ *                       ######
+ *                       ######
+ * ############    ####( ######  #####. ######  ############   ############
+ * #############  #####( ######  #####. ######  #############  #############
+ *        ######  #####( ######  #####. ######  #####  ######  #####  ######
+ * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
+ * ###### ######  #####( ######  #####. ######  #####          #####  ######
+ * #############  #############  #############  #############  #####  ######
+ *  ############   ############  #############   ############  #####  ######
+ *                                      ######
+ *                               #############
+ *                               ############
+ * 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.
+ */
+
+export const notifyShopperSuccess = {
+    "message": "Request Processed Successfully",
+    "resultCode": "Success",
+    "shopperNotificationReference": "9915003646742627",
+    "storedPaymentMethodId": "8415995487234100",
+    "pspReference": "9915003646742627",
+    "reference": "Example reference",
+    "displayedReference": "Example displayed reference"
+};

src/__mocks__/recurring/notifyShopperSuccess.ts

@@ -61,8 +61,8 @@ function createAmountObject(currency: string, value: number): Amount {
 function createPaymentsDetailsRequest(): DetailsRequest {
     return {
         details: {
-            mD: "mdValue",
-            paRes: "paResValue",
+            MD: "mdValue",
+            PaRes: "paResValue",
         },
         paymentData: "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
     };

src/__tests__/checkout.spec.ts

@@ -21,24 +21,33 @@ import nock from "nock";
 import { createClient } from "../__mocks__/base";
 import { disableSuccess } from "../__mocks__/recurring/disableSuccess";
 import { listRecurringDetailsSuccess } from "../__mocks__/recurring/listRecurringDetailsSuccess";
-import Recurring from "../services/recurring";
+import { notifyShopperSuccess } from "../__mocks__/recurring/notifyShopperSuccess";
+import RecurringService from "../services/recurring";
 import Client from "../client";
 import { paymentsSuccess } from "../__mocks__/checkout/paymentsSuccess";
 import { createPaymentsCheckoutRequest } from "./checkout.spec";
 import Checkout from "../services/checkout";
 import { PaymentRequest } from "../typings/checkout/models";
-
-const createRecurringDetailsRequest = (): IRecurring.RecurringDetailsRequest => {
+import {
+    ScheduleAccountUpdaterRequest,
+    ScheduleAccountUpdaterResult,
+    DisableRequest,
+    RecurringDetailsRequest,
+    Recurring,
+    NotifyShopperRequest
+} from "../typings/recurring/models";
+
+const createRecurringDetailsRequest = (): RecurringDetailsRequest => {
     return {
         merchantAccount: process.env.ADYEN_MERCHANT!,
-        recurring: { contract: "RECURRING" },
+        recurring: { contract: Recurring.ContractEnum.Recurring },
         shopperReference: "shopperReference",
     };
 };
 const isCI = process.env.CI === "true" || (typeof process.env.CI === "boolean" && process.env.CI);
 
 let client: Client;
-let recurring: Recurring;
+let recurring: RecurringService;
 let checkout: Checkout;
 let scope: nock.Scope;
 
@@ -47,7 +56,7 @@ beforeEach((): void => {
         nock.activate();
     }
     client = createClient();
-    recurring = new Recurring(client);
+    recurring = new RecurringService(client);
     checkout = new Checkout(client);
     scope = nock(`${client.config.endpoint}/pal/servlet/Recurring/${Client.RECURRING_API_VERSION}`);
 });
@@ -82,7 +91,7 @@ describe("Recurring", (): void => {
         scope.post("/disable")
             .reply(200, disableSuccess);
 
-        const request: IRecurring.DisableRequest = {
+        const request: DisableRequest = {
             merchantAccount: process.env.ADYEN_MERCHANT!,
             shopperReference: "shopperReference",
             recurringDetailReference: res.additionalData!["recurring.recurringDetailReference"]
@@ -96,19 +105,45 @@ describe("Recurring", (): void => {
         }
     });
 
+    test.each([isCI, true])("should send pre-debit Notification, isMock %p", async (isMock): Promise<void> => {
+        !isMock && nock.restore();
+        scope.post("/notifyShopper")
+            .reply(200, notifyShopperSuccess);
+
+        const notifyShopperRequest: NotifyShopperRequest = {
+            merchantAccount: process.env.ADYEN_MERCHANT!,
+            shopperReference: "shopperReference",
+            storedPaymentMethodId: "8415995487234100",
+            amount: {
+                currency: "INR",
+                value: 1000
+            },
+            billingDate: "2021-03-16",
+            reference: "Example reference",
+            displayedReference: "Example displayed reference"
+        };
+
+        try {
+            const result = await recurring.notifyShopper(notifyShopperRequest);
+            expect(result).toBeTruthy();
+        } catch (e) {
+            fail(e.message);
+        }
+    });
+
 
     // TODO: register account for AccountUpdater and unmock test
     test.each([true])("should schedule account updater, isMock: %p", async (isMock): Promise<void> => {
         !isMock && nock.restore();
-        const scheduleAccountUpdaterSuccess: IRecurring.ScheduleAccountUpdaterResult = {
+        const scheduleAccountUpdaterSuccess: ScheduleAccountUpdaterResult = {
             pspReference: "mocked_psp",
             result: "SUCCESS"
         };
 
         scope.post("/scheduleAccountUpdater")
             .reply(200, scheduleAccountUpdaterSuccess);
 
-        const request: IRecurring.ScheduleAccountUpdaterRequest = {
+        const request: ScheduleAccountUpdaterRequest = {
             merchantAccount: process.env.ADYEN_MERCHANT!,
             reference: "ref",
             card: {

src/__tests__/recurring.spec.ts

@@ -111,6 +111,7 @@ class Client {
             this.config.endpoint = Client.ENDPOINT_LIVE;
             this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_LIVE;
             this.config.hppEndpoint = Client.HPP_LIVE;
+            this.config.terminalApiCloudEndpoint = Client.TERMINAL_API_ENDPOINT_LIVE;
             if (liveEndpointUrlPrefix) {
                 this.config.endpoint =
                     `${Client.ENDPOINT_PROTOCOL}${liveEndpointUrlPrefix}${Client.ENDPOINT_LIVE_SUFFIX}`;

src/client.ts

@@ -42,7 +42,7 @@ class NexoCrypto {
         securityKey: SecurityKey,
     ): SaleToPOISecuredMessage {
         const derivedKey: NexoDerivedKey = NexoDerivedKeyGenerator.deriveKeyMaterial(securityKey.passphrase);
-        const saleToPoiMessageByteArray = Buffer.from(saleToPoiMessageJson, "ascii");
+        const saleToPoiMessageByteArray = Buffer.from(saleToPoiMessageJson, "utf-8");
         const ivNonce = NexoCrypto.generateRandomIvNonce();
         const encryptedSaleToPoiMessage = NexoCrypto.crypt(saleToPoiMessageByteArray, derivedKey, ivNonce, Modes.ENCRYPT);
         const encryptedSaleToPoiMessageHmac = NexoCrypto.hmac(saleToPoiMessageByteArray, derivedKey);
@@ -74,7 +74,7 @@ class NexoCrypto {
         const receivedHmac = Buffer.from(saleToPoiSecureMessage.securityTrailer.hmac, "base64");
         this.validateHmac(receivedHmac, decryptedSaleToPoiMessageByteArray, derivedKey);
 
-        return decryptedSaleToPoiMessageByteArray.toString("ascii");
+        return decryptedSaleToPoiMessageByteArray.toString("utf-8");
     }
 
     private static validateSecurityKey(securityKey: SecurityKey): void {

src/security/nexoCrypto.ts

@@ -23,39 +23,59 @@ import Service from "../service";
 import Disable from "./resource/recurring/disable";
 import ListRecurringDetails from "./resource/recurring/listRecurringDetails";
 import ScheduleAccountUpdater from "./resource/recurring/scheduleAccountUpdater";
+import NotifyShopper from "./resource/recurring/notifyShopper";
+import {
+    RecurringDetailsRequest,
+    RecurringDetailsResult,
+    DisableRequest,
+    DisableResult,
+    ScheduleAccountUpdaterRequest,
+    ScheduleAccountUpdaterResult,
+    NotifyShopperRequest,
+    NotifyShopperResult
+} from "../typings/recurring/models";
 
 class Recurring extends Service {
     private readonly _listRecurringDetails: ListRecurringDetails;
     private readonly _disable: Disable;
     private readonly _scheduleAccountUpdater: ScheduleAccountUpdater;
+    private readonly _notifyShopper: NotifyShopper
 
     public constructor(client: Client) {
         super(client);
         this._listRecurringDetails = new ListRecurringDetails(this);
         this._disable = new Disable(this);
         this._scheduleAccountUpdater = new ScheduleAccountUpdater(this);
+        this._notifyShopper = new NotifyShopper(this);
     }
 
-    public listRecurringDetails(request: IRecurring.RecurringDetailsRequest): Promise<IRecurring.RecurringDetailsResult> {
-        return getJsonResponse<IRecurring.RecurringDetailsRequest, IRecurring.RecurringDetailsResult>(
+    public listRecurringDetails(request: RecurringDetailsRequest): Promise<RecurringDetailsResult> {
+        return getJsonResponse<RecurringDetailsRequest, RecurringDetailsResult>(
             this._listRecurringDetails,
             request,
         );
     }
 
-    public disable(request: IRecurring.DisableRequest): Promise<IRecurring.DisableResult> {
-        return getJsonResponse<IRecurring.DisableRequest, IRecurring.DisableResult>(
+    public disable(request: DisableRequest): Promise<DisableResult> {
+        return getJsonResponse<DisableRequest, DisableResult>(
             this._disable,
             request,
         );
     }
 
-    public scheduleAccountUpdater(request: IRecurring.ScheduleAccountUpdaterRequest): Promise<IRecurring.ScheduleAccountUpdaterResult> {
-        return getJsonResponse<IRecurring.ScheduleAccountUpdaterRequest, IRecurring.ScheduleAccountUpdaterResult>(
+    public scheduleAccountUpdater(request: ScheduleAccountUpdaterRequest): Promise<ScheduleAccountUpdaterResult> {
+        return getJsonResponse<ScheduleAccountUpdaterRequest, ScheduleAccountUpdaterResult>(
             this._scheduleAccountUpdater,
             request,
         );
     }
+
+    public notifyShopper(request: NotifyShopperRequest): Promise<NotifyShopperResult> {
+        return getJsonResponse<NotifyShopperRequest, NotifyShopperResult>(
+            this._notifyShopper,
+            request
+        );
+    }
 }
 
 export default Recurring;