@mintlify/common 1.0.571 → 1.0.573

package/dist/mdx/server-only/getMdx.d.ts

@@ -3,6 +3,7 @@ import type { PageMetaTags, PageType } from '@mintlify/models';
 import { CodeStyling, DocsConfig } from '@mintlify/validation';
 import { MdxExtracts } from '../../index.js';
 import { createSnippetTreeMap, type Snippet } from './getMdx/snippets.js';
+type RunWithTracingFn = <T>(spanName: string, fn: () => Promise<T>) => Promise<T>;
 export type GetMdxType = {
     mdxSource: SerializeSuccess;
     mdxSourceWithNoJs: SerializeSuccess;
@@ -10,7 +11,7 @@ export type GetMdxType = {
     panelMdxSource?: SerializeSuccess;
     panelMdxSourceWithNoJs?: SerializeSuccess;
 };
-export declare function getMdx({ path, content, metadata, snippets, subdomain, codeStyling, config, tailwindSelectors, pageType, }: {
+export declare function getMdx({ path, content, metadata, snippets, subdomain, codeStyling, config, tailwindSelectors, pageType, trace, }: {
     path: string;
     content: string;
     metadata: PageMetaTags;
@@ -20,5 +21,6 @@ export declare function getMdx({ path, content, metadata, snippets, subdomain, c
     config?: Pick<DocsConfig, 'api' | '$schema'>;
     tailwindSelectors?: string[] | undefined;
     pageType?: PageType;
+    trace?: RunWithTracingFn;
 }): Promise<GetMdxType>;
 export { createSnippetTreeMap, type Snippet };

package/dist/mdx/server-only/getMdx.js

@@ -13,10 +13,11 @@ import { getMDXOptions, remarkMdxRemoveJs, remarkExpandContent, remarkSplitCodeG
 import { codeStylingToThemeOrThemes } from '../getCodeStyling.js';
 import { createSnippetTreeMap } from './getMdx/snippets.js';
 export function getMdx(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ path, content, metadata, snippets, subdomain, codeStyling, config, tailwindSelectors = undefined, pageType = 'default', }) {
+    return __awaiter(this, arguments, void 0, function* ({ path, content, metadata, snippets, subdomain, codeStyling, config, tailwindSelectors = undefined, pageType = 'default', trace = undefined, }) {
+        const traceFn = trace !== null && trace !== void 0 ? trace : ((_name, fn) => fn());
         if (!tailwindSelectors)
-            tailwindSelectors = yield getTailwindSelectors({ content });
-        const snippetTreeMap = yield createSnippetTreeMap(snippets);
+            tailwindSelectors = yield traceFn('getMdx.getTailwindSelectors', () => __awaiter(this, void 0, void 0, function* () { return getTailwindSelectors({ content }); }));
+        const snippetTreeMap = yield traceFn('getMdx.createSnippetTreeMap', () => __awaiter(this, void 0, void 0, function* () { return createSnippetTreeMap(snippets); }));
         const mdxOptionsData = {
             subdomain,
             snippetTreeMap,
@@ -40,13 +41,13 @@ export function getMdx(_a) {
             config,
             pageMetadata: metadata,
         };
-        const { mdxSource, mdxSourceWithNoJs } = yield compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path);
+        const { mdxSource, mdxSourceWithNoJs } = yield traceFn('getMdx.compileMdx.mainContent', () => __awaiter(this, void 0, void 0, function* () { return compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path, traceFn); }));
         const originalMdxExtracts = structuredClone(mdxExtracts);
         let panelMdxSource;
         let panelMdxSourceWithNoJs;
         if (mdxExtracts.panel && mdxExtracts.panel.content) {
             const panelContent = mdxExtracts.panel.content;
-            const compiledMdx = yield compileMdx(panelContent, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path);
+            const compiledMdx = yield traceFn('getMdx.compileMdx.panelContent', () => __awaiter(this, void 0, void 0, function* () { return compileMdx(panelContent, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path, traceFn); }));
             panelMdxSource = compiledMdx.mdxSource;
             panelMdxSourceWithNoJs = compiledMdx.mdxSourceWithNoJs;
             // serializing mdx content with the panel content will remove the original mdxExtracts
@@ -62,23 +63,25 @@ export function getMdx(_a) {
         };
     });
 }
-function compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path) {
+function compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, codeStyling, path, traceFn) {
     return __awaiter(this, void 0, void 0, function* () {
-        const mdxSource = yield getCompiledMdxWithFallback(content, scope, mdxOptions, codeStyling, path);
-        const mdxSourceWithNoJs = yield getCompiledMdxWithFallback(content, scope, mdxOptionsNoJs, codeStyling, path);
+        const mdxSource = yield traceFn('compileMdx.withJs', () => __awaiter(this, void 0, void 0, function* () { return getCompiledMdxWithFallback(content, scope, mdxOptions, codeStyling, path, traceFn); }));
+        const mdxSourceWithNoJs = yield traceFn('compileMdx.withoutJs', () => __awaiter(this, void 0, void 0, function* () { return getCompiledMdxWithFallback(content, scope, mdxOptionsNoJs, codeStyling, path, traceFn); }));
         return { mdxSource, mdxSourceWithNoJs };
     });
 }
-function getCompiledMdxWithFallback(source, scope, mdxOptions, codeStyling, path) {
+function getCompiledMdxWithFallback(source, scope, mdxOptions, codeStyling, path, traceFn) {
     return __awaiter(this, void 0, void 0, function* () {
         const themeOrThemes = codeStylingToThemeOrThemes(codeStyling);
         try {
-            const result = yield serialize({
-                source,
-                scope,
-                mdxOptions,
-                syntaxHighlightingOptions: Object.assign({}, themeOrThemes),
-            });
+            const result = yield traceFn('getCompiledMdxWithFallback.serialize', () => __awaiter(this, void 0, void 0, function* () {
+                return serialize({
+                    source,
+                    scope,
+                    mdxOptions,
+                    syntaxHighlightingOptions: Object.assign({}, themeOrThemes),
+                });
+            }));
             if ('error' in result) {
                 throw result.error;
             }
@@ -89,11 +92,13 @@ function getCompiledMdxWithFallback(source, scope, mdxOptions, codeStyling, path
             if (path)
                 console.log(`⚠️ Warning: MDX failed to parse page ${path}: `, err);
             // placeholder content for when there is a syntax error.
-            const fallbackResult = yield serialize({
-                source: '🚧 A parsing error occured. Please contact the owner of this website. They can use the Mintlify CLI to test this website locally and see the errors that occur.',
-                scope,
-                mdxOptions,
-            });
+            const fallbackResult = yield traceFn('getCompiledMdxWithFallback.serialize.fallback', () => __awaiter(this, void 0, void 0, function* () {
+                return serialize({
+                    source: '🚧 A parsing error occured. Please contact the owner of this website. They can use the Mintlify CLI to test this website locally and see the errors that occur.',
+                    scope,
+                    mdxOptions,
+                });
+            }));
             if ('error' in fallbackResult) {
                 throw fallbackResult.error;
             }