firebase-tools 13.29.3 → 13.31.0

package/lib/management/apps.js

@@ -1,16 +1,248 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteAppAndroidSha = exports.createAppAndroidSha = exports.listAppAndroidSha = exports.getAppConfig = exports.getAppConfigFile = exports.listFirebaseApps = exports.createWebApp = exports.createAndroidApp = exports.createIosApp = exports.getAppPlatform = exports.ShaCertificateType = exports.AppPlatform = exports.APP_LIST_PAGE_SIZE = void 0;
+exports.findIntelligentPathForAndroid = exports.findIntelligentPathForIOS = exports.deleteAppAndroidSha = exports.createAppAndroidSha = exports.listAppAndroidSha = exports.getAppConfig = exports.writeConfigToFile = exports.getAppConfigFile = exports.listFirebaseApps = exports.createWebApp = exports.createAndroidApp = exports.createIosApp = exports.getAppPlatform = exports.ShaCertificateType = exports.AppPlatform = exports.getSdkConfig = exports.checkForApps = exports.getSdkOutputPath = exports.sdkInit = exports.getPlatform = exports.APP_LIST_PAGE_SIZE = void 0;
+const fs = require("fs-extra");
+const ora = require("ora");
+const path = require("path");
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
 const operation_poller_1 = require("../operation-poller");
-const templates_1 = require("../templates");
+const types_1 = require("../dataconnect/types");
+const projectUtils_1 = require("../projectUtils");
+const prompt_1 = require("../prompt");
+const projects_1 = require("./projects");
+const fileUtils_1 = require("../dataconnect/fileUtils");
+const utils_1 = require("../utils");
 const TIMEOUT_MILLIS = 30000;
 exports.APP_LIST_PAGE_SIZE = 100;
 const CREATE_APP_API_REQUEST_TIMEOUT_MILLIS = 15000;
