firebase-tools 10.2.1 → 10.3.1

package/lib/appdistribution/options-parser-util.js

@@ -16,7 +16,7 @@ function getTestersOrGroups(value, file) {
 }
 exports.getTestersOrGroups = getTestersOrGroups;
 function getEmails(emails, file) {
-    if (emails.length == 0) {
+    if (emails.length === 0) {
         ensureFileExists(file);
         const readFile = fs.readFileSync(file, "utf8");
         return splitter(readFile);

package/lib/auth.js

@@ -291,7 +291,7 @@ async function loginRemotely(userHint) {
     });
     try {
         const tokens = await getTokensFromAuthorizationCode(code, `${api.authProxyOrigin}/complete`, codeVerifier);
-        (0, track_1.track)("login", "google_remote");
+        void (0, track_1.track)("login", "google_remote");
         return {
             user: jwt.decode(tokens.id_token),
             tokens: tokens,
@@ -307,7 +307,7 @@ async function loginWithLocalhostGoogle(port, userHint) {
     const authUrl = getLoginUrl(callbackUrl, userHint);
     const successTemplate = "../templates/loginSuccess.html";
     const tokens = await loginWithLocalhost(port, callbackUrl, authUrl, successTemplate, getTokensFromAuthorizationCode);
-    (0, track_1.track)("login", "google_localhost");
+    void (0, track_1.track)("login", "google_localhost");
     return {
         user: jwt.decode(tokens.id_token),
         tokens: tokens,
@@ -319,7 +319,7 @@ async function loginWithLocalhostGitHub(port) {
     const authUrl = getGithubLoginUrl(callbackUrl);
     const successTemplate = "../templates/loginSuccessGithub.html";
     const tokens = await loginWithLocalhost(port, callbackUrl, authUrl, successTemplate, getGithubTokensFromAuthorizationCode);
-    (0, track_1.track)("login", "google_localhost");
+    void (0, track_1.track)("login", "google_localhost");
     return tokens;
 }
 async function loginWithLocalhost(port, callbackUrl, authUrl, successTemplate, getTokens) {

package/lib/command.js

@@ -85,7 +85,7 @@ class Command {
                     }, null, 2));
                 }
                 const duration = new Date().getTime() - start;
-                track(this.name, "success", duration).then(() => process.exit());
+                void track(this.name, "success", duration).then(() => process.exit());
             })
                 .catch(async (err) => {
                 if ((0, utils_1.getInheritedOption)(options, "json")) {

package/lib/commands/apps-android-sha-create.js

@@ -9,9 +9,9 @@ const utils_1 = require("../utils");
 function getCertHashType(shaHash) {
     shaHash = shaHash.replace(/:/g, "");
     const shaHashCount = shaHash.length;
-    if (shaHashCount == 40)
+    if (shaHashCount === 40)
         return apps_1.ShaCertificateType.SHA_1.toString();
-    if (shaHashCount == 64)
+    if (shaHashCount === 64)
         return apps_1.ShaCertificateType.SHA_256.toString();
     return apps_1.ShaCertificateType.SHA_CERTIFICATE_TYPE_UNSPECIFIED.toString();
 }

package/lib/commands/apps-sdkconfig.js

@@ -70,7 +70,7 @@ module.exports = new command_1.Command("apps:sdkconfig [platform] [appId]")
     }
     spinner.succeed();
     const fileInfo = (0, apps_1.getAppConfigFile)(configData, appPlatform);
-    if (appPlatform == apps_1.AppPlatform.WEB) {
+    if (appPlatform === apps_1.AppPlatform.WEB) {
         fileInfo.sdkConfig = configData;
     }
     if (options.out === undefined) {

package/lib/commands/database-rules-list.js

@@ -18,10 +18,10 @@ exports.default = new command_1.Command("database:rules:list")
     const rulesets = await metadata.listAllRulesets(options.instance);
     for (const ruleset of rulesets) {
         const labels = [];
-        if (ruleset.id == labeled.stable) {
+        if (ruleset.id === labeled.stable) {
             labels.push("stable");
         }
-        if (ruleset.id == labeled.canary) {
+        if (ruleset.id === labeled.canary) {
             labels.push("canary");
         }
         logger_1.logger.info(`${ruleset.id}  ${ruleset.createdAt}  ${labels.join(",")}`);

package/lib/commands/emulators-start.js

@@ -59,9 +59,9 @@ module.exports = new command_1.Command("emulators:start")
     emulatorsTable.push(...controller
         .filterEmulatorTargets(options)
         .map((emulator) => {
-        const info = registry_1.EmulatorRegistry.getInfo(emulator);
         const emulatorName = constants_1.Constants.description(emulator).replace(/ emulator/i, "");
         const isSupportedByUi = types_1.EMULATORS_SUPPORTED_BY_UI.includes(emulator);
+        const info = registry_1.EmulatorRegistry.getInfo(emulator === types_1.Emulators.EXTENSIONS ? types_1.Emulators.FUNCTIONS : emulator);
         if (!info) {
             return [emulatorName, "Failed to initialize (see above)", "", ""];
         }

package/lib/commands/ext-configure.js

@@ -15,6 +15,10 @@ const paramHelper = require("../extensions/paramHelper");
 const requirePermissions_1 = require("../requirePermissions");
 const utils = require("../utils");
 const logger_1 = require("../logger");
+const refs = require("../extensions/refs");
+const manifest = require("../extensions/manifest");
+const functional_1 = require("../functional");
+const paramHelper_1 = require("../extensions/paramHelper");
 marked.setOptions({
     renderer: new TerminalRenderer(),
 });
@@ -22,6 +26,7 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     .description("configure an existing extension instance")
     .withForce()
     .option("--params <paramsFile>", "path of params file with .env format.")
+    .option("--local", "save to firebase.json rather than directly install to a Firebase project")
     .before(requirePermissions_1.requirePermissions, [
     "firebaseextensions.instances.update",
     "firebaseextensions.instances.get",
@@ -29,9 +34,46 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extMinVersion")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (instanceId, options) => {
+    var _a;
+    const projectId = (0, projectUtils_1.needProjectId)(options);
+    if (options.local) {
+        if (options.nonInteractive) {
+            throw new error_1.FirebaseError(`Command not supported in non-interactive mode, edit ./extensions/${instanceId}.env directly instead`);
+        }
+        const config = manifest.loadConfig(options);
+        const targetRef = manifest.getInstanceRef(instanceId, config);
+        const extensionVersion = await extensionsApi.getExtensionVersion(refs.toExtensionVersionRef(targetRef));
+        const oldParamValues = manifest.readInstanceParam({
+            instanceId,
+            projectDir: config.projectDir,
+        });
+        const [immutableParams, tbdParams] = (0, functional_1.partition)(extensionVersion.spec.params, (param) => { var _a; return (_a = param.immutable) !== null && _a !== void 0 ? _a : false; });
+        infoImmutableParams(immutableParams, oldParamValues);
+        paramHelper.setNewDefaults(tbdParams, oldParamValues);
+        const mutableParamsBindingOptions = await paramHelper.getParams({
+            projectId,
+            paramSpecs: tbdParams,
+            nonInteractive: false,
+            paramsEnvPath: ((_a = options.params) !== null && _a !== void 0 ? _a : ""),
+            instanceId,
+            reconfiguring: true,
+        });
+        const newParamValues = Object.assign(Object.assign({}, oldParamValues), (0, paramHelper_1.getBaseParamBindings)(mutableParamsBindingOptions));
+        await manifest.writeToManifest([
+            {
+                instanceId,
+                ref: targetRef,
+                params: newParamValues,
+            },
+        ], config, {
+            nonInteractive: false,
+            force: true,
+        });
+        manifest.showPreviewWarning();
+        return;
+    }
     const spinner = ora(`Configuring ${clc.bold(instanceId)}. This usually takes 3 to 5 minutes...`);
     try {
-        const projectId = (0, projectUtils_1.needProjectId)(options);
         let existingInstance;
         try {
             existingInstance = await extensionsApi.getInstance(projectId, instanceId);
@@ -45,10 +87,8 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
             throw err;
         }
         const paramSpecWithNewDefaults = paramHelper.getParamsWithCurrentValuesAsDefaults(existingInstance);
-        const immutableParams = _.remove(paramSpecWithNewDefaults, (param) => {
-            return param.immutable || param.param === "LOCATION";
-        });
-        const params = await paramHelper.getParams({
+        const immutableParams = _.remove(paramSpecWithNewDefaults, (param) => param.immutable);
+        const paramBindingOptions = await paramHelper.getParams({
             projectId,
             paramSpecs: paramSpecWithNewDefaults,
             nonInteractive: options.nonInteractive,
@@ -56,13 +96,14 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
             instanceId,
             reconfiguring: true,
         });
+        const paramBindings = (0, paramHelper_1.getBaseParamBindings)(paramBindingOptions);
         if (immutableParams.length) {
             const plural = immutableParams.length > 1;
             logger_1.logger.info(`The following param${plural ? "s are" : " is"} immutable:`);
             for (const { param } of immutableParams) {
                 const value = _.get(existingInstance, `config.params.${param}`);
                 logger_1.logger.info(`param: ${param}, value: ${value}`);
-                params[param] = value;
+                paramBindings[param] = value;
             }
             logger_1.logger.info((plural
                 ? "To set different values for these params"
@@ -70,10 +111,15 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
                 ", uninstall the extension, then install a new instance of this extension.");
         }
         spinner.start();
-        const res = await extensionsApi.configureInstance({ projectId, instanceId, params });
+        const res = await extensionsApi.configureInstance({
+            projectId,
+            instanceId,
+            params: paramBindings,
+        });
         spinner.stop();
         utils.logLabeledSuccess(extensionsHelper_1.logPrefix, `successfully configured ${clc.bold(instanceId)}.`);
         utils.logLabeledBullet(extensionsHelper_1.logPrefix, marked(`You can view your reconfigured instance in the Firebase console: ${utils.consoleUrl(projectId, `/extensions/instances/${instanceId}?tab=config`)}`));
+        manifest.showDeprecationWarning();
         return res;
     }
     catch (err) {
@@ -88,3 +134,17 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
         throw err;
     }
 });
+function infoImmutableParams(immutableParams, paramValues) {
+    if (!immutableParams.length) {
+        return;
+    }
+    const plural = immutableParams.length > 1;
+    utils.logLabeledWarning(extensionsHelper_1.logPrefix, marked(`The following param${plural ? "s are" : " is"} immutable and won't be changed:`));
+    for (const { param } of immutableParams) {
+        logger_1.logger.info(`param: ${param}, value: ${paramValues[param]}`);
+    }
+    logger_1.logger.info((plural
+        ? "To set different values for these params"
+        : "To set a different value for this param") +
+        ", uninstall the extension, then install a new instance of this extension.");
+}

package/lib/commands/ext-dev-init.js

@@ -24,6 +24,55 @@ function readCommonTemplates() {
         changelogTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "CHANGELOG.md"), "utf8"),
     };
 }
+exports.default = new command_1.Command("ext:dev:init")
+    .description("initialize files for writing an extension in the current directory")
+    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
+    .action(async (options) => {
+    const cwd = options.cwd || process.cwd();
+    const config = new config_1.Config({}, { projectDir: cwd, cwd: cwd });
+    try {
+        const lang = await (0, prompt_1.promptOnce)({
+            type: "list",
+            name: "language",
+            message: "In which language do you want to write the Cloud Functions for your extension?",
+            default: "javascript",
+            choices: [
+                {
+                    name: "JavaScript",
+                    value: "javascript",
+                },
+                {
+                    name: "TypeScript",
+                    value: "typescript",
+                },
+            ],
+        });
+        switch (lang) {
+            case "javascript": {
+                await javascriptSelected(config);
+                break;
+            }
+            case "typescript": {
+                await typescriptSelected(config);
+                break;
+            }
+            default: {
+                throw new error_1.FirebaseError(`${lang} is not supported.`);
+            }
+        }
+        await npmDependencies.askInstallDependencies({}, config);
+        const welcome = fs.readFileSync(path.join(TEMPLATE_ROOT, lang, "WELCOME.md"), "utf8");
+        return logger_1.logger.info("\n" + marked(welcome));
+    }
+    catch (err) {
+        if (!(err instanceof error_1.FirebaseError)) {
+            throw new error_1.FirebaseError(`Error occurred when initializing files for new extension: ${err.message}`, {
+                original: err,
+            });
+        }
+        throw err;
+    }
+});
 async function typescriptSelected(config) {
     const packageLintingTemplate = fs.readFileSync(path.join(TEMPLATE_ROOT, "typescript", "package.lint.json"), "utf8");
     const packageNoLintingTemplate = fs.readFileSync(path.join(TEMPLATE_ROOT, "typescript", "package.nolint.json"), "utf8");
@@ -84,52 +133,3 @@ async function javascriptSelected(config) {
     }
     await config.askWriteProjectFile("functions/.gitignore", gitignoreTemplate);
 }
-exports.default = new command_1.Command("ext:dev:init")
-    .description("initialize files for writing an extension in the current directory")
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (options) => {
-    const cwd = options.cwd || process.cwd();
-    const config = new config_1.Config({}, { projectDir: cwd, cwd: cwd });
-    try {
-        const lang = await (0, prompt_1.promptOnce)({
-            type: "list",
-            name: "language",
-            message: "In which language do you want to write the Cloud Functions for your extension?",
-            default: "javascript",
-            choices: [
-                {
-                    name: "JavaScript",
-                    value: "javascript",
-                },
-                {
-                    name: "TypeScript",
-                    value: "typescript",
-                },
-            ],
-        });
-        switch (lang) {
-            case "javascript": {
-                await javascriptSelected(config);
-                break;
-            }
-            case "typescript": {
-                await typescriptSelected(config);
-                break;
-            }
-            default: {
-                throw new error_1.FirebaseError(`${lang} is not supported.`);
-            }
-        }
-        await npmDependencies.askInstallDependencies({}, config);
-        const welcome = fs.readFileSync(path.join(TEMPLATE_ROOT, lang, "WELCOME.md"), "utf8");
-        return logger_1.logger.info("\n" + marked(welcome));
-    }
-    catch (err) {
-        if (!(err instanceof error_1.FirebaseError)) {
-            throw new error_1.FirebaseError(`Error occurred when initializing files for new extension: ${err.message}`, {
-                original: err,
-            });
-        }
-        throw err;
-    }
-});

package/lib/commands/ext-export.js

@@ -5,6 +5,7 @@ const command_1 = require("../command");
 const planner = require("../deploy/extensions/planner");
 const export_1 = require("../extensions/export");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
+const manifest = require("../extensions/manifest");
 const functional_1 = require("../functional");
 const getProjectNumber_1 = require("../getProjectNumber");
 const logger_1 = require("../logger");
@@ -24,7 +25,7 @@ module.exports = new command_1.Command("ext:export")
         const subbed = await (0, export_1.setSecretParamsToLatest)(i);
         return (0, export_1.parameterizeProject)(projectId, projectNumber, subbed);
     }));
-    if (have.length == 0) {
+    if (have.length === 0) {
         logger_1.logger.info(`No extension instances installed on ${projectId}, so there is nothing to export.`);
         return;
     }
@@ -40,5 +41,9 @@ module.exports = new command_1.Command("ext:export")
         logger_1.logger.info("Exiting. No changes made.");
         return;
     }
-    await (0, export_1.writeFiles)(withRef, options);
+    const existingConfig = manifest.loadConfig(options);
+    await manifest.writeToManifest(withRef, existingConfig, {
+        nonInteractive: options.nonInteractive,
+        force: options.force,
+    }, true);
 });