@jakubmazanec/error 1.0.0-1fd57ce

package/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2022 Jakub Mazanec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const ERROR_MESSAGE_TOKEN_PATTERN: RegExp;
+export declare const UNKNOWN_ERROR = "UNKNOWN_ERROR";
+export declare const INTERNAL_ERROR_MESSAGES: {
+    UNKNOWN_ERROR: string;
+};

package/dist/constants.js

@@ -0,0 +1,7 @@
+export const ERROR_MESSAGE_TOKEN_PATTERN = /\{(\d+)\}/gu;
+export const UNKNOWN_ERROR = "UNKNOWN_ERROR";
+export const INTERNAL_ERROR_MESSAGES = {
+    [UNKNOWN_ERROR]: "An unknown error has occurred."
+};
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const ERROR_MESSAGE_TOKEN_PATTERN = /\\{(\\d+)\\}/gu;\n\nexport const UNKNOWN_ERROR = 'UNKNOWN_ERROR';\n\nexport const INTERNAL_ERROR_MESSAGES = {\n  [UNKNOWN_ERROR]: 'An unknown error has occurred.',\n};\n"],"names":["ERROR_MESSAGE_TOKEN_PATTERN","UNKNOWN_ERROR","INTERNAL_ERROR_MESSAGES"],"mappings":"AAAA,OAAO,MAAMA,2BAA2B,gBAAgB,CAAC;AAEzD,OAAO,MAAMC,aAAa,GAAG,eAAe,CAAC;AAE7C,OAAO,MAAMC,uBAAuB,GAAG;IACrC,CAACD,aAAa,CAAC,EAAE,gCAAgC;CAClD,CAAC"}

package/dist/createCustomError.d.ts

@@ -0,0 +1,11 @@
+import { UNKNOWN_ERROR } from './constants.js';
+import type { CustomError, ErrorMessages } from './types.js';
+export interface CustomErrorOptions<T> {
+    messageParameters?: unknown[];
+    data: T;
+}
+/**
+ * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error`, simplifies
+ * generating error messages via predefined error codes and allows attaching custom data to the error instance.
+ */
+export declare function createCustomError<ErrorCode extends string, ErrorData extends abstract new (...args: any) => any>(errorName: string, errorMessages: ErrorMessages<ErrorCode>, ErrorData?: ErrorData): new (code: ErrorCode, options?: CustomErrorOptions<InstanceType<ErrorData>>) => CustomError<ErrorCode | typeof UNKNOWN_ERROR, InstanceType<ErrorData>>;

package/dist/createCustomError.js

@@ -0,0 +1,30 @@
+/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ import { ERROR_MESSAGE_TOKEN_PATTERN, INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR } from "./constants.js";
+function createErrorMessage(errorCode, errorMessages, messageParameters = []) {
+    let errorMessage = errorMessages[errorCode];
+    if (!errorMessage) {
+        return "";
+    }
+    return `${errorCode}: ${errorMessage.replace(ERROR_MESSAGE_TOKEN_PATTERN, (match, index)=>String(messageParameters[index]))}`;
+}
+/**
+ * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error`, simplifies
+ * generating error messages via predefined error codes and allows attaching custom data to the error instance.
+ */ export function createCustomError(errorName, errorMessages, ErrorData) {
+    return class InternalCustomError extends Error {
+        constructor(errorCode, options){
+            super(createErrorMessage(errorCode, errorMessages, options === null || options === void 0 ? void 0 : options.messageParameters));
+            this.code = errorCode;
+            this.name = errorName;
+            if (typeof (options === null || options === void 0 ? void 0 : options.data) !== "undefined") {
+                this.data = options.data;
+            }
+            // if the message is empty, we are making this an unknown error
+            if (!this.message) {
+                this.code = UNKNOWN_ERROR;
+                this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
+            }
+        }
+    };
+}
+
+//# sourceMappingURL=createCustomError.js.map

