[@wordpress/keycodes] add new definitions (#35909)

* [@wordpress/keycodes] add new definitions

* add typescript version constraint

types/wordpress__keycodes/index.d.ts

@@ -0,0 +1,122 @@
+// Type definitions for @wordpress/keycodes 2.3
+// Project: https://github.com/WordPress/gutenberg/tree/master/packages/keycodes/README.md
+// Definitions by: Derek Sifford <https://github.com/dsifford>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.1
+
+export const BACKSPACE = 8;
+export const TAB = 9;
+export const ENTER = 13;
+export const ESCAPE = 27;
+export const SPACE = 32;
+export const LEFT = 37;
+export const UP = 38;
+export const RIGHT = 39;
+export const DOWN = 40;
+export const DELETE = 46;
+export const F10 = 121;
+export const ALT = "alt";
+export const CTRL = "ctrl";
+export const COMMAND = "meta";
+export const SHIFT = "shift";
+
+export const modifiers: {
+    primary(isApple: () => boolean): string[];
+    primaryShift(isApple: () => boolean): string[];
+    primaryAlt(isApple: () => boolean): string[];
+    secondary(isApple: () => boolean): string[];
+    access(isApple: () => boolean): string[];
+    ctrl(): string[];
+    alt(): string[];
+    ctrlShift(): string[];
+    shift(): string[];
+    shiftAlt(): string[];
+};
+
+/**
+ * An object that contains functions to get raw shortcuts.
+ * E.g. rawShortcut.primary( 'm' ) will return 'meta+m' on Mac.
+ * These are intended for user with the KeyboardShortcuts component or TinyMCE.
+ */
+export const rawShortcut: {
+    primary(character: string): string;
+    primaryShift(character: string): string;
+    primaryAlt(character: string): string;
+    secondary(character: string): string;
+    access(character: string): string;
+    ctrl(character: string): string;
+    alt(character: string): string;
+    ctrlShift(character: string): string;
+    shift(character: string): string;
+    shiftAlt(character: string): string;
+};
+
+/**
+ * Return an array of the parts of a keyboard shortcut chord for display
+ * E.g displayShortcutList.primary( 'm' ) will return [ '⌘', 'M' ] on Mac.
+ */
+export const displayShortcutList: {
+    primary(character: string): string[];
+    primaryShift(character: string): string[];
+    primaryAlt(character: string): string[];
+    secondary(character: string): string[];
+    access(character: string): string[];
+    ctrl(character: string): string[];
+    alt(character: string): string[];
+    ctrlShift(character: string): string[];
+    shift(character: string): string[];
+    shiftAlt(character: string): string[];
+};
+
+/**
+ * An object that contains functions to display shortcuts.
+ * E.g. displayShortcut.primary( 'm' ) will return '⌘M' on Mac.
+ */
+export const displayShortcut: {
+    primary(character: string): string;
+    primaryShift(character: string): string;
+    primaryAlt(character: string): string;
+    secondary(character: string): string;
+    access(character: string): string;
+    ctrl(character: string): string;
+    alt(character: string): string;
+    ctrlShift(character: string): string;
+    shift(character: string): string;
+    shiftAlt(character: string): string;
+};
+
+/**
+ * An object that contains functions to return an aria label for a keyboard shortcut.
+ * E.g. shortcutAriaLabel.primary( '.' ) will return 'Command + Period' on Mac.
+ */
+export const shortcutAriaLabel: {
+    primary(character: string): string;
+    primaryShift(character: string): string;
+    primaryAlt(character: string): string;
+    secondary(character: string): string;
+    access(character: string): string;
+    ctrl(character: string): string;
+    alt(character: string): string;
+    ctrlShift(character: string): string;
+    shift(character: string): string;
+    shiftAlt(character: string): string;
+};
+
+/**
+ * An object that contains functions to check if a keyboard event matches a
+ * predefined shortcut combination.
+ * E.g. isKeyboardEvent.primary( event, 'm' ) will return true if the event
+ * signals pressing ⌘M.
+ */
+export const isKeyboardEvent: {
+    primary(event: Event, character: string): boolean;
+    primaryShift(event: Event, character: string): boolean;
+    primaryAlt(event: Event, character: string): boolean;
+    secondary(event: Event, character: string): boolean;
+    access(event: Event, character: string): boolean;
+    ctrl(event: Event, character: string): boolean;
+    alt(event: Event, character: string): boolean;
+    ctrlShift(event: Event, character: string): boolean;
+    shift(event: Event, character: string): boolean;
+    shiftAlt(event: Event, character: string): boolean;
+};

types/wordpress__keycodes/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": ["../"],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "paths": {
+            "@wordpress/keycodes": ["wordpress__keycodes"]
+        }
+    },
+    "files": ["index.d.ts", "wordpress__keycodes-tests.ts"]
+}

types/wordpress__keycodes/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }

types/wordpress__keycodes/wordpress__keycodes-tests.ts

@@ -0,0 +1,10 @@
+import * as keycodes from '@wordpress/keycodes';
+
+keycodes.displayShortcut.primaryShift('s');
+keycodes.displayShortcut.secondary('r');
+
+keycodes.shortcutAriaLabel.access('.');
+
+keycodes.rawShortcut.primary('m');
+
+keycodes.modifiers.primary(() => false);