firebase-functions 3.21.0 → 3.22.0

package/lib/v2/providers/database.js

@@ -0,0 +1,204 @@
+"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.onOperation = exports.onChangedOperation = exports.makeEndpoint = exports.makeParams = exports.getOpts = exports.onValueDeleted = exports.onValueUpdated = exports.onValueCreated = exports.onValueWritten = exports.deletedEventType = exports.updatedEventType = exports.createdEventType = exports.writtenEventType = exports.DataSnapshot = void 0;
+const apps_1 = require("../../apps");
+const database_1 = require("../../common/providers/database");
+Object.defineProperty(exports, "DataSnapshot", { enumerable: true, get: function () { return database_1.DataSnapshot; } });
+const path_1 = require("../../utilities/path");
+const path_pattern_1 = require("../../utilities/path-pattern");
+const utils_1 = require("../../utils");
+const options = require("../options");
+/** @internal */
+exports.writtenEventType = 'google.firebase.database.ref.v1.written';
+/** @internal */
+exports.createdEventType = 'google.firebase.database.ref.v1.created';
+/** @internal */
+exports.updatedEventType = 'google.firebase.database.ref.v1.updated';
+/** @internal */
+exports.deletedEventType = 'google.firebase.database.ref.v1.deleted';
+/**
+ * Event handler which triggers when data is created, updated, or deleted in Realtime Database.
+ *
+ * @param referenceOrOpts - Options or a string reference.
+ * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
+ */
+function onValueWritten(referenceOrOpts, handler) {
+    return onChangedOperation(exports.writtenEventType, referenceOrOpts, handler);
+}
+exports.onValueWritten = onValueWritten;
+/**
+ * Event handler which triggers when data is created in Realtime Database.
+ *
+ * @param referenceOrOpts - Options or a string reference.
+ * @param handler - Event handler which is run every time a Realtime Database create occurs.
+ */
+function onValueCreated(referenceOrOpts, handler) {
+    return onOperation(exports.createdEventType, referenceOrOpts, handler);
+}
+exports.onValueCreated = onValueCreated;
+/**
+ * Event handler which triggers when data is updated in Realtime Database.
+ *
+ * @param referenceOrOpts - Options or a string reference.
+ * @param handler - Event handler which is run every time a Realtime Database update occurs.
+ */
+function onValueUpdated(referenceOrOpts, handler) {
+    return onChangedOperation(exports.updatedEventType, referenceOrOpts, handler);
+}
+exports.onValueUpdated = onValueUpdated;
+/**
+ * Event handler which triggers when data is deleted in Realtime Database.
+ *
+ * @param referenceOrOpts - Options or a string reference.
+ * @param handler - Event handler which is run every time a Realtime Database deletion occurs.
+ */
+function onValueDeleted(referenceOrOpts, handler) {
+    // TODO - need to use event.data.delta
+    return onOperation(exports.deletedEventType, referenceOrOpts, handler);
+}
+exports.onValueDeleted = onValueDeleted;
+/** @internal */
+function getOpts(referenceOrOpts) {
+    let path, instance, opts;
+    if (typeof referenceOrOpts === 'string') {
+        path = (0, path_1.normalizePath)(referenceOrOpts);
+        instance = '*';
+        opts = {};
+    }
+    else {
+        path = (0, path_1.normalizePath)(referenceOrOpts.ref);
+        instance = referenceOrOpts.instance || '*';
+        opts = { ...referenceOrOpts };
+        delete opts.ref;
+        delete opts.instance;
+    }
+    return {
+        path,
+        instance,
+        opts,
+    };
+}
+exports.getOpts = getOpts;
+/** @internal */
+function makeParams(event, path, instance) {
+    return {
+        ...path.extractMatches(event.ref),
+        ...instance.extractMatches(event.instance),
+    };
+}
+exports.makeParams = makeParams;
+/** @hidden */
+function makeDatabaseEvent(event, data, instance, params) {
+    const snapshot = new database_1.DataSnapshot(data, event.ref, (0, apps_1.apps)().admin, instance);
+    const databaseEvent = {
+        ...event,
+        firebaseDatabaseHost: event.firebasedatabasehost,
+        data: snapshot,
+        params,
+    };
+    delete databaseEvent.firebasedatabasehost;
+    return databaseEvent;
+}
+/** @hidden */
+function makeChangedDatabaseEvent(event, instance, params) {
+    const before = new database_1.DataSnapshot(event.data.data, event.ref, (0, apps_1.apps)().admin, instance);
+    const after = new database_1.DataSnapshot((0, utils_1.applyChange)(event.data.data, event.data.delta), event.ref, (0, apps_1.apps)().admin, instance);
+    const databaseEvent = {
+        ...event,
+        firebaseDatabaseHost: event.firebasedatabasehost,
+        data: {
+            before,
+            after,
+        },
+        params,
+    };
+    delete databaseEvent.firebasedatabasehost;
+    return databaseEvent;
+}
+/** @internal */
+function makeEndpoint(eventType, opts, path, instance) {
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    const specificOpts = options.optionsToEndpoint(opts);
+    const eventFilters = {};
+    const eventFilterPathPatterns = {
+        // Note: Eventarc always treats ref as a path pattern
+        ref: path.getValue(),
+    };
+    instance.hasWildcards()
+        ? (eventFilterPathPatterns.instance = instance.getValue())
+        : (eventFilters.instance = instance.getValue());
+    return {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        eventTrigger: {
+            eventType,
+            eventFilters,
+            eventFilterPathPatterns,
+            retry: false,
+        },
+    };
+}
+exports.makeEndpoint = makeEndpoint;
+/** @internal */
+function onChangedOperation(eventType, referenceOrOpts, handler) {
+    const { path, instance, opts } = getOpts(referenceOrOpts);
+    const pathPattern = new path_pattern_1.PathPattern(path);
+    const instancePattern = new path_pattern_1.PathPattern(instance);
+    // wrap the handler
+    const func = (raw) => {
+        const event = raw;
+        const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
+        const params = makeParams(event, pathPattern, instancePattern);
+        const databaseEvent = makeChangedDatabaseEvent(event, instanceUrl, params);
+        return handler(databaseEvent);
+    };
+    func.run = handler;
+    func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);
+    return func;
+}
+exports.onChangedOperation = onChangedOperation;
+/** @internal */
+function onOperation(eventType, referenceOrOpts, handler) {
+    const { path, instance, opts } = getOpts(referenceOrOpts);
+    const pathPattern = new path_pattern_1.PathPattern(path);
+    const instancePattern = new path_pattern_1.PathPattern(instance);
+    // wrap the handler
+    const func = (raw) => {
+        const event = raw;
+        const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
+        const params = makeParams(event, pathPattern, instancePattern);
+        const data = eventType === exports.deletedEventType ? event.data.data : event.data.delta;
+        const databaseEvent = makeDatabaseEvent(event, data, instanceUrl, params);
+        return handler(databaseEvent);
+    };
+    func.run = handler;
+    func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);
+    return func;
+}
+exports.onOperation = onOperation;

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

