@aussieljk/forkbook 0.0.0-stage → 0.0.1-1

package/dist/addon-docs/blocks.d.ts

@@ -0,0 +1,1061 @@
+import { a as TableOfContents, i as DocsContextProps, n as DocsContainerProps, r as DocsContext, t as DocsContainer } from "../chunk-Ct9xd6IM.js";
+import { Renderer } from "@aussieljk/forkbook/internal/csf";
+import * as React$1 from "react";
+import React, { ComponentProps, Context, FC, FunctionComponent, PropsWithChildren, ReactElement, ReactNode } from "react";
+import { Args as Args$1, BaseAnnotations, ComponentTitle, Conditional, DocsContextProps as DocsContextProps$1, ModuleExport, ModuleExports, Parameters as Parameters$1, PreparedStory, Renderer as Renderer$1, ResolvedModuleExportFromType, ResolvedModuleExportType, StoryId as StoryId$1 } from "@aussieljk/forkbook/internal/types";
+import { PropDescriptor } from "@aussieljk/forkbook/preview-api";
+import { ActionItem, SupportedLanguage as SupportedLanguage$1, SyntaxHighlighter, SyntaxHighlighterFormatTypes } from "@aussieljk/forkbook/internal/components";
+import { SourceType, anchorBlockIdFromId } from "@aussieljk/forkbook/internal/docs-tools";
+
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/Source.d.ts
+declare enum SourceError {
+  NO_STORY = "There\u2019s no story here.",
+  SOURCE_UNAVAILABLE = "Oh no! The source is not available."
+}
+interface SourceCodeProps {
+  /** The language the syntax highlighter uses for your story’s code */
+  language?: SupportedLanguage$1;
+  /** Use this to override the content of the source block. */
+  code?: string;
+  /** The formatter the syntax highlighter uses for your story’s code. */
+  format?: ComponentProps<typeof SyntaxHighlighter>['format'];
+  /** Display the source snippet in a dark mode. */
+  dark?: boolean;
+  /** Whether to show the copy button. Defaults to true. */
+  copyable?: boolean;
+}
+interface SourceProps$1 extends SourceCodeProps {
+  isLoading?: boolean;
+  error?: SourceError;
+  /** Why the snippet is an incomplete example, when it is one; see `StoryDoc.warning`. */
+  warning?: string;
+  /** Replaces the `docblock-source` class names of the code block. */
+  className?: string;
+}
+/** Syntax-highlighted source code for a component (or anything!) */
+declare const Source$1: FunctionComponent<SourceProps$1>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/Preview.d.ts
+type PreviewProps = PropsWithChildren<{
+  isLoading?: true;
+  layout?: Layout;
+  inline?: boolean;
+  isColumn?: boolean;
+  columns?: number;
+  withSource?: SourceProps$1;
+  isExpanded?: boolean;
+  withToolbar?: boolean;
+  className?: string;
+  additionalActions?: ActionItem[];
+  onReloadStory?: () => void;
+}>;
+type Layout = 'padded' | 'fullscreen' | 'centered';
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/ArgsTable/types.d.ts
+interface ArgType {
+  name?: string;
+  description?: string;
+  if?: Conditional;
+  table?: {
+    category?: string;
+    disable?: boolean;
+    subcategory?: string;
+    defaultValue?: {
+      summary?: string | undefined;
+      detail?: string | undefined;
+    };
+    type?: {
+      summary?: string | undefined;
+      detail?: string | undefined;
+    };
+    readonly?: boolean;
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
+interface ArgTypes$3 {
+  [key: string]: ArgType;
+}
+interface Args$2 {
+  [key: string]: any;
+}
+type Globals$2 = {
+  [name: string]: any;
+};
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/ArgsTable/ArgsTable.d.ts
+declare enum ArgsTableError {
+  NO_COMPONENT = "No component found.",
+  ARGS_UNSUPPORTED = "Args unsupported. See Args documentation for your framework.",
+  NOT_A_STORY_COMPONENT = "No docs found for this component on this page. Import the story file whose meta.component is this component, or pass `of={ComponentStories}`."
+}
+type SortType = 'alpha' | 'requiredFirst' | 'none';
+interface ArgsTableOptionProps {
+  children?: React.ReactNode;
+  updateArgs?: (args: Args$2) => void;
+  resetArgs?: (argNames?: string[]) => void;
+  compact?: boolean;
+  inAddonPanel?: boolean;
+  inTabPanel?: boolean;
+  initialExpandedArgs?: boolean;
+  isLoading?: boolean;
+  sort?: SortType;
+  storyId?: string;
+  controlsId?: string;
+  docsLang?: string;
+}
+interface ArgsTableDataProps {
+  rows: ArgTypes$3;
+  args?: Args$2;
+  globals?: Globals$2;
+}
+interface ArgsTableErrorProps {
+  error: ArgsTableError;
+}
+interface ArgsTableLoadingProps {
+  isLoading: boolean;
+}
+type ArgsTableProps = ArgsTableOptionProps & (ArgsTableDataProps | ArgsTableErrorProps | ArgsTableLoadingProps);
+/**
+ * Display the props for a component as a props table. Each row is a collection of ArgDefs, usually
+ * derived from docgen info for the component.
+ */
+declare const ArgsTable: FC<ArgsTableProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/Story.d.ts
+interface CommonProps {
+  story: PreparedStory;
+  inline: boolean;
+  primary: boolean;
+}
+interface InlineStoryProps extends CommonProps {
+  inline: true;
+  height?: string;
+  autoplay: boolean;
+  forceInitialArgs: boolean;
+  renderStoryToElement: DocsContextProps$1['renderStoryToElement'];
+}
+interface IFrameStoryProps extends CommonProps {
+  inline: false;
+  height: string;
+}
+type StoryProps$1 = InlineStoryProps | IFrameStoryProps;
+/** A story element, either rendered inline or in an iframe, with configurable height. */
+declare const Story$2: FunctionComponent<StoryProps$1>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/Typeset.d.ts
+interface TypesetProps {
+  fontFamily?: string;
+  fontSizes: (string | number)[];
+  fontWeight?: number;
+  sampleText?: string;
+}
+/**
+ * Convenient styleguide documentation showing examples of type with different sizes and weights and
+ * configurable sample text.
+ */
+declare const Typeset: FC<TypesetProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/ColorPalette.d.ts
+type Colors = string[] | {
+  [key: string]: string;
+};
+interface ColorItemProps {
+  title: string;
+  subtitle: string;
+  colors: Colors;
+}
+/**
+ * A single color row your styleguide showing title, subtitle and one or more colors, used as a
+ * child of `ColorPalette`.
+ */
+declare const ColorItem: FunctionComponent<ColorItemProps>;
+interface ColorPaletteProps {
+  children?: React.ReactNode;
+}
+/**
+ * Styleguide documentation for colors, including names, captions, and color swatches, all specified
+ * as `ColorItem` children of this wrapper component.
+ */
+declare const ColorPalette: FunctionComponent<ColorPaletteProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/components/IconGallery.d.ts
+interface IconItemProps {
+  name: string;
+  children?: React.ReactNode;
+}
+/** An individual icon with a caption and an example (passed as `children`). */
+declare const IconItem: FunctionComponent<IconItemProps>;
+interface IconGalleryProps {
+  children?: React.ReactNode;
+}
+/** Show a grid of icons, as specified by `IconItem`. */
+declare const IconGallery: FunctionComponent<IconGalleryProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Anchor.d.ts
+interface AnchorProps {
+  storyId: string;
+}
+declare const Anchor: FC<PropsWithChildren<AnchorProps>>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/ArgTypes.d.ts
+type ArgTypesParameters = {
+  include?: PropDescriptor;
+  exclude?: PropDescriptor;
+  sort?: SortType;
+};
+type ArgTypesProps = ArgTypesParameters & {
+  of?: Renderer['component'] | ModuleExports;
+};
+declare const ArgTypes: React.ComponentType<ArgTypesProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/SourceContainer.d.ts
+type ArgsHash = string;
+declare function argsHash(args: Args$1): ArgsHash;
+interface SourceItem {
+  code: string;
+  format?: SyntaxHighlighterFormatTypes;
+  /** Why `code` is an incomplete example, when it is one; see `StoryDoc.warning`. */
+  warning?: string;
+}
+type StorySources = Record<StoryId$1, Record<ArgsHash, SourceItem>>;
+interface SourceContextProps {
+  sources: StorySources;
+  setSource?: (id: StoryId$1, item: SourceItem) => void;
+}
+declare const SourceContext: Context<SourceContextProps>;
+declare const UNKNOWN_ARGS_HASH = "--unknown--";
+declare const SourceContainer: FC<PropsWithChildren<{
+  channel: DocsContextProps$1['channel'];
+}>>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Source.d.ts
+type SourceParameters = SourceCodeProps & {
+  /** Where to read the source code from, see `SourceType` */type?: SourceType; /** Transform the detected source for display */
+  transform?: (code: string, storyContext: ReturnType<DocsContextProps['getStoryContext']>) => string | Promise<string>; /** Internal: set by our CSF loader (`enrichCsf` in `@aussieljk/forkbook/internal/csf-tools`). */
+  originalSource?: string;
+};
+type SourceProps = SourceParameters & {
+  /**
+   * Pass the export defining a story to render its source
+   *
+   * ```jsx
+   * import { Source } from '@aussieljk/forkbook/addon-docs/blocks';
+   * import * as ButtonStories from './Button.stories';
+   *
+   * <Source of={ButtonStories.Primary} />;
+   * ```
+   */
+  of?: ModuleExport; /** Internal prop to control if a story re-renders on args updates */
+  __forceInitialArgs?: boolean;
+};
+type PureSourceProps = ComponentProps<typeof Source$1>;
+declare const useSourceProps: (props: SourceProps, docsContext: DocsContextProps, sourceContext: SourceContextProps, serviceSnippet?: string, serviceWarning?: string) => PureSourceProps;
+declare const Source: React.ComponentType<SourceProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Story.d.ts
+type PureStoryProps = ComponentProps<typeof Story$2>;
+/** Props to reference another story */
+type StoryRefProps = {
+  /**
+   * Pass the export defining a story to render that story
+   *
+   * ```jsx
+   * import { Meta, Story } from '@aussieljk/forkbook/addon-docs/blocks';
+   * import * as ButtonStories from './Button.stories';
+   *
+   * <Meta of={ButtonStories} />
+   * <Story of={ButtonStories.Primary} />
+   * ```
+   */
+  of?: ModuleExport;
+  /**
+   * Pass all exports of the CSF file if this MDX file is unattached
+   *
+   * ```jsx
+   * import { Story } from '@aussieljk/forkbook/addon-docs/blocks';
+   * import * as ButtonStories from './Button.stories';
+   *
+   * <Story of={ButtonStories.Primary} meta={ButtonStories} />;
+   * ```
+   */
+  meta?: ModuleExports;
+};
+type StoryParameters = {
+  /** Render the story inline or in an iframe */inline?: boolean; /** When rendering in an iframe (`inline={false}`), set the story height */
+  height?: string; /** Whether to run the story's play function */
+  autoplay?: boolean; /** Internal prop to control if a story re-renders on args updates */
+  __forceInitialArgs?: boolean; /** Internal prop if this story is the primary story */
+  __primary?: boolean;
+};
+type StoryProps = StoryRefProps & StoryParameters;
+declare const getStoryId: (props: StoryProps, context: DocsContextProps) => StoryId$1;
+declare const getStoryProps: <TFramework extends Renderer$1>(props: StoryParameters, story: PreparedStory<TFramework>, context: DocsContextProps<TFramework>) => PureStoryProps;
+declare const Story: React.ComponentType<StoryProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Canvas.d.ts
+type CanvasProps = Pick<PreviewProps, 'withToolbar' | 'additionalActions' | 'className'> & {
+  /**
+   * Pass the export defining a story to render that story
+   *
+   * ```jsx
+   * import { Meta, Canvas } from '@aussieljk/forkbook/addon-docs/blocks';
+   * import * as ButtonStories from './Button.stories';
+   *
+   * <Meta of={ButtonStories} />
+   * <Canvas of={ButtonStories.Primary} />
+   * ```
+   */
+  of?: ModuleExport;
+  /**
+   * Pass all exports of the CSF file if this MDX file is unattached
+   *
+   * ```jsx
+   * import { Canvas } from '@aussieljk/forkbook/addon-docs/blocks';
+   * import * as ButtonStories from './Button.stories';
+   *
+   * <Canvas of={ButtonStories.Primary} meta={ButtonStories} />;
+   * ```
+   */
+  meta?: ModuleExports;
+  /**
+   * Specify the initial state of the source panel hidden: the source panel is hidden by default
+   * shown: the source panel is shown by default none: the source panel is not available and the
+   * button to show it is hidden
+   *
+   * @default 'hidden'
+   */
+  sourceState?: 'hidden' | 'shown' | 'none';
+  /**
+   * How to layout the story within the canvas padded: the story has padding within the canvas
+   * fullscreen: the story is rendered edge to edge within the canvas centered: the story is
+   * centered within the canvas
+   *
+   * @default 'padded'
+   */
+  layout?: Layout; /** @see {SourceProps} */
+  source?: Omit<SourceProps, 'dark'>; /** @see {StoryProps} */
+  story?: Pick<StoryProps, 'inline' | 'height' | 'autoplay' | '__forceInitialArgs' | '__primary'>;
+};
+declare const Canvas: React.ComponentType<CanvasProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Controls.d.ts
+type ControlsParameters = {
+  include?: PropDescriptor;
+  exclude?: PropDescriptor;
+  sort?: SortType;
+};
+type ControlsProps = ControlsParameters & {
+  of?: Renderer['component'] | ModuleExports;
+};
+declare const Controls: React.ComponentType<ControlsProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/useOf.d.ts
+type Of = Parameters<DocsContextProps$1['resolveOf']>[0];
+/**
+ * A hook to resolve the `of` prop passed to a block. will return the resolved module if the
+ * resolved module is a meta it will include a preparedMeta property similar to a preparedStory if
+ * the resolved module is a component it will include the project annotations
+ */
+declare const useOf: <TType extends ResolvedModuleExportType>(moduleExportOrType: Of, validTypes?: TType[]) => ResolvedModuleExportFromType<TType>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Description.d.ts
+declare enum DescriptionType {
+  INFO = "info",
+  NOTES = "notes",
+  DOCGEN = "docgen",
+  AUTO = "auto"
+}
+interface DescriptionProps {
+  /**
+   * Specify where to get the description from. Can be a component, a CSF file or a story. If not
+   * specified, the description will be extracted from the meta of the attached CSF file.
+   */
+  of?: Of;
+}
+declare const Description: React.ComponentType<DescriptionProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Docs.d.ts
+type DocsProps<TRenderer extends Renderer$1 = Renderer$1> = {
+  docsParameter: Parameters$1;
+  context: DocsContextProps<TRenderer>;
+};
+declare function Docs<TRenderer extends Renderer$1 = Renderer$1>({
+  context,
+  docsParameter
+}: DocsProps<TRenderer>): React.JSX.Element;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/DocsPage.d.ts
+declare const DocsPage: FC;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/types.d.ts
+declare const PRIMARY_STORY = "^";
+type Component = any;
+type DocsStoryProps = {
+  of: ModuleExport;
+  expanded?: boolean;
+  withToolbar?: boolean;
+  __forceInitialArgs?: boolean;
+  __primary?: boolean;
+};
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/DocsStory.d.ts
+declare const DocsStory: React.ComponentType<DocsStoryProps>;
+//#endregion
+//#region ../../node_modules/github-slugger/index.d.ts
+/**
+ * Slugger.
+ */
+declare class BananaSlug {
+  /** @type {Record<string, number>} */
+  occurrences: Record<string, number>;
+  /**
+   * Generate a unique slug.
+  *
+  * Tracks previously generated slugs: repeated calls with the same value
+  * will result in different slugs.
+  * Use the `slug` function to get same slugs.
+   *
+   * @param  {string} value
+   *   String of text to slugify
+   * @param  {boolean} [maintainCase=false]
+   *   Keep the current case, otherwise make all lowercase
+   * @return {string}
+   *   A unique slug string
+   */
+  slug(value: string, maintainCase?: boolean | undefined): string;
+  /**
+   * Reset - Forget all previous slugs
+   *
+   * @return void
+   */
+  reset(): void;
+}
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Heading.d.ts
+interface HeadingProps {
+  disableAnchor?: boolean;
+}
+declare const slugs: BananaSlug;
+declare const Heading: React.ComponentType<PropsWithChildren<HeadingProps>>;
+//#endregion
+//#region ../../node_modules/markdown-to-jsx/dist/index.d.ts
+/**
+ * Analogous to `node.type`. Please note that the values here may change at any time,
+ * so do not hard code against the value directly.
+ */
+declare const RuleType: {
+  readonly blockQuote: "0";
+  readonly breakLine: "1";
+  readonly breakThematic: "2";
+  readonly codeBlock: "3";
+  readonly codeFenced: "4";
+  readonly codeInline: "5";
+  readonly footnote: "6";
+  readonly footnoteReference: "7";
+  readonly gfmTask: "8";
+  readonly heading: "9";
+  readonly headingSetext: "10"; /** only available if not `disableHTMLParsing` */
+  readonly htmlBlock: "11";
+  readonly htmlComment: "12"; /** only available if not `disableHTMLParsing` */
+  readonly htmlSelfClosing: "13";
+  readonly image: "14";
+  readonly link: "15"; /** emits a `link` 'node', does not render directly */
+  readonly linkAngleBraceStyleDetector: "16"; /** emits a `link` 'node', does not render directly */
+  readonly linkBareUrlDetector: "17";
+  /** @deprecated merged into linkAngleBraceStyleDetector
+   *
+   * emits a `link` 'node', does not render directly */
+  readonly linkMailtoDetector: "18";
+  readonly newlineCoalescer: "19";
+  readonly orderedList: "20";
+  readonly paragraph: "21";
+  readonly ref: "22";
+  readonly refImage: "23";
+  readonly refLink: "24";
+  readonly table: "25";
+  readonly tableSeparator: "26";
+  readonly text: "27";
+  readonly textBolded: "28";
+  readonly textEmphasized: "29";
+  readonly textEscaped: "30";
+  readonly textMarked: "31";
+  readonly textStrikethroughed: "32";
+  readonly unorderedList: "33";
+};
+type RuleType = (typeof RuleType)[keyof typeof RuleType];
+declare const Priority: {
+  /**
+   * anything that must scan the tree before everything else
+   */
+  MAX: number;
+  /**
+   * scans for block-level constructs
+   */
+  HIGH: number;
+  /**
+   * inline w/ more priority than other inline
+   */
+  MED: number;
+  /**
+   * inline elements
+   */
+  LOW: number;
+  /**
+   * bare text and stuff that is considered leftovers
+   */
+  MIN: number;
+};
+declare namespace MarkdownToJSX {
+  /**
+   * RequireAtLeastOne<{ ... }> <- only requires at least one key
+   */
+  type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & { [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys];
+  export type CreateElement = typeof React$1.createElement;
+  export type HTMLTags = keyof React$1.JSX.IntrinsicElements;
+  export type State = {
+    /** true if the current content is inside anchor link grammar */inAnchor?: boolean; /** true if parsing in an HTML context */
+    inHTML?: boolean; /** true if parsing in an inline context (subset of rules around formatting and links) */
+    inline?: boolean; /** true if in a table */
+    inTable?: boolean; /** use this for the `key` prop */
+    key?: React$1.Key; /** true if in a list */
+    list?: boolean; /** used for lookbacks */
+    prevCapture?: string; /** true if parsing in inline context w/o links */
+    simple?: boolean;
+  };
+  export interface BlockQuoteNode {
+    alert?: string;
+    children: MarkdownToJSX.ParserResult[];
+    type: typeof RuleType.blockQuote;
+  }
+  export interface BreakLineNode {
+    type: typeof RuleType.breakLine;
+  }
+  export interface BreakThematicNode {
+    type: typeof RuleType.breakThematic;
+  }
+  export interface CodeBlockNode {
+    type: typeof RuleType.codeBlock;
+    attrs?: React$1.JSX.IntrinsicAttributes;
+    lang?: string;
+    text: string;
+  }
+  export interface CodeFencedNode {
+    type: typeof RuleType.codeFenced;
+  }
+  export interface CodeInlineNode {
+    type: typeof RuleType.codeInline;
+    text: string;
+  }
+  export interface FootnoteNode {
+    type: typeof RuleType.footnote;
+  }
+  export interface FootnoteReferenceNode {
+    type: typeof RuleType.footnoteReference;
+    target: string;
+    text: string;
+  }
+  export interface GFMTaskNode {
+    type: typeof RuleType.gfmTask;
+    completed: boolean;
+  }
+  export interface HeadingNode {
+    type: typeof RuleType.heading;
+    children: MarkdownToJSX.ParserResult[];
+    id: string;
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+  }
+  export interface HeadingSetextNode {
+    type: typeof RuleType.headingSetext;
+  }
+  export interface HTMLCommentNode {
+    type: typeof RuleType.htmlComment;
+  }
+  export interface ImageNode {
+    type: typeof RuleType.image;
+    alt?: string;
+    target: string;
+    title?: string;
+  }
+  export interface LinkNode {
+    type: typeof RuleType.link;
+    children: MarkdownToJSX.ParserResult[];
+    target: string;
+    title?: string;
+  }
+  export interface LinkAngleBraceNode {
+    type: typeof RuleType.linkAngleBraceStyleDetector;
+  }
+  export interface LinkBareURLNode {
+    type: typeof RuleType.linkBareUrlDetector;
+  }
+  export interface LinkMailtoNode {
+    type: typeof RuleType.linkMailtoDetector;
+  }
+  export interface OrderedListNode {
+    type: typeof RuleType.orderedList;
+    items: MarkdownToJSX.ParserResult[][];
+    ordered: true;
+    start?: number;
+  }
+  export interface UnorderedListNode {
+    type: typeof RuleType.unorderedList;
+    items: MarkdownToJSX.ParserResult[][];
+    ordered: false;
+  }
+  export interface NewlineNode {
+    type: typeof RuleType.newlineCoalescer;
+  }
+  export interface ParagraphNode {
+    type: typeof RuleType.paragraph;
+    children: MarkdownToJSX.ParserResult[];
+  }
+  export interface ReferenceNode {
+    type: typeof RuleType.ref;
+  }
+  export interface ReferenceImageNode {
+    type: typeof RuleType.refImage;
+    alt?: string;
+    ref: string;
+  }
+  export interface ReferenceLinkNode {
+    type: typeof RuleType.refLink;
+    children: MarkdownToJSX.ParserResult[];
+    fallbackChildren: string;
+    ref: string;
+  }
+  export interface TableNode {
+    type: typeof RuleType.table;
+    /**
+     * alignment for each table column
+     */
+    align: ('left' | 'right' | 'center')[];
+    cells: MarkdownToJSX.ParserResult[][][];
+    header: MarkdownToJSX.ParserResult[][];
+  }
+  export interface TableSeparatorNode {
+    type: typeof RuleType.tableSeparator;
+  }
+  export interface TextNode {
+    type: typeof RuleType.text;
+    text: string;
+  }
+  export interface BoldTextNode {
+    type: typeof RuleType.textBolded;
+    children: MarkdownToJSX.ParserResult[];
+  }
+  export interface ItalicTextNode {
+    type: typeof RuleType.textEmphasized;
+    children: MarkdownToJSX.ParserResult[];
+  }
+  export interface EscapedTextNode {
+    type: typeof RuleType.textEscaped;
+  }
+  export interface MarkedTextNode {
+    type: typeof RuleType.textMarked;
+    children: MarkdownToJSX.ParserResult[];
+  }
+  export interface StrikethroughTextNode {
+    type: typeof RuleType.textStrikethroughed;
+    children: MarkdownToJSX.ParserResult[];
+  }
+  export interface HTMLNode {
+    type: typeof RuleType.htmlBlock;
+    attrs: React$1.JSX.IntrinsicAttributes;
+    children?: ReturnType<MarkdownToJSX.NestedParser> | undefined;
+    noInnerParse: Boolean;
+    tag: MarkdownToJSX.HTMLTags;
+    text?: string | undefined;
+  }
+  export interface HTMLSelfClosingNode {
+    type: typeof RuleType.htmlSelfClosing;
+    attrs: React$1.JSX.IntrinsicAttributes;
+    tag: string;
+  }
+  export type ParserResult = BlockQuoteNode | BreakLineNode | BreakThematicNode | CodeBlockNode | CodeFencedNode | CodeInlineNode | FootnoteNode | FootnoteReferenceNode | GFMTaskNode | HeadingNode | HeadingSetextNode | HTMLCommentNode | ImageNode | LinkNode | LinkAngleBraceNode | LinkBareURLNode | LinkMailtoNode | OrderedListNode | UnorderedListNode | NewlineNode | ParagraphNode | ReferenceNode | ReferenceImageNode | ReferenceLinkNode | TableNode | TableSeparatorNode | TextNode | BoldTextNode | ItalicTextNode | EscapedTextNode | MarkedTextNode | StrikethroughTextNode | HTMLNode | HTMLSelfClosingNode;
+  export type NestedParser = (input: string, state?: MarkdownToJSX.State) => MarkdownToJSX.ParserResult[];
+  export type Parser<ParserOutput> = (capture: RegExpMatchArray, nestedParse: NestedParser, state?: MarkdownToJSX.State) => ParserOutput;
+  export type RuleOutput = (ast: MarkdownToJSX.ParserResult | MarkdownToJSX.ParserResult[], state: MarkdownToJSX.State) => React$1.ReactNode;
+  export type Rule<ParserOutput = MarkdownToJSX.ParserResult> = {
+    _match: (source: string, state: MarkdownToJSX.State, prevCapturedString?: string) => RegExpMatchArray;
+    _order: (typeof Priority)[keyof typeof Priority];
+    _parse: MarkdownToJSX.Parser<Omit<ParserOutput, 'type'>>;
+    /**
+     * Optional fast check that can quickly determine if this rule
+     * should even be attempted. Should check the start of the source string
+     * for quick patterns without expensive regex operations.
+     *
+     * @param source The input source string (already trimmed of leading whitespace)
+     * @param state Current parser state
+     * @returns true if the rule should be attempted, false to skip
+     */
+    _qualify?: string[] | ((source: string, state: MarkdownToJSX.State) => boolean);
+    _render?: (node: ParserOutput,
+    /**
+     * Continue rendering AST nodes if applicable.
+     */
+
+    render: RuleOutput, state?: MarkdownToJSX.State) => React$1.ReactNode;
+  };
+  export type Rules = { [K in ParserResult['type']]: K extends typeof RuleType.table ? Rule<Extract<ParserResult, {
+    type: K | typeof RuleType.paragraph;
+  }>> : Rule<Extract<ParserResult, {
+    type: K;
+  }>> };
+  export type Override = RequireAtLeastOne<{
+    component: React$1.ElementType;
+    props: Object;
+  }> | React$1.ElementType;
+  export type Overrides = { [tag in HTMLTags]?: Override } & {
+    [customComponent: string]: Override;
+  };
+  export type Options = Partial<{
+    /**
+     * Ultimate control over the output of all rendered JSX.
+     */
+    createElement: (tag: Parameters<CreateElement>[0], props: React$1.JSX.IntrinsicAttributes, ...children: React$1.ReactNode[]) => React$1.ReactNode;
+    /**
+     * The library automatically generates an anchor tag for bare URLs included in the markdown
+     * document, but this behavior can be disabled if desired.
+     */
+    disableAutoLink: boolean;
+    /**
+     * Disable the compiler's best-effort transcription of provided raw HTML
+     * into JSX-equivalent. This is the functionality that prevents the need to
+     * use `dangerouslySetInnerHTML` in React.
+     */
+    disableParsingRawHTML: boolean;
+    /**
+     * Forces the compiler to have space between hash sign and the header text which
+     * is explicitly stated in the most of the markdown specs.
+     * https://github.github.com/gfm/#atx-heading
+     * `The opening sequence of # characters must be followed by a space or by the end of line.`
+     */
+    enforceAtxHeadings: boolean;
+    /**
+     * Forces the compiler to always output content with a block-level wrapper
+     * (`<p>` or any block-level syntax your markdown already contains.)
+     */
+    forceBlock: boolean;
+    /**
+     * Forces the compiler to always output content with an inline wrapper (`<span>`)
+     */
+    forceInline: boolean;
+    /**
+     * Forces the compiler to wrap results, even if there is only a single
+     * child or no children.
+     */
+    forceWrapper: boolean;
+    /**
+     * Supply additional HTML entity: unicode replacement mappings.
+     *
+     * Pass only the inner part of the entity as the key,
+     * e.g. `&le;` -> `{ "le": "\u2264" }`
+     *
+     * By default
+     * the following entities are replaced with their unicode equivalents:
+     *
+     * ```
+     * &amp;
+     * &apos;
+     * &gt;
+     * &lt;
+     * &nbsp;
+     * &quot;
+     * ```
+     */
+    namedCodesToUnicode: {
+      [key: string]: string;
+    };
+    /**
+     * Selectively control the output of particular HTML tags as they would be
+     * emitted by the compiler.
+     */
+    overrides: Overrides;
+    /**
+     * Allows for full control over rendering of particular rules.
+     * For example, to implement a LaTeX renderer such as `react-katex`:
+     *
+     * ```
+     * renderRule(next, node, renderChildren, state) {
+     *   if (node.type === RuleType.codeBlock && node.lang === 'latex') {
+     *     return (
+     *       <TeX as="div" key={state.key}>
+     *         {String.raw`${node.text}`}
+     *       </TeX>
+     *     )
+     *   }
+     *
+     *   return next();
+     * }
+     * ```
+     *
+     * Thar be dragons obviously, but you can do a lot with this
+     * (have fun!) To see how things work internally, check the `render`
+     * method in source for a particular rule.
+     */
+    renderRule: (/** Resume normal processing, call this function as a fallback if you are not returning custom JSX. */
+
+    next: () => React$1.ReactNode, /** the current AST node, use `RuleType` against `node.type` for identification */
+
+    node: ParserResult, /** use as `renderChildren(node.children)` for block nodes */
+
+    renderChildren: RuleOutput, /** contains `key` which should be supplied to the topmost JSX element */
+
+    state: State) => React$1.ReactNode;
+    /**
+     * Override the built-in sanitizer function for URLs, etc if desired. The built-in version is available as a library export called `sanitizer`.
+     */
+    sanitizer: (value: string, tag: HTMLTags, attribute: string) => string | null;
+    /**
+     * Override normalization of non-URI-safe characters for use in generating
+     * HTML IDs for anchor linking purposes.
+     */
+    slugify: (input: string, defaultFn: (input: string) => string) => string;
+    /**
+     * Declare the type of the wrapper to be used when there are multiple
+     * children to render. Set to `null` to get an array of children back
+     * without any wrapper, or use `React.Fragment` to get a React element
+     * that won't show up in the DOM.
+     */
+    wrapper: React$1.ElementType | null;
+  }>;
+  export {};
+}
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Markdown.d.ts
+declare const Markdown: React.ComponentType<Omit<React.HTMLAttributes<Element>, "children"> & {
+  children: string;
+  options?: MarkdownToJSX.Options;
+}>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Meta.d.ts
+type MetaProps = BaseAnnotations & {
+  of?: ModuleExports;
+  title?: string;
+};
+/**
+ * This component is used to declare component metadata in docs and gets transformed into a default
+ * export underneath the hood.
+ */
+declare const Meta: FC<MetaProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Primary.d.ts
+declare const Primary: React.ComponentType<{}>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Stories.d.ts
+interface StoriesProps {
+  title?: ReactElement | string;
+  includePrimary?: boolean;
+}
+declare const Stories: React.ComponentType<StoriesProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Subheading.d.ts
+declare const Subheading: React.ComponentType<PropsWithChildren<HeadingProps>>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Subtitle.d.ts
+interface SubtitleProps {
+  children?: ReactNode;
+  /**
+   * Specify where to get the subtitle from. If not specified, the subtitle will be extracted from
+   * the meta of the attached CSF file.
+   */
+  of?: Of;
+}
+declare const Subtitle: React.ComponentType<SubtitleProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Title.d.ts
+interface TitleProps {
+  /**
+   * Specify where to get the title from. Must be a CSF file's default export. If not specified, the
+   * title will be read from children, or extracted from the meta of the attached CSF file.
+   */
+  of?: Of;
+  /** Specify content to display as the title. */
+  children?: ReactNode;
+}
+declare const extractTitle: (title: ComponentTitle) => string;
+declare const Title: React.ComponentType<TitleProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Unstyled.d.ts
+declare const Unstyled: React.ComponentType<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/Wrapper.d.ts
+declare const Wrapper: React.ComponentType<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/blocks/mdx.d.ts
+declare const assertIsFn: (val: any) => any;
+declare const AddContext: FC<PropsWithChildren<DocsContextProps>>;
+interface CodeOrSourceMdxProps {
+  className?: string;
+}
+declare const CodeOrSourceMdx: FC<PropsWithChildren<CodeOrSourceMdxProps>>;
+interface AnchorMdxProps {
+  href: string;
+  target: string;
+}
+declare const AnchorMdx: FC<PropsWithChildren<AnchorMdxProps>>;
+interface HeaderMdxProps {
+  as: string;
+  id: string;
+}
+declare const HeaderMdx: FC<PropsWithChildren<HeaderMdxProps>>;
+declare const HeadersMdx: {};
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/types.d.ts
+interface ControlProps<T> {
+  name: string;
+  storyId?: string;
+  controlsId?: string;
+  value?: T;
+  defaultValue?: T;
+  argType?: ArgType;
+  /** Whether the underlying arg is required; surfaced as `aria-required` on the control's input. */
+  required?: boolean;
+  onChange: (value?: T) => T | void;
+  onFocus?: (evt: any) => void;
+  onBlur?: (evt: any) => void;
+}
+type BooleanValue = boolean;
+interface BooleanConfig {}
+type ColorValue = string;
+type PresetColor = ColorValue | {
+  color: ColorValue;
+  title?: string;
+};
+interface ColorConfig {
+  presetColors?: PresetColor[];
+  /**
+   * Maximum number of preset colors shown in the color picker. When the number of presets exceeds
+   * this value, the oldest presets are removed first (most-recently-used order). Set to `Infinity`
+   * or `0` to disable the limit and show all presets.
+   *
+   * @default 27
+   */
+  maxPresetColors?: number;
+  /**
+   * Whether the color picker should be open by default when rendered.
+   *
+   * @default false
+   */
+  startOpen?: boolean;
+}
+type DateValue = Date | number;
+interface DateConfig {}
+type NumberValue = number;
+interface NumberConfig {
+  min?: number;
+  max?: number;
+  step?: number;
+}
+type RangeConfig = NumberConfig;
+type ObjectValue = any;
+interface ObjectConfig {}
+type OptionsSingleSelection = any;
+type OptionsMultiSelection = any[];
+type OptionsSelection = OptionsSingleSelection | OptionsMultiSelection;
+type OptionsArray = any[];
+type OptionsObject = Record<string, any>;
+type Options = OptionsArray | OptionsObject;
+type OptionsControlType = 'radio' | 'inline-radio' | 'check' | 'inline-check' | 'select' | 'multi-select';
+interface OptionsConfig {
+  labels?: Record<any, string>;
+  type: OptionsControlType;
+}
+interface NormalizedOptionsConfig {
+  options: OptionsObject;
+}
+type TextValue = string;
+interface TextConfig {
+  maxLength?: number;
+}
+type ControlType = 'array' | 'boolean' | 'color' | 'date' | 'number' | 'range' | 'object' | OptionsControlType | 'text';
+type Control = BooleanConfig | ColorConfig | DateConfig | NumberConfig | ObjectConfig | OptionsConfig | RangeConfig | TextConfig;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Color.d.ts
+type ColorControlProps = ControlProps<ColorValue> & ColorConfig;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Boolean.d.ts
+type BooleanProps = ControlProps<BooleanValue> & BooleanConfig;
+/**
+ * # Boolean Control
+ *
+ * Renders a switch toggle with "True" or "False". or if the value is `undefined`, renders a button
+ * to set the boolean.
+ *
+ * ## Example usage
+ *
+ * ```
+ * <BooleanControl name="isTrue" value={value} onChange={handleValueChange} />;
+ * ```
+ */
+declare const BooleanControl: FC<BooleanProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Date.d.ts
+declare const parseDate: (value: string) => Date;
+declare const parseTime: (value: string) => Date;
+declare const formatDate: (value: Date | number) => string;
+declare const formatTime: (value: Date | number) => string;
+type DateProps = ControlProps<DateValue> & DateConfig;
+declare const DateControl: FC<DateProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Number.d.ts
+type NumberProps = ControlProps<NumberValue | null> & NumberConfig;
+declare const parse: (value: string) => number | undefined;
+declare const format: (value: NumberValue) => string;
+declare const NumberControl: FC<NumberProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/options/Options.d.ts
+/**
+ * Options can accept `options` in two formats:
+ *
+ * - Array: ['a', 'b', 'c'] OR
+ * - Object: { a: 1, b: 2, c: 3 } (deprecated)
+ *
+ * We always normalize to the more generalized object format and ONLY handle the object format in
+ * the underlying control implementations.
+ *
+ * While non-primitive values are deprecated, they might still not be valid object keys, so the
+ * resulting object is a Label -> Value mapping.
+ */
+declare const normalizeOptions: (options: Options, labels?: Record<any, string>) => any;
+type OptionsProps = ControlProps<OptionsSelection> & OptionsConfig;
+declare const OptionsControl: FC<OptionsProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Object.d.ts
+type ObjectProps = ControlProps<ObjectValue> & ObjectConfig;
+declare const ObjectControl: FC<ObjectProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Range.d.ts
+type RangeProps = ControlProps<NumberValue | null> & RangeConfig;
+declare const RangeControl: FC<RangeProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Text.d.ts
+type TextProps = ControlProps<TextValue | undefined> & TextConfig;
+declare const TextControl: FC<TextProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/Files.d.ts
+interface FilesControlProps extends ControlProps<string[]> {
+  /**
+   * The accept attribute value is a string that defines the file types the file input should
+   * accept. This string is a comma-separated list of unique file type specifiers.
+   *
+   * @example _/_
+   *
+   * @example .webm,video/webm
+   *
+   * @example .doc,.docx,application/msword
+   *
+   * @defaultValue `image/*`
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept
+   */
+  accept?: string;
+}
+declare const FilesControl: FC<FilesControlProps>;
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/blocks/controls/index.d.ts
+type ColorProps = ColorControlProps;
+declare const LazyColorControl: React.LazyExoticComponent<React.FC<ColorControlProps>>;
+declare const ColorControl: (props: ComponentProps<typeof LazyColorControl>) => React.JSX.Element;
+//#endregion
+export { AddContext, Anchor, AnchorMdx, AnchorProps, ArgTypes, BooleanConfig, BooleanControl, BooleanProps, BooleanValue, Canvas, CodeOrSourceMdx, ColorConfig, ColorControl, ColorItem, ColorPalette, ColorProps, ColorValue, Component, Control, ControlProps, ControlType, Controls, DateConfig, DateControl, DateProps, DateValue, Description, DescriptionType, Docs, DocsContainer, DocsContainerProps, DocsContext, type DocsContextProps, DocsPage, DocsProps, DocsStory, DocsStoryProps, FilesControl, FilesControlProps, HeaderMdx, HeadersMdx, Heading, HeadingProps, IconGallery, IconItem, Markdown, Meta, NormalizedOptionsConfig, NumberConfig, NumberControl, NumberValue, ObjectConfig, ObjectControl, ObjectProps, ObjectValue, Of, Options, OptionsArray, OptionsConfig, OptionsControl, OptionsControlType, OptionsMultiSelection, OptionsObject, OptionsProps, OptionsSelection, OptionsSingleSelection, PRIMARY_STORY, PresetColor, Primary, ArgsTable as PureArgsTable, RangeConfig, RangeControl, type SortType, Source, SourceContainer, SourceContext, SourceContextProps, SourceItem, SourceParameters, SourceProps, Stories, Story, StoryProps, StorySources, Subheading, Subtitle, TableOfContents, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, UNKNOWN_ARGS_HASH, Unstyled, Wrapper, anchorBlockIdFromId, argsHash, assertIsFn, extractTitle, format, formatDate, formatTime, getStoryId, getStoryProps, normalizeOptions, parse, parseDate, parseTime, slugs, useOf, useSourceProps };