@johntalton/http-util 5.1.6 → 6.1.0

package/src/response/{not-found.js → 4xx/not-found.js}

@@ -1,10 +1,10 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../content-type.js'
-import { send } from './send-util.js'
+import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const { HTTP_STATUS_NOT_FOUND } = http2.constants
 

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

@@ -0,0 +1,17 @@
+import  http2 from 'node:http2'
+
+import { send } from '../send-util.js'
+
+/** @import { ServerHttp2Stream } from 'node:http2' */
+/** @import { Metadata } from '../../defs.js' */
+
+const { HTTP_STATUS_PAYMENT_REQUIRED } = http2.constants
+
+/**
+ * @param {ServerHttp2Stream} stream
+ * @param {Metadata} meta
+ */
+export function sendPaymentRequired(stream, meta) {
+	send(stream, HTTP_STATUS_PAYMENT_REQUIRED, {
+	}, [ ], undefined, undefined, meta)
+}

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

@@ -0,0 +1,45 @@
+import http2 from 'node:http2'
+
+import { Conditional } from '../../headers/conditional.js'
+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,
+	HTTP2_HEADER_LAST_MODIFIED
+} = http2.constants
+
+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) {
+	const {
+		etag,
+		lastModified
+	} = content
+
+	send(stream, HTTP_STATUS_PRECONDITION_FAILED, {
+		[HTTP2_HEADER_ETAG]: Conditional.encodeEtag(etag),
+		[HTTP2_HEADER_LAST_MODIFIED]: Conditional.encodeFixDate(lastModified)
+	}, [], undefined, undefined, meta)
+}

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

@@ -1,11 +1,11 @@
 import http2 from 'node:http2'
 
