react-native-voice-ts 1.0.1 → 1.0.3

package/src/VoiceUtilTypes.ts

@@ -1,46 +0,0 @@
-/**
- * React Native Voice - Speech Recognition Utility Types
- *
- * This file contains helper types and interfaces for working with
- * speech recognition functionality.
- */
-
-export interface VoiceOptions {
-  /** Android: Language model type (LANGUAGE_MODEL_FREE_FORM or LANGUAGE_MODEL_WEB_SEARCH) */
-  EXTRA_LANGUAGE_MODEL?: string;
-  /** Android: Maximum number of results */
-  EXTRA_MAX_RESULTS?: number;
-  /** Android: Enable partial results */
-  EXTRA_PARTIAL_RESULTS?: boolean;
-  /** Android: Auto request permissions */
-  REQUEST_PERMISSIONS_AUTO?: boolean;
-  /** iOS: Detection mode (automatic, manual) */
-  iosCategory?: string;
-}
-
-export interface RecognitionStats {
-  /** Duration of recognition in milliseconds */
-  duration: number;
-  /** Whether recognition is currently active */
-  isActive: boolean;
-  /** Last recognized results */
-  lastResults: string[];
-  /** Start timestamp */
-  startTime: number;
-}
-
-export interface PermissionResult {
-  /** Whether permission was granted */
-  granted: boolean;
-  /** Error message if permission check failed */
-  error?: string;
-}
-
-export interface Language {
-  /** Language code (e.g., 'en-US') */
-  code: string;
-  /** Display name */
-  name: string;
-  /** Whether language is available */
-  available: boolean;
-}

package/src/components/MicIcon.tsx

@@ -1,72 +0,0 @@
-import React from 'react';
-import Svg, { Path, Rect } from 'react-native-svg';
-
-export interface MicIconProps {
-  size?: number;
-  color?: string;
-  strokeWidth?: number;
-}
-
-/**
- * Microphone Icon Component
- * Based on Lucide mic icon
- */
-export const MicIcon: React.FC<MicIconProps> = ({
-  size = 24,
-  color = 'currentColor',
-  strokeWidth = 2,
-}) => {
-  return (
-    <Svg
-      width={size}
-      height={size}
-      viewBox="0 0 24 24"
-      fill="none"
-      stroke={color}
-      strokeWidth={strokeWidth}
-      strokeLinecap="round"
-      strokeLinejoin="round"
-    >
-      <Path d="M12 19v3" />
-      <Path d="M19 10v2a7 7 0 0 1-14 0v-2" />
-      <Rect x="9" y="2" width="6" height="13" rx="3" />
-    </Svg>
-  );
-};
-
-export interface MicOffIconProps {
-  size?: number;
-  color?: string;
-  strokeWidth?: number;
-}
-
-/**
- * Microphone Off Icon Component
- * For recording/stop state
- */
-export const MicOffIcon: React.FC<MicOffIconProps> = ({
-  size = 24,
-  color = 'currentColor',
-  strokeWidth = 2,
-}) => {
-  return (
-    <Svg
-      width={size}
-      height={size}
-      viewBox="0 0 24 24"
-      fill="none"
-      stroke={color}
-      strokeWidth={strokeWidth}
-      strokeLinecap="round"
-      strokeLinejoin="round"
-    >
-      <Path d="M2 2l20 20" />
-      <Path d="M12 12a3 3 0 0 0 3-3V5a3 3 0 1 0-6 0v1" />
-      <Path d="M19 10v2a7 7 0 0 1-11.18 5.66" />
-      <Path d="M4.27 16.73A7 7 0 0 1 5 12v-2" />
-      <Path d="M12 17v5" />
-    </Svg>
-  );
-};
-
-export default MicIcon;

package/src/components/VoiceMicrophone.tsx

