feat: create expo plugin

Author: adelbeke

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -36,7 +36,7 @@ body:
     attributes:
       label: Library version
       description: What version of the library are you using?
-      placeholder: "x.x.x"
+      placeholder: 'x.x.x'
     validations:
       required: true
   - type: textarea
@@ -61,7 +61,7 @@ body:
   - type: input
     id: reproducible-example
     attributes:
-      label: Reproducible example repository 
+      label: Reproducible example repository
       description: Please provide a link to a repository on GitHub with a reproducible example.
     validations:
       required: true

.github/workflows/ci.yml

@@ -111,7 +111,7 @@ jobs:
 
       - name: Build example for Android
         env:
-          JAVA_OPTS: "-XX:MaxHeapSize=6g"
+          JAVA_OPTS: '-XX:MaxHeapSize=6g'
         run: |
           yarn turbo run build:android --cache-dir="${{ env.TURBO_CACHE_DIR }}"
 

.yarnrc.yml

@@ -3,8 +3,8 @@ nmHoistingLimits: workspaces
 
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"
+    spec: '@yarnpkg/plugin-interactive-tools'
   - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
-    spec: "@yarnpkg/plugin-workspace-tools"
+    spec: '@yarnpkg/plugin-workspace-tools'
 
 yarnPath: .yarn/releases/yarn-3.6.1.cjs

README.md

@@ -19,8 +19,8 @@ A powerful, easy-to-use React Native library for real-time speech-to-text conver
 
 ## 📱 Demo
 
-| iOS | Android |
-| --- | ------- |
+| iOS                                                                                                       | Android                                                                                                   |
+| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
 | <video src="https://github.com/user-attachments/assets/e48938ca-87a5-4343-ab76-cecc91b8380f" width="300"> | <video src="https://github.com/user-attachments/assets/2fbf41db-bf2d-4759-9181-0b8376a96dc1" width="300"> |
 
 ## 📦 Installation
@@ -163,9 +163,11 @@ await start({ language: 'en-US' });
 ```
 
 **Options:**
+
 - `language` (string, required): Language code (e.g., "en-US", "fr-FR", "es-ES", "de-DE")
 
 **Throws:**
+
 - `PERMISSION_DENIED`: User denied permissions
 - `NOT_AVAILABLE`: Speech recognition not available
 - `START_FAILED`: Failed to start recognition
@@ -195,6 +197,7 @@ const granted = await requestPermissions({
 ```
 
 **Options (Android only):**
+
 - `title` (string, optional): Dialog title
 - `message` (string, optional): Dialog message
 - `buttonNeutral` (string, optional): Neutral button text
@@ -238,6 +241,7 @@ listener.remove();
 ```
 
 **SpeechResult:**
+
 - `transcript` (string): The recognized text
 - `confidence` (number): Confidence score from 0.0 to 1.0
 - `isFinal` (boolean): `true` for final result, `false` for partial
@@ -258,6 +262,7 @@ listener.remove();
 ```
 
 **SpeechError:**
+
 - `code` (string): Error code (see [Error Codes](#error-codes))
 - `message` (string): Human-readable error message
 
@@ -341,10 +346,12 @@ Availability depends on the device and platform. Use `isAvailable()` to check.
 ### "Permission denied" error
 
 **iOS:**
+
 - Make sure you've added `NSSpeechRecognitionUsageDescription` and `NSMicrophoneUsageDescription` to your `Info.plist`
 - Check that the user granted permissions in Settings > Your App
 
 **Android:**
+
 - Ensure `RECORD_AUDIO` permission is in `AndroidManifest.xml`
 - Call `requestPermissions()` before `start()`
 
@@ -385,6 +392,7 @@ Availability depends on the device and platform. Use `isAvailable()` to check.
 ### Network errors
 
 Some speech recognition services require internet connectivity:
+
 - **iOS**: On-device recognition available on iOS 13+ for some languages
 - **Android**: Depends on the device's speech recognition provider
 

app.plugin.js

@@ -0,0 +1,39 @@
+const { withInfoPlist, withAndroidManifest } = require('@expo/config-plugins');
+
+const withSpeechToText = (config, props = {}) => {
+  const {
+    microphonePermission = 'Allow $(PRODUCT_NAME) to access your microphone to record audio for speech recognition',
+    speechRecognitionPermission = 'Allow $(PRODUCT_NAME) to use speech recognition to convert your voice to text',
+  } = props;
+
+  config = withInfoPlist(config, (config) => {
+    config.modResults.NSSpeechRecognitionUsageDescription =
+      speechRecognitionPermission;
+    config.modResults.NSMicrophoneUsageDescription = microphonePermission;
+    return config;
+  });
+
+  config = withAndroidManifest(config, (config) => {
+    const androidManifest = config.modResults.manifest;
+
+    if (!androidManifest['uses-permission']) {
+      androidManifest['uses-permission'] = [];
+    }
+
+    const hasRecordAudio = androidManifest['uses-permission'].some(
+      (perm) => perm.$['android:name'] === 'android.permission.RECORD_AUDIO'
+    );
+
+    if (!hasRecordAudio) {
+      androidManifest['uses-permission'].push({
+        $: { 'android:name': 'android.permission.RECORD_AUDIO' },
+      });
+    }
+
+    return config;
+  });
+
+  return config;
+};
+
+module.exports = withSpeechToText;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dbkable/react-native-speech-to-text",
   "version": "0.1.0",
-  "description": "Convert audio to text",
+  "description": "Cross-platform speech recognition library for React Native using native APIs (Speech Framework & SpeechRecognizer)",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "exports": {
@@ -18,6 +18,7 @@
     "android",
     "ios",
     "cpp",
+    "app.plugin.js",
     "*.podspec",
     "react-native.config.js",
     "!ios/build",
@@ -43,7 +44,14 @@
   "keywords": [
     "react-native",
     "ios",
-    "android"
+    "android",
+    "speech",
+    "speech-to-text",
+    "voice",
+    "recognition",
+    "stt",
+    "transcription",
+    "expo"
   ],
   "repository": {
     "type": "git",
@@ -64,6 +72,7 @@
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.35.0",
     "@evilmartians/lefthook": "^1.12.3",
+    "@expo/config-plugins": "^54.0.2",
     "@react-native-community/cli": "20.0.1",
     "@react-native/babel-preset": "0.81.1",
     "@react-native/eslint-config": "^0.81.1",
@@ -160,5 +169,10 @@
     "languages": "kotlin-objc",
     "type": "turbo-module",
     "version": "0.54.8"
+  },
+  "expo": {
+    "plugins": [
+      "./app.plugin.js"
+    ]
   }
 }