@eclipse-docks/extension-pwa 0.7.95 → 0.7.97

package/dist/vite-pwa-plugin.d.ts

@@ -1,10 +1,47 @@
-import { PluginOption } from 'vite';
+import { PluginOption, UserConfig } from 'vite';
+import { RolldownOptions } from 'rolldown';
+/**
+ * JSON-serializable options for the SPA `NavigationRoute` (Workbox). Extra keys are kept for
+ * forward-compatible SW parsing.
+ */
+export type DocksPwaNavigationRouteConfig = {
+    /**
+     * RegExp **sources** for Workbox `denylist` (matched against pathname + search).
+     * Pass `[]` so no paths are denied (SPA shell for all navigations within allowlist).
+     */
+    denylist?: string[];
+    /**
+     * RegExp **sources** for Workbox `allowlist`. Omit to use Workbox’s default (`[/. /]`).
+     * Set when the SPA shell should only apply to a subset of navigations.
+     */
+    allowlist?: string[];
+} & Record<string, unknown>;
+/**
+ * JSON-serializable bundle injected into the service worker (`define`). Add sections here as
+ * the SW gains more build-time tunables; unknown top-level keys are preserved in JSON for
+ * forward-compatible workers.
+ */
+export type DocksPwaServiceWorkerConfig = {
+    /** SPA shell fallback: Workbox `NavigationRoute` for `index.html`. */
+    navigationRoute?: DocksPwaNavigationRouteConfig;
+} & Record<string, unknown>;
 export type CreateDocksPwaPluginOptions = {
     basePath: string;
     appName: string;
     appDescription: string;
     maximumFileSizeToCacheInBytes: number;
     shortName?: string;
+    /**
+     * Serializable object injected into the SW build. No implicit defaults: set `navigationRoute`
+     * (e.g. `denylist`) only when your deployment needs it.
+     */
+    serviceWorkerConfig?: DocksPwaServiceWorkerConfig;
+    /** Extra Vite / Rolldown plugins for the injectManifest service worker build only. */
+    injectManifestBuildPlugins?: {
+        vite?: UserConfig['plugins'];
+        /** Rolldown plugins (Vite 8+). Passed through to vite-plugin-pwa as `buildPlugins.rollup`. */
+        rolldown?: RolldownOptions['plugins'];
+    };
 };
-export declare function createDocksPwaPlugin({ basePath, appName, appDescription, maximumFileSizeToCacheInBytes, shortName, }: CreateDocksPwaPluginOptions): PluginOption;
+export declare function createDocksPwaPlugin({ basePath, appName, appDescription, maximumFileSizeToCacheInBytes, shortName, serviceWorkerConfig, injectManifestBuildPlugins, }: CreateDocksPwaPluginOptions): PluginOption;
 //# sourceMappingURL=vite-pwa-plugin.d.ts.map

