@venok/http 1.1.0 → 2.0.0

package/decorators/route-params.decorator.d.ts

@@ -1,378 +0,0 @@
-import { Type } from "@venok/core";
-import { PipeTransform } from "@venok/core/interfaces/features/pipes.interface";
-/**
- * The `@Response()`/`@Res` parameter decorator options.
- */
-export interface ResponseDecoratorOptions {
-    /**
-     * Determines whether the response will be sent manually within the route handler,
-     * with the use of native response handling methods exposed by the platform-specific response object,
-     * or if it should pass through Venok response processing pipeline.
-     *
-     * @default false
-     */
-    passthrough: boolean;
-}
-export type ParamData = object | string | number;
-export interface RouteParamMetadata {
-    index: number;
-    data?: ParamData;
-}
-export declare function assignMetadata<TParamtype = any, TArgs = any>(args: TArgs, paramtype: TParamtype, index: number, data?: ParamData, ...pipes: (Type<PipeTransform> | PipeTransform)[]): TArgs & {
-    [x: string]: {
-        index: number;
-        data: ParamData | undefined;
-        pipes: (PipeTransform<any, any> | Type<PipeTransform<any, any>>)[];
-    };
-};
-/**
- * Route handler parameter decorator. Extracts the `Request`
- * object from the underlying platform and populates the decorated
- * parameter with the value of `Request`.
- *
- * Example: `logout(@Request() req)`
- *
- * @publicApi
- */
-export declare const Request: () => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `Response`
- * object from the underlying platform and populates the decorated
- * parameter with the value of `Response`.
- *
- * Example: `logout(@Response() res)`
- *
- * @publicApi
- */
-export declare const Response: (options?: ResponseDecoratorOptions) => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts reference to the `Next` function
- * from the underlying platform and populates the decorated
- * parameter with the value of `Next`.
- *
- * @publicApi
- */
-export declare const Next: () => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `Ip` property
- * from the `req` object and populates the decorated
- * parameter with the value of `ip`.
-
- *
- * @publicApi
- */
-export declare const Ip: () => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `Session` object
- * from the underlying platform and populates the decorated
- * parameter with the value of `Session`.
-
- *
- * @publicApi
- */
-export declare const Session: () => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `file` object
- * and populates the decorated parameter with the value of `file`.
- * Used in conjunction with multer middleware
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFile() file) {
- *   console.log(file);
- * }
- * ```
- *
- * @publicApi
- */
-export declare function UploadedFile(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `file` object
- * and populates the decorated parameter with the value of `file`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFile() file) {
- *   console.log(file);
- * }
- * ```
- *
- * @publicApi
- */
-export declare function UploadedFile(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `file` object
- * and populates the decorated parameter with the value of `file`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFile() file) {
- *   console.log(file);
- * }
- * ```
- *
- * @publicApi
- */
-export declare function UploadedFile(fileKey?: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `files` object
- * and populates the decorated parameter with the value of `files`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFiles() files) {
- *   console.log(files);
- * }
- * ```
- *
- * @publicApi
- */
-export declare function UploadedFiles(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `files` object
- * and populates the decorated parameter with the value of `files`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFiles() files) {
- *   console.log(files);
- * }
- * ```
- *
- * @publicApi
- */
-export declare function UploadedFiles(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `headers`
- * property from the `req` object and populates the decorated
- * parameter with the value of `headers`.
- *
- * For example: `async update(@Headers('Cache-Control') cacheControl: string)`
- *
- * @param property name of single header property to extract.
-
- *
- * @publicApi
- */
-export declare const Headers: (property?: string) => ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `query`
- * property from the `req` object and populates the decorated
- * parameter with the value of `query`. May also apply pipes to the bound
- * query parameter.
- *
- * For example:
- * ```typescript
- * async find(@Query('user') user: string)
- * ```
- *
- * @param property name of single property to extract from the `query` object
- * @param pipes one or more pipes to apply to the bound query parameter
-
- *
- * @publicApi
- */
-export declare function Query(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `query`
- * property from the `req` object and populates the decorated
- * parameter with the value of `query`. May also apply pipes to the bound
- * query parameter.
- *
- * For example:
- * ```typescript
- * async find(@Query('user') user: string)
- * ```
- *
- * @param property name of single property to extract from the `query` object
- * @param pipes one or more pipes to apply to the bound query parameter
-
- *
- * @publicApi
- */
-export declare function Query(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `query`
- * property from the `req` object and populates the decorated
- * parameter with the value of `query`. May also apply pipes to the bound
- * query parameter.
- *
- * For example:
- * ```typescript
- * async find(@Query('user') user: string)
- * ```
- *
- * @param property name of single property to extract from the `query` object
- * @param pipes one or more pipes to apply to the bound query parameter
-
- *
- * @publicApi
- */
-export declare function Query(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the entire `body`
- * object from the `req` object and populates the decorated
- * parameter with the value of `body`.
- *
- * For example:
- * ```typescript
- * async create(@Body() createDto: CreateCatDto)
- * ```
-
- *
- * @publicApi
- */
-export declare function Body(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the entire `body`
- * object from the `req` object and populates the decorated
- * parameter with the value of `body`. Also applies the specified
- * pipes to that parameter.
- *
- * For example:
- * ```typescript
- * async create(@Body(new ValidationPipe()) createDto: CreateCatDto)
- * ```
- *
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound body parameter.
- *
- * @publicApi
- */
-export declare function Body(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts a single property from
- * the `body` object property of the `req` object and populates the decorated
- * parameter with the value of that property. Also applies pipes to the bound
- * body parameter.
- *
- * For example:
- * ```typescript
- * async create(@Body('role', new ValidationPipe()) role: string)
- * ```
- *
- * @param property name of single property to extract from the `body` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound body parameter.
- *
- * @publicApi
- */
-export declare function Body(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `params`
- * property from the `req` object and populates the decorated
- * parameter with the value of `params`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@Param() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@Param('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound parameter.
- *
- * @publicApi
- */
-export declare function Param(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `params`
- * property from the `req` object and populates the decorated
- * parameter with the value of `params`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@Param() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@Param('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound parameter.
- *
- * @publicApi
- */
-export declare function Param(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `params`
- * property from the `req` object and populates the decorated
- * parameter with the value of `params`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@Param() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@Param('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound parameter.
- *
- * @publicApi
- */
-export declare function Param(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `hosts`
- * property from the `req` object and populates the decorated
- * parameter with the value of `hosts`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@HostParam() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@HostParam('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
-
- *
- * @publicApi
- */
-export declare function HostParam(): ParameterDecorator;
-/**
- * Route handler parameter decorator. Extracts the `hosts`
- * property from the `req` object and populates the decorated
- * parameter with the value of `hosts`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@HostParam() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@HostParam('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
-
- *
- * @publicApi
- */
-export declare function HostParam(property: string): ParameterDecorator;
-export declare const Req: () => ParameterDecorator;
-export declare const Res: (options?: ResponseDecoratorOptions) => ParameterDecorator;

package/decorators/route-params.decorator.js

@@ -1,227 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Res = exports.Req = exports.HostParam = exports.Param = exports.Body = exports.Query = exports.Headers = exports.UploadedFiles = exports.UploadedFile = exports.Session = exports.Ip = exports.Next = exports.Response = exports.Request = exports.assignMetadata = void 0;
-const constants_1 = require("../../core/constants");
-const shared_helper_1 = require("../../core/helpers/shared.helper");
-const enums_1 = require("../enums");
-const constants_2 = require("@venok/http/constants");
-function assignMetadata(args, paramtype, index, data, ...pipes) {
-    return {
-        ...args,
-        [`${paramtype}:${index}`]: {
-            index,
-            data,
-            pipes,
-        },
-    };
-}
-exports.assignMetadata = assignMetadata;
-function createRouteParamDecorator(paramtype) {
-    return (data) => (target, key, index) => {
-        const args = Reflect.getMetadata(constants_1.ROUTE_ARGS_METADATA, target.constructor, key) || {};
-        Reflect.defineMetadata(constants_1.ROUTE_ARGS_METADATA, assignMetadata(args, paramtype, index, data), target.constructor, key);
-    };
-}
-const createPipesRouteParamDecorator = (paramtype) => (data, ...pipes) => (target, key, index) => {
-    const args = Reflect.getMetadata(constants_1.ROUTE_ARGS_METADATA, target.constructor, key) || {};
-    const hasParamData = (0, shared_helper_1.isNull)(data) || (0, shared_helper_1.isString)(data);
-    const paramData = hasParamData ? data : undefined;
-    const paramPipes = hasParamData ? pipes : [data, ...pipes];
-    Reflect.defineMetadata(constants_1.ROUTE_ARGS_METADATA, assignMetadata(args, paramtype, index, paramData, ...paramPipes), target.constructor, key);
-};
-/**
- * Route handler parameter decorator. Extracts the `Request`
- * object from the underlying platform and populates the decorated
- * parameter with the value of `Request`.
- *
- * Example: `logout(@Request() req)`
- *
- * @publicApi
- */
-exports.Request = createRouteParamDecorator(enums_1.RouteParamtypes.REQUEST);
-/**
- * Route handler parameter decorator. Extracts the `Response`
- * object from the underlying platform and populates the decorated
- * parameter with the value of `Response`.
- *
- * Example: `logout(@Response() res)`
- *
- * @publicApi
- */
-const Response = (options) => (target, key, index) => {
-    if (options?.passthrough) {
-        Reflect.defineMetadata(constants_2.RESPONSE_PASSTHROUGH_METADATA, options?.passthrough, target.constructor, key);
-    }
-    return createRouteParamDecorator(enums_1.RouteParamtypes.RESPONSE)()(target, key, index);
-};
-exports.Response = Response;
-/**
- * Route handler parameter decorator. Extracts reference to the `Next` function
- * from the underlying platform and populates the decorated
- * parameter with the value of `Next`.
- *
- * @publicApi
- */
-exports.Next = createRouteParamDecorator(enums_1.RouteParamtypes.NEXT);
-/**
- * Route handler parameter decorator. Extracts the `Ip` property
- * from the `req` object and populates the decorated
- * parameter with the value of `ip`.
-
- *
- * @publicApi
- */
-exports.Ip = createRouteParamDecorator(enums_1.RouteParamtypes.IP);
-/**
- * Route handler parameter decorator. Extracts the `Session` object
- * from the underlying platform and populates the decorated
- * parameter with the value of `Session`.
-
- *
- * @publicApi
- */
-exports.Session = createRouteParamDecorator(enums_1.RouteParamtypes.SESSION);
-/**
- * Route handler parameter decorator. Extracts the `file` object
- * and populates the decorated parameter with the value of `file`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFile() file) {
- *   console.log(file);
- * }
- * ```
- *
- * @publicApi
- */
-function UploadedFile(fileKey, ...pipes) {
-    return createPipesRouteParamDecorator(enums_1.RouteParamtypes.FILE)(fileKey, ...pipes);
-}
-exports.UploadedFile = UploadedFile;
-/**
- * Route handler parameter decorator. Extracts the `files` object
- * and populates the decorated parameter with the value of `files`.
- * Used in conjunction with
- * [multer middleware](https://github.com/expressjs/multer) for Express-based application.
- *
- * For example:
- * ```typescript
- * uploadFile(@UploadedFiles() files) {
- *   console.log(files);
- * }
- * ```
- *
- * @publicApi
- */
-function UploadedFiles(...pipes) {
-    return createPipesRouteParamDecorator(enums_1.RouteParamtypes.FILES)(undefined, ...pipes);
-}
-exports.UploadedFiles = UploadedFiles;
-/**
- * Route handler parameter decorator. Extracts the `headers`
- * property from the `req` object and populates the decorated
- * parameter with the value of `headers`.
- *
- * For example: `async update(@Headers('Cache-Control') cacheControl: string)`
- *
- * @param property name of single header property to extract.
-
- *
- * @publicApi
- */
-exports.Headers = createRouteParamDecorator(enums_1.RouteParamtypes.HEADERS);
-/**
- * Route handler parameter decorator. Extracts the `query`
- * property from the `req` object and populates the decorated
- * parameter with the value of `query`. May also apply pipes to the bound
- * query parameter.
- *
- * For example:
- * ```typescript
- * async find(@Query('user') user: string)
- * ```
- *
- * @param property name of single property to extract from the `query` object
- * @param pipes one or more pipes to apply to the bound query parameter
-
- *
- * @publicApi
- */
-function Query(property, ...pipes) {
-    return createPipesRouteParamDecorator(enums_1.RouteParamtypes.QUERY)(property, ...pipes);
-}
-exports.Query = Query;
-/**
- * Route handler parameter decorator. Extracts the entire `body` object
- * property, or optionally a named property of the `body` object, from
- * the `req` object and populates the decorated parameter with that value.
- * Also applies pipes to the bound body parameter.
- *
- * For example:
- * ```typescript
- * async create(@Body('role', new ValidationPipe()) role: string)
- * ```
- *
- * @param property name of single property to extract from the `body` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound body parameter.
- *
- * @publicApi
- */
-function Body(property, ...pipes) {
-    return createPipesRouteParamDecorator(enums_1.RouteParamtypes.BODY)(property, ...pipes);
-}
-exports.Body = Body;
-/**
- * Route handler parameter decorator. Extracts the `params`
- * property from the `req` object and populates the decorated
- * parameter with the value of `params`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@Param() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@Param('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
- * @param pipes one or more pipes - either instances or classes - to apply to
- * the bound parameter.
- *
- * @publicApi
- */
-function Param(property, ...pipes) {
-    return createPipesRouteParamDecorator(enums_1.RouteParamtypes.PARAM)(property, ...pipes);
-}
-exports.Param = Param;
-/**
- * Route handler parameter decorator. Extracts the `hosts`
- * property from the `req` object and populates the decorated
- * parameter with the value of `params`. May also apply pipes to the bound
- * parameter.
- *
- * For example, extracting all params:
- * ```typescript
- * findOne(@HostParam() params: string[])
- * ```
- *
- * For example, extracting a single param:
- * ```typescript
- * findOne(@HostParam('id') id: string)
- * ```
- * @param property name of single property to extract from the `req` object
-
- *
- * @publicApi
- */
-function HostParam(property) {
-    return createRouteParamDecorator(enums_1.RouteParamtypes.HOST)(property);
-}
-exports.HostParam = HostParam;
-exports.Req = exports.Request;
-exports.Res = exports.Response;

