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

package/README.md

@@ -1,42 +1,32 @@
 # processing-sdk
 
-Use `new FinteqHubProcessing(options: ProcessingOptions)` to create an instance of the FinteqHubProcessing object. The FinteqHubProcessing object is your entrypoint to FinteqHub processing SDK.
+Use `new FinteqHubProcessing(apiUrl: string, fingerprintVisitorId: string, merchantId: string, sessionId: string, isSecure?: boolean, retryOptions?: RetryOptions)` to create an instance of the FinteqHubProcessing object. The FinteqHubProcessing object is your entrypoint to FinteqHub processing SDK.
 
 ```
-interface ProcessingOptions {
-  apiUrl: string;
-  fingerprintVisitorId: string;
-  merchantId: string;
-  sessionId: string;
-  isSecure?: boolean; // default false
-  retryOptions?: RetryOptions;
-}
-
-const processing = new FinteqHubProcessing({
-  apiUrl: 'api-url',
-  fingerprintVisitorId: 'fingerprint-visitor-id',
-  merchantId: 'merchant-id',
-  sessionId: 'session-id',
-});
+const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'merchant-id', 'session-id');
 ```
 
 ## 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 `retryOptions` constructor option:
+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`):
 
 ```
 interface RetryOptions {
   retryCount?: number; // number of retries after the initial attempt, default 5; 0 disables retries
   retryStatusCode?: (statusCode: number) => boolean; // default: statusCode < 200 || statusCode === 408 || statusCode >= 500
 }
+
+const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'merchant-id', 'session-id', false, {
+  retryCount: 3,
+});
 ```
 
 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` 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:
+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:
 
 - `"network"` — the browser never got a complete response (e.g. `TypeError: Failed to fetch`, or the body could not be read); `diagnostics.error` describes the thrown error, `diagnostics.response.status` is present when headers had arrived before the failure, `message` is `request to <url> failed after N attempt(s): ...`;
-- `"http_error"` — an error response (non-200 status, or an `error` field in the body); `message` is the error text from the response body (or `unexpected response status <code>` when the body has none), `diagnostics.response.status` carries the HTTP status;
+- `"http_error"` — an error response (non-200 status, or an `error` field in the body); `message` is the error text from the response body (or `unexpected response status <code>` when the body has none), `diagnostics.response.status` carries the HTTP status and `diagnostics.response.error` the error text from the body;
 - `"invalid_json"` — the response body is not valid JSON; both `diagnostics.error` (the parse error; its message follows the same policy as the body — sanitized for non-200, omitted for 200 responses) and `diagnostics.response` are set.
 
 Every `diagnostics` payload also includes:
@@ -44,6 +34,7 @@ Every `diagnostics` payload also includes:
 - `sdkVersion`;
 - `request`: url, method, `x-request-id`, session id, and per-attempt log `attempts: [{ durationMs, status?, error? }]` — attempt durations help tell an instant failure (DNS/connection refused) from a hang (timeout/handshake);
 - `response.body` for non-200 responses — truncated to 500 chars with long digit runs masked (`***`); the body of a 200 response is never included since it may carry session credentials; the request body is never included anywhere;
+- `response.error` — the `error` field of the response body, for any status (including a 200 response with an `error` field); it is a business error text, so it is neither truncated nor masked;
 - `environment`: `navigator.onLine`, `document.visibilityState`, `navigator.connection` (`effectiveType`/`rtt`/`downlink`, Chromium only), timestamp.
 
 Diagnostics are collected regardless of whether retries are enabled.
@@ -93,7 +84,7 @@ import FingerprintJS from "@fingerprintjs/fingerprintjs";
 const fp = await FingerprintJS.load();
 const result = await fp.get();
 
-const processing = new FinteqHubProcessing({ apiUrl, fingerprintVisitorId: result.visitorId, merchantId, sessionId });
+const processing = new FinteqHubProcessing(apiUrl, result.visitorId, merchantId, sessionId);
 const session = await processing.getSession();
 
 const data = {/** collect data from form and session **/}

package/dist/src/processing.d.ts

@@ -3,14 +3,6 @@ export interface RetryOptions {
     retryCount?: number;
     retryStatusCode?: (statusCode: number) => boolean;
 }
