diff --git a/README.md b/README.md index 97a5d9e..8db2a43 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,53 @@ -# TS Project (Template for TypeScript) +# CUBETIQ Express Server -- TypeScript -- TS Node Dev -- Husky -- Prettier -- ESLint +- Express +- TypeScript +- Decorators + +# Getting Start + +- Add code into your `index.ts` + +```ts +import "reflect-metadata" + +import { createServer } from "http" +import server from "./server" + +const app = server.instance +const httpServer = createServer(app) + +httpServer.listen(process.env.PORT || 3000, () => { + console.log(`Server listening on port: 3000`) +}) +``` + +- Create `server.ts` + +```ts +import { Request, Response } from "express" +import { Application } from "./application" +import { Controller, Get } from "./decorators" + +@Controller("/index") +class IndexController { + @Get() + public async index(req: Request, res: Response) { + res.json({ + status: 200, + }) + } +} + +class Server extends Application { + get controllers(): any[] { + return [IndexController] + } +} + +export default new Server() +``` ### Contributors -- Sambo Chea \ No newline at end of file + +- Sambo Chea diff --git a/package.json b/package.json index 3dcc640..bc85fd6 100644 --- a/package.json +++ b/package.json @@ -1,26 +1,27 @@ { - "name": "@cubetiq/ts-project", + "name": "@cubetiq/express-server", "version": "1.0.0", - "description": "TS project template", + "description": "CUBETIQ Express Server", "main": "dist/index.js", "scripts": { "start": "ts-node-dev --respawn --transpile-only src/index.ts", "build": "rm -rf dist && tsc", - "serve": "npm run build && node dist/index.js", - "test": "echo \"Error: no test specified\" && exit 1", "prepare": "husky install" }, "repository": { "type": "git", - "url": "https://git.cubetiqs.com/CUBETIQ/ts-project.git" + "url": "https://git.cubetiqs.com/CUBETIQ/cubetiq-express-server.git" }, "keywords": [ "TypeScript", - "Nodejs" + "Nodejs", + "Express" ], "author": "Sambo Chea ", "license": "ISC", "devDependencies": { + "@types/express": "^4.17.13", + "@types/node": "^16.9.1", "@typescript-eslint/eslint-plugin": "^4.30.0", "@typescript-eslint/parser": "^4.30.0", "eslint": "^7.32.0", @@ -32,7 +33,10 @@ "prettier": "2.3.2", "ts-node-dev": "^1.1.8", "typescript": "^4.4.2", - "@types/node": "^16.9.1" + "reflect-metadata": "^0.1.13" + }, + "dependencies": { + "express": "^4.17.1" }, "lint-staged": { "**/*": "prettier --write --ignore-unknown" diff --git a/src/application.ts b/src/application.ts new file mode 100644 index 0000000..907667d --- /dev/null +++ b/src/application.ts @@ -0,0 +1,53 @@ +import express, { Application as ExpressApp, Handler } from "express" +import MetadataKeys from "./constants/metadata.keys" +import { RouteHandler } from "./decorators/handlers.decorator" + +export abstract class Application { + private readonly _instance: ExpressApp + + get instance(): ExpressApp { + return this._instance + } + + constructor() { + this._instance = express() + this._instance.use(express.json()) + this._instance.use(express.urlencoded({ extended: false })) + this.registerRoutes() + } + + private registerRoutes(): void { + const info: Array<{ api: string; handler: string }> = [] + + this.controllers.forEach((controller) => { + const controllerInstance: { [handlerName: string]: Handler } = + new controller() as any + const basePath: string = Reflect.getMetadata( + MetadataKeys.BASE_PATH, + controller + ) + const routers: RouteHandler[] = Reflect.getMetadata( + MetadataKeys.ROUTERS, + controller + ) + const exRouter = express.Router() + + routers.forEach(({ method, path, handlerName }) => { + exRouter[method]( + path, + controllerInstance[String(handlerName)] + ).bind(controllerInstance) + info.push({ + api: `${method.toLocaleUpperCase()} ${basePath + path}`, + handler: `${controller.name}.${String(handlerName)}`, + }) + }) + + this._instance.use(basePath, exRouter) + }) + + console.table(info) + } + + abstract get controllers(): Array +} diff --git a/src/constants/metadata.keys.ts b/src/constants/metadata.keys.ts new file mode 100644 index 0000000..6aa00af --- /dev/null +++ b/src/constants/metadata.keys.ts @@ -0,0 +1,6 @@ +enum MetadataKeys { + BASE_PATH = "base_path", + ROUTERS = "routers", +} + +export default MetadataKeys diff --git a/src/decorators/controller.decorator.ts b/src/decorators/controller.decorator.ts new file mode 100644 index 0000000..411cacc --- /dev/null +++ b/src/decorators/controller.decorator.ts @@ -0,0 +1,7 @@ +import MetadataKeys from "../constants/metadata.keys" + +export const Controller = (basePath: string): ClassDecorator => { + return (target: any) => { + Reflect.defineMetadata(MetadataKeys.BASE_PATH, basePath, target) + } +} diff --git a/src/decorators/handlers.decorator.ts b/src/decorators/handlers.decorator.ts new file mode 100644 index 0000000..132b0a4 --- /dev/null +++ b/src/decorators/handlers.decorator.ts @@ -0,0 +1,47 @@ +import MetadataKeys from "../constants/metadata.keys" + +export enum Method { + GET = "get", + POST = "post", + PUT = "put", + DELETE = "delete", + PATCH = "patch", +} + +export interface RouteHandler { + method: Method + path: string + handlerName: string | symbol +} + +const methodDecoratorFactory = (method: Method) => { + return (path: string = ""): MethodDecorator => { + return (target: any, propertyKey: string | symbol): void => { + const controllerClass = target.constructor + const routers: RouteHandler[] = Reflect.hasMetadata( + MetadataKeys.ROUTERS, + controllerClass + ) + ? Reflect.getMetadata(MetadataKeys.ROUTERS, controllerClass) + : [] + + routers.push({ + method, + path, + handlerName: propertyKey, + }) + + Reflect.defineMetadata( + MetadataKeys.ROUTERS, + routers, + controllerClass + ) + } + } +} + +export const Get = methodDecoratorFactory(Method.GET) +export const Post = methodDecoratorFactory(Method.POST) +export const Put = methodDecoratorFactory(Method.PUT) +export const Delete = methodDecoratorFactory(Method.DELETE) +export const Patch = methodDecoratorFactory(Method.PATCH) diff --git a/src/decorators/index.ts b/src/decorators/index.ts new file mode 100644 index 0000000..dd19214 --- /dev/null +++ b/src/decorators/index.ts @@ -0,0 +1,2 @@ +export * from "./controller.decorator" +export * from "./handlers.decorator" diff --git a/src/index.ts b/src/index.ts index 8cc3c7e..0a71a37 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1 +1,4 @@ -console.log('Welcome to TS Project!'); \ No newline at end of file +import "reflect-metadata" +import { Application } from "./application" + +export default Application diff --git a/tsconfig.json b/tsconfig.json index 6b84bab..5425253 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,100 +1,17 @@ { "compilerOptions": { - /* Visit https://aka.ms/tsconfig.json to read more about this file */ - - /* Projects */ - // "incremental": true, /* Enable incremental compilation */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ - // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ - // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ - // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ - - /* Language and Environment */ - "target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ - // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ - // "jsx": "preserve", /* Specify what JSX code is generated. */ - // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ - // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ - // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ - // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ - // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ - // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ - // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ - // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ - - /* Modules */ - "module": "commonjs", /* Specify what module code is generated. */ - // "rootDir": "./", /* Specify the root folder within your source files. */ - "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ - // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ - // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ - // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ - // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ - // "types": [], /* Specify type package names to be included without being referenced in a source file. */ - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - // "resolveJsonModule": true, /* Enable importing .json files */ - // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */ - - /* JavaScript Support */ - // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ - // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ - // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ - - /* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ - // "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ - "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ - "outDir": "dist", /* Specify an output folder for all emitted files. */ - // "removeComments": true, /* Disable emitting comments. */ - // "noEmit": true, /* Disable emitting files from a compilation. */ - // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ - // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ - // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ - // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ - // "newLine": "crlf", /* Set the newline character for emitting files. */ - // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ - // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ - // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ - // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ - - /* Interop Constraints */ - // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ - // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ - "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ - // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ - "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ - - /* Type Checking */ - "strict": true, /* Enable all strict type-checking options. */ - // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ - // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ - // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ - // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ - // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ - // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ - // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ - // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ - // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ - // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ - // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ - // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ - // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ - // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ - // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ - // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ - "lib": ["ES2015"], - /* Completeness */ - // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */ + "target": "es5", + "module": "commonjs", + "moduleResolution": "node", + "sourceMap": false, + "outDir": "dist", + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "lib": ["ES2015"], + "skipLibCheck": true, + "experimentalDecorators": true }, - } \ No newline at end of file + "include": ["src/**/*"], + "exclude": ["node_modules"] +}