typescript-mock-server 0.0.12 → 1.0.1

package/README.md

@@ -58,6 +58,13 @@ export const data: User[] = [{
     lastName: 'Development',
     creationDate:  newDate()
 }];
+
+export const config: Config = {
+    server: {
+        delay: 2000,
+        statusCode: 418
+    }
+}
 ```
 
 ## Dependencies
@@ -72,19 +79,21 @@ Following dependencies are being used:
 ## Roadmap
 - [x] Support other server port
 - [x] Improve paths/way to start
-- [ ] Support different headers/configurations (delays, status codes, ...)
+- [x] Support different headers/configurations (delays, status codes, ...)
 - [x] Support most used HTTP methods
 - [ ] Add tests
-- [ ] Refactor, split up in separate classes (first check if people actually want to use the tool)
+- [x] Refactor, split up in separate classes (first check if people actually want to use the tool)
 - [ ] Setup CI/CD (+code quality + coverage tooling)
 - [ ] Setup website
 - [ ] Create a JVM compatible version
-- [ ] Create interface to force implementation of required properties and make it more stable
-- [ ] Improve error handling (missing properties etc.)
+- [x] Create interface to force implementation of required properties and make it more stable
+- [x] Improve error handling (missing properties etc.)
 - [ ] Create an optional persistent state
 
 
 ## Release notes (will be moved to GitHub in the future)
+- v1.0.1 - Include correct files in GIT tag
+- v1.0.0 - Breaking change: renamed Server config to Request and added interval for delay
 - v0.0.11 - Add items to roadmap, bug fixes
 - v0.0.10 - Support multiple http verbs
 

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "typescript-mock-server",
-  "version": "0.0.12",
+  "version": "1.0.1",
   "description": "Simple mock server that can be used in front end development. Instead of creating json files you can just publish TypeScript objects as json",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "example": "ts-node-dev src/index.ts --path=tms-models --port=5000",
     "start": "ts-node-dev src/index.ts",
     "update-deps": "npm update",
-    "publish-to-npm": "npm publish"
+    "get-version": "echo $npm_package_version",
+    "publish-to-npm": "git tag -a ${npm_package_version} -m \"v${npm_package_version}\" && git push && npm publish"
   },
   "repository": {
     "type": "git",
@@ -32,12 +33,12 @@
     "prettier": "^2.6.2"
   },
   "dependencies": {
-    "@types/express": "^4.17.9",
-    "@types/node": "^14.18.12",
-    "express": "^4.17.3",
-    "ts-node-dev": "^1.1.8",
+    "@types/express": "^4.17.13",
+    "@types/node": "^18.0.5",
+    "express": "^4.18.1",
+    "ts-node-dev": "2.0.0",
     "tslog": "^3.3.3",
-    "typescript": "^4.0.5"
+    "typescript": "^4.7.4"
   },
   "prettier": {
     "arrowParens": "avoid",

package/src/command-line.ts

@@ -1,6 +1,5 @@
 export interface CommandLine {
   getCommands(): Map<Command, string>;
-
   getCommand(command: Command): string | undefined;
 }
 

package/src/impl/typescript-mock-server-impl.ts

@@ -8,6 +8,7 @@ import { opendir } from 'fs/promises';
 import { LoggerImpl } from './logger-impl';
 import { Logger } from '../logger';
 import { TypescriptMockServer } from '../typescript-mock-server';
+import { Interval } from '../models/config';
 
 export class TypescriptMockServerImpl implements TypescriptMockServer{
 
@@ -53,7 +54,25 @@ export class TypescriptMockServerImpl implements TypescriptMockServer{
   }
 
   private addEndpoint(endpoint: string, httpVerb: HttpVerb, model: any) {
-    this.app[httpVerb](endpoint, (req, res) => res.send(model.data));
+    this.app[httpVerb](endpoint, (req, res) => {
+      if (model?.config?.statusCode) {
+        res.statusCode = model?.config?.statusCode;
+      }
+      if (model?.config?.delay) {
+        setTimeout(() => res.send(model.data), this.getDelayValue(model?.config?.delay));
+      } else {
+        return res.send(model.data);
+      }
+    });
+  }
+
+  private getDelayValue(delay: number | Interval): number {
+    if (typeof delay === 'number') {
+      return delay;
+    } else if (delay.min && delay.max) {
+      return Math.floor(delay.min + Math.random() * delay.max);
+    }
+    return 0;
   }
 
   private handleRequest(path: string, dirent: Dirent, httpVerb: HttpVerb) {

package/src/models/config.ts

@@ -0,0 +1,13 @@
+export interface DefaultConfig {
+  request: RequestConfig;
+}
+
+export interface RequestConfig {
+  delay?: number | Interval; // Delay response (in ms), or an interval
+  statusCode?: number; // Status code of response
+}
+
+export interface Interval {
+  min: number; // Minimum boundary, including the value
+  max: number; // Maximum boundary, including the value
+}

package/tms-models/users/get-1.ts

@@ -1,11 +1,20 @@
+import { RequestConfig } from '../../src/models/config';
+
 interface User {
-    id: number;
-    firstName: string;
-    lastName: string;
+  id: number;
+  firstName: string;
+  lastName: string;
 }
 
 export const data: User = {
-    id: 1,
-    firstName: 'Guy',
-    lastName: 'Theuws'
+  id: 1,
+  firstName: 'Guy',
+  lastName: 'Theuws',
+};
+
+export const config: RequestConfig = {
+  delay: {
+    min: 1000,
+    max: 5000,
+  },
 };

package/tms-models/users/get.ts

@@ -1,3 +1,5 @@
+import { RequestConfig } from '../../src/models/config';
+
 export interface User {
     id: number;
     firstName: string;
@@ -18,3 +20,8 @@ export const data: User[] = [{
     lastName: 'Development',
     creationDate:  newDate()
 }];
+
+export const config: RequestConfig = {
+    delay: 2000,
+    statusCode: 418
+}

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2021",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "target": "es6",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
 
     "module": "commonjs",                                /* Specify what module code is generated. */