@alessiofrittoli/exception 3.5.0 → 4.1.0

package/README.md

@@ -1,42 +1,65 @@
-# Exception 🚦
+<h1 align="center">Exception 🚦</h1>
+<h2 align="center">
+  Handle errors with ease
+</h2>
+<p align="center">
+This documentation describes the <code>Exception</code> class, which provides a structured way to handle errors in TypeScript. It includes custom properties such as <code>code</code>, <code>name</code>, and <code>status</code> for more detailed error reporting and debugging.
+</p>
+<p align="center">
+  <a href="https://npmjs.org/package/@alessiofrittoli/exception">
+    <img src="https://img.shields.io/npm/v/@alessiofrittoli/exception" alt="Latest version"/>
+  </a>
+  <a href="https://coveralls.io/github/alessiofrittoli/exception">
+    <img src="https://coveralls.io/repos/github/alessiofrittoli/exception/badge.svg" alt="Test coverage"/>
+  </a>
+  <a href="https://socket.dev/npm/package/@alessiofrittoli/exception/overview">
+    <img src="https://socket.dev/api/badge/npm/package/@alessiofrittoli/exception" alt="Socket Security score"/>
+  </a>
+  <a href="https://npmjs.org/package/@alessiofrittoli/exception">
+    <img src="https://img.shields.io/npm/dm/@alessiofrittoli/exception.svg" alt="npm downloads"/>
+  </a>
+  <a href="https://bundlephobia.com/package/@alessiofrittoli/exception">
+    <img src="https://badgen.net/bundlephobia/dependency-count/@alessiofrittoli/exception" alt="Dependencies"/>
+  </a>
+  <a href="https://libraries.io/npm/%40alessiofrittoli%2Fexception">
+    <img src="https://img.shields.io/librariesio/release/npm/@alessiofrittoli/exception" alt="Dependencies status"/>
+  </a>
+</p>
+<p align="center">
+  <a href="https://bundlephobia.com/package/@alessiofrittoli/exception">
+    <img src="https://badgen.net/bundlephobia/min/@alessiofrittoli/exception" alt="minified"/>
+  </a>
+  <a href="https://bundlephobia.com/package/@alessiofrittoli/exception">
+    <img src="https://badgen.net/bundlephobia/minzip/@alessiofrittoli/exception" alt="minizipped"/>
+  </a>
+  <a href="https://bundlephobia.com/package/@alessiofrittoli/exception">
+    <img src="https://badgen.net/bundlephobia/tree-shaking/@alessiofrittoli/exception" alt="Tree shakable"/>
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/sponsors/alessiofrittoli">
+    <img src="https://img.shields.io/static/v1?label=Fund%20this%20package&message=%E2%9D%A4&logo=GitHub&color=%23DB61A2" alt="Fund this package"/>
+  </a>
+</p>
 
