helphero - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

dist/helphero.d.ts

@@ -1,4 +0,4 @@
-declare type EventKind = "tour_started" | "tour_completed" | "tour_advanced" | "tour_cancelled" | "tour_interrupted" | "error";
-declare type Event = {
-    kind: EventKind;
+declare type TourEventKind = "tour_started" | "tour_completed" | "tour_advanced" | "tour_cancelled" | "tour_interrupted" | "error";
+declare type TourEvent = {
+    kind: TourEventKind;
     details?: string;
@@ -17,6 +17,25 @@ tourId?: string;
 };
-declare type EventInfo = {
+declare type TourEventInfo = {
     tour?: Tour;
     step?: Step;
 };
+declare type ChecklistEventKind = "checklist_completed" | "checklist_item_completed";
+declare type ChecklistEvent = {
+    kind: ChecklistEventKind;
+    checklistId: string;
+    itemId?: string;
+};
+declare type ChecklistItem = {
+    id: string;
+    name: string;
+};
+declare type Checklist = {
+    id: string;
+    name: string;
+    items: ChecklistItem[];
+};
+declare type ChecklistEventInfo = {
+    checklist: Checklist;
+    item?: ChecklistItem;
+};
 declare type Data = {
@@ -34,4 +53,6 @@ [key: string]: boolean | number | string | undefined | null;
     anonymous: () => void;
-    on: (kind: EventKind, fn: (ev: Event, info: EventInfo) => void) => void;
-    off: (kind: EventKind, fn: (ev: Event, info: EventInfo) => void) => void;
+    on(kind: TourEventKind, fn: (ev: TourEvent, info: TourEventInfo) => void): void;
+    off(kind: TourEventKind, fn: (ev: TourEvent, info: TourEventInfo) => void): void;
+    on(kind: ChecklistEventKind, fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void): void;
+    off(kind: ChecklistEventKind, fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void): void;
     openChecklist: () => void;
@@ -41,3 +62,6 @@ closeChecklist: () => void;
 };
-export default function initHelpHero(appId: string): HelpHero;
-export {};
+declare function initHelpHero(appId: string): HelpHero;
+declare namespace initHelpHero {
+    var default: typeof initHelpHero;
+}
+export default initHelpHero;

dist/helphero.flow.js

@@ -7,3 +7,3 @@ /**
 
-declare type EventKind =
+declare type TourEventKind =
   | "tour_started"
@@ -15,4 +15,4 @@ | "tour_completed"
   | "error";
-declare type Event = {
-  kind: EventKind,
+declare type TourEvent = {
+  kind: TourEventKind,
   details?: string,
@@ -31,6 +31,27 @@ tourId?: string,
 };
-declare type EventInfo = {
+declare type TourEventInfo = {
   tour?: Tour,
   step?: Step
 };
+declare type ChecklistEventKind =
+  | "checklist_completed"
+  | "checklist_item_completed";
+declare type ChecklistEvent = {
+  kind: ChecklistEventKind,
+  checklistId: string,
+  itemId?: string
+};
+declare type ChecklistItem = {
+  id: string,
+  name: string
+};
+declare type Checklist = {
+  id: string,
+  name: string,
+  items: ChecklistItem[]
+};
+declare type ChecklistEventInfo = {
+  checklist: Checklist,
+  item?: ChecklistItem
+};
 declare type Data = {
@@ -51,4 +72,18 @@ [key: string]: boolean | number | string | void | null
   anonymous: () => void,
-  on: (kind: EventKind, fn: (ev: Event, info: EventInfo) => void) => void,
-  off: (kind: EventKind, fn: (ev: Event, info: EventInfo) => void) => void,
+  on(
+    kind: TourEventKind,
+    fn: (ev: TourEvent, info: TourEventInfo) => void
+  ): void,
+  off(
+    kind: TourEventKind,
+    fn: (ev: TourEvent, info: TourEventInfo) => void
+  ): void,
+  on(
+    kind: ChecklistEventKind,
+    fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void
+  ): void,
+  off(
+    kind: ChecklistEventKind,
+    fn: (ev: ChecklistEvent, info: ChecklistEventInfo) => void
+  ): void,
   openChecklist: () => void,
@@ -58,3 +93,7 @@ closeChecklist: () => void,
 };
-declare export default function initHelpHero(appId: string): HelpHero;
-declare export {};
+declare var initHelpHero: typeof npm$namespace$initHelpHero;
+
+declare var npm$namespace$initHelpHero: {|
+  (appId: string): HelpHero
+|};
+declare export default typeof initHelpHero;

dist/helphero.js

@@ -59,2 +59,3 @@ (function (global, factory) {
   }
+  initHelpHero.default = initHelpHero;
 
@@ -61,0 +62,0 @@ return initHelpHero;

package.json

 {
   "name": "helphero",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Offical HelpHero SDK for browsers",
@@ -5,0 +5,0 @@ "repository": "git://github.com/HelpHero/helphero-javascript.git",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9503

increased by20.66%

Lines of code

216

increased by41.18%

No dependency changes