mockaton 0.10.0 → 0.10.2

package/README.md

@@ -1,8 +1,8 @@
 # Mockaton 
 _Mockaton_ is a mock server for developing and testing frontends.
 
-It scans `Config.mocksDir` for files following a specific directory
-and file name convention, which is similar to the URL paths. For
+It scans `Config.mocksDir` for files following a specific
+file name convention, which is similar to the URL paths. For
 example, the following file will be served for `/api/user/1234`
 ```
 my-mocks-dir/api/user/[user-id].GET.200.json
@@ -15,13 +15,20 @@ 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. For example, for testing error responses.
-- Comment on the filename, which is anything within parentheses.
+- Different response __status code__. 
+  - e.g. for testing error responses. BTW, 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`
 
 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
+server for serving routes you don’t have mocks for.
 
 
 ## Getting Started
@@ -32,25 +39,11 @@ exploring its [sample-mocks/](./sample-mocks) directory. Then, run
 ![](./README-dashboard.png)
 
 
-### Mock Variants of Status Code
-The **sample-mocks/** directory has three mock alternatives for serving
-`/api/user/friends`:
-- _200 - OK_
-- _204 - No Content_ with an empty list of friends
-- _500 - Internal Server Error_
-	- BTW, 500 mocks get autogenerated for routes that have no 500’s.
-
-![](./README-dashboard-dropdown.png)
-
-### Mock Variants with Comments
-Comments are anything within parentheses, including them.
-![](./README-mocks-with-comments.png)
-
 ## Delay 🕓
 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).
 
 ---
 
@@ -61,11 +54,11 @@ npm install mockaton
 Create a `my-mockaton.js` file
 ```js
 import { resolve } from 'node:path'
-import { Mockaton } from 'src/Mockaton'
+import { Mockaton } from 'mockaton'
 
-Mockaton({ // Config options
-  port: 2345,
-  mocksDir: resolve('my-mocks-dir')
+Mockaton({
+  mocksDir: resolve('my-mocks-dir'), 
+  port: 2345
 })
 ```
 
@@ -81,17 +74,17 @@ interface Config {
   host?: string, // 'localhost'
   port?: number // 0 auto-assigned
   delay?: number // 1200 ms
-  cookies?(): object 
+  cookies?: object 
   database?: object // for "Transforms"
   skipOpen?: boolean // Prevents opening the dashboard in a browser
-	proxyFallback?: string // e.g. http://localhost:9999 For relaying routes without mocks
+  proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
   allowedExt?: RegExp // /\.(json|txt|md|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 ```
 
 ## Cookies
 ```js
-import { jwtCookie } from 'src/Mockaton'
+import { jwtCookie } from 'mockaton'
 
 Config.cookies = {
   'My Admin User': 'my-cookie=1;Path=/;SameSite=strict',
@@ -102,6 +95,7 @@ Config.cookies = {
   })
 }
 ```
+The key is just a label used in dashboard for selecting the desired cookie.
 
 That `jwtCookie` has a hardcoded header and signature. In other
 words, it’s useful iff you care about its payload in the frontend.

package/index.d.ts

@@ -6,9 +6,7 @@ interface Config {
 	host?: string,
 	port?: number
 	delay?: number
-
-	cookies?(): object
-
+	cookies?: object
 	database?: object
 	skipOpen?: boolean
 	proxyFallback?: string

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.0",
+	"version": "0.10.2",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",