mockaton 5.0.3 → 6.0.0

package/README.md

@@ -48,10 +48,10 @@ interface Config {
   host?: string, // defaults to 'localhost'
   port?: number // defaults to 0, which means auto-assigned
   delay?: number // defaults to 1200 (ms)
-  onReady?: (dashboardUrl: string) => void // defaults to openInBrowser. pass a noop to prevent opening the dashboard
+  onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
   cookies?: object
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-  allowedExt?: RegExp // /\.(md|json|txt|js)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+  allowedExt?: RegExp // /\.(json|js|txt)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
   extraHeaders?: []
 }
 ```
@@ -149,18 +149,20 @@ permitted](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file)
 but since that’s part of the query string, it’s ignored anyway.
 
 
-
 ### Default (index-like) route
-For the default route of a directory, omit the mock filename name
-(<b>just use the extension</b>). For example, the following files will be
-routed to `api/foo` because comments and the query string are ignored.
+**Option A.** Place it outside the directory:
+```
+api/foo/
+api/foo.GET.200.json
+```
+
+**Option B.** Omit the filename:
 ```text
 api/foo/.GET.200.json
-api/foo/?bar=[bar].GET.200.json
-api/foo/(my comment).GET.200.json
 ```
 
 
+
 ## `Config.cookies`
 The selected cookie is sent in every response in the `Set-Cookie` header.
 
@@ -197,15 +199,6 @@ Config.extraHeaders = [
 ]
 ```
 
-## Documenting Contracts (.md)
-This is handy for documenting request payload parameters. The
-dashboard prints the Markdown document as plain text (I know, I know).
-
-```text
-api/foo/[user-id].POST.md
-api/foo/[user-id].POST.201.json
-```
-
 ---
 
 ## API

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "5.0.3",
+	"version": "6.0.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/sample-mocks/api/user.GET.200.json

@@ -0,0 +1 @@
+"This mock is for /api/user"

package/src/Config.js

@@ -12,7 +12,7 @@ export const Config = {
 	cookies: {}, // defaults to the first kv
 	onReady: openInBrowser,
 	proxyFallback: '', // e.g. http://localhost:9999
-	allowedExt: /\.(md|json|txt|js)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	allowedExt: /\.(json|js|txt)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 	extraHeaders: []
 }
 

package/src/Dashboard.css

@@ -107,6 +107,10 @@ menu {
 	top: 0;
 	width: 50%;
 	margin-left: 16px;
+	
+	h2 {
+		padding-top: 20px;
+	}
 
 	pre {
 		tab-size: 2;
@@ -119,10 +123,6 @@ menu {
 			background: var(--colorLightGrey);
 			font-family: monospace;
 		}
-
-		&.Documentation {
-			margin-bottom: 12px;
-		}
 	}
 }
 

package/src/Dashboard.js

@@ -19,7 +19,6 @@ const Strings = {
 const CSS = {
 	DelayToggler: 'DelayToggler',
 	InternalServerErrorToggler: 'InternalServerErrorToggler',
-	Documentation: 'Documentation',
 	MockSelector: 'MockSelector',
 	PayloadViewer: 'PayloadViewer',
 	PreviewLink: 'PreviewLink',
@@ -30,7 +29,6 @@ const CSS = {
 }
 
 const r = createElement
-const refDocumentation = useRef()
 const refPayloadViewer = useRef()
 const refPayloadFile = useRef()
 
@@ -64,7 +62,6 @@ function DevPanel(brokersByMethod, cookies, comments) {
 				r('table', null, Object.entries(brokersByMethod).map(([method, brokers]) =>
 					r(SectionByMethod, { method, brokers }))),
 				r('div', { className: CSS.PayloadViewer },
-					r('pre', { ref: refDocumentation, className: CSS.Documentation }),
 					r('h2', { ref: refPayloadFile }, Strings.mock),
 					r('pre', { ref: refPayloadViewer }, Strings.click_link_to_preview)))))
 }
@@ -134,14 +131,14 @@ function SectionByMethod({ method, brokers }) {
 				.filter(([, broker]) => broker.mocks.length > 1) // Excludes Markdown only routes (>1 because of the autogen500)
 				.map(([urlMask, broker]) =>
 					r('tr', null,
-						r('td', null, r(PreviewLink, { method, urlMask, documentation: broker.documentation })),
+						r('td', null, r(PreviewLink, { method, urlMask })),
 						r('td', null, r(MockSelector, { broker })),
 						r('td', null, r(DelayToggler, { broker })),
 						r('td', null, r(InternalServerErrorToggler, { broker }))
 					))))
 }
 
