@ygracs/xepg-lib-js 0.0.26-b → 0.0.30

package/lib/xml-base.d.ts

@@ -1,21 +1,40 @@
-/**
- * Tries to convert a given value to a valid tag name of an XML-element.
- * @since v0.0.23
- */
-export function readAsTagName(value: any): string;
-/**
- * Tries to convert a given value to a valid name of an XML-attribute.
- * @since v0.0.23
- */
-export function readAsAttrName(value: any): string;
-/**
- * Tries to convert a given value to a valid "attribute value".
- * @since v0.0.25
- */
-export function readAsAttrValue(value: any): string | null;
-/**
- * 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
- */
-export function valueToElementID(value: any): string;
+/**
+ * 
+ * @inner
+ */
+export function _getXmlChildElementParam(obj: object | null, name: string, parseOptions?: object): string;
+/**
+ * Tries to convert a given value to a valid tag name of an XML-element.
+ * @since v0.0.23
+ */
+export function readAsTagName(value: any): string;
+/**
+ * Tries to convert a given value to a valid name of an XML-attribute.
+ * @since v0.0.23
+ */
+export function readAsAttrName(value: any): string;
+/**
+ * Tries to convert a given value to a valid "attribute value".
+ * @since v0.0.25
+ */
+export function readAsAttrValue(value: any): string | null;
+/**
+ * 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
+ */
+export function valueToElementID(value: any): string;
+/**
+ * Returns an object as a string in an XML-format.
+ * @since v0.0.24
+ * @inner
+ */
+export function serializeXObjToXMLString(node: object, opt: object, tagName: string): string;
+/**
+ * Loads an object content from an XML-string.
+ * @since v0.0.24
+ * @throws {Error}
+ * @inner
+ * @experimental
+ */
+export function deserializeXObjFromXMLString(node: object, opt: object, text: string, tagName: string): boolean;

package/lib/xml-base.js

@@ -1,30 +1,48 @@
-// [v0.1.002-20250825]
+// [v0.1.005-20260531]
 
 // === module init block ===
 
 const {
-  //valueToIndex,
+  isPlainObject,
   valueToIDString,
-  //readAsString, readAsNumber,
-  //isNotEmptyString,
-  //isArray, isObject, isPlainObject,
 } = require('@ygracs/bsfoc-lib-js');
 
-// === module inner block ===
+const xmlParser = require('@ygracs/xml-js6');
 
-/***
- * (* helper function definitions *)
- */
+const {
+  getXObjElement,
+  readXObjParam,
+} = require('@ygracs/xobj-lib-js');
 
-// === module main block ===
+const {
+  defParseOptionsSettings,
+} = require('./xepg-defs');
 
-/***
- * (* constant definitions *)
- */
+// === module inner block ===
 
-/***
- * (* function definitions *)
+/**
+ * @param {?object} obj - element
+ * @param {string} name - child element name
+ * @param {object} [parseOptions]  - parser options
+ * @returns {string}
+ * @inner
  */
+function _getXmlChildElementParam(obj, name, parseOptions) {
+  const child = obj ? getXObjElement(obj, name) : null;
+  if (child) {
+    const target = (
+      isPlainObject(parseOptions)
+      ? parseOptions.textKey
+      : defParseOptionsSettings.textKey
+    );
+    return readXObjParam(child, target);
+  } else {
+    return '';
+  };
+};
+module.exports._getXmlChildElementParam = _getXmlChildElementParam;
+
+// === module main block ===
 
 /**
  * Tries to convert a given value to a valid tag name of an XML-element.
@@ -47,6 +65,7 @@ function readAsTagName(value) {
   };
   return tagName;
 };
+module.exports.readAsTagName = readAsTagName;
 
 /**
  * Tries to convert a given value to a valid name of an XML-attribute.
@@ -69,6 +88,7 @@ function readAsAttrName(value) {
   };
   return attrName;
 };
+module.exports.readAsAttrName = readAsAttrName;
 
 /**
  * Tries to convert a given value to a valid "attribute value".
@@ -97,6 +117,7 @@ function readAsAttrValue(value) {
   };
   return result;
 };
+module.exports.readAsAttrValue = readAsAttrValue;
 
 /**
  * Tries to convert a given value to a valid identifier suitable as a value
@@ -120,14 +141,68 @@ function valueToElementID(value) {
   };
   return id;
 };
+module.exports.valueToElementID = valueToElementID;
 
-/***
- * (* class definitions *)
+/**
+ * Returns an object as a string in an XML-format.
+ * @since v0.0.24
+ * @function serializeXObjToXMLString
+ * @param {object} node - some element
+ * @param {object} opt - parser options
+ * @param {string} tagName - element tag name
+ * @returns {string}
+ * @inner
  */
