Release 5.1.0.

.github/workflows/api-docs.yml

@@ -12,12 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: code
           persist-credentials: false
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '12.x'
           cache: 'npm'
@@ -26,7 +26,7 @@ jobs:
         run: npm ci && npm run build && npm run typedoc
         working-directory: code
       - name: Checkout pages
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
           path: pages

.github/workflows/deploy.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '12.x'
           # sets up .npmrc file to publish to npm

__tests__/integration/v1/riskassessments.test.ts

@@ -24,7 +24,7 @@ describe("riskassessments", () => {
         }
       };
 
-      const response = await client.v1.riskassessments.bankaccounts(config.merchantId, body, null);
+      const response = await client.v1.riskassessments.bankaccounts(config.merchantId, body);
       expect(response.status).toBe(200);
       expect(response.body).not.toBeNull();
 

__tests__/integration/v1/tokens.test.ts

@@ -27,7 +27,7 @@ describe("token", () => {
       }
     };
 
-    const createResponse = await client.v1.tokens.create(config.merchantId, body, null);
+    const createResponse = await client.v1.tokens.create(config.merchantId, body);
     expect(createResponse.status).toBeGreaterThanOrEqual(200);
     expect(createResponse.status).toBeLessThanOrEqual(201);
     expect(createResponse.body).not.toBeNull();

__tests__/unit/index.test.ts

