@serwist/build 9.0.0-preview.9 → 9.0.0

package/src/lib/validate-options.ts

@@ -1,3 +1,4 @@
+import { SerwistConfigError } from "../schema/serwistConfigError.js";
 /*
   Copyright 2021 Google LLC
 
@@ -6,13 +7,7 @@
   https://opensource.org/licenses/MIT.
 */
 import { validationErrorMap } from "../schema/validationErrorMap.js";
-import type {
-  GetManifestOptionsComplete,
-  InjectManifestOptionsComplete,
-  ViteInjectManifestOptionsComplete,
-  WebpackInjectManifestOptionsComplete,
-} from "../types.js";
-import { SerwistConfigError } from "./serwist-config-error.js";
+import type { GetManifestOptionsComplete, InjectManifestOptionsComplete } from "../types.js";
 
 export const validateGetManifestOptions = async (input: unknown): Promise<GetManifestOptionsComplete> => {
   const result = await (await import("../schema/getManifest.js")).getManifestOptions.spa(input, { errorMap: validationErrorMap });
@@ -29,19 +24,3 @@ export const validateInjectManifestOptions = async (input: unknown): Promise<Inj
   }
   return result.data;
 };
-
-export const validateWebpackInjectManifestOptions = async (input: unknown): Promise<WebpackInjectManifestOptionsComplete> => {
-  const result = await (await import("../schema/webpack.js")).webpackInjectManifestOptions.spa(input, { errorMap: validationErrorMap });
-  if (!result.success) {
-    throw new SerwistConfigError({ moduleName: "@serwist/webpack-plugin", message: JSON.stringify(result.error.format(), null, 2) });
-  }
-  return result.data;
-};
-
-export const validateViteInjectManifestOptions = async (input: unknown): Promise<ViteInjectManifestOptionsComplete> => {
-  const result = await (await import("../schema/vite.js")).viteInjectManifestOptions.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/schema/assertType.ts

@@ -1,5 +1,7 @@
 export type Equals<T, S> = [T] extends [S] ? ([S] extends [T] ? true : false) : false;
 
+export type Assignable<T, U> = [U] extends [T] ? true : false;
+
 export function assertType<_T extends true>() {
   // Do nothing
 }

package/src/schema/injectManifest.ts

@@ -5,7 +5,7 @@ import { basePartial } from "./base.js";
 import { globPartial, requiredGlobDirectoryPartial } from "./glob.js";
 import { requiredSwDestPartial } from "./swDest.js";
 
-export const injectPartial = z
+export const baseInjectPartial = z
   .object({
     injectionPoint: z.string().default("self.__SW_MANIFEST"),
     swSrc: z.string(),
@@ -14,12 +14,12 @@ export const injectPartial = z
 
 export const injectManifestOptions = basePartial
   .merge(globPartial)
-  .merge(injectPartial)
+  .merge(baseInjectPartial)
   .merge(requiredSwDestPartial)
   .merge(requiredGlobDirectoryPartial)
   .strict("Do not pass invalid properties to InjectManifestOptions!");
 
-assertType<Equals<InjectPartial, z.input<typeof injectPartial>>>();
-assertType<Equals<InjectResolved, z.output<typeof injectPartial>>>();
+assertType<Equals<InjectPartial, z.input<typeof baseInjectPartial>>>();
+assertType<Equals<InjectResolved, z.output<typeof baseInjectPartial>>>();
 assertType<Equals<InjectManifestOptions, z.input<typeof injectManifestOptions>>>();
 assertType<Equals<InjectManifestOptionsComplete, z.output<typeof injectManifestOptions>>>();

package/src/schema/manifestEntry.ts

@@ -3,7 +3,7 @@ import { z } from "zod";
 export const manifestEntry = z
   .object({
     integrity: z.string().optional(),
-    revision: z.string().nullable(),
+    revision: z.string().nullable().optional(),
     url: z.string(),
   })
   .strict("Do not pass invalid properties to ManifestEntry!");

package/src/types.ts

@@ -1,5 +1,4 @@
 import type { Require } from "@serwist/utils";
-import type { Pattern as GlobPattern } from "fast-glob";
 import type { PackageJson } from "type-fest";
 import type { z } from "zod";
 import type { manifestEntry } from "./schema/manifestEntry.js";
@@ -39,9 +38,9 @@ export interface BasePartial {
    */
   manifestTransforms?: ManifestTransform[];
   /**
-   * This value can be used to determine the maximum size of files that will be
-   * precached. This prevents you from inadvertently precaching very large files
-   * that might have accidentally matched one of your patterns.
+   * Determines the maximum size of files that will be precached. This prevents
+   * you from inadvertently precaching very large files that might have accidentally
+   * matched one of your patterns.
    * @default 2097152
    */
   maximumFileSizeToCacheInBytes?: number;
@@ -97,14 +96,14 @@ export interface GlobPartial {
   /**
    * Determines whether or not symlinks are followed when generating the
    * precache manifest. For more information, see the definition of `follow` in
-   * [`glob`'s documentation](https://github.com/isaacs/node-glob#options).
+   * [`node-glob`'s documentation](https://github.com/isaacs/node-glob#options).
    * @default true
    */
   globFollow?: boolean;
   /**
    * A set of patterns matching files to always exclude when generating the
    * precache manifest. For more information, see the definition of `ignore` in
-   * [`glob`'s documentation](https://github.com/isaacs/node-glob#options).
+   * [`node-glob`'s documentation](https://github.com/isaacs/node-glob#options).
    * @default
    * ```
    * ["**\/node_modules\/**\/*"]
@@ -114,7 +113,7 @@ export interface GlobPartial {
   /**
    * Files matching any of these patterns will be included in the precache
    * manifest. For more information, see
-   * [`glob`'s Glob Primer](https://github.com/isaacs/node-glob#glob-primer).
+   * [`node-glob`'s Glob Primer](https://github.com/isaacs/node-glob#glob-primer).
    * @default
    * ```
    * ["**\/*.{js,css,html}"]
@@ -125,7 +124,7 @@ export interface GlobPartial {
    * If true, an error reading a directory when generating a precache manifest
    * will cause the build to fail. If false, the problematic directory will be
    * skipped. For more information, see the definition of `strict` in
-   * [`glob`'s documentation](https://github.com/isaacs/node-glob#options).
+   * [`node-glob`'s documentation](https://github.com/isaacs/node-glob#options).
    * @default true
    */
   globStrict?: boolean;
@@ -133,7 +132,7 @@ export interface GlobPartial {
    * If a URL is rendered based on some server-side logic, its contents may
    * depend on multiple files or on some other unique string value. The keys in
    * this object are server-rendered URLs. If the values are an array of
-   * strings, they will be interpreted as `glob` patterns, and the contents of
+   * strings, they will be interpreted as glob patterns, and the contents of
    * any files matching the patterns will be used to uniquely version the URL.
    * If used with a single string, it will be interpreted as unique versioning
    * information that you've generated for a given URL.
@@ -161,43 +160,6 @@ export interface InjectPartial {
 
 export type InjectResolved = Require<InjectPartial, "injectionPoint">;
 
-export interface WebpackPartial {
-  /**
-   * One or more chunk names whose corresponding output files should be included
-   * in the precache manifest.
-   */
-  chunks?: string[];
-  // We can't use the @default annotation here to assign the value via AJV, as
-  // an (RegExp)[] can't be serialized into JSON.
-  // The default value of [/\.map$/, /^manifest.*\.js$/] will be assigned by
-  // the validation function, and we need to reflect that in the docs.
-  /**
-   * One or more specifiers used to exclude assets from the precache manifest.
-   * This is interpreted following
-   * [the same rules](https://webpack.js.org/configuration/module/#condition)
-   * as `webpack`'s standard `exclude` option.
-   * @default
-   * ```
-   * [/\.map$/, /^manifest.*\.js$]
-   * ```
-   */
-  exclude?: (string | RegExp | ((arg0: any) => boolean))[];
-  /**
-   * One or more chunk names whose corresponding output files should be excluded
-   * from the precache manifest.
-   */
-  excludeChunks?: string[];
-  /**
-   * One or more specifiers used to include assets in the precache manifest.
-   * This is interpreted following
-   * [the same rules](https://webpack.js.org/configuration/module/#condition)
-   * as `webpack`'s standard `include` option.
-   */
-  include?: (string | RegExp | ((arg0: any) => boolean))[];
-}
-
-export type WebpackResolved = Require<WebpackPartial, "exclude">;
-
 export interface RequiredSwDestPartial {
   /**
    * The path and filename of the service worker file that will be created by
@@ -219,121 +181,6 @@ export interface OptionalSwDestPartial {
 
 export type OptionalSwDestResolved = OptionalSwDestPartial;
 
-export interface WebpackInjectManifestPartial {
-  /**
-   * When `true` (the default), the `swSrc` file will be compiled by `webpack`.
-   * When `false`, compilation will not occur (and `webpackCompilationPlugins`
-   * can't be used.) Set to `false` if you want to inject the manifest into,
-   * e.g., a JSON file.
-   * @default true
-   */
-  compileSrc?: boolean;
-  // This can only be set if `compileSrc` is true, but that restriction can't be
-  // represented in TypeScript. It's enforced via custom runtime validation
-  // logic and needs to be documented.
-  /**
-   * Optional `webpack` plugins that will be used when compiling the `swSrc`
-   * input file. Only valid if `compileSrc` is `true`.
-   */
-  webpackCompilationPlugins?: any[];
-}
-
-export type WebpackInjectManifestResolved = Require<WebpackInjectManifestPartial, "compileSrc">;
-
-export interface NextInjectManifestPartial {
-  /**
-   * Enables additional route caching when users navigate through pages with
-   * `next/link`. This improves the user experience in some cases but it
-   * also adds a bit of overhead due to additional network calls.
-   * @default false
-   */
-  cacheOnNavigation?: boolean;
-  /**
-   * Whether Serwist should be disabled.
-   * @default false
-   */
-  disable?: boolean;
-  /**
-   * Whether `@serwist/next` should automatically register the service worker for you. If
-   * you want to register the service worker yourself, set this to `false` and run
-   * `window.serwist.register()` in `componentDidMount` or `useEffect`.
-   * @example
-   *   ```tsx
-   *   // app/register-pwa.tsx
-   *   "use client";
-   *   import { useEffect } from "react";
-   *   import type { Serwist } from "@serwist/window";
-   *
-   *   declare global {
-   *     interface Window {
-   *       serwist: Serwist;
-   *     }
-   *   }
-   *
-   *   export default function RegisterPWA() {
-   *     useEffect(() => {
-   *       if ("serviceWorker" in navigator && window.serwist !== undefined) {
-   *         window.serwist.register();
-   *       }
-   *     }, []);
-   *     return <></>;
-   *   }
-   *
-   *   // app/layout.tsx
-   *   import RegisterPWA from "./register-pwa";
-   *
-   *   export default function RootLayout({
-   *     children,
-   *   }: {
-   *     children: React.ReactNode;
-   *   }) {
-   *     return (
-   *       <html lang="en">
-   *         <head />
-   *         <body>
-   *           <RegisterPWA />
-   *           {children}
-   *         </body>
-   *       </html>
-   *     );
-   *   }
-   *   ```
-   * @default true
-   */
-  register?: boolean;
-  /**
-   * Whether Serwist should reload the app when it goes online.
-   * @default true
-   */
-  reloadOnOnline?: boolean;
-  /**
-   * 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 nextConfig.basePath
-   */
-  scope?: string;
-  /**
-   * The URL to the service worker.
-   * @default "/sw.js"
-   */
-  swUrl?: string;
-  /**
-   * Files in the public directory matching any of these patterns
-   * will be included in the precache manifest. For more information,
-   * see [`fast-glob`'s documentation](https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax).
-   * @default
-   * ```
-   * ["**\/*"]
-   * ```
-   */
-  globPublicPatterns?: GlobPattern | GlobPattern[];
-}
-
-export type NextInjectManifestResolved = Require<
-  NextInjectManifestPartial,
-  "cacheOnNavigation" | "disable" | "register" | "reloadOnOnline" | "swUrl" | "globPublicPatterns"
->;
-
 export type GetManifestOptions = BasePartial & GlobPartial & RequiredGlobDirectoryPartial;
 
 export type GetManifestOptionsComplete = BaseResolved & GlobResolved & RequiredGlobDirectoryResolved;
@@ -342,28 +189,6 @@ export type InjectManifestOptions = BasePartial & GlobPartial & InjectPartial &
 
 export type InjectManifestOptionsComplete = BaseResolved & GlobResolved & InjectResolved & RequiredSwDestResolved & RequiredGlobDirectoryResolved;
 
-export type WebpackInjectManifestOptions = BasePartial & WebpackPartial & InjectPartial & OptionalSwDestPartial & WebpackInjectManifestPartial;
-
-export type WebpackInjectManifestOptionsComplete = BaseResolved &
-  WebpackResolved &
-  InjectResolved &
-  OptionalSwDestResolved &
-  WebpackInjectManifestResolved;
-
-export type ViteInjectManifestOptions = BasePartial & GlobPartial & InjectPartial & RequiredSwDestPartial & RequiredGlobDirectoryPartial;
-
-export type ViteInjectManifestOptionsComplete = BaseResolved & GlobResolved & InjectResolved & RequiredSwDestResolved & RequiredGlobDirectoryResolved;
-
-export type NextInjectManifestOptions = Omit<
-  WebpackInjectManifestOptions & RequiredSwDestPartial & NextInjectManifestPartial,
-  "disablePrecacheManifest"
->;
-
-export type NextInjectManifestOptionsComplete = Omit<
-  WebpackInjectManifestOptionsComplete & RequiredSwDestResolved & NextInjectManifestResolved,
-  "disablePrecacheManifest"
->;
-
 export interface GetManifestResult {
   count: number;
   manifestEntries: ManifestEntry[] | undefined;
@@ -380,7 +205,7 @@ export type BuildResult = Omit<GetManifestResult, "manifestEntries"> & {
  */
 export interface FileDetails {
   file: string;
-  hash: string;
+  hash: string | null;
   size: number;
 }
 

package/dist/chunks/vite.js

@@ -1,7 +0,0 @@
-import { b as basePartial, g as globPartial, r as requiredGlobDirectoryPartial } from './glob.js';
-import { i as injectPartial, r as requiredSwDestPartial } from './injectManifest.js';
-import 'zod';
-
-const viteInjectManifestOptions = basePartial.merge(globPartial).merge(injectPartial).merge(requiredSwDestPartial).merge(requiredGlobDirectoryPartial).strict("Do not pass invalid properties to ViteInjectManifestPartial!");
-
-export { viteInjectManifestOptions };

package/dist/chunks/webpack.js

@@ -1,33 +0,0 @@
-import { z } from 'zod';
-import { b as basePartial } from './glob.js';
-import { i as injectPartial, o as optionalSwDestPartial } from './injectManifest.js';
-
-const webpackPartial = z.object({
-    chunks: z.array(z.string()).optional(),
-    exclude: z.array(z.union([
-        z.string(),
-        z.instanceof(RegExp),
-        z.function(z.tuple([
-            z.any()
-        ]), z.boolean())
-    ])).default([
-        /\.map$/,
-        /^manifest.*\.js$/
-    ]),
-    excludeChunks: z.array(z.string()).optional(),
-    include: z.array(z.union([
-        z.string(),
-        z.instanceof(RegExp),
-        z.function(z.tuple([
-            z.any()
-        ]), z.boolean())
-    ])).optional()
-}).strict("Do not pass invalid properties to WebpackPartial!");
-const webpackInjectManifestPartial = z.object({
-    compileSrc: z.boolean().default(true),
-    swDest: z.string().optional(),
-    webpackCompilationPlugins: z.array(z.any()).optional()
-}).strict("Do not pass invalid properties to WebpackInjectManifestPartial!");
-const webpackInjectManifestOptions = basePartial.merge(webpackPartial).merge(injectPartial).merge(optionalSwDestPartial).merge(webpackInjectManifestPartial).strict("Do not pass invalid properties to WebpackInjectManifestOptions!");
-
-export { webpackInjectManifestOptions, webpackInjectManifestPartial, webpackPartial };

package/dist/index.next.d.ts

@@ -1,3 +0,0 @@
-import { validateNextInjectManifestOptions } from "./lib/validate-next-options.js";
-export { validateNextInjectManifestOptions };
-//# sourceMappingURL=index.next.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.next.d.ts","sourceRoot":"","sources":["../src/index.next.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAC;AAEnF,OAAO,EAAE,iCAAiC,EAAE,CAAC"}

package/dist/index.next.js

@@ -1,38 +0,0 @@
-import { z } from 'zod';
-import { r as requiredSwDestPartial } from './chunks/injectManifest.js';
-import { webpackInjectManifestOptions } from './chunks/webpack.js';
-import { v as validationErrorMap, S as SerwistConfigError } from './chunks/serwist-config-error.js';
-import './chunks/glob.js';
-
-const nextInjectManifestPartial = z.object({
-    cacheOnNavigation: z.boolean().default(false),
-    disable: z.boolean().default(false),
-    register: z.boolean().default(true),
-    reloadOnOnline: z.boolean().default(true),
-    scope: z.string().optional(),
-    swUrl: z.string().default("/sw.js"),
-    globPublicPatterns: z.union([
-        z.string(),
-        z.array(z.string())
-    ]).default([
-        "**/*"
-    ])
-}).strict("Do not pass invalid properties to NextInjectManifestPartial!");
-const nextInjectManifestOptions = webpackInjectManifestOptions.merge(requiredSwDestPartial).merge(nextInjectManifestPartial).omit({
-    disablePrecacheManifest: true
-}).strict("Do not pass invalid properties to NextInjectManifestOptions!");
-
-const validateNextInjectManifestOptions = (input)=>{
-    const result = nextInjectManifestOptions.safeParse(input, {
-        errorMap: validationErrorMap
-    });
-    if (!result.success) {
-        throw new SerwistConfigError({
-            moduleName: "@serwist/next",
-            message: JSON.stringify(result.error.format(), null, 2)
-        });
-    }
-    return result.data;
-};
-
-export { validateNextInjectManifestOptions };

package/dist/lib/serwist-config-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serwist-config-error.d.ts","sourceRoot":"","sources":["../../src/lib/serwist-config-error.ts"],"names":[],"mappings":"AAAA,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;CAI/E"}

package/dist/lib/validate-next-options.d.ts

@@ -1,3 +0,0 @@
-import type { NextInjectManifestOptionsComplete } from "../types.js";
-export declare const validateNextInjectManifestOptions: (input: unknown) => NextInjectManifestOptionsComplete;
-//# sourceMappingURL=validate-next-options.d.ts.map

package/dist/lib/validate-next-options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate-next-options.d.ts","sourceRoot":"","sources":["../../src/lib/validate-next-options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,aAAa,CAAC;AAGrE,eAAO,MAAM,iCAAiC,UAAW,OAAO,KAAG,iCAQlE,CAAC"}