@minecraft/api-docs-generator 1.0.0

package/lib/filters/TypeScriptFilters.js

@@ -0,0 +1,387 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeScriptFilters = void 0;
+const MinecraftScriptModule_1 = require("../modules/MinecraftScriptModule");
+const utils = __importStar(require("../utilities"));
+const typescriptTypeMappings = {
+    int8: 'number',
+    uint8: 'number',
+    int16: 'number',
+    uint16: 'number',
+    int32: 'number',
+    uint32: 'number',
+    int64: 'number',
+    uint64: 'number',
+    float: 'number',
+    double: 'number',
+};
+/**
+ * Create TypeScript 'next' and 'Symbol.iterator' methods for Iterator types.
+ */
+function generateIteratorMetadata(releases) {
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            if (scriptModule.classes) {
+                for (const classJson of scriptModule.classes) {
+                    if (!classJson.iterator) {
+                        continue;
+                    }
+                    const iteratorData = classJson.iterator;
+                    const nextMethod = {
+                        name: 'next',
+                        arguments: [],
+                        is_constructor: false,
+                        is_member: true,
+                        is_static: false,
+                        return_type: {
+                            name: 'iterator_result',
+                            iterator_type: iteratorData,
+                            is_errorable: false,
+                            is_bind_type: false,
+                        },
+                    };
+                    const iteratorMethod = {
+                        name: '[Symbol.iterator]',
+                        disable_unsafe_name_check: true,
+                        arguments: [],
+                        is_constructor: false,
+                        is_member: true,
+                        is_static: false,
+                        return_type: {
+                            name: 'iterator',
+                            iterator_type: iteratorData,
+                            is_errorable: false,
+                            is_bind_type: false,
+                        },
+                    };
+                    if (!classJson.functions) {
+                        classJson.functions = [];
+                    }
+                    classJson.functions.push(nextMethod);
+                    classJson.functions.push(iteratorMethod);
+                }
+            }
+        }
+    }
+}
+/**
+ * Facade the JS Error base class for error types.
+ */
+function generateErrorMetadata(releases) {
+    for (const release of releases) {
+        for (const moduleJson of release.script_modules) {
+            if (moduleJson.errors) {
+                for (const errorJson of moduleJson.errors) {
+                    if (errorJson.base_types === undefined) {
+                        errorJson.base_types = [];
+                    }
+                    errorJson.base_types.push({
+                        name: 'Error',
+                        is_bind_type: false,
+                        is_errorable: false,
+                    });
+                }
+            }
+        }
+    }
+}
+function renameTypesForTypeScript(releases) {
+    const fixType = (typeJson) => {
+        const mappedTypeName = typescriptTypeMappings[typeJson.name];
+        if (mappedTypeName) {
+            typeJson.original_name = typeJson.name;
+            typeJson.name = mappedTypeName;
+        }
+    };
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            utils.scanObjectForMemberWithAnyNamesFromList(scriptModule, MinecraftScriptModule_1.MinecraftTypeKeyList, (jsonObject, propertyName) => {
+                const typeJson = jsonObject[propertyName];
+                if (Array.isArray(typeJson)) {
+                    typeJson.forEach(fixType);
+                }
+                else {
+                    fixType(typeJson);
+                }
+            });
+        }
+    }
+}
+const typescriptArrayBufferTypeMappings = {
+    int8: 'Uint8Array',
+    uint8: 'Uint8Array',
+    int16: 'Int16Array',
+    uint16: 'Uint16Array',
+    int32: 'Int32Array',
+    uint32: 'Uint32Array',
+    int64: 'BigInt64Array',
+    uint64: 'BigUint64Array',
+    float: 'Float32Array',
+    double: 'Float64Array',
+};
+function generateArrayBufferTypes(releases) {
+    const fixType = (typeJson) => {
+        const mappedTypeName = typescriptArrayBufferTypeMappings[typeJson.name];
+        if (mappedTypeName) {
+            typeJson.original_name = typeJson.name;
+            typeJson.name = mappedTypeName;
+        }
+    };
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            utils.scanObjectForMemberWithAnyNamesFromList(scriptModule, ['data_buffer_type'], (jsonObject, propertyName) => {
+                const typeJson = jsonObject[propertyName];
+                if (Array.isArray(typeJson)) {
+                    typeJson.forEach(fixType);
+                }
+                else {
+                    fixType(typeJson);
+                }
+            });
+        }
+    }
+}
+function removeDuplicateVariantTypes(releases) {
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            utils.scanObjectForMemberWithName(scriptModule, 'variant_types', jsonObject => {
+                jsonObject.variant_types = jsonObject.variant_types.filter((item, index, self) => {
+                    return (index ===
+                        self.findIndex(value => {
+                            return value.name === item.name;
+                        }));
+                });
+            });
+        }
+    }
+}
+function escapeNameIfNeeded(objectWithName) {
+    const name = objectWithName.name;
+    objectWithName.ts_name_should_escape = false;
+    if (objectWithName.disable_unsafe_name_check) {
+        return;
+    }
+    if (escapedWords.indexOf(name) !== -1) {
+        objectWithName.ts_name_should_escape = true;
+    }
+    else if (name.includes(' ')) {
+        objectWithName.ts_name_should_escape = true;
+    }
+    else if (name.includes('.')) {
+        objectWithName.ts_name_should_escape = true;
+    } // Starts with number
+    else if (/^\d/.test(name)) {
+        objectWithName.ts_name_should_escape = true;
+    }
+}
+/**
+ * Words that must be escaped for TypeScript generation.
+ *
+ * See: https://github.com/microsoft/TypeScript/issues/2536#issuecomment-87194347
+ */
+const escapedWords = [
+    // Reserved Words
+    'break',
+    'case',
+    'catch',
+    'class',
+    'const',
+    'continue',
+    'debugger',
+    'default',
+    'delete',
+    'do',
+    'else',
+    'enum',
+    'export',
+    'extends',
+    'false',
+    'finally',
+    'for',
+    'function',
+    'if',
+    'import',
+    'in',
+    'instanceof',
+    'new',
+    'null',
+    'return',
+    'super',
+    'switch',
+    'this',
+    'throw',
+    'true',
+    'try',
+    'typeof',
+    'var',
+    'void',
+    'while',
+    'with',
+    // Strict Mode Reserved Words
+    'as',
+    'implements',
+    'interface',
+    'let',
+    'package',
+    'private',
+    'protected',
+    'public',
+    'static',
+    'yield',
+    // Contextual Keywords
+    'any',
+    'boolean',
+    'constructor',
+    'declare',
+    'get',
+    'module',
+    'require',
+    'number',
+    'set',
+    'string',
+    'symbol',
+    'type',
+    'from',
+    'of',
+];
+function markNamesThatShouldBeEscaped(releases) {
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            for (const functionJson of scriptModule.functions ?? []) {
+                escapeNameIfNeeded(functionJson);
+            }
+            for (const classJson of scriptModule.classes ?? []) {
+                for (const propertyJson of classJson.properties ?? []) {
+                    escapeNameIfNeeded(propertyJson);
+                }
+                for (const constantJson of classJson.constants ?? []) {
+                    escapeNameIfNeeded(constantJson);
+                }
+                for (const functionJson of classJson.functions ?? []) {
+                    escapeNameIfNeeded(functionJson);
+                }
+            }
+            for (const interfaceJson of scriptModule.interfaces ?? []) {
+                for (const propertyJson of interfaceJson.properties ?? []) {
+                    escapeNameIfNeeded(propertyJson);
+                }
+            }
+            for (const enumJson of scriptModule.enums ?? []) {
+                for (const constantJson of enumJson.constants) {
+                    escapeNameIfNeeded(constantJson);
+                }
+            }
+        }
+    }
+}
+function flagTSComments(obj) {
+    // Has Comments
+    if (obj.has_comments ||
+        obj.has_defaults ||
+        obj.has_errors ||
+        obj.is_prerelease ||
+        obj.is_deprecated ||
+        obj.has_privilege_comments ||
+        obj.has_runtime_conditions) {
+        obj.ts_has_comments = true;
+    }
+    else {
+        obj.ts_has_comments = false;
+    }
+    // Has Remarks
+    if (obj.has_comments || obj.has_privilege_comments) {
+        obj.ts_has_remarks = true;
+    }
+    else {
+        obj.ts_has_remarks = false;
+    }
+    if (obj.has_privilege_comments || obj.has_defaults || obj.has_errors) {
+        obj.msdocs_has_comments = true;
+    }
+}
+function flagTSCommentsArray(obj) {
+    for (const subObj of obj) {
+        flagTSComments(subObj);
+    }
+}
+/**
+ * Flag objects that should have comments.
+ */
+function markObjectsWithComments(releases) {
+    for (const release of releases) {
+        for (const scriptModule of release.script_modules) {
+            flagTSCommentsArray(scriptModule.constants ?? []);
+            flagTSCommentsArray(scriptModule.objects ?? []);
+            flagTSCommentsArray(scriptModule.type_aliases ?? []);
+            for (const enumJson of scriptModule.enums ?? []) {
+                flagTSComments(enumJson);
+                flagTSCommentsArray(enumJson.constants ?? []);
+            }
+            for (const classJson of scriptModule.classes ?? []) {
+                flagTSComments(classJson);
+                flagTSCommentsArray(classJson.properties ?? []);
+                flagTSCommentsArray(classJson.constants ?? []);
+                for (const functionJson of classJson.functions ?? []) {
+                    flagTSComments(functionJson);
+                    flagTSCommentsArray(functionJson.arguments ?? []);
+                }
+            }
+            for (const interfaceJson of scriptModule.interfaces ?? []) {
+                flagTSComments(interfaceJson);
+                flagTSCommentsArray(interfaceJson.properties ?? []);
+                for (const functionJson of interfaceJson.functions ?? []) {
+                    flagTSComments(functionJson);
+                    flagTSCommentsArray(functionJson.arguments ?? []);
+                }
+            }
+            for (const functionJson of scriptModule.functions ?? []) {
+                flagTSComments(functionJson);
+                flagTSCommentsArray(functionJson.arguments ?? []);
+            }
+            for (const errorJson of scriptModule.errors ?? []) {
+                flagTSComments(errorJson);
+                flagTSCommentsArray(errorJson.properties ?? []);
+            }
+        }
+    }
+}
+exports.TypeScriptFilters = {
+    id: 'ts',
+    filtersBeforeCommon: [
+        ['iterator_markup', generateIteratorMetadata],
+        ['generate_error_metadata', generateErrorMetadata],
+    ],
+    filters: [
+        ['generate_array_buffer_types', generateArrayBufferTypes],
+        ['rename_types', renameTypesForTypeScript],
+        ['remove_duplicate_variant_types', removeDuplicateVariantTypes],
+        ['mark_names_that_should_be_escaped', markNamesThatShouldBeEscaped],
+        ['mark_comments', markObjectsWithComments],
+    ],
+};
+//# sourceMappingURL=TypeScriptFilters.js.map

