@johntalton/http-util 6.0.0 → 7.0.1

package/src/response/response.js

@@ -1,18 +1,20 @@
 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'
 import { sendSSE } from './2xx/sse.js'
 import { sendTrace } from './2xx/trace.js'
+import { sendFound } from './3xx/found.js'
 import { sendMovedPermanently } from './3xx/moved-permanently.js'
 import { sendMultipleChoices } from './3xx/multiple-choices.js'
 import { sendNotModified } from './3xx/not-modified.js'
 import { sendPermanentRedirect } from './3xx/permanent-redirect.js'
 import { sendSeeOther } from './3xx/see-other.js'
 import { sendTemporaryRedirect } from './3xx/temporary-redirect.js'
+import { sendBadRequest } from './4xx/bad-request.js'
 import { sendConflict } from './4xx/conflict.js'
 import { sendContentTooLarge } from './4xx/content-too-large.js'
 import { sendForbidden } from './4xx/forbidden.js'
@@ -21,6 +23,7 @@ import { sendImATeapot } from './4xx/im-a-teapot.js'
 import { sendNotAcceptable } from './4xx/not-acceptable.js'
 import { sendNotAllowed } from './4xx/not-allowed.js'
 import { sendNotFound } from './4xx/not-found.js'
+import { sendPaymentRequired } from './4xx/payment-required.js'
 import { sendPreconditionFailed } from './4xx/precondition-failed.js'
 import { sendRangeNotSatisfiable } from './4xx/range-not-satisfiable.js'
 import { sendTimeout } from './4xx/timeout.js'
