expo-speech 11.1.1 → 11.3.0

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 ### 💡 Others
 
+## 11.3.0 — 2023-06-21
+
+### 🐛 Bug fixes
+
+- Fixed Android build warnings for Gradle version 8. ([#22537](https://github.com/expo/expo/pull/22537), [#22609](https://github.com/expo/expo/pull/22609) by [@kudo](https://github.com/kudo))
+
+## 11.2.0 — 2023-05-08
+
+### 🎉 New features
+
+- Migrated iOS codebase to use Expo modules API. ([#21814](https://github.com/expo/expo/pull/21814) by [@alanjhughes](https://github.com/alanjhughes))
+
 ## 11.1.1 — 2023-02-09
 
 _This version does not introduce any user-facing changes._

package/README.md

@@ -1,4 +1,11 @@
-# expo-speech
+<p>
+  <a href="https://docs.expo.dev/versions/latest/sdk/speech/">
+    <img
+      src="../../.github/resources/expo-speech.svg"
+      alt="expo-speech"
+      height="64" />
+  </a>
+</p>
 
 Provides text-to-speech functionality.
 
@@ -9,7 +16,7 @@ Provides text-to-speech functionality.
 
 # Installation in managed Expo projects
 
-For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/speech/).
+For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/speech/).
 
 # Installation in bare React Native projects
 
@@ -18,7 +25,7 @@ For bare React Native projects, you must ensure that you have [installed and con
 ### Add the package to your npm dependencies
 
 ```
-expo install expo-speech
+npx expo install expo-speech
 ```
 
 ### Configure for iOS

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '11.1.1'
+version = '11.3.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -35,19 +35,11 @@ buildscript {
   }
 }
 
-// Creating sources with comments
-task androidSourcesJar(type: Jar) {
-  classifier = 'sources'
-  from android.sourceSets.main.java.srcDirs
-}
-
 afterEvaluate {
   publishing {
     publications {
       release(MavenPublication) {
         from components.release
-        // Add additional sourcesJar to artifacts
-        artifact(androidSourcesJar)
       }
     }
     repositories {
@@ -70,15 +62,21 @@ android {
     jvmTarget = JavaVersion.VERSION_11.majorVersion
   }
 
+  namespace "expo.modules.speech"
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 18
-    versionName "11.1.1"
+    versionName "11.3.0"
   }
   lintOptions {
     abortOnError false
   }
+  publishing {
+    singleVariant("release") {
+      withSourcesJar()
+    }
+  }
 }
 
 dependencies {

package/android/src/main/AndroidManifest.xml

@@ -1,6 +1,4 @@
-<manifest package="expo.modules.speech"
-  xmlns:android="http://schemas.android.com/apk/res/android">
-
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
   <queries>
     <intent>
       <!-- Required for text-to-speech if targeting API 30 -->

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

@@ -27,7 +27,7 @@ class SpeechModule(
   private val delayedUtterances: Queue<Utterance> = ArrayDeque()
 
   // Module basic definitions
-  override fun getName() = "ExponentSpeech"
+  override fun getName() = "ExpoSpeech"
   override fun getConstants() = mapOf(
     "maxSpeechInputLength" to TextToSpeech.getMaxSpeechInputLength()
   )

package/build/ExponentSpeech.d.ts

@@ -1,3 +1,3 @@
-declare const _default: import("expo-modules-core").ProxyNativeModule;
+declare const _default: any;
 export default _default;
 //# sourceMappingURL=ExponentSpeech.d.ts.map

package/build/ExponentSpeech.js

@@ -1,3 +1,3 @@
-import { NativeModulesProxy } from 'expo-modules-core';
-export default NativeModulesProxy.ExponentSpeech;
+import { requireNativeModule } from 'expo-modules-core';
+export default requireNativeModule('ExpoSpeech');
 //# 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,mBAAmB,CAAC;AACvD,eAAe,kBAAkB,CAAC,cAAc,CAAC","sourcesContent":["import { NativeModulesProxy } from 'expo-modules-core';\nexport default NativeModulesProxy.ExponentSpeech;\n"]}
+{"version":3,"file":"ExponentSpeech.js","sourceRoot":"","sources":["../src/Speech/ExponentSpeech.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,eAAe,mBAAmB,CAAC,YAAY,CAAC,CAAC","sourcesContent":["import { requireNativeModule } from 'expo-modules-core';\nexport default requireNativeModule('ExpoSpeech');\n"]}

package/expo-module.config.json

@@ -0,0 +1,7 @@
+{
+  "name": "expo-speech",
+  "platforms": ["ios", "android"],
+  "ios": {
+    "modules": ["SpeechModule"]
+  }
+}

package/ios/{EXSpeech.podspec → ExpoSpeech.podspec}

@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name           = 'EXSpeech'
+  s.name           = 'ExpoSpeech'
   s.version        = package['version']
   s.summary        = package['description']
   s.description    = package['description']
@@ -11,15 +11,16 @@ Pod::Spec.new do |s|
   s.author         = package['author']
   s.homepage       = package['homepage']
   s.platform       = :ios, '13.0'
+  s.swift_version  = '5.4'
   s.source         = { git: 'https://github.com/expo/expo.git' }
   s.static_framework = true
 
   s.dependency 'ExpoModulesCore'
 
   if !$ExpoUseSources&.include?(package['name']) && ENV['EXPO_USE_SOURCE'].to_i == 0 && File.exist?("#{s.name}.xcframework") && Gem::Version.new(Pod::VERSION) >= Gem::Version.new('1.10.0')
-    s.source_files = "#{s.name}/**/*.h"
+    s.source_files = "**/*.h"
     s.vendored_frameworks = "#{s.name}.xcframework"
   else
-    s.source_files = "#{s.name}/**/*.{h,m}"
+    s.source_files = "**/*.{h,m,swift}"
   end
 end

package/ios/SpeechDelegate.swift

@@ -0,0 +1,32 @@
+import Speech
+
+protocol SpeechResultHadler {
+  func didStart(utterance: AVSpeechUtterance)
+  func willSpeak(characterRange: NSRange, utterance: AVSpeechUtterance)
+  func didCancel(utterance: AVSpeechUtterance)
+  func didFinish(utterance: AVSpeechUtterance)
+}
+
+class SpeechDelegate: NSObject, AVSpeechSynthesizerDelegate {
+  let resultHandler: SpeechResultHadler
+
+  init(resultHandler: SpeechResultHadler) {
+    self.resultHandler = resultHandler
+  }
+
+  func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didStart utterance: AVSpeechUtterance) {
+    resultHandler.didStart(utterance: utterance)
+  }
+
+  func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, willSpeakRangeOfSpeechString characterRange: NSRange, utterance: AVSpeechUtterance) {
+    resultHandler.willSpeak(characterRange: characterRange, utterance: utterance)
+  }
+
+  func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didCancel utterance: AVSpeechUtterance) {
+    resultHandler.didCancel(utterance: utterance)
+  }
+
+  func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didFinish utterance: AVSpeechUtterance) {
+    resultHandler.didFinish(utterance: utterance)
+  }
+}

package/ios/SpeechExceptions.swift

@@ -0,0 +1,7 @@
+import ExpoModulesCore
+
+class InvalidVoiceException: GenericException<String> {
+  override var reason: String {
+    "Cannot find voice with identifier: \(param)!"
+  }
+}

package/ios/SpeechModule.swift

@@ -0,0 +1,138 @@
+import ExpoModulesCore
+
+let SPEAKING_STARTED = "Exponent.speakingStarted"
+let SPEAKING_WILL_SAY_NEXT_STRING = "Exponent.speakingWillSayNextString"
+let SPEAKING_DONE = "Exponent.speakingDone"
+let SPEAKING_STOPPED = "Exponent.speakingStopped"
+let SPEAKING_ERROR = "Exponent.speakingError"
+
+public final class SpeechModule: Module, SpeechResultHadler {
+  private var synthesizer = AVSpeechSynthesizer()
+  private var delegate: SpeechDelegate?
+
+  public func definition() -> ModuleDefinition {
+    Name("ExpoSpeech")
+
+    OnCreate {
+      delegate = SpeechDelegate(resultHandler: self)
+      synthesizer.delegate = delegate
+    }
+
+    Events([
+      SPEAKING_STARTED,
+      SPEAKING_WILL_SAY_NEXT_STRING,
+      SPEAKING_DONE,
+      SPEAKING_STOPPED,
+      SPEAKING_ERROR
+    ])
+
+    AsyncFunction("speak") { (utteranceId: String, text: String, options: SpeechOptions) in
+      let utterance = ExpoSpeechUtterance(id: utteranceId, text: text)
+
+      if let language = options.language {
+        utterance.voice = AVSpeechSynthesisVoice(language: language)
+      }
+
+      if let voice = options.voice {
+        utterance.voice = AVSpeechSynthesisVoice(identifier: voice)
+
+        guard utterance.voice != nil else {
+          throw InvalidVoiceException(voice)
+        }
+      }
+
+      if let pitch = options.pitch {
+        utterance.pitchMultiplier = Float(pitch)
+      }
+
+      if let rate = options.rate {
+        utterance.rate = Float(rate) * AVSpeechUtteranceDefaultSpeechRate
+      }
+
+      synthesizer.speak(utterance)
+    }
+
+    AsyncFunction("getVoices") { () -> [VoiceInfo] in
+      let voices = AVSpeechSynthesisVoice.speechVoices()
+
+      let availableVoicesResult = voices.map { voice in
+        VoiceInfo(
+          identifier: voice.identifier,
+          name: voice.name,
+          quality: voice.quality == .enhanced ? "Enhanced" : "Default",
+          language: voice.language
+        )
+      }
+
+      return availableVoicesResult
+    }
+
+    AsyncFunction("stop") {
+      synthesizer.stopSpeaking(at: .immediate)
+    }
+
+    AsyncFunction("pause") {
+      synthesizer.pauseSpeaking(at: .immediate)
+    }
+
+    AsyncFunction("resume") {
+      synthesizer.continueSpeaking()
+    }
+
+    AsyncFunction("isSpeaking") {
+      return synthesizer.isSpeaking
+    }
+  }
+
+  func didStart(utterance: AVSpeechUtterance) {
+    guard let utterance = utterance as? ExpoSpeechUtterance else {
+      return
+    }
+    sendEvent(SPEAKING_STARTED, [
+      "id": utterance.id
+    ])
+  }
+
+  func willSpeak(characterRange: NSRange, utterance: AVSpeechUtterance) {
+    guard let utterance = utterance as? ExpoSpeechUtterance else {
+      return
+    }
+    sendEvent(SPEAKING_WILL_SAY_NEXT_STRING, [
+      "id": utterance.id,
+      "charIndex": characterRange.location,
+      "charLength": characterRange.length
+    ])
+  }
+
+  func didCancel(utterance: AVSpeechUtterance) {
+    guard let utterance = utterance as? ExpoSpeechUtterance else {
+      return
+    }
+    sendEvent(SPEAKING_STOPPED, [
+      "id": utterance.id
+    ])
+  }
+
+  func didFinish(utterance: AVSpeechUtterance) {
+    guard let utterance = utterance as? ExpoSpeechUtterance else {
+      return
+    }
+    sendEvent(SPEAKING_DONE, [
+      "id": utterance.id
+    ])
+  }
+}
+
+internal class ExpoSpeechUtterance: AVSpeechUtterance {
+  let id: String
+
+  init(id: String, text: String) {
+    self.id = id
+    super.init(string: text)
+  }
+
+  @available(*, unavailable)
+  required init?(coder: NSCoder) {
+    fatalError("Not implemented")
+  }
+}

package/ios/SpeechOptions.swift

@@ -0,0 +1,23 @@
+import ExpoModulesCore
+
+struct SpeechOptions: Record {
+  @Field
+  var language: String?
+  @Field
+  var pitch: Double?
+  @Field
+  var rate: Double?
+  @Field
+  var voice: String?
+}
+
+struct VoiceInfo: Record {
+  @Field
+  var identifier: String? = nil
+  @Field
+  var name: String? = nil
+  @Field
+  var quality: String? = nil
+  @Field
+  var language: String? = nil
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-speech",
-  "version": "11.1.1",
+  "version": "11.3.0",
   "description": "Provides text-to-speech functionality.",
   "main": "build/Speech.js",
   "types": "build/Speech.d.ts",
@@ -42,5 +42,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "1f8a6a09570fd451378565ca34933018ce48454e"
+  "gitHead": "fa5ecca8251986b9f197cc14074eec0ab6dfb6db"
 }

package/src/Speech/ExponentSpeech.ts

@@ -1,2 +1,2 @@
-import { NativeModulesProxy } from 'expo-modules-core';
-export default NativeModulesProxy.ExponentSpeech;
+import { requireNativeModule } from 'expo-modules-core';
+export default requireNativeModule('ExpoSpeech');

package/ios/EXSpeech/EXSpeech.h

@@ -1,9 +0,0 @@
-// Copyright 2015-present 650 Industries. All rights reserved.
-
-#import <ExpoModulesCore/EXExportedModule.h>
-#import <ExpoModulesCore/EXModuleRegistryConsumer.h>
-#import <ExpoModulesCore/EXEventEmitter.h>
-
-@interface EXSpeech : EXExportedModule <EXEventEmitter, EXModuleRegistryConsumer>
-
-@end

package/ios/EXSpeech/EXSpeech.m

@@ -1,186 +0,0 @@
-// Copyright 2015-present 650 Industries. All rights reserved.
-
-#import <AVFoundation/AVFoundation.h>
-
-#import <ExpoModulesCore/EXEventEmitterService.h>
-#import <EXSpeech/EXSpeech.h>
-
-@interface EXSpeechUtteranceWithId : AVSpeechUtterance
-
-@property (nonatomic) NSString* utteranceId;
-
-- (instancetype)initWithString:(NSString *)string utteranceId:(NSString *)utteranceId;
-
-@end
-
-@implementation EXSpeechUtteranceWithId
-
-static NSString *const INVALID_VOICE_ERROR_CODE = @"INVALID_VOICE_IDENTIFIER";
-static NSString *const INVALID_VOICE_ERROR_MSG = @"Cannot find voice with identifier: %@!";
-
-- (instancetype)initWithString:(NSString *)string utteranceId:(NSString *)utteranceId
-{
-  self = [super initWithString:string];
-  if (self) {
-    _utteranceId = utteranceId;
-  }
-  return self;
-}
-
-@end
-
-@interface EXSpeech () <AVSpeechSynthesizerDelegate>
-
-@property (nonatomic, strong) AVSpeechSynthesizer *synthesizer;
-@property (nonatomic, weak) EXModuleRegistry *moduleRegistry;
-
-@end
-
-@implementation EXSpeech
-
-EX_EXPORT_MODULE(ExponentSpeech)
-
-- (void)setModuleRegistry:(EXModuleRegistry *)moduleRegistry
-{
-  _moduleRegistry = moduleRegistry;
-}
-
-- (NSArray<NSString *> *)supportedEvents
-{
-  return @[@"Exponent.speakingStarted", @"Exponent.speakingWillSayNextString", @"Exponent.speakingDone", @"Exponent.speakingStopped", @"Exponent.speakingError"];
-}
-
-- (void)startObserving {
-}
-
-
-- (void)stopObserving {
-}
-
-
-- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer
-  didStartSpeechUtterance:(AVSpeechUtterance *)utterance
-{
-  id<EXEventEmitterService> emitter = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXEventEmitterService)];
-  if (emitter != nil) {
-    [emitter sendEventWithName:@"Exponent.speakingStarted" body:@{ @"id": ((EXSpeechUtteranceWithId *) utterance).utteranceId }];
-  }
-}
-
-- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer
-  willSpeakRangeOfSpeechString:(NSRange)characterRange utterance:(nonnull AVSpeechUtterance *)utterance
-{
-  id<EXEventEmitterService> emitter = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXEventEmitterService)];
-  if (emitter != nil) {
-    [emitter sendEventWithName:@"Exponent.speakingWillSayNextString" body:@{ @"id": ((EXSpeechUtteranceWithId *) utterance).utteranceId, @"charIndex": @(characterRange.location), @"charLength": @(characterRange.length) }];
-  }
-}
-
-- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer
- didCancelSpeechUtterance:(AVSpeechUtterance *)utterance
-{
-  id<EXEventEmitterService> emitter = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXEventEmitterService)];
-  if (emitter != nil) {
-    [emitter sendEventWithName:@"Exponent.speakingStopped" body:@{ @"id": ((EXSpeechUtteranceWithId *) utterance).utteranceId }];
-  }
-}
-
-- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer
- didFinishSpeechUtterance:(AVSpeechUtterance *)utterance
-{
-  id<EXEventEmitterService> emitter = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXEventEmitterService)];
-  if (emitter != nil) {
-    [emitter sendEventWithName:@"Exponent.speakingDone" body:@{ @"id": ((EXSpeechUtteranceWithId *) utterance).utteranceId }];
-  }
-}
-
-
-EX_EXPORT_METHOD_AS(speak,
-                    speak:(nonnull NSString *)utteranceId
-                    text:(nonnull NSString *)text
-                    options:(NSDictionary *)options
-                    resolver:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  if (_synthesizer == nil) {
-    _synthesizer = [[AVSpeechSynthesizer alloc] init];
-    _synthesizer.delegate = self;
-  }
-
-  AVSpeechUtterance *utterance = [[EXSpeechUtteranceWithId alloc] initWithString:text utteranceId:utteranceId];
-
-  NSString *language = options[@"language"];
-  NSString *voice = options[@"voice"];
-  NSNumber *pitch = options[@"pitch"];
-  NSNumber *rate = options[@"rate"];
-
-  if (language != nil) {
-    utterance.voice = [AVSpeechSynthesisVoice voiceWithLanguage:language];
-  }
-  if (voice != nil) {
-    utterance.voice = [AVSpeechSynthesisVoice voiceWithIdentifier:voice];
-    if (utterance.voice == nil) {
-      reject(INVALID_VOICE_ERROR_CODE, [NSString stringWithFormat:INVALID_VOICE_ERROR_MSG, voice], nil);
-      return;
-    }
-  }
-  if (pitch != nil) {
-    utterance.pitchMultiplier = [pitch floatValue];
-  }
-  if (rate != nil) {
-    utterance.rate = [rate floatValue] * AVSpeechUtteranceDefaultSpeechRate;
-  }
-
-  [_synthesizer speakUtterance:utterance];
-  resolve(nil);
-}
-
-EX_EXPORT_METHOD_AS(getVoices,
-                    getVoices:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  NSArray<AVSpeechSynthesisVoice *> *availableVoices = [AVSpeechSynthesisVoice speechVoices];
-  NSMutableArray<NSDictionary *> *availableVoicesResult = [NSMutableArray array];
-  for (AVSpeechSynthesisVoice* voice in availableVoices) {
-    NSString *quality = @"Default";
-    if (voice.quality == AVSpeechSynthesisVoiceQualityEnhanced) {
-      quality = @"Enhanced";
-    }
-    NSDictionary *voiceInfo = @{
-                                @"identifier" : voice.identifier,
-                                @"name"       : voice.name,
-                                @"quality"    : quality,
-                                @"language"   : voice.language
-                                };
-    [availableVoicesResult addObject:voiceInfo];
-  }
-  resolve([availableVoicesResult mutableCopy]);
-}
-
-EX_EXPORT_METHOD_AS(stop,
-                    stop:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  [_synthesizer stopSpeakingAtBoundary:AVSpeechBoundaryImmediate];
-  resolve(nil);
-}
-
-EX_EXPORT_METHOD_AS(pause,
-                    pause:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  [_synthesizer pauseSpeakingAtBoundary:AVSpeechBoundaryImmediate];
-  resolve(nil);
-}
-
-EX_EXPORT_METHOD_AS(resume,
-                    resume:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  [_synthesizer continueSpeaking];
-  resolve(nil);
-}
-
-EX_EXPORT_METHOD_AS(isSpeaking,
-                    isSpeaking:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject) {
-  resolve(@([_synthesizer isSpeaking]));
-}
-
-@end
-  

package/unimodule.json

@@ -1,4 +0,0 @@
-{
-  "name": "expo-speech",
-  "platforms": ["ios", "android"]
-}