firebase-tools 13.3.0 → 13.4.0

package/lib/commands/firestore-databases-delete.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.command = void 0;
-const command_1 = require("../command");
 const clc = require("colorette");
+const command_1 = require("../command");
 const fsi = require("../firestore/api");
 const prompt_1 = require("../prompt");
 const logger_1 = require("../logger");
@@ -10,6 +10,7 @@ const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
 const error_1 = require("../error");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:databases:delete <database>")
     .description("Delete a database in your Cloud Firestore project. Database delete protection state must be disabled. To do so, use the update command: firebase firestore:databases:update <database> --delete-protection DISABLED")
     .option("--force", "Attempt to delete database without prompting for confirmation.")
@@ -17,6 +18,7 @@ exports.command = new command_1.Command("firestore:databases:delete <database>")
     .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
     .action(async (database, options) => {
     const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     if (!options.force) {
         const confirmMessage = `You are about to delete projects/${options.project}/databases/${database}. Do you wish to continue?`;
         const consent = await (0, prompt_1.promptOnce)({
@@ -33,7 +35,7 @@ exports.command = new command_1.Command("firestore:databases:delete <database>")
         logger_1.logger.info(JSON.stringify(databaseResp, undefined, 2));
     }
     else {
-        logger_1.logger.info(clc.bold(`Successfully deleted ${api.prettyDatabaseString(databaseResp)}`));
+        logger_1.logger.info(clc.bold(`Successfully deleted ${printer.prettyDatabaseString(databaseResp)}`));
     }
     return databaseResp;
 });

package/lib/commands/firestore-databases-get.js

@@ -7,19 +7,21 @@ const logger_1 = require("../logger");
 const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:databases:get [database]")
     .description("Get database in your Cloud Firestore project.")
     .before(requirePermissions_1.requirePermissions, ["datastore.databases.get"])
     .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
     .action(async (database, options) => {
     const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     const databaseId = database || "(default)";
     const databaseResp = await api.getDatabase(options.project, databaseId);
     if (options.json) {
         logger_1.logger.info(JSON.stringify(databaseResp, undefined, 2));
     }
     else {
-        api.prettyPrintDatabase(databaseResp);
+        printer.prettyPrintDatabase(databaseResp);
     }
     return databaseResp;
 });

package/lib/commands/firestore-databases-list.js

@@ -7,18 +7,20 @@ const logger_1 = require("../logger");
 const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:databases:list")
     .description("List databases in your Cloud Firestore project.")
     .before(requirePermissions_1.requirePermissions, ["datastore.databases.list"])
     .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
     .action(async (options) => {
     const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     const databases = await api.listDatabases(options.project);
     if (options.json) {
         logger_1.logger.info(JSON.stringify(databases, undefined, 2));
     }
     else {
-        api.prettyPrintDatabases(databases);
+        printer.prettyPrintDatabases(databases);
     }
     return databases;
 });

package/lib/commands/firestore-databases-restore.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const clc = require("colorette");
+const command_1 = require("../command");
+const fsi = require("../firestore/api");
+const logger_1 = require("../logger");
+const requirePermissions_1 = require("../requirePermissions");
+const types_1 = require("../emulator/types");
+const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
+exports.command = new command_1.Command("firestore:databases:restore")
+    .description("Restore a Firestore database in your Firebase project.")
+    .option("-d, --database <databaseID>", "ID of the database to restore into")
+    .option("-b, --backup <backup>", "Backup from which to restore")
+    .before(requirePermissions_1.requirePermissions, ["datastore.backups.restoreDatabase"])
+    .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
+    .action(async (options) => {
+    const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
+    if (!options.database) {
+        logger_1.logger.error("Missing required flag --database. See firebase firestore:databases:restore --help for more info");
+        return;
+    }
+    const databaseId = options.database;
+    if (!options.backup) {
+        logger_1.logger.error("Missing required flag --backup. See firebase firestore:databases:restore --help for more info");
+        return;
+    }
+    const backupName = options.backup;
+    const databaseResp = await api.restoreDatabase(options.project, databaseId, backupName);
+    if (options.json) {
+        logger_1.logger.info(JSON.stringify(databaseResp, undefined, 2));
+    }
+    else {
+        logger_1.logger.info(clc.bold(`Successfully initiated restore of ${printer.prettyDatabaseString(databaseResp)}`));
+        logger_1.logger.info("Please be sure to configure Firebase rules in your Firebase config file for\n" +
+            "the new database. By default, created databases will have closed rules that\n" +
+            "block any incoming third-party traffic.");
+    }
+    return databaseResp;
+});

package/lib/commands/firestore-databases-update.js

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.command = void 0;
-const command_1 = require("../command");
 const clc = require("colorette");
+const command_1 = require("../command");
 const fsi = require("../firestore/api");
 const types = require("../firestore/api-types");
 const logger_1 = require("../logger");
 const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:databases:update <database>")
     .description("Update a database in your Firebase project. Must specify at least one property to update.")
     .option("--json", "Prints raw json response of the create API call if specified")
@@ -18,6 +19,7 @@ exports.command = new command_1.Command("firestore:databases:update <database>")
     .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
     .action(async (database, options) => {
     const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     if (!options.deleteProtection && !options.pointInTimeRecovery) {
         logger_1.logger.error("Missing properties to update. See firebase firestore:databases:update --help for more info.");
         return;
@@ -53,7 +55,7 @@ exports.command = new command_1.Command("firestore:databases:update <database>")
         logger_1.logger.info(JSON.stringify(databaseResp, undefined, 2));
     }
     else {
-        logger_1.logger.info(clc.bold(`Successfully updated ${api.prettyDatabaseString(databaseResp)}`));
+        logger_1.logger.info(clc.bold(`Successfully updated ${printer.prettyDatabaseString(databaseResp)}`));
     }
     return databaseResp;
 });

package/lib/commands/firestore-indexes-list.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.command = void 0;
-const command_1 = require("../command");
 const clc = require("colorette");
+const command_1 = require("../command");
 const fsi = require("../firestore/api");
 const logger_1 = require("../logger");
 const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:indexes")
     .description("List indexes in your project's Cloud Firestore database.")
     .option("--pretty", "Pretty print. When not specified the indexes are printed in the " +
@@ -18,17 +19,18 @@ exports.command = new command_1.Command("firestore:indexes")
     .action(async (options) => {
     var _a;
     const indexApi = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     const databaseId = (_a = options.database) !== null && _a !== void 0 ? _a : "(default)";
     const indexes = await indexApi.listIndexes(options.project, databaseId);
     const fieldOverrides = await indexApi.listFieldOverrides(options.project, databaseId);
     const indexSpec = indexApi.makeIndexSpec(indexes, fieldOverrides);
     if (options.pretty) {
         logger_1.logger.info(clc.bold(clc.white("Compound Indexes")));
-        indexApi.prettyPrintIndexes(indexes);
+        printer.prettyPrintIndexes(indexes);
         if (fieldOverrides) {
             logger_1.logger.info();
             logger_1.logger.info(clc.bold(clc.white("Field Overrides")));
-            indexApi.printFieldOverrides(fieldOverrides);
+            printer.printFieldOverrides(fieldOverrides);
         }
     }
     else {

package/lib/commands/firestore-locations.js

@@ -7,18 +7,20 @@ const logger_1 = require("../logger");
 const requirePermissions_1 = require("../requirePermissions");
 const types_1 = require("../emulator/types");
 const commandUtils_1 = require("../emulator/commandUtils");
+const pretty_print_1 = require("../firestore/pretty-print");
 exports.command = new command_1.Command("firestore:locations")
     .description("List possible locations for your Cloud Firestore project.")
     .before(requirePermissions_1.requirePermissions, ["datastore.locations.list"])
     .before(commandUtils_1.warnEmulatorNotSupported, types_1.Emulators.FIRESTORE)
     .action(async (options) => {
     const api = new fsi.FirestoreApi();
+    const printer = new pretty_print_1.PrettyPrint();
     const locations = await api.locations(options.project);
     if (options.json) {
         logger_1.logger.info(JSON.stringify(locations, undefined, 2));
     }
     else {
-        api.prettyPrintLocations(locations);
+        printer.prettyPrintLocations(locations);
     }
     return locations;
 });

package/lib/commands/index.js

@@ -101,6 +101,16 @@ function load(client) {
     client.firestore.databases.create = loadCommand("firestore-databases-create");
     client.firestore.databases.update = loadCommand("firestore-databases-update");
     client.firestore.databases.delete = loadCommand("firestore-databases-delete");
+    client.firestore.databases.restore = loadCommand("firestore-databases-restore");
+    client.firestore.backups = {};
+    client.firestore.backups.schedules = {};
+    client.firestore.backups.list = loadCommand("firestore-backups-list");
+    client.firestore.backups.get = loadCommand("firestore-backups-get");
+    client.firestore.backups.delete = loadCommand("firestore-backups-delete");
+    client.firestore.backups.schedules.list = loadCommand("firestore-backups-schedules-list");
+    client.firestore.backups.schedules.create = loadCommand("firestore-backups-schedules-create");
+    client.firestore.backups.schedules.update = loadCommand("firestore-backups-schedules-update");
+    client.firestore.backups.schedules.delete = loadCommand("firestore-backups-schedules-delete");
     client.functions = {};
     client.functions.config = {};
     client.functions.config.clone = loadCommand("functions-config-clone");

package/lib/deploy/extensions/v2FunctionHelper.js

@@ -8,6 +8,7 @@ const error_1 = require("../../error");
 const ensureApiEnabled_1 = require("../../ensureApiEnabled");
 const planner = require("./planner");
 const projectUtils_1 = require("../../projectUtils");
+const api_1 = require("../../api");
 const SERVICE_AGENT_ROLE = "roles/eventarc.eventReceiver";
 async function checkSpecForV2Functions(i) {
     const extensionSpec = await planner.getExtensionSpec(i);
@@ -16,7 +17,7 @@ async function checkSpecForV2Functions(i) {
 exports.checkSpecForV2Functions = checkSpecForV2Functions;
 async function ensureNecessaryV2ApisAndRoles(options) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
-    await (0, ensureApiEnabled_1.ensure)(projectId, "compute.googleapis.com", "extensions", options.markdown);
+    await (0, ensureApiEnabled_1.ensure)(projectId, api_1.computeOrigin, "extensions", options.markdown);
     await ensureComputeP4SARole(projectId);
 }
 exports.ensureNecessaryV2ApisAndRoles = ensureNecessaryV2ApisAndRoles;

package/lib/deploy/functions/ensure.js

@@ -8,9 +8,9 @@ const utils_1 = require("../../utils");
 const secretManager_1 = require("../../gcp/secretManager");
 const projects_1 = require("../../management/projects");
 const functional_1 = require("../../functional");
+const api_1 = require("../../api");
 const backend = require("./backend");
 const FAQ_URL = "https://firebase.google.com/support/faq#functions-runtime";
-const CLOUD_BUILD_API = "cloudbuild.googleapis.com";
 const metadataCallCache = new Map();
 async function defaultServiceAccount(e) {
     let metadataCall = metadataCallCache.get(e.project);
@@ -54,7 +54,7 @@ function isPermissionError(e) {
 }
 async function cloudBuildEnabled(projectId) {
     try {
-        await (0, ensureApiEnabled_1.ensure)(projectId, CLOUD_BUILD_API, "functions");
+        await (0, ensureApiEnabled_1.ensure)(projectId, api_1.cloudbuildOrigin, "functions");
     }
     catch (e) {
         if ((0, error_1.isBillingError)(e)) {

package/lib/deploy/functions/prepare.js

@@ -10,6 +10,7 @@ const functionsEnv = require("../../functions/env");
 const runtimes = require("./runtimes");
 const validate = require("./validate");
 const ensure = require("./ensure");
+const api_1 = require("../../api");
 const functionsDeployHelper_1 = require("./functionsDeployHelper");
 const utils_1 = require("../../utils");
 const prepareFunctionsUpload_1 = require("./prepareFunctionsUpload");
@@ -40,10 +41,10 @@ async function prepare(context, options, payload) {
         (0, utils_1.logLabeledBullet)("functions", `preparing codebase ${clc.bold(codebase)} for deployment`);
     }
     const checkAPIsEnabled = await Promise.all([
-        ensureApiEnabled.ensure(projectId, "cloudfunctions.googleapis.com", "functions"),
-        ensureApiEnabled.check(projectId, "runtimeconfig.googleapis.com", "runtimeconfig", true),
+        ensureApiEnabled.ensure(projectId, api_1.functionsOrigin, "functions"),
+        ensureApiEnabled.check(projectId, api_1.runtimeconfigOrigin, "runtimeconfig", true),
         ensure.cloudBuildEnabled(projectId),
-        ensureApiEnabled.ensure(projectId, "artifactregistry.googleapis.com", "artifactregistry"),
+        ensureApiEnabled.ensure(projectId, api_1.artifactRegistryDomain, "artifactregistry"),
     ]);
     const firebaseConfig = await functionsConfig.getFirebaseConfig(options);
     context.firebaseConfig = firebaseConfig;
@@ -157,12 +158,7 @@ async function prepare(context, options, payload) {
         return ensureApiEnabled.ensure(projectId, api, "functions", false);
     }));
     if (backend.someEndpoint(wantBackend, (e) => e.platform === "gcfv2")) {
-        const V2_APIS = [
-            "run.googleapis.com",
-            "eventarc.googleapis.com",
-            "pubsub.googleapis.com",
-            "storage.googleapis.com",
-        ];
+        const V2_APIS = [api_1.cloudRunApiOrigin, api_1.eventarcOrigin, api_1.pubsubOrigin, api_1.storageOrigin];
         const enablements = V2_APIS.map((api) => {
             return ensureApiEnabled.ensure(context.projectId, api, "functions");
         });

package/lib/emulator/downloadableEmulators.js

@@ -23,9 +23,9 @@ const EMULATOR_UPDATE_DETAILS = {
         expectedChecksum: "2fd771101c0e1f7898c04c9204f2ce63",
     },
     firestore: {
-        version: "1.18.2",
-        expectedSize: 63929486,
-        expectedChecksum: "7b066cd684baf9bcd4a56a258be344a5",
+        version: "1.19.1",
+        expectedSize: 67187672,
+        expectedChecksum: "859b1ac2a6040cccddd993c43586347c",
     },
     storage: {
         version: "1.1.3",

package/lib/ensureApiEnabled.js

@@ -15,7 +15,8 @@ const apiClient = new apiv2_1.Client({
     urlPrefix: api_1.serviceUsageOrigin,
     apiVersion: "v1",
 });
-async function check(projectId, apiName, prefix, silent = false) {
+async function check(projectId, apiUri, prefix, silent = false) {
+    const apiName = apiUri.startsWith("http") ? new URL(apiUri).hostname : apiUri;
     const res = await apiClient.get(`/projects/${projectId}/services/${apiName}`, {
         headers: { "x-goog-quota-user": `projects/${projectId}` },
         skipLog: { resBody: true },
@@ -90,18 +91,19 @@ async function enableApiWithRetries(projectId, apiName, prefix, silent, enableme
     await enable(projectId, apiName);
     return pollCheckEnabled(projectId, apiName, prefix, silent, enablementRetries);
 }
-async function ensure(projectId, apiName, prefix, silent = false) {
+async function ensure(projectId, apiUri, prefix, silent = false) {
+    const hostname = apiUri.startsWith("http") ? new URL(apiUri).hostname : apiUri;
     if (!silent) {
-        utils.logLabeledBullet(prefix, `ensuring required API ${(0, colorette_1.bold)(apiName)} is enabled...`);
+        utils.logLabeledBullet(prefix, `ensuring required API ${(0, colorette_1.bold)(hostname)} is enabled...`);
     }
-    const isEnabled = await check(projectId, apiName, prefix, silent);
+    const isEnabled = await check(projectId, hostname, prefix, silent);
     if (isEnabled) {
         return;
     }
     if (!silent) {
-        utils.logLabeledWarning(prefix, `missing required API ${(0, colorette_1.bold)(apiName)}. Enabling now...`);
+        utils.logLabeledWarning(prefix, `missing required API ${(0, colorette_1.bold)(hostname)}. Enabling now...`);
     }
-    return enableApiWithRetries(projectId, apiName, prefix, silent);
+    return enableApiWithRetries(projectId, hostname, prefix, silent);
 }
 exports.ensure = ensure;
 function enableApiURI(projectId, apiName) {

package/lib/extensions/extensionsHelper.js

@@ -353,7 +353,7 @@ async function ensureExtensionsApiEnabled(options) {
     if (!projectId) {
         return;
     }
-    return await (0, ensureApiEnabled_1.ensure)(projectId, "firebaseextensions.googleapis.com", "extensions", options.markdown);
+    return await (0, ensureApiEnabled_1.ensure)(projectId, api_1.extensionsOrigin, "extensions", options.markdown);
 }
 exports.ensureExtensionsApiEnabled = ensureExtensionsApiEnabled;
 async function ensureExtensionsPublisherApiEnabled(options) {
@@ -361,7 +361,7 @@ async function ensureExtensionsPublisherApiEnabled(options) {
     if (!projectId) {
         return;
     }
-    return await (0, ensureApiEnabled_1.ensure)(projectId, "firebaseextensionspublisher.googleapis.com", "extensions", options.markdown);
+    return await (0, ensureApiEnabled_1.ensure)(projectId, api_1.extensionsPublisherOrigin, "extensions", options.markdown);
 }
 exports.ensureExtensionsPublisherApiEnabled = ensureExtensionsPublisherApiEnabled;
 async function archiveAndUploadSource(extPath, bucketName) {

package/lib/extensions/secretsUtils.js

@@ -8,11 +8,12 @@ const projectUtils_1 = require("../projectUtils");
 const types_1 = require("./types");
 const secretManagerApi = require("../gcp/secretManager");
 const logger_1 = require("../logger");
+const api_1 = require("../api");
 exports.SECRET_LABEL = "firebase-extensions-managed";
 exports.SECRET_ROLE = "secretmanager.secretAccessor";
 async function ensureSecretManagerApiEnabled(options) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
-    return await (0, ensureApiEnabled_1.ensure)(projectId, "secretmanager.googleapis.com", "extensions", options.markdown);
+    return await (0, ensureApiEnabled_1.ensure)(projectId, api_1.secretManagerOrigin, "extensions", options.markdown);
 }
 exports.ensureSecretManagerApiEnabled = ensureSecretManagerApiEnabled;
 function usesSecrets(spec) {

package/lib/firestore/api-sort.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareFieldOverride = exports.compareApiField = exports.compareLocation = exports.compareApiDatabase = exports.compareApiIndex = exports.compareSpecIndex = void 0;
+exports.compareFieldOverride = exports.compareApiField = exports.compareApiBackupSchedule = exports.compareApiBackup = exports.compareLocation = exports.compareApiDatabase = exports.compareApiIndex = exports.compareSpecIndex = void 0;
 const API = require("./api-types");
 const util = require("./util");
 const QUERY_SCOPE_SEQUENCE = [
@@ -42,6 +42,28 @@ function compareLocation(a, b) {
     return a.locationId > b.locationId ? 1 : -1;
 }
 exports.compareLocation = compareLocation;
+function compareApiBackup(a, b) {
+    const aLocation = a.name.split("/")[3];
+    const bLocation = b.name.split("/")[3];
+    if (aLocation && bLocation && aLocation !== bLocation) {
+        return aLocation > bLocation ? 1 : -1;
+    }
+    if (a.snapshotTime && b.snapshotTime && a.snapshotTime !== b.snapshotTime) {
+        return a.snapshotTime > b.snapshotTime ? -1 : 1;
+    }
+    return a.name > b.name ? 1 : -1;
+}
+exports.compareApiBackup = compareApiBackup;
+function compareApiBackupSchedule(a, b) {
+    if (a.dailyRecurrence && !b.dailyRecurrence) {
+        return -1;
+    }
+    else if (a.weeklyRecurrence && b.dailyRecurrence) {
+        return 1;
+    }
+    return a.name > b.name ? 1 : -1;
+}
+exports.compareApiBackupSchedule = compareApiBackupSchedule;
 function compareApiField(a, b) {
     const aName = util.parseFieldName(a.name);
     const bName = util.parseFieldName(b.name);

package/lib/firestore/api-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PointInTimeRecoveryEnablement = exports.PointInTimeRecoveryEnablementOption = exports.DatabaseDeleteProtectionState = exports.DatabaseDeleteProtectionStateOption = exports.DatabaseType = exports.StateTtl = exports.State = exports.ArrayConfig = exports.Order = exports.QueryScope = exports.Mode = void 0;
+exports.RecurrenceType = exports.PointInTimeRecoveryEnablement = exports.PointInTimeRecoveryEnablementOption = exports.DatabaseDeleteProtectionState = exports.DatabaseDeleteProtectionStateOption = exports.DatabaseType = exports.StateTtl = exports.State = exports.ArrayConfig = exports.Order = exports.QueryScope = exports.Mode = void 0;
 var Mode;
 (function (Mode) {
     Mode["ASCENDING"] = "ASCENDING";
@@ -58,3 +58,8 @@ var PointInTimeRecoveryEnablement;
     PointInTimeRecoveryEnablement["ENABLED"] = "POINT_IN_TIME_RECOVERY_ENABLED";
     PointInTimeRecoveryEnablement["DISABLED"] = "POINT_IN_TIME_RECOVERY_DISABLED";
 })(PointInTimeRecoveryEnablement = exports.PointInTimeRecoveryEnablement || (exports.PointInTimeRecoveryEnablement = {}));
+var RecurrenceType;
+(function (RecurrenceType) {
+    RecurrenceType["DAILY"] = "DAILY";
+    RecurrenceType["WEEKLY"] = "WEEKLY";
+})(RecurrenceType = exports.RecurrenceType || (exports.RecurrenceType = {}));

package/lib/firestore/api.js

@@ -12,9 +12,11 @@ const prompt_1 = require("../prompt");
 const api_1 = require("../api");
 const error_1 = require("../error");
 const apiv2_1 = require("../apiv2");
+const pretty_print_1 = require("./pretty-print");
 class FirestoreApi {
     constructor() {
         this.apiClient = new apiv2_1.Client({ urlPrefix: api_1.firestoreOrigin, apiVersion: "v1" });
+        this.printer = new pretty_print_1.PrettyPrint();
     }
     async deploy(options, indexes, fieldOverrides, databaseId = "(default)") {
         const spec = this.upgradeOldSpec({
@@ -49,7 +51,7 @@ class FirestoreApi {
             }
             else if (!options.force) {
                 const indexesString = indexesToDelete
-                    .map((x) => this.prettyIndexString(x, false))
+                    .map((x) => this.printer.prettyIndexString(x, false))
                     .join("\n\t");
                 utils.logLabeledBullet("firestore", `The following indexes are defined in your project but are not present in your firestore indexes file:\n\t${indexesString}`);
             }
@@ -86,7 +88,7 @@ class FirestoreApi {
             }
             else if (!options.force) {
                 const indexesString = fieldOverridesToDelete
-                    .map((x) => this.prettyFieldString(x))
+                    .map((x) => this.printer.prettyFieldString(x))
                     .join("\n\t");
                 utils.logLabeledBullet("firestore", `The following field overrides are defined in your project but are not present in your firestore indexes file:\n\t${indexesString}`);
             }
@@ -145,7 +147,7 @@ class FirestoreApi {
             return [];
         }
         return fields.filter((field) => {
-            return field.name.indexOf("__default__") < 0;
+            return !field.name.includes("__default__");
         });
     }
     makeIndexSpec(indexes, fields) {
@@ -184,64 +186,6 @@ class FirestoreApi {
             fieldOverrides: sortedFields,
         };
     }
-    prettyPrintIndexes(indexes) {
-        if (indexes.length === 0) {
-            logger_1.logger.info("None");
-            return;
-        }
-        const sortedIndexes = indexes.sort(sort.compareApiIndex);
-        sortedIndexes.forEach((index) => {
-            logger_1.logger.info(this.prettyIndexString(index));
-        });
-    }
-    prettyPrintDatabases(databases) {
-        if (databases.length === 0) {
-            logger_1.logger.info("No databases found.");
-            return;
-        }
-        const sortedDatabases = databases.sort(sort.compareApiDatabase);
-        const Table = require("cli-table");
-        const table = new Table({
-            head: ["Database Name"],
-            colWidths: [Math.max(...sortedDatabases.map((database) => database.name.length + 5), 20)],
-        });
-        table.push(...sortedDatabases.map((database) => [this.prettyDatabaseString(database)]));
-        logger_1.logger.info(table.toString());
-    }
-    prettyPrintDatabase(database) {
-        const Table = require("cli-table");
-        const table = new Table({
-            head: ["Field", "Value"],
-            colWidths: [25, Math.max(50, 5 + database.name.length)],
-        });
-        table.push(["Name", clc.yellow(database.name)], ["Create Time", clc.yellow(database.createTime)], ["Last Update Time", clc.yellow(database.updateTime)], ["Type", clc.yellow(database.type)], ["Location", clc.yellow(database.locationId)], ["Delete Protection State", clc.yellow(database.deleteProtectionState)], ["Point In Time Recovery", clc.yellow(database.pointInTimeRecoveryEnablement)], ["Earliest Version Time", clc.yellow(database.earliestVersionTime)], ["Version Retention Period", clc.yellow(database.versionRetentionPeriod)]);
-        logger_1.logger.info(table.toString());
-    }
-    prettyPrintLocations(locations) {
-        if (locations.length === 0) {
-            logger_1.logger.info("No Locations Available");
-            return;
-        }
-        const Table = require("cli-table");
-        const table = new Table({
-            head: ["Display Name", "LocationId"],
-            colWidths: [20, 30],
-        });
-        table.push(...locations
-            .sort(sort.compareLocation)
-            .map((location) => [location.displayName, location.locationId]));
-        logger_1.logger.info(table.toString());
-    }
-    printFieldOverrides(fields) {
-        if (fields.length === 0) {
-            logger_1.logger.info("None");
-            return;
-        }
-        const sortedFields = fields.sort(sort.compareApiField);
-        sortedFields.forEach((field) => {
-            logger_1.logger.info(this.prettyFieldString(field));
-        });
-    }
     validateSpec(spec) {
         validator.assertHas(spec, "indexes");
         spec.indexes.forEach((index) => {
@@ -391,7 +335,7 @@ class FirestoreApi {
             return index.order || index.arrayConfig;
         });
         for (const mode of fieldModes) {
-            if (specModes.indexOf(mode) < 0) {
+            if (!specModes.includes(mode)) {
                 return false;
             }
         }
@@ -507,60 +451,19 @@ class FirestoreApi {
         }
         return database;
     }
-    prettyIndexString(index, includeState = true) {
-        let result = "";
-        if (index.state && includeState) {
-            const stateMsg = `[${index.state}] `;
-            if (index.state === types.State.READY) {
-                result += clc.green(stateMsg);
-            }
-            else if (index.state === types.State.CREATING) {
-                result += clc.yellow(stateMsg);
-            }
-            else {
-                result += clc.red(stateMsg);
-            }
-        }
-        const nameInfo = util.parseIndexName(index.name);
-        result += clc.cyan(`(${nameInfo.collectionGroupId})`);
-        result += " -- ";
-        index.fields.forEach((field) => {
-            if (field.fieldPath === "__name__") {
-                return;
-            }
-            const orderOrArrayConfig = field.order ? field.order : field.arrayConfig;
-            result += `(${field.fieldPath},${orderOrArrayConfig}) `;
-        });
-        return result;
-    }
-    prettyDatabaseString(database) {
-        return clc.yellow(database.name);
-    }
-    prettyFieldString(field) {
-        let result = "";
-        const parsedName = util.parseFieldName(field.name);
-        result +=
-            "[" +
-                clc.cyan(parsedName.collectionGroupId) +
-                "." +
-                clc.yellow(parsedName.fieldPath) +
-                "] --";
-        const fieldIndexes = field.indexConfig.indexes || [];
-        if (fieldIndexes.length > 0) {
-            fieldIndexes.forEach((index) => {
-                const firstField = index.fields[0];
-                const mode = firstField.order || firstField.arrayConfig;
-                result += ` (${mode})`;
-            });
-        }
-        else {
-            result += " (no indexes)";
-        }
-        const fieldTtl = field.ttlConfig;
-        if (fieldTtl) {
-            result += ` TTL(${fieldTtl.state})`;
+    async restoreDatabase(project, databaseId, backupName) {
+        const url = `/projects/${project}/databases:restore`;
+        const payload = {
+            databaseId,
+            backup: backupName,
+        };
+        const options = { queryParams: { databaseId: databaseId } };
+        const res = await this.apiClient.post(url, payload, options);
+        const database = res.body.response;
+        if (!database) {
+            throw new error_1.FirebaseError("Not found");
         }
-        return result;
+        return database;
     }
 }
 exports.FirestoreApi = FirestoreApi;