@cntwg/xml-lib-js 0.0.19 → 0.0.20

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+#### *v0.0.20*
+
+Pre-release version.
+
+> - `xmldoc-lib.md` updated;
+> - changed behavior of `TXmlAttributesMapper` class constructor: if `obj` parameter is not an object, the `TypeError` will be thrown;
+> - some fixes in `xmldoc-lib.js` module.
+
 #### *v0.0.19*
 
 Pre-release version.

package/doc/xmldoc-lib.md

@@ -1,8 +1,8 @@
->|***rev.*:**|0.1.18|
+>|***rev.*:**|0.1.19|
 >|:---|---:|
->|date:|2022-09-06|
+>|date:|2023-02-14|
 
-## Intoduction
+## Introduction
 
 This paper describes a constants and an object classes provided by `xmldoc-lib.js` module.
 
@@ -41,6 +41,8 @@ The settings listed in the table below:
 
 This constant defines a default value for naming the root element for XML-document. Its value is `root`.
 
+> WARNING: The constant `DEF\_XML\_ROOT\_ETAG_NAME` will be deprecated. Use `XML\_DEF\_ROOT\_ETAG_NAME` instead.
+
 ## Module classes
 
 ### **TXmlContentParseOptions**
@@ -91,6 +93,8 @@ The `options` structure is listed below:
 |:---|---|---:|:---|
 |`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (*see description for `XML_DEF_PARSE_OPTIONS`*)|
 
+> NOTE: if `object` parameter is not a plain object the `TypeError` thrown.
+
 #### class properties
 
 |name|read only|description|
@@ -295,7 +299,7 @@ This method deletes an element addressed by `index`. If succeed `true` is return
 
 ##### **loadItems(items, options)**
 
-This method loaded a list of elements listed by `items` and returns a quantity of a successfuly added elements.
+This method loaded a list of elements listed by `items` and returns a quantity of a successfully added elements.
 
 #### class methods (*special*)
 
@@ -382,7 +386,7 @@ The `options` structure is listed below:
 
 This method returns a host for an element as an object. If failed `null` is returned.
 
-The `options` parameter, if given, change a behavoir for the method. If set to 'true' the given instance checks aganst inheritance from a `TXmlContentRootElement`, if else, from a `TXmlElementController` class.
+The `options` parameter, if given, change a behavior for the method. If set to 'true' the given instance checks against inheritance from a `TXmlContentRootElement`, if else, from a `TXmlElementController` class.
 
 #### class methods (*special*)
 

package/lib/xmldoc-lib.js

@@ -1,4 +1,4 @@
-// [v0.1.048-20220908]
+// [v0.1.053-20230214]
 
 // === module init block ===
 
@@ -36,16 +36,17 @@ class TXmlAttributesMapper {
 
   constructor(obj, opt){
     // init an elements content
-    this.#_host = isPlainObject(obj) ? obj : {};
+    if (!isPlainObject(obj)) throw new TypeError(XML_TE_NOBJ_EMSG);
+    this.#_host = obj;
     // load options
-    let _options = (
-      isPlainObject(opt) && isPlainObject(opt.parseOptions)
-      ? opt.parseOptions
-      : {}
-    );
-    let { settings: _settings } = _options;
-    if (!isPlainObject(_settings)) _options.settings = _settings = {};
-    let { attributesKey } = _settings;
+    const _options = isPlainObject(opt) ? opt : {};
+    let { parseOptions } = _options;
+    if (!isPlainObject(parseOptions)) {
+      _options.parseOptions = parseOptions = {};
+    };
+    let { settings } = parseOptions;
+    if (!isPlainObject(settings)) parseOptions.settings = settings = {};
+    let { attributesKey } = settings;
     if (
       typeof attributesKey !== 'string'
       || ((attributesKey = attributesKey.trim()) === '')
@@ -53,8 +54,8 @@ class TXmlAttributesMapper {
       attributesKey = XML_DEF_PARSE_OPTIONS.attributesKey;
     };
     // save options
-    _settings.attributesKey = attributesKey;
-    this.#_options = _options;
+    settings.attributesKey = attributesKey;
+    this.#_options = parseOptions;
   }
 
   get entries(){
@@ -66,48 +67,49 @@ class TXmlAttributesMapper {
   }
 
   hasAttribute(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return false;
+    let result = false;
+    try {
+      result = xObj.checkXObjAttribute(
+        this.#_host,
+        value,
+        this.#_options.settings.attributesKey,
+      );
+    } catch (err) {
+      // // TODO: verify what error is thrown
+      result = false;
     };
-    // // TODO: await implementation for class method provided by xObj
-    let item = xObj.getXObjAttributes(
-      this.#_host,
-      this.#_options.settings.attributesKey,
-    );
-    return isPlainObject(item) && item[name] !== undefined;
+    return result;
   }
 
   getAttribute(value){
-    let name = '';
-    if (
-      typeof value !== 'string' || ((name = value.trim()) === '')
-    ) {
-      return '';
+    let result = '';
+    try {
+      result = xObj.readXObjAttr(
+        this.#_host,
+        value,
+        this.#_options.settings.attributesKey,
+      );
+    } catch (err) {
+      // // TODO: verify what error is thrown
+      result = '';
     };
-    return xObj.readXObjAttr(
-      this.#_host,
-      name,
-      this.#_options.settings.attributesKey,
-    );
+    return result;
   }
 
-  setAttribute(attr, value){
-    let name = '';
-    if (
-      typeof attr !== 'string' || ((name = attr.trim()) === '')
-      || value === undefined
-    ) {
-      return false;
+  setAttribute(name, value){
+    let result = false;
+    try {
+      result = xObj.writeXObjAttr(
+        this.#_host,
+        name,
+        value,
+        this.#_options.settings.attributesKey,
+      );
+    } catch (err) {
+      // // TODO: verify what error is thrown
+      result = false;
     };
-    return xObj.writeXObjAttr(
-      this.#_host,
-      name,
-      value,
-      this.#_options.settings.attributesKey,
-    );
+    return result;
   }
 
   delAttribute(value){
@@ -136,7 +138,7 @@ class TXmlAttributesMapper {
       this.#_options.settings.attributesKey,
       {
         force: true,
-        rip_oldies: true,
+        ripOldies: true,
       },
     );
   }
@@ -153,9 +155,12 @@ class TXmlElementController {
   constructor(obj, opt){
     // load options
     let _options = isPlainObject(opt) ? opt : {};
-    let { proxyModeEnable } = _options;
+    let {
+      proxyModeEnable,
+      parseOptions,
+    } = _options;
     if (typeof proxyModeEnable !== 'boolean') proxyModeEnable = false;
-    // init an elements content
+    // init an element content
     if (isObject(obj)) {
       if (isArray(obj)) return new TXmlElementsListController(obj, opt);
       // // TODO: split a plain object and class instances
@@ -169,18 +174,21 @@ class TXmlElementController {
       this.#_host = {};
     };
     // set parser options
-    let { parseOptions: _parseOptions } = _options;
-    if (!isPlainObject(_parseOptions)) {
-      _options.parseOptions = _parseOptions = {};
+    if (!isPlainObject(parseOptions)) {
+      _options.parseOptions = parseOptions = {};
     };
-    let { settings: _settings } = _parseOptions;
-    if (!isPlainObject(_settings)) {
-      _parseOptions.settings = _settings = {};
-      // // TODO: set defaults
+    let { settings } = parseOptions;
+    if (!isPlainObject(settings)) parseOptions.settings = settings = {};
+    let { textKey } = settings;
+    if (
+      typeof textKey !== 'string'
+      || ((textKey = textKey.trim()) === '')
+    ) {
+      textKey = XML_DEF_PARSE_OPTIONS.textKey;
     };
-    // save parser options
-    this.#_parseOptions = _parseOptions;
     // save options
+    settings.textKey = textKey;
+    this.#_parseOptions = parseOptions;
     _options.proxyModeEnable = proxyModeEnable;
     this.#_options = _options;
     // bind atributes mapper
@@ -379,17 +387,19 @@ class TXmlElementsListController {
   constructor(obj, opt){
     // load options
     let _options = isPlainObject(opt) ? opt : {};
-    let { proxyModeEnable, isNullItemsAllowed } = _options;
+    let {
+      proxyModeEnable,
+      isNullItemsAllowed,
+      parseOptions,
+    } = _options;
     if (typeof proxyModeEnable !== 'boolean') proxyModeEnable = false;
     if (typeof isNullItemsAllowed !== 'boolean') isNullItemsAllowed = false;
     // set parser options
-    let { parseOptions: _parseOptions } = _options;
-    if (!isPlainObject(_parseOptions)) _parseOptions = {};
-    let { settings: _settings } = _parseOptions;
-    if (!isPlainObject(_settings)) {
-      _parseOptions.settings = _settings = {};
-      // // TODO: set defaults
+    if (!isPlainObject(parseOptions)) {
+      _options.parseOptions = parseOptions = {};
     };
+    let { settings } = parseOptions;
+    if (!isPlainObject(settings)) parseOptions.settings = settings = {};
     // init an elements list content
     if (isArray(obj)) {
       this.#_host = obj;
@@ -403,8 +413,6 @@ class TXmlElementsListController {
         this.#_host = [];
       };
     };
-    // save parser options
-    _options.parseOptions = _parseOptions;
     // save options
     _options.proxyModeEnable = proxyModeEnable;
     _options.isNullItemsAllowed = isNullItemsAllowed;
@@ -570,21 +578,20 @@ class TXmlContentDeclaration {
     // load options
     let _options = isPlainObject(opt) ? opt : {};
     // set parser options
-    let { parseOptions: _parseOptions } = _options;
-    if (!isPlainObject(_parseOptions)) _parseOptions = {};
-    let { settings: _settings } = _parseOptions;
-    if (!isPlainObject(_settings)) _parseOptions.settings = _settings = {};
-    let { declarationKey } = _settings;
+    let { parseOptions: parseOptions } = _options;
+    if (!isPlainObject(parseOptions)) {
+      _options.parseOptions = parseOptions = {};
+    };
+    let { settings: settings } = parseOptions;
+    if (!isPlainObject(settings)) parseOptions.settings = settings = {};
+    let { declarationKey } = settings;
     if (
       typeof declarationKey !== 'string'
       || ((declarationKey = declarationKey.trim()) === '')
     ) {
       declarationKey = XML_DEF_PARSE_OPTIONS.declarationKey;
+      settings.declarationKey = declarationKey;
     };
-    // // TODO: set defaults
-    // save parser options
-    _options.parseOptions = _parseOptions;
-    _settings.declarationKey = declarationKey;
     // save options
     this.#_options = _options;
     // bind a documents content
@@ -610,13 +617,13 @@ class TXmlContentDeclaration {
   }
 
   init(){
-    let _options = this.#_options;
+    const _options = this.#_options;
     this.#_ctrls = new TXmlElementController(
       xObj.insertXObjElement(
         this.#_host,
         _options.parseOptions.settings.declarationKey,
       ),
-      this._options,
+      _options,
     );
     // // TODO: set version & encoding
     if (!isNotEmptyString(this.version)) this.version = '1.0';
@@ -725,19 +732,6 @@ class TXmlContentRootElement extends TXmlElementController {
     ) ? value : XML_DEF_ROOT_ETAG_NAME;
   }
 
-  //* will deprecate */
-  /*init(name){
-    //console.log('CHECK: TXmlContentRootElement.init() => was called...');
-    //console.log('CHECK: TXmlContentRootElement.init() => (*1) name:['+name+']');
-    let _options = this.#_options;
-    name = readAsString(name, _options.rootETagName, true);
-    // // TODO: check if name is valid
-    //console.log('CHECK: TXmlContentRootElement.init() => (*2)  name:['+name+']');
-    if (!isPlainObject(this.#_content[name])) this.#_content[name] = {};
-    this.#_ctrls = new TXmlElementController(this.#_content[name], _options);
-    //console.log('CHECK: TXmlContentRootElement.init() => was left...');
-  }*/
-
   static __unwrap(item, opt){
     return (
       item instanceof TXmlContentRootElement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntwg/xml-lib-js",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "A library for handling an XML-documents",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -34,6 +34,6 @@
     "@ygracs/xobj-lib-js": "^0.0.14-rc1"
   },
   "devDependencies": {
-    "jest": "^27.5.1"
+    "jest": "^29.4.2"
   }
 }