expo-mail-composer 11.2.0 → 12.0.0

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 ### 💡 Others
 
+## 12.0.0 — 2022-10-25
+
+### 🛠 Breaking changes
+
+- Bumped iOS deployment target to 13.0 and deprecated support for iOS 12. ([#18873](https://github.com/expo/expo/pull/18873) by [@tsapeta](https://github.com/tsapeta))
+
+## 11.3.0 — 2022-07-07
+
+### 🎉 New features
+
+- Native module on iOS is now written in Swift using the new API and JSI. ([#17488](https://github.com/expo/expo/pull/17488) by [@tsapeta](https://github.com/tsapeta))
+
 ## 11.2.0 — 2022-04-18
 
 ### ⚠️ Notices

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '11.2.0'
+version = '12.0.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -74,7 +74,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 31)
     versionCode 17
-    versionName "11.2.0"
+    versionName "12.0.0"
   }
   lintOptions {
     abortOnError false

package/build/ExpoMailComposer.d.ts

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

package/build/ExpoMailComposer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoMailComposer.d.ts","sourceRoot":"","sources":["../src/ExpoMailComposer.ts"],"names":[],"mappings":";AACA,wBAAmD"}
+{"version":3,"file":"ExpoMailComposer.d.ts","sourceRoot":"","sources":["../src/ExpoMailComposer.ts"],"names":[],"mappings":";AAEA,wBAAuD"}

package/build/ExpoMailComposer.js

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

package/build/ExpoMailComposer.js.map

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

package/expo-module.config.json

@@ -0,0 +1,7 @@
+{
+  "name": "expo-mail-composer",
+  "platforms": ["ios", "android"],
+  "ios": {
+    "modules": ["MailComposerModule"]
+  }
+}

package/ios/{EXMailComposer.podspec → ExpoMailComposer.podspec}

@@ -3,23 +3,30 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name           = 'EXMailComposer'
+  s.name           = 'ExpoMailComposer'
   s.version        = package['version']
   s.summary        = package['description']
   s.description    = package['description']
   s.license        = package['license']
   s.author         = package['author']
   s.homepage       = package['homepage']
-  s.platform       = :ios, '12.0'
+  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'
 
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+    'SWIFT_COMPILATION_MODE' => 'wholemodule'
+  }
+
   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/MailComposerExceptions.swift

@@ -0,0 +1,46 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import MessageUI
+import ExpoModulesCore
+
+internal final class CannotSendMailException: Exception {
+  override var reason: String {
+    "Mail services are not available, make sure you're signed into the Mail app"
+  }
+}
+
+internal final class OperationInProgressException: Exception {
+  override var reason: String {
+    "Cannot compose an email because another email composing operation is in progress"
+  }
+}
+
+internal final class MissingViewControllerException: Exception {
+  override var reason: String {
+    "Unable to find the current view controller to present the compose view controller"
+  }
+}
+
+internal final class SendingFailedException: GenericException<Error?> {
+  override var reason: String {
+    "Something went wrong while trying to send the email: \(param.debugDescription)"
+  }
+}
+
+internal final class UnknownResultException: GenericException<MFMailComposeResult> {
+  override var reason: String {
+    "Received unknown result: \(param)"
+  }
+}
+
+internal final class FileSystemNotFoundException: Exception {
+  override var reason: String {
+    "FileSystem module not found, make sure 'expo-file-system' is linked correctly"
+  }
+}
+
+internal final class FileSystemReadPermissionException: GenericException<String> {
+  override var reason: String {
+    "File '\(param)' is not readable"
+  }
+}

package/ios/MailComposerModule.swift

@@ -0,0 +1,45 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import MessageUI
+import MobileCoreServices
+import ExpoModulesCore
+
+public class MailComposerModule: Module {
+  var currentSession: MailComposingSession?
+
+  public func definition() -> ModuleDefinition {
+    Name("ExpoMailComposer")
+
+    AsyncFunction("isAvailableAsync", canSendMail)
+
+    AsyncFunction("composeAsync") { (options: MailComposerOptions, promise: Promise) in
+      guard canSendMail() else {
+        throw CannotSendMailException()
+      }
+      guard self.currentSession == nil else {
+        throw OperationInProgressException()
+      }
+      guard let appContext = self.appContext else {
+        throw AppContextLostException()
+      }
+
+      let session = MailComposingSession(appContext)
+      try session.compose(options: options)
+
+      // This is important to retain the session until it finishes
+      self.currentSession = session
+
+      session.presentViewController { result in
+        promise.settle(with: result)
+
+        // Release the session so it can get deallocated
+        self.currentSession = nil
+      }
+    }
+    .runOnQueue(.main)
+  }
+}
+
+private func canSendMail() -> Bool {
+  return MFMailComposeViewController.canSendMail()
+}

package/ios/MailComposerOptions.swift

@@ -0,0 +1,26 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import ExpoModulesCore
+
+internal struct MailComposerOptions: Record {
+  @Field
+  var recipients: [String]?
+
+  @Field
+  var ccRecipients: [String]?
+
+  @Field
+  var bccRecipients: [String]?
+
+  @Field
+  var subject: String = ""
+
+  @Field
+  var body: String = ""
+
+  @Field
+  var isHtml: Bool = false
+
+  @Field
+  var attachments: [URL]?
+}

package/ios/MailComposingSession.swift

@@ -0,0 +1,82 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import MessageUI
+import MobileCoreServices
+import ExpoModulesCore
+
+internal final class MailComposingSession: NSObject, MFMailComposeViewControllerDelegate {
+  typealias ComposingCallback = (Result<[String: String], Exception>) -> ()
+
+  let appContext: AppContext
+  let composeController: MFMailComposeViewController
+  var callback: ComposingCallback?
+
+  init(_ appContext: AppContext) {
+    self.appContext = appContext
+    self.composeController = MFMailComposeViewController()
+    super.init()
+
+    self.composeController.mailComposeDelegate = self
+  }
+
+  func compose(options: MailComposerOptions) throws {
+    composeController.setToRecipients(options.recipients)
+    composeController.setCcRecipients(options.ccRecipients)
+    composeController.setBccRecipients(options.bccRecipients)
+    composeController.setSubject(options.subject)
+    composeController.setMessageBody(options.body, isHTML: options.isHtml)
+
+    if let attachments = options.attachments {
+      guard let fileSystem = appContext.fileSystem else {
+        throw FileSystemNotFoundException()
+      }
+      for attachment in attachments {
+        guard fileSystem.permissions(forURI: attachment).contains(.read) else {
+          throw FileSystemReadPermissionException(attachment.path)
+        }
+        let mimeType = findMimeType(forAttachment: attachment)
+        let fileData = try Data(contentsOf: attachment)
+        composeController.addAttachmentData(fileData, mimeType: mimeType, fileName: attachment.lastPathComponent)
+      }
+    }
+  }
+
+  func presentViewController(_ callback: @escaping ComposingCallback) {
+    guard let currentViewController = appContext.utilities?.currentViewController() else {
+      callback(.failure(MissingViewControllerException()))
+      return
+    }
+    self.callback = callback
+    currentViewController.present(composeController, animated: true)
+  }
+
+  // MARK: - MFMailComposeViewControllerDelegate
+
+  func mailComposeController(_ controller: MFMailComposeViewController, didFinishWith result: MFMailComposeResult, error: Error?) {
+    composeController.dismiss(animated: true) {
+      guard let callback = self.callback else {
+        return
+      }
+      switch result {
+      case .cancelled:
+        callback(.success(["status": "cancelled"]))
+      case .saved:
+        callback(.success(["status": "saved"]))
+      case .sent:
+        callback(.success(["status": "sent"]))
+      case .failed:
+        callback(.failure(SendingFailedException(error)))
+      @unknown default:
+        callback(.failure(UnknownResultException(result)))
+      }
+    }
+  }
+}
+
+private func findMimeType(forAttachment attachment: URL) -> String {
+  if let identifier = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, attachment.pathExtension as CFString, nil)?.takeRetainedValue(),
+     let type = UTTypeCopyPreferredTagWithClass(identifier, kUTTagClassMIMEType)?.takeRetainedValue() {
+    return type as String
+  }
+  return "application/octet-stream"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-mail-composer",
-  "version": "11.2.0",
+  "version": "12.0.0",
   "description": "Provides an API to compose mails using OS specific UI",
   "main": "build/MailComposer.js",
   "types": "build/MailComposer.d.ts",
@@ -38,10 +38,10 @@
     "query-string": "^6.2.0"
   },
   "devDependencies": {
-    "expo-module-scripts": "^2.0.0"
+    "expo-module-scripts": "^3.0.0"
   },
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "22dce752354bb429c84851bc4389abe47a766b1f"
+  "gitHead": "eab2b09c735fb0fc2bf734a3f29a6593adba3838"
 }

package/src/ExpoMailComposer.ts

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

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "./build"
   },
   "include": ["./src"],
