@serwist/sw 8.0.0 → 8.0.2

package/dist/disableDevLogs.d.ts

@@ -1,2 +1 @@
 export declare const disableDevLogs: () => void;
-//# sourceMappingURL=disableDevLogs.d.ts.map

package/dist/handlePrecaching.d.ts

@@ -11,4 +11,3 @@ export type HandlePrecachingOptions = {
     navigateFallback?: never;
 });
 export declare const handlePrecaching: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: shouldCleanupOutdatedCaches, ...options }: HandlePrecachingOptions) => void;
-//# sourceMappingURL=handlePrecaching.d.ts.map

package/dist/index.d.ts

@@ -10,9 +10,8 @@ export type SerwistOptions = HandlePrecachingOptions & {
     cacheId?: string | undefined;
     clientsClaim?: boolean;
     runtimeCaching?: RuntimeCaching[];
-    offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions;
+    offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
     disableDevLogs?: boolean;
 };
 export declare const installSerwist: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, skipWaiting: shouldSkipWaiting, importScripts: scriptsToImport, navigationPreload, cacheId, clientsClaim: shouldClaimClients, runtimeCaching, offlineAnalyticsConfig, disableDevLogs: shouldDisableDevLogs, ...options }: SerwistOptions) => void;
 export { disableDevLogs, handlePrecaching, registerRuntimeCaching };
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -97,7 +97,13 @@ const installSerwist = ({ precacheEntries, precacheOptions, cleanupOutdatedCache
         }
     });
     if (runtimeCaching !== undefined) registerRuntimeCaching(...runtimeCaching);
-    if (offlineAnalyticsConfig !== undefined) initialize(offlineAnalyticsConfig);
+    if (offlineAnalyticsConfig !== undefined) {
+        if (typeof offlineAnalyticsConfig === "boolean") {
+            offlineAnalyticsConfig && initialize();
+        } else {
+            initialize(offlineAnalyticsConfig);
+        }
+    }
     if (shouldDisableDevLogs) disableDevLogs();
 };
 

package/dist/index.old.cjs

@@ -99,7 +99,13 @@ const installSerwist = ({ precacheEntries, precacheOptions, cleanupOutdatedCache
         }
     });
     if (runtimeCaching !== undefined) registerRuntimeCaching(...runtimeCaching);
-    if (offlineAnalyticsConfig !== undefined) initialize.initialize(offlineAnalyticsConfig);
+    if (offlineAnalyticsConfig !== undefined) {
+        if (typeof offlineAnalyticsConfig === "boolean") {
+            offlineAnalyticsConfig && initialize.initialize();
+        } else {
+            initialize.initialize(offlineAnalyticsConfig);
+        }
+    }
     if (shouldDisableDevLogs) disableDevLogs();
 };
 

package/dist/nonNullable.d.ts

@@ -1,2 +1 @@
 export declare const nonNullable: <T>(value: T) => value is NonNullable<T>;
-//# sourceMappingURL=nonNullable.d.ts.map

package/dist/registerRuntimeCaching.d.ts

@@ -1,3 +1,2 @@
 import type { RuntimeCaching } from "@serwist/build";
 export declare const registerRuntimeCaching: (...runtimeCachingList: RuntimeCaching[]) => void;
-//# sourceMappingURL=registerRuntimeCaching.d.ts.map

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@serwist/sw",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "license": "MIT",
   "type": "module",
-  "author": "Google's Web DevRel Team, Serwist's Team",
   "description": "This module makes it easy to get started with the Serwist service worker libraries.",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
-  "homepage": "https://ducanh-next-pwa.vercel.app",
+  "files": [
+    "dist",
+    "!dist/**/dts"
+  ],
   "keywords": [
     "serwist",
     "serwistjs",
     "service worker",
     "sw"
   ],
