@react-native-firebase/perf 24.1.1 → 25.0.0

package/lib/types/namespaced.ts

@@ -0,0 +1,162 @@
+/*
+ * 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 Performance Monitoring package for React Native.
+ *
+ * #### Example 1
+ *
+ * Access the firebase export from the `perf` package:
+ *
+ * ```js
+ * import { firebase } from '@react-native-firebase/perf';
+ *
+ * // firebase.perf().X
+ * ```
+ *
+ * #### Example 2
+ *
+ * Using the default export from the `perf` package:
+ *
+ * ```js
+ * import perf from '@react-native-firebase/perf';
+ *
+ * // perf().X
+ * ```
+ *
+ * #### Example 3
+ *
+ * Using the default export from the `app` package:
+ *
+ * ```js
+ * import firebase from '@react-native-firebase/app';
+ * import '@react-native-firebase/perf';
+ *
+ * // firebase.perf().X
+ * ```
+ *
+ * @firebase perf
+ */
+/**
+ * @deprecated Use the modular type exports from `@react-native-firebase/perf` instead.
+ * `FirebasePerformanceTypes` is kept for backwards compatibility with the namespaced API.
+ */
+/* eslint-disable @typescript-eslint/no-namespace */
+export namespace FirebasePerformanceTypes {
+  type FirebaseModule = ReactNativeFirebase.FirebaseModule;
+
+  /**
+   * @deprecated Use the `HttpMethod` type from the modular package exports instead.
+   */
+  export type HttpMethod =
+    | 'GET'
+    | 'HEAD'
+    | 'PUT'
+    | 'POST'
+    | 'PATCH'
+    | 'TRACE'
+    | 'DELETE'
+    | 'CONNECT'
+    | 'OPTIONS';
+
+  /**
+   * @deprecated Use the `PerformanceTrace` type from the modular package exports instead.
+   */
+  export interface Trace {
+    getAttribute(attribute: string): string | undefined;
+    putAttribute(attribute: string, value: string): void;
+    getMetric(metricName: string): number;
+    getMetrics(): { [key: string]: number };
+    putMetric(metricName: string, value: number): void;
+    incrementMetric(metricName: string, incrementBy?: number): void;
+    removeMetric(metricName: string): void;
+    start(): Promise<null>;
+    stop(): Promise<null>;
+  }
+
+  /**
+   * @deprecated Use the `ScreenTrace` type from the modular package exports instead.
+   */
+  export interface ScreenTrace {
+    start(): Promise<null>;
+    stop(): Promise<null>;
+  }
+
+  /**
+   * @deprecated Use the `HttpMetric` type from the modular package exports instead.
+   */
+  export interface HttpMetric {
+    getAttribute(attribute: string): string | undefined;
+    getAttributes(): { [key: string]: string };
+    putAttribute(attribute: string, value: string): void;
+    removeAttribute(attribute: string): void;
+    setHttpResponseCode(code: number | null): void;
+    setRequestPayloadSize(bytes: number | null): void;
+    setResponsePayloadSize(bytes: number | null): void;
+    setResponseContentType(contentType: string | null): void;
+    start(): Promise<null>;
+    stop(): Promise<null>;
+  }
+
+  /**
+   * @deprecated Use static exports from the package root instead.
+   */
+  export interface Statics {
+    SDK_VERSION: string;
+  }
+
+  /**
+   * @deprecated Use the `FirebasePerformance` type from the modular package exports instead.
+   */
+  export interface Module extends FirebaseModule {
+    app: ReactNativeFirebase.FirebaseApp;
+    isPerformanceCollectionEnabled: boolean;
+    instrumentationEnabled: boolean;
+    dataCollectionEnabled: boolean;
+    /**
+     * @deprecated prefer setting `dataCollectionEnabled = boolean`.
+     */
+    setPerformanceCollectionEnabled(enabled: boolean): Promise<null>;
+    newTrace(identifier: string): Trace;
+    startTrace(identifier: string): Promise<Trace>;
+    newScreenTrace(identifier: string): ScreenTrace;
+    startScreenTrace(identifier: string): Promise<ScreenTrace>;
+    newHttpMetric(url: string, httpMethod: HttpMethod): HttpMetric;
+  }
+}
+/* eslint-enable @typescript-eslint/no-namespace */
+
+/**
+ * Attach namespace to `firebase.` and `FirebaseApp.`.
+ */
+declare module '@react-native-firebase/app' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace ReactNativeFirebase {
+    import FirebaseModuleWithStatics = ReactNativeFirebase.FirebaseModuleWithStatics;
+    interface Module {
+      perf: FirebaseModuleWithStatics<
+        FirebasePerformanceTypes.Module,
+        FirebasePerformanceTypes.Statics
+      >;
+    }
+    interface FirebaseApp {
+      perf(): FirebasePerformanceTypes.Module;
+    }
+  }
+}

package/lib/types/perf.ts

