@ionic/portals-react-native 0.1.0 → 0.2.0-1

package/lib/module/index.js

@@ -1,8 +1,7 @@
 import { NativeEventEmitter, NativeModules } from 'react-native';
 const {
   IONPortalPubSub,
-  IONPortalManager,
-  IONLiveUpdatesManager
+  IONPortalsReactNative
 } = NativeModules;
 export { default as PortalView } from './PortalView';
 /**
@@ -61,10 +60,11 @@ export const publish = (topic, data) => {
 /**
  * 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 => {
-  IONPortalManager.register(key);
+export const register = async key => {
+  return IONPortalsReactNative.register(key);
 };
 /**
  * The configuration of a web application to be embedded in a React Native application.
@@ -74,19 +74,52 @@ export const register = key => {
  * 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 => {
-  IONPortalManager.addPortal(portal);
+export const addPortal = async 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 => {
+  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 => {
+  return IONPortalsReactNative.getPortal(name);
+};
+
+/**
+ * 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 => {
+  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 => {
-  return IONLiveUpdatesManager.syncOne(appId);
+
+export const syncOne = async appId => {
+  return IONPortalsReactNative.syncOne(appId);
 };
 /**
  * Syncs many live updates.
@@ -95,15 +128,15 @@ export const syncOne = appId => {
  * @returns Promise<SyncResults>
  */
 
