@ygracs/xepg-lib-js 0.0.24 → 0.0.25

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+#### *v0.0.25*
+
+Pre-release version.
+
+> - update `xepgdoc-lib.md`;
+> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.3.0;
+> - update dependency on `@ygracs/dtf-lib-js` module to v0.0.30;
+> - update dependency on `@ygracs/xobj-lib-js` module to v0.2.4;
+> - move some functions from `$lib/xepgdoc-lib.js` into new `$lib/xml-base.js` module;
+> - add function: `readAsAttrValue`;
+> - (`TXEpgHeaderContainer`) remove deprecated property: `Provider`;
+> - (`TXEpgContentProvider`) remove deprecated properties: `Header`, `Provider`.
+
 #### *v0.0.24*
 
 Pre-release version.

package/README.md

@@ -1,6 +1,6 @@
-|***rev.*:**|0.0.10|
+|***rev.*:**|0.0.11|
 |:---|---:|
-|***date***:|2025-07-30|
+|***date***:|2025-08-25|
 
 ## Introduction
 
@@ -20,6 +20,7 @@ This module contains the following components:
 
 	+ `readAsTagName`;
 	+ `readAsAttrName`;
+	+ `readAsAttrValue`;
 	+ `valueToElementID`;
 
 - classes:

package/doc/xepgdoc-lib.md

@@ -1,6 +1,6 @@
-|***rev.*:**|0.1.40|
+|***rev.*:**|0.1.43|
 |:---|---:|
-|***date***:|2025-07-30|
+|***date***:|2025-08-25|
 
 ## Introduction
 
@@ -91,6 +91,17 @@ This function tries to convert a given `value` to the value of type which is sui
 |:---|---|---:|:---|
 | `value` | `any` | --- | some value to read |
 
+<a name="readAsAttrValue"></a>
+#### **readAsAttrValue(value)** => `string`
+
+> since: \[`v0.0.25`]
+
+This function tries to convert a given `value` to the value of type which is suitable for an XML-element's attribute. If failed a `null` is returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | some value |
+
 <a name="valueToElementID"></a>
 #### **valueToElementID(value)**
 
@@ -670,11 +681,6 @@ The `options` structure is listed below:
 |---|---|:---|
 | `number` | no | defines a current TimeZone |
 
