expo-speech 9.1.0 → 10.0.1

package/CHANGELOG.md

@@ -8,6 +8,40 @@
 
 ### 🐛 Bug fixes
 
+### 💡 Others
+
+## 10.0.1 — 2021-10-01
+
+_This version does not introduce any user-facing changes._
+
+## 10.0.0 — 2021-09-28
+
+### 🛠 Breaking changes
+
+- Dropped support for iOS 11.0 ([#14383](https://github.com/expo/expo/pull/14383) by [@cruzach](https://github.com/cruzach))
+
+### 🐛 Bug fixes
+
+- Fix setting speaking listener for projects with `react-native@>0.64.0`. ([#13654](https://github.com/expo/expo/pull/13654) by [@dsokal](https://github.com/dsokal))
+- Fix empty voices list on web and allow to change voice when using `speak`. ([#4516](https://github.com/expo/expo/pull/14516) by [@Federkun](https://github.com/Federkun))
+- Fix building errors from use_frameworks! in Podfile. ([#14523](https://github.com/expo/expo/pull/14523) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Migrated from `@unimodules/core` to `expo-modules-core`. ([#13757](https://github.com/expo/expo/pull/13757) by [@tsapeta](https://github.com/tsapeta))
+- Rewritten Android code to Kotlin. ([#14008](https://github.com/expo/expo/pull/14008) by [@barthap](https://github.com/barthap))
+
+## 9.2.0 — 2021-06-16
+
+### 🐛 Bug fixes
+
+- Enable kotlin in all modules. ([#12716](https://github.com/expo/expo/pull/12716) by [@wschurman](https://github.com/wschurman))
+
+### 💡 Others
+
+- Build Android code using Java 8 to fix Android instrumented test build error. ([#12939](https://github.com/expo/expo/pull/12939) by [@kudo](https://github.com/kudo))
+- Export missing `WebVoice` type. ([#13257](https://github.com/expo/expo/pull/13257) by [@Simek](https://github.com/Simek))
+
 ## 9.1.0 — 2021-03-10
 
 ### 🎉 New features

package/android/build.gradle

@@ -1,12 +1,23 @@
 apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
 apply plugin: 'maven'
 
 group = 'host.exp.exponent'
-version = '9.1.0'
+version = '10.0.1'
 
-// Simple helper that allows the root project to override versions declared by this library.
-def safeExtGet(prop, fallback) {
-  rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+buildscript {
+  // Simple helper that allows the root project to override versions declared by this library.
+  ext.safeExtGet = { prop, fallback ->
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+  }
+
+  repositories {
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${safeExtGet('kotlinVersion', '1.4.21')}")
+  }
 }
 
 // Upload android library to maven with javadoc and android sources
@@ -37,25 +48,27 @@ uploadArchives {
 android {
   compileSdkVersion safeExtGet("compileSdkVersion", 30)
 
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 18
-    versionName "9.1.0"
+    versionName "10.0.1"
   }
   lintOptions {
     abortOnError false
   }
-}
-
-if (new File(rootProject.projectDir.parentFile, 'package.json').exists()) {
-  apply from: project(":unimodules-core").file("../unimodules-core.gradle")
-} else {
-  throw new GradleException(
-      "'unimodules-core.gradle' was not found in the usual React Native dependency location. " +
-          "This package can only be used in such projects. Are you sure you've installed the dependencies properly?")
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_1_8
+  }
 }
 
 dependencies {
-  unimodule "unimodules-core"
+  implementation project(':expo-modules-core')
+
+  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${safeExtGet('kotlinVersion', '1.4.21')}"
 }

package/android/src/main/java/expo/modules/speech/LanguageUtils.kt

@@ -0,0 +1,34 @@
+package expo.modules.speech
+
+import java.util.*
+
+// Lazy load the ISO codes into a Map then transform the codes to match other localization patterns in Expo
+object LanguageUtils {
+  private val countryISOCodes: Map<String, Locale> by lazy {
+    Locale.getISOCountries().map { country ->
+      val locale = Locale("", country)
+      locale.getISO3Country().toUpperCase(locale) to locale
+    }.toMap()
+  }
+  private val languageISOCodes: Map<String, Locale> by lazy {
+    Locale.getISOLanguages().map { language ->
+      val locale = Locale(language)
+      locale.getISO3Language() to locale
+    }.toMap()
+  }
+
+  // NOTE: These helpers are null-unsafe and should be called ONLY with codes
+  // returned by Locale.getISO3Country() and Locale.getISO3Language() respectively
+  private fun transformCountryISO(code: String) = countryISOCodes[code]!!.country
+  private fun transformLanguageISO(code: String) = languageISOCodes[code]!!.language
+
+  fun getISOCode(locale: Locale): String {
+    var language = transformLanguageISO(locale.getISO3Language())
+    val country = locale.getISO3Country()
+    if (country != "") {
+      val countryCode = transformCountryISO(country)
+      language += "-$countryCode"
+    }
+    return language
+  }
+}

package/android/src/main/java/expo/modules/speech/SpeechModule.kt

@@ -0,0 +1,191 @@
+package expo.modules.speech
+
+import android.content.Context
+import android.os.Bundle
+import android.speech.tts.TextToSpeech
+import android.speech.tts.UtteranceProgressListener
+import android.speech.tts.Voice
+import expo.modules.core.ExportedModule
+import expo.modules.core.ModuleRegistry
+import expo.modules.core.ModuleRegistryDelegate
+import expo.modules.core.Promise
+import expo.modules.core.interfaces.ExpoMethod
+import expo.modules.core.interfaces.LifecycleEventListener
+import expo.modules.core.interfaces.services.EventEmitter
+import expo.modules.core.interfaces.services.UIManager
+import java.util.*
+
+class SpeechModule(
+  context: Context,
+  private val moduleRegistryDelegate: ModuleRegistryDelegate = ModuleRegistryDelegate()
+) : ExportedModule(context), LifecycleEventListener {
+
+  private inline fun <reified T> moduleRegistry() =
+    moduleRegistryDelegate.getFromModuleRegistry<T>()
+
+  private val uiManager: UIManager by moduleRegistry()
+  private val delayedUtterances: Queue<Utterance> = ArrayDeque()
+
+  // Module basic definitions
+  override fun getName() = "ExponentSpeech"
+  override fun getConstants() = mapOf(
+    "maxSpeechInputLength" to TextToSpeech.getMaxSpeechInputLength()
+  )
+
+  // Module methods
+
+  @ExpoMethod
+  fun isSpeaking(promise: Promise) = promise.resolve(textToSpeech.isSpeaking)
+
+  @ExpoMethod
+  fun getVoices(promise: Promise) {
+    var nativeVoices: List<Voice> = emptyList()
+    try {
+      nativeVoices = textToSpeech.voices.toList()
+    } catch (e: Exception) {}
+
+    val voices = nativeVoices.map {
+      val quality = if (it.quality > Voice.QUALITY_NORMAL) {
+        "Enhanced"
+      } else {
+        "Default"
+      }
+
+      Bundle().apply {
+        putString("identifier", it.name)
+        putString("name", it.name)
+        putString("quality", quality)
+        putString("language", LanguageUtils.getISOCode(it.locale))
+      }
+    }
+
+    promise.resolve(voices)
+  }
+
+  @ExpoMethod
+  fun stop(promise: Promise) {
+    textToSpeech.stop()
+    promise.resolve(null)
+  }
+
+  @ExpoMethod
+  fun speak(id: String, text: String, options: Map<String, Any>?, promise: Promise) {
+    val speechOptions = SpeechOptions.optionsFromMap(options, promise) ?: return
+
+    if (text.length > TextToSpeech.getMaxSpeechInputLength()) {
+      promise.reject(
+        "ERR_SPEECH_INPUT_LENGTH",
+        "Speech input text is too long! Limit of input length is: " + TextToSpeech.getMaxSpeechInputLength()
+      )
+      return
+    }
+
+    if (isTextToSpeechReady) {
+      speakOut(id, text, speechOptions)
+    } else {
+      delayedUtterances.add(Utterance(id, text, speechOptions))
+
+      // init TTS, speaking will be available only after onInit
+      textToSpeech
+    }
+    promise.resolve(null)
+  }
+
+  private fun speakOut(id: String, text: String, options: SpeechOptions) {
+    options.pitch?.let(textToSpeech::setPitch)
+    options.rate?.let(textToSpeech::setSpeechRate)
+
+    textToSpeech.language = options.language?.let {
+      val locale = Locale(it)
+      val languageAvailable = textToSpeech.isLanguageAvailable(locale)
+
+      return@let if (
+        languageAvailable != TextToSpeech.LANG_MISSING_DATA &&
+        languageAvailable != TextToSpeech.LANG_NOT_SUPPORTED
+      ) {
+        locale
+      } else {
+        Locale.getDefault()
+      }
+    } ?: Locale.getDefault()
+
+    options.voice?.let { voiceName ->
+      textToSpeech.voices
+        .firstOrNull { it.name == voiceName }
+        ?.let(textToSpeech::setVoice)
+    }
+
+    textToSpeech.speak(
+      text,
+      TextToSpeech.QUEUE_ADD,
+      null,
+      id
+    )
+  }
+
+  // TextToSpeech object related code
+
+  private val isTextToSpeechReady
+    get() = _ttsReady
+
+  private val textToSpeech: TextToSpeech by lazy {
+    val newTtsInstance = TextToSpeech(context) { status: Int ->
+      if (status == TextToSpeech.SUCCESS) {
+        // synchronize because in some cases this runs on another thread and _textToSpeech is null
+        synchronized(this@SpeechModule) {
+          _ttsReady = true
+          _textToSpeech!!.setOnUtteranceProgressListener(object : UtteranceProgressListener() {
+            private val emitter by moduleRegistry<EventEmitter>()
+
+            override fun onStart(utteranceId: String) {
+              emitter.emit("Exponent.speakingStarted", idToMap(utteranceId))
+            }
+
+            override fun onDone(utteranceId: String) {
+              emitter.emit("Exponent.speakingDone", idToMap(utteranceId))
+            }
+
+            override fun onStop(utteranceId: String, interrupted: Boolean) {
+              emitter.emit("Exponent.speakingStopped", idToMap(utteranceId))
+            }
+
+            override fun onError(utteranceId: String) {
+              emitter.emit("Exponent.speakingError", idToMap(utteranceId))
+            }
+          })
+          for ((id, text, options) in delayedUtterances) {
+            speakOut(id, text, options)
+          }
+        }
+      }
+    }
+    _textToSpeech = newTtsInstance
+    newTtsInstance
+  }
+
+  // Lifecycle methods
+  override fun onCreate(moduleRegistry: ModuleRegistry) {
+    moduleRegistryDelegate.onCreate(moduleRegistry)
+    uiManager.registerLifecycleEventListener(this)
+  }
+  override fun onHostPause() {}
+  override fun onHostResume() {}
+  override fun onHostDestroy() {
+    textToSpeech.shutdown()
+  }
+
+  // Helpers
+  private fun idToMap(id: String) = Bundle().apply {
+    putString("id", id)
+  }
+
+  private data class Utterance(
+    val id: String,
+    val text: String,
+    val options: SpeechOptions
+  )
+
+  // do not refer to these - they're only needed when initializing `textToSpeech`
+  private var _textToSpeech: TextToSpeech? = null
+  private var _ttsReady = false
+}

package/android/src/main/java/expo/modules/speech/SpeechOptions.kt

@@ -0,0 +1,58 @@
+package expo.modules.speech
+
+import expo.modules.core.Promise
+import java.util.*
+
+data class SpeechOptions(
+  val language: String?,
+  val pitch: Float?,
+  val rate: Float?,
+  val voice: String?
+) {
+  companion object {
+    fun optionsFromMap(options: Map<String, Any?>?, promise: Promise): SpeechOptions? {
+
+      if (options == null) {
+        return SpeechOptions(null, null, null, null)
+      }
+
+      val language = options["language"]?.let {
+        if (it is String) {
+          return@let it
+        }
+
+        promise.reject("ERR_INVALID_OPTION", "Language must be a string")
+        return null
+      }
+
+      val pitch = options["pitch"]?.let {
+        if (it is Number) {
+          return@let it.toFloat()
+        }
+
+        promise.reject("ERR_INVALID_OPTION", "Pitch must be a number")
+        return null
+      }
+
+      val rate = options["rate"]?.let {
+        if (it is Number) {
+          return@let it.toFloat()
+        }
+
+        promise.reject("ERR_INVALID_OPTION", "Rate must be a number")
+        return null
+      }
+
+      val voice = options["voice"]?.let {
+        if (it is String) {
+          return@let it
+        }
+
+        promise.reject("ERR_INVALID_OPTION", "Voice name must be a string")
+        return null
+      }
+
+      return SpeechOptions(language, pitch, rate, voice)
+    }
+  }
+}

package/android/src/main/java/expo/modules/speech/SpeechPackage.kt

@@ -0,0 +1,8 @@
+package expo.modules.speech
+
+import android.content.Context
+import expo.modules.core.BasePackage
+
+class SpeechPackage : BasePackage() {
+  override fun createExportedModules(context: Context) = listOf(SpeechModule(context))
+}

package/build/ExponentSpeech.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@unimodules/core").ProxyNativeModule;
+declare const _default: import("expo-modules-core").ProxyNativeModule;
 export default _default;

package/build/ExponentSpeech.js

@@ -1,3 +1,3 @@
-import { NativeModulesProxy } from '@unimodules/core';
+import { NativeModulesProxy } from 'expo-modules-core';
 export default NativeModulesProxy.ExponentSpeech;
 //# sourceMappingURL=ExponentSpeech.js.map

package/build/ExponentSpeech.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExponentSpeech.js","sourceRoot":"","sources":["../src/Speech/ExponentSpeech.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,eAAe,kBAAkB,CAAC,cAAc,CAAC","sourcesContent":["import { NativeModulesProxy } from '@unimodules/core';\nexport default NativeModulesProxy.ExponentSpeech;\n"]}
+{"version":3,"file":"ExponentSpeech.js","sourceRoot":"","sources":["../src/Speech/ExponentSpeech.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,eAAe,kBAAkB,CAAC,cAAc,CAAC","sourcesContent":["import { NativeModulesProxy } from 'expo-modules-core';\nexport default NativeModulesProxy.ExponentSpeech;\n"]}

package/build/ExponentSpeech.web.d.ts

@@ -2,7 +2,7 @@ import { SpeechOptions, WebVoice } from './Speech.types';
 declare const _default: {
     readonly name: string;
     speak(id: string, text: string, options: SpeechOptions): Promise<SpeechSynthesisUtterance>;
-    getVoices(): WebVoice[];
+    getVoices(): Promise<WebVoice[]>;
     isSpeaking(): Promise<boolean>;
     stop(): Promise<void>;
     pause(): Promise<void>;

package/build/ExponentSpeech.web.js

@@ -1,7 +1,22 @@
-import { SyntheticPlatformEmitter, CodedError } from '@unimodules/core';
+import { SyntheticPlatformEmitter, CodedError } from 'expo-modules-core';
 import { VoiceQuality } from './Speech.types';
 //https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/text
 const MAX_SPEECH_INPUT_LENGTH = 32767;
+async function getVoices() {
+    return new Promise((resolve) => {
+        const voices = window.speechSynthesis.getVoices();
+        if (voices.length > 0) {
+            resolve(voices);
+            return;
+        }
+        // when a page loads it takes some amount of time to populate the voices list
+        // see https://stackoverflow.com/a/52005323/4337317
+        window.speechSynthesis.onvoiceschanged = function () {
+            const voices = window.speechSynthesis.getVoices();
+            resolve(voices);
+        };
+    });
+}
 export default {
     get name() {
         return 'ExponentSpeech';
@@ -24,9 +39,14 @@ export default {
             message.volume = options.volume;
         }
         if ('_voiceIndex' in options && options._voiceIndex != null) {
-            const voices = window.speechSynthesis.getVoices();
+            const voices = await getVoices();
             message.voice = voices[Math.min(voices.length - 1, Math.max(0, options._voiceIndex))];
         }
+        if (typeof options.voice === 'string') {
+            const voices = await getVoices();
+            message.voice =
+                voices[Math.max(0, voices.findIndex((voice) => voice.voiceURI === options.voice))];
+        }
         if (typeof options.onResume === 'function') {
             message.onresume = options.onResume;
         }
@@ -52,9 +72,9 @@ export default {
         window.speechSynthesis.speak(message);
         return message;
     },
-    getVoices() {
-        const voices = window.speechSynthesis.getVoices();
-        return voices.map(voice => ({
+    async getVoices() {
+        const voices = await getVoices();
+        return voices.map((voice) => ({
             identifier: voice.voiceURI,
             quality: VoiceQuality.Default,
             isDefault: voice.default,

package/build/ExponentSpeech.web.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExponentSpeech.web.js","sourceRoot":"","sources":["../src/Speech/ExponentSpeech.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAExE,OAAO,EAA2B,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEvE,gFAAgF;AAChF,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,eAAe;IACb,IAAI,IAAI;QACN,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD,KAAK,CAAC,KAAK,CAAC,EAAU,EAAE,IAAY,EAAE,OAAsB;QAC1D,IAAI,IAAI,CAAC,MAAM,GAAG,uBAAuB,EAAE;YACzC,MAAM,IAAI,UAAU,CAClB,yBAAyB,EACzB,2DAA2D,GAAG,uBAAuB,CACtF,CAAC;SACH;QAED,MAAM,OAAO,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAE/C,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YACpC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAC7B;QACD,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;YACrC,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;SAC/B;QACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACxC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;YACtC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;SACjC;QACD,IAAI,aAAa,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE;YAC3D,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvF;QACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU,EAAE;YAC1C,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;SACrC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU,EAAE;YACxC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;SACjC;QACD,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE;YAC5C,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;SACzC;QAED,OAAO,CAAC,OAAO,GAAG,CAAC,WAAiC,EAAE,EAAE;YACtD,wBAAwB,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,CAAC,WAAiC,EAAE,EAAE;YACpD,wBAAwB,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC9E,CAAC,CAAC;QACF,OAAO,CAAC,OAAO,GAAG,CAAC,WAAiC,EAAE,EAAE;YACtD,wBAAwB,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QACF,OAAO,CAAC,OAAO,GAAG,CAAC,WAAsC,EAAE,EAAE;YAC3D,wBAAwB,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC;QAEF,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,SAAS;QACP,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,UAAU,EAAE,KAAK,CAAC,QAAQ;YAC1B,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE,KAAK,CAAC,OAAO;YACxB,QAAQ,EAAE,KAAK,CAAC,IAAI;YACpB,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAC,CAAC;IACN,CAAC;IACD,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC;IACzC,CAAC;IACD,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IACD,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACxC,CAAC;IACD,KAAK,CAAC,MAAM;QACV,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IACD,oBAAoB,EAAE,uBAAuB;CAC9C,CAAC","sourcesContent":["import { SyntheticPlatformEmitter, CodedError } from '@unimodules/core';\n\nimport { SpeechOptions, WebVoice, VoiceQuality } from './Speech.types';\n\n//https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/text\nconst MAX_SPEECH_INPUT_LENGTH = 32767;\n\nexport default {\n  get name(): string {\n    return 'ExponentSpeech';\n  },\n  async speak(id: string, text: string, options: SpeechOptions): Promise<SpeechSynthesisUtterance> {\n    if (text.length > MAX_SPEECH_INPUT_LENGTH) {\n      throw new CodedError(\n        'ERR_SPEECH_INPUT_LENGTH',\n        'Speech input text is too long! Limit of input length is: ' + MAX_SPEECH_INPUT_LENGTH\n      );\n    }\n\n    const message = new SpeechSynthesisUtterance();\n\n    if (typeof options.rate === 'number') {\n      message.rate = options.rate;\n    }\n    if (typeof options.pitch === 'number') {\n      message.pitch = options.pitch;\n    }\n    if (typeof options.language === 'string') {\n      message.lang = options.language;\n    }\n    if (typeof options.volume === 'number') {\n      message.volume = options.volume;\n    }\n    if ('_voiceIndex' in options && options._voiceIndex != null) {\n      const voices = window.speechSynthesis.getVoices();\n      message.voice = voices[Math.min(voices.length - 1, Math.max(0, options._voiceIndex))];\n    }\n    if (typeof options.onResume === 'function') {\n      message.onresume = options.onResume;\n    }\n    if (typeof options.onMark === 'function') {\n      message.onmark = options.onMark;\n    }\n    if (typeof options.onBoundary === 'function') {\n      message.onboundary = options.onBoundary;\n    }\n\n    message.onstart = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingStarted', { id, nativeEvent });\n    };\n    message.onend = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingDone', { id, nativeEvent });\n    };\n    message.onpause = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingStopped', { id, nativeEvent });\n    };\n    message.onerror = (nativeEvent: SpeechSynthesisErrorEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingError', { id, nativeEvent });\n    };\n\n    message.text = text;\n\n    window.speechSynthesis.speak(message);\n\n    return message;\n  },\n  getVoices(): WebVoice[] {\n    const voices = window.speechSynthesis.getVoices();\n    return voices.map(voice => ({\n      identifier: voice.voiceURI,\n      quality: VoiceQuality.Default,\n      isDefault: voice.default,\n      language: voice.lang,\n      localService: voice.localService,\n      name: voice.name,\n      voiceURI: voice.voiceURI,\n    }));\n  },\n  async isSpeaking(): Promise<boolean> {\n    return window.speechSynthesis.speaking;\n  },\n  async stop(): Promise<void> {\n    return window.speechSynthesis.cancel();\n  },\n  async pause(): Promise<void> {\n    return window.speechSynthesis.pause();\n  },\n  async resume(): Promise<void> {\n    return window.speechSynthesis.resume();\n  },\n  maxSpeechInputLength: MAX_SPEECH_INPUT_LENGTH,\n};\n"]}
+{"version":3,"file":"ExponentSpeech.web.js","sourceRoot":"","sources":["../src/Speech/ExponentSpeech.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAA2B,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEvE,gFAAgF;AAChF,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,KAAK,UAAU,SAAS;IACtB,OAAO,IAAI,OAAO,CAAyB,CAAC,OAAO,EAAE,EAAE;QACrD,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;QAElD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,OAAO,CAAC,MAAM,CAAC,CAAC;YAChB,OAAO;SACR;QAED,6EAA6E;QAC7E,mDAAmD;QACnD,MAAM,CAAC,eAAe,CAAC,eAAe,GAAG;YACvC,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,eAAe;IACb,IAAI,IAAI;QACN,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD,KAAK,CAAC,KAAK,CAAC,EAAU,EAAE,IAAY,EAAE,OAAsB;QAC1D,IAAI,IAAI,CAAC,MAAM,GAAG,uBAAuB,EAAE;YACzC,MAAM,IAAI,UAAU,CAClB,yBAAyB,EACzB,2DAA2D,GAAG,uBAAuB,CACtF,CAAC;SACH;QAED,MAAM,OAAO,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAE/C,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YACpC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAC7B;QACD,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;YACrC,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;SAC/B;QACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACxC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;YACtC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;SACjC;QACD,IAAI,aAAa,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE;YAC3D,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvF;QACD,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;YACrC,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK;gBACX,MAAM,CACJ,IAAI,CAAC,GAAG,CACN,CAAC,EACD,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,KAAK,CAAC,CAC9D,CACF,CAAC;SACL;QACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU,EAAE;YAC1C,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;SACrC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU,EAAE;YACxC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;SACjC;QACD,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE;YAC5C,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;SACzC;QAED,OAAO,CAAC,OAAO,GAAG,CAAC,WAAiC,EAAE,EAAE;YACtD,wBAAwB,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,CAAC,WAAiC,EAAE,EAAE;YACpD,wBAAwB,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC9E,CAAC,CAAC;QACF,OAAO,CAAC,OAAO,GAAG,CAAC,WAAiC,EAAE,EAAE;YACtD,wBAAwB,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC;QACF,OAAO,CAAC,OAAO,GAAG,CAAC,WAAsC,EAAE,EAAE;YAC3D,wBAAwB,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC;QAEF,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC5B,UAAU,EAAE,KAAK,CAAC,QAAQ;YAC1B,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,SAAS,EAAE,KAAK,CAAC,OAAO;YACxB,QAAQ,EAAE,KAAK,CAAC,IAAI;YACpB,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAC,CAAC;IACN,CAAC;IACD,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC;IACzC,CAAC;IACD,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IACD,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACxC,CAAC;IACD,KAAK,CAAC,MAAM;QACV,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IACD,oBAAoB,EAAE,uBAAuB;CAC9C,CAAC","sourcesContent":["import { SyntheticPlatformEmitter, CodedError } from 'expo-modules-core';\n\nimport { SpeechOptions, WebVoice, VoiceQuality } from './Speech.types';\n\n//https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/text\nconst MAX_SPEECH_INPUT_LENGTH = 32767;\n\nasync function getVoices(): Promise<SpeechSynthesisVoice[]> {\n  return new Promise<SpeechSynthesisVoice[]>((resolve) => {\n    const voices = window.speechSynthesis.getVoices();\n\n    if (voices.length > 0) {\n      resolve(voices);\n      return;\n    }\n\n    // when a page loads it takes some amount of time to populate the voices list\n    // see https://stackoverflow.com/a/52005323/4337317\n    window.speechSynthesis.onvoiceschanged = function () {\n      const voices = window.speechSynthesis.getVoices();\n      resolve(voices);\n    };\n  });\n}\n\nexport default {\n  get name(): string {\n    return 'ExponentSpeech';\n  },\n  async speak(id: string, text: string, options: SpeechOptions): Promise<SpeechSynthesisUtterance> {\n    if (text.length > MAX_SPEECH_INPUT_LENGTH) {\n      throw new CodedError(\n        'ERR_SPEECH_INPUT_LENGTH',\n        'Speech input text is too long! Limit of input length is: ' + MAX_SPEECH_INPUT_LENGTH\n      );\n    }\n\n    const message = new SpeechSynthesisUtterance();\n\n    if (typeof options.rate === 'number') {\n      message.rate = options.rate;\n    }\n    if (typeof options.pitch === 'number') {\n      message.pitch = options.pitch;\n    }\n    if (typeof options.language === 'string') {\n      message.lang = options.language;\n    }\n    if (typeof options.volume === 'number') {\n      message.volume = options.volume;\n    }\n    if ('_voiceIndex' in options && options._voiceIndex != null) {\n      const voices = await getVoices();\n      message.voice = voices[Math.min(voices.length - 1, Math.max(0, options._voiceIndex))];\n    }\n    if (typeof options.voice === 'string') {\n      const voices = await getVoices();\n      message.voice =\n        voices[\n          Math.max(\n            0,\n            voices.findIndex((voice) => voice.voiceURI === options.voice)\n          )\n        ];\n    }\n    if (typeof options.onResume === 'function') {\n      message.onresume = options.onResume;\n    }\n    if (typeof options.onMark === 'function') {\n      message.onmark = options.onMark;\n    }\n    if (typeof options.onBoundary === 'function') {\n      message.onboundary = options.onBoundary;\n    }\n\n    message.onstart = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingStarted', { id, nativeEvent });\n    };\n    message.onend = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingDone', { id, nativeEvent });\n    };\n    message.onpause = (nativeEvent: SpeechSynthesisEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingStopped', { id, nativeEvent });\n    };\n    message.onerror = (nativeEvent: SpeechSynthesisErrorEvent) => {\n      SyntheticPlatformEmitter.emit('Exponent.speakingError', { id, nativeEvent });\n    };\n\n    message.text = text;\n\n    window.speechSynthesis.speak(message);\n\n    return message;\n  },\n  async getVoices(): Promise<WebVoice[]> {\n    const voices = await getVoices();\n    return voices.map((voice) => ({\n      identifier: voice.voiceURI,\n      quality: VoiceQuality.Default,\n      isDefault: voice.default,\n      language: voice.lang,\n      localService: voice.localService,\n      name: voice.name,\n      voiceURI: voice.voiceURI,\n    }));\n  },\n  async isSpeaking(): Promise<boolean> {\n    return window.speechSynthesis.speaking;\n  },\n  async stop(): Promise<void> {\n    return window.speechSynthesis.cancel();\n  },\n  async pause(): Promise<void> {\n    return window.speechSynthesis.pause();\n  },\n  async resume(): Promise<void> {\n    return window.speechSynthesis.resume();\n  },\n  maxSpeechInputLength: MAX_SPEECH_INPUT_LENGTH,\n};\n"]}

package/build/Speech.d.ts

@@ -1,9 +1,38 @@
-import { SpeechOptions, SpeechEventCallback, VoiceQuality, Voice } from './Speech.types';
-export { SpeechOptions, SpeechEventCallback, VoiceQuality, Voice };
+import { SpeechOptions, SpeechEventCallback, VoiceQuality, Voice, WebVoice } from './Speech.types';
+export { SpeechOptions, SpeechEventCallback, VoiceQuality, Voice, WebVoice };
+/**
+ * Speak out loud the text given options. Calling this when another text is being spoken adds
+ * an utterance to queue.
+ * @param text The text to be spoken. Cannot be longer than [`Speech.maxSpeechInputLength`](#speechmaxspeechinputlength).
+ * @param options A `SpeechOptions` object.
+ */
 export declare function speak(text: string, options?: SpeechOptions): void;
+/**
+ * Returns list of all available voices.
+ * @return List of `Voice` objects.
+ */
 export declare function getAvailableVoicesAsync(): Promise<Voice[]>;
+/**
+ * Determine whether the Text-to-speech utility is currently speaking. Will return `true` if speaker
+ * is paused.
+ * @return Returns a Promise that fulfils with a boolean, `true` if speaking, `false` if not.
+ */
 export declare function isSpeakingAsync(): Promise<boolean>;
+/**
+ * Interrupts current speech and deletes all in queue.
+ */
 export declare function stop(): Promise<void>;
+/**
+ * Pauses current speech. This method is not available on Android.
+ */
 export declare function pause(): Promise<void>;
+/**
+ * Resumes speaking previously paused speech or does nothing if there's none. This method is not
+ * available on Android.
+ */
 export declare function resume(): Promise<void>;
+/**
+ * Maximum possible text length acceptable by `Speech.speak()` method. It is platform-dependent.
+ * On iOS, this returns `Number.MAX_VALUE`.
+ */
 export declare const maxSpeechInputLength: number;

package/build/Speech.js

@@ -1,4 +1,4 @@
-import { UnavailabilityError } from '@unimodules/core';
+import { UnavailabilityError } from 'expo-modules-core';
 import { NativeEventEmitter } from 'react-native';
 import ExponentSpeech from './ExponentSpeech';
 import { VoiceQuality } from './Speech.types';
@@ -51,30 +51,61 @@ function _registerListenersIfNeeded() {
         _unregisterListenersIfNeeded();
     });
 }
+// @needsAudit
+/**
+ * Speak out loud the text given options. Calling this when another text is being spoken adds
+ * an utterance to queue.
+ * @param text The text to be spoken. Cannot be longer than [`Speech.maxSpeechInputLength`](#speechmaxspeechinputlength).
+ * @param options A `SpeechOptions` object.
+ */
 export function speak(text, options = {}) {
     const id = _nextCallbackId++;
     _CALLBACKS[id] = options;
     _registerListenersIfNeeded();
     ExponentSpeech.speak(String(id), text, options);
 }
+// @needsAudit
+/**
+ * Returns list of all available voices.
+ * @return List of `Voice` objects.
+ */
 export async function getAvailableVoicesAsync() {
     if (!ExponentSpeech.getVoices) {
         throw new UnavailabilityError('Speech', 'getVoices');
     }
     return ExponentSpeech.getVoices();
 }
+//@needsAudit
+/**
+ * Determine whether the Text-to-speech utility is currently speaking. Will return `true` if speaker
+ * is paused.
+ * @return Returns a Promise that fulfils with a boolean, `true` if speaking, `false` if not.
+ */
 export async function isSpeakingAsync() {
     return ExponentSpeech.isSpeaking();
 }
+// @needsAudit
+/**
+ * Interrupts current speech and deletes all in queue.
+ */
 export async function stop() {
     return ExponentSpeech.stop();
 }
+// @needsAudit
+/**
+ * Pauses current speech. This method is not available on Android.
+ */
 export async function pause() {
     if (!ExponentSpeech.pause) {
         throw new UnavailabilityError('Speech', 'pause');
     }
     return ExponentSpeech.pause();
 }
+// @needsAudit
+/**
+ * Resumes speaking previously paused speech or does nothing if there's none. This method is not
+ * available on Android.
+ */
 export async function resume() {
     if (!ExponentSpeech.resume) {
         throw new UnavailabilityError('Speech', 'resume');
@@ -82,7 +113,13 @@ export async function resume() {
     return ExponentSpeech.resume();
 }
 function setSpeakingListener(eventName, callback) {
-    if (SpeechEventEmitter.listeners(eventName).length > 0) {
+    // @ts-ignore: the EventEmitter interface has been changed in react-native@0.64.0
+    const listenerCount = SpeechEventEmitter.listenerCount
+        ? // @ts-ignore: this is available since 0.64
+            SpeechEventEmitter.listenerCount(eventName)
+        : // @ts-ignore: this is available in older versions
+            SpeechEventEmitter.listeners(eventName).length;
+    if (listenerCount > 0) {
         SpeechEventEmitter.removeAllListeners(eventName);
     }
     SpeechEventEmitter.addListener(eventName, callback);
@@ -90,5 +127,10 @@ function setSpeakingListener(eventName, callback) {
 function removeSpeakingListener(eventName) {
     SpeechEventEmitter.removeAllListeners(eventName);
 }
+// @needsAudit
+/**
+ * Maximum possible text length acceptable by `Speech.speak()` method. It is platform-dependent.
+ * On iOS, this returns `Number.MAX_VALUE`.
+ */
 export const maxSpeechInputLength = ExponentSpeech.maxSpeechInputLength || Number.MAX_VALUE;
 //# sourceMappingURL=Speech.js.map