@react-native-firebase/installations 18.0.0 → 18.2.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.2.0](https://github.com/invertase/react-native-firebase/compare/v18.1.0...v18.2.0) (2023-07-13)
+
+**Note:** Version bump only for package @react-native-firebase/installations
+
+## [18.1.0](https://github.com/invertase/react-native-firebase/compare/v18.0.0...v18.1.0) (2023-06-22)
+
+### Features
+
+- **installations:** Firebase JS SDK V9 modular API ([#7095](https://github.com/invertase/react-native-firebase/issues/7095)) ([08cb0c2](https://github.com/invertase/react-native-firebase/commit/08cb0c2a14ed1513ece59bae0598d169118521c3))
+
 ## [18.0.0](https://github.com/invertase/react-native-firebase/compare/v17.5.0...v18.0.0) (2023-06-05)
 
 **Note:** Version bump only for package @react-native-firebase/installations

package/__tests__/installations.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from '@jest/globals';
 
-import { firebase } from '../lib';
+import { firebase, getInstallations, onIdChange } from '../lib';
 
 describe('installations()', function () {
   describe('namespace', function () {
@@ -20,4 +20,34 @@ describe('installations()', function () {
       );
     });
   });
+
+  describe('modular', function () {
+    describe('getInstallations', function () {
+      it('returns an instance of Installations', async function () {
+        const installations = getInstallations();
+        expect(installations).toBeDefined();
+        expect(installations.app).toBeDefined();
+      });
+
+      it('supports multiple apps', async function () {
+        const app = firebase.app();
+        const secondaryApp = firebase.app('secondaryFromNative');
+
+        const installations = getInstallations();
+        const installationsForApp = getInstallations(secondaryApp);
+
+        expect(installations.app).toEqual(app);
+        expect(installationsForApp.app).toEqual(secondaryApp);
+      });
+    });
+
+    describe('onIdChange', function () {
+      it('throws an unsupported error', async function () {
+        const installations = getInstallations();
+        expect(() => onIdChange(installations, () => {})).toThrow(
+          'onIdChange() is unsupported by the React Native Firebase SDK.',
+        );
+      });
+    });
+  });
 });

package/lib/index.d.ts

@@ -89,7 +89,7 @@ export namespace FirebaseInstallationsTypes {
      * stable, URL-safe base64 string identifier that uniquely identifies the app instance.
      * NOTE: If the application already has an existing FirebaseInstanceID then the InstanceID identifier will be used.
      *
-     * @return Firebase Installation ID, this is a url-safe base64 string of a 128-bit integer.
+     * @return Firebase Installation ID, this is an url-safe base64 string of a 128-bit integer.
      */
     getId(): Promise<string>;
 
@@ -109,7 +109,7 @@ export namespace FirebaseInstallationsTypes {
      * Deletes the Firebase Installation and all associated data from the Firebase backend.
      * This call may cause Firebase Cloud Messaging, Firebase Remote Config, Firebase Predictions,
      * or Firebase In-App Messaging to not function properly. Fetching a new installations ID should
-     * reset all of the dependent services to a stable state again. A network connection is required
+     * reset all the dependent services to a stable state again. A network connection is required
      * for the method to succeed. If it fails, the existing installation data remains untouched.
      */
     delete(): Promise<void>;
@@ -117,7 +117,7 @@ export namespace FirebaseInstallationsTypes {
     /**
      * TODO implement id change listener for android.
      *
-     * Sets a new callback that will get called when Installlation ID changes.
+     * Sets a new callback that will get called when Installation ID changes.
      * Returns an unsubscribe function that will remove the callback when called.
      * Only the Android SDK supports sending ID change events.
      *
@@ -139,6 +139,8 @@ export const firebase: ReactNativeFirebase.Module & {
   ): ReactNativeFirebase.FirebaseApp & { installations(): FirebaseInstallationsTypes.Module };
 };
 
+export * from './modular';
+
 export default defaultExport;
 
 /**
@@ -147,12 +149,14 @@ export default defaultExport;
 declare module '@react-native-firebase/app' {
   namespace ReactNativeFirebase {
     import FirebaseModuleWithStaticsAndApp = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp;
+
     interface Module {
       installations: FirebaseModuleWithStaticsAndApp<
         FirebaseInstallationsTypes.Module,
         FirebaseInstallationsTypes.Statics
       >;
     }
+
     interface FirebaseApp {
       installations(): FirebaseInstallationsTypes.Module;
     }

package/lib/index.js

@@ -77,3 +77,5 @@ export default createModuleNamespace({
 // installations().X(...);
 // firebase.installations().X(...);
 export const firebase = getFirebaseRoot();
+
+export * from './modular';

package/lib/modular/index.d.ts

@@ -0,0 +1,42 @@
+import { ReactNativeFirebase } from '@react-native-firebase/app';
+import { FirebaseInstallationsTypes } from '../index';
+
+/**
+ * Returns an instance of Installations associated with the given FirebaseApp instance.
+ */
+export declare function getInstallations(
+  app?: ReactNativeFirebase.FirebaseApp,
+): FirebaseInstallationsTypes.Module;
+
+/**
+ * Deletes the Firebase Installation and all associated data.
+ */
+export declare function deleteInstallations(
+  installations?: FirebaseInstallationsTypes.Module,
+): Promise<void>;
+
+/**
+ * Creates a Firebase Installation if there isn't one for the app and returns the Installation ID.
+ */
+export declare function getId(installations: FirebaseInstallationsTypes.Module): Promise<string>;
+
+/**
+ * Returns a Firebase Installations auth token, identifying the current Firebase Installation.
+ */
+export declare function getToken(
+  installations: FirebaseInstallationsTypes.Module,
+  forceRefresh?: boolean,
+): Promise<string>;
+
+declare type IdChangeCallbackFn = (installationId: string) => void;
+declare type IdChangeUnsubscribeFn = () => void;
+
+/**
+ * Throw an error since react-native-firebase does not support this method.
+ *
+ * Sets a new callback that will get called when Installation ID changes. Returns an unsubscribe function that will remove the callback when called.
+ */
+export declare function onIdChange(
+  installations: FirebaseInstallationsTypes.Module,
+  callback: IdChangeCallbackFn,
+): IdChangeUnsubscribeFn;

package/lib/modular/index.js

@@ -0,0 +1,64 @@
+/*
+ * 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 { firebase } from '..';
+
+/**
+ * @param {import("@react-native-firebase/app").ReactNativeFirebase.FirebaseApp} app
+ * @returns {import("..").FirebaseInstallationsTypes.Module}
+ */
+export function getInstallations(app) {
+  if (app) {
+    return firebase.app(app.name).installations();
+  }
+  return firebase.app().installations();
+}
+
+/**
+ * @param {import("..").FirebaseInstallationsTypes.Module} installations
+ * @returns {Promise<void>}
+ */
+export function deleteInstallations(installations) {
+  return firebase.app(installations.app.name).installations().delete();
+}
+
+/**
+ * @param {import("..").FirebaseInstallationsTypes.Module} installations
+ * @returns {Promise<string>}
+ */
+export function getId(installations) {
+  return firebase.app(installations.app.name).installations().getId();
+}
+
+/**
+ * @param {import("..").FirebaseInstallationsTypes.Module} installations
+ * @param {boolean | undefined} forceRefresh
+ * @returns {Promise<string>}
+ */
+export function getToken(installations, forceRefresh) {
+  return firebase.app(installations.app.name).installations().getToken(forceRefresh);
+}
+
+/**
+ * @param {import("..").FirebaseInstallationsTypes.Module} installations
+ * @param {(string) => void} callback
+ * @returns {() => void}
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function onIdChange(installations, callback) {
+  throw new Error('onIdChange() is unsupported by the React Native Firebase SDK.');
+}

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/installations",
-  "version": "18.0.0",
+  "version": "18.2.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Installations",
   "main": "lib/index.js",
@@ -22,10 +22,10 @@
     "installations"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "18.0.0"
+    "@react-native-firebase/app": "18.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "db49dfeab62fa0c52530ccf2bfdfe9e27947bdbd"
+  "gitHead": "4c666df92028ddc3c0010a7ac102f54b600e6644"
 }