-<a name="TXEpgHeaderContainer+Provider"></a>
-##### **Provider**
-
-> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`provider` property](#TXEpgHeaderContainer+provider) instead.
-
 <a name="TXEpgHeaderContainer+provider"></a>
 ##### **provider**
 
@@ -822,11 +828,6 @@ The `options` structure is listed below:
 
 #### class properties
 
-<a name="TXEpgContentProvider+Header"></a>
-##### **Header**
-
-> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`header` property](#TXEpgContentProvider+header) instead.
-
 <a name="TXEpgContentProvider+header"></a>
 ##### **header**
 
@@ -836,11 +837,6 @@ The `options` structure is listed below:
 |---|---|:---|
 | `TXEpgHeaderContainer` | yes | returns a `TXEpgHeaderContainer` instance |
 
-<a name="TXEpgContentProvider+Provider"></a>
-##### **Provider**
-
-> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`provider` property](#TXEpgContentProvider+provider) instead.
-
 <a name="TXEpgContentProvider+provider"></a>
 ##### **provider**
 

package/index.js

@@ -1,4 +1,4 @@
-// [v0.1.011-20250727]
+// [v0.1.014-20250825]
 
 // === module init block ===
 
@@ -6,6 +6,8 @@ const xepgdoc = require('./lib/xepgdoc-lib.js');
 
 const xObj = require('@ygracs/xobj-lib-js');
 
+const xmlBase = require('./lib/xml-base');
+
 // === module inner block ===
 
 // === module main block ===
@@ -20,9 +22,10 @@ module.exports.TXEpgDTSProvider = xepgdoc.TXEpgDTSProvider;
 module.exports.TXEpgProviderContainer = xepgdoc.TXEpgProviderContainer;
 module.exports.TXEpgHeaderContainer = xepgdoc.TXEpgHeaderContainer;
 
-module.exports.readAsTagName = xepgdoc.readAsTagName;
-module.exports.readAsAttrName = xepgdoc.readAsAttrName;
-module.exports.valueToElementID = xepgdoc.valueToElementID;
+module.exports.readAsTagName = xmlBase.readAsTagName;
+module.exports.readAsAttrName = xmlBase.readAsAttrName;
+module.exports.readAsAttrValue = xmlBase.readAsAttrValue;
+module.exports.valueToElementID = xmlBase.valueToElementID;
 
 // re-export stuff from `@ygracs/xobj-lib-js` module
 module.exports.TXmlContentParseOptions = xObj.TXmlContentParseOptions;

package/lib/xepgdoc-lib.js

@@ -1,4 +1,4 @@
-// [v0.2.124-20250730]
+// [v0.2.128-20250825]
 
 // === module init block ===
 
@@ -36,6 +36,12 @@ const {
   writeXObjAttr,
 } = xObj;
 
+const {
+  readAsTagName,
+  readAsAttrName,
+  valueToElementID,
+} = require('./xml-base');
+
 // === module inner block ===
 
 /*
@@ -252,73 +258,6 @@ const defParseOptions = new TXmlContentParseOptions();
  * (* function definitions *)
  */
 
-/**
- * Tries to convert a given value to a valid tag name of an XML-element.
- * @since v0.0.23
- * @function readAsTagName
- * @param {any} value - some value
- * @returns {string}
- */
-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;
-};
-
-/**
- * Tries to convert a given value to a valid name of an XML-attribute.
- * @since v0.0.23
- * @function readAsAttrName
- * @param {any} value - some value
- * @returns {string}
- */
-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;
-};
-
-/**
- * Tries to convert a given value to a valid identifier suitable as a value
- * for an "ID-attribute" of an XML-element.
- * @since v0.0.23
- * @function valueToElementID
- * @param {any} value - some value
- * @returns {string}
- */
-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 *)
  */
@@ -1495,17 +1434,6 @@ class TXEpgHeaderContainer {
     return isPlainObject(docProv) ? docProv : null;
   }
 
