@vonq/hapi-elements-types 1.9.0 → 1.10.0

package/_window/api.types.ts

@@ -67,6 +67,11 @@ export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
         headers: RawAxiosRequestHeaders
         setHeaders: (headers: RawAxiosRequestHeaders) => void
         baseRequestConfig: RawAxiosRequestConfig<any>
+        makeDataRequest: (
+            method: "get" | "put" | "patch",
+            endpoint: string,
+            data?: any,
+        ) => Promise<any>
         [WindowHapiModuleName.contract]: WindowHapiAPIContract
         [WindowHapiModuleName.wallet]: WindowHapiAPIWallet
         [WindowHapiModuleName.product]: WindowHapiAPIProduct

package/_window/auth.types.ts

@@ -7,6 +7,7 @@ export type WindowHapiAuth = WindowHapiModuleWithConstructorArgs<
     {
         partnerId: string | undefined
         clientId: string | undefined
+        partnerToken: string | undefined // used for impersonation
         clientToken: string | undefined
     },
     { readonly core: WindowHapiClassInterface }

package/_window/events.types.ts

@@ -1,19 +1,19 @@
 import {
+    WindowHapiEventCommandData,
     WindowHapiEventCommandNames,
     WindowHapiEventCommandStatus,
-    WindowHapiEventCommandData,
 } from "../common/events/EventCommand/types"
 import {
+    WindowHapiEventCommand,
     WindowHapiEventCommandCallbackHandler,
+    WindowHapiEventListener,
     WindowHapiEventMediatorGetInstancesHandler,
     WindowHapiEventMediatorInstances,
-    WindowHapiEventCommand,
     WindowHapiEventStrategy,
-    WindowHapiEventListener,
 } from "../common/events/types"
 import {
-    WindowHapiModuleWithConstructorArgs,
     WindowHapiClassInterface,
+    WindowHapiModuleWithConstructorArgs,
 } from "./window"
 import { WindowHapiSubmoduleName } from "../common/enums"
 import { WindowHapiInstance } from "./instances.types"
@@ -145,6 +145,7 @@ export type WindowHapiEvents = WindowHapiModuleWithConstructorArgs<
         eventServiceStrategy: WindowHapiEventStrategy
         eventQAStrategy: WindowHapiEventStrategy
         eventDOMStrategy: WindowHapiEventStrategy
