firebase-functions 3.23.0 → 3.24.0

package/lib/runtime/manifest.js

@@ -30,8 +30,8 @@ const params_1 = require("../v2/params");
  * @internal
  */
 function stackToWire(stack) {
-    let wireStack = stack;
-    let traverse = function traverse(obj) {
+    const wireStack = stack;
+    const traverse = function traverse(obj) {
         for (const [key, val] of Object.entries(obj)) {
             if (val instanceof params_1.Expression) {
                 obj[key] = val.toCEL();

package/lib/v2/params/index.d.ts

@@ -2,7 +2,7 @@
  * @hidden
  * @alpha
  */
-import { BooleanParam, FloatParam, IntParam, ListParam, Param, ParamOptions, StringParam, SecretParam, Expression } from './types';
+import { BooleanParam, Expression, FloatParam, IntParam, ListParam, Param, ParamOptions, SecretParam, StringParam } from './types';
 export { ParamOptions, Expression };
 declare type SecretOrExpr = Param<any> | SecretParam;
 export declare const declaredParams: SecretOrExpr[];

package/lib/v2/params/types.d.ts

@@ -67,14 +67,14 @@ export interface SelectOptions<T = unknown> {
     label?: string;
     value: T;
 }
-export declare type ParamSpec<T = unknown> = {
+export interface ParamSpec<T = unknown> {
     name: string;
     default?: T;
     label?: string;
     description?: string;
     type: ParamValueType;
     input?: ParamInput<T>;
-};
+}
 export declare type ParamOptions<T = unknown> = Omit<ParamSpec<T>, 'name' | 'type'>;
 export declare abstract class Param<T extends string | number | boolean | string[]> extends Expression<T> {
     readonly name: string;
@@ -88,8 +88,8 @@ export declare abstract class Param<T extends string | number | boolean | string
     toSpec(): ParamSpec<T>;
 }
 export declare class SecretParam {
-    name: string;
     static type: ParamValueType;
+    name: string;
     constructor(name: string);
     value(): string;
     toSpec(): ParamSpec<string>;

package/lib/v2/params/types.js

@@ -42,7 +42,7 @@ class Expression {
 }
 exports.Expression = Expression;
 function quoteIfString(literal) {
-    //TODO(vsfan@): CEL's string escape semantics are slightly different than Javascript's, what do we do here?
+    // TODO(vsfan@): CEL's string escape semantics are slightly different than Javascript's, what do we do here?
     return typeof literal === 'string' ? `"${literal}"` : literal;
 }
 /**

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

@@ -29,7 +29,7 @@ export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
     data: FirebaseAlertData<T>;
 }
 /** The underlying alert type of the Firebase Alerts provider. */
-export declare type AlertType = 'crashlytics.newFatalIssue' | 'crashlytics.newNonfatalIssue' | 'crashlytics.regression' | 'crashlytics.stabilityDigest' | 'crashlytics.velocity' | 'crashlytics.newAnrIssue' | 'billing.planUpdate' | 'billing.automatedPlanUpdate' | 'appDistribution.newTesterIosDevice' | 'appDistribution.inAppFeedback' | string;
+export declare type AlertType = 'crashlytics.newFatalIssue' | 'crashlytics.newNonfatalIssue' | 'crashlytics.regression' | 'crashlytics.stabilityDigest' | 'crashlytics.velocity' | 'crashlytics.newAnrIssue' | 'billing.planUpdate' | 'billing.automatedPlanUpdate' | 'appDistribution.newTesterIosDevice' | 'appDistribution.inAppFeedback' | 'performance.threshold' | string;
 /**
  * Configuration for Firebase Alert functions.
  */

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

@@ -21,14 +21,14 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOptsAndAlertTypeAndApp = exports.getEndpointAnnotation = exports.onAlertPublished = exports.eventType = void 0;
+exports.convertAlertAndApp = exports.getOptsAndAlertTypeAndApp = exports.getEndpointAnnotation = exports.onAlertPublished = exports.eventType = void 0;
 const options = require("../../options");
 /** @internal */
 exports.eventType = 'google.firebase.firebasealerts.alerts.v1.published';
 function onAlertPublished(alertTypeOrOpts, handler) {
     const [opts, alertType, appId] = getOptsAndAlertTypeAndApp(alertTypeOrOpts);
     const func = (raw) => {
-        return handler(raw);
+        return handler(convertAlertAndApp(raw));
     };
     func.run = handler;
     func.__endpoint = getEndpointAnnotation(opts, alertType, appId);
@@ -86,3 +86,18 @@ function getOptsAndAlertTypeAndApp(alertTypeOrOpts) {
     return [opts, alertType, appId];
 }
 exports.getOptsAndAlertTypeAndApp = getOptsAndAlertTypeAndApp;
+/**
+ * Helper function to covert alert type & app id in the CloudEvent to camel case.
+ * @internal
+ */
+function convertAlertAndApp(raw) {
+    const event = { ...raw };
+    if ('alerttype' in event) {
+        event.alertType = event.alerttype;
+    }
+    if ('appid' in event) {
+        event.appId = event.appid;
+    }
+    return event;
+}
+exports.convertAlertAndApp = convertAlertAndApp;

package/lib/v2/providers/alerts/appDistribution.d.ts

@@ -4,8 +4,8 @@
  */
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
-import { FirebaseAlertData } from './alerts';
 import { Expression } from '../../params';
+import { FirebaseAlertData } from './alerts';
 /**
  * The internal payload object for adding a new tester device to app distribution.
  * Payload is wrapped inside a `FirebaseAlertData` object.

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

@@ -40,7 +40,7 @@ function onNewTesterIosDevicePublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return handler(raw);
+        return handler((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.newTesterIosDeviceAlert, appId);
@@ -60,7 +60,7 @@ function onInAppFeedbackPublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return handler(raw);
+        return handler((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.inAppFeedbackAlert, appId);

package/lib/v2/providers/alerts/billing.d.ts

@@ -2,9 +2,9 @@
  * Cloud functions to handle billing events from Firebase Alerts.
  * @packageDocumentation
  */
-import { FirebaseAlertData } from '.';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
+import { FirebaseAlertData } from './alerts';
 /**
  * The internal payload object for billing plan updates.
  * Payload is wrapped inside a `FirebaseAlertData` object.

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

@@ -22,11 +22,7 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onOperation = exports.onPlanAutomatedUpdatePublished = exports.onPlanUpdatePublished = exports.planAutomatedUpdateAlert = exports.planUpdateAlert = void 0;
-/**
- * Cloud functions to handle billing events from Firebase Alerts.
- * @packageDocumentation
- */
-const _1 = require(".");
+const alerts_1 = require("./alerts");
 /** @internal */
 exports.planUpdateAlert = 'billing.planUpdate';
 /** @internal */
@@ -58,10 +54,10 @@ function onOperation(alertType, optsOrHandler, handler) {
         optsOrHandler = {};
     }
     const func = (raw) => {
-        return handler(raw);
+        return handler((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
-    func.__endpoint = (0, _1.getEndpointAnnotation)(optsOrHandler, alertType);
+    func.__endpoint = (0, alerts_1.getEndpointAnnotation)(optsOrHandler, alertType);
     return func;
 }
 exports.onOperation = onOperation;

package/lib/v2/providers/alerts/crashlytics.d.ts

@@ -2,10 +2,10 @@
  * Cloud functions to handle Crashlytics events from Firebase Alerts.
  * @packageDocumentation
  */
-import { FirebaseAlertData } from '.';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
 import { Expression } from '../../params';
+import { FirebaseAlertData } from './alerts';
 /** Generic Crashlytics issue interface */
 export interface Issue {
     /** The ID of the Crashlytics issue */

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

@@ -22,11 +22,7 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOptsAndApp = exports.onOperation = exports.onNewAnrIssuePublished = exports.onVelocityAlertPublished = exports.onStabilityDigestPublished = exports.onRegressionAlertPublished = exports.onNewNonfatalIssuePublished = exports.onNewFatalIssuePublished = exports.newAnrIssueAlert = exports.velocityAlert = exports.stabilityDigestAlert = exports.regressionAlert = exports.newNonfatalIssueAlert = exports.newFatalIssueAlert = void 0;
-/**
- * Cloud functions to handle Crashlytics events from Firebase Alerts.
- * @packageDocumentation
- */
-const _1 = require(".");
+const alerts_1 = require("./alerts");
 /** @internal */
 exports.newFatalIssueAlert = 'crashlytics.newFatalIssue';
 /** @internal */
@@ -107,10 +103,10 @@ function onOperation(alertType, appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return handler(raw);
+        return handler((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
-    func.__endpoint = (0, _1.getEndpointAnnotation)(opts, alertType, appId);
+    func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, alertType, appId);
     return func;
 }
 exports.onOperation = onOperation;

package/lib/v2/providers/alerts/index.d.ts

@@ -7,5 +7,6 @@
 import * as appDistribution from './appDistribution';
 import * as billing from './billing';
 import * as crashlytics from './crashlytics';
-export { appDistribution, billing, crashlytics };
+import * as performance from './performance';
+export { appDistribution, billing, crashlytics, performance };
 export * from './alerts';

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

@@ -35,7 +35,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.crashlytics = exports.billing = exports.appDistribution = void 0;
+exports.performance = exports.crashlytics = exports.billing = exports.appDistribution = void 0;
 /**
  * Cloud functions to handle events from Firebase Alerts.
  * Subpackages give stronger typing to specific services which
@@ -48,4 +48,6 @@ const billing = require("./billing");
 exports.billing = billing;
 const crashlytics = require("./crashlytics");
 exports.crashlytics = crashlytics;
+const performance = require("./performance");
+exports.performance = performance;
 __exportStar(require("./alerts"), exports);

package/lib/v2/providers/alerts/performance.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Cloud functions to handle Firebase Performance Monitoring events from Firebase Alerts.
+ * @packageDocumentation
+ */
+import { CloudEvent, CloudFunction } from '../../core';
+import { EventHandlerOptions } from '../../options';
+import { FirebaseAlertData } from './alerts';
+/**
+ * The internal payload object for a performance threshold alert.
+ * Payload is wrapped inside a {@link FirebaseAlertData} object.
+ */
+export interface ThresholdAlertPayload {
+    eventName: string;
+    eventType: string;
+    metricType: string;
+    numSamples: number;
+    thresholdValue: number;
+    thresholdUnit: string;
+    conditionPercentile?: number;
+    appVersion?: string;
+    violationValue: number;
+    violationUnit: string;
+    investigateUri: string;
+}
+/**
+ * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
+ * @typeParam T - the data type for performance alerts that is wrapped in a `FirebaseAlertData` object.
+ */
+export interface PerformanceEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
+    /** The type of the alerts that got triggered. */
+    alertType: string;
+    /** The Firebase App ID that’s associated with the alert. */
+    appId: string;
+}
+/**
+ * Configuration for app distribution functions.
+ */
+export interface PerformanceOptions extends EventHandlerOptions {
+    appId?: string;
+}
+/**
+ * Declares a function that can handle receiving performance threshold alerts.
+ * @param handler - Event handler which is run every time a threshold alert is received.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onThresholdAlertPublished(handler: (event: PerformanceEvent<ThresholdAlertPayload>) => any | Promise<any>): CloudFunction<PerformanceEvent<ThresholdAlertPayload>>;
+/**
+ * Declares a function that can handle receiving performance threshold alerts.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler which is run every time a threshold alert is received.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onThresholdAlertPublished(appId: string, handler: (event: PerformanceEvent<ThresholdAlertPayload>) => any | Promise<any>): CloudFunction<PerformanceEvent<ThresholdAlertPayload>>;
+/**
+ * Declares a function that can handle receiving performance threshold alerts.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler which is run every time a threshold alert is received.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onThresholdAlertPublished(opts: PerformanceOptions, handler: (event: PerformanceEvent<ThresholdAlertPayload>) => any | Promise<any>): CloudFunction<PerformanceEvent<ThresholdAlertPayload>>;

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

@@ -0,0 +1,81 @@
+"use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertPayload = exports.getOptsAndApp = exports.onThresholdAlertPublished = exports.thresholdAlert = void 0;
+const alerts_1 = require("./alerts");
+/** @internal */
+exports.thresholdAlert = 'performance.threshold';
+/**
+ * Declares a function that can handle receiving performance threshold alerts.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler which is run every time a threshold alert is received.
+ * @returns A function that you can export and deploy.
+ */
+function onThresholdAlertPublished(appIdOrOptsOrHandler, handler) {
+    if (typeof appIdOrOptsOrHandler === 'function') {
+        handler = appIdOrOptsOrHandler;
+        appIdOrOptsOrHandler = {};
+    }
+    const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
+    const func = (raw) => {
+        const event = (0, alerts_1.convertAlertAndApp)(raw);
+        const convertedPayload = convertPayload(event.data.payload);
+        event.data.payload = convertedPayload;
+        return handler(event);
+    };
+    func.run = handler;
+    func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.thresholdAlert, appId);
+    return func;
+}
+exports.onThresholdAlertPublished = onThresholdAlertPublished;
+/**
+ * Helper function to parse the function opts and appId.
+ * @internal
+ */
+function getOptsAndApp(appIdOrOpts) {
+    if (typeof appIdOrOpts === 'string') {
+        return [{}, appIdOrOpts];
+    }
+    const opts = { ...appIdOrOpts };
+    const appId = appIdOrOpts.appId;
+    delete opts.appId;
+    return [opts, appId];
+}
+exports.getOptsAndApp = getOptsAndApp;
+/**
+ * Helper function to convert the raw payload of a {@link PerformanceEvent} to a {@link ThresholdAlertPayload}
+ * @internal
+ */
+function convertPayload(raw) {
+    const payload = { ...raw };
+    if (typeof payload.conditionPercentile !== 'undefined' &&
+        payload.conditionPercentile === 0) {
+        delete payload.conditionPercentile;
+    }
+    if (typeof payload.appVersion !== 'undefined' &&
+        payload.appVersion.length === 0) {
+        delete payload.appVersion;
+    }
+    return payload;
+}
+exports.convertPayload = convertPayload;

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

@@ -1,7 +1,7 @@
 import { AuthData, RateLimits, Request, RetryConfig } from '../../common/providers/tasks';
 import * as options from '../options';
-import { HttpsFunction } from './https';
 import { Expression } from '../params';
+import { HttpsFunction } from './https';
 export { AuthData, Request };
 export interface TaskQueueOptions extends options.EventHandlerOptions {
     /** How a task should be retried in the event of a non-2xx return. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.23.0",
+  "version": "3.24.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -64,6 +64,7 @@
     "./v2/alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js",
     "./v2/alerts/billing": "./lib/v2/providers/alerts/billing.js",
     "./v2/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
+    "./v2/alerts/performance": "./lib/v2/providers/alerts/performance.js",
     "./v2/eventarc": "./lib/v2/providers/eventarc.js",
     "./v2/identity": "./lib/v2/providers/identity.js",
     "./v2/database": "./lib/v2/providers/database.js",
@@ -125,6 +126,9 @@
       "v2/alerts/crashlytics": [
         "lib/v2/providers/alerts/crashlytics"
       ],
+      "v2/alerts/performance": [
+        "lib/v2/providers/alerts/performance"
+      ],
       "v2/base": [
         "lib/v2/base"
       ],