@notabene/javascript-sdk 2.22.0-next.1 → 2.22.0-next.3

package/README.md

@@ -898,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

@@ -1163,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.
@@ -1741,6 +1753,17 @@ declare interface JsonLdObject<T extends string> {
     "@type": T;
 }
 
+/**
+ * Ids of the wallets the embedded component always offers under a fixed id.
+ *
+ * `'ledger-usb-wallet'` and `'ledger-bluetooth-wallet'` are the two Ledger transports,
+ * `'trezor'` is Trezor over Trezor Connect, and `'wallet-connect'` is the WalletConnect
+ * (Reown AppKit) card that lists mobile wallets.
+ *
+ * @public
+ */
+export declare type KnownWalletId = 'ledger-usb-wallet' | 'ledger-bluetooth-wallet' | 'trezor' | 'wallet-connect';
+
 declare type LegalEntityNationalIdentifierTypeCode = Omit<NationalIdentifierTypeCode_2, "ARNU" | "CCPT" | "DRLC" | "SOCS" | "IDCD">;
 
 /**
@@ -3356,7 +3379,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;
@@ -3417,6 +3445,32 @@ export declare interface TransactionOptions {
          * ```
          */
         allowedWalletConnectIds?: string[];
+        /**
+         * Never offer these wallets in the component's wallet picker, whatever the user's
+         * browser has installed.
+         *
+         * Useful when you don't want to present specific wallets, for example hardware wallets.
+         * This only controls which connectors the component offers. It isn't a policy on
+         * addresses: a user can still reach the same device another way, such as Ledger Live
+         * over WalletConnect, or prove an address with a non-wallet proof type where you allow
+         * one.
+         *
+         * Entries are {@link WalletId}s and are matched case-insensitively. Hardware wallets and
+         * the WalletConnect card have fixed ids, listed in {@link KnownWalletId}. Browser extension
+         * wallets are matched by the id the component discovers them under.
+         *
+         * Disabling `'wallet-connect'` removes the WalletConnect card entirely; to offer some
+         * mobile wallets but not others, use `allowedWalletConnectIds` instead.
+         *
+         * Absent or empty means every discovered wallet is offered.
+         *
+         * @example
+         * ```ts
+         * // No hardware wallets
+         * disabledWallets: ['ledger-usb-wallet', 'ledger-bluetooth-wallet', 'trezor']
+         * ```
+         */
+        disabledWallets?: WalletId[];
     };
 }
 
@@ -3612,6 +3666,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 {
@@ -3698,6 +3755,23 @@ export declare interface Wallet extends Agent {
     wallet_connect_id?: string;
 }
 
+/**
+ * A wallet id as the embedded component reports it, for use in
+ * {@link TransactionOptions.wallets}.
+ *
+ * A {@link KnownWalletId}, or any id of a wallet the component discovers in the user's
+ * browser. Browser extension wallets on EVM chains use their EIP-6963 reverse domain
+ * name, for example `'io.metamask'` or `'com.coinbase.wallet'`. Wallets on other chains
+ * use the chain namespace followed by the wallet's name in lower case, for example
+ * `'solana-phantom'`, `'bitcoin-xverse'`, `'tron-tronlink'`, `'cardano-nami'`,
+ * `'ripple-gemwallet'` or `'concordium-browser'`.
+ *
+ * The component reports every id it discovers in the `wallet_discovered` analytics event.
+ *
+ * @public
+ */
+export declare type WalletId = KnownWalletId | (string & {});
+
 /**
  * Represents a warning component message
  * @param message - Warning message

package/dist/cjs/package.json

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

package/dist/esm/notabene.d.ts

@@ -1163,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.
@@ -1741,6 +1753,17 @@ declare interface JsonLdObject<T extends string> {
     "@type": T;
 }
 
+/**
+ * Ids of the wallets the embedded component always offers under a fixed id.
+ *
+ * `'ledger-usb-wallet'` and `'ledger-bluetooth-wallet'` are the two Ledger transports,
+ * `'trezor'` is Trezor over Trezor Connect, and `'wallet-connect'` is the WalletConnect
+ * (Reown AppKit) card that lists mobile wallets.
+ *
+ * @public
+ */
+export declare type KnownWalletId = 'ledger-usb-wallet' | 'ledger-bluetooth-wallet' | 'trezor' | 'wallet-connect';
+
 declare type LegalEntityNationalIdentifierTypeCode = Omit<NationalIdentifierTypeCode_2, "ARNU" | "CCPT" | "DRLC" | "SOCS" | "IDCD">;
 
 /**
@@ -3356,7 +3379,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;
@@ -3417,6 +3445,32 @@ export declare interface TransactionOptions {
          * ```
          */
         allowedWalletConnectIds?: string[];
+        /**
+         * Never offer these wallets in the component's wallet picker, whatever the user's
+         * browser has installed.
+         *
+         * Useful when you don't want to present specific wallets, for example hardware wallets.
+         * This only controls which connectors the component offers. It isn't a policy on
+         * addresses: a user can still reach the same device another way, such as Ledger Live
+         * over WalletConnect, or prove an address with a non-wallet proof type where you allow
+         * one.
+         *
+         * Entries are {@link WalletId}s and are matched case-insensitively. Hardware wallets and
+         * the WalletConnect card have fixed ids, listed in {@link KnownWalletId}. Browser extension
+         * wallets are matched by the id the component discovers them under.
+         *
+         * Disabling `'wallet-connect'` removes the WalletConnect card entirely; to offer some
+         * mobile wallets but not others, use `allowedWalletConnectIds` instead.
+         *
+         * Absent or empty means every discovered wallet is offered.
+         *
+         * @example
+         * ```ts
+         * // No hardware wallets
+         * disabledWallets: ['ledger-usb-wallet', 'ledger-bluetooth-wallet', 'trezor']
+         * ```
+         */
+        disabledWallets?: WalletId[];
     };
 }
 
