mockaton 7.8.0 → 8.0.0

package/README.md

@@ -274,21 +274,20 @@ Config.extraMimes = {
 }
 ```
 
-### `plugins?: { [fileEnding: string]: Plugin }`
+### `plugins?: [filenameTester: RegExp, plugin: Plugin][]
 ```ts
 type Plugin = (
   filePath: string,
   request: IncomingMessage,
   response: OutgoingMessage
-) => {
+) => Promise<{
   mime: string,
   body: string | Uint8Array
-}
+}>
 ```
-Plugins are for processing mocks before sending them. The key is the ending
-of a filename. In other words, it’s not limited to the file extension.
+Plugins are for processing mocks before sending them.
 
-Node’s `request` and `response` are included but don’t call `response.end()`
+Note: don’t call `response.end()`
 
 
 #### Plugin Examples
@@ -296,30 +295,29 @@ Node’s `request` and `response` are included but don’t call `response.end()`
 npm install yaml
 ```
 ```js
-import { readFileSync as read } from 'node:js'
 import { parse } from 'yaml'
+import { readFileSync } from 'node:js'
 import { jsToJsonPlugin } from 'mockaton'
 
 
-Config.plugins = {
-  '.yaml': function yamlToJsonPlugin(filePath) {
-    return {
-      mime: 'application/json',
-      body: JSON.stringify(parse(read(filePath, 'utf8')))
-    }
-  },
-
-  // e.g. GET /api/foo would be capitalized
-  'foo.GET.200.txt': function capitalizePlugin(filePath) {
-    return {
-      mime: 'application/text',
-      body: read(filePath, 'utf8').toUpperCase()
-    }
-  },
-
-  // Default Plugins
-  '.js': jsToJsonPlugin,
-  '.ts': jsToJsonPlugin // yes, it’s reused
+Config.plugins = [
+  [/\.(js|ts)$/, jsToJsonPlugin], // Default 
+  [/\.yaml$/, yamlToJsonPlugin],
+  [/foo\.GET\.200\.txt$/, capitalizePlugin], // e.g. GET /api/foo would be capitalized
+]
+
+function yamlToJsonPlugin(filePath) {
+  return {
+    mime: 'application/json',
+    body: JSON.stringify(parse(readFileSync(filePath, 'utf8')))
+  }
+}
+
+function capitalizePlugin(filePath) {
+  return {
+    mime: 'application/text',
+    body: readFileSync(filePath, 'utf8').toUpperCase()
+  }
 }
 ```
 
@@ -338,8 +336,8 @@ Config.corsExposedHeaders = [] // headers you need to access in client-side JS
 ```
 
 ### `onReady?: (dashboardUrl: string) => void`
-This is a callback `(dashboardAddress: string) => void`, which defaults to
-trying to open the dashboard in your default browser in macOS and Windows.
+This defaults to trying to open the dashboard
+in your default browser in macOS and Windows.
 
 If you don’t want to open a browser, pass a noop, such as
 ```js

package/index.d.ts

@@ -4,10 +4,10 @@ type Plugin = (
 	filePath: string,
 	request: IncomingMessage,
 	response: OutgoingMessage
-) => {
+) => Promise<{
 	mime: string,
 	body: string | Uint8Array
-}
+}>
 
 interface Config {
 	mocksDir: string
@@ -24,7 +24,7 @@ interface Config {
 	extraHeaders?: string[]
 	extraMimes?: { [fileExt: string]: string }
 
-	plugins?: { [fileExt: string]: Plugin }
+	plugins?: [filenameTester: RegExp, plugin: Plugin][]
 
 	corsAllowed?: boolean,
 	corsOrigins: string[]

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "7.8.0",
+	"version": "8.0.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
@@ -11,8 +11,5 @@
 		"test": "node --test",
 		"demo": "node _usage_example.js",
 		"demo:ts": "node --import=tsx _usage_example.js"
-	},
-	"optionalDependencies": {
-		"tsx": "4.19.1"
 	}
 }

package/src/Config.js

@@ -1,5 +1,6 @@
 import { isDirectory } from './utils/fs.js'
 import { openInBrowser } from './utils/openInBrowser.js'
+import { jsToJsonPlugin } from './MockDispatcherPlugins.js'
 import { StandardMethods } from './utils/http-request.js'
 import { validate, is, optional } from './utils/validate.js'
 
@@ -19,7 +20,9 @@ export const Config = Object.seal({
 	extraHeaders: [],
 	extraMimes: {},
 
-	plugins: {},
+	plugins: [
+		[/\.(js|ts)$/, jsToJsonPlugin]
+	],
 
 	corsAllowed: false,
 	corsOrigins: ['*'],
@@ -50,7 +53,7 @@ export function setup(options) {
 		extraHeaders: val => Array.isArray(val) && val.length % 2 === 0,
 		extraMimes: is(Object),
 
-		plugins: is(Object),
+		plugins: Array.isArray,
 
 		corsAllowed: is(Boolean),
 		corsOrigins: validateCorsAllowedOrigins,

package/src/MockDispatcherPlugins.js

@@ -3,14 +3,9 @@ import { mimeFor } from './utils/mime.js'
 import { Config } from './Config.js'
 
 
-const plugins = {
-	'.js': jsToJsonPlugin,
-	'.ts': jsToJsonPlugin
-}
-
 export async function preprocessPlugins(filePath, req, response) {
-	for (const [ext, plugin] of Object.entries({ ...plugins, ...Config.plugins }))
-		if (filePath.endsWith(ext))
+	for (const [regex, plugin] of Config.plugins) // TESTME capitalizePlugin
+		if (regex.test(filePath))
 			return await plugin(filePath, req, response)
 	return defaultPlugin(filePath)
 }