@vonq/hapi-elements-types 1.3.0 → 1.5.0

package/src/product/types.ts

@@ -0,0 +1,161 @@
+import { ProductFilterRecommendations, ProductPriceCurrency } from "./enums"
+import {
+    ContractCredential,
+    ContractFacet,
+    ContractPostingRequirement,
+} from "../contract/types"
+
+export type ProductRange = "hours" | "days" | "weeks" | "months"
+
+export type ProductIndustry = {
+    id: number
+    name: string
+}
+
+export type ProductLocationPartial = {
+    id: number
+    canonical_name: string
+}
+
+export type ProductLogoUrl = {
+    url: string
+}
+
+export type ProductLogoUrlWithSize = ProductLogoUrl & {
+    size: string
+}
+
+export type ProductPrice = {
+    amount: number
+    currency: ProductPriceCurrency
+}
+
+export type ProductDuration = {
+    range: ProductRange
+    period: number
+}
+
+export type ProductSupportingContractsPartial = {
+    id: number
+    name: string
+    url: string
+    type: string
+    mc_enabled: boolean
+}
+export type Product = {
+    allow_orders: boolean
+    audience_group: "niche" | "generic"
+    cross_postings: string[]
+    channel: ProductSupportingContractsPartial
+    description: string | null
+    title: string
+    duration: ProductDuration
+    homepage: string | null
+    industries: ProductIndustry[]
+    job_functions: ProductJobFunctionPartial[]
+    locations: ProductLocationPartial[]
+    mc_enabled: boolean
+    mc_only: boolean
+    product_id: string
+    ratecard_price: ProductPrice[]
+    vonq_price: ProductPrice[]
+    time_to_process: ProductDuration
+    time_to_setup: ProductDuration
+} & ProductLogos &
+    ProductType
+
+export type ProductType = {
+    type:
+        | "aggregator"
+        | "job board"
+        | "service"
+        | "social media"
+        | "publication"
+        | "community"
+}
+
+export type ProductLogos = {
+    logo_rectangle_url?: ProductLogoUrlWithSize[] | null
+    logo_square_url?: ProductLogoUrlWithSize[] | null
+    logo_url?: ProductLogoUrl[] | null
+}
+
+export type ProductJobFunctionPartial = {
+    id: number
+    name: string
+}
+
+export type ProductJobFunction = {
+    children?: ProductJobFunction[]
+} & ProductJobFunctionPartial
+
+export type ProductJobTitle = {
+    id: number
+    name: string
+    job_function: ProductJobFunctionPartial | null
+}
+
+export type ProductLocationPlaceType =
+    | "world"
+    | "continent"
+    | "country"
+    | "region"
+
+export type ProductLocation = {
+    bounding_box: any[]
+    place_type: ProductLocationPlaceType[]
+    fully_qualified_place_name: string
+    within?: ProductLocation
+} & ProductLocationPartial
+
+export type ProductFilterQueryParams = {
+    productNameInput: string
+    locationsIdsSelected: number[]
+    jobTitlesIdsSelected: number[]
+    jobFunctionsIdsSelected: number[]
+    jobIndustriesIdsSelected: number[]
+    filterProductRecommendations: ProductFilterRecommendations
+    filterMyContractSupportedOnly: boolean
+}
+
+export type ProductSearchFilters = {
+    currency?: string //ISO-4217
+    durationFrom?: string //number of days
+    durationTo?: string //number of days
+    exactLocationId?: string // Location ID
+    excludeRecommended?: boolean
+    includeLocationId?: string //regular string or comma seperated string
+    industryId?: string
+    jobFunctionId?: string
+    jobTitleId?: string //can't be used with jobFunctionId
+    mcEnabled?: boolean
+    name?: string
+    recommended?: boolean
+    sortBy?:
+        | "relevant"
+        | "recent"
+        | "order_frequency.desc"
+        | "order_frequency.asc"
+        | "created.desc"
+        | "created.asc"
+        | "list_price.desc"
+        | "list_price.asc"
+}
+
+export type ProductWithSupportForContractsFilters = {
+    search?: string
+}
+export type ProductSupportingContractsComplete = ProductLogos &
+    ProductSupportingContractsPartial & {
+        contract_credentials: ContractCredential[]
+        contract_facets?: ContractFacet[]
+        feed_url: string | null
+        manual_setup_required: boolean
+        posting_requirements: ContractPostingRequirement[]
+        setup_instructions: string //html;
+    }
+
+export type ProductUserProvidedFilters = Omit<
+    ProductFilterQueryParams,
+    "filterProductRecommendations" | "filterMyContractSupportedOnly"
+>

