@johntalton/http-util 4.0.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johntalton/http-util",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "license": "MIT",
   "type": "module",
   "exports": {

package/src/body.js

@@ -14,8 +14,8 @@ export const DEFAULT_BYTE_LIMIT = 1024 * 1024 //
 /**
  * @typedef {Object} BodyOptions
  * @property {AbortSignal|undefined} [signal]
- * @property {number} [byteLimit]
- * @property {number} [contentLength]
+ * @property {number|undefined} [byteLimit]
+ * @property {number|undefined} [contentLength]
  * @property {ContentType|undefined} [contentType]
  */
 

package/src/rate-limit.js

@@ -1,3 +1,5 @@
+// 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_POLICY = 'RateLimit-Policy'
 

package/src/response/accepted.js

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

package/src/response/conflict.js

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

package/src/response/created.js

@@ -23,5 +23,5 @@ export function sendCreated(stream, location, etag, meta) {
 	send(stream, HTTP_STATUS_CREATED, {
 			[HTTP2_HEADER_LOCATION]: location.href,
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag)
-		}, undefined, undefined, meta)
+		}, [ HTTP2_HEADER_LOCATION ], undefined, undefined, meta)
 }

package/src/response/defs.js

@@ -23,6 +23,7 @@ export const PREFLIGHT_AGE_SECONDS = '500'
  * @property {Array<TimingsInfo>} performance
  * @property {string|undefined} servername
  * @property {string|undefined} origin
+ * @property {Array<[ string, string ]>} customHeaders
  */
 
 /**

package/src/response/error.js

@@ -13,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(stream, HTTP_STATUS_INTERNAL_SERVER_ERROR, {}, [], CONTENT_TYPE_TEXT, message, meta)
 }

package/src/response/header-util.js

@@ -12,19 +12,25 @@ const {
 	HTTP2_HEADER_STATUS,
 	HTTP2_HEADER_SERVER,
 	HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
-	HTTP2_HEADER_CONTENT_TYPE
+	HTTP2_HEADER_CONTENT_TYPE,
+	HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS,
+
+	HTTP2_HEADER_ETAG
 } = http2.constants
 
 /**
  * @param {number} status
  * @param {string|undefined} contentType
+ * @param {Array<string>} exposedHeaders
  * @param {Metadata} meta
  * @returns {OutgoingHttpHeaders}
  */
-export function coreHeaders(status, contentType, meta) {
+export function coreHeaders(status, contentType, exposedHeaders, meta) {
+	const exposed = [ HTTP2_HEADER_ETAG, HTTP2_HEADER_SERVER, ...exposedHeaders ]
+
 	return {
 		[HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN]: meta.origin,
-		// Access-Control-Expose-Headers
+		[HTTP2_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS]: exposed.join(','),
 		// Access-Control-Allow-Credentials // for non-preflight
 		[HTTP2_HEADER_STATUS]: status,
 		[HTTP2_HEADER_CONTENT_TYPE]: contentType,
@@ -42,3 +48,12 @@ export function performanceHeaders(meta) {
 		[HTTP_HEADER_SERVER_TIMING]: ServerTiming.encode(meta.performance)
 	}
 }
+
+/**
+ * @param {Metadata} meta
+ * @returns {OutgoingHttpHeaders}
+ */
+export function customHeaders(meta) {
+	const m = new Map(meta.customHeaders?.filter(h => h[0].startsWith('X-')))
+	return Object.fromEntries(m)
+}

package/src/response/index.js

@@ -9,6 +9,7 @@ export * from './no-content.js'
 export * from './not-acceptable.js'
 export * from './not-allowed.js'
 export * from './not-found.js'
+export * from './not-implemented.js'
 export * from './not-modified.js'
 export * from './precondition-failed.js'
 export * from './preflight.js'
@@ -17,5 +18,6 @@ export * from './timeout.js'
 export * from './too-many-requests.js'
 export * from './trace.js'
 export * from './unauthorized.js'
+export * from './unavailable.js'
 export * from './unprocessable.js'
 export * from './unsupported-media.js'

package/src/response/json.js

@@ -71,5 +71,5 @@ export function sendJSON_Encoded(stream, obj, encoding, etag, age, cacheControl,
 			[HTTP2_HEADER_CACHE_CONTROL]: CacheControl.encode(cacheControl),
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
 			[HTTP2_HEADER_AGE]: age !== undefined ? `${age}` : undefined
-		}, CONTENT_TYPE_JSON, encodedData, meta)
+		}, [ HTTP2_HEADER_AGE ], CONTENT_TYPE_JSON, encodedData, meta)
 }

package/src/response/no-content.js

@@ -20,5 +20,5 @@ const { HTTP_STATUS_NO_CONTENT } = http2.constants
 export function sendNoContent(stream, etag, meta) {
 	send(stream, HTTP_STATUS_NO_CONTENT, {
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag)
-		}, undefined, undefined, meta)
+		}, [], undefined, undefined, meta)
 }

