@serwist/vite 9.5.6 → 9.5.8

package/dist/chunks/schema-CF26pDQI.js

@@ -0,0 +1,77 @@
+import { createRequire } from "node:module";
+import { asyncFn, basePartial, fn, globPartial, injectPartial, requiredGlobDirectoryPartial, requiredSwDestPartial } from "@serwist/build/schema";
+import { z } from "zod";
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+//#endregion
+//#region src/lib/schema.ts
+var schema_exports = /* @__PURE__ */ __exportAll({
+	devOptions: () => devOptions,
+	hooks: () => hooks,
+	injectManifestOptions: () => injectManifestOptions,
+	injectManifestPartial: () => injectManifestPartial
+});
+const hooks = z.object({
+	beforeBuildServiceWorker: z.union([fn({
+		input: [z.any()],
+		output: z.void()
+	}), asyncFn({
+		input: [z.any()],
+		output: z.void()
+	})]).optional(),
+	closeBundleOrder: z.union([
+		z.literal("pre"),
+		z.literal("post"),
+		z.null()
+	]).optional(),
+	configureOptions: z.union([fn({
+		input: [z.any(), z.any()],
+		output: z.void()
+	}), asyncFn({
+		input: [z.any(), z.any()],
+		output: z.void()
+	})]).optional()
+});
+const devOptions = z.object({
+	bundle: z.boolean().default(true),
+	minify: z.union([
+		z.boolean(),
+		z.literal("terser"),
+		z.literal("esbuild")
+	]).default(false)
+});
+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.prefault({})
+});
+const injectManifestOptions = z.strictObject({
+	...basePartial.shape,
+	...globPartial.shape,
+	...injectPartial.shape,
+	...requiredSwDestPartial.shape,
+	...requiredGlobDirectoryPartial.shape,
+	...injectManifestPartial.shape
+});
+//#endregion
+export { schema_exports as a, injectManifestPartial as i, hooks as n, __require as o, injectManifestOptions as r, devOptions as t };
+
+//# sourceMappingURL=schema-CF26pDQI.js.map

