ts-service-worker 1.3.2 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-service-worker",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Generate caching service-worker.js using declarative Typescript. Copyright (c) 2023-2025 NDP Software. All Rights Reserved.",
   "author": {
     "name": "Andrew Peterson, NDP Software",
@@ -32,9 +32,9 @@
     "types"
   ],
   "scripts": {
-    "example1": "node --loader tsx example/amp-what-sw.mts",
+    "example1": "node --import tsx example/amp-what-sw.mts",
     "example2": "./dist/cli.mjs example/offline-backup.json",
-    "test": "node --test --loader tsx src/specs/*.mts",
+    "test": "node --test --import tsx src/specs/*.mts",
     "build": "npm run clean && npm run build-dist && npm run build-bin && npm run build-types",
     "clean": "rm -fr ./dist/* ./types/*",
     "build-dist": "./node_modules/.bin/esbuild --target=esnext --outfile=./dist/index.js --bundle --platform=node --sourcemap --format=cjs src/index.mts",
@@ -43,15 +43,15 @@
     "prepublishOnly": "npm run build"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=22"
   },
   "devDependencies": {
     "@types/node": "*",
-    "typescript": "*",
     "esbuild": "*",
-    "tsx": "*"
+    "tsx": "*",
+    "typescript": "*"
   },
   "dependencies": {
-    "glob": "^10.3.10"
+    "glob": "*"
   }
 }

package/types/generate.d.mts

@@ -5,6 +5,7 @@ export type Options = {
     version?: Version;
     debug?: boolean;
     skipWaiting?: boolean;
+    compact?: boolean;
 };
 /**
  * Produce a string that contains Javascript code to implement
@@ -17,13 +18,15 @@ export type Options = {
  * - `debug`: true will generate `console.log` notices for
  *    all activity in the service worker. It should be turned off in production.
  * - `skipWaiting`: setting to `true` has the same effect as
- *    calling the method as described in the service worker documention (but simpler!).
+ *    calling the method as described in the service worker documention
+ *    (but simpler!).
+ * = `compact`: output with fewer line feeds and spaces
  */
 export declare function generateServiceWorker(inputSpec: Plan, optionsIn?: Options): string;
 export declare function generateVersion(version: Version): string;
 export declare function cacheName(version: Version): string;
 export declare function generateCacheName(version: Version): string;
 export declare function generateFlag(name: string, bool: boolean): string;
-export declare function pathsToJS(paths: InputPaths): string;
-export declare function pathToJS(path: string | RegExp | symbol): string;
+export declare function pathsToJS(paths: InputPaths | Array<InputPaths>, compact: boolean): string;
+export declare function pathToJS(path: InputPaths): string;
 export {};

package/types/requestHandler.d.mts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { IncomingMessage, ServerResponse } from "http";
 import { Options, Plan } from "./generate.mjs";
 export declare const requestHandler: (plan: Plan, options: Options) => (req: IncomingMessage, res: ServerResponse) => void;

package/types/strategies.d.mts

@@ -78,6 +78,9 @@ export type NetworkOnlyStrategy<Paths> = {
     paths: Paths;
 };
 export type RoutableStrategy<Paths> = CacheFirstStrategy<Paths> | NetworkFirstStrategy<Paths> | StaleWhileRevalidateStrategy<Paths> | NetworkOnlyStrategy<Paths> | StaticOfflineBackupStrategy<Paths>;
+export declare function isRoutableStrategy<Paths>(x: {
+    strategy: string;
+}): x is RoutableStrategy<Paths>;
 export type CacheOnInstallStrategy = CachePathOnInstall | CacheFileOnInstall;
 export type InputCacheStrategy = RoutableStrategy<InputPaths> | CacheOnInstallStrategy;
 export type InputCacheStrategyAsPaths = RoutableStrategy<InputPaths> | CachePathOnInstall;
@@ -92,12 +95,20 @@ export declare const OriginAndBelow: unique symbol;
  * for completeness.
  */
 export declare const ScopeAndBelow: unique symbol;
-export type InputPaths = RegExp | string | OutputPaths | typeof OriginAndBelow | typeof ScopeAndBelow;
+export type InputPaths = RegExp | string | typeof OriginAndBelow | typeof ScopeAndBelow | OutputPaths;
 export type OutputPaths = Array<string | RegExp>;
-export declare function isRoutableStrategy<Paths>(x: {
+/**
+ * Run through all the strategies in a plan and extract all
+ * the paths that should be "preloaded" on service worker
+ * installation. This includes explicit preload paths,
+ * preload-files (which have been converted to paths before
+ * this call), and offline backup paths.
+ */
+export declare function extractAllPreloadPaths(plan: Array<{
     strategy: string;
-}): x is RoutableStrategy<Paths>;
-export declare function convertPreloadFilesToPaths(strategy: CacheFileOnInstall): CachePathOnInstall;
+}>): OutputPaths;
+export declare function convertPreloadPathsToCacheFirst(spec: Array<InputCacheStrategyAsPaths>): Array<RoutableStrategy<InputPaths>>;
+export declare function convertAllFilesToPaths(spec: Array<InputCacheStrategy>): Array<InputCacheStrategyAsPaths>;
 /**
  * Converts paths specified by scanning the disk to the paths
  * that are the result of that scan.
@@ -112,15 +123,4 @@ export declare function convertPreloadFilesToPaths(strategy: CacheFileOnInstall)
  * cache created in the browser.
  */
 export declare function convertPreloadFiles(strategy: InputCacheStrategy): InputCacheStrategyAsPaths;
-/**
- * Run through all the strategies in a plan and extract all
- * the paths that should be "preloaded" on service worker
- * installation. This includes explicit preload paths,
- * preload-files (which have been converted to paths before
- * this call), and offline backup paths.
- */
-export declare function extractAllPreloadPaths(plan: Array<{
-    strategy: string;
-}>): OutputPaths;
-export declare function convertPreloadPathsToCacheFirst(spec: Array<InputCacheStrategyAsPaths>): Array<RoutableStrategy<InputPaths>>;
-export declare function convertAllFilesToPaths(spec: Array<InputCacheStrategy>): Array<InputCacheStrategyAsPaths>;
+export declare function convertPreloadFilesToPaths(strategy: CacheFileOnInstall): CachePathOnInstall;