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

package/lib/modular.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 { getApp } from '@react-native-firebase/app';
+import {
+  MODULAR_DEPRECATION_ARG,
+  withModularFlag,
+} from '@react-native-firebase/app/dist/module/common';
+import type { InAppMessaging } from './types/in-app-messaging';
+import type { InAppMessagingWithDeprecationArg } from './types/internal';
+
+function withModularDeprecationArg(inAppMessaging: InAppMessaging): InAppMessagingWithDeprecationArg {
+  return inAppMessaging as InAppMessagingWithDeprecationArg;
+}
+
+/**
+ * Returns the {@link InAppMessaging} instance for the default app.
+ */
+export function getInAppMessaging(): InAppMessaging {
+  return getApp().inAppMessaging();
+}
+
+/**
+ * Determines whether messages are suppressed or not.
+ */
+export function isMessagesDisplaySuppressed(inAppMessaging: InAppMessaging): boolean {
+  return withModularFlag(() => inAppMessaging.isMessagesDisplaySuppressed);
+}
+
+/**
+ * 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.
+ */
+export function setMessagesDisplaySuppressed(
+  inAppMessaging: InAppMessaging,
+  enabled: boolean,
+): Promise<null> {
+  const internalInAppMessaging = withModularDeprecationArg(inAppMessaging);
+  return internalInAppMessaging.setMessagesDisplaySuppressed.call(
+    internalInAppMessaging,
+    enabled,
+    MODULAR_DEPRECATION_ARG,
+  );
+}
+
+/**
+ * Determines whether automatic data collection is enabled or not.
+ */
+export function isAutomaticDataCollectionEnabled(inAppMessaging: InAppMessaging): boolean {
+  return withModularFlag(() => inAppMessaging.isAutomaticDataCollectionEnabled);
+}
+
+/**
+ * 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.
+ */
+export function setAutomaticDataCollectionEnabled(
+  inAppMessaging: InAppMessaging,
+  enabled: boolean,
+): Promise<null> {
+  const internalInAppMessaging = withModularDeprecationArg(inAppMessaging);
+  return internalInAppMessaging.setAutomaticDataCollectionEnabled.call(
+    internalInAppMessaging,
+    enabled,
+    MODULAR_DEPRECATION_ARG,
+  );
+}
+
+/**
+ * Trigger in-app messages programmatically.
+ */
+export function triggerEvent(inAppMessaging: InAppMessaging, eventId: string): Promise<null> {
+  const internalInAppMessaging = withModularDeprecationArg(inAppMessaging);
+  return internalInAppMessaging.triggerEvent.call(
+    internalInAppMessaging,
+    eventId,
+    MODULAR_DEPRECATION_ARG,
+  );
+}

package/lib/namespaced.ts

