@vonq/hapi-elements-types 1.24.0 → 1.26.0

package/__experimental/index.ts

@@ -0,0 +1,52 @@
+import { RecursivePartial } from "../common"
+import { Campaign, CampaignOrderRequestBody } from "../campaign"
+
+export enum ExperimentalSuggestionEndpointName {
+    "postingRequirements" = "posting_requirements",
+    "vacancyFields" = "vacancy_fields",
+    "primaryTaxonomy" = "primary_taxonomy",
+}
+
+export type ExperimentalSuggestionResponseStatus =
+    | "new"
+    | "pending"
+    | "error"
+    | "done"
+
+export type ExperimentalSuggestionCreateRequestData<P> = {
+    contract_id?: string
+    payload: P
+}
+
+export type ExperimentalSuggestionGetResponseData<P, R> = {
+    id: string
+    status: ExperimentalSuggestionResponseStatus
+    contract_id?: string
+    type: ExperimentalSuggestionEndpointName
+    payload: P
+    response: R
+}
+
+export type ExperimentalSuggestionPostingRequirementsCreateRequestPayload =
+    RecursivePartial<CampaignOrderRequestBody>
+
+export type ExperimentalSuggestionPostingRequirementsGetResponseData = Record<
+    string,
+    string | null | number | any[]
+>
+
+export type ExperimentalSuggestionVacancyFieldsCreateRequestPayload = {
+    description: string
+}
+
+export type ExperimentalSuggestionVacancyFieldsGetResponseData =
+    RecursivePartial<Campaign>
+
+export type ExperimentalSuggestionPrimaryTaxonomyCreateRequestPayload = {
+    description: string
+}
+
+export type ExperimentalSuggestionPrimaryTaxonomyGetResponseData = Record<
+    string,
+    string
+>

package/_window/utils.types.ts

