@serwist/svelte 9.0.0-preview.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Google LLC, 2019 ShadowWalker w@weiw.io https://weiw.io, 2023 Serwist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+This module's documentation can be found at https://serwist.pages.dev/docs/svelte

package/dist/index.worker.d.ts

@@ -0,0 +1,52 @@
+/// <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 = {
+    [url: string]: string | null;
+};
+export interface GetPrecacheManifestOptions {
+    /**
+     * Whether immutable assets, as in assets that are generated by
+     * Vite, should be precached.
+     *
+     * @default true
+     */
+    precacheImmutable?: boolean;
+    /**
+     * Whether static assets should be precached.
+     *
+     * @default true
+     */
+    precacheStatic?: boolean;
+    /**
+     * Whether prerendered routes should be precached. This
+     * includes their __data.json files.
+     *
+     * @default true
+     */
+    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`
+     * will be used instead.
+     *
+     * This helps prevent such assets, which are unlikely to change, from
+     * being invalidated every time the service worker is installed.
+     *
+     * Note: you should prefix these URLs with `$service-worker.base`.
+     */
+    staticRevisions?: StaticRevisions;
+}
+/**
+ * Retrieves the precache manifest generated by SvelteKit. If further
+ * modifications are needed, simply mutate the resulting array.
+ *
+ * @param options
+ * @returns
+ */
+export declare const getPrecacheManifest: ({ precacheImmutable, precacheStatic, precachePrerendered, staticRevisions, }?: GetPrecacheManifestOptions) => PrecacheEntry[];
+export declare const defaultIgnoreUrlParameters: RegExp[];
+export declare const defaultCache: RuntimeCaching[];
+//# sourceMappingURL=index.worker.d.ts.map

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

@@ -0,0 +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"}

package/dist/index.worker.js

@@ -0,0 +1,131 @@
+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';
+
+const getPrecacheManifest = ({ precacheImmutable = true, precacheStatic = true, precachePrerendered = true, staticRevisions } = {})=>{
+    const staticMapper = (url)=>{
+        const revision = staticRevisions !== undefined && url in staticRevisions ? staticRevisions[url] : version;
+        return {
+            url,
+            revision
+        };
+    };
+    return [
+        ...precacheImmutable ? build.map((url)=>({
+                url,
+                revision: null
+            })) : [],
+        ...precacheStatic ? files.map(staticMapper) : [],
+        ...precachePrerendered ? prerendered.map((url)=>({
+                url,
+                revision: version
+            })) : []
+    ];
+};
+const defaultIgnoreUrlParameters = [
+    /^x-sveltekit-invalidated$/
+];
+const defaultCache = [
+    {
+        matcher: /^https:\/\/fonts\.(?:googleapis|gstatic)\.com\/.*/i,
+        handler: new CacheFirst({
+            cacheName: "google-fonts",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 4,
+                    maxAgeSeconds: 365 * 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
+        handler: new StaleWhileRevalidate({
+            cacheName: "static-font-assets",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 4,
+                    maxAgeSeconds: 7 * 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
+        handler: new StaleWhileRevalidate({
+            cacheName: "static-image-assets",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 64,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\.(?:js)$/i,
+        handler: new StaleWhileRevalidate({
+            cacheName: "static-js-assets",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\.(?:css|less)$/i,
+        handler: new StaleWhileRevalidate({
+            cacheName: "static-style-assets",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\.(?:json|xml|csv)$/i,
+        handler: new NetworkFirst({
+            cacheName: "static-data-assets",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
+    },
+    {
+        matcher: /\/api\/.*$/i,
+        method: "GET",
+        handler: new NetworkFirst({
+            cacheName: "apis",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 16,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ],
+            networkTimeoutSeconds: 10
+        })
+    },
+    {
+        matcher: /.*/i,
+        handler: new NetworkFirst({
+            cacheName: "others",
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ],
+            networkTimeoutSeconds: 10
+        })
+    }
+];
+
+export { defaultCache, defaultIgnoreUrlParameters, getPrecacheManifest };

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@serwist/svelte",
+  "version": "9.0.0-preview.10",
+  "type": "module",
+  "description": "A module that integrates Serwist into your Svelte application.",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "keywords": [
+    "serwist",
+    "serwistjs",
+    "sw",
+    "service worker",
+    "progressive web apps",
+    "web",
+    "service-worker",
+    "progressive-web-apps",
+    "svelte",
+    "sveltekit",
+    "pwa"
+  ],
+  "author": "Serwist's Team",
+  "license": "MIT",
+  "repository": "serwist/serwist",
+  "bugs": "https://github.com/serwist/serwist/issues",
+  "homepage": "https://serwist.pages.dev",
+  "typesVersions": {
+    "*": {
+      "worker": [
+        "./dist/index.worker.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    "./worker": {
+      "types": "./dist/index.worker.d.ts",
+      "default": "./dist/index.worker.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@serwist/expiration": "9.0.0-preview.10",
+    "@serwist/strategies": "9.0.0-preview.10"
+  },
+  "devDependencies": {
+    "@sveltejs/kit": "2.5.0",
+    "rollup": "4.9.6",
+    "@serwist/constants": "9.0.0-preview.10",
+    "@serwist/precaching": "9.0.0-preview.10",
+    "@serwist/sw": "9.0.0-preview.10"
+  },
+  "peerDependencies": {
+    "@sveltejs/kit": ">=2.0.0",
+    "typescript": ">=5.0.0",
+    "@serwist/sw": "9.0.0-preview.10"
+  },
+  "peerDependenciesMeta": {
+    "@serwist/sw": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
+    "dev": "rollup --config rollup.config.js --watch",
+    "lint": "biome lint ./src",
+    "typecheck": "tsc"
+  }
+}

package/src/index.worker.ts

@@ -0,0 +1,175 @@
+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";
+
+export { immutableAssets, staticAssets, prerenderedRoutes, serviceWorkerVersion };
+
+export type StaticRevisions = { [url: string]: string | null };
+
+export interface GetPrecacheManifestOptions {
+  /**
+   * Whether immutable assets, as in assets that are generated by
+   * Vite, should be precached.
+   *
+   * @default true
+   */
+  precacheImmutable?: boolean;
+  /**
+   * Whether static assets should be precached.
+   *
+   * @default true
+   */
+  precacheStatic?: boolean;
+  /**
+   * Whether prerendered routes should be precached. This
+   * includes their __data.json files.
+   *
+   * @default true
+   */
+  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`
+   * will be used instead.
+   *
+   * This helps prevent such assets, which are unlikely to change, from
+   * being invalidated every time the service worker is installed.
+   *
+   * Note: you should prefix these URLs with `$service-worker.base`.
+   */
+  staticRevisions?: StaticRevisions;
+}
+
+/**
+ * Retrieves the precache manifest generated by SvelteKit. If further
+ * modifications are needed, simply mutate the resulting array.
+ *
+ * @param options
+ * @returns
+ */
+export const getPrecacheManifest = ({
+  precacheImmutable = true,
+  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 [
+    // Immutable files generated by Vite.
+    ...(precacheImmutable ? immutableAssets.map((url) => ({ url, revision: null }) satisfies PrecacheEntry) : []),
+    // Files in the static directory.
+    ...(precacheStatic ? staticAssets.map(staticMapper) : []),
+    // Prerendered routes.
+    ...(precachePrerendered ? prerenderedRoutes.map((url) => ({ url, revision: serviceWorkerVersion }) satisfies PrecacheEntry) : []),
+  ];
+};
+
+export const defaultIgnoreUrlParameters = [/^x-sveltekit-invalidated$/];
+
+export const defaultCache: RuntimeCaching[] = [
+  {
+    matcher: /^https:\/\/fonts\.(?:googleapis|gstatic)\.com\/.*/i,
+    handler: new CacheFirst({
+      cacheName: "google-fonts",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 4,
+          maxAgeSeconds: 365 * 24 * 60 * 60, // 365 days
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
+    handler: new StaleWhileRevalidate({
+      cacheName: "static-font-assets",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 4,
+          maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
+    handler: new StaleWhileRevalidate({
+      cacheName: "static-image-assets",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 64,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\.(?:js)$/i,
+    handler: new StaleWhileRevalidate({
+      cacheName: "static-js-assets",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 32,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\.(?:css|less)$/i,
+    handler: new StaleWhileRevalidate({
+      cacheName: "static-style-assets",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 32,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\.(?:json|xml|csv)$/i,
+    handler: new NetworkFirst({
+      cacheName: "static-data-assets",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 32,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+    }),
+  },
+  {
+    matcher: /\/api\/.*$/i,
+    method: "GET",
+    handler: new NetworkFirst({
+      cacheName: "apis",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 16,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+      networkTimeoutSeconds: 10, // fallback to cache if API does not response within 10 seconds
+    }),
+  },
+  {
+    matcher: /.*/i,
+    handler: new NetworkFirst({
+      cacheName: "others",
+      plugins: [
+        new ExpirationPlugin({
+          maxEntries: 32,
+          maxAgeSeconds: 24 * 60 * 60, // 24 hours
+        }),
+      ],
+      networkTimeoutSeconds: 10,
+    }),
+  },
+];