@@ -0,0 +1,117 @@
+/*
+ * 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 { isBoolean, isString } from '@react-native-firebase/app/dist/module/common';
+import {
+  createModuleNamespace,
+  FirebaseModule,
+  getFirebaseRoot,
+} from '@react-native-firebase/app/dist/module/internal';
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+
+import './types/internal';
+import type { FirebaseInAppMessagingTypes } from './types/namespaced';
+import { version } from './version';
+
+const statics = {};
+
+const namespace = 'inAppMessaging';
+
+const nativeModuleName = 'RNFBFiamModule';
+
+class FirebaseFiamModule extends FirebaseModule<typeof nativeModuleName> {
+  private _isMessagesDisplaySuppressed: boolean;
+  private _isAutomaticDataCollectionEnabled: boolean;
+
+  constructor(...args: ConstructorParameters<typeof FirebaseModule>) {
+    super(...args);
+    this._isMessagesDisplaySuppressed = this.native.isMessagesDisplaySuppressed;
+    this._isAutomaticDataCollectionEnabled = this.native.isAutomaticDataCollectionEnabled;
+  }
+
+  get isMessagesDisplaySuppressed(): boolean {
+    return this._isMessagesDisplaySuppressed;
+  }
+
+  get isAutomaticDataCollectionEnabled(): boolean {
+    return this._isAutomaticDataCollectionEnabled;
+  }
+
+  setMessagesDisplaySuppressed(enabled: boolean): Promise<null> {
+    if (!isBoolean(enabled)) {
+      throw new Error(
+        "firebase.inAppMessaging().setMessagesDisplaySuppressed(*) 'enabled' must be a boolean.",
+      );
+    }
+
+    this._isMessagesDisplaySuppressed = enabled;
+    return this.native.setMessagesDisplaySuppressed(enabled);
+  }
+
+  setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null> {
+    if (!isBoolean(enabled)) {
+      throw new Error(
+        "firebase.inAppMessaging().setAutomaticDataCollectionEnabled(*) 'enabled' must be a boolean.",
+      );
+    }
+
+    this._isAutomaticDataCollectionEnabled = enabled;
+    return this.native.setAutomaticDataCollectionEnabled(enabled);
+  }
+
+  triggerEvent(eventId: string): Promise<null> {
+    if (!isString(eventId)) {
+      throw new Error("firebase.inAppMessaging().triggerEvent(*) 'eventId' must be a string.");
+    }
+    return this.native.triggerEvent(eventId);
+  }
+}
+
+type InAppMessagingNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
+  FirebaseInAppMessagingTypes.Module,
+  FirebaseInAppMessagingTypes.Statics
+> & {
+  firebase: ReactNativeFirebase.Module;
+  app(name?: string): ReactNativeFirebase.FirebaseApp;
+};
+
+// import { SDK_VERSION } from '@react-native-firebase/in-app-messaging';
+export const SDK_VERSION = version;
+
+const defaultExport = createModuleNamespace({
+  statics,
+  version,
+  namespace,
+  nativeModuleName,
+  nativeEvents: false,
+  hasMultiAppSupport: false,
+  hasCustomUrlOrRegionSupport: false,
+  ModuleClass: FirebaseFiamModule,
+}) as unknown as InAppMessagingNamespace;
+
+export default defaultExport;
+
+// import inAppMessaging, { firebase } from '@react-native-firebase/in-app-messaging';
+// inAppMessaging().X(...);
+// firebase.inAppMessaging().X(...);
+export const firebase =
+  getFirebaseRoot() as unknown as ReactNativeFirebase.FirebaseNamespacedExport<
+    'inAppMessaging',
+    FirebaseInAppMessagingTypes.Module,
+    FirebaseInAppMessagingTypes.Statics,
+    false
+  >;

package/lib/types/in-app-messaging.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 type { FirebaseApp } from '@react-native-firebase/app';
+
+/**
+ * Firebase In-App Messaging service instance for the modular API.
+ *
+ * Current Firebase JS SDK releases do not ship a `firebase/in-app-messaging` modular entry point;
+ * this interface follows the same modular service-instance pattern used elsewhere in React Native
+ * Firebase.
+ */
+export interface InAppMessaging {
+  /** The FirebaseApp this module is associated with. */
+  app: FirebaseApp;
+
+  /** Whether Firebase In-App Messaging message rendering is currently suppressed. */
+  isMessagesDisplaySuppressed: boolean;
+
+  /** Whether automatic data collection is enabled for Firebase In-App Messaging. */
+  isAutomaticDataCollectionEnabled: boolean;
+
+  /**
+   * Enable or disable suppression of Firebase In-App Messaging messages.
+   *
+   * When enabled, no in-app messages will be rendered until either suppression is disabled or the
+   * app restarts. This state is not persisted between app restarts.
+   */
+  setMessagesDisplaySuppressed(enabled: boolean): Promise<null>;
+
+  /**
+   * 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.
+   */
+  setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null>;
+
+  /** Trigger in-app messages programmatically for the given event id. */
+  triggerEvent(eventId: string): Promise<null>;
+}

package/lib/types/internal.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 type { InAppMessaging } from './in-app-messaging';
+
+/** Optional final argument passed by modular API wrappers (MODULAR_DEPRECATION_ARG). */
+export type InAppMessagingModularDeprecationArg = string;
+
+/**
+ * Wrapped native module contract for `RNFBFiamModule`.
+ */
+export interface RNFBFiamModule {
+  isMessagesDisplaySuppressed: boolean;
+  isAutomaticDataCollectionEnabled: boolean;
+  setMessagesDisplaySuppressed(enabled: boolean): Promise<null>;
+  setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null>;
+  triggerEvent(eventId: string): Promise<null>;
+}
+
+declare module '@react-native-firebase/app/dist/module/internal/NativeModules' {
+  interface ReactNativeFirebaseNativeModules {
+    RNFBFiamModule: RNFBFiamModule;
+  }
+}
+
+export interface InAppMessagingInternal extends InAppMessaging {
+  readonly native: RNFBFiamModule;
+}
+
+export type InAppMessagingWithDeprecationArg = InAppMessagingInternal & {
+  setMessagesDisplaySuppressed(
+    enabled: boolean,
+    _depArg: InAppMessagingModularDeprecationArg,
+  ): Promise<null>;
+  setAutomaticDataCollectionEnabled(
+    enabled: boolean,
+    _depArg: InAppMessagingModularDeprecationArg,
+  ): Promise<null>;
+  triggerEvent(eventId: string, _depArg: InAppMessagingModularDeprecationArg): Promise<null>;
+};

