Implement project-scoped operations for the SDK (#552)

* Added AppMetadata type

* listAppMetadata: implement listAppMetadata in ProjectManagement class

* Implement setDisplayName() for ProjectManagement class

* Update CHANGELOG.MD

*  Update documentation

Author: TrCaM

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Unreleased
 
--
+- [added] `admin.projectManagement().listAppMetadata()` method to list the app summary of up to 100
+  apps in a Firebase project
+- [added] `admin.projectManagement().setDisplayName()` method to update the display name of a
+  Firebase project
 
 # v8.0.0
 

src/index.d.ts

@@ -4829,55 +4829,94 @@ declare namespace admin.projectManagement {
   }
 
   /**
-   * Metadata about a Firebase Android app.
+   * Metadata about a Firebase app.
    */
-  interface AndroidAppMetadata {
+  interface AppMetadata {
 
     /**
-     * The fully-qualified resource name that identifies this app.
-     *
-     * This is useful when manually constructing requests for Firebase's public API.
+     * The globally unique, Firebase-assigned identifier of the app.
      *
      * @example
      * ```javascript
-     * var resourceName = androidAppMetadata.resourceName;
+     * var appId = appMetadata.appId;
      * ```
      */
-    resourceName: string;
+    appId: string;
 
     /**
-     * The globally unique, Firebase-assigned identifier of the app.
+     * The optional user-assigned display name of the app.
      *
      * @example
      * ```javascript
-     * var appId = androidAppMetadata.appId;
+     * var displayName = appMetadata.displayName;
      * ```
      */
-    appId: string;
+    displayName?: string;
 
     /**
-     * The optional user-assigned display name of the app.
+     * The development platform of the app. Supporting Android and iOS app platforms.
      *
      * @example
      * ```javascript
-     * var displayName = androidAppMetadata.displayName;
+     * var platform = AppPlatform.ANDROID;
      * ```
      */
-    displayName: string | null;
+    platform: AppPlatform;
 
     /**
      * The globally unique, user-assigned ID of the parent project for the app.
      *
      * @example
      * ```javascript
-     * var projectId = androidAppMetadata.projectId;
+     * var projectId = appMetadata.projectId;
      * ```
      */
     projectId: string;
 
     /**
-     * The canonical package name of the Android App, as would appear in the Google
-     * Play Developer Console.
+     * The fully-qualified resource name that identifies this app.
+     *
+     * This is useful when manually constructing requests for Firebase's public API.
+     *
+     * @example
+     * ```javascript
+     * var resourceName = androidAppMetadata.resourceName;
+     * ```
+     */
+    resourceName: string;
+  }
+
+  /**
+   * Platforms with which a Firebase App can be associated.
+   */
+  enum AppPlatform {
+
+    /**
+     * Unknown state. This is only used for distinguishing unset values.
+     */
+    PLATFORM_UNKNOWN = 'PLATFORM_UNKNOWN',
+
+    /**
+     * The Firebase App is associated with iOS.
+     */
+    IOS = 'IOS',
+
+    /**
+     * The Firebase App is associated with Android.
+     */
+    ANDROID = 'ANDROID',
+  }
+
+  /**
+   * Metadata about a Firebase Android App.
+   */
+  interface AndroidAppMetadata extends AppMetadata {
+
+    platform: AppPlatform.ANDROID;
+
+    /**
+     * The canonical package name of the Android App, as would appear in the Google Play Developer
+     * Console.
      *
      * @example
      * ```javascript
@@ -4887,6 +4926,23 @@ declare namespace admin.projectManagement {
     packageName: string;
   }
 
+  /**
+   * Metadata about a Firebase iOS App.
+   */
+  interface IosAppMetadata extends AppMetadata {
+    platform: AppPlatform.IOS;
+
+    /**
+     * The canonical bundle ID of the iOS App as it would appear in the iOS App Store.
+     *
+     * @example
+     * ```javascript
+     * var bundleId = iosAppMetadata.bundleId;
+     *```
+     */
+    bundleId: string;
+  }
+
   /**
    * A reference to a Firebase Android app.
    *
@@ -4951,65 +5007,6 @@ declare namespace admin.projectManagement {
     getConfig(): Promise<string>;
   }
 
-  /**
-   * Metadata about a Firebase iOS app.
-   */
-  interface IosAppMetadata {
-
-    /**
-     * The fully-qualified resource name that identifies this app.
-     *
-     * This is useful when manually constructing requests for Firebase's public API.
-     *
-     * @example
-     * ```javascript
-     * var resourceName = iOSAppMetadata.resourceName;
-     * ```
-     */
-    resourceName: string;
-
-    /**
-     * The globally unique, Firebase-assigned identifier of the app.
-     *
-     * @example
-     * ```javascript
-     * var appId = androidAppMetadata.appId;
-     * ``
-     */
-    appId: string;
-
-    /**
-     * The optional user-assigned display name of the app.
-     *
-     * @example
-     * ```javascript
-     * var displayName = iOSAppMetadata.displayName;
-     * ```
-     */
-    displayName: string;
-
-    /**
-     * The globally unique, user-assigned ID of the parent project for the app.
-     *
-     * @example
-     * ```javascript
-     * var projectId = iOSAppMetadata.projectId;
-     * ```
-     */
-    projectId: string;
-
-    /**
-     * The canonical bundle ID of the iOS App as it would appear in the iOS App
-     * Store.
-     *
-     * @example
-     * ```javascript
-     * var bundleId = iosAppMetadata.bundleId;
-     *```
-     */
-    bundleId: string;
-  }
-
   /**
    * A reference to a Firebase iOS app.
    *
@@ -5056,6 +5053,13 @@ declare namespace admin.projectManagement {
   interface ProjectManagement {
     app: admin.app.App;
 
+    /**
+     * Lists up to 100 Firebase apps associated with this Firebase project.
+     *
+     * @return A promise that resolves to the metadata list of the apps.
+     */
+    listAppMetadata(): Promise<admin.projectManagement.AppMetadata[]>;
+
     /**
      * Lists up to 100 Firebase Android apps associated with this Firebase project.
      *
@@ -5082,6 +5086,15 @@ declare namespace admin.projectManagement {
      */
     androidApp(appId: string): admin.projectManagement.AndroidApp;
 
+    /**
+     * Update the display name of this Firebase project.
+     *
+     * @param newDisplayName The new display name to be updated.
+     *
+     * @return A promise that resolves when the project display name has been updated.
+     */
+    setDisplayName(newDisplayName: string): Promise<void>;
+
     /**
      * Creates an `iOSApp` object, referencing the specified iOS app within
      * this Firebase project.

src/project-management/android-app.ts

@@ -17,6 +17,7 @@
 import { FirebaseProjectManagementError } from '../utils/error';
 import * as validator from '../utils/validator';
 import { ProjectManagementRequestHandler, assertServerResponse } from './project-management-api-request';
+import { AndroidAppMetadata, AppPlatform } from './app-metadata';
 
 export class AndroidApp {
   private readonly resourceName: string;
@@ -49,6 +50,7 @@ export class AndroidApp {
           });
 
           const metadata: AndroidAppMetadata = {
+            platform: AppPlatform.ANDROID,
             resourceName: responseData.name,
             appId: responseData.appId,
             displayName: responseData.displayName || null,
@@ -127,14 +129,6 @@ export class AndroidApp {
   }
 }
 
-export interface AndroidAppMetadata {
-  readonly resourceName: string;
-  readonly appId: string;
-  readonly displayName: string | null;
-  readonly projectId: string;
-  readonly packageName: string;
-}
-
 export class ShaCertificate {
   public readonly certType: ('sha1' | 'sha256');
 

src/project-management/app-metadata.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright 2019 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export enum AppPlatform {
+  PLATFORM_UNKNOWN = 'PLATFORM_UNKNOWN',
+  IOS = 'IOS',
+  ANDROID = 'ANDROID',
+}
+
+export interface AppMetadata {
+  appId: string;
+  displayName?: string;
+  platform: AppPlatform;
+  projectId: string;
+  resourceName: string;
+}
+
+export interface AndroidAppMetadata extends AppMetadata {
+  platform: AppPlatform.ANDROID;
+  packageName: string;
+}
+
+export interface IosAppMetadata extends AppMetadata {
+  platform: AppPlatform.IOS;
+  bundleId: string;
+}

src/project-management/ios-app.ts

@@ -17,6 +17,7 @@
 import { FirebaseProjectManagementError } from '../utils/error';
 import * as validator from '../utils/validator';
 import { ProjectManagementRequestHandler, assertServerResponse } from './project-management-api-request';
+import { IosAppMetadata, AppPlatform } from './app-metadata';
 
 export class IosApp {
   private readonly resourceName: string;
@@ -49,6 +50,7 @@ export class IosApp {
           });
 
           const metadata: IosAppMetadata = {
+            platform: AppPlatform.IOS,
             resourceName: responseData.name,
             appId: responseData.appId,
             displayName: responseData.displayName || null,
@@ -85,11 +87,3 @@ export class IosApp {
         });
   }
 }
-
-export interface IosAppMetadata {
-  readonly resourceName: string;
-  readonly appId: string;
-  readonly displayName: string;
-  readonly projectId: string;
-  readonly bundleId: string;
-}

src/project-management/project-management-api-request.ts

@@ -139,6 +139,18 @@ export class ProjectManagementRequestHandler {
         'v1beta1');
   }
 
+  /**
+   * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
+   *     you want to list.
+   */
+  public listAppMetadata(parentResourceName: string): Promise<object> {
+    return this.invokeRequestHandler(
+        'GET',
+        `${parentResourceName}:searchApps?page_size=${LIST_APPS_MAX_PAGE_SIZE}`,
+        /* requestData */ null,
+        'v1beta1');
+  }
+
   /**
    * @param {string} parentResourceName Fully-qualified resource name of the project that you want
    *     to create the Android app within.