dt-toolbox 5.0.0 → 7.0.0

package/Changelog.md

@@ -1,17 +1,23 @@
 ## Release History
 
+### 7.0.0 (2023-07-15)
+- [x] Method `look` has new arguments: functions `next` and `finish`;
+- [x] To stop iteration on current dt-line `return next()`;
+- [x] To stop iteration on all dt-lines `return finish()`;
+- [x] Method `insert` was renamed to `insertSegment`;
+- [x] Method `listSegments` was added to show list of all segments in dt-object;
+- [x] Method `insertSegment` expect the incoming data as dt-object, but if is not - will assume it as a standard javascript object and will convert it to dt-object automatically;
+- [] Method `insertSegment` can recognize a dt model object.
 
-### 5.0.0 ( 2022-11-24)
-- [x] Converting library to ES module;
 
 
-### 4.0.9 ( 2022-11-14)
-- [x] Fix: Corner case with structure building;
-
-
-### 4.0.8 (2022-11-13)
-- [x] Upgrade to version v.3.0.0 of '@peter.naydenov/walk';
-- [ ] Bug: Corner case with structure building;
+### 6.0.0 (2023-05-12)
+- [x] Version 5 is full rethinking of the idea and rewrite from scratch;
+- [x] Simplified API interface;
+- [x] New internal data-model;
+- [x] Multiple data inserts;
+- [x] Predefined and custom filters for faster data scan;
+- [x] Model and query functions to shape the results;
 
 
 
@@ -287,4 +293,3 @@
 
 
 
-

package/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/Migration.guide.md

@@ -1,7 +1,69 @@
 # Migration Guides
 
+## From v.6.x.x  - v.7.x.x
+Look function can return `next` and `finish` functions. This functions are used to control the flow of the "**look**" function. If you `return next()`, the look function will continue to execute callback with next dt-line object. If you `return finish()`, the look function will end. 
 
-## From v.2.x.x. - v.3.x.x
+
+```js
+// was:
+dt.query ( (store) => {
+    store.look ( ({name, flatData, breadcrumbs}) => {
+        if ( flatData.includes('something') ) {
+                // do something
+                // return string 'next' to stop iteration on this dt-line
+                return 'next'
+        }
+    })
+})
+
+// become:
+dt.query ( (store) => {
+    store.look ( ({name, flatData, breadcrumbs, next, finish}) => {
+        if ( flatData.includes('something') ) {
+                // do something
+                // return `next()` to stop iteration on current dt-line
+                return next ()
+                // return `finish()` to stop iteration on all dt-lines (it's a new option)
+        }
+    })
+})
+
+```
+
+Method `insert` was renamed to `insertSegment` to be clear that data is not mixed. Segments are separated peaces of data.
+
+```js 
+// before
+  const dt = dtbox.init ( a );
+  dt.insert ( 'specificDataName' b ) // b is a dt-object
+
+// after
+  const dt = dtbox.init ( a );
+  dt.insertSegment ( 'specificDataName' b ) // b is a dt-object
+// it's possible to insert a standard js object but it's not recomended
+// dt.insertSegment ( 'specialDataName', a )  // a is a standard js object
+// also possible to insert a dt model object directly
+// dt.insertSegment ( 'specialDataName', c )  // Where c = b.export(). A dt model object. 
+```
+
+Method `listSegments` was added to show list of all segments in dt-object.
+
+
+
+## From v.4.x.x  - v.6.x.x
+
+The library "dt-toolbox" exist for a full 7 years and now version 6 is coming as full rewrite of the original idea. Difference are more then similarity and better aproach is to read a version 6 documentation first. Then you will find that:
+
+ - Data creation is very simular;
+ - Dt-Object becomes a storage and you can add more data to it;
+ - Dt-Object data will stay always immutable;
+ - For extracting data you can use 'query' and 'model' functions;
+ - For speed up a data evaluation dt-object has a dynamic filters;
+ - Import and export data-models from the previous version are available;
+
+
+
+## From v.2.x.x. - v.3.x.x (v.4.x.x )
 
 Upgrade to version 3 of the library will require some code changes.