@ionic/portals-react-native 0.1.0 → 0.2.0

package/src/index.ts

@@ -5,8 +5,7 @@ import {
   ViewProps,
 } from 'react-native';
 
-const { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =
-  NativeModules;
+const { IONPortalPubSub, IONPortalsReactNative } = NativeModules;
 
 export { default as PortalView } from './PortalView';
 
@@ -82,9 +81,10 @@ export const publish = (topic: string, data: any) => {
 /**
  * Validates that a valid registration key has been procured from http://ionic.io/register-portals
  * @param key The registration key
+ * @returns Promise<void>
  */
-export const register = (key: string) => {
-  IONPortalManager.register(key);
+export const register = async (key: string): Promise<void> => {
+  return IONPortalsReactNative.register(key);
 };
 
 /**
@@ -126,9 +126,30 @@ export type PortalProps = PortalProp & ViewProps;
  * Adds a Portal to an internal registry. Must be called before attempting to render a {@link PortalView}.
  *
  * @param portal The portal to add to the internal registry.
+ * @returns Promise containing the Portal that was added to the registry.
  */
-export const addPortal = (portal: Portal) => {
-  IONPortalManager.addPortal(portal);
+export const addPortal = async (portal: Portal): Promise<Portal> => {
+  return IONPortalsReactNative.addPortal(portal);
+};
+
+/**
+ * Adds all portals to an internal registry. This or {@link addPortal} must be called before attempting to render a {@link PortalView}
+ *
+ * @param portals The portals to add to the internal registry.
+ * @returns Promise containing the Portals that were added to the registry.
+ */
+export const addPortals = async (portals: Portal[]): Promise<Portal[]> => {
+  return IONPortalsReactNative.addPortals(portals);
+};
+
+/**
+ * Gets a {@link Portal} previously registered via {@link addPortal} or {@link addPortals}.
+ *
+ * @param name The portal name to retrieve from the internal registry.
+ * @returns Promise containing the registered {@link Portal}. If the {@link Portal} was not registered, the Promise will fail.
+ */
+export const getPortal = async (name: string): Promise<Portal> => {
+  return IONPortalsReactNative.getPortal(name);
 };
 
 export interface LiveUpdate {
@@ -156,14 +177,28 @@ export interface SyncResults {
   errors: LiveUpdateError[];
 }
 
+/**
+ * Configures LiveUpdates to cyrptographically verify the contents of the downloaded bundles.
+ * This method must be called before any LiveUpdates are registered otherwise they will no longer be tracked.
+ *
+ * @param pathToKey The *relative* path to the public key for verification.
+ * This path should be the same relatibe to the main application bundle on iOS and the assets directory on Android.
+ * @returns Promise<void>
+ */
+export const enableSecureLiveUpdates = async (
+  pathToKey: string
+): Promise<void> => {
+  return IONPortalsReactNative.enableSecureLiveUpdates(pathToKey);
+};
+
 /**
  * Syncs a single live update.
  *
  * @param appId The AppFlow application ID to sync.
  * @returns A Promise<LiveUpdate>. A failure should result in a {@link LiveUpdateError}.
  */
-export const syncOne = (appId: string): Promise<LiveUpdate> => {
-  return IONLiveUpdatesManager.syncOne(appId);
+export const syncOne = async (appId: string): Promise<LiveUpdate> => {
+  return IONPortalsReactNative.syncOne(appId);
 };
 
 /**
@@ -172,14 +207,14 @@ export const syncOne = (appId: string): Promise<LiveUpdate> => {
  * @param appIds The AppFlow application IDs to sync.
  * @returns Promise<SyncResults>
  */
-export const syncSome = (appIds: string[]): Promise<SyncResults> => {
-  return IONLiveUpdatesManager.syncSome(appIds);
+export const syncSome = async (appIds: string[]): Promise<SyncResults> => {
+  return IONPortalsReactNative.syncSome(appIds);
 };
 
 /**
  * Syncs all registered LiveUpdates
  * @returns Promise<SyncResults>
  */
-export const syncAll = (): Promise<SyncResults> => {
-  return IONLiveUpdatesManager.syncAll();
+export const syncAll = async (): Promise<SyncResults> => {
+  return IONPortalsReactNative.syncAll();
 };

package/ios/LiveUpdatesManager.m

@@ -1,16 +0,0 @@
-//
-//  LiveUpdatesManager.m
-//  ReactNativePortals
-//
-//  Created by Steven Sherry on 6/21/22.
-//  Copyright © 2022 Facebook. All rights reserved.
-//
-
-#import <React/RCTBridgeModule.h>
-
-@interface RCT_EXTERN_MODULE(IONLiveUpdatesManager, NSObject)
-RCT_EXTERN_METHOD(addLiveUpdate: (NSDictionary) liveUpdate)
-RCT_EXTERN_METHOD(syncOne: (NSString *) appId resolver: (RCTPromiseResolveBlock) resolver rejector: (RCTPromiseRejectBlock) rejector)
-RCT_EXTERN_METHOD(syncSome: (NSArray) appIds resolver: (RCTPromiseResolveBlock) resolver rejector: (RCTPromiseRejectBlock) rejector)
-RCT_EXTERN_METHOD(syncAll: (RCTPromiseResolveBlock) resolver rejector: (RCTPromiseRejectBlock) rejector)
-@end

package/ios/ReactNativePortals.swift

@@ -1,262 +0,0 @@
-import Foundation
-import IonicPortals
-import IonicLiveUpdates
-import React
-import UIKit
-import Capacitor
-
-@objc(IONPortalManager)
-public class PortalManager: NSObject {
-    private static var portals: [String: Portal] = [:]
-    
-    public static func register(_ key: String) {
-        PortalsRegistrationManager.shared.register(key: key)
-    }
-    
-    public static func add(_ portal: Portal) {
-        portals[portal.name] = portal
-    }
-    
-    static func getPortal(named name: String) -> Portal? { portals[name] }
-    
-    @objc func register(_ key: String) {
-        Self.register(key)
-    }
-    
-    @objc func addPortal(_ portalDict: [String: Any]) {
-        guard let portal = Portal(portalDict) else { return }
-        Self.add(portal)
-    }
-    
-    @objc static func requiresMainQueueSetup() -> Bool { true }
-}
-
-@objc(IONPortalPubSub)
-class PortalsPubSub: RCTEventEmitter {
-    private let eventName = "PortalsSubscription"
-    
-    override func supportedEvents() -> [String]! {
-        [eventName]
-    }
-    
-    @objc func subscribe(_ topic: String, resolver: RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
-        let subRef = IonicPortals.PortalsPubSub.subscribe(topic) { [weak self] result in
-            guard let self = self else { return }
-            self.sendEvent(
-                withName: self.eventName,
-                body: [
-                    "subscriptionRef": result.subscriptionRef,
-                    "topic": result.topic,
-                    "data": result.data
-                ]
-            )
-        }
-        
-        resolver(subRef)
-    }
-    
-    @objc func unsubscribe(_ topic: String, subscriptionRef: NSNumber) {
-        IonicPortals.PortalsPubSub.unsubscribe(from: topic, subscriptionRef: subscriptionRef.intValue)
-    }
-    
-    @objc func publish(_ topic: String, data: Any) {
-        IONPortalsPubSub.publish(message: data, topic: topic)
-    }
-    
-    override class func requiresMainQueueSetup() -> Bool { true }
-}
-
-@objc(IONPortalViewManager)
-class PortalViewManager: RCTViewManager {
-    override class func requiresMainQueueSetup() -> Bool { true }
-    override func view() -> UIView! { PortalView() }
-}
-
-class PortalView: UIView {
-    private var webView: PortalUIView?
-    
-    @objc var portal: [String: Any]? {
-        get {
-            guard let _portal = _portal else { return nil }
-            return [
-                "name": _portal.name,
-                "initialContext": _portal.initialContext
-            ]
-        }
-        
-        set {
-            guard let portalDict = newValue,
-                  let name = portalDict["name"] as? String
-            else { return }
-
-            var portal = PortalManager.getPortal(named: name)
-            if let initialContext = portalDict["initialContext"] as? [String: Any] {
-                portal?.initialContext = JSTypes.coerceDictionaryToJSObject(initialContext) ?? [:]
-            }
-            
-            _portal = portal
-        }
-    }
-    
-    private var _portal: Portal? {
-        didSet {
-            guard let portal = _portal else { return }
-            
-            DispatchQueue.main.async { [weak self] in
-                guard let self = self else { return }
-                self.webView?.removeFromSuperview()
-                let webView = PortalUIView(portal: portal)
-                webView.translatesAutoresizingMaskIntoConstraints = false
-                self.addSubview(webView)
-                NSLayoutConstraint.activate([
-                    webView.topAnchor.constraint(equalTo: self.topAnchor),
-                    webView.bottomAnchor.constraint(equalTo: self.bottomAnchor),
-                    webView.leadingAnchor.constraint(equalTo: self.leadingAnchor),
-                    webView.trailingAnchor.constraint(equalTo: self.trailingAnchor)
-                ])
-                self.webView = webView
-            }
-        }
-    }
-}
-
-extension Portal {
-    init?(_ dict: [String: Any]) {
-        guard let name = dict["name"] as? String else { return nil }
-        self.init(
-            name: name,
-            startDir: dict["startDir"] as? String,
-            index: dict["index"] as? String ?? "index.html",
-            initialContext: JSTypes.coerceDictionaryToJSObject(dict["initialContext"] as? [String: Any]) ?? [:],
-            liveUpdateConfig: (dict["liveUpdate"] as? [String: Any]).flatMap(LiveUpdate.init)
-        )
-    }
-}
-
-extension LiveUpdate {
-    init?(_ dict: [String: Any]) {
-        guard let appId = dict["appId"] as? String,
-              let channel = dict["channel"] as? String,
-              let syncOnAdd = dict["syncOnAdd"] as? Bool
-        else { return nil }
-        
-        self.init(appId: appId, channel: channel, syncOnAdd: syncOnAdd)
-    }
-}
-
-extension LiveUpdate {
-    var dict: [String: Any] {
-        return [
-            "appId": appId,
-            "channel": channel,
-            "syncOnAdd": syncOnAdd
-        ]
-    }
-}
-
-extension LiveUpdateManager.Error {
-    var dict: [String: Any] {
-        return [
-            "appId": appId,
-            "failStep": failStep.rawValue.uppercased(),
-            "message": localizedDescription
-        ]
-    }
-}
-
-private struct SyncResults {
-    var liveUpdates: [LiveUpdate]
-    var errors: [LiveUpdateManager.Error]
-}
-
-extension SyncResults {
-    var dict: [String: Any] {
-        return [
-            "liveUpdates": liveUpdates.map(\.dict),
-            "errors": errors.map(\.dict)
-        ]
-    }
-}
-
-@objc(IONLiveUpdatesManager)
-public class LiveUpdatesManager: NSObject {
-    private var lum = LiveUpdateManager.shared
-    
-    @objc func addLiveUpdate(_ dict: [String: Any]) {
-        guard let liveUpdate = LiveUpdate(dict) else { return }
-        try? lum.add(liveUpdate)
-    }
-    
-    @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):
-                rejector(nil, nil, error)
-            }
-        }
-    }
-    
-    @objc func syncSome(_ appIds: [String], resolver: @escaping RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
-        Task {
-            let syncResult = await lum.syncSome(appIds)
-            resolver(syncResult.dict)
-        }
-    }
-    
-    @objc func syncAll(_ resolver: @escaping RCTPromiseResolveBlock, rejector: RCTPromiseRejectBlock) {
-        Task {
-            let syncResult = await lum.syncAll()
-            resolver(syncResult.dict)
-        }
-    }
-
-    @objc static func requiresMainQueueSetup() -> Bool { true }
-}
-
-extension LiveUpdateManager {
-    fileprivate func syncSome(_ appIds: [String]) async -> SyncResults {
-        await _syncSome(appIds).syncResults
-    }
-    
-    private func _syncSome(_ appIds: [String]) -> AsyncStream<Result<LiveUpdate, LiveUpdateManager.Error>> {
-        AsyncStream { continuation in
-            sync(appIds: appIds, isParallel: true) {
-                continuation.finish()
-            } appComplete: { result in
-                continuation.yield(result)
-            }
-        }
-    }
-    
-    fileprivate func syncAll() async -> SyncResults {
-        await _syncAll().syncResults
-    }
-    
-    
-    private func _syncAll() -> AsyncStream<Result<LiveUpdate, LiveUpdateManager.Error>> {
-        AsyncStream { continuation in
-            sync(isParallel: true) {
-                continuation.finish()
-            } appComplete: { result in
-                continuation.yield(result)
-            }
-        }
-    }
-}
-
-extension AsyncStream where Element == Result<LiveUpdate, LiveUpdateManager.Error> {
-    fileprivate var syncResults: SyncResults {
-        get async {
-            await reduce(into: SyncResults(liveUpdates: [], errors: [])) { acc, next in
-                switch next {
-                case .success(let liveUpdate):
-                    acc.liveUpdates.append(liveUpdate)
-                case .failure(let error):
-                    acc.errors.append(error)
-                }
-            }
-        }
-    }
-}