@peter.naydenov/shortcuts 1.1.1 → 2.1.0

package/Changelog.md

@@ -1,6 +1,25 @@
 ## Release History
 
 
+### 2.1.0 ( 2023-10-17 )
+- [x] Method `setDependencies` to add more external objects available in all action functions;
+- [x] Method `getDependencies` to look at existing `dependencies` list;
+
+
+
+### 2.0.0 ( 2023-10-16 )
+- [x] HTML attribute `data-quick-click` is available to speed up single click response;
+- [x] Documentation on methods `pause` and `resume`;
+- [x] Method `listShortcuts` to get names of all shortcuts defined;
+- [x] Arguments for `onShortcut` and `streamKeys` converted to named arguments;
+- [x] Method `setDependencies` to add objects to the "**dependencies**" object available as named argument in all action functions;
+- [x] Method `getDependencies` to look at existing `dependencies` list;
+- [x] Methods `onShortcut` and `streamKeys` have a new argument `dependencies` to pass dependencies to the callback;
+- [x] Dependencies are aviailable for `emit` method as well as first argument;
+- [x] JSdoc type description for public methods;
+- [x] Tag <a> is always a target, regardless of argument 'data-click'. Tag <a> is always a `data-quick-click` target also;
+
+
 
 ### 1.1.1 (2023-09-30)
 - [x] Mouse faster response when maxClicks achived. (maxClicks is automatically calculated according shortcut definitions);

package/Migration.guide.md

@@ -0,0 +1,51 @@
+# Migration Guides
+
+## From version 1.x.x to version 2.x.x
+There are 2 breaking changes: in action functions and in emit method.
+### Action functions
+Version 1.x.x:
+```js
+function ( shortcut, contextName, contextNote ) {
+    // ...
+}
+```
+In version 2.x.x:
+```js
+function ({ shortcut, context, note, dependencies } ) {
+    // Change:
+    // - all arguments are named(properties of single object);
+    // - argument order doesn't matter;
+    // - added argument `dependencies` to pass dependencies to all action function;
+}
+```
+
+### Emit method
+
+Version 1.x.x:
+```js
+let result = null;
+const myAllContext = { 
+                              myAll: {
+                                       'yo' : r => result = r
+                                  }}
+short.load ( myAllContext )
+short.changeContext ( 'myAll' )
+short.emit ( 'yo', 'hello' )
+// result == 'hello'
+```
+
+In version 2.x.x:
+```js
+let result = null;
+const myAllContext = { 
+                              myAll: {
+                                       'yo' : ( dependencies, r ) => result = r
+                                       // Change:
+                                       // - first argument is always dependencies object;
+                                       // - event-data is available from position 2 of arguments list;
+                                  }}
+short.load ( myAllContext )
+short.changeContext ( 'myAll' )
+short.emit ( 'yo', 'hello' ) 
+// result == 'hello'
+```

package/README.md

@@ -11,8 +11,11 @@ Define a context based keyboard-shortcuts and describe a mouse clicks. Switch am
 
 
 ## What's new?
-Version 1.1.0 is coming with new method `emit` that make possible to trigger context functions also programmatically. In `shortcuts` you can mix keyboard, mouse and programmatical events that is prity everything that can happen in a web page.
 
+- Version 1.1.x and above are coming with method `emit` that make possible to trigger shortcuts programmatically. In `shortcuts` you can mix keyboard, mouse and programmatical events that is prity everything that can happen in a web page;
+- Method `setDependencies` comes after version 2.0.0. You can insert external libraries and modules that you will need to access from action functions. They will come as **dependencies** object. In function `emit` will come as first argument. Other arguments are attached behind the dependencies object;
+- Another html data attribute is added - `data-quick-click`. Example: `<button data-click="id" data-quick-click>Click me</button>`. This attribute is saying to `shortcuts` that target element don't need to wait for more then 1 click and shortcut can be executed immediately after the click. Attribute is available in version 2.0.0 and above;
+- Method `listShortcuts` is added in version 2.0.0. It returns a list of shortcuts for requested context. If context is not set, will return a list of all shortcuts;
 
 
 ## Shortcut Description Rules
@@ -131,6 +134,43 @@ Order of describing mouse event and modifier keys is not important.
 Multiple clicks are detected automatically by time interval between clicks. The default interval is 320ms but you can change it by setting `mouseWait` option. Read more in section `Options`.
 
 
+## Define a mouse targets
+Target HTML elements for `shortcuts` are defined by `data-click` attribute. The value of the attribute is the name of the target. Example:
+
+```html
+<button data-click="id">Click me</button>
+<!-- target name is 'id' -->
+```
+
+Attribute is customizable by setting `clickTarget` option. Read more in section `Options`.
+
+If current shortcuts context contain definition for 2 or more clicks, this may slow down the execution of single shortcuts because `shortcuts` will wait for the time interval to detect multiple clicks. To avoid this for specific targets, you can set `data-quick-click` attribute to the target element. Example:
+
+```html
+<button data-click="id" data-quick-click>Click me</button>
+<!-- target name is 'id' and will not wait for more then 1 click -->
+```
+Using a <a> tag is a special case. It's always recognized as a target, and always with attribute `data-quick-click`. No need to set it manually. Example:
+
+```html
+<a href="#">Click me</a>
+<!-- Recognized as a target and will not wait for more then 1 click -->
+<!-- Take care for the action from shortcut `mouse-click-left-1`. -->
+```
+
+Clicking on <a> tag will not execute anything. All events are blocked by default. In your `mouse-click-left-1` action function you can write a code to execute the default action. Example:
+
+```js
+{
+    contextName : {
+                    'mouse-click-left-1' : function ( {target, event} ) {
+                                        if ( target.tagName === 'A' ) { // All targets that are <a> tags will execute the default action
+                                                  window.location.href = target.href  // Go to the link
+                                            }
+                                    }
+                }
+}
+```
 
 
 
