@tambo-ai/react 0.72.0 → 0.73.1

package/dist/v1/hooks/use-tambo-v1-suggestions.js

@@ -0,0 +1,152 @@
+"use strict";
+"use client";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTamboV1Suggestions = useTamboV1Suggestions;
+const react_1 = require("react");
+const tambo_client_provider_1 = require("../../providers/tambo-client-provider");
+const tambo_registry_provider_1 = require("../../providers/tambo-registry-provider");
+const registry_1 = require("../../util/registry");
+const react_query_hooks_1 = require("../../hooks/react-query-hooks");
+const query_utils_1 = require("../../util/query-utils");
+const use_tambo_v1_1 = require("./use-tambo-v1");
+const use_tambo_v1_thread_input_1 = require("./use-tambo-v1-thread-input");
+function normalizeSuggestionGenerateResponse(response) {
+    if (response === undefined) {
+        return [];
+    }
+    if (Array.isArray(response)) {
+        return response;
+    }
+    throw new Error("Unexpected suggestions.generate response shape; expected an array");
+}
+/**
+ * Hook for managing Tambo AI suggestions in a v1 thread.
+ *
+ * Automatically generates suggestions when the latest message is from the assistant
+ * and the thread is idle (not streaming).
+ *
+ * Uses the shared thread input context, so accepting a suggestion without submitting
+ * will automatically update the input field value for any component using
+ * useTamboV1ThreadInput.
+ * @param options - Configuration options for suggestion generation
+ * @returns Object containing suggestions state and control functions
+ * @example
+ * ```tsx
+ * function SuggestionsPanel() {
+ *   const { suggestions, accept, isPending } = useTamboV1Suggestions();
+ *
+ *   return (
+ *     <div>
+ *       {suggestions.map(suggestion => (
+ *         <button
+ *           key={suggestion.id}
+ *           onClick={() => accept({ suggestion })}
+ *           disabled={isPending}
+ *         >
+ *           {suggestion.suggestion}
+ *         </button>
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ *
+ * function ChatInput() {
+ *   // This input will automatically show the accepted suggestion
+ *   const { value, setValue, submit } = useTamboV1ThreadInput();
+ *   return <input value={value} onChange={e => setValue(e.target.value)} />;
+ * }
+ * ```
+ */
+function useTamboV1Suggestions(options = {}) {
+    const { maxSuggestions = 3 } = options;
+    // Use shared thread input context
+    const { setValue, submit, threadId } = (0, use_tambo_v1_thread_input_1.useTamboV1ThreadInput)();
+    const { messages, isIdle } = (0, use_tambo_v1_1.useTamboV1)(threadId);
+    const tamboClient = (0, tambo_client_provider_1.useTamboClient)();
+    const { componentList, toolRegistry, componentToolAssociations } = (0, tambo_registry_provider_1.useTamboRegistry)();
+    const [selectedSuggestionId, setSelectedSuggestionId] = (0, react_1.useState)(null);
+    const latestMessage = messages[messages.length - 1];
+    const isLatestFromAssistant = latestMessage?.role === "assistant";
+    const latestMessageId = latestMessage?.id;
+    // Reset selected suggestion when the message changes
+    (0, react_1.useEffect)(() => {
+        setSelectedSuggestionId(null);
+    }, [latestMessageId]);
+    const shouldGenerateSuggestions = latestMessageId && isLatestFromAssistant && isIdle && threadId;
+    // Use React Query to fetch suggestions when conditions are met
+    const suggestionsResult = (0, react_query_hooks_1.useTamboQuery)({
+        queryKey: [
+            "v1-suggestions",
+            shouldGenerateSuggestions ? latestMessageId : null,
+        ],
+        queryFn: async () => {
+            if (!shouldGenerateSuggestions || !threadId || !latestMessageId) {
+                return [];
+            }
+            // Get registered components from the registry
+            const components = (0, registry_1.getAvailableComponents)(componentList, toolRegistry, componentToolAssociations);
+            const response = await tamboClient.beta.threads.suggestions.generate(latestMessageId, {
+                id: threadId,
+                maxSuggestions,
+                availableComponents: components,
+            });
+            return normalizeSuggestionGenerateResponse(response);
+        },
+        enabled: Boolean(shouldGenerateSuggestions),
+        refetchOnWindowFocus: false,
+        refetchOnReconnect: false,
+        retry: false,
+    });
+    // Accept suggestion mutation
+    const acceptMutationState = (0, react_query_hooks_1.useTamboMutation)({
+        mutationFn: async ({ suggestion, shouldSubmit = false }) => {
+            const text = suggestion.detailedSuggestion?.trim();
+            if (!text) {
+                throw new Error("Suggestion has no detailed content");
+            }
+            if (shouldSubmit) {
+                // Set the value first, then submit
+                setValue(text);
+                await submit();
+            }
+            else {
+                // Just update the shared input value
+                setValue(text);
+            }
+            setSelectedSuggestionId(suggestion.id);
+        },
+    });
+    // Generate suggestions mutation (for manual refresh)
+    const generateMutationState = (0, react_query_hooks_1.useTamboMutation)({
+        mutationFn: async (abortController) => {
+            if (!shouldGenerateSuggestions || !threadId || !latestMessageId) {
+                return [];
+            }
+            const components = (0, registry_1.getAvailableComponents)(componentList, toolRegistry, componentToolAssociations);
+            const response = await tamboClient.beta.threads.suggestions.generate(latestMessageId, {
+                id: threadId,
+                maxSuggestions,
+                availableComponents: components,
+            }, { signal: abortController.signal });
+            return normalizeSuggestionGenerateResponse(response);
+        },
+        retry: false,
+    });
+    // Use query data if available, otherwise use mutation data
+    const suggestions = isLatestFromAssistant
+        ? (suggestionsResult.data ?? generateMutationState.data ?? [])
+        : [];
+    const accept = (0, react_1.useCallback)(async (acceptOptions) => {
+        await acceptMutationState.mutateAsync(acceptOptions);
+    }, [acceptMutationState]);
+    return {
+        suggestions,
+        accept,
+        selectedSuggestionId,
+        acceptResult: acceptMutationState,
+        generateResult: generateMutationState,
+        suggestionsResult,
+        ...(0, query_utils_1.combineMutationResults)(acceptMutationState, generateMutationState),
+    };
+}
+//# sourceMappingURL=use-tambo-v1-suggestions.js.map

