mockaton 13.4.2 → 13.5.0

package/README.md

@@ -79,7 +79,7 @@ export default {
 
 <br/>
 
-Similarly, you can handle logic with [Functional Mocks](https://mockaton.com/functional-mocks):
+Similarly, you can handle logic with [Function Mocks](https://mockaton.com/function-mocks):
 
 <code>my_mocks_dir/<b>api/company/[companyId]/user/[userId]</b>.GET.200.ts</code>
 ```ts

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "13.4.2",
+	"version": "13.5.0",
 	"exports": {
 		".": {
 			"import": "./index.js",

package/src/client/ApiCommander.js

@@ -65,4 +65,6 @@ export class Commander {
 	 * @returns {Promise<Response>}
 	 */
 	getSyncVersion = () => fetch(this.addr + API.syncVersion)
+
+	getOpenAPI = () => fetch(this.addr + API.openAPI)
 }

package/src/client/ApiConstants.js

@@ -4,25 +4,33 @@ const MOUNT = '/mockaton'
 
 export const API = {
 	dashboard: MOUNT,
+
+	reset: MOUNT + '/reset',
+
+	select: MOUNT + '/select',
 	bulkSelect: MOUNT + '/bulk-select-by-comment',
-	collectProxied: MOUNT + '/collect-proxied',
-	cookies: MOUNT + '/cookies',
-	cors: MOUNT + '/cors',
+
 	delay: MOUNT + '/delay',
+	proxied: MOUNT + '/proxied',
+	toggleStatus: MOUNT + '/toggle-status',
+
+	cors: MOUNT + '/cors',
+	cookies: MOUNT + '/cookies',
 	fallback: MOUNT + '/fallback',
+	collectProxied: MOUNT + '/collect-proxied',
 	globalDelay: MOUNT + '/global-delay',
 	globalDelayJitter: MOUNT + '/global-delay-jitter',
-	proxied: MOUNT + '/proxied',
-	reset: MOUNT + '/reset',
-	select: MOUNT + '/select',
+
+	writeMock: MOUNT + '/write-mock',
+	deleteMock: MOUNT + '/delete-mock',
+	watchMocks: MOUNT + '/watch-mocks',
+
 	state: MOUNT + '/state',
-	syncVersion: MOUNT + '/sync-version',
 	throws: MOUNT + '/throws',
-	toggleStatus: MOUNT + '/toggle-status',
+	syncVersion: MOUNT + '/sync-version',
 	watchHotReload: MOUNT + '/watch-hot-reload',
-	watchMocks: MOUNT + '/watch-mocks',
-	writeMock: MOUNT + '/write-mock',
-	deleteMock: MOUNT + '/delete-mock',
+
+	openAPI: MOUNT + '/openapi'
 }
 
 export const DEFAULT_MOCK_COMMENT = '(default)'

package/src/server/Api.js

@@ -7,6 +7,7 @@ import { join } from 'node:path'
 import { readdirSync } from 'node:fs'
 import { write, rm, isFile, resolveIn } from './utils/fs.js'
 
+import openapi from '../../www/src/assets/openapi.json' with { type: 'json' }
 import pkgJSON from '../../package.json' with { type: 'json' }
 
 import { sseClientHotReload } from './utils/WatcherDevClient.js'
@@ -24,7 +25,6 @@ export const CLIENT_DIR = join(import.meta.dirname, '../client')
 const DASHBOARD_ASSETS = readdirSync(CLIENT_DIR, { recursive: true })
 
 
-
 export const apiGetReqs = new Map([
 	[API.dashboard, serveDashboard],
 	...DASHBOARD_ASSETS.map(f => [API.dashboard + '/' + f, serveStatic(f)]),
@@ -33,7 +33,8 @@ export const apiGetReqs = new Map([
 	[API.syncVersion, sseClientSyncVersion],
 
 	[API.watchHotReload, onDevWatch],
-	[API.throws, () => { throw new Error('Test500') }]
+	[API.throws, () => { throw new Error('Test500') }],
+	[API.openAPI, (_, response) => response.json(openapi)]
 ])
 
 
@@ -96,7 +97,6 @@ function onDevWatch(req, response) {
 	else
 		response.notFound()
 }
-
 /** # PATCH */
 
 function reset(_, response) {

package/src/server/Mockaton.test.js

@@ -227,6 +227,14 @@ describe('Dashboard', () => {
 })
 
 
+describe('OpenAPI', () => {
+	test('serves the json spec', async () => {
+		const r = await request(API.openAPI)
+		match(await r.text(), new RegExp('"openapi":'))
+	})
+})
+
+
 describe('Cookie', () => {
 	test('422 when trying to select non-existing cookie', async () => {
 		const r = await api.selectCookie('non-existing-cookie-key')
@@ -360,7 +368,7 @@ describe('Proxy Fallback', () => {
 
 			equal(r1.headers.get('set-cookie'), CUSTOM_COOKIES.join(', '))
 			equal(r2.headers.get('set-cookie'), CUSTOM_COOKIES.join(', '))
-			
+
 			equal(r1.headers.get('cache-control'), 'no-cache') // unsets cache
 			equal(r2.headers.get('cache-control'), 'no-cache')
 

package/www/src/assets/openapi.json

@@ -1,8 +1,8 @@
 {
-	"openapi": "3.1.2",
+	"openapi": "3.2.0",
 	"info": {
 		"title": "Mockaton Control API",
-		"version": "1.0.0"
+		"version": "1.0.1"
 	},
 	"servers": [
 		{
@@ -10,6 +10,26 @@
 		}
 	],
 	"paths": {
+		"/mockaton/openapi": {
+			"get": {
+				"summary": "Get this OpenAPI spec",
+				"x-js-client-example": "await mockaton.getOpenAPI()",
+				"responses": {
+					"200": {
+						"description": "OpenAPI spec",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "object",
+									"additionalProperties": true
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+
 		"/mockaton/state": {
 			"get": {
 				"summary": "Get complete Mockaton state",
@@ -488,29 +508,17 @@
 		},
 		"/mockaton/sync-version": {
 			"get": {
-				"summary": "Get sync version for long‑polling updates",
+				"summary": "Get sync version as SSE",
 				"description": "A counter that’s incremented when a new mock is added, removed, or renamed. Also, when the internal state changes, e.g., when changing the mock file for a route.",
 				"x-js-client-example": "await mockaton.getSyncVersion()",
-				"parameters": [
-					{
-						"name": "sync_version",
-						"in": "header",
-						"required": false,
-						"example": -1,
-						"schema": {
-							"type": "number"
-						},
-						"description": "When not present, or when the version mismatches it responds right away. Otherwise, it long polls. Times out in 8s."
-					}
-				],
 				"responses": {
 					"200": {
-						"description": "Sync version value",
+						"description": "Stream of sync version updates (SSE)",
 						"content": {
-							"application/json": {
+							"text/event-stream": {
 								"schema": {
-									"type": "number",
-									"description": "Incremental integer"
+									"type": "integer",
+									"description": "Incremental sync version emitted per event"
 								}
 							}
 						}