@vonq/hapi-elements-types 1.4.0 → 1.6.0

package/src/contract/api.types.ts

@@ -0,0 +1,47 @@
+import { AxiosRequestConfig } from "axios"
+import {
+    Contract,
+    ContractCreateForm,
+    ContractGroup,
+    ContractGroupCreateForm,
+} from "./types"
+import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
+import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiAPIContractConfigs = {
+    getContracts: AxiosRequestConfig
+    getContractsByIds: AxiosRequestConfig
+    getContract: AxiosRequestConfig
+    createContract: AxiosRequestConfig
+    removeContract: AxiosRequestConfig
+    getPostingRequirementOptions: AxiosRequestConfig
+    getGroups: AxiosRequestConfig
+    createGroup: AxiosRequestConfig
+}
+export type WindowHapiAPIContractRequests = {
+    getContracts: (
+        limitOffset?: PaginationLimitOffset,
+    ) => Promise<PaginatedAPIResponseV1<Contract>>
+    getContractsByIds: (
+        contractIds: (string | number)[],
+        limitOffset?: PaginationLimitOffset,
+    ) => Promise<PaginatedAPIResponseV1<Contract>>
+    getContract: (contractId: string) => Promise<Contract>
+    createContract: (contract: ContractCreateForm) => Promise<Contract>
+    getPostingRequirementOptions: (
+        contractId: string,
+        fieldName: string,
+        autocompleteRequestOptions: Record<string, string | string[]>,
+    ) => Promise<any>
+    getGroups: () => Promise<ContractGroup[]>
+    createGroup: (group: ContractGroupCreateForm) => Promise<ContractGroup>
+    removeContract: (contractId: string) => Promise<Contract>
+}
+export type WindowHapiAPIContract = WindowHapiModuleWithConstructorArgs<
+    WindowHapiAPIModule<
+        WindowHapiAPIContractRequests,
+        WindowHapiAPIContractConfigs
+    >,
+    { readonly api: WindowHapiAPI }
+>

package/src/contract/index.ts

@@ -0,0 +1,9 @@
+// created from 'create-ts-index'
+
+export * from "./api.types"
+export * from "./qa.types"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"
+export * from "./utils.types"
+export * from "./validations.types"

package/src/contract/qa.types.ts

@@ -0,0 +1,12 @@
+import { ContractCreateForm, ContractGroupCreateForm } from "./types"
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiQAContract = WindowHapiModuleWithConstructorArgs<
+    {
+        getRandomContractId: () => Promise<string>
+        useMockContractForm: () => ContractCreateForm
+        useMockGroupForm: () => ContractGroupCreateForm
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/contract/service.types.ts

@@ -0,0 +1,54 @@
+import {
+    HapiServiceFunctionWithLifecycleHooks,
+    WindowHapiService,
+} from "../_window/service.types"
+import { OrderJourneyStepKey } from "../orderJourney/enums"
+import {
+    Contract,
+    ContractCredential,
+    ContractGroup,
+    ContractPostingRequirementsAutocompleteRequestOption,
+} from "./types"
+import { PaginatedAPIResponseV1 } from "../common/types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type ContractServiceGetContractPostingRequirementOptionsHandler = (
+    contractId: string,
+    fieldName: string,
+    autocompleteRequestOptions: ContractPostingRequirementsAutocompleteRequestOption[],
+) => Promise<any>
+export type ContractServiceGetContractsHandler = (
+    offset: number,
+) => Promise<PaginatedAPIResponseV1<Contract>>
+export type ContractServiceGetContractGroupsHandler = () => Promise<
+    ContractGroup[]
+>
+export type ContractServiceCreateContractHandler = () => Promise<Contract>
+export type ContractServiceRemoveContractHandler = (
+    contractId: string,
+) => Promise<void>
+export type ContractServiceCreateContractGroupHandler =
+    () => Promise<ContractGroup>
+export type ContractServiceGetContractHandler = (
+    id: string,
+) => Promise<Contract>
+
+export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
+    {
+        getContractPostingRequirementOptions: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractPostingRequirementOptionsHandler>
+        getContracts: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractsHandler>
+        getContractGroups: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractGroupsHandler>
+        createContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceCreateContractHandler>
+        removeContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceRemoveContractHandler>
+        createContractGroup: HapiServiceFunctionWithLifecycleHooks<ContractServiceCreateContractGroupHandler>
+        getContract: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractHandler>
+        initiateOauthLogin: (
+            contractId: string | number,
+            orderJourneyStepActive: OrderJourneyStepKey,
+            credential: ContractCredential,
+        ) => void
+        setDefaultContractForm: () => void
+        setDefaultContractGroupForm: () => void
+    },
+    { readonly service: WindowHapiService }
+>

