@alessiofrittoli/exception 3.3.0 → 3.4.0

package/README.md

@@ -13,7 +13,6 @@
 [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
 
@@ -71,7 +70,7 @@ 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.        |
@@ -89,22 +88,22 @@ 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.              |
 
 ###### Example
 
 ```ts
-import { Exception } from '@alessiofrittoli/exception'
+import { Exception } from "@alessiofrittoli/exception";
 
 try {
-  throw new Exception( 'Resource not found', {
-    code    : 'ERR:NOTFOUND',
-    status  : 404,
-  } )
-} catch ( error ) {
-  console.error( error )
+  throw new Exception("Resource not found", {
+    code: "ERR:NOTFOUND",
+    status: 404,
+  });
+} catch (error) {
+  console.error(error);
 }
 ```
 
@@ -120,27 +119,29 @@ It supports also a JSON representation of the `Exception` class (commonly return
 
 ```ts
 try {
-  throw new Exception( 'Something went wrong', { code: 'ERR:UNKNOWN' } )
-} catch ( error ) {
-  if ( Exception.isException( error ) ) {
+  throw new Exception("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
 /** Simulates JSON Exception returned by a server JSON Response. */
-const error = (
-  JSON.parse( JSON.stringify( new Exception( 'Exception with custom name.', {
-    code: 0,
-    name: 'AbortError',
-  } ) ) )
-)
-
-console.log( Exception.isException( error ) ) // Outputs: true
+const error = JSON.parse(
+  JSON.stringify(
+    new Exception("Exception with custom name.", {
+      code: 0,
+      name: "AbortError",
+    })
+  )
+);
+
+console.log(Exception.isException(error)); // Outputs: true
 ```
 
 ---
@@ -155,10 +156,10 @@ 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                                                                                                                                                                                                                            |
+| --------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `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. |
 
 ---
 
@@ -190,7 +191,7 @@ try {
     return
   }
   // handle other unknown errors
-  
+
 }
 ```
 
@@ -229,7 +230,7 @@ try {
     return
   }
   // handle other unknown errors
-  
+
 }
 ```
 
@@ -244,18 +245,18 @@ It is designed to simplify error handling and improve feedback quality returned
 
 <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. |
+| 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>
 
@@ -271,22 +272,17 @@ 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'
+import { ErrorCode as Exception } from "@alessiofrittoli/exception/code";
 
 /** Your project custom `ErrorCode`. */
-export enum MyProjectErrorCode
-{
-  INVALID_SIGN = 'ERR:INVALIDSIGN',
-}
-
-const ErrorCode = { Exception, MyProjectErrorCode }
-type ErrorCode = MergedEnumValue<typeof ErrorCode>
+export const MyProjectErrorCode = {
+  INVALID_SIGN: "ERR:INVALIDSIGN",
+} as const;
 
-export default ErrorCode
+export const ErrorCode = { ...Exception, ...MyProjectErrorCode };
+export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
 ```
 
-⚠️ The Type `MergedEnumValue<T>` is globally delcared from `@alessiofrittoli/type-utils` so make sure to install it if needed.
-
 </details>
 
 ---
@@ -296,38 +292,38 @@ export default ErrorCode
 ##### Using the default `ErrorCode` to throw a new `Exception`
 
 ```ts
-import { Exception } from '@alessiofrittoli/exception'
-import { ErrorCode } from '@alessiofrittoli/exception/code'
+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,
-} )
+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`
+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.MyProjectErrorCode.INVALID_SIGN,
-  status  : 403,
-} )
+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`
+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.MyProjectErrorCode.INVALID_SIGN:
+      case ErrorCode.INVALID_SIGN:
         console.log( 'The signature is not valid.' )
         break
       case ErrorCode.Exception.UNKNOWN:

package/dist/abort.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkYQB23ERMjs = require('./chunk-YQB23ERM.js');require('./chunk-5TBITEFP.js');var t=class extends _chunkYQB23ERMjs.a{constructor(r,o={}){let s="AbortError",{code:n="ERR:ABORT",...i}=o;super(r,{...i,name:s,code:n})}static isAbortError(r,o){return super.isAbortError(r,o)}};exports.AbortError = t;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOBRRZX4Djs = require('./chunk-OBRRZX4D.js');var _chunkPSRQLNM6js = require('./chunk-PSRQLNM6.js');var s=class extends _chunkOBRRZX4Djs.a{constructor(r,o={}){let n="AbortError",{code:i=_chunkPSRQLNM6js.a.ABORT,...d}=o;super(r,{...d,name:n,code:i})}static isAbortError(r,o){return super.isAbortError(r,o)}};exports.AbortError = s;

package/dist/abort.mjs

@@ -1 +1 @@
-import{a as e}from"./chunk-LFZW7VUK.mjs";import"./chunk-F4EU4T25.mjs";var t=class extends e{constructor(r,o={}){let s="AbortError",{code:n="ERR:ABORT",...i}=o;super(r,{...i,name:s,code:n})}static isAbortError(r,o){return super.isAbortError(r,o)}};export{t as AbortError};
+import{a as t}from"./chunk-RAHIXT6K.mjs";import{a as e}from"./chunk-VBWDYSF3.mjs";var s=class extends t{constructor(r,o={}){let n="AbortError",{code:i=e.ABORT,...d}=o;super(r,{...d,name:n,code:i})}static isAbortError(r,o){return super.isAbortError(r,o)}};export{s as AbortError};

package/dist/chunk-OBRRZX4D.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPSRQLNM6js = require('./chunk-PSRQLNM6.js');var r=class t extends Error{constructor(e,s){super("",s),this.__typename="Exception",this.name=s.name||this.__typename,this.message=e,this.code=s.code,this.status=s.status}static isException(e){return e instanceof t||typeof e=="object"&&"__typename"in e&&e.__typename==="Exception"}static isAbortError(e,s=_chunkPSRQLNM6js.a.ABORT){return t.isException(e)&&(e.name==="AbortError"||e.code===s)}toJSON(){return{...this,message:this.message,cause:this.cause}}};exports.a = r;

package/dist/chunk-PSRQLNM6.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var R={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.a = R;

package/dist/chunk-RAHIXT6K.mjs

@@ -0,0 +1 @@
+import{a as o}from"./chunk-VBWDYSF3.mjs";var r=class t extends Error{constructor(e,s){super("",s),this.__typename="Exception",this.name=s.name||this.__typename,this.message=e,this.code=s.code,this.status=s.status}static isException(e){return e instanceof t||typeof e=="object"&&"__typename"in e&&e.__typename==="Exception"}static isAbortError(e,s=o.ABORT){return t.isException(e)&&(e.name==="AbortError"||e.code===s)}toJSON(){return{...this,message:this.message,cause:this.cause}}};export{r as a};

package/dist/chunk-VBWDYSF3.mjs

@@ -0,0 +1 @@
+var O={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{O as a};

package/dist/code.d.mts

@@ -2,17 +2,18 @@
  * Most common error codes.
  *
  */
-declare enum ErrorCode {
-    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"
-}
+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";
+};
+type ErrorCode = typeof ErrorCode[keyof typeof ErrorCode];
 
 export { ErrorCode };

package/dist/code.d.ts

@@ -2,17 +2,18 @@
  * Most common error codes.
  *
  */
-declare enum ErrorCode {
-    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"
-}
+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";
+};
+type ErrorCode = typeof ErrorCode[keyof typeof ErrorCode];
 
 export { ErrorCode };

package/dist/code.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk5TBITEFPjs = require('./chunk-5TBITEFP.js');exports.ErrorCode = _chunk5TBITEFPjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPSRQLNM6js = require('./chunk-PSRQLNM6.js');exports.ErrorCode = _chunkPSRQLNM6js.a;

package/dist/code.mjs

@@ -1 +1 @@
-import{a}from"./chunk-F4EU4T25.mjs";export{a as ErrorCode};
+import{a}from"./chunk-VBWDYSF3.mjs";export{a as ErrorCode};

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkYQB23ERMjs = require('./chunk-YQB23ERM.js');require('./chunk-5TBITEFP.js');exports.Exception = _chunkYQB23ERMjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOBRRZX4Djs = require('./chunk-OBRRZX4D.js');require('./chunk-PSRQLNM6.js');exports.Exception = _chunkOBRRZX4Djs.a;

package/dist/index.mjs

@@ -1 +1 @@
-import{a}from"./chunk-LFZW7VUK.mjs";import"./chunk-F4EU4T25.mjs";export{a as Exception};
+import{a}from"./chunk-RAHIXT6K.mjs";import"./chunk-VBWDYSF3.mjs";export{a as Exception};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/exception",
-	"version": "3.3.0",
+	"version": "3.4.0",
 	"description": "Handle errors with ease",
 	"author": {
 		"name": "Alessio Frittoli",

package/dist/chunk-5TBITEFP.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var O=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R.TOO_MANY="ERR:TOOMANY",R.QUOTA_REACHED="ERR:QUOTAREACHED",R.NOT_FOUND="ERR:NOTFOUND",R.OFFLINE="ERR:INTERNETDISCONNECTED",R))(O||{});exports.a = O;

package/dist/chunk-F4EU4T25.mjs

@@ -1 +0,0 @@
-var O=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R.TOO_MANY="ERR:TOOMANY",R.QUOTA_REACHED="ERR:QUOTAREACHED",R.NOT_FOUND="ERR:NOTFOUND",R.OFFLINE="ERR:INTERNETDISCONNECTED",R))(O||{});export{O as a};

package/dist/chunk-LFZW7VUK.mjs

@@ -1 +0,0 @@
-var o=class t extends Error{constructor(e,s){super("",s),this.__typename="Exception",this.name=s.name||this.__typename,this.message=e,this.code=s.code,this.status=s.status}static isException(e){return e instanceof t||typeof e=="object"&&"__typename"in e&&e.__typename==="Exception"}static isAbortError(e,s="ERR:ABORT"){return t.isException(e)&&(e.name==="AbortError"||e.code===s)}toJSON(){return{...this,message:this.message,cause:this.cause}}};export{o as a};

package/dist/chunk-YQB23ERM.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var o=class t extends Error{constructor(e,s){super("",s),this.__typename="Exception",this.name=s.name||this.__typename,this.message=e,this.code=s.code,this.status=s.status}static isException(e){return e instanceof t||typeof e=="object"&&"__typename"in e&&e.__typename==="Exception"}static isAbortError(e,s="ERR:ABORT"){return t.isException(e)&&(e.name==="AbortError"||e.code===s)}toJSON(){return{...this,message:this.message,cause:this.cause}}};exports.a = o;