package/dist/v1/hooks/use-tambo-v1-suggestions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-tambo-v1-suggestions.js","sourceRoot":"","sources":["../../../src/v1/hooks/use-tambo-v1-suggestions.ts"],"names":[],"mappings":";AAAA,YAAY,CAAC;;AAgJb,sDAgJC;AArRD,iCAAyD;AACzD,iFAAuE;AACvE,qFAA2E;AAC3E,kDAA6D;AAC7D,qEAKuC;AACvC,wDAGgC;AAChC,iDAA4C;AAC5C,2EAAoE;AAUpE,SAAS,mCAAmC,CAC1C,QAAiB;IAEjB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,QAAsC,CAAC;IAChD,CAAC;IAED,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;AACJ,CAAC;AAwDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,qBAAqB,CACnC,UAAwC,EAAE;IAE1C,MAAM,EAAE,cAAc,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;IAEvC,kCAAkC;IAClC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iDAAqB,GAAE,CAAC;IAE/D,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAA,yBAAU,EAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,IAAA,sCAAc,GAAE,CAAC;IACrC,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,yBAAyB,EAAE,GAC9D,IAAA,0CAAgB,GAAE,CAAC;IAErB,MAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,GAAG,IAAA,gBAAQ,EAE9D,IAAI,CAAC,CAAC;IAER,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpD,MAAM,qBAAqB,GAAG,aAAa,EAAE,IAAI,KAAK,WAAW,CAAC;IAClE,MAAM,eAAe,GAAG,aAAa,EAAE,EAAE,CAAC;IAE1C,qDAAqD;IACrD,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtB,MAAM,yBAAyB,GAC7B,eAAe,IAAI,qBAAqB,IAAI,MAAM,IAAI,QAAQ,CAAC;IAEjE,+DAA+D;IAC/D,MAAM,iBAAiB,GAAG,IAAA,iCAAa,EAA6B;QAClE,QAAQ,EAAE;YACR,gBAAgB;YAChB,yBAAyB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI;SACnD;QACD,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,IAAI,CAAC,yBAAyB,IAAI,CAAC,QAAQ,IAAI,CAAC,eAAe,EAAE,CAAC;gBAChE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,8CAA8C;YAC9C,MAAM,UAAU,GAAG,IAAA,iCAAsB,EACvC,aAAa,EACb,YAAY,EACZ,yBAAyB,CAC1B,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAClE,eAAe,EACf;gBACE,EAAE,EAAE,QAAQ;gBACZ,cAAc;gBACd,mBAAmB,EAAE,UAAU;aAChC,CACF,CAAC;YAEF,OAAO,mCAAmC,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,EAAE,OAAO,CAAC,yBAAyB,CAAC;QAC3C,oBAAoB,EAAE,KAAK;QAC3B,kBAAkB,EAAE,KAAK;QACzB,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,6BAA6B;IAC7B,MAAM,mBAAmB,GAAG,IAAA,oCAAgB,EAI1C;QACA,UAAU,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,YAAY,GAAG,KAAK,EAAE,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,UAAU,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACxD,CAAC;YAED,IAAI,YAAY,EAAE,CAAC;gBACjB,mCAAmC;gBACnC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACf,MAAM,MAAM,EAAE,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,qCAAqC;gBACrC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;YACD,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACzC,CAAC;KACF,CAAC,CAAC;IAEH,qDAAqD;IACrD,MAAM,qBAAqB,GAAG,IAAA,oCAAgB,EAI5C;QACA,UAAU,EAAE,KAAK,EAAE,eAAgC,EAAE,EAAE;YACrD,IAAI,CAAC,yBAAyB,IAAI,CAAC,QAAQ,IAAI,CAAC,eAAe,EAAE,CAAC;gBAChE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,UAAU,GAAG,IAAA,iCAAsB,EACvC,aAAa,EACb,YAAY,EACZ,yBAAyB,CAC1B,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAClE,eAAe,EACf;gBACE,EAAE,EAAE,QAAQ;gBACZ,cAAc;gBACd,mBAAmB,EAAE,UAAU;aAChC,EACD,EAAE,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,CACnC,CAAC;YAEF,OAAO,mCAAmC,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QACD,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,2DAA2D;IAC3D,MAAM,WAAW,GAAG,qBAAqB;QACvC,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,IAAI,qBAAqB,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9D,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,MAAM,GAAG,IAAA,mBAAW,EACxB,KAAK,EAAE,aAGN,EAAE,EAAE;QACH,MAAM,mBAAmB,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACvD,CAAC,EACD,CAAC,mBAAmB,CAAC,CACtB,CAAC;IAEF,OAAO;QACL,WAAW;QACX,MAAM;QACN,oBAAoB;QACpB,YAAY,EAAE,mBAAmB;QACjC,cAAc,EAAE,qBAAqB;QACrC,iBAAiB;QACjB,GAAG,IAAA,oCAAsB,EAAC,mBAAmB,EAAE,qBAAqB,CAAC;KACtE,CAAC;AACJ,CAAC","sourcesContent":["\"use client\";\n\n/**\n * useTamboV1Suggestions - Suggestions Hook for v1 API\n *\n * Provides AI-generated suggestions based on the current thread state.\n * Uses the shared thread input context so accepting a suggestion\n * automatically updates the input field.\n */\n\nimport TamboAI from \"@tambo-ai/typescript-sdk\";\nimport { useCallback, useEffect, useState } from \"react\";\nimport { useTamboClient } from \"../../providers/tambo-client-provider\";\nimport { useTamboRegistry } from \"../../providers/tambo-registry-provider\";\nimport { getAvailableComponents } from \"../../util/registry\";\nimport {\n  useTamboMutation,\n  useTamboQuery,\n  type UseTamboMutationResult,\n  type UseTamboQueryResult,\n} from \"../../hooks/react-query-hooks\";\nimport {\n  CombinedMutationResult,\n  combineMutationResults,\n} from \"../../util/query-utils\";\nimport { useTamboV1 } from \"./use-tambo-v1\";\nimport { useTamboV1ThreadInput } from \"./use-tambo-v1-thread-input\";\n\ntype Suggestion = TamboAI.Beta.Threads.Suggestion;\n\n// The SDK defines this as an alias of `Suggestion[]`.\ntype SuggestionGenerateResponse =\n  TamboAI.Beta.Threads.Suggestions.SuggestionGenerateResponse;\n\ntype SuggestionsMutationData = void | SuggestionGenerateResponse;\n\nfunction normalizeSuggestionGenerateResponse(\n  response: unknown,\n): SuggestionGenerateResponse {\n  if (response === undefined) {\n    return [];\n  }\n\n  if (Array.isArray(response)) {\n    return response as SuggestionGenerateResponse;\n  }\n\n  throw new Error(\n    \"Unexpected suggestions.generate response shape; expected an array\",\n  );\n}\n\n/**\n * Configuration options for the useTamboV1Suggestions hook\n */\nexport interface UseTamboV1SuggestionsOptions {\n  /** Maximum number of suggestions to generate (1-10, default 3) */\n  maxSuggestions?: number;\n}\n\n/**\n * Return value interface for useTamboV1Suggestions hook\n */\nexport interface UseTamboV1SuggestionsResultInternal {\n  /** List of available suggestions */\n  suggestions: Suggestion[];\n\n  /** ID of the currently selected suggestion */\n  selectedSuggestionId: string | null;\n\n  /**\n   * Accept and apply a suggestion.\n   * If shouldSubmit is false, updates the shared input context value.\n   * If shouldSubmit is true, submits the suggestion directly.\n   * @param suggestion - The suggestion to accept\n   * @param shouldSubmit - Whether to automatically submit after accepting (default: false)\n   */\n  accept: (acceptOptions: {\n    suggestion: Suggestion;\n    shouldSubmit?: boolean;\n  }) => Promise<void>;\n\n  /** Result and network state for accepting a suggestion */\n  acceptResult: UseTamboMutationResult<\n    void,\n    Error,\n    { suggestion: Suggestion; shouldSubmit?: boolean }\n  >;\n\n  /** Result and network state for generating suggestions */\n  generateResult: UseTamboMutationResult<\n    SuggestionGenerateResponse,\n    Error,\n    AbortController\n  >;\n\n  /** The full suggestions query object from React Query */\n  suggestionsResult: UseTamboQueryResult<SuggestionGenerateResponse>;\n}\n\ntype UseTamboV1SuggestionsResult = CombinedMutationResult<\n  SuggestionsMutationData,\n  Error\n> &\n  UseTamboV1SuggestionsResultInternal;\n\n/**\n * Hook for managing Tambo AI suggestions in a v1 thread.\n *\n * Automatically generates suggestions when the latest message is from the assistant\n * and the thread is idle (not streaming).\n *\n * Uses the shared thread input context, so accepting a suggestion without submitting\n * will automatically update the input field value for any component using\n * useTamboV1ThreadInput.\n * @param options - Configuration options for suggestion generation\n * @returns Object containing suggestions state and control functions\n * @example\n * ```tsx\n * function SuggestionsPanel() {\n *   const { suggestions, accept, isPending } = useTamboV1Suggestions();\n *\n *   return (\n *     <div>\n *       {suggestions.map(suggestion => (\n *         <button\n *           key={suggestion.id}\n *           onClick={() => accept({ suggestion })}\n *           disabled={isPending}\n *         >\n *           {suggestion.suggestion}\n *         </button>\n *       ))}\n *     </div>\n *   );\n * }\n *\n * function ChatInput() {\n *   // This input will automatically show the accepted suggestion\n *   const { value, setValue, submit } = useTamboV1ThreadInput();\n *   return <input value={value} onChange={e => setValue(e.target.value)} />;\n * }\n * ```\n */\nexport function useTamboV1Suggestions(\n  options: UseTamboV1SuggestionsOptions = {},\n): UseTamboV1SuggestionsResult {\n  const { maxSuggestions = 3 } = options;\n\n  // Use shared thread input context\n  const { setValue, submit, threadId } = useTamboV1ThreadInput();\n\n  const { messages, isIdle } = useTamboV1(threadId);\n  const tamboClient = useTamboClient();\n  const { componentList, toolRegistry, componentToolAssociations } =\n    useTamboRegistry();\n\n  const [selectedSuggestionId, setSelectedSuggestionId] = useState<\n    string | null\n  >(null);\n\n  const latestMessage = messages[messages.length - 1];\n  const isLatestFromAssistant = latestMessage?.role === \"assistant\";\n  const latestMessageId = latestMessage?.id;\n\n  // Reset selected suggestion when the message changes\n  useEffect(() => {\n    setSelectedSuggestionId(null);\n  }, [latestMessageId]);\n\n  const shouldGenerateSuggestions =\n    latestMessageId && isLatestFromAssistant && isIdle && threadId;\n\n  // Use React Query to fetch suggestions when conditions are met\n  const suggestionsResult = useTamboQuery<SuggestionGenerateResponse>({\n    queryKey: [\n      \"v1-suggestions\",\n      shouldGenerateSuggestions ? latestMessageId : null,\n    ],\n    queryFn: async () => {\n      if (!shouldGenerateSuggestions || !threadId || !latestMessageId) {\n        return [];\n      }\n\n      // Get registered components from the registry\n      const components = getAvailableComponents(\n        componentList,\n        toolRegistry,\n        componentToolAssociations,\n      );\n\n      const response = await tamboClient.beta.threads.suggestions.generate(\n        latestMessageId,\n        {\n          id: threadId,\n          maxSuggestions,\n          availableComponents: components,\n        },\n      );\n\n      return normalizeSuggestionGenerateResponse(response);\n    },\n    enabled: Boolean(shouldGenerateSuggestions),\n    refetchOnWindowFocus: false,\n    refetchOnReconnect: false,\n    retry: false,\n  });\n\n  // Accept suggestion mutation\n  const acceptMutationState = useTamboMutation<\n    void,\n    Error,\n    { suggestion: Suggestion; shouldSubmit?: boolean }\n  >({\n    mutationFn: async ({ suggestion, shouldSubmit = false }) => {\n      const text = suggestion.detailedSuggestion?.trim();\n      if (!text) {\n        throw new Error(\"Suggestion has no detailed content\");\n      }\n\n      if (shouldSubmit) {\n        // Set the value first, then submit\n        setValue(text);\n        await submit();\n      } else {\n        // Just update the shared input value\n        setValue(text);\n      }\n      setSelectedSuggestionId(suggestion.id);\n    },\n  });\n\n  // Generate suggestions mutation (for manual refresh)\n  const generateMutationState = useTamboMutation<\n    SuggestionGenerateResponse,\n    Error,\n    AbortController\n  >({\n    mutationFn: async (abortController: AbortController) => {\n      if (!shouldGenerateSuggestions || !threadId || !latestMessageId) {\n        return [];\n      }\n\n      const components = getAvailableComponents(\n        componentList,\n        toolRegistry,\n        componentToolAssociations,\n      );\n\n      const response = await tamboClient.beta.threads.suggestions.generate(\n        latestMessageId,\n        {\n          id: threadId,\n          maxSuggestions,\n          availableComponents: components,\n        },\n        { signal: abortController.signal },\n      );\n\n      return normalizeSuggestionGenerateResponse(response);\n    },\n    retry: false,\n  });\n\n  // Use query data if available, otherwise use mutation data\n  const suggestions = isLatestFromAssistant\n    ? (suggestionsResult.data ?? generateMutationState.data ?? [])\n    : [];\n\n  const accept = useCallback(\n    async (acceptOptions: {\n      suggestion: Suggestion;\n      shouldSubmit?: boolean;\n    }) => {\n      await acceptMutationState.mutateAsync(acceptOptions);\n    },\n    [acceptMutationState],\n  );\n\n  return {\n    suggestions,\n    accept,\n    selectedSuggestionId,\n    acceptResult: acceptMutationState,\n    generateResult: generateMutationState,\n    suggestionsResult,\n    ...combineMutationResults(acceptMutationState, generateMutationState),\n  };\n}\n"]}

package/dist/v1/hooks/use-tambo-v1-suggestions.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=use-tambo-v1-suggestions.test.d.ts.map

package/dist/v1/hooks/use-tambo-v1-suggestions.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-tambo-v1-suggestions.test.d.ts","sourceRoot":"","sources":["../../../src/v1/hooks/use-tambo-v1-suggestions.test.tsx"],"names":[],"mappings":""}