@vonq/hapi-elements-types 1.8.0 → 1.10.0

package/orderJourney/validations.types.ts

@@ -1,25 +1,42 @@
 import {
     ZodArray,
     ZodBoolean,
+    ZodNativeEnum,
     ZodObject,
     ZodOptional,
     ZodRecord,
     ZodString,
     ZodTypeAny,
+    ZodUnion,
 } from "zod"
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
 import { ZodIntlDescriptor } from "../common/validations.types"
 
 export type ZodOrderJourneyStep = ZodObject<{
     key: ZodString
-    titleIntlDescriptor: ZodIntlDescriptor
-    descriptionIntlDescriptor: ZodIntlDescriptor
+    titleIntlDescriptor: ZodOptional<ZodIntlDescriptor>
+    descriptionIntlDescriptor: ZodOptional<ZodIntlDescriptor>
     isSubmitted: ZodOptional<ZodBoolean>
     blurredFields: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
     errorMessagesIntlDescriptors: ZodOptional<ZodRecord<ZodString, ZodTypeAny>>
 }>
 
 export type ZodOrderJourneySteps = ZodArray<ZodOrderJourneyStep>
+export type ZodOrderJourneyUTMCodeMap = ZodObject<{
+    mapToName: ZodBoolean
+    value: ZodString
+    key: ZodString
+}>
+export type ZodOrderJourneyUTMCodeMaps = ZodArray<ZodOrderJourneyUTMCodeMap>
+export type ZodOrderJourneyUTMCodesStepData = ZodObject<{
+    settings: ZodOrderJourneyUTMCodeMaps
+    productUTMs: ZodRecord<ZodString, ZodOrderJourneyUTMCodeMaps>
+}>
+export type ZodOrderJourneyOrderReviewStepData = ZodObject<{
+    accordionsOpen: ZodArray<
+        ZodUnion<[ZodNativeEnum<typeof OrderJourneyStepKey>, ZodString]>
+    >
+}>
 export type WindowHapiValidationsOrderJourney = {
     supportedStepKeys: OrderJourneyStepKey[]
     stepKeysRegex: RegExp
@@ -31,4 +48,8 @@ export type WindowHapiValidationsOrderJourney = {
     paymentMethods: ZodArray<ZodString>
     supportedPaymentMethods: OrderJourneyPaymentMethod[]
     paymentMethodsRegex: RegExp
+    utmMap: ZodOrderJourneyUTMCodeMap
+    utmMaps: ZodOrderJourneyUTMCodeMaps
+    utmCodesStepData: ZodOrderJourneyUTMCodesStepData
+    orderReviewStepData: ZodOrderJourneyOrderReviewStepData
 }

package/package.json

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

package/product/state.types.ts

@@ -10,84 +10,29 @@ 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
+    /* Search Text */
+    searchTextInput: string
 }

package/product/types.ts

