@magemetrics/ai 0.5.3 → 0.6.0

package/dist/web-component/index.d.ts

@@ -1,7 +1,11 @@
+import { AuthProvider } from '@magemetrics/core';
 import { AuthState } from '@magemetrics/core';
 import { CreateFlowParam } from '@magemetrics/core';
 import { default as default_2 } from 'react';
+import { DirectAuthProvider } from '@magemetrics/core';
 import { Dispatch } from 'react';
+import { ExternalAuthProvider } from '@magemetrics/core';
+import { ExternalAuthProviderConfig } from '@magemetrics/core';
 import { FetchNextPageOptions } from '@tanstack/react-query';
 import { ForwardRefExoticComponent } from 'react';
 import { GenerateInsightParam } from '@magemetrics/core';
@@ -20,21 +24,76 @@ import { UseMutationOptions } from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 import { z } from 'zod';
 
+/**
+ * Appearance configuration for visual customization of the `@magemetrics/ai` package.
+ */
+export declare type AppearanceConfig = {
+    /**
+     * Brand colors used throughout the UI (buttons, accents, interactive elements).
+     */
+    colors?: BrandColors;
+    /**
+     * Modal-specific appearance settings.
+     */
+    modal?: ModalAppearance;
+};
+
 declare type AssemblyAIMicrophoneController = {
     status: "idle" | "starting" | "recording";
     startRecording: (onTranscript: (text: string) => void) => Promise<void>;
     stopRecording: () => Promise<void>;
 };
 
+export { AuthProvider }
+
 export { AuthState }
 
+/**
+ * Brand colors configuration for the appearance prop.
+ */
+export declare type BrandColors = PrimaryColorOption & SecondaryColorOption;
+
 export declare type CellContentProps = {
     formattedValue: FormattedData | undefined;
     unit?: string;
     renderType?: string;
 };
 
