(WIP): Add ability to generate documentation from auto-generated typings

package.json

@@ -59,7 +59,8 @@
     "@types/node": "^10.10.0",
     "dicer": "^0.3.0",
     "jsonwebtoken": "^8.5.1",
-    "node-forge": "^0.9.1"
+    "node-forge": "^0.9.1",
+    "typedoc": "^0.18.0"
   },
   "optionalDependencies": {
     "@google-cloud/firestore": "^4.0.0",
@@ -112,7 +113,6 @@
     "sinon": "^9.0.0",
     "sinon-chai": "^3.0.0",
     "ts-node": "^3.3.0",
-    "typedoc": "^0.15.0",
     "typescript": "^3.7.3",
     "yargs": "^13.2.2"
   }

src/database/database-internal.ts

@@ -51,7 +51,6 @@ class DatabaseInternals implements FirebaseServiceInternalsInterface {
 }
 
 export class DatabaseService implements FirebaseServiceInterface {
-
   public readonly INTERNAL: DatabaseInternals = new DatabaseInternals();
 
   private readonly appInternal: FirebaseApp;

src/instance-id/instance-id.ts

@@ -51,6 +51,7 @@ class InstanceIdInternals implements FirebaseServiceInternalsInterface {
  *   current app.
  */
 export class InstanceId implements FirebaseServiceInterface {
+  /** @hidden */
   public INTERNAL: InstanceIdInternals = new InstanceIdInternals();
 
   private app_: FirebaseApp;
@@ -59,6 +60,7 @@ export class InstanceId implements FirebaseServiceInterface {
   /**
    * @param {FirebaseApp} app The app for this InstanceId service.
    * @constructor
+   * @hidden
    */
   constructor(app: FirebaseApp) {
     if (!validator.isNonNullObject(app) || !('options' in app)) {

src/messaging/messaging.ts

@@ -194,29 +194,27 @@ class MessagingInternals implements FirebaseServiceInternalsInterface {
 
 
 /**
- * Messaging service bound to the provided app.
+ * Gets the {@link admin.messaging.Messaging `Messaging`} service for the
+ * current app.
+ *
+ * @example
+ * ```javascript
+ * var messaging = app.messaging();
+ * // The above is shorthand for:
+ * // var messaging = admin.messaging(app);
+ * ```
+ *
+ * @return The `Messaging` service for the current app.
  */
 export class Messaging implements FirebaseServiceInterface {
-
+  /** @hidden */
   public INTERNAL: MessagingInternals = new MessagingInternals();
 
   private urlPath: string;
   private readonly appInternal: FirebaseApp;
   private readonly messagingRequestHandler: FirebaseMessagingRequestHandler;
 
-  /**
-   * Gets the {@link admin.messaging.Messaging `Messaging`} service for the
-   * current app.
-   *
-   * @example
-   * ```javascript
-   * var messaging = app.messaging();
-   * // The above is shorthand for:
-   * // var messaging = admin.messaging(app);
-   * ```
-   *
-   * @return The `Messaging` service for the current app.
-   */
+  /** @hidden */
   constructor(app: FirebaseApp) {
     if (!validator.isNonNullObject(app) || !('options' in app)) {
       throw new FirebaseMessagingError(

src/project-management/android-app.ts

@@ -22,6 +22,7 @@ import { AndroidAppMetadata, AppPlatform } from './app-metadata';
 export class AndroidApp {
   private readonly resourceName: string;
 
+  /** @hidden */
   constructor(
       public readonly appId: string,
       private readonly requestHandler: ProjectManagementRequestHandler) {
@@ -205,6 +206,7 @@ export class ShaCertificate {
    * ```javascript
    * var resourceName = shaCertificate.resourceName;
    * ```
+   * @hidden
    */
   constructor(public readonly shaHash: string, public readonly resourceName?: string) {
     if (/^[a-fA-F0-9]{40}$/.test(shaHash)) {

src/project-management/index.ts

@@ -42,7 +42,7 @@ export namespace admin.projectManagement {
   // See https://github.com/typescript-eslint/typescript-eslint/issues/363
   export import AndroidAppMetadata = appMetadataApi.AndroidAppMetadata
   export import AppMetadata = appMetadataApi.AppMetadata
-  export import AppPlatform = appMetadataApi.AppPlatform 
+  export import AppPlatform = appMetadataApi.AppPlatform;
   export import IosAppMetadata = appMetadataApi.IosAppMetadata
 
   // Allows for exposing classes as interfaces in typings

src/project-management/ios-app.ts

@@ -22,6 +22,7 @@ import { IosAppMetadata, AppPlatform } from './app-metadata';
 export class IosApp {
   private readonly resourceName: string;
 
+  /** @hidden */
   constructor(
       public readonly appId: string,
       private readonly requestHandler: ProjectManagementRequestHandler) {

src/project-management/project-management.ts

@@ -46,6 +46,7 @@ class ProjectManagementInternals implements FirebaseServiceInternalsInterface {
  * [`admin.projectManagement()`](admin.projectManagement#projectManagement).
  */
 export class ProjectManagement implements FirebaseServiceInterface {
+  /** @hidden */
   public readonly INTERNAL: ProjectManagementInternals = new ProjectManagementInternals();
 
   private readonly requestHandler: ProjectManagementRequestHandler;
@@ -54,6 +55,7 @@ export class ProjectManagement implements FirebaseServiceInterface {
   /**
    * @param {object} app The app for this ProjectManagement service.
    * @constructor
+   * @hidden
    */
   constructor(readonly app: FirebaseApp) {
     if (!validator.isNonNullObject(app) || !('options' in app)) {

src/remote-config/remote-config.ts

@@ -45,16 +45,21 @@ class RemoteConfigInternals implements FirebaseServiceInternalsInterface {
 }
 
 /**
- * Remote Config service bound to the provided app.
+ * The Firebase `RemoteConfig` service interface.
+ *
+ * Do not call this constructor directly. Instead, use
+ * [`admin.remoteConfig()`](admin.remoteConfig#remoteConfig).
  */
 export class RemoteConfig implements FirebaseServiceInterface {
+  /** @hidden */
   public readonly INTERNAL: RemoteConfigInternals = new RemoteConfigInternals();
 
   private readonly client: RemoteConfigApiClient;
 
   /**
    * @param {FirebaseApp} app The app for this RemoteConfig service.
    * @constructor
+   * @hidden
    */
   constructor(readonly app: FirebaseApp) {
     this.client = new RemoteConfigApiClient(app);

src/security-rules/security-rules.ts

@@ -97,6 +97,7 @@ export class Ruleset implements RulesetMetadata {
   public readonly createTime: string;
   public readonly source: RulesFile[];
 
+  /** @hidden */
   constructor(ruleset: RulesetResponse) {
     if (!validator.isNonNullObject(ruleset) ||
       !validator.isNonEmptyString(ruleset.name) ||
@@ -124,13 +125,15 @@ export class SecurityRules implements FirebaseServiceInterface {
   private static readonly CLOUD_FIRESTORE = 'cloud.firestore';
   private static readonly FIREBASE_STORAGE = 'firebase.storage';
 
+  /** @hidden */
   public readonly INTERNAL = new SecurityRulesInternals();
 
   private readonly client: SecurityRulesApiClient;
 
   /**
    * @param {object} app The app for this SecurityRules service.
    * @constructor
+   * @hidden
    */
   constructor(readonly app: FirebaseApp) {
     this.client = new SecurityRulesApiClient(app);