@serwist/core 9.0.0-preview.3 → 9.0.0-preview.5

package/dist/_private/SerwistError.d.ts

@@ -1,3 +1,4 @@
+import type { MessageKey } from "../models/messages/messages.js";
 import type { MapLikeObject } from "../types.js";
 /**
  * Serwist errors should be thrown with this class.
@@ -18,7 +19,7 @@ declare class SerwistError extends Error {
      * that will help developers identify issues should
      * be added as a key on the context object.
      */
-    constructor(errorCode: string, details?: MapLikeObject);
+    constructor(errorCode: MessageKey, details?: MapLikeObject);
 }
 export { SerwistError };
 //# sourceMappingURL=SerwistError.d.ts.map

package/dist/_private/SerwistError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerwistError.d.ts","sourceRoot":"","sources":["../../src/_private/SerwistError.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD;;;;;;;;GAQG;AACH,cAAM,YAAa,SAAQ,KAAK;IAC9B,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;;;;;OAOG;gBACS,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAQvD;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"SerwistError.d.ts","sourceRoot":"","sources":["../../src/_private/SerwistError.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD;;;;;;;;GAQG;AACH,cAAM,YAAa,SAAQ,KAAK;IAC9B,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;;;;;OAOG;gBACS,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;CAQ3D;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/_private/logger.d.ts

@@ -6,6 +6,13 @@ declare global {
         __WB_DISABLE_DEV_LOGS: boolean;
     }
 }
