merge main feature branch

Author: hsubox76

.github/workflows/canary-deploy.yml

@@ -73,6 +73,7 @@ jobs:
         NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
         NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}}
         NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
+        NPM_TOKEN_VERTEX: ${{secrets.NPM_TOKEN_VERTEX}}
         NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
         NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
         NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

.github/workflows/prerelease-manual-deploy.yml

@@ -76,6 +76,7 @@ jobs:
             NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
             NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}}
             NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
+            NPM_TOKEN_VERTEX: ${{secrets.NPM_TOKEN_VERTEX}}
             NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
             NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
             NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

.github/workflows/release-prod.yml

@@ -86,6 +86,7 @@ jobs:
         NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
         NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}}
         NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
+        NPM_TOKEN_VERTEX: ${{secrets.NPM_TOKEN_VERTEX}}
         NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
         NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
         NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

.github/workflows/release-staging.yml

@@ -112,6 +112,7 @@ jobs:
         NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
         NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}}
         NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
+        NPM_TOKEN_VERTEX: ${{secrets.NPM_TOKEN_VERTEX}}
         NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
         NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
         NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

packages/vertexai/src/api.test.ts

@@ -17,11 +17,11 @@
 import { ModelParams } from './types';
 import { getGenerativeModel } from './api';
 import { expect } from 'chai';
-import { Vertex } from './public-types';
+import { VertexAI } from './public-types';
 import { GenerativeModel } from './models/generative-model';
 import { VertexError } from './errors';
 
