refactor: remove vertexai code and wrap around firebase ai package

Author: russellwheatley

packages/ai/lib/index.ts

@@ -19,21 +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 } from './public-types';
+import { AI, AIOptions, VertexAI, VertexAIOptions } from './public-types';
 import { AIError } from './errors';
 import { GenerativeModel } from './models/generative-model';
 export { ChatSession } from './methods/chat-session';
+
 export * from './requests/schema-builder';
+export * from './types';
+export * from './backend';
 
-export {
-  GenerativeModel,
-  AIError,
-  AIErrorCode,
-  ModelParams,
-  RequestOptions,
-  GoogleAIBackend,
-  VertexAIBackend,
-};
+export { GenerativeModel, AIError, VertexAI, VertexAIOptions };
 
 /**
  * Returns the default {@link AI} instance that is associated with the provided

packages/ai/lib/public-types.ts

@@ -155,3 +155,27 @@ 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

@@ -102,3 +102,75 @@ 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/lib/constants.ts

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

packages/vertexai/lib/errors.ts

@@ -24,16 +24,15 @@ import {
   GenerativeModel,
   RequestOptions,
   ModelParams,
+  VertexAIErrorCode,
+  VertexAIError,
+  VertexAI,
+  VertexAIOptions,
 } from '@react-native-firebase/ai';
-import { VertexAIErrorCode } from './types';
 import { DEFAULT_LOCATION } from './constants';
-import { VertexAI, VertexAIOptions } from './public-types';
-import { VertexAIError } from './errors';
 import { VertexAIService } from './service';
-export { ChatSession } from './methods/chat-session';
-export * from './requests/schema-builder';
 
-export { VertexAIError };
+export * from '@react-native-firebase/ai';
 
 /**
  * Returns a <code>{@link VertexAI}</code> instance for the given app.