@vonq/hapi-elements-types 1.43.0 → 1.45.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/_window/window.ts

@@ -168,6 +168,11 @@ export type WindowHapiClassInterface = {
     logDeprecationNotice: () => void
     logLatestTypesPackageVersion: () => Promise<void>
     logFeatureBranches: () => Promise<void>
+    querySelectorAllThatAlsoSearchesShadowDOM: (
+        node: Element | ShadowRoot | Document,
+        selector: string,
+    ) => Element[]
+    querySelectorThatAlsoSearchesShadowDOM: (selector: string) => Element
 }
 
 export type WindowHapi = {

package/alert/enums.ts

@@ -2,6 +2,8 @@ export enum AlertKey {
     backendErrorMessage = "backend-error-message",
     topupSuccess = "topup-success",
     contractRemoveSuccess = "contract-removed",
+    contractGroupRemoveSuccess = "contract-group-removed",
+    contractGroupUpdateSuccess = "contract-group-updated",
     contractCreateSuccess = "contract-created",
     contractEditSuccess = "contract-edited",
     contractGroupCreateSuccess = "contract-group-created",

package/alert/types.ts

@@ -23,6 +23,14 @@ export type ContractGroupCreateSuccessAlertProps = {
     groupName: string
 }
 
+export type ContractGroupUpdateSuccessAlertProps = {
+    groupName: string
+}
+
+export type ContractGroupRemoveSuccessAlertProps = {
+    groupName: string
+}
+
 export type BackendErrorMessageAlertProps = {
     errorMessage: string
 }

package/common/types.ts

@@ -280,6 +280,8 @@ export type FormFacetsFieldType =
     | "questionnaire"
     | "unknown"
 
+export type FormFacetsFormOfThisOrderedProductSpec = Record<string, any>
+
 // keep this for backwards compatability
 export type ContractPostingRequirementFieldAutocompleteRequestOption =
     PostingRequirementsAutocompleteRequestOption
@@ -292,3 +294,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/api.types.ts

@@ -3,8 +3,9 @@ import {
     Contract,
     ContractCreateForm,
     ContractGroup,
-    ContractGroupCreateForm,
     ContractEditForm,
+    ContractGroupCreateForm,
+    ContractGroupUpdateForm,
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
@@ -19,12 +20,15 @@ export type WindowHapiAPIContractConfigs = {
     removeContract: AxiosRequestConfig
     getPostingRequirementOptions: AxiosRequestConfig
     getGroups: AxiosRequestConfig
+    removeContractGroup: AxiosRequestConfig
+    updateContractGroup: AxiosRequestConfig
     createGroup: AxiosRequestConfig
 }
 export type WindowHapiAPIContractRequests = {
     getContracts: (
         limitOffset?: PaginationLimitOffset,
         labels?: Record<string, string> | null,
+        filters?: URLSearchParams,
     ) => Promise<PaginatedAPIResponseV1<Contract>>
     getContractsByIds: (
         contractIds: (string | number)[],
@@ -39,6 +43,11 @@ export type WindowHapiAPIContractRequests = {
         autocompleteRequestOptions: Record<string, string | string[]>,
     ) => Promise<any>
     getGroups: () => Promise<ContractGroup[]>
+    removeContractGroup: (groupIdx: number) => Promise<ContractGroup>
+    updateContractGroup: (
+        groupIdx: number,
+        group: ContractGroupUpdateForm,
+    ) => Promise<ContractGroup>
     createGroup: (group: ContractGroupCreateForm) => Promise<ContractGroup>
     removeContract: (contractId: string) => Promise<Contract>
 }

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,10 +28,15 @@ export type ContractServiceGetContractPostingRequirementOptionsHandler = (
     contractId: string,
     fieldName: string,
     autocompleteRequestOptions: PostingRequirementsAutocompleteRequestOption[],
-) => Promise<any>
+) => Promise<PostingRequirementOption[]>
 
 export type ContractServiceGetContractsHandler = (
     offset: number,
+    queryParams?: URLSearchParams,
+) => Promise<PaginatedAPIResponseV1<Contract>>
+
+export type ContractServiceGetFilteredContractsHandler = (
+    offset: number,
 ) => Promise<PaginatedAPIResponseV1<Contract>>
 
 export type ContractServiceGetContractGroupsHandler = () => Promise<
@@ -51,6 +57,15 @@ export type ContractServiceRemoveContractHandler = (
     contractId: string,
 ) => Promise<void>
 
+export type ContractServiceRemoveContractGroupHandler = (
+    groupIdx: number,
+) => Promise<void>
+
+export type ContractServiceUpdateContractGroupHandler = (
+    groupIdx: number,
+    groupName: string,
+) => Promise<void>
+
 export type ContractServiceCreateContractGroupHandler =
     () => Promise<ContractGroup>
 
@@ -96,6 +111,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: (
@@ -103,6 +126,7 @@ export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
             previousModals: Modals,
         ) => void
         getContractPostingRequirementOptions: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractPostingRequirementOptionsHandler>
+        getFilteredContracts: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetFilteredContractsHandler>
         getContractsLabeled: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractsLabeledHandler>
         getContracts: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractsHandler>
         getContractGroups: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractGroupsHandler>
@@ -115,6 +139,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/state.types.ts

@@ -26,6 +26,11 @@ export type ContractState = {
     groupsAreLoading: boolean
     groupIsCreating: boolean
     groupCreateError: string | null
+    groupUpdateError: string | null
     groupForm: ContractGroupCreateForm
+    groupUpdateNameInput: string
     groupFormIsValid: boolean
+    filterChannelName: string
+    filterGroupId: string
+    filtersAccordionIsOpen: boolean
 }

package/contract/types.ts

@@ -3,6 +3,8 @@ import {
     Facet,
     PostingRequirement,
     PostingRequirementLabelsMap,
+    PostingRequirementsAutocompleteRequestOption,
+    StringifiedJSON,
 } from "../common"
 import {
     ContractDirectApplyPostingRequirementQuestionnaireLengthRule,
@@ -35,6 +37,8 @@ export type ContractPurchasePrice = {
 
 export type ContractCreateFormCredentials = Record<string, string>
 
+export type ContractCreateCredentialsValidation = "if_supported"
+
 export type ContractCreateForm = {
     id?: number | string
     credentials?: ContractCreateFormCredentials
@@ -48,6 +52,7 @@ export type ContractCreateForm = {
     allow_renegotiation: boolean
     labels: Record<string, string> | null
     posting_requirements_defaults: Record<string, string | string[]> | null
+    credentials_validation?: ContractCreateCredentialsValidation
 }
 
 export type ContractEditForm = ContractCreateForm
@@ -56,6 +61,10 @@ export type ContractGroupCreateForm = {
     name: string
 }
 
+export type ContractGroupUpdateForm = {
+    name: string
+}
+
 export type ContractChannel = ProductLogos &
     ProductType & {
         allows_edit?: boolean
@@ -254,3 +263,22 @@ 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
+    lastAccessedDate: string
+}
+export type ContractProductsSupportingContractsMap = Map<
+    StringifiedJSON<ContractPostingRequirementsOptionsPayload>,
+    ContractPostingRequirementsOptionsMapState
+>
+export type ContractFilterQueryParams = {
+    filterChannelName: string
+    filterGroupId: string
+}

package/contract/utils.types.ts

@@ -3,6 +3,7 @@ import {
     ContractDirectApplyChannelPrefillVariablesMap,
     ContractCreateForm,
     ContractGroupCreateForm,
+    ContractFilterQueryParams,
 } from "./types"
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
@@ -10,6 +11,7 @@ import {
     ContractDirectApplyChannelName,
     ContractDirectApplyPostingRequirementQuestionnaireValidationWarningCode,
 } from "./enums"
+import { PaginationResponseV1 } from "types/common"
 
 export type WindowHapiUtilsContract = WindowHapiModuleWithConstructorArgs<
     {
@@ -21,6 +23,9 @@ export type WindowHapiUtilsContract = WindowHapiModuleWithConstructorArgs<
         directApplyIgnoreReasonWarning: typeof ContractDirectApplyPostingRequirementQuestionnaireValidationWarningCode
         getInitialContractForm: () => ContractCreateForm
         getInitialGroupForm: () => ContractGroupCreateForm
+        getContractsQueryParams: (
+            params: Partial<ContractFilterQueryParams>,
+        ) => URLSearchParams
         getContractNameWithGroupSuffix: (contract: Contract) => string
     },
     { readonly utils: WindowHapiUtils }

package/modal/enums.ts

@@ -18,6 +18,8 @@ export enum ModalKeys {
     basketProductBundleParentClashConfirmation = "basket-product-bundle-parent-clash-confirmation",
     basketProductBundleChildClashConfirmation = "basket-product-bundle-child-clash-confirmation",
     contractRemoveConfirmation = "contract-remove-confirmation",
+    contractGroupRemoveConfirmation = "contract-group-remove-confirmation",
+    contractGroupUpdateConfirmation = "contract-group-update-confirmation",
     contractEdit = "contract-edit",
     contractGroupConflictInfo = "contract-group-conflict-info",
     filePicker = "file-picker",

package/modal/types.ts

@@ -28,6 +28,10 @@ export type CampaignProductTakeOfflineConfirmationModalProps = {
     productId: string
 }
 export type ContractRemoveConfirmationModalProps = { contractId: string }
+export type ContractGroupRemoveConfirmationModalProps = {
+    groupId: string
+    groupIdx: number
+}
 export type ContractEditJourneyModalProps = { contractId: string }
 export type ContractGroupConflictInfoModalProps = {
     contract: Contract

package/modal/utils.types.ts

@@ -1,12 +1,13 @@
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
-import { ModalKeys } from "./enums"
+import { ModalKeys, ModalZone } from "./enums"
 import { Modals } from "./types"
 
 export type WindowHapiUtilsModal = WindowHapiModuleWithConstructorArgs<
     {
         modalKeys: typeof ModalKeys
         getIsModalOpen: (key: ModalKeys, modals: Modals) => boolean
+        getZoneOfOpenModal: (key: ModalKeys, modals: Modals) => ModalZone | null
     },
     { readonly utils: WindowHapiUtils }
 >

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@vonq/hapi-elements-types",
-  "version": "1.43.0",
+  "version": "1.45.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,17 @@ 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
+    lastAccessedDate: string
+}
+export type ProductProductsSupportingContractsMap = Map<
+    StringifiedJSON<ProductProductsSupportingContractsPayload>,
+    ProductProductsSupportingContractsMapState
+>