+function serializeXObjToXMLString(node, opt, tagName) {
+  let result = '';
+  try {
+    result = xmlParser.js2xml({ [tagName]: node }, opt);
+  } catch (err) {
+    //console.log('CHECK: serializeXObjToXMLString() => Error => '+err);
+    result = '';
+    //throw err;
+  };
+  return result;
+};
+module.exports.serializeXObjToXMLString = serializeXObjToXMLString;
 
-// === module exports block ===
-
-module.exports.readAsTagName = readAsTagName;
-module.exports.readAsAttrName = readAsAttrName;
-module.exports.readAsAttrValue = readAsAttrValue;
-module.exports.valueToElementID = valueToElementID;
+/**
+ * Loads an object content from an XML-string.
+ * @since v0.0.24
+ * @function deserializeXObjFromXMLString
+ * @param {object} node - some element
+ * @param {object} opt - parser options
+ * @param {string} text - some content
+ * @param {string} tagName - element tag name
+ * @returns {boolean}
+ * @throws {Error}
+ * @inner
+ * @experimental
+ */
+function deserializeXObjFromXMLString(node, opt, text, tagName) {
+  let result = false;
+  if (typeof text === 'string' && text !== '') {
+    try {
+      let obj = xmlParser.xml2js(text, opt);
+      if (isPlainObject(obj)) {
+        obj = obj[tagName];
+        if (isPlainObject(obj)) {
+          for (let prop in node) {
+            // // TODO: catch errors in strict mode
+            delete node[prop];
+          };
+          (Object.entries(obj)).forEach(([key, value]) => {
+            node[key] = value;
+          });
+          result = true;
+        };
+      };
+    } catch (err) {
+      //console.log('CHECK: deserializeXObjFromXMLString() => Error => '+err);
+      //console.log('CHECK: deserializeXObjFromXMLString() => Error => '+err.code);
+      throw err;
+    };
+  };
+  return result;
+};
+module.exports.deserializeXObjFromXMLString = deserializeXObjFromXMLString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xepg-lib-js",
-  "version": "0.0.26-b",
+  "version": "0.0.30",
   "description": "A library for handling an EPG-sources based on an XEPG-format",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -19,6 +19,9 @@
     "doc/*.xepg",
     "doc/*.md",
     "lib/xepgdoc-lib.js",
+    "lib/xepg-defs.js",
+    "lib/xepg-sched.js",
+    "lib/xepg-channel.js",
     "lib/dts-helper.js",
     "lib/xml-base.js",
     "lib/*.d.ts",
@@ -37,16 +40,16 @@
     "#test-dir/*": "./__test__/*"
   },
   "dependencies": {
-    "@cntwg/file-helper": "^0.0.3",
-    "@ygracs/bsfoc-lib-js": "~0.3.3",
-    "@ygracs/dtf-lib-js": "^0.0.33",
-    "@ygracs/xml-js6": "^0.0.6-b",
-    "@ygracs/xobj-lib-js": "^0.2.8-b"
+    "@cntwg/file-helper": "~0.0.4",
+    "@ygracs/bsfoc-lib-js": "~0.3.4",
+    "@ygracs/dtf-lib-js": "~0.1.0-beta.2",
+    "@ygracs/xml-js6": "~0.0.9-b",
+    "@ygracs/xobj-lib-js": "~0.3.3"
   },
   "devDependencies": {
-    "@ygracs/test-helper": "~0.0.1-b",
+    "@ygracs/test-helper": "~0.0.2-b",
     "cross-env": "^10.1.0",
-    "jest": "^30.2.0",
+    "jest": "^30.4.2",
     "jsdoc-to-markdown": "^9.1.3",
     "minimist": "^1.2.8",
     "typescript": "~5.9.3"