firebase-functions 4.5.0 → 4.6.0

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

@@ -9,16 +9,17 @@ export { HttpsError };
  */
 export type AuthBlockingEventType = "beforeCreate" | "beforeSignIn";
 /**
- * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin
- * SDK.
+ * The `UserRecord` passed to Cloud Functions is the same
+ * {@link https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.userrecord | UserRecord}
+ * that is returned by the Firebase Admin SDK.
  */
 export type UserRecord = auth.UserRecord;
 /**
- * UserInfo that is part of the UserRecord
+ * `UserInfo` that is part of the `UserRecord`.
  */
 export type UserInfo = auth.UserInfo;
 /**
- * Helper class to create the user metadata in a UserRecord object
+ * Helper class to create the user metadata in a `UserRecord` object.
  */
 export declare class UserRecordMetadata implements auth.UserMetadata {
     creationTime: string;
@@ -28,13 +29,13 @@ export declare class UserRecordMetadata implements auth.UserMetadata {
     toJSON(): AuthUserMetadata;
 }
 /**
- * Helper function that creates a UserRecord Class from data sent over the wire.
+ * Helper function that creates a `UserRecord` class from data sent over the wire.
  * @param wireData data sent over the wire
- * @returns an instance of UserRecord with correct toJSON functions
+ * @returns an instance of `UserRecord` with correct toJSON functions
  */
 export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;
 /**
- * User info that is part of the AuthUserRecord
+ * User info that is part of the `AuthUserRecord`.
  */
 export interface AuthUserInfo {
     /**
@@ -110,7 +111,7 @@ export interface AuthMultiFactorSettings {
     enrolledFactors: AuthMultiFactorInfo[];
 }
 /**
- * The UserRecord passed to auth blocking Cloud Functions from the identity platform.
+ * The `UserRecord` passed to auth blocking functions from the identity platform.
  */
 export interface AuthUserRecord {
     /**
@@ -205,7 +206,7 @@ export interface AuthEventContext extends EventContext {
     additionalUserInfo?: AdditionalUserInfo;
     credential?: Credential;
 }
-/** Defines the auth event for v2 blocking events */
+/** Defines the auth event for 2nd gen blocking events */
 export interface AuthBlockingEvent extends AuthEventContext {
     data: AuthUserRecord;
 }
@@ -213,7 +214,7 @@ export interface AuthBlockingEvent extends AuthEventContext {
  * The reCAPTCHA action options.
  */
 export type RecaptchaActionOptions = "ALLOW" | "BLOCK";
-/** The handler response type for beforeCreate blocking events */
+/** The handler response type for `beforeCreate` blocking events */
 export interface BeforeCreateResponse {
     displayName?: string;
     disabled?: boolean;
@@ -222,7 +223,7 @@ export interface BeforeCreateResponse {
     customClaims?: object;
     recaptchaActionOverride?: RecaptchaActionOptions;
 }
-/** The handler response type for beforeSignIn blocking events */
+/** The handler response type for `beforeSignIn` blocking events */
 export interface BeforeSignInResponse extends BeforeCreateResponse {
     sessionClaims?: object;
 }

package/lib/common/providers/identity.js

@@ -51,7 +51,7 @@ const EVENT_MAPPING = {
     beforeSignIn: "providers/cloud.auth/eventTypes/user.beforeSignIn",
 };
 /**
- * Helper class to create the user metadata in a UserRecord object
+ * Helper class to create the user metadata in a `UserRecord` object.
  */
 class UserRecordMetadata {
     constructor(creationTime, lastSignInTime) {
@@ -68,9 +68,9 @@ class UserRecordMetadata {
 }
 exports.UserRecordMetadata = UserRecordMetadata;
 /**
- * Helper function that creates a UserRecord Class from data sent over the wire.
+ * Helper function that creates a `UserRecord` class from data sent over the wire.
  * @param wireData data sent over the wire
- * @returns an instance of UserRecord with correct toJSON functions
+ * @returns an instance of `UserRecord` with correct toJSON functions
  */
 function userRecordConstructor(wireData) {
     // Falsey values from the wire format proto get lost when converted to JSON, this adds them back.
@@ -122,7 +122,7 @@ function userRecordConstructor(wireData) {
 }
 exports.userRecordConstructor = userRecordConstructor;
 /**
- * Checks for a valid identity platform web request, otherwise throws an HttpsError
+ * Checks for a valid identity platform web request, otherwise throws an HttpsError.
  * @internal
  */
 function isValidRequest(req) {
@@ -156,7 +156,7 @@ function unsafeDecodeAuthBlockingToken(token) {
     return decoded;
 }
 /**
- * Helper function to parse the decoded metadata object into a UserMetaData object
+ * Helper function to parse the decoded metadata object into a `UserMetaData` object
  * @internal
  */
 function parseMetadata(metadata) {
@@ -173,7 +173,7 @@ function parseMetadata(metadata) {
 }
 exports.parseMetadata = parseMetadata;
 /**
- * Helper function to parse the decoded user info array into an AuthUserInfo array
+ * Helper function to parse the decoded user info array into an `AuthUserInfo` array.
  * @internal
  */
 function parseProviderData(providerData) {
@@ -192,7 +192,7 @@ function parseProviderData(providerData) {
 }
 exports.parseProviderData = parseProviderData;
 /**
- * Helper function to parse the date into a UTC string
+ * Helper function to parse the date into a UTC string.
  * @internal
  */
 function parseDate(tokensValidAfterTime) {
@@ -276,7 +276,7 @@ function parseAuthUserRecord(decodedJWTUserRecord) {
     };
 }
 exports.parseAuthUserRecord = parseAuthUserRecord;
-/** Helper to get the AdditionalUserInfo from the decoded jwt */
+/** Helper to get the `AdditionalUserInfo` from the decoded JWT */
 function parseAdditionalUserInfo(decodedJWT) {
     let profile;
     let username;
@@ -327,7 +327,7 @@ function generateResponsePayload(authResponse) {
     return result;
 }
 exports.generateResponsePayload = generateResponsePayload;
-/** Helper to get the Credential from the decoded jwt */
+/** Helper to get the Credential from the decoded JWT */
 function parseAuthCredential(decodedJWT, time) {
     if (!decodedJWT.sign_in_attributes &&
         !decodedJWT.oauth_id_token &&

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

@@ -61,8 +61,8 @@ export interface TaskContext {
     /**
      * The "short" name of the task, or, if no name was specified at creation, a unique
      * system-generated id.
-     * This is the my-task-id value in the complete task name, ie, task_name =
-     * projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id.
+     * This is the "my-task-id" value in the complete task name, such as "task_name =
+     * projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id."
      * Populated via the `X-CloudTasks-TaskName` header.
      */
     id: string;

package/lib/v1/function-configuration.d.ts

@@ -177,7 +177,8 @@ export interface RuntimeOptions {
      *
      * @remarks
      * Set this to true to enable the App Check replay protection feature by consuming the App Check token on callable
-     * request. Tokens that are found to be already consumed will have request.app.alreadyConsumed property set true.
+     * request. Tokens that are found to be already consumed will have the `request.app.alreadyConsumed` property set
+     * to true.
      *
      *
      * Tokens are only considered to be consumed if it is sent to the App Check service by setting this option to true.
@@ -188,10 +189,10 @@ export interface RuntimeOptions {
      * performance and can potentially deplete your attestation providers' quotas faster. Use this feature only for
      * protecting low volume, security critical, or expensive operations.
      *
-     * This option does not affect the enforceAppCheck option. Setting the latter to true will cause the callable function
-     * to automatically respond with a 401 Unauthorized status code when request includes an invalid App Check token.
-     * When request includes valid but consumed App Check tokens, requests will not be automatically rejected. Instead,
-     * the request.app.alreadyConsumed property will be set to true and pass the execution to the handler code for making
+     * This option does not affect the `enforceAppCheck` option. Setting the latter to true will cause the callable function
+     * to automatically respond with a 401 Unauthorized status code when the request includes an invalid App Check token.
+     * When the request includes valid but consumed App Check tokens, requests will not be automatically rejected. Instead,
+     * the `request.app.alreadyConsumed` property will be set to true and pass the execution to the handler code for making
      * further decisions, such as requiring additional security checks or rejecting the request.
      */
     consumeAppCheckToken?: boolean;

package/lib/v2/providers/https.js

@@ -119,11 +119,12 @@ 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 = (0, https_1.onCallHandler)({
+    let func = (0, https_1.onCallHandler)({
         cors: { origin, methods: "POST" },
         enforceAppCheck: (_a = opts.enforceAppCheck) !== null && _a !== void 0 ? _a : options.getGlobalOptions().enforceAppCheck,
         consumeAppCheckToken: opts.consumeAppCheckToken,
     }, fixedLen);
+    func = (0, trace_1.wrapTraceContext)(func);
     Object.defineProperty(func, "__trigger", {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -225,7 +225,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-prettier": "^4.0.0",
-    "firebase-admin": "^11.8.0",
+    "firebase-admin": "^12.0.0",
     "js-yaml": "^3.13.1",
     "jsdom": "^16.2.1",
     "jsonwebtoken": "^9.0.0",
@@ -245,7 +245,7 @@
     "yargs": "^15.3.1"
   },
   "peerDependencies": {
-    "firebase-admin": "^10.0.0 || ^11.0.0"
+    "firebase-admin": "^10.0.0 || ^11.0.0 || ^12.0.0"
   },
   "engines": {
     "node": ">=14.10.0"