@finteqhub/sdk-js 0.15.0 → 0.16.0-beta.2

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 Notable changes to `@finteqhub/sdk-js`. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## 0.16.0
+
+### Breaking changes
+
+- The SDK no longer sends the `x-merchant-id` header (previously on every request) or the `x-project-id` header (previously on `submit-form` and `operations` requests, taken from the session response). This release requires a backend that no longer expects these headers; against older backends `submit-form` and `sessions` requests are rejected with 400.
+- The `merchantId` constructor argument was removed together with the header. The constructor is now `new FinteqHubProcessing(apiUrl, fingerprintVisitorId, sessionId, isSecure?, retryOptions?)` — every argument after `fingerprintVisitorId` shifts one position to the left. Callers must drop the third argument; a call site that still passes it fails argument validation (`isSecure` receives the session id, which is not a boolean, and the constructor throws a `TypeError`).
+
+### Changed
+
+- README: `getSession` is documented as optional and the Usage section shows a submit-only flow next to the render-from-session one. `submitForm` never depended on the session response apart from `projectId`, which is no longer sent.
+
 ## 0.15.0
 
 ### Added

package/README.md

@@ -1,16 +1,16 @@
 # 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.
+Use `new FinteqHubProcessing(apiUrl: string, fingerprintVisitorId: 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.
 
 ```
