@vonq/hapi-elements-types 1.40.0 → 1.42.0

package/_window/api.types.ts

@@ -4,7 +4,7 @@ import {
     RawAxiosRequestConfig,
     RawAxiosRequestHeaders,
 } from "axios"
-import { WindowHapiModuleName } from "../common/enums"
+import { WindowHapiModuleName, WindowHapiSubmoduleName } from "../common/enums"
 import { WindowHapiAPIATS } from "../ats/api.types"
 import { WindowHapiAPICampaign } from "../campaign/api.types"
 import { WindowHapiAPIContract } from "../contract/api.types"
@@ -111,11 +111,17 @@ export type WindowHapiAPI = WindowHapiModuleWithConstructorArgs<
         headers: RawAxiosRequestHeaders
         setHeaders: (headers: RawAxiosRequestHeaders) => void
         baseRequestConfig: RawAxiosRequestConfig<any>
-        makeDataRequest: (
-            method: "get" | "put" | "patch",
+        makeElementsAPIRequest: (
+            method: string,
             endpoint: string,
             data?: any,
+            params?: Record<string, any>,
         ) => Promise<any>
+        makeSDKUsageElementsAPIRequest: (
+            moduleName: WindowHapiSubmoduleName,
+            functionName: string,
+            functionType?: string,
+        ) => void
         modules: WindowHapiAPIModules
     } & WindowHapiAPIModules,
     { readonly core: WindowHapiClassInterface }

package/_window/config.types.ts

@@ -3,3 +3,7 @@ export type DebugPanelPosition =
     | "bottom-right"
     | "top-left"
     | "top-right"
+
+export type HE_SDK_USAGE_LOG_FLAG_OBJECT_TYPE = {
+    __he_skipLoggingSDKUsage: boolean
+}

package/_window/instances.types.ts

