@getopenpay/openpay-js 0.2.12 → 0.2.13-alpha.16b22e4

package/dist/index.d.ts

@@ -52,6 +52,13 @@ declare type ApplePayFlowCustomParams = {
     defaultFieldValues?: DefaultFieldValues;
 };
 
+declare enum Blockchain {
+    EVM = 'EVM',
+    SOL = 'Solana',
+}
+
+declare type BlockchainNetwork = keyof typeof Blockchain;
+
 declare type CdeConnection = {
     send: (data: CdeMessage) => Promise<unknown>;
 };
@@ -79,6 +86,28 @@ export declare type Config = ElementsFormProps & AllCallbacks;
 
 declare type CurrentStatus<T> = InitialStatus | SuccessStatus<T> | ErrorStatus;
 
+declare interface CustomerResponse {
+    /**
+     * The unique identifier that represents the customer
+     * @example "1234567890abcdef"
+     */
+    customerId: string;
+    /**
+     * The external customer reference ID used to tie this customer to a customer in an external system.
+     * @example "1234567890abcdef"
+     */
+    customerRefId: string | null;
+    /**
+     * The payment methods configured for this customer to make payments with.
+     */
+    paymentMethods: Omit<PaymentMethodResponse, 'entityId' | 'customer' | 'dateCreated'>[];
+    /**
+     * The date the customer record was created, represented as a Unix timestamp in seconds.
+     * @example 1716211200
+     */
+    dateCreated: number;
+}
+
 declare type CustomInitParams = {
     // You can put custom params for your init flows here
 
@@ -117,6 +146,8 @@ declare type CustomInitParams = {
     };
 };
 
