@vonq/hapi-elements-types 1.8.0 → 1.9.0

package/_window/api.types.ts

@@ -15,6 +15,7 @@ import {
     WindowHapiClassInterface,
 } from "./window"
 import { WindowHapiLogger } from "../common/logger/types"
+import { ATSUserTokenResponse } from "../ats"
 
 export type WindowHapiAPIModule<ModuleType, ModuleConfig> = {
     logger: WindowHapiLogger
@@ -29,12 +30,34 @@ export type WindowHapiAPIModule<ModuleType, ModuleConfig> = {
 export type HapiRequestConfig<T> = Omit<AxiosRequestConfig<T>, "headers"> & {
     headers?: any
 }
+
+export type WindowHapiAPIOnChangeJWTTokenHandler = (
+    newToken: string,
+    oldToken?: string,
+) => string
+
+export type WindowHapiAPIRefreshJWTTokenHandler = () => Promise<
+    ATSUserTokenResponse | undefined
+>
+
+export type WindowHapiAPIValidateJWTTokenHandler = () => Promise<boolean>
+
 export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
     {
         /* Common */
         request: <T = any, R = AxiosResponse<T>, D = any>(
             config: Partial<HapiRequestConfig<D>>,
         ) => Promise<R>
+        jwtHeaderKey: string
+        jwtRefreshIntervalInSeconds: number
+        setJWTRefreshIntervalInSeconds: (seconds: number) => void
+        jwtRefreshInterval: number | undefined
+        jwtTokenRefreshCallback:
+            | WindowHapiAPIOnChangeJWTTokenHandler
+            | undefined
+        onJWTTokenRefresh: (token: string) => void
+        refreshJWTToken: WindowHapiAPIRefreshJWTTokenHandler
+        validateJWTToken: WindowHapiAPIValidateJWTTokenHandler
         baseURL: string
         setBaseURL: (url: string) => void
         setBaseConfig: (params: Record<string, Record<string, string>>) => void

package/_window/events.types.ts

@@ -30,6 +30,9 @@ export type WindowHapiEventFactory = WindowHapiModuleWithConstructorArgs<
             value: WindowHapiEventCommandData,
             instances: WindowHapiEventMediatorInstances,
             id?: string,
+            status?: WindowHapiEventCommandStatus,
+            createdAt?: string,
+            updatedAt?: string,
         ) => WindowHapiEventCommand
         create: (
             name: WindowHapiEventCommandNames,
@@ -37,6 +40,8 @@ export type WindowHapiEventFactory = WindowHapiModuleWithConstructorArgs<
             getInstances: WindowHapiEventMediatorGetInstancesHandler,
             id?: string,
             status?: WindowHapiEventCommandStatus,
+            createdAt?: string,
+            updatedAt?: string,
         ) => WindowHapiEventCommand
     },
     { readonly getInstances: WindowHapiEventMediatorGetInstancesHandler }
@@ -47,6 +52,7 @@ export type WindowHapiEventMediatorCreateAndDispatchHandler = (
     data?: WindowHapiEventCommandData,
     id?: string,
     status?: WindowHapiEventCommandStatus,
+    getInstances?: WindowHapiEventMediatorGetInstancesHandler,
 ) => Promise<WindowHapiEventCommand | undefined>
 
 export type WindowHapiEventMediator = WindowHapiModuleWithConstructorArgs<
@@ -117,7 +123,9 @@ export type WindowHapiEventStorage = WindowHapiModuleWithConstructorArgs<
         ) => void
         remove: (id: string) => void
         removeByName: (name: string) => void
-        getEventsByName: (name: string) => WindowHapiEventCommand[]
+        getEventsByName: (
+            name: string,
+        ) => (WindowHapiEventCommand | WindowHapiEventListener)[]
     },
     { readonly getInstances: WindowHapiEventMediatorGetInstancesHandler }
 >
@@ -127,15 +135,6 @@ export type WindowHapiEvents = WindowHapiModuleWithConstructorArgs<
         hasAddedWindowMessageEvent: boolean
         addInternalEventListeners: () => void
         removeInternalEventListeners: () => void
-        createSDKEventListener: (
-            property: string,
-            callback: (data: any) => void,
-        ) => void
-        sdkEventListenerCallback: (
-            data: WindowHapiEventCommandData,
-            _property: string,
-            callback: (data: WindowHapiEventCommandData) => void,
-        ) => void
         eventFactory: WindowHapiEventFactory
         eventMediator: WindowHapiEventMediator
         eventStorage: WindowHapiEventStorage
@@ -145,6 +144,7 @@ export type WindowHapiEvents = WindowHapiModuleWithConstructorArgs<
         eventStateStrategy: WindowHapiEventStrategy
         eventServiceStrategy: WindowHapiEventStrategy
         eventQAStrategy: WindowHapiEventStrategy
+        eventDOMStrategy: WindowHapiEventStrategy
         getInstances: () => {
             source: WindowHapiInstance
             targets: WindowHapiInstance[]

package/_window/sdk.types.ts

@@ -41,6 +41,7 @@ import {
 } from "./window"
 import { WindowHapiServiceUI } from "../ui/service.types"
 import { ATSState, WindowHapiAPIATS, WindowHapiServiceATS } from "../ats"
+import { WindowHapiServiceOrderJourney } from "../orderJourney/service.types"
 
 export type WindowHapiSDKModule<
     APIModule,
@@ -97,7 +98,7 @@ export type WindowHapiSDKLanguage = WindowHapiSDKModule<
 >
 export type WindowHapiSDKOrderJourney = WindowHapiSDKModule<
     undefined,
-    undefined,
+    WindowHapiServiceOrderJourney,
     WindowHapiValidationsOrderJourney,
     WindowHapiStateModule<OrderJourneyState>,
     WindowHapiUtilsOrderJourney
@@ -147,6 +148,7 @@ export type WindowHapiSDK = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.language]: WindowHapiSDKLanguage
         [WindowHapiModuleName.debugging]: WindowHapiSDKDebugging
         [WindowHapiModuleName.alert]: WindowHapiSDKAlert