package/dist/createCustomError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/createCustomError.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {ERROR_MESSAGE_TOKEN_PATTERN, INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR} from './constants.js';\nimport type {CustomError, ErrorMessages} from './types.js';\n\nfunction createErrorMessage<T extends string>(\n  errorCode: T,\n  errorMessages: ErrorMessages<T>,\n  messageParameters: unknown[] = [],\n): string {\n  let errorMessage = errorMessages[errorCode];\n\n  if (!errorMessage) {\n    return '';\n  }\n\n  return `${errorCode}: ${errorMessage.replace(\n    ERROR_MESSAGE_TOKEN_PATTERN,\n    (match: string, index: number) => String(messageParameters[index]),\n  )}`;\n}\n\nexport interface CustomErrorOptions<T> {\n  messageParameters?: unknown[];\n  data: T;\n}\n\n/**\n * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error`, simplifies\n * generating error messages via predefined error codes and allows attaching custom data to the error instance.\n */\nexport function createCustomError<\n  ErrorCode extends string,\n  // eslint-disable-next-line @typescript-eslint/no-redeclare -- because `ErrorData` is used only as a type, we don't mind\n  ErrorData extends abstract new (...args: any) => any,\n>(\n  errorName: string,\n  errorMessages: ErrorMessages<ErrorCode>,\n  ErrorData?: ErrorData,\n): new (code: ErrorCode, options?: CustomErrorOptions<InstanceType<ErrorData>>) => CustomError<\n  ErrorCode | typeof UNKNOWN_ERROR,\n  InstanceType<ErrorData>\n> {\n  return class InternalCustomError\n    extends Error\n    implements CustomError<ErrorCode, InstanceType<ErrorData>>\n  {\n    code: ErrorCode | typeof UNKNOWN_ERROR;\n    data?: InstanceType<ErrorData>;\n\n    constructor(errorCode: ErrorCode, options?: CustomErrorOptions<InstanceType<ErrorData>>) {\n      super(createErrorMessage(errorCode, errorMessages, options?.messageParameters));\n\n      this.code = errorCode;\n      this.name = errorName;\n\n      if (typeof options?.data !== 'undefined') {\n        this.data = options.data;\n      }\n\n      // if the message is empty, we are making this an unknown error\n      if (!this.message) {\n        this.code = UNKNOWN_ERROR;\n        this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);\n      }\n    }\n  };\n}\n"],"names":["ERROR_MESSAGE_TOKEN_PATTERN","INTERNAL_ERROR_MESSAGES","UNKNOWN_ERROR","createErrorMessage","errorCode","errorMessages","messageParameters","errorMessage","replace","match","index","String","createCustomError","errorName","ErrorData","InternalCustomError","Error","constructor","options","code","name","data","message"],"mappings":"AAAA,iEAAiE,CACjE,SAAQA,2BAA2B,EAAEC,uBAAuB,EAAEC,aAAa,QAAO,gBAAgB,CAAC;AAGnG,SAASC,kBAAkB,CACzBC,SAAY,EACZC,aAA+B,EAC/BC,iBAA4B,GAAG,EAAE,EACzB;IACR,IAAIC,YAAY,GAAGF,aAAa,CAACD,SAAS,CAAC,AAAC;IAE5C,IAAI,CAACG,YAAY,EAAE;QACjB,OAAO,EAAE,CAAC;KACX;IAED,OAAO,CAAC,EAAEH,SAAS,CAAC,EAAE,EAAEG,YAAY,CAACC,OAAO,CAC1CR,2BAA2B,EAC3B,CAACS,KAAa,EAAEC,KAAa,GAAKC,MAAM,CAACL,iBAAiB,CAACI,KAAK,CAAC,CAAC,CACnE,CAAC,CAAC,CAAC;CACL;AAOD;;;GAGG,CACH,OAAO,SAASE,iBAAiB,CAK/BC,SAAiB,EACjBR,aAAuC,EACvCS,SAAqB,EAIrB;IACA,OAAO,MAAMC,mBAAmB,SACtBC,KAAK;QAMbC,YAAYb,SAAoB,EAAEc,OAAqD,CAAE;YACvF,KAAK,CAACf,kBAAkB,CAACC,SAAS,EAAEC,aAAa,EAAEa,OAAO,aAAPA,OAAO,WAAmB,GAA1BA,KAAAA,CAA0B,GAA1BA,OAAO,CAAEZ,iBAAiB,CAAC,CAAC,CAAC;YAEhF,IAAI,CAACa,IAAI,GAAGf,SAAS,CAAC;YACtB,IAAI,CAACgB,IAAI,GAAGP,SAAS,CAAC;YAEtB,IAAI,OAAOK,CAAAA,OAAO,aAAPA,OAAO,WAAM,GAAbA,KAAAA,CAAa,GAAbA,OAAO,CAAEG,IAAI,CAAA,KAAK,WAAW,EAAE;gBACxC,IAAI,CAACA,IAAI,GAAGH,OAAO,CAACG,IAAI,CAAC;aAC1B;YAED,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAACC,OAAO,EAAE;gBACjB,IAAI,CAACH,IAAI,GAAGjB,aAAa,CAAC;gBAC1B,IAAI,CAACoB,OAAO,GAAGnB,kBAAkB,CAACD,aAAa,EAAED,uBAAuB,CAAC,CAAC;aAC3E;SACF;KACF,CAAC;CACH"}

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from './createCustomError.js';
+export * from './types.js';

