@vonq/hapi-elements-types 1.28.0 → 1.29.0

package/_window/api.types.ts

@@ -16,8 +16,10 @@ import {
 } from "./window"
 import { WindowHapiLogger } from "../common/logger/types"
 import { ATSUserTokenResponse } from "../ats"
+import { PartialRecord } from "../common"
+import { WindowHapiAPIExperimental } from "../experimental"
 
-export type WindowHapiAPIModule<ModuleType, ModuleConfig> = {
+export type WindowHapiAPIModule<ModuleRequests, ModuleConfig> = {
     propertiesThatShouldNotBeDocumented: string[]
     logger: WindowHapiLogger
     configs: ModuleConfig
@@ -27,7 +29,11 @@ export type WindowHapiAPIModule<ModuleType, ModuleConfig> = {
         resourceKey: keyof ModuleConfig,
         config: RawAxiosRequestConfig,
     ) => void
-} & ModuleType
+    abortControllers: PartialRecord<
+        keyof ModuleRequests,
+        Map<RawAxiosRequestConfig, AbortController>
+    >
+} & ModuleRequests
 export type HapiRequestConfig<T> = Omit<AxiosRequestConfig<T>, "headers"> & {
     headers?: any
 }
@@ -43,6 +49,17 @@ export type WindowHapiAPIRefreshJWTTokenHandler = () => Promise<
 
 export type WindowHapiAPIValidateJWTTokenHandler = () => Promise<boolean>
 
+export type WindowHapiAPIModules = {
+    [WindowHapiModuleName.contract]: WindowHapiAPIContract
+    [WindowHapiModuleName.wallet]: WindowHapiAPIWallet
+    [WindowHapiModuleName.product]: WindowHapiAPIProduct
+    [WindowHapiModuleName.campaign]: WindowHapiAPICampaign
+    [WindowHapiModuleName.ats]: WindowHapiAPIATS
+    [WindowHapiModuleName.experimental]: WindowHapiAPIExperimental
+}
+
+type Test = WindowHapiAPIModules[keyof WindowHapiAPIModules]
+
 export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
     {
         /* Common */
@@ -60,6 +77,21 @@ export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
         request: <T = any, R = AxiosResponse<T>, D = any>(
             config: Partial<HapiRequestConfig<D>>,
         ) => Promise<R>
+        requestAbortable: <
+            ModuleKlass extends WindowHapiAPIModule<
+                ModuleRequests,
+                ModuleConfig
+            >,
+            ModuleRequests,
+            ModuleConfig,
+            T = any,
+            R = AxiosResponse<T>,
+            D = any,
+        >(
+            moduleKlass: WindowHapiAPIModule<any, any>,
+            functionName: keyof ModuleRequests,
+            config: Partial<HapiRequestConfig<D>>,
+        ) => Promise<R>
         jwtHeaderKey: string
         jwtRefreshIntervalInSeconds: number
         setJWTRefreshIntervalInSeconds: (seconds: number) => void
@@ -84,18 +116,7 @@ export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
             endpoint: string,
             data?: any,
         ) => Promise<any>
-        [WindowHapiModuleName.contract]: WindowHapiAPIContract
-        [WindowHapiModuleName.wallet]: WindowHapiAPIWallet
-        [WindowHapiModuleName.product]: WindowHapiAPIProduct
-        [WindowHapiModuleName.campaign]: WindowHapiAPICampaign
-        [WindowHapiModuleName.ats]: WindowHapiAPIATS
-        modules: {
-            [WindowHapiModuleName.contract]: WindowHapiAPIContract
-            [WindowHapiModuleName.wallet]: WindowHapiAPIWallet
-            [WindowHapiModuleName.product]: WindowHapiAPIProduct
-            [WindowHapiModuleName.campaign]: WindowHapiAPICampaign
-            [WindowHapiModuleName.ats]: WindowHapiAPIATS
-        }
-    },
+        modules: WindowHapiAPIModules
+    } & WindowHapiAPIModules,
     { readonly core: WindowHapiClassInterface }
 >

package/_window/service.types.ts

@@ -16,6 +16,7 @@ import { WindowHapiLogger } from "../common/logger/types"
 import { WindowHapiServiceOrderJourney } from "../orderJourney/service.types"
 import { WindowHapiServiceDebugging } from "../debugging/service.types"
 import { WindowHapiServiceLanguage } from "../language/service.types"
