expo-modules-core 0.7.0 → 0.9.1

package/ios/Swift/Modules/ModuleDefinitionComponents.swift

@@ -12,6 +12,7 @@ extension AnyModule {
   /**
    Sets the name of the module that is exported to the JavaScript world.
    */
+  @available(*, deprecated, renamed: "Name")
   public func name(_ name: String) -> AnyDefinition {
     return ModuleNameDefinition(name: name)
   }
@@ -21,6 +22,7 @@ extension AnyModule {
   /**
    Creates module's lifecycle listener that is called right after module initialization.
    */
+  @available(*, deprecated, renamed: "OnCreate")
   public func onCreate(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.moduleCreate, closure)
   }
@@ -28,6 +30,7 @@ extension AnyModule {
   /**
    Creates module's lifecycle listener that is called when the module is about to be deallocated.
    */
+  @available(*, deprecated, renamed: "OnDestroy")
   public func onDestroy(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.moduleDestroy, closure)
   }
@@ -35,6 +38,7 @@ extension AnyModule {
   /**
    Creates module's lifecycle listener that is called when the app context owning the module is about to be deallocated.
    */
+  @available(*, deprecated, renamed: "OnAppContextDestroys")
   public func onAppContextDestroys(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.appContextDestroys, closure)
   }
@@ -42,6 +46,7 @@ extension AnyModule {
   /**
    Creates a listener that is called when the app is about to enter the foreground mode.
    */
+  @available(*, deprecated, renamed: "OnAppEntersBackground")
   public func onAppEntersForeground(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.appEntersForeground, closure)
   }
@@ -49,6 +54,7 @@ extension AnyModule {
   /**
    Creates a listener that is called when the app becomes active again.
    */
+  @available(*, deprecated, renamed: "OnAppBecomesActive")
   public func onAppBecomesActive(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.appBecomesActive, closure)
   }
@@ -56,6 +62,7 @@ extension AnyModule {
   /**
    Creates a listener that is called when the app enters the background mode.
    */
+  @available(*, deprecated, renamed: "OnAppEntersBackground")
   public func onAppEntersBackground(_ closure: @escaping () -> Void) -> AnyDefinition {
     return EventListener(.appEntersBackground, closure)
   }
@@ -65,55 +72,70 @@ extension AnyModule {
   /**
    Creates the view manager definition that scopes other view-related definitions.
    */
+  @available(*, deprecated, renamed: "ViewManager")
   public func viewManager(@ViewManagerDefinitionBuilder _ closure: @escaping () -> ViewManagerDefinition) -> AnyDefinition {
     return closure()
   }
 }
 
-// TODO: - Remove deprecated `method` component once SDK44 is out.
-public extension AnyModule {
-  /**
-   Function without arguments.
-   */
-  @available(*, deprecated, renamed: "function")
-  func method<R>(
-    _ name: String,
-    _ closure: @escaping () -> R
-  ) -> AnyFunction {
-    return ConcreteFunction(
-      name,
-      argTypes: [],
-      closure
-    )
-  }
+// MARK: - Module name
 
-  /**
-   Function with one argument.
-   */
-  @available(*, deprecated, renamed: "function")
-  func method<R, A0: AnyArgument>(
-    _ name: String,
-    _ closure: @escaping (A0) -> R
-  ) -> AnyFunction {
-    return ConcreteFunction(
-      name,
-      argTypes: [ArgumentType(A0.self)],
-      closure
-    )
-  }
+/**
+ Sets the name of the module that is exported to the JavaScript world.
+ */
+public func Name(_ name: String) -> AnyDefinition {
+  return ModuleNameDefinition(name: name)
+}
 
-  /**
-   Function with two arguments.
-   */
-  @available(*, deprecated, renamed: "function")
-  func method<R, A0: AnyArgument, A1: AnyArgument>(
-    _ name: String,
-    _ closure: @escaping (A0, A1) -> R
-  ) -> AnyFunction {
-    return ConcreteFunction(
-      name,
-      argTypes: [ArgumentType(A0.self), ArgumentType(A1.self)],
-      closure
-    )
-  }
+// MARK: - Module's lifecycle
+
+/**
+ Creates module's lifecycle listener that is called right after module initialization.
+ */
+public func OnCreate(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.moduleCreate, closure)
+}
+
+/**
+ Creates module's lifecycle listener that is called when the module is about to be deallocated.
+ */
+public func OnDestroy(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.moduleDestroy, closure)
+}
+
+/**
+ Creates module's lifecycle listener that is called when the app context owning the module is about to be deallocated.
+ */
+public func OnAppContextDestroys(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.appContextDestroys, closure)
+}
+
+/**
+ Creates a listener that is called when the app is about to enter the foreground mode.
+ */
+public func OnAppEntersForeground(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.appEntersForeground, closure)
+}
+
+/**
+ Creates a listener that is called when the app becomes active again.
+ */
+public func OnAppBecomesActive(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.appBecomesActive, closure)
+}
+
+/**
+ Creates a listener that is called when the app enters the background mode.
+ */
+public func OnAppEntersBackground(_ closure: @escaping () -> Void) -> AnyDefinition {
+  return EventListener(.appEntersBackground, closure)
+}
+
+// MARK: - View Manager
+
+/**
+ Creates the view manager definition that scopes other view-related definitions.
+ */
+public func ViewManager(@ViewManagerDefinitionBuilder _ closure: @escaping () -> ViewManagerDefinition) -> AnyDefinition {
+  return closure()
 }

