firebase-tools 11.30.0 → 12.0.0

package/templates/extensions/POSTINSTALL.md

@@ -4,10 +4,10 @@ This file provides your users an overview of how to use your extension after the
 Include instructions for using the extension and any important functional details. Also include **detailed descriptions** for any additional post-installation setup required by the user.
 
 Reference values for the extension instance using the ${param:PARAMETER_NAME} or ${function:VARIABLE_NAME} syntax.
-Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/create-user-docs#reference-in-postinstall
+Learn more in the docs: https://firebase.google.com/docs/extensions/publishers/user-documentation#reference-in-postinstall
 
 Learn more about writing a POSTINSTALL.md file in the docs:
-https://firebase.google.com/docs/extensions/alpha/create-user-docs#writing-postinstall
+https://firebase.google.com/docs/extensions/publishers/user-documentation#writing-postinstall
 -->
 
 # See it in action

package/templates/extensions/PREINSTALL.md

@@ -4,7 +4,7 @@ This file provides your users an overview of your extension. All content is opti
 Include any important functional details as well as a brief description for any additional setup required by the user (both pre- and post-installation).
 
 Learn more about writing a PREINSTALL.md file in the docs:
-https://firebase.google.com/docs/extensions/alpha/create-user-docs#writing-preinstall
+https://firebase.google.com/docs/extensions/publishers/user-documentation#writing-preinstall
 -->
 
 Use this extension to send a friendly greeting.

package/templates/extensions/extension.yaml

@@ -1,5 +1,5 @@
 # Learn detailed information about the fields of an extension.yaml file in the docs:
-# https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml
+# https://firebase.google.com/docs/extensions/reference/extension-yaml
 
 name: greet-the-world  # Identifier for your extension
 version: 0.0.1  # Follow semver versioning
@@ -18,18 +18,21 @@ license: Apache-2.0  # https://spdx.org/licenses/
 sourceUrl: https://github.com/firebase/firebase-tools/tree/master/templates/extensions
 
 # Specify whether a paid-tier billing plan is required to use your extension.
-# Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#billing-required-field
+# Learn more in the docs: https://firebase.google.com/docs/extensions/reference/extension-yaml#billing-required-field
 billingRequired: false
 
 # In an `apis` field, list any Google APIs (like Cloud Translation, BigQuery, etc.)
 # required for your extension to operate.
-# Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#apis-field
+# Learn more in the docs:
+# https://firebase.google.com/docs/extensions/reference/extension-yaml#apis-field
 
 # In a `roles` field, list any IAM access roles required for your extension to operate.
-# Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#roles-field
+# Learn more in the docs:
+# https://firebase.google.com/docs/extensions/reference/extension-yaml#roles-field
 
 # In the `resources` field, list each of your extension's functions, including the trigger for each function.
-# Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#resources-field
+# Learn more in the docs:
+# https://firebase.google.com/docs/extensions/reference/extension-yaml#resources-field
 resources:
   - name: greetTheWorld
     type: firebaseextensions.v1beta.function
@@ -43,7 +46,8 @@ resources:
       runtime: "nodejs16"
 
 # In the `params` field, set up your extension's user-configured parameters.
-# Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#params-field
+# Learn more in the docs:
+# https://firebase.google.com/docs/extensions/reference/extension-yaml#params-field
 params:
   - param: GREETING
     label: Greeting for the world

package/templates/extensions/javascript/WELCOME.md

@@ -15,4 +15,4 @@ If you want to deploy your extension to test on a real project, go to a Firebase
 `firebase ext:install ./path/to/extension/directory --project=<project-id>`
 `firebase deploy --only extensions`
 
-You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/alpha/overview-build-extensions
+You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/publishers/get-started

package/templates/extensions/typescript/WELCOME.md

@@ -19,4 +19,4 @@ If you want to deploy your extension to test on a real project, go to a Firebase
 `firebase ext:install ./path/to/extension/directory --project=<project-id>`
 `firebase deploy --only extensions`
 