-[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![Socket Status][socket-badge]][socket-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
-
-[![GitHub Sponsor][sponsor-badge]][sponsor-url]
-
-[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fexception
-[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fexception
-[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/exception/badge.svg
-[coverage-url]: https://coveralls.io/github/alessiofrittoli/exception
-[socket-badge]: https://socket.dev/api/badge/npm/package/@alessiofrittoli/exception
-[socket-url]: https://socket.dev/npm/package/@alessiofrittoli/exception/overview
-[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fexception.svg
-[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fexception
-[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fexception
 [sponsor-badge]: https://img.shields.io/static/v1?label=Fund%20this%20package&message=%E2%9D%A4&logo=GitHub&color=%23DB61A2
 [sponsor-url]: https://github.com/sponsors/alessiofrittoli
 
-## Handle errors with ease
-
-This documentation describes the `Exception` class, which provides a structured way to handle errors in TypeScript. It includes custom properties such as `code`, `name`, and `status` for more detailed error reporting and debugging.
-
-### Table of Contents
+### Table of Content
 
 - [Getting started](#getting-started)
+- [Development](#development)
+  - [Local development](#local-development)
+  - [Production build](#production-build)
+  - [Unit tests](#unit-tests)
+    - [Run tests with coverage](#run-tests-with-coverage)
+  - [Contributing](#contributing)
+  - [Security](#security)
 - [API Reference](#api-reference)
   - [ExceptionOptions Interface](#exceptionoptions-interface)
   - [Exception Class](#exception-class)
   - [AbortError Class](#aborterror-class)
     - [AbortError Usage Scenarios](#aborterror-usage-scenarios)
-  - [`ErrorCode` enum](#errorcode-enum)
-  - [Examples](#examples)
-- [Development](#development)
-  - [Install depenendencies](#install-depenendencies)
-  - [Build the source code](#build-the-source-code)
-  - [ESLint](#eslint)
-  - [Jest](#jest)
-- [Contributing](#contributing)
-- [Security](#security)
 - [Credits](#made-with-)
 
 ---
@@ -61,6 +84,84 @@ pnpm i @alessiofrittoli/exception
 
 ---
 
+### Development
+
+Run the following to start development
+
+```shell
+nvm use
+
+pnpm i
+```
+
+#### Local development
+
+Run the following
+
+```shell
+pnpm dev
+```
+
+This will generate unminified output code, sourcemaps and will enable source file watcher.
+
+---
+
+#### Production build
+
+Run the following to create a local production build
+
+```shell
+pnpm build
+```
+
+This will generate minified output code without sourcemaps.
+
+---
+
+#### Unit tests
+
+Run all the defined test suites by running the following:
+
+```shell
+# Run tests and watch file changes.
+pnpm test:watch
+
+# Run tests in a CI environment.
+pnpm test:ci
+```
+
+---
+
+##### Run tests with coverage
+
+An HTTP server is then started to serve coverage files from `./coverage` folder.
+
+⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
+
+```shell
+pnpm test:coverage:serve
+```
+
+---
+
+#### Contributing
+
+Contributions are truly welcome!
+
+Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
+
+Help keep this project up to date with [GitHub Sponsor][sponsor-url].
+
+[![GitHub Sponsor][sponsor-badge]][sponsor-url]
+
+---
+
+#### Security
+
+If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.
+
+---
+
 ### API Reference
 
 #### `ExceptionOptions` Interface
@@ -69,11 +170,16 @@ The `ExceptionOptions` interface defines the optional parameters for the `Except
 
 ##### Properties
 
-| Property | Type     | Default     | Description                                                      |
-| -------- | -------- | ----------- | ---------------------------------------------------------------- |
-| `code`   | `TCode`  | -           | (Required) A numeric or custom code representing the error type. |
-| `name`   | `string` | `Exception` | (Optional) A string representing the error name.                 |
-| `status` | `number` | -           | (Optional) An HTTP status code associated with the error.        |
+| Property      | Type      | Default                   | Description                                                                     |
+| ------------- | --------- | ------------------------- | ------------------------------------------------------------------------------- |
+| `name`        | `string`  | `ExceptionName.Exception` | (Optional) The error interface name.                                            |
+| `message`     | `string`  | "Unknown error."          | (Optional) The error message containing technical informations about the error. |
+| `title`       | `string`  | -                         | (Optional) The error title.                                                     |
+| `description` | `string`  | -                         | (Optional) The error description.                                               |
+| `code`        | `T`       | -                         | (Required) The error code associated with the Exception.                        |
+| `isCritical`  | `boolean` | `false`                   | (Optional) Indicates whether the error is a critical error.                     |
+| `status`      | `number`  | -                         | (Optional) The HTTP status code associated with the Exception.                  |
+| `cause`       | `unknown` | -                         | (Optional) The error cause.                                                     |
 
 ---
 
@@ -87,23 +193,23 @@ The constructor initializes an `Exception` instance with a custom message and op
 
 ###### Parameters
 
-| Parameter | Type               | Description                                                     |
-| --------- | ------------------ | --------------------------------------------------------------- |
-| `message` | `TMessage`         | (Required) The error message. Can be a string or a custom type. |
-| `options` | `ExceptionOptions` | (Required) An object containing the error options.              |
+| Parameter | Type               | Description                                        |
+| --------- | ------------------ | -------------------------------------------------- |
+| `options` | `ExceptionOptions` | (Required) An object containing the error options. |
 
 ###### Example
 
 ```ts
-import { Exception } from "@alessiofrittoli/exception";
+import { Exception } from '@alessiofrittoli/exception'
 
 try {
-  throw new Exception("Resource not found", {
-    code: "ERR:NOTFOUND",
+  throw new Exception({
+    message: 'Resource not found'
+    code: 'ERR:NOTFOUND',
     status: 404,
-  });
+  })
 } catch (error) {
-  console.error(error);
+  console.error(error)
 }
 ```
 
@@ -119,29 +225,33 @@ It supports also a JSON representation of the `Exception` class (commonly return
 
 ```ts
 try {
-  throw new Exception("Something went wrong", { code: "ERR:UNKNOWN" });
+  throw new Exception({ message: 'Something went wrong', code: 'ERR:UNKNOWN' })
 } catch (error) {
   if (Exception.isException(error)) {
     // we can safely access `Exception` properties
-    console.error(`Error [${error.code}]: ${error.message}`);
+    console.error(`Error [${error.code}]: ${error.message}`)
   } else {
-    console.error(error);
+    console.error(error)
   }
 }
 ```
 
 ```ts
+import { ExceptionName } from '@alessiofrittoli/exception'
+
 /** Simulates JSON Exception returned by a server JSON Response. */
 const error = JSON.parse(
   JSON.stringify(
-    new Exception("Exception with custom name.", {
+    new Exception({
+      name: ExceptionName.AbortError,
+      message: 'Exception with custom name.',
       code: 0,
-      name: "AbortError",
-    })
-  )
-);
+    }),
+  ),
+)
 
-console.log(Exception.isException(error)); // Outputs: true
+console.log(Exception.isException(error)) // Outputs: true
+console.log(new Exception(error)) // Outputs: [Exception]
 ```
 
 ---
@@ -156,10 +266,11 @@ The constructor initializes an `AbortError` instance with a custom message and o
 
 ###### Parameters
 
-| Parameter | Type                | Description                                                                                                                                                                                                                            |
-| --------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `message` | `TMessage`          | (Required) The error message. Can be a string or a custom type.                                                                                                                                                                        |
-| `options` | `AbortErrorOptions` | (Optional) An object containing the error options. It extends the [`ExceptionOptions` Interface](#exceptionoptions-interface) and omit the `name` property. The `code` defaults to `ErrorCode.ABORT` but can be optionally customized. |
+| Parameter | Type                | Description                                                                                              |
+| --------- | ------------------- | -------------------------------------------------------------------------------------------------------- |
+| `options` | `AbortErrorOptions` | An object containing the error options.                                                                  |
+|           |                     | It extends the [`ExceptionOptions` Interface](#exceptionoptions-interface) and omit the `name` property. |
+|           |                     | The `code` defaults to `ErrorCode.ABORT` but can be optionally customized.                               |
 
 ---
 
@@ -174,24 +285,24 @@ try {
   const controller = new AbortController()
   const { signal } = controller
 
-  button.addEventListener( 'click', () => {
-    controller.abort( new AbortError( 'User cancelled the request.' ) )
-  } )
+  button.addEventListener('click', () => {
+    controller.abort(new AbortError({ message: 'User cancelled the request.' }))
+  })
 
-  await fetch( ..., { signal } )
-} catch ( error ) {
-
-  if ( AbortError.isException( error ) ) {
-    if ( AbortError.isAbortError( error ) ) {
+  await fetch(..., { signal })
+} catch (error) {
+  if (AbortError.isException(error)) {
+    if (AbortError.isAbortError(error)) {
       // handle abort error
-      console.log( error.code ) // `error.code` is type of `ErrorCode.ABORT`.
+      console.log(error.code) // `error.code` is type of `ErrorCode.ABORT`.
       return
     }
+
     // handle other Exception errors
     return
   }
-  // handle other unknown errors
 
+  // handle other unknown errors
 }
 ```
 
@@ -202,8 +313,7 @@ try {
 ```ts
 import { AbortError } from '@alessiofrittoli/exception/abort'
 
-enum CustomAbortCode
-{
+enum ApplicationErrorCode {
   CUSTOM_CODE = 'ERR:CUSTOM_ABORT_CODE',
 }
 
@@ -211,203 +321,34 @@ try {
   const controller = new AbortController()
   const { signal } = controller
 
-  button.addEventListener( 'click', () => {
+  button.addEventListener('click', () => {
     controller.abort(
-      new AbortError( 'User cancelled the request.', { code: CustomAbortCode.CUSTOM_CODE } )
+      new AbortError({
+        message: 'User cancelled the request.',
+        code: ApplicationErrorCode.CUSTOM_CODE,
+      }),
     )
-  } )
-
-  await fetch( ..., { signal } )
-} catch ( error ) {
+  })
 
-  if ( AbortError.isException( error ) ) {
-    if ( AbortError.isAbortError( error, CustomAbortCode.CUSTOM_CODE ) ) {
+  await fetch('', { signal })
+} catch (error) {
+  if (AbortError.isException<ApplicationErrorCode>(error)) {
+    if (AbortError.isAbortError(error, ApplicationErrorCode.CUSTOM_CODE)) {
       // handle abort error
-      console.log( error.code ) // `error.code` is type of `CustomAbortCode.CUSTOM_CODE`.
+      console.log(error.code) // `error.code` is type of `CustomAbortCode.CUSTOM_CODE`.
       return
     }
+
     // handle other Exception errors
     return
   }
-  // handle other unknown errors
-
-}
-```
-
----
-
-#### `ErrorCode` enum
-
-The `ErrorCode` enum is a utility that provides pre-defined constants for the most common error codes.\
-It is designed to simplify error handling and improve feedback quality returned to the user.
-
-<details>
-
-<summary>Constants Overview</summary>
-
-| Constant        | Value                      | Description                                                                  |
-| --------------- | -------------------------- | ---------------------------------------------------------------------------- |
-| `UNKNOWN`       | `ERR:UNKNOWN`              | Returned when an unexpected error occured.                                   |
-| `ABORT`         | `ERR:ABORT`                | Returned when user abort the request.                                        |
-| `EMPTY_VALUE`   | `ERR:EMPTYVALUE`           | Returned when a required value is "falsy".                                   |
-| `WRONG_VALUE`   | `ERR:WRONGVALUE`           | Return when a required value is not the expected value.                      |
-| `EXPIRED`       | `ERR:EXPIRED`              | Returned when a requested has been performed too late.                       |
-| `TOO_EARLY`     | `ERR:TOOEARLY`             | Returned when a request has been performed too early.                        |
-| `TOO_MANY`      | `ERR:TOOMANY`              | Could be return in combination with a 429 Too Many Requests Response Status. |
-| `QUOTA_REACHED` | `ERR:QUOTAREACHED`         | Returned when a specific quota has been reached.                             |
-| `NOT_FOUND`     | `ERR:NOTFOUND`             | Returned when a resource cannot be found.                                    |
-| `OFFLINE`       | `ERR:INTERNETDISCONNECTED` | Could be used to throw errors when user is offline.                          |
-
-</details>
-
----
 
-<details>
-
-<summary>Extending the `enum` in your project</summary>
-
-For obvious reasons the default `ErrorCode` provided by this library might be not enough to cover all the error cases in your project.
-
-To fill this gap, you can "extend" the `ErrorCode` enum by doing so:
-
-```ts
-// myproject/src/error-code.ts
-import { ErrorCode as Exception } from "@alessiofrittoli/exception/code";
-
-/** Your project custom `ErrorCode`. */
-export const MyProjectErrorCode = {
-  INVALID_SIGN: "ERR:INVALIDSIGN",
-} as const;
-
-export const ErrorCode = { ...Exception, ...MyProjectErrorCode };
-export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
-```
-
-</details>
-
----
-
-#### Examples
-
-##### Using the default `ErrorCode` to throw a new `Exception`
-
-```ts
-import { Exception } from "@alessiofrittoli/exception";
-import { ErrorCode } from "@alessiofrittoli/exception/code";
-
-throw new Exception("Password is a required field to log you in.", {
-  code: ErrorCode.EMPTY_VALUE,
-  status: 422,
-});
-```
-
-##### Using custom `ErrorCode` to throw a new `Exception`
-
-```ts
-import { Exception } from "@alessiofrittoli/exception";
-import { ErrorCode } from "@/error-code"; // previously created in `myproject/src/error-code.ts` (see - Extending the `enum` in your project)
-
-throw new Exception("Invalid signature.", {
-  code: ErrorCode.INVALID_SIGN,
-  status: 403,
-});
-```
-
-##### Using `ErrorCode` to handle errors
-
-```ts
-import { ErrorCode } from '@/error-code' // previously created in `myproject/src/error-code.ts` (see - Extending the `enum` in your project)
-
-try {
-  ...
-} catch ( error ) {
-  if ( Exception.isException<string, ErrorCode>( error ) ) {
-    switch ( error.code ) { // `error.code` is now type of `ErrorCode` (custom).
-      case ErrorCode.INVALID_SIGN:
-        console.log( 'The signature is not valid.' )
-        break
-      case ErrorCode.Exception.UNKNOWN:
-      default:
-        console.log( 'Unexpected error occured.' )
-    }
-  }
+  // handle other unknown errors
 }
 ```
 
 ---
 
-### Development
-
-#### Install depenendencies
-
-```bash
-npm install
-```
-
-or using `pnpm`
-
-```bash
-pnpm i
-```
-
-#### Build the source code
-
-Run the following command to test and build code for distribution.
-
-```bash
-pnpm build
-```
-
-#### [ESLint](https://www.npmjs.com/package/eslint)
-
-warnings / errors check.
-
-```bash
-pnpm lint
-```
-
-#### [Jest](https://npmjs.com/package/jest)
-
-Run all the defined test suites by running the following:
-
-```bash
-# Run tests and watch file changes.
-pnpm test:watch
-
-# Run tests in a CI environment.
-pnpm test:ci
-```
-
-- See [`package.json`](./package.json) file scripts for more info.
-
-Run tests with coverage.
-
-An HTTP server is then started to serve coverage files from `./coverage` folder.
-
-⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
-
-```bash
-test:coverage:serve
-```
-
----
-
-### Contributing
-
-Contributions are truly welcome!
-
-Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
-
-Help keep this project up to date with [GitHub Sponsor][sponsor-url].
-
-[![GitHub Sponsor][sponsor-badge]][sponsor-url]
-
----
-
-### Security
-
-If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.
-
 ### Made with ☕
 
 <table style='display:flex;gap:20px;'>

package/dist/abort/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("../code/index.cjs"),t=require("../index.cjs");var n=class extends t.Exception{constructor(n={}){let{code:r=e.ErrorCode.ABORT,...i}=n;super({...i,name:t.ExceptionName.AbortError,code:r})}static isAbortError(e,t){return super.isAbortError(e,t)}};exports.AbortError=n;

package/dist/abort/index.d.cts

@@ -0,0 +1,29 @@
+import { ErrorCode } from "../code/index.cjs";
+import { Exception, ExceptionOptions } from "../index.cjs";
+//#region src/abort/index.d.ts
+/**
+ * Interface representing the options for an Exception.
+ *
+ * @extends ExceptionOptions
+ */
+export type AbortErrorOptions<T = ErrorCode> = Partial<Omit<ExceptionOptions<T>, 'name'>>;
+/**
+ * Exception Class.
+ *
+ * @template TMessage The type of the message property of the Exception. Defaults to `string`.
+ *
+ * @extends Exception
+ */
+export declare class AbortError<T = ErrorCode> extends Exception<T> implements AbortErrorOptions<T> {
+  constructor(options?: AbortErrorOptions<T>);
+  /**
+   * Determines if the provided error is an instance of the AbortError 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 `AbortError` and has the ABORT ErrorCode, `false` otherwise.
+   */
+  static isAbortError<T = ErrorCode>(error: any, code?: T): error is AbortError<T>;
+}
+//#endregion

package/dist/abort/index.d.mts

@@ -0,0 +1,29 @@
+import { ErrorCode } from "../code/index.mjs";
+import { Exception, ExceptionOptions } from "../index.mjs";
+//#region src/abort/index.d.ts
+/**
+ * Interface representing the options for an Exception.
+ *
+ * @extends ExceptionOptions
+ */
+export type AbortErrorOptions<T = ErrorCode> = Partial<Omit<ExceptionOptions<T>, 'name'>>;
+/**
+ * Exception Class.
+ *
+ * @template TMessage The type of the message property of the Exception. Defaults to `string`.
+ *
+ * @extends Exception
+ */
+export declare class AbortError<T = ErrorCode> extends Exception<T> implements AbortErrorOptions<T> {
+  constructor(options?: AbortErrorOptions<T>);
+  /**
+   * Determines if the provided error is an instance of the AbortError 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 `AbortError` and has the ABORT ErrorCode, `false` otherwise.
+   */
+  static isAbortError<T = ErrorCode>(error: any, code?: T): error is AbortError<T>;
+}
+//#endregion

package/dist/abort/index.mjs

@@ -0,0 +1 @@
+import{ErrorCode as e}from"../code/index.mjs";import{Exception as t,ExceptionName as n}from"../index.mjs";var r=class extends t{constructor(t={}){let{code:r=e.ABORT,...i}=t;super({...i,name:n.AbortError,code:r})}static isAbortError(e,t){return super.isAbortError(e,t)}};export{r as AbortError};

package/dist/code/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e={UNKNOWN:`ERR:UNKNOWN`,ABORT:`ERR:ABORT`,EMPTY_VALUE:`ERR:EMPTYVALUE`,WRONG_VALUE:`ERR:WRONGVALUE`,EXPIRED:`ERR:EXPIRED`,TOO_EARLY:`ERR:TOOEARLY`,TOO_MANY:`ERR:TOOMANY`,QUOTA_REACHED:`ERR:QUOTAREACHED`,NOT_FOUND:`ERR:NOTFOUND`,OFFLINE:`ERR:INTERNETDISCONNECTED`};exports.ErrorCode=e;

package/dist/code/index.d.cts

@@ -0,0 +1,19 @@
+//#region src/code/index.d.ts
+/**
+ * Most common error codes.
+ *
+ */
+export declare const ErrorCode: {
+  readonly UNKNOWN: "ERR:UNKNOWN";
+  readonly ABORT: "ERR:ABORT";
+  readonly EMPTY_VALUE: "ERR:EMPTYVALUE";
+  readonly WRONG_VALUE: "ERR:WRONGVALUE";
+  readonly EXPIRED: "ERR:EXPIRED";
+  readonly TOO_EARLY: "ERR:TOOEARLY";
+  readonly TOO_MANY: "ERR:TOOMANY";
+  readonly QUOTA_REACHED: "ERR:QUOTAREACHED";
+  readonly NOT_FOUND: "ERR:NOTFOUND";
+  readonly OFFLINE: "ERR:INTERNETDISCONNECTED";
+};
+export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+//#endregion

package/dist/code/index.d.mts

@@ -0,0 +1,19 @@
+//#region src/code/index.d.ts
+/**
+ * Most common error codes.
+ *
+ */
+export declare const ErrorCode: {
+  readonly UNKNOWN: "ERR:UNKNOWN";
+  readonly ABORT: "ERR:ABORT";
+  readonly EMPTY_VALUE: "ERR:EMPTYVALUE";
+  readonly WRONG_VALUE: "ERR:WRONGVALUE";
+  readonly EXPIRED: "ERR:EXPIRED";
+  readonly TOO_EARLY: "ERR:TOOEARLY";
+  readonly TOO_MANY: "ERR:TOOMANY";
+  readonly QUOTA_REACHED: "ERR:QUOTAREACHED";
+  readonly NOT_FOUND: "ERR:NOTFOUND";
+  readonly OFFLINE: "ERR:INTERNETDISCONNECTED";
+};
+export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+//#endregion

package/dist/code/index.mjs

@@ -0,0 +1 @@
+const e={UNKNOWN:`ERR:UNKNOWN`,ABORT:`ERR:ABORT`,EMPTY_VALUE:`ERR:EMPTYVALUE`,WRONG_VALUE:`ERR:WRONGVALUE`,EXPIRED:`ERR:EXPIRED`,TOO_EARLY:`ERR:TOOEARLY`,TOO_MANY:`ERR:TOOMANY`,QUOTA_REACHED:`ERR:QUOTAREACHED`,NOT_FOUND:`ERR:NOTFOUND`,OFFLINE:`ERR:INTERNETDISCONNECTED`};export{e as ErrorCode};

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./code/index.cjs"),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.ErrorCode.ABORT){return n.isException(r)&&(r.name===t.AbortError||r.code===i)}toJSON(){return{...this,message:this.message,cause:this.cause}}};exports.Exception=n,exports.ExceptionName=t;