@ygracs/xobj-lib-js 0.2.5-b → 0.2.6-b

package/CHANGELOG.md

@@ -3,6 +3,7 @@
 Release version.
 
 > - update `xObj.md`;
+> - add a new `EvalKeyNameError` class;
 > - some fixes.
 
 #### *v0.2.4*

package/index.d.ts

@@ -1,53 +1,76 @@
-declare const _exports: {
-    readXObjParamRaw: typeof import("./lib/xObj-lib").readXObjParamRaw;
-    readXObjParam: typeof import("./lib/xObj-lib").readXObjParam;
-    readXObjParamAsBool: typeof import("./lib/xObj-lib").readXObjParamAsBool;
-    readXObjParamAsNum: typeof import("./lib/xObj-lib").readXObjParamAsNum;
-    readXObjParamEx: typeof import("./lib/xObj-lib").readXObjParamEx;
-    readXObjParamAsIndex: typeof import("./lib/xObj-lib").readXObjParamAsIndex;
-    writeXObjParamRaw: typeof import("./lib/xObj-lib").writeXObjParamRaw;
-    writeXObjParam: typeof import("./lib/xObj-lib").writeXObjParam;
-    writeXObjParamAsBool: typeof import("./lib/xObj-lib").writeXObjParamAsBool;
-    writeXObjParamAsNum: typeof import("./lib/xObj-lib").writeXObjParamAsNum;
-    writeXObjParamAsIndex: typeof import("./lib/xObj-lib").writeXObjParamAsIndex;
-    writeXObjParamEx: typeof import("./lib/xObj-lib").writeXObjParamEx;
-    readXObjAttrRaw: typeof import("./lib/xObj-lib").readXObjAttrRaw;
-    readXObjAttr: typeof import("./lib/xObj-lib").readXObjAttr;
-    readXObjAttrAsBool: typeof import("./lib/xObj-lib").readXObjAttrAsBool;
-    readXObjAttrAsNum: typeof import("./lib/xObj-lib").readXObjAttrAsNum;
-    readXObjAttrEx: typeof import("./lib/xObj-lib").readXObjAttrEx;
-    readXObjAttrAsIndex: typeof import("./lib/xObj-lib").readXObjAttrAsIndex;
-    writeXObjAttrRaw: typeof import("./lib/xObj-lib").writeXObjAttrRaw;
-    writeXObjAttr: typeof import("./lib/xObj-lib").writeXObjAttr;
-    writeXObjAttrAsBool: typeof import("./lib/xObj-lib").writeXObjAttrAsBool;
-    writeXObjAttrAsNum: typeof import("./lib/xObj-lib").writeXObjAttrAsNum;
-    writeXObjAttrAsIndex: typeof import("./lib/xObj-lib").writeXObjAttrAsIndex;
-    writeXObjAttrEx: typeof import("./lib/xObj-lib").writeXObjAttrEx;
-    getXObjAttributes: typeof import("./lib/xObj-lib").getXObjAttributes;
-    checkXObjAttribute: typeof import("./lib/xObj-lib").checkXObjAttribute;
-    deleteXObjAttribute: typeof import("./lib/xObj-lib").deleteXObjAttribute;
-    renameXObjAttribute: typeof import("./lib/xObj-lib").renameXObjAttribute;
-    getXObjElement: typeof import("./lib/xObj-lib").getXObjElement;
-    addXObjElement: typeof import("./lib/xObj-lib").addXObjElement;
-    insertXObjElement: typeof import("./lib/xObj-lib").insertXObjElement;
-    insertXObjElementEx: typeof import("./lib/xObj-lib").insertXObjElementEx;
-    deleteXObjElement: typeof import("./lib/xObj-lib").deleteXObjElement;
-    deleteXObjElementEx: typeof import("./lib/xObj-lib").deleteXObjElementEx;
-    renameXObjElement: typeof import("./lib/xObj-lib").renameXObjElement;
-    evalXObjEName: typeof import("./lib/xObj-lib").evalXObjEName;
-    insertXObjEList: typeof import("./lib/xObj-lib").insertXObjEList;
-    insertXObjEListEx: typeof import("./lib/xObj-lib").insertXObjEListEx;
-    evalKeyName: typeof import("./lib/xObj-lib").evalKeyName;
-    genXObjENameDescr: typeof import("./lib/xObj-lib").genXObjENameDescr;
-    insertXObjElements: typeof import("./lib/xObj-lib").insertXObjElements;
-    insertXObjEChain: typeof import("./lib/xObj-lib").insertXObjEChain;
-    readonly XOBJ_DEF_PARAM_TNAME: string;
-    readonly XOBJ_DEF_ATTR_TNAME: string;
-    TXmlContentParseOptions: typeof TXmlContentParseOptions;
-    DEF_XML_PARSE_OPTIONS: typeof DEF_XML_PARSE_OPTIONS;
-    XOBJ_DEF_TNAMES: typeof XOBJ_DEF_TNAMES;
-};
-export = _exports;
-import { TXmlContentParseOptions } from "./lib/xObj-defs";
-import { DEF_XML_PARSE_OPTIONS } from "./lib/xObj-defs";
-import { XOBJ_DEF_TNAMES } from "./lib/xObj-defs";
+declare const _exports: {
+    readXObjParamRaw: typeof import("./lib/xObj-lib").readXObjParamRaw;
+    readXObjParam: typeof import("./lib/xObj-lib").readXObjParam;
+    readXObjParamAsBool: typeof import("./lib/xObj-lib").readXObjParamAsBool;
+    readXObjParamAsNum: typeof import("./lib/xObj-lib").readXObjParamAsNum;
+    readXObjParamEx: typeof import("./lib/xObj-lib").readXObjParamEx;
+    readXObjParamAsIndex: typeof import("./lib/xObj-lib").readXObjParamAsIndex;
+    writeXObjParamRaw: typeof import("./lib/xObj-lib").writeXObjParamRaw;
+    writeXObjParam: typeof import("./lib/xObj-lib").writeXObjParam;
+    writeXObjParamAsBool: typeof import("./lib/xObj-lib").writeXObjParamAsBool;
+    writeXObjParamAsNum: typeof import("./lib/xObj-lib").writeXObjParamAsNum;
+    writeXObjParamAsIndex: typeof import("./lib/xObj-lib").writeXObjParamAsIndex;
+    writeXObjParamEx: typeof import("./lib/xObj-lib").writeXObjParamEx;
+    readXObjAttrRaw: typeof import("./lib/xObj-lib").readXObjAttrRaw;
+    readXObjAttr: typeof import("./lib/xObj-lib").readXObjAttr;
+    readXObjAttrAsBool: typeof import("./lib/xObj-lib").readXObjAttrAsBool;
+    readXObjAttrAsNum: typeof import("./lib/xObj-lib").readXObjAttrAsNum;
+    readXObjAttrEx: typeof import("./lib/xObj-lib").readXObjAttrEx;
+    readXObjAttrAsIndex: typeof import("./lib/xObj-lib").readXObjAttrAsIndex;
+    writeXObjAttrRaw: typeof import("./lib/xObj-lib").writeXObjAttrRaw;
+    writeXObjAttr: typeof import("./lib/xObj-lib").writeXObjAttr;
+    writeXObjAttrAsBool: typeof import("./lib/xObj-lib").writeXObjAttrAsBool;
+    writeXObjAttrAsNum: typeof import("./lib/xObj-lib").writeXObjAttrAsNum;
+    writeXObjAttrAsIndex: typeof import("./lib/xObj-lib").writeXObjAttrAsIndex;
+    writeXObjAttrEx: typeof import("./lib/xObj-lib").writeXObjAttrEx;
+    getXObjAttributes: typeof import("./lib/xObj-lib").getXObjAttributes;
+    checkXObjAttribute: typeof import("./lib/xObj-lib").checkXObjAttribute;
+    deleteXObjAttribute: typeof import("./lib/xObj-lib").deleteXObjAttribute;
+    renameXObjAttribute: typeof import("./lib/xObj-lib").renameXObjAttribute;
+    getXObjElement: typeof import("./lib/xObj-lib").getXObjElement;
+    addXObjElement: typeof import("./lib/xObj-lib").addXObjElement;
+    insertXObjElement: typeof import("./lib/xObj-lib").insertXObjElement;
+    insertXObjElementEx: typeof import("./lib/xObj-lib").insertXObjElementEx;
+    deleteXObjElement: typeof import("./lib/xObj-lib").deleteXObjElement;
+    deleteXObjElementEx: typeof import("./lib/xObj-lib").deleteXObjElementEx;
+    renameXObjElement: typeof import("./lib/xObj-lib").renameXObjElement;
+    evalXObjEName: typeof import("./lib/xObj-lib").evalXObjEName;
+    insertXObjEList: typeof import("./lib/xObj-lib").insertXObjEList;
+    insertXObjEListEx: typeof import("./lib/xObj-lib").insertXObjEListEx;
+    evalKeyName: typeof import("./lib/xObj-lib").evalKeyName;
+    genXObjENameDescr: typeof import("./lib/xObj-lib").genXObjENameDescr;
+    insertXObjElements: typeof import("./lib/xObj-lib").insertXObjElements;
+    insertXObjEChain: typeof import("./lib/xObj-lib").insertXObjEChain;
+    TXmlContentParseOptions: typeof TXmlContentParseOptions;
+    DEF_XML_PARSE_OPTIONS: typeof DEF_XML_PARSE_OPTIONS;
+    XOBJ_DEF_TNAMES: typeof XOBJ_DEF_TNAMES;
+    EvalKeyNameError: typeof EvalKeyNameError;
+
+    xml2jsParseOptions: xml2jsParseOptions;
+    js2xmlParseOptions: js2xmlParseOptions;
+    OPT_parserOptions: OPT_parserOptions;
+
+    XObjENameDescr: XObjENameDescr;
+    OPT_inselops_L: OPT_inselops_L;
+    OPT_inselops_S: OPT_inselops_S;
+    RVAL_reason: RVAL_reason;
+    RVAL_emodif: RVAL_emodif;
+    VCOR_evalkname: VCOR_evalkname;
+};
+export = _exports;
+import { TXmlContentParseOptions } from "./lib/xObj-defs";
+import { DEF_XML_PARSE_OPTIONS } from "./lib/xObj-defs";
+import { XOBJ_DEF_TNAMES } from "./lib/xObj-defs";
+import { EvalKeyNameError } from "./lib/xObj-errors";
+
+import type {
+  xml2jsParseOptions, js2xmlParseOptions,
+  OPT_parserOptions,
+} from "./lib/xObj-defs";
+
+import type {
+  XObjENameDescr,
+  OPT_inselops_L, OPT_inselops_S,
+  RVAL_reason, RVAL_emodif,
+  VCOR_evalkname,
+} from "./lib/xObj-lib";

