@vonq/hapi-elements-types 1.4.0 → 1.6.0

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 { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+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 = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPIModule<
+        WindowHapiAPICampaignRequests,
+        WindowHapiAPICampaignConfigs
+    >,
+    { readonly api: WindowHapiAPI }
+>

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/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/campaign/qa.types.ts

@@ -0,0 +1,12 @@
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+import { CampaignCreateForm } from "./types"
+
+export type WindowHapiQACampaign = WindowHapiModuleWithConstructorArgs<
+    {
+        useMockCampaignForm: () => CampaignCreateForm
+        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 { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+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 = WindowHapiModuleWithConstructorArgs<
+    {
+        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.types.ts

@@ -0,0 +1,55 @@
+import {
+    Campaign,
+    CampaignCreateForm,
+    TaxonomyEducationAndSeniorityLevel,
+    TaxonomyEmploymentTypes,
+    TaxonomySeniority,
+} from "./types"
+import { PaginationResponseV2 } from "../common/types"
+
+export type CampaignState = {
+    /* 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/types.ts

@@ -0,0 +1,237 @@
+import { ProductDuration, ProductIndustry } from "../product/types"
+import { ContractPostingRequirement } from "../contract/types"
+import { ProductPriceCurrency } from "../product/enums"
+import { EmploymentType, SalaryPeriod } from "./enums"
+
+export type CampaignProductSpecs = {
+    contractId: string | null
+    deliveredOn: string | null
+    duration: string
+    durationPeriod: ProductDuration
+    jobBoardLink: string | null
+    postingRequirements: Record<string, any> | null
+    productId: string
+    status: CampaignStatus
+    utm: string | null
+    statusDescription: string | null
+}
+
+export type CampaignPostingDetailsContactInfo = {
+    emailAddress?: string | null
+    name?: string | null
+    phoneNumber?: string | null
+}
+
+export type CampaignPostingDetailsOrganization = {
+    companyLogo: string
+    name: string
+}
+
+export type CampaignProductPostingDetailsSalaryIndicationRange = {
+    currency?: string | null
+    from?: number | null
+    to: number
+}
+
+export type CampaignPostingDetailsSalaryIndication = {
+    period: SalaryPeriod
+    range: CampaignProductPostingDetailsSalaryIndicationRange
+}
+
+export type CampaignPostingDetailsWeeklyWorkingHours = {
+    to: number
+    from?: number | null
+}
+
+export type CampaignPostingDetailsWorkingLocation = {
+    addressLine1: string
+    addressLine2: string
+    allowsRemoteWork?: boolean | number | null
+    city: string
+    country: string
+    postCode?: string | null
+    postcode: string
+}
+
+export type CampaignPostingDetails = {
+    applicationUrl: string
+    contactInfo: CampaignPostingDetailsContactInfo
+    description: string
+    employmentType: EmploymentType
+    jobPageUrl: string
+    organization: CampaignPostingDetailsOrganization
+    salaryIndication: CampaignPostingDetailsSalaryIndication
+    title: string
+    weeklyWorkingHours: CampaignPostingDetailsWeeklyWorkingHours
+    workingLocation: CampaignPostingDetailsWorkingLocation
+    yearsOfExperience: number
+}
+
+export type CampaignPosting = {
+    clicks: number
+    name: string
+    productId: string
+}
+
+export type CampaignRecruiterInfo = {
+    id?: number | null
+    name: string
+    emailAddress?: string | null
+}
+
+export type CampaignTargetGroupData = {
+    description: string
+    vonqId: string | number
+}
+
+export type CampaignTargetGroup = {
+    educationLevel: CampaignTargetGroupData[]
+    industry: CampaignTargetGroupData[]
+    jobCategory: CampaignTargetGroupData[]
+    seniority: CampaignTargetGroupData[]
+}
+
+export type CampaignTotalPrice = {
+    amount: number
+    currency: ProductPriceCurrency
+}
+
+export type CampaignStatus = "in progress" | "offline"
+
+export type CampaignDetailsStatusOrderedProductStatus = {
+    productId: string
+    status: CampaignStatus
+    statusDescription: string | null
+}
+
+export type CampaignDetailedStatus = {
+    campaignId: string
+    status: CampaignStatus
+    orderedProductsStatuses: CampaignDetailsStatusOrderedProductStatus[]
+}
+
+export type Campaign = {
+    currency: ProductPriceCurrency
+    campaignId: string
+    campaignName: string | null
+    companyId: string
+    createdOn: string
+    customerId: string
+    orderReference: string | null
+    orderedProducts: string[]
+    orderedProductsSpecs: CampaignProductSpecs[]
+    postingDetails: CampaignPostingDetails
+    postings: CampaignPosting[]
+    recruiterInfo: CampaignRecruiterInfo
+    status: CampaignStatus
+    targetGroup: CampaignTargetGroup
+    totalPrice: CampaignTotalPrice
+    walletId: string
+    detailedStatus?: CampaignDetailedStatus //this is only added virtually on FE on demand
+}
+
+export type CampaignCreateFormTargetGroupEducationLevel =
+    TaxonomyEducationAndSeniorityLevel
+
+export type CampaignCreateFormTargetGroupSeniority = TaxonomySeniority
+
+export type CampaignCreateFormTargetGroupIndustry = ProductIndustry
+
+export type CampaignCreateFormTargetGroupJobCategory = {
+    label: string
+    value: number
+}
+
+export type CampaignCreateFormTargetGroup = {
+    educationLevel: CampaignCreateFormTargetGroupEducationLevel[]
+    seniority: CampaignCreateFormTargetGroupSeniority[]
+    industry: CampaignCreateFormTargetGroupIndustry[]
+    jobCategory: CampaignCreateFormTargetGroupJobCategory[]
+}
+
+export type CampaignCreateFormOrderedProductSpecBase = {
+    productId: string
+    utm: string
+    contractId: string
+    postingRequirements: ContractPostingRequirement[]
+}
+export type CampaignCreateFormOrderedProductSpec =
+    CampaignCreateFormOrderedProductSpecBase & { [k: string]: any }
+
+export type CampaignCreateForm = {
+    companyId: string
+    campaignName?: string | null
+    poNumber?: string
+    targetGroup: CampaignCreateFormTargetGroup
+    recruiterInfo: CampaignRecruiterInfo
+    postingDetails: {
+        title: string
+        description: string
+        organization: CampaignPostingDetailsOrganization
+        workingLocation: CampaignPostingDetailsWorkingLocation
+        yearsOfExperience: number
+        employmentType: EmploymentType
+        weeklyWorkingHours: CampaignPostingDetailsWeeklyWorkingHours
+        salaryIndication: CampaignPostingDetailsSalaryIndication
+        contactInfo: CampaignPostingDetailsContactInfo
+        jobPageUrl: string
+        applicationUrl: string
+    }
+    orderedProducts: string[] //Array of UUIDs
+    orderedProductsSpecs: Record<string, CampaignCreateFormOrderedProductSpec>
+}
+
+export type CampaignOrderRequestBodyOrderedProductsSpec = {
+    contractId: string
+    utm: string
+    productId: string
+    postingRequirements?: any
+}
+
+export type CampaignOrderRequestBody = {
+    companyId: string
+    campaignName: string | null | undefined
+    walletId?: string
+    poNumber?: string
+    recruiterInfo: Omit<CampaignRecruiterInfo, "id">
+    postingDetails: CampaignPostingDetails
+    targetGroup: CampaignTargetGroup
+    orderedProducts: string[]
+    orderedProductsSpecs: CampaignOrderRequestBodyOrderedProductsSpec[]
+    currency: string
+}
+
+export type CampaignTaxonomyNameWithLanguage = {
+    languageCode: string
+    value: string
+}
+
+export type TaxonomyEducationLevelName = CampaignTaxonomyNameWithLanguage
+
+export type TaxonomySeniorityName = CampaignTaxonomyNameWithLanguage
+
+export type TaxonomySeniority = {
+    id: number
+    name: TaxonomySeniorityName[]
+}
+
+export type TaxonomyEducationAndSeniorityLevel = {
+    id: number
+    name: TaxonomyEducationLevelName[]
+}
+
+export type TaxonomyEmploymentTypes = {
+    value: EmploymentType
+    label: string
+}
+export type TransformedPostingRequirementOption = {
+    value?: string
+    options?: { label: string; value: string; data?: any[] }[]
+    label: string
+}
+export type TransformedPostingRequirement = Omit<
+    ContractPostingRequirement,
+    "options"
+> & {
+    options: TransformedPostingRequirementOption[] | null
+}

package/src/campaign/utils.types.ts

@@ -0,0 +1,59 @@
+import {
+    Campaign,
+    CampaignCreateForm,
+    CampaignCreateFormOrderedProductSpec,
+    CampaignCreateFormTargetGroup,
+    CampaignCreateFormTargetGroupEducationLevel,
+    CampaignCreateFormTargetGroupIndustry,
+    CampaignCreateFormTargetGroupJobCategory,
+    CampaignCreateFormTargetGroupSeniority,
+    CampaignOrderRequestBody,
+    CampaignOrderRequestBodyOrderedProductsSpec,
+    CampaignTargetGroup,
+    CampaignTargetGroupData,
+} from "./types"
+import { Product } from "../product/types"
+import { Contract } from "../contract/types"
+import { BasketProduct } from "../basket/types"
+import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiUtilsCampaign = WindowHapiModuleWithConstructorArgs<
+    {
+        getInitialCampaignForm: () => CampaignCreateForm
+        mapCampaignsAndUpdateById: (
+            campaignId: string,
+            campaign: Partial<Campaign>,
+        ) => void
+        getOrderCampaignRequestBody: () => CampaignOrderRequestBody
+        getCopyCampaignRequestBody: (
+            campaign: Campaign,
+        ) => CampaignOrderRequestBody
+        getPostBodyValuesForTargetGroupProperty: (
+            selectValue:
+                | CampaignCreateFormTargetGroupEducationLevel[]
+                | CampaignCreateFormTargetGroupSeniority[]
+                | CampaignCreateFormTargetGroupIndustry[]
+                | CampaignCreateFormTargetGroupJobCategory[]
+                | undefined,
+            type: "educationLevel" | "seniority" | "industry" | "jobCategory",
+        ) => CampaignTargetGroupData[]
+        getPostBodyForTargetGroup: (
+            targetGroup: CampaignCreateFormTargetGroup,
+        ) => CampaignTargetGroup
+        getPostBodyForOrderedProductsFromBasketProducts: (
+            productsOrContracts: (Contract | Product)[],
+        ) => string[]
+        getPostBodyForOrderedProductsSpecs: (
+            products: (Product | Contract)[],
+            orderedProductsSpecs: Record<
+                string,
+                CampaignCreateFormOrderedProductSpec
+            >,
+        ) => CampaignOrderRequestBodyOrderedProductsSpec[]
+        getPostBodyForOrderedProductsSpecsPostingRequirement: (
+            postingRequirement: any,
+        ) => any
+    },
+    { readonly utils: WindowHapiUtils }
+>