@h3ravel/contracts 0.28.0

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/README.md

@@ -0,0 +1,43 @@
+<div align="center">
+  <a href="https://h3ravel.toneflix.net"  target="_blank">
+    <img src="https://raw.githubusercontent.com/h3ravel/assets/refs/heads/main/logo-full.svg" width="200" alt="H3ravel Logo">
+  </a>
+  <h1 align="center"><a href="https://h3ravel.toneflix.net/arquebus">H3ravel Contracts</a></h1>
+
+[![Framework][ix]][lx]
+[![Contracts Package Version][i1]][l1]
+[![Downloads][d1]][d1]
+[![Tests][tei]][tel]
+[![License][lini]][linl]
+
+</div>
+
+# About H3ravel/contracts
+
+This package provides first class reusable interfaces and contracts for use across the [H3ravel](https://h3ravel.toneflix.net) ecosystem.
+
+## Contributing
+
+Thank you for considering contributing to the H3ravel framework! The [Contribution Guide](https://h3ravel.toneflix.net/contributing) can be found in the H3ravel documentation and will provide you with all the information you need to get started.
+
+## Code of Conduct
+
+In order to ensure that the H3ravel community is welcoming to all, please review and abide by the [Code of Conduct](#).
+
+## Security Vulnerabilities
+
+If you discover a security vulnerability within H3ravel, please send an e-mail to Legacy via hamzas.legacy@toneflix.ng. All security vulnerabilities will be promptly addressed.
+
+## License
+
+The H3ravel framework is open-sourced software licensed under the [MIT license](LICENSE).
+
+[ix]: https://img.shields.io/npm/v/%40h3ravel%2Fcore?style=flat-square&label=Framework&color=%230970ce
+[lx]: https://www.npmjs.com/package/@h3ravel/core
+[i1]: https://img.shields.io/npm/v/%40h3ravel%2Fcontracts?style=flat-square&label=@h3ravel/contracts&color=%230970ce
+[l1]: https://www.npmjs.com/package/@h3ravel/contracts
+[d1]: https://img.shields.io/npm/dt/%40h3ravel%2Fcontracts?style=flat-square&label=Downloads&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40h3ravel%2Fcontracts
+[linl]: https://github.com/h3ravel/framework/blob/main/LICENSE
+[lini]: https://img.shields.io/github/license/h3ravel/framework
+[tel]: https://github.com/h3ravel/framework/actions/workflows/test.yml
+[tei]: https://github.com/h3ravel/framework/actions/workflows/test.yml/badge.svg

package/dist/index.cjs

@@ -0,0 +1,348 @@
+let __h3ravel_arquebus = require("@h3ravel/arquebus");
+let h3 = require("h3");
+
+//#region src/Configuration/IAppBuilder.ts
+var IAppBuilder = class {};
+
+//#endregion
+//#region src/Core/IContainer.ts
+/**
+* Interface for the Container contract, defining methods for dependency injection and service resolution.
+*/
+var IContainer = class {
+	static hasAnyDecorator(target) {
+		return false;
+	}
+};
+
+//#endregion
+//#region src/Core/IApplication.ts
+var IApplication = class extends IContainer {
+	context;
+	h3Event;
+};
+
+//#endregion
+//#region src/Core/IController.ts
+/**
+* Defines the contract for all controllers.
+*/
+var IController = class {
+	callAction(method, parameters) {}
+	getMiddleware() {
+		return {};
+	}
+};
+
+//#endregion
+//#region src/Core/IRegisterer.ts
+var IRegisterer = class {};
+
+//#endregion
+//#region src/Core/IServiceProvider.ts
+var IServiceProvider = class {
+	/**
+	* Unique Identifier for service providers
+	*/
+	static uid;
+	/**
+	* Sort order
+	*/
+	static order;
+	/**
+	* Sort priority
+	*/
+	static priority;
+	/**
+	* Indicate that this service provider only runs in console
+	*/
+	static runsInConsole;
+	/**
+	* Indicate that this service provider only runs in console
+	*/
+	static console;
+};
+
+//#endregion
+//#region src/Database/IModel.ts
+var IModel = class extends __h3ravel_arquebus.Model {};
+
+//#endregion
+//#region src/Events/IDispatcher.ts
+var IDispatcher = class {};
+
+//#endregion
+//#region src/Exceptions/IExceptionHandler.ts
+var IExceptionHandler = class {};
+
+//#endregion
+//#region src/Foundation/CKernel.ts
+var CKernel = class {};
+
+//#endregion
+//#region src/Foundation/IBootstraper.ts
+var IBootstraper = class {};
+
+//#endregion
+//#region src/Foundation/IKernel.ts
+var IKernel = class {};
+
+//#endregion
+//#region src/Http/IParamBag.ts
+/**
+* ParamBag is a container for key/value pairs
+* for H3ravel App.
+*/
+var IParamBag = class {};
+
+//#endregion
+//#region src/Http/IFileBag.ts
+/**
+* FileBag is a container for uploaded files
+* for H3ravel App.
+*/
+var IFileBag = class extends IParamBag {};
+
+//#endregion
+//#region src/Http/IHeaderBag.ts
+/**
+* HeaderBag — A container for HTTP headers
+* for H3ravel App.
+*/
+var IHeaderBag = class {};
+
+//#endregion
+//#region src/Http/IHttpContext.ts
+var IHttpContext = class {
+	/**
+	* Retrieve an existing HttpContext instance for an event, if any.
+	*/
+	static get(event) {}
+	/**
+	* Delete the cached context for a given event (optional cleanup).
+	*/
+	static forget(event) {}
+};
+
+//#endregion
+//#region src/Http/IHttpRequest.ts
+var IHttpRequest = class {};
+
+//#endregion
+//#region src/Http/IHttpResponse.ts
+/**
+* Interface for the Response contract, defining methods for handling HTTP responses.
+*/
+var IHttpResponse = class {};
+
+//#endregion
+//#region src/Http/IInputBag.ts
+/**
+* InputBag is a container for user input values
+* (e.g., query params, body, cookies)
+* for H3ravel App.
+*/
+var InputBag = class extends IParamBag {};
+
+//#endregion
+//#region src/Http/IRequest.ts
+/**
+* Interface for the Request contract, defining methods for handling HTTP request data.
+*/
+var IRequest = class extends IHttpRequest {
+	/**
+	* Factory method to create a Request instance from an H3Event.
+	*/
+	static create(event, app) {
+		return Promise.resolve({});
+	}
+	/**
+	* Enables support for the _method request parameter to determine the intended HTTP method.
+	*
+	* Be warned that enabling this feature might lead to CSRF issues in your code.
+	* Check that you are using CSRF tokens when required.
+	* If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
+	* and used to send a "PUT" or "DELETE" request via the _method request parameter.
+	* If these methods are not protected against CSRF, this presents a possible vulnerability.
+	*
+	* The HTTP method can only be overridden when the real HTTP method is POST.
+	*/
+	static enableHttpMethodParameterOverride() {}
+	/**
+	* Checks whether support for the _method request parameter is enabled.
+	*/
+	static getHttpMethodParameterOverride() {
+		return false;
+	}
+};
+
+//#endregion
+//#region src/Http/IResponse.ts
+/**
+* Interface for the Response contract, defining methods for handling HTTP responses.
+*/
+var IResponse = class extends IHttpResponse {};
+var IResponsable = class extends h3.HTTPResponse {};
+
+//#endregion
+//#region src/Http/IServerBag.ts
+/**
+* ServerBag — a simplified version of Symfony's ServerBag
+* for H3ravel App.
+*
+* Responsible for extracting and normalizing HTTP headers
+* from the incoming request.
+*/
+var IServerBag = class extends IParamBag {};
+
+//#endregion
+//#region src/Http/IUploadedFile.ts
+var IUploadedFile = class {};
+
+//#endregion
+//#region src/Queue/IJob.ts
+var IJob = class {};
+
+//#endregion
+//#region src/Routing/ICallableDispatcher.ts
+var ICallableDispatcher = class {};
+
+//#endregion
+//#region src/Routing/IControllerDispatcher.ts
+var IControllerDispatcher = class {};
+
+//#endregion
+//#region src/Routing/IMiddleware.ts
+/**
+* Defines the contract for all middlewares.
+* Any middleware implementing this must define these methods.
+*/
+var IMiddleware = class {
+	options = {};
+};
+
+//#endregion
+//#region src/Routing/IPendingResourceRegistration.ts
+var IPendingResourceRegistration = class {};
+
+//#endregion
+//#region src/Routing/IPendingSingletonResourceRegistration.ts
+var IPendingSingletonResourceRegistration = class {};
+
+//#endregion
+//#region src/Routing/IRoute.ts
+var IRoute = class {};
+
+//#endregion
+//#region src/Routing/IRouter.ts
+/**
+* Interface for the Router contract, defining methods for HTTP routing.
+*/
+var IRouter = class {
+	/**
+	* All of the verbs supported by the router.
+	*/
+	static verbs;
+};
+
+//#endregion
+//#region src/Routing/IRouteRegistrar.ts
+var IRouteRegistrar = class {};
+
+//#endregion
+//#region src/Routing/Traits/UrlRoutable.ts
+var UrlRoutable = class {};
+
+//#endregion
+//#region src/Url/IRequestAwareUrl.ts
+/**
+* Contract for request-aware URL helpers
+*/
+var IRequestAwareUrl = class {};
+
+//#endregion
+//#region src/Url/IUrl.ts
+var IUrl = class {
+	/**
+	* Create a URL from a full URL string
+	*/
+	static of(url, app) {
+		return {};
+	}
+	/**
+	* Create a URL from a path relative to the app URL
+	*/
+	static to(path, app) {
+		return {};
+	}
+	/**
+	* Create a URL from a named route
+	*/
+	static route(name, params, app) {
+		return {};
+	}
+	/**
+	* Create a signed URL from a named route
+	*/
+	static signedRoute(name, params, app) {
+		return {};
+	}
+	/**
+	* Create a temporary signed URL from a named route
+	*/
+	static temporarySignedRoute(name, params, expiration, app) {
+		return {};
+	}
+	/**
+	* Create a URL from a controller action
+	*/
+	static action(controller, params, app) {
+		return {};
+	}
+};
+
+//#endregion
+//#region src/Url/IUrlHelpers.ts
+/**
+* The Url Helper Contract
+*/
+var IUrlHelpers = class {};
+
+//#endregion
+exports.CKernel = CKernel;
+exports.IAppBuilder = IAppBuilder;
+exports.IApplication = IApplication;
+exports.IBootstraper = IBootstraper;
+exports.ICallableDispatcher = ICallableDispatcher;
+exports.IContainer = IContainer;
+exports.IController = IController;
+exports.IControllerDispatcher = IControllerDispatcher;
+exports.IDispatcher = IDispatcher;
+exports.IExceptionHandler = IExceptionHandler;
+exports.IFileBag = IFileBag;
+exports.IHeaderBag = IHeaderBag;
+exports.IHttpContext = IHttpContext;
+exports.IHttpRequest = IHttpRequest;
+exports.IHttpResponse = IHttpResponse;
+exports.IJob = IJob;
+exports.IKernel = IKernel;
+exports.IMiddleware = IMiddleware;
+exports.IModel = IModel;
+exports.IParamBag = IParamBag;
+exports.IPendingResourceRegistration = IPendingResourceRegistration;
+exports.IPendingSingletonResourceRegistration = IPendingSingletonResourceRegistration;
+exports.IRegisterer = IRegisterer;
+exports.IRequest = IRequest;
+exports.IRequestAwareUrl = IRequestAwareUrl;
+exports.IResponsable = IResponsable;
+exports.IResponse = IResponse;
+exports.IRoute = IRoute;
+exports.IRouteRegistrar = IRouteRegistrar;
+exports.IRouter = IRouter;
+exports.IServerBag = IServerBag;
+exports.IServiceProvider = IServiceProvider;
+exports.IUploadedFile = IUploadedFile;
+exports.IUrl = IUrl;
+exports.IUrlHelpers = IUrlHelpers;
+exports.InputBag = InputBag;
+exports.UrlRoutable = UrlRoutable;