firebase-functions 3.20.1 → 3.21.0

package/lib/v2/options.js

@@ -57,26 +57,26 @@ exports.MAX_CONCURRENCY = 1000;
  * List of available memory options supported by Cloud Functions.
  */
 exports.SUPPORTED_MEMORY_OPTIONS = [
-    '128MB',
-    '256MB',
-    '512MB',
-    '1GB',
-    '2GB',
-    '4GB',
-    '8GB',
-    '16GB',
-    '32GB',
+    '128MiB',
+    '256MiB',
+    '512MiB',
+    '1GiB',
+    '2GiB',
+    '4GiB',
+    '8GiB',
+    '16GiB',
+    '32GiB',
 ];
 const MemoryOptionToMB = {
-    '128MB': 128,
-    '256MB': 256,
-    '512MB': 512,
-    '1GB': 1024,
-    '2GB': 2048,
-    '4GB': 4096,
-    '8GB': 8192,
-    '16GB': 16384,
-    '32GB': 32768,
+    '128MiB': 128,
+    '256MiB': 256,
+    '512MiB': 512,
+    '1GiB': 1024,
+    '2GiB': 2048,
+    '4GiB': 4096,
+    '8GiB': 8192,
+    '16GiB': 16384,
+    '32GiB': 32768,
 };
 /**
  * List of available options for VpcConnectorEgressSettings.
@@ -120,19 +120,19 @@ exports.getGlobalOptions = getGlobalOptions;
  */
 function optionsToTriggerAnnotations(opts) {
     const annotation = {};
-    encoding_1.copyIfPresent(annotation, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'vpcConnector', 'vpcConnectorEgressSettings');
-    encoding_1.convertIfPresent(annotation, opts, 'availableMemoryMb', 'memory', (mem) => {
+    (0, encoding_1.copyIfPresent)(annotation, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'vpcConnector', 'vpcConnectorEgressSettings', 'secrets');
+    (0, encoding_1.convertIfPresent)(annotation, opts, 'availableMemoryMb', 'memory', (mem) => {
         return MemoryOptionToMB[mem];
     });
-    encoding_1.convertIfPresent(annotation, opts, 'regions', 'region', (region) => {
+    (0, encoding_1.convertIfPresent)(annotation, opts, 'regions', 'region', (region) => {
         if (typeof region === 'string') {
             return [region];
         }
         return region;
     });
-    encoding_1.convertIfPresent(annotation, opts, 'serviceAccountEmail', 'serviceAccount', encoding_1.serviceAccountFromShorthand);
-    encoding_1.convertIfPresent(annotation, opts, 'timeout', 'timeoutSeconds', encoding_1.durationFromSeconds);
-    encoding_1.convertIfPresent(annotation, opts, 'failurePolicy', 'retry', (retry) => {
+    (0, encoding_1.convertIfPresent)(annotation, opts, 'serviceAccountEmail', 'serviceAccount', encoding_1.serviceAccountFromShorthand);
+    (0, encoding_1.convertIfPresent)(annotation, opts, 'timeout', 'timeoutSeconds', encoding_1.durationFromSeconds);
+    (0, encoding_1.convertIfPresent)(annotation, opts, 'failurePolicy', 'retry', (retry) => {
         return retry ? { retry: true } : null;
     });
     return annotation;
@@ -144,31 +144,23 @@ exports.optionsToTriggerAnnotations = optionsToTriggerAnnotations;
  */
 function optionsToEndpoint(opts) {
     const endpoint = {};
-    encoding_1.copyIfPresent(endpoint, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'timeoutSeconds');
-    encoding_1.convertIfPresent(endpoint, opts, 'serviceAccountEmail', 'serviceAccount');
+    (0, encoding_1.copyIfPresent)(endpoint, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'timeoutSeconds', 'cpu');
+    (0, encoding_1.convertIfPresent)(endpoint, opts, 'serviceAccountEmail', 'serviceAccount');
     if (opts.vpcConnector) {
         const vpc = { connector: opts.vpcConnector };
-        encoding_1.convertIfPresent(vpc, opts, 'egressSettings', 'vpcConnectorEgressSettings');
+        (0, encoding_1.convertIfPresent)(vpc, opts, 'egressSettings', 'vpcConnectorEgressSettings');
         endpoint.vpc = vpc;
     }
-    encoding_1.convertIfPresent(endpoint, opts, 'availableMemoryMb', 'memory', (mem) => {
-        const memoryLookup = {
-            '128MB': 128,
-            '256MB': 256,
-            '512MB': 512,
-            '1GB': 1024,
-            '2GB': 2048,
-            '4GB': 4096,
-            '8GB': 8192,
-        };
-        return memoryLookup[mem];
+    (0, encoding_1.convertIfPresent)(endpoint, opts, 'availableMemoryMb', 'memory', (mem) => {
+        return MemoryOptionToMB[mem];
     });
-    encoding_1.convertIfPresent(endpoint, opts, 'region', 'region', (region) => {
+    (0, encoding_1.convertIfPresent)(endpoint, opts, 'region', 'region', (region) => {
         if (typeof region === 'string') {
             return [region];
         }
         return region;
     });
+    (0, encoding_1.convertIfPresent)(endpoint, opts, 'secretEnvironmentVariables', 'secrets', (secrets) => secrets.map((secret) => ({ key: secret })));
     return endpoint;
 }
 exports.optionsToEndpoint = optionsToEndpoint;

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

@@ -4,18 +4,27 @@ import * as options from '../../options';
  * The CloudEvent data emitted by Firebase Alerts.
  */
 export interface FirebaseAlertData<T = any> {
+    /** Time that the event has created. */
     createTime: string;
+    /** Time that the event has ended. Optional, only present for ongoing alerts. */
     endTime: string;
+    /** Payload of the event, which includes the details of the specific alert. */
     payload: T;
 }
-interface WithAlertTypeAndApp {
-    alertType: string;
-    appId?: string;
-}
 /**
  * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
  */
-export declare type AlertEvent<T> = CloudEvent<FirebaseAlertData<T>, WithAlertTypeAndApp>;
+export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
+    /** The type of the alerts that got triggered. */
+    alertType: string;
+    /**
+     * The Firebase App ID that’s associated with the alert. This is optional,
+     * 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: FirebaseAlertData<T>;
+}
 /** The underlying alert type of the Firebase Alerts provider. */
 export declare type AlertType = 'crashlytics.newFatalIssue' | 'crashlytics.newNonfatalIssue' | 'crashlytics.regression' | 'crashlytics.stabilityDigest' | 'crashlytics.velocity' | 'crashlytics.newAnrIssue' | 'billing.planUpdate' | 'billing.automatedPlanUpdate' | 'appDistribution.newTesterIosDevice' | string;
 /**
@@ -32,5 +41,4 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
  */
 export declare function onAlertPublished<T extends {
     ['@type']: string;
-} = any>(alertTypeOrOpts: AlertType | FirebaseAlertOptions, handler: (event: AlertEvent<T>) => any | Promise<any>): CloudFunction<FirebaseAlertData<T>>;
-export {};
+} = any>(alertTypeOrOpts: AlertType | FirebaseAlertOptions, handler: (event: AlertEvent<T>) => any | Promise<any>): CloudFunction<AlertEvent<T>>;

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

@@ -1,25 +1,26 @@
-import { FirebaseAlertData } from './alerts';
 import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
+import { FirebaseAlertData } from './alerts';
 /**
  * The internal payload object for adding a new tester device to app distribution.
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface NewTesterDevicePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.NewTesterDevicePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroNewTesterIosDevicePayload';
     testerName: string;
     testerEmail: string;
     testerDeviceModelName: string;
     testerDeviceIdentifier: string;
 }
-interface WithAlertTypeAndApp {
-    alertType: string;
-    appId: string;
-}
 /**
  * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
  */
-export declare type AppDistributionEvent<T> = CloudEvent<FirebaseAlertData<T>, WithAlertTypeAndApp>;
+export interface AppDistributionEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
+    /** The type of the alerts that got triggered. */
+    alertType: string;
+    /** The Firebase App ID that’s associated with the alert. */
+    appId: string;
+}
 /**
  * Configuration for app distribution functions.
  */
@@ -29,7 +30,6 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
 /**
  * Declares a function that can handle adding a new tester iOS device.
  */
-export declare function onNewTesterIosDevicePublished(handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewTesterDevicePayload>>;
-export declare function onNewTesterIosDevicePublished(appId: string, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewTesterDevicePayload>>;
-export declare function onNewTesterIosDevicePublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewTesterDevicePayload>>;
-export {};
+export declare function onNewTesterIosDevicePublished(handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;
+export declare function onNewTesterIosDevicePublished(appId: string, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;
+export declare function onNewTesterIosDevicePublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;

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

@@ -14,7 +14,7 @@ function onNewTesterIosDevicePublished(appIdOrOptsOrHandler, handler) {
         return handler(raw);
     };
     func.run = handler;
-    func.__endpoint = alerts_1.getEndpointAnnotation(opts, exports.newTesterIosDeviceAlert, appId);
+    func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.newTesterIosDeviceAlert, appId);
     return func;
 }
 exports.onNewTesterIosDevicePublished = onNewTesterIosDevicePublished;

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

@@ -6,33 +6,39 @@ import * as options from '../../options';
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface PlanUpdatePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.PlanUpdatePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.BillingPlanUpdatePayload';
+    /** A Firebase billing plan. */
     billingPlan: string;
+    /** The email address of the person that triggered billing plan change */
     principalEmail: string;
+    /** The type of the notification, e.g. upgrade, downgrade */
+    notificationType: string;
 }
 /**
  * The internal payload object for billing plan automated updates.
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface PlanAutomatedUpdatePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.PlanAutomatedUpdatePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.BillingPlanAutomatedUpdatePayload';
+    /** A Firebase billing plan. */
     billingPlan: string;
-}
-interface WithAlertType {
-    alertType: string;
+    /** The type of the notification, e.g. upgrade, downgrade */
+    notificationType: string;
 }
 /**
  * A custom CloudEvent for billing Firebase Alerts (with custom extension attributes).
  */
-export declare type BillingEvent<T> = CloudEvent<FirebaseAlertData<T>, WithAlertType>;
+export interface BillingEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
+    /** The type of the alerts that got triggered. */
+    alertType: string;
+}
 /**
  * Declares a function that can handle a billing plan update event.
  */
-export declare function onPlanUpdatePublished(handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanUpdatePayload>>;
-export declare function onPlanUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanUpdatePayload>>;
+export declare function onPlanUpdatePublished(handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanUpdatePayload>>;
+export declare function onPlanUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanUpdatePayload>>;
 /**
  * Declares a function that can handle an automated billing plan update event.
  */
-export declare function onPlanAutomatedUpdatePublished(handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
-export declare function onPlanAutomatedUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
-export {};
+export declare function onPlanAutomatedUpdatePublished(handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;
+export declare function onPlanAutomatedUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;

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

@@ -24,7 +24,7 @@ function onOperation(alertType, optsOrHandler, handler) {
         return handler(raw);
     };
     func.run = handler;
-    func.__endpoint = _1.getEndpointAnnotation(optsOrHandler, alertType);
+    func.__endpoint = (0, _1.getEndpointAnnotation)(optsOrHandler, alertType);
     return func;
 }
 exports.onOperation = onOperation;

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

@@ -13,7 +13,8 @@ interface Issue {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface NewFatalIssuePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.CrashlyticsNewFatalIssuePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewFatalIssuePayload';
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
 }
 /**
@@ -21,7 +22,8 @@ export interface NewFatalIssuePayload {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface NewNonfatalIssuePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.CrashlyticsNewNonfatalIssuePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewNonfatalIssuePayload';
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
 }
 /**
@@ -29,16 +31,26 @@ export interface NewNonfatalIssuePayload {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface RegressionAlertPayload {
-    ['@type']: 'com.google.firebase.firebasealerts.CrashlyticsRegressionAlertPayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsRegressionAlertPayload';
+    /** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */
     type: string;
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
+    /**
+     * The time that the Crashlytics issues was most recently resolved before it
+     * began to reoccur.
+     */
     resolveTime: string;
 }
 /** Generic crashlytics trending issue interface */
 interface TrendingIssueDetails {
+    /** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */
     type: string;
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
+    /** The number of crashes that occurred with the issue */
     eventCount: number;
+    /** The number of distinct users that were affected by the issue */
     userCount: number;
 }
 /**
@@ -46,8 +58,13 @@ interface TrendingIssueDetails {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface StabilityDigestPayload {
-    ['@type']: 'com.google.firebase.firebasealerts.CrashlyticsStabilityDigestPayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsStabilityDigestPayload';
+    /**
+     * The date that the digest gets created. Issues in the digest should have the
+     * same date as the digest date
+     */
     digestDate: string;
+    /** A stability digest containing several trending Crashlytics issues */
     trendingIssues: TrendingIssueDetails[];
 }
 /**
@@ -55,11 +72,25 @@ export interface StabilityDigestPayload {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface VelocityAlertPayload {
-    ['@type']: 'com.google.firebase.firebasealerts.VelocityAlertPayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsVelocityAlertPayload';
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
+    /** The time that the Crashlytics issue gets created */
     createTime: string;
+    /**
+     * The number of user sessions for the given app version that had this
+     * specific crash issue in the time period used to trigger the velocity alert.
+     */
     crashCount: number;
+    /**
+     * The percentage of user sessions for the given app version that had this
+     * specific crash issue in the time period used to trigger the velocity alert.
+     */
     crashPercentage: number;
+    /**
+     * The first app version where this issue was seen, and not necessarily the
+     * version that has triggered the alert.
+     */
     firstVersion: string;
 }
 /**
@@ -67,17 +98,19 @@ export interface VelocityAlertPayload {
  * Payload is wrapped inside a FirebaseAlertData object.
  */
 export interface NewAnrIssuePayload {
-    ['@type']: 'com.google.firebase.firebasealerts.NewAnrIssuePayload';
+    ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewAnrIssuePayload';
+    /** Basic information of the Crashlytics issue */
     issue: Issue;
 }
-interface WithAlertTypeAndApp {
-    alertType: string;
-    appId: string;
-}
 /**
  * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
  */
-export declare type CrashlyticsEvent<T> = CloudEvent<FirebaseAlertData<T>, WithAlertTypeAndApp>;
+export interface CrashlyticsEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
+    /** The type of the alerts that got triggered. */
+    alertType: string;
+    /** The Firebase App ID that’s associated with the alert. */
+    appId: string;
+}
 /**
  * Configuration for crashlytics functions.
  */
@@ -87,37 +120,37 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
 /**
  * Declares a function that can handle a new fatal issue published to crashlytics.
  */
-export declare function onNewFatalIssuePublished(handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewFatalIssuePayload>>;
-export declare function onNewFatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewFatalIssuePayload>>;
-export declare function onNewFatalIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewFatalIssuePayload>>;
+export declare function onNewFatalIssuePublished(handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
+export declare function onNewFatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
+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.
  */
-export declare function onNewNonfatalIssuePublished(handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewNonfatalIssuePayload>>;
-export declare function onNewNonfatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewNonfatalIssuePayload>>;
-export declare function onNewNonfatalIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewNonfatalIssuePayload>>;
+export declare function onNewNonfatalIssuePublished(handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
+export declare function onNewNonfatalIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
+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.
  */
-export declare function onRegressionAlertPublished(handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<RegressionAlertPayload>>;
-export declare function onRegressionAlertPublished(appId: string, handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<RegressionAlertPayload>>;
-export declare function onRegressionAlertPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<RegressionAlertPayload>>;
+export declare function onRegressionAlertPublished(handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
+export declare function onRegressionAlertPublished(appId: string, handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
+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.
  */
-export declare function onStabilityDigestPublished(handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<StabilityDigestPayload>>;
-export declare function onStabilityDigestPublished(appId: string, handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<StabilityDigestPayload>>;
-export declare function onStabilityDigestPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<StabilityDigestPayload>>;
+export declare function onStabilityDigestPublished(handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
+export declare function onStabilityDigestPublished(appId: string, handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
+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.
  */
-export declare function onVelocityAlertPublished(handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<VelocityAlertPayload>>;
-export declare function onVelocityAlertPublished(appId: string, handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<VelocityAlertPayload>>;
-export declare function onVelocityAlertPublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<VelocityAlertPayload>>;
+export declare function onVelocityAlertPublished(handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
+export declare function onVelocityAlertPublished(appId: string, handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
+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.
  */
-export declare function onNewAnrIssuePublished(handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewAnrIssuePayload>>;
-export declare function onNewAnrIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewAnrIssuePayload>>;
-export declare function onNewAnrIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<NewAnrIssuePayload>>;
+export declare function onNewAnrIssuePublished(handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
+export declare function onNewAnrIssuePublished(appId: string, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
+export declare function onNewAnrIssuePublished(opts: CrashlyticsOptions, handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
 export {};

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

@@ -49,7 +49,7 @@ function onOperation(alertType, appIdOrOptsOrHandler, handler) {
         return handler(raw);
     };
     func.run = handler;
-    func.__endpoint = _1.getEndpointAnnotation(opts, alertType, appId);
+    func.__endpoint = (0, _1.getEndpointAnnotation)(opts, alertType, appId);
     return func;
 }
 exports.onOperation = onOperation;

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

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -1,5 +1,5 @@
-import * as options from '../options';
 import { CloudEvent, CloudFunction } from '../core';
+import * as options from '../options';
 /** Options that can be set on an Eventarc trigger. */
 export interface EventarcTriggerOptions extends options.EventHandlerOptions {
     /**

package/lib/v2/providers/eventarc.js

@@ -22,8 +22,8 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onCustomEventPublished = void 0;
-const options = require("../options");
 const encoding_1 = require("../../common/encoding");
+const options = require("../options");
 function onCustomEventPublished(eventTypeOrOpts, handler) {
     var _a;
     let opts;
@@ -57,8 +57,8 @@ function onCustomEventPublished(eventTypeOrOpts, handler) {
             channel,
         },
     };
-    encoding_1.convertIfPresent(endpoint.eventTrigger, opts, 'eventFilters', 'filters');
-    encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry');
+    (0, encoding_1.convertIfPresent)(endpoint.eventTrigger, opts, 'eventFilters', 'filters');
+    (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry');
     func.__endpoint = endpoint;
     return func;
 }

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

@@ -1,10 +1,13 @@
 import * as express from 'express';
-import * as options from '../options';
 import { CallableRequest, FunctionsErrorCode, HttpsError, Request } from '../../common/providers/https';
 import { ManifestEndpoint } from '../../runtime/manifest';
+import { GlobalOptions, SupportedRegion } from '../options';
 export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
-export interface HttpsOptions extends Omit<options.GlobalOptions, 'region'> {
-    region?: options.SupportedRegion | string | Array<options.SupportedRegion | string>;
+/**
+ * Options that can be set on an individual HTTPS Cloud Function.
+ */
+export interface HttpsOptions extends Omit<GlobalOptions, 'region'> {
+    region?: SupportedRegion | string | Array<SupportedRegion | string>;
     cors?: string | boolean | RegExp | Array<string | RegExp>;
 }
 export declare type HttpsFunction = ((req: Request, res: express.Response) => void | Promise<void>) & {

package/lib/v2/providers/https.js

@@ -24,9 +24,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.onCall = exports.onRequest = exports.HttpsError = void 0;
 const cors = require("cors");
 const encoding_1 = require("../../common/encoding");
-const options = require("../options");
 const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
+const options = require("../options");
 function onRequest(optsOrHandler, handler) {
     let opts;
     if (arguments.length === 1) {
@@ -54,9 +54,6 @@ function onRequest(optsOrHandler, handler) {
             // but optionsToTriggerAnnotations handles both cases.
             const specificOpts = options.optionsToTriggerAnnotations(opts);
             const trigger = {
-                // TODO(inlined): Remove "apiVersion" once the latest version of the CLI
-                // has migrated to "platform".
-                apiVersion: 2,
                 platform: 'gcfv2',
                 ...baseOpts,
                 ...specificOpts,
@@ -68,7 +65,7 @@ function onRequest(optsOrHandler, handler) {
                     allowInsecure: false,
                 },
             };
-            encoding_1.convertIfPresent(trigger.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+            (0, encoding_1.convertIfPresent)(trigger.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
             return trigger;
         },
     });
@@ -86,7 +83,7 @@ function onRequest(optsOrHandler, handler) {
         },
         httpsTrigger: {},
     };
-    encoding_1.convertIfPresent(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    (0, encoding_1.convertIfPresent)(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
     handler.__endpoint = endpoint;
     return handler;
 }
@@ -104,7 +101,7 @@ function onCall(optsOrHandler, handler) {
     // 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);
-    const func = https_1.onCallHandler({ cors: { origin, methods: 'POST' } }, fixedLen);
+    const func = (0, https_1.onCallHandler)({ cors: { origin, methods: 'POST' } }, fixedLen);
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -112,9 +109,6 @@ function onCall(optsOrHandler, handler) {
             // but optionsToTriggerAnnotations handles both cases.
             const specificOpts = options.optionsToTriggerAnnotations(opts);
             return {
-                // TODO(inlined): Remove "apiVersion" once the latest version of the CLI
-                // has migrated to "platform".
-                apiVersion: 2,
                 platform: 'gcfv2',
                 ...baseOpts,
                 ...specificOpts,
@@ -131,7 +125,7 @@ function onCall(optsOrHandler, handler) {
     });
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     // global options calls region a scalar and https allows it to be an array,
-    // but optionsToManifestEndpoint handles both cases.
+    // but optionsToEndpoint handles both cases.
     const specificOpts = options.optionsToEndpoint(opts);
     func.__endpoint = {
         platform: 'gcfv2',

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

@@ -0,0 +1,22 @@
+import { BlockingFunction } from '../../cloud-functions';
+import { AuthBlockingEvent, BeforeCreateResponse, BeforeSignInResponse, HttpsError } from '../../common/providers/identity';
+import * as options from '../options';
+export { HttpsError };
+/**
+ * All function options plus idToken, accessToken, and refreshToken.
+ */
+export interface BlockingOptions extends options.GlobalOptions {
+    idToken?: boolean;
+    accessToken?: boolean;
+    refreshToken?: boolean;
+}
+/**
+ * Handle an event that is triggered before a user is created.
+ */
+export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
+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.
+ */
+export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
+export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;