@runtypelabs/sdk 1.7.1 → 1.7.3

package/dist/types.d.ts

@@ -1,717 +0,0 @@
-/**
- * Client-specific types with camelCase field names
- * These types transform the API's snake_case responses to camelCase for JavaScript/TypeScript consumers
- */
-export type JsonPrimitive = string | number | boolean | null;
-export type JsonArray = JsonValue[];
-export type JsonObject = {
-    [key: string]: JsonValue;
-};
-export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
-export type Metadata = JsonObject;
-export interface JSONSchema {
-    type: 'object' | 'string' | 'number' | 'boolean' | 'array' | 'null';
-    properties?: Record<string, JSONSchema>;
-    required?: string[];
-    items?: JSONSchema;
-    description?: string;
-    default?: JsonValue;
-    enum?: JsonPrimitive[];
-    minimum?: number;
-    maximum?: number;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-}
-export interface ClientConfig {
-    apiKey?: string;
-    baseUrl?: string;
-    apiVersion?: string;
-    timeout?: number;
-    headers?: Record<string, string>;
-}
-export interface PaginationResponse<T> {
-    data: T[];
-    pagination: {
-        nextCursor: string | null;
-        prevCursor: string | null;
-        hasMore: boolean;
-        hasPrev: boolean;
-        limit: number;
-        currentOffset: number;
-        totalPages?: number;
-        currentPage?: number;
-        totalCount?: number;
-    };
-}
-export interface ApiResponse<T> {
-    data?: T;
-    success?: boolean;
-    error?: string;
-    message?: string;
-}
-export interface FlowStep {
-    id: string;
-    type: string;
-    name: string;
-    order: number;
-    enabled: boolean;
-    config: JsonObject;
-}
-export interface Flow {
-    id: string;
-    name: string;
-    description?: string;
-    status: 'draft' | 'active' | 'paused' | 'failed';
-    userId: string;
-    organizationId?: string;
-    createdAt: string;
-    updatedAt: string;
-    lastRunAt?: string;
-    prompts?: Prompt[];
-    /** Flow steps embedded in the flow response (consolidated from flow_steps endpoint) */
-    flowSteps?: FlowStep[];
-    /** Number of steps in the flow */
-    stepCount?: number;
-}
-export interface Prompt {
-    id: string;
-    name: string;
-    text: string;
-    responseFormat: 'default' | 'json' | 'markdown' | 'html' | 'xml';
-    model: string;
-    isStreamed: boolean;
-    tools: string[];
-    inputVariables?: string;
-    estimatedTokens?: number;
-    estimatedCost?: string;
-    userId: string;
-    createdAt: string;
-    updatedAt: string;
-    flows?: FlowAttachment[];
-}
-export interface FlowAttachment {
-    flowId: string;
-    flowName: string;
-    order: number;
-}
-export interface RuntypeRecord {
-    id: string;
-    type: string;
-    name: string;
-    metadata: Metadata;
-    metadataLabels?: {
-        [key: string]: string;
-    };
-    metadataSchema?: {
-        keys: string[];
-        keyMapping?: {
-            [key: string]: string;
-        };
-        keyTypes?: {
-            [key: string]: string;
-        };
-        types?: {
-            [key: string]: string;
-        };
-        sizeKb: number;
-        keyCount: number;
-        updatedAt: string;
-    };
-    availableFields?: string[];
-    userId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface ApiKey {
-    id: string;
-    name: string;
-    keyPrefix: string;
-    searchHint?: string;
-    permissions: string[];
-    isActive: boolean;
-    expiresAt?: string;
-    allowedIps: string[];
-    createdAt: string;
-    updatedAt?: string;
-    lastUsedAt?: string;
-}
-export interface ModelConfig {
-    id: string;
-    provider: string;
-    modelId: string;
-    displayName?: string;
-    requiresApiKey: boolean;
-    costPer1kTokens?: number;
-    contextLength?: number;
-    maxOutputTokens?: number;
-    maxTokens?: number;
-    supportsStreaming?: boolean;
-    supportedResponseFormats?: string[];
-    supportsSearch?: boolean;
-    isEnabled: boolean;
-    isDefault: boolean;
-    settings: JsonObject;
-    createdAt: string;
-    updatedAt: string;
-    providerKeyId?: string | null;
-    requiresIntegration?: string;
-    apiKey?: string;
-    scope?: 'personal' | 'organization';
-    organizationId?: string;
-}
-export interface UserProfile {
-    id: string;
-    firstName?: string;
-    lastName?: string;
-    email: string;
-    preferences?: {
-        theme?: 'light' | 'dark' | 'system';
-        notifications?: boolean;
-        defaultModel?: string;
-    };
-}
-export interface CreateFlowRequest {
-    name: string;
-    description?: string;
-    flowSteps?: Array<{
-        type: 'prompt' | 'context' | 'condition' | 'output' | 'email';
-        name: string;
-        order?: number;
-        enabled?: boolean;
-        config: JsonObject;
-    }>;
-}
-export interface CreatePromptRequest {
-    flowIds?: string[];
-    name: string;
-    text: string;
-    responseFormat?: 'json' | 'markdown' | 'text' | 'html' | 'xml';
-    model?: string;
-    inputVariables?: string;
-}
-export interface CreateRecordRequest {
-    type: string;
-    name: string;
-    metadata?: Metadata;
-}
-export interface BulkEditCondition {
-    field: string;
-    operator: 'equals' | 'equals_ci' | 'not_equals' | 'contains' | 'not_contains';
-    value: string | number | boolean;
-}
-export interface BulkEditRequest {
-    recordIds?: string[];
-    conditions?: BulkEditCondition[];
-    updates?: JsonObject;
-    deleteFields?: string[];
-    dryRun?: boolean;
-    applyToAll?: boolean;
-}
-export interface BulkEditResult {
-    id: string;
-    before: JsonObject;
-    after: JsonObject;
-}
-export interface BulkEditResponse {
-    data: BulkEditResult[];
-    recordIds?: number[];
-}
-export interface ProviderApiKey {
-    id: number;
-    provider: 'openai' | 'anthropic' | 'huggingface' | 'google' | 'xai' | 'mixlayer' | 'togetherai';
-    name: string;
-    keyPreview: string;
-    isDefault: boolean;
-    isActive: boolean;
-    usageCount: number;
-    lastUsedAt?: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface CreateProviderKeyRequest {
-    provider: 'openai' | 'anthropic' | 'huggingface' | 'google' | 'xai' | 'mixlayer' | 'togetherai';
-    name: string;
-    apiKey: string;
-    isDefault?: boolean;
-}
-export interface UpdateProviderKeyRequest {
-    name?: string;
-    apiKey?: string;
-    isDefault?: boolean;
-    isActive?: boolean;
-}
-export interface CreateApiKeyRequest {
-    name: string;
-    permissions?: string[];
-    expiresAt?: string;
-    allowedIps?: string[];
-    environment?: 'test' | 'production';
-}
-export interface CreateModelConfigRequest {
-    provider: 'mixlayer' | 'openai' | 'anthropic' | 'google' | 'xai' | 'huggingface' | 'togetherai';
-    modelId: string;
-    apiKey?: string;
-    settings?: JsonObject;
-}
-/** Content part types for multi-modal messages */
-export interface TextContentPart {
-    type: 'text';
-    text: string;
-}
-export interface ImageContentPart {
-    type: 'image';
-    image: string;
-    mimeType?: string;
-}
-export interface FileContentPart {
-    type: 'file';
-    data: string;
-    mimeType: string;
-    filename: string;
-}
-export type MessageContent = string | Array<TextContentPart | ImageContentPart | FileContentPart>;
-/**
- * Options for upsert mode - controls conflict detection and versioning
- */
-export interface UpsertOptions {
-    /** Whether to create a version snapshot before updating (default: true) */
-    createVersionOnChange?: boolean;
-    /** Allow overwriting changes made via dashboard/API (default: false) */
-    allowOverwriteExternalChanges?: boolean;
-}
-/**
- * Environment type for dispatch requests
- * - 'development': Use development credentials (default for testing in dashboard)
- * - 'production': Use production credentials (shows warning in UI)
- */
-export type DispatchEnvironment = 'development' | 'production';
-export interface DispatchRequest {
-    record?: {
-        id?: number | string;
-        name?: string;
-        type?: string;
-        metadata?: Metadata;
-    };
-    flow: {
-        id?: string;
-        name?: string;
-        steps?: Array<any>;
-    };
-    messages?: Array<{
-        role: 'system' | 'user' | 'assistant';
-        content: MessageContent;
-    }>;
-    /**
-     * Secure credentials for tool authentication
-     * - Never logged or returned in responses
-     * - Only used for variable substitution in tool headers/URLs
-     * - Available as {{secrets.key_name}} in tool configurations
-     */
-    secrets?: Record<string, string>;
-    /**
-     * Top-level input variables accessible as {{varName}} in templates
-     * - Allows simple syntax without _record.metadata prefix
-     * - Takes precedence over record.metadata when resolving variables
-     * - Keys cannot start with '_' (reserved for system variables)
-     */
-    inputs?: Record<string, unknown>;
-    options?: {
-        streamResponse?: boolean;
-        modelOverride?: string;
-        recordMode?: 'existing' | 'create' | 'virtual';
-        flowMode?: 'existing' | 'create' | 'virtual' | 'upsert';
-        storeResults?: boolean;
-        autoAppendMetadata?: boolean;
-        debugMode?: boolean;
-        /**
-         * Environment for credential lookup
-         * - 'development': Use development credentials (default)
-         * - 'production': Use production credentials
-         * Credentials are looked up with environment-specific first, then fallback to "all environments"
-         */
-        environment?: DispatchEnvironment;
-        createVersion?: boolean;
-        versionType?: 'published' | 'draft' | 'test' | 'virtual';
-        versionLabel?: string;
-        versionNotes?: string;
-        flowVersionId?: string;
-        upsertOptions?: UpsertOptions;
-    };
-}
-export interface ListParams {
-    limit?: number;
-    cursor?: string;
-    direction?: 'next' | 'prev';
-}
-export interface RecordListParams extends ListParams {
-    metadataKeys?: string;
-    metadataKeysAll?: string;
-    minFields?: number;
-    maxFields?: number;
-    metadataTypes?: string;
-    hasLargeFields?: boolean;
-    minSizeKb?: number;
-    maxSizeKb?: number;
-    sortBy?: string;
-    sortOrder?: 'asc' | 'desc';
-    includeFields?: boolean;
-}
-export interface Tool {
-    id: string;
-    userId: string;
-    organizationId?: string;
-    name: string;
-    description: string;
-    toolType: 'flow' | 'custom' | 'external' | 'local';
-    parametersSchema: JSONSchema;
-    config: ToolConfig;
-    isActive: boolean;
-    createdAt: string;
-    updatedAt: string;
-}
-export type ToolConfig = FlowToolConfig | CustomToolConfig | ExternalToolConfig | LocalToolConfig;
-export interface FlowToolConfig {
-    flowId: string;
-    parameterMapping: Record<string, string>;
-    outputMapping?: string;
-}
-export interface CustomToolConfig {
-    code: string;
-    timeout: number;
-    allowedApis: string[];
-}
-export interface ExternalToolConfig {
-    url: string;
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    headers?: Record<string, string>;
-    authType?: 'none' | 'bearer' | 'api_key';
-}
-export interface LocalToolConfig {
-    [key: string]: JsonValue;
-}
-export interface BuiltInTool {
-    id: string;
-    name: string;
-    description: string;
-    category: 'image_generation' | 'web_search' | 'code_execution' | 'file_operations' | 'data_analysis';
-    providers: string[];
-    parametersSchema: JSONSchema;
-    defaultConfig?: JsonObject;
-    documentationUrl?: string;
-}
-export interface ToolExecution {
-    id: string;
-    toolId: string;
-    flowExecutionId?: string;
-    stepId?: string;
-    userId: string;
-    inputParameters: JsonObject;
-    outputResult: JsonValue;
-    status: 'pending' | 'success' | 'failed';
-    errorMessage?: string;
-    executionTimeMs?: number;
-    createdAt: string;
-}
-export interface CreateToolRequest {
-    name: string;
-    description: string;
-    toolType: 'flow' | 'custom' | 'external';
-    parametersSchema: JSONSchema;
-    config: ToolConfig;
-}
-export interface UpdateToolRequest {
-    name?: string;
-    description?: string;
-    parametersSchema?: JSONSchema;
-    config?: ToolConfig;
-    isActive?: boolean;
-}
-export interface ExecuteToolRequest {
-    toolId: string;
-    parameters: JsonObject;
-}
-export interface ExecuteToolResponse {
-    executionId: string;
-    result: JsonValue;
-    status: 'success' | 'failed';
-    errorMessage?: string;
-    executionTimeMs: number;
-}
-export interface ModelUsageQueryParams {
-    startDate?: string;
-    endDate?: string;
-    period?: 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'current_month' | 'last_month' | 'current_year';
-    granularity?: 'hour' | 'day' | 'week' | 'month';
-    modelConfigId?: string;
-}
-export interface ModelUsageSummary {
-    totalRequests: number;
-    totalCost: number;
-    totalTokens: number;
-    platformCost?: number;
-    userCost?: number;
-    platformTokens?: number;
-    userTokens?: number;
-}
-export interface ModelUsageDetail {
-    modelId: string;
-    modelName?: string;
-    provider: string;
-    requestCount: number;
-    totalCost: number;
-    totalTokens: number;
-    avgCostPerRequest: number;
-}
-export interface ModelUsageTimeSeries {
-    date: string;
-    requests: number;
-    cost: number;
-    tokens: number;
-}
-export interface ModelUsageResponse {
-    meta: {
-        startDate: string;
-        endDate: string;
-        period?: string;
-        granularity?: string;
-    };
-    summary: ModelUsageSummary;
-    usageByModel: Record<string, ModelUsageDetail>;
-    timeSeries?: ModelUsageTimeSeries[];
-}
-/**
- * Runtime tool definition for inline tool definitions in requests.
- * These are not persisted - they're defined and used within a single request.
- *
- * Runtime tools allow you to define tools dynamically without saving them
- * to the database. They support the same tool types as saved tools:
- * - external: HTTP API calls with variable substitution
- * - custom: JavaScript/Python code execution
- * - flow: Execute another Runtype flow
- *
- * @example
- * ```typescript
- * const runtimeTool: RuntimeTool = {
- *   name: 'list_flows',
- *   description: 'List all flows in the workspace',
- *   toolType: 'external',
- *   parametersSchema: {
- *     type: 'object',
- *     properties: {
- *       limit: { type: 'number', default: 20 }
- *     }
- *   },
- *   config: {
- *     url: 'https://api.runtype.com/v1/flows',
- *     method: 'GET',
- *     headers: { Authorization: '{{_internal.auth_token}}' }
- *   }
- * }
- * ```
- */
-export interface RuntimeTool {
-    name: string;
-    description: string;
-    toolType: 'flow' | 'custom' | 'external' | 'local';
-    parametersSchema: JSONSchema;
-    config?: RuntimeToolConfig;
-}
-/**
- * Config options for runtime tools
- */
-export type RuntimeToolConfig = RuntimeFlowToolConfig | RuntimeCustomToolConfig | RuntimeExternalToolConfig | RuntimeLocalToolConfig;
-export interface RuntimeLocalToolConfig {
-    [key: string]: JsonValue;
-}
-export interface RuntimeFlowToolConfig {
-    flowId: string;
-    parameterMapping?: Record<string, string>;
-    outputMapping?: string;
-}
-export interface RuntimeCustomToolConfig {
-    code: string;
-    language?: 'javascript' | 'typescript' | 'python';
-    sandboxProvider?: 'quickjs' | 'daytona' | 'cloudflare-worker';
-    timeout?: number;
-}
-export interface RuntimeExternalToolConfig {
-    url: string;
-    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    headers?: Record<string, string>;
-}
-/**
- * Tools configuration for prompt steps.
- * Supports both saved tools (by ID) and runtime tools (inline definitions).
- *
- * @example
- * ```typescript
- * const toolsConfig: ToolsConfig = {
- *   // Reference saved tools by ID
- *   toolIds: ['tool_abc123', 'tool_def456'],
- *   // Or define tools inline
- *   runtimeTools: [
- *     {
- *       name: 'search_docs',
- *       description: 'Search documentation',
- *       toolType: 'external',
- *       parametersSchema: { ... },
- *       config: { url: '...', method: 'GET' }
- *     }
- *   ],
- *   maxToolCalls: 10,
- *   toolCallStrategy: 'auto'
- * }
- * ```
- */
-/**
- * Authentication configuration for custom MCP servers
- */
-export interface CustomMCPServerAuth {
-    /** Authentication type */
-    type: 'bearer' | 'api_key' | 'basic' | 'custom_header' | 'oauth2' | 'none';
-    /** Header name for api_key or custom_header auth types */
-    headerName?: string;
-    /** Token/key value for bearer, api_key, or custom_header */
-    token?: string;
-    /** Username for basic auth */
-    username?: string;
-    /** Password for basic auth */
-    password?: string;
-    /** OAuth2 credentials (for oauth2 auth type) */
-    oauth2?: {
-        accessToken?: string;
-        refreshToken?: string;
-        tokenEndpoint?: string;
-        clientId?: string;
-        clientSecret?: string;
-        expiresAt?: number;
-        scope?: string;
-        issuer?: string;
-    };
-}
-/**
- * Custom MCP server configuration for runtime use.
- *
- * Allows connecting to custom MCP-compatible servers at dispatch time,
- * with credentials passed inline (never logged or stored).
- *
- * @example
- * ```typescript
- * const mcpServer: CustomMCPServer = {
- *   id: 'notion',
- *   name: 'Notion Integration',
- *   url: 'https://my-notion-mcp.example.com/mcp',
- *   auth: {
- *     type: 'bearer',
- *     token: process.env.NOTION_MCP_TOKEN
- *   },
- *   timeout: 30000,
- *   allowedTools: ['create_page', 'search_pages']
- * }
- * ```
- */
-export interface CustomMCPServer {
-    /** Unique identifier for this server instance (used in tool IDs: mcp:custom_{id}:toolname) */
-    id: string;
-    /** Display name for UI/logging */
-    name?: string;
-    /** Server URL (required) */
-    url: string;
-    /** Authentication configuration (treated as secret, never logged) */
-    auth?: CustomMCPServerAuth;
-    /** Optional: filter to only allow specific tools (by name) */
-    allowedTools?: string[];
-    /** Optional: timeout in milliseconds (default: 30000, max: 60000) */
-    timeout?: number;
-    /** Optional: transport type (default: 'streamable_http') */
-    transport?: 'streamable_http' | 'rest';
-    /** Optional: whether the server is enabled (default: true) */
-    enabled?: boolean;
-}
-export interface ToolsConfig {
-    /** IDs of saved tools to use */
-    toolIds?: string[];
-    /** Inline runtime tool definitions (not persisted) */
-    runtimeTools?: RuntimeTool[];
-    /**
-     * Custom MCP servers with credentials passed at runtime.
-     * Maximum 5 servers per step.
-     *
-     * @example
-     * ```typescript
-     * mcpServers: [{
-     *   id: 'notion',
-     *   url: 'https://my-mcp.example.com/mcp',
-     *   auth: { type: 'bearer', token: process.env.MCP_TOKEN }
-     * }]
-     * ```
-     */
-    mcpServers?: CustomMCPServer[];
-    /** Maximum number of tool calls allowed per step */
-    maxToolCalls?: number;
-    /** Tool call strategy: 'auto' (model decides), 'required' (must call), 'none' (disabled) */
-    toolCallStrategy?: 'auto' | 'required' | 'none';
-    /** Whether to allow parallel tool calls */
-    parallelCalls?: boolean;
-    /** Per-tool configuration overrides */
-    toolConfigs?: Record<string, JsonObject>;
-}
-/**
- * Reasoning configuration for AI models that support extended thinking.
- *
- * Enables models like GPT-5, Claude 4, Gemini 2.5 to show their reasoning process.
- * Different providers have different configuration options.
- *
- * @example Simple boolean (uses provider defaults)
- * ```typescript
- * reasoning: true
- * ```
- *
- * @example GPT-5 with detailed reasoning
- * ```typescript
- * reasoning: {
- *   enabled: true,
- *   reasoningEffort: 'high',
- *   reasoningSummary: 'detailed'
- * }
- * ```
- *
- * @example Claude with thinking budget
- * ```typescript
- * reasoning: {
- *   enabled: true,
- *   budgetTokens: 16000
- * }
- * ```
- */
-export interface ReasoningConfig {
-    /** Enable reasoning (required) */
-    enabled: boolean;
-    /** Reasoning effort level for OpenAI models. 'xhigh' only available for GPT-5.1-Codex-Max */
-    reasoningEffort?: 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';
-    /** Reasoning summary mode - required for GPT-5 streaming. 'auto' for condensed, 'detailed' for comprehensive */
-    reasoningSummary?: 'auto' | 'detailed';
-    /** Maximum tokens for Claude extended thinking */
-    budgetTokens?: number;
-    /** Maximum tokens for Gemini thinking */
-    thinkingBudget?: number;
-    /** Whether to include thinking in the response */
-    includeThoughts?: boolean;
-}
-/**
- * Reasoning configuration value - either a simple boolean or detailed config.
- *
- * @example Simple enable/disable
- * ```typescript
- * reasoning: true  // Enable with provider defaults
- * reasoning: false // Explicitly disable
- * ```
- *
- * @example Detailed configuration
- * ```typescript
- * reasoning: { enabled: true, reasoningEffort: 'high' }
- * ```
- */
-export type ReasoningValue = boolean | ReasoningConfig;
-//# sourceMappingURL=types.d.ts.map