@ygracs/xepg-lib-js 0.0.22 → 0.0.23

package/lib/xepgdoc-lib.js

@@ -1,12 +1,12 @@
-// [v0.2.098-20250306]
+// [v0.2.106-20250428]
 
 // === module init block ===
 
 const xmlParser = require('@ygracs/xml-js6');
 
 const {
-  valueToIndex,
-  readAsString, readAsNumberEx,
+  valueToIndex, valueToIDString,
+  readAsString, readAsNumber,
   isNotEmptyString,
   isArray, isObject, isPlainObject,
 } = require('@ygracs/bsfoc-lib-js');
@@ -22,16 +22,18 @@ const {
 } = require('./dts-helper.js');
 
 const {
-  loadFileSync, loadFile,
+  loadFromFileSync, loadFromFile,
   saveToFileSync, saveToFile,
-} = require('./file-helper.js');
+} = require('@cntwg/file-helper');
 
 const xObj = require('@ygracs/xobj-lib-js');
 
-const TXmlContentParseOptions = xObj.TXmlContentParseOptions;
 const {
+  TXmlContentParseOptions,
   getXObjElement,
   insertXObjElement,
+  writeXObjParam,
+  writeXObjAttr,
 } = xObj;
 
 // === module extra block (helper functions) ===
@@ -44,33 +46,23 @@ function readXObjParam(obj){
   return xObj.readXObjParam(obj, defParseOptions.settings.textKey);
 };
 
-function writeXObjParam(obj, value){
-  return xObj.writeXObjParam(obj, value, defParseOptions.settings.textKey);
-};
-
-function writeXObjAttr(obj, name, value) {
-  return xObj.writeXObjAttr(
-    obj, name, value, defParseOptions.settings.attributesKey
-  );
-};
-
 /*
  * === xObj-function wrappers (end) ===
  */
 
 /**
- * @param {object} obj
- * @param {string} elem
+ * @param {object} obj - element
+ * @param {string} name - child element name
  * @returns {string}
  * @inner
  */
