@h3ravel/contracts 0.28.0

package/dist/index.js

@@ -0,0 +1,312 @@
+import { Model } from "@h3ravel/arquebus";
+import { HTTPResponse } from "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 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 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
+export { CKernel, IAppBuilder, IApplication, IBootstraper, ICallableDispatcher, IContainer, IController, IControllerDispatcher, IDispatcher, IExceptionHandler, IFileBag, IHeaderBag, IHttpContext, IHttpRequest, IHttpResponse, IJob, IKernel, IMiddleware, IModel, IParamBag, IPendingResourceRegistration, IPendingSingletonResourceRegistration, IRegisterer, IRequest, IRequestAwareUrl, IResponsable, IResponse, IRoute, IRouteRegistrar, IRouter, IServerBag, IServiceProvider, IUploadedFile, IUrl, IUrlHelpers, InputBag, UrlRoutable };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@h3ravel/contracts",
+  "version": "0.28.0",
+  "description": "H3ravel Contracts.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./*": "./*"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "tsconfig.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://h3ravel.toneflix.net",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/h3ravel/framework.git",
+    "directory": "packages/contracts"
+  },
+  "keywords": [
+    "h3ravel",
+    "modern",
+    "web",
+    "H3",
+    "framework",
+    "nodejs",
+    "typescript",
+    "laravel",
+    "contracts"
+  ],
+  "devDependencies": {
+    "edge.js": "^6.3.0",
+    "simple-body-validator": "^1.3.9",
+    "@h3ravel/musket": "^0.6.8",
+    "@h3ravel/arquebus": "^0.7.3"
+  },
+  "dependencies": {
+    "h3": "2.0.1-rc.5"
+  },
+  "scripts": {
+    "build": "tsdown --config-loader unconfig",
+    "dev": "tsx watch src/index.ts",
+    "start": "node dist/index.js",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --passWithNoTests",
+    "release:patch": "pnpm build && pnpm version patch && git add . && git commit -m \"version: bump contracts package and publish\" && pnpm publish --tag latest",
+    "version-patch": "pnpm version patch"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": ["src"],
+  "exclude": ["dist", "node_modules"]
+}