feat(firebase-ai): create `ai` package, `vertexai` wraps around it #8555

russellwheatley · 2025-06-03T09:18:50Z

Description

Moved the bulk of code to new ai package. Kept relevant types in vertexai package and deprecated them.
Updated implementation (where possible) to match firebase-js-sdk.
Updated mocks to match latest implementation on vertexai-sdk-test-data repo which now segments responses from vertexai and googleai.
I did attempt to symlink ai into vertexai but nested symlinks within directories were not being packaged in dist/ so opted to make ai package a dependency which I think is a better way of doing it.
Created an ai example app for illustration and tested latest vertexai and ai implementations which surfaced a couple of subtle bugs that have been resolved.

Important

We need to do the same attribution as we did for vertexai for this pull request.
Double check what needs to be in the CHANGELOG for this release.

Related issues

Release Summary

Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
- Yes
My change supports the following platforms;
- Android
- iOS
- Other (macOS, web)
My change includes tests;
- e2e tests added or updated in packages/\*\*/e2e
- jest tests added or updated in packages/\*\*/__tests__
I have updated TypeScript types that are affected by my change.
This is a breaking change;
- Yes
- No

Test Plan

Think react-native-firebase is great? Please consider supporting the project with any of the below:

👉 Star this repo on GitHub ⭐️
👉 Follow React Native Firebase and Invertase on Twitter

vercel · 2025-06-03T09:18:55Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
react-native-firebase	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 6, 2025 8:53am

packages/app/lib/modular/index.d.ts

packages/ai/lib/index.ts

packages/ai/lib/methods/count-tokens.ts

packages/ai/lib/requests/request.ts

eslint.config.mjs

packages/ai/__tests__/api.test.ts

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

mikehardy · 2025-07-22T16:08:49Z

Looking into this one now for review - noticed Other tests were failing because TextEncoder implementation seems to be missing and is needed ? Unexpected as it seems that should have been failing for a while if so, but...okay

rebased to main and put an in situ implementation of the string -> uint8array conversion in the storage library and it passes locally, hopefully this goes green in CI - will finish the review later

Co-authored-by: Darren Ackers <[email protected]>

mikehardy

✅ Looks like all old comments are resolved
✅ LGTM and runs locally okay except windows and one comment nit

The windows thing has bothered me for a while - I made sure the repo was windows-capable for development a long time back and we have received some PRs from folks that only have access to windows machines - more common than you might think!

❓ Rather than moan about it and keep wishing, I ported the AI mock responses script to typescript and verified it works on windows and macOS now ✅ - added a commit there as well as a couple unit test plugin fixups for windows compliance

❓ I left one teeny tiny note on the param comment to a function - initializeApp - now that it has a new signature I think the comment needs an update

That - the update to the comment - is the only thing I can think of

If that's updated (could just commit the suggestion if it works?) and you like the AI test data git clone port, this is good to go for me

packages/app/lib/modular/index.js

Co-authored-by: Mike Hardy <[email protected]>

cynthiajoan · 2025-08-09T02:32:33Z

packages/ai/CHANGELOG.md

+The new Firebase AI Logic SDK provides **preview** support for the Gemini Developer API, including its free tier offering.
+Using the Firebase AI Logic SDK with the Vertex AI Gemini API is still generally available (GA).
+
+To start using the new SDK, import the `@react-native-firebase/ai` package and use the modular method `getAI()` to initialize. See details in the [migration guide](https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk).


I like the in general changelog. The only thing I think we would like to add, since RN is not listed in the official migration guide doc, we probably want to actually have the code change example here.

cynthiajoan · 2025-08-09T02:33:39Z

packages/ai/__tests__/api.test.ts

@@ -0,0 +1,112 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

cynthiajoan · 2025-08-09T02:33:56Z

packages/ai/__tests__/backend.test.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

cynthiajoan · 2025-08-09T02:35:51Z

packages/ai/__tests__/api.test.ts

Do we also want to add GoogleAI backend test cases as well?

cynthiajoan · 2025-08-09T02:36:37Z

packages/ai/__tests__/count-tokens.test.ts

@@ -0,0 +1,167 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

cynthiajoan · 2025-08-09T02:39:18Z

packages/ai/__tests__/count-tokens.test.ts

