Skip to content

Convert Vertex AI to the AI package #3650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,146 changes: 915 additions & 231 deletions package-lock.json

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"@angular/router": "^19.0.0",
"@schematics/angular": "^19.0.0",
"esbuild": "^0.24.0",
"firebase": "^11.2.0",
"firebase": "11.8.0-20250512211235",
"firebase-functions": "^6.1.0",
"fs-extra": "^8.0.1",
"fuzzy": "^0.1.3",
Expand Down Expand Up @@ -120,5 +120,8 @@
"typescript": ">=5.5 <5.7",
"yaml": "^2.7.0"
},
"typings": "index.d.ts"
"typings": "index.d.ts",
"overrides": {
"firebase": "11.8.0-20250512211235"
}
}
79 changes: 79 additions & 0 deletions src/ai/ai.module.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import {
EnvironmentProviders,
InjectionToken,
Injector,
NgModule,
NgZone,
Optional,
makeEnvironmentProviders,
} from '@angular/core';
import { VERSION, ɵAngularFireSchedulers, ɵgetDefaultInstanceOf } from '@angular/fire';
import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
import { AppCheckInstances } from '@angular/fire/app-check';
import { AI as FirebaseAI } from 'firebase/ai';
import { registerVersion } from 'firebase/app';
import { AI, AIInstances, AI_PROVIDER_NAME } from './ai';

export const PROVIDED_AI_INSTANCES = new InjectionToken<AI[]>('angularfire2.ai-instances');

export function defaultAIInstanceFactory(provided: FirebaseAI[]|undefined, defaultApp: FirebaseApp) {
const defaultAI = ɵgetDefaultInstanceOf<FirebaseAI>(AI_PROVIDER_NAME, provided, defaultApp);
return defaultAI && new AI(defaultAI);
}

export function AIInstanceFactory(fn: (injector: Injector) => FirebaseAI) {
return (zone: NgZone, injector: Injector) => {
const ai = zone.runOutsideAngular(() => fn(injector));
return new AI(ai);
};
}

const AI_INSTANCES_PROVIDER = {
provide: AIInstances,
deps: [
[new Optional(), PROVIDED_AI_INSTANCES ],
]
};

const DEFAULT_AI_INSTANCE_PROVIDER = {
provide: AI,
useFactory: defaultAIInstanceFactory,
deps: [
[new Optional(), PROVIDED_AI_INSTANCES ],
FirebaseApp,
]
};

@NgModule({
providers: [
DEFAULT_AI_INSTANCE_PROVIDER,
AI_INSTANCES_PROVIDER,
]
})
export class AIModule {
constructor() {
registerVersion('angularfire', VERSION.full, 'ai');
}
}

export function provideAI(fn: (injector: Injector) => FirebaseAI, ...deps: any[]): EnvironmentProviders {
registerVersion('angularfire', VERSION.full, 'ai');

return makeEnvironmentProviders([
DEFAULT_AI_INSTANCE_PROVIDER,
AI_INSTANCES_PROVIDER,
{
provide: PROVIDED_AI_INSTANCES,
useFactory: AIInstanceFactory(fn),
multi: true,
deps: [
NgZone,
Injector,
ɵAngularFireSchedulers,
FirebaseApps,
[new Optional(), AppCheckInstances ],
...deps,
]
}
]);
}
38 changes: 38 additions & 0 deletions src/ai/ai.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { TestBed } from '@angular/core/testing';
import { AI, getAI, provideAI } from '@angular/fire/ai';
import { FirebaseApp, getApp, initializeApp, provideFirebaseApp } from '@angular/fire/app';
import { COMMON_CONFIG } from '../test-config';
import { rando } from '../utils';

describe('AI', () => {
let app: FirebaseApp;
let ai: AI;
let providedAI: AI;
let appName: string;

describe('single injection', () => {

beforeEach(() => {
appName = rando();
TestBed.configureTestingModule({
providers: [
provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
provideAI(() => {
providedAI = getAI(getApp(appName));
return providedAI;
}),
],
});
app = TestBed.inject(FirebaseApp);
ai = TestBed.inject(AI);
});

it('should be injectable', () => {
expect(providedAI).toBeTruthy();
expect(ai).toEqual(providedAI);
expect(ai.app).toEqual(app);
});

});

});
30 changes: 30 additions & 0 deletions src/ai/ai.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { ɵgetAllInstancesOf } from '@angular/fire';
import { AI as FirebaseAI } from 'firebase/ai';
import { from, timer } from 'rxjs';
import { concatMap, distinct } from 'rxjs/operators';

// see notes in core/firebase.app.module.ts for why we're building the class like this
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface AI extends FirebaseAI {}

export class AI {
constructor(ai: FirebaseAI) {
return ai;
}
}

export const AI_PROVIDER_NAME = 'AI';

// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface AIInstances extends Array<FirebaseAI> {}

export class AIInstances {
constructor() {
return ɵgetAllInstancesOf<FirebaseAI>(AI_PROVIDER_NAME);
}
}

export const AIInstance$ = timer(0, 300).pipe(
concatMap(() => from(ɵgetAllInstancesOf<FirebaseAI>(AI_PROVIDER_NAME))),
distinct(),
);
14 changes: 14 additions & 0 deletions src/ai/firebase.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions src/ai/ng-package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"lib": {
"entryFile": "public_api.ts"
}
}
3 changes: 3 additions & 0 deletions src/ai/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"$schema": "../../node_modules/ng-packagr/package.schema.json"
}
3 changes: 3 additions & 0 deletions src/ai/public_api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export { AI, AIInstances, AIInstance$ } from './ai';
export { provideAI, AIModule } from './ai.module';
export * from './firebase';
2 changes: 1 addition & 1 deletion src/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"@angular/platform-server": { "optional": true }
},
"dependencies": {
"firebase": "^11.2.0",
"firebase": "^11.8.0",
"rxfire": "^6.1.0",
"@angular-devkit/schematics": "^19.0.0",
"@schematics/angular": "^19.0.0",
Expand Down
4 changes: 4 additions & 0 deletions src/vertexai/firebase.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tools/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ ${exportedZoneWrappedFns}
await writeFile(filePath, fileOutput);
};
return Promise.all([
reexport('ai', 'firebase', 'firebase/ai', tsKeys<typeof import('firebase/ai')>()),
reexport('analytics', 'firebase', 'firebase/analytics', tsKeys<typeof import('firebase/analytics')>(), {
isSupported: { blockUntilFirst: false },
logEvent: { blockUntilFirst: false, logLevel: LogLevel.VERBOSE },
Expand Down