-  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__stories__/*"]
 }

package/ios/EXMailComposer/EXMailComposer.h

@@ -1,9 +0,0 @@
-// Copyright 2017-present 650 Industries. All rights reserved.
-
-#import <ExpoModulesCore/EXExportedModule.h>
-#import <ExpoModulesCore/EXModuleRegistryConsumer.h>
-
-#import <MessageUI/MessageUI.h>
-
-@interface EXMailComposer : EXExportedModule <EXModuleRegistryConsumer, MFMailComposeViewControllerDelegate>
-@end

package/ios/EXMailComposer/EXMailComposer.m

@@ -1,164 +0,0 @@
-// Copyright 2017-present 650 Industries. All rights reserved.
-
-#import <EXMailComposer/EXMailComposer.h>
-#import <MobileCoreServices/MobileCoreServices.h>
-
-#import <ExpoModulesCore/EXUtilitiesInterface.h>
-#import <ExpoModulesCore/EXFileSystemInterface.h>
-
-@interface EXMailComposer ()
-
-@property (nonatomic, weak) EXModuleRegistry *moduleRegistry;
-
-@property (nonatomic, strong) EXPromiseResolveBlock resolve;
-@property (nonatomic, strong) EXPromiseRejectBlock reject;
-
-@end
-
-@implementation EXMailComposer
-
-EX_EXPORT_MODULE(ExpoMailComposer);
-
-- (void)setModuleRegistry:(EXModuleRegistry *)moduleRegistry
-{
-  _moduleRegistry = moduleRegistry;
-}
-
-- (dispatch_queue_t)methodQueue
-{
-  return dispatch_get_main_queue();
-}
-
-EX_EXPORT_METHOD_AS(isAvailableAsync,
-                    isAvailable:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject)
-{
-  resolve(@([MFMailComposeViewController canSendMail]));
-}
-
-
-EX_EXPORT_METHOD_AS(composeAsync,
-                    composeAsync:(NSDictionary *)options
-                    resolver:(EXPromiseResolveBlock)resolve
-                    rejecter:(EXPromiseRejectBlock)reject)
-{
-  if (![MFMailComposeViewController canSendMail]) {
-    reject(@"E_COMPOSE_UNAVAILABLE", @"Mail services are not available. Make sure you're signed into the Mail app", nil);
-    return;
-  }
-
-  MFMailComposeViewController* composeController = [[MFMailComposeViewController alloc] init];
-  composeController.mailComposeDelegate = self;
-
-  NSMutableArray *recipients = [[NSMutableArray alloc] init];
-  for (NSString *recipient in options[@"recipients"]) {
-    [recipients addObject:recipient];
-  }
-  [composeController setToRecipients:recipients];
-
-  NSMutableArray *ccRecipients = [[NSMutableArray alloc] init];
-  for (NSString *ccRecipient in options[@"ccRecipients"]) {
-    [ccRecipients addObject:ccRecipient];
-  }
-  [composeController setCcRecipients:ccRecipients];
-
-  NSMutableArray *bccRecipients = [[NSMutableArray alloc] init];
-  for (NSString *bccRecipient in options[@"bccRecipients"]) {
-    [bccRecipients addObject:bccRecipient];
-  }
-  [composeController setBccRecipients:bccRecipients];
-
-  if (options[@"subject"] != nil) {
-    [composeController setSubject:options[@"subject"]];
-  }
-
-  if (options[@"body"] != nil) {
-    BOOL isHTML = NO;
-    if (options[@"isHtml"]) {
-      isHTML = YES;
-    }
-    [composeController setMessageBody:options[@"body"] isHTML:isHTML];
-  }
-
-  if (options[@"attachments"] != nil) {
-    for (NSString *uri in options[@"attachments"]) {
-      NSURL *url = [NSURL URLWithString:uri];
-      NSString *path = [url.path stringByStandardizingPath];
-      id<EXFileSystemInterface> fileSystem = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXFileSystemInterface)];
-      if (!fileSystem) {
-        reject(@"E_MISSING_MODULE", @"No FileSystem module.", nil);
-        return;
-      }
-      if (!([fileSystem permissionsForURI:url] & EXFileSystemPermissionRead)) {
-        reject(@"E_FILESYSTEM_PERMISSIONS", [NSString stringWithFormat:@"File '%@' isn't readable.", uri], nil);
-        return;
-      }
-
-      if (![[NSFileManager defaultManager] fileExistsAtPath:path]) {
-        reject(@"E_INVALID_ATTACHMENT", [NSString stringWithFormat:@"The file does not exist. Given path: `%@`.", path], nil);
-        return;
-      }
-
-      NSString *mimeType = @"application/octet-stream";
-      if ([path pathExtension]) {
-        CFStringRef identifier = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, (__bridge CFStringRef)[path pathExtension], NULL);
-        CFStringRef typeRef = UTTypeCopyPreferredTagWithClass (identifier, kUTTagClassMIMEType);
-        CFRelease(identifier);
-        if (typeRef != NULL) {
-          mimeType = [NSString stringWithString:(__bridge NSString *)(typeRef)];
-          CFRelease(typeRef);
-        }
-      }
-
-      NSData *fileData = [NSData dataWithContentsOfFile:path];
-
-      [composeController addAttachmentData:fileData mimeType:mimeType fileName:[path lastPathComponent]];
-    }
-  }
-
-  self.resolve = resolve;
-  self.reject = reject;
-  id<EXUtilitiesInterface> utilities = [_moduleRegistry getModuleImplementingProtocol:@protocol(EXUtilitiesInterface)];
-  [utilities.currentViewController presentViewController:composeController animated:YES completion:nil];
-}
-
-- (void)mailComposeController:(MFMailComposeViewController *)controller
-          didFinishWithResult:(MFMailComposeResult)result error:(NSError *)error {
-  __weak typeof(self) weakSelf = self;
-  dispatch_async(dispatch_get_main_queue(), ^{
-    [controller dismissViewControllerAnimated:YES completion:^{
-      __strong typeof(self) strongSelf = weakSelf;
-      if (strongSelf && strongSelf.resolve != nil && strongSelf.reject != nil) {
-        if (error != nil) {
-          strongSelf.reject(@"E_MAIL_ERROR", @"An error occurred while trying to send the e-mail.", error);
-          strongSelf.reject = nil;
-          strongSelf.resolve = nil;
-          return;
-        }
-
-        switch (result) {
-          case MFMailComposeResultSent:
-            strongSelf.resolve(@{ @"status": @"sent" });
-            break;
-          case MFMailComposeResultSaved:
-            strongSelf.resolve(@{ @"status": @"saved" });
-            break;
-          case MFMailComposeResultCancelled:
-            strongSelf.resolve(@{ @"status": @"cancelled" });
-            break;
-          case MFMailComposeResultFailed:
-            strongSelf.reject(@"E_MAIL_ERROR", @"Something went wrong while trying to send the e-mail.", error);
-            break;
-          default:
-            strongSelf.reject(@"E_MAIL_ERROR", @"Something went wrong while trying to send the e-mail.", error);
-            break;
-        }
-
-        strongSelf.reject = nil;
-        strongSelf.resolve = nil;
-      }
-    }];
-  });
-}
-
-@end

package/unimodule.json

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