@knime/utils 1.3.2 → 1.4.0

package/CHANGELOG.md

@@ -1,10 +1,23 @@
 # @knime/utils
 
+## 1.4.0
+
+### Minor Changes
+
+- dea510f: Moved getMetaOrCtrlKey from navigator util to hotkeys util
+
+## 1.3.3
+
+### Patch Changes
+
+- Updated dependencies [6e1501f]
+  - @knime/styles@1.4.0
+
 ## 1.3.2
 
 ### Patch Changes
 
-- ee229d3: add isWindows check to navigator utils
+- bb186d1: add isWindows check to navigator utils
 
 ## 1.3.1
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/utils",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "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)",
@@ -9,7 +9,7 @@
   "dependencies": {
     "date-fns": "2.30.0",
     "date-fns-tz": "2.0.0",
-    "@knime/styles": "1.3.1"
+    "@knime/styles": "1.4.0"
   },
   "peerDependencies": {
     "consola": "3.x"

package/src/config/globals.d.ts

@@ -1,3 +1,9 @@
-/* eslint-disable one-var */
+import type { ConsolaInstance } from "consola";
 
-declare const consola: import("consola").ConsolaInstance;
+declare global {
+  const consola: ConsolaInstance;
+
+  interface Window {
+    consola: ConsolaInstance;
+  }
+}

package/src/filters.ts

@@ -65,7 +65,7 @@ const modeDefinitions = [
       try {
         const flags = caseSensitiveSearch ? "" : "i";
         return new RegExp(searchTerm, flags);
-      } catch (error) {
+      } catch (_error) {
         // In case of an invalid regular expression, an impossible
         // regex is returned, not matching anything.
         return /$^/;
@@ -82,7 +82,7 @@ const modeDefinitions = [
       try {
         const flags = caseSensitiveSearch ? "" : "i";
         return new RegExp(`^(${searchTerm})$`, flags);
-      } catch (error) {
+      } catch (_error) {
         // In case of an invalid regular expression, an impossible
         // regex is returned, not matching anything.
         return /$^/;

package/src/format.ts

@@ -13,7 +13,7 @@ export const formatDateString = (
 ) => {
   const date = new Date(dateString);
 
-  // @ts-ignore
+  // @ts-expect-error Argument of type 'Date' is not assignable to parameter of type 'number'
   if (isNaN(date)) {
     throw Error("Invalid Date format");
   }
@@ -47,7 +47,7 @@ export const formatTimeString = (
 ) => {
   const time = new Date(timeString);
 
-  // @ts-ignore
+  // @ts-expect-error Argument of type 'Date' is not assignable to parameter of type 'number'
   if (isNaN(time)) {
     throw Error("Invalid Date format");
   }
@@ -79,7 +79,6 @@ export const formatDateTimeString = (
   dateTimeString: string | number,
   useTimeZone = false,
 ) => {
-  // eslint-disable-line arrow-body-style
   return `${formatDateString(dateTimeString, useTimeZone)} ${formatTimeString(
     dateTimeString,
     useTimeZone,

package/src/hotkeys.ts

@@ -27,6 +27,6 @@ export const isKeyWithoutModifiers = (
  *
  * @returns name of the primary modifier key for the current platform
  */
-export const getMetaOrCtrlKey = (): string => {
-  return navigatorUtils.getMetaOrCtrlKey();
+export const getMetaOrCtrlKey = (): "ctrlKey" | "metaKey" => {
+  return navigatorUtils.isMac() ? "metaKey" : "ctrlKey";
 };

package/src/intervalUtils.ts

@@ -160,7 +160,7 @@ export const formatIntervalToHumanReadableIntervalString = (
       if (milliSecondsZero) {
         output += formatPart(toFormat.interval.seconds, "second");
       } else {
-        output += `${toFormat.interval.seconds}.${toFormat.interval.milliseconds.toString().padStart(3, "0")} seconds `;
+        output += `${toFormat.interval.seconds}.${toFormat.interval.milliseconds.toString().padStart(3, "0")} seconds `; // eslint-disable-line no-magic-numbers
       }
     }
   }
@@ -308,7 +308,7 @@ export const isValidHumanReadableIntervalString = (
     } else {
       return { valid: false };
     }
-  } catch (e) {
+  } catch (_e) {
     return { valid: false };
   }
 };
@@ -384,7 +384,7 @@ export const isValidISOIntervalString = (
     } else {
       return { valid: false };
     }
-  } catch (e) {
+  } catch (_e) {
     return { valid: false };
   }
 };

package/src/navigator.ts

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

package/test-utils/muteConsole.ts

@@ -8,6 +8,7 @@ const methods: ConsoleMethod[] = ["log", "warn", "error", "info"];
  * @param f The function to run. Can be async.
  * @returns The original function's return value
  */
+// TODO: replace Function with fitting top type (...args: never[]) => unknown has unknown return type which makes problems in line 41
 export default (f: Function) => {
   const originals = methods.map((method) => console[method]);
   methods.forEach((method) => {
@@ -15,11 +16,11 @@ export default (f: Function) => {
   });
 
   let originalConsola: typeof consola;
-  // @ts-ignore - needs to extend the globalThis namespace
+  // @ts-expect-error Property 'consola' does not exist on type 'typeof globalThis'.
   if (global.consola) {
-    // @ts-ignore
+    // @ts-expect-error Property 'consola' does not exist on type 'typeof globalThis'.
     originalConsola = global.consola;
-    // @ts-ignore
+    // @ts-expect-error Property 'consola' does not exist on type 'typeof globalThis'.
     global.consola = consola.create({
       level: -1,
     });
@@ -30,7 +31,7 @@ export default (f: Function) => {
       console[method] = originals[i];
     });
     if (originalConsola) {
-      // @ts-ignore
+      // @ts-expect-error Property 'consola' does not exist on type 'typeof globalThis'.
       global.consola = originalConsola;
     }
   };