@mintlify/msft-sdk 1.1.23 → 1.1.25

package/dist/index.d.ts

@@ -1,18 +1,61 @@
+import { ApiPlaygroundDisplayType } from '@mintlify/models';
+import { ApiPlaygroundInputs } from '@mintlify/validation';
+import { ApiPlaygroundResultType } from '@mintlify/models';
+import { AsyncAPIDocumentInterface } from '@mintlify/common';
+import { ChannelData } from '@mintlify/common';
 import { ClassValue } from 'clsx';
+import { CodeSample } from '@mintlify/validation';
+import { Context } from 'react';
+import { DecoratedNavigationConfig } from '@mintlify/validation';
 import { default as default_2 } from 'react';
+import { DeploymentEntitlements } from '@mintlify/validation';
+import { DeploymentFeedbackType } from '@mintlify/validation';
+import { DeploymentPreviewType } from '@mintlify/validation';
+import { DocsConfig } from '@mintlify/validation';
 import { Element as Element_2 } from 'hast';
+import { Endpoint } from '@mintlify/validation';
+import { GitSource } from '@mintlify/validation';
 import { Handle } from 'hast-util-to-mdast';
+import { IncrementalDataSchemaArray } from '@mintlify/validation';
+import { InkeepType } from '@mintlify/models';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { MdxExtracts as MdxExtracts_2 } from '@mintlify/common';
 import { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+import { MintConfig } from '@mintlify/models';
 import { Node as Node_2 } from 'unist';
 import { Node as Node_3 } from 'hast';
+import { OpenApiMetadata } from '@mintlify/models';
+import { OpenAPIV3 } from 'openapi-types';
+import { OpenAPIV3_1 } from 'openapi-types';
+import { Operation } from '@mintlify/validation';
+import { PageMetaTags } from '@mintlify/models';
+import { PageType } from '@mintlify/models';
+import { ParameterObject } from '@mintlify/validation';
 import { Plugin as Plugin_2 } from 'unified';
 import * as React_2 from 'react';
 import { ReactNode } from 'react';
+import { RequestBodyObject } from '@mintlify/validation';
+import { ResponseObject } from '@mintlify/validation';
 import { Root } from 'mdast';
 import { Root as Root_2 } from 'hast';
+import { SchemaGraphData } from '@mintlify/validation';
+import { SchemaObject } from '@mintlify/validation';
+import { SecurityOption } from '@mintlify/validation';
+import { SerializeSuccess } from '@mintlify/mdx/types';
+import { ServerObject } from '@mintlify/validation';
 import { State } from 'hast-util-to-mdast';
+import { StoreApi } from 'zustand';
 import { Text as Text_2 } from 'hast';
+import { TrieveType } from '@mintlify/validation';
+import { UseBoundStore } from 'zustand';
+import { UUID } from '@mintlify/validation';
+
+export declare const addApiReferenceDataFromMdxAndDocsConfig: ({ pageMetadata, apiReferenceData2, mdxExtracts, docsConfig, }: {
+    pageMetadata: PageMetaTags;
+    apiReferenceData2: ApiReferenceDataV2 | undefined;
+    mdxExtracts: MdxExtracts_2 | undefined;
+    docsConfig: DocsConfig | undefined;
+}) => ApiReferenceDataV2;
 
 export declare const allComponents: {
     CodeBlock: typeof CodeBlock;
@@ -28,21 +71,129 @@ export declare const allComponents: {
     Summary: typeof Summary;
 };
 
+export declare interface AnchorConfig {
+    href: string;
+    title: string;
+    description?: string;
+    icon?: default_2.ComponentType<{
+        className?: string;
+    }>;
+}
+
+export declare const Api: ({ children }: {
+    children: ReactNode;
+}) => JSX_2.Element | null;
+
+export declare const ApiExamples: ({ className, isModal, apiReferenceData, noInputs }: ApiExamplesProps) => JSX_2.Element;
+
+declare type ApiExamplesProps = {
+    className?: string;
+    isModal?: boolean;
+    apiReferenceData?: ApiReferenceDataV2;
+    noInputs?: boolean;
+};
+
+export declare function ApiFields({ pageMetadata }: {
+    pageMetadata: PageMetaTags;
+}): JSX_2.Element;
+
+export declare const ApiPlayground: ({ endpoint, display, pathname }: ApiPlaygroundParams) => JSX_2.Element;
+
+export declare const ApiPlaygroundContext: Context<ApiPlaygroundContextType>;
+
+export declare const ApiPlaygroundContextLegacy: Context<ApiPlaygroundContextTypeLegacy>;
+
+export declare type ApiPlaygroundContextType = {
+    isSending?: boolean;
+    sendRequest?: () => void;
+    isPlaygroundExpanded: boolean;
+    result?: ApiPlaygroundResultType;
+    selectedBaseUrlIndex: number;
+    setSelectedBaseUrlIndex?: (index: number) => void;
+    setIsPlaygroundExpanded?: (expanded: boolean) => void;
+    baseUrlOptions?: string[];
+    selectedExampleIndex?: number;
+    setSelectedExampleIndex?: (index: number) => void;
+};
+
+export declare type ApiPlaygroundContextTypeLegacy = {
+    isSending?: boolean;
+    sendRequest?: () => void;
+    isPlaygroundExpanded: boolean;
+    result?: ApiPlaygroundResultType;
+    selectedBaseUrlIndex: number;
+    setSelectedBaseUrlIndex?: (index: number) => void;
+    setIsPlaygroundExpanded?: (expanded: boolean) => void;
+    baseUrlOptions?: string[];
+    selectedExampleIndex?: number;
+    setSelectedExampleIndex?: (index: number) => void;
+};
+
+declare type ApiPlaygroundParams = {
+    endpoint: Endpoint;
+    display: ApiPlaygroundDisplayType;
+    pathname: string;
+};
+
+export declare const ApiReferenceContext: Context<ApiReferenceContextType>;
+
+export declare const ApiReferenceContext2: Context<ApiReferenceContext2Type>;
+
+export declare type ApiReferenceContext2Type = {
+    apiReferenceData2: ApiReferenceDataV2;
+};
+
+export declare type ApiReferenceContextType = {
+    apiReferenceData: ApiReferenceData;
+};
+
 declare interface ApiReferenceContextValue {
     apiReferenceData2?: any;
     docsConfig?: any;
     mdxExtracts?: any;
 }
 
-export declare function ApiReferenceProvider2({ apiReferenceData2, docsConfig, mdxExtracts, children, }: ApiReferenceProvider2Props): JSX_2.Element;
+declare type ApiReferenceData = {
+    metadata?: OpenApiMetadata;
+    endpoint?: Endpoint;
+    schemaData?: SchemaData;
+    componentSchemas?: ComponentSchemas;
+    channel?: ChannelData;
+    channelId?: string;
+    document?: AsyncAPIDocumentInterface;
+};
 
-declare interface ApiReferenceProvider2Props {
-    apiReferenceData2?: any;
-    docsConfig?: any;
-    mdxExtracts?: any;
-    children: default_2.ReactNode;
+export declare interface ApiReferenceDataV2 {
+    filename?: string;
+    originalFileLocation?: string;
+    operation?: OperationV2;
+    schemaData?: SchemaV2;
+    dependencies?: {
+        parameters?: Record<UUID, ParameterObject>;
+        requestBody?: RequestBodyObject;
+        responses?: Record<UUID, ResponseObject>;
+        servers: Record<UUID, ServerObject>;
+        security: Record<UUID, ResolvedSecurityObject>;
+        processedSecurityOptions?: ProcessedSecurityOption[];
+        schemas?: Record<UUID, SchemaObject>;
+    };
 }
 
+export declare function ApiReferenceProvider({ value, children, }: {
+    value: ApiReferenceContextType;
+    children: ReactNode;
+}): JSX_2.Element;
+
+export declare function ApiReferenceProvider2({ pageMetadata, docsConfig, mdxExtracts, apiReferenceData2, children, }: ApiReferenceProvider2Props): JSX_2.Element;
+
+export declare type ApiReferenceProvider2Props = {
+    pageMetadata: PageMetaTags;
+    docsConfig: DocsConfig | undefined;
+    mdxExtracts: MdxExtracts_2 | undefined;
+    apiReferenceData2: ApiReferenceDataV2 | undefined;
+    children: ReactNode;
+};
+
 export declare interface BottomLinkConfig {
     href: string;
     label: string;
@@ -62,6 +213,12 @@ declare type CalloutType = "note" | "tip" | "important" | "caution" | "warning"
 
 export declare const capitalize: (str: string) => string;
 
+declare const CIRCULAR_REF_KEY = "$circularRef";
+
+export declare type CircularRefObject = {
+    [CIRCULAR_REF_KEY]: UUID;
+};
+
 export declare function cn(...inputs: ClassValue[]): string;
 
 export declare function CodeBlock({ children, className, fileName, language, blob, contentType, }: CodeBlockProps): JSX_2.Element;
@@ -75,6 +232,15 @@ declare interface CodeBlockProps {
     contentType?: string;
 }
 
+export declare type CodeExample = {
+    dropdown?: boolean;
+    language?: string;
+    code?: string | default_2.ReactElement | default_2.ReactElement[];
+    filename?: string;
+};
+
+declare type ComponentSchemas = Record<string, OpenAPIV3_1.SchemaObject>;
+
 declare interface ComponentsContextValue {
     LinkComponent?: LinkComponent;
 }
@@ -121,6 +287,26 @@ export declare interface CreateDefaultComponentsOptions {
 
 export declare const defaultComponents: MDXComponents;
 
+export declare const DeploymentMetadataContext: Context<DeploymentMetadataContextType>;
+
+export declare type DeploymentMetadataContextType = {
+    subdomain?: string;
+    actualSubdomain?: string;
+    gitSource?: GitSource;
+    inkeep?: InkeepType;
+    trieve?: TrieveType;
+    feedback?: DeploymentFeedbackType;
+    entitlements?: DeploymentEntitlements;
+    buildId?: string;
+    clientVersion?: string;
+    preview?: DeploymentPreviewType;
+};
+
+export declare function DeploymentMetadataProvider({ value, children, }: {
+    value: DeploymentMetadataContextType;
+    children: ReactNode;
+}): JSX_2.Element;
+
 export declare function Details({ children, open }: DetailsProps): JSX_2.Element;
 
 declare interface DetailsProps {
@@ -128,6 +314,21 @@ declare interface DetailsProps {
     open?: boolean;
 }
 
+export declare type DifferentiatedType = SchemaObject['type'] | 'oneOf' | 'any' | 'enum<string>' | 'enum<number>' | 'enum<integer>' | 'file';
+
+export declare const DocsConfigContext: Context<DocsConfigContextType>;
+
+export declare type DocsConfigContextType = {
+    mintConfig?: MintConfig;
+    docsConfig?: DocsConfig;
+    docsNavWithMetadata?: DecoratedNavigationConfig;
+};
+
+export declare function DocsConfigProvider({ value, children, }: {
+    value: DocsConfigContextType;
+    children: ReactNode;
+}): JSX_2.Element;
+
 /**
  * DocsLayout component provides a complete documentation layout with sidebar navigation
  * and main content area. It's designed to be scalable, customizable, and tree-shakable.
@@ -297,12 +498,35 @@ export declare type ElementType = {
     tagName?: string;
 };
 
+export declare const EndpointFields: () => JSX_2.Element | null;
+
+export declare const EndpointHeader: ({ onCopy, baseUrlOptions, selectedBaseUrlIndex, setSelectedBaseUrlIndex, isCopiedActive, display, path, method, onBaseUrlChange, isInPlaygroundModal, }: EndpointHeaderProps) => JSX_2.Element;
+
+declare type EndpointHeaderProps = {
+    onCopy: () => void;
+    baseUrlOptions: string[];
+    selectedBaseUrlIndex: number;
+    setSelectedBaseUrlIndex: (index: number) => void;
+    isCopiedActive: boolean;
+    isInPlaygroundModal: boolean;
+    display: 'simple' | 'none' | 'interactive';
+    path: string;
+    method: string;
+    onBaseUrlChange: () => void;
+    children?: React.ReactNode;
+};
+
 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 const getApiReferenceDataFromGraph: ({ metadata, schemaGraphData, }: {
+    metadata: PageMetaTags;
+    schemaGraphData: SchemaGraphData;
+}) => ApiReferenceDataV2;
+
 export declare function getClassNames(element: Element_2): string[];
 
 export declare const getNodeText: (node: unknown) => string;
@@ -357,6 +581,9 @@ export declare interface LlmsPageConfig {
     };
 }
 
+declare type Location_2 = 'request' | 'response';
+export { Location_2 as Location }
+
 export declare interface MDXComponents {
     h1?: default_2.ComponentType<any>;
     h2?: default_2.ComponentType<any>;
@@ -429,7 +656,7 @@ export declare interface NavItem {
     method?: string;
 }
 
-export declare function NavTree({ navTree, activeId, className, activeHref, theme, bottomLinks, }: NavTreeProps): JSX_2.Element | null;
+export declare function NavTree({ navTree, activeId, className, activeHref, theme, bottomLinks, anchors, }: NavTreeProps): JSX_2.Element | null;
 
 export declare interface NavTreeData {
     items: NavItem[];
@@ -442,8 +669,36 @@ declare interface NavTreeProps {
     activeHref?: string;
     theme?: "light" | "dark" | "system";
     bottomLinks?: BottomLinkConfig[];
+    anchors?: AnchorConfig[];
 }
 
+export declare const OperationPage: ({ apiReferenceData, operation, children, }: {
+    apiReferenceData: ApiReferenceDataV2;
+    operation: OperationV2;
+    children: ReactNode;
+}) => JSX_2.Element;
+
+export declare type OperationV2 = Operation & {
+    path: string;
+    baseUrl: string | undefined;
+    baseUrlOptions: string[];
+    title: string;
+    description: string;
+    securityRequirements?: SecurityOption[];
+    requestExamples?: CodeExample[];
+    responseExamples?: CodeExample[];
+    codeSamples?: CodeSample[];
+    requestExampleType?: 'mdx' | 'webhook' | 'codeSamples' | 'generated';
+    requestExampleLanguages?: string[];
+    requiredOnlyExamples?: boolean;
+    responseExampleType?: 'mdx' | 'generated';
+    prefillPlaygroundWithExample?: boolean;
+    prefillPlaygroundExamples?: ApiPlaygroundInputs[];
+    disableProxy?: boolean;
+};
+
+export declare const PageContext: Context<PageContextType>;
+
 export declare const PageContextMenu: ({ className, pathname, markdownContent, onCopyMarkdown, onViewMarkdown, allPages, baseUrl, }: PageContextMenuProps) => JSX_2.Element;
 
 /**
@@ -474,6 +729,21 @@ export declare interface PageContextMenuProps {
     baseUrl?: string;
 }
 
+export declare type PageContextType = {
+    pageMetadata: PageMetaTags;
+    pageType?: PageType;
+    mdxExtracts?: MdxExtracts_2;
+    description?: SerializeSuccess | string | null;
+    panelMdxSource?: SerializeSuccess;
+    panelMdxSourceWithNoJs?: SerializeSuccess;
+    pathname?: string;
+};
+
+export declare function PageProvider({ value, children }: {
+    value: PageContextType;
+    children: ReactNode;
+}): JSX_2.Element;
+
 export declare function ParamName({ children }: ParamNameProps): JSX_2.Element;
 
 declare interface ParamNameProps {
@@ -502,6 +772,39 @@ export declare interface PlainTextPageProps {
     content: string;
 }
 
+export declare const Playground: ({ isPlaygroundExpanded, setIsPlaygroundExpanded, baseUrl, baseUrlOptions, apiReferenceData, }: PlaygroundProps) => JSX_2.Element | null;
+
+declare interface PlaygroundInputsState {
+    inputs: Record<string, PlaygroundInputValue>;
+    initialize: (initialValues: Record<string, PlaygroundInputValue>) => void;
+    setInput: (name: string, value: PlaygroundInputValue) => void;
+    setInputs: (inputs: Record<string, PlaygroundInputValue>) => void;
+    replaceInputs: (inputs: Record<string, PlaygroundInputValue>) => void;
+    getInput: (name: string) => PlaygroundInputValue;
+    getApiPlaygroundInputs: () => ApiPlaygroundInputs;
+    clear: () => void;
+    reset: () => void;
+    selectedSecurityOptionIndex: number;
+    setSelectedSecurityOptionIndex: (index: number) => void;
+}
+
+declare type PlaygroundInputValue = unknown;
+
+declare type PlaygroundProps = {
+    isPlaygroundExpanded: boolean;
+    setIsPlaygroundExpanded: (isPlaygroundExpanded: boolean) => void;
+    baseUrl: string;
+    baseUrlOptions: string[];
+    apiReferenceData: ApiReferenceDataV2;
+};
+
+export declare type ProcessedSecurityOption = {
+    scheme: SecuritySchemeAndScope;
+    schema: SchemaObject;
+};
+
+export declare const processSecurityOptions: (apiReferenceData: ApiReferenceDataV2) => ProcessedSecurityOption[];
+
 export declare const rehypeCallouts: Plugin_2<[], Node_3>;
 
 export declare const rehypeCodeblocks: Plugin_2<[], Node_3>;
@@ -524,8 +827,59 @@ export declare function remarkHeadingIds(): (tree: Root) => void;
 
 export declare function removeHtmlComments(root: Root_2): void;
 
+/**
+ * SchemaObject after being processed by the various transformations in `resolveOperationWithDependencies`.
+ * This is the type of object that all the API UI components should be consuming. Any properties that
+ * aren't actually part of the OpenAPI V3/3.1 SchemaObject type should be put here—as such, we should
+ * be very judicious about adding anything to this type!
+ */
+export declare type ResolvedSchemaObject = SchemaObject & {
+    /**
+     * Distinct from the `required` property of the OpenAPI V3/3.1 SchemaObject type, which is either
+     * a boolean on a property (V3) or an array of strings on the parent schema (V3.1). Our version is
+     * determined from whichever one of those is relevant; a UI component doesn't have to do any figuring-out
+     * itself, it just has to check for this property.
+     */
+    isRequired?: boolean;
+    /**
+     * A unique key representing the path to this schema node from the root. Used for generating
+     * unique input keys in the playground data store.
+     */
+    uniqueKey?: string;
+    isCircular?: boolean;
+    type?: DifferentiatedType;
+    [CIRCULAR_REF_KEY]?: UUID;
+};
+
+export declare type ResolvedSecurityObject = {
+    [name: string]: SecuritySchemeAndScope;
+};
+
 export declare const sanitizePreTags: Plugin_2<[], Node_3>;
 
+declare type SchemaData = {
+    schemaArray: IncrementalDataSchemaArray;
+    example: unknown;
+};
+
+export declare type SchemaGeneratedExample = {
+    title: string;
+    description?: string;
+    value: unknown;
+};
+
+export declare const SchemaPage: ({ apiReferenceData, children, }: {
+    apiReferenceData: ApiReferenceDataV2;
+    children: ReactNode;
+}) => JSX_2.Element | null;
+
+export declare type SchemaV2 = SchemaObject;
+
+export declare type SecuritySchemeAndScope = (OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject) & {
+    scopes?: string[];
+    'x-default'?: string;
+};
+
 export declare function serializeMdx(mdxString: string): Promise<SerializeMdxResult>;
 
 export declare interface SerializeMdxResult {
@@ -598,8 +952,51 @@ export declare function useApiReference(): ApiReferenceContextValue | undefined;
 
 export declare function useComponents(): ComponentsContextValue;
 
+export declare const useCopyPathWithInputs: ({ path, baseUrl }: {
+    path: string;
+    baseUrl: string;
+}) => string;
+
+/**
+ * CLANKED
+ * Syncs playground state with URL pathname changes.
+ *
+ * This hook implements the following behavior:
+ * - When the pathname changes, it resets the playground inputs
+ * - After reset, it initializes with the new default values for the current endpoint
+ * - When playground closes without pathname change, state is preserved
+ * - Query parameter changes (like ?playground=open) do NOT reset the state
+ *
+ * Uses refs to track previous pathname to avoid unnecessary resets.
+ */
+export declare function useInitializeInputs({ apiReferenceData, selectedBaseUrlIndex, selectedExampleIndex, selectedRequestBodyContentTypeIndex, }: UsePlaygroundStateSyncProps): void;
+
 export declare function useMarkdownCopy(pathname: string): void;
 
+export declare const usePlaygroundInputsStore: UseBoundStore<StoreApi<PlaygroundInputsState>>;
+
+declare interface UsePlaygroundStateSyncProps {
+    apiReferenceData: ApiReferenceDataV2;
+    selectedBaseUrlIndex: number;
+    selectedExampleIndex: number;
+    selectedRequestBodyContentTypeIndex: number;
+}
+
+export declare const useSelectedSecurityOption: () => {
+    selectedSecurityOptionIndex: number;
+    setSelectedSecurityOptionIndex: (index: number) => void;
+};
+
+export declare const useSendPlaygroundRequest: ({ apiReferenceData, baseUrl, contentType, setResult, setIsSending, }: UseSendPlaygroundRequestProps) => () => Promise<void>;
+
+declare type UseSendPlaygroundRequestProps = {
+    apiReferenceData: ApiReferenceDataV2;
+    baseUrl: string | undefined;
+    contentType: string | undefined;
+    setResult: (result: ApiPlaygroundResultType) => void;
+    setIsSending: (isSending: boolean) => void;
+};
+
 export declare function ZonePivot({ pivot, target, children }: ZonePivotProps): JSX_2.Element | null;
 
 export declare interface ZonePivotGroup {