@serwist/vite 9.0.0-preview.0 → 9.0.0-preview.2

package/dist/index.js

@@ -9,13 +9,7 @@ import 'node:fs';
 import 'fast-glob';
 import 'node:assert';
 
-/**
- * Internal build plugin used by `@serwist/vite`.
- * @internal
- * @param ctx
- * @param api
- * @returns
- */ const buildPlugin = (ctx, api)=>{
+const buildPlugin = (ctx, api)=>{
     return {
         name: "@serwist/vite:build",
         enforce: "post",
@@ -35,11 +29,7 @@ import 'node:assert';
     };
 };
 
-/**
- * Integrates Serwist into your Vite app.
- * @param userOptions
- * @returns
- */ const serwist = (userOptions)=>{
+const serwist = (userOptions)=>{
     const ctx = createContext(userOptions, undefined);
     const api = createApi(ctx);
     return [

package/dist/integration/svelte/index.js

@@ -29,7 +29,6 @@ const buildPlugin = (ctx, api)=>{
 
 const configurateSvelteKitOptions = (viteConfig, kit, options)=>{
     const clientOutDir = path.resolve(viteConfig.root, viteConfig.build.outDir, "../client");
-    // Kit fixes the service worker's name to 'service-worker.js'
     if (viteConfig.isProduction) {
         options.swSrc = path.resolve(clientOutDir, "service-worker.js");
         options.swDest = path.resolve(clientOutDir, "service-worker.js");
@@ -43,8 +42,6 @@ const configurateSvelteKitOptions = (viteConfig, kit, options)=>{
         }
     }
     options.swUrl = "/service-worker.js";
-    // SvelteKit's outDir is `.svelte-kit/output/client`.
-    // We need to include the parent folder in globDirectory since SvelteKit will generate SSG in `.svelte-kit/output/prerendered` folder.
     if (!options.globDirectory) {
         options.globDirectory = path.resolve(clientOutDir, "..");
     }
@@ -62,9 +59,7 @@ const configurateSvelteKitOptions = (viteConfig, kit, options)=>{
             options.globPatterns.push(`client/${buildAssetsDir}version.json`);
         }
     }
-    // Exclude server assets: sw is built on SSR build
     options.globIgnores = buildGlobIgnores(options.globIgnores);
-    // Vite 5 support: allow override dontCacheBustURLsMatching
     if (!("dontCacheBustURLsMatching" in options)) {
         options.dontCacheBustURLsMatching = new RegExp(`${buildAssetsDir}immutable/`);
     }
@@ -78,18 +73,12 @@ function createManifestTransform(base, webManifestName, options) {
         const suffix = options?.trailingSlash === "always" ? "/" : "";
         let adapterFallback = options?.adapterFallback;
         let excludeFallback = false;
-        // the fallback will be always generated by SvelteKit.
-        // The adapter will copy the fallback only if it is provided in its options: we need to exclude it
         if (!adapterFallback) {
             adapterFallback = defaultAdapterFallback;
             excludeFallback = true;
         }
-        // the fallback will be always in .svelte-kit/output/prerendered/fallback.html
         const manifest = entries.filter(({ url })=>!(excludeFallback && url === defaultAdapterFallback)).map((e)=>{
             let url = e.url;
-            // client assets in `.svelte-kit/output/client` folder.
-            // SSG pages in `.svelte-kit/output/prerendered/pages` folder.
-            // fallback page in `.svelte-kit/output/prerendered` folder (fallback.html is the default).
             if (url.startsWith("client/")) url = url.slice(7);
             else if (url.startsWith("prerendered/pages/")) url = url.slice(18);
             else if (url === defaultAdapterFallback) url = adapterFallback;
@@ -100,11 +89,9 @@ function createManifestTransform(base, webManifestName, options) {
                 } else {
                     const idx = url.lastIndexOf("/");
                     if (idx > -1) {
-                        // abc/index.html -> abc/?
                         if (url.endsWith("/index.html")) url = `${url.slice(0, idx)}${suffix}`;
                         else url = `${url.substring(0, url.lastIndexOf("."))}${suffix}`;
                     } else {
-                        // xxx.html -> xxx/?
                         url = `${url.substring(0, url.lastIndexOf("."))}${suffix}`;
                     }
                 }
@@ -142,12 +129,7 @@ function buildGlobIgnores(globIgnores) {
     ];
 }
 
-// TODO: handle SvelteKit build errors.
-/**
- * Integrates Serwist into your SvelteKit app.
- * @param userOptions
- * @returns
- */ const serwist = (userOptions = {})=>{
+const serwist = (userOptions = {})=>{
     if (!userOptions.integration) userOptions.integration = {};
     userOptions.integration.closeBundleOrder = "pre";
     userOptions.integration.configureOptions = (viteConfig, options)=>configurateSvelteKitOptions(viteConfig, userOptions.kit ?? {}, options);

package/dist/main.js

@@ -8,11 +8,8 @@ import fg from 'fast-glob';
 import assert from 'node:assert';
 
 let enabled = true;
-// Support both browser and node environments
 const globalVar = typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : {};
-/**
- * Detect how much colors the current terminal supports
- */ let supportLevel = 0 /* none */ ;
+let supportLevel = 0;
 if (globalVar.process && globalVar.process.env && globalVar.process.stdout) {
     const { FORCE_COLOR, NODE_DISABLE_COLORS, NO_COLOR, TERM, COLORTERM } = globalVar.process.env;
     if (NODE_DISABLE_COLORS || NO_COLOR || FORCE_COLOR === '0') {
@@ -35,17 +32,15 @@ if (globalVar.process && globalVar.process.env && globalVar.process.stdout) {
         enabled = process.stdout.isTTY;
     }
     if (enabled) {
-        // Windows supports 24bit True Colors since Windows 10 revision #14931,
-        // see https://devblogs.microsoft.com/commandline/24-bit-color-in-the-windows-console/
         if (process.platform === 'win32') {
-            supportLevel = 3 /* trueColor */ ;
+            supportLevel = 3;
         } else {
             if (COLORTERM && (COLORTERM === 'truecolor' || COLORTERM === '24bit')) {
-                supportLevel = 3 /* trueColor */ ;
+                supportLevel = 3;
             } else if (TERM && (TERM.endsWith('-256color') || TERM.endsWith('256'))) {
-                supportLevel = 2 /* ansi256 */ ;
+                supportLevel = 2;
             } else {
-                supportLevel = 1 /* ansi */ ;
+                supportLevel = 1;
             }
         }
     }
@@ -54,7 +49,7 @@ let options = {
     enabled,
     supportLevel
 };
-function kolorist(start, end, level = 1 /* ansi */ ) {
+function kolorist(start, end, level = 1) {
     const open = `\x1b[${start}m`;
     const close = `\x1b[${end}m`;
     const regex = new RegExp(`\\x1b\\[${end}m`, 'g');
@@ -67,7 +62,7 @@ const green = kolorist(32, 39);
 const yellow = kolorist(33, 39);
 const cyan = kolorist(36, 39);
 
-var version = "9.0.0-preview.0";
+var version = "9.0.0-preview.2";
 
 const logSerwistResult = (buildResult, viteOptions)=>{
     const { logLevel = "info" } = viteOptions;
@@ -78,7 +73,6 @@ const logSerwistResult = (buildResult, viteOptions)=>{
             "",
             `${cyan(`@serwist/vite v${version}`)} ${green("files generated.")}`,
             `${green("✓")} ${count} precache entries ${dim(`(${(size / 1024).toFixed(2)} KiB)`)}`,
-            // log build warning
             warnings && warnings.length > 0 ? yellow([
                 "⚠ warnings",
                 ...warnings.map((w)=>`  ${w}`),
@@ -89,12 +83,9 @@ const logSerwistResult = (buildResult, viteOptions)=>{
 };
 
 const loadSerwistBuild = async ()=>{
-    // "@serwist/build" is large and makes config loading slow.
-    // Since it is not always used, we only load this when it is needed.
     try {
         return await import('@serwist/build');
     } catch (_) {
-        // We don't have a default export, don't worry.
         return require("@serwist/build");
     }
 };
@@ -126,7 +117,6 @@ const generateServiceWorker = async (ctx)=>{
             throw new Error("injectManifest failed to generate results. This is likely a bug.");
         }
         const { errors, escapeRegExp, getSourceMapURL, rebasePath, replaceAndUpdateSourceMap, translateURLToSourcemapPaths } = await loadSerwistBuild();
-        // Make sure we leave swSrc and swDest out of the precache manifest.
         for (const file of [
             ctx.options.injectManifest.swSrc,
             ctx.options.injectManifest.swDest
@@ -145,24 +135,16 @@ const generateServiceWorker = async (ctx)=>{
             throw new Error(`${errors["invalid-sw-src"]} ${error instanceof Error && error.message ? error.message : ""}`);
         }
         const injectionResults = swFileContents.match(globalRegexp);
-        // See https://github.com/GoogleChrome/workbox/issues/2230
         if (!injectionResults) {
             throw new Error(`${errors["injection-point-not-found"]} ${injectionPoint}`);
         }
         assert(injectionResults.length === 1, `${errors["multiple-injection-points"]} ${injectionPoint}`);
         const filesToWrite = {};
         const url = getSourceMapURL(swFileContents);
-        // See https://github.com/GoogleChrome/workbox/issues/2957
         const { destPath, srcPath, warning } = translateURLToSourcemapPaths(url, ctx.options.injectManifest.swSrc, ctx.options.injectManifest.swDest);
         if (warning) {
             injectManifestResult.warnings.push(warning);
         }
-        // If our swSrc file contains a sourcemap, we would invalidate that
-        // mapping if we just replaced injectionPoint with the stringified manifest.
-        // Instead, we need to update the swDest contents as well as the sourcemap
-        // (assuming it's a real file, not a data: URL) at the same time.
-        // See https://github.com/GoogleChrome/workbox/issues/2235
-        // and https://github.com/GoogleChrome/workbox/issues/2648
         if (srcPath && destPath) {
             const { map, source } = await replaceAndUpdateSourceMap({
                 originalMap: JSON.parse(await fs.readFile(srcPath, "utf8")),
@@ -174,8 +156,6 @@ const generateServiceWorker = async (ctx)=>{
             filesToWrite[ctx.options.injectManifest.swDest] = source;
             filesToWrite[destPath] = map;
         } else {
-            // If there's no sourcemap associated with swSrc, a simple string
-            // replacement will suffice.
             filesToWrite[ctx.options.injectManifest.swDest] = swFileContents.replace(globalRegexp, injectManifestResult.manifestString);
         }
         for (const [file, contents] of Object.entries(filesToWrite)){
@@ -190,10 +170,6 @@ const generateServiceWorker = async (ctx)=>{
         }
     } else {
         const define = {
-            // Nuxt does some really weird stuff. During the build, they MANUALLY
-            // set browser APIs, such as window, document, location,..., to `undefined`??
-            // Probably some Vue or server stuff. Their `define` doesn't seem to have anything
-            // particularly useful for the service worker anyway, so we don't extend it.
             ...ctx.framework === "nuxt" ? undefined : ctx.viteConfig.define,
             "process.env.NODE_ENV": `"${ctx.options.mode}"`
         };
@@ -206,7 +182,6 @@ const generateServiceWorker = async (ctx)=>{
             root: ctx.viteConfig.root,
             base: ctx.viteConfig.base,
             resolve: ctx.viteConfig.resolve,
-            // Don't copy anything from public folder
             publicDir: false,
             build: {
                 sourcemap: ctx.viteConfig.build.sourcemap,
@@ -247,7 +222,6 @@ const createApi = (ctx)=>{
             const buildResult = await generateServiceWorker(ctx);
             if (buildResult) {
                 if (ctx.viteConfig.isProduction) {
-                    // Log Serwist result
                     logSerwistResult(buildResult, ctx.viteConfig);
                 } else if (buildResult.warnings && buildResult.warnings.length > 0) {
                     console.warn(yellow([
@@ -290,17 +264,7 @@ const resolveBasePath = (base)=>{
 const isAbsolute = (url)=>{
     return url.match(/^(?:[a-z]+:)?\/\//i);
 };
-// Source: https://github.com/sveltejs/kit/blob/6419d3eaa7bf1b0a756b28f06a73f71fe042de0a/packages/kit/src/utils/filesystem.js
-// License: MIT
-/**
- * Internal function used by `@serwist/vite`.
- * Resolves a file path without extension. Also handles `/index` if the path
- * actually points to a directory.
- * @internal
- * @param ctx
- * @param api
- * @returns
- */ const resolveEntry = (entry)=>{
+const resolveEntry = (entry)=>{
     if (fs$1.existsSync(entry)) {
         const stats = fs$1.statSync(entry);
         if (stats.isDirectory()) {
@@ -317,34 +281,12 @@ const isAbsolute = (url)=>{
     }
     return null;
 };
-// Source: https://github.com/sveltejs/kit/blob/6419d3eaa7bf1b0a756b28f06a73f71fe042de0a/packages/kit/src/utils/filesystem.js
-// License: MIT
-/**
- * Internal function used by `@serwist/vite`.
- * Converts a filesystem path to a Vite `@fs` URL.
- * @internal
- * @param ctx
- * @param api
- * @returns
- */ const toFs = (str)=>{
+const toFs = (str)=>{
     str = str.replace(/\\/g, "/");
-    // Windows/Linux separation - Windows starts with a drive letter, we need a / in front there
     return `/@fs${str.startsWith("/") ? "" : "/"}${str}`;
 };
 
-// This plugin handles the service worker in two ways:
-// - If `devOptions.bundle` is enabled, hook a middleware that bundles the service worker
-// through `api.generateSW()` and returns the result into Vite's dev server.
-// - Otherwise, run `injectManifest` and return the service worker through `async load(id)`. Although
-// `precacheEntries` is always `undefined`, we still do this to check the user's `injectManifest` options
-// in dev mode.
-/**
- * Internal dev plugin used by `@serwist/vite`.
- * @internal
- * @param ctx
- * @param api
- * @returns
- */ const devPlugin = (ctx, api)=>{
+const devPlugin = (ctx, api)=>{
     return {
         name: "@serwist/vite:dev",
         apply: "serve",
@@ -408,8 +350,6 @@ const buildManifestEntry = (publicDir, url)=>{
 const lookupAdditionalPrecacheEntries = (serwistOptions)=>{
     return serwistOptions.additionalPrecacheEntries || [];
 };
-// we need to make icons relative, we can have for example icon entries with: /pwa.png
-// fast-glob will not resolve absolute paths
 const normalizeIconPath = (path)=>{
     return path.startsWith("/") ? path.substring(1) : path;
 };
@@ -419,8 +359,6 @@ const configureStaticAssets = async (resolvedPluginOptions, viteConfig)=>{
     const globs = [];
     const manifestEntries = lookupAdditionalPrecacheEntries(injectManifest);
     if (includeAssets) {
-        // we need to make icons relative, we can have for example icon entries with: /pwa.png
-        // fast-glob will not resolve absolute paths
         if (Array.isArray(includeAssets)) globs.push(...includeAssets.map(normalizeIconPath));
         else globs.push(normalizeIconPath(includeAssets));
     }
@@ -430,7 +368,6 @@ const configureStaticAssets = async (resolvedPluginOptions, viteConfig)=>{
             onlyFiles: true,
             unique: true
         });
-        // we also need to remove from the list existing included by the user
         if (manifestEntries.length > 0) {
             const included = manifestEntries.map((me)=>{
                 if (typeof me === "string") return me;
@@ -451,7 +388,6 @@ const configureStaticAssets = async (resolvedPluginOptions, viteConfig)=>{
 const resolveOptions = async (options, viteConfig)=>{
     const { type = "classic", mode = process$1.env.NODE_ENV || "production", injectRegister = "auto", registerType = "prompt", minify = true, base = viteConfig.base, scope: _scope, swUrl = "/sw.js", includeAssets = undefined, useCredentials = false, disable = false, integration = {}, buildBase, devOptions, plugins = [], rollupOptions = {}, rollupFormat = "es", ...injectManifest } = options;
     const basePath = resolveBasePath(base);
-    // check typescript service worker for injectManifest strategy
     const scope = _scope || basePath;
     let assetsDir = slash(viteConfig.build.assetsDir ?? "assets");
     if (assetsDir[assetsDir.length - 1] !== "/") assetsDir += "/";
@@ -460,7 +396,6 @@ const resolveOptions = async (options, viteConfig)=>{
         minify: false,
         ...devOptions
     };
-    // remove './' prefix from assetsDir
     const dontCacheBustURLsMatching = new RegExp(`^${assetsDir.replace(/^\.*?\//, "")}`);
     const { validateViteInjectManifestOptions } = await loadSerwistBuild();
     const validatedInjectManifest = await validateViteInjectManifestOptions(injectManifest);
@@ -493,19 +428,12 @@ const resolveOptions = async (options, viteConfig)=>{
         },
         devOptions: resolvedDevOptions
     };
-    // calculate hash only when required
     const calculateHash = !resolvedPluginOptions.disable && resolvedPluginOptions.includeAssets && viteConfig.command === "build";
     if (calculateHash) await configureStaticAssets(resolvedPluginOptions, viteConfig);
     return resolvedPluginOptions;
 };
 
-/**
- * Internal plugin used by `@serwist/vite`.
- * @internal
- * @param ctx
- * @param api
- * @returns
- */ const mainPlugin = (ctx, api)=>{
+const mainPlugin = (ctx, api)=>{
     return {
         name: "@serwist/vite",
         enforce: "pre",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/vite",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.2",
   "type": "module",
   "description": "A module that integrates Serwist into your Vite application.",
   "files": [
@@ -72,8 +72,8 @@
     "debug": "4.3.4",
     "fast-glob": "3.3.2",
     "pretty-bytes": "6.1.1",
-    "@serwist/build": "9.0.0-preview.0",
-    "@serwist/window": "9.0.0-preview.0"
+    "@serwist/build": "9.0.0-preview.2",
+    "@serwist/window": "9.0.0-preview.2"
   },
   "devDependencies": {
     "@playwright/test": "1.41.2",
@@ -81,7 +81,7 @@
     "@types/debug": "4.1.12",
     "@types/node": "20.11.16",
     "@types/prompts": "2.4.9",
-    "@types/react": "18.2.52",
+    "@types/react": "18.2.54",
     "bumpp": "9.3.0",
     "kolorist": "1.8.0",
     "preact": "10.19.3",
@@ -89,13 +89,13 @@
     "publint": "0.2.7",
     "react": "18.2.0",
     "rollup": "4.9.6",
-    "solid-js": "1.8.12",
-    "svelte": "5.0.0-next.45",
-    "typescript": "5.4.0-dev.20240203",
+    "solid-js": "1.8.14",
+    "svelte": "5.0.0-next.48",
+    "typescript": "5.4.0-dev.20240206",
     "vite": "5.0.12",
     "vue": "3.4.15",
-    "@serwist/constants": "9.0.0-preview.0",
-    "@serwist/sw": "9.0.0-preview.0"
+    "@serwist/constants": "9.0.0-preview.2",
+    "@serwist/sw": "9.0.0-preview.2"
   },
   "peerDependencies": {
     "@sveltejs/kit": "^1.0.0 || ^2.0.0",
@@ -106,7 +106,7 @@
     "typescript": ">=5.0.0",
     "vite": "^5.0.0",
     "vue": "^3.0.0",
-    "@serwist/sw": "9.0.0-preview.0"
+    "@serwist/sw": "9.0.0-preview.2"
   },
   "peerDependenciesMeta": {
     "@serwist/sw": {