@vonq/hapi-elements-types 1.4.0 → 1.6.0

package/src/campaign/validations.types.ts

@@ -0,0 +1,215 @@
+import {
+    ZodAny,
+    ZodArray,
+    ZodNullable,
+    ZodNumber,
+    ZodObject,
+    ZodOptional,
+    ZodRecord,
+    ZodString,
+    ZodUnion,
+} from "zod"
+import { ZodProductDuration } from "../product/validations.types"
+
+export type ZodCampaignTotalPrice = ZodObject<{
+    amount: ZodNumber
+    currency: ZodString
+}>
+export type ZodCampaignEmploymentType = ZodObject<{
+    label: ZodString
+    value: ZodString
+}>
+export type ZodCampaignRecruiterInfo = ZodObject<{
+    id: ZodOptional<ZodNullable<ZodUnion<[ZodNumber, ZodString]>>>
+    name: ZodString
+    emailAddress: ZodOptional<ZodNullable<ZodString>>
+}>
+export type ZodCampaignTargetGroupData = ZodObject<{
+    description: ZodString
+    vonqId: ZodString
+}>
+export type ZodCampaignTargetGroupDatas = ZodArray<ZodCampaignTargetGroupData>
+export type ZodCampaignTargetGroup = ZodObject<{
+    educationLevel: ZodCampaignTargetGroupDatas
+    industry: ZodCampaignTargetGroupDatas
+    jobCategory: ZodCampaignTargetGroupDatas
+    seniority: ZodCampaignTargetGroupDatas
+}>
+export type ZodCampaignPosting = ZodObject<{
+    clicks: ZodNumber
+    name: ZodString
+    productId: ZodString
+}>
+export type ZodCampaignPostings = ZodArray<ZodCampaignPosting>
+export type ZodCampaignPostingDetailsContactInfo = ZodObject<{
+    emailAddress: ZodOptional<ZodNullable<ZodString>>
+    name: ZodOptional<ZodNullable<ZodString>>
+    phoneNumber: ZodOptional<ZodNullable<ZodString>>
+}>
+export type ZodCampaignPostingDetailsOrganization = ZodObject<{
+    companyLogo: ZodString
+    name: ZodString
+}>
+export type ZodCampaignPostingDetailsSalaryIndication = ZodObject<{
+    period: ZodString
+    range: ZodObject<{
+        currency: ZodOptional<ZodNullable<ZodString>>
+        from: ZodOptional<ZodNullable<ZodNumber>>
+        to: ZodNumber
+    }>
+}>
+export type ZodCampaignPostingDetailsWeeklyWorkingHours = ZodObject<{
+    from: ZodOptional<ZodNullable<ZodNumber>>
+    to: ZodNumber
+}>
+export type ZodCampaignPostingDetailsWorkingLocationPostCodeDefinition = {
+    postCode: ZodOptional<ZodNullable<ZodString>>
+}
+export type ZodCampaignPostingDetailsWorkingLocationAddressDetailsDefinition = {
+    addressLine1: ZodString
+    addressLine2: ZodOptional<ZodNullable<ZodString>>
+    allowsRemoteWork: ZodOptional<ZodNullable<ZodNumber>>
+    city: ZodString
+    country: ZodString
+    postcode: ZodString
+}
+export type ZodCampaignPostingDetailsWorkingLocation = ZodObject<
+    ZodCampaignPostingDetailsWorkingLocationAddressDetailsDefinition &
+        ZodCampaignPostingDetailsWorkingLocationPostCodeDefinition
+>
+export type ZodCampaignTaxonomyNameWithLanguage = ZodObject<{
+    languageCode: ZodString
+    value: ZodString
+}>
+export type ZodCampaignTaxonomyEducationLevel = ZodObject<{
+    id: ZodNumber
+    name: ZodArray<ZodCampaignTaxonomyNameWithLanguage>
+}>
+export type ZodCampaignTaxonomyEducationLevels =
+    ZodArray<ZodCampaignTaxonomyEducationLevel>
+export type ZodCampaignTaxonomySeniority = ZodObject<{
+    id: ZodNumber
+    name: ZodArray<ZodCampaignTaxonomyNameWithLanguage>
+}>
+export type ZodCampaignTaxonomySeniorities =
+    ZodArray<ZodCampaignTaxonomySeniority>
+export type ZodCampaignPostingDetails = ZodObject<{
+    applicationUrl: ZodString
+    description: ZodString
+    contactInfo: ZodCampaignPostingDetailsContactInfo
+    employmentType: ZodString
+    jobPageUrl: ZodString
+    organization: ZodCampaignPostingDetailsOrganization
+    salaryIndication: ZodCampaignPostingDetailsSalaryIndication
+    title: ZodString
+    weeklyWorkingHours: ZodCampaignPostingDetailsWeeklyWorkingHours
+    workingLocation: ZodCampaignPostingDetailsWorkingLocation
+    yearsOfExperience: ZodNumber
+}>
+export type ZodCampaignOrderedProductSpec = ZodObject<{
+    contractId: ZodNullable<ZodString>
+    postingRequirements: ZodNullable<ZodObject<any>>
+    productId: ZodString
+    utm: ZodNullable<ZodString>
+    deliveredOn: ZodNullable<ZodString>
+    duration: ZodString
+    durationPeriod: ZodProductDuration
+    jobBoardLink: ZodNullable<ZodString>
+    status: ZodString
+    statusDescription: ZodNullable<ZodString>
+}>
+export type ZodCampaignOrderedProductSpecs =
+    ZodArray<ZodCampaignOrderedProductSpec>
+export type ZodCampaignCreateFormOrderedProductSpecs = ZodRecord<
+    ZodString,
+    ZodAny
+>
+
+export type ZodCampaign = ZodObject<{
+    currency: ZodString
+    campaignId: ZodString
+    campaignName: ZodNullable<ZodString>
+    companyId: ZodString
+    createdOn: ZodString
+    customerId: ZodString
+    orderReference: ZodNullable<ZodString>
+    orderedProducts: ZodArray<ZodString>
+    orderedProductsSpecs: ZodCampaignOrderedProductSpecs
+    postingDetails: ZodCampaignPostingDetails
+    postings: ZodCampaignPostings
+    recruiterInfo: ZodCampaignRecruiterInfo
+    status: ZodString
+    targetGroup: ZodCampaignTargetGroup
+    totalPrice: ZodCampaignTotalPrice
+    walletId: ZodOptional<ZodNullable<ZodString>>
+    poNumber: ZodOptional<ZodNullable<ZodString>>
+}>
+export type ZodCampaigns = ZodArray<ZodCampaign>
+export type ZodCampaignCreateFormPostingDetails = ZodObject<{
+    title: ZodString
+    description: ZodString
+    organization: ZodCampaignPostingDetailsOrganization
+    workingLocation: ZodObject<ZodCampaignPostingDetailsWorkingLocationAddressDetailsDefinition>
+    yearsOfExperience: ZodNumber
+    employmentType: ZodString
+    weeklyWorkingHours: ZodCampaignPostingDetailsWeeklyWorkingHours
+    salaryIndication: ZodCampaignPostingDetailsSalaryIndication
+    jobPageUrl: ZodString
+    applicationUrl: ZodString
+}>
+export type ZodCampaignCreateFormTargetGroup = ZodObject<{
+    educationLevel: ZodCampaignTaxonomyEducationLevels
+    seniority: ZodCampaignTaxonomySeniorities
+    industry: ZodArray<ZodObject<{ id: ZodNumber; name: ZodString }>>
+    jobCategory: ZodArray<
+        ZodObject<{
+            label: ZodString
+            value: ZodNumber
+        }>
+    >
+}>
+export type ZodCampaignCreateForm = ZodObject<{
+    companyId: ZodString
+    campaignName: ZodOptional<ZodNullable<ZodString>>
+    targetGroup: ZodCampaignCreateFormTargetGroup
+    recruiterInfo: ZodCampaignRecruiterInfo
+    postingDetails: ZodCampaignCreateFormPostingDetails
+    orderedProductsSpecs: ZodCampaignCreateFormOrderedProductSpecs
+    orderedProducts: ZodArray<ZodString>
+}>
+export type WindowHapiValidationsCampaign = {
+    status: string[]
+    statusRegex: RegExp
+    supportedEmploymentType: string[]
+    employmentTypeRegex: RegExp
+    employmentType: ZodCampaignEmploymentType
+    employmentTypes: ZodArray<ZodCampaignEmploymentType>
+    salaryPeriod: string[]
+    salaryPeriodRegex: RegExp
+    totalPrice: ZodCampaignTotalPrice
+    recruiterInfo: ZodCampaignRecruiterInfo
+    targetGroupData: ZodCampaignTargetGroupData
+    targetGroupDatas: ZodCampaignTargetGroupDatas
+    targetGroup: ZodCampaignTargetGroup
+    posting: ZodCampaignPosting
+    postings: ZodCampaignPostings
+    postingDetailsContactInfo: ZodCampaignPostingDetailsContactInfo
+    postingDetailsOrganization: ZodCampaignPostingDetailsOrganization
+    postingDetailsSalaryIndication: ZodCampaignPostingDetailsSalaryIndication
+    postingDetailsWeeklyWorkingHours: ZodCampaignPostingDetailsWeeklyWorkingHours
+    postingDetailsWorkingLocation: ZodCampaignPostingDetailsWorkingLocation
+    nameWithLanguage: ZodCampaignTaxonomyNameWithLanguage
+    educationLevel: ZodCampaignTaxonomyEducationLevel
+    educationLevels: ZodCampaignTaxonomyEducationLevels
+    seniority: ZodCampaignTaxonomySeniority
+    seniorities: ZodCampaignTaxonomySeniorities
+    postingDetails: ZodCampaignPostingDetails
+    orderedProductsSpec: ZodCampaignOrderedProductSpec
+    orderedProductsSpecs: ZodCampaignOrderedProductSpecs
+    campaign: ZodCampaign
+    campaigns: ZodCampaigns
+    campaignForm: ZodCampaignCreateForm
+    campaignFormTargetGroup: ZodCampaignCreateFormTargetGroup
+    campaignFormPostingDetails: ZodCampaignCreateFormPostingDetails
+    campaignFormOrderedProductsSpecs: ZodCampaignCreateFormOrderedProductSpecs
+}

