firebase-functions 3.24.0 → 3.24.1

package/lib/runtime/manifest.js

@@ -36,7 +36,7 @@ function stackToWire(stack) {
             if (val instanceof params_1.Expression) {
                 obj[key] = val.toCEL();
             }
-            else if (typeof val === 'object') {
+            else if (typeof val === 'object' && val !== null) {
                 traverse(val);
             }
         }

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

@@ -24,6 +24,8 @@ export interface NewTesterDevicePayload {
 /**
  * The internal payload object for receiving in-app feedback from a tester.
  * Payload is wrapped inside a `FirebaseAlertData` object.
+ *
+ * @alpha
  */
 export interface InAppFeedbackPayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroInAppFeedbackPayload';
@@ -162,6 +164,8 @@ export declare function onNewTesterIosDevicePublished(opts: AppDistributionOptio
  * Declares a function that can handle receiving new in-app feedback from a tester.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
+ *
+ * @alpha
  */
 export declare function onInAppFeedbackPublished(handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
 /**
@@ -169,6 +173,8 @@ export declare function onInAppFeedbackPublished(handler: (event: AppDistributio
  * @param appId - A specific application the handler will trigger on.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
+ *
+ * @alpha
  */
 export declare function onInAppFeedbackPublished(appId: string, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
 /**
@@ -176,5 +182,7 @@ export declare function onInAppFeedbackPublished(appId: string, handler: (event:
  * @param opts - Options that can be set on the function.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
+ *
+ * @alpha
  */
 export declare function onInAppFeedbackPublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;

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

@@ -52,6 +52,8 @@ exports.onNewTesterIosDevicePublished = onNewTesterIosDevicePublished;
  * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
+ *
+ * @alpha
  */
 function onInAppFeedbackPublished(appIdOrOptsOrHandler, handler) {
     if (typeof appIdOrOptsOrHandler === 'function') {

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

@@ -10,16 +10,27 @@ import { FirebaseAlertData } from './alerts';
  * Payload is wrapped inside a {@link FirebaseAlertData} object.
  */
 export interface ThresholdAlertPayload {
+    /** Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */
     eventName: string;
+    /** The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */
     eventType: string;
+    /** The metric type this alert is for (i.e. success rate, response time, duration, etc.) */
     metricType: string;
+    /** The number of events checked for this alert condition */
     numSamples: number;
+    /** The threshold value of the alert condition without units (e.g. "75", "2.1") */
     thresholdValue: number;
+    /** The unit for the alert threshold (e.g. "percent", "seconds") */
     thresholdUnit: string;
+    /** The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */
     conditionPercentile?: number;
+    /** The app version this alert was triggered for, can be omitted if the alert is for a network request (because the alert was checked against data from all versions of app) or a web app (where the app is versionless) */
     appVersion?: string;
+    /** The value that violated the alert condition (e.g. "76.5", "3") */
     violationValue: number;
+    /** The unit for the violation value (e.g. "percent", "seconds") */
     violationUnit: string;
+    /** The link to Fireconsole to investigate more into this alert */
     investigateUri: string;
 }
 /**
@@ -36,6 +47,7 @@ export interface PerformanceEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
  * Configuration for app distribution functions.
  */
 export interface PerformanceOptions extends EventHandlerOptions {
+    /** Scope the function to trigger on a specific application. */
     appId?: string;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.24.0",
+  "version": "3.24.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -175,7 +175,7 @@
     "docgen:v1": "npm run build && npm run docgen:v1:extract && npm run docgen:v1:gen",
     "docgen:v2:extract": "api-extractor run -c docgen/api-extractor.v2.json --local",
     "docgen:v2:toc": "ts-node docgen/toc.ts --input docgen/v2/markdown --output docgen/v2/markdown/toc --path /docs/functions/beta/reference",
-    "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown && npm run docgen:v2:toc",
+    "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",