@untemps/vocal 1.3.0 → 1.3.2

package/package.json

@@ -1,97 +1,105 @@
 {
-  "name": "@untemps/vocal",
-  "version": "1.3.0",
-  "description": "Class wrapped around the SpeechRecognition Web API",
-  "repository": "git@github.com:untemps/vocal.git",
-  "keywords": [
-    "Web Speech API",
-    "SpeechRecognition",
-    "speech",
-    "speech-to-text",
-    "javascript"
-  ],
-  "author": "Vincent Le Badezet <v.lebadezet@untemps.net>",
-  "license": "MIT",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
-  "file": [
-    "dist"
-  ],
-  "devDependencies": {
-    "@babel/cli": "^7.10.1",
-    "@babel/core": "^7.10.2",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.10.1",
-    "@babel/preset-env": "^7.9.6",
-    "@rollup/plugin-babel": "^5.0.2",
-    "@rollup/plugin-commonjs": "^12.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.0",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/git": "^9.0.0",
-    "@semantic-release/github": "^7.0.7",
-    "@testing-library/jest-dom": "^5.11.9",
-    "babel-jest": "^26.0.1",
-    "cross-env": "^7.0.2",
-    "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "prettier": "^2.0.5",
-    "rollup": "^2.12.0",
-    "rollup-plugin-filesize": "^9.0.0",
-    "rollup-plugin-terser": "^6.1.0",
-    "rollup-plugin-visualizer": "^4.0.4",
-    "semantic-release": "^17.0.7"
-  },
-  "dependencies": {
-    "@untemps/user-permissions-utils": "^1.1.0"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn test:ci && yarn prettier"
-    }
-  },
-  "jest": {
-    "coverageDirectory": "./coverage/",
-    "collectCoverage": true,
-    "setupFilesAfterEnv": [
-      "<rootDir>/jest/jest.setup.js"
-    ],
-    "restoreMocks": true
-  },
-  "release": {
-    "branches": [
-      "main"
-    ],
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "releaseRules": [
-            {
-              "type": "chore",
-              "release": "patch"
-            }
-          ]
-        }
-      ],
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/git",
-      "@semantic-release/github"
-    ]
-  },
-  "scripts": {
-    "dev": "cd dev && yarn && yarn start",
-    "test": "jest -u --watch",
-    "test:ci": "CI=true jest -u -b --coverage",
-    "build": " rm -rf dist && yarn build:cjs && yarn build:es && yarn build:umd",
-    "build:cjs": "cross-env NODE_ENV=production BABEL_ENV=cjs rollup -c",
-    "build:es": "cross-env NODE_ENV=production BABEL_ENV=es rollup -c",
-    "build:umd": "cross-env NODE_ENV=production BABEL_ENV=umd rollup -c",
-    "prettier": "prettier \"*/**/*.js\" --ignore-path ./.prettierignore --write"
-  }
+	"name": "@untemps/vocal",
+	"version": "1.3.2",
+	"description": "Class wrapped around the SpeechRecognition Web API",
+	"repository": "git@github.com:untemps/vocal.git",
+	"keywords": [
+		"Web Speech API",
+		"SpeechRecognition",
+		"speech",
+		"speech-to-text",
+		"javascript"
+	],
+	"author": "Vincent Le Badezet <v.lebadezet@untemps.net>",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"engines": {
+		"node": ">=22"
+	},
+	"files": [
+		"dist/index.js",
+		"dist/index.es.js",
+		"dist/index.umd.js",
+		"dist/index.d.ts",
+		"CHANGELOG.md"
+	],
+	"main": "dist/index.js",
+	"module": "dist/index.es.js",
+	"types": "dist/index.d.ts",
+	"devDependencies": {
+		"@commitlint/cli": "^21.0.1",
+		"@commitlint/config-conventional": "^21.0.1",
+		"@semantic-release/changelog": "^6.0.3",
+		"@semantic-release/git": "^10.0.1",
+		"@semantic-release/github": "^12.0.6",
+		"@testing-library/jest-dom": "^6.9.1",
+		"@vitest/coverage-v8": "^4.1.5",
+		"husky": "^9.1.7",
+		"jsdom": "^29.1.1",
+		"prettier": "^3.8.3",
+		"semantic-release": "^25.0.3",
+		"typescript": "^6.0.3",
+		"vite": "^8.0.13",
+		"vite-plugin-dts": "^5.0.0",
+		"vitest": "^4.1.5"
+	},
+	"dependencies": {
+		"@untemps/user-permissions-utils": "^1.3.0"
+	},
+	"release": {
+		"branches": [
+			"main",
+			{
+				"name": "beta",
+				"prerelease": true
+			}
+		],
+		"plugins": [
+			[
+				"@semantic-release/commit-analyzer",
+				{
+					"releaseRules": [
+						{
+							"type": "chore",
+							"release": "patch"
+						}
+					]
+				}
+			],
+			"@semantic-release/release-notes-generator",
+			"@semantic-release/changelog",
+			"@semantic-release/npm",
+			"@semantic-release/git",
+			[
+				"@semantic-release/github",
+				{
+					"assets": [
+						{
+							"path": "dist/index.js",
+							"label": "CJS distribution"
+						},
+						{
+							"path": "dist/index.es.js",
+							"label": "ES distribution"
+						},
+						{
+							"path": "dist/index.umd.js",
+							"label": "UMD distribution"
+						}
+					]
+				}
+			]
+		]
+	},
+	"scripts": {
+		"test": "vitest",
+		"test:ci": "vitest run --coverage",
+		"build": "vite build",
+		"typecheck": "tsc --noEmit",
+		"prepare": "husky",
+		"prettier": "prettier \"*/**/*.js\" --ignore-path ./.prettierignore --write"
+	}
 }

