@serwist/next 8.1.1 → 8.2.0

package/README.md

@@ -0,0 +1 @@
+This module's documentation can be found at https://serwist.vercel.app/docs/next

package/dist/{index.old.cjs → index.cjs}

@@ -40,7 +40,7 @@ const getContentHash = (file, isDev)=>{
     return getFileHash(file).slice(0, 16);
 };
 
-node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.old.cjs', document.baseURI).href)));
+node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
 
 const loadTSConfig = (baseDir, relativeTSConfigPath)=>{
     try {
@@ -760,7 +760,7 @@ const event = (...message)=>{
     prefixedLog("event", ...message);
 };
 
-const __dirname$1 = node_url.fileURLToPath(new URL(".", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.old.cjs', document.baseURI).href))));
+const __dirname$1 = node_url.fileURLToPath(new URL(".", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
 const withPWAInit = (pluginOptions)=>{
     return (nextConfig = {})=>({
             ...nextConfig,

package/dist/sw-entry-worker.cjs

@@ -0,0 +1,35 @@
+'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/types.d.ts

@@ -14,21 +14,9 @@ export interface PluginOptions extends Require<WebpackInjectManifestOptions, "sw
      */
     disable?: boolean;
     /**
-     * URL scope for PWA. Set to `/foo/` so that paths under `/foo/` are PWA while others
-     * are not.
-     * @default nextConfig.basePath
-     */
-    scope?: string;
-    /**
-     * The URL to the service worker.
-     * @default "/sw.js"
-     */
-    swUrl?: string;
-    /**
-     * Allow this plugin to automatically register the service worker for you. Set
-     * this to `false` if you want to register the service worker yourself, which
-     * can be done by running `window.serwist.register()` in
-     * `componentDidMount` or `useEffect`.
+     * 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
@@ -74,9 +62,20 @@ export interface PluginOptions extends Require<WebpackInjectManifestOptions, "sw
      */
     register?: boolean;
     /**
-     * Reload the app when it has gone back online.
+     * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/next",
-  "version": "8.1.1",
+  "version": "8.2.0",
   "type": "module",
   "description": "A module that integrates Serwist into your Next.js application.",
   "files": [
@@ -19,9 +19,9 @@
   "license": "MIT",
   "repository": "serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
-  "homepage": "https://ducanh-next-pwa.vercel.app",
+  "homepage": "https://serwist.vercel.app",
   "module": "./dist/index.js",
-  "main": "./dist/index.old.cjs",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
@@ -30,8 +30,8 @@
         "default": "./dist/index.js"
       },
       "require": {
-        "types": "./dist/index.old.d.cts",
-        "default": "./dist/index.old.cjs"
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     },
     "./browser": {
@@ -40,8 +40,8 @@
         "default": "./dist/index.browser.js"
       },
       "require": {
-        "types": "./dist/index.browser.old.d.cts",
-        "default": "./dist/index.browser.old.cjs"
+        "types": "./dist/index.browser.d.cts",
+        "default": "./dist/index.browser.cjs"
       }
     },
     "./typings": {
@@ -49,7 +49,7 @@
         "types": "./dist/sw-entry.d.ts"
       },
       "require": {
-        "types": "./dist/sw-entry.old.d.cts"
+        "types": "./dist/sw-entry.d.cts"
       }
     },
     "./package.json": "./package.json"
@@ -67,9 +67,9 @@
   "dependencies": {
     "clean-webpack-plugin": "4.0.0",
     "fast-glob": "3.3.2",
-    "@serwist/build": "8.1.1",
-    "@serwist/webpack-plugin": "8.1.1",
-    "@serwist/window": "8.1.1"
+    "@serwist/build": "8.2.0",
+    "@serwist/webpack-plugin": "8.2.0",
+    "@serwist/window": "8.2.0"
   },
   "devDependencies": {
     "@types/node": "20.10.5",
@@ -79,9 +79,9 @@
     "react-dom": "18.2.0",
     "rollup": "4.9.1",
     "type-fest": "4.8.3",
-    "typescript": "5.4.0-dev.20231220",
+    "typescript": "5.4.0-dev.20231226",
     "webpack": "5.89.0",
-    "@serwist/constants": "8.1.1"
+    "@serwist/constants": "8.2.0"
   },
   "peerDependencies": {
     "next": ">=14.0.0",

package/dist/index.browser.old.d.cts

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

package/dist/index.old.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/sw-entry.old.d.cts

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