@php-wasm/web-service-worker 0.1.2 → 0.1.3

package/package.json

@@ -1,23 +1,30 @@
 {
-	"name": "@php-wasm/web-service-worker",
-	"version": "0.1.2",
-	"description": "PHP.wasm – service worker utils",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/WordPress/wordpress-playground"
-	},
-	"homepage": "https://developer.wordpress.org/playground",
-	"author": "The WordPress contributors",
-	"contributors": [
-		{
-			"name": "Adam Zielinski",
-			"email": "adam@adamziel.com",
-			"url": "https://github.com/adamziel"
-		}
-	],
-	"license": "GPL-2.0-or-later",
-	"type": "module",
-	"main": "src/index.js",
-	"types": "src/index.d.ts",
-	"gitHead": "a0eeb66fd5386bb56715fca2b89e9669a5b8618b"
+  "name": "@php-wasm/web-service-worker",
+  "version": "0.1.3",
+  "description": "PHP.wasm – service worker utils",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/WordPress/wordpress-playground"
+  },
+  "homepage": "https://developer.wordpress.org/playground",
+  "author": "The WordPress contributors",
+  "contributors": [
+    {
+      "name": "Adam Zielinski",
+      "email": "adam@adamziel.com",
+      "url": "https://github.com/adamziel"
+    }
+  ],
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../../dist/packages/php-wasm/web-service-worker"
+  },
+  "license": "GPL-2.0-or-later",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "gitHead": "ac5bf6b09cb425d650bc57eff03eac6417cccd49",
+  "dependencies": {
+    "@php-wasm/scopes": "0.1.3"
+  }
 }

package/src/index.js

@@ -0,0 +1,3 @@
+export * from './initialize-service-worker';
+export * from './messaging';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC"}

package/src/initialize-service-worker.d.ts

@@ -0,0 +1,71 @@
+/// <reference lib="webworker" />
+/**
+ * Run this function in the service worker to install the required event
+ * handlers.
+ *
+ * @param  config
+ */
+export declare function initializeServiceWorker(config: ServiceWorkerConfiguration): void;
+export declare function convertFetchEventToPHPRequest(event: FetchEvent): Promise<Response>;
+/**
+ * Sends the message to all the controlled clients
+ * of this service worker.
+ *
+ * This used to be implemented with a BroadcastChannel, but
+ * it didn't work in Safari. BroadcastChannel breaks iframe
+ * embedding the playground in Safari.
+ *
+ * Weirdly, Safari does not pass any messages from the ServiceWorker
+ * to Window if the page is rendered inside an iframe. Window to Service
+ * Worker communication works just fine.
+ *
+ * The regular client.postMessage() communication works perfectly, so that's
+ * what this function uses to broadcast the message.
+ *
+ * @param  message The message to broadcast.
+ * @param  scope   Target worker thread scope.
+ * @returns The request ID to receive the reply.
+ */
+export declare function broadcastMessageExpectReply(message: any, scope: string): Promise<number>;
+interface ServiceWorkerConfiguration {
+    /**
+     * The version of the service worker – exposed via the /version endpoint.
+     *
+     * This is used by the frontend app to know whether it's time to update
+     * the service worker registration.
+     */
+    version: string | (() => string);
+    handleRequest?: (event: FetchEvent) => Promise<Response> | undefined;
+}
+/**
+ * Guesses whether the given path looks like a PHP file.
+ *
+ * @example
+ * ```js
+ * seemsLikeAPHPServerPath('/index.php') // true
+ * seemsLikeAPHPServerPath('/index.php') // true
+ * seemsLikeAPHPServerPath('/index.php/foo/bar') // true
+ * seemsLikeAPHPServerPath('/index.html') // false
+ * seemsLikeAPHPServerPath('/index.html/foo/bar') // false
+ * seemsLikeAPHPServerPath('/') // true
+ * ```
+ *
+ * @param  path The path to check.
+ * @returns Whether the path seems like a PHP server path.
+ */
+export declare function seemsLikeAPHPServerPath(path: string): boolean;
+/**
+ * Copy a request with custom overrides.
+ *
+ * This function is only needed because Request properties
+ * are read-only. The only way to change e.g. a URL is to
+ * create an entirely new request:
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/API/Request
+ *
+ * @param  request
+ * @param  overrides
+ * @returns The new request.
+ */
+export declare function cloneRequest(request: Request, overrides: Record<string, any>): Promise<Request>;
+export {};

package/src/initialize-service-worker.js

