@lithia-js/core 1.0.0-canary.0

package/dist/hooks/route-hooks.d.ts

@@ -0,0 +1,154 @@
+/**
+ * HTTP route hooks for Lithia.
+ *
+ * Provides convenient hooks to access request-specific data in route handlers.
+ * All hooks must be called within an HTTP request handler or middleware.
+ *
+ * @module hooks/route-hooks
+ */
+import type { IncomingHttpHeaders } from "node:http";
+import type { Route } from "@lithia-js/native";
+import type { Server } from "socket.io";
+import type { LithiaRequest, Params, Query } from "../server/request";
+import type { LithiaResponse } from "../server/response";
+/**
+ * Accesses the current HTTP request object.
+ *
+ * Provides access to all request properties including params, query,
+ * headers, body, and other request metadata.
+ *
+ * @returns The current LithiaRequest instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const req = useRequest();
+ *   console.log(req.method, req.url);
+ * }
+ * ```
+ */
+export declare function useRequest(): LithiaRequest;
+/**
+ * Accesses the current HTTP response object.
+ *
+ * Used to send responses back to the client, set headers, status codes, etc.
+ *
+ * @returns The current LithiaResponse instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const res = useResponse();
+ *   res.status(200).json({ message: 'Success' });
+ * }
+ * ```
+ */
+export declare function useResponse(): LithiaResponse;
+/**
+ * Accesses the current matched route definition.
+ *
+ * Contains metadata about the current route including path pattern,
+ * HTTP method, and handler information.
+ *
+ * @returns The matched Route, or undefined if no route matched or called before route resolution
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const route = useRoute();
+ *   console.log('Handling route:', route?.path);
+ * }
+ * ```
+ */
+export declare function useRoute(): Route | undefined;
+/**
+ * Accesses route parameters (dynamic segments).
+ *
+ * Extracts parameters from dynamic route segments like `/users/:id`.
+ *
+ * @returns Object containing route parameters
+ * @throws {Error} If called outside of a request handler
+ * @template T - Type of the params object
+ *
+ * @example
+ * ```typescript
+ * // Route: /users/:id
+ * export default async function handler() {
+ *   const { id } = useParams<{ id: string }>();
+ *   console.log('User ID:', id);
+ * }
+ * ```
+ */
+export declare function useParams<T extends Params = Params>(): T;
+/**
+ * Accesses URL query parameters.
+ *
+ * Extracts query string parameters from the request URL.
+ *
+ * @returns Object containing query parameters
+ * @throws {Error} If called outside of a request handler
+ * @template T - Type of the query object
+ *
+ * @example
+ * ```typescript
+ * // URL: /search?q=lithia&page=1
+ * export default async function handler() {
+ *   const { q, page } = useQuery<{ q: string; page: string }>();
+ *   console.log('Search:', q, 'Page:', page);
+ * }
+ * ```
+ */
+export declare function useQuery<T extends Query = Query>(): T;
+/**
+ * Accesses HTTP request headers.
+ *
+ * Returns all headers sent with the request.
+ *
+ * @returns Object containing HTTP headers
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const headers = useHeaders();
+ *   const auth = headers.authorization;
+ *   console.log('Auth header:', auth);
+ * }
+ * ```
+ */
+export declare function useHeaders(): IncomingHttpHeaders;
+/**
+ * Accesses the Socket.IO server instance from within an HTTP route handler.
+ *
+ * This hook allows HTTP routes to interact with Socket.IO, enabling you to
+ * emit events to connected clients, broadcast messages, or manage rooms in
+ * response to HTTP requests.
+ *
+ * @returns The Socket.IO Server instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * // HTTP route that triggers real-time updates
+ * export default async function handler() {
+ *   const io = useSocketServer();
+ *   const { message } = useQuery<{ message: string }>();
+ *
+ *   // Broadcast to all connected clients
+ *   io.emit('notification', { message, timestamp: Date.now() });
+ *
+ *   // Emit to a specific room
+ *   io.to('admin-room').emit('alert', { message });
+ *
+ *   // Get all connected sockets
+ *   const sockets = await io.fetchSockets();
+ *   console.log(`Broadcasting to ${sockets.length} clients`);
+ *
+ *   return { success: true, clients: sockets.length };
+ * }
+ * ```
+ */
+export declare function useSocketServer(): Server;

package/dist/hooks/route-hooks.js

