From 93f1e7c5cfaed88021530b23b34fdf16e7efd086 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 31 May 2022 12:09:01 -0700 Subject: [PATCH] Restore v9 TOC menu sub-items --- repo-scripts/api-documenter/src/toc.ts | 14 + toc/toc.yaml | 417 +++++++++++++++++++++++++ 2 files changed, 431 insertions(+) create mode 100644 toc/toc.yaml diff --git a/repo-scripts/api-documenter/src/toc.ts b/repo-scripts/api-documenter/src/toc.ts index 100f7ab1d21..71a1031ab59 100644 --- a/repo-scripts/api-documenter/src/toc.ts +++ b/repo-scripts/api-documenter/src/toc.ts @@ -85,6 +85,20 @@ function generateTocRecursively( section: [] }; + for (const member of apiItem.members) { + // only classes and interfaces have dedicated pages + if ( + member.kind === ApiItemKind.Class || + member.kind === ApiItemKind.Interface + ) { + const fileName = getFilenameForApiItem(member, addFileNameSuffix); + entryPointToc.section!.push({ + title: member.displayName, + path: `${g3Path}/${fileName}` + }); + } + } + toc.push(entryPointToc); } else { // travel the api tree to find the next entry point diff --git a/toc/toc.yaml b/toc/toc.yaml new file mode 100644 index 00000000000..3b80b55eec3 --- /dev/null +++ b/toc/toc.yaml @@ -0,0 +1,417 @@ +toc: + - title: firebase + path: docs/reference/js/v9/index + section: [] + - title: analytics + path: docs/reference/js/v9/analytics.md + section: + - title: Analytics + path: docs/reference/js/v9/analytics.analytics.md + - title: AnalyticsCallOptions + path: docs/reference/js/v9/analytics.analyticscalloptions.md + - title: AnalyticsSettings + path: docs/reference/js/v9/analytics.analyticssettings.md + - title: ControlParams + path: docs/reference/js/v9/analytics.controlparams.md + - title: CustomParams + path: docs/reference/js/v9/analytics.customparams.md + - title: EventParams + path: docs/reference/js/v9/analytics.eventparams.md + - title: GtagConfigParams + path: docs/reference/js/v9/analytics.gtagconfigparams.md + - title: Item + path: docs/reference/js/v9/analytics.item.md + - title: Promotion + path: docs/reference/js/v9/analytics.promotion.md + - title: SettingsOptions + path: docs/reference/js/v9/analytics.settingsoptions.md + - title: app + path: docs/reference/js/v9/app.md + section: + - title: FirebaseApp + path: docs/reference/js/v9/app.firebaseapp.md + - title: FirebaseAppSettings + path: docs/reference/js/v9/app.firebaseappsettings.md + - title: FirebaseError + path: docs/reference/js/v9/app.firebaseerror.md + - title: FirebaseOptions + path: docs/reference/js/v9/app.firebaseoptions.md + - title: app-check + path: docs/reference/js/v9/app-check.md + section: + - title: AppCheck + path: docs/reference/js/v9/app-check.appcheck.md + - title: AppCheckOptions + path: docs/reference/js/v9/app-check.appcheckoptions.md + - title: AppCheckToken + path: docs/reference/js/v9/app-check.appchecktoken.md + - title: AppCheckTokenResult + path: docs/reference/js/v9/app-check.appchecktokenresult.md + - title: CustomProvider + path: docs/reference/js/v9/app-check.customprovider.md + - title: CustomProviderOptions + path: docs/reference/js/v9/app-check.customprovideroptions.md + - title: ReCaptchaEnterpriseProvider + path: docs/reference/js/v9/app-check.recaptchaenterpriseprovider.md + - title: ReCaptchaV3Provider + path: docs/reference/js/v9/app-check.recaptchav3provider.md + - title: app-compat + path: docs/reference/js/v9/app-compat.md + section: + - title: _FirebaseNamespace + path: docs/reference/js/v9/app-compat._firebasenamespace.md + - title: _FirebaseService + path: docs/reference/js/v9/app-compat._firebaseservice.md + - title: FirebaseApp + path: docs/reference/js/v9/app-compat.firebaseapp.md + - title: FirebaseNamespace + path: docs/reference/js/v9/app-compat.firebasenamespace.md + - title: auth + path: docs/reference/js/v9/auth.md + section: + - title: ActionCodeInfo + path: docs/reference/js/v9/auth.actioncodeinfo.md + - title: ActionCodeSettings + path: docs/reference/js/v9/auth.actioncodesettings.md + - title: ActionCodeURL + path: docs/reference/js/v9/auth.actioncodeurl.md + - title: AdditionalUserInfo + path: docs/reference/js/v9/auth.additionaluserinfo.md + - title: ApplicationVerifier + path: docs/reference/js/v9/auth.applicationverifier.md + - title: Auth + path: docs/reference/js/v9/auth.auth.md + - title: AuthCredential + path: docs/reference/js/v9/auth.authcredential.md + - title: AuthError + path: docs/reference/js/v9/auth.autherror.md + - title: AuthErrorMap + path: docs/reference/js/v9/auth.autherrormap.md + - title: AuthProvider + path: docs/reference/js/v9/auth.authprovider.md + - title: AuthSettings + path: docs/reference/js/v9/auth.authsettings.md + - title: Config + path: docs/reference/js/v9/auth.config.md + - title: ConfirmationResult + path: docs/reference/js/v9/auth.confirmationresult.md + - title: Dependencies + path: docs/reference/js/v9/auth.dependencies.md + - title: EmailAuthCredential + path: docs/reference/js/v9/auth.emailauthcredential.md + - title: EmailAuthProvider + path: docs/reference/js/v9/auth.emailauthprovider.md + - title: EmulatorConfig + path: docs/reference/js/v9/auth.emulatorconfig.md + - title: FacebookAuthProvider + path: docs/reference/js/v9/auth.facebookauthprovider.md + - title: GithubAuthProvider + path: docs/reference/js/v9/auth.githubauthprovider.md + - title: GoogleAuthProvider + path: docs/reference/js/v9/auth.googleauthprovider.md + - title: IdTokenResult + path: docs/reference/js/v9/auth.idtokenresult.md + - title: MultiFactorAssertion + path: docs/reference/js/v9/auth.multifactorassertion.md + - title: MultiFactorError + path: docs/reference/js/v9/auth.multifactorerror.md + - title: MultiFactorInfo + path: docs/reference/js/v9/auth.multifactorinfo.md + - title: MultiFactorResolver + path: docs/reference/js/v9/auth.multifactorresolver.md + - title: MultiFactorSession + path: docs/reference/js/v9/auth.multifactorsession.md + - title: MultiFactorUser + path: docs/reference/js/v9/auth.multifactoruser.md + - title: OAuthCredential + path: docs/reference/js/v9/auth.oauthcredential.md + - title: OAuthCredentialOptions + path: docs/reference/js/v9/auth.oauthcredentialoptions.md + - title: OAuthProvider + path: docs/reference/js/v9/auth.oauthprovider.md + - title: ParsedToken + path: docs/reference/js/v9/auth.parsedtoken.md + - title: Persistence + path: docs/reference/js/v9/auth.persistence.md + - title: PhoneAuthCredential + path: docs/reference/js/v9/auth.phoneauthcredential.md + - title: PhoneAuthProvider + path: docs/reference/js/v9/auth.phoneauthprovider.md + - title: PhoneMultiFactorAssertion + path: docs/reference/js/v9/auth.phonemultifactorassertion.md + - title: PhoneMultiFactorEnrollInfoOptions + path: docs/reference/js/v9/auth.phonemultifactorenrollinfooptions.md + - title: PhoneMultiFactorGenerator + path: docs/reference/js/v9/auth.phonemultifactorgenerator.md + - title: PhoneMultiFactorInfo + path: docs/reference/js/v9/auth.phonemultifactorinfo.md + - title: PhoneMultiFactorSignInInfoOptions + path: docs/reference/js/v9/auth.phonemultifactorsignininfooptions.md + - title: PhoneSingleFactorInfoOptions + path: docs/reference/js/v9/auth.phonesinglefactorinfooptions.md + - title: PopupRedirectResolver + path: docs/reference/js/v9/auth.popupredirectresolver.md + - title: ReactNativeAsyncStorage + path: docs/reference/js/v9/auth.reactnativeasyncstorage.md + - title: RecaptchaParameters + path: docs/reference/js/v9/auth.recaptchaparameters.md + - title: RecaptchaVerifier + path: docs/reference/js/v9/auth.recaptchaverifier.md + - title: SAMLAuthProvider + path: docs/reference/js/v9/auth.samlauthprovider.md + - title: TwitterAuthProvider + path: docs/reference/js/v9/auth.twitterauthprovider.md + - title: User + path: docs/reference/js/v9/auth.user.md + - title: UserCredential + path: docs/reference/js/v9/auth.usercredential.md + - title: UserInfo + path: docs/reference/js/v9/auth.userinfo.md + - title: UserMetadata + path: docs/reference/js/v9/auth.usermetadata.md + - title: database + path: docs/reference/js/v9/database.md + section: + - title: Database + path: docs/reference/js/v9/database.database.md + - title: DatabaseReference + path: docs/reference/js/v9/database.databasereference.md + - title: DataSnapshot + path: docs/reference/js/v9/database.datasnapshot.md + - title: ListenOptions + path: docs/reference/js/v9/database.listenoptions.md + - title: OnDisconnect + path: docs/reference/js/v9/database.ondisconnect.md + - title: Query + path: docs/reference/js/v9/database.query.md + - title: QueryConstraint + path: docs/reference/js/v9/database.queryconstraint.md + - title: ThenableReference + path: docs/reference/js/v9/database.thenablereference.md + - title: TransactionOptions + path: docs/reference/js/v9/database.transactionoptions.md + - title: TransactionResult + path: docs/reference/js/v9/database.transactionresult.md + - title: firestore + path: docs/reference/js/v9/firestore_.md + section: + - title: Bytes + path: docs/reference/js/v9/firestore_.bytes.md + - title: CollectionReference + path: docs/reference/js/v9/firestore_.collectionreference.md + - title: DocumentChange + path: docs/reference/js/v9/firestore_.documentchange.md + - title: DocumentData + path: docs/reference/js/v9/firestore_.documentdata.md + - title: DocumentReference + path: docs/reference/js/v9/firestore_.documentreference.md + - title: DocumentSnapshot + path: docs/reference/js/v9/firestore_.documentsnapshot.md + - title: FieldPath + path: docs/reference/js/v9/firestore_.fieldpath.md + - title: FieldValue + path: docs/reference/js/v9/firestore_.fieldvalue.md + - title: Firestore + path: docs/reference/js/v9/firestore_.firestore.md + - title: FirestoreDataConverter + path: docs/reference/js/v9/firestore_.firestoredataconverter.md + - title: FirestoreError + path: docs/reference/js/v9/firestore_.firestoreerror.md + - title: FirestoreSettings + path: docs/reference/js/v9/firestore_.firestoresettings.md + - title: GeoPoint + path: docs/reference/js/v9/firestore_.geopoint.md + - title: LoadBundleTask + path: docs/reference/js/v9/firestore_.loadbundletask.md + - title: LoadBundleTaskProgress + path: docs/reference/js/v9/firestore_.loadbundletaskprogress.md + - title: PersistenceSettings + path: docs/reference/js/v9/firestore_.persistencesettings.md + - title: Query + path: docs/reference/js/v9/firestore_.query.md + - title: QueryConstraint + path: docs/reference/js/v9/firestore_.queryconstraint.md + - title: QueryDocumentSnapshot + path: docs/reference/js/v9/firestore_.querydocumentsnapshot.md + - title: QuerySnapshot + path: docs/reference/js/v9/firestore_.querysnapshot.md + - title: SnapshotListenOptions + path: docs/reference/js/v9/firestore_.snapshotlistenoptions.md + - title: SnapshotMetadata + path: docs/reference/js/v9/firestore_.snapshotmetadata.md + - title: SnapshotOptions + path: docs/reference/js/v9/firestore_.snapshotoptions.md + - title: Timestamp + path: docs/reference/js/v9/firestore_.timestamp.md + - title: Transaction + path: docs/reference/js/v9/firestore_.transaction.md + - title: TransactionOptions + path: docs/reference/js/v9/firestore_.transactionoptions.md + - title: Unsubscribe + path: docs/reference/js/v9/firestore_.unsubscribe.md + - title: WriteBatch + path: docs/reference/js/v9/firestore_.writebatch.md + - title: firestore/lite + path: docs/reference/js/v9/firestore_lite.md + section: + - title: Bytes + path: docs/reference/js/v9/firestore_lite.bytes.md + - title: CollectionReference + path: docs/reference/js/v9/firestore_lite.collectionreference.md + - title: DocumentData + path: docs/reference/js/v9/firestore_lite.documentdata.md + - title: DocumentReference + path: docs/reference/js/v9/firestore_lite.documentreference.md + - title: DocumentSnapshot + path: docs/reference/js/v9/firestore_lite.documentsnapshot.md + - title: FieldPath + path: docs/reference/js/v9/firestore_lite.fieldpath.md + - title: FieldValue + path: docs/reference/js/v9/firestore_lite.fieldvalue.md + - title: Firestore + path: docs/reference/js/v9/firestore_lite.firestore.md + - title: FirestoreDataConverter + path: docs/reference/js/v9/firestore_lite.firestoredataconverter.md + - title: FirestoreError + path: docs/reference/js/v9/firestore_lite.firestoreerror.md + - title: GeoPoint + path: docs/reference/js/v9/firestore_lite.geopoint.md + - title: Query + path: docs/reference/js/v9/firestore_lite.query.md + - title: QueryConstraint + path: docs/reference/js/v9/firestore_lite.queryconstraint.md + - title: QueryDocumentSnapshot + path: docs/reference/js/v9/firestore_lite.querydocumentsnapshot.md + - title: QuerySnapshot + path: docs/reference/js/v9/firestore_lite.querysnapshot.md + - title: Settings + path: docs/reference/js/v9/firestore_lite.settings.md + - title: Timestamp + path: docs/reference/js/v9/firestore_lite.timestamp.md + - title: Transaction + path: docs/reference/js/v9/firestore_lite.transaction.md + - title: TransactionOptions + path: docs/reference/js/v9/firestore_lite.transactionoptions.md + - title: WriteBatch + path: docs/reference/js/v9/firestore_lite.writebatch.md + - title: functions + path: docs/reference/js/v9/functions.md + section: + - title: Functions + path: docs/reference/js/v9/functions.functions.md + - title: FunctionsError + path: docs/reference/js/v9/functions.functionserror.md + - title: HttpsCallableOptions + path: docs/reference/js/v9/functions.httpscallableoptions.md + - title: HttpsCallableResult + path: docs/reference/js/v9/functions.httpscallableresult.md + - title: installations + path: docs/reference/js/v9/installations.md + section: + - title: Installations + path: docs/reference/js/v9/installations.installations.md + - title: messaging + path: docs/reference/js/v9/messaging_.md + section: + - title: FcmOptions + path: docs/reference/js/v9/messaging_.fcmoptions.md + - title: GetTokenOptions + path: docs/reference/js/v9/messaging_.gettokenoptions.md + - title: MessagePayload + path: docs/reference/js/v9/messaging_.messagepayload.md + - title: Messaging + path: docs/reference/js/v9/messaging_.messaging.md + - title: NotificationPayload + path: docs/reference/js/v9/messaging_.notificationpayload.md + - title: messaging/sw + path: docs/reference/js/v9/messaging_sw.md + section: + - title: FcmOptions + path: docs/reference/js/v9/messaging_sw.fcmoptions.md + - title: GetTokenOptions + path: docs/reference/js/v9/messaging_sw.gettokenoptions.md + - title: MessagePayload + path: docs/reference/js/v9/messaging_sw.messagepayload.md + - title: Messaging + path: docs/reference/js/v9/messaging_sw.messaging.md + - title: NotificationPayload + path: docs/reference/js/v9/messaging_sw.notificationpayload.md + - title: performance + path: docs/reference/js/v9/performance.md + section: + - title: FirebasePerformance + path: docs/reference/js/v9/performance.firebaseperformance.md + - title: PerformanceSettings + path: docs/reference/js/v9/performance.performancesettings.md + - title: PerformanceTrace + path: docs/reference/js/v9/performance.performancetrace.md + - title: remote-config + path: docs/reference/js/v9/remote-config.md + section: + - title: RemoteConfig + path: docs/reference/js/v9/remote-config.remoteconfig.md + - title: RemoteConfigSettings + path: docs/reference/js/v9/remote-config.remoteconfigsettings.md + - title: Value + path: docs/reference/js/v9/remote-config.value.md + - title: rules-unit-testing + path: docs/reference/js/v9/rules-unit-testing.md + section: + - title: HostAndPort + path: docs/reference/js/v9/rules-unit-testing.hostandport.md + - title: RulesTestContext + path: docs/reference/js/v9/rules-unit-testing.rulestestcontext.md + - title: RulesTestEnvironment + path: docs/reference/js/v9/rules-unit-testing.rulestestenvironment.md + - title: TestEnvironmentConfig + path: docs/reference/js/v9/rules-unit-testing.testenvironmentconfig.md + - title: storage + path: docs/reference/js/v9/storage.md + section: + - title: FirebaseStorage + path: docs/reference/js/v9/storage.firebasestorage.md + - title: FullMetadata + path: docs/reference/js/v9/storage.fullmetadata.md + - title: ListOptions + path: docs/reference/js/v9/storage.listoptions.md + - title: ListResult + path: docs/reference/js/v9/storage.listresult.md + - title: SettableMetadata + path: docs/reference/js/v9/storage.settablemetadata.md + - title: StorageError + path: docs/reference/js/v9/storage.storageerror.md + - title: StorageObserver + path: docs/reference/js/v9/storage.storageobserver.md + - title: StorageReference + path: docs/reference/js/v9/storage.storagereference.md + - title: UploadMetadata + path: docs/reference/js/v9/storage.uploadmetadata.md + - title: UploadResult + path: docs/reference/js/v9/storage.uploadresult.md + - title: UploadTask + path: docs/reference/js/v9/storage.uploadtask.md + - title: UploadTaskSnapshot + path: docs/reference/js/v9/storage.uploadtasksnapshot.md + - title: util + path: docs/reference/js/v9/util.md + section: + - title: Compat + path: docs/reference/js/v9/util.compat.md + - title: Deferred + path: docs/reference/js/v9/util.deferred.md + - title: ErrorData + path: docs/reference/js/v9/util.errordata.md + - title: ErrorFactory + path: docs/reference/js/v9/util.errorfactory.md + - title: FirebaseError + path: docs/reference/js/v9/util.firebaseerror.md + - title: Observable + path: docs/reference/js/v9/util.observable.md + - title: Observer + path: docs/reference/js/v9/util.observer.md + - title: Sha1 + path: docs/reference/js/v9/util.sha1.md + - title: StringLike + path: docs/reference/js/v9/util.stringlike.md + - title: Subscribe + path: docs/reference/js/v9/util.subscribe.md