@mui/internal-docs-infra 0.10.1-canary.4 → 0.10.1-canary.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CodeHighlighter/CodeHighlighterClient.d.mts +1 -1
- package/CodeHighlighter/CodeHighlighterContext.d.mts +2 -2
- package/CodeHighlighter/CodeHighlighterFallbackContext.d.mts +1 -1
- package/CodeHighlighter/codeToFallbackProps.d.mts +1 -1
- package/abstractCreateDemo/abstractCreateDemo.d.mts +1 -1
- package/createDemoData/createDemoData.d.mts +2 -2
- package/package.json +2 -2
- package/pipeline/loadCodeVariant/diffHast.d.mts +1 -1
- package/pipeline/loadCodeVariant/hasAllCodeVariants.d.mts +1 -1
- package/pipeline/loadCodeVariant/maybeCodeInitialData.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/createOptimizedProgram.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/formatClass.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/formatComponent.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/formatFunction.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/formatHook.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/formatRaw.d.mts +1 -1
- package/pipeline/loadServerTypesMeta/loadServerTypesMeta.d.mts +5 -5
- package/pipeline/loadServerTypesMeta/processTypes.d.mts +1 -1
- package/pipeline/syncPageIndex/metadataToMarkdown.d.mts +1 -1
- package/pipeline/transformMarkdownMetadata/types.d.mts +1 -1
- package/useCode/useCode.d.mts +1 -1
- package/useCode/useCopyFunctionality.d.mts +1 -1
- package/useCode/useTransformManagement.d.mts +1 -1
- package/useSearch/types.d.mts +2 -2
- package/useType/useType.d.mts +1 -1
- package/useType/useTypeProp.d.mts +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { CodeHighlighterClientProps } from "./types.mjs";
|
|
1
|
+
import { type CodeHighlighterClientProps } from "./types.mjs";
|
|
2
2
|
export declare function CodeHighlighterClient(props: CodeHighlighterClientProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { Code, ControlledCode } from "./types.mjs";
|
|
3
|
-
import { Selection } from "../CodeControllerContext/index.mjs";
|
|
2
|
+
import { type Code, type ControlledCode } from "./types.mjs";
|
|
3
|
+
import { type Selection } from "../CodeControllerContext/index.mjs";
|
|
4
4
|
export interface CodeHighlighterContextType {
|
|
5
5
|
code?: Code;
|
|
6
6
|
setCode?: React.Dispatch<React.SetStateAction<ControlledCode | undefined>>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { ContentLoadingVariant } from "./types.mjs";
|
|
2
|
+
import { type ContentLoadingVariant } from "./types.mjs";
|
|
3
3
|
export interface CodeHighlighterFallbackContext extends ContentLoadingVariant {
|
|
4
4
|
extraVariants?: Record<string, ContentLoadingVariant>;
|
|
5
5
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { BaseContentLoadingProps, Code } from "./types.mjs";
|
|
1
|
+
import { type BaseContentLoadingProps, type Code } from "./types.mjs";
|
|
2
2
|
export declare function codeToFallbackProps(variant: string, code?: Code, fileName?: string, needsAllFiles?: boolean, needsAllVariants?: boolean): BaseContentLoadingProps;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import type { Code, CodeHighlighterProps, ContentLoadingProps, ContentProps, LoadCodeMeta, LoadSource, LoadVariantMeta, ParseSource, SourceEnhancers } from "../CodeHighlighter/types.mjs";
|
|
3
|
-
import { DemoGlobalData } from "../createDemoData/types.mjs";
|
|
3
|
+
import { type DemoGlobalData } from "../createDemoData/types.mjs";
|
|
4
4
|
type CreateDemoMeta = {
|
|
5
5
|
name?: string;
|
|
6
6
|
slug?: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { CreateDemoDataMeta, DemoData, DemoGlobalData, DemoGlobalProvider } from "./types.mjs";
|
|
1
|
+
import type * as React from 'react';
|
|
2
|
+
import { type CreateDemoDataMeta, type DemoData, type DemoGlobalData, type DemoGlobalProvider } from "./types.mjs";
|
|
3
3
|
/**
|
|
4
4
|
* Creates demo data for displaying code examples with syntax highlighting.
|
|
5
5
|
* A variant is a different implementation style of the same component.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mui/internal-docs-infra",
|
|
3
|
-
"version": "0.10.1-canary.
|
|
3
|
+
"version": "0.10.1-canary.6",
|
|
4
4
|
"author": "MUI Team",
|
|
5
5
|
"description": "MUI Infra - internal documentation creation tools.",
|
|
6
6
|
"license": "MIT",
|
|
@@ -643,5 +643,5 @@
|
|
|
643
643
|
"bin": {
|
|
644
644
|
"docs-infra": "./cli/index.mjs"
|
|
645
645
|
},
|
|
646
|
-
"gitSha": "
|
|
646
|
+
"gitSha": "1e04001f0f8f7dda807b8ebf1219dd99f0862f5b"
|
|
647
647
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import type { Nodes } from 'hast';
|
|
2
|
-
import { ParseSource, Transforms } from "../../CodeHighlighter/types.mjs";
|
|
2
|
+
import { type ParseSource, type Transforms } from "../../CodeHighlighter/types.mjs";
|
|
3
3
|
export declare function diffHast(source: string, parsedSource: Nodes, filename: string, transforms: Transforms, parseSource: ParseSource): Promise<Record<string, any>>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Code, VariantExtraFiles, VariantSource } from "../../CodeHighlighter/types.mjs";
|
|
1
|
+
import { type Code, type VariantExtraFiles, type VariantSource } from "../../CodeHighlighter/types.mjs";
|
|
2
2
|
/**
|
|
3
3
|
* Type guard function that determines if we have sufficient data to render a code highlighter
|
|
4
4
|
* component immediately, or if we need to start loading data first.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as tae from 'typescript-api-extractor';
|
|
1
|
+
import type * as tae from 'typescript-api-extractor';
|
|
2
2
|
import { type FormattedParameter, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
3
3
|
import { type TypeRewriteContext } from "./rewriteTypes.mjs";
|
|
4
4
|
import type { ExternalTypesCollector } from "./externalTypes.mjs";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as tae from 'typescript-api-extractor';
|
|
1
|
+
import type * as tae from 'typescript-api-extractor';
|
|
2
2
|
import { type FormattedProperty, type FormattedEnumMember, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
3
3
|
import { type TypeRewriteContext } from "./rewriteTypes.mjs";
|
|
4
4
|
import type { ExternalTypesCollector } from "./externalTypes.mjs";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as tae from 'typescript-api-extractor';
|
|
1
|
+
import type * as tae from 'typescript-api-extractor';
|
|
2
2
|
import { type FormattedParameter, type FormattedProperty, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
3
3
|
import { type TypeRewriteContext } from "./rewriteTypes.mjs";
|
|
4
4
|
import type { ExternalTypesCollector } from "./externalTypes.mjs";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as tae from 'typescript-api-extractor';
|
|
1
|
+
import type * as tae from 'typescript-api-extractor';
|
|
2
2
|
import { type FormattedProperty, type FormattedParameter, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
3
3
|
import { type TypeRewriteContext } from "./rewriteTypes.mjs";
|
|
4
4
|
import type { ExternalTypesCollector } from "./externalTypes.mjs";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as tae from 'typescript-api-extractor';
|
|
1
|
+
import type * as tae from 'typescript-api-extractor';
|
|
2
2
|
import { type FormattedProperty, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
3
3
|
import { type TypeRewriteContext } from "./rewriteTypes.mjs";
|
|
4
4
|
import type { ExternalTypesCollector } from "./externalTypes.mjs";
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { ClassTypeMeta as ClassType } from "./formatClass.mjs";
|
|
2
|
-
import { ComponentTypeMeta as ComponentType } from "./formatComponent.mjs";
|
|
3
|
-
import { HookTypeMeta as HookType } from "./formatHook.mjs";
|
|
4
|
-
import { FunctionTypeMeta as FunctionType } from "./formatFunction.mjs";
|
|
5
|
-
import { RawTypeMeta as RawType, type ReExportInfo } from "./formatRaw.mjs";
|
|
1
|
+
import { type ClassTypeMeta as ClassType } from "./formatClass.mjs";
|
|
2
|
+
import { type ComponentTypeMeta as ComponentType } from "./formatComponent.mjs";
|
|
3
|
+
import { type HookTypeMeta as HookType } from "./formatHook.mjs";
|
|
4
|
+
import { type FunctionTypeMeta as FunctionType } from "./formatFunction.mjs";
|
|
5
|
+
import { type RawTypeMeta as RawType, type ReExportInfo } from "./formatRaw.mjs";
|
|
6
6
|
import { type FormattedProperty, type FormattedEnumMember, type FormattedParameter, type FormatInlineTypeOptions, type DescriptionReplacement } from "./format.mjs";
|
|
7
7
|
import type { OrderingConfig } from "../loadServerTypesText/order.mjs";
|
|
8
8
|
import { type OrganizeTypesResult } from "../loadServerTypesText/organizeTypesByExport.mjs";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { CompilerOptions } from 'typescript';
|
|
2
|
-
import { ExportNode } from 'typescript-api-extractor';
|
|
2
|
+
import { type ExportNode } from 'typescript-api-extractor';
|
|
3
3
|
import { type PerformanceLog } from "./performanceTracking.mjs";
|
|
4
4
|
export interface VariantResult {
|
|
5
5
|
exports: ExportNode[];
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Root } from 'mdast';
|
|
2
2
|
import type { ExtractedMetadata } from "../transformMarkdownMetadata/types.mjs";
|
|
3
|
-
import { Audience } from "../../createSitemap/types.mjs";
|
|
3
|
+
import { type Audience } from "../../createSitemap/types.mjs";
|
|
4
4
|
export interface PageMetadata extends ExtractedMetadata {
|
|
5
5
|
/** The slug/path for this page (e.g., 'button', 'checkbox') */
|
|
6
6
|
slug: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { PhrasingContent } from 'mdast';
|
|
2
|
-
import { Audience } from "../../createSitemap/types.mjs";
|
|
2
|
+
import { type Audience } from "../../createSitemap/types.mjs";
|
|
3
3
|
/**
|
|
4
4
|
* Base options for syncing page indexes.
|
|
5
5
|
* Shared between extractToIndex (markdown metadata) and updateParentIndex (types).
|
package/useCode/useCode.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import type { ContentProps, SourceEnhancers } from "../CodeHighlighter/types.mjs";
|
|
3
|
-
import { UseCopierOpts } from "../useCopier/index.mjs";
|
|
3
|
+
import { type UseCopierOpts } from "../useCopier/index.mjs";
|
|
4
4
|
export type UseCodeOpts = {
|
|
5
5
|
preClassName?: string;
|
|
6
6
|
preRef?: React.Ref<HTMLPreElement>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { UseCopierOpts } from "../useCopier/index.mjs";
|
|
2
|
+
import { type UseCopierOpts } from "../useCopier/index.mjs";
|
|
3
3
|
import type { VariantSource } from "../CodeHighlighter/types.mjs";
|
|
4
4
|
interface UseCopyFunctionalityProps {
|
|
5
5
|
selectedFile: VariantSource | null;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Code, VariantCode } from "../CodeHighlighter/types.mjs";
|
|
2
2
|
import { createTransformedFiles } from "./useCodeUtils.mjs";
|
|
3
|
-
import { CodeHighlighterContextType } from "../CodeHighlighter/CodeHighlighterContext.mjs";
|
|
3
|
+
import { type CodeHighlighterContextType } from "../CodeHighlighter/CodeHighlighterContext.mjs";
|
|
4
4
|
interface UseTransformManagementProps {
|
|
5
5
|
context?: CodeHighlighterContextType;
|
|
6
6
|
effectiveCode: Code;
|
package/useSearch/types.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ElapsedTime, Orama, SearchParams } from '@orama/orama';
|
|
1
|
+
import { type ElapsedTime, type Orama, type Result, type SearchParams } from '@orama/orama';
|
|
2
2
|
import type { Sitemap, SitemapPage, SitemapSection, SitemapPart, SitemapExport, SitemapSectionData } from "../createSitemap/types.mjs";
|
|
3
3
|
/**
|
|
4
4
|
* Base search result structure that can be extended by consumers
|
|
@@ -140,7 +140,7 @@ export interface UseSearchOptions {
|
|
|
140
140
|
/** Custom function to flatten sitemap pages into search results */
|
|
141
141
|
flattenPage?: (page: SitemapPage, sectionData: SitemapSectionData) => SearchResult[];
|
|
142
142
|
/** Custom function to format Orama search hits into typed results */
|
|
143
|
-
formatResult?: <TDocument = unknown>(hit:
|
|
143
|
+
formatResult?: <TDocument = unknown>(hit: Result<TDocument>) => SearchResult;
|
|
144
144
|
}
|
|
145
145
|
export type SearchBy<T> = Pick<SearchParams<Orama<T>>, 'facets' | 'groupBy' | 'limit' | 'offset' | 'where'>;
|
|
146
146
|
/**
|
package/useType/useType.d.mts
CHANGED