package/src/common/enums.ts

@@ -0,0 +1,42 @@
+export enum WindowHapiSubmoduleName {
+    "api" = "hapiApi",
+    auth = "hapiAuth",
+    config = "hapiConfig",
+    instances = "hapiInstances",
+    qa = "hapiQA",
+    routing = "hapiRouting",
+    sdk = "hapi",
+    service = "hapiService",
+    state = "hapiState",
+    ui = "hapiUI",
+    utils = "hapiUtils",
+    validation = "hapiValidation",
+    events = "hapiEvents",
+    instance = "hapiInstance",
+}
+
+export enum WindowHapiModuleName {
+    ats = "ats",
+    basket = "basket",
+    campaign = "campaign",
+    contract = "contract",
+    product = "product",
+    "common" = "common",
+    wallet = "wallet",
+    debugging = "debugging",
+    language = "language",
+    theming = "theming",
+    orderJourney = "orderJourney",
+    userJourney = "userJourney",
+    alert = "alert",
+    modal = "modal",
+    "ui" = "ui",
+}
+
+export enum WindowHapiSDKModuleName {
+    api = "api",
+    state = "state",
+    validation = "validation",
+    service = "service",
+    utils = "utils",
+}

package/src/common/events/EventCommand/enums.ts

@@ -0,0 +1,49 @@
+export enum WindowHapiEventCommandName {
+    /* State */
+    stateHydrate = "state:hydrate",
+    stateTransfer = "state:transfer",
+    stateRestore = "state:restore",
+    stateLoad = "state:load",
+    stateInit = "state:init",
+
+    /* Service */
+    serviceLoad = "service:load",
+    serviceInit = "service:init",
+    serviceRequest = "service:request",
+    serviceStart = "service:start",
+    serviceSuccess = "service:success",
+    serviceFailure = "service:failure",
+    serviceFinish = "service:finish",
+
+    /* Config */
+    configSetPartnerId = "config:partnerId",
+    configSetClientId = "config:clientId",
+    configSetAreLogsEnabled = "config:areLogsEnabled",
+
+    /* App */
+    appLoad = "app:load",
+
+    /* API */
+    apiRequest = "api:request",
+
+    /* QA */
+    qaRequest = "qa:request",
+
+    /* DOM */
+    domAppendChild = "dom:append-child",
+    domElementEvent = "dom:element-event",
+    domRemoveChild = "dom:remove-child",
+    domHideElement = "dom:hide-element",
+    domShowElement = "dom:show-element",
+    domSetStyleAttribute = "dom:set-style-attribute",
+    domAddClass = "dom:add-class",
+    domRemoveClass = "dom:remove-class",
+    domSlotAvailable = "dom:slot-available",
+
+    /* Location */
+    locationSetHref = "location:href",
+}
+
+export enum EventCommandErrorResponse {
+    stateNotFound = "state-undefined-or-not-found",
+}