+import { WindowHapiServiceExperimental } from "../experimental"
 
 export type HapiServiceFunctionLifecycleHookCallbackHandler = (
     ...args: any[]
@@ -23,6 +24,7 @@ export type HapiServiceFunctionLifecycleHookCallbackHandler = (
 
 export type HapiServiceFunctionLifecycleHookHandler = (
     callback: HapiServiceFunctionLifecycleHookCallbackHandler,
+    runArgs?: any[],
 ) => void
 
 export type HapiServiceFunctionWithLifecycleHooks<HandlerType> = {
@@ -56,6 +58,7 @@ export type WindowHapiService = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.ats]: WindowHapiServiceATS
         [WindowHapiModuleName.debugging]: WindowHapiServiceDebugging
         [WindowHapiModuleName.language]: WindowHapiServiceLanguage
+        [WindowHapiModuleName.experimental]: WindowHapiServiceExperimental
         services: {
             [WindowHapiModuleName.alert]: WindowHapiServiceAlert
             [WindowHapiModuleName.basket]: WindowHapiServiceBasket
@@ -69,6 +72,7 @@ export type WindowHapiService = WindowHapiModuleWithConstructorArgs<
             [WindowHapiModuleName.ats]: WindowHapiServiceATS
             [WindowHapiModuleName.debugging]: WindowHapiServiceDebugging
             [WindowHapiModuleName.language]: WindowHapiServiceLanguage
+            [WindowHapiModuleName.experimental]: WindowHapiServiceExperimental
         }
 
         decorateFunctionWithLifecycleEvents: <HandlerType extends Function>(

package/basket/service.types.ts

@@ -8,7 +8,7 @@ import {
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type BasketServiceGetProductsHandler = (
-    products?: BasketProduct[],
+    products: BasketProduct[],
     shouldSet?: boolean,
 ) => Promise<(Product | Contract)[]>
 export type BasketServiceAddProductOrContractByIdHandler = (
@@ -25,13 +25,14 @@ export type BasketServiceRemoveContractsWithConflictingGroupsHandler = (
 export type BasketServiceKeepContractsWithConflictingGroupsHandler = () => void
 export type BasketServiceSetProductsMetaHandler = (
     meta: BasketProduct[],
-) => Promise<(Product | Contract)[]>
+) => void
 
 export type WindowHapiServiceBasket = WindowHapiModuleWithConstructorArgs<
     {
         onAfterGetBasketData: (
             basketItemData: (Contract | Product)[],
-            shouldSet: boolean,
+            shouldSet?: boolean,
+            shouldSetMeta?: boolean,
         ) => BasketProduct[]
         setProductsMeta: BasketServiceSetProductsMetaHandler
         getProducts: HapiServiceFunctionWithLifecycleHooks<BasketServiceGetProductsHandler>

package/campaign/service.types.ts

@@ -90,6 +90,7 @@ export type WindowHapiServiceCampaign = WindowHapiModuleWithConstructorArgs<
         onAfterOrderCampaignSuccess: (
             alertKey?: AlertKey,
             disclaimerTexts?: string[],
+            isSuccessFromEditing?: boolean,
         ) => void
         validateContractPostingRequirementsWithCampaign: HapiServiceFunctionWithLifecycleHooks<CampaignServiceValidateContractPostingRequirementsWithCampaignHandler>
         saveCampaign: HapiServiceFunctionWithLifecycleHooks<CampaignServiceSaveCampaignHandler>

package/campaign/utils.types.ts

@@ -27,6 +27,7 @@ import {
 import {
     FormFacetsFieldType,
     PostingRequirement,
+    PostingRequirementLabelsMap,
     TransformedPostingRequirement,
 } from "../common"
 
@@ -64,6 +65,10 @@ export type WindowHapiUtilsCampaign = WindowHapiModuleWithConstructorArgs<
                 string,
                 CampaignCreateFormOrderedProductSpec
             >,
+            orderedProductsSpecsLabels?: Record<
+                string,
+                PostingRequirementLabelsMap
+            >,
         ) => CampaignOrderRequestBodyOrderedProductsSpec[]
         getPostBodyForOrderedProductsSpecsPostingRequirement: (
             postingRequirement: any,

package/common/enums.ts

@@ -33,6 +33,7 @@ export enum WindowHapiModuleName {
     alert = "alert",
     modal = "modal",
     "ui" = "ui",
+    "experimental" = "experimental",
 }
 
 export enum WindowHapiSDKModuleName {

package/common/types.ts

@@ -131,7 +131,6 @@ export type PostingRequirementType =
     | "TEXTAREA"
     | "AUTOCOMPLETE"
     | "STATISCH"
-    | "FILE-URL"
     | "HTMLAREA"
 
 export type PostingRequirementRuleName =
@@ -151,13 +150,8 @@ export type PostingRequirementRuleName =
     | "before"
     | "after"
     | "url"
-    | "fileMimeType"
-    | "fileMimeSubType"
-    | "editorTest"
-    | "libraryTest"
     | "autocomplete"
-    | "statictype"
-    | "staticsubtype"
+    | "mimetype"
 
 export type PostingRequirementRule = {
     rule: PostingRequirementRuleName
@@ -177,7 +171,7 @@ export type PostingRequirementDisplayRuleShowOperand =
 
 export type PostingRequirementDisplayRuleShow = {
     facet: string
-    value: any
+    value: string | string[]
     op: PostingRequirementDisplayRuleShowOperand
 }
 export type PostingRequirementDisplayRule = {
@@ -199,11 +193,6 @@ export type PostingRequirementAutocomplete = {
     required_parameters: string[] | null
     parameters_source: PostingRequirementParametersSource | null
 }
-export type PostingRequirementGroup = {
-    id: string
-    name: string
-    sort: number
-}
 export type PostingRequirement = {
     name: string
     label: string
@@ -228,7 +217,7 @@ export type PostingRequirementOptionRequiresField = {
 }
 export type PostingRequirementOption = {
     default?: string
-    key: string
+    key: string | number
     label: string
     data?: PostingRequirementOptionData
     labels?: Record<"default", string>
@@ -248,13 +237,12 @@ export type PostingRequirementOptionData = {
     images?: PostingRequirementOptionDataImage[]
 }
 export type TransformedPostingRequirementOption = {
-    value?: string
+    value?: string | number
     data?: PostingRequirementOptionData
     requires?: PostingRequirementOptionRequiresField[] | null
     label: string
     show?: string[]
 }
-export type PostingRequirementReactiveDescription = { description: string }
 export type TransformedPostingRequirement = Omit<
     PostingRequirement,
     "options"

package/common/validator/types.ts

@@ -1,5 +1,6 @@
 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
 }

package/contract/types.ts

@@ -67,6 +67,7 @@ export type Contract = {
     posting_duration_days: number | null
     group: ContractGroup | null
     posting_requirements_defaults: Record<string, string | string[]> | null
+    errors?: string[]
 }
 
 export type ContractGroup = {

package/contract/validations.types.ts

@@ -92,6 +92,7 @@ export type ZodContract = ZodObject<{
     product: ZodContractProduct
     purchase_price: ZodNullable<ZodContractPurchasePrice>
     group: ZodNullable<ZodContractGroup>
+    errors: ZodOptional<ZodArray<ZodString>>
 }>
 export type WindowHapiValidationsContract = {
     channel: ZodContractChannel

package/experimental/api.types.ts

@@ -0,0 +1,17 @@
+import { RawAxiosRequestConfig } from "axios"
+import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiAPIExperimentalConfigs = {
+    getExperimental: RawAxiosRequestConfig
+}
+export type WindowHapiAPIExperimentalRequests = {
+    getExperimental: () => Promise<any>
+}
+export type WindowHapiAPIExperimental = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPIModule<
+        WindowHapiAPIExperimentalRequests,
+        WindowHapiAPIExperimentalConfigs
+    >,
+    { readonly api: WindowHapiAPI }
+>

package/experimental/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from "./api.types"
+export * from "./service.types"

package/experimental/service.types.ts

@@ -0,0 +1,14 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiServiceExperimental = WindowHapiModuleWithConstructorArgs<
+    {
+        getExperimental: HapiServiceFunctionWithLifecycleHooks<
+            () => Promise<any>
+        >
+    },
+    { readonly service: WindowHapiService }
+>

package/modal/enums.ts

@@ -30,5 +30,6 @@ export enum ModalKeys {
 
 export enum FilePickerModalPropsActionFor {
     postingOrganization = "posting-organization",
-    postingRequirements = "posting-requirements",
+    productPostingRequirements = "product-posting-requirements",
+    contractPostingRequirements = "contract-posting-requirements",
 }

package/modal/types.ts

@@ -78,8 +78,7 @@ export type WalletPurchaseOrderModalProps = {}
 export type FilePickerModalPropsActionDataPostingRequirements = {
     requirement: TransformedPostingRequirement
     id: string | number
-    mimeTypesFull: string[]
-    mimeTypesSplit?: { mimeType: string; mimeSubType: string }[]
+    mimetype: string[]
 }
 export type FilePickerModalPropsActionData =
     FilePickerModalPropsActionDataPostingRequirements

package/orderJourney/service.types.ts

@@ -10,7 +10,9 @@ import { OrderJourneyStepKey } from "./enums"
 
 export type OrderJourneyServiceSwitchToNextStepHandler = () => Promise<void>
 export type OrderJourneyServiceSwitchToPreviousStepHandler = () => Promise<void>
-export type OrderJourneyServiceRestartJourneyHandler = () => void
+export type OrderJourneyServiceRestartJourneyHandler = (
+    shouldResetStepBackToFirstStep?: boolean,
+) => void
 
 export type WindowHapiServiceOrderJourney = WindowHapiModuleWithConstructorArgs<
     {

package/orderJourney/types.ts

@@ -203,3 +203,13 @@ export type OrderJourneyStepMap = {
     [OrderJourneyStepKey.paymentMethod]: OrderJourneyStep
     [OrderJourneyStepKey.orderConfirmation]: OrderJourneyStep
 }
+export type OrderReviewAccordionKeys = Exclude<
+    OrderJourneyStepKey,
+    | OrderJourneyStepKey.searchRecommendProducts
+    | OrderJourneyStepKey.selectProducts
+    | OrderJourneyStepKey.addContracts
+    | OrderJourneyStepKey.selectContracts
+    | OrderJourneyStepKey.orderReview
+    | OrderJourneyStepKey.orderConfirmation
+    | OrderJourneyStepKey.paymentMethod
+>

package/package.json

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