@ionic/portals-react-native 0.0.6 → 0.1.0

package/ReactNativePortals.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "IonicPortals", "~> 0.6.1"
+  s.dependency "IonicPortals", "~> 0.6.3"
 end

package/android/src/main/java/io/ionic/portals/reactnative/ReactNativePortalsModule.kt

@@ -11,6 +11,7 @@ import com.facebook.react.modules.core.DeviceEventManagerModule
 import com.facebook.react.uimanager.ThemedReactContext
 import com.facebook.react.uimanager.ViewGroupManager
 import com.facebook.react.uimanager.annotations.ReactProp
+import com.getcapacitor.CapConfig
 import com.getcapacitor.JSObject
 import com.getcapacitor.Plugin
 import io.ionic.liveupdates.LiveUpdate
@@ -19,16 +20,12 @@ import org.json.JSONArray
 import org.json.JSONException
 import org.json.JSONObject
 
-internal class PortalManagerModule(reactContext: ReactApplicationContext) :
-    ReactContextBaseJavaModule(reactContext) {
-    override fun getName() = "IONPortalManager"
-
-    @ReactMethod
-    fun register(key: String) {
-        PortalManager.register(key)
-    }
+internal object RNPortalManager {
+    private val manager = PortalManager
+    internal var indexMap: MutableMap<String, String> = mutableMapOf()
+    lateinit var reactApplicationContext: ReactApplicationContext
 
-    @ReactMethod
+    fun register(key: String) = manager.register(key)
     fun addPortal(map: ReadableMap) {
         val name = map.getString("name") ?: return
         val portalBuilder = PortalBuilder(name)
@@ -40,6 +37,9 @@ internal class PortalManagerModule(reactContext: ReactApplicationContext) :
             ?.toHashMap()
             ?.let(portalBuilder::setInitialContext)
 
+        map.getString("index")
+            ?.let { indexMap[name] = "/$it" }
+
         map.getArray("androidPlugins")
             ?.toArrayList()
             ?.mapNotNull { it as? String }
@@ -72,6 +72,25 @@ internal class PortalManagerModule(reactContext: ReactApplicationContext) :
     }
 }
 
+internal class PortalManagerModule(reactContext: ReactApplicationContext) :
+    ReactContextBaseJavaModule(reactContext) {
+    override fun getName() = "IONPortalManager"
+
+    init {
+        RNPortalManager.reactApplicationContext = reactContext
+    }
+
+    @ReactMethod
+    fun register(key: String) {
+        RNPortalManager.register(key)
+    }
+
+    @ReactMethod
+    fun addPortal(map: ReadableMap) {
+        RNPortalManager.addPortal(map)
+    }
+}
+
 internal class PortalsPubSubModule(reactContext: ReactApplicationContext) :
     ReactContextBaseJavaModule(reactContext) {
     override fun getName() = "IONPortalPubSub"
@@ -159,27 +178,15 @@ internal class PortalViewManager(private val context: ReactApplicationContext) :
     private val createId = 1
     private val fragmentMap = mutableMapOf<Int, PortalViewState>()
 
-    @ReactProp(name = "name")
-    fun setPortal(viewGroup: ViewGroup, portalName: String) {
-        when (val viewState = fragmentMap[viewGroup.id]) {
-            null -> fragmentMap[viewGroup.id] = PortalViewState(
-                fragment = null,
-                portal = PortalManager.getPortal(portalName),
-                initialContext = null
-            )
-            else -> viewState.portal = PortalManager.getPortal(portalName)
-        }
-    }
-
-    @ReactProp(name = "initialContext")
-    fun setInitialContext(viewGroup: ViewGroup, initialContext: ReadableMap) {
+    @ReactProp(name = "portal")
+    fun setPortal(viewGroup: ViewGroup, portal: ReadableMap) {
+        val name = portal.getString("name") ?: return
         when (val viewState = fragmentMap[viewGroup.id]) {
-            null -> fragmentMap[viewGroup.id] = PortalViewState(
-                fragment = null,
-                portal = null,
-                initialContext = initialContext.toHashMap()
-            )
-            else -> viewState.initialContext = initialContext.toHashMap()
+           null -> fragmentMap[viewGroup.id] = PortalViewState(
+               fragment = null,
+               portal = PortalManager.getPortal(name),
+               initialContext = portal.getMap("initialContext")?.toHashMap()
+           )
         }
     }
 
@@ -189,7 +196,7 @@ internal class PortalViewManager(private val context: ReactApplicationContext) :
         return FrameLayout(reactContext)
     }
 
-    override fun getCommandsMap(): MutableMap<String, Int>? {
+    override fun getCommandsMap(): MutableMap<String, Int> {
         return mutableMapOf("create" to createId)
     }
 
@@ -213,6 +220,15 @@ internal class PortalViewManager(private val context: ReactApplicationContext) :
         setupLayout(parentView)
 
         val portalFragment = PortalFragment(portal)
+
+        val configBuilder = CapConfig.Builder(context)
+            .setInitialFocus(false)
+
+        RNPortalManager.indexMap[portal.name]
+            ?.let(configBuilder::setStartPath)
+
+        portalFragment.setConfig(configBuilder.create())
+
         viewState.initialContext?.let(portalFragment::setInitialContext)
 
         viewState.fragment = portalFragment
@@ -241,7 +257,7 @@ internal class PortalViewManager(private val context: ReactApplicationContext) :
         fragmentMap.remove(view.id)
     }
 
-    private fun setupLayout(view: View) {
+    private fun setupLayout(view: ViewGroup) {
         Choreographer.getInstance().postFrameCallback(object : Choreographer.FrameCallback {
             override fun doFrame(frameTimeNanos: Long) {
                 layoutPortal(view)
@@ -251,12 +267,16 @@ internal class PortalViewManager(private val context: ReactApplicationContext) :
         })
     }
 
-    private fun layoutPortal(view: View) {
-        view.measure(
-            View.MeasureSpec.makeMeasureSpec(view.measuredWidth, View.MeasureSpec.EXACTLY),
-            View.MeasureSpec.makeMeasureSpec(view.measuredHeight, View.MeasureSpec.EXACTLY)
-        )
+    private fun layoutPortal(view: ViewGroup) {
+        for (i in 0 until view.childCount) {
+            val child = view.getChildAt(i)
+
+            child.measure(
+                View.MeasureSpec.makeMeasureSpec(view.measuredWidth, View.MeasureSpec.EXACTLY),
+                View.MeasureSpec.makeMeasureSpec(view.measuredHeight, View.MeasureSpec.EXACTLY)
+            )
 
-        view.layout(0, 0, view.measuredWidth, view.measuredHeight)
+            child.layout(0, 0, child.measuredWidth, child.measuredHeight)
+        }
     }
 }

package/ios/Podfile

@@ -9,6 +9,6 @@ target 'ReactNativePortals' do
   use_frameworks!
   use_react_native!(:path => config["reactNativePath"])
   # Pods for ReactNativePortals
-  pod 'IonicPortals', '~> 0.6.1'
+  pod 'IonicPortals', '~> 0.6.3'
 end
 

package/ios/Podfile.lock

@@ -1,8 +1,8 @@
 PODS:
   - boost-for-react-native (1.63.0)
-  - Capacitor (3.6.0):
+  - Capacitor (3.7.0):
     - CapacitorCordova
-  - CapacitorCordova (3.6.0)
+  - CapacitorCordova (3.7.0)
   - DoubleConversion (1.1.6)
   - FBLazyVector (0.63.4)
   - FBReactNativeSpec (0.63.4):
@@ -22,10 +22,10 @@ PODS:
     - DoubleConversion
     - glog
   - glog (0.3.5)
-  - IonicLiveUpdates (0.1.1)
-  - IonicPortals (0.6.1):
-    - Capacitor (~> 3.5)
-    - IonicLiveUpdates (~> 0.1.0)
+  - IonicLiveUpdates (0.1.3)
+  - IonicPortals (0.6.3):
+    - Capacitor (~> 3.7)
+    - IonicLiveUpdates (~> 0.1.2)
   - RCTRequired (0.63.4)
   - RCTTypeSafety (0.63.4):
     - FBLazyVector (= 0.63.4)
@@ -260,7 +260,7 @@ DEPENDENCIES:
   - FBReactNativeSpec (from `../node_modules/react-native/Libraries/FBReactNativeSpec`)
   - Folly (from `../node_modules/react-native/third-party-podspecs/Folly.podspec`)
   - glog (from `../node_modules/react-native/third-party-podspecs/glog.podspec`)
-  - IonicPortals (~> 0.6.1)
+  - IonicPortals (~> 0.6.3)
   - RCTRequired (from `../node_modules/react-native/Libraries/RCTRequired`)
   - RCTTypeSafety (from `../node_modules/react-native/Libraries/TypeSafety`)
   - React (from `../node_modules/react-native/`)
@@ -349,15 +349,15 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   boost-for-react-native: 39c7adb57c4e60d6c5479dd8623128eb5b3f0f2c
-  Capacitor: 28d6f7c3b02858b0696c98d27527ffb1ac8aba8f
-  CapacitorCordova: 23b4def1cd6a8c463074916376f511d7446d683e
+  Capacitor: 747a1e47077e8f82abf2209867c440d7366ad68c
+  CapacitorCordova: e6b42a8e8d5986c1eb8f02ac0be205fafc32ac33
   DoubleConversion: cde416483dac037923206447da6e1454df403714
   FBLazyVector: 3bb422f41b18121b71783a905c10e58606f7dc3e
   FBReactNativeSpec: f2c97f2529dd79c083355182cc158c9f98f4bd6e
   Folly: b73c3869541e86821df3c387eb0af5f65addfab4
   glog: 40a13f7840415b9a77023fbcae0f1e6f43192af3
-  IonicLiveUpdates: 5fb89c6faed266d083691e64f33710211edb3839
-  IonicPortals: 17b9ee9ae513fc3906b062bdd0b7492db94e38ce
+  IonicLiveUpdates: 91481e88b9a9a9bc02aecc589ed4bcfd658c4854
+  IonicPortals: 752f740cfaf84fafd45c0d9ab7b06c6b2a281993
   RCTRequired: 082f10cd3f905d6c124597fd1c14f6f2655ff65e
   RCTTypeSafety: 8c9c544ecbf20337d069e4ae7fd9a377aadf504b
   React: b0a957a2c44da4113b0c4c9853d8387f8e64e615
@@ -380,6 +380,6 @@ SPEC CHECKSUMS:
   ReactCommon: 73d79c7039f473b76db6ff7c6b159c478acbbb3b
   Yoga: 4bd86afe9883422a7c4028c00e34790f560923d6
 
-PODFILE CHECKSUM: 67d6b2cc79c25d2c4dcf32d6e3c6d6e6defffdb1
+PODFILE CHECKSUM: d6df5af67dbc83914b551c00dd0fbfac38c74589
 
 COCOAPODS: 1.11.2

package/ios/PortalView.m

@@ -9,6 +9,5 @@
 #import <React/RCTViewManager.h>
 
 @interface RCT_EXTERN_MODULE(IONPortalViewManager, RCTViewManager)
-RCT_EXPORT_VIEW_PROPERTY(name, NSString)
-RCT_EXPORT_VIEW_PROPERTY(initialContext, NSDictionary)
+RCT_EXPORT_VIEW_PROPERTY(portal, NSDictionary)
 @end

package/ios/ReactNativePortals.swift

@@ -74,36 +74,33 @@ class PortalViewManager: RCTViewManager {
 
 class PortalView: UIView {
     private var webView: PortalUIView?
-    private var _initialContext: [String: JSValue]?
     
-    @objc var name: String? {
+    @objc var portal: [String: Any]? {
         get {
             guard let _portal = _portal else { return nil }
-            return _portal.name
+            return [
+                "name": _portal.name,
+                "initialContext": _portal.initialContext
+            ]
         }
         
         set {
-            guard let portalName = newValue else { return }
-            _portal = PortalManager.getPortal(named: portalName)
-        }
-    }
-    
-    @objc var initialContext: [String: Any]? {
-        get { _initialContext }
-        set {
-            _initialContext = JSTypes.coerceDictionaryToJSObject(newValue)
-            // If the Portal is already present then we need to set the initialContext so it's the `didSet` property observer is fired
-            _portal?.initialContext = _initialContext ?? [:]
+            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 var portal = _portal else { return }
-            
-            if let initialContext = _initialContext {
-                portal.initialContext = initialContext
-            }
+            guard let portal = _portal else { return }
             
             DispatchQueue.main.async { [weak self] in
                 guard let self = self else { return }
@@ -129,6 +126,7 @@ extension Portal {
         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)
         )

package/lib/commonjs/index.js

@@ -24,6 +24,13 @@ const {
 } = _reactNative.NativeModules;
 const PortalsPubSub = new _reactNative.NativeEventEmitter(IONPortalPubSub);
 const subscriptionMap = new Map();
+/**
+ * Subscribes to messages for a topic
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
 
 const subscribe = async (topic, onMessageReceived) => {
   const subscriptionRef = await IONPortalPubSub.subscribe(topic);
@@ -35,6 +42,13 @@ const subscribe = async (topic, onMessageReceived) => {
   subscriptionMap.set(subscriptionRef, subscriber);
   return subscriptionRef;
 };
+/**
+ * Unsubscribes from events for the provided topic and subscription reference
+ *
+ * @param topic The topic to unsubscribe from
+ * @param subRef The unique subscription reference received when initially calling {@link subscribe}
+ */
+
 
 exports.subscribe = subscribe;
 
@@ -47,6 +61,13 @@ const unsubscribe = (topic, subRef) => {
     subscriptionMap.delete(subRef);
   }
 };
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
+
 
 exports.unsubscribe = unsubscribe;
 
@@ -56,30 +77,62 @@ const publish = (topic, data) => {
   };
   IONPortalPubSub.publish(topic, msg);
 };
+/**
+ * Validates that a valid registration key has been procured from http://ionic.io/register-portals
+ * @param key The registration key
+ */
+
 
 exports.publish = publish;
 
 const register = key => {
   IONPortalManager.register(key);
 };
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
+
 
 exports.register = register;
 
+/**
+ * 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.
+ */
 const addPortal = portal => {
   IONPortalManager.addPortal(portal);
 };
 
 exports.addPortal = addPortal;
 
+/**
+ * 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}.
+ */
 const syncOne = appId => {
   return IONLiveUpdatesManager.syncOne(appId);
 };
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
+
 
 exports.syncOne = syncOne;
 
 const syncSome = appIds => {
   return IONLiveUpdatesManager.syncSome(appIds);
 };
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
+
 
 exports.syncSome = syncSome;
 

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["IONPortalPubSub","IONPortalManager","IONLiveUpdatesManager","NativeModules","PortalsPubSub","NativeEventEmitter","subscriptionMap","Map","subscribe","topic","onMessageReceived","subscriptionRef","subscriber","addListener","message","set","unsubscribe","subRef","subscription","get","undefined","remove","delete","publish","data","msg","register","key","addPortal","portal","syncOne","appId","syncSome","appIds","syncAll"],"sources":["index.ts"],"sourcesContent":["import {\n  EmitterSubscription,\n  NativeEventEmitter,\n  NativeModules,\n  ViewProps,\n} from 'react-native';\n\nconst { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =\n  NativeModules;\n\nexport { default as PortalView } from './PortalView';\n\nexport interface Message {\n  subscriptionRef: number;\n  data: any;\n  topic: string;\n}\n\nconst PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);\n\nconst subscriptionMap = new Map<number, EmitterSubscription>();\n\nexport const subscribe = async (\n  topic: string,\n  onMessageReceived: (message: Message) => void\n): Promise<number> => {\n  const subscriptionRef = await IONPortalPubSub.subscribe(topic);\n\n  const subscriber = PortalsPubSub.addListener(\n    'PortalsSubscription',\n    (message: Message) => {\n      if (message.subscriptionRef === subscriptionRef) {\n        onMessageReceived(message);\n      }\n    }\n  );\n\n  subscriptionMap.set(subscriptionRef, subscriber);\n\n  return subscriptionRef;\n};\n\nexport const unsubscribe = (topic: string, subRef: number) => {\n  IONPortalPubSub.unsubscribe(topic, subRef);\n\n  const subscription = subscriptionMap.get(subRef);\n  if (subscription !== undefined) {\n    subscription.remove();\n    subscriptionMap.delete(subRef);\n  }\n};\n\nexport const publish = (topic: string, data: any) => {\n  const msg = { message: data };\n  IONPortalPubSub.publish(topic, msg);\n};\n\nexport const register = (key: string) => {\n  IONPortalManager.register(key);\n};\n\nexport interface Portal {\n  name: string;\n  androidPlugins?: string[];\n  startDir?: string;\n  initialContext?: {\n    [key: string]: any;\n  };\n  liveUpdate?: LiveUpdateConfig;\n}\n\nexport type PortalProps = Pick<Portal, 'name' | 'initialContext'> & ViewProps;\n\nexport const addPortal = (portal: Portal) => {\n  IONPortalManager.addPortal(portal);\n};\n\nexport interface LiveUpdate {\n  appId: string;\n  channel: string;\n}\n\nexport type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };\n\nexport interface LiveUpdateError {\n  appId: string;\n  failStep: string;\n  message: string;\n}\n\nexport interface SyncResults {\n  liveUpdates: LiveUpdate[];\n  errors: LiveUpdateError[];\n}\n\nexport const syncOne = (appId: string): Promise<LiveUpdate> => {\n  return IONLiveUpdatesManager.syncOne(appId);\n};\n\nexport const syncSome = (appIds: string[]): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncSome(appIds);\n};\n\nexport const syncAll = (): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncAll();\n};\n"],"mappings":";;;;;;;;;;;;;AAAA;;AAUA;;;;AAHA,MAAM;EAAEA,eAAF;EAAmBC,gBAAnB;EAAqCC;AAArC,IACJC,0BADF;AAWA,MAAMC,aAAa,GAAG,IAAIC,+BAAJ,CAAuBL,eAAvB,CAAtB;AAEA,MAAMM,eAAe,GAAG,IAAIC,GAAJ,EAAxB;;AAEO,MAAMC,SAAS,GAAG,OACvBC,KADuB,EAEvBC,iBAFuB,KAGH;EACpB,MAAMC,eAAe,GAAG,MAAMX,eAAe,CAACQ,SAAhB,CAA0BC,KAA1B,CAA9B;EAEA,MAAMG,UAAU,GAAGR,aAAa,CAACS,WAAd,CACjB,qBADiB,EAEhBC,OAAD,IAAsB;IACpB,IAAIA,OAAO,CAACH,eAAR,KAA4BA,eAAhC,EAAiD;MAC/CD,iBAAiB,CAACI,OAAD,CAAjB;IACD;EACF,CANgB,CAAnB;EASAR,eAAe,CAACS,GAAhB,CAAoBJ,eAApB,EAAqCC,UAArC;EAEA,OAAOD,eAAP;AACD,CAlBM;;;;AAoBA,MAAMK,WAAW,GAAG,CAACP,KAAD,EAAgBQ,MAAhB,KAAmC;EAC5DjB,eAAe,CAACgB,WAAhB,CAA4BP,KAA5B,EAAmCQ,MAAnC;EAEA,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAhB,CAAoBF,MAApB,CAArB;;EACA,IAAIC,YAAY,KAAKE,SAArB,EAAgC;IAC9BF,YAAY,CAACG,MAAb;IACAf,eAAe,CAACgB,MAAhB,CAAuBL,MAAvB;EACD;AACF,CARM;;;;AAUA,MAAMM,OAAO,GAAG,CAACd,KAAD,EAAgBe,IAAhB,KAA8B;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAX,CAAZ;EACAxB,eAAe,CAACuB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;;;;AAKA,MAAMC,QAAQ,GAAIC,GAAD,IAAiB;EACvC1B,gBAAgB,CAACyB,QAAjB,CAA0BC,GAA1B;AACD,CAFM;;;;AAgBA,MAAMC,SAAS,GAAIC,MAAD,IAAoB;EAC3C5B,gBAAgB,CAAC2B,SAAjB,CAA2BC,MAA3B;AACD,CAFM;;;;AAsBA,MAAMC,OAAO,GAAIC,KAAD,IAAwC;EAC7D,OAAO7B,qBAAqB,CAAC4B,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;;;;AAIA,MAAMC,QAAQ,GAAIC,MAAD,IAA4C;EAClE,OAAO/B,qBAAqB,CAAC8B,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;;;;AAIA,MAAMC,OAAO,GAAG,MAA4B;EACjD,OAAOhC,qBAAqB,CAACgC,OAAtB,EAAP;AACD,CAFM"}
+{"version":3,"names":["IONPortalPubSub","IONPortalManager","IONLiveUpdatesManager","NativeModules","PortalsPubSub","NativeEventEmitter","subscriptionMap","Map","subscribe","topic","onMessageReceived","subscriptionRef","subscriber","addListener","message","set","unsubscribe","subRef","subscription","get","undefined","remove","delete","publish","data","msg","register","key","addPortal","portal","syncOne","appId","syncSome","appIds","syncAll"],"sources":["index.ts"],"sourcesContent":["import {\n  EmitterSubscription,\n  NativeEventEmitter,\n  NativeModules,\n  ViewProps,\n} from 'react-native';\n\nconst { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =\n  NativeModules;\n\nexport { default as PortalView } from './PortalView';\n\n/**\n * The data that is received from a subscription event.\n */\nexport interface Message {\n  /** The unique subscription reference received from {@link subscribe}*/\n  subscriptionRef: number;\n  data: any;\n  /** The topic the message was sent from */\n  topic: string;\n}\n\nconst PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);\n\nconst subscriptionMap = new Map<number, EmitterSubscription>();\n\n/**\n * Subscribes to messages for a topic\n *\n * @param topic The topic to subscribe to\n * @param onMessageReceived The callback to invoke when a message is received\n * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.\n */\nexport const subscribe = async (\n  topic: string,\n  onMessageReceived: (message: Message) => void\n): Promise<number> => {\n  const subscriptionRef = await IONPortalPubSub.subscribe(topic);\n\n  const subscriber = PortalsPubSub.addListener(\n    'PortalsSubscription',\n    (message: Message) => {\n      if (message.subscriptionRef === subscriptionRef) {\n        onMessageReceived(message);\n      }\n    }\n  );\n\n  subscriptionMap.set(subscriptionRef, subscriber);\n\n  return subscriptionRef;\n};\n\n/**\n * Unsubscribes from events for the provided topic and subscription reference\n *\n * @param topic The topic to unsubscribe from\n * @param subRef The unique subscription reference received when initially calling {@link subscribe}\n */\nexport const unsubscribe = (topic: string, subRef: number) => {\n  IONPortalPubSub.unsubscribe(topic, subRef);\n\n  const subscription = subscriptionMap.get(subRef);\n  if (subscription !== undefined) {\n    subscription.remove();\n    subscriptionMap.delete(subRef);\n  }\n};\n\n/**\n * Publishes a message to the provided topic\n *\n * @param topic The topic to publish the message to\n * @param data The data to publish to subscribers\n */\nexport const publish = (topic: string, data: any) => {\n  const msg = { message: data };\n  IONPortalPubSub.publish(topic, msg);\n};\n\n/**\n * Validates that a valid registration key has been procured from http://ionic.io/register-portals\n * @param key The registration key\n */\nexport const register = (key: string) => {\n  IONPortalManager.register(key);\n};\n\n/**\n * The configuration of a web application to be embedded in a React Native application.\n */\nexport interface Portal {\n  /** The name of the Portal to be referenced. Must be **unique** */\n  name: string;\n  /** The classpath of all Capacitor plugins used in Android. (e.g. com.capacitorjs.plugins.camera.CameraPlugin) */\n  androidPlugins?: string[];\n  /**\n   * The root directory of the web application relative to Bundle.main on iOS\n   * and src/main/assets on Android. If omitted, `name` is used.\n   */\n  startDir?: string;\n  /** The name of the initial file to load. If omitted, 'index.html' is used. */\n  index?: string;\n  /** Any data needed at initial render when a portal is loaded. */\n  initialContext?: {\n    [key: string]: any;\n  };\n  liveUpdate?: LiveUpdateConfig;\n}\n\n/**\n * A subset of {@link Portal} properties needed for rendering a Portal. `initialContext` can be used to override\n * any initialContext defined in the original {@link Portal} definition.\n */\nexport type PortalProp = {\n  portal: Pick<Portal, 'name' | 'initialContext'>;\n};\n\n/**\n * Props needed for rendering a {@link Portal}\n */\nexport type PortalProps = PortalProp & ViewProps;\n\n/**\n * Adds a Portal to an internal registry. Must be called before attempting to render a {@link PortalView}.\n *\n * @param portal The portal to add to the internal registry.\n */\nexport const addPortal = (portal: Portal) => {\n  IONPortalManager.addPortal(portal);\n};\n\nexport interface LiveUpdate {\n  /** The AppFlow application ID */\n  appId: string;\n  /** The AppFlow distribution channel */\n  channel: string;\n}\n\n/** Data needed to register a live update to be managed */\nexport type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };\n\nexport interface LiveUpdateError {\n  /** The AppFlow application ID relating to the failure */\n  appId: string;\n  /** The step in the sync process the LiveUpdate failed on. (e.g. CHECK, UNPACK)*/\n  failStep: string;\n  /** A human readable error message */\n  message: string;\n}\n\n/** Used for communicating sync results of multiple live updates */\nexport interface SyncResults {\n  liveUpdates: LiveUpdate[];\n  errors: LiveUpdateError[];\n}\n\n/**\n * Syncs a single live update.\n *\n * @param appId The AppFlow application ID to sync.\n * @returns A Promise<LiveUpdate>. A failure should result in a {@link LiveUpdateError}.\n */\nexport const syncOne = (appId: string): Promise<LiveUpdate> => {\n  return IONLiveUpdatesManager.syncOne(appId);\n};\n\n/**\n * Syncs many live updates.\n *\n * @param appIds The AppFlow application IDs to sync.\n * @returns Promise<SyncResults>\n */\nexport const syncSome = (appIds: string[]): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncSome(appIds);\n};\n\n/**\n * Syncs all registered LiveUpdates\n * @returns Promise<SyncResults>\n */\nexport const syncAll = (): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncAll();\n};\n"],"mappings":";;;;;;;;;;;;;AAAA;;AAUA;;;;AAHA,MAAM;EAAEA,eAAF;EAAmBC,gBAAnB;EAAqCC;AAArC,IACJC,0BADF;AAgBA,MAAMC,aAAa,GAAG,IAAIC,+BAAJ,CAAuBL,eAAvB,CAAtB;AAEA,MAAMM,eAAe,GAAG,IAAIC,GAAJ,EAAxB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACO,MAAMC,SAAS,GAAG,OACvBC,KADuB,EAEvBC,iBAFuB,KAGH;EACpB,MAAMC,eAAe,GAAG,MAAMX,eAAe,CAACQ,SAAhB,CAA0BC,KAA1B,CAA9B;EAEA,MAAMG,UAAU,GAAGR,aAAa,CAACS,WAAd,CACjB,qBADiB,EAEhBC,OAAD,IAAsB;IACpB,IAAIA,OAAO,CAACH,eAAR,KAA4BA,eAAhC,EAAiD;MAC/CD,iBAAiB,CAACI,OAAD,CAAjB;IACD;EACF,CANgB,CAAnB;EASAR,eAAe,CAACS,GAAhB,CAAoBJ,eAApB,EAAqCC,UAArC;EAEA,OAAOD,eAAP;AACD,CAlBM;AAoBP;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMK,WAAW,GAAG,CAACP,KAAD,EAAgBQ,MAAhB,KAAmC;EAC5DjB,eAAe,CAACgB,WAAhB,CAA4BP,KAA5B,EAAmCQ,MAAnC;EAEA,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAhB,CAAoBF,MAApB,CAArB;;EACA,IAAIC,YAAY,KAAKE,SAArB,EAAgC;IAC9BF,YAAY,CAACG,MAAb;IACAf,eAAe,CAACgB,MAAhB,CAAuBL,MAAvB;EACD;AACF,CARM;AAUP;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMM,OAAO,GAAG,CAACd,KAAD,EAAgBe,IAAhB,KAA8B;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAX,CAAZ;EACAxB,eAAe,CAACuB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;AAKP;AACA;AACA;AACA;;;;;AACO,MAAMC,QAAQ,GAAIC,GAAD,IAAiB;EACvC1B,gBAAgB,CAACyB,QAAjB,CAA0BC,GAA1B;AACD,CAFM;AAIP;AACA;AACA;;;;;AAiCA;AACA;AACA;AACA;AACA;AACO,MAAMC,SAAS,GAAIC,MAAD,IAAoB;EAC3C5B,gBAAgB,CAAC2B,SAAjB,CAA2BC,MAA3B;AACD,CAFM;;;;AA6BP;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,OAAO,GAAIC,KAAD,IAAwC;EAC7D,OAAO7B,qBAAqB,CAAC4B,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;;;;;AACO,MAAMC,QAAQ,GAAIC,MAAD,IAA4C;EAClE,OAAO/B,qBAAqB,CAAC8B,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;;;;;AACO,MAAMC,OAAO,GAAG,MAA4B;EACjD,OAAOhC,qBAAqB,CAACgC,OAAtB,EAAP;AACD,CAFM"}

package/lib/module/index.js

@@ -5,8 +5,20 @@ const {
   IONLiveUpdatesManager
 } = NativeModules;
 export { default as PortalView } from './PortalView';
+/**
+ * The data that is received from a subscription event.
+ */
+
 const PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);
 const subscriptionMap = new Map();
+/**
+ * Subscribes to messages for a topic
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
+
 export const subscribe = async (topic, onMessageReceived) => {
   const subscriptionRef = await IONPortalPubSub.subscribe(topic);
   const subscriber = PortalsPubSub.addListener('PortalsSubscription', message => {
@@ -17,6 +29,13 @@ export const subscribe = async (topic, onMessageReceived) => {
   subscriptionMap.set(subscriptionRef, subscriber);
   return subscriptionRef;
 };
+/**
+ * Unsubscribes from events for the provided topic and subscription reference
+ *
+ * @param topic The topic to unsubscribe from
+ * @param subRef The unique subscription reference received when initially calling {@link subscribe}
+ */
+
 export const unsubscribe = (topic, subRef) => {
   IONPortalPubSub.unsubscribe(topic, subRef);
   const subscription = subscriptionMap.get(subRef);
@@ -26,24 +45,64 @@ export const unsubscribe = (topic, subRef) => {
     subscriptionMap.delete(subRef);
   }
 };
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
+
 export const publish = (topic, data) => {
   const msg = {
     message: data
   };
   IONPortalPubSub.publish(topic, msg);
 };
+/**
+ * Validates that a valid registration key has been procured from http://ionic.io/register-portals
+ * @param key The registration key
+ */
+
 export const register = key => {
   IONPortalManager.register(key);
 };
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
+
+/**
+ * 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.
+ */
 export const addPortal = portal => {
   IONPortalManager.addPortal(portal);
 };
+
+/**
+ * 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 => {
   return IONLiveUpdatesManager.syncOne(appId);
 };
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
+
 export const syncSome = appIds => {
   return IONLiveUpdatesManager.syncSome(appIds);
 };
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
+
 export const syncAll = () => {
   return IONLiveUpdatesManager.syncAll();
 };

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeEventEmitter","NativeModules","IONPortalPubSub","IONPortalManager","IONLiveUpdatesManager","default","PortalView","PortalsPubSub","subscriptionMap","Map","subscribe","topic","onMessageReceived","subscriptionRef","subscriber","addListener","message","set","unsubscribe","subRef","subscription","get","undefined","remove","delete","publish","data","msg","register","key","addPortal","portal","syncOne","appId","syncSome","appIds","syncAll"],"sources":["index.ts"],"sourcesContent":["import {\n  EmitterSubscription,\n  NativeEventEmitter,\n  NativeModules,\n  ViewProps,\n} from 'react-native';\n\nconst { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =\n  NativeModules;\n\nexport { default as PortalView } from './PortalView';\n\nexport interface Message {\n  subscriptionRef: number;\n  data: any;\n  topic: string;\n}\n\nconst PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);\n\nconst subscriptionMap = new Map<number, EmitterSubscription>();\n\nexport const subscribe = async (\n  topic: string,\n  onMessageReceived: (message: Message) => void\n): Promise<number> => {\n  const subscriptionRef = await IONPortalPubSub.subscribe(topic);\n\n  const subscriber = PortalsPubSub.addListener(\n    'PortalsSubscription',\n    (message: Message) => {\n      if (message.subscriptionRef === subscriptionRef) {\n        onMessageReceived(message);\n      }\n    }\n  );\n\n  subscriptionMap.set(subscriptionRef, subscriber);\n\n  return subscriptionRef;\n};\n\nexport const unsubscribe = (topic: string, subRef: number) => {\n  IONPortalPubSub.unsubscribe(topic, subRef);\n\n  const subscription = subscriptionMap.get(subRef);\n  if (subscription !== undefined) {\n    subscription.remove();\n    subscriptionMap.delete(subRef);\n  }\n};\n\nexport const publish = (topic: string, data: any) => {\n  const msg = { message: data };\n  IONPortalPubSub.publish(topic, msg);\n};\n\nexport const register = (key: string) => {\n  IONPortalManager.register(key);\n};\n\nexport interface Portal {\n  name: string;\n  androidPlugins?: string[];\n  startDir?: string;\n  initialContext?: {\n    [key: string]: any;\n  };\n  liveUpdate?: LiveUpdateConfig;\n}\n\nexport type PortalProps = Pick<Portal, 'name' | 'initialContext'> & ViewProps;\n\nexport const addPortal = (portal: Portal) => {\n  IONPortalManager.addPortal(portal);\n};\n\nexport interface LiveUpdate {\n  appId: string;\n  channel: string;\n}\n\nexport type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };\n\nexport interface LiveUpdateError {\n  appId: string;\n  failStep: string;\n  message: string;\n}\n\nexport interface SyncResults {\n  liveUpdates: LiveUpdate[];\n  errors: LiveUpdateError[];\n}\n\nexport const syncOne = (appId: string): Promise<LiveUpdate> => {\n  return IONLiveUpdatesManager.syncOne(appId);\n};\n\nexport const syncSome = (appIds: string[]): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncSome(appIds);\n};\n\nexport const syncAll = (): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncAll();\n};\n"],"mappings":"AAAA,SAEEA,kBAFF,EAGEC,aAHF,QAKO,cALP;AAOA,MAAM;EAAEC,eAAF;EAAmBC,gBAAnB;EAAqCC;AAArC,IACJH,aADF;AAGA,SAASI,OAAO,IAAIC,UAApB,QAAsC,cAAtC;AAQA,MAAMC,aAAa,GAAG,IAAIP,kBAAJ,CAAuBE,eAAvB,CAAtB;AAEA,MAAMM,eAAe,GAAG,IAAIC,GAAJ,EAAxB;AAEA,OAAO,MAAMC,SAAS,GAAG,OACvBC,KADuB,EAEvBC,iBAFuB,KAGH;EACpB,MAAMC,eAAe,GAAG,MAAMX,eAAe,CAACQ,SAAhB,CAA0BC,KAA1B,CAA9B;EAEA,MAAMG,UAAU,GAAGP,aAAa,CAACQ,WAAd,CACjB,qBADiB,EAEhBC,OAAD,IAAsB;IACpB,IAAIA,OAAO,CAACH,eAAR,KAA4BA,eAAhC,EAAiD;MAC/CD,iBAAiB,CAACI,OAAD,CAAjB;IACD;EACF,CANgB,CAAnB;EASAR,eAAe,CAACS,GAAhB,CAAoBJ,eAApB,EAAqCC,UAArC;EAEA,OAAOD,eAAP;AACD,CAlBM;AAoBP,OAAO,MAAMK,WAAW,GAAG,CAACP,KAAD,EAAgBQ,MAAhB,KAAmC;EAC5DjB,eAAe,CAACgB,WAAhB,CAA4BP,KAA5B,EAAmCQ,MAAnC;EAEA,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAhB,CAAoBF,MAApB,CAArB;;EACA,IAAIC,YAAY,KAAKE,SAArB,EAAgC;IAC9BF,YAAY,CAACG,MAAb;IACAf,eAAe,CAACgB,MAAhB,CAAuBL,MAAvB;EACD;AACF,CARM;AAUP,OAAO,MAAMM,OAAO,GAAG,CAACd,KAAD,EAAgBe,IAAhB,KAA8B;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAX,CAAZ;EACAxB,eAAe,CAACuB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;AAKP,OAAO,MAAMC,QAAQ,GAAIC,GAAD,IAAiB;EACvC1B,gBAAgB,CAACyB,QAAjB,CAA0BC,GAA1B;AACD,CAFM;AAgBP,OAAO,MAAMC,SAAS,GAAIC,MAAD,IAAoB;EAC3C5B,gBAAgB,CAAC2B,SAAjB,CAA2BC,MAA3B;AACD,CAFM;AAsBP,OAAO,MAAMC,OAAO,GAAIC,KAAD,IAAwC;EAC7D,OAAO7B,qBAAqB,CAAC4B,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;AAIP,OAAO,MAAMC,QAAQ,GAAIC,MAAD,IAA4C;EAClE,OAAO/B,qBAAqB,CAAC8B,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;AAIP,OAAO,MAAMC,OAAO,GAAG,MAA4B;EACjD,OAAOhC,qBAAqB,CAACgC,OAAtB,EAAP;AACD,CAFM"}
+{"version":3,"names":["NativeEventEmitter","NativeModules","IONPortalPubSub","IONPortalManager","IONLiveUpdatesManager","default","PortalView","PortalsPubSub","subscriptionMap","Map","subscribe","topic","onMessageReceived","subscriptionRef","subscriber","addListener","message","set","unsubscribe","subRef","subscription","get","undefined","remove","delete","publish","data","msg","register","key","addPortal","portal","syncOne","appId","syncSome","appIds","syncAll"],"sources":["index.ts"],"sourcesContent":["import {\n  EmitterSubscription,\n  NativeEventEmitter,\n  NativeModules,\n  ViewProps,\n} from 'react-native';\n\nconst { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =\n  NativeModules;\n\nexport { default as PortalView } from './PortalView';\n\n/**\n * The data that is received from a subscription event.\n */\nexport interface Message {\n  /** The unique subscription reference received from {@link subscribe}*/\n  subscriptionRef: number;\n  data: any;\n  /** The topic the message was sent from */\n  topic: string;\n}\n\nconst PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);\n\nconst subscriptionMap = new Map<number, EmitterSubscription>();\n\n/**\n * Subscribes to messages for a topic\n *\n * @param topic The topic to subscribe to\n * @param onMessageReceived The callback to invoke when a message is received\n * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.\n */\nexport const subscribe = async (\n  topic: string,\n  onMessageReceived: (message: Message) => void\n): Promise<number> => {\n  const subscriptionRef = await IONPortalPubSub.subscribe(topic);\n\n  const subscriber = PortalsPubSub.addListener(\n    'PortalsSubscription',\n    (message: Message) => {\n      if (message.subscriptionRef === subscriptionRef) {\n        onMessageReceived(message);\n      }\n    }\n  );\n\n  subscriptionMap.set(subscriptionRef, subscriber);\n\n  return subscriptionRef;\n};\n\n/**\n * Unsubscribes from events for the provided topic and subscription reference\n *\n * @param topic The topic to unsubscribe from\n * @param subRef The unique subscription reference received when initially calling {@link subscribe}\n */\nexport const unsubscribe = (topic: string, subRef: number) => {\n  IONPortalPubSub.unsubscribe(topic, subRef);\n\n  const subscription = subscriptionMap.get(subRef);\n  if (subscription !== undefined) {\n    subscription.remove();\n    subscriptionMap.delete(subRef);\n  }\n};\n\n/**\n * Publishes a message to the provided topic\n *\n * @param topic The topic to publish the message to\n * @param data The data to publish to subscribers\n */\nexport const publish = (topic: string, data: any) => {\n  const msg = { message: data };\n  IONPortalPubSub.publish(topic, msg);\n};\n\n/**\n * Validates that a valid registration key has been procured from http://ionic.io/register-portals\n * @param key The registration key\n */\nexport const register = (key: string) => {\n  IONPortalManager.register(key);\n};\n\n/**\n * The configuration of a web application to be embedded in a React Native application.\n */\nexport interface Portal {\n  /** The name of the Portal to be referenced. Must be **unique** */\n  name: string;\n  /** The classpath of all Capacitor plugins used in Android. (e.g. com.capacitorjs.plugins.camera.CameraPlugin) */\n  androidPlugins?: string[];\n  /**\n   * The root directory of the web application relative to Bundle.main on iOS\n   * and src/main/assets on Android. If omitted, `name` is used.\n   */\n  startDir?: string;\n  /** The name of the initial file to load. If omitted, 'index.html' is used. */\n  index?: string;\n  /** Any data needed at initial render when a portal is loaded. */\n  initialContext?: {\n    [key: string]: any;\n  };\n  liveUpdate?: LiveUpdateConfig;\n}\n\n/**\n * A subset of {@link Portal} properties needed for rendering a Portal. `initialContext` can be used to override\n * any initialContext defined in the original {@link Portal} definition.\n */\nexport type PortalProp = {\n  portal: Pick<Portal, 'name' | 'initialContext'>;\n};\n\n/**\n * Props needed for rendering a {@link Portal}\n */\nexport type PortalProps = PortalProp & ViewProps;\n\n/**\n * Adds a Portal to an internal registry. Must be called before attempting to render a {@link PortalView}.\n *\n * @param portal The portal to add to the internal registry.\n */\nexport const addPortal = (portal: Portal) => {\n  IONPortalManager.addPortal(portal);\n};\n\nexport interface LiveUpdate {\n  /** The AppFlow application ID */\n  appId: string;\n  /** The AppFlow distribution channel */\n  channel: string;\n}\n\n/** Data needed to register a live update to be managed */\nexport type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };\n\nexport interface LiveUpdateError {\n  /** The AppFlow application ID relating to the failure */\n  appId: string;\n  /** The step in the sync process the LiveUpdate failed on. (e.g. CHECK, UNPACK)*/\n  failStep: string;\n  /** A human readable error message */\n  message: string;\n}\n\n/** Used for communicating sync results of multiple live updates */\nexport interface SyncResults {\n  liveUpdates: LiveUpdate[];\n  errors: LiveUpdateError[];\n}\n\n/**\n * Syncs a single live update.\n *\n * @param appId The AppFlow application ID to sync.\n * @returns A Promise<LiveUpdate>. A failure should result in a {@link LiveUpdateError}.\n */\nexport const syncOne = (appId: string): Promise<LiveUpdate> => {\n  return IONLiveUpdatesManager.syncOne(appId);\n};\n\n/**\n * Syncs many live updates.\n *\n * @param appIds The AppFlow application IDs to sync.\n * @returns Promise<SyncResults>\n */\nexport const syncSome = (appIds: string[]): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncSome(appIds);\n};\n\n/**\n * Syncs all registered LiveUpdates\n * @returns Promise<SyncResults>\n */\nexport const syncAll = (): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncAll();\n};\n"],"mappings":"AAAA,SAEEA,kBAFF,EAGEC,aAHF,QAKO,cALP;AAOA,MAAM;EAAEC,eAAF;EAAmBC,gBAAnB;EAAqCC;AAArC,IACJH,aADF;AAGA,SAASI,OAAO,IAAIC,UAApB,QAAsC,cAAtC;AAEA;AACA;AACA;;AASA,MAAMC,aAAa,GAAG,IAAIP,kBAAJ,CAAuBE,eAAvB,CAAtB;AAEA,MAAMM,eAAe,GAAG,IAAIC,GAAJ,EAAxB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,SAAS,GAAG,OACvBC,KADuB,EAEvBC,iBAFuB,KAGH;EACpB,MAAMC,eAAe,GAAG,MAAMX,eAAe,CAACQ,SAAhB,CAA0BC,KAA1B,CAA9B;EAEA,MAAMG,UAAU,GAAGP,aAAa,CAACQ,WAAd,CACjB,qBADiB,EAEhBC,OAAD,IAAsB;IACpB,IAAIA,OAAO,CAACH,eAAR,KAA4BA,eAAhC,EAAiD;MAC/CD,iBAAiB,CAACI,OAAD,CAAjB;IACD;EACF,CANgB,CAAnB;EASAR,eAAe,CAACS,GAAhB,CAAoBJ,eAApB,EAAqCC,UAArC;EAEA,OAAOD,eAAP;AACD,CAlBM;AAoBP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMK,WAAW,GAAG,CAACP,KAAD,EAAgBQ,MAAhB,KAAmC;EAC5DjB,eAAe,CAACgB,WAAhB,CAA4BP,KAA5B,EAAmCQ,MAAnC;EAEA,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAhB,CAAoBF,MAApB,CAArB;;EACA,IAAIC,YAAY,KAAKE,SAArB,EAAgC;IAC9BF,YAAY,CAACG,MAAb;IACAf,eAAe,CAACgB,MAAhB,CAAuBL,MAAvB;EACD;AACF,CARM;AAUP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMM,OAAO,GAAG,CAACd,KAAD,EAAgBe,IAAhB,KAA8B;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAX,CAAZ;EACAxB,eAAe,CAACuB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;AAKP;AACA;AACA;AACA;;AACA,OAAO,MAAMC,QAAQ,GAAIC,GAAD,IAAiB;EACvC1B,gBAAgB,CAACyB,QAAjB,CAA0BC,GAA1B;AACD,CAFM;AAIP;AACA;AACA;;AAiCA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAIC,MAAD,IAAoB;EAC3C5B,gBAAgB,CAAC2B,SAAjB,CAA2BC,MAA3B;AACD,CAFM;;AA6BP;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,OAAO,GAAIC,KAAD,IAAwC;EAC7D,OAAO7B,qBAAqB,CAAC4B,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,QAAQ,GAAIC,MAAD,IAA4C;EAClE,OAAO/B,qBAAqB,CAAC8B,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;;AACA,OAAO,MAAMC,OAAO,GAAG,MAA4B;EACjD,OAAOhC,qBAAqB,CAACgC,OAAtB,EAAP;AACD,CAFM"}

package/lib/typescript/index.d.ts

@@ -1,41 +1,119 @@
 import { ViewProps } from 'react-native';
 export { default as PortalView } from './PortalView';
+/**
+ * The data that is received from a subscription event.
+ */
 export interface Message {
+    /** The unique subscription reference received from {@link subscribe}*/
     subscriptionRef: number;
     data: any;
+    /** The topic the message was sent from */
     topic: string;
 }
+/**
+ * Subscribes to messages for a topic
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
 export declare const subscribe: (topic: string, onMessageReceived: (message: Message) => void) => Promise<number>;
+/**
+ * Unsubscribes from events for the provided topic and subscription reference
+ *
+ * @param topic The topic to unsubscribe from
+ * @param subRef The unique subscription reference received when initially calling {@link subscribe}
+ */
 export declare const unsubscribe: (topic: string, subRef: number) => void;
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
 export declare const publish: (topic: string, data: any) => void;
+/**
+ * Validates that a valid registration key has been procured from http://ionic.io/register-portals
+ * @param key The registration key
+ */
 export declare const register: (key: string) => void;
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
 export interface Portal {
+    /** The name of the Portal to be referenced. Must be **unique** */
     name: string;
+    /** The classpath of all Capacitor plugins used in Android. (e.g. com.capacitorjs.plugins.camera.CameraPlugin) */
     androidPlugins?: string[];
+    /**
+     * The root directory of the web application relative to Bundle.main on iOS
+     * and src/main/assets on Android. If omitted, `name` is used.
+     */
     startDir?: string;
+    /** The name of the initial file to load. If omitted, 'index.html' is used. */
+    index?: string;
+    /** Any data needed at initial render when a portal is loaded. */
     initialContext?: {
         [key: string]: any;
     };
     liveUpdate?: LiveUpdateConfig;
 }
-export declare type PortalProps = Pick<Portal, 'name' | 'initialContext'> & ViewProps;
+/**
+ * A subset of {@link Portal} properties needed for rendering a Portal. `initialContext` can be used to override
+ * any initialContext defined in the original {@link Portal} definition.
+ */
+export declare type PortalProp = {
+    portal: Pick<Portal, 'name' | 'initialContext'>;
+};
+/**
+ * Props needed for rendering a {@link Portal}
+ */
+export declare 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.
+ */
 export declare const addPortal: (portal: Portal) => void;
 export interface LiveUpdate {
+    /** The AppFlow application ID */
     appId: string;
+    /** The AppFlow distribution channel */
     channel: string;
 }
+/** Data needed to register a live update to be managed */
 export declare type LiveUpdateConfig = LiveUpdate & {
     syncOnAdd: boolean;
 };
 export interface LiveUpdateError {
+    /** The AppFlow application ID relating to the failure */
     appId: string;
+    /** The step in the sync process the LiveUpdate failed on. (e.g. CHECK, UNPACK)*/
     failStep: string;
+    /** A human readable error message */
     message: string;
 }
+/** Used for communicating sync results of multiple live updates */
 export interface SyncResults {
     liveUpdates: LiveUpdate[];
     errors: LiveUpdateError[];
 }
+/**
+ * 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 declare const syncOne: (appId: string) => Promise<LiveUpdate>;
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
 export declare const syncSome: (appIds: string[]) => Promise<SyncResults>;
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
 export declare const syncAll: () => Promise<SyncResults>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/portals-react-native",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "Ionic Portals for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.ts

@@ -10,9 +10,14 @@ const { IONPortalPubSub, IONPortalManager, IONLiveUpdatesManager } =
 
 export { default as PortalView } from './PortalView';
 
+/**
+ * The data that is received from a subscription event.
+ */
 export interface Message {
+  /** The unique subscription reference received from {@link subscribe}*/
   subscriptionRef: number;
   data: any;
+  /** The topic the message was sent from */
   topic: string;
 }
 
@@ -20,6 +25,13 @@ const PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);
 
 const subscriptionMap = new Map<number, EmitterSubscription>();
 