package/src/common/events/EventCommand/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from './enums';
+export * from './types';

package/src/common/events/EventCommand/types.ts

@@ -0,0 +1,18 @@
+import { WindowHapiEventCommandName } from "./enums"
+
+export type WindowHapiEventCommandNames =
+    | WindowHapiEventCommandName
+    | `dom:element-event-${string}`
+
+export type WindowHapiEventCommandData =
+    | [string]
+    | [string, ...any[]]
+    | [...any[]]
+    | undefined
+
+export type WindowHapiEventCommandStatus =
+    | "pending"
+    | "dispatched"
+    | "resolved"
+    | "rejected"
+    | "consumed"

package/src/common/events/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from './EventCommand';
+export * from './types';

package/src/common/events/types.ts

@@ -0,0 +1,52 @@
+import {
+    WindowHapiEventCommandData,
+    WindowHapiEventCommandNames,
+    WindowHapiEventCommandStatus,
+} from "./EventCommand/types"
+import { WindowHapiInstance } from "../../_window"
+import { WindowHapiLogger } from "../logger/types"
+
+export type WindowHapiEventStrategy = {
+    handleEvent: (
+        event: WindowHapiEventCommand,
+    ) => Promise<WindowHapiEventCommand>
+}
+
+export type WindowHapiEventMediatorInstances = {
+    source: WindowHapiInstance
+    targets: WindowHapiInstance[]
+}
+
+export type WindowHapiEventMediatorGetInstancesHandler =
+    () => WindowHapiEventMediatorInstances
+
+export type WindowHapiEventCommand = {
+    id: string
+    name: WindowHapiEventCommandNames
+    createdAt: string
+    updatedAt: string | undefined
+    status: WindowHapiEventCommandStatus
+    logger: WindowHapiLogger
+    instance?: WindowHapiInstance
+    data: WindowHapiEventCommandData | undefined
+    sourceInstanceName: string
+    targetInstancesNames: string[]
+    toJSON: Record<string, any>
+}
+
+export type WindowHapiEventCommandCallbackHandler = (data: any) => void
+export type WindowHapiEventCommandCommitHandler = (
+    ...args: any[]
+) => void | never | Promise<void | never>
+
+export type WindowHapiEventCommandWithCallback = WindowHapiEventCommand & {
+    callback?: WindowHapiEventCommandCallbackHandler
+}
+
+export type WindowHapiEventListener = {
+    id?: string
+    name: WindowHapiEventCommandNames
+    callback:
+        | WindowHapiEventCommandCallbackHandler
+        | WindowHapiEventCommandCommitHandler
+}

