@untemps/react-vocal 1.7.37 → 2.0.0-beta.10

package/src/components/__tests__/VocalWithMockedUseVocal.test.js

@@ -1,40 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import React from 'react'
-import { waitFor } from '@testing-library/dom'
-import { act, fireEvent, render } from '@testing-library/react'
-
-import Vocal from '../Vocal'
-
-jest.mock('../../hooks/useVocal', () => {
-	return () => [
-		null,
-		{
-			subscribe: () => {
-				throw new Error('Foo')
-			},
-		},
-	]
-})
-
-const defaultProps = {}
-const getInstance = (props = {}, children = null) => (
-	<Vocal {...defaultProps} {...props}>
-		{children}
-	</Vocal>
-)
-
-describe('Vocal', () => {
-	it('triggers onError handler', async () => {
-		const onError = jest.fn()
-		const { queryByTestId } = render(getInstance({ onError }))
-		await act(async () => {
-			fireEvent.click(queryByTestId('__vocal-root__'))
-			await waitFor(() => expect(onError).toHaveBeenCalled())
-		})
-	})
-})
-
-// TODO: Merge this file with Vocal.test.js

package/src/hooks/__tests__/useCommands.test.js

@@ -1,64 +0,0 @@
-import { renderHook } from '@testing-library/react-hooks'
-
-import useCommands from '../useCommands'
-
-describe('useCommands', () => {
-	it('returns triggerCommand function', () => {
-		const triggerCommand = renderHook(() => useCommands())
-		expect(triggerCommand).toBeDefined()
-	})
-
-	it('triggers callback mapped to the exact input', () => {
-		const commands = {
-			foo: () => 'bar',
-		}
-		const {
-			result: { current: triggerCommand },
-		} = renderHook(() => useCommands(commands))
-		expect(triggerCommand('foo')).toBe('bar')
-	})
-
-	it('passes input as callback argument', () => {
-		const commands = {
-			foo: (input) => input,
-		}
-		const {
-			result: { current: triggerCommand },
-		} = renderHook(() => useCommands(commands))
-		expect(triggerCommand('foo')).toBe('foo')
-	})
-
-	describe('Approximate inputs', () => {
-		const value = 'foo'
-		it.each([
-			['Change la bordure en vert', 'Change la bordure en verre', value],
-			['Change la bordure en vert', 'Change la bordure en verres', value],
-			['Change la bordure en vert', 'Change la bordure en vers', value],
-			['Change la bordure en vert', 'Change la bordure en vairs', value],
-			['Change la bordure en vert', 'Changez la bordure en verre', value],
-			['Change la bordure en vert', 'Changez la bodure en verre', null],
-			['Change la bordure en vert', 'Change la bordure en rouge', null],
-			['Change la bordure en vert', 'Change la bordure en verre de rouge', null],
-			['Change la bordure en vert', 'Change la bordure en violet', null],
-			['Change la bordure en vert', 'Modifie la bordure en violet', null],
-		])('triggers callback mapped to approximate inputs', (command, input, expected) => {
-			const commands = {
-				[command]: () => value,
-			}
-			const {
-				result: { current: triggerCommand },
-			} = renderHook(() => useCommands(commands))
-			expect(triggerCommand(input)).toBe(expected)
-		})
-	})
-
-	it('returns null as no command is mapped to the input', () => {
-		const commands = {
-			foo: () => 'bar',
-		}
-		const {
-			result: { current: triggerCommand },
-		} = renderHook(() => useCommands(commands))
-		expect(triggerCommand('gag')).toBeNull()
-	})
-})

package/src/hooks/__tests__/useTimeout.test.js

@@ -1,69 +0,0 @@
-import { renderHook } from '@testing-library/react-hooks'
-
-import useTimeout from '../useTimeout'
-
-const wait = (delay) => {
-	return new Promise((resolve) => {
-		setTimeout(resolve, delay)
-	})
-}
-
-describe('useTimeout', () => {
-	it('not triggers handler before calling start', () => {
-		const handler = jest.fn()
-		renderHook(() => useTimeout(handler))
-		expect(handler).not.toHaveBeenCalled()
-	})
-
-	it('not triggers handler before timeout', async () => {
-		const handler = jest.fn()
-		const timeout = 500
-		const {
-			result: {
-				current: [start],
-			},
-		} = renderHook(() => useTimeout(handler, timeout))
-		start()
-		await wait(timeout - 50)
-		expect(handler).not.toHaveBeenCalled()
-	})
-
-	it('triggers handler immediately', async () => {
-		const handler = jest.fn()
-		const {
-			result: {
-				current: [start],
-			},
-		} = renderHook(() => useTimeout(handler))
-		start()
-		await wait(0)
-		expect(handler).toHaveBeenCalled()
-	})
-
-	it('triggers handler after delay', async () => {
-		const handler = jest.fn()
-		const timeout = 500
-		const {
-			result: {
-				current: [start],
-			},
-		} = renderHook(() => useTimeout(handler, timeout))
-		start()
-		await wait(timeout)
-		expect(handler).toHaveBeenCalled()
-	})
-
-	it('not triggers handler if stop is called before timeout', async () => {
-		const handler = jest.fn()
-		const timeout = 500
-		const {
-			result: {
-				current: [start, stop],
-			},
-		} = renderHook(() => useTimeout(handler, timeout))
-		start()
-		stop()
-		await wait(timeout)
-		expect(handler).not.toHaveBeenCalled()
-	})
-})