package/lib/filters/TypeScriptFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypeScriptFilters.js","sourceRoot":"","sources":["../../src/filters/TypeScriptFilters.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;AAGlC,4EAK0C;AAC1C,oDAAsC;AAGtC,MAAM,sBAAsB,GAA2B;IACnD,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;CACnB,CAAC;AAEF;;GAEG;AACH,SAAS,wBAAwB,CAAC,QAA4B;IAC1D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;gBACvB,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;oBAC3C,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;wBACtB,SAAS;oBACb,CAAC;oBAED,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC;oBAExC,MAAM,UAAU,GAAsB;wBAClC,IAAI,EAAE,MAAM;wBACZ,SAAS,EAAE,EAAE;wBACb,cAAc,EAAE,KAAK;wBACrB,SAAS,EAAE,IAAI;wBACf,SAAS,EAAE,KAAK;wBAChB,WAAW,EAAE;4BACT,IAAI,EAAE,iBAAiB;4BACvB,aAAa,EAAE,YAAY;4BAC3B,YAAY,EAAE,KAAK;4BACnB,YAAY,EAAE,KAAK;yBACtB;qBACJ,CAAC;oBAEF,MAAM,cAAc,GAAsB;wBACtC,IAAI,EAAE,mBAAmB;wBACzB,yBAAyB,EAAE,IAAI;wBAC/B,SAAS,EAAE,EAAE;wBACb,cAAc,EAAE,KAAK;wBACrB,SAAS,EAAE,IAAI;wBACf,SAAS,EAAE,KAAK;wBAChB,WAAW,EAAE;4BACT,IAAI,EAAE,UAAU;4BAChB,aAAa,EAAE,YAAY;4BAC3B,YAAY,EAAE,KAAK;4BACnB,YAAY,EAAE,KAAK;yBACtB;qBACJ,CAAC;oBAEF,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;wBACvB,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC;oBAC7B,CAAC;oBACD,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACrC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC7C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,QAA4B;IACvD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC9C,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gBACpB,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;oBACxC,IAAI,SAAS,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;wBACrC,SAAS,CAAC,UAAU,GAAG,EAAE,CAAC;oBAC9B,CAAC;oBAED,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC;wBACtB,IAAI,EAAE,OAAO;wBACb,YAAY,EAAE,KAAK;wBACnB,YAAY,EAAE,KAAK;qBACtB,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,wBAAwB,CAAC,QAA4B;IAC1D,MAAM,OAAO,GAAG,CAAC,QAAuB,EAAE,EAAE;QACxC,MAAM,cAAc,GAAG,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,cAAc,EAAE,CAAC;YACjB,QAAQ,CAAC,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;YACvC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC;QACnC,CAAC;IACL,CAAC,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,KAAK,CAAC,uCAAuC,CACzC,YAAY,EACZ,4CAAoB,EACpB,CAAC,UAA2D,EAAE,YAAoB,EAAE,EAAE;gBAClF,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;gBAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1B,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;qBAAM,CAAC;oBACJ,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACtB,CAAC;YACL,CAAC,CACJ,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC;AAED,MAAM,iCAAiC,GAA2B;IAC9D,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,aAAa;IACrB,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,aAAa;IACrB,KAAK,EAAE,eAAe;IACtB,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,cAAc;IACrB,MAAM,EAAE,cAAc;CACzB,CAAC;AACF,SAAS,wBAAwB,CAAC,QAA4B;IAC1D,MAAM,OAAO,GAAG,CAAC,QAAuB,EAAE,EAAE;QACxC,MAAM,cAAc,GAAG,iCAAiC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,cAAc,EAAE,CAAC;YACjB,QAAQ,CAAC,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;YACvC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC;QACnC,CAAC;IACL,CAAC,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,KAAK,CAAC,uCAAuC,CACzC,YAAY,EACZ,CAAC,kBAAkB,CAAC,EACpB,CAAC,UAA2D,EAAE,YAAoB,EAAE,EAAE;gBAClF,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;gBAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1B,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;qBAAM,CAAC;oBACJ,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACtB,CAAC;YACL,CAAC,CACJ,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,2BAA2B,CAAC,QAA4B;IAC7D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,KAAK,CAAC,2BAA2B,CAAC,YAAY,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE;gBAC1E,UAAU,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;oBAC7E,OAAO,CACH,KAAK;wBACL,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;4BACnB,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC;wBACpC,CAAC,CAAC,CACL,CAAC;gBACN,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,cAI3B;IACG,MAAM,IAAI,GAAW,cAAc,CAAC,IAAI,CAAC;IACzC,cAAc,CAAC,qBAAqB,GAAG,KAAK,CAAC;IAE7C,IAAI,cAAc,CAAC,yBAAyB,EAAE,CAAC;QAC3C,OAAO;IACX,CAAC;IAED,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpC,cAAc,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAChD,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,cAAc,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAChD,CAAC;SAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,cAAc,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAChD,CAAC,CAAC,qBAAqB;SAClB,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,cAAc,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAChD,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,YAAY,GAAa;IAC3B,iBAAiB;IACjB,OAAO;IACP,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,SAAS;IACT,QAAQ;IACR,IAAI;IACJ,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,OAAO;IACP,SAAS;IACT,KAAK;IACL,UAAU;IACV,IAAI;IACJ,QAAQ;IACR,IAAI;IACJ,YAAY;IACZ,KAAK;IACL,MAAM;IACN,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,KAAK;IACL,MAAM;IACN,OAAO;IACP,MAAM;IACN,6BAA6B;IAC7B,IAAI;IACJ,YAAY;IACZ,WAAW;IACX,KAAK;IACL,SAAS;IACT,SAAS;IACT,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,sBAAsB;IACtB,KAAK;IACL,SAAS;IACT,aAAa;IACb,SAAS;IACT,KAAK;IACL,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,MAAM;IACN,IAAI;CACP,CAAC;AAEF,SAAS,4BAA4B,CAAC,QAA4B;IAC9D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;gBACtD,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACrC,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;gBACjD,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;oBACpD,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;gBAED,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;oBACnD,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;gBAED,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;oBACnD,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;YACL,CAAC;YAED,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;gBACxD,KAAK,MAAM,YAAY,IAAI,aAAa,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;oBACxD,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;YACL,CAAC;YAED,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC9C,KAAK,MAAM,YAAY,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;oBAC5C,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,GAAuB;IAC3C,eAAe;IACf,IACI,GAAG,CAAC,YAAY;QAChB,GAAG,CAAC,YAAY;QAChB,GAAG,CAAC,UAAU;QACd,GAAG,CAAC,aAAa;QACjB,GAAG,CAAC,aAAa;QACjB,GAAG,CAAC,sBAAsB;QAC1B,GAAG,CAAC,sBAAsB,EAC5B,CAAC;QACC,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;IAC/B,CAAC;SAAM,CAAC;QACJ,GAAG,CAAC,eAAe,GAAG,KAAK,CAAC;IAChC,CAAC;IAED,cAAc;IACd,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,sBAAsB,EAAE,CAAC;QACjD,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC;IAC9B,CAAC;SAAM,CAAC;QACJ,GAAG,CAAC,cAAc,GAAG,KAAK,CAAC;IAC/B,CAAC;IAED,IAAI,GAAG,CAAC,sBAAsB,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnE,GAAG,CAAC,mBAAmB,GAAG,IAAI,CAAC;IACnC,CAAC;AACL,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAyB;IAClD,KAAK,MAAM,MAAM,IAAI,GAAG,EAAE,CAAC;QACvB,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,QAA4B;IACzD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,mBAAmB,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YAClD,mBAAmB,CAAC,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAChD,mBAAmB,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;YAErD,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC9C,cAAc,CAAC,QAAQ,CAAC,CAAC;gBACzB,mBAAmB,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YAClD,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;gBACjD,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC1B,mBAAmB,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;gBAChD,mBAAmB,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;gBAE/C,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;oBACnD,cAAc,CAAC,YAAY,CAAC,CAAC;oBAC7B,mBAAmB,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;gBACtD,CAAC;YACL,CAAC;YAED,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;gBACxD,cAAc,CAAC,aAAa,CAAC,CAAC;gBAC9B,mBAAmB,CAAC,aAAa,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;gBAEpD,KAAK,MAAM,YAAY,IAAI,aAAa,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;oBACvD,cAAc,CAAC,YAAY,CAAC,CAAC;oBAC7B,mBAAmB,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;gBACtD,CAAC;YACL,CAAC;YAED,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;gBACtD,cAAc,CAAC,YAAY,CAAC,CAAC;gBAC7B,mBAAmB,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YACtD,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;gBAChD,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC1B,mBAAmB,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAEY,QAAA,iBAAiB,GAAgB;IAC1C,EAAE,EAAE,IAAI;IACR,mBAAmB,EAAE;QACjB,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;QAC7C,CAAC,yBAAyB,EAAE,qBAAqB,CAAC;KACrD;IACD,OAAO,EAAE;QACL,CAAC,6BAA6B,EAAE,wBAAwB,CAAC;QACzD,CAAC,cAAc,EAAE,wBAAwB,CAAC;QAC1C,CAAC,gCAAgC,EAAE,2BAA2B,CAAC;QAC/D,CAAC,mCAAmC,EAAE,4BAA4B,CAAC;QACnE,CAAC,eAAe,EAAE,uBAAuB,CAAC;KAC7C;CACJ,CAAC"}

package/lib/filters/index.d.ts

@@ -0,0 +1,4 @@
+export * from './CommonFilters';
+export * from './Filters';
+export * from './MarkdownFilters';
+export * from './TypeScriptFilters';

package/lib/filters/index.js

@@ -0,0 +1,23 @@
+"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("./CommonFilters"), exports);
+__exportStar(require("./Filters"), exports);
+__exportStar(require("./MarkdownFilters"), exports);
+__exportStar(require("./TypeScriptFilters"), exports);
+//# sourceMappingURL=index.js.map

package/lib/filters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/filters/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;AAElC,kDAAgC;AAChC,4CAA0B;AAC1B,oDAAkC;AAClC,sDAAoC"}

package/lib/generator.d.ts

@@ -0,0 +1,8 @@
+import { GenerateOptions } from './Config';
+/**
+ * Main logic of the Minecraft API Docs Generator.
+ *
+ * Processes API module JSON metadata files, transforming them with filter functions,
+ * and renders them into output files with configured markup generators.
+ */
+export declare function generate(options: GenerateOptions): Promise<void>;