+/**
+ * The logger used by Serwist inside of both service workers and the window global scope.
+ *
+ * Note: This is forcibly `null` in production mode to reduce bundle size. Do check whether
+ * you are currently in development mode (by using `process.env.NODE_ENV !== "production"`)
+ * before using it.
+ */
 export declare const logger: {
     error: (...args: any[]) => void;
     debug: (...args: any[]) => void;

package/dist/_private/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/_private/logger.ts"],"names":[],"mappings":"AAQA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB;QACzB,qBAAqB,EAAE,OAAO,CAAC;KAChC;IAED,UAAU,MAAM;QACd,qBAAqB,EAAE,OAAO,CAAC;KAChC;CACF;AAED,eAAO,MAAM,MAAM;qBAmEoC,GAAG,EAAE,KAAK,IAAI;qBAAd,GAAG,EAAE,KAAK,IAAI;mBAAd,GAAG,EAAE,KAAK,IAAI;oBAAd,GAAG,EAAE,KAAK,IAAI;8BAAd,GAAG,EAAE,KAAK,IAAI;wBAAd,GAAG,EAAE,KAAK,IAAI;CAE3D,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/_private/logger.ts"],"names":[],"mappings":"AAQA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB;QACzB,qBAAqB,EAAE,OAAO,CAAC;KAChC;IAED,UAAU,MAAM;QACd,qBAAqB,EAAE,OAAO,CAAC;KAChC;CACF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,MAAM;qBAmEoC,GAAG,EAAE,KAAK,IAAI;qBAAd,GAAG,EAAE,KAAK,IAAI;mBAAd,GAAG,EAAE,KAAK,IAAI;oBAAd,GAAG,EAAE,KAAK,IAAI;8BAAd,GAAG,EAAE,KAAK,IAAI;wBAAd,GAAG,EAAE,KAAK,IAAI;CAE3D,CAAC"}

package/dist/chunks/quotaErrorCallbacks.js

@@ -92,7 +92,7 @@ const messages = {
         if (!thrownErrorMessage) {
             throw new Error("Unexpected input to " + `'plugin-error-request-will-fetch', error.`);
         }
-        return `An error was thrown by a plugins 'requestWillFetch()' method. The thrown error message was: '${thrownErrorMessage}'.`;
+        return `An error was thrown by a plugin's 'requestWillFetch()' method. The thrown error message was: '${thrownErrorMessage}'.`;
     },
     "invalid-cache-name": ({ cacheNameId, value })=>{
         if (!cacheNameId) {

package/dist/models/messages/messageGenerator.d.ts

@@ -1,2 +1,4 @@
-export declare const messageGenerator: ((code: string, ...args: any[]) => string) | ((code: string, details?: {}) => string);
+import type { MapLikeObject } from "../../types.js";
+import { type MessageKey } from "./messages.js";
+export declare const messageGenerator: ((code: string, ...args: any[]) => string) | ((code: MessageKey, details?: MapLikeObject) => string);
 //# sourceMappingURL=messageGenerator.d.ts.map

package/dist/models/messages/messageGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messageGenerator.d.ts","sourceRoot":"","sources":["../../../src/models/messages/messageGenerator.ts"],"names":[],"mappings":"AA2BA,eAAO,MAAM,gBAAgB,UAjBL,MAAM,WAAW,GAAG,EAAE,uBAQb,MAAM,0BAS6D,CAAC"}
+{"version":3,"file":"messageGenerator.d.ts","sourceRoot":"","sources":["../../../src/models/messages/messageGenerator.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,eAAe,CAAC;AAmB1D,eAAO,MAAM,gBAAgB,UAjBL,MAAM,WAAW,GAAG,EAAE,uBAQb,UAAU,YAAW,aAAa,YASiC,CAAC"}

package/dist/models/messages/messages.d.ts

@@ -1,9 +1,44 @@
 interface LoggableObject {
     [key: string]: string | number;
 }
-interface MessageMap {
-    [messageID: string]: (param: LoggableObject) => string;
-}
-export declare const messages: MessageMap;
+export declare const messages: {
+    "invalid-value": ({ paramName, validValueDescription, value }: LoggableObject) => string;
+    "not-an-array": ({ moduleName, className, funcName, paramName }: LoggableObject) => string;
+    "incorrect-type": ({ expectedType, paramName, moduleName, className, funcName }: LoggableObject) => string;
+    "incorrect-class": ({ expectedClassName, paramName, moduleName, className, funcName, isReturnValueProblem }: LoggableObject) => string;
+    "missing-a-method": ({ expectedMethod, paramName, moduleName, className, funcName }: LoggableObject) => string;
+    "add-to-cache-list-unexpected-type": ({ entry }: LoggableObject) => string;
+    "add-to-cache-list-conflicting-entries": ({ firstEntry, secondEntry }: LoggableObject) => string;
+    "plugin-error-request-will-fetch": ({ thrownErrorMessage }: LoggableObject) => string;
+    "invalid-cache-name": ({ cacheNameId, value }: LoggableObject) => string;
+    "unregister-route-but-not-found-with-method": ({ method }: LoggableObject) => string;
+    "unregister-route-route-not-registered": () => string;
+    "queue-replay-failed": ({ name }: LoggableObject) => string;
+    "duplicate-queue-name": ({ name }: LoggableObject) => string;
+    "expired-test-without-max-age": ({ methodName, paramName }: LoggableObject) => string;
+    "unsupported-route-type": ({ moduleName, className, funcName, paramName }: LoggableObject) => string;
+    "not-array-of-class": ({ value, expectedClass, moduleName, className, funcName, paramName }: LoggableObject) => string;
+    "max-entries-or-age-required": ({ moduleName, className, funcName }: LoggableObject) => string;
+    "statuses-or-headers-required": ({ moduleName, className, funcName }: LoggableObject) => string;
+    "invalid-string": ({ moduleName, funcName, paramName }: LoggableObject) => string;
+    "channel-name-required": () => string;
+    "invalid-responses-are-same-args": () => string;
+    "expire-custom-caches-only": () => string;
+    "unit-must-be-bytes": ({ normalizedRangeHeader }: LoggableObject) => string;
+    "single-range-only": ({ normalizedRangeHeader }: LoggableObject) => string;
+    "invalid-range-values": ({ normalizedRangeHeader }: LoggableObject) => string;
+    "no-range-header": () => string;
+    "range-not-satisfiable": ({ size, start, end }: LoggableObject) => string;
+    "attempt-to-cache-non-get-request": ({ url, method }: LoggableObject) => string;
+    "cache-put-with-no-response": ({ url }: LoggableObject) => string;
+    "no-response": ({ url, error }: LoggableObject) => string;
+    "bad-precaching-response": ({ url, status }: LoggableObject) => string;
+    "non-precached-url": ({ url }: LoggableObject) => string;
+    "add-to-cache-list-conflicting-integrities": ({ url }: LoggableObject) => string;
+    "missing-precache-entry": ({ cacheName, url }: LoggableObject) => string;
+    "cross-origin-copy-response": ({ origin }: LoggableObject) => string;
+    "opaque-streams-source": ({ type }: LoggableObject) => string;
+};
+export type MessageKey = keyof typeof messages;
 export {};
 //# sourceMappingURL=messages.d.ts.map

package/dist/models/messages/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/models/messages/messages.ts"],"names":[],"mappings":"AAQA,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AACD,UAAU,UAAU;IAClB,CAAC,SAAS,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,MAAM,CAAC;CACxD;AAED,eAAO,MAAM,QAAQ,EAAE,UAuNtB,CAAC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/models/messages/messages.ts"],"names":[],"mappings":"AAQA,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAKD,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuNC,CAAC;AAEvB,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/core",
-  "version": "9.0.0-preview.3",
+  "version": "9.0.0-preview.5",
   "type": "module",
   "description": "This module is used by a number of the other Serwist modules to share common code.",
   "files": [
@@ -40,7 +40,7 @@
   "devDependencies": {
     "rollup": "4.9.6",
     "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.3"
+    "@serwist/constants": "9.0.0-preview.5"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/_private/SerwistError.ts

@@ -7,6 +7,7 @@
 */
 
 import { messageGenerator } from "../models/messages/messageGenerator.js";
+import type { MessageKey } from "../models/messages/messages.js";
 import type { MapLikeObject } from "../types.js";
 
 /**
@@ -29,7 +30,7 @@ class SerwistError extends Error {
    * that will help developers identify issues should
    * be added as a key on the context object.
    */
-  constructor(errorCode: string, details?: MapLikeObject) {
+  constructor(errorCode: MessageKey, details?: MapLikeObject) {
     const message = messageGenerator(errorCode, details);
 
     super(message);

package/src/_private/logger.ts

@@ -16,6 +16,13 @@ declare global {
   }
 }
 
+/**
+ * The logger used by Serwist inside of both service workers and the window global scope.
+ *
+ * Note: This is forcibly `null` in production mode to reduce bundle size. Do check whether
+ * you are currently in development mode (by using `process.env.NODE_ENV !== "production"`)
+ * before using it.
+ */
 export const logger =
   process.env.NODE_ENV === "production"
     ? null!

package/src/models/messages/messageGenerator.ts

@@ -6,7 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { messages } from "./messages.js";
+import type { MapLikeObject } from "../../types.js";
+import { type MessageKey, messages } from "./messages.js";
 
 const fallback = (code: string, ...args: any[]) => {
   let msg = code;
@@ -16,7 +17,7 @@ const fallback = (code: string, ...args: any[]) => {
   return msg;
 };
 
-const generatorFunction = (code: string, details = {}) => {
+const generatorFunction = (code: MessageKey, details: MapLikeObject = {}) => {
   const message = messages[code];
   if (!message) {
     throw new Error(`Unable to find message for code '${code}'.`);

package/src/models/messages/messages.ts

@@ -13,7 +13,7 @@ interface MessageMap {
   [messageID: string]: (param: LoggableObject) => string;
 }
 
-export const messages: MessageMap = {
+export const messages = {
   "invalid-value": ({ paramName, validValueDescription, value }) => {
     if (!paramName || !validValueDescription) {
       throw new Error(`Unexpected input to 'invalid-value' error.`);
@@ -82,7 +82,7 @@ export const messages: MessageMap = {
       throw new Error("Unexpected input to " + `'plugin-error-request-will-fetch', error.`);
     }
 
-    return `An error was thrown by a plugins 'requestWillFetch()' method. The thrown error message was: '${thrownErrorMessage}'.`;
+    return `An error was thrown by a plugin's 'requestWillFetch()' method. The thrown error message was: '${thrownErrorMessage}'.`;
   },
 
   "invalid-cache-name": ({ cacheNameId, value }) => {
@@ -228,4 +228,6 @@ export const messages: MessageMap = {
     }
     return `${message} Please ensure your sources are CORS-enabled.`;
   },
-};
+} satisfies MessageMap;
+
+export type MessageKey = keyof typeof messages;