@h3ravel/shared 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @h3ravel/shared
+
+## 0.3.0
+
+### Minor Changes
+
+- 3ff97bf: refactor: add a shared package to be extended by others to avoid cyclic dependency issues.
+
+### Patch Changes
+
+- Updated dependencies [3ff97bf]
+  - @h3ravel/support@0.3.0
+
+## 0.2.0
+
+### Minor Changes
+
+- aea734f: Fix all known bugs and improved interdependecy between packages.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 h3ravel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from './Contracts/IApplication';\nexport * from './Contracts/IHttp';\nexport * from './Contracts/IRequest';\nexport * from './Contracts/IResponse';\nexport * from './Contracts/IServiceProvider';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,248 @@
+import { H3Event, Middleware, MiddlewareOptions } from 'h3';
+import { DotNestedKeys, DotNestedValue } from '@h3ravel/support';
+
+interface IServiceProvider {
+    /**
+     * Register bindings to the container.
+     * Runs before boot().
+     */
+    register(): void | Promise<void>;
+    /**
+     * Perform post-registration booting of services.
+     * Runs after all providers have been registered.
+     */
+    boot?(): void | Promise<void>;
+}
+
+type IPathName = 'views' | 'routes' | 'assets' | 'base' | 'public' | 'storage' | 'config';
+interface IApplication {
+    /**
+     * Registers configured service providers.
+     */
+    registerConfiguredProviders(): Promise<void>;
+    /**
+     * Registers an array of external service provider classes.
+     * @param providers - Array of service provider constructor functions.
+     */
+    registerProviders(providers: Array<new (app: IApplication) => IServiceProvider>): void;
+    /**
+     * Registers a single service provider.
+     * @param provider - The service provider instance to register.
+     */
+    register(provider: IServiceProvider): Promise<void>;
+    /**
+     * Boots all registered providers.
+     */
+    boot(): Promise<void>;
+    /**
+     * Gets the base path of the application.
+     * @returns The base path as a string.
+     */
+    getBasePath(): string;
+    /**
+     * Retrieves a path by name, optionally appending a sub-path.
+     * @param name - The name of the path property.
+     * @param pth - Optional sub-path to append.
+     * @returns The resolved path as a string.
+     */
+    getPath(name: string, pth?: string): string;
+    /**
+     * Sets a path for a given name.
+     * @param name - The name of the path property.
+     * @param path - The path to set.
+     * @returns
+     */
+    setPath(name: IPathName, path: string): void;
+    /**
+     * Gets the version of the application or TypeScript.
+     * @param key - The key to retrieve ('app' or 'ts').
+     * @returns The version string or undefined.
+     */
+    getVersion(key: 'app' | 'ts'): string | undefined;
+}
+
+/**
+ * Interface for the Request contract, defining methods for handling HTTP request data.
+ */
+interface IRequest {
+    /**
+     * Gets all input data (query parameters, route parameters, and body).
+     * @returns A promise resolving to an object containing all input data.
+     */
+    all<T = Record<string, unknown>>(): Promise<T>;
+    /**
+     * Gets a single input field from query or body.
+     * @param key - The key of the input field.
+     * @param defaultValue - Optional default value if the key is not found.
+     * @returns A promise resolving to the value of the input field or the default value.
+     */
+    input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
+    /**
+     * Gets route parameters.
+     * @returns An object containing route parameters.
+     */
+    params<T = Record<string, string>>(): T;
+    /**
+     * Gets query parameters.
+     * @returns An object containing query parameters.
+     */
+    query<T = Record<string, string>>(): T;
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent(): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+
+/**
+ * Interface for the Response contract, defining methods for handling HTTP responses.
+ */
+interface IResponse {
+    /**
+     * Sets the HTTP status code for the response.
+     * @param code - The HTTP status code.
+     * @returns The instance for method chaining.
+     */
+    setStatusCode(code: number): this;
+    /**
+     * Sets a response header.
+     * @param name - The header name.
+     * @param value - The header value.
+     * @returns The instance for method chaining.
+     */
+    setHeader(name: string, value: string): this;
+    /**
+     * Sends an HTML response.
+     * @param content - The HTML content to send.
+     * @returns The HTML content.
+     */
+    html(content: string): string;
+    /**
+     * Sends a JSON response.
+     * @param data - The data to send as JSON.
+     * @returns The input data.
+     */
+    json<T = unknown>(data: T): T;
+    /**
+     * Sends a plain text response.
+     * @param data - The text content to send.
+     * @returns The text content.
+     */
+    text(data: string): string;
+    /**
+     * Redirects to another URL.
+     * @param url - The URL to redirect to.
+     * @param status - The HTTP status code for the redirect (default: 302).
+     * @returns The redirect URL.
+     */
+    redirect(url: string, status?: number): string;
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent(): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+
+/**
+ * Interface for the Router contract, defining methods for HTTP routing.
+ */
+interface IRouter {
+    /**
+     * Registers a GET route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    get(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a POST route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    post(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a PUT route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    put(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a DELETE route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    delete(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers an API resource with standard CRUD routes.
+     * @param path - The base path for the resource.
+     * @param controller - The controller class handling the resource.
+     * @param middleware - Optional middleware array.
+     */
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): void;
+    /**
+     * Generates a URL for a named route.
+     * @param name - The name of the route.
+     * @param params - Optional parameters to replace in the route path.
+     * @returns The generated URL or undefined if the route is not found.
+     */
+    route(name: string, params?: Record<string, string>): string | undefined;
+    /**
+     * Groups routes with shared prefix or middleware.
+     * @param options - Configuration for prefix or middleware.
+     * @param callback - Callback function defining grouped routes.
+     */
+    group(options: {
+        prefix?: string;
+        middleware?: EventHandler[];
+    }, callback: () => void): void;
+    /**
+     * Registers middleware for a specific path.
+     * @param path - The path to apply the middleware.
+     * @param handler - The middleware handler.
+     * @param opts - Optional middleware options.
+     */
+    middleware(path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+}
+interface HttpContext {
+    request: IRequest;
+    response: IResponse;
+}
+/**
+ * Type for EventHandler, representing a function that handles an H3 event.
+ */
+type EventHandler = (ctx: HttpContext) => any;
+/**
+ * Defines the contract for all controllers.
+ * Any controller implementing this must define these methods.
+ */
+interface IController {
+    show(ctx: HttpContext): any;
+    index(ctx: HttpContext): any;
+    store(ctx: HttpContext): any;
+    update(ctx: HttpContext): any;
+    destroy(ctx: HttpContext): any;
+}
+/**
+ * Defines the contract for all middlewares.
+ * Any middleware implementing this must define these methods.
+ */
+interface IMiddleware {
+    handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
+}
+
+export type { EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };

package/dist/index.d.ts

@@ -0,0 +1,248 @@
+import { H3Event, Middleware, MiddlewareOptions } from 'h3';
+import { DotNestedKeys, DotNestedValue } from '@h3ravel/support';
+
+interface IServiceProvider {
+    /**
+     * Register bindings to the container.
+     * Runs before boot().
+     */
+    register(): void | Promise<void>;
+    /**
+     * Perform post-registration booting of services.
+     * Runs after all providers have been registered.
+     */
+    boot?(): void | Promise<void>;
+}
+
+type IPathName = 'views' | 'routes' | 'assets' | 'base' | 'public' | 'storage' | 'config';
+interface IApplication {
+    /**
+     * Registers configured service providers.
+     */
+    registerConfiguredProviders(): Promise<void>;
+    /**
+     * Registers an array of external service provider classes.
+     * @param providers - Array of service provider constructor functions.
+     */
+    registerProviders(providers: Array<new (app: IApplication) => IServiceProvider>): void;
+    /**
+     * Registers a single service provider.
+     * @param provider - The service provider instance to register.
+     */
+    register(provider: IServiceProvider): Promise<void>;
+    /**
+     * Boots all registered providers.
+     */
+    boot(): Promise<void>;
+    /**
+     * Gets the base path of the application.
+     * @returns The base path as a string.
+     */
+    getBasePath(): string;
+    /**
+     * Retrieves a path by name, optionally appending a sub-path.
+     * @param name - The name of the path property.
+     * @param pth - Optional sub-path to append.
+     * @returns The resolved path as a string.
+     */
+    getPath(name: string, pth?: string): string;
+    /**
+     * Sets a path for a given name.
+     * @param name - The name of the path property.
+     * @param path - The path to set.
+     * @returns
+     */
+    setPath(name: IPathName, path: string): void;
+    /**
+     * Gets the version of the application or TypeScript.
+     * @param key - The key to retrieve ('app' or 'ts').
+     * @returns The version string or undefined.
+     */
+    getVersion(key: 'app' | 'ts'): string | undefined;
+}
+
+/**
+ * Interface for the Request contract, defining methods for handling HTTP request data.
+ */
+interface IRequest {
+    /**
+     * Gets all input data (query parameters, route parameters, and body).
+     * @returns A promise resolving to an object containing all input data.
+     */
+    all<T = Record<string, unknown>>(): Promise<T>;
+    /**
+     * Gets a single input field from query or body.
+     * @param key - The key of the input field.
+     * @param defaultValue - Optional default value if the key is not found.
+     * @returns A promise resolving to the value of the input field or the default value.
+     */
+    input<T = unknown>(key: string, defaultValue?: T): Promise<T>;
+    /**
+     * Gets route parameters.
+     * @returns An object containing route parameters.
+     */
+    params<T = Record<string, string>>(): T;
+    /**
+     * Gets query parameters.
+     * @returns An object containing query parameters.
+     */
+    query<T = Record<string, string>>(): T;
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent(): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+
+/**
+ * Interface for the Response contract, defining methods for handling HTTP responses.
+ */
+interface IResponse {
+    /**
+     * Sets the HTTP status code for the response.
+     * @param code - The HTTP status code.
+     * @returns The instance for method chaining.
+     */
+    setStatusCode(code: number): this;
+    /**
+     * Sets a response header.
+     * @param name - The header name.
+     * @param value - The header value.
+     * @returns The instance for method chaining.
+     */
+    setHeader(name: string, value: string): this;
+    /**
+     * Sends an HTML response.
+     * @param content - The HTML content to send.
+     * @returns The HTML content.
+     */
+    html(content: string): string;
+    /**
+     * Sends a JSON response.
+     * @param data - The data to send as JSON.
+     * @returns The input data.
+     */
+    json<T = unknown>(data: T): T;
+    /**
+     * Sends a plain text response.
+     * @param data - The text content to send.
+     * @returns The text content.
+     */
+    text(data: string): string;
+    /**
+     * Redirects to another URL.
+     * @param url - The URL to redirect to.
+     * @param status - The HTTP status code for the redirect (default: 302).
+     * @returns The redirect URL.
+     */
+    redirect(url: string, status?: number): string;
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent(): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>>(key: K): DotNestedValue<H3Event, K>;
+}
+
+/**
+ * Interface for the Router contract, defining methods for HTTP routing.
+ */
+interface IRouter {
+    /**
+     * Registers a GET route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    get(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a POST route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    post(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a PUT route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    put(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers a DELETE route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    delete(path: string, handler: EventHandler | (new (...args: any[]) => IController), methodName?: string, name?: string, middleware?: IMiddleware[]): void;
+    /**
+     * Registers an API resource with standard CRUD routes.
+     * @param path - The base path for the resource.
+     * @param controller - The controller class handling the resource.
+     * @param middleware - Optional middleware array.
+     */
+    apiResource(path: string, controller: new (app: IApplication) => IController, middleware?: IMiddleware[]): void;
+    /**
+     * Generates a URL for a named route.
+     * @param name - The name of the route.
+     * @param params - Optional parameters to replace in the route path.
+     * @returns The generated URL or undefined if the route is not found.
+     */
+    route(name: string, params?: Record<string, string>): string | undefined;
+    /**
+     * Groups routes with shared prefix or middleware.
+     * @param options - Configuration for prefix or middleware.
+     * @param callback - Callback function defining grouped routes.
+     */
+    group(options: {
+        prefix?: string;
+        middleware?: EventHandler[];
+    }, callback: () => void): void;
+    /**
+     * Registers middleware for a specific path.
+     * @param path - The path to apply the middleware.
+     * @param handler - The middleware handler.
+     * @param opts - Optional middleware options.
+     */
+    middleware(path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+}
+interface HttpContext {
+    request: IRequest;
+    response: IResponse;
+}
+/**
+ * Type for EventHandler, representing a function that handles an H3 event.
+ */
+type EventHandler = (ctx: HttpContext) => any;
+/**
+ * Defines the contract for all controllers.
+ * Any controller implementing this must define these methods.
+ */
+interface IController {
+    show(ctx: HttpContext): any;
+    index(ctx: HttpContext): any;
+    store(ctx: HttpContext): any;
+    update(ctx: HttpContext): any;
+    destroy(ctx: HttpContext): any;
+}
+/**
+ * Defines the contract for all middlewares.
+ * Any middleware implementing this must define these methods.
+ */
+interface IMiddleware {
+    handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
+}
+
+export type { EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@h3ravel/shared",
+  "version": "0.3.0",
+  "description": "Shared Utilities.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "h3": "^2.0.0-beta.1",
+    "@h3ravel/support": "0.3.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "barrel": "barrelsby --directory src --delete --singleQuotes",
+    "dev": "tsx watch src/index.ts",
+    "start": "node dist/index.js",
+    "lint": "eslint . --ext .ts",
+    "test": "vitest"
+  }
+}

package/src/Contracts/IApplication.ts

@@ -0,0 +1,56 @@
+import { IServiceProvider } from "./IServiceProvider";
+
+export type IPathName = 'views' | 'routes' | 'assets' | 'base' | 'public' | 'storage' | 'config'
+
+export interface IApplication {
+    /**
+     * Registers configured service providers.
+     */
+    registerConfiguredProviders (): Promise<void>;
+
+    /**
+     * Registers an array of external service provider classes.
+     * @param providers - Array of service provider constructor functions.
+     */
+    registerProviders (providers: Array<new (app: IApplication) => IServiceProvider>): void;
+
+    /**
+     * Registers a single service provider.
+     * @param provider - The service provider instance to register.
+     */
+    register (provider: IServiceProvider): Promise<void>;
+
+    /**
+     * Boots all registered providers.
+     */
+    boot (): Promise<void>;
+
+    /**
+     * Gets the base path of the application.
+     * @returns The base path as a string.
+     */
+    getBasePath (): string;
+
+    /**
+     * Retrieves a path by name, optionally appending a sub-path.
+     * @param name - The name of the path property.
+     * @param pth - Optional sub-path to append.
+     * @returns The resolved path as a string.
+     */
+    getPath (name: string, pth?: string): string;
+
+    /**
+     * Sets a path for a given name.
+     * @param name - The name of the path property.
+     * @param path - The path to set.
+     * @returns
+     */
+    setPath (name: IPathName, path: string): void;
+
+    /**
+     * Gets the version of the application or TypeScript.
+     * @param key - The key to retrieve ('app' or 'ts').
+     * @returns The version string or undefined.
+     */
+    getVersion (key: 'app' | 'ts'): string | undefined;
+}

package/src/Contracts/IHttp.ts

@@ -0,0 +1,139 @@
+import type { Middleware, MiddlewareOptions } from "h3";
+
+import { IApplication } from "./IApplication";
+import { IRequest } from "./IRequest";
+import { IResponse } from "./IResponse";
+
+/**
+ * Interface for the Router contract, defining methods for HTTP routing.
+ */
+export interface IRouter {
+    /**
+     * Registers a GET route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    get (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string,
+        name?: string,
+        middleware?: IMiddleware[]
+    ): void;
+
+    /**
+     * Registers a POST route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    post (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string,
+        name?: string,
+        middleware?: IMiddleware[]
+    ): void;
+
+    /**
+     * Registers a PUT route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    put (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string,
+        name?: string,
+        middleware?: IMiddleware[]
+    ): void;
+
+    /**
+     * Registers a DELETE route.
+     * @param path - The route path.
+     * @param handler - The handler function or controller class.
+     * @param methodName - Optional controller method name.
+     * @param name - Optional route name.
+     * @param middleware - Optional middleware array.
+     */
+    delete (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string,
+        name?: string,
+        middleware?: IMiddleware[]
+    ): void;
+
+    /**
+     * Registers an API resource with standard CRUD routes.
+     * @param path - The base path for the resource.
+     * @param controller - The controller class handling the resource.
+     * @param middleware - Optional middleware array.
+     */
+    apiResource (
+        path: string,
+        controller: new (app: IApplication) => IController,
+        middleware?: IMiddleware[]
+    ): void;
+
+    /**
+     * Generates a URL for a named route.
+     * @param name - The name of the route.
+     * @param params - Optional parameters to replace in the route path.
+     * @returns The generated URL or undefined if the route is not found.
+     */
+    route (name: string, params?: Record<string, string>): string | undefined;
+
+    /**
+     * Groups routes with shared prefix or middleware.
+     * @param options - Configuration for prefix or middleware.
+     * @param callback - Callback function defining grouped routes.
+     */
+    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void): void;
+
+    /**
+     * Registers middleware for a specific path.
+     * @param path - The path to apply the middleware.
+     * @param handler - The middleware handler.
+     * @param opts - Optional middleware options.
+     */
+    middleware (path: string, handler: Middleware, opts?: MiddlewareOptions): void;
+}
+
+export interface HttpContext {
+    request: IRequest
+    response: IResponse
+}
+
+/**
+ * Type for EventHandler, representing a function that handles an H3 event.
+ */
+export type EventHandler = (ctx: HttpContext) => any
+
+/**
+ * Defines the contract for all controllers.
+ * Any controller implementing this must define these methods.
+ */
+export interface IController {
+    show (ctx: HttpContext): any
+    index (ctx: HttpContext): any
+    store (ctx: HttpContext): any
+    update (ctx: HttpContext): any
+    destroy (ctx: HttpContext): any
+}
+
+/**
+ * Defines the contract for all middlewares.
+ * Any middleware implementing this must define these methods.
+ */
+export interface IMiddleware {
+    handle (context: HttpContext, next: () => Promise<any>): Promise<any>
+} 

package/src/Contracts/IRequest.ts

@@ -0,0 +1,42 @@
+import { DotNestedKeys, DotNestedValue } from '@h3ravel/support'
+
+import type { H3Event } from "h3";
+
+/**
+ * Interface for the Request contract, defining methods for handling HTTP request data.
+ */
+export interface IRequest {
+    /**
+     * Gets all input data (query parameters, route parameters, and body).
+     * @returns A promise resolving to an object containing all input data.
+     */
+    all<T = Record<string, unknown>> (): Promise<T>;
+
+    /**
+     * Gets a single input field from query or body.
+     * @param key - The key of the input field.
+     * @param defaultValue - Optional default value if the key is not found.
+     * @returns A promise resolving to the value of the input field or the default value.
+     */
+    input<T = unknown> (key: string, defaultValue?: T): Promise<T>;
+
+    /**
+     * Gets route parameters.
+     * @returns An object containing route parameters.
+     */
+    params<T = Record<string, string>> (): T;
+
+    /**
+     * Gets query parameters.
+     * @returns An object containing query parameters.
+     */
+    query<T = Record<string, string>> (): T;
+
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent (): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>;
+}

package/src/Contracts/IResponse.ts

@@ -0,0 +1,60 @@
+import { DotNestedKeys, DotNestedValue } from '@h3ravel/support'
+
+import type { H3Event } from "h3";
+
+/**
+ * Interface for the Response contract, defining methods for handling HTTP responses.
+ */
+export interface IResponse {
+    /**
+     * Sets the HTTP status code for the response.
+     * @param code - The HTTP status code.
+     * @returns The instance for method chaining.
+     */
+    setStatusCode (code: number): this;
+
+    /**
+     * Sets a response header.
+     * @param name - The header name.
+     * @param value - The header value.
+     * @returns The instance for method chaining.
+     */
+    setHeader (name: string, value: string): this;
+
+    /**
+     * Sends an HTML response.
+     * @param content - The HTML content to send.
+     * @returns The HTML content.
+     */
+    html (content: string): string;
+
+    /**
+     * Sends a JSON response.
+     * @param data - The data to send as JSON.
+     * @returns The input data.
+     */
+    json<T = unknown> (data: T): T;
+
+    /**
+     * Sends a plain text response.
+     * @param data - The text content to send.
+     * @returns The text content.
+     */
+    text (data: string): string;
+
+    /**
+     * Redirects to another URL.
+     * @param url - The URL to redirect to.
+     * @param status - The HTTP status code for the redirect (default: 302).
+     * @returns The redirect URL.
+     */
+    redirect (url: string, status?: number): string;
+
+    /**
+     * Gets the underlying event object or a specific property of it.
+     * @param key - Optional key to access a nested property of the event.
+     * @returns The entire event object or the value of the specified property.
+     */
+    getEvent (): H3Event;
+    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>;
+}

package/src/Contracts/IServiceProvider.ts

@@ -0,0 +1,13 @@
+export interface IServiceProvider {
+    /**
+     * Register bindings to the container.
+     * Runs before boot().
+     */
+    register (): void | Promise<void>
+
+    /**
+     * Perform post-registration booting of services.
+     * Runs after all providers have been registered.
+     */
+    boot?(): void | Promise<void>
+} 

package/src/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from './Contracts/IApplication';
+export * from './Contracts/IHttp';
+export * from './Contracts/IRequest';
+export * from './Contracts/IResponse';
+export * from './Contracts/IServiceProvider';

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "target": "esnext",
+    "module": "preserve",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "strict": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+    // "target": "ES2022",
+    // "module": "ESNext",
+  }
+}