-import { CONTENT_RANGE_UNKNOWN, ContentRange } from '../content-range.js'
-import { send } from './send-util.js'
+import { CONTENT_RANGE_UNKNOWN, ContentRange } from '../../headers/content-range.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
-/** @import { ContentRangeDirective} from '../content-range.js' */
+/** @import { SendContent, Metadata } from '../../defs.js' */
+/** @import { ContentRangeDirective} from '../../headers/content-range.js' */
 
 const {
 	HTTP2_HEADER_CONTENT_RANGE
@@ -19,6 +19,17 @@ const { HTTP_STATUS_RANGE_NOT_SATISFIABLE } = http2.constants
  * @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) {
+	const { rangeDirective } = content
+
 	/** @type {ContentRangeDirective} */
 	const invalidRange = { size: rangeDirective.size, range: CONTENT_RANGE_UNKNOWN }
 

package/src/response/{timeout.js → 4xx/timeout.js}

@@ -1,9 +1,9 @@
 import http2 from 'node:http2'
 
-import { send } from './send-util.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const {
 	HTTP_STATUS_REQUEST_TIMEOUT

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

@@ -1,17 +1,17 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../content-type.js'
+import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
 import {
 	HTTP_HEADER_RATE_LIMIT,
 	HTTP_HEADER_RATE_LIMIT_POLICY,
 	RateLimit,
 	RateLimitPolicy
-} from '../rate-limit.js'
-import { send } from './send-util.js'
+} from '../../headers/rate-limit.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
-/** @import { RateLimitInfo, RateLimitPolicyInfo } from '../rate-limit.js' */
+/** @import { SendInfo, Metadata } from '../../defs.js' */
+/** @import { RateLimitInfo, RateLimitPolicyInfo } from '../../headers/rate-limit.js' */
 
 const {
 	HTTP2_HEADER_RETRY_AFTER
@@ -26,6 +26,23 @@ const { HTTP_STATUS_TOO_MANY_REQUESTS } = http2.constants
  * @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) {
+	const {
+		limitInfo,
+		policies
+	} = info
+
 	send(stream, HTTP_STATUS_TOO_MANY_REQUESTS, {
 			[HTTP2_HEADER_RETRY_AFTER]: `${limitInfo.resetSeconds}`,
 			[HTTP_HEADER_RATE_LIMIT]: RateLimit.from(limitInfo),

package/src/response/{unauthorized.js → 4xx/unauthorized.js}

@@ -1,11 +1,11 @@
 import http2 from 'node:http2'
 
-import { Challenge } from '../www-authenticate.js'
-import { send } from './send-util.js'
+import { Challenge } from '../../headers/www-authenticate.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
-/** @import { ChallengeItem } from '../www-authenticate.js' */
+/** @import { Metadata } from '../../defs.js' */
+/** @import { ChallengeItem } from '../../headers/www-authenticate.js' */
 
 const {
 	HTTP2_HEADER_WWW_AUTHENTICATE
@@ -20,6 +20,6 @@ const { HTTP_STATUS_UNAUTHORIZED } = http2.constants
  */
 export function sendUnauthorized(stream, challenge, meta) {
 	send(stream, HTTP_STATUS_UNAUTHORIZED, {
-			[HTTP2_HEADER_WWW_AUTHENTICATE]: challenge?.map(Challenge.encode),
+			[HTTP2_HEADER_WWW_AUTHENTICATE]: challenge?.map(Challenge.encode), // todo stringify ?
 		}, [ HTTP2_HEADER_WWW_AUTHENTICATE ], undefined, undefined, meta)
 }

package/src/response/{unprocessable.js → 4xx/unprocessable.js}

@@ -1,9 +1,9 @@
 import http2 from 'node:http2'
 
-import { send } from './send-util.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const { HTTP_STATUS_UNPROCESSABLE_ENTITY } = http2.constants
 

package/src/response/{unsupported-media.js → 4xx/unsupported-media.js}

@@ -1,10 +1,10 @@
 import http2 from 'node:http2'
 
-import { HTTP_HEADER_ACCEPT_PATCH, HTTP_HEADER_ACCEPT_POST, HTTP_HEADER_ACCEPT_QUERY } from './defs.js'
-import { send } from './send-util.js'
+import { HTTP_HEADER_ACCEPT_PATCH, HTTP_HEADER_ACCEPT_POST, HTTP_HEADER_ACCEPT_QUERY } from '../../defs.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { SendInfo, Metadata } from '../../defs.js' */
 
 const { HTTP2_METHOD_POST, HTTP2_METHOD_PATCH } = http2.constants
 
@@ -17,11 +17,28 @@ const { HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE } = http2.constants
  * @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) {
+	const {
+		supportedQueryTypes,
+		acceptableMediaType
+	} = info
+
 	const supportsQuery = supportedQueryTypes !== undefined && supportedQueryTypes.length > 0
 	const exposedHeaders = supportsQuery ? [ HTTP_HEADER_ACCEPT_QUERY, HTTP_HEADER_ACCEPT_POST ] : [ HTTP_HEADER_ACCEPT_POST ]
 
 	const method = HTTP2_METHOD_POST // todo pass in as parameter or split acceptable to post and patch types
-	const acceptable = Array.isArray(acceptableMediaType) ? acceptableMediaType : [ acceptableMediaType ]
+	const acceptable = Array.isArray(acceptableMediaType) ? acceptableMediaType : [ acceptableMediaType ] // todo undefined creates array of one item
 	const acceptHeader = (method === HTTP2_METHOD_POST) ? HTTP_HEADER_ACCEPT_POST : HTTP_HEADER_ACCEPT_PATCH
 	const acceptValue = ((method === HTTP2_METHOD_POST) || (method === HTTP2_METHOD_PATCH)) ? acceptable.join(',') : undefined
 

package/src/response/{error.js → 5xx/error.js}

@@ -1,10 +1,10 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../content-type.js'
-import { send } from './send-util.js'
+import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const { HTTP_STATUS_INTERNAL_SERVER_ERROR } = http2.constants
 

package/src/response/{insufficient-storage.js → 5xx/insufficient-storage.js}

@@ -1,9 +1,9 @@
 import http2 from 'node:http2'
 
-import { send } from './send-util.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const { HTTP_STATUS_INSUFFICIENT_STORAGE } = http2.constants
 

package/src/response/{not-implemented.js → 5xx/not-implemented.js}

@@ -1,10 +1,10 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../content-type.js'
-import { send } from './send-util.js'
+import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../../defs.js' */
 
 const { HTTP_STATUS_NOT_IMPLEMENTED } = http2.constants
 
@@ -15,4 +15,4 @@ const { HTTP_STATUS_NOT_IMPLEMENTED } = http2.constants
  */
 export function sendNotImplemented(stream, message, meta) {
 	send(stream, HTTP_STATUS_NOT_IMPLEMENTED, {}, [], CONTENT_TYPE_TEXT, message, meta)
-}
+}

package/src/response/{unavailable.js → 5xx/unavailable.js}

@@ -1,10 +1,10 @@
 import http2 from 'node:http2'
 
-import { CONTENT_TYPE_TEXT } from '../content-type.js'
-import { send } from './send-util.js'
+import { CONTENT_TYPE_TEXT } from '../../headers/content-type.js'
+import { send } from '../send-util.js'
 
 /** @import { ServerHttp2Stream } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { SendInfo, Metadata } from '../../defs.js' */
 
 const {
 	HTTP2_HEADER_RETRY_AFTER
@@ -19,7 +19,19 @@ const { HTTP_STATUS_SERVICE_UNAVAILABLE } = http2.constants
  * @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) {
+	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)
-}
+}

package/src/response/header-util.js

@@ -4,10 +4,10 @@ import {
 	HTTP_HEADER_SERVER_TIMING,
 	HTTP_HEADER_TIMING_ALLOW_ORIGIN,
 	ServerTiming
-} from '../server-timing.js'
+} from '../headers/server-timing.js'
 
 /** @import { OutgoingHttpHeaders } from 'node:http2' */