-export interface ProcessingOptions {
-    apiUrl: string;
-    fingerprintVisitorId: string;
-    merchantId: string;
-    sessionId: string;
-    isSecure?: boolean;
-    retryOptions?: RetryOptions;
-}
 export declare type RequestAttempt = {
     durationMs: number;
     status?: number;
@@ -28,6 +20,7 @@ export declare type RequestDiagnostics = {
     response?: {
         status: number;
         body?: string;
+        error?: string;
     };
     request: {
         url: string;
@@ -59,7 +52,7 @@ export declare class FinteqHubProcessing {
     private projectId;
     private isSecure;
     private retryOptions;
-    constructor(options: ProcessingOptions);
+    constructor(apiUrl: string, fingerprintVisitorId: string, merchantId: string, sessionId: string, isSecure?: boolean, retryOptions?: RetryOptions);
     getSession(): Promise<SessionResponse>;
     submitForm(data: SubmitData): Promise<ProcessOperationRedirectResponse>;
     private processOperation;

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, validateOptions } from "./utils";
+import { getDeviceData, uuid } from "./utils";
 import { SDK_HEADER_NAME, SDK_HEADER_VALUE, SDK_VERSION } from "./version";
 export class RequestError extends Error {
     constructor(message, diagnostics) {
@@ -25,15 +25,13 @@ const sanitizeBody = (body) => body.slice(0, MAX_BODY_SNIPPET_LENGTH).replace(/\
 // failures and for duplicate-submit rejections — retrying either only delays the error
 const defaultRetryStatusCode = (statusCode) => statusCode < 200 || statusCode === 408 || statusCode >= 500;
 export class FinteqHubProcessing {
-    constructor(options) {
-        var _a, _b;
-        validateOptions(options);
-        this.apiUrl = options.apiUrl;
-        this.fingerprintVisitorId = options.fingerprintVisitorId;
-        this.merchantId = options.merchantId;
-        this.sessionId = options.sessionId;
-        this.isSecure = (_a = options.isSecure) !== null && _a !== void 0 ? _a : false;
-        this.retryOptions = (_b = options.retryOptions) !== null && _b !== void 0 ? _b : {};
+    constructor(apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure = false, retryOptions = {}) {
+        this.apiUrl = apiUrl;
+        this.fingerprintVisitorId = fingerprintVisitorId;
+        this.merchantId = merchantId;
+        this.sessionId = sessionId;
+        this.isSecure = isSecure;
+        this.retryOptions = retryOptions;
     }
     getSession() {
         return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
@@ -136,10 +134,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, response, body, parseError);
+                throw this.responseError("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, response, body);
+                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 });
             }
             return result;
         });
@@ -166,9 +164,10 @@ 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 diagnostics = this.collectDiagnostics("network", url, options, attempts, e, response);
-                        console.error("sdk-js: request failed", diagnostics);
-                        throw new RequestError(`request to ${url} failed after ${attempt} attempt(s): ${e.message}`, diagnostics);
+                        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);
                     }
                     reason = e.message;
                 }
@@ -188,12 +187,12 @@ export class FinteqHubProcessing {
             }
         });
     }
-    responseError(kind, message, url, options, attempts, response, body, error) {
-        const diagnostics = this.collectDiagnostics(kind, url, options, attempts, error, response, body);
-        console.error("sdk-js: request failed", diagnostics);
+    responseError(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);
     }
-    collectDiagnostics(kind, url, options, attempts, error, response, body) {
+    collectDiagnostics(kind, url, options, attempts, error, response) {
         const connection = navigator.connection;
         return {
             kind,
@@ -206,7 +205,7 @@ export class FinteqHubProcessing {
                     cause: error.cause,
                 }
                 : undefined,
-            response: response ? { status: response.status, body } : undefined,
+            response,
             request: {
                 url,
                 method: options.method,

package/dist/src/utils.d.ts

@@ -1,4 +1,3 @@
-import type { ProcessingOptions } from "./processing";
 export declare const DeviceType: {
     Unknown: string;
     Computer: string;
@@ -10,7 +9,6 @@ export declare const DeviceType: {
 };
 export declare function uuid(): string;
 export declare function getDeviceType(): string;
-export declare function validateOptions(options: ProcessingOptions): void;
 export declare function getDeviceData(): {
     device: {
         type: string;

package/dist/src/utils.js

@@ -40,32 +40,6 @@ export function getDeviceType() {
     }
     return DeviceType.Unknown;
 }
-const REQUIRED_OPTIONS = ["apiUrl", "fingerprintVisitorId", "merchantId", "sessionId"];
-export function validateOptions(options) {
-    if (typeof options !== "object" || options === null) {
-        throw new TypeError("sdk-js: constructor expects an options object: { apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure?, retryOptions? }");
-    }
-    for (const key of REQUIRED_OPTIONS) {
-        if (typeof options[key] !== "string" || options[key] === "") {
-            throw new TypeError(`sdk-js: option "${key}" must be a non-empty string`);
-        }
-    }
-    if (options.isSecure !== undefined && typeof options.isSecure !== "boolean") {
-        throw new TypeError('sdk-js: option "isSecure" must be a boolean');
-    }
-    if (options.retryOptions !== undefined) {
-        if (typeof options.retryOptions !== "object" || options.retryOptions === null) {
-            throw new TypeError('sdk-js: option "retryOptions" must be an object');
-        }
-        const { retryCount, retryStatusCode } = options.retryOptions;
-        if (retryCount !== undefined && (!Number.isInteger(retryCount) || retryCount < 0)) {
-            throw new TypeError('sdk-js: option "retryOptions.retryCount" must be a non-negative integer');
-        }
-        if (retryStatusCode !== undefined && typeof retryStatusCode !== "function") {
-            throw new TypeError('sdk-js: option "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.1";
+export declare const SDK_VERSION = "0.12.0-beta.3";
 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.1";
+export const SDK_VERSION = "0.12.0-beta.3";
 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.1",
+  "version": "0.12.0-beta.3",
   "description": "SDK for interacting with FinteqHub processing API",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",