@peter.naydenov/cuts 1.6.0 → 2.0.1

package/Changelog.md

@@ -1,12 +1,20 @@
 # Release History
 
 
-## 1.6.0 ( 2025-10-?? )
+
+## 2.0.1 ( 2026-03-24 )
+- [x] Dev dependency update. Typescript - v.6.0.2;
+- [x] Rebuild types according the new version of typescript;
+
+
+
+## 2.0.0 ( 2025-11-09 )
 - [x] All 'cuts' errors goes to '@app-error' event;
 - [x] Configuration 'logLevel' default value is 1. If you want to dissable errors logging, set 'logLevel' to 0;
 - [x] Code cleaning. Removing unused code;
 - [x] Test code coverage on 85%;
 - [x] Fix: SSR option for first scene loading;
+- [x] Shortcuts version 4.0.0. New shortcut plugins - 'scroll' and 'hover';
 
 
 

package/Migration.guide.md

@@ -1 +1,94 @@
 # Migration Guides
+
+## From version 1.x.x to version 2.x.x
+
+Cuts v2.0.0 upgrades to `@peter.naydenov/shortcuts` version 4.x.x. This introduces breaking changes in how click and hover target attributes are configured, and adds new 'Hover' and 'Scroll' plugins.
+
+### Plugin Target Attributes Changes
+
+**Breaking Changes:**
+- Plugin `click` parameter `clickTarget` now accepts an **array of attribute names** instead of a single string
+- Plugin `hover` parameter `hoverTarget` now accepts an **array of attribute names** instead of a single string
+
+**Migration Required:**
+
+```js
+// Version 1.x.x (old)
+script.enablePlugin(pluginClick, { clickTarget: 'data-button' })
+script.enablePlugin(pluginHover, { hoverTarget: 'data-menu' })
+
+// Version 2.x.x (new)
+script.enablePlugin(pluginClick, { clickTarget: ['data-button'] })
+script.enablePlugin(pluginHover, { hoverTarget: ['data-menu'] })
+```
+
+**Default Values Updated:**
+- `clickTarget` default: `['data-click', 'href']` (was `'data-click'`)
+- `hoverTarget` default: `['data-hover']` (was `'data-hover'`)
+
+**Benefits:**
+- More flexible target detection
+- Support for multiple attribute patterns
+- Better compatibility with existing HTML patterns
+
+### Per-Context Setup Examples Updated
+
+All setup examples in the documentation have been updated to use arrays:
+
+```js
+// Version 2.x.x per-context setup
+const shortcutDefinition = {
+    myContext: {
+        'click:setup': () => ({
+            clickTarget: ['data-action', 'data-button', 'href'] // Array format
+        }),
+        'hover:setup': () => ({
+            hoverTarget: ['data-interactive', 'data-hover'] // Array format
+        })
+    }
+};
+```
+
+### Package Dependencies Update
+
+Update your `package.json`:
+
+```json
+{
+  "dependencies": {
+    "@peter.naydenov/cuts": "^2.0.0",
+    "@peter.naydenov/shortcuts": "^4.0.0"
+  }
+}
+```
+
+### Backward Compatibility
+
+No other breaking changes were introduced. All existing cuts API methods remain the same:
+- `script.show()`
+- `script.hide()`
+- `script.jump()`
+- `script.jumpBack()`
+- `script.setScenes()`
+- `script.listShortcuts()`
+- etc.
+
+### Example Migration
+
+**Before (v1.x.x):**
+```js
+import cuts from '@peter.naydenov/cuts'
+
+const script = cuts()
+await script.loadPlugins(['Click'])
+script.enablePlugin(pluginClick, { clickTarget: 'data-action' })
+```
+
+**After (v2.x.x):**
+```js
+import cuts from '@peter.naydenov/cuts'
+
+const script = cuts()
+await script.loadPlugins(['Click'])
+script.enablePlugin(pluginClick, { clickTarget: ['data-action'] })
+```

package/README.md

@@ -1,3 +1,7 @@
+<img src="cuts.png" width="100%" alt="Cuts" align="center" />
+
+
+
 # Cuts (@peter.naydenov/cuts)
 
 ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/peterNaydenov/cuts/main)
@@ -5,11 +9,22 @@
 ![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/%40peter.naydenov%2Fcuts)
 
 
-In filmmaking, a change of scene is typically referred to as a "**cut**". Cuts are an essential part of film editing and are used to create a cohesive narrative by connecting different scenes together.
+`An abstract idea of a cut`: In filmmaking, a change of scene is typically referred to as a "**cut**". Cuts are an essential part of film editing and are used to create a cohesive narrative by connecting different scenes together.
+
+## Description
+Let's define SPA application as a set of scenes (context/visual states) and each scene discribes a visual elements on the page and possible user interaction ( mouse, keyboard, scroll, hover, etc.). **Cuts** controls the flow among scenes in SPA application.
+
+Behaviour description is based on '[@peter.naydenov/shortcuts](https://github.com/PeterNaydenov/shortcuts)' and every scene is a different shortcuts context.
 
-Let's define SPA application as a set of scenes (pages/visual states) and each scene discribes a visual elements on the page and possible user interaction ( mouse, keyboard, etc.). **Cuts** controls the flow among scenes in SPA application.
 
