@magemetrics/ai 0.0.54-RC4 → 0.0.54-RC6

package/dist/react/index.d.ts

@@ -8,6 +8,7 @@ import { JSX } from 'react/jsx-runtime';
 import { objectOutputType } from 'zod';
 import { PropsWithChildren } from 'react';
 import { RefAttributes } from 'react';
+import type { Simplify } from 'type-fest';
 import { UseMutateAsyncFunction } from '@tanstack/react-query';
 import { UseMutateFunction } from '@tanstack/react-query';
 import { UseMutationOptions } from '@tanstack/react-query';
@@ -37,7 +38,7 @@ declare const Chat_2: default_2.MemoExoticComponent<({ flowId, className }: {
 
 export declare const ChatInput: React.FC<React.ComponentProps<typeof ChatInput_2>>;
 
-declare const ChatInput_2: default_2.FC<{
+declare const ChatInput_2: React.FC<{
     flowId: string;
 }>;
 
@@ -50,7 +51,6 @@ export declare const ChatMessages: React.FC<React.ComponentProps<typeof ChatMess
 
 declare const ChatMessages_2: default_2.FC<{
     flowId: string;
-    onWaitingMessagesCursorChange?: (value: number) => void;
 }>;
 
 export declare interface Components {
@@ -815,7 +815,15 @@ export declare class MageMetricsClient extends EventTarget {
             data_reports: number;
             visualizations: number;
         }>;
+        /**
+         * @deprecated Use `createFlow` instead.
+         * @param request the user request
+         * @returns the id of the created flow
+         */
         startFlow: (request: StartFlowParam) => Promise<string>;
+        createFlow: (request: StartFlowParam) => Promise<{
+            flowId: string;
+        }>;
         getDashboard: (dashboardId: string) => Promise<{
             description: string | null;
             id: string;
@@ -873,15 +881,13 @@ export declare interface MageMetricsClientConfig {
     apiUrl: string;
     apiKey: string;
     externalJwt?: string;
+    additionalHeaders?: Record<string, string>;
 }
 
 export declare const MageMetricsContextProvider: default_2.FC<MageMetricsContextProviderProps>;
 
-export declare interface MageMetricsContextProviderProps {
+export declare interface MageMetricsContextProviderProps extends MageMetricsClientConfig {
     children: default_2.ReactNode;
-    apiKey: string;
-    externalJwt?: string;
-    apiUrl: string;
     experimental_components?: Components;
 }
 
@@ -2067,6 +2073,50 @@ declare interface operations {
             };
         };
     };
+    createFlow: {
+        parameters: {
+            query?: never;
+            header: {
+                "sp-access-token": string;
+                "sp-refresh-token"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    userQuery: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Create a new flow */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        status: "success";
+                        flowId: string;
+                    };
+                };
+            };
+            /** @description Something wrong happened */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                    };
+                };
+            };
+        };
+    };
     retrieveChatTimeline: {
         parameters: {
             query?: never;
@@ -3077,6 +3127,22 @@ declare interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/flows": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["createFlow"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/chat/{flowId}/timeline": {
         parameters: {
             query?: never;
@@ -3361,10 +3427,6 @@ declare type RemoveParamsConfig = Simplify<{
     cookie?: string;
 }>;
 
-declare type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-} & {};
-
 export declare const StandaloneConversationModal: React.FC<StandaloneConversationModalProps>;
 
 declare type StandaloneConversationModalProps = {
@@ -3390,6 +3452,120 @@ declare type ToRemove = Simplify<{
     header: "sp-access-token" | "sp-refresh-token";
 }>;
 
+export declare const useCreateFlow: (options?: UseMutationOptions<{
+    flowId: string;
+}, Error, StartFlowParam>) => {
+    createFlow: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    createFlowAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    data: undefined;
+    variables: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+} | {
+    createFlow: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    createFlowAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    data: undefined;
+    variables: StartFlowParam;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    status: "pending";
+    mutate: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+} | {
+    createFlow: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    createFlowAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    data: undefined;
+    error: Error;
+    variables: StartFlowParam;
+    isError: true;
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    status: "error";
+    mutate: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+} | {
+    createFlow: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    createFlowAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    data: {
+        flowId: string;
+    };
+    error: null;
+    variables: StartFlowParam;
+    isError: false;
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    status: "success";
+    mutate: UseMutateFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+    mutateAsync: UseMutateAsyncFunction<    {
+    flowId: string;
+    }, Error, StartFlowParam, unknown>;
+};
+
 export declare const useDataReport: (flowDataId: FrontendReport["id"]) => {
     dataColumns: {
         name: string;
@@ -3603,6 +3779,12 @@ request: string;
 user_id: string | null;
 }[], Error>;
 
+/**
+ * Create a new flow with the given user query.
+ * @deprecated Use `useCreateFlow` instead.
+ * @param options tanstack query options to create the flow
+ * @returns a mutation
+ */
 export declare const useStartFlow: (options?: UseMutationOptions<string, Error, StartFlowParam>) => {
     startFlow: UseMutateFunction<string, Error, StartFlowParam, unknown>;
     startFlowAsync: UseMutateAsyncFunction<string, Error, StartFlowParam, unknown>;