@nodetool-ai/runtime 0.7.0-rc.11

package/dist/providers/base-provider.d.ts

@@ -0,0 +1,194 @@
+import type { ASRModel, EmbeddingModel, ImageModel, ImageTo3DParams, ImageToImageParams, ImageToVideoParams, LanguageModel, Message, Model3D, ProviderId, ProviderStreamItem, ProviderTool, EncodedAudioResult, StreamingAudioChunk, TextTo3DParams, TextToImageParams, TextToVideoParams, ToolCall, TTSModel, VideoModel } from "./types.js";
+import type { UsageInfo } from "./cost-calculator.js";
+/**
+ * Capability names a provider can expose. These correspond to the `capability`
+ * strings consumed by client-side filters like `useImageModelProviders`,
+ * `useTTSProviders`, etc.
+ */
+export type ProviderCapability = "generate_message" | "generate_messages" | "text_to_image" | "image_to_image" | "text_to_video" | "image_to_video" | "text_to_speech" | "automatic_speech_recognition" | "generate_embedding" | "text_to_3d" | "image_to_3d";
+/**
+ * Derive a provider's capability set by checking which optional `getAvailable*`
+ * methods it overrides on its prototype. Every provider can always generate
+ * messages; image/video/TTS/ASR/embedding are advertised only when the concrete
+ * class overrides the matching base method.
+ *
+ * Shared by `packages/websocket/src/models-api.ts` (REST leftover) and the
+ * `models` tRPC router so both report identical capabilities for the same
+ * provider instance.
+ */
+export declare function providerCapabilities(instance: BaseProvider): ProviderCapability[];
+export declare abstract class BaseProvider {
+    readonly provider: ProviderId;
+    private _cost;
+    private _emitMessage;
+    setMessageEmitter(fn: (msg: unknown) => void): void;
+    protected emitMessage(msg: unknown): void;
+    protected constructor(provider: ProviderId);
+    static requiredSecrets(): string[];
+    getContainerEnv(): Record<string, string>;
+    hasToolSupport(_model: string): Promise<boolean>;
+    trackUsage(model: string, usage: UsageInfo): number;
+    /** Alias for getTotalCost() — mirrors Python's BaseProvider.cost property. */
+    get cost(): number;
+    getTotalCost(): number;
+    /**
+     * Log a provider call for cost tracking.
+     * Base implementation logs to debug; subclasses or callers may persist to a Prediction model.
+     */
+    logProviderCall(args: {
+        userId: string;
+        provider: string;
+        model: string;
+        cost: number;
+        workflowId?: string | null;
+    }): Promise<void>;
+    resetCost(): void;
+    getAvailableLanguageModels(): Promise<LanguageModel[]>;
+    getAvailableImageModels(): Promise<ImageModel[]>;
+    getAvailableVideoModels(): Promise<VideoModel[]>;
+    getAvailableTTSModels(): Promise<TTSModel[]>;
+    getAvailableASRModels(): Promise<ASRModel[]>;
+    getAvailableEmbeddingModels(): Promise<EmbeddingModel[]>;
+    /**
+     * 3D **generation** models exposed by this provider (e.g. Meshy's `meshy-4`,
+     * Rodin's `rodin-regular`). Override on providers that can synthesize 3D
+     * assets from text and/or images.
+     */
+    getAvailable3DModels(): Promise<Model3D[]>;
+    abstract generateMessage(args: {
+        messages: Message[];
+        model: string;
+        tools?: ProviderTool[];
+        /** Force the model to call a specific tool by name, or "any" to require any tool call. */
+        toolChoice?: string | "any";
+        maxTokens?: number;
+        temperature?: number;
+        topP?: number;
+        presencePenalty?: number;
+        frequencyPenalty?: number;
+        /** Optional thread/conversation identifier for session-based providers. */
+        threadId?: string | null;
+        /** Optional callback for native tool execution (used by providers with in-process MCP). */
+        onToolCall?: (name: string, args: Record<string, unknown>) => Promise<string>;
+        /** Optional signal to abort the request. */
+        signal?: AbortSignal;
+    }): Promise<Message>;
+    abstract generateMessages(args: {
+        messages: Message[];
+        model: string;
+        tools?: ProviderTool[];
+        /** Force the model to call a specific tool by name, or "any" to require any tool call. */
+        toolChoice?: string | "any";
+        maxTokens?: number;
+        temperature?: number;
+        topP?: number;
+        presencePenalty?: number;
+        frequencyPenalty?: number;
+        audio?: Record<string, unknown>;
+        /** Optional thread/conversation identifier for session-based providers. */
+        threadId?: string | null;
+        /** Optional callback for native tool execution (used by providers with in-process MCP). */
+        onToolCall?: (name: string, args: Record<string, unknown>) => Promise<string>;
+        /** Optional signal to abort the request. */
+        signal?: AbortSignal;
+    }): AsyncGenerator<ProviderStreamItem>;
+    /** Traced wrapper around generateMessage. Use this instead of calling generateMessage directly. */
+    generateMessageTraced(args: Parameters<this["generateMessage"]>[0]): Promise<Message>;
+    private applyLlmRequestAttributes;
+    /** Traced wrapper around generateMessages. Use this instead of calling generateMessages directly. */
+    generateMessagesTraced(args: Parameters<this["generateMessages"]>[0]): AsyncGenerator<ProviderStreamItem>;
+    /** Internal: wrap generateMessages with OTel span */
+    private _tracedStream;
+    textToImage(_params: TextToImageParams): Promise<Uint8Array>;
+    /**
+     * Generate multiple images from a text prompt.
+     *
+     * Default implementation calls textToImage() sequentially as a fallback.
+     * Providers that support native batch generation (e.g. FAL with num_images)
+     * should override this for efficiency.
+     */
+    textToImages(params: TextToImageParams, numImages: number): Promise<Uint8Array[]>;
+    imageToImage(_image: Uint8Array, _params: ImageToImageParams): Promise<Uint8Array>;
+    /**
+     * Generate multiple image-to-image results in one logical call.
+     *
+     * Default implementation calls imageToImage() sequentially as a fallback.
+     * Providers that support native batch generation should override this.
+     */
+    imageToImages(image: Uint8Array, params: ImageToImageParams, numImages: number): Promise<Uint8Array[]>;
+    textToSpeech(_args: {
+        text: string;
+        model: string;
+        voice?: string;
+        speed?: number;
+        /**
+         * Requested output container. Providers that stream raw PCM may ignore
+         * this hint; the caller is responsible for wrapping/encoding the result.
+         */
+        audioFormat?: string;
+    }): AsyncGenerator<StreamingAudioChunk>;
+    /**
+     * Override this for providers that return fully-encoded audio (FLAC, WAV,
+     * MP3) instead of raw PCM samples. Returns null by default, meaning the
+     * caller should fall back to the streaming PCM `textToSpeech()` path.
+     *
+     * Providers that honor `audioFormat` should return audio in that container
+     * when possible and fall back to their default when the format is not
+     * supported. The returned `mimeType` reflects the actual bytes produced.
+     */
+    textToSpeechEncoded(_args: {
+        text: string;
+        model: string;
+        voice?: string;
+        speed?: number;
+        audioFormat?: string;
+    }): Promise<EncodedAudioResult | null>;
+    automaticSpeechRecognition(_args: {
+        audio: Uint8Array;
+        model: string;
+        language?: string;
+        prompt?: string;
+        temperature?: number;
+        word_timestamps?: boolean;
+    }): Promise<import("./types.js").ASRResult>;
+    textToVideo(_params: TextToVideoParams): Promise<Uint8Array>;
+    imageToVideo(_image: Uint8Array, _params: ImageToVideoParams): Promise<Uint8Array>;
+    /**
+     * Generate a 3D asset from a text prompt. Returns the encoded asset bytes
+     * (typically GLB). Providers that support 3D generation should override.
+     */
+    textTo3D(_params: TextTo3DParams): Promise<Uint8Array>;
+    /**
+     * Generate a 3D asset from a single reference image. Returns the encoded
+     * asset bytes (typically GLB). Providers that support 3D generation should
+     * override.
+     */
+    imageTo3D(_image: Uint8Array, _params: ImageTo3DParams): Promise<Uint8Array>;
+    generateEmbedding(_args: {
+        text: string | string[];
+        model: string;
+        dimensions?: number;
+    }): Promise<number[][]>;
+    isContextLengthError(error: unknown): boolean;
+    /**
+     * Check if an error is a rate limit error (HTTP 429).
+     * Subclasses may override for provider-specific detection.
+     */
+    isRateLimitError(error: unknown): boolean;
+    /**
+     * Check if an error is an authentication error (HTTP 401/403).
+     * Subclasses may override for provider-specific detection.
+     */
+    isAuthError(error: unknown): boolean;
+    protected parseToolCallArgs(raw: unknown): Record<string, unknown>;
+    protected buildToolCall(id: string, name: string, args: unknown): ToolCall;
+    /**
+     * Resolve a URI to a `data:` URI that providers can consume directly.
+     *
+     * - `file://...`        → read from disk, return `data:<mime>;base64,…`
+     * - `/api/storage/<k>`  → read from getDefaultAssetsPath()/<k> (legacy fallback)
+     * - Everything else     → returned unchanged (http/https/data: pass through)
+     */
+    protected resolveUri(uri: string): Promise<string>;
+}
+//# sourceMappingURL=base-provider.d.ts.map

