feat: generate merged schema for postman import

Author: justandras

packages/live-status-gateway-api/.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+temp
 test
 src/**.js
 

packages/live-status-gateway-api/package.json

@@ -29,8 +29,9 @@
 		"license-validate": "run -T sofie-licensecheck",
 		"gendocs": "yarn resolve-nested-examples && ag ./dist/api/asyncapi.yaml @asyncapi/html-template -o docs -p singleFile=true -p outFilename=liveStatus.html",
 		"genserver": "yarn resolve-nested-examples && ag ./dist/api/asyncapi.yaml @asyncapi/nodejs-ws-template -o server -p server=development",
-		"generate-schema-types": "node scripts/generate-schema-types.mjs",
-		"resolve-nested-examples": "node scripts/resolve-nested-examples.mjs"
+		"generate-schema-types": "yarn resolve-nested-examples && node scripts/generate-schema-types.mjs",
+		"resolve-nested-examples": "node scripts/resolve-nested-examples.mjs && yarn merge-schemas",
+		"merge-schemas": "node scripts/merge-schemas.mjs"
 	},
 	"engines": {
 		"node": ">=14.19"
@@ -63,4 +64,4 @@
 		]
 	},
 	"packageManager": "yarn@4.10.3"
-}
+}

packages/live-status-gateway-api/scripts/generate-schema-types.mjs

@@ -61,7 +61,7 @@ const generator = new TypeScriptGenerator({
 })
 
 const parser = new Parser()
-const asyncApiDoc = await fromFile(parser, 'dist/api/asyncapi.yaml').parse()
+const asyncApiDoc = await fromFile(parser, 'src/generated/asyncapi.yaml').parse()
 if (!asyncApiDoc.document) {
 	// Ignore the expected legacy version error
 	const filteredDiagnostics = asyncApiDoc.diagnostics.filter((d) => d.code !== 'asyncapi-latest-version')

packages/live-status-gateway-api/scripts/merge-schemas.mjs

@@ -0,0 +1,34 @@
+import fs from 'fs'
+import path from 'path'
+import YAML from 'yaml'
+import { fromFile, Parser } from '@asyncapi/parser'
+
+const ROOT_FILE = './temp/api/asyncapi.yaml'
+const OUTPUT_FILE = './src/generated/asyncapi.yaml'
+
+async function main() {
+	try {
+		const parser = new Parser()
+		const { document } = await fromFile(parser, ROOT_FILE).parse()
+
+		if (!document) {
+			throw new Error('Failed to parse the AsyncAPI document.')
+		}
+
+		// Convert the resolved document to JS object
+		const resolved = document.json()
+
+		// Ensure output directory exists
+		fs.mkdirSync(path.dirname(OUTPUT_FILE), { recursive: true })
+
+		// Write out single YAML file
+		fs.writeFileSync(OUTPUT_FILE, YAML.stringify(resolved), 'utf-8')
+
+		console.log(`Fully resolved AsyncAPI schema written to: ${OUTPUT_FILE}`)
+	} catch (err) {
+		console.error('Failed to generate resolved AsyncAPI schema:', err)
+		throw err
+	}
+}
+
+main()

packages/live-status-gateway-api/scripts/resolve-nested-examples.mjs

@@ -3,7 +3,7 @@ import path from 'path'
 import YAML from 'yaml'
 
 const ROOT_DIR = './api'
-const RESOLVED_DIST_DIR = './dist/api/'
+const RESOLVED_DIST_DIR = './temp/api/'
 
 /**
  * Ensures that a directory exists, creating it and all necessary parent directories