Skip to content

Prepare for public preview release #8214

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 9 commits into from
May 6, 2024

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented May 2, 2024

  • Rename package (@firebase/) and top level entry point (firebase/) from "vertexai" to "vertexai-preview".
  • Fix any missed renames from "vertex" to "vertexAI"
  • Add NPM token for the new package to the 3 workflows that do NPM publishes (already added to Github secrets)
  • Add api-report npm script so that it will be picked up by the docgen process (will generate docs in a separate PR)
  • Fix comments flagged by api-documenter process
  • Add changeset (set vertexai-preview version to 0.0.0 and allow changesets to patch bump it to 0.0.1 on publish). Note the changeset will apply to the whole ch-vertex-feature branch being merged into master, so that's why it includes @firebase/app.

I did not rename the directory packages/vertexai because I didn't want this PR to have a 140 file diff. It should be fine, the dirname isn't published to NPM.

Copy link

changeset-bot bot commented May 2, 2024

🦋 Changeset detected

Latest commit: 57f6c0b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
firebase Minor
@firebase/vertexai-preview Patch
@firebase/app Patch
@firebase/app-compat Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 2, 2024

Size Report 1

Affected Products

  • @firebase/app

    TypeBase (b981a45)Merge (a0a204a)Diff
    browser18.1 kB18.1 kB+8 B (+0.0%)
    esm523.7 kB23.7 kB+8 B (+0.0%)
    main24.8 kB24.8 kB+8 B (+0.0%)
    module18.1 kB18.1 kB+8 B (+0.0%)
  • @firebase/vertexai-preview

    TypeBase (b981a45)Merge (a0a204a)Diff
    browser?24.7 kB? (?)
    main?25.3 kB? (?)
    module?24.7 kB? (?)
  • bundle

    46 size changes

    TypeBase (b981a45)Merge (a0a204a)Diff
    analytics (logEvent)44.5 kB44.5 kB+8 B (+0.0%)
    app-check (CustomProvider)37.3 kB37.3 kB+8 B (+0.0%)
    app-check (ReCaptchaEnterpriseProvider)39.9 kB39.9 kB+8 B (+0.0%)
    app-check (ReCaptchaV3Provider)39.8 kB39.8 kB+8 B (+0.0%)
    auth (Anonymous)76.0 kB76.0 kB+8 B (+0.0%)
    auth (EmailAndPassword)84.3 kB84.3 kB+8 B (+0.0%)
    auth (GoogleFBTwitterGitHubPopup)103 kB103 kB+8 B (+0.0%)
    auth (GooglePopup)100 kB100 kB+8 B (+0.0%)
    auth (GoogleRedirect)101 kB101 kB+8 B (+0.0%)
    auth (Phone)86.7 kB86.7 kB+8 B (+0.0%)
    database (Append to a list of data)149 kB149 kB+8 B (+0.0%)
    database (Filtering data)148 kB148 kB+8 B (+0.0%)
    database (Listen for child events)164 kB164 kB+8 B (+0.0%)
    database (Listen for value events + Detach listeners)164 kB164 kB+8 B (+0.0%)
    database (Listen for value events)164 kB164 kB+8 B (+0.0%)
    database (Read data once)164 kB164 kB+8 B (+0.0%)
    database (Save data as transactions)166 kB166 kB+8 B (+0.0%)
    database (Sort data)149 kB150 kB+8 B (+0.0%)
    database (Write data)148 kB148 kB+8 B (+0.0%)
    firestore (CSI Auto Indexing Disable and Delete)270 kB270 kB+8 B (+0.0%)
    firestore (CSI Auto Indexing Enable)270 kB270 kB+8 B (+0.0%)
    firestore (Persistence)305 kB305 kB+8 B (+0.0%)
    firestore (Query Cursors)242 kB242 kB+8 B (+0.0%)
    firestore (Query)240 kB240 kB+8 B (+0.0%)
    firestore (Read data once)228 kB228 kB+8 B (+0.0%)
    firestore (Read Write w Persistence)325 kB325 kB+8 B (+0.0%)
    firestore (Realtime updates)230 kB230 kB+8 B (+0.0%)
    firestore (Transaction)207 kB207 kB+8 B (+0.0%)
    firestore (Write data)207 kB207 kB+8 B (+0.0%)
    firestore-lite (Query Cursors)89.8 kB89.8 kB+8 B (+0.0%)
    firestore-lite (Query)85.9 kB85.9 kB+8 B (+0.0%)
    firestore-lite (Read data once)62.1 kB62.1 kB+8 B (+0.0%)
    firestore-lite (Transaction)87.0 kB87.1 kB+8 B (+0.0%)
    firestore-lite (Write data)71.7 kB71.7 kB+8 B (+0.0%)
    functions (call)31.9 kB31.9 kB+8 B (+0.0%)
    messaging (send + receive)46.8 kB46.9 kB+8 B (+0.0%)
    performance (trace)51.7 kB51.7 kB+8 B (+0.0%)
    remote-config (getAndFetch)46.2 kB46.2 kB+8 B (+0.0%)
    storage (getBytes)42.0 kB42.0 kB+8 B (+0.0%)
    storage (getDownloadURL)44.1 kB44.1 kB+8 B (+0.0%)
    storage (getMetadata)43.5 kB43.5 kB+8 B (+0.0%)
    storage (list + listAll)42.9 kB43.0 kB+8 B (+0.0%)
    storage (updateMetadata)43.8 kB43.8 kB+8 B (+0.0%)
    storage (uploadBytes)48.6 kB48.7 kB+8 B (+0.0%)
    storage (uploadBytesResumable)58.6 kB58.6 kB+8 B (+0.0%)
    storage (uploadString)48.9 kB48.9 kB+8 B (+0.0%)

  • firebase

    TypeBase (b981a45)Merge (a0a204a)Diff
    firebase-app-compat.js31.4 kB31.4 kB+8 B (+0.0%)
    firebase-app.js102 kB102 kB+8 B (+0.0%)
    firebase-compat.js788 kB788 kB+8 B (+0.0%)
    firebase-performance-standalone-compat.es2017.js93.3 kB93.3 kB+8 B (+0.0%)
    firebase-performance-standalone-compat.js70.4 kB70.4 kB+8 B (+0.0%)
    firebase-vertexai-preview.js?18.9 kB? (?)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/KzZ6TZG932.html

