@notabene/javascript-sdk 2.0.0-next.6 → 2.0.0-next.8

package/src/notabene.ts

@@ -6,6 +6,8 @@ import type {
   ComponentMessage,
   Counterparty,
   DeclarationProof,
+  Deposit,
+  DepositRequest,
   Destination,
   HostMessage,
   IVMS101,
@@ -20,6 +22,7 @@ import type {
   Theme,
   Transaction,
   TransactionAsset,
+  TransactionOptions,
   VASP,
   Wallet,
   Withdrawal,
@@ -35,7 +38,9 @@ export type {
   Theme,
   Counterparty,
   Withdrawal,
+  Deposit,
   Transaction,
+  DepositRequest,
   TransactionResponse,
   Destination as destination,
   TransactionAsset,
@@ -54,6 +59,7 @@ export type {
   Agent,
   AgentType,
   OwnershipProof,
+  TransactionOptions,
 };
 
 /**
@@ -66,7 +72,7 @@ export interface NotabeneConfig {
   authToken?: string;
   uxUrl?: string;
   theme?: Theme;
-  dictionary?: { [key: string]: string };
+  locale?: string;
 }
 
 /**
@@ -80,20 +86,20 @@ export default class Notabene {
   private authToken?: string;
   private uxUrl: string;
   private theme?: Theme;
-  private dictionary?: { [key: string]: string };
+  private locale?: string;
 
   constructor(config: NotabeneConfig) {
     this.uxUrl = config.uxUrl || 'https://connect.notabene.id';
     this.nodeUrl = config.nodeUrl;
     this.authToken = config.authToken;
     this.theme = config.theme;
-    this.dictionary = config.dictionary;
+    this.locale = config.locale;
   }
 
   public componentUrl(
     path: string,
     value: Partial<Transaction>,
-    configuration?: any,
+    configuration?: TransactionOptions,
     callbacks?: CallbackOptions,
   ): string {
     const url = new URL(this.uxUrl);
@@ -110,8 +116,8 @@ export default class Notabene {
     if (this.theme) {
       url.searchParams.set('theme', JSON.stringify(this.theme));
     }
-    if (this.dictionary) {
-      url.searchParams.set('dictionary', JSON.stringify(this.dictionary));
+    if (this.locale) {
+      url.searchParams.set('locale', this.locale);
     }
     if (callbacks) {
       if (callbacks.callback)
@@ -125,7 +131,7 @@ export default class Notabene {
   public createComponent(
     path: string,
     value: Partial<Transaction>,
-    options?: any,
+    options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
     return new EmbeddedComponent(
@@ -136,12 +142,36 @@ export default class Notabene {
 
   public createWithdrawalAssist(
     value: Partial<Withdrawal>,
-    options?: any,
+    options?: TransactionOptions,
     callbacks?: CallbackOptions,
   ) {
     return this.createComponent('withdrawal-assist', value, options, callbacks);
   }
 
+  public createDepositAssist(
+    value: Partial<Deposit>,
+    options?: any,
+    callbacks?: CallbackOptions,
+  ) {
+    return this.createComponent('deposit-assist', value, options, callbacks);
+  }
+
+  public createConnect(
+    value: Partial<Withdrawal>,
+    options?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ) {
+    return this.createComponent('connect', value, options, callbacks);
+  }
+
+  public createDepositRequest(
+    value: Partial<DepositRequest>,
+    options?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ) {
+    return this.createComponent('deposit-request', value, options, callbacks);
+  }
+
   public decodeFragmentToObject(fragment: string): Record<string, string> {
     const pairs = fragment.slice(1).split('&');
     return pairs.reduce(
@@ -153,50 +183,4 @@ export default class Notabene {
       {} as Record<string, string>,
     );
   }
-
-  // private openModal(url: string): void {
-  //   if (this.modal) {
-  //     this.closeModal();
-  //   }
-  //   this.modal = document.createElement('div');
-  //   this.modal.style.position = 'fixed';
-  //   this.modal.style.top = '0';
-  //   this.modal.style.left = '0';
-  //   this.modal.style.width = '100%';
-  //   this.modal.style.height = '100%';
-  //   this.modal.style.backgroundColor = 'rgba(0, 0, 0, 0.5)';
-  //   this.modal.style.display = 'flex';
-  //   this.modal.style.justifyContent = 'center';
-  //   this.modal.style.alignItems = 'center';
-  //   const iframe = document.createElement('iframe');
-  //   iframe.src = url;
-  //   iframe.setAttribute('allowtransparency', 'true');
-  //   // iframe.allowtransparency = true;
-  //   iframe.style.backgroundColor = 'transparent';
-  //   iframe.style.width = '90%';
-  //   iframe.style.height = '90%';
-  //   iframe.style.border = 'none';
-  //   iframe.style.overflow = 'hidden';
-  //   this.modal.appendChild(iframe);
-  //   document.body.appendChild(this.modal);
-  //   this.modal.addEventListener('click', () => {
-  //     console.log('click');
-  //     this.closeModal();
-  //   });
-  //   document.addEventListener('keydown', ({ key }) => {
-  //     console.log(`key: ${key}`);
-  //     if (key === 'Escape') {
-  //       console.log('esc');
-  //       this.closeModal();
-  //     }
-  //   });
-  // }
-
-  // private closeModal(): void {
-  //   if (this.modal) {
-  //     console.log('this.closeModal');
-  //     this.modal.remove();
-  //     this.modal = undefined;
-  //   }
-  // }
 }

package/src/types.ts

@@ -1,7 +1,9 @@
 import {
+  Beneficiary,
   DateAndPlaceOfBirth,
   IVMS101,
   NationalIdentification,
+  Originator,
 } from './ivms/types';
 
 export type { IVMS101 };
@@ -23,13 +25,18 @@ export type NotabeneAsset = string;
 export type TransactionAsset = NotabeneAsset | CAIP19 | DTI;
 
 export type BlockchainAddress = string;
-export type TravelAddress = string;
+export type TravelAddress = `ta${string}`;
+export type CryptoCredential = `${string}.${string}.mastercard`;
 
 /**
  * The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
  * @public
  */
-export type Destination = BlockchainAddress | CAIP10 | TravelAddress;
+export type Destination =
+  | BlockchainAddress
+  | CAIP10
+  | CryptoCredential
+  | TravelAddress;
 export type Source = BlockchainAddress | CAIP10;
 export type URI = string;
 export type DID = `did:${string}:${string}`;
@@ -45,10 +52,6 @@ export type Theme = {
   logo: string;
 };
 
-export enum ComponentTypes {
-  WITHDRAW_ASSIST = 'WITHDRAW_ASSIST',
-}
-
 // export type TransactionType = 'VASP_2_VASP' | 'SELF_HOSTED';
 
 // export type TransactionTypeAllowed =
@@ -160,14 +163,18 @@ export interface LegalPerson extends Counterparty {
   logo?: string;
 }
 
-export type OriginatorFields = {
+type OriginatorFields = {
   source?: Source;
 };
 
-export type BeneficiaryFields = {
+type BeneficiaryFields = {
   destination?: Destination;
 };
 
+type DepositRequestFields = {
+  destinations: Destination[];
+};
+
 /**
  * An abstract transaction object
  * @public
@@ -190,12 +197,29 @@ export interface Transaction {
  * @public
  */
 export interface Withdrawal extends BeneficiaryFields, Transaction {}
+
 /**
  * An object representing a deposit transaction
  * @public
  */
 export interface Deposit extends OriginatorFields, Transaction {}
 
+/**
+ * An object representing a request for a deposit
+ * @public
+ */
+export interface DepositRequest extends DepositRequestFields, Transaction {}
+
+/**
+ * Configuration options for Transaction components
+ * @public
+ */
+
+export interface TransactionOptions {
+  microTransactionAddress?: BlockchainAddress;
+  proofFallbacks?: ProofTypes[];
+}
+
 /**
  * The verification status of a transaction
  * @public
@@ -208,6 +232,27 @@ export enum Status {
   BANNED = 'banned',
 }
 
+type V1Asset =
+  | {
+      caip19: CAIP19;
+    }
+  | string;
+
+/**
+ * Transaction payload suitable for calling Notabene v1 tx/create
+ * @public
+ */
+
+export type V1Transaction = {
+  transactionAsset: V1Asset;
+  transactionAmount: string;
+  originatorEqualsBeneficiary?: boolean;
+  originatorVASPdid: DID;
+  beneficiaryVASPdid: DID;
+  beneficiaryProof: OwnershipProof;
+  originator: Originator;
+  beneficiary: Beneficiary;
+};
 /**
  * The response of a transaction
  * @public
@@ -220,6 +265,7 @@ export type TransactionResponse = {
   valid: boolean;
   status: Status;
   errors: ValidationError[];
+  txCreate?: V1Transaction;
 };
 
 export type ValidationError = {
@@ -244,16 +290,6 @@ export type FieldsProps = {
   [name in FieldName]?: FieldProps;
 };
 
-export type WalletNotSupportedFlow = {
-  flow: 'WALLET_NOT_SUPPORTED';
-  action: 'DECLARATION' | 'REJECT';
-};
-
-// This is going to be union type
-export type Fallback = WalletNotSupportedFlow;
-
-export type OptInFeature = 'REUSE_ADDRESS_OWNERSHIP_PROOF';
-
 /**
  * Component Message Types
  * @internal

package/src/utils/MessageEventManager.ts

@@ -47,9 +47,8 @@ export class MessageEventManager {
 
   // Method to send messages through the port
   send(message: HostMessage): void {
-    if (!this.port) {
-      throw new Error('No port set');
+    if (this.port) {
+      this.port.postMessage(message);
     }
-    this.port.postMessage(message);
   }
 }

package/src/utils/arbitraries.ts

@@ -7,6 +7,8 @@ import {
   CAIP2_MATCHER,
 } from './caip';
 
+const LOCALE = new RegExp(/^[a-z]{2}(-[A-Z]{2})?$/);
+
 // Arbitraries
 export const arbitraryCAIP10 = (): fc.Arbitrary<CAIP10> =>
   fc.stringMatching(CAIP10_MATCHER) as fc.Arbitrary<CAIP10>;
@@ -19,3 +21,6 @@ export const arbitraryCAIP19 = (): fc.Arbitrary<CAIP19> =>
 
 export const arbitraryCAIP220 = (): fc.Arbitrary<CAIP220> =>
   fc.stringMatching(CAIP220_MATCHER) as fc.Arbitrary<CAIP220>;
+
+export const arbitraryLocale = (): fc.Arbitrary<string> =>
+  fc.stringMatching(LOCALE) as fc.Arbitrary<string>;