@ionic/portals-react-native 0.1.0 → 0.2.0

package/lib/commonjs/index.js

@@ -9,21 +9,17 @@ Object.defineProperty(exports, "PortalView", {
     return _PortalView.default;
   }
 });
-exports.unsubscribe = exports.syncSome = exports.syncOne = exports.syncAll = exports.subscribe = exports.register = exports.publish = exports.addPortal = void 0;
-
+exports.unsubscribe = exports.syncSome = exports.syncOne = exports.syncAll = exports.subscribe = exports.register = exports.publish = exports.getPortal = exports.enableSecureLiveUpdates = exports.addPortals = exports.addPortal = void 0;
 var _reactNative = require("react-native");
-
 var _PortalView = _interopRequireDefault(require("./PortalView"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const {
   IONPortalPubSub,
-  IONPortalManager,
-  IONLiveUpdatesManager
+  IONPortalsReactNative
 } = _reactNative.NativeModules;
 const PortalsPubSub = new _reactNative.NativeEventEmitter(IONPortalPubSub);
 const subscriptionMap = new Map();
+
 /**
  * Subscribes to messages for a topic
  *
@@ -31,7 +27,6 @@ const subscriptionMap = new Map();
  * @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);
   const subscriber = PortalsPubSub.addListener('PortalsSubscription', message => {
@@ -42,69 +37,94 @@ 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;
-
 const unsubscribe = (topic, subRef) => {
   IONPortalPubSub.unsubscribe(topic, subRef);
   const subscription = subscriptionMap.get(subRef);
-
   if (subscription !== undefined) {
     subscription.remove();
     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;
-
 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
+ * @returns Promise<void>
  */
-
-
 exports.publish = publish;
-
-const register = key => {
-  IONPortalManager.register(key);
+const register = async key => {
+  return IONPortalsReactNative.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.
+ * @returns Promise containing the Portal that was added to the registry.
  */
-const addPortal = portal => {
-  IONPortalManager.addPortal(portal);
+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.
+ */
 exports.addPortal = addPortal;
+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.
+ */
+exports.addPortals = addPortals;
+const getPortal = async name => {
+  return IONPortalsReactNative.getPortal(name);
+};
+exports.getPortal = getPortal;
+/**
+ * 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>
+ */
+const enableSecureLiveUpdates = async pathToKey => {
+  return IONPortalsReactNative.enableSecureLiveUpdates(pathToKey);
+};
 
 /**
  * Syncs a single live update.
@@ -112,33 +132,29 @@ exports.addPortal = addPortal;
  * @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);
+exports.enableSecureLiveUpdates = enableSecureLiveUpdates;
+const syncOne = async appId => {
+  return IONPortalsReactNative.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);
+const syncSome = async appIds => {
+  return IONPortalsReactNative.syncSome(appIds);
 };
+
 /**
  * Syncs all registered LiveUpdates
  * @returns Promise<SyncResults>
  */
-
-
 exports.syncSome = syncSome;
-
-const syncAll = () => {
-  return IONLiveUpdatesManager.syncAll();
+const syncAll = async () => {
+  return IONPortalsReactNative.syncAll();
 };
-
 exports.syncAll = syncAll;
 //# sourceMappingURL=index.js.map

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\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"}
+{"version":3,"names":["IONPortalPubSub","IONPortalsReactNative","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","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;AASA;AAAqD;AAFrD,MAAM;EAAEA,eAAe;EAAEC;AAAsB,CAAC,GAAGC,0BAAa;AAehE,MAAMC,aAAa,GAAG,IAAIC,+BAAkB,CAACJ,eAAe,CAAC;AAE7D,MAAMK,eAAe,GAAG,IAAIC,GAAG,EAA+B;;AAE9D;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,SAAS,GAAG,OACvBC,KAAa,EACbC,iBAA6C,KACzB;EACpB,MAAMC,eAAe,GAAG,MAAMV,eAAe,CAACO,SAAS,CAACC,KAAK,CAAC;EAE9D,MAAMG,UAAU,GAAGR,aAAa,CAACS,WAAW,CAC1C,qBAAqB,EACpBC,OAAgB,IAAK;IACpB,IAAIA,OAAO,CAACH,eAAe,KAAKA,eAAe,EAAE;MAC/CD,iBAAiB,CAACI,OAAO,CAAC;IAC5B;EACF,CAAC,CACF;EAEDR,eAAe,CAACS,GAAG,CAACJ,eAAe,EAAEC,UAAU,CAAC;EAEhD,OAAOD,eAAe;AACxB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMK,WAAW,GAAG,CAACP,KAAa,EAAEQ,MAAc,KAAK;EAC5DhB,eAAe,CAACe,WAAW,CAACP,KAAK,EAAEQ,MAAM,CAAC;EAE1C,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAG,CAACF,MAAM,CAAC;EAChD,IAAIC,YAAY,KAAKE,SAAS,EAAE;IAC9BF,YAAY,CAACG,MAAM,EAAE;IACrBf,eAAe,CAACgB,MAAM,CAACL,MAAM,CAAC;EAChC;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMM,OAAO,GAAG,CAACd,KAAa,EAAEe,IAAS,KAAK;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAK,CAAC;EAC7BvB,eAAe,CAACsB,OAAO,CAACd,KAAK,EAAEgB,GAAG,CAAC;AACrC,CAAC;;AAED;AACA;AACA;AACA;AACA;AAJA;AAKO,MAAMC,QAAQ,GAAG,MAAOC,GAAW,IAAoB;EAC5D,OAAOzB,qBAAqB,CAACwB,QAAQ,CAACC,GAAG,CAAC;AAC5C,CAAC;;AAED;AACA;AACA;AAFA;AAmCA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,SAAS,GAAG,MAAOC,MAAc,IAAsB;EAClE,OAAO3B,qBAAqB,CAAC0B,SAAS,CAACC,MAAM,CAAC;AAChD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMC,UAAU,GAAG,MAAOC,OAAiB,IAAwB;EACxE,OAAO7B,qBAAqB,CAAC4B,UAAU,CAACC,OAAO,CAAC;AAClD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMC,SAAS,GAAG,MAAOC,IAAY,IAAsB;EAChE,OAAO/B,qBAAqB,CAAC8B,SAAS,CAACC,IAAI,CAAC;AAC9C,CAAC;AAAC;AA2BF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,uBAAuB,GAAG,MACrCC,SAAiB,IACC;EAClB,OAAOjC,qBAAqB,CAACgC,uBAAuB,CAACC,SAAS,CAAC;AACjE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMC,OAAO,GAAG,MAAOC,KAAa,IAA0B;EACnE,OAAOnC,qBAAqB,CAACkC,OAAO,CAACC,KAAK,CAAC;AAC7C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AALA;AAMO,MAAMC,QAAQ,GAAG,MAAOC,MAAgB,IAA2B;EACxE,OAAOrC,qBAAqB,CAACoC,QAAQ,CAACC,MAAM,CAAC;AAC/C,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAIO,MAAMC,OAAO,GAAG,YAAkC;EACvD,OAAOtC,qBAAqB,CAACsC,OAAO,EAAE;AACxC,CAAC;AAAC"}

package/lib/module/PortalView.android.js

@@ -1,13 +1,11 @@
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
 import React, { useEffect, useRef } from 'react';
 import { findNodeHandle, requireNativeComponent, UIManager } from 'react-native';
 const PortalViewManager = requireNativeComponent('AndroidPortalView');
-
-const createFragment = viewId => UIManager.dispatchViewManagerCommand(viewId, // we are calling the 'create' command
+const createFragment = viewId => UIManager.dispatchViewManagerCommand(viewId,
+// we are calling the 'create' command
 // @ts-expect-error
 UIManager.AndroidPortalView.Commands.create.toString(), [viewId]);
-
 const PortalView = props => {
   const ref = useRef(null);
   useEffect(() => {
@@ -18,6 +16,5 @@ const PortalView = props => {
     ref: ref
   }));
 };
-
 export default PortalView;
 //# sourceMappingURL=PortalView.android.js.map

package/lib/module/PortalView.android.js.map

@@ -1 +1 @@
-{"version":3,"names":["React","useEffect","useRef","findNodeHandle","requireNativeComponent","UIManager","PortalViewManager","createFragment","viewId","dispatchViewManagerCommand","AndroidPortalView","Commands","create","toString","PortalView","props","ref","current"],"sources":["PortalView.android.tsx"],"sourcesContent":["import React, { useEffect, useRef } from 'react';\nimport {\n  findNodeHandle,\n  requireNativeComponent,\n  UIManager,\n} from 'react-native';\nimport type { PortalProps } from '.';\n\nconst PortalViewManager = requireNativeComponent('AndroidPortalView');\n\nconst createFragment = (viewId: number | null) =>\n  UIManager.dispatchViewManagerCommand(\n    viewId,\n    // we are calling the 'create' command\n    // @ts-expect-error\n    UIManager.AndroidPortalView.Commands.create.toString(),\n    [viewId]\n  );\n\nconst PortalView = (props: PortalProps) => {\n  const ref = useRef(null);\n\n  useEffect(() => {\n    const viewId = findNodeHandle(ref.current);\n    createFragment(viewId);\n  }, []);\n\n  return <PortalViewManager {...props} ref={ref} />;\n};\n\nexport default PortalView;\n"],"mappings":";;AAAA,OAAOA,KAAP,IAAgBC,SAAhB,EAA2BC,MAA3B,QAAyC,OAAzC;AACA,SACEC,cADF,EAEEC,sBAFF,EAGEC,SAHF,QAIO,cAJP;AAOA,MAAMC,iBAAiB,GAAGF,sBAAsB,CAAC,mBAAD,CAAhD;;AAEA,MAAMG,cAAc,GAAIC,MAAD,IACrBH,SAAS,CAACI,0BAAV,CACED,MADF,EAEE;AACA;AACAH,SAAS,CAACK,iBAAV,CAA4BC,QAA5B,CAAqCC,MAArC,CAA4CC,QAA5C,EAJF,EAKE,CAACL,MAAD,CALF,CADF;;AASA,MAAMM,UAAU,GAAIC,KAAD,IAAwB;EACzC,MAAMC,GAAG,GAAGd,MAAM,CAAC,IAAD,CAAlB;EAEAD,SAAS,CAAC,MAAM;IACd,MAAMO,MAAM,GAAGL,cAAc,CAACa,GAAG,CAACC,OAAL,CAA7B;IACAV,cAAc,CAACC,MAAD,CAAd;EACD,CAHQ,EAGN,EAHM,CAAT;EAKA,oBAAO,oBAAC,iBAAD,eAAuBO,KAAvB;IAA8B,GAAG,EAAEC;EAAnC,GAAP;AACD,CATD;;AAWA,eAAeF,UAAf"}
+{"version":3,"names":["React","useEffect","useRef","findNodeHandle","requireNativeComponent","UIManager","PortalViewManager","createFragment","viewId","dispatchViewManagerCommand","AndroidPortalView","Commands","create","toString","PortalView","props","ref","current"],"sources":["PortalView.android.tsx"],"sourcesContent":["import React, { useEffect, useRef } from 'react';\nimport {\n  findNodeHandle,\n  requireNativeComponent,\n  UIManager,\n} from 'react-native';\nimport type { PortalProps } from '.';\n\nconst PortalViewManager = requireNativeComponent('AndroidPortalView');\n\nconst createFragment = (viewId: number | null) =>\n  UIManager.dispatchViewManagerCommand(\n    viewId,\n    // we are calling the 'create' command\n    // @ts-expect-error\n    UIManager.AndroidPortalView.Commands.create.toString(),\n    [viewId]\n  );\n\nconst PortalView = (props: PortalProps) => {\n  const ref = useRef(null);\n\n  useEffect(() => {\n    const viewId = findNodeHandle(ref.current);\n    createFragment(viewId);\n  }, []);\n\n  return <PortalViewManager {...props} ref={ref} />;\n};\n\nexport default PortalView;\n"],"mappings":";AAAA,OAAOA,KAAK,IAAIC,SAAS,EAAEC,MAAM,QAAQ,OAAO;AAChD,SACEC,cAAc,EACdC,sBAAsB,EACtBC,SAAS,QACJ,cAAc;AAGrB,MAAMC,iBAAiB,GAAGF,sBAAsB,CAAC,mBAAmB,CAAC;AAErE,MAAMG,cAAc,GAAIC,MAAqB,IAC3CH,SAAS,CAACI,0BAA0B,CAClCD,MAAM;AACN;AACA;AACAH,SAAS,CAACK,iBAAiB,CAACC,QAAQ,CAACC,MAAM,CAACC,QAAQ,EAAE,EACtD,CAACL,MAAM,CAAC,CACT;AAEH,MAAMM,UAAU,GAAIC,KAAkB,IAAK;EACzC,MAAMC,GAAG,GAAGd,MAAM,CAAC,IAAI,CAAC;EAExBD,SAAS,CAAC,MAAM;IACd,MAAMO,MAAM,GAAGL,cAAc,CAACa,GAAG,CAACC,OAAO,CAAC;IAC1CV,cAAc,CAACC,MAAM,CAAC;EACxB,CAAC,EAAE,EAAE,CAAC;EAEN,oBAAO,oBAAC,iBAAiB,eAAKO,KAAK;IAAE,GAAG,EAAEC;EAAI,GAAG;AACnD,CAAC;AAED,eAAeF,UAAU"}

package/lib/module/PortalView.js

@@ -1,10 +1,8 @@
 import React from 'react';
 import { requireNativeComponent } from 'react-native';
 const HostComponentPortal = requireNativeComponent('IONPortalView');
-
 const PortalView = props => {
   return /*#__PURE__*/React.createElement(HostComponentPortal, props);
 };
-
 export default PortalView;
 //# sourceMappingURL=PortalView.js.map

package/lib/module/PortalView.js.map

@@ -1 +1 @@
-{"version":3,"names":["React","requireNativeComponent","HostComponentPortal","PortalView","props"],"sources":["PortalView.tsx"],"sourcesContent":["import React from 'react';\nimport { requireNativeComponent } from 'react-native';\nimport type { PortalProps } from '.';\n\nconst HostComponentPortal = requireNativeComponent('IONPortalView');\n\nconst PortalView = (props: PortalProps) => {\n  return <HostComponentPortal {...props} />;\n};\n\nexport default PortalView;\n"],"mappings":"AAAA,OAAOA,KAAP,MAAkB,OAAlB;AACA,SAASC,sBAAT,QAAuC,cAAvC;AAGA,MAAMC,mBAAmB,GAAGD,sBAAsB,CAAC,eAAD,CAAlD;;AAEA,MAAME,UAAU,GAAIC,KAAD,IAAwB;EACzC,oBAAO,oBAAC,mBAAD,EAAyBA,KAAzB,CAAP;AACD,CAFD;;AAIA,eAAeD,UAAf"}
+{"version":3,"names":["React","requireNativeComponent","HostComponentPortal","PortalView","props"],"sources":["PortalView.tsx"],"sourcesContent":["import React from 'react';\nimport { requireNativeComponent } from 'react-native';\nimport type { PortalProps } from '.';\n\nconst HostComponentPortal = requireNativeComponent('IONPortalView');\n\nconst PortalView = (props: PortalProps) => {\n  return <HostComponentPortal {...props} />;\n};\n\nexport default PortalView;\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,sBAAsB,QAAQ,cAAc;AAGrD,MAAMC,mBAAmB,GAAGD,sBAAsB,CAAC,eAAe,CAAC;AAEnE,MAAME,UAAU,GAAIC,KAAkB,IAAK;EACzC,oBAAO,oBAAC,mBAAmB,EAAKA,KAAK,CAAI;AAC3C,CAAC;AAED,eAAeD,UAAU"}

package/lib/module/index.js

@@ -1,16 +1,17 @@
 import { NativeEventEmitter, NativeModules } from 'react-native';
 const {
   IONPortalPubSub,
-  IONPortalManager,
-  IONLiveUpdatesManager
+  IONPortalsReactNative
 } = 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
  *
@@ -18,7 +19,6 @@ const subscriptionMap = new Map();
  * @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 => {
@@ -29,43 +29,44 @@ 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);
-
   if (subscription !== undefined) {
     subscription.remove();
     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
+ * @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,9 +75,41 @@ 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);
 };
 
 /**
@@ -85,25 +118,25 @@ export const addPortal = portal => {
  * @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.
  *
  * @param appIds The AppFlow application IDs to sync.
  * @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,kBAAkB,EAClBC,aAAa,QAER,cAAc;AAErB,MAAM;EAAEC,eAAe;EAAEC;AAAsB,CAAC,GAAGF,aAAa;AAEhE,SAASG,OAAO,IAAIC,UAAU,QAAQ,cAAc;;AAEpD;AACA;AACA;;AASA,MAAMC,aAAa,GAAG,IAAIN,kBAAkB,CAACE,eAAe,CAAC;AAE7D,MAAMK,eAAe,GAAG,IAAIC,GAAG,EAA+B;;AAE9D;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAG,OACvBC,KAAa,EACbC,iBAA6C,KACzB;EACpB,MAAMC,eAAe,GAAG,MAAMV,eAAe,CAACO,SAAS,CAACC,KAAK,CAAC;EAE9D,MAAMG,UAAU,GAAGP,aAAa,CAACQ,WAAW,CAC1C,qBAAqB,EACpBC,OAAgB,IAAK;IACpB,IAAIA,OAAO,CAACH,eAAe,KAAKA,eAAe,EAAE;MAC/CD,iBAAiB,CAACI,OAAO,CAAC;IAC5B;EACF,CAAC,CACF;EAEDR,eAAe,CAACS,GAAG,CAACJ,eAAe,EAAEC,UAAU,CAAC;EAEhD,OAAOD,eAAe;AACxB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMK,WAAW,GAAG,CAACP,KAAa,EAAEQ,MAAc,KAAK;EAC5DhB,eAAe,CAACe,WAAW,CAACP,KAAK,EAAEQ,MAAM,CAAC;EAE1C,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAG,CAACF,MAAM,CAAC;EAChD,IAAIC,YAAY,KAAKE,SAAS,EAAE;IAC9BF,YAAY,CAACG,MAAM,EAAE;IACrBf,eAAe,CAACgB,MAAM,CAACL,MAAM,CAAC;EAChC;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMM,OAAO,GAAG,CAACd,KAAa,EAAEe,IAAS,KAAK;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAK,CAAC;EAC7BvB,eAAe,CAACsB,OAAO,CAACd,KAAK,EAAEgB,GAAG,CAAC;AACrC,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,QAAQ,GAAG,MAAOC,GAAW,IAAoB;EAC5D,OAAOzB,qBAAqB,CAACwB,QAAQ,CAACC,GAAG,CAAC;AAC5C,CAAC;;AAED;AACA;AACA;;AAiCA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAG,MAAOC,MAAc,IAAsB;EAClE,OAAO3B,qBAAqB,CAAC0B,SAAS,CAACC,MAAM,CAAC;AAChD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,GAAG,MAAOC,OAAiB,IAAwB;EACxE,OAAO7B,qBAAqB,CAAC4B,UAAU,CAACC,OAAO,CAAC;AAClD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAG,MAAOC,IAAY,IAAsB;EAChE,OAAO/B,qBAAqB,CAAC8B,SAAS,CAACC,IAAI,CAAC;AAC9C,CAAC;AA2BD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,GAAG,MACrCC,SAAiB,IACC;EAClB,OAAOjC,qBAAqB,CAACgC,uBAAuB,CAACC,SAAS,CAAC;AACjE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,OAAO,GAAG,MAAOC,KAAa,IAA0B;EACnE,OAAOnC,qBAAqB,CAACkC,OAAO,CAACC,KAAK,CAAC;AAC7C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,QAAQ,GAAG,MAAOC,MAAgB,IAA2B;EACxE,OAAOrC,qBAAqB,CAACoC,QAAQ,CAACC,MAAM,CAAC;AAC/C,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMC,OAAO,GAAG,YAAkC;EACvD,OAAOtC,qBAAqB,CAACsC,OAAO,EAAE;AACxC,CAAC"}

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",
   "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": {