@serwist/build 9.0.0-preview.2 → 9.0.0-preview.21

package/src/_types.js

@@ -1,112 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-/**
- * @typedef {Object} ManifestEntry
- * @property {string} url The URL to the asset in the manifest.
- * @property {string} revision The revision details for the file. This should be
- * either a hash generated based on the file contents, or `null` if there is
- * versioning already included in the URL.
- * @property {string} [integrity] Integrity metadata that will be used when
- * making the network request for the URL.
- */
-
-/**
- * @typedef {Object} ManifestTransformResult
- * @property {Array<module:workbox-build.ManifestEntry>} manifest
- * @property {Array<string>|undefined} warnings
- */
-
-/**
- * @typedef {Object} RuntimeCachingEntry
- *
- * @property {string|module:workbox-routing~handlerCallback} handler
- * Either the name of one of the [built-in strategy classes]{@link module:workbox-strategies},
- * or custom handler callback to use when the generated route matches.
- *
- * @property {string|RegExp|module:workbox-routing~matchCallback} urlPattern
- * The value that will be passed to [`registerRoute()`]{@link module:workbox-routing.registerRoute},
- * used to determine whether the generated route will match a given request.
- *
- * @property {string} [method='GET'] The
- * [HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) that
- * will match the generated route.
- *
- * @property {Object} [options]
- *
- * @property {Object} [options.backgroundSync]
- *
- * @property {string} [options.backgroundSync.name] The `name` property to use
- * when creating the
- * [`BackgroundSyncPlugin`]{@link module:workbox-background-sync.BackgroundSyncPlugin}.
- *
- * @property {Object} [options.backgroundSync.options] The `options` property
- * to use when creating the
- * [`BackgroundSyncPlugin`]{@link module:workbox-background-sync.BackgroundSyncPlugin}.
- *
- * @property {Object} [options.broadcastUpdate]
- *
- * @property {string} [options.broadcastUpdate.channelName] The `channelName`
- * property to use when creating the
- * [`BroadcastCacheUpdatePlugin`]{@link module:workbox-broadcast-update.BroadcastUpdatePlugin}.
- *
- * @property {Object} [options.broadcastUpdate.options] The `options` property
- * to use when creating the
- * [`BroadcastCacheUpdatePlugin`]{@link module:workbox-broadcast-update.BroadcastUpdatePlugin}.
- *
- * @property {Object} [options.cacheableResponse]
- *
- * @property {Object} [options.cacheableResponse.headers] The `headers` property
- * to use when creating the
- * [`CacheableResponsePlugin`]{@link module:workbox-cacheable-response.CacheableResponsePlugin}.
- *
- * @property {Array<number>} [options.cacheableResponse.statuses] `statuses`
- * property to use when creating the
- * [`CacheableResponsePlugin`]{@link module:workbox-cacheable-response.CacheableResponsePlugin}.
- *
- * @property {string} [options.cacheName] The `cacheName` to use when
- * constructing one of the
- * [Workbox strategy classes]{@link module:workbox-strategies}.
- *
- * @property {Object} [options.fetchOptions] The `fetchOptions` property value
- * to use when constructing one of the
- * [Workbox strategy classes]{@link module:workbox-strategies}.
- *
- * @property {Object} [options.expiration]
- *
- * @property {number} [options.expiration.maxAgeSeconds] The `maxAgeSeconds`
- * property to use when creating the
- * [`ExpirationPlugin`]{@link module:workbox-expiration.ExpirationPlugin}.
- *
- * @property {number} [options.expiration.maxEntries] The `maxEntries`
- * property to use when creating the
- * [`ExpirationPlugin`]{@link module:workbox-expiration.ExpirationPlugin}.
- *
- * @property {Object} [options.precacheFallback]
- *
- * @property {string} [options.precacheFallback.fallbackURL] The `fallbackURL`
- * property to use when creating the
- * [`PrecacheFallbackPlugin`]{@link module:workbox-precaching.PrecacheFallbackPlugin}.
- *
- * @property {boolean} [options.rangeRequests] Set to `true` to add the
- * [`RangeRequestsPlugin`]{@link module:workbox-range-requests.RangeRequestsPlugin}
- * for the strategy being configured.
- *
- * @property {Object} [options.matchOptions] The `matchOptions` property value
- * to use when constructing one of the
- * [Workbox strategy classes]{@link module:workbox-strategies}.
- *
- * @property {number} [options.networkTimeoutSeconds] The
- * `networkTimeoutSeconds` property value to use when creating a
- * [`NetworkFirst`]{@link module:workbox-strategies.NetworkFirst} strategy.
- *
- * @property {Array<Object>} [options.plugins]
- * One or more [additional plugins](https://developers.google.com/web/tools/workbox/guides/using-plugins#custom_plugins)
- * to apply to the handler. Useful when you want a plugin that doesn't have a
- * "shortcut" configuration.
- */

package/src/index.next.ts

@@ -1,3 +0,0 @@
-import { validateNextInjectManifestOptions } from "./lib/validate-next-options.js";
-
-export { validateNextInjectManifestOptions };

package/src/lib/validate-next-options.ts

