@react-native-firebase/in-app-messaging 18.3.2 → 18.5.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [18.5.0](https://github.com/invertase/react-native-firebase/compare/v18.4.0...v18.5.0) (2023-09-22)
+
+**Note:** Version bump only for package @react-native-firebase/in-app-messaging
+
+## [18.4.0](https://github.com/invertase/react-native-firebase/compare/v18.3.2...v18.4.0) (2023-09-11)
+
+### Features
+
+- **in-app-messaging:** Firebase V9 modular APIs ([#7306](https://github.com/invertase/react-native-firebase/issues/7306)) ([0149480](https://github.com/invertase/react-native-firebase/commit/0149480df3ec267c8b317d9034ff2a297bf2ce23))
+
 ## [18.3.2](https://github.com/invertase/react-native-firebase/compare/v18.3.1...v18.3.2) (2023-09-02)
 
 **Note:** Version bump only for package @react-native-firebase/in-app-messaging

package/lib/index.js

@@ -74,6 +74,8 @@ class FirebaseFiamModule extends FirebaseModule {
   }
 }
 
+export * from './modular';
+
 // import { SDK_VERSION } from '@react-native-firebase/in-app-messaging';
 export const SDK_VERSION = version;
 

package/lib/modular/index.d.ts

@@ -0,0 +1,89 @@
+import { FirebaseInAppMessagingTypes } from '..';
+
+type FirebaseInAppMessaging = FirebaseInAppMessagingTypes.Module;
+
+export declare function getInAppMessaging(): FirebaseInAppMessaging;
+
+/**
+ * Determines whether messages are suppressed or not.
+ *
+ * #### Example
+ *
+ * ```js
+ * const inAppMessaging = getInAppMessaging();
+ * const isSuppressed = isMessagesDisplaySuppressed(inAppMessaging);
+ * ```
+ */
+export declare function isMessagesDisplaySuppressed(
+  inAppMessaging: FirebaseInAppMessaging,
+): boolean;
+
+/**
+ * Enable or disable suppression of Firebase In App Messaging messages.
+ *
+ * When enabled, no in app messages will be rendered until either you disable suppression, or the app restarts.
+ * This state is not persisted between app restarts.
+ *
+ * #### Example
+ *
+ * ```js
+ * // Suppress messages
+ * const inAppMessaging = getInAppMessaging();
+ * await setMessagesDisplaySuppressed(inAppMessaging, true);
+ * ```
+ */
+export declare function setMessagesDisplaySuppressed(
+  inAppMessaging: FirebaseInAppMessaging,
+  enabled: boolean,
+): Promise<null>;
+
+/**
+ * Determines whether automatic data collection is enabled or not.
+ *
+ * #### Example
+ *
+ * ```js
+ * const inAppMessaging = getInAppMessaging();
+ * const isDataCollectionEnabled = isAutomaticDataCollectionEnabled(inAppMessaging);
+ * ```
+ */
+export declare function isAutomaticDataCollectionEnabled(
+  inAppMessaging: FirebaseInAppMessaging,
+): boolean;
+
+/**
+ * Enable or disable automatic data collection for Firebase In-App Messaging.
+ *
+ * When enabled, generates a registration token on app startup if there is no valid one and generates a new token
+ * when it is deleted (which prevents `deleteInstanceId()` from stopping the periodic sending of data).
+ *
+ * This setting is persisted across app restarts and overrides the setting specified in your manifest/plist file.
+ *
+ * #### Example
+ *
+ * ```js
+ * // Disable data collection
+ * const inAppMessaging = getInAppMessaging();
+ * setAutomaticDataCollectionEnabled(inAppMessaging, false);
+ * ```
+ */
+export declare function setAutomaticDataCollectionEnabled(
+  inAppMessaging: FirebaseInAppMessaging,
+  enabled: boolean,
+): Promise<null>;
+
+/**
+ * Trigger in-app messages programmatically
+ *
+ * #### Example
+ *
+ * ```js
+ * // Suppress messages
+ * const inAppMessaging = getInAppMessaging();
+ * await triggerEvent(inAppMessaging, "exampleTrigger");
+ * ```
+ */
+export declare function triggerEvent(
+  inAppMessaging: FirebaseInAppMessaging,
+  eventId: string,
+): Promise<null>;

package/lib/modular/index.js

@@ -0,0 +1,57 @@
+import { firebase } from '..';
+
+/**
+ * @typedef {import("..").FirebaseApp} FirebaseApp
+ * @typedef {import("..").FirebaseInAppMessagingTypes.Module} FirebaseInAppMessaging
+ */
+
+/**
+ * @returns {FirebaseInAppMessaging}
+ */
+export function getInAppMessaging() {
+  return firebase.inAppMessaging();
+}
+
+/**
+ * @param {FirebaseInAppMessaging} inAppMessaging
+ * @returns {boolean}
+ */
+export function isMessagesDisplaySuppressed(inAppMessaging) {
+  return inAppMessaging.isMessagesDisplaySuppressed;
+}
+
+/**
+ *
+ * @param {FirebaseInAppMessaging} inAppMessaging
+ * @param {boolean} enabled
+ * @returns {Promise<null>}
+ */
+export function setMessagesDisplaySuppressed(inAppMessaging, enabled) {
+  return inAppMessaging.setMessagesDisplaySuppressed(enabled);
+}
+
+/**
+ * @param {FirebaseInAppMessaging} inAppMessaging
+ * @returns {boolean}
+ */
+export function isAutomaticDataCollectionEnabled(inAppMessaging) {
+  return inAppMessaging.isAutomaticDataCollectionEnabled;
+}
+
+/**
+ * @param {FirebaseInAppMessaging} inAppMessaging
+ * @param {boolean} enabled
+ * @returns {Promise<null>}
+ */
+export function setAutomaticDataCollectionEnabled(inAppMessaging, enabled) {
+  return inAppMessaging.setAutomaticDataCollectionEnabled(enabled);
+}
+
+/**
+ * @param {FirebaseInAppMessaging} inAppMessaging
+ * @param {string} eventId
+ * @returns {Promise<null>}
+ */
+export function triggerEvent(inAppMessaging, eventId) {
+  return inAppMessaging.triggerEvent(eventId);
+}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '18.3.2';
+module.exports = '18.5.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/in-app-messaging",
-  "version": "18.3.2",
+  "version": "18.5.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Firebase In-App Messaging helps you engage your app's active users by sending them targeted, contextual messages that encourage them to use key app features. React Native Firebase provides support for both native Android & iOS integration with a simple JavaScript API.",
   "main": "lib/index.js",
@@ -27,11 +27,11 @@
     "inAppMessaging"
   ],
   "peerDependencies": {
-    "@react-native-firebase/analytics": "18.3.2",
-    "@react-native-firebase/app": "18.3.2"
+    "@react-native-firebase/analytics": "18.5.0",
+    "@react-native-firebase/app": "18.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f323891622441c9d59a25ef37b19534db512b372"
+  "gitHead": "c9b695aa8fd75d5a1d070ecbb6bb9ac4e9ff062e"
 }