package/.github/workflows/index.yml

@@ -1,23 +0,0 @@
-name: "deploy"
-on:
-  push:
-    branches:
-      - main
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - run: yarn install
-      - run: yarn test:ci
-      - run: yarn build
-      - run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - uses: codecov/codecov-action@v1
-        with:
-          file: coverage/lcov.info

package/.prettierignore

@@ -1,2 +0,0 @@
-build/
-node_modules/

package/.prettierrc

@@ -1,29 +0,0 @@
-{
-  "printWidth": 120,
-  "useTabs": true,
-  "tabWidth": 4,
-  "singleQuote": true,
-  "semi": false,
-  "trailingComma": "es5",
-  "bracketSpacing": true,
-  "overrides": [
-    {
-      "files": "./**/*.js",
-      "options": {
-        "parser": "babylon"
-      }
-    },
-    {
-      "files": "./**/*.json",
-      "options": {
-        "parser": "json"
-      }
-    },
-    {
-      "files": ".prettierrc",
-      "options": {
-        "parser": "json"
-      }
-    }
-  ]
-}

package/CONTRIBUTING.md

@@ -1,15 +0,0 @@
-## How to contribute to `@untemps/vocal`
-
-**Contributions are warmly welcomed**
-
-Please follow those simple steps:
-- Fork the repository
-- Create a feature branch  
-Preferred name convention: [feature type]/[imperative verb]-[description of the feature] > `feat/add-foo-support`
-- Develop the feature AND write the tests (or write the tests AND develop the feature)
-- Commit your changes using Angular Git Commit Guidelines
-- Submit a Pull Request
-
-Thanks! :heart: :heart: :heart:
-
-`@untemps/vocal` Team

package/babel.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-	"presets": [
-		"@babel/preset-env"
-	],
-	"plugins": [
-		"@babel/plugin-proposal-class-properties",
-		"@babel/plugin-transform-runtime"
-	]
-}
-

package/jest/jest.setup.js