-  /**
-   * Returns a `TXEpgProviderContainer` instance
-   * @type {?TXEpgProviderContainer}
-   * @readonly
-   * @deprecated
-   * @todo \[since `v0.0.22`] deprecated. Use `TXEpgHeaderContainer.provider`
-   */
-  get Provider() {
-    return this.provider;
-  }
-
   /**
    * Returns a `TXEpgProviderContainer` instance
    * @since 0.0.22
@@ -1823,17 +1751,6 @@ class TXEpgContentProvider {
     return isPlainObject(docBody) ? docBody : null;
   }
 
-  /**
-   * Returns a `TXEpgHeaderContainer` instance
-   * @type {?TXEpgHeaderContainer}
-   * @readonly
-   * @deprecated
-   * @todo \[since `v0.0.22`] deprecated. Use `TXEpgContentProvider.header`
-   */
-  get Header() {
-    return this.header;
-  }
-
   /**
    * Returns a `TXEpgHeaderContainer` instance
    * @since 0.0.22
@@ -1849,17 +1766,6 @@ class TXEpgContentProvider {
     );
   }
 
-  /**
-   * Returns a `TXEpgProviderContainer` instance
-   * @type {?TXEpgProviderContainer}
-   * @readonly
-   * @deprecated
-   * @todo \[since `v0.0.22`] deprecated. Use `TXEpgContentProvider.provider`
-   */
-  get Provider() {
-    return this.provider;
-  }
-
   /**
    * Returns a `TXEpgProviderContainer` instance
    * @since 0.0.22
@@ -2156,10 +2062,6 @@ 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;
@@ -2167,3 +2069,8 @@ module.exports.TXEpgProviderContainer = TXEpgProviderContainer;
 module.exports.TXEpgChannelContainer = TXEpgChannelContainer;
 module.exports.TXEpgHeaderContainer = TXEpgHeaderContainer;
 module.exports.TXEpgContentProvider = TXEpgContentProvider;
+
+// * re-exported *
+module.exports.readAsTagName = readAsTagName;
+module.exports.readAsAttrName = readAsAttrName;
+module.exports.valueToElementID = valueToElementID;

package/lib/xml-base.js

@@ -0,0 +1,133 @@
+// [v0.1.002-20250825]
+
+// === module init block ===
+
+const {
+  //valueToIndex,
+  valueToIDString,
+  //readAsString, readAsNumber,
+  //isNotEmptyString,
+  //isArray, isObject, isPlainObject,
+} = require('@ygracs/bsfoc-lib-js');
+
+// === module inner block ===
+
+/***
+ * (* helper function definitions *)
+ */
+
+// === module main block ===
+
+/***
+ * (* constant definitions *)
+ */
+
+/***
+ * (* function definitions *)
+ */
+
+/**
+ * Tries to convert a given value to a valid tag name of an XML-element.
+ * @since v0.0.23
+ * @function readAsTagName
+ * @param {any} value - some value
+ * @returns {string}
+ */
+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;
+};
+
+/**
+ * Tries to convert a given value to a valid name of an XML-attribute.
+ * @since v0.0.23
+ * @function readAsAttrName
+ * @param {any} value - some value
+ * @returns {string}
+ */
+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;
+};
+
+/**
+ * Tries to convert a given value to a valid "attribute value".
+ * @since v0.0.25
+ * @function readAsAttrValue
+ * @param {any} value - some value
+ * @return {?string}
+ */
+function readAsAttrValue(value) {
+  let result = null;
+  switch (typeof value) {
+    case 'boolean': {
+      result = value.toString();
+      break;
+    }
+    case 'number': {
+      if (Number.isNaN(value)) break;
+      result = value.toString();
+      break;
+    }
+    case 'string': {
+      result = value.trim();
+      break;
+    }
+    default: {}
+  };
+  return result;
+};
+
+/**
+ * Tries to convert a given value to a valid identifier suitable as a value
+ * for an "ID-attribute" of an XML-element.
+ * @since v0.0.23
+ * @function valueToElementID
+ * @param {any} value - some value
+ * @returns {string}
+ */
+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 *)
+ */
+
+// === module exports block ===
+
+module.exports.readAsTagName = readAsTagName;
+module.exports.readAsAttrName = readAsAttrName;
+module.exports.readAsAttrValue = readAsAttrValue;
+module.exports.valueToElementID = valueToElementID;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xepg-lib-js",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "description": "A library for handling an EPG-sources based on an XEPG-format",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -19,6 +19,7 @@
     "doc/*.md",
     "lib/xepgdoc-lib.js",
     "lib/dts-helper.js",
+    "lib/xml-base.js",
     "index.js",
     "CHANGELOG.md"
   ],
@@ -33,15 +34,15 @@
   },
   "dependencies": {
     "@cntwg/file-helper": "^0.0.1",
-    "@ygracs/bsfoc-lib-js": "^0.2.3",
-    "@ygracs/dtf-lib-js": "^0.0.29",
+    "@ygracs/bsfoc-lib-js": "^0.3.0",
+    "@ygracs/dtf-lib-js": "^0.0.30",
     "@ygracs/xml-js6": "^0.0.5-b",
-    "@ygracs/xobj-lib-js": "^0.2.3"
+    "@ygracs/xobj-lib-js": "^0.2.4"
   },
   "devDependencies": {
-    "cross-env": "^7.0.3",
-    "jest": "^30.0.4",
-    "jsdoc-to-markdown": "^9.1.1",
+    "cross-env": "^10.0.0",
+    "jest": "^30.0.5",
+    "jsdoc-to-markdown": "^9.1.2",
     "minimist": "^1.2.8"
   }
 }