refactor: make ai dependency on vertexai

Author: russellwheatley

packages/ai/lib/constants.ts

@@ -19,8 +19,6 @@ import { version } from './version';
 
 export const AI_TYPE = 'AI';
 
-export const VERTEX_TYPE = 'vertexAI';
-
 export const DEFAULT_LOCATION = 'us-central1';
 
 export const DEFAULT_BASE_URL = 'https://firebasevertexai.googleapis.com';

packages/ai/lib/errors.ts

@@ -26,9 +26,9 @@ import { AI_TYPE } from './constants';
  */
 export class AIError extends FirebaseError {
   /**
-   * Constructs a new instance of the `VertexAIError` class.
+   * Constructs a new instance of the `AIError` class.
    *
-   * @param code - The error code from <code>{@link VertexAIErrorCode}</code>.
+   * @param code - The error code from <code>{@link AIErrorCode}</code>.
    * @param message - A human-readable message describing the error.
    * @param customErrorData - Optional error data.
    */

packages/ai/lib/index.ts

@@ -19,16 +19,16 @@ import './polyfills';
 import { getApp, ReactNativeFirebase } from '@react-native-firebase/app';
 import { GoogleAIBackend, VertexAIBackend } from './backend';
 import { AIErrorCode, ModelParams, RequestOptions } from './types';
-import { AI, AIOptions, VertexAI, VertexAIOptions } from './public-types';
+import { AI, AIOptions } from './public-types';
 import { AIError } from './errors';
 import { GenerativeModel } from './models/generative-model';
-export { ChatSession } from './methods/chat-session';
+import { AIModel } from './models/ai-model';
 
+export * from './public-types';
+export { ChatSession } from './methods/chat-session';
 export * from './requests/schema-builder';
-export * from './types';
-export * from './backend';
-
-export { GenerativeModel, AIError, VertexAI, VertexAIOptions };
+export { GoogleAIBackend, VertexAIBackend } from './backend';
+export { GenerativeModel, AIError, AIModel };
 
 /**
  * Returns the default {@link AI} instance that is associated with the provided

packages/ai/lib/public-types.ts

@@ -21,30 +21,6 @@ import { FirebaseAppCheckTypes } from '@react-native-firebase/app-check';
 
 export * from './types';
 
-/**
- * An instance of the Vertex AI in Firebase SDK.
- * @public
- */
-export interface VertexAI {
-  /**
-   * The {@link @firebase/app#FirebaseApp} this <code>{@link VertexAI}</code> instance is associated with.
-   */
-  app: ReactNativeFirebase.FirebaseApp;
-  location: string;
-  appCheck?: FirebaseAppCheckTypes.Module | null;
-  auth?: FirebaseAuthTypes.Module | null;
-}
-
-/**
- * Options when initializing the Vertex AI in Firebase SDK.
- * @public
- */
-export interface VertexAIOptions {
-  location?: string;
-  appCheck?: FirebaseAppCheckTypes.Module | null;
-  auth?: FirebaseAuthTypes.Module | null;
-}
-
 /**
  * Options for initializing the AI service using {@link getAI | getAI()}.
  * This allows specifying which backend to use (Vertex AI Gemini API or Gemini Developer API)
@@ -142,6 +118,8 @@ export interface AI {
    * The {@link @firebase/app#FirebaseApp} this {@link AI} instance is associated with.
    */
   app: ReactNativeFirebase.FirebaseApp;
+  appCheck?: FirebaseAppCheckTypes.Module | null;
+  auth?: FirebaseAuthTypes.Module | null;
   /**
    * A {@link Backend} instance that specifies the configuration for the target backend,
    * either the Gemini Developer API (using {@link GoogleAIBackend}) or the
@@ -155,27 +133,3 @@ export interface AI {
    */
   location: string;
 }
-
-/**
- * An instance of the Vertex AI in Firebase SDK.
- * @public
- */
-export interface VertexAI {
-  /**
-   * The {@link @firebase/app#FirebaseApp} this <code>{@link VertexAI}</code> instance is associated with.
-   */
-  app: ReactNativeFirebase.FirebaseApp;
-  location: string;
-  appCheck?: FirebaseAppCheckTypes.Module | null;
-  auth?: FirebaseAuthTypes.Module | null;
-}
-
-/**
- * Options when initializing the Vertex AI in Firebase SDK.
- * @public
- */
-export interface VertexAIOptions {
-  location?: string;
-  appCheck?: FirebaseAppCheckTypes.Module | null;
-  auth?: FirebaseAuthTypes.Module | null;
-}