package/src/contract/state.types.ts

@@ -0,0 +1,74 @@
+import { ProductSupportingContractsComplete } from "../product/types"
+import {
+    Contract,
+    ContractCreateForm,
+    ContractGroup,
+    ContractGroupCreateForm,
+    ContractGroupSelected,
+} from "./types"
+import { PaginationResponseV1 } from "../common/types"
+
+export type ContractState = {
+    /* Contracts */
+    /**
+     * Array of Contracts to be displayed in Contracts Landing or Contracts List widgets.
+     */
+    contracts: Contract[]
+    /**
+     * An object that holds information like next URL, previous URL and count for pagination purposes
+     */
+    contractsPaginationMeta: PaginationResponseV1
+    /**
+     * Shows a loading spinner when the Contracts are loading
+     */
+    contractsAreLoading: boolean
+    /**
+     * Selected Channel ID that will trigger an API request to fetch the data then to populate `contractSelected`
+     */
+    contractSelectedId: string | number | null
+    /**
+     * Selected Channel that will be part of the Contract when user submits the form
+     */
+    contractSelected: ProductSupportingContractsComplete | null
+    /**
+     * Shows a loading spinner when the properties required for the Contract are being loaded from the API
+     */
+    contractSelectedIsLoading: boolean
+    /**
+     * The object that contains details for the new Contract that will be created when user submits the form
+     */
+    contractForm: ContractCreateForm
+    /**
+     * Error(s) received from the API when user submits the form
+     */
+    contractCreateError: any
+    /**
+     * Client-side validation result of the `contractForm`. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    contractFormIsValid: boolean | null
+    /* Contracts Groups */
+    /**
+     * Array of Contract Groups for user to select during creation of a new Contract.
+     */
+    groups: ContractGroup[]
+    /**
+     * Selected Contract Group to be saved as part of Contract that will be created when user submits the form
+     */
+    groupSelected: ContractGroupSelected
+    /**
+     * Shows a loading spinner and disables the Select HTML Element when Contract Groups are loading
+     */
+    groupsAreLoading: boolean
+    /**
+     * Shows a loading spinner and disables the submit button while a new Contract Group is being created
+     */
+    groupIsCreating: boolean
+    /**
+     * Error message displayed to the end user when the new Contract Group could not be created
+     */
+    groupCreateError: string | null
+    /**
+     * The object that contains details for the new Contract Group that will be created when user submits the form
+     */
+    groupForm: ContractGroupCreateForm
+}

package/src/contract/types.ts