package/lib/types/namespaced.ts

@@ -0,0 +1,137 @@
+/*
+ * 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 type { 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
+ */
+/**
+ * @deprecated Use the exported types directly instead.
+ * FirebaseInAppMessagingTypes namespace is kept for backwards compatibility.
+ */
+/* eslint-disable @typescript-eslint/no-namespace */
+export namespace FirebaseInAppMessagingTypes {
+  /**
+   * @deprecated Use the exported types directly instead. FirebaseInAppMessagingTypes namespace is kept for backwards compatibility.
+   */
+  type FirebaseModule = ReactNativeFirebase.FirebaseModule;
+
+  /**
+   * @deprecated Use the default export statics instead.
+   */
+  export interface Statics {
+    /** @deprecated Use the default export statics instead. */
+    SDK_VERSION: string;
+  }
+
+  /**
+   * @deprecated Use the exported `InAppMessaging` type instead.
+   */
+  export interface Module extends FirebaseModule {
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * The current `FirebaseApp` instance for this Firebase service.
+     */
+    app: ReactNativeFirebase.FirebaseApp;
+
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * Determines whether messages are suppressed or not.
+     */
+    isMessagesDisplaySuppressed: boolean;
+
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * Determines whether automatic data collection is enabled or not.
+     */
+    isAutomaticDataCollectionEnabled: boolean;
+
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * Enable or disable suppression of Firebase In App Messaging messages.
+     */
+    setMessagesDisplaySuppressed(enabled: boolean): Promise<null>;
+
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * Enable or disable automatic data collection for Firebase In-App Messaging.
+     */
+    setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null>;
+
+    /**
+     * @deprecated Use the exported `InAppMessaging` type instead.
+     *
+     * Trigger in-app messages programmatically.
+     */
+    triggerEvent(eventId: string): Promise<null>;
+  }
+}
+
+declare module '@react-native-firebase/app' {
+  namespace ReactNativeFirebase {
+    interface Module {
+      inAppMessaging: FirebaseModuleWithStaticsAndApp<
+        FirebaseInAppMessagingTypes.Module,
+        FirebaseInAppMessagingTypes.Statics
+      >;
+    }
+
+    interface FirebaseApp {
+      inAppMessaging(): FirebaseInAppMessagingTypes.Module;
+    }
+  }
+}
+/* eslint-enable @typescript-eslint/no-namespace */

package/lib/version.ts

@@ -0,0 +1,2 @@
+// Generated by genversion.
+export const version = '25.0.0';

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@react-native-firebase/in-app-messaging",
-  "version": "24.1.0",
+  "version": "25.0.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",
-  "types": "lib/index.d.ts",
+  "main": "./dist/module/index.js",
+  "types": "./dist/typescript/lib/index.d.ts",
   "scripts": {
-    "build": "genversion --semi lib/version.js",
+    "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
-    "prepare": "yarn run build"
+    "compile": "bob build",
+    "prepare": "yarn run build && yarn compile"
   },
   "repository": {
     "type": "git",
@@ -27,12 +28,45 @@
     "inAppMessaging"
   ],
   "peerDependencies": {
-    "@react-native-firebase/analytics": "24.1.0",
-    "@react-native-firebase/app": "24.1.0"
+    "@react-native-firebase/analytics": "25.0.0",
+    "@react-native-firebase/app": "25.0.0"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "gitHead": "804a51fd265453f2385adb0ac96a6abf992c0316"
+  "devDependencies": {
+    "react-native-builder-bob": "^0.41.0"
+  },
+  "exports": {
+    ".": {
+      "source": "./lib/index.ts",
+      "types": "./dist/typescript/lib/index.d.ts",
+      "default": "./dist/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "react-native-builder-bob": {
+    "source": "lib",
+    "output": "dist",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "gitHead": "eac5bf5f3c80b158bf85b33789e4b64bfd16bbe1"
 }

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.packages.base.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "paths": {
+      "@react-native-firebase/app/dist/module/common": ["../app/dist/typescript/lib/common"],
+      "@react-native-firebase/app/dist/module/internal": ["../app/dist/typescript/lib/internal"],
+      "@react-native-firebase/app/dist/module/internal/NativeModules": [
+        "../app/dist/typescript/lib/internal/NativeModules"
+      ],
+      "@react-native-firebase/app": ["../app/dist/typescript/lib"]
+    }
+  },
+  "include": ["lib/**/*"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
+}

package/typedoc.json

@@ -1,5 +1,4 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["lib/index.d.ts"],
-  "intentionallyNotExported": ["InAppMessagingNamespace"]
+  "entryPoints": ["lib/modular.ts", "lib/types/in-app-messaging.ts"]
 }