@notabene/javascript-sdk 1.14.3 → 1.16.0

package/src/notabene.ts

@@ -1,26 +1,14 @@
 // @ts-ignore
 import { dom, node } from 'jsx-pragmatic';
+import {
+  NonCustodialDeclarationType,
+  Theme,
+  Transaction,
+  TransactionTypeAllowed,
+} from './types';
 // @ts-ignore
 import zoid, { destroy } from 'zoid';
-
-export interface Theme {
-  primaryColor: string;
-  secondaryColor: string;
-  fontFamily: string;
-  logo: string;
-}
-
-export enum TransactionTypeAllowed {
-  ALL = 'ALL',
-  VASP_2_VASP_ONLY = 'VASP_2_VASP_ONLY',
-  SELF_TRANSACTION_ONLY = 'SELF_TRANSACTION_ONLY',
-}
-
-export enum NonCustodialDeclarationType {
-  SIGNATURE = 'SIGNATURE',
-  DECLARATION = 'DECLARATION',
-  SIGNATURE_OR_DECLARATION = 'SIGNATURE_OR_DECLARATION',
-}
+import { popupProps, widgetProps } from './zoidComponentProps';
 
 interface NotabeneConfig {
   widget: string;
@@ -36,34 +24,6 @@ interface NotabeneConfig {
   beneficiaryDetails?: string[];
 }
 
-export interface OwnershipProofInput {
-  type?: string | null;
-  proof?: string | null;
-}
-
-export interface TransactionBlockchainInfo {
-  destination?: string | null;
-}
-interface Transaction {
-  transactionAsset: string;
-  transactionAmount: string;
-  beneficiaryAccountNumber: string;
-  originatorVASPdid?: string;
-  originatorDid?: string;
-  transactionBlockchainInfo?: TransactionBlockchainInfo;
-  beneficiaryVASPname?: string;
-  beneficiaryName?: string;
-  beneficiaryGeographicAddress?: string;
-  beneficiaryNationalIdentification?: string;
-  beneficiaryDateAndPlaceOfBirth?: string;
-  beneficiaryDid?: string;
-  isNonCustodial?: boolean;
-  originatorEqualsBeneficiary?: boolean;
-  beneficiaryProof?: OwnershipProofInput;
-  isValid?: boolean;
-  errors?: string[];
-}
-
 export default class Notabene {
   private widget: zoid.ZoidComponent;
   private popup: zoid.ZoidComponent;
@@ -77,10 +37,8 @@ export default class Notabene {
   constructor(config: NotabeneConfig) {
     this.config = config;
     this.config.nonCustodialDeclarationType =
-      config.nonCustodialDeclarationType ||
-      NonCustodialDeclarationType.SIGNATURE;
-    this.config.transactionTypeAllowed =
-      config.transactionTypeAllowed || TransactionTypeAllowed.ALL;
+      config.nonCustodialDeclarationType || 'SIGNATURE';
+    this.config.transactionTypeAllowed = config.transactionTypeAllowed || 'ALL';
     this.widgetRendered = false;
     this.shouldBeDestroyed = false;
     this.popupRendered = false;
@@ -131,35 +89,6 @@ export default class Notabene {
   }
 
   public setTransaction(tx: Transaction) {
-    const validProperties = [
-      'transactionAsset',
-      'transactionAmount',
-      'beneficiaryAccountNumber',
-      'beneficiaryAccountNumber',
-      'originatorVASPdid',
-      'originatorDid',
-      'transactionBlockchainInfo',
-      'beneficiaryVASPname',
-      'beneficiaryVASPdid',
-      'beneficiaryName',
-      'beneficiaryGeographicAddress',
-      'beneficiaryNationalIdentification',
-      'beneficiaryDateAndPlaceOfBirth',
-      'beneficiaryPersonType',
-      'beneficiaryDid',
-      'isNonCustodial',
-      'originatorEqualsBeneficiary',
-      'beneficiaryProof',
-      'isValid',
-      'errors',
-    ];
-    if (tx) {
-      Object.keys(tx).forEach((key) => {
-        if (!validProperties.includes(key)) {
-          throw new Error(`Notabene: Invalid transaction property ${key}`);
-        }
-      });
-    }
     this.tx = tx;
     if (this.widgetRendered) {
       this.widget.updateProps({
@@ -216,56 +145,7 @@ export default class Notabene {
         width: '100%',
         height: '280px',
       },
-      props: {
-        vaspDID: {
-          type: 'string',
-          required: true,
-        },
-        transaction: {
-          type: 'object',
-          required: false,
-        },
-        onRequireAdditionalInformation: {
-          type: 'function',
-          required: true,
-        },
-        onValidStateChange: {
-          type: 'function',
-          required: true,
-        },
-        error: {
-          type: 'object',
-          required: false,
-        },
-        onError: {
-          type: 'function',
-          required: true,
-        },
-        storeTransaction: {
-          type: 'function',
-          required: true,
-        },
-        theme: {
-          type: 'object',
-          required: false,
-        },
-        dictionary: {
-          type: 'object',
-          required: false,
-        },
-        transactionTypeAllowed: {
-          type: 'string',
-          required: false,
-        },
-        nonCustodialDeclarationType: {
-          type: 'string',
-          required: false,
-        },
-        beneficiaryDetails: {
-          type: 'array',
-          required: false,
-        },
-      },
+      props: widgetProps,
     })({
       vaspDID: this.config.vaspDID,
       transaction: {},
@@ -319,59 +199,7 @@ export default class Notabene {
         width: '100%',
         height: '100%',
       },
-      props: {
-        vaspDID: {
-          type: 'string',
-          required: true,
-        },
-        transaction: {
-          type: 'object',
-          required: false,
-        },
-        storeTransaction: {
-          type: 'function',
-          required: true,
-        },
-        close: {
-          type: 'function',
-        },
-        theme: {
-          type: 'object',
-          required: false,
-        },
-        dictionary: {
-          type: 'object',
-          required: false,
-        },
-        transactionTypeAllowed: {
-          type: 'string',
-          required: false,
-        },
-        nonCustodialDeclarationType: {
-          type: 'string',
-          required: false,
-        },
-        popupOpen: {
-          type: 'boolean',
-          required: true,
-        },
-        setPopupOpen: {
-          type: 'function',
-          required: true,
-        },
-        error: {
-          type: 'object',
-          required: false,
-        },
-        onError: {
-          type: 'function',
-          required: true,
-        },
-        beneficiaryDetails: {
-          type: 'array',
-          required: false,
-        },
-      },
+      props: popupProps,
       containerTemplate: ({ uid, doc, frame, prerenderFrame }: any) => {
         return node(
           'div',
@@ -395,7 +223,6 @@ export default class Notabene {
               background-color: rgba(0,0,0,0.5);
             }
             .nb-popup {
-              max-width: 608px;
               width: 100%;
               height: 100%;
             }

package/src/types.ts

@@ -0,0 +1,72 @@
+import { DateAndPlaceOfBirth, NationalIdentification } from 'ivms/types';
+
+export type Theme = {
+  primaryColor: string;
+  secondaryColor: string;
+  fontFamily: string;
+  logo: string;
+};
+
+export type TransactionTypeAllowed =
+  | 'ALL'
+  | 'VASP_2_VASP_ONLY'
+  | 'SELF_TRANSACTION_ONLY';
+
+export type NonCustodialDeclarationType =
+  | 'SIGNATURE'
+  | 'DECLARATION'
+  | 'SIGNATURE_AND_DECLARATION';
+
+export type OwnershipProofInput = {
+  type?: string | null;
+  proof?: string | null;
+};
+
+export type TransactionBlockchainInfo = {
+  destination?: string | null;
+  origin?: string | null;
+};
+
+export type CountryType = {
+  id: string;
+  name: string;
+};
+
+export type PersonType = 'natural' | 'legal';
+
+export type OriginatorFields = {
+  originatorAccountNumber?: string;
+  originatorDid?: string;
+  originatorVASPname?: string;
+  originatorVASPdid?: string;
+  originatorName?: string;
+  originatorGeographicAddress?: string;
+  originatorNationalIdentification?: NationalIdentification;
+  originatorDateAndPlaceOfBirth?: DateAndPlaceOfBirth;
+  originatorPersonType?: PersonType;
+};
+
+export type BeneficiaryFields = {
+  beneficiaryAccountNumber?: string;
+  beneficiaryDid?: string;
+  beneficiaryVASPname?: string;
+  beneficiaryVASPdid?: string;
+  beneficiaryName?: string;
+  beneficiaryGeographicAddress?: string;
+  beneficiaryNationalIdentification?: NationalIdentification;
+  beneficiaryDateAndPlaceOfBirth?: DateAndPlaceOfBirth;
+  beneficiaryPersonType?: PersonType;
+};
+
+export type Transaction = OriginatorFields &
+  BeneficiaryFields & {
+    transactionAsset: string;
+    transactionAmount: string;
+    transactionBlockchainInfo?: TransactionBlockchainInfo;
+    isNonCustodial?: boolean;
+    originatorEqualsBeneficiary?: boolean;
+    beneficiaryProof?: OwnershipProofInput;
+    originatorProof?: OwnershipProofInput;
+    isValid?: boolean;
+    errors?: string[];
+  };

package/src/zoidComponentProps.ts

@@ -0,0 +1,69 @@
+const generalProps = {
+  vaspDID: {
+    type: 'string',
+    required: true,
+  },
+  transaction: {
+    type: 'object',
+    required: false,
+  },
+  error: {
+    type: 'object',
+    required: false,
+  },
+  onError: {
+    type: 'function',
+    required: true,
+  },
+  storeTransaction: {
+    type: 'function',
+    required: true,
+  },
+  theme: {
+    type: 'object',
+    required: false,
+  },
+  dictionary: {
+    type: 'object',
+    required: false,
+  },
+  transactionTypeAllowed: {
+    type: 'string',
+    required: false,
+  },
+  nonCustodialDeclarationType: {
+    type: 'string',
+    required: false,
+  },
+  beneficiaryDetails: {
+    type: 'array',
+    required: false,
+  },
+};
+
+export const widgetProps = {
+  ...generalProps,
+  onRequireAdditionalInformation: {
+    type: 'function',
+    required: true,
+  },
+  onValidStateChange: {
+    type: 'function',
+    required: true,
+  },
+};
+
+export const popupProps = {
+  ...generalProps,
+  close: {
+    type: 'function',
+  },
+  popupOpen: {
+    type: 'boolean',
+    required: true,
+  },
+  setPopupOpen: {
+    type: 'function',
+    required: true,
+  },
+};

package/tsconfig.json

@@ -10,6 +10,7 @@
     "moduleResolution": "node",
     "sourceMap": false,
     "baseUrl": "src",
+    "resolveJsonModule": true,
     "lib": ["dom", "es2016"]
   },
   "include": ["./src"],