diff --git a/package-lock.json b/package-lock.json index 0c86cf6..95f08a5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,6 +19,7 @@ "@gravity-ui/tsconfig": "^1.0.0", "@size-limit/esbuild-why": "^11.2.0", "@size-limit/preset-small-lib": "^11.2.0", + "@testing-library/react": "^16.3.0", "@types/jest": "^29.5.14", "@types/react": "^18.0.0", "@types/react-dom": "^18.0.0", @@ -636,6 +637,19 @@ "@babel/core": "^7.0.0-0" } }, + "node_modules/@babel/runtime": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.0.tgz", + "integrity": "sha512-VtPOkrdPHZsKc/clNqyi9WUA8TINkZ4cGk63UUE3u4pmB2k+ZMQRDuIOagv8UVd6j7k0T3+RRIb7beKTebNbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, "node_modules/@babel/template": { "version": "7.27.0", "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.0.tgz", @@ -1076,20 +1090,6 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/@cspotcode/source-map-support": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", - "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@jridgewell/trace-mapping": "0.3.9" - }, - "engines": { - "node": ">=12" - } - }, "node_modules/@csstools/color-helpers": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.0.1.tgz", @@ -2316,18 +2316,6 @@ "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", "dev": true }, - "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.9", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", - "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@jridgewell/resolve-uri": "^3.0.3", - "@jridgewell/sourcemap-codec": "^1.4.10" - } - }, "node_modules/@napi-rs/wasm-runtime": { "version": "0.2.8", "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.8.tgz", @@ -2502,48 +2490,114 @@ "size-limit": "11.2.0" } }, - "node_modules/@tootallnate/once": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz", - "integrity": "sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==", + "node_modules/@testing-library/dom": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.0.tgz", + "integrity": "sha512-pemlzrSESWbdAloYml3bAJMEfNh1Z7EduzqPKprCH5S341frlpYnUEW0H72dLxa6IsYr+mPno20GiSm+h9dEdQ==", "dev": true, "license": "MIT", + "peer": true, + "dependencies": { + "@babel/code-frame": "^7.10.4", + "@babel/runtime": "^7.12.5", + "@types/aria-query": "^5.0.1", + "aria-query": "5.3.0", + "chalk": "^4.1.0", + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" + }, "engines": { - "node": ">= 10" + "node": ">=18" } }, - "node_modules/@tsconfig/node10": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", - "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==", + "node_modules/@testing-library/dom/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", "dev": true, - "optional": true, - "peer": true + "license": "MIT", + "peer": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } }, - "node_modules/@tsconfig/node12": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", - "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "node_modules/@testing-library/dom/node_modules/aria-query": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", + "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==", "dev": true, - "optional": true, - "peer": true + "license": "Apache-2.0", + "peer": true, + "dependencies": { + "dequal": "^2.0.3" + } }, - "node_modules/@tsconfig/node14": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", - "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "node_modules/@testing-library/dom/node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", "dev": true, - "optional": true, - "peer": true + "license": "MIT", + "peer": true, + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } }, - "node_modules/@tsconfig/node16": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.3.tgz", - "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", + "node_modules/@testing-library/dom/node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", "dev": true, - "optional": true, + "license": "MIT", "peer": true }, + "node_modules/@testing-library/react": { + "version": "16.3.0", + "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-16.3.0.tgz", + "integrity": "sha512-kFSyxiEDwv1WLl2fgsq6pPBbw5aWKrsY2/noi1Id0TK0UParSF62oFQFGHXIyaG4pp2tEub/Zlel+fjjZILDsw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.12.5" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@testing-library/dom": "^10.0.0", + "@types/react": "^18.0.0 || ^19.0.0", + "@types/react-dom": "^18.0.0 || ^19.0.0", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "@types/react-dom": { + "optional": true + } + } + }, + "node_modules/@tootallnate/once": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz", + "integrity": "sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, "node_modules/@tybys/wasm-util": { "version": "0.9.0", "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.9.0.tgz", @@ -2555,6 +2609,14 @@ "tslib": "^2.4.0" } }, + "node_modules/@types/aria-query": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT", + "peer": true + }, "node_modules/@types/babel__core": { "version": "7.20.5", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", @@ -3321,14 +3383,6 @@ "node": ">= 8" } }, - "node_modules/arg": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", - "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", @@ -4132,14 +4186,6 @@ "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, - "node_modules/create-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", - "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/cross-spawn": { "version": "7.0.6", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", @@ -4420,6 +4466,17 @@ "node": ">=0.4.0" } }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "dev": true, + "license": "MIT", + "peer": true, + "engines": { + "node": ">=6" + } + }, "node_modules/detect-newline": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", @@ -4430,17 +4487,6 @@ "node": ">=8" } }, - "node_modules/diff": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", - "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=0.3.1" - } - }, "node_modules/diff-sequences": { "version": "29.6.3", "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", @@ -4464,6 +4510,14 @@ "node": ">=0.10.0" } }, + "node_modules/dom-accessibility-api": { + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", + "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "dev": true, + "license": "MIT", + "peer": true + }, "node_modules/domexception": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/domexception/-/domexception-4.0.0.tgz", @@ -8416,6 +8470,17 @@ "loose-envify": "cli.js" } }, + "node_modules/lz-string": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", + "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "dev": true, + "license": "MIT", + "peer": true, + "bin": { + "lz-string": "bin/bin.js" + } + }, "node_modules/make-dir": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", @@ -9487,6 +9552,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/regenerator-runtime": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz", + "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==", + "dev": true, + "license": "MIT" + }, "node_modules/regexp-tree": { "version": "0.1.27", "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.27.tgz", @@ -10551,51 +10623,6 @@ "node": ">=12" } }, - "node_modules/ts-node": { - "version": "10.9.1", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", - "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@cspotcode/source-map-support": "^0.8.0", - "@tsconfig/node10": "^1.0.7", - "@tsconfig/node12": "^1.0.7", - "@tsconfig/node14": "^1.0.0", - "@tsconfig/node16": "^1.0.2", - "acorn": "^8.4.1", - "acorn-walk": "^8.1.1", - "arg": "^4.1.0", - "create-require": "^1.1.0", - "diff": "^4.0.1", - "make-error": "^1.1.1", - "v8-compile-cache-lib": "^3.0.1", - "yn": "3.1.1" - }, - "bin": { - "ts-node": "dist/bin.js", - "ts-node-cwd": "dist/bin-cwd.js", - "ts-node-esm": "dist/bin-esm.js", - "ts-node-script": "dist/bin-script.js", - "ts-node-transpile-only": "dist/bin-transpile.js", - "ts-script": "dist/bin-script-deprecated.js" - }, - "peerDependencies": { - "@swc/core": ">=1.2.50", - "@swc/wasm": ">=1.2.50", - "@types/node": "*", - "typescript": ">=2.7" - }, - "peerDependenciesMeta": { - "@swc/core": { - "optional": true - }, - "@swc/wasm": { - "optional": true - } - } - }, "node_modules/tsconfig-paths": { "version": "3.15.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", @@ -10863,14 +10890,6 @@ "requires-port": "^1.0.0" } }, - "node_modules/v8-compile-cache-lib": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", - "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/v8-to-istanbul": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz", @@ -11203,17 +11222,6 @@ "node": ">=12" } }, - "node_modules/yn": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", - "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=6" - } - }, "node_modules/yocto-queue": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", diff --git a/package.json b/package.json index 8b8fbd1..367cbf0 100644 --- a/package.json +++ b/package.json @@ -39,6 +39,7 @@ "@gravity-ui/tsconfig": "^1.0.0", "@size-limit/esbuild-why": "^11.2.0", "@size-limit/preset-small-lib": "^11.2.0", + "@testing-library/react": "^16.3.0", "@types/jest": "^29.5.14", "@types/react": "^18.0.0", "@types/react-dom": "^18.0.0", diff --git a/src/hooks.test.tsx b/src/hooks.test.tsx new file mode 100644 index 0000000..d4acf04 --- /dev/null +++ b/src/hooks.test.tsx @@ -0,0 +1,292 @@ +import {act, renderHook} from '@testing-library/react'; +import {getHooks} from './hooks'; +import {Controller} from './controller'; +import type {HintState} from './hints/hintStore'; +import {getOptions} from './tests/utils'; + +describe('getHooks', () => { + let controller: Controller; + + beforeEach(() => { + jest.clearAllMocks(); + + controller = new Controller(getOptions()); + + jest.spyOn(controller, 'stepElementReached'); + jest.spyOn(controller, 'stepElementDisappeared'); + jest.spyOn(controller, 'passStep'); + jest.spyOn(controller, 'closeHintByUser'); + jest.spyOn(controller, 'addPreset'); + jest.spyOn(controller, 'finishPreset'); + jest.spyOn(controller, 'runPreset'); + jest.spyOn(controller, 'resetPresetProgress'); + jest.spyOn(controller, 'suggestPresetOnce'); + jest.spyOn(controller, 'setWizardState'); + }); + + describe('useOnboardingStep', () => { + it('ref set with element and readyForHint=true -> calls stepElementReached', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => { + const hook = hooks.useOnboardingStep('testStep', true); + return { + ...hook, + ref: hook.ref as unknown as (node: Element | null) => void, + }; + }); + + const mockElement = document.createElement('div'); + act(() => { + result.current.ref(mockElement); + }); + + expect(controller.stepElementReached).toHaveBeenCalledWith({ + stepSlug: 'testStep', + element: mockElement, + }); + }); + + it('ref set to null and readyForHint=true -> calls stepElementDisappeared', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => { + const hook = hooks.useOnboardingStep('testStep', true); + return { + ...hook, + ref: hook.ref as unknown as (node: Element | null) => void, + }; + }); + + act(() => { + result.current.ref(null); + }); + + expect(controller.stepElementDisappeared).toHaveBeenCalledWith('testStep'); + }); + + it('readyForHint=false -> does not call stepElementReached', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => { + const hook = hooks.useOnboardingStep('testStep', false); + return { + ...hook, + ref: hook.ref as unknown as (node: Element | null) => void, + }; + }); + + const mockElement = document.createElement('div'); + act(() => { + result.current.ref(mockElement); + }); + + expect(controller.stepElementReached).not.toHaveBeenCalled(); + }); + + it('pass called -> calls controller passStep', async () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useOnboardingStep('testStep')); + + await act(async () => { + await result.current.pass(); + }); + + expect(controller.passStep).toHaveBeenCalledWith('testStep'); + }); + + it('closeHint called -> calls controller closeHintByUser', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useOnboardingStep('testStep')); + + act(() => { + result.current.closeHint(); + }); + + expect(controller.closeHintByUser).toHaveBeenCalledWith('testStep'); + }); + }); + + describe('useOnboardingStepBySelector', () => { + it('element with matching selector found -> calls stepElementReached', () => { + // Create a parent element with a child matching the selector + const parentElement = document.createElement('div'); + const childElement = document.createElement('div'); + childElement.classList.add('test-selector'); + parentElement.appendChild(childElement); + + const hooks = getHooks(controller); + + renderHook(() => + hooks.useOnboardingStepBySelector({ + element: parentElement, + selector: '.test-selector', + step: 'testStep', + }), + ); + + expect(controller.stepElementReached).toHaveBeenCalledWith({ + stepSlug: 'testStep', + element: childElement, + }); + }); + + it('element with selector not found -> calls stepElementDisappeared', () => { + // Create a parent element without a matching child + const parentElement = document.createElement('div'); + + const hooks = getHooks(controller); + + renderHook(() => + hooks.useOnboardingStepBySelector({ + element: parentElement, + selector: '.test-selector', + step: 'testStep', + }), + ); + + expect(controller.stepElementDisappeared).toHaveBeenCalledWith('testStep'); + }); + + it('parent element not provided -> calls stepElementDisappeared', () => { + const hooks = getHooks(controller); + + renderHook(() => + hooks.useOnboardingStepBySelector({ + selector: '.test-selector', + step: 'testStep', + }), + ); + + expect(controller.stepElementDisappeared).toHaveBeenCalledWith('testStep'); + }); + + it('readyForHint=false -> does not call stepElementReached', () => { + const parentElement = document.createElement('div'); + const childElement = document.createElement('div'); + childElement.classList.add('test-selector'); + parentElement.appendChild(childElement); + + const hooks = getHooks(controller); + + renderHook(() => + hooks.useOnboardingStepBySelector({ + element: parentElement, + selector: '.test-selector', + step: 'testStep', + readyForHint: false, + }), + ); + + expect(controller.stepElementReached).not.toHaveBeenCalled(); + }); + + it('pass called -> calls controller passStep', async () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => + hooks.useOnboardingStepBySelector({ + selector: '.test-selector', + step: 'testStep', + }), + ); + + await act(async () => { + await result.current.pass(); + }); + + expect(controller.passStep).toHaveBeenCalledWith('testStep'); + }); + + it('closeHint called -> calls controller closeHintByUser', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => + hooks.useOnboardingStepBySelector({ + selector: '.test-selector', + step: 'testStep', + }), + ); + + act(() => { + result.current.closeHint(); + }); + + expect(controller.closeHintByUser).toHaveBeenCalledWith('testStep'); + }); + + it('component unmounted -> calls stepElementDisappeared', () => { + const hooks = getHooks(controller); + + const {unmount} = renderHook(() => + hooks.useOnboardingStepBySelector({ + selector: '.test-selector', + step: 'testStep', + }), + ); + + jest.clearAllMocks(); + + unmount(); + + expect(controller.stepElementDisappeared).toHaveBeenCalledWith('testStep'); + }); + }); + + describe('useOnboardingPresets', () => { + it('hook returned -> provides direct access to controller methods', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useOnboardingPresets()); + + expect(result.current.addPreset).toBe(controller.addPreset); + expect(result.current.finishPreset).toBe(controller.finishPreset); + expect(result.current.runPreset).toBe(controller.runPreset); + expect(result.current.resetPresetProgress).toBe(controller.resetPresetProgress); + expect(result.current.suggestPresetOnce).toBe(controller.suggestPresetOnce); + }); + }); + + describe('useOnboardingHint', () => { + it('hint data available -> returns hint data and onClose function', () => { + // Setup hint data manually through the controller + const mockHintData: HintState = { + open: true, + hint: { + preset: 'testPreset', + step: { + slug: 'testStep', + name: '', + description: '', + }, + }, + anchorRef: {current: document.createElement('div')}, + }; + + // Mock the hintStore.getSnapshot to return our test data + controller.hintStore.getSnapshot = jest.fn().mockReturnValue(mockHintData); + + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useOnboardingHint()); + + expect(result.current).toEqual({ + ...mockHintData, + onClose: controller.closeHintByUser, + }); + }); + + it('call close hint -> call controller method', () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useOnboardingHint()); + + expect(result.current.onClose).toBe(controller.closeHintByUser); + }); + }); + + describe('useWizard', () => { + it('setWizardState called -> updates wizard state through controller', async () => { + const hooks = getHooks(controller); + const {result} = renderHook(() => hooks.useWizard()); + + await act(async () => { + await result.current.setWizardState('hidden'); + }); + + expect(controller.setWizardState).toHaveBeenCalledWith('hidden'); + }); + }); +});