firebase-functions 3.21.0 → 3.21.1

package/lib/providers/pubsub.d.ts

@@ -8,8 +8,8 @@ export declare const service = "pubsub.googleapis.com";
  * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message
  * is sent to a specified topic.
  *
- * @param topic The Pub/Sub topic to watch for message events.
- * @return Pub/Sub topic builder interface.
+ * @param topic - The Pub/Sub topic to watch for message events.
+ * @returns Pub/Sub topic builder interface.
  */
 export declare function topic(topic: string): TopicBuilder;
 /** @hidden */
@@ -28,7 +28,7 @@ export declare class TopicBuilder {
      * Event handler that fires every time a Cloud Pub/Sub message is
      * published.
      *
-     * @param handler Event handler that runs every time a Cloud Pub/Sub message
+     * @param handler - Event handler that runs every time a Cloud Pub/Sub message
      *   is published.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -37,7 +37,7 @@ export declare class TopicBuilder {
 /**
  * Registers a Cloud Function to run at specified times.
  *
- * @param schedule The schedule, in Unix Crontab or AppEngine syntax.
+ * @param schedule - The schedule, in Unix Crontab or AppEngine syntax.
  * @return ScheduleBuilder interface.
  */
 export declare function schedule(schedule: string): ScheduleBuilder;
@@ -63,7 +63,7 @@ export declare class ScheduleBuilder {
      * Event handler for scheduled functions. Triggered whenever the associated
      * scheduler job sends a Pub/Sub message.
      *
-     * @param handler Handler that fires whenever the associated
+     * @param handler - Handler that fires whenever the associated
      *   scheduler job sends a Pub/Sub message.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -72,7 +72,7 @@ export declare class ScheduleBuilder {
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
  */
 export declare class Message {
     /**

package/lib/providers/pubsub.js

@@ -31,8 +31,8 @@ exports.service = 'pubsub.googleapis.com';
  * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message
  * is sent to a specified topic.
  *
- * @param topic The Pub/Sub topic to watch for message events.
- * @return Pub/Sub topic builder interface.
+ * @param topic - The Pub/Sub topic to watch for message events.
+ * @returns Pub/Sub topic builder interface.
  */
 function topic(topic) {
     return _topicWithOptions(topic, {});
@@ -66,7 +66,7 @@ class TopicBuilder {
      * Event handler that fires every time a Cloud Pub/Sub message is
      * published.
      *
-     * @param handler Event handler that runs every time a Cloud Pub/Sub message
+     * @param handler - Event handler that runs every time a Cloud Pub/Sub message
      *   is published.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -86,7 +86,7 @@ exports.TopicBuilder = TopicBuilder;
 /**
  * Registers a Cloud Function to run at specified times.
  *
- * @param schedule The schedule, in Unix Crontab or AppEngine syntax.
+ * @param schedule - The schedule, in Unix Crontab or AppEngine syntax.
  * @return ScheduleBuilder interface.
  */
 function schedule(schedule) {
@@ -135,7 +135,7 @@ class ScheduleBuilder {
      * Event handler for scheduled functions. Triggered whenever the associated
      * scheduler job sends a Pub/Sub message.
      *
-     * @param handler Handler that fires whenever the associated
+     * @param handler - Handler that fires whenever the associated
      *   scheduler job sends a Pub/Sub message.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -156,7 +156,7 @@ exports.ScheduleBuilder = ScheduleBuilder;
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
  */
 class Message {
     constructor(data) {

package/lib/providers/tasks.d.ts

@@ -2,45 +2,60 @@ import * as express from 'express';
 import { Request } from '../common/providers/https';
 import { RateLimits, RetryConfig, TaskContext } from '../common/providers/tasks';
 import { ManifestEndpoint, ManifestRequiredAPI } from '../runtime/manifest';
-export { 
-/** @hidden */
-RetryConfig as RetryPolicy, 
-/** @hidden */
-RateLimits, 
-/** @hidden */
-TaskContext, };
+export { RetryConfig, RateLimits, TaskContext };
 /**
- * Configurations for Task Queue Functions.
- * @hidden
+ * Options for configuring the task queue to listen to.
  */
 export interface TaskQueueOptions {
+    /** How a task should be retried in the event of a non-2xx return. */
     retryConfig?: RetryConfig;
+    /** How congestion control should be applied to the function. */
     rateLimits?: RateLimits;
     /**
      * Who can enqueue tasks for this function.
      * If left unspecified, only service accounts which have
-     * roles/cloudtasks.enqueuer and roles/cloudfunctions.invoker
+     * `roles/cloudtasks.enqueuer` and `roles/cloudfunctions.invoker`
      * will have permissions.
      */
     invoker?: 'private' | string | string[];
 }
-/** @hidden */
+/**
+ * A handler for tasks.
+ */
 export interface TaskQueueFunction {
     (req: Request, res: express.Response): Promise<void>;
+    /** @alpha */
     __trigger: unknown;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
+    /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];
+    /**
+     * The callback passed to the `TaskQueueFunction` constructor.
+     * @param data - The body enqueued into a task queue.
+     * @param context - The request context of the enqueued task
+     * @returns Any return value. Google Cloud Functions will await any promise
+     *          before shutting down your function. Resolved return values
+     *          are only used for unit testing purposes.
+     */
     run(data: any, context: TaskContext): void | Promise<void>;
 }
-/** @hidden */
+/**
+ * Builder for creating a `TaskQueueFunction`.
+ */
 export declare class TaskQueueBuilder {
     private readonly tqOpts?;
     private readonly depOpts?;
+    /**
+     * Creates a handler for tasks sent to a Google Cloud Tasks queue.
+     * @param handler - A callback to handle task requests.
+     * @returns A Cloud Function you can export and deploy.
+     */
     onDispatch(handler: (data: any, context: TaskContext) => void | Promise<void>): TaskQueueFunction;
 }
 /**
  * Declares a function that can handle tasks enqueued using the Firebase Admin SDK.
- * @param options Configuration for the Task Queue that feeds into this function.
- * @hidden
+ * @param options - Configuration for the Task Queue that feeds into this function.
+ *        Omitting options will configure a Task Queue with default settings.
  */
 export declare function taskQueue(options?: TaskQueueOptions): TaskQueueBuilder;

package/lib/providers/tasks.js

@@ -25,13 +25,20 @@ exports.taskQueue = exports.TaskQueueBuilder = void 0;
 const cloud_functions_1 = require("../cloud-functions");
 const encoding_1 = require("../common/encoding");
 const tasks_1 = require("../common/providers/tasks");
-/** @hidden */
+/**
+ * Builder for creating a `TaskQueueFunction`.
+ */
 class TaskQueueBuilder {
     /** @internal */
     constructor(tqOpts, depOpts) {
         this.tqOpts = tqOpts;
         this.depOpts = depOpts;
     }
+    /**
+     * Creates a handler for tasks sent to a Google Cloud Tasks queue.
+     * @param handler - A callback to handle task requests.
+     * @returns A Cloud Function you can export and deploy.
+     */
     onDispatch(handler) {
         // onEnqueueHandler sniffs the function length of the passed-in callback
         // and the user could have only tried to listen to data. Wrap their handler
@@ -66,8 +73,8 @@ class TaskQueueBuilder {
 exports.TaskQueueBuilder = TaskQueueBuilder;
 /**
  * Declares a function that can handle tasks enqueued using the Firebase Admin SDK.
- * @param options Configuration for the Task Queue that feeds into this function.
- * @hidden
+ * @param options - Configuration for the Task Queue that feeds into this function.
+ *        Omitting options will configure a Task Queue with default settings.
  */
 function taskQueue(options) {
     return new TaskQueueBuilder(options);

package/lib/v2/core.d.ts

@@ -1,7 +1,13 @@
+/**
+ * Core functionality of the Firebase Functions v2 SDK.
+ * @packageDocumentation
+ */
 import { ManifestEndpoint } from '../runtime/manifest';
 /**
  * A CloudEventBase is the base of a cross-platform format for encoding a serverless event.
  * More information can be found in https://github.com/cloudevents/spec
+ * @typeParam T - The type of the event data.
+ * @beta
  */
 export interface CloudEvent<T> {
     /** Version of the CloudEvents spec for this event. */
@@ -19,10 +25,26 @@ export interface CloudEvent<T> {
     /** Information about this specific event. */
     data: T;
 }
-/** A handler for CloudEvents. */
+/**
+ * A handler for CloudEvents.
+ * @typeParam EventType - The kind of event this function handles.
+ *            Always a subclass of CloudEvent<>
+ * @beta
+ */
 export interface CloudFunction<EventType extends CloudEvent<unknown>> {
     (raw: CloudEvent<unknown>): any | Promise<any>;
+    /** @alpha */
     __trigger?: unknown;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
+    /**
+     * The callback passed to the CloudFunction constructor.
+     * Use run to test a CloudFunction
+     * @param event - The parsed event to handle.
+     * @returns Any return value. Google Cloud Functions awaits any promise
+     *          before shutting down your function. Resolved return values
+     *          are only used for unit testing purposes.
+     * @beta
+     */
     run(event: EventType): any | Promise<any>;
 }

package/lib/v2/index.d.ts

@@ -1,5 +1,11 @@
+/**
+ * The V2 API for Cloud Functions for Firebase.
+ * This SDK also supports deep imports. For example, the namespace
+ * 'pubsub' is available at 'firebase-functions/v2' or is directly importable
+ * from 'firebase-functions/v2/pubsub'.
+ * @packageDocumentation
+ */
 import * as logger from '../logger';
-import * as params from './params';
 import * as alerts from './providers/alerts';
 import * as eventarc from './providers/eventarc';
 import * as https from './providers/https';
@@ -7,6 +13,6 @@ import * as identity from './providers/identity';
 import * as pubsub from './providers/pubsub';
 import * as storage from './providers/storage';
 import * as tasks from './providers/tasks';
-export { alerts, https, identity, pubsub, storage, logger, params, tasks, eventarc, };
-export { setGlobalOptions, GlobalOptions } from './options';
+export { alerts, storage, https, identity, pubsub, logger, tasks, eventarc };
+export { setGlobalOptions, GlobalOptions, SupportedRegion, MemoryOption, VpcEgressSetting, IngressSetting, EventHandlerOptions, } from './options';
 export { CloudFunction, CloudEvent } from './core';

package/lib/v2/index.js

@@ -21,11 +21,16 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGlobalOptions = exports.eventarc = exports.tasks = exports.params = exports.logger = exports.storage = exports.pubsub = exports.identity = exports.https = exports.alerts = void 0;
+exports.setGlobalOptions = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.alerts = void 0;
+/**
+ * The V2 API for Cloud Functions for Firebase.
+ * This SDK also supports deep imports. For example, the namespace
+ * 'pubsub' is available at 'firebase-functions/v2' or is directly importable
+ * from 'firebase-functions/v2/pubsub'.
+ * @packageDocumentation
+ */
 const logger = require("../logger");
 exports.logger = logger;
-const params = require("./params");
-exports.params = params;
 const alerts = require("./providers/alerts");
 exports.alerts = alerts;
 const eventarc = require("./providers/eventarc");

package/lib/v2/options.d.ts

@@ -2,48 +2,19 @@ import { ParamSpec } from './params/types';
 /**
  * List of all regions supported by Cloud Functions v2
  */
-export declare const SUPPORTED_REGIONS: readonly ["asia-northeast1", "europe-north1", "europe-west1", "europe-west4", "us-central1", "us-east1", "us-west1"];
-/**
- * A region known to be supported by CloudFunctions v2
- */
-export declare type SupportedRegion = typeof SUPPORTED_REGIONS[number];
-/**
- * Cloud Functions v2 min timeout value.
- */
-export declare const MIN_TIMEOUT_SECONDS = 1;
-/**
- * Cloud Functions v2 max timeout value for event handlers.
- */
-export declare const MAX_EVENT_TIMEOUT_SECONDS = 540;
-/**
- * Cloud Functions v2 max timeout for HTTPS functions.
- */
-export declare const MAX_HTTPS_TIMEOUT_SECONDS = 36000;
-/**
- * Maximum number of requests to serve on a single instance.
- */
-export declare const MAX_CONCURRENCY = 1000;
+export declare type SupportedRegion = 'asia-northeast1' | 'europe-north1' | 'europe-west1' | 'europe-west4' | 'us-central1' | 'us-east1' | 'us-west1';
 /**
  * List of available memory options supported by Cloud Functions.
  */
-export declare const SUPPORTED_MEMORY_OPTIONS: readonly ["128MiB", "256MiB", "512MiB", "1GiB", "2GiB", "4GiB", "8GiB", "16GiB", "32GiB"];
-/**
- * A supported memory option.
- */
-export declare type MemoryOption = typeof SUPPORTED_MEMORY_OPTIONS[number];
+export declare type MemoryOption = '128MiB' | '256MiB' | '512MiB' | '1GiB' | '2GiB' | '4GiB' | '8GiB' | '16GiB' | '32GiB';
 /**
  * List of available options for VpcConnectorEgressSettings.
  */
-export declare const SUPPORTED_VPC_EGRESS_SETTINGS: readonly ["PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"];
-/**
- * A valid VPC Egress setting.
- */
-export declare type VpcEgressSetting = typeof SUPPORTED_VPC_EGRESS_SETTINGS[number];
+export declare type VpcEgressSetting = 'PRIVATE_RANGES_ONLY' | 'ALL_TRAFFIC';
 /**
  * List of available options for IngressSettings.
  */
-export declare const SUPPORTED_INGRESS_SETTINGS: readonly ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"];
-export declare type IngressSetting = typeof SUPPORTED_INGRESS_SETTINGS[number];
+export declare type IngressSetting = 'ALLOW_ALL' | 'ALLOW_INTERNAL_ONLY' | 'ALLOW_INTERNAL_AND_GCLB';
 /**
  * GlobalOptions are options that can be set across an entire project.
  * These options are common to HTTPS and Event handling functions.
@@ -63,6 +34,11 @@ export interface GlobalOptions {
      * 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;
     /**
@@ -82,6 +58,7 @@ export interface GlobalOptions {
      * 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;
     /**
@@ -129,13 +106,15 @@ export interface GlobalOptions {
  */
 export declare function setGlobalOptions(options: GlobalOptions): void;
 /**
- * Options that can be set on an individual event-handling Cloud Function.
+ * Additional fields that can be set on any event-handling Cloud Function.
  */
 export interface EventHandlerOptions extends GlobalOptions {
+    /** Whether failed executions should be delivered again. */
     retry?: boolean;
 }
 /**
  * @hidden
+ * @alpha
  */
 export declare function __getSpec(): {
     globalOptions: GlobalOptions;

package/lib/v2/options.js

@@ -21,52 +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.__getSpec = exports.optionsToEndpoint = exports.optionsToTriggerAnnotations = exports.getGlobalOptions = exports.setGlobalOptions = exports.SUPPORTED_INGRESS_SETTINGS = exports.SUPPORTED_VPC_EGRESS_SETTINGS = exports.SUPPORTED_MEMORY_OPTIONS = exports.MAX_CONCURRENCY = exports.MAX_HTTPS_TIMEOUT_SECONDS = exports.MAX_EVENT_TIMEOUT_SECONDS = exports.MIN_TIMEOUT_SECONDS = exports.SUPPORTED_REGIONS = void 0;
+exports.__getSpec = exports.optionsToEndpoint = exports.optionsToTriggerAnnotations = exports.getGlobalOptions = exports.setGlobalOptions = void 0;
+/**
+ * Options to configure cloud functions.
+ * @packageDocumentation
+ */
 const encoding_1 = require("../common/encoding");
 const logger = require("../logger");
 const params_1 = require("./params");
-/**
- * List of all regions supported by Cloud Functions v2
- */
-exports.SUPPORTED_REGIONS = [
-    'asia-northeast1',
-    'europe-north1',
-    'europe-west1',
-    'europe-west4',
-    'us-central1',
-    'us-east1',
-    'us-west1',
-];
-/**
- * Cloud Functions v2 min timeout value.
- */
-exports.MIN_TIMEOUT_SECONDS = 1;
-/**
- * Cloud Functions v2 max timeout value for event handlers.
- */
-exports.MAX_EVENT_TIMEOUT_SECONDS = 540;
-/**
- * Cloud Functions v2 max timeout for HTTPS functions.
- */
-exports.MAX_HTTPS_TIMEOUT_SECONDS = 36000;
-/**
- * Maximum number of requests to serve on a single instance.
- */
-exports.MAX_CONCURRENCY = 1000;
-/**
- * List of available memory options supported by Cloud Functions.
- */
-exports.SUPPORTED_MEMORY_OPTIONS = [
-    '128MiB',
-    '256MiB',
-    '512MiB',
-    '1GiB',
-    '2GiB',
-    '4GiB',
-    '8GiB',
-    '16GiB',
-    '32GiB',
-];
 const MemoryOptionToMB = {
     '128MiB': 128,
     '256MiB': 256,
@@ -78,21 +40,6 @@ const MemoryOptionToMB = {
     '16GiB': 16384,
     '32GiB': 32768,
 };
-/**
- * List of available options for VpcConnectorEgressSettings.
- */
-exports.SUPPORTED_VPC_EGRESS_SETTINGS = [
-    'PRIVATE_RANGES_ONLY',
-    'ALL_TRAFFIC',
-];
-/**
- * List of available options for IngressSettings.
- */
-exports.SUPPORTED_INGRESS_SETTINGS = [
-    'ALLOW_ALL',
-    'ALLOW_INTERNAL_ONLY',
-    'ALLOW_INTERNAL_AND_GCLB',
-];
 let globalOptions;
 /**
  * Sets default options for all functions written using the v2 SDK.
@@ -166,6 +113,7 @@ function optionsToEndpoint(opts) {
 exports.optionsToEndpoint = optionsToEndpoint;
 /**
  * @hidden
+ * @alpha
  */
 function __getSpec() {
     return {

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

@@ -1,4 +1,7 @@
-/** @hidden */
+/**
+ * @hidden
+ * @alpha
+ */
 import { BooleanParam, FloatParam, IntParam, JSONParam, ListParam, Param, ParamOptions, StringParam } from './types';
 export { ParamOptions };
 export declare const declaredParams: Param[];

package/lib/v2/params/index.js

@@ -1,7 +1,31 @@
 "use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 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.defineJSON = exports.defineList = exports.defineFloat = exports.defineInt = exports.defineBoolean = exports.defineString = exports.declaredParams = void 0;
-/** @hidden */
+/**
+ * @hidden
+ * @alpha
+ */
 const types_1 = require("./types");
 exports.declaredParams = [];
 /**

package/lib/v2/params/types.js

@@ -1,4 +1,25 @@
 "use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 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.JSONParam = exports.ListParam = exports.BooleanParam = exports.FloatParam = exports.IntParam = exports.StringParam = exports.Param = void 0;
 class Param {

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

@@ -2,6 +2,7 @@ import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
 /**
  * The CloudEvent data emitted by Firebase Alerts.
+ * @typeParam T - the payload type that is expected for this alert.
  */
 export interface FirebaseAlertData<T = any> {
     /** Time that the event has created. */
@@ -13,6 +14,7 @@ export interface FirebaseAlertData<T = any> {
 }
 /**
  * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
+ * @typeParam T - the data type for this alert that is wrapped in a `FirebaseAlertData` object.
  */
 export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
     /** The type of the alerts that got triggered. */
@@ -22,7 +24,7 @@ export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
      * and only present when the alert is targeting at a specific Firebase App.
      */
     appId?: string;
-    /** Data for an AlertEvent is a FirebaseAlertData with a given payload. */
+    /** Data for an `AlertEvent` is a `FirebaseAlertData` object with a given payload. */
     data: FirebaseAlertData<T>;
 }
 /** The underlying alert type of the Firebase Alerts provider. */
@@ -31,14 +33,103 @@ export declare type AlertType = 'crashlytics.newFatalIssue' | 'crashlytics.newNo
  * Configuration for Firebase Alert functions.
  */
 export interface FirebaseAlertOptions extends options.EventHandlerOptions {
+    /** Scope the handler to trigger on an alert type. */
     alertType: AlertType;
+    /** 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 Firebase Alerts from CloudEvents.
- * @param alertTypeOrOpts the alert type or Firebase Alert function configuration.
+ * @typeParam T - the type of event.data.payload.
+ * @param alertType - the alert type or Firebase Alert function configuration.
+ * @param handler a function that can handle the Firebase Alert inside a CloudEvent.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onAlertPublished<T extends {
+    ['@type']: string;
+} = any>(alertType: AlertType, handler: (event: AlertEvent<T>) => any | Promise<any>): CloudFunction<AlertEvent<T>>;
+/**
+ * Declares a function that can handle Firebase Alerts from CloudEvents.
+ * @typeParam T - the type of event.data.payload.
+ * @param options - the alert type and other options for this cloud function.
  * @param handler a function that can handle the Firebase Alert inside a CloudEvent.
  */
 export declare function onAlertPublished<T extends {
     ['@type']: string;
-} = any>(alertTypeOrOpts: AlertType | FirebaseAlertOptions, handler: (event: AlertEvent<T>) => any | Promise<any>): CloudFunction<AlertEvent<T>>;
+} = any>(options: FirebaseAlertOptions, handler: (event: AlertEvent<T>) => any | Promise<any>): CloudFunction<AlertEvent<T>>;