vibes-react-native 1.0.0 → 1.1.0

package/android/src/main/java/com/vibes/push/rn/plugin/notifications/VibesPushReceiver.java

@@ -16,8 +16,8 @@ import com.vibes.vibes.VibesReceiver;
 
 import static com.vibes.push.rn.plugin.VibesModule.TAG;
 
-public class VibesPushReceiver extends VibesReceiver{
-  
+public class VibesPushReceiver extends VibesReceiver {
+
   @Override
   protected void onPushOpened(Context context, PushPayloadParser pushModel) {
     super.onPushOpened(context, pushModel);
@@ -25,16 +25,18 @@ public class VibesPushReceiver extends VibesReceiver{
     emitPayload(context, pushModel);
   }
 
-  private void emitPayload(Context context, PushPayloadParser pushModel) {
-    final VibesPushReceiver serviceRef = this;
-    // We need to run this on the main thread, as the React code assumes that is true.
-    // Namely, DevServerHelper constructs a Handler() without a Looper, which triggers:
+  public static void emitPayload(Context context, PushPayloadParser pushModel) {
+    // We need to run this on the main thread, as the React code assumes that is
+    // true.
+    // Namely, DevServerHelper constructs a Handler() without a Looper, which
+    // triggers:
     // "Can't create handler inside thread that has not called Looper.prepare()"
     Handler handler = new Handler(Looper.getMainLooper());
     handler.post(new Runnable() {
       public void run() {
         // Construct and load our normal React JS code bundle
-        final ReactInstanceManager mReactInstanceManager = ((ReactApplication) context.getApplicationContext()).getReactNativeHost().getReactInstanceManager();
+        final ReactInstanceManager mReactInstanceManager = ((ReactApplication) context.getApplicationContext())
+            .getReactNativeHost().getReactInstanceManager();
         ReactContext context = mReactInstanceManager.getCurrentReactContext();
         // If it's constructed, send a notification
         if (context != null) {

package/ios/Vibes.m

@@ -27,5 +27,30 @@ RCT_EXTERN_METHOD(updateDevice: (BOOL ) updateCredentials
                                     resolver:(RCTPromiseResolveBlock *)resolve
                                     rejecter:(RCTPromiseRejectBlock *)reject)
 
+RCT_EXTERN_METHOD(getPerson: (RCTPromiseResolveBlock *)resolve
+                                    rejecter:(RCTPromiseRejectBlock *)reject)
+
+
+RCT_EXTERN_METHOD(fetchInboxMessages: (RCTPromiseResolveBlock *)resolve
+                                        rejecter:(RCTPromiseRejectBlock *)reject)
+
+RCT_EXTERN_METHOD(fetchInboxMessage: (NSString *) messageUID
+                                    resolve:(RCTPromiseResolveBlock *)resolve
+                                    reject:(RCTPromiseRejectBlock *)reject)
+
+RCT_EXTERN_METHOD(markInboxMessageAsRead: (NSString *) messageUID
+                                    resolve:(RCTPromiseResolveBlock *)resolve
+                                    reject:(RCTPromiseRejectBlock *)reject)
+
+RCT_EXTERN_METHOD(expireInboxMessage: (NSString *) messageUID
+                                    resolve:(RCTPromiseResolveBlock *)resolve
+                                    reject:(RCTPromiseRejectBlock *)reject)
+
+RCT_EXTERN_METHOD(onInboxMessageOpen: (NSDictionary *) message
+                                    resolve:(RCTPromiseResolveBlock *)resolve
+                                    reject:(RCTPromiseRejectBlock *)reject)
+
+RCT_EXTERN_METHOD(onInboxMessagesFetched: (RCTPromiseResolveBlock *)resolve
+                                    reject:(RCTPromiseRejectBlock *)reject)
 @end
 

package/ios/Vibes.swift

@@ -7,6 +7,8 @@ class Vibes: NSObject, RCTBridgeModule, VibesPush.VibesAPIDelegate {
     static func moduleName() -> String! {
         return "Vibes"
     }
+    
+    public typealias JSONDictionary = [String: Any]
 
     let userDefaults = UserDefaults.standard
 
@@ -136,7 +138,7 @@ class Vibes: NSObject, RCTBridgeModule, VibesPush.VibesAPIDelegate {
     @objc
     /// Get Vibes Device Info
     /// - Parameters:
-    ///   - resolve: promose resolver
+    ///   - resolve: promise resolver
     ///   - reject: promise rejector
     func getVibesDeviceInfo(_ resolve: @escaping RCTPromiseResolveBlock,
                             rejecter reject: @escaping RCTPromiseRejectBlock) {
@@ -148,7 +150,147 @@ class Vibes: NSObject, RCTBridgeModule, VibesPush.VibesAPIDelegate {
             resolve(["device_id": deviceId])
         }
     }
+    
+    @objc
+    /// Get Person Info
+    /// - Parameters:
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func getPerson(_ resolve: @escaping RCTPromiseResolveBlock,
+                       rejecter reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        vibes.getPerson { person, error in
+            if let error = error {
+                reject("GET_PERSON_ERROR", error.localizedDescription, error)
+            } else {
+                resolve(["external_person_id": person?.externalPersonId, "person_key": person?.personKey])
+            }
+        }
+    }
+    
+    @objc
+    /// Fetch Inbox Messages
+    ///
+    /// - Parameters:
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func fetchInboxMessages(_ resolve: @escaping RCTPromiseResolveBlock,
+                       rejecter reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        vibes.fetchInboxMessages({ messages, error in
+            if let error = error {
+                reject("FETCH_INBOX_MESSAGES_ERROR", error.localizedDescription, error)
+            } else {
+                var msgs: [JSONDictionary] = []
+                for msg in messages {
+                    msgs.append(msg.encodeJSON())
+                }
+                resolve(msgs)
+            }
+        })
+    }
 
+    @objc
+    /// Fetch single Inbox Message
+    ///
+    /// - Parameters:
+    ///   - messageUid: The Message ID
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func fetchInboxMessage(_ messageUid: String,
+                           resolve: @escaping RCTPromiseResolveBlock,
+                           reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        vibes.fetchInboxMessage(messageUID: messageUid) {message, error in
+
+            if let error = error {
+                reject("FETCH_INBOX_MESSAGE_ERROR", error.localizedDescription, error)
+            } else {
+                if let message = message {
+                    resolve(message.encodeJSON())
+                } else {
+                    reject("FETCH_INBOX_MESSAGE_ERROR", "message encoding faild", "message encoding faild" as? Error)
+                }
+            }
+        }
+    }
+    
+    @objc
+    /// Mark Inbox Message as Read
+    ///
+    /// - Parameters:
+    ///   - messageUid: The Message ID
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func markInboxMessageAsRead(_ messageUid: String,
+                           resolve: @escaping RCTPromiseResolveBlock,
+                           reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        vibes.markInboxMessageAsRead(messageUID: messageUid) {message, error in
+
+            if let error = error {
+                reject("MARK_INBOX_MESSAGE_AS_READ_ERROR", error.localizedDescription, error)
+            } else {
+                if let message = message {
+                    resolve(message.encodeJSON())
+                } else {
+                    reject("MARK_INBOX_MESSAGE_AS_READ_ERROR", "message encoding faild", "message encoding faild" as? Error)
+                }
+            }
+        }
+    }
+    
+    @objc
+    /// Expire Inbox Message
+    ///
+    /// - Parameters:
+    ///   - messageUid: The Message ID
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func expireInboxMessage(_ messageUid: String,
+                           resolve: @escaping RCTPromiseResolveBlock,
+                           reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        vibes.expireInboxMessage(messageUID: messageUid) {message, error in
+
+            if let error = error {
+                reject("EXPIRE_INBOX_MESSAGE_ERROR", error.localizedDescription, error)
+            } else {
+                if let message = message {
+                    resolve(message.encodeJSON())
+                } else {
+                    reject("EXPIRE_INBOX_MESSAGE_ERROR", "message encoding faild", "message encoding faild" as? Error)
+                }
+            }
+        }
+    }
+
+    @objc
+    ///  Inbox Message Opened
+    ///
+    /// - Parameters:
+    ///   - message: The Inbox Message
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func onInboxMessageOpen(_ message: VibesJSONDictionary,
+                           resolve: @escaping RCTPromiseResolveBlock,
+                           reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        guard let inboxMessage = InboxMessage(attributes: message) else {
+            reject("INBOX_MESSAGE_OPEN_ERROR", "Could not create Inbox Message from payload", nil)
+            return
+        }
+        vibes.onInboxMessageOpen(inboxMessage: inboxMessage)
+        resolve("success")
+    }
+    
+    @objc
+    ///  Inbox Messages Fetched
+    ///
+    /// - Parameters:
+    ///   - resolve: promise resolver
+    ///   - reject: promise rejector
+    func onInboxMessagesFetched(_ resolve: @escaping RCTPromiseResolveBlock,
+                           reject: @escaping RCTPromiseRejectBlock ) -> Void {
+        
+        vibes.onInboxMessagesFetched()
+        resolve("Success recording an inbox_fetch event")
+    }
+    
     func didRegisterDevice(deviceId: String?, error: Error?) {
         if let error = error {
             if let registerDeviceRejecter = registerDeviceRejecter {

package/lib/commonjs/index.js

@@ -5,14 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.associatePerson = associatePerson;
 exports.default = void 0;
+exports.expireInboxMessage = expireInboxMessage;
+exports.fetchInboxMessage = fetchInboxMessage;
+exports.fetchInboxMessages = fetchInboxMessages;
+exports.getPerson = getPerson;
 exports.getVibesDeviceInfo = getVibesDeviceInfo;
+exports.markInboxMessageAsRead = markInboxMessageAsRead;
+exports.onInboxMessageOpen = onInboxMessageOpen;
+exports.onInboxMessagesFetched = onInboxMessagesFetched;
 exports.registerDevice = registerDevice;
 exports.registerPush = registerPush;
 exports.unregisterDevice = unregisterDevice;
+exports.unregisterPush = unregisterPush;
 exports.updateDevice = updateDevice;
-
 var _reactNative = require("react-native");
-
 const LINKING_ERROR = `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \n\n` + _reactNative.Platform.select({
   ios: "- You have run 'pod install'\n",
   default: ''
@@ -21,33 +27,138 @@ const Vibes = _reactNative.NativeModules.Vibes ? _reactNative.NativeModules.Vibe
   get() {
     throw new Error(LINKING_ERROR);
   }
-
 });
-
+/**
+ * Register this device with the Vibes platform
+ *
+ * @return {Promise<DeviceResponse>}
+ */
 function registerDevice() {
   return Vibes.registerDevice();
 }
-
+/**
+ * Unregister this device with the Vibes platform
+ *
+ * @return {Promise<void>}
+ */
 function unregisterDevice() {
   return Vibes.unregisterDevice();
 }
 
+/**
+ * Register this device to receive push notifications
+ *
+ * @return {Promise<void>}
+ */
 function registerPush() {
   return Vibes.registerPush();
 }
 
+/**
+* Unregister the device from receiving push notifications
+*
+* @return {Promise<void>}
+*/
+function unregisterPush() {
+  return Vibes.registerPush();
+}
+
+/**
+ * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
+ *
+ * @return {Promise<DeviceInfoResponse>}
+ */
 function getVibesDeviceInfo() {
   return Vibes.getVibesDeviceInfo();
 }
 
+/**
+ * Updates the Vibes platform with changes to the device since the last time device information was submitted.
+ *
+ * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.
+ * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @returns {Promise<void>}
+ */
 function updateDevice(updateCredential, latitude, longitude) {
   return Vibes.updateDevice(updateCredential, latitude, longitude);
 }
 
+/**
+ * Associate an external ID with the current person.
+ *
+ * @param {string} externalPersonId
+ * @return {Promise<void>}
+ */
 function associatePerson(externalPersonId) {
   return Vibes.associatePerson(externalPersonId);
 }
 
+/**
+ * Fetches the PersonResponse associated with this device currently
+ *
+ * @return {Promise<PersonResponse>}
+ */
+function getPerson() {
+  return Vibes.getPerson();
+}
+/**
+ * Fetches an array of inbox messages for the person associated with this device.
+ *
+ * @return {Promise<InboxMessage[]>}
+ */
+function fetchInboxMessages() {
+  return Vibes.fetchInboxMessages();
+}
+
+/**
+ * Fetches a single inbox message by it's id.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>}
+ */
+function fetchInboxMessage(message_uid) {
+  return Vibes.fetchInboxMessage(message_uid);
+}
+
+/**
+ * Marks an inbox message as read.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
+ */
+function markInboxMessageAsRead(message_uid) {
+  return Vibes.markInboxMessageAsRead(message_uid);
+}
+
+/**
+ * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
+ */
+function expireInboxMessage(message_uid) {
+  return Vibes.expireInboxMessage(message_uid);
+}
+
+/**
+ * Records an event for when the user opens an inbox message.
+ *
+ * @param inboxMap json map of the InboxMessage
+ * @return {Promise<void>}
+ */
+function onInboxMessageOpen(inboxMap) {
+  return Vibes.onInboxMessageOpen(inboxMap);
+}
+
+/**
+ * Records an event for when the user fetches a list of inbox messages.
+ *
+ * @return {Promise<void>}
+ */
+function onInboxMessagesFetched() {
+  return Vibes.onInboxMessagesFetched();
+}
 var _default = Vibes;
 exports.default = _default;
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["LINKING_ERROR","Platform","select","ios","default","Vibes","NativeModules","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\nexport function registerDevice(): Promise<any> {\n  return Vibes.registerDevice();\n}\n\nexport function unregisterDevice(): Promise<any> {\n  return Vibes.unregisterDevice();\n}\n\nexport function registerPush(): Promise<any> {\n  return Vibes.registerPush();\n}\n\nexport function getVibesDeviceInfo(): Promise<any> {\n  return Vibes.getVibesDeviceInfo();\n}\n\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<any> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\nexport function associatePerson(externalPersonId: string): Promise<any> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\nexport default Vibes;\n"],"mappings":";;;;;;;;;;;;;AAAA;;AAEA,MAAMA,aAAa,GAChB,6EAAD,GACAC,qBAAA,CAASC,MAAT,CAAgB;EAAEC,GAAG,EAAE,gCAAP;EAAyCC,OAAO,EAAE;AAAlD,CAAhB,CADA,GAEA,sDAFA,GAGA,6CAJF;AAMA,MAAMC,KAAK,GAAGC,0BAAA,CAAcD,KAAd,GACVC,0BAAA,CAAcD,KADJ,GAEV,IAAIE,KAAJ,CACE,EADF,EAEE;EACEC,GAAG,GAAG;IACJ,MAAM,IAAIC,KAAJ,CAAUT,aAAV,CAAN;EACD;;AAHH,CAFF,CAFJ;;AAWO,SAASU,cAAT,GAAwC;EAC7C,OAAOL,KAAK,CAACK,cAAN,EAAP;AACD;;AAEM,SAASC,gBAAT,GAA0C;EAC/C,OAAON,KAAK,CAACM,gBAAN,EAAP;AACD;;AAEM,SAASC,YAAT,GAAsC;EAC3C,OAAOP,KAAK,CAACO,YAAN,EAAP;AACD;;AAEM,SAASC,kBAAT,GAA4C;EACjD,OAAOR,KAAK,CAACQ,kBAAN,EAAP;AACD;;AAEM,SAASC,YAAT,CACLC,gBADK,EAELC,QAFK,EAGLC,SAHK,EAIS;EACd,OAAOZ,KAAK,CAACS,YAAN,CAAmBC,gBAAnB,EAAqCC,QAArC,EAA+CC,SAA/C,CAAP;AACD;;AAEM,SAASC,eAAT,CAAyBC,gBAAzB,EAAiE;EACtE,OAAOd,KAAK,CAACa,eAAN,CAAsBC,gBAAtB,CAAP;AACD;;eAEcd,K"}
+{"version":3,"names":["LINKING_ERROR","Platform","select","ios","default","Vibes","NativeModules","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","unregisterPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId","getPerson","fetchInboxMessages","fetchInboxMessage","message_uid","markInboxMessageAsRead","expireInboxMessage","onInboxMessageOpen","inboxMap","onInboxMessagesFetched"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n    {},\n    {\n      get() {\n        throw new Error(LINKING_ERROR);\n      },\n    }\n  );\n\nexport interface DeviceResponse {\n  device_id?: string;\n}\nexport interface DeviceInfoResponse extends DeviceResponse {\n  push_token?: string;\n}\n\nexport interface PersonResponse {\n  person_key?: string;\n  external_person_id?: string;\n}\n\nexport interface InboxMessage {\n  content?: string;\n  created_at?: string;\n  expires_at?: string;\n  message_uid?: string;\n  read?: boolean;\n  subject?: string;\n  detail?: string;\n  collapse_key?: string;\n  apprefdata?: any;\n  images?: any;\n  inbox_custom_data: any;\n}\n\n/**\n * Register this device with the Vibes platform\n *\n * @return {Promise<DeviceResponse>}\n */\nexport function registerDevice(): Promise<DeviceResponse> {\n  return Vibes.registerDevice();\n}\n/**\n * Unregister this device with the Vibes platform\n *\n * @return {Promise<void>}\n */\nexport function unregisterDevice(): Promise<void> {\n  return Vibes.unregisterDevice();\n}\n\n/**\n * Register this device to receive push notifications\n *\n * @return {Promise<void>}\n */\nexport function registerPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n* Unregister the device from receiving push notifications\n*\n* @return {Promise<void>}\n*/\nexport function unregisterPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token\n *\n * @return {Promise<DeviceInfoResponse>}\n */\nexport function getVibesDeviceInfo(): Promise<DeviceInfoResponse> {\n  return Vibes.getVibesDeviceInfo();\n}\n\n/**\n * Updates the Vibes platform with changes to the device since the last time device information was submitted.\n *\n * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.\n * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @returns {Promise<void>}\n */\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<void> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\n/**\n * Associate an external ID with the current person.\n *\n * @param {string} externalPersonId\n * @return {Promise<void>}\n */\nexport function associatePerson(externalPersonId: string): Promise<void> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\n/**\n * Fetches the PersonResponse associated with this device currently\n *\n * @return {Promise<PersonResponse>}\n */\nexport function getPerson(): Promise<PersonResponse> {\n  return Vibes.getPerson();\n}\n/**\n * Fetches an array of inbox messages for the person associated with this device.\n *\n * @return {Promise<InboxMessage[]>}\n */\nexport function fetchInboxMessages(): Promise<InboxMessage[]> {\n  return Vibes.fetchInboxMessages();\n}\n\n/**\n * Fetches a single inbox message by it's id.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>}\n */\nexport function fetchInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.fetchInboxMessage(message_uid);\n}\n\n/**\n * Marks an inbox message as read.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated\n */\nexport function markInboxMessageAsRead(message_uid: string): Promise<InboxMessage> {\n  return Vibes.markInboxMessageAsRead(message_uid);\n}\n\n/**\n * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated\n */\nexport function expireInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.expireInboxMessage(message_uid);\n}\n\n/**\n * Records an event for when the user opens an inbox message.\n *\n * @param inboxMap json map of the InboxMessage\n * @return {Promise<void>}\n */\nexport function onInboxMessageOpen(inboxMap: InboxMessage): Promise<void> {\n  return Vibes.onInboxMessageOpen(inboxMap);\n}\n\n/**\n * Records an event for when the user fetches a list of inbox messages.\n *\n * @return {Promise<void>}\n */\nexport function onInboxMessagesFetched(): Promise<void> {\n  return Vibes.onInboxMessagesFetched();\n}\n\nexport default Vibes;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAEA,MAAMA,aAAa,GAChB,6EAA4E,GAC7EC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,6CAA6C;AAE/C,MAAMC,KAAK,GAAGC,0BAAa,CAACD,KAAK,GAC7BC,0BAAa,CAACD,KAAK,GACnB,IAAIE,KAAK,CACT,CAAC,CAAC,EACF;EACEC,GAAG,GAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CAAC,CACF;AA4BH;AACA;AACA;AACA;AACA;AACO,SAASU,cAAc,GAA4B;EACxD,OAAOL,KAAK,CAACK,cAAc,EAAE;AAC/B;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,gBAAgB,GAAkB;EAChD,OAAON,KAAK,CAACM,gBAAgB,EAAE;AACjC;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAY,GAAkB;EAC5C,OAAOP,KAAK,CAACO,YAAY,EAAE;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,cAAc,GAAkB;EAC9C,OAAOR,KAAK,CAACO,YAAY,EAAE;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASE,kBAAkB,GAAgC;EAChE,OAAOT,KAAK,CAACS,kBAAkB,EAAE;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAY,CAC1BC,gBAAyB,EACzBC,QAAgB,EAChBC,SAAiB,EACF;EACf,OAAOb,KAAK,CAACU,YAAY,CAACC,gBAAgB,EAAEC,QAAQ,EAAEC,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAe,CAACC,gBAAwB,EAAiB;EACvE,OAAOf,KAAK,CAACc,eAAe,CAACC,gBAAgB,CAAC;AAChD;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,SAAS,GAA4B;EACnD,OAAOhB,KAAK,CAACgB,SAAS,EAAE;AAC1B;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,kBAAkB,GAA4B;EAC5D,OAAOjB,KAAK,CAACiB,kBAAkB,EAAE;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,iBAAiB,CAACC,WAAmB,EAAyB;EAC5E,OAAOnB,KAAK,CAACkB,iBAAiB,CAACC,WAAW,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,sBAAsB,CAACD,WAAmB,EAAyB;EACjF,OAAOnB,KAAK,CAACoB,sBAAsB,CAACD,WAAW,CAAC;AAClD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,kBAAkB,CAACF,WAAmB,EAAyB;EAC7E,OAAOnB,KAAK,CAACqB,kBAAkB,CAACF,WAAW,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,kBAAkB,CAACC,QAAsB,EAAiB;EACxE,OAAOvB,KAAK,CAACsB,kBAAkB,CAACC,QAAQ,CAAC;AAC3C;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,sBAAsB,GAAkB;EACtD,OAAOxB,KAAK,CAACwB,sBAAsB,EAAE;AACvC;AAAC,eAEcxB,KAAK;AAAA"}

package/lib/module/index.js

@@ -7,25 +7,137 @@ const Vibes = NativeModules.Vibes ? NativeModules.Vibes : new Proxy({}, {
   get() {
     throw new Error(LINKING_ERROR);
   }
-
 });
+/**
+ * Register this device with the Vibes platform
+ *
+ * @return {Promise<DeviceResponse>}
+ */
 export function registerDevice() {
   return Vibes.registerDevice();
 }
+/**
+ * Unregister this device with the Vibes platform
+ *
+ * @return {Promise<void>}
+ */
 export function unregisterDevice() {
   return Vibes.unregisterDevice();
 }
+
+/**
+ * Register this device to receive push notifications
+ *
+ * @return {Promise<void>}
+ */
 export function registerPush() {
   return Vibes.registerPush();
 }
+
+/**
+* Unregister the device from receiving push notifications
+*
+* @return {Promise<void>}
+*/
+export function unregisterPush() {
+  return Vibes.registerPush();
+}
+
+/**
+ * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
+ *
+ * @return {Promise<DeviceInfoResponse>}
+ */
 export function getVibesDeviceInfo() {
   return Vibes.getVibesDeviceInfo();
 }
+
+/**
+ * Updates the Vibes platform with changes to the device since the last time device information was submitted.
+ *
+ * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.
+ * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @returns {Promise<void>}
+ */
 export function updateDevice(updateCredential, latitude, longitude) {
   return Vibes.updateDevice(updateCredential, latitude, longitude);
 }
+
+/**
+ * Associate an external ID with the current person.
+ *
+ * @param {string} externalPersonId
+ * @return {Promise<void>}
+ */
 export function associatePerson(externalPersonId) {
   return Vibes.associatePerson(externalPersonId);
 }
+
+/**
+ * Fetches the PersonResponse associated with this device currently
+ *
+ * @return {Promise<PersonResponse>}
+ */
+export function getPerson() {
+  return Vibes.getPerson();
+}
+/**
+ * Fetches an array of inbox messages for the person associated with this device.
+ *
+ * @return {Promise<InboxMessage[]>}
+ */
+export function fetchInboxMessages() {
+  return Vibes.fetchInboxMessages();
+}
+
+/**
+ * Fetches a single inbox message by it's id.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>}
+ */
+export function fetchInboxMessage(message_uid) {
+  return Vibes.fetchInboxMessage(message_uid);
+}
+
+/**
+ * Marks an inbox message as read.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
+ */
+export function markInboxMessageAsRead(message_uid) {
+  return Vibes.markInboxMessageAsRead(message_uid);
+}
+
+/**
+ * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
+ */
+export function expireInboxMessage(message_uid) {
+  return Vibes.expireInboxMessage(message_uid);
+}
+
+/**
+ * Records an event for when the user opens an inbox message.
+ *
+ * @param inboxMap json map of the InboxMessage
+ * @return {Promise<void>}
+ */
+export function onInboxMessageOpen(inboxMap) {
+  return Vibes.onInboxMessageOpen(inboxMap);
+}
+
+/**
+ * Records an event for when the user fetches a list of inbox messages.
+ *
+ * @return {Promise<void>}
+ */
+export function onInboxMessagesFetched() {
+  return Vibes.onInboxMessagesFetched();
+}
 export default Vibes;
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","Vibes","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\nexport function registerDevice(): Promise<any> {\n  return Vibes.registerDevice();\n}\n\nexport function unregisterDevice(): Promise<any> {\n  return Vibes.unregisterDevice();\n}\n\nexport function registerPush(): Promise<any> {\n  return Vibes.registerPush();\n}\n\nexport function getVibesDeviceInfo(): Promise<any> {\n  return Vibes.getVibesDeviceInfo();\n}\n\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<any> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\nexport function associatePerson(externalPersonId: string): Promise<any> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\nexport default Vibes;\n"],"mappings":"AAAA,SAASA,aAAT,EAAwBC,QAAxB,QAAwC,cAAxC;AAEA,MAAMC,aAAa,GAChB,6EAAD,GACAD,QAAQ,CAACE,MAAT,CAAgB;EAAEC,GAAG,EAAE,gCAAP;EAAyCC,OAAO,EAAE;AAAlD,CAAhB,CADA,GAEA,sDAFA,GAGA,6CAJF;AAMA,MAAMC,KAAK,GAAGN,aAAa,CAACM,KAAd,GACVN,aAAa,CAACM,KADJ,GAEV,IAAIC,KAAJ,CACE,EADF,EAEE;EACEC,GAAG,GAAG;IACJ,MAAM,IAAIC,KAAJ,CAAUP,aAAV,CAAN;EACD;;AAHH,CAFF,CAFJ;AAWA,OAAO,SAASQ,cAAT,GAAwC;EAC7C,OAAOJ,KAAK,CAACI,cAAN,EAAP;AACD;AAED,OAAO,SAASC,gBAAT,GAA0C;EAC/C,OAAOL,KAAK,CAACK,gBAAN,EAAP;AACD;AAED,OAAO,SAASC,YAAT,GAAsC;EAC3C,OAAON,KAAK,CAACM,YAAN,EAAP;AACD;AAED,OAAO,SAASC,kBAAT,GAA4C;EACjD,OAAOP,KAAK,CAACO,kBAAN,EAAP;AACD;AAED,OAAO,SAASC,YAAT,CACLC,gBADK,EAELC,QAFK,EAGLC,SAHK,EAIS;EACd,OAAOX,KAAK,CAACQ,YAAN,CAAmBC,gBAAnB,EAAqCC,QAArC,EAA+CC,SAA/C,CAAP;AACD;AAED,OAAO,SAASC,eAAT,CAAyBC,gBAAzB,EAAiE;EACtE,OAAOb,KAAK,CAACY,eAAN,CAAsBC,gBAAtB,CAAP;AACD;AAED,eAAeb,KAAf"}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","Vibes","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","unregisterPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId","getPerson","fetchInboxMessages","fetchInboxMessage","message_uid","markInboxMessageAsRead","expireInboxMessage","onInboxMessageOpen","inboxMap","onInboxMessagesFetched"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n    {},\n    {\n      get() {\n        throw new Error(LINKING_ERROR);\n      },\n    }\n  );\n\nexport interface DeviceResponse {\n  device_id?: string;\n}\nexport interface DeviceInfoResponse extends DeviceResponse {\n  push_token?: string;\n}\n\nexport interface PersonResponse {\n  person_key?: string;\n  external_person_id?: string;\n}\n\nexport interface InboxMessage {\n  content?: string;\n  created_at?: string;\n  expires_at?: string;\n  message_uid?: string;\n  read?: boolean;\n  subject?: string;\n  detail?: string;\n  collapse_key?: string;\n  apprefdata?: any;\n  images?: any;\n  inbox_custom_data: any;\n}\n\n/**\n * Register this device with the Vibes platform\n *\n * @return {Promise<DeviceResponse>}\n */\nexport function registerDevice(): Promise<DeviceResponse> {\n  return Vibes.registerDevice();\n}\n/**\n * Unregister this device with the Vibes platform\n *\n * @return {Promise<void>}\n */\nexport function unregisterDevice(): Promise<void> {\n  return Vibes.unregisterDevice();\n}\n\n/**\n * Register this device to receive push notifications\n *\n * @return {Promise<void>}\n */\nexport function registerPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n* Unregister the device from receiving push notifications\n*\n* @return {Promise<void>}\n*/\nexport function unregisterPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token\n *\n * @return {Promise<DeviceInfoResponse>}\n */\nexport function getVibesDeviceInfo(): Promise<DeviceInfoResponse> {\n  return Vibes.getVibesDeviceInfo();\n}\n\n/**\n * Updates the Vibes platform with changes to the device since the last time device information was submitted.\n *\n * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.\n * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @returns {Promise<void>}\n */\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<void> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\n/**\n * Associate an external ID with the current person.\n *\n * @param {string} externalPersonId\n * @return {Promise<void>}\n */\nexport function associatePerson(externalPersonId: string): Promise<void> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\n/**\n * Fetches the PersonResponse associated with this device currently\n *\n * @return {Promise<PersonResponse>}\n */\nexport function getPerson(): Promise<PersonResponse> {\n  return Vibes.getPerson();\n}\n/**\n * Fetches an array of inbox messages for the person associated with this device.\n *\n * @return {Promise<InboxMessage[]>}\n */\nexport function fetchInboxMessages(): Promise<InboxMessage[]> {\n  return Vibes.fetchInboxMessages();\n}\n\n/**\n * Fetches a single inbox message by it's id.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>}\n */\nexport function fetchInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.fetchInboxMessage(message_uid);\n}\n\n/**\n * Marks an inbox message as read.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated\n */\nexport function markInboxMessageAsRead(message_uid: string): Promise<InboxMessage> {\n  return Vibes.markInboxMessageAsRead(message_uid);\n}\n\n/**\n * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated\n */\nexport function expireInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.expireInboxMessage(message_uid);\n}\n\n/**\n * Records an event for when the user opens an inbox message.\n *\n * @param inboxMap json map of the InboxMessage\n * @return {Promise<void>}\n */\nexport function onInboxMessageOpen(inboxMap: InboxMessage): Promise<void> {\n  return Vibes.onInboxMessageOpen(inboxMap);\n}\n\n/**\n * Records an event for when the user fetches a list of inbox messages.\n *\n * @return {Promise<void>}\n */\nexport function onInboxMessagesFetched(): Promise<void> {\n  return Vibes.onInboxMessagesFetched();\n}\n\nexport default Vibes;\n"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GAChB,6EAA4E,GAC7ED,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,6CAA6C;AAE/C,MAAMC,KAAK,GAAGN,aAAa,CAACM,KAAK,GAC7BN,aAAa,CAACM,KAAK,GACnB,IAAIC,KAAK,CACT,CAAC,CAAC,EACF;EACEC,GAAG,GAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CAAC,CACF;AA4BH;AACA;AACA;AACA;AACA;AACA,OAAO,SAASQ,cAAc,GAA4B;EACxD,OAAOJ,KAAK,CAACI,cAAc,EAAE;AAC/B;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgB,GAAkB;EAChD,OAAOL,KAAK,CAACK,gBAAgB,EAAE;AACjC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAY,GAAkB;EAC5C,OAAON,KAAK,CAACM,YAAY,EAAE;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAc,GAAkB;EAC9C,OAAOP,KAAK,CAACM,YAAY,EAAE;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,kBAAkB,GAAgC;EAChE,OAAOR,KAAK,CAACQ,kBAAkB,EAAE;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAY,CAC1BC,gBAAyB,EACzBC,QAAgB,EAChBC,SAAiB,EACF;EACf,OAAOZ,KAAK,CAACS,YAAY,CAACC,gBAAgB,EAAEC,QAAQ,EAAEC,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAe,CAACC,gBAAwB,EAAiB;EACvE,OAAOd,KAAK,CAACa,eAAe,CAACC,gBAAgB,CAAC;AAChD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAAS,GAA4B;EACnD,OAAOf,KAAK,CAACe,SAAS,EAAE;AAC1B;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkB,GAA4B;EAC5D,OAAOhB,KAAK,CAACgB,kBAAkB,EAAE;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiB,CAACC,WAAmB,EAAyB;EAC5E,OAAOlB,KAAK,CAACiB,iBAAiB,CAACC,WAAW,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsB,CAACD,WAAmB,EAAyB;EACjF,OAAOlB,KAAK,CAACmB,sBAAsB,CAACD,WAAW,CAAC;AAClD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,kBAAkB,CAACF,WAAmB,EAAyB;EAC7E,OAAOlB,KAAK,CAACoB,kBAAkB,CAACF,WAAW,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,kBAAkB,CAACC,QAAsB,EAAiB;EACxE,OAAOtB,KAAK,CAACqB,kBAAkB,CAACC,QAAQ,CAAC;AAC3C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsB,GAAkB;EACtD,OAAOvB,KAAK,CAACuB,sBAAsB,EAAE;AACvC;AAEA,eAAevB,KAAK"}