@@ -1,14 +0,0 @@
-import { nextInjectManifestOptions } from "../schema/next.js";
-import { validationErrorMap } from "../schema/validationErrorMap.js";
-import type { NextInjectManifestOptionsComplete } from "../types.js";
-import { SerwistConfigError } from "./serwist-config-error.js";
-
-export const validateNextInjectManifestOptions = (input: unknown): NextInjectManifestOptionsComplete => {
-  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;
-};

package/src/schema/next.ts

@@ -1,33 +0,0 @@
-import { z } from "zod";
-import type {
-  NextInjectManifestOptions,
-  NextInjectManifestOptionsComplete,
-  NextInjectManifestPartial,
-  NextInjectManifestResolved,
-} from "../types.js";
-import { type Equals, assertType } from "./assertType.js";
-import { requiredSwDestPartial } from "./swDest.js";
-import { webpackInjectManifestOptions } from "./webpack.js";
-
-export 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!");
-
-export const nextInjectManifestOptions = webpackInjectManifestOptions
-  .merge(requiredSwDestPartial)
-  .merge(nextInjectManifestPartial)
-  .omit({ disablePrecacheManifest: true })
-  .strict("Do not pass invalid properties to NextInjectManifestOptions!");
-
-assertType<Equals<NextInjectManifestPartial, z.input<typeof nextInjectManifestPartial>>>();
-assertType<Equals<NextInjectManifestResolved, z.output<typeof nextInjectManifestPartial>>>();
-assertType<Equals<NextInjectManifestOptions, z.input<typeof nextInjectManifestOptions>>>();
-assertType<Equals<NextInjectManifestOptionsComplete, z.output<typeof nextInjectManifestOptions>>>();

package/src/schema/vite.ts

@@ -1,18 +0,0 @@
-import type { z } from "zod";
-import type { ViteInjectManifestOptions, ViteInjectManifestOptionsComplete } from "../types.js";
-import { type Equals, assertType } from "./assertType.js";
-import { basePartial } from "./base.js";
-import { globPartial } from "./glob.js";
-import { requiredGlobDirectoryPartial } from "./glob.js";
-import { injectPartial } from "./injectManifest.js";
-import { requiredSwDestPartial } from "./swDest.js";
-
-export const viteInjectManifestOptions = basePartial
-  .merge(globPartial)
-  .merge(injectPartial)
-  .merge(requiredSwDestPartial)
-  .merge(requiredGlobDirectoryPartial)
-  .strict("Do not pass invalid properties to ViteInjectManifestPartial!");
-
-assertType<Equals<ViteInjectManifestOptions, z.input<typeof viteInjectManifestOptions>>>();
-assertType<Equals<ViteInjectManifestOptionsComplete, z.output<typeof viteInjectManifestOptions>>>();

package/src/schema/webpack.ts

@@ -1,47 +0,0 @@
-import { z } from "zod";
-import type {
-  WebpackInjectManifestOptions,
-  WebpackInjectManifestOptionsComplete,
-  WebpackInjectManifestPartial,
-  WebpackInjectManifestResolved,
-  WebpackPartial,
-  WebpackResolved,
-} from "../types.js";
-import { type Equals, assertType } from "./assertType.js";
-import { basePartial } from "./base.js";
-import { injectPartial } from "./injectManifest.js";
-import { optionalSwDestPartial } from "./swDest.js";
-
-export 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(),
-    mode: z.string().nullable().optional(),
-  })
-  .strict("Do not pass invalid properties to WebpackPartial!");
-
-export 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!");
-
-export const webpackInjectManifestOptions = basePartial
-  .merge(webpackPartial)
-  .merge(injectPartial)
-  .merge(optionalSwDestPartial)
-  .merge(webpackInjectManifestPartial)
-  .strict("Do not pass invalid properties to WebpackInjectManifestOptions!");
-
-assertType<Equals<WebpackPartial, z.input<typeof webpackPartial>>>();
-assertType<Equals<WebpackResolved, z.output<typeof webpackPartial>>>();
-assertType<Equals<WebpackInjectManifestPartial, z.input<typeof webpackInjectManifestPartial>>>();
-assertType<Equals<WebpackInjectManifestResolved, z.output<typeof webpackInjectManifestPartial>>>();
-assertType<Equals<WebpackInjectManifestOptions, z.input<typeof webpackInjectManifestOptions>>>();
-assertType<Equals<WebpackInjectManifestOptionsComplete, z.output<typeof webpackInjectManifestOptions>>>();

package/dist/chunks/{serwist-config-error.js → validationErrorMap.js}

@@ -1,5 +1,12 @@
 import { z } from 'zod';
 
+class SerwistConfigError extends Error {
+    constructor({ moduleName, message }){
+        super(`Received an invalid ${moduleName ?? "Serwist"} configuration: ${message}`);
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+
 const validationErrorMap = (error, ctx)=>{
     switch(error.code){
         case z.ZodIssueCode.invalid_type:
@@ -44,11 +51,4 @@ const validationErrorMap = (error, ctx)=>{
     };
 };
 
-class SerwistConfigError extends Error {
-    constructor({ moduleName, message }){
-        super(`Received an invalid ${moduleName ?? "Serwist"} configuration: ${message}`);
-        Object.setPrototypeOf(this, new.target.prototype);
-    }
-}
-
 export { SerwistConfigError as S, validationErrorMap as v };