dt-toolbox 7.1.2 → 7.2.0

package/Changelog.md

@@ -1,13 +1,28 @@
 ## Release History
 
+
+### 7.2.0 (2023-09-18)
+- [x] Convertors recognize HTML DOM nodes. Makes a copy by reference;
+- [x] Convertors recognize functions. Makes a copy by reference;
+- [x] Model 'files' is not possible for functions and DOM nodes, so the value in the result will be string. For functions will be `function:functionName` and for DOM nodes will be `htmlElement:elementName`;
+
+
+
+### 7.1.3 (2023-09-14)
+- [x] Fix: extractList: Negative value is treated as property does not exist and returns null instead of real value;
+
+
+
 ### 7.1.2 (2023-09-12)
 - [x] Fix: Dt-Storage method 'from' is not filtering the list if requested 'breadcrumbs' does not exist;
+- [ ] Bug: extractList: Negative value is treated as property does not exist and returns null instead of real value;
 
 
 
 ### 7.1.1 (2023-09-05 )
 - [x] Fix: Multiple queries in same programming scope;
 - [ ] Bug: Dt-Storage method 'from' is not filtering the list if requested 'breadcrumbs' does not exist;
+- [ ] Bug: extractList: Negative value is treated as property does not exist and returns null instead of real value;
 
 
 

package/README.md

@@ -13,7 +13,8 @@ After version 7.1.x `dt-object` api has a new method `extractList` that helps to
 
 ## Description
 
-DT-Toolbox is created to simplify the work with deep nested javascript objects. The library was created as an immutable data-storage(dt-object), internally based on data-model called `DT-model`.
+DT-Toolbox is a tool, created to simplify the work with deep nested javascript objects. 
+The library creates an immutable data-storage(dt-object). Storage data representation is based on data-model called `DT-model`.
 
  ## What is DT-model?
 It's an internal 'dt-object' data description. Data is an array of lines where each line has 4 components:
@@ -26,12 +27,21 @@ It's an internal 'dt-object' data description. Data is an array of lines where e
 // Where ->
 // name: string. Name of the dt-line;
 // flatData:  object or array of primitive types;
