Getting the typedoc toolchain to run against index.d.ts

docgen/content-sources/js/HOME.md

@@ -0,0 +1,12 @@
+# Firebase JavaScript SDK Reference
+The Firebase JavaScript SDK implements the client-side libraries used by
+applications using Firebase services. This SDK is distributed via:
+
+- CDN (`<script src="https://www.gstatic.com/firebasejs/{{ web_sdk_version }}/firebase.js"></script>`)
+- [npm package](https://www.npmjs.com/package/firebase)
+- [Bower package](https://github.com/firebase/firebase-bower)
+
+To get started using Firebase, see
+[Add Firebase to your JavaScript Project](https://firebase.google.com/docs/web/setup).
+
+For source code, see the [Firebase JavaScript SDK Github repo](https://github.com/firebase/firebase-js-sdk).

docgen/content-sources/js/toc.yaml

@@ -0,0 +1,165 @@
+toc:
+- title: "firebase"
+  path: /docs/reference/js/firebase
+  section:
+  - title: "FirebaseError"
+    path: /docs/reference/js/firebase.FirebaseError
+
+- title: "firebase.app"
+  path: /docs/reference/js/firebase.app
+  section:
+  - title: "App"
+    path: /docs/reference/js/firebase.app.App
+
+- title: "firebase.auth"
+  path: /docs/reference/js/firebase.auth
+  section:
+  - title: "Auth"
+    path: /docs/reference/js/firebase.auth.Auth
+  - title: "ActionCodeInfo"
+    path: /docs/reference/js/firebase.auth.ActionCodeInfo
+  - title: "ApplicationVerifier"
+    path: /docs/reference/js/firebase.auth.ApplicationVerifier
+  - title: "AuthCredential"
+    path: /docs/reference/js/firebase.auth.AuthCredential
+  - title: "AuthSettings"
+    path: /docs/reference/js/firebase.auth.AuthSettings
+  - title: "OAuthCredential"
+    path: /docs/reference/js/firebase.auth.OAuthCredential
+  - title: "AuthProvider"
+    path: /docs/reference/js/firebase.auth.AuthProvider
+  - title: "ConfirmationResult"
+    path: /docs/reference/js/firebase.auth.ConfirmationResult
+  - title: "EmailAuthProvider"
+    path: /docs/reference/js/firebase.auth.EmailAuthProvider
+  - title: "Error"
+    path: /docs/reference/js/firebase.auth.Error
+  - title: "FacebookAuthProvider"
+    path: /docs/reference/js/firebase.auth.FacebookAuthProvider
+  - title: "GithubAuthProvider"
+    path: /docs/reference/js/firebase.auth.GithubAuthProvider
+  - title: "GoogleAuthProvider"
+    path: /docs/reference/js/firebase.auth.GoogleAuthProvider
+  - title: "IdTokenResult"
+    path: /docs/reference/js/firebase.auth.IDTokenResult
+  - title: "TwitterAuthProvider"
+    path: /docs/reference/js/firebase.auth.TwitterAuthProvider
+  - title: "OAuthProvider"
+    path: /docs/reference/js/firebase.auth.OAuthProvider
+  - title: "PhoneAuthProvider"
+    path: /docs/reference/js/firebase.auth.PhoneAuthProvider
+  - title: "SAMLAuthProvider"
+    path: /docs/reference/js/firebase.auth.SAMLAuthProvider
+  - title: "RecaptchaVerifier"
+    path: /docs/reference/js/firebase.auth.RecaptchaVerifier
+  - title: "UserMetadata"
+    path: /docs/reference/js/firebase.auth.UserMetadata
+  - title: "User"
+    path: /docs/reference/js/firebase.User
+  - title: "UserInfo"
+    path: /docs/reference/js/firebase.UserInfo
+
+- title: "firebase.database"
+  path: /docs/reference/js/firebase.database
+  section:
+  - title: "Database"
+    path: /docs/reference/js/firebase.database.Database
+  - title: "DataSnapshot"
+    path: /docs/reference/js/firebase.database.DataSnapshot
+  - title: "OnDisconnect"
+    path: /docs/reference/js/firebase.database.OnDisconnect
+  - title: "Reference"
+    path: /docs/reference/js/firebase.database.Reference
+  - title: "ServerValue"
+    path: /docs/reference/js/firebase.database.ServerValue
+  - title: "ThenableReference"
+    path: /docs/reference/js/firebase.database.ThenableReference
+  - title: "Query"
+    path: /docs/reference/js/firebase.database.Query
+- title: "firebase.firestore"
+  path: /docs/reference/js/firebase.firestore
+  section:
+  - title: "Blob"
+    path: /docs/reference/js/firebase.firestore.Blob
+  - title: "CollectionReference"
+    path: /docs/reference/js/firebase.firestore.CollectionReference
+  - title: "DocumentChange"
+    path: /docs/reference/js/firebase.firestore.DocumentChange
+  - title: "DocumentReference"
+    path: /docs/reference/js/firebase.firestore.DocumentReference
+  - title: "DocumentSnapshot"
+    path: /docs/reference/js/firebase.firestore.DocumentSnapshot
+  - title: "FieldPath"
+    path: /docs/reference/js/firebase.firestore.FieldPath
+  - title: "FieldValue"
+    path: /docs/reference/js/firebase.firestore.FieldValue
+  - title: "Firestore"
+    path: /docs/reference/js/firebase.firestore.Firestore
+  - title: "FirestoreError"
+    path: /docs/reference/js/firebase.firestore.FirestoreError
+  - title: "GeoPoint"
+    path: /docs/reference/js/firebase.firestore.GeoPoint
+  - title: "GetOptions"
+    path: /docs/reference/js/firebase.firestore.GetOptions
+  - title: "PersistenceSettings"
+    path: /docs/reference/js/firebase.firestore.PersistenceSettings
+  - title: "Query"
+    path: /docs/reference/js/firebase.firestore.Query
+  - title: "QueryDocumentSnapshot"
+    path: /docs/reference/js/firebase.firestore.QueryDocumentSnapshot
+  - title: "QuerySnapshot"
+    path: /docs/reference/js/firebase.firestore.QuerySnapshot
+  - title: "SetOptions"
+    path: /docs/reference/js/firebase.firestore.SetOptions
+  - title: "Settings"
+    path: /docs/reference/js/firebase.firestore.Settings
+  - title: "SnapshotListenOptions"
+    path: /docs/reference/js/firebase.firestore.SnapshotListenOptions
+  - title: "SnapshotMetadata"
+    path: /docs/reference/js/firebase.firestore.SnapshotMetadata
+  - title: "SnapshotOptions"
+    path: /docs/reference/js/firebase.firestore.SnapshotOptions
+  - title: "TimeStamp"
+    path: /docs/reference/js/firebase.firestore.TimeStamp
+  - title: "Transaction"
+    path: /docs/reference/js/firebase.firestore.Transaction
+  - title: "WriteBatch"
+    path: /docs/reference/js/firebase.firestore.WriteBatch
+
+- title: "firebase.functions"
+  path: /docs/reference/js/firebase.functions
+  section:
+  - title: "Functions"
+    path: /docs/reference/js/firebase.functions.Functions
+  - title: "HttpsCallable"
+    path: /docs/reference/js/firebase.functions.HttpsCallable
+  - title: "HttpsCallableOptions"
+    path: /docs/reference/js/firebase.functions.HttpsCallableOptions
+  - title: "HttpsCallableResult"
+    path: /docs/reference/js/firebase.functions.HttpsCallableResult
+  - title: "HttpsError"
+    path: /docs/reference/js/firebase.functions.HttpsError
+
+- title: "firebase.messaging"
+  path: /docs/reference/js/firebase.messaging
+  section:
+  - title: "Messaging"
+    path: /docs/reference/js/firebase.messaging.Messaging
+
+- title: "firebase.storage"
+  path: /docs/reference/js/firebase.storage
+  section:
+  - title: "Storage"
+    path: /docs/reference/js/firebase.storage.Storage
+  - title: "FullMetadata"
+    path: /docs/reference/js/firebase.storage.FullMetadata
+  - title: "Reference"
+    path: /docs/reference/js/firebase.storage.Reference
+  - title: "SettableMetadata"
+    path: /docs/reference/js/firebase.storage.SettableMetadata
+  - title: "UploadMetadata"
+    path: /docs/reference/js/firebase.storage.UploadMetadata
+  - title: "UploadTask"
+    path: /docs/reference/js/firebase.storage.UploadTask
+  - title: "UploadTaskSnapshot"
+    path: /docs/reference/js/firebase.storage.UploadTaskSnapshot

docgen/content-sources/node/HOME.md

@@ -0,0 +1,12 @@
+# Firebase JavaScript SDK Reference For Node.js
+The Firebase JavaScript SDK implements the client-side libraries used by
+applications using Firebase services. This SDK is distributed via:
+
+- CDN (`<script src="https://www.gstatic.com/firebasejs/{{ web_sdk_version }}/firebase.js"></script>`)
+- [npm package](https://www.npmjs.com/package/firebase)
+- [Bower package](https://github.com/firebase/firebase-bower)
+
+To get started using Firebase, see
+[Add Firebase to your JavaScript Project](https://firebase.google.com/docs/web/setup).
+
+For source code, see the [Firebase JavaScript SDK Github repo](https://github.com/firebase/firebase-js-sdk).

docgen/content-sources/node/toc.yaml

@@ -0,0 +1,174 @@
+toc:
+- title: "admin"
+  path: /docs/reference/node/admin
+  section:
+  - title: "AppOptions"
+    path: /docs/reference/node/admin.AppOptions
+  - title: "FirebaseArrayIndexError"
+    path: /docs/reference/node/admin.FirebaseArrayIndexError
+  - title: "FirebaseError"
+    path: /docs/reference/node/admin.FirebaseError
+  - title: "GoogleOAuthAccessToken"
+    path: /docs/reference/node/admin.GoogleOAuthAccessToken
+  - title: "ServiceAccount"
+    path: /docs/reference/node/admin.ServiceAccount
+
+- title: "admin.app"
+  path: /docs/reference/node/admin.app
+  section:
+  - title: "App"
+    path: /docs/reference/node/admin.app.App
+
+- title: "admin.auth"
+  path: /docs/reference/node/admin.auth
+  section:
+  - title: "Auth"
+    path: /docs/reference/node/admin.auth.Auth
+  - title: "ActionCodeSettings"
+    path: /docs/reference/node/admin.auth.ActionCodeSettings
+  - title: "CreateRequest"
+    path: /docs/reference/node/admin.auth.CreateRequest
+  - title: "UpdateRequest"
+    path: /docs/reference/node/admin.auth.UpdateRequest
+  - title: "UserImportOptions"
+    path: /docs/reference/node/admin.auth.UserImportOptions
+  - title: "UserImportRecord"
+    path: /docs/reference/node/admin.auth.UserImportRecord
+  - title: "UserImportResult"
+    path: /docs/reference/node/admin.auth.UserImportResult
+  - title: "DecodedIdToken"
+    path: /docs/reference/node/admin.auth.DecodedIdToken
+  - title: "UserInfo"
+    path: /docs/reference/node/admin.auth.UserInfo
+  - title: "UserMetadata"
+    path: /docs/reference/node/admin.auth.UserMetadata
+  - title: "UserRecord"
+    path: /docs/reference/node/admin.auth.UserRecord
+  - title: "SessionCookieOptions"
+    path: /docs/reference/node/admin.auth.SessionCookieOptions
+  - title: "BaseAuth"
+    path: /docs/reference/node/admin.auth.BaseAuth
+  - title: "ListUsersResult"
+    path: /docs/reference/node/admin.auth.ListUsersResult
+
+- title: "admin.credential"
+  path: /docs/reference/node/admin.credential
+  section:
+  - title: "Credential"
+    path: /docs/reference/node/admin.credential.Credential
+
+- title: "admin.database"
+  path: /docs/reference/node/admin.database
+  section:
+  - title: "Database"
+    path: /docs/reference/node/admin.database.Database
+  - title: "DataSnapshot"
+    path: /docs/reference/node/admin.database.DataSnapshot
+  - title: "OnDisconnect"
+    path: /docs/reference/node/admin.database.OnDisconnect
+  - title: "Query"
+    path: /docs/reference/node/admin.database.Query
+  - title: "Reference"
+    path: /docs/reference/node/admin.database.Reference
+  - title: "ServerValue"
+    path: /docs/reference/node/admin.database.ServerValue
+  - title: "ThenableReference"
+    path: /docs/reference/node/admin.database.ThenableReference
+
+- title: "admin.firestore"
+  path: /docs/reference/node/admin.firestore
+  section:
+  - title: "FieldPath"
+    path: /docs/reference/node/admin.firestore.FieldPath
+  - title: "FieldValue"
+    path: /docs/reference/node/admin.firestore.FieldValue
+  - title: "GeoPoint"
+    path: /docs/reference/node/admin.firestore.GeoPoint
+
+- title: "admin.instanceId"
+  path: /docs/reference/node/admin.instanceId
+  section:
+  - title: "InstanceId"
+    path: /docs/reference/node/admin.instanceId.InstanceId
+
+- title: "admin.messaging"
+  path: /docs/reference/node/admin.messaging
+  section:
+  - title: "TopicMessage"
+    path: /docs/reference/node/TopicMessage
+  - title: "TokenMessage"
+    path: /docs/reference/node/TokenMessage
+  - title: "ConditionMessage"
+    path: /docs/reference/node/ConditionMessage
+  - title: "AndroidConfig"
+    path: /docs/reference/node/admin.messaging.AndroidConfig
+  - title: "AndroidNotification"
+    path: /docs/reference/node/admin.messaging.AndroidNotification
+  - title: "Messaging"
+    path: /docs/reference/node/admin.messaging.Messaging
+  - title: "MessagingConditionResponse"
+    path: /docs/reference/node/admin.messaging.MessagingConditionResponse
+  - title: "MessagingDeviceGroupResponse"
+    path: /docs/reference/node/admin.messaging.MessagingDeviceGroupResponse
+  - title: "MessagingDeviceResult"
+    path: /docs/reference/node/admin.messaging.MessagingDeviceResult
+  - title: "MessagingDevicesResponse"
+    path: /docs/reference/node/admin.messaging.MessagingDevicesResponse
+  - title: "MessagingOptions"
+    path: /docs/reference/node/admin.messaging.MessagingOptions
+  - title: "MessagingPayload"
+    path: /docs/reference/node/admin.messaging.MessagingPayload
+  - title: "MessagingTopicResponse"
+    path: /docs/reference/node/admin.messaging.MessagingTopicResponse
+  - title: "MessagingTopicManagementResponse"
+    path: /docs/reference/node/admin.messaging.MessagingTopicManagementResponse
+  - title: "NotificationMessagePayload"
+    path: /docs/reference/node/admin.messaging.NotificationMessagePayload
+  - title: "MulticastMessage"
+    path: /docs/reference/node/admin.messaging.MulticastMessage
+  - title: "WebpushNotification"
+    path: /docs/reference/node/admin.messaging.WebpushNotification
+  - title: "WebpushFcmOptions"
+    path: /docs/reference/node/admin.messaging.WebpushFcmOptions
+  - title: "DataMessagePayload"
+    path: /docs/reference/node/admin.messaging.DataMessagePayload
+  - title: "BatchResponse"
+    path: /docs/reference/node/admin.messaging.BatchResponse
+  - title: "SendResponse"
+    path: /docs/reference/node/admin.messaging.SendResponse
+  - title: "ApnsConfig"
+    path: /docs/reference/node/admin.messaging.ApnsConfig
+  - title: "ApnsPayload"
+    path: /docs/reference/node/admin.messaging.ApnsPayload
+  - title: "Aps"
+    path: /docs/reference/node/admin.messaging.Aps
+  - title: "ApsAlert"
+    path: /docs/reference/node/admin.messaging.ApsAlert
+  - title: "CriticalSound"
+    path: /docs/reference/node/admin.messaging.CriticalSound
+  - title: "Notification"
+    path: /docs/reference/node/admin.messaging.Notification
+  - title: "WebpushConfig"
+    path: /docs/reference/node/admin.messaging.WebpushConfig
+
+- title: "admin.projectManagement"
+  path: /docs/reference/node/admin.projectManagement
+  section:
+  - title: "AndroidApp"
+    path: /docs/reference/node/admin.projectManagement.AndroidApp
+  - title: "AndroidAppMetadata"
+    path: /docs/reference/node/admin.projectManagement.AndroidAppMetadata
+  - title: "IosApp"
+    path: /docs/reference/node/admin.projectManagement.IosApp
+  - title: "IosAppMetadata"
+    path: /docs/reference/node/admin.projectManagement.IosAppMetadata
+  - title: "ProjectManagement"
+    path: /docs/reference/node/admin.projectManagement.ProjectManagement
+  - title: "ShaCertificate"
+    path: /docs/reference/node/admin.projectManagement.ShaCertificate
+
+- title: "admin.storage"
+  path: /docs/reference/node/admin.storage
+  section:
+  - title: "Storage"
+    path: /docs/reference/node/admin.storage.Storage