package/src/product/utils.types.ts

@@ -0,0 +1,22 @@
+import { ProductFilterQueryParams, ProductUserProvidedFilters } from "./types"
+import { PaginationResponseV1 } from "../common/types"
+import { ModuleWithConstructorArgs } from "../types"
+import {
+    OrderJourneyPaymentMethod,
+    OrderJourneyStepKey,
+} from "../orderJourney/enums"
+import { WindowHapiUtils } from "../_window/utils.types"
+
+export type WindowHapiUtilsProduct = ModuleWithConstructorArgs<
+    {
+        getUserProvidedFilters: () => ProductUserProvidedFilters
+        getProductsQueryParams: (
+            params: Partial<ProductFilterQueryParams>,
+            paginationOptions?: PaginationResponseV1 | null,
+        ) => URLSearchParams
+        getNextPageOffsetAndLimit: (
+            meta: PaginationResponseV1,
+        ) => PaginationResponseV1
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/src/product/validations.types.ts

@@ -0,0 +1,189 @@
+import {
+    ZodAny,
+    ZodArray,
+    ZodBoolean,
+    ZodNullable,
+    ZodNumber,
+    ZodObject,
+    ZodOptional,
+    ZodString,
+} from "zod"
+import { ProductPriceCurrency } from "./enums"
+import { ZodPaginationResponseV1 } from "../common/validations.types"
+
+export type ZodProductCrossPosting = ZodString
+export type ZodProductCrossPostings = ZodArray<ZodProductCrossPosting>
+export type ZodProductDescription = ZodString
+export type ZodProductHomepage = ZodString
+
+export type ZodProductChannel = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+    url: ZodString
+    type: ZodString
+    mc_enabled: ZodBoolean
+}>
+
+export type ZodProductDuration = ZodObject<{
+    range: ZodString
+    period: ZodNumber
+}>
+
+export type ZodProductIndustry = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+}>
+export type ZodProductIndustries = ZodArray<ZodProductIndustry>
+
+export type ZodProductJobFunction = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+}>
+export type ZodProductJobFunctions = ZodArray<ZodProductJobFunction>
+export type ZodProductLocationPartial = ZodObject<{
+    id: ZodNumber
+    canonical_name: ZodString
+}>
+export type ZodProductLocationsPartial = ZodArray<ZodProductLocationPartial>
+export type ZodProductLocationBoundingBox = ZodAny
+export type ZodProductLocationBoundingBoxes =
+    ZodArray<ZodProductLocationBoundingBox>
+export type ZodProductLocationPlaceType = ZodString
+export type ZodProductLocationPlaceTypes = ZodArray<ZodProductLocationPlaceType>
+export type ZodProductLocation = ZodObject<{
+    bounding_box: ZodProductLocationBoundingBoxes
+    place_type: ZodProductLocationPlaceTypes
+    fully_qualified_place_name: ZodString
+    within: ZodOptional<ZodAny>
+    canonical_name: ZodString
+    id: ZodNumber
+}>
+export type ZodProductLocations = ZodArray<ZodProductLocation>
+export type ZodProductPrice = ZodObject<{
+    amount: ZodNumber
+    currency: ZodString
+}>
+export type ZodProductPrices = ZodArray<ZodProductPrice>
+export type ZodProductLogoWithSize = ZodObject<{
+    size: ZodString
+    url: ZodString
+}>
+export type ZodProductLogosWithSizes = ZodArray<ZodProductLogoWithSize>
+export type ZodProductLogoUrl = ZodObject<{
+    url: ZodString
+}>
+export type ZodProductLogoUrls = ZodArray<ZodProductLogoUrl>
+export type ZodProductJobTitle = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+}>
+export type ZodProductJobTitles = ZodArray<ZodProductJobTitle>
+export type ZodProductFilters = ZodObject<{
+    currency: ZodOptional<ZodString>
+    durationFrom: ZodOptional<ZodString>
+    durationTo: ZodOptional<ZodString>
+    exactLocationId: ZodOptional<ZodString>
+    excludeRecommended: ZodOptional<ZodBoolean>
+    includeLocationId: ZodOptional<ZodString>
+    industryId: ZodOptional<ZodString>
+    jobFunctionId: ZodOptional<ZodString>
+    jobTitleId: ZodOptional<ZodString>
+    mcEnabled: ZodOptional<ZodBoolean>
+    name: ZodOptional<ZodString>
+    recommended: ZodOptional<ZodBoolean>
+    sortBy: ZodOptional<ZodString>
+}>
+export type ZodProductWithSupportForContractsFilters = ZodObject<{
+    search: ZodString
+}>
+
+export type ZodProduct = ZodObject<{
+    allow_orders: ZodBoolean
+    audience_group: ZodString
+    cross_postings: ZodProductCrossPostings
+    channel: ZodNullable<ZodProductChannel>
+    description: ZodNullable<ZodProductDescription>
+    duration: ZodProductDuration
+    homepage: ZodNullable<ZodProductHomepage>
+    industries: ZodProductIndustries
+    job_functions: ZodProductJobFunctions
+    locations: ZodProductLocationsPartial
+    mc_enabled: ZodBoolean
+    mc_only: ZodBoolean
+    product_id: ZodString
+    ratecard_price: ZodProductPrices
+    vonq_price: ZodProductPrices
+    title: ZodString
+    time_to_process: ZodProductDuration
+    time_to_setup: ZodProductDuration
+    logo_rectangle_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_square_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_url: ZodOptional<ZodNullable<ZodProductLogoUrls>>
+    type: ZodNullable<ZodString>
+}>
+
+export type ZodProducts = ZodArray<ZodProduct>
+
+export type ZodProductWithContractSupport = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+    url: ZodString
+    type: ZodString
+    mc_enabled: ZodBoolean
+}>
+
+export type ZodProductWithContractSupportComplete = ZodObject<{
+    url: ZodString
+    type: ZodString
+    setup_instructions: ZodString
+    posting_requirements: ZodArray<ZodAny>
+    manual_setup_required: ZodBoolean
+    feed_url: ZodNullable<ZodString>
+    contract_facets: ZodOptional<ZodArray<ZodAny>>
+    contract_credentials: ZodArray<ZodAny>
+    id: ZodNumber
+    name: ZodString
+    mc_enabled: ZodBoolean
+    logo_rectangle_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_square_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_url: ZodOptional<ZodNullable<ZodProductLogoUrls>>
+}>
+export type WindowHapiValidationsProduct = {
+    type: string[]
+    typeRegex: RegExp
+    audienceGroup: string[]
+    audienceGroupRegex: RegExp
+    range: string[]
+    rangeRegex: RegExp
+    currencies: ProductPriceCurrency[]
+    currencyRegex: RegExp
+    currency: ZodString
+    searchSortBy: string[]
+    searchSortByRegex: RegExp
+    placeTypes: string[]
+    placeTypesRegex: RegExp
+    logoWithSize: ZodProductLogoWithSize
+    logo: ZodProductLogoUrl
+    channel: ZodProductChannel
+    duration: ZodProductDuration
+    industry: ZodProductIndustry
+    industries: ZodProductIndustries
+    jobFunction: ZodProductJobFunction
+    jobFunctions: ZodProductJobFunctions
+    location: ZodProductLocationPartial
+    locations: ZodProductLocationsPartial
+    price: ZodProductPrice
+    prices: ZodProductPrices
+    product: ZodProduct
+    products: ZodProducts
+    productWithContractSupport: ZodProductWithContractSupport
+    productsWithContractSupport: ZodArray<ZodProductWithContractSupport>
+    productWithContractSupportComplete: ZodProductWithContractSupportComplete
+    productLocation: ZodProductLocation
+    productLocations: ZodProductLocations
+    jobTitle: ZodProductJobTitle
+    jobTitles: ZodProductJobTitles
+    filters: ZodProductFilters
+    filterForContracts: ZodProductWithSupportForContractsFilters
+    productsPaginationMeta: ZodNullable<ZodPaginationResponseV1>
+}

