@runtypelabs/sdk 1.7.2 → 1.8.0

package/dist/client-token-types.d.ts

@@ -1,143 +0,0 @@
-/**
- * Client Token Types
- *
- * Types for the client tokens system that enables secure browser-to-API communication.
- *
- * Note: These types are inlined from the internal shared package to avoid
- * requiring users to install @runtypelabs/shared.
- */
-/**
- * Environment for a client token
- */
-export type ClientTokenEnvironment = 'test' | 'live';
-/**
- * Version pinning options for client tokens
- */
-export type ClientTokenVersionPin = 'latest' | 'published' | string;
-/**
- * Theme configuration for the client widget
- */
-export interface ClientWidgetTheme {
-    /** Primary brand color */
-    primaryColor?: string;
-    /** Background color */
-    backgroundColor?: string;
-    /** Text color */
-    textColor?: string;
-    /** Font family */
-    fontFamily?: string;
-    /** Border radius for elements */
-    borderRadius?: string;
-    /** Light or dark mode */
-    mode?: 'light' | 'dark';
-}
-/**
- * Client token configuration (theme, welcome message, etc.)
- */
-export interface ClientTokenConfig {
-    /** Welcome message shown when widget opens */
-    welcomeMessage?: string;
-    /** Input placeholder text */
-    placeholder?: string;
-    /** Theme configuration */
-    theme?: ClientWidgetTheme;
-    /** Custom data passed to flows */
-    customData?: Record<string, any>;
-}
-/**
- * Client token data returned from the API
- */
-export interface ClientToken {
-    id: string;
-    name: string | null;
-    flowIds: string[];
-    defaultFlowId: string;
-    allowedOrigins: string[];
-    environment: ClientTokenEnvironment;
-    pinToVersion: ClientTokenVersionPin | null;
-    rateLimitPerMinute: number | null;
-    rateLimitPerHour: number | null;
-    maxMessagesPerSession: number | null;
-    sessionIdleTimeoutMinutes: number | null;
-    config: ClientTokenConfig;
-    isActive: boolean;
-    tokenPrefix: string;
-    tokenHint: string | null;
-    conversationCount?: number;
-    lastUsedAt: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Request to create a client token
- */
-export interface CreateClientTokenRequest {
-    name: string;
-    flowIds: string[];
-    defaultFlowId: string;
-    allowedOrigins: string[];
-    environment?: ClientTokenEnvironment;
-    pinToVersion?: ClientTokenVersionPin;
-    rateLimitPerMinute?: number;
-    rateLimitPerHour?: number;
-    maxMessagesPerSession?: number;
-    sessionIdleTimeoutMinutes?: number;
-    config?: ClientTokenConfig;
-}
-/**
- * Request to update a client token
- */
-export interface UpdateClientTokenRequest {
-    name?: string;
-    flowIds?: string[];
-    defaultFlowId?: string;
-    allowedOrigins?: string[];
-    pinToVersion?: ClientTokenVersionPin;
-    rateLimitPerMinute?: number;
-    rateLimitPerHour?: number;
-    maxMessagesPerSession?: number;
-    sessionIdleTimeoutMinutes?: number;
-    config?: ClientTokenConfig;
-    isActive?: boolean;
-}
-/**
- * Security warning for token configuration
- */
-export interface SecurityWarning {
-    type: string;
-    message: string;
-}
-/**
- * Response from creating a client token
- */
-export interface CreateClientTokenResponse {
-    clientToken: ClientToken;
-    /** The plain token value - only shown once! */
-    token: string;
-    warnings: SecurityWarning[];
-}
-/**
- * Conversation record from the API
- */
-export interface ClientConversation {
-    id: string;
-    name: string;
-    flowId: string;
-    origin: string;
-    messageCount: number;
-    firstMessage: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * List conversations response
- */
-export interface ListConversationsResponse {
-    conversations: ClientConversation[];
-    pagination: {
-        limit: number;
-        offset: number;
-        hasMore: boolean;
-    };
-}
-//# sourceMappingURL=client-token-types.d.ts.map

package/dist/client-token-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client-token-types.d.ts","sourceRoot":"","sources":["../src/client-token-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,uBAAuB;IACvB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yBAAyB;IACzB,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,EAAE,sBAAsB,CAAA;IACnC,YAAY,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAC1C,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,MAAM,EAAE,iBAAiB,CAAA;IACzB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,YAAY,CAAC,EAAE,qBAAqB,CAAA;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,YAAY,CAAC,EAAE,qBAAqB,CAAA;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,WAAW,CAAA;IACxB,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,kBAAkB,EAAE,CAAA;IACnC,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,CAAA;KACjB,CAAA;CACF"}

package/dist/client-token-types.js

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * Client Token Types
- *
- * Types for the client tokens system that enables secure browser-to-API communication.
- *
- * Note: These types are inlined from the internal shared package to avoid
- * requiring users to install @runtypelabs/shared.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=client-token-types.js.map

package/dist/client-token-types.js.map

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

package/dist/client.d.ts

@@ -1,135 +0,0 @@
-/**
- * @layer sdk
- * @case camelCase (SDK and API both use native camelCase - no conversion needed)
- *
- * Main Runtype API Client.
- *
- * The SDK and API both use native camelCase for all request/response bodies.
- * No case transformation is performed.
- *
- * @see packages/client/src/transform.ts for pass-through utilities
- */
-import type { ClientConfig, DispatchRequest } from './types';
-import { FlowsEndpoint, PromptsEndpoint, RecordsEndpoint, ApiKeysEndpoint, ModelConfigsEndpoint, DispatchEndpoint, ChatEndpoint, UsersEndpoint, AnalyticsEndpoint, FlowStepsEndpoint, ContextTemplatesEndpoint, ToolsEndpoint, EvalEndpoint, ClientTokensEndpoint, AgentsEndpoint, type ApiClient } from './endpoints';
-import { ClientFlowBuilder, StreamCallbacks, FlowSummary } from './flow-builder';
-import { FlowResult } from './flow-result';
-type LocalToolHandler = (args: unknown) => Promise<unknown>;
-/**
- * RuntypeClient - The main entry point for interacting with the Runtype API
- *
- * Automatically transforms field names between camelCase (client) and snake_case (API)
- * to provide an idiomatic JavaScript/TypeScript experience while maintaining API consistency.
- */
-export declare class RuntypeClient implements ApiClient {
-    private baseUrl;
-    private apiVersion;
-    private timeout;
-    private headers;
-    flows: FlowsEndpoint;
-    prompts: PromptsEndpoint;
-    records: RecordsEndpoint;
-    apiKeys: ApiKeysEndpoint;
-    modelConfigs: ModelConfigsEndpoint;
-    dispatch: DispatchEndpoint;
-    chat: ChatEndpoint;
-    users: UsersEndpoint;
-    analytics: AnalyticsEndpoint;
-    flowSteps: FlowStepsEndpoint;
-    contextTemplates: ContextTemplatesEndpoint;
-    tools: ToolsEndpoint;
-    eval: EvalEndpoint;
-    clientTokens: ClientTokensEndpoint;
-    agents: AgentsEndpoint;
-    constructor(config?: ClientConfig);
-    /**
-     * Set the API key for authentication
-     */
-    setApiKey(apiKey: string): void;
-    /**
-     * Start building a flow with fluent API
-     *
-     * @example
-     * ```typescript
-     * const response = await runtype
-     *   .flow('My Flow')
-     *   .withRecord({ name: 'Test', type: 'data' })
-     *   .fetchUrl({ name: 'Fetch', url: '...', outputVariable: 'data' })
-     *   .prompt({ name: 'Process', model: 'gpt-4', userPrompt: '...' })
-     *   .run()
-     * ```
-     */
-    flow(name: string): ClientFlowBuilder;
-    /**
-     * Remove the API key
-     */
-    clearApiKey(): void;
-    /**
-     * Run a flow with client-side tools (automatic pause/resume loop)
-     *
-     * @param request - The dispatch request configuration
-     * @param clientTools - Map of tool names to async functions that execute the tool logic
-     * @param callbacks - Optional callbacks for streaming events
-     * @returns The final result of the flow execution or summary if streaming
-     */
-    runWithLocalTools(request: DispatchRequest, localTools: Record<string, LocalToolHandler>, callbacks?: StreamCallbacks): Promise<FlowResult | FlowSummary>;
-    /**
-     * Generic GET request
-     */
-    get<T>(path: string, params?: Record<string, unknown>): Promise<T>;
-    /**
-     * Generic POST request
-     */
-    post<T>(path: string, data?: unknown): Promise<T>;
-    /**
-     * POST request with FormData support for file uploads
-     */
-    postFormData<T>(path: string, formData: FormData): Promise<T>;
-    /**
-     * Generic request that returns raw Response for streaming
-     */
-    requestStream(path: string, options?: RequestInit): Promise<Response>;
-    /**
-     * Generic PUT request
-     */
-    put<T>(path: string, data?: unknown): Promise<T>;
-    /**
-     * Generic PATCH request
-     */
-    patch<T>(path: string, data?: unknown): Promise<T>;
-    /**
-     * Generic DELETE request
-     */
-    delete<T>(path: string, data?: unknown): Promise<T>;
-    /**
-     * Build full URL with query parameters
-     */
-    private buildUrl;
-    /**
-     * Make HTTP request with timeout and error handling
-     */
-    private makeRequest;
-    /**
-     * Make HTTP request that returns raw Response (for streaming)
-     */
-    private makeRawRequest;
-    /**
-     * Handle error responses
-     */
-    private createApiError;
-}
-/**
- * Custom error class for Runtype API errors
- */
-export declare class RuntypeApiError extends Error {
-    statusCode: number;
-    data?: unknown | undefined;
-    headers?: Headers | undefined;
-    statusText?: string | undefined;
-    constructor(message: string, statusCode: number, data?: unknown | undefined, headers?: Headers | undefined, statusText?: string | undefined);
-}
-/**
- * Convenience function to create a new RuntypeClient instance
- */
-export declare function createClient(config?: ClientConfig): RuntypeClient;
-export {};
-//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE5D,OAAO,EACL,aAAa,EACb,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,KAAK,SAAS,EACf,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,WAAW,EAIZ,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C,KAAK,gBAAgB,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAqC3D;;;;;GAKG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,OAAO,CAAwB;IAGhC,KAAK,EAAE,aAAa,CAAA;IACpB,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,eAAe,CAAA;IACxB,YAAY,EAAE,oBAAoB,CAAA;IAClC,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE,aAAa,CAAA;IACpB,SAAS,EAAE,iBAAiB,CAAA;IAC5B,SAAS,EAAE,iBAAiB,CAAA;IAC5B,gBAAgB,EAAE,wBAAwB,CAAA;IAC1C,KAAK,EAAE,aAAa,CAAA;IACpB,IAAI,EAAE,YAAY,CAAA;IAClB,YAAY,EAAE,oBAAoB,CAAA;IAClC,MAAM,EAAE,cAAc,CAAA;gBAEjB,MAAM,GAAE,YAAiB;IAkCrC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB;IAUrC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAC5C,SAAS,CAAC,EAAE,eAAe,GAC1B,OAAO,CAAC,UAAU,GAAG,WAAW,CAAC;IA6KpC;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IASxE;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAUvD;;OAEG;IACG,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC;IAcnE;;OAEG;IACG,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyB/E;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAUtD;;OAEG;IACG,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAUxD;;OAEG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAUzD;;OAEG;IACH,OAAO,CAAC,QAAQ;IAiBhB;;OAEG;YACW,WAAW;IAsCzB;;OAEG;YACW,cAAc;IA4B5B;;OAEG;YACW,cAAc;CA8B7B;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IAG/B,UAAU,EAAE,MAAM;IAClB,IAAI,CAAC,EAAE,OAAO;IACd,OAAO,CAAC,EAAE,OAAO;IACjB,UAAU,CAAC,EAAE,MAAM;gBAJ1B,OAAO,EAAE,MAAM,EACR,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,OAAO,YAAA,EACd,OAAO,CAAC,EAAE,OAAO,YAAA,EACjB,UAAU,CAAC,EAAE,MAAM,YAAA;CAK7B;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,aAAa,CAEjE"}