Vendor keyboard event shim

Author: reecelucas

README.md

@@ -14,8 +14,6 @@ React hook for creating simple keyboard shortcuts.
 npm install @reecelucas/react-use-hotkeys
 ```
 
-This package has a single dependency, a tiny shim called [`shim-keyboard-event-key`](https://www.npmjs.com/package/shim-keyboard-event-key) that normalises the non-standard `KeyBoardEvent.key` [values](https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/8860571/) implemented in Edge and IE.
-
 ## Example Usage
 
 All hotkey combinations must use valid `KeyBoardEvent` `"key"` values. A full list can be found on [MDN](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and Wes Bos has created a great [interactive lookup](https://keycode.info/).

package.json

@@ -66,10 +66,7 @@
     "tslint": "^5.15.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-react": "^4.0.0",
-    "typescript": "^3.4.1"
-  },
-  "dependencies": {
-    "shim-keyboard-event-key": "^1.0.3"
+    "typescript": "^4.8.2"
   },
   "husky": {
     "hooks": {

src/index.ts

@@ -8,7 +8,7 @@ import modifierKeyPressed from './helpers/modifierKeyPressed';
 import tail from './helpers/tail';
 import takeUntilLast from './helpers/takeUntilLast';
 
-import 'shim-keyboard-event-key';
+import './vendor/shim-keyboard-event-key';
 
 interface SequenceTimers {
   [key: number]: number;

src/vendor/shim-keyboard-event-key/index.js

@@ -0,0 +1,40 @@
+// Vendored version of https://github.com/shvaikalesh/shim-keyboard-event-key.
+// Necessary to fix an issue with SSR.
+(function() {
+  'use strict';
+
+  if (typeof self === 'undefined' || !self.document) return;
+
+  var event = KeyboardEvent.prototype;
+  var desc = Object.getOwnPropertyDescriptor(event, 'key');
+  if (!desc) return;
+
+  var keys = {
+    Win: 'Meta',
+    Scroll: 'ScrollLock',
+    Spacebar: ' ',
+
+    Down: 'ArrowDown',
+    Left: 'ArrowLeft',
+    Right: 'ArrowRight',
+    Up: 'ArrowUp',
+
+    Del: 'Delete',
+    Apps: 'ContextMenu',
+    Esc: 'Escape',
+
+    Multiply: '*',
+    Add: '+',
+    Subtract: '-',
+    Decimal: '.',
+    Divide: '/'
+  };
+
+  Object.defineProperty(event, 'key', {
+    get: function() {
+      var key = desc.get.call(this);
+
+      return keys.hasOwnProperty(key) ? keys[key] : key;
+    }
+  });
+})();

tsconfig.json

@@ -8,6 +8,7 @@
     "pretty": true,
     "rootDir": "src",
     "strict": true,
+    "allowJs": true,
     "noUnusedLocals": true,
     "noImplicitReturns": true,
     "outDir": "lib",

yarn.lock

@@ -8664,11 +8664,6 @@ shellwords@^0.1.1:
   resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b"
   integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==
 
-shim-keyboard-event-key@^1.0.3:
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/shim-keyboard-event-key/-/shim-keyboard-event-key-1.0.3.tgz#9a9441d6b7d1fb25819d86182caf554e821a515c"
-  integrity sha512-PTNRkOxDlZ2+Xz4CbKJJsh/pe1DJdaC+b4HHV02A1aEWNmwh1g9am0ZiU/ktu3uVfQrY3yDHTOVhst3xpLhw2A==
-
 sigmund@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/sigmund/-/sigmund-1.0.1.tgz#3ff21f198cad2175f9f3b781853fd94d0d19b590"
@@ -9432,10 +9427,10 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
 
-typescript@^3.4.1:
-  version "3.4.1"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.4.1.tgz#b6691be11a881ffa9a05765a205cb7383f3b63c6"
-  integrity sha512-3NSMb2VzDQm8oBTLH6Nj55VVtUEpe/rgkIzMir0qVoLyjDZlnMBva0U6vDiV3IH+sl/Yu6oP5QwsAQtHPmDd2Q==
+typescript@^4.8.2:
+  version "4.8.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.8.2.tgz#e3b33d5ccfb5914e4eeab6699cf208adee3fd790"
+  integrity sha512-C0I1UsrrDHo2fYI5oaCGbSejwX4ch+9Y5jTQELvovfmFkK3HHSZJB8MSJcWLmCUBzQBchCrZ9rMRV6GuNrvGtw==
 
 ua-parser-js@^0.7.18:
   version "0.7.28"