package/src/routing/functions.types.ts

@@ -0,0 +1,48 @@
+export type RouterStoreSetParentWindowQueryParamsHandler = (
+    params: Record<string, string>,
+) => void
+export type RouterStoreSetParentWindowPathnameHandler = (
+    pathname: string,
+) => void
+export type RouterStoreSetParentWindowOriginHandler = (origin: string) => void
+export type RouterStoreSetLastScrollPositionHandler = (position: number) => void
+export type RouterStoreSetRedirectUrlHandler = (url?: string) => void
+export type RouterStoreSetIsRedirectingHandler = (
+    isRedirecting: boolean,
+) => void
+export type RouterStoreSetCurrentRoutePathNameHandler = (
+    pathname: string,
+) => void
+export type RouterStoreSetPreviousRoutePathNameHandler = (
+    pathname: string,
+) => void
+export type RouterStoreSetCurrentAsPathHandler = (pathname: string) => void
+export type RouterStoreSetPreviousAsPathHandler = (pathname: string) => void
+export type RouterStoreSetPreviousHashHandler = (
+    hash: string | undefined,
+) => void
+export type RouterStoreSetCurrentHashHandler = (
+    hash: string | undefined,
+) => void
+export type RouterStoreFunctions = {
+    /**
+     * The function that sets the value of `lastScrollPosition`. Refer to [RouterStoreState](/docs/api/modules#routertorestate) for more details. **This function is called automatically when route changes and should not be called from outside**
+     */
+    setLastScrollPosition: RouterStoreSetLastScrollPositionHandler
+    /**
+     * The function that sets the value of `redirectUrl`. Refer to [RouterStoreState](/docs/api/modules#routertorestate) for more details.
+     */
+    setRedirectUrl: RouterStoreSetRedirectUrlHandler
+    /**
+     * The function that sets the value of `isRedirecting`. Refer to [RouterStoreState](/docs/api/modules#routertorestate) for more details.
+     */
+    setIsRedirecting: RouterStoreSetIsRedirectingHandler
+    /**
+     * The function that sets the value of `currentAsPath`. Refer to [RouterStoreState](/docs/api/modules#routertorestate) for more details. **This function is called automatically when route changes and should not be called from outside**
+     */
+    setCurrentAsPath: RouterStoreSetCurrentAsPathHandler
+    /**
+     * The function that sets the value of `previousAsPath`. Refer to [RouterStoreState](/docs/api/modules#routertorestate) for more details. **This function is called automatically when route changes and should not be called from outside**
+     */
+    setPreviousAsPath: RouterStoreSetPreviousAsPathHandler
+}