@@ -0,0 +1,174 @@
+"use strict";
+/**
+ * HTTP route hooks for Lithia.
+ *
+ * Provides convenient hooks to access request-specific data in route handlers.
+ * All hooks must be called within an HTTP request handler or middleware.
+ *
+ * @module hooks/route-hooks
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRequest = useRequest;
+exports.useResponse = useResponse;
+exports.useRoute = useRoute;
+exports.useParams = useParams;
+exports.useQuery = useQuery;
+exports.useHeaders = useHeaders;
+exports.useSocketServer = useSocketServer;
+const route_context_1 = require("../context/route-context");
+/**
+ * Accesses the current HTTP request object.
+ *
+ * Provides access to all request properties including params, query,
+ * headers, body, and other request metadata.
+ *
+ * @returns The current LithiaRequest instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const req = useRequest();
+ *   console.log(req.method, req.url);
+ * }
+ * ```
+ */
+function useRequest() {
+    return (0, route_context_1.getRouteContext)().req;
+}
+/**
+ * Accesses the current HTTP response object.
+ *
+ * Used to send responses back to the client, set headers, status codes, etc.
+ *
+ * @returns The current LithiaResponse instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const res = useResponse();
+ *   res.status(200).json({ message: 'Success' });
+ * }
+ * ```
+ */
+function useResponse() {
+    return (0, route_context_1.getRouteContext)().res;
+}
+/**
+ * Accesses the current matched route definition.
+ *
+ * Contains metadata about the current route including path pattern,
+ * HTTP method, and handler information.
+ *
+ * @returns The matched Route, or undefined if no route matched or called before route resolution
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const route = useRoute();
+ *   console.log('Handling route:', route?.path);
+ * }
+ * ```
+ */
+function useRoute() {
+    return (0, route_context_1.getRouteContext)().route;
+}
+/**
+ * Accesses route parameters (dynamic segments).
+ *
+ * Extracts parameters from dynamic route segments like `/users/:id`.
+ *
+ * @returns Object containing route parameters
+ * @throws {Error} If called outside of a request handler
+ * @template T - Type of the params object
+ *
+ * @example
+ * ```typescript
+ * // Route: /users/:id
+ * export default async function handler() {
+ *   const { id } = useParams<{ id: string }>();
+ *   console.log('User ID:', id);
+ * }
+ * ```
+ */
+function useParams() {
+    return (0, route_context_1.getRouteContext)().req.params;
+}
+/**
+ * Accesses URL query parameters.
+ *
+ * Extracts query string parameters from the request URL.
+ *
+ * @returns Object containing query parameters
+ * @throws {Error} If called outside of a request handler
+ * @template T - Type of the query object
+ *
+ * @example
+ * ```typescript
+ * // URL: /search?q=lithia&page=1
+ * export default async function handler() {
+ *   const { q, page } = useQuery<{ q: string; page: string }>();
+ *   console.log('Search:', q, 'Page:', page);
+ * }
+ * ```
+ */
+function useQuery() {
+    return (0, route_context_1.getRouteContext)().req.query;
+}
+/**
+ * Accesses HTTP request headers.
+ *
+ * Returns all headers sent with the request.
+ *
+ * @returns Object containing HTTP headers
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * export default async function handler() {
+ *   const headers = useHeaders();
+ *   const auth = headers.authorization;
+ *   console.log('Auth header:', auth);
+ * }
+ * ```
+ */
+function useHeaders() {
+    return (0, route_context_1.getRouteContext)().req.headers;
+}
+/**
+ * Accesses the Socket.IO server instance from within an HTTP route handler.
+ *
+ * This hook allows HTTP routes to interact with Socket.IO, enabling you to
+ * emit events to connected clients, broadcast messages, or manage rooms in
+ * response to HTTP requests.
+ *
+ * @returns The Socket.IO Server instance
+ * @throws {Error} If called outside of a request handler
+ *
+ * @example
+ * ```typescript
+ * // HTTP route that triggers real-time updates
+ * export default async function handler() {
+ *   const io = useSocketServer();
+ *   const { message } = useQuery<{ message: string }>();
+ *
+ *   // Broadcast to all connected clients
+ *   io.emit('notification', { message, timestamp: Date.now() });
+ *
+ *   // Emit to a specific room
+ *   io.to('admin-room').emit('alert', { message });
+ *
+ *   // Get all connected sockets
+ *   const sockets = await io.fetchSockets();
+ *   console.log(`Broadcasting to ${sockets.length} clients`);
+ *
+ *   return { success: true, clients: sockets.length };
+ * }
+ * ```
+ */
+function useSocketServer() {
+    return (0, route_context_1.getRouteContext)().socketServer;
+}
+//# sourceMappingURL=route-hooks.js.map

package/dist/hooks/route-hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-hooks.js","sourceRoot":"","sources":["../../src/hooks/route-hooks.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AA0BH,gCAEC;AAkBD,kCAEC;AAmBD,4BAEC;AAoBD,8BAEC;AAoBD,4BAEC;AAmBD,gCAEC;AAiCD,0CAEC;AApKD,4DAA2D;AAI3D;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,UAAU;IACzB,OAAO,IAAA,+BAAe,GAAE,CAAC,GAAG,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,WAAW;IAC1B,OAAO,IAAA,+BAAe,GAAE,CAAC,GAAG,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,QAAQ;IACvB,OAAO,IAAA,+BAAe,GAAE,CAAC,KAAK,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,SAAS;IACxB,OAAO,IAAA,+BAAe,GAAE,CAAC,GAAG,CAAC,MAAW,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,QAAQ;IACvB,OAAO,IAAA,+BAAe,GAAE,CAAC,GAAG,CAAC,KAAU,CAAC;AACzC,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,UAAU;IACzB,OAAO,IAAA,+BAAe,GAAE,CAAC,GAAG,CAAC,OAAO,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,eAAe;IAC9B,OAAO,IAAA,+BAAe,GAAE,CAAC,YAAY,CAAC;AACvC,CAAC"}

