mockaton 13.3.5 → 13.4.0

package/www/src/assets/openapi.json

@@ -10,37 +10,97 @@
 		}
 	],
 	"paths": {
-		"/mockaton/reset": {
+		"/mockaton/state": {
+			"get": {
+				"summary": "Get complete Mockaton state",
+				"x-js-client-example": "await mockaton.getState()",
+				"responses": {
+					"200": {
+						"description": "Mockaton state",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/State"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/mockaton/write-mock": {
 			"patch": {
-				"summary": "Re-initialize Mockaton",
-				"description": "The selected mocks, cookies, and delays go back to default, but `proxyFallback`, `collectProxied`, and `corsAllowed` are not affected.",
-				"x-js-client-example": "await mockaton.reset()",
+				"summary": "Write a mock file",
+				"description": "Writes a mock file to the mocks directory. Requires `config.readOnly = false`",
+				"x-js-client-example": "await mockaton.writeMock('api/user/friends.GET.200.json', '{ \"friends\": [] }')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "array",
+								"minItems": 2,
+								"maxItems": 2,
+								"prefixItems": [
+									{
+										"$ref": "#/components/schemas/Filename"
+									},
+									{
+										"type": "string",
+										"description": "File content"
+									}
+								],
+								"additionalItems": false
+							}
+						}
+					}
+				},
 				"responses": {
 					"200": {
 						"description": "OK"
+					},
+					"403": {
+						"description": "Forbidden (read-only mode or outside mocksDir)"
 					}
 				}
 			}
 		},
-		"/mockaton/bulk-select-by-comment": {
+		"/mockaton/delete-mock": {
 			"patch": {
-				"summary": "Select all mocks that have a particular comment",
-				"x-js-client-example": "await mockaton.bulkSelectByComment('(demo-a)')",
+				"summary": "Delete a mock file",
+				"description": "Deletes a mock file from the mocks directory. Requires `config.readOnly=false`",
+				"x-js-client-example": "await mockaton.deleteMock('api/user/friends.GET.200.json')",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"type": "string",
-								"description": "Parentheses are optional, so you can pass a partial match. For example, passing `'demo-'` (without the final `a`) works too. On routes with many partial matches, their first mock in alphabetical order wins.",
-								"example": "(demo-a)"
+								"$ref": "#/components/schemas/Filename"
 							}
 						}
 					}
 				},
 				"responses": {
 					"200": {
-						"$ref": "#/components/responses/Broker"
+						"description": "OK"
+					},
+					"403": {
+						"description": "Forbidden (read-only mode or outside mocksDir)"
+					},
+					"422": {
+						"description": "Mock file does not exist"
+					}
+				}
+			}
+		},
+		"/mockaton/reset": {
+			"patch": {
+				"summary": "Re-initialize Mockaton",
+				"description": "The selected mocks, cookies, and delays go back to their defaults, but `proxyFallback`, `collectProxied`, and `corsAllowed` are not affected.",
+				"x-js-client-example": "await mockaton.reset()",
+				"responses": {
+					"200": {
+						"description": "OK"
 					}
 				}
 			}
@@ -77,57 +137,34 @@
 				}
 			}
 		},
-		"/mockaton/toggle-status": {
+		"/mockaton/bulk-select-by-comment": {
 			"patch": {
-				"summary": "Toggle a specific status for a route",
-				"description": "Selects the first found mock with the given status, which could be the autogenerated one. Or, selects the default file.",
-				"x-js-client-example": "await mockaton.toggleStatus('GET', '/api/user/friends', 500)",
+				"summary": "Select all mocks that have a particular comment",
+				"x-js-client-example": "await mockaton.bulkSelectByComment('(demo-a)')",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"type": "array",
-								"minItems": 3,
-								"maxItems": 3,
-								"prefixItems": [
-									{
-										"$ref": "#/components/schemas/Method"
-									},
-									{
-										"$ref": "#/components/schemas/UrlMask"
-									},
-									{
-										"type": "number",
-										"description": "HTTP Status to toggle",
-										"example": 500
-									}
-								],
-								"additionalItems": false
-							},
-							"example": [
-								"GET",
-								"/api/user",
-								500
-							]
+								"type": "string",
+								"description": "Parentheses are optional, so you can pass a partial match. For example, passing `'demo-'` (without the final `a`) works too. On routes with many partial matches, their first mock in alphabetical order wins.",
+								"example": "(demo-a)"
+							}
 						}
 					}
 				},
 				"responses": {
 					"200": {
 						"$ref": "#/components/responses/Broker"
-					},
-					"422": {
-						"description": "Route does not exist"
 					}
 				}
 			}
 		},
