typescript-mock-server 1.11.2 → 1.11.5

package/README.md

@@ -4,10 +4,37 @@ This makes it easier to maintain your mocks because you can load your own models
 have to update your mock, otherwise you will receive compile errors.
 
 # 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: `npm run --prefix node_modules/typescript-mock-server start -- --path=$INIT_CWD/tms-models`. 
-Your models should export a data const (or a function receiving `req` and `res`) and your file should be named as `^(get|post){1}(-\d)?.ts$`. 
-Changes are being picked up automatically, so no need for a restart. When you add files, you have to restart.
+The easiest way to use this tool is by installing it globally:
+
+```bash
+npm install -g typescript-mock-server
+```
+
+Then you can run it from anywhere using:
+
+```bash
+typescript-mock-server --path=./tms-models
+```
+
+Alternatively, you can install it as a (dev)dependency:
+
+```bash
+npm install --save-dev typescript-mock-server
+```
+
+And add a script to your `package.json`:
+
+```json
+"scripts": {
+  "mock": "typescript-mock-server --path=tms-models"
+}
+```
+
+Or run it directly using `npx`:
+
+```bash
+npx typescript-mock-server --path=tms-models
+```
 
 Check out the [working example project](https://github.com/GuyT07/typescript-mock-server-examle) and [the source](https://github.com/GuyT07/typescript-mock-server/tree/main/tms-models/users).
 
@@ -99,6 +126,10 @@ Following dependencies are being used:
 
 
 ## Release notes (will be moved to GitHub in the future)
+- v1.11.5 - Ensured binary has executable permissions and updated README with better Quickstart instructions.
+- v1.11.4 - Fixed "models not found" error when running as a dependency by removing incorrect path mapping for compiled models and relying on ts-node for raw TypeScript files.
+- v1.11.3 - Fixed module resolution when used as a dependency by explicitly adding ts-node as a dependency and improving its configuration at runtime.
+- v1.11.1 - Added binary support to the package, allowing it to be executed as a command-line tool when installed as a dependency.
 - v1.11.0 - Support dynamic responses via request/response context, added comprehensive tests, and switched to a faster build-and-serve workflow
 - v1.10.0 - Improved path resolution and library usage support
 - v1.0.8 - Minor bugfixes

package/dist/impl/typescript-mock-server-impl.js

@@ -78,7 +78,15 @@ class TypescriptMockServerImpl {
     static loadModule(moduleName) {
         return __awaiter(this, void 0, void 0, function* () {
             if (moduleName.endsWith('.ts')) {
-                require('ts-node').register({ transpileOnly: true });
+                require('ts-node').register({
+                    transpileOnly: true,
+                    compilerOptions: {
+                        module: 'commonjs',
+                        allowJs: true,
+                        esModuleInterop: true,
+                        resolveJsonModule: true
+                    }
+                });
             }
             return yield Promise.resolve(`${moduleName}`).then(s => __importStar(require(s)));
         });
@@ -170,16 +178,6 @@ class TypescriptMockServerImpl {
             const endpoint = this.convertFileNameToEndpoint(dirPath, dirent, httpVerb);
             let modulePath = `${dirPath}/${dirent.name}`;
             this.registeredEndpoints.push({ httpVerb, endpoint });
-            if (__filename.endsWith('.js') && modulePath.endsWith('.ts')) {
-                const distPath = path_1.default.join(process.cwd(), 'dist');
-                const potentialJsPath = modulePath
-                    .replace(process.cwd(), distPath)
-                    .replace(/\.ts$/, '.js');
-                const fs = require('fs');
-                if (fs.existsSync(potentialJsPath)) {
-                    modulePath = potentialJsPath;
-                }
-            }
             yield TypescriptMockServerImpl.loadModule(modulePath)
                 .then(model => this.addEndpoint(endpoint, httpVerb, model))
                 .catch(error => this.log.error(error));

package/dist/src/impl/typescript-mock-server-impl.js

@@ -77,6 +77,17 @@ class TypescriptMockServerImpl {
     }
     static loadModule(moduleName) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (moduleName.endsWith('.ts')) {
+                require('ts-node').register({
+                    transpileOnly: true,
+                    compilerOptions: {
+                        module: 'commonjs',
+                        allowJs: true,
+                        esModuleInterop: true,
+                        resolveJsonModule: true
+                    }
+                });
+            }
             return yield Promise.resolve(`${moduleName}`).then(s => __importStar(require(s)));
         });
     }
@@ -167,15 +178,6 @@ class TypescriptMockServerImpl {
             const endpoint = this.convertFileNameToEndpoint(dirPath, dirent, httpVerb);
             let modulePath = `${dirPath}/${dirent.name}`;
             this.registeredEndpoints.push({ httpVerb, endpoint });
-            if (__filename.endsWith('.js')) {
-                const distPath = path_1.default.join(process.cwd(), 'dist');
-                if (modulePath.startsWith(process.cwd()) && !modulePath.startsWith(distPath)) {
-                    modulePath = modulePath.replace(process.cwd(), distPath);
-                }
-                if (modulePath.endsWith('.ts')) {
-                    modulePath = modulePath.replace(/\.ts$/, '.js');
-                }
-            }
             yield TypescriptMockServerImpl.loadModule(modulePath)
                 .then(model => this.addEndpoint(endpoint, httpVerb, model))
                 .catch(error => this.log.error(error));

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "typescript-mock-server",
-  "version": "1.11.2",
+  "version": "1.11.5",
   "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": "dist/src/index.js",
   "bin": {
     "typescript-mock-server": "dist/src/index.js"
   },
   "scripts": {
+    "prepare": "npm run build",
     "test": "jest",
-    "build": "tsc --outDir dist && sed -i '' '1s|.*|#!/usr/bin/env node|' dist/src/index.js",
+    "build": "tsc --outDir dist && sed -i '' '1s|.*|#!/usr/bin/env node|' dist/src/index.js && chmod +x dist/src/index.js",
     "example": "npm run build && node dist/src/index.js --path=tms-models --port=5200 --cors=http://localhost:5200",
     "start": "npm run build && node dist/src/index.js",
     "update-deps": "npm update",
@@ -43,6 +44,7 @@
     "@types/node": "^24.10.1",
     "cors": "^2.8.5",
     "express": "^5.1.0",
+    "ts-node": "^10.9.2",
     "tslog": "^3.3.3",
     "typescript": "^5.9.3",
     "ts-node-dev": "2.0.0"

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

@@ -33,7 +33,15 @@ export class TypescriptMockServerImpl implements TypescriptMockServer{
 
   private static async loadModule(moduleName: string) {
     if (moduleName.endsWith('.ts')) {
-      require('ts-node').register({ transpileOnly: true });
+      require('ts-node').register({
+        transpileOnly: true,
+        compilerOptions: {
+          module: 'commonjs',
+          allowJs: true,
+          esModuleInterop: true,
+          resolveJsonModule: true
+        }
+      });
     }
     return await import(moduleName);
   }
@@ -113,18 +121,6 @@ export class TypescriptMockServerImpl implements TypescriptMockServer{
     let modulePath = `${dirPath}/${dirent.name}`;
     this.registeredEndpoints.push({ httpVerb, endpoint });
 
-    if (__filename.endsWith('.js') && modulePath.endsWith('.ts')) {
-      const distPath = path.join(process.cwd(), 'dist');
-      const potentialJsPath = modulePath
-        .replace(process.cwd(), distPath)
-        .replace(/\.ts$/, '.js');
-
-      const fs = require('fs');
-      if (fs.existsSync(potentialJsPath)) {
-        modulePath = potentialJsPath;
-      }
-    }
-
     await TypescriptMockServerImpl.loadModule(modulePath)
       .then(model => this.addEndpoint(endpoint, httpVerb, model))
       .catch(error => this.log.error(error));

package/tsconfig.json

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