firebase-admin 9.12.0 → 10.0.0

package/lib/project-management/ios-app.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -20,9 +20,16 @@ exports.IosApp = void 0;
 var error_1 = require("../utils/error");
 var validator = require("../utils/validator");
 var project_management_api_request_internal_1 = require("./project-management-api-request-internal");
-var index_1 = require("./index");
-var AppPlatform = index_1.projectManagement.AppPlatform;
+var app_metadata_1 = require("./app-metadata");
+/**
+ * A reference to a Firebase iOS app.
+ *
+ * Do not call this constructor directly. Instead, use {@link ProjectManagement.iosApp}.
+ */
 var IosApp = /** @class */ (function () {
+    /**
+     * @internal
+     */
     function IosApp(appId, requestHandler) {
         this.appId = appId;
         this.requestHandler = requestHandler;
@@ -34,7 +41,7 @@ var IosApp = /** @class */ (function () {
     /**
      * Retrieves metadata about this iOS app.
      *
-     * @return {!Promise<admin.projectManagement.IosAppMetadata>} A promise that
+     * @returns A promise that
      *     resolves to the retrieved metadata about this iOS app.
      */
     IosApp.prototype.getMetadata = function () {
@@ -46,7 +53,7 @@ var IosApp = /** @class */ (function () {
                 project_management_api_request_internal_1.assertServerResponse(validator.isNonEmptyString(responseData[requiredField]), responseData, "getMetadata()'s responseData." + requiredField + " must be a non-empty string.");
             });
             var metadata = {
-                platform: AppPlatform.IOS,
+                platform: app_metadata_1.AppPlatform.IOS,
                 resourceName: responseData.name,
                 appId: responseData.appId,
                 displayName: responseData.displayName || null,
@@ -59,9 +66,9 @@ var IosApp = /** @class */ (function () {
     /**
      * Sets the optional user-assigned display name of the app.
      *
-     * @param newDisplayName The new display name to set.
+     * @param newDisplayName - The new display name to set.
      *
-     * @return A promise that resolves when the display name has
+     * @returns A promise that resolves when the display name has
      *     been set.
      */
     IosApp.prototype.setDisplayName = function (newDisplayName) {
@@ -70,7 +77,7 @@ var IosApp = /** @class */ (function () {
     /**
      * Gets the configuration artifact associated with this app.
      *
-     * @return A promise that resolves to the iOS app's Firebase
+     * @returns A promise that resolves to the iOS app's Firebase
      *     config file, in UTF-8 string format. This string is typically intended to
      *     be written to a plist file that gets shipped with your iOS app.
      */

package/lib/project-management/project-management-api-request-internal.d.ts

@@ -0,0 +1,17 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * Copyright 2018 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 declare function assertServerResponse(condition: boolean, responseData: object, message: string): void;

package/lib/project-management/project-management-api-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -19,8 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectManagementRequestHandler = exports.assertServerResponse = void 0;
 var api_request_1 = require("../utils/api-request");
 var error_1 = require("../utils/error");
-var validator = require("../utils/validator");
 var index_1 = require("../utils/index");
+var validator = require("../utils/validator");
 /** Project management backend host and port. */
 var PROJECT_MANAGEMENT_HOST_AND_PORT = 'firebase.googleapis.com:443';
 /** Project management backend path. */
@@ -48,11 +48,11 @@ exports.assertServerResponse = assertServerResponse;
  * Class that provides mechanism to send requests to the Firebase project management backend
  * endpoints.
  *
- * @private
+ * @internal
  */
 var ProjectManagementRequestHandler = /** @class */ (function () {
     /**
-     * @param {FirebaseApp} app The app used to fetch access tokens to sign API requests.
+     * @param app - The app used to fetch access tokens to sign API requests.
      * @constructor
      */
     function ProjectManagementRequestHandler(app) {
@@ -102,7 +102,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         throw new error_1.FirebaseProjectManagementError(errorCode, errorMessage + " Status code: " + errStatusCode + ". Raw server response: \"" + errText + "\".");
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the project whose Android
+     * @param parentResourceName - Fully-qualified resource name of the project whose Android
      *     apps you want to list.
      */
     ProjectManagementRequestHandler.prototype.listAndroidApps = function (parentResourceName) {
@@ -110,7 +110,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
+     * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
      *     you want to list.
      */
     ProjectManagementRequestHandler.prototype.listIosApps = function (parentResourceName) {
@@ -118,7 +118,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the project whose iOS apps
+     * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
      *     you want to list.
      */
     ProjectManagementRequestHandler.prototype.listAppMetadata = function (parentResourceName) {
@@ -126,7 +126,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the project that you want
+     * @param parentResourceName - Fully-qualified resource name of the project that you want
      *     to create the Android app within.
      */
     ProjectManagementRequestHandler.prototype.createAndroidApp = function (parentResourceName, packageName, displayName) {
@@ -146,7 +146,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         });
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the project that you want
+     * @param parentResourceName - Fully-qualified resource name of the project that you want
      *     to create the iOS app within.
      */
     ProjectManagementRequestHandler.prototype.createIosApp = function (parentResourceName, bundleId, displayName) {
@@ -166,7 +166,7 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
         });
     };
     /**
-     * @param {string} resourceName Fully-qualified resource name of the entity whose display name you
+     * @param resourceName - Fully-qualified resource name of the entity whose display name you
      *     want to set.
      */
     ProjectManagementRequestHandler.prototype.setDisplayName = function (resourceName, newDisplayName) {
@@ -178,14 +178,14 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
             .then(function () { return undefined; });
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the Android app whose SHA
+     * @param parentResourceName - Fully-qualified resource name of the Android app whose SHA
      *     certificates you want to get.
      */
     ProjectManagementRequestHandler.prototype.getAndroidShaCertificates = function (parentResourceName) {
         return this.invokeRequestHandler('GET', parentResourceName + "/sha", /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the Android app that you
+     * @param parentResourceName - Fully-qualified resource name of the Android app that you
      *     want to add the given SHA certificate to.
      */
     ProjectManagementRequestHandler.prototype.addAndroidShaCertificate = function (parentResourceName, certificate) {
@@ -198,21 +198,21 @@ var ProjectManagementRequestHandler = /** @class */ (function () {
             .then(function () { return undefined; });
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the app whose config you
+     * @param parentResourceName - Fully-qualified resource name of the app whose config you
      *     want to get.
      */
     ProjectManagementRequestHandler.prototype.getConfig = function (parentResourceName) {
         return this.invokeRequestHandler('GET', parentResourceName + "/config", /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} parentResourceName Fully-qualified resource name of the entity that you want to
+     * @param parentResourceName - Fully-qualified resource name of the entity that you want to
      *     get.
      */
     ProjectManagementRequestHandler.prototype.getResource = function (parentResourceName) {
         return this.invokeRequestHandler('GET', parentResourceName, /* requestData */ null, 'v1beta1');
     };
     /**
-     * @param {string} resourceName Fully-qualified resource name of the entity that you want to
+     * @param resourceName - Fully-qualified resource name of the entity that you want to
      *     delete.
      */
     ProjectManagementRequestHandler.prototype.deleteResource = function (resourceName) {

package/lib/project-management/project-management-namespace.d.ts

@@ -0,0 +1,82 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * Copyright 2021 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.
+ */
+import { App } from '../app';
+import { AppMetadata as TAppMetadata, AppPlatform as TAppPlatform } from './app-metadata';
+import { ProjectManagement as TProjectManagement } from './project-management';
+import { AndroidApp as TAndroidApp, AndroidAppMetadata as TAndroidAppMetadata, ShaCertificate as TShaCertificate } from './android-app';
+import { IosApp as TIosApp, IosAppMetadata as TIosAppMetadata } from './ios-app';
+/**
+  * Gets the {@link firebase-admin.project-management#ProjectManagement} service for the
+  * default app or a given app.
+  *
+  * `admin.projectManagement()` can be called with no arguments to access the
+  * default app's `ProjectManagement` service, or as `admin.projectManagement(app)` to access
+  * the `ProjectManagement` service associated with a specific app.
+  *
+  * @example
+  * ```javascript
+  * // Get the ProjectManagement service for the default app
+  * var defaultProjectManagement = admin.projectManagement();
+  * ```
+  *
+  * @example
+  * ```javascript
+  * // Get the ProjectManagement service for a given app
+  * var otherProjectManagement = admin.projectManagement(otherApp);
+  * ```
+  *
+  * @param app - Optional app whose `ProjectManagement` service
+  *     to return. If not provided, the default `ProjectManagement` service will
+  *     be returned. *
+  * @returns The default `ProjectManagement` service if no app is provided or the
+  *   `ProjectManagement` service associated with the provided app.
+  */
+export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
+export declare namespace projectManagement {
+    /**
+     * Type alias to {@link firebase-admin.project-management#AppMetadata}.
+     */
+    type AppMetadata = TAppMetadata;
+    /**
+     * Type alias to {@link firebase-admin.project-management#AppPlatform}.
+     */
+    type AppPlatform = TAppPlatform;
+    /**
+     * Type alias to {@link firebase-admin.project-management#ProjectManagement}.
+     */
+    type ProjectManagement = TProjectManagement;
+    /**
+     * Type alias to {@link firebase-admin.project-management#IosApp}.
+     */
+    type IosApp = TIosApp;
+    /**
+     * Type alias to {@link firebase-admin.project-management#IosAppMetadata}.
+     */
+    type IosAppMetadata = TIosAppMetadata;
+    /**
+     * Type alias to {@link firebase-admin.project-management#AndroidApp}.
+     */
+    type AndroidApp = TAndroidApp;
+    /**
+     * Type alias to {@link firebase-admin.project-management#AndroidAppMetadata}.
+     */
+    type AndroidAppMetadata = TAndroidAppMetadata;
+    /**
+     * Type alias to {@link firebase-admin.project-management#ShaCertificate}.
+     */
+    type ShaCertificate = TShaCertificate;
+}

package/lib/project-management/project-management-namespace.js

@@ -0,0 +1,18 @@
+/*! firebase-admin v10.0.0 */
+"use strict";
+/*!
+ * Copyright 2021 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/project-management/project-management.d.ts

@@ -0,0 +1,115 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * Copyright 2018 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.
+ */
+import { App } from '../app';
+import { AndroidApp, ShaCertificate } from './android-app';
+import { IosApp } from './ios-app';
+import { AppMetadata } from './app-metadata';
+/**
+ * The Firebase ProjectManagement service interface.
+ */
+export declare class ProjectManagement {
+    readonly app: App;
+    private readonly requestHandler;
+    private projectId;
+    /**
+     * Lists up to 100 Firebase Android apps associated with this Firebase project.
+     *
+     * @returns The list of Android apps.
+     */
+    listAndroidApps(): Promise<AndroidApp[]>;
+    /**
+     * Lists up to 100 Firebase iOS apps associated with this Firebase project.
+     *
+     * @returns The list of iOS apps.
+     */
+    listIosApps(): Promise<IosApp[]>;
+    /**
+     * Creates an `AndroidApp` object, referencing the specified Android app within
+     * this Firebase project.
+     *
+     * This method does not perform an RPC.
+     *
+     * @param appId - The `appId` of the Android app to reference.
+     *
+     * @returns An `AndroidApp` object that references the specified Firebase Android app.
+     */
+    androidApp(appId: string): AndroidApp;
+    /**
+     * Creates an `iOSApp` object, referencing the specified iOS app within
+     * this Firebase project.
+     *
+     * This method does not perform an RPC.
+     *
+     * @param appId - The `appId` of the iOS app to reference.
+     *
+     * @returns An `iOSApp` object that references the specified Firebase iOS app.
+     */
+    iosApp(appId: string): IosApp;
+    /**
+     * Creates a `ShaCertificate` object.
+     *
+     * This method does not perform an RPC.
+     *
+     * @param shaHash - The SHA-1 or SHA-256 hash for this certificate.
+     *
+     * @returns A `ShaCertificate` object contains the specified SHA hash.
+     */
+    shaCertificate(shaHash: string): ShaCertificate;
+    /**
+     * Creates a new Firebase Android app associated with this Firebase project.
+     *
+     * @param packageName - The canonical package name of the Android App,
+     *     as would appear in the Google Play Developer Console.
+     * @param displayName - An optional user-assigned display name for this
+     *     new app.
+     *
+     * @returns A promise that resolves to the newly created Android app.
+     */
+    createAndroidApp(packageName: string, displayName?: string): Promise<AndroidApp>;
+    /**
+     * Creates a new Firebase iOS app associated with this Firebase project.
+     *
+     * @param bundleId - The iOS app bundle ID to use for this new app.
+     * @param displayName - An optional user-assigned display name for this
+     *     new app.
+     *
+     * @returns A promise that resolves to the newly created iOS app.
+     */
+    createIosApp(bundleId: string, displayName?: string): Promise<IosApp>;
+    /**
+     * Lists up to 100 Firebase apps associated with this Firebase project.
+     *
+     * @returns A promise that resolves to the metadata list of the apps.
+     */
+    listAppMetadata(): Promise<AppMetadata[]>;
+    /**
+     * Update the display name of this Firebase project.
+     *
+     * @param newDisplayName - The new display name to be updated.
+     *
+     * @returns A promise that resolves when the project display name has been updated.
+     */
+    setDisplayName(newDisplayName: string): Promise<void>;
+    private transformResponseToAppMetadata;
+    private getResourceName;
+    private getProjectId;
+    /**
+     * Lists up to 100 Firebase apps for a specified platform, associated with this Firebase project.
+     */
+    private listPlatformApps;
+    private assertListAppsResponseData;
+}

package/lib/project-management/project-management.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -23,18 +23,15 @@ var validator = require("../utils/validator");
 var android_app_1 = require("./android-app");
 var ios_app_1 = require("./ios-app");
 var project_management_api_request_internal_1 = require("./project-management-api-request-internal");
-var index_1 = require("./index");
-var AppPlatform = index_1.projectManagement.AppPlatform;
+var app_metadata_1 = require("./app-metadata");
 /**
  * The Firebase ProjectManagement service interface.
- *
- * Do not call this constructor directly. Instead, use
- * [`admin.projectManagement()`](projectManagement#projectManagement).
  */
 var ProjectManagement = /** @class */ (function () {
     /**
-     * @param {object} app The app for this ProjectManagement service.
+     * @param app - The app for this ProjectManagement service.
      * @constructor
+     * @internal
      */
     function ProjectManagement(app) {
         this.app = app;
@@ -47,7 +44,7 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Lists up to 100 Firebase Android apps associated with this Firebase project.
      *
-     * @return The list of Android apps.
+     * @returns The list of Android apps.
      */
     ProjectManagement.prototype.listAndroidApps = function () {
         return this.listPlatformApps('android', 'listAndroidApps()');
@@ -55,7 +52,7 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Lists up to 100 Firebase iOS apps associated with this Firebase project.
      *
-     * @return The list of iOS apps.
+     * @returns The list of iOS apps.
      */
     ProjectManagement.prototype.listIosApps = function () {
         return this.listPlatformApps('ios', 'listIosApps()');
@@ -66,9 +63,9 @@ var ProjectManagement = /** @class */ (function () {
      *
      * This method does not perform an RPC.
      *
-     * @param appId The `appId` of the Android app to reference.
+     * @param appId - The `appId` of the Android app to reference.
      *
-     * @return An `AndroidApp` object that references the specified Firebase Android app.
+     * @returns An `AndroidApp` object that references the specified Firebase Android app.
      */
     ProjectManagement.prototype.androidApp = function (appId) {
         return new android_app_1.AndroidApp(appId, this.requestHandler);
@@ -79,9 +76,9 @@ var ProjectManagement = /** @class */ (function () {
      *
      * This method does not perform an RPC.
      *
-     * @param appId The `appId` of the iOS app to reference.
+     * @param appId - The `appId` of the iOS app to reference.
      *
-     * @return An `iOSApp` object that references the specified Firebase iOS app.
+     * @returns An `iOSApp` object that references the specified Firebase iOS app.
      */
     ProjectManagement.prototype.iosApp = function (appId) {
         return new ios_app_1.IosApp(appId, this.requestHandler);
@@ -91,9 +88,9 @@ var ProjectManagement = /** @class */ (function () {
      *
      * This method does not perform an RPC.
      *
-     * @param shaHash The SHA-1 or SHA-256 hash for this certificate.
+     * @param shaHash - The SHA-1 or SHA-256 hash for this certificate.
      *
-     * @return A `ShaCertificate` object contains the specified SHA hash.
+     * @returns A `ShaCertificate` object contains the specified SHA hash.
      */
     ProjectManagement.prototype.shaCertificate = function (shaHash) {
         return new android_app_1.ShaCertificate(shaHash);
@@ -101,12 +98,12 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Creates a new Firebase Android app associated with this Firebase project.
      *
-     * @param packageName The canonical package name of the Android App,
+     * @param packageName - The canonical package name of the Android App,
      *     as would appear in the Google Play Developer Console.
-     * @param displayName An optional user-assigned display name for this
+     * @param displayName - An optional user-assigned display name for this
      *     new app.
      *
-     * @return A promise that resolves to the newly created Android app.
+     * @returns A promise that resolves to the newly created Android app.
      */
     ProjectManagement.prototype.createAndroidApp = function (packageName, displayName) {
         var _this = this;
@@ -123,11 +120,11 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Creates a new Firebase iOS app associated with this Firebase project.
      *
-     * @param bundleId The iOS app bundle ID to use for this new app.
-     * @param displayName An optional user-assigned display name for this
+     * @param bundleId - The iOS app bundle ID to use for this new app.
+     * @param displayName - An optional user-assigned display name for this
      *     new app.
      *
-     * @return A promise that resolves to the newly created iOS app.
+     * @returns A promise that resolves to the newly created iOS app.
      */
     ProjectManagement.prototype.createIosApp = function (bundleId, displayName) {
         var _this = this;
@@ -144,7 +141,7 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Lists up to 100 Firebase apps associated with this Firebase project.
      *
-     * @return A promise that resolves to the metadata list of the apps.
+     * @returns A promise that resolves to the metadata list of the apps.
      */
     ProjectManagement.prototype.listAppMetadata = function () {
         var _this = this;
@@ -162,9 +159,9 @@ var ProjectManagement = /** @class */ (function () {
     /**
      * Update the display name of this Firebase project.
      *
-     * @param newDisplayName The new display name to be updated.
+     * @param newDisplayName - The new display name to be updated.
      *
-     * @return A promise that resolves when the project display name has been updated.
+     * @returns A promise that resolves when the project display name has been updated.
      */
     ProjectManagement.prototype.setDisplayName = function (newDisplayName) {
         var _this = this;
@@ -183,7 +180,7 @@ var ProjectManagement = /** @class */ (function () {
             project_management_api_request_internal_1.assertServerResponse(validator.isNonEmptyString(appJson.platform), responseData, '"apps[].platform" field must be present in the listAppMetadata() response data.');
             var metadata = {
                 appId: appJson.appId,
-                platform: AppPlatform[appJson.platform] || AppPlatform.PLATFORM_UNKNOWN,
+                platform: app_metadata_1.AppPlatform[appJson.platform] || app_metadata_1.AppPlatform.PLATFORM_UNKNOWN,
                 projectId: projectId,
                 resourceName: appJson.name,
             };