mockaton 0.9.4 → 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 = {
@@ -9,8 +9,8 @@ export const Config = {
 	port: 0, // auto-assigned
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
-	database: {}, // for mjs transforms
-	skipOpen: false, // Prevents opening the dashboard in a browser
+	database: {},
+	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/README.md

@@ -9,17 +9,17 @@ 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, 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.
 
 
@@ -34,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`:
-- _200 - OK_,
-- _204 - No Content_ of an empty list of friends, and
+- _200 - OK_
+- _204 - No Content_ with an empty list of friends
 - _501 - Internal Server Error_
-	- 501 mocks get autogenerated for routes that have no 501’s.
+	- BTW, 501 mocks get autogenerated for routes that have no 501’s.
 
 ![](./README-dashboard-dropdown.png)
 
@@ -45,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`
 
@@ -77,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 ~)
 }
 ```
 
@@ -96,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'
+  })
 }
 ```
 

package/_usage_example.js

@@ -10,6 +10,9 @@ Mockaton({
 	cookies: {
 		'Admin User': 'my-cookie=1;Path=/;SameSite=strict',
 		'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'
+		})
 	}
 })

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

package/utils/validate.js

@@ -1,27 +1,8 @@
-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 (typeCheckers.has(validator)) {
-			if (!typeCheckers.get(validator)(value))
-				throw new TypeError(`${field} ${value}`)
-		}
-		else if (!validator(value))
+	for (const [field, value] of Object.entries(obj))
+		if (!shape[field](value))
 			throw new TypeError(`${field} ${value}`)
-	}
 }
+
+export const is = ctor => val => val.constructor === ctor
+export const optional = tester => val => !val || tester(val)