@@ -3,7 +3,7 @@ import * as options from '../options';
 /** Options that can be set on an Eventarc trigger. */
 export interface EventarcTriggerOptions extends options.EventHandlerOptions {
     /**
-     * Type of the event.
+     * Type of the event to trigger on.
      */
     eventType: string;
     /**
@@ -25,8 +25,92 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
      * Eventarc event exact match filter.
      */
     filters?: Record<string, 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;
 }
-export declare type CloudEventHandler = (event: CloudEvent<any>) => any | Promise<any>;
-/** Handle an Eventarc event published on the default channel. */
-export declare function onCustomEventPublished<T = any>(eventType: string, handler: CloudEventHandler): CloudFunction<CloudEvent<T>>;
-export declare function onCustomEventPublished<T = any>(opts: EventarcTriggerOptions, handler: CloudEventHandler): CloudFunction<CloudEvent<T>>;
+/** Handles an Eventarc event published on the default channel.
+ * @param eventType - Type of the event to trigger on.
+ * @param handler - A function to execute when triggered.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onCustomEventPublished<T = any>(eventType: string, handler: (event: CloudEvent<T>) => any | Promise<any>): CloudFunction<CloudEvent<T>>;
+/** Handles an Eventarc event.
+ * @param opts - Options to set on this function
+ * @param handler - A function to execute when triggered.
+ * @returns A function that you can export and deploy.
+ */
+export declare function onCustomEventPublished<T = any>(opts: EventarcTriggerOptions, handler: (event: CloudEvent<T>) => any | Promise<any>): CloudFunction<CloudEvent<T>>;

