@toapi/worker 1.0.1 → 1.1.0

package/dist/handle-toapi-request.d.ts

@@ -0,0 +1,11 @@
+import type { Logger } from "@toapi/common";
+export declare function handleToapiRequest(req: Request, options?: {
+    logger?: Logger;
+}): Promise<Response>;
+/**
+ * @deprecated Renamed to {@link handleToapiRequest} as part of the tapi → toapi
+ * rebrand. This alias points to the same function and will be removed in a
+ * future major version.
+ */
+export declare const handleTapiRequest: typeof handleToapiRequest;
+//# sourceMappingURL=handle-toapi-request.d.ts.map

package/dist/handle-toapi-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle-toapi-request.d.ts","sourceRoot":"","sources":["../src/handle-toapi-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAM5C,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,OAAO,EACZ,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,qBAsC9B;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,2BAAqB,CAAC"}

package/dist/handle-toapi-request.js

@@ -0,0 +1,45 @@
+import { isMutation } from "@toapi/common";
+import { getCachedEntry, getMetadata } from "./cache";
+import { mutateAndInvalidate } from "./mutate-and-invalidate";
+import { serveFromNetwork } from "./serve-from-network";
+export async function handleToapiRequest(req, options) {
+    const errorLog = options?.logger?.error ??
+        ((err) => console.error("Toapi Worker fetch failed", err));
+    if (isMutation(req)) {
+        return mutateAndInvalidate(req);
+    }
+    else {
+        const cachedResponse = await getCachedEntry(req);
+        if (!cachedResponse) {
+            // no cached response, serve from network
+            return serveFromNetwork(req);
+        }
+        const meta = await getMetadata(req.url);
+        if (meta?.expiresAt) {
+            if (meta.expiresAt > Date.now()) {
+                // cached response is still valid
+                return cachedResponse;
+            }
+            else {
+                // cached response is expired
+                try {
+                    // try to serve from network
+                    return serveFromNetwork(req);
+                }
+                catch (error) {
+                    // probably network not available, serve old response
+                    errorLog(error);
+                    return cachedResponse;
+                }
+            }
+        }
+        // no expiration header, serve cached response
+        return cachedResponse;
+    }
+}
+/**
+ * @deprecated Renamed to {@link handleToapiRequest} as part of the tapi → toapi
+ * rebrand. This alias points to the same function and will be removed in a
+ * future major version.
+ */
+export const handleTapiRequest = handleToapiRequest;

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-import type { Logger } from "@toapi/common";
 export type { Logger } from "@toapi/common";
 export { cleanup } from "./cleanup";
 export type { CleanupOptions } from "./cleanup";
+export { handleToapiRequest, handleTapiRequest } from "./handle-toapi-request";
 export { listenForInvalidations } from "./revalidation-stream";
-export declare function handleTapiRequest(req: Request, options?: {
-    logger?: Logger;
-}): Promise<Response>;
+export { setupToapiWorker } from "./setup";
+export type { SetupToapiWorkerOptions } from "./setup";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAK5C,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,OAAO,EACZ,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,qBAsC9B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,41 +1,4 @@
-import { isMutation } from "@toapi/common";
-import { getCachedEntry, getMetadata } from "./cache";
-import { mutateAndInvalidate } from "./mutate-and-invalidate";
-import { serveFromNetwork } from "./serve-from-network";
 export { cleanup } from "./cleanup";
+export { handleToapiRequest, handleTapiRequest } from "./handle-toapi-request";
 export { listenForInvalidations } from "./revalidation-stream";
-export async function handleTapiRequest(req, options) {
-    const errorLog = options?.logger?.error ??
-        ((err) => console.error("TApi Worker fetch failed", err));
-    if (isMutation(req)) {
-        return mutateAndInvalidate(req);
-    }
-    else {
-        const cachedResponse = await getCachedEntry(req);
-        if (!cachedResponse) {
-            // no cached response, serve from network
-            return serveFromNetwork(req);
-        }
-        const meta = await getMetadata(req.url);
-        if (meta?.expiresAt) {
-            if (meta.expiresAt > Date.now()) {
-                // cached response is still valid
-                return cachedResponse;
-            }
-            else {
-                // cached response is expired
-                try {
-                    // try to serve from network
-                    return serveFromNetwork(req);
-                }
-                catch (error) {
-                    // probably network not available, serve old response
-                    errorLog(error);
-                    return cachedResponse;
-                }
-            }
-        }
-        // no expiration header, serve cached response
-        return cachedResponse;
-    }
-}
+export { setupToapiWorker } from "./setup";

package/dist/setup.d.ts

