simple-keyboard 3.7.0 → 3.7.1

package/build/services/Utilities.d.ts

@@ -1,201 +1,201 @@
-import { KeyboardInput } from "./../interfaces";
-import { KeyboardOptions, UtilitiesParams } from "../interfaces";
-/**
- * Utility Service
- */
-declare class Utilities {
-    getOptions: () => KeyboardOptions;
-    getCaretPosition: () => number | null;
-    getCaretPositionEnd: () => number | null;
-    dispatch: any;
-    maxLengthReached: boolean;
-    /**
-     * Creates an instance of the Utility service
-     */
-    constructor({ getOptions, getCaretPosition, getCaretPositionEnd, dispatch, }: UtilitiesParams);
-    /**
-     * Retrieve button type
-     *
-     * @param  {string} button The button's layout name
-     * @return {string} The button type
-     */
-    getButtonType(button: string): string;
-    /**
-     * Adds default classes to a given button
-     *
-     * @param  {string} button The button's layout name
-     * @return {string} The classes to be added to the button
-     */
-    getButtonClass(button: string): string;
-    /**
-     * Default button display labels
-     */
-    getDefaultDiplay(): {
-        "{bksp}": string;
-        "{backspace}": string;
-        "{enter}": string;
-        "{shift}": string;
-        "{shiftleft}": string;
-        "{shiftright}": string;
-        "{alt}": string;
-        "{s}": string;
-        "{tab}": string;
-        "{lock}": string;
-        "{capslock}": string;
-        "{accept}": string;
-        "{space}": string;
-        "{//}": string;
-        "{esc}": string;
-        "{escape}": string;
-        "{f1}": string;
-        "{f2}": string;
-        "{f3}": string;
-        "{f4}": string;
-        "{f5}": string;
-        "{f6}": string;
-        "{f7}": string;
-        "{f8}": string;
-        "{f9}": string;
-        "{f10}": string;
-        "{f11}": string;
-        "{f12}": string;
-        "{numpaddivide}": string;
-        "{numlock}": string;
-        "{arrowup}": string;
-        "{arrowleft}": string;
-        "{arrowdown}": string;
-        "{arrowright}": string;
-        "{prtscr}": string;
-        "{scrolllock}": string;
-        "{pause}": string;
-        "{insert}": string;
-        "{home}": string;
-        "{pageup}": string;
-        "{delete}": string;
-        "{forwarddelete}": string;
-        "{end}": string;
-        "{pagedown}": string;
-        "{numpadmultiply}": string;
-        "{numpadsubtract}": string;
-        "{numpadadd}": string;
-        "{numpadenter}": string;
-        "{period}": string;
-        "{numpaddecimal}": string;
-        "{numpad0}": string;
-        "{numpad1}": string;
-        "{numpad2}": string;
-        "{numpad3}": string;
-        "{numpad4}": string;
-        "{numpad5}": string;
-        "{numpad6}": string;
-        "{numpad7}": string;
-        "{numpad8}": string;
-        "{numpad9}": string;
-    };
-    /**
-     * Returns the display (label) name for a given button
-     *
-     * @param  {string} button The button's layout name
-     * @param  {object} display The provided display option
-     * @param  {boolean} mergeDisplay Whether the provided param value should be merged with the default one.
-     */
-    getButtonDisplayName(button: string, display: KeyboardOptions["display"], mergeDisplay?: boolean): string;
-    /**
-     * Returns the updated input resulting from clicking a given button
-     *
-     * @param  {string} button The button's layout name
-     * @param  {string} input The input string
-     * @param  {number} caretPos The cursor's current position
-     * @param  {number} caretPosEnd The cursor's current end position
-     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
-     */
-    getUpdatedInput(button: string, input: string, caretPos: any, caretPosEnd?: any, moveCaret?: boolean): string;
-    /**
-     * Moves the cursor position by a given amount
-     *
-     * @param  {number} length Represents by how many characters the input should be moved
-     * @param  {boolean} minus Whether the cursor should be moved to the left or not.
-     */
-    updateCaretPos(length: number, minus?: boolean): void;
-    /**
-     * Action method of updateCaretPos
-     *
-     * @param  {number} length Represents by how many characters the input should be moved
-     * @param  {boolean} minus Whether the cursor should be moved to the left or not.
-     */
-    updateCaretPosAction(length: number, minus?: boolean): number | null;
-    /**
-     * Adds a string to the input at a given position
-     *
-     * @param  {string} source The source input
-     * @param  {string} str The string to add
-     * @param  {number} position The (cursor) position where the string should be added
-     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
-     */
-    addStringAt(source: string, str: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
-    /**
-     * Check whether the button is a standard button
-     */
-    isStandardButton: (button: string) => boolean | "";
-    /**
-     * Removes an amount of characters before a given position
-     *
-     * @param  {string} source The source input
-     * @param  {number} position The (cursor) position from where the characters should be removed
-     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
-     */
-    removeAt(source: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
-    /**
-     * Removes an amount of characters after a given position
-     *
-     * @param  {string} source The source input
-     * @param  {number} position The (cursor) position from where the characters should be removed
-     */
-    removeForwardsAt(source: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
-    /**
-     * Determines whether the maxLength has been reached. This function is called when the maxLength option it set.
-     *
-     * @param  {object} inputObj
-     * @param  {string} updatedInput
-     */
-    handleMaxLength(inputObj: KeyboardInput, updatedInput: string): boolean | undefined;
-    /**
-     * Gets the current value of maxLengthReached
-     */
-    isMaxLengthReached(): boolean;
-    /**
-     * Determines whether a touch device is being used
-     */
-    isTouchDevice(): number | true;
-    /**
-     * Determines whether pointer events are supported
-     */
-    pointerEventsSupported(): boolean;
-    /**
-     * Bind all methods in a given class
-     */
-    static bindMethods(myClass: any, instance: any): void;
-    /**
-     * Transforms an arbitrary string to camelCase
-     *
-     * @param  {string} str The string to transform.
-     */
-    camelCase(str: string): string;
-    /**
-     * Split array into chunks
-     */
-    chunkArray<T>(arr: T[], size: number): T[][];
-    /**
-     * Escape regex input
-     */
-    escapeRegex(str: string): string;
-    /**
-     * Calculate caret position offset when using rtl option
-     */
-    getRtlOffset(index: number, input: string): number;
-    /**
-     * Reusable empty function
-     */
-    static noop: () => void;
-}
-export default Utilities;
+import { KeyboardInput } from "./../interfaces";
+import { KeyboardOptions, UtilitiesParams } from "../interfaces";
+/**
+ * Utility Service
+ */
+declare class Utilities {
+    getOptions: () => KeyboardOptions;
+    getCaretPosition: () => number | null;
+    getCaretPositionEnd: () => number | null;
+    dispatch: any;
+    maxLengthReached: boolean;
+    /**
+     * Creates an instance of the Utility service
+     */
+    constructor({ getOptions, getCaretPosition, getCaretPositionEnd, dispatch, }: UtilitiesParams);
+    /**
+     * Retrieve button type
+     *
+     * @param  {string} button The button's layout name
+     * @return {string} The button type
+     */
+    getButtonType(button: string): string;
+    /**
+     * Adds default classes to a given button
+     *
+     * @param  {string} button The button's layout name
+     * @return {string} The classes to be added to the button
+     */
+    getButtonClass(button: string): string;
+    /**
+     * Default button display labels
+     */
+    getDefaultDiplay(): {
+        "{bksp}": string;
+        "{backspace}": string;
+        "{enter}": string;
+        "{shift}": string;
+        "{shiftleft}": string;
+        "{shiftright}": string;
+        "{alt}": string;
+        "{s}": string;
+        "{tab}": string;
+        "{lock}": string;
+        "{capslock}": string;
+        "{accept}": string;
+        "{space}": string;
+        "{//}": string;
+        "{esc}": string;
+        "{escape}": string;
+        "{f1}": string;
+        "{f2}": string;
+        "{f3}": string;
+        "{f4}": string;
+        "{f5}": string;
+        "{f6}": string;
+        "{f7}": string;
+        "{f8}": string;
+        "{f9}": string;
+        "{f10}": string;
+        "{f11}": string;
+        "{f12}": string;
+        "{numpaddivide}": string;
+        "{numlock}": string;
+        "{arrowup}": string;
+        "{arrowleft}": string;
+        "{arrowdown}": string;
+        "{arrowright}": string;
+        "{prtscr}": string;
+        "{scrolllock}": string;
+        "{pause}": string;
+        "{insert}": string;
+        "{home}": string;
+        "{pageup}": string;
+        "{delete}": string;
+        "{forwarddelete}": string;
+        "{end}": string;
+        "{pagedown}": string;
+        "{numpadmultiply}": string;
+        "{numpadsubtract}": string;
+        "{numpadadd}": string;
+        "{numpadenter}": string;
+        "{period}": string;
+        "{numpaddecimal}": string;
+        "{numpad0}": string;
+        "{numpad1}": string;
+        "{numpad2}": string;
+        "{numpad3}": string;
+        "{numpad4}": string;
+        "{numpad5}": string;
+        "{numpad6}": string;
+        "{numpad7}": string;
+        "{numpad8}": string;
+        "{numpad9}": string;
+    };
+    /**
+     * Returns the display (label) name for a given button
+     *
+     * @param  {string} button The button's layout name
+     * @param  {object} display The provided display option
+     * @param  {boolean} mergeDisplay Whether the provided param value should be merged with the default one.
+     */
+    getButtonDisplayName(button: string, display: KeyboardOptions["display"], mergeDisplay?: boolean): string;
+    /**
+     * Returns the updated input resulting from clicking a given button
+     *
+     * @param  {string} button The button's layout name
+     * @param  {string} input The input string
+     * @param  {number} caretPos The cursor's current position
+     * @param  {number} caretPosEnd The cursor's current end position
+     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
+     */
+    getUpdatedInput(button: string, input: string, caretPos: any, caretPosEnd?: any, moveCaret?: boolean): string;
+    /**
+     * Moves the cursor position by a given amount
+     *
+     * @param  {number} length Represents by how many characters the input should be moved
+     * @param  {boolean} minus Whether the cursor should be moved to the left or not.
+     */
+    updateCaretPos(length: number, minus?: boolean): void;
+    /**
+     * Action method of updateCaretPos
+     *
+     * @param  {number} length Represents by how many characters the input should be moved
+     * @param  {boolean} minus Whether the cursor should be moved to the left or not.
+     */
+    updateCaretPosAction(length: number, minus?: boolean): number | null;
+    /**
+     * Adds a string to the input at a given position
+     *
+     * @param  {string} source The source input
+     * @param  {string} str The string to add
+     * @param  {number} position The (cursor) position where the string should be added
+     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
+     */
+    addStringAt(source: string, str: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
+    /**
+     * Check whether the button is a standard button
+     */
+    isStandardButton: (button: string) => boolean | "";
+    /**
+     * Removes an amount of characters before a given position
+     *
+     * @param  {string} source The source input
+     * @param  {number} position The (cursor) position from where the characters should be removed
+     * @param  {boolean} moveCaret Whether to update simple-keyboard's cursor
+     */
+    removeAt(source: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
+    /**
+     * Removes an amount of characters after a given position
+     *
+     * @param  {string} source The source input
+     * @param  {number} position The (cursor) position from where the characters should be removed
+     */
+    removeForwardsAt(source: string, position?: number, positionEnd?: number, moveCaret?: boolean): string;
+    /**
+     * Determines whether the maxLength has been reached. This function is called when the maxLength option it set.
+     *
+     * @param  {object} inputObj
+     * @param  {string} updatedInput
+     */
+    handleMaxLength(inputObj: KeyboardInput, updatedInput: string): boolean | undefined;
+    /**
+     * Gets the current value of maxLengthReached
+     */
+    isMaxLengthReached(): boolean;
+    /**
+     * Determines whether a touch device is being used
+     */
+    isTouchDevice(): number | true;
+    /**
+     * Determines whether pointer events are supported
+     */
+    pointerEventsSupported(): boolean;
+    /**
+     * Bind all methods in a given class
+     */
+    static bindMethods(myClass: any, instance: any): void;
+    /**
+     * Transforms an arbitrary string to camelCase
+     *
+     * @param  {string} str The string to transform.
+     */
+    camelCase(str: string): string;
+    /**
+     * Split array into chunks
+     */
+    chunkArray<T>(arr: T[], size: number): T[][];
+    /**
+     * Escape regex input
+     */
+    escapeRegex(str: string): string;
+    /**
+     * Calculate caret position offset when using rtl option
+     */
+    getRtlOffset(index: number, input: string): number;
+    /**
+     * Reusable empty function
+     */
+    static noop: () => void;
+}
+export default Utilities;

package/package.json

@@ -1,114 +1,114 @@
-{
-  "name": "simple-keyboard",
-  "version": "3.7.0",
-  "description": "On-screen Javascript Virtual Keyboard",
-  "main": "build/index.js",
-  "scripts": {
-    "start": "webpack serve --config webpack.config.demo.js",
-    "build": "webpack && npm run build-modern && npm run build-modern-esm && tsc",
-    "build-modern": "webpack --config webpack.config.modern.js",
-    "build-modern-esm": "webpack --config webpack.config.modern_esm.js",
-    "test": "jest --silent",
-    "coverage": "npm run test -- --coverage",
-    "prepare": "npm run build",
-    "trypublish": "npm publish || true"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/hodgef/simple-keyboard"
-  },
-  "author": "Francisco Hodge <hello@franciscohodge.com> (https://github.com/hodgef)",
-  "bugs": {
-    "url": "https://github.com/hodgef/simple-keyboard/issues"
-  },
-  "homepage": "https://virtual-keyboard.js.org/",
-  "keywords": [
-    "javascript",
-    "es6",
-    "digital",
-    "keyboard",
-    "onscreen",
-    "virtual",
-    "screen-keyboard",
-    "component",
-    "virtual-keyboard",
-    "touchscreen",
-    "touch-screen",
-    "kiosk",
-    "osk",
-    "js"
-  ],
-  "license": "MIT",
-  "devDependencies": {
-    "@babel/cli": "^7.22.10",
-    "@babel/core": "^7.22.10",
-    "@babel/plugin-proposal-class-properties": "^7.17.12",
-    "@babel/plugin-transform-typescript": "^7.22.10",
-    "@babel/polyfill": "^7.12.1",
-    "@babel/preset-env": "^7.22.10",
-    "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.62.0",
-    "autoprefixer": "^10.4.15",
-    "babel-eslint": "^10.1.0",
-    "babel-loader": "^9.1.3",
-    "babel-preset-minify": "^0.5.2",
-    "core-js": "^3.32.0",
-    "css-loader": "^6.8.1",
-    "css-minimizer-webpack-plugin": "^5.0.1",
-    "eslint": "^8.47.0",
-    "file-loader": "^6.2.0",
-    "html-webpack-plugin": "^5.5.3",
-    "jest": "^26.6.3",
-    "mini-css-extract-plugin": "^2.7.6",
-    "postcss": "^8.4.28",
-    "postcss-loader": "^7.3.3",
-    "style-loader": "^3.3.3",
-    "terser-webpack-plugin": "^5.3.9",
-    "typescript": "^4.9.5",
-    "url-loader": "^4.1.1",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.3",
-    "webpack-dev-server": "4.15.0"
-  },
-  "jest": {
-    "roots": [
-      "<rootDir>/src"
-    ],
-    "collectCoverageFrom": [
-      "src/**/*.{js,jsx,ts,tsx}",
-      "!src/**/*.d.ts",
-      "!src/lib/index.js",
-      "!src/lib/polyfills.js",
-      "!src/demo/**",
-      "!src/utils/**",
-      "!src/**/*.d.ts",
-      "!**/tests/**"
-    ],
-    "testMatch": [
-      "<rootDir>/src/**/__tests__/**/*.{js,jsx,ts,tsx}",
-      "<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}"
-    ],
-    "transformIgnorePatterns": [
-      "[/\\\\]node_modules[/\\\\].+\\.(js|jsx|ts|tsx)$",
-      "^.+\\.module\\.(css|sass|scss)$"
-    ],
-    "modulePaths": [],
-    "moduleNameMapper": {
-      "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/scripts/testMock.js",
-      "\\.(css|less)$": "<rootDir>/scripts/testMock.js"
-    },
-    "moduleFileExtensions": [
-      "web.js",
-      "js",
-      "web.ts",
-      "ts",
-      "web.tsx",
-      "tsx",
-      "json",
-      "web.jsx",
-      "jsx",
-      "node"
-    ]
-  }
-}
+{
+  "name": "simple-keyboard",
+  "version": "3.7.1",
+  "description": "On-screen Javascript Virtual Keyboard",
+  "main": "build/index.js",
+  "scripts": {
+    "start": "webpack serve --config webpack.config.demo.js",
+    "build": "webpack && npm run build-modern && npm run build-modern-esm && tsc",
+    "build-modern": "webpack --config webpack.config.modern.js",
+    "build-modern-esm": "webpack --config webpack.config.modern_esm.js",
+    "test": "jest --silent",
+    "coverage": "npm run test -- --coverage",
+    "prepare": "npm run build",
+    "trypublish": "npm publish || true"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hodgef/simple-keyboard"
+  },
+  "author": "Francisco Hodge <hello@franciscohodge.com> (https://github.com/hodgef)",
+  "bugs": {
+    "url": "https://github.com/hodgef/simple-keyboard/issues"
+  },
+  "homepage": "https://virtual-keyboard.js.org/",
+  "keywords": [
+    "javascript",
+    "es6",
+    "digital",
+    "keyboard",
+    "onscreen",
+    "virtual",
+    "screen-keyboard",
+    "component",
+    "virtual-keyboard",
+    "touchscreen",
+    "touch-screen",
+    "kiosk",
+    "osk",
+    "js"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/cli": "^7.22.10",
+    "@babel/core": "^7.22.10",
+    "@babel/plugin-proposal-class-properties": "^7.17.12",
+    "@babel/plugin-transform-typescript": "^7.22.10",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/preset-env": "^7.22.10",
+    "@types/jest": "^27.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.62.0",
+    "autoprefixer": "^10.4.15",
+    "babel-eslint": "^10.1.0",
+    "babel-loader": "^9.1.3",
+    "babel-preset-minify": "^0.5.2",
+    "core-js": "^3.32.0",
+    "css-loader": "^6.8.1",
+    "css-minimizer-webpack-plugin": "^5.0.1",
+    "eslint": "^8.47.0",
+    "file-loader": "^6.2.0",
+    "html-webpack-plugin": "^5.5.3",
+    "jest": "^26.6.3",
+    "mini-css-extract-plugin": "^2.7.6",
+    "postcss": "^8.4.28",
+    "postcss-loader": "^7.3.3",
+    "style-loader": "^3.3.3",
+    "terser-webpack-plugin": "^5.3.9",
+    "typescript": "^4.9.5",
+    "url-loader": "^4.1.1",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.3",
+    "webpack-dev-server": "4.15.0"
+  },
+  "jest": {
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.{js,jsx,ts,tsx}",
+      "!src/**/*.d.ts",
+      "!src/lib/index.js",
+      "!src/lib/polyfills.js",
+      "!src/demo/**",
+      "!src/utils/**",
+      "!src/**/*.d.ts",
+      "!**/tests/**"
+    ],
+    "testMatch": [
+      "<rootDir>/src/**/__tests__/**/*.{js,jsx,ts,tsx}",
+      "<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}"
+    ],
+    "transformIgnorePatterns": [
+      "[/\\\\]node_modules[/\\\\].+\\.(js|jsx|ts|tsx)$",
+      "^.+\\.module\\.(css|sass|scss)$"
+    ],
+    "modulePaths": [],
+    "moduleNameMapper": {
+      "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/scripts/testMock.js",
+      "\\.(css|less)$": "<rootDir>/scripts/testMock.js"
+    },
+    "moduleFileExtensions": [
+      "web.js",
+      "js",
+      "web.ts",
+      "ts",
+      "web.tsx",
+      "tsx",
+      "json",
+      "web.jsx",
+      "jsx",
+      "node"
+    ]
+  }
+}