package/dist/vite-pwa-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vite-pwa-plugin.d.ts","sourceRoot":"","sources":["../src/vite-pwa-plugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGzC,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAQF,wBAAgB,oBAAoB,CAAC,EACnC,QAAQ,EACR,OAAO,EACP,cAAc,EACd,6BAA6B,EAC7B,SAAmB,GACpB,EAAE,2BAA2B,GAAG,YAAY,CAwC5C"}
+{"version":3,"file":"vite-pwa-plugin.d.ts","sourceRoot":"","sources":["../src/vite-pwa-plugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAShD;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sEAAsE;IACtE,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AA0B5B,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;IAClD,sFAAsF;IACtF,0BAA0B,CAAC,EAAE;QAC3B,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7B,8FAA8F;QAC9F,QAAQ,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;KACvC,CAAC;CACH,CAAC;AAQF,wBAAgB,oBAAoB,CAAC,EACnC,QAAQ,EACR,OAAO,EACP,cAAc,EACd,6BAA6B,EAC7B,SAAmB,EACnB,mBAAmB,EACnB,0BAA0B,GAC3B,EAAE,2BAA2B,GAAG,YAAY,CA0D5C"}

package/dist/vite-pwa-plugin.js

@@ -2,6 +2,21 @@ import { fileURLToPath } from "url";
 import path from "path";
 import { VitePWA } from "vite-plugin-pwa";
 //#region src/vite-pwa-plugin.ts
+function stripUndefinedEntries(obj) {
+	return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== void 0));
+}
+function resolveServiceWorkerConfig(user) {
+	const u = stripUndefinedEntries(user ?? {});
+	const navRaw = u.navigationRoute;
+	const rest = Object.fromEntries(Object.entries(u).filter(([k]) => k !== "navigationRoute"));
+	if (navRaw === void 0) return rest;
+	if (typeof navRaw !== "object" || navRaw === null || Array.isArray(navRaw)) throw new Error("createDocksPwaPlugin.serviceWorkerConfig.navigationRoute must be a plain object");
+	const navigationRoute = stripUndefinedEntries(navRaw);
+	return {
+		...rest,
+		navigationRoute
+	};
+}
 var DEFAULT_GLOB_PATTERNS = ["**/*.{js,css,html,ico,png,svg,webp,woff2,woff,ttf,wasm}"];
 var DEFAULT_ASSETS = [
 	"favicon.svg",
@@ -11,7 +26,8 @@ var DEFAULT_ASSETS = [
 var pwaSwPath = fileURLToPath(import.meta.resolve("@eclipse-docks/extension-pwa/sw"));
 var pwaSwDir = path.dirname(pwaSwPath);
 var pwaSwFilename = path.basename(pwaSwPath);
-function createDocksPwaPlugin({ basePath, appName, appDescription, maximumFileSizeToCacheInBytes, shortName = appName }) {
+function createDocksPwaPlugin({ basePath, appName, appDescription, maximumFileSizeToCacheInBytes, shortName = appName, serviceWorkerConfig, injectManifestBuildPlugins }) {
+	const resolvedSwConfig = resolveServiceWorkerConfig(serviceWorkerConfig);
 	return VitePWA({
 		registerType: "autoUpdate",
 		injectRegister: "inline",
@@ -42,7 +58,16 @@ function createDocksPwaPlugin({ basePath, appName, appDescription, maximumFileSi
 		includeAssets: DEFAULT_ASSETS,
 		injectManifest: {
 			maximumFileSizeToCacheInBytes,
-			globPatterns: DEFAULT_GLOB_PATTERNS
+			globPatterns: DEFAULT_GLOB_PATTERNS,
+			buildPlugins: {
+				vite: [{
+					name: "docks-pwa-sw-injected-config",
+					config() {
+						return { define: { __DOCKS_SW_INJECTED_CONFIG__: JSON.stringify(resolvedSwConfig) } };
+					}
+				}, ...injectManifestBuildPlugins?.vite ?? []],
+				rollup: injectManifestBuildPlugins?.rolldown
+			}
 		},
 		devOptions: { enabled: false }
 	});

package/dist/vite-pwa-plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"vite-pwa-plugin.js","names":[],"sources":["../src/vite-pwa-plugin.ts"],"sourcesContent":["import { fileURLToPath } from 'url';\nimport path from 'path';\nimport type { PluginOption } from 'vite';\nimport { VitePWA } from 'vite-plugin-pwa';\n\nexport type CreateDocksPwaPluginOptions = {\n  basePath: string;\n  appName: string;\n  appDescription: string;\n  maximumFileSizeToCacheInBytes: number;\n  shortName?: string;\n};\n\nconst DEFAULT_GLOB_PATTERNS = ['**/*.{js,css,html,ico,png,svg,webp,woff2,woff,ttf,wasm}'];\nconst DEFAULT_ASSETS = ['favicon.svg', 'logo.svg', 'logo-loading.svg'];\nconst pwaSwPath = fileURLToPath(import.meta.resolve('@eclipse-docks/extension-pwa/sw'));\nconst pwaSwDir = path.dirname(pwaSwPath);\nconst pwaSwFilename = path.basename(pwaSwPath);\n\nexport function createDocksPwaPlugin({\n  basePath,\n  appName,\n  appDescription,\n  maximumFileSizeToCacheInBytes,\n  shortName = appName,\n}: CreateDocksPwaPluginOptions): PluginOption {\n  return VitePWA({\n    registerType: 'autoUpdate',\n    injectRegister: 'inline',\n    strategies: 'injectManifest',\n    srcDir: pwaSwDir,\n    filename: pwaSwFilename,\n    manifest: {\n      name: appName,\n      short_name: shortName,\n      description: appDescription,\n      theme_color: '#1a1a1a',\n      background_color: '#1a1a1a',\n      display: 'standalone',\n      start_url: basePath,\n      scope: basePath,\n      icons: [\n        {\n          src: 'logo.svg',\n          sizes: 'any',\n          type: 'image/svg+xml',\n          purpose: 'any',\n        },\n        {\n          src: 'favicon.svg',\n          sizes: 'any',\n          type: 'image/svg+xml',\n          purpose: 'monochrome',\n        },\n      ],\n    },\n    includeAssets: DEFAULT_ASSETS,\n    injectManifest: {\n      maximumFileSizeToCacheInBytes,\n      globPatterns: DEFAULT_GLOB_PATTERNS,\n    },\n    devOptions: {\n      enabled: false,\n    },\n  });\n}\n"],"mappings":";;;;AAaA,IAAM,wBAAwB,CAAC,0DAA0D;AACzF,IAAM,iBAAiB;CAAC;CAAe;CAAY;CAAmB;AACtE,IAAM,YAAY,cAAc,OAAO,KAAK,QAAQ,kCAAkC,CAAC;AACvF,IAAM,WAAW,KAAK,QAAQ,UAAU;AACxC,IAAM,gBAAgB,KAAK,SAAS,UAAU;AAE9C,SAAgB,qBAAqB,EACnC,UACA,SACA,gBACA,+BACA,YAAY,WACgC;AAC5C,QAAO,QAAQ;EACb,cAAc;EACd,gBAAgB;EAChB,YAAY;EACZ,QAAQ;EACR,UAAU;EACV,UAAU;GACR,MAAM;GACN,YAAY;GACZ,aAAa;GACb,aAAa;GACb,kBAAkB;GAClB,SAAS;GACT,WAAW;GACX,OAAO;GACP,OAAO,CACL;IACE,KAAK;IACL,OAAO;IACP,MAAM;IACN,SAAS;IACV,EACD;IACE,KAAK;IACL,OAAO;IACP,MAAM;IACN,SAAS;IACV,CACF;GACF;EACD,eAAe;EACf,gBAAgB;GACd;GACA,cAAc;GACf;EACD,YAAY,EACV,SAAS,OACV;EACF,CAAC"}
+{"version":3,"file":"vite-pwa-plugin.js","names":[],"sources":["../src/vite-pwa-plugin.ts"],"sourcesContent":["import { fileURLToPath } from 'url';\nimport path from 'path';\nimport type { PluginOption, UserConfig } from 'vite';\nimport type { RolldownOptions } from 'rolldown';\nimport { VitePWA } from 'vite-plugin-pwa';\nimport type { CustomInjectManifestOptions } from 'vite-plugin-pwa';\n\n/** vite-plugin-pwa still names this `rollup`; Vite 8’s SW build uses Rolldown. */\ntype VitePwaInjectManifestRollupPlugins = NonNullable<\n  NonNullable<CustomInjectManifestOptions['buildPlugins']>['rollup']\n>;\n\n/**\n * JSON-serializable options for the SPA `NavigationRoute` (Workbox). Extra keys are kept for\n * forward-compatible SW parsing.\n */\nexport type DocksPwaNavigationRouteConfig = {\n  /**\n   * RegExp **sources** for Workbox `denylist` (matched against pathname + search).\n   * Pass `[]` so no paths are denied (SPA shell for all navigations within allowlist).\n   */\n  denylist?: string[];\n  /**\n   * RegExp **sources** for Workbox `allowlist`. Omit to use Workbox’s default (`[/. /]`).\n   * Set when the SPA shell should only apply to a subset of navigations.\n   */\n  allowlist?: string[];\n} & Record<string, unknown>;\n\n/**\n * JSON-serializable bundle injected into the service worker (`define`). Add sections here as\n * the SW gains more build-time tunables; unknown top-level keys are preserved in JSON for\n * forward-compatible workers.\n */\nexport type DocksPwaServiceWorkerConfig = {\n  /** SPA shell fallback: Workbox `NavigationRoute` for `index.html`. */\n  navigationRoute?: DocksPwaNavigationRouteConfig;\n} & Record<string, unknown>;\n\nfunction stripUndefinedEntries<T extends Record<string, unknown>>(obj: T): Record<string, unknown> {\n  return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== undefined));\n}\n\nfunction resolveServiceWorkerConfig(user?: DocksPwaServiceWorkerConfig): DocksPwaServiceWorkerConfig {\n  const u = stripUndefinedEntries((user ?? {}) as Record<string, unknown>);\n  const navRaw = u.navigationRoute;\n  const rest = Object.fromEntries(Object.entries(u).filter(([k]) => k !== 'navigationRoute'));\n\n  if (navRaw === undefined) {\n    return rest as DocksPwaServiceWorkerConfig;\n  }\n  if (typeof navRaw !== 'object' || navRaw === null || Array.isArray(navRaw)) {\n    throw new Error('createDocksPwaPlugin.serviceWorkerConfig.navigationRoute must be a plain object');\n  }\n\n  const navigationRoute = stripUndefinedEntries(navRaw as Record<string, unknown>) as DocksPwaNavigationRouteConfig;\n\n  return {\n    ...rest,\n    navigationRoute,\n  } as DocksPwaServiceWorkerConfig;\n}\n\nexport type CreateDocksPwaPluginOptions = {\n  basePath: string;\n  appName: string;\n  appDescription: string;\n  maximumFileSizeToCacheInBytes: number;\n  shortName?: string;\n  /**\n   * Serializable object injected into the SW build. No implicit defaults: set `navigationRoute`\n   * (e.g. `denylist`) only when your deployment needs it.\n   */\n  serviceWorkerConfig?: DocksPwaServiceWorkerConfig;\n  /** Extra Vite / Rolldown plugins for the injectManifest service worker build only. */\n  injectManifestBuildPlugins?: {\n    vite?: UserConfig['plugins'];\n    /** Rolldown plugins (Vite 8+). Passed through to vite-plugin-pwa as `buildPlugins.rollup`. */\n    rolldown?: RolldownOptions['plugins'];\n  };\n};\n\nconst DEFAULT_GLOB_PATTERNS = ['**/*.{js,css,html,ico,png,svg,webp,woff2,woff,ttf,wasm}'];\nconst DEFAULT_ASSETS = ['favicon.svg', 'logo.svg', 'logo-loading.svg'];\nconst pwaSwPath = fileURLToPath(import.meta.resolve('@eclipse-docks/extension-pwa/sw'));\nconst pwaSwDir = path.dirname(pwaSwPath);\nconst pwaSwFilename = path.basename(pwaSwPath);\n\nexport function createDocksPwaPlugin({\n  basePath,\n  appName,\n  appDescription,\n  maximumFileSizeToCacheInBytes,\n  shortName = appName,\n  serviceWorkerConfig,\n  injectManifestBuildPlugins,\n}: CreateDocksPwaPluginOptions): PluginOption {\n  const resolvedSwConfig = resolveServiceWorkerConfig(serviceWorkerConfig);\n\n  return VitePWA({\n    registerType: 'autoUpdate',\n    injectRegister: 'inline',\n    strategies: 'injectManifest',\n    srcDir: pwaSwDir,\n    filename: pwaSwFilename,\n    manifest: {\n      name: appName,\n      short_name: shortName,\n      description: appDescription,\n      theme_color: '#1a1a1a',\n      background_color: '#1a1a1a',\n      display: 'standalone',\n      start_url: basePath,\n      scope: basePath,\n      icons: [\n        {\n          src: 'logo.svg',\n          sizes: 'any',\n          type: 'image/svg+xml',\n          purpose: 'any',\n        },\n        {\n          src: 'favicon.svg',\n          sizes: 'any',\n          type: 'image/svg+xml',\n          purpose: 'monochrome',\n        },\n      ],\n    },\n    includeAssets: DEFAULT_ASSETS,\n    injectManifest: {\n      maximumFileSizeToCacheInBytes,\n      globPatterns: DEFAULT_GLOB_PATTERNS,\n      buildPlugins: {\n        vite: [\n          {\n            name: 'docks-pwa-sw-injected-config',\n            config() {\n              return {\n                define: {\n                  __DOCKS_SW_INJECTED_CONFIG__: JSON.stringify(resolvedSwConfig),\n                },\n              };\n            },\n          },\n          ...(injectManifestBuildPlugins?.vite ?? []),\n        ],\n        rollup: injectManifestBuildPlugins?.rolldown as VitePwaInjectManifestRollupPlugins,\n      },\n    },\n    devOptions: {\n      enabled: false,\n    },\n  });\n}\n"],"mappings":";;;;AAuCA,SAAS,sBAAyD,KAAiC;AACjG,QAAO,OAAO,YAAY,OAAO,QAAQ,IAAI,CAAC,QAAQ,GAAG,OAAO,MAAM,KAAA,EAAU,CAAC;;AAGnF,SAAS,2BAA2B,MAAiE;CACnG,MAAM,IAAI,sBAAuB,QAAQ,EAAE,CAA6B;CACxE,MAAM,SAAS,EAAE;CACjB,MAAM,OAAO,OAAO,YAAY,OAAO,QAAQ,EAAE,CAAC,QAAQ,CAAC,OAAO,MAAM,kBAAkB,CAAC;AAE3F,KAAI,WAAW,KAAA,EACb,QAAO;AAET,KAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,MAAM,QAAQ,OAAO,CACxE,OAAM,IAAI,MAAM,kFAAkF;CAGpG,MAAM,kBAAkB,sBAAsB,OAAkC;AAEhF,QAAO;EACL,GAAG;EACH;EACD;;AAsBH,IAAM,wBAAwB,CAAC,0DAA0D;AACzF,IAAM,iBAAiB;CAAC;CAAe;CAAY;CAAmB;AACtE,IAAM,YAAY,cAAc,OAAO,KAAK,QAAQ,kCAAkC,CAAC;AACvF,IAAM,WAAW,KAAK,QAAQ,UAAU;AACxC,IAAM,gBAAgB,KAAK,SAAS,UAAU;AAE9C,SAAgB,qBAAqB,EACnC,UACA,SACA,gBACA,+BACA,YAAY,SACZ,qBACA,8BAC4C;CAC5C,MAAM,mBAAmB,2BAA2B,oBAAoB;AAExE,QAAO,QAAQ;EACb,cAAc;EACd,gBAAgB;EAChB,YAAY;EACZ,QAAQ;EACR,UAAU;EACV,UAAU;GACR,MAAM;GACN,YAAY;GACZ,aAAa;GACb,aAAa;GACb,kBAAkB;GAClB,SAAS;GACT,WAAW;GACX,OAAO;GACP,OAAO,CACL;IACE,KAAK;IACL,OAAO;IACP,MAAM;IACN,SAAS;IACV,EACD;IACE,KAAK;IACL,OAAO;IACP,MAAM;IACN,SAAS;IACV,CACF;GACF;EACD,eAAe;EACf,gBAAgB;GACd;GACA,cAAc;GACd,cAAc;IACZ,MAAM,CACJ;KACE,MAAM;KACN,SAAS;AACP,aAAO,EACL,QAAQ,EACN,8BAA8B,KAAK,UAAU,iBAAiB,EAC/D,EACF;;KAEJ,EACD,GAAI,4BAA4B,QAAQ,EAAE,CAC3C;IACD,QAAQ,4BAA4B;IACrC;GACF;EACD,YAAY,EACV,SAAS,OACV;EACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-docks/extension-pwa",
-  "version": "0.7.95",
+  "version": "0.7.97",
   "type": "module",
   "main": "./dist/index.js",
   "exports": {
@@ -21,6 +21,7 @@
     "vite-plugin-pwa": "^1.2.0"
   },
   "devDependencies": {
+    "rolldown": "1.0.0-rc.15",
     "typescript": "^6.0.0",
     "vite": "^8.0.0",
     "vite-plugin-dts": "^4.5.4"

package/src/sw.ts

@@ -83,8 +83,41 @@ addPlugins([
 
 precacheAndRoute(PRECACHE_MANIFEST);
 
+/** Injected by `createDocksPwaPlugin` for the SW build only (JSON: `DocksPwaServiceWorkerConfig`). */
+declare const __DOCKS_SW_INJECTED_CONFIG__: Readonly<Record<string, unknown>>;
+
+function recordOrEmpty(value: unknown, path: string): Record<string, unknown> {
+  if (value === undefined) {
+    return {};
+  }
+  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+    throw new Error(`Docks PWA SW: "${path}" must be a plain object`);
+  }
+  return value as Record<string, unknown>;
+}
+
+function regexpSourcesFromNavConfig(config: Readonly<Record<string, unknown>>, key: string): RegExp[] {
+  const raw = config[key];
+  if (raw === undefined) {
+    return [];
+  }
+  if (!Array.isArray(raw) || !raw.every((x): x is string => typeof x === 'string')) {
+    throw new Error(`Docks PWA SW: navigationRoute.${key} must be string[]`);
+  }
+  return raw.map((s) => new RegExp(s));
+}
+
+const swCfg = __DOCKS_SW_INJECTED_CONFIG__;
 const indexUrl = new URL('index.html', self.registration.scope).href;
-registerRoute(new NavigationRoute(createHandlerBoundToURL(indexUrl)));
+const navCfg = recordOrEmpty(swCfg.navigationRoute, 'navigationRoute');
+const denylist = regexpSourcesFromNavConfig(navCfg, 'denylist');
+const allowlist = regexpSourcesFromNavConfig(navCfg, 'allowlist');
+registerRoute(
+  new NavigationRoute(createHandlerBoundToURL(indexUrl), {
+    ...(allowlist.length > 0 ? { allowlist } : {}),
+    denylist,
+  }),
+);
 
 self.addEventListener('message', (event) => {
   if (event.data?.type === 'SKIP_WAITING') {