@vonq/hapi-elements-types 1.4.0 → 1.5.0

package/src/basket/state.types.ts

@@ -0,0 +1,34 @@
+import { Product } from "../product/types"
+import { BasketProduct } from "./types"
+import { Contract } from "../contract/types"
+
+export type BasketStoreState = {
+    /**
+     * Array of `BasketProduct`s. The price or other properties of a Product or Contract may change therefore this variable only contains ID of Product or Contract and whether it is a Product or not; via the `isProduct: boolean` variable. Elements of this array then are fetched from the API with their latest information and then set as `products`.
+     */
+    productsMeta: BasketProduct[]
+    /**
+     * Array of Products and/or Contracts. This variable is auto-populated with the response received from the API for the Products and Contracts inside `productsMeta`
+     */
+    products: (Product | Contract)[]
+    /**
+     * Sum of prices of Products and/or Contracts in EUR currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInEUR: number
+    /**
+     * Sum of prices of Products and/or Contracts in USD currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInUSD: number
+    /**
+     * Sum of prices of Products and/or Contracts in GBP currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInGBP: number
+    /**
+     * Sum of prices of Products and/or Contracts in the current display currency that is used throughout the widgets. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInDisplayCurrency: number
+    /**
+     * Shows a spinner in Basket when the data for Products and/or Contracts is being fetched from the API
+     */
+    productsAreLoading: boolean
+}

package/src/basket/state.validations.ts

@@ -0,0 +1,12 @@
+import { BasketStoreState } from "./state.types"
+import { StateValidations } from "../_window/state.types"
+
+export const basketStoreStateValidations: StateValidations<BasketStoreState> = {
+    productsMeta: "basket.productsMeta",
+    products: "basket.products",
+    productsAreLoading: "common.genericBoolean",
+    totalInEUR: "throwHasNoSetterError",
+    totalInGBP: "throwHasNoSetterError",
+    totalInUSD: "throwHasNoSetterError",
+    totalInDisplayCurrency: "throwHasNoSetterError",
+}

package/src/basket/types.ts

@@ -0,0 +1,4 @@
+export type BasketProduct = {
+    id: number | string // Product ID or Contract ID
+    isProduct: boolean
+}

package/src/basket/utils.ts

@@ -0,0 +1,79 @@
+import { Product } from "../product/types"
+import { Contract } from "../contract/types"
+import { ProductPriceCurrency } from "../product/enums"
+import { BasketProduct } from "./types"
+
+export const getIsBasketProductContract = (product: Product | Contract) => {
+    return (product as Contract).contract_id !== undefined
+}
+export const getIsBasketProductProduct = (product: Product | Contract) => {
+    return (product as Product).product_id !== undefined
+}
+export const getBasketProductId = (product: Product | Contract) => {
+    const isProduct = getIsBasketProductProduct(product)
+    return isProduct
+        ? (product as Product).product_id
+        : (product as Contract).contract_id
+}
+export const getBasketProductTitle = (product: Product | Contract) => {
+    const isProduct = getIsBasketProductProduct(product)
+    return isProduct
+        ? (product as Product).title
+        : (product as Contract).product.title
+}
+
+export const getBasketProductPrice = (
+    product: Product | Contract,
+    displayCurrency: ProductPriceCurrency,
+) => {
+    if ((product as Product).product_id) {
+        const price = (product as Product).vonq_price.find(
+            (price) => price.currency === displayCurrency,
+        )
+        if (price) {
+            return price
+        }
+        return undefined
+    } else {
+        return undefined
+    }
+}
+
+export const getBasketProductBoardType = (product: Product | Contract) => {
+    if ((product as Product).product_id) {
+        return (product as Product).type
+    } else {
+        return (product as Contract).channel?.type
+    }
+}
+
+export const getBasketProductTimeToProcess = (product: Product | Contract) => {
+    if ((product as Product).product_id) {
+        return `${(product as Product).time_to_process.period} ${
+            (product as Product).time_to_process.range
+        }`
+    } else {
+        return undefined
+    }
+}
+
+export const getBasketProductDuration = (product: Product | Contract) => {
+    if ((product as Product).product_id) {
+        return `${(product as Product).duration.period} ${
+            (product as Product).duration.range
+        }`
+    } else {
+        return undefined
+    }
+}
+
+export const getIsProductOrContractInBasket = (
+    contractOrProductId: string,
+    productsMeta: BasketProduct[],
+) => {
+    const alreadyInBasket = productsMeta.find(
+        (basketProduct) => basketProduct.id === contractOrProductId,
+    )
+
+    return alreadyInBasket !== undefined
+}