-function PreviewLink({ method, urlMask, documentation }) {
+function PreviewLink({ method, urlMask }) {
 	return (
 		r('a', {
 			className: CSS.PreviewLink,
@@ -150,13 +147,6 @@ function PreviewLink({ method, urlMask, documentation }) {
 			async onClick(event) {
 				event.preventDefault()
 				try {
-					if (documentation) {
-						const r = await fetch(documentation)
-						refDocumentation.current.innerText = await r.text()
-					}
-					else
-						refDocumentation.current.innerText = ''
-
 					const spinner = setTimeout(() => refPayloadViewer.current.innerText = Strings.fetching, 180)
 					const res = await fetch(this.href, {
 						method: this.getAttribute('data-method')

package/src/MockBroker.js

@@ -5,19 +5,15 @@ import { isDirectory } from './utils/fs.js'
 import { DEFAULT_500_COMMENT } from './ApiConstants.js'
 
 
-// MockBroker is a state for a particular route. It knows the available
-// mock files that can be served for the route, the currently selected
-// file, and its delay. Also, knows if the route has documentation (md)
+// MockBroker is a state for a particular route. It knows the available mock files
+// that can be served for the route, the currently selected file, and its delay.
 export class MockBroker {
 	#route
 
 	constructor(file) {
 		this.#route = new Route(file)
 		this.method = this.#route.method
-
-		this.documentation = '' // .md
-
-		this.mocks = [] // *.json,txt,js
+		this.mocks = []
 		this.currentMock = {
 			file: '',
 			delay: 0
@@ -27,13 +23,9 @@ export class MockBroker {
 	}
 
 	register(file) {
-		if (file.endsWith('.md'))
-			this.documentation = file
-		else {
-			if (!this.mocks.length)
-				this.currentMock.file = file // The first mock file option for a particular route becomes the default
-			this.mocks.push(file)
-		}
+		if (!this.mocks.length)
+			this.currentMock.file = file // The first mock file option for a particular route becomes the default
+		this.mocks.push(file)
 	}
 
 	urlMaskMatches(url) { return this.#route.urlMaskMatches(url) }
@@ -77,7 +69,7 @@ export class MockBroker {
 	}
 
 	#registerTemp500() {
-		const { urlMask, method } = Route.parseFilename(this.mocks[0] || this.documentation)
+		const { urlMask, method } = Route.parseFilename(this.mocks[0])
 		let mask = urlMask
 		if (isDirectory(join(Config.mocksDir, urlMask)))
 			mask = urlMask + '/'

package/src/MockDispatcher.js

@@ -7,16 +7,10 @@ import { Config } from './Config.js'
 import { mimeFor } from './utils/mime.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 import { JsonBodyParserError } from './utils/http-request.js'
-import { sendInternalServerError, sendNotFound, sendFile, sendBadRequest } from './utils/http-response.js'
+import { sendInternalServerError, sendNotFound, sendBadRequest } from './utils/http-response.js'
 
 
 export async function dispatchMock(req, response) {
-	/* Serve Documentation */
-	if (req.method === 'GET' && req.url.endsWith('.md')) {
-		sendFile(response, join(Config.mocksDir, decodeURIComponent(req.url)))
-		return
-	}
-
 	const broker = mockBrokerCollection.getBrokerForUrl(req.method, req.url)
 	if (!broker) {
 		if (Config.proxyFallback)

package/src/Route.js

@@ -44,43 +44,22 @@ export class Route {
 
 	static parseFilename(file) {
 		const tokens = file.replace(Route.reComments, '').split('.')
-		return file.endsWith('.md') 
-			? parseDocumentation(tokens) 
-			: parseMock(tokens)
-	}
-}
-
-function parseDocumentation(tokens) { // TESTME
-	if (tokens.length < 3)
-		return { error: 'Invalid Documentation Filename Convention' }
-
-	const method = tokens.at(-2)
-	if (!httpMethods.includes(method))
-		return { error: `Unrecognized HTTP Method: "${method}"` }
-
-	return {
-		urlMask: '/' + removeTrailingSlash(tokens.at(-3)),
-		method,
-		status: 200
-	}
-}
-
-function parseMock(tokens) {
-	if (tokens.length < 4)
-		return { error: 'Invalid Filename Convention' }
-
-	const status = Number(tokens.at(-2))
-	if (!responseStatusIsValid(status))
-		return { error: `Invalid HTTP Response Status: "${status}"` }
-
-	const method = tokens.at(-3)
-	if (!httpMethods.includes(method))
-		return { error: `Unrecognized HTTP Method: "${method}"` }
-
-	return {
-		urlMask: '/' + removeTrailingSlash(tokens.at(-4)),
-		method,
-		status
+		if (tokens.length < 4)
+			return { error: 'Invalid Filename Convention' }
+
+		const status = Number(tokens.at(-2))
+		if (!responseStatusIsValid(status))
+			return { error: `Invalid HTTP Response Status: "${status}"` }
+
+		const method = tokens.at(-3)
+		if (!httpMethods.includes(method))
+			return { error: `Unrecognized HTTP Method: "${method}"` }
+
+		return {
+			urlMask: '/' + removeTrailingSlash(tokens.at(-4)),
+			method,
+			status
+		}
 	}
 }
 

package/sample-mocks/api/user/.GET.200.json

@@ -1 +0,0 @@
-"This is an index-like route (i.e. /api/user). This file has no name, only the extension convention is needed for the index path."

package/sample-mocks/api/user/edit-name.PATCH.md

@@ -1,9 +0,0 @@
-# Request Body
-
-```json
-{ 
-  "new_name": "John"
-}
-```
-
-This is just documentation. In this example, for the request body payload.