@jakubmazanec/error 2.0.1-9029e49 → 2.0.1-c5ebb6f

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/README.md CHANGED
@@ -1,10 +1,12 @@
1
+ <!-- header -->
1
2
  <div align="center">
2
3
 
3
4
  # @jakubmazanec/error
4
5
 
5
- <!-- description -->Collection of utilities for creating and handling errors.<!-- description -->
6
+ Collection of utilities for creating and handling errors.
6
7
 
7
8
  </div>
9
+ <!-- header -->
8
10
 
9
11
  ## Installation
10
12
 
@@ -11,9 +11,10 @@ import { createErrorMessage } from './internals.js';
11
11
  return class InternalCustomError extends Error {
12
12
  code;
13
13
  constructor(errorCode, options){
14
- let errorMessage = createErrorMessage(errorCode, errorMessages, options === null || options === void 0 ? void 0 : options.messageParameters);
14
+ var _options, _options1;
15
+ let errorMessage = createErrorMessage(errorCode, errorMessages, (_options = options) === null || _options === void 0 ? void 0 : _options.messageParameters);
15
16
  let errorOptions = {};
16
- if (typeof (options === null || options === void 0 ? void 0 : options.cause) !== 'undefined') {
17
+ if (typeof ((_options1 = options) === null || _options1 === void 0 ? void 0 : _options1.cause) !== 'undefined') {
17
18
  errorOptions.cause = options.cause;
18
19
  }
19
20
  super(errorMessage, errorOptions);
@@ -1 +1 @@
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 {@linkcode CustomError}.\n */\nexport function createCustomError<ErrorCode extends string>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n): new (code: ErrorCode, options?: CustomErrorOptions) => CustomError<\n ErrorCode | typeof UNKNOWN_ERROR\n> {\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;IAIvC,OAAO,MAAMC,4BAA4BC;QACvCC,KAAuC;QAEvCC,YAAYC,SAAoB,EAAEC,OAA4B,CAAE;YAC9D,IAAIC,eAAeV,mBAAmBQ,WAAWL,eAAeM,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASE;YACzE,IAAIC,eAA6B,CAAC;YAElC,IAAI,OAAOH,CAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASI,KAAI,MAAM,aAAa;gBACzCD,aAAaC,QAAQJ,QAAQI;YAC/B;YAEA,KAAK,CAACH,cAAcE;YAEpB,IAAI,CAACN,OAAOE;YACZ,IAAI,CAACM,OAAOZ;YAEZ,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAACa,SAAS;gBACjB,IAAI,CAACT,OAAOP;gBACZ,IAAI,CAACgB,UAAUf,mBAAmBD,eAAeD;YACnD;QACF;IACF;AACF"}
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 {@linkcode CustomError}.\n */\nexport function createCustomError<ErrorCode extends string>(\n errorName: string,\n errorMessages: ErrorMessages<ErrorCode>,\n): new (code: ErrorCode, options?: CustomErrorOptions) => CustomError<\n ErrorCode | typeof UNKNOWN_ERROR\n> {\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;IAIvC,OAAO,MAAMC,4BAA4BC;QACvCC,KAAuC;QAEvCC,YAAYC,SAAoB,EAAEC,OAA4B,CAAE;gBACEA,UAGrDA;YAHX,IAAIC,eAAeV,mBAAmBQ,WAAWL,gBAAeM,WAAAA,qBAAAA,+BAAAA,SAASE,iBAAiB;YAC1F,IAAIC,eAA6B,CAAC;YAElC,IAAI,SAAOH,YAAAA,qBAAAA,gCAAAA,UAASI,KAAK,MAAK,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"}
@@ -5,15 +5,16 @@ export function createCustomErrorWithData(errorName, errorMessages, errorData) {
5
5
  code;
6
6
  data;
7
7
  constructor(errorCode, options){
8
- let errorMessage = createErrorMessage(errorCode, errorMessages, options === null || options === void 0 ? void 0 : options.messageParameters);
8
+ var _options, _options1, _options2;
9
+ let errorMessage = createErrorMessage(errorCode, errorMessages, (_options = options) === null || _options === void 0 ? void 0 : _options.messageParameters);
9
10
  let errorOptions = {};
10
- if (typeof (options === null || options === void 0 ? void 0 : options.cause) !== 'undefined') {
11
+ if (typeof ((_options1 = options) === null || _options1 === void 0 ? void 0 : _options1.cause) !== 'undefined') {
11
12
  errorOptions.cause = options.cause;
12
13
  }
13
14
  super(errorMessage, errorOptions);
14
15
  this.code = errorCode;
15
16
  this.name = errorName;
16
- if (typeof (options === null || options === void 0 ? void 0 : options.data) !== 'undefined') {
17
+ if (typeof ((_options2 = options) === null || _options2 === void 0 ? void 0 : _options2.data) !== 'undefined') {
17
18
  this.data = options.data;
18
19
  }
19
20
  // if the message is empty, we are making this an unknown error
@@ -1 +1 @@
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 {@linkcode 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 (code: ErrorCode, options?: CustomErrorWithDataOptions<ErrorData>) => CustomErrorWithData<\n ErrorCode | typeof UNKNOWN_ERROR,\n ErrorData\n> {\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,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASE;YACzE,IAAIC,eAA6B,CAAC;YAElC,IAAI,OAAOH,CAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASI,KAAI,MAAM,aAAa;gBACzCD,aAAaC,QAAQJ,QAAQI;YAC/B;YAEA,KAAK,CAACH,cAAcE;YAEpB,IAAI,CAACP,OAAOG;YACZ,IAAI,CAACM,OAAOd;YAEZ,IAAI,OAAOS,CAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASH,IAAG,MAAM,aAAa;gBACxC,IAAI,CAACA,OAAOG,QAAQH;YACtB;YAEA,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAACS,SAAS;gBACjB,IAAI,CAACV,OAAOR;gBACZ,IAAI,CAACkB,UAAUjB,mBAAmBD,eAAeD;YACnD;QACF;IACF;AACF"}
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 {@linkcode 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 (code: ErrorCode, options?: CustomErrorWithDataOptions<ErrorData>) => CustomErrorWithData<\n ErrorCode | typeof UNKNOWN_ERROR,\n ErrorData\n> {\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;gBACjBA,UAGrDA,WASAA;YAZX,IAAIC,eAAeZ,mBAAmBU,WAAWP,gBAAeQ,WAAAA,qBAAAA,+BAAAA,SAASE,iBAAiB;YAC1F,IAAIC,eAA6B,CAAC;YAElC,IAAI,SAAOH,YAAAA,qBAAAA,gCAAAA,UAASI,KAAK,MAAK,aAAa;gBACzCD,aAAaC,KAAK,GAAGJ,QAAQI,KAAK;YACpC;YAEA,KAAK,CAACH,cAAcE;YAEpB,IAAI,CAACP,IAAI,GAAGG;YACZ,IAAI,CAACM,IAAI,GAAGd;YAEZ,IAAI,SAAOS,YAAAA,qBAAAA,gCAAAA,UAASH,IAAI,MAAK,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 +1 @@
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,QACnCN,6BACA,CAACO,OAAeC,QAAkBC,OAAOL,iBAAiB,CAACI,MAAM,GACjE,CAAC;AACL"}
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jakubmazanec/error",
3
- "version": "2.0.1-9029e49",
3
+ "version": "2.0.1-c5ebb6f",
4
4
  "description": "Collection of utilities for creating and handling errors.",
5
5
  "repository": {
6
6
  "type": "git",