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

package/README.md

@@ -33,10 +33,10 @@ interface RetryOptions {
 
 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 +44,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.

package/dist/src/processing.d.ts

@@ -28,6 +28,7 @@ export declare type RequestDiagnostics = {
     response?: {
         status: number;
         body?: string;
+        error?: string;
     };
     request: {
         url: string;

package/dist/src/processing.js

@@ -136,10 +136,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 +166,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 +189,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 +207,7 @@ export class FinteqHubProcessing {
                     cause: error.cause,
                 }
                 : undefined,
-            response: response ? { status: response.status, body } : undefined,
+            response,
             request: {
                 url,
                 method: options.method,

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.2";
 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.2";
 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.2",
   "description": "SDK for interacting with FinteqHub processing API",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",