@mintlify/common 1.0.474 → 1.0.476

package/dist/fs/addBasePath.d.ts

@@ -0,0 +1 @@
+export declare const addBasePath: (path: string, basePath?: string) => string;

package/dist/fs/addBasePath.js

@@ -0,0 +1,6 @@
+export const addBasePath = (path, basePath) => {
+    if (basePath) {
+        return `${basePath}${path}`;
+    }
+    return path;
+};

package/dist/fs/index.d.ts

@@ -2,3 +2,4 @@ export * from './createPathArr.js';
 export * from './optionallyLeadingSlash.js';
 export * from './removeLeadingSlash.js';
 export * from './normalizeRelativePath.js';
+export * from './addBasePath.js';

package/dist/fs/index.js

@@ -2,3 +2,4 @@ export * from './createPathArr.js';
 export * from './optionallyLeadingSlash.js';
 export * from './removeLeadingSlash.js';
 export * from './normalizeRelativePath.js';
+export * from './addBasePath.js';

package/dist/index.d.ts

@@ -18,4 +18,5 @@ export * from './camelToSentenceCase.js';
 export * from './asyncapi/index.js';
 export * from './isAbsoluteUrl.js';
 export * from './rss/index.js';
+export * from './services/aws.js';
 export * from './slugify.js';

package/dist/index.js

@@ -18,4 +18,5 @@ export * from './camelToSentenceCase.js';
 export * from './asyncapi/index.js';
 export * from './isAbsoluteUrl.js';
 export * from './rss/index.js';
+export * from './services/aws.js';
 export * from './slugify.js';

package/dist/mdx/getMDXOptions.d.ts

