@braze/react-native-sdk - npm Package Compare versions

Comparing version 3.0.0 to 4.0.0

package.json

 {
   "name": "@braze/react-native-sdk",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Braze SDK for React Native.",
@@ -62,2 +62,2 @@ "main": "src/index.js",
   }
-}
+}

src/braze.js

@@ -553,3 +553,3 @@ import {
   /**
-   * Returns a content cards array
+   * Returns a content cards array after performing a refresh.
    * @returns {Promise<ContentCard[]>}
@@ -556,0 +556,0 @@ */

src/index.d.ts

@@ -552,10 +552,10 @@ // Definitions by: ahanriat <https://github.com/ahanriat>
  * @param {boolean} useBrazeUI - Whether to use the default Braze UI for in-app messages.
- * @param {function} subscriber - The method to call when an in-app message is received.
+ * @param {function} callback - The method to call when an in-app message is received.
  *
- * @returns subscription - If a subscriber is passed to the function, returns the subscription. When you want to stop
- * listening, call `.remove()` on the returned subscription. Returns undefined if no subscriber is provided.
+ * @returns subscription - If a callback is passed to the function, returns the subscription. When you want to stop
+ * listening, call `.remove()` on the returned subscription. Returns undefined if no callback is provided.
  */
 export function subscribeToInAppMessage(
   useBrazeUI: boolean,
-  subscriber?: Function
+  callback?: Function
 ): EmitterSubscription | undefined;
@@ -699,4 +699,8 @@
 
+export interface ContentCardsUpdatedEvent {
+  cards: ContentCard[];
+}
+
 interface BrazeEvent {
-  /** Callback passes a boolean that indicates whether content cards have changed in the latest refresh. */
+  /** Callback passes an object with the `cards` as of the latest refresh. */
   CONTENT_CARDS_UPDATED: 'contentCardsUpdated';
@@ -712,8 +716,10 @@ /** Callback passes an object containing "error_code", "user_id", "original_signature", and "reason". */
 
-/**
- * Subscribes to the specific SDK event
- * @param {BrazeEvent} event
- * @param {function} subscriber
- */
-export function addListener(event: BrazeEvent[keyof BrazeEvent], subscriber: Function): EmitterSubscription;
+/** Callback passes an object with the `cards` as of the latest refresh. */
+export function addListener(event: "contentCardsUpdated", callback: (update: ContentCardsUpdatedEvent) => void): EmitterSubscription;
+/** Callback passes an object containing "error_code", "user_id", "original_signature", and "reason". */
+export function addListener(event: "sdkAuthenticationError", callback: (sdkAuthenticationError: SDKAuthenticationErrorType) => void): EmitterSubscription;
+/** Callback passes the BrazeInAppMessage object. */
+export function addListener(event: "inAppMessageReceived", callback: (inAppMessage: BrazeInAppMessage) => void): EmitterSubscription;
+/** Only supported on Android. */
+export function addListener(event: "pushNotificationEvent", callback: (notification: PushNotificationEvent) => void): EmitterSubscription;
 
@@ -720,0 +726,0 @@ type Callback<T> = (error?: object, result?: T) => void;

No alert changes

Improved metrics

Total package byte prevSize

186065

2.54%

Lines of code

2304

0.22%

No dependency changes