@alessiofrittoli/exception 3.5.0 → 4.1.0

package/dist/index.d.cts

@@ -0,0 +1,177 @@
+import { ErrorCode } from "./code/index.cjs";
+//#region src/error-names.d.ts
+/**
+ * Exception Name.
+ *
+ * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/DOMException#error_names)
+ */
+export declare const ExceptionName: {
+  readonly Exception: "Exception";
+  readonly AbortError: "AbortError";
+  readonly NotAllowedError: "NotAllowedError";
+  readonly NotFoundError: "NotFoundError";
+  readonly NotSupportedError: "NotSupportedError";
+  readonly InvalidStateError: "InvalidStateError";
+  readonly InvalidAccessError: "InvalidAccessError";
+  readonly NetworkError: "NetworkError";
+  readonly SecurityError: "SecurityError";
+  readonly TimeoutError: "TimeoutError";
+  readonly QuotaExceededError: "QuotaExceededError";
+  readonly DataError: "DataError";
+  readonly EncodingError: "EncodingError";
+  readonly OperationError: "OperationError";
+  readonly ConstraintError: "ConstraintError";
+  readonly TransactionInactiveError: "TransactionInactiveError";
+  readonly ReadOnlyError: "ReadOnlyError";
+  readonly VersionError: "VersionError";
+  readonly NoModificationAllowedError: "NoModificationAllowedError";
+  readonly HierarchyRequestError: "HierarchyRequestError";
+  readonly WrongDocumentError: "WrongDocumentError";
+  readonly InvalidCharacterError: "InvalidCharacterError";
+  readonly NamespaceError: "NamespaceError";
+  readonly SyntaxError: "SyntaxError";
+  readonly DataCloneError: "DataCloneError";
+  readonly URLMismatchError: "URLMismatchError";
+  readonly InvalidModificationError: "InvalidModificationError";
+  readonly NotReadableError: "NotReadableError";
+};
+export type ExceptionName = (typeof ExceptionName)[keyof typeof ExceptionName];
+//#endregion
+//#region src/index.d.ts
+/**
+ * Interface representing the options for an Exception.
+ *
+ * @template T The type of the error code.
+ *
+ * @extends ErrorOptions
+ */
+export interface ExceptionOptions<T = ErrorCode> extends ErrorOptions {
+  /**
+   * The error interface name.
+   *
+   * @see {@link ExceptionName} for a list of possible standard values.
+   *
+   * @default ExceptionName.Exception
+   */
+  name?: string;
+  /**
+   * The error message containing technical informations about the error.
+   *
+   * It shouldn't be rendered to the user.
+   */
+  message?: string;
+  /**
+   * The error title.
+   *
+   */
+  title?: string;
+  /**
+   * The error description.
+   *
+   */
+  description?: string;
+  /**
+   * The error code associated with the Exception.
+   *
+   */
+  code: T;
+  /**
+   * Indicates whether the error is a critical error.
+   *
+   * @default false
+   */
+  isCritical?: boolean;
+  /**
+   * The HTTP status code associated with the Exception.
+   *
+   */
+  status?: number;
+  /**
+   * The error cause.
+   *
+   */
+  cause?: unknown;
+}
+/**
+ * Exception Class.
+ *
+ * @template T The type of the code property of the Exception. Defaults to `ErrorCode`.
+ *
+ * @extends Error
+ * @implements ExceptionOptions<T>
+ */
+export declare class Exception<T = ErrorCode> extends Error {
+  private readonly __typename;
+  /**
+   * The error interface name.
+   *
+   */
+  readonly name: string;
+  /**
+   * The error message containing technical informations about the error.
+   *
+   * ⚠️ do not render `Exception.message` to the user.
+   */
+  readonly message: string;
+  /**
+   * The error title that can be rendered to the user.
+   *
+   */
+  readonly title: string | undefined;
+  /**
+   * The error description that can be rendered to the user.
+   *
+   */
+  readonly description: string | undefined;
+  /**
+   * The error code.
+   *
+   */
+  readonly code: T;
+  /**
+   * Indicates whether the error is a critical error.
+   *
+   */
+  readonly isCritical: boolean;
+  /**
+   * The HTTP status code associated with the Exception.
+   *
+   */
+  readonly status: number | undefined;
+  /**
+   * The error cause.
+   *
+   */
+  readonly cause: unknown;
+  /**
+   * Constructs a new Exception instance.
+   *
+   * @param options An object defining Exception options. See {@link ExceptionOptions} for more info.
+   */
+  constructor(options: ExceptionOptions<T>);
+  /**
+   * Determines if the provided error is an instance of the Exception class.
+   *
+   * @template T The type of the code property of the Exception.
+   *
+   * @param error The error to check.
+   * @returns `true` if the error is an instance of Exception or has a `__typename` property equal to 'Exception', `false` otherwise.
+   */
+  static isException<T = ErrorCode>(error: any): error is Exception<T>;
+  /**
+   * Determines if the provided error is an instance of the Exception class and has the ABORT ErrorCode.
+   *
+   * @template T The type of the code property of the Exception.
+   *
+   * @param error The error to check.
+   * @returns `true` if the error is an `Exception` and has the ABORT ErrorCode, `false` otherwise.
+   */
+  static isAbortError<T = ErrorCode>(error: any, code?: T): error is Exception<T>;
+  /**
+   * Converts the instance to a JSON object.
+   *
+   * @returns A JSON representation of the instance, including the message property.
+   */
+  toJSON(): this;
+}
+//#endregion

