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

package/src/types.ts

@@ -1,3 +1,4 @@
+import type { Invoice, Party } from '@taprsvp/types';
 import type {
   Address,
   Beneficiary,
@@ -23,6 +24,8 @@ export type {
   NationalIdentification,
   Originator,
 };
+// Re-export TAIP-16 invoice types for SDK consumers
+export type { Invoice };
 /**
  * Interoperable Virtual Asset Service Provider (VASP) Messaging Standard
  * @public
@@ -209,6 +212,7 @@ export type Source = BlockchainAddress | CAIP10;
 
 /**
  * A Uniform Resource Identifier
+ * @remarks This type will be narrowed to `` `${string}:${string}` `` in the next major release.
  * @public
  */
 export type URI = string;
@@ -617,6 +621,14 @@ export interface DepositRequestOptions {
   showQrCode?: boolean; // Defaults to true
 }
 
+/** Output fields populated by the component on completion */
+export interface InvoiceReaderResponse {
+  /** TAIP-16 compliant invoice data (populated by the component after PDF parsing) */
+  invoice?: Invoice;
+  merchant?: Party;
+  customer?: Party;
+}
+
 /**
  * An object representing a connection request
  * @public
@@ -777,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> =>