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

package/src/index.schema.ts

@@ -0,0 +1,3 @@
+import { devOptions, hooks, injectManifestOptions, injectManifestPartial } from "./lib/schema.js";
+
+export { hooks, devOptions, injectManifestPartial, injectManifestOptions };

package/src/index.ts

@@ -1,12 +1,13 @@
 import type { Plugin } from "vite";
 
-import { createApi } from "./api.js";
-import { createContext } from "./context.js";
+import { createApi } from "./lib/api.js";
+import { createContext } from "./lib/context.js";
+import type { DevOptions, ExtendManifestEntriesHook, Hooks, PluginOptions, PluginOptionsComplete, SerwistViteApi } from "./lib/types.js";
+import { resolveEntry, toFs } from "./lib/utils.js";
+import { validateInjectManifestOptions } from "./lib/validator.js";
 import { buildPlugin } from "./plugins/build.js";
 import { devPlugin } from "./plugins/dev.js";
 import { mainPlugin } from "./plugins/main.js";
-import type { PluginOptions } from "./types.js";
-import { resolveEntry, toFs } from "./utils.js";
 
 /**
  * Integrates Serwist into your Vite app.
@@ -20,6 +21,6 @@ export const serwist = (userOptions: PluginOptions): Plugin[] => {
 };
 
 // This allows for customization.
-export { buildPlugin as build, createApi, createContext, devPlugin as dev, mainPlugin as main, resolveEntry, toFs };
-export type { SerwistViteContext } from "./context.js";
-export * from "./types.js";
+export { buildPlugin as build, createApi, createContext, devPlugin as dev, mainPlugin as main, resolveEntry, toFs, validateInjectManifestOptions };
+export type { SerwistViteContext } from "./lib/context.js";
+export type { PluginOptions, PluginOptionsComplete, Hooks, ExtendManifestEntriesHook, DevOptions, SerwistViteApi };

package/src/{context.ts → lib/context.ts}

@@ -1,6 +1,6 @@
 import type { ResolvedConfig } from "vite";
 
-import type { PluginOptions, ResolvedPluginOptions } from "./types.js";
+import type { PluginOptions, PluginOptionsComplete } from "./types.js";
 
 export type SerwistViteFrameworks = "nuxt";
 
@@ -21,7 +21,7 @@ export interface SerwistViteContext {
    * Note: this is different from `userOptions` in that it has been parsed, whereas
    * `userOptions` is the raw configuration that the user provides us.
    */