-		"/mockaton/proxied": {
+		"/mockaton/toggle-status": {
 			"patch": {
-				"summary": "Set whether a route is proxied",
-				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
-				"x-js-client-example": "await mockaton.setRouteIsProxied('GET', '/api/user/friends', true)",
+				"summary": "Toggle a specific status for a route",
+				"description": "Selects the first found mock with the given status, which could be the autogenerated one. Or, selects the default file.",
+				"x-js-client-example": "await mockaton.toggleStatus('GET', '/api/user/friends', 500)",
 				"requestBody": {
 					"required": true,
 					"content": {
@@ -144,9 +181,9 @@
 										"$ref": "#/components/schemas/UrlMask"
 									},
 									{
-										"type": "boolean",
-										"description": "proxied",
-										"example": true
+										"type": "number",
+										"description": "HTTP Status to toggle",
+										"example": 500
 									}
 								],
 								"additionalItems": false
@@ -154,7 +191,7 @@
 							"example": [
 								"GET",
 								"/api/user",
-								true
+								500
 							]
 						}
 					}
@@ -164,7 +201,7 @@
 						"$ref": "#/components/responses/Broker"
 					},
 					"422": {
-						"description": "Invalid request. Possible reasons:\n- Route does not exist\n- Expected boolean for `proxied`\n- No `proxyFallback` configured\n"
+						"description": "Route does not exist"
 					}
 				}
 			}
@@ -266,70 +303,50 @@
 				}
 			}
 		},
-		"/mockaton/cors": {
+		"/mockaton/cookies": {
 			"patch": {
-				"summary": "Enable or disable CORS",
-				"x-js-client-example": "await mockaton.setCorsAllowed(false)",
+				"summary": "Select a cookie label",
+				"x-js-client-example": "await mockaton.selectCookie('Normal User')",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"type": "boolean",
-								"description": "Is enabled?"
+								"type": "string",
+								"description": "Cookie key",
+								"example": "Normal User"
 							}
 						}
 					}
 				},
 				"responses": {
 					"200": {
-						"description": "OK"
-					},
-					"422": {
-						"description": "Expected boolean"
-					}
-				}
-			}
-		},
-		"/mockaton/fallback": {
-			"patch": {
-				"summary": "Set proxy fallback address",
-				"x-js-client-example": "await mockaton.setProxyFallback('http://example.test')",
-				"requestBody": {
-					"required": true,
-					"content": {
-						"application/json": {
-							"schema": {
-								"type": "string",
-								"description": "URL",
-								"example": "https://example.test"
+						"description": "Available cookie labels",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CookieSelectionList"
+								}
 							}
 						}
-					}
-				},
-				"responses": {
-					"200": {
-						"description": "OK"
 					},
 					"422": {
-						"description": "Invalid Proxy Fallback URL"
+						"description": "Cookie key not found"
 					}
 				}
 			}
 		},
-		"/mockaton/collect-proxied": {
+		"/mockaton/cors": {
 			"patch": {
-				"summary": "Enable or disable collection of proxied responses",
-				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
-				"x-js-client-example": "await mockaton.setCollectProxied(true)",
+				"summary": "Enable or disable CORS",
+				"x-js-client-example": "await mockaton.setCorsAllowed(false)",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
 								"type": "boolean",
-								"description": "Should Collect?",
-								"example": true
+								"description": "Is enabled?"
 							}
 						}
 					}
@@ -344,51 +361,45 @@
 				}
 			}
 		},
-		"/mockaton/cookies": {
+		"/mockaton/fallback": {
 			"patch": {
-				"summary": "Select a cookie label",
-				"x-js-client-example": "await mockaton.selectCookie('Normal User')",
+				"summary": "Set proxy fallback address",
+				"x-js-client-example": "await mockaton.setProxyFallback('http://example.test')",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
 								"type": "string",
-								"description": "Cookie key",
-								"example": "Normal User"
+								"description": "URL",
+								"example": "https://example.test"
 							}
 						}
 					}
 				},
 				"responses": {
 					"200": {
-						"description": "Available cookie labels",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/CookieSelectionList"
-								}
-							}
-						}
+						"description": "OK"
 					},
 					"422": {
-						"description": "Cookie key not found"
+						"description": "Invalid Proxy Fallback URL"
 					}
 				}
 			}
 		},
