@qualcomm-ui/mdx-vite 2.15.0 → 2.16.0

package/dist/docs-plugin/remark/remark-extract-meta.d.ts

@@ -4,14 +4,26 @@ export type MetadataValue = Record<string, string | string[]>;
 /**
  * Extracts metadata from MDX files and removes it from the MDX content.
  *
- * @example
+ * Supports two formats:
+ *
+ * @example `::: meta` - YAML-like key-value pairs
  * ```
  * ::: meta
  * component: NumberInput
- * keywords: [forms, input, data entry]
  * :::
  *
- * result: {keywords: ["forms", "input", "data entry"], component: "NumberInput"}
+ * result: {component: "NumberInput"}
+ * ```
+ *
+ * @example `::: terms` - flat list of terms
+ * ```
+ * ::: terms
+ * forms
+ * input
+ * data entry
+ * :::
+ *
+ * result: {terms: ["forms", "input", "data entry"]}
  * ```
  */
 export declare const remarkExtractMeta: Plugin<[MetadataValue], Root>;

package/dist/docs-plugin/remark/remark-extract-meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remark-extract-meta.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/remark-extract-meta.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAS,IAAI,EAAC,MAAM,OAAO,CAAA;AACvC,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;AAiD7D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,CAuE3D,CAAA"}
+{"version":3,"file":"remark-extract-meta.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/remark-extract-meta.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAS,IAAI,EAAC,MAAM,OAAO,CAAA;AACvC,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;AA4D7D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,CAgG3D,CAAA"}

package/dist/index.js

@@ -5343,6 +5343,9 @@ function parseMetaContent(content) {
   }
   return result;
 }
