@finteqhub/sdk-js 0.17.0-beta.1 → 0.17.0

package/CHANGELOG.md

@@ -1,21 +1,21 @@
 # Changelog
 
-Notable changes to `@finteqhub/sdk-js`. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Notable changes to the SDK. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## 0.17.0
 
 ### Breaking changes
 
-- `FinteqHubProcessing` was renamed to `Processing`. The old name is no longer exported.
-- The constructor takes a single options object instead of positional arguments. The object is validated like the positional arguments were; passing positional arguments throws `TypeError: sdk-js: constructor expects an options object`. The new `ProcessingOptions` type is exported.
+- The SDK class is now exported as `Processing`; the previous class name is no longer exported.
+- The constructor takes a single options object instead of positional arguments. The object is validated like the positional arguments were; passing positional arguments throws `TypeError: sdk-js: constructor expects an options object`. Unknown keys are rejected too (`TypeError: sdk-js: unknown option "issecure"`), so a misspelled option, or a `merchantId` left over from 0.15.0, fails loudly instead of silently falling back to the default. The new `ProcessingOptions` type is exported.
 
 Migration:
 
 ```
-// 0.16.0
-new FinteqHubProcessing(apiUrl, fingerprintVisitorId, sessionId, isSecure, retryOptions);
+// 0.16.0: positional arguments
+(apiUrl, fingerprintVisitorId, sessionId, isSecure, retryOptions)
 
-// 0.17.0
+// 0.17.0: an options object
 new Processing({ apiUrl, fingerprintVisitorId, sessionId, isSecure, retryOptions });
 ```
 
@@ -26,7 +26,7 @@ new Processing({ apiUrl, fingerprintVisitorId, sessionId, isSecure, retryOptions
 ### 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`).
+- The `merchantId` constructor argument was removed together with the header. The constructor arguments are now `(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
 
@@ -60,7 +60,7 @@ No code changes: the SDK behaves exactly as in 0.13.0 (only the version reported
 
 ### Breaking changes
 
-- The SDK identification header sent with every request was renamed from `X-Finteqhub-SDK` to `x-pgw-sdk`, now spelled in lower case to match the other headers the SDK sends. Header names are case-insensitive, so only the name itself changed; the value format (`sdk-js/<version>`) is unchanged.
+- The SDK identification header sent with every request was renamed to `x-pgw-sdk`, spelled in lower case to match the other headers the SDK sends. Backends that read the header by its previous name must switch to `x-pgw-sdk`; the value format (`sdk-js/<version>`) is unchanged.
 
 ## 0.12.0
 

package/README.md

@@ -1,6 +1,6 @@
 # processing-sdk
 
-Use `new Processing(options: ProcessingOptions)` to create an instance of the Processing object. The Processing object is your entrypoint to FinteqHub processing SDK.
+Use `new Processing(options: ProcessingOptions)` to create an instance of the Processing object. The Processing object is your entrypoint to the processing SDK.
 
 ```
 interface ProcessingOptions {
@@ -18,7 +18,7 @@ const processing = new Processing({
 });
 ```
 
-The constructor validates its options and throws a `TypeError` when they are not an object, 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)).
+The constructor validates its options and throws a `TypeError` when they are not an object, when they contain an unknown key (for example a misspelled `issecure`), 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
 
@@ -77,7 +77,7 @@ Every request the SDK makes carries an extra header:
 x-pgw-sdk: sdk-js/<version>
 ```
 
-The value contains the SDK name and version (kept in sync with `package.json` by a test) — for example `sdk-js/0.11.0`. FinteqHub uses this header to identify traffic coming from the official SDK integration — for example to notify affected merchants when a security fix is released. It does not affect authentication or request routing.
+The value contains the SDK name and version (kept in sync with `package.json` by a test) — for example `sdk-js/0.11.0`. The backend uses this header to identify traffic coming from the official SDK integration — for example to notify affected merchants when a security fix is released. It does not affect authentication or request routing.
 
 The header is added automatically to every request and cannot be disabled.
 

package/dist/src/utils.js

@@ -50,11 +50,18 @@ export function getDeviceType() {
     return DeviceType.Unknown;
 }
 const REQUIRED_STRINGS = ["apiUrl", "fingerprintVisitorId", "sessionId"];
+const KNOWN_OPTIONS = [...REQUIRED_STRINGS, "isSecure", "retryOptions"];
 export function validateArguments(options) {
     // catches callers still using the positional signature from 0.16.0 and earlier
     if (typeof options !== "object" || options === null) {
         throw new TypeError("sdk-js: constructor expects an options object");
     }
+    // a misspelled key (e.g. `issecure`) would otherwise silently fall back to the default
+    for (const key of Object.keys(options)) {
+        if (!KNOWN_OPTIONS.includes(key)) {
+            throw new TypeError(`sdk-js: unknown option "${key}"`);
+        }
+    }
     for (const key of REQUIRED_STRINGS) {
         if (typeof options[key] !== "string" || options[key] === "") {
             throw new TypeError(`sdk-js: ${key} must be a non-empty string`);

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.17.0-beta.1";
+export declare const SDK_VERSION = "0.17.0";
 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.17.0-beta.1";
+export const SDK_VERSION = "0.17.0";
 export const SDK_HEADER_VALUE = `sdk-js/${SDK_VERSION}`;

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@finteqhub/sdk-js",
-  "version": "0.17.0-beta.1",
-  "description": "SDK for interacting with FinteqHub processing API",
+  "version": "0.17.0",
+  "description": "SDK for interacting with the processing API",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "files": [
     "dist/*",
     "CHANGELOG.md"
   ],
-  "author": "FinteqHub",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/finteqhub/sdk-js.git"