@cntwg/xml-lib-js 0.0.20 → 0.0.22

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+#### *v0.0.22*
+
+Pre-release version.
+
+> - some fixes in `xmldoc-lib.js` module.
+
+#### *v0.0.21*
+
+Pre-release version.
+
+> - some fixes in `xmldoc-lib.js` module;
+> - added method `hasChild()` from `TXmlElementController` class;
+> - removed constants `DEF_XML_PARSE_OPTIONS` and `DEF_XML_ROOT_ETAG_NAME` from `xmldoc-lib.js` module exports;
+> - updated dependency on `@ygracs/xobj-lib-js` module to v0.0.14rc3.
+
 #### *v0.0.20*
 
 Pre-release version.

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2019-2023 Yuri Grachev
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2019-2023 Yuri Grachev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/doc/xmldoc-lib.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.19|
+>|***rev.*:**|0.1.20|
 >|:---|---:|
->|date:|2023-02-14|
+>|date:|2023-03-01|
 
 ## Introduction
 
@@ -183,6 +183,10 @@ The method received value that can be a string or an array. If value is an array
 or
 `[ <lang>, <textValue> ]`.
 
+##### **hasChild(name)**
+
+This method checks whether or not a child element addressed by `name` is exists.
+
 ##### **getChild(name)**
 
 This method returns a child element addressed by `name`.

package/index.js

@@ -1,31 +1,31 @@
-// [v0.1.007-20220722]
-
-// === module init block ===
-
-const xObj = require('@ygracs/xobj-lib-js');
-const xmldoc = require('./lib/xmldoc-lib.js');
-
-// === module extra block (helper functions) ===
-
-// === module main block ===
-
-// === module exports block ===
-
-exports.xObj = xObj;
-
-// will deprecate
-exports.DEF_XML_PARSE_OPTIONS = xmldoc.DEF_XML_PARSE_OPTIONS;
-// will deprecate
-exports.DEF_XML_ROOT_ETAG_NAME = xmldoc.DEF_XML_ROOT_ETAG_NAME;
-
-exports.XML_DEF_PARSE_OPTIONS = xmldoc.XML_DEF_PARSE_OPTIONS;
-exports.XML_DEF_ROOT_ETAG_NAME = xmldoc.XML_DEF_ROOT_ETAG_NAME;
-
-exports.TXmlContentParseOptions = xmldoc.TXmlContentParseOptions;
-
-exports.TXmlAttributesMapper = xmldoc.TXmlAttributesMapper;
-exports.TXmlElementController = xmldoc.TXmlElementController;
-exports.TXmlElementsListController = xmldoc.TXmlElementsListController;
-exports.TXmlContentDeclaration = xmldoc.TXmlContentDeclaration;
-exports.TXmlContentRootElement = xmldoc.TXmlContentRootElement;
-exports.TXmlContentContainer = xmldoc.TXmlContentContainer;
+// [v0.1.009-20230316]
+
+// === module init block ===
+
+const xObj = require('@ygracs/xobj-lib-js');
+const xmldoc = require('./lib/xmldoc-lib.js');
+
+// === module extra block (helper functions) ===
+
+// === module main block ===
+
+// === module exports block ===
+
+exports.xObj = xObj;
+
+// will deprecate
+exports.DEF_XML_PARSE_OPTIONS = xmldoc.XML_DEF_PARSE_OPTIONS;
+// will deprecate
+exports.DEF_XML_ROOT_ETAG_NAME = xmldoc.XML_DEF_ROOT_ETAG_NAME;
+
+exports.XML_DEF_PARSE_OPTIONS = xmldoc.XML_DEF_PARSE_OPTIONS;
+exports.XML_DEF_ROOT_ETAG_NAME = xmldoc.XML_DEF_ROOT_ETAG_NAME;
+
+exports.TXmlContentParseOptions = xmldoc.TXmlContentParseOptions;
+
+exports.TXmlAttributesMapper = xmldoc.TXmlAttributesMapper;
+exports.TXmlElementController = xmldoc.TXmlElementController;
+exports.TXmlElementsListController = xmldoc.TXmlElementsListController;
+exports.TXmlContentDeclaration = xmldoc.TXmlContentDeclaration;
+exports.TXmlContentRootElement = xmldoc.TXmlContentRootElement;
+exports.TXmlContentContainer = xmldoc.TXmlContentContainer;

