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

package/src/utils/keyboard.ts

@@ -1,351 +0,0 @@
-import { isSubsetMatching } from "./object.js";
-
-export type PressedKey =
-  | string
-  | Partial<Pick<KeyboardEvent, "altKey" | "key" | "ctrlKey" | "metaKey" | "shiftKey" | "code">>;
-
-/**
- * Check if a specified key was pressed.
- * @param event The KeyboardEvent
- * @param key The key, either the [key property](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) as a string (e.g. "m")
- * or an object with the relevant key parameters, e.g. `{ key: "m", altKey: true }`
- * @returns true, if the key was pressed with the specified parameters
- */
-export const wasKeyPressed = (event: KeyboardEvent, key: PressedKey) => {
-  if (typeof key === "string") {
-    return event.key === key;
-  }
-  return isSubsetMatching(
-    { altKey: false, ctrlKey: false, metaKey: false, shiftKey: false, ...key },
-    event,
-  );
-};
-
-/**
- * Check if the `key` property of a KeyboardEvent is a printable character.
- *
- * There is no standardized or specified algorithm to check for [named keys](https://www.w3.org/TR/uievents-key/#named-key-attribute-values) vs printable characters.
- * For this check we use the provided list provided by the standard, which might be incomplete.
- */
-export const isPrintableCharacter = (key: string) => !NAMED_KEYS_SET.has(key);
-
-/**
- * Based on https://www.w3.org/TR/uievents-key/#named-key-attribute-values
- *
- * Extracted using
- * ```js
- * copy(JSON.stringify([...document.querySelectorAll(".key-table-key")].map(e => e.innerText.replaceAll("\"", ""))));
- * ```
- */
-export const NAMED_KEYS = [
-  "Unidentified",
-  "Alt",
-  "AltGraph",
-  "CapsLock",
-  "Control",
-  "Fn",
-  "FnLock",
-  "Meta",
-  "NumLock",
-  "ScrollLock",
-  "Shift",
-  "Symbol",
-  "SymbolLock",
-  "Hyper",
-  "Super",
-  "Enter",
-  "Tab",
-  "ArrowDown",
-  "ArrowLeft",
-  "ArrowRight",
-  "ArrowUp",
-  "End",
-  "Home",
-  "PageDown",
-  "PageUp",
-  "Backspace",
-  "Clear",
-  "Copy",
-  "CrSel",
-  "Cut",
-  "Delete",
-  "EraseEof",
-  "ExSel",
-  "Insert",
-  "Paste",
-  "Redo",
-  "Undo",
-  "Accept",
-  "Again",
-  "Attn",
-  "Cancel",
-  "ContextMenu",
-  "Escape",
-  "Execute",
-  "Find",
-  "Help",
-  "Pause",
-  "Play",
-  "Props",
-  "Select",
-  "ZoomIn",
-  "ZoomOut",
-  "BrightnessDown",
-  "BrightnessUp",
-  "Eject",
-  "LogOff",
-  "Power",
-  "PowerOff",
-  "PrintScreen",
-  "Hibernate",
-  "Standby",
-  "WakeUp",
-  "AllCandidates",
-  "Alphanumeric",
-  "CodeInput",
-  "Compose",
-  "Convert",
-  "Dead",
-  "FinalMode",
-  "GroupFirst",
-  "GroupLast",
-  "GroupNext",
-  "GroupPrevious",
-  "ModeChange",
-  "NextCandidate",
-  "NonConvert",
-  "PreviousCandidate",
-  "Process",
-  "SingleCandidate",
-  "HangulMode",
-  "HanjaMode",
-  "JunjaMode",
-  "Eisu",
-  "Hankaku",
-  "Hiragana",
-  "HiraganaKatakana",
-  "KanaMode",
-  "KanjiMode",
-  "Katakana",
-  "Romaji",
-  "Zenkaku",
-  "ZenkakuHankaku",
-  "F1",
-  "F2",
-  "F3",
-  "F4",
-  "F5",
-  "F6",
-  "F7",
-  "F8",
-  "F9",
-  "F10",
-  "F11",
-  "F12",
-  "Soft1",
-  "Soft2",
-  "Soft3",
-  "Soft4",
-  "ChannelDown",
-  "ChannelUp",
-  "Close",
-  "MailForward",
-  "MailReply",
-  "MailSend",
-  "MediaClose",
-  "MediaFastForward",
-  "MediaPause",
-  "MediaPlay",
-  "MediaPlayPause",
-  "MediaRecord",
-  "MediaRewind",
-  "MediaStop",
-  "MediaTrackNext",
-  "MediaTrackPrevious",
-  "New",
-  "Open",
-  "Print",
-  "Save",
-  "SpellCheck",
-  "Key11",
-  "Key12",
-  "AudioBalanceLeft",
-  "AudioBalanceRight",
-  "AudioBassBoostDown",
-  "AudioBassBoostToggle",
-  "AudioBassBoostUp",
-  "AudioFaderFront",
-  "AudioFaderRear",
-  "AudioSurroundModeNext",
-  "AudioTrebleDown",
-  "AudioTrebleUp",
-  "AudioVolumeDown",
-  "AudioVolumeUp",
-  "AudioVolumeMute",
-  "MicrophoneToggle",
-  "MicrophoneVolumeDown",
-  "MicrophoneVolumeUp",
-  "MicrophoneVolumeMute",
-  "SpeechCorrectionList",
-  "SpeechInputToggle",
-  "LaunchApplication1",
-  "LaunchApplication2",
-  "LaunchCalendar",
-  "LaunchContacts",
-  "LaunchMail",
-  "LaunchMediaPlayer",
-  "LaunchMusicPlayer",
-  "LaunchPhone",
-  "LaunchScreenSaver",
-  "LaunchSpreadsheet",
-  "LaunchWebBrowser",
-  "LaunchWebCam",
-  "LaunchWordProcessor",
-  "BrowserBack",
-  "BrowserFavorites",
-  "BrowserForward",
-  "BrowserHome",
-  "BrowserRefresh",
-  "BrowserSearch",
-  "BrowserStop",
-  "AppSwitch",
-  "Call",
-  "Camera",
-  "CameraFocus",
-  "EndCall",
-  "GoBack",
-  "GoHome",
-  "HeadsetHook",
-  "LastNumberRedial",
-  "Notification",
-  "MannerMode",
-  "VoiceDial",
-  "TV",
-  "TV3DMode",
-  "TVAntennaCable",
-  "TVAudioDescription",
-  "TVAudioDescriptionMixDown",
-  "TVAudioDescriptionMixUp",
-  "TVContentsMenu",
-  "TVDataService",
-  "TVInput",
-  "TVInputComponent1",
-  "TVInputComponent2",
-  "TVInputComposite1",
-  "TVInputComposite2",
-  "TVInputHDMI1",
-  "TVInputHDMI2",
-  "TVInputHDMI3",
-  "TVInputHDMI4",
-  "TVInputVGA1",
-  "TVMediaContext",
-  "TVNetwork",
-  "TVNumberEntry",
-  "TVPower",
-  "TVRadioService",
-  "TVSatellite",
-  "TVSatelliteBS",
-  "TVSatelliteCS",
-  "TVSatelliteToggle",
-  "TVTerrestrialAnalog",
-  "TVTerrestrialDigital",
-  "TVTimer",
-  "AVRInput",
-  "AVRPower",
-  "ColorF0Red",
-  "ColorF1Green",
-  "ColorF2Yellow",
-  "ColorF3Blue",
-  "ColorF4Grey",
-  "ColorF5Brown",
-  "ClosedCaptionToggle",
-  "Dimmer",
-  "DisplaySwap",
-  "DVR",
-  "Exit",
-  "FavoriteClear0",
-  "FavoriteClear1",
-  "FavoriteClear2",
-  "FavoriteClear3",
-  "FavoriteRecall0",
-  "FavoriteRecall1",
-  "FavoriteRecall2",
-  "FavoriteRecall3",
-  "FavoriteStore0",
-  "FavoriteStore1",
-  "FavoriteStore2",
-  "FavoriteStore3",
-  "Guide",
-  "GuideNextDay",
-  "GuidePreviousDay",
-  "Info",
-  "InstantReplay",
-  "Link",
-  "ListProgram",
-  "LiveContent",
-  "Lock",
-  "MediaApps",
-  "MediaAudioTrack",
-  "MediaLast",
-  "MediaSkipBackward",
-  "MediaSkipForward",
-  "MediaStepBackward",
-  "MediaStepForward",
-  "MediaTopMenu",
-  "NavigateIn",
-  "NavigateNext",
-  "NavigateOut",
-  "NavigatePrevious",
-  "NextFavoriteChannel",
-  "NextUserProfile",
-  "OnDemand",
-  "Pairing",
-  "PinPDown",
-  "PinPMove",
-  "PinPToggle",
-  "PinPUp",
-  "PlaySpeedDown",
-  "PlaySpeedReset",
-  "PlaySpeedUp",
-  "RandomToggle",
-  "RcLowBattery",
-  "RecordSpeedNext",
-  "RfBypass",
-  "ScanChannelsToggle",
-  "ScreenModeNext",
-  "Settings",
-  "SplitScreenToggle",
-  "STBInput",
-  "STBPower",
-  "Subtitle",
-  "Teletext",
-  "VideoModeNext",
-  "Wink",
-  "ZoomToggle",
-  "AudioVolumeDown",
-  "AudioVolumeUp",
-  "AudioVolumeMute",
-  "BrowserBack",
-  "BrowserForward",
-  "ChannelDown",
-  "ChannelUp",
-  "ContextMenu",
-  "Eject",
-  "End",
-  "Enter",
-  "Home",
-  "MediaFastForward",
-  "MediaPlay",
-  "MediaPlayPause",
-  "MediaRecord",
-  "MediaRewind",
-  "MediaStop",
-  "MediaNextTrack",
-  "MediaPause",
-  "MediaPreviousTrack",
-  "Power",
-  "Unidentified",
-] as const;
-
-// Create a Set, which is easier and faster to use.
-export const NAMED_KEYS_SET = new Set<string>(NAMED_KEYS);

