@jakubmazanec/error 3.0.15 → 3.0.16-unstable.2468857d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,10 @@
1
- "use strict";
2
- export const ERROR_MESSAGE_TOKEN_PATTERN = /\{(\d+)\}/gu;
3
- export const UNKNOWN_ERROR = "UNKNOWN_ERROR";
4
- export const INTERNAL_ERROR_MESSAGES = {
5
- [UNKNOWN_ERROR]: "An unknown error has occurred."
6
- };
7
- //# sourceMappingURL=constants.js.map
1
+ //#region source/constants.ts
2
+ const ERROR_MESSAGE_TOKEN_PATTERN = /\{(\d+)\}/gu;
3
+ /**
4
+ * Code for an unknown error. You should never use nor encounter this error code.
5
+ */
6
+ const UNKNOWN_ERROR = "UNKNOWN_ERROR";
7
+ const INTERNAL_ERROR_MESSAGES = { [UNKNOWN_ERROR]: "An unknown error has occurred." };
8
+
9
+ //#endregion
10
+ export { ERROR_MESSAGE_TOKEN_PATTERN, INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR };
@@ -1,23 +1,32 @@
1
- "use strict";
2
1
  import { INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR } from "./constants.js";
3
- import { createErrorMessage } from "./internals.js";
4
- export function createCustomError(errorName, errorMessages) {
5
- return class InternalCustomError extends Error {
6
- code;
7
- constructor(errorCode, options) {
8
- let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
9
- let errorOptions = {};
10
- if (options?.cause !== void 0) {
11
- errorOptions.cause = options.cause;
12
- }
13
- super(errorMessage, errorOptions);
14
- this.code = errorCode;
15
- this.name = errorName;
16
- if (!this.message) {
17
- this.code = UNKNOWN_ERROR;
18
- this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
19
- }
20
- }
21
- };
2
+ import { createErrorMessage } from "./internals/createErrorMessage.js";
3
+
4
+ //#region source/createCustomError.ts
5
+ /**
6
+ * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error` and simplifies
7
+ * generating error messages via predefined error codes.
8
+ *
9
+ * @param errorName Error name.
10
+ * @param errorMessages Object containing all possible error messages.
11
+ * @return Class that implements {@link CustomError}.
12
+ */
13
+ function createCustomError(errorName, errorMessages) {
14
+ return class InternalCustomError extends Error {
15
+ code;
16
+ constructor(errorCode, options) {
17
+ let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
18
+ let errorOptions = {};
19
+ if (options?.cause !== void 0) errorOptions.cause = options.cause;
20
+ super(errorMessage, errorOptions);
21
+ this.code = errorCode;
22
+ this.name = errorName;
23
+ if (!this.message) {
24
+ this.code = UNKNOWN_ERROR;
25
+ this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
26
+ }
27
+ }
28
+ };
22
29
  }
23
- //# sourceMappingURL=createCustomError.js.map
30
+
31
+ //#endregion
32
+ export { createCustomError };
@@ -1,27 +1,26 @@
1
- "use strict";
2
1
  import { INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR } from "./constants.js";
3
- import { createErrorMessage } from "./internals.js";
4
- export function createCustomErrorWithData(errorName, errorMessages, errorData) {
5
- return class InternalCustomError extends Error {
6
- code;
7
- data;
8
- constructor(errorCode, options) {
9
- let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
10
- let errorOptions = {};
11
- if (options?.cause !== void 0) {
12
- errorOptions.cause = options.cause;
13
- }
14
- super(errorMessage, errorOptions);
15
- this.code = errorCode;
16
- this.name = errorName;
17
- if (options?.data !== void 0) {
18
- this.data = options.data;
19
- }
20
- if (!this.message) {
21
- this.code = UNKNOWN_ERROR;
22
- this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
23
- }
24
- }
25
- };
2
+ import { createErrorMessage } from "./internals/createErrorMessage.js";
3
+
4
+ //#region source/createCustomErrorWithData.ts
5
+ function createCustomErrorWithData(errorName, errorMessages, errorData) {
6
+ return class InternalCustomError extends Error {
7
+ code;
8
+ data;
9
+ constructor(errorCode, options) {
10
+ let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
11
+ let errorOptions = {};
12
+ if (options?.cause !== void 0) errorOptions.cause = options.cause;
13
+ super(errorMessage, errorOptions);
14
+ this.code = errorCode;
15
+ this.name = errorName;
16
+ if (options?.data !== void 0) this.data = options.data;
17
+ if (!this.message) {
18
+ this.code = UNKNOWN_ERROR;
19
+ this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
20
+ }
21
+ }
22
+ };
26
23
  }
27
- //# sourceMappingURL=createCustomErrorWithData.js.map
24
+
25
+ //#endregion
26
+ export { createCustomErrorWithData };
@@ -1,13 +1,19 @@
1
- "use strict";
2
1
  import { ERROR_MESSAGE_TOKEN_PATTERN } from "../constants.js";
3
- export function createErrorMessage(errorCode, errorMessages, messageParameters = []) {
4
- let errorMessage = errorMessages[errorCode];
5
- if (!errorMessage) {
6
- return "";
7
- }
8
- return `${errorCode}: ${errorMessage.replace(
9
- ERROR_MESSAGE_TOKEN_PATTERN,
10
- (match, index) => String(messageParameters[index])
11
- )}`;
2
+
3
+ //#region source/internals/createErrorMessage.ts
4
+ /**
5
+ * A function that generates an error message based on provided error code and message parameters. It is used only internally.
6
+ *
7
+ * @param errorCode Error code.
8
+ * @param errorMessages Object containing all possible error messages.
9
+ * @param messageParameters Array of values that are used as message parameters.
10
+ * @return Error message.
11
+ */
12
+ function createErrorMessage(errorCode, errorMessages, messageParameters = []) {
13
+ let errorMessage = errorMessages[errorCode];
14
+ if (!errorMessage) return "";
15
+ return `${errorCode}: ${errorMessage.replace(ERROR_MESSAGE_TOKEN_PATTERN, (match, index) => String(messageParameters[index]))}`;
12
16
  }
13
- //# sourceMappingURL=createErrorMessage.js.map
17
+
18
+ //#endregion
19
+ export { createErrorMessage };
package/build/main.js CHANGED
@@ -1,5 +1,5 @@
1
- "use strict";
2
- export { UNKNOWN_ERROR } from "./constants.js";
3
- export * from "./createCustomError.js";
4
- export * from "./createCustomErrorWithData.js";
5
- //# sourceMappingURL=main.js.map
1
+ import { UNKNOWN_ERROR } from "./constants.js";
2
+ import { createCustomError } from "./createCustomError.js";
3
+ import { createCustomErrorWithData } from "./createCustomErrorWithData.js";
4
+
5
+ export { UNKNOWN_ERROR, createCustomError, createCustomErrorWithData };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jakubmazanec/error",
3
- "version": "3.0.15",
3
+ "version": "3.0.16-unstable.2468857d",
4
4
  "description": "Collection of utilities for creating and handling errors.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,9 +17,9 @@
17
17
  "source"
18
18
  ],
19
19
  "scripts": {
20
- "build": "del-cli build tsconfig.tsbuildinfo && esbuild \"source/**/*\" --platform=node --target=node24.3 --outdir=build --sourcemap && tsc",
20
+ "build": "del-cli build tsconfig.tsbuildinfo && tsdown && tsc",
21
21
  "clean": "del-cli coverage build *.tsbuildinfo",
22
- "develop": "concurrently \"esbuild \"source/**/*\" --platform=node --target=node24.3 --outdir=build --sourcemap --watch\" \"tsc --watch\"",
22
+ "develop": "concurrently \"tsdown --watch\" \"tsc --watch\"",
23
23
  "document": "del-cli docs && typedoc --options typedoc.config.cjs",
24
24
  "format": "prettier . --write --ignore-unknown",
25
25
  "lint": "eslint .",
@@ -30,17 +30,17 @@
30
30
  "zod": "^4.1.13"
31
31
  },
32
32
  "devDependencies": {
33
- "@jakubmazanec/eslint-config": "^4.1.0",
33
+ "@jakubmazanec/eslint-config": "4.1.10-unstable.2468857d",
34
34
  "@types/lodash": "^4.17.21",
35
35
  "@types/node": "^24.0.4",
36
36
  "@vitest/coverage-v8": "^3.2.4",
37
37
  "concurrently": "^9.2.1",
38
38
  "del-cli": "^6.0.0",
39
- "esbuild": "^0.27.0",
40
39
  "eslint": "^9.33.0",
41
40
  "lodash": "^4.17.21",
42
41
  "prettier": "^3.6.2",
43
42
  "prettier-plugin-packagejson": "^2.5.19",
43
+ "tsdown": "^0.17.2",
44
44
  "typedoc": "^0.28.14",
45
45
  "typedoc-plugin-markdown": "^4.9.0",
46
46
  "typescript": "^5.9.3",
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../source/constants.ts"],
4
- "sourcesContent": ["export const ERROR_MESSAGE_TOKEN_PATTERN = /\\{(\\d+)\\}/gu;\n\n/**\n * Code for an unknown error. You should never use nor encounter this error code.\n */\nexport const UNKNOWN_ERROR = 'UNKNOWN_ERROR';\n\nexport const INTERNAL_ERROR_MESSAGES = {\n [UNKNOWN_ERROR]: 'An unknown error has occurred.',\n};\n"],
5
- "mappings": ";AAAO,aAAM,8BAA8B;AAKpC,aAAM,gBAAgB;AAEtB,aAAM,0BAA0B;AAAA,EACrC,CAAC,aAAa,GAAG;AACnB;",
6
- "names": []
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../source/createCustomError.ts"],
4
- "sourcesContent": ["import {INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR} from './constants.js';\nimport {createErrorMessage} from './internals.js';\nimport {type CustomError, type CustomErrorOptions, type ErrorMessages} from './types.js';\n\n/**\n * Function for creating custom error classes. Such custom error class properly subclasses built-in `Error` and simplifies\n * generating error messages via predefined error codes.\n *\n * @param errorName Error name.\n * @param errorMessages Object containing all possible error messages.\n * @return Class that implements {@link CustomError}.\n */\nexport function createCustomError<ErrorCode extends string>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n): new (\n code: ErrorCode,\n options?: CustomErrorOptions,\n) => CustomError<ErrorCode | typeof UNKNOWN_ERROR> {\n return class InternalCustomError extends Error implements CustomError<ErrorCode> {\n code: ErrorCode | typeof UNKNOWN_ERROR;\n\n constructor(errorCode: ErrorCode, options?: CustomErrorOptions) {\n let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);\n let errorOptions: ErrorOptions = {};\n\n if (options?.cause !== undefined) {\n errorOptions.cause = options.cause;\n }\n\n super(errorMessage, errorOptions);\n\n this.code = errorCode;\n this.name = errorName;\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"],
5
- "mappings": ";AAAA,SAAQ,yBAAyB,qBAAoB;AACrD,SAAQ,0BAAyB;AAW1B,gBAAS,kBACd,WACA,eAIiD;AACjD,SAAO,MAAM,4BAA4B,MAAwC;AAAA,IAC/E;AAAA,IAEA,YAAY,WAAsB,SAA8B;AAC9D,UAAI,eAAe,mBAAmB,WAAW,eAAe,SAAS,iBAAiB;AAC1F,UAAI,eAA6B,CAAC;AAElC,UAAI,SAAS,UAAU,QAAW;AAChC,qBAAa,QAAQ,QAAQ;AAAA,MAC/B;AAEA,YAAM,cAAc,YAAY;AAEhC,WAAK,OAAO;AACZ,WAAK,OAAO;AAGZ,UAAI,CAAC,KAAK,SAAS;AACjB,aAAK,OAAO;AACZ,aAAK,UAAU,mBAAmB,eAAe,uBAAuB;AAAA,MAC1E;AAAA,IACF;AAAA,EACF;AACF;",
6
- "names": []
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../source/createCustomErrorWithData.ts"],
4
- "sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type z, type ZodObject} from 'zod';\n\nimport {INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR} from './constants.js';\nimport {createErrorMessage} from './internals.js';\nimport {\n type CustomErrorWithData,\n type CustomErrorWithDataOptions,\n type ErrorMessages,\n} from './types.js';\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 *\n * @param errorName Error name.\n * @param errorMessages Object containing all possible error messages.\n * @param errorData Runtime representation of the `ErrorData` type parameter; can be either a class expression, or a Zod schema.\n * @return Class that implements {@link CustomErrorWithData}.\n */\nexport function createCustomErrorWithData<ErrorCode extends string, ErrorData extends ZodObject>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n errorData: ErrorData,\n): new (\n code: ErrorCode,\n options?: CustomErrorWithDataOptions<z.infer<ErrorData>>,\n) => CustomErrorWithData<ErrorCode | typeof UNKNOWN_ERROR, z.infer<ErrorData>>;\nexport function createCustomErrorWithData<\n ErrorCode extends string,\n ErrorData extends abstract new (...args: any) => any,\n>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n errorData: ErrorData,\n): new (\n code: ErrorCode,\n options?: CustomErrorWithDataOptions<InstanceType<ErrorData>>,\n) => CustomErrorWithData<ErrorCode | typeof UNKNOWN_ERROR, InstanceType<ErrorData>>;\nexport function createCustomErrorWithData<ErrorCode extends string, ErrorData>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n errorData: ErrorData,\n): new (\n code: ErrorCode,\n options?: CustomErrorWithDataOptions<ErrorData>,\n) => CustomErrorWithData<ErrorCode | typeof UNKNOWN_ERROR, ErrorData> {\n return class InternalCustomError\n extends Error\n implements CustomErrorWithData<ErrorCode, ErrorData>\n {\n code: ErrorCode | typeof UNKNOWN_ERROR;\n data?: ErrorData;\n\n constructor(errorCode: ErrorCode, options?: CustomErrorWithDataOptions<ErrorData>) {\n let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);\n let errorOptions: ErrorOptions = {};\n\n if (options?.cause !== undefined) {\n errorOptions.cause = options.cause;\n }\n\n super(errorMessage, errorOptions);\n\n this.code = errorCode;\n this.name = errorName;\n\n if (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"],
5
- "mappings": ";AAGA,SAAQ,yBAAyB,qBAAoB;AACrD,SAAQ,0BAAyB;AAmC1B,gBAAS,0BACd,WACA,eACA,WAIoE;AACpE,SAAO,MAAM,4BACH,MAEV;AAAA,IACE;AAAA,IACA;AAAA,IAEA,YAAY,WAAsB,SAAiD;AACjF,UAAI,eAAe,mBAAmB,WAAW,eAAe,SAAS,iBAAiB;AAC1F,UAAI,eAA6B,CAAC;AAElC,UAAI,SAAS,UAAU,QAAW;AAChC,qBAAa,QAAQ,QAAQ;AAAA,MAC/B;AAEA,YAAM,cAAc,YAAY;AAEhC,WAAK,OAAO;AACZ,WAAK,OAAO;AAEZ,UAAI,SAAS,SAAS,QAAW;AAC/B,aAAK,OAAO,QAAQ;AAAA,MACtB;AAGA,UAAI,CAAC,KAAK,SAAS;AACjB,aAAK,OAAO;AACZ,aAAK,UAAU,mBAAmB,eAAe,uBAAuB;AAAA,MAC1E;AAAA,IACF;AAAA,EACF;AACF;",
6
- "names": []
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../source/internals/createErrorMessage.ts"],
4
- "sourcesContent": ["import {ERROR_MESSAGE_TOKEN_PATTERN} from '../constants.js';\nimport {type ErrorMessages} from '../types.js';\n\n/**\n * A function that generates an error message based on provided error code and message parameters. It is used only internally.\n *\n * @param errorCode Error code.\n * @param errorMessages Object containing all possible error messages.\n * @param messageParameters Array of values that are used as message parameters.\n * @return Error message.\n */\nexport function 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"],
5
- "mappings": ";AAAA,SAAQ,mCAAkC;AAWnC,gBAAS,mBACd,WACA,eACA,oBAA+B,CAAC,GACxB;AACR,MAAI,eAAe,cAAc,SAAS;AAE1C,MAAI,CAAC,cAAc;AACjB,WAAO;AAAA,EACT;AAEA,SAAO,GAAG,SAAS,KAAK,aAAa;AAAA,IACnC;AAAA,IACA,CAAC,OAAe,UAAkB,OAAO,kBAAkB,KAAK,CAAC;AAAA,EACnE,CAAC;AACH;",
6
- "names": []
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- export * from "./internals/createErrorMessage.js";
3
- //# sourceMappingURL=internals.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../source/internals.ts"],
4
- "sourcesContent": ["export * from './internals/createErrorMessage.js';\n"],
5
- "mappings": ";AAAA,cAAc;",
6
- "names": []
7
- }
package/build/main.js.map DELETED
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../source/main.ts"],
4
- "sourcesContent": ["export {UNKNOWN_ERROR} from './constants.js';\nexport * from './createCustomError.js';\nexport * from './createCustomErrorWithData.js';\nexport type * from './types.js';\n"],
5
- "mappings": ";AAAA,SAAQ,qBAAoB;AAC5B,cAAc;AACd,cAAc;",
6
- "names": []
7
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=CustomError.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=CustomErrorOptions.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=CustomErrorWithData.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=CustomErrorWithDataOptions.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=ErrorMessages.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }
package/build/types.js DELETED
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=types.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": [],
4
- "sourcesContent": [],
5
- "mappings": "",
6
- "names": []
7
- }