feat: Add location stub utility (#28)

* feat: Add `location` stub from prerenderer as a utility

* fix: Setup `globalThis.location` & support class methods

* test: Add tests for locationStub utility

Author: rschristian

src/prerender.d.ts

@@ -13,3 +13,5 @@ export default function prerender(
 	vnode: VNode,
 	options?: PrerenderOptions
 ): Promise<PrerenderResult>;
+
+export function locationStub(path: string): void;

src/prerender.js

@@ -40,3 +40,20 @@ export default async function prerender(vnode, options) {
 		vnodeHook = null;
 	}
 }
+
+/**
+ * Update `location` to current URL so routers can use things like `location.pathname`
+ *
+ * @param {string} path - current URL path
+ */
+export function locationStub(path) {
+	globalThis.location = {};
+	const u = new URL(path, 'http://localhost');
+	for (const i in u) {
+		try {
+            globalThis.location[i] = /to[A-Z]/.test(i)
+                ? u[i].bind(u)
+                : String(u[i]);
+		} catch {}
+	}
+}

test/location-stub.test.js

@@ -0,0 +1,36 @@
+import { describe, it, beforeEach, expect } from '@jest/globals';
+import { locationStub } from '../src/prerender.js';
+
+describe('location-stub', () => {
+	beforeEach(() => {
+		if (globalThis.location) {
+			delete globalThis.location;
+		}
+	});
+
+	it('Contains all Location instance properties', () => {
+		locationStub('/foo/bar?baz=qux#quux');
+
+		[
+			// 'ancestorOrigins', // Not supported by FireFox and sees little use, but we could add an empty val if it's needed
+			'hash',
+			'host',
+			'hostname',
+			'href',
+			'origin',
+			'pathname',
+			'port',
+			'protocol',
+			'search',
+		].forEach(key => {
+			expect(globalThis.location).toHaveProperty(key);
+		});
+	});
+
+	// Do we need to support `assign`, `reload`, and/or `replace`?
+	it('Support bound methods', () => {
+		locationStub('/foo/bar?baz=qux#quux');
+
+		expect(globalThis.location.toString()).toBe('http://localhost/foo/bar?baz=qux#quux');
+	});
+});