v3.8.0

HelpHero · May 6, 2023 · 39fe183 · 39fe183
1 parent cd50709
commit 39fe183
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "helphero",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Offical HelpHero SDK for browsers",
   "repository": "git://github.com/HelpHero/helphero-javascript.git",
   "homepage": "https://github.com/HelpHero/helphero-javascript",

diff --git a/src/helphero.ts b/src/helphero.ts
@@ -52,6 +52,22 @@ export type ChecklistEventInfo = {
   item?: ChecklistItem;
 };
 
+type HotspotEventKind = "hotspot_visited" | "hotspot_dismissed";
+
+export type HotspotEvent = {
+  kind: HotspotEventKind;
+  hotspotId: string;
+};
+
+export type Hotspot = {
+  id: string;
+  name: string;
+};
+
+export type HotspotEventInfo = {
+  hotspot: Hotspot;
+};
+
 type Data = {
   [key: string]: boolean | number | string | undefined | null;
 };
@@ -96,6 +112,11 @@ export type HelpHero = {
     fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void,
     context?: any
   ): void;
+  on(
+    kind: HotspotEventKind,
+    fn: (ev: HotspotEvent, info: HotspotEventInfo) => void,
+    context?: any
+  ): void;
   off(
     fn: (
       ev: TourEvent | ChecklistEvent,
@@ -113,6 +134,11 @@ export type HelpHero = {
     fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void,
     context?: any
   ): void;
+  off(
+    kind: HotspotEventKind,
+    fn: (ev: HotspotEvent, info: HotspotEventInfo) => void,
+    context?: any
+  ): void;
   openChecklist: () => void;
   closeChecklist: () => void;
   startChecklist: (id: string) => void;