@@ -8,7 +8,7 @@ import {
 export type ProductRange = "hours" | "days" | "weeks" | "months"
 
 export type ProductIndustry = {
-    id: number
+    id: number | string
     name: string
 }
 
@@ -64,14 +64,16 @@ export type Product = {
 } & ProductLogos &
     ProductType
 
+export type ProductBoardType =
+    | "aggregator"
+    | "job board"
+    | "service"
+    | "social media"
+    | "publication"
+    | "community"
+
 export type ProductType = {
-    type:
-        | "aggregator"
-        | "job board"
-        | "service"
-        | "social media"
-        | "publication"
-        | "community"
+    type: ProductBoardType
 }
 
 export type ProductLogos = {
@@ -100,6 +102,8 @@ export type ProductLocationPlaceType =
     | "continent"
     | "country"
     | "region"
+    | "place"
+    | "district"
 
 export type ProductLocation = {
     bounding_box: any[]
@@ -116,6 +120,7 @@ export type ProductFilterQueryParams = {
     jobIndustriesIdsSelected: number[]
     filterProductRecommendations: ProductFilterRecommendations
     filterMyContractSupportedOnly: boolean
+    searchTextInput: string
 }
 
 export type ProductSearchFilters = {

package/product/validations.types.ts

@@ -7,6 +7,7 @@ import {
     ZodObject,
     ZodOptional,
     ZodString,
+    ZodUnion,
 } from "zod"
 import { ProductPriceCurrency } from "./enums"
 import { ZodPaginationResponseV1 } from "../common/validations.types"
@@ -30,7 +31,7 @@ export type ZodProductDuration = ZodObject<{
 }>
 
 export type ZodProductIndustry = ZodObject<{
-    id: ZodNumber
+    id: ZodUnion<[ZodNumber, ZodString]>
     name: ZodString
 }>
 export type ZodProductIndustries = ZodArray<ZodProductIndustry>

package/theming/types.ts

@@ -39,6 +39,7 @@ declare const useTheme: UseThemeFactory<DefaultTheme>
 
 export type ThemeGlobalStyles = {
     borderRadius: string
+    borderColor: string
 
     primaryBackgroundColor: string
     primaryTextColor: string
@@ -67,6 +68,9 @@ export type ThemeGlobalStyles = {
 
     accentBackgroundColor: string
     accentTextColor: string
+
+    scrollBarTrackColor: string
+    scrollBarThumbColor: string
 }
 
 export type HapiThemingThemeProvider = Theming<HapiTheme>["ThemeProvider"]
@@ -80,6 +84,7 @@ export type HapiThemeRule =
     | "loadingSpinner"
     | "userJourneyBar"
     | "card"
+    | "productCard"
     | "tabHeaders"
     | "tabHeader"
     | "tabPanels"
@@ -98,6 +103,7 @@ export type HapiThemeRule =
     | "buttonFaded"
     | "buttonAccent"
     | "badgeBase"
+    | "formFieldLabel"
     | "formFieldBase"
     | "inputSelectBase"
     | "input"

package/ui/service.types.ts

@@ -3,6 +3,8 @@ import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
     {
+        onIframeLoaded: (callback: (iframeName: string) => void) => void
+        onIframeUnloaded: (callback: (iframeName: string) => void) => void
         setStyleAttribute: (
             selector: string,
             attributeName: string,
@@ -11,12 +13,12 @@ export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
         setStyle: (selector: string, style: any) => Promise<void>
         addClass: (selector: string, className: string) => Promise<void>
         removeClass: (selector: string, className: string) => Promise<void>
-        appendChild: (
-            containerSelector: string,
+        appendChildToSlot: (
+            slotId: string,
             element: HTMLElement,
         ) => Promise<void>
-        removeChild: (
-            containerSelector: string,
+        removeChildFromSlot: (
+            slotId: string,
             elementSelector: string,
         ) => Promise<void>
         hideElement: (elementSelector: string) => Promise<void>

package/wallet/state.types.ts

@@ -6,53 +6,17 @@ import {
 } from "./types"
 
 export type WalletState = {
-    /**
-     * User's Wallet that can hold credits to be used on Creating/Ordering a Campaign
-     */
     wallet: Wallet | null
-    /**
-     * User's balance in dollars converted from cents through `wallet.balance`. **This value is a computed getter meaning that it cannot be set from outside**
-     */
     balanceInUSD: number | null
-    /**
-     * Indicates whether or not user has enough credits/balance to Order a Campaign
-     */
     balanceIsEnoughToOrderCampaign: boolean
-    /**
-     * Shows a loading spinner while wallet is loading
-     */
     walletIsLoading: boolean
-    /**
-     * The request body to be sent to HAPI Backend Service to create a payment intent. **This value is a computed getter meaning that it cannot be set from outside**
-     */
     paymentIntentRequestBody: WalletPaymentIntentRequest | null
     paymentIntentClientSecret: string | null
-    /**
-     * Shows a loading spinner while PaymentIntent is creating
-     */
     topUpIsLoading: boolean
-    /**
-     * A custom amount to specify for the top up of balance
-     */
     topUpAmount: number
-    /**
-     * A minimum amount enforced by an ATS for the top up of balance
-     */
     topUpMinAmount: number
-    /**
-     * A minimum amount's currency enforced by an ATS for the top up of balance
-     */
     topUpMinAmountCurrency: ProductPriceCurrency
-    /**
-     * Indicates if user has agreed to terms of service
-     */
     topUpTermsOfServiceIsAgreed: boolean
-    /**
-     * Step of the popup. **Should not be edited from outside**
-     */
     topUpCurrentStepIndex: number
-    /**
-     * An array of payment method types that Stripe accepts https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_types to specify which types of payment methods the end user can use
-     */
     topUpPaymentMethodTypes: WalletPaymentIntentPaymentMethod[]
 }