package/dist/index.d.mts

@@ -1,71 +1,177 @@
-import { ErrorCode } from './code.mjs';
-
+import { ErrorCode } from "./code/index.mjs";
+//#region src/error-names.d.ts
+/**
+ * Exception Name.
+ *
+ * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/DOMException#error_names)
+ */
+export declare const ExceptionName: {
+  readonly Exception: "Exception";
+  readonly AbortError: "AbortError";
+  readonly NotAllowedError: "NotAllowedError";
+  readonly NotFoundError: "NotFoundError";
+  readonly NotSupportedError: "NotSupportedError";
+  readonly InvalidStateError: "InvalidStateError";
+  readonly InvalidAccessError: "InvalidAccessError";
+  readonly NetworkError: "NetworkError";
+  readonly SecurityError: "SecurityError";
+  readonly TimeoutError: "TimeoutError";
+  readonly QuotaExceededError: "QuotaExceededError";
+  readonly DataError: "DataError";
+  readonly EncodingError: "EncodingError";
+  readonly OperationError: "OperationError";
+  readonly ConstraintError: "ConstraintError";
+  readonly TransactionInactiveError: "TransactionInactiveError";
+  readonly ReadOnlyError: "ReadOnlyError";
+  readonly VersionError: "VersionError";
+  readonly NoModificationAllowedError: "NoModificationAllowedError";
+  readonly HierarchyRequestError: "HierarchyRequestError";
+  readonly WrongDocumentError: "WrongDocumentError";
+  readonly InvalidCharacterError: "InvalidCharacterError";
+  readonly NamespaceError: "NamespaceError";
+  readonly SyntaxError: "SyntaxError";
+  readonly DataCloneError: "DataCloneError";
+  readonly URLMismatchError: "URLMismatchError";
+  readonly InvalidModificationError: "InvalidModificationError";
+  readonly NotReadableError: "NotReadableError";
+};
+export type ExceptionName = (typeof ExceptionName)[keyof typeof ExceptionName];
+//#endregion
+//#region src/index.d.ts
 /**
  * Interface representing the options for an Exception.
  *
- * @template TCode The type of the error code.
+ * @template T The type of the error code.
+ *
  * @extends ErrorOptions
  */
