@athenna/http 3.0.11 → 3.1.0

package/build/Types/Middlewares/InterceptorRouteType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { InterceptHandler } from '#src/Types/Middlewares/MiddlewareHandler';
+import { InterceptorContract } from '#src/Contracts/InterceptorContract';
+export type InterceptorRouteType = string | InterceptHandler | InterceptorContract;

package/build/Types/Middlewares/InterceptorRouteType.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Middlewares/MiddlewareHandler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Context } from '#src/Types/Contexts/Context';
+import { InterceptContext } from '#src/Types/Contexts/InterceptContext';
+import { TerminateContext } from '#src/Types/Contexts/TerminateContext';
+export type HandleHandler = (ctx: Context) => any | Promise<any>;
+export type InterceptHandler = (ctx: InterceptContext) => string | Record<string, any> | Record<string, any>[] | Promise<string> | Promise<Record<string, any>> | Promise<Record<string, any>[]>;
+export type TerminateHandler = (ctx: TerminateContext) => any | Promise<any>;
+export type MiddlewareHandler = HandleHandler | TerminateHandler | InterceptHandler;
+export type MiddlewareRecord = {
+    middlewares: HandleHandler[];
+    terminators: TerminateHandler[];
+    interceptors: InterceptHandler[];
+};

package/build/Types/Middlewares/MiddlewareHandler.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Middlewares/MiddlewareOptions.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export type MiddlewareOptions = {
+    /**
+     * The alias that will be used to register the dependency inside
+     * the service provider. Athenna will not create camel alias from
+     * the alias set here.
+     *
+     * @default App/Http/Middlewares/YourMiddlewareClassName
+     */
+    alias?: string;
+    /**
+     * The registration type that will be used to register your middleware
+     * inside the service provider.
+     *
+     * @default transient
+     */
+    type?: 'fake' | 'scoped' | 'singleton' | 'transient';
+    /**
+     * Set if your middleware is global and should be executed in all requests
+     * of your server. If this value is true, Athenna will ignore the "name" property.
+     *
+     * @default false
+     */
+    isGlobal?: boolean;
+    /**
+     * Set the name of your middleware to be used inside routes. If "isGlobal" property
+     * is true, Athenna will ignore this property. Athenna will always set the default
+     * name of your middleware as the middleware class name in camel case format.
+     *
+     * @default yourMiddlewareClassName
+     */
+    name?: string;
+};

package/build/Types/Middlewares/MiddlewareOptions.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Middlewares/MiddlewareRouteType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { HandleHandler } from '#src/Types/Middlewares/MiddlewareHandler';
+import { MiddlewareContract } from '#src/Contracts/MiddlewareContract';
+export type MiddlewareRouteType = string | HandleHandler | MiddlewareContract;

package/build/Types/Middlewares/MiddlewareRouteType.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Middlewares/TerminatorRouteType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { TerminateHandler } from '#src/Types/Middlewares/MiddlewareHandler';
+import { TerminatorContract } from '#src/Contracts/TerminatorContract';
+export type TerminatorRouteType = string | TerminateHandler | TerminatorContract;

package/build/Types/Middlewares/TerminatorRouteType.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Router/RouteHandler.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { RequestHandler } from '#src/Types/Contexts/Context';
+export type RouteHandler = string | RequestHandler;

package/build/Types/Router/RouteHandler.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Router/RouteJSON.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { HTTPMethods, RouteOptions } from 'fastify';
+import { RequestHandler } from '#src/Types/Contexts/Context';
+import { MiddlewareRecord } from '#src/Types/Middlewares/MiddlewareHandler';
+export type RouteJSON = {
+    url: string;
+    methods?: HTTPMethods[];
+    name?: string;
+    deleted?: boolean;
+    prefixes?: string[];
+    handler?: RequestHandler;
+    middlewares?: MiddlewareRecord;
+    fastify?: Partial<RouteOptions>;
+};

package/build/Types/Router/RouteJSON.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/Types/Router/RouteResourceTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export type RouteResourceTypes = 'index' | 'store' | 'show' | 'update' | 'delete';

