mockaton 6.0.0 → 6.3.0

package/README.md

@@ -48,10 +48,11 @@ interface Config {
   host?: string, // defaults to 'localhost'
   port?: number // defaults to 0, which means auto-assigned
   delay?: number // defaults to 1200 (ms)
+  ignore?: RegExp // defaults to /(.DS_Store|~)$/
   onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
   cookies?: object
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-  allowedExt?: RegExp // /\.(json|js|txt)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+  extraMimes?: object
   extraHeaders?: []
 }
 ```
@@ -116,10 +117,6 @@ The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 ### Extension
 `.Method.ResponseStatusCode.FileExt`
 
-The **file extension** can be anything, but `.md` is reserved for documentation.
-
-The `Config.allowedExt` regex defaults to: `/\.(md|json|txt|js)$/`
-
 
 ### Dynamic Parameters
 Anything within square brackets. For example:
@@ -132,7 +129,7 @@ Comments are anything within parentheses, including them.
 They are ignored for URL purposes, so they have no effect
 on the URL mask. For example, these two are for `/api/foo`
 <pre>
-api/foo<b>(my comment)</b>.GET.200.json<b>(bar)</b>
+api/foo<b>(my comment)</b>.GET.200.json
 api/foo.GET.200.json
 </pre>
 
@@ -150,6 +147,9 @@ but since that’s part of the query string, it’s ignored anyway.
 
 
 ### Default (index-like) route
+For instance, let's say you have `api/foo/bar`, and
+`api/foo`. For the latter you have two options:
+
 **Option A.** Place it outside the directory:
 ```
 api/foo/