@@ -3612,6 +3666,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 {
@@ -3698,6 +3755,23 @@ export declare interface Wallet extends Agent {
     wallet_connect_id?: string;
 }
 
+/**
+ * A wallet id as the embedded component reports it, for use in
+ * {@link TransactionOptions.wallets}.
+ *
+ * A {@link KnownWalletId}, or any id of a wallet the component discovers in the user's
+ * browser. Browser extension wallets on EVM chains use their EIP-6963 reverse domain
+ * name, for example `'io.metamask'` or `'com.coinbase.wallet'`. Wallets on other chains
+ * use the chain namespace followed by the wallet's name in lower case, for example
+ * `'solana-phantom'`, `'bitcoin-xverse'`, `'tron-tronlink'`, `'cardano-nami'`,
+ * `'ripple-gemwallet'` or `'concordium-browser'`.
+ *
+ * The component reports every id it discovers in the `wallet_discovered` analytics event.
+ *
+ * @public
+ */
+export declare type WalletId = KnownWalletId | (string & {});
+
 /**
  * Represents a warning component message
  * @param message - Warning message

package/dist/esm/package.json

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

package/dist/notabene.d.ts

@@ -1163,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.
@@ -1741,6 +1753,17 @@ declare interface JsonLdObject<T extends string> {
     "@type": T;
 }
 
+/**
+ * Ids of the wallets the embedded component always offers under a fixed id.
+ *
+ * `'ledger-usb-wallet'` and `'ledger-bluetooth-wallet'` are the two Ledger transports,
+ * `'trezor'` is Trezor over Trezor Connect, and `'wallet-connect'` is the WalletConnect
+ * (Reown AppKit) card that lists mobile wallets.
+ *
+ * @public
+ */
+export declare type KnownWalletId = 'ledger-usb-wallet' | 'ledger-bluetooth-wallet' | 'trezor' | 'wallet-connect';
+
 declare type LegalEntityNationalIdentifierTypeCode = Omit<NationalIdentifierTypeCode_2, "ARNU" | "CCPT" | "DRLC" | "SOCS" | "IDCD">;
 
 /**
@@ -3356,7 +3379,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;
@@ -3417,6 +3445,32 @@ export declare interface TransactionOptions {
          * ```
          */
         allowedWalletConnectIds?: string[];
+        /**
+         * Never offer these wallets in the component's wallet picker, whatever the user's
+         * browser has installed.
+         *
+         * Useful when you don't want to present specific wallets, for example hardware wallets.
+         * This only controls which connectors the component offers. It isn't a policy on
+         * addresses: a user can still reach the same device another way, such as Ledger Live
+         * over WalletConnect, or prove an address with a non-wallet proof type where you allow
+         * one.
+         *
+         * Entries are {@link WalletId}s and are matched case-insensitively. Hardware wallets and
+         * the WalletConnect card have fixed ids, listed in {@link KnownWalletId}. Browser extension
+         * wallets are matched by the id the component discovers them under.
+         *
+         * Disabling `'wallet-connect'` removes the WalletConnect card entirely; to offer some
+         * mobile wallets but not others, use `allowedWalletConnectIds` instead.
+         *
+         * Absent or empty means every discovered wallet is offered.
+         *
+         * @example
+         * ```ts
+         * // No hardware wallets
+         * disabledWallets: ['ledger-usb-wallet', 'ledger-bluetooth-wallet', 'trezor']
+         * ```
+         */
+        disabledWallets?: WalletId[];
     };
 }
 
