123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 |
- /*! firebase-admin v12.1.1 */
- "use strict";
- /*!
- * 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.
- */
- Object.defineProperty(exports, "__esModule", { value: true });
- exports.ProjectManagementRequestHandler = exports.assertServerResponse = void 0;
- const api_request_1 = require("../utils/api-request");
- const error_1 = require("../utils/error");
- const index_1 = require("../utils/index");
- const validator = require("../utils/validator");
- /** Project management backend host and port. */
- const PROJECT_MANAGEMENT_HOST_AND_PORT = 'firebase.googleapis.com:443';
- /** Project management backend path. */
- const PROJECT_MANAGEMENT_PATH = '/v1/';
- /** Project management beta backend path. */
- const PROJECT_MANAGEMENT_BETA_PATH = '/v1beta1/';
- /** Project management request header. */
- const PROJECT_MANAGEMENT_HEADERS = {
- 'X-Client-Version': `Node/Admin/${(0, index_1.getSdkVersion)()}`,
- };
- /** Project management request timeout duration in milliseconds. */
- const PROJECT_MANAGEMENT_TIMEOUT_MILLIS = 10000;
- const LIST_APPS_MAX_PAGE_SIZE = 100;
- const CERT_TYPE_API_MAP = {
- sha1: 'SHA_1',
- sha256: 'SHA_256',
- };
- function assertServerResponse(condition, responseData, message) {
- if (!condition) {
- throw new error_1.FirebaseProjectManagementError('invalid-server-response', `${message} Response data: ${JSON.stringify(responseData, null, 2)}`);
- }
- }
- exports.assertServerResponse = assertServerResponse;
- /**
- * Class that provides mechanism to send requests to the Firebase project management backend
- * endpoints.
- *
- * @internal
- */
- class ProjectManagementRequestHandler {
- static wrapAndRethrowHttpError(errStatusCode, errText) {
- let errorCode;
- let errorMessage;
- switch (errStatusCode) {
- case 400:
- errorCode = 'invalid-argument';
- errorMessage = 'Invalid argument provided.';
- break;
- case 401:
- case 403:
- errorCode = 'authentication-error';
- errorMessage = 'An error occurred when trying to authenticate. Make sure the credential '
- + 'used to authenticate this SDK has the proper permissions. See '
- + 'https://firebase.google.com/docs/admin/setup for setup instructions.';
- break;
- case 404:
- errorCode = 'not-found';
- errorMessage = 'The specified entity could not be found.';
- break;
- case 409:
- errorCode = 'already-exists';
- errorMessage = 'The specified entity already exists.';
- break;
- case 500:
- errorCode = 'internal-error';
- errorMessage = 'An internal error has occurred. Please retry the request.';
- break;
- case 503:
- errorCode = 'service-unavailable';
- errorMessage = 'The server could not process the request in time. See the error '
- + 'documentation for more details.';
- break;
- default:
- errorCode = 'unknown-error';
- errorMessage = 'An unknown server error was returned.';
- }
- if (!errText) {
- errText = '<missing>';
- }
- throw new error_1.FirebaseProjectManagementError(errorCode, `${errorMessage} Status code: ${errStatusCode}. Raw server response: "${errText}".`);
- }
- /**
- * @param app - The app used to fetch access tokens to sign API requests.
- * @constructor
- */
- constructor(app) {
- this.baseUrl = `https://${PROJECT_MANAGEMENT_HOST_AND_PORT}${PROJECT_MANAGEMENT_PATH}`;
- this.baseBetaUrl = `https://${PROJECT_MANAGEMENT_HOST_AND_PORT}${PROJECT_MANAGEMENT_BETA_PATH}`;
- this.httpClient = new api_request_1.AuthorizedHttpClient(app);
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the project whose Android
- * apps you want to list.
- */
- listAndroidApps(parentResourceName) {
- return this.invokeRequestHandler('GET', `${parentResourceName}/androidApps?page_size=${LIST_APPS_MAX_PAGE_SIZE}`,
- /* requestData */ null, 'v1beta1');
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
- * you want to list.
- */
- listIosApps(parentResourceName) {
- return this.invokeRequestHandler('GET', `${parentResourceName}/iosApps?page_size=${LIST_APPS_MAX_PAGE_SIZE}`,
- /* requestData */ null, 'v1beta1');
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the project whose iOS apps
- * you want to list.
- */
- listAppMetadata(parentResourceName) {
- return this.invokeRequestHandler('GET', `${parentResourceName}:searchApps?page_size=${LIST_APPS_MAX_PAGE_SIZE}`,
- /* requestData */ null, 'v1beta1');
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the project that you want
- * to create the Android app within.
- */
- createAndroidApp(parentResourceName, packageName, displayName) {
- const requestData = {
- packageName,
- };
- if (validator.isNonEmptyString(displayName)) {
- requestData.displayName = displayName;
- }
- return this
- .invokeRequestHandler('POST', `${parentResourceName}/androidApps`, requestData, 'v1beta1')
- .then((responseData) => {
- assertServerResponse(validator.isNonNullObject(responseData), responseData, 'createAndroidApp\'s responseData must be a non-null object.');
- assertServerResponse(validator.isNonEmptyString(responseData.name), responseData, 'createAndroidApp\'s responseData.name must be a non-empty string.');
- return this.pollRemoteOperationWithExponentialBackoff(responseData.name);
- });
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the project that you want
- * to create the iOS app within.
- */
- createIosApp(parentResourceName, bundleId, displayName) {
- const requestData = {
- bundleId,
- };
- if (validator.isNonEmptyString(displayName)) {
- requestData.displayName = displayName;
- }
- return this
- .invokeRequestHandler('POST', `${parentResourceName}/iosApps`, requestData, 'v1beta1')
- .then((responseData) => {
- assertServerResponse(validator.isNonNullObject(responseData), responseData, 'createIosApp\'s responseData must be a non-null object.');
- assertServerResponse(validator.isNonEmptyString(responseData.name), responseData, 'createIosApp\'s responseData.name must be a non-empty string.');
- return this.pollRemoteOperationWithExponentialBackoff(responseData.name);
- });
- }
- /**
- * @param resourceName - Fully-qualified resource name of the entity whose display name you
- * want to set.
- */
- setDisplayName(resourceName, newDisplayName) {
- const requestData = {
- displayName: newDisplayName,
- };
- return this
- .invokeRequestHandler('PATCH', `${resourceName}?update_mask=display_name`, requestData, 'v1beta1')
- .then(() => undefined);
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the Android app whose SHA
- * certificates you want to get.
- */
- getAndroidShaCertificates(parentResourceName) {
- return this.invokeRequestHandler('GET', `${parentResourceName}/sha`, /* requestData */ null, 'v1beta1');
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the Android app that you
- * want to add the given SHA certificate to.
- */
- addAndroidShaCertificate(parentResourceName, certificate) {
- const requestData = {
- shaHash: certificate.shaHash,
- certType: CERT_TYPE_API_MAP[certificate.certType],
- };
- return this
- .invokeRequestHandler('POST', `${parentResourceName}/sha`, requestData, 'v1beta1')
- .then(() => undefined);
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the app whose config you
- * want to get.
- */
- getConfig(parentResourceName) {
- return this.invokeRequestHandler('GET', `${parentResourceName}/config`, /* requestData */ null, 'v1beta1');
- }
- /**
- * @param parentResourceName - Fully-qualified resource name of the entity that you want to
- * get.
- */
- getResource(parentResourceName) {
- return this.invokeRequestHandler('GET', parentResourceName, /* requestData */ null, 'v1beta1');
- }
- /**
- * @param resourceName - Fully-qualified resource name of the entity that you want to
- * delete.
- */
- deleteResource(resourceName) {
- return this
- .invokeRequestHandler('DELETE', resourceName, /* requestData */ null, 'v1beta1')
- .then(() => undefined);
- }
- pollRemoteOperationWithExponentialBackoff(operationResourceName) {
- const poller = new api_request_1.ExponentialBackoffPoller();
- return poller.poll(() => {
- return this.invokeRequestHandler('GET', operationResourceName, /* requestData */ null)
- .then((responseData) => {
- if (responseData.error) {
- const errStatusCode = responseData.error.code || 500;
- const errText = responseData.error.message || JSON.stringify(responseData.error);
- ProjectManagementRequestHandler.wrapAndRethrowHttpError(errStatusCode, errText);
- }
- if (!responseData.done) {
- // Continue polling.
- return null;
- }
- // Polling complete. Resolve with operation response JSON.
- return responseData.response;
- });
- });
- }
- /**
- * Invokes the request handler with the provided request data.
- */
- invokeRequestHandler(method, path, requestData, apiVersion = 'v1') {
- const baseUrlToUse = (apiVersion === 'v1') ? this.baseUrl : this.baseBetaUrl;
- const request = {
- method,
- url: `${baseUrlToUse}${path}`,
- headers: PROJECT_MANAGEMENT_HEADERS,
- data: requestData,
- timeout: PROJECT_MANAGEMENT_TIMEOUT_MILLIS,
- };
- return this.httpClient.send(request)
- .then((response) => {
- // Send non-JSON responses to the catch() below, where they will be treated as errors.
- if (!response.isJson()) {
- throw new api_request_1.HttpError(response);
- }
- return response.data;
- })
- .catch((err) => {
- if (err instanceof api_request_1.HttpError) {
- ProjectManagementRequestHandler.wrapAndRethrowHttpError(err.response.status, err.response.text);
- }
- throw err;
- });
- }
- }
- exports.ProjectManagementRequestHandler = ProjectManagementRequestHandler;
|