@@ -199,6 +199,13 @@ Config.extraHeaders = [
 ]
 ```
 
+## `Config.extraMimes`
+```js
+Config.extraMimes = {
+  jpg: 'application/jpeg'
+}
+```
+
 ---
 
 ## API

package/Tests.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-default-type=module
 
 import { tmpdir } from 'node:os'
 import { dirname } from 'node:path'
@@ -9,13 +9,20 @@ import { equal, deepEqual, match } from 'node:assert/strict'
 import { writeFileSync, mkdtempSync, mkdirSync } from 'node:fs'
 
 import { Route } from './src/Route.js'
-import { mimeFor } from './src/utils/mime.js'
+import { mimeFor } from './src/mime.js'
 import { Mockaton } from './src/Mockaton.js'
 import { API, DF, DEFAULT_500_COMMENT } from './src/ApiConstants.js'
 
 
 const tmpDir = mkdtempSync(tmpdir()) + '/'
 const staticTmpDir = mkdtempSync(tmpdir()) + '/'
+
+const fixtureCustomMime = [
+	'/api/custom-mime',
+	'api/custom-mime.GET.200.my_custom_extension',
+	'Custom Extension and MIME'
+]
+
 const fixtures = [
 	[
 		'/api',
@@ -87,7 +94,8 @@ const fixtures = [
 		'/api/company-e/1234/?limit=4',
 		'api/company-e/[id]?limit=[limit].GET.200.json',
 		'with pretty-param and query-params'
-	]
+	],
+	fixtureCustomMime
 ]
 for (const [, file, body] of fixtures)
 	write(file, file.endsWith('.json') ? JSON.stringify(body) : body)
@@ -95,6 +103,7 @@ for (const [, file, body] of fixtures)
 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 }))
+write('api/ignored.GET.200.json~', '')
 
 // JavaScript to JSON
 write('/api/object.GET.200.js', 'export default { JSON_FROM_JS: true }')
@@ -111,7 +120,10 @@ const server = Mockaton({
 		userA: 'CookieA',
 		userB: 'CookieB'
 	},
-	extraHeaders: ['Server', 'MockatonTester']
+	extraHeaders: ['Server', 'MockatonTester'],
+	extraMimes: {
+		my_custom_extension: 'my_custom_mime'
+	}
 })
 server.on('listening', runTests)
 
@@ -161,6 +173,7 @@ async function runTests() {
 		await testMockDispatching(url, file, body)
 
 	await testMockDispatching('/api/object', 'api/object.GET.200.js', { JSON_FROM_JS: true }, mimeFor('.json'))
+	await testMockDispatching(...fixtureCustomMime, 'my_custom_mime')
 	await testJsFunctionMocks()
 
 	await testItUpdatesUserRole()
@@ -190,6 +203,10 @@ async function test404() {
 		const res = await request('/api/non-existing-too', { method: 'DELETE' })
 		equal(res.status, 404)
 	})
+	await it('Ignores files ending in ~ by default, e.g. JetBrains temp files', async () => {
+		const res = await request('/api/ignored')
+		equal(res.status, 404)
+	})
 }
 
 async function testMockDispatching(url, file, expectedBody, forcedMime = void 0) {
@@ -354,7 +371,6 @@ async function testInvalidFilenamesAreIgnored() {
 		const consoleErrorSpy = t.mock.method(console, 'error')
 		consoleErrorSpy.mock.mockImplementation(() => {}) // so they don’t render in the test report
 
-		// An extension is needed for testing because of `Config.allowedExt`
 		write('api/_INVALID_FILENAME_CONVENTION_.json', '')
 		write('api/bad-filename.GET._INVALID_STATUS_.json', '')
 		write('api/bad-filename._INVALID_METHOD_.200.json', '')

package/index.d.ts

@@ -5,12 +5,13 @@ interface Config {
 	staticDir?: string
 	host?: string,
 	port?: number
+	ignore?: RegExp
 	delay?: number
 	onReady?: (address: string) => void
 	cookies?: object
 	proxyFallback?: string
-	allowedExt?: RegExp
-	extraHeaders?: [string, string][] 
+	extraHeaders?: [string, string][]
+	extraMimes?: object
 }
 
 export function Mockaton(options: Config): Server

package/package.json

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

package/src/Config.js

@@ -8,12 +8,13 @@ export const Config = {
 	staticDir: '',
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
+	ignore: /(\.DS_Store|~)$/,
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
 	onReady: openInBrowser,
 	proxyFallback: '', // e.g. http://localhost:9999
-	allowedExt: /\.(json|js|txt)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
-	extraHeaders: []
+	extraHeaders: [],
+	extraMimes: {}
 }
 
 export function setup(options) {
@@ -23,12 +24,13 @@ export function setup(options) {
 		staticDir: optional(isDirectory),
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
+		ignore: is(RegExp),
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),
 		onReady: is(Function),
 		proxyFallback: optional(URL.canParse),
-		allowedExt: is(RegExp),
-		extraHeaders: Array.isArray
+		extraHeaders: Array.isArray,
+		extraMimes: is(Object)
 	})
 }
 

package/src/MockBroker.js

@@ -18,7 +18,6 @@ export class MockBroker {
 			file: '',
 			delay: 0
 		}
-
 		this.register(file)
 	}
 

package/src/MockDispatcher.js

@@ -4,7 +4,7 @@ import { readFileSync } from 'node:fs'
 import { proxy } from './ProxyRelay.js'
 import { cookie } from './cookie.js'
 import { Config } from './Config.js'
-import { mimeFor } from './utils/mime.js'
+import { mimeFor } from './mime.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 import { JsonBodyParserError } from './utils/http-request.js'
 import { sendInternalServerError, sendNotFound, sendBadRequest } from './utils/http-response.js'
@@ -59,7 +59,7 @@ async function jsMockText(file, req, response) {
 }
 
 function readMock(file) {
-	return readFileSync(join(Config.mocksDir, file), 'utf8')
+	return readFileSync(join(Config.mocksDir, file))
 }
 
 async function importDefault(file) {

package/src/mime.js

@@ -0,0 +1,93 @@
+import { Config } from './Config.js'
+
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
+// m = {}; 
+// for (const row of tbody.children)
+//   m[row.children[0].querySelector('code').innerText] = row.children[2].querySelector('code').innerText
+const mimes = {
+	'3g2': 'video/3gpp2',
+	'3gp': 'video/3gpp',
+	'7z': 'application/x-7z-compressed',
+	aac: 'audio/aac',
+	abw: 'application/x-abiword',
+	apng: 'image/apng',
+	arc: 'application/x-freearc',
+	avi: 'video/x-msvideo',
+	avif: 'image/avif',
+	azw: 'application/vnd.amazon.ebook',
+	bin: 'application/octet-stream',
+	bmp: 'image/bmp',
+	bz2: 'application/x-bzip2',
+	bz: 'application/x-bzip',
+	cda: 'application/x-cdf',
+	cjs: 'text/javascript',
+	csh: 'application/x-csh',
+	css: 'text/css',
+	csv: 'text/csv',
+	doc: 'application/msword',
+	docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+	eot: 'application/vnd.ms-fontobject',
+	epub: 'application/epub+zip',
+	gif: 'image/gif',
+	gz: 'application/gzip',
+	htm: 'text/html',
+	html: 'text/html',
+	ico: 'image/vnd.microsoft.icon',
+	ics: 'text/calendar',
+	jar: 'application/java-archive',
+	jpeg: 'image/jpeg',
+	jpg: 'image/jpeg',
+	js: 'text/javascript',
+	json: 'application/json',
+	jsonld: 'application/ld+json',
+	mid: 'audio/midi',
+	midi: 'audio/midi',
+	mjs: 'text/javascript',
+	mp3: 'audio/mpeg',
+	mp4: 'video/mp4',
+	mpeg: 'video/mpeg',
+	mpkg: 'application/vnd.apple.installer+xml',
+	odp: 'application/vnd.oasis.opendocument.presentation',
+	ods: 'application/vnd.oasis.opendocument.spreadsheet',
+	odt: 'application/vnd.oasis.opendocument.text',
+	oga: 'audio/ogg',
+	ogv: 'video/ogg',
+	ogx: 'application/ogg',
+	opus: 'audio/ogg',
+	otf: 'font/otf',
+	pdf: 'application/pdf',
+	php: 'application/x-httpd-php',
+	png: 'image/png',
+	ppt: 'application/vnd.ms-powerpoint',
+	pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+	rar: 'application/vnd.rar',
+	rtf: 'application/rtf',
+	sh: 'application/x-sh',
+	svg: 'image/svg+xml',
+	tar: 'application/x-tar',
+	tif: 'image/tiff',
+	ts: 'video/mp2t',
+	ttf: 'font/ttf',
+	txt: 'text/plain',
+	vsd: 'application/vnd.visio',
+	wav: 'audio/wav',
+	weba: 'audio/webm',
+	webm: 'video/webm',
+	webp: 'image/webp',
+	woff2: 'font/woff2',
+	woff: 'font/woff',
+	xhtml: 'application/xhtml+xml',
+	xls: 'application/vnd.ms-excel',
+	xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+	xml: 'application/xml',
+	xul: 'application/vnd.mozilla.xul+xml',
+	zip: 'application/zip'
+}
+
+export function mimeFor(filename) {
+	const ext = filename.replace(/.*\./, '').toLowerCase()
+	const mime = Config.extraMimes[ext] || mimes[ext] || ''
+	if (!mime)
+		console.info(`Missing MIME for ${filename}`)
+	return mime
+}

package/src/mockBrokersCollection.js

@@ -25,7 +25,7 @@ export function init() {
 	cookie.init(Config.cookies)
 
 	const files = readDir(Config.mocksDir, { recursive: true })
-		.filter(f => Config.allowedExt.test(f) && isFile(join(Config.mocksDir, f)))
+		.filter(f => !Config.ignore.test(f) && isFile(join(Config.mocksDir, f)))
 		.sort()
 
 	for (const file of files) {

package/src/utils/http-response.js

@@ -1,5 +1,5 @@
 import fs from 'node:fs'
-import { mimeFor } from './mime.js'
+import { mimeFor } from '../mime.js'
 import { isFile, read } from './fs.js'
 
 

package/src/utils/mime.js

@@ -1,47 +0,0 @@
-// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
-const mimes = {
-	aac: 'audio/acc',
-	apng: 'image/apng',
-	avif: 'image/avif',
-	css: 'text/css',
-	doc: 'application/msword',
-	docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
-	eot: 'application/vnd.ms-fontobject',
-	epub: 'application/epub+zip',
-	gif: 'image/gif',
-	gz: 'application/gzip',
-	htm: 'text/html',
-	html: 'text/html',
-	ico: 'image/vnd.microsoft.icon',
-	ics: 'text/calendar',
-	jpeg: 'image/jpeg',
-	jpg: 'image/jpeg',
-	js: 'application/javascript',
-	json: 'application/json',
-	jsonld: 'application/ld+json',
-	md: 'text/markdown',
-	mjs: 'text/javascript',
-	mp3: 'audio/mpeg',
-	mp4: 'video/mp4',
-	oft: 'font/otf',
-	pdf: 'application/pdf',
-	png: 'image/png',
-	ttf: 'font/ttf',
-	txt: 'plain/text',
-	wav: 'audio/wav',
-	weba: 'audio/webm',
-	webm: 'video/webm',
-	webp: 'image/webp',
-	woff2: 'font/woff2',
-	woff: 'font/woff',
-	xml: 'application/xml',
-	zip: 'application/zip'
-}
-
-export function mimeFor(filename) {
-	const ext = filename.replace(/.*\./, '')
-	const mime = mimes[ext] || ''
-	if (!mime)
-		console.error(`Missing MIME for ${filename}`)
-	return mime
-}