firebase-functions 7.0.2 → 7.0.3

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

@@ -1,14 +1,20 @@
 import { __export } from "../../_virtual/rolldown_runtime.mjs";
 import { initV2Endpoint } from "../../runtime/manifest.mjs";
+import { convertIfPresent, convertInvoker } from "../../common/encoding.mjs";
 import { withInit } from "../../common/onInit.mjs";
+import { withErrorHandler } from "../../common/providers/https.mjs";
 import { normalizePath } from "../../common/utilities/path.mjs";
 import { wrapTraceContext } from "../trace.mjs";
 import { getGlobalOptions, optionsToEndpoint } from "../options.mjs";
 import { PathPattern } from "../../common/utilities/path-pattern.mjs";
+import express from "express";
+import fs from "fs";
 
 //#region src/v2/providers/dataconnect.ts
 var dataconnect_exports = /* @__PURE__ */ __export({
+	initGraphqlServer: () => initGraphqlServer,
 	mutationExecutedEventType: () => mutationExecutedEventType,
+	onGraphRequest: () => onGraphRequest,
 	onMutationExecuted: () => onMutationExecuted
 });
 /** @internal */
@@ -125,6 +131,81 @@ function onOperation(eventType, mutationOrOpts, handler) {
 	func.__endpoint = makeEndpoint(eventType, opts, servicePattern, connectorPattern, operationPattern);
 	return func;
 }
+/** @hidden */
+async function initGraphqlServer(opts) {
+	if (!opts.schema && !opts.schemaFilePath || opts.schema && opts.schemaFilePath) {
+		throw new Error("Exactly one of 'schema' or 'schemaFilePath' must be provided.");
+	}
+	if (opts.schemaFilePath) {
+		opts.schema = fs.readFileSync(opts.schemaFilePath, "utf-8");
+	}
+	if (!opts.resolvers.query && !opts.resolvers.mutation) {
+		throw new Error("At least one query or mutation resolver must be provided.");
+	}
+	const apolloResolvers = {};
+	if (opts.resolvers.query) {
+		apolloResolvers.Query = opts.resolvers.query;
+	}
+	if (opts.resolvers.mutation) {
+		apolloResolvers.Mutation = opts.resolvers.mutation;
+	}
+	try {
+		const { ApolloServer } = await import("@apollo/server");
+		const { expressMiddleware } = await import("@as-integrations/express4");
+		const serverPromise$1 = (async () => {
+			const app = express();
+			const server = new ApolloServer({
+				typeDefs: opts.schema,
+				resolvers: apolloResolvers
+			});
+			await server.start();
+			app.use(`/${opts.path ?? "graphql"}`, express.json(), expressMiddleware(server));
+			return app;
+		})();
+		return serverPromise$1;
+	} catch (e) {
+		if (e instanceof Error) {
+			throw new Error("Error initializing GraphQL server: " + e.message);
+		} else {
+			throw e;
+		}
+	}
+}
+let serverPromise = null;
+/**
+* @hidden
+* Handles HTTPS GraphQL requests.
+* @param {GraphqlServerOptions} opts - Options for configuring the GraphQL server.
+* @returns {HttpsFunction} A function you can export and deploy.
+*/
+function onGraphRequest(opts) {
+	const handler = wrapTraceContext(withInit(withErrorHandler(async (req, res) => {
+		serverPromise = serverPromise ?? initGraphqlServer(opts);
+		const app = await serverPromise;
+		app(req, res);
+	})));
+	const globalOpts = getGlobalOptions();
+	const baseOpts = optionsToEndpoint(globalOpts);
+	const specificOpts = optionsToEndpoint(opts);
+	const endpoint = {
+		...initV2Endpoint(globalOpts, opts),
+		platform: "gcfv2",
+		...baseOpts,
+		...specificOpts,
+		labels: {
+			...baseOpts?.labels,
+			...specificOpts?.labels
+		},
+		dataConnectGraphqlTrigger: {}
+	};
+	convertIfPresent(endpoint.dataConnectGraphqlTrigger, globalOpts, "invoker", "invoker", convertInvoker);
+	convertIfPresent(endpoint.dataConnectGraphqlTrigger, opts, "invoker", "invoker", convertInvoker);
+	if (opts.schemaFilePath) {
+		endpoint.dataConnectGraphqlTrigger.schemaFilePath = opts.schemaFilePath;
+	}
+	handler.__endpoint = endpoint;
+	return handler;
+}
 
 //#endregion
-export { dataconnect_exports, mutationExecutedEventType, onMutationExecuted };
+export { dataconnect_exports, initGraphqlServer, mutationExecutedEventType, onGraphRequest, onMutationExecuted };

package/lib/runtime/manifest.d.ts