package/dist/chunks/schema-CF26pDQI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-CF26pDQI.js","names":[],"sources":["../../src/lib/schema.ts"],"sourcesContent":["import { asyncFn, basePartial, fn, globPartial, injectPartial, requiredGlobDirectoryPartial, requiredSwDestPartial } from \"@serwist/build/schema\";\nimport { z } from \"zod\";\n\nexport const hooks = z.object({\n  beforeBuildServiceWorker: z\n    .union([\n      fn({\n        input: [z.any()],\n        output: z.void(),\n      }),\n      asyncFn({\n        input: [z.any()],\n        output: z.void(),\n      }),\n    ])\n    .optional(),\n  closeBundleOrder: z.union([z.literal(\"pre\"), z.literal(\"post\"), z.null()]).optional(),\n  configureOptions: z\n    .union([\n      fn({\n        input: [z.any(), z.any()],\n        output: z.void(),\n      }),\n      asyncFn({\n        input: [z.any(), z.any()],\n        output: z.void(),\n      }),\n    ])\n    .optional(),\n});\n\nexport const devOptions = z.object({\n  bundle: z.boolean().default(true),\n  minify: z.union([z.boolean(), z.literal(\"terser\"), z.literal(\"esbuild\")]).default(false),\n});\n\nexport const injectManifestPartial = z.object({\n  mode: z.union([z.literal(\"development\"), z.literal(\"production\")]),\n  type: z.union([z.literal(\"classic\"), z.literal(\"module\")]).default(\"classic\"),\n  scope: z.string(),\n  base: z.string(),\n  disable: z.boolean().default(false),\n  integration: hooks.default({}),\n  swUrl: z.string().default(\"/sw.js\"),\n  plugins: z.array(z.any()).default([]),\n  rollupFormat: z.union([z.literal(\"es\"), z.literal(\"iife\")]).default(\"es\"),\n  rollupOptions: z.record(z.string(), z.any()).default({}),\n  devOptions: devOptions.prefault({}),\n});\n\nexport const injectManifestOptions = z.strictObject({\n  ...basePartial.shape,\n  ...globPartial.shape,\n  ...injectPartial.shape,\n  ...requiredSwDestPartial.shape,\n  ...requiredGlobDirectoryPartial.shape,\n  ...injectManifestPartial.shape,\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAa,QAAQ,EAAE,OAAO;CAC5B,0BAA0B,EACvB,MAAM,CACL,GAAG;EACD,OAAO,CAAC,EAAE,KAAK,CAAC;EAChB,QAAQ,EAAE,MAAM;EACjB,CAAC,EACF,QAAQ;EACN,OAAO,CAAC,EAAE,KAAK,CAAC;EAChB,QAAQ,EAAE,MAAM;EACjB,CAAC,CACH,CAAC,CACD,UAAU;CACb,kBAAkB,EAAE,MAAM;EAAC,EAAE,QAAQ,MAAM;EAAE,EAAE,QAAQ,OAAO;EAAE,EAAE,MAAM;EAAC,CAAC,CAAC,UAAU;CACrF,kBAAkB,EACf,MAAM,CACL,GAAG;EACD,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC;EACzB,QAAQ,EAAE,MAAM;EACjB,CAAC,EACF,QAAQ;EACN,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC;EACzB,QAAQ,EAAE,MAAM;EACjB,CAAC,CACH,CAAC,CACD,UAAU;CACd,CAAC;AAEF,MAAa,aAAa,EAAE,OAAO;CACjC,QAAQ,EAAE,SAAS,CAAC,QAAQ,KAAK;CACjC,QAAQ,EAAE,MAAM;EAAC,EAAE,SAAS;EAAE,EAAE,QAAQ,SAAS;EAAE,EAAE,QAAQ,UAAU;EAAC,CAAC,CAAC,QAAQ,MAAM;CACzF,CAAC;AAEF,MAAa,wBAAwB,EAAE,OAAO;CAC5C,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,cAAc,EAAE,EAAE,QAAQ,aAAa,CAAC,CAAC;CAClE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,UAAU,EAAE,EAAE,QAAQ,SAAS,CAAC,CAAC,CAAC,QAAQ,UAAU;CAC7E,OAAO,EAAE,QAAQ;CACjB,MAAM,EAAE,QAAQ;CAChB,SAAS,EAAE,SAAS,CAAC,QAAQ,MAAM;CACnC,aAAa,MAAM,QAAQ,EAAE,CAAC;CAC9B,OAAO,EAAE,QAAQ,CAAC,QAAQ,SAAS;CACnC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;CACrC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,KAAK,EAAE,EAAE,QAAQ,OAAO,CAAC,CAAC,CAAC,QAAQ,KAAK;CACzE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;CACxD,YAAY,WAAW,SAAS,EAAE,CAAC;CACpC,CAAC;AAEF,MAAa,wBAAwB,EAAE,aAAa;CAClD,GAAG,YAAY;CACf,GAAG,YAAY;CACf,GAAG,cAAc;CACjB,GAAG,sBAAsB;CACzB,GAAG,6BAA6B;CAChC,GAAG,sBAAsB;CAC1B,CAAC"}

package/dist/index.d.mts

