@notabene/javascript-sdk 2.0.0-next.16 → 2.0.0-next.18

package/src/notabene.ts

@@ -4,7 +4,6 @@ import type {
   CallbackOptions,
   ComponentMessage,
   ConnectionRequest,
-  ConnectionResponse,
   Counterparty,
   DeclarationProof,
   Deposit,
@@ -35,11 +34,11 @@ import {
 } from './types';
 import { encodeObjectToFragment } from './utils/urls';
 
+// Must be exported for React Native SDK to use
+export { default as EmbeddedComponent } from './components/EmbeddedComponent';
 export type {
   ComponentMessage,
-  EmbeddedComponent,
   ConnectionRequest,
-  ConnectionResponse,
   HostMessage,
   Theme,
   Counterparty,
@@ -140,10 +139,10 @@ export default class Notabene {
    * @returns component URL
    * @internal
    */
-  componentUrl<V>(
+  componentUrl<V, O>(
     path: string,
     value: V,
-    configuration?: TransactionOptions,
+    configuration?: O,
     callbacks?: CallbackOptions,
   ): string {
     const url = new URL(this.uxUrl);
@@ -182,15 +181,16 @@ export default class Notabene {
    * @returns A new EmbeddedComponent instance
    * @internal
    */
-  createComponent<V, R>(
+  createComponent<V, O>(
     path: string,
-    value: V,
-    options?: TransactionOptions,
+    value: Partial<V>,
+    options?: O,
     callbacks?: CallbackOptions,
   ) {
-    return new EmbeddedComponent<V, R>(
+    return new EmbeddedComponent<V, O>(
       this.componentUrl(path, value, options, callbacks),
       value,
+      options,
     );
   }
 
@@ -207,10 +207,12 @@ export default class Notabene {
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent<
-      Partial<Withdrawal>,
-      TransactionResponse<Withdrawal>
-    >('withdrawal-assist', value, options, callbacks);
+    return this.createComponent<Withdrawal, TransactionOptions>(
+      'withdrawal-assist',
+      value,
+      options,
+      callbacks,
+    );
   }
 
   /**
@@ -227,10 +229,12 @@ export default class Notabene {
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent<
-      Partial<Withdrawal>,
-      TransactionResponse<Withdrawal>
-    >('wallet-assist', value, options, callbacks);
+    return this.createComponent<Withdrawal, TransactionOptions>(
+      'wallet-assist',
+      value,
+      options,
+      callbacks,
+    );
   }
 
   /**
@@ -247,7 +251,7 @@ export default class Notabene {
     options?: any,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent<Partial<Deposit>, TransactionResponse<Deposit>>(
+    return this.createComponent<Deposit, any>(
       'deposit-assist',
       value,
       options,
@@ -269,7 +273,7 @@ export default class Notabene {
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent<ConnectionRequest, ConnectionResponse>(
+    return this.createComponent<ConnectionRequest, TransactionOptions>(
       'connect',
       value,
       options,
@@ -291,10 +295,12 @@ export default class Notabene {
     options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
-    return this.createComponent<
-      DepositRequest,
-      TransactionResponse<DepositRequest>
-    >('deposit-request', value, options, callbacks);
+    return this.createComponent<DepositRequest, TransactionOptions>(
+      'deposit-request',
+      value,
+      options,
+      callbacks,
+    );
   }
 
   /**

package/src/types.ts

@@ -355,17 +355,6 @@ export interface ConnectionRequest extends ComponentRequest {
   asset: TransactionAsset;
 }
 
-/**
- * An object representing a connection response
- * @public
- */
-export interface ConnectionResponse extends ComponentResponse {
-  value: ConnectionRequest;
-  ivms: IVMS101;
-  proof?: OwnershipProof;
-  txCreate?: V1Transaction;
-}
-
 /**
  * The verification status of a transaction
  * @public
@@ -469,19 +458,19 @@ export const enum CMType {
   RESULT = 'result',
   READY = 'ready',
   INVALID = 'invalid',
-  MODAL = 'openModal',
   ERROR = 'error',
-  CLOSE = 'closeModal',
   CANCEL = 'cancel',
 }
 
 /**
  * Represents a completed component message
+ * @typeParam T - The overall Value type being returned
+ * @param response - The Response object which wraps T
  * @public
  */
-export type Completed = {
+export type Completed<T> = {
   type: CMType.COMPLETE;
-  response: ComponentResponse;
+  response: TransactionResponse<T>;
 };
 
 /**
@@ -493,8 +482,8 @@ export type Ready = {
 };
 
 /**
- * Represents a resize request component message
- * @public
+ * Represents a resize request component message. This is handled by the library.
+ * @internal
  */
 export type ResizeRequest = {
   type: CMType.RESIZE;
@@ -503,6 +492,7 @@ export type ResizeRequest = {
 
 /**
  * Represents an error component message
+ * @param message - Error message
  * @public
  */
 export type Error = {
@@ -512,7 +502,7 @@ export type Error = {
 
 /**
  * Represents a cancel component message
- * @public
+ * @internal
  */
 export type Cancel = {
   type: CMType.CANCEL;
@@ -520,11 +510,14 @@ export type Cancel = {
 
 /**
  * Represents an invalid value component message
- * @public
+ * @typeParam T - The overall Value type being returned
+ * @param value - The current Partial value
+ * @param errors - Array of validation errors
+ * @internal
  */
-export type InvalidValue = {
+export type InvalidValue<T> = {
   type: CMType.INVALID;
-  value: any;
+  value: Partial<T>;
   errors: ValidationError[];
 };
 
@@ -532,13 +525,13 @@ export type InvalidValue = {
  * Component Message
  * @public
  */
-export type ComponentMessage =
-  | Completed
+export type ComponentMessage<T> =
+  | Completed<T>
   | Cancel
   | Error
   | Ready
   | ResizeRequest
-  | InvalidValue;
+  | InvalidValue<T>;
 
 /**
  * Host Message Types
@@ -551,19 +544,22 @@ export const enum HMType {
 }
 
 /**
- * Represents an update value host message
+ * Represents an update value host message. This is sent from Host to component.
+ * @typeParam T - The overall Value type being sent
+ * @typeParam O - The Option type being sent
  * @public
  */
-export type UpdateValue = {
+export type UpdateValue<T, O> = {
   type: HMType.UPDATE;
-  value: ComponentRequest;
+  value: Partial<T>;
+  options?: O;
 };
 
 /**
  * Host Messages
  * @public
  */
-export type HostMessage = UpdateValue;
+export type HostMessage<T, O> = UpdateValue<T, O>;
 
 /**
  * Options for callback and redirect URIs
@@ -592,6 +588,7 @@ export enum ProofStatus {
 export enum ProofTypes {
   SelfDeclaration = 'self-declaration',
   PersonalSignEIP191 = 'eip-191',
+  SIWE = 'siwe',
   PersonalSignEIP712 = 'eip-712',
   PersonalSignBIP137 = 'bip-137',
   PersonalSignXPUB = 'xpub',
@@ -619,6 +616,7 @@ export interface SignatureProof extends OwnershipProof {
     | ProofTypes.PersonalSignEIP191
     | ProofTypes.PersonalSignEIP712
     | ProofTypes.PersonalSignBIP137
+    | ProofTypes.SIWE
     | ProofTypes.PersonalSignXPUB;
   proof: string;
   attestation: string;

package/src/utils/MessageEventManager.ts

@@ -1,9 +1,9 @@
 import { ComponentMessage, HostMessage } from '../types';
 
-export type MessageCallback = (message: ComponentMessage) => void;
+export type MessageCallback<T> = (message: ComponentMessage<T>) => void;
 
-export class MessageEventManager {
-  private listeners: Map<string, Set<MessageCallback>> = new Map();
+export class MessageEventManager<T, O> {
+  private listeners: Map<string, Set<MessageCallback<T>>> = new Map();
   private port?: MessagePort;
 
   constructor() {
@@ -16,14 +16,14 @@ export class MessageEventManager {
     this.port.start();
   }
 
-  on(messageType: string, callback: MessageCallback): void {
+  on(messageType: string, callback: MessageCallback<T>): void {
     if (!this.listeners.has(messageType)) {
       this.listeners.set(messageType, new Set());
     }
     this.listeners.get(messageType)!.add(callback);
   }
 
-  off(messageType: string, callback: MessageCallback): void {
+  off(messageType: string, callback: MessageCallback<T>): void {
     const callbacks = this.listeners.get(messageType);
     if (callbacks) {
       callbacks.delete(callback);
@@ -33,7 +33,7 @@ export class MessageEventManager {
     }
   }
 
-  private handleMessage(event: MessageEvent): void {
+  private handleMessage(event: MessageEvent<ComponentMessage<T>>): void {
     // console.log('received message', event.data);
     const message = event.data;
     if (typeof message === 'object' && message !== null && 'type' in message) {
@@ -46,7 +46,7 @@ export class MessageEventManager {
   }
 
   // Method to send messages through the port
-  send(message: HostMessage): void {
+  send(message: HostMessage<T, O>): void {
     if (this.port) {
       this.port.postMessage(message);
     }

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

@@ -1,9 +1,14 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
-import { HMType, UpdateValue } from '../../types';
+import {
+  HMType,
+  type TransactionOptions,
+  type UpdateValue,
+  type Withdrawal,
+} from '../../types';
 import { MessageEventManager } from '../MessageEventManager';
 
 describe('MessageEventManager', () => {
-  let messageEventManager: MessageEventManager;
+  let messageEventManager: MessageEventManager<Withdrawal, TransactionOptions>;
   let mockPort: MessagePort;
 
   beforeEach(() => {
@@ -13,7 +18,10 @@ describe('MessageEventManager', () => {
       start: vi.fn(),
     } as unknown as MessagePort;
 
-    messageEventManager = new MessageEventManager();
+    messageEventManager = new MessageEventManager<
+      Withdrawal,
+      TransactionOptions
+    >();
   });
 
   describe('setPort', () => {
@@ -73,7 +81,7 @@ describe('MessageEventManager', () => {
     });
 
     it('should send messages through the port', () => {
-      const message: UpdateValue = {
+      const message: UpdateValue<Withdrawal, TransactionOptions> = {
         type: HMType.UPDATE,
         value: { requestId: 'id' },
       };