shelving 1.133.0 → 1.134.1

package/error/CodedError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Error with a `.code` field and a `.details` field to provide context about what went wrong.
+ * - Code should be a `number` in the range of 400-599
+ * - Details are appended to `.message` in the format `message: debuggedContext`
+ * - Details are converted to string using `debug()`
+ */
+export declare class CodedError extends Error {
+    /** Number in the range of 400-599, roughly corresponding to HTTP error codes. */
+    readonly code: number;
+    /** Details about the error, which are appended to the message. */
+    readonly details: unknown;
+    constructor(message?: string, details?: unknown);
+}

package/error/CodedError.js

@@ -0,0 +1,21 @@
+import { debug } from "../util/debug.js";
+/**
+ * Error with a `.code` field and a `.details` field to provide context about what went wrong.
+ * - Code should be a `number` in the range of 400-599
+ * - Details are appended to `.message` in the format `message: debuggedContext`
+ * - Details are converted to string using `debug()`
+ */
+export class CodedError extends Error {
+    /** Number in the range of 400-599, roughly corresponding to HTTP error codes. */
+    code = 500;
+    /** Details about the error, which are appended to the message. */
+    details;
+    constructor(message = CodedError.prototype.message, details) {
+        const debugged = details !== undefined ? debug(details, 2) : "";
+        super(debugged.length ? `${message}: ${debugged}` : message);
+        this.details = details;
+        Error.captureStackTrace(this, CodedError);
+    }
+}
+CodedError.prototype.name = "CodedError";
+CodedError.prototype.message = "Internal error";

