@peter.naydenov/shortcuts 4.0.1 → 4.1.0

package/src/main.js

@@ -100,7 +100,7 @@ function main ( options = {} ) {
     const  
           inAPI = {}      // API for internal methods
         , API   = {}      // API for public methods
-        ,  ev = notice ()  // Event emitter instance
+        , ev    = notice ()  // Event emitter instance
         , state = {
                       currentContext   : { name: null, note: null } // Context data container
                     , shortcuts        : {}   // shortcuts = { contextName : { shortcut :  callback[] } }
@@ -113,7 +113,7 @@ function main ( options = {} ) {
                               ev
                             , inAPI
                             , API
-                            , extra : {}
+                            , extra : { emit: ev.emit }
                         };
 
     // ----------------------  > PLUGIN METHODS < ---------------------- //
@@ -232,10 +232,10 @@ function main ( options = {} ) {
      * @function emit
      * @description Emit event for shortcut in current context
      * @param {string} name - Shortcut name
-     * @param {any} [args] - Arguments for callback function
+     * @param {...any} [args] - Arguments forwarded to the shortcut callback as additional positional parameters
      * @returns {void}
      **/
-    API.emit = (name,...args) =>  ev.emit ( inAPI._readShortcutWithPlugins ( name ), ...args )
+    API.emit = (name,...args) =>  ev.emit ( inAPI._readShortcutWithPlugins ( name ), { dependencies: dependencies.extra, type: 'custom' }, ...args )
       
 
     /**
@@ -273,7 +273,7 @@ function main ( options = {} ) {
                         API.changeContext ()
                         state.plugins.forEach ( plugin => plugin.destroy () )
                         API.listContexts ().map ( cx =>  API.unload ( cx ))
-                        dependencies.extra = {}
+                        dependencies.extra = { emit: ev.emit }
                         state.exposeShortcut = null
       } // reset func.
 

package/src/plugins/click/_listenDOM.js

@@ -16,7 +16,7 @@
  * @property {string|null} note - Current context note
  * @property {Object} options - Plugin state listenOptions (reference to pluginState.listenOptions)
  * @property {Event} event - The original DOM event
- * @property {Object} dependencies - Extra dependencies object
+ * @property {Object} dependencies - Reference to the library's `extra` bag. Always includes `emit: ev.emit` plus any keys you set via `short.setDependencies({...})`
  * @property {Object} viewport - Viewport information with X, Y, width, height
  * @property {Object} sizes - Element dimensions with width, height
  * @property {Object} position - Element position relative to viewport with x, y
@@ -24,9 +24,9 @@
  * @property {string} type - Event type ('click')
  */
 function _listenDOM ( dependencies, state ) {
-        const { 
+        const {
                    ev
-                , _findTarget 
+                , _findTarget
                 , _readClickEvent
                 , extra
                         } = dependencies

package/src/plugins/form/_listenDOM.js

@@ -14,19 +14,20 @@
  * @property {string} context - Current context name
  * @property {string|null} note - Current context note
  * @property {Event} event - The original DOM event
- * @property {Object} dependencies - Extra dependencies object
+ * @property {Object} dependencies - Reference to the library's `extra` bag. Always includes `emit: ev.emit` plus any keys you set via `short.setDependencies({...})`
  * @property {Object} options - Plugin state listenOptions (reference to pluginState.listenOptions)
  * @property {Object} viewport - Viewport information with X, Y, width, height
  * @property {Object} sizes - Element dimensions with width, height
  * @property {Object} position - Element position relative to viewport with x, y
  * @property {Object} pagePosition - Element position relative to page with x, y
- * @property {string} type - Event type ('form-in', 'form-out', 'form-instant')
+ * @property {string} type - Event type ('form'). The timing (in/out/instant) lives in the emitted event name (e.g. `email/in`, `email/instant`)
  */
 function _listenDOM ( dependencies, state ) {
         const { ev } = dependencies;
         let timeout = null; 
 
         function setupData ( dependencies, state, event, type) {
+                const { extra } = dependencies;
                 const 
                       { left, top, width, height } = event.target.getBoundingClientRect ()
                     , scrollX = window.scrollX
@@ -37,7 +38,7 @@ function _listenDOM ( dependencies, state ) {
                         , context : state.currentContext.name
                         , note    : state.currentContext.note
                         , event   
-                        , dependencies : dependencies.extra
+                        , dependencies : extra
                         , options : state.listenOptions
                         , viewport : {                                     // Viewport scroll positions and sizes
                                   X:scrollX
@@ -56,7 +57,7 @@ function _listenDOM ( dependencies, state ) {
                 const 
                       { callbacks, typeFn } = state
                     , target = event.target
-                    , prop = setupData ( dependencies, state, event, "form-in" )
+                    , prop = setupData ( dependencies, state, event, "form" )
                     , type = typeFn ( prop )
                     , key = `${type}/in`
                     ;
@@ -67,7 +68,7 @@ function _listenDOM ( dependencies, state ) {
         function listenFocusOut ( event ) {  // Timing: out
                 const
                       { callbacks, typeFn } = state
-                    , prop   = setupData ( dependencies, state, event, "form-out" )
+                    , prop   = setupData ( dependencies, state, event, "form" )
                     , type   = typeFn ( prop )
                     , key    = `${type}/out`
                     ;
@@ -79,7 +80,7 @@ function _listenDOM ( dependencies, state ) {
         function listenInput ( event ) {   // Timing: instant
                 const 
                       { callbacks, typeFn } = state
-                    , prop   = setupData ( dependencies, state, event, "form-instant" )
+                    , prop   = setupData ( dependencies, state, event, "form" )
                     , type   = typeFn ( prop )
                     , wait   = state.wait[`${type}`]
                     , key    = `${type}/instant`

package/src/plugins/hover/_listenDOM.js

@@ -11,7 +11,7 @@
  * @property {string} context - Current context name
  * @property {string|null} note - Current context note
  * @property {Event} event - The original DOM event
- * @property {Object} dependencies - Extra dependencies object
+ * @property {Object} dependencies - Reference to the library's `extra` bag. Always includes `emit: ev.emit` plus any keys you set via `short.setDependencies({...})`
  * @property {Object} options - Plugin state listenOptions (reference to pluginState.listenOptions)
  * @property {Object} viewport - Viewport information with X, Y, width, height
  * @property {Object} sizes - Element dimensions with width, height
@@ -68,7 +68,7 @@ function listenForHover ( event ) {
                         ;
 
                     return {
-                                target : tg
+                                  target : tg
                                 , context: state.currentContext.name
                                 , note   : state.currentContext.note
                                 , event

package/src/plugins/key/_listenDOM.js

@@ -16,14 +16,14 @@
  * @property {Function} isWaiting - Function to check if currently waiting for keys
  * @property {string|null} note - Current context note
  * @property {string} context - Current context name
- * @property {Object} dependencies - Extra dependencies object
+ * @property {Object} dependencies - Reference to the library's `extra` bag. Always includes `emit: ev.emit` plus any keys you set via `short.setDependencies({...})`
  * @property {Object} options - Plugin state listenOptions (reference to pluginState.listenOptions)
  * @property {Object} viewport - Viewport information with X, Y, width, height
  * @property {string} type - Event type ('key')
  */
 function _listenDOM ( dependencies, state ) {
 // Listen for input signals and generate event titles
-    const { 
+    const {
                   ev
                 , _specialChars
                 , _readKeyEvent
@@ -67,11 +67,11 @@ function _listenDOM ( dependencies, state ) {
                                     , context: currentContext.name
                                     , dependencies : extra
                                     , options : state.listenOptions
-                                    , viewport : { 
+                                    , viewport : {
                                               X : window.scrollX
                                             , Y : window.scrollY
                                             , width:window.innerWidth
-                                            , height:window.innerHeight 
+                                            , height:window.innerHeight
                                         }
                                     , type : 'key'
                             };

package/src/plugins/scroll/_listenDOM.js

@@ -13,7 +13,7 @@
  * @property {string} direction - Scroll direction ('up', 'down', 'left', 'right')
  * @property {string} context - Current context name
  * @property {string|null} note - Current context note
- * @property {Object} dependencies - Extra dependencies object
+ * @property {Object} dependencies - Reference to the library's `extra` bag. Always includes `emit: ev.emit` plus any keys you set via `short.setDependencies({...})`
  * @property {Object} options - Plugin state listenOptions (reference to pluginState.listenOptions)
  * @property {Object} viewport - Viewport information with X, Y, width, height
  * @property {string} type - Event type ('scroll')

package/test/01-general.test.js

@@ -218,7 +218,7 @@ describe ( "Shortcuts", () => {
                             const myAllContext = { 
                                                     myAll: {
                                                             'click : leff-1' : () => 'nothing'
-                                                            , 'yo' : ({msg}) => result = msg
+                                                            , 'yo' : (x,{msg}) => result = msg
                                                         }}
                             short.load ( myAllContext )
                             short.changeContext ( 'myAll' )    

package/test/02-key.test.js

@@ -464,10 +464,54 @@ describe ( 'Key plugin', () => {
                               expect ( emit[0] ).to.equal ( 'setup' )
                               
                               // Click and measure time
-                              await userEvent.keyboard ( 'a')                       
+                              await userEvent.keyboard ( 'a' )
                               await waitFor ( () => {
                                           expect ( emit ).to.deep.equal ( [ 'setup', 'a' ] )
                                     }, { timeout: 1000, interval: 12 })
                   }) // it extra parameters to plugin options
 
+
+
+    it ( 'Key callback data contains emit property', async () => {
+                    let captured = null
+                    short.enablePlugin ( pluginKey )
+                    short.load ({
+                                'local' : {
+                                          'key: a' : ( data ) => captured = data
+                                    }
+                          })
+                    short.changeContext ( 'local' )
+                    await userEvent.keyboard ( 'a' )
+                    await wait ( 20 )
+                    await waitFor ( () => {
+                                const { emit } = captured.dependencies;
+                                expect ( captured ).toBeTruthy ()
+                                expect ( typeof emit ).toBe ( 'function' )
+                          }, { timeout: 1000, interval: 12 })
+          }) // it key callback data contains emit property
+
+
+
+    it ( 'Key callback can emit other events via data.dependencies.emit (workflow)', async () => {
+                    const log = []
+                    short.enablePlugin ( pluginKey )
+                    short.load ({
+                                'local' : {
+                                          'key: a' : ( k ) => {
+                                                          log.push ( 'a-fired' )
+                                                          k.dependencies.emit ( '@hidden' )
+                                                  }
+                                        , '@hidden' : () => {
+                                                          log.push ( 'hidden-fired' )
+                                                  }
+                                    }
+                          })
+                    short.changeContext ( 'local' )
+                    await userEvent.keyboard ( 'a' )
+                    await wait ( 50 )
+                    await waitFor ( () => {
+                                expect ( log ).to.deep.equal ( [ 'a-fired', 'hidden-fired' ] )
+                          }, { timeout: 1000, interval: 12 })
+          }) // it key callback workflow
+
 })

package/test/03-click.test.js

@@ -587,10 +587,59 @@ describe ( 'Click plugin', () => {
                         const target = document.querySelector ( '[data-hover="blue"]' );
                         
                         // Click and measure time
-                        await userEvent.click ( target )                        
+                        await userEvent.click ( target )
                         await waitFor ( () => {
                                     expect ( emit ).to.deep.equal ( [ 'setup', 'clicked' ] )
                               }, { timeout: 1000, interval: 12 })
             }) // it extra parameters to plugin options
-   
+
+
+
+        it ( 'Click callback data contains emit property', async () => {
+                        let captured = null
+                        short.enablePlugin ( pluginClick )
+                        short.load ({
+                                        'local' : {
+                                                  'click: left-1' : ( data ) => {
+                                                                        captured = data
+                                                                  }
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        const megaBtn = document.querySelector ( '[data-click="mega"]' )
+                        expect ( megaBtn ).to.not.be.null
+                        await userEvent.click ( megaBtn )
+                        await wait ( 50 )
+                        await waitFor ( () => {
+                                        expect ( captured ).toBeTruthy ()
+                                        expect ( typeof captured.dependencies.emit ).toBe ( 'function' )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it click callback data contains emit property
+
+
+
+        it ( 'Click callback can emit other events via data.dependencies.emit (workflow)', async () => {
+                        const log = []
+                        short.enablePlugin ( pluginClick )
+                        short.load ({
+                                        'local' : {
+                                                  'click: left-1' : ( data ) => {
+                                                                        log.push ( 'left-1-fired' )
+                                                                        data.dependencies.emit ( 'CLICK:RIGHT-1' )
+                                                                  }
+                                                , 'click: right-1' : () => {
+                                                                        log.push ( 'right-1-fired' )
+                                                                  }
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        const megaBtn = document.querySelector ( '[data-click="mega"]' )
+                        expect ( megaBtn ).to.not.be.null
+                        await userEvent.click ( megaBtn )
+                        await wait ( 50 )
+                        await waitFor ( () => {
+                                        expect ( log ).to.deep.equal ( [ 'left-1-fired', 'right-1-fired' ] )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it click callback workflow
+
  }) // describe

package/test/04-form.test.js

@@ -323,5 +323,30 @@ describe ( 'Form plugin', () => {
                                 expect ( emit ).to.includes ( 'executed' )
                         }, { timeout: 1000, interval: 12 })
         }) // it Extra parameters to plugin options
-       
+
+
+
+        it ( 'Form action fn receives emit property on data', async () => {
+                        let captured = null
+                        short.enablePlugin ( pluginForm )
+                        short.load ({
+                                        'local' : {
+                                                  'form: action' : () => [{
+                                                                fn : ( data ) => { captured = data }
+                                                                , type : 'input'
+                                                                , timing : 'in'
+                                                        }]
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        const input = document.getElementById ( 'name' )
+                        expect ( input ).to.not.be.null
+                        input.focus ()
+                        await wait ( 80 )
+                        await waitFor ( () => {
+                                        expect ( captured ).toBeTruthy ()
+                                        expect ( typeof captured.dependencies.emit ).toBe ( 'function' )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it form action fn data contains emit property
+
 }) // describe

package/test/05-hover.test.js

@@ -458,6 +458,54 @@ describe ( 'Hover plugin', () => {
                               }, { timeout: 1000, interval: 12 })
             }) // it extra parameters to plugin options
 
-      
-   
+
+
+      it ( 'Hover callback data contains emit property', async () => {
+                        let captured = null
+                        short.enablePlugin ( pluginHover )
+                        short.load ({
+                                        'local' : {
+                                                  'hover : on' : ( data ) => {
+                                                                        captured = data
+                                                                  }
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        const megaBtn = document.querySelector ( '[data-click="mega"]' )
+                        expect ( megaBtn ).to.not.be.null
+                        await userEvent.hover ( megaBtn )
+                        await wait ( 340 )
+                        await waitFor ( () => {
+                                        expect ( captured ).toBeTruthy ()
+                                        expect ( typeof captured.dependencies.emit ).toBe ( 'function' )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it hover callback data contains emit property
+
+
+
+      it ( 'Hover callback can emit other events via data.dependencies.emit (workflow)', async () => {
+                        const log = []
+                        short.enablePlugin ( pluginHover )
+                        short.load ({
+                                        'local' : {
+                                                  'hover : on' : ( data ) => {
+                                                                        log.push ( 'on-fired' )
+                                                                        data.dependencies.emit ( 'HOVER:OFF' )
+                                                                  }
+                                                , 'hover : off' : () => {
+                                                                        log.push ( 'off-fired' )
+                                                                  }
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        const megaBtn = document.querySelector ( '[data-click="mega"]' )
+                        expect ( megaBtn ).to.not.be.null
+                        await userEvent.hover ( megaBtn )
+                        await wait ( 340 )
+                        await waitFor ( () => {
+                                        expect ( log[0] ).toBe ( 'on-fired' )
+                                        expect ( log ).to.includes ( 'off-fired' )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it hover callback workflow
+
  }) // describe

package/test/06-scroll.test.js

@@ -371,4 +371,25 @@ it ( 'Disable a plugin', () => {
                         expect ( scrollEvents.length ).to.be.greaterThan ( 0 )
             }) // it extra parameters to plugin options
 
+
+
+      it ( 'Scroll callback data contains emit property', async () => {
+                        let captured = null
+                        short.enablePlugin ( pluginScroll )
+                        short.load ({
+                                        'local' : {
+                                                  'scroll: down' : ( data ) => {
+                                                                        captured = data
+                                                                  }
+                                            }
+                                })
+                        short.changeContext ( 'local' )
+                        window.scrollTo ( 0, 100 )
+                        await wait ( 200 )
+                        await waitFor ( () => {
+                                        expect ( captured ).toBeTruthy ()
+                                        expect ( typeof captured.dependencies.emit ).toBe ( 'function' )
+                                }, { timeout: 1000, interval: 12 })
+                }) // it scroll callback data contains emit property
+
  }) // describe Scroll plugin