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

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,KAAK,QAAS,MAAM,WAEhC,CAAC;AAEF,eAAO,MAAM,eAAe,SAAU,MAAM,WAG3C,CAAC;AAEF,eAAO,MAAM,UAAU,QAAS,MAAM,4BAErC,CAAC;AAEF,eAAO,MAAM,aAAa,SAAU,MAAM,WAEzC,CAAC;AAIF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,UAAW,MAAM,KAAG,MAAM,GAAG,IAqBrD,CAAC;AAIF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,QAAS,MAAM,WAI/B,CAAC"}

package/src/assets.ts

@@ -1,76 +0,0 @@
-import crypto from "node:crypto";
-import fs from "node:fs";
-import { resolve as resolveFs } from "node:path";
-
-import type { InjectManifestOptions, ManifestEntry } from "@serwist/build";
-import fg from "fast-glob";
-import type { ResolvedConfig } from "vite";
-
-import type { ResolvedPluginOptions } from "./types.js";
-
-const buildManifestEntry = (publicDir: string, url: string): Promise<ManifestEntry> => {
-  return new Promise((resolve, reject) => {
-    const cHash = crypto.createHash("MD5");
-    const stream = fs.createReadStream(resolveFs(publicDir, url));
-    stream.on("error", (err) => {
-      reject(err);
-    });
-    stream.on("data", (chunk) => {
-      cHash.update(chunk);
-    });
-    stream.on("end", () => {
-      return resolve({
-        url,
-        revision: `${cHash.digest("hex")}`,
-      });
-    });
-  });
-};
-
-const lookupAdditionalPrecacheEntries = (serwistOptions: Partial<InjectManifestOptions>): (string | ManifestEntry)[] => {
-  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: string) => {
-  return path.startsWith("/") ? path.substring(1) : path;
-};
-
-export const configureStaticAssets = async (resolvedPluginOptions: ResolvedPluginOptions, viteConfig: ResolvedConfig) => {
-  const { injectManifest, includeAssets } = resolvedPluginOptions;
-
-  const { publicDir } = viteConfig;
-  const globs: string[] = [];
-  const manifestEntries: (string | ManifestEntry)[] = 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));
-  }
-  if (globs.length > 0) {
-    let assets = await fg(globs, {
-      cwd: publicDir,
-      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;
-        return me.url;
-      });
-      assets = assets.filter((a) => !included.includes(a));
-    }
-    const assetsEntries = await Promise.all(
-      assets.map((a) => {
-        return buildManifestEntry(publicDir, a);
-      }),
-    );
-    manifestEntries.push(...assetsEntries);
-  }
-  if (manifestEntries.length > 0) {
-    injectManifest.additionalPrecacheEntries = manifestEntries;
-  }
-};

package/src/integration/svelte/build.ts

@@ -1,21 +0,0 @@
-import type { Plugin } from "vite";
-
-import type { SerwistViteContext } from "../../context.js";
-import type { SerwistViteApi } from "../../types.js";
-
-export const buildPlugin = (ctx: SerwistViteContext, api: SerwistViteApi) => {
-  return <Plugin>{
-    name: "@serwist/vite/integration-svelte:build",
-    apply: "build",
-    enforce: "pre",
-    closeBundle: {
-      sequential: true,
-      enforce: "pre",
-      async handler() {
-        if (api && !api.disabled && ctx.viteConfig.build.ssr) {
-          await api.generateSW();
-        }
-      },
-    },
-  };
-};

package/src/integration/svelte/config.ts