@@ -45,6 +45,10 @@ export interface ManifestEndpoint {
     callableTrigger?: {
         genkitAction?: string;
     };
+    dataConnectGraphqlTrigger?: {
+        invoker?: string[];
+        schemaFilePath?: string;
+    };
     eventTrigger?: {
         eventFilters: Record<string, string | Expression<string>>;
         eventFilterPathPatterns?: Record<string, string | Expression<string>>;

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

@@ -1,3 +1,6 @@
+import express from "express";
+import type { GraphQLResolveInfo } from "graphql";
+import { HttpsFunction, HttpsOptions } from "./https";
 import { CloudEvent, CloudFunction } from "../core";
 import { ParamsOf, VarName } from "../../common/params";
 import { EventHandlerOptions, SupportedRegion } from "../options";
@@ -93,3 +96,60 @@ export declare function onMutationExecuted<Mutation extends string, Variables =
  * @param handler - Event handler which is run every time a mutation is executed.
  */
 export declare function onMutationExecuted<Options extends OperationOptions, Variables = unknown, ResponseData = unknown>(opts: Options, handler: (event: DataConnectEvent<MutationEventData<Variables, ResponseData>, DataConnectParams<Options>>) => unknown | Promise<unknown>): CloudFunction<DataConnectEvent<MutationEventData<Variables, ResponseData>, DataConnectParams<Options>>>;
+/** @hidden */
+export declare function initGraphqlServer(opts: GraphqlServerOptions): Promise<express.Express>;
+/**
+ * @hidden
+ * Handles HTTPS GraphQL requests.
+ * @param {GraphqlServerOptions} opts - Options for configuring the GraphQL server.
+ * @returns {HttpsFunction} A function you can export and deploy.
+ */
+export declare function onGraphRequest(opts: GraphqlServerOptions): HttpsFunction;
+/**
+ * @hidden
+ * Options for configuring the GraphQL server.
+ */
+export interface GraphqlServerOptions extends Omit<HttpsOptions, "cors"> {
+    /**
+     * A valid SDL string that represents the GraphQL server's schema.
+     * Either `schema` or `schemaFilePath` is required.
+     */
+    schema?: string;
+    /**
+     * A relative file path from the Firebase project directory to a valid GraphQL schema.
+     * Either `schema` or `schemaFilePath` is required.
+     */
+    schemaFilePath?: string;
+    /**
+     * The path where the GraphQL server will be served on the Cloud Run function.
+     * e.g. https://...run.app/{path}
+     * If no path is provided, "graphql" is used as the default.
+     */
+    path?: string;
+    /** A map of functions that populate data for individual GraphQL schema fields. */
+    resolvers: GraphqlResolvers;
+}
+/**
+ * @hidden
+ * Per-request context state shared by all resolvers in a particular query.
+ */
+export interface FirebaseContext {
+    auth?: {
+        /** The UID of the Firebase user that made the request, if present. */
+        uid?: string;
+        /** The token attached to the `X-Firebase-Auth-Token` in the request, if present. */
+        token?: string;
+    };
+}
+/**
+ * @hidden
+ * Resolver functions that populate data for individual GraphQL schema fields.
+ */
+export interface GraphqlResolvers {
+    query?: {
+        [resolver: string]: (parent: unknown, args: Record<string, unknown>, context: FirebaseContext, info: GraphQLResolveInfo) => unknown;
+    };
+    mutation?: {
+        [key: string]: (parent: unknown, args: Record<string, unknown>, context: FirebaseContext, info: GraphQLResolveInfo) => unknown;
+    };
+}

package/lib/v2/providers/dataconnect.js

@@ -1,14 +1,22 @@
 const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.js');
 const require_runtime_manifest = require('../../runtime/manifest.js');
+const require_common_encoding = require('../../common/encoding.js');
 const require_common_onInit = require('../../common/onInit.js');
+const require_common_providers_https = require('../../common/providers/https.js');
 const require_common_utilities_path = require('../../common/utilities/path.js');
 const require_v2_trace = require('../trace.js');
 const require_v2_options = require('../options.js');
 const require_common_utilities_path_pattern = require('../../common/utilities/path-pattern.js');
+let express = require("express");
+express = require_rolldown_runtime.__toESM(express);
+let fs = require("fs");
+fs = require_rolldown_runtime.__toESM(fs);
 
 //#region src/v2/providers/dataconnect.ts
 var dataconnect_exports = /* @__PURE__ */ require_rolldown_runtime.__export({
+	initGraphqlServer: () => initGraphqlServer,
 	mutationExecutedEventType: () => mutationExecutedEventType,
+	onGraphRequest: () => onGraphRequest,
 	onMutationExecuted: () => onMutationExecuted
 });
 /** @internal */
@@ -125,6 +133,81 @@ function onOperation(eventType, mutationOrOpts, handler) {
 	func.__endpoint = makeEndpoint(eventType, opts, servicePattern, connectorPattern, operationPattern);
 	return func;
 }
+/** @hidden */
+async function initGraphqlServer(opts) {
+	if (!opts.schema && !opts.schemaFilePath || opts.schema && opts.schemaFilePath) {
+		throw new Error("Exactly one of 'schema' or 'schemaFilePath' must be provided.");
+	}
+	if (opts.schemaFilePath) {
+		opts.schema = fs.default.readFileSync(opts.schemaFilePath, "utf-8");
+	}
+	if (!opts.resolvers.query && !opts.resolvers.mutation) {
+		throw new Error("At least one query or mutation resolver must be provided.");
+	}
+	const apolloResolvers = {};
+	if (opts.resolvers.query) {
+		apolloResolvers.Query = opts.resolvers.query;
+	}
+	if (opts.resolvers.mutation) {
+		apolloResolvers.Mutation = opts.resolvers.mutation;
+	}
+	try {
+		const { ApolloServer } = await import("@apollo/server");
+		const { expressMiddleware } = await import("@as-integrations/express4");
+		const serverPromise$1 = (async () => {
+			const app = (0, express.default)();
+			const server = new ApolloServer({
+				typeDefs: opts.schema,
+				resolvers: apolloResolvers
+			});
+			await server.start();
+			app.use(`/${opts.path ?? "graphql"}`, express.default.json(), expressMiddleware(server));
+			return app;
+		})();
+		return serverPromise$1;
+	} catch (e) {
+		if (e instanceof Error) {
+			throw new Error("Error initializing GraphQL server: " + e.message);
+		} else {
+			throw e;
+		}
+	}
+}
+let serverPromise = null;
+/**
+* @hidden
+* Handles HTTPS GraphQL requests.
+* @param {GraphqlServerOptions} opts - Options for configuring the GraphQL server.
+* @returns {HttpsFunction} A function you can export and deploy.
+*/
+function onGraphRequest(opts) {
+	const handler = require_v2_trace.wrapTraceContext(require_common_onInit.withInit(require_common_providers_https.withErrorHandler(async (req, res) => {
+		serverPromise = serverPromise ?? initGraphqlServer(opts);
+		const app = await serverPromise;
+		app(req, res);
+	})));
+	const globalOpts = require_v2_options.getGlobalOptions();
+	const baseOpts = require_v2_options.optionsToEndpoint(globalOpts);
+	const specificOpts = require_v2_options.optionsToEndpoint(opts);
+	const endpoint = {
+		...require_runtime_manifest.initV2Endpoint(globalOpts, opts),
+		platform: "gcfv2",
+		...baseOpts,
+		...specificOpts,
+		labels: {
+			...baseOpts?.labels,
+			...specificOpts?.labels
+		},
+		dataConnectGraphqlTrigger: {}
+	};
+	require_common_encoding.convertIfPresent(endpoint.dataConnectGraphqlTrigger, globalOpts, "invoker", "invoker", require_common_encoding.convertInvoker);
+	require_common_encoding.convertIfPresent(endpoint.dataConnectGraphqlTrigger, opts, "invoker", "invoker", require_common_encoding.convertInvoker);
+	if (opts.schemaFilePath) {
+		endpoint.dataConnectGraphqlTrigger.schemaFilePath = opts.schemaFilePath;
+	}
+	handler.__endpoint = endpoint;
+	return handler;
+}
 
 //#endregion
 Object.defineProperty(exports, 'dataconnect_exports', {
@@ -133,5 +216,7 @@ Object.defineProperty(exports, 'dataconnect_exports', {
     return dataconnect_exports;
   }
 });
+exports.initGraphqlServer = initGraphqlServer;
 exports.mutationExecutedEventType = mutationExecutedEventType;
+exports.onGraphRequest = onGraphRequest;
 exports.onMutationExecuted = onMutationExecuted;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "7.0.2",
+  "version": "7.0.3",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -508,6 +508,8 @@
     "protobufjs": "^7.2.2"
   },
   "devDependencies": {
+    "@apollo/server": "^5.2.0",
+    "@as-integrations/express4": "^1.1.2",
     "@eslint/eslintrc": "^3.3.1",
     "@firebase/api-documenter": "^0.2.0",
     "@microsoft/api-documenter": "^7.13.45",
@@ -534,6 +536,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "firebase-admin": "^13.0.0",
     "genkit": "^1.0.0-rc.4",
+    "graphql": "^16.12.0",
     "jsdom": "^16.2.1",
     "jsonwebtoken": "^9.0.0",
     "jwk-to-pem": "^2.0.5",
@@ -554,8 +557,18 @@
     "yargs": "^15.3.1"
   },
   "peerDependencies": {
+    "@apollo/server": "^5.2.0",
+    "@as-integrations/express4": "^1.1.2",
     "firebase-admin": "^11.10.0 || ^12.0.0 || ^13.0.0"
   },
+  "peerDependenciesMeta": {
+    "@apollo/server": {
+      "optional": true
+    },
+    "@as-integrations/express4": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=18.0.0"
   }