@notabene/javascript-sdk 2.21.0 → 2.22.0-next.2

package/README.md

@@ -377,15 +377,19 @@ The Connect Wallet component helps you collect and verify the address of your us
 ### Parameters
 
 - `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+- `address`: Optional account to collect a proof for, as a blockchain address or CAIP-10 identifier. When set, the component narrows the connected wallet to this account and only offers to verify that one; connecting fails if the wallet does not hold it. When omitted, the user chooses which of their addresses to prove.
 
 ```js
 const connect = notabene.createConnectWallet({
   asset: 'ETH',
+  address: '0x...',
 });
 
 const { proof, txCreate } = await connect.openModal();
 ```
 
+The proved account is returned on `proof.address` as a CAIP-10 identifier.
+
 ## Deposit Request
 
 The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
@@ -894,7 +898,7 @@ const options: TransactionOptions = {
   contactSupport: { // Configures the contact support button (enabled via agentSections)
     supportUrl: 'https://support.example.com',
   },
-  hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
+  hide: ['asset', 'destination'], // Don't show specific sections of component. Also accepts 'header' to drop the card header (icon, title, description, participant logo)
   autoSubmit: false // Automatically sends the complete event and hides the complete button -  Default false
 };
 

package/dist/cjs/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
@@ -1149,6 +1163,18 @@ export declare type FieldTypes = {
  */
 export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: Pick<RefreshSource, 'url' | 'key'>): Promise<ConnectionResult<T>>;
 
+/**
+ * A section of a WithdrawalAssist or DepositAssist screen that can be left out,
+ * via {@link TransactionOptions.hide}.
+ *
+ * `'header'` is the card header — its status icon, title, description and
+ * participant logo. The card body and footer are unaffected, so the Notabene
+ * attribution in the footer still shows.
+ *
+ * @public
+ */
+export declare type HideSection = 'asset' | 'destination' | 'counterparty' | 'agent' | 'header';
+
 /**
  * Host Message Type enum representing different message types that can be sent
  * from the host application.
@@ -3342,7 +3368,12 @@ export declare interface TransactionOptions {
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
     vasps?: VASPOptions;
-    hide?: ValidationSections[];
+    /**
+     * Sections of the component to leave out. Hiding `'header'` is useful when the
+     * surrounding page already states what the user is being asked to do, so ours
+     * would repeat or contradict it.
+     */
+    hide?: HideSection[];
     counterpartyAssist?: CounterpartyAssistConfig;
     contactSupport?: ContactSupportConfig;
     consent?: ConsentConfig;
@@ -3598,6 +3629,9 @@ export declare type ValidationError = {
 /**
  * Sections in a WithdrawalAssist screen
  *
+ * @deprecated Use {@link HideSection} instead. Members stay assignable to their
+ * literals, so existing callers keep compiling.
+ *
  * @alpha
  */
 export declare enum ValidationSections {

package/dist/cjs/package.json

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

package/dist/esm/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
@@ -1149,6 +1163,18 @@ export declare type FieldTypes = {
  */
 export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: Pick<RefreshSource, 'url' | 'key'>): Promise<ConnectionResult<T>>;
 
+/**
+ * A section of a WithdrawalAssist or DepositAssist screen that can be left out,
+ * via {@link TransactionOptions.hide}.
+ *
+ * `'header'` is the card header — its status icon, title, description and
+ * participant logo. The card body and footer are unaffected, so the Notabene
+ * attribution in the footer still shows.
+ *
+ * @public
+ */
+export declare type HideSection = 'asset' | 'destination' | 'counterparty' | 'agent' | 'header';
+
 /**
  * Host Message Type enum representing different message types that can be sent
  * from the host application.
@@ -3342,7 +3368,12 @@ export declare interface TransactionOptions {
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
     vasps?: VASPOptions;
-    hide?: ValidationSections[];
+    /**
+     * Sections of the component to leave out. Hiding `'header'` is useful when the
+     * surrounding page already states what the user is being asked to do, so ours
+     * would repeat or contradict it.
+     */
+    hide?: HideSection[];
     counterpartyAssist?: CounterpartyAssistConfig;
     contactSupport?: ContactSupportConfig;
     consent?: ConsentConfig;
@@ -3598,6 +3629,9 @@ export declare type ValidationError = {
 /**
  * Sections in a WithdrawalAssist screen
  *
+ * @deprecated Use {@link HideSection} instead. Members stay assignable to their
+ * literals, so existing callers keep compiling.
+ *
  * @alpha
  */
 export declare enum ValidationSections {

package/dist/esm/package.json

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

package/dist/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
@@ -1149,6 +1163,18 @@ export declare type FieldTypes = {
  */
 export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: Pick<RefreshSource, 'url' | 'key'>): Promise<ConnectionResult<T>>;
 
+/**
+ * A section of a WithdrawalAssist or DepositAssist screen that can be left out,
+ * via {@link TransactionOptions.hide}.
+ *
+ * `'header'` is the card header — its status icon, title, description and
+ * participant logo. The card body and footer are unaffected, so the Notabene
+ * attribution in the footer still shows.
+ *
+ * @public
+ */
+export declare type HideSection = 'asset' | 'destination' | 'counterparty' | 'agent' | 'header';
+
 /**
  * Host Message Type enum representing different message types that can be sent
  * from the host application.
@@ -3342,7 +3368,12 @@ export declare interface TransactionOptions {
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
     vasps?: VASPOptions;
-    hide?: ValidationSections[];
+    /**
+     * Sections of the component to leave out. Hiding `'header'` is useful when the
+     * surrounding page already states what the user is being asked to do, so ours
+     * would repeat or contradict it.
+     */
+    hide?: HideSection[];
     counterpartyAssist?: CounterpartyAssistConfig;
     contactSupport?: ContactSupportConfig;
     consent?: ConsentConfig;
@@ -3598,6 +3629,9 @@ export declare type ValidationError = {
 /**
  * Sections in a WithdrawalAssist screen
  *
+ * @deprecated Use {@link HideSection} instead. Members stay assignable to their
+ * literals, so existing callers keep compiling.
+ *
  * @alpha
  */
 export declare enum ValidationSections {

package/package.json

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

package/src/notabene.ts

@@ -30,6 +30,7 @@ import type {
   Error,
   FieldOptions,
   FieldTypes,
+  HideSection,
   HostMessage,
   InvalidValue,
   InvoiceReaderResponse,
@@ -159,6 +160,7 @@ export type {
   Error,
   FieldOptions,
   FieldTypes,
+  HideSection,
   HostMessage,
   InvalidValue,
   InvoiceReaderResponse,

package/src/types.ts

@@ -641,6 +641,20 @@ export interface InvoiceReaderResponse {
  */
 export interface ConnectionRequest extends ComponentRequest {
   asset: TransactionAsset;
+  /**
+   * The account to collect a proof for.
+   *
+   * @remarks
+   * When set, the component narrows the connected wallet to this account and
+   * only offers to verify that one, instead of letting the user pick any
+   * address the wallet reports. Connecting fails if the wallet does not hold
+   * it. When omitted, the user chooses which of their addresses to prove.
+   *
+   * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+   *
+   * @see {@link OwnershipProof.address} For the proved account on the response
+   */
+  address?: BlockchainAddress | CAIP10;
 }
 
 /**
@@ -900,9 +914,29 @@ export type CounterpartyAssistConfig =
       webhookUrl?: string;
     };
 
+/**
+ * A section of a WithdrawalAssist or DepositAssist screen that can be left out,
+ * via {@link TransactionOptions.hide}.
+ *
+ * `'header'` is the card header — its status icon, title, description and
+ * participant logo. The card body and footer are unaffected, so the Notabene
+ * attribution in the footer still shows.
+ *
+ * @public
+ */
+export type HideSection =
+  | 'asset'
+  | 'destination'
+  | 'counterparty'
+  | 'agent'
+  | 'header';
+
 /**
  * Sections in a WithdrawalAssist screen
  *
+ * @deprecated Use {@link HideSection} instead. Members stay assignable to their
+ * literals, so existing callers keep compiling.
+ *
  * @alpha
  */
 export enum ValidationSections {
@@ -1039,7 +1073,12 @@ export interface TransactionOptions {
   allowedCounterpartyTypes?: PersonType[]; // Defaults to All
   fields?: FieldTypes;
   vasps?: VASPOptions;
-  hide?: ValidationSections[]; // You can hide a specific section of the component by listing it here
+  /**
+   * Sections of the component to leave out. Hiding `'header'` is useful when the
+   * surrounding page already states what the user is being asked to do, so ours
+   * would repeat or contradict it.
+   */
+  hide?: HideSection[];
   counterpartyAssist?: CounterpartyAssistConfig;
   contactSupport?: ContactSupportConfig; // Requires 'contact-support' in agentSections
   consent?: ConsentConfig; // Defaults to true

package/src/utils/arbitraries.ts

@@ -18,6 +18,7 @@ import type {
   DepositRequestOptions,
   DID,
   FieldTypes,
+  HideSection,
   ISOCurrency,
   ISODate,
   NaturalPerson,
@@ -30,13 +31,7 @@ import type {
   VASPTrustStatus,
   Withdrawal,
 } from '../types';
-import {
-  AgentType,
-  PersonType,
-  ProofTypes,
-  ValidationSections,
-  VASPSearchControl,
-} from '../types';
+import { AgentType, PersonType, ProofTypes, VASPSearchControl } from '../types';
 import {
   CAIP10_MATCHER,
   CAIP19_MATCHER,
@@ -125,6 +120,9 @@ export const arbitraryConnectionRequest = (): fc.Arbitrary<ConnectionRequest> =>
     asset: arbitraryTransactionAsset(),
     requestId: fc.option(fc.uuid()),
     customer: fc.option(arbitraryCounterparty()),
+    address: fc.option(
+      fc.oneof(arbitraryBlockchainAddress(), arbitraryCAIP10()),
+    ),
   });
 
 // Helper for ISO date format
@@ -292,7 +290,15 @@ export const arbitraryTransactionOptions =
       fields: fc.option(arbitraryFieldTypes()),
       vasps: fc.option(arbitraryVASPOptions()),
       hide: fc.option(
-        fc.array(fc.constantFrom(...Object.values(ValidationSections))),
+        fc.array(
+          fc.constantFrom<HideSection>(
+            'asset',
+            'destination',
+            'counterparty',
+            'agent',
+            'header',
+          ),
+        ),
       ),
       contactSupport: fc.option(arbitraryContactSupportConfig()),
     });