@trackunit/react-vite-test-setup 0.0.213 → 0.0.214
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs.js +60 -0
- package/index.esm.js +60 -1
- package/package.json +1 -1
- package/src/createMockGoogleMap.d.ts +42 -0
- package/src/index.d.ts +1 -0
package/index.cjs.js
CHANGED
|
@@ -91,6 +91,65 @@ const configureReliableAsyncUtils = () => {
|
|
|
91
91
|
react.configure({ asyncWrapper: reliableAsyncWrapper, asyncUtilTimeout: 10000 });
|
|
92
92
|
};
|
|
93
93
|
|
|
94
|
+
/**
|
|
95
|
+
* Creates a mock Google map instance for unit testing adapter instances directly.
|
|
96
|
+
* Requires `setupGoogleMaps()` in the vitest setup, which registers the
|
|
97
|
+
* `@googlemaps/jest-mocks` classes on `google.maps`.
|
|
98
|
+
*
|
|
99
|
+
* Use this when you need fine-grained control over mock behavior, such as:
|
|
100
|
+
* - Testing adapter instance methods (connect, setCenter, etc.)
|
|
101
|
+
* - Simulating map events (idle, click, bounds_changed) by name
|
|
102
|
+
* - Shaping the DOM a loader probes inside the map container
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* ```typescript
|
|
106
|
+
* import { createMockGoogleMap } from "@trackunit/react-vite-test-setup";
|
|
107
|
+
*
|
|
108
|
+
* it("should connect to map", () => {
|
|
109
|
+
* const { map, triggerEvent } = createMockGoogleMap();
|
|
110
|
+
* const adapter = new GoogleMapsAdapterInstance(config);
|
|
111
|
+
* adapter.connect(map);
|
|
112
|
+
* triggerEvent("idle");
|
|
113
|
+
* });
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
const createMockGoogleMap = () => {
|
|
117
|
+
const container = document.createElement("div");
|
|
118
|
+
const map = new google.maps.Map(container, {
|
|
119
|
+
center: { lat: 0, lng: 0 },
|
|
120
|
+
zoom: 10,
|
|
121
|
+
});
|
|
122
|
+
vitest.vi.spyOn(map, "getDiv").mockReturnValue(container);
|
|
123
|
+
const listeners = new Map();
|
|
124
|
+
vitest.vi.spyOn(map, "addListener").mockImplementation((eventName, handler) => {
|
|
125
|
+
let handlers = listeners.get(eventName);
|
|
126
|
+
if (handlers === undefined) {
|
|
127
|
+
handlers = new Set();
|
|
128
|
+
listeners.set(eventName, handlers);
|
|
129
|
+
}
|
|
130
|
+
handlers.add(handler);
|
|
131
|
+
const registered = handlers;
|
|
132
|
+
return {
|
|
133
|
+
remove: () => {
|
|
134
|
+
registered.delete(handler);
|
|
135
|
+
},
|
|
136
|
+
};
|
|
137
|
+
});
|
|
138
|
+
const triggerEvent = (eventName, eventArg) => {
|
|
139
|
+
// Copy first: a handler that removes itself must not skip its neighbours.
|
|
140
|
+
[...(listeners.get(eventName) ?? [])].forEach(handler => {
|
|
141
|
+
handler.call(map, eventArg);
|
|
142
|
+
});
|
|
143
|
+
};
|
|
144
|
+
const addEventLayer = () => {
|
|
145
|
+
const eventLayer = document.createElement("div");
|
|
146
|
+
eventLayer.setAttribute("style", "z-index: 3;");
|
|
147
|
+
container.appendChild(eventLayer);
|
|
148
|
+
return eventLayer;
|
|
149
|
+
};
|
|
150
|
+
return { map, container, triggerEvent, addEventLayer };
|
|
151
|
+
};
|
|
152
|
+
|
|
94
153
|
/**
|
|
95
154
|
* Sets up a mock implementation for HTML Canvas API in testing environments.
|
|
96
155
|
*
|
|
@@ -1455,6 +1514,7 @@ const setupTanstackReactRouter = () => {
|
|
|
1455
1514
|
|
|
1456
1515
|
exports.configureReliableAsyncUtils = configureReliableAsyncUtils;
|
|
1457
1516
|
exports.createMockClickEvent = createMockClickEvent;
|
|
1517
|
+
exports.createMockGoogleMap = createMockGoogleMap;
|
|
1458
1518
|
exports.createMockMapboxMap = createMockMapboxMap;
|
|
1459
1519
|
exports.resetTanstackReactVirtualMock = resetTanstackReactVirtualMock;
|
|
1460
1520
|
exports.setTanstackReactVirtualItems = setTanstackReactVirtualItems;
|
package/index.esm.js
CHANGED
|
@@ -70,6 +70,65 @@ const configureReliableAsyncUtils = () => {
|
|
|
70
70
|
configure({ asyncWrapper: reliableAsyncWrapper, asyncUtilTimeout: 10000 });
|
|
71
71
|
};
|
|
72
72
|
|
|
73
|
+
/**
|
|
74
|
+
* Creates a mock Google map instance for unit testing adapter instances directly.
|
|
75
|
+
* Requires `setupGoogleMaps()` in the vitest setup, which registers the
|
|
76
|
+
* `@googlemaps/jest-mocks` classes on `google.maps`.
|
|
77
|
+
*
|
|
78
|
+
* Use this when you need fine-grained control over mock behavior, such as:
|
|
79
|
+
* - Testing adapter instance methods (connect, setCenter, etc.)
|
|
80
|
+
* - Simulating map events (idle, click, bounds_changed) by name
|
|
81
|
+
* - Shaping the DOM a loader probes inside the map container
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* import { createMockGoogleMap } from "@trackunit/react-vite-test-setup";
|
|
86
|
+
*
|
|
87
|
+
* it("should connect to map", () => {
|
|
88
|
+
* const { map, triggerEvent } = createMockGoogleMap();
|
|
89
|
+
* const adapter = new GoogleMapsAdapterInstance(config);
|
|
90
|
+
* adapter.connect(map);
|
|
91
|
+
* triggerEvent("idle");
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
const createMockGoogleMap = () => {
|
|
96
|
+
const container = document.createElement("div");
|
|
97
|
+
const map = new google.maps.Map(container, {
|
|
98
|
+
center: { lat: 0, lng: 0 },
|
|
99
|
+
zoom: 10,
|
|
100
|
+
});
|
|
101
|
+
vi.spyOn(map, "getDiv").mockReturnValue(container);
|
|
102
|
+
const listeners = new Map();
|
|
103
|
+
vi.spyOn(map, "addListener").mockImplementation((eventName, handler) => {
|
|
104
|
+
let handlers = listeners.get(eventName);
|
|
105
|
+
if (handlers === undefined) {
|
|
106
|
+
handlers = new Set();
|
|
107
|
+
listeners.set(eventName, handlers);
|
|
108
|
+
}
|
|
109
|
+
handlers.add(handler);
|
|
110
|
+
const registered = handlers;
|
|
111
|
+
return {
|
|
112
|
+
remove: () => {
|
|
113
|
+
registered.delete(handler);
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
});
|
|
117
|
+
const triggerEvent = (eventName, eventArg) => {
|
|
118
|
+
// Copy first: a handler that removes itself must not skip its neighbours.
|
|
119
|
+
[...(listeners.get(eventName) ?? [])].forEach(handler => {
|
|
120
|
+
handler.call(map, eventArg);
|
|
121
|
+
});
|
|
122
|
+
};
|
|
123
|
+
const addEventLayer = () => {
|
|
124
|
+
const eventLayer = document.createElement("div");
|
|
125
|
+
eventLayer.setAttribute("style", "z-index: 3;");
|
|
126
|
+
container.appendChild(eventLayer);
|
|
127
|
+
return eventLayer;
|
|
128
|
+
};
|
|
129
|
+
return { map, container, triggerEvent, addEventLayer };
|
|
130
|
+
};
|
|
131
|
+
|
|
73
132
|
/**
|
|
74
133
|
* Sets up a mock implementation for HTML Canvas API in testing environments.
|
|
75
134
|
*
|
|
@@ -1432,4 +1491,4 @@ const setupTanstackReactRouter = () => {
|
|
|
1432
1491
|
}));
|
|
1433
1492
|
};
|
|
1434
1493
|
|
|
1435
|
-
export { configureReliableAsyncUtils, createMockClickEvent, createMockMapboxMap, resetTanstackReactVirtualMock, setTanstackReactVirtualItems, setTanstackReactVirtualStableInstance, setupAllMocks, setupBasicMocks, setupCanvasMock, setupDefaultMocks, setupFailOnConsole, setupGoogleMaps, setupHelmetMock, setupIntersectionObserver, setupLexical, setupMapbox, setupMatchMediaMock, setupReactTestingLibrary, setupReactVirtualizedAutoSizer, setupResizeObserver, setupTanstackReactRouter, setupTanstackReactVirtual, setupTimeAndLanguage, setupTimeZone, setupTranslations, setupWebStreams, tanstackReactVirtualMock };
|
|
1494
|
+
export { configureReliableAsyncUtils, createMockClickEvent, createMockGoogleMap, createMockMapboxMap, resetTanstackReactVirtualMock, setTanstackReactVirtualItems, setTanstackReactVirtualStableInstance, setupAllMocks, setupBasicMocks, setupCanvasMock, setupDefaultMocks, setupFailOnConsole, setupGoogleMaps, setupHelmetMock, setupIntersectionObserver, setupLexical, setupMapbox, setupMatchMediaMock, setupReactTestingLibrary, setupReactVirtualizedAutoSizer, setupResizeObserver, setupTanstackReactRouter, setupTanstackReactVirtual, setupTimeAndLanguage, setupTimeZone, setupTranslations, setupWebStreams, tanstackReactVirtualMock };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trackunit/react-vite-test-setup",
|
|
3
3
|
"description": "Test setup utilities for React applications",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.214",
|
|
5
5
|
"repository": "https://github.com/Trackunit/manager",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
7
7
|
"engines": {
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Return type of createMockGoogleMap: the mock map plus helpers for firing its
|
|
3
|
+
* events and shaping the DOM inside its container.
|
|
4
|
+
*/
|
|
5
|
+
export type MockGoogleMap = Readonly<{
|
|
6
|
+
/** A `google.maps.Map` from `@googlemaps/jest-mocks` whose `getDiv()` returns `container`. */
|
|
7
|
+
map: google.maps.Map;
|
|
8
|
+
/** The element `map.getDiv()` returns; empty until `addEventLayer` runs. */
|
|
9
|
+
container: HTMLDivElement;
|
|
10
|
+
/** Invokes every handler registered through `map.addListener(eventName, ...)`. */
|
|
11
|
+
triggerEvent: (eventName: string, eventArg?: unknown) => void;
|
|
12
|
+
/**
|
|
13
|
+
* Appends the element Google renders its pointer events on, which
|
|
14
|
+
* `terra-draw-google-maps-adapter` finds through the inline `z-index: 3` style
|
|
15
|
+
* (SAGA-985). Left out, the container stands in for a map whose panes are not
|
|
16
|
+
* rendered yet, or for a Maps JS release that restructured them.
|
|
17
|
+
*/
|
|
18
|
+
addEventLayer: () => HTMLElement;
|
|
19
|
+
}>;
|
|
20
|
+
/**
|
|
21
|
+
* Creates a mock Google map instance for unit testing adapter instances directly.
|
|
22
|
+
* Requires `setupGoogleMaps()` in the vitest setup, which registers the
|
|
23
|
+
* `@googlemaps/jest-mocks` classes on `google.maps`.
|
|
24
|
+
*
|
|
25
|
+
* Use this when you need fine-grained control over mock behavior, such as:
|
|
26
|
+
* - Testing adapter instance methods (connect, setCenter, etc.)
|
|
27
|
+
* - Simulating map events (idle, click, bounds_changed) by name
|
|
28
|
+
* - Shaping the DOM a loader probes inside the map container
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```typescript
|
|
32
|
+
* import { createMockGoogleMap } from "@trackunit/react-vite-test-setup";
|
|
33
|
+
*
|
|
34
|
+
* it("should connect to map", () => {
|
|
35
|
+
* const { map, triggerEvent } = createMockGoogleMap();
|
|
36
|
+
* const adapter = new GoogleMapsAdapterInstance(config);
|
|
37
|
+
* adapter.connect(map);
|
|
38
|
+
* triggerEvent("idle");
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const createMockGoogleMap: () => MockGoogleMap;
|