-const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'merchant-id', 'session-id');
+const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-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)).
+The constructor validates its arguments and throws a `TypeError` when `apiUrl`, `fingerprintVisitorId` 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`):
+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 fifth one, after `isSecure`):
 
 ```
 interface RetryOptions {
@@ -18,7 +18,7 @@ interface RetryOptions {
   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, {
+const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'session-id', false, {
   retryCount: 3,
 });
 ```
@@ -26,7 +26,7 @@ const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id',
 To disable retries entirely, pass `retryCount: 0` — every request is then sent exactly once, as in 0.11.0. Error diagnostics (`RequestError`, the `console.error` dump) are still collected:
 
 ```
-const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'merchant-id', 'session-id', false, {
+const processing = new FinteqHubProcessing('api-url', 'fingerprint-visitor-id', 'session-id', false, {
   retryCount: 0,
 });
 ```
@@ -67,7 +67,7 @@ The header is added automatically to every request and cannot be disabled.
 
 ### processing.getSession()
 
-Use `processing.getSession` to get session information.
+Use `processing.getSession` to get session information (payment methods, credential fields, operation amount and currency, init credentials) for rendering the form. It is optional: `submitForm` does not depend on it and can be called right after constructing the instance.
 
 ```
 processing
@@ -89,6 +89,10 @@ processing
 
 ## Usage
 
+### Submit only
+
+The minimal flow is to construct the instance and call `submitForm` — no other request is needed before it. Use it when your own UI already knows what to collect from the customer (for example, the payment method and its credential fields are fixed on your side):
+
 ```
 import { FinteqHubProcessing } from "@finteqhub/sdk-js";
 import FingerprintJS from "@fingerprintjs/fingerprintjs";
@@ -96,10 +100,26 @@ import FingerprintJS from "@fingerprintjs/fingerprintjs";
 const fp = await FingerprintJS.load();
 const result = await fp.get();
 
-const processing = new FinteqHubProcessing(apiUrl, result.visitorId, merchantId, sessionId);
+const processing = new FinteqHubProcessing(apiUrl, result.visitorId, sessionId);
+
+const data = {/** collect data from form **/}
+
+processing
+  .submitForm(data)
+  .then(result => console.log(result))
+  .catch(error => console.warn(error));
+```
+
+### Render the form from session data
+
+Call `getSession` first when the form itself is built from the session: available payment methods, their credential fields, the operation amount and currency. `submitForm` does not use the result — it only drives your UI:
+
+```
+const processing = new FinteqHubProcessing(apiUrl, result.visitorId, sessionId);
+
 const session = await processing.getSession();
 
-const data = {/** collect data from form and session **/}
+const data = {/** collect data from form rendered from session **/}
 
 processing
   .submitForm(data)

package/dist/src/processing.d.ts

@@ -47,12 +47,11 @@ export declare class RequestError extends Error {
 export declare class FinteqHubProcessing {
     private apiUrl;
     private fingerprintVisitorId;
-    private merchantId;
     private sessionId;
     private projectId;
     private isSecure;
     private retryOptions;
-    constructor(apiUrl: string, fingerprintVisitorId: string, merchantId: string, sessionId: string, isSecure?: boolean, retryOptions?: RetryOptions);
+    constructor(apiUrl: string, fingerprintVisitorId: string, sessionId: string, isSecure?: boolean, retryOptions?: RetryOptions);
     getSession(): Promise<SessionResponse>;
     submitForm(data: SubmitData): Promise<ProcessOperationRedirectResponse>;
     private processOperation;

package/dist/src/processing.js

@@ -25,11 +25,10 @@ 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(apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure = false, retryOptions = {}) {
-        validateArguments({ apiUrl, fingerprintVisitorId, merchantId, sessionId, isSecure, retryOptions });
+    constructor(apiUrl, fingerprintVisitorId, sessionId, isSecure = false, retryOptions = {}) {
+        validateArguments({ apiUrl, fingerprintVisitorId, sessionId, isSecure, retryOptions });
         this.apiUrl = apiUrl;
         this.fingerprintVisitorId = fingerprintVisitorId;
-        this.merchantId = merchantId;
         this.sessionId = sessionId;
         this.isSecure = isSecure;
         this.retryOptions = retryOptions;
@@ -43,7 +42,6 @@ export class FinteqHubProcessing {
                     method: "GET",
                     headers: {
                         "Content-Type": "application/json;charset=UTF-8",
-                        "x-merchant-id": this.merchantId,
                         "x-request-id": uuid(),
                         [SDK_HEADER_NAME]: SDK_HEADER_VALUE,
                     },
@@ -108,11 +106,9 @@ export class FinteqHubProcessing {
             method: "POST",
             headers: {
                 "Content-Type": "application/json;charset=UTF-8",
-                "x-merchant-id": this.merchantId,
                 "x-request-id": uuid(),
                 "x-fingerprint": this.fingerprintVisitorId,
                 "x-session-id": this.sessionId,
-                "x-project-id": this.projectId,
                 [SDK_HEADER_NAME]: SDK_HEADER_VALUE,
             },
             body: JSON.stringify(data),

package/dist/src/utils.d.ts

@@ -13,7 +13,6 @@ export declare function getDeviceType(): string;
 declare type ConstructorArguments = {
     apiUrl: string;
     fingerprintVisitorId: string;
-    merchantId: string;
     sessionId: string;
     isSecure: boolean;
     retryOptions: RetryOptions;

package/dist/src/utils.js

@@ -49,7 +49,7 @@ export function getDeviceType() {
     }
     return DeviceType.Unknown;
 }
-const REQUIRED_STRINGS = ["apiUrl", "fingerprintVisitorId", "merchantId", "sessionId"];
+const REQUIRED_STRINGS = ["apiUrl", "fingerprintVisitorId", "sessionId"];
 export function validateArguments(args) {
     for (const key of REQUIRED_STRINGS) {
         if (typeof args[key] !== "string" || args[key] === "") {

package/dist/src/version.d.ts

@@ -1,3 +1,3 @@
 export declare const SDK_HEADER_NAME = "x-pgw-sdk";
-export declare const SDK_VERSION = "0.15.0";
+export declare const SDK_VERSION = "0.16.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-pgw-sdk";
-export const SDK_VERSION = "0.15.0";
+export const SDK_VERSION = "0.16.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.15.0",
+  "version": "0.16.0-beta.2",
   "description": "SDK for interacting with FinteqHub processing API",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",