@@ -0,0 +1,228 @@
+import { BasePartial, BaseResolved, GlobPartial, GlobResolved, InjectPartial, InjectResolved, ManifestEntry, RequiredGlobDirectoryPartial, RequiredGlobDirectoryResolved, RequiredSwDestPartial, RequiredSwDestResolved } from "@serwist/build";
+import { BuildOptions, Plugin, ResolvedConfig } from "vite";
+import { Require } from "@serwist/utils";
+import { RollupOptions } from "rollup";
+
+//#region src/lib/types.d.ts
+interface InjectPartial$1 {
+  /**
+   * The mode in which your service worker should be built.
+   *
+   * @default
+   * process.env.NODE_ENV // or "production" if undefined
+   */
+  mode?: "development" | "production";
+  /**
+   * 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 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;
+  /**
+   * 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;
+  /**
+   * Rollup/Vite plugins used to build the 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;
+}
+interface InjectResolved$1 extends Require<InjectPartial$1, "mode" | "type" | "scope" | "base" | "disable" | "swUrl" | "rollupFormat"> {
+  devOptions: Required<DevOptions>;
+}
+interface InjectManifestOptions extends Omit<BasePartial, "disablePrecacheManifest">, GlobPartial, InjectPartial, RequiredSwDestPartial, RequiredGlobDirectoryPartial, InjectPartial$1 {}
+interface InjectManifestOptionsComplete extends BaseResolved, GlobResolved, InjectResolved, RequiredSwDestResolved, RequiredGlobDirectoryResolved, InjectResolved$1 {}
+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>;
+}
+interface DevOptions {
+  /**
+   * Whether the service worker should be bundled in development mode.
+   *
+   * @default true
+   */
+  bundle?: boolean;
+  /**
+   * Whether the service worker should be minified in development mode.
+   *
+   * @default false
+   */
+  minify?: BuildOptions["minify"];
+}
+interface PluginOptions extends InjectManifestOptions {}
+interface PluginOptionsComplete extends InjectResolved$1 {
+  injectManifest: Omit<InjectManifestOptionsComplete, keyof InjectResolved$1>;
+}
+interface SerwistViteApi {
+  /**
+   * Whether the plugin is disabled.
+   */
+  disabled: boolean;
+  /**
+   * Extends the precache manifest.
+   * @param fn
+   */
+  extendManifestEntries(fn: ExtendManifestEntriesHook): void;
+  generateSW(): Promise<void>;
+}
+type ExtendManifestEntriesHook = (manifestEntries: (string | ManifestEntry)[]) => (string | ManifestEntry)[] | undefined;
+//#endregion
+//#region src/lib/context.d.ts
+type SerwistViteFrameworks = "nuxt";
+interface SerwistViteContext {
+  /**
+   * Resolved Vite config.
+   *
+   * Note: This value is set by our main plugin, located at plugins/main.ts.
+   */
+  viteConfig: ResolvedConfig;
+  /**
+   * Provided options.
+   */
+  userOptions: PluginOptions;
+  /**
+   * Resolved options.
+   *
+   * Note: this is different from `userOptions` in that it has been parsed, whereas
+   * `userOptions` is the raw configuration that the user provides us.
+   */
+  options: PluginOptionsComplete;
+  useImportRegister: boolean;
+  /**
+   * Is the plugin running on dev?
+   *
+   * Note: This value is set by our dev plugin, located at plugins/dev.ts.
+   */
+  devEnvironment: boolean;
+  /** To tailor our APIs to these frameworks. */
+  framework: SerwistViteFrameworks | undefined;
+}
+declare const createContext: (userOptions: PluginOptions, framework: SerwistViteFrameworks | undefined) => SerwistViteContext;
+//#endregion
+//#region src/lib/api.d.ts
+declare const createApi: (ctx: SerwistViteContext) => SerwistViteApi;
+//#endregion
+//#region src/lib/utils.d.ts
+/**
+ * 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
+ */
+declare const resolveEntry: (entry: string) => string | null;
+/**
+ * Internal function used by `@serwist/vite`.
+ * Converts a filesystem path to a Vite `@fs` URL.
+ * @internal
+ * @param ctx
+ * @param api
+ * @returns
+ */
+declare const toFs: (str: string) => string;
+//#endregion
+//#region src/lib/validator.d.ts
+declare const validateInjectManifestOptions: (input: unknown) => Promise<InjectManifestOptionsComplete>;
+//#endregion
+//#region src/plugins/build.d.ts
+/**
+ * Internal build plugin used by `@serwist/vite`.
+ * @internal
+ * @param ctx
+ * @param api
+ * @returns
+ */
+declare const buildPlugin: (ctx: SerwistViteContext, api: SerwistViteApi) => Plugin;
+//#endregion
+//#region src/plugins/dev.d.ts
+/**
+ * Internal dev plugin used by `@serwist/vite`.
+ * @internal
+ * @param ctx
+ * @param api
+ * @returns
+ */
+declare const devPlugin: (ctx: SerwistViteContext, api: SerwistViteApi) => Plugin;
+//#endregion
+//#region src/plugins/main.d.ts
+/**
+ * Internal plugin used by `@serwist/vite`.
+ * @internal
+ * @param ctx
+ * @param api
+ * @returns
+ */
+declare const mainPlugin: (ctx: SerwistViteContext, api: SerwistViteApi) => Plugin;
+//#endregion
+//#region src/index.d.ts
+/**
+ * Integrates Serwist into your Vite app.
+ * @param userOptions
+ * @returns
+ */
+declare const serwist: (userOptions: PluginOptions) => Plugin[];
+//#endregion
+export { type DevOptions, type ExtendManifestEntriesHook, type Hooks, type PluginOptions, type PluginOptionsComplete, type SerwistViteApi, type SerwistViteContext, buildPlugin as build, createApi, createContext, devPlugin as dev, mainPlugin as main, resolveEntry, serwist, toFs, validateInjectManifestOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/lib/types.ts","../src/lib/context.ts","../src/lib/api.ts","../src/lib/utils.ts","../src/lib/validator.ts","../src/plugins/build.ts","../src/plugins/dev.ts","../src/plugins/main.ts","../src/index.ts"],"mappings":";;;;;;UAiBiB,eAAA;;AAAjB;;;;;EAOE,IAAA;EAsDqB;;;;;;;EA9CrB,IAAA,GAAO,UAAA;EASP;;;;;;;;EAAA,KAAA;EAqCA;;;;;;EA9BA,IAAA;EAqCe;;;;;EA/Bf,OAAA;EA+BsC;;;EA3BtC,WAAA,GAAc,KAAA;EA2BgC;;;;;EArB9C,KAAA;EAyBe;;;EArBf,OAAA,GAAU,MAAA;EAsBF;;;;;EAhBR,YAAA;EAqBe;;;EAjBf,aAAA,GAAgB,IAAA,CAAK,aAAA;EAanB;;;EATF,UAAA,GAAa,UAAA;AAAA;AAAA,UAGE,gBAAA,SAAuB,OAAA,CAAQ,eAAA;EAC9C,UAAA,EAAY,QAAA,CAAS,UAAA;AAAA;AAAA,UAGN,qBAAA,SACP,IAAA,CAAK,WAAA,8BACX,WAAA,EACA,aAAA,EACA,qBAAA,EACA,4BAAA,EACA,eAAA;AAAA,UAEa,6BAAA,SACP,YAAA,EACN,YAAA,EACA,cAAA,EACA,sBAAA,EACA,6BAAA,EACA,gBAAA;AAAA,UAEa,KAAA;EAJb;;;;;EAUF,wBAAA,IAA4B,OAAA,EAAS,qBAAA,YAAiC,OAAA;EAZpE;;;EAgBF,gBAAA;EAZE;;;AAEJ;;;EAiBE,gBAAA,IAAoB,WAAA,EAAa,cAAA,EAAgB,OAAA,EAAS,aAAA,YAAyB,OAAA;AAAA;AAAA,UAGpE,UAAA;EAH2C;;;;;EAS1D,MAAA;EApB4B;;;;;EA0B5B,MAAA,GAAS,YAAA;AAAA;AAAA,UAGM,aAAA,SAAsB,qBAAA;AAAA,UAEtB,qBAAA,SAA8B,gBAAA;EAC7C,cAAA,EAAgB,IAAA,CAAK,6BAAA,QAAqC,gBAAA;AAAA;AAAA,UAG3C,cAAA;;;;EAIf,QAAA;EAbS;;;AAGX;EAeE,qBAAA,CAAsB,EAAA,EAAI,yBAAA;EAI1B,UAAA,IAAc,OAAA;AAAA;AAAA,KAGJ,yBAAA,IAA6B,eAAA,YAA2B,aAAA,kBAA+B,aAAA;;;KC9JvF,qBAAA;AAAA,UAEK,kBAAA;;;ADWjB;;;ECLE,UAAA,EAAY,cAAA;ED8CE;;;EC1Cd,WAAA,EAAa,aAAA;EDkEA;;;;;;EC3Db,OAAA,EAAS,qBAAA;EACT,iBAAA;ED8BA;;;;;ECxBA,cAAA;ED4CA;EC1CA,SAAA,EAAW,qBAAA;AAAA;AAAA,cAGA,aAAA,GAAiB,WAAA,EAAa,aAAA,EAAe,SAAA,EAAW,qBAAA,iBAAoC,kBAAA;;;cC5B5F,SAAA,GAAa,GAAA,EAAK,kBAAA,KAAqB,cAAA;;;;;AFUpD;;;;;;;cGca,YAAA,GAAgB,KAAA;;;;;;;;;cAiChB,IAAA,GAAQ,GAAA;;;cC5DR,6BAAA,GAAuC,KAAA,cAAiB,OAAA,CAAQ,6BAAA;;;;;;AJa7E;;;;cKLa,WAAA,GAAe,GAAA,EAAK,kBAAA,EAAoB,GAAA,EAAK,cAAA,KAChD,MAAA;;;;;;ALIV;;;;cMKa,SAAA,GAAa,GAAA,EAAK,kBAAA,EAAoB,GAAA,EAAK,cAAA,KAAiB,MAAA;;;;;;ANLzE;;;;cODa,UAAA,GAAc,GAAA,EAAK,kBAAA,EAAoB,GAAA,EAAK,cAAA,KAC/C,MAAA;;;;;;;;cCDG,OAAA,GAAW,WAAA,EAAa,aAAA,KAAgB,MAAA"}