@@ -3612,6 +3666,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 {
@@ -3698,6 +3755,23 @@ export declare interface Wallet extends Agent {
     wallet_connect_id?: string;
 }
 
+/**
+ * A wallet id as the embedded component reports it, for use in
+ * {@link TransactionOptions.wallets}.
+ *
+ * A {@link KnownWalletId}, or any id of a wallet the component discovers in the user's
+ * browser. Browser extension wallets on EVM chains use their EIP-6963 reverse domain
+ * name, for example `'io.metamask'` or `'com.coinbase.wallet'`. Wallets on other chains
+ * use the chain namespace followed by the wallet's name in lower case, for example
+ * `'solana-phantom'`, `'bitcoin-xverse'`, `'tron-tronlink'`, `'cardano-nami'`,
+ * `'ripple-gemwallet'` or `'concordium-browser'`.
+ *
+ * The component reports every id it discovers in the `wallet_discovered` analytics event.
+ *
+ * @public
+ */
+export declare type WalletId = KnownWalletId | (string & {});
+
 /**
  * Represents a warning component message
  * @param message - Warning message

package/package.json

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

package/src/notabene.ts

@@ -30,10 +30,12 @@ import type {
   Error,
   FieldOptions,
   FieldTypes,
+  HideSection,
   HostMessage,
   InvalidValue,
   InvoiceReaderResponse,
   IVMS101,
+  KnownWalletId,
   LegalPerson,
   LegalPersonFieldName,
   LegalPersonFields,
@@ -67,6 +69,7 @@ import type {
   VASPOptions,
   VASPTrustStatus,
   Wallet,
+  WalletId,
   Withdrawal,
 } from './types';
 import {
@@ -159,10 +162,12 @@ export type {
   Error,
   FieldOptions,
   FieldTypes,
+  HideSection,
   HostMessage,
   InvalidValue,
   InvoiceReaderResponse,
   IVMS101,
+  KnownWalletId,
   LegalPerson,
   LegalPersonFieldName,
   LegalPersonFields,
@@ -197,6 +202,7 @@ export type {
   VASPOptions,
   VASPTrustStatus,
   Wallet,
+  WalletId,
   Withdrawal,
 };
 

package/src/types.ts

@@ -914,9 +914,61 @@ export type CounterpartyAssistConfig =
       webhookUrl?: string;
     };
 
+/**
+ * Ids of the wallets the embedded component always offers under a fixed id.
+ *
+ * `'ledger-usb-wallet'` and `'ledger-bluetooth-wallet'` are the two Ledger transports,
+ * `'trezor'` is Trezor over Trezor Connect, and `'wallet-connect'` is the WalletConnect
+ * (Reown AppKit) card that lists mobile wallets.
+ *
+ * @public
+ */
+export type KnownWalletId =
+  | 'ledger-usb-wallet'
+  | 'ledger-bluetooth-wallet'
+  | 'trezor'
+  | 'wallet-connect';
+
+/**
+ * A wallet id as the embedded component reports it, for use in
+ * {@link TransactionOptions.wallets}.
+ *
+ * A {@link KnownWalletId}, or any id of a wallet the component discovers in the user's
+ * browser. Browser extension wallets on EVM chains use their EIP-6963 reverse domain
+ * name, for example `'io.metamask'` or `'com.coinbase.wallet'`. Wallets on other chains
+ * use the chain namespace followed by the wallet's name in lower case, for example
+ * `'solana-phantom'`, `'bitcoin-xverse'`, `'tron-tronlink'`, `'cardano-nami'`,
+ * `'ripple-gemwallet'` or `'concordium-browser'`.
+ *
+ * The component reports every id it discovers in the `wallet_discovered` analytics event.
+ *
+ * @public
+ */
+export type WalletId = KnownWalletId | (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 {
@@ -1053,7 +1105,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
@@ -1114,6 +1171,32 @@ export interface TransactionOptions {
      * ```
      */
     allowedWalletConnectIds?: string[];
+    /**
+     * Never offer these wallets in the component's wallet picker, whatever the user's
+     * browser has installed.
+     *
+     * Useful when you don't want to present specific wallets, for example hardware wallets.
+     * This only controls which connectors the component offers. It isn't a policy on
+     * addresses: a user can still reach the same device another way, such as Ledger Live
+     * over WalletConnect, or prove an address with a non-wallet proof type where you allow
+     * one.
+     *
+     * Entries are {@link WalletId}s and are matched case-insensitively. Hardware wallets and
+     * the WalletConnect card have fixed ids, listed in {@link KnownWalletId}. Browser extension
+     * wallets are matched by the id the component discovers them under.
+     *
+     * Disabling `'wallet-connect'` removes the WalletConnect card entirely; to offer some
+     * mobile wallets but not others, use `allowedWalletConnectIds` instead.
+     *
+     * Absent or empty means every discovered wallet is offered.
+     *
+     * @example
+     * ```ts
+     * // No hardware wallets
+     * disabledWallets: ['ledger-usb-wallet', 'ledger-bluetooth-wallet', 'trezor']
+     * ```
+     */
+    disabledWallets?: WalletId[];
   };
 }
 /**

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,
@@ -295,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()),
     });