@ygracs/xobj-lib-js 0.0.14-rc4 → 0.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+#### *v0.1.1*
+
+Release version.
+
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.2.0.
+
+#### *v0.1.0*
+
+Release version.
+
+> - `xObj-lib.md` updated;
+> - change behavior for function: `insertXObjElement`, `insertXObjElements`, `insertXObjEChain`, `insertXObjEList` (***remove deprecated options parameters**. check the package docs*)
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.4.
+
 #### *v0.0.14rc4*
 
 Pre-release version.

package/doc/xObj.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.22|
+>|***rev.*:**|0.1.23|
 >|:---|---:|
->|date:|2023-03-15|
+>|date:|2023-07-30|
 
 ## Intoduction
 
@@ -266,15 +266,17 @@ This function inserts an empty element named by a `name` parameter into a given
 > - `object` parameter is not a plain object (*error code: `ERR_XOBJ_NOBJ`*);
 > - `name` parameter is not a non-empty string.
 
+An `options` parameter contains the following parameters:
+
+|option name|value type|default value|description|
+|:---|---|---:|:---|
+|`force`|`boolean`|`false`|modifies the functions behavior|
+|`ripOldies`|`boolean`|`false`|it prevents a replacement of an element which exists  and has a type of an `object`. Applied only if `force` option is set to `true`|
+
 An `options.force` parameter modifies the functions behavior as follows:
-- if not given it is set to `false`(default value);
 - when set to `true`, the addressed element will be replaced with an empty element.
 - when set to `false`, if the target element exists and is not a type of an `object`, the function will failed.
 
-An `options.ripOldies` parameter applied only if `options.force` is `true`. And if set to `false` (*default value*), it prevents a replacement of an element which exists  and has a type of an `object`.
-
-> NOTE: An `options.rip_oldies` will deprecate. Use `options.ripOldies` instead.
-
 #### **deleteXObjElement(object, name)**
 
 This function deletes an element addressed by `name` parameter from a given object. If succeed `true` is returned.
@@ -307,7 +309,7 @@ A value of the `name` parameter must have some of the following formats:
 4. `<name>[@<attribute>]`;
 5. `<name>[@<attribute>=<value>]`;
 
-> Note: the `<value>` must be quotted if it contains characters like a spaces or square brackets.
+> Note: the `<value>` must be quoted if it contains characters like a spaces or square brackets.
 
 The returned object has following attributes:
 
@@ -331,7 +333,7 @@ This function inserts an elements given by the `names_list` and return quantity
 
 > If an `object` parameter given to the function is not a plain object, the function will throw a `TypeError` exception.
 >
