@vonq/hapi-elements-types 1.5.0 → 1.6.0

package/src/common/types.ts

@@ -1,8 +1,7 @@
 import validator from "validator"
-import validators from "./validators"
 import { MessageDescriptor } from "react-intl"
-import { Logger } from "./logger/Logger"
-import { Stores } from "../types"
+import { WindowHapiLogger } from "./logger/types"
+import { Validators } from "./validator/types"
 
 export type ValueOf<T> = T[keyof T]
 export type AnyNonFunction<T> = Omit<T, "function">
@@ -76,14 +75,14 @@ export type ValidatorKey =
           | "PostalCodeLocale"
           | "isPostalCodeLocales"
       >
-    | keyof typeof validators
+    | keyof Validators
 export type NestedValidatorKeys =
     | ValidatorKey
     | {
           [k: string]: ValidatorKey | NestedValidatorKeys
       }
 export type BaseService = {
-    logger: Logger
+    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
@@ -97,7 +96,7 @@ export type HapiWebComponent = {
     key: string
     id: string
     injects?: string[]
-    initialState?: Partial<Record<keyof Stores, any>>
+    initialState?: Partial<Record<string, any>>
     isUserJourney?: boolean
     webComponentCSS?: Record<string, any> //React.CSSProperties
     attributes?: Record<string, string>

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
+}

package/src/contract/api.types.ts

@@ -7,7 +7,7 @@ import {
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiAPIContractConfigs = {
     getContracts: AxiosRequestConfig
@@ -38,7 +38,7 @@ export type WindowHapiAPIContractRequests = {
     createGroup: (group: ContractGroupCreateForm) => Promise<ContractGroup>
     removeContract: (contractId: string) => Promise<Contract>
 }
-export type WindowHapiAPIContract = ModuleWithConstructorArgs<
+export type WindowHapiAPIContract = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<
         WindowHapiAPIContractRequests,
         WindowHapiAPIContractConfigs

package/src/contract/index.ts

@@ -1,14 +1,9 @@
 // created from 'create-ts-index'
 
-export * from './api.types';
-export * from './consts';
-export * from './functions.types';
-export * from './qa.types';
-export * from './service.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './types';
-export * from './utils';
-export * from './utils.types';
-export * from './validations.types';
+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

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

package/src/contract/service.types.ts

@@ -10,7 +10,7 @@ import {
     ContractPostingRequirementsAutocompleteRequestOption,
 } from "./types"
 import { PaginatedAPIResponseV1 } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type ContractServiceGetContractPostingRequirementOptionsHandler = (
     contractId: string,
@@ -33,7 +33,7 @@ export type ContractServiceGetContractHandler = (
     id: string,
 ) => Promise<Contract>
 
-export type WindowHapiServiceContract = ModuleWithConstructorArgs<
+export type WindowHapiServiceContract = WindowHapiModuleWithConstructorArgs<
     {
         getContractPostingRequirementOptions: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractPostingRequirementOptionsHandler>
         getContracts: HapiServiceFunctionWithLifecycleHooks<ContractServiceGetContractsHandler>

package/src/contract/state.types.ts

@@ -8,7 +8,7 @@ import {
 } from "./types"
 import { PaginationResponseV1 } from "../common/types"
 
-export type ContractStoreState = {
+export type ContractState = {
     /* Contracts */
     /**
      * Array of Contracts to be displayed in Contracts Landing or Contracts List widgets.

package/src/contract/utils.types.ts

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

package/src/debugging/index.ts

@@ -1,6 +1,3 @@
 // created from 'create-ts-index'
 
-export * from './functions.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
+export * from "./state.types"

package/src/debugging/state.types.ts

@@ -1,4 +1,4 @@
-export type DebuggingStoreState = {
+export type DebuggingState = {
     /**
      * Shows or hides the debugging tool on Campaign Create Form's fields for Product & Contract steps
      */

package/src/index.ts

@@ -1,22 +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 './config';
-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';
-export * from './consts';
-export * from './types';
-export * from './utils';
+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

@@ -1,11 +1,5 @@
 // created from 'create-ts-index'
 
-export * from './consts';
-export * from './en';
-export * from './functions.types';
-export * from './qa.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './utils';
-export * from './validations.types';
+export * from "./qa.types"
+export * from "./state.types"
+export * from "./validations.types"

package/src/language/qa.types.ts

@@ -1,9 +1,9 @@
 import { ProductPriceCurrency } from "../product/enums"
 import { LanguageStoreTranslations } from "./state.types"
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiQALanguage = ModuleWithConstructorArgs<
+export type WindowHapiQALanguage = WindowHapiModuleWithConstructorArgs<
     {
         setLocale: (locale: string) => string
         setDisplayCurrency: (

package/src/language/state.types.ts

@@ -5,7 +5,7 @@ export type LanguageStoreTranslations = Record<
     string,
     LanguageStoreLocaleTranslations
 >
-export type LanguageStoreState = {
+export type LanguageState = {
     /**
      * Locale of the user (navigator language) in RFC 5646 that can be changed via setLocale function
      */

package/src/modal/index.ts

@@ -1,11 +1,6 @@
 // created from 'create-ts-index'
 
-export * from './consts';
-export * from './enums';
-export * from './functions.types';
-export * from './service.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './store.types';
-export * from './types';
+export * from "./enums"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"

package/src/modal/service.types.ts

@@ -4,10 +4,10 @@ import { Product } from "../product/types"
 import { Contract } from "../contract/types"
 import { IObservableValue } from "mobx"
 import { AnyNonFunction } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiService } from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiServiceModal = ModuleWithConstructorArgs<
+export type WindowHapiServiceModal = WindowHapiModuleWithConstructorArgs<
     {
         openModal: (
             key: ModalKeys,

package/src/modal/state.types.ts

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

package/src/orderJourney/index.ts

@@ -1,13 +1,8 @@
 // created from 'create-ts-index'
 
-export * from './consts';
-export * from './enums';
-export * from './functions.types';
-export * from './qa.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './types';
-export * from './utils';
-export * from './utils.types';
-export * from './validations.types';
+export * from "./enums"
+export * from "./qa.types"
+export * from "./state.types"
+export * from "./types"
+export * from "./utils.types"
+export * from "./validations.types"

package/src/orderJourney/qa.types.ts

@@ -1,8 +1,8 @@
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiQAOrderJourney = ModuleWithConstructorArgs<
+export type WindowHapiQAOrderJourney = WindowHapiModuleWithConstructorArgs<
     {
         setEnabledSteps: (steps: OrderJourneyStepKey[]) => OrderJourneyStepKey[]
         setEnabledPaymentMethods: (

package/src/orderJourney/state.types.ts

@@ -3,7 +3,7 @@ import { OrderJourneyStep, OrderJourneyContractStep } from "./types"
 import { MessageDescriptor } from "react-intl"
 import { NestedValidatorKeys, UseValidatorResult } from "../common/types"
 
-export type OrderJourneyStoreState = {
+export type OrderJourneyState = {
     stepsEnabled: OrderJourneyStepKey[]
     steps: OrderJourneyStep[]
     stepPreviousIndex: number

package/src/orderJourney/utils.types.ts

@@ -1,8 +1,8 @@
 import { OrderJourneyPaymentMethod, OrderJourneyStepKey } from "./enums"
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiUtilsOrderJourney = ModuleWithConstructorArgs<
+export type WindowHapiUtilsOrderJourney = WindowHapiModuleWithConstructorArgs<
     {
         stepKeys: typeof OrderJourneyStepKey
         paymentMethodKeys: typeof OrderJourneyPaymentMethod

package/src/product/api.types.ts

@@ -11,11 +11,11 @@ import {
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
 import { PaginatedAPIResponseV1, PaginationLimitOffset } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
 import {
     WindowHapiAPIATSConfigs,
     WindowHapiAPIATSRequests,
 } from "../ats/api.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiAPIProductConfigs = {
     getProduct: AxiosRequestConfig
@@ -53,7 +53,7 @@ export type WindowHapiAPIProductRequests = {
     ) => Promise<PaginatedAPIResponseV1<ProductJobTitle>>
     getLocations: (searchParam: string) => Promise<ProductLocation[]>
 }
-export type WindowHapiAPIProduct = ModuleWithConstructorArgs<
+export type WindowHapiAPIProduct = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<
         WindowHapiAPIProductRequests,
         WindowHapiAPIProductConfigs

package/src/product/index.ts

@@ -1,14 +1,10 @@
 // created from 'create-ts-index'
 
-export * from './api.types';
-export * from './consts';
-export * from './enums';
-export * from './functions.types';
-export * from './qa.types';
-export * from './service.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './types';
-export * from './utils.types';
-export * from './validations.types';
+export * from "./api.types"
+export * from "./enums"
+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/product/qa.types.ts

@@ -1,7 +1,7 @@
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiQAProduct = ModuleWithConstructorArgs<
+export type WindowHapiQAProduct = WindowHapiModuleWithConstructorArgs<
     {
         useMockFilters: () => Promise<void>
         getRandomChannelIdThatSupportsContracts: () => Promise<number>

package/src/product/service.types.ts

@@ -13,7 +13,7 @@ import {
     ProductSupportingContractsPartial,
 } from "./types"
 import { PaginatedAPIResponseV1, PaginationResponseV1 } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type ProductServiceGetFilteredProductsHandler = (
     meta?: PaginationResponseV1 | null,
@@ -51,7 +51,7 @@ export type ProductServiceGetIndustriesHandler = () => Promise<
     ProductIndustry[]
 >
 
-export type WindowHapiServiceProduct = ModuleWithConstructorArgs<
+export type WindowHapiServiceProduct = WindowHapiModuleWithConstructorArgs<
     {
         getProductWithContractsSupportById: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductWithContractsSupportByIdHandler>
         getProductsWithContractsSupport: HapiServiceFunctionWithLifecycleHooks<ProductServiceGetProductsWithContractsSupportHandler>

package/src/product/state.types.ts

@@ -8,7 +8,7 @@ import {
 } from "./types"
 import { PaginationResponseV1 } from "../common/types"
 
-export type ProductStoreState = {
+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

package/src/product/utils.types.ts

@@ -1,13 +1,13 @@
 import { ProductFilterQueryParams, ProductUserProvidedFilters } from "./types"
 import { PaginationResponseV1 } from "../common/types"
-import { ModuleWithConstructorArgs } from "../types"
 import {
     OrderJourneyPaymentMethod,
     OrderJourneyStepKey,
 } from "../orderJourney/enums"
 import { WindowHapiUtils } from "../_window/utils.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiUtilsProduct = ModuleWithConstructorArgs<
+export type WindowHapiUtilsProduct = WindowHapiModuleWithConstructorArgs<
     {
         getUserProvidedFilters: () => ProductUserProvidedFilters
         getProductsQueryParams: (

package/src/routing/index.ts

@@ -1,5 +1,3 @@
 // created from 'create-ts-index'
 
-export * from './functions.types';
-export * from './state.initial';
-export * from './state.types';
+export * from "./state.types"

package/src/theming/index.ts

@@ -1,11 +1,6 @@
 // created from 'create-ts-index'
 
-export * from './consts';
-export * from './functions.types';
-export * from './qa.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './types';
-export * from './utils';
-export * from './validations.types';
+export * from "./qa.types"
+export * from "./state.types"
+export * from "./types"
+export * from "./validations.types"

package/src/theming/qa.types.ts

@@ -1,8 +1,8 @@
 import { HapiFontOptions, HapiTheme } from "./types"
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiQA } from "../_window/qa.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiQATheming = ModuleWithConstructorArgs<
+export type WindowHapiQATheming = WindowHapiModuleWithConstructorArgs<
     {
         setTheme: (updatedTheme: Partial<HapiTheme>) => HapiTheme
         setFontOptions: (fontOptions: HapiFontOptions) => HapiFontOptions

package/src/theming/state.types.ts

@@ -1,6 +1,6 @@
 import { HapiFontOptions, HapiTheme } from "./types"
 
-export type ThemeStoreState = {
+export type ThemingState = {
     theme: Partial<HapiTheme>
     fontOptions: HapiFontOptions
 }

package/src/ui/service.types.ts

@@ -1,7 +1,7 @@
-import { ModuleWithConstructorArgs } from "../types"
 import { WindowHapiService } from "../_window/service.types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-export type WindowHapiServiceUI = ModuleWithConstructorArgs<
+export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
     {
         setStyleAttribute: (
             selector: string,

package/src/wallet/api.types.ts

@@ -6,7 +6,7 @@ import {
     WalletPaymentIntentRequest,
 } from "./types"
 import { WindowHapiAPI, WindowHapiAPIModule } from "../_window/api.types"
-import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WindowHapiAPIWalletConfigs = {
     getWallet: RawAxiosRequestConfig
@@ -24,7 +24,7 @@ export type WindowHapiAPIWalletRequests = {
         paymentParams: WalletPaymentIntentRequest,
     ) => Promise<any>
 }
-export type WindowHapiAPIWallet = ModuleWithConstructorArgs<
+export type WindowHapiAPIWallet = WindowHapiModuleWithConstructorArgs<
     WindowHapiAPIModule<
         WindowHapiAPIWalletRequests,
         WindowHapiAPIWalletConfigs

package/src/wallet/index.ts

@@ -1,11 +1,7 @@
 // created from 'create-ts-index'
 
-export * from './api.types';
-export * from './consts';
-export * from './functions.types';
-export * from './service.types';
-export * from './state.initial';
-export * from './state.types';
-export * from './state.validations';
-export * from './types';
-export * from './validations.types';
+export * from "./api.types"
+export * from "./service.types"
+export * from "./state.types"
+export * from "./types"
+export * from "./validations.types"

package/src/wallet/service.types.ts

@@ -3,7 +3,7 @@ import {
     HapiServiceFunctionWithLifecycleHooks,
     WindowHapiService,
 } from "../_window/service.types"
-import { ModuleWithConstructorArgs } from "../types"
+import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
 export type WalletServiceGetATSSettingsHandler =
     () => Promise<WalletATSSettings>
@@ -12,7 +12,7 @@ export type WalletServiceGetWalletHandler = (
 ) => Promise<Wallet>
 export type WalletServiceCreateWalletHandler = () => Promise<Wallet>
 
-export type WindowHapiServiceWallet = ModuleWithConstructorArgs<
+export type WindowHapiServiceWallet = WindowHapiModuleWithConstructorArgs<
     {
         getATSSettings: HapiServiceFunctionWithLifecycleHooks<WalletServiceGetATSSettingsHandler>
         getWallet: HapiServiceFunctionWithLifecycleHooks<WalletServiceGetWalletHandler>

package/src/wallet/state.types.ts

@@ -5,7 +5,7 @@ import {
     WalletPaymentIntentRequest,
 } from "./types"
 
-export type WalletStoreState = {
+export type WalletState = {
     /**
      * User's Wallet that can hold credits to be used on Creating/Ordering a Campaign
      */

package/tsconfig.json

@@ -18,16 +18,9 @@
     "jsx": "preserve",
     "incremental": false,
     "experimentalDecorators": true,
-    "baseUrl": "./src",
-    "forceConsistentCasingInFileNames": true,
-    "paths": {
-      "axios": ["../../node_modules/axios"],
-      "zod": ["../../node_modules/zod"],
-      "theming": ["../../node_modules/theming"],
-      "react-intl": ["../../node_modules/react-intl"],
-      "react": ["../../node_modules/react"],
-      "lodash": ["../../node_modules/lodash"]
-    }
+    "baseUrl": "./",
+    "outFile": "index.d.ts",
+    "forceConsistentCasingInFileNames": true
   },
   "include": [
     "./src/**/*",
@@ -36,6 +29,8 @@
     "node_modules",
     "../ats/**/*",
     "../common/**/*",
-    "./dist/**/*"
+    "../src/**/*",
+    "./index.d.ts",
+    "./index.d.ts.map"
   ]
 }

package/src/alert/functions.types.ts

@@ -1,13 +0,0 @@
-import { AlertKey } from "./enums"
-import { Alert, AlertOptions, AlertProps } from "./types"
-
-export type AlertStoreShowHandler = (
-    key: AlertKey,
-    props: AlertProps | undefined,
-    options: AlertOptions,
-) => void
-export type AlertStoreSetAlertsHandler = (alerts: Alert[]) => void
-export type AlertStoreFunctions = {
-    showAlert: AlertStoreShowHandler
-    setAlerts: AlertStoreSetAlertsHandler
-}

package/src/alert/state.initial.ts

@@ -1,16 +0,0 @@
-import { AlertStoreState } from "./state.types"
-import { AlertType } from "./enums"
-
-export const initialAlertStoreState: AlertStoreState = {
-    alerts: [],
-    errorOptions: null,
-    infoOptions: null,
-    warningOptions: null,
-    successOptions: null,
-    defaultOptions: {
-        shouldShowDismiss: true,
-        position: "top-center",
-        autoClose: 5000,
-        type: AlertType.info,
-    },
-}

package/src/alert/state.validations.ts

@@ -1,11 +0,0 @@
-import { AlertStoreState } from "./state.types"
-import { StateValidations } from "../_window/state.types"
-
-export const alertStoreStateValidations: StateValidations<AlertStoreState> = {
-    alerts: undefined,
-    errorOptions: "throwHasNoSetterError",
-    infoOptions: "throwHasNoSetterError",
-    warningOptions: "throwHasNoSetterError",
-    successOptions: "throwHasNoSetterError",
-    defaultOptions: undefined,
-}