+/**
+ * Subscribes to messages for a topic
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
 export const subscribe = async (
   topic: string,
   onMessageReceived: (message: Message) => void
@@ -40,6 +52,12 @@ export const subscribe = async (
   return subscriptionRef;
 };
 
+/**
+ * Unsubscribes from events for the provided topic and subscription reference
+ *
+ * @param topic The topic to unsubscribe from
+ * @param subRef The unique subscription reference received when initially calling {@link subscribe}
+ */
 export const unsubscribe = (topic: string, subRef: number) => {
   IONPortalPubSub.unsubscribe(topic, subRef);
 
@@ -50,57 +68,118 @@ export const unsubscribe = (topic: string, subRef: number) => {
   }
 };
 
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
 export const publish = (topic: string, data: any) => {
   const msg = { message: data };
   IONPortalPubSub.publish(topic, msg);
 };
 
+/**
+ * Validates that a valid registration key has been procured from http://ionic.io/register-portals
+ * @param key The registration key
+ */
 export const register = (key: string) => {
   IONPortalManager.register(key);
 };
 
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
 export interface Portal {
+  /** The name of the Portal to be referenced. Must be **unique** */
   name: string;
+  /** The classpath of all Capacitor plugins used in Android. (e.g. com.capacitorjs.plugins.camera.CameraPlugin) */
   androidPlugins?: string[];
+  /**
+   * The root directory of the web application relative to Bundle.main on iOS
+   * and src/main/assets on Android. If omitted, `name` is used.
+   */
   startDir?: string;
+  /** The name of the initial file to load. If omitted, 'index.html' is used. */
+  index?: string;
+  /** Any data needed at initial render when a portal is loaded. */
   initialContext?: {
     [key: string]: any;
   };
   liveUpdate?: LiveUpdateConfig;
 }
 
