@venok/http 1.1.0 → 2.0.0

package/decorators/controller.decorator.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Controller = void 0;
-const constants_1 = require("../../core/constants");
-const shared_helper_1 = require("../../core/helpers/shared.helper");
-const constants_2 = require("@venok/http/constants");
-/**
- * Decorator that marks a class as a Venok controller that can receive inbound
- * requests and produce responses.
- *
- * An HTTP Controller responds to inbound HTTP Requests and produces HTTP Responses.
- * It defines a class that provides the context for one or more related route
- * handlers that correspond to HTTP request methods and associated routes
- * for example `GET /api/profile`, `POST /users/resume`
- *
- * A Microservice Controller responds to requests as well as events, running over
- * a variety of transports. It defines a class that provides a context for
- * one or more message or event handlers.
- *
- * @param prefixOrOptions a `route path prefix` or a `ControllerOptions` object.
- * A `route path prefix` is pre-pended to the path specified in any request decorator
- * in the class. `ControllerOptions` is an options configuration object specifying:
- * - `scope` - symbol that determines the lifetime of a Controller instance.
- * See Scope for more details.
- * - `prefix` - string that defines a `route path prefix`.  The prefix
- * is pre-pended to the path specified in any request decorator in the class.
- * - `version` - string, array of strings, or Symbol that defines the version
- * of all routes in the class. See Versioning
- * for more details.
- *
- * @publicApi
- */
-function Controller(prefixOrOptions) {
-    const defaultPath = "/";
-    const [path, host, scopeOptions, versionOptions] = (0, shared_helper_1.isUndefined)(prefixOrOptions)
-        ? [defaultPath, undefined, undefined, undefined]
-        : (0, shared_helper_1.isString)(prefixOrOptions) || Array.isArray(prefixOrOptions)
-            ? [prefixOrOptions, undefined, undefined, undefined]
-            : [
-                prefixOrOptions.path || defaultPath,
-                prefixOrOptions.host,
-                { scope: prefixOrOptions.scope, durable: prefixOrOptions.durable },
-                Array.isArray(prefixOrOptions.version) ? Array.from(new Set(prefixOrOptions.version)) : prefixOrOptions.version,
-            ];
-    return (target) => {
-        Reflect.defineMetadata(constants_2.CONTROLLER_WATERMARK, true, target);
-        Reflect.defineMetadata(constants_2.PATH_METADATA, path, target);
-        Reflect.defineMetadata(constants_2.HOST_METADATA, host, target);
-        Reflect.defineMetadata(constants_1.SCOPE_OPTIONS_METADATA, scopeOptions, target);
-        Reflect.defineMetadata(constants_2.VERSION_METADATA, versionOptions, target);
-    };
-}
-exports.Controller = Controller;

package/decorators/header.decorator.d.ts

@@ -1,12 +0,0 @@
-/**
- * Request method Decorator.  Sets a response header.
- *
- * For example:
- * `@Header('Cache-Control', 'none')`
- *
- * @param name string to be used for header name
- * @param value string to be used for header value
- *
- * @publicApi
- */
-export declare function Header(name: string, value: string): MethodDecorator;

package/decorators/header.decorator.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Header = void 0;
-const extends_metadata_helper_1 = require("../../core/helpers/extends-metadata.helper");
-const constants_1 = require("@venok/http/constants");
-/**
- * Request method Decorator.  Sets a response header.
- *
- * For example:
- * `@Header('Cache-Control', 'none')`
- *
- * @param name string to be used for header name
- * @param value string to be used for header value
- *
- * @publicApi
- */
-function Header(name, value) {
-    return (target, key, descriptor) => {
-        (0, extends_metadata_helper_1.extendArrayMetadata)(constants_1.HEADERS_METADATA, [{ name, value }], descriptor.value);
-        return descriptor;
-    };
-}
-exports.Header = Header;

package/decorators/http-code.decorator.d.ts

@@ -1,9 +0,0 @@
-/**
- * Request method Decorator. Defines the HTTP response status code.  Overrides
- * default status code for the decorated request method.
- *
- * @param statusCode HTTP response code to be returned by route handler.
- *
- * @publicApi
- */
-export declare function HttpCode(statusCode: number): MethodDecorator;

package/decorators/http-code.decorator.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpCode = void 0;
-const constants_1 = require("@venok/http/constants");
-/**
- * Request method Decorator. Defines the HTTP response status code.  Overrides
- * default status code for the decorated request method.
- *
- * @param statusCode HTTP response code to be returned by route handler.
- *
- * @publicApi
- */
-function HttpCode(statusCode) {
-    return (target, key, descriptor) => {
-        Reflect.defineMetadata(constants_1.HTTP_CODE_METADATA, statusCode, descriptor.value);
-        return descriptor;
-    };
-}
-exports.HttpCode = HttpCode;

package/decorators/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./controller.decorator";
-export * from "./header.decorator";
-export * from "./http-code.decorator";
-export * from "./redirect.decorator";
-export * from "./render.decorator";
-export * from "./request-mapping.decorator";
-export * from "./route-params.decorator";
-export * from "./sse.decorator";
-export * from "./version.decorator";

package/decorators/index.js