-		"/mockaton/watch-mocks": {
+		"/mockaton/collect-proxied": {
 			"patch": {
-				"summary": "Enable or disable mock file watching",
-				"description": "Controls file watchers for mocksDir.",
-				"x-js-client-example": "await mockaton.setWatchMocks(true)",
+				"summary": "Enable or disable collection of proxied responses",
+				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
+				"x-js-client-example": "await mockaton.setCollectProxied(true)",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
 								"type": "boolean",
-								"description": "true to start watchers, false to stop them"
+								"description": "Should Collect?",
+								"example": true
 							}
 						}
 					}
@@ -398,59 +409,69 @@
 						"description": "OK"
 					},
 					"422": {
-						"description": "Invalid input - expected boolean"
+						"description": "Expected boolean"
 					}
 				}
 			}
 		},
-		"/mockaton/write-mock": {
+		"/mockaton/proxied": {
 			"patch": {
-				"summary": "Write a mock file",
-				"description": "Writes a mock file to the mocks directory. Guarded by `readOnly` and `mocksDir`.",
-				"x-js-client-example": "await mockaton.writeMock('api/user/friends.GET.200.json', '{ \"friends\": [] }')",
+				"summary": "Set whether a route is proxied",
+				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
+				"x-js-client-example": "await mockaton.setRouteIsProxied('GET', '/api/user/friends', true)",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
 								"type": "array",
-								"minItems": 2,
-								"maxItems": 2,
+								"minItems": 3,
+								"maxItems": 3,
 								"prefixItems": [
 									{
-										"$ref": "#/components/schemas/Filename"
+										"$ref": "#/components/schemas/Method"
 									},
 									{
-										"type": "string",
-										"description": "File content"
+										"$ref": "#/components/schemas/UrlMask"
+									},
+									{
+										"type": "boolean",
+										"description": "proxied",
+										"example": true
 									}
 								],
 								"additionalItems": false
-							}
+							},
+							"example": [
+								"GET",
+								"/api/user",
+								true
+							]
 						}
 					}
 				},
 				"responses": {
 					"200": {
-						"description": "OK"
+						"$ref": "#/components/responses/Broker"
 					},
-					"403": {
-						"description": "Forbidden (read-only mode or outside mocksDir)"
+					"422": {
+						"description": "Invalid request. Possible reasons:\n- Route does not exist\n- Expected boolean for `proxied`\n- No `proxyFallback` configured\n"
 					}
 				}
 			}
 		},
-		"/mockaton/delete-mock": {
+		"/mockaton/watch-mocks": {
 			"patch": {
-				"summary": "Delete a mock file",
-				"description": "Deletes a mock file from the mocks directory. Guarded by `readOnly` and `mocksDir`.",
-				"x-js-client-example": "await mockaton.deleteMock('api/user/friends.GET.200.json')",
+				"summary": "Enable or disable mock file watching",
+				"description": "Controls file watchers for mocksDir.",
+				"x-js-client-example": "await mockaton.setWatchMocks(true)",
 				"requestBody": {
 					"required": true,
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/Filename"
+								"type": "boolean",
+								"description": "true to start watchers, false to stop them"
 							}
 						}
 					}
@@ -459,29 +480,8 @@
 					"200": {
 						"description": "OK"
 					},
-					"403": {
-						"description": "Forbidden (read-only mode or outside mocksDir)"
-					},
 					"422": {
-						"description": "Mock file does not exist"
-					}
-				}
-			}
-		},
-		"/mockaton/state": {
-			"get": {
-				"summary": "Get complete Mockaton state",
-				"x-js-client-example": "await mockaton.getState()",
-				"responses": {
-					"200": {
-						"description": "Mockaton state",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/State"
-								}
-							}
-						}
+						"description": "Invalid input - expected boolean"
 					}
 				}
 			}

package/src/client/dom-utils.js

