@ryuhq/sdk 0.1.13 → 0.2.0

package/dist/client-D5U6ssPc.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Gateway-mandatory model client for the Ryu SDK.
+ *
+ * Rust-cored: this is a thin TypeScript wrapper over the `@ryuhq/sdk-native`
+ * addon's `ModelClient`, which is the `crates/ryu-sdk` Rust core. Every model
+ * call is routed by the Rust core to the Ryu gateway's OpenAI-compatible
+ * `/v1/chat/completions` endpoint; direct-provider base URLs are rejected at
+ * construction. No provider SDK or base URL is ever imported here.
+ *
+ * Usage:
+ *
+ *   const model = defineModel("gpt-4o");
+ *   const reply = await model.chat([{ role: "user", content: "hello" }]);
+ *   for await (const delta of model.stream([{ role: "user", content: "hi" }])) {
+ *     process.stdout.write(delta.content);
+ *   }
+ */
+/** A single message in a chat conversation. */
+interface ChatMessage {
+    /** The message text. */
+    content: string;
+    /** The speaker: "system", "user", or "assistant". */
+    role: "system" | "user" | "assistant";
+}
+/** A streaming chat completion delta. */
+interface ChatDelta {
+    /** Incremental text fragment from the model. */
+    content: string | null;
+    /** Non-null on the final chunk when `finish_reason` is set. */
+    finishReason: string | null;
+}
+/** Non-streaming chat completion result. */
+interface ChatResult {
+    /** The full assistant reply text. */
+    content: string;
+    /** The gateway/model-reported finish reason. */
+    finishReason: string | null;
+    /** Usage stats as reported by the gateway (optional — gateway may omit). */
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+/** Options accepted by `defineModel`. */
+interface ModelClientOptions {
+    /**
+     * Gateway base URL (no trailing `/v1`). Defaults to `RYU_GATEWAY_URL` then
+     * the Rust core's default. Direct provider URLs are rejected at construction.
+     */
+    baseUrl?: string;
+    /**
+     * Bearer token forwarded to the gateway. Defaults to `RYU_GATEWAY_TOKEN`.
+     * This is the gateway token, never a provider API key.
+     */
+    token?: string;
+}
+/**
+ * A gateway-mandatory model client backed by the Rust core.
+ *
+ * All calls go through the native `ModelClient`; if the configured base URL is a
+ * direct provider, construction throws.
+ */
+declare class ModelClient {
+    readonly model: string;
+    readonly baseUrl: string;
+    private readonly native;
+    constructor(model: string, options?: ModelClientOptions);
+    /** Send a non-streaming chat completion request to the gateway. */
+    chat(messages: ChatMessage[]): Promise<ChatResult>;
+    /** Send a streaming chat completion request, yielding deltas as they arrive. */
+    stream(messages: ChatMessage[]): AsyncGenerator<ChatDelta>;
+}
+/**
+ * Create a gateway-mandatory model client for `modelId`.
+ *
+ *   const model = defineModel("gpt-4o");
+ *   const model = defineModel("claude-3-5-sonnet", { baseUrl: "http://my-gateway:7981" });
+ *
+ * A direct provider URL throws immediately (egress enforcement in the Rust core).
+ */
+declare function defineModel(modelId: string, options?: ModelClientOptions): ModelClient;
+
+export { type ChatDelta as C, ModelClient as M, type ChatMessage as a, type ChatResult as b, type ModelClientOptions as c, defineModel as d };