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

package/lib/module/index.js

@@ -1,12 +1,23 @@
 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
+ *
+ * @param topic The topic to subscribe to
+ * @param onMessageReceived The callback to invoke when a message is received
+ * @returns A Promise<number> containing the unique subscription reference. This will need to be stored for calling {@link unsubscribe}.
+ */
+
 export const subscribe = async (topic, onMessageReceived) => {
   const subscriptionRef = await IONPortalPubSub.subscribe(topic);
   const subscriber = PortalsPubSub.addListener('PortalsSubscription', message => {
@@ -17,6 +28,13 @@ export const subscribe = async (topic, onMessageReceived) => {
   subscriptionMap.set(subscriptionRef, subscriber);
   return subscriptionRef;
 };
+/**
+ * Unsubscribes from events for the provided topic and subscription reference
+ *
+ * @param topic The topic to unsubscribe from
+ * @param subRef The unique subscription reference received when initially calling {@link subscribe}
+ */
+
 export const unsubscribe = (topic, subRef) => {
   IONPortalPubSub.unsubscribe(topic, subRef);
   const subscription = subscriptionMap.get(subRef);
@@ -26,25 +44,99 @@ export const unsubscribe = (topic, subRef) => {
     subscriptionMap.delete(subRef);
   }
 };
+/**
+ * Publishes a message to the provided topic
+ *
+ * @param topic The topic to publish the message to
+ * @param data The data to publish to subscribers
+ */
+
 export const publish = (topic, data) => {
   const msg = {
     message: data
   };
   IONPortalPubSub.publish(topic, msg);
 };
-export const register = key => {
-  IONPortalManager.register(key);
+/**
+ * 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 = async key => {
+  return IONPortalsReactNative.register(key);
 };
-export const addPortal = portal => {
-  IONPortalManager.addPortal(portal);
+/**
+ * The configuration of a web application to be embedded in a React Native application.
+ */
+
+/**
+ * Adds a Portal to an internal registry. Must be called before attempting to render a {@link PortalView}.
+ *
+ * @param portal The portal to add to the internal registry.
+ * @returns Promise containing the Portal that was added to the registry.
+ */
+export const addPortal = async portal => {
+  return IONPortalsReactNative.addPortal(portal);
 };
-export const syncOne = appId => {
-  return IONLiveUpdatesManager.syncOne(appId);
+/**
+ * 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);
 };
-export const syncSome = appIds => {
-  return IONLiveUpdatesManager.syncSome(appIds);
+/**
+ * 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);
 };
-export const syncAll = () => {
-  return IONLiveUpdatesManager.syncAll();
+
+/**
+ * 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 = async appId => {
+  return IONPortalsReactNative.syncOne(appId);
+};
+/**
+ * Syncs many live updates.
+ *
+ * @param appIds The AppFlow application IDs to sync.
+ * @returns Promise<SyncResults>
+ */
+
+export const syncSome = async appIds => {
+  return IONPortalsReactNative.syncSome(appIds);
+};
+/**
+ * Syncs all registered LiveUpdates
+ * @returns Promise<SyncResults>
+ */
+
+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\nexport interface Message {\n  subscriptionRef: number;\n  data: any;\n  topic: string;\n}\n\nconst PortalsPubSub = new NativeEventEmitter(IONPortalPubSub);\n\nconst subscriptionMap = new Map<number, EmitterSubscription>();\n\nexport const subscribe = async (\n  topic: string,\n  onMessageReceived: (message: Message) => void\n): Promise<number> => {\n  const subscriptionRef = await IONPortalPubSub.subscribe(topic);\n\n  const subscriber = PortalsPubSub.addListener(\n    'PortalsSubscription',\n    (message: Message) => {\n      if (message.subscriptionRef === subscriptionRef) {\n        onMessageReceived(message);\n      }\n    }\n  );\n\n  subscriptionMap.set(subscriptionRef, subscriber);\n\n  return subscriptionRef;\n};\n\nexport const unsubscribe = (topic: string, subRef: number) => {\n  IONPortalPubSub.unsubscribe(topic, subRef);\n\n  const subscription = subscriptionMap.get(subRef);\n  if (subscription !== undefined) {\n    subscription.remove();\n    subscriptionMap.delete(subRef);\n  }\n};\n\nexport const publish = (topic: string, data: any) => {\n  const msg = { message: data };\n  IONPortalPubSub.publish(topic, msg);\n};\n\nexport const register = (key: string) => {\n  IONPortalManager.register(key);\n};\n\nexport interface Portal {\n  name: string;\n  androidPlugins?: string[];\n  startDir?: string;\n  initialContext?: {\n    [key: string]: any;\n  };\n  liveUpdate?: LiveUpdateConfig;\n}\n\nexport type PortalProps = Pick<Portal, 'name' | 'initialContext'> & ViewProps;\n\nexport const addPortal = (portal: Portal) => {\n  IONPortalManager.addPortal(portal);\n};\n\nexport interface LiveUpdate {\n  appId: string;\n  channel: string;\n}\n\nexport type LiveUpdateConfig = LiveUpdate & { syncOnAdd: boolean };\n\nexport interface LiveUpdateError {\n  appId: string;\n  failStep: string;\n  message: string;\n}\n\nexport interface SyncResults {\n  liveUpdates: LiveUpdate[];\n  errors: LiveUpdateError[];\n}\n\nexport const syncOne = (appId: string): Promise<LiveUpdate> => {\n  return IONLiveUpdatesManager.syncOne(appId);\n};\n\nexport const syncSome = (appIds: string[]): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncSome(appIds);\n};\n\nexport const syncAll = (): Promise<SyncResults> => {\n  return IONLiveUpdatesManager.syncAll();\n};\n"],"mappings":"AAAA,SAEEA,kBAFF,EAGEC,aAHF,QAKO,cALP;AAOA,MAAM;EAAEC,eAAF;EAAmBC,gBAAnB;EAAqCC;AAArC,IACJH,aADF;AAGA,SAASI,OAAO,IAAIC,UAApB,QAAsC,cAAtC;AAQA,MAAMC,aAAa,GAAG,IAAIP,kBAAJ,CAAuBE,eAAvB,CAAtB;AAEA,MAAMM,eAAe,GAAG,IAAIC,GAAJ,EAAxB;AAEA,OAAO,MAAMC,SAAS,GAAG,OACvBC,KADuB,EAEvBC,iBAFuB,KAGH;EACpB,MAAMC,eAAe,GAAG,MAAMX,eAAe,CAACQ,SAAhB,CAA0BC,KAA1B,CAA9B;EAEA,MAAMG,UAAU,GAAGP,aAAa,CAACQ,WAAd,CACjB,qBADiB,EAEhBC,OAAD,IAAsB;IACpB,IAAIA,OAAO,CAACH,eAAR,KAA4BA,eAAhC,EAAiD;MAC/CD,iBAAiB,CAACI,OAAD,CAAjB;IACD;EACF,CANgB,CAAnB;EASAR,eAAe,CAACS,GAAhB,CAAoBJ,eAApB,EAAqCC,UAArC;EAEA,OAAOD,eAAP;AACD,CAlBM;AAoBP,OAAO,MAAMK,WAAW,GAAG,CAACP,KAAD,EAAgBQ,MAAhB,KAAmC;EAC5DjB,eAAe,CAACgB,WAAhB,CAA4BP,KAA5B,EAAmCQ,MAAnC;EAEA,MAAMC,YAAY,GAAGZ,eAAe,CAACa,GAAhB,CAAoBF,MAApB,CAArB;;EACA,IAAIC,YAAY,KAAKE,SAArB,EAAgC;IAC9BF,YAAY,CAACG,MAAb;IACAf,eAAe,CAACgB,MAAhB,CAAuBL,MAAvB;EACD;AACF,CARM;AAUP,OAAO,MAAMM,OAAO,GAAG,CAACd,KAAD,EAAgBe,IAAhB,KAA8B;EACnD,MAAMC,GAAG,GAAG;IAAEX,OAAO,EAAEU;EAAX,CAAZ;EACAxB,eAAe,CAACuB,OAAhB,CAAwBd,KAAxB,EAA+BgB,GAA/B;AACD,CAHM;AAKP,OAAO,MAAMC,QAAQ,GAAIC,GAAD,IAAiB;EACvC1B,gBAAgB,CAACyB,QAAjB,CAA0BC,GAA1B;AACD,CAFM;AAgBP,OAAO,MAAMC,SAAS,GAAIC,MAAD,IAAoB;EAC3C5B,gBAAgB,CAAC2B,SAAjB,CAA2BC,MAA3B;AACD,CAFM;AAsBP,OAAO,MAAMC,OAAO,GAAIC,KAAD,IAAwC;EAC7D,OAAO7B,qBAAqB,CAAC4B,OAAtB,CAA8BC,KAA9B,CAAP;AACD,CAFM;AAIP,OAAO,MAAMC,QAAQ,GAAIC,MAAD,IAA4C;EAClE,OAAO/B,qBAAqB,CAAC8B,QAAtB,CAA+BC,MAA/B,CAAP;AACD,CAFM;AAIP,OAAO,MAAMC,OAAO,GAAG,MAA4B;EACjD,OAAOhC,qBAAqB,CAACgC,OAAtB,EAAP;AACD,CAFM"}
+{"version":3,"names":["NativeEventEmitter","NativeModules","IONPortalPubSub","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

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

package/package.json

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