mockaton 7.6.2 → 7.7.1

package/README.md

@@ -58,8 +58,9 @@ _Reset_ button is for registering newly added, removed, or renamed mocks.
 
 
 ## Basic Usage
+`tsx` is only needed if you want to write mocks in TypeScript
 ```
-npm install mockaton
+npm install mockaton tsx
 ```
 Create a `my-mockaton.js` file
 ```js
@@ -74,7 +75,7 @@ Mockaton({
 ```
 
 ```sh
-node my-mockaton.js
+node --import=tsx my-mockaton.js
 ```
 
 ## Config Options
@@ -123,7 +124,14 @@ api/user(default).GET.200.json
 
 ---
 
-## You can write JSON mocks in JavaScript
+## You can write JSON mocks in JavaScript or TypeScript
+For TypeScript mocks, install [tsx](https://www.npmjs.com/package/tsx) and load it.
+```shell
+npm install --save-dev tsx
+node --import=tsx my-mockaton.js
+```
+---
+
 An Object, Array, or String is sent as JSON.
 
 `api/foo.GET.200.js`
@@ -373,7 +381,7 @@ await mockaton.reset()
 
 <div style="display: flex; align-items: center; gap: 20px">
   <img src="./sample-mocks/api/user/avatar.GET.200.png" width="170"/>
-  <p style="font-size: 18px">“Use Mockaton” - Albert Einstein</p>
+  <p style="font-size: 18px">“Use Mockaton”</p>
 </div>
 
 

package/_usage_example.js

@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 import { join } from 'node:path'
 import { Mockaton, jwtCookie } from './index.js' // from 'mockaton'
 

package/package.json

@@ -2,13 +2,17 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "7.6.2",
+	"version": "7.7.1",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
 	"repository": "https://github.com/ericfortis/mockaton",
 	"scripts": {
 		"test": "node --test",
-		"demo": "./_usage_example.js"
+		"demo": "node _usage_example.js",
+		"demo:ts": "node --import=tsx _usage_example.js"
+	},
+	"optionalDependencies": {
+		"tsx": "4.19.1"
 	}
 }

package/sample-mocks/api/user/typescript-scores-full.GET.200.ts

@@ -0,0 +1,9 @@
+import scores from './typescript-scores.GET.200'
+
+export default [
+	...scores,
+	{ id: 103 },
+	{ id: 104 },
+	{ id: 105 },
+]
+

package/sample-mocks/api/user/typescript-scores.GET.200.ts

@@ -0,0 +1,6 @@
+export default [
+	{ id: 100 },
+	{ id: 101 },
+	{ id: 102 },
+]
+

package/src/Dashboard.js

@@ -145,7 +145,6 @@ function ResetButton() {
 }
 
 function StaticFilesList({ staticFiles }) {
-	console.log(staticFiles)
 	if (!staticFiles.length)
 		return null
 	return (

package/src/Filename.js

@@ -19,13 +19,16 @@ export function filenameIsValid(file) {
 		console.error(error, file)
 	return !error
 }
+
 function validateFilename(file) {
 	const tokens = file.replace(reComments, '').split('.')
 	if (tokens.length < 4)
 		return 'Invalid Filename Convention'
+
 	const { status, method } = parseFilename(file)
 	if (!responseStatusIsValid(status))
 		return `Invalid HTTP Response Status: "${status}"`
+
 	if (!httpMethods.includes(method))
 		return `Unrecognized HTTP Method: "${method}"`
 }

package/src/MockBroker.js

@@ -64,9 +64,9 @@ export class MockBroker {
 	}
 
 	extractComments() {
-		let comments = []
+		const comments = []
 		for (const file of this.mocks)
-			comments = comments.concat(extractComments(file))
+			comments.push(...extractComments(file))
 		return comments
 	}
 

package/src/MockDispatcher.js

@@ -25,33 +25,59 @@ export async function dispatchMock(req, response) {
 		console.log(decodeURIComponent(req.url), ' → ', file)
 		const filePath = join(Config.mocksDir, file)
 
-		let mockBody
-		if (file.endsWith('.js')) {
-			response.setHeader('Content-Type', mimeFor('.json'))
-			const jsExport = (await import(filePath + '?' + Date.now())).default // date for cache busting
-			mockBody = typeof jsExport === 'function'
-				? await jsExport(req, response)
-				: JSON.stringify(jsExport, null, 2)
-		}
-		else {
-			response.setHeader('Content-Type', mimeFor(file))
-			mockBody = broker.isTemp500
-				? ''
-				: read(filePath)
-		}
+		response.statusCode = status
 
 		if (cookie.getCurrent())
 			response.setHeader('Set-Cookie', cookie.getCurrent())
 
-		response.writeHead(status, Config.extraHeaders)
+		for (let i = 0; i < Config.extraHeaders.length; i += 2)
+			response.setHeader(Config.extraHeaders[i], Config.extraHeaders[i + 1])
+
+		const [mime, mockBody] = broker.isTemp500
+			? temp500Plugin(filePath, req, response)
+			: await preprocessPlugins(filePath, req, response)
+
+		response.setHeader('Content-Type', mime)
 		setTimeout(() => response.end(mockBody), delay)
 	}
 	catch (error) {
 		if (error instanceof JsonBodyParserError)
 			sendBadRequest(response, error)
-		else if (error.code === 'ENOENT')
-			sendNotFound(response) // file has been deleted
+		else if (error.code === 'ENOENT') // mock-file has been deleted
+			sendNotFound(response)
+		else if (error.code === 'ERR_UNKNOWN_FILE_EXTENSION') {
+			if (error.toString().includes('Unknown file extension ".ts"'))
+				console.log('Looks like you need a TypeScript compiler\n',
+					'    npm install tsx\n',
+					'    node --import=tsx my-mockaton.js\n')
+			sendInternalServerError(response, error)
+		}
 		else
 			sendInternalServerError(response, error)
 	}
 }
+
+// TODO expose to userland for custom plugins such yaml -> json
+async function preprocessPlugins(filePath, req, response) {
+	if (filePath.endsWith('.js') || filePath.endsWith('.ts'))
+		return await jsPlugin(filePath, req, response)
+	return readPlugin(filePath, req, response)
+}
+
+function temp500Plugin(filePath) {
+	return [mimeFor(filePath), '']
+}
+
+async function jsPlugin(filePath, req, response) {
+	const jsExport = (await import(filePath + '?' + Date.now())).default // date for cache busting
+	const mockBody = typeof jsExport === 'function'
+		? await jsExport(req, response)
+		: JSON.stringify(jsExport, null, 2)
+	const mime = response.getHeader('Content-Type') // jsFunc are allowed to set it
+		|| mimeFor('.json')
+	return [mime, mockBody]
+}
+
+function readPlugin(filePath) {
+	return [mimeFor(filePath), read(filePath)]
+}

package/src/Mockaton.test.js

@@ -24,7 +24,6 @@ const fixtureCustomMime = [
 	'api/custom-mime.GET.200.my_custom_extension',
 	'Custom Extension and MIME'
 ]
-
 const fixtureNonDefaultInName = [
 	'/api/the-route',
 	'api/the-route(default).GET.200.json',
@@ -35,7 +34,6 @@ const fixtureDefaultInName = [
 	'api/the-route(default).GET.200.json',
 	'default my route body content'
 ]
-
 const fixtureDelayed = [
 	'/api/delayed',
 	'api/delayed.GET.200.json',