package/dist/main.js

@@ -0,0 +1,4 @@
+export * from "./createCustomError.js";
+export * from "./types.js";
+
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/main.ts"],"sourcesContent":["export * from './createCustomError.js';\nexport * from './types.js';\n"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC"}

package/dist/types/CustomError.d.ts

@@ -0,0 +1,10 @@
+import type { UNKNOWN_ERROR } from '../constants.js';
+/**
+ * Type representing custom error.
+ */
+export declare type CustomError<ErrorCode extends string, ErrorData> = Error & {
+    /** String that is used to quickly determine the nature of the error and why it could have occurred. */
+    code: ErrorCode | typeof UNKNOWN_ERROR;
+    /** Data related to the error that can be used during the error handling process to gain more information or take an action. */
+    data?: ErrorData;
+};

package/dist/types/CustomError.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=CustomError.js.map

package/dist/types/CustomError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/CustomError.ts"],"sourcesContent":["import type {UNKNOWN_ERROR} from '../constants.js';\n\n/**\n * Type representing custom error.\n */\nexport type CustomError<ErrorCode extends string, ErrorData> = Error & {\n  /** String that is used to quickly determine the nature of the error and why it could have occurred. */\n  code: ErrorCode | typeof UNKNOWN_ERROR;\n\n  /** Data related to the error that can be used during the error handling process to gain more information or take an action. */\n  data?: ErrorData;\n};\n"],"names":[],"mappings":"AAAA,WAWE"}

package/dist/types/ErrorMessages.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Object type whose property keys are `ErrorCode` and whose property values are `string`.
+ */
+export declare type ErrorMessages<ErrorCode extends string> = Record<ErrorCode, string>;

package/dist/types/ErrorMessages.js

@@ -0,0 +1,5 @@
+/**
+ * Object type whose property keys are `ErrorCode` and whose property values are `string`.
+ */ export { };
+
+//# sourceMappingURL=ErrorMessages.js.map

package/dist/types/ErrorMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/ErrorMessages.ts"],"sourcesContent":["/**\n * Object type whose property keys are `ErrorCode` and whose property values are `string`.\n */\nexport type ErrorMessages<ErrorCode extends string> = Record<ErrorCode, string>;\n"],"names":[],"mappings":"AAAA;;GAEG,CACH,WAAgF"}

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export * from './types/CustomError.js';
+export * from './types/ErrorMessages.js';

package/dist/types.js

