@peter.naydenov/shortcuts 2.2.0 → 3.0.1

package/test/01-general.cy.js

@@ -1,7 +1,11 @@
 
 import Block from '../test-components/Block.jsx'
 import '../test-components/style.css'
-import shortcuts from '../src/main.js'
+import { 
+          pluginClick,
+          pluginKey
+        , shortcuts 
+                } from '../src/main.js'
 import { expect } from 'chai'
 
 import askForPromise from 'ask-for-promise'
@@ -10,17 +14,20 @@ let
        a = false
      , b = false
      ;
-const short = shortcuts ({onShortcut : ({shortcut, context, note}) => console.log (shortcut, context, note)});
+                                    
+const short = shortcuts ({onShortcut : ( shortcut, {context,note,type}) =>  console.log (shortcut, context, note, type)   });
+    
 short.load ({
                   general : {
-                            'shift+a': [ () => a = true ]
+                            ' key : shift+a': [ () => a = true ]
                         }
                 , extra : {    
-                            'shift+a,p,r,o,b,a,ctrl+m' : () => b = true 
+                            'key:shift+a,p,r,o,b,a,ctrl+m' : () => b = true 
                         }
         })
 
 
+
 describe ( 'Shortcuts', () => {
 
 beforeEach ( () => {
@@ -30,182 +37,210 @@ beforeEach ( () => {
 
 
 
-it ( 'Simple shortcut', done => {
-            let res = false;
+it ( 'Shortcut if no plugin installed', done => {
             short.changeContext ( 'general' )
-            cy.get('body').type ( '{shift}a' )
-            cy.wait ( 30 )   // Default wait sequence timeout is 480 ms, but maxSequence is 1, so we don't need to wait for timeout
-              .then ( () => { 
-                                expect ( a ).to.be.true 
-                                done ()
-                        })            
-    }) // it first test
+            let r = short.listShortcuts ('general')
+            expect ( r[0]).to.equal ( ' key : shift+a' ) // Shortcut name is the same as it was set
+            done ()
+    }) // it no plugin installed
 
 
 
-it ( 'Check context switching and shortcut sequences', done => {
-    expect ( a ).to.be.false
-    expect ( b ).to.be.false
-    
-    short.changeContext ( 'extra' )
-    cy.get('body').type ( '{shift}a' )
-    cy.wait ( 500 )   // Default wait sequence timeout is 480 ms. Context 'extra' has a sequence of 7 keys. Need to wait for timeout
-      .then ( () => {
-                        expect ( a ).to.be.false
-                        
-                        cy.get('body')
-                                .type ( '{shift}a' )
-                                .type('proba')
-                                .type('{ctrl}M')
-                        return cy.wait ( 1 )   // Shortuct sequence is 7 keys - the maximum number of keys for this context. Don't need to wait for timeout
-            })
-      .then ( () => {
-                        expect ( b ).to.be.true
+it ( 'Key plugin, no context selected', done => {
+            short.enablePlugin ( pluginKey )
+            const r = short.listShortcuts ( 'general' )
+            expect ( r[0] ).to.equal ( 'KEY:A+SHIFT' ) // Shortcut name is recognized by plugin and is normalized
+            done ()
+    }) // it key plugin installed, no context selected
+
 
-                        short.changeContext ( 'general' )
-                        cy.get('body').type ( '{shift}a' )
-                        return cy.wait ( 2 )  // Context 'general' has a sequence of 1 key. Don't need to wait for timeout
-                })
-        .then ( () => {
-                        expect ( a ).to.be.true
-                        done ()
-                })
-}) // it context and shortcut sequences
+
+it ( 'Key plugin with context selected', done => {
+            short.enablePlugin ( pluginKey )
+            short.changeContext ( 'general' )
+            const r = short.listShortcuts ('general')
+            expect ( r[0] ).to.equal ( 'KEY:A+SHIFT' ) // Shortcut name is recognized by plugin and is normalized
+            cy.wait ( 1 )
+                .then ( () => done () )
+    }) // it key plugin installed with context selected
+
+
+
+it ( 'Simple shortcut', done => {
+        short.enablePlugin  ( pluginKey  )
+        short.changeContext ( )
+        short.changeContext ( 'general'  )
+        cy.get('body').type ( '{shift}a' )
+        cy.wait ( 1 )   // Default wait sequence timeout is 480 ms, but maxSequence is 1, so we don't need to wait for timeout
+          .then ( () => { 
+                            expect ( a ).to.be.true 
+                            done ()
+                    })
+    }) // it simple shortcut
+
+
+
+it ( 'Call sequence shortcut', done => {
+        b = false
+        short.enablePlugin ( pluginKey )
+        short.changeContext ( 'general' )
+        short.changeContext ( 'extra' )
+        
+        cy.get('body')
+          .type ( '{shift}a' )
+          .type ( 'proba' )
+          .type ( '{ctrl}M' )
+       
+        cy.wait ( 1 )   // Default wait sequence timeout is 480 ms, but maxSequence is 1, so we don't need to wait for timeout
+          .then ( () => { 
+                            expect ( b ).to.be.true
+                            done ()
+                    })                      
+    }) // it call sequence shortcut
 
 
 
 it ( 'Single mouse click', done => {
-    expect ( a ).to.be.false
-    expect ( b ).to.be.false
-    short.load ({ 'extra' : { 
-                            'mouse-click-left-1' : () => a = true 
-                        } 
+        expect ( a ).to.be.false
+        expect ( b ).to.be.false
+        short.enablePlugin ( pluginClick )
+        
+        short.load ({ 'extra' : { 
+                                ' cLIck  : left - 1 ' : () => a = true   // Check if spaces, letter case can break the shortcut recognition
+                            }
+                })
+        short.changeContext ( 'extra' )
+        cy.get('#rspan').click ()
+        cy.wait ( 10 ) // Default wait mouse timeout is 320 ms, but maxClicks is 1, so we don't need to wait for timeout
+          .then ( () => {
+                expect ( a ).to.be.true 
             })
-    short.changeContext ( 'extra' )
-    cy.get('#rspan').click ()
-    cy.wait ( 10 ) // Default wait mouse timeout is 320 ms, but maxClicks is 1, so we don't need to wait for timeout
-      .then ( () => expect ( a ).to.be.true )
-    cy.wait ( 300 ) // ...but mouseIgnore still active, so we better wait to not interfere with next test
-      .then ( () => done() )
-}) // it mouse click
+        cy.wait ( 1 ) // ...but mouseIgnore still active, so we better wait to not interfere with next test
+          .then ( () => done() )
+    }) // it mouse click
 
 
 
 it ( 'Double mouse click', done => {
-    expect ( a ).to.be.false
-    expect ( b ).to.be.false
-    
-    short.changeContext ( 'extra' )
-    
-    short.load ({   
-                    'extra' : {   // load will overwrite existing 'extra' context definition
-                                  'mouse-click-left-2' : () => a = true
-                              } 
-                }) // load will restart the selected context
-                   
-    cy.get('#rspan').click().click ().click () // Third click is ignored. Max clicks according definition is 2.
-    cy.wait ( 350 ) // Default wait mouse timeout is 320 ms
-      .then ( () => {
-                    expect ( a ).to.be.true
-                    done ()
-        })
-}) // it double mouse click
-
+        expect ( a ).to.be.false
+        expect ( b ).to.be.false
+
+        short.enablePlugin ( pluginClick )
+        short.changeContext ( 'extra' )
+        
+        short.load ({   
+                        'extra' : {   // load will overwrite existing 'extra' context definition
+                                      'click: left-2' : () => a = true
+                                  } 
+                    }) // load will restart the selected context
+                       
+        cy.get('#rspan').click().click ().click () // Third click is ignored. Max clicks according definition is 2.
+        cy.wait ( 1 ) // Default wait mouse timeout is 320 ms
+          .then ( () => {
+                        expect ( a ).to.be.true
+                        done ()
+            })
+    }) // it double mouse click
 
 
-it ( 'Emit custom event', () => {
-      let result = null;
-      const myAllContext = { 
-                              myAll: {
-                                        'mouse-click-leff-1' : () =>  console.log ( 'nothing' )
-                                      , '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.enablePlugin ( pluginClick )
+        short.setDependencies ({ task })
+        
+        short.load ({   
+                        'extra' : {   // load will overwrite existing 'extra' context definition
+                                    '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 ( '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 ( 'Emit custom event', done => {
+        let result = null;
+        short.changeContext ()
+        short.enablePlugin ( pluginClick )
+        const myAllContext = { 
+                                myAll: {
+                                          'click : leff-1' : () =>  console.log ( 'nothing' )
+                                         , 'yo' : ({msg}) => result = msg
+                                    }}
+        short.load ( myAllContext )
+        short.changeContext ( 'myAll' )
+        short.emit ( 'yo', { context: short.getContext(), note: 'tt', type:'custom', msg:'hello' })
+        expect ( result ).to.be.equal ( 'hello' )
+        short.changeContext ( 'general' )
+        short.unload ( 'myAll' )
+        done ()
+    }) // it emit custom event
 
 
 
 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' )
+        let general =  short.listShortcuts ('general');
+        expect ( general ).to.be.an('array')
+        expect ( general ).to.have.lengthOf ( 1 )
+        expect ( general[0] ).to.be.equal ( 'KEY:A+SHIFT' )
+        
+        let fail = short.listShortcuts ('somethingNotExisting');
+        expect ( fail ).to.be.null
     
-}) // it list shortcuts
+        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 ( 'KEY: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
+        // Click on anchor that don't have click-data attribute.
+        let result = 'none';
+        short.load ({ 'extra' : { 
+                                'click: 1 - left' : ({target, context, event }) => {   // Order of button name and number of click is not important
+                                            event.preventDefault ()
+                                            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/src/methods/_findTarget.js

@@ -1,19 +0,0 @@
-'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/methods/_listen.js

@@ -1,210 +0,0 @@
-'use strict'
-
-
-
-function _listen ( dependencies, state ) {
-// Listen for input signals and generate event titles
-return function _listen () {   
-    const { 
-                ev
-              , inAPI : {
-                          _findTarget
-                        , _specialChars
-                        , _readKeyEvent
-                        , _readMouseEvent
-                    }
-            } = dependencies
-        , {
-                  exposeShortcut
-                , currentContext
-                , streamKeys
-                , listenOptions
-            } = state
-        , {
-                  mouseWait
-                , keyWait
-                , clickTarget
-                , listenFor  
-            } = listenOptions
-        ;
-    
-    let 
-          r = []
-        , mouseTarget = null // Dom element or null
-        , mouseDomEvent = null
-        , keyTimer = null    // Timer for key sequence or null
-        , mouseTimer = null  // Timer for mouse sequence or null
-        , mouseIgnore = null // Timer for ignoring mouse clicks or null
-        , sequence = true
-        , ignore   = false   // Use to trigger a single callback without adding the key to the sequence.
-        , count    = 0
-        ;
-    
-
-
-
-    const  
-           waitKeys   = () => sequence = false  
-        ,  endKeys    = () => sequence = true  
-        , ignoreKeys  = () => ignore   = true
-        , waitingKeys = () => sequence === false
-        ;
-    
-
-
-    function keySequenceEnd () {   // Execute when key sequence ends
-                    let res =  r.map ( x => ([x.join('+')])   );
-                    if ( !sequence ) {
-                            let signal = res.at(-1);
-                            ev.emit ( signal, { wait:waitKeys, end:endKeys, ignore:ignoreKeys, isWaiting:waitingKeys, note: currentContext.note, context: currentContext.name })
-                            if ( ignore ) {
-                                        res = res.slice ( 0, -1 )
-                                        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(','), data )   
-                            if ( exposeShortcut )   exposeShortcut ({ shortcut:res.join(','), context: currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
-                            // Reset:
-                            r = []
-                            keyTimer = null
-                        }
-        } // keySequeceEnd func.
-
-
-
-    function mouseSequenceEnd () {   // Execute when mouse sequence ends
-                    const 
-                          mouseEvent = _readMouseEvent ( mouseDomEvent, count )
-                        , data = { 
-                                  target : mouseTarget
-                                , targetProps : mouseTarget ? mouseTarget.getBoundingClientRect() : null
-                                , x       : mouseDomEvent.clientX
-                                , y       : mouseDomEvent.clientY
-                                , context : currentContext.name
-                                , note    : currentContext.note
-                                , event   : mouseDomEvent
-                                , dependencies : dependencies.extra
-                            }
-                        ;
-                    ev.emit ( mouseEvent.join('+'), data )
-                    if ( exposeShortcut )   exposeShortcut ({ shortcut: mouseEvent.join('+'), context:currentContext.name, note:currentContext.note, dependencies:dependencies.extra })
-                    // Reset:
-                    mouseTimer = null
-                    mouseIgnore = null
-                    mouseTarget = null
-                    mouseDomEvent = null
-                    count = 0
-        } // mouseSequenceEnd func.
-
-
-
-    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 ) {
-                                                    clearTimeout ( mouseIgnore )
-                                                    mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
-                                                    return
-                                            }
-                                        mouseTarget = _findTarget ( event.target )
-                                        if ( mouseTarget && mouseTarget.dataset.hasOwnProperty('quickClick'))   targetMax = 1
-                                        if ( mouseTarget && mouseTarget.tagName === 'A'                     )   targetMax = 1
-                                        mouseDomEvent = event
-                                        count++
-                                        if ( count >= targetMax ) {  
-                                                    mouseSequenceEnd ()
-                                                    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 ) {
-                                                    clearTimeout ( mouseIgnore )
-                                                    mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
-                                                    return
-                                            }
-                                        mouseTarget = _findTarget ( event.target )
-                                        if ( mouseTarget && mouseTarget.dataset.hasOwnProperty('quickClick'))   targetMax = 1
-                                        if ( mouseTarget && mouseTarget.tagName === 'A'                     )   targetMax = 1
-                                        mouseDomEvent = event
-                                        count++
-                                        if ( count >= targetMax ) {
-                                                    mouseSequenceEnd ()
-                                                    if ( targetMax > 1 )   mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
-                                                    return
-                                            }
-                                        mouseTimer = setTimeout ( mouseSequenceEnd, mouseWait )
-                                })
-        } // listenMouse func.
-
-
-
-    function listenKeyboard () {
-                        document.addEventListener ( 'keydown', event => {   // Listen for special keyboard keys
-                                        clearTimeout ( keyTimer )
-                                        if ( _specialChars.hasOwnProperty(event.code) )   r.push ( _readKeyEvent ( event, _specialChars ))
-                                        else                                             return
-                                        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 === listenOptions.maxSequence ) {                                                    
-                                                    keySequenceEnd ()
-                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
-                                                    return
-                                            }
-                                        if ( sequence   )   keyTimer = setTimeout ( keySequenceEnd, keyWait )
-                                        else                keySequenceEnd ()
-                                })
-
-                        document.addEventListener ( 'keypress', event => {  // Listen for regular keyboard keys
-                                        if ( _specialChars.hasOwnProperty(event.code) )   return            
-                                        clearTimeout ( keyTimer )
-                                        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 === listenOptions.maxSequence ) {
-                                                    keySequenceEnd ()
-                                                    listenOptions.keyIgnore = setTimeout ( () => listenOptions.keyIgnore=null, keyWait )
-                                                    return
-                                            }
-                                        if ( sequence )   keyTimer = setTimeout ( keySequenceEnd, keyWait )
-                                        else              keySequenceEnd ()
-                                })
-        } // listenKeyboard func.
-    
-    
-
-    if ( listenFor.includes('mouse')    )   listenMouse ()
-    if ( listenFor.includes('keyboard') )   listenKeyboard ()
-
-}} // _listen func.
-
-
-
-export default _listen
-
-

package/src/methods/_readMouseEvent.js

@@ -1,24 +0,0 @@
-'use strict'
-
-function _readMouseEvent () {
-return function _readMouseEvent ( event, count ) {
-    let
-          { shiftKey, altKey, ctrlKey, key, button } = event
-        , mouseNames = [ 'LEFT', 'MIDDLE', 'RIGHT' ]
-        , mouseEvent = `MOUSE-CLICK-${mouseNames[button]}-${count}`
-        , res = []
-        ;
-    
-    res.push ( mouseEvent )
-    if ( ctrlKey )   res.push ( 'CTRL' )
-    if ( shiftKey )  res.push ( 'SHIFT' )
-    if ( altKey )    res.push ( 'ALT' )
-
-    return res.sort ()
-}} // _readMouseEvent func.
-
-
-
-export default _readMouseEvent
-
-