@magemetrics/ai 0.11.0 → 0.11.1

package/dist/react/index.d.ts

@@ -94,6 +94,46 @@ export declare interface ChatContextValue {
     enableSpeechToText?: boolean;
 }
 
+/**
+ * Optional provider that allows the host application to pass dynamic runtime hints
+ * to the chat. The hints are sent with every message and injected ephemerally into
+ * the LLM prompt — they are not persisted or shown in the UI.
+ * Place this anywhere inside `MageMetricsContextProvider` and around the `Chat` component.
+ * When the `value` prop changes, the next message sent will carry the updated hints.
+ * If this provider is not used, no hints are sent — everything works as before.
+ * @param props - The provider props
+ * @param props.value - The chat hints value to provide
+ * @param props.children - The child components
+ * @returns The provider component wrapping children
+ */
+export declare const ChatHintsProvider: default_2.FC<ChatHintsProviderProps>;
+
+declare interface ChatHintsProviderProps {
+    /**
+     * Arbitrary key-value hints from the host application.
+     * These are sent alongside every chat message and injected into the LLM prompt.
+     * @example
+     * ```tsx
+     * <ChatHintsProvider value={{
+     *   selectedLocation: { lat: 48.8566, lng: 2.3522, name: "Paris" },
+     *   activeFilters: ["revenue > 1M"],
+     * }}>
+     *   <Chat flowId="..." />
+     * </ChatHintsProvider>
+     * ```
+     */
+    value: ChatHintsValue;
+    children: default_2.ReactNode;
+}
+
+/**
+ * The value type for chat hints — a free-form key-value object
+ * that the host application can use to pass runtime information to the LLM.
+ * These hints are injected ephemerally into each chat message (not persisted)
+ * so the LLM is aware of the host application's current state.
+ */
+export declare type ChatHintsValue = Record<string, unknown>;
+
 export declare interface ChatInputContextValue {
     flowId: string | undefined;
     isLoading: boolean;
@@ -625,6 +665,12 @@ is_public: boolean;
 
 export declare const useChatContext: () => ChatContextValue;
 
+/**
+ * Returns the current chat hints value, or `null` if no `ChatHintsProvider` is present.
+ * @returns The current chat hints value or null
+ */
+export declare const useChatHints: () => ChatHintsValue | null;
+
 export declare const useChatInputContext: () => ChatInputContextValue;
 
 export declare const useCreateFlow: (options?: UseMutationOptions<{

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

@@ -94,6 +94,46 @@ export declare interface ChatContextValue {
     enableSpeechToText?: boolean;
 }
 
+/**
+ * Optional provider that allows the host application to pass dynamic runtime hints
+ * to the chat. The hints are sent with every message and injected ephemerally into
+ * the LLM prompt — they are not persisted or shown in the UI.
+ * Place this anywhere inside `MageMetricsContextProvider` and around the `Chat` component.
+ * When the `value` prop changes, the next message sent will carry the updated hints.
+ * If this provider is not used, no hints are sent — everything works as before.
+ * @param props - The provider props
+ * @param props.value - The chat hints value to provide
+ * @param props.children - The child components
+ * @returns The provider component wrapping children
+ */
+export declare const ChatHintsProvider: default_2.FC<ChatHintsProviderProps>;
+
+declare interface ChatHintsProviderProps {
+    /**
+     * Arbitrary key-value hints from the host application.
+     * These are sent alongside every chat message and injected into the LLM prompt.
+     * @example
+     * ```tsx
+     * <ChatHintsProvider value={{
+     *   selectedLocation: { lat: 48.8566, lng: 2.3522, name: "Paris" },
+     *   activeFilters: ["revenue > 1M"],
+     * }}>
+     *   <Chat flowId="..." />
+     * </ChatHintsProvider>
+     * ```
+     */
+    value: ChatHintsValue;
+    children: default_2.ReactNode;
+}
+
+/**
+ * The value type for chat hints — a free-form key-value object
+ * that the host application can use to pass runtime information to the LLM.
+ * These hints are injected ephemerally into each chat message (not persisted)
+ * so the LLM is aware of the host application's current state.
+ */
+export declare type ChatHintsValue = Record<string, unknown>;
+
 export declare interface ChatInputContextValue {
     flowId: string | undefined;
     isLoading: boolean;
@@ -625,6 +665,12 @@ export declare const useCanvas: (canvasId: string | undefined | null, options?:
 
 export declare const useChatContext: () => ChatContextValue;
 
+/**
+ * Returns the current chat hints value, or `null` if no `ChatHintsProvider` is present.
+ * @returns The current chat hints value or null
+ */
+export declare const useChatHints: () => ChatHintsValue | null;
+
 export declare const useChatInputContext: () => ChatInputContextValue;
 
 export declare const useCreateFlow: (options?: UseMutationOptions<{