msw 0.42.0 → 0.42.3

package/lib/index.d.ts

@@ -183,6 +183,14 @@ declare const rest: {
     options: <RequestBodyType_7 extends DefaultBodyType = DefaultBodyType, Params_7 extends PathParams<keyof Params_7> = PathParams<string>, ResponseBody_7 extends DefaultBodyType = DefaultBodyType>(path: Path, resolver: ResponseResolver<RestRequest<RequestBodyType_7, Params_7>, RestContext, ResponseBody_7>) => RestHandler<MockedRequest<DefaultBodyType>>;
 };
 
+declare type ForbiddenFieldNames = '' | 'data' | 'errors' | 'extensions';
+/**
+ * Set a custom field on the GraphQL mocked response.
+ * @example res(ctx.fields('customField', value))
+ * @see {@link https://mswjs.io/docs/api/context/field}
+ */
+declare const field: <FieldNameType extends string, FieldValueType>(fieldName: FieldNameType extends ForbiddenFieldNames ? never : FieldNameType, fieldValue: FieldValueType) => ResponseTransformer<string>;
+
 interface ParsedGraphQLQuery {
     operationType: OperationTypeNode;
     operationName?: string;
@@ -204,6 +212,7 @@ declare type GraphQLContext<QueryType extends Record<string, unknown>> = Default
     extensions: GraphQLPayloadContext<QueryType>;
     errors: typeof errors;
     cookie: typeof cookie;
+    field: typeof field;
 };
 declare const graphqlContext: GraphQLContext<any>;
 declare type GraphQLVariables = Record<string, any>;

package/lib/index.js

@@ -685,8 +685,8 @@ function parseMultipartData(data2, headers) {
   }
   const parsedBody = {};
   try {
-    for (const field of fields) {
-      const [contentHeaders, ...rest2] = field.split("\r\n\r\n");
+    for (const field2 of fields) {
+      const [contentHeaders, ...rest2] = field2.split("\r\n\r\n");
       const contentBody = rest2.join("\r\n\r\n");
       const { contentType: contentType2, filename, name } = parseContentHeaders(contentHeaders);
       const value = filename === void 0 ? contentBody : new File([contentBody], filename, { type: contentType2 });
@@ -1088,6 +1088,23 @@ var RestHandler = class extends RequestHandler {
   }
 };
 
+// src/context/field.ts
+var import_outvariant2 = require("outvariant");
+var field = (fieldName, fieldValue) => {
+  return (res) => {
+    validateFieldName(fieldName);
+    const prevBody = jsonParse(res.body) || {};
+    const nextBody = mergeRight(prevBody, { [fieldName]: fieldValue });
+    return json(nextBody)(res);
+  };
+};
+function validateFieldName(fieldName) {
+  (0, import_outvariant2.invariant)(fieldName.trim() !== "", devUtils.formatMessage("Failed to set a custom field on a GraphQL response: field name cannot be empty."));
+  (0, import_outvariant2.invariant)(fieldName !== "data", devUtils.formatMessage('Failed to set a custom "%s" field on a mocked GraphQL response: forbidden field name. Did you mean to call "ctx.data()" instead?', fieldName));
+  (0, import_outvariant2.invariant)(fieldName !== "errors", devUtils.formatMessage('Failed to set a custom "%s" field on a mocked GraphQL response: forbidden field name. Did you mean to call "ctx.errors()" instead?', fieldName));
+  (0, import_outvariant2.invariant)(fieldName !== "extensions", devUtils.formatMessage('Failed to set a custom "%s" field on a mocked GraphQL response: forbidden field name. Did you mean to call "ctx.extensions()" instead?', fieldName));
+}
+
 // src/utils/internal/tryCatch.ts
 function tryCatch(fn, onException) {
   try {
@@ -1103,7 +1120,8 @@ var graphqlContext = __spreadProps(__spreadValues({}, defaultContext), {
   data,
   extensions,
   errors,
-  cookie
+  cookie,
+  field
 });
 function isDocumentNode(value) {
   if (value == null) {
@@ -1291,7 +1309,7 @@ function readResponseCookies(request, response2) {
 
 // src/utils/handleRequest.ts
 async function handleRequest(request, handlers, options, emitter, handleRequestOptions) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e, _f, _g;
   emitter.emit("request:start", request);
   if (request.headers.get("x-msw-bypass") === "true") {
     emitter.emit("request:end", request);
@@ -1329,18 +1347,12 @@ async function handleRequest(request, handlers, options, emitter, handleRequestO
   }
   readResponseCookies(request, response2);
   emitter.emit("request:match", request);
-  return new Promise((resolve) => {
-    var _a2, _b2, _c2;
-    const requiredLookupResult = lookupResult;
-    const transformedResponse = ((_a2 = handleRequestOptions == null ? void 0 : handleRequestOptions.transformResponse) == null ? void 0 : _a2.call(handleRequestOptions, response2)) || response2;
-    (_b2 = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponse) == null ? void 0 : _b2.call(handleRequestOptions, transformedResponse, requiredLookupResult);
-    setTimeout(() => {
-      var _a3;
-      (_a3 = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponseSent) == null ? void 0 : _a3.call(handleRequestOptions, transformedResponse, requiredLookupResult);
-      emitter.emit("request:end", request);
-      resolve(transformedResponse);
-    }, (_c2 = response2.delay) != null ? _c2 : 0);
-  });
+  const requiredLookupResult = lookupResult;
+  const transformedResponse = ((_e = handleRequestOptions == null ? void 0 : handleRequestOptions.transformResponse) == null ? void 0 : _e.call(handleRequestOptions, response2)) || response2;
+  (_f = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponse) == null ? void 0 : _f.call(handleRequestOptions, transformedResponse, requiredLookupResult);
+  (_g = handleRequestOptions == null ? void 0 : handleRequestOptions.onMockedResponseSent) == null ? void 0 : _g.call(handleRequestOptions, transformedResponse, requiredLookupResult);
+  emitter.emit("request:end", request);
+  return transformedResponse;
 }
 
 // src/utils/worker/createRequestListener.ts