@react-native-firebase/in-app-messaging 24.1.0 → 25.0.0

package/lib/index.d.ts

@@ -1,194 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
-import { ReactNativeFirebase } from '@react-native-firebase/app';
-
-/**
- * Firebase In-App Messaging package for React Native.
- *
- * #### Example 1
- *
- * Access the firebase export from the `inAppMessaging` package:
- *
- * ```js
- * import { firebase } from '@react-native-firebase/in-app-messaging';
- *
- * // firebase.inAppMessaging().X
- * ```
- *
- * #### Example 2
- *
- * Using the default export from the `in-app-messaging` package:
- *
- * ```js
- * import inAppMessaging from '@react-native-firebase/in-app-messaging';
- *
- * // inAppMessaging().X
- * ```
- *
- * #### Example 3
- *
- * Using the default export from the `app` package:
- *
- * ```js
- * import firebase from '@react-native-firebase/app';
- * import '@react-native-firebase/in-app-messaging';
- *
- * // firebase.inAppMessaging().X
- * ```
- *
- * @firebase in-app-messaging
- */
-export namespace FirebaseInAppMessagingTypes {
-  import FirebaseModule = ReactNativeFirebase.FirebaseModule;
-
-  export interface Statics {
-    SDK_VERSION: string;
-  }
-
-  /**
-   * The Firebase In-App Messaging service interface.
-   *
-   * > This module is available for the default app only.
-   *
-   * #### Example
-   *
-   * Get the  In-App Messaging service for the default app:
-   *
-   * ```js
-   * const defaultAppInAppMessaging = firebase.inAppMessaging();
-   * ```
-   */
-  export class Module extends FirebaseModule {
-    /**
-     * The current `FirebaseApp` instance for this Firebase service.
-     */
-    app: ReactNativeFirebase.FirebaseApp;
-
-    /**
-     * Determines whether messages are suppressed or not.
-     *
-     * #### Example
-     *
-     * ```js
-     * const isSuppressed = firebase.inAppMessaging().isMessagesDisplaySuppressed;
-     * ```
-     */
-    isMessagesDisplaySuppressed: 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
-     * await firebase.inAppMessaging().setMessagesDisplaySuppressed(true);
-     * ```
-     *
-     * @param enabled Whether messages should be suppressed.
-     */
-    setMessagesDisplaySuppressed(enabled: boolean): Promise<null>;
-
-    /**
-     * Determines whether automatic data collection is enabled or not.
-     *
-     * #### Example
-     *
-     * ```js
-     * const isDataCollectionEnabled = firebase.inAppMessaging().isAutomaticDataCollectionEnabled;
-     * ```
-     */
-    isAutomaticDataCollectionEnabled: 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
-     * firebase.inAppMessaging().setAutomaticDataCollectionEnabled(false);
-     * ```
-     *
-     * @param enabled Whether automatic data collection is enabled.
-     */
-    setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null>;
-
-    /**
-     * Trigger in-app messages programmatically
-     *
-     * #### Example
-     *
-     * ```js
-     * // Suppress messages
-     * await firebase.inAppMessaging().triggerEvent("exampleTrigger");
-     * ```
-     *
-     * @param eventId The id of the event.
-     */
-    triggerEvent(eventId: string): Promise<null>;
-  }
-}
-
-type InAppMessagingNamespace = ReactNativeFirebase.FirebaseModuleWithStatics<
-  FirebaseInAppMessagingTypes.Module,
-  FirebaseInAppMessagingTypes.Statics
-> & {
-  firebase: ReactNativeFirebase.Module;
-  app(name?: string): ReactNativeFirebase.FirebaseApp;
-};
-
-declare const defaultExport: InAppMessagingNamespace;
-
-export const firebase: ReactNativeFirebase.Module & {
-  inAppMessaging: typeof defaultExport;
-  app(
-    name?: string,
-  ): ReactNativeFirebase.FirebaseApp & { inAppMessaging(): FirebaseInAppMessagingTypes.Module };
-};
-
-export default defaultExport;
-
-export * from './modular';
-
-/**
- * Attach namespace to `firebase.` and `FirebaseApp.`.
- */
-declare module '@react-native-firebase/app' {
-  namespace ReactNativeFirebase {
-    import FirebaseModuleWithStatics = ReactNativeFirebase.FirebaseModuleWithStatics;
-    interface Module {
-      inAppMessaging: FirebaseModuleWithStatics<
-        FirebaseInAppMessagingTypes.Module,
-        FirebaseInAppMessagingTypes.Statics
-      >;
-    }
-
-    interface FirebaseApp {
-      inAppMessaging(): FirebaseInAppMessagingTypes.Module;
-    }
-  }
-}

package/lib/modular/index.d.ts

@@ -1,89 +0,0 @@
-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

@@ -1,57 +0,0 @@
-import { getApp } from '@react-native-firebase/app';
-
-/**
- * @typedef {import("..").FirebaseApp} FirebaseApp
- * @typedef {import("..").FirebaseInAppMessagingTypes.Module} FirebaseInAppMessaging
- */
-
-/**
- * @returns {FirebaseInAppMessaging}
- */
-export function getInAppMessaging() {
-  return getApp().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 +0,0 @@
-// Generated by genversion.
-module.exports = '24.1.0';