-const fakeVertex: Vertex = {
+const fakeVertexAI: VertexAI = {
   app: {
     name: 'DEFAULT',
     automaticDataCollectionEnabled: true,
@@ -35,30 +35,30 @@ const fakeVertex: Vertex = {
 
 describe('Top level API', () => {
   it('getGenerativeModel throws if no model is provided', () => {
-    expect(() => getGenerativeModel(fakeVertex, {} as ModelParams)).to.throw(
+    expect(() => getGenerativeModel(fakeVertexAI, {} as ModelParams)).to.throw(
       VertexError.NO_MODEL
     );
   });
   it('getGenerativeModel throws if no apiKey is provided', () => {
     const fakeVertexNoApiKey = {
-      ...fakeVertex,
+      ...fakeVertexAI,
       app: { options: { projectId: 'my-project' } }
-    } as Vertex;
+    } as VertexAI;
     expect(() =>
       getGenerativeModel(fakeVertexNoApiKey, { model: 'my-model' })
     ).to.throw(VertexError.NO_API_KEY);
   });
   it('getGenerativeModel throws if no projectId is provided', () => {
     const fakeVertexNoProject = {
-      ...fakeVertex,
+      ...fakeVertexAI,
       app: { options: { apiKey: 'my-key' } }
-    } as Vertex;
+    } as VertexAI;
     expect(() =>
       getGenerativeModel(fakeVertexNoProject, { model: 'my-model' })
     ).to.throw(VertexError.NO_PROJECT_ID);
   });
   it('getGenerativeModel gets a GenerativeModel', () => {
-    const genModel = getGenerativeModel(fakeVertex, { model: 'my-model' });
+    const genModel = getGenerativeModel(fakeVertexAI, { model: 'my-model' });
     expect(genModel).to.be.an.instanceOf(GenerativeModel);
     expect(genModel.model).to.equal('publishers/google/models/my-model');
   });

packages/vertexai/src/api.ts

@@ -19,8 +19,8 @@ import { FirebaseApp, getApp, _getProvider } from '@firebase/app';
 import { Provider } from '@firebase/component';
 import { getModularInstance } from '@firebase/util';
 import { DEFAULT_LOCATION, VERTEX_TYPE } from './constants';
-import { VertexService } from './service';
-import { Vertex } from './public-types';
+import { VertexAIService } from './service';
+import { VertexAI } from './public-types';
 import { ERROR_FACTORY, VertexError } from './errors';
 import { ModelParams, RequestOptions } from './types';
 import { GenerativeModel } from './models/generative-model';
@@ -31,18 +31,20 @@ export { GenerativeModel };
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    [VERTEX_TYPE]: VertexService;
+    [VERTEX_TYPE]: VertexAIService;
   }
 }
 
 /**
- * Returns an {@link Vertex} instance for the given app.
+ * Returns an {@link VertexAI} instance for the given app.
  *
  * @public
  *
  * @param app - The {@link @firebase/app#FirebaseApp} to use.
  */
-export function getVertex(app: FirebaseApp = getApp()): Vertex {
+export function getVertexAI(
+  app: FirebaseApp = getApp()
+): VertexAI {
   app = getModularInstance(app);
   // Dependencies
   const vertexProvider: Provider<'vertex'> = _getProvider(app, VERTEX_TYPE);
@@ -53,7 +55,7 @@ export function getVertex(app: FirebaseApp = getApp()): Vertex {
 }
 
 export function getGenerativeModel(
-  vertex: Vertex,
+  vertex: VertexAI,
   modelParams: ModelParams,
   requestOptions?: RequestOptions
 ): GenerativeModel {

packages/vertexai/src/index.ts

@@ -22,7 +22,7 @@
  */
 
 import { registerVersion, _registerComponent } from '@firebase/app';
-import { VertexService } from './service';
+import { VertexAIService } from './service';
 import { VERTEX_TYPE } from './constants';
 import { Component, ComponentType } from '@firebase/component';
 import { name, version } from '../package.json';
@@ -41,7 +41,7 @@ function registerVertex(): void {
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
         const appCheckProvider = container.getProvider('app-check-internal');
-        return new VertexService(app, appCheckProvider);
+        return new VertexAIService(app, appCheckProvider);
       },
       ComponentType.PUBLIC
     ).setMultipleInstances(true)

packages/vertexai/src/models/generative-model.test.ts

@@ -16,9 +16,9 @@
  */
 import { expect } from 'chai';
 import { GenerativeModel } from './generative-model';
-import { Vertex } from '../public-types';
+import { VertexAI } from '../public-types';
 
-const fakeVertex: Vertex = {
+const fakeVertexAI: VertexAI = {
   app: {
     name: 'DEFAULT',
     automaticDataCollectionEnabled: true,
@@ -32,23 +32,23 @@ const fakeVertex: Vertex = {
 
 describe('GenerativeModel', () => {
   it('handles plain model name', () => {
-    const genModel = new GenerativeModel(fakeVertex, { model: 'my-model' });
+    const genModel = new GenerativeModel(fakeVertexAI, { model: 'my-model' });
     expect(genModel.model).to.equal('publishers/google/models/my-model');
   });
   it('handles models/ prefixed model name', () => {
-    const genModel = new GenerativeModel(fakeVertex, {
+    const genModel = new GenerativeModel(fakeVertexAI, {
       model: 'models/my-model'
     });
     expect(genModel.model).to.equal('publishers/google/models/my-model');
   });
   it('handles full model name', () => {
-    const genModel = new GenerativeModel(fakeVertex, {
+    const genModel = new GenerativeModel(fakeVertexAI, {
       model: 'publishers/google/models/my-model'
     });
     expect(genModel.model).to.equal('publishers/google/models/my-model');
   });
   it('handles prefixed tuned model name', () => {
-    const genModel = new GenerativeModel(fakeVertex, {
+    const genModel = new GenerativeModel(fakeVertexAI, {
       model: 'tunedModels/my-model'
     });
     expect(genModel.model).to.equal('tunedModels/my-model');

packages/vertexai/src/models/generative-model.ts

@@ -36,10 +36,10 @@ import {
 import { ChatSession } from '../methods/chat-session';
 import { countTokens } from '../methods/count-tokens';
 import { formatGenerateContentInput } from '../requests/request-helpers';
-import { Vertex } from '../public-types';
+import { VertexAI } from '../public-types';
 import { ERROR_FACTORY, VertexError } from '../errors';
 import { ApiSettings } from '../types/internal';
-import { VertexService } from '../service';
+import { VertexAIService } from '../service';
 
 /**
  * Class for generative model APIs.
@@ -54,23 +54,23 @@ export class GenerativeModel {
   tools?: Tool[];
 
   constructor(
-    vertex: Vertex,
+    vertexAI: VertexAI,
     modelParams: ModelParams,
     requestOptions?: RequestOptions
   ) {
-    if (!vertex.app?.options?.apiKey) {
+    if (!vertexAI.app?.options?.apiKey) {
       throw ERROR_FACTORY.create(VertexError.NO_API_KEY);
-    } else if (!vertex.app?.options?.projectId) {
+    } else if (!vertexAI.app?.options?.projectId) {
       throw ERROR_FACTORY.create(VertexError.NO_PROJECT_ID);
     } else {
       this._apiSettings = {
-        apiKey: vertex.app.options.apiKey,
-        project: vertex.app.options.projectId,
-        location: vertex.location
+        apiKey: vertexAI.app.options.apiKey,
+        project: vertexAI.app.options.projectId,
+        location: vertexAI.location
       };
-      if ((vertex as VertexService).appCheck) {
+      if ((vertexAI as VertexAIService).appCheck) {
         this._apiSettings.getAppCheckToken = () =>
-          (vertex as VertexService).appCheck!.getToken();
+          (vertexAI as VertexAIService).appCheck!.getToken();
       }
     }
     if (modelParams.model.includes('/')) {

packages/vertexai/src/public-types.ts

@@ -20,12 +20,12 @@ import { FirebaseApp } from '@firebase/app';
 export * from './types';
 
 /**
- * An instance of Firebase Vertex.
+ * An instance of Firebase Vertex AI.
  * @public
  */
-export interface Vertex {
+export interface VertexAI {
   /**
-   * The {@link @firebase/app#FirebaseApp} this {@link Vertex} instance is associated with.
+   * The {@link @firebase/app#FirebaseApp} this {@link VertexAI} instance is associated with.
    */
   app: FirebaseApp;
   location: string;