package/src/hooks/__tests__/useVocal.test.js

@@ -1,197 +0,0 @@
-import { renderHook } from '@testing-library/react-hooks'
-import { Vocal as SpeechRecognitionWrapper } from '@untemps/vocal'
-
-import useVocal from '../useVocal'
-
-jest.mock('@untemps/vocal')
-
-describe('useVocal', () => {
-	const mockStart = jest.fn()
-	const mockStop = jest.fn()
-	const mockAbort = jest.fn()
-	const mockAddEventListener = jest.fn()
-	const mockRemoveEventListener = jest.fn()
-	const mockCleanup = jest.fn()
-
-	const mockIsSupported = jest.fn()
-	Object.defineProperty(SpeechRecognitionWrapper, 'isSupported', {
-		get: mockIsSupported,
-	})
-
-	describe('with no SpeechRecognition support', () => {
-		beforeAll(() => {
-			mockIsSupported.mockReturnValue(false)
-		})
-
-		it('cannot create SpeechRecognition instance', () => {
-			const {
-				result: {
-					current: [ref],
-				},
-			} = renderHook(() => useVocal())
-			expect(ref.current).toBeNull()
-		})
-
-		it('not triggers start function', () => {
-			const {
-				result: {
-					current: [, { start }],
-				},
-			} = renderHook(() => useVocal())
-			start()
-			expect(mockStart).not.toHaveBeenCalled()
-		})
-
-		it('not triggers stop function', () => {
-			const {
-				result: {
-					current: [, { stop }],
-				},
-			} = renderHook(() => useVocal())
-			stop()
-			expect(mockStop).not.toHaveBeenCalled()
-		})
-
-		it('not triggers abort function', () => {
-			const {
-				result: {
-					current: [, { abort }],
-				},
-			} = renderHook(() => useVocal())
-			abort()
-			expect(mockAbort).not.toHaveBeenCalled()
-		})
-
-		it('not triggers clean function', () => {
-			const {
-				result: {
-					current: [, { clean }],
-				},
-			} = renderHook(() => useVocal())
-			clean()
-			expect(mockCleanup).not.toHaveBeenCalled()
-		})
-
-		it('not triggers subscribe function', () => {
-			const {
-				result: {
-					current: [, { subscribe }],
-				},
-			} = renderHook(() => useVocal())
-			subscribe('foo', jest.fn())
-			expect(mockAddEventListener).not.toHaveBeenCalled()
-		})
-
-		it('not triggers unsubscribe function', () => {
-			const {
-				result: {
-					current: [, { unsubscribe }],
-				},
-			} = renderHook(() => useVocal())
-			unsubscribe('foo', jest.fn())
-			expect(mockRemoveEventListener).not.toHaveBeenCalled()
-		})
-	})
-
-	describe('with SpeechRecognition support', () => {
-		beforeAll(() => {
-			mockIsSupported.mockReturnValue(true)
-		})
-
-		beforeEach(() => {
-			SpeechRecognitionWrapper.mockImplementation(() => {
-				return {
-					start: mockStart,
-					stop: mockStop,
-					abort: mockAbort,
-					addEventListener: mockAddEventListener,
-					removeEventListener: mockRemoveEventListener,
-					cleanup: mockCleanup,
-				}
-			})
-		})
-
-		afterEach(() => {
-			SpeechRecognitionWrapper.mockReset()
-		})
-
-		it('creates SpeechRecognition instance', () => {
-			const {
-				result: {
-					current: [ref],
-				},
-			} = renderHook(() => useVocal())
-			expect(ref.current).toBeDefined()
-		})
-
-		it('uses custom SpeechRecognition instance', () => {
-			const foo = new SpeechRecognitionWrapper()
-			const {
-				result: {
-					current: [ref],
-				},
-			} = renderHook(() => useVocal(null, null, foo))
-			expect(ref.current).toBe(foo)
-		})
-
-		it('triggers start function', () => {
-			const {
-				result: {
-					current: [, { start }],
-				},
-			} = renderHook(() => useVocal())
-			start()
-			expect(mockStart).toHaveBeenCalled()
-		})
-
-		it('triggers stop function', () => {
-			const {
-				result: {
-					current: [, { stop }],
-				},
-			} = renderHook(() => useVocal())
-			stop()
-			expect(mockStop).toHaveBeenCalled()
-		})
-
-		it('triggers abort function', () => {
-			const {
-				result: {
-					current: [, { abort }],
-				},
-			} = renderHook(() => useVocal())
-			abort()
-			expect(mockAbort).toHaveBeenCalled()
-		})
-
-		it('triggers clean function', () => {
-			const {
-				result: {
-					current: [, { clean }],
-				},
-			} = renderHook(() => useVocal())
-			clean()
-			expect(mockCleanup).toHaveBeenCalled()
-		})
-
-		it('triggers subscribe function', () => {
-			const {
-				result: {
-					current: [, { subscribe }],
-				},
-			} = renderHook(() => useVocal())
-			subscribe('foo', jest.fn())
-			expect(mockAddEventListener).toHaveBeenCalled()
-		})
-
-		it('triggers unsubscribe function', () => {
-			const {
-				result: {
-					current: [, { unsubscribe }],
-				},
-			} = renderHook(() => useVocal())
-			unsubscribe('foo', jest.fn())
-			expect(mockRemoveEventListener).toHaveBeenCalled()
-		})
-	})
-})

