Release 4.3.0.

Author: IngenicoEPayments

__tests__/unit/utils/obfuscate.test.ts

@@ -1,11 +1,29 @@
 import each from "jest-each";
 import * as http from "http";
+import * as _ from "lodash";
 import * as obfuscate from "../../../src/utils/obfuscate";
+import { ObfuscationRule } from "../../../src/model";
+
+import * as connectSdk from "../../../src";
+
+connectSdk.init({
+  host: "example.org",
+  scheme: "https",
+  port: -1,
+  enableLogging: false,
+  apiKeyId: "",
+  secretApiKey: "",
+  integrator: "Integration tests"
+});
 
 /**
  * @group unit:obfuscate
  */
 describe("obfuscate.getObfuscated", () => {
+  beforeEach(() => {
+    delete connectSdk.context.getContext().obfuscationRules;
+  });
+
   test("undefined body", () => {
     expect(obfuscate.getObfuscated(undefined)).toBe("");
   });
@@ -44,6 +62,41 @@ describe("obfuscate.getObfuscated", () => {
     expect(obfuscate.getObfuscated(body)).toBe(JSON.stringify(expected, null, 2));
   });
 
+  test("cardNumber with custom rule", () => {
+    const body = {
+      order: {
+        amountOfMoney: {
+          currencyCode: "CAD",
+          amount: 2345
+        },
+        customer: {
+          billingAddress: {
+            countryCode: "CA"
+          }
+        }
+      },
+      cardPaymentMethodSpecificInput: {
+        paymentProductId: 1,
+        card: {
+          cvv: "123",
+          cardNumber: "1234567890123456",
+          expiryDate: "1220"
+        }
+      }
+    };
+    const expected = JSON.parse(JSON.stringify(body));
+    expected.cardPaymentMethodSpecificInput.card.cvv = "***";
+    expected.cardPaymentMethodSpecificInput.card.cardNumber = "123456******3456";
+    expected.cardPaymentMethodSpecificInput.card.expiryDate = "**20";
+
+    const obfuscationRule: ObfuscationRule = value => value.substring(0, 6) + _.padStart("", 6, "*") + value.substring(12);
+    connectSdk.context.getContext().obfuscationRules = {
+      cardNumber: obfuscationRule
+    };
+
+    expect(obfuscate.getObfuscated(body)).toBe(JSON.stringify(expected, null, 2));
+  });
+
   test("iban", () => {
     const body = {
       sepaDirectDebit: {
@@ -140,4 +193,37 @@ describe("obfuscate.getObfuscated", () => {
 
     expect(obfuscate.getObfuscated(headers, null, true)).toBe(JSON.stringify(expected, null, 2));
   });
+
+  const customHeadersTestData = [
+    ["Authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l", "********"],
+    ["authorization", "Basic QWxhZGRpbjpPcGVuU2VzYW1l", "********"],
+    ["AUTHORIZATION", "Basic QWxhZGRpbjpPcGVuU2VzYW1l", "********"],
+
+    ["X-GCS-Authentication-Token", "foobar", "********"],
+    ["x-gcs-authentication-token", "foobar", "********"],
+    ["X-GCS-AUTHENTICATION-TOKEN", "foobar", "********"],
+
+    ["X-GCS-CallerPassword", "foobar", "********"],
+    ["x-gcs-callerpassword", "foobar", "********"],
+    ["X-GCS-CALLERPASSWORD", "foobar", "********"],
+
+    ["Content-Type", "application/json", "****************"],
+    ["content-type", "application/json", "****************"],
+    ["CONTENT-TYPE", "application/json", "****************"]
+  ];
+  each(customHeadersTestData).test("when the header is '%s'", (name, originalValue, expectedObfuscatedValue) => {
+    const headers: http.IncomingHttpHeaders = {};
+    headers[name] = originalValue;
+    headers["content-length"] = "5";
+
+    const expected = JSON.parse(JSON.stringify(headers));
+    expected[name] = expectedObfuscatedValue;
+
+    const obfuscationRule: ObfuscationRule = obfuscate.all();
+    connectSdk.context.getContext().obfuscationRules = {
+      "content-type": obfuscationRule
+    };
+
+    expect(obfuscate.getObfuscated(headers, null, true)).toBe(JSON.stringify(expected, null, 2));
+  });
 });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "connect-sdk-nodejs",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API",
   "homepage": "https://github.com/Ingenico-ePayments/connect-sdk-nodejs#readme",
   "bugs": {

package.json

@@ -5,6 +5,7 @@
 import https = require("https");
 import { CommunicatorLogger, ConnectSdk, Context } from "./model";
 import sdkcontext = require("./utils/context");
+import obfuscate = require("./utils/obfuscate");
 
 import hostedcheckouts = require("./hostedcheckouts");
 import hostedmandatemanagements = require("./hostedmandatemanagements");
@@ -89,6 +90,13 @@ const connectSdk: ConnectSdk = {
   files: files,
   context: sdkcontext,
 
-  webhooks: webhooks
+  webhooks: webhooks,
+
+  obfuscate: {
+    all: obfuscate.all,
+    allButLast: obfuscate.allButLast,
+    allButFirst: obfuscate.allButFirst,
+    withFixedLength: obfuscate.withFixedLength
+  }
 };
 export = connectSdk;

src/index.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated from the API references found at
  * https://epayments-api.developer-ingenico.com/s2sapi/v1/
  */
-import { Context, SdkContext } from "./types";
+import { Context, ObfuscationRules, SdkContext } from "./types";
 import { HostedcheckoutsClient } from "./hostedcheckouts";
 import { HostedmandatemanagementsClient } from "./hostedmandatemanagements";
 import { PaymentsClient } from "./payments";
@@ -42,6 +42,8 @@ export interface ConnectSdk {
   readonly context: SdkContext;
 
   readonly webhooks: WebhooksHelper;
+
+  readonly obfuscate: ObfuscationRules;
 }
 
 export * from "./types";

src/model/index.ts

@@ -21,6 +21,7 @@ export interface Context {
   integrator: string;
   shoppingCartExtension?: ShoppingCartExtension;
   httpOptions?: https.RequestOptions;
+  obfuscationRules?: { [key: string]: ObfuscationRule };
 }
 
 export interface FileMetaData {
@@ -55,6 +56,27 @@ export interface MultipartFormDataRequest extends SdkRequest {
   body: MultipartFormDataObject;
 }
 
+export interface ObfuscationRules {
+  /**
+   * @returns An obfuscation rule that will replace all characters with *.
+   */
+  all(): ObfuscationRule;
+  /**
+   * @returns An obfuscation rule that will keep a fixed number of characters at the end, then replaces all other characters with *.
+   */
+  allButLast(count: number): ObfuscationRule;
+  /**
+   * @returns An obfuscation rule that will keep a fixed number of characters at the start, then replaces all other characters with *.
+   */
+  allButFirst(count: number): ObfuscationRule;
+  /**
+   * @returns An obfuscation rule that will replace values with a fixed length string containing only *.
+   */
+  withFixedLength(count: number): ObfuscationRule;
+}
+
+export type ObfuscationRule = (value: string) => string;
+
 export interface PaymentContext {
   extraHeaders?: Header[];
   idemPotence?: IdemPotence;

src/model/types.ts

@@ -18,7 +18,7 @@ interface ServerMetaInfo {
 export function serverMetaInfo(sdkContext: SdkContext): Header {
   const info: ServerMetaInfo = {
     sdkCreator: "Ingenico",
-    sdkIdentifier: "NodejsServerSDK/v4.2.1",
+    sdkIdentifier: "NodejsServerSDK/v4.3.0",
     platformIdentifier: process.env["OS"] + " Node.js/" + process.versions.node
   };
   if (sdkContext.getIntegrator() !== null) {