@magemetrics/ai 0.0.40 → 0.0.42

package/dist/react/index.d.ts

@@ -1,34 +1,255 @@
-import { ComponentPropsWithoutRef } from 'react';
-import { JSX } from 'react/jsx-runtime';
+import { default as default_2 } from 'react';
+import { z } from '@hono/zod-openapi';
+
+export declare class ApiService {
+    private client;
+    constructor(baseUrl: string);
+    getRecentFlows: (params: {
+        limit?: number;
+    }) => Promise<{
+        created_at: string;
+        id: string;
+        request: string;
+        user_id: string | null;
+    }[]>;
+    startFlow: (request: string) => Promise<string>;
+}
+
+export declare type CellContentProps = {
+    formattedValue: FormattedData | undefined;
+    isOpened: boolean;
+    unit?: string;
+    renderType?: string;
+};
+
+export declare interface Components {
+    dataTableCells?: {
+        [key: string]: (props: CellContentProps) => default_2.ReactNode;
+    };
+    dataReportTable?: (props: DataReportMessageProps) => default_2.ReactNode;
+}
 
 declare type ControlledModalProps = {
     visible: boolean;
     onClose: () => void;
 };
 
+export declare interface DataReportMessageProps {
+    report: FrontendFlowData;
+    isOpened: boolean;
+    setIsOpened: (opened: boolean) => void;
+    infiniteData: {
+        data?: {
+            pages: unknown[][];
+        };
+        isPending: boolean;
+        fetchNextPage: () => Promise<unknown>;
+        isFetching: boolean;
+        isFetchingNextPage: boolean;
+        hasNextPage: boolean | undefined;
+    };
+    columns: FrontendFlowColumns;
+    totalRows: number;
+}
+
 declare type DisplayControlProps = {
     showRecommendations?: boolean;
     showRecentChats?: boolean;
     showBackdrop?: boolean;
 };
 
+/**
+ * This module handles the formatting and normalization of table cell values for display and sorting.
+ *
+ * Problem:
+ * When displaying data in tables, we often receive values in various formats (strings, dates,
+ * JSON objects, etc.). We need to:
+ * 1. Display these values in a consistent, human-readable format
+ * 2. Enable proper sorting of these values regardless of their original format
+ *
+ * Solution:
+ * The FormattedData type and formatCellValue function transform any input value into a
+ * standardized format with two properties:
+ * - display: A string representation suitable for rendering
+ * - sortValue: A normalized value (string/number/date) suitable for consistent sorting
+ *
+ * The module handles various special cases:
+ * - JSON strings (parsing them to extract actual values)
+ * - Date/time values (converting to consistent format)
+ * - BigQuery-style objects with 'value' property
+ * - Nested objects (pretty-printing them)
+ * - Null/undefined values
+ */
+declare type FormattedData = {
+    display: (string & {}) | "empty" | null;
+    sortValue: string | number | Date | null;
+};
+
+declare type FrontendFlowColumns = z.infer<typeof FrontendFlowColumnsSchema>;
+
+declare const FrontendFlowColumnsSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    data_type: z.ZodString;
+} & {
+    dataType: z.ZodString;
+    renderType: z.ZodOptional<z.ZodString>;
+    unit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    data_type: string;
+    dataType: string;
+    unit?: string | undefined;
+    renderType?: string | undefined;
+}, {
+    name: string;
+    data_type: string;
+    dataType: string;
+    unit?: string | undefined;
+    renderType?: string | undefined;
+}>, "many">;
+
+declare type FrontendFlowData = z.infer<typeof FrontendFlowDataSchema>;
+
+declare const FrontendFlowDataSchema: z.ZodObject<Omit<{
+    created_at: z.ZodString;
+    flow_id: z.ZodString;
+    id: z.ZodNumber;
+    is_sample: z.ZodBoolean;
+    schema: z.ZodString;
+    sql: z.ZodString;
+    table: z.ZodString;
+    title: z.ZodString;
+    data_sample: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
+    data_summary: z.ZodObject<{
+        columns: z.ZodRecord<z.ZodString, z.ZodObject<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        columns: z.ZodRecord<z.ZodString, z.ZodObject<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        columns: z.ZodRecord<z.ZodString, z.ZodObject<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "schema" | "sql" | "table" | "created_at" | "is_sample" | "data_sample">, "strip", z.ZodTypeAny, {
+    title: string;
+    id: number;
+    flow_id: string;
+    data_summary: {
+        columns: Record<string, z.objectOutputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">>;
+    } & {
+        [k: string]: unknown;
+    };
+}, {
+    title: string;
+    id: number;
+    flow_id: string;
+    data_summary: {
+        columns: Record<string, z.objectInputType<{
+            position: z.ZodOptional<z.ZodNumber>;
+            data_type: z.ZodString;
+            null_count: z.ZodNullable<z.ZodNumber>;
+            unique_count: z.ZodNullable<z.ZodNumber>;
+            unique_percentage: z.ZodNullable<z.ZodNumber>;
+        }, z.ZodTypeAny, "passthrough">>;
+    } & {
+        [k: string]: unknown;
+    };
+}>;
+
 export declare const logout: () => Promise<void>;
 
-export declare const MageMetricsModal: (props: MageMetricsModalProps) => JSX.Element;
+export declare const MageMetricsContextProvider: default_2.FC<MageMetricsContextProviderProps>;
+
+export declare interface MageMetricsContextProviderProps {
+    children: default_2.ReactNode;
+    apiKey?: string;
+    externalJwt?: string;
+    apiUrl: string;
+    experimental_components?: Components;
+}
 
-declare type MageMetricsModalProps = ComponentPropsWithoutRef<typeof MainModal>;
+export declare const ManagedModal: React.FC<ManagedModalProps>;
 
-declare const MainModal: React.FC<{
+declare interface ManagedModalProps extends ModalProps {
     apiKey: string;
     externalJwt: string;
     apiUrl: string;
-    display?: string;
     persist?: PersistenceOptions;
+    experimental_components?: Components;
+}
+
+declare interface ModalProps {
+    display?: string;
     modal?: ControlledModalProps;
     startOptions?: StartOptions;
-}>;
+}
+
+declare type PersistenceOptions = "queryParam" | "none";
 
-declare type PersistenceOptions = "localStorage" | "queryParam" | "none";
+export declare const StandaloneConversationModal: React.FC<StandaloneConversationModalProps>;
+
+declare type StandaloneConversationModalProps = {
+    opened: boolean;
+    flowId: string;
+    onOpenChange?: (open: boolean) => void;
+};
 
 declare type StartOptions = DisplayControlProps & {
     label?: string;
@@ -41,7 +262,7 @@ export { }
 declare module "react" {
     namespace JSX {
         interface IntrinsicElements {
-            "magemetrics-ai": SearchElementAttributes;
+            "magemetrics-ai": ManagedModalProps;
         }
     }
 }