@coinflowlabs/vue 0.1.0

package/dist/lib/common/CoinflowTypes.d.ts

@@ -0,0 +1,309 @@
+import type { Connection, VersionedTransaction, PublicKey, Signer, Transaction } from '@solana/web3.js';
+export declare enum SettlementType {
+    Credits = "Credits",
+    USDC = "USDC",
+    Bank = "Bank"
+}
+export declare enum MerchantStyle {
+    Rounded = "rounded",
+    Sharp = "sharp",
+    Pill = "pill"
+}
+export type MerchantTheme = {
+    primary?: string;
+    background?: string;
+    backgroundAccent?: string;
+    backgroundAccent2?: string;
+    textColor?: string;
+    textColorAccent?: string;
+    textColorAction?: string;
+    font?: string;
+    style?: MerchantStyle;
+};
+export interface CustomerInfo {
+    name?: string;
+    verificationId?: string;
+    displayName?: string;
+    address?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    ip?: string;
+    lat?: string;
+    lng?: string;
+}
+/** Coinflow Types **/
+export type CoinflowBlockchain = 'solana' | 'near' | 'eth' | 'polygon' | 'base';
+export type CoinflowEnvs = 'prod' | 'staging' | 'staging-live' | 'sandbox' | 'local';
+export interface CoinflowTypes {
+    merchantId: string;
+    env?: CoinflowEnvs;
+    loaderBackground?: string;
+    blockchain: CoinflowBlockchain;
+    handleHeightChange?: (height: string) => void;
+    theme?: MerchantTheme;
+}
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type OnSuccessMethod = (args: {
+    paymentId: string;
+    hash?: string | undefined;
+} | string) => void | Promise<void>;
+/** Wallets **/
+export interface SolanaWallet {
+    publicKey: PublicKey | null;
+    signTransaction?: <T extends Transaction | VersionedTransaction>(transaction: T) => Promise<T>;
+    sendTransaction: <T extends Transaction | VersionedTransaction>(transaction: T) => Promise<string>;
+    signMessage?: (message: Uint8Array) => Promise<Uint8Array>;
+}
+export interface NearWallet {
+    accountId: string;
+    signAndSendTransaction: (transaction: unknown) => Promise<{
+        transaction: {
+            hash: string;
+        };
+    }>;
+}
+type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, Array<string>>;
+export type EthWallet = {
+    address: string | null | undefined;
+    sendTransaction: (transaction: {
+        to: string;
+        from?: string;
+        nonce?: Bytes | bigint | string | number;
+        gasLimit?: Bytes | bigint | string | number;
+        gasPrice?: Bytes | bigint | string | number;
+        data?: BytesLike;
+        value?: Bytes | bigint | string | number;
+        chainId?: number;
+        type?: number;
+        accessList?: AccessListish;
+        maxPriorityFeePerGas?: Bytes | bigint | string | number;
+        maxFeePerGas?: Bytes | bigint | string | number;
+        customData?: Record<string, any>;
+        ccipReadEnabled?: boolean;
+    }) => Promise<{
+        hash: string;
+    }>;
+    signMessage: (message: string) => Promise<string>;
+};
+/** History **/
+export interface CoinflowSolanaHistoryProps extends CoinflowTypes {
+    wallet: SolanaWallet;
+    connection: Connection;
+    blockchain: 'solana';
+}
+export interface CoinflowNearHistoryProps extends CoinflowTypes {
+    wallet: NearWallet;
+    blockchain: 'near';
+}
+export interface CoinflowEvmHistoryProps extends CoinflowTypes {
+    wallet: EthWallet;
+}
+export interface CoinflowEthHistoryProps extends CoinflowEvmHistoryProps {
+    blockchain: 'eth';
+}
+export interface CoinflowPolygonHistoryProps extends CoinflowEvmHistoryProps {
+    blockchain: 'polygon';
+}
+export interface CoinflowBaseHistoryProps extends CoinflowEvmHistoryProps {
+    blockchain: 'base';
+}
+export type CoinflowHistoryProps = CoinflowSolanaHistoryProps | CoinflowNearHistoryProps | CoinflowPolygonHistoryProps | CoinflowEthHistoryProps | CoinflowBaseHistoryProps;
+/** Transactions **/
+export type NearFtTransferCallAction = {
+    methodName: 'ft_transfer_call';
+    args: object;
+    gas: string;
+    deposit: string;
+};
+type Bytes = ArrayLike<number>;
+type BytesLike = Bytes | string;
+/** Purchase **/
+export type ChargebackProtectionData = ChargebackProtectionItem[];
+export interface ChargebackProtectionItem {
+    /**
+     * The name of the product
+     */
+    productName: string;
+    /**
+     * The product type. Possible values include: inGameProduct, gameOfSkill, dataStorage, computingResources, sportsTicket, eSportsTicket, musicTicket, conferenceTicket, virtualSportsTicket, virtualESportsTicket, virtualMusicTicket, virtualConferenceTicket, alcohol, DLC, subscription, fundACause, realEstate, computingContract, digitalArt, topUp
+     */
+    productType: 'inGameProduct' | 'gameOfSkill' | 'dataStorage' | 'computingResources' | 'sportsTicket' | 'eSportsTicket' | 'musicTicket' | 'conferenceTicket' | 'virtualSportsTicket' | 'virtualESportsTicket' | 'virtualMusicTicket' | 'virtualConferenceTicket' | 'alcohol' | 'DLC' | 'subscription' | 'fundACause' | 'realEstate' | 'computingContract' | 'digitalArt' | 'topUp' | 'ownershipContract';
+    /**
+     * The item's list price
+     */
+    /**
+     * The number of units sold
+     */
+    quantity: number;
+    /**
+     * Any additional data that the store can provide on the product, e.g. description, link to image, etc.
+     */
+    rawProductData?: Record<string, any>;
+}
+export interface CoinflowCommonPurchaseProps extends CoinflowTypes {
+    amount?: number | string;
+    onSuccess?: OnSuccessMethod;
+    webhookInfo?: object;
+    email?: string;
+    chargebackProtectionData?: ChargebackProtectionData;
+    planCode?: string;
+    disableApplePay?: boolean;
+    disableGooglePay?: boolean;
+    customerInfo?: CustomerInfo;
+    settlementType?: SettlementType;
+    authOnly?: boolean;
+    deviceId?: string;
+    jwtToken?: string;
+    /**
+     * If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list.
+     *
+     * Example:
+     * Primary origin that will be interacting with the Coinflow iFrame: foo.com
+     * Subsequent origins that will render foo.com: bar.com
+     * The origin array would then be: [https://foo.com,https://bar.com]
+     */
+    origins?: string[];
+}
+export interface CoinflowSolanaPurchaseProps extends CoinflowCommonPurchaseProps {
+    wallet: SolanaWallet;
+    transaction?: Transaction | VersionedTransaction;
+    partialSigners?: Signer[];
+    debugTx?: boolean;
+    connection: Connection;
+    blockchain: 'solana';
+    token?: PublicKey | string;
+    rent?: {
+        lamports: string | number;
+    };
+    nativeSolToConvert?: {
+        lamports: string | number;
+    };
+}
+export interface CoinflowNearPurchaseProps extends CoinflowCommonPurchaseProps {
+    wallet: NearWallet;
+    blockchain: 'near';
+    action?: NearFtTransferCallAction;
+    nearDeposit?: string;
+}
+export interface CoinflowEvmPurchaseProps extends CoinflowCommonPurchaseProps {
+    transaction?: EvmTransactionData;
+    token?: string;
+    wallet: EthWallet;
+}
+export interface CoinflowPolygonPurchaseProps extends CoinflowEvmPurchaseProps {
+    blockchain: 'polygon';
+}
+export interface CoinflowEthPurchaseProps extends CoinflowEvmPurchaseProps {
+    blockchain: 'eth';
+}
+export interface CoinflowBasePurchaseProps extends CoinflowEvmPurchaseProps {
+    blockchain: 'base';
+}
+export type CoinflowPurchaseProps = CoinflowSolanaPurchaseProps | CoinflowNearPurchaseProps | CoinflowPolygonPurchaseProps | CoinflowEthPurchaseProps | CoinflowBasePurchaseProps;
+/** Withdraw **/
+export interface CoinflowCommonWithdrawProps extends CoinflowTypes {
+    onSuccess?: OnSuccessMethod;
+    tokens?: string[];
+    lockDefaultToken?: boolean;
+    amount?: number;
+    email?: string;
+    bankAccountLinkRedirect?: string;
+    additionalWallets?: {
+        wallet: string;
+        blockchain: 'solana' | 'eth' | 'near' | 'polygon';
+    }[];
+    lockAmount?: boolean;
+    transactionSigner?: string;
+    /**
+     * If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list.
+     *
+     * Example:
+     * Primary origin that will be interacting with the Coinflow iFrame: foo.com
+     * Subsequent origins that will render foo.com: bar.com
+     * The origin array would then be: [https://foo.com,https://bar.com]
+     */
+    origins?: string[];
+}
+export interface CoinflowSolanaWithdrawProps extends CoinflowCommonWithdrawProps {
+    wallet: SolanaWallet;
+    connection: Connection;
+    blockchain: 'solana';
+}
+export interface CoinflowNearWithdrawProps extends CoinflowCommonWithdrawProps {
+    wallet: NearWallet;
+    blockchain: 'near';
+}
+export interface CoinflowEvmWithdrawProps extends CoinflowCommonWithdrawProps {
+    wallet: EthWallet;
+    usePermit?: boolean;
+}
+export interface CoinflowEthWithdrawProps extends CoinflowEvmWithdrawProps {
+    blockchain: 'eth';
+    usePermit?: boolean;
+}
+export interface CoinflowPolygonWithdrawProps extends CoinflowEvmWithdrawProps {
+    blockchain: 'polygon';
+}
+export interface CoinflowBaseWithdrawProps extends CoinflowEvmWithdrawProps {
+    blockchain: 'base';
+}
+export type CoinflowWithdrawProps = CoinflowSolanaWithdrawProps | CoinflowNearWithdrawProps | CoinflowEthWithdrawProps | CoinflowPolygonWithdrawProps | CoinflowBaseWithdrawProps;
+export interface CommonEvmRedeem {
+    waitForHash?: boolean;
+}
+export interface NormalRedeem extends CommonEvmRedeem {
+    transaction: {
+        to: string;
+        data: string;
+    };
+}
+export interface KnownTokenIdRedeem extends NormalRedeem {
+    nftContract: string;
+    nftId: string;
+}
+export interface SafeMintRedeem extends NormalRedeem {
+    type: 'safeMint';
+    nftContract?: string;
+}
+export interface ReturnedTokenIdRedeem extends NormalRedeem {
+    type: 'returned';
+    nftContract?: string;
+}
+type ReservoirNftIdItem = Omit<KnownTokenIdRedeem, keyof NormalRedeem>;
+interface ReservoirOrderIdItem {
+    orderId: string;
+}
+type ReservoirItem = ReservoirNftIdItem | ReservoirOrderIdItem;
+type ReservoirItems = ReservoirItem | ReservoirItem[];
+export interface ReservoirRedeem extends CommonEvmRedeem {
+    type: 'reservoir';
+    items: ReservoirItems;
+}
+export type EvmTransactionData = SafeMintRedeem | ReturnedTokenIdRedeem | ReservoirRedeem | KnownTokenIdRedeem | NormalRedeem;
+export interface CoinflowIFrameProps extends Omit<CoinflowTypes, 'merchantId'>, Pick<CoinflowCommonPurchaseProps, 'chargebackProtectionData' | 'webhookInfo' | 'amount' | 'customerInfo' | 'settlementType' | 'email' | 'planCode' | 'deviceId' | 'jwtToken' | 'origins'>, Pick<CoinflowCommonWithdrawProps, 'bankAccountLinkRedirect' | 'additionalWallets' | 'transactionSigner' | 'lockAmount' | 'lockDefaultToken' | 'origins'>, Pick<CoinflowEvmPurchaseProps, 'authOnly'>, Pick<CoinflowSolanaPurchaseProps, 'rent' | 'nativeSolToConvert' | 'token'> {
+    walletPubkey: string | null | undefined;
+    route: string;
+    routePrefix?: string;
+    transaction?: string;
+    tokens?: string[] | PublicKey[];
+    nearDeposit?: string;
+    merchantCss?: string;
+    color?: 'white' | 'black';
+    disableApplePay?: boolean;
+    disableGooglePay?: boolean;
+    theme?: MerchantTheme;
+    usePermit?: boolean;
+}
+export declare enum CardType {
+    VISA = "VISA",
+    MASTERCARD = "MSTR",
+    AMEX = "AMEX",
+    DISCOVER = "DISC"
+}
+export {};