package/src/common/index.ts

@@ -0,0 +1,7 @@
+// created from 'create-ts-index'
+
+export * from "./events"
+export * from "./qa.types"
+export * from "./types"
+export * from "./validations.types"
+export * from "./enums"

package/src/common/logger/enums.ts

@@ -0,0 +1,12 @@
+export enum LogLevel {
+    Off = 0,
+    Error,
+    Warning,
+    Info,
+    Debug,
+}
+
+export enum NetworkErrorLoggerType {
+    "XHR" = "XHR",
+    "WS" = "WS",
+}

package/src/common/logger/types.ts

@@ -0,0 +1,18 @@
+import { LogLevel } from "./enums"
+
+export type LogOutput = (
+    source: string,
+    level: LogLevel,
+    ...objects: any[]
+) => void
+
+export type WindowHapiLogger = {
+    id: string
+    setIsEnabled: (isEnabled: boolean) => void
+    debug: (...objects: any[]) => void
+    info: (...objects: any[]) => void
+    warn: (...objects: any[]) => void
+    error: (...objects: any[]) => void
+    timeStart: (message: string) => void
+    timeEnd: (message: string) => void
+}

package/src/common/qa.types.ts

@@ -0,0 +1,9 @@
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiQACommon = WindowHapiModuleWithConstructorArgs<
+    {
+        setComponentDebuggingIsEnabled: (isEnabled: boolean) => boolean
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/common/types.ts

@@ -0,0 +1,109 @@
+import validator from "validator"
+import { MessageDescriptor } from "react-intl"
+import { WindowHapiLogger } from "./logger/types"
+import { Validators } from "./validator/types"
+
+export type ValueOf<T> = T[keyof T]
+export type AnyNonFunction<T> = Omit<T, "function">
+export declare type PrimitiveType =
+    | string
+    | number
+    | boolean
+    | null
+    | undefined
+    | Date
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+export type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>
+}
+export type PartialRecord<K extends keyof any, T> = Partial<Record<K, T>>
+export type RemoveIndex<T> = {
+    [K in keyof T as string extends K
+        ? never
+        : number extends K
+        ? never
+        : K]: T[K]
+}
+export type PaginationLimitOffset = {
+    limit?: number
+    offset?: number
+}
+export type PaginationResponseV1 = {
+    count?: number
+    next?: string | null
+    previous?: string | null
+} & PaginationLimitOffset
+export type PaginationResponseV2 = {
+    total?: number
+    meta?: {
+        first: string
+        last: string
+        next: string
+        previous: string
+    }
+} & PaginationLimitOffset
+export type PaginatedAPIResponseV1<T> = {
+    results: T[]
+} & PaginationResponseV1
+export type PaginatedAPIResponseV2<T> = {
+    data: T[]
+} & PaginationResponseV2
+export type HapiInputErrorMessageOrValidity =
+    | MessageDescriptor
+    | boolean
+    | undefined
+    | null
+export type UseValidatorResult = {
+    validityOrErrorMessages: Record<string, HapiInputErrorMessageOrValidity>
+    areAllValid: boolean
+}
+export type ValidatorKey =
+    | Exclude<
+          keyof typeof validator,
+          | "version"
+          | "AlphaLocale"
+          | "isAlphaLocales"
+          | "AlphanumericLocale"
+          | "isAlphanumericLocales"
+          | "ibanLocales"
+          | "FloatLocale"
+          | "isFloatLocales"
+          | "MobilePhoneLocale"
+          | "PhoneLocale"
+          | "PhoneLocaleAlias"
+          | "isMobilePhoneLocales"
+          | "PostalCodeLocale"
+          | "isPostalCodeLocales"
+      >
+    | keyof Validators
+export type NestedValidatorKeys =
+    | ValidatorKey
+    | {
+          [k: string]: ValidatorKey | NestedValidatorKeys
+      }
+export type BaseService = {
+    logger: WindowHapiLogger
+}
+// the reason there are no types like enums here is because
+// the options should be a serializable JSON during generation of web component files
+export type HapiWebComponent = {
+    title: string
+    description: string
+    moduleName: string //WindowHapiModuleName
+    secondaryModuleName?: string //WindowHapiModuleName
+    notes?: string //additional remarks like some best practices for this individual widget
+    path: string
+    key: string
+    id: string
+    injects?: string[]
+    initialState?: Partial<Record<string, any>>
+    isUserJourney?: boolean
+    webComponentCSS?: Record<string, any> //React.CSSProperties
+    attributes?: Record<string, string>
+    qaFunctionToMockId?: Record<string, string> //some widgets have attributes like <widget campaign-id=IDHERE> and they show 404 inside demo pages and documentation so this will map to window.hapiQA function that will grab that id. example below
+    /* mock id example
+    {
+        "campaignId": "campaign.getRandomCampaignId" //campaignId being the path parameter like [campaignId].tsx
+    }
+    */
+}

