@ionic/portals-react-native 0.5.1 → 0.6.0

package/ios/Portal.swift

@@ -12,13 +12,26 @@ import IonicPortals
 
 @dynamicMemberLookup
 struct Portal {
-    struct Plugin {
+    struct Plugin: Codable {
         var iosClassName: String
         var androidClassPath: String
     }
 
     var _portal: IonicPortals.Portal
     var plugins: [Plugin]
+    private var webVitals: [String]?
+    var usesWebVitals: Bool {
+        get {
+            webVitals?.contains("fcp") ?? false
+        }
+        set {
+            if newValue {
+                webVitals = ["fcp"]
+            } else {
+                webVitals = nil
+            }
+        }
+    }
 
     subscript<T>(dynamicMember keypath: Swift.WritableKeyPath<IonicPortals.Portal, T>) -> T {
         get { _portal[keyPath: keypath] }
@@ -31,66 +44,49 @@ struct Portal {
 }
 
 extension Portal {
-    init?(_ dict: [String: Any], _ liveUpdateManager: LiveUpdateManager) {
-        guard let name = dict["name"] as? String else { return nil }
-        var plugins: [Portal.Plugin] = []
-
-        if let capPlugins = dict["plugins"] as? Array<[String: String]> {
-            plugins = capPlugins.compactMap(Portal.Plugin.init)
-        }
-        
-        var assetMaps: [AssetMap] = []
-        
-        if let maps = dict["assetMaps"] as? Array<[String: String]> {
-            assetMaps = maps.compactMap(AssetMap.init)
-        }
-
-        self._portal = IonicPortals.Portal(
-            name: name,
-            startDir: dict["startDir"] as? String,
-            index: dict["index"] as? String ?? "index.html",
-            initialContext: JSTypes.coerceDictionaryToJSObject(dict["initialContext"] as? [String: Any]) ?? [:],
-            assetMaps: assetMaps,
-            plugins: plugins.toCapPlugin,
-            liveUpdateManager: liveUpdateManager,
-            liveUpdateConfig: (dict["liveUpdate"] as? [String: Any]).flatMap(LiveUpdate.init)
-        )
-
-        self.plugins = plugins
+    func encode(to encoder: JSValueEncoder) throws -> JSObject {
+        var object = try encoder.encodeJSObject(self)
+        object["initialContext"] = _portal.initialContext
+        return object
     }
 
-    var dict: [String: Any] {
-        var base = [
-            "name": self.name,
-            "startDir": self.startDir,
-            "index": self.index,
-            "initialContext": self.initialContext,
-            "liveUpdate": self.liveUpdateConfig?.dict as Any
-        ]
-
-        if !plugins.isEmpty {
-            base["plugins"] = plugins.map(\.dict)
-        }
-
-        return base
+    static func decode(from jsObject: JSObject, with decoder: JSValueDecoder) throws -> Portal {
+        var portal = try decoder.decode(Portal.self, from: jsObject)
+        portal.initialContext = jsObject["initialContext"] as? JSObject ?? [:]
+        return portal
     }
 }
 
-extension Portal.Plugin {
-    init?(_ dict: [String: String]) {
-        guard let iosClassName = dict["iosClassName"],
-              let androidClassPath = dict["androidClassPath"]
-        else { return nil }
-
-        self.iosClassName = iosClassName
-        self.androidClassPath = androidClassPath
+extension Portal: Encodable {
+    enum CodingKeys: String, CodingKey {
+        case name, startDir, plugins, index, initialContext, assetMaps, liveUpdate, webVitals
+    }
+    
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.name, forKey: .name)
+        try container.encode(self.startDir, forKey: .startDir)
+        try container.encode(self.plugins, forKey: .plugins)
+        try container.encode(self.index, forKey: .index)
+        try container.encode(self.assetMaps, forKey: .assetMaps)
+        try container.encode(self.liveUpdateConfig, forKey: .liveUpdate)
+        try container.encodeIfPresent(webVitals, forKey: .webVitals)
     }
+}
 
-    var dict: [String: String] {
-        return [
-            "iosClassName": iosClassName,
-            "androidClassPath": androidClassPath
-        ]
+extension Portal: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let name = try container.decode(String.self, forKey: .name)
+        let startDir = try container.decodeIfPresent(String.self, forKey: .startDir) ?? ""
+        let plugins = try container.decodeIfPresent([Plugin].self, forKey: .plugins) ?? []
+        let index = try container.decodeIfPresent(String.self, forKey: .index) ?? "index.html"
+        let assetMaps = try container.decodeIfPresent([AssetMap].self, forKey: .assetMaps) ?? []
+        let liveUpdateConfig = try container.decodeIfPresent(LiveUpdate.self, forKey: .liveUpdate)
+        let webVitals = try container.decodeIfPresent([String].self, forKey: .webVitals)
+        
+        let portal = IonicPortals.Portal(name: name, startDir: startDir, index: index, assetMaps: assetMaps, plugins: plugins.toCapPlugin, liveUpdateManager: PortalsReactNative.lum, liveUpdateConfig: liveUpdateConfig)
+        self.init(_portal: portal, plugins: plugins, webVitals: webVitals)
     }
 }
 

package/ios/PortalView.swift

@@ -23,10 +23,7 @@ class PortalView: UIView {
     @objc var portal: [String: Any]? {
         get {
             guard let _portal = _portal else { return nil }
-            return [
-                "name": _portal.name,
-                "initialContext": _portal.initialContext
-            ]
+            return try? _portal.encode(to: JSValueEncoder(optionalEncodingStrategy: .undefined))
         }
         
         set {
@@ -34,12 +31,33 @@ class PortalView: UIView {
                   let name = portalDict["name"] as? String
             else { return }
             
-            var portal = PortalsReactNative.getPortal(named: name)
+            var portal: Portal
             
-            if let initialContext = portalDict["initialContext"] as? [String: Any] {
-                portal?.initialContext = JSTypes.coerceDictionaryToJSObject(initialContext) ?? [:]
+            if var deprecatedPortal = PortalsReactNative.getPortal(named: name) {
+                if let initialContext = portalDict["initialContext"] as? [String: Any] {
+                    deprecatedPortal.initialContext = JSTypes.coerceDictionaryToJSObject(initialContext) ?? [:]
+                }
+                portal = deprecatedPortal
+            } else {
+                let jsObject = JSTypes.coerceDictionaryToJSObject(portalDict) ?? [:]
+                do {
+                    portal = try Portal.decode(from: jsObject, with: JSValueDecoder())
+                } catch {
+                    print(error.localizedDescription)
+                    return
+                }
+            }
+            if portal.usesWebVitals {
+                var vitalsPlugin = WebVitalsPlugin { portalName, duration in
+                    IonicPortals.PortalsPubSub
+                        .shared
+                        .publish(
+                            ["portalName": portalName, "duration": duration],
+                            to: "webVitals:received"
+                        )
+                }
+                portal._portal.plugins.append(.instance(vitalsPlugin))
             }
-            
             _portal = portal
         }
     }

package/ios/PortalsConfig.swift

@@ -10,94 +10,7 @@ import Capacitor
 import IonicLiveUpdates
 import IonicPortals
 
-struct PortalsConfig {
-    var portals: [Portal]
+struct PortalsConfig: Decodable {
     var registrationKey: String?
     var secureLiveUpdatesPublicKey: String?
-    
-    struct Portal {
-        var name: String
-        var startDir: String?
-        var index: String?
-        var initialContext: JSObject?
-        var assetMaps: [AssetMap]?
-        var plugins: [ReactNativePortals.Portal.Plugin]?
-        var liveUpdate: LiveUpdate?
-        
-        func portal(with liveUpdateManager: LiveUpdateManager) -> ReactNativePortals.Portal {
-            return .init(
-                _portal: .init(
-                    name: name,
-                    startDir: startDir,
-                    index: index ?? "index.html",
-                    initialContext: initialContext ?? [:],
-                    assetMaps: assetMaps ?? [],
-                    plugins: plugins?.toCapPlugin ?? [],
-                    liveUpdateManager: liveUpdateManager,
-                    liveUpdateConfig: liveUpdate.map { .init(appId: $0.appId, channel: $0.channel, syncOnAdd: $0.syncOnAdd) }
-                ),
-                plugins: plugins ?? []
-            )
-        }
-        
-        struct LiveUpdate {
-            var channel: String
-            var appId: String
-            var syncOnAdd: Bool
-        }
-    }
 }
-
-extension PortalsConfig {
-    init?(_ dict: [String: Any]) {
-        guard let rawPortals = dict["portals"] as? [[String: Any]] else {
-            print("Portals configuration must contain a 'portals' property.")
-            return nil
-        }
-        
-        let portals = rawPortals.compactMap(Portal.init)
-        guard portals.count == rawPortals.count else {
-            print("Invalid portals configuration.")
-            return nil
-        }
-        
-        self.portals = portals
-        registrationKey = dict["registrationKey"] as? String
-        secureLiveUpdatesPublicKey = dict["liveUpdatesKey"] as? String
-    }
-}
-
-extension PortalsConfig.Portal {
-    init?(_ dict: [String: Any]) {
-        guard let name = dict["name"] as? String else {
-            print("Portal confifguration must contain a 'name' property.")
-            return nil
-        }
-        
-        self.name = name
-        startDir = dict["startDir"] as? String
-        index = dict["index"] as? String
-        initialContext = (dict["initialContext"] as? [String: Any])
-            .flatMap { JSTypes.coerceDictionaryToJSObject($0) }
-        plugins = (dict["plugins"] as? Array<[String: String]>)
-            .flatMap { $0.compactMap(ReactNativePortals.Portal.Plugin.init) }
-        assetMaps = (dict["assetMaps"] as? Array<[String: String]>)
-            .flatMap { $0.compactMap(AssetMap.init) }
-        liveUpdate = (dict["liveUpdate"] as? [String: Any])
-            .flatMap(LiveUpdate.init)
-    }
-}
-
-extension PortalsConfig.Portal.LiveUpdate {
-    init?(_ dict: [String: Any]) {
-        guard let appId = dict["appId"] as? String else {
-            print("LiveUpdate configuration must contain an 'appId' property.")
-            return nil
-        }
-        
-        self.appId = appId
-        channel = dict["channel"] as? String ?? "production"
-        syncOnAdd = dict["syncOnAdd"] as? Bool ?? true
-    }
-}
-

package/ios/PortalsReactNative-Bridging-Header.h

@@ -0,0 +1,2 @@
+#import <React/RCTBridgeModule.h>
+#import <React/RCTViewManager.h>

package/ios/PortalsReactNative.swift

@@ -1,42 +1,33 @@
 import Foundation
+import Capacitor
 import IonicPortals
 import IonicLiveUpdates
 import React
 
 @objc(IONPortalsReactNative)
 public class PortalsReactNative: NSObject {
-    private var lum: LiveUpdateManager
+    internal private(set) static var lum: LiveUpdateManager = .shared
+    @available(*, deprecated, message: "This will be removed in the next release")
     internal static var portals = ConcurrentDictionary<String, Portal>(label: "com.portals.reactnative", dict: [:])
+    let encoder = JSValueEncoder(optionalEncodingStrategy: .undefined)
+    let decoder = JSValueDecoder()
     
     public override init() {
         guard let configUrl = Bundle.main.url(forResource: "portals.config.json", withExtension: nil) else {
-            lum = .shared
             return
         }
         
         guard let configData = try? Data(contentsOf: configUrl),
-              let jsonData = try? JSONSerialization.jsonObject(with: configData) as? [String: Any],
-              let portalsConfig = PortalsConfig(jsonData)
+              let portalsConfig = try? JSONDecoder().decode(PortalsConfig.self, from: configData)
         else { fatalError("Portals config data is malformed. Aborting.") }
         
         if let registrationKey = portalsConfig.registrationKey {
             PortalsRegistrationManager.shared.register(key: registrationKey)
         }
         
-        let liveUpdateManager: LiveUpdateManager
         if let publicKeyPath = portalsConfig.secureLiveUpdatesPublicKey {
             guard let publicKeyUrl = Bundle.main.url(forResource: publicKeyPath, withExtension: nil) else { fatalError("Public key not found at \(publicKeyPath)") }
-            liveUpdateManager = SecureLiveUpdateManager(named: "secure-updates", publicKeyUrl: publicKeyUrl)
-        } else {
-            liveUpdateManager = .shared
-        }
-        
-        lum = liveUpdateManager
-        
-        let portals = portalsConfig.portals.map { $0.portal(with: liveUpdateManager) }
-        
-        for portal in portals {
-            Self.portals[portal.name] = portal
+            Self.lum = SecureLiveUpdateManager(named: "secure-updates", publicKeyUrl: publicKeyUrl)
         }
     }
     
@@ -47,39 +38,53 @@ public class PortalsReactNative: NSObject {
     
     @objc func enableSecureLiveUpdates(_ publicKeyPath: String, resolver: RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
         guard let publicKeyUrl = Bundle.main.url(forResource: publicKeyPath, withExtension: nil) else { fatalError("Public key not found at \(publicKeyPath)") }
-        lum = SecureLiveUpdateManager(named: "secure-updates", publicKeyUrl: publicKeyUrl)
+        Self.lum = SecureLiveUpdateManager(named: "secure-updates", publicKeyUrl: publicKeyUrl)
         resolver(())
     }
     
+    @available(*, deprecated, message: "This will be removed in the next release")
     @objc func addPortal(_ portalDict: [String: Any], resolver: RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
-        guard let portal = Portal(portalDict, lum) else { return rejector(nil, "Invalid Portal configuration", nil) }
-        Self.portals[portal.name] = portal
-        resolver(portal.dict)
+        do {
+            let portal = try Portal.decode(from: JSTypes.coerceDictionaryToJSObject(portalDict) ?? [:], with: decoder)
+            Self.portals[portal.name] = portal
+            resolver(try encoder.encode(portal))
+        } catch {
+            rejector(nil, "Invalid Portal configuration", error)
+        }
     }
     
+    @available(*, deprecated, message: "This will be removed in the next release")
     @objc func addPortals(_ portalsArray: [[String: Any]], resolver: RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
-        let portals = portalsArray.compactMap { Portal($0, lum) }
-        
-        for portal in portals {
-            Self.portals[portal.name] = portal
+        do {
+            let portals = try decoder.decode([Portal].self, from: JSTypes.coerceArrayToJSArray(portalsArray) ?? [])
+            for portal in portals {
+                Self.portals[portal.name] = portal
+            }
+            resolver(try encoder.encode(portals))
+        } catch {
+            rejector(nil, "Invalid Portal configuration", error)
         }
-        
-        resolver(portals.map(\.dict))
     }
     
+    @available(*, deprecated, message: "This will be removed in the next release")
     static func getPortal(named name: String) -> Portal? { portals[name] }
     
+    @available(*, deprecated, message: "This will be removed in the next release")
     @objc func getPortal(_ name: String, resolver: RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
         guard let portal = Self.getPortal(named: name) else { return rejector(nil, "Portal named \(name) not registered", nil) }
-        resolver(portal.dict)
+        do {
+            resolver(try encoder.encode(portal))
+        } catch {
+            rejector(nil, "Invalid Portal configuration", error)
+        }
     }
     
     @objc func syncOne(_ appId: String, resolver: @escaping RCTPromiseResolveBlock, rejector: @escaping RCTPromiseRejectBlock) {
-        lum.sync(appId: appId, isParallel: true) { result in
-            switch result {
-            case .success(let update):
-                resolver(update.dict)
-            case .failure(let error):
+        Task {
+            do {
+                let result = try await Self.lum.sync(appId: appId)
+                resolver(try? JSValueEncoder(optionalEncodingStrategy: .undefined).encode(result))
+            } catch {
                 rejector(nil, nil, error)
             }
         }
@@ -87,15 +92,15 @@ public class PortalsReactNative: NSObject {
     
     @objc func syncSome(_ appIds: [String], resolver: @escaping RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
         Task {
-            let syncResult = await lum.syncSome(appIds)
-            resolver(syncResult.dict)
+            let syncResult = await Self.lum.syncSome(appIds)
+            resolver(try? syncResult.dict)
         }
     }
     
     @objc func syncAll(_ resolver: @escaping RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
         Task {
-            let syncResult = await lum.syncAll()
-            resolver(syncResult.dict)
+            let syncResult = await Self.lum.syncAll()
+            resolver(try? syncResult.dict)
         }
     }
     

package/ios/SyncResult+SyncError+Encodable.swift

@@ -0,0 +1,55 @@
+//
+//  SyncResult+Dict.swift
+//  ReactNativePortals
+//
+//  Created by Steven Sherry on 3/28/23.
+//  Copyright © 2023 Facebook. All rights reserved.
+//
+
+import IonicLiveUpdates
+
+extension LiveUpdateManager.SyncResult: Encodable {
+    enum TopLevelKeys: String, CodingKey { case liveUpdate, snapshot, source, activeApplicationPathChanged }
+    enum LiveUpdateKeys: String, CodingKey { case appId, channel }
+    enum SnapshotKeys: String, CodingKey { case id, buildId }
+
+    public func encode(to encoder: Encoder) throws {
+        var topLevelContainer = encoder.container(keyedBy: TopLevelKeys.self)
+
+        var liveUpdateContainer = topLevelContainer.nestedContainer(keyedBy: LiveUpdateKeys.self, forKey: .liveUpdate)
+        try liveUpdateContainer.encode(liveUpdate.appId, forKey: .appId)
+        try liveUpdateContainer.encode(liveUpdate.channel, forKey: .channel)
+
+        if let snapshot {
+            var snapshotContainer = topLevelContainer.nestedContainer(keyedBy: SnapshotKeys.self, forKey: .snapshot)
+            try snapshotContainer.encode(snapshot.id, forKey: .id)
+            try snapshotContainer.encode(snapshot.buildId, forKey: .buildId)
+        }
+
+        if case let .cache(pathsChanged) = source {
+            try topLevelContainer.encode("cache", forKey: .source)
+            try topLevelContainer.encode(pathsChanged, forKey: .activeApplicationPathChanged)
+        } else {
+            try topLevelContainer.encode("download", forKey: .source)
+            try topLevelContainer.encode(true, forKey: .activeApplicationPathChanged)
+        }
+    }
+}
+
+extension LiveUpdateManager.SyncError: Encodable {
+    enum CodingKeys: String, CodingKey { case appId, failStep, message }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        let failStep: String
+        if case .secureUpdateError = reason {
+            failStep = "VERIFY"
+        } else {
+            failStep = self.failStep.rawValue.uppercased()
+        }
+
+        try container.encode(appId, forKey: .appId)
+        try container.encode(failStep, forKey: .failStep)
+        try container.encode(errorDescription, forKey: .message)
+    }
+}

package/ios/WebVitals.swift

@@ -8,10 +8,27 @@
 
 import IonicPortals
 import React
+import Combine
 
 @objc(IONPortalsWebVitals)
 class WebVitals: RCTEventEmitter {
     private let fcp = "vitals:fcp"
+    private var subscription: AnyCancellable?
+    
+    override init() {
+        super.init()
+        subscription = IonicPortals.PortalsPubSub
+            .shared
+            .publisher(for: "webVitals:received")
+            .data()
+            .sink { [weak self] data in
+                guard let self = self else { return }
+                self.sendEvent(
+                    withName: self.fcp,
+                    body: data
+                )
+            }
+    }
 
     override func supportedEvents() -> [String] {
         [fcp]
@@ -21,33 +38,9 @@ class WebVitals: RCTEventEmitter {
         guard var portal = PortalsReactNative.portals[portalName] else {
             return resolver(())
         }
-
-        var portalPlugins = portal._portal.plugins.filter { plugin in
-            switch plugin {
-            case .instance(let plugin):
-                return type(of: plugin) != WebVitalsPlugin.self
-            case .type:
-                return true
-            }
-        }
-
-
-        var vitalsPlugin = WebVitalsPlugin { [weak self] _, duration in
-            guard let self = self else { return }
-            self.sendEvent(
-                withName: self.fcp,
-                body: [
-                    "portalName": portalName,
-                    "duration": duration
-                ]
-            )
-        }
-
-        portalPlugins.append(.instance(vitalsPlugin))
-        portal._portal.plugins = portalPlugins
-
+        
+        portal.usesWebVitals = true
         PortalsReactNative.portals[portalName] = portal
-
         resolver(())
     }