refactor(ml): align modular API with firebase-js-sdk

Author: russellwheatley

packages/ml/lib/index.ts

@@ -15,11 +15,11 @@
  *
  */
 
-export type { FirebaseML } from './types/ml';
+export * from './modular';
 
-export type { FirebaseMLTypes } from './types/namespaced';
+export type { FirebaseApp, FirebaseML } from './types/ml';
 
-export * from './modular';
+export type { FirebaseMLTypes } from './types/namespaced';
 
 export * from './namespaced';
 export { default } from './namespaced';

packages/ml/lib/modular.ts

@@ -16,15 +16,13 @@
  */
 
 import { getApp } from '@react-native-firebase/app';
-import type { FirebaseApp } from '@react-native-firebase/app';
-import type { FirebaseML } from './types/ml';
+import type { FirebaseApp, FirebaseML } from './types/ml';
 
 /**
- * Returns the existing default {@link FirebaseML} instance that is associated with the
- * default {@link @firebase/app!FirebaseApp}. If no instance exists, initializes a new
- * instance with default settings.
+ * Returns the {@link FirebaseML} instance for the default or given {@link FirebaseApp}.
  *
- * @returns The {@link FirebaseML} instance of the provided app.
+ * @param app - The Firebase `FirebaseApp` to use. When omitted, the default app is used.
+ * @returns The ML service instance for that app.
  */
 export function getML(app?: FirebaseApp): FirebaseML {
   if (app) {

packages/ml/lib/types/ml.ts

@@ -15,12 +15,18 @@
  *
  */
 
-import type { FirebaseApp } from '@react-native-firebase/app';
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+
+export type FirebaseApp = ReactNativeFirebase.FirebaseApp;
 
 /**
- * Firebase ML module instance for the modular API.
+ * Firebase ML service instance for the modular API.
+ *
+ * Current Firebase JS SDK releases do not ship a `firebase/ml` modular entry point; this interface
+ * follows the same modular service-instance pattern used elsewhere in React Native Firebase (see e.g.
+ * the Firestore package's `Firestore` type).
  */
-export interface FirebaseML {
+export interface FirebaseML extends ReactNativeFirebase.FirebaseModule {
   /** The FirebaseApp this module is associated with */
   app: FirebaseApp;
 }