package/src/response/not-acceptable.js

@@ -19,6 +19,7 @@ export function sendNotAcceptable(stream, supportedTypes, meta) {
 	send(stream,
 		HTTP_STATUS_NOT_ACCEPTABLE,
 		{},
+		[],
 		has ? CONTENT_TYPE_JSON : undefined,
 		has ? JSON.stringify(supportedTypes) : undefined,
 		meta)

package/src/response/not-allowed.js

@@ -18,5 +18,5 @@ const { HTTP2_HEADER_ALLOW } = http2.constants
 export function sendNotAllowed(stream, methods, meta) {
 	send(stream, HTTP_STATUS_METHOD_NOT_ALLOWED, {
 			[HTTP2_HEADER_ALLOW]: methods.join(',')
-		}, undefined, undefined, meta)
+		}, [ HTTP2_HEADER_ALLOW ], undefined, undefined, meta)
 }

package/src/response/not-found.js

@@ -13,5 +13,5 @@ const { HTTP_STATUS_NOT_FOUND } = http2.constants
  * @param {Metadata} meta
  */
 export function sendNotFound(stream, message, meta) {
-	send(stream, HTTP_STATUS_NOT_FOUND, {}, CONTENT_TYPE_TEXT, message, meta)
+	send(stream, HTTP_STATUS_NOT_FOUND, {}, [], CONTENT_TYPE_TEXT, message, meta)
 }

package/src/response/not-implemented.js

@@ -0,0 +1,17 @@
+import http2 from 'node:http2'
+import { CONTENT_TYPE_TEXT } from '../content-type.js'
+import { send } from './send-util.js'
+
+/** @import { ServerHttp2Stream } from 'node:http2' */
+/** @import { Metadata } from './defs.js' */
+
+const { HTTP_STATUS_NOT_IMPLEMENTED } = http2.constants
+
+/**
+ * @param {ServerHttp2Stream} stream
+ * @param {string|undefined} message
+ * @param {Metadata} meta
+ */
+export function sendNotImplemented(stream, message, meta) {
+	send(stream, HTTP_STATUS_NOT_IMPLEMENTED, {}, [], CONTENT_TYPE_TEXT, message, meta)
+}

package/src/response/not-modified.js

@@ -30,5 +30,5 @@ export function sendNotModified(stream, etag, age, cacheControl, meta) {
 			[HTTP2_HEADER_CACHE_CONTROL]: CacheControl.encode(cacheControl),
 			[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
 			[HTTP2_HEADER_AGE]: age !== undefined ? `${age}` : undefined
-		}, undefined, undefined, meta)
+		}, [ HTTP2_HEADER_AGE ], undefined, undefined, meta)
 }

package/src/response/precondition-failed.js

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

package/src/response/preflight.js

@@ -35,5 +35,5 @@ export function sendPreflight(stream, methods, meta) {
 			].join(','),
 			[HTTP2_HEADER_ACCESS_CONTROL_MAX_AGE]: PREFLIGHT_AGE_SECONDS
 			// Access-Control-Allow-Credentials
-		}, undefined, undefined, meta)
+		}, [], undefined, undefined, meta)
 }

package/src/response/response.js

@@ -7,6 +7,7 @@ import { sendNoContent } from './no-content.js'
 import { sendNotAcceptable } from './not-acceptable.js'
 import { sendNotAllowed } from './not-allowed.js'
 import { sendNotFound } from './not-found.js'
+import { sendNotImplemented } from './not-implemented.js'
 import { sendNotModified } from './not-modified.js'
 import { sendPreconditionFailed } from './precondition-failed.js'
 import { sendPreflight } from './preflight.js'
@@ -15,6 +16,7 @@ import { sendTimeout } from './timeout.js'
 import { sendTooManyRequests } from './too-many-requests.js'
 import { sendTrace } from './trace.js'
 import { sendUnauthorized } from './unauthorized.js'
+import { sendUnavailable } from './unavailable.js'
 import { sendUnprocessable } from './unprocessable.js'
 import { sendUnsupportedMediaType } from './unsupported-media.js'
 
