shelving 1.154.0 → 1.154.1

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.154.0",
+	"version": "1.154.1",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/util/http.d.ts

@@ -9,41 +9,25 @@ export declare function _getMessageContent(message: Request | Response, MessageE
 /**
  * Get the body content of an HTTP `Request` based on its content type, or throw `RequestError` if the content could not be parsed.
  *
+ * @returns undefined If the request method is `GET` or `HEAD` (these request methods have no body).
  * @returns unknown If content type is `application/json` and has valid JSON (including `undefined` if the content is empty).
  * @returns unknown If content type is `multipart/form-data` then convert it to a simple `Data` object.
  * @returns string If content type is `text/plain` or anything else (including `""` empty string if it's empty).
  *
  * @throws RequestError if the content is not `text/plain`, or `application/json` with valid JSON.
  */
-export declare function getRequestContent(message: Request, caller?: AnyCaller): Promise<unknown>;
+export declare function getRequestContent(request: Request, caller?: AnyCaller): Promise<unknown>;
 /**
  * Get the body content of an HTTP `Response` based on its content type, or throw `ResponseError` if the content could not be parsed.
  *
+ * @returns undefined If the request status is `204 No Content` (this response has no body).
  * @returns unknown If content type is `application/json` and has valid JSON (including `undefined` if the content is empty).
  * @returns unknown If content type is `multipart/form-data` then convert it to a simple `Data` object.
  * @returns string If content type is `text/plain` or anything else (including `""` empty string if it's empty).
  *
  * @throws RequestError if the content is not `text/plain` or `application/json` with valid JSON.
  */
-export declare function getResponseContent(message: Response, caller?: AnyCaller): Promise<unknown>;
-/**
- * Get the body content of an HTTP `Request` as JSON, or throw `RequestError` if the content could not be parsed.
- * - Doesn't check the `Content-Type` header, so it can be used for any request.
- *
- * @returns unknown The parsed JSON content of the request body, or `undefined` if the body is empty.
- *
- * @throws RequestError if the content is not valid JSON.
- */
-export declare function getRequestJSON(message: Request, caller?: AnyCaller): Promise<unknown>;
-/**
- * Get the body content of an HTTP `Response` as JSON, or throw `ResponseError` if the content could not be parsed.
- * - Doesn't check the `Content-Type` header, so it can be used for any response.
- *
- * @returns unknown The parsed JSON content of the response body, or `undefined` if the body is empty.
- *
- * @throws RequestError if the content is not valid JSON.
- */
-export declare function getResponseJSON(message: Response, caller?: AnyCaller): Promise<unknown>;
+export declare function getResponseContent(response: Response, caller?: AnyCaller): Promise<unknown>;
 /**
  * Get an HTTP `Response` for an unknown value.
  *

package/util/http.js

@@ -24,59 +24,47 @@ export async function _getMessageFormData(message, MessageError, caller) {
 }
 export function _getMessageContent(message, MessageError, caller) {
     const type = message.headers.get("Content-Type");
+    if (!type || type?.startsWith("text/"))
+        return message.text();
     if (type?.startsWith("application/json"))
         return _getMessageJSON(message, MessageError, caller);
     if (type?.startsWith("multipart/form-data"))
         return _getMessageFormData(message, MessageError, caller);
-    return message.text();
+    throw new MessageError("Content-Type must be text/*, application/json, or multipart/form-data", { received: type, caller });
 }
 /**
  * Get the body content of an HTTP `Request` based on its content type, or throw `RequestError` if the content could not be parsed.
  *
+ * @returns undefined If the request method is `GET` or `HEAD` (these request methods have no body).
  * @returns unknown If content type is `application/json` and has valid JSON (including `undefined` if the content is empty).
  * @returns unknown If content type is `multipart/form-data` then convert it to a simple `Data` object.
  * @returns string If content type is `text/plain` or anything else (including `""` empty string if it's empty).
  *
  * @throws RequestError if the content is not `text/plain`, or `application/json` with valid JSON.
  */
-export function getRequestContent(message, caller = getRequestContent) {
-    if (message.method === "GET" || message.method === "HEAD")
+export function getRequestContent(request, caller = getRequestContent) {
+    const { method } = request;
+    // The HTTP/1.1 RFC 7231 does not forbid sending a body in GET or HEAD requests, but it is uncommon and not recommended because many servers, proxies, and caches may ignore or mishandle it.
+    if (method === "GET" || method === "HEAD")
         return Promise.resolve(undefined);
-    return _getMessageContent(message, RequestError, caller);
+    return _getMessageContent(request, RequestError, caller);
 }
 /**
  * Get the body content of an HTTP `Response` based on its content type, or throw `ResponseError` if the content could not be parsed.
  *
+ * @returns undefined If the request status is `204 No Content` (this response has no body).
  * @returns unknown If content type is `application/json` and has valid JSON (including `undefined` if the content is empty).
  * @returns unknown If content type is `multipart/form-data` then convert it to a simple `Data` object.
  * @returns string If content type is `text/plain` or anything else (including `""` empty string if it's empty).
  *
  * @throws RequestError if the content is not `text/plain` or `application/json` with valid JSON.
  */
-export function getResponseContent(message, caller = getResponseContent) {
-    return _getMessageContent(message, ResponseError, caller);
-}
-/**
- * Get the body content of an HTTP `Request` as JSON, or throw `RequestError` if the content could not be parsed.
- * - Doesn't check the `Content-Type` header, so it can be used for any request.
- *
- * @returns unknown The parsed JSON content of the request body, or `undefined` if the body is empty.
- *
- * @throws RequestError if the content is not valid JSON.
- */
-export function getRequestJSON(message, caller = getRequestJSON) {
-    return _getMessageJSON(message, RequestError, caller);
-}
-/**
- * Get the body content of an HTTP `Response` as JSON, or throw `ResponseError` if the content could not be parsed.
- * - Doesn't check the `Content-Type` header, so it can be used for any response.
- *
- * @returns unknown The parsed JSON content of the response body, or `undefined` if the body is empty.
- *
- * @throws RequestError if the content is not valid JSON.
- */
-export function getResponseJSON(message, caller = getResponseJSON) {
-    return _getMessageJSON(message, ResponseError, caller);
+export function getResponseContent(response, caller = getResponseContent) {
+    const { status } = response;
+    // RFC 7230 Section 3.3.3: A server MUST NOT send a Content-Length header field in any response with a status code of 1xx (Informational), 204 (No Content), or 304 (Not Modified).
+    if ((status >= 100 && status < 200) || status === 204 || status === 304)
+        return Promise.resolve(undefined);
+    return _getMessageContent(response, ResponseError, caller);
 }
 /**
  * Get an HTTP `Response` for an unknown value.