+        [WindowHapiModuleName.ui]: WindowHapiSDKUI
     },
     { readonly core: WindowHapiClassInterface }
 >

package/_window/service.types.ts

@@ -13,6 +13,7 @@ import {
     WindowHapiModuleWithConstructorArgs,
 } from "./window"
 import { WindowHapiLogger } from "../common/logger/types"
+import { WindowHapiServiceOrderJourney } from "../orderJourney/service.types"
 
 export type HapiServiceFunctionLifecycleHookCallbackHandler = () =>
     | void
@@ -45,6 +46,7 @@ export type WindowHapiService = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.product]: WindowHapiServiceProduct
         [WindowHapiModuleName.wallet]: WindowHapiServiceWallet
         [WindowHapiModuleName.modal]: WindowHapiServiceModal
+        [WindowHapiModuleName.orderJourney]: WindowHapiServiceOrderJourney
         [WindowHapiModuleName.ui]: WindowHapiServiceUI
         [WindowHapiModuleName.ats]: WindowHapiServiceATS
         services: {
@@ -55,6 +57,7 @@ export type WindowHapiService = WindowHapiModuleWithConstructorArgs<
             [WindowHapiModuleName.product]: WindowHapiServiceProduct
             [WindowHapiModuleName.wallet]: WindowHapiServiceWallet
             [WindowHapiModuleName.modal]: WindowHapiServiceModal
+            [WindowHapiModuleName.orderJourney]: WindowHapiServiceOrderJourney
             [WindowHapiModuleName.ui]: WindowHapiServiceUI
             [WindowHapiModuleName.ats]: WindowHapiServiceATS
         }

package/_window/state.types.ts

@@ -41,11 +41,9 @@ export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
         [WindowHapiModuleName.modal]: WindowHapiStateModule<ModalState>
         [WindowHapiModuleName.ats]: WindowHapiStateModule<ATSState>
-        getModuleByName: (
-            name: string,
-        ) => WindowHapiStateModule<any> | undefined
+        basePropertiesThatShouldNotBeDocumented: string[]
         handleDefaultStateFromQueryParams: (params: string | string[]) => void
