mockaton 8.11.7 → 8.12.0

package/README.md

@@ -367,6 +367,11 @@ Mockaton’s predefined list. For that, you can add it to <code>config.extraMime
 </details>
 
 
+### `formatCollectedJSON?: boolean`
+Defaults to `true`. Saves the mock with the formatting output
+of `JSON.stringify(data, null, '  ')` (two spaces indentation).
+
+
 ### `staticDir?: string`
 - Use Case 1: If you have a bunch of static assets you don’t want to add `.GET.200.ext`
 - Use Case 2: For a standalone demo server. For example,
@@ -497,11 +502,8 @@ config.corsExposedHeaders = [] // headers you need to access in client-side JS
 
 ### `onReady?: (dashboardUrl: string) => void`
 By default, it will open the dashboard in your default browser on macOS and
-Windows. But for a more cross-platform utility, you could `npm install open` and pass it.
-```js
-import open from 'open'
-config.onReady = open
-```
+Windows. But for a more cross-platform utility you could `npm install open` and
+Mockaton will use that implementation instead.
 
 If you don’t want to open a browser, pass a noop:
 ```js

package/index.d.ts

@@ -18,6 +18,7 @@ interface Config {
 	port?: number
 	proxyFallback?: string
 	collectProxied?: boolean
+	formatCollectedJSON?: boolean
 
 	delay?: number
 	cookies?: { [label: string]: string }

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "mockaton",
-	"description": "A deterministic server-side for developing and testing frontend clients",
+	"description": "A deterministic server-side for developing and testing APIs",
 	"type": "module",
-	"version": "8.11.7",
+	"version": "8.12.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
@@ -15,6 +15,7 @@
 		"outdated": "npm outdated --parseable | awk -F: '{ printf \"npm i %-30s ;# %s\\n\", $4, $2 }'"
 	},
 	"optionalDependencies": {
+		"open": "^10.0.0",
 		"pixaton": ">=1.0.2",
 		"puppeteer": ">=24.1.1"
 	}

package/src/Api.js

@@ -11,7 +11,7 @@ import { parseJSON } from './utils/http-request.js'
 import { listFilesRecursively } from './utils/fs.js'
 import * as mockBrokersCollection from './mockBrokersCollection.js'
 import { DF, API, LONG_POLL_SERVER_TIMEOUT } from './ApiConstants.js'
-import { sendOK, sendJSON, sendUnprocessableContent, sendDashboardFile, sendForbidden } from './utils/http-response.js'
+import { sendOK, sendJSON, sendUnprocessableContent, sendFile } from './utils/http-response.js'
 
 
 const dashboardAssets = [
@@ -25,8 +25,7 @@ const dashboardAssets = [
 
 export const apiGetRequests = new Map([
 	[API.dashboard, serveDashboard],
-	...dashboardAssets.map(f =>
-		[API.dashboard + f, serveDashboardAsset]),
+	...dashboardAssets.map(f => [API.dashboard + f, serveDashboardAsset(f)]),
 	[API.cors, getIsCorsAllowed],
 	[API.static, listStaticFiles],
 	[API.mocks, listMockBrokers],
@@ -54,15 +53,12 @@ export const apiPatchRequests = new Map([
 /* === GET === */
 
 function serveDashboard(_, response) {
-	sendDashboardFile(response, join(import.meta.dirname, 'Dashboard.html'))
+	sendFile(response, join(import.meta.dirname, 'Dashboard.html'))
 }
 
-function serveDashboardAsset(req, response) {
-	const f = req.url.replace(API.dashboard, '')
-	if (dashboardAssets.includes(f))
-		sendDashboardFile(response, join(import.meta.dirname, f))
-	else
-		sendForbidden(response)
+function serveDashboardAsset(f) {
+	return (req, response) =>
+		sendFile(response, join(import.meta.dirname, f))
 }
 
 function listCookies(_, response) { sendJSON(response, cookie.list()) }

package/src/ProxyRelay.js

@@ -39,6 +39,13 @@ export async function proxy(req, response, delay) {
 		let filename = makeMockFilename(req.url, req.method, proxyResponse.status, ext)
 		if (isFile(join(config.mocksDir, filename))) // TESTME
 			filename = makeMockFilename(req.url + `(${randomUUID()})`, req.method, proxyResponse.status, ext)
-		write(join(config.mocksDir, filename), body)
+
+		let data = body
+		if (config.formatCollectedJSON && ext === 'json') // TESTME
+			try {
+				data = JSON.string(JSON.parse(body), null, '  ')
+			}
+			catch {}
+		write(join(config.mocksDir, filename), data)
 	}
 }

package/src/config.js

@@ -16,6 +16,7 @@ export const config = Object.seal({
 	port: 0, // auto-assigned
 	proxyFallback: '', // e.g. http://localhost:9999
 	collectProxied: false,
+	formatCollectedJSON: true,
 
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
@@ -34,7 +35,7 @@ export const config = Object.seal({
 	corsCredentials: true,
 	corsMaxAge: 0,
 
-	onReady: openInBrowser
+	onReady: await openInBrowser
 })
 
 
@@ -49,6 +50,7 @@ export function setup(options) {
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		proxyFallback: optional(URL.canParse),
 		collectProxied: is(Boolean),
+		formatCollectedJSON: is(Boolean),
 
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),

package/src/utils/http-response.js

@@ -17,12 +17,7 @@ export function sendJSON(response, payload) {
 	response.end(JSON.stringify(payload))
 }
 
-export function sendForbidden(response) {
-	response.statusCode = 403
-	response.end()
-}
-
-export function sendDashboardFile(response, file) {
+export function sendFile(response, file) {
 	response.setHeader('Content-Type', mimeFor(file))
 	response.end(readFileSync(file, 'utf8'))
 }

package/src/utils/openInBrowser.js

@@ -1,7 +1,16 @@
 import { exec } from 'node:child_process'
 
 
-export function openInBrowser(address) {
+export const openInBrowser = (async () => {
+	try {
+		return (await import('open')).default
+	}
+	catch (error) {
+		return _openInBrowser
+	}
+})()
+
+function _openInBrowser(address) {
 	switch (process.platform) {
 		case 'darwin':
 			exec(`open ${address}`)