mockaton 9.6.1 → 10.0.0

package/CHANGELOG.md

@@ -1,6 +1,115 @@
 # Changelog
 
+- 10.0.0 **Breaking Change**: Mockaton constructor is now async. So if you
+use the programmatic launch, instead of the cli, change:
+```js
+Mockaton()
+// to
+await Mockaton()
+```
 
-## 9.0.0 (9/13/25)
-- **Breaking change**: Commander GET APIs have been consolidated into `commander.getState()`. These were undocumented APIs, so likely you are not affected.
-- `--no-open` new cli flag. Prevents opening dashboard in a browser. (No-ops `config.onReady`)
+---
+
+- 9.6.0 dashboard: persist `groupByMethod` preference in localStorage
+- 9.5.0 cli: new log level `verbose`
+- 9.4.0 dashboard: user can resize panels
+- 9.3.0 handle head requests for get mocks
+- 9.2.0 dashboard: syntax highlight more xml files (such as html)
+- 9.1.0 cli: new flag: --no-open
+- 9.0.0 **Breaking Change**: Commander’s GET APIs have been consolidated into `commander.getState()`. 
+  These were undocumented APIs, so you are likely not affected.
+
+---
+
+- 8.27.0 dashboard: group by method checkbox
+- 8.26.0 ui simplify mock-selector label text
+- 8.25.0 --quiet and logLevel options
+- 8.24.0 show iso date in logs and log static file dispatch
+- 8.23.0 cli
+- 8.22.0 xml syntax highlight
+- 8.21.0 responsive mock list
+- 8.20.0 revert progress bar (no clock spinner)
+- 8.19.0 move puppeteer and pixaton to devDeps
+- 8.18.0 cors. allow by default 'authorization' header
+- 8.17.0 conditionally render proxy toggler
+- 8.16.0 watch static mocks dir
+- 8.15.0 add config.delayJitter
+- 8.14.0 static files controls
+- 8.13.0 highlight dir structure
+- 8.12.0 Adds config.formatCollectedJSON
+- 8.11.0 Allow all the HTTP methods Node.js supports
+- 8.10.0 global delay field
+- 8.9.0 long poll Add or Remove mocks
+- 8.8.0 allow proxying individual routes
+- 8.7.0 dashboard now highlights and previews 500 mocks when checking the 500 toggler
+- 8.6.0 feat: save proxied checkbox
+- 8.5.0 Add demo-app-vite
+- 8.4.0 auto register/unregister mocks
+- 8.3.0 feat `config.collectProxied`
+- 8.2.0 Allow changing proxy fallback server from UI
+- 8.1.0 describe http status code in payload viewer title
+- 8.0.0 **Breaking change**: `config.plugins` are no longer an Object. Now they are an Array and they the
+test is now a regex. So if you use custom plugins, change e.g.:
+```js
+plugins = {
+  '.js': jsToJsonPlugin,
+  '.ts': jsToJsonPlugin
+}
+// to
+plugins = [
+  [/\.(js|ts)$/, jsToJsonPlugin], // Default 
+]
+```
+
+---
+
+- 7.8.0 support userland plugins
+- 7.7.0 TypeScript mocks support
+- 7.6.0 render list of static files
+- 7.5.0 allowing previewing mock images
+- 7.4.0 progress bar for payload viewer
+- 7.3.0 Allow CORS Checkbox
+- 7.2.0 add content-type as default header when allowing cors
+- 7.1.0 CORS support
+- 7.0.0 **Breaking change**: Split `PATCH mockaton/edit` into `selectMock` and `setRouteIsDelayed`.
+So instead of:
+```js
+fetch(addr + '/mockaton/edit', {
+  method: 'PATCH',
+  body: JSON.stringify({
+    file: 'api/foo.200.GET.json',
+    delayed: true // optional
+  })
+})
+
+// change it to
+await commander.select('api/foo.200.GET.json')
+await commander.setMockIsDelayed('api/foo.200.GET.json', true)
+```
+
+---
+
+- 6.4.0 Default mock could be selected with the comment `(default)`
+- 6.3.0 422 when trying to change a mock that doesn't exist on a route that has mocks
+- 6.4.0 no partial comment search
+- 6.3.0 Allow extending the mime list
+- 6.2.0 Add `config.ignore` regex
+- 6.1.0 remove `config.allowedExt`
+- 6.0.0 **Breaking change**: Remove feature for using .md files for documentating APIs
+
+---
+
+- 5.0.0 **Breaking change**: .md files no longer use status code in the extension
+- 4.0.0 **Breaking change**: rename `config.open` to `config.onReady`
+- 3.0.0 **Breaking change**: `config.skipOpen` boolean to `config.open` function
+
+---  
+
+- 2.3.0 style dashboard
+- 2.2.0 Allow injecting `extraHeaders`
+- 2.1.0 make auto-generate 500's configurable
+- 2.0.0 **Breaking change**: Transforms no longer get a mock
+
+--- 
+
+- 1.1.0 Allow writing JSON mocks in JS