@@ -0,0 +1,53 @@
+import type { Logger } from "@toapi/common";
+export interface SetupToapiWorkerOptions {
+    /**
+     * Base path whose requests are handled by the Toapi cache. Same-origin
+     * requests whose pathname starts with this prefix are served from cache /
+     * network by {@link handleToapiRequest}; the `${basePath}/__tapi` control
+     * endpoints (such as the invalidation stream) are always excluded.
+     *
+     * @default "/api"
+     */
+    basePath?: string;
+    /**
+     * URL of the server's revalidation stream.
+     *
+     * @default `${basePath}/__tapi/invalidations`
+     */
+    invalidationsUrl?: string;
+    /**
+     * Grace period in seconds past a cache entry's `expiresAt` before it is
+     * dropped on the next `activate`. See {@link CleanupOptions}.
+     *
+     * @default 60 * 60 * 24 * 7 // 7 days
+     */
+    maximumStaleAge?: number;
+    /**
+     * Optional logger. Its `error` method is used for failed network refetches
+     * and for a fatal failure of the invalidation stream. Defaults to
+     * `console.error`.
+     */
+    logger?: Logger;
+}
+/**
+ * Wire up the whole Toapi service worker in a single call. This registers the
+ * `activate` and `fetch` listeners and opens the revalidation stream, and is
+ * equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
+ * {@link listenForInvalidations} by hand.
+ *
+ * ```ts
+ * // service-worker.ts
+ * import { setupToapiWorker } from "@toapi/worker";
+ *
+ * declare const self: ServiceWorkerGlobalScope;
+ *
+ * setupToapiWorker();
+ * ```
+ *
+ * The `fetch` listener only responds to same-origin requests under `basePath`,
+ * so it composes with other `fetch` listeners (for example
+ * `vite-plugin-pwa`'s precaching) — requests it doesn't handle fall through to
+ * them.
+ */
+export declare function setupToapiWorker({ basePath, invalidationsUrl, maximumStaleAge, logger, }?: SetupToapiWorkerOptions): void;
+//# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAU5C,MAAM,WAAW,uBAAuB;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,QAAiB,EACjB,gBAAsD,EACtD,eAAkC,EAClC,MAAM,GACP,GAAE,uBAA4B,QAwB9B"}

package/dist/setup.js

@@ -0,0 +1,44 @@
+import { INVALIDATIONS_ROUTE } from "@toapi/common";
+import { cleanup } from "./cleanup";
+import { handleToapiRequest } from "./handle-toapi-request";
+import { listenForInvalidations } from "./revalidation-stream";
+const ONE_WEEK_SECONDS = 60 * 60 * 24 * 7;
+/**
+ * Wire up the whole Toapi service worker in a single call. This registers the
+ * `activate` and `fetch` listeners and opens the revalidation stream, and is
+ * equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
+ * {@link listenForInvalidations} by hand.
+ *
+ * ```ts
+ * // service-worker.ts
+ * import { setupToapiWorker } from "@toapi/worker";
+ *
+ * declare const self: ServiceWorkerGlobalScope;
+ *
+ * setupToapiWorker();
+ * ```
+ *
+ * The `fetch` listener only responds to same-origin requests under `basePath`,
+ * so it composes with other `fetch` listeners (for example
+ * `vite-plugin-pwa`'s precaching) — requests it doesn't handle fall through to
+ * them.
+ */
+export function setupToapiWorker({ basePath = "/api", invalidationsUrl = `${basePath}${INVALIDATIONS_ROUTE}`, maximumStaleAge = ONE_WEEK_SECONDS, logger, } = {}) {
+    const controlPrefix = `${basePath}/__tapi`;
+    const errorLog = logger?.error ??
+        ((err) => console.error("Toapi Worker: invalidation stream failed", err));
+    self.addEventListener("activate", (event) => {
+        event.waitUntil(cleanup({ maximumStaleAge }));
+    });
+    self.addEventListener("fetch", (event) => {
+        const url = new URL(event.request.url);
+        // only handle same-origin API requests, and never the control endpoints
+        if (url.origin !== self.location.origin)
+            return;
+        if (url.pathname.startsWith(basePath) &&
+            !url.pathname.startsWith(controlPrefix)) {
+            event.respondWith(handleToapiRequest(event.request, { logger }));
+        }
+    });
+    listenForInvalidations({ url: invalidationsUrl }).catch(errorLog);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toapi/worker",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "author": {
     "name": "Michel Smola",
     "email": "michel.smola@farbenmeer.de"
@@ -20,7 +20,7 @@
     }
   },
   "dependencies": {
-    "@toapi/common": "^1.0.1"
+    "@toapi/common": "^1.1.0"
   },
   "devDependencies": {
     "@types/node": "^25.0.3",