-/** @import { Metadata } from './defs.js' */
+/** @import { Metadata } from '../defs.js' */
 
 const {
 	HTTP2_HEADER_STATUS,

package/src/response/index.js

@@ -1,40 +1,44 @@
 /** biome-ignore-all lint/performance/noBarrelFile: entry point */
 /** biome-ignore-all lint/performance/noReExportAll: entry point */
-export * from './defs.js'
+export * from '../defs.js'
+export * from './header-util.js'
 export * from './send-util.js'
 // end common headers
 
-export * from './accepted.js'
-export * from './bytes.js'
-export * from './conflict.js'
-export * from './content-too-large.js'
-export * from './created.js'
-export * from './error.js'
-export * from './forbidden.js'
-export * from './gone.js'
-export * from './im-a-teapot.js'
-export * from './insufficient-storage.js'
-export * from './json.js'
-export * from './moved-permanently.js'
-export * from './multiple-choices.js'
-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 './partial-content.js'
-export * from './permanent-redirect.js'
-export * from './precondition-failed.js'
-export * from './preflight.js'
-export * from './range-not-satisfiable.js'
-export * from './see-other.js'
-export * from './sse.js'
-export * from './temporary-redirect.js'
-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'
+export * from './2xx/accepted.js'
+export * from './2xx/bytes.js'
+export * from './2xx/created.js'
+export * from './2xx/json.js'
+export * from './2xx/no-content.js'
+export * from './2xx/partial-content.js'
+export * from './2xx/preflight.js'
+export * from './2xx/sse.js'
+export * from './2xx/trace.js'
+export * from './3xx/found.js'
+export * from './3xx/moved-permanently.js'
+export * from './3xx/multiple-choices.js'
+export * from './3xx/not-modified.js'
+export * from './3xx/permanent-redirect.js'
+export * from './3xx/see-other.js'
+export * from './3xx/temporary-redirect.js'
+export * from './4xx/bad-request.js'
+export * from './4xx/conflict.js'
+export * from './4xx/content-too-large.js'
+export * from './4xx/forbidden.js'
+export * from './4xx/gone.js'
+export * from './4xx/im-a-teapot.js'
+export * from './4xx/not-acceptable.js'
+export * from './4xx/not-allowed.js'
+export * from './4xx/not-found.js'
+export * from './4xx/payment-required.js'
+export * from './4xx/precondition-failed.js'
+export * from './4xx/range-not-satisfiable.js'
+export * from './4xx/timeout.js'
+export * from './4xx/too-many-requests.js'
+export * from './4xx/unauthorized.js'
+export * from './4xx/unprocessable.js'
+export * from './4xx/unsupported-media.js'
+export * from './5xx/error.js'
+export * from './5xx/insufficient-storage.js'
+export * from './5xx/not-implemented.js'
+export * from './5xx/unavailable.js'

package/src/response/response.js

@@ -1,46 +1,51 @@
-import { sendAccepted } from './accepted.js'
-import { sendBytes } from './bytes.js'
-import { sendConflict } from './conflict.js'
-import { sendContentTooLarge } from './content-too-large.js'
-import { sendCreated } from './created.js'
-import { sendError } from './error.js'
-import { sendForbidden } from './forbidden.js'
-import { sendGone } from './gone.js'
-import { sendImATeapot } from './im-a-teapot.js'
-import { sendInsufficientStorage } from './insufficient-storage.js'
-import { sendJSON_Encoded } from './json.js'
-import { sendMovedPermanently } from './moved-permanently.js'
-import { sendMultipleChoices } from './multiple-choices.js'
-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 { sendPartialContent } from './partial-content.js'
-import { sendPermanentRedirect } from './permanent-redirect.js'
-import { sendPreconditionFailed } from './precondition-failed.js'
-import { sendPreflight } from './preflight.js'
-import { sendRangeNotSatisfiable } from './range-not-satisfiable.js'
-import { sendSeeOther } from './see-other.js'
-import { sendSSE } from './sse.js'
-import { sendTemporaryRedirect } from './temporary-redirect.js'
-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'
+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 { 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'
+import { sendGone } from './4xx/gone.js'
+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'
+import { sendTooManyRequests } from './4xx/too-many-requests.js'
+import { sendUnauthorized } from './4xx/unauthorized.js'
+import { sendUnprocessable } from './4xx/unprocessable.js'
+import { sendUnsupportedMediaType } from './4xx/unsupported-media.js'
+import { sendError } from './5xx/error.js'
+import { sendInsufficientStorage } from './5xx/insufficient-storage.js'
+import { sendNotImplemented } from './5xx/not-implemented.js'
+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,
@@ -54,6 +59,7 @@ export const Response = {
 	notImplemented: sendNotImplemented,
 	notModified: sendNotModified,
 	partialContent: sendPartialContent,
+	paymentRequired: sendPaymentRequired,
 	permanentRedirect: sendPermanentRedirect,
 	preconditionFailed: sendPreconditionFailed,
 	preflight: sendPreflight,