firebase-functions 7.0.4 → 7.0.5

package/lib/esm/v2/providers/pubsub.mjs

@@ -10,6 +10,8 @@ var pubsub_exports = /* @__PURE__ */ __export({
 	Message: () => Message,
 	onMessagePublished: () => onMessagePublished
 });
+const V1_CONTEXT = Symbol("v1Context");
+const V1_MESSAGE = Symbol("v1Message");
 /**
 * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
 * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
@@ -101,7 +103,67 @@ function onMessagePublished(topicOrOptions, handler) {
 	}
 	const func = (raw) => {
 		const messagePublishedData = raw.data;
-		messagePublishedData.message = new Message(messagePublishedData.message);
+		if (!(messagePublishedData.message instanceof Message)) {
+			messagePublishedData.message = new Message(messagePublishedData.message);
+		}
+		/**
+		* Get the v1-compatible EventContext object.
+		* This is a compatibility layer to ease migration from v1 to v2.
+		* @returns A v1 EventContext-like object.
+		*/
+		Object.defineProperty(raw, "context", { get: function() {
+			if (this[V1_CONTEXT]) {
+				return this[V1_CONTEXT];
+			}
+			const data = this.data;
+			if (!data?.message) {
+				throw new Error("Malformed Pub/Sub event: 'data.message' is missing.");
+			}
+			const v1Context = {
+				eventId: data.message.messageId,
+				timestamp: data.message.publishTime,
+				eventType: "google.pubsub.topic.publish",
+				resource: {
+					service: "pubsub.googleapis.com",
+					name: this.source.replace("//pubsub.googleapis.com/", "")
+				},
+				params: {}
+			};
+			this[V1_CONTEXT] = v1Context;
+			return this[V1_CONTEXT];
+		} });
+		/**
+		* Get the v1-compatible Message object.
+		* This is a compatibility layer to ease migration from v1 to v2.
+		* @returns A plain object mimicking the v1 Message structure.
+		*/
+		Object.defineProperty(raw, "message", { get: function() {
+			if (this[V1_MESSAGE]) {
+				return this[V1_MESSAGE];
+			}
+			const data = this.data;
+			if (!data || !data.message) {
+				throw new Error("Malformed Pub/Sub event: 'data.message' is missing.");
+			}
+			const v2Message = data.message;
+			const baseMessage = {
+				data: v2Message.data,
+				messageId: v2Message.messageId,
+				publishTime: v2Message.publishTime,
+				attributes: v2Message.attributes || {}
+			};
+			if (v2Message.orderingKey) {
+				baseMessage.orderingKey = v2Message.orderingKey;
+			}
+			this[V1_MESSAGE] = {
+				...baseMessage,
+				get json() {
+					return v2Message.json;
+				},
+				toJSON: () => baseMessage
+			};
+			return this[V1_MESSAGE];
+		} });
 		return wrapTraceContext(withInit(handler))(raw);
 	};
 	func.run = handler;

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

@@ -1,5 +1,6 @@
 import { ResetValue } from "../../common/options";
 import { CloudEvent, CloudFunction } from "../core";
+import type { EventContext } from "../../v1/index";
 import { Expression } from "../../params";
 import * as options from "../options";
 import { SupportedSecretParam } from "../../params/types";
@@ -80,6 +81,33 @@ export interface MessagePublishedData<T = any> {
     /** A subscription resource. */
     readonly subscription: string;
 }