@@ -28,6 +30,7 @@ export const Response = {
 	notAcceptable: sendNotAcceptable,
 	notAllowed: sendNotAllowed,
 	notFound: sendNotFound,
+	notImplemented: sendNotImplemented,
 	notModified: sendNotModified,
 	preconditionFailed: sendPreconditionFailed,
 	preflight: sendPreflight,
@@ -36,6 +39,7 @@ export const Response = {
 	tooManyRequests: sendTooManyRequests,
 	trace: sendTrace,
 	unauthorized: sendUnauthorized,
+	unavailable: sendUnavailable,
 	unprocessable: sendUnprocessable,
 	unsupportedMediaType: sendUnsupportedMediaType
 }

package/src/response/send-util.js

@@ -1,4 +1,8 @@
-import { coreHeaders, performanceHeaders } from './header-util.js'
+import {
+	coreHeaders,
+	customHeaders,
+	performanceHeaders
+} from './header-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
 /** @import { IncomingHttpHeaders } from 'node:http2' */
@@ -8,24 +12,29 @@ import { coreHeaders, performanceHeaders } from './header-util.js'
  * @param {ServerHttp2Stream} stream
  * @param {number} status
  * @param {IncomingHttpHeaders} headers
+ * @param {Array<string>} exposedHeaders
  * @param {string|undefined} contentType
  * @param {ArrayBufferLike|ArrayBufferView|string|undefined} body
  * @param {Metadata} meta
  */
-export function send(stream, status, headers, contentType, body, meta) {
+export function send(stream, status, headers, exposedHeaders, contentType, body, meta) {
 	// if(status >= 400) { console.warn(status, body) }
 	if(status === 401) { console.warn(status, body) }
 	if(status === 404) { console.warn(status, body) }
-	if(status === 500) { console.warn(status, body) }
+	if(status >= 500) { console.warn(status, body) }
 
 	if(stream === undefined) { return }
 	if(stream.closed) { return }
 
 	if(!stream.headersSent) {
+		const custom = customHeaders(meta)
+		const exposed = [ ...exposedHeaders, ...Object.keys(custom) ]
+
 		stream.respond({
-			...coreHeaders(status, contentType, meta),
+			...coreHeaders(status, contentType, exposed, meta),
 			...performanceHeaders(meta),
-			...headers
+			...headers,
+			...custom
 		})
 	}
 

package/src/response/sse.js

@@ -23,7 +23,7 @@ export function sendSSE(stream, meta) {
 	const status = activeStream ? HTTP_STATUS_OK : SSE_INACTIVE_STATUS_CODE
 
 	stream.respond({
-		...coreHeaders(status, SSE_MIME, meta),
+		...coreHeaders(status, SSE_MIME, [], meta),
 		...performanceHeaders(meta)
 
 		// [HTTP2_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS]: 'true'

package/src/response/timeout.js

@@ -17,5 +17,5 @@ const { HTTP2_HEADER_CONNECTION } = http2.constants
 export function sendTimeout(stream, meta) {
 	send(stream, HTTP_STATUS_REQUEST_TIMEOUT, {
 			[HTTP2_HEADER_CONNECTION]: 'close'
-		}, undefined, undefined, meta)
+		}, [], undefined, undefined, meta)
 }

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

@@ -30,6 +30,11 @@ export function sendTooManyRequests(stream, limitInfo, policies, meta) {
 			[HTTP_HEADER_RATE_LIMIT]: RateLimit.from(limitInfo),
 			[HTTP_HEADER_RATE_LIMIT_POLICY]: RateLimitPolicy.from(...policies)
 		},
+		[
+			HTTP2_HEADER_RETRY_AFTER,
+			HTTP_HEADER_RATE_LIMIT,
+			HTTP_HEADER_RATE_LIMIT_POLICY
+		],
 		CONTENT_TYPE_TEXT,
 		`Retry After ${limitInfo.resetSeconds} Seconds`,
 		meta)

package/src/response/trace.js

@@ -35,5 +35,5 @@ export function sendTrace(stream, method, url, headers, meta) {
 		]
 		.join('\n')
 
-	send(stream, HTTP_STATUS_OK, {}, CONTENT_TYPE_MESSAGE_HTTP, reconstructed, meta)
+	send(stream, HTTP_STATUS_OK, {}, [], CONTENT_TYPE_MESSAGE_HTTP, reconstructed, meta)
 }

package/src/response/unauthorized.js

@@ -13,5 +13,5 @@ const { HTTP_STATUS_UNAUTHORIZED } = http2.constants
 export function sendUnauthorized(stream, meta) {
 	send(stream, HTTP_STATUS_UNAUTHORIZED, {
 			//  WWW-Authenticate
-		}, undefined, undefined, meta)
+		}, [], undefined, undefined, meta)
 }

package/src/response/unavailable.js

@@ -0,0 +1,24 @@
+import http2 from 'node:http2'
+import { CONTENT_TYPE_TEXT } from '../content-type.js'
+import { send } from './send-util.js'
+
+/** @import { ServerHttp2Stream } from 'node:http2' */
+/** @import { 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) {
+	send(stream, HTTP_STATUS_SERVICE_UNAVAILABLE, {
+		[HTTP2_HEADER_RETRY_AFTER]: Number.isInteger(retryAfter) ? `${retryAfter}` : undefined
+	}, [ HTTP2_HEADER_RETRY_AFTER ], CONTENT_TYPE_TEXT, message, meta)
+}

package/src/response/unprocessable.js

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

package/src/response/unsupported-media.js

@@ -17,5 +17,5 @@ export function sendUnsupportedMediaType(stream, acceptableMediaType, meta) {
 
 	send(stream, HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, {
 			[HTTP_HEADER_ACCEPT_POST]: acceptable.join(',')
-		}, undefined, undefined, meta)
+		}, [ HTTP_HEADER_ACCEPT_POST ], undefined, undefined, meta)
 }