+function parseTermsContent(content) {
+  return content.split("\n").map((line) => line.trim()).filter((line) => line && line !== ":::");
+}
 var remarkExtractMeta = (metadata = {}) => {
   return (tree) => {
     const nodesToRemove = [];
@@ -5355,16 +5358,27 @@ var remarkExtractMeta = (metadata = {}) => {
         return;
       }
       const text = firstChild.value;
-      const openMatch = text.match(/^:::\s*meta\s*/);
-      if (!openMatch) {
+      const metaMatch = text.match(/^:::\s*meta\s*/);
+      const termsMatch = text.match(/^:::\s*terms\s*/);
+      if (!metaMatch && !termsMatch) {
         return;
       }
+      const openMatch = metaMatch || termsMatch;
+      const isTermsBlock = !!termsMatch;
       if (text.includes(":::") && text.lastIndexOf(":::") > openMatch[0].length) {
         const afterOpen = text.slice(openMatch[0].length);
         const closeIndex = afterOpen.lastIndexOf(":::");
         const content = afterOpen.slice(0, closeIndex);
-        const parsed = parseMetaContent(content);
-        Object.assign(metadata, parsed);
+        if (isTermsBlock) {
+          const terms = parseTermsContent(content);
+          if (terms.length > 0) {
+            const existing = metadata.terms;
+            metadata.terms = Array.isArray(existing) ? [...existing, ...terms] : terms;
+          }
+        } else {
+          const parsed = parseMetaContent(content);
+          Object.assign(metadata, parsed);
+        }
         nodesToRemove.push({ index, parent });
         return SKIP;
       }
@@ -5379,8 +5393,16 @@ var remarkExtractMeta = (metadata = {}) => {
       const closeIndexFull = afterOpenFull.lastIndexOf(":::");
       if (closeIndexFull !== -1) {
         const content = afterOpenFull.slice(0, closeIndexFull);
-        const parsed = parseMetaContent(content);
-        Object.assign(metadata, parsed);
+        if (isTermsBlock) {
+          const terms = parseTermsContent(content);
+          if (terms.length > 0) {
+            const existing = metadata.terms;
+            metadata.terms = Array.isArray(existing) ? [...existing, ...terms] : terms;
+          }
+        } else {
+          const parsed = parseMetaContent(content);
+          Object.assign(metadata, parsed);
+        }
         nodesToRemove.push({ index, parent });
         return SKIP;
       }
@@ -5791,7 +5813,7 @@ ${tagContent.trim()}
    * Creates a remark plugin that replaces TypeDocProps JSX elements with
    * Markdown tables containing component prop documentation.
    */
-  formatTypeDocProps() {
+  propsToMarkdownList() {
     return () => (tree, _file, done) => {
       visit7(
         tree,
@@ -5830,15 +5852,18 @@ ${tagContent.trim()}
             }
             return;
           }
-          const propsDoc = this.extractProps(componentProps, Boolean(isPartial));
+          const propTypes = this.extractProps(
+            componentProps,
+            Boolean(isPartial)
+          );
           if (getConfig().verbose) {
             console.log(
               `  Replaced TypeDocProps ${propsName} with API documentation`
             );
           }
-          const regularProps = propsDoc.filter((p) => p.propType === void 0);
-          const inputs = propsDoc.filter((p) => p.propType === "input");
-          const outputs = propsDoc.filter((p) => p.propType === "output");
+          const regularProps = propTypes.filter((p) => p.propType === void 0);
+          const inputs = propTypes.filter((p) => p.propType === "input");
+          const outputs = propTypes.filter((p) => p.propType === "output");
           const sections = [];
           if (regularProps.length > 0) {
             sections.push(propsToDefinitionList(regularProps));
@@ -5860,9 +5885,8 @@ ${propsToDefinitionList(outputs)}`);
             }
             return;
           }
-          const propNames = propsDoc.map((p) => p.name);
           Object.assign(node, {
-            data: { typeDocProps: { name: propsName, props: propNames } },
+            data: { typeDocProps: { name: propsName, props: propTypes } },
             lang: null,
             meta: null,
             type: "code",
@@ -6063,19 +6087,19 @@ var SectionExtractor = class {
     return text.trim();
   }
   buildSectionEntry(section, pageInfo) {
-    const { metadata, nodes } = this.extractMetadata(section.nodes);
+    const { nodes, terms } = this.extractTerms(section.nodes);
     if (nodes.length === 0) {
       return null;
     }
     const contentNodes = [];
     const codeExamples = [];
+    const sectionTypes = [];
     for (const node of nodes) {
       if (node.type === "code") {
         const codeNode = node;
         if (codeNode.data?.typeDocProps) {
           const { name, props } = codeNode.data.typeDocProps;
-          metadata.props = [...metadata.props ?? [], ...props];
-          metadata.type = name;
+          sectionTypes.push({ props, type: name });
         }
         codeExamples.push({
           code: codeNode.value,
@@ -6091,71 +6115,57 @@ var SectionExtractor = class {
     const url = pageInfo.url ? `${pageInfo.url}#${this.generateAnchorId(section.headerPath.at(-1) ?? "")}` : void 0;
     const hashData = {
       headerPath: section.headerPath,
-      metadata: Object.keys(metadata).length ? metadata : void 0,
       pageFrontmatter: Object.keys(pageInfo.frontmatter).length ? pageInfo.frontmatter : void 0,
       pageId: pageInfo.id,
-      rawContent: rawContent.trim()
+      rawContent: rawContent.trim(),
+      terms: terms.length ? terms : void 0,
+      types: sectionTypes.length ? sectionTypes : void 0,
+      url
     };
-    const sectionHash = JSON.stringify(hashData);
+    const sectionHash = computeMd5(JSON.stringify(hashData));
     return {
       ...hashData,
       codeExamples: codeExamples.length ? codeExamples : void 0,
       content: content.trim(),
       hash: sectionHash,
-      sectionId,
-      url
+      sectionId
     };
   }
-  extractMetadata(nodes) {
-    const metadata = {};
+  extractTerms(nodes) {
     const filteredNodes = [];
+    const terms = [];
     for (const node of nodes) {
       if (node.type === "paragraph") {
-        const firstChild = node.children?.[0];
+        const children = node.children ?? [];
+        const firstChild = children[0];
         if (firstChild?.type === "text") {
-          const text = firstChild.value;
-          const metaMatch = text.match(/^:::\s*meta\s*/);
-          if (metaMatch) {
-            const parsed = this.parseMetaBlock(text);
-            Object.assign(metadata, parsed);
+          const firstText = firstChild.value;
+          const termsMatch = firstText.match(/^:::\s*terms\s*/);
+          if (termsMatch) {
+            let fullText = firstText;
+            for (let i = 1; i < children.length; i++) {
+              const child = children[i];
+              if (child.type === "text") {
+                fullText += child.value;
+              } else if (child.type === "softBreak") {
+                fullText += "\n";
+              }
+            }
+            const parsedTerms = this.parseTermsBlock(fullText);
+            terms.push(...parsedTerms);
             continue;
           }
         }
       }
       filteredNodes.push(node);
     }
-    return { metadata, nodes: filteredNodes };
+    return { nodes: filteredNodes, terms };
   }
-  parseMetaBlock(text) {
-    const metadata = {};
-    const afterOpen = text.replace(/^:::\s*meta\s*/, "");
+  parseTermsBlock(text) {
+    const afterOpen = text.replace(/^:::\s*terms\s*/, "");
     const closeIndex = afterOpen.lastIndexOf(":::");
     const content = closeIndex !== -1 ? afterOpen.slice(0, closeIndex) : afterOpen;
-    const lines = content.split("\n");
-    for (const line of lines) {
-      const trimmed = line.trim();
-      if (!trimmed) {
-        continue;
-      }
-      const colonIndex = trimmed.indexOf(":");
-      if (colonIndex === -1) {
-        continue;
-      }
-      const key = trimmed.slice(0, colonIndex).trim();
-      const value = trimmed.slice(colonIndex + 1).trim();
-      if (key && value) {
-        metadata[key] = this.parseValue(value);
-      }
-    }
-    return metadata;
-  }
-  parseValue(value) {
-    const trimmed = value.trim();
-    if (trimmed.startsWith("[") && trimmed.endsWith("]")) {
-      const inner = trimmed.slice(1, -1);
-      return inner.split(",").map((item) => item.trim()).filter(Boolean);
-    }
-    return trimmed;
+    return content.split("\n").map((line) => line.trim()).filter((line) => line && line !== ":::");
   }
   /**
    * Convert links to inline code. URLs are not relevant for text embeddings
@@ -6398,7 +6408,7 @@ var KnowledgeGenerator = class {
    * into Markdown, resolving relative links, and cleaning up formatting.
    */
   async processMdxContent(mdxContent, pageInfo, frontmatter) {
-    const processor = unified5().use(remarkParse4).use(remarkMdx3).use(remarkFrontmatter2, ["yaml"]).use(this.propFormatter.formatTypeDocProps()).use(this.formatFrontmatterExpressions(frontmatter)).use(await formatThemeNodes()).use(formatDemos(pageInfo.demosFolder)).use(this.transformRelativeUrls(pageInfo.url));
+    const processor = unified5().use(remarkParse4).use(remarkMdx3).use(remarkFrontmatter2, ["yaml"]).use(this.propFormatter.propsToMarkdownList()).use(this.formatFrontmatterExpressions(frontmatter)).use(await formatThemeNodes()).use(formatDemos(pageInfo.demosFolder)).use(this.transformRelativeUrls(pageInfo.url));
     this.applyPlugins(pageInfo, processor);
     processor.use(remarkStringify4);
     return await processor.run(processor.parse(mdxContent));