@@ -0,0 +1,145 @@
+import { ProductLogos, ProductType } from "../product/types"
+
+export type ContractProduct = {
+    product_id: string
+    title: string
+}
+
+export type ContractCredential = {
+    description?: string | null
+    label: string
+    name: string
+    sort: string
+    url: string | null
+    options: any[] | null
+}
+
+export type ContractFacet = {}
+
+export type ContractPostingRequirementType =
+    | "SELECT"
+    | "SELECT-MAP_ONLY"
+    | "TEXT"
+    | "MULTIPLE"
+    | "HIER"
+    | "TEXTEXPAND"
+    | "DATE"
+    | "TEXTAREA"
+    | "AUTOCOMPLETE"
+    | "STATISCH"
+
+export type ContractPostingRequirementRule = {
+    rule: string
+    data: string
+}
+
+export type ContractPostingRequirementDisplayRuleShow = {
+    facet: string
+    value: any
+    op: "notempty" | "equal" | "in"
+}
+
+export type ContractPostingRequirementDisplayRule = {
+    show: ContractPostingRequirementDisplayRuleShow[]
+}
+
+export type ContractPostingRequirementAutocompleteParametersSourceSingle = {
+    field?: string
+    facet?: string
+}
+
+export type ContractPostingRequirementAutocompleteParametersSourceMultiple = {
+    [
+        key: string
+    ]: ContractPostingRequirementAutocompleteParametersSourceSingle[]
+}
+
+export type ContractPostingRequirementParametersSource =
+    | ContractPostingRequirementAutocompleteParametersSourceSingle
+    | ContractPostingRequirementAutocompleteParametersSourceMultiple
+
+export type ContractPostingRequirementAutocomplete = {
+    required_parameters: string[] | null
+    parameters_source: ContractPostingRequirementParametersSource | null
+}
+
+export type ContractPostingRequirement = {
+    name: string
+    label: string
+    description?: string
+    display_rules: ContractPostingRequirementDisplayRule | null
+    autocomplete: ContractPostingRequirementAutocomplete | null
+    options: ContractPostingRequirementOption[] | null
+    required: boolean
+    sort: string
+    type: ContractPostingRequirementType
+    rules?: ContractPostingRequirementRule[] | null
+}
+
+export type ContractPostingRequirementOption = {
+    default?: string
+    key: string
+    label: string
+    data?: any[]
+    labels?: Record<"default", string>
+    sort: string
+    parent?: string
+}
+
+export type ContractPurchasePrice = {
+    amount: number | null
+    currency: string | null
+}
+
+export type ContractCreateFormCredentials = Record<string, string>
+
+export type ContractCreateForm = {
+    id?: number
+    credentials?: ContractCreateFormCredentials
+    facets?: any
+    expiry_date: string | null
+    alias: string | null
+    purchase_price: ContractPurchasePrice
+    credits: string | null
+    followed_instructions: boolean
+    allow_renegotiation: boolean
+}
+
+export type ContractGroupCreateForm = {
+    name: string
+}
+
+export type ContractChannel = ProductLogos &
+    ProductType & {
+        id: number
+        name: string
+        url: string
+    }
+
+export type Contract = {
+    channel?: ContractChannel
+    alias: string
+    channel_id: number
+    class_name: string
+    contract_id: string
+    credits: number | null
+    customer_id: string
+    expiry_date: string | null
+    facets?: any[]
+    product: ContractProduct
+    purchase_price: ContractPurchasePrice | null
+    group: ContractGroup | null
+}
+
+export type ContractGroup = {
+    id: string
+    idx: number
+    igb_customer_id: string
+    name: string
+}
+
+export type ContractGroupSelected = ContractGroup | "add-new" | null
+export type ContractPostingRequirementsAutocompleteRequestOption = {
+    key: string
+    value: string | string[]
+}

package/src/contract/utils.types.ts

@@ -0,0 +1,11 @@
+import { ContractCreateForm, ContractGroupCreateForm } from "./types"
+import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiUtilsContract = WindowHapiModuleWithConstructorArgs<
+    {
+        getInitialContractForm: () => ContractCreateForm
+        getInitialGroupForm: () => ContractGroupCreateForm
+    },
+    { readonly utils: WindowHapiUtils }
+>

package/src/contract/validations.types.ts

