@qualcomm-ui/mdx-vite 2.7.0 → 2.8.0

package/dist/docs-plugin/__tests__/remark-frontmatter-description.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=remark-frontmatter-description.spec.d.ts.map

package/dist/docs-plugin/__tests__/remark-frontmatter-description.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remark-frontmatter-description.spec.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/__tests__/remark-frontmatter-description.spec.ts"],"names":[],"mappings":""}

package/dist/docs-plugin/internal/search-indexer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/search-indexer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EAEP,OAAO,EACP,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,KAAK,eAAe,EAEpB,eAAe,EAQf,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,YAAY,CAAA;AAInB,qBAAa,aAAa;IA4Cf,MAAM,EAAE,oBAAoB;IAC5B,WAAW;IA5CpB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2C;IAExE,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAE/D;IACD,OAAO,CAAC,aAAa,CAAmD;IAExE,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IACD,OAAO,CAAC,QAAQ,CAAc;IAE9B,IAAI,WAAW,IAAI,WAAW,EAAE,CAE/B;IACD,OAAO,CAAC,YAAY,CAAoB;IAExC,KAAK,IAAI,IAAI;gBAOJ,MAAM,EAAE,oBAAoB,EAC5B,WAAW,UAAO,EAEzB,MAAM,GAAE;QACN,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,SAAS,CAAC,EAAE,kBAAkB,CAAA;QAC9B,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,UAAU,CAAC,EAAE,UAAU,CAAA;KACnB;IAyBR;;;OAGG;IACH,OAAO,CAAC,YAAY;IA8DpB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAmHtB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,cAAc;IAqBtB,UAAU,CACR,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,GAAE,OAAc,GAC1B,eAAe,EAAE;CAmCrB"}
+{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/search-indexer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EAEP,OAAO,EACP,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,KAAK,eAAe,EAEpB,eAAe,EAQf,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,YAAY,CAAA;AAInB,qBAAa,aAAa;IA4Cf,MAAM,EAAE,oBAAoB;IAC5B,WAAW;IA5CpB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2C;IAExE,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAE/D;IACD,OAAO,CAAC,aAAa,CAAmD;IAExE,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IACD,OAAO,CAAC,QAAQ,CAAc;IAE9B,IAAI,WAAW,IAAI,WAAW,EAAE,CAE/B;IACD,OAAO,CAAC,YAAY,CAAoB;IAExC,KAAK,IAAI,IAAI;gBAOJ,MAAM,EAAE,oBAAoB,EAC5B,WAAW,UAAO,EAEzB,MAAM,GAAE;QACN,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,SAAS,CAAC,EAAE,kBAAkB,CAAA;QAC9B,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,UAAU,CAAC,EAAE,UAAU,CAAA;KACnB;IAyBR;;;OAGG;IACH,OAAO,CAAC,YAAY;IA+DpB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAmHtB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,cAAc;IAqBtB,UAAU,CACR,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,GAAE,OAAc,GAC1B,eAAe,EAAE;CAmCrB"}

package/dist/docs-plugin/internal/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC,eAAO,MAAM,SAAS,GACpB,OAAO,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,KAC3D,OAAyD,CAAA;AAE5D,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAElE;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAgBxC,CAAA;AAEJ;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC,eAAO,MAAM,SAAS,GACpB,OAAO,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,KAC3D,OAAyD,CAAA;AAE5D,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAElE;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAiBxC,CAAA;AAEJ;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}

package/dist/docs-plugin/mdx-plugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mdx-plugins.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/mdx-plugins.ts"],"names":[],"mappings":"AAGA,OAAoB,EAAC,KAAK,kBAAkB,EAAC,MAAM,iBAAiB,CAAA;AAWpE,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,OAAO,CAAA;AAC3C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAA;AAW1C,OAAO,EAAe,KAAK,mBAAmB,EAAC,MAAM,YAAY,CAAA;AAKjE;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;CACjD;AAED,wBAAgB,oBAAoB,IAAI,gBAAgB,EAAE,CAWzD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,sBAA2B,GACnC,aAAa,CAwBf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAShD"}
+{"version":3,"file":"mdx-plugins.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/mdx-plugins.ts"],"names":[],"mappings":"AAGA,OAAoB,EAAC,KAAK,kBAAkB,EAAC,MAAM,iBAAiB,CAAA;AAWpE,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,OAAO,CAAA;AAC3C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAA;AAW1C,OAAO,EAAe,KAAK,mBAAmB,EAAC,MAAM,YAAY,CAAA;AAUjE;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;CACjD;AAED,wBAAgB,oBAAoB,IAAI,gBAAgB,EAAE,CAWzD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,sBAA2B,GACnC,aAAa,CAwBf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAUhD"}

package/dist/docs-plugin/remark/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./remark-alerts";
 export * from "./remark-code-tabs";