package/lib/v2/providers/eventarc.js

@@ -22,6 +22,10 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onCustomEventPublished = void 0;
+/**
+ * Cloud functions to integrate directly with Eventarc.
+ * @packageDocumentation
+ */
 const encoding_1 = require("../../common/encoding");
 const options = require("../options");
 function onCustomEventPublished(eventTypeOrOpts, handler) {

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

@@ -1,23 +1,144 @@
 import * as express from 'express';
 import { CallableRequest, FunctionsErrorCode, HttpsError, Request } from '../../common/providers/https';
 import { ManifestEndpoint } from '../../runtime/manifest';
+import * as options from '../options';
 import { GlobalOptions, SupportedRegion } from '../options';
 export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
 /**
- * Options that can be set on an individual HTTPS Cloud Function.
+ * Options that can be set on an individual HTTPS function.
  */
 export interface HttpsOptions extends Omit<GlobalOptions, 'region'> {
+    /** HTTP functions can override global options and can specify multiple regions to deploy to. */
     region?: SupportedRegion | string | Array<SupportedRegion | string>;
+    /** If true, allows CORS on requests to this function.
+     * If this is a `string` or `RegExp`, allows requests from domains that match the provided value.
+     * If this is an `Array`, allows requests from domains matching at least one entry of the array.
+     * Defaults to true for {@link https.CallableFunction} and false otherwise.
+     */
     cors?: string | boolean | RegExp | Array<string | RegExp>;
+    /**
+     * 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>;
+    /**
+     * Invoker to set access control on https functions.
+     */
+    invoker?: 'public' | 'private' | string | string[];
+    secrets?: string[];
+    /** Whether failed executions should be delivered again. */
+    retry?: boolean;
 }
-export declare type HttpsFunction = ((req: Request, res: express.Response) => void | Promise<void>) & {
+/**
+ * Handles HTTPS requests.
+ */
+export declare type HttpsFunction = ((
+/** An Express request object representing the HTTPS call to the function. */
+req: Request, 
+/** An Express response object, for this function to respond to callers. */
+res: express.Response) => void | Promise<void>) & {
+    /** @alpha */
     __trigger?: unknown;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
 };
+/**
+ * Creates a callable method for clients to call using a Firebase SDK.
+ */
 export interface CallableFunction<T, Return> extends HttpsFunction {
+    /** Executes the handler function with the provided data as input. Used for unit testing.
+     * @param data - An input for the handler function.
+     * @returns The output of the handler function.
+     */
     run(data: CallableRequest<T>): Return;
 }
+/**
+ * Handles HTTPS requests.
+ * @param opts - Options to set on this function
+ * @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
+/**
+ * Handles HTTPS requests.
+ * @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
+/**
+ * Declares a callable method for clients to call using a Firebase SDK.
+ * @param opts - Options to set on this function.
+ * @param handler - A function that takes a {@link https.CallableRequest}.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onCall<T = any, Return = any | Promise<any>>(opts: HttpsOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
+/**
+ * Declares a callable method for clients to call using a Firebase SDK.
+ * @param handler - A function that takes a {@link https.CallableRequest}.
+ * @returns A function that you can export and deploy.
+ */
 export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

package/lib/v2/providers/https.js

@@ -22,8 +22,13 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onCall = exports.onRequest = exports.HttpsError = void 0;
+/**
+ * Cloud functions to handle HTTPS request or callable RPCs.
+ * @packageDocumentation
+ */
 const cors = require("cors");
 const encoding_1 = require("../../common/encoding");
+const debug_1 = require("../../common/debug");
 const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
 const options = require("../options");
@@ -36,12 +41,13 @@ function onRequest(optsOrHandler, handler) {
     else {
         opts = optsOrHandler;
     }
-    if ('cors' in opts) {
+    if ((0, debug_1.isDebugFeatureEnabled)('enableCors') || 'cors' in opts) {
+        const origin = (0, debug_1.isDebugFeatureEnabled)('enableCors') ? true : opts.cors;
         const userProvidedHandler = handler;
         handler = (req, res) => {
             return new Promise((resolve) => {
                 res.on('finish', resolve);
-                cors({ origin: opts.cors })(req, res, () => {
+                cors({ origin })(req, res, () => {
                     resolve(userProvidedHandler(req, res));
                 });
             });
@@ -97,7 +103,11 @@ function onCall(optsOrHandler, handler) {
     else {
         opts = optsOrHandler;
     }
-    const origin = 'cors' in opts ? opts.cors : true;
+    const origin = (0, debug_1.isDebugFeatureEnabled)('enableCors')
+        ? true
+        : 'cors' in opts
+            ? opts.cors
+            : true;
     // onCallHandler sniffs the function length to determine which API to present.
     // fix the length to prevent api versions from being mismatched.
     const fixedLen = (req) => handler(req);

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

@@ -1,22 +1,126 @@
+/**
+ * Cloud functions to handle events from Google Cloud Identity Platform.
+ * @packageDocumentation
+ */
 import { BlockingFunction } from '../../cloud-functions';
-import { AuthBlockingEvent, BeforeCreateResponse, BeforeSignInResponse, HttpsError } from '../../common/providers/identity';
+import { AuthBlockingEvent, AuthBlockingEventType, BeforeCreateResponse, BeforeSignInResponse, HttpsError } from '../../common/providers/identity';
 import * as options from '../options';
 export { HttpsError };
+/** @hidden Internally used when parsing the options. */
+interface InternalOptions {
+    opts: options.GlobalOptions;
+    idToken: boolean;
+    accessToken: boolean;
+    refreshToken: boolean;
+}
 /**
  * All function options plus idToken, accessToken, and refreshToken.
  */
-export interface BlockingOptions extends options.GlobalOptions {
+export interface BlockingOptions {
+    /** Pass the ID Token credential to the function. */
     idToken?: boolean;
+    /** Pass the Access Token credential to the function. */
     accessToken?: boolean;
+    /** Pass the Refresh Token credential to the function. */
     refreshToken?: boolean;
+    /**
+     * 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[];
 }
 /**
- * Handle an event that is triggered before a user is created.
+ * Handles an event that is triggered before a user is created.
+ * @param handler - Event handler which is run every time before a user is created
  */
 export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before a user is created.
+ * @param opts - Object containing function options
+ * @param handler - Event handler which is run every time before a user is created
+ */
 export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
 /**
- * Handle an event that is triggered before a user is signed in.
+ * Handles an event that is triggered before a user is signed in.
+ * @param handler - Event handler which is run every time before a user is signed in
  */
 export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before a user is signed in.
+ * @param opts - Object containing function options
+ * @param handler - Event handler which is run every time before a user is signed in
+ */
 export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
+/** @hidden */
+export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;
+/** @hidden */
+export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;