@@ -0,0 +1,104 @@
+import {
+    ZodAny,
+    ZodArray,
+    ZodBoolean,
+    ZodNull,
+    ZodNullable,
+    ZodNumber,
+    ZodObject,
+    ZodOptional,
+    ZodRecord,
+    ZodString,
+    ZodUnion,
+} from "zod"
+import {
+    ZodProductLogosWithSizes,
+    ZodProductLogoUrl,
+    ZodProductWithContractSupportComplete,
+} from "../product/validations.types"
+
+export type ZodContractAlias = ZodOptional<ZodNullable<ZodString>>
+export type ZodContractExpiryDate = ZodOptional<ZodNullable<ZodString>>
+export type ZodContractCredits = ZodOptional<
+    ZodNullable<ZodUnion<[ZodNumber, ZodString]>>
+>
+export type ZodContractFacets = ZodOptional<ZodAny>
+export type ZodContractChannel = ZodObject<{
+    id: ZodNumber
+    name: ZodString
+    url: ZodString
+    type: ZodString
+}>
+export type ZodContractProduct = ZodObject<{
+    product_id: ZodString
+    title: ZodString
+}>
+export type ZodContractPurchasePrice = ZodOptional<
+    ZodObject<{
+        amount: ZodNullable<ZodNumber>
+        currency: ZodNullable<ZodString>
+    }>
+>
+export type ZodContractGroup = ZodObject<{
+    id: ZodOptional<ZodString>
+    idx: ZodOptional<ZodNumber>
+    igb_customer_id: ZodOptional<ZodString>
+    name: ZodString
+}>
+export type ZodContractGroupSelected = ZodUnion<
+    [ZodString, ZodContractGroup, ZodNull]
+>
+export type ZodContractGroupCreateForm = ZodObject<{
+    name: ZodString
+}>
+export type ZodContractCreateForm = ZodObject<{
+    id: ZodOptional<ZodNumber>
+    credentials: ZodOptional<ZodObject<any>>
+    facets: ZodContractFacets
+    alias: ZodContractAlias
+    expiry_date: ZodContractExpiryDate
+    purchase_price: ZodContractPurchasePrice
+    credits: ZodContractCredits
+    followed_instructions: ZodOptional<ZodBoolean>
+    allow_renegotiation: ZodOptional<ZodBoolean>
+}>
+export type ZodContractPostingRequirementAutocompleteRequestOptions = ZodRecord<
+    ZodString,
+    ZodUnion<[ZodString, ZodArray<ZodString>]>
+>
+
+export type ZodContract = ZodObject<{
+    channel: ZodOptional<ZodContractChannel>
+    alias: ZodContractAlias
+    channel_id: ZodNumber
+    class_name: ZodString
+    contract_id: ZodString
+    customer_id: ZodString
+    facets: ZodContractFacets
+    credits: ZodContractCredits
+    expiry_date: ZodContractExpiryDate
+    logo_rectangle_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_square_url: ZodOptional<ZodNullable<ZodProductLogosWithSizes>>
+    logo_url: ZodOptional<ZodNullable<ZodProductLogoUrl>>
+    product: ZodContractProduct
+    purchase_price: ZodNullable<ZodContractPurchasePrice>
+    group: ZodNullable<ZodContractGroup>
+}>
+export type WindowHapiValidationsContract = {
+    channel: ZodContractChannel
+    product: ZodContractProduct
+    contractPurchasePrice: ZodContractPurchasePrice
+    contractExpiryDate: ZodContractExpiryDate
+    contractAlias: ZodContractAlias
+    contractCredits: ZodContractCredits
+    contractFacets: ZodOptional<ZodAny>
+    contractForm: ZodContractCreateForm
+    contract: ZodContract
+    contractSelected: ZodNullable<ZodProductWithContractSupportComplete>
+    contracts: ZodArray<ZodContract>
+    group: ZodContractGroup
+    groupSelected: ZodContractGroupSelected
+    groups: ZodArray<ZodContractGroup>
+    groupForm: ZodContractGroupCreateForm
+    postingRequirementAutocompleteRequestOptions: ZodContractPostingRequirementAutocompleteRequestOptions
+}

package/src/debugging/index.ts

@@ -0,0 +1,3 @@
+// created from 'create-ts-index'
+
+export * from "./state.types"

package/src/debugging/state.types.ts

@@ -0,0 +1,18 @@
+export type DebuggingState = {
+    /**
+     * Shows or hides the debugging tool on Campaign Create Form's fields for Product & Contract steps
+     */
+    campaignFormDebuggerIsShown: boolean
+    /**
+     * Shows translation keys in place of translations for ease of development
+     */
+    localeDebuggingIsEnabled: boolean
+    /**
+     * Encompasses widgets that may become available (or upon request) with a red border and a name so communication while making requests is easier.
+     */
+    componentDebuggingIsEnabled: boolean
+    /**
+     * Enables console logs (all HAPI Elements) logs
+     */
+    consoleLogsAreEnabled: boolean
+}

package/src/index.ts

@@ -0,0 +1,18 @@
+// created from 'create-ts-index'
+
+export * from "./_window"
+export * from "./alert"
+export * from "./ats"
+export * from "./basket"
+export * from "./campaign"
+export * from "./common"
+export * from "./contract"
+export * from "./debugging"
+export * from "./language"
+export * from "./modal"
+export * from "./orderJourney"
+export * from "./product"
+export * from "./routing"
+export * from "./theming"
+export * from "./ui"
+export * from "./wallet"

