@openpkg-ts/sdk 0.50.0 → 0.51.0

package/dist/index.js

@@ -1329,6 +1329,19 @@ function withInlineTags(node, ...texts) {
   const inlineTags = parseInlineTags(...texts);
   return inlineTags ? { ...node, inlineTags } : node;
 }
+var INLINE_TAGS_ONLY_RE = /^\s*(?:\{@[a-zA-Z][a-zA-Z0-9]*(?:[^}\\]|\\.)*\}\s*)+$/;
+function splitCommentLevelTags(text) {
+  if (!text.includes("{@"))
+    return { retained: text, hoisted: [] };
+  const paragraphs = text.split(/\n\s*\n/);
+  const hoisted = [];
+  while (paragraphs.length > 1 && INLINE_TAGS_ONLY_RE.test(paragraphs[paragraphs.length - 1])) {
+    hoisted.unshift(...parseInlineTags(paragraphs.pop()) ?? []);
+  }
+  return { retained: paragraphs.join(`
+
+`), hoisted };
+}
 function parseExamplesFromTags(tags) {
   const examples = [];
   for (const tag of tags) {
@@ -1353,10 +1366,8 @@ function parseExamplesFromTags(tags) {
 function stripParamSeparator(text) {
   if (!text)
     return;
-  let stripped = text.replace(/^-\s*/, "").trim();
-  const parts = stripped.split(/\n\s*\n/);
-  stripped = parts[0].trim();
-  return stripped || undefined;
+  const stripped = text.replace(/^-\s*/, "").trim();
+  return splitCommentLevelTags(stripped).retained.trim() || undefined;
 }
 function stripTypeParamSeparator(text) {
   if (!text)
@@ -1378,6 +1389,7 @@ function extractSeeTagText(tag) {
   if (seeMatch) {
     let text = seeMatch[1].trim();
     text = text.replace(/\s*\*\s*$/gm, "").trim();
+    text = text.replace(/^[ \t]*\*[ \t]?/gm, "").trim();
     if (text)
       return text;
   }
@@ -1416,8 +1428,11 @@ function extractSeeTagText(tag) {
 }
 function getJSDocComment(node, symbol, checker) {
   const jsDocTags = ts.getJSDocTags(node);
+  const commentLevelTags = [];
   const tags = jsDocTags.map((tag) => {
     const rawText = typeof tag.comment === "string" ? tag.comment : ts.getTextOfJSDocComment(tag.comment) ?? "";
+    const { retained, hoisted } = tag.tagName.text === "see" ? { retained: rawText, hoisted: [] } : splitCommentLevelTags(rawText);
+    commentLevelTags.push(...hoisted);
     if (tag.tagName.text === "param") {
       const paramTag = tag;
       let paramName = "";
@@ -1450,7 +1465,7 @@ function getJSDocComment(node, symbol, checker) {
       const text = extractSeeTagText(tag);
       return withInlineTags({ name: tag.tagName.text, text }, text);
     }
-    return withInlineTags({ name: tag.tagName.text, text: rawText }, rawText);
+    return withInlineTags({ name: tag.tagName.text, text: rawText }, retained);
   });
   const jsDocComments = ts.getJSDocCommentsAndTags(node).filter(ts.isJSDoc);
   let description;
@@ -1468,7 +1483,13 @@ function getJSDocComment(node, symbol, checker) {
     }
   }
   const examples = parseExamplesFromTags(tags);
-  return { description, tags, examples, inlineTags: parseInlineTags(description) };
+  const inlineTags = [...parseInlineTags(description) ?? [], ...commentLevelTags];
+  return {
+    description,
+    tags,
+    examples,
+    inlineTags: inlineTags.length > 0 ? inlineTags : undefined
+  };
 }
 function getSourceLocation(node, sourceFile) {
   const { line } = sourceFile.getLineAndCharacterOfPosition(node.getStart(sourceFile));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/sdk",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "description": "TypeScript API extraction SDK - programmatic primitives for OpenPkg specs",
   "keywords": [
     "openpkg",