@vonq/hapi-elements-types 1.43.0 → 1.44.0

package/_window/state.types.ts

@@ -27,16 +27,24 @@ import { WindowHapiValidationsOrderJourney } from "../orderJourney/validations.t
 import { WindowHapiValidationsWallet } from "../wallet/validations.types"
 import { WindowHapiValidations } from "./validation.types"
 import { ExperimentalState } from "../experimental/state.types"
+import { ProductCacheState } from "../product/state.cache.types"
+import { ContractCacheState } from "../contract/state.cache.types"
 
 export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
     {
         [WindowHapiModuleName.alert]: WindowHapiStateModule<AlertState>
         [WindowHapiModuleName.basket]: WindowHapiStateModule<BasketState>
         [WindowHapiModuleName.campaign]: WindowHapiStateModule<CampaignState>
-        [WindowHapiModuleName.contract]: WindowHapiStateModule<ContractState>
+        [WindowHapiModuleName.contract]: WindowHapiStateModule<
+            ContractState,
+            ContractCacheState
+        >
         [WindowHapiModuleName.debugging]: WindowHapiStateModule<DebuggingState>
         [WindowHapiModuleName.language]: WindowHapiStateModule<LanguageState>
-        [WindowHapiModuleName.product]: WindowHapiStateModule<ProductState>
+        [WindowHapiModuleName.product]: WindowHapiStateModule<
+            ProductState,
+            ProductCacheState
+        >
         [WindowHapiModuleName.theming]: WindowHapiStateModule<ThemingState>
         [WindowHapiModuleName.orderJourney]: WindowHapiStateModule<OrderJourneyState>
         [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
@@ -56,10 +64,16 @@ export type WindowHapiState = WindowHapiModuleWithConstructorArgs<
             [WindowHapiModuleName.alert]: WindowHapiStateModule<AlertState>
             [WindowHapiModuleName.basket]: WindowHapiStateModule<BasketState>
             [WindowHapiModuleName.campaign]: WindowHapiStateModule<CampaignState>
-            [WindowHapiModuleName.contract]: WindowHapiStateModule<ContractState>
+            [WindowHapiModuleName.contract]: WindowHapiStateModule<
+                ContractState,
+                ContractCacheState
+            >
             [WindowHapiModuleName.debugging]: WindowHapiStateModule<DebuggingState>
             [WindowHapiModuleName.language]: WindowHapiStateModule<LanguageState>
-            [WindowHapiModuleName.product]: WindowHapiStateModule<ProductState>
+            [WindowHapiModuleName.product]: WindowHapiStateModule<
+                ProductState,
+                ProductCacheState
+            >
             [WindowHapiModuleName.theming]: WindowHapiStateModule<ThemingState>
             [WindowHapiModuleName.orderJourney]: WindowHapiStateModule<OrderJourneyState>
             [WindowHapiModuleName.wallet]: WindowHapiStateModule<WalletState>
@@ -91,12 +105,13 @@ export type WindowHapiStatesJSON = {
     [WindowHapiModuleName.experimental]: ExperimentalState
 }
 
-export type WindowHapiStateBase<T> = {
+export type WindowHapiStateBase<T, CacheType = undefined> = {
     propertiesThatShouldNotBeDocumented: string[]
     __elementsStateModuleName: string
     toJSON: any
     addClassPropertiesObserver: () => void
     validations: StateValidations<T>
+    cache: WindowHapiStateModule<CacheType> | undefined
 }
 
 export type HapiStateValueWithListener<T> = {
@@ -104,7 +119,10 @@ export type HapiStateValueWithListener<T> = {
     value: T
 }
 
-export type WindowHapiStateModule<T> = WindowHapiStateBase<T> & {
+export type WindowHapiStateModule<
+    T,
+    CacheType = undefined,
+> = WindowHapiStateBase<T, CacheType> & {
     [P in keyof T]:
         | T[P]
         | HapiStateValueWithListener<T[P]>

package/common/types.ts

@@ -292,3 +292,5 @@ export type HapiFeatureBranch = {
     releaseDate: string
 }
 export type FlattenedItem = { label: string; value: any }
+
+export type StringifiedJSON<T> = string

package/common/validations.types.ts

@@ -3,6 +3,7 @@ import {
     ZodArray,
     ZodBoolean,
     ZodFunction,
+    ZodMap,
     ZodNullable,
     ZodNumber,
     ZodObject,
@@ -63,6 +64,7 @@ export type WindowHapiValidationsCommon = {
     genericString: ZodString
     genericStringArray: ZodArray<ZodString>
     genericObject: ZodObject<any>
+    genericMap: ZodMap<any, any>
     genericRecordFunction: ZodRecord<
         ZodString,
         ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>

package/contract/service.types.ts

@@ -5,8 +5,8 @@ import {
 import { OrderJourneyStepKey } from "../orderJourney/enums"
 import {
     Contract,
-    ContractDirectApplyChannelPrefillVariablesMap,
     ContractCredential,
+    ContractDirectApplyChannelPrefillVariablesMap,
     ContractGroup,
     ContractDirectApplyPostingRequirementQuestionnaireQuestionBody,
     ContractDirectApplyPostingRequirementQuestionnaireRules,
@@ -14,6 +14,7 @@ import {
 } from "./types"
 import {
     PaginatedAPIResponseV1,
+    PostingRequirementOption,
     PostingRequirementsAutocompleteRequestOption,
     TransformedPostingRequirement,
 } from "../common/types"
@@ -27,7 +28,7 @@ export type ContractServiceGetContractPostingRequirementOptionsHandler = (
     contractId: string,
     fieldName: string,
     autocompleteRequestOptions: PostingRequirementsAutocompleteRequestOption[],
-) => Promise<any>
+) => Promise<PostingRequirementOption[]>
 
 export type ContractServiceGetContractsHandler = (
     offset: number,
@@ -96,6 +97,14 @@ export type ContractServiceGetContractChannelPostingRequirementQuestionnaireRule
         channelName: ContractDirectApplyChannelName,
     ) => Promise<ContractServiceGetContractChannelPostingRequirementQuestionnaireRulesForDirectApplyResponse>
 
+export type ContractServiceGetContractPostingRequirementOptionsFromCacheOrAPIHandler =
+    (
+        contractId: string,
+        fieldName: string,
+        autocompleteRequestOptions: PostingRequirementsAutocompleteRequestOption[],
+        forceRefresh?: boolean,
+    ) => Promise<PostingRequirementOption[]>
+
 export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
     {
         onAfterContractEditModalOpenClose: (
@@ -115,6 +124,7 @@ export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
         getContractChannelPostingRequirementQuestionnaireBodyForDirectApply: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractChannelPostingRequirementQuestionnaireBodyForDirectApplyHandler>
         getContractChannelPostingRequirementQuestionnaireRulesForDirectApply: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractChannelPostingRequirementQuestionnaireRulesForDirectApplyHandler>
         setContractChannelPostingRequirementQuestionnaireOptionsDirectApply: HapiServiceFunctionWithLifecycleHooks<ContractServiceSetContractChannelPostingRequirementQuestionnaireOptionsDirectApplyHandler>
+        getContractPostingRequirementOptionsFromCacheOrAPI: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractPostingRequirementOptionsFromCacheOrAPIHandler>
         initiateOauthLogin: (
             contractId: string | number,
             orderJourneyStepActive: OrderJourneyStepKey,

package/contract/state.cache.types.ts

@@ -0,0 +1,5 @@
+import { ContractProductsSupportingContractsMap } from "./types"
+
+export type ContractCacheState = {
+    postingRequirementOptionsMap: ContractProductsSupportingContractsMap
+}

package/contract/types.ts

@@ -3,6 +3,8 @@ import {
     Facet,
     PostingRequirement,
     PostingRequirementLabelsMap,
+    PostingRequirementsAutocompleteRequestOption,
+    StringifiedJSON,
 } from "../common"
 import {
     ContractDirectApplyPostingRequirementQuestionnaireLengthRule,
@@ -254,3 +256,17 @@ export type ContractDirectApplyPostingRequirementQuestionnaireQuestionAnswerIgno
         answer: ContractDirectApplyPostingRequirementQuestionnaireClosedQuestionAnswer
         ignoreReasons: ContractDirectApplyPostingRequirementQuestionnaireQuestionValidationError[]
     }
+
+export type ContractPostingRequirementsOptionsPayload = [
+    string | number, // argument 1 of fn ContractServiceGetContractPostingRequirementOptionsFromCacheOrAPIHandler
+    string, // argument 2 of fn ContractServiceGetContractPostingRequirementOptionsFromCacheOrAPIHandler
+    PostingRequirementsAutocompleteRequestOption[], // argument 3 of fn ContractServiceGetContractPostingRequirementOptionsFromCacheOrAPIHandler
+]
+export type ContractPostingRequirementsOptionsMapState = {
+    isLoading: boolean
+    data: any | null
+}
+export type ContractProductsSupportingContractsMap = Map<
+    StringifiedJSON<ContractPostingRequirementsOptionsPayload>,
+    ContractPostingRequirementsOptionsMapState
+>

package/package.json

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

package/product/service.types.ts

@@ -67,6 +67,11 @@ export type ProductServiceSetArbitraryJobTitle = (
     shouldResetJobFunctionsIds?: boolean,
 ) => void
 
+export type ProductServiceGetProductSupportingContractsFromCacheOrAPIHandler = (
+    id: string | number,
+    forceRefresh?: boolean,
+) => Promise<ProductSupportingContractsComplete | undefined>
+
 export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
     {
         loadMoreProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceLoadMoreProductsHandler>
@@ -83,6 +88,7 @@ export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
         getJobTitles: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetJobTitlesHandler>
         getJobFunctions: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetJobFunctionsHandler>
         getIndustries: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetIndustriesHandler>
+        getProductSupportingContractsFromCacheOrAPI: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductSupportingContractsFromCacheOrAPIHandler>
     },
     { readonly service: WindowHapiService }
 >

package/product/state.cache.types.ts

@@ -0,0 +1,5 @@
+import { ProductProductsSupportingContractsMap } from "./types"
+
+export type ProductCacheState = {
+    productsSupportingContractsMap: ProductProductsSupportingContractsMap
+}

package/product/types.ts

@@ -4,12 +4,8 @@ import {
     ProductSortBy,
     ProductTypeFilterBy,
 } from "./enums"
-import { ContractCredential, ContractDetails } from "../contract/types"
-import {
-    Facet,
-    PostingRequirement,
-    PostingRequirementLabelsMap,
-} from "../common"
+import { ContractDetails } from "../contract/types"
+import { StringifiedJSON } from "../common"
 
 export type ProductRange = "hours" | "days" | "weeks" | "months"
 
@@ -171,3 +167,16 @@ export type ProductUserProvidedFilters = Omit<
     ProductFilterQueryParams,
     "filterProductRecommendations" | "filterMyContractSupportedOnly"
 >
+
+export type ProductProductsSupportingContractsPayload = [
+    string | number, // argument 1 of fn ProductServiceGetProductSupportingContractsFromCacheOrAPIHandler
+]
+
+export type ProductProductsSupportingContractsMapState = {
+    isLoading: boolean
+    data: ProductSupportingContractsComplete | null
+}
+export type ProductProductsSupportingContractsMap = Map<
+    StringifiedJSON<ProductProductsSupportingContractsPayload>,
+    ProductProductsSupportingContractsMapState
+>