@notabene/javascript-sdk 2.16.0-next.4 → 2.16.0-next.5

package/README.md

@@ -806,6 +806,7 @@ const options: TransactionOptions = {
     },
   },
   vasps: {
+    // V1 options — `searchable` is mutually exclusive with V2 `showTrustStatus` below
     addUnknown: true, // Allow users to add a missing VASP - Defaults to false
     onlyActive: true, // Only list active VASPs - Default false
     searchable: [
@@ -813,6 +814,13 @@ const options: TransactionOptions = {
       VASPSearchControl.PENDING, // JS: 'pending'
     ], // Control searches for VASPs - Defaults to undefined
   },
+  // V2 alternative — filter by trust status instead of `searchable`. `addUnknown`
+  // and `onlyActive` remain valid; `searchable` cannot be combined with `showTrustStatus`:
+  // vasps: {
+  //   addUnknown: true,
+  //   onlyActive: true,
+  //   showTrustStatus: ['TRUSTED', 'NEW'], // 'TRUSTED' | 'NEW' | 'FLAGGED' | 'BANNED'
+  // },
   counterpartyAssist: { // Allows users to share a link to collect counterparty data
     counterpartyTypes: [
       PersonType.LEGAL, // JS: 'legal'

package/dist/cjs/notabene.d.ts

@@ -3516,13 +3516,37 @@ export declare interface VASP extends Agent {
 }
 
 /**
- * Options for which VASPs to be searchable
+ * Options controlling which VASPs are listed and searchable in the picker.
+ *
+ * Two mutually exclusive variants:
+ *
+ * - **V1** — `addUnknown`, `onlyActive`, `searchable` (filters by {@link VASPSearchControl} status).
+ * - **V2** — `addUnknown`, `onlyActive`, `showTrustStatus` (filters by {@link VASPTrustStatus}).
+ *
+ * `searchable` (V1-only) cannot be combined with `showTrustStatus` (V2-only);
+ * TypeScript will reject the mix at compile time. `addUnknown` and `onlyActive` are valid in both variants.
+ *
+ * @example V1
+ * ```ts
+ * { addUnknown: true, onlyActive: true, searchable: [VASPSearchControl.ALLOWED] }
+ * ```
+ *
+ * @example V2
+ * ```ts
+ * { addUnknown: true, onlyActive: true, showTrustStatus: ['TRUSTED', 'NEW'] }
+ * ```
+ *
  * @public
  */
 export declare type VASPOptions = {
     addUnknown?: boolean;
     onlyActive?: boolean;
     searchable?: VASPSearchControl[];
+} | {
+    searchable?: undefined;
+    addUnknown?: boolean;
+    onlyActive?: boolean;
+    showTrustStatus?: VASPTrustStatus[];
 };
 
 /**
@@ -3538,6 +3562,15 @@ export declare enum VASPSearchControl {
     PENDING = "pending"
 }
 
+/**
+ * Trust status assigned to a VASP in the Notabene network.
+ *
+ * Used by {@link VASPOptions.showTrustStatus} to filter which VASPs are listed in the picker.
+ *
+ * @public
+ */
+export declare type VASPTrustStatus = 'TRUSTED' | 'NEW' | 'FLAGGED' | 'BANNED';
+
 /**
  * A wallet agent acting on behalf of the counterparty
  * @public

package/dist/cjs/package.json

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

package/dist/esm/notabene.d.ts

@@ -3516,13 +3516,37 @@ export declare interface VASP extends Agent {
 }
 
 /**
- * Options for which VASPs to be searchable
+ * Options controlling which VASPs are listed and searchable in the picker.
+ *
+ * Two mutually exclusive variants:
+ *
+ * - **V1** — `addUnknown`, `onlyActive`, `searchable` (filters by {@link VASPSearchControl} status).
+ * - **V2** — `addUnknown`, `onlyActive`, `showTrustStatus` (filters by {@link VASPTrustStatus}).
+ *
+ * `searchable` (V1-only) cannot be combined with `showTrustStatus` (V2-only);
+ * TypeScript will reject the mix at compile time. `addUnknown` and `onlyActive` are valid in both variants.
+ *
+ * @example V1
+ * ```ts
+ * { addUnknown: true, onlyActive: true, searchable: [VASPSearchControl.ALLOWED] }
+ * ```
+ *
+ * @example V2
+ * ```ts
+ * { addUnknown: true, onlyActive: true, showTrustStatus: ['TRUSTED', 'NEW'] }
+ * ```
+ *
  * @public
  */
 export declare type VASPOptions = {
     addUnknown?: boolean;
     onlyActive?: boolean;
     searchable?: VASPSearchControl[];
+} | {
+    searchable?: undefined;
+    addUnknown?: boolean;
+    onlyActive?: boolean;
+    showTrustStatus?: VASPTrustStatus[];
 };
 
 /**
@@ -3538,6 +3562,15 @@ export declare enum VASPSearchControl {
     PENDING = "pending"
 }
 
+/**
+ * Trust status assigned to a VASP in the Notabene network.
+ *
+ * Used by {@link VASPOptions.showTrustStatus} to filter which VASPs are listed in the picker.
+ *
+ * @public
+ */
+export declare type VASPTrustStatus = 'TRUSTED' | 'NEW' | 'FLAGGED' | 'BANNED';
+
 /**
  * A wallet agent acting on behalf of the counterparty
  * @public

package/dist/esm/package.json

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

package/dist/notabene.d.ts

@@ -3516,13 +3516,37 @@ export declare interface VASP extends Agent {
 }
 
 /**
- * Options for which VASPs to be searchable
+ * Options controlling which VASPs are listed and searchable in the picker.
+ *
+ * Two mutually exclusive variants:
+ *
+ * - **V1** — `addUnknown`, `onlyActive`, `searchable` (filters by {@link VASPSearchControl} status).
+ * - **V2** — `addUnknown`, `onlyActive`, `showTrustStatus` (filters by {@link VASPTrustStatus}).
+ *
+ * `searchable` (V1-only) cannot be combined with `showTrustStatus` (V2-only);
+ * TypeScript will reject the mix at compile time. `addUnknown` and `onlyActive` are valid in both variants.
+ *
+ * @example V1
+ * ```ts
+ * { addUnknown: true, onlyActive: true, searchable: [VASPSearchControl.ALLOWED] }
+ * ```
+ *
+ * @example V2
+ * ```ts
+ * { addUnknown: true, onlyActive: true, showTrustStatus: ['TRUSTED', 'NEW'] }
+ * ```
+ *
  * @public
  */
 export declare type VASPOptions = {
     addUnknown?: boolean;
     onlyActive?: boolean;
     searchable?: VASPSearchControl[];
+} | {
+    searchable?: undefined;
+    addUnknown?: boolean;
+    onlyActive?: boolean;
+    showTrustStatus?: VASPTrustStatus[];
 };
 
 /**
@@ -3538,6 +3562,15 @@ export declare enum VASPSearchControl {
     PENDING = "pending"
 }
 
+/**
+ * Trust status assigned to a VASP in the Notabene network.
+ *
+ * Used by {@link VASPOptions.showTrustStatus} to filter which VASPs are listed in the picker.
+ *
+ * @public
+ */
+export declare type VASPTrustStatus = 'TRUSTED' | 'NEW' | 'FLAGGED' | 'BANNED';
+
 /**
  * A wallet agent acting on behalf of the counterparty
  * @public

package/package.json

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

package/src/notabene.ts

@@ -63,6 +63,7 @@ import type {
   ValidationError,
   VASP,
   VASPOptions,
+  VASPTrustStatus,
   Wallet,
   Withdrawal,
 } from './types';
@@ -189,6 +190,7 @@ export type {
   ValidationError,
   VASP,
   VASPOptions,
+  VASPTrustStatus,
   Wallet,
   Withdrawal,
 };

package/src/types.ts

@@ -789,14 +789,53 @@ export enum VASPSearchControl {
 }
 
 /**
- * Options for which VASPs to be searchable
+ * Trust status assigned to a VASP in the Notabene network.
+ *
+ * Used by {@link VASPOptions.showTrustStatus} to filter which VASPs are listed in the picker.
+ *
  * @public
  */
-export type VASPOptions = {
-  addUnknown?: boolean;
-  onlyActive?: boolean;
-  searchable?: VASPSearchControl[]; // If array left empty all VASPs will be searchable
-};
+export type VASPTrustStatus = 'TRUSTED' | 'NEW' | 'FLAGGED' | 'BANNED';
+
+/**
+ * Options controlling which VASPs are listed and searchable in the picker.
+ *
+ * Two mutually exclusive variants:
+ *
+ * - **V1** — `addUnknown`, `onlyActive`, `searchable` (filters by {@link VASPSearchControl} status).
+ * - **V2** — `addUnknown`, `onlyActive`, `showTrustStatus` (filters by {@link VASPTrustStatus}).
+ *
+ * `searchable` (V1-only) cannot be combined with `showTrustStatus` (V2-only);
+ * TypeScript will reject the mix at compile time. `addUnknown` and `onlyActive` are valid in both variants.
+ *
+ * @example V1
+ * ```ts
+ * { addUnknown: true, onlyActive: true, searchable: [VASPSearchControl.ALLOWED] }
+ * ```
+ *
+ * @example V2
+ * ```ts
+ * { addUnknown: true, onlyActive: true, showTrustStatus: ['TRUSTED', 'NEW'] }
+ * ```
+ *
+ * @public
+ */
+export type VASPOptions =
+  // V1 vasps options
+  | {
+      addUnknown?: boolean;
+      onlyActive?: boolean;
+      searchable?: VASPSearchControl[]; // If array left empty all VASPs will be searchable
+    }
+  // V2 vasps options
+  | {
+      // Typing `searchable` as `undefined` (rather than omitting it) makes TS reject
+      // mixing V1 and V2 options, e.g. { searchable: [...], showTrustStatus: [...] }.
+      searchable?: undefined;
+      addUnknown?: boolean;
+      onlyActive?: boolean;
+      showTrustStatus?: VASPTrustStatus[];
+    };
 
 /**
  * Available methods for identity verification

package/src/utils/arbitraries.ts

@@ -24,6 +24,7 @@ import type {
   TransactionOptions,
   TravelAddress,
   VASPOptions,
+  VASPTrustStatus,
   Withdrawal,
 } from '../types';
 import {
@@ -31,6 +32,7 @@ import {
   PersonType,
   ProofTypes,
   ValidationSections,
+  VASPSearchControl,
 } from '../types';
 import {
   CAIP10_MATCHER,
@@ -194,10 +196,33 @@ export const arbitraryFieldTypes = (): fc.Arbitrary<FieldTypes> =>
   });
 
 export const arbitraryVASPOptions = (): fc.Arbitrary<VASPOptions> =>
-  fc.record({
-    addUnknown: fc.option(fc.boolean()),
-    onlyActive: fc.option(fc.boolean()),
-  });
+  fc.oneof(
+    fc.record({
+      addUnknown: fc.option(fc.boolean(), { nil: undefined }),
+      onlyActive: fc.option(fc.boolean(), { nil: undefined }),
+      searchable: fc.option(
+        fc.array(
+          fc.constantFrom(VASPSearchControl.ALLOWED, VASPSearchControl.PENDING),
+        ),
+        { nil: undefined },
+      ),
+    }),
+    fc.record({
+      addUnknown: fc.option(fc.boolean(), { nil: undefined }),
+      onlyActive: fc.option(fc.boolean(), { nil: undefined }),
+      showTrustStatus: fc.option(
+        fc.array(
+          fc.constantFrom<VASPTrustStatus>(
+            'TRUSTED',
+            'NEW',
+            'FLAGGED',
+            'BANNED',
+          ),
+        ),
+        { nil: undefined },
+      ),
+    }),
+  );
 
 export const arbitraryTransactionOptions =
   (): fc.Arbitrary<TransactionOptions> =>