sleepy-serv 0.6.2 → 0.8.0

package/README.md

@@ -26,9 +26,25 @@ The parameter for `import.meta.dirname` can be any directory you prefer, but it'
 
 ### Return Value
 
-`sleepy-serv` was originally built for NodeJS, but it was ported to `bun` recently (before the initial release). The `createApp()` function merely calls `Bun.serve()` under-the-hood, and returns the `app` object that contains two properties:
+`sleepy-serv` was originally built for NodeJS, but it was ported to `bun` recently (before the initial release). The `createApp()` function merely calls `Bun.serve()` under-the-hood, and returns the `app` object that contains these properties:
 - `routes`: Contains a list of all of the routes defined by the file structure. This is useful for debugging.
-- `server`: this is the object that's returned from `Bun.serve()`. The `server` object has an `async` `.stop()` method on it, which can also be used for graceful shutdowns.
+- `server`: this is the object that's returned from `Bun.serve()`. The `server` object has an `async` `.stop()` method on it, but prefer `app.close()` (see [Shutting Down](#shutting-down)), which stops the server and releases everything else the app holds.
+- `commands`: WebSocket helpers for pushing messages out to connected clients: `send(clientId, event, body)` and `broadcast(event, body)`.
+- `close`: an `async` function that shuts the app down. See [Shutting Down](#shutting-down).
+
+### Shutting Down
+
+`app.close()` shuts the app down and releases everything it holds:
+
+```js
+const app = await createApp(PORT, import.meta.dirname)
+
+await app.close()
+```
+
+It stops the server, tears down the Ctrl+D shutdown handler, and calls [`onClose`](#onclose). Pass `close(true)` to force-close active connections rather than waiting for in-flight requests to finish. That argument is handed straight to `server.stop()`, so it behaves exactly as it does in `Bun.serve()`.
+
+This matters most for tests that start and stop an app per case. Calling `server.stop()` on its own stops the HTTP listener but leaves the Ctrl+D shutdown handler attached to `stdin`, which holds an open handle and can keep the process from exiting. `app.close()` does not have that problem.
 
 ### Adding Routes
 
@@ -315,7 +331,7 @@ export default [
 This function returns a middleware function that validates request data against provided schemas. The returned middleware function has the signature `(req, res, next)` and forwards `res` via `next(res)` after successful validation.
 
 The `schemas` object can contain these optional properties:
-- `headers`: takes a string formatter schema to evaluate `req.headers`
+- `headers`: takes a string formatter schema to evaluate `req.headers`. Header names are case-insensitive, so schema keys are lowercased to match; validation errors report the lowercased name (e.g. `headers.userid`).
 - `params`: takes a string formatter schema to evaluate `req.params`
 - `query`: takes a string formatter schema to evaluate `req.query`
 - `body`: takes a JSON validation schema to evaluate `res` (the body value passed in via `next`)
@@ -465,7 +481,7 @@ Yields these routes:
 
 ### `onClose`
 
-When the app is started, the app can be shutdown gracefully by pressing Ctrl+D in the terminal. The `onClose` hook will be called during that shutdown if it's defined. `onClose` can also be `async` as well.
+When the app is started, the app can be shutdown gracefully by pressing Ctrl+D in the terminal. That handler is only wired up when `stdin` is a TTY, so it's skipped in CI, in test runners, and anywhere `stdin` is piped. The `onClose` hook will be called during that shutdown if it's defined, and it's also called by [`app.close()`](#shutting-down). `onClose` can also be `async` as well.
 
 ```js
 const app = await createApp(PORT, import.meta.dirname, {

package/dist/errors.d.ts

@@ -0,0 +1,173 @@
+import { StatusCode } from './utils';
+import type { FormattedError } from './utils';
+export type ErrorOutput = {
+    message: string;
+} | FormattedError[] | null;
+export declare class RequestError extends Error {
+    static get status(): StatusCode;
+    get output(): ErrorOutput;
+    constructor(message: string);
+}
+export declare class BadRequestError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UnauthorizedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class PaymentRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ForbiddenError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class NotFoundError extends RequestError {
+    static get status(): StatusCode;
+    constructor();
+}
+export declare class MethodNotAllowedError extends RequestError {
+    static get status(): StatusCode;
+    constructor();
+}
+export declare class NotAcceptableError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ProxyAuthenticationRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class RequestTimeoutError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ConflictError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class GoneError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class LengthRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class PreconditionFailedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class PayloadTooLargeError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UriTooLongError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UnsupportedMediaTypeError extends RequestError {
+    static get status(): StatusCode;
+    constructor(subject: string);
+}
+export declare class RangeNotSatisfiableError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ExpectationFailedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ImATeapotError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class MisdirectedRequestError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UnprocessableContentError extends RequestError {
+    static get status(): StatusCode;
+    get output(): ErrorOutput;
+    constructor(errors: FormattedError[]);
+}
+export declare class LockedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class FailedDependencyError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class TooEarlyError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UpgradeRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class PreconditionRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class TooManyRequestsError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class RequestHeaderFieldsTooLargeError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class UnavailableForLegalReasonsError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class InternalServerError extends RequestError {
+    static get status(): StatusCode;
+    ctx: unknown;
+    constructor(message: string, ctx?: unknown);
+}
+export declare class NotImplementedError extends RequestError {
+    static get status(): StatusCode;
+    constructor();
+}
+export declare class BadGatewayError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class ServiceUnavailableError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class GatewayTimeoutError extends RequestError {
+    static get status(): StatusCode;
+    constructor();
+}
+export declare class HTTPVersionNotSupportedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class VariantAlsoNegotiatesError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class InsufficientStorageError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class LoopDetectedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class NotExtendedError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+export declare class NetworkAuthenticationRequiredError extends RequestError {
+    static get status(): StatusCode;
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C,MAAM,MAAM,WAAW,GACnB;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GACnB,cAAc,EAAE,GAChB,IAAI,CAAA;AAER,qBAAa,YAAa,SAAQ,KAAK;IACrC,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;IAED,IAAI,MAAM,IAAK,WAAW,CAEzB;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAID,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,aAAc,SAAQ,YAAY;IAC7C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;;CAOF;AAED,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;;CAOF;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,gCAAiC,SAAQ,YAAY;IAChE,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,aAAc,SAAQ,YAAY;IAC7C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,SAAU,SAAQ,YAAY;IACzC,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,wBAAyB,SAAQ,YAAY;IACxD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,sBAAuB,SAAQ,YAAY;IACtD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;IAED,IAAI,MAAM,IAAK,WAAW,CAEzB;gBAEY,MAAM,EAAE,cAAc,EAAE;CAKtC;AAED,qBAAa,WAAY,SAAQ,YAAY;IAC3C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,aAAc,SAAQ,YAAY;IAC7C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,gCAAiC,SAAQ,YAAY;IAChE,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,+BAAgC,SAAQ,YAAY;IAC/D,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAID,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;IAED,GAAG,EAAE,OAAO,CAAA;gBAEC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO;CAM5C;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;;CAOF;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;;CAOF;AAED,qBAAa,4BAA6B,SAAQ,YAAY;IAC5D,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,wBAAyB,SAAQ,YAAY;IACxD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B;AAED,qBAAa,kCAAmC,SAAQ,YAAY;IAClE,MAAM,KAAK,MAAM,IAAK,UAAU,CAE/B;gBAEY,OAAO,EAAE,MAAM;CAK7B"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { AppOptions, Server } from './utils';
+import type { SocketCommands } from './socket';
+export * from './errors';
+export { parseJsonBody, setValidationFormats, validateSchemas, } from './middleware';
+export { HttpMethod, StatusCode } from './utils';
+export type { AppOptions, EndpointRequest, FormattedError, Middleware, NextFn, Request, Server, SocketOptions, WebSocketRequest, } from './utils';
+export type { FormatterField, FormatterSchema, ValidationSchemas, } from './middleware';
+export type { SocketCommands } from './socket';
+type OutputRoutes = Record<string, string[]>;
+type CloseFn = (force?: boolean) => Promise<void>;
+export type App = {
+    server: Server;
+    commands: SocketCommands;
+    routes: OutputRoutes;
+    close: CloseFn;
+};
+export declare function createApp(port: number, rootPath: string, opts?: AppOptions): Promise<App>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,EAIV,UAAU,EACV,MAAM,EACP,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAGV,cAAc,EACf,MAAM,UAAU,CAAA;AAEjB,cAAc,UAAU,CAAA;AAExB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,eAAe,GAChB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEhD,YAAY,EACV,UAAU,EACV,eAAe,EACf,cAAc,EACd,UAAU,EACV,MAAM,EACN,OAAO,EACP,MAAM,EACN,aAAa,EACb,gBAAgB,GACjB,MAAM,SAAS,CAAA;AAEhB,YAAY,EACV,cAAc,EACd,eAAe,EACf,iBAAiB,GAClB,MAAM,cAAc,CAAA;AAErB,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE9C,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AA4C5C,KAAK,OAAO,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAEjD,MAAM,MAAM,GAAG,GAAG;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,cAAc,CAAA;IACxB,MAAM,EAAE,YAAY,CAAA;IACpB,KAAK,EAAE,OAAO,CAAA;CACf,CAAA;AA4ZD,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,UAAe,GACpB,OAAO,CAAC,GAAG,CAAC,CAad"}

package/dist/messages.d.ts

@@ -0,0 +1,63 @@
+import type { HttpMethod } from './utils';
+export declare const MessageType: {
+    readonly Request: "request";
+    readonly Response: "response";
+    readonly Welcome: "welcome";
+    readonly Heartbeat: "heartbeat";
+    readonly Notification: "notification";
+};
+export type MessageType = typeof MessageType[keyof typeof MessageType];
+export declare const RECEIVED_MESSAGE_TYPES: string[];
+export type BaseMessage = {
+    id: string;
+    clientId: string;
+    type: MessageType;
+    timestamp: string;
+};
+export type HeartbeatMessage = BaseMessage & {
+    type: typeof MessageType.Heartbeat;
+};
+export type RequestMessage = BaseMessage & {
+    type: typeof MessageType.Request;
+    method: HttpMethod;
+    route: string;
+    headers: Bun.HeadersInit;
+    query: Record<string, unknown>;
+    body: unknown;
+};
+export type ResponseMessage = BaseMessage & {
+    type: typeof MessageType.Response;
+    status: number;
+    headers: Headers;
+    body: unknown;
+};
+export type WelcomeMessage = BaseMessage & {
+    type: typeof MessageType.Welcome;
+    headers: Headers;
+    body: {
+        heartbeatInterval: number;
+        token: string;
+    };
+};
+export type NotificationMessage = BaseMessage & {
+    type: typeof MessageType.Notification;
+    event: string;
+    headers: Headers;
+    body: unknown;
+};
+export type Message = HeartbeatMessage | RequestMessage | ResponseMessage | WelcomeMessage | NotificationMessage;
+export type RawMessage = {
+    type?: string;
+    [key: string]: unknown;
+};
+export type IncomingMessage = HeartbeatMessage | RequestMessage;
+export type MessageContent<T extends MessageType = MessageType> = Partial<Pick<Extract<Message, {
+    type: T;
+}>, 'id'>> & Omit<Extract<Message, {
+    type: T;
+}>, keyof BaseMessage>;
+export declare function createMessage<T extends MessageType>(clientId: string, type: T, content: MessageContent<T>): Extract<Message, {
+    type: T;
+}>;
+export declare function validateMessage(message: RawMessage): IncomingMessage;
+//# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzC,eAAO,MAAM,WAAW;;;;;;CAMd,CAAA;AAEV,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAEtE,eAAO,MAAM,sBAAsB,EAAE,MAAM,EAG1C,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG;IAC3C,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IACzC,IAAI,EAAE,OAAO,WAAW,CAAC,OAAO,CAAA;IAChC,MAAM,EAAE,UAAU,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,GAAG,CAAC,WAAW,CAAA;IACxB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C,IAAI,EAAE,OAAO,WAAW,CAAC,QAAQ,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IACzC,IAAI,EAAE,OAAO,WAAW,CAAC,OAAO,CAAA;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE;QACJ,iBAAiB,EAAE,MAAM,CAAA;QACzB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG;IAC9C,IAAI,EAAE,OAAO,WAAW,CAAC,YAAY,CAAA;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GACf,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,cAAc,GACd,mBAAmB,CAAA;AAEvB,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,cAAc,CAAA;AAE/D,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAC5D,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAC9C,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,EAAE,MAAM,WAAW,CAAC,CAAA;AAwG5D,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,EACjD,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,CAe/B;AAED,wBAAgB,eAAe,CAAE,OAAO,EAAE,UAAU,GAAG,eAAe,CA4BrE"}

package/dist/middleware.d.ts

@@ -0,0 +1,19 @@
+import type { Format, Schema } from 'ajv';
+import type { Middleware } from './utils';
+export type FormatterField = {
+    type: string;
+    value: unknown;
+};
+export type FormatterSchema = Record<string, FormatterField>;
+export type ValidationSchemas = {
+    headers?: FormatterSchema;
+    params?: FormatterSchema;
+    query?: FormatterSchema;
+    body?: Schema;
+};
+export type SchemaKey = keyof ValidationSchemas;
+export declare function parseJsonBody(): Middleware;
+export declare function setValidationFormats(formats: Record<string, Format>): void;
+export declare function resetValidationFormatsState(): void;
+export declare function validateSchemas(schemas: ValidationSchemas): Middleware;
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAoB,MAAM,KAAK,CAAA;AAC3D,OAAO,KAAK,EAAkB,UAAU,EAAmB,MAAM,SAAS,CAAA;AAE1E,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAE5D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAA;AA2F/C,wBAAgB,aAAa,IAAK,UAAU,CAoB3C;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9B,IAAI,CAUN;AAID,wBAAgB,2BAA2B,IAAK,IAAI,CAGnD;AAcD,wBAAgB,eAAe,CAC7B,OAAO,EAAE,iBAAiB,GACzB,UAAU,CAgCZ"}

package/dist/socket.d.ts

@@ -0,0 +1,50 @@
+import type { WebSocketHandler } from 'bun';
+import type { HttpMethod, Request, Middleware, SocketData, AppOptions } from './utils';
+export type Ticket = {
+    clientId: string;
+    expiresAt: number;
+};
+export type SocketConnection = {
+    data: SocketData;
+    send: (data: string) => unknown;
+    close: () => void;
+};
+export type ActiveSession = {
+    token: string;
+    ws: SocketConnection;
+};
+export type InactiveSession = {
+    token: string;
+    expiresAt: number;
+};
+export type Session = ActiveSession | InactiveSession;
+export type SocketState = {
+    disconnectThreshold: number;
+    heartbeatInterval: number;
+    maxTickets: number;
+    reclaimTtl: number;
+    ticketTtl: number;
+    tickets: Map<string, Ticket>;
+    activeSessions: Map<string, ActiveSession>;
+    inactiveSessions: Map<string, InactiveSession>;
+};
+export type SocketRoute = {
+    method: HttpMethod;
+    path: string;
+    segments: string[];
+    chain: Middleware[];
+};
+export type SocketEndpoint = {
+    method: HttpMethod;
+    path: string;
+    handler: (req: Request, res: unknown) => Response;
+};
+export type SocketCommands = {
+    send: (clientId: string, event: string, body: unknown) => void;
+    broadcast: (event: string, body: unknown) => void;
+};
+export declare function buildSocketState(opts?: AppOptions): SocketState;
+export declare function buildSocketServer(routes: SocketRoute[], state: SocketState): WebSocketHandler<SocketData>;
+export declare function buildSocketHandlers(state: SocketState): SocketEndpoint[];
+export declare function buildSocketCommands(state: SocketState): SocketCommands;
+//# sourceMappingURL=socket.d.ts.map

package/dist/socket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../src/socket.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAG3C,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EAEP,UAAU,EACV,UAAU,EACV,UAAU,EACX,MAAM,SAAS,CAAA;AAShB,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;IAC/B,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,gBAAgB,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,aAAa,GAAG,eAAe,CAAA;AAErD,MAAM,MAAM,WAAW,GAAG;IACxB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,iBAAiB,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5B,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAC1C,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAC/C,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,KAAK,QAAQ,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAC9D,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;CAClD,CAAA;AAmTD,wBAAgB,gBAAgB,CAAE,IAAI,GAAE,UAAe,GAAG,WAAW,CAWpE;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,WAAW,EAAE,EACrB,KAAK,EAAE,WAAW,GACjB,gBAAgB,CAAC,UAAU,CAAC,CAuH9B;AAED,wBAAgB,mBAAmB,CAAE,KAAK,EAAE,WAAW,GAAG,cAAc,EAAE,CAqIzE;AAED,wBAAgB,mBAAmB,CAAE,KAAK,EAAE,WAAW,GAAG,cAAc,CA+BvE"}

package/dist/utils.d.ts

@@ -0,0 +1,125 @@
+import type { ErrorObject } from 'ajv';
+import type { BunRequest, Server as BunServer } from 'bun';
+export declare const HttpMethod: {
+    readonly Head: "HEAD";
+    readonly Get: "GET";
+    readonly Post: "POST";
+    readonly Put: "PUT";
+    readonly Patch: "PATCH";
+    readonly Delete: "DELETE";
+};
+export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
+export declare const StatusCode: {
+    readonly Continue: 100;
+    readonly SwitchingProtocols: 101;
+    readonly Processing: 102;
+    readonly EarlyHints: 103;
+    readonly Ok: 200;
+    readonly Created: 201;
+    readonly Accepted: 202;
+    readonly NonAuthoritativeInformation: 203;
+    readonly NoContent: 204;
+    readonly ResetContent: 205;
+    readonly PartialContent: 206;
+    readonly MultiStatus: 207;
+    readonly AlreadyReported: 208;
+    readonly ImUsed: 226;
+    readonly MultipleChoices: 300;
+    readonly MovedPermanently: 301;
+    readonly Found: 302;
+    readonly SeeOther: 303;
+    readonly NotModified: 304;
+    readonly UseProxy: 305;
+    readonly TemporaryRedirect: 307;
+    readonly PermanentRedirect: 308;
+    readonly BadRequest: 400;
+    readonly Unauthorized: 401;
+    readonly PaymentRequired: 402;
+    readonly Forbidden: 403;
+    readonly NotFound: 404;
+    readonly MethodNotAllowed: 405;
+    readonly NotAcceptable: 406;
+    readonly ProxyAuthenticationRequired: 407;
+    readonly RequestTimeout: 408;
+    readonly Conflict: 409;
+    readonly Gone: 410;
+    readonly LengthRequired: 411;
+    readonly PreconditionFailed: 412;
+    readonly PayloadTooLarge: 413;
+    readonly UriTooLong: 414;
+    readonly UnsupportedMediaType: 415;
+    readonly RangeNotSatisfiable: 416;
+    readonly ExpectationFailed: 417;
+    readonly ImATeapot: 418;
+    readonly MisdirectedRequest: 421;
+    readonly UnprocessableContent: 422;
+    readonly Locked: 423;
+    readonly FailedDependency: 424;
+    readonly TooEarly: 425;
+    readonly UpgradeRequired: 426;
+    readonly PreconditionRequired: 428;
+    readonly TooManyRequests: 429;
+    readonly RequestHeaderFieldsTooLarge: 431;
+    readonly UnavailableForLegalReasons: 451;
+    readonly InternalServerError: 500;
+    readonly NotImplemented: 501;
+    readonly BadGateway: 502;
+    readonly ServiceUnavailable: 503;
+    readonly GatewayTimeout: 504;
+    readonly HTTPVersionNotSupported: 505;
+    readonly VariantAlsoNegotiates: 506;
+    readonly InsufficientStorage: 507;
+    readonly LoopDetected: 508;
+    readonly NotExtended: 510;
+    readonly NetworkAuthenticationRequired: 511;
+};
+export type StatusCode = typeof StatusCode[keyof typeof StatusCode];
+export type ValidationError = Partial<ErrorObject>;
+export type FormattedError = {
+    path: string;
+    message: string;
+};
+export type NextFn = (data?: unknown) => Response | Promise<Response>;
+export type BaseRequest = {
+    method: HttpMethod;
+    route: string;
+    headers: Headers;
+    params: Record<string, string>;
+    query: Record<string, unknown>;
+    json: () => Promise<unknown>;
+};
+export type EndpointRequest = BaseRequest & {
+    raw: BunRequest;
+    server: Server;
+};
+export type WebSocketRequest = BaseRequest & {
+    id: string;
+    clientId: string;
+};
+export type Request = EndpointRequest | WebSocketRequest;
+export type Middleware = (req: Request, res: unknown, next: NextFn | null) => unknown;
+export type SocketOptions = {
+    disconnectThreshold?: number;
+    heartbeatInterval?: number;
+    maxTickets?: number;
+    reclaimTtl?: number;
+    ticketTtl?: number;
+};
+export type SocketData = {
+    clientId: string;
+    superseded: boolean;
+    reaped: boolean;
+    reaperHandle: ReturnType<typeof setTimeout> | null;
+};
+export type Server = BunServer<SocketData>;
+export type AppOptions = {
+    hostname?: string;
+    mountPath?: string;
+    middleware?: Middleware[];
+    ws?: SocketOptions;
+    onClose?: () => Promise<void> | void;
+};
+export declare function toSegments(pathString: string): string[];
+export declare function formatError(prefix: string, input: ValidationError): FormattedError;
+export declare function executeMiddlewareChain(req: Request, chain: Middleware[]): Promise<Response>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AACtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,KAAK,CAAA;AAE1D,eAAO,MAAM,UAAU;;;;;;;CAOb,CAAA;AAEV,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAEnE,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmEb,CAAA;AAEV,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;AAErE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C,GAAG,EAAE,UAAU,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAA;AAExD,MAAM,MAAM,UAAU,GAAG,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GAAG,IAAI,KAChB,OAAO,CAAA;AAEZ,MAAM,MAAM,aAAa,GAAG;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,OAAO,CAAA;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,YAAY,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAA;CACnD,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;AAE1C,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CACrC,CAAA;AAED,wBAAgB,UAAU,CAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAaxD;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,eAAe,GACrB,cAAc,CAQhB;AAED,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,UAAU,EAAE,GAClB,OAAO,CAAC,QAAQ,CAAC,CA0BnB"}

package/package.json

@@ -3,9 +3,20 @@
   "description": "A more opinionated web server for building REST-ful applications",
   "author": "Travis J True",
   "license": "MIT",
-  "version": "0.6.2",
-  "exports": "./src/index.js",
+  "version": "0.8.0",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.*"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/travistrue2008/sleepy-serv.git",
@@ -18,7 +29,10 @@
     "web server",
     "www"
   ],
-  "scripts": {},
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
   "dependencies": {
     "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1"