mockaton 0.9.2 → 0.9.4

package/Config.js

@@ -9,7 +9,7 @@ export const Config = {
 	port: 0, // auto-assigned
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
-	database: {},
+	database: {}, // for mjs transforms
 	skipOpen: false, // Prevents opening the dashboard in a browser
 	allowedExt: /\.(json|txt|md|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }

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,9 +1,8 @@
-# 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/
@@ -17,7 +16,7 @@ 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 different response status code, or
 - a comment on the filename, which is anything within parentheses.
 
 Those variants can be manually selected in the dashboard
@@ -35,9 +34,9 @@ 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_
+- _200 - OK_,
+- _204 - No Content_ of an empty list of friends, and
+- _501 - Internal Server Error_
 	- 501 mocks get autogenerated for routes that have no 501’s.
 
 ![](./README-dashboard-dropdown.png)
@@ -78,17 +77,15 @@ node my-mockaton.js
 ## Config Options
 ```ts
 interface Config {
-  mocksDir: string
-  staticDir?: string
-  host?: string,
-  port?: number
-
-  cookies?(): object
-
-  skipOpen?: boolean
-  allowedExt?: RegExp
-  delayMilliseconds?: number
-  database?: object
+	mocksDir: string
+	staticDir?: string
+	host?: string,
+	port?: number
+	delay?: number
+	cookies?(): object
+	database?: object
+	skipOpen?: boolean
+	allowedExt?: RegExp
 }
 ```
 
@@ -155,8 +152,6 @@ api/foo/?bar=[bar].GET.200.json
 api/foo/(my comment).GET.200.json
 ```
 
----
-
 
 ---
 ## Mock Precedence
@@ -197,8 +192,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()
 }
 ```
 
@@ -214,15 +211,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
@@ -236,4 +235,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,7 @@ 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', { foo: 'bar' })
 	}
 })

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

package/utils/validate.js

@@ -1,17 +1,27 @@
+const isTypeOf = example => value =>
+	Object.prototype.toString.call(value) ===
+	Object.prototype.toString.call(example)
+
+const typeCheckers = new Map([
+	[Date, isTypeOf(new Date())],
+	[Array, isTypeOf([])],
+	[String, isTypeOf('')],
+	[Object, isTypeOf({})],
+	[Number, isTypeOf(1)],
+	[RegExp, isTypeOf(/a/)],
+	[Boolean, isTypeOf(true)],
+	[Function, isTypeOf(a => a)]
+])
+
+
 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))
+		if (typeCheckers.has(validator)) {
+			if (!typeCheckers.get(validator)(value))
 				throw new TypeError(`${field} ${value}`)
 		}
-		else if (!isTypeOf(validator, value))
+		else if (!validator(value))
 			throw new TypeError(`${field} ${value}`)
 	}
 }
-
-function isTypeOf(example, value) {
-	return (
-		Object.prototype.toString.call(value) ===
-		Object.prototype.toString.call(example))
-}