shelving 1.174.1 → 1.175.0

package/endpoint/Endpoint.d.ts

@@ -1,7 +1,7 @@
 import { type Schema } from "../schema/Schema.js";
 import { type Data } from "../util/data.js";
 import type { AnyCaller, Arguments } from "../util/function.js";
-import { type RequestHandler, type RequestMethod, type RequestOptions } from "../util/http.js";
+import { type OptionalRequestHandler, type RequestMethod, type RequestOptions } from "../util/http.js";
 import { type URLString } from "../util/url.js";
 import type { EndpointCallback } from "./util.js";
 /**
@@ -27,7 +27,7 @@ export declare class Endpoint<P, R> {
      *
      * @param callback The callback function that implements the logic for this endpoint by receiving the payload and returning the response.
      */
-    handler<A extends Arguments = []>(callback: EndpointCallback<P, R, A>): RequestHandler<A>;
+    handler<A extends Arguments = []>(callback: EndpointCallback<P, R, A>): OptionalRequestHandler<A>;
     /**
      * Render the URL for this endpoint with the given payload.
      * - URL might contain `{placeholder}` values that are replaced with values from the payload.

package/endpoint/util.d.ts

@@ -1,5 +1,5 @@
 import type { Arguments } from "../util/function.js";
-import type { RequestHandlers } from "../util/http.js";
+import type { OptionalRequestHandlers } from "../util/http.js";
 /**
  * A function that handles a endpoint request, with a payload and returns a result.
  *
@@ -23,4 +23,4 @@ export type EndpointCallback<P, R, A extends Arguments = []> = (payload: P, requ
  * @returns The resulting `Response` from the first handler that matches the `Request`.
  * @throws `NotFoundError` if no handler matches the `Request`.
  */
-export declare function handleEndpoints<A extends Arguments = []>(endpoints: RequestHandlers<A>, request: Request, ...args: A): Promise<Response> | Response;
+export declare function handleEndpoints<A extends Arguments = []>(endpoints: OptionalRequestHandlers<A>, request: Request, ...args: A): Promise<Response> | Response;

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.174.1",
+	"version": "1.175.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/dhoulb/shelving.git"

package/util/http.d.ts

@@ -3,10 +3,12 @@ import { ResponseError } from "../error/ResponseError.js";
 import { type Data } from "./data.js";
 import type { AnyCaller, Arguments } from "./function.js";
 import type { URLString } from "./url.js";
-/** A handler function takes a `Request` and optional extra arguments, and returns a `Response` (possibly asynchronously) or `undefined` if the request could not be handled. */
-export type RequestHandler<A extends Arguments = []> = (request: Request, ...args: A) => Response | Promise<Response> | undefined;
+/** A handler function takes a `Request` and optional extra arguments and returns a `Response` (possibly asynchronously). */
+export type RequestHandler<A extends Arguments = []> = (request: Request, ...args: A) => Response | Promise<Response>;
+/** An optional request handler that may return `undefined` to indicate no match. */
+export type OptionalRequestHandler<A extends Arguments = []> = (request: Request, ...args: A) => Response | Promise<Response> | undefined;
 /** A list of optional request handlers. */
-export type RequestHandlers<A extends Arguments = []> = Iterable<RequestHandler<A>>;
+export type OptionalRequestHandlers<A extends Arguments = []> = Iterable<OptionalRequestHandler<A>>;
 export declare function _getMessageJSON(message: Request | Response, MessageError: typeof RequestError | typeof ResponseError, caller: AnyCaller): Promise<unknown>;
 export declare function _getMessageFormData(message: Request | Response, MessageError: typeof RequestError | typeof ResponseError, caller: AnyCaller): Promise<unknown>;
 export declare function _getMessageContent(message: Request | Response, MessageError: typeof RequestError | typeof ResponseError, caller: AnyCaller): Promise<unknown>;