@knime/utils 1.2.7 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/utils
 
+## 1.3.1
+
+### Patch Changes
+
+- a674c18: Allow zero duration but disallow empty duration in IntervalInput
+
+## 1.3.0
+
+### Minor Changes
+
+- 59af778: Added a utility file for `hotkeys`. This utility can be used to detect if a modifier key is pressed or if the hotkey is pressed without any modifier keys. Additionally the `getMetaOrCtrlKey()` util was moved from `navigator` to the new `hotkeys` util.
+
 ## 1.2.7
 
 ### Patch Changes

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "@knime/utils",
-  "version": "1.2.7",
+  "version": "1.3.1",
   "description": "Internal utility functions and constants shared across @knime packages.",
   "homepage": "https://knime.github.io/webapps-common/",
   "license": "GPL 3 and Additional Permissions according to Sec. 7 (SEE the file LICENSE)",
   "author": "KNIME AG, Zurich, Switzerland",
   "type": "module",
   "dependencies": {
-    "consola": "3.2.3",
     "date-fns": "2.30.0",
     "date-fns-tz": "2.0.0",
     "@knime/styles": "1.3.1"
   },
+  "peerDependencies": {
+    "consola": "3.x"
+  },
+  "devDependencies": {
+    "consola": "3.2.3",
+    "flush-promises": "^1.0.2",
+    "mock-xmlhttprequest": "^8.3.0"
+  },
   "main": "src/index.ts",
   "module": "src/index.ts",
   "files": [
@@ -32,10 +39,6 @@
       "import": "./test-utils/index.ts"
     }
   },
-  "devDependencies": {
-    "flush-promises": "^1.0.2",
-    "mock-xmlhttprequest": "^8.3.0"
-  },
   "scripts": {
     "test:unit": "TZ='Europe/Berlin' vitest"
   }

package/src/hotkeys.ts

@@ -0,0 +1,32 @@
+import { navigatorUtils } from "@knime/utils";
+
+/**
+ * Checks if any modifier key (Ctrl, Meta, Alt, or Shift) is pressed.
+ * @param {KeyboardEvent} event - The keyboard event to check.
+ * @returns {boolean} True if a modifier key is pressed, otherwise false.
+ */
+export const isModifierKeyPressed = (event: KeyboardEvent): boolean => {
+  return event.ctrlKey || event.metaKey || event.altKey || event.shiftKey;
+};
+
+/**
+ * Checks if a specific key (or keys) were pressed without any modifier keys.
+ * @param {KeyboardEvent} event - The keyboard event to check.
+ * @param {string | string[]} keys - The key or keys to check for.
+ * @returns {boolean} True if the specified key(s) were pressed without modifiers, otherwise false.
+ */
+export const isKeyWithoutModifiers = (
+  event: KeyboardEvent,
+  keys: string | string[],
+): boolean => {
+  const keyList = Array.isArray(keys) ? keys : [keys];
+  return keyList.includes(event.key) && !isModifierKeyPressed(event);
+};
+
+/**
+ *
+ * @returns name of the primary modifier key for the current platform
+ */
+export const getMetaOrCtrlKey = (): string => {
+  return navigatorUtils.getMetaOrCtrlKey();
+};

package/src/index.ts

@@ -47,6 +47,7 @@ export namespace UploadManagerNS {
 }
 
 export * from "./fileExtensions";
+export * from "./hotkeys";
 
 export {
   uploadManager,

package/src/intervalUtils.ts

@@ -22,7 +22,6 @@ type IntervalStringValidationResult =
       valid: true;
       type: AllowedIntervalTypes;
       negative: boolean;
-      zero: boolean;
     }
   | { valid: false };
 
@@ -305,7 +304,6 @@ export const isValidHumanReadableIntervalString = (
         valid: true,
         type: actualType,
         negative,
-        zero: isZero(validationResult),
       };
     } else {
       return { valid: false };
@@ -382,7 +380,6 @@ export const isValidISOIntervalString = (
         valid: true,
         type: actualType,
         negative,
-        zero: isZero(validationResult),
       };
     } else {
       return { valid: false };

package/src/navigator.ts

@@ -2,10 +2,19 @@
  *
  * @returns true when the platform of the user is Mac
  */
-export const isMac = () => navigator?.userAgent?.toLowerCase()?.includes("mac");
+export const isMac = (): boolean =>
+  navigator?.userAgent?.toLowerCase()?.includes("mac");
 
 /**
+ * @deprecated Since version 1.3.6.  Use `hotkeys.ts` instead.
  *
- * @returns name of the primary modifier key for the current platform
+ * @returns name of the primary modifier key for the current platform.
  */
-export const getMetaOrCtrlKey = () => (isMac() ? "metaKey" : "ctrlKey");
+export const getMetaOrCtrlKey = () => {
+  if (import.meta.env.DEV) {
+    consola.warn(
+      "getMetaOrCtrlKey is deprecated on navigatorUtils. Please use hotkeys.ts instead.",
+    );
+  }
+  return isMac() ? "metaKey" : "ctrlKey";
+};