package/index.js

@@ -1,4 +1,4 @@
-// [v0.1.013-20251213]
+// [v0.1.014-20251228]
 
 // === module init block ===
 
@@ -8,6 +8,10 @@ const {
   XOBJ_DEF_TNAMES,
 } = require('./lib/xObj-defs');
 
+const {
+  EvalKeyNameError,
+} = require('./lib/xObj-errors');
+
 // === module inner block ===
 
 // === module main block ===
@@ -15,6 +19,9 @@ const {
 // === module exports block ===
 
 module.exports = require('./lib/xObj-lib');
+
 module.exports.TXmlContentParseOptions = TXmlContentParseOptions;
 module.exports.DEF_XML_PARSE_OPTIONS = DEF_XML_PARSE_OPTIONS;
 module.exports.XOBJ_DEF_TNAMES = XOBJ_DEF_TNAMES;
+
+module.exports.EvalKeyNameError = EvalKeyNameError;

package/lib/xObj-defs.d.ts

@@ -1,166 +1,142 @@
-/**
- * A parser options settings
- */
-export type OPT_parserOptions = {
-    compact?: boolean | undefined;
-    declarationKey?: string | undefined;
-    attributesKey?: string | undefined;
-    textKey?: string | undefined;
-    commentKey?: string | undefined;
-    cdataKey?: string | undefined;
-    nameKey?: string | undefined;
-    typeKey?: string | undefined;
-    parentKey?: string | undefined;
-    elementsKey?: string | undefined;
-    ignoreDeclaration?: boolean | undefined;
-    ignoreDocType?: boolean | undefined;
-    ignoreInstraction?: boolean | undefined;
-    ignoreText?: boolean | undefined;
-    ignoreComment?: boolean | undefined;
-    ignoreCData?: boolean | undefined;
-    fullTagEmptyElement?: boolean | undefined;
-    addParent?: boolean | undefined;
-    trim?: boolean | undefined;
-    spaces?: any;
-};
-/**
- * A parser options to convert an 'XML'-string into a 'JS'-object
- */
-export type xml2jsParseOptions = {
-    compact?: boolean | undefined;
-    declarationKey?: string | undefined;
-    attributesKey?: string | undefined;
-    textKey?: string | undefined;
-    commentKey?: string | undefined;
-    cdataKey?: string | undefined;
-    nameKey?: string | undefined;
-    typeKey?: string | undefined;
-    parentKey?: string | undefined;
-    elementsKey?: string | undefined;
-    ignoreDeclaration?: boolean | undefined;
-    ignoreDocType?: boolean | undefined;
-    ignoreInstraction?: boolean | undefined;
-    ignoreText?: boolean | undefined;
-    ignoreComment?: boolean | undefined;
-    ignoreCData?: boolean | undefined;
-    addParent?: boolean | undefined;
-    trim?: boolean | undefined;
-};
-/**
- * A parser options to convert a 'JS'-object into an 'XML'-string
- */
-export type js2xmlParseOptions = {
-    compact?: boolean | undefined;
-    declarationKey?: string | undefined;
-    attributesKey?: string | undefined;
-    textKey?: string | undefined;
-    commentKey?: string | undefined;
-    cdataKey?: string | undefined;
-    nameKey?: string | undefined;
-    typeKey?: string | undefined;
-    parentKey?: string | undefined;
-    elementsKey?: string | undefined;
-    ignoreDeclaration?: boolean | undefined;
-    ignoreDocType?: boolean | undefined;
-    ignoreInstraction?: boolean | undefined;
-    ignoreText?: boolean | undefined;
-    ignoreComment?: boolean | undefined;
-    ignoreCData?: boolean | undefined;
-    fullTagEmptyElement?: boolean | undefined;
-    spaces?: any;
-};
-export const XOBJ_DEF_PARAM_TNAME: "__text";
-export const XOBJ_DEF_ATTR_TNAME: "__attr";
-export namespace XOBJ_DEF_TNAMES {
-    export { XOBJ_DEF_PARAM_TNAME };
-    export { XOBJ_DEF_ATTR_TNAME };
-    export { XOBJ_DEF_DECL_TNAME };
-    export { XOBJ_DEF_CDATA_TNAME };
-}
-export namespace XOBJ_ECODE_TABLE {
-    export { XOBJ_TE_NOBJ_EMSG };
-    export { XOBJ_TE_NOBJ_ECODE };
-    export { XOBJ_TE_NARR_EMSG };
-    export { XOBJ_TE_NARR_ECODE };
-    export { XOBJ_TE_NSTR_EMSG };
-    export { XOBJ_TE_NSTR_ECODE };
-    export { XOBJ_TE_NPOBJ_EMSG };
-    export { XOBJ_TE_NPOBJ_ECODE };
-    export { XOBJ_TE_ANES_EMSG };
-    export { XOBJ_TE_ANES_ECODE };
-    export { XOBJ_TE_KNES_EMSG };
-    export { XOBJ_TE_KNES_ECODE };
-}
-export namespace DEF_XML_PARSE_OPTIONS {
-    export let compact: boolean;
-    export { XOBJ_DEF_DECL_TNAME as declarationKey };
-    export { XOBJ_DEF_ATTR_TNAME as attributesKey };
-    export { XOBJ_DEF_PARAM_TNAME as textKey };
-    export let commentKey: string;
-    export { XOBJ_DEF_CDATA_TNAME as cdataKey };
-    export let nameKey: string;
-    export let typeKey: string;
-    export let parentKey: string;
-    export let elementsKey: string;
-    export let ignoreDeclaration: boolean;
-    export let ignoreDocType: boolean;
-    /** @deprecated */
-    export let ignoreInstractions: boolean;
-    export let ignoreInstraction: boolean;
-    export let ignoreText: boolean;
-    /** @deprecated */
-    export let ignoreComments: boolean;
-    export let ignoreComment: boolean;
-    export let ignoreCData: boolean;
-    export let fullTagEmptyElement: boolean;
-    export let addParent: boolean;
-    export let trim: boolean;
-    export let spaces: number;
-}
-
-/**
- * @classdesc Implements a container that provide a functionality to work
- *    with options for an XML-parser
- */
-export class TXmlContentParseOptions {
-    /**
-     * Creates a container instance
-     */
-    static createNewOptionsSet(opt?: any): OPT_parserOptions;
-    /**
-     * Creates a container instance
-     */
-    constructor(param?: any);
-    /**
-     * Contains a set of a current settings
-     */
-    get settings(): OPT_parserOptions;
-    /**
-     * Contains a set of a settings for converting an 'XML' to 'JS'-object
-     */
-    get xml2js(): xml2jsParseOptions;
-    /**
-     * Contains a set of a settings for converting an 'JS'-object to 'XML'
-     */
-    get js2xml(): js2xmlParseOptions;
-    /**
-     * Contains a set of a reserved key words
-     */
-    get reservedKeys(): Set<string>;
-    #private;
-}
-declare const XOBJ_DEF_DECL_TNAME: "__decl";
-declare const XOBJ_DEF_CDATA_TNAME: "__cdata";
-declare const XOBJ_TE_NOBJ_EMSG: "invalid argument (an object expected)";
-declare const XOBJ_TE_NOBJ_ECODE: "ERR_XOBJ_NOBJ";
-declare const XOBJ_TE_NARR_EMSG: "invalid argument (an array expected)";
-declare const XOBJ_TE_NARR_ECODE: "ERR_XOBJ_NARR";
-declare const XOBJ_TE_NSTR_EMSG: "invalid argument (a string expected)";
-declare const XOBJ_TE_NSTR_ECODE: "ERR_XOBJ_NSTR";
-declare const XOBJ_TE_NPOBJ_EMSG: "invalid argument (a plain object expected)";
-declare const XOBJ_TE_NPOBJ_ECODE: "ERR_XOBJ_NPOBJ";
-declare const XOBJ_TE_ANES_EMSG: "<attr_name> must be a non-empty string";
-declare const XOBJ_TE_ANES_ECODE: "ERR_XOBJ_INVARG_ATTR";
-declare const XOBJ_TE_KNES_EMSG: "<key_name> must be a non-empty string";
-declare const XOBJ_TE_KNES_ECODE: "ERR_XOBJ_INVARG_KEY";
-export {};
+/**
+ * A parser options settings
+ */
+export type OPT_parserOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    fullTagEmptyElement?: boolean;
+    addParent?: boolean;
+    trim?: boolean;
+    spaces?: any;
+};
+/**
+ * A parser options to convert an 'XML'-string into a 'JS'-object
+ */
+export type xml2jsParseOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    addParent?: boolean;
+    trim?: boolean;
+};
+/**
+ * A parser options to convert a 'JS'-object into an 'XML'-string
+ */
+export type js2xmlParseOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    fullTagEmptyElement?: boolean;
+    spaces?: any;
+};
+
+export const XOBJ_DEF_PARAM_TNAME: "__text";
+export const XOBJ_DEF_ATTR_TNAME: "__attr";
+export namespace XOBJ_DEF_TNAMES {
+    export { XOBJ_DEF_PARAM_TNAME };
+    export { XOBJ_DEF_ATTR_TNAME };
+    export { XOBJ_DEF_DECL_TNAME };
+    export { XOBJ_DEF_CDATA_TNAME };
+}
+export namespace DEF_XML_PARSE_OPTIONS {
+    export let compact: boolean;
+    export { XOBJ_DEF_DECL_TNAME as declarationKey };
+    export { XOBJ_DEF_ATTR_TNAME as attributesKey };
+    export { XOBJ_DEF_PARAM_TNAME as textKey };
+    export let commentKey: string;
+    export { XOBJ_DEF_CDATA_TNAME as cdataKey };
+    export let nameKey: string;
+    export let typeKey: string;
+    export let parentKey: string;
+    export let elementsKey: string;
+    export let ignoreDeclaration: boolean;
+    export let ignoreDocType: boolean;
+    /** @deprecated */
+    export let ignoreInstractions: boolean;
+    export let ignoreInstraction: boolean;
+    export let ignoreText: boolean;
+    /** @deprecated */
+    export let ignoreComments: boolean;
+    export let ignoreComment: boolean;
+    export let ignoreCData: boolean;
+    export let fullTagEmptyElement: boolean;
+    export let addParent: boolean;
+    export let trim: boolean;
+    export let spaces: number;
+}
+
+/**
+ * @classdesc Implements a container that provide a functionality to work
+ *    with options for an XML-parser
+ */
+export class TXmlContentParseOptions {
+    /**
+     * Creates a container instance
+     */
+    static createNewOptionsSet(opt?: any): OPT_parserOptions;
+    /**
+     * Creates a container instance
+     */
+    constructor(param?: any);
+    /**
+     * Contains a set of a current settings
+     */
+    get settings(): OPT_parserOptions;
+    /**
+     * Contains a set of a settings for converting an 'XML' to 'JS'-object
+     */
+    get xml2js(): xml2jsParseOptions;
+    /**
+     * Contains a set of a settings for converting an 'JS'-object to 'XML'
+     */
+    get js2xml(): js2xmlParseOptions;
+    /**
+     * Contains a set of a reserved key words
+     */
+    get reservedKeys(): Set<string>;
+    #private;
+}
+
+declare const XOBJ_DEF_DECL_TNAME: "__decl";
+declare const XOBJ_DEF_CDATA_TNAME: "__cdata";
+export {};

