mockaton 0.10.1 → 0.10.3

package/README.md

@@ -16,7 +16,7 @@ be used for downloading a TAR of your XHR requests following that convention.
 ### Mock Variants
 Each route can have many mocks, which could either be:
 - Different response __status code__. 
-  - e.g. for testing error responses. BTW, an _Internal Server
+  - e.g. for testing error responses. As a side note, an _Internal Server
     Error_ mock is autogenerated for routes that have no 500.
 - __Comment__ on the filename, which is anything within parentheses.
   - e.g. `api/user(my-comment).POST.201.json`
@@ -24,7 +24,7 @@ Each route can have many mocks, which could either be:
 Those alternatives can be manually selected in the dashboard
 UI, or programmatically, for instance, for setting up tests.
 
-About the default mock file, the first file in **alphabetical order** wins.
+The first file in **alphabetical order** becomes the default mock.
 
 ### Proxying Routes
 `Config.proxyFallback` lets you specify a target
@@ -43,7 +43,7 @@ exploring its [sample-mocks/](./sample-mocks) directory. Then, run
 The clock icon next to the mock selector is a checkbox for delaying a
 particular response. They are handy for testing spinners.
 
-The milliseconds for the delay is globally configurable via `Config.delay = 1200`
+The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 
 ---
 
@@ -57,8 +57,8 @@ import { resolve } from 'node:path'
 import { Mockaton } from 'mockaton'
 
 Mockaton({
-  mocksDir: resolve('my-mocks-dir'),
-	port: 2345
+  mocksDir: resolve('my-mocks-dir'), 
+  port: 2345
 })
 ```
 
@@ -71,9 +71,9 @@ node my-mockaton.js
 interface Config {
   mocksDir: string
   staticDir?: string 
-  host?: string, // 'localhost'
-  port?: number // 0 auto-assigned
-  delay?: number // 1200 ms
+  host?: string, // defaults to 'localhost'
+  port?: number // defaults to 0, which means auto-assigned
+  delay?: number // defaults to 1200 (ms)
   cookies?: object 
   database?: object // for "Transforms"
   skipOpen?: boolean // Prevents opening the dashboard in a browser
@@ -84,7 +84,7 @@ interface Config {
 
 ## Cookies
 ```js
-import { jwtCookie } from 'src/Mockaton'
+import { jwtCookie } from 'mockaton'
 
 Config.cookies = {
   'My Admin User': 'my-cookie=1;Path=/;SameSite=strict',
@@ -95,10 +95,10 @@ Config.cookies = {
   })
 }
 ```
-The key is just a label used in dashboard for selecting the desired cookie.
+The key is just a label used for selecting a particular cookie in the dashboard.
 
-That `jwtCookie` has a hardcoded header and signature. In other
-words, it’s useful iff you care about its payload in the frontend.
+`jwtCookie` has a hardcoded header and signature. In other
+words, it’s useful if you only care about its payload.
 
 ---
 
@@ -115,7 +115,7 @@ The `Config.allowedExt` regex defaults to: `/\.(json|txt|md|mjs)$/`
 
 
 ### Dynamic Parameters
-Anything within square brackets. For example, 
+Anything within square brackets. For example:
 <pre>
 api/user/<b>[id]</b>/<b>[age]</b>.GET.200.json
 </pre>
@@ -134,10 +134,10 @@ api/foo.GET.200.json
 api/video<b>?limit=[limit]</b>.GET.200.json
 </pre>
 
-The query string is ignored when routing to it. It’s
-only used for documenting the URL API contract.
+The query string is ignored when routing to it. In other words, it’s
+only used for documenting the URL contract.
 
-BTW, in Windows, filenames containing "?" are [not
+Speaking of which, in Windows, filenames containing "?" are [not
 permitted](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file),
 but since that’s part of the query string, it’s ignored anyway.
 
@@ -155,7 +155,7 @@ api/foo/(my comment).GET.200.json
 
 ## Documenting Contracts (.md)
 This is handy for documenting request payload parameters. The dashboard will
-print the markdown document (as plain text) above the actual payload content.
+print the Markdown document (as plain text) above the actual payload content.
 
 Create a markdown file following the same filename convention.
 The status code can be any number. For example,

package/package.json

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

package/src/Dashboard.js

@@ -341,7 +341,5 @@ function createSvgElement(tagName, props, ...children) {
 }
 
 function useRef() {
-	return {
-		currentMock: null
-	}
+	return { current: null }
 }

package/src/MockDispatcher.js

@@ -23,7 +23,7 @@ export async function dispatchMock(req, response) {
 		if (Config.proxyFallback)
 			await proxy(req, response)
 		else
-			sendNotFound(response) // TESTME
+			sendNotFound(response) // TODO unit TESTME
 		return
 	}
 
@@ -59,7 +59,7 @@ const nonSafeMethods = ['PATCH', 'POST', 'PUT', 'DELETE', 'CONNECT']
 
 async function requestBodyForTransform(req, mockAsText) {
 	if (nonSafeMethods.includes(req.method))
-		return req.headers[DF.isForDashboard] // TESTME
+		return req.headers[DF.isForDashboard] // TODO unit TESTME
 			? JSON.parse(mockAsText)
 			: await parseJSON(req)
 	return ''