+
+  it('total tokens with modality details', async () => {
+    const mockResponse = getMockResponse(
+      BackendName.VertexAI,


for my education, we are having the fakeAPI backend set to googleAI, but in the getMockResponse we pass the backend as VertexAI, is that going to have any issue?

cynthiajoan · 2025-08-09T04:29:56Z

packages/ai/__tests__/googleai-mappers.test.ts

@@ -0,0 +1,365 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

cynthiajoan · 2025-08-09T04:33:22Z

packages/ai/lib/index.ts

@@ -0,0 +1,92 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

cynthiajoan · 2025-08-09T04:58:25Z

packages/ai/lib/models/ai-model.ts

@@ -0,0 +1,125 @@
+import { ApiSettings } from '../types/internal';


License header?

cynthiajoan · 2025-08-09T05:07:37Z

packages/ai/lib/models/index.ts

@@ -0,0 +1,2 @@
+export * from './ai-model';


Just wondering, do we need license header for index.ts?

cynthiajoan · 2025-08-09T05:08:25Z

packages/ai/lib/public-types.ts

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC


Suggested change

* Copyright 2024 Google LLC

* Copyright 2025 Google LLC

vercel bot had a problem deploying to Preview June 3, 2025 13:06 Failure

vercel bot had a problem deploying to Preview June 3, 2025 13:57 Failure

vercel bot deployed to Preview June 4, 2025 14:53 View deployment

vercel bot deployed to Preview June 5, 2025 13:53 View deployment

vercel bot deployed to Preview June 5, 2025 14:06 View deployment

russellwheatley changed the title ~~feat(firebase-ai): create ai package, vertexai to wrap around it~~ feat(firebase-ai): create ai package, vertexai wraps around it Jun 5, 2025

vercel bot deployed to Preview June 6, 2025 09:16 View deployment

vercel bot deployed to Preview June 6, 2025 10:02 View deployment

vercel bot deployed to Preview June 6, 2025 11:51 View deployment

vercel bot deployed to Preview June 6, 2025 11:57 View deployment

vercel bot deployed to Preview June 6, 2025 12:26 View deployment

vercel bot deployed to Preview June 6, 2025 13:22 View deployment

vercel bot deployed to Preview June 6, 2025 14:00 View deployment

russellwheatley marked this pull request as ready for review June 6, 2025 14:35

vercel bot had a problem deploying to Preview June 10, 2025 09:29 Failure

vercel bot deployed to Preview June 10, 2025 12:05 View deployment

russellwheatley requested a review from mikehardy June 23, 2025 08:41

Ehesp reviewed Jun 23, 2025

View reviewed changes

packages/app/lib/modular/index.d.ts Show resolved Hide resolved

vercel bot deployed to Preview June 24, 2025 15:17 View deployment

Lyokone reviewed Jul 1, 2025

View reviewed changes

packages/ai/lib/index.ts Show resolved Hide resolved

packages/ai/lib/index.ts Show resolved Hide resolved

packages/ai/lib/methods/count-tokens.ts Outdated Show resolved Hide resolved

packages/ai/lib/requests/request.ts Outdated Show resolved Hide resolved

russellwheatley requested review from Lyokone and Ehesp July 1, 2025 10:08

vercel bot deployed to Preview July 1, 2025 10:11 View deployment

dackers86 reviewed Jul 11, 2025

View reviewed changes

vercel bot deployed to Preview July 18, 2025 11:44 View deployment

vercel bot deployed to Preview July 21, 2025 14:58 View deployment

russellwheatley requested a review from dackers86 July 22, 2025 08:04

mikehardy force-pushed the firebase-ai branch from aeadc6c to 465d179 Compare July 22, 2025 16:07

russellwheatley and others added 13 commits August 5, 2025 17:12

docs(ai): write usage docs

fafbdcb

format

136fc0f

rm note

5676d59

scrub TODO

a899ebf

test: ensure all types are exported

63e06dc

chore: pr feedback

24a3466

chore: rm code comment

3c7ddfb

Apply suggestions from code review

ae726f7

Co-authored-by: Darren Ackers <[email protected]>

chore: finish string

0b40f34

fix(storage, other): work around missing TextEncoder implementation

a824a06

fix(windows): port prepare script to platform-independent typescript

6e075ce

test(windows): ignore iOS plugin tests on windows

3817e65

test(ai): add example app to list of example apps

db8e985

mikehardy force-pushed the firebase-ai branch from caef75a to db8e985 Compare August 5, 2025 22:14

vercel bot deployed to Preview August 5, 2025 22:18 View deployment

mikehardy approved these changes Aug 5, 2025

View reviewed changes

packages/app/lib/modular/index.js Outdated Show resolved Hide resolved

mikehardy added the Workflow: Pending Merge Waiting on CI or similar label Aug 6, 2025

Update packages/app/lib/modular/index.js

fae445d

Co-authored-by: Mike Hardy <[email protected]>

vercel bot deployed to Preview August 6, 2025 08:53 View deployment

cynthiajoan reviewed Aug 9, 2025

View reviewed changes

packages/ai/__tests__/api.test.ts

Copy link

cynthiajoan Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want to add GoogleAI backend test cases as well?

cynthiajoan reviewed Aug 9, 2025

View reviewed changes

packages/ai/lib/models/ai-model.ts

@@ -0,0 +1,125 @@

import { ApiSettings } from '../types/internal';

Copy link

cynthiajoan Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

License header?

cynthiajoan reviewed Aug 9, 2025

View reviewed changes

packages/ai/lib/models/index.ts

@@ -0,0 +1,2 @@

export * from './ai-model';

Copy link

cynthiajoan Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wondering, do we need license header for index.ts?

cynthiajoan reviewed Aug 9, 2025

View reviewed changes

		@@ -0,0 +1,125 @@
		import { ApiSettings } from '../types/internal';

feat(firebase-ai): create ai package, vertexai wraps around it #8555

Are you sure you want to change the base?

feat(firebase-ai): create ai package, vertexai wraps around it #8555

Uh oh!

Conversation

russellwheatley commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Important

Related issues

Release Summary

Checklist

Test Plan

Uh oh!

vercel bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mikehardy commented Jul 22, 2025

Uh oh!

mikehardy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feat(firebase-ai): create `ai` package, `vertexai` wraps around it #8555

feat(firebase-ai): create `ai` package, `vertexai` wraps around it #8555

russellwheatley commented Jun 3, 2025 •

edited

Loading

vercel bot commented Jun 3, 2025 •

edited

Loading

mikehardy left a comment •

edited

Loading