package/dist/providers/base-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-provider.d.ts","sourceRoot":"","sources":["../../src/providers/base-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,UAAU,EACV,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,OAAO,EACP,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,UAAU,EACX,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAgBtD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,gBAAgB,GAChB,8BAA8B,GAC9B,oBAAoB,GACpB,YAAY,GACZ,aAAa,CAAC;AAElB;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,YAAY,GACrB,kBAAkB,EAAE,CA4CtB;AAED,8BAAsB,YAAY;IAChC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,YAAY,CAAyC;IAE7D,iBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAInD,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAIzC,SAAS,aAAa,QAAQ,EAAE,UAAU;IAI1C,MAAM,CAAC,eAAe,IAAI,MAAM,EAAE;IAIlC,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAInC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM;IAanD,8EAA8E;IAC9E,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,YAAY,IAAI,MAAM;IAItB;;;OAGG;IACG,eAAe,CAAC,IAAI,EAAE;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjB,SAAS,IAAI,IAAI;IAIX,0BAA0B,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAItD,uBAAuB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAIhD,uBAAuB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAIhD,qBAAqB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI5C,qBAAqB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI5C,2BAA2B,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAI9D;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAIhD,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE;QAC7B,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;QACvB,0FAA0F;QAC1F,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;QAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,2EAA2E;QAC3E,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,2FAA2F;QAC3F,UAAU,CAAC,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,OAAO,CAAC,MAAM,CAAC,CAAC;QACrB,4CAA4C;QAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GAAG,OAAO,CAAC,OAAO,CAAC;IAEpB,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE;QAC9B,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;QACvB,0FAA0F;QAC1F,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;QAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,2EAA2E;QAC3E,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,2FAA2F;QAC3F,UAAU,CAAC,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,OAAO,CAAC,MAAM,CAAC,CAAC;QACrB,4CAA4C;QAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GAAG,cAAc,CAAC,kBAAkB,CAAC;IAEtC,mGAAmG;IAC7F,qBAAqB,CACzB,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3C,OAAO,CAAC,OAAO,CAAC;IAgFnB,OAAO,CAAC,yBAAyB;IAyBjC,qGAAqG;IAC9F,sBAAsB,CAC3B,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,GAC5C,cAAc,CAAC,kBAAkB,CAAC;IAwFrC,qDAAqD;YACtC,aAAa;IAwBtB,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlE;;;;;;OAMG;IACG,YAAY,CAChB,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,EAAE,CAAC;IAQlB,YAAY,CAChB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;OAKG;IACG,aAAa,CACjB,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,kBAAkB,EAC1B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,EAAE,CAAC;IAQjB,YAAY,CAAC,KAAK,EAAE;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,cAAc,CAAC,mBAAmB,CAAC;IAKvC;;;;;;;;OAQG;IACG,mBAAmB,CAAC,KAAK,EAAE;QAC/B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAIhC,0BAA0B,CAAC,KAAK,EAAE;QACtC,KAAK,EAAE,UAAU,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,GAAG,OAAO,CAAC,OAAO,YAAY,EAAE,SAAS,CAAC;IAMrC,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI5D,YAAY,CAChB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAItB;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAI5D;;;;OAIG;IACG,SAAS,CACb,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,UAAU,CAAC;IAIhB,iBAAiB,CAAC,KAAK,EAAE;QAC7B,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IAIvB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAK7C;;;OAGG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAKzC;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAOpC,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAelE,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,QAAQ;IAQ1E;;;;;;OAMG;cACa,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAgCzD"}