firebase-functions 3.21.0 → 3.22.0

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

@@ -1,16 +1,24 @@
+/**
+ * Cloud functions to handle Crashlytics events from Firebase Alerts.
+ * @packageDocumentation
+ */
 import { FirebaseAlertData } from '.';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
-/** Generic crashlytics issue interface */
-interface Issue {
+/** Generic Crashlytics issue interface */
+export interface Issue {
+    /** The ID of the Crashlytics issue */
     id: string;
+    /** The title of the Crashlytics issue */
     title: string;
+    /** The subtitle of the Crashlytics issue */
     subtitle: string;
+    /** The application version of the Crashlytics issue */
     appVersion: string;
 }
 /**
  * The internal payload object for a new fatal issue.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface NewFatalIssuePayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewFatalIssuePayload';
@@ -19,7 +27,7 @@ export interface NewFatalIssuePayload {
 }
 /**
  * The internal payload object for a new non-fatal issue.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface NewNonfatalIssuePayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewNonfatalIssuePayload';
@@ -28,7 +36,7 @@ export interface NewNonfatalIssuePayload {
 }
 /**
  * The internal payload object for a regression alert.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface RegressionAlertPayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsRegressionAlertPayload';
@@ -42,8 +50,8 @@ export interface RegressionAlertPayload {
      */
     resolveTime: string;
 }