@@ -1,59 +0,0 @@
-const { toBeInTheDocument, toHaveAttribute, toHaveStyle } = require('@testing-library/jest-dom/matchers')
-import '@testing-library/jest-dom/extend-expect'
-
-expect.extend({ toBeInTheDocument, toHaveAttribute, toHaveStyle })
-
-global.PermissionStatus = jest.fn(() => ({
-	state: 'granted',
-	addEventListener: jest.fn(),
-}))
-const status = new PermissionStatus()
-global.Permissions = jest.fn(() => ({
-	query: jest.fn().mockResolvedValue(status),
-}))
-global.navigator.permissions = new Permissions()
-global.MediaDevices = jest.fn(() => ({
-	getUserMedia: jest.fn().mockResolvedValue('foo'),
-}))
-global.navigator.mediaDevices = new MediaDevices()
-global.SpeechGrammarList = jest.fn(() => ({
-	length: 0,
-}))
-global.SpeechRecognition = jest.fn(() => {
-	const handlers = {}
-	return {
-		addEventListener: jest.fn((type, callback) => {
-			handlers[type] = callback
-		}),
-		removeEventListener: jest.fn(),
-		dispatchEvent: jest.fn(),
-		start: jest.fn(() => {
-			!!handlers.start && handlers.start()
-		}),
-		stop: jest.fn(() => {
-			!!handlers.end && handlers.end()
-		}),
-		abort: jest.fn(() => {
-			!!handlers.end && handlers.end()
-		}),
-		say: jest.fn((sentence) => {
-			!!handlers.speechstart && handlers.speechstart()
-
-			const resultEvent = new Event('result')
-			resultEvent.resultIndex = 0
-			resultEvent.results = [
-				[
-					{
-						transcript: sentence,
-					},
-				],
-			]
-			if (sentence) {
-				!!handlers.result && handlers.result(resultEvent)
-			} else {
-				!!handlers.nomatch && handlers.nomatch()
-			}
-			!!handlers.speechend && handlers.speechend()
-		}),
-	}
-})

package/rollup.config.js

@@ -1,38 +0,0 @@
-import babel from '@rollup/plugin-babel'
-import commonjs from '@rollup/plugin-commonjs'
-import resolve from '@rollup/plugin-node-resolve'
-import filesize from "rollup-plugin-filesize"
-import { terser } from 'rollup-plugin-terser'
-import visualizer from 'rollup-plugin-visualizer'
-
-const production = process.env.NODE_ENV === 'production'
-const target = process.env.BABEL_ENV
-
-export default {
-	input: 'src/index.js',
-	output: {
-		name: 'vocal',
-		file: {
-			cjs: 'dist/index.js',
-			es: 'dist/index.es.js',
-			umd: 'dist/index.umd.js'
-		}[target],
-		format: target,
-		sourcemap: 'inline'
-	},
-	external: ['@babel/plugin-transform-runtime'],
-	plugins: [
-		babel({
-			exclude: 'node_modules/**',
-			babelHelpers: 'runtime'
-		}),
-		resolve(),
-		commonjs(),
-		filesize(),
-		production && terser(),
-		visualizer({
-			sourcemap: true,
-			open: true
-		})
-	],
-}

package/src/Vocal.js