-function _getXmlChildElementParam(obj, elem) {
-  const child = obj ? getXObjElement(obj, elem) : null;
+function _getXmlChildElementParam(obj, name) {
+  const child = obj ? getXObjElement(obj, name) : null;
   return child ? readXObjParam(child) : '';
 };
 
 /**
- * @param {object} obj
+ * @param {object} obj - element
  * @returns {number}
  * @inner
  */
@@ -81,18 +73,25 @@ function _getDTSTypeValueForXObj(obj) {
   return chkDTSysID(result) ? result : 0; //-1; // // TODO: [?]
 };
 
-function writeXEpgDocDeclSection(obj, opt) {
+/**
+ * @param {object} obj - element
+ * @param {*} data - data
+ * @returns {void}
+ * @inner
+ */
+function writeXEpgDocDeclSection(obj, data) {
+  const key_name = defParseOptions.settings.declarationKey;
   let xml_ver = XEPG_XML_DOC_VERSION;
   let doc_def_enc = XEPG_DEF_ENCODING_VALUE;
-  let key_name = defParseOptions.settings.declarationKey;
-  if (isPlainObject(opt)) {
-    xml_ver = readAsString(opt.version, { defValue: xml_ver });
-    doc_def_enc = readAsString(opt.encoding, { defValue: doc_def_enc });
+  if (isPlainObject(data)) {
+    xml_ver = readAsString(data.version, { defValue: xml_ver });
+    doc_def_enc = readAsString(data.encoding, { defValue: doc_def_enc });
   };
   if (isPlainObject(obj) && isNotEmptyString(key_name)) {
     obj[key_name] = {};
-    writeXObjAttr(obj[key_name], 'version', xml_ver);
-    writeXObjAttr(obj[key_name], 'encoding', doc_def_enc);
+    const attr_key = defParseOptions.settings.attributesKey;
+    writeXObjAttr(obj[key_name], 'version', xml_ver, attr_key);
+    writeXObjAttr(obj[key_name], 'encoding', doc_def_enc, attr_key);
   };
 };
 
@@ -161,6 +160,75 @@ const defParseOptions = new TXmlContentParseOptions();
  * (* function definitions *)
  */
 
+/**
+ * @since v0.0.23
+ * @function readAsTagName
+ * @param {any} value - some value
+ * @returns {string}
+ * @description Tries to convert a given value to a valid tag name
+ *              of an XML-element.
+ */
+function readAsTagName(value) {
+  let tagName = valueToIDString(value, { ignoreNumbers: true });
+  if (tagName === null) return '';
+  if (tagName !== '') {
+    // // TODO: do extra checks
+    const template = /[\s\/\\\"\'<>=]/;
+    const trigger = tagName.match(template);
+    if (trigger) {
+      //console.log(trigger);
+      tagName = '';
+    };
+  };
+  return tagName;
+};
+
+/**
+ * @since v0.0.23
+ * @function readAsAttrName
+ * @param {any} value - some value
+ * @returns {string}
+ * @description Tries to convert a given value to a valid name
+ *              of an XML-attribute.
+ */
+function readAsAttrName(value) {
+  let attrName = valueToIDString(value, { ignoreNumbers: true });
+  if (attrName === null) return '';
+  if (attrName !== '') {
+    // // TODO: do extra checks
+    const template = /[\s\/\\\"\'<>=]/;
+    const trigger = attrName.match(template);
+    if (trigger) {
+      //console.log(trigger);
+      attrName = '';
+    };
+  };
+  return attrName;
+};
+
+/**
+ * @since v0.0.23
+ * @function valueToElementID
+ * @param {any} value - some value
+ * @returns {string}
+ * @description Tries to convert a given value to a valid identifier
+ *              suitable as a value for an "ID-attribute" of an XML-element.
+ */
+function valueToElementID(value) {
+  let id = valueToIDString(value);
+  if (id === null) return '';
+  if (id !== '') {
+    // // TODO: do extra checks
+    const template = /[\s\/\\\"\'<>=]/;
+    const trigger = id.match(template);
+    if (trigger) {
+      //console.log(trigger);
+      id = '';
+    };
+  };
+  return id;
+};
+
 /***
  * (* class definitions *)
  */
@@ -176,32 +244,45 @@ const defParseOptions = new TXmlContentParseOptions();
  */
 
 /**
+ * @typedef {Object} OPT_epgelsett_bs
+ * @property {TXmlContentParseOptions} [parseOptions] - parser options
+ * @description An XEPG-element options set (base)
+ */
+
+/**
+ * @typedef {Object} OPT_epgelsett_ex
+ * @property {TXmlContentParseOptions} [parseOptions] - parser options
+ * @property {object} [opt.dts_src]
+ * @property {object} [opt.tz_src]
+ * @description An XEPG-element options set (extend)
+ */
+
+/**
+ * @since 0.0.22
  * @classdesc This class implements an interface of a EPG-schedule element
  */
 class TXEpgScheduleItem {
-  /** @property {object} */
+  /** @type {object} */
   #_host;// = null;
-  /** @property {object} */
+  /** @type {OPT_epgelsett_ex} */
   #_options;// = null;
-  /** @property {TXmlContentParseOptions} */
+  /** @type {TXmlContentParseOptions} */
   #_parseOptions;// = null;
-  /** @property {?object} */
+  /** @type {?object} */
   #_dts_src = null;
-  /** @property {?object} */
+  /** @type {?object} */
   #_tz_src = null;
 
   /**
    * @param {object} obj - host object
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
-   * @param {?object} [opt.dts_src]
-   * @param {?object} [opt.tz_src]
+   * @param {OPT_epgelsett_ex} [opt] - options
    * @description Creates an instance of the EPG-schedule element
    */
   constructor(obj, opt) {
     // load content
     const _host = isPlainObject(obj) ? obj : {};
     // load options
+    /** @type {OPT_epgelsett_ex} */
     const _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -226,7 +307,7 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a dtstype ID
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get dtstype() {
@@ -235,7 +316,7 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a TZ-offset
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get curDocTZ() {
@@ -248,7 +329,7 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a schedule start time as a timestamp
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get time() {
@@ -260,7 +341,7 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a schedule title
-   * @property {string}
+   * @type {string}
    * @readonly
    */
   get title() {
@@ -269,7 +350,7 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a schedule category
-   * @property {string}
+   * @type {string}
    * @readonly
    */
   get category() {
@@ -278,18 +359,18 @@ class TXEpgScheduleItem {
 
   /**
    * Contains a schedule rating value (aka pcmark)
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get rating() {
-    return readAsNumberEx(
+    return readAsNumber(
       _getXmlChildElementParam(this.#_host, XEPG_SCHEDPMARK_ETAG_NAME), 0
     );
   }
 
   /**
    * Contains a schedule description
-   * @property {string}
+   * @type {string}
    * @readonly
    */
   get descr() {
@@ -330,7 +411,9 @@ class TXEpgScheduleItem {
       if (dtValue !== '') {
         const opt = { force: true };
         const item = insertXObjElement(this.#_host, XEPG_SCHEDTIME_ETAG_NAME, opt);
-        if (item) result = writeXObjParam(item, dtValue);
+        if (item) {
+          result = writeXObjParam(item, dtValue, defParseOptions.settings.textKey);
+        };
       };
     };
     return result;
@@ -346,7 +429,9 @@ class TXEpgScheduleItem {
     if (typeof value === 'string') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_SCHEDTITL_ETAG_NAME, opt);
-      if (item) result = writeXObjParam(item, value.trim());
+      if (item) {
+        result = writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
     return result;
   }
@@ -361,7 +446,9 @@ class TXEpgScheduleItem {
     if (typeof value === 'string') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_SCHEDCAT_ETAG_NAME, opt);
-      if (item) result = writeXObjParam(item, value.trim());
+      if (item) {
+        result = writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
     return result;
   }
@@ -377,7 +464,9 @@ class TXEpgScheduleItem {
     if (_value !== -1) {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_SCHEDPMARK_ETAG_NAME, opt);
-      if (item) result = writeXObjParam(item, _value);
+      if (item) {
+        result = writeXObjParam(item, _value, defParseOptions.settings.textKey);
+      };
     };
     return result;
   }
@@ -392,7 +481,9 @@ class TXEpgScheduleItem {
     if (typeof value === 'string') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_SCHEDDESC_ETAG_NAME, opt);
-      if (item) result = writeXObjParam(item, value.trim());
+      if (item) {
+        result = writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
     return result;
   }
@@ -423,24 +514,23 @@ class TXEpgScheduleItem {
  * @classdesc This class implements an interface of a EPG-schedules list
  */
 class TXEpgSchedulesList {
-  /** @property {object[]} */
+  /** @type {object[]} */
   #_content;// = null;
-  /** @property {object} */
+  /** @type {OPT_epgelsett_ex} */
   #_options;// = null;
-  /** @property {?object} */
+  /** @type {?object} */
   #_dts_src = null;
-  /** @property {?object} */
+  /** @type {?object} */
   #_tz_src = null;
 
   /**
    * @param {any[]} obj - list of an elements
-   * @param {object} [opt] - options
-   * @param {?object} [opt.dts_src]
-   * @param {?object} [opt.tz_src]
+   * @param {OPT_epgelsett_ex} [opt] - options
    * @description Creates an instance of the schedules list
    */
   constructor(obj, opt) {
     const _content = isArray(obj) ? obj : [];
+    /** @type {OPT_epgelsett_ex} */
     const _options = isPlainObject(opt) ? opt : {};
     let { dts_src, tz_src } = _options;
     if (!isPlainObject(dts_src)) dts_src = null;
@@ -468,7 +558,7 @@ class TXEpgSchedulesList {
 
   /**
    * Contains a quantity of a schedules
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get schedQty() {
@@ -477,7 +567,7 @@ class TXEpgSchedulesList {
 
   /**
    * Contains a dtstype ID
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get dtstype() {
@@ -486,7 +576,7 @@ class TXEpgSchedulesList {
 
   /**
    * Contains a TZ-offset
-   * @property {number}
+   * @type {number}
    * @readonly
    */
   get curDocTZ() {
@@ -527,9 +617,9 @@ class TXEpgSchedulesList {
   }
 
   /**
+   * @since 0.0.20
    * @param {(number|string)} value - index of some element
    * @returns {boolean}
-   * @since 0.0.20
    * @description Checks whether a given value is a valid index
    *              and it fits the index range of an instance
    */
@@ -539,9 +629,9 @@ class TXEpgSchedulesList {
   }
 
   /**
+   * @since 0.0.22
    * @param {(number|string)} index - index of some element
    * @returns {?TXEpgScheduleItem}
-   * @since 0.0.22
    * @description Returns a schedule element addressed by a given index
    */
   schedule(index) {
@@ -602,24 +692,24 @@ class TXEpgSchedulesList {
  * @classdesc This class implements an interface of a EPG-provider element
  */
 class TXEpgProviderContainer {
-  /** @property {Object} */
+  /** @type {Object} */
   #_host;// = null;
-  /** @property {Object} */
+  /** @type {OPT_epgelsett_bs} */
   #_options;// = null;
-  /** @property {TXmlContentParseOptions} */
+  /** @type {TXmlContentParseOptions} */
   #_parseOptions;// = null;
-  /** @property {?TXEpgDTSProvider} */
+  /** @type {?TXEpgDTSProvider} */
 
   /**
    * @param {object} obj - host object
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
+   * @param {OPT_epgelsett_bs} [opt] - options
    * @description Creates an instance of the EPG-provider element
    */
   constructor(obj, opt) {
     // load content
     const _host = isPlainObject(obj) ? obj : {};
     // load options
+    /** @type {OPT_epgelsett_bs} */
     const _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -652,7 +742,7 @@ class TXEpgProviderContainer {
 
   /**
    * Contains a provider name
-   * @property {string}
+   * @type {string}
    */
   get name() {
     return _getXmlChildElementParam(this.#_host, 'name').trim();
@@ -664,7 +754,7 @@ class TXEpgProviderContainer {
 
   /**
    * Contains a version of a provider
-   * @property {string}
+   * @type {string}
    */
   get version() {
     return _getXmlChildElementParam(this.#_host, 'version').trim();
@@ -674,13 +764,15 @@ class TXEpgProviderContainer {
     if (typeof value === 'string' && this.name !== '') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, 'version', opt);
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
   /**
    * Contains a version of a document schema
-   * @property {string}
+   * @type {string}
    */
   get schema() {
     return _getXmlChildElementParam(this.#_host, XEPG_DOCSCH_ETAG_NAME).trim();
@@ -690,13 +782,15 @@ class TXEpgProviderContainer {
     if (typeof value === 'string') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_DOCSCH_ETAG_NAME, opt);
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
   /**
    * Contains a document type
-   * @property {string}
+   * @type {string}
    */
   get doctype() {
     return _getXmlChildElementParam(this.#_host, XEPG_DOCTYP_ETAG_NAME).trim();
@@ -706,7 +800,9 @@ class TXEpgProviderContainer {
     if (typeof value === 'string') {
       const opt = { force: true };
       const item = insertXObjElement(this.#_host, XEPG_DOCTYP_ETAG_NAME, opt);
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
@@ -720,7 +816,9 @@ class TXEpgProviderContainer {
     if (typeof value === 'string') {
       const name = value.trim();
       const item = insertXObjElement(this.#_host, 'name', { force: true });
-      if (item) isSucceed = writeXObjParam(item, name);
+      if (item) {
+        isSucceed = writeXObjParam(item, name, defParseOptions.settings.textKey);
+      };
     };
     return isSucceed;
   }
@@ -803,8 +901,8 @@ class TXEpgProviderContainer {
   }
 
   /**
-   * @returns {string}
    * @since v0.0.20
+   * @returns {string}
    * @description Returns an instance content as a string in an XML-format.
    */
   saveToXMLString() {
@@ -835,28 +933,29 @@ class TXEpgProviderContainer {
  */
 
 /**
+ * @since 0.0.22
  * @classdesc This class implements an interface of a channel element
  */
 class TXEpgChannelContainer {
-  /** @property {object} */
+  /** @type {object} */
   #_host;// = null;
-  /** @property {object} */
+  /** @type {OPT_epgelsett_bs} */
   #_options;// = null;
-  /** @property {TXmlContentParseOptions} */
+  /** @type {TXmlContentParseOptions} */
   #_parseOptions;// = null;
-  /** @property {string} */
+  /** @type {string} */
   #_xepgSchema;// = null;
 
   /**
    * @param {object} obj - host object
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
+   * @param {OPT_epgelsett_bs} [opt] - options
    * @description Creates an instance of the channel element
    */
   constructor(obj, opt) {
     // load content
     const _host = isPlainObject(obj) ? obj : {};
     // load options
+    /** @type {OPT_epgelsett_bs} */
     const _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -877,7 +976,7 @@ class TXEpgChannelContainer {
 
   /**
    * Contains a channel ID
-   * @returns {string}
+   * @type {string}
    * @readonly
    */
   get id() {
@@ -886,7 +985,7 @@ class TXEpgChannelContainer {
 
   /**
    * Contains a channel name
-   * @returns {string}
+   * @type {string}
    */
   get name() {
     return _getXmlChildElementParam(this.#_host, XEPG_CHNNAME_ETAG_NAME).trim();
@@ -899,13 +998,15 @@ class TXEpgChannelContainer {
         XEPG_CHNNAME_ETAG_NAME,
         { force: true },
       );
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
   /**
    * Contains a channel Group ID
-   * @returns {string}
+   * @type {string}
    */
   get gid() {
     return _getXmlChildElementParam(this.#_host, XEPG_CHNGID_ETAG_NAME).trim();
@@ -918,13 +1019,15 @@ class TXEpgChannelContainer {
         XEPG_CHNGID_ETAG_NAME,
         { force: true },
       );
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
   /**
    * Contains a channel source URL
-   * @returns {string}
+   * @type {string}
    */
   get url() {
     return _getXmlChildElementParam(this.#_host, XEPG_CHNURL_ETAG_NAME).trim();
@@ -937,7 +1040,9 @@ class TXEpgChannelContainer {
         XEPG_CHNURL_ETAG_NAME,
         { force: true },
       );
-      if (item) writeXObjParam(item, value.trim());
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptions.settings.textKey);
+      };
     };
   }
 
@@ -956,7 +1061,7 @@ class TXEpgChannelContainer {
         { force: true },
       );
       if (item) {
-        isSucceed = writeXObjParam(item, chnid);
+        isSucceed = writeXObjParam(item, chnid, defParseOptions.settings.textKey);
       };
     };
     return isSucceed;
@@ -1020,14 +1125,15 @@ class TXEpgChannelContainer {
     };
     let item = null;
     const _host = this.#_host;
+    const text_key = defParseOptions.settings.textKey;
     item = insertXObjElement(_host, XEPG_CHNID_ETAG_NAME, { force: true });
-    if (item) writeXObjParam(item, chnid);
+    if (item) writeXObjParam(item, chnid, text_key);
     item = insertXObjElement(_host, XEPG_CHNNAME_ETAG_NAME, { force: true });
-    if (item) writeXObjParam(item, chname);
+    if (item) writeXObjParam(item, chname, text_key);
     item = insertXObjElement(_host, XEPG_CHNGID_ETAG_NAME, { force: true });
-    if (item) writeXObjParam(item, chngid);
+    if (item) writeXObjParam(item, chngid, text_key);
     item = insertXObjElement(_host, XEPG_CHNURL_ETAG_NAME, { force: true });
-    if (item) writeXObjParam(item, srcurl);
+    if (item) writeXObjParam(item, srcurl, text_key);
   }
 
 }
@@ -1036,21 +1142,21 @@ class TXEpgChannelContainer {
  * @classdesc This class implements an interface of a DTS-provider element
  */
 class TXEpgDTSProvider {
-  /** @property {object} */
+  /** @type {object} */
   #_content;// = null;
-  /** @property {object} */
+  /** @type {OPT_epgelsett_bs} */
   #_options;// = null;
 
   /**
    * @param {object} obj - host object
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
+   * @param {OPT_epgelsett_bs} [opt] - options
    * @description Creates an instance of the DTS-provider element
    */
   constructor(obj, opt) {
     // load content
     const _content = isPlainObject(obj) ? obj : {};
     // load options
+    /** @type {OPT_epgelsett_bs} */
     let _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -1077,7 +1183,7 @@ class TXEpgDTSProvider {
 
   /**
    * Contains a dtstype ID
-   * @property {number}
+   * @type {number}
    */
   get dtstype() {
     const item = getXObjElement(this.#_content, XEPG_DTSINFO_ETAG_NAME);
@@ -1092,7 +1198,7 @@ class TXEpgDTSProvider {
 
   /**
    * Contains a TZ-offset
-   * @property {number}
+   * @type {number}
    */
   get curDocTZ() {
     const tz = convTZStringToValue(
@@ -1109,7 +1215,9 @@ class TXEpgDTSProvider {
         XEPG_DOCTZ_ETAG_NAME,
         { force: true },
       );
-      if (item) writeXObjParam(item, _value);
+      if (item) {
+        writeXObjParam(item, _value, defParseOptions.settings.textKey);
+      };
     };
   }
 
@@ -1132,10 +1240,10 @@ class TXEpgDTSProvider {
         let curItem = insertXObjElement(item, 'value', { force: true });
         if (
           curItem
-          && writeXObjParam(curItem, index)
+          && writeXObjParam(curItem, index, defParseOptions.settings.textKey)
           && (curItem = insertXObjElement(item, 'name', { force: true }))
         ) {
-          isSucceed = writeXObjParam(curItem, name);
+          isSucceed = writeXObjParam(curItem, name, defParseOptions.settings.textKey);
         };
       };
     };
@@ -1148,25 +1256,25 @@ class TXEpgDTSProvider {
  * @classdesc This class implements an interface of a EPG-header element
  */
 class TXEpgHeaderContainer {
-  /** @property {Object} */
+  /** @type {Object} */
   #_host;// = null;
-  /** @property {Object} */
+  /** @type {OPT_epgelsett_bs} */
   #_options;// = null;
-  /** @property {TXmlContentParseOptions} */
+  /** @type {TXmlContentParseOptions} */
   #_parseOptions;// = null;
-  /** @property {TXEpgDTSProvider} */
+  /** @type {TXEpgDTSProvider} */
   #_dtsProv;// = null;
 
   /**
-   * @param {object} obj
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
+   * @param {object} obj - host element
+   * @param {OPT_epgelsett_bs} [opt] - options
    * @description Creates an instance of the EPG-header element
    */
   constructor(obj, opt) {
     // load content
     const _host = isPlainObject(obj) ? obj : {};
     // load options
+    /** @type {OPT_epgelsett_bs} */
     const _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -1187,7 +1295,7 @@ class TXEpgHeaderContainer {
 
   /**
    * Returns a `TXEpgDTSProvider` instance
-   * @property {TXEpgDTSProvider}
+   * @type {TXEpgDTSProvider}
    * @readonly
    */
   get dts() {
@@ -1196,7 +1304,7 @@ class TXEpgHeaderContainer {
 
   /**
    * Contains a dtstype ID
-   * @property {number}
+   * @type {number}
    * @todo [since v0.0.22] becomes readonly
    */
   get dtstype() {
@@ -1209,7 +1317,7 @@ class TXEpgHeaderContainer {
 
   /**
    * Contains a TZ-offset
-   * @property {number}
+   * @type {number}
    * @todo [since v0.0.22] becomes readonly
    */
   get curDocTZ() {
@@ -1244,7 +1352,7 @@ class TXEpgHeaderContainer {
 
   /**
    * Returns a `TXEpgProviderContainer` instance
-   * @property {?TXEpgProviderContainer}
+   * @type {?TXEpgProviderContainer}
    * @readonly
    * @deprecated
    */
@@ -1255,7 +1363,7 @@ class TXEpgHeaderContainer {
   /**
    * Returns a `TXEpgProviderContainer` instance
    * @since 0.0.22
-   * @property {?TXEpgProviderContainer}
+   * @type {?TXEpgProviderContainer}
    * @readonly
    */
   get provider() {
@@ -1270,7 +1378,7 @@ class TXEpgHeaderContainer {
   /**
    * Returns a `TXEpgChannelContainer` instance
    * @since 0.0.22
-   * @property {?TXEpgChannelContainer}
+   * @type {?TXEpgChannelContainer}
    * @readonly
    */
   get channel() {
@@ -1301,7 +1409,9 @@ class TXEpgHeaderContainer {
       XEPG_DOCDTO_ETAG_NAME,
       { force: true },
     );
-    if (item) writeXObjParam(item, dt_str);
+    if (item) {
+      writeXObjParam(item, dt_str, defParseOptions.settings.textKey);
+    };
   }
 
   /**
@@ -1330,7 +1440,9 @@ class TXEpgHeaderContainer {
       XEPG_DOCDTE_ETAG_NAME,
       { force: true },
     );
-    if (item) writeXObjParam(item, dt_str);
+    if (item) {
+      writeXObjParam(item, dt_str, defParseOptions.settings.textKey);
+    };
   }
 
   /**
@@ -1385,8 +1497,8 @@ class TXEpgHeaderContainer {
   }
 
   /**
-   * @returns {string}
    * @since v0.0.20
+   * @returns {string}
    * @description Returns an instance content as a string in an XML-format.
    */
   saveToXMLString() {
@@ -1412,32 +1524,37 @@ class TXEpgHeaderContainer {
  * @property {boolean} isERR - flag
  * @property {number} [errCode] - error code
  * @property {string} errEvent - event ID
- * @property {string} errMsg - event message
- * @property {string} source - path to file
- * @property {any} content - file content
+ * @property {string} [errMsg] - event message
+ * @property {string} [source] - path to file
+ * @property {any} [content] - file content
  * @description A fs ops description.
  */
 
+/**
+ * @typedef {Object} OPT_epgcpsett
+ * @property {TXmlContentParseOptions} [parseOptions] - parser options
+ * @property {boolean} [autoBindRoot] - <*deprecated*>
+ * @description An options set for `TXEpgContentProvider`-class
+
 /**
  * @classdesc This class implements an interface of the container
  *            that manages a content of a XEPG-document
  */
 class TXEpgContentProvider {
-  /** @property {Object} */
+  /** @type {Object} */
   #_content;// = null;
-  /** @property {Object} */
+  /** @type {OPT_epgcpsett} */
   #_options;// = null;
-  /** @property {?TXmlContentParseOptions} */
+  /** @type {TXmlContentParseOptions} */
   #_parseOptions;// = null;
 
   /**
-   * @param {object} [opt] - options
-   * @param {object} [opt.parseOptions]
-   * @param {boolean} [opt.autoBindRoot] - <*reserved*> ([?] - deprecate)
+   * @param {OPT_epgcpsett} [opt] - options
    * @description Creates an instance of the XEPG-content provider
    */
   constructor(opt) {
     // load options
+    /** @type {OPT_epgcpsett} */
     const _options = isPlainObject(opt) ? opt : {};
     let {
       parseOptions,
@@ -1477,7 +1594,12 @@ class TXEpgContentProvider {
     if (!docRoot) {
       docRoot = insertXObjElement(_content, XEPG_ROOT_ETAG_NAME);
       if (docRoot) {
-        writeXObjAttr(docRoot, `xmlns:${XEPG_DEF_NS_NAME}`, XEPG_DEF_NS_PATH);
+        writeXObjAttr(
+          docRoot,
+          `xmlns:${XEPG_DEF_NS_NAME}`,
+          XEPG_DEF_NS_PATH,
+          defParseOptions.settings.attributesKey,
+        );
       };
     };
     return isPlainObject(docRoot) ? docRoot : null;
@@ -1543,7 +1665,7 @@ class TXEpgContentProvider {
 
   /**
    * Returns a `TXEpgHeaderContainer` instance
-   * @property {?TXEpgHeaderContainer}
+   * @type {?TXEpgHeaderContainer}
    * @readonly
    * @deprecated
    */
@@ -1559,7 +1681,7 @@ class TXEpgContentProvider {
   /**
    * Returns a `TXEpgHeaderContainer` instance
    * @since 0.0.22
-   * @property {?TXEpgHeaderContainer}
+   * @type {?TXEpgHeaderContainer}
    * @readonly
    */
   get header() {
@@ -1573,7 +1695,7 @@ class TXEpgContentProvider {
 
   /**
    * Returns a `TXEpgProviderContainer` instance
-   * @property {?TXEpgProviderContainer}
+   * @type {?TXEpgProviderContainer}
    * @readonly
    * @deprecated
    */
@@ -1585,7 +1707,7 @@ class TXEpgContentProvider {
   /**
    * Returns a `TXEpgProviderContainer` instance
    * @since 0.0.22
-   * @property {?TXEpgProviderContainer}
+   * @type {?TXEpgProviderContainer}
    * @readonly
    */
   get provider() {
@@ -1595,7 +1717,7 @@ class TXEpgContentProvider {
 
   /**
    * Returns a `TXEpgDTSProvider` instance
-   * @property {?TXEpgDTSProvider}
+   * @type {?TXEpgDTSProvider}
    * @readonly
    */
   get dts() {
@@ -1611,7 +1733,7 @@ class TXEpgContentProvider {
 
   /**
    * Returns a `TXEpgSchedulesList` instance
-   * @property {TXEpgSchedulesList}
+   * @type {TXEpgSchedulesList}
    * @readonly
    */
   get SchedulesList() {
@@ -1754,10 +1876,10 @@ class TXEpgContentProvider {
   }
 
   /**
+   * @since 0.0.18
    * @param {string} xmlString - a document content in XML-format
    * @returns {boolean}
    * @throws {Error}
-   * @since 0.0.18
    * @description Loads a document content from a string.
    */
   loadFromXMLString(xmlString) {
@@ -1807,7 +1929,7 @@ class TXEpgContentProvider {
   loadFromFile(source) {
     /**/// main part that return promise as a result
     return new Promise((resolve, reject) => {
-      loadFile(source).then(data => {
+      loadFromFile(source).then(data => {
         if (!data.isERR) {
           if (data.content !== '') {
             if (this.loadFromXMLString(data.content)) {
@@ -1838,7 +1960,7 @@ class TXEpgContentProvider {
    * @description Loads a document content from a file.
    */
   loadFromFileSync(source) {
-    const data = loadFileSync(source);
+    const data = loadFromFileSync(source);
     if (!data.isERR) {
       if (data.content !== '') {
         if (this.loadFromXMLString(data.content)) {
@@ -1868,6 +1990,15 @@ class TXEpgContentProvider {
 
 // === module exports block ===
 
+module.exports.XEPG_DEF_PROVIDER_NAME = XEPG_DEF_PROVIDER_NAME;
+module.exports.XEPG_DEF_PROVIDER_VER = XEPG_DEF_PROVIDER_VER;
+module.exports.XEPG_DEF_DOCUMENT_TYPE = XEPG_DEF_DOCUMENT_TYPE;
+module.exports.XEPG_DEF_DOCUMENT_SCHEMA = XEPG_DEF_DOCUMENT_SCHEMA;
+
+module.exports.readAsTagName = readAsTagName;
+module.exports.readAsAttrName = readAsAttrName;
+module.exports.valueToElementID = valueToElementID;
+
 module.exports.TXEpgDTSProvider = TXEpgDTSProvider;
 module.exports.TXEpgScheduleItem = TXEpgScheduleItem;
 module.exports.TXEpgSchedulesList = TXEpgSchedulesList;
@@ -1876,10 +2007,5 @@ module.exports.TXEpgChannelContainer = TXEpgChannelContainer;
 module.exports.TXEpgHeaderContainer = TXEpgHeaderContainer;
 module.exports.TXEpgContentProvider = TXEpgContentProvider;
 
-module.exports.XEPG_DEF_PROVIDER_NAME = XEPG_DEF_PROVIDER_NAME;
-module.exports.XEPG_DEF_PROVIDER_VER = XEPG_DEF_PROVIDER_VER;
-module.exports.XEPG_DEF_DOCUMENT_TYPE = XEPG_DEF_DOCUMENT_TYPE;
-module.exports.XEPG_DEF_DOCUMENT_SCHEMA = XEPG_DEF_DOCUMENT_SCHEMA;
-
 /** @deprecated */
 module.exports.TXepgDTSProvider = TXEpgDTSProvider;