@notabene/javascript-sdk 2.9.2 → 2.9.3

package/README.md

@@ -436,11 +436,11 @@ If any of the required parameters are missing the component will just show the N
 
 ---
 
-## Counterparty Assist
+## Counterparty Handoff
 
-The **Counterparty Assist** feature enables handoff of data collection to a counterparty or to another device by sharing a secure link. This facilitates more accurate and complete data collection, particularly when the counterparty is able to provide the required information directly.
+**Counterparty Assist** is a feature built into the existing **Withdrawal** and **Deposit Assist** components. When enabled, it allows users to hand off data collection to a counterparty — or to another device — by sharing a secure link. This helps ensure more accurate and complete information, especially when the counterparty is best suited to provide the required data.
 
-This feature can be enabled globally for all counterparty types or selectively for specific types.
+This feature does not function as a standalone component. Instead, it augments the Withdrawal and Deposit flows when configured.
 
 ### Use Cases
 
@@ -454,33 +454,27 @@ During the address verification step, users can share a link to complete self-ho
 
 ### Counterparty Assist Configuration
 
-You can enable **Counterparty Assist** via the `counterpartyAssist` configuration field in one of the following ways:
+You can enable **Counterparty Assist** by specifying the counterparty types you want the feature to apply to using the counterpartyAssist configuration field.
 
-- `true`: Enable for all counterparty types (`self`, `natural`, and `legal`)
-- `false`: Disable the feature entirely
+- `false`: Disable the feature explicitly
+- `undefined` (not configured): Feature is disabled by default
 - `{ counterpartyTypes: [PersonType.SELF, PersonType.NATURAL, PersonType.LEGAL] }`: Enable for specific counterparty types
 
 **Example Config**
 
-```ts
+```js
 import Notabene, {
   PersonType,
 } from '@notabene/javascript-sdk';
 
-// Counterparty assist is enabled for all counterparty types
-const optionsAllEnabled: TransactionOptions = {
-  ...
-  counterpartyAssist: true, // 'self', 'natural', and 'legal' enabled
-};
-
 // Counterparty assist is enabled for specific counterparty types
 const options: TransactionOptions = {
   ...
   counterpartyAssist: {
     counterpartyTypes: [
-      PersonType.LEGAL, // JS: 'legal'
+      PersonType.LEGAL,   // JS: 'legal'
       PersonType.NATURAL, // JS: 'natural'
-      PersonType.SELF, // JS: 'self'
+      PersonType.SELF,    // JS: 'self'
     ],
   }
 };
@@ -503,7 +497,7 @@ When a third party completes their step after following the shared link, the hos
 
 **Example Response**
 
-```json
+```js
 {
   type: CMType.COMPLETE, // 'complete'
   response: { // transaciton data + refresh source
@@ -549,7 +543,7 @@ To simplify retrieval and decryption, we provide an asynchronous [`getRefreshRes
 
 **Example**
 
-```ts
+```js
 import { getRefreshResult } from "@notabene/javascript-sdk";
 
 const transaction = await getRefreshResult({
@@ -571,7 +565,7 @@ const transaction = await getRefreshResult({
 
 **Example Active Transaction Data**
 
-```json
+```js
 {
   "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
   "metadata": {
@@ -583,14 +577,14 @@ const transaction = await getRefreshResult({
   },
   "status": "active",
   "tx": {
-    ...
+    //...
   }
 }
 ```
 
 **Example Completed Transaction Data**
 
-```json
+```js
 {
   "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
   "metadata": {
@@ -603,19 +597,19 @@ const transaction = await getRefreshResult({
   "status": "completed",
   "result": { // the response returned from the embedded component when all information is successfully collected
     "proof": {
-      ...
+      //...
     },
     "txCreate": {
-      ...
+      //...
     },
     "errors": [],
     "status": "pending",
     "valid": true,
     "value": {
-      ...
+      //...
     },
     "ivms101": {
-      ...
+      //...
     }
   }
 }

package/dist/cjs/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.2",
+  "version": "2.9.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/dist/esm/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.2",
+  "version": "2.9.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.2",
+  "version": "2.9.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",