@vonq/hapi-elements-types 1.4.0 → 1.6.0

package/src/modal/types.ts

@@ -0,0 +1,44 @@
+import { Product } from "../product/types"
+import { Contract } from "../contract/types"
+import { ModalKeys, ModalZone } from "./enums"
+import { AnyNonFunction } from "../common/types"
+
+export type ProductDetailModalProps = {
+    id: string
+}
+export type UTMCodesModalProps = {}
+export type BasketRemoveProductConfirmationModalProps = {
+    basketProduct: Product | Contract
+}
+export type CampaignTakeOfflineConfirmationModalProps = { campaignId: string }
+export type ContractRemoveConfirmationModalProps = { contractId: string }
+export type BasketModalProps = {}
+export type WalletModalProps = {}
+
+export type ModalProps = AnyNonFunction<
+    | ProductDetailModalProps
+    | UTMCodesModalProps
+    | BasketRemoveProductConfirmationModalProps
+    | CampaignTakeOfflineConfirmationModalProps
+    | ContractRemoveConfirmationModalProps
+    | BasketModalProps
+    | WalletModalProps
+>
+
+export type ModalOptions = {
+    showCloseButton?: boolean
+    showBackdrop?: boolean
+    disableVerticalScroll?: boolean
+}
+
+export type Modal = {
+    zone: ModalZone
+    key: ModalKeys
+    props: ModalProps | undefined
+    options: ModalOptions
+}
+
+export type Modals = {
+    [ModalZone.primary]: Modal | null
+    [ModalZone.secondary]: Modal | null
+}

package/src/orderJourney/enums.ts

@@ -0,0 +1,25 @@
+export enum OrderJourneyStepKey {
+    searchRecommendProducts = "search-recommend-products",
+    selectProducts = "select-products",
+    addContracts = "add-contracts",
+    selectContracts = "select-contracts",
+    basketSummary = "basket-summary",
+    targetGroup = "target-group",
+    recruiterInfo = "recruiter-info",
+    postingDetails = "posting-details",
+    postingOrganization = "posting-organization",
+    postingContactInfo = "posting-contact-info",
+    postingWorkingLocation = "posting-working-location",
+    postingURLs = "posting-urls",
+    contractChannelPostingRequirements = "contract-channel-posting-requirements",
+    postingUTMCodes = "posting-utm-codes",
+    orderReview = "order-review",
+    paymentMethod = "payment-method",
+    orderConfirmation = "order-confirmation",
+}
+
+export enum OrderJourneyPaymentMethod {
+    atsManaged = "ats-managed",
+    wallet = "wallet",
+    purchaseOrder = "purchase-order",
+}

package/src/orderJourney/index.ts

@@ -0,0 +1,8 @@
+// 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"

package/src/orderJourney/qa.types.ts

