@magemetrics/ai 0.8.2 → 0.9.1

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

@@ -8,7 +8,6 @@ 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';
 import { InfiniteData } from '@tanstack/react-query';
 import { InfiniteQueryObserverResult } from '@tanstack/react-query';
 import { MageMetricsClient } from '@magemetrics/core';
@@ -21,6 +20,7 @@ import { SortingState as SortingState_2 } from '@tanstack/react-table';
 import { UseMutateAsyncFunction } from '@tanstack/react-query';
 import { UseMutateFunction } from '@tanstack/react-query';
 import { UseMutationOptions } from '@tanstack/react-query';
+import { UseQueryOptions } from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 import { z } from 'zod';
 
@@ -53,6 +53,25 @@ export { AuthState }
  */
 export declare type BrandColors = PrimaryColorOption & SecondaryColorOption;
 
+/**
+ * A standalone authenticated Canvas component that renders a canvas by its ID.
+ * This is useful for displaying saved canvases without the chat interface.
+ * @param root0 props for the component
+ * @param root0.canvasId The UUID of the canvas to display
+ * @returns the canvas component
+ * @example
+ * ```tsx
+ * import { Canvas } from "@magemetrics/ai";
+ *
+ * const SavedCanvasView = ({ canvasId }: { canvasId: string }) => {
+ *   return <Canvas canvasId={canvasId} />;
+ * };
+ * ```
+ */
+export declare const Canvas: React.FC<{
+    canvasId: string;
+}>;
+
 export declare type CellContentProps = {
     formattedValue: FormattedData | undefined;
     unit?: string;
@@ -128,6 +147,10 @@ export declare interface Components {
     }) => default_2.ReactNode;
     avatar?: default_2.ReactNode;
     getCanvasShareableLink?: (canvasId: string) => string;
+    canvasPanelActions?: (props: {
+        canvas: FrontendCanvas;
+        flowId: string;
+    }) => default_2.ReactNode;
 }
 
 export declare const ConfigurableChat: ConfigurableChatComponent;
@@ -243,15 +266,6 @@ export { ExternalAuthProvider }
 
 export { ExternalAuthProviderConfig }
 
-declare type ExtractInsightResponse = z.infer<typeof ExtractInsightResponseSchema>;
-
-declare const ExtractInsightResponseSchema: z.ZodUnion<[z.ZodObject<{
-    type: z.ZodLiteral<"text">;
-    insight: z.ZodString;
-}, z.core.$strip>, z.ZodObject<{
-    type: z.ZodLiteral<"missing">;
-}, z.core.$strip>]>;
-
 /**
  * This module handles the formatting and normalization of table cell values for display and sorting.
  *
@@ -279,6 +293,16 @@ declare type FormattedData = {
     sortValue: string | number | Date | null;
 };
 
+declare type FrontendCanvas = z.infer<typeof FrontendCanvasSchema>;
+
+declare const FrontendCanvasSchema: z.ZodObject<{
+    title: z.ZodNullable<z.ZodString>;
+    id: z.ZodUUID;
+    nodes: z.ZodArray<z.ZodAny>;
+    edges: z.ZodArray<z.ZodAny>;
+    is_public: z.ZodBoolean;
+}, z.core.$strip>;
+
 declare type FrontendReport = z.infer<typeof FrontendReportSchema>;
 
 declare type FrontendReportColumns = z.infer<typeof FrontendReportColumnsSchema>;
@@ -287,6 +311,15 @@ declare const FrontendReportColumnsSchema: z.ZodArray<z.ZodObject<{
     dataType: z.ZodString;
     renderType: z.ZodOptional<z.ZodString>;
     unit: z.ZodOptional<z.ZodString>;
+    canonicalDataType: z.ZodOptional<z.ZodEnum<{
+        boolean: "boolean";
+        array: "array";
+        text: "text";
+        json: "json";
+        other: "other";
+        datetime: "datetime";
+        numeric: "numeric";
+    }>>;
     name: z.ZodString;
     data_type: z.ZodString;
 }, z.core.$strip>>;
@@ -443,8 +476,6 @@ declare const FrontendVisualizationSchema: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 
-export { GenerateInsightParam }
-
 export declare const InfiniteDataTableUI: React.FC<InfiniteDataTableUIProps>;
 
 declare type InfiniteDataTableUIProps = {
@@ -707,7 +738,47 @@ declare type StartOptions = DisplayControlProps & {
     enableSpeechToText?: boolean;
 };
 
-declare type TableFilters = Record<string, string | number>;
+declare type TableFilters = Record<string, TableFilterValue>;
+
+declare type TableFilterValue = z.infer<typeof TableFilterValueSchema>;
+
+declare const TableFilterValueSchema: z.ZodObject<{
+    operator: z.ZodEnum<{
+        endsWith: "endsWith";
+        startsWith: "startsWith";
+        contains: "contains";
+        eq: "eq";
+        gt: "gt";
+        gte: "gte";
+        lt: "lt";
+        lte: "lte";
+        neq: "neq";
+        regex: "regex";
+        between: "between";
+    }>;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>;
+}, z.core.$strip>;
+
+/**
+ * Hook to fetch a canvas by its ID.
+ * @param canvasId - The UUID of the canvas to fetch
+ * @param options - Optional react-query options
+ * @returns Query result with the canvas data
+ * @example
+ * ```tsx
+ * const { data: canvas, isLoading } = useCanvas(canvasId);
+ * if (canvas) {
+ *   console.log(canvas.title, canvas.is_public);
+ * }
+ * ```
+ */
+export declare const useCanvas: (canvasId: string | undefined | null, options?: Omit<UseQueryOptions<FrontendCanvas, unknown>, "queryKey" | "queryFn">) => UseQueryResult<    {
+    title: string | null;
+    id: string;
+    nodes: any[];
+    edges: any[];
+    is_public: boolean;
+}, unknown>;
 
 export declare const useChatContext: () => ChatContextValue;
 
