@jakubmazanec/error 3.0.0-next.a956e19 → 3.0.0-next.b3909a5
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.
- package/build/constants.js +7 -0
- package/build/constants.js.map +7 -0
- package/build/createCustomError.js +23 -0
- package/build/createCustomError.js.map +7 -0
- package/{dist → build}/createCustomErrorWithData.d.ts +1 -1
- package/build/createCustomErrorWithData.js +27 -0
- package/build/createCustomErrorWithData.js.map +7 -0
- package/build/internals/createErrorMessage.js +13 -0
- package/build/internals/createErrorMessage.js.map +7 -0
- package/build/internals.js +3 -0
- package/build/internals.js.map +7 -0
- package/build/main.js +6 -0
- package/build/main.js.map +7 -0
- package/build/types/CustomError.js +2 -0
- package/build/types/CustomError.js.map +7 -0
- package/build/types/CustomErrorOptions.js +2 -0
- package/build/types/CustomErrorOptions.js.map +7 -0
- package/{dist → build}/types/CustomErrorWithData.d.ts +1 -1
- package/build/types/CustomErrorWithData.js +2 -0
- package/build/types/CustomErrorWithData.js.map +7 -0
- package/build/types/CustomErrorWithDataOptions.js +2 -0
- package/build/types/CustomErrorWithDataOptions.js.map +7 -0
- package/build/types/ErrorMessages.js +2 -0
- package/build/types/ErrorMessages.js.map +7 -0
- package/build/types.js +7 -0
- package/build/types.js.map +7 -0
- package/package.json +22 -11
- package/{src → source}/createCustomError.ts +1 -1
- package/{src → source}/createCustomErrorWithData.ts +3 -3
- package/{src → source}/types/CustomErrorWithData.ts +1 -1
- package/dist/constants.js +0 -9
- package/dist/constants.js.map +0 -1
- package/dist/createCustomError.js +0 -31
- package/dist/createCustomError.js.map +0 -1
- package/dist/createCustomErrorWithData.js +0 -28
- package/dist/createCustomErrorWithData.js.map +0 -1
- package/dist/internals/createErrorMessage.js +0 -17
- package/dist/internals/createErrorMessage.js.map +0 -1
- package/dist/internals.js +0 -3
- package/dist/internals.js.map +0 -1
- package/dist/main.js +0 -6
- package/dist/main.js.map +0 -1
- package/dist/types/CustomError.js +0 -5
- package/dist/types/CustomError.js.map +0 -1
- package/dist/types/CustomErrorOptions.js +0 -5
- package/dist/types/CustomErrorOptions.js.map +0 -1
- package/dist/types/CustomErrorWithData.js +0 -5
- package/dist/types/CustomErrorWithData.js.map +0 -1
- package/dist/types/CustomErrorWithDataOptions.js +0 -5
- package/dist/types/CustomErrorWithDataOptions.js.map +0 -1
- package/dist/types/ErrorMessages.js +0 -5
- package/dist/types/ErrorMessages.js.map +0 -1
- package/dist/types.js +0 -7
- package/dist/types.js.map +0 -1
- package/{dist → build}/constants.d.ts +0 -0
- package/{dist → build}/createCustomError.d.ts +0 -0
- package/{dist → build}/internals/createErrorMessage.d.ts +0 -0
- package/{dist → build}/internals.d.ts +0 -0
- package/{dist → build}/main.d.ts +1 -1
- package/{dist → build}/types/CustomError.d.ts +0 -0
- package/{dist → build}/types/CustomErrorOptions.d.ts +0 -0
- package/{dist → build}/types/CustomErrorWithDataOptions.d.ts +0 -0
- package/{dist → build}/types/ErrorMessages.d.ts +0 -0
- package/{dist → build}/types.d.ts +0 -0
- package/{src → source}/constants.ts +0 -0
- package/{src → source}/internals/createErrorMessage.ts +0 -0
- package/{src → source}/internals.ts +0 -0
- package/{src → source}/main.ts +1 -1
- /package/{src → source}/types/CustomError.ts +0 -0
- /package/{src → source}/types/CustomErrorOptions.ts +0 -0
- /package/{src → source}/types/CustomErrorWithDataOptions.ts +0 -0
- /package/{src → source}/types/ErrorMessages.ts +0 -0
- /package/{src → source}/types.ts +0 -0
|
@@ -0,0 +1,7 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
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
|
+
};
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=createCustomError.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
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
|
+
};
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=createCustomErrorWithData.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../source/createCustomErrorWithData.ts"],
|
|
4
|
+
"sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type AnyZodObject, type z} 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 AnyZodObject>(\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
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
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
|
+
)}`;
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=createErrorMessage.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
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
|
+
}
|
package/build/main.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
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 * from './types.js';\n"],
|
|
5
|
+
"mappings": ";AAAA,SAAQ,qBAAoB;AAC5B,cAAc;AACd,cAAc;AACd,cAAc;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/build/types.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
export * from "./types/CustomError.js";
|
|
3
|
+
export * from "./types/CustomErrorOptions.js";
|
|
4
|
+
export * from "./types/CustomErrorWithData.js";
|
|
5
|
+
export * from "./types/CustomErrorWithDataOptions.js";
|
|
6
|
+
export * from "./types/ErrorMessages.js";
|
|
7
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../source/types.ts"],
|
|
4
|
+
"sourcesContent": ["export * from './types/CustomError.js';\nexport * from './types/CustomErrorOptions.js';\nexport * from './types/CustomErrorWithData.js';\nexport * from './types/CustomErrorWithDataOptions.js';\nexport * from './types/ErrorMessages.js';\n"],
|
|
5
|
+
"mappings": ";AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jakubmazanec/error",
|
|
3
|
-
"version": "3.0.0-next.
|
|
3
|
+
"version": "3.0.0-next.b3909a5",
|
|
4
4
|
"description": "Collection of utilities for creating and handling errors.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -11,26 +11,37 @@
|
|
|
11
11
|
"author": "Jakub Mazanec <jakub@mazanec.dev>",
|
|
12
12
|
"sideEffects": false,
|
|
13
13
|
"type": "module",
|
|
14
|
-
"exports": "./
|
|
14
|
+
"exports": "./build/main.js",
|
|
15
15
|
"files": [
|
|
16
|
-
"
|
|
17
|
-
"
|
|
16
|
+
"build",
|
|
17
|
+
"source"
|
|
18
18
|
],
|
|
19
19
|
"scripts": {
|
|
20
|
-
"build": "
|
|
21
|
-
"clean": "del-cli coverage
|
|
22
|
-
"
|
|
23
|
-
"
|
|
20
|
+
"build": "del-cli build tsconfig.tsbuildinfo && esbuild \"source/**/*\" --platform=node --target=node20.8 --outdir=build --sourcemap && tsc",
|
|
21
|
+
"clean": "del-cli coverage build *.tsbuildinfo",
|
|
22
|
+
"develop": "concurrently \"esbuild \"source/**/*\" --platform=node --target=node20.8 --outdir=build --sourcemap --watch\" \"tsc --watch\"",
|
|
23
|
+
"document": "del-cli docs && typedoc --options typedoc.config.cjs",
|
|
24
|
+
"format": "prettier . --write --ignore-unknown",
|
|
24
25
|
"lint": "eslint .",
|
|
25
|
-
"test": "
|
|
26
|
+
"test": "del-cli coverage && vitest run --coverage --passWithNoTests",
|
|
26
27
|
"typecheck": "tsc --project tsconfig.typecheck.json"
|
|
27
28
|
},
|
|
28
29
|
"dependencies": {
|
|
29
30
|
"zod": "^3.21.4"
|
|
30
31
|
},
|
|
31
32
|
"devDependencies": {
|
|
32
|
-
"@
|
|
33
|
-
"@
|
|
33
|
+
"@types/node": "^20.8.5",
|
|
34
|
+
"@vitest/coverage-v8": "^1.2.0",
|
|
35
|
+
"concurrently": "^8.0.0",
|
|
36
|
+
"del-cli": "^5.0.0",
|
|
37
|
+
"esbuild": "^0.19.11",
|
|
38
|
+
"eslint": "^8.56.0",
|
|
39
|
+
"prettier": "^3.0.0",
|
|
40
|
+
"prettier-plugin-packagejson": "^2.4.3",
|
|
41
|
+
"typedoc": "^0.25.2",
|
|
42
|
+
"typedoc-plugin-markdown": "^3.15.1",
|
|
43
|
+
"typescript": "^5.1.3",
|
|
44
|
+
"vitest": "^1.2.0"
|
|
34
45
|
},
|
|
35
46
|
"packageManager": "npm@10.1.0",
|
|
36
47
|
"engines": {
|
|
@@ -24,7 +24,7 @@ export function createCustomError<ErrorCode extends string>(
|
|
|
24
24
|
let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
|
|
25
25
|
let errorOptions: ErrorOptions = {};
|
|
26
26
|
|
|
27
|
-
if (
|
|
27
|
+
if (options?.cause !== undefined) {
|
|
28
28
|
errorOptions.cause = options.cause;
|
|
29
29
|
}
|
|
30
30
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/* eslint-disable @typescript-eslint/no-explicit-any -- needed */
|
|
2
|
-
import {type
|
|
2
|
+
import {type AnyZodObject, type z} from 'zod';
|
|
3
3
|
|
|
4
4
|
import {INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR} from './constants.js';
|
|
5
5
|
import {createErrorMessage} from './internals.js';
|
|
@@ -56,7 +56,7 @@ export function createCustomErrorWithData<ErrorCode extends string, ErrorData>(
|
|
|
56
56
|
let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
|
|
57
57
|
let errorOptions: ErrorOptions = {};
|
|
58
58
|
|
|
59
|
-
if (
|
|
59
|
+
if (options?.cause !== undefined) {
|
|
60
60
|
errorOptions.cause = options.cause;
|
|
61
61
|
}
|
|
62
62
|
|
|
@@ -65,7 +65,7 @@ export function createCustomErrorWithData<ErrorCode extends string, ErrorData>(
|
|
|
65
65
|
this.code = errorCode;
|
|
66
66
|
this.name = errorName;
|
|
67
67
|
|
|
68
|
-
if (
|
|
68
|
+
if (options?.data !== undefined) {
|
|
69
69
|
this.data = options.data;
|
|
70
70
|
}
|
|
71
71
|
|
package/dist/constants.js
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export const ERROR_MESSAGE_TOKEN_PATTERN = /\{(\d+)\}/gu;
|
|
2
|
-
/**
|
|
3
|
-
* Code for an unknown error. You should never use nor encounter this error code.
|
|
4
|
-
*/ export const UNKNOWN_ERROR = 'UNKNOWN_ERROR';
|
|
5
|
-
export const INTERNAL_ERROR_MESSAGES = {
|
|
6
|
-
[UNKNOWN_ERROR]: 'An unknown error has occurred.'
|
|
7
|
-
};
|
|
8
|
-
|
|
9
|
-
//# sourceMappingURL=constants.js.map
|
package/dist/constants.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/constants.ts"],"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"],"names":["ERROR_MESSAGE_TOKEN_PATTERN","UNKNOWN_ERROR","INTERNAL_ERROR_MESSAGES"],"mappings":"AAAA,OAAO,MAAMA,8BAA8B,cAAc;AAEzD;;CAEC,GACD,OAAO,MAAMC,gBAAgB,gBAAgB;AAE7C,OAAO,MAAMC,0BAA0B;IACrC,CAACD,cAAc,EAAE;AACnB,EAAE"}
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import { INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR } from './constants.js';
|
|
2
|
-
import { createErrorMessage } from './internals.js';
|
|
3
|
-
/**
|
|
4
|
-
* Function for creating custom error classes. Such custom error class properly subclasses built-in `Error` and simplifies
|
|
5
|
-
* generating error messages via predefined error codes.
|
|
6
|
-
*
|
|
7
|
-
* @param errorName Error name.
|
|
8
|
-
* @param errorMessages Object containing all possible error messages.
|
|
9
|
-
* @return Class that implements {@link CustomError}.
|
|
10
|
-
*/ export function createCustomError(errorName, errorMessages) {
|
|
11
|
-
return class InternalCustomError extends Error {
|
|
12
|
-
code;
|
|
13
|
-
constructor(errorCode, options){
|
|
14
|
-
let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
|
|
15
|
-
let errorOptions = {};
|
|
16
|
-
if (typeof options?.cause !== 'undefined') {
|
|
17
|
-
errorOptions.cause = options.cause;
|
|
18
|
-
}
|
|
19
|
-
super(errorMessage, errorOptions);
|
|
20
|
-
this.code = errorCode;
|
|
21
|
-
this.name = errorName;
|
|
22
|
-
// if the message is empty, we are making this an unknown error
|
|
23
|
-
if (!this.message) {
|
|
24
|
-
this.code = UNKNOWN_ERROR;
|
|
25
|
-
this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
//# sourceMappingURL=createCustomError.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/createCustomError.ts"],"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 (typeof 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"],"names":["INTERNAL_ERROR_MESSAGES","UNKNOWN_ERROR","createErrorMessage","createCustomError","errorName","errorMessages","InternalCustomError","Error","code","constructor","errorCode","options","errorMessage","messageParameters","errorOptions","cause","name","message"],"mappings":"AAAA,SAAQA,uBAAuB,EAAEC,aAAa,QAAO,iBAAiB;AACtE,SAAQC,kBAAkB,QAAO,iBAAiB;AAGlD;;;;;;;CAOC,GACD,OAAO,SAASC,kBACdC,SAAiB,EACjBC,aAAuC;IAKvC,OAAO,MAAMC,4BAA4BC;QACvCC,KAAuC;QAEvCC,YAAYC,SAAoB,EAAEC,OAA4B,CAAE;YAC9D,IAAIC,eAAeV,mBAAmBQ,WAAWL,eAAeM,SAASE;YACzE,IAAIC,eAA6B,CAAC;YAElC,IAAI,OAAOH,SAASI,UAAU,aAAa;gBACzCD,aAAaC,KAAK,GAAGJ,QAAQI,KAAK;YACpC;YAEA,KAAK,CAACH,cAAcE;YAEpB,IAAI,CAACN,IAAI,GAAGE;YACZ,IAAI,CAACM,IAAI,GAAGZ;YAEZ,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAACa,OAAO,EAAE;gBACjB,IAAI,CAACT,IAAI,GAAGP;gBACZ,IAAI,CAACgB,OAAO,GAAGf,mBAAmBD,eAAeD;YACnD;QACF;IACF;AACF"}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ import { INTERNAL_ERROR_MESSAGES, UNKNOWN_ERROR } from './constants.js';
|
|
2
|
-
import { createErrorMessage } from './internals.js';
|
|
3
|
-
export function createCustomErrorWithData(errorName, errorMessages, errorData) {
|
|
4
|
-
return class InternalCustomError extends Error {
|
|
5
|
-
code;
|
|
6
|
-
data;
|
|
7
|
-
constructor(errorCode, options){
|
|
8
|
-
let errorMessage = createErrorMessage(errorCode, errorMessages, options?.messageParameters);
|
|
9
|
-
let errorOptions = {};
|
|
10
|
-
if (typeof options?.cause !== 'undefined') {
|
|
11
|
-
errorOptions.cause = options.cause;
|
|
12
|
-
}
|
|
13
|
-
super(errorMessage, errorOptions);
|
|
14
|
-
this.code = errorCode;
|
|
15
|
-
this.name = errorName;
|
|
16
|
-
if (typeof options?.data !== 'undefined') {
|
|
17
|
-
this.data = options.data;
|
|
18
|
-
}
|
|
19
|
-
// if the message is empty, we are making this an unknown error
|
|
20
|
-
if (!this.message) {
|
|
21
|
-
this.code = UNKNOWN_ERROR;
|
|
22
|
-
this.message = createErrorMessage(UNKNOWN_ERROR, INTERNAL_ERROR_MESSAGES);
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
//# sourceMappingURL=createCustomErrorWithData.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/createCustomErrorWithData.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type z, type AnyZodObject} 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 AnyZodObject>(\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 (typeof 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 (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":["INTERNAL_ERROR_MESSAGES","UNKNOWN_ERROR","createErrorMessage","createCustomErrorWithData","errorName","errorMessages","errorData","InternalCustomError","Error","code","data","constructor","errorCode","options","errorMessage","messageParameters","errorOptions","cause","name","message"],"mappings":"AAAA,+DAA+D,GAG/D,SAAQA,uBAAuB,EAAEC,aAAa,QAAO,iBAAiB;AACtE,SAAQC,kBAAkB,QAAO,iBAAiB;AAmClD,OAAO,SAASC,0BACdC,SAAiB,EACjBC,aAAuC,EACvCC,SAAoB;IAKpB,OAAO,MAAMC,4BACHC;QAGRC,KAAuC;QACvCC,KAAiB;QAEjBC,YAAYC,SAAoB,EAAEC,OAA+C,CAAE;YACjF,IAAIC,eAAeZ,mBAAmBU,WAAWP,eAAeQ,SAASE;YACzE,IAAIC,eAA6B,CAAC;YAElC,IAAI,OAAOH,SAASI,UAAU,aAAa;gBACzCD,aAAaC,KAAK,GAAGJ,QAAQI,KAAK;YACpC;YAEA,KAAK,CAACH,cAAcE;YAEpB,IAAI,CAACP,IAAI,GAAGG;YACZ,IAAI,CAACM,IAAI,GAAGd;YAEZ,IAAI,OAAOS,SAASH,SAAS,aAAa;gBACxC,IAAI,CAACA,IAAI,GAAGG,QAAQH,IAAI;YAC1B;YAEA,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAACS,OAAO,EAAE;gBACjB,IAAI,CAACV,IAAI,GAAGR;gBACZ,IAAI,CAACkB,OAAO,GAAGjB,mBAAmBD,eAAeD;YACnD;QACF;IACF;AACF"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { ERROR_MESSAGE_TOKEN_PATTERN } from '../constants.js';
|
|
2
|
-
/**
|
|
3
|
-
* A function that generates an error message based on provided error code and message parameters. It is used only internally.
|
|
4
|
-
*
|
|
5
|
-
* @param errorCode Error code.
|
|
6
|
-
* @param errorMessages Object containing all possible error messages.
|
|
7
|
-
* @param messageParameters Array of values that are used as message parameters.
|
|
8
|
-
* @return Error message.
|
|
9
|
-
*/ export function createErrorMessage(errorCode, errorMessages, messageParameters = []) {
|
|
10
|
-
let errorMessage = errorMessages[errorCode];
|
|
11
|
-
if (!errorMessage) {
|
|
12
|
-
return '';
|
|
13
|
-
}
|
|
14
|
-
return `${errorCode}: ${errorMessage.replace(ERROR_MESSAGE_TOKEN_PATTERN, (match, index)=>String(messageParameters[index]))}`;
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
//# sourceMappingURL=createErrorMessage.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/internals/createErrorMessage.ts"],"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"],"names":["ERROR_MESSAGE_TOKEN_PATTERN","createErrorMessage","errorCode","errorMessages","messageParameters","errorMessage","replace","match","index","String"],"mappings":"AAAA,SAAQA,2BAA2B,QAAO,kBAAkB;AAG5D;;;;;;;CAOC,GACD,OAAO,SAASC,mBACdC,SAAY,EACZC,aAA+B,EAC/BC,oBAA+B,EAAE;IAEjC,IAAIC,eAAeF,aAAa,CAACD,UAAU;IAE3C,IAAI,CAACG,cAAc;QACjB,OAAO;IACT;IAEA,OAAO,CAAC,EAAEH,UAAU,EAAE,EAAEG,aAAaC,OAAO,CAC1CN,6BACA,CAACO,OAAeC,QAAkBC,OAAOL,iBAAiB,CAACI,MAAM,GACjE,CAAC;AACL"}
|
package/dist/internals.js
DELETED
package/dist/internals.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/internals.ts"],"sourcesContent":["export * from './internals/createErrorMessage.js';\n"],"names":[],"mappings":"AAAA,cAAc,oCAAoC"}
|
package/dist/main.js
DELETED
package/dist/main.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/main.ts"],"sourcesContent":["export * from './createCustomError.js';\nexport * from './createCustomErrorWithData.js';\nexport * from './types.js';\nexport {UNKNOWN_ERROR} from './constants.js';\n"],"names":["UNKNOWN_ERROR"],"mappings":"AAAA,cAAc,yBAAyB;AACvC,cAAc,iCAAiC;AAC/C,cAAc,aAAa;AAC3B,SAAQA,aAAa,QAAO,iBAAiB"}
|
|
@@ -1 +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> = 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"],"names":[],"mappings":"AAEA;;CAEC,GACD,WAGE"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types/CustomErrorOptions.ts"],"sourcesContent":["/**\n * Type representing options object used when instantianting class returned from {@link createCustomError}.\n */\nexport type CustomErrorOptions = {\n /** Array of values that are used as parameters to generate the error message. */\n messageParameters?: unknown[];\n\n /** Used for setting `cause` property of an error instance that indicates the specific original cause of the error. */\n cause?: unknown;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAME"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types/CustomErrorWithData.ts"],"sourcesContent":["import type {UNKNOWN_ERROR} from '../constants.js';\n\n/**\n * Type representing custom error that can have an arbitrary data attached.\n */\nexport type CustomErrorWithData<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":"AAEA;;CAEC,GACD,WAME"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types/CustomErrorWithDataOptions.ts"],"sourcesContent":["/**\n * Type representing options object used when instantianting class returned from {@link createCustomErrorWithData}.\n */\nexport type CustomErrorWithDataOptions<ErrorData> = {\n /** Array of values that are used as parameters to generate the error message. */\n messageParameters?: unknown[];\n\n /** Used for setting `cause` property of an error instance that indicates the specific original cause of the error. */\n cause?: unknown;\n\n /** Custom data that will be attached to the error instance. */\n data?: ErrorData;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WASE"}
|
|
@@ -1 +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;;CAEC,GACD,WAAgF"}
|
package/dist/types.js
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
export * from './types/CustomError.js';
|
|
2
|
-
export * from './types/CustomErrorOptions.js';
|
|
3
|
-
export * from './types/CustomErrorWithData.js';
|
|
4
|
-
export * from './types/CustomErrorWithDataOptions.js';
|
|
5
|
-
export * from './types/ErrorMessages.js';
|
|
6
|
-
|
|
7
|
-
//# sourceMappingURL=types.js.map
|
package/dist/types.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export * from './types/CustomError.js';\nexport * from './types/CustomErrorOptions.js';\nexport * from './types/CustomErrorWithData.js';\nexport * from './types/CustomErrorWithDataOptions.js';\nexport * from './types/ErrorMessages.js';\n"],"names":[],"mappings":"AAAA,cAAc,yBAAyB;AACvC,cAAc,gCAAgC;AAC9C,cAAc,iCAAiC;AAC/C,cAAc,wCAAwC;AACtD,cAAc,2BAA2B"}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
package/{dist → build}/main.d.ts
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
package/{src → source}/main.ts
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/{src → source}/types.ts
RENAMED
|
File without changes
|