package/ios/Swift/ModulesProvider.swift

@@ -1,16 +1,9 @@
 import Foundation
 
 /**
- An empty protocol that Objective-C can refer to as a type of the modules provider.
- In Objective-C code we do not do anything with it except passing it back to the Swift light side.
+ Swift protocol defining the requirements for modules providers.
  */
-@objc
-public protocol ModulesProviderObjCProtocol {}
-
-/**
- Swift protocol defining the requirements for modules providers. Extends its Objective-C counterpart `ModulesProviderObjCProtocol`.
- */
-public protocol ModulesProviderProtocol: ModulesProviderObjCProtocol {
+public protocol ModulesProviderProtocol {
   func getModuleClasses() -> [AnyModule.Type]
 
   /**
@@ -30,7 +23,7 @@ public protocol ModulesProviderProtocol: ModulesProviderObjCProtocol {
  The proper implementation is generated by autolinking as part of `pod install` command.
  */
 @objc
-open class ModulesProvider: NSObject, ModulesProviderProtocol, ModulesProviderObjCProtocol {
+open class ModulesProvider: NSObject, ModulesProviderProtocol {
   open func getModuleClasses() -> [AnyModule.Type] {
     return []
   }

package/ios/Swift/Objects/ObjectDefinitionComponents.swift

@@ -6,6 +6,7 @@
 /**
  Definition function setting the module's constants to export.
  */
+@available(*, deprecated, renamed: "Constants")
 public func constants(_ body: @escaping () -> [String: Any?]) -> AnyDefinition {
   return ConstantsDefinition(body: body)
 }
@@ -13,15 +14,31 @@ public func constants(_ body: @escaping () -> [String: Any?]) -> AnyDefinition {
 /**
  Definition function setting the module's constants to export.
  */
+public func Constants(_ body: @escaping () -> [String: Any?]) -> AnyDefinition {
+  return ConstantsDefinition(body: body)
+}
+
+/**
+ Definition function setting the module's constants to export.
+ */
+@available(*, deprecated, renamed: "Constants")
 public func constants(_ body: @autoclosure @escaping () -> [String: Any?]) -> AnyDefinition {
   return ConstantsDefinition(body: body)
 }
 
+/**
+ Definition function setting the module's constants to export.
+ */
+public func Constants(_ body: @autoclosure @escaping () -> [String: Any?]) -> AnyDefinition {
+  return ConstantsDefinition(body: body)
+}
+
 // MARK: - Functions
 
 /**
  Function without arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R>(
   _ name: String,
   _ closure: @escaping () throws -> R
@@ -36,6 +53,7 @@ public func function<R>(
 /**
  Function with one argument.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0) throws -> R
@@ -50,6 +68,7 @@ public func function<R, A0: AnyArgument>(
 /**
  Function with two arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1) throws -> R
@@ -64,6 +83,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument>(
 /**
  Function with three arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2) throws -> R
@@ -82,6 +102,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument>(
 /**
  Function with four arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2, A3) throws -> R
@@ -101,6 +122,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: A
 /**
  Function with five arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: AnyArgument, A4: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2, A3, A4) throws -> R
@@ -121,6 +143,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: A
 /**
  Function with six arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: AnyArgument, A4: AnyArgument, A5: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2, A3, A4, A5) throws -> R
@@ -142,6 +165,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: A
 /**
  Function with seven arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: AnyArgument, A4: AnyArgument, A5: AnyArgument, A6: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2, A3, A4, A5, A6) throws -> R
@@ -164,6 +188,7 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: A
 /**
  Function with eight arguments.
  */
+@available(*, deprecated, renamed: "AsyncFunction")
 public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: AnyArgument, A4: AnyArgument, A5: AnyArgument, A6: AnyArgument, A7: AnyArgument>(
   _ name: String,
   _ closure: @escaping (A0, A1, A2, A3, A4, A5, A6, A7) throws -> R
@@ -189,20 +214,44 @@ public func function<R, A0: AnyArgument, A1: AnyArgument, A2: AnyArgument, A3: A
 /**
  Defines event names that the object can send to JavaScript.
  */
+@available(*, deprecated, renamed: "Events")
 public func events(_ names: String...) -> AnyDefinition {
   return EventsDefinition(names: names)
 }
 
+/**
+ Defines event names that the object can send to JavaScript.
+ */
+public func Events(_ names: String...) -> AnyDefinition {
+  return EventsDefinition(names: names)
+}
+
 /**
  Function that is invoked when the first event listener is added.
  */
+@available(*, deprecated, renamed: "OnStartObserving")
 public func onStartObserving(_ body: @escaping () -> Void) -> AnyFunction {
   return ConcreteFunction("startObserving", argTypes: [], body)
 }
 
+/**
+ Function that is invoked when the first event listener is added.
+ */
+public func OnStartObserving(_ body: @escaping () -> Void) -> AnyFunction {
+  return ConcreteFunction("startObserving", argTypes: [], body)
+}
+
 /**
  Function that is invoked when all event listeners are removed.
  */
+@available(*, deprecated, renamed: "OnStopObserving")
 public func onStopObserving(_ body: @escaping () -> Void) -> AnyFunction {
   return ConcreteFunction("stopObserving", argTypes: [], body)
 }
+
+/**
+ Function that is invoked when all event listeners are removed.
+ */
+public func OnStopObserving(_ body: @escaping () -> Void) -> AnyFunction {
+  return ConcreteFunction("stopObserving", argTypes: [], body)
+}

package/ios/Swift/SwiftInteropBridge.swift

@@ -11,9 +11,14 @@ public final class SwiftInteropBridge: NSObject {
     appContext.moduleRegistry
   }
 
+  internal init(appContext: AppContext) {
+    self.appContext = appContext
+    super.init()
+  }
+
   @objc
-  public init(modulesProvider: ModulesProviderObjCProtocol, legacyModuleRegistry: EXModuleRegistry) {
-    self.appContext = AppContext(withModulesProvider: modulesProvider as! ModulesProviderProtocol, legacyModuleRegistry: legacyModuleRegistry)
+  public init(modulesProvider: ModulesProvider, legacyModuleRegistry: EXModuleRegistry) {
+    self.appContext = AppContext(withModulesProvider: modulesProvider, legacyModuleRegistry: legacyModuleRegistry)
     super.init()
   }
 
@@ -83,9 +88,13 @@ public final class SwiftInteropBridge: NSObject {
   }
 
   @objc
-  public func exportedViewManagersNames() -> [String] {
-    return registry.compactMap { holder in
-      return holder.definition.viewManager != nil ? holder.name : nil
+  public func viewManagersMetadata() -> [String: Any] {
+    return registry.reduce(into: [String: Any]()) { acc, holder in
+      if let viewManager = holder.definition.viewManager {
+        acc[holder.name] = [
+          "propsNames": viewManager.props.map { $0.name }
+        ]
+      }
     }
   }
 

package/ios/Swift/Views/ComponentData.swift

@@ -1,12 +1,13 @@
 // Copyright 2021-present 650 Industries. All rights reserved.
 
+import React
 
 /**
  Custom component data extending `RCTComponentData`. Its main purpose is to handle event-based props (callbacks),
  but it also simplifies capturing the view config so we can omit some reflections that React Native executes.
  */
 @objc(EXComponentData)
-public final class ComponentData: EXComponentDataCompatibleWrapper {
+public final class ComponentData: RCTComponentData {
   /**
    Weak pointer to the holder of a module that the component data was created for.
    */

package/ios/Swift/Views/ExpoView.swift

@@ -0,0 +1,8 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import React
+
+/**
+ The view that just extends `RCTView`. In the future we may add more features here.
+ */
+open class ExpoView: RCTView {}

package/ios/Swift/Views/ViewManagerDefinitionComponents.swift

@@ -5,15 +5,24 @@
 /**
  Defines the factory creating a native view when the module is used as a view.
  */
+@available(*, deprecated, renamed: "View")
 public func view(_ closure: @escaping () -> UIView) -> ViewManagerDefinitionComponent {
   return ViewFactory(closure)
 }
 
+/**
+ Defines the factory creating a native view when the module is used as a view.
+ */
+public func View(_ closure: @escaping () -> UIView) -> ViewManagerDefinitionComponent {
+  return ViewFactory(closure)
+}
+
 // MARK: Props
 
 /**
  Creates a view prop that defines its name and setter.
  */
+@available(*, deprecated, renamed: "Prop")
 public func prop<ViewType: UIView, PropType: AnyArgument>(
   _ name: String,
   _ setter: @escaping (ViewType, PropType) -> Void
@@ -24,3 +33,17 @@ public func prop<ViewType: UIView, PropType: AnyArgument>(
     setter: setter
   )
 }
+
+/**
+ Creates a view prop that defines its name and setter.
+ */
+public func Prop<ViewType: UIView, PropType: AnyArgument>(
+  _ name: String,
+  _ setter: @escaping (ViewType, PropType) -> Void
+) -> ViewManagerDefinitionComponent {
+  return ConcreteViewProp(
+    name: name,
+    propType: ArgumentType(PropType.self),
+    setter: setter
+  )
+}

package/ios/Swift.h

@@ -1,5 +1,10 @@
 // Copyright 2018-present 650 Industries. All rights reserved.
 
+// The generated swift header may depend on some Objective-C declarations,
+// adding dependency imports here to prevent declarations not found errors.
+#import <ExpoModulesCore/EXDefines.h>
+#import <ExpoModulesCore/RCTComponentData+Privates.h>
+
 // When `use_frameworks!` is used, the generated Swift header is inside ExpoModulesCore module.
 // Otherwise, it's available only locally with double-quoted imports.
 #if __has_include(<ExpoModulesCore/ExpoModulesCore-Swift.h>)

package/ios/Tests/ArgumentTypeSpec.swift

@@ -1,11 +1,10 @@
 // Copyright 2021-present 650 Industries. All rights reserved.
 
-import Quick
-import Nimble
+import ExpoModulesTestCore
 
 @testable import ExpoModulesCore
 
-class ArgumentTypeSpec: QuickSpec {
+class ArgumentTypeSpec: ExpoSpec {
   override func spec() {
     it("casts primitives") {
       let type = ArgumentType(Int.self)

package/ios/Tests/ConstantsSpec.swift

@@ -1,15 +1,14 @@
-import Quick
-import Nimble
+import ExpoModulesTestCore
 
 @testable import ExpoModulesCore
 
-class ConstantsSpec: QuickSpec {
+class ConstantsSpec: ExpoSpec {
   override func spec() {
     let appContext = AppContext()
 
     it("takes closure resolving to dictionary") {
       let holder = mockModuleHolder(appContext) {
-        constants {
+        Constants {
           return ["test": 123]
         }
       }
@@ -18,15 +17,15 @@ class ConstantsSpec: QuickSpec {
 
     it("takes the dictionary") {
       let holder = mockModuleHolder(appContext) {
-        constants(["test": 123])
+        Constants(["test": 123])
       }
       expect(holder.getConstants()["test"] as? Int) == 123
     }
 
     it("merges multiple constants definitions") {
       let holder = mockModuleHolder(appContext) {
-        constants(["test": 456, "test2": 789])
-        constants(["test": 123])
+        Constants(["test": 456, "test2": 789])
+        Constants(["test": 123])
       }
       let consts = holder.getConstants()
       expect(consts["test"] as? Int) == 123

package/ios/Tests/ConvertiblesSpec.swift

@@ -1,12 +1,11 @@
 // Copyright 2018-present 650 Industries. All rights reserved.
 
 import CoreGraphics
-import Quick
-import Nimble
+import ExpoModulesTestCore
 
 @testable import ExpoModulesCore
 
-class ConvertiblesSpec: QuickSpec {
+class ConvertiblesSpec: ExpoSpec {
   override func spec() {
     describe("URL") {
       it("converts from remote url") {

package/ios/Tests/ExceptionsSpec.swift

@@ -1,11 +1,10 @@
 // Copyright 2021-present 650 Industries. All rights reserved.
 
-import Quick
-import Nimble
+import ExpoModulesTestCore
 
 @testable import ExpoModulesCore
 
-final class ExceptionsSpec: QuickSpec {
+final class ExceptionsSpec: ExpoSpec {
   override func spec() {
     it("has name") {
       let error = TestException()

package/ios/Tests/ExpoModulesSpec.swift

@@ -0,0 +1,75 @@
+// Copyright 2022-present 650 Industries. All rights reserved.
+
+import ExpoModulesTestCore
+
+@testable import ExpoModulesCore
+
+class ExpoModulesSpec: ExpoSpec {
+  override func spec() {
+    let appContext = AppContext.create()
+    let interopBridge = SwiftInteropBridge(appContext: appContext)
+    let runtime = appContext.runtime
+    let testModuleName = "TestModule"
+    let testFunctionName = "testFunction"
+    let constantsDict: [String: Any] = [
+      "expo": "is cool",
+      "sdk": 45,
+    ]
+
+    beforeSuite {
+      try! appContext.installExpoModulesHostObject(interopBridge)
+
+      appContext.moduleRegistry.register(holder: mockModuleHolder(appContext) {
+        Name(testModuleName)
+
+        Constants(constantsDict)
+
+        Function(testFunctionName) { Double.pi }
+      })
+    }
+
+    describe("host object") {
+      it("is defined") {
+        expect(try! runtime?.eval("'ExpoModules' in this").asBool()) === true
+      }
+
+      it("has native module defined") {
+        expect(try! runtime?.eval("'\(testModuleName)' in ExpoModules").asBool()) === true
+      }
+
+      it("can access native module") {
+        let nativeModule = try! runtime?.eval("ExpoModules.\(testModuleName)")
+        expect(nativeModule?.isUndefined()) == false
+        expect(nativeModule?.isObject()) == true
+        expect(nativeModule?.getRaw()).notTo(beNil())
+      }
+
+      it("has keys for registered modules") {
+        let registeredModuleNames = appContext.moduleRegistry.getModuleNames()
+        let keys = try! runtime?.eval("Object.keys(ExpoModules)").asArray().compactMap {
+          return try! $0?.asString()
+        }
+        expect(keys).to(contain(registeredModuleNames))
+      }
+    }
+
+    describe("module") {
+      it("exposes constants") {
+        let dict = try! runtime!.eval("ExpoModules.TestModule").asDict()
+
+        dict.forEach { (key: String, value: Any) in
+          expect(value) === dict[key]!
+        }
+      }
+
+      it("has function") {
+        expect(try! runtime?.eval("typeof ExpoModules.TestModule.\(testFunctionName)").asString()) == "function"
+        expect(try! runtime?.eval("ExpoModules.TestModule.\(testFunctionName)").isFunction()) == true
+      }
+
+      it("calls function") {
+        expect(try! runtime?.eval("ExpoModules.TestModule.\(testFunctionName)()").asDouble()) == Double.pi
+      }
+    }
+  }
+}