@@ -1,238 +0,0 @@
-import React, { useEffect, useState, useCallback } from 'react';
-import Voice from '../index';
-import type { SpeechErrorEvent, SpeechResultsEvent } from '../VoiceModuleTypes';
-
-export interface VoiceMicrophoneProps {
-  /**
-   * Callback fired when speech is recognized and converted to text
-   */
-  onSpeechResult?: (text: string) => void;
-
-  /**
-   * Callback fired when partial results are available (real-time)
-   */
-  onPartialResult?: (text: string) => void;
-
-  /**
-   * Callback fired when recording starts
-   */
-  onStart?: () => void;
-
-  /**
-   * Callback fired when recording stops
-   */
-  onStop?: () => void;
-
-  /**
-   * Callback fired when an error occurs
-   */
-  onError?: (error: string) => void;
-
-  /**
-   * Language locale for speech recognition
-   * @default 'en-US'
-   */
-  locale?: string;
-
-  /**
-   * Whether to automatically start recording on mount
-   * @default false
-   */
-  autoStart?: boolean;
-
-  /**
-   * Whether to enable partial results (real-time transcription)
-   * @default true
-   */
-  enablePartialResults?: boolean;
-
-  /**
-   * Custom render function for the component
-   * Receives isRecording state and control functions
-   */
-  children?: (props: {
-    isRecording: boolean;
-    recognizedText: string;
-    partialText: string;
-    start: () => Promise<void>;
-    stop: () => Promise<void>;
-    cancel: () => Promise<void>;
-    error: string | null;
-  }) => React.ReactNode;
-}
-
-/**
- * VoiceMicrophone Component
- *
- * A ready-to-use voice recognition component that handles microphone access,
- * speech recognition, and provides real-time text results.
- *
- * @example
- * ```tsx
- * // Simple usage with callback
- * <VoiceMicrophone
- *   onSpeechResult={(text) => setSearchQuery(text)}
- * />
- *
- * // Custom render with full control
- * <VoiceMicrophone locale="en-US">
- *   {({ isRecording, recognizedText, start, stop }) => (
- *     <View>
- *       <Text>{recognizedText}</Text>
- *       <Button
- *         onPress={isRecording ? stop : start}
- *         title={isRecording ? 'Stop' : 'Start'}
- *       />
- *     </View>
- *   )}
- * </VoiceMicrophone>
- * ```
- */
-const VoiceMicrophone: React.FC<VoiceMicrophoneProps> = ({
-  onSpeechResult,
-  onPartialResult,
-  onStart,
-  onStop,
-  onError,
-  locale = 'en-US',
-  autoStart = false,
-  enablePartialResults = true,
-  children,
-}) => {
-  const [isRecording, setIsRecording] = useState(false);
-  const [recognizedText, setRecognizedText] = useState('');
-  const [partialText, setPartialText] = useState('');
-  const [error, setError] = useState<string | null>(null);
-
-  useEffect(() => {
-    // Set up event listeners
-    Voice.onSpeechStart = () => {
-      setIsRecording(true);
-      setError(null);
-      onStart?.();
-    };
-
-    Voice.onSpeechEnd = () => {
-      setIsRecording(false);
-      onStop?.();
-    };
-
-    Voice.onSpeechError = (e: SpeechErrorEvent) => {
-      const errorMessage = e.error?.message || 'Unknown error';
-      setError(errorMessage);
-      setIsRecording(false);
-      onError?.(errorMessage);
-    };
-
-    Voice.onSpeechResults = (e: SpeechResultsEvent) => {
-      if (e.value && e.value.length > 0) {
-        const text = e.value[0];
-        setRecognizedText(text);
-        onSpeechResult?.(text);
-      }
-    };
-
-    if (enablePartialResults) {
-      Voice.onSpeechPartialResults = (e: SpeechResultsEvent) => {
-        if (e.value && e.value.length > 0) {
-          const text = e.value[0];
-          setPartialText(text);
-          onPartialResult?.(text);
-        }
-      };
-    }
-
-    // Cleanup
-    return () => {
-      Voice.destroy().then(Voice.removeAllListeners);
-    };
-  }, [
-    onSpeechResult,
-    onPartialResult,
-    onStart,
-    onStop,
-    onError,
-    enablePartialResults,
-  ]);
-
-  // Auto-start if enabled
-  useEffect(() => {
-    if (autoStart) {
-      start();
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [autoStart]);
-
-  const start = useCallback(async () => {
-    try {
-      setError(null);
-      setRecognizedText('');
-      setPartialText('');
-
-      // Check permission (Android only)
-      const hasPermission = await Voice.checkMicrophonePermission();
-      if (!hasPermission) {
-        const granted = await Voice.requestMicrophonePermission();
-        if (!granted) {
-          setError('Microphone permission denied');
-          return;
-        }
-      }
-
-      await Voice.start(locale, {
-        EXTRA_PARTIAL_RESULTS: enablePartialResults,
-      });
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to start recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [locale, enablePartialResults, onError]);
-
-  const stop = useCallback(async () => {
-    try {
-      await Voice.stop();
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to stop recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [onError]);
-
-  const cancel = useCallback(async () => {
-    try {
-      await Voice.cancel();
-      setRecognizedText('');
-      setPartialText('');
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to cancel recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [onError]);
-
-  // If children render prop is provided, use it
-  if (children) {
-    return (
-      <>
-        {children({
-          isRecording,
-          recognizedText,
-          partialText,
-          start,
-          stop,
-          cancel,
-          error,
-        })}
-      </>
-    );
-  }
-
-  // Default: render nothing (headless component)
-  return null;
-};
-
-export default VoiceMicrophone;

package/src/components/index.ts

@@ -1,4 +0,0 @@
-export { default as VoiceMicrophone } from './VoiceMicrophone';
-export type { VoiceMicrophoneProps } from './VoiceMicrophone';
-export { MicIcon, MicOffIcon } from './MicIcon';
-export type { MicIconProps, MicOffIconProps } from './MicIcon';

package/src/hooks/index.ts

@@ -1,5 +0,0 @@
-export { useVoiceRecognition } from './useVoiceRecognition';
-export type {
-  UseVoiceRecognitionOptions,
-  UseVoiceRecognitionReturn,
-} from './useVoiceRecognition';

package/src/hooks/useVoiceRecognition.ts

@@ -1,217 +0,0 @@
-import { useEffect, useState, useCallback } from 'react';
-import Voice from '../index';
-import type { SpeechErrorEvent, SpeechResultsEvent } from '../VoiceModuleTypes';
-
-export interface UseVoiceRecognitionOptions {
-  /**
-   * Language locale for speech recognition
-   * @default 'en-US'
-   */
-  locale?: string;
-
-  /**
-   * Whether to enable partial results (real-time transcription)
-   * @default true
-   */
-  enablePartialResults?: boolean;
-
-  /**
-   * Callback fired when speech is recognized
-   */
-  onResult?: (text: string) => void;
-
-  /**
-   * Callback fired when an error occurs
-   */
-  onError?: (error: string) => void;
-}
-
-export interface UseVoiceRecognitionReturn {
-  /**
-   * Whether voice recognition is currently active
-   */
-  isRecording: boolean;
-
-  /**
-   * Final recognized text results
-   */
-  results: string[];
-
-  /**
-   * Partial results (real-time transcription)
-   */
-  partialResults: string[];
-
-  /**
-   * Error message if an error occurred
-   */
-  error: string | null;
-
-  /**
-   * Start voice recognition
-   */
-  start: () => Promise<void>;
-
-  /**
-   * Stop voice recognition and get final results
-   */
-  stop: () => Promise<void>;
-
-  /**
-   * Cancel voice recognition without getting results
-   */
-  cancel: () => Promise<void>;
-
-  /**
-   * Reset all state
-   */
-  reset: () => void;
-}
-
-/**
- * Custom hook for voice recognition
- *
- * Provides a simple interface for speech-to-text functionality with automatic
- * event listener setup and cleanup.
- *
- * @example
- * ```tsx
- * const { isRecording, results, start, stop } = useVoiceRecognition({
- *   locale: 'en-US',
- *   onResult: (text) => setSearchQuery(text),
- * });
- *
- * // In your component
- * <Button
- *   onPress={isRecording ? stop : start}
- *   title={isRecording ? 'Stop' : 'Start Recording'}
- * />
- * <Text>{results[0]}</Text>
- * ```
- */
-export const useVoiceRecognition = (
-  options: UseVoiceRecognitionOptions = {},
-): UseVoiceRecognitionReturn => {
-  const {
-    locale = 'en-US',
-    enablePartialResults = true,
-    onResult,
-    onError,
-  } = options;
-
-  const [isRecording, setIsRecording] = useState(false);
-  const [results, setResults] = useState<string[]>([]);
-  const [partialResults, setPartialResults] = useState<string[]>([]);
-  const [error, setError] = useState<string | null>(null);
-
-  useEffect(() => {
-    // Set up event listeners
-    Voice.onSpeechStart = () => {
-      setIsRecording(true);
-      setError(null);
-    };
-
-    Voice.onSpeechEnd = () => {
-      setIsRecording(false);
-    };
-
-    Voice.onSpeechError = (e: SpeechErrorEvent) => {
-      const errorMessage = e.error?.message || 'Unknown error';
-      setError(errorMessage);
-      setIsRecording(false);
-      onError?.(errorMessage);
-    };
-
-    Voice.onSpeechResults = (e: SpeechResultsEvent) => {
-      if (e.value && e.value.length > 0) {
-        setResults(e.value);
-        const firstResult = e.value[0];
-        if (firstResult) {
-          onResult?.(firstResult);
-        }
-      }
-    };
-
-    if (enablePartialResults) {
-      Voice.onSpeechPartialResults = (e: SpeechResultsEvent) => {
-        if (e.value && e.value.length > 0) {
-          setPartialResults(e.value);
-        }
-      };
-    }
-
-    // Cleanup
-    return () => {
-      Voice.destroy().then(Voice.removeAllListeners);
-    };
-  }, [enablePartialResults, onResult, onError]);
-
-  const start = useCallback(async () => {
-    try {
-      setError(null);
-      setResults([]);
-      setPartialResults([]);
-
-      // Check permission (Android only)
-      const hasPermission = await Voice.checkMicrophonePermission();
-      if (!hasPermission) {
-        const granted = await Voice.requestMicrophonePermission();
-        if (!granted) {
-          setError('Microphone permission denied');
-          return;
-        }
-      }
-
-      await Voice.start(locale, {
-        EXTRA_PARTIAL_RESULTS: enablePartialResults,
-      });
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to start recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [locale, enablePartialResults, onError]);
-
-  const stop = useCallback(async () => {
-    try {
-      await Voice.stop();
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to stop recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [onError]);
-
-  const cancel = useCallback(async () => {
-    try {
-      await Voice.cancel();
-      setResults([]);
-      setPartialResults([]);
-    } catch (e) {
-      const errorMessage =
-        e instanceof Error ? e.message : 'Failed to cancel recording';
-      setError(errorMessage);
-      onError?.(errorMessage);
-    }
-  }, [onError]);
-
-  const reset = useCallback(() => {
-    setResults([]);
-    setPartialResults([]);
-    setError(null);
-    setIsRecording(false);
-  }, []);
-
-  return {
-    isRecording,
-    results,
-    partialResults,
-    error,
-    start,
-    stop,
-    cancel,
-    reset,
-  };
-};

package/src/images/mic.svg

@@ -1,16 +0,0 @@
-<svg
-  xmlns="http://www.w3.org/2000/svg"
-  width="24"
-  height="24"
-  viewBox="0 0 24 24"
-  fill="none"
-  stroke="currentColor"
-  stroke-width="2"
-  stroke-linecap="round"
-  stroke-linejoin="round"
-  class="lucide lucide-mic-icon lucide-mic"
->
-  <path d="M12 19v3" />
-  <path d="M19 10v2a7 7 0 0 1-14 0v-2" />
-  <rect x="9" y="2" width="6" height="13" rx="3" />
-</svg>;