package/src/basket/utils.types.ts

@@ -0,0 +1,10 @@
+import { BasketProduct } from "./types"
+import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiUtils } from "../_window/utils.types"
+
+export type WindowHapiUtilsBasket = ModuleWithConstructorArgs<
+    {
+        getInitialBasketProductsMeta: () => BasketProduct[]
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/src/basket/validations.types.ts

@@ -0,0 +1,25 @@
+import {
+    ZodArray,
+    ZodBoolean,
+    ZodNumber,
+    ZodObject,
+    ZodString,
+    ZodUnion,
+} from "zod"
+import { ZodProduct } from "../product/validations.types"
+import { ZodContract } from "../contract/validations.types"
+
+export type ZodContractsOrProducts = ZodArray<
+    ZodUnion<[ZodProduct, ZodContract]>
+>
+export type ZodBasketProductMeta = ZodObject<{
+    id: ZodUnion<[ZodString, ZodNumber]>
+    isProduct: ZodBoolean
+}>
+export type ZodBasketProductsMeta = ZodArray<ZodBasketProductMeta>
+
+export type WindowHapiValidationsBasket = {
+    contractsOrProducts: ZodContractsOrProducts
+    productMeta: ZodBasketProductMeta
+    productsMeta: ZodBasketProductsMeta
+}

package/src/campaign/api.types.ts

@@ -0,0 +1,45 @@
+import { AxiosRequestConfig } from "axios"
+import {
+    Campaign,
+    CampaignOrderRequestBody,
+    TaxonomyEducationAndSeniorityLevel,
+} from "./types"
+import { ProductSupportingContractsComplete } from "../product/types"
+import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
+import { PaginatedAPIResponseV2 } from "../common/types"
+import { ModuleWithConstructorArgs } from "../types"
+
+export type WindowHapiAPICampaignConfigs = {
+    getCampaigns: AxiosRequestConfig
+    getCampaign: AxiosRequestConfig
+    getCampaignDetail: AxiosRequestConfig
+    setCampaignCancellation: AxiosRequestConfig
+    getEducationLevels: AxiosRequestConfig
+    getSeniorities: AxiosRequestConfig
+    orderCampaign: AxiosRequestConfig
+}
+export type WindowHapiAPICampaignRequests = {
+    getCampaigns: (
+        offset?: number,
+        limit?: number,
+    ) => Promise<PaginatedAPIResponseV2<Campaign>>
+    getCampaign: (campaignId: string) => Promise<Campaign>
+    getCampaignDetail: (
+        campaignId: string,
+        detail: "status",
+    ) => Promise<ProductSupportingContractsComplete>
+    setCampaignCancellation: (
+        campaignId: string,
+        body: Partial<Campaign>,
+    ) => Promise<ProductSupportingContractsComplete>
+    getEducationLevels: () => Promise<TaxonomyEducationAndSeniorityLevel[]>
+    getSeniorities: () => Promise<TaxonomyEducationAndSeniorityLevel[]>
+    orderCampaign: (postBody: CampaignOrderRequestBody) => Promise<Campaign>
+}
+export type WindowHapiAPICampaign = ModuleWithConstructorArgs<
+    WindowHapiAPIModule<
+        WindowHapiAPICampaignRequests,
+        WindowHapiAPICampaignConfigs
+    >,
+    { readonly api: WindowHapiAPI }
+>

package/src/campaign/consts.ts

@@ -0,0 +1 @@
+export const CAMPAIGN_CREATE_FORM_LOCALSTORAGE_KEY = "createCampaignForm"

package/src/campaign/enums.ts

@@ -0,0 +1,17 @@
+export enum EmploymentType {
+    permanent = "permanent",
+    temporary = "temporary",
+    fixed_term = "fixed_term",
+    fixed_term_with_option_for_permanent = "fixed_term_with_option_for_permanent",
+    freelance = "freelance",
+    traineeship = "traineeship",
+    internship = "internship",
+}
+
+export enum SalaryPeriod {
+    DAILY = "daily",
+    MONTHLY = "monthly",
+    HOURLY = "hourly",
+    WEEKLY = "weekly",
+    YEARLY = "yearly",
+}

package/src/campaign/functions.types.ts

@@ -0,0 +1,90 @@
+/* Campaign */
+
+import {
+    Campaign,
+    CampaignCreateForm,
+    TaxonomyEducationAndSeniorityLevel,
+    TaxonomySeniority,
+} from "./types"
+import { PaginationResponseV2, RecursivePartial } from "../common/types"
+
+export type CampaignStoreSetCampaignsHandler = (campaigns: Campaign[]) => void
+export type CampaignStoreSetCampaignsPaginationMetaHandler = (
+    meta: PaginationResponseV2 | null,
+) => void
+export type CampaignStoreSetCampaignsAreLoadingHandler = (
+    isLoading: boolean,
+) => void
+export type CampaignStoreSetCampaignHandler = (
+    campaignId: string,
+    campaign: Partial<Campaign>,
+) => void
+export type CampaignStoreSetCampaignFormHandler = (
+    campaign: RecursivePartial<CampaignCreateForm>,
+    replaceAsIs?: boolean,
+) => void
+export type CampaignStoreSetCampaignIsCreatingHandler = (
+    isCreating: boolean,
+) => void
+
+/* Education Levels */
+export type CampaignStoreSetEducationLevelsHandler = (
+    educationLevels: TaxonomyEducationAndSeniorityLevel[],
+) => void
+export type CampaignStoreSetEducationLevelsAreLoadingHandler = (
+    isLoading: boolean,
+) => void
+
+/* Seniorities */
+export type CampaignStoreSetSenioritiesHandler = (
+    seniorities: TaxonomySeniority[],
+) => void
+export type CampaignStoreSetSenioritiesAreLoadingHandler = (
+    isLoading: boolean,
+) => void
+
+export type CampaignStoreFunctions = {
+    /* Campaign */
+    /**
+     * The function that sets the value of `campaigns`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaigns: CampaignStoreSetCampaignsHandler
+    /**
+     * The function that sets the value of `campaignsPaginationMeta`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaignsPaginationMeta: CampaignStoreSetCampaignsPaginationMetaHandler
+    /**
+     * The function that sets the value of `campaignsAreLoading`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaignsAreLoading: CampaignStoreSetCampaignsAreLoadingHandler
+    /**
+     * The function that updates properties of a Campaign in the array of `campaigns` by given Campaign ID. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaign: CampaignStoreSetCampaignHandler
+    /**
+     * The function that updates properties of `campaignForm`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaignForm: CampaignStoreSetCampaignFormHandler
+    /**
+     * The function that sets the value of `campaignIsCreating`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setCampaignIsCreating: CampaignStoreSetCampaignIsCreatingHandler
+    /* Education Levels */
+    /**
+     * The function that sets the value of `educationLevels`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setEducationLevels: CampaignStoreSetEducationLevelsHandler
+    /**
+     * The function that sets the value of `educationLevelsAreLoading`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setEducationLevelsAreLoading: CampaignStoreSetEducationLevelsAreLoadingHandler
+    /* Seniorities */
+    /**
+     * The function that sets the value of `seniorities`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setSeniorities: CampaignStoreSetSenioritiesHandler
+    /**
+     * The function that sets the value of `senioritiesAreLoading`. Refer to [CampaignStoreState](/docs/sdk/campaigns/#campaignstorestate) for more details.
+     */
+    setSenoritiesAreLoading: CampaignStoreSetSenioritiesAreLoadingHandler
+}

package/src/campaign/index.ts

@@ -0,0 +1,15 @@
+// created from 'create-ts-index'
+
+export * from './api.types';
+export * from './consts';
+export * from './enums';
+export * from './functions.types';
+export * from './qa.types';
+export * from './service.types';
+export * from './state.initial';
+export * from './state.types';
+export * from './state.validations';
+export * from './types';
+export * from './utils';
+export * from './utils.types';
+export * from './validations.types';

package/src/campaign/qa.types.ts

@@ -0,0 +1,12 @@
+import { MockCampaignCreateForm } from "../consts"
+import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiQA } from "../_window/qa.types"
+
+export type WindowHapiQACampaign = ModuleWithConstructorArgs<
+    {
+        useMockCampaignForm: () => MockCampaignCreateForm
+        getRandomCampaignId: () => Promise<string>
+        setCampaignFormDebuggerIsShown: (isEnabled: boolean) => boolean
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/campaign/service.types.ts

@@ -0,0 +1,48 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { ProductSupportingContractsComplete } from "../product/types"
+import { Campaign, TaxonomyEducationAndSeniorityLevel } from "./types"
+import { PaginatedAPIResponseV2 } from "../common/types"
+import { ModuleWithConstructorArgs } from "../types"
+
+export type CampaignServiceGetCampaignsHandler = (
+    offset?: number,
+    limit?: number,
+) => Promise<PaginatedAPIResponseV2<Campaign>>
+export type CampaignServiceGetCampaignDetailHandler = (
+    campaignId: string,
+    detail: "status",
+) => Promise<ProductSupportingContractsComplete>
+export type CampaignServiceGetCampaignHandler = (
+    campaignId: string,
+) => Promise<ProductSupportingContractsComplete>
+export type CampaignServiceSetCampaignCancellationHandler = (
+    campaignId: string,
+    body: Partial<Campaign>,
+) => Promise<ProductSupportingContractsComplete>
+export type CampaignServiceGetEducationLevelsHandler = () => Promise<
+    TaxonomyEducationAndSeniorityLevel[]
+>
+export type CampaignServiceGetSenioritiesHandler = () => Promise<
+    TaxonomyEducationAndSeniorityLevel[]
+>
+export type CampaignServiceOrderCampaignHandler = () => Promise<Campaign>
+export type CampaignServiceCopyCampaignHandler = (
+    campaign: Campaign,
+) => Promise<Campaign>
+
+export type WindowHapiServiceCampaign = ModuleWithConstructorArgs<
+    {
+        getCampaigns: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetCampaignsHandler>
+        getCampaignDetail: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetCampaignDetailHandler>
+        getCampaign: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetCampaignHandler>
+        setCampaignCancellation: HapiServiceFunctionWithLifecycleHooks<CampaignServiceSetCampaignCancellationHandler>
+        getEducationLevels: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetEducationLevelsHandler>
+        getSeniorities: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetSenioritiesHandler>
+        orderCampaign: HapiServiceFunctionWithLifecycleHooks<CampaignServiceOrderCampaignHandler>
+        copyCampaign: HapiServiceFunctionWithLifecycleHooks<CampaignServiceCopyCampaignHandler>
+    },
+    { readonly service: WindowHapiService }
+>

package/src/campaign/state.initial.ts

@@ -0,0 +1,84 @@
+import { EmploymentType, SalaryPeriod } from "./enums"
+import { CampaignStoreState } from "./state.types"
+
+export const initialCampaignStoreState: CampaignStoreState = {
+    campaigns: [],
+    campaignsPaginationMeta: {
+        limit: 20,
+        offset: 0,
+    },
+    campaignsAreLoading: false,
+    campaignForm: {
+        recruiterInfo: {
+            name: "",
+            emailAddress: "",
+        },
+        postingDetails: {
+            title: "",
+            description: "",
+            organization: {
+                name: "",
+                companyLogo: "",
+            },
+            contactInfo: {
+                name: "",
+                emailAddress: "",
+                phoneNumber: "",
+            },
+            workingLocation: {
+                addressLine1: "",
+                addressLine2: "",
+                postcode: "",
+                city: "",
+                country: "",
+                allowsRemoteWork: 0,
+            },
+            yearsOfExperience: 0,
+            employmentType: EmploymentType.permanent,
+            weeklyWorkingHours: {
+                from: 0,
+                to: 0,
+            },
+            salaryIndication: {
+                period: SalaryPeriod.MONTHLY,
+                range: {
+                    from: 0,
+                    to: 0,
+                    currency: "",
+                },
+            },
+            jobPageUrl: "",
+            applicationUrl: "",
+        },
+        targetGroup: {
+            educationLevel: [],
+            seniority: [],
+            industry: [],
+            jobCategory: [],
+        },
+        orderedProducts: [],
+        orderedProductsSpecs: {},
+        campaignName: "",
+        companyId: "",
+    },
+    campaignIsCreating: false,
+    /* Education Levels */
+    educationLevels: [],
+    educationLevelsAreLoading: false,
+    /* Seniorities */
+    seniorities: [],
+    senioritiesAreLoading: false,
+    /* Employment Types */
+    employmentTypes: [
+        { value: EmploymentType.permanent, label: "Permanent" },
+        { value: EmploymentType.temporary, label: "Temporary" },
+        { value: EmploymentType.fixed_term, label: "Fixed term" },
+        {
+            value: EmploymentType.fixed_term_with_option_for_permanent,
+            label: "Fixed term with option for permanent",
+        },
+        { value: EmploymentType.freelance, label: "Freelance" },
+        { value: EmploymentType.traineeship, label: "Traineeship" },
+        { value: EmploymentType.internship, label: "Internship" },
+    ],
+}

package/src/campaign/state.types.ts

@@ -0,0 +1,55 @@
+import {
+    Campaign,
+    CampaignCreateForm,
+    TaxonomyEducationAndSeniorityLevel,
+    TaxonomyEmploymentTypes,
+    TaxonomySeniority,
+} from "./types"
+import { PaginationResponseV2 } from "../common/types"
+
+export type CampaignStoreState = {
+    /* Campaign */
+    /**
+     * Array of Campaign Objects for listing in Campaigns Landing and Campaigns List (both Card and Accordion Table Layout) widgets
+     */
+    campaigns: Campaign[]
+    /**
+     * An object that holds information like next URL, previous URL and count for pagination purposes
+     */
+    campaignsPaginationMeta: PaginationResponseV2
+    /**
+     * Used to show a loading spinner in Campaign widgets that show list of campaigns
+     */
+    campaignsAreLoading: boolean
+    /**
+     * Object used to create (order) a campaign
+     */
+    campaignForm: CampaignCreateForm
+    /**
+     * Shows a loading spinner and disables the buttons in Campaign Create Form while creating a Campaign
+     */
+    campaignIsCreating: boolean
+    /* Education Levels */
+    /**
+     * Array of Education Levels that end user will select via a Select HTML element
+     */
+    educationLevels: TaxonomyEducationAndSeniorityLevel[]
+    /**
+     * Used to show a loading spinner and also disable the Select HTML element while values for Education Levels is loading
+     */
+    educationLevelsAreLoading: boolean
+    /* Seniorities */
+    /**
+     * Array of Seniorities that end user will select via a Select HTML element
+     */
+    seniorities: TaxonomySeniority[]
+    /**
+     * Used to show a loading spinner and also disable the Select HTML element while values for Seniorities is loading
+     */
+    senioritiesAreLoading: boolean
+    /* Employment Types */
+    /**
+     * Array of Employment Types that end user will select via a Select HTML element
+     */
+    employmentTypes: TaxonomyEmploymentTypes[]
+}

package/src/campaign/state.validations.ts

@@ -0,0 +1,16 @@
+import { CampaignStoreState } from "./state.types"
+import { StateValidations } from "../_window/state.types"
+
+export const campaignStoreStateValidations: StateValidations<CampaignStoreState> =
+    {
+        campaigns: "campaign.campaigns",
+        campaignsPaginationMeta: "common.paginationMetaV2",
+        campaignsAreLoading: "common.genericBoolean",
+        campaignIsCreating: "common.genericBoolean",
+        campaignForm: "campaign.campaignForm",
+        educationLevels: "campaign.educationLevels",
+        educationLevelsAreLoading: "common.genericBoolean",
+        seniorities: "campaign.seniorities",
+        senioritiesAreLoading: "common.genericBoolean",
+        employmentTypes: "campaign.employmentTypes",
+    }