-You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/alpha/overview-build-extensions
+You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/publishers/get-started

package/templates/extensions/typescript/index.ts

@@ -5,7 +5,7 @@
  * Reference PARAMETERS in your functions code with:
  * `process.env.<parameter-name>`
  * Learn more about building extensions in the docs:
- * https://firebase.google.com/docs/extensions/alpha/overview
+ * https://firebase.google.com/docs/extensions/publishers
  */
 
 import * as functions from "firebase-functions";

package/templates/init/functions/javascript/index.js

@@ -1,9 +1,19 @@
-const functions = require("firebase-functions");
+/**
+ * Import function triggers from their respective submodules:
+ *
+ * const {onCall} = require("firebase-functions/v2/https");
+ * const {onDocumentWritten} = require("firebase-functions/v2/firestore");
+ *
+ * See a full list of supported triggers at https://firebase.google.com/docs/functions
+ */
 
-// // Create and deploy your first functions
-// // https://firebase.google.com/docs/functions/get-started
-//
-// exports.helloWorld = functions.https.onRequest((request, response) => {
-//   functions.logger.info("Hello logs!", {structuredData: true});
+const {onRequest} = require("firebase-functions/v2/https");
+const logger = require("firebase-functions/logger");
+
+// Create and deploy your first functions
+// https://firebase.google.com/docs/functions/get-started
+
+// exports.helloWorld = onRequest((request, response) => {
+//   logger.info("Hello logs!", {structuredData: true});
 //   response.send("Hello from Firebase!");
 // });

package/templates/init/functions/javascript/package.lint.json

@@ -10,17 +10,17 @@
     "logs": "firebase functions:log"
   },
   "engines": {
-    "node": "16"
+    "node": "18"
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.3.1"
   },
   "devDependencies": {
     "eslint": "^8.15.0",
     "eslint-config-google": "^0.14.0",
-    "firebase-functions-test": "^3.0.0"
+    "firebase-functions-test": "^3.1.0"
   },
   "private": true
 }

package/templates/init/functions/javascript/package.nolint.json

@@ -9,15 +9,15 @@
     "logs": "firebase functions:log"
   },
   "engines": {
-    "node": "16"
+    "node": "18"
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.3.1"
   },
   "devDependencies": {
-    "firebase-functions-test": "^3.0.0"
+    "firebase-functions-test": "^3.1.0"
   },
   "private": true
 }

package/templates/init/functions/typescript/index.ts

@@ -1,9 +1,19 @@
-import * as functions from "firebase-functions";
+/**
+ * Import function triggers from their respective submodules:
+ *
+ * import {onCall} from "firebase-functions/v2/https";
+ * import {onDocumentWritten} from "firebase-functions/v2/firestore";
+ *
+ * See a full list of supported triggers at https://firebase.google.com/docs/functions
+ */
 
-// // Start writing functions
-// // https://firebase.google.com/docs/functions/typescript
-//
-// export const helloWorld = functions.https.onRequest((request, response) => {
-//   functions.logger.info("Hello logs!", {structuredData: true});
+import {onRequest} from "firebase-functions/v2/https";
+import * as logger from "firebase-functions/logger";
+
+// Start writing functions
+// https://firebase.google.com/docs/functions/typescript
+
+// export const helloWorld = onRequest((request, response) => {
+//   logger.info("Hello logs!", {structuredData: true});
 //   response.send("Hello from Firebase!");
 // });

package/templates/init/functions/typescript/package.lint.json

@@ -11,12 +11,12 @@
     "logs": "firebase functions:log"
   },
   "engines": {
-    "node": "16"
+    "node": "18"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.3.1"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.12.0",
@@ -24,7 +24,7 @@
     "eslint": "^8.9.0",
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-import": "^2.25.4",
-    "firebase-functions-test": "^3.0.0",
+    "firebase-functions-test": "^3.1.0",
     "typescript": "^4.9.0"
   },
   "private": true