@@ -11,6 +11,7 @@ import {
 import { WindowHapiUtilsModal } from "../modal/utils.types"
 import { WindowHapiUtilsRouter } from "../routing/utils.types"
 import { WindowHapiUtilsLanguage } from "../language/utils.types"
+import { WindowHapiUtilsAlert } from "../alert/utils.types"
 
 export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
     {
@@ -44,6 +45,7 @@ export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
         modal: WindowHapiUtilsModal
         router: WindowHapiUtilsRouter
         language: WindowHapiUtilsLanguage
+        alert: WindowHapiUtilsAlert
 
         utilities: {
             [WindowHapiModuleName.basket]: WindowHapiUtilsBasket
@@ -54,6 +56,7 @@ export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
             [WindowHapiModuleName.modal]: WindowHapiUtilsModal
             [WindowHapiModuleName.router]: WindowHapiUtilsRouter
             [WindowHapiModuleName.language]: WindowHapiUtilsLanguage
+            [WindowHapiModuleName.alert]: WindowHapiUtilsAlert
         }
     },
     { readonly core: WindowHapiClassInterface }

package/alert/enums.ts

@@ -3,6 +3,7 @@ export enum AlertKey {
     topupSuccess = "topup-success",
     contractRemoveSuccess = "contract-removed",
     contractCreateSuccess = "contract-created",
+    contractEditSuccess = "contract-edited",
     contractGroupCreateSuccess = "contract-group-created",
     campaignTakeOfflineSuccess = "campaign-take-offline-success",
     campaignProductTakeOfflineSuccess = "campaign-product-take-offline-success",
@@ -14,6 +15,7 @@ export enum AlertKey {
     productAddToBasket = "add-product-to-basket-success",
     productRemoveFromBasket = "remove-product-from-basket-warning",
     utmCodeConfirmation = "utm-code-confirmation",
+    __experimentalCampaignVacancyFieldsSmartFillEmpty = "__experimental-campaign-vacancy-fields-smart-fill-empty",
 }
 
 export enum AlertType {

package/alert/types.ts

@@ -11,6 +11,10 @@ export type ContractCreateSuccessAlertProps = {
     contractName: string
 }
 
+export type ContractEditSuccessAlertProps = {
+    contractName: string
+}
+
 export type ContractRemoveSuccessAlertProps = {
     contractName: string
 }
@@ -32,6 +36,8 @@ export type UTMCodesSuccessAlertProps = {
     type: "save" | "reset"
 }
 
+export type ExperimentalCampaignVacancyFieldsAIPrefillEmptyAlertProps = {}
+
 export type ButtonCopySuccessAlertProps = {}
 
 export type CampaignOrderSuccessAlertProps = {}

package/alert/utils.types.ts

@@ -0,0 +1,10 @@
+import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+import { AlertKey } from "./enums"
+
+export type WindowHapiUtilsAlert = WindowHapiModuleWithConstructorArgs<
+    {
+        alertKeys: typeof AlertKey
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/ats/types.ts

@@ -24,6 +24,7 @@ export type ATSUserSettings = {
     can_use_wallets: boolean
     can_pay_with_direct_charge: boolean
     invoice_currency: string | null
+    ai_suggestions: boolean
 }
 export type ATSSettings = {
     payment_settings: ATSUserPaymentSetting[]

package/campaign/enums.ts

@@ -9,6 +9,7 @@ export enum EmploymentType {
 }
 
 export enum SalaryPeriod {
-    MONTHLY = "monthly",
-    YEARLY = "yearly",
+    hourly = "hourly",
+    monthly = "monthly",
+    yearly = "yearly",
 }

package/campaign/qa.types.ts

@@ -7,6 +7,7 @@ export type WindowHapiQACampaign = WindowHapiModuleWithConstructorArgs<
         useMockCampaignForm: () => CampaignCreateForm
         getRandomCampaignId: () => Promise<string>
         setCampaignFormDebuggerIsShown: (isEnabled: boolean) => boolean
+        setCampaignCardDebuggerIsShown: (isEnabled: boolean) => boolean
     },
     { readonly qa: WindowHapiQA }
 >

package/campaign/service.types.ts

@@ -16,7 +16,6 @@ import {
 import { PaginatedAPIResponseV2 } from "../common/types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 import { AlertKey } from "../alert"
-import { EmploymentType } from "./enums"
 
 export type CampaignServiceGetCampaignsHandler = (
     offset?: number,

package/campaign/utils.types.ts

@@ -24,6 +24,11 @@ import {
     OrderJourneyOrderErrors,
     OrderJourneyOrderErrorsCampaignIsValidButPostingRequirementsInvalid,
 } from "../orderJourney"
+import {
+    FormFacetsFieldType,
+    PostingRequirement,
+    TransformedPostingRequirement,
+} from "../common"
 
 export type WindowHapiUtilsCampaign = WindowHapiModuleWithConstructorArgs<
     {
@@ -73,6 +78,9 @@ export type WindowHapiUtilsCampaign = WindowHapiModuleWithConstructorArgs<
             newErrors: OrderJourneyOrderErrorsCampaignIsValidButPostingRequirementsInvalid,
             indexOfNewPostingRequirements: number,
         ) => OrderJourneyOrderErrors
+        getPostingRequirementFormFieldType: (
+            requirement: TransformedPostingRequirement | PostingRequirement,
+        ) => FormFacetsFieldType
     },
     { readonly utils: WindowHapiUtils }
 >

package/common/types.ts

@@ -268,10 +268,10 @@ export type FormFacetsFieldType =
     | "select-tree-async"
     | "select-tree"
     | "select-tree-autocomplete"
-    | "input-tag"
-    | "date"
     | "select-autocomplete"
     | "select-multi-autocomplete"
+    | "input-tag"
+    | "date"
     | "heading"
     | "file-upload"
     | "unknown"

package/contract/api.types.ts

@@ -4,6 +4,7 @@ import {
     ContractCreateForm,
     ContractGroup,
     ContractGroupCreateForm,
+    ContractEditForm,
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
@@ -14,6 +15,7 @@ export type WindowHapiAPIContractConfigs = {
     getContractsByIds: AxiosRequestConfig
     getContract: AxiosRequestConfig
     createContract: AxiosRequestConfig
+    saveContract: AxiosRequestConfig
     removeContract: AxiosRequestConfig
     getPostingRequirementOptions: AxiosRequestConfig
     getGroups: AxiosRequestConfig
@@ -30,6 +32,7 @@ export type WindowHapiAPIContractRequests = {
     ) => Promise<PaginatedAPIResponseV1<Contract>>
     getContract: (contractId: string) => Promise<Contract>
     createContract: (contract: ContractCreateForm) => Promise<Contract>
+    saveContract: (contract: ContractEditForm) => Promise<Contract>
     getPostingRequirementOptions: (
         contractId: string,
         fieldName: string,

package/contract/service.types.ts

@@ -27,6 +27,7 @@ export type ContractServiceGetContractsLabeledHandler = (
     labels?: Record<string, string> | null,
 ) => Promise<PaginatedAPIResponseV1<Contract>>
 export type ContractServiceCreateContractHandler = () => Promise<Contract>
+export type ContractServiceSaveContractHandler = () => Promise<Contract>
 export type ContractServiceRemoveContractHandler = (
     contractId: string,
 ) => Promise<void>
@@ -44,6 +45,7 @@ export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
         getContractGroups: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractGroupsHandler>
         createContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceCreateContractHandler>
         removeContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceRemoveContractHandler>
+        saveContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceSaveContractHandler>
         createContractGroup: HapiServiceFunctionWithLifecycleHooks<ContractServiceCreateContractGroupHandler>
         getContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractHandler>
         initiateOauthLogin: (

package/contract/state.types.ts

@@ -5,6 +5,7 @@ import {
     ContractGroup,
     ContractGroupCreateForm,
     ContractGroupSelected,
+    ContractEditForm,
 } from "./types"
 import { PaginationResponseV1 } from "../common/types"
 
@@ -16,7 +17,7 @@ export type ContractState = {
     contractSelectedId: string | number | null
     contractSelected: ProductSupportingContractsComplete | null
     contractSelectedIsLoading: boolean
-    contractForm: ContractCreateForm
+    contractForm: ContractCreateForm | ContractEditForm
     contractCreateError: any
     contractFormIsValid: boolean | null
     /* Contracts Groups */

package/contract/types.ts

@@ -24,25 +24,29 @@ export type ContractPurchasePrice = {
 export type ContractCreateFormCredentials = Record<string, string>
 
 export type ContractCreateForm = {
-    id?: number
+    id?: number | string
     credentials?: ContractCreateFormCredentials
-    facets?: any
+    facets?: any | null
     expiry_date: string | null
     alias: string | null
-    purchase_price: ContractPurchasePrice
+    purchase_price: ContractPurchasePrice | null
     credits: string | null
     followed_instructions: boolean
     posting_duration_days: number | null
     allow_renegotiation: boolean
     labels: Record<string, string> | null
+    posting_requirements_defaults: Record<string, string | string[]> | null
 }
 
+export type ContractEditForm = ContractCreateForm
+
 export type ContractGroupCreateForm = {
     name: string
 }
 
 export type ContractChannel = ProductLogos &
     ProductType & {
+        allows_edit?: boolean
         id: number
         name: string
         url: string
@@ -58,11 +62,11 @@ export type Contract = {
     credits: number | null
     customer_id: string
     expiry_date: string | null
-    facets?: any[]
     product: ContractProduct
     purchase_price: ContractPurchasePrice | null
     posting_duration_days: number | null
     group: ContractGroup | null
+    posting_requirements_defaults: Record<string, string | string[]> | null
 }
 
 export type ContractGroup = {

package/contract/validations.types.ts

@@ -34,10 +34,12 @@ export type ZodContractProduct = ZodObject<{
     title: ZodString
 }>
 export type ZodContractPurchasePrice = ZodOptional<
-    ZodObject<{
-        amount: ZodNullable<ZodNumber>
-        currency: ZodNullable<ZodString>
-    }>
+    ZodNullable<
+        ZodObject<{
+            amount: ZodNullable<ZodNumber>
+            currency: ZodNullable<ZodString>
+        }>
+    >
 >
 export type ZodContractGroup = ZodObject<{
     id: ZodOptional<ZodString>
@@ -52,7 +54,7 @@ export type ZodContractGroupCreateForm = ZodObject<{
     name: ZodString
 }>
 export type ZodContractCreateForm = ZodObject<{
-    id: ZodOptional<ZodNumber>
+    id: ZodOptional<ZodUnion<[ZodNumber, ZodString]>>
     credentials: ZodOptional<ZodObject<any>>
     facets: ZodContractFacets
     alias: ZodContractAlias

package/debugging/state.types.ts

@@ -1,5 +1,6 @@
 export type DebuggingState = {
     campaignFormDebuggerIsShown: boolean
+    campaignCardDebuggerIsShown: boolean
     localeDebuggingIsEnabled: boolean
     componentDebuggingIsEnabled: boolean
     consoleLogsAreEnabled: boolean

package/modal/enums.ts

@@ -18,12 +18,14 @@ export enum ModalKeys {
     basketProductBundleParentClashConfirmation = "basket-product-bundle-parent-clash-confirmation",
     basketProductBundleChildClashConfirmation = "basket-product-bundle-child-clash-confirmation",
     contractRemoveConfirmation = "contract-remove-confirmation",
+    contractEdit = "contract-edit",
     contractGroupConflictInfo = "contract-group-conflict-info",
     filePicker = "file-picker",
-    contractPostingRequirementsSmartFillSuccess = "contract-posting-requirements-smart-fill-success",
     "mediaEditor" = "media-editor",
     "uploadWidget" = "upload-widget",
     "mediaLibrary" = "media-library",
+    __experimentalContractPostingRequirementsSmartFillSuccess = "__experimental-contract-posting-requirements-smart-fill-success",
+    __experimentalCampaignVacancyFieldsSmartFillSuccess = "__experimental-campaign-vacancy-fields-smart-fill-success",
 }
 
 export enum FilePickerModalPropsActionFor {

package/modal/types.ts

@@ -1,7 +1,11 @@
 import { Product } from "../product/types"
 import { Contract } from "../contract/types"
 import { FilePickerModalPropsActionFor, ModalKeys, ModalZone } from "./enums"
-import { AnyNonFunction, TransformedPostingRequirement } from "../common/types"
+import {
+    AnyNonFunction,
+    RecursivePartial,
+    TransformedPostingRequirement,
+} from "../common/types"
 import { Campaign } from "../campaign"
 import { OrderJourneyPaymentMethod } from "../orderJourney"
 import { PickerDisplayMode } from "filestack-js"
@@ -20,6 +24,7 @@ export type CampaignProductTakeOfflineConfirmationModalProps = {
     productId: string
 }
 export type ContractRemoveConfirmationModalProps = { contractId: string }
+export type ContractEditJourneyModalProps = { contractId: string }
 export type ContractGroupConflictInfoModalProps = {
     contract: Contract
     conflictingContracts: Contract[]
@@ -44,6 +49,9 @@ export type ContractPostingRequirementsSmartFillResponseModalProps = {
     postingRequirements: Record<string, TransformedPostingRequirement>
     contractId: string
 }
+export type CampaignVacancyFieldsSmartFillResponseModalProps = {
+    response: RecursivePartial<Campaign>
+}
 export type FilePickerOptions = {
     accept?: string[]
     uploadInBackground?: boolean

package/package.json

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

package/product/service.types.ts

@@ -25,6 +25,9 @@ export type ProductServiceGetFilteredProductsHandler = (
     filters?: Partial<ProductFilterQueryParams>,
 ) => Promise<Product[]>
 export type ProductServiceLoadMoreProductsHandler = () => Promise<Product[]>
+export type ProductServiceLoadMoreFreeAddOnProductsHandler = () => Promise<
+    Product[]
+>
 export type ProductServiceGetProductWithContractsSupportByIdHandler = (
     id: string | number,
 ) => Promise<ProductSupportingContractsComplete>
@@ -34,6 +37,7 @@ export type ProductServiceGetProductsWithContractsSupportHandler = (
 export type ProductServiceGetRecommendedProductsHandler = () => Promise<
     Product[]
 >
+export type ProductServiceGetFreeAddOnProductsHandler = () => Promise<Product[]>
 export type ProductServiceGetProductHandler = (
     productId: number | string,
 ) => Promise<Product>
@@ -76,11 +80,13 @@ export type ProductServiceGetProductPostingRequirementsHandler = (
 export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
     {
         loadMoreProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceLoadMoreProductsHandler>
+        loadMoreFreeAddOnProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceLoadMoreFreeAddOnProductsHandler>
         setArbitraryJobTitle: ProductServiceSetArbitraryJobTitle
         getProductWithContractsSupportById: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductWithContractsSupportByIdHandler>
         getProductsWithContractsSupport: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsWithContractsSupportHandler>
         getFilteredProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetFilteredProductsHandler>
         getRecommendedProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetRecommendedProductsHandler>
+        getFreeAddOnProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetFreeAddOnProductsHandler>
         getProducts: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsHandler>
         getProduct: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductHandler>
         getLocations: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetLocationsHandler>

package/product/state.types.ts

@@ -13,6 +13,9 @@ export type ProductState = {
     /* Products */
     recommendedProducts: Product[]
     recommendedProductsAreLoading: boolean
+    freeAddOnProducts: Product[]
+    freeAddOnProductsAreLoading: boolean
+    freeAddOnProductsPaginationMeta: PaginationResponseV1 | null
     productsWithContractsSupport: ProductSupportingContractsPartial[]
     productsWithContractsSupportAreLoading: boolean
     products: Product[]