Updates for controller inheritance sample to highlight the benefits of unified CRUD operations extended from a base controller (template method pattern)

Author: ivanproskuryakov

sample/sample17-controllers-inheritance/app.ts

@@ -8,4 +8,12 @@ useExpressServer(app, {
 });
 app.listen(3001); // run express app
 
-console.log("Express server is running on port 3001. Open http://localhost:3001/blogs/ or http://localhost:3002/posts/");
+console.log(
+  "Possible GET endpoints you may see from a browser",
+  "http://localhost:3001/article",
+  "http://localhost:3001/article/1000",
+  "http://localhost:3001/product",
+  "http://localhost:3001/product/1000",
+  "http://localhost:3001/category",
+  "http://localhost:3001/category/1000",
+);

sample/sample17-controllers-inheritance/controllers/AbstractContollerTemplate.ts

@@ -0,0 +1,65 @@
+import {Res} from "../../../src/decorator/Res";
+import {Put} from "../../../src/decorator/Put";
+import {Post} from "../../../src/decorator/Post";
+import {Param} from "../../../src/decorator/Param";
+import {Get} from "../../../src/decorator/Get";
+import {Delete} from "../../../src/decorator/Delete";
+import {Body} from "../../../src/decorator/Body";
+
+import {MockedRepository} from "../repository/MockedRepository";
+import {IInstance} from "../interface/IInstance";
+
+export abstract class AbstractControllerTemplate {
+  protected domain: string;
+  protected repository: MockedRepository;
+
+  @Post()
+  public async create(
+    @Body() payload: any,
+    @Res() res: any
+  ): Promise<{}> {
+    const item = await this.repository.create(payload);
+
+    res.status(201);
+    res.location(`/${this.domain}/${item.id}`);
+
+    return {};
+  }
+
+  @Put("/:id")
+  public async updated(
+    @Param("id") id: number,
+    @Body() payload: any,
+    @Res() res: any
+  ): Promise<{}> {
+    await this.repository.update(id, payload);
+    res.status(204);
+
+    return {};
+  }
+
+  @Get("/:id")
+  public read(
+    @Param("id") id: number,
+    @Res() res: any
+  ): Promise<IInstance> {
+    return this.repository.find(id);
+  }
+
+  @Get()
+  public readCollection(
+    @Res() res: any
+  ): Promise<IInstance[]> {
+    return this.repository.getCollection();
+  }
+
+  @Delete("/:id")
+  public async delete(
+    @Param("id") id: number,
+    @Res() res: any
+  ): Promise<{}> {
+    await this.repository.delete(id);
+
+    return {};
+  }
+}

sample/sample17-controllers-inheritance/controllers/ArticleController.ts

@@ -0,0 +1,15 @@
+import {Controller} from "../../../src/decorator/Controller";
+import {AbstractControllerTemplate} from "./AbstractContollerTemplate";
+import {MockedRepository} from "../repository/MockedRepository";
+
+const domain = "article";
+
+@Controller(`/${domain}`)
+export class ArticleController extends AbstractControllerTemplate {
+  protected constructor() {
+    super();
+
+    this.domain = domain;
+    this.repository = new MockedRepository(domain);
+  }
+}

sample/sample17-controllers-inheritance/controllers/BaseController.ts

@@ -0,0 +1,15 @@
+import {Controller} from "../../../src/decorator/Controller";
+import {AbstractControllerTemplate} from "./AbstractContollerTemplate";
+import {MockedRepository} from "../repository/MockedRepository";
+
+const domain = "category";
+
+@Controller(`/${domain}`)
+export class CategoryController extends AbstractControllerTemplate {
+  protected constructor() {
+    super();
+
+    this.domain = domain;
+    this.repository = new MockedRepository(domain);
+  }
+}

sample/sample17-controllers-inheritance/controllers/BlogController.ts

@@ -0,0 +1,15 @@
+import {Controller} from "../../../src/decorator/Controller";
+import {AbstractControllerTemplate} from "./AbstractContollerTemplate";
+import {MockedRepository} from "../repository/MockedRepository";
+
+const domain = "product";
+
+@Controller(`/${domain}`)
+export class CategoryController extends AbstractControllerTemplate {
+  protected constructor() {
+    super();
+
+    this.domain = domain;
+    this.repository = new MockedRepository(domain);
+  }
+}

sample/sample17-controllers-inheritance/controllers/CategoryController.ts

@@ -0,0 +1,4 @@
+export interface IInstance {
+  id: number;
+  type: string;
+}

sample/sample17-controllers-inheritance/controllers/PostController.ts

@@ -0,0 +1,3 @@
+export interface IPayload {
+  id: number;
+}