@mintlify/msft-sdk 1.1.9 → 1.1.11

package/dist/index.d.ts

@@ -1,6 +1,46 @@
+import { ClassValue } from 'clsx';
 import { default as default_2 } from 'react';
+import { Element as Element_2 } from 'hast';
+import { Handle } from 'hast-util-to-mdast';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
-import { ReactNode } from 'react';
+import { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+import { Node as Node_2 } from 'unist';
+import { Node as Node_3 } from 'hast';
+import { Plugin as Plugin_2 } from 'unified';
+import * as React_2 from 'react';
+import { Root } from 'mdast';
+import { Root as Root_2 } from 'hast';
+import { State } from 'hast-util-to-mdast';
+import { Text as Text_2 } from 'hast';
+
+export declare const allComponents: {
+    CodeBlock: typeof CodeBlock;
+    Heading: ({ id, level, children, className, }: HeadingProps) => JSX_2.Element;
+    Link: typeof Link;
+    Callout: typeof Callout;
+    ZonePivot: typeof ZonePivot;
+    ZoneTarget: typeof ZoneTarget;
+    ParamName: typeof ParamName;
+    Tabs: typeof Tabs;
+    Tab: typeof Tab;
+    Details: typeof Details;
+    Summary: typeof Summary;
+};
+
+declare interface ApiReferenceContextValue {
+    apiReferenceData2?: any;
+    docsConfig?: any;
+    mdxExtracts?: any;
+}
+
+export declare function ApiReferenceProvider2({ apiReferenceData2, docsConfig, mdxExtracts, children, }: ApiReferenceProvider2Props): JSX_2.Element;
+
+declare interface ApiReferenceProvider2Props {
+    apiReferenceData2?: any;
+    docsConfig?: any;
+    mdxExtracts?: any;
+    children: default_2.ReactNode;
+}
 
 export declare interface BottomLinkConfig {
     href: string;
@@ -10,7 +50,31 @@ export declare interface BottomLinkConfig {
     }>;
 }
 
-export declare interface ComponentsContextValue {
+export declare function Callout({ type, children }: CalloutProps): JSX_2.Element;
+
+declare interface CalloutProps {
+    type: CalloutType;
+    children: React.ReactNode;
+}
+
+declare type CalloutType = "note" | "tip" | "important" | "caution" | "warning" | "nextstepaction";
+
+export declare const capitalize: (str: string) => string;
+
+export declare function cn(...inputs: ClassValue[]): string;
+
+export declare function CodeBlock({ children, className, fileName, language, blob, contentType, }: CodeBlockProps): JSX_2.Element;
+
+declare interface CodeBlockProps {
+    children: default_2.ReactNode;
+    className?: string;
+    language?: string;
+    fileName?: string;
+    blob?: Blob;
+    contentType?: string;
+}
+
+declare interface ComponentsContextValue {
     LinkComponent?: LinkComponent;
 }
 
@@ -19,21 +83,12 @@ export declare function ComponentsProvider({ children, LinkComponent, }: {
     LinkComponent?: LinkComponent;
 }): JSX_2.Element;
 
-declare type ContextualOption = {
-    id: string;
-    title: string;
-    description: string;
-    icon: default_2.ElementType;
-    action: () => void;
-    externalLink?: boolean;
-};
-
 export declare function convertHtmlToMdx(html: string, options?: ConvertOptions): Promise<{
     mdx: string;
     mdxExtracts: MdxExtracts;
 }>;
 
-declare interface ConvertOptions {
+export declare interface ConvertOptions {
     metadata?: Record<string, unknown>;
     mdxExtracts?: MdxExtracts;
     images?: {
@@ -41,131 +96,35 @@ declare interface ConvertOptions {
     };
 }
 
-/**
- * DocsLayout component provides a complete documentation layout with sidebar navigation
- * and main content area. It's designed to be scalable, customizable, and tree-shakable.
- *
- * @example
- * ```tsx
- * <DocsLayout
- *   navTree={{ items: [...] }}
- *   activeHref="/docs/getting-started"
- *   theme="dark"
- *   bottomLinks={[
- *     { href: "https://blog.com", label: "Blog", icon: BlogIcon }
- *   ]}
- *   LinkComponent={Link}
- * >
- *   <YourPageContent />
- * </DocsLayout>
- * ```
- */
-export declare const DocsLayout: ({ navTree, children, activeHref, activeId, theme, className, bottomLinks, dropdown, LinkComponent, localization, telemetry, showSidebar, sidebarClassName, }: DocsLayoutProps) => JSX_2.Element;
-
-/**
- * Localization strings for DocsLayout
- */
-export declare interface DocsLayoutLocalization {
-    /** Aria label for the sidebar navigation. Default: "Sidebar navigation" */
-    sidebarAriaLabel?: string;
-}
-
-/**
- * Props for the DocsLayout component
- */
-export declare interface DocsLayoutProps {
-    /** Navigation tree data structure */
-    navTree: NavTreeData;
-    /** The main content to render in the layout */
-    children: ReactNode;
-    /** Currently active href for navigation highlighting */
-    activeHref?: string;
-    /** Currently active ID for navigation highlighting */
-    activeId?: string;
-    /** Theme for the layout */
-    theme?: "light" | "dark";
-    /** Additional CSS classes for the outer container */
-    className?: string;
-    /** Bottom links configuration (e.g., blog, GitHub, feedback) */
-    bottomLinks?: BottomLinkConfig[];
-    /** Dropdown configuration for navigation */
-    dropdown?: DropdownConfig;
-    /** Custom Link component for navigation (e.g., React Router Link, Next.js Link) */
+export declare interface CopyMarkdownOptions {
+    pathname: string;
+    onSuccess?: () => void;
+    onFail?: (error: unknown) => void;
+}
+
+export declare const copyMarkdownToClipboard: ({ pathname, onSuccess, onFail, }: CopyMarkdownOptions) => void;
+
+export declare function createDefaultComponents(options?: CreateDefaultComponentsOptions): MDXComponents;
+
+export declare interface CreateDefaultComponentsOptions {
     LinkComponent?: LinkComponent;
-    /** Localization strings */
-    localization?: DocsLayoutLocalization;
-    /** Telemetry configuration */
-    telemetry?: DocsLayoutTelemetry;
-    /** Whether to show the sidebar. Default: true */
-    showSidebar?: boolean;
-    /** Custom className for the sidebar to control responsive behavior.
-     * Default: "mint:max-lg:hidden" (hidden below lg breakpoint) */
-    sidebarClassName?: string;
-}
-
-/**
- * Telemetry configuration for DocsLayout
- */
-export declare interface DocsLayoutTelemetry {
-    /** Activity name for bottom link clicks */
-    bottomLinkActivity?: string;
-    /** Phase for bottom link clicks (e.g., "Start", "Complete") */
-    bottomLinkPhase?: string;
-}
-
-/**
- * DocsPage component renders a documentation page with MDX content, table of contents,
- * zone pivot selectors, and page context menu. It supports full customization through
- * props for localization, telemetry, and custom components.
- *
- * @example
- * ```tsx
- * <DocsPage
- *   payload={{
- *     content: "...",
- *     serializedContent: Content,
- *     title: "Getting Started",
- *     description: "Learn how to get started"
- *   }}
- *   toc={[{ title: "Introduction", slug: "intro", level: 2 }]}
- *   theme="dark"
- *   pathname="/docs/getting-started"
- *   LinkComponent={Link}
- *   localization={{
- *     onThisPage: "In this article"
- *   }}
- *   telemetry={{
- *     contextMenuActivity: "DocsPageContextMenu",
- *     contextMenuPhase: "Start"
- *   }}
- * />
- * ```
- */
-export declare function DocsPage({ payload, toc, navTree, dropdown, activeHref, theme, className, pathname, markdownContent, allPages, baseUrl, bottomLinks, LinkComponent, localization, telemetry, contextMenu, }: EnhancedDocsPageProps): JSX_2.Element;
-
-/**
- * Localization strings for DocsPage component
- */
-export declare interface DocsPageLocalization {
-    /** Text for "On this page" heading. Default: "On this page" */
-    onThisPage?: string;
-    /** Loading message. Default: "Loading..." */
-    loading?: string;
-    /** Error title. Default: "Error" */
-    errorTitle?: string;
-    /** Generic error message. Default: "Something went wrong" */
-    errorMessage?: string;
-    /** Not found title. Default: "Page not found" */
-    notFoundTitle?: string;
-    /** Not found message. Default: "The page you're looking for doesn't exist" */
-    notFoundMessage?: string;
 }
 
+export declare const defaultComponents: MDXComponents;
+
+export declare function Details({ children, open }: DetailsProps): JSX_2.Element;
+
+declare interface DetailsProps {
+    children: default_2.ReactNode;
+    open?: boolean;
+}
+
+export declare function DocsPage({ payload, toc, navTree, activeHref, theme, className, pathname, markdownContent, allPages, baseUrl, bottomLinks, LinkComponent, }: DocsPageProps): JSX_2.Element;
+
 export declare interface DocsPageProps {
     payload: PayloadData;
     toc?: TocItem[];
     navTree?: NavTreeData;
-    dropdown?: DropdownConfig;
     activeHref?: string;
     theme?: "light" | "dark";
     className?: string;
@@ -177,64 +136,44 @@ export declare interface DocsPageProps {
     LinkComponent?: LinkComponent;
 }
 
-/**
- * Telemetry configuration for DocsPage
- */
-export declare interface DocsPageTelemetry {
-    /** Activity name for page context menu interactions */
-    contextMenuActivity?: string;
-    /** Phase for context menu interactions */
-    contextMenuPhase?: string;
-    /** Activity name for TOC link clicks */
-    tocLinkActivity?: string;
-    /** Phase for TOC link clicks */
-    tocLinkPhase?: string;
-    /** Activity name for zone pivot selector changes */
-    zonePivotActivity?: string;
-    /** Phase for zone pivot changes */
-    zonePivotPhase?: string;
-}
-
-export declare interface DropdownConfig {
-    title: string;
-    description: string;
-    icon?: default_2.ComponentType<{
-        className?: string;
-    }>;
-    color?: {
-        light?: string;
-        dark?: string;
-    };
-    items?: DropdownItem[];
-}
-
-export declare interface DropdownItem {
-    title: string;
-    href?: string;
-    description?: string;
-    icon?: default_2.ComponentType<{
-        className?: string;
-    }>;
-}
+export declare type ElementType = {
+    type?: string;
+    tagName?: string;
+};
 
-/**
- * Enhanced DocsPageProps with localization and telemetry support
- */
-export declare interface EnhancedDocsPageProps extends DocsPageProps {
-    /** Localization strings */
-    localization?: DocsPageLocalization;
-    /** Telemetry configuration */
-    telemetry?: DocsPageTelemetry;
-    /** Context menu configuration */
-    contextMenu?: PageContextMenuConfig;
-}
+export declare function extractHeadings(): (tree: Node_2, file: unknown) => void;
 
 export declare function generateLlmsFullTxt(pages: LlmsPageConfig[], baseUrl: string): Promise<string>;
 
 export declare function generateLlmsTxt(pages: LlmsPageConfig[], baseUrl: string): string;
 
+export declare function getClassNames(element: Element_2): string[];
+
+export declare const getNodeText: (node: unknown) => string;
+
+export declare function getPageMarkdown(pathname: string): Promise<string>;
+
+export declare function getTextContent(node: Element_2 | Text_2): string;
+
+export declare const Heading: ({ id, level, children, className, }: HeadingProps) => JSX_2.Element;
+
+declare interface HeadingProps {
+    id: string;
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    children: default_2.ReactNode;
+    className?: string;
+}
+
 export declare const Home: () => JSX_2.Element;
 
+export declare function isElement<T extends ElementType = Element_2>(node: ElementType | undefined, key?: keyof T, element?: string): node is T & {
+    data?: {
+        meta?: unknown;
+    };
+};
+
+export declare function Link({ href, children, className }: LinkProps): JSX_2.Element;
+
 export declare type LinkComponent = default_2.ComponentType<LinkComponentProps>;
 
 export declare interface LinkComponentProps extends default_2.AnchorHTMLAttributes<HTMLAnchorElement> {
@@ -242,6 +181,12 @@ export declare interface LinkComponentProps extends default_2.AnchorHTMLAttribut
     className?: string;
 }
 
+declare interface LinkProps {
+    href?: string;
+    children: default_2.ReactNode;
+    className?: string;
+}
+
 export declare interface LlmsPageConfig {
     title: string;
     slug: string;
@@ -256,7 +201,7 @@ export declare interface LlmsPageConfig {
     };
 }
 
-declare interface MDXComponents {
+export declare interface MDXComponents {
     h1?: default_2.ComponentType<any>;
     h2?: default_2.ComponentType<any>;
     h3?: default_2.ComponentType<any>;
@@ -294,6 +239,8 @@ export declare interface MdxExtracts {
     pivotTocItems?: Record<string, TocItem[]>;
 }
 
+export declare function mdxJsxFlowElementHandler(state: State, node: Element_2): MdxJsxFlowElement;
+
 export declare function MDXRenderer({ children, components }: MDXRendererProps): JSX_2.Element;
 
 declare interface MDXRendererProps {
@@ -301,7 +248,7 @@ declare interface MDXRendererProps {
     components?: MDXComponents;
 }
 
-export declare function MobileNavTree({ isOpen, setIsOpen, navTree, activeId, className, theme, dropdown, activeHref, bottomLinks, LinkComponent, }: MobileNavTreeProps): JSX_2.Element;
+export declare function MobileNavTree({ isOpen, setIsOpen, navTree, activeId, className, theme, activeHref, bottomLinks, LinkComponent, }: MobileNavTreeProps): JSX_2.Element;
 
 declare interface MobileNavTreeProps {
     isOpen: boolean;
@@ -310,7 +257,6 @@ declare interface MobileNavTreeProps {
     activeId?: string;
     className?: string;
     theme?: "light" | "dark" | "system";
-    dropdown?: DropdownConfig;
     activeHref?: string;
     bottomLinks?: BottomLinkConfig[];
     LinkComponent?: LinkComponent;
@@ -324,9 +270,10 @@ export declare interface NavItem {
     icon?: default_2.ComponentType<{
         className?: string;
     }>;
+    method?: string;
 }
 
-export declare function NavTree({ navTree, activeId, className, dropdown, activeHref, theme, bottomLinks, }: NavTreeProps): JSX_2.Element | null;
+export declare function NavTree({ navTree, activeId, className, activeHref, theme, bottomLinks, }: NavTreeProps): JSX_2.Element | null;
 
 export declare interface NavTreeData {
     items: NavItem[];
@@ -336,49 +283,27 @@ declare interface NavTreeProps {
     navTree: NavTreeData;
     activeId?: string;
     className?: string;
-    dropdown?: DropdownConfig;
     activeHref?: string;
     theme?: "light" | "dark" | "system";
     bottomLinks?: BottomLinkConfig[];
 }
 
-export declare const PageContextMenu: ({ className, pathname, markdownContent, onCopyMarkdown, onCopyPage, onViewMarkdown, onViewLlmsTxt, onViewLlmsFullTxt, allPages, baseUrl, customActions, }: PageContextMenuProps) => JSX_2.Element;
-
-/**
- * Configuration for the page context menu
- */
-declare interface PageContextMenuConfig {
-    /** Custom actions for the page context menu. If provided, these will replace the default actions. */
-    customActions?: ContextualOption[];
-    /** Callback fired after markdown is successfully copied */
-    onCopyMarkdown?: () => void;
-    /** Custom handler for "Copy Page" action. If provided, replaces default copy behavior. */
-    onCopyPage?: () => void | Promise<void>;
-    /** Custom handler for "View as Markdown" action. If provided, replaces default view behavior. */
-    onViewMarkdown?: (pathname: string) => void;
-    /** Custom handler for "View llms.txt" action. If provided, replaces default behavior. */
-    onViewLlmsTxt?: () => void;
-    /** Custom handler for "View llms-full.txt" action. If provided, replaces default behavior. */
-    onViewLlmsFullTxt?: () => void;
-}
+export declare const PageContextMenu: ({ className, pathname, markdownContent, onCopyMarkdown, onViewMarkdown, allPages, baseUrl, }: PageContextMenuProps) => JSX_2.Element;
 
 export declare interface PageContextMenuProps {
     className?: string;
     pathname: string;
     markdownContent?: string;
-    /** Callback fired after markdown is successfully copied */
     onCopyMarkdown?: () => void;
-    /** Custom handler for "Copy Page" action. If provided, replaces default copy behavior. */
-    onCopyPage?: () => void | Promise<void>;
-    /** Custom handler for "View as Markdown" action. If provided, replaces default view behavior. */
     onViewMarkdown?: (pathname: string) => void;
-    /** Custom handler for "View llms.txt" action. If provided, replaces default behavior. */
-    onViewLlmsTxt?: () => void;
-    /** Custom handler for "View llms-full.txt" action. If provided, replaces default behavior. */
-    onViewLlmsFullTxt?: () => void;
     allPages?: LlmsPageConfig[];
     baseUrl?: string;
-    customActions?: ContextualOption[];
+}
+
+export declare function ParamName({ children }: ParamNameProps): JSX_2.Element;
+
+declare interface ParamNameProps {
+    children: React.ReactNode;
 }
 
 export declare interface PayloadData {
@@ -403,14 +328,86 @@ export declare interface PlainTextPageProps {
     content: string;
 }
 
+export declare const rehypeCallouts: Plugin_2<[], Node_3>;
+
+export declare const rehypeCodeblocks: Plugin_2<[], Node_3>;
+
+export declare const rehypeDetails: Plugin_2<[], Node_3>;
+
+export declare const rehypeHeadingIds: Plugin_2<[], Node_3>;
+
+export declare const rehypeParamName: Plugin_2<[], Node_3>;
+
+export declare function rehypeRemark(): (tree: Root_2) => Root;
+
+export declare function rehypeRemoveHtmlComments(): (root: Root_2) => void;
+
+export declare const rehypeTabs: Plugin_2<[], Node_3>;
+
+export declare const rehypeZonePivots: Plugin_2<[ConvertOptions?], Node_3>;
+
+export declare function remarkHeadingIds(): (tree: Root) => void;
+
+export declare function removeHtmlComments(root: Root_2): void;
+
+export declare const sanitizePreTags: Plugin_2<[], Node_3>;
+
 export declare function serializeMdx(mdxString: string): Promise<default_2.ComponentType>;
 
+export declare function Summary({ children, isOpen }: SummaryProps): JSX_2.Element;
+
+declare interface SummaryProps {
+    children: default_2.ReactNode;
+    isOpen?: boolean;
+}
+
+export declare function Tab({ children }: TabProps): JSX_2.Element;
+
+export declare const Table: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableElement> & React_2.RefAttributes<HTMLTableElement>>;
+
+export declare const TableBody: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
+
+export declare const TableCaption: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableCaptionElement> & React_2.RefAttributes<HTMLTableCaptionElement>>;
+
+export declare const TableCell: React_2.ForwardRefExoticComponent<React_2.TdHTMLAttributes<HTMLTableCellElement> & React_2.RefAttributes<HTMLTableCellElement>>;
+
+export declare const tableCellHandler: Handle;
+
+export declare const TableFooter: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
+
+export declare const tableHandler: Handle;
+
+export declare const TableHead: React_2.ForwardRefExoticComponent<React_2.ThHTMLAttributes<HTMLTableCellElement> & React_2.RefAttributes<HTMLTableCellElement>>;
+
+export declare const TableHeader: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
+
 export declare function TableOfContents({ toc }: TableOfContentsProps): JSX_2.Element;
 
 declare interface TableOfContentsProps {
     toc: TocItem[];
 }
 
+export declare const TableRow: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableRowElement> & React_2.RefAttributes<HTMLTableRowElement>>;
+
+export declare const tableRowHandler: Handle;
+
+declare interface TabProps {
+    title: string;
+    icon?: string;
+    children?: default_2.ReactNode;
+}
+
+export declare function Tabs({ children, defaultTab, defaultTabIndex, className, onClickTab, onChange }: TabsProps): JSX_2.Element;
+
+declare interface TabsProps {
+    children: default_2.ReactNode;
+    defaultTab?: number;
+    defaultTabIndex?: number;
+    className?: string;
+    onClickTab?: (index: number) => void;
+    onChange?: (index: number) => void;
+}
+
 export declare interface TocItem {
     title: string;
     slug: string;
@@ -418,10 +415,14 @@ export declare interface TocItem {
     children?: TocItem[];
 }
 
+export declare function useApiReference(): ApiReferenceContextValue | undefined;
+
 export declare function useComponents(): ComponentsContextValue;
 
 export declare function useMarkdownCopy(pathname: string): void;
 
+export declare function ZonePivot({ pivot, target, children }: ZonePivotProps): JSX_2.Element | null;
+
 export declare interface ZonePivotGroup {
     id: string;
     title: string;
@@ -432,6 +433,12 @@ export declare interface ZonePivotGroup {
     }>;
 }
 
+declare interface ZonePivotProps {
+    pivot: string;
+    target?: string;
+    children: default_2.ReactNode;
+}
+
 export declare function ZonePivotProvider({ groups, children, defaultPivots, }: ZonePivotProviderProps): JSX_2.Element;
 
 declare interface ZonePivotProviderProps {
@@ -447,4 +454,11 @@ declare interface ZonePivotSelectorProps {
     className?: string;
 }
 
+export declare function ZoneTarget({ target, children }: ZoneTargetProps): JSX_2.Element;
+
+declare interface ZoneTargetProps {
+    target: string;
+    children: default_2.ReactNode;
+}
+
 export { }