@minecraft/api-docs-generator 1.0.0

package/lib/utilities/ScanObject.js

@@ -0,0 +1,101 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanObjectForMemberArray = scanObjectForMemberArray;
+exports.scanObjectForMemberWithName = scanObjectForMemberWithName;
+exports.scanObjectForMembersWithNamesNoChangelog = scanObjectForMembersWithNamesNoChangelog;
+exports.scanObjectForMembersWithNames = scanObjectForMembersWithNames;
+exports.scanObjectForMemberWithAnyNamesFromList = scanObjectForMemberWithAnyNamesFromList;
+/*
+ * Scan for all objects with array properties.
+ */
+function scanObjectForMemberArray(object, callback) {
+    if (object instanceof Object) {
+        for (const k in object) {
+            if (Object.prototype.hasOwnProperty.call(object, k) && object[k] !== undefined) {
+                if (Array.isArray(object[k])) {
+                    callback(object, k);
+                }
+                // Recursive call to scan property
+                scanObjectForMemberArray(object[k], callback);
+            }
+        }
+    }
+}
+/**
+ * Scan for all objects with a property with the specified name.
+ *
+ * If KeyType exists as a key of KeyToTypeMapping, the parent object is a Record with a key of the mapped type,
+ * If KeyType also exists as a key of KeyToParentTypeMapping, the parent object is the type defined in that mapping
+ * Otherwise if the KeyType is not a key of either mapping, the parent object is a dictionary with unknown keys
+ */
+function scanObjectForMemberWithName(object, memberName, callback) {
+    if (object instanceof Object) {
+        for (const k in object) {
+            if (Object.prototype.hasOwnProperty.call(object, k) && object[k] !== undefined) {
+                // If we are at a member we are looking for
+                if (k === memberName) {
+                    callback(object);
+                }
+                // Recursive call to scan property
+                scanObjectForMemberWithName(object[k], memberName, callback);
+            }
+        }
+    }
+}
+/*
+ * Scan for all objects with both of two properties with the given names. Does not include 'changelog' fields.
+ */
+function scanObjectForMembersWithNamesNoChangelog(object, memberName1, memberName2, callback) {
+    scanObjectForMembersWithNames_internal(object, memberName1, memberName2, ['changelog'], callback);
+}
+/*
+ * Scan for all objects with both of two properties with the given names.
+ */
+function scanObjectForMembersWithNames(object, memberName1, memberName2, callback) {
+    scanObjectForMembersWithNames_internal(object, memberName1, memberName2, [], callback);
+}
+function scanObjectForMembersWithNames_internal(object, memberName1, memberName2, keysToSkip, callback) {
+    if (object instanceof Object) {
+        let hasMember1 = false;
+        let hasMember2 = false;
+        for (const k in object) {
+            if (keysToSkip.includes(k)) {
+                continue;
+            }
+            if (Object.prototype.hasOwnProperty.call(object, k) && object[k] !== undefined) {
+                // If we are at a member we are looking for
+                if (k === memberName1) {
+                    hasMember1 = true;
+                }
+                else if (k === memberName2) {
+                    hasMember2 = true;
+                }
+                // Recursive call to scan property
+                scanObjectForMembersWithNames(object[k], memberName1, memberName2, callback);
+            }
+        }
+        if (hasMember1 && hasMember2) {
+            callback(object);
+        }
+    }
+}
+/*
+ * Scan for all objects with properties matching any of a list of names.
+ *
+ * This function can process multiple types of objects, so it is necessary to explicitly define the type in the callback.
+ */
+function scanObjectForMemberWithAnyNamesFromList(object, memberNames, callback) {
+    if (object instanceof Object) {
+        for (const k in object) {
+            if (Object.prototype.hasOwnProperty.call(object, k) && object[k] !== undefined) {
+                if (memberNames.some(name => k === name)) {
+                    callback(object, k);
+                }
+                scanObjectForMemberWithAnyNamesFromList(object[k], memberNames, callback);
+            }
+        }
+    }
+}
+//# sourceMappingURL=ScanObject.js.map