package/dist/lib/common/CoinflowUtils.d.ts

@@ -0,0 +1,21 @@
+import { CoinflowBlockchain, CoinflowEnvs, CoinflowIFrameProps, CoinflowPurchaseProps } from './CoinflowTypes';
+export declare class CoinflowUtils {
+    env: CoinflowEnvs;
+    url: string;
+    constructor(env?: CoinflowEnvs);
+    getNSurePartnerId(merchantId: string): Promise<string | undefined>;
+    getCreditBalance(publicKey: string, merchantId: string, blockchain: 'solana' | 'near'): Promise<{
+        cents: number;
+    }>;
+    static getCoinflowBaseUrl(env?: CoinflowEnvs): string;
+    static getCoinflowApiUrl(env?: CoinflowEnvs): string;
+    static getCoinflowUrl({ walletPubkey, route, routePrefix, env, amount, transaction, blockchain, webhookInfo, email, loaderBackground, handleHeightChange, bankAccountLinkRedirect, additionalWallets, nearDeposit, chargebackProtectionData, merchantCss, color, rent, lockDefaultToken, token, tokens, planCode, disableApplePay, disableGooglePay, customerInfo, settlementType, lockAmount, nativeSolToConvert, theme, usePermit, transactionSigner, authOnly, deviceId, jwtToken, origins, }: CoinflowIFrameProps): string;
+    static getTransaction(props: CoinflowPurchaseProps): string | undefined;
+    static byBlockchain<T>(blockchain: CoinflowBlockchain, args: {
+        solana: T;
+        near: T;
+        eth: T;
+        polygon: T;
+        base: T;
+    }): T;
+}

