@tsed/platform-router 7.0.0-beta.14

package/lib/types/domain/PlatformRouters.d.ts

@@ -0,0 +1,14 @@
+import { Hooks } from "@tsed/core";
+import { InjectorService, TokenProvider } from "@tsed/di";
+import { PlatformParams } from "@tsed/platform-params";
+import { PlatformLayer } from "./PlatformLayer";
+import { PlatformRouter } from "./PlatformRouter";
+export declare class PlatformRouters {
+    protected readonly injector: InjectorService;
+    protected readonly platformParams: PlatformParams;
+    readonly hooks: Hooks;
+    constructor(injector: InjectorService, platformParams: PlatformParams);
+    prebuild(): void;
+    from(token: TokenProvider, parentMiddlewares?: any[]): PlatformRouter;
+    getLayers(router: PlatformRouter): PlatformLayer[];
+}

package/lib/types/domain/SinglePathType.d.ts

@@ -0,0 +1 @@
+export declare type SinglePathType = string | RegExp;

package/lib/types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./domain/PlatformHandlerMetadata";
+export * from "./domain/PlatformHandlerType";
+export * from "./domain/PlatformLayer";
+export * from "./domain/PlatformRouter";
+export * from "./domain/PlatformRouters";
+export * from "./domain/SinglePathType";
+export * from "./utils/formatMethod";
+export * from "./utils/useContextHandler";

package/lib/types/utils/formatMethod.d.ts

@@ -0,0 +1 @@
+export declare function formatMethod(method: string | undefined): string;

package/lib/types/utils/useContextHandler.d.ts

@@ -0,0 +1,13 @@
+import { DIContext } from "@tsed/di";
+import { PlatformHandlerType } from "../domain/PlatformHandlerType";
+export declare type PlatformContextHandler<Context = DIContext> = ($ctx: Context) => any | Promise<any>;
+/**
+ * Create Ts.ED context handler
+ * @param fn
+ * @ignore
+ */
+export declare function useContextHandler(fn: PlatformContextHandler & {
+    type?: PlatformHandlerType;
+}): PlatformContextHandler<DIContext> & {
+    type?: PlatformHandlerType | undefined;
+};

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@tsed/platform-router",
+  "version": "7.0.0-beta.14",
+  "description": "Router",
+  "private": false,
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2"
+  },
+  "dependencies": {
+    "tslib": "2.4.0"
+  },
+  "devDependencies": {
+    "@tsed/core": "7.0.0-beta.14",
+    "@tsed/di": "7.0.0-beta.14",
+    "@tsed/exceptions": "7.0.0-beta.14",
+    "@tsed/json-mapper": "7.0.0-beta.14",
+    "@tsed/platform-params": "7.0.0-beta.14",
+    "@tsed/schema": "7.0.0-beta.14"
+  },
+  "peerDependencies": {
+    "@tsed/core": "^7.0.0-beta.14",
+    "@tsed/di": "^7.0.0-beta.14",
+    "@tsed/exceptions": "^7.0.0-beta.14",
+    "@tsed/json-mapper": "^7.0.0-beta.14",
+    "@tsed/platform-params": "^7.0.0-beta.14",
+    "@tsed/schema": "^7.0.0-beta.14"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/exceptions": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    },
+    "@tsed/platform-params": {
+      "optional": false
+    }
+  },
+  "repository": "https://github.com/tsedio/tsed",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/platform/platform-router",
+  "author": "Romain Lenzotti",
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "beta"
+  }
+}

package/readme.md

@@ -0,0 +1,176 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>@tsed/platform-router</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![Coverage Status](https://coveralls.io/repos/github/tsedio/tsed/badge.svg?branch=production)](https://coveralls.io/github/tsedio/tsed?branch=production)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://slack.tsed.io">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io/
+
+# Installation
+
+```bash
+npm install --save @tsed/platform-router
+```
+
+## Usage
+
+This module generates routers from decorated class.
+
+```typescript
+import express from "express";
+import {Controller, InjectorService} from "@tsed/di";
+import {PlatformHandlerType, PlatformHandlerMetadata, PlatformRouter, PlatformLayer} from "@tsed/platform-router";
+import {Delete, Get, Head, Options, Patch, Post, Put} from "@tsed/schema";
+
+@Controller("/nested")
+class NestedController {
+  @Get("/")
+  get() {}
+
+  @Post("/")
+  post() {}
+
+  @Put("/:id")
+  put() {}
+
+  @Delete("/:id")
+  delete() {}
+
+  @Head("/:id")
+  head() {}
+
+  @Options("/:id")
+  option() {}
+
+  @Patch("/:id")
+  patch() {}
+}
+
+@Controller({path: "/controller", children: [NestedController]})
+@UseBefore(function useBefore() {})
+class MyController {
+  @Get("/")
+  get() {}
+
+  @Post("/")
+  post() {}
+
+  @Put("/:id")
+  put() {}
+
+  @Delete("/:id")
+  delete() {}
+
+  @Head("/:id")
+  head() {}
+
+  @Options("/:id")
+  option() {}
+
+  @Patch("/:id")
+  patch() {}
+}
+
+const injector = new InjectorService();
+const expressApp = express();
+
+injector.addProvider(MyController);
+injector.addProvider(NestedController);
+
+const appRouter = new PlatformRouter(injector);
+
+appRouter.use("/rest", MyController);
+
+// transform handlerMetadata to a compatible handler for the targeted framework (Express.js, Koa.js, etc...)
+PlatformRouter.hooks.on("alterHandler", (handlerMetadata: PlatformHandlerMetadata) => {
+  const handler = handlerMetadata.compileHandler(injector);
+
+  switch (handlerMetadata.type) {
+    default:
+    case PlatformHandlerType.RAW_FN: // native express.js/koa.js handler
+      return handler;
+    case PlatformHandlerType.MIDDLEWARE:
+    case PlatformHandlerType.ENDPOINT:
+      return (req, res, next) => {
+        return next();
+      };
+    case PlatformHandlerType.ERR_MIDDLEWARE:
+      return (error: unknown, req, res, next) => {
+        return next();
+      };
+    case PlatformHandlerType.CUSTOM:
+      return (req, res, next) => {
+        return next();
+      };
+  }
+});
+
+// bind layers to the framework router
+appRouter.getLayers().forEach((layer: PlatformLayer) => {
+  const {method, args} = layer;
+
+  expressApp[method](...layer.args);
+});
+
+expressApp.listen(3000);
+```
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html).
+
+<a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your
+website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2018 Romain Lenzotti
+
+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/tsconfig.compile.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
+}