@knime/utils 1.11.1 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @knime/utils
 
+## 1.12.0
+
+### Minor Changes
+
+- e774645: - `formatFileSize`: now formatted with `pretty-bytes` instead of `filesize`, dropping the `filesize` dependency. Sizes are now rendered in decimal (SI) units to three significant figures (e.g. `1024` → `"1.02 kB"`, `24117248` → `"24.1 MB"`) instead of binary IEC units (`KiB`, `MiB`, `GiB`). The unused `decimals` parameter has been removed (no caller passed it); precision is fixed at three significant figures.
+- c2d135a: - `hotkeys`: added `match(event, hotkeys)` to test a `KeyboardEvent` against an ordered list of `Hotkey` tokens, including support for single-digit ranges (e.g. `"1-9"`) and treating `Backspace` as `Delete` on macOS.
+  - `hotkeys.getDefaultSeparator` / `hotkeys.formatHotkeys`: the default separator is now platform-aware — `"+"` on Windows/Linux (e.g. `Ctrl+S`) and `" "` on macOS (e.g. `⌘ S`). Pass a custom `getSeparator` to `formatHotkeys` to override.
+  - `Hotkey`: the type now includes `NumberRange` tokens (e.g. `"1-9"`).
+  - `hotkeys.formatHotkey`: added an optional `platform` argument to force a platform's modifier glyphs instead of auto-detecting from the user agent. Exposed the `hotkeyPlatform` value and `HotkeyPlatform` type for it.
+
+## 1.11.2
+
+### Patch Changes
+
+- 6f1aed0: `@knime/utils`: migrated the package into the KNIME Design System monorepo. The package now builds to `dist` (compiled ESM + type declarations) like the other published packages.
+
 ## 1.11.1
 
 ### Patch Changes

package/README.md

@@ -1,29 +1,82 @@
-# ![Image](https://www.knime.com/sites/default/files/knime_logo_github_40x40_4layers.png) @knime/utils
+# KNIME® Frontend – Utils
 
-Internal utility functions and constants shared across `@knime` packages.
+This package is maintained by the [UI Core Team](mailto:team-ui-core@knime.com).
 
-## Installation
+It contains framework-agnostic utility functions and constants shared across KNIME projects — date/time formatting, hotkey helpers, string and number utilities, HTML sanitization, file-size and file-extension helpers, promise helpers, and an upload manager. It has no Vue dependency and can be used from any TypeScript/JavaScript project.
 
-To install the `@knime/utils` package, you can use npm:
+It's published as npm package: [@knime/utils]
 
-```bash
-npm install @knime/utils
+## Why is this not a `@knime/kds-*` package?
+
+`@knime/utils` predates the design system and is consumed beyond it. It keeps its original name and is **versioned independently** (currently `1.x`) — it is _not_ part of the `@knime/kds-*` Changesets group. It is also pure TypeScript (no Vue, no styles), so its build does not need the Vue/CSS toolchain the component packages use.
+
+## Development
+
+This package is part of the [KNIME Design System monorepo](../../README.md). For setup instructions, see the **[root README](../../README.md)**.
+
+### Testing
+
+Unit tests are based on [Vitest]. Run from the monorepo root:
+
+```sh
+pnpm run test:unit      # Run all unit tests (packages/*)
+pnpm run coverage       # Generate coverage reports
+```
+
+Date/time tests assert against a fixed timezone (`Europe/Berlin`), configured in [`vite.config.ts`](vite.config.ts).
+
+### Logging
+
+You can log using the global `consola` variable (which the embedding application needs to provide).
+
+See https://github.com/nuxt/consola for details.
+
+## Building
+
+To build the package as an ES library:
+
+```sh
+pnpm run build      # Build only this package
 ```
 
-## Usage
+Results are saved to `dist/` (compiled ESM plus type declarations under `dist/src`).
+
+## Using the utilities in an application
+
+Install the [@knime/utils] npm package as a dependency:
+
+```sh
+pnpm add @knime/utils
+```
 
-To use it in your project, you can import it as follows:
+```ts
+import { capitalize, formatFileSize, sleep } from "@knime/utils";
 
-```javascript
-import { capitalize } from "@knime/utils";
+capitalize("hello"); // "Hello"
+formatFileSize(1024); // "1.02 kB"
+await sleep(100);
 ```
 
+### Subpath exports
+
+| Entry                       | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `@knime/utils`              | The utility functions and constants                              |
+| `@knime/utils/test-utils`   | Test helpers (e.g. `muteConsole`)                                |
+| `@knime/utils/globals.d.ts` | Ambient `consola` global declaration (reference from a `*.d.ts`) |
+| `@knime/utils/audit`        | Programmatic API for the bulk advisory audit                     |
+
+### Requirements
+
+The embedding app must provide:
+
+- A `consola` instance compatible with the version defined in [`package.json`](package.json)
+
 ## Audit tool
 
 This package also ships a CLI tool (`pnpm-bulk-audit`) that audits dependencies
 using the npm bulk advisory API — a drop-in workaround while `pnpm audit` is
-broken. See [src/audit/README.md](src/audit/README.md) for details.
-
-# Join the Community!
+broken. See [audit/README.md](audit/README.md) for details.
 
-- [KNIME Forum](https://forum.knime.com/)
+[Vitest]: https://vitest.dev/
+[@knime/utils]: https://www.npmjs.com/package/@knime/utils

package/dist/globals.d.ts

@@ -0,0 +1,8 @@
+import { ConsolaInstance } from 'consola';
+declare global {
+  const consola: ConsolaInstance;
+
+  interface Window {
+    consola: ConsolaInstance;
+  }
+}