@johntalton/http-util 6.1.0 → 7.0.1

package/README.md

@@ -64,7 +64,7 @@ All responders take in a `stream` as well as a metadata object to hint on server
 - [`sendGone`](#responsegone)
 - [`sendImATeapot`](#)
 - [`sendInsufficientStorage`](#)
-- [`sendJSON_Encoded`](#responsejson) - Standard Ok response with encoding
+- [`sendJSON`](#responsejson) - Standard Ok response with encoding
 - [`sendMovedPermanently`](#responsemovedpermanently)
 - [`sendMultipleChoices`](#)
 - [`sendNoContent`](#responsenocontent)

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@johntalton/http-util",
-  "version": "6.1.0",
+  "version": "7.0.1",
   "license": "MIT",
   "type": "module",
+  "sideEffects": false,
   "imports": {
     "#util": "./src/headers/util/index.js"
   },

package/src/defs.js

@@ -28,7 +28,7 @@ export const RANGE_UNITS_NONE = 'none'
 
 
 /** @import { TimingsInfo } from './headers/server-timing.js' */
-/** @import { EtagItem, IMFFixDateInput,  } from './headers/conditional.js' */
+/** @import { EtagItem, IMFFixDateInput } from './headers/conditional.js' */
 /** @import { CacheControlOptions } from './headers/cache-control.js' */
 /** @import { ContentRangeDirective } from './headers/content-range.js' */
 /** @import { RateLimitPolicyInfo, RateLimitInfo } from './headers/rate-limit.js' */

package/src/headers/conditional.js

@@ -102,7 +102,7 @@ export class ETag {
 	static isValid(etag) {
 		if(etag === undefined) { return false }
 
-		// %x21 / %x23-7E  and %x80-FF
+		// %x21 / %x23-7E and %x80-FF
 		for(const c of etag) {
 			if(c.charCodeAt(0) < 0x21) { return false }
 			if(c.charCodeAt(0) > 0xFF) { return false }

package/src/headers/link.js

@@ -9,7 +9,7 @@ export class Link {
 	/**
 	 * @param {LinkItem} link
 	 */
-	static  *#encode(link) {
+	static *#encode(link) {
 		const encodedUri = (link.url instanceof URL) ? link.url : encodeURI(link.url)
 
 		yield `<${encodedUri}>`

package/src/headers/multipart.js

@@ -1,6 +1,5 @@
 import { ReadableStream } from 'node:stream/web'
 
-import { isQuoted, stripQuotes } from '../headers/util/quote.js'
 import { ContentDisposition } from './content-disposition.js'
 import { ContentRange } from './content-range.js'
 import { ContentType } from './content-type.js'
@@ -65,11 +64,6 @@ export class Multipart {
 
 		const lines = text.split(MULTIPART_SEPARATOR)
 
-		if(lines.length === 0) {
-			// missing body?
-			return formData
-		}
-
 		const boundaryBegin = `${BOUNDARY_MARK}${boundary}`
 		const boundaryEnd = `${BOUNDARY_MARK}${boundary}${BOUNDARY_MARK}`
 
@@ -107,7 +101,7 @@ export class Multipart {
 							throw new Error('disposition not form-data')
 						}
 
-						partName = isQuoted(disposition.name) ? stripQuotes(disposition.name) : disposition.name
+						partName = disposition.name
 					}
 					else {
 						// unsupported part header - ignore
@@ -131,10 +125,9 @@ export class Multipart {
 				}
 				state = MULTIPART_STATE.HEADERS
 			}
-			else {
-				throw new Error('unknown state')
-			}
-
+			// else {
+			// 	throw new Error('unknown state')
+			// }
 		}
 
 		return formData

package/src/headers/range.js

@@ -99,6 +99,8 @@ export class Range {
 	 */
 	static normalize(directive, contentLength) {
 		if(directive === undefined) { return undefined }
+		if(!Number.isInteger(contentLength)) { return undefined }
+		if(contentLength <= 0) { return undefined }
 
 		/** @type {Array<NormalizedRangeValue>} */
 		const normalizedRanges = directive.ranges.map(({ start, end }) => {

package/src/headers/rate-limit.js

@@ -1,6 +1,6 @@
 // https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-10.html
 
-export  const HTTP_HEADER_RATE_LIMIT = 'RateLimit'
+export const HTTP_HEADER_RATE_LIMIT = 'RateLimit'
 export const HTTP_HEADER_RATE_LIMIT_POLICY = 'RateLimit-Policy'
 
 /**

package/src/headers/util/mime.js

@@ -19,7 +19,7 @@ export const SPECIAL_CHARS = [
 	'{', '}',
 	'@', ',', ';', ':',
 	'\\', '"', '/', '?', '=', // '.',
-	// '%', // '!', '$', '&', // #  ^ * | ~ `
+	// '%', // '!', '$', '&', // # ^ * | ~ `
 	// space
 	' ', '\u000B', '\u000C',
 	// control

package/src/headers/util/whitespace.js

@@ -4,5 +4,5 @@ export const WHITESPACE_REGEX = /\s/
  * @param {string} c
  */
 export function isWhitespace(c){
-  return WHITESPACE_REGEX.test(c)
+	return WHITESPACE_REGEX.test(c)
 }

package/src/headers/www-authenticate.js

@@ -31,7 +31,6 @@ export function paramNeedQuotes(paramName) {
 	return PARAMETERS_THAT_NEED_QUOTES.includes(paramName.toLowerCase())
 }
 
-
 export class Challenge {
 	/**
 	 * @param {string} realm

package/src/response/2xx/bytes.js

@@ -3,39 +3,10 @@ import http2 from 'node:http2'
 import { send_bytes } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { AcceptRangeUnits, SendContent, SendInfo, Metadata, SendBody } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
-/** @import { CacheControlOptions } from '../../headers/cache-control.js' */
+/** @import { SendContent, SendInfo, Metadata, SendBody } from '../../defs.js' */
 
 const { HTTP_STATUS_OK } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {SendBody|undefined} obj
- * @param {string|undefined} contentType
- * @param {number|undefined} contentLength
- * @param {string|undefined} encoding
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {number|undefined} age
- * @param {CacheControlOptions} cacheControl
- * @param {AcceptRangeUnits|undefined} acceptRanges
- * @param {Metadata} meta
- */
-export function sendBytes(stream, contentType, obj, contentLength, encoding, etag, lastModified, age, cacheControl, acceptRanges, meta) {
-	_sendBytes(stream, obj, {
-		contentType,
-		contentLength,
-		encoding,
-		etag,
-		lastModified,
-		age,
-		cacheControl
-	}, {
-		acceptRanges
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {SendBody|undefined} obj
@@ -43,7 +14,7 @@ export function sendBytes(stream, contentType, obj, contentLength, encoding, eta
  * @param {Pick<SendInfo, 'acceptRanges'>} info
  * @param {Metadata} meta
  */
-export function _sendBytes(stream, obj, content, info, meta) {
+export function sendBytes(stream, obj, content, info, meta) {
 	const {
 		contentType,
 		contentLength,

package/src/response/2xx/created.js

@@ -5,7 +5,6 @@ import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, Metadata } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
 
 const {
 	HTTP2_HEADER_LOCATION,
@@ -17,32 +16,20 @@ const { HTTP_STATUS_CREATED } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {Metadata} meta
- */
-export function sendCreated(stream, location, etag, lastModified, meta) {
-	_sendCreated(stream, location, {
-		etag,
-		lastModified
-	}, meta)
-}
-
-/**
- * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Pick<SendContent, 'etag' | 'lastModified'>} content
  * @param {Metadata} meta
  */
-export function _sendCreated(stream, location, content, meta) {
+export function sendCreated(stream, location, content, meta) {
 	const {
 		etag,
 		lastModified
 	} = content
 
+	const loc = (location instanceof URL) ? location.href : location
+
 	send(stream, HTTP_STATUS_CREATED, {
-			[HTTP2_HEADER_LOCATION]: location.href,
+			[HTTP2_HEADER_LOCATION]: loc,
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
 			[HTTP2_HEADER_LAST_MODIFIED]: Conditional.encodeFixDate(lastModified)
 		}, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)

package/src/response/2xx/json.js

@@ -5,32 +5,19 @@ import { send_encoded } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, SendInfo, Metadata } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
-/** @import { CacheControlOptions } from '../../headers/cache-control.js' */
 
 const { HTTP_STATUS_OK } = http2.constants
 
 /**
+ * @deprecated
  * @param {ServerHttp2Stream} stream
  * @param {Object} obj
- * @param {string|undefined} encoding
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {number|undefined} age
- * @param {CacheControlOptions} cacheControl
- * @param {Array<string>|undefined} supportedQueryTypes
+ * @param {Omit<SendContent, 'contentType' | 'contentLength' | 'rangeDirective'>} content
+ * @param {Pick<SendInfo, 'supportedQueryTypes'>} info
  * @param {Metadata} meta
  */
-export function sendJSON_Encoded(stream, obj, encoding, etag, lastModified, age, cacheControl, supportedQueryTypes, meta) {
-	_sendJSON_Encoded(stream, obj, {
-		encoding,
-		etag,
-		lastModified,
-		age,
-		cacheControl
-	}, {
-		supportedQueryTypes
-	}, meta)
+export function sendJSON_Encoded(stream, obj, content, info, meta) {
+	sendJSON(stream, obj, content, info, meta)
 }
 
 /**
@@ -40,7 +27,7 @@ export function sendJSON_Encoded(stream, obj, encoding, etag, lastModified, age,
  * @param {Pick<SendInfo, 'supportedQueryTypes'>} info
  * @param {Metadata} meta
  */
-export function _sendJSON_Encoded(stream, obj, content, info, meta) {
+export function sendJSON(stream, obj, content, info, meta) {
 	const {
 		encoding,
 		etag,

package/src/response/2xx/no-content.js

@@ -5,7 +5,6 @@ import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, Metadata } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
 
 const {
 	HTTP2_HEADER_ETAG,
@@ -14,25 +13,12 @@ const {
 
 const { HTTP_STATUS_NO_CONTENT } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {Metadata} meta
- */
-export function sendNoContent(stream, etag, lastModified, meta) {
-	_sendNoContent(stream, {
-		etag,
-		lastModified
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendContent, 'etag' | 'lastModified'>} content
  * @param {Metadata} meta
  */
-export function _sendNoContent(stream, content, meta) {
+export function sendNoContent(stream, content, meta) {
 	const {
 		etag,
 		lastModified

package/src/response/2xx/partial-content.js

@@ -7,11 +7,8 @@ import { send_bytes } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, Metadata, SendBody } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
-/** @import { CacheControlOptions } from '../../headers/cache-control.js' */
 /** @import { ContentRangeDirective } from '../../headers/content-range.js' */
 
-
 const { HTTP_STATUS_PARTIAL_CONTENT } = http2.constants
 
 /**
@@ -25,37 +22,13 @@ const { HTTP_STATUS_PARTIAL_CONTENT } = http2.constants
  * @property {ContentRangeDirective} range
  */
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {string|undefined} contentType
- * @param {NonEmptyArray<PartialBytes>|PartialBytes} objs
- * @param {number|undefined} contentLength
- * @param {string|undefined} encoding
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {number|undefined} age
- * @param {CacheControlOptions} cacheControl
- * @param {Metadata} meta
- */
-export function sendPartialContent(stream, contentType, objs, contentLength, encoding, etag, lastModified, age, cacheControl, meta) {
-	return _sendPartialContent(stream, objs, {
-		contentType,
-		contentLength,
-		encoding,
-		etag,
-		lastModified,
-		age,
-		cacheControl
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {NonEmptyArray<PartialBytes>|PartialBytes} objs
  * @param {Omit<SendContent, 'rangeDirective'>} content
  * @param {Metadata} meta
  */
-export function _sendPartialContent(stream, objs, content, meta) {
+export function sendPartialContent(stream, objs, content, meta) {
 	const {
 		contentType,
 		contentLength,

package/src/response/2xx/preflight.js

@@ -1,15 +1,18 @@
 import http2 from 'node:http2'
 
 import {
+	HTTP_HEADER_ACCEPT_PATCH,
+	HTTP_HEADER_ACCEPT_POST,
 	HTTP_HEADER_ACCEPT_QUERY,
 	HTTP_METHOD_QUERY,
 	HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE,
 	PREFLIGHT_AGE_SECONDS
+
 } from '../../defs.js'
 import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { AcceptRangeUnits, SendInfo, Metadata } from '../../defs.js' */
+/** @import { SendInfo, Metadata } from '../../defs.js' */
 
 const {
 	HTTP2_HEADER_CONTENT_TYPE,
@@ -25,27 +28,12 @@ const {
 
 const { HTTP_STATUS_OK } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {Array<string>} supportedMethods
- * @param {Array<string>|undefined} supportedQueryTypes
- * @param {AcceptRangeUnits|undefined} acceptRanges
- * @param {Metadata} meta
- */
-export function sendPreflight(stream, supportedMethods, supportedQueryTypes, acceptRanges, meta) {
-	_sendPreflight(stream, {
-		supportedMethods,
-		supportedQueryTypes,
-		acceptRanges
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendInfo, 'supportedMethods' | 'supportedQueryTypes' | 'acceptRanges'>} info
  * @param {Metadata} meta
  */
-export function _sendPreflight(stream, info, meta) {
+export function sendPreflight(stream, info, meta) {
 	const {
 		supportedMethods,
 		supportedQueryTypes,
@@ -56,17 +44,22 @@ export function _sendPreflight(stream, info, meta) {
 	const exposedHeadersAcceptQuery = supportsQuery ? [ HTTP_HEADER_ACCEPT_QUERY ] : []
 	const exposedHeaders = acceptRanges === undefined ? exposedHeadersAcceptQuery : [ HTTP2_HEADER_ACCEPT_RANGES, ...exposedHeadersAcceptQuery ]
 
+	// todo: if supportedMethods includes POST | PATCH
+	// include accept-post / accept-patch headers
+
 	send(stream, HTTP_STATUS_OK, {
 			[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_METHODS]: supportedMethods.join(','),
 			[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_HEADERS]: [
 				HTTP2_HEADER_IF_MATCH,
 				HTTP2_HEADER_IF_NONE_MATCH,
 				HTTP2_HEADER_AUTHORIZATION,
-				HTTP2_HEADER_CONTENT_TYPE,
-				HTTP2_HEADER_RANGE,
+				HTTP2_HEADER_CONTENT_TYPE, // overrides cors safe restriction (for json)
+				HTTP2_HEADER_RANGE, // todo cors safe override not needed
 				HTTP2_HEADER_IF_RANGE
 			].join(','),
 			[HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE]: PREFLIGHT_AGE_SECONDS,
+			// [HTTP_HEADER_ACCEPT_POST]: ,
+			// [HTTP_HEADER_ACCEPT_PATCH]: ,
 			[HTTP2_HEADER_ACCEPT_RANGES]: acceptRanges,
 			[HTTP_HEADER_ACCEPT_QUERY]: supportedQueryTypes?.join(',') // todo should empty array return undef
 			// Access-Control-Allow-Credentials

package/src/response/3xx/found.js

@@ -1,4 +1,4 @@
-import  http2 from 'node:http2'
+import http2 from 'node:http2'
 
 import { send } from '../send-util.js'
 
@@ -13,11 +13,13 @@ const { HTTP_STATUS_FOUND } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Metadata} meta
  */
 export function sendFound(stream, location, meta) {
+	const loc = (location instanceof URL) ? location.href : location
+
 	send(stream, HTTP_STATUS_FOUND, {
-		[HTTP2_HEADER_LOCATION]: location.href
+		[HTTP2_HEADER_LOCATION]: loc
 	}, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
 }

package/src/response/3xx/moved-permanently.js

@@ -6,18 +6,20 @@ import { send } from '../send-util.js'
 /** @import { Metadata } from '../../defs.js' */
 
 const {
-  HTTP2_HEADER_LOCATION
+	HTTP2_HEADER_LOCATION
 } = http2.constants
 
 const { HTTP_STATUS_MOVED_PERMANENTLY } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Metadata} meta
  */
 export function sendMovedPermanently(stream, location, meta) {
-  send(stream, HTTP_STATUS_MOVED_PERMANENTLY, {
-    [HTTP2_HEADER_LOCATION]: location.href
-  }, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
+	const loc = (location instanceof URL) ? location.href : location
+
+	send(stream, HTTP_STATUS_MOVED_PERMANENTLY, {
+		[HTTP2_HEADER_LOCATION]: loc
+	}, [HTTP2_HEADER_LOCATION], undefined, undefined, meta)
 }

package/src/response/3xx/not-modified.js

@@ -6,8 +6,6 @@ import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, Metadata } from '../../defs.js' */
-/** @import { EtagItem, IMFFixDateInput } from '../../headers/conditional.js' */
-/** @import { CacheControlOptions } from '../../headers/cache-control.js' */
 
 const {
 	HTTP2_HEADER_AGE,
@@ -19,29 +17,12 @@ const {
 
 const { HTTP_STATUS_NOT_MODIFIED } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {number|undefined} age
- * @param {CacheControlOptions} cacheControl
- * @param {Metadata} meta
- */
-export function sendNotModified(stream, etag, lastModified, age, cacheControl, meta) {
-	_sendNotModified(stream, {
-		etag,
-		lastModified,
-		age,
-		cacheControl
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendContent, 'etag' | 'lastModified' | 'age' | 'cacheControl'>} content
  * @param {Metadata} meta
  */
-export function _sendNotModified(stream, content, meta) {
+export function sendNotModified(stream, content, meta) {
 	const {
 		etag,
 		lastModified,
@@ -54,6 +35,6 @@ export function _sendNotModified(stream, content, meta) {
 			[HTTP2_HEADER_CACHE_CONTROL]: CacheControl.encode(cacheControl),
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
 			[HTTP2_HEADER_LAST_MODIFIED]: Conditional.encodeFixDate(lastModified),
-			[HTTP2_HEADER_AGE]: age === undefined ? undefined : `${age}`
+			[HTTP2_HEADER_AGE]: Number.isInteger(age) ? `${age}` : undefined
 		}, [ HTTP2_HEADER_AGE ], undefined, undefined, meta)
 }

package/src/response/3xx/permanent-redirect.js

@@ -13,11 +13,13 @@ const { HTTP_STATUS_PERMANENT_REDIRECT } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Metadata} meta
  */
 export function sendPermanentRedirect(stream, location, meta) {
+	const loc = (location instanceof URL) ? location.href : location
+
 	send(stream, HTTP_STATUS_PERMANENT_REDIRECT, {
-		[HTTP2_HEADER_LOCATION]: location.href
+		[HTTP2_HEADER_LOCATION]: loc
 	}, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
 }

package/src/response/3xx/see-other.js

@@ -6,18 +6,20 @@ import { send } from '../send-util.js'
 /** @import { Metadata } from '../../defs.js' */
 
 const {
-  HTTP2_HEADER_LOCATION
+	HTTP2_HEADER_LOCATION
 } = http2.constants
 
 const { HTTP_STATUS_SEE_OTHER } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Metadata} meta
  */
 export function sendSeeOther(stream, location, meta) {
-  send(stream, HTTP_STATUS_SEE_OTHER, {
-    [HTTP2_HEADER_LOCATION]: location.href
-  }, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
+	const loc = (location instanceof URL) ? location.href : location
+
+	send(stream, HTTP_STATUS_SEE_OTHER, {
+		[HTTP2_HEADER_LOCATION]: loc
+	}, [HTTP2_HEADER_LOCATION], undefined, undefined, meta)
 }

package/src/response/3xx/temporary-redirect.js

@@ -13,11 +13,13 @@ const { HTTP_STATUS_TEMPORARY_REDIRECT } = http2.constants
 
 /**
  * @param {ServerHttp2Stream} stream
- * @param {URL} location
+ * @param {URL|string} location
  * @param {Metadata} meta
  */
 export function sendTemporaryRedirect(stream, location, meta) {
+	const loc = (location instanceof URL) ? location.href : location
+
 	send(stream, HTTP_STATUS_TEMPORARY_REDIRECT, {
-		[HTTP2_HEADER_LOCATION]: location.href
+		[HTTP2_HEADER_LOCATION]: loc
 	}, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
 }

package/src/response/4xx/bad-request.js

@@ -1,4 +1,4 @@
-import  http2 from 'node:http2'
+import http2 from 'node:http2'
 
 import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
 import { send } from '../send-util.js'
@@ -14,6 +14,6 @@ const { HTTP_STATUS_BAD_REQUEST } = http2.constants
  * @param {Metadata} meta
  */
 export function sendBadRequest(stream, message, meta) {
-  send(stream, HTTP_STATUS_BAD_REQUEST, {
-  }, [ ], CONTENT_TYPE_TEXT, message, meta)
+	send(stream, HTTP_STATUS_BAD_REQUEST, {
+	}, [], CONTENT_TYPE_TEXT, message, meta)
 }

package/src/response/4xx/content-too-large.js

@@ -12,5 +12,5 @@ const { HTTP_STATUS_PAYLOAD_TOO_LARGE } = http2.constants
  * @param {Metadata} meta
  */
 export function sendContentTooLarge(stream, meta) {
-  send(stream, HTTP_STATUS_PAYLOAD_TOO_LARGE, {}, [], undefined, undefined, meta)
+	send(stream, HTTP_STATUS_PAYLOAD_TOO_LARGE, {}, [], undefined, undefined, meta)
 }

package/src/response/4xx/gone.js

@@ -12,5 +12,5 @@ const { HTTP_STATUS_GONE } = http2.constants
  * @param {Metadata} meta
  */
 export function sendGone(stream, meta) {
-  send(stream, HTTP_STATUS_GONE, {}, [], undefined, undefined, meta)
+	send(stream, HTTP_STATUS_GONE, {}, [], undefined, undefined, meta)
 }

package/src/response/4xx/im-a-teapot.js

@@ -12,5 +12,5 @@ const { HTTP_STATUS_TEAPOT } = http2.constants
  * @param {Metadata} meta
  */
 export function sendImATeapot(stream, meta) {
-  send(stream, HTTP_STATUS_TEAPOT, {}, [], undefined, undefined, meta)
+	send(stream, HTTP_STATUS_TEAPOT, {}, [], undefined, undefined, meta)
 }

package/src/response/4xx/not-acceptable.js

@@ -8,21 +8,12 @@ import { send } from '../send-util.js'
 
 const { HTTP_STATUS_NOT_ACCEPTABLE } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {Array<string>|string} supportedTypes
- * @param {Metadata} meta
- */
-export function sendNotAcceptable(stream, supportedTypes, meta) {
-	_sendNotAcceptable(stream, { supportedTypes }, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendInfo, 'supportedTypes'>} info
  * @param {Metadata} meta
  */
-export function _sendNotAcceptable(stream, info, meta) {
+export function sendNotAcceptable(stream, info, meta) {
 	const { supportedTypes } = info
 
 	const supportedTypesList = Array.isArray(supportedTypes) ? supportedTypes : [ supportedTypes ]
@@ -33,6 +24,6 @@ export function _sendNotAcceptable(stream, info, meta) {
 		{},
 		[],
 		has ? CONTENT_TYPE_JSON : undefined,
-		has ? JSON.stringify(supportedTypes) : undefined,
+		has ? JSON.stringify({ supportedTypes: supportedTypesList }) : undefined,
 		meta)
 }

package/src/response/4xx/not-allowed.js

@@ -11,21 +11,12 @@ const {
 
 const { HTTP2_HEADER_ALLOW } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {Array<string>} supportedMethods
- * @param {Metadata} meta
- */
-export function sendNotAllowed(stream, supportedMethods, meta) {
-	_sendNotAllowed(stream, { supportedMethods }, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendInfo, 'supportedMethods'>} info
  * @param {Metadata} meta
  */
-export function _sendNotAllowed(stream, info, meta) {
+export function sendNotAllowed(stream, info, meta) {
 	const { supportedMethods } = info
 
 	send(stream, HTTP_STATUS_METHOD_NOT_ALLOWED, {

package/src/response/4xx/payment-required.js

@@ -1,4 +1,4 @@
-import  http2 from 'node:http2'
+import http2 from 'node:http2'
 
 import { send } from '../send-util.js'
 

package/src/response/4xx/precondition-failed.js

@@ -5,7 +5,6 @@ import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendContent, Metadata } from '../../defs.js' */
-/** @import { EtagItem ,IMFFixDateInput } from '../../headers/conditional.js' */
 
 const {
 	HTTP2_HEADER_ETAG,
@@ -14,25 +13,12 @@ const {
 
 const { HTTP_STATUS_PRECONDITION_FAILED } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {EtagItem|undefined} etag
- * @param {IMFFixDateInput|string|undefined} lastModified
- * @param {Metadata} meta
- */
-export function sendPreconditionFailed(stream, etag, lastModified, meta) {
-	_sendPreconditionFailed(stream, {
-		etag,
-		lastModified
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendContent, 'etag' | 'lastModified'>} content
  * @param {Metadata} meta
  */
-export function _sendPreconditionFailed(stream, content, meta) {
+export function sendPreconditionFailed(stream, content, meta) {
 	const {
 		etag,
 		lastModified

package/src/response/4xx/range-not-satisfiable.js

@@ -13,21 +13,12 @@ const {
 
 const { HTTP_STATUS_RANGE_NOT_SATISFIABLE } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {ContentRangeDirective} rangeDirective
- * @param {Metadata} meta
- */
-export function sendRangeNotSatisfiable(stream, rangeDirective, meta) {
-	_sendRangeNotSatisfiable(stream, { rangeDirective }, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendContent, 'rangeDirective'>} content
  * @param {Metadata} meta
  */
-export function _sendRangeNotSatisfiable(stream, content, meta) {
+export function sendRangeNotSatisfiable(stream, content, meta) {
 	const { rangeDirective } = content
 
 	/** @type {ContentRangeDirective} */

package/src/response/4xx/too-many-requests.js

@@ -11,7 +11,6 @@ import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendInfo, Metadata } from '../../defs.js' */
-/** @import { RateLimitInfo, RateLimitPolicyInfo } from '../../headers/rate-limit.js' */
 
 const {
 	HTTP2_HEADER_RETRY_AFTER
@@ -19,25 +18,12 @@ const {
 
 const { HTTP_STATUS_TOO_MANY_REQUESTS } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {RateLimitInfo} limitInfo
- * @param {Array<RateLimitPolicyInfo>} policies
- * @param {Metadata} meta
- */
-export function sendTooManyRequests(stream, limitInfo, policies, meta) {
-	_sendTooManyRequests(stream, {
-		limitInfo,
-		policies
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendInfo, 'limitInfo' | 'policies'>} info
  * @param {Metadata} meta
  */
-export function _sendTooManyRequests(stream, info, meta) {
+export function sendTooManyRequests(stream, info, meta) {
 	const {
 		limitInfo,
 		policies

package/src/response/4xx/unsupported-media.js

@@ -10,25 +10,12 @@ const { HTTP2_METHOD_POST, HTTP2_METHOD_PATCH } = http2.constants
 
 const { HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {Array<string>|string} acceptableMediaType
- * @param {Array<string>|undefined} supportedQueryTypes
- * @param {Metadata} meta
- */
-export function sendUnsupportedMediaType(stream, acceptableMediaType, supportedQueryTypes, meta) {
-	_sendUnsupportedMediaType(stream, {
-		acceptableMediaType,
-		supportedQueryTypes
-	}, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {Pick<SendInfo, 'acceptableMediaType' | 'supportedQueryTypes'>} info
  * @param {Metadata} meta
  */
-export function _sendUnsupportedMediaType(stream, info, meta) {
+export function sendUnsupportedMediaType(stream, info, meta) {
 	const {
 		supportedQueryTypes,
 		acceptableMediaType

package/src/response/5xx/error.js

@@ -1,7 +1,6 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
-import { send } from '../send-util.js'
+import { send_error } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { Metadata } from '../../defs.js' */
@@ -14,5 +13,5 @@ const { HTTP_STATUS_INTERNAL_SERVER_ERROR } = http2.constants
  * @param {Metadata} meta
  */
 export function sendError(stream, message, meta) {
-	send(stream, HTTP_STATUS_INTERNAL_SERVER_ERROR, {}, [], CONTENT_TYPE_TEXT, message, meta)
+	send_error(stream, HTTP_STATUS_INTERNAL_SERVER_ERROR, message, undefined, meta)
 }

package/src/response/5xx/insufficient-storage.js

@@ -1,6 +1,6 @@
 import http2 from 'node:http2'
 
-import { send } from '../send-util.js'
+import { send_error } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { Metadata } from '../../defs.js' */
@@ -12,5 +12,5 @@ const { HTTP_STATUS_INSUFFICIENT_STORAGE } = http2.constants
  * @param {Metadata} meta
  */
 export function sendInsufficientStorage(stream, meta) {
-  send(stream, HTTP_STATUS_INSUFFICIENT_STORAGE, {}, [], undefined, undefined, meta)
+	send_error(stream, HTTP_STATUS_INSUFFICIENT_STORAGE, 'Insufficient Storage', undefined, meta)
 }

package/src/response/5xx/not-implemented.js

@@ -1,7 +1,6 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
-import { send } from '../send-util.js'
+import { send_error } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { Metadata } from '../../defs.js' */
@@ -14,5 +13,5 @@ const { HTTP_STATUS_NOT_IMPLEMENTED } = http2.constants
  * @param {Metadata} meta
  */
 export function sendNotImplemented(stream, message, meta) {
-	send(stream, HTTP_STATUS_NOT_IMPLEMENTED, {}, [], CONTENT_TYPE_TEXT, message, meta)
+	send_error(stream, HTTP_STATUS_NOT_IMPLEMENTED, message, undefined, meta)
 }

package/src/response/5xx/unavailable.js

@@ -1,37 +1,20 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
-import { send } from '../send-util.js'
+import { send_error } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { SendInfo, Metadata } from '../../defs.js' */
 
-const {
-	HTTP2_HEADER_RETRY_AFTER
-} = http2.constants
-
 const { HTTP_STATUS_SERVICE_UNAVAILABLE } = http2.constants
 
-/**
- * @param {ServerHttp2Stream} stream
- * @param {string|undefined} message
- * @param {number|undefined} retryAfter
- * @param {Metadata} meta
- */
-export function sendUnavailable(stream, message, retryAfter, meta) {
-	_sendUnavailable(stream, message, { retryAfter }, meta)
-}
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {string|undefined} message
  * @param {Pick<SendInfo, 'retryAfter'>} info
  * @param {Metadata} meta
  */
-export function _sendUnavailable(stream, message, info, meta) {
+export function sendUnavailable(stream, message, info, meta) {
 	const { retryAfter } = info
 
-	send(stream, HTTP_STATUS_SERVICE_UNAVAILABLE, {
-		[HTTP2_HEADER_RETRY_AFTER]: Number.isInteger(retryAfter) ? `${retryAfter}` : undefined
-	}, [ HTTP2_HEADER_RETRY_AFTER ], CONTENT_TYPE_TEXT, message, meta)
+	send_error(stream, HTTP_STATUS_SERVICE_UNAVAILABLE, message, retryAfter, meta)
 }

package/src/response/header-util.js

@@ -27,7 +27,7 @@ const {
  * @returns {OutgoingHttpHeaders}
  */
 export function coreHeaders(status, contentType, exposedHeaders, meta) {
-	const exposed = [ HTTP2_HEADER_ETAG, HTTP2_HEADER_SERVER, ...exposedHeaders ]
+	const exposed = [ HTTP2_HEADER_ETAG, HTTP2_HEADER_SERVER, ...exposedHeaders ] // todo include lastModified
 
 	return {
 		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: meta.origin,

package/src/response/response.js

@@ -1,7 +1,7 @@
 import { sendAccepted } from './2xx/accepted.js'
 import { sendBytes } from './2xx/bytes.js'
 import { sendCreated } from './2xx/created.js'
-import { sendJSON_Encoded } from './2xx/json.js'
+import { sendJSON } from './2xx/json.js'
 import { sendNoContent } from './2xx/no-content.js'
 import { sendPartialContent } from './2xx/partial-content.js'
 import { sendPreflight } from './2xx/preflight.js'
@@ -49,7 +49,7 @@ export const Response = {
 	gone: sendGone,
 	imATeapot: sendImATeapot,
 	insufficientStorage: sendInsufficientStorage,
-	json: sendJSON_Encoded,
+	json: sendJSON,
 	movedPermanently: sendMovedPermanently,
 	multipleChoices: sendMultipleChoices,
 	noContent: sendNoContent,

package/src/response/send-util.js

@@ -12,7 +12,7 @@ import { HTTP_HEADER_ACCEPT_QUERY } from '../defs.js'
 import { CacheControl } from '../headers/cache-control.js'
 import { Conditional } from '../headers/conditional.js'
 import { ContentRange } from '../headers/content-range.js'
-import { CHARSET_UTF8 } from '../headers/content-type.js'
+import { CHARSET_UTF8, CONTENT_TYPE_JSON } from '../headers/content-type.js'
 import {
 	coreHeaders,
 	customHeaders,
@@ -45,9 +45,29 @@ const {
 	HTTP2_HEADER_CONTENT_LENGTH,
 	HTTP2_HEADER_ACCEPT,
 	HTTP2_HEADER_ACCEPT_ENCODING,
-	HTTP2_HEADER_RANGE
+	HTTP2_HEADER_RANGE,
+	HTTP2_HEADER_RETRY_AFTER
 } = http2.constants
 
+/**
+ * @param {ServerHttp2Stream} stream
+ * @param {number} status
+ * @param {string|undefined} message
+ * @param {number|undefined} retryAfter
+ * @param {Metadata} meta
+ */
+export function send_error(stream, status, message, retryAfter, meta) {
+	const obj = JSON.stringify({
+		message: message ?? 'Error'
+	})
+
+	const exposedHeaders = Number.isInteger(retryAfter) ? [ HTTP2_HEADER_RETRY_AFTER ] : []
+
+	send(stream, status, {
+		[HTTP2_HEADER_RETRY_AFTER]: Number.isInteger(retryAfter) ? `${retryAfter}` : undefined
+	}, exposedHeaders, CONTENT_TYPE_JSON, obj, meta) // todo should this be plain text
+}
+
 /** @typedef { (data: InputType) => Buffer<ArrayBuffer> } EncoderFun */
 
 /** @type {Map<string, EncoderFun>} */
@@ -91,7 +111,6 @@ export function send_encoded(stream, status, contentType, body, encoding, etag,
 	send_bytes(stream, status, contentType, encodedData, undefined, undefined, actualEncoding, etag, lastModified, age, cacheControl, acceptRanges, supportedQueryTypes, meta )
 }
 
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {number} status
@@ -127,7 +146,7 @@ export function send_bytes(stream, status, contentType, obj, range, contentLengt
 			[HTTP2_HEADER_CACHE_CONTROL]: CacheControl.encode(cacheControl),
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
 			[HTTP2_HEADER_LAST_MODIFIED]: Conditional.encodeFixDate(lastModified),
-			[HTTP2_HEADER_AGE]: age === undefined ? undefined : `${age}`,
+			[HTTP2_HEADER_AGE]: Number.isInteger(age) ? `${age}` : undefined,
 			[HTTP2_HEADER_CONTENT_LENGTH]: contentLen,
 			[HTTP2_HEADER_CONTENT_RANGE]: ContentRange.encode(range),
 			[HTTP2_HEADER_ACCEPT_RANGES]: acceptRanges,
@@ -173,8 +192,8 @@ export function send(stream, status, headers, exposedHeaders, contentType, body,
 				Readable.fromWeb(body, { signal }),
 				stream,
 				err => {
-					if(err !== null) {
-						console.warn('pipeline error')
+					if(err !== null && err !== undefined) {
+						console.warn('pipeline error', err)
 					}
 				})