mockaton 0.9.3 → 0.9.5

package/Config.js

@@ -1,5 +1,5 @@
 import { existsSync, lstatSync } from 'node:fs'
-import { validate } from './utils/validate.js'
+import { validate, is, optional } from './utils/validate.js'
 
 
 export const Config = {
@@ -10,7 +10,7 @@ export const Config = {
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
 	database: {},
-	skipOpen: false, // Prevents opening the dashboard in a browser
+	skipOpen: false,
 	allowedExt: /\.(json|txt|md|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 
@@ -19,21 +19,16 @@ export function setup(options) {
 	validate(Config, {
 		mocksDir: isDirectory,
 		staticDir: optional(isDirectory),
-		host: String,
+		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		delay: ms => Number.isInteger(ms) && ms > 0,
-		cookies: Object,
-		database: Object,
-		skipOpen: Boolean,
-		allowedExt: RegExp
+		cookies: is(Object),
+		database: is(Object),
+		skipOpen: is(Boolean),
+		allowedExt: is(RegExp)
 	})
 }
 
-
-function optional(tester) {
-	return val => !val || tester(val)
-}
-
 function isDirectory(dir) {
 	return existsSync(dir) && lstatSync(dir).isDirectory()
 }

package/MockBroker.js

@@ -24,7 +24,7 @@ export class MockBroker {
 			delay: 0
 		}
 
-		this.transforms = [] // *.js
+		this.transforms = [] // *.mjs
 		this.currentTransform = ''
 
 		this.register(file)

package/README.md

@@ -1,26 +1,25 @@
-# Mockaton (Mock Server)
+# Mockaton 
+_Mockaton_ is a mock server for developing and testing frontends.
 
-Mockaton scans `Config.mocksDir` for files
-following a specific file name convention, which is similar to the URLs.
-
-For example, the following file will be served for `/api/user/1234`
+It scans `Config.mocksDir` for files following a specific file name convention, which is
+similar to the URLs. For example, the following file will be served for `/api/user/1234`
 ```
 api/
 api/user/
 api/user/[user-id].GET.200.json
 ```
 
-By the way, this [browser
+By the way, [this browser
 extension](https://github.com/ericfortis/devtools-ext-tar-http-requests) can
-be used for downloading a tar of your XHR requests following that convention.
+be used for downloading a TAR of your XHR requests following that convention.
 
 
 ### Mock Variants
-Each route can have different mocks and those variants could either be:
-- a different response status code, (e.g. 200, 401), or
-- a comment on the filename, which is anything within parentheses.
+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.
 
-Those variants can be manually selected in the dashboard
+Those alternatives can be manually selected in the dashboard
 UI, or programmatically, for instance, for setting up tests.
 
 
@@ -35,10 +34,10 @@ exploring its [sample-mocks/](./sample-mocks) directory. Then run
 ### Mock Variants of Status Code
 The **sample-mocks/** directory has three mock alternatives for serving
 `/api/user/friends`:
-- an HTTP status of _200 - OK_,
-- another one with _204 - No Content_ of an empty list of friends, and
-- a _501 - Internal Server Error_
-	- 501 mocks get autogenerated for routes that have no 501’s.
+- _200 - OK_
+- _204 - No Content_ with an empty list of friends
+- _501 - Internal Server Error_
+	- BTW, 501 mocks get autogenerated for routes that have no 501’s.
 
 ![](./README-dashboard-dropdown.png)
 
@@ -46,11 +45,9 @@ The **sample-mocks/** directory has three mock alternatives for serving
 Comments are anything within parentheses, including them.
 ![](./README-mocks-with-comments.png)
 
----
-
-## Delay
+## Delay 🕓
 The clock icon next to the mock selector dropdown is a checkbox for delaying a
-particular response. They are handy for testing spinners when developing UIs. 
+particular response. They are handy for testing spinners.
 
 The milliseconds for the delay is globally configurable via `Config.delay = 1200`
 
@@ -78,15 +75,15 @@ node my-mockaton.js
 ## Config Options
 ```ts
 interface Config {
-	mocksDir: string
-	staticDir?: string
-	host?: string,
-	port?: number
-	delay?: number
-	cookies?(): object
-	database?: object
-	skipOpen?: boolean
-	allowedExt?: RegExp
+  mocksDir: string
+  staticDir?: string 
+  host?: string, // 'localhost'
+  port?: number // 0 auto-assigned
+  delay?: number // 1200 ms
+  cookies?(): object 
+  database?: object // for "Transforms"
+  skipOpen?: boolean // Prevents opening the dashboard in a browser
+  allowedExt?: RegExp // /\.(json|txt|md|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 ```
 
@@ -97,7 +94,10 @@ import { jwtCookie } from 'mockaton'
 Config.cookies = {
   'My Admin User':  'my-cookie=1;Path=/;SameSite=strict',
   'My Normal User': 'my-cookie=0;Path=/;SameSite=strict',
-  'My JWT': jwtCookie('my-cookie', { foo: 'bar' })
+  'My JWT': jwtCookie('my-cookie', {
+    email: 'john.doe@example.com',
+    picture: 'https://cdn.auth0.com/avatars/jd.png'
+  })
 }
 ```
 
@@ -193,8 +193,10 @@ with `.mjs` will process the mock before serving it.
 
 For example, this handler will uppercase the mock body.
 ```js
-export default capitalizeAllText(mockAsText, requestBody) {
-  return mockAsText.toUpperCase();
+export default function capitalizeAllText(mockAsText, requestBody, Config) {
+  Config.database.myCount ??= 0
+  Config.database.myCount++
+  return mockAsText.toUpperCase()
 }
 ```
 
@@ -210,15 +212,17 @@ other words, only one transform per route is supported in demo mode.
 ```
 PATCH http://localhost:2345/mockaton/edit
 { 
-	"file": "api/foo.200.GET.json"
-	"delayed": true // optional
+  "file": "api/foo.200.GET.json"
+  "delayed": true // optional
 }
 ```
 
 ### Bulk Selecting Mocks by Matching comments
 ```
 PATCH http://localhost:2345/mockaton/bulk-select
-{ "comment": "demo-a" }
+{
+  "comment": "demo-a"
+}
 ```
 
 Many mocks can be changed at once. We do that by searching the
@@ -232,4 +236,7 @@ Similarly, if there’s no demo mock at all for
 a route, the first dev mock (a-z) will be served.
 
 
-
+### Reset
+```
+PATCH http://localhost:2345/mockaton/reset
+```

package/Route.js

@@ -67,7 +67,7 @@ export class Route {
 }
 
 
-// Stars out (for regex) all the paths that are in angle brackets
+// Stars out (for regex) all the paths that are in square brackets
 function disregardVariables(str) {
 	return str.replace(/\[.*?]/g, '[^/]*')
 }

package/_usage_example.js

@@ -9,6 +9,10 @@ Mockaton({
 	staticDir: resolve('sample-static'),
 	cookies: {
 		'Admin User': 'my-cookie=1;Path=/;SameSite=strict',
-		'Normal User': 'my-cookie=0;Path=/;SameSite=strict'
+		'Normal User': 'my-cookie=0;Path=/;SameSite=strict',
+		'My JWT': jwtCookie('my-cookie', {
+			email: 'john.doe@example.com',
+			picture: 'https://cdn.auth0.com/avatars/jd.png'
+		})
 	}
 })

package/mockBrokersCollection.js

@@ -47,8 +47,8 @@ export const getBrokerByFilename = file => {
 
 
 // Searching the routes in reverse order so dynamic params (e.g.
-// /user/<id>) don’t take precedence over exact paths (e.g.
-// /user/name). That’s because "<" chars are lower than alphanumeric ones.
+// /user/[id]) don’t take precedence over exact paths (e.g.
+// /user/name). That’s because "[]" chars are lower than alphanumeric ones.
 // BTW, `urlMasks` always start with "/", so there’s no need to
 // worry about the primacy of array-like keys when iterating.
 export function findMatchingBroker(method, url) {

package/package.json

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

package/utils/validate.js

@@ -1,17 +1,8 @@
 export function validate(obj, shape) {
-	for (const [field, value] of Object.entries(obj)) {
-		const validator = shape[field]
-		if (isTypeOf(validator, Function) && validator !== Function) {
-			if (!validator(value))
-				throw new TypeError(`${field} ${value}`)
-		}
-		else if (!isTypeOf(validator, value))
+	for (const [field, value] of Object.entries(obj))
+		if (!shape[field](value))
 			throw new TypeError(`${field} ${value}`)
-	}
 }
 
-function isTypeOf(example, value) {
-	return (
-		Object.prototype.toString.call(value) ===
-		Object.prototype.toString.call(example))
-}
+export const is = ctor => val => val.constructor === ctor
+export const optional = tester => val => !val || tester(val)