@@ -1,25 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./controller.decorator"), exports);
-__exportStar(require("./header.decorator"), exports);
-__exportStar(require("./http-code.decorator"), exports);
-__exportStar(require("./redirect.decorator"), exports);
-__exportStar(require("./render.decorator"), exports);
-__exportStar(require("./request-mapping.decorator"), exports);
-__exportStar(require("./route-params.decorator"), exports);
-__exportStar(require("./sse.decorator"), exports);
-__exportStar(require("./version.decorator"), exports);

package/decorators/redirect.decorator.d.ts

@@ -1,6 +0,0 @@
-/**
- * Redirects request to the specified URL.
- *
- * @publicApi
- */
-export declare function Redirect(url?: string, statusCode?: number): MethodDecorator;

package/decorators/redirect.decorator.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Redirect = void 0;
-const constants_1 = require("@venok/http/constants");
-/**
- * Redirects request to the specified URL.
- *
- * @publicApi
- */
-function Redirect(url = "", statusCode) {
-    return (target, key, descriptor) => {
-        Reflect.defineMetadata(constants_1.REDIRECT_METADATA, { statusCode, url }, descriptor.value);
-        return descriptor;
-    };
-}
-exports.Redirect = Redirect;

package/decorators/render.decorator.d.ts

@@ -1,10 +0,0 @@
-/**
- * Route handler method Decorator. Defines a template to be rendered by the controller.
- *
- * For example: `@Render('index')`
- *
- * @param template name of the render engine template file
- *
- * @publicApi
- */
-export declare function Render(template: string): MethodDecorator;

package/decorators/render.decorator.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Render = void 0;
-const constants_1 = require("@venok/http/constants");
-/**
- * Route handler method Decorator. Defines a template to be rendered by the controller.
- *
- * For example: `@Render('index')`
- *
- * @param template name of the render engine template file
- *
- * @publicApi
- */
-function Render(template) {
-    return (target, key, descriptor) => {
-        Reflect.defineMetadata(constants_1.RENDER_METADATA, template, descriptor.value);
-        return descriptor;
-    };
-}
-exports.Render = Render;

package/decorators/request-mapping.decorator.d.ts

@@ -1,78 +0,0 @@
-import { RequestMethod } from "@venok/http/enums";
-export interface RequestMappingMetadata {
-    path?: string | string[];
-    method?: RequestMethod;
-}
-export declare const RequestMapping: (metadata?: RequestMappingMetadata) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP POST requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Post: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP GET requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Get: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP DELETE requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Delete: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP PUT requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Put: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP PATCH requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Patch: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP OPTIONS requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Options: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes HTTP HEAD requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Head: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const All: (path?: string | string[]) => MethodDecorator;
-/**
- * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-export declare const Search: (path?: string | string[]) => MethodDecorator;

package/decorators/request-mapping.decorator.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Search = exports.All = exports.Head = exports.Options = exports.Patch = exports.Put = exports.Delete = exports.Get = exports.Post = exports.RequestMapping = void 0;
-const constants_1 = require("@venok/http/constants");
-const enums_1 = require("@venok/http/enums");
-const defaultMetadata = {
-    [constants_1.PATH_METADATA]: "/",
-    [constants_1.METHOD_METADATA]: enums_1.RequestMethod.GET,
-};
-const RequestMapping = (metadata = defaultMetadata) => {
-    const pathMetadata = metadata[constants_1.PATH_METADATA];
-    const path = pathMetadata && pathMetadata.length ? pathMetadata : "/";
-    const requestMethod = metadata[constants_1.METHOD_METADATA] || enums_1.RequestMethod.GET;
-    return (target, key, descriptor) => {
-        Reflect.defineMetadata(constants_1.PATH_METADATA, path, descriptor.value);
-        Reflect.defineMetadata(constants_1.METHOD_METADATA, requestMethod, descriptor.value);
-        return descriptor;
-    };
-};
-exports.RequestMapping = RequestMapping;
-const createMappingDecorator = (method) => (path) => {
-    return (0, exports.RequestMapping)({
-        [constants_1.PATH_METADATA]: path,
-        [constants_1.METHOD_METADATA]: method,
-    });
-};
-/**
- * Route handler (method) Decorator. Routes HTTP POST requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Post = createMappingDecorator(enums_1.RequestMethod.POST);
-/**
- * Route handler (method) Decorator. Routes HTTP GET requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Get = createMappingDecorator(enums_1.RequestMethod.GET);
-/**
- * Route handler (method) Decorator. Routes HTTP DELETE requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Delete = createMappingDecorator(enums_1.RequestMethod.DELETE);
-/**
- * Route handler (method) Decorator. Routes HTTP PUT requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Put = createMappingDecorator(enums_1.RequestMethod.PUT);
-/**
- * Route handler (method) Decorator. Routes HTTP PATCH requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Patch = createMappingDecorator(enums_1.RequestMethod.PATCH);
-/**
- * Route handler (method) Decorator. Routes HTTP OPTIONS requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Options = createMappingDecorator(enums_1.RequestMethod.OPTIONS);
-/**
- * Route handler (method) Decorator. Routes HTTP HEAD requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Head = createMappingDecorator(enums_1.RequestMethod.HEAD);
-/**
- * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.All = createMappingDecorator(enums_1.RequestMethod.ALL);
-/**
- * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
- *
- * @see [Routing](https://docs.nestjs.com/controllers#routing)
- *
- * @publicApi
- */
-exports.Search = createMappingDecorator(enums_1.RequestMethod.SEARCH);