-export type PortalProps = Pick<Portal, 'name' | 'initialContext'> & ViewProps;
+/**
+ * A subset of {@link Portal} properties needed for rendering a Portal. `initialContext` can be used to override
+ * any initialContext defined in the original {@link Portal} definition.
+ */
+export type PortalProp = {
+  portal: Pick<Portal, 'name' | 'initialContext'>;
+};
+
+/**
+ * Props needed for rendering a {@link Portal}
+ */
+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.
+ */
 export const addPortal = (portal: Portal) => {
   IONPortalManager.addPortal(portal);
 };
 
 export interface LiveUpdate {
+  /** The AppFlow application ID */
   appId: string;
+  /** The AppFlow distribution channel */
   channel: string;
 }
 
+/** Data needed to register a live update to be managed */
 export type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };
 
 export interface LiveUpdateError {
+  /** The AppFlow application ID relating to the failure */
   appId: string;
+  /** The step in the sync process the LiveUpdate failed on. (e.g. CHECK, UNPACK)*/
   failStep: string;
+  /** A human readable error message */
   message: string;
 }
 
+/** Used for communicating sync results of multiple live updates */
 export interface SyncResults {
   liveUpdates: LiveUpdate[];
   errors: LiveUpdateError[];
 }
 
+/**
+ * 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);
 };
 
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
 export const syncSome = (appIds: string[]): Promise<SyncResults> => {
   return IONLiveUpdatesManager.syncSome(appIds);
 };
 
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
 export const syncAll = (): Promise<SyncResults> => {
   return IONLiveUpdatesManager.syncAll();
 };