package/dist/lib/common/SolanaPeerDeps.d.ts

@@ -0,0 +1,5 @@
+import * as SolanaWeb3Js from '@solana/web3.js';
+import base58Imported from 'bs58';
+declare const web3: typeof SolanaWeb3Js | undefined;
+declare const base58: typeof base58Imported | undefined;
+export { web3, base58 };

package/dist/lib/common/card-form/TokenEx.d.ts

@@ -0,0 +1,106 @@
+export interface TokenizationResponse {
+    cardType: string;
+    cvvIncluded: true;
+    firstSix: string;
+    lastFour: string;
+    referenceNumber: string;
+    token: string;
+    tokenHMAC: string;
+}
+declare global {
+    namespace TokenEx {
+        interface FraudServicesConfig {
+            useKount?: boolean;
+            kount?: {
+                merchantId?: string;
+                mode?: string;
+                anId?: string;
+            };
+        }
+        interface Config {
+            debug?: boolean;
+            enablePrettyFormat?: boolean;
+            maskInput?: boolean;
+            enableValidateOnBlur?: boolean;
+            enableAriaRequired?: boolean;
+            pci?: boolean;
+            cvvOnly?: boolean;
+            allowUnknownCardTypes?: boolean;
+            enableAutoComplete?: boolean;
+            returnAutoCompleteValues?: boolean;
+            returnKhash?: boolean;
+            returnWhash?: boolean;
+            enforceLuhnCompliance?: boolean;
+            use3DS?: boolean;
+            validateOnKeyUp?: boolean;
+            validateOnCvvKeyUp?: boolean;
+            expiresInSeconds?: number;
+            useExtendedBIN?: boolean;
+            inlineIframeJavaScript?: boolean;
+            iframeVersion?: number;
+            authenticationKey?: string;
+            origin?: string;
+            tokenExID?: string;
+            timestamp?: string;
+            tokenScheme?: string;
+            token?: string;
+            customDataLabel?: string;
+            customCvvDataLabel?: string;
+            title?: string;
+            cvvTitle?: string;
+            inputTitle?: string;
+            cvvInputTitle?: string;
+            cardMaxLengths?: {
+                visa?: number;
+                mastercard?: number;
+                americanExpress?: number;
+                discover?: number;
+                jcb?: number;
+                diners?: number;
+            };
+            fraudServices?: FraudServicesConfig;
+            threeDSMethodNotificationUrl?: string;
+            customDataTypes?: string | object;
+            cvvContainerID?: string;
+            cvvPlaceholder?: string;
+            cardType?: string;
+            forterSiteId?: string;
+            forterUsername?: string;
+            customRegEx?: string;
+            placeholder?: string;
+            inputType?: string;
+            inputMode?: string;
+            font?: string;
+            cvv?: boolean;
+            styles: {
+                base: string;
+                focus: string;
+                error: string;
+                cvv: {
+                    base: string;
+                    focus: string;
+                    error: string;
+                };
+            };
+        }
+        interface IframeAPI {
+            load(): void;
+            on: (event: string, callback: (data?: any) => void) => void;
+            tokenize(): void;
+            validate(): void;
+            reset(): void;
+            blur(): void;
+            cvvBlur(): void;
+            focus(): void;
+            cvvFocus(): void;
+            remove(): void;
+            toggleMask(): void;
+            toggleCvvMask(): void;
+            setPAN(pan: string): void;
+            binLookup(): void;
+            validateConfig(): void;
+            setFraudServicesRequestDetails(data: string): void;
+        }
+        function Iframe(containerID: string, configuration: Config): IframeAPI;
+    }
+}

