typescript-mock-server 0.0.3 → 0.0.6

package/README.md

@@ -1,10 +1,72 @@
 # Typescript mock server
-Simple mock server that can be used in front end development. Instead of creating json files you can just publish TypeScript objects as json. 
+Simple mock/stub server that can be used in front end development. Instead of creating json files you can just publish TypeScript objects as json. 
 This makes it easier to maintain your mocks because you can load your own models. When you change your implementation you also 
 have to update your mock, otherwise you will receive compile errors. 
 
-# Dependencies
+# Quickstart
+The easiest way to check out this stub/mock server is by installing it as a (dev)dependency and then 
+add a script to you scripts section: `cd node_modules/typescript-mock-server && npm run start -- --path=../../path-to-your-model-directory`. 
+Please note we are changing the directory and therefore, to set the path parameter, you need to go 2 levels up to be in your root. 
+I am looking for a cleaner way of doing this. Your models should export a data const and your file should be named as `^(get|post){1}(-\d)?.ts$`. 
+Changes are being picked up automatically, so no need for a restart.
 
+Check out [the examples](https://github.com/GuyT07/typescript-mock-server/tree/main/tms-models/users).
 
+## Adding GET mocks/stubs
+Examples talk, so lets start with an example.
+
+Your requirement is to have the following endpoints `/users`, `/users/1` and `/users/profile/1`
+
+Create a root folder that contains your models, like `models`. Then add a folder `users` and within the newly created folder 
+create a new folder `profile`. Add following files `get.ts` and `get-1.ts` in the `users` directory, `get-1.ts` in the `profile` dir. You should 
+have the following structure:
+
+```
+--models
+    -- users
+       - get.ts
+       - get-1.ts
+    -- profile
+       - get-1.ts
+```
+
+Within the model file you can import/create your model:
+
+```
+export interface User {
+    id: number;
+    firstName: string;
+    lastName: string;
+    creationDate: Date;
+}
+
+const newDate = () => new Date();
+
+export const data: User[] = [{
+    id: 1,
+    firstName: 'Guy',
+    lastName: 'Theuws',
+    creationDate:  newDate()
+}, {
+    id: 2,
+    firstName: 'Generation Y',
+    lastName: 'Development',
+    creationDate:  newDate()
+}];
+```
+
+## Dependencies
+Following dependencies are being used:
+
+- express
+- ts-node-dev
+- typescript
+- @types/express
+- @types/node
+
+## Roadmap
+- [ ] Support other server port
+- [ ] Improve paths/way to start
+- [ ] Support different headers
+- [ ] Support all HTTP methods
 
-# 

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "typescript-mock-server",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "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",
-  "main": "index.js",
-  "bin": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "ts-node-dev src/index.ts --path=../typescript-mock-server-test/tms-models"
+    "example": "ts-node-dev src/index.ts --path=tms-models",
+    "start": "ts-node-dev src/index.ts"
   },
   "repository": {
     "type": "git",

package/src/index.ts

@@ -1,12 +1,9 @@
-#!./node_modules/.bin/ts-node-dev
+#!./../node_modules/.bin/ts-node-dev
 
 import express from 'express';
 import { Express } from 'express';
 import * as fs from 'fs';
 
-// @ts-ignore
-export default function mockServer() {
-
     const baseDirPath = process.cwd()
     console.log(baseDirPath);
 
@@ -90,5 +87,4 @@ export default function mockServer() {
             endpoint = endpoint.replace('-', '');
         }
         return endpoint;
-    }
 }

package/tms-models/users/get.ts

@@ -2,16 +2,19 @@ export interface User {
     id: number;
     firstName: string;
     lastName: string;
+    creationDate:  Date;
 }
 
-const myNewMethod = () => new Date();
+const newDate = () => new Date();
 
 export const data: User[] = [{
     id: 1,
     firstName: 'Guy',
-    lastName: 'Theuws'
+    lastName: 'Theuws',
+    creationDate:  newDate()
 }, {
     id: 2,
     firstName: 'Generation Y',
-    lastName: 'Development'
+    lastName: 'Development',
+    creationDate:  newDate()
 }];

package/index.js

@@ -1,5 +0,0 @@
-mockServer = require('./src/index');
-
-
-mockServer();
-