@vonq/hapi-elements-types 1.23.0 → 1.25.0

package/_window/qa.types.ts

@@ -26,6 +26,7 @@ export type WindowHapiQA = WindowHapiModuleWithConstructorArgs<
         getDebugPanelButtonEl: () => HTMLElement | null
         onClickDebugPanel: () => void
         addDebugPanelToDOM: () => void
+        removeDebugPanelFromDOM: () => void
         setDebugPanelPosition: (buttonEl: HTMLElement | null) => void
     },
     { readonly core: WindowHapiClassInterface }

package/_window/ui.types.ts

@@ -3,10 +3,17 @@ import {
     WindowHapiClassInterface,
 } from "./window"
 
+export type WindowHapiUIElementNameForAddingToBody =
+    | "he-ui-modals"
+    | "he-ui-alertbar"
+
 export type WindowHapiUI = WindowHapiModuleWithConstructorArgs<
     {
         addUIElementToBody: (
-            elementName: "he-ui-modals" | "he-ui-alertbar",
+            elementName: WindowHapiUIElementNameForAddingToBody,
+        ) => void
+        removeUIElementFromBody: (
+            elementName: WindowHapiUIElementNameForAddingToBody,
         ) => void
         toggleModal: () => void
         toggleAlertbar: () => void

package/_window/window.ts

@@ -5,7 +5,10 @@ import { WindowHapiInstance, WindowHapiInstances } from "./instances.types"
 import { WindowHapiRouting } from "./routing.types"
 import { WindowHapiAuth } from "./auth.types"
 import { WindowHapiEvents } from "./events.types"
-import { WindowHapiUI } from "./ui.types"
+import {
+    WindowHapiUI,
+    WindowHapiUIElementNameForAddingToBody,
+} from "./ui.types"
 import { WindowHapiAPI } from "./api.types"
 import { WindowHapiSDK } from "./sdk.types"
 import { WindowHapiService } from "./service.types"
@@ -129,6 +132,11 @@ export type WindowHapiConfigSubmodule = {
     featureBranches: HapiFeatureBranch[]
 }
 
+export type WindowPropertiesMap = {
+    windowKey: WindowHapiSubmoduleName
+    klassProperty: keyof WindowHapiClassInterface
+}
+
 export type WindowHapiClassInterface = {
     logger: WindowHapiLogger
     utils: WindowHapiUtilsSubmodule
@@ -148,6 +156,16 @@ export type WindowHapiClassInterface = {
     isReady: boolean
     enableLogs: boolean
     enableRemoteLogs: boolean
+    windowPropertiesMap: WindowPropertiesMap[]
+    uiElementsToAddToBody: WindowHapiUIElementNameForAddingToBody[]
+    attachWebComponents: () => void
+    attach: () => void
+    detach: () => void
+    bootstrap: () => Promise<void>
+    logWelcomeMessage: () => void
+    logDeprecationNotice: () => void
+    logLatestTypesPackageVersion: () => Promise<void>
+    logFeatureBranches: () => Promise<void>
 }
 
 export type WindowHapi = {
@@ -173,7 +191,9 @@ export type WindowHapiInjector = {
             key: K,
             value: WindowHapiInjectorConfig[K],
         ): WindowHapiInjectorConfig
-        inject: () => Promise<void>
+        inject: () => Promise<never | true>
+        eject: () => Promise<void>
+        reinjectForNewUser: (newToken: string) => Promise<never | true>
     }
     hapiInjectorConfig: WindowHapiInjectorConfig
 }

package/alert/index.ts.bak

@@ -1,6 +1,6 @@
 // created from 'create-ts-index'
 
-export * from "./enums"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
+export * from './enums';
+export * from './service.types';
+export * from './state.types';
+export * from './types';

package/ats/index.ts.bak

@@ -1,6 +1,6 @@
 // created from 'create-ts-index'
 
-export * from "./api.types"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
+export * from './api.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';

package/basket/index.ts.bak

@@ -1,7 +1,7 @@
 // created from 'create-ts-index'
 
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./utils.types"
-export * from "./validations.types"
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';
+export * from './validations.types';

package/basket/service.types.ts

@@ -9,6 +9,7 @@ import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type BasketServiceGetProductsHandler = (
     products?: BasketProduct[],
+    shouldSet?: boolean,
 ) => Promise<(Product | Contract)[]>
 export type BasketServiceAddProductOrContractByIdHandler = (
     contractOrProductId: string,
@@ -30,6 +31,7 @@ export type WindowHapiServiceBasket = WindowHapiModuleWithConstructorArgs<
     {
         onAfterGetBasketData: (
             basketItemData: (Contract | Product)[],
+            shouldSet: boolean,
         ) => BasketProduct[]
         setProductsMeta: BasketServiceSetProductsMetaHandler
         getProducts: HapiServiceFunctionWithLifecycleHooks<BasketServiceGetProductsHandler>

package/campaign/index.ts.bak

@@ -1,10 +1,10 @@
 // created from 'create-ts-index'
 
-export * from "./api.types"
-export * from "./enums"
-export * from "./qa.types"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./utils.types"
-export * from "./validations.types"
+export * from './api.types';
+export * from './enums';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';
+export * from './validations.types';

package/campaign/service.types.ts

@@ -16,7 +16,6 @@ import {
 import { PaginatedAPIResponseV2 } from "../common/types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 import { AlertKey } from "../alert"
-import { EmploymentType } from "./enums"
 
 export type CampaignServiceGetCampaignsHandler = (
     offset?: number,

package/common/index.ts.bak

@@ -1,7 +1,9 @@
 // created from 'create-ts-index'
 
-export * from "./events"
-export * from "./qa.types"
-export * from "./types"
-export * from "./validations.types"
-export * from "./enums"
+export * from './events';
+export * from './logger';
+export * from './validator';
+export * from './enums';
+export * from './qa.types';
+export * from './types';
+export * from './validations.types';

package/common/logger/index.ts.bak

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from './enums';
+export * from './types';

package/common/types.ts

@@ -223,16 +223,26 @@ export type PostingRequirementOption = {
     default?: string
     key: string
     label: string
-    data?: any[]
+    data?: PostingRequirementOptionData
     labels?: Record<"default", string>
     sort: string
     parent?: string
     requires?: PostingRequirementOptionRequiresField[] | null
     show?: string[]
 }
+export type PostingRequirementOptionDataImage = {
+    image: {
+        title: string
+        src: string
+    }
+}
+export type PostingRequirementOptionData = {
+    description?: string
+    images?: PostingRequirementOptionDataImage[]
+}
 export type TransformedPostingRequirementOption = {
     value?: string
-    data?: any[]
+    data?: PostingRequirementOptionData
     requires?: PostingRequirementOptionRequiresField[] | null
     label: string
     show?: string[]

package/common/validator/index.ts.bak

@@ -0,0 +1,3 @@
+// created from 'create-ts-index'
+
+export * from './types';

package/contract/api.types.ts

@@ -4,6 +4,7 @@ import {
     ContractCreateForm,
     ContractGroup,
     ContractGroupCreateForm,
+    ContractUpdateForm,
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
@@ -14,6 +15,7 @@ export type WindowHapiAPIContractConfigs = {
     getContractsByIds: AxiosRequestConfig
     getContract: AxiosRequestConfig
     createContract: AxiosRequestConfig
+    updateContract: AxiosRequestConfig
     removeContract: AxiosRequestConfig
     getPostingRequirementOptions: AxiosRequestConfig
     getGroups: AxiosRequestConfig
@@ -30,6 +32,10 @@ export type WindowHapiAPIContractRequests = {
     ) => Promise<PaginatedAPIResponseV1<Contract>>
     getContract: (contractId: string) => Promise<Contract>
     createContract: (contract: ContractCreateForm) => Promise<Contract>
+    updateContract: (
+        contractId: string,
+        contract: ContractUpdateForm,
+    ) => Promise<Contract>
     getPostingRequirementOptions: (
         contractId: string,
         fieldName: string,

package/contract/index.ts.bak

@@ -1,9 +1,9 @@
 // created from 'create-ts-index'
 
-export * from "./api.types"
-export * from "./qa.types"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./utils.types"
-export * from "./validations.types"
+export * from './api.types';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';
+export * from './validations.types';

package/contract/state.types.ts

@@ -5,6 +5,7 @@ import {
     ContractGroup,
     ContractGroupCreateForm,
     ContractGroupSelected,
+    ContractUpdateForm,
 } from "./types"
 import { PaginationResponseV1 } from "../common/types"
 
@@ -16,7 +17,7 @@ export type ContractState = {
     contractSelectedId: string | number | null
     contractSelected: ProductSupportingContractsComplete | null
     contractSelectedIsLoading: boolean
-    contractForm: ContractCreateForm
+    contractForm: ContractCreateForm | ContractUpdateForm
     contractCreateError: any
     contractFormIsValid: boolean | null
     /* Contracts Groups */

package/contract/types.ts

@@ -26,17 +26,20 @@ export type ContractCreateFormCredentials = Record<string, string>
 export type ContractCreateForm = {
     id?: number
     credentials?: ContractCreateFormCredentials
-    facets?: any
+    facets?: any | null
     expiry_date: string | null
     alias: string | null
-    purchase_price: ContractPurchasePrice
+    purchase_price: ContractPurchasePrice | null
     credits: string | null
     followed_instructions: boolean
     posting_duration_days: number | null
     allow_renegotiation: boolean
     labels: Record<string, string> | null
+    posting_requirements_defaults: Record<string, string> | null
 }
 
+export type ContractUpdateForm = Omit<ContractCreateForm, "id">
+
 export type ContractGroupCreateForm = {
     name: string
 }
@@ -58,7 +61,6 @@ export type Contract = {
     credits: number | null
     customer_id: string
     expiry_date: string | null
-    facets?: any[]
     product: ContractProduct
     purchase_price: ContractPurchasePrice | null
     posting_duration_days: number | null

package/debugging/index.ts.bak

@@ -1,4 +1,5 @@
 // created from 'create-ts-index'
 
-export * from "./state.types"
-export * from "./types"
+export * from './service.types';
+export * from './state.types';
+export * from './types';

package/index.ts.bak

@@ -1,18 +1,18 @@
 // created from 'create-ts-index'
 
-export * from "./_window"
-export * from "./alert"
-export * from "./ats"
-export * from "./basket"
-export * from "./campaign"
-export * from "./common"
-export * from "./contract"
-export * from "./debugging"
-export * from "./language"
-export * from "./modal"
-export * from "./orderJourney"
-export * from "./product"
-export * from "./routing"
-export * from "./theming"
-export * from "./ui"
-export * from "./wallet"
+export * from './_window';
+export * from './alert';
+export * from './ats';
+export * from './basket';
+export * from './campaign';
+export * from './common';
+export * from './contract';
+export * from './debugging';
+export * from './language';
+export * from './modal';
+export * from './orderJourney';
+export * from './product';
+export * from './routing';
+export * from './theming';
+export * from './ui';
+export * from './wallet';

package/language/index.ts.bak

@@ -1,5 +1,8 @@
 // created from 'create-ts-index'
 
-export * from "./qa.types"
-export * from "./state.types"
-export * from "./validations.types"
+export * from './enums';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.types';
+export * from './utils.types';
+export * from './validations.types';

package/modal/enums.ts

@@ -18,6 +18,7 @@ export enum ModalKeys {
     basketProductBundleParentClashConfirmation = "basket-product-bundle-parent-clash-confirmation",
     basketProductBundleChildClashConfirmation = "basket-product-bundle-child-clash-confirmation",
     contractRemoveConfirmation = "contract-remove-confirmation",
+    contractEdit = "contract-edit",
     contractGroupConflictInfo = "contract-group-conflict-info",
     filePicker = "file-picker",
     contractPostingRequirementsSmartFillSuccess = "contract-posting-requirements-smart-fill-success",

package/modal/index.ts.bak

@@ -1,6 +1,7 @@
 // created from 'create-ts-index'
 
-export * from "./enums"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
+export * from './enums';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';

package/orderJourney/index.ts.bak

@@ -1,8 +1,9 @@
 // created from 'create-ts-index'
 
-export * from "./enums"
-export * from "./qa.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./utils.types"
-export * from "./validations.types"
+export * from './enums';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';
+export * from './validations.types';

package/orderJourney/service.types.ts

@@ -17,6 +17,7 @@ export type WindowHapiServiceOrderJourney = WindowHapiModuleWithConstructorArgs<
         switchToNextStep: HapiServiceFunctionWithLifecycleHooks<OrderJourneyServiceSwitchToNextStepHandler>
         switchToPreviousStep: HapiServiceFunctionWithLifecycleHooks<OrderJourneyServiceSwitchToPreviousStepHandler>
         restartJourney: HapiServiceFunctionWithLifecycleHooks<OrderJourneyServiceRestartJourneyHandler>
+        unblurOnboardingStepFields: () => void
         getValidators: () => Record<string, NestedValidatorKeys>
         getErrorMessages: () => Record<string, Record<string, any> | undefined>
         getBlurredFields: () => Record<string, Record<string, any> | undefined>

package/package.json

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

package/product/index.ts.bak

@@ -1,10 +1,10 @@
 // created from 'create-ts-index'
 
-export * from "./api.types"
-export * from "./enums"
-export * from "./qa.types"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./utils.types"
-export * from "./validations.types"
+export * from './api.types';
+export * from './enums';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './utils.types';
+export * from './validations.types';

package/product/service.types.ts

@@ -25,6 +25,9 @@ export type ProductServiceGetFilteredProductsHandler = (
     filters?: Partial<ProductFilterQueryParams>,
 ) => Promise<Product[]>
 export type ProductServiceLoadMoreProductsHandler = () => Promise<Product[]>
+export type ProductServiceLoadMoreFreeAddOnProductsHandler = () => Promise<
+    Product[]
+>
 export type ProductServiceGetProductWithContractsSupportByIdHandler = (
     id: string | number,
 ) => Promise<ProductSupportingContractsComplete>
@@ -34,6 +37,7 @@ export type ProductServiceGetProductsWithContractsSupportHandler = (
 export type ProductServiceGetRecommendedProductsHandler = () => Promise<
     Product[]
 >
+export type ProductServiceGetFreeAddOnProductsHandler = () => Promise<Product[]>
 export type ProductServiceGetProductHandler = (
     productId: number | string,
 ) => Promise<Product>
@@ -76,11 +80,13 @@ export type ProductServiceGetProductPostingRequirementsHandler = (
 export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
     {
         loadMoreProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceLoadMoreProductsHandler>
+        loadMoreFreeAddOnProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceLoadMoreFreeAddOnProductsHandler>
         setArbitraryJobTitle: ProductServiceSetArbitraryJobTitle
         getProductWithContractsSupportById: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductWithContractsSupportByIdHandler>
         getProductsWithContractsSupport: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsWithContractsSupportHandler>
         getFilteredProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetFilteredProductsHandler>
         getRecommendedProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetRecommendedProductsHandler>
+        getFreeAddOnProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetFreeAddOnProductsHandler>
         getProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsHandler>
         getProduct: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductHandler>
         getLocations: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetLocationsHandler>

package/product/state.types.ts

@@ -13,6 +13,9 @@ export type ProductState = {
     /* Products */
     recommendedProducts: Product[]
     recommendedProductsAreLoading: boolean
+    freeAddOnProducts: Product[]
+    freeAddOnProductsAreLoading: boolean
+    freeAddOnProductsPaginationMeta: PaginationResponseV1 | null
     productsWithContractsSupport: ProductSupportingContractsPartial[]
     productsWithContractsSupportAreLoading: boolean
     products: Product[]

package/routing/index.ts.bak

@@ -1,3 +1,4 @@
 // created from 'create-ts-index'
 
-export * from "./state.types"
+export * from './state.types';
+export * from './utils.types';

package/theming/index.ts.bak

@@ -1,6 +1,6 @@
 // created from 'create-ts-index'
 
-export * from "./qa.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./validations.types"
+export * from './qa.types';
+export * from './state.types';
+export * from './types';
+export * from './validations.types';

package/wallet/index.ts.bak

@@ -1,7 +1,7 @@
 // created from 'create-ts-index'
 
-export * from "./api.types"
-export * from "./service.types"
-export * from "./state.types"
-export * from "./types"
-export * from "./validations.types"
+export * from './api.types';
+export * from './service.types';
+export * from './state.types';
+export * from './types';
+export * from './validations.types';