@typespec/tspd 0.47.0-dev.0 → 0.69.0-dev.1

package/dist/src/ref-doc/experimental.js

@@ -2,32 +2,31 @@ import { compile, createDiagnosticCollector, joinPaths, NodeHost, } from "@types
 import { mkdir, readFile, writeFile } from "fs/promises";
 import prettier from "prettier";
 import { generateJsApiDocs } from "./api-docs.js";
-import { renderToDocusaurusMarkdown } from "./emitters/docusaurus.js";
 import { renderReadme } from "./emitters/markdown.js";
+import { renderToAstroStarlightMarkdown } from "./emitters/starlight.js";
 import { extractLibraryRefDocs, extractRefDocs } from "./extractor.js";
 /**
  * @experimental this is for experimental and is for internal use only. Breaking change to this API can happen at anytime.
  */
-export async function generateLibraryDocs(libraryPath, outputDir, skipJSApi = false) {
+export async function generateLibraryDocs(libraryPath, outputDir, options = {}) {
     const diagnostics = createDiagnosticCollector();
     const pkgJson = await readPackageJson(libraryPath);
     const refDoc = diagnostics.pipe(await extractLibraryRefDocs(libraryPath));
-    const files = renderToDocusaurusMarkdown(refDoc);
+    const files = renderToAstroStarlightMarkdown(refDoc);
     await mkdir(outputDir, { recursive: true });
     const config = await prettier.resolveConfig(libraryPath);
     for (const [name, content] of Object.entries(files)) {
         const formatted = await formatMarkdown(name, content, config);
         await writeFile(joinPaths(outputDir, name), formatted);
     }
-    const readme = await formatMarkdown(joinPaths(libraryPath, "README.md"), await renderReadme(refDoc, libraryPath), config !== null && config !== void 0 ? config : {});
+    const readme = await formatMarkdown(joinPaths(libraryPath, "README.md"), await renderReadme(refDoc, libraryPath), config ?? {});
     await writeFile(joinPaths(libraryPath, "README.md"), readme);
-    if (pkgJson.main && !skipJSApi) {
+    if (pkgJson.main && !options.skipJSApi) {
         await generateJsApiDocs(libraryPath, joinPaths(outputDir, "js-api"));
     }
     return diagnostics.diagnostics;
 }
 export async function resolveLibraryRefDocsBase(libraryPath, options = {}) {
-    var _a;
     const diagnostics = createDiagnosticCollector();
     const pkgJson = await readPackageJson(libraryPath);
     if (pkgJson.tspMain) {
@@ -36,7 +35,7 @@ export async function resolveLibraryRefDocsBase(libraryPath, options = {}) {
             parseOptions: { comments: true, docs: true },
         });
         const refDoc = diagnostics.pipe(extractRefDocs(program, options));
-        for (const diag of (_a = program.diagnostics) !== null && _a !== void 0 ? _a : []) {
+        for (const diag of program.diagnostics ?? []) {
             diagnostics.add(diag);
         }
         return diagnostics.wrap(refDoc);
@@ -50,7 +49,7 @@ async function readPackageJson(libraryPath) {
 async function formatMarkdown(filename, content, options) {
     try {
         return await prettier.format(content, {
-            ...(options !== null && options !== void 0 ? options : {}),
+            ...(options ?? {}),
             parser: "markdown",
         });
     }

package/dist/src/ref-doc/experimental.js.map

@@ -1 +1 @@
-{"version":3,"file":"experimental.js","sourceRoot":"","sources":["../../../src/ref-doc/experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,yBAAyB,EAEzB,SAAS,EACT,QAAQ,GAET,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAwB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAG7F;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,WAAmB,EACnB,SAAiB,EACjB,YAAqB,KAAK;IAE1B,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1E,MAAM,KAAK,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACzD,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,cAAc,CACjC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,EACnC,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,EACvC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CACb,CAAC;IACF,MAAM,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QAC/B,MAAM,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,WAAW,CAAC,WAAW,CAAC;AACjC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,WAAmB,EACnB,UAAgC,EAAE;;IAElC,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE;YAC5C,YAAY,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;SAC7C,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAClE,KAAK,MAAM,IAAI,IAAI,MAAA,OAAO,CAAC,WAAW,mCAAI,EAAE,EAAE,CAAC;YAC7C,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,WAAmB;IAChD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;IACtE,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;AACvC,CAAC;AACD,KAAK,UAAU,cAAc,CAC3B,QAAgB,EAChB,OAAe,EACf,OAAgC;IAEhC,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE;YACpC,GAAG,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;YAClB,MAAM,EAAE,UAAU;SACnB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,+BAA+B,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC"}
+{"version":3,"file":"experimental.js","sourceRoot":"","sources":["../../../src/ref-doc/experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,yBAAyB,EAEzB,SAAS,EACT,QAAQ,GAET,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAwB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAM7F;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,WAAmB,EACnB,SAAiB,EACjB,UAAsC,EAAE;IAExC,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1E,MAAM,KAAK,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACzD,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,cAAc,CACjC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,EACnC,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,EACvC,MAAM,IAAI,EAAE,CACb,CAAC;IACF,MAAM,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,WAAW,CAAC,WAAW,CAAC;AACjC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,WAAmB,EACnB,UAAgC,EAAE;IAElC,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE;YAC5C,YAAY,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;SAC7C,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAClE,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;YAC7C,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,WAAmB;IAChD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;IACtE,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;AACvC,CAAC;AACD,KAAK,UAAU,cAAc,CAC3B,QAAgB,EAChB,OAAe,EACf,OAAgC;IAEhC,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE;YACpC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;YAClB,MAAM,EAAE,UAAU;SACnB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,+BAA+B,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC"}

package/dist/src/ref-doc/extractor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extractor.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/extractor.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,UAAU,EAwBV,OAAO,EAQR,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAcL,qBAAqB,EACrB,kBAAkB,EAEnB,MAAM,YAAY,CAAC;AAGpB,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,CAAC,qBAAqB,EAAE,SAAS,UAAU,EAAE,CAAC,CAAC,CAoCzD;AAOD,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAkCD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,oBAAyB,GACjC,CAAC,kBAAkB,EAAE,SAAS,UAAU,EAAE,CAAC,CAwF7C"}
+{"version":3,"file":"extractor.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/extractor.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,UAAU,EAyBV,OAAO,EASR,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAmBL,qBAAqB,EACrB,kBAAkB,EAEnB,MAAM,YAAY,CAAC;AAmBpB,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,CAAC,qBAAqB,EAAE,SAAS,UAAU,EAAE,CAAC,CAAC,CAuCzD;AAOD,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAmCD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,oBAAyB,GACjC,CAAC,kBAAkB,EAAE,SAAS,UAAU,EAAE,CAAC,CAqG7C"}

package/dist/src/ref-doc/extractor.js

@@ -1,10 +1,13 @@
-import { compile, compilerAssert, createDiagnosticCollector, getDoc, getLocationContext, getSourceLocation, getTypeName, isDeclaredType, isTemplateDeclaration, joinPaths, navigateProgram, navigateTypesInNamespace, NodeHost, NoTarget, resolvePath, SyntaxKind, } from "@typespec/compiler";
+import { compile, compilerAssert, createDiagnosticCollector, getDeprecated, getDoc, getLocationContext, getSourceLocation, getTypeName, isDeclaredType, isTemplateDeclaration, joinPaths, navigateProgram, navigateTypesInNamespace, NodeHost, NoTarget, resolveLinterDefinition, resolvePath, } from "@typespec/compiler";
+import { SyntaxKind } from "@typespec/compiler/ast";
 import { readFile } from "fs/promises";
 import { pathToFileURL } from "url";
 import { reportDiagnostic } from "./lib.js";
 import { getQualifier, getTypeSignature } from "./utils/type-signature.js";
+function getExport(pkgJson, path, condition) {
+    return pkgJson.exports?.[path]?.[condition];
+}
 export async function extractLibraryRefDocs(libraryPath) {
-    var _a, _b, _c;
     const diagnostics = createDiagnosticCollector();
     const pkgJson = await readPackageJson(libraryPath);
     const refDoc = {
@@ -12,29 +15,32 @@ export async function extractLibraryRefDocs(libraryPath) {
         description: pkgJson.description,
         packageJson: pkgJson,
         namespaces: [],
+        getNamedTypeRefDoc: (type) => undefined,
     };
-    if (pkgJson.tspMain) {
-        const main = resolvePath(libraryPath, pkgJson.tspMain);
+    const tspMain = getExport(pkgJson, ".", "typespec");
+    if (tspMain) {
+        const main = resolvePath(libraryPath, tspMain);
         const program = await compile(NodeHost, main, {
             parseOptions: { comments: true, docs: true },
         });
-        refDoc.namespaces = diagnostics.pipe(extractRefDocs(program)).namespaces;
-        for (const diag of (_a = program.diagnostics) !== null && _a !== void 0 ? _a : []) {
+        const tspEmitter = diagnostics.pipe(extractRefDocs(program));
+        Object.assign(refDoc, tspEmitter);
+        for (const diag of program.diagnostics ?? []) {
             diagnostics.add(diag);
         }
     }
-    if (pkgJson.main) {
-        const entrypoint = await import(pathToFileURL(resolvePath(libraryPath, pkgJson.main)).href);
+    const main = getExport(pkgJson, ".", "import") ?? getExport(pkgJson, ".", "default");
+    if (main) {
+        const entrypoint = await import(pathToFileURL(resolvePath(libraryPath, main)).href);
         const lib = entrypoint.$lib;
-        if ((_b = lib === null || lib === void 0 ? void 0 : lib.emitter) === null || _b === void 0 ? void 0 : _b.options) {
+        if (lib?.emitter?.options) {
             refDoc.emitter = {
                 options: extractEmitterOptionsRefDoc(lib.emitter.options),
             };
         }
-        // eslint-disable-next-line deprecation/deprecation
-        const linter = (_c = entrypoint.$linter) !== null && _c !== void 0 ? _c : lib === null || lib === void 0 ? void 0 : lib.linter;
+        const linter = entrypoint.$linter;
         if (lib && linter) {
-            refDoc.linter = extractLinterRefDoc(lib.name, linter);
+            refDoc.linter = extractLinterRefDoc(lib.name, resolveLinterDefinition(lib.name, linter));
         }
     }
     return diagnostics.wrap(refDoc);
@@ -44,10 +50,9 @@ async function readPackageJson(libraryPath) {
     return JSON.parse(buffer.toString());
 }
 function resolveNamespaces(program, options) {
-    var _a;
     const diagnostics = createDiagnosticCollector();
     let namespaceTypes = [];
-    const { include, exclude } = (_a = options === null || options === void 0 ? void 0 : options.namespaces) !== null && _a !== void 0 ? _a : {};
+    const { include, exclude } = options?.namespaces ?? {};
     if (include) {
         namespaceTypes = include
             .map((x) => diagnostics.pipe(program.resolveTypeReference(x)))
@@ -74,12 +79,14 @@ function resolveNamespaces(program, options) {
 export function extractRefDocs(program, options = {}) {
     const diagnostics = createDiagnosticCollector();
     const namespaceTypes = diagnostics.pipe(resolveNamespaces(program, options));
-    const refDoc = {
-        namespaces: [],
-    };
+    const typeMapping = new Map();
+    const namespaces = [];
     for (const namespace of namespaceTypes) {
+        const name = getTypeName(namespace);
         const namespaceDoc = {
-            id: getTypeName(namespace),
+            kind: "namespace",
+            id: name,
+            name,
             decorators: [],
             operations: [],
             interfaces: [],
@@ -88,24 +95,28 @@ export function extractRefDocs(program, options = {}) {
             unions: [],
             scalars: [],
         };
-        refDoc.namespaces.push(namespaceDoc);
+        namespaces.push(namespaceDoc);
+        function collectType(type, refDoc, array) {
+            typeMapping.set(type, refDoc);
+            array.push(refDoc);
+        }
         navigateTypesInNamespace(namespace, {
             decorator(dec) {
-                namespaceDoc.decorators.push(extractDecoratorRefDoc(program, dec));
+                collectType(dec, extractDecoratorRefDoc(program, dec), namespaceDoc.decorators);
             },
             operation(operation) {
                 if (!isDeclaredType(operation)) {
                     return;
                 }
                 if (operation.interface === undefined) {
-                    namespaceDoc.operations.push(extractOperationRefDoc(program, operation, undefined));
+                    collectType(operation, extractOperationRefDoc(program, operation, undefined), namespaceDoc.operations);
                 }
             },
             interface(iface) {
                 if (!isDeclaredType(iface)) {
                     return;
                 }
-                namespaceDoc.interfaces.push(extractInterfaceRefDocs(program, iface));
+                collectType(iface, extractInterfaceRefDocs(program, iface), namespaceDoc.interfaces);
             },
             model(model) {
                 if (!isDeclaredType(model)) {
@@ -114,29 +125,29 @@ export function extractRefDocs(program, options = {}) {
                 if (model.name === "") {
                     return;
                 }
-                namespaceDoc.models.push(extractModelRefDocs(program, model));
+                collectType(model, extractModelRefDocs(program, model), namespaceDoc.models);
             },
             enum(e) {
                 if (!isDeclaredType(e)) {
                     return;
                 }
-                namespaceDoc.enums.push(extractEnumRefDoc(program, e));
+                collectType(e, extractEnumRefDoc(program, e), namespaceDoc.enums);
             },
             union(union) {
                 if (!isDeclaredType(union)) {
                     return;
                 }
                 if (union.name !== undefined) {
-                    namespaceDoc.unions.push(extractUnionRefDocs(program, union));
+                    collectType(union, extractUnionRefDocs(program, union), namespaceDoc.unions);
                 }
             },
             scalar(scalar) {
-                namespaceDoc.scalars.push(extractScalarRefDocs(program, scalar));
+                collectType(scalar, extractScalarRefDocs(program, scalar), namespaceDoc.scalars);
             },
         }, { includeTemplateDeclaration: true, skipSubNamespaces: true });
     }
-    sort(refDoc.namespaces);
-    for (const namespace of refDoc.namespaces) {
+    sort(namespaces);
+    for (const namespace of namespaces) {
         sort(namespace.decorators);
         sort(namespace.enums);
         sort(namespace.interfaces);
@@ -148,25 +159,27 @@ export function extractRefDocs(program, options = {}) {
     function sort(arr) {
         arr.sort((a, b) => a.id.localeCompare(b.id, "en"));
     }
-    return diagnostics.wrap(refDoc);
+    return diagnostics.wrap({
+        namespaces,
+        getNamedTypeRefDoc: (type) => typeMapping.get(type),
+    });
 }
 function extractTemplateParameterDocs(program, type) {
     if (isTemplateDeclaration(type)) {
         const templateParamsDocs = getTemplateParameterDocs(type);
         return type.node.templateParameters.map((x) => {
-            var _a, _b;
             const doc = templateParamsDocs.get(x.id.sv);
             if (doc === undefined || doc === "") {
                 reportDiagnostic(program, {
                     code: "documentation-missing",
                     messageId: "templateParam",
-                    format: { name: (_a = type.name) !== null && _a !== void 0 ? _a : "", param: x.id.sv },
+                    format: { name: type.name ?? "", param: x.id.sv },
                     target: NoTarget,
                 });
             }
             return {
                 name: x.id.sv,
-                doc: (_b = templateParamsDocs.get(x.id.sv)) !== null && _b !== void 0 ? _b : "",
+                doc: templateParamsDocs.get(x.id.sv) ?? "",
             };
         });
     }
@@ -175,19 +188,18 @@ function extractTemplateParameterDocs(program, type) {
     }
 }
 function extractInterfaceRefDocs(program, iface) {
-    var _a;
     const doc = extractMainDoc(program, iface);
     if (doc === undefined || doc === "") {
         reportDiagnostic(program, {
             code: "documentation-missing",
             messageId: "interface",
-            format: { name: (_a = iface.name) !== null && _a !== void 0 ? _a : "" },
+            format: { name: iface.name ?? "" },
             target: NoTarget,
         });
     }
     return {
-        id: getNamedTypeId(iface),
-        name: iface.name,
+        kind: "interface",
+        ...extractBase(program, iface),
         signature: getTypeSignature(iface),
         type: iface,
         templateParameters: extractTemplateParameterDocs(program, iface),
@@ -196,15 +208,22 @@ function extractInterfaceRefDocs(program, iface) {
         examples: extractExamples(iface),
     };
 }
+function extractBase(program, type) {
+    const deprecated = getDeprecated(program, type);
+    return {
+        id: getNamedTypeId(type),
+        name: type.name,
+        deprecated: deprecated ? { message: deprecated } : undefined,
+    };
+}
 function extractOperationRefDoc(program, operation, interfaceName) {
-    var _a, _b;
     const doc = extractMainDoc(program, operation);
     if (doc === undefined || doc === "") {
         if (operation.interface !== undefined) {
             reportDiagnostic(program, {
                 code: "documentation-missing",
                 messageId: "interfaceOperation",
-                format: { name: (_a = `${operation.interface.name}.${operation.name}`) !== null && _a !== void 0 ? _a : "" },
+                format: { name: `${operation.interface.name}.${operation.name}` },
                 target: NoTarget,
             });
         }
@@ -212,13 +231,14 @@ function extractOperationRefDoc(program, operation, interfaceName) {
             reportDiagnostic(program, {
                 code: "documentation-missing",
                 messageId: "operation",
-                format: { name: (_b = operation.name) !== null && _b !== void 0 ? _b : "" },
+                format: { name: operation.name ?? "" },
                 target: NoTarget,
             });
         }
     }
     return {
-        id: getNamedTypeId(operation),
+        kind: "operation",
+        ...extractBase(program, operation),
         name: interfaceName ? `${interfaceName}.${operation.name}` : operation.name,
         signature: getTypeSignature(operation),
         type: operation,
@@ -228,10 +248,8 @@ function extractOperationRefDoc(program, operation, interfaceName) {
     };
 }
 function extractDecoratorRefDoc(program, decorator) {
-    var _a;
     const paramDoc = getParmeterDocs(decorator);
     const parameters = decorator.parameters.map((x) => {
-        var _a;
         const docVal = paramDoc.get(x.name);
         if (docVal === undefined || docVal === "") {
             reportDiagnostic(program, {
@@ -242,8 +260,9 @@ function extractDecoratorRefDoc(program, decorator) {
             });
         }
         return {
+            kind: "decorator",
             type: x,
-            doc: (_a = paramDoc.get(x.name)) !== null && _a !== void 0 ? _a : "",
+            doc: paramDoc.get(x.name) ?? "",
             name: x.name,
             optional: x.optional,
             rest: x.rest,
@@ -260,8 +279,8 @@ function extractDecoratorRefDoc(program, decorator) {
         });
     }
     return {
-        id: getNamedTypeId(decorator),
-        name: decorator.name,
+        kind: "decorator",
+        ...extractBase(program, decorator),
         type: decorator,
         signature: getTypeSignature(decorator),
         doc: mainDoc,
@@ -270,7 +289,7 @@ function extractDecoratorRefDoc(program, decorator) {
         otherTags: [],
         target: {
             type: decorator.target,
-            doc: (_a = paramDoc.get(decorator.target.name)) !== null && _a !== void 0 ? _a : "",
+            doc: paramDoc.get(decorator.target.name) ?? "",
             name: decorator.target.name,
             optional: decorator.target.optional,
             rest: decorator.target.rest,
@@ -278,40 +297,60 @@ function extractDecoratorRefDoc(program, decorator) {
     };
 }
 function extractModelRefDocs(program, type) {
-    var _a;
     const doc = extractMainDoc(program, type);
     if (doc === undefined || doc === "") {
         reportDiagnostic(program, {
             code: "documentation-missing",
             messageId: "model",
-            format: { name: (_a = type.name) !== null && _a !== void 0 ? _a : "" },
+            format: { name: type.name ?? "" },
             target: NoTarget,
         });
     }
     return {
-        id: getNamedTypeId(type),
-        name: type.name,
+        kind: "model",
+        ...extractBase(program, type),
         signature: getTypeSignature(type),
         type,
         templateParameters: extractTemplateParameterDocs(program, type),
         doc: doc,
         examples: extractExamples(type),
+        properties: new Map([...type.properties.values()].map((x) => [x.name, extractModelPropertyRefDocs(program, x)])),
+    };
+}
+function extractModelPropertyRefDocs(program, type) {
+    const doc = extractMainDoc(program, type);
+    return {
+        ...extractBase(program, type),
+        signature: getTypeSignature(type),
+        type,
+        doc: doc,
+        examples: extractExamples(type),
     };
 }
 function extractEnumRefDoc(program, type) {
-    var _a;
     const doc = extractMainDoc(program, type);
     if (doc === undefined || doc === "") {
         reportDiagnostic(program, {
             code: "documentation-missing",
             messageId: "enum",
-            format: { name: (_a = type.name) !== null && _a !== void 0 ? _a : "" },
+            format: { name: type.name ?? "" },
             target: NoTarget,
         });
     }
     return {
-        id: getNamedTypeId(type),
-        name: type.name,
+        kind: "enum",
+        ...extractBase(program, type),
+        signature: getTypeSignature(type),
+        type,
+        doc: doc,
+        examples: extractExamples(type),
+        members: new Map([...type.members.values()].map((x) => [x.name, extractEnumMemberRefDocs(program, x)])),
+    };
+}
+function extractEnumMemberRefDocs(program, type) {
+    const doc = extractMainDoc(program, type);
+    return {
+        ...extractBase(program, type),
         signature: getTypeSignature(type),
         type,
         doc: doc,
@@ -319,19 +358,18 @@ function extractEnumRefDoc(program, type) {
     };
 }
 function extractUnionRefDocs(program, type) {
-    var _a;
     const doc = extractMainDoc(program, type);
     if (doc === undefined || doc === "") {
         reportDiagnostic(program, {
             code: "documentation-missing",
             messageId: "union",
-            format: { name: (_a = type.name) !== null && _a !== void 0 ? _a : "" },
+            format: { name: type.name ?? "" },
             target: NoTarget,
         });
     }
     return {
-        id: getNamedTypeId(type),
-        name: type.name,
+        kind: "union",
+        ...extractBase(program, type),
         signature: getTypeSignature(type),
         type,
         templateParameters: extractTemplateParameterDocs(program, type),
@@ -340,19 +378,18 @@ function extractUnionRefDocs(program, type) {
     };
 }
 function extractScalarRefDocs(program, type) {
-    var _a;
     const doc = extractMainDoc(program, type);
     if (doc === undefined || doc === "") {
         reportDiagnostic(program, {
             code: "documentation-missing",
             messageId: "scalar",
-            format: { name: (_a = type.name) !== null && _a !== void 0 ? _a : "" },
+            format: { name: type.name ?? "" },
             target: NoTarget,
         });
     }
     return {
-        id: getNamedTypeId(type),
-        name: type.name,
+        kind: "scalar",
+        ...extractBase(program, type),
         signature: getTypeSignature(type),
         type,
         doc: doc,
@@ -360,19 +397,17 @@ function extractScalarRefDocs(program, type) {
     };
 }
 function extractMainDoc(program, type) {
-    var _a, _b, _c;
-    let mainDoc = "";
-    for (const doc of (_b = (_a = type.node) === null || _a === void 0 ? void 0 : _a.docs) !== null && _b !== void 0 ? _b : []) {
+    const mainDocs = [];
+    for (const doc of type.node?.docs ?? []) {
         for (const dContent of doc.content) {
-            mainDoc += dContent.text + "\n";
+            mainDocs.push(dContent.text);
         }
     }
-    return mainDoc !== "" ? mainDoc : (_c = getDoc(program, type)) !== null && _c !== void 0 ? _c : "";
+    return mainDocs.length > 0 ? mainDocs.join("\n") : (getDoc(program, type) ?? "");
 }
 function extractExamples(type) {
-    var _a, _b;
     const examples = [];
-    for (const doc of (_b = (_a = type.node) === null || _a === void 0 ? void 0 : _a.docs) !== null && _b !== void 0 ? _b : []) {
+    for (const doc of type.node?.docs ?? []) {
         for (const dTag of doc.tags) {
             if (dTag.kind === SyntaxKind.DocUnknownTag) {
                 if (dTag.tagName.sv === "example") {
@@ -384,12 +419,11 @@ function extractExamples(type) {
     return examples;
 }
 function getNamedTypeId(type) {
-    var _a;
     switch (type.kind) {
         case "Decorator":
             return getDecoratorId(type);
         case "Operation":
-            return getQualifier((_a = type.interface) !== null && _a !== void 0 ? _a : type.namespace) + type.name;
+            return getQualifier(type.interface ?? type.namespace) + type.name;
         default:
             return "namespace" in type ? getQualifier(type.namespace) + type.name : type.name;
     }
@@ -398,9 +432,8 @@ function getDecoratorId(decorator) {
     return "@" + getQualifier(decorator.namespace) + decorator.name.slice(1);
 }
 function checkIfTagHasDocOnSameLine(tag) {
-    var _a, _b;
-    const start = (_a = tag.content[0]) === null || _a === void 0 ? void 0 : _a.pos;
-    const end = (_b = tag.content[0]) === null || _b === void 0 ? void 0 : _b.end;
+    const start = tag.content[0]?.pos;
+    const end = tag.content[0]?.end;
     const file = getSourceLocation(tag.content[0]).file;
     let hasFirstLine = false;
     for (let i = start; i < end; i++) {
@@ -427,9 +460,8 @@ function extractExample(tag) {
     }
 }
 function getParmeterDocs(type) {
-    var _a, _b;
     const map = new Map();
-    for (const d of (_b = (_a = type === null || type === void 0 ? void 0 : type.node) === null || _a === void 0 ? void 0 : _a.docs) !== null && _b !== void 0 ? _b : []) {
+    for (const d of type?.node?.docs ?? []) {
         for (const tag of d.tags) {
             if (tag.kind === SyntaxKind.DocParamTag) {
                 map.set(tag.paramName.sv, getDocContent(tag.content));
@@ -439,9 +471,8 @@ function getParmeterDocs(type) {
     return map;
 }
 function getTemplateParameterDocs(type) {
-    var _a, _b;
     const map = new Map();
-    for (const d of (_b = (_a = type === null || type === void 0 ? void 0 : type.node) === null || _a === void 0 ? void 0 : _a.docs) !== null && _b !== void 0 ? _b : []) {
+    for (const d of type?.node?.docs ?? []) {
         for (const tag of d.tags) {
             if (tag.kind === SyntaxKind.DocTemplateTag) {
                 map.set(tag.paramName.sv, getDocContent(tag.content));
@@ -460,13 +491,12 @@ function getDocContent(content) {
 }
 function extractEmitterOptionsRefDoc(options) {
     return Object.entries(options.properties).map(([name, value]) => {
-        var _a;
         return {
             name,
             type: value.enum
                 ? value.enum.map((x) => (typeof x === "string" ? `"${x}"` : x)).join(" | ")
                 : value.type,
-            doc: (_a = value.description) !== null && _a !== void 0 ? _a : "",
+            doc: value.description ?? "",
         };
     });
 }
@@ -480,6 +510,7 @@ function extractLinterRuleSetsRefDoc(libName, ruleSets) {
     return Object.entries(ruleSets).map(([name, ruleSet]) => {
         const fullName = `${libName}/${name}`;
         return {
+            kind: "ruleset",
             id: fullName,
             name: fullName,
             ruleSet,
@@ -489,6 +520,7 @@ function extractLinterRuleSetsRefDoc(libName, ruleSets) {
 function extractLinterRuleRefDoc(libName, rule) {
     const fullName = `${libName}/${rule.name}`;
     return {
+        kind: "rule",
         id: fullName,
         name: fullName,
         rule,