@notabene/javascript-sdk 2.0.0-next.3 → 2.0.0-next.5

package/temp/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/ts-out/src/__tests__/notabene.test.d.ts

@@ -1 +0,0 @@
-export {};

package/ts-out/src/__tests__/notabene.test.js

@@ -1,97 +0,0 @@
-import { fc, test } from '@fast-check/vitest';
-import { describe } from 'vitest';
-import { abitraryCallbackOptions, arbitraryComponent } from '../arbitraries';
-import Notabene from '../notabene';
-describe('Notabene', () => {
-    describe('defaults', () => {
-        test.prop([
-            fc.string({ minLength: 3 }),
-            fc.webUrl(),
-            arbitraryComponent(),
-            fc.object(),
-        ])('Should set the correct values', (authToken, nodeUrl, component, value) => {
-            const notabene = new Notabene({
-                nodeUrl,
-                authToken,
-            });
-            const url = new URL(notabene.componentUrl(component, value));
-            return (url.hash ===
-                `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}` &&
-                url.searchParams.get('nodeUrl') === nodeUrl &&
-                url.pathname === `/${component}`);
-        });
-    });
-    describe('minimal', () => {
-        test.prop([arbitraryComponent(), fc.object()])('Should set the correct values', (component, value) => {
-            const notabene = new Notabene({});
-            const url = new URL(notabene.componentUrl(component, value));
-            return (url.hash === `#value=${encodeURIComponent(JSON.stringify(value))}` &&
-                url.hostname === 'connect.notabene.id' &&
-                url.pathname === `/${component}`);
-        });
-    });
-    describe('with uxUrl', () => {
-        test.prop([
-            fc.string({ minLength: 3 }),
-            fc.webUrl(),
-            arbitraryComponent(),
-            fc.webAuthority(),
-            fc.object(),
-        ])('Should set the correct values', (authToken, nodeUrl, component, uxAuthority, value) => {
-            const notabene = new Notabene({
-                nodeUrl,
-                authToken,
-                uxUrl: `https://${uxAuthority}`,
-            });
-            const url = new URL(notabene.componentUrl(component, value));
-            const [domain, port] = uxAuthority.split(':');
-            return (url.hostname === domain &&
-                url.port === (port || '') &&
-                url.hash ===
-                    `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}` &&
-                url.searchParams.get('nodeUrl') === nodeUrl &&
-                url.pathname === `/${component}`);
-        });
-    });
-    describe('with value and configuration', () => {
-        test.prop([
-            fc.string({ minLength: 3 }),
-            fc.webUrl(),
-            arbitraryComponent(),
-            fc.object(),
-            fc.object(),
-        ])('Should set the correct values', (authToken, nodeUrl, component, value, configuration) => {
-            const notabene = new Notabene({
-                nodeUrl,
-                authToken,
-            });
-            const url = new URL(notabene.componentUrl(component, value, configuration));
-            return (url.hash ===
-                `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}&configuration=${encodeURIComponent(JSON.stringify(configuration))}` &&
-                url.searchParams.get('nodeUrl') === nodeUrl &&
-                url.pathname === `/${component}`);
-        });
-    });
-    describe('with value and configuration', () => {
-        test.prop([
-            fc.string({ minLength: 3 }),
-            fc.webUrl(),
-            arbitraryComponent(),
-            fc.object(),
-            fc.object(),
-            abitraryCallbackOptions(),
-        ])('Should set the correct values', (authToken, nodeUrl, component, value, configuration, callbacks) => {
-            const notabene = new Notabene({
-                nodeUrl,
-                authToken,
-            });
-            const url = new URL(notabene.componentUrl(component, value, configuration, callbacks));
-            return (url.hash ===
-                `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}&configuration=${encodeURIComponent(JSON.stringify(configuration))}` &&
-                url.searchParams.get('nodeUrl') === nodeUrl &&
-                url.pathname === `/${component}` &&
-                url.searchParams.get('callback_url') === callbacks.callback &&
-                url.searchParams.get('redirect_uri') === callbacks.redirectUri);
-        });
-    });
-});

package/ts-out/src/arbitraries.d.ts