package/build/Types/Router/RouteResourceTypes.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+declare module 'fastify' {
+    interface FastifyRequest {
+        data: any;
+    }
+    interface FastifySchema {
+        hide?: boolean;
+        deprecated?: boolean;
+        tags?: string[];
+        description?: string;
+        summary?: string;
+        consumes?: string[];
+        produces?: string[];
+        externalDocs?: import('openapi-types').OpenAPIV2.ExternalDocumentationObject | import('openapi-types').OpenAPIV3.ExternalDocumentationObject;
+        security?: Array<{
+            [securityLabel: string]: string[];
+        }>;
+        /**
+         * OpenAPI operation unique identifier
+         */
+        operationId?: string;
+    }
+}
+export * from './Context/Request.js';
+export * from './Context/Response.js';
+export * from './Contracts/MiddlewareContract.js';
+export * from './Contracts/TerminatorContract.js';
+export * from './Contracts/InterceptorContract.js';
+export * from './Decorators/Controller.js';
+export * from './Decorators/Middleware.js';
+export * from './Decorators/Interceptor.js';
+export * from './Decorators/Terminator.js';
+export * from './Facades/Route.js';
+export * from './Facades/Server.js';
+export * from './Providers/HttpRouteProvider.js';
+export * from './Providers/HttpServerProvider.js';
+export * from './Kernels/HttpKernel.js';
+export * from './Handlers/FastifyHandler.js';
+export * from './Handlers/HttpExceptionHandler.js';
+export * from './Router/Router.js';
+export * from './Server/ServerImpl.js';
+export * from './Types/Router/RouteJSON.js';
+export * from './Types/Router/RouteHandler.js';
+export * from './Types/Router/RouteResourceTypes.js';
+export * from './Types/Contexts/Context.js';
+export * from './Types/Contexts/ErrorContext.js';
+export * from './Types/Contexts/TerminateContext.js';
+export * from './Types/Contexts/InterceptContext.js';
+export * from './Types/Middlewares/MiddlewareHandler.js';
+export * from './Exceptions/BadGatewayException.js';
+export * from './Exceptions/BadRequestException.js';
+export * from './Exceptions/ForbiddenException.js';
+export * from './Exceptions/HttpException.js';
+export * from './Exceptions/InternalServerException.js';
+export * from './Exceptions/MethodNotAllowedException.js';
+export * from './Exceptions/NotAcceptableException.js';
+export * from './Exceptions/NotFoundException.js';
+export * from './Exceptions/NotImplementedException.js';
+export * from './Exceptions/PayloadTooLargeException.js';
+export * from './Exceptions/RequestTimeoutException.js';
+export * from './Exceptions/ServiceUnavailableException.js';
+export * from './Exceptions/UnauthorizedException.js';
+export * from './Exceptions/UnprocessableEntityException.js';

package/build/index.js

@@ -0,0 +1,48 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export * from './Context/Request.js';
+export * from './Context/Response.js';
+export * from './Contracts/MiddlewareContract.js';
+export * from './Contracts/TerminatorContract.js';
+export * from './Contracts/InterceptorContract.js';
+export * from './Decorators/Controller.js';
+export * from './Decorators/Middleware.js';
+export * from './Decorators/Interceptor.js';
+export * from './Decorators/Terminator.js';
+export * from './Facades/Route.js';
+export * from './Facades/Server.js';
+export * from './Providers/HttpRouteProvider.js';
+export * from './Providers/HttpServerProvider.js';
+export * from './Kernels/HttpKernel.js';
+export * from './Handlers/FastifyHandler.js';
+export * from './Handlers/HttpExceptionHandler.js';
+export * from './Router/Router.js';
+export * from './Server/ServerImpl.js';
+export * from './Types/Router/RouteJSON.js';
+export * from './Types/Router/RouteHandler.js';
+export * from './Types/Router/RouteResourceTypes.js';
+export * from './Types/Contexts/Context.js';
+export * from './Types/Contexts/ErrorContext.js';
+export * from './Types/Contexts/TerminateContext.js';
+export * from './Types/Contexts/InterceptContext.js';
+export * from './Types/Middlewares/MiddlewareHandler.js';
+export * from './Exceptions/BadGatewayException.js';
+export * from './Exceptions/BadRequestException.js';
+export * from './Exceptions/ForbiddenException.js';
+export * from './Exceptions/HttpException.js';
+export * from './Exceptions/InternalServerException.js';
+export * from './Exceptions/MethodNotAllowedException.js';
+export * from './Exceptions/NotAcceptableException.js';
+export * from './Exceptions/NotFoundException.js';
+export * from './Exceptions/NotImplementedException.js';
+export * from './Exceptions/PayloadTooLargeException.js';
+export * from './Exceptions/RequestTimeoutException.js';
+export * from './Exceptions/ServiceUnavailableException.js';
+export * from './Exceptions/UnauthorizedException.js';
+export * from './Exceptions/UnprocessableEntityException.js';