@@ -0,0 +1,99 @@
+/*
+ * 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';
+
+/**
+ * Configuration options for Performance Monitoring (aligned with {@link https://firebase.google.com/docs/reference/js/performance.performancesettings | PerformanceSettings} in the Firebase JS SDK).
+ */
+export interface PerformanceSettings {
+  /** Whether to collect custom events. */
+  dataCollectionEnabled?: boolean;
+  /** Whether to collect out-of-the-box events. */
+  instrumentationEnabled?: boolean;
+}
+
+/**
+ * Valid HTTP methods for HTTP metrics.
+ */
+export type HttpMethod =
+  | 'GET'
+  | 'HEAD'
+  | 'PUT'
+  | 'POST'
+  | 'PATCH'
+  | 'TRACE'
+  | 'DELETE'
+  | 'CONNECT'
+  | 'OPTIONS';
+
+/**
+ * A performance trace (aligned with {@link https://firebase.google.com/docs/reference/js/performance.performancetrace | PerformanceTrace} in the Firebase JS SDK).
+ *
+ * @remarks React Native uses async `start`/`stop` (native bridge). The web SDK uses synchronous `start`/`stop`. React Native also exposes `getMetrics` and `removeMetric`, which are not on the web `PerformanceTrace` type.
+ */
+export interface PerformanceTrace {
+  getAttribute(attr: string): string | undefined;
+  putAttribute(attr: string, value: string): void;
+  getMetric(metricName: string): number;
+  getMetrics(): { [key: string]: number };
+  putMetric(metricName: string, num: number): void;
+  incrementMetric(metricName: string, num?: number): void;
+  removeMetric(metricName: string): void;
+  start(): Promise<null>;
+  stop(): Promise<null>;
+}
+
+/**
+ * Screen trace for slow/frozen frames (React Native).
+ */
+export interface ScreenTrace {
+  start(): Promise<null>;
+  stop(): Promise<null>;
+}
+
+/**
+ * Network request metric (React Native; not part of the web Performance modular surface).
+ */
+export interface HttpMetric {
+  getAttribute(attr: string): string | undefined;
+  getAttributes(): { [key: string]: string };
+  putAttribute(attr: string, value: string): void;
+  removeAttribute(attr: string): void;
+  setHttpResponseCode(code: number | null): void;
+  setRequestPayloadSize(bytes: number | null): void;
+  setResponsePayloadSize(bytes: number | null): void;
+  setResponseContentType(contentType: string | null): void;
+  start(): Promise<null>;
+  stop(): Promise<null>;
+}
+
+/**
+ * Firebase Performance Monitoring service (aligned with {@link https://firebase.google.com/docs/reference/js/performance.firebaseperformance | FirebasePerformance} in the Firebase JS SDK).
+ *
+ * @remarks React Native adds collection/read APIs backed by native (`isPerformanceCollectionEnabled`, custom traces, HTTP metrics, screen traces).
+ */
+export interface FirebasePerformance {
+  /** The FirebaseApp this Performance instance is associated with. */
+  app: FirebaseApp;
+  /** Controls logging of automatic traces and HTTP/S network monitoring. */
+  instrumentationEnabled: boolean;
+  /** Controls logging of custom traces. */
+  dataCollectionEnabled: boolean;
+  /** Whether performance data collection is enabled for this app instance (native). */
+  isPerformanceCollectionEnabled: boolean;
+}

package/lib/version.ts

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

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@react-native-firebase/perf",
-  "version": "24.1.1",
+  "version": "25.0.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",
-  "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",
     "build:plugin": "rimraf plugin/build && tsc --build plugin",
+    "compile": "bob build",
     "lint:plugin": "eslint plugin/src/*",
-    "prepare": "yarn run build && yarn run build:plugin"
+    "prepare": "yarn run build && yarn compile && yarn run build:plugin"
   },
   "repository": {
     "type": "git",
@@ -29,11 +30,12 @@
     "performance monitoring"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "24.1.1",
+    "@react-native-firebase/app": "25.0.0",
     "expo": ">=47.0.0"
   },
   "devDependencies": {
-    "expo": "^55.0.5"
+    "expo": "^55.0.18",
+    "react-native-builder-bob": "^0.40.13"
   },
   "peerDependenciesMeta": {
     "expo": {
@@ -44,5 +46,35 @@
     "access": "public",
     "provenance": true
   },
-  "gitHead": "ea699f0bbcc98d25eebea4bfbe88cf1e9f2d0107"
+  "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/plugin/tsconfig.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "outDir": "build",
     "rootDir": "src",
-    "declaration": true
+    "declaration": true,
+    "types": ["react-native", "node"]
   },
   "include": ["./src"]
 }

package/plugin/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/android/applyPlugin.ts","./src/android/buildscriptDependency.ts","./src/android/constants.ts","./src/android/index.ts"],"version":"5.9.3"}
+{"root":["./src/index.ts","./src/android/applyPlugin.ts","./src/android/buildscriptDependency.ts","./src/android/constants.ts","./src/android/index.ts"],"version":"6.0.3"}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "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/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": ["../app/dist/typescript/lib/internal"],
+      "@react-native-firebase/app": ["../app/dist/typescript/lib"],
+      "@react-native-firebase/app/dist/module/types/internal": [
+        "../app/dist/typescript/lib/types/internal"
+      ]
+    }
+  },
+  "include": ["lib/**/*"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
+}

package/typedoc.json

@@ -1,5 +1,5 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["lib/index.d.ts"],
-  "intentionallyNotExported": ["PerfNamespace"]
+  "entryPoints": ["lib/modular.ts", "lib/types/perf.ts"],
+  "tsconfig": "tsconfig.json"
 }