@mintlify/common 1.0.591 → 1.0.593

package/dist/api-reference/parseApiTargetFromMetadata.d.ts

@@ -0,0 +1,13 @@
+import { PageMetaTags } from '@mintlify/models';
+import { parseAsyncApiString } from '../asyncapi/parseAsyncApiString.js';
+import { parseOpenApiSchemaString, parseOpenApiString } from '../openapi/parseOpenApiString.js';
+export type SchemaTargetType = {
+    type: 'schema';
+} & ReturnType<typeof parseOpenApiSchemaString>;
+export type OperationTargetType = {
+    type: 'operation';
+} & ReturnType<typeof parseOpenApiString>;
+export type AsyncApiTargetType = {
+    type: 'asyncapi';
+} & ReturnType<typeof parseAsyncApiString>;
+export declare const parseApiTargetFromMetadata: (metadata: PageMetaTags) => SchemaTargetType | OperationTargetType | AsyncApiTargetType | undefined;

package/dist/api-reference/parseApiTargetFromMetadata.js

@@ -0,0 +1,25 @@
+import { parseAsyncApiString } from '../asyncapi/parseAsyncApiString.js';
+import { parseOpenApiSchemaString, parseOpenApiString } from '../openapi/parseOpenApiString.js';
+export const parseApiTargetFromMetadata = (metadata) => {
+    const openapiSchema = metadata['openapi-schema'];
+    if (typeof openapiSchema === 'string' && openapiSchema.length > 0) {
+        return Object.assign({ type: 'schema' }, parseOpenApiSchemaString(openapiSchema));
+    }
+    const openapi = metadata.openapi;
+    if (typeof openapi === 'string' && openapi.length > 0) {
+        try {
+            return Object.assign({ type: 'operation' }, parseOpenApiString(openapi));
+        }
+        catch (error) {
+            console.error(`unable to parse value "${openapi}" for field "openapi":`, error);
+            return undefined;
+        }
+    }
+    const asyncapi = metadata.asyncapi;
+    if (typeof asyncapi === 'string' && asyncapi.length > 0) {
+        const asyncApiMetadata = parseAsyncApiString(asyncapi);
+        return asyncApiMetadata
+            ? Object.assign({ type: 'asyncapi' }, asyncApiMetadata) : undefined;
+    }
+    return undefined;
+};

package/dist/index.d.ts

@@ -23,3 +23,4 @@ export * from './services/aws.js';
 export * from './slugify.js';
 export * from './services/aws.js';
 export * from './truncateAtWordBoundary.js';
+export * from './api-reference/parseApiTargetFromMetadata.js';

package/dist/index.js

@@ -23,3 +23,4 @@ export * from './services/aws.js';
 export * from './slugify.js';
 export * from './services/aws.js';
 export * from './truncateAtWordBoundary.js';
+export * from './api-reference/parseApiTargetFromMetadata.js';

package/dist/mdx/getMDXOptions.js

@@ -1,4 +1,4 @@
-import { rehypeCodeBlocks, rehypeDynamicTailwindCss, rehypeMdxExtractEndpoint, rehypeMdxExtractExamples, rehypeParamFieldIds, rehypeRawComponents, rehypeTable, rehypeUnicodeIds, rehypeZoomImages, remarkExtractChangelogFilters, remarkExtractTableOfContents, remarkFrames, remarkComponentIds, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkMdxExtractPanel, remarkVideo, } from './plugins/index.js';
+import { rehypeCodeBlocks, rehypeDynamicTailwindCss, rehypeMdxExtractEndpoint, rehypeMdxExtractExamples, rehypeParamFieldIds, rehypeRawComponents, rehypeTable, rehypeUnicodeIds, rehypeZoomImages, remarkExtractChangelogFilters, remarkExtractTableOfContents, remarkFrames, remarkComponentIds, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkMdxExtractPanel, remarkVideo, remarkExtractMultiView, } from './plugins/index.js';
 import { remarkMdxRemoveUnknownJsx } from './plugins/remark/remarkMdxRemoveUnknownJsx/index.js';
 import { remarkMermaid } from './plugins/remark/remarkMermaid.js';
 // avoid running extractors unnecessarily
