mockaton 0.9.4 → 0.9.6

package/Api.js

@@ -97,7 +97,7 @@ async function bulkUpdateBrokersByCommentTag(req, response) {
 async function updateBrokerTransform(req, response) {
 	try {
 		const body = await parseJSON(req)
-		const broker = mockBrokersCollection.getBroker(body[DF.method], body[DF.urlMask])
+		const broker = mockBrokersCollection.getBrokerByFilename(body[DF.file])
 		broker.updateTransform(body[DF.file])
 		sendOK(response)
 	}

package/ApiConstants.js

@@ -15,7 +15,5 @@ export const DF = { // Dashboard Fields (XHR)
 	delayed: 'delayed',
 	file: 'file',
 	currentCookieKey: 'current_cookie_key',
-	isForDashboard: 'mock_request_payload',
-	method: 'method',
-	urlMask: 'url_mask'
+	isForDashboard: 'mock_request_payload'
 }

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/Dashboard.js

@@ -257,15 +257,13 @@ function Transforms({ brokersByMethod }) {
 			r('tr', null,
 				r('td', null, r(PreviewLink, { method: broker.method, urlMask })),
 				r('td', null, r(TransformSelector, {
-					urlMask,
-					method: broker.method,
 					items: ['', ...broker.transforms],
 					selected: broker.currentTransform
 				})))
 		)))
 }
 
-function TransformSelector({ method, urlMask, items, selected }) {
+function TransformSelector({ items, selected }) {
 	const className = defaultIsSelected => cssClass(
 		CSS.TransformSelector,
 		!defaultIsSelected && CSS.bold)
@@ -273,16 +271,10 @@ function TransformSelector({ method, urlMask, items, selected }) {
 		r('select', {
 			className: className(selected === items[0]),
 			autocomplete: 'off',
-			'data-urlMask': urlMask,
-			'data-method': method,
 			onChange() {
 				fetch(DP.transform, {
 					method: 'PATCH',
-					body: JSON.stringify({
-						[DF.file]: this.value,
-						[DF.urlMask]: this.getAttribute('data-urlMask'),
-						[DF.method]: this.getAttribute('data-method')
-					})
+					body: JSON.stringify({ [DF.file]: this.value })
 				}).then(() => {
 					this.closest('tr').querySelector('a').click()
 					this.className = className(this.value === this.options[0].value)

package/README.md

@@ -9,19 +9,21 @@ 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.
 
+About the mock precedence, the first file in **alphabetical order** wins.
+
 
 ## Getting Started
 The best way to learn _Mockaton_ is by checking out this repo and
@@ -34,10 +36,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 +47,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 +77,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,12 +96,15 @@ 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'
+  })
 }
 ```
 
 That `jwtCookie` has a hardcoded header and signature. In other
-words, it’s useful iff you care about its payload in frontend.
+words, it’s useful iff you care about its payload in the frontend.
 
 ---
 
@@ -152,28 +155,6 @@ api/foo/?bar=[bar].GET.200.json
 api/foo/(my comment).GET.200.json
 ```
 
-
----
-## Mock Precedence
-The first file in **alphabetical order** wins when a particular route has many files.
-
-### Why do we have many mocks per Route+Method?
-Each route has mocks for many status codes, and also different
-mocks (by having comments) for testing particular scenarios.
-For example, different 422 validation error messages.
-
----
-
-## Reset the Dashboard UI after insert or delete
-When deleting the currently selected option, without refreshing the dashboard, the
-served mock will be an alternative mock if it exists. That is, the dashboard won't show
-a 404 after deleting the current mock if there’s another mock for that particular route.
-
-Similarly, inserting a file that goes first in alphabetical order will
-send a different mock from the one stated in the dashboard dropdown.
-
----
-
 ## 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.
@@ -182,15 +163,14 @@ Create a markdown file following the same filename convention.
 The status code can be any number. For example,
 ```text
 api/foo/[user-id].POST.201.md
+api/foo/[user-id].POST.201.json
 ```
 
----
-
-## Non-Deterministic Mocks (.mjs handlers)
+## Transforms (.mjs)
 Using the same filename convention, files ending
 with `.mjs` will process the mock before serving it.
 
-For example, this handler will uppercase the mock body.
+For example, this handler will capitalize the mock body and increment a counter.
 ```js
 export default function capitalizeAllText(mockAsText, requestBody, Config) {
   Config.database.myCount ??= 0
@@ -199,31 +179,21 @@ export default function capitalizeAllText(mockAsText, requestBody, Config) {
 }
 ```
 
-In demo mode, transforms tagged with the string `demo` within a filename
-comment get activated. Mock sets tags e.g. `demo-a` have no effect. In
-other words, only one transform per route is supported in demo mode.
-
 ---
 
 ## API
 
-### Changing a mock for one route
+### `/mockaton/edit` Select a mock for a route
 ```
-PATCH http://localhost:2345/mockaton/edit
+PATCH /mockaton/edit
 { 
   "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"
-}
-```
-
+### `/mockaton/bulk-select` Select all mocks that have a particular comment
 Many mocks can be changed at once. We do that by searching the
 comments on the filename. For example, `api/foo(demo-a).GET.200.json`
 
@@ -234,8 +204,44 @@ particular API there is only `demo-a` and `demo-b`, changing to
 Similarly, if there’s no demo mock at all for
 a route, the first dev mock (a-z) will be served.
 
+```
+PATCH /mockaton/bulk-select
+{
+  "comment": "demo-a"
+}
+```
+---
 
-### Reset
+### `/mockaton/reset` Reset
+Re-Initialize the collection and its states (selected mocks and cookies, delays, etc.).
 ```
-PATCH http://localhost:2345/mockaton/reset
+PATCH /mockaton/reset
+```
+---
+
+### `/mockaton/cookies` Select a cookie
+In `Config.cookies`, each key is a label used to change them.
+```
+PATCH /mockaton/cookies
+{
+  "current_cookie_key": "My Normal User"
+}
 ```
+
+### `/mockaton/cookies` List Cookies
+Sends a list of the cookie labels (keys) and
+along with a flag indicated if it’s the selected.
+```
+GET /mockaton/cookies
+```
+
+---
+
+### `/mockaton/transform` Select a Transform
+```
+PATCH /mockaton/transform
+{
+  "file": "api/video/list(concat newly uploaded).GET.200.mjs"
+}
+```
+---

package/Route.js

@@ -16,7 +16,7 @@ export class Route {
 	constructor(file) {
 		const { urlMask, method } = Route.parseFilename(file)
 		this.method = method
-		this.#urlRegex = new RegExp(`^${disregardVariables(removeQueryStringAndFragment(urlMask))}/*$`)
+		this.#urlRegex = new RegExp('^' + disregardVariables(removeQueryStringAndFragment(urlMask)) + '/*$')
 	}
 
 	urlMaskMatches(url) {

package/Tests.js

@@ -306,8 +306,6 @@ export default function (mock, reqBody, config) {
 		await request(DP.transform, {
 			method: 'PATCH',
 			body: JSON.stringify({
-				[DF.method]: 'POST',
-				[DF.urlMask]: '/api/transform',
 				[DF.file]: 'api/transform.POST.200.mjs'
 			})
 		})

package/_usage_example.js

@@ -8,8 +8,11 @@ Mockaton({
 	mocksDir: resolve('sample-mocks'),
 	staticDir: resolve('sample-static'),
 	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 Admin User': 'my-cookie=1;Path=/;SameSite=strict',
+		'My 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/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.6",
 	"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)