package/src/routing/index.ts

@@ -0,0 +1,5 @@
+// created from 'create-ts-index'
+
+export * from './functions.types';
+export * from './state.initial';
+export * from './state.types';

package/src/routing/state.initial.ts

@@ -0,0 +1,10 @@
+import { RouterStoreState } from "./state.types"
+import { isBrowser } from "../common/browser"
+
+export const initialRouterStoreState: RouterStoreState = {
+    currentAsPath: isBrowser ? window.location.pathname : "",
+    previousAsPath: isBrowser ? window.location.pathname : "",
+    redirectUrl: "",
+    isRedirecting: false,
+    lastScrollPosition: 0,
+}

package/src/routing/state.types.ts

@@ -0,0 +1,30 @@
+export type RouteTransitionOptions = {
+    shallow?: boolean
+}
+export type RouterState = {
+    url: string
+    as: string
+    options: RouteTransitionOptions
+}
+export type RouterStoreState = {
+    /**
+     * Holds the current route "asPath" (NextJS Router related) path URL
+     */
+    currentAsPath: string
+    /**
+     * Holds the previous route "asPath" (NextJS Router related) path URL
+     */
+    previousAsPath: string
+    /**
+     * Specifies a redirectUrl to land on after a certain action is completed
+     */
+    redirectUrl: string | undefined
+    /**
+     * Shows loading spinner while user is being redirected
+     */
+    isRedirecting: boolean
+    /**
+     * Captures lastScrollPosition in Y axis before a route changes, useful when the position is going to be restored later
+     */
+    lastScrollPosition: number
+}