feat: google.maps.event mocks (#189)

Author: eegli

.gitignore

@@ -2,6 +2,7 @@ node_modules
 dist/
 .npmrc
 **/docs
+.prettierrc
 
 # Logs
 logs

src/drawing/marker/marker.ts

@@ -15,6 +15,7 @@
  */
 
 import { LatLng } from "../../maps/coordinates/latlng";
+import { MapsEventListener } from "../../maps/event/event";
 import { MVCObject } from "../../maps/event/mvcobject";
 
 export class Marker extends MVCObject implements google.maps.Marker {
@@ -124,7 +125,6 @@ export class Marker extends MVCObject implements google.maps.Marker {
       (
         eventName: string,
         handler: (this: Marker, event: MouseEvent) => void
-      ): google.maps.MapsEventListener =>
-        jest.fn() as unknown as google.maps.MapsEventListener
+      ): google.maps.MapsEventListener => MapsEventListener
     );
 }

src/index.ts

@@ -44,6 +44,7 @@ import {
 import { StreetViewService } from "./street-view/service/service";
 import { ControlPosition } from "./maps/controls/controlposition";
 import { MapTypeId } from "./maps/maps/constants";
+import { event } from "./maps/event/event";
 
 const initialize = function (): void {
   (global as any).google = {
@@ -66,16 +67,7 @@ const initialize = function (): void {
       StreetViewPreference: StreetViewPreference,
       StreetViewSource: StreetViewSource,
       StreetViewStatus: StreetViewStatus,
-      event: {
-        addListener: jest.fn(),
-        addListenerOnce: jest.fn(),
-        addDomListerner: jest.fn(),
-        addDomListernerOnce: jest.fn(),
-        clearInstanceListeners: jest.fn(),
-        clearListeners: jest.fn(),
-        removeListener: jest.fn(),
-        trigger: jest.fn(),
-      },
+      event: event,
       places: {
         Autocomplete: Autocomplete,
         SearchBox: SearchBox,
@@ -93,6 +85,7 @@ const initialize = function (): void {
 export {
   Circle,
   Data,
+  event,
   Feature,
   LatLng,
   LatLngBounds,

src/maps/event/event.test.ts

@@ -0,0 +1,7 @@
+import { initialize } from "../../index";
+import { event } from "./event";
+
+test("event system", () => {
+  initialize();
+  expect(google.maps.event).toStrictEqual(event);
+});

src/maps/event/event.ts

@@ -0,0 +1,65 @@
+export const MapsEventListener: google.maps.MapsEventListener = {
+  remove: jest.fn(),
+};
+
+export const event: typeof google.maps.event = {
+  addDomListener: jest
+    .fn()
+    .mockImplementation(
+      (
+        instance: object,
+        eventName: string,
+        handler: Function,
+        capture?: boolean
+      ): google.maps.MapsEventListener => MapsEventListener
+    ),
+  addDomListenerOnce: jest
+    .fn()
+    .mockImplementation(
+      (
+        instance: object,
+        eventName: string,
+        handler: Function,
+        capture?: boolean
+      ): google.maps.MapsEventListener => MapsEventListener
+    ),
+  addListener: jest
+    .fn()
+    .mockImplementation(
+      (
+        instance: object,
+        eventName: string,
+        handler: Function
+      ): google.maps.MapsEventListener => MapsEventListener
+    ),
+  addListenerOnce: jest
+    .fn()
+    .mockImplementation(
+      (
+        instance: object,
+        eventName: string,
+        handler: Function
+      ): google.maps.MapsEventListener => MapsEventListener
+    ),
+  clearInstanceListeners: jest
+    .fn()
+    .mockImplementation((instance: object): void => null),
+  clearListeners: jest
+    .fn()
+    .mockImplementation((instance: object, eventName: string): void => null),
+  hasListeners: jest
+    .fn()
+    .mockImplementation(
+      (instance: object, eventName: string): boolean => false
+    ),
+  removeListener: jest
+    .fn()
+    .mockImplementation(
+      (listener: google.maps.MapsEventListener): void => null
+    ),
+  trigger: jest
+    .fn()
+    .mockImplementation(
+      (instance: object, eventName: string, ...eventArgs: any[]): void => null
+    ),
+};

src/maps/event/mvcobject.test.ts

@@ -6,6 +6,7 @@ test("instances are stored", () => {
   const mvcObject = new MVCObject();
   expect(MVCObject.mockInstances).toStrictEqual([mvcObject]);
   expect(MVCObject.mockInstances[0].addListener).toBeTruthy();
+  expect(mvcObject.addListener()).toBeTruthy();
 });
 
 test("setup child class", () => {

src/maps/event/mvcobject.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { MapsEventListener } from "./event";
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 export class MVCObject implements google.maps.MVCObject {
@@ -38,7 +40,8 @@ export class MVCObject implements google.maps.MVCObject {
   public addListener = jest
     .fn()
     .mockImplementation(
-      (eventName: string, handler: (...args: any[]) => void): void => null
+      (eventName: string, handler: Function): google.maps.MapsEventListener =>
+        MapsEventListener
     );
   public bindTo = jest
     .fn()