@minecraft/markup-generators-plugin 1.0.0

package/CHANGELOG.json

@@ -0,0 +1,26 @@
+{
+  "name": "@minecraft/markup-generators-plugin",
+  "entries": [
+    {
+      "date": "Thu, 26 Jun 2025 22:33:07 GMT",
+      "version": "1.0.0",
+      "tag": "@minecraft/markup-generators-plugin_v1.0.0",
+      "comments": {
+        "major": [
+          {
+            "author": "zachary.campbell@skyboxlabs.com",
+            "package": "@minecraft/markup-generators-plugin",
+            "commit": "6dbbce7231a4daceb4ddbba5681891de7fc481e7",
+            "comment": "Add api-docs-generator and markup-generators-plugin"
+          },
+          {
+            "author": "beachball",
+            "package": "@minecraft/markup-generators-plugin",
+            "comment": "Bump @minecraft/api-docs-generator to v1.0.0",
+            "commit": "not available"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log - @minecraft/markup-generators-plugin
+
+<!-- This log was last generated on Thu, 26 Jun 2025 22:33:07 GMT and should not be manually modified. -->
+
+<!-- Start content -->
+
+## 1.0.0
+
+Thu, 26 Jun 2025 22:33:07 GMT
+
+### Major changes
+
+- Add api-docs-generator and markup-generators-plugin (zachary.campbell@skyboxlabs.com)
+- Bump @minecraft/api-docs-generator to v1.0.0

package/README.md

@@ -0,0 +1,17 @@
+# @minecraft/markup-generators-plugin
+
+This package extends [@minecraft/api-docs-generator](../api-docs-generator/README.md) with a core set of markup generators used to generate Minecraft API scripting types and documentation.
+
+## Markup Generators
+
+The optional `run-generators` argument uses a list of markup generator IDs described in the table below. If `run-generators` is not provided, then the generators marked as default will run:
+
+| ID | Name | Default? | Description |
+| :-- | :-- | :-: | :-- |
+| msdocs | MSDocs | :heavy_check_mark: | Markdown documentation for Minecraft APIs. |
+| ts | Typescript Definitions | :heavy_check_mark: | TypeScript type definitions for Minecraft APIs. |
+| ts-source | Typescript Source | :heavy_check_mark: | TypeScript source generation for Minecraft `vanilla-data` APIs. |
+| npm | NPM | :heavy_check_mark: | NPM module packaging. Requires `ts` and `ts-source`. |
+| typedoc | TypeDoc | :heavy_check_mark: | TypeDoc formatted documentation. Requires `ts` and `ts-source`. |
+| changelog | Changelog | :heavy_check_mark: | Markdown formatted changelog output for differences between API module versions. |
+| changelog-json | Changelog JSON | | JSON changelog output. |

package/lib/generators/ChangelogJSONGenerator.d.ts

@@ -0,0 +1,7 @@
+import { GeneratorContext, MarkupGenerator, MinecraftRelease } from '@minecraft/api-docs-generator';
+export declare class ChangelogJSONGenerator implements MarkupGenerator {
+    generateFiles(context: GeneratorContext, releases: MinecraftRelease[], outputDirectory: string): Promise<void>;
+    readonly id: string;
+    readonly name: string;
+    readonly outputDirectoryName: string;
+}

package/lib/generators/ChangelogJSONGenerator.js

@@ -0,0 +1,46 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangelogJSONGenerator = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const api_docs_generator_1 = require("@minecraft/api-docs-generator");
+class ChangelogJSONGenerator {
+    generateFiles(context, releases, outputDirectory) {
+        if (releases.length === 0) {
+            api_docs_generator_1.Logger.warn(`No releases found, '${this.name}' generation not possible.`);
+            return;
+        }
+        if (context.changelogStrategy instanceof api_docs_generator_1.DisabledChangelogStrategy) {
+            api_docs_generator_1.Logger.warn(`Generator '${this.name}' requires a changelog strategy!`);
+            return;
+        }
+        let modulesToChangelog = releases[0].getLatestScriptModules();
+        modulesToChangelog = modulesToChangelog.concat(releases[0].command_modules);
+        const afterEventsModule = (0, api_docs_generator_1.getAfterEventsOrderingModuleFrom)(releases[0].engine_data_modules);
+        if (afterEventsModule) {
+            modulesToChangelog = modulesToChangelog.concat(afterEventsModule);
+        }
+        for (const moduleJson of modulesToChangelog) {
+            if ((0, api_docs_generator_1.moduleHasChangelog)(moduleJson)) {
+                const moduleName = moduleJson.name;
+                const changelogsFile = path_1.default.join(outputDirectory, `${moduleName}.json`);
+                api_docs_generator_1.Logger.info(`Writing changelog to disk: ${changelogsFile}`);
+                fs_1.default.mkdirSync(path_1.default.dirname(changelogsFile), { recursive: true });
+                let fileContents = JSON.stringify(moduleJson.changelog, undefined, 2);
+                fileContents = fileContents.replace(/\r?\n/g, '\r\n');
+                fs_1.default.writeFileSync(changelogsFile, fileContents);
+            }
+        }
+        return Promise.resolve();
+    }
+    id = 'changelog-json';
+    name = 'Changelog JSON';
+    outputDirectoryName = 'changelog';
+}
+exports.ChangelogJSONGenerator = ChangelogJSONGenerator;
+//# sourceMappingURL=ChangelogJSONGenerator.js.map

package/lib/generators/ChangelogJSONGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangelogJSONGenerator.js","sourceRoot":"","sources":["../../src/generators/ChangelogJSONGenerator.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;AAElC,4CAAoB;AACpB,gDAAwB;AAExB,sEASuC;AAEvC,MAAa,sBAAsB;IAC/B,aAAa,CAAC,OAAyB,EAAE,QAA4B,EAAE,eAAuB;QAC1F,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,2BAAM,CAAC,IAAI,CAAC,uBAAuB,IAAI,CAAC,IAAI,4BAA4B,CAAC,CAAC;YAC1E,OAAO;QACX,CAAC;QACD,IAAI,OAAO,CAAC,iBAAiB,YAAY,8CAAyB,EAAE,CAAC;YACjE,2BAAM,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,kCAAkC,CAAC,CAAC;YACvE,OAAO;QACX,CAAC;QAED,IAAI,kBAAkB,GAAuB,QAAQ,CAAC,CAAC,CAAC,CAAC,sBAAsB,EAAE,CAAC;QAClF,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAE5E,MAAM,iBAAiB,GAAG,IAAA,qDAAgC,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;QAC5F,IAAI,iBAAiB,EAAE,CAAC;YACpB,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACtE,CAAC;QAED,KAAK,MAAM,UAAU,IAAI,kBAAkB,EAAE,CAAC;YAC1C,IAAI,IAAA,uCAAkB,EAAC,UAAU,CAAC,EAAE,CAAC;gBACjC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;gBAEnC,MAAM,cAAc,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,UAAU,OAAO,CAAC,CAAC;gBACxE,2BAAM,CAAC,IAAI,CAAC,8BAA8B,cAAc,EAAE,CAAC,CAAC;gBAC5D,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAEhE,IAAI,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;gBACtE,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACtD,YAAE,CAAC,aAAa,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACnD,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAEQ,EAAE,GAAW,gBAAgB,CAAC;IAC9B,IAAI,GAAW,gBAAgB,CAAC;IAChC,mBAAmB,GAAW,WAAW,CAAC;CACtD;AAvCD,wDAuCC"}

package/lib/generators/ChangelogMDGenerator.d.ts

@@ -0,0 +1,9 @@
+import { GeneratorContext, FilterGroup, MinecraftRelease, MarkupGenerator } from '@minecraft/api-docs-generator';
+export declare class ChangelogMDGenerator implements MarkupGenerator {
+    generateFiles(context: GeneratorContext, releases: MinecraftRelease[], outputDirectory: string): Promise<void>;
+    readonly id: string;
+    readonly name: string;
+    readonly outputDirectoryName: string;
+    readonly templates: string[];
+    readonly filterGroups: FilterGroup[];
+}

package/lib/generators/ChangelogMDGenerator.js

@@ -0,0 +1,54 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangelogMDGenerator = void 0;
+const fs_1 = __importDefault(require("fs"));
+const mustache_1 = __importDefault(require("mustache"));
+const path_1 = __importDefault(require("path"));
+const api_docs_generator_1 = require("@minecraft/api-docs-generator");
+class ChangelogMDGenerator {
+    generateFiles(context, releases, outputDirectory) {
+        if (releases.length === 0) {
+            api_docs_generator_1.Logger.warn(`No releases found, '${this.name}' generation not possible.`);
+            return;
+        }
+        if (context.changelogStrategy instanceof api_docs_generator_1.DisabledChangelogStrategy) {
+            api_docs_generator_1.Logger.warn(`Generator '${this.name}' requires a changelog strategy!`);
+            return;
+        }
+        const { txt: txtTemplateFiles, tsdef: tsTemplateFiles } = context.getTemplates(...this.templates);
+        for (const moduleJson of releases[0].getLatestScriptModules()) {
+            const moduleName = moduleJson.name;
+            const txtTemplateFileData = txtTemplateFiles.readFileAsString('md_changelog.mustache');
+            const txtProcessedData = mustache_1.default.render(txtTemplateFileData, moduleJson, {
+                // TypeScript Partials
+                type: tsTemplateFiles.readFileAsString('type.mustache'),
+                value: tsTemplateFiles.readFileAsString('value.mustache'),
+                function_declaration: tsTemplateFiles.readFileAsString('function_declaration.mustache'),
+                function: tsTemplateFiles.readFileAsString('function.mustache'),
+                property_declaration: tsTemplateFiles.readFileAsString('property_declaration.mustache'),
+                property: tsTemplateFiles.readFileAsString('property.mustache'),
+                enum: tsTemplateFiles.readFileAsString('enum.mustache'),
+                class: tsTemplateFiles.readFileAsString('class.mustache'),
+                type_alias: tsTemplateFiles.readFileAsString('type_alias.mustache'),
+                module: tsTemplateFiles.readFileAsString('module.mustache'),
+                function_argument_declaration: tsTemplateFiles.readFileAsString('function_argument_declaration.mustache'),
+            });
+            const txtModuleFilePath = path_1.default.join(outputDirectory, `${moduleName}.txt`);
+            fs_1.default.mkdirSync(path_1.default.dirname(txtModuleFilePath), { recursive: true });
+            fs_1.default.writeFileSync(txtModuleFilePath, txtProcessedData);
+        }
+        return Promise.resolve();
+    }
+    id = 'changelog';
+    name = 'Changelog';
+    outputDirectoryName = 'txt';
+    templates = ['txt', 'tsdef'];
+    filterGroups = [api_docs_generator_1.CommonFilters];
+}
+exports.ChangelogMDGenerator = ChangelogMDGenerator;
+//# sourceMappingURL=ChangelogMDGenerator.js.map

package/lib/generators/ChangelogMDGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangelogMDGenerator.js","sourceRoot":"","sources":["../../src/generators/ChangelogMDGenerator.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;AAElC,4CAAoB;AACpB,wDAAgC;AAChC,gDAAwB;AAExB,sEAQuC;AAEvC,MAAa,oBAAoB;IAC7B,aAAa,CAAC,OAAyB,EAAE,QAA4B,EAAE,eAAuB;QAC1F,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,2BAAM,CAAC,IAAI,CAAC,uBAAuB,IAAI,CAAC,IAAI,4BAA4B,CAAC,CAAC;YAC1E,OAAO;QACX,CAAC;QACD,IAAI,OAAO,CAAC,iBAAiB,YAAY,8CAAyB,EAAE,CAAC;YACjE,2BAAM,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,kCAAkC,CAAC,CAAC;YACvE,OAAO;QACX,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAElG,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,sBAAsB,EAAE,EAAE,CAAC;YAC5D,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;YAEnC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;YACvF,MAAM,gBAAgB,GAAG,kBAAQ,CAAC,MAAM,CAAC,mBAAmB,EAAE,UAAU,EAAE;gBACtE,sBAAsB;gBACtB,IAAI,EAAE,eAAe,CAAC,gBAAgB,CAAC,eAAe,CAAC;gBACvD,KAAK,EAAE,eAAe,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;gBACzD,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,+BAA+B,CAAC;gBACvF,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;gBAC/D,oBAAoB,EAAE,eAAe,CAAC,gBAAgB,CAAC,+BAA+B,CAAC;gBACvF,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;gBAC/D,IAAI,EAAE,eAAe,CAAC,gBAAgB,CAAC,eAAe,CAAC;gBACvD,KAAK,EAAE,eAAe,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;gBACzD,UAAU,EAAE,eAAe,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;gBACnE,MAAM,EAAE,eAAe,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;gBAC3D,6BAA6B,EAAE,eAAe,CAAC,gBAAgB,CAC3D,wCAAwC,CAC3C;aACJ,CAAC,CAAC;YACH,MAAM,iBAAiB,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,UAAU,MAAM,CAAC,CAAC;YAC1E,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,YAAE,CAAC,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAEQ,EAAE,GAAW,WAAW,CAAC;IACzB,IAAI,GAAW,WAAW,CAAC;IAC3B,mBAAmB,GAAW,KAAK,CAAC;IAEpC,SAAS,GAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACvC,YAAY,GAAkB,CAAC,kCAAa,CAAC,CAAC;CAC1D;AA/CD,oDA+CC"}

package/lib/generators/MSDocsMarkdownGenerator.d.ts

@@ -0,0 +1,26 @@
+import { FilterGroup, GeneratorContext, MarkupGenerator, MinecraftRelease, MinecraftScriptModule } from '@minecraft/api-docs-generator';
+export declare const MSDocsFilters: FilterGroup;
+export declare class MSDocsMarkdownGenerator implements MarkupGenerator {
+    private generateScriptClassFiles;
+    private generateScriptEnumFiles;
+    private generateScriptTypeAliasFiles;
+    private generateScriptModuleFile;
+    private generateScriptModuleChangelogFile;
+    getSortedModules(release: MinecraftRelease): {
+        latest: MinecraftScriptModule[];
+        prior: MinecraftScriptModule[];
+    };
+    private generateScriptTableOfContents;
+    private generateCommandFiles;
+    private generateCommandEnumFiles;
+    private generateCommandsTableOfContents;
+    private generateCommandsSummaryFile;
+    private generateBlockFiles;
+    private generateBlockPropertyFiles;
+    generateFiles(context: GeneratorContext, releases: MinecraftRelease[], outputDirectory: string): Promise<void>;
+    readonly id: string;
+    readonly name: string;
+    readonly outputDirectoryName: string;
+    readonly templates: string[];
+    readonly filterGroups: FilterGroup[];
+}

package/lib/generators/MSDocsMarkdownGenerator.js

@@ -0,0 +1,434 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MSDocsMarkdownGenerator = exports.MSDocsFilters = void 0;
+const fs_1 = __importDefault(require("fs"));
+const mustache_1 = __importDefault(require("mustache"));
+const path_1 = __importDefault(require("path"));
+const semver = __importStar(require("semver"));
+const api_docs_generator_1 = require("@minecraft/api-docs-generator");
+exports.MSDocsFilters = {
+    id: 'msdoc',
+    filters: [
+        ['add_headers_to_prior_docs', addHeaderToPrior],
+        ['add_changed_stable_apis', checkForChangedStableAPIs],
+    ],
+};
+function addHeaderToPrior(releases) {
+    if (releases.length !== 1) {
+        api_docs_generator_1.Logger.assert(false, 'There should only be one release for MSDocs.');
+        return;
+    }
+    const markPrior = (c, isModule) => {
+        if (!c.from_module.prior_version) {
+            return;
+        }
+        c.show_prior_warning = true;
+        if (c.deprecated_version === undefined) {
+            if (isModule) {
+                c.prior_link = `../../../scriptapi/${c.from_module.bookmark_name.startsWith('minecraft-')
+                    ? `minecraft/${c.from_module.bookmark_name.substring(10)}`
+                    : c.from_module.bookmark_name}/${c.from_module.bookmark_name}.md`;
+            }
+            else {
+                c.prior_link = `../../../scriptapi/${c.from_module.bookmark_name.startsWith('minecraft-')
+                    ? `minecraft/${c.from_module.bookmark_name.substring(10)}`
+                    : c.from_module.bookmark_name}/${c.name}.md`;
+            }
+        }
+    };
+    const release = releases[0];
+    for (const scriptModule of release.script_modules) {
+        markPrior(scriptModule, true);
+        for (const arr of [
+            scriptModule.classes,
+            scriptModule.interfaces,
+            scriptModule.enums,
+            scriptModule.type_aliases,
+        ]) {
+            for (const c of arr) {
+                markPrior(c);
+            }
+        }
+    }
+}
+function getLatestBeta(scriptModules, uuid) {
+    const betas = scriptModules.filter(module => module.uuid === uuid && semver.prerelease(module.version)?.some(prerelease => prerelease === 'beta'));
+    if (betas.length > 1) {
+        api_docs_generator_1.Logger.warn(`Unexpected amount of betas for ${uuid}`);
+        return undefined;
+    }
+    return betas.length === 1 ? betas[0] : undefined;
+}
+function getLatestStable(scriptModules, uuid, majorVersion) {
+    let latestStable;
+    for (const module of scriptModules) {
+        if (module.uuid !== uuid) {
+            continue;
+        }
+        const moduleVersion = semver.parse(module.version);
+        if (moduleVersion.major !== majorVersion) {
+            continue;
+        }
+        if (moduleVersion.prerelease &&
+            moduleVersion.prerelease.some(pr => pr === 'beta' || pr === 'alpha' || pr === 'internal')) {
+            continue;
+        }
+        if (!latestStable || moduleVersion.minor > semver.minor(latestStable.version)) {
+            latestStable = module;
+        }
+    }
+    return latestStable;
+}
+function checkForChangedStableAPIs(releases) {
+    if (releases.length !== 1) {
+        api_docs_generator_1.Logger.assert(false, 'There should only be one release for MSDocs.');
+        return;
+    }
+    const release = releases[0];
+    const moduleUUIDs = [...new Set(release.script_modules.map(m => m.uuid))];
+    for (const uuid of moduleUUIDs) {
+        const latestBeta = getLatestBeta(release.script_modules, uuid);
+        if (!latestBeta) {
+            continue;
+        }
+        const latestStable = getLatestStable(release.script_modules, uuid, semver.major(latestBeta.version));
+        if (!latestStable) {
+            continue;
+        }
+        const compareFunctionLists = (betaFuncs, stableFuncs) => {
+            const newBetaFuncs = [];
+            for (const betaFunc of betaFuncs ?? []) {
+                for (const stableFunc of stableFuncs ?? []) {
+                    if (betaFunc.name === stableFunc.name) {
+                        if (betaFunc.arguments.length !== stableFunc.arguments.length ||
+                            betaFunc.return_type.name !== stableFunc.return_type.name) {
+                            betaFunc.is_prerelease = true;
+                            stableFunc.stable_only = true;
+                            newBetaFuncs.push(stableFunc);
+                        }
+                        continue;
+                    }
+                }
+            }
+            for (const newBetaFunc of newBetaFuncs) {
+                betaFuncs.push(newBetaFunc);
+            }
+        };
+        compareFunctionLists(latestBeta.functions, latestStable.functions);
+        for (const betaFunc of latestBeta.classes ?? []) {
+            for (const stableFunc of latestStable.classes ?? []) {
+                if (betaFunc.class_name === stableFunc.class_name) {
+                    compareFunctionLists(betaFunc.functions, stableFunc.functions);
+                    continue;
+                }
+            }
+        }
+    }
+}
+const MUSTACHE_CONFIG = {
+    display_constructor_as_instantiation: true,
+    disable_export_keyword: true,
+};
+class MSDocsMarkdownGenerator {
+    generateScriptClassFiles(classJson, mdTemplateFiles, tsTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/class.mustache');
+        classJson.mustache_config = MUSTACHE_CONFIG;
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, classJson, {
+            // MSDocs Partials
+            type_with_links: mdTemplateFiles.readFileAsString('script/type_with_links.mustache'),
+            function: mdTemplateFiles.readFileAsString('script/function.mustache'),
+            examples: mdTemplateFiles.readFileAsString('script/examples.mustache'),
+            value: mdTemplateFiles.readFileAsString('script/value.mustache'),
+            property: mdTemplateFiles.readFileAsString('script/property.mustache'),
+            property_declaration: mdTemplateFiles.readFileAsString('script/property_declaration.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('script/default_metadata.mustache'),
+            // TypeScript Partials
+            function_declaration: tsTemplateFiles.readFileAsString('function_declaration.mustache'),
+            function_argument_declaration: tsTemplateFiles.readFileAsString('function_argument_declaration.mustache'),
+            type: tsTemplateFiles.readFileAsString('type.mustache'),
+        });
+        const msdocsClassFilePath = path_1.default.join(outputDirectory, `${classJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsClassFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsClassFilePath, msdocsProcessedData);
+    }
+    generateScriptEnumFiles(enumJson, mdTemplateFiles, tsTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/enum.mustache');
+        enumJson.mustache_config = MUSTACHE_CONFIG;
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, enumJson, {
+            // MSDocs Partials
+            type_with_links: mdTemplateFiles.readFileAsString('script/type_with_links.mustache'),
+            function: mdTemplateFiles.readFileAsString('script/function.mustache'),
+            value: mdTemplateFiles.readFileAsString('script/value.mustache'),
+            property: mdTemplateFiles.readFileAsString('script/property.mustache'),
+            property_declaration: mdTemplateFiles.readFileAsString('script/property_declaration.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('script/default_metadata.mustache'),
+            // TypeScript Partials
+            function_declaration: tsTemplateFiles.readFileAsString('function_declaration.mustache'),
+            function_argument_declaration: tsTemplateFiles.readFileAsString('function_argument_declaration.mustache'),
+            type: tsTemplateFiles.readFileAsString('type.mustache'),
+        });
+        const msdocsClassFilePath = path_1.default.join(outputDirectory, `${enumJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsClassFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsClassFilePath, msdocsProcessedData);
+    }
+    generateScriptTypeAliasFiles(typeAliasJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/type_alias.mustache');
+        typeAliasJson.mustache_config = MUSTACHE_CONFIG;
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, typeAliasJson, {
+            examples: mdTemplateFiles.readFileAsString('script/examples.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('script/default_metadata.mustache'),
+        });
+        const msdocsClassFilePath = path_1.default.join(outputDirectory, `${typeAliasJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsClassFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsClassFilePath, msdocsProcessedData);
+    }
+    generateScriptModuleFile(moduleJson, mdTemplateFiles, tsTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/module.mustache');
+        moduleJson.mustache_config = MUSTACHE_CONFIG;
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, moduleJson, {
+            // MSDocs Partials
+            type_with_links: mdTemplateFiles.readFileAsString('script/type_with_links.mustache'),
+            class: mdTemplateFiles.readFileAsString('script/class.mustache'),
+            function: mdTemplateFiles.readFileAsString('script/function.mustache'),
+            examples: mdTemplateFiles.readFileAsString('script/examples.mustache'),
+            value: mdTemplateFiles.readFileAsString('script/value.mustache'),
+            property: mdTemplateFiles.readFileAsString('script/property.mustache'),
+            property_declaration: mdTemplateFiles.readFileAsString('script/property_declaration.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('script/default_metadata.mustache'),
+            // TypeScript Partials
+            function_declaration: tsTemplateFiles.readFileAsString('function_declaration.mustache'),
+            function_argument_declaration: tsTemplateFiles.readFileAsString('function_argument_declaration.mustache'),
+            type: tsTemplateFiles.readFileAsString('type.mustache'),
+        });
+        const msdocsModuleFilePath = path_1.default.join(outputDirectory, `${moduleJson.bookmark_name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsModuleFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsModuleFilePath, msdocsProcessedData);
+    }
+    generateScriptModuleChangelogFile(moduleJson, mdTemplateFiles, tsTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/module_changelog.mustache');
+        moduleJson.mustache_config = MUSTACHE_CONFIG;
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, moduleJson, {
+            // MSDocs Partials
+            type_with_links: mdTemplateFiles.readFileAsString('script/type_with_links.mustache'),
+            class: mdTemplateFiles.readFileAsString('script/class.mustache'),
+            function: mdTemplateFiles.readFileAsString('script/function.mustache'),
+            examples: mdTemplateFiles.readFileAsString('script/examples.mustache'),
+            value: mdTemplateFiles.readFileAsString('script/value.mustache'),
+            property: mdTemplateFiles.readFileAsString('script/property.mustache'),
+            property_declaration: mdTemplateFiles.readFileAsString('script/property_declaration.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('script/default_metadata.mustache'),
+            // TypeScript Partials
+            function_declaration: tsTemplateFiles.readFileAsString('function_declaration.mustache'),
+            function_argument_declaration: tsTemplateFiles.readFileAsString('function_argument_declaration.mustache'),
+            type: tsTemplateFiles.readFileAsString('type.mustache'),
+        });
+        const msdocChangelogFilePath = path_1.default.join(outputDirectory, 'changelog.md');
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocChangelogFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocChangelogFilePath, msdocsProcessedData);
+    }
+    getSortedModules(release) {
+        const latest = release.getLatestScriptModules().sort(api_docs_generator_1.Utils.nameSortComparer);
+        const prior = release
+            .getLatestScriptModulesByMajorVersion()
+            .filter(module => !latest.includes(module))
+            .sort((e1, e2) => {
+            const nameSort = api_docs_generator_1.Utils.nameSortComparer(e1, e2);
+            if (nameSort === 0) {
+                return semver.compare(e2.version, e1.version);
+            }
+            return nameSort;
+        });
+        return {
+            latest,
+            prior,
+        };
+    }
+    generateScriptTableOfContents(release, mdTemplateFiles, msdocsDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('script/toc.mustache');
+        const createTOC = (pathString, modules) => {
+            const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, {
+                script_modules: modules,
+            });
+            fs_1.default.mkdirSync(path_1.default.dirname(pathString), { recursive: true });
+            fs_1.default.writeFileSync(pathString, msdocsProcessedData);
+        };
+        const modules = this.getSortedModules(release);
+        createTOC(path_1.default.join(msdocsDirectory, 'scriptapi', `TOC.yml`), modules.latest);
+        if (modules.prior.length !== 0) {
+            createTOC(path_1.default.join(msdocsDirectory, 'priorscriptapi', `TOC.yml`), modules.prior);
+        }
+    }
+    generateCommandFiles(commandJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('commands/command.mustache');
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, commandJson, {
+            overload: mdTemplateFiles.readFileAsString('commands/overload.mustache'),
+            parameter: mdTemplateFiles.readFileAsString('commands/parameter.mustache'),
+            inline_enum: mdTemplateFiles.readFileAsString('commands/inline_enum.mustache'),
+            default_metadata: mdTemplateFiles.readFileAsString('commands/default_metadata.mustache'),
+        });
+        const msdocsCommandFilePath = path_1.default.join(outputDirectory, 'commands', `${commandJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsCommandFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsCommandFilePath, msdocsProcessedData);
+    }
+    generateCommandEnumFiles(enumJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('commands/enum.mustache');
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, enumJson, {
+            default_metadata: mdTemplateFiles.readFileAsString('commands/default_metadata.mustache'),
+        });
+        const msdocsEnumFilePath = path_1.default.join(outputDirectory, 'enums', `${enumJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsEnumFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsEnumFilePath, msdocsProcessedData);
+    }
+    generateCommandsTableOfContents(commandsJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('commands/toc.mustache');
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, {
+            commands: commandsJson,
+        });
+        const msdocsModuleFilePath = path_1.default.join(outputDirectory, `TOC.yml`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsModuleFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsModuleFilePath, msdocsProcessedData);
+    }
+    generateCommandsSummaryFile(moduleJson, mdTemplateFiles, outputDirectory) {
+        const summaryTemplateFileData = mdTemplateFiles.readFileAsString('commands/summary.mustache');
+        const summaryProcessedData = mustache_1.default.render(summaryTemplateFileData, {
+            commands: moduleJson.commands,
+            command_enums: moduleJson.command_enums,
+            command_types: moduleJson.command_types,
+        }, {
+            default_metadata: mdTemplateFiles.readFileAsString('commands/default_metadata.mustache'),
+        });
+        const summaryOutputFilePath = path_1.default.join(outputDirectory, `commands.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(summaryOutputFilePath), { recursive: true });
+        fs_1.default.writeFileSync(summaryOutputFilePath, summaryProcessedData);
+    }
+    generateBlockFiles(blockJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('blocks/block.mustache');
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, blockJson, {
+            default_metadata: mdTemplateFiles.readFileAsString('blocks/default_metadata.mustache'),
+        });
+        const msdocsBlockFilePath = path_1.default.join(outputDirectory, 'blocks', `${blockJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsBlockFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsBlockFilePath, msdocsProcessedData);
+    }
+    generateBlockPropertyFiles(blockPropertyJson, mdTemplateFiles, outputDirectory) {
+        const msdocsTemplateFileData = mdTemplateFiles.readFileAsString('blocks/block_property.mustache');
+        const msdocsProcessedData = mustache_1.default.render(msdocsTemplateFileData, blockPropertyJson, {
+            default_metadata: mdTemplateFiles.readFileAsString('blocks/default_metadata.mustache'),
+        });
+        const msdocsBlockPropertyFilePath = path_1.default.join(outputDirectory, 'block_properties', `${blockPropertyJson.name}.md`);
+        fs_1.default.mkdirSync(path_1.default.dirname(msdocsBlockPropertyFilePath), { recursive: true });
+        fs_1.default.writeFileSync(msdocsBlockPropertyFilePath, msdocsProcessedData);
+    }
+    generateFiles(context, releases, outputDirectory) {
+        if (releases.length === 0) {
+            api_docs_generator_1.Logger.warn(`No releases found, '${this.name}' generation not possible.`);
+            return;
+        }
+        api_docs_generator_1.Logger.info(`Running filter group: ${exports.MSDocsFilters.id}`);
+        for (const filter of exports.MSDocsFilters.filters) {
+            api_docs_generator_1.Logger.info(`Running filter: ${filter[0]}`);
+            try {
+                filter[1](releases);
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    api_docs_generator_1.Logger.error(`Filter ${filter[0]} threw an exception: ${e.message} @ ${e.stack}`);
+                }
+            }
+        }
+        const { msdocs: mdTemplateFiles, tsdef: tsTemplateFiles } = context.getTemplates(...this.templates);
+        const commandsMSDocsOutputPath = path_1.default.join(outputDirectory, 'commands');
+        const blocksMSDocsOutputPath = path_1.default.join(outputDirectory, 'blocks');
+        ///
+        // Script
+        ///
+        const modules = releases[0].getLatestScriptModulesByMajorVersion();
+        for (const moduleJson of modules) {
+            const scriptModuleOutputFolder = path_1.default.join(outputDirectory, moduleJson.from_module.folder_path, moduleJson.from_module.filepath_name);
+            this.generateScriptModuleFile(moduleJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            if ((0, api_docs_generator_1.moduleHasChangelog)(moduleJson) &&
+                moduleJson.changelog.length > 0 &&
+                moduleJson.display_changelog_in_toc) {
+                this.generateScriptModuleChangelogFile(moduleJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            }
+            for (const classJson of moduleJson.classes ?? []) {
+                this.generateScriptClassFiles(classJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            }
+            for (const interfaceJson of moduleJson.interfaces ?? []) {
+                this.generateScriptClassFiles(interfaceJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            }
+            for (const errorJson of moduleJson.errors ?? []) {
+                this.generateScriptClassFiles(errorJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            }
+            for (const enumJson of moduleJson.enums ?? []) {
+                this.generateScriptEnumFiles(enumJson, mdTemplateFiles, tsTemplateFiles, scriptModuleOutputFolder);
+            }
+            for (const typeAliasJson of moduleJson.type_aliases ?? []) {
+                this.generateScriptTypeAliasFiles(typeAliasJson, mdTemplateFiles, scriptModuleOutputFolder);
+            }
+        }
+        this.generateScriptTableOfContents(releases[0], mdTemplateFiles, outputDirectory);
+        ///
+        // Commands
+        ///
+        if (releases[0].command_modules.length > 0) {
+            const moduleJson = releases[0].command_modules[0];
+            for (const commandJson of moduleJson.commands ?? []) {
+                this.generateCommandFiles(commandJson, mdTemplateFiles, commandsMSDocsOutputPath);
+            }
+            for (const enumJson of moduleJson.command_enums ?? []) {
+                this.generateCommandEnumFiles(enumJson, mdTemplateFiles, commandsMSDocsOutputPath);
+            }
+            this.generateCommandsSummaryFile(moduleJson, mdTemplateFiles, commandsMSDocsOutputPath);
+            this.generateCommandsTableOfContents(moduleJson.commands, mdTemplateFiles, commandsMSDocsOutputPath);
+        }
+        ///
+        // Blocks
+        ///
+        if (releases[0].block_modules.length > 0) {
+            const moduleJson = releases[0].block_modules[0];
+            for (const dataItemsJson of moduleJson.data_items ?? []) {
+                this.generateBlockFiles(dataItemsJson, mdTemplateFiles, blocksMSDocsOutputPath);
+            }
+            for (const blockPropertyJson of moduleJson.block_properties ?? []) {
+                this.generateBlockPropertyFiles(blockPropertyJson, mdTemplateFiles, blocksMSDocsOutputPath);
+            }
+        }
+        return Promise.resolve();
+    }
+    id = 'msdocs';
+    name = 'MS Docs';
+    outputDirectoryName = 'msdocs';
+    templates = ['msdocs', 'tsdef'];
+    filterGroups = [api_docs_generator_1.CommonFilters, api_docs_generator_1.MarkdownFilters, api_docs_generator_1.TypeScriptFilters];
+}
+exports.MSDocsMarkdownGenerator = MSDocsMarkdownGenerator;
+//# sourceMappingURL=MSDocsMarkdownGenerator.js.map