firebase-functions 6.0.0 → 6.1.0

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

@@ -7,7 +7,7 @@ export { HttpsError };
  * @hidden
  * @alpha
  */
-export type AuthBlockingEventType = "beforeCreate" | "beforeSignIn";
+export type AuthBlockingEventType = "beforeCreate" | "beforeSignIn" | "beforeSendEmail" | "beforeSendSms";
 /**
  * The `UserRecord` passed to Cloud Functions is the same
  * {@link https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.userrecord | UserRecord}
@@ -179,11 +179,13 @@ export interface AuthUserRecord {
 }
 /** The additional user info component of the auth event context */
 export interface AdditionalUserInfo {
-    providerId: string;
+    providerId?: string;
     profile?: any;
     username?: string;
     isNewUser: boolean;
     recaptchaScore?: number;
+    email?: string;
+    phoneNumber?: string;
 }
 /** The credential component of the auth event context */
 export interface Credential {
@@ -198,6 +200,19 @@ export interface Credential {
     providerId: string;
     signInMethod: string;
 }
+/**
+ * Possible types of emails as described by the GCIP backend, which can be:
+ * - A sign-in email
+ * - A password reset email
+ */
+export type EmailType = "EMAIL_SIGN_IN" | "PASSWORD_RESET";
+/**
+ * The type of SMS message, which can be:
+ * - A sign-in or sign up SMS message
+ * - A multi-factor sign-in SMS message
+ * - A multi-factor enrollment SMS message
+ */
+export type SmsType = "SIGN_IN_OR_SIGN_UP" | "MULTI_FACTOR_SIGN_IN" | "MULTI_FACTOR_ENROLLMENT";
 /** Defines the auth event context for blocking events */
 export interface AuthEventContext extends EventContext {
     locale?: string;
@@ -205,15 +220,23 @@ export interface AuthEventContext extends EventContext {
     userAgent: string;
     additionalUserInfo?: AdditionalUserInfo;
     credential?: Credential;
+    emailType?: EmailType;
+    smsType?: SmsType;
 }
 /** Defines the auth event for 2nd gen blocking events */
 export interface AuthBlockingEvent extends AuthEventContext {
-    data: AuthUserRecord;
+    data?: AuthUserRecord;
 }
-/**
- * The reCAPTCHA action options.
- */
+/** The reCAPTCHA action options. */
 export type RecaptchaActionOptions = "ALLOW" | "BLOCK";
+/** The handler response type for `beforeEmailSent` blocking events */
+export interface BeforeEmailResponse {
+    recaptchaActionOverride?: RecaptchaActionOptions;
+}
+/** The handler response type for `beforeSmsSent` blocking events */
+export interface BeforeSmsResponse {
+    recaptchaActionOverride?: RecaptchaActionOptions;
+}
 /** The handler response type for `beforeCreate` blocking events */
 export interface BeforeCreateResponse {
     displayName?: string;
@@ -227,3 +250,9 @@ export interface BeforeCreateResponse {
 export interface BeforeSignInResponse extends BeforeCreateResponse {
     sessionClaims?: object;
 }
+export type MaybeAsync<T> = T | Promise<T>;
+export type HandlerV1 = (userOrContext: AuthUserRecord | AuthEventContext, context?: AuthEventContext) => MaybeAsync<BeforeCreateResponse | BeforeSignInResponse | BeforeEmailResponse | BeforeSmsResponse | void>;
+export type HandlerV2 = (event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | BeforeSignInResponse | BeforeEmailResponse | BeforeSmsResponse | void>;
+export type AuthBlockingEventHandler = (HandlerV1 | HandlerV2) & {
+    platform: "gcfv1" | "gcfv2";
+};

package/lib/common/providers/identity.js

@@ -49,6 +49,8 @@ const CLAIMS_MAX_PAYLOAD_SIZE = 1000;
 const EVENT_MAPPING = {
     beforeCreate: "providers/cloud.auth/eventTypes/user.beforeCreate",
     beforeSignIn: "providers/cloud.auth/eventTypes/user.beforeSignIn",
+    beforeSendEmail: "providers/cloud.auth/eventTypes/user.beforeSendEmail",
+    beforeSendSms: "providers/cloud.auth/eventTypes/user.beforeSendSms",
 };
 /**
  * Helper class to create the user metadata in a `UserRecord` object.
@@ -302,6 +304,8 @@ function parseAdditionalUserInfo(decodedJWT) {
         username,
         isNewUser: decodedJWT.event_type === "beforeCreate" ? true : false,
         recaptchaScore: decodedJWT.recaptcha_score,
+        email: decodedJWT.email,
+        phoneNumber: decodedJWT.phone_number,
     };
 }
 /**
@@ -372,6 +376,8 @@ function parseAuthEventContext(decodedJWT, projectId, time = new Date().getTime(
         timestamp: new Date(decodedJWT.iat * 1000).toUTCString(),
         additionalUserInfo: parseAdditionalUserInfo(decodedJWT),
         credential: parseAuthCredential(decodedJWT, time),
+        emailType: decodedJWT.email_type,
+        smsType: decodedJWT.sms_type,
         params: {},
     };
 }
@@ -443,15 +449,20 @@ function wrapHandler(eventType, handler) {
             }
             const decodedPayload = (0, debug_1.isDebugFeatureEnabled)("skipTokenVerification")
                 ? unsafeDecodeAuthBlockingToken(req.body.data.jwt)
-                : handler.length === 2
+                : handler.platform === "gcfv1"
                     ? await auth.getAuth((0, app_1.getApp)())._verifyAuthBlockingToken(req.body.data.jwt)
                     : await auth.getAuth((0, app_1.getApp)())._verifyAuthBlockingToken(req.body.data.jwt, "run.app");
-            const authUserRecord = parseAuthUserRecord(decodedPayload.user_record);
+            let authUserRecord;
+            if (decodedPayload.event_type === "beforeCreate" ||
+                decodedPayload.event_type === "beforeSignIn") {
+                authUserRecord = parseAuthUserRecord(decodedPayload.user_record);
+            }
             const authEventContext = parseAuthEventContext(decodedPayload, projectId);
             let authResponse;
-            if (handler.length === 2) {
-                authResponse =
-                    (await handler(authUserRecord, authEventContext)) || undefined;
+            if (handler.platform === "gcfv1") {
+                authResponse = authUserRecord
+                    ? (await handler(authUserRecord, authEventContext)) || undefined
+                    : (await handler(authEventContext)) || undefined;
             }
             else {
                 authResponse =

package/lib/v1/providers/auth.d.ts

@@ -1,4 +1,4 @@
-import { AuthEventContext, AuthUserRecord, BeforeCreateResponse, BeforeSignInResponse, HttpsError, UserInfo, UserRecord, userRecordConstructor, UserRecordMetadata } from "../../common/providers/identity";
+import { AuthEventContext, AuthUserRecord, BeforeCreateResponse, BeforeEmailResponse, BeforeSignInResponse, BeforeSmsResponse, HttpsError, MaybeAsync, UserInfo, UserRecord, userRecordConstructor, UserRecordMetadata } from "../../common/providers/identity";
 import { BlockingFunction, CloudFunction, EventContext } from "../cloud-functions";
 export { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor };
 export { HttpsError };
@@ -57,7 +57,7 @@ export declare class UserBuilder {
      *
      * @public
      */
-    beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeCreateResponse | void | Promise<BeforeCreateResponse> | Promise<void>): BlockingFunction;
+    beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;
     /**
      * Blocks request to sign-in a Firebase Auth user.
      *
@@ -65,7 +65,9 @@ export declare class UserBuilder {
      *
      * @public
      */
-    beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeSignInResponse | void | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;
+    beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;
+    beforeEmail(handler: (context: AuthEventContext) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
+    beforeSms(handler: (context: AuthEventContext) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;
     private onOperation;
     private beforeOperation;
 }

package/lib/v1/providers/auth.js

@@ -108,6 +108,12 @@ class UserBuilder {
     beforeSignIn(handler) {
         return this.beforeOperation(handler, "beforeSignIn");
     }
+    beforeEmail(handler) {
+        return this.beforeOperation(handler, "beforeSendEmail");
+    }
+    beforeSms(handler) {
+        return this.beforeOperation(handler, "beforeSendSms");
+    }
     onOperation(handler, eventType) {
         return (0, cloud_functions_1.makeCloudFunction)({
             handler,
@@ -126,10 +132,8 @@ class UserBuilder {
         const accessToken = ((_b = (_a = this.userOptions) === null || _a === void 0 ? void 0 : _a.blockingOptions) === null || _b === void 0 ? void 0 : _b.accessToken) || false;
         const idToken = ((_d = (_c = this.userOptions) === null || _c === void 0 ? void 0 : _c.blockingOptions) === null || _d === void 0 ? void 0 : _d.idToken) || false;
         const refreshToken = ((_f = (_e = this.userOptions) === null || _e === void 0 ? void 0 : _e.blockingOptions) === null || _f === void 0 ? void 0 : _f.refreshToken) || false;
-        // Create our own function that just calls the provided function so we know for sure that
-        // handler takes two arguments. This is something common/providers/identity depends on.
-        const wrappedHandler = (user, context) => handler(user, context);
-        const func = (0, identity_1.wrapHandler)(eventType, wrappedHandler);
+        const annotatedHandler = Object.assign(handler, { platform: "gcfv1" });
+        const func = (0, identity_1.wrapHandler)(eventType, annotatedHandler);
         const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
         func.__trigger = {
             labels: {},

package/lib/v2/index.d.ts

@@ -25,3 +25,7 @@ export { Change } from "../common/change";
 import * as params from "../params";
 export { params };
 export { config } from "../v1/config";
+import { setApp as setEmulatedAdminApp } from "../common/app";
+export declare const app: {
+    setEmulatedAdminApp: typeof setEmulatedAdminApp;
+};

package/lib/v2/index.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = exports.params = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
+exports.app = exports.config = exports.params = exports.Change = exports.onInit = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
 /**
  * The 2nd gen API for Cloud Functions for Firebase.
  * This SDK supports deep imports. For example, the namespace
@@ -68,3 +68,6 @@ exports.params = params;
 // TODO(danielylee): Remove in next major release.
 var config_1 = require("../v1/config");
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });
+// Required for v1 Emulator support.
+const app_1 = require("../common/app");
+exports.app = { setEmulatedAdminApp: app_1.setApp };

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

@@ -3,7 +3,7 @@
  * @packageDocumentation
  */
 import { ResetValue } from "../../common/options";
-import { AuthBlockingEvent, AuthBlockingEventType, AuthUserRecord, BeforeCreateResponse, BeforeSignInResponse, HttpsError } from "../../common/providers/identity";
+import { AuthBlockingEvent, AuthBlockingEventType, AuthUserRecord, BeforeCreateResponse, BeforeSignInResponse, BeforeEmailResponse, BeforeSmsResponse, HandlerV2, HttpsError, MaybeAsync } from "../../common/providers/identity";
 import { BlockingFunction } from "../../v1/cloud-functions";
 import { Expression } from "../../params";
 import * as options from "../options";
@@ -107,27 +107,49 @@ export interface BlockingOptions {
 }
 /**
  * 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
+ * @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;
+export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | 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
+ * @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;
+export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;
 /**
  * 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
+ * @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;
+export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSignInResponse | 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
+ * @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;
+export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before an email is sent to a user.
+ * @param handler - Event handler that is run before an email is sent to a user.
+ */
+export declare function beforeEmailSent(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before an email is sent to a user.
+ * @param opts - Object containing function options.
+ * @param handler - Event handler that is run before an email is sent to a user.
+ */
+export declare function beforeEmailSent(opts: Omit<BlockingOptions, "idToken" | "accessToken" | "refreshToken">, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before an SMS is sent to a user.
+ * @param handler - Event handler that is run before an SMS is sent to a user.
+ */
+export declare function beforeSmsSent(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;
+/**
+ * Handles an event that is triggered before an SMS is sent to a user.
+ * @param opts - Object containing function options.
+ * @param handler - Event handler that is run before an SMS is sent to a user.
+ */
+export declare function beforeSmsSent(opts: Omit<BlockingOptions, "idToken" | "accessToken" | "refreshToken">, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSmsResponse | 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;
+export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | BeforeSignInResponse | BeforeEmailResponse | BeforeSmsResponse | void>), handler: HandlerV2): BlockingFunction;
 /** @hidden */
 export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;

package/lib/v2/providers/identity.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOpts = exports.beforeOperation = exports.beforeUserSignedIn = exports.beforeUserCreated = exports.HttpsError = void 0;
+exports.getOpts = exports.beforeOperation = exports.beforeSmsSent = exports.beforeEmailSent = exports.beforeUserSignedIn = exports.beforeUserCreated = exports.HttpsError = void 0;
 const identity_1 = require("../../common/providers/identity");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return identity_1.HttpsError; } });
 const trace_1 = require("../trace");
@@ -29,9 +29,9 @@ const manifest_1 = require("../../runtime/manifest");
 const options = require("../options");
 const onInit_1 = require("../../common/onInit");
 /**
- * Handles an event that is triggered before a user is created
- * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation)
- * @param handler? - If defined, an event handler which is run every time before a user is created
+ * Handles an event that is triggered before a user is created.
+ * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation).
+ * @param handler? - If defined, an event handler which is run every time before a user is created.
  */
 function beforeUserCreated(optsOrHandler, handler) {
     return beforeOperation("beforeCreate", optsOrHandler, handler);
@@ -39,24 +39,42 @@ function beforeUserCreated(optsOrHandler, handler) {
 exports.beforeUserCreated = beforeUserCreated;
 /**
  * Handles an event that is triggered before a user is signed in.
- * @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin)
- * @param handler - Event handler which is run every time before a user is signed in
+ * @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin).
+ * @param handler - Event handler which is run every time before a user is signed in.
  */
 function beforeUserSignedIn(optsOrHandler, handler) {
     return beforeOperation("beforeSignIn", optsOrHandler, handler);
 }
 exports.beforeUserSignedIn = beforeUserSignedIn;
+/**
+ * Handles an event that is triggered before an email is sent to a user.
+ * @param optsOrHandler- Either an object containing function options, or an event handler that is run before an email is sent to a user.
+ * @param handler - Event handler that is run before an email is sent to a user.
+ */
+function beforeEmailSent(optsOrHandler, handler) {
+    return beforeOperation("beforeSendEmail", optsOrHandler, handler);
+}
+exports.beforeEmailSent = beforeEmailSent;
+/**
+ * Handles an event that is triggered before an SMS is sent to a user.
+ * @param optsOrHandler - Either an object containing function options, or an event handler that is run before an SMS is sent to a user.
+ * @param handler - Event handler that is run before an SMS is sent to a user.
+ */
+function beforeSmsSent(optsOrHandler, handler) {
+    return beforeOperation("beforeSendSms", optsOrHandler, handler);
+}
+exports.beforeSmsSent = beforeSmsSent;
 /** @hidden */
 function beforeOperation(eventType, optsOrHandler, handler) {
     if (!handler || typeof optsOrHandler === "function") {
         handler = optsOrHandler;
         optsOrHandler = {};
     }
-    const { opts, accessToken, idToken, refreshToken } = getOpts(optsOrHandler);
+    const { opts, ...blockingOptions } = getOpts(optsOrHandler);
     // Create our own function that just calls the provided function so we know for sure that
     // handler takes one argument. This is something common/providers/identity depends on.
-    const wrappedHandler = (event) => handler(event);
-    const func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)((0, identity_1.wrapHandler)(eventType, wrappedHandler)));
+    const annotatedHandler = Object.assign(handler, { platform: "gcfv2" });
+    const func = (0, trace_1.wrapTraceContext)((0, onInit_1.withInit)((0, identity_1.wrapHandler)(eventType, annotatedHandler)));
     const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
     /** Endpoint */
     const baseOptsEndpoint = options.optionsToEndpoint(options.getGlobalOptions());
@@ -73,9 +91,7 @@ function beforeOperation(eventType, optsOrHandler, handler) {
         blockingTrigger: {
             eventType: legacyEventType,
             options: {
-                accessToken,
-                idToken,
-                refreshToken,
+                ...((eventType === "beforeCreate" || eventType === "beforeSignIn") && blockingOptions),
             },
         },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -270,9 +270,9 @@
   },
   "dependencies": {
     "@types/cors": "^2.8.5",
-    "@types/express": "4.17.3",
+    "@types/express": "^4.17.21",
     "cors": "^2.8.5",
-    "express": "^4.17.1",
+    "express": "^4.21.0",
     "protobufjs": "^7.2.2"
   },
   "devDependencies": {