package/src/language/index.ts

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

package/src/language/qa.types.ts

@@ -0,0 +1,19 @@
+import { ProductPriceCurrency } from "../product/enums"
+import { LanguageStoreTranslations } from "./state.types"
+import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiQALanguage = WindowHapiModuleWithConstructorArgs<
+    {
+        setLocale: (locale: string) => string
+        setDisplayCurrency: (
+            currency: ProductPriceCurrency,
+        ) => ProductPriceCurrency
+        setTranslationByLocaleAndKey: (
+            locale: string,
+            key: string,
+            message: string,
+        ) => LanguageStoreTranslations
+    },
+    { readonly qa: WindowHapiQA }
+>

package/src/language/state.types.ts

@@ -0,0 +1,25 @@
+import { ProductPriceCurrency } from "../product/enums"
+
+export type LanguageStoreLocaleTranslations = Record<string, string>
+export type LanguageStoreTranslations = Record<
+    string,
+    LanguageStoreLocaleTranslations
+>
+export type LanguageState = {
+    /**
+     * Locale of the user (navigator language) in RFC 5646 that can be changed via setLocale function
+     */
+    locale: string
+    /**
+     * An object containing key-value parts where the key is the i18n key such as `test.example-string` and the value is the actual translation. Translations will be loaded by current locale and fallbacks will be used from American English defaults we have.
+     */
+    translations: LanguageStoreTranslations
+    /**
+     * Current Display Currency of all the widgets
+     */
+    displayCurrency: ProductPriceCurrency
+    /**
+     * Array of supported currencies. **This value changes automatically when user scrolls and should not be set from outside**
+     */
+    supportedCurrencies: ProductPriceCurrency[]
+}

package/src/language/validations.types.ts

@@ -0,0 +1,13 @@
+import { ZodRecord, ZodString } from "zod"
+import { ProductPriceCurrency } from "../product/enums"
+
+export type ZodTranslations = ZodRecord<
+    ZodString,
+    ZodRecord<ZodString, ZodString>
+>
+export type WindowHapiValidationsLanguage = {
+    translations: ZodTranslations
+    supportedCurrencies: ProductPriceCurrency[]
+    supportedCurrenciesRegex: RegExp
+    displayCurrency: ZodString
+}

package/src/modal/enums.ts

@@ -0,0 +1,14 @@
+export enum ModalZone {
+    "primary" = "primary",
+    "secondary" = "secondary",
+}
+
+export enum ModalKeys {
+    wallet = "layout-wallet-modal",
+    basket = "layout-basket-modal",
+    productInfo = "product-info",
+    campaignTakeOfflineConfirmation = "campaign-confirm-take-offline",
+    campaignCopyConfirmation = "campaign-confirm-copy",
+    basketRemoveProductConfirmation = "remove-product-from-basket",
+    contractRemoveConfirmation = "contract-remove-confirmation",
+}

package/src/modal/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./enums"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"

package/src/modal/service.types.ts

@@ -0,0 +1,32 @@
+import { ModalOptions } from "./types"
+import { ModalKeys, ModalZone } from "./enums"
+import { Product } from "../product/types"
+import { Contract } from "../contract/types"
+import { IObservableValue } from "mobx"
+import { AnyNonFunction } from "../common/types"
+import { WindowHapiService } from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
+
+export type WindowHapiServiceModal = WindowHapiModuleWithConstructorArgs<
+    {
+        openModal: (
+            key: ModalKeys,
+            props: AnyNonFunction<
+                | { product: Product }
+                | {
+                      onClickAccept: (
+                          productOrContract: Product | Contract,
+                      ) => void
+                      onClickDecline: () => void
+                      basketProduct: Product | Contract
+                  }
+                | { campaignId: string }
+                | { partnerId?: IObservableValue<string> }
+            >,
+            options?: ModalOptions,
+            zone?: ModalZone,
+        ) => void
+        closeModal: (key: ModalKeys) => void
+    },
+    { readonly service: WindowHapiService }
+>

package/src/modal/state.types.ts

@@ -0,0 +1,8 @@
+import { Modals } from "./types"
+
+export type ModalState = {
+    /**
+     * An object of modals that are seperated into different layers
+     */
+    modals: Modals
+}