packages/ai/lib/types/error.ts

@@ -15,9 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseError } from '@firebase/util';
 import { GenerateContentResponse } from './responses';
-import { VERTEX_TYPE } from '../constants';
 
 /**
  * Details object that may be included in an error response.
@@ -104,75 +102,3 @@ export const enum AIErrorCode {
   /** An error occurred due an attempt to use an unsupported feature. */
   UNSUPPORTED = 'unsupported',
 }
-
-/**
- * Standardized error codes that <code>{@link VertexAIError}</code> can have.
- *
- * @public
- */
-export const enum VertexAIErrorCode {
-  /** A generic error occurred. */
-  ERROR = 'error',
-
-  /** An error occurred in a request. */
-  REQUEST_ERROR = 'request-error',
-
-  /** An error occurred in a response. */
-  RESPONSE_ERROR = 'response-error',
-
-  /** An error occurred while performing a fetch. */
-  FETCH_ERROR = 'fetch-error',
-
-  /** An error associated with a Content object.  */
-  INVALID_CONTENT = 'invalid-content',
-
-  /** An error due to the Firebase API not being enabled in the Console. */
-  API_NOT_ENABLED = 'api-not-enabled',
-
-  /** An error due to invalid Schema input.  */
-  INVALID_SCHEMA = 'invalid-schema',
-
-  /** An error occurred due to a missing Firebase API key. */
-  NO_API_KEY = 'no-api-key',
-
-  /** An error occurred due to a model name not being specified during initialization. */
-  NO_MODEL = 'no-model',
-
-  /** An error occurred due to a missing project ID. */
-  NO_PROJECT_ID = 'no-project-id',
-
-  /** An error occurred while parsing. */
-  PARSE_FAILED = 'parse-failed',
-}
-
-/**
- * Error class for the Vertex AI in Firebase SDK.
- *
- * @public
- */
-export class VertexAIError extends FirebaseError {
-  /**
-   * Constructs a new instance of the `VertexAIError` class.
-   *
-   * @param code - The error code from <code>{@link VertexAIErrorCode}</code>.
-   * @param message - A human-readable message describing the error.
-   * @param customErrorData - Optional error data.
-   */
-  constructor(
-    readonly code: VertexAIErrorCode,
-    message: string,
-    readonly customErrorData?: CustomErrorData,
-  ) {
-    // Match error format used by FirebaseError from ErrorFactory
-    const service = VERTEX_TYPE;
-    const serviceName = 'VertexAI';
-    const fullCode = `${service}/${code}`;
-    const fullMessage = `${serviceName}: ${message} (${fullCode})`;
-    super(code, fullMessage);
-
-    Object.setPrototypeOf(this, VertexAIError.prototype);
-
-    // Since Error is an interface, we don't inherit toString and so we define it ourselves.
-    this.toString = () => fullMessage;
-  }
-}

packages/vertexai/__tests__/backwards-compatbility.test.ts

