@qualcomm-ui/mdx-vite 3.1.0 → 3.2.0

package/dist/docs-plugin/frontmatter-hmr-plugin.d.ts

@@ -0,0 +1,31 @@
+import type { PluginOption } from "vite";
+/**
+ * Options for the {@link frontmatterHmrPlugin}.
+ */
+export interface FrontmatterHmrPluginOptions {
+    /**
+     * The name of the frontmatter export to target. This needs to match the
+     * '@mdx-js/react' frontmatter export name, which defaults to `frontmatter`.
+     *
+     * @default frontmatter
+     */
+    exportName?: string;
+}
+/**
+ * A Vite plugin that fixes Hot Module Replacement (HMR) for MDX frontmatter exports.
+ *
+ * By default, React Fast Refresh only processes modules that export React
+ * components. Since frontmatter is a plain object, changes to it don't trigger HMR
+ * updates and instead prompt a full refresh.
+ *
+ * This plugin works around the issue by attaching a `$$typeof` property set to
+ * `Symbol.for('react.memo')` on the exported `frontmatter` object, tricking React
+ * Fast Refresh's {@link https://github.com/facebook/react/blob/f5af92d2c47d1e1f455faf912b1d3221d1038c37/packages/react-refresh/src/ReactFreshRuntime.js#L717-L723 isLikelyComponentType}
+ * check into treating the module as a component module eligible for HMR.
+ *
+ * @since 3.2.0
+ *
+ * @returns A Vite plugin option that transforms modules containing frontmatter exports.
+ */
+export declare function frontmatterHmrPlugin(opts?: FrontmatterHmrPluginOptions): PluginOption;
+//# sourceMappingURL=frontmatter-hmr-plugin.d.ts.map

package/dist/docs-plugin/frontmatter-hmr-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontmatter-hmr-plugin.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/frontmatter-hmr-plugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,MAAM,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,GAAE,2BAAgC,GACrC,YAAY,CAkBd"}

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

@@ -1,5 +1,6 @@
 export * from "./config";
 export * from "./docs-plugin";
+export * from "./frontmatter-hmr-plugin";
 export type * from "./nav-builder";
 export * from "./mdx-plugins";
 export * from "./rehype";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,mBAAmB,eAAe,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,0BAA0B,CAAA;AACxC,mBAAmB,eAAe,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/dist/index.js

@@ -3806,6 +3806,25 @@ function quiDocsPlugin(opts) {
   };
 }
 
+// src/docs-plugin/frontmatter-hmr-plugin.ts
+function frontmatterHmrPlugin(opts = {}) {
+  const { exportName = "frontmatter" } = opts;
+  return {
+    name: "frontmatter-hmr-fix",
+    transform(code) {
+      if (code.includes(`export const ${exportName}`)) {
+        code += `
+            ;Object.defineProperty(${exportName}, "$$typeof", {
+              enumerable: false,
+              value: Symbol.for('react.memo')
+            });
+          `;
+        return code;
+      }
+    }
+  };
+}
+
 // src/docs-plugin/mdx-plugins.ts
 import rehypeShiki from "@shikijs/rehype";
 import {
@@ -6252,6 +6271,7 @@ export {
   createDemoName,
   extractFileImports,
   extractPageId,
+  frontmatterHmrPlugin,
   getAlertIcon,
   getRehypePlugins,
   getRemarkPlugins,