@notabene/javascript-sdk 2.0.0-next.2 → 2.0.0-next.20

package/etc/javascript-sdk.api.md

@@ -1,363 +0,0 @@
-## API Report File for "@notabene/javascript-sdk"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-// @public
-export interface Agent {
-    // Warning: (ae-forgotten-export) The symbol "DID" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    did: DID;
-    // (undocumented)
-    logo?: string;
-    // (undocumented)
-    name?: string;
-    // (undocumented)
-    type: AgentType;
-    // (undocumented)
-    url?: string;
-    // (undocumented)
-    verified?: boolean;
-}
-
-// @public
-export enum AgentType {
-    // (undocumented)
-    PRIVATE = "WALLET",
-    // (undocumented)
-    VASP = "VASP"
-}
-
-// Warning: (ae-internal-missing-underscore) The name "CMType" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const enum CMType {
-    // (undocumented)
-    CANCEL = "cancel",
-    // (undocumented)
-    CLOSE = "closeModal",
-    // (undocumented)
-    COMPLETE = "complete",
-    // (undocumented)
-    ERROR = "error",
-    // (undocumented)
-    INVALID = "invalid",
-    // (undocumented)
-    MODAL = "openModal",
-    // (undocumented)
-    READY = "ready",
-    // (undocumented)
-    RESIZE = "resize",
-    // (undocumented)
-    RESULT = "result"
-}
-
-// Warning: (ae-forgotten-export) The symbol "Completed" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "Cancel" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "Error_2" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "Result" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "Ready" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "ResizeRequest" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "ModalRequest" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "InvalidValue" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "CloseModal" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-internal-missing-underscore) The name "ComponentMessage" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export type ComponentMessage = Completed | Cancel | Error_2 | Result | Ready | ResizeRequest | ModalRequest | InvalidValue | CloseModal;
-
-// @public
-export interface Counterparty {
-    // (undocumented)
-    accountNumber?: string;
-    // (undocumented)
-    did?: string;
-    // (undocumented)
-    geographicAddress?: string;
-    // (undocumented)
-    name?: string;
-    // (undocumented)
-    type?: PersonType;
-    // (undocumented)
-    verified?: boolean;
-}
-
-// @public
-export interface DeclarationProof extends OwnershipProof {
-    // (undocumented)
-    attestation: string;
-    // (undocumented)
-    confirmed: boolean;
-    // (undocumented)
-    type: ProofTypes.SelfDeclaration;
-}
-
-// Warning: (ae-forgotten-export) The symbol "BlockchainAddress" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "CAIP19" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "TravelAddress" needs to be exported by the entry point notabene.d.ts
-//
-// @public
-export type destination = BlockchainAddress | CAIP19 | TravelAddress;
-
-// @public
-export class EmbeddedComponent {
-    constructor(url: string, value: Partial<Transaction>);
-    // (undocumented)
-    completion(): Promise<TransactionResponse>;
-    // Warning: (ae-forgotten-export) The symbol "ValidationError" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    get errors(): ValidationError[];
-    // (undocumented)
-    mount(parentId: string): void;
-    // (undocumented)
-    off(messageType: string, callback: MessageCallback): void;
-    // Warning: (ae-forgotten-export) The symbol "MessageCallback" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    on(messageType: string, callback: MessageCallback): void;
-    // (undocumented)
-    open(): void;
-    // Warning: (ae-incompatible-release-tags) The symbol "send" is marked as @public, but its signature references "HostMessage" which is marked as @internal
-    //
-    // (undocumented)
-    send(message: HostMessage): void;
-    // (undocumented)
-    update(value: Partial<Transaction>): void;
-    // (undocumented)
-    get url(): string;
-    // (undocumented)
-    get value(): Partial<Transaction>;
-}
-
-// Warning: (ae-forgotten-export) The symbol "UpdateValue" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "RequestResponse" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-internal-missing-underscore) The name "HostMessage" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export type HostMessage = UpdateValue | RequestResponse;
-
-// @public
-export type IVMS101 = {
-    originator?: Originator;
-    beneficiary?: Beneficiary;
-    originatingVASP?: OriginatingVASP;
-    beneficiaryVASP?: BeneficiaryVASP;
-    transferPath?: TransferPath;
-    payloadMetadata?: PayloadMetadata;
-};
-
-// @public
-export interface MicroTransferProof extends OwnershipProof {
-    // (undocumented)
-    amount: number;
-    // Warning: (ae-forgotten-export) The symbol "CAIP2" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    chain: CAIP2;
-    // (undocumented)
-    txhash: string;
-    // (undocumented)
-    type: ProofTypes.MicroTransfer;
-}
-
-// @public
-class Notabene {
-    constructor(config: NotabeneConfig);
-    // Warning: (ae-forgotten-export) The symbol "CallbackOptions" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    componentUrl(path: string, value: Partial<Transaction>, configuration?: any, callbacks?: CallbackOptions): string;
-    // (undocumented)
-    createComponent(path: string, value: Partial<Transaction>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
-    // (undocumented)
-    createWithdrawalAssist(value: Partial<Withdrawal>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
-    // (undocumented)
-    decodeFragmentToObject(fragment: string): Record<string, string>;
-}
-export { Notabene }
-export default Notabene;
-
-// @public
-export interface NotabeneConfig {
-    // (undocumented)
-    authToken: string;
-    // (undocumented)
-    dictionary?: {
-        [key: string]: string;
-    };
-    // (undocumented)
-    nodeUrl: string;
-    // (undocumented)
-    theme?: Theme;
-    // (undocumented)
-    uxUrl?: string;
-}
-
-// @public
-export interface OwnershipProof {
-    // Warning: (ae-forgotten-export) The symbol "CAIP10" needs to be exported by the entry point notabene.d.ts
-    //
-    // (undocumented)
-    address: CAIP10;
-    // (undocumented)
-    did: DID;
-    // (undocumented)
-    status: ProofStatus;
-    // (undocumented)
-    type: ProofTypes;
-}
-
-// @public
-export enum PersonType {
-    // (undocumented)
-    LEGAL = "legal",
-    // (undocumented)
-    NATURAL = "natural",
-    // (undocumented)
-    SELF = "self"
-}
-
-// @public
-export enum ProofStatus {
-    // (undocumented)
-    FAILED = "rejected",// Verification is pending
-    // (undocumented)
-    FLAGGED = "flagged",// Rejected
-    // (undocumented)
-    PENDING = "pending",// Flagged for manual review
-    // (undocumented)
-    VERIFIED = "verified"
-}
-
-// @public
-export enum ProofTypes {
-    // (undocumented)
-    MicroTransfer = "microtransfer",
-    // (undocumented)
-    PersonalSignBIP137 = "bip-137",
-    // (undocumented)
-    PersonalSignEIP191 = "eip-191",
-    // (undocumented)
-    PersonalSignEIP712 = "eip-712",
-    // (undocumented)
-    PersonalSignXPUB = "xpub",
-    // (undocumented)
-    Screenshot = "screenshot",
-    // (undocumented)
-    SelfDeclaration = "self-declaration"
-}
-
-// @public
-export interface ScreenshotProof extends OwnershipProof {
-    // (undocumented)
-    type: ProofTypes.Screenshot;
-    // (undocumented)
-    url: string;
-}
-
-// @public
-export interface SignatureProof extends OwnershipProof {
-    // (undocumented)
-    attestation: string;
-    // (undocumented)
-    proof: string;
-    // (undocumented)
-    type: ProofTypes.PersonalSignEIP191 | ProofTypes.PersonalSignEIP712 | ProofTypes.PersonalSignBIP137 | ProofTypes.PersonalSignXPUB;
-    // (undocumented)
-    wallet_provider: string;
-}
-
-// @public
-export enum Status {
-    // (undocumented)
-    BANNED = "banned",
-    // (undocumented)
-    EMPTY = "empty",
-    // (undocumented)
-    PENDING = "pending",
-    // (undocumented)
-    VERIFIED = "verified",
-    // (undocumented)
-    VERIFY = "verify"
-}
-
-// @public
-export type Theme = {
-    primaryColor: string;
-    secondaryColor: string;
-    fontFamily: string;
-    logo: string;
-};
-
-// @public
-export interface Transaction {
-    // (undocumented)
-    agent: Agent;
-    // (undocumented)
-    amountDecimal: number;
-    // (undocumented)
-    asset: TransactionAsset;
-    // (undocumented)
-    counterparty: Counterparty;
-    // (undocumented)
-    customAssetPrice?: {
-        price: number;
-        currency: string;
-    };
-    // (undocumented)
-    customer?: Counterparty;
-}
-
-// Warning: (ae-forgotten-export) The symbol "NotabeneAsset" needs to be exported by the entry point notabene.d.ts
-// Warning: (ae-forgotten-export) The symbol "DTI" needs to be exported by the entry point notabene.d.ts
-//
-// @public
-export type TransactionAsset = NotabeneAsset | CAIP19 | DTI;
-
-// @public
-export type TransactionResponse = {
-    value: Transaction;
-    ivms: IVMS101;
-    proof?: OwnershipProof;
-    valid: boolean;
-    status: Status;
-    errors: ValidationError[];
-};
-
-// @public
-export interface VASP extends Agent {
-    // (undocumented)
-    name?: string;
-    // (undocumented)
-    url?: string;
-}
-
-// @public
-export interface Wallet extends Agent {
-    // (undocumented)
-    proof: OwnershipProof;
-    // (undocumented)
-    wallet_connect_id?: string;
-}
-
-// Warning: (ae-forgotten-export) The symbol "BeneficiaryFields" needs to be exported by the entry point notabene.d.ts
-//
-// @public
-export interface Withdrawal extends BeneficiaryFields, Transaction {
-}
-
-// Warnings were encountered during analysis:
-//
-// ts-out/src/ivms/types.d.ts:246:5 - (ae-forgotten-export) The symbol "Originator" needs to be exported by the entry point notabene.d.ts
-// ts-out/src/ivms/types.d.ts:247:5 - (ae-forgotten-export) The symbol "Beneficiary" needs to be exported by the entry point notabene.d.ts
-// ts-out/src/ivms/types.d.ts:248:5 - (ae-forgotten-export) The symbol "OriginatingVASP" needs to be exported by the entry point notabene.d.ts
-// ts-out/src/ivms/types.d.ts:249:5 - (ae-forgotten-export) The symbol "BeneficiaryVASP" needs to be exported by the entry point notabene.d.ts
-// ts-out/src/ivms/types.d.ts:250:5 - (ae-forgotten-export) The symbol "TransferPath" needs to be exported by the entry point notabene.d.ts
-// ts-out/src/ivms/types.d.ts:251:5 - (ae-forgotten-export) The symbol "PayloadMetadata" needs to be exported by the entry point notabene.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```

package/index.html

@@ -1,137 +0,0 @@
-<!doctype html>
-<html lang="en">
-  ​
-  <head>
-    <meta charset="UTF-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Notabene Widget Example</title>
-    <script type="module">
-      import Notabene from '/src/notabene.ts';
-      const nb = new Notabene({
-        nodeUrl: 'https://api-qa.eu.notabene.dev',
-        uxUrl: 'http://localhost:8000',
-        authToken:
-          'eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NkstUiJ9.eyJpYXQiOjE3MjI5NDQ0NTcsImV4cCI6bnVsbCwidmMiOnsiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiLCJodHRwczovL2FwaS5ub3RhYmVuZS5pZC9zY2hlbWFzL3YxIl0sInR5cGUiOlsiVmVyaWZpYWJsZUNyZWRlbnRpYWwiLCJBY2Nlc3NUb2tlbiJdLCJjcmVkZW50aWFsU3ViamVjdCI6eyJub25jZSI6IjNkNGUxMzVjLWUzZjgtNGVjOC1iZTY1LTZhYjI4ODZhM2U3NSIsImV4cGlyYXRpb25EYXRlIjoxNzIzMDMwODU3NjY1LCJzY29wZSI6ImN1c3RvbWVyIiwidmFzcF9kaWQiOiJkaWQ6ZXRocjoweGQyODUzNGY3N2VkYjUyODRjN2I3ODg2YmVjNjk5ODI2NWNhYTFiMDYifX0sInN1YiI6ImRpZDpldGhyOjB4YWFjYmM3MGQ1ZGEzYjg0Mzk4ZjM1NmVkYzVmNjU2ZmMzNDVlMDk2ZiIsImlzcyI6ImRpZDpldGhyOjB4ZDI4NTM0Zjc3ZWRiNTI4NGM3Yjc4ODZiZWM2OTk4MjY1Y2FhMWIwNiJ9.h0yG5ev6X3oFtMkFBEmIXK9_iZtE1vrW51XjZ0-Yw7gbNKAKKpue01V4z8AgM08-1aPoJhugpNeGHGlyGq3vlwE',
-        theme: {
-          // primaryColor: '#fff',
-          // primaryFontColor: '#fff',
-          // secondaryFontColor: '#fff',
-          // backgroundColor: 'black',
-          // mode: 'dark',
-        },
-        // transactionTypeAllowed: 'VASP_2_VASP_ONLY',
-        // nonCustodialDeclarationType: 'DECLARATION',
-        // optInFeatures: ['REUSE_ADDRESS_OWNERSHIP_PROOF'],
-
-        // @deprecated
-        // beneficiaryDetails: ['beneficiaryNationalIdentification'],
-
-        // fieldsProps: {
-        //   nationalIdentification: {
-        //     forceDisplay: true,
-        //   },
-        //   dateAndPlaceOfBirth: {
-        //     forceDisplay: true,
-        //   },
-        //   geographicAddress: {
-        //     forceDisplay: true,
-        //     optional: true
-        //   },
-        //   counterparty: {
-        //     optional: true
-        //   }
-        // }
-        // fallbacks: [{flow: "WALLET_NOT_SUPPORTED", action: "REJECT"}]
-      });
-
-      const component = nb.createWithdrawalAssist({
-        asset: 'ETH',
-        customer: {
-          name: 'John Doe',
-          type: PersonType.NATURAL,
-        },
-        destination: '0x8e73ea19a72e89f20339f5a9e4cda8e4b230455c',
-        amountDecimal: 40.1,
-      });
-      component.mount('#withdrawal-assist');
-      component.on('error', console.error);
-      component.on('complete', (result) => {
-        console.log('result', result);
-        document.getElementById('result').innerText = JSON.stringify(
-          result,
-          null,
-          2,
-        );
-      });
-
-      const fullscreen = nb.createWithdrawalAssist(
-        {
-          asset: 'BTC',
-          // originatorAccountNumber: '0xdc0fF33a148031FasdfD1DE1e18e23456b25E1d8',
-          destination: '0x8e73ea19a72e89f20339f5a9e4cda8e4b230455c',
-          amountDecimal: 40.1,
-        },
-        {},
-        {
-          redirectUri: document.location.href,
-        },
-      );
-      document
-        .getElementById('open-fullscreen')
-        .addEventListener('click', () => {
-          document.location.hash = undefined;
-          fullscreen.open();
-        });
-      if (document.location.hash) {
-        const response = nb.decodeFragmentToObject(document.location.hash);
-        console.log(response);
-        document.getElementById('result').innerText = JSON.stringify(
-          JSON.parse(response['message']),
-          null,
-          2,
-        );
-      }
-    </script>
-    <link
-      rel="stylesheet"
-      href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.min.css"
-    />
-
-    <style>
-      body {
-        margin: 0;
-        padding: 1em;
-        max-width: 800px;
-      }
-      #container {
-        max-width: 100vw;
-      }
-      pre {
-        border: 1px solid #ccc;
-        padding: 1em;
-        font-family: monospace;
-      }
-    </style>
-  </head>
-  ​
-  <body>
-    <h1>Notabene Javascript SDK</h1>
-    <section>
-      <h2>Withdrawal Assist</h2>
-      <section>
-        <h3>Embedded</h3>
-        <div id="withdrawal-assist"></div>
-      </section>
-      <section>
-        <h3>Full Screen</h3>
-        <button id="open-fullscreen">Open fullscreen</button>
-      </section>
-      <section>
-        <h3>result</h3>
-        <pre id="result"></pre>
-      </section>
-    </section>
-  </body>
-  ​
-</html>