firebase-tools 14.27.0 → 15.0.0

package/lib/archiveDirectory.js

@@ -5,17 +5,12 @@ const archiver = require("archiver");
 const filesize = require("filesize");
 const fs = require("fs");
 const path = require("path");
-const tar = require("tar");
 const tmp = require("tmp");
 const error_1 = require("./error");
-const listFiles_1 = require("./listFiles");
 const logger_1 = require("./logger");
 const fsAsync = require("./fsAsync");
 async function archiveDirectory(sourceDirectory, options = {}) {
-    let postfix = ".tar.gz";
-    if (options.type === "zip") {
-        postfix = ".zip";
-    }
+    const postfix = ".zip";
     const tempFile = tmp.fileSync({
         prefix: "firebase-archive-",
         postfix,
@@ -23,13 +18,7 @@ async function archiveDirectory(sourceDirectory, options = {}) {
     if (!options.ignore) {
         options.ignore = [];
     }
-    let makeArchive;
-    if (options.type === "zip") {
-        makeArchive = zipDirectory(sourceDirectory, tempFile, options);
-    }
-    else {
-        makeArchive = tarDirectory(sourceDirectory, tempFile, options);
-    }
+    const makeArchive = zipDirectory(sourceDirectory, tempFile, options);
     try {
         const archive = await makeArchive;
         logger_1.logger.debug(`Archived ${filesize(archive.size)} in ${sourceDirectory}.`);
@@ -43,37 +32,6 @@ async function archiveDirectory(sourceDirectory, options = {}) {
     }
 }
 exports.archiveDirectory = archiveDirectory;
-async function tarDirectory(sourceDirectory, tempFile, options) {
-    const allFiles = (0, listFiles_1.listFiles)(sourceDirectory, options.ignore);
-    try {
-        fs.statSync(sourceDirectory);
-    }
-    catch (err) {
-        if (err.code === "ENOENT") {
-            throw new error_1.FirebaseError(`Could not read directory "${sourceDirectory}"`);
-        }
-        throw err;
-    }
-    if (!allFiles.length) {
-        throw new error_1.FirebaseError(`Cannot create a tar archive with 0 files from directory "${sourceDirectory}"`);
-    }
-    await tar.create({
-        gzip: true,
-        file: tempFile.name,
-        cwd: sourceDirectory,
-        follow: true,
-        noDirRecurse: true,
-        portable: true,
-    }, allFiles);
-    const stats = fs.statSync(tempFile.name);
-    return {
-        file: tempFile.name,
-        stream: fs.createReadStream(tempFile.name),
-        manifest: allFiles,
-        size: stats.size,
-        source: sourceDirectory,
-    };
-}
 async function zipDirectory(sourceDirectory, tempFile, options) {
     const archiveFileStream = fs.createWriteStream(tempFile.name, {
         flags: "w",
@@ -84,7 +42,11 @@ async function zipDirectory(sourceDirectory, tempFile, options) {
     const allFiles = [];
     let files;
     try {
-        files = await fsAsync.readdirRecursive({ path: sourceDirectory, ignore: options.ignore });
+        files = await fsAsync.readdirRecursive({
+            path: sourceDirectory,
+            ignore: options.ignore,
+            ignoreSymlinks: true,
+        });
     }
     catch (err) {
         if (err.code === "ENOENT") {

package/lib/bin/cli.js

@@ -9,13 +9,13 @@ marked_1.marked.use((0, marked_terminal_1.markedTerminal)());
 const fs = require("node:fs");
 const configstore_1 = require("../configstore");
 const errorOut_1 = require("../errorOut");
-const handlePreviewToggles_1 = require("../handlePreviewToggles");
 const logger_1 = require("../logger");
 const client = require("..");
 const fsutils = require("../fsutils");
 const utils = require("../utils");
 const experiments_1 = require("../experiments");
 const fetchMOTD_1 = require("../fetchMOTD");
+const command_1 = require("../command");
 function cli(pkg) {
     const updateNotifier = updateNotifierPkg({ pkg });
     const args = process.argv.slice(2);
@@ -87,13 +87,40 @@ function cli(pkg) {
     process.on("uncaughtException", (err) => {
         (0, errorOut_1.errorOut)(err);
     });
-    if (!(0, handlePreviewToggles_1.handlePreviewToggles)(args)) {
-        if (!args.length) {
-            client.cli.help();
-        }
-        else {
-            cmd = client.cli.parse(process.argv);
-        }
+    const commandName = args[0];
+    const isHelp = !args.length ||
+        commandName === "help" ||
+        (args.length === 1 && commandName === "ext") ||
+        commandName === "--help";
+    const hasHelpFlag = args.includes("--help") || args.includes("-h");
+    if (hasHelpFlag) {
+        client.getCommand(commandName);
+    }
+    if (isHelp) {
+        const seen = new Set();
+        const loadAll = (obj) => {
+            if (seen.has(obj))
+                return;
+            seen.add(obj);
+            for (const [key, value] of Object.entries(obj)) {
+                if ((0, command_1.isCommandModule)(value)) {
+                    value.load();
+                }
+                else if (typeof value === "object" &&
+                    value !== null &&
+                    !Array.isArray(value) &&
+                    key !== "cli") {
+                    loadAll(value);
+                }
+            }
+        };
+        loadAll(client);
+    }
+    if (!args.length) {
+        client.cli.help();
+    }
+    else {
+        cmd = client.cli.parse(process.argv);
     }
 }
 exports.cli = cli;

package/lib/command.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateProjectId = exports.Command = void 0;
+exports.validateProjectId = exports.Command = exports.isCommandModule = void 0;
 const clc = require("colorette");
 const path = require("node:path");
 const lodash_1 = require("lodash");
@@ -17,6 +17,10 @@ const studio_1 = require("./management/studio");
 const requireAuth_1 = require("./requireAuth");
 const logger_1 = require("./logger");
 const env_1 = require("./env");
+function isCommandModule(value) {
+    return typeof value === "function" && typeof value.load === "function";
+}
+exports.isCommandModule = isCommandModule;
 class Command {
     constructor(cmd) {
         this.cmd = cmd;

package/lib/commands/dataconnect-execute.js

@@ -165,7 +165,7 @@ exports.command = new command_1.Command("dataconnect:execute [file] [operationNa
         return query;
     }
     async function getServiceInfo() {
-        return (0, load_1.pickService)(projectId, options.config, serviceId || undefined).catch((e) => {
+        return (0, load_1.pickOneService)(projectId, options.config, serviceId || undefined, locationId || undefined).catch((e) => {
             if (!(e instanceof error_1.FirebaseError)) {
                 return Promise.reject(e);
             }

package/lib/commands/dataconnect-sdk-generate.js

@@ -15,7 +15,9 @@ const error_1 = require("../error");
 const init_1 = require("./init");
 const hub_1 = require("../emulator/hub");
 exports.command = new command_1.Command("dataconnect:sdk:generate")
-    .description("generate typed SDKs for your Data Connect connectors")
+    .description("generate typed SDKs to use Data Connect in your apps")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service. If not provided, generates SDKs for all services.")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .option("--watch", "watch for changes to your connector GQL files and regenerate your SDKs when updates occur")
     .action(async (options) => {
     const projectId = (0, projectUtils_1.getProjectId)(options);
@@ -46,7 +48,7 @@ exports.command = new command_1.Command("dataconnect:sdk:generate")
         justRanInit = true;
         options.config = config;
     }
-    let serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config);
+    let serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config, options);
     if (!serviceInfosWithSDKs.length) {
         if (justRanInit || options.nonInteractive) {
             throw new error_1.FirebaseError(`No generated SDKs are configured during init. Please run ${clc.bold("firebase init dataconnect:sdk")} to configure a generated SDK.`);
@@ -65,12 +67,12 @@ exports.command = new command_1.Command("dataconnect:sdk:generate")
         await dataconnectSdkInit.askQuestions(setup);
         await dataconnectSdkInit.actuate(setup, config);
         justRanInit = true;
-        serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config);
+        serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config, options);
     }
     await generateSDKsInAll(options, serviceInfosWithSDKs, justRanInit);
 });
-async function loadAllWithSDKs(projectId, config) {
-    const serviceInfos = await (0, load_1.loadAll)(projectId || hub_1.EmulatorHub.MISSING_PROJECT_PLACEHOLDER, config);
+async function loadAllWithSDKs(projectId, config, options) {
+    const serviceInfos = await (0, load_1.pickServices)(projectId || hub_1.EmulatorHub.MISSING_PROJECT_PLACEHOLDER, config, options.service, options.location);
     return serviceInfos.filter((serviceInfo) => serviceInfo.connectorInfo.some((c) => {
         var _a, _b, _c, _d, _e;
         return (((_a = c.connectorYaml.generate) === null || _a === void 0 ? void 0 : _a.javascriptSdk) ||

package/lib/commands/dataconnect-sql-diff.js

@@ -9,19 +9,21 @@ const load_1 = require("../dataconnect/load");
 const schemaMigration_1 = require("../dataconnect/schemaMigration");
 const requireAuth_1 = require("../requireAuth");
 const types_1 = require("../dataconnect/types");
-exports.command = new command_1.Command("dataconnect:sql:diff [serviceId]")
-    .description("display the differences between a local Data Connect schema and your CloudSQL database's current schema")
+exports.command = new command_1.Command("dataconnect:sql:diff")
+    .description("display the differences between the local Data Connect schema and your CloudSQL database's schema")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .before(requirePermissions_1.requirePermissions, [
     "firebasedataconnect.services.list",
     "firebasedataconnect.schemas.list",
     "firebasedataconnect.schemas.update",
 ])
     .before(requireAuth_1.requireAuth)
-    .action(async (serviceId, options) => {
+    .action(async (options) => {
     var _a;
     const projectId = (0, projectUtils_1.needProjectId)(options);
     await (0, ensureApis_1.ensureApis)(projectId);
-    const serviceInfo = await (0, load_1.pickService)(projectId, options.config, serviceId);
+    const serviceInfo = await (0, load_1.pickOneService)(projectId, options.config, options.service, options.location);
     const diffs = await (0, schemaMigration_1.diffSchema)(options, (0, types_1.mainSchema)(serviceInfo.schemas), (_a = (0, types_1.mainSchemaYaml)(serviceInfo.dataConnectYaml).datasource.postgresql) === null || _a === void 0 ? void 0 : _a.schemaValidation);
-    return { projectId, serviceId, diffs };
+    return { projectId, diffs };
 });

package/lib/commands/dataconnect-sql-grant.js

@@ -13,31 +13,31 @@ const permissionsSetup_1 = require("../gcp/cloudsql/permissionsSetup");
 const cloudsqladmin_1 = require("../gcp/cloudsql/cloudsqladmin");
 const types_1 = require("../dataconnect/types");
 const allowedRoles = Object.keys(permissionsSetup_1.fdcSqlRoleMap);
-exports.command = new command_1.Command("dataconnect:sql:grant [serviceId]")
+exports.command = new command_1.Command("dataconnect:sql:grant")
     .description("grants the SQL role <role> to the provided user or service account <email>")
     .option("-R, --role <role>", "The SQL role to grant. One of: owner, writer, or reader.")
     .option("-E, --email <email>", "The email of the user or service account we would like to grant the role to.")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .before(requirePermissions_1.requirePermissions, ["firebasedataconnect.services.list"])
     .before(requireAuth_1.requireAuth)
-    .action(async (serviceId, options) => {
-    const role = options.role;
-    const email = options.email;
-    if (!role) {
+    .action(async (options) => {
+    if (!options.role) {
         throw new error_1.FirebaseError("-R, --role <role> is required. Run the command with -h for more info.");
     }
-    if (!email) {
+    if (!options.email) {
         throw new error_1.FirebaseError("-E, --email <email> is required. Run the command with -h for more info.");
     }
-    if (!allowedRoles.includes(role.toLowerCase())) {
+    if (!allowedRoles.includes(options.role.toLowerCase())) {
         throw new error_1.FirebaseError(`Role should be one of ${allowedRoles.join(" | ")}.`);
     }
+    const projectId = (0, projectUtils_1.needProjectId)(options);
+    await (0, ensureApis_1.ensureApis)(projectId);
+    const serviceInfo = await (0, load_1.pickOneService)(projectId, options.config, options.service, options.location);
     const userIsCSQLAdmin = await (0, cloudsqladmin_1.iamUserIsCSQLAdmin)(options);
     if (!userIsCSQLAdmin) {
-        throw new error_1.FirebaseError(`Only users with 'roles/cloudsql.admin' can grant SQL roles. If you do not have this role, ask your database administrator to run this command or manually grant ${role} to ${email}`);
+        throw new error_1.FirebaseError(`Only users with 'roles/cloudsql.admin' can grant SQL roles. If you do not have this role, ask your database administrator to run this command or manually grant ${options.role} to ${options.email}`);
     }
-    const projectId = (0, projectUtils_1.needProjectId)(options);
-    await (0, ensureApis_1.ensureApis)(projectId);
-    const serviceInfo = await (0, load_1.pickService)(projectId, options.config, serviceId);
     await (0, schemaMigration_1.grantRoleToUserInSchema)(options, (0, types_1.mainSchema)(serviceInfo.schemas));
-    return { projectId, serviceId };
+    return { projectId };
 });

package/lib/commands/dataconnect-sql-migrate.js

@@ -11,8 +11,10 @@ const requirePermissions_1 = require("../requirePermissions");
 const ensureApis_1 = require("../dataconnect/ensureApis");
 const utils_1 = require("../utils");
 const types_1 = require("../dataconnect/types");
-exports.command = new command_1.Command("dataconnect:sql:migrate [serviceId]")
+exports.command = new command_1.Command("dataconnect:sql:migrate")
     .description("migrate your CloudSQL database's schema to match your local Data Connect schema")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .before(requirePermissions_1.requirePermissions, [
     "firebasedataconnect.services.list",
     "firebasedataconnect.schemas.list",
@@ -21,11 +23,11 @@ exports.command = new command_1.Command("dataconnect:sql:migrate [serviceId]")
 ])
     .before(requireAuth_1.requireAuth)
     .withForce("execute any required database changes without prompting")
-    .action(async (serviceId, options) => {
+    .action(async (options) => {
     var _a, _b;
     const projectId = (0, projectUtils_1.needProjectId)(options);
     await (0, ensureApis_1.ensureApis)(projectId);
-    const serviceInfo = await (0, load_1.pickService)(projectId, options.config, serviceId);
+    const serviceInfo = await (0, load_1.pickOneService)(projectId, options.config, options.service, options.location);
     const instanceId = (_a = (0, types_1.mainSchemaYaml)(serviceInfo.dataConnectYaml).datasource.postgresql) === null || _a === void 0 ? void 0 : _a.cloudSql.instanceId;
     if (!instanceId) {
         throw new error_1.FirebaseError("dataconnect.yaml is missing field schema.datasource.postgresql.cloudsql.instanceId");
@@ -42,5 +44,5 @@ exports.command = new command_1.Command("dataconnect:sql:migrate [serviceId]")
     else {
         (0, utils_1.logLabeledSuccess)("dataconnect", "Database schema is already up to date!");
     }
-    return { projectId, serviceId, diffs };
+    return { projectId, diffs };
 });

package/lib/commands/dataconnect-sql-setup.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.command = void 0;
 const command_1 = require("../command");
 const projectUtils_1 = require("../projectUtils");
-const load_1 = require("../dataconnect/load");
 const error_1 = require("../error");
 const requireAuth_1 = require("../requireAuth");
 const requirePermissions_1 = require("../requirePermissions");
@@ -12,9 +11,12 @@ const permissionsSetup_1 = require("../gcp/cloudsql/permissionsSetup");
 const permissions_1 = require("../gcp/cloudsql/permissions");
 const schemaMigration_1 = require("../dataconnect/schemaMigration");
 const connect_1 = require("../gcp/cloudsql/connect");
+const load_1 = require("../dataconnect/load");
 const types_1 = require("../dataconnect/types");
-exports.command = new command_1.Command("dataconnect:sql:setup [serviceId]")
+exports.command = new command_1.Command("dataconnect:sql:setup")
     .description("set up your CloudSQL database")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .before(requirePermissions_1.requirePermissions, [
     "firebasedataconnect.services.list",
     "firebasedataconnect.schemas.list",
@@ -22,11 +24,11 @@ exports.command = new command_1.Command("dataconnect:sql:setup [serviceId]")
     "cloudsql.instances.connect",
 ])
     .before(requireAuth_1.requireAuth)
-    .action(async (serviceId, options) => {
+    .action(async (options) => {
     var _a;
     const projectId = (0, projectUtils_1.needProjectId)(options);
     await (0, ensureApis_1.ensureApis)(projectId);
-    const serviceInfo = await (0, load_1.pickService)(projectId, options.config, serviceId);
+    const serviceInfo = await (0, load_1.pickOneService)(projectId, options.config, options.service, options.location);
     const instanceId = (_a = (0, types_1.mainSchemaYaml)(serviceInfo.dataConnectYaml).datasource.postgresql) === null || _a === void 0 ? void 0 : _a.cloudSql.instanceId;
     if (!instanceId) {
         throw new error_1.FirebaseError("dataconnect.yaml is missing field schema.datasource.postgresql.cloudsql.instanceId");

package/lib/commands/dataconnect-sql-shell.js

@@ -73,14 +73,16 @@ async function mainShellLoop(conn) {
         }
     }
 }
-exports.command = new command_1.Command("dataconnect:sql:shell [serviceId]")
+exports.command = new command_1.Command("dataconnect:sql:shell")
     .description("start a shell connected directly to your Data Connect service's linked CloudSQL instance")
+    .option("--service <serviceId>", "the serviceId of the Data Connect service")
+    .option("--location <location>", "the location of the Data Connect service. Only needed if service ID is used in multiple locations.")
     .before(requirePermissions_1.requirePermissions, ["firebasedataconnect.services.list", "cloudsql.instances.connect"])
     .before(requireAuth_1.requireAuth)
-    .action(async (serviceId, options) => {
+    .action(async (options) => {
     const projectId = (0, projectUtils_1.needProjectId)(options);
     await (0, ensureApis_1.ensureApis)(projectId);
-    const serviceInfo = await (0, load_1.pickService)(projectId, options.config, serviceId);
+    const serviceInfo = await (0, load_1.pickOneService)(projectId, options.config, options.service, options.location);
     const { instanceId, databaseId } = (0, schemaMigration_1.getIdentifiers)((0, types_1.mainSchema)(serviceInfo.schemas));
     const { user: username } = await (0, connect_1.getIAMUser)(options);
     const instance = await cloudSqlAdminClient.getInstance(projectId, instanceId);
@@ -106,5 +108,5 @@ exports.command = new command_1.Command("dataconnect:sql:shell [serviceId]")
     conn.release();
     await pool.end();
     connector.close();
-    return { projectId, serviceId };
+    return { projectId };
 });

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

@@ -24,5 +24,5 @@ exports.command = new command_1.Command("firestore:backups:list")
         (0, utils_1.logWarning)("We were not able to reach the following locations: " +
             listBackupsResponse.unreachable.join(", "));
     }
-    return backups;
+    return listBackupsResponse;
 });

package/lib/commands/functions-config-clone.js

@@ -10,12 +10,12 @@ const requirePermissions_1 = require("../requirePermissions");
 const functionsConfig = require("../functionsConfig");
 const functionsConfigClone_1 = require("../functionsConfigClone");
 const utils = require("../utils");
-const deprecationWarnings_1 = require("../functions/deprecationWarnings");
 exports.command = new command_1.Command("functions:config:clone")
     .description("clone environment config from another project")
     .option("--from <projectId>", "the project from which to clone configuration")
     .option("--only <keys>", "a comma-separated list of keys to clone")
     .option("--except <keys>", "a comma-separated list of keys to not clone")
+    .before(functionsConfig.ensureLegacyRuntimeConfigCommandsEnabled)
     .before(requirePermissions_1.requirePermissions, [
     "runtimeconfig.configs.list",
     "runtimeconfig.configs.create",
@@ -51,5 +51,5 @@ exports.command = new command_1.Command("functions:config:clone")
     await (0, functionsConfigClone_1.functionsConfigClone)(options.from, projectId, only, except);
     utils.logSuccess(`Cloned functions config from ${clc.bold(options.from)} into ${clc.bold(projectId)}`);
     logger_1.logger.info(`\nPlease deploy your functions for the change to take effect by running ${clc.bold("firebase deploy --only functions")}\n`);
-    (0, deprecationWarnings_1.logFunctionsConfigDeprecationWarning)();
+    functionsConfig.logFunctionsConfigDeprecationWarning();
 });