-> The `options` parameter if given must be an object. For details see `insertXObjElement`.
+> The `options` parameter if given must be an object. For details see [`insertXObjElement`](#insertxobjelementobject-name-options).
 
 #### **insertXObjEList(object, name\[, options])**
 
@@ -341,23 +343,25 @@ This function inserts an elements list named by a `name` parameter into a given
 > - `object` parameter is not a plain object;
 > - `name` parameter is not a non-empty string.
 
+An `options` parameter contains the following parameters:
+
+|option name|value type|default value|description|
+|:---|---|---:|:---|
+|`force`|`boolean`|`false`|modifies the functions behavior|
+|`ripOldies`|`boolean`|`false`|it prevents a replacement of an element which exists  and has a type of an `array`. Applied only if `force` option is set to `true`|
+
 An `options.force` parameter modifies the functions behavior as follows:
-- if not given it is set to `false` (*default value*);
 - when set to `true`, the addressed element will be replaced with an empty elements list.
 - when set to `false`, if the target element type is an `object`, the function will wraps it in the list.
 - when set to `false`, if the target element exists and is not a type of an `array` or an `object`, the function will failed.
 
-An `options.ripOldies` parameter applied only if `options.force` is `true`. And if set to `false` (*default value*), it prevents a replacement of an element which exists  and has a type of an `array`.
-
-> NOTE: An `options.rip_oldies` will deprecate. Use `options.ripOldies` instead.
-
 #### **insertXObjEChain(object, names_list\[, options])**
 
 This function inserts a chain of the elements listed by `names_list`. If succeed the last inserted element will be returned or `null` if failed.
 
 > If an `object` parameter given to the function is not a plain object, the function will throw a `TypeError` exception.
 >
-> The `options` parameter if given must be an object. For details see `insertXObjElement`.
+> The `options` parameter if given must be an object. For details see [`insertXObjElement`](#insertxobjelementobject-name-options).
 
 #### **deleteXObjElementEx(object, name)**
 

package/index.js

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

package/lib/xObj-lib.js

@@ -1,4 +1,4 @@
-// [v0.1.056-20230316]
+// [v0.1.059-20230918]
 
 // === module init block ===
 
@@ -212,7 +212,7 @@ function addXObjElement(obj, name){
   };
 };
 
-function insertXObjElement(obj, name, opt = {}){
+function insertXObjElement(obj, name, opt){
   let err = null;
   if (!isPlainObject(obj)) {
     err = new TypeError(XOBJ_TE_NPOBJ_EMSG);
@@ -231,9 +231,8 @@ function insertXObjElement(obj, name, opt = {}){
     throw err;
   };
   const _options = isPlainObject(opt) ? opt : {};
-  let { force, rip_oldies, ripOldies } = _options;
+  let { force, ripOldies } = _options;
   if (typeof force !== 'boolean') force = false;
-  if (ripOldies === undefined) ripOldies = rip_oldies;
   if (typeof ripOldies !== 'boolean') ripOldies = false;
   let prop = obj[key];
   let isACCEPTED = (
@@ -536,10 +535,11 @@ function readXObjParamAsStr(obj, defValue, key){
       }
     };
   };
-  return readAsString(result, defValue, {
+  return readAsString(result, {
     useTrim: false,
     numberToString: true,
     boolToString: true,
+    defValue,
   });
 };
 
@@ -657,10 +657,11 @@ function writeXObjParamEx(obj, value, defValue, key){
       numberToString: true,
       boolToString: true,
     });
-    const _value = readAsString(value, _defValue, {
+    const _value = readAsString(value, {
       useTrim: false,
       numberToString: true,
       boolToString: true,
+      defValue: _defValue,
     });
     try {
       isSUCCEED = writeXObjParamRaw(obj, _value, key);
@@ -752,10 +753,11 @@ function readXObjAttrAsStr(obj, attr, defValue, key){
       }
     };
   };
-  return readAsString(result, defValue, {
+  return readAsString(result, {
     useTrim: true,
     numberToString: true,
     boolToString: true,
+    defValue,
   });
 };
 
@@ -873,10 +875,11 @@ function writeXObjAttrEx(obj, attr, value, defValue, key){
       numberToString: true,
       boolToString: true,
     });
-    const _value = readAsString(value, _defValue, {
+    const _value = readAsString(value, {
       useTrim: true,
       numberToString: true,
       boolToString: true,
+      defValue: _defValue,
     });
     try {
       isSUCCEED = writeXObjAttrRaw(obj, attr, _value, key);
@@ -905,8 +908,8 @@ function insertXObjElements(obj, ...args){
   const hasOpt = len > 0 && isPlainObject(args[len - 1]);
   const opt = hasOpt ? args.pop() : {};
   const names = readAsListS({
-    trim: true,
-    keep_empty: false,
+    useTrim: true,
+    keepEmpty: false,
   }, ...args);
   let count = 0;
   for (let key of names) {
@@ -915,7 +918,7 @@ function insertXObjElements(obj, ...args){
   return count;
 };
 
-function insertXObjEList(obj, name, opt = {}){
+function insertXObjEList(obj, name, opt){
   let err = null;
   if (!isPlainObject(obj)) {
     err = new TypeError(XOBJ_TE_NPOBJ_EMSG);
@@ -934,9 +937,8 @@ function insertXObjEList(obj, name, opt = {}){
     throw err;
   };
   const _options = isPlainObject(opt) ? opt : {};
-  let { force, rip_oldies, ripOldies } = _options;
+  let { force, ripOldies } = _options;
   if (typeof force !== 'boolean') force = false;
-  if (ripOldies === undefined) ripOldies = rip_oldies;
   if (typeof ripOldies !== 'boolean') ripOldies = false;
   let item = obj[key];
   let isACCEPTED = (
@@ -965,8 +967,8 @@ function insertXObjEChain(obj, ...args){
   const hasOpt = len > 0 && isPlainObject(args[len - 1]);
   const opt = hasOpt ? args.pop() : {};
   const names = readAsListS({
-    trim: true,
-    keep_empty: false,
+    useTrim: true,
+    keepEmpty: false,
   }, ...args);
   let curObj = obj;
   let isSUCCEED = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xobj-lib-js",
-  "version": "0.0.14rc4",
+  "version": "0.1.1",
   "description": "A helper library to work with xml-js module",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -27,10 +27,10 @@
     "#lib/*": "./lib/*"
   },
   "dependencies": {
-    "@ygracs/bsfoc-lib-js": "^0.1.3"
+    "@ygracs/bsfoc-lib-js": "^0.2.0"
   },
   "devDependencies": {
-    "jest": "^29.6.1",
+    "jest": "^29.7.0",
     "minimist": "^1.2.8"
   }
 }