firebase-functions 5.1.0 → 6.0.0

package/README.md

@@ -23,12 +23,13 @@ _Please avoid double posting across multiple channels!_
 
 ```js
 // functions/index.js
-const functions = require("firebase-functions");
+const { onValueCreated } = require("firebase-functions/database");
+const logger = require("firebase-functions/logger");
 const notifyUsers = require("./notify-users");
 
-exports.newPost = functions.database.ref("/posts/{postId}").onCreate((snapshot, context) => {
-  functions.logger.info("Received new post with ID:", context.params.postId);
-  return notifyUsers(snapshot.val());
+exports.newPost = onValueCreated({ ref: "/posts/{postId}" }, (event) => {
+  logger.info("Received new post with ID:", event.params.postId);
+  return notifyUsers(event.data.val());
 });
 ```
 

package/lib/logger/index.js

@@ -63,6 +63,10 @@ function removeCircular(obj, refs = []) {
  * @public
  */
 function write(entry) {
+    const ctx = trace_1.traceContext.getStore();
+    if (ctx === null || ctx === void 0 ? void 0 : ctx.traceId) {
+        entry["logging.googleapis.com/trace"] = `projects/${process.env.GCLOUD_PROJECT}/traces/${ctx.traceId}`;
+    }
     common_1.UNPATCHED_CONSOLE[common_1.CONSOLE_SEVERITY[entry.severity]](JSON.stringify(removeCircular(entry)));
 }
 exports.write = write;
@@ -123,16 +127,12 @@ function entryFromArgs(severity, args) {
     if (lastArg && typeof lastArg === "object" && lastArg.constructor === Object) {
         entry = args.pop();
     }
-    const ctx = trace_1.traceContext.getStore();
     // mimic `console.*` behavior, see https://nodejs.org/api/console.html#console_console_log_data_args
     let message = (0, util_1.format)(...args);
     if (severity === "ERROR" && !args.find((arg) => arg instanceof Error)) {
         message = new Error(message).stack || message;
     }
     const out = {
-        "logging.googleapis.com/trace": (ctx === null || ctx === void 0 ? void 0 : ctx.traceId)
-            ? `projects/${process.env.GCLOUD_PROJECT}/traces/${ctx.traceId}`
-            : undefined,
         ...entry,
         severity,
     };

package/lib/params/index.d.ts

@@ -30,11 +30,10 @@ export declare const gcloudProject: Param<string>;
 export declare const storageBucket: Param<string>;
 /**
  * Declares a secret param, that will persist values only in Cloud Secret Manager.
- * Secrets are stored interally as bytestrings. Use `ParamOptions.as` to provide type
+ * Secrets are stored internally as bytestrings. Use `ParamOptions.as` to provide type
  * hinting during parameter resolution.
  *
  * @param name The name of the environment variable to use to load the parameter.
- * @param options Configuration options for the parameter.
  * @returns A parameter with a `string` return type for `.value`.
  */
 export declare function defineSecret(name: string): SecretParam;

package/lib/params/index.js

@@ -77,11 +77,10 @@ exports.gcloudProject = new types_1.InternalExpression("GCLOUD_PROJECT", (env) =
 exports.storageBucket = new types_1.InternalExpression("STORAGE_BUCKET", (env) => { var _a; return ((_a = JSON.parse(env.FIREBASE_CONFIG)) === null || _a === void 0 ? void 0 : _a.storageBucket) || ""; });
 /**
  * Declares a secret param, that will persist values only in Cloud Secret Manager.
- * Secrets are stored interally as bytestrings. Use `ParamOptions.as` to provide type
+ * Secrets are stored internally as bytestrings. Use `ParamOptions.as` to provide type
  * hinting during parameter resolution.
  *
  * @param name The name of the environment variable to use to load the parameter.
- * @param options Configuration options for the parameter.
  * @returns A parameter with a `string` return type for `.value`.
  */
 function defineSecret(name) {

package/lib/params/types.d.ts

@@ -33,7 +33,7 @@ export declare class CompareExpression<T extends string | number | boolean | str
 type ParamValueType = "string" | "list" | "boolean" | "int" | "float" | "secret";
 /** Create a select input from a series of values. */
 export declare function select<T>(options: T[]): SelectInput<T>;
-/** Create a select input from a map of labels to vaues. */
+/** Create a select input from a map of labels to values. */
 export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
 /** Create a multi-select input from a series of values. */
 export declare function multiSelect(options: string[]): MultiSelectInput;

package/lib/v1/config.d.ts

@@ -3,6 +3,8 @@ export { firebaseConfig } from "../common/config";
  * Store and retrieve project configuration data such as third-party API
  * keys or other settings. You can set configuration values using the
  * Firebase CLI as described in
- * [Environment Configuration](/docs/functions/config-env).
+ * https://firebase.google.com/docs/functions/config-env.
+ *
+ * @deprecated Using functions.config() is discouraged. See https://firebase.google.com/docs/functions/config-env.
  */
 export declare function config(): Record<string, any>;

package/lib/v1/config.js

@@ -35,7 +35,9 @@ exports.resetCache = resetCache;
  * Store and retrieve project configuration data such as third-party API
  * keys or other settings. You can set configuration values using the
  * Firebase CLI as described in
- * [Environment Configuration](/docs/functions/config-env).
+ * https://firebase.google.com/docs/functions/config-env.
+ *
+ * @deprecated Using functions.config() is discouraged. See https://firebase.google.com/docs/functions/config-env.
  */
 function config() {
     // K_CONFIGURATION is only set in GCFv2

package/lib/v2/index.d.ts

@@ -24,3 +24,4 @@ export { CloudFunction, CloudEvent, ParamsOf, onInit } from "./core";
 export { Change } from "../common/change";
 import * as params from "../params";
 export { params };
+export { config } from "../v1/config";

package/lib/v2/index.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.params = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
+exports.config = exports.params = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
 /**
  * The 2nd gen API for Cloud Functions for Firebase.
  * This SDK supports deep imports. For example, the namespace
@@ -64,3 +64,7 @@ Object.defineProperty(exports, "Change", { enumerable: true, get: function () {
 // NOTE: Equivalent to `export * as params from "../params"` but api-extractor doesn't support that syntax.
 const params = require("../params");
 exports.params = params;
+// NOTE: Required to support the Functions Emulator which monkey patches `functions.config()`
+// TODO(danielylee): Remove in next major release.
+var config_1 = require("../v1/config");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });

package/lib/v2/options.d.ts

@@ -43,7 +43,7 @@ export interface GlobalOptions {
      * The minimum timeout for a 2nd gen function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes).
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

package/lib/v2/providers/alerts/alerts.js

@@ -43,6 +43,7 @@ exports.onAlertPublished = onAlertPublished;
  * @internal
  */
 function getEndpointAnnotation(opts, alertType, appId) {
+    var _a;
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     const specificOpts = options.optionsToEndpoint(opts);
     const endpoint = {
@@ -59,7 +60,7 @@ function getEndpointAnnotation(opts, alertType, appId) {
             eventFilters: {
                 alerttype: alertType,
             },
-            retry: !!opts.retry,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     if (appId) {

package/lib/v2/providers/database.js

@@ -143,6 +143,7 @@ function makeChangedDatabaseEvent(event, instance, params) {
 }
 /** @internal */
 function makeEndpoint(eventType, opts, path, instance) {
+    var _a;
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     const specificOpts = options.optionsToEndpoint(opts);
     const eventFilters = {};
@@ -166,7 +167,7 @@ function makeEndpoint(eventType, opts, path, instance) {
             eventType,
             eventFilters,
             eventFilterPathPatterns,
-            retry: false,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
 }

package/lib/v2/providers/eventarc.js

@@ -32,7 +32,7 @@ const trace_1 = require("../trace");
 const options = require("../options");
 const onInit_1 = require("../../common/onInit");
 function onCustomEventPublished(eventTypeOrOpts, handler) {
-    var _a;
+    var _a, _b;
     let opts;
     if (typeof eventTypeOrOpts === "string") {
         opts = {
@@ -61,7 +61,7 @@ function onCustomEventPublished(eventTypeOrOpts, handler) {
         eventTrigger: {
             eventType: opts.eventType,
             eventFilters: {},
-            retry: false,
+            retry: (_b = opts.retry) !== null && _b !== void 0 ? _b : false,
             channel,
         },
     };

package/lib/v2/providers/firestore.js

@@ -256,6 +256,7 @@ function makeChangedFirestoreEvent(event, params) {
 exports.makeChangedFirestoreEvent = makeChangedFirestoreEvent;
 /** @internal */
 function makeEndpoint(eventType, opts, document, database, namespace) {
+    var _a;
     const baseOpts = (0, options_1.optionsToEndpoint)((0, options_1.getGlobalOptions)());
     const specificOpts = (0, options_1.optionsToEndpoint)(opts);
     const eventFilters = {
@@ -283,7 +284,7 @@ function makeEndpoint(eventType, opts, document, database, namespace) {
             eventType,
             eventFilters,
             eventFilterPathPatterns,
-            retry: !!opts.retry,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
 }

package/lib/v2/providers/https.d.ts

@@ -10,7 +10,7 @@ export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
 /**
  * Options that can be set on an onRequest HTTPS function.
  */
-export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
+export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceAppCheck"> {
     /**
      * If true, do not deploy or emulate this function.
      */

package/lib/v2/providers/https.js

@@ -128,7 +128,7 @@ function onCall(optsOrHandler, handler) {
     // on the origin header of the request. If there is only one element in the
     // array, this is unnecessary.
     if (Array.isArray(origin) && origin.length === 1) {
-        origin = origin[1];
+        origin = origin[0];
     }
     // onCallHandler sniffs the function length to determine which API to present.
     // fix the length to prevent api versions from being mismatched.

package/lib/v2/providers/pubsub.js

@@ -112,6 +112,7 @@ exports.Message = Message;
  * @typeParam T - Type representing `Message.data`'s JSON format
  */
 function onMessagePublished(topicOrOptions, handler) {
+    var _a;
     let topic;
     let opts;
     if (typeof topicOrOptions === "string") {
@@ -162,7 +163,7 @@ function onMessagePublished(topicOrOptions, handler) {
         eventTrigger: {
             eventType: "google.cloud.pubsub.topic.v1.messagePublished",
             eventFilters: { topic },
-            retry: false,
+            retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, "retry", "retry");

package/lib/v2/providers/remoteConfig.js

@@ -36,6 +36,7 @@ exports.eventType = "google.firebase.remoteconfig.remoteConfig.v1.updated";
  * @returns A function that you can export and deploy.
  */
 function onConfigUpdated(optsOrHandler, handler) {
+    var _a;
     if (typeof optsOrHandler === "function") {
         handler = optsOrHandler;
         optsOrHandler = {};
@@ -58,7 +59,7 @@ function onConfigUpdated(optsOrHandler, handler) {
         eventTrigger: {
             eventType: exports.eventType,
             eventFilters: {},
-            retry: !!optsOrHandler.retry,
+            retry: (_a = optsOrHandler.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     func.__endpoint = ep;

package/lib/v2/providers/storage.js

@@ -133,6 +133,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
     // To prevent runtime errors when FIREBASE_CONFIG env var is missing, we use getters.
     Object.defineProperty(func, "__endpoint", {
         get: () => {
+            var _a;
             const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
             const specificOpts = options.optionsToEndpoint(opts);
             const endpoint = {
@@ -147,7 +148,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
                 eventTrigger: {
                     eventType,
                     eventFilters: { bucket },
-                    retry: false,
+                    retry: (_a = opts.retry) !== null && _a !== void 0 ? _a : false,
                 },
             };
             (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, "retry", "retry");

package/lib/v2/providers/tasks.js

@@ -86,6 +86,7 @@ function onTaskDispatched(optsOrHandler, handler) {
     (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.rateLimits, opts.rateLimits, "maxConcurrentDispatches", "maxDispatchesPerSecond");
     (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, options.getGlobalOptions(), "invoker", "invoker", encoding_1.convertInvoker);
     (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, opts, "invoker", "invoker", encoding_1.convertInvoker);
+    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, "retry", "retry");
     func.__requiredAPIs = [
         {
             api: "cloudtasks.googleapis.com",

package/lib/v2/providers/testLab.js

@@ -37,6 +37,7 @@ exports.eventType = "google.firebase.testlab.testMatrix.v1.completed";
  * @alpha
  */
 function onTestMatrixCompleted(optsOrHandler, handler) {
+    var _a;
     if (typeof optsOrHandler === "function") {
         handler = optsOrHandler;
         optsOrHandler = {};
@@ -59,7 +60,7 @@ function onTestMatrixCompleted(optsOrHandler, handler) {
         eventTrigger: {
             eventType: exports.eventType,
             eventFilters: {},
-            retry: !!optsOrHandler.retry,
+            retry: (_a = optsOrHandler.retry) !== null && _a !== void 0 ? _a : false,
         },
     };
     func.__endpoint = ep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "5.1.0",
+  "version": "6.0.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -22,13 +22,12 @@
     "lib",
     "protos"
   ],
-  "main": "lib/v1/index.js",
+  "main": "lib/v2/index.js",
   "bin": {
     "firebase-functions": "./lib/bin/firebase-functions.js"
   },
-  "types": "lib/v1/index.d.ts",
+  "types": "lib/v2/index.d.ts",
   "exports": {
-    ".": "./lib/v1/index.js",
     "./logger/compat": "./lib/logger/compat.js",
     "./logger": "./lib/logger/index.js",
     "./params": "./lib/params/index.js",
@@ -43,6 +42,25 @@
     "./v1/storage": "./lib/v1/providers/storage.js",
     "./v1/tasks": "./lib/v1/providers/tasks.js",
     "./v1/testLab": "./lib/v1/providers/testLab.js",
+    ".": "./lib/v2/index.js",
+    "./core": "./lib/v2/core.js",
+    "./options": "./lib/v2/options.js",
+    "./https": "./lib/v2/providers/https.js",
+    "./pubsub": "./lib/v2/providers/pubsub.js",
+    "./storage": "./lib/v2/providers/storage.js",
+    "./tasks": "./lib/v2/providers/tasks.js",
+    "./alerts": "./lib/v2/providers/alerts/index.js",
+    "./alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js",
+    "./alerts/billing": "./lib/v2/providers/alerts/billing.js",
+    "./alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
+    "./alerts/performance": "./lib/v2/providers/alerts/performance.js",
+    "./eventarc": "./lib/v2/providers/eventarc.js",
+    "./identity": "./lib/v2/providers/identity.js",
+    "./database": "./lib/v2/providers/database.js",
+    "./scheduler": "./lib/v2/providers/scheduler.js",
+    "./remoteConfig": "./lib/v2/providers/remoteConfig.js",
+    "./testLab": "./lib/v2/providers/testLab.js",
+    "./firestore": "./lib/v2/providers/firestore.js",
     "./v2": "./lib/v2/index.js",
     "./v2/core": "./lib/v2/core.js",
     "./v2/options": "./lib/v2/options.js",
@@ -107,6 +125,60 @@
       "v1/testLab": [
         "lib/v1/providers/testLab"
       ],
+      "core": [
+        "./lib/v2/core"
+      ],
+      "options": [
+        "./lib/v2/options"
+      ],
+      "https": [
+        "./lib/v2/providers/https"
+      ],
+      "pubsub": [
+        "./lib/v2/providers/pubsub"
+      ],
+      "storage": [
+        "./lib/v2/providers/storage"
+      ],
+      "tasks": [
+        "./lib/v2/providers/tasks"
+      ],
+      "alerts": [
+        "./lib/v2/providers/alerts/index"
+      ],
+      "alerts/appDistribution": [
+        "./lib/v2/providers/alerts/appDistribution"
+      ],
+      "alerts/billing": [
+        "./lib/v2/providers/alerts/billing"
+      ],
+      "alerts/crashlytics": [
+        "./lib/v2/providers/alerts/crashlytics"
+      ],
+      "alerts/performance": [
+        "./lib/v2/providers/alerts/performance"
+      ],
+      "eventarc": [
+        "./lib/v2/providers/eventarc"
+      ],
+      "identity": [
+        "./lib/v2/providers/identity"
+      ],
+      "database": [
+        "./lib/v2/providers/database"
+      ],
+      "scheduler": [
+        "./lib/v2/providers/scheduler"
+      ],
+      "remoteConfig": [
+        "./lib/v2/providers/remoteConfig"
+      ],
+      "testLab": [
+        "./lib/v2/providers/testLab"
+      ],
+      "firestore": [
+        "./lib/v2/providers/firestore"
+      ],
       "v2": [
         "lib/v2"
       ],
@@ -182,7 +254,7 @@
     "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown --project functions && npm run docgen:v2:toc",
     "docgen:v2": "npm run build && npm run docgen:v2:extract && npm run docgen:v2:gen",
     "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack",
-    "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json",
+    "build:release": "npm ci --production && npm install --no-save typescript && tsc -p tsconfig.release.json",
     "build": "tsc -p tsconfig.release.json",
     "build:watch": "npm run build -- -w",
     "format": "npm run format:ts && npm run format:other",