package/lib/utilities/ScanObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScanObject.js","sourceRoot":"","sources":["../../src/utilities/ScanObject.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAOlC,4DAgBC;AASD,kEAqBC;AAKD,4FAiBC;AAKD,sEAiBC;AA2CD,0FAgBC;AAxJD;;GAEG;AACH,SAAgB,wBAAwB,CACpC,MAA+B,EAC/B,QAAsF;IAEtF,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC3B,QAAQ,CAAC,MAAwC,EAAE,CAAC,CAAC,CAAC;gBAC1D,CAAC;gBAED,kCAAkC;gBAClC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAA4B,EAAE,QAAQ,CAAC,CAAC;YAC7E,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,2BAA2B,CAOzC,MAA+B,EAAE,UAAmB,EAAE,QAA4C;IAChG,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7E,2CAA2C;gBAC3C,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;oBACnB,QAAQ,CAAC,MAAoB,CAAC,CAAC;gBACnC,CAAC;gBAED,kCAAkC;gBAClC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAA4B,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC5F,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,wCAAwC,CAKpD,MAA+B,EAC/B,WAAqB,EACrB,WAAqB,EACrB,QAA4C;IAE5C,sCAAsC,CAClC,MAAM,EACN,WAAW,EACX,WAAW,EACX,CAAC,WAAW,CAAC,EACb,QAAQ,CACX,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAKzC,MAA+B,EAC/B,WAAqB,EACrB,WAAqB,EACrB,QAA4C;IAE5C,sCAAsC,CAClC,MAAM,EACN,WAAW,EACX,WAAW,EACX,EAAE,EACF,QAAQ,CACX,CAAC;AACN,CAAC;AAED,SAAS,sCAAsC,CAK3C,MAA+B,EAC/B,WAAqB,EACrB,WAAqB,EACrB,UAAoB,EACpB,QAA4C;IAE5C,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC3B,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACrB,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzB,SAAS;YACb,CAAC;YACD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7E,2CAA2C;gBAC3C,IAAI,CAAC,KAAK,WAAW,EAAE,CAAC;oBACpB,UAAU,GAAG,IAAI,CAAC;gBACtB,CAAC;qBAAM,IAAI,CAAC,KAAK,WAAW,EAAE,CAAC;oBAC3B,UAAU,GAAG,IAAI,CAAC;gBACtB,CAAC;gBAED,kCAAkC;gBAClC,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAA4B,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC5G,CAAC;QACL,CAAC;QACD,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;YAC3B,QAAQ,CAAC,MAAoB,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,uCAAuC,CACnD,MAA+B,EAC/B,WAAqB,EACrB,QAA+E;IAE/E,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7E,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;oBACvC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBACxB,CAAC;gBAED,uCAAuC,CAAC,MAAM,CAAC,CAAC,CAA4B,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;YACzG,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC"}

package/lib/utilities/SortComparers.d.ts

@@ -0,0 +1,3 @@
+export declare function nameSortComparer(element1: Record<'name', string>, element2: Record<'name', string>): number;
+export declare function semVerSortComparer<SemVerKey extends 'version' | 'minecraft_version' | 'schema_version'>(semverKeyName: SemVerKey): (element1: Record<SemVerKey, string>, element2: Record<SemVerKey, string>) => number;
+export declare function reverseSemVerSortComparer<SemVerKey extends 'version' | 'minecraft_version' | 'schema_version'>(semverKeyName: SemVerKey): (element1: Record<SemVerKey, string>, element2: Record<SemVerKey, string>) => number;

package/lib/utilities/SortComparers.js

@@ -0,0 +1,21 @@
+"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.nameSortComparer = nameSortComparer;
+exports.semVerSortComparer = semVerSortComparer;
+exports.reverseSemVerSortComparer = reverseSemVerSortComparer;
+const semver_1 = __importDefault(require("semver"));
+function nameSortComparer(element1, element2) {
+    return element1.name.localeCompare(element2.name);
+}
+function semVerSortComparer(semverKeyName) {
+    return (element1, element2) => semver_1.default.compare(element1[semverKeyName], element2[semverKeyName]);
+}
+function reverseSemVerSortComparer(semverKeyName) {
+    return (element1, element2) => semver_1.default.rcompare(element1[semverKeyName], element2[semverKeyName]);
+}
+//# sourceMappingURL=SortComparers.js.map