@@ -1,169 +0,0 @@
-import { isNavigatorPermissionsSupported, isNavigatorMediaDevicesSupported, getUserMediaStream } from '@untemps/user-permissions-utils'
-
-class Vocal {
-	static defaultOptions = {
-		grammars: null,
-		lang: 'en-US',
-		continuous: false,
-		interimResults: false,
-		maxAlternatives: 1,
-		serviceURI: null,
-	}
-
-	static eventTypes = {
-		AUDIO_END: 'audioend',
-		AUDIO_START: 'audiostart',
-		END: 'end',
-		ERROR: 'error',
-		NO_MATCH: 'nomatch',
-		RESULT: 'result',
-		SOUND_END: 'soundend',
-		SOUND_START: 'soundstart',
-		SPEECH_END: 'speechend',
-		SPEECH_START: 'speechstart',
-		START: 'start',
-	}
-
-	static get isSupported() {
-		return !!Vocal._resolveSpeechRecognition() && !!isNavigatorPermissionsSupported() && !!isNavigatorMediaDevicesSupported()
-	}
-
-	static set isSupported(_) {
-		throw new Error('You cannot set isSupported directly.')
-	}
-
-	_instance = null
-	_listeners = null
-
-	constructor(options) {
-		const SpeechRecognition = Vocal._resolveSpeechRecognition()
-		if (!SpeechRecognition) {
-			throw new DOMException('SpeechRecognition not supported', 'NOT_SUPPORTED_ERR')
-		}
-
-		this._instance = new SpeechRecognition()
-		this._listeners = {}
-
-		Object.entries({
-			...Vocal.defaultOptions,
-			...(options || {}),
-		}).forEach(([key, value]) => {
-			if (key === 'grammars' && !value) {
-				const SpeechGrammarList = Vocal._resolveSpeechGrammarList()
-				if (!!SpeechGrammarList) {
-					value = new SpeechGrammarList()
-				}
-			}
-			this._instance[key] = value
-		})
-	}
-
-	get instance() {
-		return this._instance
-	}
-
-	set instance(_) {
-		throw new Error('You cannot set instance directly.')
-	}
-
-	async start() {
-		if (!!this._instance) {
-			try {
-				const stream = await getUserMediaStream('microphone', { audio: true })
-				if (!stream) {
-					throw new Error('Unable to retrieve the stream from media device')
-				}
-				this._instance.start()
-			} catch (error) {
-				const errorHandler = this._listeners.error
-				if (!!errorHandler) {
-					errorHandler(error)
-				}
-			}
-		}
-
-		return this
-	}
-
-	stop() {
-		if (!!this._instance) {
-			this._instance.stop()
-		}
-
-		return this
-	}
-
-	abort() {
-		if (!!this._instance) {
-			this._instance.abort()
-		}
-
-		return this
-	}
-
-	addEventListener(eventType, callback) {
-		if (!!this._instance && this._includesEventType(eventType)) {
-			if (!!this._listeners[eventType]) {
-				this.removeEventListener(eventType)
-			}
-
-			const handler = (event) => {
-				let additionalArgs = []
-				if (eventType === Vocal.eventTypes.RESULT) {
-					if (!!event.results && event.results.length > 0) {
-						additionalArgs.push(event.results[0][0].transcript)
-					}
-				}
-
-				!!callback && callback.apply(this, [event, ...additionalArgs])
-			}
-			this._instance.addEventListener(eventType, handler)
-
-			this._listeners[eventType] = handler
-		}
-
-		return this
-	}
-
-	removeEventListener(eventType) {
-		const handler = this._listeners[eventType]
-		this._instance.removeEventListener(eventType, handler)
-
-		delete this._listeners[eventType]
-
-		return this
-	}
-
-	cleanup() {
-		this.stop()
-
-		Object.keys(this._listeners).forEach((key) => this.removeEventListener(key))
-		this._instance = null
-
-		return this
-	}
-
-	_includesEventType(eventType) {
-		return !!Object.values(Vocal.eventTypes).find((type) => type === eventType)
-	}
-
-	static _resolveSpeechRecognition() {
-		return (
-			window.SpeechRecognition ||
-			window.webkitSpeechRecognition ||
-			window.mozSpeechRecognition ||
-			window.msSpeechRecognition
-		)
-	}
-
-	static _resolveSpeechGrammarList() {
-		return (
-			window.SpeechGrammarList ||
-			window.webkitSpeechGrammarList ||
-			window.mozSpeechGrammarList ||
-			window.msSpeechGrammarList
-		)
-	}
-}
-
-export default Vocal

package/src/__tests__/Vocal.test.js

@@ -1,34 +0,0 @@
-import Vocal from '../Vocal'
-import * as userPermissionsUtils from '@untemps/user-permissions-utils'
-
-describe('Vocal', () => {
-	it('throws error when setting isSupported explicitly', () => {
-		expect(() => (Vocal.isSupported = false)).toThrow()
-	})
-
-	it('throws error when setting instance explicitly', () => {
-		const wrapper = new Vocal()
-		expect(() => (wrapper.instance = null)).toThrow()
-	})
-
-	it('throws error when getUserMediaStream returns false value', async () => {
-		const onError = jest.fn()
-		jest.spyOn(userPermissionsUtils, 'getUserMediaStream').mockResolvedValueOnce(null)
-		const wrapper = new Vocal()
-		wrapper.addEventListener('error', onError)
-		await wrapper.start()
-		expect(onError).toHaveBeenCalledWith(new Error('Unable to retrieve the stream from media device'))
-	})
-
-	it('throws error when getUserMediaStream throws', async () => {
-		const onError = jest.fn()
-		const error = new Error('foo')
-		jest.spyOn(userPermissionsUtils, 'getUserMediaStream').mockImplementationOnce(() => {
-			throw error
-		})
-		const wrapper = new Vocal()
-		wrapper.addEventListener('error', onError)
-		await wrapper.start()
-		expect(onError).toHaveBeenCalledWith(error)
-	})
-})

package/src/index.js

@@ -1 +0,0 @@
-export { default as Vocal } from './Vocal'