-  options: ResolvedPluginOptions;
+  options: PluginOptionsComplete;
   useImportRegister: boolean;
   /**
    * Is the plugin running on dev?

package/src/{log.ts → lib/log.ts}

@@ -2,7 +2,7 @@ import type { BuildResult } from "@serwist/build";
 import { cyan, dim, green, yellow } from "kolorist";
 import type { ResolvedConfig } from "vite";
 
-import { version } from "../package.json";
+import { version } from "../../package.json";
 
 export const logSerwistResult = (buildResult: Pick<BuildResult, "count" | "size" | "warnings">, viteOptions: ResolvedConfig) => {
   const { logLevel = "info" } = viteOptions;

package/src/{modules.ts → lib/modules.ts}

@@ -21,9 +21,8 @@ interface BuildResult extends SerwistBuild.GetManifestResult {
   manifestString: string;
 }
 
-export const injectManifest = async (config: SerwistBuild.ViteInjectManifestOptions): Promise<BuildResult> => {
-  const { validateViteInjectManifestOptions, getFileManifestEntries, stringify } = await loadSerwistBuild();
-  const options = await validateViteInjectManifestOptions(config);
+export const injectManifest = async (options: SerwistBuild.GetManifestOptions): Promise<BuildResult> => {
+  const { getFileManifestEntries, stringify } = await loadSerwistBuild();
   const { count, size, manifestEntries, warnings } = await getFileManifestEntries(options);
   const manifestString = manifestEntries === undefined ? "undefined" : stringify(manifestEntries);
   return {
@@ -36,7 +35,7 @@ export const injectManifest = async (config: SerwistBuild.ViteInjectManifestOpti
 };
 
 export const generateServiceWorker = async (ctx: SerwistViteContext) => {
-  const { format, plugins, rollupOptions } = ctx.options.injectManifestRollupOptions;
+  const { plugins, rollupOptions, rollupFormat } = ctx.options;
 
   const parsedSwDest = path.parse(ctx.options.injectManifest.swDest);
 
@@ -152,7 +151,7 @@ export const generateServiceWorker = async (ctx: SerwistViteContext) => {
         lib: {
           entry: ctx.options.injectManifest.swSrc,
           name: "app",
-          formats: [format],
+          formats: [rollupFormat],
         },
         rollupOptions: {
           ...rollupOptions,

package/src/lib/options.ts

@@ -0,0 +1,76 @@
+import path from "node:path";
+import process from "node:process";
+
+import type { ResolvedConfig } from "vite";
+
+import type { PluginOptions, PluginOptionsComplete } from "./types.js";
+import { resolveBasePath, slash } from "./utils.js";
+import { validateInjectManifestOptions } from "./validator.js";
+
+const prepareConfigForValidation = (
+  viteConfig: ResolvedConfig,
+  {
+    mode = process.env.NODE_ENV === "production" || process.env.NODE_ENV === "development" ? process.env.NODE_ENV : "production",
+    base = viteConfig.base,
+    scope: _scope,
+    devOptions,
+    ...injectManifest
+  }: PluginOptions,
+) => {
+  const basePath = resolveBasePath(base);
+  return {
+    mode,
+    base: basePath,
+    scope: _scope || basePath,
+    devOptions,
+    ...injectManifest,
+  };
+};
+
+export const resolveOptions = async (options: PluginOptions, viteConfig: ResolvedConfig): Promise<PluginOptionsComplete> => {
+  const {
+    mode,
+    type,
+    scope,
+    base,
+    disable,
+    integration,
+    swUrl,
+    swSrc,
+    swDest,
+    plugins,
+    rollupFormat,
+    rollupOptions,
+    devOptions,
+    ...userInjectManifest
+  } = await validateInjectManifestOptions(prepareConfigForValidation(viteConfig, options));
+
+  let assetsDir = slash(viteConfig.build.assetsDir ?? "assets");
+  if (assetsDir[assetsDir.length - 1] !== "/") assetsDir += "/";
+
+  // remove './' prefix from assetsDir
+  const dontCacheBustURLsMatching = new RegExp(`^${assetsDir.replace(/^\.*?\//, "")}`);
+
+  const resolvedPluginOptions = {
+    mode,
+    type,
+    scope,
+    base,
+    disable,
+    integration,
+    swUrl,
+    plugins,
+    rollupFormat,
+    rollupOptions,
+    devOptions,
+    injectManifest: {
+      dontCacheBustURLsMatching,
+      ...userInjectManifest,
+      swSrc: path.resolve(viteConfig.root, swSrc),
+      swDest: path.resolve(viteConfig.root, viteConfig.build.outDir, swDest),
+      disablePrecacheManifest: !viteConfig.isProduction,
+    },
+  } satisfies PluginOptionsComplete;
+
+  return resolvedPluginOptions;
+};

package/src/lib/schema.ts

@@ -0,0 +1,35 @@
+import { basePartial, globPartial, injectPartial, requiredGlobDirectoryPartial, requiredSwDestPartial } from "@serwist/build/schema";
+import { z } from "zod";
+
+export const hooks = z.object({
+  beforeBuildServiceWorker: z.function(z.tuple([z.any()]), z.union([z.promise(z.void()), z.void()])).optional(),
+  closeBundleOrder: z.union([z.literal("pre"), z.literal("post"), z.null()]).optional(),
+  configureOptions: z.function(z.tuple([z.any(), z.any()]), z.union([z.promise(z.void()), z.void()])).optional(),
+});
+
+export const devOptions = z.object({
+  bundle: z.boolean().default(true),
+  minify: z.union([z.boolean(), z.literal("terser"), z.literal("esbuild")]).default(false),
+});
+
+export const injectManifestPartial = z.object({
+  mode: z.union([z.literal("development"), z.literal("production")]),
+  type: z.union([z.literal("classic"), z.literal("module")]).default("classic"),
+  scope: z.string(),
+  base: z.string(),
+  disable: z.boolean().default(false),
+  integration: hooks.default({}),
+  swUrl: z.string().default("/sw.js"),
+  plugins: z.array(z.any()).default([]),
+  rollupFormat: z.union([z.literal("es"), z.literal("iife")]).default("es"),
+  rollupOptions: z.record(z.string(), z.any()).default({}),
+  devOptions: devOptions.default({}),
+});
+
+export const injectManifestOptions = basePartial
+  .merge(globPartial)
+  .merge(injectPartial)
+  .merge(requiredSwDestPartial)
+  .merge(requiredGlobDirectoryPartial)
+  .merge(injectManifestPartial)
+  .strict("Do not pass invalid properties to InjectManifestOptions!");

package/src/lib/types.ts

@@ -0,0 +1,163 @@
+import type {
+  BasePartial,
+  BaseResolved,
+  GlobPartial,
+  GlobResolved,
+  InjectPartial as BaseInjectPartial,
+  InjectResolved as BaseInjectResolved,
+  ManifestEntry,
+  RequiredGlobDirectoryPartial,
+  RequiredGlobDirectoryResolved,
+  RequiredSwDestPartial,
+  RequiredSwDestResolved,
+} from "@serwist/build";
+import type { Require } from "@serwist/utils";
+import type { RollupOptions } from "rollup";
+import type { BuildOptions, Plugin, ResolvedConfig } from "vite";
+
+export interface InjectPartial {
+  /**
+   * The mode in which Serwist should be built.
+   *
+   * @default
+   * process.env.NODE_ENV // or "production" if undefined
+   */
+  mode?: "development" | "production";
+  /**
+   * The service worker type.
+   *
+   * @default "classic"
+   */
+  type?: WorkerType;
+  /**
+   * The scope with which Serwist should register the service worker.
+   *
+   * @default viteOptions.base
+   */
+  scope?: string;
+  /**
+   * The base from which Serwist resolves URLs.
+   *
+   * @default viteOptions.base
+   */
+  base?: string;
+  /**
+   * Whether Serwist should be disabled.
+   *
+   * @default false
+   */
+  disable?: boolean;
+  /**
+   * Hooks of the build lifecycle.
+   */
+  integration?: Hooks;
+  /**
+   * The URL to the service worker.
+   *
+   * @default "/sw.js"
+   */
+  swUrl?: string;
+  /**
+   * Plugins used to build your service worker.
+   */
+  plugins?: Plugin[];
+  /**
+   * The format used to build the service worker.
+   *
+   * @default "es"
+   */
+  rollupFormat?: "es" | "iife";
+  /**
+   * Custom Rollup options used to build the service worker.
+   */
+  rollupOptions?: Omit<RollupOptions, "plugins" | "output">;
+  /**
+   * Development-specific options.
+   */
+  devOptions?: DevOptions;
+}
+
+export interface InjectResolved extends Require<InjectPartial, "mode" | "type" | "scope" | "base" | "disable" | "swUrl" | "rollupFormat"> {
+  devOptions: Required<DevOptions>;
+}
+
+export interface InjectManifestOptions
+  extends Omit<BasePartial, "disablePrecacheManifest">,
+    GlobPartial,
+    BaseInjectPartial,
+    RequiredSwDestPartial,
+    RequiredGlobDirectoryPartial,
+    InjectPartial {}
+
+export interface InjectManifestOptionsComplete
+  extends BaseResolved,
+    GlobResolved,
+    BaseInjectResolved,
+    RequiredSwDestResolved,
+    RequiredGlobDirectoryResolved,
+    InjectResolved {}
+
+export interface Hooks {
+  beforeBuildServiceWorker?: (options: PluginOptionsComplete) => void | Promise<void>;
+  closeBundleOrder?: "pre" | "post" | null;
+  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;
+  /**
+   * Whether the service worker should be minified in development mode.
+   *
+   * @default false
+   */
+  minify?: BuildOptions["minify"];
+}
+
+export interface PluginOptions extends InjectManifestOptions {}
+
+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.
+   */
+  disabled: boolean;
+  /**
+   * Extends the precache manifest.
+   * @param fn
+   */
+  extendManifestEntries(fn: ExtendManifestEntriesHook): void;
+  /*
+   * Generates the service worker.
+   */
+  generateSW(): Promise<void>;
+}
+
+export type ExtendManifestEntriesHook = (manifestEntries: (string | ManifestEntry)[]) => (string | ManifestEntry)[] | undefined;

