@surrealdb/ui 1.0.4 → 1.0.5

package/dist/ui.d.ts

@@ -1,3 +1,4 @@
+import { AlertProps } from '@mantine/core';
 import { BoxProps } from '@mantine/core';
 import { FC } from 'react';
 import { Highlighter } from '@lezer/highlight';
@@ -5,11 +6,11 @@ import { HighlightStyle } from '@codemirror/language';
 import { HTMLAttributes } from 'react';
 import { MantineColor } from '@mantine/core';
 import { MantineColorScheme } from '@mantine/core';
-import { MantineColorShade } from '@mantine/core';
-import { MantineColorsTuple } from '@mantine/core';
 import { MantineFontSize } from '@mantine/core';
-import { MantineRadius } from '@mantine/core';
-import { VariantColorsResolver } from '@mantine/core';
+import { MantineThemeOverride } from '@mantine/core';
+import type * as React_2 from 'react';
+import { ReactNode } from 'react';
+import { Root } from 'mdast';
 
 declare type AnyFn = (...rest: any[]) => any;
 
@@ -86,6 +87,17 @@ export declare const brandYouTube: string;
 
 export declare function clsx(...args: unknown[]): string;
 
+/**
+ * Enhanced code block component with copy button, title, and highlight regions
+ */
+export declare const CodeBlock: FC<CodeBlockProps>;
+
+export declare interface CodeBlockProps extends Omit<BoxProps, "children"> {
+    title?: string;
+    value: string;
+    lang?: string;
+}
+
 export declare type ColorScheme = keyof ThemeConfig;
 
 /**
@@ -93,16 +105,39 @@ export declare type ColorScheme = keyof ThemeConfig;
  */
 export declare function createHighlighter(colorScheme: ColorScheme): Highlighter;
 
+/**
+ * Create markdown components for use with hast-util-to-jsx-runtime
+ * Props come directly from HAST (hProperties are merged into props)
+ */
+export declare function createMarkdownComponents(): Record<string, React_2.ComponentType<Record<string, unknown>>>;
+
 export declare type DefaultSort = {
     [key: string]: unknown;
 };
 
+export declare interface ExtractedCode {
+    test?: string;
+    code: string;
+}
+
+/**
+ * Extract test code from block comments at the start.
+ * Pattern: block comment (slash-star-star ... star-slash) followed by code
+ */
+export declare function extractTest(input: string): ExtractedCode;
+
 export declare const Highlighting: FC<HighlightingProps>;
 
 export declare interface HighlightingProps extends BoxProps {
     value: string;
     language: string;
     colorScheme?: MantineColorScheme;
+    highlightRegions?: HighlightRegion[];
+}
+
+export declare interface HighlightRegion {
+    start: number;
+    end: number;
 }
 
 export declare const Icon: FC<IconProps>;
@@ -412,147 +447,49 @@ export declare const iconXml: string;
 /**
  * The Mantine theme configurtation
  */
