@ngrok/mantle 0.66.0 → 0.66.2

package/dist/code-block.d.ts

@@ -1,9 +1,10 @@
-import * as react from 'react';
-import { HTMLAttributes, ComponentProps, ReactNode } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { W as WithAsChild } from './as-child-DJ7x3JFV.js';
-import { S as SvgAttributes } from './types-BuKAGhC-.js';
+import { t as SvgAttributes } from "./types-Dh4BVhXC.js";
+import { t as WithAsChild } from "./as-child-XMVTepJu.js";
+import * as react from "react";
+import { ComponentProps, HTMLAttributes, ReactNode } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 
+//#region src/components/code-block/supported-languages.d.ts
 /**
  * List of supported languages for syntax highlighting.
  * @private
@@ -26,38 +27,44 @@ declare const isSupportedLanguage: (value: unknown) => value is SupportedLanguag
  * Formats a language name into a class name that Prism.js can understand.
  * @default "language-sh"
  */
-declare function formatLanguageClassName(language?: SupportedLanguage | undefined): "language-html" | "language-ruby" | "language-py" | "language-text" | "language-plaintext" | "language-go" | "language-bash" | "language-cs" | "language-csharp" | "language-css" | "language-dotnet" | "language-java" | "language-javascript" | "language-js" | "language-json" | "language-jsx" | "language-markup" | "language-plain" | "language-python" | "language-rb" | "language-rust" | "language-sh" | "language-shell" | "language-ts" | "language-tsx" | "language-txt" | "language-typescript" | "language-xml" | "language-yaml" | "language-yml";
-
+declare function formatLanguageClassName(language?: SupportedLanguage | undefined): "language-html" | "language-ruby" | "language-text" | "language-py" | "language-go" | "language-bash" | "language-cs" | "language-csharp" | "language-css" | "language-dotnet" | "language-java" | "language-javascript" | "language-js" | "language-json" | "language-jsx" | "language-markup" | "language-plain" | "language-plaintext" | "language-python" | "language-rb" | "language-rust" | "language-sh" | "language-shell" | "language-ts" | "language-tsx" | "language-txt" | "language-typescript" | "language-xml" | "language-yaml" | "language-yml";
+//#endregion
+//#region src/components/code-block/indentation.d.ts
 declare const indentations: readonly ["tabs", "spaces"];
 type Indentation = (typeof indentations)[number];
-
+/**
+ * Type Predicate: checks if the given value is a valid indentation type.
+ */
+//#endregion
+//#region src/components/code-block/line-numbers.d.ts
 /**
  * A line range is a string in the format of `start-end` where `start` and `end` are line numbers.
  */
 type LineRange = `${number}-${number}`;
-
+//#endregion
+//#region src/components/code-block/parse-metastring.d.ts
 declare const modes: readonly ["cli", "file", "traffic-policy"];
 type Mode = (typeof modes)[number];
 type MetaInput = {
-    collapsible?: boolean | undefined;
-    disableCopy?: boolean | undefined;
-    indentation?: Indentation | undefined;
-    mode?: Mode | undefined;
-    title?: string | undefined;
+  collapsible?: boolean | undefined;
+  disableCopy?: boolean | undefined;
+  indentation?: Indentation | undefined;
+  mode?: Mode | undefined;
+  title?: string | undefined;
 };
 type Meta = {
-    collapsible: boolean;
-    disableCopy: boolean;
-    indentation?: Indentation | undefined;
-    mode?: Mode | undefined;
-    title?: string | undefined;
+  collapsible: boolean;
+  disableCopy: boolean;
+  indentation?: Indentation | undefined;
+  mode?: Mode | undefined;
+  title?: string | undefined;
 };
 declare const defaultMeta: {
-    readonly collapsible: false;
-    readonly disableCopy: false;
-    readonly indentation: undefined;
-    readonly mode: undefined;
-    readonly title: undefined;
+  readonly collapsible: false;
+  readonly disableCopy: false;
+  readonly indentation: undefined;
+  readonly mode: undefined;
+  readonly title: undefined;
 };
 type DefaultMeta = typeof defaultMeta;
 /**
@@ -67,64 +74,65 @@ type DefaultMeta = typeof defaultMeta;
  * CodeBlock components as props.
  */
 declare function parseMetastring(input: string | undefined): Meta;