package/README.md

@@ -501,14 +501,12 @@ Defaults to `'normal'`.
 
 ```js
 import { Mockaton } from 'mockaton'
-import mockatonConfig from './mockaton.config.js'
+import config from './mockaton.config.js'
 
-const server = Mockaton({
-  ...mockatonConfig, // Not required, but it’s not read by default.
-})
+const server = await Mockaton(
+  config // Not required, but it’s not read by default.
+)
 ```
-See [src/cli.js](src/cli.js) or [src/Mockaton.test.js](src/Mockaton.test.js) for more examples.
-
 </details>
 
 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "9.6.1",
+	"version": "10.0.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
@@ -27,6 +27,6 @@
 	},
 	"devDependencies": {
 		"pixaton": "1.1.3",
-		"puppeteer": "24.19.0"
+		"puppeteer": "24.22.3"
 	}
 }

package/src/Mockaton.js

@@ -15,27 +15,28 @@ import { sendNoContent, sendInternalServerError, sendUnprocessableContent } from
 
 
 export function Mockaton(options) {
-	setup(options)
-
-	mockBrokerCollection.init()
-	staticCollection.init()
-	watchMocksDir()
-	watchStaticDir()
-
-	const server = createServer(onRequest)
-
-	server.listen(config.port, config.host, function () {
-		const { address, port } = this.address()
-		const url = `http://${address}:${port}`
-		logger.info('Listening', url)
-		logger.info('Dashboard', url + API.dashboard)
-		config.onReady(url + API.dashboard)
+	return new Promise((resolve, reject) => {
+		setup(options)
+
+		mockBrokerCollection.init()
+		staticCollection.init()
+		watchMocksDir()
+		watchStaticDir()
+
+		const server = createServer(onRequest)
+		server.on('error', reject)
+		server.listen(config.port, config.host, () => {
+			const { address, port } = server.address()
+			const url = `http://${address}:${port}`
+			const dashboardUrl = url + API.dashboard
+			logger.info('Listening', url)
+			logger.info('Dashboard', dashboardUrl)
+			config.onReady(dashboardUrl)
+			resolve(server)
+		})
 	})
-
-	return server
 }
 
-
 async function onRequest(req, response) {
 	response.on('error', logger.warn)
 

package/src/cli.js

@@ -36,7 +36,7 @@ catch (error) {
 }
 
 
-if (args.version) 
+if (args.version)
 	console.log(pkgJSON.version)
 
 else if (args.help)
@@ -83,10 +83,7 @@ else {
 	if (args['no-open']) opts.onReady = () => {}
 
 	try {
-		Mockaton(opts).on('error', error => {
-			console.error(error.message)
-			process.exit(1)
-		})
+		await Mockaton(opts)
 	}
 	catch (err) {
 		console.error(err?.message || err)