+  "author": "Google's Web DevRel Team, Serwist's Team",
+  "repository": "serwist/serwist",
+  "bugs": "https://github.com/serwist/serwist/issues",
+  "homepage": "https://ducanh-next-pwa.vercel.app",
   "module": "./dist/index.js",
   "main": "./dist/index.old.cjs",
   "types": "./dist/index.d.ts",
@@ -26,22 +30,22 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "8.0.0",
-    "@serwist/broadcast-update": "8.0.0",
-    "@serwist/cacheable-response": "8.0.0",
-    "@serwist/core": "8.0.0",
-    "@serwist/expiration": "8.0.0",
-    "@serwist/google-analytics": "8.0.0",
-    "@serwist/navigation-preload": "8.0.0",
-    "@serwist/precaching": "8.0.0",
-    "@serwist/range-requests": "8.0.0",
-    "@serwist/routing": "8.0.0",
-    "@serwist/strategies": "8.0.0"
+    "@serwist/background-sync": "8.0.2",
+    "@serwist/broadcast-update": "8.0.2",
+    "@serwist/cacheable-response": "8.0.2",
+    "@serwist/core": "8.0.2",
+    "@serwist/expiration": "8.0.2",
+    "@serwist/google-analytics": "8.0.2",
+    "@serwist/navigation-preload": "8.0.2",
+    "@serwist/precaching": "8.0.2",
+    "@serwist/range-requests": "8.0.2",
+    "@serwist/routing": "8.0.2",
+    "@serwist/strategies": "8.0.2"
   },
   "devDependencies": {
     "rollup": "3.28.1",
-    "@serwist/build": "8.0.0",
-    "@serwist/constants": "8.0.0"
+    "@serwist/build": "8.0.2",
+    "@serwist/constants": "8.0.2"
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",

package/.turbo/turbo-build.log

@@ -1,10 +0,0 @@
-
-> @serwist/sw@8.0.0 build /home/runner/work/serwist/serwist/packages/sw
-> rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js
-
-(node:3208) ExperimentalWarning: Import assertions are not a stable feature of the JavaScript language. Avoid relying on their current behavior and syntax as those might change in a future version of Node.js.
-(Use `node --trace-warnings ...` to show where the warning was created)
-(node:3208) ExperimentalWarning: Importing JSON modules is an experimental feature and might change at any time
-
-src/index.ts → dist/index.old.cjs, dist/index.js...
-created dist/index.old.cjs, dist/index.js in 2.1s

package/.turbo/turbo-lint.log

@@ -1,4 +0,0 @@
-
-> @serwist/sw@8.0.0 lint /home/runner/work/serwist/serwist/packages/sw
-> eslint src --ext ts,tsx,js,jsx,cjs,mjs
-

package/.turbo/turbo-typecheck.log

@@ -1,4 +0,0 @@
-
-> @serwist/sw@8.0.0 typecheck /home/runner/work/serwist/serwist/packages/sw
-> tsc
-

package/CHANGELOG.md

@@ -1,43 +0,0 @@
-# @serwist/sw
-
-## 8.0.0
-
-### Major Changes
-
-- [`e0313f0`](https://github.com/serwist/serwist/commit/e0313f02f661a07ccbe9edc64e44e1af6136c73e) Thanks [@DuCanhGH](https://github.com/DuCanhGH)! - chore: initial release
-
-  - Reimagined `@serwist/next`.
-    - Removed various options.
-      - Removed `aggressiveFrontEndNavCaching` to reassess its usefulness.
-      - Removed `browserslist`. Use `swcEnvTargets` instead (TODO: add this option).
-      - Custom workers have been removed. You should use `swSrc`.
-      - Removed `extendDefaultRuntimeCaching`. Use the spread syntax instead (use `import { defaultCache } from "@serwist/next/browser"` to import the default runtimeCaching array).
-      - Temporarily removed `fallbacks` to investigate module-friendly alternatives.
-      - Removed `swcMinify`.
-      - Removed `watchWorkersInDev`.
-      - Removed `cacheStartUrl`, `dynamicStartUrl`, and `dynamicStartUrl`. These shall be re-added only when their use cases are made more clear to me.
-    - Merged `workboxOptions` with the plugin's options.
-    - Removed `swc-loader`, `terser-minify`, `webpack-builders`,... (we now leverage `ChildCompilationPlugin` to compile workers - this change will be backported to `@ducanh2912/next-pwa@10`)
-    - Removed the ability to use GenerateSW. `@serwist/sw.installSerwist` is provided as a replacement.
-    - `swSrc` is now a required property.
-    - Moved minimum support Next.js version from `11.0.0` to `14.0.0`.
-  - Removed GenerateSW (replaced by `@serwist/sw.installSerwist`).
-    - See `examples/next-basic/app/sw.ts` to see how `installSerwist` should be used.
-  - Repurposed `@serwist/sw`.
-    - The old package might be reintroduced if there's demand.
-  - **Note:** This is just the initial release, and there is still a lot of ground to cover (a lot of legacy code to be removed, a lot of features to be reintroduced,...). Here's to a bright future for the project :\_)
-
-### Patch Changes
-
-- Updated dependencies [[`e0313f0`](https://github.com/serwist/serwist/commit/e0313f02f661a07ccbe9edc64e44e1af6136c73e)]:
-  - @serwist/cacheable-response@8.0.0
-  - @serwist/navigation-preload@8.0.0
-  - @serwist/broadcast-update@8.0.0
-  - @serwist/google-analytics@8.0.0
-  - @serwist/background-sync@8.0.0
-  - @serwist/range-requests@8.0.0
-  - @serwist/expiration@8.0.0
-  - @serwist/precaching@8.0.0
-  - @serwist/strategies@8.0.0
-  - @serwist/routing@8.0.0
-  - @serwist/core@8.0.0

package/dist/disableDevLogs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"disableDevLogs.d.ts","sourceRoot":"","sources":["../src/disableDevLogs.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc,YAE1B,CAAC"}

package/dist/handlePrecaching.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"handlePrecaching.d.ts","sourceRoot":"","sources":["../src/handlePrecaching.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAI/E,MAAM,MAAM,uBAAuB,GAAG;IACpC,eAAe,CAAC,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7C,eAAe,CAAC,EAAE,oBAAoB,CAAC;IAEvC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,GAAG,CAAC;IAAE,gBAAgB,EAAE,MAAM,CAAC;IAAC,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,gBAAgB,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAE7I,eAAO,MAAM,gBAAgB,yGAK1B,uBAAuB,SAoBzB,CAAC"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,sCAAsC,CAAC;AAGzG,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAIrE,MAAM,MAAM,cAAc,GAAG,uBAAuB,GAAG;IACrD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC,sBAAsB,CAAC,EAAE,gCAAgC,CAAC;IAC1D,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,cAAc,wRAcxB,cAAc,SAsChB,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/nonNullable.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nonNullable.d.ts","sourceRoot":"","sources":["../src/nonNullable.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,0CAAkF,CAAC"}

package/dist/registerRuntimeCaching.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registerRuntimeCaching.d.ts","sourceRoot":"","sources":["../src/registerRuntimeCaching.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,gBAAgB,CAAC;AAkBnE,eAAO,MAAM,sBAAsB,0BAA2B,cAAc,EAAE,SA4C7E,CAAC"}

package/rollup.config.js

@@ -1,27 +0,0 @@
-// @ts-check
-import { getRollupOptions } from "@serwist/constants/rollup";
-
-import packageJson from "./package.json" assert { type: "json" };
-
-const isDev = process.env.NODE_ENV === "development";
-
-export default getRollupOptions({
-  packageJson,
-  jsFiles: [
-    {
-      input: "src/index.ts",
-      output: [
-        {
-          file: "dist/index.old.cjs",
-          format: "cjs",
-          exports: "named",
-        },
-        {
-          file: "dist/index.js",
-          format: "esm",
-        },
-      ],
-    },
-  ],
-  shouldEmitDeclaration: !isDev,
-});

package/src/disableDevLogs.ts

@@ -1,7 +0,0 @@
-declare const self: WorkerGlobalScope & {
-  __WB_DISABLE_DEV_LOGS: boolean;
-};
-
-export const disableDevLogs = () => {
-  self.__WB_DISABLE_DEV_LOGS = true;
-};

package/src/handlePrecaching.ts

@@ -1,37 +0,0 @@
-import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
-import { cleanupOutdatedCaches, createHandlerBoundToURL, precacheAndRoute } from "@serwist/precaching";
-import { NavigationRoute, registerRoute } from "@serwist/routing";
-
-export type HandlePrecachingOptions = {
-  precacheEntries?: (PrecacheEntry | string)[];
-  precacheOptions?: PrecacheRouteOptions;
-
-  cleanupOutdatedCaches?: boolean;
-} & ({ navigateFallback: string; navigateFallbackAllowlist?: RegExp[]; navigateFallbackDenylist?: RegExp[] } | { navigateFallback?: never });
-
-export const handlePrecaching = ({
-  precacheEntries,
-  precacheOptions,
-  cleanupOutdatedCaches: shouldCleanupOutdatedCaches = false,
-  ...options
-}: HandlePrecachingOptions) => {
-  if (!!precacheEntries && precacheEntries.length > 0) {
-    /**
-     * The precacheAndRoute() method efficiently caches and responds to
-     * requests for URLs in the manifest.
-     * See https://goo.gl/S9QRab
-     */
-    precacheAndRoute(precacheEntries, precacheOptions);
-  }
-
-  if (shouldCleanupOutdatedCaches) cleanupOutdatedCaches();
-
-  if (options.navigateFallback) {
-    registerRoute(
-      new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
-        allowlist: options.navigateFallbackAllowlist,
-        denylist: options.navigateFallbackDenylist,
-      })
-    );
-  }
-};

package/src/index.ts

@@ -1,77 +0,0 @@
-import type { RuntimeCaching } from "@serwist/build";
-import { clientsClaim, setCacheNameDetails } from "@serwist/core";
-import { type GoogleAnalyticsInitializeOptions, initialize } from "@serwist/google-analytics/initialize";
-import { enable } from "@serwist/navigation-preload";
-
-import { disableDevLogs } from "./disableDevLogs.js";
-import { handlePrecaching, type HandlePrecachingOptions } from "./handlePrecaching.js";
-import { registerRuntimeCaching } from "./registerRuntimeCaching.js";
-
-declare const self: ServiceWorkerGlobalScope;
-
-export type SerwistOptions = HandlePrecachingOptions & {
-  skipWaiting?: boolean;
-  importScripts?: string[];
-  navigationPreload?: boolean;
-  cacheId?: string | undefined;
-  clientsClaim?: boolean;
-  runtimeCaching?: RuntimeCaching[];
-  offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions;
-  disableDevLogs?: boolean;
-};
-
-export const installSerwist = ({
-  precacheEntries,
-  precacheOptions,
-  cleanupOutdatedCaches,
-
-  skipWaiting: shouldSkipWaiting = false,
-  importScripts: scriptsToImport,
-  navigationPreload = false,
-  cacheId,
-  clientsClaim: shouldClaimClients = false,
-  runtimeCaching,
-  offlineAnalyticsConfig,
-  disableDevLogs: shouldDisableDevLogs,
-  ...options
-}: SerwistOptions) => {
-  if (!!scriptsToImport && scriptsToImport.length > 0) self.importScripts(...scriptsToImport);
-
-  if (navigationPreload) enable();
-
-  if (cacheId !== undefined)
-    setCacheNameDetails({
-      prefix: cacheId,
-    });
-
-  if (shouldSkipWaiting) {
-    self.skipWaiting();
-  } else {
-    self.addEventListener("message", (event) => {
-      if (event.data && event.data.type === "SKIP_WAITING") {
-        self.skipWaiting();
-      }
-    });
-  }
-
-  if (shouldClaimClients) clientsClaim();
-
-  handlePrecaching({
-    precacheEntries,
-    precacheOptions,
-    cleanupOutdatedCaches,
-    ...(options.navigateFallback && {
-      navigateFallback: options.navigateFallback,
-      navigateFallbackAllowlist: options.navigateFallbackAllowlist,
-      navigateFallbackDenylist: options.navigateFallbackDenylist,
-    }),
-  });
-
-  if (runtimeCaching !== undefined) registerRuntimeCaching(...runtimeCaching);
-
-  if (offlineAnalyticsConfig !== undefined) initialize(offlineAnalyticsConfig);
-
-  if (shouldDisableDevLogs) disableDevLogs();
-};
-
-export { disableDevLogs, handlePrecaching, registerRuntimeCaching };

package/src/nonNullable.ts

@@ -1 +0,0 @@
-export const nonNullable = <T>(value: T): value is NonNullable<T> => value !== null && value !== undefined;

package/src/registerRuntimeCaching.ts

@@ -1,65 +0,0 @@
-import { BackgroundSyncPlugin } from "@serwist/background-sync";
-import { BroadcastUpdatePlugin } from "@serwist/broadcast-update";
-import type { RuntimeCaching, StrategyName } from "@serwist/build";
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
-import { ExpirationPlugin } from "@serwist/expiration";
-import { PrecacheFallbackPlugin } from "@serwist/precaching";
-import { RangeRequestsPlugin } from "@serwist/range-requests";
-import { registerRoute } from "@serwist/routing";
-import { CacheFirst, CacheOnly, NetworkFirst, NetworkOnly, StaleWhileRevalidate } from "@serwist/strategies";
-
-import { nonNullable } from "./nonNullable.js";
-
-const HANDLER_NAME_TO_METHOD = {
-  CacheFirst,
-  CacheOnly,
-  NetworkFirst,
-  NetworkOnly,
-  StaleWhileRevalidate,
-} satisfies Record<StrategyName, unknown>;
-
-export const registerRuntimeCaching = (...runtimeCachingList: RuntimeCaching[]) => {
-  for (const rcEntry of runtimeCachingList) {
-    if (typeof rcEntry.handler === "string") {
-      const {
-        cacheName,
-        networkTimeoutSeconds,
-        fetchOptions,
-        matchOptions,
-        plugins,
-        backgroundSync,
-        broadcastUpdate,
-        cacheableResponse,
-        expiration,
-        precacheFallback,
-        rangeRequests,
-      } = rcEntry.options!; // entry.options is always defined when entry.handler is of type 'string'.
-      const Handler = HANDLER_NAME_TO_METHOD[rcEntry.handler];
-      registerRoute(
-        rcEntry.urlPattern,
-        new Handler({
-          cacheName: cacheName ?? undefined,
-          networkTimeoutSeconds,
-          fetchOptions,
-          matchOptions,
-          plugins: [
-            ...(plugins ?? []),
-            backgroundSync && new BackgroundSyncPlugin(backgroundSync.name, backgroundSync.options),
-            broadcastUpdate &&
-              new BroadcastUpdatePlugin({
-                // @ts-expect-error weird...
-                channelName: broadcastUpdate.channelName,
-                ...broadcastUpdate.options,
-              }),
-            cacheableResponse && new CacheableResponsePlugin(cacheableResponse),
-            expiration && new ExpirationPlugin(expiration),
-            precacheFallback && new PrecacheFallbackPlugin(precacheFallback),
-            rangeRequests ? new RangeRequestsPlugin() : undefined,
-          ].filter(nonNullable),
-        })
-      );
-    } else {
-      registerRoute(rcEntry.urlPattern, rcEntry.handler, rcEntry.method);
-    }
-  }
-};

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "module": "NodeNext"
-  },
-  "include": ["**/*.ts", "rollup.config.js"],
-  "exclude": ["dist", "node_modules"]
-}