@@ -6,7 +6,6 @@ import type { PluggableList } from 'unified';
 import { MdxExtracts } from '../types/mdx/MdxExtracts.js';
 type MDXOptionsData = {
     snippetTreeMap: Record<string, Root>;
-    allowedComponents: string[];
     pageMetadata: PageMetaTags;
     config?: DocsConfig | MintConfig;
     subdomain?: string;

package/dist/mdx/getMDXOptions.js

@@ -23,7 +23,7 @@ export const getMDXOptions = ({ data, remarkPlugins = [], rehypePlugins = [], md
             remarkMermaid,
             remarkComponentIds,
             ...remarkPlugins,
-            [remarkMdxRemoveUnknownJsx, data.allowedComponents],
+            remarkMdxRemoveUnknownJsx,
         ],
         rehypePlugins: [
             rehypeCodeBlocks,

package/dist/mdx/getS3ImageUri.d.ts

@@ -0,0 +1,4 @@
+export declare const getS3ImageUri: (imagePath: string, subdomain: string, filePath: string, basePath: string | undefined, opts?: {
+    bucketName?: string;
+    region?: string;
+}) => string;

package/dist/mdx/getS3ImageUri.js

@@ -0,0 +1,12 @@
+import path from 'path';
+import { removeBasePath } from '../fs/removeBasePath.js';
+import { getS3URI } from '../services/aws.js';
+export const getS3ImageUri = (imagePath, subdomain, filePath, basePath, opts = {}) => {
+    if (imagePath.startsWith('/')) {
+        const path = removeBasePath(imagePath, basePath);
+        return getS3URI(subdomain, path, opts);
+    }
+    const beforeFilePath = path.join(filePath, '../');
+    const relativePath = removeBasePath(path.join(beforeFilePath, imagePath), basePath);
+    return getS3URI(subdomain, relativePath, opts);
+};

package/dist/mdx/index.d.ts

@@ -5,3 +5,4 @@ export * from './plugins/index.js';
 export * from './lib/index.js';
 export * from './getMDXOptions.js';
 export * from './astUtils.js';
+export * from './getS3ImageUri.js';

package/dist/mdx/index.js

@@ -5,3 +5,4 @@ export * from './plugins/index.js';
 export * from './lib/index.js';
 export * from './getMDXOptions.js';
 export * from './astUtils.js';
+export * from './getS3ImageUri.js';

package/dist/mdx/plugins/remark/index.d.ts

@@ -4,7 +4,6 @@ export * from './remarkRemoveImports.js';
 export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkMdxRemoveUnknownJsx/index.js';
-export * from './remarkReplaceAllImages.js';
 export * from './remarkMermaid.js';
 export * from './remarkMdxRemoveJs.js';
 export * from './remarkExtractChangelogFilters.js';

package/dist/mdx/plugins/remark/index.js

@@ -4,7 +4,6 @@ export * from './remarkRemoveImports.js';
 export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkMdxRemoveUnknownJsx/index.js';
-export * from './remarkReplaceAllImages.js';
 export * from './remarkMermaid.js';
 export * from './remarkMdxRemoveJs.js';
 export * from './remarkExtractChangelogFilters.js';

package/dist/mdx/plugins/remark/remarkMdxRemoveUnknownJsx/index.d.ts

@@ -1,2 +1,2 @@
 import type { Root } from 'mdast';
-export declare const remarkMdxRemoveUnknownJsx: (allowedComponents?: string[]) => (tree: Root) => Root | import("mdast-util-mdxjs-esm").MdxjsEsm | import("mdast").Link | import("mdast").Delete | import("mdast").Blockquote | import("mdast").Break | import("mdast").Code | import("mdast").Definition | import("mdast").Emphasis | import("mdast").FootnoteDefinition | import("mdast").FootnoteReference | import("mdast").Heading | import("mdast").Html | import("mdast").Image | import("mdast").ImageReference | import("mdast").InlineCode | import("mdast").LinkReference | import("mdast").List | import("mdast").ListItem | import("mdast").Paragraph | import("mdast").Strong | import("mdast").Table | import("mdast").TableCell | import("mdast").TableRow | import("mdast").Text | import("mdast").ThematicBreak | import("mdast").Yaml | import("mdast-util-math").InlineMath | import("mdast-util-math").Math | import("mdast-util-mdx-expression").MdxTextExpression | import("mdast-util-mdx-expression").MdxFlowExpression | import("mdast-util-mdx").MdxJsxFlowElement | import("mdast-util-mdx").MdxJsxTextElement;
+export declare const remarkMdxRemoveUnknownJsx: () => (tree: Root) => Root | import("mdast-util-mdxjs-esm").MdxjsEsm | import("mdast").Link | import("mdast").Delete | import("mdast").Blockquote | import("mdast").Break | import("mdast").Code | import("mdast").Definition | import("mdast").Emphasis | import("mdast").FootnoteDefinition | import("mdast").FootnoteReference | import("mdast").Heading | import("mdast").Html | import("mdast").Image | import("mdast").ImageReference | import("mdast").InlineCode | import("mdast").LinkReference | import("mdast").List | import("mdast").ListItem | import("mdast").Paragraph | import("mdast").Strong | import("mdast").Table | import("mdast").TableCell | import("mdast").TableRow | import("mdast").Text | import("mdast").ThematicBreak | import("mdast").Yaml | import("mdast-util-math").InlineMath | import("mdast-util-math").Math | import("mdast-util-mdx-expression").MdxTextExpression | import("mdast-util-mdx-expression").MdxFlowExpression | import("mdast-util-mdx").MdxJsxFlowElement | import("mdast-util-mdx").MdxJsxTextElement;

package/dist/mdx/plugins/remark/remarkMdxRemoveUnknownJsx/index.js

@@ -1,7 +1,8 @@
 import { map } from 'unist-util-map';
+import { allowedComponents } from '../../../index.js';
 import { findExportedNodes, isMdxJsxFlowElementHast } from '../../../lib/index.js';
 import { createCommentNode } from './createCommentNode.js';
-export const remarkMdxRemoveUnknownJsx = (allowedComponents) => (tree) => {
+export const remarkMdxRemoveUnknownJsx = () => (tree) => {
     const exportedComponentNames = findExportedNodes(tree, 'ArrowFunctionExpression');
     return map(tree, (node) => {
         if (isMdxJsxFlowElementHast(node)) {

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

@@ -0,0 +1,6 @@
+import type { Root } from 'mdast';
+export type Snippet = {
+    snippetFileLocation: string;
+    content: string;
+};
+export declare function createSnippetTreeMap(snippets: Snippet[]): Promise<Record<string, Root>>;

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

@@ -0,0 +1,110 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { fromMarkdown } from 'mdast-util-from-markdown';
+import { gfmFromMarkdown } from 'mdast-util-gfm';
+import { mdxFromMarkdown } from 'mdast-util-mdx';
+import { gfm } from 'micromark-extension-gfm';
+import { mdxjs } from 'micromark-extension-mdxjs';
+import { coreRemark, remarkMdxInjectSnippets } from '../../../index.js';
+export function createSnippetTreeMap(snippets) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        if (snippets.length === 0) {
+            return {};
+        }
+        const orderedSnippets = orderSnippetsByNumberOfSnippetsInContent(snippets);
+        let treeMap = {};
+        // If the lowest number of references is greater than 0, then there will be cyclical references that will never resolve.
+        // In these cases we do not try to replace snippets in snippets
+        // TODO: Better error handling for cyclical references
+        if (((_a = orderedSnippets[0]) === null || _a === void 0 ? void 0 : _a.numSnippetsInContent) === 0) {
+            orderedSnippets.forEach((snippet) => {
+                treeMap = addSnippetTreeToMap(snippet, treeMap);
+            });
+            return treeMap;
+        }
+        let failedParseArr = [];
+        orderedSnippets.forEach((snippet) => __awaiter(this, void 0, void 0, function* () {
+            if (snippet.numSnippetsInContent === 0) {
+                // No need to remove references if none exist
+                treeMap = addSnippetTreeToMap(snippet, treeMap);
+            }
+            if (failedParseArr.length > 0) {
+                let prevArrLength = failedParseArr.length + 1;
+                // We try to resolve the failed snippets which likely failed because it was referencing
+                // another snippet that has not been resolved yet.
+                // We loop while snippets continue to be resolved.
+                while (prevArrLength > failedParseArr.length && prevArrLength !== 0) {
+                    const newlyParsedSnippets = [];
+                    for (const failedParse of failedParseArr) {
+                        try {
+                            treeMap = yield addParsedSnippetTreeToMap(failedParse, treeMap);
+                            newlyParsedSnippets.push(failedParse);
+                        }
+                        catch (_a) { }
+                    }
+                    prevArrLength = failedParseArr.length;
+                    failedParseArr = failedParseArr.filter((elem) => !newlyParsedSnippets.includes(elem));
+                }
+            }
+            try {
+                treeMap = yield addParsedSnippetTreeToMap(snippet, treeMap);
+            }
+            catch (_b) {
+                // TODO - find exact error message for when inner snippet doesn't exist
+                failedParseArr.push(snippet);
+            }
+        }));
+        return treeMap;
+    });
+}
+function addSnippetTreeToMap(snippet, map) {
+    try {
+        const tree = fromMarkdown(snippet.content, {
+            extensions: [gfm(), mdxjs()],
+            mdastExtensions: [gfmFromMarkdown(), mdxFromMarkdown()],
+        });
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- TODO: Please fix this violation when you can!
+        map = Object.assign(Object.assign({}, map), { [snippet.snippetFileLocation]: tree });
+    }
+    catch (_a) {
+        // TODO: Better error handling
+    }
+    return map;
+}
+function addParsedSnippetTreeToMap(snippet, treeMap) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const parsedContent = yield preparseSnippet(snippet, treeMap);
+        return addSnippetTreeToMap(Object.assign(Object.assign({}, snippet), { content: parsedContent }), treeMap);
+    });
+}
+/*
+ * We order the snippets by increasing number of references to other snippets in an attempt to avoid
+ * trying to parse a snippet that references another snippet that has not been resolved yet.
+ */
+function orderSnippetsByNumberOfSnippetsInContent(snippets) {
+    const snippetsWithNumSnippets = snippets.map((snippet) => {
+        return Object.assign(Object.assign({}, snippet), { 
+            // Note: It's possible the regex might not be enough
+            numSnippetsInContent: (snippet.content.match(/<Snippet/g) || []).length });
+    });
+    snippetsWithNumSnippets.sort(function (first, second) {
+        return first.numSnippetsInContent - second.numSnippetsInContent;
+    });
+    return snippetsWithNumSnippets;
+}
+function preparseSnippet(snippet, snippetTreeMap) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const file = yield coreRemark()
+            .use([remarkMdxInjectSnippets, snippetTreeMap])
+            .process(snippet.content);
+        return String(file);
+    });
+}

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