-        shouldPreventStateDispatch: boolean
+        onAfterStateChange: () => void
         stores: {
             alert: WindowHapiStateModule<AlertState>
             basket: WindowHapiStateModule<BasketState>
@@ -82,12 +80,13 @@ export type WindowHapiStatesJSON = {
 
 export type WindowHapiStateBase = {
     propertiesThatShouldNotBeDocumented: string[]
-    __stateName: string
+    __elementsStateModuleName: string
     toJSON: any
+    addClassPropertiesObserver: () => void
 }
 
 export type HapiStateValueWithListener<T> = {
-    on: (callback: WindowHapiEventCommandCallbackHandler) => void
+    onChange: (callback: WindowHapiEventCommandCallbackHandler) => void
     value: T
 }
 
@@ -113,3 +112,9 @@ export type StateValidationKey =
 export type StateValidations<State> = {
     [P in keyof State]: StateValidationKey | undefined
 }
+
+export type WindowHapiStateModuleState<T> = {
+    [K in keyof T]: T[K]
+} & {
+    state?: WindowHapiState
+}

package/_window/window.ts

@@ -92,6 +92,7 @@ export type WindowHapiConfigSubmodule = {
     enableLogs: boolean
     webComponents: HapiWebComponent[]
     isInvalidToken: boolean
+    isAllowedToUseDevelopmentEnvironment: boolean
     useJWTAuthHeaders: boolean
     addModal: boolean
     addAlertBar: boolean
@@ -120,6 +121,7 @@ export type WindowHapiClassInterface = {
     service: WindowHapiServiceSubmodule
     instance: WindowHapiInstance
     qa: WindowHapiQASubmodule
+    isProduction: boolean
 }
 
 export type WindowHapi = {

package/ats/api.types.ts

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

package/ats/state.types.ts

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

package/ats/types.ts

@@ -5,6 +5,10 @@ export type ATSUserPaymentSetting = {
     max_outstanding_balance: string
     max_purchase_order: string
     min_topup: string
+    gateway: {
+        provider: "stripe"
+        publishable_key: string
+    }
     payment_method_types: WalletPaymentIntentPaymentMethod[] | null
 }
 export type ATSUserSettings = {
@@ -17,3 +21,7 @@ export type ATSSettings = {
     payment_settings: ATSUserPaymentSetting[]
     settings: ATSUserSettings
 }
+
+export type ATSUserTokenResponse = {
+    token: string
+}

package/basket/service.types.ts

@@ -17,15 +17,21 @@ export type BasketServiceAddProductOrContractByIdHandler = (
 export type BasketServiceRemoveProductOrContractByIdHandler = (
     contractOrProductId: string,
 ) => void
+export type BasketServiceRemoveContractsWithConflictingGroupsHandler = (
+    contractThatUserTriedToAdd: Contract,
+) => void
+export type BasketServiceKeepContractsWithConflictingGroupsHandler = () => void
 
 export type WindowHapiServiceBasket = WindowHapiModuleWithConstructorArgs<
     {
-        setBasketProductsAndMetaByItemData: (
+        onAfterGetBasketData: (
             basketItemData: (Contract | Product)[],
         ) => BasketProduct[]
         getProducts: HapiServiceFunctionWithLifecycleHooks<BasketServiceGetProductsHandler>
         addProductOrContractById: HapiServiceFunctionWithLifecycleHooks<BasketServiceAddProductOrContractByIdHandler>
         removeProductOrContractById: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveProductOrContractByIdHandler>
+        removeContractsWithConflictingGroups: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveContractsWithConflictingGroupsHandler>
+        keepContractsWithConflictingGroups: HapiServiceFunctionWithLifecycleHooks<BasketServiceKeepContractsWithConflictingGroupsHandler>
         clear: () => BasketProduct[]
     },
     { readonly service: WindowHapiService }

package/basket/state.types.ts

@@ -3,36 +3,12 @@ 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 AUD currency. **This value is a computed getter meaning that it cannot be set from outside**
-     */
     totalInAUD: 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/basket/utils.types.ts

@@ -1,10 +1,46 @@
 import { BasketProduct } from "./types"
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
+import {
+    Product,
+    ProductBoardType,
+    ProductPrice,
+    ProductPriceCurrency,
+} from "../product"
+import { Contract } from "../contract"
+import {
+    getBasketProductBoardType,
+    getConflictingContractsWithDifferentGroupsInBasket,
+} from "../../common/basket/utils"
 
 export type WindowHapiUtilsBasket = WindowHapiModuleWithConstructorArgs<
     {
         getInitialBasketProductsMeta: () => BasketProduct[]
+        getBasketProductId: (product: Product | Contract) => string
+        getBasketProductTitle: (product: Product | Contract) => string
+        getIsBasketProductContract: (product: Product | Contract) => boolean
+        getIsBasketProductProduct: (product: Product | Contract) => boolean
+        getBasketProductPrice: (
+            product: Product | Contract,
+            displayCurrency: ProductPriceCurrency,
+        ) => ProductPrice | undefined
+        getBasketProductBoardType: (
+            product: Product | Contract,
+        ) => ProductBoardType | undefined
+        getBasketProductTimeToProcess: (
+            product: Product | Contract,
+        ) => string | undefined
+        getBasketProductDuration: (
+            product: Product | Contract,
+        ) => string | undefined
+        getIsProductOrContractInBasket: (
+            contractOrProductId: string,
+            productsMeta: BasketProduct[],
+        ) => boolean
+        getConflictingContractsWithDifferentGroupsInBasket: (
+            contract: Contract,
+            basketProducts: (Contract | Product)[],
+        ) => (Product | Contract)[]
     },
     { readonly utils: WindowHapiUtils }
 >

package/campaign/state.types.ts

@@ -9,47 +9,17 @@ import { PaginationResponseV2 } from "../common/types"
 
 export type CampaignState = {
     /* Campaign */
-    /**
-     * Array of Campaign Objects for listing in Campaigns Landing and Campaigns List (both Card and Accordion Table Layout) widgets
-     */
     campaigns: Campaign[]
-    /**
-     * An object that holds information like next URL, previous URL and count for pagination purposes
-     */
     campaignsPaginationMeta: PaginationResponseV2
-    /**
-     * Used to show a loading spinner in Campaign widgets that show list of campaigns
-     */
     campaignsAreLoading: boolean
-    /**
-     * Object used to create (order) a campaign
-     */
     campaignForm: CampaignCreateForm
-    /**
-     * Shows a loading spinner and disables the buttons in Campaign Create Form while creating a Campaign
-     */
     campaignIsCreating: boolean
     /* Education Levels */
-    /**
-     * Array of Education Levels that end user will select via a Select HTML element
-     */
     educationLevels: TaxonomyEducationAndSeniorityLevel[]
-    /**
-     * Used to show a loading spinner and also disable the Select HTML element while values for Education Levels is loading
-     */
     educationLevelsAreLoading: boolean
     /* Seniorities */
-    /**
-     * Array of Seniorities that end user will select via a Select HTML element
-     */
     seniorities: TaxonomySeniority[]
-    /**
-     * Used to show a loading spinner and also disable the Select HTML element while values for Seniorities is loading
-     */
     senioritiesAreLoading: boolean
     /* Employment Types */
-    /**
-     * Array of Employment Types that end user will select via a Select HTML element
-     */
     employmentTypes: TaxonomyEmploymentTypes[]
 }

package/campaign/types.ts

@@ -2,6 +2,7 @@ import { ProductDuration, ProductIndustry } from "../product/types"
 import { ContractPostingRequirement } from "../contract/types"
 import { ProductPriceCurrency } from "../product/enums"
 import { EmploymentType, SalaryPeriod } from "./enums"
+import { OrderJourneyPaymentMethod } from "../orderJourney"
 
 export type CampaignProductSpecs = {
     contractId: string | null
@@ -121,6 +122,7 @@ export type Campaign = {
     orderedProducts: string[]
     orderedProductsSpecs: CampaignProductSpecs[]
     postingDetails: CampaignPostingDetails
+    paymentMethod: OrderJourneyPaymentMethod
     postings: CampaignPosting[]
     recruiterInfo: CampaignRecruiterInfo
     status: CampaignStatus
@@ -161,7 +163,8 @@ export type CampaignCreateFormOrderedProductSpec =
 export type CampaignCreateForm = {
     companyId: string
     campaignName?: string | null
-    poNumber?: string
+    poNumber: string | null
+    paymentMethod: OrderJourneyPaymentMethod | null
     targetGroup: CampaignCreateFormTargetGroup
     recruiterInfo: CampaignRecruiterInfo
     postingDetails: {
@@ -173,7 +176,7 @@ export type CampaignCreateForm = {
         employmentType: EmploymentType
         weeklyWorkingHours: CampaignPostingDetailsWeeklyWorkingHours
         salaryIndication: CampaignPostingDetailsSalaryIndication
-        contactInfo: CampaignPostingDetailsContactInfo
+        contactInfo: CampaignPostingDetailsContactInfo | null
         jobPageUrl: string
         applicationUrl: string
     }
@@ -182,9 +185,9 @@ export type CampaignCreateForm = {
 }
 
 export type CampaignOrderRequestBodyOrderedProductsSpec = {
-    contractId: string
+    contractId?: string
     utm: string
-    productId: string
+    productId?: string
     postingRequirements?: any
 }
 
@@ -192,8 +195,9 @@ export type CampaignOrderRequestBody = {
     companyId: string
     campaignName: string | null | undefined
     walletId?: string
-    poNumber?: string
+    poNumber?: string | null
     recruiterInfo: Omit<CampaignRecruiterInfo, "id">
+    paymentMethod: OrderJourneyPaymentMethod | null
     postingDetails: CampaignPostingDetails
     targetGroup: CampaignTargetGroup
     orderedProducts: string[]

package/campaign/validations.types.ts

@@ -1,6 +1,8 @@
 import {
     ZodAny,
     ZodArray,
+    ZodBoolean,
+    ZodNativeEnum,
     ZodNullable,
     ZodNumber,
     ZodObject,
@@ -10,6 +12,7 @@ import {
     ZodUnion,
 } from "zod"
 import { ZodProductDuration } from "../product/validations.types"
+import { OrderJourneyPaymentMethod } from "../orderJourney"
 
 export type ZodCampaignTotalPrice = ZodObject<{
     amount: ZodNumber
@@ -26,7 +29,7 @@ export type ZodCampaignRecruiterInfo = ZodObject<{
 }>
 export type ZodCampaignTargetGroupData = ZodObject<{
     description: ZodString
-    vonqId: ZodString
+    vonqId: ZodUnion<[ZodNumber, ZodString]>
 }>
 export type ZodCampaignTargetGroupDatas = ZodArray<ZodCampaignTargetGroupData>
 export type ZodCampaignTargetGroup = ZodObject<{
@@ -68,7 +71,9 @@ export type ZodCampaignPostingDetailsWorkingLocationPostCodeDefinition = {
 export type ZodCampaignPostingDetailsWorkingLocationAddressDetailsDefinition = {
     addressLine1: ZodString
     addressLine2: ZodOptional<ZodNullable<ZodString>>
-    allowsRemoteWork: ZodOptional<ZodNullable<ZodNumber>>
+    allowsRemoteWork: ZodOptional<
+        ZodNullable<ZodUnion<[ZodNumber, ZodBoolean]>>
+    >
     city: ZodString
     country: ZodString
     postcode: ZodString
@@ -131,7 +136,7 @@ export type ZodCampaign = ZodObject<{
     campaignName: ZodNullable<ZodString>
     companyId: ZodString
     createdOn: ZodString
-    customerId: ZodString
+    customerId: ZodNullable<ZodString>
     orderReference: ZodNullable<ZodString>
     orderedProducts: ZodArray<ZodString>
     orderedProductsSpecs: ZodCampaignOrderedProductSpecs
@@ -171,6 +176,8 @@ export type ZodCampaignCreateFormTargetGroup = ZodObject<{
 export type ZodCampaignCreateForm = ZodObject<{
     companyId: ZodString
     campaignName: ZodOptional<ZodNullable<ZodString>>
+    poNumber: ZodNullable<ZodString>
+    paymentMethod: ZodNullable<ZodNativeEnum<typeof OrderJourneyPaymentMethod>>
     targetGroup: ZodCampaignCreateFormTargetGroup
     recruiterInfo: ZodCampaignRecruiterInfo
     postingDetails: ZodCampaignCreateFormPostingDetails

package/common/enums.ts

@@ -16,6 +16,8 @@ export enum WindowHapiSubmoduleName {
 }
 
 export enum WindowHapiModuleName {
+    router = "router",
+    config = "config",
     ats = "ats",
     basket = "basket",
     campaign = "campaign",

package/common/events/EventCommand/enums.ts

@@ -1,10 +1,7 @@
 export enum WindowHapiEventCommandName {
     /* State */
-    stateHydrate = "state:hydrate",
-    stateTransfer = "state:transfer",
-    stateRestore = "state:restore",
     stateLoad = "state:load",
-    stateInit = "state:init",
+    stateHydrate = "state:hydrate",
 
     /* Service */
     serviceLoad = "service:load",
@@ -30,6 +27,8 @@ export enum WindowHapiEventCommandName {
     qaRequest = "qa:request",
 
     /* DOM */
+    iframeLoaded = "dom:iframe-loaded",
+    iframeUnloaded = "dom:iframe-unloaded",
     domAppendChild = "dom:append-child",
     domElementEvent = "dom:element-event",
     domRemoveChild = "dom:remove-child",
@@ -39,6 +38,8 @@ export enum WindowHapiEventCommandName {
     domAddClass = "dom:add-class",
     domRemoveClass = "dom:remove-class",
     domSlotAvailable = "dom:slot-available",
+    domElementMounted = "dom:element-mounted",
+    domElementUnmounted = "dom:element-unmounted",
 
     /* Location */
     locationSetHref = "location:href",

package/common/events/EventCommand/types.ts

@@ -3,11 +3,13 @@ import { WindowHapiEventCommandName } from "./enums"
 export type WindowHapiEventCommandNames =
     | WindowHapiEventCommandName
     | `dom:element-event-${string}`
+    | `state:change-event-${string}`
 
 export type WindowHapiEventCommandData =
     | [string]
     | [string, ...any[]]
     | [...any[]]
+    | any
     | undefined
 
 export type WindowHapiEventCommandStatus =

package/common/events/types.ts

@@ -34,7 +34,10 @@ export type WindowHapiEventCommand = {
     toJSON: Record<string, any>
 }
 
-export type WindowHapiEventCommandCallbackHandler = (data: any) => void
+export type WindowHapiEventCommandCallbackHandler = (
+    data: any,
+    event: WindowHapiEventCommand,
+) => void
 export type WindowHapiEventCommandCommitHandler = (
     ...args: any[]
 ) => void | never | Promise<void | never>

package/common/qa.types.ts

@@ -4,6 +4,8 @@ import { WindowHapiModuleWithConstructorArgs } from "../_window"
 export type WindowHapiQACommon = WindowHapiModuleWithConstructorArgs<
     {
         setComponentDebuggingIsEnabled: (isEnabled: boolean) => boolean
+        setIsAIFeaturesEnabled: (isEnabled: boolean) => boolean
+        refreshPage: () => void
     },
     { readonly qa: WindowHapiQA }
 >

package/common/validations.types.ts

@@ -55,6 +55,7 @@ export type ZodPaginationResponseV2 = ZodObject<
     } & ZodPaginationLimitOffsetDefinition
 >
 export type WindowHapiValidationsCommon = {
+    isURL: (url: string) => boolean | never
     genericBoolean: ZodBoolean
     genericNumber: ZodNumber
     genericNumberArray: ZodArray<ZodNumber>
@@ -66,6 +67,7 @@ export type WindowHapiValidationsCommon = {
         ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>
     >
     genericRecordBoolean: ZodRecord<ZodString, ZodBoolean>
+    genericRecordAny: ZodRecord<ZodString, ZodAny>
     genericRecordString: ZodRecord<ZodString, ZodString>
     genericStringOrNumber: ZodUnion<[ZodNumber, ZodString]>
     genericNullableStringOrNumber: ZodNullable<ZodUnion<[ZodNumber, ZodString]>>

package/contract/state.types.ts

@@ -10,65 +10,20 @@ import { PaginationResponseV1 } from "../common/types"
 
 export type ContractState = {
     /* Contracts */
-    /**
-     * Array of Contracts to be displayed in Contracts Landing or Contracts List widgets.
-     */
     contracts: Contract[]
-    /**
-     * An object that holds information like next URL, previous URL and count for pagination purposes
-     */
     contractsPaginationMeta: PaginationResponseV1
-    /**
-     * Shows a loading spinner when the Contracts are loading
-     */
     contractsAreLoading: boolean
-    /**
-     * Selected Channel ID that will trigger an API request to fetch the data then to populate `contractSelected`
-     */
     contractSelectedId: string | number | null
-    /**
-     * Selected Channel that will be part of the Contract when user submits the form
-     */
     contractSelected: ProductSupportingContractsComplete | null
-    /**
-     * Shows a loading spinner when the properties required for the Contract are being loaded from the API
-     */
     contractSelectedIsLoading: boolean
-    /**
-     * The object that contains details for the new Contract that will be created when user submits the form
-     */
     contractForm: ContractCreateForm
-    /**
-     * Error(s) received from the API when user submits the form
-     */
     contractCreateError: any
-    /**
-     * Client-side validation result of the `contractForm`. **This value is a computed getter meaning that it cannot be set from outside**
-     */
     contractFormIsValid: boolean | null
     /* Contracts Groups */
-    /**
-     * Array of Contract Groups for user to select during creation of a new Contract.
-     */
     groups: ContractGroup[]
-    /**
-     * Selected Contract Group to be saved as part of Contract that will be created when user submits the form
-     */
     groupSelected: ContractGroupSelected
-    /**
-     * Shows a loading spinner and disables the Select HTML Element when Contract Groups are loading
-     */
     groupsAreLoading: boolean
-    /**
-     * Shows a loading spinner and disables the submit button while a new Contract Group is being created
-     */
     groupIsCreating: boolean
-    /**
-     * Error message displayed to the end user when the new Contract Group could not be created
-     */
     groupCreateError: string | null
-    /**
-     * The object that contains details for the new Contract Group that will be created when user submits the form
-     */
     groupForm: ContractGroupCreateForm
 }

package/contract/utils.types.ts

@@ -1,4 +1,4 @@
-import { ContractCreateForm, ContractGroupCreateForm } from "./types"
+import { Contract, ContractCreateForm, ContractGroupCreateForm } from "./types"
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
@@ -6,6 +6,7 @@ export type WindowHapiUtilsContract = WindowHapiModuleWithConstructorArgs<
     {
         getInitialContractForm: () => ContractCreateForm
         getInitialGroupForm: () => ContractGroupCreateForm
+        getContractNameWithGroupSuffix: (contract: Contract) => string
     },
     { readonly utils: WindowHapiUtils }
 >

package/debugging/state.types.ts

@@ -1,18 +1,7 @@
 export type DebuggingState = {
-    /**
-     * Shows or hides the debugging tool on Campaign Create Form's fields for Product & Contract steps
-     */
     campaignFormDebuggerIsShown: boolean
-    /**
-     * Shows translation keys in place of translations for ease of development
-     */
     localeDebuggingIsEnabled: boolean
-    /**
-     * Encompasses widgets that may become available (or upon request) with a red border and a name so communication while making requests is easier.
-     */
     componentDebuggingIsEnabled: boolean
-    /**
-     * Enables console logs (all HAPI Elements) logs
-     */
     consoleLogsAreEnabled: boolean
+    isAIFeaturesEnabled: boolean
 }

package/modal/enums.ts

@@ -11,4 +11,7 @@ export enum ModalKeys {
     campaignCopyConfirmation = "campaign-confirm-copy",
     basketRemoveProductConfirmation = "remove-product-from-basket",
     contractRemoveConfirmation = "contract-remove-confirmation",
+    contractGroupConflictInfo = "contract-group-conflict-info",
+    filePicker = "file-picker",
+    contractPostingRequirementsSmartFillSuccess = "contract-posting-requirements-smart-fill-success",
 }

package/modal/types.ts

@@ -2,6 +2,7 @@ import { Product } from "../product/types"
 import { Contract } from "../contract/types"
 import { ModalKeys, ModalZone } from "./enums"
 import { AnyNonFunction } from "../common/types"
+import { TransformedPostingRequirement } from "../campaign"
 
 export type ProductDetailModalProps = {
     id: string
@@ -12,6 +13,21 @@ export type BasketRemoveProductConfirmationModalProps = {
 }
 export type CampaignTakeOfflineConfirmationModalProps = { campaignId: string }
 export type ContractRemoveConfirmationModalProps = { contractId: string }
+export type ContractGroupConflictInfoModalProps = {
+    contract: Contract
+    conflictingContracts: Contract[]
+}
+export type ContractPostingRequirementsSmartFillResponseModalProps = {
+    response: Record<string, any>
+    postingRequirements: Record<string, TransformedPostingRequirement>
+    contractId: string
+}
+export type FilePickerOptions = {
+    accept?: string[]
+    uploadInBackground?: boolean
+    maxFiles?: number
+    maxSize?: number
+}
 export type BasketModalProps = {}
 export type WalletModalProps = {}
 
@@ -21,6 +37,8 @@ export type ModalProps = AnyNonFunction<
     | BasketRemoveProductConfirmationModalProps
     | CampaignTakeOfflineConfirmationModalProps
     | ContractRemoveConfirmationModalProps
+    | ContractGroupConflictInfoModalProps
+    | ContractPostingRequirementsSmartFillResponseModalProps
     | BasketModalProps
     | WalletModalProps
 >
@@ -28,6 +46,7 @@ export type ModalProps = AnyNonFunction<
 export type ModalOptions = {
     showCloseButton?: boolean
     showBackdrop?: boolean
+    unstyled?: boolean
     disableVerticalScroll?: boolean
 }
 

package/orderJourney/enums.ts

@@ -21,5 +21,5 @@ export enum OrderJourneyStepKey {
 export enum OrderJourneyPaymentMethod {
     atsManaged = "ats-managed",
     wallet = "wallet",
-    purchaseOrder = "purchase-order",
+    purchaseOrder = "purchase_order",
 }

package/orderJourney/service.types.ts

@@ -0,0 +1,16 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type OrderJourneyServiceSwitchToNextStepHandler = () => Promise<void>
+export type OrderJourneyServiceSwitchToPreviousStepHandler = () => Promise<void>
+
+export type WindowHapiServiceOrderJourney = WindowHapiModuleWithConstructorArgs<
+    {
+        switchToNextStep: HapiServiceFunctionWithLifecycleHooks<OrderJourneyServiceSwitchToNextStepHandler>
+        switchToPreviousStep: HapiServiceFunctionWithLifecycleHooks<OrderJourneyServiceSwitchToPreviousStepHandler>
+    },
+    { readonly service: WindowHapiService }
+>

package/orderJourney/state.types.ts

@@ -1,5 +1,11 @@
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
-import { OrderJourneyStep, OrderJourneyContractStep } from "./types"
+import {
+    OrderJourneyStep,
+    OrderJourneyContractStep,
+    OrderJourneyUTMStepData,
+    OrderJourneyUTMStepValidations,
+    OrderJourneyOrderReviewStepData,
+} from "./types"
 import { MessageDescriptor } from "react-intl"
 import { NestedValidatorKeys, UseValidatorResult } from "../common/types"
 
@@ -15,9 +21,9 @@ export type OrderJourneyState = {
     stepActive: OrderJourneyStep | null
     stepNext: OrderJourneyStep | null
     stepsPopulatedAreHidden: boolean
+    stepIsSwitching: boolean
     paymentMethodsAvailable: OrderJourneyPaymentMethod[]
     paymentMethodsEnabled: OrderJourneyPaymentMethod[]
-    paymentMethodActive: OrderJourneyPaymentMethod | null
     hidePrefilledFields: boolean
     orderErrors: Record<string, any> | null
     /* Onboarding */
@@ -82,11 +88,11 @@ export type OrderJourneyState = {
     contractStepsValidations: Record<string, UseValidatorResult> | null
     /* UTM Codes */
     utmCodesStep: OrderJourneyStep
-    utmCodesStepData: Record<string, any>
-    utmCodesStepValidations: UseValidatorResult
+    utmCodesStepData: OrderJourneyUTMStepData
+    utmCodesStepValidations: OrderJourneyUTMStepValidations
     /* Order Review */
     orderReviewStep: OrderJourneyStep
-    orderReviewStepData: Record<string, any>
+    orderReviewStepData: OrderJourneyOrderReviewStepData
     orderReviewStepValidations: UseValidatorResult
     /* Payment Method */
     paymentMethodStep: OrderJourneyStep

package/orderJourney/types.ts

@@ -1,18 +1,24 @@
 import { MessageDescriptor } from "react-intl"
 import { OrderJourneyStepKey } from "./enums"
+import { UseValidatorResult } from "../common"
 
-export type OrderJourneyStepBlurredFields = Record<
-    string,
-    | boolean
-    | Record<string, boolean>
-    | Record<string, Record<string, boolean> | boolean>
->
+export type OrderJourneyStepBlurredFields = {
+    [k: string]:
+        | boolean
+        | Record<string, boolean | OrderJourneyStepBlurredFields>
+}
 
-export type OrderJourneyStepErrorMessages = Record<
-    string,
-    | MessageDescriptor
-    | Record<string, MessageDescriptor | Record<string, MessageDescriptor>>
->
+export type OrderJourneyStepErrorMessage = Record<string, MessageDescriptor>
+
+export type OrderJourneyStepErrorMessages = {
+    [k: string]:
+        | MessageDescriptor
+        | Record<string, MessageDescriptor | OrderJourneyStepErrorMessage>
+}
+
+export type OrderJourneyStepHideFields = {
+    [k: string]: boolean | Record<string, boolean | OrderJourneyStepHideFields>
+}
 
 export type OrderJourneyStepKeyType = OrderJourneyStepKey | string
 export type OrderJourneyStep = {
@@ -22,10 +28,42 @@ export type OrderJourneyStep = {
     isSubmitted?: boolean
     blurredFields?: OrderJourneyStepBlurredFields
     errorMessagesIntlDescriptors?: OrderJourneyStepErrorMessages
-    hideFields?: Record<string, boolean>
+    hideFields?: OrderJourneyStepHideFields
 }
 
 export type OrderJourneyContractStep = Omit<
     OrderJourneyStep,
     "blurredFields" | "isSubmitted" | "errorMessagesIntlDescriptors"
 >
+
+export type UTMMap = {
+    value: string
+    mapToName: boolean
+    key: string
+}
+
+export type OrderJourneyUTMStepData = {
+    settings: UTMMap[]
+    productUTMs: Record<string, UTMMap[]>
+}
+
+export type OrderJourneyUTMStepValidations = {
+    settings: {
+        name: UseValidatorResult
+        value: UseValidatorResult
+    }
+    productUTMs: Record<
+        string,
+        {
+            settings: {
+                name: UseValidatorResult
+                value: UseValidatorResult
+            }
+        }
+    >
+    areAllValid: boolean
+}
+
+export type OrderJourneyOrderReviewStepData = {
+    accordionsOpen: OrderJourneyStepKey[]
+}

package/orderJourney/utils.types.ts

@@ -1,11 +1,19 @@
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
+import { Contract } from "../contract"
+import { Product } from "../product"
 
 export type WindowHapiUtilsOrderJourney = WindowHapiModuleWithConstructorArgs<
     {
         stepKeys: typeof OrderJourneyStepKey
         paymentMethodKeys: typeof OrderJourneyPaymentMethod
+        updateProductUTMsFromBasketItemData: (
+            basketItemData: (Contract | Product)[],
+        ) => void
+        updateOrderReviewAccordionStatesFromBasketItemData: (
+            basketItemData: (Contract | Product)[],
+        ) => void
     },
     { readonly utils: WindowHapiUtils }
 >

package/orderJourney/validations.types.ts

@@ -1,25 +1,42 @@
 import {
     ZodArray,
     ZodBoolean,
+    ZodNativeEnum,
     ZodObject,
     ZodOptional,
     ZodRecord,
     ZodString,
     ZodTypeAny,
+    ZodUnion,
 } from "zod"
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
 import { ZodIntlDescriptor } from "../common/validations.types"
 
 export type ZodOrderJourneyStep = ZodObject<{
     key: ZodString
-    titleIntlDescriptor: ZodIntlDescriptor
-    descriptionIntlDescriptor: ZodIntlDescriptor
+    titleIntlDescriptor: ZodOptional<ZodIntlDescriptor>
+    descriptionIntlDescriptor: ZodOptional<ZodIntlDescriptor>
     isSubmitted: ZodOptional<ZodBoolean>
     blurredFields: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
     errorMessagesIntlDescriptors: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
 }>
 
 export type ZodOrderJourneySteps = ZodArray<ZodOrderJourneyStep>
+export type ZodOrderJourneyUTMCodeMap = ZodObject<{
+    mapToName: ZodBoolean
+    value: ZodString
+    key: ZodString
+}>
+export type ZodOrderJourneyUTMCodeMaps = ZodArray<ZodOrderJourneyUTMCodeMap>
+export type ZodOrderJourneyUTMCodesStepData = ZodObject<{
+    settings: ZodOrderJourneyUTMCodeMaps
+    productUTMs: ZodRecord<ZodString, ZodOrderJourneyUTMCodeMaps>
+}>
+export type ZodOrderJourneyOrderReviewStepData = ZodObject<{
+    accordionsOpen: ZodArray<
+        ZodUnion<[ZodNativeEnum<typeof OrderJourneyStepKey>, ZodString]>
+    >
+}>
 export type WindowHapiValidationsOrderJourney = {
     supportedStepKeys: OrderJourneyStepKey[]
     stepKeysRegex: RegExp
@@ -31,4 +48,8 @@ export type WindowHapiValidationsOrderJourney = {
     paymentMethods: ZodArray<ZodString>
     supportedPaymentMethods: OrderJourneyPaymentMethod[]
     paymentMethodsRegex: RegExp
+    utmMap: ZodOrderJourneyUTMCodeMap
+    utmMaps: ZodOrderJourneyUTMCodeMaps
+    utmCodesStepData: ZodOrderJourneyUTMCodesStepData
+    orderReviewStepData: ZodOrderJourneyOrderReviewStepData
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@vonq/hapi-elements-types",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "This package contains Typescript definitions for HAPI Elements",
   "author": "VONQ HAPI Team",
   "license": "BSD-3-Clause",

package/product/state.types.ts

@@ -10,84 +10,29 @@ import { PaginationResponseV1 } from "../common/types"
 
 export type ProductState = {
     /* Products */
-    /**
-     * Array of Products to be listed on Products Landing and Products List widgets. As user applies filters and sorting, this value gets overwritten
-     */
     recommendedProducts: Product[]
-    /**
-     * Indicates if recommended products are loading
-     */
     recommendedProductsAreLoading: boolean
-    /**
-     * Array of Products to be listed on Contracts Add Channel Selector Dropdown
-     */
     productsWithContractsSupport: ProductSupportingContractsPartial[]
-    /**
-     * Indicates whether the Products with Contracts support is loading (mainly used for showing a loading spinner on the Select element when the user is searching for a Product when creating a contract)
-     */
     productsWithContractsSupportAreLoading: boolean
-    /**
-     * Array of Products to be listed on Products Landing and Products List widgets. As user applies filters and sorting, this value gets overwritten
-     */
     products: Product[]
-    /**
-     Offset and limit style pagination meta
-     */
     productsPaginationMeta: PaginationResponseV1 | null
-    /**
-     * Indicates if products are loading
-     */
     productsAreLoading: boolean
-    /**
-     * The value of Product name in the Input HTML Element that is used to fetch new Product results from the API
-     */
     productNameInput: string
-    /**
-     * The selected Product region IDs that is used to fetch new Product results from the API
-     */
     jobRegionsIdsSelected: number[]
     /* Locations */
-    /**
-     * Array of Locations that are lazily loaded with the input given in `jobRegionsIdsSelected`
-     */
     jobRegions: ProductLocation[]
     /* Job Titles */
-    /**
-     * Array of Job Titles that are lazily loaded with the input given in `jobTitlesIdsSelected`
-     */
     jobTitles: ProductJobTitle[]
-    /**
-     * The selected Job Title IDs that are used to fetch new Product results from the API
-     */
     jobTitlesIdsSelected: number[]
     /* Job Functions */
-    /**
-     * Array of Job Functions that are lazily loaded with the input given in `jobTitlesIdsSelected`
-     */
     jobFunctions: ProductJobFunction[]
-    /**
-     * Shows a loading spinner and disables the Select HTML Element while locations are loading
-     */
     jobFunctionsAreLoading: boolean
-    /**
-     * The value of Job Function in the Input HTML Element that lazy loads `jobFunctions`
-     */
     jobFunctionsInput: string
-    /**
-     * The selected Job Function IDs that are used to fetch new Product results from the API
-     */
     jobFunctionsIdsSelected: number[]
     /* Industries */
-    /**
-     * The selected Job Industry ID that is used to fetch new Product results from the API
-     */
     jobIndustriesIdsSelected: number[]
-    /**
-     * Array of Industries that are lazily loaded with the input given in `jobIndustriesIdsSelected`
-     */
     jobIndustries: ProductIndustry[]
-    /**
-     * Shows a loading spinner and disables the Select HTML Element while locations are loading
-     */
     jobIndustriesAreLoading: boolean
+    /* Search Text */
+    searchTextInput: string
 }

package/product/types.ts

@@ -64,14 +64,16 @@ export type Product = {
 } & ProductLogos &
     ProductType
 
+export type ProductBoardType =
+    | "aggregator"
+    | "job board"
+    | "service"
+    | "social media"
+    | "publication"
+    | "community"
+
 export type ProductType = {
-    type:
-        | "aggregator"
-        | "job board"
-        | "service"
-        | "social media"
-        | "publication"
-        | "community"
+    type: ProductBoardType
 }
 
 export type ProductLogos = {
@@ -100,6 +102,8 @@ export type ProductLocationPlaceType =
     | "continent"
     | "country"
     | "region"
+    | "place"
+    | "district"
 
 export type ProductLocation = {
     bounding_box: any[]
@@ -116,6 +120,7 @@ export type ProductFilterQueryParams = {
     jobIndustriesIdsSelected: number[]
     filterProductRecommendations: ProductFilterRecommendations
     filterMyContractSupportedOnly: boolean
+    searchTextInput: string
 }
 
 export type ProductSearchFilters = {

package/theming/types.ts

@@ -39,6 +39,7 @@ declare const useTheme: UseThemeFactory<DefaultTheme>
 
 export type ThemeGlobalStyles = {
     borderRadius: string
+    borderColor: string
 
     primaryBackgroundColor: string
     primaryTextColor: string
@@ -67,6 +68,9 @@ export type ThemeGlobalStyles = {
 
     accentBackgroundColor: string
     accentTextColor: string
+
+    scrollBarTrackColor: string
+    scrollBarThumbColor: string
 }
 
 export type HapiThemingThemeProvider = Theming<HapiTheme>["ThemeProvider"]
@@ -98,6 +102,7 @@ export type HapiThemeRule =
     | "buttonFaded"
     | "buttonAccent"
     | "badgeBase"
+    | "formFieldLabel"
     | "formFieldBase"
     | "inputSelectBase"
     | "input"

package/ui/service.types.ts

@@ -3,6 +3,8 @@ import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
     {
+        onIframeLoaded: (callback: (iframeName: string) => void) => void
+        onIframeUnloaded: (callback: (iframeName: string) => void) => void
         setStyleAttribute: (
             selector: string,
             attributeName: string,
@@ -11,12 +13,12 @@ export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
         setStyle: (selector: string, style: any) => Promise<void>
         addClass: (selector: string, className: string) => Promise<void>
         removeClass: (selector: string, className: string) => Promise<void>
-        appendChild: (
-            containerSelector: string,
+        appendChildToSlot: (
+            slotId: string,
             element: HTMLElement,
         ) => Promise<void>
-        removeChild: (
-            containerSelector: string,
+        removeChildFromSlot: (
+            slotId: string,
             elementSelector: string,
         ) => Promise<void>
         hideElement: (elementSelector: string) => Promise<void>

package/wallet/state.types.ts

@@ -6,53 +6,17 @@ import {
 } 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[]
 }