@react-native-firebase/perf 20.3.0 → 20.4.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.4.0](https://github.com/invertase/react-native-firebase/compare/v20.3.0...v20.4.0) (2024-08-13)
+
+**Note:** Version bump only for package @react-native-firebase/perf
+
 ## [20.3.0](https://github.com/invertase/react-native-firebase/compare/v20.2.1...v20.3.0) (2024-07-19)
 
 **Note:** Version bump only for package @react-native-firebase/perf

package/lib/index.d.ts

@@ -552,6 +552,8 @@ export const firebase: ReactNativeFirebase.Module & {
 
 export default defaultExport;
 
+export * from './modular';
+
 /**
  * Attach namespace to `firebase.` and `FirebaseApp.`.
  */

package/lib/index.js

@@ -27,15 +27,6 @@ import Trace from './Trace';
 import ScreenTrace from './ScreenTrace';
 import version from './version';
 
-export {
-  getPerformance,
-  initializePerformance,
-  trace,
-  httpMetric,
-  newScreenTrace,
-  startScreenTrace,
-} from './modular/index';
-
 const statics = {};
 
 const namespace = 'perf';
@@ -175,6 +166,8 @@ export default createModuleNamespace({
   ModuleClass: FirebasePerfModule,
 });
 
+export * from './modular';
+
 // import perf, { firebase } from '@react-native-firebase/perf';
 // perf().X(...);
 // firebase.perf().X(...);

package/lib/modular/index.d.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 { FirebaseApp } from '@firebase/app-types';
+import { FirebasePerformanceTypes } from '..';
+
+import Performance = FirebasePerformanceTypes.Module;
+
+import Trace = FirebasePerformanceTypes.Module.Trace;
+import HttpMethod = FirebasePerformanceTypes.HttpMethod;
+import HttpMetric = FirebasePerformanceTypes.HttpMetric;
+import ScreenTrace = FirebasePerformanceTypes.ScreenTrace;
+
+/**
+ * Returns a Performance instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @returns {Performance}
+ */
+export function getPerformance(app?: FirebaseApp): Performance;
+
+type PerformanceSettings = {
+  dataCollectionEnabled: boolean;
+};
+
+/**
+ * Returns a Performance instance for the given app.
+ * @param app - FirebaseApp. Required.
+ * @param settings - PerformanceSettings. Set "dataCollectionEnabled" which will enable/disable Performance collection.
+ * @returns {Promise<Performance>}
+ */
+export function initializePerformance(
+  app: FirebaseApp,
+  settings: PerformanceSettings,
+): Promise<Performance>;
+
+/**
+ * Returns a Trace instance.
+ * @param perf - Performance instance.
+ * @param identifier - A String to identify the Trace instance.
+ * @returns {Trace}
+ */
+export function trace(perf: Performance, identifier: string): Trace;
+
+/**
+ * Returns a HttpMetric instance.
+ * @param perf - Performance instance.
+ * @param identifier - A String to identify the HttpMetric instance.
+ * @param httpMethod - The HTTP method for the HttpMetric instance.
+ * @returns {HttpMetric}
+ */
+export function httpMetric(
+  perf: Performance,
+  identifier: string,
+  httpMethod: HttpMethod,
+): HttpMetric;
+
+/**
+ * Creates a ScreenTrace instance with the given identifier.
+ * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
+ * @platform android Android !== 9.0.0 && Android !== 9.1.0
+ * @param perf - Performance instance.
+ * @param identifier - Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.
+ * @returns {ScreenTrace}
+ */
+export function newScreenTrace(perf: Performance, identifier: string): ScreenTrace;
+
+/**
+ * Creates a ScreenTrace instance with the given identifier and immediately starts it.
+ * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
+ * @platform android Android !== 9.0.0 && Android !== 9.1.0
+ * @param perf - Performance instance.
+ * @param identifier - Name of the screen.
+ * @returns {Promise<ScreenTrace>}
+ */
+export function startScreenTrace(perf: Performance, identifier: string): Promise<ScreenTrace>;

package/lib/modular/index.js

@@ -15,6 +15,14 @@
  *
  */
 
+/**
+ * @typedef {import('@firebase/app').FirebaseApp} FirebaseApp
+ * @typedef {import('..').FirebasePerformanceTypes.Module} Performance
+ * @typedef {import('..').FirebasePerformanceTypes.Trace} Trace
+ * @typedef {import('..').FirebasePerformanceTypes.ScreenTrace} ScreenTrace
+ * @typedef {import('..').FirebasePerformanceTypes.HttpMetric} HttpMetric
+ */
+
 import { isBoolean } from '@react-native-firebase/app/lib/common';
 import { firebase } from '..';
 
@@ -73,6 +81,7 @@ export function httpMetric(perf, identifier, httpMethod) {
  * @platform android Android !== 9.0.0 && Android !== 9.1.0
  * @param perf - Performance instance
  * @param identifier Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.
+ * @returns {ScreenTrace}
  */
 export function newScreenTrace(perf, identifier) {
   return perf.newScreenTrace(identifier);
@@ -83,6 +92,7 @@ export function newScreenTrace(perf, identifier) {
  * @platform android Android !== 9.0.0 && Android !== 9.1.0
  * @param perf - Performance instance
  * @param identifier Name of the screen
+ * @returns {Promise<ScreenTrace>}
  */
 export function startScreenTrace(perf, identifier) {
   return perf.startScreenTrace(identifier);

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/perf",
-  "version": "20.3.0",
+  "version": "20.4.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration with Performance Monitoring to gain insight into key performance characteristics within your React Native application.",
   "main": "lib/index.js",
@@ -29,7 +29,7 @@
     "performance monitoring"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "20.3.0",
+    "@react-native-firebase/app": "20.4.0",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a916b37b022cf40588fa0fd915b7ab901e2458d0"
+  "gitHead": "3ac3e9623674a8db52c111b4aa0a85a883260116"
 }