mockaton 8.2.1 → 8.2.3

package/README.md

@@ -127,24 +127,20 @@ database, or pull data from a backend.
 Don’t call `response.end()`, just return a `string | Buffer | Uint8Array`.
 
 ```js
-
-export default function optionalName(request, response) {
+export default function requestCounter(request, response) {
   globalThis.myDatabase ??= { count: 0 }
   globalThis.myDatabase.count++
-
-  // Optinally, you can override these two:
-  repsonse.statusCode = 200
-  response.setHeader('Content-Type', 'application/json')
-
-  return JSON.stringify({ a: 1 })
+  return JSON.stringify({
+    count: globalThis.myDatabase.count
+  })
 }
 ```
 
 If you need to serve a static `.js` file, put it in your
 `Config.staticDir` without the mock filename convention.
 
-This example will echo back the request body concatenated with another fixture.
 ```js
+// This example will echo the request body concatenated with another fixture.
 // api/color.POST.201.js
 
 import colors from './colors.json' with { type: 'json' }

package/package.json

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

package/.editorconfig

@@ -1,11 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = tab
-insert_final_newline = true
-
-[*.md]
-indent_style = space

package/sample-mocks/api/user/edit-name.PATCH.200.json

@@ -1,3 +0,0 @@
-{
-	"renamed": "OK"
-}

package/sample-mocks/api/user/edit-name.PATCH.422.json

@@ -1,3 +0,0 @@
-{
-	"msg": "Validation Error"
-}

package/sample-mocks/api/user/friends.GET.200.json

@@ -1,3 +0,0 @@
-{
-	"_": "This is an exact path (i.e. /api/user/friends)"
-}

package/sample-mocks/api/user/friends.GET.204.json

@@ -1,4 +0,0 @@
-{
-	"_": "An example response of a user without friends. Uses HTTP Status: 204 - No Content",
-	"friends": []
-}

package/sample-mocks/api/user/friends.GET.500.txt

@@ -1,7 +0,0 @@
-This is a plain text response for (/api/friends). 
-
-In this case, it’s for mocking up a 500 - Internal Server Error.
-
-This file could have been empty, or some JSON if it had a `.json` extension.
-
-By the way, on initialization an 500 is auto-generated for routes that don’t have a 500.

package/sample-mocks/api/user/likes.GET.200.js

@@ -1,9 +0,0 @@
-// You can write JSON responses in JavaScript. 
-// You can export an: Object, Array, or String
-
-export default [
-	{ id: 0 },
-	{ id: 1 },
-	{ id: 2 },
-]
-

package/sample-mocks/api/user/links.GET.200.js

@@ -1,9 +0,0 @@
-// You can write JSON responses in JavaScript as a function.
-// Must return a String and they should NOT call `response.end()`
-
-export default function (req, response) {
-	return JSON.stringify([
-		'http://example.com/foo',
-		'http://example.com/bar'
-	], null, 2)
-}

package/sample-mocks/api/user/logout.POST.200.json

@@ -1 +0,0 @@
-""

package/sample-mocks/api/user/typescript-scores-full.GET.200.ts

@@ -1,9 +0,0 @@
-import scores from './typescript-scores.GET.200'
-
-export default [
-	...scores,
-	{ id: 103 },
-	{ id: 104 },
-	{ id: 105 },
-]
-

package/sample-mocks/api/user/typescript-scores.GET.200.ts

@@ -1,6 +0,0 @@
-export default [
-	{ id: 100 },
-	{ id: 101 },
-	{ id: 102 },
-]
-

package/sample-mocks/api/user/videos(all variants).GET.200.json

@@ -1,13 +0,0 @@
-{
-	"_": "This file has a comment: `(assorted)`. i.e. the route is /api/user/videos",
-	"videos": [
-		{
-			"url": "https://example.com/1",
-			"verified": true
-		},
-		{
-			"url": "https://example.com/2",
-			"verified": false
-		}
-	]
-}

package/sample-mocks/api/user/videos(default).GET.200.json

@@ -1,13 +0,0 @@
-{
-	"_": "This file has a comment: `(default)`. Which makes the file with comment: (all variants) not to win",
-	"videos": [
-		{
-			"url": "https://example.com/1",
-			"verified": false
-		},
-		{
-			"url": "https://example.com/2",
-			"verified": false
-		}
-	]
-}

package/sample-mocks/api/user/videos(verified)(another comment).GET.200.json

@@ -1,13 +0,0 @@
-{
-	"_": "This file has two comments: `(entirely verified)` and `(another comment)`. i.e. the route is /api/user/videos",
-	"videos": [
-		{
-			"url": "https://example.com/1",
-			"verified": true
-		},
-		{
-			"url": "https://example.com/2",
-			"verified": true
-		}
-	]
-}

package/sample-mocks/api/user/yaml-fruits.GET.200.yml

@@ -1,5 +0,0 @@
-fruits:
-  apple
-  banana
-  orange
-  

package/sample-mocks/api/user.GET.200.json

@@ -1,4 +0,0 @@
-{
-	"_": "This mock is for /api/user",
-	"name": "John"
-}

package/sample-mocks/api/video/[id].GET.200.json

@@ -1,4 +0,0 @@
-{
-	"_": "This route has a dynamic param `<id>`. i.e. /api/video/123",
-	"url": "https://example.com/123"
-}

package/sample-mocks/api/video/stat/[stat-id]/[video-id].GET.200.json

@@ -1,3 +0,0 @@
-{
-	"_": "Two Dynamic Params. i.e. /api/video/stat/VIEWS/123"
-}

package/sample-mocks/api/video/stat/[stat-id]/all-videos?limit=[limit].GET.200.json

@@ -1,4 +0,0 @@
-{
-	"_": "Example filename with a query string. BTW, it doesn't work on Windows, because '?' is an illegal character. At any rate, the full query string is ignored.",
-	"data": []
-}

package/sample-static/another-entry/index.html

@@ -1,35 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-	<meta charset="UTF-8">
-	<meta content="width=device-width" name="viewport">
-	<link rel="icon" href="data:">
-	<title>Another Entry Point</title>
-</head>
-<body>
-<h1>Another Entry Point</h1>
-
-<h2>/api/user</h2>
-<pre></pre>
-<script>
-	(async () => {
-		let output = ''
-		try {
-			const response = await fetch('/api/user')
-			if (response.ok) {
-				const json = await response.json()
-				output = JSON.stringify(json, null, 2)
-			}
-			else
-				throw response.status
-		}
-		catch (error) {
-			output = 'Error: ' + error
-		}
-		finally {
-			document.querySelector('pre').innerText = output
-		}
-	})()
-</script>
-</body>
-</html>

package/sample-static/index.html

@@ -1,37 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-	<meta charset="UTF-8">
-	<meta content="width=device-width" name="viewport">
-	<link rel="icon" href="data:">
-	<title>Title</title>
-</head>
-<body>
-<h1>Welcome!</h1>
-<video src="assets/video.mp4" width="720" controls></video>
-
-<h2>/api/user</h2>
-<pre></pre>
-
-<script>
-	(async () => {
-		let output = ''
-		try {
-			const response = await fetch('/api/user')
-			if (response.ok) {
-				const json = await response.json()
-				output = JSON.stringify(json, null, 2)
-			}
-			else
-				throw response.status
-		}
-		catch (error) {
-			output = 'Error: ' + error
-		}
-		finally {
-			document.querySelector('pre').innerText = output
-		}
-	})()
-</script>
-</body>
-</html>

package/ui-tests/_setup.js

@@ -1,37 +0,0 @@
-import { after } from 'node:test'
-import { launch } from 'puppeteer'
-import {
-	removeDiffsAndCandidates,
-	testPixels as _testPixels,
-	diffServer
-} from 'pixaton'
-import { Commander } from '../index.js'
-
-// Before running these tests you need to spin up the demo:
-//   npm run demo
-
-const MOCKATON_ADDR = 'http://localhost:2345'
-const mockaton = new Commander(MOCKATON_ADDR)
-
-const testsDir = import.meta.dirname
-
-removeDiffsAndCandidates(testsDir)
-const browser = await launch({ headless: true })
-const page = await browser.newPage()
-
-after(() => {
-	browser?.close()
-	diffServer(testsDir)
-})
-
-export function testPixels(testFileName, options = {}) {
-	options.beforeSuite = async () => await mockaton.reset()
-	options.viewports ??= [{
-		width: 1024,
-		height: 800,
-		deviceScaleFactor: 1.5 // for better screenshots
-	}]
-	options.colorSchemes ??= ['light', 'dark']
-	options.screenshotOptions ??= {}
-	_testPixels(page, testFileName, MOCKATON_ADDR + '/mockaton', 'body', options)
-}

package/ui-tests/bulk-select.test.js

@@ -1,10 +0,0 @@
-import { testPixels } from './_setup.js'
-
-
-testPixels(import.meta.filename, {
-	async setup(page) {
-		const qaId = 'BulkSelector'
-		const target = '(Mockaton 500)'
-		await page.select(`select[data-qaid="${qaId}"]`, target)
-	}
-})

package/ui-tests/initial-dashboard-state.test.js

@@ -1,4 +0,0 @@
-import { testPixels } from './_setup.js'
-
-
-testPixels(import.meta.filename)

package/ui-tests/payload-viewer-formats-json.test.js

@@ -1,9 +0,0 @@
-import { testPixels } from './_setup.js'
-
-
-testPixels(import.meta.filename, {
-	async setup(page) {
-		const linkText = '/api/user'
-		await page.locator(`a ::-p-text(${linkText})`).click()
-	}
-})

package/ui-tests/payload-viewer-renders-images.test.js

@@ -1,9 +0,0 @@
-import { testPixels } from './_setup.js'
-
-
-testPixels(import.meta.filename, {
-	async setup(page) {
-		const linkText = '/api/user/avatar'
-		await page.locator(`a ::-p-text(${linkText})`).click()
-	}
-})

package/ui-tests/select-mock-variant.test.js

@@ -1,10 +0,0 @@
-import { testPixels } from './_setup.js'
-
-
-testPixels(import.meta.filename, {
-	async setup(page) {
-		const qaId = '/api/user/friends'
-		const target = 'api/user/friends.GET.204.json'
-		await page.select(`select[data-qaid="${qaId}"]`, target)
-	}
-})