-
+//#endregion
+//#region src/components/code-block/code-block.d.ts
 type CodeBlockCodeProps = Omit<ComponentProps<"pre">, "children"> & {
-    /**
-     * The code to display in the code block. Should be code formatted as a string. This code will be passed to our syntax highlighter.
-     */
-    value: string;
-    /**
-     * @todo not implemented yet
-     */
-    highlightLines?: (LineRange | number)[];
-    /**
-     * The type of indentation to use. Can be either "tabs" or "spaces".
-     * @default inferred from the given language, fallback to `spaces`
-     */
-    indentation?: Indentation;
-    /**
-     * The language of the code block. This will be used to determine how to syntax highlight the code.
-     * @default `"text"`.
-     */
-    language?: SupportedLanguage;
-    /**
-     * @todo not implemented yet
-     */
-    showLineNumbers?: boolean;
+  /**
+   * The code to display in the code block. Should be code formatted as a string. This code will be passed to our syntax highlighter.
+   */
+  value: string;
+  /**
+   * @todo not implemented yet
+   */
+  highlightLines?: (LineRange | number)[];
+  /**
+   * The type of indentation to use. Can be either "tabs" or "spaces".
+   * @default inferred from the given language, fallback to `spaces`
+   */
+  indentation?: Indentation;
+  /**
+   * The language of the code block. This will be used to determine how to syntax highlight the code.
+   * @default `"text"`.
+   */
+  language?: SupportedLanguage;
+  /**
+   * @todo not implemented yet
+   */
+  showLineNumbers?: boolean;
 };
 type CodeBlockCopyButtonProps = Omit<ComponentProps<"button">, "children" | "type"> & WithAsChild & {
-    /**
-     * Callback fired when the copy button is clicked, passes the copied text as an argument.
-     */
-    onCopy?: (value: string) => void;
-    /**
-     * Callback fired when an error occurs during copying.
-     */
-    onCopyError?: (error: unknown) => void;
+  /**
+   * Callback fired when the copy button is clicked, passes the copied text as an argument.
+   */
+  onCopy?: (value: string) => void;
+  /**
+   * Callback fired when an error occurs during copying.
+   */
+  onCopyError?: (error: unknown) => void;
 };
 type CodeBlockExpanderButtonProps = Omit<ComponentProps<"button">, "children" | "aria-controls" | "aria-expanded"> & WithAsChild;
 type CodeBlockIconProps = Omit<SvgAttributes, "children"> & ({
-    /**
-     * A custom icon to display in the code block header.
-     * (Pass only one of `svg` or `preset`.)
-     */
-    svg: ReactNode;
-    /**
-     * A preset icon to display in the code block header.
-     * (Pass only one of `svg` or `preset`.)
-     */
-    preset?: undefined | never;
+  /**
+   * A custom icon to display in the code block header.
+   * (Pass only one of `svg` or `preset`.)
+   */
+  svg: ReactNode;
+  /**
+   * A preset icon to display in the code block header.
+   * (Pass only one of `svg` or `preset`.)
+   */
+  preset?: undefined | never;
 } | {
-    /**
-     * A custom icon to display in the code block header.
-     * (Pass only one of `svg` or `preset`.)
-     */
-    svg?: undefined | never;
-    /**
-     * A preset icon to display in the code block header.
-     * (Pass only one of `svg` or `preset`.)
-     */
-    preset: Mode;
+  /**
+   * A custom icon to display in the code block header.
+   * (Pass only one of `svg` or `preset`.)
+   */
+  svg?: undefined | never;
+  /**
+   * A preset icon to display in the code block header.
+   * (Pass only one of `svg` or `preset`.)
+   */
+  preset: Mode;
 });
 /**
  * A small icon that represents the type of code block being displayed,
@@ -150,9 +158,14 @@ type CodeBlockIconProps = Omit<SvgAttributes, "children"> & ({
  * </CodeBlock.Root>
  * ```
  */