-export const syncSome = appIds => {
-  return IONLiveUpdatesManager.syncSome(appIds);
+export const syncSome = async appIds => {
+  return IONPortalsReactNative.syncSome(appIds);
 };
 /**
  * Syncs all registered LiveUpdates
  * @returns Promise<SyncResults>
  */
 
-export const syncAll = () => {
-  return IONLiveUpdatesManager.syncAll();
+export const syncAll = async () => {
+  return IONPortalsReactNative.syncAll();
 };
 //# sourceMappingURL=index.js.map

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\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"}
+{"version":3,"names":["NativeEventEmitter","NativeModules","IONPortalPubSub","IONPortalsReactNative","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","addPortals","portals","getPortal","name","enableSecureLiveUpdates","pathToKey","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, IONPortalsReactNative } = 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 * @returns Promise<void>\n */\nexport const register = async (key: string): Promise<void> => {\n  return IONPortalsReactNative.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 * @returns Promise containing the Portal that was added to the registry.\n */\nexport const addPortal = async (portal: Portal): Promise<Portal> => {\n  return IONPortalsReactNative.addPortal(portal);\n};\n\n/**\n * Adds all portals to an internal registry. This or {@link addPortal} must be called before attempting to render a {@link PortalView}\n *\n * @param portals The portals to add to the internal registry.\n * @returns Promise containing the Portals that were added to the registry.\n */\nexport const addPortals = async (portals: Portal[]): Promise<Portal[]> => {\n  return IONPortalsReactNative.addPortals(portals);\n};\n\n/**\n * Gets a {@link Portal} previously registered via {@link addPortal} or {@link addPortals}.\n *\n * @param name The portal name to retrieve from the internal registry.\n * @returns Promise containing the registered {@link Portal}. If the {@link Portal} was not registered, the Promise will fail.\n */\nexport const getPortal = async (name: string): Promise<Portal> => {\n  return IONPortalsReactNative.getPortal(name);\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 * Configures LiveUpdates to cyrptographically verify the contents of the downloaded bundles.\n * This method must be called before any LiveUpdates are registered otherwise they will no longer be tracked.\n *\n * @param pathToKey The *relative* path to the public key for verification.\n * This path should be the same relatibe to the main application bundle on iOS and the assets directory on Android.\n * @returns Promise<void>\n */\nexport const enableSecureLiveUpdates = async (\n  pathToKey: string\n): Promise<void> => {\n  return IONPortalsReactNative.enableSecureLiveUpdates(pathToKey);\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 = async (appId: string): Promise<LiveUpdate> => {\n  return IONPortalsReactNative.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 = async (appIds: string[]): Promise<SyncResults> => {\n  return IONPortalsReactNative.syncSome(appIds);\n};\n\n/**\n * Syncs all registered LiveUpdates\n * @returns Promise<SyncResults>\n */\nexport const syncAll = async (): Promise<SyncResults> => {\n  return IONPortalsReactNative.syncAll();\n};\n"],"mappings":"AAAA,SAEEA,kBAFF,EAGEC,aAHF,QAKO,cALP;AAOA,MAAM;EAAEC,eAAF;EAAmBC;AAAnB,IAA6CF,aAAnD;AAEA,SAASG,OAAO,IAAIC,UAApB,QAAsC,cAAtC;AAEA;AACA;AACA;;AASA,MAAMC,aAAa,GAAG,IAAIN,kBAAJ,CAAuBE,eAAvB,CAAtB;AAEA,MAAMK,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,MAAMV,eAAe,CAACO,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;EAC5DhB,eAAe,CAACe,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;EACAvB,eAAe,CAACsB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;AAKP;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,QAAQ,GAAG,MAAOC,GAAP,IAAsC;EAC5D,OAAOzB,qBAAqB,CAACwB,QAAtB,CAA+BC,GAA/B,CAAP;AACD,CAFM;AAIP;AACA;AACA;;AAiCA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAG,MAAOC,MAAP,IAA2C;EAClE,OAAO3B,qBAAqB,CAAC0B,SAAtB,CAAgCC,MAAhC,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,UAAU,GAAG,MAAOC,OAAP,IAAgD;EACxE,OAAO7B,qBAAqB,CAAC4B,UAAtB,CAAiCC,OAAjC,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,SAAS,GAAG,MAAOC,IAAP,IAAyC;EAChE,OAAO/B,qBAAqB,CAAC8B,SAAtB,CAAgCC,IAAhC,CAAP;AACD,CAFM;;AA6BP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,GAAG,MACrCC,SADqC,IAEnB;EAClB,OAAOjC,qBAAqB,CAACgC,uBAAtB,CAA8CC,SAA9C,CAAP;AACD,CAJM;AAMP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,OAAO,GAAG,MAAOC,KAAP,IAA8C;EACnE,OAAOnC,qBAAqB,CAACkC,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMC,QAAQ,GAAG,MAAOC,MAAP,IAAkD;EACxE,OAAOrC,qBAAqB,CAACoC,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;AAIP;AACA;AACA;AACA;;AACA,OAAO,MAAMC,OAAO,GAAG,YAAkC;EACvD,OAAOtC,qBAAqB,CAACsC,OAAtB,EAAP;AACD,CAFM"}

package/lib/typescript/index.d.ts

@@ -35,8 +35,9 @@ 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
+ * @returns Promise<void>
  */
-export declare const register: (key: string) => void;
+export declare const register: (key: string) => Promise<void>;
 /**
  * The configuration of a web application to be embedded in a React Native application.
  */
@@ -73,8 +74,23 @@ 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.
+ * @returns Promise containing the Portal that was added to the registry.
  */
-export declare const addPortal: (portal: Portal) => void;
+export declare const addPortal: (portal: Portal) => Promise<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 declare const addPortals: (portals: Portal[]) => Promise<Portal[]>;
+/**
+ * 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 declare const getPortal: (name: string) => Promise<Portal>;
 export interface LiveUpdate {
     /** The AppFlow application ID */
     appId: string;
@@ -98,6 +114,15 @@ export interface SyncResults {
     liveUpdates: LiveUpdate[];
     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 declare const enableSecureLiveUpdates: (pathToKey: string) => Promise<void>;
 /**
  * Syncs a single live update.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/portals-react-native",
-  "version": "0.1.0",
+  "version": "0.2.0-1",
   "description": "Ionic Portals for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -29,6 +29,7 @@
     "typescript": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "lint:fix": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "docs": "typedoc --out ./docs/documentation ./src --tsconfig ./tsconfig.build.json",
     "prepare": "bob build",
     "release": "release-it",
     "example": "yarn --cwd example",
@@ -68,6 +69,7 @@
     "react": "16.13.1",
     "react-native": "0.63.4",
     "react-native-builder-bob": "^0.18.2",
+    "typedoc": "^0.23.16",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {

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)
-                }
-            }
-        }
-    }
-}