package/lib/xmldoc-lib.js

@@ -1,4 +1,4 @@
-// [v0.1.053-20230214]
+// [v0.1.066-20230317]
 
 // === module init block ===
 
@@ -66,12 +66,12 @@ class TXmlAttributesMapper {
     return isPlainObject(items) ? Object.entries(items) : [];
   }
 
-  hasAttribute(value){
+  hasAttribute(name){
     let result = false;
     try {
       result = xObj.checkXObjAttribute(
         this.#_host,
-        value,
+        name,
         this.#_options.settings.attributesKey,
       );
     } catch (err) {
@@ -81,12 +81,12 @@ class TXmlAttributesMapper {
     return result;
   }
 
-  getAttribute(value){
+  getAttribute(name){
     let result = '';
     try {
       result = xObj.readXObjAttr(
         this.#_host,
-        value,
+        name,
         this.#_options.settings.attributesKey,
       );
     } catch (err) {
@@ -112,24 +112,19 @@ class TXmlAttributesMapper {
     return result;
   }
 
-  delAttribute(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return false;
-    };
-    // // TODO: await implementation for class method provided by xObj
-    let items = xObj.getXObjAttributes(
-      this.#_host,
-      this.#_options.settings.attributesKey,
-    );
-    let isSUCCEED = isPlainObject(items);
-    if (isSUCCEED) {
-      // // TODO: catch errors in strict mode
-      isSUCCEED = delete items[name];
+  delAttribute(name){
+    let result = false;
+    try {
+      result = xObj.deleteXObjAttribute(
+        this.#_host,
+        name,
+        this.#_options.settings.attributesKey,
+      );
+    } catch (err) {
+      // // TODO: verify what error is thrown
+      result = false;
     };
-    return isSUCCEED;
+    return result;
   }
 
   clear(){
@@ -244,42 +239,60 @@ class TXmlElementController {
   }
 
   setTextValue(value){
-    value = valueToArray(value);
-    let val_size = value.length;
-    if (val_size === 1) {
-      return xObj.writeXObjParam(
-        this.#_host,
-        value[0],
-        this.#_parseOptions.settings.textKey,
-      );
-    } else if (val_size > 1) {
-      if (xObj.writeXObjParam(
-        this.#_host,
-        value[1],
-        this.#_parseOptions.settings.textKey,
-      )) {
-        return this.#_attributes.setAttribute(XML_LANG_ATTR_TNAME, value[0]);
+    const _value = valueToArray(value);
+    const len = _value.length;
+    if (len > 0) {
+      if (len === 1) {
+        return xObj.writeXObjParam(
+          this.#_host,
+          _value[0],
+          this.#_parseOptions.settings.textKey,
+        );
+      } else {
+        const [ lang, param ] = _value;
+        if (xObj.writeXObjParam(
+          this.#_host,
+          param,
+          this.#_parseOptions.settings.textKey,
+        )) {
+          return this.#_attributes.setAttribute(XML_LANG_ATTR_TNAME, lang);
+        };
       };
     };
     return false;
   }
 
-  getChild(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return null;
+  hasChild(name){
+    const _name = xObj.evalXObjEName(name);
+    let result = false;
+    if (typeof _name === 'string' && _name !== '') {
+      try {
+        result = isObject(xObj.getXObjElement(this.#_host, name));
+      } catch (err) {
+        // // TODO: [?] verify what error is thrown
+        throw err;
+      };
     };
-    let item = xObj.getXObjElement(this.#_host, name);
-    if (isArray(item)) {
-      item = new TXmlElementsListController(item, this.#_options);
-    } else if (isObject(item)) {
-      item = new TXmlElementController(item, this.#_options);
-    } else {
-      item = null;
+    return result;
+  }
+
+  getChild(name){
+    const _name = xObj.evalXObjEName(name);
+    let result = null;
+    if (typeof _name === 'string' && _name !== '') {
+      try {
+        const item = xObj.getXObjElement(this.#_host, name);
+        if (isArray(item)) {
+          result = new TXmlElementsListController(item, this.#_options);
+        } else if (isObject(item)) {
+          result = new TXmlElementController(item, this.#_options);
+        };
+      } catch (err) {
+        // // TODO: [?] verify what error is thrown
+        throw err;
+      };
     };
-    return item;
+    return result;
   }
 
   _getChildRaw(name){
@@ -294,23 +307,9 @@ class TXmlElementController {
     return item !== undefined ? item : null;
   }
 
-  _setChildRaw(name, obj){
+  _setChildRaw(...args){
     //console.log('CHECK: TXmlElementController._setChildRaw() => was called...');
-    let isSUCCEED = false; let item = null;
-    if (isArray(obj)) {
-      //console.log('CHECK: TXmlElementController._setChildRaw() => <obj> is array...');
-      item = xObj.insertXObjEList(this.#_host, name, true);
-      // load elements
-      for (let element of obj) {
-        if (isPlainObject(element)) item.push(element);
-      };
-    } else if (isObject(obj)) {
-      //console.log('CHECK: TXmlElementController._setChildRaw() => <obj> is object...');
-      item = xObj.insertXObjElement(this.#_host, name, true);
-      // // TODO: set element
-    };
-    if (item) isSUCCEED = true;
-    return isSUCCEED;
+    return TXmlElementController.__setChildRaw(this, ...args);
   }
 
   _addChildRaw(name){//}, obj){
@@ -325,38 +324,48 @@ class TXmlElementController {
     return result.isSucceed ? result.item : null;
   }
 
-  addChild(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return null;
+  addChild(name){
+    const _name = xObj.evalXObjEName(name);
+    let result = null;
+    if (typeof _name === 'string' && _name !== '') {
+      try {
+        let { item } = xObj.addXObjElement(this.#_host, name);
+        if (item) result = new TXmlElementController(item, this.#_options)
+      } catch (err) {
+        // // TODO: [?] verify what error is thrown
+        throw err;
+      };
     };
-    const result = xObj.addXObjElement(this.#_host, name);
-    return (
-      result.isSucceed
-      ? new TXmlElementController(result.item, this.#_options)
-      : null
-    );
+    return result;
   }
 
-  delChild(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return false;
-    };
-    let item = xObj.getXObjElement(this.#_host, name);
-    if (isArray(item)) {
-      //console.log('CHECK: TXmlElementController.delChild() => item.typeof() => [object Array]');
-    } else if (isObject(item)) {
-      return xObj.deleteXObjElement(this.#_host, name);
-    } else {
-      //console.log('CHECK: TXmlElementController.delChild() => item.typeof() => ['+typeof item+']');
-      //console.log('CHECK: TXmlElementController.delChild() => item.value() => ['+item+']');
+  delChild(name){
+    const _name = xObj.evalXObjEName(name);
+    let isSUCCEED = false;
+    if (typeof _name === 'string' && _name !== '') {
+      try {
+        const item = xObj.getXObjElement(this.#_host, name);
+        let isACCEPTED = false;
+        if (isArray(item)) {
+          //console.log('CHECK: TXmlElementController.delChild() => item.typeof() => [object Array]');
+          if (item.length < 2) {
+            isACCEPTED = true;
+          } else {
+            //console.log('CHECK: TXmlElementController.delChild() => item.length() => ['+item.length+']');
+          };
+        } else if (isObject(item)) {
+          isACCEPTED = true;
+        } else {
+          //console.log('CHECK: TXmlElementController.delChild() => item.typeof() => ['+typeof item+']');
+          //console.log('CHECK: TXmlElementController.delChild() => item.value() => ['+item+']');
+        };
+        if (isACCEPTED) isSUCCEED = xObj.deleteXObjElement(this.#_host, name);
+      } catch (err) {
+        // // TODO: [?] verify what error is thrown
+        throw err;
+      };
     };
-    return false;
+    return isSUCCEED;
   }
 
   clear(){
@@ -367,6 +376,28 @@ class TXmlElementController {
     return (item instanceof TXmlElementController) ? item.#_host : null;
   }
 
+  static __setChildRaw(node, name, obj){
+    //console.log('CHECK: TXmlElementController.__setChildRaw() => was called...');
+    let isSUCCEED = false;
+    if (node instanceof TXmlElementController) {
+      let item = null;
+      if (isArray(obj)) {
+        //console.log('CHECK: TXmlElementController.__setChildRaw() => <obj> is array...');
+        item = xObj.insertXObjEList(node.#_host, name, { force: true });
+        // load elements
+        for (let element of obj) {
+          if (isPlainObject(element)) item.push(element);
+        };
+      } else if (isObject(obj)) {
+        //console.log('CHECK: TXmlElementController.__setChildRaw() => <obj> is object...');
+        item = xObj.insertXObjElement(node.#_host, name, { force: true });
+        // // TODO: set element
+      };
+      if (item) isSUCCEED = true;
+    };
+    return isSUCCEED;
+  }
+
   static clear(obj){
     let item = TXmlElementController.__unwrap(obj);
     if (item) {
@@ -660,7 +691,7 @@ class TXmlContentRootElement extends TXmlElementController {
       const entries = Object.keys(obj);
       const len = entries.length;
       if (len === 0) {
-        rootItem = xObj.insertXObjElement(obj, rootETagName, false);
+        rootItem = xObj.insertXObjElement(obj, rootETagName);
       } else {
         const {
           declarationKey,
@@ -692,13 +723,13 @@ class TXmlContentRootElement extends TXmlElementController {
           };
         };
         if (targetKey === '') {
-          rootItem = xObj.insertXObjElement(obj, rootETagName, false);
+          rootItem = xObj.insertXObjElement(obj, rootETagName);
         } else {
           if (autoBindRoot) {
             rootItem = obj[targetKey];
             rootETagName = targetKey;
             if (!isPlainObject(rootItem)) {
-              rootItem = xObj.insertXObjElement(obj, rootETagName, false);
+              rootItem = xObj.insertXObjElement(obj, rootETagName);
             };
           } else {
             throw new TypeError(`TXmlContentRootElement : ${XML_TE_NROOT_EMSG}`);
@@ -706,7 +737,7 @@ class TXmlContentRootElement extends TXmlElementController {
         };
       };
     } else if (!isPlainObject(rootItem)) {
-      rootItem = xObj.insertXObjElement(obj, rootETagName, false);
+      rootItem = xObj.insertXObjElement(obj, rootETagName);
     };
     // init parent class instance
     super(rootItem, _options);
@@ -814,7 +845,7 @@ class TXmlContentContainer {
     try {
       result = xmlParser.js2xml(this.#_content, this.#_parseOptions.js2xml);
     } catch (err) {
-      console.log('CHECK: TXmlContentContainer.saveToXMLString() => Error => '+err);
+      //console.log('CHECK: TXmlContentContainer.saveToXMLString() => Error => '+err);
       //isERR = true;
       throw err;
     };
@@ -844,9 +875,21 @@ class TXmlContentContainer {
           data.errEvent = 'OPS_IS_SUCCEED';
           resolve(data);
         }).catch(err => {
-          console.log('CHECK: TXmlContentContainer.saveToFile() => Error => '+err);
-          console.log('CHECK: TXmlContentContainer.saveToFile() => Error => '+err.code);
-          reject(err);
+          switch (err.code) {
+            case 'ENOENT': {
+              data.isERR = true;
+              data.errEvent = err.code;
+              data.content = '';
+              resolve(data);
+              break;
+            }
+            default: {
+              console.log('CHECK: TXmlContentContainer.saveToFile() => Error => '+err);
+              console.log('CHECK: TXmlContentContainer.saveToFile() => Error => '+err.code);
+              reject(err);
+              break;
+            }
+          };
         });
       };
     });
@@ -870,9 +913,20 @@ class TXmlContentContainer {
         data.content = this.saveToXMLString();
         fs.writeFileSync(data.source, data.content, 'utf8');
       } catch (err) {
-        console.log('CHECK: TXmlContentContainer.saveToFileSync() => Error => '+err);
-        console.log('CHECK: TXmlContentContainer.saveToFileSync() => Error => '+err.code);
-        throw err;
+        switch (err.code) {
+          case 'ENOENT': {
+            data.isERR = true;
+            data.errEvent = err.code;
+            data.content = '';
+            break;
+          }
+          default: {
+            console.log('CHECK: TXmlContentContainer.saveToFileSync() => Error => '+err);
+            console.log('CHECK: TXmlContentContainer.saveToFileSync() => Error => '+err.code);
+            throw err;
+            break;
+          }
+        };
       };
     };
     return data;
@@ -888,8 +942,8 @@ class TXmlContentContainer {
           isSUCCEED = this._bindContent(obj, this.#_options);
         };
       } catch (err) {
-        console.log('CHECK: TXmlContentContainer.loadFromXMLString() => Error => '+err);
-        console.log('CHECK: TXmlContentContainer.loadFromXMLString() => Error => '+err.code);
+        //console.log('CHECK: TXmlContentContainer.loadFromXMLString() => Error => '+err);
+        //console.log('CHECK: TXmlContentContainer.loadFromXMLString() => Error => '+err.code);
         throw err;
       };
     };
@@ -931,16 +985,18 @@ class TXmlContentContainer {
         }).catch(err => {
           switch (err.code) {
             case 'ENOENT':
-            case 'EISDIR':
+            case 'EISDIR': {
               data.isERR = true;
               data.errEvent = err.code;
               resolve(data);
               break;
-            default:
+            }
+            default: {
               console.log('CHECK: TXmlContentContainer.loadFromFile() => Error => '+err);
               console.log('CHECK: TXmlContentContainer.loadFromFile() => Error => '+err.code);
               reject(err);
               break;
+            }
           };
         });
       };
@@ -978,15 +1034,17 @@ class TXmlContentContainer {
       } catch (err) {
         switch (err.code) {
           case 'ENOENT':
-          case 'EISDIR':
-          data.isERR = true;
-          data.errEvent = err.code;
-          break;
-          default:
-          console.log('CHECK: TXmlContentContainer.loadFromFileSync() => Error => '+err);
-          console.log('CHECK: TXmlContentContainer.loadFromFileSync() => Error => '+err.code);
-          throw err;
-          break;
+          case 'EISDIR': {
+            data.isERR = true;
+            data.errEvent = err.code;
+            break;
+          }
+          default: {
+            console.log('CHECK: TXmlContentContainer.loadFromFileSync() => Error => '+err);
+            console.log('CHECK: TXmlContentContainer.loadFromFileSync() => Error => '+err.code);
+            throw err;
+            break;
+          }
         };
       };
     };
@@ -1001,8 +1059,8 @@ class TXmlContentContainer {
 
 // === module exports block ===
 
-exports.DEF_XML_PARSE_OPTIONS = XML_DEF_PARSE_OPTIONS; // will deprecate
-exports.DEF_XML_ROOT_ETAG_NAME = XML_DEF_ROOT_ETAG_NAME; // will deprecate
+//exports.DEF_XML_PARSE_OPTIONS = XML_DEF_PARSE_OPTIONS; // will deprecate
+//exports.DEF_XML_ROOT_ETAG_NAME = XML_DEF_ROOT_ETAG_NAME; // will deprecate
 
 exports.XML_DEF_PARSE_OPTIONS = XML_DEF_PARSE_OPTIONS;
 exports.XML_DEF_ROOT_ETAG_NAME = XML_DEF_ROOT_ETAG_NAME;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntwg/xml-lib-js",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "A library for handling an XML-documents",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -31,7 +31,7 @@
   "dependencies": {
     "@ygracs/bsfoc-lib-js": "^0.1.2",
     "@ygracs/xml-js6": "^0.0.3-b",
-    "@ygracs/xobj-lib-js": "^0.0.14-rc1"
+    "@ygracs/xobj-lib-js": "^0.0.14-rc3"
   },
   "devDependencies": {
     "jest": "^29.4.2"