@serwist/turbopack 10.0.0-preview.10

package/src/index.worker.ts

@@ -0,0 +1,278 @@
+import type { RuntimeCaching } from "serwist";
+import { CacheFirst, ExpirationPlugin, NetworkFirst, NetworkOnly, RangeRequestsPlugin, StaleWhileRevalidate } from "serwist";
+
+export const PAGES_CACHE_NAME = {
+  rscPrefetch: "pages-rsc-prefetch",
+  rsc: "pages-rsc",
+  html: "pages",
+} as const;
+
+/**
+ * The default, recommended list of caching strategies for applications
+ * built with Next.js.
+ *
+ * @see https://serwist.pages.dev/docs/next/worker-exports#default-cache
+ */
+export const defaultCache: RuntimeCaching[] =
+  process.env.NODE_ENV !== "production"
+    ? [
+        {
+          matcher: /.*/i,
+          handler: new NetworkOnly(),
+        },
+      ]
+    : [
+        {
+          matcher: /^https:\/\/fonts\.(?:gstatic)\.com\/.*/i,
+          handler: new CacheFirst({
+            cacheName: "google-fonts-webfonts",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 365 * 24 * 60 * 60, // 365 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /^https:\/\/fonts\.(?:googleapis)\.com\/.*/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "google-fonts-stylesheets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-font-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-image-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 30 * 24 * 60 * 60, // 30 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/static.+\.js$/i,
+          handler: new CacheFirst({
+            cacheName: "next-static-js-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/image\?url=.+$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "next-image",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:mp3|wav|ogg)$/i,
+          handler: new CacheFirst({
+            cacheName: "static-audio-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+              new RangeRequestsPlugin(),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:mp4|webm)$/i,
+          handler: new CacheFirst({
+            cacheName: "static-video-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+              new RangeRequestsPlugin(),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:js)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-js-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 48,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:css|less)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-style-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/data\/.+\/.+\.json$/i,
+          handler: new NetworkFirst({
+            cacheName: "next-data",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:json|xml|csv)$/i,
+          handler: new NetworkFirst({
+            cacheName: "static-data-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ sameOrigin, url: { pathname } }) => {
+            // Exclude /api/auth/callback/* to fix OAuth workflow in Safari without having
+            // an impact on other environments
+            // The above route is the default for next-auth, you may need to change it if
+            // your OAuth workflow has a different callback route.
+            // Issue: https://github.com/shadowwalker/next-pwa/issues/131#issuecomment-821894809
+            // TODO(ducanhgh): Investigate Auth.js's "/api/auth/*" failing when we allow them
+            // to be cached (the current behaviour).
+            if (!sameOrigin || pathname.startsWith("/api/auth/callback")) {
+              return false;
+            }
+
+            if (pathname.startsWith("/api/")) {
+              return true;
+            }
+
+            return false;
+          },
+          method: "GET",
+          handler: new NetworkFirst({
+            cacheName: "apis",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 16,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+            networkTimeoutSeconds: 10, // fallback to cache if API does not response within 10 seconds
+          }),
+        },
+        {
+          matcher: ({ request, url: { pathname }, sameOrigin }) =>
+            request.headers.get("RSC") === "1" && request.headers.get("Next-Router-Prefetch") === "1" && sameOrigin && !pathname.startsWith("/api/"),
+          handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.rscPrefetch,
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ request, url: { pathname }, sameOrigin }) => request.headers.get("RSC") === "1" && sameOrigin && !pathname.startsWith("/api/"),
+          handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.rsc,
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ request, url: { pathname }, sameOrigin }) =>
+            request.headers.get("Content-Type")?.includes("text/html") && sameOrigin && !pathname.startsWith("/api/"),
+          handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.html,
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ url: { pathname }, sameOrigin }) => sameOrigin && !pathname.startsWith("/api/"),
+          handler: new NetworkFirst({
+            cacheName: "others",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ sameOrigin }) => !sameOrigin,
+          handler: new NetworkFirst({
+            cacheName: "cross-origin",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 60 * 60, // 1 hour
+              }),
+            ],
+            networkTimeoutSeconds: 10,
+          }),
+        },
+      ];

package/src/lib/constants.ts

@@ -0,0 +1,4 @@
+export const DEFAULT_GLOB_PATTERNS = [
+  ".next/static/**/*.{js,css,html,ico,apng,png,avif,jpg,jpeg,jfif,pjpeg,pjp,gif,svg,webp,json,webmanifest}",
+  "public/**/*",
+];

package/src/lib/context.ts

@@ -0,0 +1,16 @@
+import type { Serwist } from "@serwist/window";
+import { createContext, useContext } from "react";
+
+export interface SerwistContextValues {
+  serwist: Serwist | null;
+}
+
+export const SerwistContext = createContext<SerwistContextValues>(null!);
+
+export const useSerwist = () => {
+  const context = useContext(SerwistContext);
+  if (!context) {
+    throw new Error("[useSerwist]: 'SerwistContext' is not available.");
+  }
+  return context;
+};

package/src/lib/index.ts

@@ -0,0 +1,3 @@
+import * as logger from "./logger.js";
+
+export { logger };

package/src/lib/logger.ts

@@ -0,0 +1,57 @@
+import { bold, green, red, white, yellow } from "kolorist";
+
+const LOGGING_METHOD = ["wait", "error", "warn", "info", "event"] as const;
+
+type LoggingMethods = (typeof LOGGING_METHOD)[number];
+
+const mapLoggingMethodToConsole: Record<LoggingMethods, "log" | "error" | "warn" | "log"> = {
+  wait: "log",
+  error: "error",
+  warn: "warn",
+  info: "log",
+  event: "log",
+};
+
+const prefixes = {
+  wait: `${white(bold("○"))} (serwist)`,
+  error: `${red(bold("X"))} (serwist)`,
+  warn: `${yellow(bold("⚠"))} (serwist)`,
+  info: `${white(bold("○"))} (serwist)`,
+  event: `${green(bold("✓"))} (serwist)`,
+};
+
+const prefixedLog = (prefixType: LoggingMethods, ...message: any[]) => {
+  const consoleMethod = mapLoggingMethodToConsole[prefixType];
+  const prefix = prefixes[prefixType];
+
+  if ((message[0] === "" || message[0] === undefined) && message.length === 1) {
+    message.shift();
+  }
+
+  // If there's no message, don't print the prefix but a new line
+  if (message.length === 0) {
+    console[consoleMethod]("");
+  } else {
+    console[consoleMethod](` ${prefix}`, ...message);
+  }
+};
+
+export const wait = (...message: any[]) => {
+  prefixedLog("wait", ...message);
+};
+
+export const error = (...message: any[]) => {
+  prefixedLog("error", ...message);
+};
+
+export const warn = (...message: any[]) => {
+  prefixedLog("warn", ...message);
+};
+
+export const info = (...message: any[]) => {
+  prefixedLog("info", ...message);
+};
+
+export const event = (...message: any[]) => {
+  prefixedLog("event", ...message);
+};

package/src/types.ts

@@ -0,0 +1,37 @@
+import type {
+  BasePartial,
+  BaseResolved,
+  GlobPartial,
+  GlobResolved,
+  InjectPartial,
+  InjectResolved,
+  OptionalGlobDirectoryPartial,
+  RequiredGlobDirectoryResolved,
+} from "@serwist/build";
+import { assertType, type Equals } from "@serwist/build/schema";
+import type { Prettify } from "@serwist/utils";
+import type z from "zod";
+import type { injectManifestOptions } from "./index.schema.js";
+
+export interface TurboPartial {
+  /**
+   * The path to your working directory.
+   *
+   * @default process.cwd()
+   */
+  cwd?: string;
+  /**
+   * The Next.js `basePath` config option. If this option
+   * is not configured, set to `/`.
+   */
+  basePath: string;
+}
+
+export type TurboResolved = Required<TurboPartial>;
+
+export type InjectManifestOptions = Prettify<BasePartial & GlobPartial & InjectPartial & OptionalGlobDirectoryPartial & TurboPartial>;
+
+export type InjectManifestOptionsComplete = Prettify<BaseResolved & GlobResolved & InjectResolved & RequiredGlobDirectoryResolved & TurboResolved>;
+
+assertType<Equals<InjectManifestOptions, z.input<typeof injectManifestOptions>>>();
+assertType<Equals<InjectManifestOptionsComplete, z.output<typeof injectManifestOptions>>>();