mockaton 1.0.0 → 1.1.0

package/README.md

@@ -26,6 +26,17 @@ UI, or programmatically, for instance, for setting up tests.
 
 The first file in **alphabetical order** becomes the default mock.
 
+### Optionally, you can write mocks in JavaScript
+An Object, Array, or String is sent as JSON.
+
+`api/user/likes.GET.200.js`
+```js
+export default [
+  { id: 0 }
+]
+```
+
+
 ### Proxying Routes
 `Config.proxyFallback` lets you specify a target
 server for serving routes you don’t have mocks for.
@@ -78,7 +89,7 @@ interface Config {
   database?: object // for "Transforms"
   skipOpen?: boolean // Prevents opening the dashboard in a browser
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-  allowedExt?: RegExp // /\.(json|txt|md|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+  allowedExt?: RegExp // /\.(json|txt|md|js|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 ```
 

package/Tests.js

@@ -96,6 +96,9 @@ write('api/.GET.500.txt', 'keeps non-autogenerated 500')
 write('api/alternative(comment-2).GET.200.json', JSON.stringify({ comment: 2 }))
 write('api/my-route(comment-2).GET.200.json', JSON.stringify({ comment: 2 }))
 
+// JavaScript to JSON
+write('/api/object.GET.200.js', 'export default { JSON_FROM_JS: true }')
+
 writeStatic('index.html', '<h1>Static</h1>')
 writeStatic('assets/app.js', 'const app = 1')
 writeStatic('another-entry/index.html', '<h1>Another</h1>')
@@ -118,6 +121,8 @@ async function runTests() {
 	for (const [url, file, body] of fixtures)
 		await testMockDispatching(url, file, body)
 
+	await testMockDispatching('/api/object', 'api/object.GET.200.js', { JSON_FROM_JS: true }, undefined, mimeFor('.json'))
+
 	await testItUpdatesDelayAndFile(
 		'/api/alternative',
 		'api/alternative(comment-2).GET.200.json',
@@ -185,9 +190,9 @@ async function test404() {
 	})
 }
 
-async function testMockDispatching(url, file, expectedBody, reqBody = void 0) {
+async function testMockDispatching(url, file, expectedBody, reqBody = void 0, forcedMime = void 0) {
 	const { urlMask, method, status } = Route.parseFilename(file)
-	const mime = mimeFor(file)
+	const mime = forcedMime || mimeFor(file)
 	const now = new Date()
 	const res = await request(url, { method, body: reqBody })
 	const body = mime === 'application/json'

package/package.json

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

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

@@ -0,0 +1,7 @@
+// You can write JSON responses in JavaScript.
+
+export default [
+	{ id: 0 },
+	{ id: 1 },
+	{ id: 2 },
+]

package/src/Config.js

@@ -1,4 +1,4 @@
-import { existsSync, lstatSync } from 'node:fs'
+import { existsSync as exists, lstatSync } from 'node:fs'
 import { validate, is, optional } from './utils/validate.js'
 
 
@@ -12,7 +12,7 @@ export const Config = {
 	database: {},
 	skipOpen: false,
 	proxyFallback: '', // e.g. http://localhost:9999
-	allowedExt: /\.(json|txt|md|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	allowedExt: /\.(json|txt|md|js|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 
 export function setup(options) {
@@ -32,7 +32,7 @@ export function setup(options) {
 }
 
 function isDirectory(dir) {
-	return existsSync(dir) && lstatSync(dir).isDirectory()
+	return exists(dir) && lstatSync(dir).isDirectory()
 }
 
 

package/src/MockDispatcher.js

@@ -31,15 +31,19 @@ export async function dispatchMock(req, response) {
 		const { file, status, delay, currentTransform } = broker
 		console.log('\n', req.url, '→\n ', file)
 
+		const shouldJavaScriptToJSON = file.endsWith('.js')
 		response.statusCode = status
-		response.setHeader('content-type', mimeFor(file))
+		response.setHeader('content-type', mimeFor(shouldJavaScriptToJSON ? '.json' : file))
 		if (cookie.getCurrent())
 			response.setHeader('set-cookie', cookie.getCurrent())
 
-		let mockAsText = readMock(file)
+		let mockAsText = shouldJavaScriptToJSON
+			? JSON.stringify(await importDefault(file))
+			: readMock(file)
+
 		if (broker.currentTransform) {
 			const body = await requestBodyForTransform(req, mockAsText)
-			const transformFunc = await importTransformFunc(currentTransform)
+			const transformFunc = await importDefault(currentTransform)
 			mockAsText = transformFunc(mockAsText, body, Config)
 		}
 		setTimeout(() => response.end(mockAsText), delay)
@@ -69,7 +73,7 @@ function readMock(file) {
 	return readFileSync(join(Config.mocksDir, file), 'utf8')
 }
 
-async function importTransformFunc(file) {
+async function importDefault(file) {
 	// The date param is just for cache busting
 	return (await import(join(Config.mocksDir, file) + '?' + Date.now())).default
 }

package/src/mockBrokersCollection.js

@@ -34,7 +34,7 @@ export function init() {
 			continue
 		}
 		collection[method] ??= {}
-		if (!(urlMask in collection[method]))
+		if (!collection[method][urlMask])
 			collection[method][urlMask] = new MockBroker(file)
 		else
 			collection[method][urlMask].register(file)