package/templates/init/functions/typescript/package.nolint.json

@@ -10,16 +10,16 @@
     "logs": "firebase functions:log"
   },
   "engines": {
-    "node": "16"
+    "node": "18"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^11.5.0",
-    "firebase-functions": "^4.2.0"
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.3.1"
   },
   "devDependencies": {
     "typescript": "^4.9.0",
-    "firebase-functions-test": "^3.0.0"
+    "firebase-functions-test": "^3.1.0"
   },
   "private": true
 }

package/lib/commands/ext-dev-emulators-exec.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const clc = require("colorette");
-const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
-const command_1 = require("../command");
-const error_1 = require("../error");
-const commandUtils = require("../emulator/commandUtils");
-exports.command = new command_1.Command("ext:dev:emulators:exec <script>")
-    .description("deprecated: please use `firebase emulators:exec` instead")
-    .before(commandUtils.setExportOnExitOptions)
-    .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
-    .option(commandUtils.FLAG_TEST_CONFIG, commandUtils.DESC_TEST_CONFIG)
-    .option(commandUtils.FLAG_TEST_PARAMS, commandUtils.DESC_TEST_PARAMS)
-    .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)
-    .option(commandUtils.FLAG_EXPORT_ON_EXIT, commandUtils.DESC_EXPORT_ON_EXIT)
-    .option(commandUtils.FLAG_UI, commandUtils.DESC_UI)
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action((script) => {
-    const localInstallCommand = `firebase ext:install ${process.cwd()}`;
-    const emulatorsExecCommand = `firebase emulators:exec '${script}`;
-    throw new error_1.FirebaseError("ext:dev:emulators:exec is no longer supported. " +
-        "Instead, navigate to a Firebase project directory and add this extension to the extensions manifest by running:\n" +
-        clc.bold(localInstallCommand) +
-        "\nThen, you can emulate this extension as part of that project by running:\n" +
-        clc.bold(emulatorsExecCommand));
-});

package/lib/commands/ext-dev-emulators-start.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const clc = require("colorette");
-const command_1 = require("../command");
-const commandUtils = require("../emulator/commandUtils");
-const error_1 = require("../error");
-exports.command = new command_1.Command("ext:dev:emulators:start")
-    .description("deprecated: please use `firebase emulators:start`")
-    .before(commandUtils.setExportOnExitOptions)
-    .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
-    .option(commandUtils.FLAG_TEST_CONFIG, commandUtils.DESC_TEST_CONFIG)
-    .option(commandUtils.FLAG_TEST_PARAMS, commandUtils.DESC_TEST_PARAMS)
-    .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)
-    .option(commandUtils.FLAG_EXPORT_ON_EXIT, commandUtils.DESC_EXPORT_ON_EXIT)
-    .action(() => {
-    const localInstallCommand = `firebase ext:install ${process.cwd()}`;
-    const emulatorsStartCommand = "firebase emulators:start";
-    throw new error_1.FirebaseError("ext:dev:emulators:start is no longer supported. " +
-        "Instead, navigate to a Firebase project directory and add this extension to the extensions manifest by running:\n" +
-        clc.bold(localInstallCommand) +
-        "\nThen, you can emulate this extension as part of that project by running:\n" +
-        clc.bold(emulatorsStartCommand));
-});