@@ -35,16 +38,18 @@ import { sendUnavailable } from './5xx/unavailable.js'
 
 export const Response = {
 	accepted: sendAccepted,
+	badRequest: sendBadRequest,
 	bytes: sendBytes,
 	conflict: sendConflict,
 	contentTooLarge: sendContentTooLarge,
 	created: sendCreated,
 	error: sendError,
 	forbidden: sendForbidden,
+	found: sendFound,
 	gone: sendGone,
 	imATeapot: sendImATeapot,
 	insufficientStorage: sendInsufficientStorage,
-	json: sendJSON_Encoded,
+	json: sendJSON,
 	movedPermanently: sendMovedPermanently,
 	multipleChoices: sendMultipleChoices,
 	noContent: sendNoContent,
@@ -54,6 +59,7 @@ export const Response = {
 	notImplemented: sendNotImplemented,
 	notModified: sendNotModified,
 	partialContent: sendPartialContent,
+	paymentRequired: sendPaymentRequired,
 	permanentRedirect: sendPermanentRedirect,
 	preconditionFailed: sendPreconditionFailed,
 	preflight: sendPreflight,

package/src/response/send-util.js

@@ -1,5 +1,5 @@
 import http2 from 'node:http2'
-import { Readable } from 'node:stream'
+import { pipeline, Readable } from 'node:stream'
 import { ReadableStream } from 'node:stream/web'
 import {
 	brotliCompressSync,
@@ -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,
@@ -22,8 +22,8 @@ import {
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { OutgoingHttpHeaders } from 'node:http2' */
 /** @import { InputType } from 'node:zlib' */
-/** @import { Metadata, SendBody } from '../defs.js' */
-/** @import { EtagItem } from '../headers/conditional.js' */
+/** @import { AcceptRangeUnits, 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' */
 
@@ -38,16 +38,37 @@ const {
 	HTTP2_HEADER_VARY,
 	HTTP2_HEADER_CACHE_CONTROL,
 	HTTP2_HEADER_ETAG,
+	HTTP2_HEADER_LAST_MODIFIED,
 	HTTP2_HEADER_AGE,
 	HTTP2_HEADER_ACCEPT_RANGES,
 	HTTP2_HEADER_CONTENT_RANGE,
 	HTTP2_HEADER_CONTENT_LENGTH,
 	HTTP2_HEADER_ACCEPT,
 	HTTP2_HEADER_ACCEPT_ENCODING,
-	HTTP2_HEADER_RANGE
+	HTTP2_HEADER_RANGE,
+	HTTP2_HEADER_RETRY_AFTER
 } = http2.constants
 
-/** @typedef { (data: InputType) => Buffer } EncoderFun */
+/**
+ * @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>} */
 export const ENCODER_MAP = new Map([
@@ -64,13 +85,14 @@ export const ENCODER_MAP = new Map([
  * @param {SendBody} body
  * @param {string|undefined} encoding
  * @param {EtagItem|undefined} etag
+ * @param {IMFFixDateInput|string|undefined} lastModified
  * @param {number|undefined} age
  * @param {CacheControlOptions|undefined} cacheControl
- * @param {'bytes'|'none'|undefined} acceptRanges
+ * @param {AcceptRangeUnits|undefined} acceptRanges
  * @param {Array<string>|undefined} supportedQueryTypes
  * @param {Metadata} meta
  */
-export function send_encoded(stream, status, contentType, body, encoding, etag, age, cacheControl, acceptRanges, supportedQueryTypes, meta) {
+export function send_encoded(stream, status, contentType, body, encoding, etag, lastModified, age, cacheControl, acceptRanges, supportedQueryTypes, meta) {
 	const obj = (typeof body === 'string') ? Buffer.from(body, CHARSET_UTF8) : body
 
 	const useIdentity = encoding === 'identity'
@@ -86,10 +108,9 @@ export function send_encoded(stream, status, contentType, body, encoding, etag,
 		{ name: 'encode', duration: encodeEnd - encodeStart }
 	)
 
-	send_bytes(stream, status, contentType, encodedData, undefined, undefined, actualEncoding, etag, age, cacheControl, acceptRanges, supportedQueryTypes, meta )
+	send_bytes(stream, status, contentType, encodedData, undefined, undefined, actualEncoding, etag, lastModified, age, cacheControl, acceptRanges, supportedQueryTypes, meta )
 }
 
-
 /**
  * @param {ServerHttp2Stream} stream
  * @param {number} status
@@ -99,13 +120,14 @@ export function send_encoded(stream, status, contentType, body, encoding, etag,
  * @param {number|undefined} contentLength
  * @param {string|undefined} encoding
  * @param {EtagItem|undefined} etag
+ * @param {IMFFixDateInput|string|undefined} lastModified
  * @param {number|undefined} age
  * @param {CacheControlOptions|undefined} cacheControl
- * @param {'bytes'|'none'|undefined} acceptRanges
+ * @param {AcceptRangeUnits|undefined} acceptRanges
  * @param {Array<string>|undefined} supportedQueryTypes
  * @param {Metadata} meta
  */
-export function send_bytes(stream, status, contentType, obj, range, contentLength, encoding, etag, age, cacheControl, acceptRanges, supportedQueryTypes, meta) {
+export function send_bytes(stream, status, contentType, obj, range, contentLength, encoding, etag, lastModified, age, cacheControl, acceptRanges, supportedQueryTypes, meta) {
 	const contentLen = Number.isInteger(contentLength) ? `${contentLength}` : undefined
 	const supportsQuery = supportedQueryTypes !== undefined && supportedQueryTypes.length > 0
 
@@ -123,7 +145,8 @@ export function send_bytes(stream, status, contentType, obj, range, contentLengt
 			[HTTP2_HEADER_VARY]: varyHeaders.join(','),
 			[HTTP2_HEADER_CACHE_CONTROL]: CacheControl.encode(cacheControl),
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
-			[HTTP2_HEADER_AGE]: age === undefined ? undefined : `${age}`,
+			[HTTP2_HEADER_LAST_MODIFIED]: Conditional.encodeFixDate(lastModified),
+			[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,
@@ -164,7 +187,16 @@ export function send(stream, status, headers, exposedHeaders, contentType, body,
 
 	if(stream.writable && body !== undefined) {
 		if(body instanceof ReadableStream) {
-			Readable.fromWeb(body).pipe(stream)
+			const signal = undefined // AbortSignal.timeout(1000)
+			pipeline(
+				Readable.fromWeb(body, { signal }),
+				stream,
+				err => {
+					if(err !== null && err !== undefined) {
+						console.warn('pipeline error', err)
+					}
+				})
+
 			return
 		}