package/src/hooks/useCommands.js

@@ -1,21 +0,0 @@
-import Fuse from 'fuse.js'
-
-const useCommands = (commands, precision = 0.4) => {
-	commands = !!commands
-		? Object.entries(commands)?.reduce((acc, [key, value]) => ({ [key.toLowerCase()]: value }), {})
-		: {}
-
-	const triggerCommand = (input) => {
-		const fuse = new Fuse(Object.keys(commands), { includeScore: true, ignoreLocation: true })
-		const result = fuse.search(input).filter((r) => r.score < precision)
-		if (!!result?.length) {
-			const key = result[0].item.toLowerCase()
-			return commands[key]?.(input)
-		}
-		return null
-	}
-
-	return triggerCommand
-}
-
-export default useCommands

package/src/hooks/useTimeout.js

@@ -1,23 +0,0 @@
-import { useCallback, useEffect, useRef } from 'react'
-
-const useTimeout = (handler, timeout = 0) => {
-	const ref = useRef(-1)
-
-	const stop = useCallback(() => {
-		clearTimeout(ref.current)
-		ref.current = -1
-	}, [])
-
-	const start = useCallback(() => {
-		stop()
-		ref.current = setTimeout(handler, timeout)
-	}, [handler, timeout, stop])
-
-	useEffect(() => stop, [stop])
-
-	return [start, stop]
-}
-
-export default useTimeout
-
-// TODO: Return a promise

package/src/hooks/useVocal.js

@@ -1,58 +0,0 @@
-import { useCallback, useEffect, useRef } from 'react'
-import { Vocal as SpeechRecognitionWrapper } from '@untemps/vocal'
-
-const useVocal = (lang = 'en-US', grammars = null, __rsInstance = null) => {
-	const ref = useRef(null)
-
-	useEffect(() => {
-		if (SpeechRecognitionWrapper.isSupported) {
-			ref.current = __rsInstance || new SpeechRecognitionWrapper({ lang, grammars })
-			return () => {
-				ref.current.abort()
-				ref.current.cleanup()
-			}
-		}
-	}, [lang, grammars, __rsInstance])
-
-	const start = useCallback(() => {
-		if (ref.current) {
-			ref.current.start()
-		}
-	}, [])
-
-	const stop = useCallback(() => {
-		if (ref.current) {
-			ref.current.stop()
-		}
-	}, [])
-
-	const abort = useCallback(() => {
-		if (ref.current) {
-			ref.current.abort()
-		}
-	}, [])
-
-	const subscribe = useCallback((eventType, handler) => {
-		if (ref.current) {
-			ref.current.addEventListener(eventType, handler)
-		}
-	}, [])
-
-	const unsubscribe = useCallback((eventType, handler) => {
-		if (ref.current) {
-			ref.current.removeEventListener(eventType, handler)
-		}
-	}, [])
-
-	const clean = useCallback(() => {
-		if (ref.current) {
-			ref.current.cleanup()
-		}
-	}, [])
-
-	return [ref, { start, stop, abort, subscribe, unsubscribe, clean }]
-}
-
-export default useVocal
-
-// TODO: Return the instance, not the ref

package/src/index.js

@@ -1,7 +0,0 @@
-import Vocal from './components/Vocal'
-import { Vocal as SpeechRecognitionWrapper } from '@untemps/vocal'
-
-export { default as useVocal } from './hooks/useVocal'
-export const isSupported = SpeechRecognitionWrapper.isSupported
-
-export default Vocal