Using mongoose models, tests and lint settings.

Author: snava10

.editorconfig

@@ -9,4 +9,6 @@ indent_size = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = false
-insert_final_newline = false
+insert_final_newline = false
+prettier.singleQuote = true
+

src/.eslintignore renamed to .eslintignore

@@ -1,14 +1,20 @@
 {
-  "env": {
-    "browser": true,
-    "commonjs": true,
-    "es2021": true
-  },
-  "extends": ["google"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 12
-  },
-  "plugins": ["@typescript-eslint"],
-  "rules": {}
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
 }

.eslintrc.json

@@ -1,3 +1,3 @@
 {
-    "editor.formatOnSave": true
-}
+  "editor.formatOnSave": true
+}

.vscode/settings.json

@@ -1,13 +1,14 @@
+// eslint-disable-next-line no-undef
 module.exports = {
   globals: {
     "ts-jest": {
-      tsConfig: "tsconfig.json",
+      tsconfig: "tsconfig.json",
     },
   },
   moduleFileExtensions: ["ts", "js"],
   transform: {
     "^.+\\.(ts|tsx)$": "ts-jest",
   },
-  testMatch: ["**/test/**/*.test.(ts|js)"],
+  testMatch: ["**/test/**/*.(test|spec).(ts|js)"],
   testEnvironment: "node",
 };

jest.config.js

@@ -0,0 +1,30 @@
+import { GET, Path, PathParam, POST, PUT } from "typescript-rest";
+import Plane, { PlaneModel } from "../models/plane.model";
+
+@Path("api/planes/")
+export class PlanesController {
+  @GET
+  getAll(): Promise<Array<PlaneModel>> {
+    return Plane.find().exec();
+  }
+
+  @GET
+  @Path(":name")
+  getByName(@PathParam("name") name: string): Promise<Array<PlaneModel>> {
+    return Plane.find({ name: name }).exec();
+  }
+
+  @POST
+  create(plane: PlaneModel): Promise<PlaneModel> {
+    return Plane.create(plane);
+  }
+
+  @PUT
+  update(plane: PlaneModel): Promise<PlaneModel> {
+    return Plane.replaceOne({ _id: plane.id }, plane).exec();
+  }
+
+  delete(planeId: string): Promise<{ deletedCount?: number }> {
+    return Plane.deleteOne({ _id: planeId }).exec();
+  }
+}

src/controllers/planes.controller.ts

@@ -0,0 +1,35 @@
+import mongoose from "mongoose";
+
+export interface PlaneModel {
+  id?: any;
+  manufacturer: string;
+  name: string;
+  maxRange: number;
+}
+
+interface IPlane extends PlaneModel, mongoose.Document {}
+
+export const PlaneSchema = new mongoose.Schema(
+  {
+    manufacturer: {
+      required: true,
+      type: String,
+    },
+    name: {
+      required: true,
+      type: String,
+    },
+    maxRange: {
+      required: true,
+      type: Number,
+      default: 0,
+    },
+  },
+  { timestamps: true }
+);
+
+const Plane: mongoose.Model<IPlane> = mongoose.model<IPlane>(
+  "Plane",
+  PlaneSchema
+);
+export default Plane;

src/models/plane.model.ts

@@ -23,13 +23,10 @@ export async function start(port?: number): Promise<ApiServer> {
   return apiServer;
 }
 
-export function assertEnvironment() {
+export function assertEnvironment(): void {
   const errMessage = " variable not set";
 
   if (!process.env.MONGODB_URI) {
     throw new Error("MONGODB_URI" + errMessage);
   }
-  if (!process.env.JWT_SECRET) {
-    throw new Error("JWT_SECRET" + errMessage);
-  }
 }

src/start.ts

@@ -0,0 +1,19 @@
+describe("Planes controller", () => {
+  //   beforeAll(() => {});
+
+  it("get all", () => {
+    expect(false).toBeTruthy();
+  });
+
+  it("get by name", () => {
+    expect(false).toBeTruthy();
+  });
+
+  it("create", () => {
+    expect(false).toBeTruthy();
+  });
+
+  it("update", () => {
+    expect(false).toBeTruthy();
+  });
+});

test/controllers/planes.controller.spec.ts

@@ -1,25 +1,24 @@
 {
-    "compileOnSave": true,
-    "compilerOptions": {
-      "declaration": false,
-      "experimentalDecorators": true,
-      "emitDecoratorMetadata": true,
-      "module": "commonjs",
-      "newLine": "LF",
-      "noFallthroughCasesInSwitch": true,
-      "noImplicitAny": true,
-      "noImplicitReturns": true,
-      "noImplicitThis": false,
-      "noUnusedParameters": false,
-      "noUnusedLocals": true,
-      "outDir": "dist",
-      "skipLibCheck": true,
-      "sourceMap": false,
-      "strictNullChecks": false,
-      "target": "es2016",
-      "resolveJsonModule": true,
-      "esModuleInterop": true,
-      "rootDir": "src"
-    }
+  "compileOnSave": true,
+  "compilerOptions": {
+    "declaration": false,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "commonjs",
+    "newLine": "LF",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": false,
+    "noUnusedParameters": false,
+    "noUnusedLocals": true,
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "sourceMap": false,
+    "strictNullChecks": false,
+    "target": "es2016",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "rootDir": "src"
   }
-  
+}

test/hello.spec.ts

@@ -1,5 +1,4 @@
 {
-    "extends": "./tsconfig.base.json",
-    "include": ["src/**/*.ts"]
+  "extends": "./tsconfig.base.json",
+  "include": ["src/**/*.ts"]
 }
-