@johntalton/http-core 1.0.2 → 1.0.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@johntalton/http-core",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "license": "MIT",
   "exports": {
     ".": "./src/index.js"
@@ -15,7 +15,7 @@
   "scripts": {
   },
   "dependencies": {
-    "@johntalton/http-util": "^5.0.1",
+    "@johntalton/http-util": "^6.0.0",
     "@johntalton/sse-util": "^1.0.0"
   }
 }

package/src/epilogue.js

@@ -24,7 +24,7 @@ function addSSEPortHandler(stream, port, streamId, shutdownSignal) {
 		port.close()
 	}))
 
-	shutdownSignal.addEventListener('abort', signalHandler)
+	shutdownSignal.addEventListener('abort', signalHandler, { once: true })
 
 	// ServerSentEvents.messageToEventStreamLines({
 	// 		comment: 'Welcome',
@@ -47,24 +47,25 @@ function addSSEPortHandler(stream, port, streamId, shutdownSignal) {
 export function epilogue(state) {
 	const { type, stream, meta, streamId } = state
 
-	meta.customHeaders.push([ 'X-Request-Id', streamId ])
+	meta.customHeaders?.push([ 'X-Request-Id', streamId ])
 
 	switch(type) {
 		//
 		case 'trace': { Response.trace(stream, state.method, state.url, state.headers, meta) } break
 		//
 		case 'preflight': { Response.preflight(stream, state.methods, state.supportedQueryTypes, undefined, meta) } break
-		// case 'no-content': { Response.noContent(stream, state.etag, meta)} break
+		case 'no-content': { Response.noContent(stream, state.etag, meta)} break
 		// case 'accepted': { Response.accepted(stream, meta) } break
 		case 'created': { Response.created(stream, new URL(state.location, meta.origin), state.etag, meta) } break
 		case 'not-modified': { Response.notModified(stream, state.etag, state.age, { priv: true, maxAge: 60 }, meta) } break
 
 		//
 		// case 'multiple-choices': { Response.multipleChoices(stream, meta) } break
-		// case 'gone': { Response.gone(stream, meta) } break
-		// case 'moved-permanently': { Response.movedPermanently(stream, state.location, meta) } break
-		// case 'see-other': { Response.seeOther(stream, state.location, meta) } break
-		// case 'temporary-redirect': { Response.temporaryRedirect(stream, state.location, meta) } break
+		case 'gone': { Response.gone(stream, meta) } break
+		case 'moved-permanently': { Response.movedPermanently(stream, state.location, meta) } break
+		case 'see-other': { Response.seeOther(stream, state.location, meta) } break
+		case 'temporary-redirect': { Response.temporaryRedirect(stream, state.location, meta) } break
+		case 'permanent-redirect': { Response.permanentRedirect(stream, state.location, meta) } break
 
 		//
 		case '404': { Response.notFound(stream, state.message, meta) } break
@@ -75,13 +76,14 @@ export function epilogue(state) {
 		case 'unprocessable': { Response.unprocessable(stream, meta) } break
 		case 'precondition-failed': { Response.preconditionFailed(stream, meta) } break
 		case 'not-satisfiable': { Response.rangeNotSatisfiable(stream, { size: state.contentLength }, meta) } break
-		// case 'content-too-large': { Response.contentTooLarge(stream, meta) } break
-		// case 'insufficient-storage': { Response.insufficientStorage(stream, meta) } break
-		// case 'too-many-requests': { Response.tooManyRequests(stream, state.limit, state.policies, meta) } break
-		// case 'unauthorized': { Response.unauthorized(stream, meta) } break
+		case 'content-too-large': { Response.contentTooLarge(stream, meta) } break
+		case 'insufficient-storage': { Response.insufficientStorage(stream, meta) } break
+		case 'too-many-requests': { Response.tooManyRequests(stream, state.limit, state.policies, meta) } break
+		case 'unauthorized': { Response.unauthorized(stream, state.challenge, meta) } break
+		case 'forbidden': { Response.forbidden(stream, meta) } break
 		case 'unavailable': { Response.unavailable(stream, state.message, state.retryAfter, meta)} break
 		case 'not-implemented': { Response.notImplemented(stream, state.message, meta)} break
-		// case 'timeout': { Response.timeout(stream, meta) } break
+		case 'timeout': { Response.timeout(stream, meta) } break
 
 		//
 		case 'sse': {

package/src/index.js

@@ -1,3 +1,4 @@
+/** biome-ignore-all lint/nursery/noExcessiveLinesPerFile: legacy */
 import crypto from 'node:crypto'
 import fs from 'node:fs'
 import http2 from 'node:http2'
@@ -41,14 +42,48 @@ export const KNOWN_METHODS = [
 
 /** @import { Metadata } from '@johntalton/http-util/response' */
 /** @import { BodyFuture } from '@johntalton/http-util/body' */
-/** @import { EtagItem, IMFFixDate, ContentRangeDirective } from '@johntalton/http-util/headers' */
+/** @import { EtagItem, IMFFixDate, ContentRangeDirective, RateLimitPolicyInfo, RateLimitInfo, ChallengeItem } from '@johntalton/http-util/headers' */
 /** @import { SendBody } from '@johntalton/http-util/response' */
+/** @import { SecFetchSite, SecFetchMode, SecFetchDest } from '@johntalton/http-util/headers' */
+
 
 /** @typedef {(state: RouteRequest|RouteAction) => Promise<RouteAction>} Router */
 
 /** @typedef {'request'} RouteTypeRequest */
-/** @typedef {'partial-bytes'|'bytes'|'json'|'404'|'sse'|'error'|'preflight'|'not-allowed'|'trace'|'created'|'unsupported-media'|'not-modified'|'precondition-failed'|'unprocessable'|'not-acceptable'|'conflict'|'not-implemented'|'unavailable'|'not-satisfiable'} RouteType */
-/** @typedef {'GET'|'HEAD'|'POST'|'PUT'|'OPTIONS'|'DELETE'|'TRACE'} RouteMethod */
+/** @typedef {
+	'partial-bytes' |
+	'bytes' |
+	'json' |
+	'404' |
+	'sse' |
+	'error' |
+	'preflight' |
+	'not-allowed' |
+	'trace' |
+	'created' |
+	'unsupported-media' |
+	'not-modified' |
+	'precondition-failed' |
+	'unprocessable' |
+	'not-acceptable' |
+	'conflict' |
+	'not-implemented' |
+	'unavailable' |
+	'not-satisfiable' |
+	'see-other' |
+	'temporary-redirect' |
+	'permanent-redirect' |
+	'moved-permanently' |
+	'gone' |
+	'no-content' |
+	'content-too-large' |
+	'insufficient-storage' |
+	'too-many-requests' |
+	'unauthorized' |
+	'forbidden' |
+	'timeout'
+} RouteType */
+/** @typedef {'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'OPTIONS'|'DELETE'|'TRACE'|'QUERY'} RouteMethod */
 
 /** @typedef {string & { readonly _brand: 'sid' }} StreamID */
 
@@ -77,6 +112,7 @@ export const KNOWN_METHODS = [
  * @property {RouteRequestAccept} accept
  * @property {RouteRemoteClient} client
  * @property {RouteConditions} conditions
+ * @property {SecFetchMetadata} secFetchMetadata
  * @property {string} SNI
  */
 /** @typedef {RouteBase & RouteRequestBase} RouteRequest */
@@ -132,6 +168,14 @@ export const KNOWN_METHODS = [
  * @property {IMFFixDate|EtagItem|undefined} [range]
  */
 
+/**
+ * @typedef {Object} SecFetchMetadata
+ * @property {SecFetchSite|undefined} site
+ * @property {SecFetchMode|undefined} mode
+ * @property {SecFetchDest|undefined} dest
+ */
+
+
 /**
  * @typedef {Object} RoutePreflightBase
  * @property {'preflight'} type
@@ -277,6 +321,85 @@ export const KNOWN_METHODS = [
  */
 /** @typedef {RouteBase & RouteNotSatisfiableBase} RouteNotSatisfiable */
 
+/**
+ * @typedef {Object} RouteSeeOtherBase
+ * @property {'see-other'} type
+ * @property {URL} location
+ */
+/** @typedef {RouteBase & RouteSeeOtherBase} RouteSeeOther */
+
+/**
+ * @typedef {Object} RouteTemporaryRedirectBase
+ * @property {'temporary-redirect'} type
+ * @property {URL} location
+ */
+/** @typedef {RouteBase & RouteTemporaryRedirectBase} RouteTemporaryRedirect */
+
+/**
+ * @typedef {Object} RoutePermanentRedirectBase
+ * @property {'permanent-redirect'} type
+ * @property {URL} location
+ */
+/** @typedef {RouteBase & RoutePermanentRedirectBase} RoutePermanentRedirect */
+
+/**
+ * @typedef {Object} RouteMovedPermanentlyBase
+ * @property {'moved-permanently'} type
+ * @property {URL} location
+ */
+/** @typedef {RouteBase & RouteMovedPermanentlyBase} RouteMovedPermanently */
+
+/**
+ * @typedef {Object} RouteNoContentBase
+ * @property {'no-content'} type
+ * @property {EtagItem|undefined} [etag]
+ */
+/** @typedef {RouteBase & RouteNoContentBase} RouteNoContent */
+
+/**
+ * @typedef {Object} RouteGoneBase
+ * @property {'gone'} type
+ */
+/** @typedef {RouteBase & RouteGoneBase} RouteGone */
+
+/**
+ * @typedef {Object} RouteContentTooLargeBase
+ * @property {'content-too-large'} type
+ */
+/** @typedef {RouteBase & RouteContentTooLargeBase} RouteContentTooLarge */
+
+/**
+ * @typedef {Object} RouteInsufficientStorageBase
+ * @property {'insufficient-storage'} type
+ */
+/** @typedef {RouteBase & RouteInsufficientStorageBase} RouteInsufficientStorage */
+
+/**
+ * @typedef {Object} RouteTooManyRequestsBase
+ * @property {'too-many-requests'} type
+ * @property {RateLimitInfo} limit
+ * @property {Array<RateLimitPolicyInfo>} policies
+ */
+/** @typedef {RouteBase & RouteTooManyRequestsBase} RouteTooManyRequests */
+
+/**
+ * @typedef {Object} RouteUnauthorizedBase
+ * @property {'unauthorized'} type
+ * @property {Array<ChallengeItem>} challenge
+ */
+/** @typedef {RouteBase & RouteUnauthorizedBase} RouteUnauthorized */
+
+/**
+ * @typedef {Object} RouteForbiddenBase
+ * @property {'forbidden'} type
+ */
+/** @typedef {RouteBase & RouteForbiddenBase} RouteForbidden */
+
+/**
+ * @typedef {Object} RouteTimeoutBase
+ * @property {'timeout'} type
+ */
+/** @typedef {RouteBase & RouteTimeoutBase} RouteTimeout */
 
 /**
  * @typedef {Object} RouteSSEBase
@@ -307,7 +430,19 @@ export const KNOWN_METHODS = [
 	RouteNotImplemented |
 	RouteUnavailable |
 	RoutePartialBytes |
-	RouteNotSatisfiable
+	RouteNotSatisfiable |
+	RouteSeeOther |
+	RouteTemporaryRedirect |
+	RoutePermanentRedirect |
+	RouteMovedPermanently |
+	RouteNoContent |
+	RouteGone |
+	RouteContentTooLarge |
+	RouteInsufficientStorage |
+	RouteTooManyRequests |
+	RouteUnauthorized |
+	RouteForbidden |
+	RouteTimeout
 } RouteAction */
 
 /** @typedef {Record<string, string|undefined>} RouteMatches */

package/src/preamble.js

@@ -1,3 +1,4 @@
+/** biome-ignore-all lint/nursery/noExcessiveLinesPerFile: does all the work */
 import http2 from 'node:http2'
 import { TLSSocket } from 'node:tls'
 
@@ -8,6 +9,7 @@ import {
 	AcceptLanguage,
 
 	Conditional,
+	ContentType,
 	ETag,
 
 	FORWARDED_KEY_FOR,
@@ -19,18 +21,21 @@ import {
 	MIME_TYPE_MESSAGE_HTTP,
 	MIME_TYPE_TEXT,
 	MIME_TYPE_XML,
-	parseContentType
+	SecFetch
 } from '@johntalton/http-util/headers'
 import {
 	ENCODER_MAP,
 	HTTP_HEADER_FORWARDED,
-	HTTP_HEADER_ORIGIN
+	HTTP_HEADER_ORIGIN,
+	HTTP_HEADER_SEC_FETCH_DEST,
+	HTTP_HEADER_SEC_FETCH_MODE,
+	HTTP_HEADER_SEC_FETCH_SITE
 } from '@johntalton/http-util/response'
 
 import { isValidHeader, isValidLikeHeader, isValidMethod } from './index.js'
 
 /** @import { ServerHttp2Stream, IncomingHttpHeaders } from 'node:http2' */
-/** @import { Config, RouteRequest, RouteAction, StreamID, RouteConditions } from './index.js' */
+/** @import { Config, RouteRequest, RouteAction, StreamID, RouteConditions, SecFetchMetadata } from './index.js' */
 
 const { HTTP2_METHOD_OPTIONS, HTTP2_METHOD_TRACE } = http2.constants
 
@@ -142,9 +147,9 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	// const secUA = header[HTTP_HEADER_SEC_CH_UA]
 	// const secPlatform = header[HTTP_HEADER_SEC_CH_PLATFORM]
 	// const secMobile = header[HTTP_HEADER_SEC_CH_MOBILE]
-	// const secFetchSite = header[HTTP_HEADER_SEC_FETCH_SITE]
-	// const secFetchMode = header[HTTP_HEADER_SEC_FETCH_MODE]
-	// const secFetchDest = header[HTTP_HEADER_SEC_FETCH_DEST]
+	const secFetchSite = headers[HTTP_HEADER_SEC_FETCH_SITE]
+	const secFetchMode = headers[HTTP_HEADER_SEC_FETCH_MODE]
+	const secFetchDest = headers[HTTP_HEADER_SEC_FETCH_DEST]
 
 	//
 	const allowedOrigin = (ALLOWED_ORIGINS.includes('*') || ((origin !== undefined) && URL.canParse(origin) && ALLOWED_ORIGINS.includes(origin))) ? origin : undefined
@@ -200,6 +205,15 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	const requestUrl = new URL(fullPathAndQuery, `${scheme}://${authority}`)
 
+	// Sec Fetch Metadata
+	/** @type {SecFetchMetadata} */
+	const secFetchMetadata = {
+		site: SecFetch.parseSite(secFetchSite),
+		mode: SecFetch.parseMode(secFetchMode),
+		dest: SecFetch.parseDestination(secFetchDest)
+	}
+
+
 	//
 	/** @type {RouteConditions} */
 	const conditions = {
@@ -240,7 +254,7 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	// content negotiation
 	//
-	const contentType = parseContentType(fullContentType)
+	const contentType = ContentType.parse(fullContentType)
 	const acceptedEncoding = AcceptEncoding.select(fullAcceptEncoding, DEFAULT_SUPPORTED_ENCODINGS)
 	const accept = Accept.select(fullAccept, DEFAULT_SUPPORTED_MIME_TYPES)
 	const acceptedLanguage = AcceptLanguage.select(fullAcceptLanguage, DEFAULT_SUPPORTED_LANGUAGES)
@@ -255,7 +269,7 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 	//
 	if(method === HTTP2_METHOD_TRACE) {
 		if(!ALLOW_TRACE) { return { ...state, type: 'not-allowed', method, methods: [], url: requestUrl }}
-		const maxForwardsValue = maxForwards !== undefined ? Number.parseInt(maxForwards) : 0
+		const maxForwardsValue = maxForwards === undefined ? 0 : Number.parseInt(maxForwards)
 		const preambleEnd = performance.now()
 		state.meta.performance.push({ name: 'preamble-trace', duration: preambleEnd - preambleStart })
 		if(acceptObject.type !== MIME_TYPE_MESSAGE_HTTP) { return { ...state, type: 'not-acceptable', acceptableMediaTypes: [ MIME_TYPE_MESSAGE_HTTP ] } }
@@ -294,6 +308,7 @@ export function preamble(config, streamId, stream, headers, servername, shutdown
 		body,
 		// tokens,
 		conditions,
+		secFetchMetadata,
 		accept: acceptObject,
 		client: { family, ip, port },
 		SNI