-export declare const Chat: React.FC<ConversationContentProps>;
+export declare const Chat: React.FC<PublicChatProps>;
+
+declare const Chat_2: ChatComponent;
+
+declare interface ChatComponent extends default_2.MemoExoticComponent<(props: ChatProps) => default_2.JSX.Element> {
+    Messages: typeof MessagesContainer;
+    Input: typeof InputContainer & {
+        Default: typeof ChatInputDefault;
+    };
+}
+
+export declare interface ChatContextValue {
+    flowId: string | undefined | null;
+    enableSpeechToText?: boolean;
+}
+
+export declare interface ChatInputContextValue {
+    flowId: string | undefined;
+    isLoading: boolean;
+    isStreaming: boolean;
+    isError: boolean;
+    onRetry?: () => void;
+    onStop?: () => void;
+    sendMessage: (text: string, isEditing: boolean) => void;
+    lastUserMessage?: string;
+    enableSpeechToText?: boolean;
+}
+
+declare const ChatInputDefault: default_2.FC;
+
+declare interface ChatProps {
+    flowId: string | undefined | null;
+    enableSpeechToText?: boolean;
+    children?: default_2.ReactNode;
+}
 
 declare interface ColumnSort {
     desc: boolean;
@@ -70,6 +129,26 @@ export declare interface Components {
     getCanvasShareableLink?: (canvasId: string) => string;
 }
 
+export declare const ConfigurableChat: ConfigurableChatComponent;
+
+declare interface ConfigurableChatComponent extends default_2.FC<ConfigurableChatComponentProps> {
+    Messages: typeof Chat_2.Messages;
+    Input: typeof Chat_2.Input;
+}
+
+declare type ConfigurableChatComponentProps = {
+    flowId: string | undefined | null;
+    enableSpeechToText?: boolean;
+    disableCanvas?: boolean;
+    children?: default_2.ReactNode;
+    /**
+     * Appearance configuration for customizing the visual style.
+     * Includes brand colors and modal-specific styling options.
+     */
+    appearance?: AppearanceConfig;
+};
+
+/** @deprecated This type is no longer used and will be removed in a future version. */
 declare type ControlledModalProps = {
     visible: boolean;
     onClose: () => void;
@@ -84,6 +163,7 @@ declare interface ConversationContentProps {
     topBar?: React.ReactNode;
     disableCanvas?: boolean;
     enableSpeechToText?: boolean;
+    children?: React.ReactNode;
 }
 
 export { CreateFlowParam }
@@ -128,6 +208,8 @@ declare type DataTableState = {
     filters: TableFilters;
 };
 
+export { DirectAuthProvider }
+
 declare type DisplayControlProps = {
     /** Whether to display the recommendations section when the input is active */
     showRecommendations?: boolean;
@@ -139,9 +221,7 @@ declare type DisplayControlProps = {
 
 export declare const DomWrapper: React.FC<PropsWithChildren<DomWrapperProps>>;
 
-declare type DomWrapperProps = {
-    display?: string;
-};
+declare type DomWrapperProps = InternalColorSwatchProps;
 
 export declare const DownloadDataReportButton: React.FC<{
     reportId: number;
@@ -158,6 +238,10 @@ declare type ExportReportDataResult = {
     data: Blob | string;
 };
 
+export { ExternalAuthProvider }
+
+export { ExternalAuthProviderConfig }
+
 declare type ExtractInsightResponse = z.infer<typeof ExtractInsightResponseSchema>;
 
 declare const ExtractInsightResponseSchema: z.ZodUnion<[z.ZodObject<{
@@ -209,7 +293,6 @@ declare const FrontendReportColumnsSchema: z.ZodArray<z.ZodObject<{
 declare type FrontendReportExplainability = z.infer<typeof FrontendReportExplainabilitySchema>;
 
 declare const FrontendReportExplainabilitySchema: z.ZodObject<{
-    flow_data_id: z.ZodNumber;
     sql_explanation: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         chunk_title: z.ZodString;
         chunk_explanation: z.ZodString;
@@ -257,6 +340,7 @@ declare const FrontendReportExplainabilitySchema: z.ZodObject<{
     assumptions_score_reason: z.ZodOptional<z.ZodString>;
     friendliness_score: z.ZodOptional<z.ZodNumber>;
     friendliness_score_reason: z.ZodOptional<z.ZodString>;
+    flow_data_id: z.ZodNumber;
 }, z.core.$strip>;
 
 declare const FrontendReportSchema: z.ZodObject<{
@@ -267,7 +351,14 @@ declare const FrontendReportSchema: z.ZodObject<{
     created_at: z.ZodString;
     is_removed: z.ZodBoolean;
     flow_id: z.ZodString;
-    bookmarked: z.ZodBoolean;
+    is_materialized: z.ZodNullable<z.ZodBoolean>;
+    last_materialized_at: z.ZodNullable<z.ZodString>;
+    materialized_error_message: z.ZodNullable<z.ZodString>;
+    materialized_status: z.ZodNullable<z.ZodEnum<{
+        running: "running";
+        completed: "completed";
+        failed: "failed";
+    }>>;
     data_summary: z.ZodObject<{
         columns: z.ZodRecord<z.ZodString, z.ZodObject<{
             position: z.ZodOptional<z.ZodNumber>;
@@ -275,8 +366,19 @@ declare const FrontendReportSchema: z.ZodObject<{
             null_count: z.ZodNullable<z.ZodNumber>;
             unique_count: z.ZodNullable<z.ZodNumber>;
             unique_percentage: z.ZodNullable<z.ZodNumber>;
+            min_value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            max_value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            avg_value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            median_value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            std_value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            min_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            max_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            min_length: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            max_length: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            avg_length: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         }, z.core.$loose>>;
     }, z.core.$loose>;
+    bookmarked: z.ZodBoolean;
 }, z.core.$strip>;
 
 declare type FrontendVisualization = z.output<typeof FrontendVisualizationSchema>;
@@ -284,8 +386,18 @@ declare type FrontendVisualization = z.output<typeof FrontendVisualizationSchema
 declare const FrontendVisualizationSchema: z.ZodObject<{
     id: z.ZodNumber;
     created_at: z.ZodString;
-    flow_data_id: z.ZodNumber;
     bookmarked: z.ZodBoolean;
+    flow_data_id: z.ZodNumber;
+    flow_data: z.ZodOptional<z.ZodObject<{
+        is_materialized: z.ZodNullable<z.ZodBoolean>;
+        last_materialized_at: z.ZodNullable<z.ZodString>;
+        materialized_error_message: z.ZodNullable<z.ZodString>;
+        materialized_status: z.ZodNullable<z.ZodEnum<{
+            running: "running";
+            completed: "completed";
+            failed: "failed";
+        }>>;
+    }, z.core.$strip>>;
     configuration: z.ZodDiscriminatedUnion<[z.ZodObject<{
         config_version: z.ZodLiteral<2>;
         xAxisLabel: z.ZodString;
@@ -344,6 +456,21 @@ declare type InfiniteDataTableUIProps = {
     totalRows: number;
 };
 
+declare const InputContainer: default_2.FC<{
+    children?: default_2.ReactNode | ((context: ChatInputContextValue) => default_2.ReactNode);
+}>;
+
+/**
+ * Internal/relaxed type for passing color props through component trees.
+ * Use this for internal components; use ColorSwatchOptions for external APIs.
+ */
+declare type InternalColorSwatchProps = {
+    primaryColor?: string;
+    primarySwatch?: PrimaryColorSwatch;
+    secondaryColor?: string;
+    secondarySwatch?: SecondaryColorSwatch;
+};
+
 export declare const logout: () => void;
 
 export { MageMetricsClient }
@@ -376,7 +503,7 @@ declare type MageMetricsPublicContextProviderProps = PropsWithChildren<Pick<Mage
 
 export declare const ManagedModal: React.FC<ManagedModalProps>;
 
-declare interface ManagedModalProps extends ModalProps {
+declare type ManagedModalBaseProps = ModalProps & {
     /** API key for authenticating with the MageMetrics service */
     apiKey: string;
     /** External JWT token for user authentication */
@@ -393,10 +520,42 @@ declare interface ManagedModalProps extends ModalProps {
     components?: Components;
     /** Application name to associate with flows created through this modal */
     applicationName?: string;
-}
+    /**
+     * Appearance configuration for customizing the visual style.
+     * Includes brand colors and modal-specific styling options.
+     */
+    appearance?: AppearanceConfig;
+    /** Callbacks for various events */
+    callbacks?: {
+        /** Callback fired when the conversation modal is opened */
+        onConversationOpen?: () => void;
+    };
+};
+
+/**
+ * Props for ManagedModal component.
+ */
+declare type ManagedModalProps = ManagedModalBaseProps;
+
+declare const MessagesContainer: default_2.FC;
+
+/**
+ * Modal-specific appearance configuration.
+ */
+export declare type ModalAppearance = {
+    /**
+     * Primary color for modal background gradient.
+     * Used to customize the mesh gradient background in conversation modals.
+     * Can be any CSS color (hex, rgb, hsl, oklch, etc.).
+     */
+    backgroundPrimary?: string;
+};
 
 declare interface ModalProps {
-    /** Control modal visibility and close behavior externally */
+    /**
+     * @deprecated This prop is no longer used and will be removed in a future version.
+     * Control modal visibility and close behavior externally
+     */
     modal?: ControlledModalProps;
     /** Configuration options for the start modal (chat launcher, recommendations, etc.) */
     startOptions?: StartOptions;
@@ -435,12 +594,44 @@ declare type PaginatedDataTableUIProps = {
 
 declare type PersistenceOptions = "queryParam" | "none";
 
+/**
+ * Primary color shade stops used in the UI.
+ */
+declare const PRIMARY_SHADE_STOPS: readonly ["50", "400", "500", "600", "650", "750", "900"];
+
+/**
+ * Primary color options - mutually exclusive: use either primaryColor OR primarySwatch, not both.
+ */
+declare type PrimaryColorOption = {
+    primaryColor: string;
+    primarySwatch?: never;
+} | {
+    primaryColor?: never;
+    primarySwatch: PrimaryColorSwatch;
+} | {
+    primaryColor?: never;
+    primarySwatch?: never;
+};
+
+declare type PrimaryColorShade = (typeof PRIMARY_SHADE_STOPS)[number];
+
+/** Complete primary swatch (7 shades required) */
+export declare type PrimaryColorSwatch = Record<PrimaryColorShade, string>;
+
 export declare const PublicCanvas: React.FC<React.ComponentProps<typeof PublicCanvasPanel>>;
 
 declare const PublicCanvasPanel: default_2.FC<{
     canvasId: string;
 }>;
 
+export declare type PublicChatProps = Omit<ConversationContentProps, "children"> & {
+    /**
+     * Appearance configuration for customizing the visual style.
+     * Includes brand colors and modal-specific styling options.
+     */
+    appearance?: AppearanceConfig;
+};
+
 /**
  * This component is not bounded in height and must be wrapped in a container to properly work
  * @param props - props
@@ -465,9 +656,33 @@ declare type ReportDataFilters = {
     cursor?: number;
 };
 
+/**
+ * Secondary color shade stops used in the UI.
+ */
+declare const SECONDARY_SHADE_STOPS: readonly ["500", "600", "700"];
+
+/**
+ * Secondary color options - mutually exclusive: use either secondaryColor OR secondarySwatch, not both.
+ */
+declare type SecondaryColorOption = {
+    secondaryColor: string;
+    secondarySwatch?: never;
+} | {
+    secondaryColor?: never;
+    secondarySwatch: SecondaryColorSwatch;
+} | {
+    secondaryColor?: never;
+    secondarySwatch?: never;
+};
+
+declare type SecondaryColorShade = (typeof SECONDARY_SHADE_STOPS)[number];
+
+/** Complete secondary swatch (3 shades required) */
+export declare type SecondaryColorSwatch = Record<SecondaryColorShade, string>;
+
 declare type SortingState = ColumnSort[];
 
-export declare const StandaloneConversationModal: React.FC<StandaloneConversationModalProps>;
+export declare const StandaloneConversationModal: default_2.FC<StandaloneConversationModalProps>;
 
 declare type StandaloneConversationModalProps = {
     opened: boolean;
@@ -475,6 +690,7 @@ declare type StandaloneConversationModalProps = {
     disableCanvas?: boolean;
     showDataFreshness?: boolean;
     onOpenChange?: (open: boolean) => void;
+    appearance?: AppearanceConfig;
 };
 
 declare type StartOptions = DisplayControlProps & {
@@ -490,6 +706,10 @@ declare type StartOptions = DisplayControlProps & {
 
 declare type TableFilters = Record<string, string | number>;
 
+export declare const useChatContext: () => ChatContextValue;
+
+export declare const useChatInputContext: () => ChatInputContextValue;
+
 export declare const useCreateFlow: (options?: UseMutationOptions<{
     flowId: string;
 }, Error, CreateFlowParam>) => {
@@ -1008,8 +1228,18 @@ declare type V1FrontendVisualization = z.output<typeof V1FrontendVisualizationSc
 declare const V1FrontendVisualizationSchema: z.ZodObject<{
     id: z.ZodNumber;
     created_at: z.ZodString;
-    flow_data_id: z.ZodNumber;
     bookmarked: z.ZodBoolean;
+    flow_data_id: z.ZodNumber;
+    flow_data: z.ZodOptional<z.ZodObject<{
+        is_materialized: z.ZodNullable<z.ZodBoolean>;
+        last_materialized_at: z.ZodNullable<z.ZodString>;
+        materialized_error_message: z.ZodNullable<z.ZodString>;
+        materialized_status: z.ZodNullable<z.ZodEnum<{
+            running: "running";
+            completed: "completed";
+            failed: "failed";
+        }>>;
+    }, z.core.$strip>>;
     configuration: z.ZodDiscriminatedUnion<[z.ZodObject<{
         xAxisLabel: z.ZodString;
         yAxisLabel: z.ZodString;