package/src/utils/math.spec.ts

@@ -1,14 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { MathUtils } from "./math.js";
-
-describe("MathUtils.clamp", () => {
-  test.each([
-    { number: 1, min: 1, max: 2, result: 1 },
-    { number: 1, min: 2, max: 2, result: 2 },
-    { number: 1, min: 0, max: 0, result: 0 },
-    { number: 1, min: 1, max: 1, result: 1 },
-  ])(
-    "should return $result for key number:$number min:$min max:$max",
-    ({ number, min, max, result }) => expect(MathUtils.clamp(number, min, max)).toBe(result),
-  );
-});

package/src/utils/math.ts

@@ -1,6 +0,0 @@
-export const MathUtils = {
-  /**
-   * Ensures that a given `number` is or is between a given `min` and `max`.
-   */
-  clamp: (number: number, min: number, max: number) => Math.max(Math.min(number, max), min),
-};

package/src/utils/object.spec.ts

@@ -1,33 +0,0 @@
-import { expect, test } from "vitest";
-import { isSubsetMatching } from "./object.js";
-
-const referenceObj = { a: 42, b: "foo", c: null, d: true };
-
-test.each([
-  // ARRANGE
-  { label: "with the same key-values", compareObj: { ...referenceObj } },
-  {
-    label: "with additional key-values in compared object",
-    compareObj: { d: true, b: "foo", c: null, a: 42, f: 23 },
-  },
-  { label: "with undefined keys", compareObj: { ...referenceObj, e: undefined } },
-])("should return true for objects $label", ({ compareObj }) => {
-  // ACT
-  const result = isSubsetMatching(referenceObj, compareObj);
-
-  // ASSERT
-  expect(result).toBeTruthy();
-});
-
-test.each([
-  // ARRANGE
-  { label: "only having a single entry", compareObj: { foo: 42 } },
-  { label: "a value", compareObj: { ...referenceObj, a: 0 } },
-  { label: "a value", compareObj: { ...referenceObj, a: undefined } },
-])("should return false when objects differ by $label", ({ compareObj }) => {
-  // ACT
-  const result = isSubsetMatching(referenceObj, compareObj);
-
-  // ASSERT
-  expect(result).toBeFalsy();
-});

