@vonq/hapi-elements-types 1.50.0 → 1.52.0

package/_window/sdk.types.ts

@@ -54,6 +54,7 @@ import { ExperimentalState } from "../experimental/state.types"
 import { ProductCacheState } from "../product/state.cache.types"
 import { WindowHapiValidationsUI } from "../ui/validations.types"
 import { WindowHapiUtilsUI } from "../ui/utils.types"
+import { UIState } from "types/ui/state.types"
 
 export type WindowHapiSDKModule<
     APIModule,
@@ -140,7 +141,7 @@ export type WindowHapiSDKUI = WindowHapiSDKModule<
     undefined,
     WindowHapiServiceUI,
     WindowHapiValidationsUI,
-    undefined,
+    WindowHapiStateModule<UIState>,
     WindowHapiUtilsUI
 >
 export type WindowHapiSDKATS = WindowHapiSDKModule<

package/_window/service.types.ts

@@ -28,6 +28,7 @@ export type HapiServiceFunctionLifecycleHookHandler = (
 ) => void
 
 export type HapiServiceFunctionWithLifecycleHooks<HandlerType> = {
+    functionName: string
     run: HandlerType
     runWithoutSDKUsageLog: HandlerType
     onStart: HapiServiceFunctionLifecycleHookHandler

package/_window/state.types.ts

@@ -6,6 +6,7 @@ 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 { UIState } from "types/ui/state.types"
 import { OrderJourneyState } from "../orderJourney/state.types"
 import { WalletState } from "../wallet/state.types"
 import { ModalState } from "../modal/state.types"
@@ -46,6 +47,7 @@ export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
             ProductCacheState
         >
         [WindowHapiModuleName.theming]: WindowHapiStateModule<ThemingState>
+        [WindowHapiModuleName.ui]: WindowHapiStateModule<UIState>
         [WindowHapiModuleName.orderJourney]: WindowHapiStateModule<OrderJourneyState>
         [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
         [WindowHapiModuleName.modal]: WindowHapiStateModule<ModalState>
@@ -75,6 +77,7 @@ export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
                 ProductCacheState
             >
             [WindowHapiModuleName.theming]: WindowHapiStateModule<ThemingState>
+            [WindowHapiModuleName.ui]: WindowHapiStateModule<UIState>
             [WindowHapiModuleName.orderJourney]: WindowHapiStateModule<OrderJourneyState>
             [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
             [WindowHapiModuleName.modal]: WindowHapiStateModule<ModalState>
@@ -98,6 +101,7 @@ export type WindowHapiStatesJSON = {
     [WindowHapiModuleName.language]: LanguageState
     [WindowHapiModuleName.product]: ProductState
     [WindowHapiModuleName.theming]: ThemingState
+    [WindowHapiModuleName.ui]: UIState
     [WindowHapiModuleName.orderJourney]: OrderJourneyState
     [WindowHapiModuleName.wallet]: WalletState
     [WindowHapiModuleName.modal]: ModalState

package/_window/utils.types.ts

@@ -13,7 +13,7 @@ import { WindowHapiUtilsRouter } from "../routing/utils.types"
 import { WindowHapiUtilsLanguage } from "../language/utils.types"
 import { WindowHapiUtilsAlert } from "../alert/utils.types"
 
-import { FlattenedItem, WindowHapiLogger } from "../common"
+import { FlattenedItem, WindowHapiLogger, WindowHapiTimer } from "../common"
 import { WindowHapiUtilsUI } from "../ui/utils.types"
 
 export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
@@ -45,6 +45,23 @@ export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
         ) => any[]
         getComponentNameIndexSuffix: (instanceName: string) => string
         getIframeLoadingSpinner: () => HTMLDivElement
+        timeoutIds: WindowHapiTimer[]
+        intervalIds: WindowHapiTimer[]
+        setTimeout: (
+            callingFunctionName: string,
+            handler: TimerHandler,
+            timeout?: number,
+            ...args: any[]
+        ) => number
+        setInterval: (
+            callingFunctionName: string,
+            handler: TimerHandler,
+            timeout?: number,
+            ...args: any[]
+        ) => number
+        clearTimeout: (id: number) => void
+        clearInterval: (id: number) => void
+        clearAllTimers: () => void
         product: WindowHapiUtilsProduct
         contract: WindowHapiUtilsContract
         campaign: WindowHapiUtilsCampaign

package/alert/types.ts

@@ -51,6 +51,10 @@ export type ButtonCopySuccessAlertProps = {}
 
 export type CampaignOrderSuccessAlertProps = {}
 
+export type CampaignOrderFailAlertProps = {
+    errorMessage?: string
+}
+
 export type CampaignCopySuccessAlertProps = {}
 
 export type CampaignCopyProductsContractsDeletedWarningAlertProps = {}

package/basket/service.types.ts

@@ -6,6 +6,7 @@ import {
     WindowHapiService,
 } from "../_window/service.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
+import { ModalKeys } from "types/modal"
 
 export type BasketServiceGetProductsHandler = (
     products: BasketProduct[],
@@ -23,6 +24,9 @@ export type BasketServiceRemoveContractsWithConflictingGroupsHandler = (
     contractThatUserTriedToAdd: Contract,
 ) => void
 export type BasketServiceKeepContractsWithConflictingGroupsHandler = () => void
+export type BasketServiceRemoveProductOrContractFromBeingAddedRemovedHandler = (
+    contractOrProductId: string,
+) => void
 export type BasketServiceSetProductsMetaHandler = (
     meta: BasketProduct[],
 ) => void
@@ -40,6 +44,7 @@ export type WindowHapiServiceBasket = WindowHapiModuleWithConstructorArgs<
         removeProductOrContractById: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveProductOrContractByIdHandler>
         removeContractsWithConflictingGroups: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveContractsWithConflictingGroupsHandler>
         keepContractsWithConflictingGroups: HapiServiceFunctionWithLifecycleHooks<BasketServiceKeepContractsWithConflictingGroupsHandler>
+        removeProductOrContractFromBeingAddedRemoved: HapiServiceFunctionWithLifecycleHooks<BasketServiceRemoveProductOrContractFromBeingAddedRemovedHandler>
         clear: () => BasketProduct[]
     },
     { readonly service: WindowHapiService }

package/campaign/api.types.ts

@@ -1,6 +1,8 @@
 import { AxiosRequestConfig } from "axios"
 import {
     Campaign,
+    CampaignApplication,
+    CampaignApplicationFileGenerated,
     CampaignEditRequestBody,
     CampaignIdResponse,
     CampaignOrderRequestBody,
@@ -16,13 +18,15 @@ import {
 } from "./types"
 import { ProductSupportingContractsComplete } from "../product/types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
-import { PaginatedAPIResponseV2 } from "../common/types"
+import { PaginatedAPIResponseV1, PaginatedAPIResponseV2 } from "../common/types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiAPICampaignConfigs = {
     getCampaigns: AxiosRequestConfig
     getCampaign: AxiosRequestConfig
     getCampaignDetail: AxiosRequestConfig
+    getCampaignApplications: AxiosRequestConfig
+    generateCampaignApplicationFile: AxiosRequestConfig
     setCampaignCancellation: AxiosRequestConfig
     getEducationLevels: AxiosRequestConfig
     getSeniorities: AxiosRequestConfig
@@ -51,6 +55,14 @@ export type WindowHapiAPICampaignRequests = {
         campaignId: string,
         detail: "status",
     ) => Promise<ProductSupportingContractsComplete>
+    getCampaignApplications: (
+        campaignId: string,
+    ) => Promise<PaginatedAPIResponseV1<CampaignApplication>>
+    generateCampaignApplicationFile: (
+        campaignId: string,
+        applicationId: string,
+        filename: string,
+    ) => Promise<CampaignApplicationFileGenerated>
     setCampaignCancellation: (
         campaignId: string,
         body: Partial<Campaign>,

package/campaign/types.ts

@@ -1,9 +1,13 @@
 import {
+    ProductCPA,
     ProductDuration,
     ProductIndustry,
     ProductJobFunctionPartial,
 } from "../product/types"
-import { ProductPriceCurrency } from "../product/enums"
+import {
+    ProductCPAHiringGoalUnit,
+    ProductPriceCurrency,
+} from "../product/enums"
 import { EmploymentType, SalaryPeriod } from "./enums"
 import { OrderJourneyPaymentMethod } from "../orderJourney"
 import {
@@ -24,6 +28,8 @@ export type CampaignProductSpecs = {
     status: CampaignStatus
     utm: string | null
     statusDescription: string | null
+    metadata?: CampaignMetadata
+    orderedCpa?: ProductCPA
 }
 
 export type CampaignProductStatus = {
@@ -101,6 +107,7 @@ export type CampaignPosting = {
     clicks: number
     name: string
     productId: string
+    cpaResults?: Record<ProductCPAHiringGoalUnit, number>
 }
 
 export type CampaignRecruiterInfo = {
@@ -167,6 +174,8 @@ export type CampaignDraftV2 = {
     }
 }
 
+export type CampaignMetadata = Record<string, any>
+
 export type Campaign = Pick<CampaignDraft, "campaignId"> &
     CampaignDraftOldBackwardsCompatability &
     CampaignDraftV2 & {
@@ -191,6 +200,7 @@ export type Campaign = Pick<CampaignDraft, "campaignId"> &
         detailedStatus?: CampaignDetailedStatus //this is only added virtually on FE on demand
         isEditable: boolean
         modifiedOn: string
+        metadata?: CampaignMetadata
     }
 
 export type CampaignCreateFormTargetGroupEducationLevel =
@@ -311,10 +321,10 @@ export type CampaignOrderRequestBodyProvidedBySmartFill = Omit<
     CampaignOrderRequestBody,
     "targetGroup"
 > & {
-    targetGroup: {
+    taxonomy: {
         industry: ProductIndustry
         seniority: TaxonomyEducationAndSeniorityLevel
-        jobCategory: ProductJobFunctionPartial
+        jobFunction: ProductJobFunctionPartial
         educationLevel: TaxonomyEducationAndSeniorityLevel
     }
 }
@@ -436,3 +446,24 @@ export type CampaignVacancyFieldsSuggestionsGetRequestResponse = {
     updated_at: string
     prefill_data: RecursivePartial<CampaignOrderRequestBodyProvidedBySmartFill>
 }
+
+export type CampaignApplicationFile = {
+    type: string
+    mimeType: string
+    filename: string
+}
+
+export type CampaignApplicationFileGenerated = {
+    filename: string
+    url: string
+    generated_at: string
+}
+
+export type CampaignApplication = {
+    id: string
+    name: string
+    email: string
+    phone: string
+    files: CampaignApplicationFile[]
+    updated: string
+}

package/common/logger/types.ts

@@ -17,3 +17,5 @@ export type WindowHapiLogger = {
     timeStart: (message: string) => void
     timeEnd: (message: string) => void
 }
+
+export type WindowHapiTimer = {}

package/common/types.ts

@@ -118,6 +118,7 @@ export type HapiWebComponent = {
     */
     // some widgets have query params, we need to mock them
     qaMockQueryParams?: Record<string, string>
+    qaDocsPlaygroundCSS?: Record<string, string>
     optionalAttributes?: string[]
     loadingLazyIframe?: boolean
     isHiddenOnDocumentation?: boolean

package/modal/enums.ts

@@ -17,6 +17,7 @@ export enum ModalKeys {
     basketRemoveProductConfirmation = "remove-product-from-basket",
     basketProductBundleParentClashConfirmation = "basket-product-bundle-parent-clash-confirmation",
     basketProductBundleChildClashConfirmation = "basket-product-bundle-child-clash-confirmation",
+    basketProductCPAClashConfirmation = "basket-product-cpa-clash-confirmation",
     contractRemoveConfirmation = "contract-remove-confirmation",
     contractGroupRemoveConfirmation = "contract-group-remove-confirmation",
     contractGroupUpdateConfirmation = "contract-group-update-confirmation",

package/modal/types.ts

@@ -45,6 +45,11 @@ export type BasketProductBundleParentClashConfirmationProps = {
     bundleProduct: Product
     childProducts: Product[]
 }
+export type BasketProductCPAClashConfirmationModalProps = {
+    itemsBeingClashed: (Product | Contract)[]
+    itemBeingAdded: Product | Contract
+}
+
 export type CampaignEditModalProps = {
     campaign?: Campaign
 }
@@ -103,6 +108,9 @@ export type ModalProps = AnyNonFunction<
     | FilePickerModalProps
     | BasketModalProps
     | WalletModalProps
+    | BasketProductCPAClashConfirmationModalProps
+    | BasketProductBundleParentClashConfirmationModalProps
+    | BasketProductBundleParentClashConfirmationProps
 >
 
 export type ModalOptions = {

package/package.json

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

package/product/enums.ts

@@ -25,3 +25,7 @@ export enum ProductTypeFilterBy {
     "bundlesOnly" = "bundlesOnly",
     "freeAddOnOnly" = "freeAddOnOnly",
 }
+
+export enum ProductCPAHiringGoalUnit {
+    reviewedApplications = "reviewed_applications",
+}

package/product/types.ts

@@ -1,4 +1,5 @@
 import {
+    ProductCPAHiringGoalUnit,
     ProductFilterRecommendations,
     ProductPriceCurrency,
     ProductSortBy,
@@ -47,6 +48,10 @@ export type ProductSupportingContractsPartial = {
 
 export type ProductAudienceGroup = "niche" | "generic"
 
+export type ProductCPA = {
+    hiring_goal: number
+    hiring_goal_unit: ProductCPAHiringGoalUnit
+}
 export type Product = {
     allow_orders: boolean
     audience_group: ProductAudienceGroup
@@ -69,6 +74,7 @@ export type Product = {
     time_to_setup: ProductDuration
     is_recommended?: boolean
     has_product_specs: boolean
+    cpa: ProductCPA | null
 } & ProductLogos &
     ProductType
 

package/ui/state.types.ts

@@ -0,0 +1,3 @@
+export type UIState = {
+    descriptionsAreShownBelowFormFields: boolean
+}