mockaton 8.26.1 → 9.1.1

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+
+## 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`)

package/README.md

@@ -4,6 +4,8 @@
 ![NPM Version](https://img.shields.io/npm/l/mockaton)
 [![Test](https://github.com/ericfortis/mockaton/actions/workflows/test.yml/badge.svg)](https://github.com/ericfortis/mockaton/actions/workflows/test.yml)
 [![CodeQL](https://github.com/ericfortis/mockaton/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/ericfortis/mockaton/actions/workflows/github-code-scanning/codeql)
+[![codecov](https://codecov.io/github/ericfortis/mockaton/graph/badge.svg?token=90NYLMMG1J)](https://codecov.io/github/ericfortis/mockaton)
+
 
 An HTTP mock server for simulating APIs with minimal setup
 — ideal for testing difficult to reproduce states.
@@ -55,9 +57,9 @@ Nonetheless, there’s a programmatic API, which is handy
 for setting up tests (see **Commander API** section below).
 
 <picture>
-  <source media="(prefers-color-scheme: light)" srcset="pixaton-tests/macos/pic-for-readme.vp880x768.light.gold.png">
-  <source media="(prefers-color-scheme: dark)" srcset="pixaton-tests/macos/pic-for-readme.vp880x768.dark.gold.png">
-  <img alt="Mockaton Dashboard" src="pixaton-tests/macos/pic-for-readme.vp880x768.light.gold.png">
+  <source media="(prefers-color-scheme: light)" srcset="pixaton-tests/macos/pic-for-readme.vp810x768.light.gold.png">
+  <source media="(prefers-color-scheme: dark)" srcset="pixaton-tests/macos/pic-for-readme.vp810x768.dark.gold.png">
+  <img alt="Mockaton Dashboard" src="pixaton-tests/macos/pic-for-readme.vp810x768.light.gold.png">
 </picture>
 
 
@@ -116,20 +118,60 @@ They will be saved in your `config.mocksDir` following the filename convention.
 
 <br/>
 
+## Privacy and Security
+- Zero dependencies (no runtime and no build packages).
+- Does not write to disk. Except when you select ✅ **Save Mocks** for scraping mocks from a backend.
+- Does not initiate network connections (no logs, no telemetry).
+- Does not hijack your HTTP client.
+- Auditable. Organized and small &mdash; under 4 KLoC (50% is UI and tests).
+
 
 ## Basic Usage
-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.
+1. Install Node.js, which comes with `npm` and `npx`
+
+2. Create a sample mock in the default mocks directory (`./mockaton-mocks`)
 ```sh
 mkdir -p mockaton-mocks/api/
 echo "[1,2,3]" > mockaton-mocks/api/foo.GET.200.json
-
+```
+3. Run Mockaton (npx installs it if needed)
+```shell
 npx mockaton --port 2345
 ```
 
+<details>
+<summary>Or, if you have a package.json</summary>
+
+```shell
+npm install mockaton --save-dev
+```
+
+```json
+{
+  "scripts": {
+    "mockaton": "mockaton --port 2345"
+  }
+}
+```
+</details>
+
+
+<details>
+<summary>Or, if want an executable without using NPM?</summary>
+
+Clone this repo, and make a link to `src/cli.js`
+```shell
+git clone https://github.com/ericfortis/mockaton.git
+ln -s `realpath mockaton/src/cli.js` ~/bin/mockaton # some dir in your $PATH
+```
+
+
+</details>
+
+
+
 ## CLI Options
-CLI options override their counterparts in `mockaton.config.js`
+The CLI options override their counterparts in `mockaton.config.js`
 
 ```txt
 -c, --config <file>    (default: ./mockaton.config.js)
@@ -141,13 +183,15 @@ CLI options override their counterparts in `mockaton.config.js`
 -p, --port <port>      (default: 0) which means auto-assigned
 
 -q, --quiet            Errors only
+--no-open              Don’t open dashboard in a browser (noops onReady callback)
+
 -h, --help             Show this help
 -v, --version          Show version
 ```
 
 
 ## mockaton.config.js (Optional)
-As an overview, these are the default options:
+As an overview, these are the defaults:
 ```js
 import {
   defineConfig,
@@ -163,24 +207,20 @@ export default defineConfig({
 
   host: '127.0.0.1',
   port: 0,
+  
+  logLevel: 'normal',
+  
+  delay: 1200,
+  delayJitter: 0,
 
   proxyFallback: '',
   collectProxied: false,
   formatCollectedJSON: true,
 
-  delay: 1200,
-  delayJitter: 0,
-
   cookies: {},
-
   extraHeaders: [],
-
   extraMimes: {},
 
-  plugins: [
-    [/\.(js|ts)$/, jsToJsonPlugin]
-  ],
-
   corsAllowed: true,
   corsOrigins: ['*'],
   corsMethods: SUPPORTED_METHODS,
@@ -188,10 +228,13 @@ export default defineConfig({
   corsExposedHeaders: [],
   corsCredentials: true,
   corsMaxAge: 0,
+  
+  
+  plugins: [
+    [/\.(js|ts)$/, jsToJsonPlugin]
+  ],
 
   onReady: await openInBrowser,
-  
-  logLevel: 'normal'
 })
 ```
 
@@ -331,7 +374,8 @@ config.extraHeaders = [
 ### `extraMimes?: { [fileExt: string]: string }`
 ```js
 config.extraMimes = {
-  jpe: 'application/jpeg'
+  jpe: 'application/jpeg',
+  html: 'text/html; charset=utf-8' // overrides built-in
 }
 ```
 Those extra media types take precedence over the built-in
@@ -709,6 +753,14 @@ with many partial matches, their first mock in alphabetical order wins.
 ### Set route is delayed flag
 ```js
 await mockaton.setRouteIsDelayed('GET', '/api/foo', true)
+// or
+await mockaton.setStaticRouteIsDelayed('/api/foo', true)
+```
+<br/>
+
+### Set static route status
+```js
+await mockaton.setStaticRouteStatus('/api/foo', 404)
 ```
 
 ### Set route is proxied flag
@@ -739,6 +791,23 @@ await mockaton.setCollectProxied(true)
 
 <br/>
 
+### Set global delay value
+```js
+await mockaton.setGlobalDelsy(1200) // ms
+```
+
+<br/>
+
+
+### Set CORS allowed
+```js
+await mockaton.setCorsAllowed(true)
+```
+
+<br/>
+
+
+
 ### Reset
 Re-initialize the collection. The selected mocks, cookies, and delays go back to
 default, but the `proxyFallback`, `colledProxied`, and `corsAllowed` are not affected.

package/index.d.ts

@@ -16,22 +16,20 @@ interface Config {
 
 	host?: string,
 	port?: number
+	
+	logLevel?: 'normal' | 'quiet'
+
+	delay?: number
+	delayJitter?: number
 
 	proxyFallback?: string
 	collectProxied?: boolean
 	formatCollectedJSON?: boolean
 
-	delay?: number
-	delayJitter?: number
-
 	cookies?: { [label: string]: string }
-
 	extraHeaders?: string[]
-
 	extraMimes?: { [fileExt: string]: string }
 
-	plugins?: [filenameTester: RegExp, plugin: Plugin][]
-
 	corsAllowed?: boolean,
 	corsOrigins?: string[]
 	corsMethods?: string[]
@@ -39,15 +37,16 @@ interface Config {
 	corsExposedHeaders?: string[]
 	corsCredentials?: boolean
 	corsMaxAge?: number
+	
+	
+	plugins?: [filenameTester: RegExp, plugin: Plugin][]
 
 	onReady?: (address: string) => void
-	
-	logLevel?: 'normal' | 'quiet'
 }
 
 
 export function Mockaton(options: Partial<Config>): Server | undefined
-export function defineConfig(options: Partial<Config>): Config
+export function defineConfig(options: Partial<Config>): Partial<Config>
 
 export const jsToJsonPlugin: Plugin
 
@@ -86,3 +85,17 @@ export type ClientStaticBrokers = {
 }
 
 
+export interface State {
+	brokersByMethod: ClientBrokersByMethod
+	staticBrokers: ClientStaticBrokers
+	
+	cookies: [label:string, selected:boolean][] 
+	comments: string[]
+	
+	delay: number
+	
+	collectProxied: boolean
+	proxyFallback: string
+	
+	corsAllowed: boolean
+}

package/index.js

@@ -2,9 +2,7 @@ export { Mockaton } from './src/Mockaton.js'
 export { Commander } from './src/ApiCommander.js'
 
 export { jwtCookie } from './src/utils/jwt.js'
-export { openInBrowser } from './src/utils/openInBrowser.js'
 export { jsToJsonPlugin } from './src/MockDispatcher.js'
-export { parseJSON, SUPPORTED_METHODS } from './src/utils/http-request.js'
+export { parseJSON } from './src/utils/http-request.js'
 
-/** @param {Partial<Config>} opts */
 export const defineConfig = opts => opts