@peter.naydenov/cuts 1.5.0 → 2.0.0

package/Changelog.md

@@ -1,88 +1,127 @@
 # Release History
 
 
-## 1.5.0 ( 2025-10-?? )
+## 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';
+
+
+
+
+## 1.5.0 ( 2025-10-23 )
 - [x] Dependency update. @peter.naydenov/shortcuts - v.3.5.1
 - [x] Dev dependency update. Vitest - v.4.0.1
 - [x] Cuts has event '@app-error'. Shortcut errors will trigger this event;
 - [x] Type improvements;
 - [x] New method `getState` returns an object with the current state;
 - [x] Fix: Closing a long list of scenes breaks the state;
-
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ## 1.4.4 ( 2025-10-10)
 - [x] Dependency update. @peter.naydenov/shortcuts - v.3.3.1 ( fixing problem with 'key:specialCharacters' events);
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ## 1.4.3 ( 2025-09-30)
 - [x] Dependency update. ask-for-promise@3.0.2;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ## 1.4.2 ( 2025-09-29)
 - [x] Dependency update. @peter.naydenov/shortcuts@3.3.0;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
+
+
 
 ## 1.4.1. ( 2025-09-24)
 - [x] Fix: Cleaning a duplicated line of code in main.js;
-
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ## 1.4.0 ( 2025-09-06)
 - [x] New methods: jump, jumpBack, jumpsReset;
 - [ ] Bug: Duplicated line of code in main.js;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ## 1.3.1 ( 2025-08-15)
 - [ ] Fix: Missing typedef for plugin 'form'
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ## 1.3.0 ( 2025-08-15)
 - [x] Dependency update. @peter.naydenov/shortcuts@3.1.5. Plugin 'form' is available;
 - [ ] Miss: Missing typedef for plugin 'form'
-
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ## 1.2.8 ( 2025-05-03)
 - [x] Dependency update. @peter.naydenov/shortcuts@3.1.4;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
+
 
 
 ### 1.2.7 ( 2025-02-04)
 - [x] Dependency update. @peter.naydenov/log@1.1.1;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ### 1.2.6 ( 2025-01-23)
 - [x] Improve: Warn that the scene is not defined if scene is set to null;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ### 1.2.4 ( 2025-01-15)
 - [x] Dependency update. @peter.naydenov/shortcuts@3.1.3;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ### 1.2.3 ( 2024-12-23)
 - [x] Dependency update. @peter.naydenov/shortcuts@3.1.2;
-
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ### 1.2.2 ( 2024-12-22 )
 - [x] Fix: Wrong argument 'dependencies' for 'beforeHide' and 'afterShow' methods;
-
-
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 ### 1.2.1 ( 2024-12-21 )
 - [x] Fix: Wrong settings if missing 'beforeHide' method;
 - [ ] Bug: Wrong argument 'dependencies' for 'beforeHide' and 'afterShow' methods;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 ### 1.2.0 (2024-12-21)
 - [x] Extend 'scene' with optional 'afterShow' and 'beforeHide' methods;
 - [ ] Bug: Wrong settings if missing 'beforeHide' method;
 - [ ] Bug: Wrong argument 'dependencies' for 'beforeHide' and 'afterShow' methods;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
@@ -90,16 +129,23 @@
 - [x] Type improvements;
 - [x] Refactoring related to types;
 - [x] New method `loadPlugins` to load shortcut plugins: `Key`, `Click` or both;
+- [x] Method 'setScene' errors goes to '@app-error'
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ### 1.0.2 (2024-12-12)
 - [x] Create d.ts files in folder 'types';
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 
 ### 1.0.1 (2024-05-10)
 - [x] Fix: Repository address in package.json;
+- [ ] Bug: Closing a long list of scenes breaks the state;
+- [ ] Bug: SSR option for first scene loading;
 
 
 

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

@@ -110,8 +110,38 @@ script.jumpBack ({hops:2}) // Will load scene from the jump stack. Will load 'te
 
 
 
+## Plugin Configuration
+
+When using shortcut plugins with shortcuts v4.0.0, `clickTarget` and `hoverTarget` parameters now accept arrays of attribute names:
+
+```js
+import cuts from '@peter.naydenov/cuts'
+
+const script = cuts()
+const [ pluginClick, pluginHover] = await script.loadPlugins(['Click', 'Hover'])
+
+// Enable click plugin with multiple target attributes
+script.enablePlugin ( pluginClick, { 
+    clickTarget: ['data-action', 'data-button', 'href'] 
+})
+
+// Enable hover plugin with multiple target attributes  
+script.enablePlugin ( pluginHover, { 
+    hoverTarget: ['data-interactive', 'data-hover'] 
+})
+```
+
+**Available Plugins in v4.0.0:**
+- **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](https://github.com/PeterNaydenov/shortcuts)
 - [History of changes](https://github.com/PeterNaydenov/cuts/blob/main/Changelog.md)
+- [Migration Guide](https://github.com/PeterNaydenov/cuts/blob/main/Migration.guide.md)
 - [Learn how shortcuts are implemented](https://github.com/PeterNaydenov/shortcuts)
 
 

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);