package/lib/xObj-defs.js

@@ -1,4 +1,4 @@
-// [v0.1.067-20251214]
+// [v0.1.068-20251229]
 
 // === module init block ===
 
@@ -26,35 +26,6 @@ const XOBJ_DEF_TNAMES = {
   XOBJ_DEF_CDATA_TNAME,
 };
 
-const XOBJ_TE_INVARG_EMSG = 'invalid argument';
-const XOBJ_TE_NOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (an object expected)`;
-const XOBJ_TE_NOBJ_ECODE = 'ERR_XOBJ_NOBJ';
-const XOBJ_TE_NARR_EMSG = `${XOBJ_TE_INVARG_EMSG} (an array expected)`;
-const XOBJ_TE_NARR_ECODE = 'ERR_XOBJ_NARR';
-const XOBJ_TE_NSTR_EMSG = `${XOBJ_TE_INVARG_EMSG} (a string expected)`;
-const XOBJ_TE_NSTR_ECODE = 'ERR_XOBJ_NSTR';
-const XOBJ_TE_NPOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (a plain object expected)`;
-const XOBJ_TE_NPOBJ_ECODE = 'ERR_XOBJ_NPOBJ';
-const XOBJ_TE_ANES_EMSG = '<attr_name> must be a non-empty string';
-const XOBJ_TE_ANES_ECODE = 'ERR_XOBJ_INVARG_ATTR';
-const XOBJ_TE_KNES_EMSG = '<key_name> must be a non-empty string';
-const XOBJ_TE_KNES_ECODE = 'ERR_XOBJ_INVARG_KEY';
-
-const XOBJ_ECODE_TABLE = {
-  XOBJ_TE_NOBJ_EMSG,
-  XOBJ_TE_NOBJ_ECODE,
-  XOBJ_TE_NARR_EMSG,
-  XOBJ_TE_NARR_ECODE,
-  XOBJ_TE_NSTR_EMSG,
-  XOBJ_TE_NSTR_ECODE,
-  XOBJ_TE_NPOBJ_EMSG,
-  XOBJ_TE_NPOBJ_ECODE,
-  XOBJ_TE_ANES_EMSG,
-  XOBJ_TE_ANES_ECODE,
-  XOBJ_TE_KNES_EMSG,
-  XOBJ_TE_KNES_ECODE,
-};
-
 /**
  * A parser options settings
  * @typedef {Object} OPT_parserOptions
@@ -316,7 +287,6 @@ class TXmlContentParseOptions {
 module.exports.XOBJ_DEF_PARAM_TNAME = XOBJ_DEF_PARAM_TNAME;
 module.exports.XOBJ_DEF_ATTR_TNAME = XOBJ_DEF_ATTR_TNAME;
 module.exports.XOBJ_DEF_TNAMES = XOBJ_DEF_TNAMES;
-module.exports.XOBJ_ECODE_TABLE = XOBJ_ECODE_TABLE;
 module.exports.DEF_XML_PARSE_OPTIONS = DEF_XML_PARSE_OPTIONS;
 
 module.exports.TXmlContentParseOptions = TXmlContentParseOptions;

package/lib/xObj-errors.d.ts

@@ -0,0 +1,41 @@
+export namespace XOBJ_ECODE_TABLE {
+    export { XOBJ_TE_NOBJ_EMSG };
+    export { XOBJ_TE_NOBJ_ECODE };
+    export { XOBJ_TE_NARR_EMSG };
+    export { XOBJ_TE_NARR_ECODE };
+    export { XOBJ_TE_NSTR_EMSG };
+    export { XOBJ_TE_NSTR_ECODE };
+    export { XOBJ_TE_NPOBJ_EMSG };
+    export { XOBJ_TE_NPOBJ_ECODE };
+    export { XOBJ_TE_ANES_EMSG };
+    export { XOBJ_TE_ANES_ECODE };
+    export { XOBJ_TE_KNES_EMSG };
+    export { XOBJ_TE_KNES_ECODE };
+}
+/**
+ * @classdesc Extends a base `TypeError` object to provide some information
+ *            on the errors thrown when a key name evaluation failed
+ */
+export class EvalKeyNameError extends TypeError {
+    /**
+     * Creates a new instance
+     */
+    constructor(msg: string, options?: any);
+    /**
+     * Represents an error code
+     */
+    code: string;
+}
+declare const XOBJ_TE_NOBJ_EMSG: "invalid argument (an object expected)";
+declare const XOBJ_TE_NOBJ_ECODE: "ERR_XOBJ_NOBJ";
+declare const XOBJ_TE_NARR_EMSG: "invalid argument (an array expected)";
+declare const XOBJ_TE_NARR_ECODE: "ERR_XOBJ_NARR";
+declare const XOBJ_TE_NSTR_EMSG: "invalid argument (a string expected)";
+declare const XOBJ_TE_NSTR_ECODE: "ERR_XOBJ_NSTR";
+declare const XOBJ_TE_NPOBJ_EMSG: "invalid argument (a plain object expected)";
+declare const XOBJ_TE_NPOBJ_ECODE: "ERR_XOBJ_NPOBJ";
+declare const XOBJ_TE_ANES_EMSG: "<attr_name> must be a non-empty string";
+declare const XOBJ_TE_ANES_ECODE: "ERR_XOBJ_INVARG_ATTR";
+declare const XOBJ_TE_KNES_EMSG: "<key_name> must be a non-empty string";
+declare const XOBJ_TE_KNES_ECODE: "ERR_XOBJ_INVARG_KEY";
+export {};