@@ -18,6 +18,7 @@ export const getMDXOptions = ({ data, remarkPlugins = [], rehypePlugins = [], md
             [remarkExtractTableOfContents, mdxExtracts, data.pageMetadata], // modifies tree so cannot be excluded
             [remarkExtractChangelogFilters, mdxExtracts],
             [remarkMdxExtractPanel, mdxExtracts],
+            [remarkExtractMultiView, mdxExtracts],
             remarkMdxRemoveUnusedVariables,
             remarkFrames,
             remarkRemoveImports,

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

@@ -15,3 +15,4 @@ export * from './remarkMdxExtractPanel.js';
 export * from './remarkValidateSteps.js';
 export * from './remarkValidateTabs.js';
 export * from './remarkVideo.js';
+export * from './remarkExtractMultiView.js';

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

@@ -15,3 +15,4 @@ export * from './remarkMdxExtractPanel.js';
 export * from './remarkValidateSteps.js';
 export * from './remarkValidateTabs.js';
 export * from './remarkVideo.js';
+export * from './remarkExtractMultiView.js';

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

@@ -0,0 +1,3 @@
+import type { Root } from 'mdast';
+import type { MdxExtracts } from '../../../types/index.js';
+export declare const remarkExtractMultiView: (mdxExtracts?: MdxExtracts) => (tree: Root) => Root;

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

@@ -0,0 +1,76 @@
+import remarkStringify from 'remark-stringify';
+import { unified } from 'unified';
+import { visit } from 'unist-util-visit';
+import { coreRemarkMdxPlugins } from '../../remark.js';
+export const remarkExtractMultiView = (mdxExtracts) => {
+    return (tree) => {
+        const multiViews = [];
+        const sanitizeNode = (node) => {
+            const sanitized = Object.assign({}, node);
+            if ('attributes' in sanitized && Array.isArray(sanitized.attributes)) {
+                sanitized.attributes = sanitized.attributes.map((attr) => {
+                    if (attr.value != null && typeof attr.value !== 'string') {
+                        return Object.assign(Object.assign({}, attr), { value: String(attr.value) });
+                    }
+                    return attr;
+                });
+            }
+            if ('children' in sanitized && Array.isArray(sanitized.children)) {
+                sanitized.children = sanitized.children.map(sanitizeNode);
+            }
+            return sanitized;
+        };
+        const stringifyNode = (node) => {
+            try {
+                return unified()
+                    .use(coreRemarkMdxPlugins)
+                    .use(remarkStringify)
+                    .stringify(sanitizeNode(node));
+            }
+            catch (error) {
+                console.error('Error converting MDX content to markdown:', error);
+                return '';
+            }
+        };
+        const getStringValue = (attribute) => {
+            if (!(attribute === null || attribute === void 0 ? void 0 : attribute.value)) {
+                return undefined;
+            }
+            if (typeof attribute.value === 'string') {
+                return attribute.value;
+            }
+            if (typeof attribute.value === 'object' && 'value' in attribute.value) {
+                return String(attribute.value.value);
+            }
+            return undefined;
+        };
+        visit(tree, 'mdxJsxFlowElement', (node) => {
+            if (node.name === 'View') {
+                const title = getStringValue(node.attributes.find((attr) => attr.type === 'mdxJsxAttribute' && attr.name === 'title'));
+                const icon = getStringValue(node.attributes.find((attr) => attr.type === 'mdxJsxAttribute' && attr.name === 'icon'));
+                const iconType = getStringValue(node.attributes.find((attr) => attr.type === 'mdxJsxAttribute' && attr.name === 'iconType'));
+                const content = stringifyNode({
+                    type: 'root',
+                    children: node.children,
+                });
+                if (title) {
+                    const viewItem = {
+                        title,
+                        content,
+                    };
+                    if (icon) {
+                        viewItem.icon = icon;
+                    }
+                    if (iconType) {
+                        viewItem.iconType = iconType;
+                    }
+                    multiViews.push(viewItem);
+                }
+            }
+        });
+        if (mdxExtracts && multiViews.length) {
+            mdxExtracts.multiViewItems = multiViews;
+        }
+        return tree;
+    };
+};

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

@@ -54,6 +54,10 @@ export function getMdx(_a) {
             // so we need to restore the original mdxExtracts
             mdxExtracts = Object.assign(Object.assign({}, originalMdxExtracts), { codeExamples: mdxExtracts.codeExamples });
         }
+        // to avoid flash on initial load, we set the first view as active
+        if (mdxExtracts.multiViewItems) {
+            mdxExtracts.multiViewItems = mdxExtracts.multiViewItems.map((item, index) => (Object.assign(Object.assign({}, item), { active: index === 0 })));
+        }
         return {
             mdxExtracts,
             mdxSource,

package/dist/mdx/utils.js

@@ -129,6 +129,7 @@ export const allowedComponents = [
     'pre',
     'ZoomImage',
     'Mermaid',
+    'View',
     // Custom tags
     'zapier-zap-templates',
 ];