@@ -1,4 +0,0 @@
-import fc from 'fast-check';
-import { CallbackOptions } from './types';
-export declare const arbitraryComponent: () => fc.Arbitrary<string>;
-export declare const abitraryCallbackOptions: () => fc.Arbitrary<CallbackOptions>;

package/ts-out/src/arbitraries.js

@@ -1,8 +0,0 @@
-import fc from 'fast-check';
-const COMPONENT_MATCHER = /^[a-z0-9-_]+$/;
-// Arbitraries
-export const arbitraryComponent = () => fc.stringMatching(COMPONENT_MATCHER);
-export const abitraryCallbackOptions = () => fc.record({
-    callback: fc.webUrl(),
-    redirectUri: fc.webUrl(),
-});

package/ts-out/src/components/EmbeddedComponent.d.ts

@@ -1,25 +0,0 @@
-import { HostMessage, Transaction, TransactionResponse, ValidationError } from '../types';
-import { MessageCallback } from '../utils/MessageEventManager';
-/**
- * An embedded Notabene component
- * @public
- */
-export default class EmbeddedComponent {
-    private _url;
-    private _value;
-    private _errors;
-    private iframe?;
-    private eventManager;
-    private ready;
-    constructor(url: string, value: Partial<Transaction>);
-    get url(): string;
-    get value(): Partial<Transaction>;
-    get errors(): ValidationError[];
-    open(): void;
-    mount(parentId: string): void;
-    send(message: HostMessage): void;
-    on(messageType: string, callback: MessageCallback): void;
-    off(messageType: string, callback: MessageCallback): void;
-    update(value: Partial<Transaction>): void;
-    completion(): Promise<TransactionResponse>;
-}

package/ts-out/src/components/EmbeddedComponent.js

@@ -1,87 +0,0 @@
-import { CMType, HMType, } from '../types';
-import { MessageEventManager, } from '../utils/MessageEventManager';
-/**
- * An embedded Notabene component
- * @public
- */
-export default class EmbeddedComponent {
-    _url;
-    _value;
-    _errors = [];
-    iframe;
-    eventManager;
-    ready = false;
-    constructor(url, value) {
-        this._url = url;
-        this._value = value;
-        this.eventManager = new MessageEventManager();
-        this.on(CMType.INVALID, (message) => {
-            if (message.type === CMType.INVALID) {
-                this._errors = message.errors;
-                this._value = message.value;
-            }
-        });
-        this.on(CMType.RESIZE, (message) => {
-            if (message.type === CMType.RESIZE) {
-                if (this.iframe)
-                    this.iframe.style.height = `${message.height}px`;
-            }
-        });
-    }
-    get url() {
-        return this._url;
-    }
-    get value() {
-        return this._value;
-    }
-    get errors() {
-        return this._errors;
-    }
-    open() {
-        document.location.href = this.url;
-    }
-    mount(parentId) {
-        this.iframe = document.createElement('iframe');
-        this.iframe.src = this.url;
-        this.iframe.style.width = '100%';
-        this.iframe.style.height = '100px';
-        this.iframe.style.border = 'none';
-        this.iframe.style.overflow = 'hidden';
-        window.addEventListener('message', (event) => {
-            if (event.source !== this.iframe?.contentWindow) {
-                return;
-            }
-            console.log('received message from iframe', event.data);
-            this.eventManager?.setPort(event.ports[0]);
-            this.ready = true;
-        });
-        const parent = document.querySelector(parentId);
-        if (!parent)
-            throw new Error(`parentID ${parentId} not found`);
-        parent.appendChild(this.iframe);
-        this.iframe?.contentWindow?.focus();
-    }
-    send(message) {
-        this.eventManager.send(message);
-    }
-    on(messageType, callback) {
-        this.eventManager.on(messageType, callback);
-    }
-    off(messageType, callback) {
-        this.eventManager.off(messageType, callback);
-    }
-    update(value) {
-        this._value = value;
-        this.send({ type: HMType.UPDATE, value });
-    }
-    completion() {
-        return new Promise((resolve, reject) => {
-            this.on(CMType.COMPLETE, (message) => {
-                resolve(message.response);
-            });
-            this.on('error', (message) => {
-                reject(new Error(message.message));
-            });
-        });
-    }
-}

package/ts-out/src/components/__tests__/EmbeddedComponent.test.d.ts

@@ -1 +0,0 @@
-export {};