package/lib/commands/ext-dev-extension-delete.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const utils = require("../utils");
-const clc = require("colorette");
-const command_1 = require("../command");
-const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const extensionsApi_1 = require("../extensions/extensionsApi");
-const refs = require("../extensions/refs");
-const prompt_1 = require("../prompt");
-const requireAuth_1 = require("../requireAuth");
-const error_1 = require("../error");
-const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
-exports.command = new command_1.Command("ext:dev:delete <extensionRef>")
-    .description("delete an extension")
-    .help("use this command to delete an extension, and make it unavailable for developers to install or reconfigure. " +
-    "Specify the extension you want to delete using the format '<publisherId>/<extensionId>.")
-    .before(requireAuth_1.requireAuth)
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (extensionRef) => {
-    const { publisherId, extensionId, version } = refs.parse(extensionRef);
-    if (version) {
-        throw new error_1.FirebaseError(`Deleting a single version is not currently supported. You can only delete ${clc.bold("ALL versions")} of an extension. To delete all versions, please remove the version from the reference.`);
-    }
-    utils.logLabeledWarning(extensionsHelper_1.logPrefix, "If you delete this extension, developers won't be able to install it. " +
-        "For developers who currently have this extension installed, " +
-        "it will continue to run and will appear as unpublished when " +
-        "listed in the Firebase console or Firebase CLI.");
-    utils.logLabeledWarning("This is a permanent action", `Once deleted, you may never use the extension name '${clc.bold(extensionId)}' again.`);
-    await (0, extensionsApi_1.getExtension)(extensionRef);
-    const consent = await confirmDelete(publisherId, extensionId);
-    if (!consent) {
-        throw new error_1.FirebaseError("deletion cancelled.");
-    }
-    await (0, extensionsApi_1.deleteExtension)(extensionRef);
-    utils.logLabeledSuccess(extensionsHelper_1.logPrefix, "successfully deleted all versions of this extension.");
-});
-async function confirmDelete(publisherId, extensionId) {
-    const message = `You are about to delete ALL versions of ${clc.green(`${publisherId}/${extensionId}`)}.\nDo you wish to continue? `;
-    return (0, prompt_1.promptOnce)({
-        type: "confirm",
-        message,
-        default: false,
-    });
-}

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

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const command_1 = require("../command");
-const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const extensionsApi_1 = require("../extensions/extensionsApi");
-const utils = require("../utils");
-const refs = require("../extensions/refs");
-const prompt_1 = require("../prompt");
-const clc = require("colorette");
-const requireAuth_1 = require("../requireAuth");
-const error_1 = require("../error");
-const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
-exports.command = new command_1.Command("ext:dev:unpublish <extensionRef>")
-    .description("unpublish an extension")
-    .withForce()
-    .help("use this command to unpublish an extension, and make it unavailable for developers to install or reconfigure. " +
-    "Specify the extension you want to unpublish using the format '<publisherId>/<extensionId>.")
-    .before(requireAuth_1.requireAuth)
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (extensionRef, options) => {
-    const { publisherId, extensionId, version } = refs.parse(extensionRef);
-    utils.logLabeledWarning(extensionsHelper_1.logPrefix, "If you unpublish this extension, developers won't be able to install it. For developers who currently have this extension installed, it will continue to run and will appear as unpublished when listed in the Firebase console or Firebase CLI.");
-    utils.logLabeledWarning("This is a permanent action", `Once unpublished, you may never use the extension name '${clc.bold(extensionId)}' again.`);
-    if (version) {
-        throw new error_1.FirebaseError(`Unpublishing a single version is not currently supported. You can only unpublish ${clc.bold("ALL versions")} of an extension. To unpublish all versions, please remove the version from the reference.`);
-    }
-    await (0, extensionsApi_1.getExtension)(extensionRef);
-    const consent = await comfirmUnpublish(publisherId, extensionId, options);
-    if (!consent) {
-        throw new error_1.FirebaseError("unpublishing cancelled.");
-    }
-    await (0, extensionsApi_1.unpublishExtension)(extensionRef);
-    utils.logLabeledSuccess(extensionsHelper_1.logPrefix, "successfully unpublished all versions of this extension.");
-});
-async function comfirmUnpublish(publisherId, extensionId, options) {
-    if (options.nonInteractive && !options.force) {
-        throw new error_1.FirebaseError("Pass the --force flag to use this command in non-interactive mode");
-    }
-    if (options.nonInteractive && options.force) {
-        return true;
-    }
-    const message = `You are about to unpublish ALL versions of ${clc.green(`${publisherId}/${extensionId}`)}.\nDo you wish to continue? `;
-    return (0, prompt_1.promptOnce)({
-        type: "confirm",
-        message,
-        default: false,
-    });
-}

