@serwist/next 8.4.1 → 8.4.3

package/dist/index.browser.d.cts

@@ -0,0 +1,2 @@
+import type { RuntimeCaching } from "@serwist/build";
+export declare const defaultCache: RuntimeCaching[];

package/dist/index.cjs

@@ -792,29 +792,30 @@ const withPWAInit = (pluginOptions)=>{
                 }));
                 const swEntryJs = path.join(__dirname$1, "sw-entry.js");
                 const entry = config.entry;
-                config.entry = ()=>entry().then((entries)=>{
-                        if (entries["main.js"] && !entries["main.js"].includes(swEntryJs)) {
-                            if (Array.isArray(entries["main.js"])) {
-                                entries["main.js"].unshift(swEntryJs);
-                            } else if (typeof entries["main.js"] === "string") {
-                                entries["main.js"] = [
-                                    swEntryJs,
-                                    entries["main.js"]
-                                ];
-                            }
+                config.entry = async ()=>{
+                    const entries = await entry();
+                    if (entries["main.js"] && !entries["main.js"].includes(swEntryJs)) {
+                        if (Array.isArray(entries["main.js"])) {
+                            entries["main.js"].unshift(swEntryJs);
+                        } else if (typeof entries["main.js"] === "string") {
+                            entries["main.js"] = [
+                                swEntryJs,
+                                entries["main.js"]
+                            ];
                         }
-                        if (entries["main-app"] && !entries["main-app"].includes(swEntryJs)) {
-                            if (Array.isArray(entries["main-app"])) {
-                                entries["main-app"].unshift(swEntryJs);
-                            } else if (typeof entries["main-app"] === "string") {
-                                entries["main-app"] = [
-                                    swEntryJs,
-                                    entries["main-app"]
-                                ];
-                            }
+                    }
+                    if (entries["main-app"] && !entries["main-app"].includes(swEntryJs)) {
+                        if (Array.isArray(entries["main-app"])) {
+                            entries["main-app"].unshift(swEntryJs);
+                        } else if (typeof entries["main-app"] === "string") {
+                            entries["main-app"] = [
+                                swEntryJs,
+                                entries["main-app"]
+                            ];
                         }
-                        return entries;
-                    });
+                    }
+                    return entries;
+                };
                 if (!options.isServer) {
                     if (!register) {
                         info("Service worker won't be automatically registered as per the config, please call the following code in componentDidMount or useEffect:");
@@ -859,7 +860,7 @@ const withPWAInit = (pluginOptions)=>{
                         ]
                     }));
                     // Precache files in public folder
-                    let resolvedManifestEntries = additionalPrecacheEntries ?? [];
+                    let resolvedManifestEntries = additionalPrecacheEntries;
                     if (!resolvedManifestEntries) {
                         const swDestFileName = path.basename(swDest);
                         resolvedManifestEntries = fg.sync([

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+import type { NextConfig } from "next";
+import type { PluginOptions } from "./types.js";
+declare const withPWAInit: (pluginOptions: PluginOptions) => (nextConfig?: NextConfig) => NextConfig;
+export default withPWAInit;
+export * from "./types.js";

package/dist/index.js

@@ -787,29 +787,30 @@ const withPWAInit = (pluginOptions)=>{
                 }));
                 const swEntryJs = path.join(__dirname, "sw-entry.js");
                 const entry = config.entry;
-                config.entry = ()=>entry().then((entries)=>{
-                        if (entries["main.js"] && !entries["main.js"].includes(swEntryJs)) {
-                            if (Array.isArray(entries["main.js"])) {
-                                entries["main.js"].unshift(swEntryJs);
-                            } else if (typeof entries["main.js"] === "string") {
-                                entries["main.js"] = [
-                                    swEntryJs,
-                                    entries["main.js"]
-                                ];
-                            }
+                config.entry = async ()=>{
+                    const entries = await entry();
+                    if (entries["main.js"] && !entries["main.js"].includes(swEntryJs)) {
+                        if (Array.isArray(entries["main.js"])) {
+                            entries["main.js"].unshift(swEntryJs);
+                        } else if (typeof entries["main.js"] === "string") {
+                            entries["main.js"] = [
+                                swEntryJs,
+                                entries["main.js"]
+                            ];
                         }
-                        if (entries["main-app"] && !entries["main-app"].includes(swEntryJs)) {
-                            if (Array.isArray(entries["main-app"])) {
-                                entries["main-app"].unshift(swEntryJs);
-                            } else if (typeof entries["main-app"] === "string") {
-                                entries["main-app"] = [
-                                    swEntryJs,
-                                    entries["main-app"]
-                                ];
-                            }
+                    }
+                    if (entries["main-app"] && !entries["main-app"].includes(swEntryJs)) {
+                        if (Array.isArray(entries["main-app"])) {
+                            entries["main-app"].unshift(swEntryJs);
+                        } else if (typeof entries["main-app"] === "string") {
+                            entries["main-app"] = [
+                                swEntryJs,
+                                entries["main-app"]
+                            ];
                         }
-                        return entries;
-                    });
+                    }
+                    return entries;
+                };
                 if (!options.isServer) {
                     if (!register) {
                         info("Service worker won't be automatically registered as per the config, please call the following code in componentDidMount or useEffect:");
@@ -854,7 +855,7 @@ const withPWAInit = (pluginOptions)=>{
                         ]
                     }));
                     // Precache files in public folder
-                    let resolvedManifestEntries = additionalPrecacheEntries ?? [];
+                    let resolvedManifestEntries = additionalPrecacheEntries;
                     if (!resolvedManifestEntries) {
                         const swDestFileName = path.basename(swDest);
                         resolvedManifestEntries = fg.sync([

package/dist/internal-types.d.cts

@@ -0,0 +1,9 @@
+export type SerwistNextOptionsKey = "self.__SERWIST_SW_ENTRY";
+export interface SerwistNextOptions {
+    sw: string;
+    scope: string;
+    cacheOnFrontEndNav: boolean;
+    register: boolean;
+    reloadOnOnline: boolean;
+    swEntryWorker: string | undefined;
+}

package/dist/sw-entry-worker.d.cts

@@ -0,0 +1,7 @@
+export type MessageType = {
+    type: "__FRONTEND_NAV_CACHE__";
+    url: URL | string;
+} | {
+    type: "__START_URL_CACHE__";
+    url: URL | string;
+};

package/dist/sw-entry.d.cts

@@ -0,0 +1,6 @@
+import { Serwist } from "@serwist/window";
+declare global {
+    interface Window {
+        serwist: Serwist;
+    }
+}

package/dist/types.d.cts

@@ -0,0 +1,81 @@
+import type { WebpackInjectManifestOptions } from "@serwist/build";
+type Require<T, U extends keyof T> = T & Required<Pick<T, U>>;
+export interface PluginOptions extends Require<WebpackInjectManifestOptions, "swDest"> {
+    /**
+     * Enable additional route caching when users navigate through pages with
+     * `next/link`. This improves the user experience in some cases but it
+     * also adds a bit of overhead due to additional network calls.
+     * @default false
+     */
+    cacheOnFrontEndNav?: boolean;
+    /**
+     * Whether Serwist should be disabled.
+     * @default false
+     */
+    disable?: boolean;
+    /**
+     * Whether `@serwist/next` should automatically register the service worker for you. If
+     * you want to register the service worker yourself, set this to `false` and run
+     * `window.serwist.register()` in `componentDidMount` or `useEffect`.
+     * @example
+     *   ```tsx
+     *   // app/register-pwa.tsx
+     *   "use client";
+     *   import { useEffect } from "react";
+     *   import type { Serwist } from "@serwist/window";
+     *
+     *   declare global {
+     *     interface Window {
+     *       serwist: Serwist;
+     *     }
+     *   }
+     *
+     *   export default function RegisterPWA() {
+     *     useEffect(() => {
+     *       if ("serviceWorker" in navigator && window.serwist !== undefined) {
+     *         window.serwist.register();
+     *       }
+     *     }, []);
+     *     return <></>;
+     *   }
+     *
+     *   // app/layout.tsx
+     *   import RegisterPWA from "./register-pwa";
+     *
+     *   export default function RootLayout({
+     *     children,
+     *   }: {
+     *     children: React.ReactNode;
+     *   }) {
+     *     return (
+     *       <html lang="en">
+     *         <head />
+     *         <body>
+     *           <RegisterPWA />
+     *           {children}
+     *         </body>
+     *       </html>
+     *     );
+     *   }
+     *   ```
+     * @default true
+     */
+    register?: boolean;
+    /**
+     * Whether Serwist should reload the app when it goes online.
+     * @default true
+     */
+    reloadOnOnline?: boolean;
+    /**
+     * The service worker's URL scope. Set to `/foo/` so that paths under `/foo/` are under the service
+     * worker's control while others are not.
+     * @default nextConfig.basePath
+     */
+    scope?: string;
+    /**
+     * The URL to the service worker.
+     * @default "/sw.js"
+     */
+    swUrl?: string;
+}
+export {};

package/dist/utils/find-first-truthy.d.cts

@@ -0,0 +1,7 @@
+/**
+ * Find the first truthy value in an array.
+ * @param arr
+ * @param fn
+ * @returns
+ */
+export declare const findFirstTruthy: <T, U>(arr: T[], fn: (elm: T) => U) => NonNullable<U> | undefined;

package/dist/utils/get-content-hash.d.cts

@@ -0,0 +1,3 @@
+/// <reference types="node" resolution-mode="require"/>
+import type fs from "node:fs";
+export declare const getContentHash: (file: fs.PathOrFileDescriptor, isDev: boolean) => string;

package/dist/utils/get-file-hash.d.cts

@@ -0,0 +1,3 @@
+/// <reference types="node" resolution-mode="require"/>
+import fs from "node:fs";
+export declare const getFileHash: (file: fs.PathOrFileDescriptor) => string;

package/dist/utils/get-package-version.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Get a package's version
+ * @param packageName
+ * @returns
+ */
+export declare const getPackageVersion: (packageName: string) => string | undefined;

package/dist/utils/index.d.cts

@@ -0,0 +1,6 @@
+export { findFirstTruthy } from "./find-first-truthy.js";
+export { getContentHash } from "./get-content-hash.js";
+export { getFileHash } from "./get-file-hash.js";
+export { getPackageVersion } from "./get-package-version.js";
+export { loadTSConfig } from "./load-tsconfig.js";
+export * as logger from "./logger.js";

package/dist/utils/load-tsconfig.d.cts

@@ -0,0 +1,2 @@
+import type { TsConfigJson as TSConfigJSON } from "type-fest";
+export declare const loadTSConfig: (baseDir: string, relativeTSConfigPath: string | undefined) => TSConfigJSON | undefined;

package/dist/utils/logger.d.cts

@@ -0,0 +1,5 @@
+export declare const wait: (...message: any[]) => void;
+export declare const error: (...message: any[]) => void;
+export declare const warn: (...message: any[]) => void;
+export declare const info: (...message: any[]) => void;
+export declare const event: (...message: any[]) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/next",
-  "version": "8.4.1",
+  "version": "8.4.3",
   "type": "module",
   "description": "A module that integrates Serwist into your Next.js application.",
   "files": [
@@ -67,9 +67,9 @@
   "dependencies": {
     "clean-webpack-plugin": "4.0.0",
     "fast-glob": "3.3.2",
-    "@serwist/build": "8.4.1",
-    "@serwist/webpack-plugin": "8.4.1",
-    "@serwist/window": "8.4.1"
+    "@serwist/build": "8.4.3",
+    "@serwist/webpack-plugin": "8.4.3",
+    "@serwist/window": "8.4.3"
   },
   "devDependencies": {
     "@types/node": "20.10.5",
@@ -81,7 +81,7 @@
     "type-fest": "4.8.3",
     "typescript": "5.4.0-dev.20231226",
     "webpack": "5.89.0",
-    "@serwist/constants": "8.4.1"
+    "@serwist/constants": "8.4.3"
   },
   "peerDependencies": {
     "next": ">=14.0.0",