package/src/utils/object.ts

@@ -1,8 +0,0 @@
-/**
- * Check if every entry of a subset exists and matches the entry of a target object.
- * @returns `true`, if target contains the subset
- */
-export const isSubsetMatching = (subset: object, target: object) =>
-  Object.entries(subset).every(
-    ([key, value]) => (target as Record<string, unknown>)[key] === value,
-  );

package/src/utils/timer.ts

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

package/src/utils/vitest.ts

@@ -1,36 +0,0 @@
-import { vi } from "vitest";
-
-type Callback = () => void | (() => Promise<void>);
-
-/**
- * Mocks the following vue lifecycle functions:
- * - onBeforeMount
- * - onMounted
- * - onBeforeUnmount
- * - onUnmounted
- *
- * `onBeforeMount` and `onMounted` callbacks are executed immediately.
- * `onBeforeUnmount` and `onUnmounted` are executed when the returned callback is run.
- * @returns a callback to trigger the run of `onBeforeUnmount` and `onUnmounted`
- */
-export const mockVueLifecycle = () => {
-  const { callbacks } = vi.hoisted(() => ({
-    callbacks: {
-      onBeforeUnmountedCb: null as Callback | null,
-      onUnmountedCb: null as Callback | null,
-    },
-  }));
-
-  vi.mock("vue", async (original) => ({
-    ...((await original()) as typeof import("vue")),
-    onBeforeMount: vi.fn((cb: Callback) => cb()),
-    onMounted: vi.fn((cb: Callback) => cb()),
-    onBeforeUnmount: vi.fn((cb: Callback) => (callbacks.onBeforeUnmountedCb = cb)),
-    onUnmounted: vi.fn((cb: Callback) => (callbacks.onUnmountedCb = cb)),
-  }));
-
-  return async () => {
-    await callbacks.onBeforeUnmountedCb?.();
-    await callbacks.onUnmountedCb?.();
-  };
-};