@vonq/hapi-elements-types 1.4.0 → 1.6.0

package/src/_window/state.types.ts

@@ -0,0 +1,114 @@
+import { AlertState } from "../alert/state.types"
+import { BasketState } from "../basket/state.types"
+import { CampaignState } from "../campaign/state.types"
+import { ContractState } from "../contract/state.types"
+import { DebuggingState } from "../debugging/state.types"
+import { LanguageState } from "../language/state.types"
+import { ProductState } from "../product/state.types"
+import { ThemingState } from "../theming/state.types"
+import { OrderJourneyState } from "../orderJourney/state.types"
+import { WalletState } from "../wallet/state.types"
+import { ModalState } from "../modal/state.types"
+import { WindowHapiEventCommandCallbackHandler } from "../common/events/types"
+import { WindowHapiModuleName } from "../common/enums"
+import { ATSState } from "../ats/state.types"
+import {
+    WindowHapiModuleWithConstructorArgs,
+    WindowHapiClassInterface,
+} from "./window"
+import { WindowHapiValidationsCommon } from "../common/validations.types"
+import { WindowHapiValidationsBasket } from "../basket/validations.types"
+import { WindowHapiValidationsCampaign } from "../campaign/validations.types"
+import { WindowHapiValidationsContract } from "../contract/validations.types"
+import { WindowHapiValidationsLanguage } from "../language/validations.types"
+import { WindowHapiValidationsProduct } from "../product/validations.types"
+import { WindowHapiValidationsTheming } from "../theming/validations.types"
+import { WindowHapiValidationsOrderJourney } from "../orderJourney/validations.types"
+import { WindowHapiValidationsWallet } from "../wallet/validations.types"
+import { WindowHapiValidations } from "./validation.types"
+
+export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
+    {
+        [WindowHapiModuleName.alert]: WindowHapiStateModule<AlertState>
+        [WindowHapiModuleName.basket]: WindowHapiStateModule<BasketState>
+        [WindowHapiModuleName.campaign]: WindowHapiStateModule<CampaignState>
+        [WindowHapiModuleName.contract]: WindowHapiStateModule<ContractState>
+        [WindowHapiModuleName.debugging]: WindowHapiStateModule<DebuggingState>
+        [WindowHapiModuleName.language]: WindowHapiStateModule<LanguageState>
+        [WindowHapiModuleName.product]: WindowHapiStateModule<ProductState>
+        [WindowHapiModuleName.theming]: WindowHapiStateModule<ThemingState>
+        [WindowHapiModuleName.orderJourney]: WindowHapiStateModule<OrderJourneyState>
+        [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
+        [WindowHapiModuleName.modal]: WindowHapiStateModule<ModalState>
+        [WindowHapiModuleName.ats]: WindowHapiStateModule<ATSState>
+        getModuleByName: (
+            name: string,
+        ) => WindowHapiStateModule<any> | undefined
+        handleDefaultStateFromQueryParams: (params: string | string[]) => void
+        shouldPreventStateDispatch: boolean
+        stores: {
+            alert: WindowHapiStateModule<AlertState>
+            basket: WindowHapiStateModule<BasketState>
+            campaign: WindowHapiStateModule<CampaignState>
+            contract: WindowHapiStateModule<ContractState>
+            debugging: WindowHapiStateModule<DebuggingState>
+            language: WindowHapiStateModule<LanguageState>
+            product: WindowHapiStateModule<ProductState>
+            theming: WindowHapiStateModule<ThemingState>
+            orderJourney: WindowHapiStateModule<OrderJourneyState>
+            wallet: WindowHapiStateModule<WalletState>
+            modal: WindowHapiStateModule<ModalState>
+            ats: WindowHapiStateModule<ATSState>
+        }
+        toJSON: Record<string, any>
+    },
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiStatesJSON = {
+    [WindowHapiModuleName.alert]: AlertState
+    [WindowHapiModuleName.basket]: BasketState
+    [WindowHapiModuleName.campaign]: CampaignState
+    [WindowHapiModuleName.contract]: ContractState
+    [WindowHapiModuleName.debugging]: DebuggingState
+    [WindowHapiModuleName.language]: LanguageState
+    [WindowHapiModuleName.product]: ProductState
+    [WindowHapiModuleName.theming]: ThemingState
+    [WindowHapiModuleName.orderJourney]: OrderJourneyState
+    [WindowHapiModuleName.wallet]: WalletState
+    [WindowHapiModuleName.modal]: ModalState
+    [WindowHapiModuleName.ats]: ATSState
+}
+
+export type WindowHapiStateBase = {
+    __stateName: string
+    toJSON: any
+}
+
+export type HapiStateValueWithListener<T> = {
+    on: (callback: WindowHapiEventCommandCallbackHandler) => void
+    value: T
+}
+
+export type WindowHapiStateModule<T> = WindowHapiStateBase & {
+    [P in keyof T]:
+        | T[P]
+        | HapiStateValueWithListener<T[P]>
+        | ((v: T[P]) => void)
+}
+
+export type StateValidationKey =
+    | keyof WindowHapiValidations
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsCommon}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsBasket}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsCampaign}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsContract}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsLanguage}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsProduct}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsTheming}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsOrderJourney}`
+    | `${keyof WindowHapiValidations}.${keyof WindowHapiValidationsWallet}`
+
+export type StateValidations<State> = {
+    [P in keyof State]: StateValidationKey | undefined
+}

package/src/_window/ui.types.ts

@@ -0,0 +1,15 @@
+import {
+    WindowHapiModuleWithConstructorArgs,
+    WindowHapiClassInterface,
+} from "./window"
+
+export type WindowHapiUI = WindowHapiModuleWithConstructorArgs<
+    {
+        addUIElementToBody: (
+            elementName: "he-ui-modals" | "he-ui-alertbar",
+        ) => void
+        toggleModal: () => void
+        toggleAlertbar: () => void
+    },
+    { readonly core: WindowHapiClassInterface }
+>

package/src/_window/utils.types.ts

@@ -0,0 +1,36 @@
+import { WindowHapiModuleName } from "../common/enums"
+import { WindowHapiUtilsProduct } from "../product/utils.types"
+import { WindowHapiUtilsContract } from "../contract/utils.types"
+import { WindowHapiUtilsCampaign } from "../campaign/utils.types"
+import { WindowHapiUtilsBasket } from "../basket/utils.types"
+import { WindowHapiUtilsOrderJourney } from "../orderJourney/utils.types"
+import {
+    WindowHapiModuleWithConstructorArgs,
+    WindowHapiClassInterface,
+} from "./window"
+
+export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
+    {
+        isObject: (item: any) => boolean
+        mergeDeepOverwriteArrays: (
+            original: Record<string, any>,
+            overwrites: Record<string, any>,
+        ) => Record<string, any>
+        getComponentNameIndexSuffix: (instanceName: string) => string
+        getIframeLoadingSpinner: () => HTMLDivElement
+        product: WindowHapiUtilsProduct
+        contract: WindowHapiUtilsContract
+        campaign: WindowHapiUtilsCampaign
+        basket: WindowHapiUtilsBasket
+        orderJourney: WindowHapiUtilsOrderJourney
+
+        utilities: {
+            [WindowHapiModuleName.basket]: WindowHapiUtilsBasket
+            [WindowHapiModuleName.campaign]: WindowHapiUtilsCampaign
+            [WindowHapiModuleName.contract]: WindowHapiUtilsContract
+            [WindowHapiModuleName.product]: WindowHapiUtilsProduct
+            [WindowHapiModuleName.orderJourney]: WindowHapiUtilsOrderJourney
+        }
+    },
+    { readonly core: WindowHapiClassInterface }
+>

package/src/_window/validation.types.ts

@@ -0,0 +1,45 @@
+import { z } from "zod"
+import { WindowHapiModuleName } from "../common/enums"
+import {
+    WindowHapiModuleWithConstructorArgs,
+    WindowHapiClassInterface,
+} from "./window"
+import { WindowHapiValidationsCommon } from "../common/validations.types"
+import { WindowHapiValidationsProduct } from "../product/validations.types"
+import { WindowHapiValidationsContract } from "../contract/validations.types"
+import { WindowHapiValidationsCampaign } from "../campaign/validations.types"
+import { WindowHapiValidationsBasket } from "../basket/validations.types"
+import { WindowHapiValidationsWallet } from "../wallet/validations.types"
+import { WindowHapiValidationsTheming } from "../theming/validations.types"
+import { WindowHapiValidationsLanguage } from "../language/validations.types"
+import { WindowHapiValidationsOrderJourney } from "../orderJourney/validations.types"
+
+export type WindowHapiValidations = WindowHapiModuleWithConstructorArgs<
+    {
+        validator: typeof z
+        messages: Record<string, string | Function>
+        [WindowHapiModuleName.common]: WindowHapiValidationsCommon
+        [WindowHapiModuleName.product]: WindowHapiValidationsProduct
+        [WindowHapiModuleName.contract]: WindowHapiValidationsContract
+        [WindowHapiModuleName.campaign]: WindowHapiValidationsCampaign
+        [WindowHapiModuleName.basket]: WindowHapiValidationsBasket
+        [WindowHapiModuleName.wallet]: WindowHapiValidationsWallet
+        [WindowHapiModuleName.theming]: WindowHapiValidationsTheming
+        [WindowHapiModuleName.language]: WindowHapiValidationsLanguage
+        [WindowHapiModuleName.orderJourney]: WindowHapiValidationsOrderJourney
+        throwError: (error: string | undefined) => void
+        throwHasNoSetterError: (propertyName: string) => void
+        checkAndThrowArgumentUndefinedOrInvalidTypeError: (
+            parameter: any,
+            parameterName: string,
+            typeString: string,
+            invalidator?: Function,
+        ) => void
+        runSDKEventsValidations: (callback: Function) => void
+    },
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type ValidationSubmoduleConstructorArgs = {
+    readonly validation: WindowHapiValidations
+}

package/src/_window/window.ts

@@ -0,0 +1,140 @@
+import { WindowHapiUtils } from "./utils.types"
+import { WindowHapiValidations } from "./validation.types"
+import { WindowHapiState } from "./state.types"
+import { WindowHapiInstance, WindowHapiInstances } from "./instances.types"
+import { WindowHapiRouting } from "./routing.types"
+import { WindowHapiAuth } from "./auth.types"
+import { WindowHapiEvents } from "./events.types"
+import { WindowHapiUI } from "./ui.types"
+import { WindowHapiAPI } from "./api.types"
+import { WindowHapiSDK } from "./sdk.types"
+import { WindowHapiService } from "./service.types"
+import { WindowHapiQA } from "./qa.types"
+import { WindowHapiLogger } from "../common/logger/types"
+import {
+    HapiWebComponent,
+    RecursivePartial,
+    WindowHapiSubmoduleName,
+} from "../common"
+import { DebugPanelPosition } from "./config.types"
+
+export type WindowHapiModuleWithConstructorArgs<Module, ConstructorArgs> =
+    Module & ConstructorArgs
+
+export type WindowHapiUtilsSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiUtils,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiValidationSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiValidations,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiStateSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiState,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiInstancesSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiInstances,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiRoutingSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiRouting,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiAuthSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAuth,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiEventsSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiEvents,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiUISubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiUI,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiAPISubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPI,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiSDKSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiSDK,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiServiceSubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiService,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiQASubmodule = WindowHapiModuleWithConstructorArgs<
+    WindowHapiQA,
+    { readonly core: WindowHapiClassInterface }
+>
+
+export type WindowHapiConfigSubmodule = {
+    apiHost: string
+    initialState: RecursivePartial<any>
+    partnerId: string
+    clientId: string
+    clientToken: string
+    loadingSpinnerDefaultFillColor: string
+    appOrigin: string
+    enableLogs: boolean
+    webComponents: HapiWebComponent[]
+    isInvalidToken: boolean
+    useJWTAuthHeaders: boolean
+    addModal: boolean
+    addAlertBar: boolean
+    addDebugPanel: boolean
+    debugPanelPosition: DebugPanelPosition
+    datadogClientToken: string
+    env: string
+    appVersion: string
+    testMode: boolean
+    debugMode: boolean
+    htmlTemplates: Record<string, string>
+}
+
+export type WindowHapiClassInterface = {
+    logger: WindowHapiLogger
+    utils: WindowHapiUtilsSubmodule
+    validation: WindowHapiValidationSubmodule
+    state: WindowHapiStateSubmodule
+    instances: WindowHapiInstancesSubmodule
+    routing: WindowHapiRoutingSubmodule
+    auth: WindowHapiAuthSubmodule
+    events: WindowHapiEventsSubmodule
+    ui: WindowHapiUISubmodule
+    api: WindowHapiAPISubmodule
+    sdk: WindowHapiSDKSubmodule
+    service: WindowHapiServiceSubmodule
+    instance: WindowHapiInstance
+    qa: WindowHapiQASubmodule
+}
+
+export type WindowHapi = {
+    [WindowHapiSubmoduleName.api]: WindowHapiAPISubmodule
+    [WindowHapiSubmoduleName.auth]: WindowHapiAuthSubmodule
+    [WindowHapiSubmoduleName.config]: WindowHapiConfigSubmodule
+    [WindowHapiSubmoduleName.instances]: WindowHapiInstancesSubmodule
+    [WindowHapiSubmoduleName.qa]: WindowHapiQASubmodule
+    [WindowHapiSubmoduleName.routing]: WindowHapiRoutingSubmodule
+    [WindowHapiSubmoduleName.sdk]: WindowHapiSDKSubmodule
+    [WindowHapiSubmoduleName.service]: WindowHapiServiceSubmodule
+    [WindowHapiSubmoduleName.state]: WindowHapiStateSubmodule
+    [WindowHapiSubmoduleName.ui]: WindowHapiUISubmodule
+    [WindowHapiSubmoduleName.utils]: WindowHapiUtilsSubmodule
+    [WindowHapiSubmoduleName.validation]: WindowHapiValidationSubmodule
+    [WindowHapiSubmoduleName.events]: WindowHapiEventsSubmodule
+    [WindowHapiSubmoduleName.instance]: WindowHapiInstance
+}

package/src/alert/enums.ts

@@ -0,0 +1,22 @@
+export enum AlertKey {
+    backendErrorMessage = "backend-error-message",
+    topupSuccess = "topup-success",
+    contractRemoveSuccess = "contract-removed",
+    contractCreateSuccess = "contract-created",
+    contractGroupCreateSuccess = "contract-group-created",
+    campaignTakeOfflineSuccess = "campaign-take-offline-success",
+    campaignOrderSuccess = "campaign-order-success",
+    campaignCopySuccess = "campaign-copy-success",
+    buttonCopySuccess = "copy-button-success",
+    productAddToBasket = "add-product-to-basket-success",
+    productRemoveFromBasket = "remove-product-from-basket-warning",
+    utmCodeConfirmation = "utm-code-confirmation",
+}
+
+export enum AlertType {
+    "success" = "success",
+    "info" = "info",
+    "warning" = "warning",
+    "error" = "error",
+    "custom" = "custom",
+}

package/src/alert/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./enums"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"

package/src/alert/service.types.ts

@@ -0,0 +1,15 @@
+import { AlertKey } from "./enums"
+import { AlertOptions } from "./types"
+import { WindowHapiService } from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiServiceAlert = WindowHapiModuleWithConstructorArgs<
+    {
+        show: (
+            key: AlertKey,
+            props: any | undefined,
+            options: AlertOptions,
+        ) => void
+    },
+    { readonly service: WindowHapiService }
+>

package/src/alert/state.types.ts

@@ -0,0 +1,9 @@
+import { Alert, AlertOptions } from "./types"
+export type AlertState = {
+    alerts: Alert[]
+    defaultOptions: AlertOptions
+    successOptions: AlertOptions | null
+    infoOptions: AlertOptions | null
+    warningOptions: AlertOptions | null
+    errorOptions: AlertOptions | null
+}

package/src/alert/types.ts

@@ -0,0 +1,63 @@
+import { ToastOptions } from "react-toastify/dist/types"
+import { AlertKey } from "./enums"
+import { AnyNonFunction } from "../common/types"
+
+export type AlertOptions = ToastOptions & {
+    shouldShowDismiss?: boolean
+}
+
+export type ContractCreateSuccessAlertProps = {
+    contractName: string
+}
+
+export type ContractRemoveSuccessAlertProps = {
+    contractName: string
+}
+
+export type ContractGroupCreateSuccessAlertProps = {
+    groupName: string
+}
+
+export type BackendErrorMessageAlertProps = {
+    errorMessage: string
+}
+
+export type WalletTopUpSuccessAlertProps = {
+    amountInDollars: number
+}
+
+export type UTMCodesSuccessAlertProps = {
+    type: "save" | "reset"
+}
+
+export type ButtonCopySuccessAlertProps = {}
+
+export type CampaignOrderSuccessAlertProps = {}
+
+export type CampaignCopySuccessAlertProps = {}
+
+export type CampaignTakeOfflineSuccessAlertProps = {}
+
+export type ProductAddToBasketSuccessAlertProps = {}
+
+export type ProductRemoveFromBasketWarningAlertProps = {}
+
+export type AlertProps = AnyNonFunction<
+    | ContractCreateSuccessAlertProps
+    | ContractRemoveSuccessAlertProps
+    | ContractGroupCreateSuccessAlertProps
+    | BackendErrorMessageAlertProps
+    | WalletTopUpSuccessAlertProps
+    | ButtonCopySuccessAlertProps
+    | CampaignOrderSuccessAlertProps
+    | CampaignCopySuccessAlertProps
+    | CampaignTakeOfflineSuccessAlertProps
+    | ProductAddToBasketSuccessAlertProps
+    | ProductRemoveFromBasketWarningAlertProps
+>
+
+export type Alert = {
+    key: AlertKey
+    props: AlertProps | undefined
+    options: AlertOptions
+}

package/src/ats/api.types.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig } from "axios/index"
+import { ATSSettings } from "./types"
+import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiAPIATSConfigs = {
+    getUserSettings: AxiosRequestConfig<any>
+}
+
+export type WindowHapiAPIATSRequests = {
+    getUserSettings: () => Promise<ATSSettings>
+}
+export type WindowHapiAPIATS = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPIModule<WindowHapiAPIATSRequests, WindowHapiAPIATSConfigs>,
+    { readonly api: WindowHapiAPI }
+>

package/src/ats/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./api.types"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"

package/src/ats/service.types.ts

@@ -0,0 +1,17 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { ATSSettings } from "./types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type ATSServiceGetUserSettingsHandler = () => Promise<
+    ATSSettings | undefined
+>
+
+export type WindowHapiServiceATS = WindowHapiModuleWithConstructorArgs<
+    {
+        getUserSettings: HapiServiceFunctionWithLifecycleHooks<ATSServiceGetUserSettingsHandler>
+    },
+    { readonly service: WindowHapiService }
+>

package/src/ats/state.types.ts

@@ -0,0 +1,5 @@
+import { ATSSettings } from "./types"
+
+export type ATSState = {
+    userSettings: ATSSettings | null
+}

package/src/ats/types.ts

@@ -0,0 +1,19 @@
+import { WalletPaymentIntentPaymentMethod } from "../wallet/types"
+
+export type ATSUserPaymentSetting = {
+    currency: string
+    max_outstanding_balance: string
+    max_purchase_order: string
+    min_topup: string
+    payment_method_types: WalletPaymentIntentPaymentMethod[] | null
+}
+export type ATSUserSettings = {
+    ats_managed_payment: boolean
+    can_pay_with_purchase_order: boolean
+    can_use_wallets: boolean
+    invoice_currency: string
+}
+export type ATSSettings = {
+    payment_settings: ATSUserPaymentSetting[]
+    settings: ATSUserSettings
+}

package/src/basket/index.ts

@@ -0,0 +1,7 @@
+// created from 'create-ts-index'
+
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"
+export * from "./utils.types"
+export * from "./validations.types"

package/src/basket/service.types.ts

@@ -0,0 +1,32 @@
+import { Contract } from "../contract/types"
+import { Product } from "../product/types"
+import { BasketProduct } from "./types"
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type BasketServiceGetProductsHandler = () => Promise<
+    (Product | Contract)[]
+>
+export type BasketServiceAddProductOrContractByIdHandler = (
+    contractOrProductId: string,
+    isProduct: boolean,
+) => void
+export type BasketServiceRemoveProductOrContractByIdHandler = (
+    contractOrProductId: string,
+) => void
+
+export type WindowHapiServiceBasket = WindowHapiModuleWithConstructorArgs<
+    {
+        setBasketProductsAndMetaByItemData: (
+            basketItemData: (Contract | Product)[],
+        ) => BasketProduct[]
+        getProducts: HapiServiceFunctionWithLifecycleHooks<BasketServiceGetProductsHandler>
+        addProductOrContractById: HapiServiceFunctionWithLifecycleHooks<BasketServiceAddProductOrContractByIdHandler>
+        removeProductOrContractById: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveProductOrContractByIdHandler>
+        clear: () => BasketProduct[]
+    },
+    { readonly service: WindowHapiService }
+>

package/src/basket/state.types.ts

@@ -0,0 +1,34 @@
+import { Product } from "../product/types"
+import { BasketProduct } from "./types"
+import { Contract } from "../contract/types"
+
+export type BasketState = {
+    /**
+     * Array of `BasketProduct`s. The price or other properties of a Product or Contract may change therefore this variable only contains ID of Product or Contract and whether it is a Product or not; via the `isProduct: boolean` variable. Elements of this array then are fetched from the API with their latest information and then set as `products`.
+     */
+    productsMeta: BasketProduct[]
+    /**
+     * Array of Products and/or Contracts. This variable is auto-populated with the response received from the API for the Products and Contracts inside `productsMeta`
+     */
+    products: (Product | Contract)[]
+    /**
+     * Sum of prices of Products and/or Contracts in EUR currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInEUR: number
+    /**
+     * Sum of prices of Products and/or Contracts in USD currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInUSD: number
+    /**
+     * Sum of prices of Products and/or Contracts in GBP currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInGBP: number
+    /**
+     * Sum of prices of Products and/or Contracts in the current display currency that is used throughout the widgets. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInDisplayCurrency: number
+    /**
+     * Shows a spinner in Basket when the data for Products and/or Contracts is being fetched from the API
+     */
+    productsAreLoading: boolean
+}

package/src/basket/types.ts

@@ -0,0 +1,4 @@
+export type BasketProduct = {
+    id: number | string // Product ID or Contract ID
+    isProduct: boolean
+}

package/src/basket/utils.types.ts

@@ -0,0 +1,10 @@
+import { BasketProduct } from "./types"
+import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiUtilsBasket = WindowHapiModuleWithConstructorArgs<
+    {
+        getInitialBasketProductsMeta: () => BasketProduct[]
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/src/basket/validations.types.ts

@@ -0,0 +1,25 @@
+import {
+    ZodArray,
+    ZodBoolean,
+    ZodNumber,
+    ZodObject,
+    ZodString,
+    ZodUnion,
+} from "zod"
+import { ZodProduct } from "../product/validations.types"
+import { ZodContract } from "../contract/validations.types"
+
+export type ZodContractsOrProducts = ZodArray<
+    ZodUnion<[ZodProduct, ZodContract]>
+>
+export type ZodBasketProductMeta = ZodObject<{
+    id: ZodUnion<[ZodString, ZodNumber]>
+    isProduct: ZodBoolean
+}>
+export type ZodBasketProductsMeta = ZodArray<ZodBasketProductMeta>
+
+export type WindowHapiValidationsBasket = {
+    contractsOrProducts: ZodContractsOrProducts
+    productMeta: ZodBasketProductMeta
+    productsMeta: ZodBasketProductsMeta
+}