package/dist/lib.d.ts

@@ -0,0 +1,10 @@
+export { defineConfig, LithiaConfig } from "./config";
+export { loadEnv } from "./env";
+export { InjectionKey, inject, injectOptional, provide, useData, useHeaders, useParams, useQuery, useRequest, useResponse, useRoute, useSocketServer, } from "./hooks";
+export { Lithia } from "./lithia";
+export { logger } from "./logger";
+export { EventErrorInfo, EventHandler } from "./server/event-processor";
+export { validate } from "./server/middlewares/validation";
+export { LithiaRequest, Params, Query } from "./server/request";
+export { LithiaHandler, LithiaMiddleware, RequestErrorInfo, } from "./server/request-processor";
+export { LithiaResponse } from "./server/response";

package/dist/lib.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LithiaResponse = exports.LithiaRequest = exports.validate = exports.logger = exports.Lithia = exports.useSocketServer = exports.useRoute = exports.useResponse = exports.useRequest = exports.useQuery = exports.useParams = exports.useHeaders = exports.useData = exports.provide = exports.injectOptional = exports.inject = exports.loadEnv = exports.defineConfig = void 0;
+var config_1 = require("./config");
+Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return config_1.defineConfig; } });
+var env_1 = require("./env");
+Object.defineProperty(exports, "loadEnv", { enumerable: true, get: function () { return env_1.loadEnv; } });
+var hooks_1 = require("./hooks");
+Object.defineProperty(exports, "inject", { enumerable: true, get: function () { return hooks_1.inject; } });
+Object.defineProperty(exports, "injectOptional", { enumerable: true, get: function () { return hooks_1.injectOptional; } });
+Object.defineProperty(exports, "provide", { enumerable: true, get: function () { return hooks_1.provide; } });
+Object.defineProperty(exports, "useData", { enumerable: true, get: function () { return hooks_1.useData; } });
+Object.defineProperty(exports, "useHeaders", { enumerable: true, get: function () { return hooks_1.useHeaders; } });
+Object.defineProperty(exports, "useParams", { enumerable: true, get: function () { return hooks_1.useParams; } });
+Object.defineProperty(exports, "useQuery", { enumerable: true, get: function () { return hooks_1.useQuery; } });
+Object.defineProperty(exports, "useRequest", { enumerable: true, get: function () { return hooks_1.useRequest; } });
+Object.defineProperty(exports, "useResponse", { enumerable: true, get: function () { return hooks_1.useResponse; } });
+Object.defineProperty(exports, "useRoute", { enumerable: true, get: function () { return hooks_1.useRoute; } });
+Object.defineProperty(exports, "useSocketServer", { enumerable: true, get: function () { return hooks_1.useSocketServer; } });
+var lithia_1 = require("./lithia");
+Object.defineProperty(exports, "Lithia", { enumerable: true, get: function () { return lithia_1.Lithia; } });
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });
+var validation_1 = require("./server/middlewares/validation");
+Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return validation_1.validate; } });
+var request_1 = require("./server/request");
+Object.defineProperty(exports, "LithiaRequest", { enumerable: true, get: function () { return request_1.LithiaRequest; } });
+var response_1 = require("./server/response");
+Object.defineProperty(exports, "LithiaResponse", { enumerable: true, get: function () { return response_1.LithiaResponse; } });
+//# sourceMappingURL=lib.js.map

package/dist/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;AAAA,mCAAsD;AAA7C,sGAAA,YAAY,OAAA;AACrB,6BAAgC;AAAvB,8FAAA,OAAO,OAAA;AAChB,iCAaiB;AAXhB,+FAAA,MAAM,OAAA;AACN,uGAAA,cAAc,OAAA;AACd,gGAAA,OAAO,OAAA;AACP,gGAAA,OAAO,OAAA;AACP,mGAAA,UAAU,OAAA;AACV,kGAAA,SAAS,OAAA;AACT,iGAAA,QAAQ,OAAA;AACR,mGAAA,UAAU,OAAA;AACV,oGAAA,WAAW,OAAA;AACX,iGAAA,QAAQ,OAAA;AACR,wGAAA,eAAe,OAAA;AAEhB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAEf,8DAA2D;AAAlD,sGAAA,QAAQ,OAAA;AACjB,4CAAgE;AAAvD,wGAAA,aAAa,OAAA;AAMtB,8CAAmD;AAA1C,0GAAA,cAAc,OAAA"}