package/lib/xObj-errors.js

@@ -0,0 +1,71 @@
+// [v0.1.003-20251229]
+
+// === module init block ===
+
+const {
+  isPlainObject,
+} = require('@ygracs/bsfoc-lib-js');
+
+// === module inner block ===
+
+// === module main block ===
+
+const XOBJ_TE_INVARG_EMSG = 'invalid argument';
+const XOBJ_TE_NOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (an object expected)`;
+const XOBJ_TE_NOBJ_ECODE = 'ERR_XOBJ_NOBJ';
+const XOBJ_TE_NARR_EMSG = `${XOBJ_TE_INVARG_EMSG} (an array expected)`;
+const XOBJ_TE_NARR_ECODE = 'ERR_XOBJ_NARR';
+const XOBJ_TE_NSTR_EMSG = `${XOBJ_TE_INVARG_EMSG} (a string expected)`;
+const XOBJ_TE_NSTR_ECODE = 'ERR_XOBJ_NSTR';
+const XOBJ_TE_NPOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (a plain object expected)`;
+const XOBJ_TE_NPOBJ_ECODE = 'ERR_XOBJ_NPOBJ';
+const XOBJ_TE_ANES_EMSG = '<attr_name> must be a non-empty string';
+const XOBJ_TE_ANES_ECODE = 'ERR_XOBJ_INVARG_ATTR';
+const XOBJ_TE_KNES_EMSG = '<key_name> must be a non-empty string';
+const XOBJ_TE_KNES_ECODE = 'ERR_XOBJ_INVARG_KEY';
+
+const XOBJ_ECODE_TABLE = {
+  XOBJ_TE_NOBJ_EMSG,
+  XOBJ_TE_NOBJ_ECODE,
+  XOBJ_TE_NARR_EMSG,
+  XOBJ_TE_NARR_ECODE,
+  XOBJ_TE_NSTR_EMSG,
+  XOBJ_TE_NSTR_ECODE,
+  XOBJ_TE_NPOBJ_EMSG,
+  XOBJ_TE_NPOBJ_ECODE,
+  XOBJ_TE_ANES_EMSG,
+  XOBJ_TE_ANES_ECODE,
+  XOBJ_TE_KNES_EMSG,
+  XOBJ_TE_KNES_ECODE,
+};
+module.exports.XOBJ_ECODE_TABLE = XOBJ_ECODE_TABLE;
+
+/**
+ * @augments TypeError
+ * @classdesc Extends a base `TypeError` object to provide some information
+ *            on the errors thrown when a key name evaluation failed
+ */
+class EvalKeyNameError extends TypeError {
+  /**
+   * Creates a new instance
+   * @param {string} msg - some user error message
+   * @param {*} [options] - user options
+   */
+  constructor(msg, options) {
+    super(msg, options);
+    /** @type {string} */
+    this.name = 'EvalKeyNameError';
+    const code = (
+      isPlainObject(options) && typeof options.code === 'string'
+      ? options.code
+      : ''
+    );
+    /**
+     * Represents an error code
+     * @type {string}
+     */
+    this.code = code;
+  }
+
+};
+module.exports.EvalKeyNameError = EvalKeyNameError;