@ygracs/xepg-lib-js 0.0.23 → 0.0.25

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.23",
+  "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.28",
+    "@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.2"
+    "@ygracs/xobj-lib-js": "^0.2.4"
   },
   "devDependencies": {
-    "cross-env": "^7.0.3",
-    "jest": "^29.7.0",
-    "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"
   }
 }