@@ -1,141 +0,0 @@
-import crypto from "node:crypto";
-import os from "node:os";
-import path from "node:path";
-
-import type { ManifestTransform } from "@serwist/build";
-import { errors } from "@serwist/build";
-import type { ResolvedConfig } from "vite";
-
-import type { PluginOptions as BasePluginOptions } from "../../types.js";
-import { resolveEntry } from "../../utils.js";
-import type { KitOptions } from "./types.js";
-
-export const configurateSvelteKitOptions = (viteConfig: ResolvedConfig, kit: KitOptions, options: BasePluginOptions) => {
-  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");
-  } else {
-    const swSrc = resolveEntry(path.join(viteConfig.root, kit.files?.serviceWorker ?? "src/service-worker"));
-    if (swSrc) {
-      options.swSrc = swSrc;
-      options.swDest = path.join(os.tmpdir(), `serwist-vite-integration-svelte-${crypto.randomUUID()}.js`);
-    } else {
-      throw new Error(errors["invalid-sw-src"]);
-    }
-  }
-  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, "..");
-  }
-  if (!options.manifestTransforms) {
-    options.manifestTransforms = [createManifestTransform(viteConfig.base, undefined, kit)];
-  }
-
-  let buildAssetsDir = kit.appDir ?? "_app/";
-  if (buildAssetsDir[0] === "/") buildAssetsDir = buildAssetsDir.slice(1);
-  if (buildAssetsDir[buildAssetsDir.length - 1] !== "/") buildAssetsDir += "/";
-
-  if (!options.modifyURLPrefix) {
-    options.globPatterns = buildGlobPatterns(options.globPatterns);
-    if (kit.includeVersionFile) {
-      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/`);
-  }
-
-  if (!options.injectionPoint) {
-    options.injectionPoint = "self.__SW_MANIFEST";
-  }
-};
-
-export function createManifestTransform(base: string, webManifestName?: string, options?: KitOptions): ManifestTransform {
-  return async (entries) => {
-    const defaultAdapterFallback = "prerendered/fallback.html";
-    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!;
-
-        if (url.endsWith(".html")) {
-          if (url.startsWith("/")) url = url.slice(1);
-
-          if (url === "index.html") {
-            url = base;
-          } else {
-            const idx = url.lastIndexOf("/");
-            if (idx > -1) {
-              // abc/index.html -> abc/?
-              if (url.endsWith("/index.html")) url = `${url.slice(0, idx)}${suffix}`;
-              // abc/def.html -> abc/def/?
-              else url = `${url.substring(0, url.lastIndexOf("."))}${suffix}`;
-            } else {
-              // xxx.html -> xxx/?
-              url = `${url.substring(0, url.lastIndexOf("."))}${suffix}`;
-            }
-          }
-        }
-
-        e.url = url;
-
-        return e;
-      });
-
-    if (!webManifestName) return { manifest };
-
-    return { manifest: manifest.filter((e) => e.url !== webManifestName) };
-  };
-}
-
-export function buildGlobPatterns(globPatterns?: string[]) {
-  if (globPatterns) {
-    if (!globPatterns.some((g) => g.startsWith("prerendered/"))) globPatterns.push("prerendered/**/*.html");
-
-    if (!globPatterns.some((g) => g.startsWith("client/"))) globPatterns.push("client/**/*.{js,css,ico,png,svg,webp,webmanifest}");
-
-    if (!globPatterns.some((g) => g.includes("webmanifest"))) globPatterns.push("client/*.webmanifest");
-
-    return globPatterns;
-  }
-
-  return ["client/**/*.{js,css,ico,png,svg,webp,webmanifest}", "prerendered/**/*.html"];
-}
-
-export function buildGlobIgnores(globIgnores?: string[]) {
-  if (globIgnores) {
-    if (!globIgnores.some((g) => g.startsWith("server/"))) globIgnores.push("server/*.*");
-
-    return globIgnores;
-  }
-
-  return ["server/*.*"];
-}

package/src/integration/svelte/index.ts

@@ -1,27 +0,0 @@
-import type { Plugin } from "vite";
-
-import { createApi } from "../../api.js";
-import { createContext } from "../../context.js";
-import { devPlugin } from "../../plugins/dev.js";
-import { mainPlugin } from "../../plugins/main.js";
-import type { PluginOptions as BasePluginOptions } from "../../types.js";
-import { buildPlugin } from "./build.js";
-import { configurateSvelteKitOptions } from "./config.js";
-import type { PluginOptions } from "./types.js";
-
-// TODO: handle SvelteKit build errors.
-/**
- * Integrates Serwist into your SvelteKit app.
- * @param userOptions
- * @returns
- */
-export const serwist = (userOptions: PluginOptions = {}): Plugin[] => {
-  if (!userOptions.integration) userOptions.integration = {};
-  userOptions.integration.closeBundleOrder = "pre";
-  userOptions.integration.configureOptions = (viteConfig, options) => configurateSvelteKitOptions(viteConfig, userOptions.kit ?? {}, options);
-  const ctx = createContext(userOptions as BasePluginOptions, "sveltekit");
-  const api = createApi(ctx);
-  return [mainPlugin(ctx, api), devPlugin(ctx, api), buildPlugin(ctx, api)];
-};
-
-export * from "./types.js";

package/src/integration/svelte/types.ts

@@ -1,26 +0,0 @@
-import type { KitConfig } from "@sveltejs/kit";
-
-import type { PluginOptions as BasePluginOptions } from "../../types.js";
-import type { Optional } from "../../utils-types.js";
-
-export interface KitOptions extends Pick<KitConfig, "appDir" | "files"> {
-  /**
-   * @see https://kit.svelte.dev/docs/adapter-static#options-fallback
-   */
-  adapterFallback?: string;
-  /**
-   * `trailingSlash` in `+page.{ts,js}` or `+layout.{ts,js}` files.
-   * @default "never"
-   */
-  trailingSlash?: "never" | "always" | "ignore";
-  /**
-   * Should `"${appDir}/version.json"` be included in the service worker's precache manifest?
-   *
-   * @default false
-   */
-  includeVersionFile?: boolean;
-}
-
-export interface PluginOptions extends Optional<Omit<BasePluginOptions, "swSrc" | "swDest" | "swUrl">, "globDirectory"> {
-  kit?: KitOptions;
-}

package/src/options.ts

@@ -1,90 +0,0 @@
-import path from "node:path";
-import process from "node:process";
-
-import type { ResolvedConfig } from "vite";
-
-import { configureStaticAssets } from "./assets.js";
-import { loadSerwistBuild } from "./modules.js";
-import type { PluginOptions, ResolvedPluginOptions } from "./types.js";
-import { resolveBasePath, slash } from "./utils.js";
-
-export const resolveOptions = async (options: PluginOptions, viteConfig: ResolvedConfig): Promise<ResolvedPluginOptions> => {
-  const {
-    type = "classic",
-    mode = (process.env.NODE_ENV || "production") as "production" | "development",
-    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 += "/";
-
-  const resolvedDevOptions: ResolvedPluginOptions["devOptions"] = {
-    bundle: true,
-    minify: false,
-    ...devOptions,
-  };
-
-  // remove './' prefix from assetsDir
-  const dontCacheBustURLsMatching = new RegExp(`^${assetsDir.replace(/^\.*?\//, "")}`);
-
-  const { validateViteInjectManifestOptions } = await loadSerwistBuild();
-
-  const validatedInjectManifest = await validateViteInjectManifestOptions(injectManifest);
-
-  const { swSrc, swDest, ...userInjectManifest } = validatedInjectManifest || {};
-
-  const resolvedPluginOptions = {
-    base: basePath,
-    type,
-    mode,
-    injectRegister,
-    registerType,
-    useCredentials,
-    swUrl,
-    injectManifest: {
-      dontCacheBustURLsMatching,
-      ...userInjectManifest,
-      swSrc: path.resolve(viteConfig.root, swSrc),
-      swDest: path.resolve(viteConfig.root, viteConfig.build.outDir, swDest),
-      disablePrecacheManifest: !viteConfig.isProduction,
-    },
-    scope,
-    minify,
-    includeAssets,
-    disable,
-    integration,
-    buildBase: buildBase ?? basePath,
-    injectManifestRollupOptions: {
-      plugins,
-      rollupOptions,
-      format: rollupFormat,
-    },
-    devOptions: resolvedDevOptions,
-  } satisfies ResolvedPluginOptions;
-
-  // calculate hash only when required
-  const calculateHash = !resolvedPluginOptions.disable && resolvedPluginOptions.includeAssets && viteConfig.command === "build";
-
-  if (calculateHash) await configureStaticAssets(resolvedPluginOptions, viteConfig);
-
-  return resolvedPluginOptions;
-};

package/src/types.ts

@@ -1,207 +0,0 @@
-import type { ManifestEntry, ViteInjectManifestOptions } from "@serwist/build";
-import type { RollupOptions } from "rollup";
-import type { BuildOptions, Plugin, ResolvedConfig } from "vite";
-
-export type InjectManifestVitePlugins = string[] | ((vitePluginIds: string[]) => string[]);
-export interface CustomInjectManifestOptions extends Omit<ViteInjectManifestOptions, "disablePrecacheManifest"> {
-  /**
-   * The URL to the service worker.
-   * @default "/sw.js"
-   */
-  swUrl?: string;
-  /**
-   * Configure the format to use in the Rollup build.
-   *
-   * @default 'es'
-   */
-  rollupFormat?: "es" | "iife";
-  /**
-   * Since `v0.15.0` you can add plugins to build your service worker.
-   *
-   * When using `injectManifest` there are 2 builds, your application and the service worker.
-   * If you're using custom configuration for your service worker (for example custom plugins) you can use this option to configure the service worker build.
-   * Both configurations cannot be shared, and so you'll need to duplicate the configuration, with the exception of `define`.
-   *
-   * **WARN**: this option is for advanced usage, be aware that you may break your application build.
-   */
-  plugins?: Plugin[];
-  /**
-   * Since `v0.15.0` you can add custom Rollup options to build your service worker: we expose the same configuration to build a worker using Vite.
-   */
-  rollupOptions?: Omit<RollupOptions, "plugins" | "output">;
-}
-
-export interface SerwistViteHooks {
-  beforeBuildServiceWorker?: (options: ResolvedPluginOptions) => 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.
-   */
-  bundle?: boolean;
-  minify?: BuildOptions["minify"];
-}
-
-/**
- * Plugin options.
- */
-export interface BasePluginOptions {
-  /**
-   * Build mode
-   *
-   * @default
-   * process.env.NODE_ENV // or "production" if undefined
-   */
-  mode?: "development" | "production";
-  /**
-   * The service worker type.
-   *
-   * @default "classic"
-   */
-  type?: WorkerType;
-  /**
-   * The scope to register the Service Worker
-   *
-   * @default `viteOptions.base`
-   */
-  scope?: string;
-  /**
-   * Inject the service worker register inlined in the index.html
-   *
-   * If set to "auto", depends on whether you used the `import { registerSW } from 'virtual:pwa-register'`
-   * it will do nothing or use the `script` mode
-   *
-   * `"inline"` - inject a simple register, inlined with the generated html
-   *
-   * `"script"` - inject `<script/>` in `<head>` with `src` attribute to a generated script to register the service worker
-   *
-   * `"script-defer"` - inject `<script defer />` in `<head>`, with `src` attribute to a generated script to register the service worker
-   *
-   * `null` - do nothing. You will need to register the service worker yourself or import `registerSW` from `virtual:pwa-register`.
-   *
-   * @default "auto"
-   */
-  injectRegister: "inline" | "script" | "script-defer" | "auto" | null | false;
-  /**
-   * Mode for the virtual register.
-   * This is NOT available if `injectRegister` is set to `"inline"` or `"script"`
-   *
-   * `"prompt"` - you will need to show a popup/dialog to the user to confirm the reload.
-   *
-   * `"autoUpdate"` - when new content is available, the new service worker will update caches and reload all browser
-   * windows/tabs with the application open automatically, it must take the control for the application to work
-   * properly.
-   *
-   * @default "prompt"
-   */
-  registerType?: "prompt" | "autoUpdate";
-  /**
-   * Minify the generated manifest
-   *
-   * @default true
-   */
-  minify: boolean;
-  /**
-   * Whether to add the `crossorigin="use-credentials"` attribute to `<link rel="manifest">`
-   * @default false
-   */
-  useCredentials?: boolean;
-  /**
-   * Override Vite's base options for `@serwist/vite`.
-   *
-   * @default viteOptions.base
-   */
-  base?: string;
-  /**
-   * `public` resources to be added to the PWA manifest.
-   *
-   * You don't need to add `manifest` icons here, it will be auto included.
-   *
-   * The `public` directory will be resolved from Vite's `publicDir` option directory.
-   */
-  includeAssets: string | string[] | undefined;
-  /**
-   * Whether Serwist should be disabled.
-   *
-   * @default false
-   */
-  disable: boolean;
-  /**
-   * `@serwist/vite` integration.
-   */
-  integration?: SerwistViteHooks;
-  /**
-   * When Vite's build folder is not the same as your base root folder, configure it here.
-   *
-   * This option will be useful for integrations like `vite-plugin-laravel` where Vite's build folder is `public/build` but Laravel's base path is `public`.
-   *
-   * This option will be used to configure the path for the service worker, "registerSW.js" and the web manifest assets.
-   *
-   * For example, if your base path is `/`, then, in your Laravel PWA configuration use `buildPath: '/build/'`.
-   *
-   * By default: `vite.base`.
-   */
-  buildBase?: string;
-}
-
-export interface PluginOptions extends Partial<BasePluginOptions>, CustomInjectManifestOptions {
-  devOptions?: DevOptions;
-}
-
-export interface InjectManifestRollupOptions {
-  format: "es" | "iife";
-  plugins: Plugin[];
-  rollupOptions: RollupOptions;
-}
-
-export interface ResolvedPluginOptions extends Required<BasePluginOptions>, Required<Pick<CustomInjectManifestOptions, "swUrl">> {
-  injectManifest: ViteInjectManifestOptions;
-  injectManifestRollupOptions: InjectManifestRollupOptions;
-  devOptions: Required<DevOptions>;
-}
-
-export interface ShareTargetFiles {
-  name: string;
-  accept: string | string[];
-}
-
-/**
- * @see https://developer.mozilla.org/en-US/docs/Web/Manifest/launch_handler#launch_handler_item_values
- */
-export type LaunchHandlerClientMode = "auto" | "focus-existing" | "navigate-existing" | "navigate-new";
-
-export type Display = "fullscreen" | "standalone" | "minimal-ui" | "browser";
-export type DisplayOverride = Display | "window-controls-overlay";
-export type IconPurpose = "monochrome" | "maskable" | "any";
-
-// biome-ignore lint/complexity/noBannedTypes: We intentionally have 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 {
-  /**
-   * Is the plugin disabled?
-   */
-  disabled: boolean;
-  extendManifestEntries(fn: ExtendManifestEntriesHook): void;
-  /*
-   * Generate the service worker.
-   */
-  generateSW(): Promise<void>;
-}
-
-export type ExtendManifestEntriesHook = (manifestEntries: (string | ManifestEntry)[]) => (string | ManifestEntry)[] | undefined;

package/src/utils-types.ts

@@ -1 +0,0 @@
-export type Optional<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;