-// breadcrumbs: string. Bredcrumbs description of the current dt-line;
-// edges: string[]. List of breadcrumbs of the related dt-lines;
+// breadcrumbs: string. Bredcrumbs description(identifier) of the current dt-line;
+// edges: string[]. List of breadcrumbs of the related dt-lines(children);
 ```
 
 This data-description is easy to read, saved, or transfered.
 
+DT-model can become a storage for multiple data blocks - `data-segments`. Each data-segment can be extracted but also can be queried and modeled together with other data-segments in a way to create a new dt-object.
+
+Concept `state` - A specific shape of DT-model where all primitive states are stored in 'root' object and the other states as separated data-segments. Root data-segment is a flat object (single row without edges).
+
+There is a library [@peter.naydenov/dt-queries](https://github.com/PeterNaydenov/dt-queries) that contains query functions that can be useful with data manipulation:
+- splitSegments: Splits a solid data into multiple data-segments;
+- joinSegments : Consolidate multiple data-segments in a single solid data;
+- updateState  : Updates the state with new data. Takes only declared data-segments and root data properties;
+
 
 ## Installation
 Install for node.js projects by writing in your terminal:
@@ -52,7 +62,7 @@ import dtbox from 'dt-toolbox'
 Use Dt-toolbox methods(init and load) to create a `dt-object`. 
 
 DT-object:
-- Provides multiple insertion of data segments. Data from each insertion stays differentiated;
+- Provides multiple insertion of data-segments. Data from each insertion stays differentiated;
 - Has prebuilded filters for fast search of data;
 - Can create and register a customized filters for fast search of data;
 - Can apply `query functions` to find, extract and reshape the data;
@@ -1174,9 +1184,9 @@ console.log ( result )
 
 
 ## External Links
+- [DT-Queries. Some useful query functions for DT-Toolbox](https://github.com/PeterNaydenov/dt-queries)
 - [History of changes](https://github.com/PeterNaydenov/dt-toolbox/blob/master/Changelog.md)
 - [Migration guide](https://github.com/PeterNaydenov/dt-toolbox/blob/master/Migration.guide.md)
-- [DT-Queries. Some useful query functions for DT-Toolbox](https://github.com/PeterNaydenov/dt-queries)
 - [Documentation v.4.x.x](https://github.com/PeterNaydenov/dt-toolbox/blob/master/README_v.4.x.x.md)
 - [Documentation v.2.x.x](https://github.com/PeterNaydenov/dt-toolbox/blob/master/README_v.2.x.x.md)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dt-toolbox",
   "description": "Data manipulation tool",
-  "version": "7.1.2",
+  "version": "7.2.0",
   "license": "MIT",
   "author": "Peter Naydenov",
   "keywords": [
@@ -28,7 +28,7 @@
   },
   "homepage": "https://github.com/PeterNaydenov/dt-toolbox#readme",
   "dependencies": {
-    "@peter.naydenov/walk": "4.0.0"
+    "@peter.naydenov/walk": "4.1.0"
   },
   "devDependencies": {
     "c8": "^8.0.1",

package/src/convertors/index.js

@@ -65,7 +65,11 @@ function to ( type, dependencies, inData ) {   // convert from flat to 'data-typ
                             return tuples.toType ( inData )
             case 'files':
                            tups = tuples.toType ( inData );
-                           return tups.map ( ([k,v]) =>  (( k === 'root' ) ? v : `${k}/${v}`)   )
+                           return tups.map ( ([k,v]) => { 
+                                            if ( typeof v === 'function' )   return `${k}/function:${v.name}`
+                                            if ( v?.nodeType )               return `${k}/HtmlElement:${v.tagName? v.tagName.toLowerCase() : 'notSpecified'}`
+                                            return (( k === 'root' ) ? v : `${k}/${v}`)   
+                                        })
             case 'breadcrumb' :
             case 'breadcrumbs':
                            let current;

package/src/flatObject/extractList.js

@@ -3,33 +3,32 @@
 
 
 function extractList ( dependencies, flatIO, indexFn ) {
-return function exportList ( list, options={} ) {
+return function extractList ( list, options ) {
             const 
                       root     = indexFn ( 'root' )
-                    , { main:{load} } = dependencies ()
-                    , possibleAs = ['standard', 'std', 'midFlat', 'tuple', 'tuples', 'breadcrumb', 'breadcrumbs', 'files', 'file' ]
+                    , { main:{load}, INIT_DATA_TYPES } = dependencies ()
                     ;
             let 
                   error = false
                 , errorMsg = ''
                 ;
-
+                
             if ( options ) {
                     if ( !options.as ) {
                             error = true
                             errorMsg = `Options should be an object and property "as" is required`
                         }
-                    if ( !error && !possibleAs.includes(options.as) ) {  
+                    if ( !error && !INIT_DATA_TYPES.includes(options.as) ) {  
                             error = true
                             errorMsg = `Invalid option "as" value: ${options.as}. Choose one of: std, standard, ''`
                         }
-                    if ( error )  throw new Error ( `Invalid option "as" value: ${options.as}` )
+                    if ( error )  throw new Error ( errorMsg )
                 }
 
             return list
                         .map ( name => {
                                             let lines = flatIO.export ( name );
-                                            if ( lines.length === 0 )  return root[1][name] ? root[1][name] : null
+                                            if ( lines.length === 0 )  return root[1].hasOwnProperty(name) ? root[1][name] : null
                                             else                       return lines
                                         })
                         .map ( item => {

package/src/flatObject/index.js

@@ -38,9 +38,9 @@ function flatObject ( dependencies, d ) {
                 }
             ;
 
-        function index (n) {
+        function index ( n ) {
                         if ( n == null )   return null
-                        let r  = flatIO.getLine(n)
+                        let r  = flatIO.getLine ( n )
                         if ( r ) {
                               let [ name, d, breadcrumbs, links ] = r;
                               let copy;