@@ -1,154 +0,0 @@
-export function t(translation) {
-	return translation[0]
-}
-
-export function classNames(...args) {
-	return args.filter(Boolean).join(' ')
-}
-
-export function createElement(tag, props, ...children) {
-	const elem = document.createElement(tag)
-	if (props)
-		for (const [k, v] of Object.entries(props))
-			if (v === undefined) continue
-			else if (k === 'ref') v.elem = elem
-			else if (k === 'style') Object.assign(elem.style, v)
-			else if (k.startsWith('on')) elem.addEventListener(k.slice(2).toLowerCase(), ...[v].flat())
-			else if (k in elem) elem[k] = v
-			else elem.setAttribute(k, v)
-	elem.append(...children.flat().filter(Boolean))
-	return elem
-}
-
-export function createSvgElement(tag, props, ...children) {
-	const elem = document.createElementNS('http://www.w3.org/2000/svg', tag)
-	for (const [k, v] of Object.entries(props))
-		elem.setAttribute(k, v)
-	elem.append(...children.flat().filter(Boolean))
-	return elem
-}
-
-export function Fragment(...args) {
-	const frag = new DocumentFragment()
-	for (const arg of args)
-		if (Array.isArray(arg))
-			frag.append(...arg)
-		else
-			frag.appendChild(arg)
-	return frag
-}
-
-
-export function restoreFocus(cb) {
-	const focusQuery = selectorFor(document.activeElement)
-	cb()
-	if (focusQuery)
-		document.querySelector(focusQuery)?.focus()
-}
-
-function selectorFor(elem) {
-	if (!(elem instanceof Element))
-		return
-	const path = []
-	while (elem) {
-		let qualifier = ''
-		if (elem.hasAttribute('key'))
-			qualifier = `[key="${elem.getAttribute('key')}"]`
-		else {
-			let i = 0
-			let sib = elem
-			while ((sib = sib.previousElementSibling))
-				if (sib.tagName === elem.tagName)
-					i++
-			if (i)
-				qualifier = `:nth-of-type(${i + 1})`
-		}
-		path.push(elem.tagName + qualifier)
-		elem = elem.parentElement
-	}
-	return path.reverse().join('>')
-}
-
-
-export function extractClassNames({ cssRules }) {
-	// Class names must begin with _ or a letter, then it can have numbers and hyphens
-	// TODO think about tag.className selectors
-	const reClassName = /(?:^|[\s,{>])&?\s*\.([a-zA-Z_][\w-]*)/g
-	const cNames = {}
-	let match
-	for (const rule of cssRules)
-		while (match = reClassName.exec(rule.cssText))
-			cNames[match[1]] = match[1]
-	return cNames
-}
-
-
-export class QueryParamBool {
-	constructor(param) {
-		this.param = param
-		this.value = this.#init()
-	}
-
-	#init() {
-		const qs = new URLSearchParams(globalThis.location?.search)
-		if (qs.has(this.param))
-			return qs.get(this.param) !== '0'
-		const stored = globalThis.localStorage?.getItem(this.param) !== '0'
-		if (!stored)
-			this.#applyToUrl(false)
-		return stored
-	}
-
-	toggle() {
-		this.value = !this.value
-		if (this.value)
-			globalThis.localStorage?.removeItem(this.param)
-		else
-			globalThis.localStorage?.setItem(this.param, '0')
-		this.#applyToUrl(this.value)
-	}
-
-	#applyToUrl(nextVal) {
-		const url = new URL(globalThis.location?.href)
-		if (nextVal)
-			url.searchParams.delete(this.param)
-		else
-			url.searchParams.set(this.param, '0')
-		history.replaceState(null, '', url)
-	}
-}
-
-
-export class LocalStorageSet {
-	constructor(key) {
-		this.key = key
-		this.value = this.#parse()
-	}
-
-	add(item) {
-		this.value.add(item)
-		this.#persist()
-	}
-
-	delete(item) {
-		this.value.delete(item)
-		this.#persist()
-	}
-
-	has(item) {
-		return this.value.has(item)
-	}
-
-	#parse() {
-		try {
-			return new Set(JSON.parse(globalThis.localStorage?.getItem(this.key) || '[]'))
-		}
-		catch {
-			return new Set()
-		}
-	}
-
-	#persist() {
-		globalThis.localStorage?.setItem(this.key, JSON.stringify([...this.value]))
-	}
-}

package/src/client/watcherDev.js

@@ -1,39 +0,0 @@
-import { API } from './ApiConstants.js'
-
-
-let conn = null
-let timer = null
-
-window.addEventListener('beforeunload', teardown)
-connect()
-function connect() {
-	if (conn) return
-
-	clearTimeout(timer)
-	conn = new EventSource(API.watchHotReload)
-
-	conn.onmessage = function (event) {
-		const file = event.data
-		if (file.endsWith('.css'))
-			hotReloadCSS(file)
-		else if (file)
-			location.reload()
-	}
-
-	conn.onerror = function () {
-		console.error('hot reload')
-		teardown()
-		timer = setTimeout(connect, 3000)
-	}
-}
-
-function teardown() {
-	clearTimeout(timer)
-	conn?.close()
-	conn = null
-}
-
-async function hotReloadCSS(file) {
-	const mod = await import(`./${file}?${Date.now()}`, { with: { type: 'css' } })
-	document.adoptedStyleSheets = [mod.default]
-}