package/error/ConflictError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if the state of the program is not correct to execute a given operation. */
-export declare class ConflictError extends EnhancedError {
+export declare class ConflictError extends CodedError {
     readonly code = 509;
     constructor(message?: string, context?: unknown);
 }

package/error/ConflictError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if the state of the program is not correct to execute a given operation. */
-export class ConflictError extends EnhancedError {
+export class ConflictError extends CodedError {
     code = 509;
-    constructor(message = "Conflict", context) {
+    constructor(message = ConflictError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, ConflictError);
     }
 }
 ConflictError.prototype.name = "ConflictError";
+ConflictError.prototype.message = "Conflict";

package/error/ConnectionError.d.ts

@@ -1,5 +1,5 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if e.g. a user's internet connection fails. */
-export declare class ConnectionError extends EnhancedError {
+export declare class ConnectionError extends CodedError {
     constructor(message?: string, context?: unknown);
 }

package/error/ConnectionError.js

@@ -1,8 +1,10 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if e.g. a user's internet connection fails. */
-export class ConnectionError extends EnhancedError {
-    constructor(message = "Connection error", context) {
+export class ConnectionError extends CodedError {
+    constructor(message = ConnectionError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, ConnectionError);
     }
 }
 ConnectionError.prototype.name = "ConnectionError";
+ConnectionError.prototype.message = "Connection error";

package/error/ForbiddenError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
-export declare class ForbiddenError extends EnhancedError {
+export declare class ForbiddenError extends CodedError {
     readonly code = 403;
     constructor(message?: string, context?: unknown);
 }

package/error/ForbiddenError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
-export class ForbiddenError extends EnhancedError {
+export class ForbiddenError extends CodedError {
     code = 403;
-    constructor(message = "Forbidden", context) {
+    constructor(message = ForbiddenError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, ForbiddenError);
     }
 }
 ForbiddenError.prototype.name = "ForbiddenError";
+ForbiddenError.prototype.message = "Forbidden";

package/error/NotFoundError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if if a value is required but doesn't exist. */
-export declare class NotFoundError extends EnhancedError {
+export declare class NotFoundError extends CodedError {
     readonly code = 404;
     constructor(message?: string, context?: unknown);
 }

package/error/NotFoundError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if if a value is required but doesn't exist. */
-export class NotFoundError extends EnhancedError {
+export class NotFoundError extends CodedError {
     code = 404;
-    constructor(message = "Not found", context) {
+    constructor(message = NotFoundError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, NotFoundError);
     }
 }
 NotFoundError.prototype.name = "NotFoundError";
+NotFoundError.prototype.message = "Not found";

package/error/NotImplementedError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Error thrown when functionality is called but is not implemented by an interface. */
-export declare class NotImplementedError extends EnhancedError {
+export declare class NotImplementedError extends CodedError {
     readonly code = 501;
     constructor(message?: string, value?: unknown);
 }

package/error/NotImplementedError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Error thrown when functionality is called but is not implemented by an interface. */
-export class NotImplementedError extends EnhancedError {
+export class NotImplementedError extends CodedError {
     code = 501;
-    constructor(message = "Not implemented", value) {
+    constructor(message = NotImplementedError.prototype.message, value) {
         super(message, value);
+        Error.captureStackTrace(this, NotImplementedError);
     }
 }
 NotImplementedError.prototype.name = "NotImplementedError";
+NotImplementedError.prototype.message = "Not implemented";

package/error/UnauthorizedError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
-export declare class UnauthorizedError extends EnhancedError {
+export declare class UnauthorizedError extends CodedError {
     readonly code = 401;
     constructor(message?: string, context?: unknown);
 }

package/error/UnauthorizedError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
-export class UnauthorizedError extends EnhancedError {
+export class UnauthorizedError extends CodedError {
     code = 401;
-    constructor(message = "Unauthorized", context) {
+    constructor(message = UnauthorizedError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, UnauthorizedError);
     }
 }
 UnauthorizedError.prototype.name = "UnauthorizedError";
+UnauthorizedError.prototype.message = "Unauthorized";

package/error/ValidationError.d.ts

@@ -1,6 +1,6 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Error thrown when a value isn't valid. */
-export declare class ValidationError extends EnhancedError {
+export declare class ValidationError extends CodedError {
     readonly code = 422;
     constructor(message?: string, context?: unknown);
 }

package/error/ValidationError.js

@@ -1,9 +1,11 @@
-import { EnhancedError } from "./EnhancedError.js";
+import { CodedError } from "./CodedError.js";
 /** Error thrown when a value isn't valid. */
-export class ValidationError extends EnhancedError {
+export class ValidationError extends CodedError {
     code = 422;
-    constructor(message = "Invalid value", context) {
+    constructor(message = ValidationError.prototype.message, context) {
         super(message, context);
+        Error.captureStackTrace(this, ValidationError);
     }
 }
 ValidationError.prototype.name = "ValidationError";
+ValidationError.prototype.message = "Invalid input";

package/error/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./EnhancedError.js";
+export * from "./CodedError.js";
 export * from "./ConflictError.js";
 export * from "./ConnectionError.js";
 export * from "./ForbiddenError.js";

package/error/index.js

@@ -1,4 +1,4 @@
-export * from "./EnhancedError.js";
+export * from "./CodedError.js";
 export * from "./ConflictError.js";
 export * from "./ConnectionError.js";
 export * from "./ForbiddenError.js";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.133.0",
+	"version": "1.134.1",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/error/EnhancedError.d.ts

@@ -1,10 +0,0 @@
-/**
- * Error with a `.context` field to provide information about what went wrong.
- * - Context is appended to `.message` in the format `message: debuggedContext`
- * - Context is converted to a string using `debug()`
- */
-export declare class EnhancedError extends Error {
-    readonly code: number;
-    readonly context: unknown;
-    constructor(message: string, context?: unknown);
-}

package/error/EnhancedError.js

@@ -1,16 +0,0 @@
-import { debug } from "../util/debug.js";
-/**
- * Error with a `.context` field to provide information about what went wrong.
- * - Context is appended to `.message` in the format `message: debuggedContext`
- * - Context is converted to a string using `debug()`
- */
-export class EnhancedError extends Error {
-    code = 500;
-    context;
-    constructor(message, context) {
-        const debugged = context !== undefined ? debug(context, 2) : "";
-        super(debugged.length ? `${message}: ${debugged}` : message);
-        this.context = context;
-    }
-}
-EnhancedError.prototype.name = "EnhancedError";

package/error/ThroughError.d.ts

@@ -1,7 +0,0 @@
-/**
- * Thrown to wrap an error with another error.
- * - Merges the message and stack of the previous message.
- */
-export declare class ThroughError extends Error {
-    constructor(message: string, cause: unknown);
-}

package/error/ThroughError.js

@@ -1,13 +0,0 @@
-import { debug } from "../util/debug.js";
-/**
- * Thrown to wrap an error with another error.
- * - Merges the message and stack of the previous message.
- */
-export class ThroughError extends Error {
-    constructor(message, cause) {
-        super(message);
-        this.cause = cause;
-        this.stack = `${this.stack || ""}\nCause: ${cause instanceof Error ? cause.stack || "" : debug(cause)}`;
-    }
-}
-ThroughError.prototype.name = "ThroughError";