@@ -0,0 +1,14 @@
+import { type SerializeSuccess } from '@mintlify/mdx';
+import type { PageMetaTags } from '@mintlify/models';
+import type { DocsConfig } from '@mintlify/validation';
+import { MdxExtracts } from '../../index.js';
+import { createSnippetTreeMap, type Snippet } from './getMdx/snippets.js';
+export type GetMdxType = {
+    mdxSource: SerializeSuccess;
+    mdxSourceWithNoJs: SerializeSuccess;
+    mdxExtracts: MdxExtracts;
+    panelMdxSource?: SerializeSuccess;
+    panelMdxSourceWithNoJs?: SerializeSuccess;
+};
+export declare function getMdx(path: string, content: string, metadata: PageMetaTags, snippets: Snippet[], subdomain: string, config: DocsConfig, tailwindSelectors: string[], pageType?: 'default' | 'pdf'): Promise<GetMdxType>;
+export { createSnippetTreeMap, type Snippet };

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

@@ -0,0 +1,99 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { serialize } from '@mintlify/mdx';
+import { getMDXOptions, remarkMdxRemoveJs, remarkExpandContent, remarkSplitCodeGroup, remarkSplitTabs, remarkValidateSteps, remarkValidateTabs, } from '../../index.js';
+import { createSnippetTreeMap } from './getMdx/snippets.js';
+export function getMdx(path_1, content_1, metadata_1, snippets_1, subdomain_1, config_1, tailwindSelectors_1) {
+    return __awaiter(this, arguments, void 0, function* (path, content, metadata, snippets, subdomain, config, tailwindSelectors, pageType = 'default') {
+        const snippetTreeMap = yield createSnippetTreeMap(snippets);
+        const mdxOptionsData = {
+            subdomain,
+            snippetTreeMap,
+            pageMetadata: metadata,
+            config,
+            tailwindSelectors,
+        };
+        let mdxExtracts = {};
+        let plugins = [remarkValidateSteps, remarkValidateTabs];
+        if (pageType === 'pdf') {
+            plugins = [...plugins, remarkExpandContent, remarkSplitCodeGroup, remarkSplitTabs];
+        }
+        const mdxOptions = getMDXOptions({ data: mdxOptionsData, remarkPlugins: plugins, mdxExtracts });
+        const mdxOptionsNoJs = getMDXOptions({
+            data: mdxOptionsData,
+            remarkPlugins: [remarkMdxRemoveJs, ...plugins],
+        });
+        const scope = {
+            config,
+            pageMetadata: metadata,
+        };
+        const { mdxSource, mdxSourceWithNoJs } = yield compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, config, path);
+        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, config, path);
+            panelMdxSource = compiledMdx.mdxSource;
+            panelMdxSourceWithNoJs = compiledMdx.mdxSourceWithNoJs;
+            // serializing mdx content with the panel content will remove the original mdxExtracts
+            // so we need to restore the original mdxExtracts
+            mdxExtracts = Object.assign(Object.assign({}, originalMdxExtracts), { codeExamples: mdxExtracts.codeExamples });
+        }
+        return {
+            mdxExtracts,
+            mdxSource,
+            mdxSourceWithNoJs,
+            panelMdxSource,
+            panelMdxSourceWithNoJs,
+        };
+    });
+}
+function compileMdx(content, scope, mdxOptions, mdxOptionsNoJs, config, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const mdxSource = yield getCompiledMdxWithFallback(content, scope, mdxOptions, config, path);
+        const mdxSourceWithNoJs = yield getCompiledMdxWithFallback(content, scope, mdxOptionsNoJs, config, path);
+        return { mdxSource, mdxSourceWithNoJs };
+    });
+}
+function getCompiledMdxWithFallback(source, scope, mdxOptions, config, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        try {
+            const result = yield serialize({
+                source,
+                scope,
+                mdxOptions,
+                syntaxHighlightingOptions: {
+                    codeStyling: (_a = config.styling) === null || _a === void 0 ? void 0 : _a.codeblocks,
+                },
+            });
+            if ('error' in result) {
+                throw result.error;
+            }
+            return result;
+        }
+        catch (err) {
+            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,
+            });
+            if ('error' in fallbackResult) {
+                throw fallbackResult.error;
+            }
+            return fallbackResult;
+        }
+    });
+}
+export { createSnippetTreeMap };

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

