@serwist/next 8.4.0 → 8.4.1

package/dist/index.browser.d.cts

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

package/dist/index.cjs

@@ -750,7 +750,7 @@ const prefixedLog = (prefixType, ...message)=>{
     if (message.length === 0) {
         console[consoleMethod]("");
     } else {
-        console[consoleMethod](" " + prefix, ...message);
+        console[consoleMethod](` ${prefix}`, ...message);
     }
 };
 const info = (...message)=>{
@@ -774,7 +774,7 @@ const withPWAInit = (pluginOptions)=>{
                     config = nextConfig.webpack(config, options);
                 }
                 if (disable) {
-                    options.isServer && info("PWA support is disabled.");
+                    options.isServer && info("Serwist is disabled.");
                     return config;
                 }
                 if (!config.plugins) {
@@ -818,13 +818,14 @@ const withPWAInit = (pluginOptions)=>{
                 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:");
-                        info(`  window.serwist.register()`);
+                        info("  window.serwist.register()");
                         if (!tsConfigJson?.compilerOptions?.types?.includes("@serwist/next/typings")) {
                             info("You may also want to add @serwist/next/typings to compilerOptions.types in your tsconfig.json/jsconfig.json.");
                         }
                     }
                     const { swSrc: providedSwSrc, swDest: providedSwDest, additionalPrecacheEntries, exclude = [], modifyURLPrefix = {}, manifestTransforms = [], ...otherBuildOptions } = buildOptions;
-                    let swSrc = providedSwSrc, swDest = providedSwDest;
+                    let swSrc = providedSwSrc;
+                    let swDest = providedSwDest;
                     if (!path.isAbsolute(swSrc)) {
                         swSrc = path.join(options.dir, swSrc);
                     }
@@ -835,7 +836,7 @@ const withPWAInit = (pluginOptions)=>{
                     const shouldBuildSWEntryWorker = cacheOnFrontEndNav;
                     let swEntryPublicPath = undefined;
                     if (shouldBuildSWEntryWorker) {
-                        const swEntryWorkerSrc = path.join(__dirname$1, `sw-entry-worker.js`);
+                        const swEntryWorkerSrc = path.join(__dirname$1, "sw-entry-worker.js");
                         const swEntryName = `swe-worker-${getContentHash(swEntryWorkerSrc, dev)}.js`;
                         swEntryPublicPath = path.posix.join(basePath, swEntryName);
                         const swEntryWorkerDest = path.join(destDir, swEntryName);

package/dist/index.d.cts

@@ -1,5 +0,0 @@
-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

@@ -745,7 +745,7 @@ const prefixedLog = (prefixType, ...message)=>{
     if (message.length === 0) {
         console[consoleMethod]("");
     } else {
-        console[consoleMethod](" " + prefix, ...message);
+        console[consoleMethod](` ${prefix}`, ...message);
     }
 };
 const info = (...message)=>{
@@ -769,7 +769,7 @@ const withPWAInit = (pluginOptions)=>{
                     config = nextConfig.webpack(config, options);
                 }
                 if (disable) {
-                    options.isServer && info("PWA support is disabled.");
+                    options.isServer && info("Serwist is disabled.");
                     return config;
                 }
                 if (!config.plugins) {
@@ -813,13 +813,14 @@ const withPWAInit = (pluginOptions)=>{
                 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:");
-                        info(`  window.serwist.register()`);
+                        info("  window.serwist.register()");
                         if (!tsConfigJson?.compilerOptions?.types?.includes("@serwist/next/typings")) {
                             info("You may also want to add @serwist/next/typings to compilerOptions.types in your tsconfig.json/jsconfig.json.");
                         }
                     }
                     const { swSrc: providedSwSrc, swDest: providedSwDest, additionalPrecacheEntries, exclude = [], modifyURLPrefix = {}, manifestTransforms = [], ...otherBuildOptions } = buildOptions;
-                    let swSrc = providedSwSrc, swDest = providedSwDest;
+                    let swSrc = providedSwSrc;
+                    let swDest = providedSwDest;
                     if (!path.isAbsolute(swSrc)) {
                         swSrc = path.join(options.dir, swSrc);
                     }
@@ -830,7 +831,7 @@ const withPWAInit = (pluginOptions)=>{
                     const shouldBuildSWEntryWorker = cacheOnFrontEndNav;
                     let swEntryPublicPath = undefined;
                     if (shouldBuildSWEntryWorker) {
-                        const swEntryWorkerSrc = path.join(__dirname, `sw-entry-worker.js`);
+                        const swEntryWorkerSrc = path.join(__dirname, "sw-entry-worker.js");
                         const swEntryName = `swe-worker-${getContentHash(swEntryWorkerSrc, dev)}.js`;
                         swEntryPublicPath = path.posix.join(basePath, swEntryName);
                         const swEntryWorkerDest = path.join(destDir, swEntryName);

package/dist/internal-types.d.cts

@@ -1,9 +0,0 @@
-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

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

package/dist/sw-entry.d.cts

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

package/dist/types.d.cts

@@ -1,81 +0,0 @@
-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

@@ -1,7 +0,0 @@
-/**
- * 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

@@ -1,3 +0,0 @@
-/// <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

@@ -1,3 +0,0 @@
-/// <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

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

package/dist/utils/index.d.cts

@@ -1,6 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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/dist/utils.d.cts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/next",
-  "version": "8.4.0",
+  "version": "8.4.1",
   "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.0",
-    "@serwist/webpack-plugin": "8.4.0",
-    "@serwist/window": "8.4.0"
+    "@serwist/build": "8.4.1",
+    "@serwist/webpack-plugin": "8.4.1",
+    "@serwist/window": "8.4.1"
   },
   "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.0"
+    "@serwist/constants": "8.4.1"
   },
   "peerDependencies": {
     "next": ">=14.0.0",
@@ -90,7 +90,7 @@
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
     "dev": "rollup --config rollup.config.js --watch",
-    "lint": "eslint src --ext ts,tsx,js,jsx,cjs,mjs",
+    "lint": "biome lint ./src",
     "typecheck": "tsc"
   }
 }