mockaton 8.23.3 → 8.23.4

package/README.md

@@ -118,18 +118,13 @@ They will be saved in your `config.mocksDir` following the filename convention.
 
 
 ## Basic Usage
-Mockaton is a Node.js program with no dependencies.
-
-### Create a Sample Mock
-The default `--mocks-dir` is **mockaton-mocks** in the current working directory.
+Mockaton is a Node.js program available as an NPM module. After you have
+Node.js, you can create a sample mock in the default mocks directory, which
+is `./mockaton-mocks`. Then run it with `npx`, which installs it if needed.
 ```sh
 mkdir -p mockaton-mocks/api/
 echo "[1,2,3]" > mockaton-mocks/api/foo.GET.200.json
-```
 
-### Install and Run
-```sh
-npm install mockaton
 npx mockaton --port 2345
 ```
 
@@ -139,34 +134,70 @@ CLI options override their counterparts in `mockaton.config.js`
 ```txt
 -c, --config <file>       (default: ./mockaton.config.js)
 
--m, --mocks-dir <dir>     (default: ./mockaton-mocks/)
--s, --static-dir <dir>    (default: ./mockaton-static-mocks/)
-
 -H, --host <host>         (default: 127.0.0.1)
 -p, --port <port>         (default: 0) which means auto-assigned
+
+-m, --mocks-dir <dir>     (default: ./mockaton-mocks/)
+-s, --static-dir <dir>    (default: ./mockaton-static-mocks/)
 ```
 
 
-## mockaton.config.js
-Optionally, use a `mockaton.config.js` file:
+## mockaton.config.js (Optional)
+As an overview, these are the default options:
 ```js
-import { defineConfig } from 'mockaton'
+import {
+  defineConfig,
+  jsToJsonPlugin,
+  openInBrowser,
+  SUPPORTED_METHODS
+} from 'mockaton'
+
 
 export default defineConfig({
-  port: 2345,
-  mocksDir: 'my-mocks-dir',
-  delayJitter: 0.5,
-  // …
-}) 
+  mocksDir: 'mockaton-mocks',
+  staticDir: 'mockaton-static-mocks',
+  ignore: /(\.DS_Store|~)$/,
+
+  host: '127.0.0.1',
+  port: 0,
+
+  proxyFallback: '',
+  collectProxied: false,
+  formatCollectedJSON: true,
+
+  delay: 1200,
+  delayJitter: 0,
+
+  cookies: {},
+
+  extraHeaders: [],
+
+  extraMimes: {},
+
+  plugins: [
+    [/\.(js|ts)$/, jsToJsonPlugin]
+  ],
+
+  corsAllowed: true,
+  corsOrigins: ['*'],
+  corsMethods: SUPPORTED_METHODS,
+  corsHeaders: ['content-type', 'authorization'],
+  corsExposedHeaders: [],
+  corsCredentials: true,
+  corsMaxAge: 0,
+
+  onReady: await openInBrowser
+})
 ```
 
 <details>
-<summary><b>See all config options</b></summary>
+<summary><b>See Config Documentation</b></summary>
 
-### `mocksDir: string`
-This is the only required field. The directory must exist.
+### `mocksDir?: string`
+Defaults to `'mockaton-mocks'`. 
 
 ### `staticDir?: string`
+Defaults to `'mockaton-static-mocks'`.
 This option is not needed besides serving partial content (e.g., videos). But
 it’s convenient for serving 200 GET requests without having to add the filename
 extension convention. For example, for using Mockaton as a standalone demo server,
@@ -192,7 +223,7 @@ tested against the basename (filename without directory path).
 
 
 ### `host?: string`
-Defaults to `'localhost'`
+Defaults to `'127.0.0.1'`
 
 ### `port?: number`
 Defaults to `0`, which means auto-assigned
@@ -622,7 +653,7 @@ api/foo/bar.GET.200.json
 <br/>
 
 ## Commander API
