@vonq/hapi-elements-types 1.58.0 → 1.59.0

package/common/events/EventCommand/enums.ts

@@ -52,6 +52,9 @@ export enum WindowHapiEventCommandName {
     domElementMounted = "dom:element-mounted",
     domElementUnmounted = "dom:element-unmounted",
     domChangeIcons = "dom:change-icons",
+    domScrollTo = "dom:scroll-to",
+    domGetScroll = "dom:get-scroll",
+    domEventTriggered = "dom:dom-event-triggered",
 
     /* Location */
     locationSetHref = "location:href",

package/common/types.ts

@@ -301,3 +301,5 @@ export type HapiFeatureBranch = {
 export type FlattenedItem = { label: string; value: any }
 
 export type StringifiedJSON<T> = string
+
+export type DOMEventType = keyof GlobalEventHandlersEventMap

package/package.json

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

package/ui/service.types.ts

@@ -1,7 +1,12 @@
 import { WindowHapiService } from "../_window/service.types"
 import { WindowHapiModuleWithConstructorArgs } from "../_window"
 
-import { HapiUIIconConfig } from "./types"
+import {
+    HAPIDomEventTriggeredEventSerializable,
+    HAPIDOMEventTriggeredEventType,
+    HapiUIIconConfig,
+    HAPIUIScrollPosition,
+} from "./types"
 
 export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
     {
@@ -39,6 +44,20 @@ export type WindowHapiServiceUI = WindowHapiModuleWithConstructorArgs<
         hideElement: (elementSelector: string) => Promise<string>
         showElement: (elementSelector: string) => Promise<string>
         changeIcons: (configs: HapiUIIconConfig[]) => Promise<void>
+        scrollTo: (
+            iframeName: string,
+            elementSelector: string,
+            scrollToOptions: ScrollToOptions,
+        ) => Promise<void>
+        getScrollPosition: (
+            iframeName: string,
+            elementSelector: string,
+        ) => Promise<HAPIUIScrollPosition>
+        onDOMEvent: (
+            elementSelector: string,
+            eventName: HAPIDOMEventTriggeredEventType,
+            callback: (event: HAPIDomEventTriggeredEventSerializable) => void,
+        ) => Promise<string>
     },
     { readonly service: WindowHapiService }
 >

package/ui/types.ts

@@ -1,4 +1,5 @@
 import { HapiUIIconType } from "./enums"
+import { DOMEventType } from "../common"
 
 export type HapiUIIconConfig = {
     fromType: HapiUIIconType
@@ -8,3 +9,24 @@ export type HapiUIIconConfig = {
     // lottieFilePath can only be used when the 'toType' is of type 'lottie'
     lottieFilePath?: string
 }
+
+export type HAPIUIScrollPosition = {
+    top: number
+    left: number
+}
+
+export type HAPIDOMEventTriggeredEventType = Extract<DOMEventType, "scroll">
+
+export type HAPIDomEventTriggeredEventSerializable = {
+    type: string
+    timeStamp: number
+    target: string
+    currentTarget: string
+    key?: string
+    code?: string
+    value?: string
+    checked?: boolean
+    scrollTop?: number
+    scrollLeft?: number
+    path: string[]
+}