@@ -6,6 +6,7 @@ import { WindowHapiLogger } from "../common/logger/types"
 
 export type WindowHapiInstances = WindowHapiModuleWithConstructorArgs<
     {
+        logger: WindowHapiLogger
         instances: WindowHapiInstance[]
         readyInstances: string[]
         getFrameWindowByName: (name: string) => Window | undefined

package/_window/qa.types.ts

@@ -10,6 +10,7 @@ import { WindowHapiQAContract } from "../contract/qa.types"
 import { WindowHapiQATheming } from "../theming/qa.types"
 import { WindowHapiQALanguage } from "../language/qa.types"
 import { WindowHapiQAProduct } from "../product/qa.types"
+import { WindowHapiLogger } from "../common"
 
 export type WindowHapiQA = WindowHapiModuleWithConstructorArgs<
     {
@@ -20,6 +21,7 @@ export type WindowHapiQA = WindowHapiModuleWithConstructorArgs<
         [WindowHapiModuleName.theming]: WindowHapiQATheming
         [WindowHapiModuleName.language]: WindowHapiQALanguage
         [WindowHapiModuleName.common]: WindowHapiQACommon
+        logger: WindowHapiLogger
 
         isDebugPanelOpen: boolean
 

package/_window/service.types.ts

@@ -29,6 +29,7 @@ export type HapiServiceFunctionLifecycleHookHandler = (
 
 export type HapiServiceFunctionWithLifecycleHooks<HandlerType> = {
     run: HandlerType
+    runWithoutSDKUsageLog: HandlerType
     onStart: HapiServiceFunctionLifecycleHookHandler
     onSuccess: HapiServiceFunctionLifecycleHookHandler
     onFailure: HapiServiceFunctionLifecycleHookHandler

package/_window/ui.types.ts

@@ -2,6 +2,7 @@ import {
     WindowHapiModuleWithConstructorArgs,
     WindowHapiClassInterface,
 } from "./window"
+import { WindowHapiLogger } from "../common"
 
 export type WindowHapiUIElementNameForAddingToBody =
     | "he-ui-modals"
@@ -9,6 +10,7 @@ export type WindowHapiUIElementNameForAddingToBody =
 
 export type WindowHapiUI = WindowHapiModuleWithConstructorArgs<
     {
+        logger: WindowHapiLogger
         addUIElementToBody: (
             elementName: WindowHapiUIElementNameForAddingToBody,
         ) => void

package/_window/utils.types.ts

@@ -13,10 +13,11 @@ import { WindowHapiUtilsRouter } from "../routing/utils.types"
 import { WindowHapiUtilsLanguage } from "../language/utils.types"
 import { WindowHapiUtilsAlert } from "../alert/utils.types"
 
-import { FlattenedItem } from "../common"
+import { FlattenedItem, WindowHapiLogger } from "../common"
 
 export type WindowHapiUtils = WindowHapiModuleWithConstructorArgs<
     {
+        logger: WindowHapiLogger
         isObject: (item: any) => boolean
         mergeDeepOverwriteArrays: (original: any, overwrites: any) => any
         flattenObject: (

package/ats/api.types.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestConfig } from "axios/index"
-import { ATSMessage, ATSSettings, ATSUserTokenResponse } from "./types"
+import { ATSSettings, ATSUserTokenResponse } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
@@ -15,8 +15,6 @@ export type WindowHapiAPIATSRequests = {
     refreshJWTToken: () => Promise<ATSUserTokenResponse>
     validateJWTToken: () => Promise<boolean>
     getUserData: () => Promise<any>
-    getMessages: () => Promise<ATSMessage[]>
-    sendMessage: (ticket: ATSMessage) => Promise<ATSMessage[]>
 }
 export type WindowHapiAPIATS = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<WindowHapiAPIATSRequests, WindowHapiAPIATSConfigs>,

package/ats/service.types.ts

@@ -2,26 +2,20 @@ import {
     HapiServiceFunctionWithLifecycleHooks,
     WindowHapiService,
 } from "../_window/service.types"
-import { ATSMessage, ATSSettings, ATSUserData } from "./types"
+import { ATSSettings, ATSUserData } from "./types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type ATSServiceGetUserSettingsHandler = () => Promise<
     ATSSettings | undefined
 >
 
-export type ATSServiceGetUserDataHandler = () => Promise<ATSUserData | undefined>
-
-export type ATSServiceGetMessagesHandler = () => Promise<ATSMessage[]>
-
-export type ATSServiceSendMessageHandler = (
-    message: ATSMessage,
-) => Promise<ATSMessage[]>
+export type ATSServiceGetUserDataHandler = () => Promise<
+    ATSUserData | undefined
+>
 
 export type WindowHapiServiceATS = WindowHapiModuleWithConstructorArgs<
     {
         getUserSettings: HapiServiceFunctionWithLifecycleHooks<ATSServiceGetUserSettingsHandler>
-        getMessages: HapiServiceFunctionWithLifecycleHooks<ATSServiceGetMessagesHandler>
-        sendMessage: HapiServiceFunctionWithLifecycleHooks<ATSServiceSendMessageHandler>
     },
     { readonly service: WindowHapiService }
 >

package/ats/types.ts

@@ -24,10 +24,13 @@ export type ATSUserSettings = {
     can_use_wallets: boolean
     can_pay_with_direct_charge: boolean
     invoice_currency: string | null
-    smartfill: {
+    smartfill?: {
         vacancy_fields: boolean | null
         posting_requirements: boolean | null
     }
+    direct_apply?: {
+        enabled: boolean
+    }
 }
 export type ATSSettings = {
     payment_settings: ATSUserPaymentSetting[]
@@ -51,17 +54,3 @@ export type ATSUserData = {
 export type ATSUserTokenResponse = {
     token: string
 }
-
-export type ATSMessage = {
-    id?: string
-    sender: "ats" | "vonq"
-    createdAt?: string
-    message: string
-}
-
-export type ATSDataResponse = {
-    data: {
-        messages: ATSMessage[]
-    }
-    type: "elements"
-}

package/campaign/api.types.ts

@@ -9,6 +9,9 @@ import {
     CampaignPostingRequirementsSuggestionsGetRequestResponse,
     CampaignPostingRequirementsValidateRequestBody,
     CampaignSetProductStatusRequestBody,
+    CampaignVacancyFieldsSuggestionCreateRequest,
+    CampaignVacancyFieldsSuggestionCreateRequestResponse,
+    CampaignVacancyFieldsSuggestionsGetRequestResponse,
     TaxonomyEducationAndSeniorityLevel,
 } from "./types"
 import { ProductSupportingContractsComplete } from "../product/types"
@@ -30,6 +33,8 @@ export type WindowHapiAPICampaignConfigs = {
     setProductStatus: AxiosRequestConfig
     getSuggestionOfPostingRequirements: AxiosRequestConfig
     createSuggestionOfPostingRequirements: AxiosRequestConfig
+    getSuggestionOfVacancyFields: AxiosRequestConfig
+    createSuggestionOfVacancyFields: AxiosRequestConfig
 }
 export type WindowHapiAPICampaignRequests = {
     getCampaigns: (
@@ -71,6 +76,12 @@ export type WindowHapiAPICampaignRequests = {
     createSuggestionOfPostingRequirements: (
         payload: CampaignPostingRequirementsSuggestionCreateRequest,
     ) => Promise<CampaignPostingRequirementsSuggestionCreateRequestResponse>
+    getSuggestionOfVacancyFields: (
+        suggestionId: string,
+    ) => Promise<CampaignVacancyFieldsSuggestionsGetRequestResponse>
+    createSuggestionOfVacancyFields: (
+        payload: CampaignVacancyFieldsSuggestionCreateRequest,
+    ) => Promise<CampaignVacancyFieldsSuggestionCreateRequestResponse>
 }
 export type WindowHapiAPICampaign = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<

package/campaign/service.types.ts

@@ -13,6 +13,8 @@ import {
     CampaignPostingRequirementsSuggestionCreateRequestResponse,
     CampaignPostingRequirementsSuggestionsGetRequestResponse,
     CampaignSetProductStatusRequestBody,
+    CampaignVacancyFieldsSuggestionCreateRequestResponse,
+    CampaignVacancyFieldsSuggestionsGetRequestResponse,
     TaxonomyEducationAndSeniorityLevel,
     TaxonomyEmploymentTypes,
 } from "./types"
@@ -79,11 +81,21 @@ export type CampaignServiceGetEmploymentTypesHandler = () => Promise<
     TaxonomyEmploymentTypes[]
 >
 export type CampaignServiceCreateSuggestionOfPostingRequirementsHandler = (
-    contractIds: (string | number)[],
+    contractId: string | number,
+    customDescription?: string,
+    customContextObject?: Record<string, any>,
 ) => Promise<CampaignPostingRequirementsSuggestionCreateRequestResponse>
 export type CampaignServiceGetSuggestionOfPostingRequirementsHandler = (
     taskId: string,
 ) => Promise<CampaignPostingRequirementsSuggestionsGetRequestResponse>
+export type CampaignServiceCreateSuggestionOfVacancyFieldsHandler = (
+    customDescription?: string,
+    customContextObject?: Record<string, any>,
+) => Promise<CampaignVacancyFieldsSuggestionCreateRequestResponse>
+export type CampaignServiceGetSuggestionOfVacancyFieldsHandler = (
+    taskId: string,
+    excludedDotNotatedObjectPathsOfCampaignForm?: string[],
+) => Promise<CampaignVacancyFieldsSuggestionsGetRequestResponse>
 
 export type WindowHapiServiceCampaign = WindowHapiModuleWithConstructorArgs<
     {
@@ -112,6 +124,8 @@ export type WindowHapiServiceCampaign = WindowHapiModuleWithConstructorArgs<
         getEmploymentTypes: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetEmploymentTypesHandler>
         createSuggestionOfPostingRequirements: HapiServiceFunctionWithLifecycleHooks<CampaignServiceCreateSuggestionOfPostingRequirementsHandler>
         getSuggestionOfPostingRequirements: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetSuggestionOfPostingRequirementsHandler>
+        createSuggestionOfVacancyFields: HapiServiceFunctionWithLifecycleHooks<CampaignServiceCreateSuggestionOfVacancyFieldsHandler>
+        getSuggestionOfVacancyFields: HapiServiceFunctionWithLifecycleHooks<CampaignServiceGetSuggestionOfVacancyFieldsHandler>
     },
     { readonly service: WindowHapiService }
 >

package/campaign/state.types.ts

@@ -3,7 +3,7 @@ import {
     CampaignCreateForm,
     CampaignCreateFormDraft,
     CampaignEditForm,
-    CampaignPostingRequirementsSuggestionStatus,
+    CampaignSuggestionStatus,
     TaxonomyEducationAndSeniorityLevel,
     TaxonomyEmploymentTypes,
     TaxonomySeniority,
@@ -33,7 +33,16 @@ export type CampaignState = {
         string,
         {
             createdAt: string
-            status: CampaignPostingRequirementsSuggestionStatus
+            status: CampaignSuggestionStatus
+        }
+    >
+    /* Vacancy Fields Suggestions */
+    vacancyFieldsSuggestionsPollingIntervalsMap: Record<string, number>
+    vacancyFieldsSuggestionsPollingStatusMap: Record<
+        string,
+        {
+            createdAt: string
+            status: CampaignSuggestionStatus
         }
     >
 }

package/campaign/types.ts

@@ -2,7 +2,11 @@ import { ProductDuration, ProductIndustry } from "../product/types"
 import { ProductPriceCurrency } from "../product/enums"
 import { EmploymentType, SalaryPeriod } from "./enums"
 import { OrderJourneyPaymentMethod } from "../orderJourney"
-import { PostingRequirement, PostingRequirementLabelsMap } from "../common"
+import {
+    PostingRequirement,
+    PostingRequirementLabelsMap,
+    RecursivePartial,
+} from "../common"
 
 export type CampaignProductSpecs = {
     contractId: string | null
@@ -361,7 +365,7 @@ export type CampaignIdResponse = {
 }
 
 export type CampaignPostingRequirementsSuggestionCreateRequest = {
-    contract_ids: (string | number)[]
+    contract_id: string | number
     context: {
         structured: Record<string, any>
         unstructured: string
@@ -372,7 +376,18 @@ export type CampaignPostingRequirementsSuggestionCreateRequestResponse = {
     smartfill_task_id: string
 }
 
-export type CampaignPostingRequirementsSuggestionStatus =
+export type CampaignVacancyFieldsSuggestionCreateRequest = {
+    context: {
+        structured: Record<string, any>
+        unstructured: string
+    }
+}
+
+export type CampaignVacancyFieldsSuggestionCreateRequestResponse = {
+    smartfill_task_id: string
+}
+
+export type CampaignSuggestionStatus =
     | "queued"
     | "started"
     | "completed"
@@ -380,13 +395,18 @@ export type CampaignPostingRequirementsSuggestionStatus =
 
 export type CampaignPostingRequirementsSuggestionsGetRequestResponse = {
     id: string
-    status: CampaignPostingRequirementsSuggestionStatus
-    smartfills: {
-        contract_id: string
-        channel_id: string
-        status: CampaignPostingRequirementsSuggestionStatus
-        created_at: string
-        updated_at: string
-        prefill_data: Record<string, any>
-    }[]
+    status: CampaignSuggestionStatus
+    contract_id: string
+    channel_id: string
+    created_at: string
+    updated_at: string
+    prefill_data: Record<string, any>
+}
+
+export type CampaignVacancyFieldsSuggestionsGetRequestResponse = {
+    id: string
+    status: CampaignSuggestionStatus
+    created_at: string
+    updated_at: string
+    prefill_data: RecursivePartial<CampaignCreateForm>
 }

package/common/types.ts

@@ -133,6 +133,7 @@ export type PostingRequirementType =
     | "AUTOCOMPLETE"
     | "STATISCH"
     | "HTMLAREA"
+    | "QUESTIONNAIRE"
 
 export type PostingRequirementRuleName =
     | "int"
@@ -194,6 +195,75 @@ export type PostingRequirementAutocomplete = {
     required_parameters: string[] | null
     parameters_source: PostingRequirementParametersSource | null
 }
+
+export type UNSTABLE_PostingRequirementQuestionnaireQuestion = {
+    maxLength?: number
+    minLength?: number
+    maxQuestions?: number
+    htmlAllowed?: string
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaireClosedQuestionItem = {
+    maxLength: number
+    minLength: number
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaireClosedQuestionItems = {
+    item: UNSTABLE_PostingRequirementQuestionnaireClosedQuestionItem[]
+    maxOccurs: number
+    minOccurs: number
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaireText = {
+    limit?: number
+    formats?: string
+    min?: string
+    max?: string
+    question: UNSTABLE_PostingRequirementQuestionnaireQuestion
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaireClosedQuestion = {
+    items: UNSTABLE_PostingRequirementQuestionnaireClosedQuestionItems
+    question: UNSTABLE_PostingRequirementQuestionnaireQuestion
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaireSettings = {
+    ordered: boolean
+    editable: boolean
+    maxQuestions: number
+    maxOpenQuestions: number
+    supportsRequired: boolean
+    maxClosedQuestions: number
+    supportsConditions: boolean
+}
+
+export type UNSTABLE_PostingRequirementQuestionnaire = {
+    types: UNSTABLE_PostingRequirementQuestionnaireType[]
+    text?: UNSTABLE_PostingRequirementQuestionnaireText
+    choice?: UNSTABLE_PostingRequirementQuestionnaireClosedQuestion
+    "multi-choice"?: UNSTABLE_PostingRequirementQuestionnaireClosedQuestion
+    hier?: UNSTABLE_PostingRequirementQuestionnaireClosedQuestion
+    questionnaire: UNSTABLE_PostingRequirementQuestionnaireSettings
+}
+export type UNSTABLE_PostingRequirementQuestionnaireType =
+    | "text"
+    | "choice"
+    | "multi-choice"
+    | "textarea"
+    | "page-break"
+    | "date"
+    | "file"
+    | "hier"
+    | "information"
+
+export type UNSTABLE_PostingRequirementQuestionnaireQuestionBodyToStringify = {
+    id: string
+    question: string
+    type: UNSTABLE_PostingRequirementQuestionnaireType
+    is_required: boolean
+    answers: { answer: string }[]
+}
+
 export type PostingRequirement = {
     name: string
     label: string
@@ -201,6 +271,7 @@ export type PostingRequirement = {
     display_rules: PostingRequirementDisplayRule | null
     autocomplete: PostingRequirementAutocomplete | null
     options: PostingRequirementOption[] | null
+    questionnaire: UNSTABLE_PostingRequirementQuestionnaire | null
     primary_taxonomy?: string | null
     message?: string | null
     required: boolean
@@ -272,6 +343,7 @@ export type FormFacetsFieldType =
     | "date"
     | "heading"
     | "file-upload"
+    | "questionnaire"
     | "unknown"
 
 // keep this for backwards compatability

package/experimental/enums.ts

@@ -1,7 +1,4 @@
-export enum ExperimentalModalKeys {
-    contractPostingRequirementsSmartFillSuccess = "__experimental-contract-posting-requirements-smart-fill-success",
-    campaignVacancyFieldsSmartFillSuccess = "__experimental-campaign-vacancy-fields-smart-fill-success",
-}
+export enum ExperimentalModalKeys {}
 
 export enum ExperimentalFilePickerModalPropsActionFor {
     productPostingRequirements = "product-posting-requirements",

package/package.json

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