@vonq/hapi-elements-types 1.4.0 → 1.6.0

package/src/wallet/service.types.ts

@@ -0,0 +1,26 @@
+import { Wallet, WalletATSSettings, WalletPaymentIntentRequest } from "./types"
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WalletServiceGetATSSettingsHandler =
+    () => Promise<WalletATSSettings>
+export type WalletServiceGetWalletHandler = (
+    preventSettingIsLoading?: boolean,
+) => Promise<Wallet>
+export type WalletServiceCreateWalletHandler = () => Promise<Wallet>
+
+export type WindowHapiServiceWallet = WindowHapiModuleWithConstructorArgs<
+    {
+        getATSSettings: HapiServiceFunctionWithLifecycleHooks<WalletServiceGetATSSettingsHandler>
+        getWallet: HapiServiceFunctionWithLifecycleHooks<WalletServiceGetWalletHandler>
+        createWallet: HapiServiceFunctionWithLifecycleHooks<WalletServiceCreateWalletHandler>
+        createPaymentIntent: (
+            paymentParams: WalletPaymentIntentRequest,
+        ) => Promise<void>
+        resetTopUpState: () => void
+    },
+    { readonly service: WindowHapiService }
+>

package/src/wallet/state.types.ts

@@ -0,0 +1,58 @@
+import { ProductPriceCurrency } from "../product/enums"
+import {
+    Wallet,
+    WalletPaymentIntentPaymentMethod,
+    WalletPaymentIntentRequest,
+} from "./types"
+
+export type WalletState = {
+    /**
+     * User's Wallet that can hold credits to be used on Creating/Ordering a Campaign
+     */
+    wallet: Wallet | null
+    /**
+     * User's balance in dollars converted from cents through `wallet.balance`. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    balanceInUSD: number | null
+    /**
+     * Indicates whether or not user has enough credits/balance to Order a Campaign
+     */
+    balanceIsEnoughToOrderCampaign: boolean
+    /**
+     * Shows a loading spinner while wallet is loading
+     */
+    walletIsLoading: boolean
+    /**
+     * The request body to be sent to HAPI Backend Service to create a payment intent. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    paymentIntentRequestBody: WalletPaymentIntentRequest | null
+    paymentIntentClientSecret: string | null
+    /**
+     * Shows a loading spinner while PaymentIntent is creating
+     */
+    topUpIsLoading: boolean
+    /**
+     * A custom amount to specify for the top up of balance
+     */
+    topUpAmount: number
+    /**
+     * A minimum amount enforced by an ATS for the top up of balance
+     */
+    topUpMinAmount: number
+    /**
+     * A minimum amount's currency enforced by an ATS for the top up of balance
+     */
+    topUpMinAmountCurrency: ProductPriceCurrency
+    /**
+     * Indicates if user has agreed to terms of service
+     */
+    topUpTermsOfServiceIsAgreed: boolean
+    /**
+     * Step of the popup. **Should not be edited from outside**
+     */
+    topUpCurrentStepIndex: number
+    /**
+     * An array of payment method types that Stripe accepts https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_types to specify which types of payment methods the end user can use
+     */
+    topUpPaymentMethodTypes: WalletPaymentIntentPaymentMethod[]
+}

package/src/wallet/types.ts

@@ -0,0 +1,65 @@
+import { ProductPriceCurrency } from "../product/enums"
+
+export type WalletBalanceInCents = {
+    USD: number
+}
+
+export type Wallet = {
+    balance: WalletBalanceInCents
+    created_date: string
+    has_billing_details: boolean
+    id: string
+}
+
+export type WalletATSSettings = {
+    topUpAmount: number
+    topUpMinAmount: number
+    topUpPaymentMethodTypes: WalletPaymentIntentPaymentMethod[]
+    topUpMinAmountCurrency: ProductPriceCurrency
+}
+
+export type WalletCreateForm = {
+    customerName: string
+}
+
+export type WalletBillingPortalLinkResponse = {
+    billingPortalLink: string
+}
+
+export type WalletPaymentIntentPaymentMethod =
+    | "card"
+    | "acss_debit"
+    | "affirm"
+    | "afterpay_clearpay"
+    | "alipay"
+    | "au_becs_debit"
+    | "bacs_debit"
+    | "bancontact"
+    | "blik"
+    | "boleto"
+    | "card_present"
+    | "eps"
+    | "fpx"
+    | "giropay"
+    | "grabpay"
+    | "ideal"
+    | "klarna"
+    | "konbini"
+    | "link"
+    | "oxxo"
+    | "p24"
+    | "paynow"
+    | "pix"
+    | "promptpay"
+    | "sepa_debit"
+    | "sofort"
+    | "us_bank_account"
+    | "wechat_pay"
+
+export type WalletPaymentIntentRequest = {
+    walletId: string
+    partnerId: string
+    amount: number
+    agreeTerms: boolean
+    paymentMethodTypes?: WalletPaymentIntentPaymentMethod[]
+}

package/src/wallet/validations.types.ts

@@ -0,0 +1,18 @@
+import { ZodBoolean, ZodNullable, ZodNumber, ZodObject, ZodString } from "zod"
+
+export type ZodWalletBalance = ZodObject<{
+    USD: ZodNumber
+}>
+export type ZodWallet = ZodObject<{
+    balance: ZodWalletBalance
+    created_date: ZodString
+    has_billing_details: ZodBoolean
+    id: ZodString
+}>
+export type ZodWalletCreateForm = ZodObject<{
+    customerName: ZodString
+}>
+export type WindowHapiValidationsWallet = {
+    wallet: ZodNullable<ZodWallet>
+    walletForm: ZodWalletCreateForm
+}

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "isolatedModules": false,
+    "jsx": "preserve",
+    "incremental": false,
+    "experimentalDecorators": true,
+    "baseUrl": "./",
+    "outFile": "index.d.ts",
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "./src/**/*",
+  ],
+  "exclude": [
+    "node_modules",
+    "../ats/**/*",
+    "../common/**/*",
+    "../src/**/*",
+    "./index.d.ts",
+    "./index.d.ts.map"
+  ]
+}