+/**
+ * A v1-compatible Pub/Sub Message.
+ * Note: This is a plain object mimicking the v1 Message structure, not an instance of the v1 Message class.
+ * @typeParam T - Type of `json` payload.
+ */
+export interface V1PubSubMessage<T = any> {
+    readonly data: string;
+    readonly attributes: {
+        [key: string]: string;
+    };
+    readonly messageId: string;
+    readonly publishTime: string;
+    readonly orderingKey?: string;
+    readonly json: T;
+    toJSON(): any;
+}
+export interface MessagePublishedEvent<T = any> extends CloudEvent<MessagePublishedData<T>> {
+    /**
+     * v1-compatible EventContext.
+     */
+    readonly context: EventContext;
+    /**
+     * v1-compatible Pub/Sub Message.
+     * Note: This is a plain object mimicking the v1 Message structure, not an instance of the v1 Message class.
+     */
+    readonly message: V1PubSubMessage<T>;
+}
 /** PubSubOptions extend EventHandlerOptions but must include a topic. */
 export interface PubSubOptions extends options.EventHandlerOptions {
     /** The Pub/Sub topic to watch for message events */
@@ -171,11 +199,11 @@ export interface PubSubOptions extends options.EventHandlerOptions {
  * @param handler - runs every time a Cloud Pub/Sub message is published
  * @typeParam T - Type representing `Message.data`'s JSON format
  */
-export declare function onMessagePublished<T = any>(topic: string, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;
+export declare function onMessagePublished<T = any>(topic: string, handler: (event: MessagePublishedEvent<T>) => any | Promise<any>): CloudFunction<MessagePublishedEvent<T>>;
 /**
  * Handle a message being published to a Pub/Sub topic.
  * @param options - Option containing information (topic) for event
  * @param handler - runs every time a Cloud Pub/Sub message is published
  * @typeParam T - Type representing `Message.data`'s JSON format
  */
-export declare function onMessagePublished<T = any>(options: PubSubOptions, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;
+export declare function onMessagePublished<T = any>(options: PubSubOptions, handler: (event: MessagePublishedEvent<T>) => any | Promise<any>): CloudFunction<MessagePublishedEvent<T>>;

package/lib/v2/providers/pubsub.js

@@ -10,6 +10,8 @@ var pubsub_exports = /* @__PURE__ */ require_rolldown_runtime.__export({
 	Message: () => Message,
 	onMessagePublished: () => onMessagePublished
 });
+const V1_CONTEXT = Symbol("v1Context");
+const V1_MESSAGE = Symbol("v1Message");
 /**
 * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
 * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
@@ -101,7 +103,67 @@ function onMessagePublished(topicOrOptions, handler) {
 	}
 	const func = (raw) => {
 		const messagePublishedData = raw.data;
-		messagePublishedData.message = new Message(messagePublishedData.message);
+		if (!(messagePublishedData.message instanceof Message)) {
+			messagePublishedData.message = new Message(messagePublishedData.message);
+		}
+		/**
+		* Get the v1-compatible EventContext object.
+		* This is a compatibility layer to ease migration from v1 to v2.
+		* @returns A v1 EventContext-like object.
+		*/
+		Object.defineProperty(raw, "context", { get: function() {
+			if (this[V1_CONTEXT]) {
+				return this[V1_CONTEXT];
+			}
+			const data = this.data;
+			if (!data?.message) {
+				throw new Error("Malformed Pub/Sub event: 'data.message' is missing.");
+			}
+			const v1Context = {
+				eventId: data.message.messageId,
+				timestamp: data.message.publishTime,
+				eventType: "google.pubsub.topic.publish",
+				resource: {
+					service: "pubsub.googleapis.com",
+					name: this.source.replace("//pubsub.googleapis.com/", "")
+				},
+				params: {}
+			};
+			this[V1_CONTEXT] = v1Context;
+			return this[V1_CONTEXT];
+		} });
+		/**
+		* Get the v1-compatible Message object.
+		* This is a compatibility layer to ease migration from v1 to v2.
+		* @returns A plain object mimicking the v1 Message structure.
+		*/
+		Object.defineProperty(raw, "message", { get: function() {
+			if (this[V1_MESSAGE]) {
+				return this[V1_MESSAGE];
+			}
+			const data = this.data;
+			if (!data || !data.message) {
+				throw new Error("Malformed Pub/Sub event: 'data.message' is missing.");
+			}
+			const v2Message = data.message;
+			const baseMessage = {
+				data: v2Message.data,
+				messageId: v2Message.messageId,
+				publishTime: v2Message.publishTime,
+				attributes: v2Message.attributes || {}
+			};
+			if (v2Message.orderingKey) {
+				baseMessage.orderingKey = v2Message.orderingKey;
+			}
+			this[V1_MESSAGE] = {
+				...baseMessage,
+				get json() {
+					return v2Message.json;
+				},
+				toJSON: () => baseMessage
+			};
+			return this[V1_MESSAGE];
+		} });
 		return require_v2_trace.wrapTraceContext(require_common_onInit.withInit(handler))(raw);
 	};
 	func.run = handler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "7.0.4",
+  "version": "7.0.5",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",