package/dist/lib/common/card-form/cardFormTypes.d.ts

@@ -0,0 +1,44 @@
+import { CSSProperties } from 'react';
+import { TokenizationResponse } from './TokenEx';
+import { CardType, CoinflowEnvs } from '../CoinflowTypes';
+export declare const TokenExCardNumberIframeId = "tokenExCardNumber";
+export declare const TokenExCvvContainerID = "tokenExCardCvv";
+export interface TokenExIframe extends ReturnType<typeof TokenEx.Iframe> {
+    tokenize: () => Promise<TokenizationResponse>;
+}
+export declare const CARD_TYPE_MAPPING: Record<CardType, string>;
+export interface TokenExIFrameConfiguration {
+    origin: string;
+    timestamp: string;
+    tokenExID: string;
+    tokenScheme: string;
+    authenticationKey: string;
+    pci: true;
+    token?: string;
+}
+export interface CardFormInputStyles {
+    base: CSSProperties | string;
+    focus?: CSSProperties | string;
+    error?: CSSProperties | string;
+}
+export type CoinflowCardTokenResponse = {
+    token: string;
+};
+export interface CoinflowCardNumberInputProps {
+    env: CoinflowEnvs;
+    css: CardFormInputStyles & {
+        cvv: CardFormInputStyles;
+    };
+    debug?: boolean;
+    origins?: string[];
+}
+export interface CoinflowCvvOnlyInputProps {
+    token: string;
+    cardType: CardType;
+    env: CoinflowEnvs;
+    css: CardFormInputStyles & {
+        cvv: CardFormInputStyles;
+    };
+    debug?: boolean;
+    origins?: string[];
+}