-/** Generic crashlytics trending issue interface */
-interface TrendingIssueDetails {
+/** Generic Crashlytics trending issue interface */
+export interface TrendingIssueDetails {
     /** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */
     type: string;
     /** Basic information of the Crashlytics issue */
@@ -55,7 +63,7 @@ interface TrendingIssueDetails {
 }
 /**
  * The internal payload object for a stability digest.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface StabilityDigestPayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsStabilityDigestPayload';
@@ -69,7 +77,7 @@ export interface StabilityDigestPayload {
 }
 /**
  * The internal payload object for a velocity alert.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface VelocityAlertPayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsVelocityAlertPayload';
@@ -95,7 +103,7 @@ export interface VelocityAlertPayload {
 }
 /**
  * The internal payload object for a new Application Not Responding issue.
- * Payload is wrapped inside a FirebaseAlertData object.
+ * Payload is wrapped inside a `FirebaseAlertData` object.
  */
 export interface NewAnrIssuePayload {
     ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewAnrIssuePayload';
@@ -104,6 +112,7 @@ export interface NewAnrIssuePayload {
 }
 /**
  * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
+ * @typeParam T - the data type for Crashlytics alerts that is wrapped in a `FirebaseAlertData` object.
  */
 export interface CrashlyticsEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
     /** The type of the alerts that got triggered. */
@@ -112,45 +121,211 @@ export interface CrashlyticsEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
     appId: string;
 }
 /**
- * Configuration for crashlytics functions.
+ * Configuration for Crashlytics functions.
  */
 export interface CrashlyticsOptions extends options.EventHandlerOptions {
+    /** Scope the function to trigger on a specific application. */
     appId?: string;
+    /**
+     * Region where functions should be deployed.
+     */
+    region?: options.SupportedRegion | string;
+    /**
+     * Amount of memory to allocate to a function.
+     * A value of null restores the defaults of 256MB.
+     */
+    memory?: options.MemoryOption | null;
+    /**
+     * Timeout for the function in sections, possible values are 0 to 540.
+     * HTTPS functions can specify a higher timeout.
+     * A value of null restores the default of 60s
+     * The minimum timeout for a gen 2 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
+     * timeout of 1,800s (30 minutes)
+     */
+    timeoutSeconds?: number | null;
+    /**
+     * Min number of actual instances to be running at a given time.
+     * Instances will be billed for memory allocation and 10% of CPU allocation
+     * while idle.
+     * A value of null restores the default min instances.
+     */
+    minInstances?: number | null;
+    /**
+     * Max number of instances to be running in parallel.
+     * A value of null restores the default max instances.
+     */
+    maxInstances?: number | null;
+    /**
+     * Number of requests a function can serve at once.
+     * Can only be applied to functions running on Cloud Functions v2.
+     * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
+     * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
+     * The maximum value for concurrency is 1,000.
+     */
+    concurrency?: number | null;
+    /**
+     * Fractional number of CPUs to allocate to a function.
+     * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
+     * This is different from the defaults when using the gcloud utility and is different from
+     * the fixed amount assigned in Google Cloud Functions generation 1.
+     * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
+     * to the value "gcf_gen1"
+     */
+    cpu?: number | 'gcf_gen1';
+    /**
+     * Connect cloud function to specified VPC connector.
+     * A value of null removes the VPC connector
+     */
+    vpcConnector?: string | null;
+    /**
+     * Egress settings for VPC connector.
+     * A value of null turns off VPC connector egress settings
+     */
+    vpcConnectorEgressSettings?: options.VpcEgressSetting | null;
+    /**
+     * Specific service account for the function to run as.
+     * A value of null restores the default service account.
+     */
+    serviceAccount?: string | null;
+    /**
+     * Ingress settings which control where this function can be called from.
+     * A value of null turns off ingress settings.
+     */
+    ingressSettings?: options.IngressSetting | null;
+    /**
+     * User labels to set on the function.
+     */
+    labels?: Record<string, string>;
+    secrets?: string[];
+    /** Whether failed executions should be delivered again. */
+    retry?: boolean;
 }
 /**
- * Declares a function that can handle a new fatal issue published to crashlytics.
+ * Declares a function that can handle a new fatal issue published to Crashlytics.
+ * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onNewFatalIssuePublished(handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
+/**
+ * Declares a function that can handle a new fatal issue published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onNewFatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
+/**
+ * Declares a function that can handle a new fatal issue published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onNewFatalIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
 /**
- * Declares a function that can handle aa new non-fatal issue published to crashlytics.
+ * Declares a function that can handle a new non-fatal issue published to Crashlytics.
+ * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onNewNonfatalIssuePublished(handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
+/**
+ * Declares a function that can handle a new non-fatal issue published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onNewNonfatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
+/**
+ * Declares a function that can handle a new non-fatal issue published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onNewNonfatalIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
 /**
- * Declares a function that can handle a regression alert published to crashlytics.
+ * Declares a function that can handle a regression alert published to Crashlytics.
+ * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onRegressionAlertPublished(handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
+/**
+ * Declares a function that can handle a regression alert published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onRegressionAlertPublished(appId: string, handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
+/**
+ * Declares a function that can handle a regression alert published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onRegressionAlertPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
 /**
- * Declares a function that can handle a stability digest published to crashlytics.
+ * Declares a function that can handle a stability digest published to Crashlytics.
+ * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onStabilityDigestPublished(handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
+/**
+ * Declares a function that can handle a stability digest published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onStabilityDigestPublished(appId: string, handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
+/**
+ * Declares a function that can handle a stability digest published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onStabilityDigestPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
 /**
- * Declares a function that can handle a velocity alert published to crashlytics.
+ * Declares a function that can handle a velocity alert published to Crashlytics.
+ * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onVelocityAlertPublished(handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
+/**
+ * Declares a function that can handle a velocity alert published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onVelocityAlertPublished(appId: string, handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
+/**
+ * Declares a function that can handle a velocity alert published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onVelocityAlertPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
 /**
- * Declares a function that can handle a new Application Not Responding issue published to crashlytics.
+ * Declares a function that can handle a new Application Not Responding issue published to Crashlytics.
+ * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
  */
 export declare function onNewAnrIssuePublished(handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
+/**
+ * Declares a function that can handle a new Application Not Responding issue published to Crashlytics.
+ * @param appId - A specific application the handler will trigger on.
+ * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onNewAnrIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
+/**
+ * Declares a function that can handle a new Application Not Responding issue published to Crashlytics.
+ * @param opts - Options that can be set on the function.
+ * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+
+ */
 export declare function onNewAnrIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
-export {};

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

@@ -1,6 +1,31 @@
 "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.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(".");
 /** @internal */
 exports.newFatalIssueAlert = 'crashlytics.newFatalIssue';
@@ -14,26 +39,62 @@ exports.stabilityDigestAlert = 'crashlytics.stabilityDigest';
 exports.velocityAlert = 'crashlytics.velocity';
 /** @internal */
 exports.newAnrIssueAlert = 'crashlytics.newAnrIssue';
+/**
+ * Declares a function that can handle a new fatal issue published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onNewFatalIssuePublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.newFatalIssueAlert, appIdOrOptsOrHandler, handler);
 }
 exports.onNewFatalIssuePublished = onNewFatalIssuePublished;
+/**
+ * Declares a function that can handle a new non-fatal issue published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onNewNonfatalIssuePublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.newNonfatalIssueAlert, appIdOrOptsOrHandler, handler);
 }
 exports.onNewNonfatalIssuePublished = onNewNonfatalIssuePublished;
+/**
+ * Declares a function that can handle a regression alert published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onRegressionAlertPublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.regressionAlert, appIdOrOptsOrHandler, handler);
 }
 exports.onRegressionAlertPublished = onRegressionAlertPublished;
+/**
+ * Declares a function that can handle a stability digest published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onStabilityDigestPublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.stabilityDigestAlert, appIdOrOptsOrHandler, handler);
 }
 exports.onStabilityDigestPublished = onStabilityDigestPublished;
+/**
+ * Declares a function that can handle a velocity alert published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onVelocityAlertPublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.velocityAlert, appIdOrOptsOrHandler, handler);
 }
 exports.onVelocityAlertPublished = onVelocityAlertPublished;
+/**
+ * Declares a function that can handle a new Application Not Responding issue published to Crashlytics.
+ * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
+ * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.
+ * @returns A function that you can export and deploy.
+ */
 function onNewAnrIssuePublished(appIdOrOptsOrHandler, handler) {
     return onOperation(exports.newAnrIssueAlert, appIdOrOptsOrHandler, handler);
 }
@@ -54,8 +115,8 @@ function onOperation(alertType, appIdOrOptsOrHandler, handler) {
 }
 exports.onOperation = onOperation;
 /**
- * @internal
  * Helper function to parse the function opts and appId.
+ * @internal
  */
 function getOptsAndApp(appIdOrOpts) {
     let opts;

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

@@ -1,3 +1,9 @@
+/**
+ * Cloud functions to handle events from Firebase Alerts.
+ * Subpackages give stronger typing to specific services which
+ * notify users via Firebase Alerts.
+ * @packageDocumentation
+ */
 import * as appDistribution from './appDistribution';
 import * as billing from './billing';
 import * as crashlytics from './crashlytics';

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

@@ -1,4 +1,25 @@
 "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.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -15,6 +36,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.crashlytics = exports.billing = exports.appDistribution = void 0;
+/**
+ * Cloud functions to handle events from Firebase Alerts.
+ * Subpackages give stronger typing to specific services which
+ * notify users via Firebase Alerts.
+ * @packageDocumentation
+ */
 const appDistribution = require("./appDistribution");
 exports.appDistribution = appDistribution;
 const billing = require("./billing");

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

@@ -0,0 +1,182 @@
+import { Change } from '../../common/change';
+import { DataSnapshot } from '../../common/providers/database';
+import { CloudEvent, CloudFunction } from '../core';
+import * as options from '../options';
+export { DataSnapshot };
+/** @hidden */
+export interface RawRTDBCloudEventData {
+    ['@type']: 'type.googleapis.com/google.events.firebase.database.v1.ReferenceEventData';
+    data: any;
+    delta: any;
+}
+/** @hidden */
+export interface RawRTDBCloudEvent extends CloudEvent<RawRTDBCloudEventData> {
+    firebasedatabasehost: string;
+    instance: string;
+    ref: string;
+    location: string;
+}
+/** A CloudEvent that contains a DataSnapshot or a Change<DataSnapshot> */
+export interface DatabaseEvent<T> extends CloudEvent<T> {
+    /** The domain of the database instance */
+    firebaseDatabaseHost: string;
+    /** The instance ID portion of the fully qualified resource name */
+    instance: string;
+    /** The database reference path */
+    ref: string;
+    /** The location of the database */
+    location: string;
+    /**
+     * An object containing the values of the path patterns.
+     * Only named capture groups will be populated - {key}, {key=*}, {key=**}
+     */
+    params: Record<string, string>;
+}
+/** ReferenceOptions extend EventHandlerOptions with provided ref and optional instance  */
+export interface ReferenceOptions extends options.EventHandlerOptions {
+    /**
+     * Specify the handler to trigger on a database reference(s).
+     * This value can either be a single reference or a pattern.
+     * Examples: '/foo/bar', '/foo/{bar}'
+     */
+    ref: string;
+    /**
+     * Specify the handler to trigger on a database instance(s).
+     * If present, this value can either be a single instance or a pattern.
+     * Examples: 'my-instance-1', 'my-instance-*'
+     * Note: The capture syntax cannot be used for 'instance'.
+     */
+    instance?: string;
+    /**
+     * Region where functions should be deployed.
+     */
+    region?: options.SupportedRegion | string;
+    /**
+     * Amount of memory to allocate to a function.
+     * A value of null restores the defaults of 256MB.
+     */
+    memory?: options.MemoryOption | null;
+    /**
+     * Timeout for the function in sections, possible values are 0 to 540.
+     * HTTPS functions can specify a higher timeout.
+     * A value of null restores the default of 60s
+     * The minimum timeout for a gen 2 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
+     * timeout of 1,800s (30 minutes)
+     */
+    timeoutSeconds?: number | null;
+    /**
+     * Min number of actual instances to be running at a given time.
+     * Instances will be billed for memory allocation and 10% of CPU allocation
+     * while idle.
+     * A value of null restores the default min instances.
+     */
+    minInstances?: number | null;
+    /**
+     * Max number of instances to be running in parallel.
+     * A value of null restores the default max instances.
+     */
+    maxInstances?: number | null;
+    /**
+     * Number of requests a function can serve at once.
+     * Can only be applied to functions running on Cloud Functions v2.
+     * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
+     * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
+     * The maximum value for concurrency is 1,000.
+     */
+    concurrency?: number | null;
+    /**
+     * Fractional number of CPUs to allocate to a function.
+     * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
+     * This is different from the defaults when using the gcloud utility and is different from
+     * the fixed amount assigned in Google Cloud Functions generation 1.
+     * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
+     * to the value "gcf_gen1"
+     */
+    cpu?: number | 'gcf_gen1';
+    /**
+     * Connect cloud function to specified VPC connector.
+     * A value of null removes the VPC connector
+     */
+    vpcConnector?: string | null;
+    /**
+     * Egress settings for VPC connector.
+     * A value of null turns off VPC connector egress settings
+     */
+    vpcConnectorEgressSettings?: options.VpcEgressSetting | null;
+    /**
+     * Specific service account for the function to run as.
+     * A value of null restores the default service account.
+     */
+    serviceAccount?: string | null;
+    /**
+     * Ingress settings which control where this function can be called from.
+     * A value of null turns off ingress settings.
+     */
+    ingressSettings?: options.IngressSetting | null;
+    /**
+     * User labels to set on the function.
+     */
+    labels?: Record<string, string>;
+    secrets?: string[];
+    /** Whether failed executions should be delivered again. */
+    retry?: boolean;
+}
+/**
+ * Event handler which triggers when data is created, updated, or deleted in Realtime Database.
+ *
+ * @param reference - The database reference path to trigger on.
+ * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
+ */
+export declare function onValueWritten(reference: string, handler: (event: DatabaseEvent<Change<DataSnapshot>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>>>;
+/**
+ * Event handler which triggers when data is created, updated, or deleted in Realtime Database.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
+ */
+export declare function onValueWritten(opts: ReferenceOptions, handler: (event: DatabaseEvent<Change<DataSnapshot>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>>>;
+/**
+ * Event handler which triggers when data is created in Realtime Database.
+ *
+ * @param reference - The database reference path to trigger on.
+ * @param handler - Event handler which is run every time a Realtime Database create occurs.
+ */
+export declare function onValueCreated(reference: string, handler: (event: DatabaseEvent<DataSnapshot>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot>>;
+/**
+ * Event handler which triggers when data is created in Realtime Database.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Realtime Database create occurs.
+ */
+export declare function onValueCreated(opts: ReferenceOptions, handler: (event: DatabaseEvent<DataSnapshot>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot>>;
+/**
+ * Event handler which triggers when data is updated in Realtime Database.
+ *
+ * @param reference - The database reference path to trigger on.
+ * @param handler - Event handler which is run every time a Realtime Database update occurs.
+ */
+export declare function onValueUpdated(reference: string, handler: (event: DatabaseEvent<Change<DataSnapshot>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>>>;
+/**
+ * Event handler which triggers when data is updated in Realtime Database.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Realtime Database update occurs.
+ */
+export declare function onValueUpdated(opts: ReferenceOptions, handler: (event: DatabaseEvent<Change<DataSnapshot>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>>>;
+/**
+ * Event handler which triggers when data is deleted in Realtime Database.
+ *
+ * @param reference - The database reference path to trigger on.
+ * @param handler - Event handler which is run every time a Realtime Database deletion occurs.
+ */
+export declare function onValueDeleted(reference: string, handler: (event: DatabaseEvent<DataSnapshot>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot>>;
+/**
+ * Event handler which triggers when data is deleted in Realtime Database.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Realtime Database deletion occurs.
+ */
+export declare function onValueDeleted(opts: ReferenceOptions, handler: (event: DatabaseEvent<DataSnapshot>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot>>;