@@ -0,0 +1 @@
+export { createSnippetTreeMap, getMdx, type GetMdxType, type Snippet } from './getMdx.js';

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

@@ -0,0 +1 @@
+export { createSnippetTreeMap, getMdx } from './getMdx.js';

package/dist/mdx/utils.d.ts

@@ -16,3 +16,4 @@ export declare const isMdxJsxFlowElement: (node: Node) => node is MdxJsxFlowElem
 export declare const createUniqueVariableName: (variableName: string, id: number) => string;
 export declare const getObjectExpressionStringProperty: (key: string, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute | undefined) => string | undefined;
 export declare const getArrayExpressionStringProperties: (attribute: MdxJsxAttribute | MdxJsxExpressionAttribute | undefined) => string[];
+export declare const allowedComponents: string[];

package/dist/mdx/utils.js

@@ -46,3 +46,88 @@ export const getArrayExpressionStringProperties = (attribute) => {
     }
     return collection;
 };
+export const allowedComponents = [
+    'ApiPlayground',
+    'Accordion',
+    'AccordionGroup',
+    'CodeGroup',
+    'Columns',
+    'CodeBlock',
+    'CustomCode',
+    'CustomComponent',
+    'DynamicCustomComponent',
+    'Danger',
+    'SnippetGroup',
+    'Panel',
+    'RequestExample',
+    'ResponseExample',
+    'Param',
+    'ParamField',
+    'Card',
+    'CardGroup',
+    'Expandable',
+    'Frame',
+    'Heading',
+    'Info',
+    'Icon',
+    'Link',
+    'MDXContentController',
+    'ResponseField',
+    'Warning',
+    'Note',
+    'Tip',
+    'Check',
+    'Tabs',
+    'Tab',
+    'Tooltip',
+    'Latex',
+    'Step',
+    'Steps',
+    'Update',
+    'a',
+    'b',
+    'br',
+    'button',
+    'clipPath',
+    'defs',
+    'div',
+    'form',
+    'g',
+    'h1',
+    'h2',
+    'h3',
+    'h4',
+    'head',
+    'iframe',
+    'img',
+    'input',
+    'label',
+    'li',
+    'link',
+    'ol',
+    'p',
+    'path',
+    'picture',
+    'rect',
+    'script',
+    'section',
+    'source',
+    'span',
+    'sub',
+    'sup',
+    'svg',
+    'table',
+    'tbody',
+    'td',
+    'th',
+    'thead',
+    'tr',
+    'ul',
+    'video',
+    'code',
+    'pre',
+    'ZoomImage',
+    'Mermaid',
+    // Custom tags
+    'zapier-zap-templates',
+];