package/lib/commands/ext-sources-create.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
-const command_1 = require("../command");
-const projectUtils_1 = require("../projectUtils");
-const logger_1 = require("../logger");
-const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const requirePermissions_1 = require("../requirePermissions");
-exports.command = new command_1.Command("ext:sources:create <sourceLocation>")
-    .description(`create a extension source from sourceLocation`)
-    .help("sourceLocation can be a local directory containing an extension, or URL pointing to a zipped extension. " +
-    'If using a URL, you can specify a root folder for the extension by adding "#<extensionRoot>". ' +
-    "For example, if your extension.yaml is in the my/extension directory of the archive, " +
-    "you should use sourceUrl#my/extension. If no extensionRoot is specified, / is assumed.")
-    .before(requirePermissions_1.requirePermissions, ["firebaseextensions.sources.create"])
-    .before(extensionsHelper_1.ensureExtensionsApiEnabled)
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (sourceLocation, options) => {
-    const projectId = (0, projectUtils_1.needProjectId)(options);
-    const res = await (0, extensionsHelper_1.createSourceFromLocation)(projectId, sourceLocation);
-    logger_1.logger.info(`Extension source creation successful for ${res.spec.name}! Your new source is ${res.name}`);
-    return res;
-});

package/lib/extensions/askUserForConsent.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptForPublisherTOS = void 0;
-const marked_1 = require("marked");
-const TerminalRenderer = require("marked-terminal");
-const error_1 = require("../error");
-const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const prompt_1 = require("../prompt");
-const utils = require("../utils");
-marked_1.marked.setOptions({
-    renderer: new TerminalRenderer(),
-});
-async function promptForPublisherTOS() {
-    const termsOfServiceMsg = "By registering as a publisher, you confirm that you have read the Firebase Extensions Publisher Terms and Conditions (linked below) and you, on behalf of yourself and the organization you represent, agree to comply with it.  Here is a brief summary of the highlights of our terms and conditions:\n" +
-        "  - You ensure extensions you publish comply with all laws and regulations; do not include any viruses, spyware, Trojan horses, or other malicious code; and do not violate any person’s rights, including intellectual property, privacy, and security rights.\n" +
-        "  - You will not engage in any activity that interferes with or accesses in an unauthorized manner the properties or services of Google, Google’s affiliates, or any third party.\n" +
-        "  - If you become aware or should be aware of a critical security issue in your extension, you will provide either a resolution or a written resolution plan within 48 hours.\n" +
-        "  - If Google requests a critical security matter to be patched for your extension, you will respond to Google within 48 hours with either a resolution or a written resolution plan.\n" +
-        "  - Google may remove your extension or terminate the agreement, if you violate any terms.";
-    utils.logLabeledBullet(extensionsHelper_1.logPrefix, (0, marked_1.marked)(termsOfServiceMsg));
-    const consented = await (0, prompt_1.promptOnce)({
-        name: "consent",
-        type: "confirm",
-        message: (0, marked_1.marked)("Do you accept the [Firebase Extensions Publisher Terms and Conditions](https://firebase.google.com/docs/extensions/alpha/terms-of-service) and acknowledge that your information will be used in accordance with [Google's Privacy Policy](https://policies.google.com/privacy?hl=en)?"),
-        default: false,
-    });
-    if (!consented) {
-        throw new error_1.FirebaseError("You must agree to the terms of service to register a publisher ID.", {
-            exit: 1,
-        });
-    }
-}
-exports.promptForPublisherTOS = promptForPublisherTOS;