@serwist/svelte 9.0.0-preview.12 → 9.0.0-preview.14

package/dist/index.worker.d.ts

@@ -1,11 +1,15 @@
 /// <reference types="@sveltejs/kit" />
 import type { PrecacheEntry } from "@serwist/precaching";
 import type { RuntimeCaching } from "@serwist/sw";
-import { build as immutableAssets, files as staticAssets, prerendered as prerenderedRoutes, version as serviceWorkerVersion } from "$service-worker";
-export { immutableAssets, staticAssets, prerenderedRoutes, serviceWorkerVersion };
-export type StaticRevisions = {
+import { base as basePath, build as immutableAssets, files as staticAssets, prerendered as prerenderedRoutes, version as serviceWorkerVersion } from "$service-worker";
+export { basePath, immutableAssets, staticAssets, prerenderedRoutes, serviceWorkerVersion };
+export type StaticRevisions = string | {
     [url: string]: string | null;
 };
+export type ManifestTransform = (manifest: PrecacheEntry[]) => {
+    manifest: PrecacheEntry[];
+    warnings?: string[] | undefined;
+};
 export interface GetPrecacheManifestOptions {
     /**
      * Whether immutable assets, as in assets that are generated by
@@ -28,25 +32,32 @@ export interface GetPrecacheManifestOptions {
      */
     precachePrerendered?: boolean;
     /**
-     * An object that maps URLs of static assets to custom `revision`'s.
-     * If an URL doesn't exist in the object, `$service-worker.version`
+     * A string revision used for all static assets or an object that maps
+     * URLs of static assets to custom revisions.
+     * If an URL doesn't exist in the object, `serviceWorkerVersion`
      * will be used instead.
      *
      * This helps prevent such assets, which are unlikely to change, from
-     * being invalidated every time the service worker is installed.
+     * being invalidated every time the service worker is rebuilt and updated.
      *
-     * Note: you should prefix these URLs with `$service-worker.base`.
+     * Note: you should prefix these URLs with `basePath`.
      */
     staticRevisions?: StaticRevisions;
+    /**
+     * One or more functions which will be applied sequentially against the
+     * generated manifest.
+     */
+    manifestTransforms?: ManifestTransform[];
 }
 /**
- * Retrieves the precache manifest generated by SvelteKit. If further
- * modifications are needed, simply mutate the resulting array.
+ * Retrieves the precache manifest generated by SvelteKit. A simple
+ * wrapper around SvelteKit's built-in service worker support. For more
+ * complex use cases, seek [the `@serwist/vite` recipe for SvelteKit](https://serwist.pages.dev/docs/vite/recipes/svelte-kit).
  *
  * @param options
  * @returns
  */
-export declare const getPrecacheManifest: ({ precacheImmutable, precacheStatic, precachePrerendered, staticRevisions, }?: GetPrecacheManifestOptions) => PrecacheEntry[];
+export declare const getPrecacheManifest: ({ precacheImmutable, precacheStatic, precachePrerendered, staticRevisions, manifestTransforms, }?: GetPrecacheManifestOptions) => PrecacheEntry[] | undefined;
 export declare const defaultIgnoreUrlParameters: RegExp[];
 export declare const defaultCache: RuntimeCaching[];
 //# sourceMappingURL=index.worker.d.ts.map

package/dist/index.worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EAAE,KAAK,IAAI,eAAe,EAAE,KAAK,IAAI,YAAY,EAAE,WAAW,IAAI,iBAAiB,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAErJ,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;AAElF,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAE/D,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,kFAK7B,0BAA0B,KAAQ,aAAa,EAajD,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAAgC,CAAC;AAExE,eAAO,MAAM,YAAY,EAAE,cAAc,EAoGxC,CAAC"}
+{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EACL,IAAI,IAAI,QAAQ,EAChB,KAAK,IAAI,eAAe,EACxB,KAAK,IAAI,YAAY,EACrB,WAAW,IAAI,iBAAiB,EAChC,OAAO,IAAI,oBAAoB,EAChC,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;AAE5F,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK;IAC7D,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,sGAM7B,0BAA0B,KAAQ,aAAa,EAAE,GAAG,SA2CtD,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAAgC,CAAC;AAExE,eAAO,MAAM,YAAY,EAAE,cAAc,EAoGxC,CAAC"}

package/dist/index.worker.js

@@ -1,17 +1,15 @@
+import { logger } from '@serwist/core/internal';
 import { ExpirationPlugin } from '@serwist/expiration';
 import { CacheFirst, StaleWhileRevalidate, NetworkFirst } from '@serwist/strategies';
 import { build, files, prerendered, version } from '$service-worker';
-export { build as immutableAssets, prerendered as prerenderedRoutes, version as serviceWorkerVersion, files as staticAssets } from '$service-worker';
+export { base as basePath, build as immutableAssets, prerendered as prerenderedRoutes, version as serviceWorkerVersion, files as staticAssets } from '$service-worker';
 
-const getPrecacheManifest = ({ precacheImmutable = true, precacheStatic = true, precachePrerendered = true, staticRevisions } = {})=>{
-    const staticMapper = (url)=>{
-        const revision = staticRevisions !== undefined && url in staticRevisions ? staticRevisions[url] : version;
-        return {
+const getPrecacheManifest = ({ precacheImmutable = true, precacheStatic = true, precachePrerendered = true, staticRevisions, manifestTransforms } = {})=>{
+    const staticMapper = (url)=>({
             url,
-            revision
-        };
-    };
-    return [
+            revision: typeof staticRevisions === "string" ? staticRevisions : typeof staticRevisions === "object" ? url in staticRevisions ? staticRevisions[url] : version : version
+        });
+    let precacheManifest = [
         ...precacheImmutable ? build.map((url)=>({
                 url,
                 revision: null
@@ -22,6 +20,29 @@ const getPrecacheManifest = ({ precacheImmutable = true, precacheStatic = true,
                 revision: version
             })) : []
     ];
+    if (manifestTransforms) {
+        const allWarnings = [];
+        for (const transform of manifestTransforms){
+            const result = transform(precacheManifest);
+            if (!("manifest" in result)) {
+                if (process.env.NODE_ENV !== "production") {
+                    logger.error("The return value from a manifestTransform should be an object with 'manifest' and optionally 'warnings' properties.");
+                }
+                return undefined;
+            }
+            precacheManifest = result.manifest;
+            allWarnings.push(...result.warnings || []);
+        }
+        if (process.env.NODE_ENV !== "production" && allWarnings.length > 0) {
+            logger.warn("Received warnings while transforming the precache manifest.");
+            logger.groupCollapsed("View details here.");
+            for (const warning of allWarnings){
+                logger.warn(warning);
+            }
+            logger.groupEnd();
+        }
+    }
+    return precacheManifest;
 };
 const defaultIgnoreUrlParameters = [
     /^x-sveltekit-invalidated$/

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/svelte",
-  "version": "9.0.0-preview.12",
+  "version": "9.0.0-preview.14",
   "type": "module",
-  "description": "A module that integrates Serwist into your Svelte application.",
+  "description": "A module that complements SvelteKit's built-in service worker support.",
   "files": [
     "src",
     "dist"
@@ -40,20 +40,21 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/expiration": "9.0.0-preview.12",
-    "@serwist/strategies": "9.0.0-preview.12"
+    "@serwist/core": "9.0.0-preview.14",
+    "@serwist/expiration": "9.0.0-preview.14",
+    "@serwist/strategies": "9.0.0-preview.14"
   },
   "devDependencies": {
-    "@sveltejs/kit": "2.5.0",
-    "rollup": "4.9.6",
-    "@serwist/constants": "9.0.0-preview.12",
-    "@serwist/precaching": "9.0.0-preview.12",
-    "@serwist/sw": "9.0.0-preview.12"
+    "@sveltejs/kit": "2.5.3",
+    "rollup": "4.13.0",
+    "@serwist/constants": "9.0.0-preview.14",
+    "@serwist/precaching": "9.0.0-preview.14",
+    "@serwist/sw": "9.0.0-preview.14"
   },
   "peerDependencies": {
     "@sveltejs/kit": ">=2.0.0",
     "typescript": ">=5.0.0",
-    "@serwist/sw": "9.0.0-preview.12"
+    "@serwist/sw": "9.0.0-preview.14"
   },
   "peerDependenciesMeta": {
     "@serwist/sw": {

package/src/index.worker.ts

@@ -1,13 +1,25 @@
+import { logger } from "@serwist/core/internal";
 import { ExpirationPlugin } from "@serwist/expiration";
 import type { PrecacheEntry } from "@serwist/precaching";
 import { CacheFirst, NetworkFirst, StaleWhileRevalidate } from "@serwist/strategies";
 import type { RuntimeCaching } from "@serwist/sw";
 
-import { build as immutableAssets, files as staticAssets, prerendered as prerenderedRoutes, version as serviceWorkerVersion } from "$service-worker";
+import {
+  base as basePath,
+  build as immutableAssets,
+  files as staticAssets,
+  prerendered as prerenderedRoutes,
+  version as serviceWorkerVersion,
+} from "$service-worker";
 
-export { immutableAssets, staticAssets, prerenderedRoutes, serviceWorkerVersion };
+export { basePath, immutableAssets, staticAssets, prerenderedRoutes, serviceWorkerVersion };
 
-export type StaticRevisions = { [url: string]: string | null };
+export type StaticRevisions = string | { [url: string]: string | null };
+
+export type ManifestTransform = (manifest: PrecacheEntry[]) => {
+  manifest: PrecacheEntry[];
+  warnings?: string[] | undefined;
+};
 
 export interface GetPrecacheManifestOptions {
   /**
@@ -31,21 +43,28 @@ export interface GetPrecacheManifestOptions {
    */
   precachePrerendered?: boolean;
   /**
-   * An object that maps URLs of static assets to custom `revision`'s.
-   * If an URL doesn't exist in the object, `$service-worker.version`
+   * A string revision used for all static assets or an object that maps
+   * URLs of static assets to custom revisions.
+   * If an URL doesn't exist in the object, `serviceWorkerVersion`
    * will be used instead.
    *
    * This helps prevent such assets, which are unlikely to change, from
-   * being invalidated every time the service worker is installed.
+   * being invalidated every time the service worker is rebuilt and updated.
    *
-   * Note: you should prefix these URLs with `$service-worker.base`.
+   * Note: you should prefix these URLs with `basePath`.
    */
   staticRevisions?: StaticRevisions;
+  /**
+   * One or more functions which will be applied sequentially against the
+   * generated manifest.
+   */
+  manifestTransforms?: ManifestTransform[];
 }
 
 /**
- * Retrieves the precache manifest generated by SvelteKit. If further
- * modifications are needed, simply mutate the resulting array.
+ * Retrieves the precache manifest generated by SvelteKit. A simple
+ * wrapper around SvelteKit's built-in service worker support. For more
+ * complex use cases, seek [the `@serwist/vite` recipe for SvelteKit](https://serwist.pages.dev/docs/vite/recipes/svelte-kit).
  *
  * @param options
  * @returns
@@ -55,19 +74,50 @@ export const getPrecacheManifest = ({
   precacheStatic = true,
   precachePrerendered = true,
   staticRevisions,
-}: GetPrecacheManifestOptions = {}): PrecacheEntry[] => {
-  const staticMapper = (url: string): PrecacheEntry => {
-    const revision = staticRevisions !== undefined && url in staticRevisions ? staticRevisions[url] : serviceWorkerVersion;
-    return { url, revision };
-  };
-  return [
+  manifestTransforms,
+}: GetPrecacheManifestOptions = {}): PrecacheEntry[] | undefined => {
+  const staticMapper = (url: string): PrecacheEntry => ({
+    url,
+    revision:
+      typeof staticRevisions === "string"
+        ? staticRevisions
+        : typeof staticRevisions === "object"
+          ? url in staticRevisions
+            ? staticRevisions[url]
+            : serviceWorkerVersion
+          : serviceWorkerVersion,
+  });
+  let precacheManifest: PrecacheEntry[] = [
     // Immutable files generated by Vite.
-    ...(precacheImmutable ? immutableAssets.map((url) => ({ url, revision: null }) satisfies PrecacheEntry) : []),
+    ...(precacheImmutable ? immutableAssets.map((url) => <PrecacheEntry>{ url, revision: null }) : []),
     // Files in the static directory.
     ...(precacheStatic ? staticAssets.map(staticMapper) : []),
     // Prerendered routes.
-    ...(precachePrerendered ? prerenderedRoutes.map((url) => ({ url, revision: serviceWorkerVersion }) satisfies PrecacheEntry) : []),
+    ...(precachePrerendered ? prerenderedRoutes.map((url) => <PrecacheEntry>{ url, revision: serviceWorkerVersion }) : []),
   ];
+  if (manifestTransforms) {
+    const allWarnings: string[] = [];
+    for (const transform of manifestTransforms) {
+      const result = transform(precacheManifest);
+      if (!("manifest" in result)) {
+        if (process.env.NODE_ENV !== "production") {
+          logger.error("The return value from a manifestTransform should be an object with 'manifest' and optionally 'warnings' properties.");
+        }
+        return undefined;
+      }
+      precacheManifest = result.manifest;
+      allWarnings.push(...(result.warnings || []));
+    }
+    if (process.env.NODE_ENV !== "production" && allWarnings.length > 0) {
+      logger.warn("Received warnings while transforming the precache manifest.");
+      logger.groupCollapsed("View details here.");
+      for (const warning of allWarnings) {
+        logger.warn(warning);
+      }
+      logger.groupEnd();
+    }
+  }
+  return precacheManifest;
 };
 
 export const defaultIgnoreUrlParameters = [/^x-sveltekit-invalidated$/];