@vonq/hapi-elements-types 1.6.0 → 1.8.0

package/README.md

@@ -0,0 +1,21 @@
+This package contains type definitions for VONQ HAPI Elements project.
+
+To get started using the types, install the package as a dev dependency:
+
+
+Using NPM:
+```
+npm install @vonq/hapi-elements-types --save-dev
+```
+
+Using Yarn:
+```
+yarn add -D @vonq/hapi-elements-types
+```
+
+All the types have been exported in a single file so you can get started using the types as such:
+```
+import {CreateCampaignForm} from "@vonq/hapi-elements-types";
+
+const campaignObject: CreateCampaignForm = {} //Typescript will warn about missing properties
+```

package/{src/_window → _window}/sdk.types.ts

@@ -40,6 +40,7 @@ import {
     WindowHapiClassInterface,
 } from "./window"
 import { WindowHapiServiceUI } from "../ui/service.types"
+import { ATSState, WindowHapiAPIATS, WindowHapiServiceATS } from "../ats"
 
 export type WindowHapiSDKModule<
     APIModule,
@@ -126,8 +127,16 @@ export type WindowHapiSDKUI = WindowHapiSDKModule<
     undefined,
     undefined
 >
+export type WindowHapiSDKATS = WindowHapiSDKModule<
+    WindowHapiAPIATS,
+    WindowHapiServiceATS,
+    undefined,
+    WindowHapiStateModule<ATSState>
+>
+
 export type WindowHapiSDK = WindowHapiModuleWithConstructorArgs<
     {
+        [WindowHapiModuleName.ats]: WindowHapiSDKATS
         [WindowHapiModuleName.contract]: WindowHapiSDKContract
         [WindowHapiModuleName.basket]: WindowHapiSDKBasket
         [WindowHapiModuleName.campaign]: WindowHapiSDKCampaign

package/{src/_window → _window}/state.types.ts

@@ -81,6 +81,7 @@ export type WindowHapiStatesJSON = {
 }
 
 export type WindowHapiStateBase = {
+    propertiesThatShouldNotBeDocumented: string[]
     __stateName: string
     toJSON: any
 }

package/{src/ats → ats}/types.ts

@@ -11,7 +11,7 @@ export type ATSUserSettings = {
     ats_managed_payment: boolean
     can_pay_with_purchase_order: boolean
     can_use_wallets: boolean
-    invoice_currency: string
+    invoice_currency: string | null
 }
 export type ATSSettings = {
     payment_settings: ATSUserPaymentSetting[]

package/{src/basket → basket}/state.types.ts

@@ -23,6 +23,10 @@ export type BasketState = {
      * Sum of prices of Products and/or Contracts in GBP currency. **This value is a computed getter meaning that it cannot be set from outside**
      */
     totalInGBP: number
+    /**
+     * Sum of prices of Products and/or Contracts in AUD currency. **This value is a computed getter meaning that it cannot be set from outside**
+     */
+    totalInAUD: number
     /**
      * Sum of prices of Products and/or Contracts in the current display currency that is used throughout the widgets. **This value is a computed getter meaning that it cannot be set from outside**
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@vonq/hapi-elements-types",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "This package contains Typescript definitions for HAPI Elements",
   "author": "VONQ HAPI Team",
   "license": "BSD-3-Clause",
@@ -12,7 +12,7 @@
     "publish:types": "npm publish --access public",
     "generate:index": "cti create ./src"
   },
-  "main": "src/index.ts",
+  "main": "index.ts",
   "types": "index.d.ts",
   "dependencies": {
     "@datadog/browser-logs": "^4.34.2",

package/{src/product → product}/enums.ts

@@ -8,4 +8,5 @@ export enum ProductPriceCurrency {
     "USD" = "USD",
     "EUR" = "EUR",
     "GBP" = "GBP",
+    "AUD" = "AUD",
 }

package/{src/product → product}/utils.types.ts

@@ -1,9 +1,5 @@
 import { ProductFilterQueryParams, ProductUserProvidedFilters } from "./types"
 import { PaginationResponseV1 } from "../common/types"
-import {
-    OrderJourneyPaymentMethod,
-    OrderJourneyStepKey,
-} from "../orderJourney/enums"
 import { WindowHapiUtils } from "../_window/utils.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 

package/{src/routing → routing}/state.types.ts

@@ -6,7 +6,7 @@ export type RouterState = {
     as: string
     options: RouteTransitionOptions
 }
-export type RouterStoreState = {
+export type RoutingState = {
     /**
      * Holds the current route "asPath" (NextJS Router related) path URL
      */

package/{src/theming → theming}/types.ts

@@ -1,4 +1,41 @@
-import { Theming } from "theming"
+import * as React from "react"
+
+type DefaultTheme = object | null
+
+type WithThemeFactory<Theme> = <
+    InnerProps extends { theme: NonNullable<Theme> },
+    InnerComponent extends React.ComponentType<InnerProps>,
+    OuterProps extends InnerProps & { theme?: NonNullable<Theme> },
+>(
+    comp: InnerComponent,
+) => React.ComponentType<OuterProps>
+
+interface ThemeProviderProps<Theme> {
+    theme: NonNullable<Theme> | ((outerTheme: Theme) => NonNullable<Theme>)
+    children: React.ReactNode
+}
+
+type ThemeProviderFactory<Theme> = React.ComponentType<
+    ThemeProviderProps<Theme>
+>
+
+type UseThemeFactory<Theme> = <CustomTheme = Theme>() => CustomTheme
+
+interface Theming<Theme> {
+    context: React.Context<Theme>
+    withTheme: WithThemeFactory<Theme>
+    ThemeProvider: ThemeProviderFactory<Theme>
+    useTheme: UseThemeFactory<Theme>
+}
+
+declare function createTheming<Theme>(
+    context: React.Context<Theme>,
+): Theming<Theme>
+
+declare const withTheme: WithThemeFactory<DefaultTheme>
+declare const ThemeProvider: ThemeProviderFactory<DefaultTheme>
+declare const ThemeContext: React.Context<DefaultTheme>
+declare const useTheme: UseThemeFactory<DefaultTheme>
 
 export type ThemeGlobalStyles = {
     borderRadius: string

package/tsconfig.json

@@ -23,7 +23,7 @@
     "forceConsistentCasingInFileNames": true
   },
   "include": [
-    "./src/**/*",
+    "**/*",
   ],
   "exclude": [
     "node_modules",