-declare function CodeBlockIconComponent({ className, preset, svg: _svgProp, ...props }: CodeBlockIconProps): react_jsx_runtime.JSX.Element;
+declare function CodeBlockIconComponent({
+  className,
+  preset,
+  svg: _svgProp,
+  ...props
+}: CodeBlockIconProps): react_jsx_runtime0.JSX.Element;
 declare namespace CodeBlockIconComponent {
-    var displayName: string;
+  var displayName: string;
 }
 /**
  * Code blocks render and apply syntax highlighting to blocks of code.
@@ -175,159 +188,160 @@ declare namespace CodeBlockIconComponent {
  * ```
  */
 declare const CodeBlock: {
-    /**
-     * Code blocks render and apply syntax highlighting to blocks of code.
-     * This is the root component for all code block components.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockroot
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Header>
-     *     <CodeBlock.Icon preset="file" />
-     *     <CodeBlock.Title>…</CodeBlock.Title>
-     *   </CodeBlock.Header>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.CopyButton />
-     *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
-     *   </CodeBlock.Body>
-     *   <CodeBlock.ExpanderButton />
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Root: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "align"> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
-    /**
-     * The body of the `CodeBlock`. This is where the `CodeBlock.Code` and optional
-     * `CodeBlock.CopyButton` is rendered.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockbody
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.CopyButton />
-     *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
-     *   </CodeBlock.Body>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Body: react.ForwardRefExoticComponent<Omit<react.ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
-    /**
-     * The `CodeBlock` content. This is where the code is rendered and syntax highlighted.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockcode
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.Code
-     *       language="sh"
-     *       value={fmtCode`ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0`}
-     *     />
-     *   </CodeBlock.Body>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Code: react.ForwardRefExoticComponent<Omit<CodeBlockCodeProps, "ref"> & react.RefAttributes<HTMLPreElement>>;
-    /**
-     * The (optional) copy button of the `CodeBlock`. Render this as a child of the
-     * `CodeBlock.Body` to allow users to copy the code block contents to their
-     * clipboard.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockcopybutton
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.CopyButton />
-     *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
-     *   </CodeBlock.Body>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly CopyButton: react.ForwardRefExoticComponent<Omit<CodeBlockCopyButtonProps, "ref"> & react.RefAttributes<HTMLButtonElement>>;
-    /**
-     * The (optional) expander button of the `CodeBlock`. Render this as a child of the
-     * `CodeBlock.Body` to allow users to expand/collapse the code block contents.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockexpanderbutton
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
-     *   </CodeBlock.Body>
-     *   <CodeBlock.ExpanderButton />
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly ExpanderButton: react.ForwardRefExoticComponent<Omit<CodeBlockExpanderButtonProps, "ref"> & react.RefAttributes<HTMLButtonElement>>;
-    /**
-     * The (optional) header slot of the `CodeBlock`. This is where things like the
-     * `CodeBlock.Icon` and `CodeBlock.Title` are rendered.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockheader
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Header>
-     *     <CodeBlock.Icon preset="file" />
-     *     <CodeBlock.Title>…</CodeBlock.Title>
-     *   </CodeBlock.Header>
-     *   <CodeBlock.Body>
-     *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
-     *   </CodeBlock.Body>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Header: react.ForwardRefExoticComponent<Omit<react.ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
-    /**
-     * A small icon that represents the type of code block being displayed,
-     * rendered as an SVG next to the code block title in the code block header.
-     *
-     * You can pass in a custom SVG component or use one of the presets
-     * (pass only one of `svg` or `preset`).
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblockicon
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Header>
-     *     <CodeBlock.Icon preset="file" />
-     *     <CodeBlock.Title>…</CodeBlock.Title>
-     *   </CodeBlock.Header>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Icon: typeof CodeBlockIconComponent;
-    /**
-     * The (optional) title of the `CodeBlock`. Default renders as an h3 element,
-     * use asChild to render something else.
-     *
-     * @see https://mantle.ngrok.com/components/code-block#codeblocktitle
-     *
-     * @example
-     * ```tsx
-     * <CodeBlock.Root>
-     *   <CodeBlock.Header>
-     *     <CodeBlock.Icon preset="file" />
-     *     <CodeBlock.Title>example.js</CodeBlock.Title>
-     *   </CodeBlock.Header>
-     * </CodeBlock.Root>
-     * ```
-     */
-    readonly Title: react.ForwardRefExoticComponent<HTMLAttributes<HTMLHeadingElement> & {
-        asChild?: boolean;
-    } & react.RefAttributes<HTMLHeadingElement>>;
+  /**
+   * Code blocks render and apply syntax highlighting to blocks of code.
+   * This is the root component for all code block components.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockroot
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Header>
+   *     <CodeBlock.Icon preset="file" />
+   *     <CodeBlock.Title>…</CodeBlock.Title>
+   *   </CodeBlock.Header>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.CopyButton />
+   *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
+   *   </CodeBlock.Body>
+   *   <CodeBlock.ExpanderButton />
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Root: react.ForwardRefExoticComponent<Omit<Omit<react.DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "align"> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
+  /**
+   * The body of the `CodeBlock`. This is where the `CodeBlock.Code` and optional
+   * `CodeBlock.CopyButton` is rendered.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockbody
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.CopyButton />
+   *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
+   *   </CodeBlock.Body>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Body: react.ForwardRefExoticComponent<Omit<react.ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
+  /**
+   * The `CodeBlock` content. This is where the code is rendered and syntax highlighted.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockcode
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.Code
+   *       language="sh"
+   *       value={fmtCode`ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0`}
+   *     />
+   *   </CodeBlock.Body>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Code: react.ForwardRefExoticComponent<Omit<CodeBlockCodeProps, "ref"> & react.RefAttributes<HTMLPreElement>>;
+  /**
+   * The (optional) copy button of the `CodeBlock`. Render this as a child of the
+   * `CodeBlock.Body` to allow users to copy the code block contents to their
+   * clipboard.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockcopybutton
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.CopyButton />
+   *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
+   *   </CodeBlock.Body>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly CopyButton: react.ForwardRefExoticComponent<Omit<CodeBlockCopyButtonProps, "ref"> & react.RefAttributes<HTMLButtonElement>>;
+  /**
+   * The (optional) expander button of the `CodeBlock`. Render this as a child of the
+   * `CodeBlock.Body` to allow users to expand/collapse the code block contents.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockexpanderbutton
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
+   *   </CodeBlock.Body>
+   *   <CodeBlock.ExpanderButton />
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly ExpanderButton: react.ForwardRefExoticComponent<Omit<CodeBlockExpanderButtonProps, "ref"> & react.RefAttributes<HTMLButtonElement>>;
+  /**
+   * The (optional) header slot of the `CodeBlock`. This is where things like the
+   * `CodeBlock.Icon` and `CodeBlock.Title` are rendered.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockheader
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Header>
+   *     <CodeBlock.Icon preset="file" />
+   *     <CodeBlock.Title>…</CodeBlock.Title>
+   *   </CodeBlock.Header>
+   *   <CodeBlock.Body>
+   *     <CodeBlock.Code language="…" value={fmtCode\`…\`} />
+   *   </CodeBlock.Body>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Header: react.ForwardRefExoticComponent<Omit<react.ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & WithAsChild, "ref"> & react.RefAttributes<HTMLDivElement>>;
+  /**
+   * A small icon that represents the type of code block being displayed,
+   * rendered as an SVG next to the code block title in the code block header.
+   *
+   * You can pass in a custom SVG component or use one of the presets
+   * (pass only one of `svg` or `preset`).
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblockicon
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Header>
+   *     <CodeBlock.Icon preset="file" />
+   *     <CodeBlock.Title>…</CodeBlock.Title>
+   *   </CodeBlock.Header>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Icon: typeof CodeBlockIconComponent;
+  /**
+   * The (optional) title of the `CodeBlock`. Default renders as an h3 element,
+   * use asChild to render something else.
+   *
+   * @see https://mantle.ngrok.com/components/code-block#codeblocktitle
+   *
+   * @example
+   * ```tsx
+   * <CodeBlock.Root>
+   *   <CodeBlock.Header>
+   *     <CodeBlock.Icon preset="file" />
+   *     <CodeBlock.Title>example.js</CodeBlock.Title>
+   *   </CodeBlock.Header>
+   * </CodeBlock.Root>
+   * ```
+   */
+  readonly Title: react.ForwardRefExoticComponent<HTMLAttributes<HTMLHeadingElement> & {
+    asChild?: boolean;
+  } & react.RefAttributes<HTMLHeadingElement>>;
 };
