graphql-http 1.23.0 → 1.23.1

package/lib/use/@netlify/functions.d.mts

@@ -1,4 +1,4 @@
-import { HandlerOptions as RawHandlerOptions, OperationContext } from '../../handler/index.mjs';
+import { HandlerOptions as RawHandlerOptions, OperationContext } from '../../handler.mjs';
 import type { Handler as NetlifyHandler, HandlerEvent as NetlifyHandlerEvent, HandlerContext as NetlifyHandlerContext } from '@netlify/functions';
 /**
  * Handler options when using the netlify adapter

package/lib/use/express.d.mts

@@ -7,6 +7,12 @@ import { RequestParams } from '../common.mjs';
  * @category Server/express
  */
 export interface RequestContext {
+    /**
+     * The Express response object for the current request.
+     *
+     * This can be used to manipulate the HTTP response, for example to set
+     * response headers or cookies.
+     */
     res: Response;
 }
 /**
@@ -59,16 +65,40 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.
  *
+ * The Express response is available through `req.context.res`. To expose it
+ * to GraphQL resolvers, return it from the `context` option. This can be used
+ * to manipulate the HTTP response, for example to set response headers or
+ * cookies.
+ *
  * ```js
  * import express from 'express'; // yarn add express
  * import { createHandler } from 'graphql-http/lib/use/express';
  * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const app = express();
- * app.all('/graphql', createHandler({ schema }));
+ *
+ * app.all(
+ *   '/graphql',
+ *   createHandler({
+ *     schema,
+ *     context(req) {
+ *       return {
+ *         res: req.context.res,
+ *       };
+ *     },
+ *   }),
+ * );
  *
  * app.listen({ port: 4000 });
- * console.log('Listening to port 4000');
+ * ```
+ *
+ * A resolver can then manipulate the response:
+ *
+ * ```js
+ * resolve(_, __, { res }) {
+ *   res.setHeader('set-cookie', 'session=; Max-Age=0; Path=/');
+ *   return true;
+ * }
  * ```
  *
  * @category Server/express

package/lib/use/express.d.ts

@@ -7,6 +7,12 @@ import { RequestParams } from '../common';
  * @category Server/express
  */
 export interface RequestContext {
+    /**
+     * The Express response object for the current request.
+     *
+     * This can be used to manipulate the HTTP response, for example to set
+     * response headers or cookies.
+     */
     res: Response;
 }
 /**
@@ -59,16 +65,40 @@ export type HandlerOptions<Context extends OperationContext = undefined> = RawHa
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.
  *
+ * The Express response is available through `req.context.res`. To expose it
+ * to GraphQL resolvers, return it from the `context` option. This can be used
+ * to manipulate the HTTP response, for example to set response headers or
+ * cookies.
+ *
  * ```js
  * import express from 'express'; // yarn add express
  * import { createHandler } from 'graphql-http/lib/use/express';
  * import { schema } from './my-graphql-schema';
  *
  * const app = express();
- * app.all('/graphql', createHandler({ schema }));
+ *
+ * app.all(
+ *   '/graphql',
+ *   createHandler({
+ *     schema,
+ *     context(req) {
+ *       return {
+ *         res: req.context.res,
+ *       };
+ *     },
+ *   }),
+ * );
  *
  * app.listen({ port: 4000 });
- * console.log('Listening to port 4000');
+ * ```
+ *
+ * A resolver can then manipulate the response:
+ *
+ * ```js
+ * resolve(_, __, { res }) {
+ *   res.setHeader('set-cookie', 'session=; Max-Age=0; Path=/');
+ *   return true;
+ * }
  * ```
  *
  * @category Server/express

package/lib/use/express.js

@@ -56,16 +56,40 @@ exports.parseRequestParams = parseRequestParams;
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.
  *
+ * The Express response is available through `req.context.res`. To expose it
+ * to GraphQL resolvers, return it from the `context` option. This can be used
+ * to manipulate the HTTP response, for example to set response headers or
+ * cookies.
+ *
  * ```js
  * import express from 'express'; // yarn add express
  * import { createHandler } from 'graphql-http/lib/use/express';
  * import { schema } from './my-graphql-schema';
  *
  * const app = express();
- * app.all('/graphql', createHandler({ schema }));
+ *
+ * app.all(
+ *   '/graphql',
+ *   createHandler({
+ *     schema,
+ *     context(req) {
+ *       return {
+ *         res: req.context.res,
+ *       };
+ *     },
+ *   }),
+ * );
  *
  * app.listen({ port: 4000 });
- * console.log('Listening to port 4000');
+ * ```
+ *
+ * A resolver can then manipulate the response:
+ *
+ * ```js
+ * resolve(_, __, { res }) {
+ *   res.setHeader('set-cookie', 'session=; Max-Age=0; Path=/');
+ *   return true;
+ * }
  * ```
  *
  * @category Server/express

package/lib/use/express.mjs

@@ -52,16 +52,40 @@ export async function parseRequestParams(req, res) {
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.
  *
+ * The Express response is available through `req.context.res`. To expose it
+ * to GraphQL resolvers, return it from the `context` option. This can be used
+ * to manipulate the HTTP response, for example to set response headers or
+ * cookies.
+ *
  * ```js
  * import express from 'express'; // yarn add express
  * import { createHandler } from 'graphql-http/lib/use/express';
  * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const app = express();
- * app.all('/graphql', createHandler({ schema }));
+ *
+ * app.all(
+ *   '/graphql',
+ *   createHandler({
+ *     schema,
+ *     context(req) {
+ *       return {
+ *         res: req.context.res,
+ *       };
+ *     },
+ *   }),
+ * );
  *
  * app.listen({ port: 4000 });
- * console.log('Listening to port 4000');
+ * ```
+ *
+ * A resolver can then manipulate the response:
+ *
+ * ```js
+ * resolve(_, __, { res }) {
+ *   res.setHeader('set-cookie', 'session=; Max-Age=0; Path=/');
+ *   return true;
+ * }
  * ```
  *
  * @category Server/express

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.23.0",
+  "version": "1.23.1",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP spec compliant server, client and audit suite.",
   "keywords": [
     "graphql",