+export * from "./remark-frontmatter-description";
 export * from "./remark-self-link-headings";
 export * from "./remark-spoilers";
 //# sourceMappingURL=index.d.ts.map

package/dist/docs-plugin/remark/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA"}

package/dist/docs-plugin/remark/remark-frontmatter-description.d.ts

@@ -0,0 +1,8 @@
+import type { Root } from "mdast";
+import type { Plugin } from "unified";
+/**
+ * Wraps standalone `{frontmatter.description}` expressions in a
+ * `<p class="mdx">` element for styling purposes.
+ */
+export declare const remarkFrontmatterDescription: Plugin<[], Root>;
+//# sourceMappingURL=remark-frontmatter-description.d.ts.map

package/dist/docs-plugin/remark/remark-frontmatter-description.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remark-frontmatter-description.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/remark-frontmatter-description.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAS,IAAI,EAAC,MAAM,OAAO,CAAA;AACvC,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAQnC;;;GAGG;AACH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,CAmCzD,CAAA"}

package/dist/index.js

@@ -121,6 +121,7 @@ function defined(value) {
 }
 var frontmatterSchema = implement().with({
   categories: z3.string().array().optional(),
+  description: z3.string().optional(),
   group: z3.string().optional(),
   hidden: z3.boolean().optional(),
   hideBreadcrumbs: z3.boolean().optional(),
@@ -1553,6 +1554,7 @@ var SearchIndexer = class {
         this.metaJson,
         routeMeta?.title || frontmatter.title || ""
       ),
+      description: frontmatter.description,
       hidden: defined(routeMeta.hidden) ? routeMeta.hidden : frontmatter.hidden,
       hideBreadcrumbs: defined(routeMeta.hideBreadcrumbs) ? routeMeta.hideBreadcrumbs : frontmatter.hideBreadcrumbs,
       hideFromSearch: defined(routeMeta.hideFromSearch) ? routeMeta.hideFromSearch : frontmatter.hideFromSearch,
@@ -2178,9 +2180,38 @@ var remarkCodeTabs = () => {
   };
 };
 
+// src/docs-plugin/remark/remark-frontmatter-description.ts
+import { visit as visit5 } from "unist-util-visit";
+var remarkFrontmatterDescription = () => {
+  return (tree) => {
+    visit5(
+      tree,
+      "mdxFlowExpression",
+      (node, index, parent) => {
+        if (node.value.trim() !== "frontmatter.description" || index === void 0 || !parent) {
+          return;
+        }
+        const wrappedNode = {
+          attributes: [
+            {
+              name: "className",
+              type: "mdxJsxAttribute",
+              value: "mdx"
+            }
+          ],
+          children: [node],
+          name: "p",
+          type: "mdxJsxFlowElement"
+        };
+        parent.children[index] = wrappedNode;
+      }
+    );
+  };
+};
+
 // src/docs-plugin/remark/remark-self-link-headings.ts
 import { toString as toString2 } from "mdast-util-to-string";
-import { visit as visit5 } from "unist-util-visit";
+import { visit as visit6 } from "unist-util-visit";
 var emptyOptions2 = {};
 function remarkSelfLinkHeadings(baseUrl = "", options) {
   if (!baseUrl) {
@@ -2208,7 +2239,7 @@ function remarkSelfLinkHeadings(baseUrl = "", options) {
     }
     return (tree) => {
       seenIds.clear();
-      visit5(tree, "heading", (node) => {
+      visit6(tree, "heading", (node) => {
         if (allowedLevels.has(node.depth)) {
           const text = toString2(node);
           const slug = prefix + createSlug(text);
@@ -2225,7 +2256,7 @@ function remarkSelfLinkHeadings(baseUrl = "", options) {
 }
 
 // src/docs-plugin/remark/remark-spoilers.ts
-import { visit as visit6 } from "unist-util-visit";
+import { visit as visit7 } from "unist-util-visit";
 var remarkSpoilers = (options = {}) => {
   const {
     defaultSummary = "Open spoiler",
@@ -2233,7 +2264,7 @@ var remarkSpoilers = (options = {}) => {
     summaryClassName = []
   } = options;
   return (tree) => {
-    visit6(tree, "paragraph", (node, index, parent) => {
+    visit7(tree, "paragraph", (node, index, parent) => {
       if (!parent || index === void 0) {
         return;
       }
@@ -2559,6 +2590,7 @@ function getRemarkPlugins() {
     remarkGfm2,
     remarkAlerts,
     remarkCodeTabs,
+    remarkFrontmatterDescription,
     remarkSpoilers
   ];
 }
@@ -2570,7 +2602,7 @@ import { readFile } from "node:fs/promises";
 import postcss from "postcss";
 import selectorParser from "postcss-selector-parser";
 import { compile } from "tailwindcss";
-import { visit as visit7 } from "unist-util-visit";
+import { visit as visit8 } from "unist-util-visit";
 import { camelCase } from "@qualcomm-ui/utils/change-case";
 async function loadStylesheetContent(id) {
   const resolveId = id === "tailwindcss" ? "tailwindcss/index.css" : id;
@@ -3245,7 +3277,7 @@ function angularDemoPlugin({
   }
   async function extractRelativeImports(filePath) {
     try {
-      let visit9 = function(node) {
+      let visit10 = function(node) {
         if (ts.isImportDeclaration(node)) {
           const moduleSpecifier = node.moduleSpecifier;
           if (ts.isStringLiteral(moduleSpecifier)) {
@@ -3264,9 +3296,9 @@ function angularDemoPlugin({
             }
           }
         }
-        ts.forEachChild(node, visit9);
+        ts.forEachChild(node, visit10);
       };
-      var visit8 = visit9;
+      var visit9 = visit10;
       const content = await readFile2(filePath, "utf-8");
       const sourceFile = ts.createSourceFile(
         filePath,
@@ -3276,7 +3308,7 @@ function angularDemoPlugin({
         ts.ScriptKind.TS
       );
       const relativeImports = [];
-      visit9(sourceFile);
+      visit10(sourceFile);
       return relativeImports;
     } catch (error) {
       logDev(
@@ -3299,16 +3331,16 @@ function angularDemoPlugin({
   }
   function stripImports(code, fileName) {
     try {
-      let visit9 = function(node) {
+      let visit10 = function(node) {
         if (ts.isImportDeclaration(node)) {
           importRanges.push({
             end: node.getEnd(),
             start: node.getFullStart()
           });
         }
-        ts.forEachChild(node, visit9);
+        ts.forEachChild(node, visit10);
       };
-      var visit8 = visit9;
+      var visit9 = visit10;
       const sourceFile = ts.createSourceFile(
         fileName,
         code,
@@ -3317,7 +3349,7 @@ function angularDemoPlugin({
         ts.ScriptKind.TS
       );
       const importRanges = [];
-      visit9(sourceFile);
+      visit10(sourceFile);
       return importRanges.map((range) => {
         let endPos = range.end;
         if (code[endPos] === "\n") {
@@ -3429,7 +3461,7 @@ function angularDemoPlugin({
     let templateUrl = null;
     let hasDefaultExport = false;
     const importsFromAst = [];
-    function visit8(node) {
+    function visit9(node) {
       if (ts.isImportDeclaration(node)) {
         importsFromAst.push(node.getFullText(sourceFile).trim());
       }
@@ -3477,9 +3509,9 @@ function angularDemoPlugin({
       if (ts.isExportAssignment(node) && !node.isExportEquals) {
         hasDefaultExport = true;
       }
-      ts.forEachChild(node, visit8);
+      ts.forEachChild(node, visit9);
     }
-    visit8(sourceFile);
+    visit9(sourceFile);
     return {
       componentClass,
       hasDefaultExport,
@@ -3931,7 +3963,7 @@ function extractImports(code, fileName) {
   );
   const thirdPartyImports = [];
   const relativeImports = [];
-  function visit8(node) {
+  function visit9(node) {
     if (ts2.isImportDeclaration(node)) {
       const importSpec = parseImportDeclaration(node, fileName);
       if (importSpec) {
@@ -3942,9 +3974,9 @@ function extractImports(code, fileName) {
         }
       }
     }
-    ts2.forEachChild(node, visit8);
+    ts2.forEachChild(node, visit9);
   }
-  visit8(sourceFile);
+  visit9(sourceFile);
   return { relativeImports, thirdPartyImports };
 }
 function getScriptKind(fileName) {
@@ -4541,16 +4573,16 @@ function reactDemoPlugin({
   }
   function stripImports(code, fileName) {
     try {
-      let visit9 = function(node) {
+      let visit10 = function(node) {
         if (ts3.isImportDeclaration(node)) {
           importRanges.push({
             end: node.getEnd(),
             start: node.getFullStart()
           });
         }
-        ts3.forEachChild(node, visit9);
+        ts3.forEachChild(node, visit10);
       };
-      var visit8 = visit9;
+      var visit9 = visit10;
       const sourceFile = ts3.createSourceFile(
         fileName,
         code,
@@ -4559,7 +4591,7 @@ function reactDemoPlugin({
         getScriptKind(fileName)
       );
       const importRanges = [];
-      visit9(sourceFile);
+      visit10(sourceFile);
       return importRanges.map((range) => {
         let endPos = range.end;
         if (code[endPos] === "\n") {
@@ -4623,6 +4655,7 @@ export {
   remarkAlerts,
   remarkCodeTabs,
   remarkFrontmatter2 as remarkFrontmatter,
+  remarkFrontmatterDescription,
   remarkGfm2 as remarkGfm,
   remarkMdxFrontmatter,
   remarkSelfLinkHeadings,