package/dist/lib/common/card-form/tokenexHelpers.d.ts

@@ -0,0 +1,43 @@
+import { CardType, CoinflowEnvs } from '../CoinflowTypes';
+import { TokenExIframe, TokenExIFrameConfiguration } from './cardFormTypes';
+export declare function getIframeConfig({ token, origins, env, }: {
+    token?: string;
+    origins: string[] | undefined;
+    env: CoinflowEnvs;
+}): Promise<TokenExIFrameConfiguration>;
+export declare function setTokenExScriptTag({ env, setTokenExScriptLoaded, }: {
+    env: CoinflowEnvs;
+    setTokenExScriptLoaded: (b: boolean) => void;
+}): void;
+export declare function doInitializeCvvOnlyTokenExIframe({ token, cardType, css, debug, fontFamily, origins, tokenExScriptLoaded, env, setCachedToken, setLoaded, }: {
+    token: string;
+    cardType: CardType;
+    css: string;
+    debug?: boolean;
+    fontFamily?: string;
+    origins: string[] | undefined;
+    tokenExScriptLoaded: boolean;
+    env: CoinflowEnvs;
+    setCachedToken: (s: string | undefined) => void;
+    setLoaded: (b: boolean) => void;
+}): Promise<TokenExIframe | undefined>;
+export declare function doInitializeTokenExIframe({ css, debug, fontFamily, origins, tokenExScriptLoaded, env, setCachedToken, setLoaded, }: {
+    css: string;
+    debug?: boolean;
+    fontFamily?: string;
+    origins: string[] | undefined;
+    tokenExScriptLoaded: boolean;
+    env: CoinflowEnvs;
+    setCachedToken: (s: string | undefined) => void;
+    setLoaded: (b: boolean) => void;
+}): Promise<TokenExIframe | undefined>;
+export declare function doInitializeTokenExCardOnlyIframe({ css, debug, fontFamily, origins, tokenExScriptLoaded, env, setCachedToken, setLoaded, }: {
+    css: string;
+    debug?: boolean;
+    fontFamily?: string;
+    origins: string[] | undefined;
+    tokenExScriptLoaded: boolean;
+    env: CoinflowEnvs;
+    setCachedToken: (s: string | undefined) => void;
+    setLoaded: (b: boolean) => void;
+}): Promise<TokenExIframe | undefined>;

