mockaton 6.3.0 → 6.3.4

package/README.md

@@ -44,16 +44,20 @@ node my-mockaton.js
 ```ts
 interface Config {
   mocksDir: string
+  ignore?: RegExp // defaults to /(.DS_Store|~)$/
+	
   staticDir?: string
+	
   host?: string, // defaults to 'localhost'
   port?: number // defaults to 0, which means auto-assigned
-  delay?: number // defaults to 1200 (ms)
-  ignore?: RegExp // defaults to /(.DS_Store|~)$/
-  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
-  extraMimes?: object
+	
+  delay?: number // defaults to 1200 (ms)
+  cookies?: { [label: string]: string }
+  extraMimes?: { [fileExt: string]: string }
   extraHeaders?: []
+	
+  onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
 }
 ```
 
@@ -80,11 +84,12 @@ export default [
 ]
 ```
 
-Or, export default a function. In it, you can override the response status and the
-default JSON content type. But don’t call `response.end()`, just return a string.
+Or, export default a function. In it, you can override the
+response status and the default JSON content type. But don’t call
+`response.end()`, just return a `string`, `Buffer`, or `Uint8Array`.
 
-In a sense, you can think of this is an HTTP handler. So you can read or
-write to a database, or pull data from a backend. The `request` is of type
+Think of this as an HTTP handler. You can read or write to a
+database, or pull data from a backend. The `request` is of type
 [IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage), and the
 `response` a [ServerResponse](https://nodejs.org/api/http.html#class-httpserverresponse).
 ```js

package/index.d.ts

@@ -2,16 +2,20 @@ import { Server } from 'node:http';
 
 interface Config {
 	mocksDir: string
+	ignore?: RegExp
+
 	staticDir?: string
+
 	host?: string,
 	port?: number
-	ignore?: RegExp
-	delay?: number
-	onReady?: (address: string) => void
-	cookies?: object
 	proxyFallback?: string
+
+	delay?: number
+	cookies?: { [label: string]: string }
 	extraHeaders?: [string, string][]
-	extraMimes?: object
+	extraMimes?: { [fileExt: string]: string }
+
+	onReady?: (address: string) => void
 }
 
 export function Mockaton(options: Config): Server

package/package.json

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

package/src/Config.js

@@ -3,34 +3,42 @@ import { validate, is, optional } from './utils/validate.js'
 import { isDirectory } from './utils/fs.js'
 
 
-export const Config = {
+export const Config = Object.seal({
 	mocksDir: '',
+	ignore: /(\.DS_Store|~)$/,
+
 	staticDir: '',
+
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
-	ignore: /(\.DS_Store|~)$/,
+	proxyFallback: '', // e.g. http://localhost:9999
+
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
-	onReady: openInBrowser,
-	proxyFallback: '', // e.g. http://localhost:9999
 	extraHeaders: [],
-	extraMimes: {}
-}
+	extraMimes: {},
+
+	onReady: openInBrowser
+})
 
 export function setup(options) {
 	Object.assign(Config, options)
 	validate(Config, {
 		mocksDir: isDirectory,
+		ignore: is(RegExp),
+
 		staticDir: optional(isDirectory),
+
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
-		ignore: is(RegExp),
+		proxyFallback: optional(URL.canParse),
+
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),
-		onReady: is(Function),
-		proxyFallback: optional(URL.canParse),
 		extraHeaders: Array.isArray,
-		extraMimes: is(Object)
+		extraMimes: is(Object),
+
+		onReady: is(Function)
 	})
 }
 

package/src/MockBroker.js

@@ -1,7 +1,5 @@
-import { join } from 'node:path'
 import { Route } from './Route.js'
 import { Config } from './Config.js'
-import { isDirectory } from './utils/fs.js'
 import { DEFAULT_500_COMMENT } from './ApiConstants.js'
 
 
@@ -12,7 +10,6 @@ export class MockBroker {
 
 	constructor(file) {
 		this.#route = new Route(file)
-		this.method = this.#route.method
 		this.mocks = []
 		this.currentMock = {
 			file: '',
@@ -61,19 +58,11 @@ export class MockBroker {
 		if (!this.#has500())
 			this.#registerTemp500()
 	}
-
 	#has500() {
-		return this.mocks.some(mock =>
-			Route.parseFilename(mock).status === 500)
+		return this.mocks.some(mock => Route.parseFilename(mock).status === 500)
 	}
-
 	#registerTemp500() {
 		const { urlMask, method } = Route.parseFilename(this.mocks[0])
-		let mask = urlMask
-		if (isDirectory(join(Config.mocksDir, urlMask)))
-			mask = urlMask + '/'
-		mask = mask.replace(/^\//, '') // remove initial slash
-		const file = `${mask}${DEFAULT_500_COMMENT}.${method}.500.txt`
-		this.register(file)
+		this.register(`${urlMask}${DEFAULT_500_COMMENT}.${method}.500.txt`)
 	}
 }

package/src/MockDispatcher.js

@@ -22,7 +22,7 @@ export async function dispatchMock(req, response) {
 
 	try {
 		const { file, status, delay } = broker
-		console.log('\n', req.url, '→\n ', file)
+		console.log(req.url, ' → ', file)
 
 		let mockText
 		if (file.endsWith('.js')) {

package/src/Route.js

@@ -14,8 +14,7 @@ export class Route {
 	#urlRegex
 
 	constructor(file) {
-		const { urlMask, method } = Route.parseFilename(file)
-		this.method = method
+		const { urlMask } = Route.parseFilename(file)
 		this.#urlRegex = new RegExp('^' + disregardVariables(removeQueryStringAndFragment(urlMask)) + '/*$')
 	}