@griddo/ax 12.10.2 → 12.10.3

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/ax",
 	"description": "Griddo Author Experience",
-	"version": "12.10.2",
+	"version": "12.10.3",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -201,5 +201,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "35d223c7201fb171f9111b2831d446d4b4461880"
+	"gitHead": "2d015ededd3170ca82057b809faaafc6b91c80ff"
 }

package/src/__tests__/hooks/shortcuts/engine.test.ts

@@ -18,7 +18,7 @@ function register(
 	overrides: Partial<ShortcutConfig> & Pick<ShortcutConfig, "id" | "keys">,
 	target?: EventTarget,
 ): ShortcutConfig {
-	const config: ShortcutConfig = { handler: jest.fn(), ...overrides };
+	const config: ShortcutConfig = { handler: vi.fn(), ...overrides };
 	const cleanup = shortcutEngine.register(config, target);
 	cleanups.push(cleanup);
 	return config;
@@ -266,13 +266,13 @@ describe("ShortcutEngine", () => {
 		});
 
 		it("resets on timeout", () => {
-			jest.useFakeTimers();
+			vi.useFakeTimers();
 			const config = register({ id: "goto", keys: parseShortcut("g l") });
 			keydown({ key: "g" });
-			jest.advanceTimersByTime(1100);
+			vi.advanceTimersByTime(1100);
 			keydown({ key: "l" });
 			expect(config.handler).not.toHaveBeenCalled();
-			jest.useRealTimers();
+			vi.useRealTimers();
 		});
 
 		it("calls preventDefault on first key of chord", () => {
@@ -282,8 +282,8 @@ describe("ShortcutEngine", () => {
 		});
 
 		it("does not fire single-key shortcuts while chord is advancing", () => {
-			const chordHandler = jest.fn();
-			const singleHandler = jest.fn();
+			const chordHandler = vi.fn();
+			const singleHandler = vi.fn();
 			register({ id: "chord", keys: parseShortcut("g l") });
 			register({ id: "single-g", keys: parseShortcut("g"), handler: singleHandler });
 
@@ -320,7 +320,7 @@ describe("ShortcutEngine", () => {
 
 	describe("cleanup", () => {
 		it("unregisters shortcut when cleanup is called", () => {
-			const handler = jest.fn();
+			const handler = vi.fn();
 			const cleanup = shortcutEngine.register({ id: "tmp", keys: parseShortcut("mod+s"), handler }, window);
 			cleanup();
 
@@ -331,9 +331,9 @@ describe("ShortcutEngine", () => {
 		it("removes listener when last shortcut on a target is unregistered", () => {
 			const div = document.createElement("div");
 			document.body.appendChild(div);
-			const spy = jest.spyOn(div, "removeEventListener");
+			const spy = vi.spyOn(div, "removeEventListener");
 
-			const cleanup = shortcutEngine.register({ id: "tmp", keys: parseShortcut("mod+x"), handler: jest.fn() }, div);
+			const cleanup = shortcutEngine.register({ id: "tmp", keys: parseShortcut("mod+x"), handler: vi.fn() }, div);
 			cleanup();
 
 			expect(spy).toHaveBeenCalledWith("keydown", expect.any(Function));

package/src/__tests__/hooks/shortcuts/hooks.test.tsx

@@ -26,7 +26,7 @@ function keydown(init: KeyboardEventInit): KeyboardEvent {
 
 describe("shortcut()", () => {
 	it("creates a ShortcutConfig with parsed keys", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		const config = shortcut("save", "mod+s", handler);
 		expect(config.id).toBe("save");
 		expect(config.keys).toEqual([{ modifiers: ["mod"], key: "s" }]);
@@ -34,7 +34,7 @@ describe("shortcut()", () => {
 	});
 
 	it("applies overrides", () => {
-		const config = shortcut("save", "mod+s", jest.fn(), {
+		const config = shortcut("save", "mod+s", vi.fn(), {
 			allowInInput: true,
 			priority: 5,
 			description: "Save document",
@@ -51,14 +51,14 @@ describe("shortcut()", () => {
 
 describe("useShortcuts", () => {
 	it("registers and fires shortcut on matching key", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useShortcuts([shortcut("s1", "mod+s", handler)]));
 		keydown({ key: "s", ctrlKey: true });
 		expect(handler).toHaveBeenCalledTimes(1);
 	});
 
 	it("cleans up shortcuts on unmount", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		const { unmount } = renderHook(() => useShortcuts([shortcut("s1", "mod+s", handler)]));
 		unmount();
 		keydown({ key: "s", ctrlKey: true });
@@ -66,7 +66,7 @@ describe("useShortcuts", () => {
 	});
 
 	it("does not fire when enabled is false", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useShortcuts([shortcut("s1", "mod+s", handler)], { enabled: false }));
 		keydown({ key: "s", ctrlKey: true });
 		expect(handler).not.toHaveBeenCalled();
@@ -94,7 +94,7 @@ describe("useShortcuts", () => {
 		const div = document.createElement("div");
 		document.body.appendChild(div);
 		const ref = { current: div } as React.RefObject<HTMLDivElement>;
-		const handler = jest.fn();
+		const handler = vi.fn();
 
 		renderHook(() => useShortcuts([shortcut("s1", "mod+b", handler)], { ref }));
 
@@ -116,21 +116,21 @@ describe("useShortcuts", () => {
 
 describe("useSaveShortcut", () => {
 	it("fires handler on mod+s", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useSaveShortcut(handler));
 		keydown({ key: "s", ctrlKey: true });
 		expect(handler).toHaveBeenCalledTimes(1);
 	});
 
 	it("does not fire when disabled", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useSaveShortcut(handler, false));
 		keydown({ key: "s", ctrlKey: true });
 		expect(handler).not.toHaveBeenCalled();
 	});
 
 	it("works inside input elements", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useSaveShortcut(handler));
 		const input = document.createElement("input");
 		document.body.appendChild(input);
@@ -142,14 +142,14 @@ describe("useSaveShortcut", () => {
 
 describe("useEscapeShortcut", () => {
 	it("fires handler on Escape", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useEscapeShortcut(handler));
 		keydown({ key: "Escape" });
 		expect(handler).toHaveBeenCalledTimes(1);
 	});
 
 	it("does not fire when disabled", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useEscapeShortcut(handler, false));
 		keydown({ key: "Escape" });
 		expect(handler).not.toHaveBeenCalled();
@@ -158,8 +158,8 @@ describe("useEscapeShortcut", () => {
 
 describe("useUndoRedoShortcuts", () => {
 	it("fires onUndo on mod+z", () => {
-		const onUndo = jest.fn();
-		const onRedo = jest.fn();
+		const onUndo = vi.fn();
+		const onRedo = vi.fn();
 		renderHook(() => useUndoRedoShortcuts(onUndo, onRedo));
 		keydown({ key: "z", ctrlKey: true });
 		expect(onUndo).toHaveBeenCalledTimes(1);
@@ -167,8 +167,8 @@ describe("useUndoRedoShortcuts", () => {
 	});
 
 	it("fires onRedo on mod+shift+z", () => {
-		const onUndo = jest.fn();
-		const onRedo = jest.fn();
+		const onUndo = vi.fn();
+		const onRedo = vi.fn();
 		renderHook(() => useUndoRedoShortcuts(onUndo, onRedo));
 		keydown({ key: "z", ctrlKey: true, shiftKey: true });
 		expect(onRedo).toHaveBeenCalledTimes(1);
@@ -184,7 +184,7 @@ describe("useGlobalShortcuts", () => {
 	});
 
 	it("yields to higher-priority shortcut", () => {
-		const handler = jest.fn();
+		const handler = vi.fn();
 		renderHook(() => useGlobalShortcuts());
 		renderHook(() => useSaveShortcut(handler));
 
@@ -201,7 +201,7 @@ describe("useGlobalShortcuts", () => {
 describe("useIframeShortcutBridge", () => {
 	it("re-dispatches same-origin shortcut messages as keydown", () => {
 		renderHook(() => useIframeShortcutBridge());
-		const spy = jest.fn();
+		const spy = vi.fn();
 		window.addEventListener("keydown", spy);
 
 		window.dispatchEvent(
@@ -224,7 +224,7 @@ describe("useIframeShortcutBridge", () => {
 
 	it("ignores cross-origin messages", () => {
 		renderHook(() => useIframeShortcutBridge());
-		const spy = jest.fn();
+		const spy = vi.fn();
 		window.addEventListener("keydown", spy);
 
 		window.dispatchEvent(
@@ -243,7 +243,7 @@ describe("useIframeShortcutBridge", () => {
 
 	it("ignores messages with unrecognized type", () => {
 		renderHook(() => useIframeShortcutBridge());
-		const spy = jest.fn();
+		const spy = vi.fn();
 		window.addEventListener("keydown", spy);
 
 		window.dispatchEvent(

package/src/hooks/index.tsx

@@ -16,6 +16,22 @@ import { useURLSearchParam } from "./location";
 import { useContextMenu, useHandleClickOutside, useModal, useModals, useToast } from "./modals";
 import { useNetworkStatus } from "./network";
 import { useResizable } from "./resize";
+import {
+	type KeyCombo,
+	type ModifierKey,
+	parseShortcut,
+	type ShortcutConfig,
+	shortcut,
+	shortcutEngine,
+	type UseShortcutsOptions,
+	useEscapeShortcut,
+	useForwardShortcutKeys,
+	useGlobalShortcuts,
+	useIframeShortcutBridge,
+	useSaveShortcut,
+	useShortcuts,
+	useUndoRedoShortcuts,
+} from "./shortcuts";
 import {
 	useGlobalPermission,
 	usePermission,
@@ -26,6 +42,9 @@ import {
 import { useFirefoxScrollLock, useWindowSize } from "./window";
 
 export {
+	parseShortcut,
+	shortcut,
+	shortcutEngine,
 	useAdaptiveText,
 	useBroadcastChannel,
 	useBroadcastClipboard,
@@ -40,9 +59,13 @@ export {
 	useEditingLock,
 	useEmptyState,
 	useEqualStructured,
+	useEscapeShortcut,
 	useFirefoxScrollLock,
+	useForwardShortcutKeys,
 	useGlobalPermission,
+	useGlobalShortcuts,
 	useHandleClickOutside,
+	useIframeShortcutBridge,
 	useIsDirty,
 	useModal,
 	useModals,
@@ -55,9 +78,16 @@ export {
 	usePermissionsForSite,
 	usePrevious,
 	useResizable,
+	useSaveShortcut,
+	useShortcuts,
 	useShouldBeSaved,
 	useToast,
+	useUndoRedoShortcuts,
 	useURLSearchParam,
 	useWindowSize,
 	type IBulkSelectedItems,
+	type KeyCombo,
+	type ModifierKey,
+	type ShortcutConfig,
+	type UseShortcutsOptions,
 };