firebase-admin
Version:
Firebase admin SDK for Node.js
95 lines (94 loc) • 4.23 kB
JavaScript
/*! firebase-admin v13.3.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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.IosApp = void 0;
const error_1 = require("../utils/error");
const validator = require("../utils/validator");
const project_management_api_request_internal_1 = require("./project-management-api-request-internal");
const app_metadata_1 = require("./app-metadata");
/**
* A reference to a Firebase iOS app.
*
* Do not call this constructor directly. Instead, use {@link ProjectManagement.iosApp}.
*/
class IosApp {
/**
* @internal
*/
constructor(appId, requestHandler) {
this.appId = appId;
this.requestHandler = requestHandler;
if (!validator.isNonEmptyString(appId)) {
throw new error_1.FirebaseProjectManagementError('invalid-argument', 'appId must be a non-empty string.');
}
this.resourceName = `projects/-/iosApps/${appId}`;
}
/**
* Retrieves metadata about this iOS app.
*
* @returns A promise that
* resolves to the retrieved metadata about this iOS app.
*/
getMetadata() {
return this.requestHandler.getResource(this.resourceName)
.then((responseData) => {
(0, project_management_api_request_internal_1.assertServerResponse)(validator.isNonNullObject(responseData), responseData, 'getMetadata()\'s responseData must be a non-null object.');
const requiredFieldsList = ['name', 'appId', 'projectId', 'bundleId'];
requiredFieldsList.forEach((requiredField) => {
(0, project_management_api_request_internal_1.assertServerResponse)(validator.isNonEmptyString(responseData[requiredField]), responseData, `getMetadata()'s responseData.${requiredField} must be a non-empty string.`);
});
const metadata = {
platform: app_metadata_1.AppPlatform.IOS,
resourceName: responseData.name,
appId: responseData.appId,
displayName: responseData.displayName || null,
projectId: responseData.projectId,
bundleId: responseData.bundleId,
};
return metadata;
});
}
/**
* Sets the optional user-assigned display name of the app.
*
* @param newDisplayName - The new display name to set.
*
* @returns A promise that resolves when the display name has
* been set.
*/
setDisplayName(newDisplayName) {
return this.requestHandler.setDisplayName(this.resourceName, newDisplayName);
}
/**
* Gets the configuration artifact associated with this app.
*
* @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.
*/
getConfig() {
return this.requestHandler.getConfig(this.resourceName)
.then((responseData) => {
(0, project_management_api_request_internal_1.assertServerResponse)(validator.isNonNullObject(responseData), responseData, 'getConfig()\'s responseData must be a non-null object.');
const base64ConfigFileContents = responseData.configFileContents;
(0, project_management_api_request_internal_1.assertServerResponse)(validator.isBase64String(base64ConfigFileContents), responseData, 'getConfig()\'s responseData.configFileContents must be a base64 string.');
return Buffer.from(base64ConfigFileContents, 'base64').toString('utf8');
});
}
}
exports.IosApp = IosApp;