@serwist/vite 9.0.0-preview.24 → 9.0.0-preview.25

package/dist/index.js

@@ -7,7 +7,7 @@ import { validationErrorMap, SerwistConfigError } from '@serwist/build/schema';
 import { normalizePath } from 'vite';
 import process from 'node:process';
 
-var version = "9.0.0-preview.24";
+var version = "9.0.0-preview.25";
 
 const logSerwistResult = (buildResult, viteOptions)=>{
     const { logLevel = "info" } = viteOptions;
@@ -257,7 +257,7 @@ const buildPlugin = (ctx, api)=>{
                 }
             }
         },
-        async buildEnd (error) {
+        buildEnd (error) {
             if (error) throw error;
         }
     };
@@ -303,8 +303,8 @@ const devPlugin = (ctx, api)=>{
     };
 };
 
-const INTERNAL_SERWIST_VIRTUAL = "virtual:internal-serwist";
-const RESOLVED_INTERNAL_SERWIST_VIRTUAL = `\0${INTERNAL_SERWIST_VIRTUAL}`;
+const SERWIST_VIRTUAL = "virtual:serwist";
+const RESOLVED_SERWIST_VIRTUAL = `\0${SERWIST_VIRTUAL}`;
 
 const prepareConfigForValidation = (viteConfig, { mode = process.env.NODE_ENV === "production" || process.env.NODE_ENV === "development" ? process.env.NODE_ENV : "production", base = viteConfig.base, scope: _scope, devOptions, ...injectManifest })=>{
     const basePath = resolveBasePath(base);
@@ -361,13 +361,13 @@ const mainPlugin = (ctx, api)=>{
             ctx.options = await resolveOptions(ctx.userOptions, config);
         },
         resolveId (id) {
-            if (id === INTERNAL_SERWIST_VIRTUAL) {
-                return RESOLVED_INTERNAL_SERWIST_VIRTUAL;
+            if (id === SERWIST_VIRTUAL) {
+                return RESOLVED_SERWIST_VIRTUAL;
             }
             return undefined;
         },
         load (id) {
-            if (id === RESOLVED_INTERNAL_SERWIST_VIRTUAL) {
+            if (id === RESOLVED_SERWIST_VIRTUAL) {
                 return `export const swUrl = "${path.posix.join(ctx.options.base, ctx.options.swUrl)}";
 export const swScope = "${ctx.options.scope}";
 export const swType = "${ctx.devEnvironment ? "module" : ctx.options.type}";`;

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

@@ -1 +1 @@
-{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAI9C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,cAAc,EA8GpC,CAAC"}
+{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG9C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,cAAc,EA8GpC,CAAC"}

package/dist/index.worker.js

@@ -1,5 +1,4 @@
-import { ExpirationPlugin } from 'serwist/plugins';
-import { CacheFirst, StaleWhileRevalidate, NetworkFirst } from 'serwist/strategies';
+import { CacheFirst, ExpirationPlugin, StaleWhileRevalidate, NetworkFirst } from 'serwist';
 
 const defaultCache = import.meta.env.DEV ? [] : [
     {

package/dist/lib/constants.d.ts

@@ -1,3 +1,3 @@
-export declare const INTERNAL_SERWIST_VIRTUAL = "virtual:internal-serwist";
-export declare const RESOLVED_INTERNAL_SERWIST_VIRTUAL = "\0virtual:internal-serwist";
+export declare const SERWIST_VIRTUAL = "virtual:serwist";
+export declare const RESOLVED_SERWIST_VIRTUAL = "\0virtual:serwist";
 //# sourceMappingURL=constants.d.ts.map

package/dist/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,6BAA6B,CAAC;AACnE,eAAO,MAAM,iCAAiC,+BAAkC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,oBAAoB,CAAC;AACjD,eAAO,MAAM,wBAAwB,sBAAyB,CAAC"}

package/dist/lib/schema.d.ts

@@ -56,9 +56,9 @@ export declare const injectManifestPartial: z.ZodObject<{
         minify?: boolean | "terser" | "esbuild" | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    scope: string;
     type: "classic" | "module";
     mode: "development" | "production";
+    scope: string;
     base: string;
     disable: boolean;
     integration: {
@@ -75,8 +75,8 @@ export declare const injectManifestPartial: z.ZodObject<{
         minify: boolean | "terser" | "esbuild";
     };
 }, {
-    scope: string;
     mode: "development" | "production";
+    scope: string;
     base: string;
     type?: "classic" | "module" | undefined;
     disable?: boolean | undefined;
@@ -238,9 +238,9 @@ export declare const injectManifestOptions: z.ZodObject<{
         minify?: boolean | "terser" | "esbuild" | undefined;
     }>>;
 }, "strict", z.ZodTypeAny, {
-    scope: string;
     type: "classic" | "module";
     mode: "development" | "production";
+    scope: string;
     base: string;
     disable: boolean;
     integration: {
@@ -297,8 +297,8 @@ export declare const injectManifestOptions: z.ZodObject<{
     modifyURLPrefix?: Record<string, string> | undefined;
     templatedURLs?: Record<string, string | string[]> | undefined;
 }, {
-    scope: string;
     mode: "development" | "production";
+    scope: string;
     base: string;
     swSrc: string;
     swDest: string;

package/dist/lib/types.d.ts

@@ -4,28 +4,34 @@ import type { RollupOptions } from "rollup";
 import type { BuildOptions, Plugin, ResolvedConfig } from "vite";
 export interface InjectPartial {
     /**
-     * The mode in which Serwist should be built.
+     * The mode in which your service worker should be built.
      *
      * @default
      * process.env.NODE_ENV // or "production" if undefined
      */
     mode?: "development" | "production";
     /**
-     * The service worker type.
+     * The module type with which the service worker should be registered. Usually used alongside
+     * `rollupFormat`.
      *
      * @default "classic"
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register#type
      */
     type?: WorkerType;
     /**
-     * The scope with which Serwist should register the service worker.
+     * The service worker's URL scope. Set to `"/foo/"` so that paths under "/foo/"
+     * are under the service worker's control while others are not.
      *
      * @default viteOptions.base
+     * @see https://vitejs.dev/config/shared-options.html#base
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register#scope
      */
     scope?: string;
     /**
      * The base from which Serwist resolves URLs.
      *
      * @default viteOptions.base
+     * @see https://vitejs.dev/config/shared-options.html#base
      */
     base?: string;
     /**
@@ -45,7 +51,7 @@ export interface InjectPartial {
      */
     swUrl?: string;
     /**
-     * Plugins used to build your service worker.
+     * Rollup/Vite plugins used to build the service worker.
      */
     plugins?: Plugin[];
     /**
@@ -71,19 +77,28 @@ export interface InjectManifestOptions extends Omit<BasePartial, "disablePrecach
 export interface InjectManifestOptionsComplete extends BaseResolved, GlobResolved, BaseInjectResolved, RequiredSwDestResolved, RequiredGlobDirectoryResolved, InjectResolved {
 }
 export interface Hooks {
+    /**
+     * Allows you to run some logic before the service worker is built.
+     * @param options
+     * @returns
+     */
     beforeBuildServiceWorker?: (options: PluginOptionsComplete) => void | Promise<void>;
+    /**
+     * Adjusts the application order of `@serwist/vite`'s `closeBundle` hook.
+     */
     closeBundleOrder?: "pre" | "post" | null;
+    /**
+     * Allows you to configure the options of Serwist and Vite. Useful when there is a dependency between the two.
+     * @param viteOptions
+     * @param options
+     * @returns
+     */
     configureOptions?: (viteOptions: ResolvedConfig, options: PluginOptions) => void | Promise<void>;
 }
 export interface DevOptions {
     /**
      * Whether the service worker should be bundled in development mode.
      *
-     * Many browsers still [do not support ES Modules in service workers](https://caniuse.com/mdn-api_serviceworker_ecmascript_modules). However, in development
-     * mode, certain frameworks, such as SvelteKit, do not bundle the service worker. As a result, trying to register that service worker on browsers lacking
-     * support, such as Firefox or Safari, will fail, but doing so on browsers not lacking support will not fail. This option is provided to prevent that from
-     * happening. What the plugin does is intercepting any request to the service worker (requests for `swUrl`) and returning a bundled one.
-     *
      * @default true
      */
     bundle?: boolean;
@@ -99,17 +114,6 @@ export interface PluginOptions extends InjectManifestOptions {
 export interface PluginOptionsComplete extends InjectResolved {
     injectManifest: Omit<InjectManifestOptionsComplete, keyof InjectResolved>;
 }
-export interface ShareTargetFiles {
-    name: string;
-    accept: string | string[];
-}
-type Nothing = {};
-/**
- * type StringLiteralUnion<'maskable'> = 'maskable' | string
- * This has auto completion whereas `'maskable' | string` doesn't
- * Adapted from https://github.com/microsoft/TypeScript/issues/29729
- */
-export type StringLiteralUnion<T extends U, U = string> = T | (U & Nothing);
 export interface SerwistViteApi {
     /**
      * Whether the plugin is disabled.
@@ -123,5 +127,4 @@ export interface SerwistViteApi {
     generateSW(): Promise<void>;
 }
 export type ExtendManifestEntriesHook = (manifestEntries: (string | ManifestEntry)[]) => (string | ManifestEntry)[] | undefined;
-export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,aAAa,IAAI,iBAAiB,EAClC,cAAc,IAAI,kBAAkB,EACpC,aAAa,EACb,4BAA4B,EAC5B,6BAA6B,EAC7B,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAEjE,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,YAAY,CAAC;IACpC;;;;OAIG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,QAAQ,CAAC,CAAC;IAC1D;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,cAAc,CAAC;IACvI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,WAAW,EAAE,yBAAyB,CAAC,EAClD,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa;CAAG;AAEpB,MAAM,WAAW,6BACf,SAAQ,YAAY,EAClB,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,6BAA6B,EAC7B,cAAc;CAAG;AAErB,MAAM,WAAW,KAAK;IACpB,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpF,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IACzC,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClG;AAED,MAAM,WAAW,UAAU;IACzB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;CAAG;AAE/D,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,cAAc,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,cAAc,CAAC,CAAC;CAC3E;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B;AAGD,KAAK,OAAO,GAAG,EAAE,CAAC;AAElB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;AAE5E,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAI3D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,eAAe,EAAE,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,GAAG,SAAS,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,aAAa,IAAI,iBAAiB,EAClC,cAAc,IAAI,kBAAkB,EACpC,aAAa,EACb,4BAA4B,EAC5B,6BAA6B,EAC7B,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAEjE,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,YAAY,CAAC;IACpC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,QAAQ,CAAC,CAAC;IAC1D;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,cAAc,CAAC;IACvI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,WAAW,EAAE,yBAAyB,CAAC,EAClD,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,4BAA4B,EAC5B,aAAa;CAAG;AAEpB,MAAM,WAAW,6BACf,SAAQ,YAAY,EAClB,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,6BAA6B,EAC7B,cAAc;CAAG;AAErB,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpF;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IACzC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClG;AAED,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;CAAG;AAE/D,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,cAAc,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,cAAc,CAAC,CAAC;CAC3E;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAI3D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,eAAe,EAAE,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,EAAE,GAAG,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/vite",
-  "version": "9.0.0-preview.24",
+  "version": "9.0.0-preview.25",
   "type": "module",
   "description": "A module that integrates Serwist into your Vite application.",
   "files": [
@@ -30,22 +30,22 @@
   },
   "author": "antfu <anthonyfu117@hotmail.com>, Serwist's Team",
   "license": "MIT",
-  "repository": "https://gitlab.com/serwist/serwist",
-  "bugs": "https://gitlab.com/serwist/serwist/issues",
+  "repository": "https://github.com/serwist/serwist",
+  "bugs": "https://github.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "sideEffects": false,
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "browser": [
-        "./dist/index.browser.d.ts"
-      ],
       "worker": [
         "./dist/index.worker.d.ts"
       ],
       "schema": [
         "./dist/index.schema.d.ts"
+      ],
+      "typings": [
+        "./typings.d.ts"
       ]
     }
   },
@@ -54,10 +54,6 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./browser": {
-      "types": "./dist/index.browser.d.ts",
-      "default": "./dist/index.browser.js"
-    },
     "./worker": {
       "types": "./dist/index.worker.d.ts",
       "default": "./dist/index.worker.js"
@@ -66,24 +62,27 @@
       "types": "./dist/index.schema.d.ts",
       "default": "./dist/index.schema.js"
     },
+    "./typings": {
+      "types": "./typings.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "dependencies": {
     "glob": "10.3.12",
     "kolorist": "1.8.0",
     "zod": "3.22.4",
-    "@serwist/build": "9.0.0-preview.24",
-    "serwist": "9.0.0-preview.24",
-    "@serwist/window": "9.0.0-preview.24"
+    "@serwist/build": "9.0.0-preview.25",
+    "serwist": "9.0.0-preview.25",
+    "@serwist/window": "9.0.0-preview.25"
   },
   "devDependencies": {
-    "@types/node": "20.12.4",
-    "rollup": "4.14.0",
-    "typescript": "5.5.0-dev.20240404",
+    "@types/node": "20.12.7",
+    "rollup": "4.14.3",
+    "typescript": "5.5.0-dev.20240415",
     "vite": "5.2.8",
-    "@serwist/constants": "9.0.0-preview.24",
-    "serwist": "9.0.0-preview.24",
-    "@serwist/utils": "9.0.0-preview.24"
+    "@serwist/configs": "9.0.0-preview.25",
+    "@serwist/utils": "9.0.0-preview.25",
+    "serwist": "9.0.0-preview.25"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0",

package/src/index.worker.ts

@@ -1,6 +1,5 @@
 import type { RuntimeCaching } from "serwist";
-import { ExpirationPlugin } from "serwist/plugins";
-import { CacheFirst, NetworkFirst, StaleWhileRevalidate } from "serwist/strategies";
+import { CacheFirst, ExpirationPlugin, NetworkFirst, StaleWhileRevalidate } from "serwist";
 
 /**
  * The default, recommended list of caching strategies for applications

package/src/lib/constants.ts

@@ -1,2 +1,2 @@
-export const INTERNAL_SERWIST_VIRTUAL = "virtual:internal-serwist";
-export const RESOLVED_INTERNAL_SERWIST_VIRTUAL = `\0${INTERNAL_SERWIST_VIRTUAL}`;
+export const SERWIST_VIRTUAL = "virtual:serwist";
+export const RESOLVED_SERWIST_VIRTUAL = `\0${SERWIST_VIRTUAL}`;

package/src/lib/types.ts

@@ -17,28 +17,34 @@ import type { BuildOptions, Plugin, ResolvedConfig } from "vite";
 
 export interface InjectPartial {
   /**
-   * The mode in which Serwist should be built.
+   * The mode in which your service worker should be built.
    *
    * @default
    * process.env.NODE_ENV // or "production" if undefined
    */
   mode?: "development" | "production";
   /**
-   * The service worker type.
+   * The module type with which the service worker should be registered. Usually used alongside
+   * `rollupFormat`.
    *
    * @default "classic"
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register#type
    */
   type?: WorkerType;
   /**
-   * The scope with which Serwist should register the service worker.
+   * The service worker's URL scope. Set to `"/foo/"` so that paths under "/foo/"
+   * are under the service worker's control while others are not.
    *
    * @default viteOptions.base
+   * @see https://vitejs.dev/config/shared-options.html#base
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register#scope
    */
   scope?: string;
   /**
    * The base from which Serwist resolves URLs.
    *
    * @default viteOptions.base
+   * @see https://vitejs.dev/config/shared-options.html#base
    */
   base?: string;
   /**
@@ -58,7 +64,7 @@ export interface InjectPartial {
    */
   swUrl?: string;
   /**
-   * Plugins used to build your service worker.
+   * Rollup/Vite plugins used to build the service worker.
    */
   plugins?: Plugin[];
   /**
@@ -98,8 +104,22 @@ export interface InjectManifestOptionsComplete
     InjectResolved {}
 
 export interface Hooks {
+  /**
+   * Allows you to run some logic before the service worker is built.
+   * @param options 
+   * @returns 
+   */
   beforeBuildServiceWorker?: (options: PluginOptionsComplete) => void | Promise<void>;
+  /**
+   * Adjusts the application order of `@serwist/vite`'s `closeBundle` hook.
+   */
   closeBundleOrder?: "pre" | "post" | null;
+  /**
+   * Allows you to configure the options of Serwist and Vite. Useful when there is a dependency between the two.
+   * @param viteOptions 
+   * @param options 
+   * @returns 
+   */
   configureOptions?: (viteOptions: ResolvedConfig, options: PluginOptions) => void | Promise<void>;
 }
 
@@ -107,11 +127,6 @@ export interface DevOptions {
   /**
    * Whether the service worker should be bundled in development mode.
    *
-   * Many browsers still [do not support ES Modules in service workers](https://caniuse.com/mdn-api_serviceworker_ecmascript_modules). However, in development
-   * mode, certain frameworks, such as SvelteKit, do not bundle the service worker. As a result, trying to register that service worker on browsers lacking
-   * support, such as Firefox or Safari, will fail, but doing so on browsers not lacking support will not fail. This option is provided to prevent that from
-   * happening. What the plugin does is intercepting any request to the service worker (requests for `swUrl`) and returning a bundled one.
-   *
    * @default true
    */
   bundle?: boolean;
@@ -129,21 +144,6 @@ export interface PluginOptionsComplete extends InjectResolved {
   injectManifest: Omit<InjectManifestOptionsComplete, keyof InjectResolved>;
 }
 
-export interface ShareTargetFiles {
-  name: string;
-  accept: string | string[];
-}
-
-// biome-ignore lint/complexity/noBannedTypes: We intentionally do this.
-type Nothing = {};
-
-/**
- * type StringLiteralUnion<'maskable'> = 'maskable' | string
- * This has auto completion whereas `'maskable' | string` doesn't
- * Adapted from https://github.com/microsoft/TypeScript/issues/29729
- */
-export type StringLiteralUnion<T extends U, U = string> = T | (U & Nothing);
-
 export interface SerwistViteApi {
   /**
    * Whether the plugin is disabled.

package/src/plugins/build.ts

@@ -24,7 +24,7 @@ export const buildPlugin = (ctx: SerwistViteContext, api: SerwistViteApi) => {
         }
       },
     },
-    async buildEnd(error) {
+    buildEnd(error) {
       if (error) throw error;
     },
   };

package/src/plugins/main.ts

@@ -2,7 +2,7 @@ import path from "node:path";
 
 import type { Plugin, UserConfig } from "vite";
 
-import { INTERNAL_SERWIST_VIRTUAL, RESOLVED_INTERNAL_SERWIST_VIRTUAL } from "../lib/constants.js";
+import { SERWIST_VIRTUAL, RESOLVED_SERWIST_VIRTUAL } from "../lib/constants.js";
 import type { SerwistViteContext } from "../lib/context.js";
 import { resolveOptions } from "../lib/options.js";
 import type { SerwistViteApi } from "../lib/types.js";
@@ -31,13 +31,13 @@ export const mainPlugin = (ctx: SerwistViteContext, api: SerwistViteApi) => {
       ctx.options = await resolveOptions(ctx.userOptions, config);
     },
     resolveId(id) {
-      if (id === INTERNAL_SERWIST_VIRTUAL) {
-        return RESOLVED_INTERNAL_SERWIST_VIRTUAL;
+      if (id === SERWIST_VIRTUAL) {
+        return RESOLVED_SERWIST_VIRTUAL;
       }
       return undefined;
     },
     load(id) {
-      if (id === RESOLVED_INTERNAL_SERWIST_VIRTUAL) {
+      if (id === RESOLVED_SERWIST_VIRTUAL) {
         return `export const swUrl = "${path.posix.join(ctx.options.base, ctx.options.swUrl)}";
 export const swScope = "${ctx.options.scope}";
 export const swType = "${ctx.devEnvironment ? "module" : ctx.options.type}";`;

package/src/rollup.js

@@ -1,5 +1,5 @@
 // @ts-check
-import { getRollupOptions } from "@serwist/constants/rollup";
+import { getRollupOptions } from "@serwist/configs/rollup";
 
 import packageJson from "../package.json" assert { type: "json" };
 
@@ -9,7 +9,6 @@ export default getRollupOptions({
     {
       input: {
         index: "src/index.ts",
-        "index.browser": "src/index.browser.ts",
         "index.worker": "src/index.worker.ts",
         "index.schema": "src/index.schema.ts",
       },
@@ -19,7 +18,6 @@ export default getRollupOptions({
         chunkFileNames: "chunks/[name].js",
         format: "esm",
       },
-      external: ["virtual:internal-serwist"],
     },
   ],
 });

package/dist/index.browser.d.ts

@@ -1,2 +0,0 @@
-export declare const getSerwist: () => Promise<import("@serwist/window").Serwist | undefined>;
-//# sourceMappingURL=index.browser.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU,8DAKtB,CAAC"}

package/dist/index.browser.js

@@ -1,13 +0,0 @@
-import { swUrl, swScope, swType } from 'virtual:internal-serwist';
-
-const getSerwist = async ()=>{
-    if ("serviceWorker" in navigator) {
-        return new (await import('@serwist/window')).Serwist(swUrl, {
-            scope: swScope,
-            type: swType
-        });
-    }
-    return undefined;
-};
-
-export { getSerwist };

package/src/index.browser.ts

@@ -1,8 +0,0 @@
-import { swScope, swType, swUrl } from "virtual:internal-serwist";
-
-export const getSerwist = async () => {
-  if ("serviceWorker" in navigator) {
-    return new (await import("@serwist/window")).Serwist(swUrl, { scope: swScope, type: swType });
-  }
-  return undefined;
-};

package/src/virtual.d.ts

@@ -1,5 +0,0 @@
-declare module "virtual:internal-serwist" {
-  export const swUrl: string;
-  export const swScope: string;
-  export const swType: WorkerType;
-}