package/decorators/sse.decorator.d.ts

@@ -1,6 +0,0 @@
-/**
- * Declares this route as a Server-Sent-Events endpoint
- *
- * @publicApi
- */
-export declare function Sse(path?: string): MethodDecorator;

package/decorators/sse.decorator.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sse = void 0;
-const constants_1 = require("@venok/http/constants");
-const enums_1 = require("@venok/http/enums");
-/**
- * Declares this route as a Server-Sent-Events endpoint
- *
- * @publicApi
- */
-function Sse(path) {
-    return (target, key, descriptor) => {
-        path = path && path.length ? path : "/";
-        Reflect.defineMetadata(constants_1.PATH_METADATA, path, descriptor.value);
-        Reflect.defineMetadata(constants_1.METHOD_METADATA, enums_1.RequestMethod.GET, descriptor.value);
-        Reflect.defineMetadata(constants_1.SSE_METADATA, true, descriptor.value);
-        return descriptor;
-    };
-}
-exports.Sse = Sse;

package/decorators/version.decorator.d.ts

@@ -1,7 +0,0 @@
-import { VersionValue } from "../interfaces";
-/**
- * Sets the version of the endpoint to the passed version
- *
- * @publicApi
- */
-export declare function Version(version: VersionValue): MethodDecorator;

package/decorators/version.decorator.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Version = void 0;
-const constants_1 = require("@venok/http/constants");
-/**
- * Sets the version of the endpoint to the passed version
- *
- * @publicApi
- */
-function Version(version) {
-    if (Array.isArray(version)) {
-        // Drop duplicated versions
-        version = Array.from(new Set(version));
-    }
-    return (target, key, descriptor) => {
-        Reflect.defineMetadata(constants_1.VERSION_METADATA, version, descriptor.value);
-        return descriptor;
-    };
-}
-exports.Version = Version;