-const WEB_CONFIG_FILE_NAME = "google-config.js";
+const DISPLAY_NAME_QUESTION = {
+    type: "input",
+    name: "displayName",
+    default: "",
+    message: "What would you like to call your app?",
+};
+async function getPlatform(appDir, config) {
+    let targetPlatform = await (0, fileUtils_1.getPlatformFromFolder)(appDir);
+    if (targetPlatform === types_1.Platform.NONE) {
+        appDir = await (0, prompt_1.promptForDirectory)({
+            config,
+            relativeTo: appDir,
+            message: "We couldn't determine what kind of app you're using. Where is your app directory?",
+        });
+        targetPlatform = await (0, fileUtils_1.getPlatformFromFolder)(appDir);
+    }
+    if (targetPlatform === types_1.Platform.NONE || targetPlatform === types_1.Platform.MULTIPLE) {
+        if (targetPlatform === types_1.Platform.NONE) {
+            (0, utils_1.logBullet)(`Couldn't automatically detect app your in directory ${appDir}.`);
+        }
+        else {
+            (0, utils_1.logSuccess)(`Detected multiple app platforms in directory ${appDir}`);
+        }
+        const platforms = [
+            { name: "iOS (Swift)", value: types_1.Platform.IOS },
+            { name: "Web (JavaScript)", value: types_1.Platform.WEB },
+            { name: "Android (Kotlin)", value: types_1.Platform.ANDROID },
+        ];
+        targetPlatform = await (0, prompt_1.promptOnce)({
+            message: "Which platform do you want to set up an SDK for? Note: We currently do not support automatically setting up C++ or Unity projects.",
+            type: "list",
+            choices: platforms,
+        });
+    }
+    else if (targetPlatform === types_1.Platform.FLUTTER) {
+        (0, utils_1.logWarning)(`Detected ${targetPlatform} app in directory ${appDir}`);
+        throw new error_1.FirebaseError(`Flutter is not supported by apps:configure.
+Please follow the link below to set up firebase for your Flutter app:
+https://firebase.google.com/docs/flutter/setup
+    `);
+    }
+    else {
+        (0, utils_1.logSuccess)(`Detected ${targetPlatform} app in directory ${appDir}`);
+    }
+    return targetPlatform === types_1.Platform.MULTIPLE
+        ? AppPlatform.PLATFORM_UNSPECIFIED
+        : targetPlatform;
+}
+exports.getPlatform = getPlatform;
+async function initiateIosAppCreation(options) {
+    if (!options.nonInteractive) {
+        await (0, prompt_1.prompt)(options, [
+            DISPLAY_NAME_QUESTION,
+            {
+                type: "input",
+                default: "",
+                name: "bundleId",
+                message: "Please specify your iOS app bundle ID:",
+            },
+            {
+                type: "input",
+                default: "",
+                name: "appStoreId",
+                message: "Please specify your iOS app App Store ID:",
+            },
+        ]);
+    }
+    if (!options.bundleId) {
+        throw new error_1.FirebaseError("Bundle ID for iOS app cannot be empty");
+    }
+    const spinner = ora("Creating your iOS app").start();
+    try {
+        const appData = await createIosApp(options.project, {
+            displayName: options.displayName,
+            bundleId: options.bundleId,
+            appStoreId: options.appStoreId,
+        });
+        spinner.succeed();
+        return appData;
+    }
+    catch (err) {
+        spinner.fail();
+        throw err;
+    }
+}
+async function initiateAndroidAppCreation(options) {
+    if (!options.nonInteractive) {
+        await (0, prompt_1.prompt)(options, [
+            DISPLAY_NAME_QUESTION,
+            {
+                type: "input",
+                default: "",
+                name: "packageName",
+                message: "Please specify your Android app package name:",
+            },
+        ]);
+    }
+    if (!options.packageName) {
+        throw new error_1.FirebaseError("Package name for Android app cannot be empty");
+    }
+    const spinner = ora("Creating your Android app").start();
+    try {
+        const appData = await createAndroidApp(options.project, {
+            displayName: options.displayName,
+            packageName: options.packageName,
+        });
+        spinner.succeed();
+        return appData;
+    }
+    catch (err) {
+        spinner.fail();
+        throw err;
+    }
+}
+async function initiateWebAppCreation(options) {
+    if (!options.nonInteractive) {
+        await (0, prompt_1.prompt)(options, [DISPLAY_NAME_QUESTION]);
+    }
+    if (!options.displayName) {
+        throw new error_1.FirebaseError("Display name for Web app cannot be empty");
+    }
+    const spinner = ora("Creating your Web app").start();
+    try {
+        const appData = await createWebApp(options.project, { displayName: options.displayName });
+        spinner.succeed();
+        return appData;
+    }
+    catch (err) {
+        spinner.fail();
+        throw err;
+    }
+}
+async function sdkInit(appPlatform, options) {
+    let appData;
+    switch (appPlatform) {
+        case AppPlatform.IOS:
+            appData = await initiateIosAppCreation(options);
+            break;
+        case AppPlatform.ANDROID:
+            appData = await initiateAndroidAppCreation(options);
+            break;
+        case AppPlatform.WEB:
+            appData = await initiateWebAppCreation(options);
+            break;
+        default:
+            throw new error_1.FirebaseError("Unexpected error. This should not happen");
+    }
+    return appData;
+}
+exports.sdkInit = sdkInit;
+async function getSdkOutputPath(appDir, platform, config) {
+    switch (platform) {
+        case AppPlatform.ANDROID:
+            const androidPath = await findIntelligentPathForAndroid(appDir, config);
+            return path.join(androidPath, "google-services.json");
+        case AppPlatform.WEB:
+            return path.join(appDir, "firebase-js-config.json");
+        case AppPlatform.IOS:
+            const iosPath = await findIntelligentPathForIOS(appDir, config);
+            return path.join(iosPath, "GoogleService-Info.plist");
+    }
+    throw new error_1.FirebaseError("Platform " + platform.toString() + " is not supported yet.");
+}
+exports.getSdkOutputPath = getSdkOutputPath;
+function checkForApps(apps, appPlatform) {
+    if (!apps.length) {
+        throw new error_1.FirebaseError(`There are no ${appPlatform === AppPlatform.ANY ? "" : appPlatform + " "}apps ` +
+            "associated with this Firebase project");
+    }
+}
+exports.checkForApps = checkForApps;
+async function selectAppInteractively(apps, appPlatform) {
+    checkForApps(apps, appPlatform);
+    const choices = apps.map((app) => {
+        return {
+            name: `${app.displayName || app.bundleId || app.packageName}` +
+                ` - ${app.appId} (${app.platform})`,
+            value: app,
+        };
+    });
+    return await (0, prompt_1.promptOnce)({
+        type: "list",
+        message: `Select the ${appPlatform === AppPlatform.ANY ? "" : appPlatform + " "}` +
+            "app to get the configuration data:",
+        choices,
+    });
+}
+async function getSdkConfig(options, appPlatform, appId) {
+    if (!appId) {
+        let projectId = (0, projectUtils_1.needProjectId)(options);
+        if (options.nonInteractive && !projectId) {
+            throw new error_1.FirebaseError("Must supply app and project ids in non-interactive mode.");
+        }
+        else if (!projectId) {
+            const result = await (0, projects_1.getOrPromptProject)(options);
+            projectId = result.projectId;
+        }
+        const apps = await listFirebaseApps(projectId, appPlatform);
+        checkForApps(apps, appPlatform);
+        if (apps.length === 1) {
+            appId = apps[0].appId;
+            appPlatform = apps[0].platform;
+        }
+        else if (options.nonInteractive) {
+            throw new error_1.FirebaseError(`Project ${projectId} has multiple apps, must specify an app id.`);
+        }
+        else {
+            const appMetadata = await selectAppInteractively(apps, appPlatform);
+            appId = appMetadata.appId;
+            appPlatform = appMetadata.platform;
+        }
+    }
+    let configData;
+    const spinner = ora(`Downloading configuration data for your Firebase ${appPlatform} app`).start();
+    try {
+        configData = await getAppConfig(appId, appPlatform);
+    }
+    catch (err) {
+        spinner.fail();
+        throw err;
+    }
+    spinner.succeed();
+    return configData;
+}
+exports.getSdkConfig = getSdkConfig;
 var AppPlatform;
 (function (AppPlatform) {
     AppPlatform["PLATFORM_UNSPECIFIED"] = "PLATFORM_UNSPECIFIED";
@@ -182,13 +414,12 @@ function getAppConfigResourceString(appId, platform) {
 }
 function parseConfigFromResponse(responseBody, platform) {
     if (platform === AppPlatform.WEB) {
-        const JS_TEMPLATE = (0, templates_1.readTemplateSync)("setup/web.js");
         return {
-            fileName: WEB_CONFIG_FILE_NAME,
-            fileContents: JS_TEMPLATE.replace("{/*--CONFIG--*/}", JSON.stringify(responseBody, null, 2)),
+            fileName: "firebase-js-config.json",
+            fileContents: JSON.stringify(responseBody, null, 2),
         };
     }
-    else if (platform === AppPlatform.ANDROID || platform === AppPlatform.IOS) {
+    else if ("configFilename" in responseBody) {
         return {
             fileName: responseBody.configFilename,
             fileContents: Buffer.from(responseBody.configFileContents, "base64").toString("utf8"),
@@ -200,6 +431,24 @@ function getAppConfigFile(config, platform) {
     return parseConfigFromResponse(config, platform);
 }
 exports.getAppConfigFile = getAppConfigFile;
+async function writeConfigToFile(filename, nonInteractive, fileContents) {
+    if (fs.existsSync(filename)) {
+        if (nonInteractive) {
+            throw new error_1.FirebaseError(`${filename} already exists`);
+        }
+        const overwrite = await (0, prompt_1.promptOnce)({
+            type: "confirm",
+            default: false,
+            message: `${filename} already exists. Do you want to overwrite?`,
+        });
+        if (!overwrite) {
+            return false;
+        }
+    }
+    await fs.writeFile(filename, fileContents);
+    return true;
+}
+exports.writeConfigToFile = writeConfigToFile;
 async function getAppConfig(appId, platform) {
     try {
         const response = await apiClient.request({
@@ -278,3 +527,61 @@ async function deleteAppAndroidSha(projectId, appId, shaId) {
     }
 }
 exports.deleteAppAndroidSha = deleteAppAndroidSha;
+async function findIntelligentPathForIOS(appDir, options) {
+    const currentFiles = await fs.readdir(appDir, { withFileTypes: true });
+    for (let i = 0; i < currentFiles.length; i++) {
+        const dirent = currentFiles[i];
+        const xcodeStr = ".xcodeproj";
+        const file = dirent.name;
+        if (file.endsWith(xcodeStr)) {
+            return path.join(appDir, file.substring(0, file.length - xcodeStr.length));
+        }
+        else if (file === "Info.plist" ||
+            file === "Assets.xcassets" ||
+            (dirent.isDirectory() && file === "Preview Content")) {
+            return appDir;
+        }
+    }
+    let outputPath = null;
+    if (!options.nonInteractive) {
+        outputPath = await (0, prompt_1.promptForDirectory)({
+            config: options.config,
+            message: `We weren't able to automatically determine the output directory. Where would you like to output your config file?`,
+            relativeTo: appDir,
+        });
+    }
+    if (!outputPath) {
+        throw new Error("We weren't able to automatically determine the output directory.");
+    }
+    return outputPath;
+}
+exports.findIntelligentPathForIOS = findIntelligentPathForIOS;
+async function findIntelligentPathForAndroid(appDir, options) {
+    const paths = appDir.split("/");
+    if (paths[0] === "app") {
+        return appDir;
+    }
+    else {
+        const currentFiles = await fs.readdir(appDir, { withFileTypes: true });
+        const dirs = [];
+        for (const fileOrDir of currentFiles) {
+            if (fileOrDir.isDirectory()) {
+                if (fileOrDir.name === "src") {
+                    return appDir;
+                }
+            }
+        }
+        let module = path.join(appDir, "app");
+        if (dirs.length === 1) {
+            return module;
+        }
+        if (!options.nonInteractive) {
+            module = await (0, prompt_1.promptForDirectory)({
+                config: options.config,
+                message: `We weren't able to automatically determine the output directory. Where would you like to output your config file?`,
+            });
+        }
+        return module;
+    }
+}
+exports.findIntelligentPathForAndroid = findIntelligentPathForAndroid;

package/lib/profileReport.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProfileReport = exports.extractReadableIndex = exports.formatBytes = exports.formatNumber = exports.pathString = exports.extractJSON = void 0;
 const clc = require("colorette");
-const Table = require("cli-table");
+const Table = require("cli-table3");
 const fs = require("fs");
 const _ = require("lodash");
 const readline = require("readline");

package/lib/prompt.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.promptForDirectory = exports.confirm = exports.promptOnce = exports.prompt = void 0;
 const inquirer = require("inquirer");
+const path = require("path");
 const fsutils_1 = require("./fsutils");
 const error_1 = require("./error");
 const logger_1 = require("./logger");
@@ -54,9 +55,16 @@ exports.confirm = confirm;
 async function promptForDirectory(args) {
     let dir = "";
     while (!dir) {
-        const target = args.config.path(await promptOnce({
+        const promptPath = await promptOnce({
             message: args.message,
-        }));
+        });
+        let target;
+        if (args.relativeTo) {
+            target = path.resolve(args.relativeTo, promptPath);
+        }
+        else {
+            target = args.config.path(promptPath);
+        }
         if ((0, fsutils_1.fileExistsSync)(target)) {
             logger_1.logger.error(`Expected a directory, but ${target} is a file. Please provide a path to a directory.`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "13.29.3",
+  "version": "13.31.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {
@@ -29,7 +29,7 @@
   ],
   "preferGlobal": true,
   "engines": {
-    "node": ">=18.0.0 || >=20.0.0"
+    "node": ">=18.0.0 || >=20.0.0 || >=22.0.0"
   },
   "author": "Firebase (https://firebase.google.com/)",
   "license": "MIT",
@@ -71,7 +71,7 @@
     "body-parser": "^1.19.0",
     "chokidar": "^3.6.0",
     "cjson": "^0.3.1",
-    "cli-table": "0.3.11",
+    "cli-table3": "0.6.5",
     "colorette": "^2.0.19",
     "commander": "^5.1.0",
     "configstore": "^5.0.1",
@@ -84,7 +84,7 @@
     "exegesis-express": "^4.0.0",
     "express": "^4.16.4",
     "filesize": "^6.1.0",
-    "form-data": "^4.0.0",
+    "form-data": "^4.0.1",
     "fs-extra": "^10.1.0",
     "fuzzy": "^0.1.3",
     "gaxios": "^6.7.0",
@@ -116,7 +116,7 @@
     "sql-formatter": "^15.3.0",
     "stream-chain": "^2.2.4",
     "stream-json": "^1.7.3",
-    "superstatic": "^9.1.0",
+    "superstatic": "^9.2.0",
     "tar": "^6.1.11",
     "tcp-port-used": "^1.0.2",
     "tmp": "^0.2.3",
@@ -128,5 +128,14 @@
     "winston-transport": "^4.4.0",
     "ws": "^7.5.10",
     "yaml": "^2.4.1"
+  },
+  "overrides": {
+    "@angular-devkit/core": {
+      "ajv-formats": "3.0.1",
+      "ajv": "^8.17.1"
+    },
+    "node-fetch": {
+      "whatwg-url": "^14.0.0"
+    }
   }
 }

package/templates/genkit/firebase.0.9.0.template

@@ -19,7 +19,7 @@ export const menuSuggestionFlow = onFlow(
   ai,
   {
     name: "menuSuggestionFlow",
-    inputSchema: z.string(),
+    inputSchema: z.string().describe("A restaurant theme").default("seafood"),
     outputSchema: z.string(),
     authPolicy: firebaseAuth((user) => {
       // By default, the firebaseAuth policy requires that all requests have an

package/templates/genkit/firebase.1.0.0.template

@@ -0,0 +1,66 @@
+// Import the Genkit core libraries and plugins.
+import {genkit, z} from "genkit";
+$GENKIT_CONFIG_IMPORTS
+$GENKIT_MODEL_IMPORT
+
+// Cloud Functions for Firebase supports Genkit natively. The onCallGenkit function creates a callable
+// function from a Genkit action. It automatically implements streaming if your flow does.
+// The https library also has other utility methods such as hasClaim, which verifies that
+// a caller's token has a specific claim (optionally matching a specific value)
+import { onCallGenkit, hasClaim } from "firebase-functions/https";
+
+// Genkit models generally depend on an API key. APIs should be stored in Cloud Secret Manager so that
+// access to these sensitive values can be controlled. defineSecret does this for you automatically.
+// If you are using Google generative AI you can get an API key at https://aistudio.google.com/app/apikey
+import { defineSecret } from "firebase-functions/params";
+const apiKey = defineSecret("GOOGLE_GENAI_API_KEY");
+
+const ai = genkit({
+  plugins: [
+$GENKIT_CONFIG_PLUGINS
+  ],
+});
+
+// Define a simple flow that prompts an LLM to generate menu suggestions.
+const menuSuggestionFlow = ai.defineFlow({
+    name: "menuSuggestionFlow",
+    inputSchema: z.string().describe("A restaurant theme").default("seafood"),
+    outputSchema: z.string(),
+    streamSchema: z.string(),
+  }, async (subject, { sendChunk }) => {
+    // Construct a request and send it to the model API.
+    const prompt =
+      `Suggest an item for the menu of a ${subject} themed restaurant`;
+    const { response, stream } = ai.generateStream({
+      model: $GENKIT_MODEL,
+      prompt: prompt,
+      config: {
+        temperature: 1,
+      },
+    });
+
+    for await (const chunk of stream) {
+      sendChunk(chunk.text);
+    }
+
+    // Handle the response from the model API. In this sample, we just
+    // convert it to a string, but more complicated flows might coerce the
+    // response into structured output or chain the response into another
+    // LLM call, etc.
+    return (await response).text;
+  }
+);
+
+export const menuSuggestion = onCallGenkit({
+  // Uncomment to enable AppCheck. This can reduce costs by ensuring only your Verified
+  // app users can use your API. Read more at https://firebase.google.com/docs/app-check/cloud-functions
+  // enforceAppCheck: true,
+
+  // authPolicy can be any callback that accepts an AuthData (a uid and tokens dictionary) and the
+  // request data. The isSignedIn() and hasClaim() helpers can be used to simplify. The following
+  // will require the user to have the email_verified claim, for example.
+  // authPolicy: hasClaim("email_verified"),
+
+  // Grant access to the API key to this function:
+  secrets: [apiKey],
+}, menuSuggestionFlow);

package/templates/init/dataconnect/mutations.gql

@@ -1,36 +1,20 @@
 # # Example mutations for a simple movie app
 
 # # Create a movie based on user input
-# mutation CreateMovie(
-#   $title: String!
-#   $genre: String!
-#   $imageUrl: String!
-# ) @auth(level: USER_EMAIL_VERIFIED) {
-#   movie_insert(
-#     data: {
-#       title: $title
-#       genre: $genre
-#       imageUrl: $imageUrl
-#     }
-#   )
+# mutation CreateMovie($title: String!, $genre: String!, $imageUrl: String!)
+# @auth(level: USER_EMAIL_VERIFIED) {
+#   movie_insert(data: { title: $title, genre: $genre, imageUrl: $imageUrl })
 # }
 
 # # Upsert (update or insert) a user's username based on their auth.uid
 # mutation UpsertUser($username: String!) @auth(level: USER) {
-#   user_upsert(
-#     data: {
-#       id_expr: "auth.uid"
-#       username: $username
-#     }
-#   )
+#   # The "auth.uid" server value ensures that users can only register their own user.
+#   user_upsert(data: { id_expr: "auth.uid", username: $username })
 # }
 
 # # Add a review for a movie
-# mutation AddReview(
-#   $movieId: UUID!
-#   $rating: Int!
-#   $reviewText: String!
-# ) @auth(level: USER) {
+# mutation AddReview($movieId: UUID!, $rating: Int!, $reviewText: String!)
+# @auth(level: USER) {
 #   review_upsert(
 #     data: {
 #       userId_expr: "auth.uid"
@@ -43,8 +27,7 @@
 # }
 
 # # Logged in user can delete their review for a movie
-# mutation DeleteReview(
-#   $movieId: UUID!
-# ) @auth(level: USER) {
+# mutation DeleteReview($movieId: UUID!) @auth(level: USER) {
+#   # The "auth.uid" server value ensures that users can only delete their own reviews.
 #   review_delete(key: { userId_expr: "auth.uid", movieId: $movieId })
 # }

package/templates/init/dataconnect/queries.gql

@@ -13,19 +13,21 @@
 
 # # List all users, only admins should be able to list all users, so we use NO_ACCESS
 # query ListUsers @auth(level: NO_ACCESS) {
-#   users { id, username }
+#   users {
+#     id
+#     username
+#   }
 # }
 
-# # Logged in user can list all their reviews and movie titles associated with the review 
-# # Since the query requires the uid of the current authenticated user, the auth level is set to USER
+# # Logged in users can list all their reviews and movie titles associated with the review
+# # Since the query uses the uid of the current authenticated user, we set auth level to USER
 # query ListUserReviews @auth(level: USER) {
-#   user(key: {id_expr: "auth.uid"}) {
+#   user(key: { id_expr: "auth.uid" }) {
 #     id
 #     username
 #     # <field>_on_<foreign_key_field> makes it easy to grab info from another table
 #     # Here, we use it to grab all the reviews written by the user.
 #     reviews: reviews_on_user {
-#       id
 #       rating
 #       reviewDate
 #       reviewText
@@ -50,7 +52,6 @@
 #       description
 #     }
 #     reviews: reviews_on_movie {
-#       id
 #       reviewText
 #       reviewDate
 #       rating
@@ -63,16 +64,10 @@
 # }
 
 # # Search for movies, actors, and reviews
-# query SearchMovie(
-#   $titleInput: String
-#   $genre: String
-# ) @auth(level: PUBLIC) {
+# query SearchMovie($titleInput: String, $genre: String) @auth(level: PUBLIC) {
 #   movies(
 #     where: {
-#       _and: [
-#         { genre: { eq: $genre } }
-#         { title: { contains: $titleInput } }
-#       ]
+#       _and: [{ genre: { eq: $genre } }, { title: { contains: $titleInput } }]
 #     }
 #   ) {
 #     id