✨ feat: Add type annotations and refactor function exports

- Modify exports in "index.ts" to include type annotations for "useEdgeSpeech" and "useMicrosoftSpeech".
- Modify export in "useOpenaiSTT/index.ts" to include a type annotation for "useOpenaiSTTWithRecord".
- Remove import of "OpenaiSpeechRecognitionOptions" in "useOpenaiSTT/useOpenaiSTTWithPSR.ts".
- Replace type "OpenaiSpeechRecognitionOptions" with "STTConfig" in "useOpenaiSTT/useOpenaiSTTWithRecord.ts" and "useOpenaiSTT/useOpenaiSTTWithSR.ts".
- Modify function parameters to use object destructuring in "useOpenaiSTT/useOpenaiSTTWithRecord.ts" and "useOpenaiSTT/useOpenaiSTTWithSR.ts".

Changes were made to add type annotations and improve code structure for better readability and maintainability.

Author: canisminor1990

src/react/index.ts

@@ -5,8 +5,8 @@ export { useAudioVisualizer } from './hooks/useAudioVisualizer';
 export { useBlobUrl } from './hooks/useBlobUrl';
 export { useStreamAudioPlayer } from './hooks/useStreamAudioPlayer';
 export { useAudioRecorder } from './useAudioRecorder';
-export { type EdgeSpeechOptions,useEdgeSpeech } from './useEdgeSpeech';
-export { type MicrosoftSpeechOptions,useMicrosoftSpeech } from './useMicrosoftSpeech';
+export { type EdgeSpeechOptions, useEdgeSpeech } from './useEdgeSpeech';
+export { type MicrosoftSpeechOptions, useMicrosoftSpeech } from './useMicrosoftSpeech';
 export {
   type OpenaiSpeechRecognitionOptions,
   type OpenAISTTConfig,
@@ -21,4 +21,4 @@ export {
   type SpeechRecognitionOptions,
   useSpeechRecognition,
 } from './useSpeechRecognition/useSpeechRecognition';
-export { type SpeechSynthesOptions,useSpeechSynthes } from './useSpeechSynthes';
+export { type SpeechSynthesOptions, useSpeechSynthes } from './useSpeechSynthes';

src/react/useOpenaiSTT/index.ts

@@ -1,7 +1,4 @@
 export { type OpenAISTTConfig, useOpenaiSTT } from './useOpenaiSTT';
 export { useOpenaiSTTWithPSR } from './useOpenaiSTTWithPSR';
-export {
-  type OpenaiSpeechRecognitionOptions,
-  useOpenaiSTTWithRecord,
-} from './useOpenaiSTTWithRecord';
+export { type STTConfig, useOpenaiSTTWithRecord } from './useOpenaiSTTWithRecord';
 export { useOpenaiSTTWithSR } from './useOpenaiSTTWithSR';

src/react/useOpenaiSTT/useOpenaiSTTWithPSR.ts

@@ -3,11 +3,10 @@ import { useCallback, useState } from 'react';
 import { useOpenaiSTT } from '@/react/useOpenaiSTT/useOpenaiSTT';
 import { usePersistedSpeechRecognition } from '@/react/useSpeechRecognition';
 
-import { OpenaiSpeechRecognitionOptions, STTConfig } from './useOpenaiSTTWithRecord';
+import { STTConfig } from './useOpenaiSTTWithRecord';
 
 export const useOpenaiSTTWithPSR = (
   locale: string,
-  config: OpenaiSpeechRecognitionOptions,
   {
     onBlobAvailable,
     onTextChange,
@@ -16,6 +15,7 @@ export const useOpenaiSTTWithPSR = (
     onFinished,
     onStart,
     onStop,
+    options,
     ...restConfig
   }: STTConfig = {},
 ) => {
@@ -68,7 +68,7 @@ export const useOpenaiSTTWithPSR = (
       handleStop();
       onFinished?.(data, ...rest);
     },
-    options: config.options!,
+    options: options!,
     shouldFetch,
     speech: blob as Blob,
     ...restConfig,

src/react/useOpenaiSTT/useOpenaiSTTWithRecord.ts

@@ -7,27 +7,26 @@ import { SpeechRecognitionOptions } from '@/react/useSpeechRecognition/useSpeech
 
 import { OpenAISTTConfig } from './useOpenaiSTT';
 
-export type OpenaiSpeechRecognitionOptions = SpeechRecognitionOptions & Partial<OpenAISTTConfig>;
-
-export interface STTConfig extends SpeechRecognitionOptions, SWRConfiguration {
+export interface STTConfig
+  extends SpeechRecognitionOptions,
+    SWRConfiguration,
+    Partial<OpenAISTTConfig> {
   onFinished?: SWRConfiguration['onSuccess'];
   onStart?: () => void;
   onStop?: () => void;
 }
 
-export const useOpenaiSTTWithRecord = (
-  config: Partial<OpenAISTTConfig>,
-  {
-    onBlobAvailable,
-    onTextChange,
-    onSuccess,
-    onError,
-    onFinished,
-    onStart,
-    onStop,
-    ...restConfig
-  }: STTConfig = {},
-) => {
+export const useOpenaiSTTWithRecord = ({
+  onBlobAvailable,
+  onTextChange,
+  onSuccess,
+  onError,
+  onFinished,
+  onStart,
+  onStop,
+  options,
+  ...restConfig
+}: STTConfig = {}) => {
   const [isGlobalLoading, setIsGlobalLoading] = useState<boolean>(false);
   const [shouldFetch, setShouldFetch] = useState<boolean>(false);
   const [text, setText] = useState<string>();
@@ -65,7 +64,7 @@ export const useOpenaiSTTWithRecord = (
       handleStop();
       onFinished?.(data, ...rest);
     },
-    options: config.options!,
+    options: options!,
     shouldFetch,
     speech: blob as Blob,
     ...restConfig,

src/react/useOpenaiSTT/useOpenaiSTTWithSR.ts

@@ -3,11 +3,10 @@ import { useCallback, useState } from 'react';
 import { useOpenaiSTT } from '@/react/useOpenaiSTT/useOpenaiSTT';
 import { useSpeechRecognition } from '@/react/useSpeechRecognition';
 
-import { OpenaiSpeechRecognitionOptions, STTConfig } from './useOpenaiSTTWithRecord';
+import { STTConfig } from './useOpenaiSTTWithRecord';
 
 export const useOpenaiSTTWithSR = (
   locale: string,
-  config: OpenaiSpeechRecognitionOptions,
   {
     onBlobAvailable,
     onTextChange,
@@ -16,6 +15,7 @@ export const useOpenaiSTTWithSR = (
     onFinished,
     onStart,
     onStop,
+    options,
     ...restConfig
   }: STTConfig = {},
 ) => {
@@ -68,7 +68,7 @@ export const useOpenaiSTTWithSR = (
       handleStop();
       onFinished?.(data, ...rest);
     },
-    options: config.options!,
+    options: options!,
     shouldFetch,
     speech: blob as Blob,
     ...restConfig,