@@ -0,0 +1,306 @@
+import { awaitReply, getNextRequestId } from './messaging';
+import { getURLScope, isURLScoped, removeURLScope, setURLScope, } from '@php-wasm/scopes';
+/**
+ * Run this function in the service worker to install the required event
+ * handlers.
+ *
+ * @param  config
+ */
+export function initializeServiceWorker(config) {
+    const { version, handleRequest = defaultRequestHandler } = config;
+    /**
+     * Enable the client app to force-update the service worker
+     * registration.
+     */
+    self.addEventListener('message', (event) => {
+        if (!event.data) {
+            return;
+        }
+        if (event.data === 'skip-waiting') {
+            self.skipWaiting();
+        }
+    });
+    /**
+     * Ensure the client gets claimed by this service worker right after the registration.
+     *
+     * Only requests from the "controlled" pages are resolved via the fetch listener below.
+     * However, simply registering the worker is not enough to make it the "controller" of
+     * the current page. The user still has to reload the page. If they don't an iframe
+     * pointing to /index.php will show a 404 message instead of a homepage.
+     *
+     * This activation handles saves the user reloading the page after the initial confusion.
+     * It immediately makes this worker the controller of any client that registers it.
+     */
+    self.addEventListener('activate', (event) => {
+        // eslint-disable-next-line no-undef
+        event.waitUntil(self.clients.claim());
+    });
+    /**
+     * The main method. It captures the requests and loop them back to the
+     * Worker Thread using the Loopback request
+     */
+    self.addEventListener('fetch', (event) => {
+        const url = new URL(event.request.url);
+        // Provide a custom JSON response in the special /version endpoint
+        // so the frontend app can know whether it's time to update the
+        // service worker registration.
+        if (url.pathname === '/version') {
+            event.preventDefault();
+            const currentVersion = typeof version === 'function' ? version() : version;
+            event.respondWith(new Response(JSON.stringify({ version: currentVersion }), {
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                status: 200,
+            }));
+            return;
+        }
+        // Don't handle requests to the service worker script itself.
+        if (url.pathname.startsWith(self.location.pathname)) {
+            return;
+        }
+        // Only handle requests from scoped sites.
+        // So – bale out if the request URL is not scoped and the
+        // referrer URL is not scoped.
+        if (!isURLScoped(url)) {
+            let referrerUrl;
+            try {
+                referrerUrl = new URL(event.request.referrer);
+            }
+            catch (e) {
+                return;
+            }
+            if (!isURLScoped(referrerUrl)) {
+                // Let the browser handle uncoped requests as is.
+                return;
+            }
+        }
+        console.debug(`[ServiceWorker] Serving request: ${getRelativePart(removeURLScope(url))}`);
+        const responsePromise = handleRequest(event);
+        if (responsePromise) {
+            event.respondWith(responsePromise);
+        }
+    });
+}
+async function defaultRequestHandler(event) {
+    event.preventDefault();
+    const url = new URL(event.request.url);
+    const unscopedUrl = removeURLScope(url);
+    if (!seemsLikeAPHPServerPath(unscopedUrl.pathname)) {
+        return fetch(await cloneRequest(event.request, {
+            url,
+        }));
+    }
+    return convertFetchEventToPHPRequest(event);
+}
+export async function convertFetchEventToPHPRequest(event) {
+    let url = new URL(event.request.url);
+    if (!isURLScoped(url)) {
+        try {
+            const referrerUrl = new URL(event.request.referrer);
+            url = setURLScope(url, getURLScope(referrerUrl));
+        }
+        catch (e) {
+            // ignore
+        }
+    }
+    const { body, files, contentType } = await rewritePost(event.request);
+    const requestHeaders = {};
+    for (const pair of event.request.headers.entries()) {
+        requestHeaders[pair[0]] = pair[1];
+    }
+    let phpResponse;
+    try {
+        const message = {
+            method: 'request',
+            args: [
+                {
+                    body,
+                    files,
+                    absoluteUrl: url.toString(),
+                    method: event.request.method,
+                    headers: {
+                        ...requestHeaders,
+                        Host: url.host,
+                        // Safari and Firefox don't make the User-Agent header
+                        // available in the fetch event. Let's add it manually:
+                        'User-agent': self.navigator.userAgent,
+                        'Content-type': contentType,
+                    },
+                },
+            ],
+        };
+        const scope = getURLScope(url);
+        if (scope === null) {
+            throw new Error(`The URL ${url.toString()} is not scoped. This should not happen.`);
+        }
+        console.debug('[ServiceWorker] Forwarding a request to the Worker Thread', {
+            message,
+        });
+        const requestId = await broadcastMessageExpectReply(message, scope);
+        phpResponse = await awaitReply(self, requestId);
+        // X-frame-options gets in a way when PHP is
+        // being displayed in an iframe.
+        delete phpResponse.headers['x-frame-options'];
+        console.debug('[ServiceWorker] Response received from the main app', {
+            phpResponse,
+        });
+    }
+    catch (e) {
+        console.error(e, { url: url.toString() });
+        throw e;
+    }
+    return new Response(phpResponse.body, {
+        headers: phpResponse.headers,
+        status: phpResponse.httpStatusCode,
+    });
+}
+/**
+ * Sends the message to all the controlled clients
+ * of this service worker.
+ *
+ * This used to be implemented with a BroadcastChannel, but
+ * it didn't work in Safari. BroadcastChannel breaks iframe
+ * embedding the playground in Safari.
+ *
+ * Weirdly, Safari does not pass any messages from the ServiceWorker
+ * to Window if the page is rendered inside an iframe. Window to Service
+ * Worker communication works just fine.
+ *
+ * The regular client.postMessage() communication works perfectly, so that's
+ * what this function uses to broadcast the message.
+ *
+ * @param  message The message to broadcast.
+ * @param  scope   Target worker thread scope.
+ * @returns The request ID to receive the reply.
+ */
+export async function broadcastMessageExpectReply(message, scope) {
+    const requestId = getNextRequestId();
+    for (const client of await self.clients.matchAll({
+        // Sometimes the client that triggered the current fetch()
+        // event is considered uncontrolled in Google Chrome. This
+        // only happens on the first few fetches() after the initial
+        // registration of the service worker.
+        includeUncontrolled: true,
+    })) {
+        client.postMessage({
+            ...message,
+            /**
+             * Attach the scope with a URL starting with `/scope:` to this message.
+             *
+             * We need this mechanics because this worker broadcasts
+             * events to all the listeners across all browser tabs. Scopes
+             * helps WASM workers ignore requests meant for other WASM workers.
+             */
+            scope,
+            requestId,
+        });
+    }
+    return requestId;
+}
+/**
+ * Guesses whether the given path looks like a PHP file.
+ *
+ * @example
+ * ```js
+ * seemsLikeAPHPServerPath('/index.php') // true
+ * seemsLikeAPHPServerPath('/index.php') // true
+ * seemsLikeAPHPServerPath('/index.php/foo/bar') // true
+ * seemsLikeAPHPServerPath('/index.html') // false
+ * seemsLikeAPHPServerPath('/index.html/foo/bar') // false
+ * seemsLikeAPHPServerPath('/') // true
+ * ```
+ *
+ * @param  path The path to check.
+ * @returns Whether the path seems like a PHP server path.
+ */
+export function seemsLikeAPHPServerPath(path) {
+    return seemsLikeAPHPFile(path) || seemsLikeADirectoryRoot(path);
+}
+function seemsLikeAPHPFile(path) {
+    return path.endsWith('.php') || path.includes('.php/');
+}
+function seemsLikeADirectoryRoot(path) {
+    const lastSegment = path.split('/').pop();
+    return !lastSegment.includes('.');
+}
+async function rewritePost(request) {
+    const contentType = request.headers.get('content-type');
+    if (request.method !== 'POST') {
+        return {
+            contentType,
+            body: undefined,
+            files: undefined,
+        };
+    }
+    // If the request contains multipart form data, rewrite it
+    // to a regular form data and handle files separately.
+    const isMultipart = contentType
+        .toLowerCase()
+        .startsWith('multipart/form-data');
+    if (isMultipart) {
+        try {
+            const formData = (await request.clone().formData());
+            const post = {};
+            const files = {};
+            for (const key of formData.keys()) {
+                const value = formData.get(key);
+                if (value instanceof File) {
+                    files[key] = value;
+                }
+                else {
+                    post[key] = value;
+                }
+            }
+            return {
+                contentType: 'application/x-www-form-urlencoded',
+                body: new URLSearchParams(post).toString(),
+                files,
+            };
+        }
+        catch (e) {
+            // ignore
+        }
+    }
+    // Otherwise, grab body as literal text
+    return {
+        contentType,
+        body: await request.clone().text(),
+        files: {},
+    };
+}
+/**
+ * Copy a request with custom overrides.
+ *
+ * This function is only needed because Request properties
+ * are read-only. The only way to change e.g. a URL is to
+ * create an entirely new request:
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/API/Request
+ *
+ * @param  request
+ * @param  overrides
+ * @returns The new request.
+ */
+export async function cloneRequest(request, overrides) {
+    const body = ['GET', 'HEAD'].includes(request.method) || 'body' in overrides
+        ? undefined
+        : await request.blob();
+    return new Request(overrides['url'] || request.url, {
+        body,
+        method: request.method,
+        headers: request.headers,
+        referrer: request.referrer,
+        referrerPolicy: request.referrerPolicy,
+        mode: request.mode === 'navigate' ? 'same-origin' : request.mode,
+        credentials: request.credentials,
+        cache: request.cache,
+        redirect: request.redirect,
+        integrity: request.integrity,
+        ...overrides,
+    });
+}
+function getRelativePart(url) {
+    return url.toString().substring(url.origin.length);
+}
+//# sourceMappingURL=initialize-service-worker.js.map