@@ -19,6 +19,10 @@ describe("assertSuccess", () => {
       };
       const asserted = assertSuccess(response);
       expect(asserted).toBe(response);
+      // check separate properties too, to ensure that the right type is returned
+      expect(asserted.status).toBe(response.status);
+      expect(asserted.isSuccess).toBe(true);
+      expect(asserted.body).toBe(response.body);
     });
 
     test("!isSuccess", () => {
@@ -55,6 +59,11 @@ describe("assertSuccess", () => {
       };
       const asserted = assertSuccess(response);
       expect(asserted).toBe(response);
+      // check separate properties too, to ensure that the right type is returned
+      expect(asserted.status).toBe(response.status);
+      expect(asserted.isSuccess).toBe(true);
+      expect(asserted.body).toBe(response.body);
+      expect(asserted.file).toBe(response.file);
     });
 
     test("!isSuccess", () => {

documentation/Migration Guide v4 to v5.md

@@ -118,7 +118,7 @@ Modules for API clients and calls like `connect-sdk-nodejs/lib/v1/payments` or `
 ```typescript
 import { create as createPayment } from "connect-sdk-nodejs/lib/v1/payments/create";
 import { newPaymentsClient } from "connect-sdk-nodejs/lib/v1/payments";
-import { CreatePaymentResponse} from "connect-sdk-nodejs/lib/v1/model/domain";
+import { CreatePaymentResponse } from "connect-sdk-nodejs/lib/v1/model/domain";
 
 const createResponse = await createPayment(sdkContext)(merchantId, body, paymentContext);
 const responseBody = createResponse.body as CreatePaymentResponse;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "connect-sdk-nodejs",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API",
   "homepage": "https://github.com/Worldline-Global-Collect/connect-sdk-nodejs#readme",
   "bugs": {
@@ -30,6 +30,7 @@
     "test:integration": "jest --group=integration"
   },
   "dependencies": {
+    "dateformat": "^4.6.3",
     "form-data": "^4.0.0",
     "jsonschema": "^1.4.1",
     "lodash": "^4.17.21",
@@ -50,7 +51,6 @@
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
     "body-parser": "^1.20.2",
-    "dateformat": "^4.6.3",
     "eslint": "^7.32.0",
     "express": "^4.18.2",
     "husky": "^4.3.8",

src/index.ts

@@ -20,17 +20,17 @@ export const obfuscate: ObfuscationRules = {
 };
 
 /**
- * Asserts that an {@link SdkResponse} is successful.
+ * Asserts that an {@link SdkBinaryResponse} is successful.
  * @returns The response if it is successful.
  * @throws {@link SdkApiError} if the response is not successful.
  */
-export function assertSuccess<T, E>(response: SdkResponse<T, E>): SdkSuccessResponse<T>;
+export function assertSuccess<E>(response: SdkBinaryResponse<E>): SdkBinarySuccessResponse;
 /**
- * Asserts that an {@link SdkBinaryResponse} is successful.
+ * Asserts that an {@link SdkResponse} is successful.
  * @returns The response if it is successful.
  * @throws {@link SdkApiError} if the response is not successful.
  */
-export function assertSuccess<E>(response: SdkBinaryResponse<E>): SdkBinarySuccessResponse;
+export function assertSuccess<T, E>(response: SdkResponse<T, E>): SdkSuccessResponse<T>;
 export function assertSuccess<T, E>(response: SdkResponse<T, E> | SdkBinaryResponse<E>): SdkSuccessResponse<T> | SdkBinarySuccessResponse {
   if (response.isSuccess) {
     return response;

src/model/types.ts

@@ -1,4 +1,5 @@
 import { Readable } from "stream";
+import { Agent } from "http";
 import { ShoppingCartExtension } from "./domain";
 
 export interface Authenticator {
@@ -22,6 +23,11 @@ export interface Configuration {
   shoppingCartExtension?: ShoppingCartExtension;
   obfuscationRules?: Record<string, ObfuscationRule>;
   proxy?: ProxyConfiguration;
+  connectionOptions?: ConnectionOptions;
+}
+
+export interface ConnectionOptions {
+  agent?: Agent;
 }
 
 export interface FileMetadata {
@@ -99,6 +105,7 @@ export interface ProxyConfiguration {
 export interface SdkContext {
   getEndpoint(): HttpEndpoint;
   getProxy(): ProxyConfiguration | undefined;
+  getConnectionOptions(): ConnectionOptions | undefined;
   getAuthenticator(): Authenticator;
   getLogger(): Logger;
   setLogger(logger: Logger): void;

src/utils/communicator.ts

@@ -71,6 +71,11 @@ async function prepareRequest(request: SdkRequest, sdkContext: SdkContext, optio
       options.headers!["Proxy-Authorization"] = "Basic " + Buffer.from(proxy.credentials).toString("base64");
     }
   }
+
+  const connectionOptions = sdkContext.getConnectionOptions();
+  if (connectionOptions?.agent) {
+    options.agent = connectionOptions.agent;
+  }
 }
 
 function handleResponse(

src/utils/context.ts

@@ -1,4 +1,4 @@
-import { Authenticator, CommunicatorLogger, Configuration, HttpEndpoint, Logger, ObfuscationRule, ProxyConfiguration, SdkContext } from "../model";
+import { Authenticator, CommunicatorLogger, Configuration, ConnectionOptions, HttpEndpoint, Logger, ObfuscationRule, ProxyConfiguration, SdkContext } from "../model";
 import { ShoppingCartExtension } from "../model/domain";
 import { V1HMACAuthenticator } from "./authentication";
 
@@ -15,6 +15,7 @@ function defaultPort(scheme: "http" | "https"): number {
 class SdkContextImpl implements SdkContext {
   private readonly endpoint: HttpEndpoint;
   private readonly proxy?: ProxyConfiguration;
+  private readonly connectionOptions?: ConnectionOptions;
   private readonly authenticator: Authenticator;
   private readonly integrator: string;
   private readonly shoppingCartExtension?: ShoppingCartExtension;
@@ -29,6 +30,7 @@ class SdkContextImpl implements SdkContext {
       port: configuration.port ?? defaultPort(configuration.scheme ?? "https")
     };
     this.proxy = configuration.proxy;
+    this.connectionOptions = configuration.connectionOptions;
     this.authenticator = new V1HMACAuthenticator(configuration.apiKeyId, configuration.secretApiKey);
 
     this.logger = configuration.logger ? toLogger(configuration.logger) : consoleLogger;
@@ -59,6 +61,10 @@ class SdkContextImpl implements SdkContext {
     return this.proxy;
   }
 
+  getConnectionOptions(): ConnectionOptions | undefined {
+    return this.connectionOptions;
+  }
+
   getAuthenticator(): Authenticator {
     return this.authenticator;
   }

src/utils/headers.ts

@@ -18,7 +18,7 @@ interface ServerMetaInfo {
 export function serverMetaInfo(sdkContext: SdkContext): Header {
   const info: ServerMetaInfo = {
     sdkCreator: "Worldline",
-    sdkIdentifier: "NodejsServerSDK/v5.0.0",
+    sdkIdentifier: "NodejsServerSDK/v5.1.0",
     platformIdentifier: process.env["OS"] + " Node.js/" + process.versions.node,
     integrator: sdkContext.getIntegrator()
   };