@mintlify/common 1.0.1292 → 1.0.1293

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

@@ -34,4 +34,8 @@ export declare function resolveVisibilityFor(node: MdxJsxElement, scope?: Static
 export declare function isHiddenFromHumans(resolution: VisibilityResolution): boolean;
 export declare function isHiddenFromAgents(resolution: VisibilityResolution): boolean;
 export declare function toVisibilityAuthRule(resolution: VisibilityResolution): VisibilityAuthRule | undefined;
-export declare const remarkVisibilityForMarkdown: () => (tree: Root) => void;
+export type RemarkVisibilityForMarkdownOptions = {
+    /** `docs.json` variation labels by id, so each `Variation` is titled the way readers see it. */
+    variationLabels?: Readonly<Record<string, string>>;
+};
+export declare const remarkVisibilityForMarkdown: ({ variationLabels }?: RemarkVisibilityForMarkdownOptions) => (tree: Root) => void;

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

@@ -1,7 +1,7 @@
 import { getAST, stringifyTree } from '../../remark-core.js';
 import { BLOCK_LINK_LABEL } from './firstPartyMarkdownComponents.js';
 import { evaluateStatic } from './staticEvaluator.js';
-import { chargeUnfoldBudget, chargeUnfoldCall, collectMarkdownComponentContext, collectUsageProps, containsJsx, createUnfoldBudget, definitionGatesContent, DROP_ELEMENTS, FORM_CONTROL_ELEMENTS, dropPairedDarkOnly, escapeInterpolatedText, HEADING_ELEMENTS, isPresentationalAttribute, UNWRAP_BLOCK_ELEMENTS, UNWRAP_INLINE_ELEMENTS, escapeLinkLabel, extractProgramExpression, markdownLinkDestination, MAX_UNFOLD_DEPTH, GFM_ALERT_PATTERN, HEADLINE_ATTRIBUTES, KEEP_TAG_COMPONENTS, materializeComponent, serializeExpressionJsx, } from './unfoldComponentsForMarkdown.js';
+import { chargeUnfoldBudget, chargeUnfoldCall, collectMarkdownComponentContext, collectUsageProps, containsJsx, createUnfoldBudget, definitionGatesContent, DROP_ELEMENTS, FORM_CONTROL_ELEMENTS, dropPairedDarkOnly, escapeInterpolatedText, HEADING_ELEMENTS, isPresentationalAttribute, UNWRAP_BLOCK_ELEMENTS, UNWRAP_INLINE_ELEMENTS, escapeLinkLabel, extractProgramExpression, FAILED_SPREAD, markdownLinkDestination, MAX_UNFOLD_DEPTH, GFM_ALERT_PATTERN, HEADLINE_ATTRIBUTES, KEEP_TAG_COMPONENTS, materializeComponent, serializeExpressionJsx, } from './unfoldComponentsForMarkdown.js';
 import { toVisibilityGroups, toVisibilityGroupsRule, } from './visibility-auth-rule.js';
 export function isVisibilityElement(node) {
     return ((node.type === 'mdxJsxFlowElement' || node.type === 'mdxJsxTextElement') &&
@@ -655,12 +655,38 @@ function unfoldComponentElement(node, name, ctx) {
     var _a;
     if (name === 'Visibility')
         return undefined;
+    if (name === 'Variation' && !ctx.defs.has(name))
+        return unfoldVariation(node, ctx);
     const baseName = name.split('.')[0];
     if (baseName === undefined || !/^[A-Z]/.test(baseName))
         return undefined;
     const element = name === 'Steps' ? withStepDefaults(node, ctx) : node;
     return (_a = unfoldUsage(element, name, ctx)) !== null && _a !== void 0 ? _a : unfoldForeignUsage(element, name, ctx);
 }
+/**
+ * A `Variation` becomes its options' labels in bold, followed by its content. One whose `is`
+ * cannot be evaluated keeps its tag, and one with no valid ids renders nothing, as on the page.
+ */
+function unfoldVariation(node, ctx) {
+    const failed = new Set();
+    const props = collectUsageProps(node, ctx, failed);
+    if (failed.has('is') || failed.has(FAILED_SPREAD))
+        return undefined;
+    const ids = variationIds(props.get('is'));
+    if (ids.length === 0)
+        return [];
+    const title = ids.map((id) => { var _a, _b; return (_b = (_a = ctx.variationLabels) === null || _a === void 0 ? void 0 : _a.get(id)) !== null && _b !== void 0 ? _b : id; }).join(', ');
+    return wrapPhrasingRuns([
+        ...parseMarkdown(headlineMarkdown(title, undefined), ctx),
+        ...transformChildren([...node.children], ctx),
+    ]);
+}
+const isStaticArray = (value) => Array.isArray(value);
+function variationIds(value) {
+    const values = isStaticArray(value) ? value : [value];
+    const ids = values.map((id) => (typeof id === 'string' ? id.trim() : ''));
+    return ids.every((id) => id !== '') ? ids : [];
+}
 /** `Steps` numbers its `Step` children and passes its `titleSize` down; a Step's own props win. */
 function withStepDefaults(node, ctx) {
     const titleSize = collectUsageProps(node, ctx).get('titleSize');
@@ -859,9 +885,9 @@ function normalizeGfmAlerts(nodes) {
         }
     }
 }
-export const remarkVisibilityForMarkdown = () => (tree) => {
+export const remarkVisibilityForMarkdown = ({ variationLabels } = {}) => (tree) => {
     const componentContext = collectMarkdownComponentContext(tree);
-    const ctx = Object.assign(Object.assign({}, componentContext), { stack: [], budget: createUnfoldBudget() });
+    const ctx = Object.assign(Object.assign({}, componentContext), { stack: [], budget: createUnfoldBudget(), variationLabels: new Map(Object.entries(variationLabels !== null && variationLabels !== void 0 ? variationLabels : {})) });
     tree.children = transformChildren(tree.children, ctx);
     normalizeGfmAlerts(tree.children);
 };

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

@@ -25,6 +25,8 @@ export type UnfoldContext = MarkdownComponentContext & {
      * At the page level this is the literal scope.
      */
     trusted?: EvalEnv;
+    /** `docs.json` variation labels by id. */
+    variationLabels?: ReadonlyMap<string, string>;
 };
 /** The environment holding only values that no write the evaluator cannot see can make stale. */
 export declare function trustedEnv(ctx: UnfoldContext): EvalEnv;

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

@@ -274,7 +274,7 @@ export function dropPairedDarkOnly(children, classOf) {
     });
     return children.filter((_, index) => !dropped.has(index));
 }
-export const KEEP_TAG_COMPONENTS = new Set(['Variation', 'View', 'Snippet']);
+export const KEEP_TAG_COMPONENTS = new Set(['Variation', 'Snippet']);
 export const HEADLINE_ATTRIBUTES = ['title', 'label', 'name', 'path'];
 export const GFM_ALERT_PATTERN = /^\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]/;
 export function prefixBlockquoteLines(text) {

package/dist/mdx/remark.d.ts

@@ -1,4 +1,6 @@
 import { type RemarkUserMentionsOptions } from './plugins/remark/remarkUserMentions.js';
+import { type RemarkVisibilityForMarkdownOptions } from './plugins/remark/remarkVisibilityForMarkdown.js';
 export { coreRemark, coreRemarkMdxPlugins, getAST, stringifyTree, stringifyTreeForAgents, } from './remark-core.js';
 export declare function stripVisibilityForMarkdown(mdx: string): string;
-export declare function transformContentForMarkdown(mdx: string, mentionOptions?: RemarkUserMentionsOptions): string;
+export type TransformContentForMarkdownOptions = RemarkUserMentionsOptions & RemarkVisibilityForMarkdownOptions;
+export declare function transformContentForMarkdown(mdx: string, { variationLabels, ...mentionOptions }?: TransformContentForMarkdownOptions): string;

package/dist/mdx/remark.js

@@ -1,5 +1,16 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { remarkUserMentions, } from './plugins/remark/remarkUserMentions.js';
-import { remarkVisibilityForMarkdown } from './plugins/remark/remarkVisibilityForMarkdown.js';
+import { remarkVisibilityForMarkdown, } from './plugins/remark/remarkVisibilityForMarkdown.js';
 import { getAST, stringifyTreeForAgents } from './remark-core.js';
 export { coreRemark, coreRemarkMdxPlugins, getAST, stringifyTree, stringifyTreeForAgents, } from './remark-core.js';
 export function stripVisibilityForMarkdown(mdx) {
@@ -7,9 +18,10 @@ export function stripVisibilityForMarkdown(mdx) {
     remarkVisibilityForMarkdown()(tree);
     return stringifyTreeForAgents(tree);
 }
-export function transformContentForMarkdown(mdx, mentionOptions = {}) {
+export function transformContentForMarkdown(mdx, _a = {}) {
+    var { variationLabels } = _a, mentionOptions = __rest(_a, ["variationLabels"]);
     const tree = getAST(mdx);
-    remarkVisibilityForMarkdown()(tree);
+    remarkVisibilityForMarkdown({ variationLabels })(tree);
     remarkUserMentions(mentionOptions)(tree);
     return stringifyTreeForAgents(tree);
 }