@google-oss-bot
Copy link
Contributor

Size Analysis Report 1

This report is too large (176,140 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/Q4oaTTNdPg.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 2, 2024

Size Analysis Report 1

This report is too large (176,140 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/Wm3xXSbkhu.html

@hsubox76 hsubox76 marked this pull request as ready for review May 2, 2024 20:48
@hsubox76 hsubox76 requested review from a team as code owners May 2, 2024 20:48
@hsubox76 hsubox76 requested review from DellaBitta and dlarocque May 2, 2024 20:48
Copy link
Contributor

@DellaBitta DellaBitta left a comment

Choose a reason for hiding this comment

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

Approved with some nits and potential changes

"description": "A template package for new firebase packages",
"name": "@firebase/vertexai-preview",
"version": "0.0.0",
"description": "A Firebase SDK for VertexAI",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: maybe we should we note that it's a preview version here in the description?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added, hopefully we catch this string when we go GA!

@@ -45,20 +45,26 @@ declare module '@firebase/component' {
export function getVertexAI(app: FirebaseApp = getApp()): VertexAI {
app = getModularInstance(app);
// Dependencies
const vertexProvider: Provider<'vertex'> = _getProvider(app, VERTEX_TYPE);
const vertexProvider: Provider<'vertexAI'> = _getProvider(app, VERTEX_TYPE);
Copy link
Contributor

Choose a reason for hiding this comment

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

Could change Provider<`vertexAI`> to Provider<VERTEX_TYPE> here, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sadly I cannot, Typescript can't turn an actual code string into a string that you use for typing.

@@ -74,6 +74,11 @@ export interface GenerateContentResponse {
usageMetadata?: UsageMetadata;
}

/**
* Usage metadata about response.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit a response

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could even link to GenerateContentResponse, will do that.

@hsubox76 hsubox76 merged commit e12d91f into ch-vertex-feature May 6, 2024
40 of 41 checks passed
@hsubox76 hsubox76 deleted the ch-vertex-preview-prep branch May 6, 2024 19:55
@firebase firebase locked and limited conversation to collaborators Jun 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants