@untemps/vocal 2.0.0-beta.24 → 2.0.0-beta.25

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+# [2.0.0-beta.25](https://github.com/untemps/vocal/compare/v2.0.0-beta.24...v2.0.0-beta.25) (2026-05-22)
+
 # [2.0.0-beta.24](https://github.com/untemps/vocal/compare/v2.0.0-beta.23...v2.0.0-beta.24) (2026-05-22)
 
 # [2.0.0-beta.23](https://github.com/untemps/vocal/compare/v2.0.0-beta.22...v2.0.0-beta.23) (2026-05-22)

package/dist/Vocal.d.ts

@@ -0,0 +1,73 @@
+declare global {
+    interface SpeechRecognition extends EventTarget {
+        continuous: boolean;
+        grammars: SpeechGrammarList | null;
+        interimResults: boolean;
+        lang: string;
+        maxAlternatives: number;
+        start(): void;
+        stop(): void;
+        abort(): void;
+    }
+    var SpeechRecognition: {
+        new (): SpeechRecognition;
+        prototype: SpeechRecognition;
+    };
+    interface SpeechGrammarList {
+        length: number;
+    }
+    var SpeechGrammarList: {
+        new (): SpeechGrammarList;
+        prototype: SpeechGrammarList;
+    };
+    interface Window {
+        SpeechRecognition?: typeof SpeechRecognition;
+        webkitSpeechRecognition?: typeof SpeechRecognition;
+        mozSpeechRecognition?: typeof SpeechRecognition;
+        msSpeechRecognition?: typeof SpeechRecognition;
+        SpeechGrammarList?: typeof SpeechGrammarList;
+        webkitSpeechGrammarList?: typeof SpeechGrammarList;
+        mozSpeechGrammarList?: typeof SpeechGrammarList;
+        msSpeechGrammarList?: typeof SpeechGrammarList;
+    }
+}
+export interface VocalOptions {
+    grammars?: SpeechGrammarList | null;
+    lang?: string;
+    continuous?: boolean;
+    interimResults?: boolean;
+    maxAlternatives?: number;
+}
+export declare const eventTypes: {
+    readonly AUDIO_END: "audioend";
+    readonly AUDIO_START: "audiostart";
+    readonly END: "end";
+    readonly ERROR: "error";
+    readonly NO_MATCH: "nomatch";
+    readonly RESULT: "result";
+    readonly SOUND_END: "soundend";
+    readonly SOUND_START: "soundstart";
+    readonly SPEECH_END: "speechend";
+    readonly SPEECH_START: "speechstart";
+    readonly START: "start";
+};
+export type EventType = (typeof eventTypes)[keyof typeof eventTypes];
+export type ResultEventHandler = (event: SpeechRecognitionEvent, bestAlternative: string, alternatives: string[]) => void;
+export type ErrorEventHandler = (event: SpeechRecognitionErrorEvent) => void;
+export type GenericEventHandler = (event: Event) => void;
+export type EventHandlerFor<T extends EventType> = T extends 'result' ? ResultEventHandler : T extends 'error' ? ErrorEventHandler : GenericEventHandler;
+export interface VocalInstance {
+    readonly isRecording: boolean;
+    start(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    stop(): void;
+    abort(): void;
+    on<T extends EventType>(eventType: T, callback: EventHandlerFor<T>): void;
+    on(eventType: string, callback: GenericEventHandler): void;
+    off<T extends EventType>(eventType: T, callback?: EventHandlerFor<T>): void;
+    off(eventType: string, callback?: GenericEventHandler): void;
+    cleanup(): void;
+}
+export declare const isSupported: () => boolean;
+export declare const createVocal: (options?: VocalOptions) => VocalInstance;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@untemps/vocal",
-	"version": "2.0.0-beta.24",
+	"version": "2.0.0-beta.25",
 	"description": "Class wrapped around the SpeechRecognition Web API",
 	"repository": "git@github.com:untemps/vocal.git",
 	"keywords": [
@@ -24,6 +24,7 @@
 		"dist/index.cjs",
 		"dist/index.es.js",
 		"dist/index.d.ts",
+		"dist/Vocal.d.ts",
 		"CHANGELOG.md"
 	],
 	"main": "dist/index.cjs",