@serwist/next 8.4.4 → 9.0.0-preview.0

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/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.cjs

@@ -1,35 +0,0 @@
-'use strict';
-
-self.onmessage = async (ev)=>{
-    switch(ev.data.type){
-        case "__START_URL_CACHE__":
-            {
-                const url = ev.data.url;
-                const response = await fetch(url);
-                if (!response.redirected) {
-                    const startUrlCache = await caches.open("start-url");
-                    return startUrlCache.put(url, response);
-                }
-                return Promise.resolve();
-            }
-        case "__FRONTEND_NAV_CACHE__":
-            {
-                const url = ev.data.url;
-                const pagesCache = await caches.open("pages");
-                const isPageCached = !!await pagesCache.match(url, {
-                    ignoreSearch: true
-                });
-                if (isPageCached) {
-                    return;
-                }
-                const page = await fetch(url);
-                if (!page.ok) {
-                    return;
-                }
-                pagesCache.put(url, page.clone());
-                return Promise.resolve();
-            }
-        default:
-            return Promise.resolve();
-    }
-};

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.cjs

@@ -1,43 +0,0 @@
-'use strict';
-
-var window$1 = require('@serwist/window');
-
-if (typeof window !== "undefined" && "serviceWorker" in navigator && typeof caches !== "undefined") {
-    let swEntryWorker;
-    if (self.__SERWIST_SW_ENTRY.swEntryWorker) {
-        swEntryWorker = new Worker(self.__SERWIST_SW_ENTRY.swEntryWorker);
-    }
-    window.serwist = new window$1.Serwist(window.location.origin + self.__SERWIST_SW_ENTRY.sw, {
-        scope: self.__SERWIST_SW_ENTRY.scope
-    });
-    if (self.__SERWIST_SW_ENTRY.register) {
-        window.serwist.register();
-    }
-    if (self.__SERWIST_SW_ENTRY.cacheOnFrontEndNav) {
-        const cacheOnFrontEndNav = async (url)=>{
-            if (!window.navigator.onLine || !url) {
-                return;
-            }
-            swEntryWorker?.postMessage({
-                type: "__FRONTEND_NAV_CACHE__",
-                url
-            });
-        };
-        const pushState = history.pushState;
-        history.pushState = (...args)=>{
-            pushState.apply(history, args);
-            cacheOnFrontEndNav(args[2]);
-        };
-        const replaceState = history.replaceState;
-        history.replaceState = (...args)=>{
-            replaceState.apply(history, args);
-            cacheOnFrontEndNav(args[2]);
-        };
-        window.addEventListener("online", ()=>{
-            cacheOnFrontEndNav(window.location.pathname);
-        });
-    }
-    if (self.__SERWIST_SW_ENTRY.reloadOnOnline) {
-        window.addEventListener("online", ()=>location.reload());
-    }
-}

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/types.d.ts

@@ -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/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;