-`Commander` is a client for Mockaton’s HTTP API.
+`Commander` is a JavaScript client for Mockaton’s HTTP API.
 All of its methods return their `fetch` response promise.
 ```js
 import { Commander } from 'mockaton'
@@ -632,7 +663,8 @@ const myMockatonAddr = 'http://localhost:2345'
 const mockaton = new Commander(myMockatonAddr)
 ```
 
-<br/>
+<details>
+<summary><b>See Commander Documentation</b></summary>
 
 ### Select a mock file for a route
 ```js
@@ -688,6 +720,7 @@ default, but the `proxyFallback`, `colledProxied`, and `corsAllowed` are not aff
 ```js
 await mockaton.reset()
 ```
+</details>
 
 
 <br/>
@@ -704,7 +737,7 @@ example, if you are polling, and you want to test the state change.
 
 ### Client Side
 In contrast to Mockaton, which is an HTTP Server, these programs
-hijack the client (e.g., `fetch`) in Node.js and browsers.
+hijack the HTTP client in Node.js and browsers.
 
 - [Mock Server Worker (MSW)](https://mswjs.io)
 - [Nock](https://github.com/nock/nock)

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "8.23.3",
+	"version": "8.23.4",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Api.js

@@ -14,18 +14,17 @@ import { DF, API, LONG_POLL_SERVER_TIMEOUT } from './ApiConstants.js'
 import { sendOK, sendJSON, sendUnprocessableContent, sendFile } from './utils/http-response.js'
 
 
-const dashboardAssets = [
-	'/ApiConstants.js',
-	'/ApiCommander.js',
-	'/Dashboard.css',
-	'/Dashboard.js',
-	'/Filename.js',
-	'/Logo.svg'
-]
-
 export const apiGetRequests = new Map([
-	[API.dashboard, serveDashboard],
-	...dashboardAssets.map(f => [API.dashboard + f, serveDashboardAsset(f)]),
+	[API.dashboard, serveDashboardAsset('Dashboard.html')],
+	...[
+		'/ApiConstants.js',
+		'/ApiCommander.js',
+		'/Dashboard.css',
+		'/Dashboard.js',
+		'/Filename.js',
+		'/Logo.svg'
+	].map(f => [API.dashboard + f, serveDashboardAsset(f)]),
+
 	[API.cors, getIsCorsAllowed],
 	[API.static, listStaticFiles],
 	[API.mocks, listMockBrokers],
@@ -55,13 +54,8 @@ export const apiPatchRequests = new Map([
 
 /** # GET */
 
-function serveDashboard(_, response) {
-	sendFile(response, join(import.meta.dirname, 'Dashboard.html'))
-}
-
 function serveDashboardAsset(f) {
-	return (_, response) =>
-		sendFile(response, join(import.meta.dirname, f))
+	return (_, response) => sendFile(response, join(import.meta.dirname, f))
 }
 
 function listCookies(_, response) { sendJSON(response, cookie.list()) }
@@ -81,12 +75,10 @@ function longPollClientSyncVersion(req, response) {
 		sendJSON(response, uiSyncVersion.version)
 		return
 	}
-
 	function onAddOrRemoveMock() {
 		uiSyncVersion.unsubscribe(onAddOrRemoveMock)
 		sendJSON(response, uiSyncVersion.version)
 	}
-
 	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, onAddOrRemoveMock)
 	req.on('error', () => {
 		uiSyncVersion.unsubscribe(onAddOrRemoveMock)

package/src/Dashboard.css

@@ -530,10 +530,11 @@ table {
 .PayloadViewer {
 	pre {
 		padding-top: 12px;
+		font-family: monospace;
 
 		code {
 			white-space: pre;
-			tab-size: 4;
+			tab-size: 2;
 			font-family: monospace;
 
 			* {

package/src/cli.js

@@ -45,7 +45,7 @@ Options:
 
 Notes:
   * mockaton.config.js supports more options, see:
-      https://github.com/ericfortis/mockaton?tab=readme-ov-file#config
+      https://github.com/ericfortis/mockaton?tab=readme-ov-file#mockatonconfigjs-optional
   * CLI options override their mockaton.config.js counterparts`)
 
 else if (args.config && !isFile(args.config)) {