@knime/utils 1.11.0 → 1.11.2

package/src/filters.ts

@@ -1,114 +0,0 @@
-/**
- * These definitions can be used to filter an array. Each entry should contain a method normalize which can be used to
- * compile any filter settings and a method "test" which takes the compiled result, additional settings and the item to
- * be matched/filtered
- * */
-interface FilterDefinition<SearchTerm, Normalized, Testable> {
-  id: string;
-  normalize: (
-    searchTerm: SearchTerm,
-    caseSensitiveSearch: boolean,
-  ) => Normalized;
-  test: (
-    text: Testable,
-    normalizedSearchTerm: Normalized,
-    caseSensitiveSearch: boolean,
-    inverseSearch: boolean,
-  ) => boolean;
-}
-
-interface StringTest {
-  test(str: string): boolean;
-}
-
-type SearchFilterDefinition = FilterDefinition<string, string, string>;
-type PatternFilterDefinition = FilterDefinition<
-  string,
-  RegExp | StringTest,
-  string
->;
-type TypeFilterDefinition = FilterDefinition<
-  string[],
-  StringTest,
-  string | undefined
->;
-
-const modeDefinitions = [
-  {
-    id: "search",
-    normalize(searchTerm, caseSensitiveSearch) {
-      return caseSensitiveSearch ? searchTerm : searchTerm.toLowerCase();
-    },
-    test(text, normalizedSearchTerm, caseSensitiveSearch, inverseSearch) {
-      const testText = caseSensitiveSearch ? text : text.toLowerCase();
-      const matches = testText.includes(normalizedSearchTerm);
-      return inverseSearch ? !matches : matches;
-    },
-  } satisfies SearchFilterDefinition,
-  {
-    id: "wildcard",
-    normalize(searchTerm, caseSensitiveSearch) {
-      // Do a regex search, explicitly matching start and end of the search term.
-      // All regex special character except from "* and ?" (wildcards) are escaped.
-      if (searchTerm.length > 0) {
-        const escapedSearchTerm = searchTerm.replace(
-          /[-[\]{}()+.,\\^$|#\s]/g,
-          "\\$&",
-        );
-        const wildcardSearchTerm = escapedSearchTerm
-          .replace(/\*/g, ".*")
-          .replace(/\?/g, ".?");
-        searchTerm = `^${wildcardSearchTerm}$`;
-      } else {
-        return { test: () => false };
-      }
-      try {
-        const flags = caseSensitiveSearch ? "" : "i";
-        return new RegExp(searchTerm, flags);
-      } catch (_error) {
-        // In case of an invalid regular expression, an impossible
-        // regex is returned, not matching anything.
-        return /$^/;
-      }
-    },
-    test(text, normalizedSearchTerm, caseSensitiveSearch, inverseSearch) {
-      const matches = normalizedSearchTerm.test(text);
-      return inverseSearch ? !matches : matches;
-    },
-  } satisfies PatternFilterDefinition,
-  {
-    id: "regex",
-    normalize(searchTerm, caseSensitiveSearch) {
-      try {
-        const flags = caseSensitiveSearch ? "" : "i";
-        return new RegExp(`^(${searchTerm})$`, flags);
-      } catch (_error) {
-        // In case of an invalid regular expression, an impossible
-        // regex is returned, not matching anything.
-        return /$^/;
-      }
-    },
-    test(text, normalizedSearchTerm, caseSensitiveSearch, inverseSearch) {
-      const matches = normalizedSearchTerm.test(text);
-      return inverseSearch ? !matches : matches;
-    },
-  } satisfies PatternFilterDefinition,
-  {
-    id: "type",
-    normalize(selectedTypes) {
-      return { test: (type: string) => selectedTypes.includes(type) };
-    },
-    test(type, normalizedSearchTerm) {
-      if (typeof type === "undefined") {
-        return false;
-      }
-      return normalizedSearchTerm.test(type);
-    },
-  } satisfies TypeFilterDefinition,
-];
-
-// convert [{id: "key1", text: "asdf"}, ...] to {"key1": {id:"key1", text: "asdf"} ... }
-export const filters: Record<
-  string,
-  FilterDefinition<unknown, unknown, unknown>
-> = Object.assign({}, ...modeDefinitions.map((obj) => ({ [obj.id]: obj })));

package/src/format.ts

@@ -1,113 +0,0 @@
-import { filesize } from "filesize";
-
-import getLocalTimeZone from "./localTimezone";
-/**
- * Converts the specified date String to human readable text containing the day, month, and year.
- * Example: '2018-07-31T09:44:31+00:00' => 'Jul 31, 2018'
- *
- * @param dateString String representation of the Date to format
- * @param useTimeZone to set the timeZone where the user is located, and display local date and time
- * @returns human readable date String
- */
-export const formatDateString = (
-  dateString: string | number,
-  useTimeZone = false,
-) => {
-  const date = new Date(dateString);
-
-  // @ts-expect-error Argument of type 'Date' is not assignable to parameter of type 'number'
-  if (isNaN(date)) {
-    throw Error("Invalid Date format");
-  }
-
-  const baseDateOptions: Intl.DateTimeFormatOptions = {
-    day: "numeric",
-    month: "short",
-    year: "numeric",
-  };
-
-  // This only works for the default locale of en-US, as support of other locals in node js might not be available
-  // See for example this issue https://github.com/nodejs/node/issues/8500
-  const dateOptions: Intl.DateTimeFormatOptions = useTimeZone
-    ? { ...baseDateOptions, timeZone: getLocalTimeZone() }
-    : baseDateOptions;
-
-  return date.toLocaleDateString("en-US", dateOptions);
-};
-
-/**
- * Converts the specified time String to human readable text containing the hour (12-hour) and minute.
- * Example: '2018-07-31T09:44:31+00:00' => '9:44 AM'
- *
- * @param timeString String representation of the Date (including time) to format
- * @param useTimeZone to set the timeZone where the user is located, and display local date and time
- * @returns human readable time String
- */
-export const formatTimeString = (
-  timeString: string | number,
-  useTimeZone = false,
-) => {
-  const time = new Date(timeString);
-
-  // @ts-expect-error Argument of type 'Date' is not assignable to parameter of type 'number'
-  if (isNaN(time)) {
-    throw Error("Invalid Date format");
-  }
-
-  // This only works for the default locale of en-US, as support of other locals in node js might not be available
-  // See for example this issue https://github.com/nodejs/node/issues/8500
-  const baseTimeOptions: Intl.DateTimeFormatOptions = {
-    hour: "numeric",
-    minute: "2-digit",
-  };
-
-  const timeOptions: Intl.DateTimeFormatOptions = useTimeZone
-    ? { ...baseTimeOptions, timeZone: getLocalTimeZone() }
-    : baseTimeOptions;
-
-  return time.toLocaleTimeString("en-US", timeOptions);
-};
-
-/**
- * Converts the specified time String to human readable text containing the date (day, month, year) and time (hour,
- * minute; 12-hour).
- * Example: '2018-07-31T09:44:31+00:00' => 'Jul 31, 2018 9:44 AM'
- *
- * @param dateTimeString String representation of the Date (including time and date) to format
- * @param useTimeZone to set the timeZone where the user is located, and display local date and time
- * @returns human readable date/time String
- */
-export const formatDateTimeString = (
-  dateTimeString: string | number,
-  useTimeZone = false,
-) => {
-  return `${formatDateString(dateTimeString, useTimeZone)} ${formatTimeString(
-    dateTimeString,
-    useTimeZone,
-  )}`;
-};
-
-/**
- * Converts the specified date and time to the user time zone with option to display (day, month, year) only or with time (hour,
- * minute; 12-hour).
- *
- * @param showTime String representation of the Date to convert and format
- * @param String | number} date String representation of the Date to convert and format
- * @returns human readable date/time String converted to user time zone
- */
-export const formatLocalDateTimeString = (date: string, showTime: boolean) =>
-  showTime ? formatDateTimeString(date, true) : formatDateString(date, true);
-
-export const formatFileSize = (bytes: number, decimals = 1): string => {
-  const safeBytes = Number.isFinite(bytes) && bytes >= 0 ? bytes : 0;
-  const safeDecimals =
-    Number.isFinite(decimals) && decimals >= 0 ? Math.floor(decimals) : 0;
-
-  return filesize(safeBytes, {
-    output: "string",
-    base: 2,
-    standard: "iec",
-    round: safeDecimals,
-    pad: true,
-  }) as string;
-};

package/src/formatHotkeys.ts

@@ -1,98 +0,0 @@
-import { isMac } from "./navigator";
-
-type Keys =
-  | "F1"
-  | "F2"
-  | "F3"
-  | "F4"
-  | "F5"
-  | "F6"
-  | "F7"
-  | "F8"
-  | "F9"
-  | "F10"
-  | "F11"
-  | "F12"
-  | "PageUp"
-  | "PageDown"
-  | "ArrowUp"
-  | "ArrowRight"
-  | "ArrowDown"
-  | "ArrowLeft"
-  | "Delete"
-  | "Enter"
-  | "Backspace"
-  | "Home"
-  | "End"
-  | " "; // Space;
-
-type Modifiers = "CtrlOrCmd" | "Ctrl" | "Alt" | "Shift";
-
-// creates loose autocomplete by using a union of the passed-in type
-// and the entire `string` set *except* the passed-in type
-type LooseAutoComplete<T extends string> = T | Omit<string, T>;
-
-export type NumberRange = `${number}-${number}`;
-export type KnownHotkey = Keys | Modifiers | NumberRange;
-
-export type Hotkey = LooseAutoComplete<Keys | Modifiers>;
-
-const globalKeyMap = {
-  ArrowUp: "↑",
-  ArrowDown: "↓",
-  ArrowLeft: "←",
-  ArrowRight: "→",
-  Enter: "↵",
-  " ": "Space", // we use event.key and there space is an actual space not the code "Space"
-  CtrlOrCmd: "Ctrl",
-} as const;
-
-const MacOSkeyMap = {
-  Shift: "⇧",
-  Delete: "⌫",
-  CtrlOrCmd: "⌘",
-  Ctrl: "⌃",
-  Alt: "⌥",
-  Enter: "↩",
-} as const;
-
-type KeyFormatMap = typeof MacOSkeyMap | typeof globalKeyMap;
-
-/**
- * Returns a string representation of a single hotkey. Replaces some special key names with symbols
- */
-export const formatHotkey = (hotkey: Hotkey): string => {
-  /**
-   * Returns the symbol corresponding to the `key` based on the given
-   * `formatMap`. Otherwise, if not found, returns the same `key` value given
-   */
-  const mapSymbols = (formatMap: KeyFormatMap) => (key: Hotkey) =>
-    formatMap[key as keyof KeyFormatMap] ?? key;
-
-  /**
-   * Pipe function implementation. Receives a list of functions to execute in order
-   * and will pipe the parameter passed at the end to each function returning the final output
-   */
-  const pipe = <T extends () => string>(
-    ...fns: Array<(...args: Hotkey[]) => ReturnType<T>>
-  ) => fns.reduce((f, g) => (arg) => g(f(arg)));
-
-  const macKeyFormatter = pipe(
-    mapSymbols(MacOSkeyMap),
-    mapSymbols(globalKeyMap),
-  );
-
-  const generalKeyFormatter = mapSymbols(globalKeyMap);
-
-  return isMac() ? macKeyFormatter(hotkey) : generalKeyFormatter(hotkey);
-};
-
-export const getDefaultSeparator = () => " ";
-
-/**
- * Returns a string representation of a list of hotkeys. Replaces some special key names with symbols
- */
-export const formatHotkeys = (
-  hotkeys: Array<Hotkey>,
-  getSeparator = getDefaultSeparator,
-) => hotkeys.map(formatHotkey).join(getSeparator());

package/src/getDeepActiveElement.ts

@@ -1,9 +0,0 @@
-const getDeepActiveElement = () => {
-  let element = document?.activeElement;
-  while (element?.shadowRoot) {
-    element = element?.shadowRoot?.activeElement;
-  }
-  return element;
-};
-
-export default getDeepActiveElement;

package/src/index.ts

@@ -1,76 +0,0 @@
-import { capitalize, caseFormatter } from "./capitalize";
-import { isAfterMaxDate, isBeforeMinDate } from "./dateMinMaxCheck";
-import debounce from "./debounce";
-import { filters } from "./filters";
-import {
-  formatDateString,
-  formatDateTimeString,
-  formatFileSize,
-  formatLocalDateTimeString,
-  formatTimeString,
-} from "./format";
-import {
-  formatHotkey,
-  formatHotkeys,
-  getDefaultSeparator,
-} from "./formatHotkeys";
-import type {
-  Hotkey as _Hotkey,
-  KnownHotkey as _KnownHotkey,
-} from "./formatHotkeys";
-import getDeepActiveElement from "./getDeepActiveElement";
-import getWrappedAroundIndex from "./getWrappedAroundIndex";
-import * as intervalUtils from "./intervalUtils";
-import getLocalTimeZone from "./localTimezone";
-import * as navigatorUtils from "./navigator";
-import numIntegerDigits from "./numIntegerDigits";
-import * as promise from "./promise";
-import { sanitization } from "./sanitization";
-import sleep from "./sleep";
-import truncateString from "./truncateString";
-import updateDate from "./updateDate";
-import updateTime from "./updateTime";
-import type {
-  UploaderManagerConfig as _UploadManagerConfig,
-  UploadStateName as _UploadStateName,
-} from "./uploadManager";
-import * as uploadManager from "./uploadManager";
-
-const hotkeys = { formatHotkeys, formatHotkey, getDefaultSeparator };
-
-export type Hotkey = _Hotkey;
-export type KnownHotkey = _KnownHotkey;
-
-export type UploaderConfig = _UploadManagerConfig;
-export type UploadStateName = _UploadStateName;
-
-export * from "./fileExtensions";
-export * from "./hotkeys";
-
-export {
-  uploadManager,
-  promise,
-  capitalize,
-  caseFormatter,
-  debounce,
-  filters,
-  formatDateString,
-  formatDateTimeString,
-  formatFileSize,
-  getDeepActiveElement,
-  formatLocalDateTimeString,
-  formatTimeString,
-  getLocalTimeZone,
-  getWrappedAroundIndex,
-  hotkeys,
-  isAfterMaxDate,
-  isBeforeMinDate,
-  intervalUtils,
-  navigatorUtils,
-  numIntegerDigits,
-  sleep,
-  truncateString,
-  updateDate,
-  updateTime,
-  sanitization,
-};