@sit-onyx/headless 1.0.0-beta.2 → 1.0.0-beta.21

package/src/utils/keyboard.ts

@@ -1,4 +1,4 @@
-import { isSubsetMatching } from "./object";
+import { isSubsetMatching } from "./object.js";
 
 export type PressedKey =
   | string

package/src/utils/math.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from "vitest";
-import { MathUtils } from "./math";
+import { MathUtils } from "./math.js";
 
 describe("MathUtils.clamp", () => {
   test.each([

package/src/utils/object.spec.ts

@@ -1,5 +1,5 @@
 import { expect, test } from "vitest";
-import { isSubsetMatching } from "./object";
+import { isSubsetMatching } from "./object.js";
 
 const referenceObj = { a: 42, b: "foo", c: null, d: true };
 

package/src/utils/timer.ts

@@ -1,3 +1,5 @@
+import { toValue, type MaybeRefOrGetter } from "vue";
+
 /**
  * Debounces a given callback which will only be called when not called for the given timeout.
  *
@@ -5,11 +7,16 @@
  */
 export const debounce = <TArgs extends unknown[]>(
   handler: (...args: TArgs) => void,
-  timeout: number,
+  timeout: MaybeRefOrGetter<number>,
 ) => {
   let timer: ReturnType<typeof setTimeout> | undefined;
-  return (...lastArgs: TArgs) => {
+
+  const func = (...lastArgs: TArgs) => {
     clearTimeout(timer);
-    timer = setTimeout(() => handler(...lastArgs), timeout);
+    timer = setTimeout(() => handler(...lastArgs), toValue(timeout));
   };
+  /** Abort the currently debounced action, if any. */
+  func.abort = () => clearTimeout(timer);
+
+  return func;
 };

package/src/utils/types.ts

@@ -21,3 +21,13 @@ export type IfDefined<Key extends string, TValue> =
 export type IsArray<TValue, TMultiple extends boolean = false> = TMultiple extends true
   ? TValue[]
   : TValue;
+
+/**
+ * A type that can be wrapped in an array.
+ */
+export type Arrayable<T> = T | Array<T>;
+
+/**
+ * Either the actual value or a nullish one.
+ */
+export type Nullable<T = never> = T | null | undefined;

package/src/utils/vitest.ts

@@ -1,6 +1,6 @@
-import { vi, type Awaitable } from "vitest";
+import { vi } from "vitest";
 
-type Callback = () => Awaitable<void>;
+type Callback = () => void | (() => Promise<void>);
 
 /**
  * Mocks the following vue lifecycle functions:

package/src/utils/id.ts

@@ -1,14 +0,0 @@
-/**
- * Returns a unique global id string
- */
-// ⚠️ we make use of an IIFE to encapsulate the globalCounter so it can never accidentally be used somewhere else.
-const nextId = (() => {
-  let globalCounter = 1;
-  return () => globalCounter++;
-})();
-
-/**
- * Creates a globally unique string using a counter.
- * The given name is the prefix.
- */
-export const createId = (name: string) => `${name}-${nextId()}`;