-When all interactions can be described in the **Scene** data models, means that the components (react,vue, svelte or any other framework) can be used as simple template engines - to render only html.
+
+## Why Cuts?
+ - SPA as a set of many scenes: Every scene can be developed and tested separately;
+ - Easy for reshape the flow of the application;
+ - Many developers can work toghether on the same project without conflicts;
+ - User interaction is easy to read and solve some problems of native DOM events;
+ - As user interaction is defined separately from the html markup, you have large choice of frameworks and template engines (react, vue, svelte, [morph](https://github.com/PeterNaydenov/morph), mustache, handlebars, etc.) to build your application visually;
+ - As user interaction is defined separately, visual components can be reused many times with different user interaction on each reuse;
 
 
 
@@ -51,10 +66,10 @@ script.show ({ scene : 'sceneName'}) // change the current Scene
 , jumpsReset      : 'Reset the jump stack'
 , listScenes      : 'List of loaded Scene names'
 , listShortcuts   : 'List shortcuts per Scene. Provide the name of the Scene'
-, setDependencies : 'Add object to the "dependencies" object. This object will be passed to the Scene "show" method'
+, setDependencies : 'Add object to the "dependencies" object. This object will be passed to the Scene "show" and "hide" methods and events descriptors'
 , getDependencies : 'Returns the "dependencies" object'
-, enablePlugin    : 'Enable a shortcut plugin. Available after version 1.1.0'
-, disablePlugin   : 'Disable a shortcut plugin. Available after version 1.1.0'
+, enablePlugin    : 'Enable a shortcut plugin.' 
+, disablePlugin   : 'Disable a shortcut plugin.'
 , getState        : 'Get the current state of the application'
 , emit            : 'Emit an event'
 ```
@@ -110,10 +125,39 @@ script.jumpBack ({hops:2}) // Will load scene from the jump stack. Will load 'te
 
 
 
+## Plugin Configuration
+
+Shortcuts has a plugin system. To load them, use the `loadPlugins` method.
+
+```js
+import cuts from '@peter.naydenov/cuts'
+
+const 
+     script = cuts ()
+   , [ pluginClick, pluginHover] = await script.loadPlugins(['Click', 'Hover'])
+   ;
+
+// Enable click plugin
+script.enablePlugin ( pluginClick )
+
+// Enable hover plugin 
+script.enablePlugin ( pluginHover )
+```
+
+
+**Available Plugins in v4.x.x:**
+- **Key**: Keyboard shortcuts
+- **Click**: Mouse click events  
+- **Form**: Form input events
+- **Hover**: Mouse hover events (new in v4.0.0)
+- **Scroll**: Scroll events (new in v4.0.0)
+
+
+
 ## Links
+- [Shortcuts documentation - @peter.naydenov/shortcuts](https://github.com/PeterNaydenov/shortcuts)
 - [History of changes](https://github.com/PeterNaydenov/cuts/blob/main/Changelog.md)
-- [Learn how shortcuts are implemented](https://github.com/PeterNaydenov/shortcuts)
-
+- [Migration Guide](https://github.com/PeterNaydenov/cuts/blob/main/Migration.guide.md)
 
 
 

package/coverage/lcov-report/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/lcov-report/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selector that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);

package/coverage/lcov-report/index.html

@@ -0,0 +1,131 @@
+
+<!doctype html>
+<html lang="en">
+
+<head>
+    <title>Code coverage report for All files</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="prettify.css" />
+    <link rel="stylesheet" href="base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+    
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1>All files</h1>
+        <div class='clearfix'>
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">85.71% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>198/231</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">80% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>60/75</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">75.51% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>37/49</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">88.38% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>175/198</span>
+            </div>
+        
+            
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <div class="pad1">
+<table class="coverage-summary">
+<thead>
+<tr>
+   <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
+   <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
+   <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
+   <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
+   <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
+   <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
+   <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
+</tr>
+</thead>
+<tbody><tr>
+	<td class="file high" data-value="src"><a href="src/index.html">src</a></td>
+	<td data-value="93.33" class="pic high">
+	<div class="chart"><div class="cover-fill" style="width: 93%"></div><div class="cover-empty" style="width: 7%"></div></div>
+	</td>
+	<td data-value="93.33" class="pct high">93.33%</td>
+	<td data-value="105" class="abs high">98/105</td>
+	<td data-value="95.23" class="pct high">95.23%</td>
+	<td data-value="21" class="abs high">20/21</td>
+	<td data-value="72" class="pct medium">72%</td>
+	<td data-value="25" class="abs medium">18/25</td>
+	<td data-value="100" class="pct high">100%</td>
+	<td data-value="83" class="abs high">83/83</td>
+	</tr>
+
+<tr>
+	<td class="file medium" data-value="src/methods"><a href="src/methods/index.html">src/methods</a></td>
+	<td data-value="79.36" class="pic medium">
+	<div class="chart"><div class="cover-fill" style="width: 79%"></div><div class="cover-empty" style="width: 21%"></div></div>
+	</td>
+	<td data-value="79.36" class="pct medium">79.36%</td>
+	<td data-value="126" class="abs medium">100/126</td>
+	<td data-value="74.07" class="pct medium">74.07%</td>
+	<td data-value="54" class="abs medium">40/54</td>
+	<td data-value="79.16" class="pct medium">79.16%</td>
+	<td data-value="24" class="abs medium">19/24</td>
+	<td data-value="80" class="pct high">80%</td>
+	<td data-value="115" class="abs high">92/115</td>
+	</tr>
+
+</tbody>
+</table>
+</div>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2025-11-09T11:05:03.156Z
+            </div>
+        <script src="prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="sorter.js"></script>
+        <script src="block-navigation.js"></script>
+    </body>
+</html>
+    

package/coverage/lcov-report/prettify.css

@@ -0,0 +1 @@
+.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}