package/src/initialize-service-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialize-service-worker.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/initialize-service-worker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACN,WAAW,EACX,WAAW,EACX,cAAc,EACd,WAAW,GACX,MAAM,kBAAkB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAkC;IACzE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,qBAAqB,EAAE,GAAG,MAAM,CAAC;IAClE;;;OAGG;IACH,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QAC1C,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YAChB,OAAO;SACP;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YAClC,IAAI,CAAC,WAAW,EAAE,CAAC;SACnB;IACF,CAAC,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;QAC3C,oCAAoC;QACpC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH;;;OAGG;IACH,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACxC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEvC,kEAAkE;QAClE,+DAA+D;QAC/D,+BAA+B;QAC/B,IAAI,GAAG,CAAC,QAAQ,KAAK,UAAU,EAAE;YAChC,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,MAAM,cAAc,GACnB,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACrD,KAAK,CAAC,WAAW,CAChB,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE;gBACzD,OAAO,EAAE;oBACR,cAAc,EAAE,kBAAkB;iBAClC;gBACD,MAAM,EAAE,GAAG;aACX,CAAC,CACF,CAAC;YACF,OAAO;SACP;QAED,6DAA6D;QAC7D,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACpD,OAAO;SACP;QAED,0CAA0C;QAC1C,yDAAyD;QACzD,8BAA8B;QAC9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;YACtB,IAAI,WAAW,CAAC;YAChB,IAAI;gBACH,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAC9C;YAAC,OAAO,CAAC,EAAE;gBACX,OAAO;aACP;YACD,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE;gBAC9B,iDAAiD;gBACjD,OAAO;aACP;SACD;QAED,OAAO,CAAC,KAAK,CACZ,oCAAoC,eAAe,CAClD,cAAc,CAAC,GAAG,CAAC,CACnB,EAAE,CACH,CAAC;QACF,MAAM,eAAe,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,eAAe,EAAE;YACpB,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;SACnC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,KAAiB;IACrD,KAAK,CAAC,cAAc,EAAE,CAAC;IACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACnD,OAAO,KAAK,CACX,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE;YACjC,GAAG;SACH,CAAC,CACF,CAAC;KACF;IACD,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,KAAiB;IACpE,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAErC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;QACtB,IAAI;YACH,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,WAAW,CAAE,CAAC,CAAC;SAClD;QAAC,OAAO,CAAC,EAAE;YACX,SAAS;SACT;KACD;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,cAAc,GAA2B,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAK,KAAK,CAAC,OAAO,CAAC,OAAe,CAAC,OAAO,EAAE,EAAE;QAC5D,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;KAClC;IAED,IAAI,WAAW,CAAC;IAChB,IAAI;QACH,MAAM,OAAO,GAAG;YACf,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE;gBACL;oBACC,IAAI;oBACJ,KAAK;oBACL,WAAW,EAAE,GAAG,CAAC,QAAQ,EAAE;oBAC3B,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM;oBAC5B,OAAO,EAAE;wBACR,GAAG,cAAc;wBACjB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,sDAAsD;wBACtD,uDAAuD;wBACvD,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;wBACtC,cAAc,EAAE,WAAW;qBAC3B;iBACD;aACD;SACD,CAAC;QACF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,IAAI,EAAE;YACnB,MAAM,IAAI,KAAK,CACd,WAAW,GAAG,CAAC,QAAQ,EAAE,yCAAyC,CAClE,CAAC;SACF;QACD,OAAO,CAAC,KAAK,CACZ,2DAA2D,EAC3D;YACC,OAAO;SACP,CACD,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,2BAA2B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpE,WAAW,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAEhD,4CAA4C;QAC5C,gCAAgC;QAChC,OAAO,WAAW,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAE9C,OAAO,CAAC,KAAK,CAAC,qDAAqD,EAAE;YACpE,WAAW;SACX,CAAC,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACX,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,CAAC;KACR;IAED,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE;QACrC,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,MAAM,EAAE,WAAW,CAAC,cAAc;KAClC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,OAAY,EAAE,KAAa;IAC5E,MAAM,SAAS,GAAG,gBAAgB,EAAE,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAChD,0DAA0D;QAC1D,0DAA0D;QAC1D,4DAA4D;QAC5D,sCAAsC;QACtC,mBAAmB,EAAE,IAAI;KACzB,CAAC,EAAE;QACH,MAAM,CAAC,WAAW,CAAC;YAClB,GAAG,OAAO;YACV;;;;;;eAMG;YACH,KAAK;YACL,SAAS;SACT,CAAC,CAAC;KACH;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAaD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAY;IACnD,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,uBAAuB,CAAC,IAAY;IAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAC1C,OAAO,CAAC,WAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,OAAgB;IAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAE,CAAC;IACzD,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE;QAC9B,OAAO;YACN,WAAW;YACX,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;SAChB,CAAC;KACF;IAED,0DAA0D;IAC1D,sDAAsD;IACtD,MAAM,WAAW,GAAG,WAAW;SAC7B,WAAW,EAAE;SACb,UAAU,CAAC,qBAAqB,CAAC,CAAC;IACpC,IAAI,WAAW,EAAE;QAChB,IAAI;YACH,MAAM,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAQ,CAAC;YAC3D,MAAM,IAAI,GAA2B,EAAE,CAAC;YACxC,MAAM,KAAK,GAAyB,EAAE,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAChC,IAAI,KAAK,YAAY,IAAI,EAAE;oBAC1B,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBACnB;qBAAM;oBACN,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBAClB;aACD;YAED,OAAO;gBACN,WAAW,EAAE,mCAAmC;gBAChD,IAAI,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;gBAC1C,KAAK;aACL,CAAC;SACF;QAAC,OAAO,CAAC,EAAE;YACX,SAAS;SACT;KACD;IAED,uCAAuC;IACvC,OAAO;QACN,WAAW;QACX,IAAI,EAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE;QAClC,KAAK,EAAE,EAAE;KACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CACjC,OAAgB,EAChB,SAA8B;IAE9B,MAAM,IAAI,GACT,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,SAAS;QAC9D,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE;QACnD,IAAI;QACJ,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI;QAChE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,GAAG,SAAS;KACZ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,GAAQ;IAChC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC"}

