@tambo-ai/react 0.68.0 → 0.69.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/context-helpers/context-helpers.test.js +16 -4
- package/dist/context-helpers/context-helpers.test.js.map +1 -1
- package/dist/context-helpers/current-interactables-context-helper.d.ts +2 -2
- package/dist/context-helpers/current-interactables-context-helper.d.ts.map +1 -1
- package/dist/context-helpers/current-interactables-context-helper.js +31 -15
- package/dist/context-helpers/current-interactables-context-helper.js.map +1 -1
- package/dist/context-helpers/registry.d.ts +2 -2
- package/dist/context-helpers/registry.d.ts.map +1 -1
- package/dist/context-helpers/registry.js.map +1 -1
- package/dist/context-helpers/types.d.ts +2 -2
- package/dist/context-helpers/types.d.ts.map +1 -1
- package/dist/context-helpers/types.js.map +1 -1
- package/dist/hooks/use-message-images.test.js +174 -37
- package/dist/hooks/use-message-images.test.js.map +1 -1
- package/dist/hooks/use-tambo-voice.d.ts +1 -1
- package/dist/hooks/use-tambo-voice.js +1 -1
- package/dist/hooks/use-tambo-voice.js.map +1 -1
- package/dist/hooks/use-tambo-voice.test.d.ts +2 -0
- package/dist/hooks/use-tambo-voice.test.d.ts.map +1 -0
- package/dist/hooks/use-tambo-voice.test.js +239 -0
- package/dist/hooks/use-tambo-voice.test.js.map +1 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp/elicitation.d.ts.map +1 -1
- package/dist/mcp/elicitation.js +12 -0
- package/dist/mcp/elicitation.js.map +1 -1
- package/dist/mcp/elicitation.test.js +8 -1
- package/dist/mcp/elicitation.test.js.map +1 -1
- package/dist/mcp/mcp-client.d.ts +6 -10
- package/dist/mcp/mcp-client.d.ts.map +1 -1
- package/dist/mcp/mcp-client.js.map +1 -1
- package/dist/mcp/mcp-hooks.d.ts +12 -60
- package/dist/mcp/mcp-hooks.d.ts.map +1 -1
- package/dist/mcp/mcp-hooks.js +90 -10
- package/dist/mcp/mcp-hooks.js.map +1 -1
- package/dist/mcp/mcp-hooks.test.js +423 -0
- package/dist/mcp/mcp-hooks.test.js.map +1 -1
- package/dist/mcp/tambo-mcp-provider.d.ts.map +1 -1
- package/dist/mcp/tambo-mcp-provider.js +3 -0
- package/dist/mcp/tambo-mcp-provider.js.map +1 -1
- package/dist/mcp/tambo-mcp-provider.test.js +37 -0
- package/dist/mcp/tambo-mcp-provider.test.js.map +1 -1
- package/dist/model/component-metadata.d.ts +53 -20
- package/dist/model/component-metadata.d.ts.map +1 -1
- package/dist/model/component-metadata.js.map +1 -1
- package/dist/model/tambo-interactable.d.ts +6 -0
- package/dist/model/tambo-interactable.d.ts.map +1 -1
- package/dist/model/tambo-interactable.js.map +1 -1
- package/dist/providers/index.d.ts +1 -1
- package/dist/providers/index.d.ts.map +1 -1
- package/dist/providers/index.js.map +1 -1
- package/dist/providers/tambo-client-provider.d.ts +8 -0
- package/dist/providers/tambo-client-provider.d.ts.map +1 -1
- package/dist/providers/tambo-client-provider.js +10 -11
- package/dist/providers/tambo-client-provider.js.map +1 -1
- package/dist/providers/tambo-client-provider.test.d.ts +2 -0
- package/dist/providers/tambo-client-provider.test.d.ts.map +1 -0
- package/dist/providers/tambo-client-provider.test.js +208 -0
- package/dist/providers/tambo-client-provider.test.js.map +1 -0
- package/dist/providers/tambo-context-attachment-provider.d.ts +34 -92
- package/dist/providers/tambo-context-attachment-provider.d.ts.map +1 -1
- package/dist/providers/tambo-context-attachment-provider.js +62 -105
- package/dist/providers/tambo-context-attachment-provider.js.map +1 -1
- package/dist/providers/tambo-context-attachment-provider.test.js +229 -463
- package/dist/providers/tambo-context-attachment-provider.test.js.map +1 -1
- package/dist/providers/tambo-interactable-provider.d.ts +2 -0
- package/dist/providers/tambo-interactable-provider.d.ts.map +1 -1
- package/dist/providers/tambo-interactable-provider.js +29 -4
- package/dist/providers/tambo-interactable-provider.js.map +1 -1
- package/dist/providers/tambo-interactable-provider.test.js +1 -1
- package/dist/providers/tambo-interactable-provider.test.js.map +1 -1
- package/dist/providers/tambo-interactables-additional-context.test.js +2 -5
- package/dist/providers/tambo-interactables-additional-context.test.js.map +1 -1
- package/dist/providers/tambo-provider.d.ts +2 -3
- package/dist/providers/tambo-provider.d.ts.map +1 -1
- package/dist/providers/tambo-provider.js +5 -6
- package/dist/providers/tambo-provider.js.map +1 -1
- package/dist/providers/tambo-registry-provider.test.js +16 -0
- package/dist/providers/tambo-registry-provider.test.js.map +1 -1
- package/dist/providers/tambo-registry-schema-compat.test.js +31 -0
- package/dist/providers/tambo-registry-schema-compat.test.js.map +1 -1
- package/dist/providers/tambo-thread-input-provider.d.ts +1 -1
- package/dist/providers/tambo-thread-input-provider.d.ts.map +1 -1
- package/dist/providers/tambo-thread-input-provider.js +5 -1
- package/dist/providers/tambo-thread-input-provider.js.map +1 -1
- package/dist/providers/tambo-thread-provider-initial-messages.test.js +84 -2
- package/dist/providers/tambo-thread-provider-initial-messages.test.js.map +1 -1
- package/dist/providers/tambo-thread-provider.d.ts.map +1 -1
- package/dist/providers/tambo-thread-provider.js +53 -42
- package/dist/providers/tambo-thread-provider.js.map +1 -1
- package/dist/providers/tambo-thread-provider.test.js +368 -262
- package/dist/providers/tambo-thread-provider.test.js.map +1 -1
- package/dist/schema/json-schema.js +29 -29
- package/dist/schema/json-schema.js.map +1 -1
- package/dist/schema/schema.test.js +237 -0
- package/dist/schema/schema.test.js.map +1 -1
- package/dist/schema/standard-schema.d.ts +1 -0
- package/dist/schema/standard-schema.d.ts.map +1 -1
- package/dist/schema/standard-schema.js +18 -13
- package/dist/schema/standard-schema.js.map +1 -1
- package/dist/schema/standard-schema.test.d.ts +2 -0
- package/dist/schema/standard-schema.test.d.ts.map +1 -0
- package/dist/schema/standard-schema.test.js +165 -0
- package/dist/schema/standard-schema.test.js.map +1 -0
- package/dist/schema/validate.test.js +149 -0
- package/dist/schema/validate.test.js.map +1 -1
- package/dist/schema/zod.d.ts +7 -4
- package/dist/schema/zod.d.ts.map +1 -1
- package/dist/schema/zod.js +65 -22
- package/dist/schema/zod.js.map +1 -1
- package/dist/schema/zod.test.js +112 -0
- package/dist/schema/zod.test.js.map +1 -1
- package/dist/testing/tools.d.ts +4 -1
- package/dist/testing/tools.d.ts.map +1 -1
- package/dist/testing/tools.js +6 -1
- package/dist/testing/tools.js.map +1 -1
- package/dist/util/generate-component.d.ts.map +1 -1
- package/dist/util/generate-component.js +18 -3
- package/dist/util/generate-component.js.map +1 -1
- package/dist/util/generate-component.test.d.ts +2 -0
- package/dist/util/generate-component.test.d.ts.map +1 -0
- package/dist/util/generate-component.test.js +340 -0
- package/dist/util/generate-component.test.js.map +1 -0
- package/dist/util/is-promise.d.ts +9 -0
- package/dist/util/is-promise.d.ts.map +1 -0
- package/dist/util/is-promise.js +20 -0
- package/dist/util/is-promise.js.map +1 -0
- package/dist/util/is-promise.test.d.ts +2 -0
- package/dist/util/is-promise.test.d.ts.map +1 -0
- package/dist/util/is-promise.test.js +48 -0
- package/dist/util/is-promise.test.js.map +1 -0
- package/dist/util/query-utils.test.d.ts +2 -0
- package/dist/util/query-utils.test.d.ts.map +1 -0
- package/dist/util/query-utils.test.js +382 -0
- package/dist/util/query-utils.test.js.map +1 -0
- package/dist/util/registry-validators.d.ts.map +1 -1
- package/dist/util/registry-validators.js +7 -0
- package/dist/util/registry-validators.js.map +1 -1
- package/dist/util/registry-validators.test.js +57 -0
- package/dist/util/registry-validators.test.js.map +1 -1
- package/dist/util/registry.d.ts.map +1 -1
- package/dist/util/registry.js +9 -0
- package/dist/util/registry.js.map +1 -1
- package/dist/util/registry.test.js +323 -1
- package/dist/util/registry.test.js.map +1 -1
- package/dist/util/resource-validators.test.d.ts +2 -0
- package/dist/util/resource-validators.test.d.ts.map +1 -0
- package/dist/util/resource-validators.test.js +90 -0
- package/dist/util/resource-validators.test.js.map +1 -0
- package/dist/util/tool-caller.d.ts +2 -2
- package/dist/util/tool-caller.d.ts.map +1 -1
- package/dist/util/tool-caller.js +8 -8
- package/dist/util/tool-caller.js.map +1 -1
- package/dist/util/validate-component-name.test.d.ts +2 -0
- package/dist/util/validate-component-name.test.d.ts.map +1 -0
- package/dist/util/validate-component-name.test.js +35 -0
- package/dist/util/validate-component-name.test.js.map +1 -0
- package/esm/context-helpers/context-helpers.test.js +16 -4
- package/esm/context-helpers/context-helpers.test.js.map +1 -1
- package/esm/context-helpers/current-interactables-context-helper.d.ts +2 -2
- package/esm/context-helpers/current-interactables-context-helper.d.ts.map +1 -1
- package/esm/context-helpers/current-interactables-context-helper.js +31 -15
- package/esm/context-helpers/current-interactables-context-helper.js.map +1 -1
- package/esm/context-helpers/registry.d.ts +2 -2
- package/esm/context-helpers/registry.d.ts.map +1 -1
- package/esm/context-helpers/registry.js.map +1 -1
- package/esm/context-helpers/types.d.ts +2 -2
- package/esm/context-helpers/types.d.ts.map +1 -1
- package/esm/context-helpers/types.js.map +1 -1
- package/esm/hooks/use-message-images.test.js +174 -37
- package/esm/hooks/use-message-images.test.js.map +1 -1
- package/esm/hooks/use-tambo-voice.d.ts +1 -1
- package/esm/hooks/use-tambo-voice.js +1 -1
- package/esm/hooks/use-tambo-voice.js.map +1 -1
- package/esm/hooks/use-tambo-voice.test.d.ts +2 -0
- package/esm/hooks/use-tambo-voice.test.d.ts.map +1 -0
- package/esm/hooks/use-tambo-voice.test.js +234 -0
- package/esm/hooks/use-tambo-voice.test.js.map +1 -0
- package/esm/index.d.ts +2 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/esm/mcp/elicitation.d.ts.map +1 -1
- package/esm/mcp/elicitation.js +12 -0
- package/esm/mcp/elicitation.js.map +1 -1
- package/esm/mcp/elicitation.test.js +8 -1
- package/esm/mcp/elicitation.test.js.map +1 -1
- package/esm/mcp/mcp-client.d.ts +6 -10
- package/esm/mcp/mcp-client.d.ts.map +1 -1
- package/esm/mcp/mcp-client.js.map +1 -1
- package/esm/mcp/mcp-hooks.d.ts +12 -60
- package/esm/mcp/mcp-hooks.d.ts.map +1 -1
- package/esm/mcp/mcp-hooks.js +57 -10
- package/esm/mcp/mcp-hooks.js.map +1 -1
- package/esm/mcp/mcp-hooks.test.js +423 -0
- package/esm/mcp/mcp-hooks.test.js.map +1 -1
- package/esm/mcp/tambo-mcp-provider.d.ts.map +1 -1
- package/esm/mcp/tambo-mcp-provider.js +3 -0
- package/esm/mcp/tambo-mcp-provider.js.map +1 -1
- package/esm/mcp/tambo-mcp-provider.test.js +37 -0
- package/esm/mcp/tambo-mcp-provider.test.js.map +1 -1
- package/esm/model/component-metadata.d.ts +53 -20
- package/esm/model/component-metadata.d.ts.map +1 -1
- package/esm/model/component-metadata.js.map +1 -1
- package/esm/model/tambo-interactable.d.ts +6 -0
- package/esm/model/tambo-interactable.d.ts.map +1 -1
- package/esm/model/tambo-interactable.js.map +1 -1
- package/esm/providers/index.d.ts +1 -1
- package/esm/providers/index.d.ts.map +1 -1
- package/esm/providers/index.js.map +1 -1
- package/esm/providers/tambo-client-provider.d.ts +8 -0
- package/esm/providers/tambo-client-provider.d.ts.map +1 -1
- package/esm/providers/tambo-client-provider.js +11 -12
- package/esm/providers/tambo-client-provider.js.map +1 -1
- package/esm/providers/tambo-client-provider.test.d.ts +2 -0
- package/esm/providers/tambo-client-provider.test.d.ts.map +1 -0
- package/esm/providers/tambo-client-provider.test.js +203 -0
- package/esm/providers/tambo-client-provider.test.js.map +1 -0
- package/esm/providers/tambo-context-attachment-provider.d.ts +34 -92
- package/esm/providers/tambo-context-attachment-provider.d.ts.map +1 -1
- package/esm/providers/tambo-context-attachment-provider.js +63 -106
- package/esm/providers/tambo-context-attachment-provider.js.map +1 -1
- package/esm/providers/tambo-context-attachment-provider.test.js +230 -464
- package/esm/providers/tambo-context-attachment-provider.test.js.map +1 -1
- package/esm/providers/tambo-interactable-provider.d.ts +2 -0
- package/esm/providers/tambo-interactable-provider.d.ts.map +1 -1
- package/esm/providers/tambo-interactable-provider.js +29 -4
- package/esm/providers/tambo-interactable-provider.js.map +1 -1
- package/esm/providers/tambo-interactable-provider.test.js +1 -1
- package/esm/providers/tambo-interactable-provider.test.js.map +1 -1
- package/esm/providers/tambo-interactables-additional-context.test.js +2 -5
- package/esm/providers/tambo-interactables-additional-context.test.js.map +1 -1
- package/esm/providers/tambo-provider.d.ts +2 -3
- package/esm/providers/tambo-provider.d.ts.map +1 -1
- package/esm/providers/tambo-provider.js +5 -6
- package/esm/providers/tambo-provider.js.map +1 -1
- package/esm/providers/tambo-registry-provider.test.js +16 -0
- package/esm/providers/tambo-registry-provider.test.js.map +1 -1
- package/esm/providers/tambo-registry-schema-compat.test.js +31 -0
- package/esm/providers/tambo-registry-schema-compat.test.js.map +1 -1
- package/esm/providers/tambo-thread-input-provider.d.ts +1 -1
- package/esm/providers/tambo-thread-input-provider.d.ts.map +1 -1
- package/esm/providers/tambo-thread-input-provider.js +5 -1
- package/esm/providers/tambo-thread-input-provider.js.map +1 -1
- package/esm/providers/tambo-thread-provider-initial-messages.test.js +84 -2
- package/esm/providers/tambo-thread-provider-initial-messages.test.js.map +1 -1
- package/esm/providers/tambo-thread-provider.d.ts.map +1 -1
- package/esm/providers/tambo-thread-provider.js +53 -42
- package/esm/providers/tambo-thread-provider.js.map +1 -1
- package/esm/providers/tambo-thread-provider.test.js +368 -262
- package/esm/providers/tambo-thread-provider.test.js.map +1 -1
- package/esm/schema/json-schema.js +1 -1
- package/esm/schema/json-schema.js.map +1 -1
- package/esm/schema/schema.test.js +238 -1
- package/esm/schema/schema.test.js.map +1 -1
- package/esm/schema/standard-schema.d.ts +1 -0
- package/esm/schema/standard-schema.d.ts.map +1 -1
- package/esm/schema/standard-schema.js +18 -13
- package/esm/schema/standard-schema.js.map +1 -1
- package/esm/schema/standard-schema.test.d.ts +2 -0
- package/esm/schema/standard-schema.test.d.ts.map +1 -0
- package/esm/schema/standard-schema.test.js +130 -0
- package/esm/schema/standard-schema.test.js.map +1 -0
- package/esm/schema/validate.test.js +149 -0
- package/esm/schema/validate.test.js.map +1 -1
- package/esm/schema/zod.d.ts +7 -4
- package/esm/schema/zod.d.ts.map +1 -1
- package/esm/schema/zod.js +65 -22
- package/esm/schema/zod.js.map +1 -1
- package/esm/schema/zod.test.js +113 -1
- package/esm/schema/zod.test.js.map +1 -1
- package/esm/testing/tools.d.ts +4 -1
- package/esm/testing/tools.d.ts.map +1 -1
- package/esm/testing/tools.js +6 -1
- package/esm/testing/tools.js.map +1 -1
- package/esm/util/generate-component.d.ts.map +1 -1
- package/esm/util/generate-component.js +18 -3
- package/esm/util/generate-component.js.map +1 -1
- package/esm/util/generate-component.test.d.ts +2 -0
- package/esm/util/generate-component.test.d.ts.map +1 -0
- package/esm/util/generate-component.test.js +302 -0
- package/esm/util/generate-component.test.js.map +1 -0
- package/esm/util/is-promise.d.ts +9 -0
- package/esm/util/is-promise.d.ts.map +1 -0
- package/esm/util/is-promise.js +17 -0
- package/esm/util/is-promise.js.map +1 -0
- package/esm/util/is-promise.test.d.ts +2 -0
- package/esm/util/is-promise.test.d.ts.map +1 -0
- package/esm/util/is-promise.test.js +46 -0
- package/esm/util/is-promise.test.js.map +1 -0
- package/esm/util/query-utils.test.d.ts +2 -0
- package/esm/util/query-utils.test.d.ts.map +1 -0
- package/esm/util/query-utils.test.js +380 -0
- package/esm/util/query-utils.test.js.map +1 -0
- package/esm/util/registry-validators.d.ts.map +1 -1
- package/esm/util/registry-validators.js +7 -0
- package/esm/util/registry-validators.js.map +1 -1
- package/esm/util/registry-validators.test.js +57 -0
- package/esm/util/registry-validators.test.js.map +1 -1
- package/esm/util/registry.d.ts.map +1 -1
- package/esm/util/registry.js +9 -0
- package/esm/util/registry.js.map +1 -1
- package/esm/util/registry.test.js +324 -2
- package/esm/util/registry.test.js.map +1 -1
- package/esm/util/resource-validators.test.d.ts +2 -0
- package/esm/util/resource-validators.test.d.ts.map +1 -0
- package/esm/util/resource-validators.test.js +88 -0
- package/esm/util/resource-validators.test.js.map +1 -0
- package/esm/util/tool-caller.d.ts +2 -2
- package/esm/util/tool-caller.d.ts.map +1 -1
- package/esm/util/tool-caller.js +8 -8
- package/esm/util/tool-caller.js.map +1 -1
- package/esm/util/validate-component-name.test.d.ts +2 -0
- package/esm/util/validate-component-name.test.d.ts.map +1 -0
- package/esm/util/validate-component-name.test.js +33 -0
- package/esm/util/validate-component-name.test.js.map +1 -0
- package/package.json +15 -23
- package/dist/schema/alias.d.ts +0 -3
- package/dist/schema/alias.d.ts.map +0 -1
- package/dist/schema/alias.js +0 -6
- package/dist/schema/alias.js.map +0 -1
- package/esm/schema/alias.d.ts +0 -3
- package/esm/schema/alias.d.ts.map +0 -1
- package/esm/schema/alias.js +0 -13
- package/esm/schema/alias.js.map +0 -1
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ToolAnnotations as MCPToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
|
|
1
2
|
import type { StandardSchemaV1 } from "@standard-schema/spec";
|
|
2
3
|
import TamboAI from "@tambo-ai/typescript-sdk";
|
|
3
4
|
import { JSONSchema7 } from "json-schema";
|
|
@@ -14,6 +15,20 @@ import { $ZodFunction as Zod4Function, $ZodFunctionArgs as Zod4FunctionArgs, $Zo
|
|
|
14
15
|
* @see https://standardschema.dev/
|
|
15
16
|
*/
|
|
16
17
|
export type SupportedSchema<Shape = unknown> = StandardSchemaV1<Shape, Shape> | JSONSchema7;
|
|
18
|
+
/**
|
|
19
|
+
* Annotations describing a tool's behavior, aligned with the MCP (Model Context Protocol)
|
|
20
|
+
* specification. These hints help clients understand how tools behave and can be used
|
|
21
|
+
* to optimize tool execution strategies.
|
|
22
|
+
* @see https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations
|
|
23
|
+
*/
|
|
24
|
+
export type ToolAnnotations = MCPToolAnnotations & {
|
|
25
|
+
/**
|
|
26
|
+
* Indicates that the tool is safe to be called repeatedly while a response is
|
|
27
|
+
* being streamed. This is typically used for read-only tools that do not
|
|
28
|
+
* cause side effects.
|
|
29
|
+
*/
|
|
30
|
+
tamboStreamableHint?: boolean;
|
|
31
|
+
};
|
|
17
32
|
/** Extension of the ToolParameters interface from Tambo AI to include JSONSchema definition */
|
|
18
33
|
export type ParameterSpec = TamboAI.ToolParameters & {
|
|
19
34
|
schema?: JSONSchema7;
|
|
@@ -24,6 +39,18 @@ export type ParameterSpec = TamboAI.ToolParameters & {
|
|
|
24
39
|
*/
|
|
25
40
|
export interface ComponentContextToolMetadata extends TamboAI.ComponentContextToolMetadata {
|
|
26
41
|
parameters: ParameterSpec[];
|
|
42
|
+
/**
|
|
43
|
+
* Optional per-tool call limit. When set, this overrides the project's
|
|
44
|
+
* global tool call limit for this specific tool.
|
|
45
|
+
*
|
|
46
|
+
* This is useful for tools that should only be called once or twice
|
|
47
|
+
* regardless of the project's global limit.
|
|
48
|
+
*/
|
|
49
|
+
maxCalls?: number;
|
|
50
|
+
/**
|
|
51
|
+
* Annotations describing the tool's behavior. See {@link ToolAnnotations}.
|
|
52
|
+
*/
|
|
53
|
+
annotations?: ToolAnnotations;
|
|
27
54
|
}
|
|
28
55
|
export interface ComponentContextTool {
|
|
29
56
|
getComponentContext: (...args: any[]) => Promise<any>;
|
|
@@ -104,27 +131,31 @@ export interface TamboTool<Params = any, Returns = any, Rest extends any[] = []>
|
|
|
104
131
|
*/
|
|
105
132
|
title?: string;
|
|
106
133
|
/**
|
|
107
|
-
* Optional
|
|
134
|
+
* Optional limit for how many times this tool may be called while
|
|
135
|
+
* generating a single response. If present, this value overrides the
|
|
136
|
+
* project's global `maxToolCallLimit` for this tool.
|
|
137
|
+
* @example 1
|
|
138
|
+
*/
|
|
139
|
+
maxCalls?: number;
|
|
140
|
+
/**
|
|
141
|
+
* Annotations describing the tool's behavior, aligned with the MCP specification.
|
|
142
|
+
* Use `tamboStreamableHint: true` to enable streaming execution of partial tool calls.
|
|
143
|
+
* @see {@link ToolAnnotations}
|
|
144
|
+
* @example
|
|
145
|
+
* ```ts
|
|
146
|
+
* const setTextTool: TamboTool<{ text: string }> = {
|
|
147
|
+
* name: "set_text",
|
|
148
|
+
* description: "Set the displayed text",
|
|
149
|
+
* annotations: {
|
|
150
|
+
* tamboStreamableHint: true, // tool is safe for streaming calls
|
|
151
|
+
* },
|
|
152
|
+
* tool: ({ text }) => setText(text),
|
|
153
|
+
* inputSchema: z.object({ text: z.string() }),
|
|
154
|
+
* outputSchema: z.void(),
|
|
155
|
+
* };
|
|
156
|
+
* ```
|
|
108
157
|
*/
|
|
109
|
-
annotations?:
|
|
110
|
-
/**
|
|
111
|
-
* An array indicating the intended audience(s) for this resource. Valid
|
|
112
|
-
* values are "user" and "assistant". For example, ["user", "assistant"]
|
|
113
|
-
* indicates content useful for both.
|
|
114
|
-
*/
|
|
115
|
-
audience: ("user" | "assistant")[];
|
|
116
|
-
/**
|
|
117
|
-
* A number from 0.0 to 1.0 indicating the importance of this resource. A
|
|
118
|
-
* value of 1 means "most important" (effectively required), while 0 means
|
|
119
|
-
* "least important" (entirely optional).
|
|
120
|
-
*/
|
|
121
|
-
priority: number;
|
|
122
|
-
/**
|
|
123
|
-
* An ISO 8601 formatted timestamp indicating when the resource was last
|
|
124
|
-
* modified (e.g., "2025-01-12T15:00:58Z").
|
|
125
|
-
*/
|
|
126
|
-
lastModified: string;
|
|
127
|
-
};
|
|
158
|
+
annotations?: ToolAnnotations;
|
|
128
159
|
/**
|
|
129
160
|
* The function that implements the tool's logic. This function will be called
|
|
130
161
|
* by Tambo when the model decides to invoke the tool.
|
|
@@ -318,6 +349,8 @@ export interface TamboComponent {
|
|
|
318
349
|
loadingComponent?: ComponentType<any>;
|
|
319
350
|
/** The tools that are associated with the component */
|
|
320
351
|
associatedTools?: (TamboTool | TamboToolWithToolSchema)[];
|
|
352
|
+
/** Annotations describing the component's behavior. */
|
|
353
|
+
annotations?: ToolAnnotations;
|
|
321
354
|
}
|
|
322
355
|
export interface RegisterToolsFn {
|
|
323
356
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component-metadata.d.ts","sourceRoot":"","sources":["../../src/model/component-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,OAAO,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EACL,WAAW,IAAI,YAAY,EAC3B,QAAQ,IAAI,gBAAgB,EAC5B,OAAO,IAAI,mBAAmB,EAC9B,KAAK,IAAI,SAAS,EACnB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,gBAAgB,IAAI,gBAAgB,EACpC,QAAQ,IAAI,mBAAmB,EAC/B,KAAK,IAAI,SAAS,EACnB,MAAM,aAAa,CAAC;AAErB;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IACvC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,GAC9B,WAAW,CAAC;AAEhB,+FAA+F;AAC/F,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,cAAc,GAAG;IACnD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,4BACf,SAAQ,OAAO,CAAC,4BAA4B;IAC5C,UAAU,EAAE,aAAa,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"component-metadata.d.ts","sourceRoot":"","sources":["../../src/model/component-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,IAAI,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAChG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,OAAO,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EACL,WAAW,IAAI,YAAY,EAC3B,QAAQ,IAAI,gBAAgB,EAC5B,OAAO,IAAI,mBAAmB,EAC9B,KAAK,IAAI,SAAS,EACnB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,gBAAgB,IAAI,gBAAgB,EACpC,QAAQ,IAAI,mBAAmB,EAC/B,KAAK,IAAI,SAAS,EACnB,MAAM,aAAa,CAAC;AAErB;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IACvC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,GAC9B,WAAW,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG;IACjD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,+FAA+F;AAC/F,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,cAAc,GAAG;IACnD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,4BACf,SAAQ,OAAO,CAAC,4BAA4B;IAC5C,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,mBAAmB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACtD,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,kBAAkB;IACrE,SAAS,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAC9B,gBAAgB,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEpE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CACpC,MAAM,EACN,SAAS,GAAG,uBAAuB,CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,WAAW,SAAS,CACxB,MAAM,GAAG,GAAG,EACZ,OAAO,GAAG,GAAG,EACb,IAAI,SAAS,GAAG,EAAE,GAAG,EAAE;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;;;;;;;OAQG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,WAAW,EAAE,eAAe,GAAG,OAAO,CAAC;IAEvC;;;;;;OAMG;IACH,YAAY,EAAE,eAAe,GAAG,OAAO,CAAC;IAExC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,CACnB,MAAM,EAAE,GAAG,KAET,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC,GACzD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC;CACtD;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CACjC,IAAI,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EAC1B,OAAO,GAAG,GAAG,IACX,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC,GAAG;IAC7D,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,uEAAuE;IACvE,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAGF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,IACjD,uBAAuB,GACvB,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAC7B,IAAI,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,EAClC,OAAO,GAAG,OAAO,IACf,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC,GAAG;IAC5E,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,WAAW,EAAE,cAAc,CAAC;IAC5B,YAAY,EAAE,cAAc,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,SAAS,EACT,MAAM,GAAG,aAAa,GAAG,cAAc,CACxC,GAAG;IACF,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;IAClD,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CACjC,KAAK,SAAS,gBAAgB,GAAG,gBAAgB,EACjD,MAAM,SAAS,gBAAgB,GAAG,gBAAgB,IAChD,IAAI,CACN,SAAS,CACP,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,EACnC,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,CACrC,EACD,MAAM,GAAG,aAAa,GAAG,cAAc,CACxC,GAAG;IACF,IAAI,EAAE,CACJ,GAAG,IAAI,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,KAC3C,UAAU,CAAC,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,WAAW,EAAE,KAAK,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,qBAAqB,CACxB,IAAI,SAAS,gBAAgB,EAC7B,OAAO,SAAS,mBAAmB,IACjC,IAAI,CACN,uBAAuB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,EAC5D,YAAY,CACb,GAAG;IACF,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,uEAAuE;IACvE,UAAU,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;CACzC,CAAC;AAEF,KAAK,qBAAqB,CACxB,IAAI,SAAS,gBAAgB,EAC7B,OAAO,SAAS,mBAAmB,IACjC,IAAI,CACN,uBAAuB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,EAC5D,YAAY,CACb,GAAG;IACF,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,uEAAuE;IACvE,UAAU,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC7D;;GAEG;AAEH,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;;;OAIG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IACtC,uDAAuD;IACvD,eAAe,CAAC,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,CAAC;IAC1D,uDAAuD;IACvD,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC3B,CAAC,KAAK,EAAE,CAAC,SAAS,GAAG,uBAAuB,CAAC,EAAE,GAAG,IAAI,CAAC;CACxD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,SAAS,gBAAgB,EAAE,OAAO,SAAS,mBAAmB,EACjE,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,EAC1C,eAAe,CAAC,EAAE,OAAO,GACxB,IAAI,CAAC;IACR;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,SAAS,gBAAgB,EAAE,OAAO,SAAS,mBAAmB,EACjE,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,EAC1C,eAAe,CAAC,EAAE,OAAO,GACxB,IAAI,CAAC;IACR,CAAC,IAAI,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjE,CAAC,IAAI,SAAS,gBAAgB,EAAE,OAAO,SAAS,gBAAgB,EAC9D,IAAI,EAAE,uBAAuB,CAAC,IAAI,EAAE,OAAO,CAAC,EAC5C,eAAe,CAAC,EAAE,OAAO,GACxB,IAAI,CAAC;IACR,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,OAAO,GAAG,GAAG,EAChC,IAAI,EAAE,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,EACxC,eAAe,CAAC,EAAE,OAAO,GACxB,IAAI,CAAC;IACR,CAAC,IAAI,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1D,CAAC,IAAI,EAAE,SAAS,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,KAAK,SAAS,gBAAgB,EAAE,MAAM,SAAS,gBAAgB,EAC9D,IAAI,EAAE,uBAAuB,CAAC,KAAK,EAAE,MAAM,CAAC,GAC3C,uBAAuB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,CAAC,IAAI,SAAS,gBAAgB,EAAE,OAAO,SAAS,mBAAmB,EACjE,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,GACzC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,IAAI,SAAS,gBAAgB,EAAE,OAAO,SAAS,mBAAmB,EACjE,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,GACzC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,IAAI,EAAE,uBAAuB,GAAG,uBAAuB,CAAC;IACzD;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,EACvB,IAAI,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC9B,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;CAC9B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component-metadata.js","sourceRoot":"","sources":["../../src/model/component-metadata.ts"],"names":[],"mappings":"","sourcesContent":["import type { StandardSchemaV1 } from \"@standard-schema/spec\";\nimport TamboAI from \"@tambo-ai/typescript-sdk\";\nimport { JSONSchema7 } from \"json-schema\";\nimport { ComponentType } from \"react\";\nimport {\n ZodFunction as Zod3Function,\n ZodTuple as Zod3FunctionArgs,\n ZodType as Zod3FunctionReturns,\n infer as Zod3Infer,\n} from \"zod/v3\";\nimport {\n $ZodFunction as Zod4Function,\n $ZodFunctionArgs as Zod4FunctionArgs,\n $ZodType as Zod4FunctionReturns,\n infer as Zod4Infer,\n} from \"zod/v4/core\";\n\n/**\n * A schema type that accepts either a Standard Schema compliant validator\n * (e.g., Zod, Valibot, ArkType) or a raw JSON Schema object.\n *\n * Standard Schema is a specification that provides a unified interface for\n * TypeScript validation libraries. Libraries like Zod implement this spec,\n * allowing us to accept any compliant validator without depending on a specific library.\n * @see https://standardschema.dev/\n */\nexport type SupportedSchema<Shape = unknown> =\n | StandardSchemaV1<Shape, Shape>\n | JSONSchema7;\n\n/** Extension of the ToolParameters interface from Tambo AI to include JSONSchema definition */\nexport type ParameterSpec = TamboAI.ToolParameters & {\n schema?: JSONSchema7;\n};\n\n/**\n * Extends the base ContextTool interface from Tambo AI to include schema information\n * for parameter validation.\n */\nexport interface ComponentContextToolMetadata\n extends TamboAI.ComponentContextToolMetadata {\n parameters: ParameterSpec[];\n}\n\nexport interface ComponentContextTool {\n getComponentContext: (...args: any[]) => Promise<any>;\n definition: ComponentContextToolMetadata;\n}\n\nexport interface RegisteredComponent extends TamboAI.AvailableComponent {\n component: ComponentType<any>;\n loadingComponent?: ComponentType<any>;\n}\n\nexport type ComponentRegistry = Record<string, RegisteredComponent>;\n\nexport type TamboToolRegistry = Record<\n string,\n TamboTool | TamboToolWithToolSchema\n>;\n\n/**\n * A JSON Schema that is compatible with the MCP.\n * This is a simplified JSON Schema that is compatible with the MCPClient and the tool's inputSchema.\n *\n * Do not export this type from the SDK.\n */\nexport type JSONSchemaLite = JSONSchema7 & {\n description?: string;\n};\n\ntype MaybeAsync<T> = T | Promise<T>;\n\n/**\n * TamboTool is a type that represents a tool that can be registered with Tambo.\n *\n * It is preferable to use the `defineTool` helper function to create tools, as\n * it provides better type inference and safety.\n * @example\n * ```ts\n * import { TamboTool, defineTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon = defineTool({\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n * Alternatively, you manually construct a TamboTool with type safety by passing\n * the expected parameter and return types as generics:\n * ```ts\n * import { TamboTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon: TamboTool<{ location: string }, { lat: number; lon: number }> = {\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n */\nexport interface TamboTool<\n Params = any,\n Returns = any,\n Rest extends any[] = [],\n> {\n /**\n * Unique identifier for the tool\n */\n name: string;\n /**\n * Description of what the tool does - used by AI to determine when to use it\n */\n description: string;\n /**\n * Optional human-readable name of the tool for display purposes.\n */\n title?: string;\n /**\n * Optional properties describing tool behavior\n */\n annotations?: {\n /**\n * An array indicating the intended audience(s) for this resource. Valid\n * values are \"user\" and \"assistant\". For example, [\"user\", \"assistant\"]\n * indicates content useful for both.\n */\n audience: (\"user\" | \"assistant\")[];\n /**\n * A number from 0.0 to 1.0 indicating the importance of this resource. A\n * value of 1 means \"most important\" (effectively required), while 0 means\n * \"least important\" (entirely optional).\n */\n priority: number;\n /**\n * An ISO 8601 formatted timestamp indicating when the resource was last\n * modified (e.g., \"2025-01-12T15:00:58Z\").\n */\n lastModified: string;\n };\n\n /**\n * The function that implements the tool's logic. This function will be called\n * by Tambo when the model decides to invoke the tool.\n * @param params - The input parameters for the tool. These are validated\n * against the inputSchema before being passed so are guaranteed to be correct\n * when called by the model.\n * @returns The result of the tool execution, which can be a value or a\n * Promise resolving to a value\n */\n tool: (params: Params, ...rest: Rest) => MaybeAsync<Returns>;\n\n /**\n * The schema for the tool's input parameters. This can be a validator from\n * any Standard Schema compliant library (Zod, Valibot, ArkType, etc.) or a\n * raw JSON Schema object.\n *\n * This schema is used to validate and parse the parameters before passing\n * them to the tool function.\n */\n inputSchema: SupportedSchema | unknown;\n\n /**\n * The schema for the tool's output/return value. This can be any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.) or a raw JSON Schema object.\n *\n * This is used to inform the model about the structure of the tool's return value\n * and is not used for runtime validation at this stage.\n */\n outputSchema: SupportedSchema | unknown;\n\n /**\n * Optional function to transform the tool's return value into an array of content parts.\n * If not provided, the return value will be converted to a string and wrapped in a text content part.\n * @param result - The result returned by the tool function\n * @returns An array of content parts to be sent back to the AI\n */\n transformToContent?: (\n result: any,\n ) =>\n | Promise<TamboAI.Beta.Threads.ChatCompletionContentPart[]>\n | TamboAI.Beta.Threads.ChatCompletionContentPart[];\n}\n\n/**\n * Simplified interface for tools using the deprecated toolSchema format.\n * This interface uses simple `any` types to avoid complex type instantiation.\n * Use `defineTamboTool()` for full type inference when creating tools.\n * @deprecated Use TamboTool with `inputSchema`/`outputSchema` instead.\n */\nexport type TamboToolWithToolSchema<\n Args extends any[] = any[],\n Returns = any,\n> = Omit<TamboTool, \"tool\" | \"inputSchema\" | \"outputSchema\"> & {\n tool: (...args: Args) => MaybeAsync<Returns>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: unknown;\n};\n\n// NOTE(lachieh): this comment mirrors the one from `TamboTool` above\n/**\n * TamboTool is a type that represents a tool that can be registered with Tambo.\n *\n * It is preferable to use the `defineTool` helper function to create tools, as\n * it provides better type inference and safety.\n * @example\n * ```ts\n * import { TamboTool, defineTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon = defineTool({\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n * Alternatively, you manually construct a TamboTool with type safety by passing\n * the expected parameter and return types as generics:\n * ```ts\n * import { TamboTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon: TamboTool<{ location: string }, { lat: number; lon: number }> = {\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n */\nexport type TamboToolBase<Params = any, Returns = any> =\n | TamboToolWithToolSchema\n | TamboTool<Params, Returns>;\n\n/**\n * A tool that uses JSON Schema compliant input and output schemas.\n * This does not provide type safety for the tool's parameters and return value.\n * @internal\n */\nexport type TamboToolJSONSchema<\n Args extends unknown[] = unknown[],\n Returns = unknown,\n> = Omit<TamboTool<Args, Returns>, \"tool\" | \"inputSchema\" | \"outputSchema\"> & {\n tool: (...args: Args) => MaybeAsync<Returns>;\n inputSchema: JSONSchemaLite;\n outputSchema: JSONSchemaLite;\n};\n\n/**\n * A tool that could not be matched to any known schema types.\n * This means type safety cannot be guaranteed.\n * @internal\n */\nexport type TamboToolUnknown = Omit<\n TamboTool,\n \"tool\" | \"inputSchema\" | \"outputSchema\"\n> & {\n tool: (...args: unknown[]) => MaybeAsync<unknown>;\n inputSchema: unknown;\n outputSchema: unknown;\n};\n\n/**\n * A tool that uses Standard Schema compliant input and output schemas.\n * This provides full type safety for the tool's parameters and return value.\n * @internal\n */\nexport type TamboToolStandardSchema<\n Input extends StandardSchemaV1 = StandardSchemaV1,\n Output extends StandardSchemaV1 = StandardSchemaV1,\n> = Omit<\n TamboTool<\n StandardSchemaV1.InferOutput<Input>,\n StandardSchemaV1.InferOutput<Output>\n >,\n \"tool\" | \"inputSchema\" | \"outputSchema\"\n> & {\n tool: (\n ...args: [StandardSchemaV1.InferOutput<Input>]\n ) => MaybeAsync<StandardSchemaV1.InferOutput<Output>>;\n inputSchema: Input;\n outputSchema: Output;\n};\n\ntype TamboToolZod3Function<\n Args extends Zod3FunctionArgs,\n Returns extends Zod3FunctionReturns,\n> = Omit<\n TamboToolWithToolSchema<Zod3Infer<Args>, Zod3Infer<Returns>>,\n \"toolSchema\"\n> & {\n tool: (...args: Zod3Infer<Args>) => MaybeAsync<Zod3Infer<Returns>>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: Zod3Function<Args, Returns>;\n};\n\ntype TamboToolZod4Function<\n Args extends Zod4FunctionArgs,\n Returns extends Zod4FunctionReturns,\n> = Omit<\n TamboToolWithToolSchema<Zod4Infer<Args>, Zod4Infer<Returns>>,\n \"toolSchema\"\n> & {\n tool: (...args: Zod4Infer<Args>) => MaybeAsync<Zod4Infer<Returns>>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: Zod4Function<Args, Returns>;\n};\n\nexport type TamboToolAssociations = Record<string, string[]>;\n/**\n * A component that can be registered with the TamboRegistryProvider.\n */\n\nexport interface TamboComponent {\n /** The name of the component */\n name: string;\n /** The description of the component */\n description: string;\n /**\n * The React component to render.\n *\n * Make sure to pass the Component itself, not an instance of the component. For example,\n * if you have a component like this:\n *\n * ```tsx\n * const MyComponent = () => {\n * return <div>My Component</div>;\n * };\n * ```\n *\n * You should pass the `Component`:\n *\n * ```tsx\n * const components = [MyComponent];\n * <TamboRegistryProvider components={components} />\n * ```\n */\n component: ComponentType<any>;\n\n /**\n * Schema describing the component's props. Accepts any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.) or a raw JSON Schema\n * object.\n *\n * Either this or propsDefinition must be provided, but not both.\n * @example\n * ```typescript\n * import { z } from \"zod/v4\";\n *\n * const component: TamboComponent = {\n * name: \"MyComponent\",\n * description: \"A sample component\",\n * component: MyComponent,\n * propsSchema: z.object({\n * title: z.string(),\n * count: z.number().optional()\n * })\n * };\n * ```\n */\n propsSchema?: SupportedSchema;\n /**\n * The props definition of the component as a JSON object.\n * Either this or propsSchema must be provided, but not both.\n * @deprecated Use propsSchema instead.\n */\n propsDefinition?: any;\n /** The loading component to render while the component is loading */\n loadingComponent?: ComponentType<any>;\n /** The tools that are associated with the component */\n associatedTools?: (TamboTool | TamboToolWithToolSchema)[];\n}\n\nexport interface RegisterToolsFn {\n /**\n * Registers one or more Tambo tools.\n * @param tools - An array of Tambo tools to register\n */\n (tools: TamboTool[]): void;\n (tools: (TamboTool | TamboToolWithToolSchema)[]): void;\n}\n\n/**\n * Function interface for registering a Tambo tool with full type inference.\n * This function has multiple overloads to handle different schema types. This\n * is a utility function and does not perform any runtime logic.\n */\nexport interface RegisterToolFn {\n /**\n * @deprecated Use `inputSchema`/`outputSchema` instead. toolSchema is deprecated\n * and will be removed in future versions.\n * @example\n * ```diff\n * import { z } from \"zod/v3\";\n * const myTool = defineTamboTool({\n * ...\n * - toolSchema: z.function()\n * - .arguments(z.tuple([z.string()]))\n * - .returns(z.number()),\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n */\n <Args extends Zod3FunctionArgs, Returns extends Zod3FunctionReturns>(\n tool: TamboToolZod3Function<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n /**\n * @deprecated Use `inputSchema`/`outputSchema` instead. toolSchema is deprecated\n * and will be removed in future versions.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n * const myTool = defineTamboTool({\n * ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - }),\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n */\n <Args extends Zod4FunctionArgs, Returns extends Zod4FunctionReturns>(\n tool: TamboToolZod4Function<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n (tool: TamboToolWithToolSchema, warnOnOverwrite?: boolean): void;\n <Args extends StandardSchemaV1, Returns extends StandardSchemaV1>(\n tool: TamboToolStandardSchema<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n <Args extends any[], Returns = any>(\n tool: TamboToolJSONSchema<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n (tool: TamboToolUnknown, warnOnOverwrite?: boolean): void;\n (tool: TamboTool, warnOnOverwrite?: boolean): void;\n}\n\n/**\n * Function interface for defining a Tambo tool with full type inference. This\n * function has multiple overloads to handle different schema types. This is a\n * utility function and does not perform any runtime logic.\n */\nexport interface DefineToolFn {\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * Tambo uses the [standard-schema.dev](https://standard-schema.dev) spec which means you can use any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.). This definition ensures the input and output types are correctly\n * inferred from the provided schemas.\n * @example\n * ```typescript\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * inputSchema: z.object({\n * input: z.string().describe(\"Input description\")\n * }),\n * outputSchema: z.number().describe(\"Result description\"),\n * });\n * ```\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n */\n <Input extends StandardSchemaV1, Output extends StandardSchemaV1>(\n tool: TamboToolStandardSchema<Input, Output>,\n ): TamboToolStandardSchema<Input, Output>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` format which uses a zod function schema. If you are using a validation\n * library that implements StandardSchema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - })\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * ```\n */\n <Args extends Zod3FunctionArgs, Returns extends Zod3FunctionReturns>(\n tool: TamboToolZod3Function<Args, Returns>,\n ): TamboToolZod3Function<Args, Returns>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` format which uses a zod function schema. If you are using a validation\n * library that implements standard-schema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - })\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n * ```\n */\n <Args extends Zod4FunctionArgs, Returns extends Zod4FunctionReturns>(\n tool: TamboToolZod4Function<Args, Returns>,\n ): TamboToolZod4Function<Args, Returns>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` property which uses a zod function schema. If you are using a validation\n * library that implements standard-schema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: { ... }\n * + inputSchema: z.object({ ... }),\n * + outputSchema: z.number(),\n * });\n * ```\n */\n (tool: TamboToolWithToolSchema): TamboToolWithToolSchema;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool definition matched to JSON Schema input and output schemas which allows does not guarantee type\n * safety. If you are using a validation library that implements\n * [Standard Schema](https://standardschema.dev/#what-tools-frameworks-accept-speccompliant-schemas), please ensure\n * your schemas are correctly typed.\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n */\n <I extends any[], O = any>(\n tool: TamboToolJSONSchema<I, O>,\n ): TamboToolJSONSchema<I, O>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool definition could not be matched to any known schema types which means type safety cannot be\n * guaranteed. If you are using a validation library that implements\n * [Standard Schema](https://standardschema.dev/#what-tools-frameworks-accept-speccompliant-schemas), please ensure\n * your schemas are correctly typed.\n * @example\n * ```typescript\n * const myTool = defineTamboTool({\n * name: \"myTool\",\n * description: \"An example tool\",\n * tool: (input) => { ... },\n * inputSchema: yourInputSchema,\n * outputSchema: yourOutputSchema,\n * });\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * ```\n */\n (tool: TamboToolUnknown): TamboToolUnknown;\n (tool: TamboTool): TamboTool;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"component-metadata.js","sourceRoot":"","sources":["../../src/model/component-metadata.ts"],"names":[],"mappings":"","sourcesContent":["import type { ToolAnnotations as MCPToolAnnotations } from \"@modelcontextprotocol/sdk/types.js\";\nimport type { StandardSchemaV1 } from \"@standard-schema/spec\";\nimport TamboAI from \"@tambo-ai/typescript-sdk\";\nimport { JSONSchema7 } from \"json-schema\";\nimport { ComponentType } from \"react\";\nimport {\n ZodFunction as Zod3Function,\n ZodTuple as Zod3FunctionArgs,\n ZodType as Zod3FunctionReturns,\n infer as Zod3Infer,\n} from \"zod/v3\";\nimport {\n $ZodFunction as Zod4Function,\n $ZodFunctionArgs as Zod4FunctionArgs,\n $ZodType as Zod4FunctionReturns,\n infer as Zod4Infer,\n} from \"zod/v4/core\";\n\n/**\n * A schema type that accepts either a Standard Schema compliant validator\n * (e.g., Zod, Valibot, ArkType) or a raw JSON Schema object.\n *\n * Standard Schema is a specification that provides a unified interface for\n * TypeScript validation libraries. Libraries like Zod implement this spec,\n * allowing us to accept any compliant validator without depending on a specific library.\n * @see https://standardschema.dev/\n */\nexport type SupportedSchema<Shape = unknown> =\n | StandardSchemaV1<Shape, Shape>\n | JSONSchema7;\n\n/**\n * Annotations describing a tool's behavior, aligned with the MCP (Model Context Protocol)\n * specification. These hints help clients understand how tools behave and can be used\n * to optimize tool execution strategies.\n * @see https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations\n */\nexport type ToolAnnotations = MCPToolAnnotations & {\n /**\n * Indicates that the tool is safe to be called repeatedly while a response is\n * being streamed. This is typically used for read-only tools that do not\n * cause side effects.\n */\n tamboStreamableHint?: boolean;\n};\n\n/** Extension of the ToolParameters interface from Tambo AI to include JSONSchema definition */\nexport type ParameterSpec = TamboAI.ToolParameters & {\n schema?: JSONSchema7;\n};\n\n/**\n * Extends the base ContextTool interface from Tambo AI to include schema information\n * for parameter validation.\n */\nexport interface ComponentContextToolMetadata\n extends TamboAI.ComponentContextToolMetadata {\n parameters: ParameterSpec[];\n /**\n * Optional per-tool call limit. When set, this overrides the project's\n * global tool call limit for this specific tool.\n *\n * This is useful for tools that should only be called once or twice\n * regardless of the project's global limit.\n */\n maxCalls?: number;\n /**\n * Annotations describing the tool's behavior. See {@link ToolAnnotations}.\n */\n annotations?: ToolAnnotations;\n}\n\nexport interface ComponentContextTool {\n getComponentContext: (...args: any[]) => Promise<any>;\n definition: ComponentContextToolMetadata;\n}\n\nexport interface RegisteredComponent extends TamboAI.AvailableComponent {\n component: ComponentType<any>;\n loadingComponent?: ComponentType<any>;\n}\n\nexport type ComponentRegistry = Record<string, RegisteredComponent>;\n\nexport type TamboToolRegistry = Record<\n string,\n TamboTool | TamboToolWithToolSchema\n>;\n\n/**\n * A JSON Schema that is compatible with the MCP.\n * This is a simplified JSON Schema that is compatible with the MCPClient and the tool's inputSchema.\n *\n * Do not export this type from the SDK.\n */\nexport type JSONSchemaLite = JSONSchema7 & {\n description?: string;\n};\n\ntype MaybeAsync<T> = T | Promise<T>;\n\n/**\n * TamboTool is a type that represents a tool that can be registered with Tambo.\n *\n * It is preferable to use the `defineTool` helper function to create tools, as\n * it provides better type inference and safety.\n * @example\n * ```ts\n * import { TamboTool, defineTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon = defineTool({\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n * Alternatively, you manually construct a TamboTool with type safety by passing\n * the expected parameter and return types as generics:\n * ```ts\n * import { TamboTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon: TamboTool<{ location: string }, { lat: number; lon: number }> = {\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n */\nexport interface TamboTool<\n Params = any,\n Returns = any,\n Rest extends any[] = [],\n> {\n /**\n * Unique identifier for the tool\n */\n name: string;\n /**\n * Description of what the tool does - used by AI to determine when to use it\n */\n description: string;\n /**\n * Optional human-readable name of the tool for display purposes.\n */\n title?: string;\n /**\n * Optional limit for how many times this tool may be called while\n * generating a single response. If present, this value overrides the\n * project's global `maxToolCallLimit` for this tool.\n * @example 1\n */\n maxCalls?: number;\n /**\n * Annotations describing the tool's behavior, aligned with the MCP specification.\n * Use `tamboStreamableHint: true` to enable streaming execution of partial tool calls.\n * @see {@link ToolAnnotations}\n * @example\n * ```ts\n * const setTextTool: TamboTool<{ text: string }> = {\n * name: \"set_text\",\n * description: \"Set the displayed text\",\n * annotations: {\n * tamboStreamableHint: true, // tool is safe for streaming calls\n * },\n * tool: ({ text }) => setText(text),\n * inputSchema: z.object({ text: z.string() }),\n * outputSchema: z.void(),\n * };\n * ```\n */\n annotations?: ToolAnnotations;\n\n /**\n * The function that implements the tool's logic. This function will be called\n * by Tambo when the model decides to invoke the tool.\n * @param params - The input parameters for the tool. These are validated\n * against the inputSchema before being passed so are guaranteed to be correct\n * when called by the model.\n * @returns The result of the tool execution, which can be a value or a\n * Promise resolving to a value\n */\n tool: (params: Params, ...rest: Rest) => MaybeAsync<Returns>;\n\n /**\n * The schema for the tool's input parameters. This can be a validator from\n * any Standard Schema compliant library (Zod, Valibot, ArkType, etc.) or a\n * raw JSON Schema object.\n *\n * This schema is used to validate and parse the parameters before passing\n * them to the tool function.\n */\n inputSchema: SupportedSchema | unknown;\n\n /**\n * The schema for the tool's output/return value. This can be any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.) or a raw JSON Schema object.\n *\n * This is used to inform the model about the structure of the tool's return value\n * and is not used for runtime validation at this stage.\n */\n outputSchema: SupportedSchema | unknown;\n\n /**\n * Optional function to transform the tool's return value into an array of content parts.\n * If not provided, the return value will be converted to a string and wrapped in a text content part.\n * @param result - The result returned by the tool function\n * @returns An array of content parts to be sent back to the AI\n */\n transformToContent?: (\n result: any,\n ) =>\n | Promise<TamboAI.Beta.Threads.ChatCompletionContentPart[]>\n | TamboAI.Beta.Threads.ChatCompletionContentPart[];\n}\n\n/**\n * Simplified interface for tools using the deprecated toolSchema format.\n * This interface uses simple `any` types to avoid complex type instantiation.\n * Use `defineTamboTool()` for full type inference when creating tools.\n * @deprecated Use TamboTool with `inputSchema`/`outputSchema` instead.\n */\nexport type TamboToolWithToolSchema<\n Args extends any[] = any[],\n Returns = any,\n> = Omit<TamboTool, \"tool\" | \"inputSchema\" | \"outputSchema\"> & {\n tool: (...args: Args) => MaybeAsync<Returns>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: unknown;\n};\n\n// NOTE(lachieh): this comment mirrors the one from `TamboTool` above\n/**\n * TamboTool is a type that represents a tool that can be registered with Tambo.\n *\n * It is preferable to use the `defineTool` helper function to create tools, as\n * it provides better type inference and safety.\n * @example\n * ```ts\n * import { TamboTool, defineTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon = defineTool({\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n * Alternatively, you manually construct a TamboTool with type safety by passing\n * the expected parameter and return types as generics:\n * ```ts\n * import { TamboTool } from \"@tambo-ai/react\";\n * import { z } from \"zod\";\n *\n * const locationToLatLon: TamboTool<{ location: string }, { lat: number; lon: number }> = {\n * name: \"location_to_latlon\",\n * description:\n * \"Fetch latitude and longitude from a location string. Returns an object with 'lat' and 'lon' properties.\",\n * tool: async ({ location }) => getLatLonFromLocation(location),\n * inputSchema: z.object({\n * location: z.string(),\n * }),\n * outputSchema: z.object({\n * lat: z.number(),\n * lon: z.number(),\n * }),\n * });\n * ```\n */\nexport type TamboToolBase<Params = any, Returns = any> =\n | TamboToolWithToolSchema\n | TamboTool<Params, Returns>;\n\n/**\n * A tool that uses JSON Schema compliant input and output schemas.\n * This does not provide type safety for the tool's parameters and return value.\n * @internal\n */\nexport type TamboToolJSONSchema<\n Args extends unknown[] = unknown[],\n Returns = unknown,\n> = Omit<TamboTool<Args, Returns>, \"tool\" | \"inputSchema\" | \"outputSchema\"> & {\n tool: (...args: Args) => MaybeAsync<Returns>;\n inputSchema: JSONSchemaLite;\n outputSchema: JSONSchemaLite;\n};\n\n/**\n * A tool that could not be matched to any known schema types.\n * This means type safety cannot be guaranteed.\n * @internal\n */\nexport type TamboToolUnknown = Omit<\n TamboTool,\n \"tool\" | \"inputSchema\" | \"outputSchema\"\n> & {\n tool: (...args: unknown[]) => MaybeAsync<unknown>;\n inputSchema: unknown;\n outputSchema: unknown;\n};\n\n/**\n * A tool that uses Standard Schema compliant input and output schemas.\n * This provides full type safety for the tool's parameters and return value.\n * @internal\n */\nexport type TamboToolStandardSchema<\n Input extends StandardSchemaV1 = StandardSchemaV1,\n Output extends StandardSchemaV1 = StandardSchemaV1,\n> = Omit<\n TamboTool<\n StandardSchemaV1.InferOutput<Input>,\n StandardSchemaV1.InferOutput<Output>\n >,\n \"tool\" | \"inputSchema\" | \"outputSchema\"\n> & {\n tool: (\n ...args: [StandardSchemaV1.InferOutput<Input>]\n ) => MaybeAsync<StandardSchemaV1.InferOutput<Output>>;\n inputSchema: Input;\n outputSchema: Output;\n};\n\ntype TamboToolZod3Function<\n Args extends Zod3FunctionArgs,\n Returns extends Zod3FunctionReturns,\n> = Omit<\n TamboToolWithToolSchema<Zod3Infer<Args>, Zod3Infer<Returns>>,\n \"toolSchema\"\n> & {\n tool: (...args: Zod3Infer<Args>) => MaybeAsync<Zod3Infer<Returns>>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: Zod3Function<Args, Returns>;\n};\n\ntype TamboToolZod4Function<\n Args extends Zod4FunctionArgs,\n Returns extends Zod4FunctionReturns,\n> = Omit<\n TamboToolWithToolSchema<Zod4Infer<Args>, Zod4Infer<Returns>>,\n \"toolSchema\"\n> & {\n tool: (...args: Zod4Infer<Args>) => MaybeAsync<Zod4Infer<Returns>>;\n /** @deprecated Use `inputSchema`/`outputSchema` properties instead. */\n toolSchema: Zod4Function<Args, Returns>;\n};\n\nexport type TamboToolAssociations = Record<string, string[]>;\n/**\n * A component that can be registered with the TamboRegistryProvider.\n */\n\nexport interface TamboComponent {\n /** The name of the component */\n name: string;\n /** The description of the component */\n description: string;\n /**\n * The React component to render.\n *\n * Make sure to pass the Component itself, not an instance of the component. For example,\n * if you have a component like this:\n *\n * ```tsx\n * const MyComponent = () => {\n * return <div>My Component</div>;\n * };\n * ```\n *\n * You should pass the `Component`:\n *\n * ```tsx\n * const components = [MyComponent];\n * <TamboRegistryProvider components={components} />\n * ```\n */\n component: ComponentType<any>;\n\n /**\n * Schema describing the component's props. Accepts any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.) or a raw JSON Schema\n * object.\n *\n * Either this or propsDefinition must be provided, but not both.\n * @example\n * ```typescript\n * import { z } from \"zod/v4\";\n *\n * const component: TamboComponent = {\n * name: \"MyComponent\",\n * description: \"A sample component\",\n * component: MyComponent,\n * propsSchema: z.object({\n * title: z.string(),\n * count: z.number().optional()\n * })\n * };\n * ```\n */\n propsSchema?: SupportedSchema;\n /**\n * The props definition of the component as a JSON object.\n * Either this or propsSchema must be provided, but not both.\n * @deprecated Use propsSchema instead.\n */\n propsDefinition?: any;\n /** The loading component to render while the component is loading */\n loadingComponent?: ComponentType<any>;\n /** The tools that are associated with the component */\n associatedTools?: (TamboTool | TamboToolWithToolSchema)[];\n /** Annotations describing the component's behavior. */\n annotations?: ToolAnnotations;\n}\n\nexport interface RegisterToolsFn {\n /**\n * Registers one or more Tambo tools.\n * @param tools - An array of Tambo tools to register\n */\n (tools: TamboTool[]): void;\n (tools: (TamboTool | TamboToolWithToolSchema)[]): void;\n}\n\n/**\n * Function interface for registering a Tambo tool with full type inference.\n * This function has multiple overloads to handle different schema types. This\n * is a utility function and does not perform any runtime logic.\n */\nexport interface RegisterToolFn {\n /**\n * @deprecated Use `inputSchema`/`outputSchema` instead. toolSchema is deprecated\n * and will be removed in future versions.\n * @example\n * ```diff\n * import { z } from \"zod/v3\";\n * const myTool = defineTamboTool({\n * ...\n * - toolSchema: z.function()\n * - .arguments(z.tuple([z.string()]))\n * - .returns(z.number()),\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n */\n <Args extends Zod3FunctionArgs, Returns extends Zod3FunctionReturns>(\n tool: TamboToolZod3Function<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n /**\n * @deprecated Use `inputSchema`/`outputSchema` instead. toolSchema is deprecated\n * and will be removed in future versions.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n * const myTool = defineTamboTool({\n * ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - }),\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n */\n <Args extends Zod4FunctionArgs, Returns extends Zod4FunctionReturns>(\n tool: TamboToolZod4Function<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n (tool: TamboToolWithToolSchema, warnOnOverwrite?: boolean): void;\n <Args extends StandardSchemaV1, Returns extends StandardSchemaV1>(\n tool: TamboToolStandardSchema<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n <Args extends any[], Returns = any>(\n tool: TamboToolJSONSchema<Args, Returns>,\n warnOnOverwrite?: boolean,\n ): void;\n (tool: TamboToolUnknown, warnOnOverwrite?: boolean): void;\n (tool: TamboTool, warnOnOverwrite?: boolean): void;\n}\n\n/**\n * Function interface for defining a Tambo tool with full type inference. This\n * function has multiple overloads to handle different schema types. This is a\n * utility function and does not perform any runtime logic.\n */\nexport interface DefineToolFn {\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * Tambo uses the [standard-schema.dev](https://standard-schema.dev) spec which means you can use any Standard Schema\n * compliant validator (Zod, Valibot, ArkType, etc.). This definition ensures the input and output types are correctly\n * inferred from the provided schemas.\n * @example\n * ```typescript\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * inputSchema: z.object({\n * input: z.string().describe(\"Input description\")\n * }),\n * outputSchema: z.number().describe(\"Result description\"),\n * });\n * ```\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n */\n <Input extends StandardSchemaV1, Output extends StandardSchemaV1>(\n tool: TamboToolStandardSchema<Input, Output>,\n ): TamboToolStandardSchema<Input, Output>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` format which uses a zod function schema. If you are using a validation\n * library that implements StandardSchema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - })\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * ```\n */\n <Args extends Zod3FunctionArgs, Returns extends Zod3FunctionReturns>(\n tool: TamboToolZod3Function<Args, Returns>,\n ): TamboToolZod3Function<Args, Returns>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` format which uses a zod function schema. If you are using a validation\n * library that implements standard-schema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: z.function({\n * - input: z.tuple([z.string()]),\n * - output: z.number(),\n * - })\n * + inputSchema: z.object({\n * + input: z.string().describe(\"Input description\")\n * + }),\n * + outputSchema: z.number().describe(\"Result description\"),\n * });\n * ```\n */\n <Args extends Zod4FunctionArgs, Returns extends Zod4FunctionReturns>(\n tool: TamboToolZod4Function<Args, Returns>,\n ): TamboToolZod4Function<Args, Returns>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool uses the deprecated `toolSchema` property which uses a zod function schema. If you are using a validation\n * library that implements standard-schema.dev, please switch to using separate `inputSchema` and `outputSchema`\n * properties instead. See example below.\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * @deprecated Using `toolSchema` is deprecated. Please use separate `inputSchema` and `outputSchema` properties instead.\n * Note that use of `toolSchema` will be removed in a future release.\n * @example\n * ```diff\n * import { z } from \"zod/v4\";\n *\n * const myTool = defineTamboTool({\n * // ...\n * - toolSchema: { ... }\n * + inputSchema: z.object({ ... }),\n * + outputSchema: z.number(),\n * });\n * ```\n */\n (tool: TamboToolWithToolSchema): TamboToolWithToolSchema;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool definition matched to JSON Schema input and output schemas which allows does not guarantee type\n * safety. If you are using a validation library that implements\n * [Standard Schema](https://standardschema.dev/#what-tools-frameworks-accept-speccompliant-schemas), please ensure\n * your schemas are correctly typed.\n * @see {@link https://standard-schema.dev/}\n * @param tool The tool definition to register\n * @returns The registered tool definition\n */\n <I extends any[], O = any>(\n tool: TamboToolJSONSchema<I, O>,\n ): TamboToolJSONSchema<I, O>;\n /**\n * Provides type safety for defining a Tambo Tool.\n *\n * This tool definition could not be matched to any known schema types which means type safety cannot be\n * guaranteed. If you are using a validation library that implements\n * [Standard Schema](https://standardschema.dev/#what-tools-frameworks-accept-speccompliant-schemas), please ensure\n * your schemas are correctly typed.\n * @example\n * ```typescript\n * const myTool = defineTamboTool({\n * name: \"myTool\",\n * description: \"An example tool\",\n * tool: (input) => { ... },\n * inputSchema: yourInputSchema,\n * outputSchema: yourOutputSchema,\n * });\n * @param tool The tool definition to register\n * @returns The registered tool definition\n * ```\n */\n (tool: TamboToolUnknown): TamboToolUnknown;\n (tool: TamboTool): TamboTool;\n}\n"]}
|
|
@@ -4,6 +4,8 @@ export interface TamboInteractableComponent<Props = Record<string, unknown>, Sta
|
|
|
4
4
|
id: string;
|
|
5
5
|
/** Current props for the component */
|
|
6
6
|
props: Props;
|
|
7
|
+
/** Whether the component is currently selected for interaction, meaning Tambo should interact with it when responding to the next message*/
|
|
8
|
+
isSelected?: boolean;
|
|
7
9
|
/** Current state for the component */
|
|
8
10
|
state?: State;
|
|
9
11
|
/** Optional schema for validating state updates */
|
|
@@ -28,5 +30,9 @@ export interface TamboInteractableContext {
|
|
|
28
30
|
setInteractableState: (componentId: string, key: string, value: unknown) => void;
|
|
29
31
|
/** Get state for a specific interactable component */
|
|
30
32
|
getInteractableComponentState: (componentId: string) => Record<string, unknown> | undefined;
|
|
33
|
+
/** Set whether an interactable component is selected for interaction */
|
|
34
|
+
setInteractableSelected: (componentId: string, isSelected: boolean) => void;
|
|
35
|
+
/** Clear all interactable component selections */
|
|
36
|
+
clearInteractableSelections: () => void;
|
|
31
37
|
}
|
|
32
38
|
//# sourceMappingURL=tambo-interactable.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tambo-interactable.d.ts","sourceRoot":"","sources":["../../src/model/tambo-interactable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEvE,MAAM,WAAW,0BAA0B,CACzC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC/B,SAAQ,cAAc;IACtB,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,sCAAsC;IACtC,KAAK,EAAE,KAAK,CAAC;IACb,sCAAsC;IACtC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,sBAAsB,EAAE,0BAA0B,EAAE,CAAC;IACrD,uCAAuC;IACvC,wBAAwB,EAAE,CACxB,SAAS,EAAE,IAAI,CAAC,0BAA0B,EAAE,IAAI,GAAG,WAAW,CAAC,KAC5D,MAAM,CAAC;IACZ,6CAA6C;IAC7C,2BAA2B,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,+CAA+C;IAC/C,gCAAgC,EAAE,CAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,MAAM,CAAC;IACZ,0CAA0C;IAC1C,wBAAwB,EAAE,CACxB,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3B,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAE3B,EAAE,EAAE,MAAM,KACP,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAClD,wDAAwD;IACxD,+BAA+B,EAAE,CAC/B,aAAa,EAAE,MAAM,KAClB,0BAA0B,EAAE,CAAC;IAClC,wCAAwC;IACxC,8BAA8B,EAAE,MAAM,IAAI,CAAC;IAC3C,sDAAsD;IACtD,oBAAoB,EAAE,CACpB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,KACX,IAAI,CAAC;IACV,sDAAsD;IACtD,6BAA6B,EAAE,CAC7B,WAAW,EAAE,MAAM,KAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"tambo-interactable.d.ts","sourceRoot":"","sources":["../../src/model/tambo-interactable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEvE,MAAM,WAAW,0BAA0B,CACzC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC/B,SAAQ,cAAc;IACtB,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,sCAAsC;IACtC,KAAK,EAAE,KAAK,CAAC;IACb,4IAA4I;IAC5I,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,sBAAsB,EAAE,0BAA0B,EAAE,CAAC;IACrD,uCAAuC;IACvC,wBAAwB,EAAE,CACxB,SAAS,EAAE,IAAI,CAAC,0BAA0B,EAAE,IAAI,GAAG,WAAW,CAAC,KAC5D,MAAM,CAAC;IACZ,6CAA6C;IAC7C,2BAA2B,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,+CAA+C;IAC/C,gCAAgC,EAAE,CAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,MAAM,CAAC;IACZ,0CAA0C;IAC1C,wBAAwB,EAAE,CACxB,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3B,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAE3B,EAAE,EAAE,MAAM,KACP,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAClD,wDAAwD;IACxD,+BAA+B,EAAE,CAC/B,aAAa,EAAE,MAAM,KAClB,0BAA0B,EAAE,CAAC;IAClC,wCAAwC;IACxC,8BAA8B,EAAE,MAAM,IAAI,CAAC;IAC3C,sDAAsD;IACtD,oBAAoB,EAAE,CACpB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,KACX,IAAI,CAAC;IACV,sDAAsD;IACtD,6BAA6B,EAAE,CAC7B,WAAW,EAAE,MAAM,KAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACzC,wEAAwE;IACxE,uBAAuB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5E,kDAAkD;IAClD,2BAA2B,EAAE,MAAM,IAAI,CAAC;CACzC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tambo-interactable.js","sourceRoot":"","sources":["../../src/model/tambo-interactable.ts"],"names":[],"mappings":"","sourcesContent":["import { SupportedSchema, TamboComponent } from \"./component-metadata\";\n\nexport interface TamboInteractableComponent<\n Props = Record<string, unknown>,\n State = Record<string, unknown>,\n> extends TamboComponent {\n /** Unique identifier for this component instance */\n id: string;\n /** Current props for the component */\n props: Props;\n /** Current state for the component */\n state?: State;\n /** Optional schema for validating state updates */\n stateSchema?: SupportedSchema<State>;\n}\n\nexport interface TamboInteractableContext {\n /** List of all interactable components */\n interactableComponents: TamboInteractableComponent[];\n /** Add a new interactable component */\n addInteractableComponent: (\n component: Omit<TamboInteractableComponent, \"id\" | \"createdAt\">,\n ) => string;\n /** Remove an interactable component by ID */\n removeInteractableComponent: (id: string) => void;\n /** Update an interactable component's props */\n updateInteractableComponentProps: (\n id: string,\n newProps: Record<string, any>,\n ) => string;\n /** Get an interactable component by ID */\n getInteractableComponent: <\n P = Record<string, unknown>,\n S = Record<string, unknown>,\n >(\n id: string,\n ) => TamboInteractableComponent<P, S> | undefined;\n /** Get all interactable components by component name */\n getInteractableComponentsByName: (\n componentName: string,\n ) => TamboInteractableComponent[];\n /** Clear all interactable components */\n clearAllInteractableComponents: () => void;\n /** Set state for a specific interactable component */\n setInteractableState: (\n componentId: string,\n key: string,\n value: unknown,\n ) => void;\n /** Get state for a specific interactable component */\n getInteractableComponentState: (\n componentId: string,\n ) => Record<string, unknown> | undefined;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"tambo-interactable.js","sourceRoot":"","sources":["../../src/model/tambo-interactable.ts"],"names":[],"mappings":"","sourcesContent":["import { SupportedSchema, TamboComponent } from \"./component-metadata\";\n\nexport interface TamboInteractableComponent<\n Props = Record<string, unknown>,\n State = Record<string, unknown>,\n> extends TamboComponent {\n /** Unique identifier for this component instance */\n id: string;\n /** Current props for the component */\n props: Props;\n /** Whether the component is currently selected for interaction, meaning Tambo should interact with it when responding to the next message*/\n isSelected?: boolean;\n /** Current state for the component */\n state?: State;\n /** Optional schema for validating state updates */\n stateSchema?: SupportedSchema<State>;\n}\n\nexport interface TamboInteractableContext {\n /** List of all interactable components */\n interactableComponents: TamboInteractableComponent[];\n /** Add a new interactable component */\n addInteractableComponent: (\n component: Omit<TamboInteractableComponent, \"id\" | \"createdAt\">,\n ) => string;\n /** Remove an interactable component by ID */\n removeInteractableComponent: (id: string) => void;\n /** Update an interactable component's props */\n updateInteractableComponentProps: (\n id: string,\n newProps: Record<string, any>,\n ) => string;\n /** Get an interactable component by ID */\n getInteractableComponent: <\n P = Record<string, unknown>,\n S = Record<string, unknown>,\n >(\n id: string,\n ) => TamboInteractableComponent<P, S> | undefined;\n /** Get all interactable components by component name */\n getInteractableComponentsByName: (\n componentName: string,\n ) => TamboInteractableComponent[];\n /** Clear all interactable components */\n clearAllInteractableComponents: () => void;\n /** Set state for a specific interactable component */\n setInteractableState: (\n componentId: string,\n key: string,\n value: unknown,\n ) => void;\n /** Get state for a specific interactable component */\n getInteractableComponentState: (\n componentId: string,\n ) => Record<string, unknown> | undefined;\n /** Set whether an interactable component is selected for interaction */\n setInteractableSelected: (componentId: string, isSelected: boolean) => void;\n /** Clear all interactable component selections */\n clearInteractableSelections: () => void;\n}\n"]}
|
package/esm/providers/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export type { RegisterToolFn, RegisterToolsFn, TamboComponent, TamboTool, } from "../model/component-metadata";
|
|
2
2
|
export { TamboClientProvider, useIsTamboTokenUpdating, useTamboClient, } from "./tambo-client-provider";
|
|
3
3
|
export { TamboComponentProvider, useTamboComponent, } from "./tambo-component-provider";
|
|
4
|
-
export { TamboContextAttachmentProvider, useTamboContextAttachment, type ContextAttachment, type ContextAttachmentState, type
|
|
4
|
+
export { TamboContextAttachmentProvider, useTamboContextAttachment, type ContextAttachment, type ContextAttachmentState, type TamboContextAttachmentProviderProps, } from "./tambo-context-attachment-provider";
|
|
5
5
|
export { TamboContextHelpersProvider, useTamboContextHelpers, type TamboContextHelpersContextProps, type TamboContextHelpersProviderProps, } from "./tambo-context-helpers-provider";
|
|
6
6
|
export { Pending, Streaming, Success, TamboPropStreamProvider, useTamboStream, } from "./tambo-prop-stream-provider";
|
|
7
7
|
export type { StreamStateComponentProps, StreamStatus, TamboPropStreamContextValue, } from "./tambo-prop-stream-provider";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,SAAS,GACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,GACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,EACzB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,SAAS,GACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,GACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,EACzB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,mCAAmC,GACzC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,2BAA2B,EAC3B,sBAAsB,EACtB,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,GACtC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,OAAO,EACP,SAAS,EACT,OAAO,EACP,uBAAuB,EACvB,cAAc,GACf,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,yBAAyB,EACzB,YAAY,EACZ,2BAA2B,GAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,EAChB,KAAK,oBAAoB,GAC1B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,KAAK,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,KAAK,4BAA4B,GAClC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,KAAK,wBAAwB,GAC9B,MAAM,yBAAyB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,GACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,GACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,GAI1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,2BAA2B,EAC3B,sBAAsB,GAGvB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,OAAO,EACP,SAAS,EACT,OAAO,EACP,uBAAuB,EACvB,cAAc,GACf,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,GAEjB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAA+B,MAAM,eAAe,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,GAEf,MAAM,yBAAyB,CAAC","sourcesContent":["export type {\n RegisterToolFn,\n RegisterToolsFn,\n TamboComponent,\n TamboTool,\n} from \"../model/component-metadata\";\nexport {\n TamboClientProvider,\n useIsTamboTokenUpdating,\n useTamboClient,\n} from \"./tambo-client-provider\";\nexport {\n TamboComponentProvider,\n useTamboComponent,\n} from \"./tambo-component-provider\";\nexport {\n TamboContextAttachmentProvider,\n useTamboContextAttachment,\n type ContextAttachment,\n type ContextAttachmentState,\n type TamboContextAttachmentProviderProps,\n} from \"./tambo-context-attachment-provider\";\nexport {\n TamboContextHelpersProvider,\n useTamboContextHelpers,\n type TamboContextHelpersContextProps,\n type TamboContextHelpersProviderProps,\n} from \"./tambo-context-helpers-provider\";\nexport {\n Pending,\n Streaming,\n Success,\n TamboPropStreamProvider,\n useTamboStream,\n} from \"./tambo-prop-stream-provider\";\nexport type {\n StreamStateComponentProps,\n StreamStatus,\n TamboPropStreamContextValue,\n} from \"./tambo-prop-stream-provider\";\nexport { TamboContext, TamboProvider, useTambo } from \"./tambo-provider\";\nexport {\n TamboRegistryProvider,\n useTamboMcpServerInfos,\n useTamboRegistry,\n type TamboRegistryContext,\n} from \"./tambo-registry-provider\";\nexport { TamboStubProvider, type TamboStubProviderProps } from \"./tambo-stubs\";\nexport {\n TamboThreadInputProvider,\n useTamboThreadInput,\n type TamboThreadInputContextProps,\n} from \"./tambo-thread-input-provider\";\nexport {\n TamboThreadContext,\n TamboThreadProvider,\n useTamboGenerationStage,\n useTamboThread,\n type TamboThreadProviderProps,\n} from \"./tambo-thread-provider\";\n"]}
|
|
@@ -22,6 +22,11 @@ export interface TamboClientProviderProps {
|
|
|
22
22
|
* user when calling the Tambo API.
|
|
23
23
|
*/
|
|
24
24
|
userToken?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Additional headers to include in all requests to the Tambo API.
|
|
27
|
+
* These will be merged with the default headers.
|
|
28
|
+
*/
|
|
29
|
+
additionalHeaders?: Record<string, string>;
|
|
25
30
|
}
|
|
26
31
|
export interface TamboClientContextProps {
|
|
27
32
|
/** The TamboAI client */
|
|
@@ -30,6 +35,8 @@ export interface TamboClientContextProps {
|
|
|
30
35
|
queryClient: QueryClient;
|
|
31
36
|
/** Whether the session token is currently being updated */
|
|
32
37
|
isUpdatingToken: boolean;
|
|
38
|
+
/** Additional headers to include in all requests */
|
|
39
|
+
additionalHeaders?: Record<string, string>;
|
|
33
40
|
}
|
|
34
41
|
export declare const TamboClientContext: React.Context<TamboClientContextProps | undefined>;
|
|
35
42
|
/**
|
|
@@ -41,6 +48,7 @@ export declare const TamboClientContext: React.Context<TamboClientContextProps |
|
|
|
41
48
|
* @param props.apiKey - The API key for the Tambo API
|
|
42
49
|
* @param props.environment - The environment to use for the Tambo API
|
|
43
50
|
* @param props.userToken - The oauth access token to use to identify the user in the Tambo API
|
|
51
|
+
* @param props.additionalHeaders - Additional headers to include in all requests
|
|
44
52
|
* @returns The TamboClientProvider component
|
|
45
53
|
*/
|
|
46
54
|
export declare const TamboClientProvider: React.FC<PropsWithChildren<TamboClientProviderProps>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tambo-client-provider.d.ts","sourceRoot":"","sources":["../../src/providers/tambo-client-provider.tsx"],"names":[],"mappings":"AACA,OAAO,OAA0B,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,EAAiB,iBAAiB,
|
|
1
|
+
{"version":3,"file":"tambo-client-provider.d.ts","sourceRoot":"","sources":["../../src/providers/tambo-client-provider.tsx"],"names":[],"mappings":"AACA,OAAO,OAA0B,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,EAAiB,iBAAiB,EAAW,MAAM,OAAO,CAAC;AAIzE,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAEvC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,uBAAuB;IACtC,yBAAyB;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,sCAAsC;IACtC,WAAW,EAAE,WAAW,CAAC;IACzB,2DAA2D;IAC3D,eAAe,EAAE,OAAO,CAAC;IACzB,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C;AAED,eAAO,MAAM,kBAAkB,oDAEnB,CAAC;AAEb;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CACxC,iBAAiB,CAAC,wBAAwB,CAAC,CA6C5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,eAM1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,mBAQ/B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,eAQnC,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
import TamboAI from "@tambo-ai/typescript-sdk";
|
|
3
3
|
import { QueryClient } from "@tanstack/react-query";
|
|
4
|
-
import React, { createContext,
|
|
4
|
+
import React, { createContext, useMemo } from "react";
|
|
5
5
|
import packageJson from "../../package.json";
|
|
6
6
|
import { useTamboSessionToken } from "./hooks/use-tambo-session-token";
|
|
7
7
|
export const TamboClientContext = createContext(undefined);
|
|
@@ -14,29 +14,28 @@ export const TamboClientContext = createContext(undefined);
|
|
|
14
14
|
* @param props.apiKey - The API key for the Tambo API
|
|
15
15
|
* @param props.environment - The environment to use for the Tambo API
|
|
16
16
|
* @param props.userToken - The oauth access token to use to identify the user in the Tambo API
|
|
17
|
+
* @param props.additionalHeaders - Additional headers to include in all requests
|
|
17
18
|
* @returns The TamboClientProvider component
|
|
18
19
|
*/
|
|
19
|
-
export const TamboClientProvider = ({ children, tamboUrl, apiKey, environment, userToken }) => {
|
|
20
|
-
const tamboConfig = {
|
|
20
|
+
export const TamboClientProvider = ({ children, tamboUrl, apiKey, environment, userToken, additionalHeaders, }) => {
|
|
21
|
+
const tamboConfig = useMemo(() => ({
|
|
21
22
|
apiKey,
|
|
22
23
|
defaultHeaders: {
|
|
23
24
|
"X-Tambo-React-Version": packageJson.version,
|
|
25
|
+
...additionalHeaders,
|
|
24
26
|
},
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
tamboConfig.environment = environment;
|
|
31
|
-
}
|
|
32
|
-
const [client] = useState(() => new TamboAI(tamboConfig));
|
|
33
|
-
const [queryClient] = useState(() => new QueryClient());
|
|
27
|
+
baseURL: tamboUrl ?? undefined,
|
|
28
|
+
environment: environment ?? undefined,
|
|
29
|
+
}), [additionalHeaders, apiKey, tamboUrl, environment]);
|
|
30
|
+
const client = useMemo(() => new TamboAI(tamboConfig), [tamboConfig]);
|
|
31
|
+
const queryClient = useMemo(() => new QueryClient(), []);
|
|
34
32
|
// Keep the session token updated and get the updating state
|
|
35
33
|
const { isFetching: isUpdatingToken } = useTamboSessionToken(client, queryClient, userToken);
|
|
36
34
|
return (React.createElement(TamboClientContext.Provider, { value: {
|
|
37
35
|
client,
|
|
38
36
|
queryClient,
|
|
39
37
|
isUpdatingToken,
|
|
38
|
+
additionalHeaders: tamboConfig.defaultHeaders,
|
|
40
39
|
} }, children));
|
|
41
40
|
};
|
|
42
41
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tambo-client-provider.js","sourceRoot":"","sources":["../../src/providers/tambo-client-provider.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,OAA0B,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,EAAE,aAAa,EAAqB,
|
|
1
|
+
{"version":3,"file":"tambo-client-provider.js","sourceRoot":"","sources":["../../src/providers/tambo-client-provider.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,OAA0B,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,EAAE,aAAa,EAAqB,OAAO,EAAE,MAAM,OAAO,CAAC;AACzE,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AA2CvE,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAE7C,SAAS,CAAC,CAAC;AAEb;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAE5B,CAAC,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,WAAW,EACX,SAAS,EACT,iBAAiB,GAClB,EAAE,EAAE;IACH,MAAM,WAAW,GAAG,OAAO,CACzB,GAAG,EAAE,CACH,CAAC;QACC,MAAM;QACN,cAAc,EAAE;YACd,uBAAuB,EAAE,WAAW,CAAC,OAAO;YAC5C,GAAG,iBAAiB;SACrB;QACD,OAAO,EAAE,QAAQ,IAAI,SAAS;QAC9B,WAAW,EAAE,WAAW,IAAI,SAAS;KACtC,CAAyB,EAC5B,CAAC,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CACnD,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IAEzD,4DAA4D;IAC5D,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAC1D,MAAM,EACN,WAAW,EACX,SAAS,CACV,CAAC;IAEF,OAAO,CACL,oBAAC,kBAAkB,CAAC,QAAQ,IAC1B,KAAK,EAAE;YACL,MAAM;YACN,WAAW;YACX,eAAe;YACf,iBAAiB,EAAE,WAAW,CAAC,cAAc;SAC9C,IAEA,QAAQ,CACmB,CAC/B,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACrD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CAAC;AACxB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACtC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACrD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,WAAW,CAAC;AAC7B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACrD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,eAAe,CAAC;AACjC,CAAC,CAAC","sourcesContent":["\"use client\";\nimport TamboAI, { ClientOptions } from \"@tambo-ai/typescript-sdk\";\nimport { QueryClient } from \"@tanstack/react-query\";\nimport React, { createContext, PropsWithChildren, useMemo } from \"react\";\nimport packageJson from \"../../package.json\";\nimport { useTamboSessionToken } from \"./hooks/use-tambo-session-token\";\n\nexport interface TamboClientProviderProps {\n /**\n * The URL of the Tambo API (only used for local development and debugging)\n */\n tamboUrl?: string;\n /**\n * The API key for the Tambo API. This typically comes from a variable like\n * `process.env.NEXT_PUBLIC_TAMBO_API_KEY`\n */\n apiKey: string;\n /**\n * The environment to use for the Tambo API\n */\n environment?: \"production\" | \"staging\";\n\n /**\n * The user token to use to identify the user in the Tambo API. This token is\n * a 3rd party token like a Google or GitHub access token, exchanged with the\n * Tambo API to get a session token. This is used to securely identify the\n * user when calling the Tambo API.\n */\n userToken?: string;\n\n /**\n * Additional headers to include in all requests to the Tambo API.\n * These will be merged with the default headers.\n */\n additionalHeaders?: Record<string, string>;\n}\n\nexport interface TamboClientContextProps {\n /** The TamboAI client */\n client: TamboAI;\n /** The tambo-specific query client */\n queryClient: QueryClient;\n /** Whether the session token is currently being updated */\n isUpdatingToken: boolean;\n /** Additional headers to include in all requests */\n additionalHeaders?: Record<string, string>;\n}\n\nexport const TamboClientContext = createContext<\n TamboClientContextProps | undefined\n>(undefined);\n\n/**\n * The TamboClientProvider is a React provider that provides a TamboAI client\n * and a query client to the descendants of the provider.\n * @param props - The props for the TamboClientProvider\n * @param props.children - The children to wrap\n * @param props.tamboUrl - The URL of the Tambo API\n * @param props.apiKey - The API key for the Tambo API\n * @param props.environment - The environment to use for the Tambo API\n * @param props.userToken - The oauth access token to use to identify the user in the Tambo API\n * @param props.additionalHeaders - Additional headers to include in all requests\n * @returns The TamboClientProvider component\n */\nexport const TamboClientProvider: React.FC<\n PropsWithChildren<TamboClientProviderProps>\n> = ({\n children,\n tamboUrl,\n apiKey,\n environment,\n userToken,\n additionalHeaders,\n}) => {\n const tamboConfig = useMemo(\n () =>\n ({\n apiKey,\n defaultHeaders: {\n \"X-Tambo-React-Version\": packageJson.version,\n ...additionalHeaders,\n },\n baseURL: tamboUrl ?? undefined,\n environment: environment ?? undefined,\n }) satisfies ClientOptions,\n [additionalHeaders, apiKey, tamboUrl, environment],\n );\n\n const client = useMemo(() => new TamboAI(tamboConfig), [tamboConfig]);\n const queryClient = useMemo(() => new QueryClient(), []);\n\n // Keep the session token updated and get the updating state\n const { isFetching: isUpdatingToken } = useTamboSessionToken(\n client,\n queryClient,\n userToken,\n );\n\n return (\n <TamboClientContext.Provider\n value={{\n client,\n queryClient,\n isUpdatingToken,\n additionalHeaders: tamboConfig.defaultHeaders,\n }}\n >\n {children}\n </TamboClientContext.Provider>\n );\n};\n\n/**\n * The useTamboClient hook provides access to the TamboAI client\n * to the descendants of the TamboClientProvider.\n * @returns The TamboAI client\n */\nexport const useTamboClient = () => {\n const context = React.useContext(TamboClientContext);\n if (context === undefined) {\n throw new Error(\"useTamboClient must be used within a TamboClientProvider\");\n }\n return context.client;\n};\n\n/**\n * The useTamboQueryClient hook provides access to the tambo-specific query client\n * to the descendants of the TamboClientProvider.\n * @returns The tambo-specific query client\n * @private\n */\nexport const useTamboQueryClient = () => {\n const context = React.useContext(TamboClientContext);\n if (context === undefined) {\n throw new Error(\n \"useTamboQueryClient must be used within a TamboClientProvider\",\n );\n }\n return context.queryClient;\n};\n\n/**\n * Hook to check if the session token is currently being updated\n * @returns true if the token is being refreshed, false otherwise\n */\nexport const useIsTamboTokenUpdating = () => {\n const context = React.useContext(TamboClientContext);\n if (context === undefined) {\n throw new Error(\n \"useIsTamboTokenUpdating must be used within a TamboClientProvider\",\n );\n }\n return context.isUpdatingToken;\n};\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tambo-client-provider.test.d.ts","sourceRoot":"","sources":["../../src/providers/tambo-client-provider.test.tsx"],"names":[],"mappings":""}
|