@@ -838,6 +909,7 @@ export declare const useDataReport: (reportId: FrontendReport["id"]) => {
         dataType: string;
         renderType?: string;
         unit?: string;
+        canonicalDataType?: "numeric" | "boolean" | "datetime" | "text" | "array" | "json" | "other";
     }[] | undefined;
     isPendingColumns: boolean;
     isPendingData: boolean;
@@ -975,169 +1047,6 @@ export declare const useDownloadReportData: (options?: UseMutationOptions<Export
     mutateAsync: UseMutateAsyncFunction<ExportReportDataResult, Error, ExportReportDataParams, unknown>;
 };
 
-export declare const useGenerateContextualInsight: (options?: UseMutationOptions<ExtractInsightResponse, Error, GenerateInsightParam>) => {
-    generateInsight: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    generateInsightAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    data: undefined;
-    variables: undefined;
-    error: null;
-    isError: false;
-    isIdle: true;
-    isPending: false;
-    isSuccess: false;
-    status: "idle";
-    mutate: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-} | {
-    generateInsight: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    generateInsightAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    data: undefined;
-    variables: GenerateInsightParam;
-    error: null;
-    isError: false;
-    isIdle: false;
-    isPending: true;
-    isSuccess: false;
-    status: "pending";
-    mutate: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-} | {
-    generateInsight: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    generateInsightAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    data: undefined;
-    error: Error;
-    variables: GenerateInsightParam;
-    isError: true;
-    isIdle: false;
-    isPending: false;
-    isSuccess: false;
-    status: "error";
-    mutate: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-} | {
-    generateInsight: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    generateInsightAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    data: {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    };
-    error: null;
-    variables: GenerateInsightParam;
-    isError: false;
-    isIdle: false;
-    isPending: false;
-    isSuccess: true;
-    status: "success";
-    mutate: UseMutateFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-    reset: () => void;
-    context: unknown;
-    failureCount: number;
-    failureReason: Error | null;
-    isPaused: boolean;
-    submittedAt: number;
-    mutateAsync: UseMutateAsyncFunction<    {
-        type: "text";
-        insight: string;
-    } | {
-        type: "missing";
-    }, Error, GenerateInsightParam, unknown>;
-};
-
 export declare const useMageMetricsApiUrl: () => string;
 
 export declare const useMageMetricsClient: () => MageMetricsClient;
@@ -1156,6 +1065,7 @@ export declare const usePaginatedDataReport: (reportId: FrontendReport["id"], op
         dataType: string;
         renderType?: string;
         unit?: string;
+        canonicalDataType?: "numeric" | "boolean" | "datetime" | "text" | "array" | "json" | "other";
     }[] | undefined;
     isPendingColumns: boolean;
     isPendingData: boolean;