mockaton 0.9.8 → 0.9.10

package/README.md

@@ -1,13 +1,13 @@
 # Mockaton 
 _Mockaton_ is a mock server for developing and testing frontends.
 
-It scans `Config.mocksDir` for files following a specific
-file name convention, which is similar to the URL paths. For
+It scans `Config.mocksDir` for files following a specific directory
+and file name convention, which is similar to the URL paths. For
 example, the following file will be served for `/api/user/1234`
 ```
-api/
-api/user/
-api/user/[user-id].GET.200.json
+-- api/
+   |-- user/
+       |-- [user-id].GET.200.json
 ```
 
 By the way, [this browser
@@ -63,11 +63,12 @@ npm install mockaton
 Create a `my-mockaton.js` file
 ```js
 import { resolve } from 'node:path'
-import { Mockaton } from 'mockaton'
+import { Mockaton } from 'src/Mockaton'
+
 
 Mockaton({ // Config options
-  port: 2345,
-  mocksDir: resolve('my-mocks-dir')
+	port: 2345,
+	mocksDir: resolve('my-mocks-dir')
 })
 ```
 
@@ -92,15 +93,16 @@ interface Config {
 
 ## Cookies
 ```js
-import { jwtCookie } from 'mockaton'
+import { jwtCookie } from 'src/Mockaton'
+
 
 Config.cookies = {
-  'My Admin User':  'my-cookie=1;Path=/;SameSite=strict',
-  'My Normal User': 'my-cookie=0;Path=/;SameSite=strict',
-  'My JWT': jwtCookie('my-cookie', {
-    email: 'john.doe@example.com',
-    picture: 'https://cdn.auth0.com/avatars/jd.png'
-  })
+	'My Admin User': 'my-cookie=1;Path=/;SameSite=strict',
+	'My Normal User': 'my-cookie=0;Path=/;SameSite=strict',
+	'My JWT': jwtCookie('my-cookie', {
+		email: 'john.doe@example.com',
+		picture: 'https://cdn.auth0.com/avatars/jd.png'
+	})
 }
 ```
 
@@ -122,23 +124,27 @@ The `Config.allowedExt` regex defaults to: `/\.(json|txt|md|mjs)$/`
 
 
 ### Dynamic Parameters
-Anything within square brackets. For example, `api/user/[id]/[age].GET.200.json`
+Anything within square brackets. For example, 
+<pre>
+api/user/<b>[id]</b>/<b>[age]</b>.GET.200.json
+</pre>
 
 ### Comments
-Comments are anything within parentheses, including them, and they are
-ignored for URL purposes. In other words, comments have no effect on the
-URL mask. For example, these two are for `/api/foo`
-```
-api/foo(my comment).GET.200.json(foo)
+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>(foo)</b>
 api/foo.GET.200.json
-```
+</pre>
 
 ### Query String Params
-```
-api/video?limit=[limit].GET.200.json
-```
-The query string behaves like comments in the sense it’s only used for documenting
-the URL API contract. In other words, the query string is ignored when routing to it.
+<pre>
+api/video<b>?limit=[limit]</b>.GET.200.json
+</pre>
+
+The query string is ignored when routing to it. It’s
+only used for documenting the URL API contract.
 
 BTW, in Windows, filenames containing "?" are [not
 permitted](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file),
@@ -199,7 +205,7 @@ PATCH /mockaton/edit
 ```
 PATCH /mockaton/bulk-select
 {
-  "comment": "demo-a"
+  "comment": "(demo-a)"
 }
 ```
 ---

package/Tests.js

@@ -6,10 +6,10 @@ import { describe, it } from 'node:test'
 import { equal, deepEqual, match } from 'node:assert/strict'
 import { writeFileSync, mkdtempSync, mkdirSync } from 'node:fs'
 
-import { Route } from './Route.js'
-import { mimeFor } from './utils/mime.js'
-import { DP, DF } from './ApiConstants.js'
-import { Mockaton } from './Mockaton.js'
+import { Route } from './src/Route.js'
+import { mimeFor } from './src/utils/mime.js'
+import { Mockaton } from './src/Mockaton.js'
+import { DP, DF } from './src/ApiConstants.js'
 
 
 const tmpDir = mkdtempSync(tmpdir()) + '/'

package/index.js

@@ -1,2 +1,2 @@
-export { Mockaton } from './Mockaton.js'
-export { jwtCookie } from './utils/jwt.js'
+export { Mockaton } from './src/Mockaton.js'
+export { jwtCookie } from './src/utils/jwt.js'

package/package.json

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

package/{MockDispatcher.js → src/MockDispatcher.js}

@@ -5,7 +5,7 @@ import { DF } from './ApiConstants.js'
 import { cookie } from './cookie.js'
 import { Config } from './Config.js'
 import { mimeFor } from './utils/mime.js'
-import * as MockBrokerCollection from './mockBrokersCollection.js'
+import * as mockBrokerCollection from './mockBrokersCollection.js'
 import { parseJSON, JsonBodyParserError } from './utils/http-request.js'
 import { sendInternalServerError, sendNotFound, sendFile, sendBadRequest } from './utils/http-response.js'
 
@@ -17,14 +17,14 @@ export async function dispatchMock(req, response) {
 		return
 	}
 
-	const mockBroker = MockBrokerCollection.findMatchingBroker(req.method, req.url)
-	if (!mockBroker) {
+	const broker = mockBrokerCollection.getBrokerForUrl(req.method, req.url)
+	if (!broker) {
 		sendNotFound(response)
 		return
 	}
 	
 	try {
-		const { file, status, delay, currentTransform } = mockBroker
+		const { file, status, delay, currentTransform } = broker
 		console.log('\n', req.url, '→\n ', file)
 
 		response.statusCode = status
@@ -33,7 +33,7 @@ export async function dispatchMock(req, response) {
 			response.setHeader('set-cookie', cookie.getCurrent())
 
 		let mockAsText = readMock(file)
-		if (mockBroker.currentTransform) {
+		if (broker.currentTransform) {
 			const body = await requestBodyForTransform(req, mockAsText)
 			const transformFunc = await importTransformFunc(currentTransform)
 			mockAsText = transformFunc(mockAsText, body, Config)

package/{Mockaton.js → src/Mockaton.js}

@@ -4,14 +4,14 @@ import { createServer } from 'node:http'
 import { DP } from './ApiConstants.js'
 import { Config, setup } from './Config.js'
 import { dispatchMock } from './MockDispatcher.js'
-import * as MockBrokerCollection from './mockBrokersCollection.js'
+import * as mockBrokerCollection from './mockBrokersCollection.js'
 import { dispatchStatic, isStatic } from './StaticDispatcher.js'
 import { apiPatchRequests, apiGetRequests } from './Api.js'
 
 
 export function Mockaton(options) {
 	setup(options)
-	MockBrokerCollection.init()
+	mockBrokerCollection.init()
 
 	return createServer(async (req, response) => {
 		const { url, method } = req

package/{mockBrokersCollection.js → src/mockBrokersCollection.js}

@@ -20,43 +20,54 @@ import { MockBroker } from './MockBroker.js'
 let collection = {}
 
 export function init() {
+	collection = {}
 	cookie.init(Config.cookies)
 
-	collection = {}
-	for (const file of listMocksDirRecursively()) {
+	const files = readdirSync(Config.mocksDir, { recursive: true })
+		.filter(f => Config.allowedExt.test(f) && lstatSync(join(Config.mocksDir, f)).isFile())
+		.sort()
+
+	for (const file of files) {
 		const { error, method, urlMask } = Route.parseFilename(file)
-		if (error) // skip
+		if (error) {
 			console.error(error, file)
-		else {
-			collection[method] ??= {}
-			if (!(urlMask in collection[method]))
-				collection[method][urlMask] = new MockBroker(file)
-			else
-				collection[method][urlMask].register(file)
+			continue
 		}
+		collection[method] ??= {}
+		if (!(urlMask in collection[method]))
+			collection[method][urlMask] = new MockBroker(file)
+		else
+			collection[method][urlMask].register(file)
 	}
 	forEachBroker(broker => broker.ensureItHas500())
 }
 
+function forEachBroker(fn) {
+	for (const brokers of Object.values(collection))
+		Object.values(brokers).forEach(fn)
+}
+
+
 export const getAll = () => collection
+
 export const getBrokerByFilename = file => {
 	const { method, urlMask } = Route.parseFilename(file)
 	return collection[method][urlMask]
 }
 
-
 // Searching the routes in reverse order so dynamic params (e.g.
 // /user/[id]) don’t take precedence over exact paths (e.g.
 // /user/name). That’s because "[]" chars are lower than alphanumeric ones.
 // BTW, `urlMasks` always start with "/", so there’s no need to
 // worry about the primacy of array-like keys when iterating.
-export function findMatchingBroker(method, url) {
+export function getBrokerForUrl(method, url) {
 	const brokers = Object.values(collection[method])
 	for (let i = brokers.length - 1; i >= 0; i--)
 		if (brokers[i].urlMaskMatches(url))
 			return brokers[i]
 }
 
+
 export function extractAllComments() {
 	const comments = new Set()
 	forEachBroker(broker => {
@@ -70,14 +81,4 @@ export function setMocksMatchingComment(comment) {
 	forEachBroker(broker => broker.setByMatchingComment(comment))
 }
 
-function listMocksDirRecursively() {
-	return readdirSync(Config.mocksDir, { recursive: true })
-		.filter(f => Config.allowedExt.test(f) && lstatSync(join(Config.mocksDir, f)).isFile())
-		.sort()
-}
-
-function forEachBroker(fn) {
-	for (const brokers of Object.values(collection))
-		Object.values(brokers).forEach(fn)
-}