@nhtio/encoder 0.1.0-master-ab456424

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright (c) 2025 New Horizon Technology LTD (nht.io)
+
+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/README.md

@@ -0,0 +1,5 @@
+# @nhtio/encoder
+
+A portable cross-environment encoder / decoder for complex and structured data
+
+For more information, see the [official documentation](https://encoder.nht.io)

package/exceptions-BHfZbUPp.mjs

@@ -0,0 +1,168 @@
+var k = Object.defineProperty;
+var S = (r, s, t) => s in r ? k(r, s, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[s] = t;
+var e = (r, s, t) => S(r, typeof s != "symbol" ? s + "" : s, t);
+class o extends Error {
+  /**
+   * Creates a new BaseException instance.
+   *
+   * @param message - The error message. If not provided, uses the static message from the constructor.
+   * @param options - Additional options including error cause, code, and status.
+   */
+  constructor(t, c) {
+    super(t, c);
+    /**
+     * Name of the class that raised the exception.
+     */
+    e(this, "name");
+    /**
+     * A status code for the error. Usually helpful when converting errors
+     * to HTTP responses.
+     */
+    e(this, "status");
+    const d = this.constructor;
+    this.name = d.name, this.message = t || d.message || "", this.status = (c == null ? void 0 : c.status) || d.status || 500;
+    const g = (c == null ? void 0 : c.code) || d.code;
+    g !== void 0 && (this.code = g);
+    const $ = d.help;
+    $ !== void 0 && (this.help = $), Error.captureStackTrace(this, d);
+  }
+  /**
+   * Returns the constructor name for the Symbol.toStringTag property.
+   *
+   * @returns The name of the exception class.
+   */
+  get [Symbol.toStringTag]() {
+    return this.constructor.name;
+  }
+  /**
+   * Returns a string representation of the exception.
+   * Includes the error code in brackets if available.
+   *
+   * @returns A formatted string representation of the exception.
+   */
+  toString() {
+    return this.code ? `${this.name} [${this.code}]: ${this.message}` : `${this.name}: ${this.message}`;
+  }
+}
+const n = class n extends o {
+  /**
+   * Creates a new E_UNENCODABLE_VALUE exception.
+   *
+   * @param value - The value that could not be encoded.
+   */
+  constructor(s) {
+    const t = `Value of type ${typeof s} (${String(s)}) is not encodable.`;
+    super(t, {
+      code: n.code,
+      status: n.status
+    });
+  }
+};
+e(n, "status", 500), e(n, "code", "E_UNENCODABLE_VALUE");
+let f = n;
+const u = class u extends o {
+  /**
+   * Creates a new E_ENCODING_FAILED exception.
+   *
+   * @param value - The value that failed to encode.
+   * @param cause - The underlying error that caused the encoding to fail.
+   */
+  constructor(s, t) {
+    const c = `Value of type ${typeof s} (${String(s)}) is not encodable.`;
+    super(c, {
+      code: u.code,
+      status: u.status,
+      cause: t
+    });
+  }
+};
+e(u, "status", 500), e(u, "code", "E_ENCODING_FAILED");
+let p = u;
+const i = class i extends o {
+  /**
+   * Creates a new E_CIRCULAR_REFERENCE exception.
+   */
+  constructor() {
+    super("Circular reference detected.", {
+      code: i.code,
+      status: i.status
+    });
+  }
+};
+e(i, "status", 500), e(i, "code", "E_CIRCULAR_REFERENCE");
+let x = i;
+const h = class h extends o {
+  /**
+   * Creates a new E_UNDECODABLE_VALUE exception.
+   *
+   * @param type - The type string that could not be decoded.
+   */
+  constructor(s) {
+    const t = `Value of type ${s} cannot be decoded.`;
+    super(t, {
+      code: h.code,
+      status: h.status
+    });
+  }
+};
+e(h, "status", 500), e(h, "code", "E_UNDECODABLE_VALUE");
+let v = h;
+const l = class l extends o {
+  /**
+   * Creates a new E_NOT_AN_ENCODED_VALUE exception.
+   *
+   * @param value - The string value that is not a valid encoded value.
+   */
+  constructor(s) {
+    const t = `Value "${s}" is not a valid encoded value.`;
+    super(t, {
+      code: l.code,
+      status: l.status
+    });
+  }
+};
+e(l, "status", 500), e(l, "code", "E_NOT_AN_ENCODED_VALUE");
+let b = l;
+const m = class m extends o {
+  /**
+   * Creates a new E_INVALID_VERSION exception.
+   *
+   * @param version - The invalid version string.
+   */
+  constructor(s) {
+    const t = `Invalid version "${s}"`;
+    super(t, {
+      code: m.code,
+      status: m.status
+    });
+  }
+};
+e(m, "status", 500), e(m, "code", "E_INVALID_VERSION");
+let y = m;
+const a = class a extends o {
+  /**
+   * Creates a new E_INCOMPATIBLE_VERSION exception.
+   *
+   * @param version - The incompatible version string from the encoded data.
+   */
+  constructor(s) {
+    const t = `Encoded data version ${s} is not compatible with the current version 0.1.0-master-ab456424.`;
+    super(t, {
+      code: a.code,
+      status: a.status
+    });
+  }
+};
+e(a, "status", 500), e(a, "code", "E_INCOMPATIBLE_VERSION"), e(a, "help", "This error indicates that the encoded value is from a version which is newer than the version of the decoder.");
+let w = a;
+export {
+  o as B,
+  f as E,
+  x as a,
+  p as b,
+  v as c,
+  b as d,
+  y as e,
+  w as f
+};
+//# sourceMappingURL=exceptions-BHfZbUPp.mjs.map

package/exceptions-BHfZbUPp.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions-BHfZbUPp.mjs","sources":["../src/private/exceptions.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\n\n/**\n * Base exception class that extends the native Error class.\n * Provides a foundation for all custom exceptions with additional metadata\n * like error codes, status codes, and help descriptions.\n */\nexport class BaseException extends Error {\n  /**\n   * Define the error metadata as static properties to avoid\n   * setting them repeatedly on the error instance\n   */\n  declare static help?: string\n  declare static code?: string\n  declare static status?: number\n  declare static message?: string\n\n  /**\n   * Name of the class that raised the exception.\n   */\n  name: string\n\n  /**\n   * Optional help description for the error. You can use it to define additional\n   * human readable information for the error.\n   */\n  declare help?: string\n\n  /**\n   * A machine readable error code. This will allow the error handling logic\n   * to narrow down exceptions based upon the error code.\n   */\n  declare code?: string\n\n  /**\n   * A status code for the error. Usually helpful when converting errors\n   * to HTTP responses.\n   */\n  status: number\n\n  /**\n   * Creates a new BaseException instance.\n   *\n   * @param message - The error message. If not provided, uses the static message from the constructor.\n   * @param options - Additional options including error cause, code, and status.\n   */\n  constructor(message?: string, options?: ErrorOptions & { code?: string; status?: number }) {\n    super(message, options)\n\n    const ErrorConstructor = this.constructor as typeof BaseException\n\n    this.name = ErrorConstructor.name\n    this.message = message || ErrorConstructor.message || ''\n    this.status = options?.status || ErrorConstructor.status || 500\n\n    const code = options?.code || ErrorConstructor.code\n    if (code !== undefined) {\n      this.code = code\n    }\n\n    const help = ErrorConstructor.help\n    if (help !== undefined) {\n      this.help = help\n    }\n\n    Error.captureStackTrace(this, ErrorConstructor)\n  }\n\n  /**\n   * Returns the constructor name for the Symbol.toStringTag property.\n   *\n   * @returns The name of the exception class.\n   */\n  get [Symbol.toStringTag]() {\n    return this.constructor.name\n  }\n\n  /**\n   * Returns a string representation of the exception.\n   * Includes the error code in brackets if available.\n   *\n   * @returns A formatted string representation of the exception.\n   */\n  toString() {\n    if (this.code) {\n      return `${this.name} [${this.code}]: ${this.message}`\n    }\n    return `${this.name}: ${this.message}`\n  }\n}\n\n/**\n * Exception thrown when a value cannot be encoded.\n * This indicates that the value type is not supported by the encoder.\n */\nexport class E_UNENCODABLE_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_UNENCODABLE_VALUE'\n\n  /**\n   * Creates a new E_UNENCODABLE_VALUE exception.\n   *\n   * @param value - The value that could not be encoded.\n   */\n  constructor(value: unknown) {\n    const message = `Value of type ${typeof value} (${String(value)}) is not encodable.`\n    super(message, {\n      code: E_UNENCODABLE_VALUE.code,\n      status: E_UNENCODABLE_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when encoding fails due to an underlying error.\n * This wraps the original error as the cause for better error tracing.\n */\nexport class E_ENCODING_FAILED extends BaseException {\n  static status = 500\n  static code = 'E_ENCODING_FAILED'\n\n  /**\n   * Creates a new E_ENCODING_FAILED exception.\n   *\n   * @param value - The value that failed to encode.\n   * @param cause - The underlying error that caused the encoding to fail.\n   */\n  constructor(value: unknown, cause: unknown) {\n    const message = `Value of type ${typeof value} (${String(value)}) is not encodable.`\n    super(message, {\n      code: E_ENCODING_FAILED.code,\n      status: E_ENCODING_FAILED.status,\n      cause,\n    })\n  }\n}\n\n/**\n * Exception thrown when a circular reference is detected during encoding.\n * Circular references cannot be encoded and must be avoided.\n */\nexport class E_CIRCULAR_REFERENCE extends BaseException {\n  static status = 500\n  static code = 'E_CIRCULAR_REFERENCE'\n\n  /**\n   * Creates a new E_CIRCULAR_REFERENCE exception.\n   */\n  constructor() {\n    const message = `Circular reference detected.`\n    super(message, {\n      code: E_CIRCULAR_REFERENCE.code,\n      status: E_CIRCULAR_REFERENCE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when a value with an unknown or unsupported type cannot be decoded.\n */\nexport class E_UNDECODABLE_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_UNDECODABLE_VALUE'\n\n  /**\n   * Creates a new E_UNDECODABLE_VALUE exception.\n   *\n   * @param type - The type string that could not be decoded.\n   */\n  constructor(type: string) {\n    const message = `Value of type ${type} cannot be decoded.`\n    super(message, {\n      code: E_UNDECODABLE_VALUE.code,\n      status: E_UNDECODABLE_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when attempting to decode a value that is not a valid encoded value.\n * This indicates the input string is not in the expected encoded format.\n */\nexport class E_NOT_AN_ENCODED_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_NOT_AN_ENCODED_VALUE'\n\n  /**\n   * Creates a new E_NOT_AN_ENCODED_VALUE exception.\n   *\n   * @param value - The string value that is not a valid encoded value.\n   */\n  constructor(value: string) {\n    const message = `Value \"${value}\" is not a valid encoded value.`\n    super(message, {\n      code: E_NOT_AN_ENCODED_VALUE.code,\n      status: E_NOT_AN_ENCODED_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when an invalid version string is encountered.\n */\nexport class E_INVALID_VERSION extends BaseException {\n  static status = 500\n  static code = 'E_INVALID_VERSION'\n\n  /**\n   * Creates a new E_INVALID_VERSION exception.\n   *\n   * @param version - The invalid version string.\n   */\n  constructor(version: string) {\n    const message = `Invalid version \"${version}\"`\n    super(message, {\n      code: E_INVALID_VERSION.code,\n      status: E_INVALID_VERSION.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when attempting to decode data encoded with an incompatible version.\n * This typically occurs when the encoded data is from a newer version than the decoder supports.\n */\nexport class E_INCOMPATIBLE_VERSION extends BaseException {\n  static status = 500\n  static code = 'E_INCOMPATIBLE_VERSION'\n  static help =\n    'This error indicates that the encoded value is from a version which is newer than the version of the decoder.'\n\n  /**\n   * Creates a new E_INCOMPATIBLE_VERSION exception.\n   *\n   * @param version - The incompatible version string from the encoded data.\n   */\n  constructor(version: string) {\n    const message = `Encoded data version ${version} is not compatible with the current version ${__VERSION__}.`\n    super(message, {\n      code: E_INCOMPATIBLE_VERSION.code,\n      status: E_INCOMPATIBLE_VERSION.status,\n    })\n  }\n}\n"],"names":["BaseException","message","options","__publicField","ErrorConstructor","code","help","_E_UNENCODABLE_VALUE","value","E_UNENCODABLE_VALUE","_E_ENCODING_FAILED","cause","E_ENCODING_FAILED","_E_CIRCULAR_REFERENCE","E_CIRCULAR_REFERENCE","_E_UNDECODABLE_VALUE","type","E_UNDECODABLE_VALUE","_E_NOT_AN_ENCODED_VALUE","E_NOT_AN_ENCODED_VALUE","_E_INVALID_VERSION","version","E_INVALID_VERSION","_E_INCOMPATIBLE_VERSION","E_INCOMPATIBLE_VERSION"],"mappings":";;;AAOO,MAAMA,UAAsB,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuCvC,YAAYC,GAAkBC,GAA6D;AACzF,UAAMD,GAASC,CAAO;AA3BxB;AAAA;AAAA;AAAA,IAAAC,EAAA;AAkBA;AAAA;AAAA;AAAA;AAAA,IAAAA,EAAA;AAWE,UAAMC,IAAmB,KAAK;AAE9B,SAAK,OAAOA,EAAiB,MAC7B,KAAK,UAAUH,KAAWG,EAAiB,WAAW,IACtD,KAAK,UAASF,KAAA,gBAAAA,EAAS,WAAUE,EAAiB,UAAU;AAE5D,UAAMC,KAAOH,KAAA,gBAAAA,EAAS,SAAQE,EAAiB;AAC/C,IAAIC,MAAS,WACX,KAAK,OAAOA;AAGd,UAAMC,IAAOF,EAAiB;AAC9B,IAAIE,MAAS,WACX,KAAK,OAAOA,IAGd,MAAM,kBAAkB,MAAMF,CAAgB;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAK,OAAO,WAAW,IAAI;AACzB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,WAAW;AACT,WAAI,KAAK,OACA,GAAG,KAAK,IAAI,KAAK,KAAK,IAAI,MAAM,KAAK,OAAO,KAE9C,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO;AAAA,EACtC;AACF;AAMO,MAAMG,IAAN,MAAMA,UAA4BP,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASrD,YAAYQ,GAAgB;AAC1B,UAAMP,IAAU,iBAAiB,OAAOO,CAAK,KAAK,OAAOA,CAAK,CAAC;AAC/D,UAAMP,GAAS;AAAA,MACb,MAAMM,EAAoB;AAAA,MAC1B,QAAQA,EAAoB;AAAA,IAAA,CAC7B;AAAA,EACH;AACF;AAfEJ,EADWI,GACJ,UAAS,MAChBJ,EAFWI,GAEJ,QAAO;AAFT,IAAME,IAANF;AAsBA,MAAMG,IAAN,MAAMA,UAA0BV,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUnD,YAAYQ,GAAgBG,GAAgB;AAC1C,UAAMV,IAAU,iBAAiB,OAAOO,CAAK,KAAK,OAAOA,CAAK,CAAC;AAC/D,UAAMP,GAAS;AAAA,MACb,MAAMS,EAAkB;AAAA,MACxB,QAAQA,EAAkB;AAAA,MAC1B,OAAAC;AAAA,IAAA,CACD;AAAA,EACH;AACF;AAjBER,EADWO,GACJ,UAAS,MAChBP,EAFWO,GAEJ,QAAO;AAFT,IAAME,IAANF;AAwBA,MAAMG,IAAN,MAAMA,UAA6Bb,EAAc;AAAA;AAAA;AAAA;AAAA,EAOtD,cAAc;AAEZ,UADgB,gCACD;AAAA,MACb,MAAMa,EAAqB;AAAA,MAC3B,QAAQA,EAAqB;AAAA,IAAA,CAC9B;AAAA,EACH;AACF;AAbEV,EADWU,GACJ,UAAS,MAChBV,EAFWU,GAEJ,QAAO;AAFT,IAAMC,IAAND;AAmBA,MAAME,IAAN,MAAMA,UAA4Bf,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASrD,YAAYgB,GAAc;AACxB,UAAMf,IAAU,iBAAiBe,CAAI;AACrC,UAAMf,GAAS;AAAA,MACb,MAAMc,EAAoB;AAAA,MAC1B,QAAQA,EAAoB;AAAA,IAAA,CAC7B;AAAA,EACH;AACF;AAfEZ,EADWY,GACJ,UAAS,MAChBZ,EAFWY,GAEJ,QAAO;AAFT,IAAME,IAANF;AAsBA,MAAMG,IAAN,MAAMA,UAA+BlB,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASxD,YAAYQ,GAAe;AACzB,UAAMP,IAAU,UAAUO,CAAK;AAC/B,UAAMP,GAAS;AAAA,MACb,MAAMiB,EAAuB;AAAA,MAC7B,QAAQA,EAAuB;AAAA,IAAA,CAChC;AAAA,EACH;AACF;AAfEf,EADWe,GACJ,UAAS,MAChBf,EAFWe,GAEJ,QAAO;AAFT,IAAMC,IAAND;AAqBA,MAAME,IAAN,MAAMA,UAA0BpB,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASnD,YAAYqB,GAAiB;AAC3B,UAAMpB,IAAU,oBAAoBoB,CAAO;AAC3C,UAAMpB,GAAS;AAAA,MACb,MAAMmB,EAAkB;AAAA,MACxB,QAAQA,EAAkB;AAAA,IAAA,CAC3B;AAAA,EACH;AACF;AAfEjB,EADWiB,GACJ,UAAS,MAChBjB,EAFWiB,GAEJ,QAAO;AAFT,IAAME,IAANF;AAsBA,MAAMG,IAAN,MAAMA,UAA+BvB,EAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWxD,YAAYqB,GAAiB;AAC3B,UAAMpB,IAAU,wBAAwBoB,CAAO;AAC/C,UAAMpB,GAAS;AAAA,MACb,MAAMsB,EAAuB;AAAA,MAC7B,QAAQA,EAAuB;AAAA,IAAA,CAChC;AAAA,EACH;AACF;AAjBEpB,EADWoB,GACJ,UAAS,MAChBpB,EAFWoB,GAEJ,QAAO,2BACdpB,EAHWoB,GAGJ,QACL;AAJG,IAAMC,IAAND;"}

package/exceptions-iBYg29S4.js

@@ -0,0 +1,2 @@
+"use strict";var S=Object.defineProperty;var k=(r,t,s)=>t in r?S(r,t,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[t]=s;var e=(r,t,s)=>k(r,typeof t!="symbol"?t+"":t,s);class a extends Error{constructor(s,c){super(s,c);e(this,"name");e(this,"status");const d=this.constructor;this.name=d.name,this.message=s||d.message||"",this.status=(c==null?void 0:c.status)||d.status||500;const y=(c==null?void 0:c.code)||d.code;y!==void 0&&(this.code=y);const w=d.help;w!==void 0&&(this.help=w),Error.captureStackTrace(this,d)}get[Symbol.toStringTag](){return this.constructor.name}toString(){return this.code?`${this.name} [${this.code}]: ${this.message}`:`${this.name}: ${this.message}`}}const n=class n extends a{constructor(t){const s=`Value of type ${typeof t} (${String(t)}) is not encodable.`;super(s,{code:n.code,status:n.status})}};e(n,"status",500),e(n,"code","E_UNENCODABLE_VALUE");let g=n;const u=class u extends a{constructor(t,s){const c=`Value of type ${typeof t} (${String(t)}) is not encodable.`;super(c,{code:u.code,status:u.status,cause:s})}};e(u,"status",500),e(u,"code","E_ENCODING_FAILED");let $=u;const i=class i extends a{constructor(){super("Circular reference detected.",{code:i.code,status:i.status})}};e(i,"status",500),e(i,"code","E_CIRCULAR_REFERENCE");let f=i;const h=class h extends a{constructor(t){const s=`Value of type ${t} cannot be decoded.`;super(s,{code:h.code,status:h.status})}};e(h,"status",500),e(h,"code","E_UNDECODABLE_VALUE");let p=h;const l=class l extends a{constructor(t){const s=`Value "${t}" is not a valid encoded value.`;super(s,{code:l.code,status:l.status})}};e(l,"status",500),e(l,"code","E_NOT_AN_ENCODED_VALUE");let x=l;const m=class m extends a{constructor(t){const s=`Invalid version "${t}"`;super(s,{code:m.code,status:m.status})}};e(m,"status",500),e(m,"code","E_INVALID_VERSION");let v=m;const o=class o extends a{constructor(t){const s=`Encoded data version ${t} is not compatible with the current version 0.1.0-master-ab456424.`;super(s,{code:o.code,status:o.status})}};e(o,"status",500),e(o,"code","E_INCOMPATIBLE_VERSION"),e(o,"help","This error indicates that the encoded value is from a version which is newer than the version of the decoder.");let b=o;exports.BaseException=a;exports.E_CIRCULAR_REFERENCE=f;exports.E_ENCODING_FAILED=$;exports.E_INCOMPATIBLE_VERSION=b;exports.E_INVALID_VERSION=v;exports.E_NOT_AN_ENCODED_VALUE=x;exports.E_UNDECODABLE_VALUE=p;exports.E_UNENCODABLE_VALUE=g;
+//# sourceMappingURL=exceptions-iBYg29S4.js.map

package/exceptions-iBYg29S4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions-iBYg29S4.js","sources":["../src/private/exceptions.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\n\n/**\n * Base exception class that extends the native Error class.\n * Provides a foundation for all custom exceptions with additional metadata\n * like error codes, status codes, and help descriptions.\n */\nexport class BaseException extends Error {\n  /**\n   * Define the error metadata as static properties to avoid\n   * setting them repeatedly on the error instance\n   */\n  declare static help?: string\n  declare static code?: string\n  declare static status?: number\n  declare static message?: string\n\n  /**\n   * Name of the class that raised the exception.\n   */\n  name: string\n\n  /**\n   * Optional help description for the error. You can use it to define additional\n   * human readable information for the error.\n   */\n  declare help?: string\n\n  /**\n   * A machine readable error code. This will allow the error handling logic\n   * to narrow down exceptions based upon the error code.\n   */\n  declare code?: string\n\n  /**\n   * A status code for the error. Usually helpful when converting errors\n   * to HTTP responses.\n   */\n  status: number\n\n  /**\n   * Creates a new BaseException instance.\n   *\n   * @param message - The error message. If not provided, uses the static message from the constructor.\n   * @param options - Additional options including error cause, code, and status.\n   */\n  constructor(message?: string, options?: ErrorOptions & { code?: string; status?: number }) {\n    super(message, options)\n\n    const ErrorConstructor = this.constructor as typeof BaseException\n\n    this.name = ErrorConstructor.name\n    this.message = message || ErrorConstructor.message || ''\n    this.status = options?.status || ErrorConstructor.status || 500\n\n    const code = options?.code || ErrorConstructor.code\n    if (code !== undefined) {\n      this.code = code\n    }\n\n    const help = ErrorConstructor.help\n    if (help !== undefined) {\n      this.help = help\n    }\n\n    Error.captureStackTrace(this, ErrorConstructor)\n  }\n\n  /**\n   * Returns the constructor name for the Symbol.toStringTag property.\n   *\n   * @returns The name of the exception class.\n   */\n  get [Symbol.toStringTag]() {\n    return this.constructor.name\n  }\n\n  /**\n   * Returns a string representation of the exception.\n   * Includes the error code in brackets if available.\n   *\n   * @returns A formatted string representation of the exception.\n   */\n  toString() {\n    if (this.code) {\n      return `${this.name} [${this.code}]: ${this.message}`\n    }\n    return `${this.name}: ${this.message}`\n  }\n}\n\n/**\n * Exception thrown when a value cannot be encoded.\n * This indicates that the value type is not supported by the encoder.\n */\nexport class E_UNENCODABLE_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_UNENCODABLE_VALUE'\n\n  /**\n   * Creates a new E_UNENCODABLE_VALUE exception.\n   *\n   * @param value - The value that could not be encoded.\n   */\n  constructor(value: unknown) {\n    const message = `Value of type ${typeof value} (${String(value)}) is not encodable.`\n    super(message, {\n      code: E_UNENCODABLE_VALUE.code,\n      status: E_UNENCODABLE_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when encoding fails due to an underlying error.\n * This wraps the original error as the cause for better error tracing.\n */\nexport class E_ENCODING_FAILED extends BaseException {\n  static status = 500\n  static code = 'E_ENCODING_FAILED'\n\n  /**\n   * Creates a new E_ENCODING_FAILED exception.\n   *\n   * @param value - The value that failed to encode.\n   * @param cause - The underlying error that caused the encoding to fail.\n   */\n  constructor(value: unknown, cause: unknown) {\n    const message = `Value of type ${typeof value} (${String(value)}) is not encodable.`\n    super(message, {\n      code: E_ENCODING_FAILED.code,\n      status: E_ENCODING_FAILED.status,\n      cause,\n    })\n  }\n}\n\n/**\n * Exception thrown when a circular reference is detected during encoding.\n * Circular references cannot be encoded and must be avoided.\n */\nexport class E_CIRCULAR_REFERENCE extends BaseException {\n  static status = 500\n  static code = 'E_CIRCULAR_REFERENCE'\n\n  /**\n   * Creates a new E_CIRCULAR_REFERENCE exception.\n   */\n  constructor() {\n    const message = `Circular reference detected.`\n    super(message, {\n      code: E_CIRCULAR_REFERENCE.code,\n      status: E_CIRCULAR_REFERENCE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when a value with an unknown or unsupported type cannot be decoded.\n */\nexport class E_UNDECODABLE_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_UNDECODABLE_VALUE'\n\n  /**\n   * Creates a new E_UNDECODABLE_VALUE exception.\n   *\n   * @param type - The type string that could not be decoded.\n   */\n  constructor(type: string) {\n    const message = `Value of type ${type} cannot be decoded.`\n    super(message, {\n      code: E_UNDECODABLE_VALUE.code,\n      status: E_UNDECODABLE_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when attempting to decode a value that is not a valid encoded value.\n * This indicates the input string is not in the expected encoded format.\n */\nexport class E_NOT_AN_ENCODED_VALUE extends BaseException {\n  static status = 500\n  static code = 'E_NOT_AN_ENCODED_VALUE'\n\n  /**\n   * Creates a new E_NOT_AN_ENCODED_VALUE exception.\n   *\n   * @param value - The string value that is not a valid encoded value.\n   */\n  constructor(value: string) {\n    const message = `Value \"${value}\" is not a valid encoded value.`\n    super(message, {\n      code: E_NOT_AN_ENCODED_VALUE.code,\n      status: E_NOT_AN_ENCODED_VALUE.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when an invalid version string is encountered.\n */\nexport class E_INVALID_VERSION extends BaseException {\n  static status = 500\n  static code = 'E_INVALID_VERSION'\n\n  /**\n   * Creates a new E_INVALID_VERSION exception.\n   *\n   * @param version - The invalid version string.\n   */\n  constructor(version: string) {\n    const message = `Invalid version \"${version}\"`\n    super(message, {\n      code: E_INVALID_VERSION.code,\n      status: E_INVALID_VERSION.status,\n    })\n  }\n}\n\n/**\n * Exception thrown when attempting to decode data encoded with an incompatible version.\n * This typically occurs when the encoded data is from a newer version than the decoder supports.\n */\nexport class E_INCOMPATIBLE_VERSION extends BaseException {\n  static status = 500\n  static code = 'E_INCOMPATIBLE_VERSION'\n  static help =\n    'This error indicates that the encoded value is from a version which is newer than the version of the decoder.'\n\n  /**\n   * Creates a new E_INCOMPATIBLE_VERSION exception.\n   *\n   * @param version - The incompatible version string from the encoded data.\n   */\n  constructor(version: string) {\n    const message = `Encoded data version ${version} is not compatible with the current version ${__VERSION__}.`\n    super(message, {\n      code: E_INCOMPATIBLE_VERSION.code,\n      status: E_INCOMPATIBLE_VERSION.status,\n    })\n  }\n}\n"],"names":["BaseException","message","options","__publicField","ErrorConstructor","code","help","_E_UNENCODABLE_VALUE","value","E_UNENCODABLE_VALUE","_E_ENCODING_FAILED","cause","E_ENCODING_FAILED","_E_CIRCULAR_REFERENCE","E_CIRCULAR_REFERENCE","_E_UNDECODABLE_VALUE","type","E_UNDECODABLE_VALUE","_E_NOT_AN_ENCODED_VALUE","E_NOT_AN_ENCODED_VALUE","_E_INVALID_VERSION","version","E_INVALID_VERSION","_E_INCOMPATIBLE_VERSION","E_INCOMPATIBLE_VERSION"],"mappings":"iLAOO,MAAMA,UAAsB,KAAM,CAuCvC,YAAYC,EAAkBC,EAA6D,CACzF,MAAMD,EAASC,CAAO,EA3BxBC,EAAA,aAkBAA,EAAA,eAWE,MAAMC,EAAmB,KAAK,YAE9B,KAAK,KAAOA,EAAiB,KAC7B,KAAK,QAAUH,GAAWG,EAAiB,SAAW,GACtD,KAAK,QAASF,GAAA,YAAAA,EAAS,SAAUE,EAAiB,QAAU,IAE5D,MAAMC,GAAOH,GAAA,YAAAA,EAAS,OAAQE,EAAiB,KAC3CC,IAAS,SACX,KAAK,KAAOA,GAGd,MAAMC,EAAOF,EAAiB,KAC1BE,IAAS,SACX,KAAK,KAAOA,GAGd,MAAM,kBAAkB,KAAMF,CAAgB,CAChD,CAOA,IAAK,OAAO,WAAW,GAAI,CACzB,OAAO,KAAK,YAAY,IAC1B,CAQA,UAAW,CACT,OAAI,KAAK,KACA,GAAG,KAAK,IAAI,KAAK,KAAK,IAAI,MAAM,KAAK,OAAO,GAE9C,GAAG,KAAK,IAAI,KAAK,KAAK,OAAO,EACtC,CACF,CAMO,MAAMG,EAAN,MAAMA,UAA4BP,CAAc,CASrD,YAAYQ,EAAgB,CAC1B,MAAMP,EAAU,iBAAiB,OAAOO,CAAK,KAAK,OAAOA,CAAK,CAAC,sBAC/D,MAAMP,EAAS,CACb,KAAMM,EAAoB,KAC1B,OAAQA,EAAoB,MAAA,CAC7B,CACH,CACF,EAfEJ,EADWI,EACJ,SAAS,KAChBJ,EAFWI,EAEJ,OAAO,uBAFT,IAAME,EAANF,EAsBA,MAAMG,EAAN,MAAMA,UAA0BV,CAAc,CAUnD,YAAYQ,EAAgBG,EAAgB,CAC1C,MAAMV,EAAU,iBAAiB,OAAOO,CAAK,KAAK,OAAOA,CAAK,CAAC,sBAC/D,MAAMP,EAAS,CACb,KAAMS,EAAkB,KACxB,OAAQA,EAAkB,OAC1B,MAAAC,CAAA,CACD,CACH,CACF,EAjBER,EADWO,EACJ,SAAS,KAChBP,EAFWO,EAEJ,OAAO,qBAFT,IAAME,EAANF,EAwBA,MAAMG,EAAN,MAAMA,UAA6Bb,CAAc,CAOtD,aAAc,CAEZ,MADgB,+BACD,CACb,KAAMa,EAAqB,KAC3B,OAAQA,EAAqB,MAAA,CAC9B,CACH,CACF,EAbEV,EADWU,EACJ,SAAS,KAChBV,EAFWU,EAEJ,OAAO,wBAFT,IAAMC,EAAND,EAmBA,MAAME,EAAN,MAAMA,UAA4Bf,CAAc,CASrD,YAAYgB,EAAc,CACxB,MAAMf,EAAU,iBAAiBe,CAAI,sBACrC,MAAMf,EAAS,CACb,KAAMc,EAAoB,KAC1B,OAAQA,EAAoB,MAAA,CAC7B,CACH,CACF,EAfEZ,EADWY,EACJ,SAAS,KAChBZ,EAFWY,EAEJ,OAAO,uBAFT,IAAME,EAANF,EAsBA,MAAMG,EAAN,MAAMA,UAA+BlB,CAAc,CASxD,YAAYQ,EAAe,CACzB,MAAMP,EAAU,UAAUO,CAAK,kCAC/B,MAAMP,EAAS,CACb,KAAMiB,EAAuB,KAC7B,OAAQA,EAAuB,MAAA,CAChC,CACH,CACF,EAfEf,EADWe,EACJ,SAAS,KAChBf,EAFWe,EAEJ,OAAO,0BAFT,IAAMC,EAAND,EAqBA,MAAME,EAAN,MAAMA,UAA0BpB,CAAc,CASnD,YAAYqB,EAAiB,CAC3B,MAAMpB,EAAU,oBAAoBoB,CAAO,IAC3C,MAAMpB,EAAS,CACb,KAAMmB,EAAkB,KACxB,OAAQA,EAAkB,MAAA,CAC3B,CACH,CACF,EAfEjB,EADWiB,EACJ,SAAS,KAChBjB,EAFWiB,EAEJ,OAAO,qBAFT,IAAME,EAANF,EAsBA,MAAMG,EAAN,MAAMA,UAA+BvB,CAAc,CAWxD,YAAYqB,EAAiB,CAC3B,MAAMpB,EAAU,wBAAwBoB,CAAO,qEAC/C,MAAMpB,EAAS,CACb,KAAMsB,EAAuB,KAC7B,OAAQA,EAAuB,MAAA,CAChC,CACH,CACF,EAjBEpB,EADWoB,EACJ,SAAS,KAChBpB,EAFWoB,EAEJ,OAAO,0BACdpB,EAHWoB,EAGJ,OACL,iHAJG,IAAMC,EAAND"}

package/exceptions.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("./exceptions-iBYg29S4.js");exports.E_CIRCULAR_REFERENCE=E.E_CIRCULAR_REFERENCE;exports.E_ENCODING_FAILED=E.E_ENCODING_FAILED;exports.E_INCOMPATIBLE_VERSION=E.E_INCOMPATIBLE_VERSION;exports.E_INVALID_VERSION=E.E_INVALID_VERSION;exports.E_NOT_AN_ENCODED_VALUE=E.E_NOT_AN_ENCODED_VALUE;exports.E_UNDECODABLE_VALUE=E.E_UNDECODABLE_VALUE;exports.E_UNENCODABLE_VALUE=E.E_UNENCODABLE_VALUE;
+//# sourceMappingURL=exceptions.cjs.map

package/exceptions.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/exceptions.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Exceptions thrown by the encoder/decoder
+ * @module @nhtio/encoder/exceptions
+ *
+ * @primaryExport
+ */
+export type { BaseException } from './private/exceptions';
+export { E_NOT_AN_ENCODED_VALUE, E_INVALID_VERSION, E_INCOMPATIBLE_VERSION, E_ENCODING_FAILED, E_CIRCULAR_REFERENCE, E_UNENCODABLE_VALUE, E_UNDECODABLE_VALUE, } from './private/exceptions';

package/exceptions.mjs

@@ -0,0 +1,11 @@
+import { a as N, b as A, f as I, e as L, d as a, c as C, E as D } from "./exceptions-BHfZbUPp.mjs";
+export {
+  N as E_CIRCULAR_REFERENCE,
+  A as E_ENCODING_FAILED,
+  I as E_INCOMPATIBLE_VERSION,
+  L as E_INVALID_VERSION,
+  a as E_NOT_AN_ENCODED_VALUE,
+  C as E_UNDECODABLE_VALUE,
+  D as E_UNENCODABLE_VALUE
+};
+//# sourceMappingURL=exceptions.mjs.map

package/exceptions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";"}