@@ -0,0 +1,4 @@
+export * from "./types/CustomError.js";
+export * from "./types/ErrorMessages.js";
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export * from './types/CustomError.js';\nexport * from './types/ErrorMessages.js';\n"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jakubmazanec/error",
+  "version": "1.0.0-1fd57ce",
+  "description": "Collection of utilities for creating and handling errors.",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:jakubmazanec/js-tools.git",
+    "directory": "packages/error"
+  },
+  "license": "MIT",
+  "author": "Jakub Mazanec <jakub@mazanec.dev>",
+  "sideEffects": false,
+  "type": "module",
+  "exports": "./dist/main.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "swc src -d dist && tsc",
+    "clean": "del-cli dist *.tsbuildinfo",
+    "document": "typedoc --options typedoc.config.cjs",
+    "format": "prettier . --write --ignore-unknown --ignore-path ../../.prettierignore",
+    "lint": "eslint .",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "typecheck": "tsc --project tsconfig.typecheck.json"
+  },
+  "devDependencies": {
+    "@jest/globals": "^28.1.3"
+  },
+  "packageManager": "npm@8.11.0",
+  "engines": {
+    "node": ">=16.15.0"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,7 @@
+export const ERROR_MESSAGE_TOKEN_PATTERN = /\{(\d+)\}/gu;
+
+export const UNKNOWN_ERROR = 'UNKNOWN_ERROR';
+
+export const INTERNAL_ERROR_MESSAGES = {
+  [UNKNOWN_ERROR]: 'An unknown error has occurred.',
+};

package/src/createCustomError.ts

@@ -0,0 +1,67 @@
+/* eslint-disable @typescript-eslint/no-explicit-any -- needed */
+import {ERROR_MESSAGE_TOKEN_PATTERN, INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR} from './constants.js';
+import type {CustomError, ErrorMessages} from './types.js';
+
+function createErrorMessage<T extends string>(
+  errorCode: T,
+  errorMessages: ErrorMessages<T>,
+  messageParameters: unknown[] = [],
+): string {
+  let errorMessage = errorMessages[errorCode];
+
+  if (!errorMessage) {
+    return '';
+  }
+
+  return `${errorCode}: ${errorMessage.replace(
+    ERROR_MESSAGE_TOKEN_PATTERN,
+    (match: string, index: number) => String(messageParameters[index]),
+  )}`;
+}
+
+export interface CustomErrorOptions<T> {
+  messageParameters?: unknown[];
+  data: T;
+}
+
+/**
+ * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error`, simplifies
+ * generating error messages via predefined error codes and allows attaching custom data to the error instance.
+ */
+export function createCustomError<
+  ErrorCode extends string,
+  // eslint-disable-next-line @typescript-eslint/no-redeclare -- because `ErrorData` is used only as a type, we don't mind
+  ErrorData extends abstract new (...args: any) => any,
+>(
+  errorName: string,
+  errorMessages: ErrorMessages<ErrorCode>,
+  ErrorData?: ErrorData,
+): new (code: ErrorCode, options?: CustomErrorOptions<InstanceType<ErrorData>>) => CustomError<
+  ErrorCode | typeof UNKNOWN_ERROR,
+  InstanceType<ErrorData>
+> {
+  return class InternalCustomError
+    extends Error
+    implements CustomError<ErrorCode, InstanceType<ErrorData>>
+  {
+    code: ErrorCode | typeof UNKNOWN_ERROR;
+    data?: InstanceType<ErrorData>;
+
+    constructor(errorCode: ErrorCode, options?: CustomErrorOptions<InstanceType<ErrorData>>) {
+      super(createErrorMessage(errorCode, errorMessages, options?.messageParameters));
+
+      this.code = errorCode;
+      this.name = errorName;
+
+      if (typeof options?.data !== 'undefined') {
+        this.data = options.data;
+      }
+
+      // if the message is empty, we are making this an unknown error
+      if (!this.message) {
+        this.code = UNKNOWN_ERROR;
+        this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
+      }
+    }
+  };
+}

package/src/main.ts

@@ -0,0 +1,2 @@
+export * from './createCustomError.js';
+export * from './types.js';

package/src/types/CustomError.ts

@@ -0,0 +1,12 @@
+import type {UNKNOWN_ERROR} from '../constants.js';
+
+/**
+ * Type representing custom error.
+ */
+export type CustomError<ErrorCode extends string, ErrorData> = Error & {
+  /** String that is used to quickly determine the nature of the error and why it could have occurred. */
+  code: ErrorCode | typeof UNKNOWN_ERROR;
+
+  /** Data related to the error that can be used during the error handling process to gain more information or take an action. */
+  data?: ErrorData;
+};

package/src/types/ErrorMessages.ts

@@ -0,0 +1,4 @@
+/**
+ * Object type whose property keys are `ErrorCode` and whose property values are `string`.
+ */
+export type ErrorMessages<ErrorCode extends string> = Record<ErrorCode, string>;

package/src/types.ts

@@ -0,0 +1,2 @@
+export * from './types/CustomError.js';
+export * from './types/ErrorMessages.js';