@notabene/javascript-sdk 2.17.0 → 2.18.0-next.3

package/docs/README.md

@@ -73,6 +73,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
       - [Full Example](#full-example)
       - [Field reference](#field-reference)
     - [Configure Counterparty Assist](#counterparty-assist-configuration)
+    - [Consent / Terms & Conditions](#consent--terms--conditions)
   - [Locales](#locales)
   - [Theming](#theming)
   - [License](#license)
@@ -767,7 +768,8 @@ const options: TransactionOptions = {
       PersonType.NATURAL, // JS: 'natural'
       PersonType.SELF, // JS: 'self'
     ],
-  }
+  },
+  consent: true, // true (default) | false (hide) | { label?: string, description?: string }
 };
 const withdrawal = notabene.createWithdrawalAssist(tx, options);
 ```
@@ -987,6 +989,37 @@ const options: TransactionOptions = {
 | `lei`                    | --      | ✅    | 🟩      | LEI (Legal Entity Identifier)                 |
 | `countryOfRegistration`  | --      | 🟩    | 🟩      | Country of Registration                       |
 
+### Consent / Terms & Conditions
+
+By default, a consent checkbox is shown when the counterparty agent is a VASP. It asks the user to accept sharing personal information with the receiving/sending exchange. You can configure this behavior using the `consent` option.
+
+- `undefined` or `true`: Show the default consent checkbox (default behavior)
+- `false`: Hide the consent checkbox entirely
+- `{ label?, description? }`: Show the checkbox with custom text
+
+#### Hiding the consent checkbox
+
+```ts
+const options: TransactionOptions = {
+  consent: false,
+};
+```
+
+When hidden, the consent requirement is skipped in validation — the component will complete without requiring the user to check the box.
+
+#### Custom consent text
+
+```ts
+const options: TransactionOptions = {
+  consent: {
+    label: 'I agree to the terms',
+    description: 'By proceeding you agree to share your name and address with the counterparty.',
+  },
+};
+```
+
+Both `label` and `description` are optional — you can override one while keeping the default for the other. Translations are the customer's responsibility when providing custom text.
+
 ## Locales
 
 See [locales](_media/locales.ts) for the list of supported locales.

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.17.0",
+  "version": "2.18.0-next.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",
@@ -107,4 +107,4 @@
       "@commitlint/config-conventional"
     ]
   }
-}
+}

package/src/notabene.ts

@@ -14,6 +14,8 @@ import type {
   ComponentResponse,
   ConnectionOptions,
   ConnectionRequest,
+  ConsentConfig,
+  ContactSupportConfig,
   CosmosMetadata,
   Counterparty,
   CounterpartyAssistConfig,
@@ -74,6 +76,7 @@ import {
   ErrorIdentifierCode,
   HMType,
   IdentityVerificationMethod,
+  InfoIdentifierCode,
   PersonType,
   ProofStatus,
   ProofTypes,
@@ -117,6 +120,7 @@ export {
   ErrorIdentifierCode,
   HMType,
   IdentityVerificationMethod,
+  InfoIdentifierCode,
   PersonType,
   ProofStatus,
   ProofTypes,
@@ -140,6 +144,8 @@ export type {
   ComponentResponse,
   ConnectionOptions,
   ConnectionRequest,
+  ConsentConfig,
+  ContactSupportConfig,
   CosmosMetadata,
   Counterparty,
   CounterpartyAssistConfig,

package/src/types.ts

@@ -922,6 +922,7 @@ export interface ThresholdOptions {
  * - `'signature'` — wallet connection for ownership proof via signature
  * - `'manual-signing'` — ownership proof via manual message signing
  * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
+ * - `'contact-support'` — show a contact support button
  *
  * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
  * Including an option implicitly enables that capability.
@@ -934,7 +935,28 @@ export type SectionOption =
   | 'microtransfer' // ProofTypes.MicroTransfer
   | 'signature'
   | 'manual-signing'
-  | 'add-vasp';
+  | 'add-vasp'
+  | 'contact-support';
+
+/**
+ * Configuration for the contact support action.
+ *
+ * @remarks
+ * Contact support is **enabled** by including `'contact-support'` in
+ * `agentSections.main` or `agentSections.fallback`. This object only
+ * configures the behaviour when the feature is enabled.
+ *
+ * - With `contactSupport: { supportUrl: "..." }` — clicking sends an info
+ *   message to the host **and** attempts to open the URL as a fallback.
+ * - Without `contactSupport` — clicking only sends an info message; the
+ *   host decides what to do.
+ *
+ * @public
+ */
+export interface ContactSupportConfig {
+  /** URL to open when the user clicks the support button */
+  supportUrl: string;
+}
 
 /**
  * Explicit layout configuration for the agent selection step.
@@ -956,6 +978,25 @@ export interface AgentSections {
   fallback?: SectionOption[];
 }
 
+/**
+ * Configuration for the terms and conditions consent checkbox.
+ *
+ * @remarks
+ * - `undefined` or `true`: show default T&C (current behavior)
+ * - `false`: hide T&C entirely
+ * - `{ label?, description? }`: show with custom text (translations are the customer's responsibility)
+ *
+ * @public
+ */
+export type ConsentConfig =
+  | boolean
+  | {
+      /** Custom label text. Replaces the default "Accept terms and conditions". */
+      label?: string;
+      /** Custom description text. Replaces the default sharing-info description. */
+      description?: string;
+    };
+
 /**
  * Configuration options for Transaction components
  * @public
@@ -983,6 +1024,8 @@ export interface TransactionOptions {
   vasps?: VASPOptions;
   hide?: ValidationSections[]; // You can hide a specific section of the component by listing it here
   counterpartyAssist?: CounterpartyAssistConfig;
+  contactSupport?: ContactSupportConfig; // Requires 'contact-support' in agentSections
+  consent?: ConsentConfig; // Defaults to true
   autoSubmit?: boolean; // Defaults to false
 }
 /**
@@ -1111,16 +1154,26 @@ export type Warning = {
   identifier?: WarningIdentifierCode;
 };
 
+/**
+ * Identifier codes for info messages
+ * @public
+ */
+export enum InfoIdentifierCode {
+  CONTACT_SUPPORT = 'CONTACT_SUPPORT',
+}
+
 /**
  * Represents an info component message
  * @param message - Info message
  * @param description - Description of the info message
+ * @param identifier - Identifier code of the info message
  * @public
  */
 export type Info = {
   type: CMType.INFO;
   message: string;
   description?: string;
+  identifier?: InfoIdentifierCode;
 };
 
 /**

package/src/utils/arbitraries.ts

@@ -1,6 +1,7 @@
 import fc from 'fast-check';
 import type {
   Agent,
+  AgentSections,
   BlockchainAddress,
   CAIP10,
   CAIP19,
@@ -9,6 +10,7 @@ import type {
   CallbackOptions,
   ConnectionOptions,
   ConnectionRequest,
+  ContactSupportConfig,
   Counterparty,
   CryptoCredential,
   Deposit,
@@ -19,6 +21,7 @@ import type {
   ISOCurrency,
   ISODate,
   NaturalPerson,
+  SectionOption,
   ThresholdOptions,
   TransactionAsset,
   TransactionOptions,
@@ -236,9 +239,35 @@ export const arbitraryVASPOptions = (): fc.Arbitrary<VASPOptions> =>
     }),
   );
 
+const SECTION_OPTIONS: SectionOption[] = [
+  'self-declaration',
+  'screenshot',
+  'microtransfer',
+  'signature',
+  'manual-signing',
+  'add-vasp',
+  'contact-support',
+];
+
+export const arbitrarySectionOption = (): fc.Arbitrary<SectionOption> =>
+  fc.constantFrom(...SECTION_OPTIONS);
+
+export const arbitraryAgentSections = (): fc.Arbitrary<AgentSections> =>
+  fc.record({
+    main: fc.option(fc.array(arbitrarySectionOption())),
+    fallback: fc.option(fc.array(arbitrarySectionOption())),
+  });
+
+export const arbitraryContactSupportConfig =
+  (): fc.Arbitrary<ContactSupportConfig> =>
+    fc.record({
+      supportUrl: fc.webUrl(),
+    });
+
 export const arbitraryTransactionOptions =
   (): fc.Arbitrary<TransactionOptions> =>
     fc.record({
+      agentSections: fc.option(arbitraryAgentSections()),
       proofs: fc.option(
         fc.record({
           microTransfer: fc.option(
@@ -265,6 +294,7 @@ export const arbitraryTransactionOptions =
       hide: fc.option(
         fc.array(fc.constantFrom(...Object.values(ValidationSections))),
       ),
+      contactSupport: fc.option(arbitraryContactSupportConfig()),
     });
 
 export const arbitraryDepositRequestOptions =