package/dist/lib/common/index.d.ts

@@ -0,0 +1,6 @@
+export * from './CoinflowTypes';
+export * from './CoinflowUtils';
+export * from './CoinflowLibMessageHandlers';
+export * from './card-form/cardFormTypes';
+export * from './card-form/TokenEx';
+export * from './card-form/tokenexHelpers';

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@coinflowlabs/vue",
+  "private": false,
+  "version": "0.1.0",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "./dist/coinflow-vue.umd.cjs",
+  "module": "./dist/coinflow-vue.js",
+  "exports": {
+    ".": {
+      "import": "./dist/coinflow-vue.js",
+      "require": "./dist/coinflow-vue.umd.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "vue:dev": "vite",
+    "build": "npm run clean && npm run codegen && vue-tsc && vite build",
+    "preview": "vite preview",
+    "codegen": "mkdir -p ./src/lib/common/ && cp -r ../lib-common/src/ ./src/lib/common/"
+  },
+  "peerDependencies": {
+    "vue": "~3.4.30",
+    "@solana/web3.js": ">=1.54.0",
+    "bs58": "^4.0.1"
+  },
+  "devDependencies": {
+    "@types/bs58": "^4.0.4",
+    "@rushstack/eslint-patch": "^1.2.0",
+    "@types/node": "^18.11.18",
+    "@vitejs/plugin-vue": "^4.0.0",
+    "@vue/eslint-config-prettier": "^7.0.0",
+    "@vue/eslint-config-typescript": "^11.0.2",
+    "eslint": "^8.31.0",
+    "eslint-plugin-vue": "^9.8.0",
+    "prettier": "^2.8.1",
+    "typescript": "^4.9.3",
+    "vite": "^4.0.0",
+    "vite-plugin-dts": "^1.7.1",
+    "vitepress": "^1.0.0-alpha.34",
+    "vue": "^3.2.45",
+    "vue-tsc": "^1.0.11"
+  },
+  "dependencies": {
+    "lz-string": "^1.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@solana/web3.js": {
+      "optional": true
+    },
+    "bs58": {
+      "optional": true
+    }
+  }
+}