+        eventConfigStrategy: WindowHapiEventStrategy
         getInstances: () => {
             source: WindowHapiInstance
             targets: WindowHapiInstance[]

package/_window/instances.types.ts

@@ -7,6 +7,7 @@ import { WindowHapiLogger } from "../common/logger/types"
 export type WindowHapiInstances = WindowHapiModuleWithConstructorArgs<
     {
         instances: WindowHapiInstance[]
+        readyInstances: string[]
         getFrameWindowByName: (name: string) => Window | undefined
         hasInstance: (instanceName: string) => boolean
         getInstanceByName: (
@@ -17,6 +18,7 @@ export type WindowHapiInstances = WindowHapiModuleWithConstructorArgs<
         removeInstance: (instanceName: string) => void
         onAfterAddInstance: (instance: WindowHapiInstance) => void
         onAfterRemoveInstance: (instance: WindowHapiInstance) => void
+        setInstanceReadyByName: (instanceName: string, isReady: boolean) => void
     },
     { readonly core: WindowHapiClassInterface }
 >

package/_window/service.types.ts

@@ -36,6 +36,7 @@ export type HapiServiceBase = {
     __serviceName: WindowHapiModuleName
     logger: WindowHapiLogger
     init: () => void
+    propertiesThatShouldNotBeDocumented: string[]
 }
 export type WindowHapiService = WindowHapiModuleWithConstructorArgs<
     {

package/_window/state.types.ts

@@ -43,6 +43,7 @@ export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.ats]: WindowHapiStateModule<ATSState>
         basePropertiesThatShouldNotBeDocumented: string[]
         handleDefaultStateFromQueryParams: (params: string | string[]) => void
+        onBeforeStateChange: () => void
         onAfterStateChange: () => void
         stores: {
             alert: WindowHapiStateModule<AlertState>
@@ -78,11 +79,12 @@ export type WindowHapiStatesJSON = {
     [WindowHapiModuleName.ats]: ATSState
 }
 
-export type WindowHapiStateBase = {
+export type WindowHapiStateBase<T> = {
     propertiesThatShouldNotBeDocumented: string[]
     __elementsStateModuleName: string
     toJSON: any
     addClassPropertiesObserver: () => void
+    validations: StateValidations<T>
 }
 
 export type HapiStateValueWithListener<T> = {
@@ -90,7 +92,7 @@ export type HapiStateValueWithListener<T> = {
     value: T
 }
 
-export type WindowHapiStateModule<T> = WindowHapiStateBase & {
+export type WindowHapiStateModule<T> = WindowHapiStateBase<T> & {
     [P in keyof T]:
         | T[P]
         | HapiStateValueWithListener<T[P]>

package/_window/utils.types.ts

@@ -8,14 +8,15 @@ import {
     WindowHapiModuleWithConstructorArgs,
     WindowHapiClassInterface,
 } from "./window"
+import { RecursivePartial } from "../common"
 
 export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
     {
         isObject: (item: any) => boolean
-        mergeDeepOverwriteArrays: (
-            original: Record<string, any>,
-            overwrites: Record<string, any>,
-        ) => Record<string, any>
+        mergeDeepOverwriteArrays: <T>(
+            original: T,
+            overwrites: RecursivePartial<T>,
+        ) => T
         getComponentNameIndexSuffix: (instanceName: string) => string
         getIframeLoadingSpinner: () => HTMLDivElement
         product: WindowHapiUtilsProduct

package/_window/window.ts

@@ -85,10 +85,12 @@ export type WindowHapiConfigSubmodule = {
     apiHost: string
     initialState: RecursivePartial<any>
     partnerId: string
+    partnerToken: string
     clientId: string
     clientToken: string
     loadingSpinnerDefaultFillColor: string
     appOrigin: string
+    docsOrigin: string
     enableLogs: boolean
     webComponents: HapiWebComponent[]
     isInvalidToken: boolean
@@ -122,6 +124,7 @@ export type WindowHapiClassInterface = {
     instance: WindowHapiInstance
     qa: WindowHapiQASubmodule
     isProduction: boolean
+    enableLogs: boolean
 }
 
 export type WindowHapi = {

package/alert/enums.ts

@@ -5,6 +5,7 @@ export enum AlertKey {
     contractCreateSuccess = "contract-created",
     contractGroupCreateSuccess = "contract-group-created",
     campaignTakeOfflineSuccess = "campaign-take-offline-success",
+    "campaignCopyContractWarning" = "campaign-copy-contract-warning",
     campaignOrderSuccess = "campaign-order-success",
     campaignCopySuccess = "campaign-copy-success",
     buttonCopySuccess = "copy-button-success",

package/alert/types.ts

@@ -36,6 +36,8 @@ export type CampaignOrderSuccessAlertProps = {}
 
 export type CampaignCopySuccessAlertProps = {}
 
+export type DiscardedContractsDuringCampaignCopyAlertProps = {}
+
 export type CampaignTakeOfflineSuccessAlertProps = {}
 
 export type ProductAddToBasketSuccessAlertProps = {}
@@ -44,6 +46,7 @@ export type ProductRemoveFromBasketWarningAlertProps = {}
 
 export type AlertProps = AnyNonFunction<
     | ContractCreateSuccessAlertProps
+    | DiscardedContractsDuringCampaignCopyAlertProps
     | ContractRemoveSuccessAlertProps
     | ContractGroupCreateSuccessAlertProps
     | BackendErrorMessageAlertProps

package/ats/api.types.ts

@@ -1,5 +1,10 @@
 import { AxiosRequestConfig } from "axios/index"
-import { ATSSettings, ATSUserTokenResponse } from "./types"
+import {
+    ATSDataResponse,
+    ATSMessage,
+    ATSSettings,
+    ATSUserTokenResponse,
+} from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
@@ -13,6 +18,8 @@ export type WindowHapiAPIATSRequests = {
     getUserSettings: () => Promise<ATSSettings>
     refreshJWTToken: () => Promise<ATSUserTokenResponse>
     validateJWTToken: () => Promise<boolean>
+    getMessages: () => Promise<ATSMessage[]>
+    sendMessage: (ticket: ATSMessage) => Promise<ATSMessage[]>
 }
 export type WindowHapiAPIATS = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<WindowHapiAPIATSRequests, WindowHapiAPIATSConfigs>,

package/ats/service.types.ts

@@ -2,16 +2,23 @@ import {
     HapiServiceFunctionWithLifecycleHooks,
     WindowHapiService,
 } from "../_window/service.types"
-import { ATSSettings } from "./types"
+import { ATSMessage, ATSSettings } from "./types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type ATSServiceGetUserSettingsHandler = () => Promise<
     ATSSettings | undefined
 >
+export type ATSServiceGetMessagesHandler = () => Promise<ATSMessage[]>
+
+export type ATSServiceSendMessageHandler = (
+    message: ATSMessage,
+) => Promise<ATSMessage[]>
 
 export type WindowHapiServiceATS = WindowHapiModuleWithConstructorArgs<
     {
         getUserSettings: HapiServiceFunctionWithLifecycleHooks<ATSServiceGetUserSettingsHandler>
+        getMessages: HapiServiceFunctionWithLifecycleHooks<ATSServiceGetMessagesHandler>
+        sendMessage: HapiServiceFunctionWithLifecycleHooks<ATSServiceSendMessageHandler>
     },
     { readonly service: WindowHapiService }
 >

package/ats/types.ts

@@ -25,3 +25,17 @@ export type ATSSettings = {
 export type ATSUserTokenResponse = {
     token: string
 }
+
+export type ATSMessage = {
+    id?: string
+    sender: "ats" | "vonq"
+    createdAt?: string
+    message: string
+}
+
+export type ATSDataResponse = {
+    data: {
+        messages: ATSMessage[]
+    }
+    type: "elements"
+}

package/basket/service.types.ts

@@ -7,9 +7,9 @@ import {
 } from "../_window/service.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type BasketServiceGetProductsHandler = () => Promise<
-    (Product | Contract)[]
->
+export type BasketServiceGetProductsHandler = (
+    products?: BasketProduct[],
+) => Promise<(Product | Contract)[]>
 export type BasketServiceAddProductOrContractByIdHandler = (
     contractOrProductId: string,
     isProduct: boolean,

package/basket/utils.types.ts

@@ -12,6 +12,7 @@ import {
     getBasketProductBoardType,
     getConflictingContractsWithDifferentGroupsInBasket,
 } from "../../common/basket/utils"
+import { Campaign, CampaignCreateForm } from "../campaign"
 
 export type WindowHapiUtilsBasket = WindowHapiModuleWithConstructorArgs<
     {
@@ -41,6 +42,7 @@ export type WindowHapiUtilsBasket = WindowHapiModuleWithConstructorArgs<
             contract: Contract,
             basketProducts: (Contract | Product)[],
         ) => (Product | Contract)[]
+        getBasketProductMetaFromCampaignForm: (form: Campaign) => any[]
     },
     { readonly utils: WindowHapiUtils }
 >

package/campaign/service.types.ts

@@ -31,6 +31,7 @@ export type CampaignServiceGetSenioritiesHandler = () => Promise<
 export type CampaignServiceOrderCampaignHandler = () => Promise<Campaign>
 export type CampaignServiceCopyCampaignHandler = (
     campaign: Campaign,
+    withExistingProducts: boolean,
 ) => Promise<Campaign>
 
 export type WindowHapiServiceCampaign = WindowHapiModuleWithConstructorArgs<

package/campaign/types.ts

@@ -117,6 +117,7 @@ export type Campaign = {
     campaignName: string | null
     companyId: string
     createdOn: string
+    poNumber: string | null
     customerId: string
     orderReference: string | null
     orderedProducts: string[]
@@ -141,7 +142,7 @@ export type CampaignCreateFormTargetGroupIndustry = ProductIndustry
 
 export type CampaignCreateFormTargetGroupJobCategory = {
     label: string
-    value: number
+    value: number | string
 }
 
 export type CampaignCreateFormTargetGroup = {
@@ -162,6 +163,7 @@ export type CampaignCreateFormOrderedProductSpec =
 
 export type CampaignCreateForm = {
     companyId: string
+    currency: ProductPriceCurrency
     campaignName?: string | null
     poNumber: string | null
     paymentMethod: OrderJourneyPaymentMethod | null
@@ -215,12 +217,12 @@ export type TaxonomyEducationLevelName = CampaignTaxonomyNameWithLanguage
 export type TaxonomySeniorityName = CampaignTaxonomyNameWithLanguage
 
 export type TaxonomySeniority = {
-    id: number
+    id: number | string
     name: TaxonomySeniorityName[]
 }
 
 export type TaxonomyEducationAndSeniorityLevel = {
-    id: number
+    id: number | string
     name: TaxonomyEducationLevelName[]
 }
 

package/campaign/utils.types.ts

@@ -26,9 +26,7 @@ export type WindowHapiUtilsCampaign = WindowHapiModuleWithConstructorArgs<
             campaign: Partial<Campaign>,
         ) => void
         getOrderCampaignRequestBody: () => CampaignOrderRequestBody
-        getCopyCampaignRequestBody: (
-            campaign: Campaign,
-        ) => CampaignOrderRequestBody
+        getCopyCampaignRequestBody: (campaign: Campaign) => CampaignCreateForm
         getPostBodyValuesForTargetGroupProperty: (
             selectValue:
                 | CampaignCreateFormTargetGroupEducationLevel[]

package/campaign/validations.types.ts

@@ -87,13 +87,13 @@ export type ZodCampaignTaxonomyNameWithLanguage = ZodObject<{
     value: ZodString
 }>
 export type ZodCampaignTaxonomyEducationLevel = ZodObject<{
-    id: ZodNumber
+    id: ZodUnion<[ZodNumber, ZodString]>
     name: ZodArray<ZodCampaignTaxonomyNameWithLanguage>
 }>
 export type ZodCampaignTaxonomyEducationLevels =
     ZodArray<ZodCampaignTaxonomyEducationLevel>
 export type ZodCampaignTaxonomySeniority = ZodObject<{
-    id: ZodNumber
+    id: ZodUnion<[ZodNumber, ZodString]>
     name: ZodArray<ZodCampaignTaxonomyNameWithLanguage>
 }>
 export type ZodCampaignTaxonomySeniorities =
@@ -165,11 +165,13 @@ export type ZodCampaignCreateFormPostingDetails = ZodObject<{
 export type ZodCampaignCreateFormTargetGroup = ZodObject<{
     educationLevel: ZodCampaignTaxonomyEducationLevels
     seniority: ZodCampaignTaxonomySeniorities
-    industry: ZodArray<ZodObject<{ id: ZodNumber; name: ZodString }>>
+    industry: ZodArray<
+        ZodObject<{ id: ZodUnion<[ZodNumber, ZodString]>; name: ZodString }>
+    >
     jobCategory: ZodArray<
         ZodObject<{
             label: ZodString
-            value: ZodNumber
+            value: ZodUnion<[ZodNumber, ZodString]>
         }>
     >
 }>

package/common/events/EventCommand/enums.ts

@@ -1,6 +1,5 @@
 export enum WindowHapiEventCommandName {
     /* State */
-    stateLoad = "state:load",
     stateHydrate = "state:hydrate",
 
     /* Service */
@@ -14,11 +13,13 @@ export enum WindowHapiEventCommandName {
 
     /* Config */
     configSetPartnerId = "config:partnerId",
+    configSetPartnerToken = "config:partnerToken", // used for impersonation purposes
     configSetClientId = "config:clientId",
     configSetAreLogsEnabled = "config:areLogsEnabled",
 
     /* App */
     appLoad = "app:load",
+    appReady = "app:ready",
 
     /* API */
     apiRequest = "api:request",

package/common/events/types.ts

@@ -36,7 +36,7 @@ export type WindowHapiEventCommand = {
 
 export type WindowHapiEventCommandCallbackHandler = (
     data: any,
-    event: WindowHapiEventCommand,
+    event: WindowHapiEventCommand | WindowHapiEventListener,
 ) => void
 export type WindowHapiEventCommandCommitHandler = (
     ...args: any[]

package/contract/types.ts

@@ -5,13 +5,15 @@ export type ContractProduct = {
     title: string
 }
 
+export type ContractCredentialOption = { key: string; label: string }
+
 export type ContractCredential = {
     description?: string | null
     label: string
     name: string
     sort: string
     url: string | null
-    options: any[] | null
+    options: ContractCredentialOption[] | null
 }
 
 export type ContractFacet = {}

package/modal/enums.ts

@@ -9,6 +9,7 @@ export enum ModalKeys {
     productInfo = "product-info",
     campaignTakeOfflineConfirmation = "campaign-confirm-take-offline",
     campaignCopyConfirmation = "campaign-confirm-copy",
+    campaignCopySelection = "contract-copy-selection",
     basketRemoveProductConfirmation = "remove-product-from-basket",
     contractRemoveConfirmation = "contract-remove-confirmation",
     contractGroupConflictInfo = "contract-group-conflict-info",

package/modal/types.ts

@@ -2,7 +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"
+import { Campaign, TransformedPostingRequirement } from "../campaign"
 
 export type ProductDetailModalProps = {
     id: string
@@ -17,6 +17,10 @@ export type ContractGroupConflictInfoModalProps = {
     contract: Contract
     conflictingContracts: Contract[]
 }
+export type CampaignCopySelectionModalProps = {
+    products: (Product | Contract)[]
+    campaign: Campaign
+}
 export type ContractPostingRequirementsSmartFillResponseModalProps = {
     response: Record<string, any>
     postingRequirements: Record<string, TransformedPostingRequirement>
@@ -45,6 +49,7 @@ export type ModalProps = AnyNonFunction<
 
 export type ModalOptions = {
     showCloseButton?: boolean
+    showBottomCloseButton?: boolean
     showBackdrop?: boolean
     unstyled?: boolean
     disableVerticalScroll?: boolean

package/orderJourney/enums.ts

@@ -19,7 +19,7 @@ export enum OrderJourneyStepKey {
 }
 
 export enum OrderJourneyPaymentMethod {
-    atsManaged = "ats-managed",
+    atsManaged = "ats_managed",
     wallet = "wallet",
     purchaseOrder = "purchase_order",
 }

package/orderJourney/state.types.ts

@@ -82,7 +82,6 @@ export type OrderJourneyState = {
         string,
         Record<string, MessageDescriptor>
     >
-    contractStepsHideFields: Record<string, boolean>
     contractStepsValidators: Record<string, Record<string, NestedValidatorKeys>>
     contractStepsData: Record<string, Record<string, any>>
     contractStepsValidations: Record<string, UseValidatorResult> | null

package/orderJourney/types.ts

@@ -16,10 +16,6 @@ export type OrderJourneyStepErrorMessages = {
         | Record<string, MessageDescriptor | OrderJourneyStepErrorMessage>
 }
 
-export type OrderJourneyStepHideFields = {
-    [k: string]: boolean | Record<string, boolean | OrderJourneyStepHideFields>
-}
-
 export type OrderJourneyStepKeyType = OrderJourneyStepKey | string
 export type OrderJourneyStep = {
     key: OrderJourneyStepKeyType
@@ -28,7 +24,6 @@ export type OrderJourneyStep = {
     isSubmitted?: boolean
     blurredFields?: OrderJourneyStepBlurredFields
     errorMessagesIntlDescriptors?: OrderJourneyStepErrorMessages
-    hideFields?: OrderJourneyStepHideFields
 }
 
 export type OrderJourneyContractStep = Omit<

package/orderJourney/utils.types.ts

@@ -3,11 +3,13 @@ import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 import { Contract } from "../contract"
 import { Product } from "../product"
+import { orderJourneyGetContractIdFromContractStepKey } from "../../common/orderJourney/utils"
 
 export type WindowHapiUtilsOrderJourney = WindowHapiModuleWithConstructorArgs<
     {
         stepKeys: typeof OrderJourneyStepKey
         paymentMethodKeys: typeof OrderJourneyPaymentMethod
+        orderJourneyGetContractIdFromContractStepKey: (key: string) => string
         updateProductUTMsFromBasketItemData: (
             basketItemData: (Contract | Product)[],
         ) => void

package/package.json

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

package/product/types.ts

@@ -8,7 +8,7 @@ import {
 export type ProductRange = "hours" | "days" | "weeks" | "months"
 
 export type ProductIndustry = {
-    id: number
+    id: number | string
     name: string
 }
 

package/product/validations.types.ts

@@ -7,6 +7,7 @@ import {
     ZodObject,
     ZodOptional,
     ZodString,
+    ZodUnion,
 } from "zod"
 import { ProductPriceCurrency } from "./enums"
 import { ZodPaginationResponseV1 } from "../common/validations.types"
@@ -30,7 +31,7 @@ export type ZodProductDuration = ZodObject<{
 }>
 
 export type ZodProductIndustry = ZodObject<{
-    id: ZodNumber
+    id: ZodUnion<[ZodNumber, ZodString]>
     name: ZodString
 }>
 export type ZodProductIndustries = ZodArray<ZodProductIndustry>

package/theming/types.ts

@@ -84,6 +84,7 @@ export type HapiThemeRule =
     | "loadingSpinner"
     | "userJourneyBar"
     | "card"
+    | "productCard"
     | "tabHeaders"
     | "tabHeader"
     | "tabPanels"