@truefoundry/ai-gateway-sdk 0.0.0-stage → 0.0.2

package/dist/types/MessagesRequest.d.ts

@@ -0,0 +1,459 @@
+/**
+ * ================================
+ * Inherited upstream file
+ * ================================
+ */
+export interface CacheControlEphemeral {
+    type: 'ephemeral';
+}
+export interface ServerToolUseBlockParam {
+    id: string;
+    input: unknown;
+    name: 'web_search';
+    type: 'server_tool_use';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface WebSearchResultBlockParam {
+    encrypted_content: string;
+    title: string;
+    type: 'web_search_result';
+    url: string;
+    page_age?: string | null;
+}
+export interface WebSearchToolRequestError {
+    error_code: 'invalid_tool_input' | 'unavailable' | 'max_uses_exceeded' | 'too_many_requests' | 'query_too_long';
+    type: 'web_search_tool_result_error';
+}
+export type WebSearchToolResultBlockParamContent = Array<WebSearchResultBlockParam> | WebSearchToolRequestError;
+export interface WebSearchToolResultBlockParam {
+    content: WebSearchToolResultBlockParamContent;
+    tool_use_id: string;
+    type: 'web_search_tool_result';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface CitationCharLocationParam {
+    cited_text: string;
+    document_index: number;
+    document_title: string | null;
+    end_char_index: number;
+    start_char_index: number;
+    type: 'char_location';
+}
+export interface CitationPageLocationParam {
+    cited_text: string;
+    document_index: number;
+    document_title: string | null;
+    end_page_number: number;
+    start_page_number: number;
+    type: 'page_location';
+}
+export interface CitationContentBlockLocationParam {
+    cited_text: string;
+    document_index: number;
+    document_title: string | null;
+    end_block_index: number;
+    start_block_index: number;
+    type: 'content_block_location';
+}
+export interface CitationWebSearchResultLocationParam {
+    cited_text: string;
+    encrypted_index: string;
+    title: string | null;
+    type: 'web_search_result_location';
+    url: string;
+}
+export type TextCitationParam = CitationCharLocationParam | CitationPageLocationParam | CitationContentBlockLocationParam | CitationWebSearchResultLocationParam;
+export interface TextBlockParam {
+    text: string;
+    type: 'text';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+    citations?: Array<TextCitationParam> | null;
+}
+export interface Base64ImageSource {
+    data: string;
+    media_type: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+    type: 'base64';
+}
+export interface URLImageSource {
+    type: 'url';
+    media_type: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+    url: string;
+}
+export interface FileImageSource {
+    type: 'file';
+    file_id: string;
+}
+export interface ImageBlockParam {
+    source: Base64ImageSource | URLImageSource | FileImageSource;
+    type: 'image';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface ToolUseBlockParam {
+    id: string;
+    input: unknown;
+    name: string;
+    type: 'tool_use';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface ToolResultBlockParam {
+    tool_use_id: string;
+    type: 'tool_result';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+    content?: string | Array<TextBlockParam | ImageBlockParam>;
+    is_error?: boolean;
+}
+export interface Base64PDFSource {
+    data: string;
+    media_type: 'application/pdf';
+    type: 'base64';
+}
+export interface PlainTextSource {
+    data: string;
+    media_type: 'text/plain';
+    type: 'text';
+}
+export interface ContentBlockSource {
+    content: string | Array<ContentBlockSourceContent>;
+    type: 'content';
+}
+export type ContentBlockSourceContent = TextBlockParam | ImageBlockParam;
+export interface URLPDFSource {
+    type: 'url';
+    url: string;
+    media_type?: 'application/pdf';
+}
+export interface CitationsConfigParam {
+    enabled?: boolean;
+}
+export interface DocumentBlockParam {
+    source: Base64PDFSource | PlainTextSource | ContentBlockSource | URLPDFSource;
+    type: 'document';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+    citations?: CitationsConfigParam;
+    context?: string | null;
+    title?: string | null;
+}
+export interface ThinkingBlockParam {
+    signature: string;
+    thinking: string;
+    type: 'thinking';
+}
+export interface RedactedThinkingBlockParam {
+    data: string;
+    type: 'redacted_thinking';
+}
+export type BetaCodeExecutionToolResultErrorCode = 'invalid_tool_input' | 'unavailable' | 'too_many_requests' | 'execution_time_exceeded';
+export interface BetaCodeExecutionToolResultErrorParam {
+    error_code: BetaCodeExecutionToolResultErrorCode;
+    type: 'code_execution_tool_result_error';
+}
+export interface BetaCodeExecutionOutputBlockParam {
+    file_id: string;
+    type: 'code_execution_output';
+}
+export interface BetaCodeExecutionResultBlockParam {
+    content: Array<BetaCodeExecutionOutputBlockParam>;
+    return_code: number;
+    stderr: string;
+    stdout: string;
+    type: 'code_execution_result';
+}
+export type BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultErrorParam | BetaCodeExecutionResultBlockParam;
+export interface BetaCodeExecutionToolResultBlockParam {
+    content: BetaCodeExecutionToolResultBlockParamContent;
+    tool_use_id: string;
+    type: 'code_execution_tool_result';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+/**
+ * Regular text content.
+ */
+export type ContentBlockParam = ServerToolUseBlockParam | WebSearchToolResultBlockParam | TextBlockParam | ImageBlockParam | ToolUseBlockParam | ToolResultBlockParam | DocumentBlockParam | ThinkingBlockParam | RedactedThinkingBlockParam | BetaCodeExecutionToolResultBlockParam;
+export interface MessageParam {
+    content: string | Array<ContentBlockParam>;
+    role: 'user' | 'assistant';
+}
+export interface Metadata {
+    /**
+     * An external identifier for the user who is associated with the request.
+     */
+    user_id?: string | null;
+}
+export interface ThinkingConfigEnabled {
+    /**
+     * Determines how many tokens Claude can use for its internal reasoning process.
+     */
+    budget_tokens: number;
+    type: 'enabled';
+}
+export interface ThinkingConfigDisabled {
+    type: 'disabled';
+}
+export type ThinkingConfigParam = ThinkingConfigEnabled | ThinkingConfigDisabled;
+/**
+ * The model will use any available tools.
+ */
+export interface ToolChoiceAny {
+    type: 'any';
+    /**
+     * Whether to disable parallel tool use.
+     *
+     * Defaults to `false`. If set to `true`, the model will output exactly one tool
+     * use.
+     */
+    disable_parallel_tool_use?: boolean;
+}
+/**
+ * The model will automatically decide whether to use tools.
+ */
+export interface ToolChoiceAuto {
+    type: 'auto';
+    /**
+     * Whether to disable parallel tool use.
+     *
+     * Defaults to `false`. If set to `true`, the model will output at most one tool
+     * use.
+     */
+    disable_parallel_tool_use?: boolean;
+}
+/**
+ * The model will not be allowed to use tools.
+ */
+export interface ToolChoiceNone {
+    type: 'none';
+}
+/**
+ * The model will use the specified tool with `tool_choice.name`.
+ */
+export interface ToolChoiceTool {
+    /**
+     * The name of the tool to use.
+     */
+    name: string;
+    type: 'tool';
+    /**
+     * Whether to disable parallel tool use.
+     *
+     * Defaults to `false`. If set to `true`, the model will output exactly one tool
+     * use.
+     */
+    disable_parallel_tool_use?: boolean;
+}
+export interface ToolInputSchema {
+    type: 'object';
+    properties?: unknown | null;
+    required?: Array<string> | null;
+    [k: string]: unknown;
+}
+export interface Tool {
+    /**
+     * [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
+     *
+     * This defines the shape of the `input` that your tool accepts and that the model
+     * will produce.
+     */
+    input_schema: ToolInputSchema;
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in `tool_use` blocks.
+     */
+    name: string;
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+    /**
+     * Description of what this tool does.
+     *
+     * Tool descriptions should be as detailed as possible. The more information that
+     * the model has about what the tool is and how to use it, the better it will
+     * perform. You can use natural language descriptions to reinforce important
+     * aspects of the tool input JSON schema.
+     */
+    description?: string;
+    eager_input_streaming?: boolean;
+    type?: 'custom' | null;
+}
+export interface ToolBash20250124 {
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in `tool_use` blocks.
+     */
+    name: 'bash';
+    type: 'bash_20250124';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface ToolTextEditor20250124 {
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in `tool_use` blocks.
+     */
+    name: 'str_replace_editor';
+    type: 'text_editor_20250124';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export interface WebSearchUserLocation {
+    type: 'approximate';
+    /**
+     * The city of the user.
+     */
+    city?: string | null;
+    /**
+     * The two letter
+     * [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+     * user.
+     */
+    country?: string | null;
+    /**
+     * The region of the user.
+     */
+    region?: string | null;
+    /**
+     * The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+     */
+    timezone?: string | null;
+}
+export interface WebSearchTool20250305 {
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in `tool_use` blocks.
+     */
+    name: 'web_search';
+    type: 'web_search_20250305';
+    /**
+     * If provided, only these domains will be included in results. Cannot be used
+     * alongside `blocked_domains`.
+     */
+    allowed_domains?: Array<string> | null;
+    /**
+     * If provided, these domains will never appear in results. Cannot be used
+     * alongside `allowed_domains`.
+     */
+    blocked_domains?: Array<string> | null;
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+    /**
+     * Maximum number of times the tool can be used in the API request.
+     */
+    max_uses?: number | null;
+    /**
+     * Parameters for the user's location. Used to provide more relevant search
+     * results.
+     */
+    user_location?: WebSearchUserLocation | null;
+}
+export interface TextEditor20250429 {
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in `tool_use` blocks.
+     */
+    name: 'str_replace_based_edit_tool';
+    type: 'text_editor_20250429';
+    /**
+     * Create a cache control breakpoint at this content block.
+     */
+    cache_control?: CacheControlEphemeral | null;
+}
+export type ToolUnion = Tool | ToolBash20250124 | ToolTextEditor20250124 | TextEditor20250429 | WebSearchTool20250305;
+/**
+ * How the model should use the provided tools. The model can use a specific tool,
+ * any available tool, decide by itself, or not use tools at all.
+ */
+export type ToolChoice = ToolChoiceAuto | ToolChoiceAny | ToolChoiceTool | ToolChoiceNone;
+export interface MessageCreateParamsBase {
+    /**
+     * The maximum number of tokens to generate before stopping.
+     */
+    max_tokens: number;
+    /**
+     * Input messages.
+     */
+    messages: Array<MessageParam>;
+    /**
+     * The model that will complete your prompt.\n\nSee
+     */
+    model: string;
+    /**
+     * An object describing metadata about the request.
+     */
+    metadata?: Metadata;
+    /**
+     * Determines whether to use priority capacity (if available) or standard capacity
+     */
+    service_tier?: 'auto' | 'standard_only';
+    /**
+     * Custom text sequences that will cause the model to stop generating.
+     */
+    stop_sequences?: Array<string>;
+    /**
+     * Whether to incrementally stream the response using server-sent events.
+     */
+    stream?: boolean;
+    /**
+     * System prompt.
+     */
+    system?: string | Array<TextBlockParam>;
+    /**
+     * Amount of randomness injected into the response.
+     */
+    temperature?: number;
+    /**
+     * Configuration for enabling Claude's extended thinking.
+     */
+    thinking?: ThinkingConfigParam;
+    /**
+     * How the model should use the provided tools. The model can use a specific tool,
+     * any available tool, decide by itself, or not use tools at all.
+     */
+    tool_choice?: ToolChoice;
+    /**
+     * Definitions of tools that the model may use.
+     */
+    tools?: Array<ToolUnion>;
+    /**
+     * Only sample from the top K options for each subsequent token.
+     */
+    top_k?: number;
+    /**
+     * Use nucleus sampling.
+     */
+    top_p?: number;
+    anthropic_beta?: string | string[];
+}

package/dist/types/MessagesRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MessagesRequest.js.map

package/dist/types/MessagesRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagesRequest.js","sourceRoot":"","sources":["../../src/types/MessagesRequest.ts"],"names":[],"mappings":""}

package/dist/types/MessagesStreamResponse.d.ts

@@ -0,0 +1,64 @@
+/**
+ * ================================
+ * Inherited upstream file
+ * ================================
+ */
+import { ANTHROPIC_STOP_REASON, CitationCharLocation, CitationContentBlockLocation, CitationPageLocation, CitationsWebSearchResultLocation, MessagesResponse, RedactedThinkingBlock, ServerToolUseBlock, TextBlock, ThinkingBlock, ToolUseBlock, Usage, WebSearchToolResultBlock } from './messagesResponse.js';
+export interface RawMessageStartEvent {
+    message: MessagesResponse;
+    type: 'message_start';
+}
+export interface RawMessageDelta {
+    stop_reason: ANTHROPIC_STOP_REASON | null;
+    stop_sequence: string | null;
+}
+export interface RawMessageDeltaEvent {
+    delta: RawMessageDelta;
+    type: 'message_delta';
+    /**
+     * Billing and rate-limit usage.
+     */
+    usage: Usage;
+}
+export interface RawMessageStopEvent {
+    type: 'message_stop';
+}
+export interface RawContentBlockStartEvent {
+    content_block: TextBlock | ToolUseBlock | ServerToolUseBlock | WebSearchToolResultBlock | ThinkingBlock | RedactedThinkingBlock;
+    index: number;
+    type: 'content_block_start';
+}
+export interface TextDelta {
+    text: string;
+    type: 'text_delta';
+}
+export interface InputJSONDelta {
+    partial_json: string;
+    type: 'input_json_delta';
+}
+export interface CitationsDelta {
+    citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | CitationsWebSearchResultLocation;
+    type: 'citations_delta';
+}
+export interface ThinkingDelta {
+    thinking: string;
+    type: 'thinking_delta';
+}
+export interface SignatureDelta {
+    signature: string;
+    type: 'signature_delta';
+}
+export type RawContentBlockDelta = TextDelta | InputJSONDelta | CitationsDelta | ThinkingDelta | SignatureDelta;
+export interface RawContentBlockDeltaEvent {
+    delta: RawContentBlockDelta;
+    index: number;
+    type: 'content_block_delta';
+}
+export interface RawContentBlockStopEvent {
+    index: number;
+    type: 'content_block_stop';
+}
+export interface RawPingEvent {
+    type: 'ping';
+}
+export type RawMessageStreamEvent = RawMessageStartEvent | RawMessageDeltaEvent | RawMessageStopEvent | RawContentBlockStartEvent | RawContentBlockDeltaEvent | RawContentBlockStopEvent | RawPingEvent;

package/dist/types/MessagesStreamResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MessagesStreamResponse.js.map

package/dist/types/MessagesStreamResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagesStreamResponse.js","sourceRoot":"","sources":["../../src/types/MessagesStreamResponse.ts"],"names":[],"mappings":""}

package/dist/types/cache.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Instance-level cache port for injected credential / token refresh storage.
+ *
+ * Keys are logical only (provider family + version + hash of auth inputs).
+ * The gateway adapter prefixes tenant and serializes. Values are opaque —
+ * expiry lives in the payload when present. No delete, scan, TTL arg, or
+ * semantic-cache API in v1.
+ */
+export interface CachePort {
+    get(key: string): Promise<unknown | undefined>;
+    update(key: string, value: unknown): Promise<void>;
+}

package/dist/types/cache.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cache.js.map

package/dist/types/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/types/cache.ts"],"names":[],"mappings":""}