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

package/dist/cjs/notabene.d.ts

@@ -1753,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">;
 
 /**
@@ -3434,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[];
     };
 }
 
@@ -3718,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.2",
+  "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

@@ -1753,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">;
 
 /**
@@ -3434,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[];
     };
 }
 
@@ -3718,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.2",
+  "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

@@ -1753,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">;
 
 /**
@@ -3434,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[];
     };
 }
 
@@ -3718,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.2",
+  "version": "2.22.0-next.3",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/src/notabene.ts

@@ -35,6 +35,7 @@ import type {
   InvalidValue,
   InvoiceReaderResponse,
   IVMS101,
+  KnownWalletId,
   LegalPerson,
   LegalPersonFieldName,
   LegalPersonFields,
@@ -68,6 +69,7 @@ import type {
   VASPOptions,
   VASPTrustStatus,
   Wallet,
+  WalletId,
   Withdrawal,
 } from './types';
 import {
@@ -165,6 +167,7 @@ export type {
   InvalidValue,
   InvoiceReaderResponse,
   IVMS101,
+  KnownWalletId,
   LegalPerson,
   LegalPersonFieldName,
   LegalPersonFields,
@@ -199,6 +202,7 @@ export type {
   VASPOptions,
   VASPTrustStatus,
   Wallet,
+  WalletId,
   Withdrawal,
 };
 

package/src/types.ts

@@ -914,6 +914,38 @@ 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}.
@@ -1139,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[];
   };
 }
 /**