package/src/lib/validator.ts

@@ -0,0 +1,10 @@
+import { SerwistConfigError, validationErrorMap } from "@serwist/build/schema";
+import type { InjectManifestOptionsComplete } from "./types.js";
+
+export const validateInjectManifestOptions = async (input: unknown): Promise<InjectManifestOptionsComplete> => {
+  const result = await (await import("./schema.js")).injectManifestOptions.spa(input, { errorMap: validationErrorMap });
+  if (!result.success) {
+    throw new SerwistConfigError({ moduleName: "@serwist/vite", message: JSON.stringify(result.error.format(), null, 2) });
+  }
+  return result.data;
+};

package/src/plugins/build.ts

@@ -1,7 +1,7 @@
 import type { Plugin } from "vite";
 
-import type { SerwistViteContext } from "../context.js";
-import type { SerwistViteApi } from "../types.js";
+import type { SerwistViteContext } from "../lib/context.js";
+import type { SerwistViteApi } from "../lib/types.js";
 
 /**
  * Internal build plugin used by `@serwist/vite`.

package/src/plugins/dev.ts

@@ -3,9 +3,9 @@ import path from "node:path";
 
 import { type Plugin, normalizePath } from "vite";
 
-import type { SerwistViteContext } from "../context.js";
-import type { SerwistViteApi } from "../types.js";
-import { toFs } from "../utils.js";
+import type { SerwistViteContext } from "../lib/context.js";
+import type { SerwistViteApi } from "../lib/types.js";
+import { toFs } from "../lib/utils.js";
 
 // This plugin handles the service worker in two ways:
 // - If `devOptions.bundle` is enabled, hook a middleware that bundles the service worker

package/src/plugins/main.ts

@@ -2,10 +2,10 @@ import path from "node:path";
 
 import type { Plugin, UserConfig } from "vite";
 
-import { INTERNAL_SERWIST_VIRTUAL, RESOLVED_INTERNAL_SERWIST_VIRTUAL } from "../constants.js";
-import type { SerwistViteContext } from "../context.js";
-import { resolveOptions } from "../options.js";
-import type { SerwistViteApi } from "../types.js";
+import { INTERNAL_SERWIST_VIRTUAL, RESOLVED_INTERNAL_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";
 
 /**
  * Internal plugin used by `@serwist/vite`.
@@ -38,7 +38,7 @@ export const mainPlugin = (ctx: SerwistViteContext, api: SerwistViteApi) => {
     },
     load(id) {
       if (id === RESOLVED_INTERNAL_SERWIST_VIRTUAL) {
-        return `export const swUrl = "${path.posix.join(ctx.options.buildBase, ctx.options.swUrl)}";
+        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

@@ -11,12 +11,13 @@ export default getRollupOptions({
         index: "src/index.ts",
         "index.browser": "src/index.browser.ts",
         "index.worker": "src/index.worker.ts",
+        "index.schema": "src/index.schema.ts",
       },
       output: {
         dir: "dist",
-        format: "esm",
         entryFileNames: "[name].js",
-        chunkFileNames: "[name].js",
+        chunkFileNames: "chunks/[name].js",
+        format: "esm",
       },
       external: ["virtual:internal-serwist"],
     },

package/dist/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGvD,OAAO,KAAK,EAA6B,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5E,eAAO,MAAM,SAAS,QAAS,kBAAkB,KAAG,cA8BnD,CAAC"}

package/dist/assets.d.ts

@@ -1,4 +0,0 @@
-import type { ResolvedConfig } from "vite";
-import type { ResolvedPluginOptions } from "./types.js";
-export declare const configureStaticAssets: (resolvedPluginOptions: ResolvedPluginOptions, viteConfig: ResolvedConfig) => Promise<void>;
-//# sourceMappingURL=assets.d.ts.map

package/dist/assets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../src/assets.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AA+BxD,eAAO,MAAM,qBAAqB,0BAAiC,qBAAqB,cAAc,cAAc,kBAoCnH,CAAC"}

package/dist/constants.d.ts.map

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

package/dist/context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEvE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,UAAU,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,WAAW,EAAE,aAAa,CAAC;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,qBAAqB,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB,8CAA8C;IAC9C,SAAS,EAAE,qBAAqB,GAAG,SAAS,CAAC;CAC9C;AAED,eAAO,MAAM,aAAa,gBAAiB,aAAa,aAAa,qBAAqB,GAAG,SAAS,KAAG,kBASxG,CAAC"}

package/dist/log.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAI3C,eAAO,MAAM,gBAAgB,gBAAiB,KAAK,WAAW,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC,eAAe,cAAc,SAkB1H,CAAC"}

package/dist/modules.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../src/modules.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD,eAAO,MAAM,gBAAgB,QAAa,QAAQ,mBAAmB,CASpE,CAAC;AAEF,UAAU,WAAY,SAAQ,YAAY,CAAC,iBAAiB;IAC1D,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,cAAc,WAAkB,aAAa,yBAAyB,KAAG,QAAQ,WAAW,CAYxG,CAAC;AAEF,eAAO,MAAM,qBAAqB,QAAe,kBAAkB,qCAwIlE,CAAC"}

package/dist/options.d.ts

@@ -1,4 +0,0 @@
-import type { ResolvedConfig } from "vite";
-import type { PluginOptions, ResolvedPluginOptions } from "./types.js";
-export declare const resolveOptions: (options: PluginOptions, viteConfig: ResolvedConfig) => Promise<ResolvedPluginOptions>;
-//# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAI3C,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGvE,eAAO,MAAM,cAAc,YAAmB,aAAa,cAAc,cAAc,KAAG,QAAQ,qBAAqB,CA+EtH,CAAC"}