@finteqhub/sdk-js 0.12.0-beta.3 → 0.12.0-beta.5

package/README.md

@@ -6,6 +6,8 @@ Use `new FinteqHubProcessing(apiUrl: string, fingerprintVisitorId: string, merch
 const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'merchant-id', 'session-id');
 ```
 
+The constructor validates its arguments and throws a `TypeError` when `apiUrl`, `fingerprintVisitorId`, `merchantId` or `sessionId` is missing, empty or not a string, when `isSecure` is not a boolean, or when `retryOptions` is malformed (see [Retries and error diagnostics](#retries-and-error-diagnostics)).
+
 ## Retries and error diagnostics
 
 Failed HTTP requests are retried automatically with exponential backoff (`100ms → 200ms → 500ms → 1000ms → 2000ms`; every retry after the fifth waits 2000ms). Retries can be configured via the optional `retryOptions` constructor argument (the sixth one, after `isSecure`):
@@ -21,6 +23,8 @@ const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id',
 });
 ```
 
+The constructor throws a `TypeError` when `retryOptions` is not an object, `retryCount` is not a non-negative integer, or `retryStatusCode` is not a function.
+
 Network errors (the browser could not reach the server at all, e.g. `TypeError: Failed to fetch`, or the connection dropped while the response body was being read) are always retried too.
 
 Every retry attempt is reported with `console.warn`. When a request finally fails, the SDK logs `console.error` (`sdk-js: request failed: <message>`) with a full diagnostic dump and rejects with a `RequestError` whose `diagnostics` field carries the same payload — include it in your error reporting. `diagnostics.kind` tells the failure class apart:

package/dist/src/processing.d.ts

@@ -59,6 +59,6 @@ export declare class FinteqHubProcessing {
     private sendPost;
     private request;
     private fetchWithRetry;
-    private responseError;
+    private requestError;
     private collectDiagnostics;
 }

package/dist/src/processing.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { getDeviceData, uuid } from "./utils";
+import { getDeviceData, uuid, validateArguments } from "./utils";
 import { SDK_HEADER_NAME, SDK_HEADER_VALUE, SDK_VERSION } from "./version";
 export class RequestError extends Error {
     constructor(message, diagnostics) {
@@ -26,6 +26,7 @@ const sanitizeBody = (body) => body.slice(0, MAX_BODY_SNIPPET_LENGTH).replace(/\
 const defaultRetryStatusCode = (statusCode) => statusCode < 200 || statusCode === 408 || statusCode >= 500;
 export class FinteqHubProcessing {
     constructor(apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure = false, retryOptions = {}) {
+        validateArguments({ apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure, retryOptions });
         this.apiUrl = apiUrl;
         this.fingerprintVisitorId = fingerprintVisitorId;
         this.merchantId = merchantId;
@@ -134,10 +135,10 @@ export class FinteqHubProcessing {
                         ? sanitizeBody(e.message)
                         : "parse error message omitted (200 response body may carry credentials)",
                 };
-                throw this.responseError("invalid_json", `request to ${url} returned invalid JSON (status ${response.status})`, url, options, attempts, { status: response.status, body }, parseError);
+                throw this.requestError("invalid_json", `request to ${url} returned invalid JSON (status ${response.status})`, url, options, attempts, { status: response.status, body }, parseError);
             }
             if ((result === null || result === void 0 ? void 0 : result.error) || response.status !== 200) {
-                throw this.responseError("http_error", (result === null || result === void 0 ? void 0 : result.error) || `unexpected response status ${response.status}`, url, options, attempts, { status: response.status, body, error: result === null || result === void 0 ? void 0 : result.error });
+                throw this.requestError("http_error", (result === null || result === void 0 ? void 0 : result.error) || `unexpected response status ${response.status}`, url, options, attempts, { status: response.status, body, error: result === null || result === void 0 ? void 0 : result.error });
             }
             return result;
         });
@@ -164,10 +165,7 @@ export class FinteqHubProcessing {
                     // status is known when the failure happened while reading the body of a received response
                     attempts.push({ durationMs: Date.now() - startedAt, status: response === null || response === void 0 ? void 0 : response.status, error: e.message });
                     if (attempt > retryCount) {
-                        const message = `request to ${url} failed after ${attempt} attempt(s): ${e.message}`;
-                        const diagnostics = this.collectDiagnostics("network", url, options, attempts, e, response ? { status: response.status } : undefined);
-                        console.error(`sdk-js: request failed: ${message}`, diagnostics);
-                        throw new RequestError(message, diagnostics);
+                        throw this.requestError("network", `request to ${url} failed after ${attempt} attempt(s): ${e.message}`, url, options, attempts, response ? { status: response.status } : undefined, e);
                     }
                     reason = e.message;
                 }
@@ -187,7 +185,7 @@ export class FinteqHubProcessing {
             }
         });
     }
-    responseError(kind, message, url, options, attempts, response, error) {
+    requestError(kind, message, url, options, attempts, response, error) {
         const diagnostics = this.collectDiagnostics(kind, url, options, attempts, error, response);
         console.error(`sdk-js: request failed: ${message}`, diagnostics);
         return new RequestError(message, diagnostics);

package/dist/src/utils.d.ts

@@ -1,3 +1,4 @@
+import type { RetryOptions } from "./processing";
 export declare const DeviceType: {
     Unknown: string;
     Computer: string;
@@ -9,6 +10,15 @@ export declare const DeviceType: {
 };
 export declare function uuid(): string;
 export declare function getDeviceType(): string;
+declare type ConstructorArguments = {
+    apiUrl: string;
+    fingerprintVisitorId: string;
+    merchantId: string;
+    sessionId: string;
+    isSecure: boolean;
+    retryOptions: RetryOptions;
+};
+export declare function validateArguments(args: ConstructorArguments): void;
 export declare function getDeviceData(): {
     device: {
         type: string;
@@ -31,3 +41,4 @@ export declare function getDeviceData(): {
         };
     };
 };
+export {};

package/dist/src/utils.js

@@ -40,6 +40,28 @@ export function getDeviceType() {
     }
     return DeviceType.Unknown;
 }
+const REQUIRED_STRINGS = ["apiUrl", "fingerprintVisitorId", "merchantId", "sessionId"];
+export function validateArguments(args) {
+    for (const key of REQUIRED_STRINGS) {
+        if (typeof args[key] !== "string" || args[key] === "") {
+            throw new TypeError(`sdk-js: ${key} must be a non-empty string`);
+        }
+    }
+    if (typeof args.isSecure !== "boolean") {
+        throw new TypeError("sdk-js: isSecure must be a boolean");
+    }
+    const { retryOptions } = args;
+    if (typeof retryOptions !== "object" || retryOptions === null) {
+        throw new TypeError("sdk-js: retryOptions must be an object");
+    }
+    const { retryCount, retryStatusCode } = retryOptions;
+    if (retryCount !== undefined && (!Number.isInteger(retryCount) || retryCount < 0)) {
+        throw new TypeError("sdk-js: retryOptions.retryCount must be a non-negative integer");
+    }
+    if (retryStatusCode !== undefined && typeof retryStatusCode !== "function") {
+        throw new TypeError("sdk-js: retryOptions.retryStatusCode must be a function");
+    }
+}
 export function getDeviceData() {
     var _a, _b, _c;
     return {

package/dist/src/version.d.ts

@@ -1,3 +1,3 @@
 export declare const SDK_HEADER_NAME = "X-Finteqhub-SDK";
-export declare const SDK_VERSION = "0.12.0-beta.3";
+export declare const SDK_VERSION = "0.12.0-beta.5";
 export declare const SDK_HEADER_VALUE: string;

package/dist/src/version.js

@@ -1,3 +1,3 @@
 export const SDK_HEADER_NAME = "X-Finteqhub-SDK";
-export const SDK_VERSION = "0.12.0-beta.3";
+export const SDK_VERSION = "0.12.0-beta.5";
 export const SDK_HEADER_VALUE = `sdk-js/${SDK_VERSION}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finteqhub/sdk-js",
-  "version": "0.12.0-beta.3",
+  "version": "0.12.0-beta.5",
   "description": "SDK for interacting with FinteqHub processing API",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",