@@ -201,6 +241,7 @@ Description of keyboard action functions is:
 function myKeyHandler ({
                   context   // (string) Name of the current context;
                 , note      // (string) Name of the note or null if note isn't set;
+                , dependencies // (object) Object with dependencies that you have set by calling `setDependencies` method;
                 , wait      // (function). Call it to stop a sequence timer and write shortcut sequence without a timer.
                 , end       // (function). Recover the sequence timer;
                 , ignore    // (function). Call it to ignore the current shortcut from the sequence;
@@ -220,6 +261,7 @@ Mouse action functions can be described like:
 function myMouseHandler ({
                   context     // (string) Name of the current context;
                 , note        // (string) Name of the note or null if note isn't set;
+                , dependencies // (object) Object with dependencies that you have set by calling `setDependencies` method;
                 , target      // (DOM element). Target element of the mouse event;
                 , targetProps // (object). Coordinates of the target element (top, left, right, bottom, width, height) or null if target element is not available;
                 , x           // (number). X coordinate of the target element;
@@ -239,18 +281,30 @@ function myMouseHandler ({
 Description of the methods of shortcut instance:
 
 ```js
-  load          : 'Load and extend a shortcut definition.'
-, unload        : 'Remove a shortcut context with all its shortcuts.'
-, changeContext : 'Switch to existing shortcut context.'
-, emit          : 'Trigger a shortcut or custom event programmatically.'
-, pause         : 'Stop listening for shortcuts.'
-, resume        : 'Resume listening for shortcuts.'
-, listContexts  : 'Return list of available contexts.'
-, getContext    : 'Return a name of current context or null if there is no context selected'
-, getNote       : `Return a name of current note or null if note isn't set`
-, setNote       : 'Set a note to current context.'
+  load            : 'Load and extend a shortcut definition.'
+, unload          : 'Remove a shortcut context with all its shortcuts.'
+, changeContext   : 'Switch to existing shortcut context.'
+, emit            : 'Trigger a shortcut or custom event programmatically.'
+, pause           : 'Stop listening for shortcuts.'
+, resume          : 'Resume listening for shortcuts.'
+, listContexts    : 'Return list of available contexts.'
+, getContext      : 'Return a name of current context or null if there is no context selected'
+, getNote         : `Return a name of current note or null if note isn't set`
+, setNote         : 'Set a note to current context.'
+, setDependencies : 'Set dependencies that will be available in action functions.'
+, getDependencies : 'Return dependencies object.'
 ```
 
+### How to 'pause' and 'resume'?
+When you want to stop execution of shortcuts, call `short.pause()`. It's equal to `short.pause('*')`. Will stop all shortcuts in the active context. Stop for single shortcut is by calling `short.pause('shortcutName')`. To resume shortcuts execution call `short.resume()`. It's equal to `short.resume('*')`. Will resume all shortcuts in the active context. Resume for single shortcut is by calling `short.resume('shortcutName')`.
+
+```js
+// pause all shortcuts in the active context
+short.pause () // will stop all shortcuts in the active context
+short.resume ( 'shift+a' ) // will resume only 'shift+a' shortcut
+
+short.resume ('*') // will resume all shortcuts
+```
 
 
 
@@ -283,10 +337,11 @@ const short = shortcuts ( shortcuts.getDefaults () ) // same as above
 
 ### onShortcut option
 ```js
- function onShortcut ( shortcut, context, note ) {
+ function onShortcut ({ shortcut, context, note, dependencies }) {
         // shortcut - (string) Triggered shortcut name
         // context - (string) Name of the current context
         // note - (string) Name of the note or null if note isn't set
+        // dependencies - (object) Object with dependencies that you have set by calling `setDependencies` method
     }
 ```
 
@@ -294,10 +349,11 @@ const short = shortcuts ( shortcuts.getDefaults () ) // same as above
 
 ### streamKeys option
 ```js
- function streamKeys ( key, context, note ) {
+ function streamKeys ({ key, context, note, dependencies }) {
         // key - (string) Pressed key name
         // context - (string) Name of the current context
         // note - (string) Name of the note or null if note isn't set
+        // dependencies - (object) Object with dependencies that you have set by calling `setDependencies` method
     }
 ```
 

package/index.html

@@ -25,7 +25,7 @@
         import sc from '/src/main.js'
 
         const options = {
-                  onShortcut ( shortcut, context, note ) {
+                  onShortcut ({ shortcut, context, note }) {
                           console.log ( '-- RESULTS --->' )
                           console.log ( 'Shortcut', shortcut )
                           console.log ( 'Context:', context )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.naydenov/shortcuts",
-  "version": "1.1.1",
+  "version": "2.1.0",
   "description": "Context control of shortcuts based on keyboard and mouse events",
   "keywords": [
     "shortcut",
@@ -25,13 +25,13 @@
   },
   "devDependencies": {
     "@vitejs/plugin-react": "^4.1.0",
-    "ask-for-promise": "^1.3.1",
+    "ask-for-promise": "^1.4.0",
     "chai": "^4.3.10",
-    "cypress": "^13.3.0",
+    "cypress": "^13.3.1",
     "mocha": "^10.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "vite": "^4.4.9"
+    "vite": "^4.4.11"
   },
   "author": "Peter Naydenov",
   "license": "MIT"

package/src/main.js

@@ -10,21 +10,13 @@
  *  - Development was started on June 21st, 2023
  *  - First version was published on August 14th, 2023
  *  - Method 'emit' was added on September 30st, 2023
+ *  - Version 2.0.0 was published on October 16th, 2023
  */
 
 
 
-import notice from '@peter.naydenov/notice'   // Docs: https://github.com/PeterNaydenov/notice
-
-import listen         from './listen.js'
-import readShortcut   from './readShortcut.js'
-import readKeyEvent   from './readKeyEvent.js'
-import readMouseEvent from './readMouseEvent.js'
-import findTarget from './findTarget.js'
-import specialChars from './specialChars.js'
-import load from './load.js'
-import unload from './unload.js'
-import changeContext from './changeContext.js'
+import notice  from '@peter.naydenov/notice'   // Docs: https://github.com/PeterNaydenov/notice
+import methods from './methods/index.js'
 
 
 
@@ -33,53 +25,115 @@ import changeContext from './changeContext.js'
 function main ( options = {} ) {
     const
           ev = notice ()  // Event emitter instance
-        , currentContext = { name: null, note: null } // Context data container
-        , exposeShortcut = (options.onShortcut && ( typeof options.onShortcut === 'function')) ? options.onShortcut : false
-        , streamKeys     = (options.streamKeys && ( typeof options.streamKeys === 'function')) ? options.streamKeys : false
-        , listenOptions = {
-                              mouseWait     : options.mouseWait ? options.mouseWait : 320   // 320 ms
-                            , maxClicks     : 1  // The maximum number of clicks in a sequence. Controlled automatically by 'changeContext' function.
-                            , keyWait       : options.keyWait ? options.keyWait : 480   // 480 ms
-                            , maxSequence   : 1  // How many keys can be pressed in a sequence. Controlled automatically by 'changeContext' function.
-                            , clickTarget   : options.clickTarget ? options.clickTarget :  'click' // Data-attribute name for click target ( data-click )
-                            , listenFor     : (options.listenFor && Array.isArray(options.listenFor)) ? options.listenFor : [ 'mouse', 'keyboard' ] // What to listen for: ['mouse'], ['keyboard'], ['mouse', 'keyboard']
-                            , keyIgnore     : null   // Timer for ignoring key presses after max sequence or null. Not a public option.
-                       }
-        , shortcuts = {}   // shortcuts = { contextName : { shortcut :  callback[] } }
-        , getContext = () => currentContext.name
-        , getNote    = () => currentContext.note
-        , setNote    = (note=null) => { if (typeof note === 'string' || note == null )   currentContext.note = note }
+        , inAPI = {}      // API for internal methods
+        , API   = {}      // API for public methods
+        , state = {
+                      currentContext : { name: null, note: null } // Context data container
+                    , shortcuts      : {}   // shortcuts = { contextName : { shortcut :  callback[] } }
+                    , listenOptions  : {
+                                          mouseWait     : options.mouseWait ? options.mouseWait : 320   // 320 ms
+                                        , maxClicks     : 1  // The maximum number of clicks in a sequence. Controlled automatically by 'changeContext' function.
+                                        , keyWait       : options.keyWait ? options.keyWait : 480   // 480 ms
+                                        , maxSequence   : 1  // How many keys can be pressed in a sequence. Controlled automatically by 'changeContext' function.
+                                        , clickTarget   : options.clickTarget ? options.clickTarget :  'click' // Data-attribute name for click target ( data-click )
+                                        , listenFor     : (options.listenFor && Array.isArray(options.listenFor)) ? options.listenFor : [ 'mouse', 'keyboard' ] // What to listen for: ['mouse'], ['keyboard'], ['mouse', 'keyboard']
+                                        , keyIgnore     : null   // Timer for ignoring key presses after max sequence or null. Not a public option.
+                                    }
+                    , exposeShortcut : (options.onShortcut && ( typeof options.onShortcut === 'function')) ? options.onShortcut : false
+                    , streamKeys     : (options.streamKeys && ( typeof options.streamKeys === 'function')) ? options.streamKeys : false
+              } // state
         , dependencies = { 
-                              specialChars 
-                            , readKeyEvent
-                            , readMouseEvent
-                            , findTarget
-                            , ev
-                            , exposeShortcut
-                            , streamKeys
+                              ev
+                            , inAPI
+                            , API
+                            , extra : {}
                         }
         ;
-    
-    listen ( dependencies, listenOptions, currentContext )
-
-    return {  // shortcuts API
-        load          : load ( shortcuts, readShortcut, changeContext( shortcuts, listenOptions, ev, currentContext ), getContext )      
-      , unload        : unload ( shortcuts, ev, currentContext )
-      , changeContext : changeContext ( shortcuts, listenOptions, ev, currentContext )
-      , pause         : () => ev.stop ()
-      , resume        : () => ev.start ()
-      , emit          : (x,...args) => ev.emit ( readShortcut(x), ...args )
-      , listContexts  : () => Object.keys ( shortcuts )
-      , getContext
-      , getNote 
-      , setNote
-    }
+
+    /**
+     * @function getContext
+     * @description Get current context name
+     * @returns {string} - Current context name
+     */
+    API.getContext = () => state.currentContext.name
+
+    /**
+     * @function getNote
+     * @description Get current context note
+     * @returns {string} - Current context note
+     */
+    API.getNote    = () => state.currentContext.note
+
+    /**
+     * @function setNote
+     * @description Set current context note
+     * @param {string} note - Context note
+     * @returns {void}
+     */
+    API.setNote    = (note=null) => { if (typeof note === 'string' || note == null )   state.currentContext.note = note }
+
+    /**
+       * @function pause
+       * @description Pause shortcut(s) in current context
+       * @param {string} [name='*' ] - Shortcut name that should be paused. Default is '*' - all shortcuts in current context.
+       * @returns {void}
+       */
+    API.pause = (name='*') => ev.stop ( inAPI._readShortcut(name) )
+
+    /**
+       * @function resume
+       * @description Resume shortcut(s) in current context
+       * @param {string} [name='*' ] - Shortcut name that should be resumed. Default is '*' - all shortcuts in current context.
+       * @returns {void}
+       */
+    API.resume = (name='*') => ev.start ( inAPI._readShortcut(name) )
+
+    /**
+     * @function emit
+     * @description Emit event for shortcut in current context
+     * @param {string} name - Shortcut name
+     * @param {any} [args] - Arguments for callback function
+     * @returns {void}
+     **/
+    API.emit = (name,...args) => ev.emit ( inAPI._readShortcut(name), dependencies.extra, ...args )
+
+    /**
+     * @function listContexts
+     * @description List all context names
+     * @returns {string[]} - Array of context names
+     */
+    API.listContexts = () => Object.keys ( shortcuts )
+
+    /**
+     * @function setDependencies
+     * @description Set a dependency package that will be provided to each action function
+     * @param {object} deps - Enumerate external dependencies
+     * @returns {void}
+     */
+    API.setDependencies = (deps) => dependencies.extra = { ...dependencies.extra, ...deps }
+
+    /**
+     * @function getDependencies
+     * @description Get a dependency package that will be provided to each action function
+     * @returns {object} - Enumerate external dependencies
+     **/
+    API.getDependencies = () => dependencies.extra
+
+
+
+    Object.entries ( methods ).forEach ( ([ name, method ]) => {
+                if ( name.startsWith('_') ) inAPI [ name ] = method ( dependencies, state )
+                else                          API [ name ] = method ( dependencies, state )
+        })
+  
+    inAPI._listen ()
+    return API
 } // main func.
 
 
 
 main.getDefaults = () => ({
-                          mouseWait     : 320     // 320 ms   // TODO: Slow down. It's too fast at the moment.
+                          mouseWait     : 320     // 320 ms
                         , keyWait       : 480     // 480 ms
                         , clickTarget   : 'click' // Data-attribute name for click target ( data-click )
                         , listenFor     : [ 'mouse', 'keyboard' ]

package/src/methods/_findTarget.js

@@ -0,0 +1,19 @@
+'use strict'
+
+function _findTarget ( dependencies, state ) {
+const { listenOptions : {clickTarget}} = state;
+return function _findTarget ( target ) {
+    const t = target;
+    if ( t === document      )   return null
+    if ( t === document.body )   return null
+
+    if ( t.dataset[clickTarget] ) return t
+    if ( t.nodeName === 'A'     ) return t
+    return   _findTarget ( t.parentNode ) 
+}} // _findTarget func.
+
+
+
+export default _findTarget
+
+

package/src/{listen.js → methods/_listen.js}

@@ -2,22 +2,30 @@
 
 
 
-function listen ( dependencies, options, currentContext ) {   // Listen for input signals and generate event titles
+function _listen ( dependencies, state ) {
+// Listen for input signals and generate event titles
+return function _listen () {   
     const { 
-              specialChars 
-            , readKeyEvent
-            , readMouseEvent
-            , findTarget
-            , ev
-            , exposeShortcut
-            , streamKeys
-        } = dependencies
-        , { 
+                ev
+              , inAPI : {
+                          _findTarget
+                        , _specialChars
+                        , _readKeyEvent
+                        , _readMouseEvent
+                    }
+            } = dependencies
+        , {
+                  exposeShortcut
+                , currentContext
+                , streamKeys
+                , listenOptions
+            } = state
+        , {
                   mouseWait
                 , keyWait
                 , clickTarget
-                , listenFor
-            } = options
+                , listenFor  
+            } = listenOptions
         ;
     
     let 
@@ -54,10 +62,18 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                         ignore = false
                                 }
                         }
-
+                    const data = {
+                                      wait: waitKeys
+                                    , end:endKeys
+                                    , ignore:ignoreKeys
+                                    , isWaiting:waitingKeys
+                                    , note: currentContext.note
+                                    , context: currentContext.name
+                                    , dependencies : dependencies.extra
+                            };
                     if ( sequence ) { 
-                            ev.emit ( res.join(','), { wait: waitKeys, end:endKeys, ignore:ignoreKeys, isWaiting:waitingKeys, note: currentContext.note, context: currentContext.name })   
-                            if ( exposeShortcut )   exposeShortcut ( res.join(','), currentContext.name, currentContext.note ) // TODO: Add a context information...?
+                            ev.emit ( res.join(','), data )   
+                            if ( exposeShortcut )   exposeShortcut ({ shortcut:res.join(','), context: currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
                             // Reset:
                             r = []
                             keyTimer = null
@@ -68,7 +84,7 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
 
     function mouseSequenceEnd () {   // Execute when mouse sequence ends
                     const 
-                          mouseEvent = readMouseEvent ( mouseDomEvent, count )
+                          mouseEvent = _readMouseEvent ( mouseDomEvent, count )
                         , data = { 
                                   target : mouseTarget
                                 , targetProps : mouseTarget ? mouseTarget.getBoundingClientRect() : null
@@ -77,10 +93,11 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                 , context : currentContext.name
                                 , note    : currentContext.note
                                 , event   : mouseDomEvent
+                                , dependencies : dependencies.extra
                             }
                         ;
                     ev.emit ( mouseEvent.join('+'), data )
-                    if ( exposeShortcut )   exposeShortcut ( mouseEvent.join('+'), currentContext.name, currentContext.note )
+                    if ( exposeShortcut )   exposeShortcut ({ shortcut: mouseEvent.join('+'), context:currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
                     // Reset:
                     mouseTimer = null
                     mouseIgnore = null
@@ -93,6 +110,7 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
 
     function listenMouse () {
                         window.addEventListener ( 'contextmenu', event => {   // Listen for right mouse clicks
+                                        let targetMax = listenOptions.maxClicks;  // Maximum number of clicks per target
                                         event.preventDefault ()
                                         clearTimeout ( mouseTimer )
                                         if ( mouseIgnore ) {
@@ -100,18 +118,21 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                                     mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
                                                     return
                                             }
-                                        mouseTarget = findTarget (event.target, clickTarget )
+                                        mouseTarget = _findTarget ( event.target )
+                                        if ( mouseTarget && mouseTarget.dataset.hasOwnProperty('quickClick'))   targetMax = 1
+                                        if ( mouseTarget && mouseTarget.tagName === 'A'                     )   targetMax = 1
                                         mouseDomEvent = event
                                         count++
-                                        if ( count === options.maxClicks ) {  
+                                        if ( count >= targetMax ) {  
                                                     mouseSequenceEnd ()
-                                                    mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
+                                                    if ( targetMax > 1 )   mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
                                                     return
                                             }
                                         mouseTimer = setTimeout ( mouseSequenceEnd, mouseWait )
                                 })
 
                         document.addEventListener ( 'click', event => {  // Listen for left and middle mouse clicks
+                                        let targetMax = listenOptions.maxClicks;  // Maximum number of clicks per target
                                         event.preventDefault ()
                                         clearTimeout ( mouseTimer )
                                         if ( mouseIgnore ) {
@@ -119,12 +140,14 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                                     mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
                                                     return
                                             }
-                                        mouseTarget = findTarget ( event.target, clickTarget )
+                                        mouseTarget = _findTarget ( event.target )
+                                        if ( mouseTarget && mouseTarget.dataset.hasOwnProperty('quickClick'))   targetMax = 1
+                                        if ( mouseTarget && mouseTarget.tagName === 'A'                     )   targetMax = 1
                                         mouseDomEvent = event
                                         count++
-                                        if ( count >= options.maxClicks ) {
+                                        if ( count >= targetMax ) {
                                                     mouseSequenceEnd ()
-                                                    mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
+                                                    if ( targetMax > 1 )   mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
                                                     return
                                             }
                                         mouseTimer = setTimeout ( mouseSequenceEnd, mouseWait )
@@ -136,17 +159,17 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
     function listenKeyboard () {
                         document.addEventListener ( 'keydown', event => {   // Listen for special keyboard keys
                                         clearTimeout ( keyTimer )
-                                        if ( specialChars.hasOwnProperty(event.code) )   r.push ( readKeyEvent ( event, specialChars ))
+                                        if ( _specialChars.hasOwnProperty(event.code) )   r.push ( _readKeyEvent ( event, _specialChars ))
                                         else                                             return
-                                        if ( streamKeys )   streamKeys ( event.key, currentContext.name, currentContext.note )
-                                        if ( options.keyIgnore ) {
-                                                    clearTimeout ( options.keyIgnore )
-                                                    options.keyIgnore = setTimeout ( () => options.keyIgnore=null, keyWait )
+                                        if ( streamKeys )   streamKeys ({ key:event.key, context:currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
+                                        if ( listenOptions.keyIgnore ) {
+                                                    clearTimeout ( listenOptions.keyIgnore )
+                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
                                                     return 
                                             }
-                                        if ( sequence && r.length === options.maxSequence ) {                                                    
+                                        if ( sequence && r.length === listenOptions.maxSequence ) {                                                    
                                                     keySequenceEnd ()
-                                                    options.keyIgnore = setTimeout ( () => options.keyIgnore=null, keyWait )
+                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
                                                     return
                                             }
                                         if ( sequence   )   keyTimer = setTimeout ( keySequenceEnd, keyWait )
@@ -154,18 +177,18 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                 })
 
                         document.addEventListener ( 'keypress', event => {  // Listen for regular keyboard keys
-                                        if ( specialChars.hasOwnProperty(event.code) )   return            
+                                        if ( _specialChars.hasOwnProperty(event.code) )   return            
                                         clearTimeout ( keyTimer )
-                                        if ( streamKeys )   streamKeys ( event.key, currentContext.name, currentContext.note )
-                                        if ( options.keyIgnore ) {
-                                                    clearTimeout ( options.keyIgnore )
-                                                    options.keyIgnore = setTimeout ( () => options.keyIgnore=null, keyWait )
+                                        if ( streamKeys )   streamKeys ({ key:event.key, context:currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
+                                        if ( listenOptions.keyIgnore ) {
+                                                    clearTimeout ( listenOptions.keyIgnore )
+                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
                                                     return 
                                             }
-                                        r.push ( readKeyEvent ( event, specialChars ))
-                                        if ( sequence && r.length === options.maxSequence ) {
+                                        r.push ( _readKeyEvent ( event, _specialChars ))
+                                        if ( sequence && r.length === listenOptions.maxSequence ) {
                                                     keySequenceEnd ()
-                                                    options.keyIgnore = setTimeout ( () => options.keyIgnore=null, keyWait )
+                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
                                                     return
                                             }
                                         if ( sequence )   keyTimer = setTimeout ( keySequenceEnd, keyWait )
@@ -178,10 +201,10 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
     if ( listenFor.includes('mouse')    )   listenMouse ()
     if ( listenFor.includes('keyboard') )   listenKeyboard ()
 
-} // listen func.
+}} // _listen func.
 
 
 
-export default listen
+export default _listen
 
 

package/src/{readKeyEvent.js → methods/_readKeyEvent.js}

@@ -1,7 +1,7 @@
 'use strict'
 
-
-function readKeyEvent ( event, specialChars ) {
+function _readKeyEvent () {
+return function _readKeyEvent ( event, _specialChars ) {
     let
           { shiftKey, altKey, ctrlKey } = event
         , falseKeys = [ 'ControlLeft','ControlRight', 'ShiftLeft', 'ShiftRight', 'AltLeft', 'AltRight', 'Meta' ]
@@ -15,13 +15,13 @@ function readKeyEvent ( event, specialChars ) {
     if ( shiftKey )  res.push ( 'SHIFT' )
     if ( altKey )    res.push ( 'ALT' )
 
-    if ( specialChars.hasOwnProperty ( key ) )  res.push ( specialChars[key].toUpperCase () )
-    else if ( !falseKeys.includes(key)  )       res.push ( key.toUpperCase () )
+    if ( _specialChars.hasOwnProperty ( key ) )  res.push ( _specialChars[key].toUpperCase () )
+    else if (       !falseKeys.includes(key)  )  res.push ( key.toUpperCase () )
     return res.sort ()
-} // readKeyEvent func.
+}} // _readKeyEvent func.
 
 
 
-export default readKeyEvent
+export default _readKeyEvent
 
 

package/src/{readMouseEvent.js → methods/_readMouseEvent.js}

@@ -1,7 +1,7 @@
 'use strict'
 
-
-function readMouseEvent ( event, count ) {
+function _readMouseEvent () {
+return function _readMouseEvent ( event, count ) {
     let
           { shiftKey, altKey, ctrlKey, key, button } = event
         , mouseNames = [ 'LEFT', 'MIDDLE', 'RIGHT' ]
@@ -15,10 +15,10 @@ function readMouseEvent ( event, count ) {
     if ( altKey )    res.push ( 'ALT' )
 
     return res.sort ()
-} // readMouseEvent func.
+}} // _readMouseEvent func.
 
 
 
-export default readMouseEvent
+export default _readMouseEvent
 
 

package/src/{readShortcut.js → methods/_readShortcut.js}

@@ -1,16 +1,17 @@
 'use strict'
 // [ crtl+s, shift+alt+o]
-function readShortcut ( txt ) {
+function _readShortcut () {
+return function _readShortcut ( txt ) {
         const r = txt
                     .split ( ',' )
                     .map ( (x) => x.trim() )
                     .map ( (x) => x.split ( '+' ).map(x => x.toUpperCase()).sort().join('+') )
                     .join ( ',' );
     return r
-} // readShortcut func.
+}} // _readShortcut func.
 
 
 
-export default readShortcut
+export default _readShortcut
 
 

package/src/methods/_specialChars.js

@@ -0,0 +1,38 @@
+function _specialChars () {
+return {
+  'ArrowLeft'   : 'LEFT'
+, 'ArrowUp'     : 'UP'
+, 'ArrowRight'  : 'RIGHT'
+, 'ArrowDown'   : 'DOWN'
+, 'Enter'       : 'ENTER'
+, 'NumpadEnter' : 'ENTER'
+, 'Escape'      : 'ESC' 
+, 'Backspace'   : 'BACKSPACE'
+, 'Space'       : 'SPACE'
+, 'Tab'         : 'TAB'
+, 'Backquote'   : '`'
+, 'BracketLeft' : '['
+, 'BracketRight': ']'
+, 'Equal'       : '='
+, 'Slash'       : '/'
+, 'Backslash'   : '\\'
+, 'IntlBackslash' : '`'
+, 'F1'  : 'F1'
+, 'F2'  : 'F2'
+, 'F3'  : 'F3'
+, 'F4'  : 'F4'
+, 'F5'  : 'F5'
+, 'F6'  : 'F6'
+, 'F7'  : 'F7'
+, 'F8'  : 'F8'
+, 'F9'  : 'F9'
+, 'F10' : 'F10'
+, 'F11' : 'F11'
+, 'F12' : 'F12'
+}}
+
+
+
+export default _specialChars
+
+

package/src/{changeContext.js → methods/changeContext.js}

@@ -1,8 +1,24 @@
 'use strict'
 
-function changeContext ( shortcuts, listenOptions, ev, currentContext ) {
+function changeContext ( dependencies, state ) {
+const 
+          { 
+               shortcuts
+             , listenOptions 
+             , currentContext
+          } = state
+        , { ev } = dependencies
+        ;
+
+/**
+ * @function changeContext
+ * @description Change current context with shortcuts belonging to it.
+ * @param {string} [contextName=false] - Name of context to change to. Default 'false' will switch off all shortcuts.
+ * @returns {void}
+ */
 return function changeContext ( contextName = false ) {
         const current = currentContext.name;
+        
         listenOptions.maxSequence = 1
         listenOptions.maxClicks = 1
         
@@ -37,7 +53,7 @@ return function changeContext ( contextName = false ) {
                                 }
                         list.forEach ( fn => ev.on ( shortcutName, fn )   )    // Enable new context shortcuts
                 })   
-        currentContext.name = contextName
+        currentContext.name = contextName        
 }} // changeContext func.
 
 

package/src/methods/index.js

@@ -0,0 +1,29 @@
+import _findTarget      from './_findTarget.js'
+import _listen         from './_listen.js'
+import _readKeyEvent   from './_readKeyEvent.js'
+import _readMouseEvent from './_readMouseEvent.js'
+import _readShortcut   from './_readShortcut.js'
+import _specialChars   from './_specialChars.js'
+
+import load           from './load.js'
+import unload         from './unload.js'
+import changeContext  from './changeContext.js'
+import listShortcuts  from './listShortcuts.js'
+
+
+
+export default {
+// Internal methods
+    _findTarget
+  , _listen
+  , _readKeyEvent
+  , _readMouseEvent
+  , _readShortcut
+  , _specialChars
+
+// Public methods
+  , changeContext
+  , listShortcuts
+  , load
+  , unload
+}

package/src/methods/listShortcuts.js

@@ -0,0 +1,40 @@
+'use strict'
+/**
+ * @typedef {object} contextShortcuts
+ * @property {string} context - Context name
+ * @property {string[]} shortcuts - List of shortcuts in a context
+ */
+
+
+
+function listShortcuts ( dependencies, state ) {
+const shortcuts = state.shortcuts;
+/**
+ *  List all shortcuts in all contexts or in a specific context.
+ *  @param {string}[ contextName=null]  - List of shortcuts for provided context name. (optional)
+ *  @returns {string[]|contextShortcuts[]} - List of shortcuts for a specified context or list of contextShortcuts for all contexts.
+ */
+return function listShortcuts ( contextName=null ) {
+    
+    // Create a list of shortcuts for a specific context:
+    if ( contextName != null ) {
+                let context = shortcuts[contextName];
+                if ( context == null )   return null
+                return Object.entries ( context ).map ( ([shortcut, callbacks]) => shortcut )
+        }
+
+    // Create a list of allShortcuts for each context:
+    return  Object.keys ( shortcuts ).map ( contextName => {
+                        let result = {};
+                        result['context'] = contextName
+                        result['shortcuts'] = Object.entries ( shortcuts[contextName] ).map ( ([shortcut, callbacks]) => shortcut   )
+                        return result
+            }) // map
+
+}} // listShortcuts func.
+
+
+
+export default listShortcuts
+
+

package/src/{load.js → methods/load.js}

@@ -1,8 +1,17 @@
 'use strict'
 
-
-
-function load ( shortcuts, readShortcut, changeContext, getContext ) {
+function load ( dependencies, state ) {
+const 
+          { shortcuts } = state
+        , {
+                inAPI : { _readShortcut }
+                , API : { changeContext, getContext }
+        } = dependencies;
+/**
+ *  Load a context with shortcuts object
+ *  @param {Object} obj - Context description object: { contextName : { shortcut : callback[] }
+ *  @returns {void}
+ */
 return function load ( obj ) {
     const
            currentContextName = getContext ()
@@ -14,7 +23,7 @@ return function load ( obj ) {
                     if ( contextName === currentContextName ) hasChanges = true;
                     shortcuts [ contextName ] = {}
                     description.forEach ( ([ title, callbackList ]) => {
-                                    const name = readShortcut ( title );
+                                    const name = _readShortcut ( title );
                                     if ( callbackList instanceof Function ) callbackList = [ callbackList ]
                                     shortcuts [contextName][ name ] = callbackList
                             }) // shortcuts.forEach

package/src/{unload.js → methods/unload.js}

@@ -1,8 +1,16 @@
 'use strict'
 
-
-
-function unload ( shortcuts, ev, currentContext ) {
+function unload ( dependencies, state ) {
+const 
+     { currentContext, shortcuts } = state
+   , { ev } = dependencies
+   ;
+/**
+ * @function unload
+ * @description Unload a non-active context with shortcuts.
+ * @param {string} contextName - Context name to unload
+ * @returns {void}
+ */
 return function unload ( contextName ) {
         const current = currentContext.name;
         if ( current === contextName ) {

package/test/01-general.cy.js

@@ -4,11 +4,13 @@ import '../test-components/style.css'
 import shortcuts from '../src/main.js'
 import { expect } from 'chai'
 
+import askForPromise from 'ask-for-promise'
+
 let
        a = false
      , b = false
      ;
-const short = shortcuts ({onShortcut : ( shortcut, context, note ) => console.log (shortcut, context, note)});
+const short = shortcuts ({onShortcut : ({shortcut, context, note}) => console.log (shortcut, context, note)});
 short.load ({
                   general : {
                             'shift+a': [ () => a = true ]
@@ -116,12 +118,94 @@ it ( 'Emit custom event', () => {
       const myAllContext = { 
                               myAll: {
                                         'mouse-click-leff-1' : () =>  console.log ( 'nothing' )
-                                      , 'yo' : r => result = r
+                                      , 'yo' : (dependencies,r) => result = r
                                   }}
       short.load ( myAllContext )
       short.changeContext ( 'myAll' )
       short.emit ( 'yo', 'hello' )
       expect ( result ).to.be.equal ( 'hello' )
+      short.changeContext ( 'general' )
+      short.unload ( 'myAll' )
 }) // it emit custom event
 
+
+
+it ( 'Dependencies on shortcuts', done => {
+    const task = askForPromise ();
+    expect ( a ).to.be.false
+    expect ( b ).to.be.false
+
+    short.setDependencies ({ task })
+    
+    short.load ({   
+                    'extra' : {   // load will overwrite existing 'extra' context definition
+                                  'mouse-click-left-1' : ({dependencies}) => {
+                                                                    const { task } = dependencies;
+                                                                    expect ( task ).to.have.property ( 'done' )
+                                                                    expect ( task ).to.have.property ( 'promise' )
+                                                                    a = true
+                                                                }
+                              } 
+                }) // load will restart the selected context
+
+    short.changeContext ( 'extra' )
+    cy.get('#rspan').click ()
+    cy.wait ( 350 ) // Default wait mouse timeout is 320 ms
+      .then ( () => {
+                    expect ( a ).to.be.true
+                    done ()
+        })
+}) // it dependencies on shortcuts
+
+
+
+it ( 'List shortcuts', () => {
+    let general =  short.listShortcuts ('general');
+    expect ( general ).to.be.an('array')
+    expect ( general ).to.have.lengthOf ( 1 )
+    expect ( general[0] ).to.be.equal ( 'A+SHIFT' )
+    
+    let fail = short.listShortcuts ('somethingNotExisting');
+    expect ( fail ).to.be.null
+
+    let all = short.listShortcuts ();
+    expect ( all ).to.be.an('array')
+    
+    expect ( all ).to.have.lengthOf ( 2 )
+    expect ( all[0] ).to.have.property ( 'context' )
+    expect ( all[0] ).to.have.property ( 'shortcuts' )
+    expect ( all[0].shortcuts ).to.be.an('array')
+    expect ( all[0].shortcuts ).to.have.lengthOf ( 1 )
+    expect ( all[0].shortcuts[0] ).to.be.equal ( 'A+SHIFT' )
+    expect ( all[0].context ).to.be.equal ( 'general' )
+    
+}) // it list shortcuts
+
+
+
+it ( 'Click on anchor', done => {
+    // Click on anchor that don't have click-data attribute.
+    let result = 'none';
+    short.load ({ 'extra' : { 
+                              'mouse-click-left-1' : ({target, context }) => {
+                                          expect ( context ).to.be.equal ( 'extra' )
+                                          expect ( target.nodeName ).to.be.equal ( 'A' )
+                                          result = target.nodeName
+                                    }
+                          } 
+              })
+    short.changeContext ( 'extra' )    
+    cy.get ( '#anchor' ).click ()
+    cy.wait ( 3 ) // Consider mouse click has some latency
+      // According Cypress documentation: 
+      // It is unsafe to chain further commands that rely on the subject after .click(). 
+      // source docs: https://docs.cypress.io/api/commands/click
+      .then ( () => {
+                  short.changeContext ( 'general' )              
+                  expect ( result ).to.be.equal ( 'A' )
+                  done ()
+          })
+}) // it click on anchor
+
+
 }) // describe

package/test-components/Block.jsx

@@ -2,6 +2,7 @@ function Block () {
 return <>
     <div className="block" data-click="red"><span id='rspan'>Red</span> </div>
     <button className="big-btn" data-click="mega">Mega button</button>
+    <p>Some text with <a href="#" target="_blank">link <span id="anchor">in</span></a> it</p>
 </> 
 }
 

package/blueprint-docs.md

@@ -1,73 +0,0 @@
-# Shortcuts (@peter.naydenov/shortcuts)
-*UNDER HEAVY DEVELOPMENT - early experimental stage*
-
-Build a keyboard shortcuts maps and describe a mouse clicks. Control them on context.
-
-Tread it as a "**draft**" during `HEAVY DEVELOPMENT` stage. the API will change frequently and version of the package will not be updated. Will stay at `0.0.1` until the API get usable.
-
-
-
-
-
-Create shortcuts for your web application based on keyboard and mouse events.
-
-Listen for keyboard, mouse and touch events and converts them into event-emmiter events. 
-Define a shortcut library with shortcut names and callback functions. The callback functions will be called when the shortcut is pressed. Library `shortcuts` supports a context switching and that allows 
-to add, remove and change multiple shortcuts by changing the current context. 
-
-- Context switching;
-- Listen for keyboard, mouse and touch events;
-- Read a shortcut sequences;
-- Multiple mouse clicks events for left and right mouse buttons;
-- The delay between keypresses and mouse clicks in shortcut sequences are controlled by parameters;
-- Centralized control over mouse click event. All clicks on the page can be described by a single callback function;
-
-
-Define and conrol shortcuts in your application. Setup a stage, create a shortcut name and associate a list of callback function with it. The callback function will be called when the shortcut is pressed. Changing the stage will stop all shortcuts associated with it old stage and start all shortcuts associated with the new stage.
-
-Event sources: keyboard, mouse, touch;
-
-## Installation
-
-```bash
- npm i @peter.naydenov/shortcuts
-```
-
-From the project file:
-
-```js
- import shortcuts from '@peter.naydenov/shortcuts'
-
-```
-
-## Methods
-
-
-```js
-  'load'          : 'Provide context objects, shortcuts related to the context and list of callback functions'
-, 'unload'        : 'Remove context objects and shortcuts'
-, 'changeContext' : 'Change the current context. Change active list of shortcuts'
-, 'pause'         : 'Disable all shortcuts. No change of context'
-, 'resume'        : 'Resume shortcuts after pause'
-, 'getContext'    : 'Return the current context name'
-```
-
-
-## Keyboard Action functions
-Keypress will create an event with name of pressed keys. If `shortcut` has a callback function associated with this name, the callback function will be called. 
-
-The callback function will receive an object with the following properties:
-
-```js
-    function keyCallback (key) {
-        console.log(key)
-    }
-```
-Every shortcut is defined by a callback function. The callback function will be called when the shortcut is pressed. The callback function will receive an object with the following properties:
-
-
-```js
-    function keyCallback (key) {
-        console.log(key)
-    }
-```

package/dist/assets/index-3c4377c6.js

@@ -1 +0,0 @@
-(function(){const e=document.createElement("link").relList;if(e&&e.supports&&e.supports("modulepreload"))return;for(const o of document.querySelectorAll('link[rel="modulepreload"]'))i(o);new MutationObserver(o=>{for(const l of o)if(l.type==="childList")for(const u of l.addedNodes)u.tagName==="LINK"&&u.rel==="modulepreload"&&i(u)}).observe(document,{childList:!0,subtree:!0});function t(o){const l={};return o.integrity&&(l.integrity=o.integrity),o.referrerPolicy&&(l.referrerPolicy=o.referrerPolicy),o.crossOrigin==="use-credentials"?l.credentials="include":o.crossOrigin==="anonymous"?l.credentials="omit":l.credentials="same-origin",l}function i(o){if(o.ep)return;o.ep=!0;const l=t(o);fetch(o.href,l)}})();function M(){function r(){let e={},t={},i=[],o=!1,l="";function u(n,s){e[n]||(e[n]=[]),e[n].push(s)}function c(n,s){t[n]||(t[n]=[]),t[n].push(s)}function y(n,s){if(s){e[n]&&(e[n]=e[n].filter(g=>g!==s)),t[n]&&(t[n]=t[n].filter(g=>g!==s)),e[n]&&e[n].length===0&&delete e[n],t[n]&&t[n].length===0&&delete e[n];return}t[n]&&delete t[n],e[n]&&delete e[n]}function f(){e={},t={},i=[]}function m(n,s){o=!!n,s&&typeof s=="string"&&(l=s)}function d(){const[n,...s]=arguments;if(o&&(console.log(`${l} Event "${n}" was triggered.`),s.length>0&&(console.log("Arguments:"),console.log(...s),console.log("^----"))),n=="*"&&Object.keys(e).forEach(E=>{i.includes(E)||e[E].forEach(F=>F(...s))}),t[n]){if(i.includes(n))return;t[n].forEach(g=>g(...s)),delete t[n]}if(e[n]){if(i.includes(n))return;e[n].forEach(g=>g(...s))}}function k(n){if(n==="*"){i=[];return}i=i.filter(s=>n!=s)}function p(n){if(n==="*"){const s=Object.keys(e);i=[...Object.keys(t),...s];return}i.push(n)}return{on:u,once:c,off:y,reset:f,emit:d,stop:p,start:k,debug:m}}return new r}function P(r,e,t){const{specialChars:i,readKeyEvent:o,readMouseEvent:l,findTarget:u,ev:c,exposeShortcut:y,streamKeys:f}=r,{mouseWait:m,keyWait:d,clickTarget:k,listenFor:p}=e;let n=[],s=null,g=null,E=null,F=null,h=null,T=!0,L=!1,S=0;const A=()=>T=!1,b=()=>T=!0,O=()=>L=!0,v=()=>T===!1;function I(){let a=n.map(K=>[K.join("+")]);if(!T){let K=a.at(-1);c.emit(K,{wait:A,end:b,ignore:O,isWaiting:v,note:t.note,context:t.name}),L&&(a=a.slice(0,-1),L=!1)}T&&(c.emit(a.join(","),{wait:A,end:b,ignore:O,isWaiting:v,note:t.note,context:t.name}),y&&y(a.join(","),t.name,t.note),n=[],E=null)}function w(){const a=l(g,S),K={target:s,targetProps:s?s.getBoundingClientRect():null,x:g.clientX,y:g.clientY,context:t.name,note:t.note,event:g};c.emit(a.join("+"),K),y&&y(a.join("+"),t.name,t.note),F=null,h=null,s=null,g=null,S=0}function q(){window.addEventListener("contextmenu",a=>{if(clearTimeout(F),h){clearTimeout(h),h=setTimeout(()=>h=null,m);return}if(S===e.maxClicks){w(),h=setTimeout(()=>h=null,m);return}a.preventDefault(),s=u(a.target,k),g=a,S++,F=setTimeout(w,m)}),document.addEventListener("click",a=>{if(clearTimeout(F),h){clearTimeout(h),h=setTimeout(()=>h=null,m);return}if(S===e.maxClicks){w(),h=setTimeout(()=>h=null,m);return}s=u(a.target,k),g=a,S++,F=setTimeout(w,m)})}function j(){document.addEventListener("keydown",a=>{if(clearTimeout(E),i.hasOwnProperty(a.code))n.push(o(a,i));else return;if(f&&f(a.key,t.name,t.note),e.keyIgnore){clearTimeout(e.keyIgnore),e.keyIgnore=setTimeout(()=>e.keyIgnore=null,d);return}if(T&&n.length===e.maxSequence){I(),e.keyIgnore=setTimeout(()=>e.keyIgnore=null,d);return}T?E=setTimeout(I,d):I()}),document.addEventListener("keypress",a=>{if(!i.hasOwnProperty(a.code)){if(clearTimeout(E),f&&f(a.key,t.name,t.note),e.keyIgnore){clearTimeout(e.keyIgnore),e.keyIgnore=setTimeout(()=>e.keyIgnore=null,d);return}if(n.push(o(a,i)),T&&n.length===e.maxSequence){I(),e.keyIgnore=setTimeout(()=>e.keyIgnore=null,d);return}T?E=setTimeout(I,d):I()}})}p.includes("mouse")&&q(),p.includes("keyboard")&&j()}function B(r){return r.split(",").map(t=>t.trim()).map(t=>t.split("+").map(i=>i.toUpperCase()).sort().join("+")).join(",")}function D(r,e){let{shiftKey:t,altKey:i,ctrlKey:o}=r,l=["ControlLeft","ControlRight","ShiftLeft","ShiftRight","AltLeft","AltRight","Meta"],u=r.code.replace("Key","").replace("Digit",""),c=[];return o&&c.push("CTRL"),t&&c.push("SHIFT"),i&&c.push("ALT"),e.hasOwnProperty(u)?c.push(e[u].toUpperCase()):l.includes(u)||c.push(u.toUpperCase()),c.sort()}function U(r,e){let{shiftKey:t,altKey:i,ctrlKey:o,key:l,button:u}=r,c=["LEFT","MIDDLE","RIGHT"],y=`MOUSE-CLICK-${c[u]}-${e}`,f=[];return f.push(y),o&&f.push("CTRL"),t&&f.push("SHIFT"),i&&f.push("ALT"),f.sort()}function $(r,e){let t=r;for(;t&&!t.dataset[e];)if(t=t.parentNode,t===document||t===document.body)return null;return t}const x={ArrowLeft:"LEFT",ArrowUp:"UP",ArrowRight:"RIGHT",ArrowDown:"DOWN",Enter:"ENTER",NumpadEnter:"ENTER",Escape:"ESC",Backspace:"BACKSPACE",Space:"SPACE",Tab:"TAB",Backquote:"`",BracketLeft:"[",BracketRight:"]",Equal:"=",Slash:"/",Backslash:"\\",IntlBackslash:"`",F1:"F1",F2:"F2",F3:"F3",F4:"F4",F5:"F5",F6:"F6",F7:"F7",F8:"F8",F9:"F9",F10:"F10",F11:"F11",F12:"F12"};function N(r,e,t,i){return function(l){const u=i(),c=Object.keys(l);let y=!1;c.forEach(f=>{const m=Object.entries(l[f]);f===u&&(y=!0),r[f]={},m.forEach(([d,k])=>{const p=e(d);k instanceof Function&&(k=[k]),r[f][p]=k})}),y&&(t(),t(u))}}function H(r,e,t){return function(o){if(t.name===o){e.emit("shortcuts-error",`Context '${o}' can't be removed during is current active context. Change the context first`);return}if(!r[o]){e.emit("shortcuts-error",`Context '${o}' does not exist`);return}delete r[o]}}function R(r,e,t,i){return function(l=!1){const u=i.name;if(e.maxSequence=1,e.maxClicks=1,e.keyIgnore>=0&&(clearTimeout(e.keyIgnore),e.keyIgnore=null),!l){t.reset(),i.name=null;return}if(u!==l){if(!r[l]){t.emit("shortcuts-error",`Context '${l}' does not exist`);return}r[u]&&t.reset(),Object.entries(r[l]).forEach(([c,y])=>{if(c.includes("MOUSE-CLICK-")){let[,,,m]=c.split("-"),d=parseInt(m);e.maxClicks<d&&(e.maxClicks=d)}else{let m=c.split(",").length;e.maxSequence<m&&(e.maxSequence=m)}y.forEach(m=>t.on(c,m))}),i.name=l}}}function W(r={}){const e=M(),t={name:null,note:null},i=r.onShortcut&&typeof r.onShortcut=="function"?r.onShortcut:!1,o=r.streamKeys&&typeof r.streamKeys=="function"?r.streamKeys:!1,l={mouseWait:r.mouseWait?r.mouseWait:320,maxClicks:1,keyWait:r.keyWait?r.keyWait:480,maxSequence:1,clickTarget:r.clickTarget?r.clickTarget:"click",listenFor:r.listenFor&&Array.isArray(r.listenFor)?r.listenFor:["mouse","keyboard"],keyIgnore:null},u={},c=()=>t.name,y=()=>t.note,f=(d=null)=>{(typeof d=="string"||d==null)&&(t.note=d)};return P({specialChars:x,readKeyEvent:D,readMouseEvent:U,findTarget:$,ev:e,exposeShortcut:i,streamKeys:o},l,t),{load:N(u,B,R(u,l,e,t),c),unload:H(u,e,t),changeContext:R(u,l,e,t),pause:()=>e.stop(),resume:()=>e.start(),listContexts:()=>Object.keys(u),getContext:c,getNote:y,setNote:f}}W.getDefaults=()=>({mouseWait:320,keyWait:480,clickTarget:"click",listenFor:["mouse","keyboard"],onShortcut:!1,streamKeys:!1});const G={onShortcut(r,e,t){console.log("-- RESULTS --->"),console.log("Shortcut",r),console.log("Context:",e),t&&console.log("Note:",t)}},C=W(G);C.load({general:{q:[()=>console.log("Q was clicked")],"r,o,s":()=>console.log("ROS was clicked"),"mouse-click-left-2":()=>console.log("Mouse left click 2"),r:[({isWaiting:r})=>{r()||console.log("R was clicked")}],"shift+w":[({wait:r,end:e,ignore:t,isWaiting:i,note:o})=>{t(),i()?(console.log("END"),e()):(console.log("WAIT"),r())},()=>console.log("W")]}});C.changeContext("general");C.setNote("some");

package/dist/index.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite App</title>
-    <style>
-      .block {
-              width: 100px;
-              height: 100px;
-              background-color: red;
-          }
-      .big-btn {
-              width: 200px;
-              height: 200px;
-              margin-left: 320px;
-              background-color: skyblue;
-              border-radius: 10px;
-          }
-    </style>
-    <script type="module" crossorigin src="/assets/index-3c4377c6.js"></script>
-  </head>
-  <body>
-    
-    <div class="block" data-click="red-block">
-        <span>hello</span>
-    </div>
-
-    <button class="big-btn" data-click="mega-button" draggable>Mega button</button>
-  </body>
-</html>

package/dist/vite.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/src/findTarget.js

@@ -1,18 +0,0 @@
-'use strict'
-
-
-function findTarget ( target, dataName ) {
-    let t = target
-    while ( t && !t.dataset[dataName] ) {
-            t = t.parentNode;
-            if ( t === document      )   return null
-            if ( t === document.body )   return null
-        }
-    return t
-} // findTarget func.
-
-
-
-export default findTarget
-
-

package/src/specialChars.js

@@ -1,31 +0,0 @@
-export default {
-      'ArrowLeft'   : 'LEFT'
-    , 'ArrowUp'     : 'UP'
-    , 'ArrowRight'  : 'RIGHT'
-    , 'ArrowDown'   : 'DOWN'
-    , 'Enter'       : 'ENTER'
-    , 'NumpadEnter' : 'ENTER'
-    , 'Escape'      : 'ESC' 
-    , 'Backspace'   : 'BACKSPACE'
-    , 'Space'       : 'SPACE'
-    , 'Tab'         : 'TAB'
-    , 'Backquote'   : '`'
-    , 'BracketLeft' : '['
-    , 'BracketRight': ']'
-    , 'Equal'       : '='
-    , 'Slash'       : '/'
-    , 'Backslash'   : '\\'
-    , 'IntlBackslash' : '`'
-    , 'F1'  : 'F1'
-    , 'F2'  : 'F2'
-    , 'F3'  : 'F3'
-    , 'F4'  : 'F4'
-    , 'F5'  : 'F5'
-    , 'F6'  : 'F6'
-    , 'F7'  : 'F7'
-    , 'F8'  : 'F8'
-    , 'F9'  : 'F9'
-    , 'F10' : 'F10'
-    , 'F11' : 'F11'
-    , 'F12' : 'F12'
-}