package/src/common/validations.types.ts

@@ -0,0 +1,89 @@
+import {
+    ZodAny,
+    ZodArray,
+    ZodBoolean,
+    ZodFunction,
+    ZodNullable,
+    ZodNumber,
+    ZodObject,
+    ZodOptional,
+    ZodRecord,
+    ZodString,
+    ZodTuple,
+    ZodUnion,
+    ZodUnknown,
+} from "zod"
+
+export type ZodIntlDescriptor = ZodObject<{
+    id: ZodString
+    defaultMessage: ZodString
+}>
+export type ZodPaginationLimit = ZodNumber
+export type ZodPaginationOffset = ZodNumber
+export type ZodPaginationLimitOffsetDefinition = {
+    limit: ZodOptional<ZodPaginationLimit>
+    offset: ZodOptional<ZodPaginationOffset>
+}
+export type ZodPaginationLimitOffset =
+    ZodObject<ZodPaginationLimitOffsetDefinition>
+export type ZodPaginationNext = ZodString
+export type ZodPaginationPrevious = ZodString
+export type ZodPaginationFirst = ZodString
+export type ZodPaginationLast = ZodString
+export type ZodPaginationNextPreviousDefinition = {
+    next: ZodOptional<ZodNullable<ZodPaginationNext>>
+    previous: ZodOptional<ZodNullable<ZodPaginationPrevious>>
+}
+export type ZodPaginationFirstLastDefinition = {
+    first: ZodOptional<ZodNullable<ZodPaginationFirst>>
+    last: ZodOptional<ZodNullable<ZodPaginationLast>>
+}
+export type ZodPaginationTotal = ZodNumber
+export type ZodPaginationResponseV1 = ZodObject<
+    {
+        count: ZodOptional<ZodNullable<ZodNumber>>
+    } & ZodPaginationLimitOffsetDefinition &
+        ZodPaginationNextPreviousDefinition
+>
+export type ZodPaginationMeta = ZodObject<
+    ZodPaginationFirstLastDefinition & ZodPaginationNextPreviousDefinition
+>
+export type ZodPaginationResponseV2 = ZodObject<
+    {
+        total: ZodOptional<ZodNullable<ZodPaginationTotal>>
+        meta: ZodOptional<ZodPaginationMeta>
+    } & ZodPaginationLimitOffsetDefinition
+>
+export type WindowHapiValidationsCommon = {
+    genericBoolean: ZodBoolean
+    genericNumber: ZodNumber
+    genericNumberArray: ZodArray<ZodNumber>
+    genericString: ZodString
+    genericStringArray: ZodArray<ZodString>
+    genericObject: ZodObject<any>
+    genericRecordFunction: ZodRecord<
+        ZodString,
+        ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>
+    >
+    genericRecordBoolean: ZodRecord<ZodString, ZodBoolean>
+    genericRecordString: ZodRecord<ZodString, ZodString>
+    genericStringOrNumber: ZodUnion<[ZodNumber, ZodString]>
+    genericNullableStringOrNumber: ZodNullable<ZodUnion<[ZodNumber, ZodString]>>
+    genericNullableString: ZodNullable<ZodString>
+    genericAny: ZodAny
+    genericAnyArray: ZodArray<ZodAny>
+    genericStringOrNumberArray: ZodArray<ZodUnion<[ZodNumber, ZodString]>>
+    recordString: ZodRecord<ZodString, ZodString>
+    intlDescriptor: ZodIntlDescriptor
+    limitOffsetPagination: ZodPaginationLimitOffsetDefinition
+    paginationMetaV1: ZodPaginationResponseV1
+    paginationMetaV2: ZodPaginationResponseV2
+    hexRegex: RegExp
+    hex: ZodString
+    camelCaseRegex: RegExp
+    camelCase: ZodString
+    urlRegex: RegExp
+    url: ZodString
+    apiResourceRegex: RegExp
+    apiResource: ZodString
+}

package/src/common/validator/types.ts

@@ -0,0 +1,4 @@
+export type Validators = {
+    isNotEmpty: (value: string | Record<string, any> | any[]) => boolean
+    isNotZero: (value: number) => boolean
+}