package/src/{messaging.ts → messaging.d.ts}

@@ -1,7 +1,3 @@
-const DEFAULT_RESPONSE_TIMEOUT = 25000;
-
-let lastRequestId = 0;
-
 /**
  * Posts a message branded with a unique `requestId` to the given `target`.
  * Then returns the `requestId` so it can be used to await a reply.
@@ -48,26 +44,8 @@ let lastRequestId = 0;
  * @param  postMessageArgs Additional arguments to pass to `postMessage`.
  * @returns The message ID for awaitReply().
  */
-export function postMessageExpectReply(
-	target: PostMessageTarget,
-	message: Record<string, any>,
-	...postMessageArgs: any[]
-): number {
-	const requestId = getNextRequestId();
-	target.postMessage(
-		{
-			...message,
-			requestId,
-		},
-		...postMessageArgs
-	);
-	return requestId;
-}
-
-export function getNextRequestId() {
-	return ++lastRequestId;
-}
-
+export declare function postMessageExpectReply(target: PostMessageTarget, message: Record<string, any>, ...postMessageArgs: any[]): number;
+export declare function getNextRequestId(): number;
 /**
  * Awaits a reply to the message with the given ID.
  *
@@ -80,32 +58,7 @@ export function getNextRequestId() {
  *                       throwing an error.
  * @returns The reply from the messageTarget.
  */
