@notabene/javascript-sdk 2.14.2 → 2.15.0-next.1

package/dist/cjs/notabene.d.ts

@@ -73,6 +73,26 @@ export declare interface Agent {
     verified?: boolean;
 }
 
+/**
+ * Explicit layout configuration for the agent selection step.
+ *
+ * @remarks
+ * Controls which options appear in the main selection area vs. behind the
+ * "Can't find what you're looking for?" fallback toggle.
+ *
+ * When the main section has no options (empty or all filtered out), fallback options
+ * are promoted and shown inline. When the main section has only one option, a dedicated
+ * single-option layout is used.
+ *
+ * @public
+ */
+export declare interface AgentSections {
+    /** Options shown in the main selection area (always visible) */
+    main?: SectionOption[];
+    /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
+    fallback?: SectionOption[];
+}
+
 /**
  * The type of Agent. Either a wallet or a VASP
  * @public
@@ -653,6 +673,7 @@ export declare interface Counterparty {
  */
 export declare type CounterpartyAssistConfig = boolean | {
     counterpartyTypes: PersonType[];
+    /** @remarks Requires a transactionId to be passed in. */
     identityVerification?: IdentityVerificationConfig;
 };
 
@@ -938,8 +959,6 @@ export declare type HostMessage<T, O> = UpdateValue<T, O>;
 declare type IdentityVerificationConfig = {
     /** The required verification method. If not specified, none will be used */
     requiredMethod?: IdentityVerificationMethod;
-    /** OAuth provider(s) to use for authentication. Can be a single provider or array of providers */
-    oAuth?: OAuthProvider[] | OAuthProvider;
 };
 
 /**
@@ -947,8 +966,7 @@ declare type IdentityVerificationConfig = {
  * @public
  */
 export declare enum IdentityVerificationMethod {
-    SMS = "sms",
-    EMAIL = "email"
+    SMS = "sms"
 }
 
 /**
@@ -1327,15 +1345,6 @@ declare type NaturalPersonV2 = Omit<NaturalPerson_2, 'name'> & {
     name: NaturalPersonNameV2;
 };
 
-/**
- * Primary constructor for Notabene UX elements
- *
- * This class provides methods to create and manage various Notabene components
- * such as withdrawal assist, deposit assist, connect, and deposit request.
- * It also handles URL generation and fragment decoding for these components.
- *
- * @public
- */
 declare class Notabene {
     private nodeUrl?;
     private authToken?;
@@ -1460,14 +1469,6 @@ export declare interface NotabeneConfig {
     locale?: string;
 }
 
-/**
- * Supported OAuth providers for authentication
- * @public
- */
-export declare enum OAuthProvider {
-    COINBASE = "coinbase"
-}
-
 /**
  * Originating VASP
  * Represents the VASP which initiates the VA transfer
@@ -1713,6 +1714,25 @@ export declare interface ScreenshotProof extends OwnershipProof {
     url: string;
 }
 
+/**
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
+ *
+ * @remarks
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
+ * - `'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)
+ *
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
+ * Including an option implicitly enables that capability.
+ *
+ * @public
+ */
+export declare type SectionOption = ProofTypes.SelfDeclaration | ProofTypes.Screenshot | ProofTypes.MicroTransfer | 'signature' | 'manual-signing' | 'add-vasp';
+
 /**
  * Interface for signature-based ownership proofs that use cryptographic message signing
  *
@@ -1933,6 +1953,11 @@ export declare interface TransactionIVMS101Request {
  * @public
  */
 export declare interface TransactionOptions {
+    /**
+     * Explicit layout configuration for the agent selection step.
+     * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
+     */
+    agentSections?: AgentSections;
     proofs?: {
         reuseProof?: boolean;
         microTransfer?: {

package/dist/cjs/package.json

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

package/dist/esm/notabene.d.ts

@@ -73,6 +73,26 @@ export declare interface Agent {
     verified?: boolean;
 }
 
+/**
+ * Explicit layout configuration for the agent selection step.
+ *
+ * @remarks
+ * Controls which options appear in the main selection area vs. behind the
+ * "Can't find what you're looking for?" fallback toggle.
+ *
+ * When the main section has no options (empty or all filtered out), fallback options
+ * are promoted and shown inline. When the main section has only one option, a dedicated
+ * single-option layout is used.
+ *
+ * @public
+ */
+export declare interface AgentSections {
+    /** Options shown in the main selection area (always visible) */
+    main?: SectionOption[];
+    /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
+    fallback?: SectionOption[];
+}
+
 /**
  * The type of Agent. Either a wallet or a VASP
  * @public
@@ -653,6 +673,7 @@ export declare interface Counterparty {
  */
 export declare type CounterpartyAssistConfig = boolean | {
     counterpartyTypes: PersonType[];
+    /** @remarks Requires a transactionId to be passed in. */
     identityVerification?: IdentityVerificationConfig;
 };
 
@@ -938,8 +959,6 @@ export declare type HostMessage<T, O> = UpdateValue<T, O>;
 declare type IdentityVerificationConfig = {
     /** The required verification method. If not specified, none will be used */
     requiredMethod?: IdentityVerificationMethod;
-    /** OAuth provider(s) to use for authentication. Can be a single provider or array of providers */
-    oAuth?: OAuthProvider[] | OAuthProvider;
 };
 
 /**
@@ -947,8 +966,7 @@ declare type IdentityVerificationConfig = {
  * @public
  */
 export declare enum IdentityVerificationMethod {
-    SMS = "sms",
-    EMAIL = "email"
+    SMS = "sms"
 }
 
 /**
@@ -1327,15 +1345,6 @@ declare type NaturalPersonV2 = Omit<NaturalPerson_2, 'name'> & {
     name: NaturalPersonNameV2;
 };
 
-/**
- * Primary constructor for Notabene UX elements
- *
- * This class provides methods to create and manage various Notabene components
- * such as withdrawal assist, deposit assist, connect, and deposit request.
- * It also handles URL generation and fragment decoding for these components.
- *
- * @public
- */
 declare class Notabene {
     private nodeUrl?;
     private authToken?;
@@ -1460,14 +1469,6 @@ export declare interface NotabeneConfig {
     locale?: string;
 }
 
-/**
- * Supported OAuth providers for authentication
- * @public
- */
-export declare enum OAuthProvider {
-    COINBASE = "coinbase"
-}
-
 /**
  * Originating VASP
  * Represents the VASP which initiates the VA transfer
@@ -1713,6 +1714,25 @@ export declare interface ScreenshotProof extends OwnershipProof {
     url: string;
 }
 
+/**
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
+ *
+ * @remarks
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
+ * - `'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)
+ *
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
+ * Including an option implicitly enables that capability.
+ *
+ * @public
+ */
+export declare type SectionOption = ProofTypes.SelfDeclaration | ProofTypes.Screenshot | ProofTypes.MicroTransfer | 'signature' | 'manual-signing' | 'add-vasp';
+
 /**
  * Interface for signature-based ownership proofs that use cryptographic message signing
  *
@@ -1933,6 +1953,11 @@ export declare interface TransactionIVMS101Request {
  * @public
  */
 export declare interface TransactionOptions {
+    /**
+     * Explicit layout configuration for the agent selection step.
+     * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
+     */
+    agentSections?: AgentSections;
     proofs?: {
         reuseProof?: boolean;
         microTransfer?: {