From 3883133c33ba48027081eef9d946988f33b07606 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 21 May 2024 13:59:51 -0700 Subject: [PATCH 1/5] Fix typings issue (#8256) --- .changeset/empty-windows-push.md | 5 +++++ packages/vertexai/package.json | 5 +++-- 2 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 .changeset/empty-windows-push.md diff --git a/.changeset/empty-windows-push.md b/.changeset/empty-windows-push.md new file mode 100644 index 00000000000..b6c64f14cca --- /dev/null +++ b/.changeset/empty-windows-push.md @@ -0,0 +1,5 @@ +--- +'@firebase/vertexai-preview': patch +--- + +Change `types` paths to point to rolled-up public `d.ts` files. This fixes some TypeScript compiler errors users are seeing. diff --git a/packages/vertexai/package.json b/packages/vertexai/package.json index ccf4fcca84e..05d4ffd85fb 100644 --- a/packages/vertexai/package.json +++ b/packages/vertexai/package.json @@ -11,7 +11,7 @@ "module": "dist/esm/index.esm2017.js", "exports": { ".": { - "types": "./dist/src/index.d.ts", + "types": "./dist/vertexai-preview-public.d.ts", "node": { "require": "./dist/index.cjs.js", "import": "./dist/esm/index.esm2017.js" @@ -37,7 +37,8 @@ "test": "run-p --npm-path npm lint test:browser", "test:ci": "yarn testsetup && node ../../scripts/run_tests_in_ci.js -s test", "test:browser": "yarn testsetup && karma start --single-run", - "api-report": "api-extractor run --local --verbose" + "api-report": "api-extractor run --local --verbose", + "typings:public": "node ../../scripts/build/use_typings.js ./dist/vertexai-preview-public.d.ts" }, "peerDependencies": { "@firebase/app": "0.x", From aa060a7f699accf9db895f5acb1dd73e497db9ba Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Wed, 22 May 2024 13:59:22 -0700 Subject: [PATCH 2/5] More robust clean up after unexpected docgen process exits. (#8260) --- scripts/docgen/docgen.ts | 65 ++++++++++++++++++++++++++++++++-------- 1 file changed, 52 insertions(+), 13 deletions(-) diff --git a/scripts/docgen/docgen.ts b/scripts/docgen/docgen.ts index 3f4d10ebbd9..314e42a7cfc 100644 --- a/scripts/docgen/docgen.ts +++ b/scripts/docgen/docgen.ts @@ -90,6 +90,50 @@ yargs .demandCommand() .help().argv; +process.on('exit', cleanup); +process.on('SIGINT', cleanup); + +let authApiReportOriginal: string; +let authApiConfigOriginal: string; + +function cleanup() { + try { + // Restore original auth api-extractor.json contents. + if (authApiReportOriginal) { + console.log(`Restoring original auth api-extractor.json contents.`); + fs.writeFileSync( + `${projectRoot}/packages/auth/api-extractor.json`, + authApiConfigOriginal + ); + } + // Restore original auth.api.md + if (authApiConfigOriginal) { + console.log(`Restoring original auth.api.md contents.`); + fs.writeFileSync( + `${projectRoot}/common/api-review/auth.api.md`, + authApiReportOriginal + ); + } + for (const excludedPackage of EXCLUDED_PACKAGES) { + if (fs.existsSync(`${projectRoot}/temp/${excludedPackage}.skip`)) { + console.log( + `Restoring json files for excluded package: ${excludedPackage}.` + ); + fs.renameSync( + `${projectRoot}/temp/${excludedPackage}.skip`, + `${projectRoot}/temp/${excludedPackage}.api.json` + ); + } + } + } catch (e) { + console.error( + 'Error cleaning up files on exit - ' + + 'check for temp modifications to md and json files.' + ); + console.error(e); + } +} + async function generateToc() { console.log(`Temporarily renaming excluded packages' json files.`); for (const excludedPackage of EXCLUDED_PACKAGES) { @@ -115,15 +159,7 @@ async function generateToc() { { stdio: 'inherit' } ); } finally { - console.log(`Restoring excluded packages' json files.`); - for (const excludedPackage of EXCLUDED_PACKAGES) { - if (fs.existsSync(`${projectRoot}/temp/${excludedPackage}.skip`)) { - fs.renameSync( - `${projectRoot}/temp/${excludedPackage}.skip`, - `${projectRoot}/temp/${excludedPackage}.api.json` - ); - } - } + cleanup(); } } @@ -137,12 +173,12 @@ async function generateDocs( console.log(`Temporarily modifying auth api-extractor.json for docgen.`); // Use a special d.ts file for auth for doc gen only. - const authApiConfigOriginal = fs.readFileSync( + authApiConfigOriginal = fs.readFileSync( `${projectRoot}/packages/auth/api-extractor.json`, 'utf8' ); // Save original auth.md as well. - const authApiReportOriginal = fs.readFileSync( + authApiReportOriginal = fs.readFileSync( `${projectRoot}/common/api-review/auth.api.md`, 'utf8' ); @@ -193,10 +229,13 @@ async function generateDocs( ); } - if (!fs.existsSync(tmpDir)) { - fs.mkdirSync(tmpDir); + if (fs.existsSync(tmpDir)) { + console.log(`Removing old json temp dir: ${tmpDir}.`); + fs.rmSync(tmpDir, { recursive: true, force: true }); } + fs.mkdirSync(tmpDir); + // TODO: Throw error if path doesn't exist once all packages add markdown support. const apiJsonDirectories = ( await mapWorkspaceToPackages([`${projectRoot}/packages/*`]) From 370b6c8b7fbeb742a36a0ea399dd5e6cf9fa6267 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 23 May 2024 10:01:24 -0400 Subject: [PATCH 3/5] Add toc (#8257) --- .gitignore | 1 - toc/toc.yaml | 555 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 555 insertions(+), 1 deletion(-) create mode 100644 toc/toc.yaml diff --git a/.gitignore b/.gitignore index e15c88b7ae7..ec2ca7e596e 100644 --- a/.gitignore +++ b/.gitignore @@ -91,7 +91,6 @@ tsdoc-metadata.json # generated html docs docs-rut/ docs/ -toc/ # generated Terraform docs .terraform/* diff --git a/toc/toc.yaml b/toc/toc.yaml new file mode 100644 index 00000000000..d6d5ff4a185 --- /dev/null +++ b/toc/toc.yaml @@ -0,0 +1,555 @@ +toc: + - title: firebase + path: /docs/reference/js/index + - title: analytics + path: /docs/reference/js/analytics.md + section: + - title: Analytics + path: /docs/reference/js/analytics.analytics.md + - title: AnalyticsCallOptions + path: /docs/reference/js/analytics.analyticscalloptions.md + - title: AnalyticsSettings + path: /docs/reference/js/analytics.analyticssettings.md + - title: ConsentSettings + path: /docs/reference/js/analytics.consentsettings.md + - title: ControlParams + path: /docs/reference/js/analytics.controlparams.md + - title: CustomParams + path: /docs/reference/js/analytics.customparams.md + - title: EventParams + path: /docs/reference/js/analytics.eventparams.md + - title: GtagConfigParams + path: /docs/reference/js/analytics.gtagconfigparams.md + - title: Item + path: /docs/reference/js/analytics.item.md + - title: Promotion + path: /docs/reference/js/analytics.promotion.md + - title: SettingsOptions + path: /docs/reference/js/analytics.settingsoptions.md + - title: app + path: /docs/reference/js/app.md + section: + - title: FirebaseApp + path: /docs/reference/js/app.firebaseapp.md + - title: FirebaseAppSettings + path: /docs/reference/js/app.firebaseappsettings.md + - title: FirebaseOptions + path: /docs/reference/js/app.firebaseoptions.md + - title: FirebaseServerApp + path: /docs/reference/js/app.firebaseserverapp.md + - title: FirebaseServerAppSettings + path: /docs/reference/js/app.firebaseserverappsettings.md + - title: app-check + path: /docs/reference/js/app-check.md + section: + - title: AppCheck + path: /docs/reference/js/app-check.appcheck.md + - title: AppCheckOptions + path: /docs/reference/js/app-check.appcheckoptions.md + - title: AppCheckToken + path: /docs/reference/js/app-check.appchecktoken.md + - title: AppCheckTokenResult + path: /docs/reference/js/app-check.appchecktokenresult.md + - title: CustomProvider + path: /docs/reference/js/app-check.customprovider.md + - title: CustomProviderOptions + path: /docs/reference/js/app-check.customprovideroptions.md + - title: ReCaptchaEnterpriseProvider + path: /docs/reference/js/app-check.recaptchaenterpriseprovider.md + - title: ReCaptchaV3Provider + path: /docs/reference/js/app-check.recaptchav3provider.md + - title: auth + path: /docs/reference/js/auth.md + section: + - title: ActionCodeInfo + path: /docs/reference/js/auth.actioncodeinfo.md + - title: ActionCodeSettings + path: /docs/reference/js/auth.actioncodesettings.md + - title: ActionCodeURL + path: /docs/reference/js/auth.actioncodeurl.md + - title: AdditionalUserInfo + path: /docs/reference/js/auth.additionaluserinfo.md + - title: ApplicationVerifier + path: /docs/reference/js/auth.applicationverifier.md + - title: Auth + path: /docs/reference/js/auth.auth.md + - title: AuthCredential + path: /docs/reference/js/auth.authcredential.md + - title: AuthError + path: /docs/reference/js/auth.autherror.md + - title: AuthErrorMap + path: /docs/reference/js/auth.autherrormap.md + - title: AuthProvider + path: /docs/reference/js/auth.authprovider.md + - title: AuthSettings + path: /docs/reference/js/auth.authsettings.md + - title: Config + path: /docs/reference/js/auth.config.md + - title: ConfirmationResult + path: /docs/reference/js/auth.confirmationresult.md + - title: Dependencies + path: /docs/reference/js/auth.dependencies.md + - title: EmailAuthCredential + path: /docs/reference/js/auth.emailauthcredential.md + - title: EmailAuthProvider + path: /docs/reference/js/auth.emailauthprovider.md + - title: EmulatorConfig + path: /docs/reference/js/auth.emulatorconfig.md + - title: FacebookAuthProvider + path: /docs/reference/js/auth.facebookauthprovider.md + - title: GithubAuthProvider + path: /docs/reference/js/auth.githubauthprovider.md + - title: GoogleAuthProvider + path: /docs/reference/js/auth.googleauthprovider.md + - title: IdTokenResult + path: /docs/reference/js/auth.idtokenresult.md + - title: MultiFactorAssertion + path: /docs/reference/js/auth.multifactorassertion.md + - title: MultiFactorError + path: /docs/reference/js/auth.multifactorerror.md + - title: MultiFactorInfo + path: /docs/reference/js/auth.multifactorinfo.md + - title: MultiFactorResolver + path: /docs/reference/js/auth.multifactorresolver.md + - title: MultiFactorSession + path: /docs/reference/js/auth.multifactorsession.md + - title: MultiFactorUser + path: /docs/reference/js/auth.multifactoruser.md + - title: OAuthCredential + path: /docs/reference/js/auth.oauthcredential.md + - title: OAuthCredentialOptions + path: /docs/reference/js/auth.oauthcredentialoptions.md + - title: OAuthProvider + path: /docs/reference/js/auth.oauthprovider.md + - title: ParsedToken + path: /docs/reference/js/auth.parsedtoken.md + - title: PasswordPolicy + path: /docs/reference/js/auth.passwordpolicy.md + - title: PasswordValidationStatus + path: /docs/reference/js/auth.passwordvalidationstatus.md + - title: Persistence + path: /docs/reference/js/auth.persistence.md + - title: PhoneAuthCredential + path: /docs/reference/js/auth.phoneauthcredential.md + - title: PhoneAuthProvider + path: /docs/reference/js/auth.phoneauthprovider.md + - title: PhoneMultiFactorAssertion + path: /docs/reference/js/auth.phonemultifactorassertion.md + - title: PhoneMultiFactorEnrollInfoOptions + path: /docs/reference/js/auth.phonemultifactorenrollinfooptions.md + - title: PhoneMultiFactorGenerator + path: /docs/reference/js/auth.phonemultifactorgenerator.md + - title: PhoneMultiFactorInfo + path: /docs/reference/js/auth.phonemultifactorinfo.md + - title: PhoneMultiFactorSignInInfoOptions + path: /docs/reference/js/auth.phonemultifactorsignininfooptions.md + - title: PhoneSingleFactorInfoOptions + path: /docs/reference/js/auth.phonesinglefactorinfooptions.md + - title: PopupRedirectResolver + path: /docs/reference/js/auth.popupredirectresolver.md + - title: ReactNativeAsyncStorage + path: /docs/reference/js/auth.reactnativeasyncstorage.md + - title: RecaptchaParameters + path: /docs/reference/js/auth.recaptchaparameters.md + - title: RecaptchaVerifier + path: /docs/reference/js/auth.recaptchaverifier.md + - title: SAMLAuthProvider + path: /docs/reference/js/auth.samlauthprovider.md + - title: TotpMultiFactorAssertion + path: /docs/reference/js/auth.totpmultifactorassertion.md + - title: TotpMultiFactorGenerator + path: /docs/reference/js/auth.totpmultifactorgenerator.md + - title: TotpMultiFactorInfo + path: /docs/reference/js/auth.totpmultifactorinfo.md + - title: TotpSecret + path: /docs/reference/js/auth.totpsecret.md + - title: TwitterAuthProvider + path: /docs/reference/js/auth.twitterauthprovider.md + - title: User + path: /docs/reference/js/auth.user.md + - title: UserCredential + path: /docs/reference/js/auth.usercredential.md + - title: UserInfo + path: /docs/reference/js/auth.userinfo.md + - title: UserMetadata + path: /docs/reference/js/auth.usermetadata.md + - title: database + path: /docs/reference/js/database.md + section: + - title: Database + path: /docs/reference/js/database.database.md + - title: DatabaseReference + path: /docs/reference/js/database.databasereference.md + - title: DataSnapshot + path: /docs/reference/js/database.datasnapshot.md + - title: IteratedDataSnapshot + path: /docs/reference/js/database.iterateddatasnapshot.md + - title: ListenOptions + path: /docs/reference/js/database.listenoptions.md + - title: OnDisconnect + path: /docs/reference/js/database.ondisconnect.md + - title: Query + path: /docs/reference/js/database.query.md + - title: QueryConstraint + path: /docs/reference/js/database.queryconstraint.md + - title: ThenableReference + path: /docs/reference/js/database.thenablereference.md + - title: TransactionOptions + path: /docs/reference/js/database.transactionoptions.md + - title: TransactionResult + path: /docs/reference/js/database.transactionresult.md + - title: firestore + path: /docs/reference/js/firestore_.md + section: + - title: AggregateField + path: /docs/reference/js/firestore_.aggregatefield.md + - title: AggregateQuerySnapshot + path: /docs/reference/js/firestore_.aggregatequerysnapshot.md + - title: AggregateSpec + path: /docs/reference/js/firestore_.aggregatespec.md + - title: Bytes + path: /docs/reference/js/firestore_.bytes.md + - title: CollectionReference + path: /docs/reference/js/firestore_.collectionreference.md + - title: DocumentChange + path: /docs/reference/js/firestore_.documentchange.md + - title: DocumentData + path: /docs/reference/js/firestore_.documentdata.md + - title: DocumentReference + path: /docs/reference/js/firestore_.documentreference.md + - title: DocumentSnapshot + path: /docs/reference/js/firestore_.documentsnapshot.md + - title: ExperimentalLongPollingOptions + path: /docs/reference/js/firestore_.experimentallongpollingoptions.md + - title: FieldPath + path: /docs/reference/js/firestore_.fieldpath.md + - title: FieldValue + path: /docs/reference/js/firestore_.fieldvalue.md + - title: Firestore + path: /docs/reference/js/firestore_.firestore.md + - title: FirestoreDataConverter + path: /docs/reference/js/firestore_.firestoredataconverter.md + - title: FirestoreError + path: /docs/reference/js/firestore_.firestoreerror.md + - title: FirestoreSettings + path: /docs/reference/js/firestore_.firestoresettings.md + - title: GeoPoint + path: /docs/reference/js/firestore_.geopoint.md + - title: Index + path: /docs/reference/js/firestore_.index.md + - title: IndexConfiguration + path: /docs/reference/js/firestore_.indexconfiguration.md + - title: IndexField + path: /docs/reference/js/firestore_.indexfield.md + - title: LoadBundleTask + path: /docs/reference/js/firestore_.loadbundletask.md + - title: LoadBundleTaskProgress + path: /docs/reference/js/firestore_.loadbundletaskprogress.md + - title: MemoryCacheSettings + path: /docs/reference/js/firestore_.memorycachesettings.md + - title: MemoryEagerGarbageCollector + path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md + - title: MemoryLocalCache + path: /docs/reference/js/firestore_.memorylocalcache.md + - title: MemoryLruGarbageCollector + path: /docs/reference/js/firestore_.memorylrugarbagecollector.md + - title: PersistenceSettings + path: /docs/reference/js/firestore_.persistencesettings.md + - title: PersistentCacheIndexManager + path: /docs/reference/js/firestore_.persistentcacheindexmanager.md + - title: PersistentCacheSettings + path: /docs/reference/js/firestore_.persistentcachesettings.md + - title: PersistentLocalCache + path: /docs/reference/js/firestore_.persistentlocalcache.md + - title: PersistentMultipleTabManager + path: /docs/reference/js/firestore_.persistentmultipletabmanager.md + - title: PersistentSingleTabManager + path: /docs/reference/js/firestore_.persistentsingletabmanager.md + - title: PersistentSingleTabManagerSettings + path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md + - title: Query + path: /docs/reference/js/firestore_.query.md + - title: QueryCompositeFilterConstraint + path: /docs/reference/js/firestore_.querycompositefilterconstraint.md + - title: QueryConstraint + path: /docs/reference/js/firestore_.queryconstraint.md + - title: QueryDocumentSnapshot + path: /docs/reference/js/firestore_.querydocumentsnapshot.md + - title: QueryEndAtConstraint + path: /docs/reference/js/firestore_.queryendatconstraint.md + - title: QueryFieldFilterConstraint + path: /docs/reference/js/firestore_.queryfieldfilterconstraint.md + - title: QueryLimitConstraint + path: /docs/reference/js/firestore_.querylimitconstraint.md + - title: QueryOrderByConstraint + path: /docs/reference/js/firestore_.queryorderbyconstraint.md + - title: QuerySnapshot + path: /docs/reference/js/firestore_.querysnapshot.md + - title: QueryStartAtConstraint + path: /docs/reference/js/firestore_.querystartatconstraint.md + - title: SnapshotListenOptions + path: /docs/reference/js/firestore_.snapshotlistenoptions.md + - title: SnapshotMetadata + path: /docs/reference/js/firestore_.snapshotmetadata.md + - title: SnapshotOptions + path: /docs/reference/js/firestore_.snapshotoptions.md + - title: Timestamp + path: /docs/reference/js/firestore_.timestamp.md + - title: Transaction + path: /docs/reference/js/firestore_.transaction.md + - title: TransactionOptions + path: /docs/reference/js/firestore_.transactionoptions.md + - title: Unsubscribe + path: /docs/reference/js/firestore_.unsubscribe.md + - title: WriteBatch + path: /docs/reference/js/firestore_.writebatch.md + - title: firestore/lite + path: /docs/reference/js/firestore_lite.md + section: + - title: AggregateField + path: /docs/reference/js/firestore_lite.aggregatefield.md + - title: AggregateQuerySnapshot + path: /docs/reference/js/firestore_lite.aggregatequerysnapshot.md + - title: AggregateSpec + path: /docs/reference/js/firestore_lite.aggregatespec.md + - title: Bytes + path: /docs/reference/js/firestore_lite.bytes.md + - title: CollectionReference + path: /docs/reference/js/firestore_lite.collectionreference.md + - title: DocumentData + path: /docs/reference/js/firestore_lite.documentdata.md + - title: DocumentReference + path: /docs/reference/js/firestore_lite.documentreference.md + - title: DocumentSnapshot + path: /docs/reference/js/firestore_lite.documentsnapshot.md + - title: FieldPath + path: /docs/reference/js/firestore_lite.fieldpath.md + - title: FieldValue + path: /docs/reference/js/firestore_lite.fieldvalue.md + - title: Firestore + path: /docs/reference/js/firestore_lite.firestore.md + - title: FirestoreDataConverter + path: /docs/reference/js/firestore_lite.firestoredataconverter.md + - title: FirestoreError + path: /docs/reference/js/firestore_lite.firestoreerror.md + - title: GeoPoint + path: /docs/reference/js/firestore_lite.geopoint.md + - title: Query + path: /docs/reference/js/firestore_lite.query.md + - title: QueryCompositeFilterConstraint + path: /docs/reference/js/firestore_lite.querycompositefilterconstraint.md + - title: QueryConstraint + path: /docs/reference/js/firestore_lite.queryconstraint.md + - title: QueryDocumentSnapshot + path: /docs/reference/js/firestore_lite.querydocumentsnapshot.md + - title: QueryEndAtConstraint + path: /docs/reference/js/firestore_lite.queryendatconstraint.md + - title: QueryFieldFilterConstraint + path: /docs/reference/js/firestore_lite.queryfieldfilterconstraint.md + - title: QueryLimitConstraint + path: /docs/reference/js/firestore_lite.querylimitconstraint.md + - title: QueryOrderByConstraint + path: /docs/reference/js/firestore_lite.queryorderbyconstraint.md + - title: QuerySnapshot + path: /docs/reference/js/firestore_lite.querysnapshot.md + - title: QueryStartAtConstraint + path: /docs/reference/js/firestore_lite.querystartatconstraint.md + - title: Settings + path: /docs/reference/js/firestore_lite.settings.md + - title: Timestamp + path: /docs/reference/js/firestore_lite.timestamp.md + - title: Transaction + path: /docs/reference/js/firestore_lite.transaction.md + - title: TransactionOptions + path: /docs/reference/js/firestore_lite.transactionoptions.md + - title: WriteBatch + path: /docs/reference/js/firestore_lite.writebatch.md + - title: functions + path: /docs/reference/js/functions.md + section: + - title: Functions + path: /docs/reference/js/functions.functions.md + - title: FunctionsError + path: /docs/reference/js/functions.functionserror.md + - title: HttpsCallableOptions + path: /docs/reference/js/functions.httpscallableoptions.md + - title: HttpsCallableResult + path: /docs/reference/js/functions.httpscallableresult.md + - title: installations + path: /docs/reference/js/installations.md + section: + - title: Installations + path: /docs/reference/js/installations.installations.md + - title: messaging + path: /docs/reference/js/messaging_.md + section: + - title: FcmOptions + path: /docs/reference/js/messaging_.fcmoptions.md + - title: GetTokenOptions + path: /docs/reference/js/messaging_.gettokenoptions.md + - title: MessagePayload + path: /docs/reference/js/messaging_.messagepayload.md + - title: Messaging + path: /docs/reference/js/messaging_.messaging.md + - title: NotificationPayload + path: /docs/reference/js/messaging_.notificationpayload.md + - title: messaging/sw + path: /docs/reference/js/messaging_sw.md + section: + - title: FcmOptions + path: /docs/reference/js/messaging_sw.fcmoptions.md + - title: GetTokenOptions + path: /docs/reference/js/messaging_sw.gettokenoptions.md + - title: MessagePayload + path: /docs/reference/js/messaging_sw.messagepayload.md + - title: Messaging + path: /docs/reference/js/messaging_sw.messaging.md + - title: NotificationPayload + path: /docs/reference/js/messaging_sw.notificationpayload.md + - title: performance + path: /docs/reference/js/performance.md + section: + - title: FirebasePerformance + path: /docs/reference/js/performance.firebaseperformance.md + - title: PerformanceSettings + path: /docs/reference/js/performance.performancesettings.md + - title: PerformanceTrace + path: /docs/reference/js/performance.performancetrace.md + - title: remote-config + path: /docs/reference/js/remote-config.md + section: + - title: RemoteConfig + path: /docs/reference/js/remote-config.remoteconfig.md + - title: RemoteConfigSettings + path: /docs/reference/js/remote-config.remoteconfigsettings.md + - title: Value + path: /docs/reference/js/remote-config.value.md + - title: storage + path: /docs/reference/js/storage.md + section: + - title: FirebaseStorage + path: /docs/reference/js/storage.firebasestorage.md + - title: FullMetadata + path: /docs/reference/js/storage.fullmetadata.md + - title: ListOptions + path: /docs/reference/js/storage.listoptions.md + - title: ListResult + path: /docs/reference/js/storage.listresult.md + - title: SettableMetadata + path: /docs/reference/js/storage.settablemetadata.md + - title: StorageError + path: /docs/reference/js/storage.storageerror.md + - title: StorageObserver + path: /docs/reference/js/storage.storageobserver.md + - title: StorageReference + path: /docs/reference/js/storage.storagereference.md + - title: UploadMetadata + path: /docs/reference/js/storage.uploadmetadata.md + - title: UploadResult + path: /docs/reference/js/storage.uploadresult.md + - title: UploadTask + path: /docs/reference/js/storage.uploadtask.md + - title: UploadTaskSnapshot + path: /docs/reference/js/storage.uploadtasksnapshot.md + - title: vertexai-preview + path: /docs/reference/js/vertexai-preview.md + section: + - title: BaseParams + path: /docs/reference/js/vertexai-preview.baseparams.md + - title: ChatSession + path: /docs/reference/js/vertexai-preview.chatsession.md + - title: Citation + path: /docs/reference/js/vertexai-preview.citation.md + - title: CitationMetadata + path: /docs/reference/js/vertexai-preview.citationmetadata.md + - title: Content + path: /docs/reference/js/vertexai-preview.content.md + - title: CountTokensRequest + path: /docs/reference/js/vertexai-preview.counttokensrequest.md + - title: CountTokensResponse + path: /docs/reference/js/vertexai-preview.counttokensresponse.md + - title: Date_2 + path: /docs/reference/js/vertexai-preview.date_2.md + - title: EnhancedGenerateContentResponse + path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md + - title: ErrorDetails + path: /docs/reference/js/vertexai-preview.errordetails.md + - title: FileData + path: /docs/reference/js/vertexai-preview.filedata.md + - title: FileDataPart + path: /docs/reference/js/vertexai-preview.filedatapart.md + - title: FunctionCall + path: /docs/reference/js/vertexai-preview.functioncall.md + - title: FunctionCallingConfig + path: /docs/reference/js/vertexai-preview.functioncallingconfig.md + - title: FunctionCallPart + path: /docs/reference/js/vertexai-preview.functioncallpart.md + - title: FunctionDeclaration + path: /docs/reference/js/vertexai-preview.functiondeclaration.md + - title: FunctionDeclarationSchema + path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md + - title: FunctionDeclarationSchemaProperty + path: >- + /docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md + - title: FunctionDeclarationsTool + path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md + - title: FunctionResponse + path: /docs/reference/js/vertexai-preview.functionresponse.md + - title: FunctionResponsePart + path: /docs/reference/js/vertexai-preview.functionresponsepart.md + - title: GenerateContentCandidate + path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md + - title: GenerateContentRequest + path: /docs/reference/js/vertexai-preview.generatecontentrequest.md + - title: GenerateContentResponse + path: /docs/reference/js/vertexai-preview.generatecontentresponse.md + - title: GenerateContentResult + path: /docs/reference/js/vertexai-preview.generatecontentresult.md + - title: GenerateContentStreamResult + path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md + - title: GenerationConfig + path: /docs/reference/js/vertexai-preview.generationconfig.md + - title: GenerativeContentBlob + path: /docs/reference/js/vertexai-preview.generativecontentblob.md + - title: GenerativeModel + path: /docs/reference/js/vertexai-preview.generativemodel.md + - title: GroundingAttribution + path: /docs/reference/js/vertexai-preview.groundingattribution.md + - title: GroundingMetadata + path: /docs/reference/js/vertexai-preview.groundingmetadata.md + - title: HTTPErrorDetails + path: /docs/reference/js/vertexai-preview.httperrordetails.md + - title: InlineDataPart + path: /docs/reference/js/vertexai-preview.inlinedatapart.md + - title: ModelParams + path: /docs/reference/js/vertexai-preview.modelparams.md + - title: PromptFeedback + path: /docs/reference/js/vertexai-preview.promptfeedback.md + - title: RequestOptions + path: /docs/reference/js/vertexai-preview.requestoptions.md + - title: RetrievedContextAttribution + path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md + - title: SafetyRating + path: /docs/reference/js/vertexai-preview.safetyrating.md + - title: SafetySetting + path: /docs/reference/js/vertexai-preview.safetysetting.md + - title: Segment + path: /docs/reference/js/vertexai-preview.segment.md + - title: StartChatParams + path: /docs/reference/js/vertexai-preview.startchatparams.md + - title: TextPart + path: /docs/reference/js/vertexai-preview.textpart.md + - title: ToolConfig + path: /docs/reference/js/vertexai-preview.toolconfig.md + - title: UsageMetadata + path: /docs/reference/js/vertexai-preview.usagemetadata.md + - title: VertexAI + path: /docs/reference/js/vertexai-preview.vertexai.md + - title: VertexAIError + path: /docs/reference/js/vertexai-preview.vertexaierror.md + - title: VertexAIOptions + path: /docs/reference/js/vertexai-preview.vertexaioptions.md + - title: VideoMetadata + path: /docs/reference/js/vertexai-preview.videometadata.md + - title: WebAttribution + path: /docs/reference/js/vertexai-preview.webattribution.md From 0af23e02e0c90ae550dd3edf1c9244a8eba3aee1 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 23 May 2024 13:12:19 -0400 Subject: [PATCH 4/5] Generate dts rollups for auth webextension and cordova (#8251) --- .changeset/wet-hotels-greet.md | 5 +++++ packages/auth/cordova/api-extractor.json | 16 ++++++++++++++++ packages/auth/cordova/package.json | 4 ++-- packages/auth/package.json | 6 +++--- packages/auth/web-extension/api-extractor.json | 16 ++++++++++++++++ packages/auth/web-extension/package.json | 4 ++-- 6 files changed, 44 insertions(+), 7 deletions(-) create mode 100644 .changeset/wet-hotels-greet.md create mode 100644 packages/auth/cordova/api-extractor.json create mode 100644 packages/auth/web-extension/api-extractor.json diff --git a/.changeset/wet-hotels-greet.md b/.changeset/wet-hotels-greet.md new file mode 100644 index 00000000000..41cafaae220 --- /dev/null +++ b/.changeset/wet-hotels-greet.md @@ -0,0 +1,5 @@ +--- +'@firebase/auth': patch +--- + +Generate dts rollups for auth web extension and cordova diff --git a/packages/auth/cordova/api-extractor.json b/packages/auth/cordova/api-extractor.json new file mode 100644 index 00000000000..e76c159a8ef --- /dev/null +++ b/packages/auth/cordova/api-extractor.json @@ -0,0 +1,16 @@ +{ + "extends": "../../../config/api-extractor.json", + "mainEntryPointFilePath": "/dist/cordova/index.cordova.d.ts", + "apiReport": { + "enabled": false + }, + "dtsRollup": { + "enabled": true, + "untrimmedFilePath": "/dist/cordova/.d.ts", + "publicTrimmedFilePath": "/dist/cordova/-public.d.ts" + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/temp/subpackages/.api.json" + } +} diff --git a/packages/auth/cordova/package.json b/packages/auth/cordova/package.json index b133d280d44..aef216664f4 100644 --- a/packages/auth/cordova/package.json +++ b/packages/auth/cordova/package.json @@ -1,7 +1,7 @@ { - "name": "@firebase/auth/cordova", + "name": "@firebase/auth-cordova", "description": "A Cordova-specific build of the Firebase Auth JS SDK", "browser": "../dist/cordova/index.js", "module": "../dist/cordova/index.js", - "typings": "../dist/cordova/index.cordova.d.ts" + "typings": "../dist/cordova/auth-cordova-public.d.ts" } \ No newline at end of file diff --git a/packages/auth/package.json b/packages/auth/package.json index 0b4829da3ca..33d01f4ca51 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -39,11 +39,11 @@ "default": "./dist/esm2017/index.js" }, "./cordova": { - "types": "./dist/cordova/index.cordova.d.ts", + "types": "./dist/cordova/auth-cordova-public.d.ts", "default": "./dist/cordova/index.js" }, "./web-extension": { - "types:": "./dist/web-extension-esm2017/index.web-extension.d.ts", + "types:": "./dist/web-extension-esm2017/auth-web-extension-public.d.ts", "import": "./dist/web-extension-esm2017/index.js", "require": "./dist/web-extension-cjs/index.js", "default": "./dist/web-extension-esm2017/index.js" @@ -111,7 +111,7 @@ "test:node:integration": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration", "test:node:integration:local": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration --local", "test:webdriver": "rollup -c test/integration/webdriver/static/rollup.config.js && ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --webdriver", - "api-report": "api-extractor run --local --verbose", + "api-report": "api-extractor run --local --verbose --config ./api-extractor.json && api-extractor run --local --verbose --config ./web-extension/api-extractor.json && api-extractor run --local --verbose --config ./cordova/api-extractor.json", "doc": "api-documenter markdown --input temp --output docs", "build:doc": "yarn build && yarn doc", "typings:public": "node ../../scripts/build/use_typings.js ./dist/auth-public.d.ts" diff --git a/packages/auth/web-extension/api-extractor.json b/packages/auth/web-extension/api-extractor.json new file mode 100644 index 00000000000..d12063c69b5 --- /dev/null +++ b/packages/auth/web-extension/api-extractor.json @@ -0,0 +1,16 @@ +{ + "extends": "../../../config/api-extractor.json", + "mainEntryPointFilePath": "/dist/web-extension-esm2017/index.web-extension.d.ts", + "apiReport": { + "enabled": false + }, + "dtsRollup": { + "enabled": true, + "untrimmedFilePath": "/dist/web-extension-esm2017/.d.ts", + "publicTrimmedFilePath": "/dist/web-extension-esm2017/-public.d.ts" + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/temp/subpackages/.api.json" + } +} diff --git a/packages/auth/web-extension/package.json b/packages/auth/web-extension/package.json index 1a46dcf1f90..f3882a4f1d0 100644 --- a/packages/auth/web-extension/package.json +++ b/packages/auth/web-extension/package.json @@ -1,8 +1,8 @@ { - "name": "@firebase/auth/web-extension", + "name": "@firebase/auth-web-extension", "description": "A Chrome-Manifest-v3-specific build of the Firebase Auth JS SDK", "main": "../dist/web-extension-cjs/index.js", "browser": "../dist/web-extension-esm2017/index.js", "module": "../dist/web-extension-esm2017/index.js", - "typings": "../dist/web-extension-esm2017/index.web-extension.d.ts" + "typings": "../dist/web-extension-esm2017/auth-web-extension-public.d.ts" } \ No newline at end of file From 52d626655c5abe386f3de8c064a012a5d97e726f Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 23 May 2024 10:47:02 -0700 Subject: [PATCH 5/5] Add vertex preview token to canary deploy workflow. (#8262) --- .github/workflows/canary-deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/canary-deploy.yml b/.github/workflows/canary-deploy.yml index 8b359aaccdf..8dc364b48ba 100644 --- a/.github/workflows/canary-deploy.yml +++ b/.github/workflows/canary-deploy.yml @@ -74,6 +74,7 @@ jobs: NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}} NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}} NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}} + NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}} 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 }}