-export function awaitReply(
-	messageTarget: IsomorphicEventTarget,
-	requestId: number,
-	timeout: number = DEFAULT_RESPONSE_TIMEOUT
-): Promise<any> {
-	return new Promise((resolve, reject) => {
-		const responseHandler = (event: MessageEvent) => {
-			if (
-				event.data.type === 'response' &&
-				event.data.requestId === requestId
-			) {
-				messageTarget.removeEventListener('message', responseHandler);
-				clearTimeout(failOntimeout);
-				resolve(event.data.response);
-			}
-		};
-
-		const failOntimeout = setTimeout(() => {
-			reject(new Error('Request timed out'));
-			messageTarget.removeEventListener('message', responseHandler);
-		}, timeout);
-
-		messageTarget.addEventListener('message', responseHandler);
-	});
-}
-
+export declare function awaitReply(messageTarget: IsomorphicEventTarget, requestId: number, timeout?: number): Promise<any>;
 /**
  * Creates a response message to the given message ID.
  *
@@ -115,28 +68,17 @@ export function awaitReply(
  * @param  response  The response to send back to the messageTarget.
  * @returns A message object that can be sent back to the other thread.
  */
-export function responseTo<T>(
-	requestId: number,
-	response: T
-): MessageResponse<T> {
-	return {
-		type: 'response',
-		requestId,
-		response,
-	};
-}
-
+export declare function responseTo<T>(requestId: number, response: T): MessageResponse<T>;
 export interface MessageResponse<T> {
-	type: 'response';
-	requestId: number;
-	response: T;
+    type: 'response';
+    requestId: number;
+    response: T;
 }
-
 interface PostMessageTarget {
-	postMessage(message: any, ...args: any[]): void;
+    postMessage(message: any, ...args: any[]): void;
 }
-
 interface IsomorphicEventTarget {
-	addEventListener(type: string, listener: (event: any) => void): void;
-	removeEventListener(type: string, listener: (event: any) => void): void;
+    addEventListener(type: string, listener: (event: any) => void): void;
+    removeEventListener(type: string, listener: (event: any) => void): void;
 }
+export {};

package/src/messaging.js

@@ -0,0 +1,105 @@
+const DEFAULT_RESPONSE_TIMEOUT = 25000;
+let lastRequestId = 0;
+/**
+ * Posts a message branded with a unique `requestId` to the given `target`.
+ * Then returns the `requestId` so it can be used to await a reply.
+ * Effectively, it implements the request/response dynamics on
+ * of JavaScript's `postMessage`
+ *
+ * @example
+ *
+ * In the main app:
+ *
+ * ```js
+ * import { postMessageExpectReply, awaitReply } from 'php-wasm-browser';
+ * const iframeWindow = iframe.contentWindow;
+ * const requestId = postMessageExpectReply(iframeWindow, {
+ *    type: "get_php_version"
+ * });
+ * const response = await awaitReply(iframeWindow, requestId);
+ * console.log(response);
+ * // "8.0.24"
+ * ```
+ *
+ * In the iframe:
+ *
+ * ```js
+ * import { responseTo } from 'php-wasm-browser';
+ * window.addEventListener('message', (event) => {
+ *    let response = '8.0.24';
+ *    if(event.data.type === 'get_php_version') {
+ *       response = '8.0.24';
+ *    } else {
+ *       throw new Error(`Unexpected message type: ${event.data.type}`);
+ *    }
+ *
+ *    // When `requestId` is present, the other thread expects a response:
+ *    if (event.data.requestId) {
+ *       const response = responseTo(event.data.requestId, response);
+ *       window.parent.postMessage(response, event.origin);
+ *    }
+ * });
+ * ```
+ *
+ * @param  target          An object that has a `postMessage` method.
+ * @param  message         A key-value object that can be serialized to JSON.
+ * @param  postMessageArgs Additional arguments to pass to `postMessage`.
+ * @returns The message ID for awaitReply().
+ */
+export function postMessageExpectReply(target, message, ...postMessageArgs) {
+    const requestId = getNextRequestId();
+    target.postMessage({
+        ...message,
+        requestId,
+    }, ...postMessageArgs);
+    return requestId;
+}
+export function getNextRequestId() {
+    return ++lastRequestId;
+}
+/**
+ * Awaits a reply to the message with the given ID.
+ *
+ * @see postMessageExpectReply
+ * @throws {@link Error} If the reply is not received within the timeout.
+ * @param  messageTarget EventEmitter emitting `message` events, e.g. `window`
+ *                       or a `Worker` instance.
+ * @param  requestId     The message ID returned by postMessageExpectReply().
+ * @param  timeout       The number of milliseconds to wait for a reply before
+ *                       throwing an error.
+ * @returns The reply from the messageTarget.
+ */
+export function awaitReply(messageTarget, requestId, timeout = DEFAULT_RESPONSE_TIMEOUT) {
+    return new Promise((resolve, reject) => {
+        const responseHandler = (event) => {
+            if (event.data.type === 'response' &&
+                event.data.requestId === requestId) {
+                messageTarget.removeEventListener('message', responseHandler);
+                clearTimeout(failOntimeout);
+                resolve(event.data.response);
+            }
+        };
+        const failOntimeout = setTimeout(() => {
+            reject(new Error('Request timed out'));
+            messageTarget.removeEventListener('message', responseHandler);
+        }, timeout);
+        messageTarget.addEventListener('message', responseHandler);
+    });
+}
+/**
+ * Creates a response message to the given message ID.
+ *
+ * @see postMessageExpectReply
+ * @param  requestId The message ID sent from the other thread by
+ *                   `postMessageExpectReply` in the `message` event.
+ * @param  response  The response to send back to the messageTarget.
+ * @returns A message object that can be sent back to the other thread.
+ */
+export function responseTo(requestId, response) {
+    return {
+        type: 'response',
+        requestId,
+        response,
+    };
+}
+//# sourceMappingURL=messaging.js.map

package/src/messaging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/messaging.ts"],"names":[],"mappings":"AAAA,MAAM,wBAAwB,GAAG,KAAK,CAAC;AAEvC,IAAI,aAAa,GAAG,CAAC,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAAyB,EACzB,OAA4B,EAC5B,GAAG,eAAsB;IAEzB,MAAM,SAAS,GAAG,gBAAgB,EAAE,CAAC;IACrC,MAAM,CAAC,WAAW,CACjB;QACC,GAAG,OAAO;QACV,SAAS;KACT,EACD,GAAG,eAAe,CAClB,CAAC;IACF,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC/B,OAAO,EAAE,aAAa,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACzB,aAAoC,EACpC,SAAiB,EACjB,UAAkB,wBAAwB;IAE1C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,CAAC,KAAmB,EAAE,EAAE;YAC/C,IACC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU;gBAC9B,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EACjC;gBACD,aAAa,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;gBAC9D,YAAY,CAAC,aAAa,CAAC,CAAC;gBAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7B;QACF,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;YACrC,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;YACvC,aAAa,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC/D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,aAAa,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACzB,SAAiB,EACjB,QAAW;IAEX,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,SAAS;QACT,QAAQ;KACR,CAAC;AACH,CAAC"}

package/.eslintrc.json

@@ -1,18 +0,0 @@
-{
-	"extends": ["../../../.eslintrc.json"],
-	"ignorePatterns": ["!**/*"],
-	"overrides": [
-		{
-			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-			"rules": {}
-		},
-		{
-			"files": ["*.ts", "*.tsx"],
-			"rules": {}
-		},
-		{
-			"files": ["*.js", "*.jsx"],
-			"rules": {}
-		}
-	]
-}

package/project.json

@@ -1,44 +0,0 @@
-{
-	"name": "php-wasm-web-service-worker",
-	"$schema": "../../../node_modules/nx/schemas/project-schema.json",
-	"sourceRoot": "packages/php-wasm/web-service-worker/src",
-	"projectType": "library",
-	"targets": {
-		"build": {
-			"executor": "@wp-playground/nx-extensions:package-json",
-			"options": {
-				"tsConfig": "packages/php-wasm/web-service-worker/tsconfig.lib.json",
-				"outputPath": "dist/packages/php-wasm/web-service-worker",
-				"buildTarget": "php-wasm-web-service-worker:build:bundle:production"
-			}
-		},
-		"build:bundle": {
-			"executor": "@nrwl/js:tsc",
-			"outputs": ["{options.outputPath}"],
-			"options": {
-				"outputPath": "dist/packages/php-wasm/web-service-worker",
-				"main": "packages/php-wasm/web-service-worker/src/index.ts",
-				"tsConfig": "packages/php-wasm/web-service-worker/tsconfig.lib.json",
-				"assets": ["packages/php-wasm/web-service-worker/*.md"]
-			}
-		},
-		"lint": {
-			"executor": "@nrwl/linter:eslint",
-			"outputs": ["{options.outputFile}"],
-			"options": {
-				"lintFilePatterns": [
-					"packages/php-wasm/web-service-worker/**/*.ts"
-				]
-			}
-		},
-		"typecheck": {
-			"executor": "@nrwl/workspace:run-commands",
-			"options": {
-				"commands": [
-					"yarn tsc -p packages/php-wasm/web-service-worker/tsconfig.lib.json --noEmit"
-				]
-			}
-		}
-	},
-	"tags": []
-}

package/src/initialize-service-worker.ts

