@vonq/hapi-elements-types 1.30.0 → 1.32.0

package/alert/service.types.ts

@@ -9,6 +9,7 @@ export type WindowHapiServiceAlert = WindowHapiModuleWithConstructorArgs<
             key: AlertKey,
             props: any | undefined,
             options: AlertOptions,
+            id: string,
         ) => void
         hide: (key: AlertKey) => void
     },

package/alert/types.ts

@@ -68,6 +68,7 @@ export type AlertProps = AnyNonFunction<
 >
 
 export type Alert = {
+    id: string
     key: AlertKey
     props: AlertProps | undefined
     options: AlertOptions

package/basket/state.types.ts

@@ -12,6 +12,7 @@ export type BasketState = {
     totalInWalletCurrency: number
     totalExceedsMaxPurchaseOrder: boolean
     productsAreLoading: boolean
+    productIdsBeingAdded: (string | number)[]
     deliveryAndProcessingTimes: ProductOrderDeliveryTime | null
     deliveryAndProcessingTimesAreLoading: boolean
 }

package/campaign/qa.types.ts

@@ -4,7 +4,7 @@ import { CampaignCreateForm } from "./types"
 
 export type WindowHapiQACampaign = WindowHapiModuleWithConstructorArgs<
     {
-        useMockCampaignForm: () => CampaignCreateForm
+        useMockCampaignForm: () => Promise<CampaignCreateForm>
         getRandomCampaignId: () => Promise<string>
         setCampaignFormDebuggerIsShown: (isEnabled: boolean) => boolean
         setCampaignCardDebuggerIsShown: (isEnabled: boolean) => boolean

package/campaign/state.types.ts

@@ -1,6 +1,7 @@
 import {
     Campaign,
     CampaignCreateForm,
+    CampaignCreateFormDraft,
     CampaignEditForm,
     TaxonomyEducationAndSeniorityLevel,
     TaxonomyEmploymentTypes,
@@ -14,6 +15,7 @@ export type CampaignState = {
     campaignsPaginationMeta: PaginationResponseV2
     campaignsAreLoading: boolean
     campaignForm: CampaignCreateForm | CampaignEditForm
+    campaignFormDraft: CampaignCreateFormDraft | null
     campaignIsCreating: boolean
     /* Education Levels */
     educationLevels: TaxonomyEducationAndSeniorityLevel[]

package/campaign/types.ts

@@ -46,11 +46,11 @@ export type CampaignPostingDetailsOrganization = {
 export type CampaignProductPostingDetailsSalaryIndicationRange = {
     currency?: string | null
     from?: number | null
-    to: number
+    to?: number | null
 }
 
 export type CampaignPostingDetailsSalaryIndication = {
-    period: SalaryPeriod
+    period: SalaryPeriod | null
     range: CampaignProductPostingDetailsSalaryIndicationRange
 }
 
@@ -76,7 +76,7 @@ export type CampaignPostingDetails = {
     employmentType: EmploymentType
     jobPageUrl: string
     organization: CampaignPostingDetailsOrganization
-    salaryIndication: CampaignPostingDetailsSalaryIndication
+    salaryIndication: CampaignPostingDetailsSalaryIndication | null
     title: string
     weeklyWorkingHours: CampaignPostingDetailsWeeklyWorkingHours
     workingLocation: CampaignPostingDetailsWorkingLocation
@@ -130,6 +130,14 @@ export type CampaignDetailedStatus = {
     orderedProductsStatuses: CampaignDetailsStatusOrderedProductStatus[]
 }
 
+export type CampaignDraftOldBackwardsCompatability = {
+    // there is a recipe /docs/recipes/order-journey-campaign-recipes/campaign-order-success-event/
+    // it says if payment method is direct-charge, BE returns `draftCampaignId` instead of `campaignId`
+    // during migration from PKB-drafts to non-PKB drafts, I think this got removed
+    // HE should continue to support it
+    draftCampaignId?: string
+}
+
 export type CampaignDraft = {
     campaignId: string
     isDraft: boolean
@@ -146,6 +154,7 @@ export type CampaignDraftV2 = {
 }
 
 export type Campaign = Pick<CampaignDraft, "campaignId"> &
+    CampaignDraftOldBackwardsCompatability &
     CampaignDraftV2 & {
         labels: Record<string, string> | null
         currency: ProductPriceCurrency
@@ -207,7 +216,7 @@ export type CampaignCreateFormPostingDetails = {
     yearsOfExperience: number
     employmentType: EmploymentType
     weeklyWorkingHours: CampaignPostingDetailsWeeklyWorkingHours
-    salaryIndication: CampaignPostingDetailsSalaryIndication
+    salaryIndication: CampaignPostingDetailsSalaryIndication | null
     contactInfo: CampaignPostingDetailsContactInfo | null
     jobPageUrl: string
     applicationUrl: string
@@ -230,6 +239,9 @@ export type CampaignCreateForm = {
     heStateSnapshotId?: string
 }
 
+export type CampaignCreateFormDraft = CampaignCreateForm &
+    Pick<Campaign, "campaignId">
+
 export type CampaignEditForm = Omit<
     CampaignCreateForm,
     | "companyId"

package/campaign/validations.types.ts

@@ -54,14 +54,16 @@ export type ZodCampaignPostingDetailsOrganization = ZodObject<{
     companyLogo: ZodString
     name: ZodString
 }>
-export type ZodCampaignPostingDetailsSalaryIndication = ZodObject<{
-    period: ZodString
-    range: ZodObject<{
-        currency: ZodOptional<ZodNullable<ZodString>>
-        from: ZodOptional<ZodNullable<ZodNumber>>
-        to: ZodNumber
+export type ZodCampaignPostingDetailsSalaryIndication = ZodNullable<
+    ZodObject<{
+        period: ZodOptional<ZodNullable<ZodString>>
+        range: ZodObject<{
+            currency: ZodOptional<ZodNullable<ZodString>>
+            from: ZodOptional<ZodNullable<ZodNumber>>
+            to: ZodOptional<ZodNullable<ZodNumber>>
+        }>
     }>
-}>
+>
 export type ZodCampaignPostingDetailsWeeklyWorkingHours = ZodObject<{
     from: ZodOptional<ZodNullable<ZodNumber>>
     to: ZodNumber
@@ -193,7 +195,7 @@ export type ZodCampaignCreateFormTargetGroup = ZodObject<{
         }>
     >
 }>
-export type ZodCampaignCreateForm = ZodObject<{
+export type ZodCampaignCreateFormRaw = {
     labels: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>
     companyId: ZodString
     campaignName: ZodOptional<ZodNullable<ZodString>>
@@ -206,7 +208,16 @@ export type ZodCampaignCreateForm = ZodObject<{
     postingDetails: ZodCampaignCreateFormPostingDetails
     orderedProductsSpecs: ZodCampaignCreateFormOrderedProductSpecs
     orderedProducts: ZodArray<ZodString>
-}>
+}
+export type ZodCampaignCreateForm = ZodObject<ZodCampaignCreateFormRaw>
+export type ZodCampaignCampaignIdRaw = {
+    campaignId: ZodString
+}
+export type ZodCampaignCreateFormDraftPartials =
+    ZodObject<ZodCampaignCampaignIdRaw>
+export type ZodCampaignCreateFormDraft = ZodNullable<
+    ZodObject<ZodCampaignCreateFormRaw & ZodCampaignCampaignIdRaw>
+>
 export type WindowHapiValidationsCampaign = {
     status: string[]
     draftStatus: CampaignDraftStatus[]
@@ -241,6 +252,8 @@ export type WindowHapiValidationsCampaign = {
     campaign: ZodCampaign
     campaigns: ZodCampaigns
     campaignForm: ZodCampaignCreateForm
+    campaignFormDraft: ZodCampaignCreateFormDraft
+    campaignFormDraftPartials: ZodCampaignCreateFormDraftPartials
     campaignFormTargetGroup: ZodCampaignCreateFormTargetGroup
     campaignFormPostingDetails: ZodCampaignCreateFormPostingDetails
     campaignFormOrderedProductsSpecs: ZodCampaignCreateFormOrderedProductSpecs

package/common/types.ts

@@ -82,12 +82,13 @@ export type ValidatorKey =
           | "isPostalCodeLocales"
       >
     | keyof Validators
+export type ValidatorKeyMap = {
+    [k: string]: ValidatorKey | NestedValidatorKeys
+}
 export type NestedValidatorKeys =
     | ValidatorKey
     | ValidatorKey[]
-    | {
-          [k: string]: ValidatorKey | NestedValidatorKeys
-      }
+    | ValidatorKeyMap
 export type BaseService = {
     logger: WindowHapiLogger
 }

package/common/validations.types.ts

@@ -13,6 +13,7 @@ import {
     ZodUnion,
     ZodUnknown,
 } from "zod"
+import { Validators } from "./validator"
 
 export type ZodIntlDescriptor = ZodObject<{
     id: ZodString
@@ -55,7 +56,6 @@ export type ZodPaginationResponseV2 = ZodObject<
     } & ZodPaginationLimitOffsetDefinition
 >
 export type WindowHapiValidationsCommon = {
-    isURL: (url: string) => boolean | never
     genericBoolean: ZodBoolean
     genericNumber: ZodNumber
     genericNumberArray: ZodArray<ZodNumber>
@@ -90,4 +90,4 @@ export type WindowHapiValidationsCommon = {
     url: ZodString
     apiResourceRegex: RegExp
     apiResource: ZodString
-}
+} & Validators

package/common/validator/types.ts

@@ -1,6 +1,24 @@
+export type ValidatorsIsNotEmptyHandler = (
+    value: string | Record<string, any> | any[],
+) => boolean
+
+export type ValidatorsIsNotEmptyObjectHandler = (
+    value: Object | undefined | null,
+) => boolean
+
+export type ValidatorsIsNotZeroHandler = (value: number) => boolean
+
+export type ValidatorsIsHandledByBackendHandler = (value: any) => false
+
+export type ValidatorsIsURLHandler = (value: string) => boolean
+
+export type ValidatorsIsRegExpHandler = (value: string) => boolean
+
 export type Validators = {
-    isNotEmpty: (value: string | Record<string, any> | any[]) => boolean
-    isNotEmptyObject: (value: Object | undefined | null) => boolean
-    isNotZero: (value: number) => boolean
-    isHandledByBackend: (value: any) => false
+    isNotEmpty: ValidatorsIsNotEmptyHandler
+    isNotEmptyObject: ValidatorsIsNotEmptyObjectHandler
+    isNotZero: ValidatorsIsNotZeroHandler
+    isHandledByBackend: ValidatorsIsHandledByBackendHandler
+    isURL: ValidatorsIsURLHandler
+    isRegExp: ValidatorsIsRegExpHandler
 }

package/language/service.types.ts

@@ -2,6 +2,8 @@ import { WindowHapiService } from "../_window/service.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiServiceLanguage = WindowHapiModuleWithConstructorArgs<
-    {},
+    {
+        resetAndRefreshTaxonomies: () => void
+    },
     { readonly service: WindowHapiService }
 >

package/orderJourney/state.types.ts

@@ -83,6 +83,7 @@ export type OrderJourneyState = {
     /* Posting Details */
     postingDetailsStep: OrderJourneyStep
     postingDetailsStepData: Record<string, any>
+    postingDetailsStepValidators: NestedValidatorKeys
     postingDetailsStepValidations: UseValidatorResult
     /* Organization */
     organizationStep: OrderJourneyStep

package/package.json

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

package/theming/types.ts

@@ -168,6 +168,7 @@ export type HapiThemeRule =
     | "headingFive"
     | "headingSix"
     | "alert"
+    | "alertProgressBar"
 
 export type HapiThemeComponentVariant =
     | "primary"