-export declare const MANTINE_THEME: {
-    focusRing?: "auto" | "always" | "never" | undefined;
-    scale?: number | undefined;
-    fontSmoothing?: boolean | undefined;
-    white?: string | undefined;
-    black?: string | undefined;
-    colors?: {
-        [x: string & {}]: MantineColorsTuple | undefined;
-        dark?: MantineColorsTuple | undefined;
-        gray?: MantineColorsTuple | undefined;
-        red?: MantineColorsTuple | undefined;
-        pink?: MantineColorsTuple | undefined;
-        grape?: MantineColorsTuple | undefined;
-        violet?: MantineColorsTuple | undefined;
-        indigo?: MantineColorsTuple | undefined;
-        blue?: MantineColorsTuple | undefined;
-        cyan?: MantineColorsTuple | undefined;
-        green?: MantineColorsTuple | undefined;
-        lime?: MantineColorsTuple | undefined;
-        yellow?: MantineColorsTuple | undefined;
-        orange?: MantineColorsTuple | undefined;
-        teal?: MantineColorsTuple | undefined;
-    } | undefined;
-    primaryShade?: MantineColorShade | {
-        light?: MantineColorShade | undefined;
-        dark?: MantineColorShade | undefined;
-    } | undefined;
-    primaryColor?: string | undefined;
-    variantColorResolver?: VariantColorsResolver | undefined;
-    autoContrast?: boolean | undefined;
-    luminanceThreshold?: number | undefined;
-    fontFamily?: string | undefined;
-    fontFamilyMonospace?: string | undefined;
-    headings?: {
-        fontFamily?: string | undefined;
-        fontWeight?: string | undefined;
-        textWrap?: "balance" | "nowrap" | "wrap" | "stable" | "pretty" | undefined;
-        sizes?: {
-            h1?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-            h2?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-            h3?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-            h4?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-            h5?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-            h6?: {
-                fontSize?: string | undefined;
-                fontWeight?: string | undefined;
-                lineHeight?: string | undefined;
-            } | undefined;
-        } | undefined;
-    } | undefined;
-    radius?: {
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    defaultRadius?: MantineRadius | undefined;
-    spacing?: {
-        [x: number]: string | undefined;
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    fontSizes?: {
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    lineHeights?: {
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    breakpoints?: {
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    shadows?: {
-        [x: string & {}]: string | undefined;
-        xs?: string | undefined;
-        sm?: string | undefined;
-        md?: string | undefined;
-        lg?: string | undefined;
-        xl?: string | undefined;
-    } | undefined;
-    respectReducedMotion?: boolean | undefined;
-    cursorType?: "default" | "pointer" | undefined;
-    defaultGradient?: {
-        from?: string | undefined;
-        to?: string | undefined;
-        deg?: number | undefined;
-    } | undefined;
-    activeClassName?: string | undefined;
-    focusClassName?: string | undefined;
-    components?: {
-        [x: string]: {
-            classNames?: any;
-            styles?: any;
-            vars?: any;
-            defaultProps?: any;
-        } | undefined;
-    } | undefined;
-    other?: {
-        [x: string]: any;
-    } | undefined;
-};
+export declare const MANTINE_THEME: MantineThemeOverride;
+
+/**
+ * Main Markdown component that parses markdown and renders it
+ * Applies stylesheet and spacing
+ */
+export declare function Markdown({ content, components }: MarkdownProps): React_2.ReactElement;
+
+/**
+ * Default markdown components
+ */
+export declare const markdownComponents: Record<string, React_2.ComponentType<Record<string, unknown>>>;
+
+export declare interface MarkdownProps {
+    /**
+     * Markdown content to render
+     */
+    content: string;
+    /**
+     * Optional custom component overrides
+     */
+    components?: Partial<Record<string, React_2.ComponentType<unknown>>>;
+}
+
+/**
+ * Note/Callout component with variants: note, important, warning, caution
+ */
+export declare const Note: FC<NoteProps>;
+
+export declare const NOTE_KINDS: readonly ["note", "tip", "important", "warning", "caution"];
+
+export declare type NoteKind = (typeof NOTE_KINDS)[number];
+
+export declare interface NoteProps extends Omit<AlertProps, "title" | "children"> {
+    kind: NoteKind;
+    title?: string;
+    children: ReactNode;
+}
+
+/**
+ * Parse markdown string to mdast (Markdown AST)
+ */
+export declare function parseMarkdownAST(markdown: string): Root;
 
 export declare const picto2106: string;
 
@@ -1002,6 +939,48 @@ export declare const pictoZed: string;
 
 export declare const pictoZoomIn: string;
 
+/**
+ * Process highlight regions in code
+ */
+export declare function processHighlightRegions(code: string): {
+    regions: HighlightRegion[];
+    processedCode: string;
+};
+
+/**
+ * Remark plugin to parse title from code block meta
+ * Pattern: ```js title="file.js" or ```js {title="file.js"}
+ */
+export declare function remarkCodeTitle(): (tree: Root) => void;
+
+/**
+ * Remark plugin to detect and transform GitHub-style notes in blockquotes
+ * Pattern: > [!note], > [!warning], > [!note: Custom Title]
+ */
+export declare function remarkNotes(): (tree: Root) => void;
+
+/**
+ * Remark plugin to add slug IDs to headings
+ */
+export declare function remarkSlug(): (tree: Root) => void;
+
+/**
+ * Render parsed markdown AST to React elements
+ * Uses mdast-util-to-hast and hast-util-to-jsx-runtime for rendering
+ */
+export declare function RenderMarkdown({ ast, components, }: RenderMarkdownProps): React_2.ReactElement | null;
+
+export declare interface RenderMarkdownProps {
+    /**
+     * Parsed markdown AST to render
+     */
+    ast: Root;
+    /**
+     * Optional custom component overrides
+     */
+    components?: Partial<Record<string, React_2.ComponentType<Record<string, unknown>> | string>>;
+}
+
 export declare type SortDirection = "asc" | "desc" | undefined;
 
 export declare interface SortHandle<T = DefaultSort> {