-interface ExceptionOptions<TCode = ErrorCode> extends ErrorOptions {
-    /** The error code associated with the Exception. */
-    code: TCode;
-    /**  The name of the Exception. */
-    name?: string;
-    /** The HTTP status code associated with the Exception. */
-    status?: number;
+export interface ExceptionOptions<T = ErrorCode> extends ErrorOptions {
+  /**
+   * The error interface name.
+   *
+   * @see {@link ExceptionName} for a list of possible standard values.
+   *
+   * @default ExceptionName.Exception
+   */
+  name?: string;
+  /**
+   * The error message containing technical informations about the error.
+   *
+   * It shouldn't be rendered to the user.
+   */
+  message?: string;
+  /**
+   * The error title.
+   *
+   */
+  title?: string;
+  /**
+   * The error description.
+   *
+   */
+  description?: string;
+  /**
+   * The error code associated with the Exception.
+   *
+   */
+  code: T;
+  /**
+   * Indicates whether the error is a critical error.
+   *
+   * @default false
+   */
+  isCritical?: boolean;
+  /**
+   * The HTTP status code associated with the Exception.
+   *
+   */
+  status?: number;
+  /**
+   * The error cause.
+   *
+   */
+  cause?: unknown;
 }
 /**
  * Exception Class.
  *
- * @template TMessage	The type of the message property of the Exception. Defaults to `string`.
- * @template TCode		The type of the code property of the Exception. Defaults to `ErrorCode`.
+ * @template T The type of the code property of the Exception. Defaults to `ErrorCode`.
  *
  * @extends Error
- * @implements ExceptionOptions<TCode>
+ * @implements ExceptionOptions<T>
  */
-declare class Exception<TMessage = string, TCode = ErrorCode> extends Error implements ExceptionOptions<TCode> {
-    message: TMessage;
-    status: number | undefined;
-    name: string;
-    private __typename;
-    code: TCode;
-    /**
-     * Constructs a new Exception instance.
-     *
-     * @param message The message describing the exception.
-     * @param options Additional options for the exception.
-     */
-    constructor(message: TMessage, options: ExceptionOptions<TCode>);
-    /**
-     * Determines if the provided error is an instance of the Exception class.
-     *
-     * @template TMessage	The type of the message property of the Exception.
-     * @template TCode		The type of the code property of the Exception.
-     *
-     * @param	error The error to check.
-     * @returns	`true` if the error is an instance of Exception or has a `__typename` property equal to 'Exception', `false` otherwise.
-     */
-    static isException<TMessage = string, TCode = ErrorCode>(error: any): error is Exception<TMessage, TCode>;
-    /**
-     * Determines if the provided error is an instance of the Exception class and has the ABORT ErrorCode.
-     *
-     * This won't work for `new DOMException( 'Abort reason', 'AbortError' )` since we type guard the checked value to `Exception<TMessage, ErrorCode.ABORT>`.
-     *
-     * @template TMessage The type of the message property of the Exception.
-     *
-     * @param	error The error to check.
-     * @returns	`true` if the error is an `Exception` and has the ABORT ErrorCode, `false` otherwise.
-     */
-    static isAbortError<TMessage = string, TCode = ErrorCode>(error: any, code?: TCode): error is Exception<TMessage, TCode>;
-    /**
-     * Converts the instance to a JSON object.
-     *
-     * @returns A JSON representation of the instance, including the message property.
-     */
-    toJSON(): this & {
-        message: TMessage;
-        cause: unknown;
-    };
+export declare class Exception<T = ErrorCode> extends Error {
+  private readonly __typename;
+  /**
+   * The error interface name.
+   *
+   */
+  readonly name: string;
+  /**
+   * The error message containing technical informations about the error.
+   *
+   * ⚠️ do not render `Exception.message` to the user.
+   */
+  readonly message: string;
+  /**
+   * The error title that can be rendered to the user.
+   *
+   */
+  readonly title: string | undefined;
+  /**
+   * The error description that can be rendered to the user.
+   *
+   */
+  readonly description: string | undefined;
+  /**
+   * The error code.
+   *
+   */
+  readonly code: T;
+  /**
+   * Indicates whether the error is a critical error.
+   *
+   */
+  readonly isCritical: boolean;
+  /**
+   * The HTTP status code associated with the Exception.
+   *
+   */
+  readonly status: number | undefined;
+  /**
+   * The error cause.
+   *
+   */
+  readonly cause: unknown;
+  /**
+   * Constructs a new Exception instance.
+   *
+   * @param options An object defining Exception options. See {@link ExceptionOptions} for more info.
+   */
+  constructor(options: ExceptionOptions<T>);
+  /**
+   * Determines if the provided error is an instance of the Exception class.
+   *
+   * @template T The type of the code property of the Exception.
+   *
+   * @param error The error to check.
+   * @returns `true` if the error is an instance of Exception or has a `__typename` property equal to 'Exception', `false` otherwise.
+   */
+  static isException<T = ErrorCode>(error: any): error is Exception<T>;
+  /**
+   * Determines if the provided error is an instance of the Exception class and has the ABORT ErrorCode.
+   *
+   * @template T The type of the code property of the Exception.
+   *
+   * @param error The error to check.
+   * @returns `true` if the error is an `Exception` and has the ABORT ErrorCode, `false` otherwise.
+   */
+  static isAbortError<T = ErrorCode>(error: any, code?: T): error is Exception<T>;
+  /**
+   * Converts the instance to a JSON object.
+   *
+   * @returns A JSON representation of the instance, including the message property.
+   */
+  toJSON(): this;
 }
-
-export { Exception, type ExceptionOptions };
+//#endregion

package/dist/index.mjs

@@ -1 +1 @@
-import{a}from"./chunk-RAHIXT6K.mjs";import"./chunk-VBWDYSF3.mjs";export{a as Exception};
+import{ErrorCode as e}from"./code/index.mjs";const t={Exception:`Exception`,AbortError:`AbortError`,NotAllowedError:`NotAllowedError`,NotFoundError:`NotFoundError`,NotSupportedError:`NotSupportedError`,InvalidStateError:`InvalidStateError`,InvalidAccessError:`InvalidAccessError`,NetworkError:`NetworkError`,SecurityError:`SecurityError`,TimeoutError:`TimeoutError`,QuotaExceededError:`QuotaExceededError`,DataError:`DataError`,EncodingError:`EncodingError`,OperationError:`OperationError`,ConstraintError:`ConstraintError`,TransactionInactiveError:`TransactionInactiveError`,ReadOnlyError:`ReadOnlyError`,VersionError:`VersionError`,NoModificationAllowedError:`NoModificationAllowedError`,HierarchyRequestError:`HierarchyRequestError`,WrongDocumentError:`WrongDocumentError`,InvalidCharacterError:`InvalidCharacterError`,NamespaceError:`NamespaceError`,SyntaxError:`SyntaxError`,DataCloneError:`DataCloneError`,URLMismatchError:`URLMismatchError`,InvalidModificationError:`InvalidModificationError`,NotReadableError:`NotReadableError`};var n=class n extends Error{__typename=t.Exception;name=this.__typename;message;title;description;code;isCritical;status;cause;constructor(e){let{message:t=`Unknown error.`}=e;super(t),e.name&&(this.name=e.name),this.message=t,this.title=e.title,this.description=e.description,this.code=e.code,this.isCritical=e.isCritical??!1,this.status=e.status,this.cause=n.isException(e.cause)?new n(e.cause):e.cause}static isException(e){return e instanceof n||typeof e==`object`&&`__typename`in e&&e.__typename===t.Exception}static isAbortError(r,i=e.ABORT){return n.isException(r)&&(r.name===t.AbortError||r.code===i)}toJSON(){return{...this,message:this.message,cause:this.cause}}};export{n as Exception,t as ExceptionName};

package/license.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/package.json

@@ -1,112 +1,101 @@
 {
-	"name": "@alessiofrittoli/exception",
-	"version": "3.5.0",
-	"description": "Handle errors with ease",
-	"author": {
-		"name": "Alessio Frittoli",
-		"email": "info@alessiofrittoli.it",
-		"url": "https://alessiofrittoli.it"
-	},
-	"license": "MIT",
-	"funding": [
-		{
-			"type": "github",
-			"url": "https://github.com/sponsors/alessiofrittoli"
-		}
-	],
-	"keywords": [
-		"exceptions",
-		"errors"
-	],
-	"homepage": "https://github.com/alessiofrittoli/exception#readme",
-	"bugs": {
-		"url": "https://github.com/alessiofrittoli/exception/issues",
-		"email": "info@alessiofrittoli.it"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/alessiofrittoli/exception.git"
-	},
-	"main": "./dist/index.js",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.ts",
-	"files": [
-		"dist"
-	],
-	"exports": {
-		".": {
-			"import": {
-				"types": "./dist/index.d.mts",
-				"default": "./dist/index.mjs"
-			},
-			"require": {
-				"types": "./dist/index.d.ts",
-				"default": "./dist/index.js"
-			}
-		},
-		"./code": {
-			"import": {
-				"types": "./dist/code.d.mts",
-				"default": "./dist/code.mjs"
-			},
-			"require": {
-				"types": "./dist/code.d.ts",
-				"default": "./dist/code.js"
-			}
-		},
-		"./abort": {
-			"import": {
-				"types": "./dist/abort.d.mts",
-				"default": "./dist/abort.mjs"
-			},
-			"require": {
-				"types": "./dist/abort.d.ts",
-				"default": "./dist/abort.js"
-			}
-		}
-	},
-	"sideEffects": false,
-	"scripts": {
-		"//1a": "*********************************************************************",
-		"//1b": "******************** DEV - BUILD - LINT - RELEASE *******************",
-		"//1c": "*********************************************************************",
-		"dev": "cross-env NODE_ENV=development tsup --watch",
-		"build:prod": "cross-env NODE_ENV=production tsup",
-		"build": "pnpm lint && pnpm test:ci && pnpm build:prod",
-		"lint": "eslint",
-		"release": "node scripts/release.js --verbose --npm",
-		"//2a": "*********************************************************************",
-		"//2b": "***************************** UNIT TESTS ****************************",
-		"//2c": "*********************************************************************",
-		"test": "jest --verbose",
-		"test:watch": "jest --watchAll --verbose",
-		"test:ci": "jest --ci --verbose",
-		"//3a": "*********************************************************************",
-		"//3b": "************************ UNIT TESTS COVERAGE ************************",
-		"//3c": "*********************************************************************",
-		"test:coverage": "pnpm test:watch --coverage",
-		"test:coverage:ci": "pnpm test:ci --coverage",
-		"test:serve-coverage": "http-server ./coverage/lcov-report --gzip true -p 0 -o --silent",
-		"test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\""
-	},
-	"devDependencies": {
-		"@alessiofrittoli/node-scripts": "^3.3.0",
-		"@eslint/js": "^9.39.1",
-		"@jest/globals": "^30.2.0",
-		"@types/jest": "^30.0.0",
-		"@types/node": "^24.10.1",
-		"concurrently": "^9.2.1",
-		"cross-env": "^10.1.0",
-		"dotenv": "^17.2.3",
-		"esbuild": "0.27.1",
-		"eslint": "^9.39.1",
-		"globals": "^16.5.0",
-		"http-server": "^14.1.1",
-		"jest": "^30.2.0",
-		"ts-jest": "^29.4.6",
-		"ts-node": "^10.9.2",
-		"tsup": "^8.5.1",
-		"typescript": "^5.9.3",
-		"typescript-eslint": "^8.48.1"
-	}
-}
+  "name": "@alessiofrittoli/exception",
+  "version": "4.1.0",
+  "description": "Handle errors with ease",
+  "type": "module",
+  "author": {
+    "name": "Alessio Frittoli",
+    "email": "info@alessiofrittoli.it",
+    "url": "https://alessiofrittoli.it"
+  },
+  "license": "MIT",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/alessiofrittoli"
+    }
+  ],
+  "keywords": [
+    "exceptions",
+    "errors"
+  ],
+  "homepage": "https://github.com/alessiofrittoli/exception#readme",
+  "bugs": {
+    "url": "https://github.com/alessiofrittoli/exception/issues",
+    "email": "info@alessiofrittoli.it"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alessiofrittoli/exception.git"
+  },
+  "engines": {
+    "node": ">=24.15.0",
+    "pnpm": ">=11.27.1"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./*": {
+      "import": {
+        "types": "./dist/*/index.d.mts",
+        "default": "./dist/*/index.mjs"
+      },
+      "require": {
+        "types": "./dist/*/index.d.cts",
+        "default": "./dist/*/index.cjs"
+      }
+    }
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@alessiofrittoli/node-scripts": "4.0.0-alpha.3",
+    "@alessiofrittoli/package-configs": "1.6.0",
+    "@types/node": "^24.19.1",
+    "@vitest/coverage-v8": "^5.0.3",
+    "concurrently": "^9.2.1",
+    "http-server": "^14.1.1",
+    "oxlint": "^1.86.0",
+    "prettier": "^3.9.9",
+    "prettier-plugin-sort-imports": "^1.8.11",
+    "tsdown": "^0.23.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.3.2",
+    "vitest": "^5.0.3"
+  },
+  "scripts": {
+    "//1a": "*********************************************************************",
+    "//1b": "******************** DEV - BUILD - LINT - RELEASE *******************",
+    "//1c": "*********************************************************************",
+    "dev": "tsdown --watch",
+    "build": "pnpm lint && pnpm tsc && pnpm tsdown",
+    "lint": "oxlint --report-unused-disable-directives --max-warnings 0",
+    "release": "node scripts/release.ts --verbose --npm",
+    "//2a": "*********************************************************************",
+    "//2b": "***************************** UNIT TESTS ****************************",
+    "//2c": "*********************************************************************",
+    "test": "vitest --reporter=tree",
+    "test:watch": "pnpm test watch",
+    "test:ci": "pnpm test run",
+    "//3a": "*********************************************************************",
+    "//3b": "************************ UNIT TESTS COVERAGE ************************",
+    "//3c": "*********************************************************************",
+    "test:coverage": "pnpm test:watch --coverage",
+    "test:coverage:ci": "pnpm test:ci --coverage",
+    "test:serve-coverage": "http-server ./coverage --gzip true -p 0 -o /index.html --silent",
+    "test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\""
+  }
+}