@@ -0,0 +1,16 @@
+import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiQAOrderJourney = WindowHapiModuleWithConstructorArgs<
+    {
+        setEnabledSteps: (steps: OrderJourneyStepKey[]) => OrderJourneyStepKey[]
+        setEnabledPaymentMethods: (
+            methods: OrderJourneyPaymentMethod[],
+        ) => OrderJourneyPaymentMethod[]
+        setPaymentMethodActive: (
+            method: OrderJourneyPaymentMethod | null,
+        ) => OrderJourneyPaymentMethod | null
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/orderJourney/state.types.ts

@@ -0,0 +1,99 @@
+import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
+import { OrderJourneyStep, OrderJourneyContractStep } from "./types"
+import { MessageDescriptor } from "react-intl"
+import { NestedValidatorKeys, UseValidatorResult } from "../common/types"
+
+export type OrderJourneyState = {
+    stepsEnabled: OrderJourneyStepKey[]
+    steps: OrderJourneyStep[]
+    stepPreviousIndex: number
+    stepActiveIndex: number
+    stepNextIndex: number
+    stepFirstIndex: number
+    stepLastIndex: number
+    stepPrevious: OrderJourneyStep | null
+    stepActive: OrderJourneyStep | null
+    stepNext: OrderJourneyStep | null
+    stepsPopulatedAreHidden: boolean
+    paymentMethodsAvailable: OrderJourneyPaymentMethod[]
+    paymentMethodsEnabled: OrderJourneyPaymentMethod[]
+    paymentMethodActive: OrderJourneyPaymentMethod | null
+    hidePrefilledFields: boolean
+    orderErrors: Record<string, any> | null
+    /* Onboarding */
+    onboardingStep: OrderJourneyStep
+    onboardingStepData: Record<string, any>
+    onboardingStepValidations: UseValidatorResult
+    /* Select Products */
+    selectProductsStep: OrderJourneyStep
+    selectProductsStepData: Record<string, any>
+    selectProductsStepValidations: UseValidatorResult
+    /* Add Contracts */
+    addContractsStep: OrderJourneyStep
+    addContractsStepData: Record<string, any>
+    addContractsStepValidations: UseValidatorResult
+    /* Select Contracts */
+    selectContractsStep: OrderJourneyStep
+    selectContractsStepData: Record<string, any>
+    selectContractsStepValidations: UseValidatorResult
+    /* Basket Summary */
+    basketSummaryStep: OrderJourneyStep
+    basketSummaryStepData: Record<string, any>
+    basketSummaryStepValidations: UseValidatorResult
+    /* Target Group */
+    targetGroupStep: OrderJourneyStep
+    targetGroupStepData: Record<string, any>
+    targetGroupStepValidations: UseValidatorResult
+    /* Recruiter Info */
+    recruiterInfoStep: OrderJourneyStep
+    recruiterInfoStepData: Record<string, any>
+    recruiterInfoStepValidations: UseValidatorResult
+    /* Posting Details */
+    postingDetailsStep: OrderJourneyStep
+    postingDetailsStepData: Record<string, any>
+    postingDetailsStepValidations: UseValidatorResult
+    /* Organization */
+    organizationStep: OrderJourneyStep
+    organizationStepData: Record<string, any>
+    organizationStepValidations: UseValidatorResult
+    /* Contact Info */
+    contactInfoStep: OrderJourneyStep
+    contactInfoStepData: Record<string, any>
+    contactInfoStepValidations: UseValidatorResult
+    /* Working Location */
+    workingLocationStep: OrderJourneyStep
+    workingLocationStepData: Record<string, any>
+    workingLocationStepValidations: UseValidatorResult
+    /* URLs */
+    urlsStep: OrderJourneyStep
+    urlsStepData: Record<string, any>
+    urlsStepValidations: UseValidatorResult
+    /* Contract Fields */
+    contractSteps: OrderJourneyContractStep[]
+    contractStepsBlurredFields: Record<string, Record<string, boolean>>
+    contractStepsSubmittedSteps: Record<string, boolean>
+    contractStepsErrorMessages: Record<
+        string,
+        Record<string, MessageDescriptor>
+    >
+    contractStepsHideFields: Record<string, boolean>
+    contractStepsValidators: Record<string, Record<string, NestedValidatorKeys>>
+    contractStepsData: Record<string, Record<string, any>>
+    contractStepsValidations: Record<string, UseValidatorResult> | null
+    /* UTM Codes */
+    utmCodesStep: OrderJourneyStep
+    utmCodesStepData: Record<string, any>
+    utmCodesStepValidations: UseValidatorResult
+    /* Order Review */
+    orderReviewStep: OrderJourneyStep
+    orderReviewStepData: Record<string, any>
+    orderReviewStepValidations: UseValidatorResult
+    /* Payment Method */
+    paymentMethodStep: OrderJourneyStep
+    paymentMethodStepData: Record<string, any>
+    paymentMethodStepValidations: UseValidatorResult
+    /* Order Confirmation */
+    orderConfirmationStep: OrderJourneyStep
+    orderConfirmationStepData: Record<string, any>
+    orderConfirmationStepValidations: UseValidatorResult
+}

package/src/orderJourney/types.ts

@@ -0,0 +1,31 @@
+import { MessageDescriptor } from "react-intl"
+import { OrderJourneyStepKey } from "./enums"
+
+export type OrderJourneyStepBlurredFields = Record<
+    string,
+    | boolean
+    | Record<string, boolean>
+    | Record<string, Record<string, boolean> | boolean>
+>
+
+export type OrderJourneyStepErrorMessages = Record<
+    string,
+    | MessageDescriptor
+    | Record<string, MessageDescriptor | Record<string, MessageDescriptor>>
+>
+
+export type OrderJourneyStepKeyType = OrderJourneyStepKey | string
+export type OrderJourneyStep = {
+    key: OrderJourneyStepKeyType
+    titleIntlDescriptor?: MessageDescriptor
+    descriptionIntlDescriptor?: MessageDescriptor
+    isSubmitted?: boolean
+    blurredFields?: OrderJourneyStepBlurredFields
+    errorMessagesIntlDescriptors?: OrderJourneyStepErrorMessages
+    hideFields?: Record<string, boolean>
+}
+
+export type OrderJourneyContractStep = Omit<
+    OrderJourneyStep,
+    "blurredFields" | "isSubmitted" | "errorMessagesIntlDescriptors"
+>

package/src/orderJourney/utils.types.ts

@@ -0,0 +1,11 @@
+import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
+import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiUtilsOrderJourney = WindowHapiModuleWithConstructorArgs<
+    {
+        stepKeys: typeof OrderJourneyStepKey
+        paymentMethodKeys: typeof OrderJourneyPaymentMethod
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/src/orderJourney/validations.types.ts

@@ -0,0 +1,34 @@
+import {
+    ZodArray,
+    ZodBoolean,
+    ZodObject,
+    ZodOptional,
+    ZodRecord,
+    ZodString,
+    ZodTypeAny,
+} from "zod"
+import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
+import { ZodIntlDescriptor } from "../common/validations.types"
+
+export type ZodOrderJourneyStep = ZodObject<{
+    key: ZodString
+    titleIntlDescriptor: ZodIntlDescriptor
+    descriptionIntlDescriptor: ZodIntlDescriptor
+    isSubmitted: ZodOptional<ZodBoolean>
+    blurredFields: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
+    errorMessagesIntlDescriptors: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
+}>
+
+export type ZodOrderJourneySteps = ZodArray<ZodOrderJourneyStep>
+export type WindowHapiValidationsOrderJourney = {
+    supportedStepKeys: OrderJourneyStepKey[]
+    stepKeysRegex: RegExp
+    stepKey: ZodString
+    stepKeys: ZodArray<ZodString>
+    step: ZodOrderJourneyStep
+    steps: ZodOrderJourneySteps
+    paymentMethod: ZodString
+    paymentMethods: ZodArray<ZodString>
+    supportedPaymentMethods: OrderJourneyPaymentMethod[]
+    paymentMethodsRegex: RegExp
+}

package/src/product/api.types.ts

@@ -0,0 +1,62 @@
+import { AxiosRequestConfig } from "axios"
+import {
+    Product,
+    ProductIndustry,
+    ProductJobFunction,
+    ProductJobTitle,
+    ProductLocation,
+    ProductSupportingContractsComplete,
+    ProductSupportingContractsPartial,
+    ProductWithSupportForContractsFilters,
+} from "./types"
+import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
+import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
+import {
+    WindowHapiAPIATSConfigs,
+    WindowHapiAPIATSRequests,
+} from "../ats/api.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiAPIProductConfigs = {
+    getProduct: AxiosRequestConfig
+    getProductSupportingContracts: AxiosRequestConfig
+    getProducts: AxiosRequestConfig
+    getProductsSupportingContracts: AxiosRequestConfig
+    searchProducts: AxiosRequestConfig
+    getIndustries: AxiosRequestConfig
+    getJobFunctions: AxiosRequestConfig
+    getJobTitles: AxiosRequestConfig
+    getLocations: AxiosRequestConfig
+}
+export type WindowHapiAPIProductRequests = {
+    getProduct: (productId: number | string) => Promise<Product>
+    getProductSupportingContracts: (
+        productId: number | string,
+    ) => Promise<ProductSupportingContractsComplete>
+    getProducts: (
+        productIds: (number | string)[],
+        limitOffset?: PaginationLimitOffset,
+        allowOrders?: boolean,
+    ) => Promise<PaginatedAPIResponseV1<Product>>
+    searchProducts: (
+        filters?: URLSearchParams,
+        limitOffset?: PaginationLimitOffset,
+    ) => Promise<PaginatedAPIResponseV1<Product>>
+    getProductsSupportingContracts: (
+        filters?: ProductWithSupportForContractsFilters,
+        limitOffset?: PaginationLimitOffset,
+    ) => Promise<PaginatedAPIResponseV1<ProductSupportingContractsPartial>>
+    getIndustries: () => Promise<ProductIndustry[]>
+    getJobFunctions: () => Promise<ProductJobFunction[]>
+    getJobTitles: (
+        text?: string,
+    ) => Promise<PaginatedAPIResponseV1<ProductJobTitle>>
+    getLocations: (searchParam: string) => Promise<ProductLocation[]>
+}
+export type WindowHapiAPIProduct = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPIModule<
+        WindowHapiAPIProductRequests,
+        WindowHapiAPIProductConfigs
+    >,
+    { readonly api: WindowHapiAPI }
+>

package/src/product/enums.ts

@@ -0,0 +1,11 @@
+export enum ProductFilterRecommendations {
+    "all" = "all",
+    "only" = "only",
+    "without" = "without",
+}
+
+export enum ProductPriceCurrency {
+    "USD" = "USD",
+    "EUR" = "EUR",
+    "GBP" = "GBP",
+}

package/src/product/index.ts

@@ -0,0 +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"

package/src/product/qa.types.ts

@@ -0,0 +1,11 @@
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiQAProduct = WindowHapiModuleWithConstructorArgs<
+    {
+        useMockFilters: () => Promise<void>
+        getRandomChannelIdThatSupportsContracts: () => Promise<number>
+        getRandomProductId: () => Promise<string>
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/product/service.types.ts

@@ -0,0 +1,68 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import {
+    Product,
+    ProductFilterQueryParams,
+    ProductIndustry,
+    ProductJobFunction,
+    ProductJobTitle,
+    ProductLocation,
+    ProductSupportingContractsComplete,
+    ProductSupportingContractsPartial,
+} from "./types"
+import { PaginatedAPIResponseV1, PaginationResponseV1 } from "../common/types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type ProductServiceGetFilteredProductsHandler = (
+    meta?: PaginationResponseV1 | null,
+    filters?: Partial<ProductFilterQueryParams>,
+) => Promise<Product[]>
+export type ProductServiceGetProductWithContractsSupportByIdHandler = (
+    id: string | number,
+) => Promise<ProductSupportingContractsComplete>
+export type ProductServiceGetProductsWithContractsSupportHandler = (
+    queryParams?: any,
+) => Promise<ProductSupportingContractsPartial[]>
+export type ProductServiceGetRecommendedProductsHandler = () => Promise<
+    Product[]
+>
+export type ProductServiceGetProductHandler = (
+    productId: number | string,
+) => Promise<Product>
+export type ProductServiceGetProductsHandler = (
+    queryParams: URLSearchParams,
+    shouldAppendResults?: boolean,
+) => Promise<{
+    products: Product[]
+    paginationMeta?: PaginationResponseV1
+}>
+export type ProductServiceGetLocationsHandler = (
+    text: string,
+) => Promise<ProductLocation[]>
+export type ProductServiceGetJobTitlesHandler = (
+    text?: string,
+) => Promise<PaginatedAPIResponseV1<ProductJobTitle>>
+export type ProductServiceGetJobFunctionsHandler = () => Promise<
+    ProductJobFunction[]
+>
+export type ProductServiceGetIndustriesHandler = () => Promise<
+    ProductIndustry[]
+>
+
+export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
+    {
+        getProductWithContractsSupportById: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductWithContractsSupportByIdHandler>
+        getProductsWithContractsSupport: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsWithContractsSupportHandler>
+        getFilteredProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetFilteredProductsHandler>
+        getRecommendedProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetRecommendedProductsHandler>
+        getProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsHandler>
+        getProduct: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductHandler>
+        getLocations: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetLocationsHandler>
+        getJobTitles: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetJobTitlesHandler>
+        getJobFunctions: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetJobFunctionsHandler>
+        getIndustries: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetIndustriesHandler>
+    },
+    { readonly service: WindowHapiService }
+>

package/src/product/state.types.ts

@@ -0,0 +1,93 @@
+import {
+    Product,
+    ProductIndustry,
+    ProductJobFunction,
+    ProductJobTitle,
+    ProductLocation,
+    ProductSupportingContractsPartial,
+} from "./types"
+import { PaginationResponseV1 } from "../common/types"
+
+export type ProductState = {
+    /* Products */
+    /**
+     * Array of Products to be listed on Products Landing and Products List widgets. As user applies filters and sorting, this value gets overwritten
+     */
+    recommendedProducts: Product[]
+    /**
+     * Indicates if recommended products are loading
+     */
+    recommendedProductsAreLoading: boolean
+    /**
+     * Array of Products to be listed on Contracts Add Channel Selector Dropdown
+     */
+    productsWithContractsSupport: ProductSupportingContractsPartial[]
+    /**
+     * Indicates whether the Products with Contracts support is loading (mainly used for showing a loading spinner on the Select element when the user is searching for a Product when creating a contract)
+     */
+    productsWithContractsSupportAreLoading: boolean
+    /**
+     * Array of Products to be listed on Products Landing and Products List widgets. As user applies filters and sorting, this value gets overwritten
+     */
+    products: Product[]
+    /**
+     Offset and limit style pagination meta
+     */
+    productsPaginationMeta: PaginationResponseV1 | null
+    /**
+     * Indicates if products are loading
+     */
+    productsAreLoading: boolean
+    /**
+     * The value of Product name in the Input HTML Element that is used to fetch new Product results from the API
+     */
+    productNameInput: string
+    /**
+     * The selected Product region IDs that is used to fetch new Product results from the API
+     */
+    jobRegionsIdsSelected: number[]
+    /* Locations */
+    /**
+     * Array of Locations that are lazily loaded with the input given in `jobRegionsIdsSelected`
+     */
+    jobRegions: ProductLocation[]
+    /* Job Titles */
+    /**
+     * Array of Job Titles that are lazily loaded with the input given in `jobTitlesIdsSelected`
+     */
+    jobTitles: ProductJobTitle[]
+    /**
+     * The selected Job Title IDs that are used to fetch new Product results from the API
+     */
+    jobTitlesIdsSelected: number[]
+    /* Job Functions */
+    /**
+     * Array of Job Functions that are lazily loaded with the input given in `jobTitlesIdsSelected`
+     */
+    jobFunctions: ProductJobFunction[]
+    /**
+     * Shows a loading spinner and disables the Select HTML Element while locations are loading
+     */
+    jobFunctionsAreLoading: boolean
+    /**
+     * The value of Job Function in the Input HTML Element that lazy loads `jobFunctions`
+     */
+    jobFunctionsInput: string
+    /**
+     * The selected Job Function IDs that are used to fetch new Product results from the API
+     */
+    jobFunctionsIdsSelected: number[]
+    /* Industries */
+    /**
+     * The selected Job Industry ID that is used to fetch new Product results from the API
+     */
+    jobIndustriesIdsSelected: number[]
+    /**
+     * Array of Industries that are lazily loaded with the input given in `jobIndustriesIdsSelected`
+     */
+    jobIndustries: ProductIndustry[]
+    /**
+     * Shows a loading spinner and disables the Select HTML Element while locations are loading
+     */
+    jobIndustriesAreLoading: boolean
+}