@notabene/javascript-sdk 2.0.3 → 2.1.0

package/src/types.ts

@@ -235,10 +235,10 @@ export type ISOCurrency = string;
  * @public
  */
 export type Theme = {
-  primaryColor: string;
-  secondaryColor: string;
-  fontFamily: string;
-  logo: string;
+  primaryColor?: string;
+  secondaryColor?: string;
+  fontFamily?: string;
+  logo?: string;
 };
 
 /**
@@ -700,6 +700,19 @@ export type FieldTypes = {
   legalPerson?: LegalPersonFields;
 };
 
+/**
+ * VASP Visibility Control representing allow/deny behaviour for VASP visibility
+ *
+ * @remarks
+ * - ALLOWED: Include VASPs you have explicitly allowed in the Notabene Network
+ * - PENDING: Include VASPs neither allowed nor denied
+ * @public
+ */
+export const enum VASPSearchControl {
+  ALLOWED = 'allowed',
+  PENDING = 'pending',
+}
+
 /**
  * Options for which VASPs to be searchable
  * @public
@@ -707,6 +720,7 @@ export type FieldTypes = {
 export type VASPOptions = {
   addUnknown?: boolean;
   onlyActive?: boolean;
+  searchable?: VASPSearchControl[]; // If array left empty all VASPs will be searchable
 };
 
 /**
@@ -765,7 +779,6 @@ export interface TransactionOptions {
  * - COMPLETE: Indicates a completed operation with response data
  * - RESIZE: Request to adjust component size/dimensions
  * - RESULT: Operation result notification
- * - READY: Component is initialized and ready
  * - INVALID: Validation failed with errors
  * - ERROR: Operation encountered an error
  * - CANCEL: Operation was cancelled
@@ -775,7 +788,6 @@ export const enum CMType {
   COMPLETE = 'complete',
   RESIZE = 'resize',
   RESULT = 'result',
-  READY = 'ready',
   INVALID = 'invalid',
   ERROR = 'error',
   CANCEL = 'cancel',
@@ -792,14 +804,6 @@ export type Completed<T> = {
   response: TransactionResponse<T>;
 };
 
-/**
- * Represents a ready component message
- * @public
- */
-export type Ready = {
-  type: CMType.READY;
-};
-
 /**
  * Represents a resize request component message. This is handled by the library.
  * @internal
@@ -812,11 +816,15 @@ export type ResizeRequest = {
 /**
  * Represents an error component message
  * @param message - Error message
+ * @param description - Description of the error message
+ * @param identifier - Identifier code of the error message
  * @public
  */
 export type Error = {
   type: CMType.ERROR;
   message: string;
+  description?: string;
+  identifier?: string;
 };
 
 /**
@@ -849,7 +857,6 @@ export type InvalidValue<T> = {
  * - Completed: Operation finished successfully with response data
  * - Cancel: User cancelled the operation
  * - Error: Operation failed with error message
- * - Ready: Component initialized and ready for use
  * - ResizeRequest: Component needs to adjust its dimensions
  * - InvalidValue: Validation failed with current partial value
  *
@@ -858,7 +865,6 @@ export type InvalidValue<T> = {
  * @see {@link Completed} For successful completion message format
  * @see {@link Cancel} For cancellation message format
  * @see {@link Error} For error message format
- * @see {@link Ready} For ready message format
  * @see {@link ResizeRequest} For resize message format
  * @see {@link InvalidValue} For validation failure message format
  * @public
@@ -867,7 +873,6 @@ export type ComponentMessage<T> =
   | Completed<T>
   | Cancel
   | Error
-  | Ready
   | ResizeRequest
   | InvalidValue<T>;
 

package/src/utils/__tests__/MessageEventManager.test.ts

@@ -1,6 +1,5 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import {
-  HMType,
   type TransactionOptions,
   type UpdateValue,
   type Withdrawal,
@@ -34,13 +33,13 @@ describe('MessageEventManager', () => {
     });
 
     it('should subscribe and receive messages of a specific type', () => {
-      const readyHandler = vi.fn();
-      messageEventManager.on('ready', readyHandler);
+      const completeHandler = vi.fn();
+      messageEventManager.on('complete', completeHandler);
 
-      const readyMessage = { type: 'ready' };
-      mockPort.onmessage!({ data: readyMessage } as MessageEvent);
+      const completeMessage = { type: 'complete' };
+      mockPort.onmessage!({ data: completeMessage } as MessageEvent);
 
-      expect(readyHandler).toHaveBeenCalledWith(readyMessage);
+      expect(completeHandler).toHaveBeenCalledWith(completeMessage);
     });
 
     it('should not call handlers for different message types', () => {
@@ -82,7 +81,8 @@ describe('MessageEventManager', () => {
 
     it('should send messages through the port', () => {
       const message: UpdateValue<Withdrawal, TransactionOptions> = {
-        type: HMType.UPDATE,
+        // @ts-expect-error Type '"update"' is not assignable to type 'HMType.UPDATE'.
+        type: 'update',
         value: { requestId: 'id' },
       };
       messageEventManager.send(message);

package/docs/types/type-aliases/Ready.md

@@ -1,21 +0,0 @@
-[**@notabene/javascript-sdk**](../../README.md) • **Docs**
-
-***
-
-[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Ready
-
-# Type Alias: Ready
-
-> **Ready**: `object`
-
-Represents a ready component message
-
-## Type declaration
-
-### type
-
-> **type**: [`READY`](../enumerations/CMType.md#ready)
-
-## Defined in
-
-[types.ts:799](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L799)