-
+//#endregion
+//#region src/components/code-block/escape-html.d.ts
 /**
  * Escapes special HTML characters in a string to their corresponding
  * HTML entities, preventing issues like unintended HTML rendering or
@@ -348,24 +362,27 @@ declare const CodeBlock: {
  * // Returns: '&lt;div&gt;Hello &amp; &quot;world&quot;&lt;/div&gt;'
  */
 declare function escapeHtml(value: string): string;
-
+//#endregion
+//#region src/components/code-block/fmt-code.d.ts
 type Primitive = string | number | boolean | undefined | null;
 /**
  * Tagged template literal to format code blocks and normalize leading indentation
  */
 declare function fmtCode(strings: TemplateStringsArray, ...values: Primitive[]): string;
-
+//#endregion
+//#region src/components/code-block/normalize.d.ts
 type Options = {
-    /**
-     * The indentation type to use. Can be either "tabs" or "spaces".
-     * @default "spaces"
-     */
-    indentation?: Indentation;
+  /**
+   * The indentation type to use. Can be either "tabs" or "spaces".
+   * @default "spaces"
+   */
+  indentation?: Indentation;
 };
 /**
  * Trim any leading and trailing whitespace/empty lines, convert leading
  * indentation to the given options.indentation
  */
 declare function normalizeIndentation(value: string, options?: Options): string;
-
+//#endregion
 export { CodeBlock, type DefaultMeta, type Meta, type MetaInput, type Mode, type SupportedLanguage, defaultMeta, escapeHtml, fmtCode, formatLanguageClassName, isSupportedLanguage, normalizeIndentation, parseLanguage, parseMetastring, supportedLanguages };
+//# sourceMappingURL=code-block.d.ts.map