@@ -1,364 +0,0 @@
-/// <reference lib="WebWorker" />
-declare const self: ServiceWorkerGlobalScope;
-
-import { awaitReply, getNextRequestId } from './messaging';
-import {
-	getURLScope,
-	isURLScoped,
-	removeURLScope,
-	setURLScope,
-} from '@php-wasm/scopes';
-
-/**
- * Run this function in the service worker to install the required event
- * handlers.
- *
- * @param  config
- */
-export function initializeServiceWorker(config: ServiceWorkerConfiguration) {
-	const { version, handleRequest = defaultRequestHandler } = config;
-	/**
-	 * Enable the client app to force-update the service worker
-	 * registration.
-	 */
-	self.addEventListener('message', (event) => {
-		if (!event.data) {
-			return;
-		}
-
-		if (event.data === 'skip-waiting') {
-			self.skipWaiting();
-		}
-	});
-
-	/**
-	 * Ensure the client gets claimed by this service worker right after the registration.
-	 *
-	 * Only requests from the "controlled" pages are resolved via the fetch listener below.
-	 * However, simply registering the worker is not enough to make it the "controller" of
-	 * the current page. The user still has to reload the page. If they don't an iframe
-	 * pointing to /index.php will show a 404 message instead of a homepage.
-	 *
-	 * This activation handles saves the user reloading the page after the initial confusion.
-	 * It immediately makes this worker the controller of any client that registers it.
-	 */
-	self.addEventListener('activate', (event) => {
-		// eslint-disable-next-line no-undef
-		event.waitUntil(self.clients.claim());
-	});
-
-	/**
-	 * The main method. It captures the requests and loop them back to the
-	 * Worker Thread using the Loopback request
-	 */
-	self.addEventListener('fetch', (event) => {
-		const url = new URL(event.request.url);
-
-		// Provide a custom JSON response in the special /version endpoint
-		// so the frontend app can know whether it's time to update the
-		// service worker registration.
-		if (url.pathname === '/version') {
-			event.preventDefault();
-			const currentVersion =
-				typeof version === 'function' ? version() : version;
-			event.respondWith(
-				new Response(JSON.stringify({ version: currentVersion }), {
-					headers: {
-						'Content-Type': 'application/json',
-					},
-					status: 200,
-				})
-			);
-			return;
-		}
-
-		// Don't handle requests to the service worker script itself.
-		if (url.pathname.startsWith(self.location.pathname)) {
-			return;
-		}
-
-		// Only handle requests from scoped sites.
-		// So – bale out if the request URL is not scoped and the
-		// referrer URL is not scoped.
-		if (!isURLScoped(url)) {
-			let referrerUrl;
-			try {
-				referrerUrl = new URL(event.request.referrer);
-			} catch (e) {
-				return;
-			}
-			if (!isURLScoped(referrerUrl)) {
-				// Let the browser handle uncoped requests as is.
-				return;
-			}
-		}
-
-		console.debug(
-			`[ServiceWorker] Serving request: ${getRelativePart(
-				removeURLScope(url)
-			)}`
-		);
-		const responsePromise = handleRequest(event);
-		if (responsePromise) {
-			event.respondWith(responsePromise);
-		}
-	});
-}
-
-async function defaultRequestHandler(event: FetchEvent) {
-	event.preventDefault();
-	const url = new URL(event.request.url);
-	const unscopedUrl = removeURLScope(url);
-	if (!seemsLikeAPHPServerPath(unscopedUrl.pathname)) {
-		return fetch(
-			await cloneRequest(event.request, {
-				url,
-			})
-		);
-	}
-	return convertFetchEventToPHPRequest(event);
-}
-
-export async function convertFetchEventToPHPRequest(event: FetchEvent) {
-	let url = new URL(event.request.url);
-
-	if (!isURLScoped(url)) {
-		try {
-			const referrerUrl = new URL(event.request.referrer);
-			url = setURLScope(url, getURLScope(referrerUrl)!);
-		} catch (e) {
-			// ignore
-		}
-	}
-
-	const { body, files, contentType } = await rewritePost(event.request);
-	const requestHeaders: Record<string, string> = {};
-	for (const pair of (event.request.headers as any).entries()) {
-		requestHeaders[pair[0]] = pair[1];
-	}
-
-	let phpResponse;
-	try {
-		const message = {
-			method: 'request',
-			args: [
-				{
-					body,
-					files,
-					absoluteUrl: url.toString(),
-					method: event.request.method,
-					headers: {
-						...requestHeaders,
-						Host: url.host,
-						// Safari and Firefox don't make the User-Agent header
-						// available in the fetch event. Let's add it manually:
-						'User-agent': self.navigator.userAgent,
-						'Content-type': contentType,
-					},
-				},
-			],
-		};
-		const scope = getURLScope(url);
-		if (scope === null) {
-			throw new Error(
-				`The URL ${url.toString()} is not scoped. This should not happen.`
-			);
-		}
-		console.debug(
-			'[ServiceWorker] Forwarding a request to the Worker Thread',
-			{
-				message,
-			}
-		);
-		const requestId = await broadcastMessageExpectReply(message, scope);
-		phpResponse = await awaitReply(self, requestId);
-
-		// X-frame-options gets in a way when PHP is
-		// being displayed in an iframe.
-		delete phpResponse.headers['x-frame-options'];
-
-		console.debug('[ServiceWorker] Response received from the main app', {
-			phpResponse,
-		});
-	} catch (e) {
-		console.error(e, { url: url.toString() });
-		throw e;
-	}
-
-	return new Response(phpResponse.body, {
-		headers: phpResponse.headers,
-		status: phpResponse.httpStatusCode,
-	});
-}
-
-/**
- * Sends the message to all the controlled clients
- * of this service worker.
- *
- * This used to be implemented with a BroadcastChannel, but
- * it didn't work in Safari. BroadcastChannel breaks iframe
- * embedding the playground in Safari.
- *
- * Weirdly, Safari does not pass any messages from the ServiceWorker
- * to Window if the page is rendered inside an iframe. Window to Service
- * Worker communication works just fine.
- *
- * The regular client.postMessage() communication works perfectly, so that's
- * what this function uses to broadcast the message.
- *
- * @param  message The message to broadcast.
- * @param  scope   Target worker thread scope.
- * @returns The request ID to receive the reply.
- */
-export async function broadcastMessageExpectReply(message: any, scope: string) {
-	const requestId = getNextRequestId();
-	for (const client of await self.clients.matchAll({
-		// Sometimes the client that triggered the current fetch()
-		// event is considered uncontrolled in Google Chrome. This
-		// only happens on the first few fetches() after the initial
-		// registration of the service worker.
-		includeUncontrolled: true,
-	})) {
-		client.postMessage({
-			...message,
-			/**
-			 * Attach the scope with a URL starting with `/scope:` to this message.
-			 *
-			 * We need this mechanics because this worker broadcasts
-			 * events to all the listeners across all browser tabs. Scopes
-			 * helps WASM workers ignore requests meant for other WASM workers.
-			 */
-			scope,
-			requestId,
-		});
-	}
-	return requestId;
-}
-
-interface ServiceWorkerConfiguration {
-	/**
-	 * The version of the service worker – exposed via the /version endpoint.
-	 *
-	 * This is used by the frontend app to know whether it's time to update
-	 * the service worker registration.
-	 */
-	version: string | (() => string);
-	handleRequest?: (event: FetchEvent) => Promise<Response> | undefined;
-}
-
-/**
- * Guesses whether the given path looks like a PHP file.
- *
- * @example
- * ```js
- * seemsLikeAPHPServerPath('/index.php') // true
- * seemsLikeAPHPServerPath('/index.php') // true
- * seemsLikeAPHPServerPath('/index.php/foo/bar') // true
- * seemsLikeAPHPServerPath('/index.html') // false
- * seemsLikeAPHPServerPath('/index.html/foo/bar') // false
- * seemsLikeAPHPServerPath('/') // true
- * ```
- *
- * @param  path The path to check.
- * @returns Whether the path seems like a PHP server path.
- */
-export function seemsLikeAPHPServerPath(path: string): boolean {
-	return seemsLikeAPHPFile(path) || seemsLikeADirectoryRoot(path);
-}
-
-function seemsLikeAPHPFile(path: string) {
-	return path.endsWith('.php') || path.includes('.php/');
-}
-
-function seemsLikeADirectoryRoot(path: string) {
-	const lastSegment = path.split('/').pop();
-	return !lastSegment!.includes('.');
-}
-
-async function rewritePost(request: Request) {
-	const contentType = request.headers.get('content-type')!;
-	if (request.method !== 'POST') {
-		return {
-			contentType,
-			body: undefined,
-			files: undefined,
-		};
-	}
-
-	// If the request contains multipart form data, rewrite it
-	// to a regular form data and handle files separately.
-	const isMultipart = contentType
-		.toLowerCase()
-		.startsWith('multipart/form-data');
-	if (isMultipart) {
-		try {
-			const formData = (await request.clone().formData()) as any;
-			const post: Record<string, string> = {};
-			const files: Record<string, File> = {};
-
-			for (const key of formData.keys()) {
-				const value = formData.get(key);
-				if (value instanceof File) {
-					files[key] = value;
-				} else {
-					post[key] = value;
-				}
-			}
-
-			return {
-				contentType: 'application/x-www-form-urlencoded',
-				body: new URLSearchParams(post).toString(),
-				files,
-			};
-		} catch (e) {
-			// ignore
-		}
-	}
-
-	// Otherwise, grab body as literal text
-	return {
-		contentType,
-		body: await request.clone().text(),
-		files: {},
-	};
-}
-
-/**
- * Copy a request with custom overrides.
- *
- * This function is only needed because Request properties
- * are read-only. The only way to change e.g. a URL is to
- * create an entirely new request:
- *
- * https://developer.mozilla.org/en-US/docs/Web/API/Request
- *
- * @param  request
- * @param  overrides
- * @returns The new request.
- */
-export async function cloneRequest(
-	request: Request,
-	overrides: Record<string, any>
-): Promise<Request> {
-	const body =
-		['GET', 'HEAD'].includes(request.method) || 'body' in overrides
-			? undefined
-			: await request.blob();
-	return new Request(overrides['url'] || request.url, {
-		body,
-		method: request.method,
-		headers: request.headers,
-		referrer: request.referrer,
-		referrerPolicy: request.referrerPolicy,
-		mode: request.mode === 'navigate' ? 'same-origin' : request.mode,
-		credentials: request.credentials,
-		cache: request.cache,
-		redirect: request.redirect,
-		integrity: request.integrity,
-		...overrides,
-	});
-}
-
-function getRelativePart(url: URL): string {
-	return url.toString().substring(url.origin.length);
-}

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-	"extends": "../../../tsconfig.base.json",
-	"compilerOptions": {
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"noImplicitOverride": true,
-		"noPropertyAccessFromIndexSignature": true,
-		"noImplicitReturns": true,
-		"noFallthroughCasesInSwitch": true
-	},
-	"files": [],
-	"include": [],
-	"references": [
-		{
-			"path": "./tsconfig.lib.json"
-		}
-	]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "../../../dist/out-tsc",
-		"declaration": true,
-		"types": ["node"]
-	},
-	"include": ["src/**/*.ts"],
-	"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}