@cntwg/xml-lib-js 0.0.23 → 0.0.24

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+#### *v0.0.24*
+
+Pre-release version.
+
+> - `xmldoc-lib.md` updated;
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.4;
+> - updated dependency on `@ygracs/xobj-lib-js` module to v0.1.0;
+> - some fixes in `xmldoc-lib.js` module.
+
 #### *v0.0.23*
 
 Pre-release version.

package/README.md

@@ -1,11 +1,21 @@
-|***rev.*:**|0.1.2|
+|***rev.*:**|0.1.3|
 |:---|---:|
-|***date***:|2022-09-06|
+|***date***:|2023-07-31|
 
 ## Introduction
 
 This module provide a base functionality for handling an XML-documents.
 
+## Use cases
+
+### Installation
+
+`npm install @cntwg/xml-lib-js`
+
+## Description
+
+This module contains the following components:
+
 ### 1. xObj-manipulator
 
 xObj-manipulator is a set of functions (see docs for [`@ygracs/xobj-lib-js` module](https://gitlab.com/ygracs/xobj-lib-js)).

package/doc/xmldoc-lib.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.20|
+>|***rev.*:**|0.1.21|
 >|:---|---:|
->|date:|2023-03-01|
+>|date:|2023-07-31|
 
 ## Introduction
 
@@ -37,11 +37,13 @@ The settings listed in the table below:
 |`trim`|`boolean`|`true`|
 |`spaces`|`number`|`2`|
 
+> WARNING: The constant `DEF\_XML\_PARSE\_OPTIONS` will be deprecated. Use `XML\_DEF\_PARSE\_OPTIONS` instead.
+
 ### **DEF\_XML\_ROOT\_ETAG_NAME** or **XML\_DEF\_ROOT\_ETAG_NAME**
 
 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.
+> WARNING: The constant `DEF\_XML\_ROOT\_ETAG_NAME` is deprecate. Use `XML\_DEF\_ROOT\_ETAG_NAME` instead.
 
 ## Module classes
 
@@ -305,6 +307,12 @@ This method deletes an element addressed by `index`. If succeed `true` is return
 
 This method loaded a list of elements listed by `items` and returns a quantity of a successfully added elements.
 
+The `options` structure is listed below:
+
+|option name|value type|default value|description|
+|:---|---|---:|:---|
+|`useClear`|`boolean`|`true`|if `true` the method deletes all the previous content before load the list|
+
 #### class methods (*special*)
 
 ##### **_getItemRaw(name)**
@@ -461,3 +469,5 @@ This method returns a document content as a string in the JSON-format.
 ##### **_bindContent(obj\[, options])**
 
 This method binds a given object as a document content.
+
+For `options` parameter details see the class constractor description.

package/index.js

@@ -1,4 +1,4 @@
-// [v0.1.009-20230316]
+// [v0.1.010-20230731]
 
 // === module init block ===
 

package/lib/xmldoc-lib.js

@@ -1,4 +1,4 @@
-// [v0.1.066-20230317]
+// [v0.1.067-20230731]
 
 // === module init block ===
 
@@ -584,11 +584,14 @@ class TXmlElementsListController {
   }
 
   loadItems(items, opt){
-    let act_as_new = true;
-    if (isPlainObject(opt)) {
-      act_as_new = readAsBool(opt.load_as_new, act_as_new);
-    };
-    if (act_as_new) this.clear();
+    const _options = isPlainObject(opt) ? opt : {};
+    let {
+      useClear,
+      load_as_new,
+    } = _options;
+    if (useClear === undefined) useClear = load_as_new;
+    if (typeof useClear !== 'boolean') useClear = true;
+    if (useClear) this.clear();
     let count = this.count;
     valueToArray(items).forEach((item) => { this.addItem(item); });
     return this.count - count;
@@ -609,11 +612,11 @@ class TXmlContentDeclaration {
     // load options
     let _options = isPlainObject(opt) ? opt : {};
     // set parser options
-    let { parseOptions: parseOptions } = _options;
+    let { parseOptions } = _options;
     if (!isPlainObject(parseOptions)) {
       _options.parseOptions = parseOptions = {};
     };
-    let { settings: settings } = parseOptions;
+    let { settings } = parseOptions;
     if (!isPlainObject(settings)) parseOptions.settings = settings = {};
     let { declarationKey } = settings;
     if (
@@ -1059,9 +1062,6 @@ 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.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.23",
+  "version": "0.0.24",
   "description": "A library for handling an XML-documents",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -32,9 +32,9 @@
     "#lib/*": "./lib/*"
   },
   "dependencies": {
-    "@ygracs/bsfoc-lib-js": "^0.1.3",
+    "@ygracs/bsfoc-lib-js": "^0.1.4",
     "@ygracs/xml-js6": "^0.0.3-b",
-    "@ygracs/xobj-lib-js": "^0.0.14-rc4"
+    "@ygracs/xobj-lib-js": "^0.1.0"
   },
   "devDependencies": {
     "jest": "^29.6.1",