@peter.naydenov/shortcuts 3.5.1 → 3.5.2

package/Changelog.md

@@ -2,6 +2,11 @@
 
 
 
+### 3.5.2 ( 2025-10-20 )
+- [x] Types update;
+
+
+
 ### 3.5.1 ( 2025-10-20 )
 - [x] Update in package.json. Field 'types' was added;
 

package/dist/plugins/click/index.d.ts

@@ -1,4 +1,30 @@
 export default pluginClick;
+export type PluginAPI = {
+    /**
+     * - Get plugin prefix
+     */
+    getPrefix: () => string;
+    /**
+     * - Format shortcut name
+     */
+    shortcutName: (arg0: string) => string;
+    /**
+     * - Handle context change
+     */
+    contextChange: (arg0: string) => void;
+    /**
+     * - Mute the plugin
+     */
+    mute: () => void;
+    /**
+     * - Unmute the plugin
+     */
+    unmute: () => void;
+    /**
+     * - Destroy the plugin
+     */
+    destroy: () => void;
+};
 /**
  * @function pluginClick
  * @description Plugin for mouse click shortcuts

package/dist/plugins/form/index.d.ts

@@ -1,4 +1,30 @@
 export default pluginForm;
+export type PluginAPI = {
+    /**
+     * - Get plugin prefix
+     */
+    getPrefix: () => string;
+    /**
+     * - Format shortcut name
+     */
+    shortcutName: (arg0: string) => string;
+    /**
+     * - Handle context change
+     */
+    contextChange: (arg0: string) => void;
+    /**
+     * - Mute the plugin
+     */
+    mute: () => void;
+    /**
+     * - Unmute the plugin
+     */
+    unmute: () => void;
+    /**
+     * - Destroy the plugin
+     */
+    destroy: () => void;
+};
 /**
  * @function pluginForm
  * @description Plugin for form element shortcuts

package/dist/plugins/key/index.d.ts

@@ -1,4 +1,30 @@
 export default pluginKey;
+export type PluginAPI = {
+    /**
+     * - Get plugin prefix
+     */
+    getPrefix: () => string;
+    /**
+     * - Format shortcut name
+     */
+    shortcutName: (arg0: string) => string;
+    /**
+     * - Handle context change
+     */
+    contextChange: (arg0: string) => void;
+    /**
+     * - Mute the plugin
+     */
+    mute: () => void;
+    /**
+     * - Unmute the plugin
+     */
+    unmute: () => void;
+    /**
+     * - Destroy the plugin
+     */
+    destroy: () => void;
+};
 /**
  * @function pluginKey
  * @description Plugin for keyboard shortcuts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@peter.naydenov/shortcuts",
   "description": "Context control of shortcuts based on keyboard and mouse events",
-  "version": "3.5.1",
+  "version": "3.5.2",
   "license": "MIT",
   "author": "Peter Naydenov",
   "main": "./dist/shortcuts.umd.js",

package/src/plugins/click/index.js

@@ -1,5 +1,15 @@
 'use strict'
 
+/**
+ * @typedef {Object} PluginAPI
+ * @property {function(): string} getPrefix - Get plugin prefix
+ * @property {function(string): string} shortcutName - Format shortcut name
+ * @property {function(string): void} contextChange - Handle context change
+ * @property {function(): void} mute - Mute the plugin
+ * @property {function(): void} unmute - Unmute the plugin
+ * @property {function(): void} destroy - Destroy the plugin
+ */
+
 import _findTarget              from "./_findTarget"
 import _listenDOM              from "./_listenDOM"
 import _normalizeShortcutName  from "./_normalizeShortcutName"

package/src/plugins/form/index.js

@@ -1,5 +1,15 @@
 'use strict'
 
+/**
+ * @typedef {Object} PluginAPI
+ * @property {function(): string} getPrefix - Get plugin prefix
+ * @property {function(string): string} shortcutName - Format shortcut name
+ * @property {function(string): void} contextChange - Handle context change
+ * @property {function(): void} mute - Mute the plugin
+ * @property {function(): void} unmute - Unmute the plugin
+ * @property {function(): void} destroy - Destroy the plugin
+ */
+
 // import all plugin files here
 import _listenDOM from './_listenDOM.js'
 import _normalizeShortcutName from './_normalizeShortcutName.js'

package/src/plugins/key/index.js

@@ -1,5 +1,15 @@
 'use strict'
 
+/**
+ * @typedef {Object} PluginAPI
+ * @property {function(): string} getPrefix - Get plugin prefix
+ * @property {function(string): string} shortcutName - Format shortcut name
+ * @property {function(string): void} contextChange - Handle context change
+ * @property {function(): void} mute - Mute the plugin
+ * @property {function(): void} unmute - Unmute the plugin
+ * @property {function(): void} destroy - Destroy the plugin
+ */
+
 // import all plugin files here
 import _listenDOM              from './_listenDOM.js'
 import _normalizeShortcutName  from './_normalizeShortcutName.js'