package/lib/utilities/SortComparers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SortComparers.js","sourceRoot":"","sources":["../../src/utilities/SortComparers.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;AAIlC,4CAEC;AAED,gDAIC;AAED,8DAIC;AAhBD,oDAA4B;AAE5B,SAAgB,gBAAgB,CAAC,QAAgC,EAAE,QAAgC;IAC/F,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC;AAED,SAAgB,kBAAkB,CAC9B,aAAwB;IAExB,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,gBAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;AACpG,CAAC;AAED,SAAgB,yBAAyB,CACrC,aAAwB;IAExB,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,gBAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;AACrG,CAAC"}

package/lib/utilities/index.d.ts

@@ -0,0 +1,9 @@
+export * from './AppendVersion';
+export * from './Complete';
+export * from './DeepCopyJson';
+export * from './GetFiles';
+export * from './LongestCommonSubsequence';
+export * from './MergeArrays';
+export * from './RemoveProperty';
+export * from './ScanObject';
+export * from './SortComparers';

package/lib/utilities/index.js

@@ -0,0 +1,28 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AppendVersion"), exports);
+__exportStar(require("./Complete"), exports);
+__exportStar(require("./DeepCopyJson"), exports);
+__exportStar(require("./GetFiles"), exports);
+__exportStar(require("./LongestCommonSubsequence"), exports);
+__exportStar(require("./MergeArrays"), exports);
+__exportStar(require("./RemoveProperty"), exports);
+__exportStar(require("./ScanObject"), exports);
+__exportStar(require("./SortComparers"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utilities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utilities/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;AAElC,kDAAgC;AAChC,6CAA2B;AAC3B,iDAA+B;AAC/B,6CAA2B;AAC3B,6DAA2C;AAC3C,gDAA8B;AAC9B,mDAAiC;AACjC,+CAA6B;AAC7B,kDAAgC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@minecraft/api-docs-generator",
+  "version": "1.0.0",
+  "description": "Core Minecraft API Docs Generator package for generating API markup and documentation",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "author": "Jake Shirley (jashir@mojang.com)",
+  "contributors": [
+    {
+      "name": "Raphael Landaverde",
+      "email": "rlanda@microsoft.com"
+    },
+    {
+      "name": "Zach Campbell",
+      "email": "zachary.campbell@skyboxlabs.com"
+    }
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Mojang/minecraft-scripting-libraries.git",
+    "directory": "tools/api-docs-generator"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "just build",
+    "clean": "just clean",
+    "lint": "just lint",
+    "test": "just test",
+    "package": "just package",
+    "postpublish": "just postpublish"
+  },
+  "bin": {
+    "minecraft-api-docs-generator": "lib/cli.js"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.{spec,test}.ts",
+    "README.md",
+    "CHANGELOG.*"
+  ],
+  "devDependencies": {
+    "@minecraft/core-build-tasks": "*",
+    "@types/deep-equal": "^1.0.4",
+    "@types/node": "^22.0.0",
+    "@types/semver": "^7.3.12",
+    "@types/terminal-kit": "^2.5.6",
+    "@types/toposort": "^2.0.7",
+    "@types/yargs": "^17.0.32",
+    "eslint": "^9.17.0",
+    "eslint-config-minecraft-scripting": "*",
+    "just-scripts": "^2.3.3",
+    "ts-node": "^10.9.2",
+    "vitest": "^3.0.8"
+  },
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "cosmiconfig": "^9.0.0",
+    "deep-equal": "^2.1.0",
+    "prettier": "^3.5.3",
+    "resolve-from": "^5.0.0",
+    "runtypes": "^6.7.0",
+    "semver": "^7.3.5",
+    "terminal-kit": "^2.5.6",
+    "toposort": "^2.0.2",
+    "typescript": "~5.6.0",
+    "word-wrap": "^1.2.3",
+    "yargs": "^17.0.32"
+  }
+}