@rowsncolumns/utils 9.2.38 → 9.2.39

package/dist/cjs/index.d.ts

@@ -21,4 +21,5 @@ export * from "./conditional-format";
 export * from "./data-validation";
 export * from "./content-hash";
 export * from "./shared-string-canonical";
+export * from "./keyboard";
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC"}

package/dist/cjs/index.js

@@ -24,3 +24,4 @@ tslib_1.__exportStar(require("./conditional-format"), exports);
 tslib_1.__exportStar(require("./data-validation"), exports);
 tslib_1.__exportStar(require("./content-hash"), exports);
 tslib_1.__exportStar(require("./shared-string-canonical"), exports);
+tslib_1.__exportStar(require("./keyboard"), exports);

package/dist/cjs/keyboard.d.ts

@@ -0,0 +1,28 @@
+type HotkeyEventLike = {
+    key: string;
+    code?: string;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+export declare const hotkeyKeyFromCode: (code: string | undefined) => string | undefined;
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+export declare const getHotkeyKey: (event: HotkeyEventLike) => string;
+export {};
+//# sourceMappingURL=keyboard.d.ts.map

package/dist/cjs/keyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../keyboard.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAqBF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,GAAG,SAAS,uBAWzD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,eAAe,WAYlD,CAAC"}

package/dist/cjs/keyboard.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHotkeyKey = exports.hotkeyKeyFromCode = void 0;
+var PUNCTUATION_BY_CODE = {
+    Backquote: "`",
+    Backslash: "\\",
+    BracketLeft: "[",
+    BracketRight: "]",
+    Comma: ",",
+    Equal: "=",
+    Minus: "-",
+    Period: ".",
+    Quote: "'",
+    Semicolon: ";",
+    Slash: "/",
+};
+var isPrintableAscii = function (key) {
+    var charCode = key.charCodeAt(0);
+    return charCode >= 0x20 && charCode <= 0x7e;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+var hotkeyKeyFromCode = function (code) {
+    if (!code) {
+        return undefined;
+    }
+    if (/^Key[A-Z]$/.test(code)) {
+        return code.charAt(3).toLowerCase();
+    }
+    if (/^Digit[0-9]$/.test(code)) {
+        return code.charAt(5);
+    }
+    return PUNCTUATION_BY_CODE[code];
+};
+exports.hotkeyKeyFromCode = hotkeyKeyFromCode;
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+var getHotkeyKey = function (event) {
+    var key = event.key, code = event.code;
+    if (key.length === 1) {
+        if (isPrintableAscii(key)) {
+            return key.toLowerCase();
+        }
+        var keyFromCode = (0, exports.hotkeyKeyFromCode)(code);
+        if (keyFromCode !== undefined) {
+            return keyFromCode;
+        }
+    }
+    return key;
+};
+exports.getHotkeyKey = getHotkeyKey;

package/dist/cjs/tsconfig.cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}
+{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../keyboard.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}

package/dist/esm/index.d.ts

@@ -21,4 +21,5 @@ export * from "./conditional-format";
 export * from "./data-validation";
 export * from "./content-hash";
 export * from "./shared-string-canonical";
+export * from "./keyboard";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC"}

package/dist/esm/index.js

@@ -21,3 +21,4 @@ export * from "./conditional-format";
 export * from "./data-validation";
 export * from "./content-hash";
 export * from "./shared-string-canonical";
+export * from "./keyboard";

package/dist/esm/keyboard.d.ts

@@ -0,0 +1,28 @@
+type HotkeyEventLike = {
+    key: string;
+    code?: string;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+export declare const hotkeyKeyFromCode: (code: string | undefined) => string | undefined;
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+export declare const getHotkeyKey: (event: HotkeyEventLike) => string;
+export {};
+//# sourceMappingURL=keyboard.d.ts.map

package/dist/esm/keyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../keyboard.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAqBF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,GAAG,SAAS,uBAWzD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,eAAe,WAYlD,CAAC"}

package/dist/esm/keyboard.js

@@ -0,0 +1,62 @@
+const PUNCTUATION_BY_CODE = {
+    Backquote: "`",
+    Backslash: "\\",
+    BracketLeft: "[",
+    BracketRight: "]",
+    Comma: ",",
+    Equal: "=",
+    Minus: "-",
+    Period: ".",
+    Quote: "'",
+    Semicolon: ";",
+    Slash: "/",
+};
+const isPrintableAscii = (key) => {
+    const charCode = key.charCodeAt(0);
+    return charCode >= 0x20 && charCode <= 0x7e;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+export const hotkeyKeyFromCode = (code) => {
+    if (!code) {
+        return undefined;
+    }
+    if (/^Key[A-Z]$/.test(code)) {
+        return code.charAt(3).toLowerCase();
+    }
+    if (/^Digit[0-9]$/.test(code)) {
+        return code.charAt(5);
+    }
+    return PUNCTUATION_BY_CODE[code];
+};
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+export const getHotkeyKey = (event) => {
+    const { key, code } = event;
+    if (key.length === 1) {
+        if (isPrintableAscii(key)) {
+            return key.toLowerCase();
+        }
+        const keyFromCode = hotkeyKeyFromCode(code);
+        if (keyFromCode !== undefined) {
+            return keyFromCode;
+        }
+    }
+    return key;
+};

package/dist/esm/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}
+{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../keyboard.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowsncolumns/utils",
-  "version": "9.2.38",
+  "version": "9.2.39",
   "author": "Vinay M",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "./dist/cjs/index.js",