@untemps/react-vocal 2.0.0-beta.1 → 2.0.0-beta.11

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

@@ -1,197 +0,0 @@
-import { renderHook } from '@testing-library/react'
-import { Vocal as SpeechRecognitionWrapper } from '@untemps/vocal'
-
-import useVocal from '../useVocal'
-
-vi.mock('@untemps/vocal')
-
-describe('useVocal', () => {
-	const mockStart = vi.fn()
-	const mockStop = vi.fn()
-	const mockAbort = vi.fn()
-	const mockAddEventListener = vi.fn()
-	const mockRemoveEventListener = vi.fn()
-	const mockCleanup = vi.fn()
-
-	const mockIsSupported = vi.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', vi.fn())
-			expect(mockAddEventListener).not.toHaveBeenCalled()
-		})
-
-		it('not triggers unsubscribe function', () => {
-			const {
-				result: {
-					current: [, { unsubscribe }],
-				},
-			} = renderHook(() => useVocal())
-			unsubscribe('foo', vi.fn())
-			expect(mockRemoveEventListener).not.toHaveBeenCalled()
-		})
-	})
-
-	describe('with SpeechRecognition support', () => {
-		beforeAll(() => {
-			mockIsSupported.mockReturnValue(true)
-		})
-
-		beforeEach(() => {
-			SpeechRecognitionWrapper.mockImplementation(function () {
-				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', vi.fn())
-			expect(mockAddEventListener).toHaveBeenCalled()
-		})
-
-		it('triggers unsubscribe function', () => {
-			const {
-				result: {
-					current: [, { unsubscribe }],
-				},
-			} = renderHook(() => useVocal())
-			unsubscribe('foo', vi.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,21 +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

package/src/hooks/useVocal.js

@@ -1,56 +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

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

package/vite.config.js

@@ -1,35 +0,0 @@
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
-
-export default defineConfig({
-	plugins: [react()],
-	build: {
-		lib: {
-			entry: 'src/index.js',
-			name: 'ReactVocal',
-			formats: ['es', 'cjs', 'umd'],
-			fileName: (format) => ({ es: 'index.es.js', umd: 'index.umd.js', cjs: 'index.js' })[format],
-		},
-		rollupOptions: {
-			external: ['react', 'react-dom'],
-			output: {
-				globals: {
-					react: 'React',
-					'react-dom': 'ReactDOM',
-				},
-			},
-		},
-		sourcemap: true,
-	},
-	test: {
-		globals: true,
-		environment: 'jsdom',
-		setupFiles: ['./vitest.setup.js'],
-		restoreMocks: true,
-		coverage: {
-			provider: 'v8',
-			reporter: ['text', 'lcov'],
-			reportsDirectory: './coverage',
-		},
-	},
-})

package/vitest.setup.js

@@ -1,71 +0,0 @@
-import { vi } from 'vitest'
-import '@testing-library/jest-dom/vitest'
-
-Object.defineProperty(global, 'navigator', {
-	value: { userAgent: 'node.js' },
-	writable: true,
-	configurable: true,
-})
-global.PermissionStatus = vi.fn(function () {
-	return {
-		state: 'granted',
-		addEventListener: vi.fn(),
-	}
-})
-global.Permissions = vi.fn(function () {
-	return {
-		query: vi.fn().mockResolvedValue(new PermissionStatus()),
-	}
-})
-Object.defineProperty(global.navigator, 'permissions', {
-	value: new Permissions(),
-	writable: true,
-	configurable: true,
-})
-global.MediaDevices = vi.fn(function () {
-	return {
-		getUserMedia: vi.fn().mockResolvedValue('foo'),
-	}
-})
-Object.defineProperty(global.navigator, 'mediaDevices', {
-	value: new MediaDevices(),
-	writable: true,
-	configurable: true,
-})
-global.SpeechGrammarList = vi.fn(function () {
-	return {
-		length: 0,
-	}
-})
-global.SpeechRecognition = vi.fn(function () {
-	const handlers = {}
-	return {
-		addEventListener: vi.fn(function (type, callback) {
-			handlers[type] = callback
-		}),
-		removeEventListener: vi.fn(),
-		dispatchEvent: vi.fn(),
-		start: vi.fn(function () {
-			handlers.start?.()
-		}),
-		stop: vi.fn(function () {
-			handlers.end?.()
-		}),
-		abort: vi.fn(function () {
-			handlers.end?.()
-		}),
-		say: vi.fn(function (sentence) {
-			handlers.speechstart?.()
-
-			const resultEvent = new Event('result')
-			resultEvent.resultIndex = 0
-			resultEvent.results = [[{ transcript: sentence }]]
-			handlers.speechend?.()
-			if (sentence) {
-				handlers.result?.(resultEvent)
-			} else {
-				handlers.nomatch?.()
-			}
-		}),
-	}
-})