+declare type CustomStyles = string;
+
 declare type DefaultFieldValues = Partial<Record<FieldNameEnum, string>>;
 
 declare type ElementProps<PlaceholderType extends z.ZodTypeAny = z.ZodString> = {
@@ -161,6 +192,14 @@ declare enum ElementTypeEnum {
 
 declare type ElementTypeEnumValue = ElementTypeEnum[keyof ElementTypeEnum];
 
+declare enum Environment {
+    Local = 'local',
+    Development = 'development',
+    Staging = 'staging',
+    Demo = 'demo',
+    Production = 'production',
+}
+
 declare type ErrorStatus = {
     status: 'error';
     isSuccess: false;
@@ -260,6 +299,13 @@ declare type InitApplePayFlowResult = {
     startFlow: (customParams?: ApplePayFlowCustomParams) => Promise<void>;
 };
 
+declare interface InitFailedEvent {
+    type: 'initFailed';
+    message: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    data: Record<string, any>;
+}
+
 declare type InitGooglePayFlowResult = {
     processor: PaymentProcessor;
     isAvailable: boolean;
@@ -267,11 +313,25 @@ declare type InitGooglePayFlowResult = {
     startFlow: (customParams?: GooglePayFlowCustomParams) => Promise<void>;
 };
 
+declare interface InitializedEvent {
+    entityId: string;
+}
+
 declare type InitialStatus = {
     status: 'initial';
     isSuccess: false;
 };
 
+declare type InitLoopCryptoFlowSuccess =
+| {
+    isAvailable: true;
+    widgetProps: LoopCryptoWidgetProps;
+    initLoopConnectProps: LoopConnectConfig;
+}
+| {
+    isAvailable: false;
+};
+
 declare type InitOjsFlow<T extends InitOjsFlowResult> = (params: InitOjsFlowParams) => Promise<T>;
 
 declare type InitOjsFlowParams = {
@@ -419,6 +479,51 @@ declare class LoadedOncePublisher<T> {
     };
 }
 
+declare interface LoopConnectConfig {
+    apiKey: string;
+    entityId: string;
+    merchantId?: string;
+    environment?: Environment | `${Environment}`;
+    customStyles?: CustomStyles;
+    onInitialized?: (detail: InitializedEvent) => void;
+    onInitFailed?: (detail: InitFailedEvent) => void;
+    onWalletChange?: (detail: WalletChangeEvent) => void;
+    onNetworkChange?: (detail: NetworkChangeEvent) => void;
+}
+
+declare type LoopCryptoFlowCustomParams =
+| {
+    customer: Omit<CustomerResponse, 'paymentMethods' | 'merchants' | 'dateCreated'>;
+    payin: PayInCompleteEvent;
+    // TODO: Move these to nonCdeFormInput prop
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    success: true;
+}
+| {
+    detail: PayInFailedEvent;
+    // TODO: Move these to nonCdeFormInput prop
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    success: false;
+};
+
+declare type LoopCryptoWidgetProps = {
+    paymentUsdAmount: number;
+    suggestedAuthorizationUsdAmount: number;
+    subscriptionRefId?: string;
+    customerRefId?: string;
+    invoiceRefId?: string;
+};
+
+declare interface NetworkChangeEvent {
+    id: number;
+    name: string;
+    chain: BlockchainNetwork;
+}
+
 declare type OjsContext = {
     /**
      * The secure token for the checkout session.
@@ -529,6 +634,12 @@ declare const OjsFlows = {
         run: runAirwallexApplePayFlow,
     },
 
+    // Loop
+    loopCrypto: {
+        init: initLoopFlow,
+        run: runLoopFlow,
+    },
+
     authorizeNetApplePay: {
         init: initAuthnetApplePayFlow,
         run: runAuthnetApplePayFlow,
@@ -589,6 +700,10 @@ export declare class OpenPayForm {
             publisher: LoadedOncePublisher<InitApplePayFlowResult>;
             initialize: (initParams: InitOjsFlowParams) => Promise<void>;
         };
+        readonly loop: {
+            publisher: LoadedOncePublisher<InitLoopCryptoFlowSuccess>;
+            initialize: (initParams: InitOjsFlowParams) => Promise<void>;
+        };
         readonly authorizeNetGooglePay: {
             publisher: LoadedOncePublisher<InitGooglePayFlowResult>;
             initialize: (initParams: InitOjsFlowParams) => Promise<void>;
@@ -659,6 +774,11 @@ export declare class OpenPayForm {
     } | {
         isAvailable: false;
         name: string;
+    } | {
+        isAvailable: true;
+        widgetProps: LoopCryptoWidgetProps;
+        initLoopConnectProps: LoopConnectConfig;
+        name: string;
     })[] | undefined;
     generalSubmit: <T extends SubmitMethod>(method: T, settings?: SubmitSettings<T>) => Promise<void> | undefined;
     /**
@@ -672,8 +792,224 @@ export declare class OpenPayForm {
     updateCallbacks: (newCallbacks: AllCallbacks) => void;
 }
 
+/**
+ * @deprecated Use interface PayInCreatedEvent for data returned from the creation of a PayIn
+ */
+declare interface PayInCompleteEvent extends PayinResponse {}
+
+declare enum PayInFailed {
+    INSUFFICIENT_BALANCE = 'insufficientBalance',
+    INSUFFICIENT_AUTHORIZATION = 'insufficientAuthorization',
+    SIGNED_MESSAGE_REQUIRED = 'signedMessageRequired',
+    CUSTOMER_CREATION_FAILED = 'customerCreationFailed',
+    PAYMENT_FAILED = 'paymentFailed',
+    TRANSACTION_FAILED = 'transactionFailed',
+}
+
+declare interface PayInFailedData {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error: Record<string, any> | undefined;
+}
+
+declare interface PayInFailedEvent {
+    type: PayInFailed;
+    message: string;
+    data: PayInFailedData;
+}
+
+declare interface PayinPaymentMethodResponse
+extends Omit<PaymentMethodResponse, 'merchantId' | 'entityId' | 'dateCreated'> {
+    /**
+     * The status of the payment method
+     */
+    status: 'ok' | 'insufficient_balance' | 'insufficient_authorization' | 'insufficient_balance_authorization';
+}
+
+declare interface PayinPayoutDestinationResponse
+extends Omit<PayoutDestinationResponse, 'merchantId' | 'entityId' | 'isDefault' | 'dateCreated'> {}
+
+declare interface PayinResponse {
+    /**
+     * The unique identifier for the payin
+     * @example "8f47c6e9-2b3a-4d5c-9f8e-1a2b3c4d5e6f"
+     */
+    payinId: string;
+    /**
+     * The unique identifier of the merchant this payin is associated with
+     * @example "67e55044-10b1-426f-9247-bb680e5fe0c8"
+     */
+    merchantId: string;
+    /**
+     * The amount to be paid, specified in either fiat or crypto based on amountType
+     * @example "100.00"
+     */
+    amount: string;
+    /**
+     * The type of the amount, either "fiat" or "token"
+     * @example "fiat"
+     */
+    amountType: 'fiat' | 'token';
+    /**
+     * The date the payment will take place, represented as a Unix timestamp
+     * @example 1716211200
+     */
+    billDate: number;
+    /**
+     * The unique invoice identifier representing this payin transaction
+     * @example "1234567890abcdef"
+     */
+    invoiceId: string;
+    /**
+     * (Optional) A description or note that provides additional context about this payin. This can be used to help identify or provide details about the payment for internal reference or customer communications.
+     * @example "Payment for Developer plan"
+     */
+    description: string | null;
+    /**
+     * (Optional) The external invoice ID used to tie this payin to an invoice in an external system
+     * @example "1234567890abcdef"
+     */
+    externalInvoiceRef: string | null;
+    /**
+     * The type of the payin, either "subscription" or "invoice"
+     * @example "subscription"
+     */
+    payinType: 'subscription' | 'invoice';
+    /**
+     * The status of the payin, can be "scheduled", "pending", "completed", or "failed"
+     * @example "scheduled"
+     */
+    payinStatus: 'scheduled' | 'pending' | 'completed' | 'failed' | 'canceled' | 'uncollectible' | 'draft';
+    /**
+     * The transaction details for the payin
+     */
+    transaction: PayinTransactionResponse | null;
+    /**
+     * The payment method used for this payin
+     */
+    paymentMethod: PayinPaymentMethodResponse;
+    /**
+     * The payout destination used for this payin
+     */
+    payoutDestination: PayinPayoutDestinationResponse;
+    /**
+     * The date the payin record was created, represented as a Unix timestamp in seconds.
+     * @example 1716211200
+     */
+    dateCreated: number;
+}
+
+declare interface PayinTransactionResponse {
+    /**
+     * The transaction id generated by the blockchain network when the transaction is processed
+     * @example "0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe"
+     */
+    transactionId: string;
+    /**
+     * The URL to view this transaction in a blockchain explorer. The specific explorer URL depends on the blockchain network the transaction was processed on
+     * @example "https://etherscan.io/tx/0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe"
+     */
+    transactionUrl: string;
+    /**
+     * The actual token amount that was transferred  including all decimal places. For example - an amount of 1.99 USDC will result in a `amountTransferred` of "1990000"
+     * @example "1990000"
+     */
+    amountTransferred: string | null;
+    /**
+     * The exchange rate that was applied when the payment was processed on the blockchain
+     */
+    exchangeRate: PaymentMethodTokenExchangeRate | null;
+}
+
 declare type PaymentDataRequest = google.payments.api.PaymentDataRequest;
 
+declare interface PaymentMethodPreAuthorization {
+    /**
+     * The balance of the payment method formatted in the token amount
+     * @example "100"
+     */
+    balance: string;
+    /**
+     * The authorization amount of the payment method formatted in the token amount
+     * @example "49.9"
+     */
+    authorization: string;
+}
+
+declare interface PaymentMethodResponse {
+    /**
+     * The unique identifier for the payment method
+     * @example "1234567890abcdef"
+     */
+    paymentMethodId: string;
+    /**
+     * The unique identifier of the merchant this payment method is associated with
+     * @example "67e55044-10b1-426f-9247-bb680e5fe0c8"
+     */
+    merchantId: string;
+    /**
+     * The name of the payment method
+     * @example "My Crypto Wallet"
+     */
+    paymentMethodName: string;
+    /**
+     * The customers that are associated with the payment method
+     */
+    customer: Omit<CustomerResponse, 'paymentMethods' | 'merchants' | 'dateCreated'>;
+    /**
+     * The blockchain network ID the payment method is associated with
+     * @example 1
+     */
+    networkId: number;
+    /**
+     * The blockchain wallet address where payments will be sent from
+     * @example "0x1234567890abcdef"
+     */
+    walletAddress: string;
+    /**
+     * Whether the payment method is the default payment method for wallet address
+     * @example true
+     */
+    isDefault: boolean;
+    /**
+     * The token associated with the payment method
+     */
+    token: PaymentMethodToken;
+    /**
+     * The status of the payment method, including the wallet's balance and authorization status
+     */
+    preAuthorization: PaymentMethodPreAuthorization | null;
+    /**
+     * The date the payment method record was created, represented as a Unix timestamp in seconds.
+     * @example 1716211200
+     */
+    dateCreated: number;
+}
+
+declare interface PaymentMethodToken extends Omit<TokenResponse, 'networkId'> {
+    /**
+     * The exchange rate of the token
+     */
+    exchangeRates: PaymentMethodTokenExchangeRate[];
+}
+
+declare interface PaymentMethodTokenExchangeRate {
+    /**
+     * The currency code. Only "USD" is supported at this time.
+     * @example "USD"
+     */
+    currency: string;
+    /**
+     * The price of the token in the specified currency code. Accurate to 4 decimal places, e.g. a price of "1.9900" represents $1.99
+     * @example "10000"
+     */
+    price: string;
+    /**
+     * The Unix timestamp (in seconds) when this exchange rate was last updated
+     * @example 1715731200
+     */
+    timestamp: number;
+}
+
 declare const PaymentProcessor = z.enum(['stripe', 'airwallex', 'authorize_net']);
 
 declare type PaymentProcessor = z.infer<typeof PaymentProcessor>;
@@ -696,12 +1032,46 @@ declare type PaymentRequestStatus = {
     startFlow: (params?: PaymentRequestStartParams) => Promise<void>;
 };
 
+declare interface PayoutDestinationResponse {
+    /**
+     * The unique identifier for the payout destination
+     * @example "1234567890abcdef"
+     */
+    payoutDestinationId: string;
+    /**
+     * The merchant ID associated with this payout destination
+     * @example "1234567890abcdef"
+     */
+    merchantId: string;
+    /**
+     * The blockchain network ID the payout destination is associated with
+     * @example 1
+     */
+    networkId: number;
+    /**
+     * The blockchain wallet address where payments will be sent. Must be a valid address for the specified network.
+     * @example "0x1234567890abcdef"
+     */
+    walletAddress: string;
+    /**
+     * Whether the payout destination is the default payout destination for the merchant.
+     * @example true
+     */
+    isDefault: boolean;
+    /**
+     * The date the payout destination record was created, represented as a Unix timestamp in seconds.
+     * @example 1716211200
+     */
+    dateCreated: number;
+}
+
 declare type ProcessorSpecificSubmitSettings<T extends SubmitMethod = SubmitMethod> = {
     'pockyt-paypal': { useRedirectFlow?: boolean };
     'airwallex-google-pay': GooglePayFlowCustomParams;
     'airwallex-apple-pay': ApplePayFlowCustomParams;
     'authorizenet-google-pay': GooglePayFlowCustomParams;
     'authorizenet-apple-pay': ApplePayFlowCustomParams;
+    'loop-crypto': LoopCryptoFlowCustomParams;
 }[T];
 
 declare type PRStatuses = Record<PaymentRequestProvider, PaymentRequestStatus>;
@@ -732,6 +1102,7 @@ export declare enum SubmitMethods {
     airwallexApplePay = 'airwallex-apple-pay',
     authorizenetGooglePay = 'authorizenet-google-pay',
     authorizenetApplePay = 'authorizenet-apple-pay',
+    loopCrypto = 'loop-crypto',
 }
 
 export declare type SubmitSettings<T extends SubmitMethod = SubmitMethod> = ProcessorSpecificSubmitSettings<T> &
@@ -743,4 +1114,37 @@ declare type SuccessStatus<T> = {
     loadedValue: T;
 };
 
+declare interface TokenResponse {
+    /**
+     * The unique identifier for the token used by the payment type.
+     * @example "123e4567-e89b-12d3-a456-426614174000"
+     */
+    tokenId: string;
+    /**
+     * The blockchain network ID the token is associated with
+     * @example 1
+     */
+    networkId: number;
+    /**
+     * The token symbol that identifies the token on the blockchain network
+     * @example "USDC"
+     */
+    symbol: string;
+    /**
+     * The token contract address for the payment type
+     * @example "0x1234567890abcdef"
+     */
+    address: string;
+    /**
+     * The number of decimal places used to represent token amounts
+     * @example 6
+     */
+    decimals: number;
+}
+
+declare interface WalletChangeEvent {
+    address: string;
+    ens: string | undefined;
+}
+
 export { }