@@ -0,0 +1,83 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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 { describe, expect, it } from '@jest/globals';
+import {
+  AIError,
+  AIModel,
+  GenerativeModel,
+  VertexAIError,
+  VertexAIErrorCode,
+  VertexAIModel,
+  VertexAI,
+  getGenerativeModel,
+} from '../lib/index';
+import { AI, AIErrorCode } from '@react-native-firebase/ai';
+import { VertexAIBackend } from '@react-native-firebase/ai';
+import { ReactNativeFirebase } from '@react-native-firebase/app';
+
+function assertAssignable<T, _U extends T>(): void {}
+
+const fakeAI: AI = {
+  app: {
+    name: 'DEFAULT',
+    automaticDataCollectionEnabled: true,
+    options: {
+      apiKey: 'key',
+      projectId: 'my-project',
+      appId: 'app-id',
+    },
+  } as ReactNativeFirebase.FirebaseApp,
+  backend: new VertexAIBackend('us-central1'),
+  location: 'us-central1',
+};
+
+const fakeVertexAI: VertexAI = fakeAI;
+
+describe('backwards-compatible types', function () {
+  it('AI is backwards compatible with VertexAI', function () {
+    assertAssignable<VertexAI, AI>();
+  });
+
+  it('AIError is backwards compatible with VertexAIError', function () {
+    assertAssignable<typeof VertexAIError, typeof AIError>();
+    const err = new VertexAIError(VertexAIErrorCode.ERROR, '');
+    expect(err).toBeInstanceOf(AIError);
+    expect(err).toBeInstanceOf(VertexAIError);
+  });
+
+  it('AIErrorCode is backwards compatible with VertexAIErrorCode', () => {
+    assertAssignable<VertexAIErrorCode, AIErrorCode>();
+    const errCode = AIErrorCode.ERROR;
+    expect(errCode).toBe(VertexAIErrorCode.ERROR);
+  });
+
+  it('AIModel is backwards compatible with VertexAIModel', () => {
+    assertAssignable<typeof VertexAIModel, typeof AIModel>();
+
+    const model = new GenerativeModel(fakeAI, { model: 'model-name' });
+    expect(model).toBeInstanceOf(AIModel);
+    expect(model).toBeInstanceOf(VertexAIModel);
+  });
+
+  describe('backward-compatible functions', () => {
+    it('getGenerativeModel', () => {
+      const model = getGenerativeModel(fakeVertexAI, { model: 'model-name' });
+      expect(model).toBeInstanceOf(AIModel);
+      expect(model).toBeInstanceOf(VertexAIModel);
+    });
+  });
+});

packages/vertexai/lib/ai-symlink

@@ -15,24 +15,23 @@
  * limitations under the License.
  */
 
-import './polyfills';
 import { getApp, ReactNativeFirebase } from '@react-native-firebase/app';
-import {
-  getGenerativeModel as getGenerativeModelFromAI,
-  getAI,
-  VertexAIBackend,
-  GenerativeModel,
-  RequestOptions,
-  ModelParams,
-  VertexAIErrorCode,
-  VertexAIError,
-  VertexAI,
-  VertexAIOptions,
-} from './ai-symlink/index';
-import { DEFAULT_LOCATION } from './ai-symlink/constants';
-import { VertexAIService } from './service';
+import { VertexAIBackend, AIModel, AIError, AIErrorCode } from '@react-native-firebase/ai';
+import { VertexAIOptions, VertexAI } from './public-types';
+export * from './public-types';
+export * from '@react-native-firebase/ai';
+
+const DEFAULT_LOCATION = 'us-central1';
 
 /**
+ * @deprecated Use the new {@link getAI | getAI()} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
+ *
+ * Returns a {@link VertexAI} instance for the given app, configured to use the
+ * Vertex AI Gemini API. This instance will be
+ * configured to use the Vertex AI Gemini API.
+ *
  * Returns a <code>{@link VertexAI}</code> instance for the given app.
  *
  * @public
@@ -51,30 +50,31 @@ export function getVertexAI(
     location: options?.location || DEFAULT_LOCATION,
     appCheck: options?.appCheck || null,
     auth: options?.auth || null,
-  } as VertexAIService;
+    backend: new VertexAIBackend(options?.location || DEFAULT_LOCATION),
+  };
 }
 
 /**
- * Returns a <code>{@link GenerativeModel}</code> class with methods for inference
- * and other functionality.
+ * @deprecated Use the new {@link AIModel} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
+ *
+ * Base class for Firebase AI model APIs.
  *
  * @public
  */
-export function getGenerativeModel(
-  vertexAI: VertexAI,
-  modelParams: ModelParams,
-  requestOptions?: RequestOptions,
-): GenerativeModel {
-  if (!modelParams.model) {
-    throw new VertexAIError(
-      VertexAIErrorCode.NO_MODEL,
-      `Must provide a model name. Example: getGenerativeModel({ model: 'my-model-name' })`,
-    );
-  }
+export const VertexAIModel = AIModel;
 
-  const ai = getAI(vertexAI.app, {
-    backend: new VertexAIBackend(vertexAI.location),
-  });
+/**
+ * @deprecated Use the new {@link AIError} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
+ *
+ * Error class for the Firebase AI SDK.
+ *
+ * @public
+ */
+export const VertexAIError = AIError;
 
-  return getGenerativeModelFromAI(ai, modelParams, requestOptions);
-}
+export { AIErrorCode as VertexAIErrorCode };
+export { VertexAIBackend, AIModel, AIError };